Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetAccountPeople

Description

Contains the different functions to run the operation getAccountPeople

Synopsis

getAccountPeople :: forall m. MonadHTTP m => GetAccountPeopleParameters -> ClientT m (Response GetAccountPeopleResponse)
data GetAccountPeopleParameters = GetAccountPeopleParameters {
}
mkGetAccountPeopleParameters :: GetAccountPeopleParameters
data GetAccountPeopleParametersQueryRelationship' = GetAccountPeopleParametersQueryRelationship' {
}
mkGetAccountPeopleParametersQueryRelationship' :: GetAccountPeopleParametersQueryRelationship'
data GetAccountPeopleResponse
data GetAccountPeopleResponseBody200 = GetAccountPeopleResponseBody200 {
}
mkGetAccountPeopleResponseBody200 :: [Person] -> Bool -> Text -> GetAccountPeopleResponseBody200

Documentation

getAccountPeople Source #

Arguments

:: forall m. 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>

data GetAccountPeopleParameters Source #

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

Constructors

GetAccountPeopleParameters

Fields

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

Instances

Instances details

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

mkGetAccountPeopleParameters :: GetAccountPeopleParameters Source #

Create a new GetAccountPeopleParameters with all required fields.

data GetAccountPeopleParametersQueryRelationship' Source #

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

Instances

Instances details

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

mkGetAccountPeopleParametersQueryRelationship' :: GetAccountPeopleParametersQueryRelationship' Source #

Create a new GetAccountPeopleParametersQueryRelationship' with all required fields.

data GetAccountPeopleResponse Source #

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.

Instances

Instances details

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

data GetAccountPeopleResponseBody200 Source #

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

Constructors

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

Instances

Instances details

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

mkGetAccountPeopleResponseBody200 Source #

Arguments

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

Create a new GetAccountPeopleResponseBody200 with all required fields.