Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Collect_invoice

Description

Contains the different functions to run the operation collect_invoice

Synopsis

collect_invoice :: forall m. MonadHTTP m => Text -> Maybe InvoiceCollect -> ClientT m (Response Collect_invoiceResponse)
data Collect_invoiceResponse
collect_invoiceWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> Maybe InvoiceCollect -> m (Response Collect_invoiceResponse)
collect_invoiceRaw :: forall m. MonadHTTP m => Text -> Maybe InvoiceCollect -> ClientT m (Response ByteString)
collect_invoiceWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> Maybe InvoiceCollect -> m (Response ByteString)

Documentation

collect_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`.
-> Maybe InvoiceCollect	The request body to send
-> ClientT m (Response Collect_invoiceResponse)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/collect

Force a collection attempt using the stored billing information. This will trigger a transaction outside of Recurly's normal retry logic.

data Collect_invoiceResponse Source #

Represents a response of the operation collect_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), Collect_invoiceResponseError is used.

Constructors

Collect_invoiceResponseError String	Means either no matching case available or a parse error
Collect_invoiceResponse200 Invoice	The updated invoice.
Collect_invoiceResponse404 Error	Incorrect site or invoice ID.
Collect_invoiceResponse422 ErrorMayHaveTransaction	Tried collecting a manual or closed invoice, or there was an error processing the transaction.
Collect_invoiceResponseDefault Error	Unexpected error.

Instances

Instances details

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

collect_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`.
-> Maybe InvoiceCollect	The request body to send
-> m (Response Collect_invoiceResponse)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/collect

The same as collect_invoice but accepts an explicit configuration.

collect_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`.
-> Maybe InvoiceCollect	The request body to send
-> ClientT m (Response ByteString)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/collect

The same as collect_invoice but returns the raw ByteString.

collect_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`.
-> Maybe InvoiceCollect	The request body to send
-> m (Response ByteString)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/collect

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