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 -> Text -> Maybe PostTransfersTransferRequestBody -> m (Either HttpException (Response PostTransfersTransferResponse))
postTransfersTransferRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostTransfersTransferRequestBody -> m (Either HttpException (Response ByteString))
postTransfersTransferM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostTransfersTransferRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTransfersTransferResponse))
postTransfersTransferRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe 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
-> Text	transfer \| Constraints: Maximum length of 5000
-> Maybe 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 -> Text -> Maybe 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) => Text -> Maybe 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) => Text -> Maybe 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

postTransfersTransferRequestBodyDescription :: Maybe Text
description: An arbitrary string attached to the object. Often useful for displaying to users.
Constraints:
- Maximum length of 5000
postTransfersTransferRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postTransfersTransferRequestBodyMetadata :: Maybe PostTransfersTransferRequestBodyMetadata'
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 PostTransfersTransferRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTransfersTransfer Methods (==) :: PostTransfersTransferRequestBody -> PostTransfersTransferRequestBody -> Bool # (/=) :: PostTransfersTransferRequestBody -> PostTransfersTransferRequestBody -> Bool #
Show PostTransfersTransferRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTransfersTransfer Methods showsPrec :: Int -> PostTransfersTransferRequestBody -> ShowS # show :: PostTransfersTransferRequestBody -> String # showList :: [PostTransfersTransferRequestBody] -> ShowS #
ToJSON PostTransfersTransferRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTransfersTransfer Methods toJSON :: PostTransfersTransferRequestBody -> Value # toEncoding :: PostTransfersTransferRequestBody -> Encoding # toJSONList :: [PostTransfersTransferRequestBody] -> Value # toEncodingList :: [PostTransfersTransferRequestBody] -> Encoding #
FromJSON PostTransfersTransferRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTransfersTransfer Methods parseJSON :: Value -> Parser PostTransfersTransferRequestBody # parseJSONList :: Value -> Parser [PostTransfersTransferRequestBody] #

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

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

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.

Instances

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