Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetAccountPeople

Contains the different functions to run the operation getAccountPeople

4 types
4 values

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourceGetAccountPeople.hs

valuegetAccountPeople

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

GET /v1/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 GetAccountPeopleParameters

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

Constructors

GetAccountPeopleParameters
- getAccountPeopleParametersQueryEndingBefore :: 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
- getAccountPeopleParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getAccountPeopleParametersQueryLimit :: 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.
- getAccountPeopleParametersQueryRelationship :: Maybe GetAccountPeopleParametersQueryRelationship'
  queryRelationship: Represents the parameter named 'relationship'
  Filters on the list of people returned based on the person's relationship to the account's company.
- getAccountPeopleParametersQueryStartingAfter :: 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 GetAccountPeopleParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople
Show GetAccountPeopleParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople
FromJSON GetAccountPeopleParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople
ToJSON GetAccountPeopleParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople

valuemkGetAccountPeopleParameters :: GetAccountPeopleParameters

Create a new GetAccountPeopleParameters with all required fields.

datadata GetAccountPeopleParametersQueryRelationship'

Defines the object schema located at paths./v1/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

GetAccountPeopleParametersQueryRelationship'
- getAccountPeopleParametersQueryRelationship'Director :: Maybe Bool
  director
- getAccountPeopleParametersQueryRelationship'Executive :: Maybe Bool
  executive
- getAccountPeopleParametersQueryRelationship'Owner :: Maybe Bool
  owner
- getAccountPeopleParametersQueryRelationship'Representative :: Maybe Bool
  representative

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountPeopleParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople
Show GetAccountPeopleParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople
FromJSON GetAccountPeopleParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople
ToJSON GetAccountPeopleParametersQueryRelationship'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople

valuemkGetAccountPeopleParametersQueryRelationship' :: GetAccountPeopleParametersQueryRelationship'

Create a new GetAccountPeopleParametersQueryRelationship' with all required fields.

datadata GetAccountPeopleResponse

Represents a response of the operation getAccountPeople.

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

Constructors

GetAccountPeopleResponseError String
Means either no matching case available or a parse error
GetAccountPeopleResponse200 GetAccountPeopleResponseBody200
Successful response.
GetAccountPeopleResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetAccountPeopleResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople
Show GetAccountPeopleResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople

datadata GetAccountPeopleResponseBody200

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountPeopleResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople
Show GetAccountPeopleResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople
FromJSON GetAccountPeopleResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople
ToJSON GetAccountPeopleResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountPeople

valuemkGetAccountPeopleResponseBody200

:: [Person]
getAccountPeopleResponseBody200Data
-> Bool
getAccountPeopleResponseBody200HasMore
-> Text
getAccountPeopleResponseBody200Url
-> GetAccountPeopleResponseBody200

Create a new GetAccountPeopleResponseBody200 with all required fields.