Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetTopups

Description

Contains the different functions to run the operation getTopups

Synopsis

getTopups :: forall m. MonadHTTP m => GetTopupsParameters -> ClientT m (Response GetTopupsResponse)
data GetTopupsParameters = GetTopupsParameters {
}
mkGetTopupsParameters :: GetTopupsParameters
data GetTopupsParametersQueryAmount'OneOf1 = GetTopupsParametersQueryAmount'OneOf1 {
}
mkGetTopupsParametersQueryAmount'OneOf1 :: GetTopupsParametersQueryAmount'OneOf1
data GetTopupsParametersQueryAmount'Variants
- = GetTopupsParametersQueryAmount'GetTopupsParametersQueryAmount'OneOf1 GetTopupsParametersQueryAmount'OneOf1
- | GetTopupsParametersQueryAmount'Int Int
data GetTopupsParametersQueryCreated'OneOf1 = GetTopupsParametersQueryCreated'OneOf1 {
}
mkGetTopupsParametersQueryCreated'OneOf1 :: GetTopupsParametersQueryCreated'OneOf1
data GetTopupsParametersQueryCreated'Variants
- = GetTopupsParametersQueryCreated'GetTopupsParametersQueryCreated'OneOf1 GetTopupsParametersQueryCreated'OneOf1
- | GetTopupsParametersQueryCreated'Int Int
data GetTopupsParametersQueryStatus'
data GetTopupsResponse
data GetTopupsResponseBody200 = GetTopupsResponseBody200 {
}
mkGetTopupsResponseBody200 :: [Topup] -> Bool -> Text -> GetTopupsResponseBody200

Documentation

getTopups Source #

Arguments

:: forall m. 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>

data GetTopupsParameters Source #

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

Constructors

GetTopupsParameters

Fields

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

Instances

Instances details

Eq GetTopupsParameters Source #
Instance details Defined in StripeAPI.Operations.GetTopups Methods (==) :: GetTopupsParameters -> GetTopupsParameters -> Bool # (/=) :: GetTopupsParameters -> GetTopupsParameters -> Bool #
Show GetTopupsParameters Source #
Instance details Defined in StripeAPI.Operations.GetTopups Methods showsPrec :: Int -> GetTopupsParameters -> ShowS # show :: GetTopupsParameters -> String # showList :: [GetTopupsParameters] -> ShowS #
ToJSON GetTopupsParameters Source #
Instance details Defined in StripeAPI.Operations.GetTopups Methods toJSON :: GetTopupsParameters -> Value # toEncoding :: GetTopupsParameters -> Encoding # toJSONList :: [GetTopupsParameters] -> Value # toEncodingList :: [GetTopupsParameters] -> Encoding #
FromJSON GetTopupsParameters Source #
Instance details Defined in StripeAPI.Operations.GetTopups Methods 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.

Constructors

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

Instances

Instances details

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

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.

Constructors

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

Instances

Instances details

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

data GetTopupsParametersQueryCreated'OneOf1 Source #

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

Constructors

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

Instances

Instances details

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

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.

Constructors

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

Instances

Instances details

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

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

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"`

Instances

Instances details

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

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.

Constructors

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

Instances

Instances details

Eq GetTopupsResponse Source #
Instance details Defined in StripeAPI.Operations.GetTopups Methods (==) :: GetTopupsResponse -> GetTopupsResponse -> Bool # (/=) :: GetTopupsResponse -> GetTopupsResponse -> Bool #
Show GetTopupsResponse Source #
Instance details Defined in StripeAPI.Operations.GetTopups Methods 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.

Constructors

GetTopupsResponseBody200
Fields 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'

Instances

Instances details

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

mkGetTopupsResponseBody200 Source #

Arguments

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

Create a new GetTopupsResponseBody200 with all required fields.