| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.List_external_invoices
Description
Contains the different functions to run the operation list_external_invoices
Synopsis
- list_external_invoices :: forall m. MonadHTTP m => List_external_invoicesParameters -> ClientT m (Response List_external_invoicesResponse)
- data List_external_invoicesParameters = List_external_invoicesParameters {}
- mkList_external_invoicesParameters :: List_external_invoicesParameters
- data List_external_invoicesParametersQueryOrder
- data List_external_invoicesParametersQuerySort
- data List_external_invoicesResponse
- list_external_invoicesWithConfiguration :: forall m. MonadHTTP m => Configuration -> List_external_invoicesParameters -> m (Response List_external_invoicesResponse)
- list_external_invoicesRaw :: forall m. MonadHTTP m => List_external_invoicesParameters -> ClientT m (Response ByteString)
- list_external_invoicesWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> List_external_invoicesParameters -> m (Response ByteString)
Documentation
list_external_invoices Source #
Arguments
| :: forall m. MonadHTTP m | |
| => List_external_invoicesParameters | Contains all available parameters of this operation (query and path parameters) |
| -> ClientT m (Response List_external_invoicesResponse) | Monadic computation which returns the result of the operation |
GET /external_invoices
See the Pagination Guide to learn how to use pagination in the API and Client Libraries.
data List_external_invoicesParameters Source #
Defines the object schema located at paths./external_invoices.GET.parameters in the specification.
Constructors
| List_external_invoicesParameters | |
Fields
| |
Instances
mkList_external_invoicesParameters :: List_external_invoicesParameters Source #
Create a new List_external_invoicesParameters with all required fields.
data List_external_invoicesParametersQueryOrder Source #
Defines the enum schema located at paths./external_invoices.GET.parameters.properties.queryOrder in the specification.
Represents the parameter named 'order'
Sort order.
Constructors
| List_external_invoicesParametersQueryOrderOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| List_external_invoicesParametersQueryOrderTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| List_external_invoicesParametersQueryOrderEnumAsc | Represents the JSON value |
| List_external_invoicesParametersQueryOrderEnumDesc | Represents the JSON value |
data List_external_invoicesParametersQuerySort Source #
Defines the enum schema located at paths./external_invoices.GET.parameters.properties.querySort in the specification.
Represents the parameter named 'sort'
Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
Constructors
| List_external_invoicesParametersQuerySortOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| List_external_invoicesParametersQuerySortTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| List_external_invoicesParametersQuerySortEnumCreated_at | Represents the JSON value |
| List_external_invoicesParametersQuerySortEnumUpdated_at | Represents the JSON value |
data List_external_invoicesResponse Source #
Represents a response of the operation list_external_invoices.
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), List_external_invoicesResponseError is used.
Constructors
| List_external_invoicesResponseError String | Means either no matching case available or a parse error |
| List_external_invoicesResponse200 ExternalInvoiceList | A list of the the external_invoices on a site. |
| List_external_invoicesResponse404 Error | Incorrect site. |
| List_external_invoicesResponseDefault Error | Unexpected error. |
Instances
list_external_invoicesWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> List_external_invoicesParameters | Contains all available parameters of this operation (query and path parameters) |
| -> m (Response List_external_invoicesResponse) | Monadic computation which returns the result of the operation |
GET /external_invoices
The same as list_external_invoices but accepts an explicit configuration.
list_external_invoicesRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => List_external_invoicesParameters | Contains all available parameters of this operation (query and path parameters) |
| -> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /external_invoices
The same as list_external_invoices but returns the raw ByteString.
list_external_invoicesWithConfigurationRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> List_external_invoicesParameters | Contains all available parameters of this operation (query and path parameters) |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /external_invoices
The same as list_external_invoices but accepts an explicit configuration and returns the raw ByteString.