Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetRecipients

Contains the different functions to run the operation getRecipients

6 types
4 values

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourceGetRecipients.hs

valuegetRecipients

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

datadata GetRecipientsParameters

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

Constructors

GetRecipientsParameters
- 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.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRecipientsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
Show GetRecipientsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
FromJSON GetRecipientsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
ToJSON GetRecipientsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients

valuemkGetRecipientsParameters :: GetRecipientsParameters

Create a new GetRecipientsParameters with all required fields.

datadata GetRecipientsParametersQueryCreated'OneOf1

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRecipientsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
Show GetRecipientsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
FromJSON GetRecipientsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
ToJSON GetRecipientsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients

valuemkGetRecipientsParametersQueryCreated'OneOf1 :: GetRecipientsParametersQueryCreated'OneOf1

Create a new GetRecipientsParametersQueryCreated'OneOf1 with all required fields.

datadata GetRecipientsParametersQueryCreated'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRecipientsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
Show GetRecipientsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
FromJSON GetRecipientsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
ToJSON GetRecipientsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients

datadata GetRecipientsParametersQueryType'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRecipientsParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
Show GetRecipientsParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
FromJSON GetRecipientsParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
ToJSON GetRecipientsParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients

datadata GetRecipientsResponse

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.

Instances2Eq, Show

Eq GetRecipientsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
Show GetRecipientsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients

datadata GetRecipientsResponseBody200

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

Constructors

GetRecipientsResponseBody200
- 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'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRecipientsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
Show GetRecipientsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
FromJSON GetRecipientsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients
ToJSON GetRecipientsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRecipients

valuemkGetRecipientsResponseBody200

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

Create a new GetRecipientsResponseBody200 with all required fields.