Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetAccountsAccountPeople

Contains the different functions to run the operation getAccountsAccountPeople

4 types
4 values

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourceGetAccountsAccountPeople.hs

valuegetAccountsAccountPeople

:: MonadHTTP m
=> GetAccountsAccountPeopleParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetAccountsAccountPeopleResponse)
Monadic computation which returns the result of the operation

GET /v1/accounts/{account}/people

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

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

Constructors

GetAccountsAccountPeopleParameters
- getAccountsAccountPeopleParametersPathAccount :: Text
  pathAccount: Represents the parameter named 'account'
  Constraints:
  - Maximum length of 5000
- getAccountsAccountPeopleParametersQueryEndingBefore :: 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
- getAccountsAccountPeopleParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getAccountsAccountPeopleParametersQueryLimit :: 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.
- getAccountsAccountPeopleParametersQueryRelationship :: Maybe GetAccountsAccountPeopleParametersQueryRelationship'
  queryRelationship: Represents the parameter named 'relationship'
  Filters on the list of people returned based on the person's relationship to the account's company.
- getAccountsAccountPeopleParametersQueryStartingAfter :: 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 GetAccountsAccountPeopleParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople
Show GetAccountsAccountPeopleParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople
FromJSON GetAccountsAccountPeopleParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople
ToJSON GetAccountsAccountPeopleParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople

valuemkGetAccountsAccountPeopleParameters

:: Text
getAccountsAccountPeopleParametersPathAccount
-> GetAccountsAccountPeopleParameters

Create a new GetAccountsAccountPeopleParameters with all required fields.

datadata GetAccountsAccountPeopleParametersQueryRelationship'

Defines the object schema located at paths./v1/accounts/{account}/people.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

GetAccountsAccountPeopleParametersQueryRelationship'
- getAccountsAccountPeopleParametersQueryRelationship'Director :: Maybe Bool
  director
- getAccountsAccountPeopleParametersQueryRelationship'Executive :: Maybe Bool
  executive
- getAccountsAccountPeopleParametersQueryRelationship'Owner :: Maybe Bool
  owner
- getAccountsAccountPeopleParametersQueryRelationship'Representative :: Maybe Bool
  representative

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountsAccountPeopleParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople
Show GetAccountsAccountPeopleParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople
FromJSON GetAccountsAccountPeopleParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople
ToJSON GetAccountsAccountPeopleParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople

valuemkGetAccountsAccountPeopleParametersQueryRelationship' :: GetAccountsAccountPeopleParametersQueryRelationship'

Create a new GetAccountsAccountPeopleParametersQueryRelationship' with all required fields.

datadata GetAccountsAccountPeopleResponse

Represents a response of the operation getAccountsAccountPeople.

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

Constructors

GetAccountsAccountPeopleResponseError String
Means either no matching case available or a parse error
GetAccountsAccountPeopleResponse200 GetAccountsAccountPeopleResponseBody200
Successful response.
GetAccountsAccountPeopleResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetAccountsAccountPeopleResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople
Show GetAccountsAccountPeopleResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople

datadata GetAccountsAccountPeopleResponseBody200

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountsAccountPeopleResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople
Show GetAccountsAccountPeopleResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople
FromJSON GetAccountsAccountPeopleResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople
ToJSON GetAccountsAccountPeopleResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountsAccountPeople

valuemkGetAccountsAccountPeopleResponseBody200

:: [Person]
getAccountsAccountPeopleResponseBody200Data
-> Bool
getAccountsAccountPeopleResponseBody200HasMore
-> Text
getAccountsAccountPeopleResponseBody200Url
-> GetAccountsAccountPeopleResponseBody200

Create a new GetAccountsAccountPeopleResponseBody200 with all required fields.