recurly-client-0.1.0.0: Client for Recurly subscription management
Safe HaskellSafe-Inferred
LanguageHaskell2010

RecurlyClient.Operations.List_invoice_template_accounts

Description

Contains the different functions to run the operation list_invoice_template_accounts

Synopsis

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

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 "asc"

List_invoice_template_accountsParametersQueryOrderEnumDesc

Represents the JSON value "desc"

Instances

Instances details
FromJSON List_invoice_template_accountsParametersQueryOrder Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

ToJSON List_invoice_template_accountsParametersQueryOrder Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

Show List_invoice_template_accountsParametersQueryOrder Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

Eq List_invoice_template_accountsParametersQueryOrder Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

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 true

Instances

Instances details
FromJSON List_invoice_template_accountsParametersQueryPast_due Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

ToJSON List_invoice_template_accountsParametersQueryPast_due Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

Show List_invoice_template_accountsParametersQueryPast_due Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

Eq List_invoice_template_accountsParametersQueryPast_due Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

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 "created_at"

List_invoice_template_accountsParametersQuerySortEnumUpdated_at

Represents the JSON value "updated_at"

Instances

Instances details
FromJSON List_invoice_template_accountsParametersQuerySort Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

ToJSON List_invoice_template_accountsParametersQuerySort Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

Show List_invoice_template_accountsParametersQuerySort Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

Eq List_invoice_template_accountsParametersQuerySort Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoice_template_accounts

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.