Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetRecipients

Description

Contains the different functions to run the operation getRecipients

Synopsis

getRecipients :: forall m. MonadHTTP m => GetRecipientsParameters -> StripeT m (Response GetRecipientsResponse)
data GetRecipientsParameters = GetRecipientsParameters {
}
mkGetRecipientsParameters :: GetRecipientsParameters
data GetRecipientsParametersQueryCreated'OneOf1 = GetRecipientsParametersQueryCreated'OneOf1 {
}
mkGetRecipientsParametersQueryCreated'OneOf1 :: GetRecipientsParametersQueryCreated'OneOf1
data GetRecipientsParametersQueryCreated'Variants
- = GetRecipientsParametersQueryCreated'GetRecipientsParametersQueryCreated'OneOf1 GetRecipientsParametersQueryCreated'OneOf1
- | GetRecipientsParametersQueryCreated'Int Int
data GetRecipientsParametersQueryType'
data GetRecipientsResponse
data GetRecipientsResponseBody200 = GetRecipientsResponseBody200 {
}
mkGetRecipientsResponseBody200 :: [Recipient] -> Bool -> Text -> GetRecipientsResponseBody200

Documentation

getRecipients Source #

Arguments

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

GET /v1/recipients

<p>Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.</p>

data GetRecipientsParameters Source #

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

Constructors

GetRecipientsParameters

Fields

getRecipientsParametersQueryCreated :: Maybe GetRecipientsParametersQueryCreated'Variants
queryCreated: Represents the parameter named 'created'
getRecipientsParametersQueryEndingBefore :: 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
getRecipientsParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getRecipientsParametersQueryLimit :: 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.
getRecipientsParametersQueryStartingAfter :: 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
getRecipientsParametersQueryType :: Maybe GetRecipientsParametersQueryType'
queryType: Represents the parameter named 'type'
Constraints:
- Maximum length of 5000
getRecipientsParametersQueryVerified :: Maybe Bool
queryVerified: Represents the parameter named 'verified'
Only return recipients that are verified or unverified.

Instances

Instances details

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

mkGetRecipientsParameters :: GetRecipientsParameters Source #

Create a new GetRecipientsParameters with all required fields.

data GetRecipientsParametersQueryCreated'OneOf1 Source #

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

Constructors

GetRecipientsParametersQueryCreated'OneOf1
Fields getRecipientsParametersQueryCreated'OneOf1Gt :: Maybe Int gt getRecipientsParametersQueryCreated'OneOf1Gte :: Maybe Int gte getRecipientsParametersQueryCreated'OneOf1Lt :: Maybe Int lt getRecipientsParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

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

mkGetRecipientsParametersQueryCreated'OneOf1 :: GetRecipientsParametersQueryCreated'OneOf1 Source #

Create a new GetRecipientsParametersQueryCreated'OneOf1 with all required fields.

data GetRecipientsParametersQueryCreated'Variants Source #

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

Represents the parameter named 'created'

Constructors

GetRecipientsParametersQueryCreated'GetRecipientsParametersQueryCreated'OneOf1 GetRecipientsParametersQueryCreated'OneOf1
GetRecipientsParametersQueryCreated'Int Int

Instances

Instances details

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

data GetRecipientsParametersQueryType' Source #

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

Represents the parameter named 'type'

Constructors

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

Instances

Instances details

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

data GetRecipientsResponse Source #

Represents a response of the operation getRecipients.

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

Constructors

GetRecipientsResponseError String	Means either no matching case available or a parse error
GetRecipientsResponse200 GetRecipientsResponseBody200	Successful response.
GetRecipientsResponseDefault Error	Error response.

Instances

Instances details

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

data GetRecipientsResponseBody200 Source #

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

Constructors

GetRecipientsResponseBody200
Fields getRecipientsResponseBody200Data :: [Recipient] data getRecipientsResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getRecipientsResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000 Must match pattern '^/v1/recipients'

Instances

Instances details

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

mkGetRecipientsResponseBody200 Source #

Arguments

:: [Recipient]	`getRecipientsResponseBody200Data`
-> Bool	`getRecipientsResponseBody200HasMore`
-> Text	`getRecipientsResponseBody200Url`
-> GetRecipientsResponseBody200

Create a new GetRecipientsResponseBody200 with all required fields.