Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Mark_invoice_successful

Description

Contains the different functions to run the operation mark_invoice_successful

Synopsis

mark_invoice_successful :: forall m. MonadHTTP m => Text -> ClientT m (Response Mark_invoice_successfulResponse)
data Mark_invoice_successfulResponse
mark_invoice_successfulWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response Mark_invoice_successfulResponse)
mark_invoice_successfulRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
mark_invoice_successfulWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> m (Response ByteString)

Documentation

mark_invoice_successful Source #

Arguments

:: forall m. MonadHTTP m
=> Text	invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
-> ClientT m (Response Mark_invoice_successfulResponse)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/mark_successful

Indicates that the invoice was successfully paid for and that automated collection attempts should stop - this functionality is typically used to indicate that payment was received via another method and that revenue should be recognized.

Only invoices with the `pending`, `processing`, `past_due` or `failed` states can be marked as paid.

data Mark_invoice_successfulResponse Source #

Represents a response of the operation mark_invoice_successful.

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

Constructors

Mark_invoice_successfulResponseError String	Means either no matching case available or a parse error
Mark_invoice_successfulResponse200 Invoice	The updated invoice.
Mark_invoice_successfulResponse404 Error	Incorrect site or invoice ID.
Mark_invoice_successfulResponse422 Error	Tried marking a closed (successful or failed) invoice as successful.
Mark_invoice_successfulResponseDefault Error	Unexpected error.

Instances

Instances details

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

mark_invoice_successfulWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Text	invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
-> m (Response Mark_invoice_successfulResponse)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/mark_successful

The same as mark_invoice_successful but accepts an explicit configuration.

mark_invoice_successfulRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Text	invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
-> ClientT m (Response ByteString)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/mark_successful

The same as mark_invoice_successful but returns the raw ByteString.

mark_invoice_successfulWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Text	invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
-> m (Response ByteString)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/mark_successful

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