Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostTopupsTopup

Description

Contains the different functions to run the operation postTopupsTopup

Synopsis

postTopupsTopup :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostTopupsTopupRequestBody -> m (Either HttpException (Response PostTopupsTopupResponse))
postTopupsTopupRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostTopupsTopupRequestBody -> m (Either HttpException (Response ByteString))
postTopupsTopupM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostTopupsTopupRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTopupsTopupResponse))
postTopupsTopupRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostTopupsTopupRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostTopupsTopupRequestBody = PostTopupsTopupRequestBody {
}
data PostTopupsTopupRequestBodyMetadata' = PostTopupsTopupRequestBodyMetadata' {
}
data PostTopupsTopupResponse

Documentation

postTopupsTopup Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	topup \| Constraints: Maximum length of 5000
-> Maybe PostTopupsTopupRequestBody	The request body to send
-> m (Either HttpException (Response PostTopupsTopupResponse))	Monad containing the result of the operation

POST /v1/topups/{topup}

<p>Updates the metadata of a top-up. Other top-up details are not editable by design.</p>

postTopupsTopupRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostTopupsTopupRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/topups/{topup}

The same as postTopupsTopup but returns the raw ByteString

postTopupsTopupM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostTopupsTopupRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTopupsTopupResponse)) Source #

POST /v1/topups/{topup}

Monadic version of postTopupsTopup (use with runWithConfiguration)

postTopupsTopupRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostTopupsTopupRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/topups/{topup}

Monadic version of postTopupsTopupRaw (use with runWithConfiguration)

data PostTopupsTopupRequestBody Source #

Defines the data type for the schema postTopupsTopupRequestBody

Constructors

PostTopupsTopupRequestBody

Fields

postTopupsTopupRequestBodyDescription :: Maybe Text
description: An arbitrary string attached to the object. Often useful for displaying to users.
Constraints:
- Maximum length of 5000
postTopupsTopupRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postTopupsTopupRequestBodyMetadata :: Maybe PostTopupsTopupRequestBodyMetadata'
metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Instances

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

data PostTopupsTopupRequestBodyMetadata' Source #

Defines the data type for the schema postTopupsTopupRequestBodyMetadata'

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Constructors

PostTopupsTopupRequestBodyMetadata'

Instances

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

data PostTopupsTopupResponse Source #

Represents a response of the operation postTopupsTopup.

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

Constructors

PostTopupsTopupResponseError String	Means either no matching case available or a parse error
PostTopupsTopupResponse200 Topup	Successful response.
PostTopupsTopupResponseDefault Error	Error response.

Instances

Eq PostTopupsTopupResponse Source #
Instance details Defined in StripeAPI.Operations.PostTopupsTopup Methods (==) :: PostTopupsTopupResponse -> PostTopupsTopupResponse -> Bool # (/=) :: PostTopupsTopupResponse -> PostTopupsTopupResponse -> Bool #
Show PostTopupsTopupResponse Source #
Instance details Defined in StripeAPI.Operations.PostTopupsTopup Methods showsPrec :: Int -> PostTopupsTopupResponse -> ShowS # show :: PostTopupsTopupResponse -> String # showList :: [PostTopupsTopupResponse] -> ShowS #