Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Void_invoice

Description

Contains the different functions to run the operation void_invoice

Synopsis

void_invoice :: forall m. MonadHTTP m => Text -> ClientT m (Response Void_invoiceResponse)
data Void_invoiceResponse
void_invoiceWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response Void_invoiceResponse)
void_invoiceRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
void_invoiceWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> m (Response ByteString)

Documentation

void_invoice 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 Void_invoiceResponse)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/void

Invoice must be a credit invoice (`type=credit`) and cannot be closed (`state=closed`), processing (`state=processing`), or already voided.

data Void_invoiceResponse Source #

Represents a response of the operation void_invoice.

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

Constructors

Void_invoiceResponseError String	Means either no matching case available or a parse error
Void_invoiceResponse200 Invoice	The updated invoice.
Void_invoiceResponse404 Error	Incorrect site or invoice ID.
Void_invoiceResponse422 Error	Invoice did not meet the conditions to be voided.
Void_invoiceResponseDefault Error	Unexpected error.

Instances

Instances details

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

void_invoiceWithConfiguration 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 Void_invoiceResponse)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/void

The same as void_invoice but accepts an explicit configuration.

void_invoiceRaw 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}/void

The same as void_invoice but returns the raw ByteString.

void_invoiceWithConfigurationRaw 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}/void

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