Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetAccountPersons

Contains the different functions to run the operation getAccountPersons

4 types
4 values

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourceGetAccountPersons.hs

valuegetAccountPersons

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

datadata GetAccountPersonsParameters

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

Constructors

GetAccountPersonsParameters
- getAccountPersonsParametersQueryEndingBefore :: 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
- getAccountPersonsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getAccountPersonsParametersQueryLimit :: 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.
- getAccountPersonsParametersQueryRelationship :: Maybe GetAccountPersonsParametersQueryRelationship'
  queryRelationship: Represents the parameter named 'relationship'
  Filters on the list of people returned based on the person's relationship to the account's company.
- getAccountPersonsParametersQueryStartingAfter :: 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 GetAccountPersonsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons
Show GetAccountPersonsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons
FromJSON GetAccountPersonsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons
ToJSON GetAccountPersonsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons

valuemkGetAccountPersonsParameters :: GetAccountPersonsParameters

Create a new GetAccountPersonsParameters with all required fields.

datadata GetAccountPersonsParametersQueryRelationship'

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

GetAccountPersonsParametersQueryRelationship'
- getAccountPersonsParametersQueryRelationship'Director :: Maybe Bool
  director
- getAccountPersonsParametersQueryRelationship'Executive :: Maybe Bool
  executive
- getAccountPersonsParametersQueryRelationship'Owner :: Maybe Bool
  owner
- getAccountPersonsParametersQueryRelationship'Representative :: Maybe Bool
  representative

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountPersonsParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons
Show GetAccountPersonsParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons
FromJSON GetAccountPersonsParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons
ToJSON GetAccountPersonsParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons

valuemkGetAccountPersonsParametersQueryRelationship' :: GetAccountPersonsParametersQueryRelationship'

Create a new GetAccountPersonsParametersQueryRelationship' with all required fields.

datadata GetAccountPersonsResponse

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.

Instances2Eq, Show

Eq GetAccountPersonsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons
Show GetAccountPersonsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons

datadata GetAccountPersonsResponseBody200

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

Constructors

GetAccountPersonsResponseBody200
- getAccountPersonsResponseBody200Data :: [Person]
  data
- getAccountPersonsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getAccountPersonsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountPersonsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons
Show GetAccountPersonsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons
FromJSON GetAccountPersonsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons
ToJSON GetAccountPersonsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPersons

valuemkGetAccountPersonsResponseBody200

:: [Person]
getAccountPersonsResponseBody200Data
-> Bool
getAccountPersonsResponseBody200HasMore
-> Text
getAccountPersonsResponseBody200Url
-> GetAccountPersonsResponseBody200

Create a new GetAccountPersonsResponseBody200 with all required fields.