Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostOrdersIdReturns

Description

Contains the different functions to run the operation postOrdersIdReturns

Synopsis

postOrdersIdReturns :: forall m. MonadHTTP m => Text -> Maybe PostOrdersIdReturnsRequestBody -> ClientT m (Response PostOrdersIdReturnsResponse)
data PostOrdersIdReturnsRequestBody = PostOrdersIdReturnsRequestBody {
- postOrdersIdReturnsRequestBodyExpand :: Maybe [Text]
- postOrdersIdReturnsRequestBodyItems :: Maybe PostOrdersIdReturnsRequestBodyItems'Variants
}
mkPostOrdersIdReturnsRequestBody :: PostOrdersIdReturnsRequestBody
data PostOrdersIdReturnsRequestBodyItems'OneOf1 = PostOrdersIdReturnsRequestBodyItems'OneOf1 {
}
mkPostOrdersIdReturnsRequestBodyItems'OneOf1 :: PostOrdersIdReturnsRequestBodyItems'OneOf1
data PostOrdersIdReturnsRequestBodyItems'OneOf1Type'
data PostOrdersIdReturnsRequestBodyItems'Variants
- = PostOrdersIdReturnsRequestBodyItems'EmptyString
- | PostOrdersIdReturnsRequestBodyItems'ListTPostOrdersIdReturnsRequestBodyItems'OneOf1 [PostOrdersIdReturnsRequestBodyItems'OneOf1]
data PostOrdersIdReturnsResponse

Documentation

postOrdersIdReturns Source #

Arguments

:: forall m. MonadHTTP m
=> Text	id \| Constraints: Maximum length of 5000
-> Maybe PostOrdersIdReturnsRequestBody	The request body to send
-> ClientT m (Response PostOrdersIdReturnsResponse)	Monadic computation which returns 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>

data PostOrdersIdReturnsRequestBody Source #

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

Constructors

PostOrdersIdReturnsRequestBody
Fields postOrdersIdReturnsRequestBodyExpand :: Maybe [Text] expand: Specifies which fields in the response should be expanded. postOrdersIdReturnsRequestBodyItems :: Maybe PostOrdersIdReturnsRequestBodyItems'Variants items: List of items to return.

Instances

Instances details

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

mkPostOrdersIdReturnsRequestBody :: PostOrdersIdReturnsRequestBody Source #

Create a new PostOrdersIdReturnsRequestBody with all required fields.

data PostOrdersIdReturnsRequestBodyItems'OneOf1 Source #

Defines the object schema located at paths./v1/orders/{id}/returns.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.anyOf.items in the specification.

Constructors

PostOrdersIdReturnsRequestBodyItems'OneOf1

Fields

postOrdersIdReturnsRequestBodyItems'OneOf1Amount :: Maybe Int
amount
postOrdersIdReturnsRequestBodyItems'OneOf1Description :: Maybe Text
description
Constraints:
- Maximum length of 1000
postOrdersIdReturnsRequestBodyItems'OneOf1Parent :: Maybe Text
parent
Constraints:
- Maximum length of 5000
postOrdersIdReturnsRequestBodyItems'OneOf1Quantity :: Maybe Int
quantity
postOrdersIdReturnsRequestBodyItems'OneOf1Type :: Maybe PostOrdersIdReturnsRequestBodyItems'OneOf1Type'
type
Constraints:
- Maximum length of 5000

Instances

Instances details

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

mkPostOrdersIdReturnsRequestBodyItems'OneOf1 :: PostOrdersIdReturnsRequestBodyItems'OneOf1 Source #

Create a new PostOrdersIdReturnsRequestBodyItems'OneOf1 with all required fields.

data PostOrdersIdReturnsRequestBodyItems'OneOf1Type' Source #

Defines the enum schema located at paths./v1/orders/{id}/returns.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.anyOf.items.properties.type in the specification.

Constructors

PostOrdersIdReturnsRequestBodyItems'OneOf1Type'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostOrdersIdReturnsRequestBodyItems'OneOf1Type'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostOrdersIdReturnsRequestBodyItems'OneOf1Type'EnumDiscount	Represents the JSON value `"discount"`
PostOrdersIdReturnsRequestBodyItems'OneOf1Type'EnumShipping	Represents the JSON value `"shipping"`
PostOrdersIdReturnsRequestBodyItems'OneOf1Type'EnumSku	Represents the JSON value `"sku"`
PostOrdersIdReturnsRequestBodyItems'OneOf1Type'EnumTax	Represents the JSON value `"tax"`

Instances

Instances details

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

data PostOrdersIdReturnsRequestBodyItems'Variants Source #

Defines the oneOf schema located at paths./v1/orders/{id}/returns.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.anyOf in the specification.

List of items to return.

Constructors

PostOrdersIdReturnsRequestBodyItems'EmptyString	Represents the JSON value `""`
PostOrdersIdReturnsRequestBodyItems'ListTPostOrdersIdReturnsRequestBodyItems'OneOf1 [PostOrdersIdReturnsRequestBodyItems'OneOf1]

Instances

Instances details

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

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

Instances details

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