Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetAccountsAccountPeople

Description

Contains the different functions to run the operation getAccountsAccountPeople

Synopsis

getAccountsAccountPeople :: forall m. MonadHTTP m => GetAccountsAccountPeopleParameters -> StripeT m (Response GetAccountsAccountPeopleResponse)
data GetAccountsAccountPeopleParameters = GetAccountsAccountPeopleParameters {
}
mkGetAccountsAccountPeopleParameters :: Text -> GetAccountsAccountPeopleParameters
data GetAccountsAccountPeopleParametersQueryRelationship' = GetAccountsAccountPeopleParametersQueryRelationship' {
}
mkGetAccountsAccountPeopleParametersQueryRelationship' :: GetAccountsAccountPeopleParametersQueryRelationship'
data GetAccountsAccountPeopleResponse
data GetAccountsAccountPeopleResponseBody200 = GetAccountsAccountPeopleResponseBody200 {
}
mkGetAccountsAccountPeopleResponseBody200 :: [Person] -> Bool -> Text -> GetAccountsAccountPeopleResponseBody200

Documentation

getAccountsAccountPeople Source #

Arguments

:: forall m. MonadHTTP m
=> GetAccountsAccountPeopleParameters	Contains all available parameters of this operation (query and path parameters)
-> StripeT 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>

data GetAccountsAccountPeopleParameters Source #

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

Constructors

GetAccountsAccountPeopleParameters

Fields

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

Instances

Instances details

Eq GetAccountsAccountPeopleParameters Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods (==) :: GetAccountsAccountPeopleParameters -> GetAccountsAccountPeopleParameters -> Bool # (/=) :: GetAccountsAccountPeopleParameters -> GetAccountsAccountPeopleParameters -> Bool #
Show GetAccountsAccountPeopleParameters Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods showsPrec :: Int -> GetAccountsAccountPeopleParameters -> ShowS # show :: GetAccountsAccountPeopleParameters -> String # showList :: [GetAccountsAccountPeopleParameters] -> ShowS #
ToJSON GetAccountsAccountPeopleParameters Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods toJSON :: GetAccountsAccountPeopleParameters -> Value # toEncoding :: GetAccountsAccountPeopleParameters -> Encoding # toJSONList :: [GetAccountsAccountPeopleParameters] -> Value # toEncodingList :: [GetAccountsAccountPeopleParameters] -> Encoding #
FromJSON GetAccountsAccountPeopleParameters Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods parseJSON :: Value -> Parser GetAccountsAccountPeopleParameters # parseJSONList :: Value -> Parser [GetAccountsAccountPeopleParameters] #

mkGetAccountsAccountPeopleParameters Source #

Arguments

:: Text	`getAccountsAccountPeopleParametersPathAccount`
-> GetAccountsAccountPeopleParameters

Create a new GetAccountsAccountPeopleParameters with all required fields.

data GetAccountsAccountPeopleParametersQueryRelationship' Source #

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

Instances

Instances details

Eq GetAccountsAccountPeopleParametersQueryRelationship' Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods (==) :: GetAccountsAccountPeopleParametersQueryRelationship' -> GetAccountsAccountPeopleParametersQueryRelationship' -> Bool # (/=) :: GetAccountsAccountPeopleParametersQueryRelationship' -> GetAccountsAccountPeopleParametersQueryRelationship' -> Bool #
Show GetAccountsAccountPeopleParametersQueryRelationship' Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods showsPrec :: Int -> GetAccountsAccountPeopleParametersQueryRelationship' -> ShowS # show :: GetAccountsAccountPeopleParametersQueryRelationship' -> String # showList :: [GetAccountsAccountPeopleParametersQueryRelationship'] -> ShowS #
ToJSON GetAccountsAccountPeopleParametersQueryRelationship' Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods toJSON :: GetAccountsAccountPeopleParametersQueryRelationship' -> Value # toEncoding :: GetAccountsAccountPeopleParametersQueryRelationship' -> Encoding # toJSONList :: [GetAccountsAccountPeopleParametersQueryRelationship'] -> Value # toEncodingList :: [GetAccountsAccountPeopleParametersQueryRelationship'] -> Encoding #
FromJSON GetAccountsAccountPeopleParametersQueryRelationship' Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods parseJSON :: Value -> Parser GetAccountsAccountPeopleParametersQueryRelationship' # parseJSONList :: Value -> Parser [GetAccountsAccountPeopleParametersQueryRelationship'] #

mkGetAccountsAccountPeopleParametersQueryRelationship' :: GetAccountsAccountPeopleParametersQueryRelationship' Source #

Create a new GetAccountsAccountPeopleParametersQueryRelationship' with all required fields.

data GetAccountsAccountPeopleResponse Source #

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.

Instances

Instances details

Eq GetAccountsAccountPeopleResponse Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods (==) :: GetAccountsAccountPeopleResponse -> GetAccountsAccountPeopleResponse -> Bool # (/=) :: GetAccountsAccountPeopleResponse -> GetAccountsAccountPeopleResponse -> Bool #
Show GetAccountsAccountPeopleResponse Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods showsPrec :: Int -> GetAccountsAccountPeopleResponse -> ShowS # show :: GetAccountsAccountPeopleResponse -> String # showList :: [GetAccountsAccountPeopleResponse] -> ShowS #

data GetAccountsAccountPeopleResponseBody200 Source #

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

Constructors

GetAccountsAccountPeopleResponseBody200
Fields 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

Instances

Instances details

Eq GetAccountsAccountPeopleResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods (==) :: GetAccountsAccountPeopleResponseBody200 -> GetAccountsAccountPeopleResponseBody200 -> Bool # (/=) :: GetAccountsAccountPeopleResponseBody200 -> GetAccountsAccountPeopleResponseBody200 -> Bool #
Show GetAccountsAccountPeopleResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods showsPrec :: Int -> GetAccountsAccountPeopleResponseBody200 -> ShowS # show :: GetAccountsAccountPeopleResponseBody200 -> String # showList :: [GetAccountsAccountPeopleResponseBody200] -> ShowS #
ToJSON GetAccountsAccountPeopleResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods toJSON :: GetAccountsAccountPeopleResponseBody200 -> Value # toEncoding :: GetAccountsAccountPeopleResponseBody200 -> Encoding # toJSONList :: [GetAccountsAccountPeopleResponseBody200] -> Value # toEncodingList :: [GetAccountsAccountPeopleResponseBody200] -> Encoding #
FromJSON GetAccountsAccountPeopleResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetAccountsAccountPeople Methods parseJSON :: Value -> Parser GetAccountsAccountPeopleResponseBody200 # parseJSONList :: Value -> Parser [GetAccountsAccountPeopleResponseBody200] #

mkGetAccountsAccountPeopleResponseBody200 Source #

Arguments

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

Create a new GetAccountsAccountPeopleResponseBody200 with all required fields.