Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
RecurlyClient.Operations.List_invoice_template_accounts
Description
Contains the different functions to run the operation list_invoice_template_accounts
Synopsis
- list_invoice_template_accounts :: forall m. MonadHTTP m => List_invoice_template_accountsParameters -> ClientT m (Response List_invoice_template_accountsResponse)
- data List_invoice_template_accountsParameters = List_invoice_template_accountsParameters {
- list_invoice_template_accountsParametersPathInvoice_template_id :: Text
- list_invoice_template_accountsParametersQueryBegin_time :: Maybe JsonDateTime
- list_invoice_template_accountsParametersQueryEmail :: Maybe Text
- list_invoice_template_accountsParametersQueryEnd_time :: Maybe JsonDateTime
- list_invoice_template_accountsParametersQueryIds :: Maybe [Text]
- list_invoice_template_accountsParametersQueryLimit :: Maybe Int
- list_invoice_template_accountsParametersQueryOrder :: Maybe List_invoice_template_accountsParametersQueryOrder
- list_invoice_template_accountsParametersQueryPast_due :: Maybe List_invoice_template_accountsParametersQueryPast_due
- list_invoice_template_accountsParametersQuerySort :: Maybe List_invoice_template_accountsParametersQuerySort
- list_invoice_template_accountsParametersQuerySubscriber :: Maybe Bool
- mkList_invoice_template_accountsParameters :: Text -> List_invoice_template_accountsParameters
- data List_invoice_template_accountsParametersQueryOrder
- data List_invoice_template_accountsParametersQueryPast_due
- data List_invoice_template_accountsParametersQuerySort
- data List_invoice_template_accountsResponse
- list_invoice_template_accountsWithConfiguration :: forall m. MonadHTTP m => Configuration -> List_invoice_template_accountsParameters -> m (Response List_invoice_template_accountsResponse)
- list_invoice_template_accountsRaw :: forall m. MonadHTTP m => List_invoice_template_accountsParameters -> ClientT m (Response ByteString)
- list_invoice_template_accountsWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> List_invoice_template_accountsParameters -> m (Response ByteString)
Documentation
list_invoice_template_accounts Source #
Arguments
:: forall m. MonadHTTP m | |
=> List_invoice_template_accountsParameters | Contains all available parameters of this operation (query and path parameters) |
-> ClientT m (Response List_invoice_template_accountsResponse) | Monadic computation which returns the result of the operation |
GET /invoice_templates/{invoice_template_id}/accounts
See the Pagination Guide to learn how to use pagination in the API and Client Libraries.
data List_invoice_template_accountsParameters Source #
Defines the object schema located at paths./invoice_templates/{invoice_template_id}/accounts.GET.parameters
in the specification.
Constructors
List_invoice_template_accountsParameters | |
Fields
|
Instances
mkList_invoice_template_accountsParameters Source #
Arguments
:: Text |
|
-> List_invoice_template_accountsParameters |
Create a new List_invoice_template_accountsParameters
with all required fields.
data List_invoice_template_accountsParametersQueryOrder Source #
Defines the enum schema located at paths./invoice_templates/{invoice_template_id}/accounts.GET.parameters.properties.queryOrder
in the specification.
Represents the parameter named 'order'
Sort order.
Constructors
List_invoice_template_accountsParametersQueryOrderOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
List_invoice_template_accountsParametersQueryOrderTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
List_invoice_template_accountsParametersQueryOrderEnumAsc | Represents the JSON value |
List_invoice_template_accountsParametersQueryOrderEnumDesc | Represents the JSON value |
Instances
data List_invoice_template_accountsParametersQueryPast_due Source #
Defines the enum schema located at paths./invoice_templates/{invoice_template_id}/accounts.GET.parameters.properties.queryPast_due
in the specification.
Represents the parameter named 'past_due'
Filter for accounts with an invoice in the `past_due` state.
Constructors
List_invoice_template_accountsParametersQueryPast_dueOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
List_invoice_template_accountsParametersQueryPast_dueTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
List_invoice_template_accountsParametersQueryPast_dueEnumTrue | Represents the JSON value |
Instances
data List_invoice_template_accountsParametersQuerySort Source #
Defines the enum schema located at paths./invoice_templates/{invoice_template_id}/accounts.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_invoice_template_accountsParametersQuerySortOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
List_invoice_template_accountsParametersQuerySortTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
List_invoice_template_accountsParametersQuerySortEnumCreated_at | Represents the JSON value |
List_invoice_template_accountsParametersQuerySortEnumUpdated_at | Represents the JSON value |
Instances
data List_invoice_template_accountsResponse Source #
Represents a response of the operation list_invoice_template_accounts
.
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_invoice_template_accountsResponseError
is used.
Constructors
List_invoice_template_accountsResponseError String | Means either no matching case available or a parse error |
List_invoice_template_accountsResponse200 AccountList | A list of an invoice template's associated accounts. |
List_invoice_template_accountsResponse400 Error | Invalid or unpermitted parameter. |
List_invoice_template_accountsResponse404 Error | Incorrect site or invoice template ID. |
List_invoice_template_accountsResponseDefault Error | Unexpected error. |
list_invoice_template_accountsWithConfiguration Source #
Arguments
:: forall m. MonadHTTP m | |
=> Configuration | The configuration to use in the request |
-> List_invoice_template_accountsParameters | Contains all available parameters of this operation (query and path parameters) |
-> m (Response List_invoice_template_accountsResponse) | Monadic computation which returns the result of the operation |
GET /invoice_templates/{invoice_template_id}/accounts
The same as list_invoice_template_accounts
but accepts an explicit configuration.
list_invoice_template_accountsRaw Source #
Arguments
:: forall m. MonadHTTP m | |
=> List_invoice_template_accountsParameters | 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 /invoice_templates/{invoice_template_id}/accounts
The same as list_invoice_template_accounts
but returns the raw ByteString
.
list_invoice_template_accountsWithConfigurationRaw Source #
Arguments
:: forall m. MonadHTTP m | |
=> Configuration | The configuration to use in the request |
-> List_invoice_template_accountsParameters | Contains all available parameters of this operation (query and path parameters) |
-> m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /invoice_templates/{invoice_template_id}/accounts
The same as list_invoice_template_accounts
but accepts an explicit configuration and returns the raw ByteString
.