StripeAPI.Operations.GetAccountsAccountPersons

Contains the different functions to run the operation getAccountsAccountPersons

Documentation

getAccountsAccountPersons

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Text

account | Constraints: Maximum length of 5000

-> Maybe Text

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 Text

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 Text

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

-> Maybe Text

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

-> Maybe GetAccountsAccountPersonsRequestBody

The request body to send

-> m (Either HttpException (Response GetAccountsAccountPersonsResponse))

Monad containing the result of the operation

GET /v1/accounts/{account}/persons

<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>

getAccountsAccountPersonsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetAccountsAccountPersonsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/accounts/{account}/persons

The same as getAccountsAccountPersons but returns the raw ByteString

getAccountsAccountPersonsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetAccountsAccountPersonsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetAccountsAccountPersonsResponse))

GET /v1/accounts/{account}/persons

Monadic version of getAccountsAccountPersons (use with runWithConfiguration)

getAccountsAccountPersonsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetAccountsAccountPersonsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/accounts/{account}/persons

Monadic version of getAccountsAccountPersonsRaw (use with runWithConfiguration)

data GetAccountsAccountPersonsRequestBody

Defines the data type for the schema getAccountsAccountPersonsRequestBody

Constructors

GetAccountsAccountPersonsRequestBody

Instances

Eq GetAccountsAccountPersonsRequestBody

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

(==) :: GetAccountsAccountPersonsRequestBody -> GetAccountsAccountPersonsRequestBody -> Bool

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

Show GetAccountsAccountPersonsRequestBody

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

showsPrec :: Int -> GetAccountsAccountPersonsRequestBody -> ShowS

show :: GetAccountsAccountPersonsRequestBody -> String

showList :: [GetAccountsAccountPersonsRequestBody] -> ShowS

ToJSON GetAccountsAccountPersonsRequestBody

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

toJSON :: GetAccountsAccountPersonsRequestBody -> Value

toEncoding :: GetAccountsAccountPersonsRequestBody -> Encoding

toJSONList :: [GetAccountsAccountPersonsRequestBody] -> Value

toEncodingList :: [GetAccountsAccountPersonsRequestBody] -> Encoding

FromJSON GetAccountsAccountPersonsRequestBody

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

parseJSON :: Value -> Parser GetAccountsAccountPersonsRequestBody

parseJSONList :: Value -> Parser [GetAccountsAccountPersonsRequestBody]

data GetAccountsAccountPersonsResponse

Represents a response of the operation getAccountsAccountPersons.

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), GetAccountsAccountPersonsResponseError is used.

Constructors

GetAccountsAccountPersonsResponseError String

Means either no matching case available or a parse error

GetAccountsAccountPersonsResponse200 GetAccountsAccountPersonsResponseBody200

Successful response.

GetAccountsAccountPersonsResponseDefault Error

Error response.

Instances

Eq GetAccountsAccountPersonsResponse

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

(==) :: GetAccountsAccountPersonsResponse -> GetAccountsAccountPersonsResponse -> Bool

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

Show GetAccountsAccountPersonsResponse

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

showsPrec :: Int -> GetAccountsAccountPersonsResponse -> ShowS

show :: GetAccountsAccountPersonsResponse -> String

showList :: [GetAccountsAccountPersonsResponse] -> ShowS

data GetAccountsAccountPersonsResponseBody200

Defines the data type for the schema GetAccountsAccountPersonsResponseBody200

Constructors

GetAccountsAccountPersonsResponseBody200

Fields

• getAccountsAccountPersonsResponseBody200Data :: [] Person

  data

• getAccountsAccountPersonsResponseBody200HasMore :: Bool

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

• getAccountsAccountPersonsResponseBody200Object :: GetAccountsAccountPersonsResponseBody200Object'

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

• getAccountsAccountPersonsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetAccountsAccountPersonsResponseBody200

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

(==) :: GetAccountsAccountPersonsResponseBody200 -> GetAccountsAccountPersonsResponseBody200 -> Bool

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

Show GetAccountsAccountPersonsResponseBody200

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

showsPrec :: Int -> GetAccountsAccountPersonsResponseBody200 -> ShowS

show :: GetAccountsAccountPersonsResponseBody200 -> String

showList :: [GetAccountsAccountPersonsResponseBody200] -> ShowS

ToJSON GetAccountsAccountPersonsResponseBody200

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

toJSON :: GetAccountsAccountPersonsResponseBody200 -> Value

toEncoding :: GetAccountsAccountPersonsResponseBody200 -> Encoding

toJSONList :: [GetAccountsAccountPersonsResponseBody200] -> Value

toEncodingList :: [GetAccountsAccountPersonsResponseBody200] -> Encoding

FromJSON GetAccountsAccountPersonsResponseBody200

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

parseJSON :: Value -> Parser GetAccountsAccountPersonsResponseBody200

parseJSONList :: Value -> Parser [GetAccountsAccountPersonsResponseBody200]

data GetAccountsAccountPersonsResponseBody200Object'

Defines the enum schema GetAccountsAccountPersonsResponseBody200Object'

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

Constructors

GetAccountsAccountPersonsResponseBody200Object'EnumOther Value

GetAccountsAccountPersonsResponseBody200Object'EnumTyped Text

GetAccountsAccountPersonsResponseBody200Object'EnumStringList

Instances

Eq GetAccountsAccountPersonsResponseBody200Object'

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

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

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

Show GetAccountsAccountPersonsResponseBody200Object'

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

showsPrec :: Int -> GetAccountsAccountPersonsResponseBody200Object' -> ShowS

show :: GetAccountsAccountPersonsResponseBody200Object' -> String

showList :: [GetAccountsAccountPersonsResponseBody200Object'] -> ShowS

ToJSON GetAccountsAccountPersonsResponseBody200Object'

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

toJSON :: GetAccountsAccountPersonsResponseBody200Object' -> Value

toEncoding :: GetAccountsAccountPersonsResponseBody200Object' -> Encoding

toJSONList :: [GetAccountsAccountPersonsResponseBody200Object'] -> Value

toEncodingList :: [GetAccountsAccountPersonsResponseBody200Object'] -> Encoding

FromJSON GetAccountsAccountPersonsResponseBody200Object'

Defined in StripeAPI.Operations.GetAccountsAccountPersons

Methods

parseJSON :: Value -> Parser GetAccountsAccountPersonsResponseBody200Object'

parseJSONList :: Value -> Parser [GetAccountsAccountPersonsResponseBody200Object']