Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostCouponsCoupon

Description

Contains the different functions to run the operation postCouponsCoupon

Synopsis

postCouponsCoupon :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostCouponsCouponRequestBody -> m (Either HttpException (Response PostCouponsCouponResponse))
postCouponsCouponRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostCouponsCouponRequestBody -> m (Either HttpException (Response ByteString))
postCouponsCouponM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostCouponsCouponRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCouponsCouponResponse))
postCouponsCouponRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostCouponsCouponRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostCouponsCouponRequestBody = PostCouponsCouponRequestBody {
}
data PostCouponsCouponRequestBodyMetadata' = PostCouponsCouponRequestBodyMetadata' {
}
data PostCouponsCouponResponse

Documentation

postCouponsCoupon Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	coupon \| Constraints: Maximum length of 5000
-> Maybe PostCouponsCouponRequestBody	The request body to send
-> m (Either HttpException (Response PostCouponsCouponResponse))	Monad containing the result of the operation

POST /v1/coupons/{coupon}

<p>Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.</p>

postCouponsCouponRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostCouponsCouponRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/coupons/{coupon}

The same as postCouponsCoupon but returns the raw ByteString

postCouponsCouponM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostCouponsCouponRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCouponsCouponResponse)) Source #

POST /v1/coupons/{coupon}

Monadic version of postCouponsCoupon (use with runWithConfiguration)

postCouponsCouponRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostCouponsCouponRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/coupons/{coupon}

Monadic version of postCouponsCouponRaw (use with runWithConfiguration)

data PostCouponsCouponRequestBody Source #

Defines the data type for the schema postCouponsCouponRequestBody

Constructors

PostCouponsCouponRequestBody

Fields

postCouponsCouponRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postCouponsCouponRequestBodyMetadata :: Maybe PostCouponsCouponRequestBodyMetadata'
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`.
postCouponsCouponRequestBodyName :: Maybe Text
name: Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
Constraints:
- Maximum length of 40

Instances

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

data PostCouponsCouponRequestBodyMetadata' Source #

Defines the data type for the schema postCouponsCouponRequestBodyMetadata'

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

PostCouponsCouponRequestBodyMetadata'

Instances

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

data PostCouponsCouponResponse Source #

Represents a response of the operation postCouponsCoupon.

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

Constructors

PostCouponsCouponResponseError String	Means either no matching case available or a parse error
PostCouponsCouponResponse200 Coupon	Successful response.
PostCouponsCouponResponseDefault Error	Error response.

Instances

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