| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Get_invoice
Description
Contains the different functions to run the operation get_invoice
Synopsis
- get_invoice :: forall m. MonadHTTP m => Text -> ClientT m (Response Get_invoiceResponse)
- data Get_invoiceResponse
- get_invoiceWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response Get_invoiceResponse)
- get_invoiceRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
- get_invoiceWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> m (Response ByteString)
Documentation
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 Get_invoiceResponse) | Monadic computation which returns the result of the operation |
GET /invoices/{invoice_id}Fetch an invoice
data Get_invoiceResponse Source #
Represents a response of the operation get_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), Get_invoiceResponseError is used.
Constructors
| Get_invoiceResponseError String | Means either no matching case available or a parse error |
| Get_invoiceResponse200 Invoice | An invoice. |
| Get_invoiceResponse404 Error | Incorrect site or invoice ID. |
| Get_invoiceResponseDefault Error | Unexpected error. |
Instances
| Show Get_invoiceResponse Source # | |
Defined in RecurlyClient.Operations.Get_invoice Methods showsPrec :: Int -> Get_invoiceResponse -> ShowS # show :: Get_invoiceResponse -> String # showList :: [Get_invoiceResponse] -> ShowS # | |
| Eq Get_invoiceResponse Source # | |
Defined in RecurlyClient.Operations.Get_invoice Methods (==) :: Get_invoiceResponse -> Get_invoiceResponse -> Bool # (/=) :: Get_invoiceResponse -> Get_invoiceResponse -> Bool # | |
get_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 Get_invoiceResponse) | Monadic computation which returns the result of the operation |
GET /invoices/{invoice_id}The same as get_invoice but accepts an explicit configuration.
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 |
GET /invoices/{invoice_id}The same as get_invoice but returns the raw ByteString.
get_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 |
GET /invoices/{invoice_id}The same as get_invoice but accepts an explicit configuration and returns the raw ByteString.