Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostOrdersId

Description

Contains the different functions to run the operation postOrdersId

Synopsis

postOrdersId :: forall m. MonadHTTP m => Text -> Maybe PostOrdersIdRequestBody -> ClientT m (Response PostOrdersIdResponse)
data PostOrdersIdRequestBody = PostOrdersIdRequestBody {
}
mkPostOrdersIdRequestBody :: PostOrdersIdRequestBody
data PostOrdersIdRequestBodyMetadata'Variants
- = PostOrdersIdRequestBodyMetadata'EmptyString
- | PostOrdersIdRequestBodyMetadata'Object Object
data PostOrdersIdRequestBodyShipping' = PostOrdersIdRequestBodyShipping' {
- postOrdersIdRequestBodyShipping'Carrier :: Text
- postOrdersIdRequestBodyShipping'TrackingNumber :: Text
}
mkPostOrdersIdRequestBodyShipping' :: Text -> Text -> PostOrdersIdRequestBodyShipping'
data PostOrdersIdRequestBodyStatus'
data PostOrdersIdResponse

Documentation

postOrdersId Source #

Arguments

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

data PostOrdersIdRequestBody Source #

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

Constructors

PostOrdersIdRequestBody

Fields

postOrdersIdRequestBodyCoupon :: Maybe Text
coupon: A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons.
Constraints:
- Maximum length of 5000
postOrdersIdRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postOrdersIdRequestBodyMetadata :: Maybe PostOrdersIdRequestBodyMetadata'Variants
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`.
postOrdersIdRequestBodySelectedShippingMethod :: Maybe Text
selected_shipping_method: The shipping method to select for fulfilling this order. If specified, must be one of the `id`s of a shipping method in the `shipping_methods` array. If specified, will overwrite the existing selected shipping method, updating `items` as necessary.
Constraints:
- Maximum length of 5000
postOrdersIdRequestBodyShipping :: Maybe PostOrdersIdRequestBodyShipping'
shipping: Tracking information once the order has been fulfilled.
postOrdersIdRequestBodyStatus :: Maybe PostOrdersIdRequestBodyStatus'
status: Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More detail in the Orders Guide.
Constraints:
- Maximum length of 5000

Instances

Instances details

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

mkPostOrdersIdRequestBody :: PostOrdersIdRequestBody Source #

Create a new PostOrdersIdRequestBody with all required fields.

data PostOrdersIdRequestBodyMetadata'Variants Source #

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

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

PostOrdersIdRequestBodyMetadata'EmptyString	Represents the JSON value `""`
PostOrdersIdRequestBodyMetadata'Object Object

Instances

Instances details

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

data PostOrdersIdRequestBodyShipping' Source #

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

Tracking information once the order has been fulfilled.

Constructors

PostOrdersIdRequestBodyShipping'
Fields postOrdersIdRequestBodyShipping'Carrier :: Text carrier Constraints: Maximum length of 5000 postOrdersIdRequestBodyShipping'TrackingNumber :: Text tracking_number Constraints: Maximum length of 5000

Instances

Instances details

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

mkPostOrdersIdRequestBodyShipping' Source #

Arguments

:: Text	`postOrdersIdRequestBodyShipping'Carrier`
-> Text	`postOrdersIdRequestBodyShipping'TrackingNumber`
-> PostOrdersIdRequestBodyShipping'

Create a new PostOrdersIdRequestBodyShipping' with all required fields.

data PostOrdersIdRequestBodyStatus' Source #

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

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

Constructors

PostOrdersIdRequestBodyStatus'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostOrdersIdRequestBodyStatus'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostOrdersIdRequestBodyStatus'EnumCanceled	Represents the JSON value `"canceled"`
PostOrdersIdRequestBodyStatus'EnumCreated	Represents the JSON value `"created"`
PostOrdersIdRequestBodyStatus'EnumFulfilled	Represents the JSON value `"fulfilled"`
PostOrdersIdRequestBodyStatus'EnumPaid	Represents the JSON value `"paid"`
PostOrdersIdRequestBodyStatus'EnumReturned	Represents the JSON value `"returned"`

Instances

Instances details

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

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.

Instances

Instances details

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