Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostOrders

Description

Contains the different functions to run the operation postOrders

Synopsis

postOrders :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostOrdersRequestBody -> m (Either HttpException (Response PostOrdersResponse))
postOrdersRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostOrdersRequestBody -> m (Either HttpException (Response ByteString))
postOrdersM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostOrdersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostOrdersResponse))
postOrdersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostOrdersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostOrdersRequestBody = PostOrdersRequestBody {
}
data PostOrdersRequestBodyItems' = PostOrdersRequestBodyItems' {
}
data PostOrdersRequestBodyItems'Type'
data PostOrdersRequestBodyMetadata' = PostOrdersRequestBodyMetadata' {
}
data PostOrdersRequestBodyShipping' = PostOrdersRequestBodyShipping' {
}
data PostOrdersRequestBodyShipping'Address' = PostOrdersRequestBodyShipping'Address' {
}
data PostOrdersResponse

Documentation

postOrders Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> PostOrdersRequestBody	The request body to send
-> m (Either HttpException (Response PostOrdersResponse))	Monad containing the result of the operation

POST /v1/orders

<p>Creates a new order object.</p>

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

POST /v1/orders

The same as postOrders but returns the raw ByteString

postOrdersM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostOrdersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostOrdersResponse)) Source #

POST /v1/orders

Monadic version of postOrders (use with runWithConfiguration)

postOrdersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostOrdersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/orders

Monadic version of postOrdersRaw (use with runWithConfiguration)

data PostOrdersRequestBody Source #

Defines the data type for the schema postOrdersRequestBody

Constructors

PostOrdersRequestBody

Fields

postOrdersRequestBodyCoupon :: Maybe String
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
postOrdersRequestBodyCurrency :: String
currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
postOrdersRequestBodyCustomer :: Maybe String
customer: The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object.
Constraints:
- Maximum length of 5000
postOrdersRequestBodyEmail :: Maybe String
email: The email address of the customer placing the order.
Constraints:
- Maximum length of 5000
postOrdersRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.
postOrdersRequestBodyItems :: Maybe ([] PostOrdersRequestBodyItems')
items: List of items constituting the order. An order can have up to 25 items.
postOrdersRequestBodyMetadata :: Maybe PostOrdersRequestBodyMetadata'
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`.
postOrdersRequestBodyShipping :: Maybe PostOrdersRequestBodyShipping'
shipping: Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.

Instances

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

data PostOrdersRequestBodyItems' Source #

Defines the data type for the schema postOrdersRequestBodyItems'

Constructors

PostOrdersRequestBodyItems'

Fields

postOrdersRequestBodyItems'Amount :: Maybe Integer
amount
postOrdersRequestBodyItems'Currency :: Maybe String
currency
postOrdersRequestBodyItems'Description :: Maybe String
description
Constraints:
- Maximum length of 1000
postOrdersRequestBodyItems'Parent :: Maybe String
parent
Constraints:
- Maximum length of 5000
postOrdersRequestBodyItems'Quantity :: Maybe Integer
quantity
postOrdersRequestBodyItems'Type :: Maybe PostOrdersRequestBodyItems'Type'
type
Constraints:
- Maximum length of 5000

Instances

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

data PostOrdersRequestBodyItems'Type' Source #

Defines the enum schema postOrdersRequestBodyItems'Type'

Constructors

PostOrdersRequestBodyItems'Type'EnumOther Value
PostOrdersRequestBodyItems'Type'EnumTyped String
PostOrdersRequestBodyItems'Type'EnumStringDiscount
PostOrdersRequestBodyItems'Type'EnumStringShipping
PostOrdersRequestBodyItems'Type'EnumStringSku
PostOrdersRequestBodyItems'Type'EnumStringTax

Instances

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

data PostOrdersRequestBodyMetadata' Source #

Defines the data type for the schema postOrdersRequestBodyMetadata'

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

PostOrdersRequestBodyMetadata'

Instances

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

data PostOrdersRequestBodyShipping' Source #

Defines the data type for the schema postOrdersRequestBodyShipping'

Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.

Constructors

PostOrdersRequestBodyShipping'
Fields postOrdersRequestBodyShipping'Address :: PostOrdersRequestBodyShipping'Address' address postOrdersRequestBodyShipping'Name :: String name Constraints: Maximum length of 5000 postOrdersRequestBodyShipping'Phone :: Maybe String phone Constraints: Maximum length of 5000

Instances

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

data PostOrdersRequestBodyShipping'Address' Source #

Defines the data type for the schema postOrdersRequestBodyShipping'Address'

Constructors

PostOrdersRequestBodyShipping'Address'

Fields

postOrdersRequestBodyShipping'Address'City :: Maybe String
city
Constraints:
- Maximum length of 5000
postOrdersRequestBodyShipping'Address'Country :: Maybe String
country
Constraints:
- Maximum length of 5000
postOrdersRequestBodyShipping'Address'Line1 :: String
line1
Constraints:
- Maximum length of 5000
postOrdersRequestBodyShipping'Address'Line2 :: Maybe String
line2
Constraints:
- Maximum length of 5000
postOrdersRequestBodyShipping'Address'PostalCode :: Maybe String
postal_code
Constraints:
- Maximum length of 5000
postOrdersRequestBodyShipping'Address'State :: Maybe String
state
Constraints:
- Maximum length of 5000

Instances

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

data PostOrdersResponse Source #

Represents a response of the operation postOrders.

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

Constructors

PostOrdersResponseError String	Means either no matching case available or a parse error
PostOrdersResponse200 Order	Successful response.
PostOrdersResponseDefault Error	Error response.

Instances

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