Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostOrdersId

Description

Contains the different functions to run the operation postOrdersId

Synopsis

postOrdersId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostOrdersIdRequestBody -> m (Either HttpException (Response PostOrdersIdResponse))
postOrdersIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostOrdersIdRequestBody -> m (Either HttpException (Response ByteString))
postOrdersIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostOrdersIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostOrdersIdResponse))
postOrdersIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostOrdersIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostOrdersIdRequestBody = PostOrdersIdRequestBody {
}
data PostOrdersIdRequestBodyMetadata' = PostOrdersIdRequestBodyMetadata' {
}
data PostOrdersIdRequestBodyShipping' = PostOrdersIdRequestBodyShipping' {
- postOrdersIdRequestBodyShipping'Carrier :: Text
- postOrdersIdRequestBodyShipping'TrackingNumber :: Text
}
data PostOrdersIdRequestBodyStatus'
data PostOrdersIdResponse

Documentation

postOrdersId Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	id \| Constraints: Maximum length of 5000
-> Maybe 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 -> Text -> Maybe PostOrdersIdRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/orders/{id}

The same as postOrdersId but returns the raw ByteString

postOrdersIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostOrdersIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostOrdersIdResponse)) Source #

POST /v1/orders/{id}

Monadic version of postOrdersId (use with runWithConfiguration)

postOrdersIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostOrdersIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/orders/{id}

Monadic version of postOrdersIdRaw (use with runWithConfiguration)

data PostOrdersIdRequestBody Source #

Defines the data type for the schema postOrdersIdRequestBody

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'
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

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] #

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

Constructors

PostOrdersIdRequestBodyMetadata'

Instances

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

data PostOrdersIdRequestBodyShipping' Source #

Defines the data type for the schema postOrdersIdRequestBodyShipping'

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

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'] #

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.

Constructors

PostOrdersIdRequestBodyStatus'EnumOther Value
PostOrdersIdRequestBodyStatus'EnumTyped Text
PostOrdersIdRequestBodyStatus'EnumStringCanceled
PostOrdersIdRequestBodyStatus'EnumStringCreated
PostOrdersIdRequestBodyStatus'EnumStringFulfilled
PostOrdersIdRequestBodyStatus'EnumStringPaid
PostOrdersIdRequestBodyStatus'EnumStringReturned

Instances

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

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 #