StripeAPI.Operations.PostRefundsRefund

Contains the different functions to run the operation postRefundsRefund

Documentation

postRefundsRefund

Arguments

:: forall m. MonadHTTP m

=> Text

refund

-> Maybe PostRefundsRefundRequestBody

The request body to send

-> StripeT m (Response PostRefundsRefundResponse)

Monadic computation which returns 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>

data PostRefundsRefundRequestBody

Defines the object schema located at paths./v1/refunds/{refund}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostRefundsRefundRequestBody

Fields

• postRefundsRefundRequestBodyExpand :: Maybe [Text]

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

• postRefundsRefundRequestBodyMetadata :: Maybe PostRefundsRefundRequestBodyMetadata'Variants

  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

Defined in StripeAPI.Operations.PostRefundsRefund

Methods

(==) :: PostRefundsRefundRequestBody -> PostRefundsRefundRequestBody -> Bool

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

Show PostRefundsRefundRequestBody

Defined in StripeAPI.Operations.PostRefundsRefund

Methods

showsPrec :: Int -> PostRefundsRefundRequestBody -> ShowS

show :: PostRefundsRefundRequestBody -> String

showList :: [PostRefundsRefundRequestBody] -> ShowS

ToJSON PostRefundsRefundRequestBody

Defined in StripeAPI.Operations.PostRefundsRefund

Methods

toJSON :: PostRefundsRefundRequestBody -> Value

toEncoding :: PostRefundsRefundRequestBody -> Encoding

toJSONList :: [PostRefundsRefundRequestBody] -> Value

toEncodingList :: [PostRefundsRefundRequestBody] -> Encoding

FromJSON PostRefundsRefundRequestBody

Defined in StripeAPI.Operations.PostRefundsRefund

Methods

parseJSON :: Value -> Parser PostRefundsRefundRequestBody

parseJSONList :: Value -> Parser [PostRefundsRefundRequestBody]

mkPostRefundsRefundRequestBody :: PostRefundsRefundRequestBody

Create a new PostRefundsRefundRequestBody with all required fields.

data PostRefundsRefundRequestBodyMetadata'Variants

Defines the oneOf schema located at paths./v1/refunds/{refund}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

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'EmptyString

Represents the JSON value ""

PostRefundsRefundRequestBodyMetadata'Object Object

Instances

Eq PostRefundsRefundRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRefundsRefund

Methods

(==) :: PostRefundsRefundRequestBodyMetadata'Variants -> PostRefundsRefundRequestBodyMetadata'Variants -> Bool

(/=) :: PostRefundsRefundRequestBodyMetadata'Variants -> PostRefundsRefundRequestBodyMetadata'Variants -> Bool

Show PostRefundsRefundRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRefundsRefund

Methods

showsPrec :: Int -> PostRefundsRefundRequestBodyMetadata'Variants -> ShowS

show :: PostRefundsRefundRequestBodyMetadata'Variants -> String

showList :: [PostRefundsRefundRequestBodyMetadata'Variants] -> ShowS

ToJSON PostRefundsRefundRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRefundsRefund

Methods

toJSON :: PostRefundsRefundRequestBodyMetadata'Variants -> Value

toEncoding :: PostRefundsRefundRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostRefundsRefundRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostRefundsRefundRequestBodyMetadata'Variants] -> Encoding

FromJSON PostRefundsRefundRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRefundsRefund

Methods

parseJSON :: Value -> Parser PostRefundsRefundRequestBodyMetadata'Variants

parseJSONList :: Value -> Parser [PostRefundsRefundRequestBodyMetadata'Variants]

data PostRefundsRefundResponse

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

Defined in StripeAPI.Operations.PostRefundsRefund

Methods

(==) :: PostRefundsRefundResponse -> PostRefundsRefundResponse -> Bool

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

Show PostRefundsRefundResponse

Defined in StripeAPI.Operations.PostRefundsRefund

Methods

showsPrec :: Int -> PostRefundsRefundResponse -> ShowS

show :: PostRefundsRefundResponse -> String

showList :: [PostRefundsRefundResponse] -> ShowS