| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Preview_subscription_change
Description
Contains the different functions to run the operation preview_subscription_change
Synopsis
- preview_subscription_change :: forall m. MonadHTTP m => Text -> SubscriptionChangeCreate -> ClientT m (Response Preview_subscription_changeResponse)
- data Preview_subscription_changeResponse
- preview_subscription_changeWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> SubscriptionChangeCreate -> m (Response Preview_subscription_changeResponse)
- preview_subscription_changeRaw :: forall m. MonadHTTP m => Text -> SubscriptionChangeCreate -> ClientT m (Response ByteString)
- preview_subscription_changeWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> SubscriptionChangeCreate -> m (Response ByteString)
Documentation
preview_subscription_change Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | subscription_id: Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`. |
| -> SubscriptionChangeCreate | The request body to send |
| -> ClientT m (Response Preview_subscription_changeResponse) | Monadic computation which returns the result of the operation |
POST /subscriptions/{subscription_id}/change/previewCalling this will not save the subscription change or overwrite an existing change.
data Preview_subscription_changeResponse Source #
Represents a response of the operation preview_subscription_change.
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_subscription_changeResponseError is used.
Constructors
| Preview_subscription_changeResponseError String | Means either no matching case available or a parse error |
| Preview_subscription_changeResponse200 SubscriptionChange | A subscription change. |
| Preview_subscription_changeResponse404 Error | Incorrect site ID. |
| Preview_subscription_changeResponse422 ErrorMayHaveTransaction | A validation error such as "Subscription hasn't been changed" or error running the verification transaction. |
| Preview_subscription_changeResponseDefault Error | Unexpected error. |
Instances
preview_subscription_changeWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | subscription_id: Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`. |
| -> SubscriptionChangeCreate | The request body to send |
| -> m (Response Preview_subscription_changeResponse) | Monadic computation which returns the result of the operation |
POST /subscriptions/{subscription_id}/change/previewThe same as preview_subscription_change but accepts an explicit configuration.
preview_subscription_changeRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | subscription_id: Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`. |
| -> SubscriptionChangeCreate | The request body to send |
| -> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /subscriptions/{subscription_id}/change/previewThe same as preview_subscription_change but returns the raw ByteString.
preview_subscription_changeWithConfigurationRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | subscription_id: Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`. |
| -> SubscriptionChangeCreate | The request body to send |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /subscriptions/{subscription_id}/change/previewThe same as preview_subscription_change but accepts an explicit configuration and returns the raw ByteString.