Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetAccountPersons

Description

Contains the different functions to run the operation getAccountPersons

Synopsis

getAccountPersons :: forall m. MonadHTTP m => GetAccountPersonsParameters -> StripeT m (Response GetAccountPersonsResponse)
data GetAccountPersonsParameters = GetAccountPersonsParameters {
}
mkGetAccountPersonsParameters :: GetAccountPersonsParameters
data GetAccountPersonsParametersQueryRelationship' = GetAccountPersonsParametersQueryRelationship' {
}
mkGetAccountPersonsParametersQueryRelationship' :: GetAccountPersonsParametersQueryRelationship'
data GetAccountPersonsResponse
data GetAccountPersonsResponseBody200 = GetAccountPersonsResponseBody200 {
}
mkGetAccountPersonsResponseBody200 :: [Person] -> Bool -> Text -> GetAccountPersonsResponseBody200

Documentation

getAccountPersons Source #

Arguments

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

data GetAccountPersonsParameters Source #

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

Constructors

GetAccountPersonsParameters

Fields

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

Instances

Instances details

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

mkGetAccountPersonsParameters :: GetAccountPersonsParameters Source #

Create a new GetAccountPersonsParameters with all required fields.

data GetAccountPersonsParametersQueryRelationship' Source #

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

Instances

Instances details

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

mkGetAccountPersonsParametersQueryRelationship' :: GetAccountPersonsParametersQueryRelationship' Source #

Create a new GetAccountPersonsParametersQueryRelationship' with all required fields.

data GetAccountPersonsResponse Source #

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.

Instances

Instances details

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

data GetAccountPersonsResponseBody200 Source #

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

Constructors

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

Instances

Instances details

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

mkGetAccountPersonsResponseBody200 Source #

Arguments

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

Create a new GetAccountPersonsResponseBody200 with all required fields.