| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostOrdersIdReturns
Description
Contains the different functions to run the operation postOrdersIdReturns
Synopsis
- postOrdersIdReturns :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostOrdersIdReturnsRequestBody -> m (Either HttpException (Response PostOrdersIdReturnsResponse))
- postOrdersIdReturnsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostOrdersIdReturnsRequestBody -> m (Either HttpException (Response ByteString))
- postOrdersIdReturnsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostOrdersIdReturnsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostOrdersIdReturnsResponse))
- postOrdersIdReturnsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostOrdersIdReturnsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostOrdersIdReturnsRequestBody = PostOrdersIdReturnsRequestBody {}
- data PostOrdersIdReturnsRequestBodyItems'OneOf1
- data PostOrdersIdReturnsRequestBodyItems'OneOf2 = PostOrdersIdReturnsRequestBodyItems'OneOf2 {
- postOrdersIdReturnsRequestBodyItems'OneOf2Amount :: Maybe Integer
- postOrdersIdReturnsRequestBodyItems'OneOf2Description :: Maybe Text
- postOrdersIdReturnsRequestBodyItems'OneOf2Parent :: Maybe Text
- postOrdersIdReturnsRequestBodyItems'OneOf2Quantity :: Maybe Integer
- postOrdersIdReturnsRequestBodyItems'OneOf2Type :: Maybe PostOrdersIdReturnsRequestBodyItems'OneOf2Type'
- data PostOrdersIdReturnsRequestBodyItems'OneOf2Type'
- = PostOrdersIdReturnsRequestBodyItems'OneOf2Type'EnumOther Value
- | PostOrdersIdReturnsRequestBodyItems'OneOf2Type'EnumTyped Text
- | PostOrdersIdReturnsRequestBodyItems'OneOf2Type'EnumStringDiscount
- | PostOrdersIdReturnsRequestBodyItems'OneOf2Type'EnumStringShipping
- | PostOrdersIdReturnsRequestBodyItems'OneOf2Type'EnumStringSku
- | PostOrdersIdReturnsRequestBodyItems'OneOf2Type'EnumStringTax
- data PostOrdersIdReturnsRequestBodyItems'Variants
- data PostOrdersIdReturnsResponse
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Text | id | Constraints: Maximum length of 5000 |
| -> Maybe PostOrdersIdReturnsRequestBody | The request body to send |
| -> m (Either HttpException (Response PostOrdersIdReturnsResponse)) | Monad containing the result of the operation |
POST /v1/orders/{id}/returns<p>Return all or part of an order. The order must have a status of <code>paid</code> or <code>fulfilled</code> before it can be returned. Once all items have been returned, the order will become <code>canceled</code> or <code>returned</code> depending on which status the order started in.</p>
postOrdersIdReturnsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostOrdersIdReturnsRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/orders/{id}/returnsThe same as postOrdersIdReturns but returns the raw ByteString
postOrdersIdReturnsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostOrdersIdReturnsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostOrdersIdReturnsResponse)) Source #
POST /v1/orders/{id}/returnsMonadic version of postOrdersIdReturns (use with runWithConfiguration)
postOrdersIdReturnsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostOrdersIdReturnsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/orders/{id}/returnsMonadic version of postOrdersIdReturnsRaw (use with runWithConfiguration)
data PostOrdersIdReturnsRequestBody Source #
Defines the data type for the schema postOrdersIdReturnsRequestBody
Constructors
| PostOrdersIdReturnsRequestBody | |
Fields
| |
Instances
data PostOrdersIdReturnsRequestBodyItems'OneOf1 Source #
Defines the enum schema postOrdersIdReturnsRequestBodyItems'OneOf1
Constructors
| PostOrdersIdReturnsRequestBodyItems'OneOf1EnumOther Value | |
| PostOrdersIdReturnsRequestBodyItems'OneOf1EnumTyped Text | |
| PostOrdersIdReturnsRequestBodyItems'OneOf1EnumString_ |
data PostOrdersIdReturnsRequestBodyItems'OneOf2 Source #
Defines the data type for the schema postOrdersIdReturnsRequestBodyItems'OneOf2
Constructors
| PostOrdersIdReturnsRequestBodyItems'OneOf2 | |
Fields
| |
data PostOrdersIdReturnsRequestBodyItems'OneOf2Type' Source #
Defines the enum schema postOrdersIdReturnsRequestBodyItems'OneOf2Type'
Constructors
Instances
data PostOrdersIdReturnsRequestBodyItems'Variants Source #
Define the one-of schema postOrdersIdReturnsRequestBodyItems'
List of items to return.
Constructors
Instances
data PostOrdersIdReturnsResponse Source #
Represents a response of the operation postOrdersIdReturns.
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), PostOrdersIdReturnsResponseError is used.
Constructors
| PostOrdersIdReturnsResponseError String | Means either no matching case available or a parse error |
| PostOrdersIdReturnsResponse200 OrderReturn | Successful response. |
| PostOrdersIdReturnsResponseDefault Error | Error response. |
Instances
| Eq PostOrdersIdReturnsResponse Source # | |
Defined in StripeAPI.Operations.PostOrdersIdReturns Methods (==) :: PostOrdersIdReturnsResponse -> PostOrdersIdReturnsResponse -> Bool # (/=) :: PostOrdersIdReturnsResponse -> PostOrdersIdReturnsResponse -> Bool # | |
| Show PostOrdersIdReturnsResponse Source # | |
Defined in StripeAPI.Operations.PostOrdersIdReturns Methods showsPrec :: Int -> PostOrdersIdReturnsResponse -> ShowS # show :: PostOrdersIdReturnsResponse -> String # showList :: [PostOrdersIdReturnsResponse] -> ShowS # | |