Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTopups

Contains the different functions to run the operation getTopups

8 types
5 values

Packagestripeapi-3.0.0.0
Exports13
LanguageHaskell2010
LicenceMIT
SourceGetTopups.hs

valuegetTopups

:: MonadHTTP m
=> GetTopupsParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetTopupsResponse)
Monadic computation which returns the result of the operation

GET /v1/topups

<p>Returns a list of top-ups.</p>

datadata GetTopupsParameters

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

Constructors

GetTopupsParameters
- getTopupsParametersQueryAmount :: Maybe GetTopupsParametersQueryAmount'Variants
  queryAmount: Represents the parameter named 'amount'
  A positive integer representing how much to transfer.
- getTopupsParametersQueryCreated :: Maybe GetTopupsParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
  A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
- getTopupsParametersQueryEndingBefore :: 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
- getTopupsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getTopupsParametersQueryLimit :: 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.
- getTopupsParametersQueryStartingAfter :: 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
- getTopupsParametersQueryStatus :: Maybe GetTopupsParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTopupsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
Show GetTopupsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
FromJSON GetTopupsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
ToJSON GetTopupsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups

valuemkGetTopupsParameters :: GetTopupsParameters

Create a new GetTopupsParameters with all required fields.

datadata GetTopupsParametersQueryAmount'OneOf1

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

Constructors

GetTopupsParametersQueryAmount'OneOf1
- getTopupsParametersQueryAmount'OneOf1Gt :: Maybe Int
  gt
- getTopupsParametersQueryAmount'OneOf1Gte :: Maybe Int
  gte
- getTopupsParametersQueryAmount'OneOf1Lt :: Maybe Int
  lt
- getTopupsParametersQueryAmount'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTopupsParametersQueryAmount'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
Show GetTopupsParametersQueryAmount'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
FromJSON GetTopupsParametersQueryAmount'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
ToJSON GetTopupsParametersQueryAmount'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups

valuemkGetTopupsParametersQueryAmount'OneOf1 :: GetTopupsParametersQueryAmount'OneOf1

Create a new GetTopupsParametersQueryAmount'OneOf1 with all required fields.

datadata GetTopupsParametersQueryAmount'Variants

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

Represents the parameter named 'amount'

A positive integer representing how much to transfer.

Constructors

GetTopupsParametersQueryAmount'GetTopupsParametersQueryAmount'OneOf1 GetTopupsParametersQueryAmount'OneOf1
GetTopupsParametersQueryAmount'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTopupsParametersQueryAmount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
Show GetTopupsParametersQueryAmount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
FromJSON GetTopupsParametersQueryAmount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
ToJSON GetTopupsParametersQueryAmount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups

datadata GetTopupsParametersQueryCreated'OneOf1

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

Constructors

GetTopupsParametersQueryCreated'OneOf1
- getTopupsParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getTopupsParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getTopupsParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getTopupsParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTopupsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
Show GetTopupsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
FromJSON GetTopupsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
ToJSON GetTopupsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups

valuemkGetTopupsParametersQueryCreated'OneOf1 :: GetTopupsParametersQueryCreated'OneOf1

Create a new GetTopupsParametersQueryCreated'OneOf1 with all required fields.

datadata GetTopupsParametersQueryCreated'Variants

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

Represents the parameter named 'created'

A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

Constructors

GetTopupsParametersQueryCreated'GetTopupsParametersQueryCreated'OneOf1 GetTopupsParametersQueryCreated'OneOf1
GetTopupsParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTopupsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
Show GetTopupsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
FromJSON GetTopupsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
ToJSON GetTopupsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups

datadata GetTopupsParametersQueryStatus'

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

Represents the parameter named 'status'

Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.

Constructors

GetTopupsParametersQueryStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTopupsParametersQueryStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTopupsParametersQueryStatus'EnumCanceled
Represents the JSON value "canceled"
GetTopupsParametersQueryStatus'EnumFailed
Represents the JSON value "failed"
GetTopupsParametersQueryStatus'EnumPending
Represents the JSON value "pending"
GetTopupsParametersQueryStatus'EnumSucceeded
Represents the JSON value "succeeded"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTopupsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
Show GetTopupsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
FromJSON GetTopupsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
ToJSON GetTopupsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups

datadata GetTopupsResponse

Represents a response of the operation getTopups.

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

Constructors

GetTopupsResponseError String
Means either no matching case available or a parse error
GetTopupsResponse200 GetTopupsResponseBody200
Successful response.
GetTopupsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTopupsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
Show GetTopupsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups

datadata GetTopupsResponseBody200

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

Constructors

GetTopupsResponseBody200
- getTopupsResponseBody200Data :: [Topup]
  data
- getTopupsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getTopupsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/topups'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTopupsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
Show GetTopupsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
FromJSON GetTopupsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups
ToJSON GetTopupsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTopups

valuemkGetTopupsResponseBody200

:: [Topup]
getTopupsResponseBody200Data
-> Bool
getTopupsResponseBody200HasMore
-> Text
getTopupsResponseBody200Url
-> GetTopupsResponseBody200

Create a new GetTopupsResponseBody200 with all required fields.