Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation getTopups
Synopsis
- getTopups :: forall m. MonadHTTP m => GetTopupsParameters -> StripeT m (Response GetTopupsResponse)
- data GetTopupsParameters = GetTopupsParameters {
- getTopupsParametersQueryAmount :: Maybe GetTopupsParametersQueryAmount'Variants
- getTopupsParametersQueryCreated :: Maybe GetTopupsParametersQueryCreated'Variants
- getTopupsParametersQueryEndingBefore :: Maybe Text
- getTopupsParametersQueryExpand :: Maybe [Text]
- getTopupsParametersQueryLimit :: Maybe Int
- getTopupsParametersQueryStartingAfter :: Maybe Text
- getTopupsParametersQueryStatus :: Maybe GetTopupsParametersQueryStatus'
- mkGetTopupsParameters :: GetTopupsParameters
- data GetTopupsParametersQueryAmount'OneOf1 = GetTopupsParametersQueryAmount'OneOf1 {}
- mkGetTopupsParametersQueryAmount'OneOf1 :: GetTopupsParametersQueryAmount'OneOf1
- data GetTopupsParametersQueryAmount'Variants
- data GetTopupsParametersQueryCreated'OneOf1 = GetTopupsParametersQueryCreated'OneOf1 {}
- mkGetTopupsParametersQueryCreated'OneOf1 :: GetTopupsParametersQueryCreated'OneOf1
- data GetTopupsParametersQueryCreated'Variants
- data GetTopupsParametersQueryStatus'
- data GetTopupsResponse
- data GetTopupsResponseBody200 = GetTopupsResponseBody200 {}
- mkGetTopupsResponseBody200 :: [Topup] -> Bool -> Text -> GetTopupsResponseBody200
Documentation
:: forall m. MonadHTTP m | |
=> GetTopupsParameters | Contains all available parameters of this operation (query and path parameters) |
-> StripeT m (Response GetTopupsResponse) | Monadic computation which returns the result of the operation |
GET /v1/topups
<p>Returns a list of top-ups.</p>
data GetTopupsParameters Source #
Defines the object schema located at paths./v1/topups.GET.parameters
in the specification.
GetTopupsParameters | |
|
Instances
Eq GetTopupsParameters Source # | |
Defined in StripeAPI.Operations.GetTopups (==) :: GetTopupsParameters -> GetTopupsParameters -> Bool # (/=) :: GetTopupsParameters -> GetTopupsParameters -> Bool # | |
Show GetTopupsParameters Source # | |
Defined in StripeAPI.Operations.GetTopups showsPrec :: Int -> GetTopupsParameters -> ShowS # show :: GetTopupsParameters -> String # showList :: [GetTopupsParameters] -> ShowS # | |
ToJSON GetTopupsParameters Source # | |
Defined in StripeAPI.Operations.GetTopups toJSON :: GetTopupsParameters -> Value # toEncoding :: GetTopupsParameters -> Encoding # toJSONList :: [GetTopupsParameters] -> Value # toEncodingList :: [GetTopupsParameters] -> Encoding # | |
FromJSON GetTopupsParameters Source # | |
Defined in StripeAPI.Operations.GetTopups parseJSON :: Value -> Parser GetTopupsParameters # parseJSONList :: Value -> Parser [GetTopupsParameters] # |
mkGetTopupsParameters :: GetTopupsParameters Source #
Create a new GetTopupsParameters
with all required fields.
data GetTopupsParametersQueryAmount'OneOf1 Source #
Defines the object schema located at paths./v1/topups.GET.parameters.properties.queryAmount.anyOf
in the specification.
mkGetTopupsParametersQueryAmount'OneOf1 :: GetTopupsParametersQueryAmount'OneOf1 Source #
Create a new GetTopupsParametersQueryAmount'OneOf1
with all required fields.
data GetTopupsParametersQueryAmount'Variants Source #
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.
GetTopupsParametersQueryAmount'GetTopupsParametersQueryAmount'OneOf1 GetTopupsParametersQueryAmount'OneOf1 | |
GetTopupsParametersQueryAmount'Int Int |
data GetTopupsParametersQueryCreated'OneOf1 Source #
Defines the object schema located at paths./v1/topups.GET.parameters.properties.queryCreated.anyOf
in the specification.
mkGetTopupsParametersQueryCreated'OneOf1 :: GetTopupsParametersQueryCreated'OneOf1 Source #
Create a new GetTopupsParametersQueryCreated'OneOf1
with all required fields.
data GetTopupsParametersQueryCreated'Variants Source #
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.
GetTopupsParametersQueryCreated'GetTopupsParametersQueryCreated'OneOf1 GetTopupsParametersQueryCreated'OneOf1 | |
GetTopupsParametersQueryCreated'Int Int |
data GetTopupsParametersQueryStatus' Source #
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`.
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 |
GetTopupsParametersQueryStatus'EnumFailed | Represents the JSON value |
GetTopupsParametersQueryStatus'EnumPending | Represents the JSON value |
GetTopupsParametersQueryStatus'EnumSucceeded | Represents the JSON value |
data GetTopupsResponse Source #
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.
GetTopupsResponseError String | Means either no matching case available or a parse error |
GetTopupsResponse200 GetTopupsResponseBody200 | Successful response. |
GetTopupsResponseDefault Error | Error response. |
Instances
Eq GetTopupsResponse Source # | |
Defined in StripeAPI.Operations.GetTopups (==) :: GetTopupsResponse -> GetTopupsResponse -> Bool # (/=) :: GetTopupsResponse -> GetTopupsResponse -> Bool # | |
Show GetTopupsResponse Source # | |
Defined in StripeAPI.Operations.GetTopups showsPrec :: Int -> GetTopupsResponse -> ShowS # show :: GetTopupsResponse -> String # showList :: [GetTopupsResponse] -> ShowS # |
data GetTopupsResponseBody200 Source #
Defines the object schema located at paths./v1/topups.GET.responses.200.content.application/json.schema
in the specification.
GetTopupsResponseBody200 | |
|
Instances
Eq GetTopupsResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetTopups | |
Show GetTopupsResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetTopups showsPrec :: Int -> GetTopupsResponseBody200 -> ShowS # show :: GetTopupsResponseBody200 -> String # showList :: [GetTopupsResponseBody200] -> ShowS # | |
ToJSON GetTopupsResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetTopups | |
FromJSON GetTopupsResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetTopups |
mkGetTopupsResponseBody200 Source #
:: [Topup] | |
-> Bool | |
-> Text | |
-> GetTopupsResponseBody200 |
Create a new GetTopupsResponseBody200
with all required fields.