| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Create_usage
Description
Contains the different functions to run the operation create_usage
Synopsis
- create_usage :: forall m. MonadHTTP m => Create_usageParameters -> UsageCreate -> ClientT m (Response Create_usageResponse)
- data Create_usageParameters = Create_usageParameters {}
- mkCreate_usageParameters :: Text -> Text -> Create_usageParameters
- data Create_usageResponse
- create_usageWithConfiguration :: forall m. MonadHTTP m => Configuration -> Create_usageParameters -> UsageCreate -> m (Response Create_usageResponse)
- create_usageRaw :: forall m. MonadHTTP m => Create_usageParameters -> UsageCreate -> ClientT m (Response ByteString)
- create_usageWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Create_usageParameters -> UsageCreate -> m (Response ByteString)
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => Create_usageParameters | Contains all available parameters of this operation (query and path parameters) |
| -> UsageCreate | The request body to send |
| -> ClientT m (Response Create_usageResponse) | Monadic computation which returns the result of the operation |
POST /subscriptions/{subscription_id}/add_ons/{add_on_id}/usageLog a usage record on this subscription add-on
data Create_usageParameters Source #
Defines the object schema located at paths./subscriptions/{subscription_id}/add_ons/{add_on_id}/usage.POST.parameters in the specification.
Constructors
| Create_usageParameters | |
Fields
| |
Instances
| FromJSON Create_usageParameters Source # | |
Defined in RecurlyClient.Operations.Create_usage Methods parseJSON :: Value -> Parser Create_usageParameters # parseJSONList :: Value -> Parser [Create_usageParameters] # | |
| ToJSON Create_usageParameters Source # | |
Defined in RecurlyClient.Operations.Create_usage Methods toJSON :: Create_usageParameters -> Value # toEncoding :: Create_usageParameters -> Encoding # toJSONList :: [Create_usageParameters] -> Value # | |
| Show Create_usageParameters Source # | |
Defined in RecurlyClient.Operations.Create_usage Methods showsPrec :: Int -> Create_usageParameters -> ShowS # show :: Create_usageParameters -> String # showList :: [Create_usageParameters] -> ShowS # | |
| Eq Create_usageParameters Source # | |
Defined in RecurlyClient.Operations.Create_usage Methods (==) :: Create_usageParameters -> Create_usageParameters -> Bool # (/=) :: Create_usageParameters -> Create_usageParameters -> Bool # | |
mkCreate_usageParameters Source #
Arguments
| :: Text | |
| -> Text | |
| -> Create_usageParameters |
Create a new Create_usageParameters with all required fields.
data Create_usageResponse Source #
Represents a response of the operation create_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), Create_usageResponseError is used.
Constructors
| Create_usageResponseError String | Means either no matching case available or a parse error |
| Create_usageResponse201 Usage | The created usage record. |
| Create_usageResponse400 Error | Invalid or unpermitted parameter. |
| Create_usageResponse404 Error | Incorrect site or subscription ID or add-on id. |
| Create_usageResponse422 Error | A validation error. |
| Create_usageResponseDefault Error | Unexpected error. |
Instances
| Show Create_usageResponse Source # | |
Defined in RecurlyClient.Operations.Create_usage Methods showsPrec :: Int -> Create_usageResponse -> ShowS # show :: Create_usageResponse -> String # showList :: [Create_usageResponse] -> ShowS # | |
| Eq Create_usageResponse Source # | |
Defined in RecurlyClient.Operations.Create_usage Methods (==) :: Create_usageResponse -> Create_usageResponse -> Bool # (/=) :: Create_usageResponse -> Create_usageResponse -> Bool # | |
create_usageWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Create_usageParameters | Contains all available parameters of this operation (query and path parameters) |
| -> UsageCreate | The request body to send |
| -> m (Response Create_usageResponse) | Monadic computation which returns the result of the operation |
POST /subscriptions/{subscription_id}/add_ons/{add_on_id}/usageThe same as create_usage but accepts an explicit configuration.
Arguments
| :: forall m. MonadHTTP m | |
| => Create_usageParameters | Contains all available parameters of this operation (query and path parameters) |
| -> UsageCreate | The request body to send |
| -> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /subscriptions/{subscription_id}/add_ons/{add_on_id}/usageThe same as create_usage but returns the raw ByteString.
create_usageWithConfigurationRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Create_usageParameters | Contains all available parameters of this operation (query and path parameters) |
| -> UsageCreate | The request body to send |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /subscriptions/{subscription_id}/add_ons/{add_on_id}/usageThe same as create_usage but accepts an explicit configuration and returns the raw ByteString.