Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postOrdersId
Synopsis
- postOrdersId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostOrdersIdRequestBody -> m (Either HttpException (Response PostOrdersIdResponse))
- postOrdersIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostOrdersIdRequestBody -> m (Either HttpException (Response ByteString))
- postOrdersIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostOrdersIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostOrdersIdResponse))
- postOrdersIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostOrdersIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostOrdersIdRequestBody = PostOrdersIdRequestBody {
- postOrdersIdRequestBodyCoupon :: Maybe String
- postOrdersIdRequestBodyExpand :: Maybe ([] String)
- postOrdersIdRequestBodyMetadata :: Maybe PostOrdersIdRequestBodyMetadata'
- postOrdersIdRequestBodySelectedShippingMethod :: Maybe String
- postOrdersIdRequestBodyShipping :: Maybe PostOrdersIdRequestBodyShipping'
- postOrdersIdRequestBodyStatus :: Maybe PostOrdersIdRequestBodyStatus'
- data PostOrdersIdRequestBodyMetadata' = PostOrdersIdRequestBodyMetadata' {
- data PostOrdersIdRequestBodyShipping' = PostOrdersIdRequestBodyShipping' {}
- data PostOrdersIdRequestBodyStatus'
- = PostOrdersIdRequestBodyStatus'EnumOther Value
- | PostOrdersIdRequestBodyStatus'EnumTyped String
- | PostOrdersIdRequestBodyStatus'EnumStringCanceled
- | PostOrdersIdRequestBodyStatus'EnumStringCreated
- | PostOrdersIdRequestBodyStatus'EnumStringFulfilled
- | PostOrdersIdRequestBodyStatus'EnumStringPaid
- | PostOrdersIdRequestBodyStatus'EnumStringReturned
- data PostOrdersIdResponse
Documentation
:: (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
postOrdersIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> 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) => String -> 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
PostOrdersIdRequestBody | |
|
Instances
Eq PostOrdersIdRequestBody Source # | |
Defined in StripeAPI.Operations.PostOrdersId | |
Show PostOrdersIdRequestBody Source # | |
Defined in StripeAPI.Operations.PostOrdersId showsPrec :: Int -> PostOrdersIdRequestBody -> ShowS # show :: PostOrdersIdRequestBody -> String # showList :: [PostOrdersIdRequestBody] -> ShowS # | |
ToJSON PostOrdersIdRequestBody Source # | |
Defined in StripeAPI.Operations.PostOrdersId | |
FromJSON PostOrdersIdRequestBody Source # | |
Defined in StripeAPI.Operations.PostOrdersId |
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.
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.
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.
PostOrdersIdResponseError String | Means either no matching case available or a parse error |
PostOrdersIdResponse200 Order | Successful response. |
PostOrdersIdResponseDefault Error | Error response. |
Instances
Eq PostOrdersIdResponse Source # | |
Defined in StripeAPI.Operations.PostOrdersId (==) :: PostOrdersIdResponse -> PostOrdersIdResponse -> Bool # (/=) :: PostOrdersIdResponse -> PostOrdersIdResponse -> Bool # | |
Show PostOrdersIdResponse Source # | |
Defined in StripeAPI.Operations.PostOrdersId showsPrec :: Int -> PostOrdersIdResponse -> ShowS # show :: PostOrdersIdResponse -> String # showList :: [PostOrdersIdResponse] -> ShowS # |