| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostProductsId
Description
Contains the different functions to run the operation postProductsId
Synopsis
- postProductsId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostProductsIdRequestBody -> m (Either HttpException (Response PostProductsIdResponse))
- postProductsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostProductsIdRequestBody -> m (Either HttpException (Response ByteString))
- postProductsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostProductsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostProductsIdResponse))
- postProductsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostProductsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostProductsIdRequestBody = PostProductsIdRequestBody {
- postProductsIdRequestBodyActive :: Maybe Bool
- postProductsIdRequestBodyAttributes :: Maybe PostProductsIdRequestBodyAttributes'Variants
- postProductsIdRequestBodyCaption :: Maybe Text
- postProductsIdRequestBodyDeactivateOn :: Maybe ([] Text)
- postProductsIdRequestBodyDescription :: Maybe Text
- postProductsIdRequestBodyExpand :: Maybe ([] Text)
- postProductsIdRequestBodyImages :: Maybe PostProductsIdRequestBodyImages'Variants
- postProductsIdRequestBodyMetadata :: Maybe PostProductsIdRequestBodyMetadata'
- postProductsIdRequestBodyName :: Maybe Text
- postProductsIdRequestBodyPackageDimensions :: Maybe PostProductsIdRequestBodyPackageDimensions'Variants
- postProductsIdRequestBodyShippable :: Maybe Bool
- postProductsIdRequestBodyStatementDescriptor :: Maybe Text
- postProductsIdRequestBodyUnitLabel :: Maybe Text
- postProductsIdRequestBodyUrl :: Maybe Text
- data PostProductsIdRequestBodyAttributes'OneOf1
- data PostProductsIdRequestBodyAttributes'Variants
- data PostProductsIdRequestBodyImages'OneOf1
- data PostProductsIdRequestBodyImages'Variants
- data PostProductsIdRequestBodyMetadata' = PostProductsIdRequestBodyMetadata' {
- data PostProductsIdRequestBodyPackageDimensions'OneOf1
- data PostProductsIdRequestBodyPackageDimensions'OneOf2 = PostProductsIdRequestBodyPackageDimensions'OneOf2 {}
- data PostProductsIdRequestBodyPackageDimensions'Variants
- data PostProductsIdResponse
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Text | id | Constraints: Maximum length of 5000 |
| -> Maybe PostProductsIdRequestBody | The request body to send |
| -> m (Either HttpException (Response PostProductsIdResponse)) | Monad containing the result of the operation |
POST /v1/products/{id}<p>Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
postProductsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostProductsIdRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/products/{id}The same as postProductsId but returns the raw ByteString
postProductsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostProductsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostProductsIdResponse)) Source #
POST /v1/products/{id}Monadic version of postProductsId (use with runWithConfiguration)
postProductsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostProductsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/products/{id}Monadic version of postProductsIdRaw (use with runWithConfiguration)
data PostProductsIdRequestBody Source #
Defines the data type for the schema postProductsIdRequestBody
Constructors
| PostProductsIdRequestBody | |
Fields
| |
Instances
| Eq PostProductsIdRequestBody Source # | |
Defined in StripeAPI.Operations.PostProductsId Methods (==) :: PostProductsIdRequestBody -> PostProductsIdRequestBody -> Bool # (/=) :: PostProductsIdRequestBody -> PostProductsIdRequestBody -> Bool # | |
| Show PostProductsIdRequestBody Source # | |
Defined in StripeAPI.Operations.PostProductsId Methods showsPrec :: Int -> PostProductsIdRequestBody -> ShowS # show :: PostProductsIdRequestBody -> String # showList :: [PostProductsIdRequestBody] -> ShowS # | |
| ToJSON PostProductsIdRequestBody Source # | |
Defined in StripeAPI.Operations.PostProductsId Methods toJSON :: PostProductsIdRequestBody -> Value # toEncoding :: PostProductsIdRequestBody -> Encoding # toJSONList :: [PostProductsIdRequestBody] -> Value # | |
| FromJSON PostProductsIdRequestBody Source # | |
Defined in StripeAPI.Operations.PostProductsId Methods parseJSON :: Value -> Parser PostProductsIdRequestBody # parseJSONList :: Value -> Parser [PostProductsIdRequestBody] # | |
data PostProductsIdRequestBodyAttributes'OneOf1 Source #
Defines the enum schema postProductsIdRequestBodyAttributes'OneOf1
Constructors
| PostProductsIdRequestBodyAttributes'OneOf1EnumOther Value | |
| PostProductsIdRequestBodyAttributes'OneOf1EnumTyped Text | |
| PostProductsIdRequestBodyAttributes'OneOf1EnumString_ |
Instances
data PostProductsIdRequestBodyAttributes'Variants Source #
Define the one-of schema postProductsIdRequestBodyAttributes'
A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., `["color", "size"]`). If a value for `attributes` is specified, the list specified will replace the existing attributes list on this product. Any attributes not present after the update will be deleted from the SKUs for this product.
Constructors
| PostProductsIdRequestBodyAttributes'PostProductsIdRequestBodyAttributes'OneOf1 PostProductsIdRequestBodyAttributes'OneOf1 | |
| PostProductsIdRequestBodyAttributes'ListText ([] Text) |
Instances
data PostProductsIdRequestBodyImages'OneOf1 Source #
Defines the enum schema postProductsIdRequestBodyImages'OneOf1
Constructors
| PostProductsIdRequestBodyImages'OneOf1EnumOther Value | |
| PostProductsIdRequestBodyImages'OneOf1EnumTyped Text | |
| PostProductsIdRequestBodyImages'OneOf1EnumString_ |
Instances
data PostProductsIdRequestBodyImages'Variants Source #
Define the one-of schema postProductsIdRequestBodyImages'
A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
Constructors
| PostProductsIdRequestBodyImages'PostProductsIdRequestBodyImages'OneOf1 PostProductsIdRequestBodyImages'OneOf1 | |
| PostProductsIdRequestBodyImages'ListText ([] Text) |
Instances
data PostProductsIdRequestBodyMetadata' Source #
Defines the data type for the schema postProductsIdRequestBodyMetadata'
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
| PostProductsIdRequestBodyMetadata' | |
Instances
data PostProductsIdRequestBodyPackageDimensions'OneOf1 Source #
Defines the enum schema postProductsIdRequestBodyPackage_dimensions'OneOf1
Constructors
| PostProductsIdRequestBodyPackageDimensions'OneOf1EnumOther Value | |
| PostProductsIdRequestBodyPackageDimensions'OneOf1EnumTyped Text | |
| PostProductsIdRequestBodyPackageDimensions'OneOf1EnumString_ |
Instances
data PostProductsIdRequestBodyPackageDimensions'OneOf2 Source #
Defines the data type for the schema postProductsIdRequestBodyPackage_dimensions'OneOf2
Instances
data PostProductsIdRequestBodyPackageDimensions'Variants Source #
Define the one-of schema postProductsIdRequestBodyPackage_dimensions'
The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own `package_dimensions`. May only be set if `type=good`.
Constructors
Instances
data PostProductsIdResponse Source #
Represents a response of the operation postProductsId.
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), PostProductsIdResponseError is used.
Constructors
| PostProductsIdResponseError String | Means either no matching case available or a parse error |
| PostProductsIdResponse200 Product | Successful response. |
| PostProductsIdResponseDefault Error | Error response. |
Instances
| Eq PostProductsIdResponse Source # | |
Defined in StripeAPI.Operations.PostProductsId Methods (==) :: PostProductsIdResponse -> PostProductsIdResponse -> Bool # (/=) :: PostProductsIdResponse -> PostProductsIdResponse -> Bool # | |
| Show PostProductsIdResponse Source # | |
Defined in StripeAPI.Operations.PostProductsId Methods showsPrec :: Int -> PostProductsIdResponse -> ShowS # show :: PostProductsIdResponse -> String # showList :: [PostProductsIdResponse] -> ShowS # | |