| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Get_usage
Description
Contains the different functions to run the operation get_usage
Synopsis
- get_usage :: forall m. MonadHTTP m => Text -> ClientT m (Response Get_usageResponse)
- data Get_usageResponse
- get_usageWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response Get_usageResponse)
- get_usageRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
- get_usageWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> m (Response ByteString)
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => Text | usage_id: Usage Record ID. |
| -> ClientT m (Response Get_usageResponse) | Monadic computation which returns the result of the operation |
GET /usage/{usage_id}Get a usage record
data Get_usageResponse Source #
Represents a response of the operation get_usage.
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_usageResponseError is used.
Constructors
| Get_usageResponseError String | Means either no matching case available or a parse error |
| Get_usageResponse200 Usage | The usage record. |
| Get_usageResponse400 Error | Invalid or unpermitted parameter. |
| Get_usageResponse404 Error | Incorrect site or subscription, add-on, or usage ID. |
| Get_usageResponseDefault Error | Unexpected error. |
Instances
| Show Get_usageResponse Source # | |
Defined in RecurlyClient.Operations.Get_usage Methods showsPrec :: Int -> Get_usageResponse -> ShowS # show :: Get_usageResponse -> String # showList :: [Get_usageResponse] -> ShowS # | |
| Eq Get_usageResponse Source # | |
Defined in RecurlyClient.Operations.Get_usage Methods (==) :: Get_usageResponse -> Get_usageResponse -> Bool # (/=) :: Get_usageResponse -> Get_usageResponse -> Bool # | |
get_usageWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | usage_id: Usage Record ID. |
| -> m (Response Get_usageResponse) | Monadic computation which returns the result of the operation |
GET /usage/{usage_id}The same as get_usage but accepts an explicit configuration.
Arguments
| :: forall m. MonadHTTP m | |
| => Text | usage_id: Usage Record ID. |
| -> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /usage/{usage_id}The same as get_usage but returns the raw ByteString.
get_usageWithConfigurationRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | usage_id: Usage Record ID. |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /usage/{usage_id}The same as get_usage but accepts an explicit configuration and returns the raw ByteString.