StripeAPI.Operations.GetTopups

Contains the different functions to run the operation getTopups

Documentation

getTopups

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

amount: A positive integer representing how much to transfer.

-> Maybe Text

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.

-> Maybe Text

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

-> Maybe Text

expand: Specifies which fields in the response should be expanded.

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe Text

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

-> Maybe Text

status: Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. | Constraints: Maximum length of 5000

-> Maybe GetTopupsRequestBody

The request body to send

-> m (Either HttpException (Response GetTopupsResponse))

Monad containing the result of the operation

GET /v1/topups

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

getTopupsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetTopupsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/topups

The same as getTopups but returns the raw ByteString

getTopupsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetTopupsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetTopupsResponse))

GET /v1/topups

Monadic version of getTopups (use with runWithConfiguration)

getTopupsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetTopupsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/topups

Monadic version of getTopupsRaw (use with runWithConfiguration)

data GetTopupsRequestBody

Defines the data type for the schema getTopupsRequestBody

Constructors

GetTopupsRequestBody

Instances

Eq GetTopupsRequestBody

Defined in StripeAPI.Operations.GetTopups

Methods

(==) :: GetTopupsRequestBody -> GetTopupsRequestBody -> Bool

(/=) :: GetTopupsRequestBody -> GetTopupsRequestBody -> Bool

Show GetTopupsRequestBody

Defined in StripeAPI.Operations.GetTopups

Methods

showsPrec :: Int -> GetTopupsRequestBody -> ShowS

show :: GetTopupsRequestBody -> String

showList :: [GetTopupsRequestBody] -> ShowS

ToJSON GetTopupsRequestBody

Defined in StripeAPI.Operations.GetTopups

Methods

toJSON :: GetTopupsRequestBody -> Value

toEncoding :: GetTopupsRequestBody -> Encoding

toJSONList :: [GetTopupsRequestBody] -> Value

toEncodingList :: [GetTopupsRequestBody] -> Encoding

FromJSON GetTopupsRequestBody

Defined in StripeAPI.Operations.GetTopups

Methods

parseJSON :: Value -> Parser GetTopupsRequestBody

parseJSONList :: Value -> Parser [GetTopupsRequestBody]

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

Instances

Eq GetTopupsResponse

Defined in StripeAPI.Operations.GetTopups

Methods

(==) :: GetTopupsResponse -> GetTopupsResponse -> Bool

(/=) :: GetTopupsResponse -> GetTopupsResponse -> Bool

Show GetTopupsResponse

Defined in StripeAPI.Operations.GetTopups

Methods

showsPrec :: Int -> GetTopupsResponse -> ShowS

show :: GetTopupsResponse -> String

showList :: [GetTopupsResponse] -> ShowS

data GetTopupsResponseBody200

Defines the data type for the schema GetTopupsResponseBody200

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.

• getTopupsResponseBody200Object :: GetTopupsResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getTopupsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/topups'

Instances

Eq GetTopupsResponseBody200

Defined in StripeAPI.Operations.GetTopups

Methods

(==) :: GetTopupsResponseBody200 -> GetTopupsResponseBody200 -> Bool

(/=) :: GetTopupsResponseBody200 -> GetTopupsResponseBody200 -> Bool

Show GetTopupsResponseBody200

Defined in StripeAPI.Operations.GetTopups

Methods

showsPrec :: Int -> GetTopupsResponseBody200 -> ShowS

show :: GetTopupsResponseBody200 -> String

showList :: [GetTopupsResponseBody200] -> ShowS

ToJSON GetTopupsResponseBody200

Defined in StripeAPI.Operations.GetTopups

Methods

toJSON :: GetTopupsResponseBody200 -> Value

toEncoding :: GetTopupsResponseBody200 -> Encoding

toJSONList :: [GetTopupsResponseBody200] -> Value

toEncodingList :: [GetTopupsResponseBody200] -> Encoding

FromJSON GetTopupsResponseBody200

Defined in StripeAPI.Operations.GetTopups

Methods

parseJSON :: Value -> Parser GetTopupsResponseBody200

parseJSONList :: Value -> Parser [GetTopupsResponseBody200]

data GetTopupsResponseBody200Object'

Defines the enum schema GetTopupsResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetTopupsResponseBody200Object'EnumOther Value

GetTopupsResponseBody200Object'EnumTyped Text

GetTopupsResponseBody200Object'EnumStringList

Instances

Eq GetTopupsResponseBody200Object'

Defined in StripeAPI.Operations.GetTopups

Methods

(==) :: GetTopupsResponseBody200Object' -> GetTopupsResponseBody200Object' -> Bool

(/=) :: GetTopupsResponseBody200Object' -> GetTopupsResponseBody200Object' -> Bool

Show GetTopupsResponseBody200Object'

Defined in StripeAPI.Operations.GetTopups

Methods

showsPrec :: Int -> GetTopupsResponseBody200Object' -> ShowS

show :: GetTopupsResponseBody200Object' -> String

showList :: [GetTopupsResponseBody200Object'] -> ShowS

ToJSON GetTopupsResponseBody200Object'

Defined in StripeAPI.Operations.GetTopups

Methods

toJSON :: GetTopupsResponseBody200Object' -> Value

toEncoding :: GetTopupsResponseBody200Object' -> Encoding

toJSONList :: [GetTopupsResponseBody200Object'] -> Value

toEncodingList :: [GetTopupsResponseBody200Object'] -> Encoding

FromJSON GetTopupsResponseBody200Object'

Defined in StripeAPI.Operations.GetTopups

Methods

parseJSON :: Value -> Parser GetTopupsResponseBody200Object'

parseJSONList :: Value -> Parser [GetTopupsResponseBody200Object']