stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostOrdersIdReturns

Description

Contains the different functions to run the operation postOrdersIdReturns

Synopsis

Documentation

postOrdersIdReturns Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> String

id | Constraints: Maximum length of 5000

-> 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 -> String -> PostOrdersIdReturnsRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/orders/{id}/returns

The same as postOrdersIdReturns but returns the raw ByteString

data PostOrdersIdReturnsRequestBody Source #

Defines the data type for the schema postOrdersIdReturnsRequestBody

Constructors

PostOrdersIdReturnsRequestBody 

Fields

data PostOrdersIdReturnsRequestBodyItems'OneOf1 Source #

Defines the enum schema postOrdersIdReturnsRequestBodyItems'OneOf1

data PostOrdersIdReturnsRequestBodyItems'OneOf2 Source #

Defines the data type for the schema postOrdersIdReturnsRequestBodyItems'OneOf2

data PostOrdersIdReturnsRequestBodyItems'OneOf2Type' Source #

Defines the enum schema postOrdersIdReturnsRequestBodyItems'OneOf2Type'

data PostOrdersIdReturnsRequestBodyItems'Variants Source #

Define the one-of schema postOrdersIdReturnsRequestBodyItems'

List of items to return.

Instances
Eq PostOrdersIdReturnsRequestBodyItems'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostOrdersIdReturns

Show PostOrdersIdReturnsRequestBodyItems'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostOrdersIdReturns

Generic PostOrdersIdReturnsRequestBodyItems'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostOrdersIdReturns

ToJSON PostOrdersIdReturnsRequestBodyItems'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostOrdersIdReturns

FromJSON PostOrdersIdReturnsRequestBodyItems'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostOrdersIdReturns

type Rep PostOrdersIdReturnsRequestBodyItems'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostOrdersIdReturns

type Rep PostOrdersIdReturnsRequestBodyItems'Variants = D1 (MetaData "PostOrdersIdReturnsRequestBodyItems'Variants" "StripeAPI.Operations.PostOrdersIdReturns" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostOrdersIdReturnsRequestBodyItems'PostOrdersIdReturnsRequestBodyItems'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostOrdersIdReturnsRequestBodyItems'OneOf1)) :+: C1 (MetaCons "PostOrdersIdReturnsRequestBodyItems'ListPostOrdersIdReturnsRequestBodyItems'OneOf2" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [PostOrdersIdReturnsRequestBodyItems'OneOf2])))

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.