Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostRefundsRefund

Description

Contains the different functions to run the operation postRefundsRefund

Synopsis

postRefundsRefund :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostRefundsRefundRequestBody -> m (Either HttpException (Response PostRefundsRefundResponse))
postRefundsRefundRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostRefundsRefundRequestBody -> m (Either HttpException (Response ByteString))
postRefundsRefundM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostRefundsRefundRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostRefundsRefundResponse))
postRefundsRefundRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostRefundsRefundRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostRefundsRefundRequestBody = PostRefundsRefundRequestBody {
- postRefundsRefundRequestBodyExpand :: Maybe ([] Text)
- postRefundsRefundRequestBodyMetadata :: Maybe PostRefundsRefundRequestBodyMetadata'
}
data PostRefundsRefundRequestBodyMetadata' = PostRefundsRefundRequestBodyMetadata' {
}
data PostRefundsRefundResponse

Documentation

postRefundsRefund Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	refund
-> Maybe PostRefundsRefundRequestBody	The request body to send
-> m (Either HttpException (Response PostRefundsRefundResponse))	Monad containing the result of the operation

POST /v1/refunds/{refund}

<p>Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

<p>This request only accepts <code>metadata</code> as an argument.</p>

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

POST /v1/refunds/{refund}

The same as postRefundsRefund but returns the raw ByteString

postRefundsRefundM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostRefundsRefundRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostRefundsRefundResponse)) Source #

POST /v1/refunds/{refund}

Monadic version of postRefundsRefund (use with runWithConfiguration)

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

POST /v1/refunds/{refund}

Monadic version of postRefundsRefundRaw (use with runWithConfiguration)

data PostRefundsRefundRequestBody Source #

Defines the data type for the schema postRefundsRefundRequestBody

Constructors

PostRefundsRefundRequestBody

Fields

postRefundsRefundRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postRefundsRefundRequestBodyMetadata :: Maybe PostRefundsRefundRequestBodyMetadata'
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 PostRefundsRefundRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostRefundsRefund Methods (==) :: PostRefundsRefundRequestBody -> PostRefundsRefundRequestBody -> Bool # (/=) :: PostRefundsRefundRequestBody -> PostRefundsRefundRequestBody -> Bool #
Show PostRefundsRefundRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostRefundsRefund Methods showsPrec :: Int -> PostRefundsRefundRequestBody -> ShowS # show :: PostRefundsRefundRequestBody -> String # showList :: [PostRefundsRefundRequestBody] -> ShowS #
ToJSON PostRefundsRefundRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostRefundsRefund Methods toJSON :: PostRefundsRefundRequestBody -> Value # toEncoding :: PostRefundsRefundRequestBody -> Encoding # toJSONList :: [PostRefundsRefundRequestBody] -> Value # toEncodingList :: [PostRefundsRefundRequestBody] -> Encoding #
FromJSON PostRefundsRefundRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostRefundsRefund Methods parseJSON :: Value -> Parser PostRefundsRefundRequestBody # parseJSONList :: Value -> Parser [PostRefundsRefundRequestBody] #

data PostRefundsRefundRequestBodyMetadata' Source #

Defines the data type for the schema postRefundsRefundRequestBodyMetadata'

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

PostRefundsRefundRequestBodyMetadata'

Instances

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

data PostRefundsRefundResponse Source #

Represents a response of the operation postRefundsRefund.

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

Constructors

PostRefundsRefundResponseError String	Means either no matching case available or a parse error
PostRefundsRefundResponse200 Refund	Successful response.
PostRefundsRefundResponseDefault Error	Error response.

Instances

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