Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetAccountsAccountPersons

Contains the different functions to run the operation getAccountsAccountPersons

Synopsis

value getAccountsAccountPersons
data GetAccountsAccountPersonsParameters
value mkGetAccountsAccountPersonsParameters
data GetAccountsAccountPersonsParametersQueryRelationship'
value mkGetAccountsAccountPersonsParametersQueryRelationship'
data GetAccountsAccountPersonsResponse
data GetAccountsAccountPersonsResponseBody200
value mkGetAccountsAccountPersonsResponseBody200

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourceGetAccountsAccountPersons.hs

valuegetAccountsAccountPersons

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

datadata GetAccountsAccountPersonsParameters

Source#

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountsAccountPersonsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons
Show GetAccountsAccountPersonsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons
FromJSON GetAccountsAccountPersonsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons
ToJSON GetAccountsAccountPersonsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons

valuemkGetAccountsAccountPersonsParameters

:: Text
getAccountsAccountPersonsParametersPathAccount
-> GetAccountsAccountPersonsParameters

Source#

Create a new GetAccountsAccountPersonsParameters with all required fields.

datadata 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'
- getAccountsAccountPersonsParametersQueryRelationship'Director :: Maybe Bool
  director
- getAccountsAccountPersonsParametersQueryRelationship'Executive :: Maybe Bool
  executive
- getAccountsAccountPersonsParametersQueryRelationship'Owner :: Maybe Bool
  owner
- getAccountsAccountPersonsParametersQueryRelationship'Representative :: Maybe Bool
  representative

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountsAccountPersonsParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons
Show GetAccountsAccountPersonsParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons
FromJSON GetAccountsAccountPersonsParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons
ToJSON GetAccountsAccountPersonsParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons

valuemkGetAccountsAccountPersonsParametersQueryRelationship' :: GetAccountsAccountPersonsParametersQueryRelationship'

Source#

Create a new GetAccountsAccountPersonsParametersQueryRelationship' with all required fields.

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

Instances2Eq, Show

Eq GetAccountsAccountPersonsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons
Show GetAccountsAccountPersonsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountsAccountPersonsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons
Show GetAccountsAccountPersonsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons
FromJSON GetAccountsAccountPersonsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons
ToJSON GetAccountsAccountPersonsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPersons

valuemkGetAccountsAccountPersonsResponseBody200

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

Source#

Create a new GetAccountsAccountPersonsResponseBody200 with all required fields.