Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetAccountsAccountPersons

Description

Contains the different functions to run the operation getAccountsAccountPersons

Synopsis

getAccountsAccountPersons :: forall m. MonadHTTP m => GetAccountsAccountPersonsParameters -> ClientT m (Response GetAccountsAccountPersonsResponse)
data GetAccountsAccountPersonsParameters = GetAccountsAccountPersonsParameters {
}
mkGetAccountsAccountPersonsParameters :: Text -> GetAccountsAccountPersonsParameters
data GetAccountsAccountPersonsParametersQueryRelationship' = GetAccountsAccountPersonsParametersQueryRelationship' {
}
mkGetAccountsAccountPersonsParametersQueryRelationship' :: GetAccountsAccountPersonsParametersQueryRelationship'
data GetAccountsAccountPersonsResponse
data GetAccountsAccountPersonsResponseBody200 = GetAccountsAccountPersonsResponseBody200 {
}
mkGetAccountsAccountPersonsResponseBody200 :: [Person] -> Bool -> Text -> GetAccountsAccountPersonsResponseBody200

Documentation

getAccountsAccountPersons Source #

Arguments

:: forall m. MonadHTTP m
=> GetAccountsAccountPersonsParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetAccountsAccountPersonsResponse)	Monadic computation which returns 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>

data GetAccountsAccountPersonsParameters Source #

Defines the object schema located at paths./v1/accounts/{account}/persons.GET.parameters in the specification.

Constructors

GetAccountsAccountPersonsParameters

Fields

getAccountsAccountPersonsParametersPathAccount :: Text
pathAccount: Represents the parameter named 'account'
Constraints:
- Maximum length of 5000
getAccountsAccountPersonsParametersQueryEndingBefore :: Maybe Text
queryEnding_before: Represents the parameter named '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
getAccountsAccountPersonsParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getAccountsAccountPersonsParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
getAccountsAccountPersonsParametersQueryRelationship :: Maybe GetAccountsAccountPersonsParametersQueryRelationship'
queryRelationship: Represents the parameter named 'relationship'
Filters on the list of people returned based on the person's relationship to the account's company.
getAccountsAccountPersonsParametersQueryStartingAfter :: Maybe Text
queryStarting_after: Represents the parameter named '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

Instances

Instances details

Eq GetAccountsAccountPersonsParameters Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods (==) :: GetAccountsAccountPersonsParameters -> GetAccountsAccountPersonsParameters -> Bool # (/=) :: GetAccountsAccountPersonsParameters -> GetAccountsAccountPersonsParameters -> Bool #
Show GetAccountsAccountPersonsParameters Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods showsPrec :: Int -> GetAccountsAccountPersonsParameters -> ShowS # show :: GetAccountsAccountPersonsParameters -> String # showList :: [GetAccountsAccountPersonsParameters] -> ShowS #
ToJSON GetAccountsAccountPersonsParameters Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods toJSON :: GetAccountsAccountPersonsParameters -> Value # toEncoding :: GetAccountsAccountPersonsParameters -> Encoding # toJSONList :: [GetAccountsAccountPersonsParameters] -> Value # toEncodingList :: [GetAccountsAccountPersonsParameters] -> Encoding #
FromJSON GetAccountsAccountPersonsParameters Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods parseJSON :: Value -> Parser GetAccountsAccountPersonsParameters # parseJSONList :: Value -> Parser [GetAccountsAccountPersonsParameters] #

mkGetAccountsAccountPersonsParameters Source #

Arguments

:: Text	`getAccountsAccountPersonsParametersPathAccount`
-> GetAccountsAccountPersonsParameters

Create a new GetAccountsAccountPersonsParameters with all required fields.

data GetAccountsAccountPersonsParametersQueryRelationship' Source #

Defines the object schema located at paths./v1/accounts/{account}/persons.GET.parameters.properties.queryRelationship in the specification.

Represents the parameter named 'relationship'

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

Constructors

GetAccountsAccountPersonsParametersQueryRelationship'
Fields getAccountsAccountPersonsParametersQueryRelationship'Director :: Maybe Bool director getAccountsAccountPersonsParametersQueryRelationship'Executive :: Maybe Bool executive getAccountsAccountPersonsParametersQueryRelationship'Owner :: Maybe Bool owner getAccountsAccountPersonsParametersQueryRelationship'Representative :: Maybe Bool representative

Instances

Instances details

Eq GetAccountsAccountPersonsParametersQueryRelationship' Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods (==) :: GetAccountsAccountPersonsParametersQueryRelationship' -> GetAccountsAccountPersonsParametersQueryRelationship' -> Bool # (/=) :: GetAccountsAccountPersonsParametersQueryRelationship' -> GetAccountsAccountPersonsParametersQueryRelationship' -> Bool #
Show GetAccountsAccountPersonsParametersQueryRelationship' Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods showsPrec :: Int -> GetAccountsAccountPersonsParametersQueryRelationship' -> ShowS # show :: GetAccountsAccountPersonsParametersQueryRelationship' -> String # showList :: [GetAccountsAccountPersonsParametersQueryRelationship'] -> ShowS #
ToJSON GetAccountsAccountPersonsParametersQueryRelationship' Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods toJSON :: GetAccountsAccountPersonsParametersQueryRelationship' -> Value # toEncoding :: GetAccountsAccountPersonsParametersQueryRelationship' -> Encoding # toJSONList :: [GetAccountsAccountPersonsParametersQueryRelationship'] -> Value # toEncodingList :: [GetAccountsAccountPersonsParametersQueryRelationship'] -> Encoding #
FromJSON GetAccountsAccountPersonsParametersQueryRelationship' Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods parseJSON :: Value -> Parser GetAccountsAccountPersonsParametersQueryRelationship' # parseJSONList :: Value -> Parser [GetAccountsAccountPersonsParametersQueryRelationship'] #

mkGetAccountsAccountPersonsParametersQueryRelationship' :: GetAccountsAccountPersonsParametersQueryRelationship' Source #

Create a new GetAccountsAccountPersonsParametersQueryRelationship' with all required fields.

data GetAccountsAccountPersonsResponse Source #

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

Instances details

Eq GetAccountsAccountPersonsResponse Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods (==) :: GetAccountsAccountPersonsResponse -> GetAccountsAccountPersonsResponse -> Bool # (/=) :: GetAccountsAccountPersonsResponse -> GetAccountsAccountPersonsResponse -> Bool #
Show GetAccountsAccountPersonsResponse Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods showsPrec :: Int -> GetAccountsAccountPersonsResponse -> ShowS # show :: GetAccountsAccountPersonsResponse -> String # showList :: [GetAccountsAccountPersonsResponse] -> ShowS #

data GetAccountsAccountPersonsResponseBody200 Source #

Defines the object schema located at paths./v1/accounts/{account}/persons.GET.responses.200.content.application/json.schema in the specification.

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. getAccountsAccountPersonsResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000

Instances

Instances details

Eq GetAccountsAccountPersonsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods (==) :: GetAccountsAccountPersonsResponseBody200 -> GetAccountsAccountPersonsResponseBody200 -> Bool # (/=) :: GetAccountsAccountPersonsResponseBody200 -> GetAccountsAccountPersonsResponseBody200 -> Bool #
Show GetAccountsAccountPersonsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods showsPrec :: Int -> GetAccountsAccountPersonsResponseBody200 -> ShowS # show :: GetAccountsAccountPersonsResponseBody200 -> String # showList :: [GetAccountsAccountPersonsResponseBody200] -> ShowS #
ToJSON GetAccountsAccountPersonsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods toJSON :: GetAccountsAccountPersonsResponseBody200 -> Value # toEncoding :: GetAccountsAccountPersonsResponseBody200 -> Encoding # toJSONList :: [GetAccountsAccountPersonsResponseBody200] -> Value # toEncodingList :: [GetAccountsAccountPersonsResponseBody200] -> Encoding #
FromJSON GetAccountsAccountPersonsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPersons Methods parseJSON :: Value -> Parser GetAccountsAccountPersonsResponseBody200 # parseJSONList :: Value -> Parser [GetAccountsAccountPersonsResponseBody200] #

mkGetAccountsAccountPersonsResponseBody200 Source #

Arguments

:: [Person]	`getAccountsAccountPersonsResponseBody200Data`
-> Bool	`getAccountsAccountPersonsResponseBody200HasMore`
-> Text	`getAccountsAccountPersonsResponseBody200Url`
-> GetAccountsAccountPersonsResponseBody200

Create a new GetAccountsAccountPersonsResponseBody200 with all required fields.