| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Update_plan
Description
Contains the different functions to run the operation update_plan
Synopsis
- update_plan :: forall m. MonadHTTP m => Text -> PlanUpdate -> ClientT m (Response Update_planResponse)
- data Update_planResponse
- update_planWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> PlanUpdate -> m (Response Update_planResponse)
- update_planRaw :: forall m. MonadHTTP m => Text -> PlanUpdate -> ClientT m (Response ByteString)
- update_planWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> PlanUpdate -> m (Response ByteString)
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => Text | plan_id: Plan ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-gold`. |
| -> PlanUpdate | The request body to send |
| -> ClientT m (Response Update_planResponse) | Monadic computation which returns the result of the operation |
PUT /plans/{plan_id}Update a plan
data Update_planResponse Source #
Represents a response of the operation update_plan.
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), Update_planResponseError is used.
Constructors
| Update_planResponseError String | Means either no matching case available or a parse error |
| Update_planResponse201 Plan | A plan. |
| Update_planResponse404 Error | Incorrect site ID. |
| Update_planResponse422 Error | A validation error such as 'Code has already been taken.' |
| Update_planResponseDefault Error | Unexpected error. |
Instances
| Show Update_planResponse Source # | |
Defined in RecurlyClient.Operations.Update_plan Methods showsPrec :: Int -> Update_planResponse -> ShowS # show :: Update_planResponse -> String # showList :: [Update_planResponse] -> ShowS # | |
| Eq Update_planResponse Source # | |
Defined in RecurlyClient.Operations.Update_plan Methods (==) :: Update_planResponse -> Update_planResponse -> Bool # (/=) :: Update_planResponse -> Update_planResponse -> Bool # | |
update_planWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | plan_id: Plan ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-gold`. |
| -> PlanUpdate | The request body to send |
| -> m (Response Update_planResponse) | Monadic computation which returns the result of the operation |
PUT /plans/{plan_id}The same as update_plan but accepts an explicit configuration.
Arguments
| :: forall m. MonadHTTP m | |
| => Text | plan_id: Plan ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-gold`. |
| -> PlanUpdate | The request body to send |
| -> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
PUT /plans/{plan_id}The same as update_plan but returns the raw ByteString.
update_planWithConfigurationRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | plan_id: Plan ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-gold`. |
| -> PlanUpdate | The request body to send |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
PUT /plans/{plan_id}The same as update_plan but accepts an explicit configuration and returns the raw ByteString.