| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostPromotionCodesPromotionCode
Description
Contains the different functions to run the operation postPromotionCodesPromotionCode
Synopsis
- postPromotionCodesPromotionCode :: forall m. MonadHTTP m => Text -> Maybe PostPromotionCodesPromotionCodeRequestBody -> ClientT m (Response PostPromotionCodesPromotionCodeResponse)
- data PostPromotionCodesPromotionCodeRequestBody = PostPromotionCodesPromotionCodeRequestBody {}
- mkPostPromotionCodesPromotionCodeRequestBody :: PostPromotionCodesPromotionCodeRequestBody
- data PostPromotionCodesPromotionCodeRequestBodyMetadata'Variants
- data PostPromotionCodesPromotionCodeResponse
Documentation
postPromotionCodesPromotionCode Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | promotion_code | Constraints: Maximum length of 5000 |
| -> Maybe PostPromotionCodesPromotionCodeRequestBody | The request body to send |
| -> ClientT m (Response PostPromotionCodesPromotionCodeResponse) | Monadic computation which returns the result of the operation |
POST /v1/promotion_codes/{promotion_code}<p>Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.</p>
data PostPromotionCodesPromotionCodeRequestBody Source #
Defines the object schema located at paths./v1/promotion_codes/{promotion_code}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostPromotionCodesPromotionCodeRequestBody | |
Fields
| |
Instances
mkPostPromotionCodesPromotionCodeRequestBody :: PostPromotionCodesPromotionCodeRequestBody Source #
Create a new PostPromotionCodesPromotionCodeRequestBody with all required fields.
data PostPromotionCodesPromotionCodeRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/promotion_codes/{promotion_code}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.
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
| PostPromotionCodesPromotionCodeRequestBodyMetadata'EmptyString | Represents the JSON value |
| PostPromotionCodesPromotionCodeRequestBodyMetadata'Object Object |
Instances
data PostPromotionCodesPromotionCodeResponse Source #
Represents a response of the operation postPromotionCodesPromotionCode.
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), PostPromotionCodesPromotionCodeResponseError is used.
Constructors
| PostPromotionCodesPromotionCodeResponseError String | Means either no matching case available or a parse error |
| PostPromotionCodesPromotionCodeResponse200 PromotionCode | Successful response. |
| PostPromotionCodesPromotionCodeResponseDefault Error | Error response. |