| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostTransfersTransfer
Description
Contains the different functions to run the operation postTransfersTransfer
Synopsis
- postTransfersTransfer :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostTransfersTransferRequestBody -> m (Either HttpException (Response PostTransfersTransferResponse))
- postTransfersTransferRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostTransfersTransferRequestBody -> m (Either HttpException (Response ByteString))
- postTransfersTransferM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostTransfersTransferRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTransfersTransferResponse))
- postTransfersTransferRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostTransfersTransferRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostTransfersTransferRequestBody = PostTransfersTransferRequestBody {}
- data PostTransfersTransferRequestBodyMetadata' = PostTransfersTransferRequestBodyMetadata' {
- data PostTransfersTransferResponse
Documentation
postTransfersTransfer Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> String | transfer | Constraints: Maximum length of 5000 |
| -> PostTransfersTransferRequestBody | The request body to send |
| -> m (Either HttpException (Response PostTransfersTransferResponse)) | Monad containing 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>
postTransfersTransferRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostTransfersTransferRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/transfers/{transfer}The same as postTransfersTransfer but returns the raw ByteString
postTransfersTransferM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostTransfersTransferRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTransfersTransferResponse)) Source #
POST /v1/transfers/{transfer}Monadic version of postTransfersTransfer (use with runWithConfiguration)
postTransfersTransferRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostTransfersTransferRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/transfers/{transfer}Monadic version of postTransfersTransferRaw (use with runWithConfiguration)
data PostTransfersTransferRequestBody Source #
Defines the data type for the schema postTransfersTransferRequestBody
Constructors
| PostTransfersTransferRequestBody | |
Fields
| |
Instances
data PostTransfersTransferRequestBodyMetadata' Source #
Defines the data type for the schema postTransfersTransferRequestBodyMetadata'
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' | |
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. |