| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Get_plan
Description
Contains the different functions to run the operation get_plan
Synopsis
- get_plan :: forall m. MonadHTTP m => Text -> ClientT m (Response Get_planResponse)
- data Get_planResponse
- get_planWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response Get_planResponse)
- get_planRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
- get_planWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> 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`. |
| -> ClientT m (Response Get_planResponse) | Monadic computation which returns the result of the operation |
GET /plans/{plan_id}Fetch a plan
data Get_planResponse Source #
Represents a response of the operation get_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), Get_planResponseError is used.
Constructors
| Get_planResponseError String | Means either no matching case available or a parse error |
| Get_planResponse200 Plan | A plan. |
| Get_planResponse404 Error | Incorrect site or plan ID. |
| Get_planResponseDefault Error | Unexpected error. |
Instances
| Show Get_planResponse Source # | |
Defined in RecurlyClient.Operations.Get_plan Methods showsPrec :: Int -> Get_planResponse -> ShowS # show :: Get_planResponse -> String # showList :: [Get_planResponse] -> ShowS # | |
| Eq Get_planResponse Source # | |
Defined in RecurlyClient.Operations.Get_plan Methods (==) :: Get_planResponse -> Get_planResponse -> Bool # (/=) :: Get_planResponse -> Get_planResponse -> Bool # | |
get_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`. |
| -> m (Response Get_planResponse) | Monadic computation which returns the result of the operation |
GET /plans/{plan_id}The same as get_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`. |
| -> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /plans/{plan_id}The same as get_plan but returns the raw ByteString.
get_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`. |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /plans/{plan_id}The same as get_plan but accepts an explicit configuration and returns the raw ByteString.