Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Get_plan_add_on

Description

Contains the different functions to run the operation get_plan_add_on

Synopsis

get_plan_add_on :: forall m. MonadHTTP m => Get_plan_add_onParameters -> ClientT m (Response Get_plan_add_onResponse)
data Get_plan_add_onParameters = Get_plan_add_onParameters {
- get_plan_add_onParametersPathAdd_on_id :: Text
- get_plan_add_onParametersPathPlan_id :: Text
}
mkGet_plan_add_onParameters :: Text -> Text -> Get_plan_add_onParameters
data Get_plan_add_onResponse
get_plan_add_onWithConfiguration :: forall m. MonadHTTP m => Configuration -> Get_plan_add_onParameters -> m (Response Get_plan_add_onResponse)
get_plan_add_onRaw :: forall m. MonadHTTP m => Get_plan_add_onParameters -> ClientT m (Response ByteString)
get_plan_add_onWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Get_plan_add_onParameters -> m (Response ByteString)

Documentation

get_plan_add_on Source #

Arguments

:: forall m. MonadHTTP m
=> Get_plan_add_onParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response Get_plan_add_onResponse)	Monadic computation which returns the result of the operation

GET /plans/{plan_id}/add_ons/{add_on_id}

Fetch a plan's add-on

data Get_plan_add_onParameters Source #

Defines the object schema located at paths./plans/{plan_id}/add_ons/{add_on_id}.GET.parameters in the specification.

Constructors

Get_plan_add_onParameters

Fields

get_plan_add_onParametersPathAdd_on_id :: Text
pathAdd_on_id: Represents the parameter named 'add_on_id'
Add-on ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-gold`.
get_plan_add_onParametersPathPlan_id :: Text
pathPlan_id: Represents the parameter named 'plan_id'
Plan ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-gold`.

Instances

Instances details

FromJSON Get_plan_add_onParameters Source #
Instance details Defined in RecurlyClient.Operations.Get_plan_add_on Methods parseJSON :: Value -> Parser Get_plan_add_onParameters # parseJSONList :: Value -> Parser [Get_plan_add_onParameters] #
ToJSON Get_plan_add_onParameters Source #
Instance details Defined in RecurlyClient.Operations.Get_plan_add_on Methods toJSON :: Get_plan_add_onParameters -> Value # toEncoding :: Get_plan_add_onParameters -> Encoding # toJSONList :: [Get_plan_add_onParameters] -> Value # toEncodingList :: [Get_plan_add_onParameters] -> Encoding #
Show Get_plan_add_onParameters Source #
Instance details Defined in RecurlyClient.Operations.Get_plan_add_on Methods showsPrec :: Int -> Get_plan_add_onParameters -> ShowS # show :: Get_plan_add_onParameters -> String # showList :: [Get_plan_add_onParameters] -> ShowS #
Eq Get_plan_add_onParameters Source #
Instance details Defined in RecurlyClient.Operations.Get_plan_add_on Methods (==) :: Get_plan_add_onParameters -> Get_plan_add_onParameters -> Bool # (/=) :: Get_plan_add_onParameters -> Get_plan_add_onParameters -> Bool #

mkGet_plan_add_onParameters Source #

Arguments

:: Text	`get_plan_add_onParametersPathAdd_on_id`
-> Text	`get_plan_add_onParametersPathPlan_id`
-> Get_plan_add_onParameters

Create a new Get_plan_add_onParameters with all required fields.

data Get_plan_add_onResponse Source #

Represents a response of the operation get_plan_add_on.

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_plan_add_onResponseError is used.

Constructors

Get_plan_add_onResponseError String	Means either no matching case available or a parse error
Get_plan_add_onResponse200 AddOn	An add-on.
Get_plan_add_onResponse404 Error	Incorrect site, plan or add-on ID.
Get_plan_add_onResponseDefault Error	Unexpected error.

Instances

Instances details

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

get_plan_add_onWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Get_plan_add_onParameters	Contains all available parameters of this operation (query and path parameters)
-> m (Response Get_plan_add_onResponse)	Monadic computation which returns the result of the operation

GET /plans/{plan_id}/add_ons/{add_on_id}

The same as get_plan_add_on but accepts an explicit configuration.

get_plan_add_onRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Get_plan_add_onParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response ByteString)	Monadic computation which returns the result of the operation

GET /plans/{plan_id}/add_ons/{add_on_id}

The same as get_plan_add_on but returns the raw ByteString.

get_plan_add_onWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Get_plan_add_onParameters	Contains all available parameters of this operation (query and path parameters)
-> m (Response ByteString)	Monadic computation which returns the result of the operation

GET /plans/{plan_id}/add_ons/{add_on_id}

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