Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetCouponsCoupon

Description

Contains the different functions to run the operation getCouponsCoupon

Synopsis

getCouponsCoupon :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe GetCouponsCouponRequestBody -> m (Either HttpException (Response GetCouponsCouponResponse))
getCouponsCouponRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe GetCouponsCouponRequestBody -> m (Either HttpException (Response ByteString))
getCouponsCouponM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe GetCouponsCouponRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCouponsCouponResponse))
getCouponsCouponRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe GetCouponsCouponRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetCouponsCouponRequestBody = GetCouponsCouponRequestBody {
}
data GetCouponsCouponResponse

Documentation

getCouponsCoupon Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	coupon \| Constraints: Maximum length of 5000
-> Maybe Text	expand: Specifies which fields in the response should be expanded.
-> Maybe GetCouponsCouponRequestBody	The request body to send
-> m (Either HttpException (Response GetCouponsCouponResponse))	Monad containing the result of the operation

GET /v1/coupons/{coupon}

<p>Retrieves the coupon with the given ID.</p>

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

GET /v1/coupons/{coupon}

The same as getCouponsCoupon but returns the raw ByteString

getCouponsCouponM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe GetCouponsCouponRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCouponsCouponResponse)) Source #

GET /v1/coupons/{coupon}

Monadic version of getCouponsCoupon (use with runWithConfiguration)

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

GET /v1/coupons/{coupon}

Monadic version of getCouponsCouponRaw (use with runWithConfiguration)

data GetCouponsCouponRequestBody Source #

Defines the data type for the schema getCouponsCouponRequestBody

Constructors

GetCouponsCouponRequestBody

Instances

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

data GetCouponsCouponResponse Source #

Represents a response of the operation getCouponsCoupon.

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

Constructors

GetCouponsCouponResponseError String	Means either no matching case available or a parse error
GetCouponsCouponResponse200 Coupon	Successful response.
GetCouponsCouponResponseDefault Error	Error response.

Instances

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