stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostProductsId

Description

Contains the different functions to run the operation postProductsId

Synopsis

Documentation

postProductsId Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> String

id | Constraints: Maximum length of 5000

-> 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 -> String -> PostProductsIdRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/products/{id}

The same as postProductsId but returns the raw ByteString

data PostProductsIdRequestBody Source #

Defines the data type for the schema postProductsIdRequestBody

Constructors

PostProductsIdRequestBody 

Fields

data PostProductsIdRequestBodyAttributes'OneOf1 Source #

Defines the enum schema postProductsIdRequestBodyAttributes'OneOf1

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.

Instances
Eq PostProductsIdRequestBodyAttributes'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

Show PostProductsIdRequestBodyAttributes'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

Generic PostProductsIdRequestBodyAttributes'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

ToJSON PostProductsIdRequestBodyAttributes'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

FromJSON PostProductsIdRequestBodyAttributes'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

type Rep PostProductsIdRequestBodyAttributes'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

type Rep PostProductsIdRequestBodyAttributes'Variants = D1 (MetaData "PostProductsIdRequestBodyAttributes'Variants" "StripeAPI.Operations.PostProductsId" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostProductsIdRequestBodyAttributes'PostProductsIdRequestBodyAttributes'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostProductsIdRequestBodyAttributes'OneOf1)) :+: C1 (MetaCons "PostProductsIdRequestBodyAttributes'ListString" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))

data PostProductsIdRequestBodyImages'OneOf1 Source #

Defines the enum schema postProductsIdRequestBodyImages'OneOf1

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.

Instances
Eq PostProductsIdRequestBodyImages'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

Show PostProductsIdRequestBodyImages'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

Generic PostProductsIdRequestBodyImages'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

ToJSON PostProductsIdRequestBodyImages'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

FromJSON PostProductsIdRequestBodyImages'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

type Rep PostProductsIdRequestBodyImages'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

type Rep PostProductsIdRequestBodyImages'Variants = D1 (MetaData "PostProductsIdRequestBodyImages'Variants" "StripeAPI.Operations.PostProductsId" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostProductsIdRequestBodyImages'PostProductsIdRequestBodyImages'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostProductsIdRequestBodyImages'OneOf1)) :+: C1 (MetaCons "PostProductsIdRequestBodyImages'ListString" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))

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

data PostProductsIdRequestBodyPackageDimensions'OneOf1 Source #

Defines the enum schema postProductsIdRequestBodyPackage_dimensions'OneOf1

data PostProductsIdRequestBodyPackageDimensions'OneOf2 Source #

Defines the data type for the schema postProductsIdRequestBodyPackage_dimensions'OneOf2

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

Instances
Eq PostProductsIdRequestBodyPackageDimensions'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

Show PostProductsIdRequestBodyPackageDimensions'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

Generic PostProductsIdRequestBodyPackageDimensions'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

ToJSON PostProductsIdRequestBodyPackageDimensions'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

FromJSON PostProductsIdRequestBodyPackageDimensions'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

type Rep PostProductsIdRequestBodyPackageDimensions'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostProductsId

type Rep PostProductsIdRequestBodyPackageDimensions'Variants = D1 (MetaData "PostProductsIdRequestBodyPackageDimensions'Variants" "StripeAPI.Operations.PostProductsId" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostProductsIdRequestBodyPackageDimensions'PostProductsIdRequestBodyPackageDimensions'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostProductsIdRequestBodyPackageDimensions'OneOf1)) :+: C1 (MetaCons "PostProductsIdRequestBodyPackageDimensions'PostProductsIdRequestBodyPackageDimensions'OneOf2" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostProductsIdRequestBodyPackageDimensions'OneOf2)))

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.