| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Update_item
Description
Contains the different functions to run the operation update_item
Synopsis
- update_item :: forall m. MonadHTTP m => Text -> ItemUpdate -> ClientT m (Response Update_itemResponse)
- data Update_itemResponse
- update_itemWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> ItemUpdate -> m (Response Update_itemResponse)
- update_itemRaw :: forall m. MonadHTTP m => Text -> ItemUpdate -> ClientT m (Response ByteString)
- update_itemWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> ItemUpdate -> m (Response ByteString)
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => Text | item_id: Item ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-red`. |
| -> ItemUpdate | The request body to send |
| -> ClientT m (Response Update_itemResponse) | Monadic computation which returns the result of the operation |
PUT /items/{item_id}Update an active item
data Update_itemResponse Source #
Represents a response of the operation update_item.
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_itemResponseError is used.
Constructors
| Update_itemResponseError String | Means either no matching case available or a parse error |
| Update_itemResponse200 Item | The updated item. |
| Update_itemResponse400 Error | Bad request, perhaps invalid JSON? |
| Update_itemResponse404 Error | Incorrect site or item ID. |
| Update_itemResponse422 Error | Invalid request parameters |
| Update_itemResponseDefault Error | Unexpected error. |
Instances
| Show Update_itemResponse Source # | |
Defined in RecurlyClient.Operations.Update_item Methods showsPrec :: Int -> Update_itemResponse -> ShowS # show :: Update_itemResponse -> String # showList :: [Update_itemResponse] -> ShowS # | |
| Eq Update_itemResponse Source # | |
Defined in RecurlyClient.Operations.Update_item Methods (==) :: Update_itemResponse -> Update_itemResponse -> Bool # (/=) :: Update_itemResponse -> Update_itemResponse -> Bool # | |
update_itemWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | item_id: Item ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-red`. |
| -> ItemUpdate | The request body to send |
| -> m (Response Update_itemResponse) | Monadic computation which returns the result of the operation |
PUT /items/{item_id}The same as update_item but accepts an explicit configuration.
Arguments
| :: forall m. MonadHTTP m | |
| => Text | item_id: Item ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-red`. |
| -> ItemUpdate | The request body to send |
| -> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
PUT /items/{item_id}The same as update_item but returns the raw ByteString.
update_itemWithConfigurationRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | item_id: Item ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-red`. |
| -> ItemUpdate | The request body to send |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
PUT /items/{item_id}The same as update_item but accepts an explicit configuration and returns the raw ByteString.