Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostSkus

Description

Contains the different functions to run the operation postSkus

Synopsis

postSkus :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostSkusRequestBody -> m (Either HttpException (Response PostSkusResponse))
postSkusRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostSkusRequestBody -> m (Either HttpException (Response ByteString))
postSkusM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostSkusRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSkusResponse))
postSkusRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostSkusRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostSkusRequestBody = PostSkusRequestBody {
}
data PostSkusRequestBodyAttributes' = PostSkusRequestBodyAttributes' {
}
data PostSkusRequestBodyInventory' = PostSkusRequestBodyInventory' {
}
data PostSkusRequestBodyInventory'Type'
data PostSkusRequestBodyInventory'Value'
data PostSkusRequestBodyMetadata' = PostSkusRequestBodyMetadata' {
}
data PostSkusRequestBodyPackageDimensions' = PostSkusRequestBodyPackageDimensions' {
}
data PostSkusResponse

Documentation

postSkus Source #

Arguments

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

POST /v1/skus

<p>Creates a new SKU associated with a product.</p>

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

POST /v1/skus

The same as postSkus but returns the raw ByteString

postSkusM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostSkusRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSkusResponse)) Source #

POST /v1/skus

Monadic version of postSkus (use with runWithConfiguration)

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

POST /v1/skus

Monadic version of postSkusRaw (use with runWithConfiguration)

data PostSkusRequestBody Source #

Defines the data type for the schema postSkusRequestBody

Constructors

PostSkusRequestBody

Fields

postSkusRequestBodyActive :: Maybe Bool
active: Whether the SKU is available for purchase. Default to `true`.
postSkusRequestBodyAttributes :: Maybe PostSkusRequestBodyAttributes'
attributes: A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`.
postSkusRequestBodyCurrency :: Text
currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
postSkusRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postSkusRequestBodyId :: Maybe Text
id: The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated.
postSkusRequestBodyImage :: Maybe Text
image: The URL of an image for this SKU, meant to be displayable to the customer.
Constraints:
- Maximum length of 5000
postSkusRequestBodyInventory :: PostSkusRequestBodyInventory'
inventory: Description of the SKU's inventory.
postSkusRequestBodyMetadata :: Maybe PostSkusRequestBodyMetadata'
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`.
postSkusRequestBodyPackageDimensions :: Maybe PostSkusRequestBodyPackageDimensions'
package_dimensions: The dimensions of this SKU for shipping purposes.
postSkusRequestBodyPrice :: Integer
price: The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).
postSkusRequestBodyProduct :: Text
product: The ID of the product this SKU is associated with. Must be a product with type `good`.
Constraints:
- Maximum length of 5000

Instances

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

data PostSkusRequestBodyAttributes' Source #

Defines the data type for the schema postSkusRequestBodyAttributes'

A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`.

Constructors

PostSkusRequestBodyAttributes'

Instances

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

data PostSkusRequestBodyInventory' Source #

Defines the data type for the schema postSkusRequestBodyInventory'

Description of the SKU's inventory.

Constructors

PostSkusRequestBodyInventory'
Fields postSkusRequestBodyInventory'Quantity :: Maybe Integer quantity postSkusRequestBodyInventory'Type :: Maybe PostSkusRequestBodyInventory'Type' type Constraints: Maximum length of 5000 postSkusRequestBodyInventory'Value :: Maybe PostSkusRequestBodyInventory'Value' value Constraints: Maximum length of 5000

Instances

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

data PostSkusRequestBodyInventory'Type' Source #

Defines the enum schema postSkusRequestBodyInventory'Type'

Constructors

PostSkusRequestBodyInventory'Type'EnumOther Value
PostSkusRequestBodyInventory'Type'EnumTyped Text
PostSkusRequestBodyInventory'Type'EnumStringBucket
PostSkusRequestBodyInventory'Type'EnumStringFinite
PostSkusRequestBodyInventory'Type'EnumStringInfinite

Instances

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

data PostSkusRequestBodyInventory'Value' Source #

Defines the enum schema postSkusRequestBodyInventory'Value'

Constructors

PostSkusRequestBodyInventory'Value'EnumOther Value
PostSkusRequestBodyInventory'Value'EnumTyped Text
PostSkusRequestBodyInventory'Value'EnumString_
PostSkusRequestBodyInventory'Value'EnumStringInStock
PostSkusRequestBodyInventory'Value'EnumStringLimited
PostSkusRequestBodyInventory'Value'EnumStringOutOfStock

Instances

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

data PostSkusRequestBodyMetadata' Source #

Defines the data type for the schema postSkusRequestBodyMetadata'

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

PostSkusRequestBodyMetadata'

Instances

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

data PostSkusRequestBodyPackageDimensions' Source #

Defines the data type for the schema postSkusRequestBodyPackage_dimensions'

The dimensions of this SKU for shipping purposes.

Constructors

PostSkusRequestBodyPackageDimensions'
Fields postSkusRequestBodyPackageDimensions'Height :: Double height postSkusRequestBodyPackageDimensions'Length :: Double length postSkusRequestBodyPackageDimensions'Weight :: Double weight postSkusRequestBodyPackageDimensions'Width :: Double width

Instances

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

data PostSkusResponse Source #

Represents a response of the operation postSkus.

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

Constructors

PostSkusResponseError String	Means either no matching case available or a parse error
PostSkusResponse200 Sku	Successful response.
PostSkusResponseDefault Error	Error response.

Instances

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