| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Preview_gift_card
Description
Contains the different functions to run the operation preview_gift_card
Synopsis
- preview_gift_card :: forall m. MonadHTTP m => GiftCardCreate -> ClientT m (Response Preview_gift_cardResponse)
- data Preview_gift_cardResponse
- preview_gift_cardWithConfiguration :: forall m. MonadHTTP m => Configuration -> GiftCardCreate -> m (Response Preview_gift_cardResponse)
- preview_gift_cardRaw :: forall m. MonadHTTP m => GiftCardCreate -> ClientT m (Response ByteString)
- preview_gift_cardWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> GiftCardCreate -> m (Response ByteString)
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => GiftCardCreate | The request body to send |
| -> ClientT m (Response Preview_gift_cardResponse) | Monadic computation which returns the result of the operation |
POST /gift_cards/preview
Preview gift card
data Preview_gift_cardResponse Source #
Represents a response of the operation preview_gift_card.
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), Preview_gift_cardResponseError is used.
Constructors
| Preview_gift_cardResponseError String | Means either no matching case available or a parse error |
| Preview_gift_cardResponse201 GiftCard | Returns the gift card |
| Preview_gift_cardResponse400 Error | Bad request; perhaps missing or invalid parameters. |
| Preview_gift_cardResponse422 Error | Gift card cannot be completed for the specified reason. |
| Preview_gift_cardResponseDefault Error | Unexpected error. |
Instances
| Show Preview_gift_cardResponse Source # | |
Defined in RecurlyClient.Operations.Preview_gift_card Methods showsPrec :: Int -> Preview_gift_cardResponse -> ShowS # show :: Preview_gift_cardResponse -> String # showList :: [Preview_gift_cardResponse] -> ShowS # | |
| Eq Preview_gift_cardResponse Source # | |
Defined in RecurlyClient.Operations.Preview_gift_card Methods (==) :: Preview_gift_cardResponse -> Preview_gift_cardResponse -> Bool # (/=) :: Preview_gift_cardResponse -> Preview_gift_cardResponse -> Bool # | |
preview_gift_cardWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> GiftCardCreate | The request body to send |
| -> m (Response Preview_gift_cardResponse) | Monadic computation which returns the result of the operation |
POST /gift_cards/preview
The same as preview_gift_card but accepts an explicit configuration.
Arguments
| :: forall m. MonadHTTP m | |
| => GiftCardCreate | The request body to send |
| -> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /gift_cards/preview
The same as preview_gift_card but returns the raw ByteString.
preview_gift_cardWithConfigurationRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> GiftCardCreate | The request body to send |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /gift_cards/preview
The same as preview_gift_card but accepts an explicit configuration and returns the raw ByteString.