Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetIssuingCardholders

Description

Contains the different functions to run the operation getIssuingCardholders

Synopsis

getIssuingCardholders :: forall m. MonadHTTP m => GetIssuingCardholdersParameters -> StripeT m (Response GetIssuingCardholdersResponse)
data GetIssuingCardholdersParameters = GetIssuingCardholdersParameters {
}
mkGetIssuingCardholdersParameters :: GetIssuingCardholdersParameters
data GetIssuingCardholdersParametersQueryCreated'OneOf1 = GetIssuingCardholdersParametersQueryCreated'OneOf1 {
}
mkGetIssuingCardholdersParametersQueryCreated'OneOf1 :: GetIssuingCardholdersParametersQueryCreated'OneOf1
data GetIssuingCardholdersParametersQueryCreated'Variants
- = GetIssuingCardholdersParametersQueryCreated'GetIssuingCardholdersParametersQueryCreated'OneOf1 GetIssuingCardholdersParametersQueryCreated'OneOf1
- | GetIssuingCardholdersParametersQueryCreated'Int Int
data GetIssuingCardholdersParametersQueryStatus'
data GetIssuingCardholdersParametersQueryType'
data GetIssuingCardholdersResponse
data GetIssuingCardholdersResponseBody200 = GetIssuingCardholdersResponseBody200 {
}
mkGetIssuingCardholdersResponseBody200 :: [Issuing'cardholder] -> Bool -> Text -> GetIssuingCardholdersResponseBody200

Documentation

getIssuingCardholders Source #

Arguments

:: forall m. MonadHTTP m
=> GetIssuingCardholdersParameters	Contains all available parameters of this operation (query and path parameters)
-> StripeT m (Response GetIssuingCardholdersResponse)	Monadic computation which returns the result of the operation

GET /v1/issuing/cardholders

<p>Returns a list of Issuing <code>Cardholder</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

data GetIssuingCardholdersParameters Source #

Defines the object schema located at paths./v1/issuing/cardholders.GET.parameters in the specification.

Constructors

GetIssuingCardholdersParameters

Fields

getIssuingCardholdersParametersQueryCreated :: Maybe GetIssuingCardholdersParametersQueryCreated'Variants
queryCreated: Represents the parameter named 'created'
Only return cardholders that were created during the given date interval.
getIssuingCardholdersParametersQueryEmail :: Maybe Text
queryEmail: Represents the parameter named 'email'
Only return cardholders that have the given email address.
getIssuingCardholdersParametersQueryEndingBefore :: 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
getIssuingCardholdersParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getIssuingCardholdersParametersQueryLimit :: 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.
getIssuingCardholdersParametersQueryPhoneNumber :: Maybe Text
queryPhone_number: Represents the parameter named 'phone_number'
Only return cardholders that have the given phone number.
getIssuingCardholdersParametersQueryStartingAfter :: 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
getIssuingCardholdersParametersQueryStatus :: Maybe GetIssuingCardholdersParametersQueryStatus'
queryStatus: Represents the parameter named 'status'
Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.
getIssuingCardholdersParametersQueryType :: Maybe GetIssuingCardholdersParametersQueryType'
queryType: Represents the parameter named 'type'
Only return cardholders that have the given type. One of `individual` or `company`.

Instances

Instances details

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

mkGetIssuingCardholdersParameters :: GetIssuingCardholdersParameters Source #

Create a new GetIssuingCardholdersParameters with all required fields.

data GetIssuingCardholdersParametersQueryCreated'OneOf1 Source #

Defines the object schema located at paths./v1/issuing/cardholders.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetIssuingCardholdersParametersQueryCreated'OneOf1
Fields getIssuingCardholdersParametersQueryCreated'OneOf1Gt :: Maybe Int gt getIssuingCardholdersParametersQueryCreated'OneOf1Gte :: Maybe Int gte getIssuingCardholdersParametersQueryCreated'OneOf1Lt :: Maybe Int lt getIssuingCardholdersParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

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

mkGetIssuingCardholdersParametersQueryCreated'OneOf1 :: GetIssuingCardholdersParametersQueryCreated'OneOf1 Source #

Create a new GetIssuingCardholdersParametersQueryCreated'OneOf1 with all required fields.

data GetIssuingCardholdersParametersQueryCreated'Variants Source #

Defines the oneOf schema located at paths./v1/issuing/cardholders.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Only return cardholders that were created during the given date interval.

Constructors

GetIssuingCardholdersParametersQueryCreated'GetIssuingCardholdersParametersQueryCreated'OneOf1 GetIssuingCardholdersParametersQueryCreated'OneOf1
GetIssuingCardholdersParametersQueryCreated'Int Int

Instances

Instances details

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

data GetIssuingCardholdersParametersQueryStatus' Source #

Defines the enum schema located at paths./v1/issuing/cardholders.GET.parameters.properties.queryStatus in the specification.

Represents the parameter named 'status'

Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.

Constructors

GetIssuingCardholdersParametersQueryStatus'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetIssuingCardholdersParametersQueryStatus'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
GetIssuingCardholdersParametersQueryStatus'EnumActive	Represents the JSON value `"active"`
GetIssuingCardholdersParametersQueryStatus'EnumBlocked	Represents the JSON value `"blocked"`
GetIssuingCardholdersParametersQueryStatus'EnumInactive	Represents the JSON value `"inactive"`

Instances

Instances details

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

data GetIssuingCardholdersParametersQueryType' Source #

Defines the enum schema located at paths./v1/issuing/cardholders.GET.parameters.properties.queryType in the specification.

Represents the parameter named 'type'

Only return cardholders that have the given type. One of `individual` or `company`.

Constructors

GetIssuingCardholdersParametersQueryType'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetIssuingCardholdersParametersQueryType'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
GetIssuingCardholdersParametersQueryType'EnumCompany	Represents the JSON value `"company"`
GetIssuingCardholdersParametersQueryType'EnumIndividual	Represents the JSON value `"individual"`

Instances

Instances details

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

data GetIssuingCardholdersResponse Source #

Represents a response of the operation getIssuingCardholders.

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

Constructors

GetIssuingCardholdersResponseError String	Means either no matching case available or a parse error
GetIssuingCardholdersResponse200 GetIssuingCardholdersResponseBody200	Successful response.
GetIssuingCardholdersResponseDefault Error	Error response.

Instances

Instances details

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

data GetIssuingCardholdersResponseBody200 Source #

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

Constructors

GetIssuingCardholdersResponseBody200
Fields getIssuingCardholdersResponseBody200Data :: [Issuing'cardholder] data getIssuingCardholdersResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getIssuingCardholdersResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000 Must match pattern '^/v1/issuing/cardholders'

Instances

Instances details

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

mkGetIssuingCardholdersResponseBody200 Source #

Arguments

:: [Issuing'cardholder]	`getIssuingCardholdersResponseBody200Data`
-> Bool	`getIssuingCardholdersResponseBody200HasMore`
-> Text	`getIssuingCardholdersResponseBody200Url`
-> GetIssuingCardholdersResponseBody200

Create a new GetIssuingCardholdersResponseBody200 with all required fields.