Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Operations.GetAccountPersons
Description
Contains the different functions to run the operation getAccountPersons
Synopsis
- getAccountPersons :: forall m. MonadHTTP m => GetAccountPersonsParameters -> ClientT m (Response GetAccountPersonsResponse)
- data GetAccountPersonsParameters = GetAccountPersonsParameters {
- getAccountPersonsParametersQueryEndingBefore :: Maybe Text
- getAccountPersonsParametersQueryExpand :: Maybe [Text]
- getAccountPersonsParametersQueryLimit :: Maybe Int
- getAccountPersonsParametersQueryRelationship :: Maybe GetAccountPersonsParametersQueryRelationship'
- getAccountPersonsParametersQueryStartingAfter :: Maybe Text
- mkGetAccountPersonsParameters :: GetAccountPersonsParameters
- data GetAccountPersonsParametersQueryRelationship' = GetAccountPersonsParametersQueryRelationship' {}
- mkGetAccountPersonsParametersQueryRelationship' :: GetAccountPersonsParametersQueryRelationship'
- data GetAccountPersonsResponse
- data GetAccountPersonsResponseBody200 = GetAccountPersonsResponseBody200 {}
- mkGetAccountPersonsResponseBody200 :: [Person] -> Bool -> Text -> GetAccountPersonsResponseBody200
Documentation
Arguments
:: forall m. MonadHTTP m | |
=> GetAccountPersonsParameters | Contains all available parameters of this operation (query and path parameters) |
-> ClientT m (Response GetAccountPersonsResponse) | Monadic computation which returns the result of the operation |
GET /v1/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 GetAccountPersonsParameters Source #
Defines the object schema located at paths./v1/account/persons.GET.parameters
in the specification.
Constructors
GetAccountPersonsParameters | |
Fields
|
Instances
mkGetAccountPersonsParameters :: GetAccountPersonsParameters Source #
Create a new GetAccountPersonsParameters
with all required fields.
data GetAccountPersonsParametersQueryRelationship' Source #
Defines the object schema located at paths./v1/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
Instances
mkGetAccountPersonsParametersQueryRelationship' :: GetAccountPersonsParametersQueryRelationship' Source #
Create a new GetAccountPersonsParametersQueryRelationship'
with all required fields.
data GetAccountPersonsResponse Source #
Represents a response of the operation getAccountPersons
.
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), GetAccountPersonsResponseError
is used.
Constructors
GetAccountPersonsResponseError String | Means either no matching case available or a parse error |
GetAccountPersonsResponse200 GetAccountPersonsResponseBody200 | Successful response. |
GetAccountPersonsResponseDefault Error | Error response. |
Instances
Eq GetAccountPersonsResponse Source # | |
Defined in StripeAPI.Operations.GetAccountPersons Methods (==) :: GetAccountPersonsResponse -> GetAccountPersonsResponse -> Bool # (/=) :: GetAccountPersonsResponse -> GetAccountPersonsResponse -> Bool # | |
Show GetAccountPersonsResponse Source # | |
Defined in StripeAPI.Operations.GetAccountPersons Methods showsPrec :: Int -> GetAccountPersonsResponse -> ShowS # show :: GetAccountPersonsResponse -> String # showList :: [GetAccountPersonsResponse] -> ShowS # |
data GetAccountPersonsResponseBody200 Source #
Defines the object schema located at paths./v1/account/persons.GET.responses.200.content.application/json.schema
in the specification.
Constructors
GetAccountPersonsResponseBody200 | |
Fields
|
Instances
mkGetAccountPersonsResponseBody200 Source #
Arguments
:: [Person] | |
-> Bool | |
-> Text | |
-> GetAccountPersonsResponseBody200 |
Create a new GetAccountPersonsResponseBody200
with all required fields.