Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostTopupsTopupCancel

Description

Contains the different functions to run the operation postTopupsTopupCancel

Synopsis

postTopupsTopupCancel :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostTopupsTopupCancelRequestBody -> m (Either HttpException (Response PostTopupsTopupCancelResponse))
postTopupsTopupCancelRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostTopupsTopupCancelRequestBody -> m (Either HttpException (Response ByteString))
postTopupsTopupCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostTopupsTopupCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTopupsTopupCancelResponse))
postTopupsTopupCancelRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostTopupsTopupCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostTopupsTopupCancelRequestBody = PostTopupsTopupCancelRequestBody {
- postTopupsTopupCancelRequestBodyExpand :: Maybe ([] String)
}
data PostTopupsTopupCancelResponse

Documentation

postTopupsTopupCancel Source #

Arguments

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

POST /v1/topups/{topup}/cancel

<p>Cancels a top-up. Only pending top-ups can be canceled.</p>

postTopupsTopupCancelRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostTopupsTopupCancelRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/topups/{topup}/cancel

The same as postTopupsTopupCancel but returns the raw ByteString

postTopupsTopupCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostTopupsTopupCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTopupsTopupCancelResponse)) Source #

POST /v1/topups/{topup}/cancel

Monadic version of postTopupsTopupCancel (use with runWithConfiguration)

postTopupsTopupCancelRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostTopupsTopupCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/topups/{topup}/cancel

Monadic version of postTopupsTopupCancelRaw (use with runWithConfiguration)

data PostTopupsTopupCancelRequestBody Source #

Defines the data type for the schema postTopupsTopupCancelRequestBody

Constructors

PostTopupsTopupCancelRequestBody
Fields postTopupsTopupCancelRequestBodyExpand :: Maybe ([] String) expand: Specifies which fields in the response should be expanded.

Instances

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

data PostTopupsTopupCancelResponse Source #

Represents a response of the operation postTopupsTopupCancel.

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

Constructors

PostTopupsTopupCancelResponseError String	Means either no matching case available or a parse error
PostTopupsTopupCancelResponse200 Topup	Successful response.
PostTopupsTopupCancelResponseDefault Error	Error response.

Instances

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