stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostOrdersId

Description

Contains the different functions to run the operation postOrdersId

Synopsis

Documentation

postOrdersId Source #

Arguments

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

The configuration to use in the request

-> String

id | Constraints: Maximum length of 5000

-> PostOrdersIdRequestBody

The request body to send

-> m (Either HttpException (Response PostOrdersIdResponse))

Monad containing the result of the operation

POST /v1/orders/{id}

<p>Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

postOrdersIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostOrdersIdRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/orders/{id}

The same as postOrdersId but returns the raw ByteString

data PostOrdersIdRequestBody Source #

Defines the data type for the schema postOrdersIdRequestBody

Constructors

PostOrdersIdRequestBody 

Fields

data PostOrdersIdRequestBodyMetadata' Source #

Defines the data type for the schema postOrdersIdRequestBodyMetadata'

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`.

data PostOrdersIdRequestBodyShipping' Source #

Defines the data type for the schema postOrdersIdRequestBodyShipping'

Tracking information once the order has been fulfilled.

Constructors

PostOrdersIdRequestBodyShipping' 

Fields

data PostOrdersIdRequestBodyStatus' Source #

Defines the enum schema postOrdersIdRequestBodyStatus'

Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More detail in the Orders Guide.

data PostOrdersIdResponse Source #

Represents a response of the operation postOrdersId.

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), PostOrdersIdResponseError is used.

Constructors

PostOrdersIdResponseError String

Means either no matching case available or a parse error

PostOrdersIdResponse200 Order

Successful response.

PostOrdersIdResponseDefault Error

Error response.