Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Get_item

Description

Contains the different functions to run the operation get_item

Synopsis

get_item :: forall m. MonadHTTP m => Text -> ClientT m (Response Get_itemResponse)
data Get_itemResponse
get_itemWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response Get_itemResponse)
get_itemRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
get_itemWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> m (Response ByteString)

Documentation

get_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 Get_itemResponse)	Monadic computation which returns the result of the operation

GET /items/{item_id}

Fetch an item

data Get_itemResponse Source #

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

Constructors

Get_itemResponseError String	Means either no matching case available or a parse error
Get_itemResponse200 Item	An item.
Get_itemResponse404 Error	Incorrect site or item ID.
Get_itemResponseDefault Error	Unexpected error.

Instances

Instances details

Show Get_itemResponse Source #
Instance details Defined in RecurlyClient.Operations.Get_item Methods showsPrec :: Int -> Get_itemResponse -> ShowS # show :: Get_itemResponse -> String # showList :: [Get_itemResponse] -> ShowS #
Eq Get_itemResponse Source #
Instance details Defined in RecurlyClient.Operations.Get_item Methods (==) :: Get_itemResponse -> Get_itemResponse -> Bool # (/=) :: Get_itemResponse -> Get_itemResponse -> Bool #

get_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 Get_itemResponse)	Monadic computation which returns the result of the operation

GET /items/{item_id}

The same as get_item but accepts an explicit configuration.

get_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

GET /items/{item_id}

The same as get_item but returns the raw ByteString.

get_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

GET /items/{item_id}

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