stripeapi-1.0.0.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetRecipients

Description

Contains the different functions to run the operation getRecipients

Synopsis

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

data GetRecipientsParametersQueryCreated'OneOf1 Source #

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

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'

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"

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.

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