| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostTransfersTransfer
Description
Contains the different functions to run the operation postTransfersTransfer
Synopsis
- postTransfersTransfer :: forall m. MonadHTTP m => Text -> Maybe PostTransfersTransferRequestBody -> ClientT m (Response PostTransfersTransferResponse)
- data PostTransfersTransferRequestBody = PostTransfersTransferRequestBody {}
- mkPostTransfersTransferRequestBody :: PostTransfersTransferRequestBody
- data PostTransfersTransferRequestBodyMetadata'Variants
- data PostTransfersTransferResponse
Documentation
postTransfersTransfer Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | transfer | Constraints: Maximum length of 5000 |
| -> Maybe PostTransfersTransferRequestBody | The request body to send |
| -> ClientT m (Response PostTransfersTransferResponse) | Monadic computation which returns the result of the operation |
POST /v1/transfers/{transfer}<p>Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
<p>This request accepts only metadata as an argument.</p>
data PostTransfersTransferRequestBody Source #
Defines the object schema located at paths./v1/transfers/{transfer}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostTransfersTransferRequestBody | |
Fields
| |
Instances
mkPostTransfersTransferRequestBody :: PostTransfersTransferRequestBody Source #
Create a new PostTransfersTransferRequestBody with all required fields.
data PostTransfersTransferRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/transfers/{transfer}.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
| PostTransfersTransferRequestBodyMetadata'EmptyString | Represents the JSON value |
| PostTransfersTransferRequestBodyMetadata'Object Object |
Instances
data PostTransfersTransferResponse Source #
Represents a response of the operation postTransfersTransfer.
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), PostTransfersTransferResponseError is used.
Constructors
| PostTransfersTransferResponseError String | Means either no matching case available or a parse error |
| PostTransfersTransferResponse200 Transfer | Successful response. |
| PostTransfersTransferResponseDefault Error | Error response. |