Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Apply_credit_balance

Description

Contains the different functions to run the operation apply_credit_balance

Synopsis

apply_credit_balance :: forall m. MonadHTTP m => Apply_credit_balanceParameters -> ClientT m (Response Apply_credit_balanceResponse)
data Apply_credit_balanceParameters = Apply_credit_balanceParameters {
- apply_credit_balanceParametersPathInvoice_id :: Text
- apply_credit_balanceParametersPathSite_id :: Text
}
mkApply_credit_balanceParameters :: Text -> Text -> Apply_credit_balanceParameters
data Apply_credit_balanceResponse
apply_credit_balanceWithConfiguration :: forall m. MonadHTTP m => Configuration -> Apply_credit_balanceParameters -> m (Response Apply_credit_balanceResponse)
apply_credit_balanceRaw :: forall m. MonadHTTP m => Apply_credit_balanceParameters -> ClientT m (Response ByteString)
apply_credit_balanceWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Apply_credit_balanceParameters -> m (Response ByteString)

Documentation

apply_credit_balance Source #

Arguments

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

PUT /invoices/{invoice_id}/apply_credit_balance

Apply credit payment to the outstanding balance on an existing charge invoice from an account’s available balance from existing credit invoices.

data Apply_credit_balanceParameters Source #

Defines the object schema located at paths./invoices/{invoice_id}/apply_credit_balance.PUT.parameters in the specification.

Constructors

Apply_credit_balanceParameters

Fields

apply_credit_balanceParametersPathInvoice_id :: Text
pathInvoice_id: Represents the parameter named 'invoice_id'
Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
apply_credit_balanceParametersPathSite_id :: Text
pathSite_id: Represents the parameter named 'site_id'
Site ID or subdomain. For ID no prefix is used e.g. `e28zov4fw0v2`. For subdomain use prefix `subdomain-`, e.g. `subdomain-recurly`.

Instances

Instances details

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

mkApply_credit_balanceParameters Source #

Arguments

:: Text	`apply_credit_balanceParametersPathInvoice_id`
-> Text	`apply_credit_balanceParametersPathSite_id`
-> Apply_credit_balanceParameters

Create a new Apply_credit_balanceParameters with all required fields.

data Apply_credit_balanceResponse Source #

Represents a response of the operation apply_credit_balance.

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), Apply_credit_balanceResponseError is used.

Constructors

Apply_credit_balanceResponseError String	Means either no matching case available or a parse error
Apply_credit_balanceResponse200 Invoice	The updated invoice.
Apply_credit_balanceResponse404 Error	Incorrect site or invoice ID.
Apply_credit_balanceResponse422 Error	Tried applying credit to a legacy or closed invoice or there was an error processing the credit payment, such as no available credit on the account.
Apply_credit_balanceResponseDefault Error	Unexpected error.

Instances

Instances details

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

apply_credit_balanceWithConfiguration Source #

Arguments

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

PUT /invoices/{invoice_id}/apply_credit_balance

The same as apply_credit_balance but accepts an explicit configuration.

apply_credit_balanceRaw Source #

Arguments

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

PUT /invoices/{invoice_id}/apply_credit_balance

The same as apply_credit_balance but returns the raw ByteString.

apply_credit_balanceWithConfigurationRaw Source #

Arguments

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

PUT /invoices/{invoice_id}/apply_credit_balance

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