recurly-client-0.1.0.0: Client for Recurly subscription management
Safe HaskellSafe-Inferred
LanguageHaskell2010

RecurlyClient.Operations.Deactivate_item

Description

Contains the different functions to run the operation deactivate_item

Synopsis

Documentation

deactivate_item Source #

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`.

-> ClientT m (Response Deactivate_itemResponse)

Monadic computation which returns the result of the operation

DELETE /items/{item_id}

Deactivating an item makes it unavailable for new purchases. It will not affect existing line items.

data Deactivate_itemResponse Source #

Represents a response of the operation deactivate_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), Deactivate_itemResponseError is used.

Constructors

Deactivate_itemResponseError String

Means either no matching case available or a parse error

Deactivate_itemResponse200 Item

An item.

Deactivate_itemResponse422 Error

Item may already be inactive.

Deactivate_itemResponseDefault Error

Unexpected error.

deactivate_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`.

-> m (Response Deactivate_itemResponse)

Monadic computation which returns the result of the operation

DELETE /items/{item_id}

The same as deactivate_item but accepts an explicit configuration.

deactivate_itemRaw Source #

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`.

-> ClientT m (Response ByteString)

Monadic computation which returns the result of the operation

DELETE /items/{item_id}

The same as deactivate_item but returns the raw ByteString.

deactivate_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`.

-> m (Response ByteString)

Monadic computation which returns the result of the operation

DELETE /items/{item_id}

The same as deactivate_item but accepts an explicit configuration and returns the raw ByteString.