StripeAPI.Operations.GetAccountsAccountPeople

Contains the different functions to run the operation getAccountsAccountPeople

Documentation

getAccountsAccountPeople

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> String

account | Constraints: Maximum length of 5000

-> Maybe String

ending_before: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. | Constraints: Maximum length of 5000

-> Maybe String

expand: Specifies which fields in the response should be expanded.

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe String

relationship: Filters on the list of people returned based on the person's relationship to the account's company.

-> Maybe String

starting_after: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. | Constraints: Maximum length of 5000

-> GetAccountsAccountPeopleRequestBody

The request body to send

-> m (Either HttpException (Response GetAccountsAccountPeopleResponse))

Monad containing the result of the operation

GET /v1/accounts/{account}/people

<p>Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.</p>

getAccountsAccountPeopleRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountsAccountPeopleRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/accounts/{account}/people

The same as getAccountsAccountPeople but returns the raw ByteString

getAccountsAccountPeopleM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountsAccountPeopleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetAccountsAccountPeopleResponse))

GET /v1/accounts/{account}/people

Monadic version of getAccountsAccountPeople (use with runWithConfiguration)

getAccountsAccountPeopleRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountsAccountPeopleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/accounts/{account}/people

Monadic version of getAccountsAccountPeopleRaw (use with runWithConfiguration)

data GetAccountsAccountPeopleRequestBody

Defines the data type for the schema getAccountsAccountPeopleRequestBody

Constructors

GetAccountsAccountPeopleRequestBody

Instances

Eq GetAccountsAccountPeopleRequestBody

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

(==) :: GetAccountsAccountPeopleRequestBody -> GetAccountsAccountPeopleRequestBody -> Bool

(/=) :: GetAccountsAccountPeopleRequestBody -> GetAccountsAccountPeopleRequestBody -> Bool

Show GetAccountsAccountPeopleRequestBody

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

showsPrec :: Int -> GetAccountsAccountPeopleRequestBody -> ShowS

show :: GetAccountsAccountPeopleRequestBody -> String

showList :: [GetAccountsAccountPeopleRequestBody] -> ShowS

ToJSON GetAccountsAccountPeopleRequestBody

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

toJSON :: GetAccountsAccountPeopleRequestBody -> Value

toEncoding :: GetAccountsAccountPeopleRequestBody -> Encoding

toJSONList :: [GetAccountsAccountPeopleRequestBody] -> Value

toEncodingList :: [GetAccountsAccountPeopleRequestBody] -> Encoding

FromJSON GetAccountsAccountPeopleRequestBody

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

parseJSON :: Value -> Parser GetAccountsAccountPeopleRequestBody

parseJSONList :: Value -> Parser [GetAccountsAccountPeopleRequestBody]

data GetAccountsAccountPeopleResponse

Represents a response of the operation getAccountsAccountPeople.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetAccountsAccountPeopleResponseError is used.

Constructors

GetAccountsAccountPeopleResponseError String

Means either no matching case available or a parse error

GetAccountsAccountPeopleResponse200 GetAccountsAccountPeopleResponseBody200

Successful response.

GetAccountsAccountPeopleResponseDefault Error

Error response.

Instances

Eq GetAccountsAccountPeopleResponse

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

(==) :: GetAccountsAccountPeopleResponse -> GetAccountsAccountPeopleResponse -> Bool

(/=) :: GetAccountsAccountPeopleResponse -> GetAccountsAccountPeopleResponse -> Bool

Show GetAccountsAccountPeopleResponse

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

showsPrec :: Int -> GetAccountsAccountPeopleResponse -> ShowS

show :: GetAccountsAccountPeopleResponse -> String

showList :: [GetAccountsAccountPeopleResponse] -> ShowS

data GetAccountsAccountPeopleResponseBody200

Defines the data type for the schema GetAccountsAccountPeopleResponseBody200

Constructors

GetAccountsAccountPeopleResponseBody200

Fields

• getAccountsAccountPeopleResponseBody200Data :: [] Person

  data

• getAccountsAccountPeopleResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getAccountsAccountPeopleResponseBody200Object :: GetAccountsAccountPeopleResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getAccountsAccountPeopleResponseBody200Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetAccountsAccountPeopleResponseBody200

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

(==) :: GetAccountsAccountPeopleResponseBody200 -> GetAccountsAccountPeopleResponseBody200 -> Bool

(/=) :: GetAccountsAccountPeopleResponseBody200 -> GetAccountsAccountPeopleResponseBody200 -> Bool

Show GetAccountsAccountPeopleResponseBody200

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

showsPrec :: Int -> GetAccountsAccountPeopleResponseBody200 -> ShowS

show :: GetAccountsAccountPeopleResponseBody200 -> String

showList :: [GetAccountsAccountPeopleResponseBody200] -> ShowS

ToJSON GetAccountsAccountPeopleResponseBody200

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

toJSON :: GetAccountsAccountPeopleResponseBody200 -> Value

toEncoding :: GetAccountsAccountPeopleResponseBody200 -> Encoding

toJSONList :: [GetAccountsAccountPeopleResponseBody200] -> Value

toEncodingList :: [GetAccountsAccountPeopleResponseBody200] -> Encoding

FromJSON GetAccountsAccountPeopleResponseBody200

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

parseJSON :: Value -> Parser GetAccountsAccountPeopleResponseBody200

parseJSONList :: Value -> Parser [GetAccountsAccountPeopleResponseBody200]

data GetAccountsAccountPeopleResponseBody200Object'

Defines the enum schema GetAccountsAccountPeopleResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetAccountsAccountPeopleResponseBody200Object'EnumOther Value

GetAccountsAccountPeopleResponseBody200Object'EnumTyped String

GetAccountsAccountPeopleResponseBody200Object'EnumStringList

Instances

Eq GetAccountsAccountPeopleResponseBody200Object'

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

(==) :: GetAccountsAccountPeopleResponseBody200Object' -> GetAccountsAccountPeopleResponseBody200Object' -> Bool

(/=) :: GetAccountsAccountPeopleResponseBody200Object' -> GetAccountsAccountPeopleResponseBody200Object' -> Bool

Show GetAccountsAccountPeopleResponseBody200Object'

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

showsPrec :: Int -> GetAccountsAccountPeopleResponseBody200Object' -> ShowS

show :: GetAccountsAccountPeopleResponseBody200Object' -> String

showList :: [GetAccountsAccountPeopleResponseBody200Object'] -> ShowS

ToJSON GetAccountsAccountPeopleResponseBody200Object'

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

toJSON :: GetAccountsAccountPeopleResponseBody200Object' -> Value

toEncoding :: GetAccountsAccountPeopleResponseBody200Object' -> Encoding

toJSONList :: [GetAccountsAccountPeopleResponseBody200Object'] -> Value

toEncodingList :: [GetAccountsAccountPeopleResponseBody200Object'] -> Encoding

FromJSON GetAccountsAccountPeopleResponseBody200Object'

Defined in StripeAPI.Operations.GetAccountsAccountPeople

Methods

parseJSON :: Value -> Parser GetAccountsAccountPeopleResponseBody200Object'

parseJSONList :: Value -> Parser [GetAccountsAccountPeopleResponseBody200Object']