StripeAPI.Operations.PostTopupsTopup

Contains the different functions to run the operation postTopupsTopup

Documentation

postTopupsTopup

Arguments

:: forall m. MonadHTTP m

=> Text

topup | Constraints: Maximum length of 5000

-> Maybe PostTopupsTopupRequestBody

The request body to send

-> ClientT m (Response PostTopupsTopupResponse)

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

data PostTopupsTopupRequestBody

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

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

Defined in StripeAPI.Operations.PostTopupsTopup

Methods

(==) :: PostTopupsTopupRequestBody -> PostTopupsTopupRequestBody -> Bool

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

Show PostTopupsTopupRequestBody

Defined in StripeAPI.Operations.PostTopupsTopup

Methods

showsPrec :: Int -> PostTopupsTopupRequestBody -> ShowS

show :: PostTopupsTopupRequestBody -> String

showList :: [PostTopupsTopupRequestBody] -> ShowS

ToJSON PostTopupsTopupRequestBody

Defined in StripeAPI.Operations.PostTopupsTopup

Methods

toJSON :: PostTopupsTopupRequestBody -> Value

toEncoding :: PostTopupsTopupRequestBody -> Encoding

toJSONList :: [PostTopupsTopupRequestBody] -> Value

toEncodingList :: [PostTopupsTopupRequestBody] -> Encoding

FromJSON PostTopupsTopupRequestBody

Defined in StripeAPI.Operations.PostTopupsTopup

Methods

parseJSON :: Value -> Parser PostTopupsTopupRequestBody

parseJSONList :: Value -> Parser [PostTopupsTopupRequestBody]

mkPostTopupsTopupRequestBody :: PostTopupsTopupRequestBody

Create a new PostTopupsTopupRequestBody with all required fields.

data PostTopupsTopupRequestBodyMetadata'Variants

Defines the oneOf schema located at paths./v1/topups/{topup}.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

PostTopupsTopupRequestBodyMetadata'EmptyString

Represents the JSON value ""

PostTopupsTopupRequestBodyMetadata'Object Object

Instances

Eq PostTopupsTopupRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTopupsTopup

Methods

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

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

Show PostTopupsTopupRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTopupsTopup

Methods

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

show :: PostTopupsTopupRequestBodyMetadata'Variants -> String

showList :: [PostTopupsTopupRequestBodyMetadata'Variants] -> ShowS

ToJSON PostTopupsTopupRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTopupsTopup

Methods

toJSON :: PostTopupsTopupRequestBodyMetadata'Variants -> Value

toEncoding :: PostTopupsTopupRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostTopupsTopupRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostTopupsTopupRequestBodyMetadata'Variants] -> Encoding

FromJSON PostTopupsTopupRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTopupsTopup

Methods

parseJSON :: Value -> Parser PostTopupsTopupRequestBodyMetadata'Variants

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

data PostTopupsTopupResponse

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

Defined in StripeAPI.Operations.PostTopupsTopup

Methods

(==) :: PostTopupsTopupResponse -> PostTopupsTopupResponse -> Bool

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

Show PostTopupsTopupResponse

Defined in StripeAPI.Operations.PostTopupsTopup

Methods

showsPrec :: Int -> PostTopupsTopupResponse -> ShowS

show :: PostTopupsTopupResponse -> String

showList :: [PostTopupsTopupResponse] -> ShowS