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

RecurlyClient.Operations.List_account_line_items

Description

Contains the different functions to run the operation list_account_line_items

Synopsis

Documentation

list_account_line_items Source #

Arguments

:: forall m. MonadHTTP m 
=> List_account_line_itemsParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response List_account_line_itemsResponse)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/line_items

See the Pagination Guide to learn how to use pagination in the API and Client Libraries.

data List_account_line_itemsParameters Source #

Defines the object schema located at paths./accounts/{account_id}/line_items.GET.parameters in the specification.

Constructors

List_account_line_itemsParameters 

Fields

data List_account_line_itemsParametersQueryOrder Source #

Defines the enum schema located at paths./accounts/{account_id}/line_items.GET.parameters.properties.queryOrder in the specification.

Represents the parameter named 'order'

Sort order.

Constructors

List_account_line_itemsParametersQueryOrderOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

List_account_line_itemsParametersQueryOrderTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

List_account_line_itemsParametersQueryOrderEnumAsc

Represents the JSON value "asc"

List_account_line_itemsParametersQueryOrderEnumDesc

Represents the JSON value "desc"

data List_account_line_itemsParametersQueryOriginal Source #

Defines the enum schema located at paths./accounts/{account_id}/line_items.GET.parameters.properties.queryOriginal in the specification.

Represents the parameter named 'original'

Filter by original field.

Constructors

List_account_line_itemsParametersQueryOriginalOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

List_account_line_itemsParametersQueryOriginalTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

List_account_line_itemsParametersQueryOriginalEnumTrue

Represents the JSON value true

Instances

Instances details
FromJSON List_account_line_itemsParametersQueryOriginal Source # 
Instance details

Defined in RecurlyClient.Operations.List_account_line_items

ToJSON List_account_line_itemsParametersQueryOriginal Source # 
Instance details

Defined in RecurlyClient.Operations.List_account_line_items

Show List_account_line_itemsParametersQueryOriginal Source # 
Instance details

Defined in RecurlyClient.Operations.List_account_line_items

Eq List_account_line_itemsParametersQueryOriginal Source # 
Instance details

Defined in RecurlyClient.Operations.List_account_line_items

data List_account_line_itemsParametersQuerySort Source #

Defines the enum schema located at paths./accounts/{account_id}/line_items.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_account_line_itemsParametersQuerySortOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

List_account_line_itemsParametersQuerySortTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

List_account_line_itemsParametersQuerySortEnumCreated_at

Represents the JSON value "created_at"

List_account_line_itemsParametersQuerySortEnumUpdated_at

Represents the JSON value "updated_at"

data List_account_line_itemsParametersQueryState Source #

Defines the enum schema located at paths./accounts/{account_id}/line_items.GET.parameters.properties.queryState in the specification.

Represents the parameter named 'state'

Filter by state field.

Constructors

List_account_line_itemsParametersQueryStateOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

List_account_line_itemsParametersQueryStateTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

List_account_line_itemsParametersQueryStateEnumInvoiced

Represents the JSON value "invoiced"

List_account_line_itemsParametersQueryStateEnumPending

Represents the JSON value "pending"

data List_account_line_itemsParametersQueryType Source #

Defines the enum schema located at paths./accounts/{account_id}/line_items.GET.parameters.properties.queryType in the specification.

Represents the parameter named 'type'

Filter by type field.

Constructors

List_account_line_itemsParametersQueryTypeOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

List_account_line_itemsParametersQueryTypeTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

List_account_line_itemsParametersQueryTypeEnumCharge

Represents the JSON value "charge"

List_account_line_itemsParametersQueryTypeEnumCredit

Represents the JSON value "credit"

data List_account_line_itemsResponse Source #

Represents a response of the operation list_account_line_items.

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_account_line_itemsResponseError is used.

Constructors

List_account_line_itemsResponseError String

Means either no matching case available or a parse error

List_account_line_itemsResponse200 LineItemList

A list of the account's line items.

List_account_line_itemsResponse400 Error

Invalid or unpermitted parameter.

List_account_line_itemsResponse404 Error

Incorrect site ID.

List_account_line_itemsResponseDefault Error

Unexpected error.

list_account_line_itemsWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_account_line_itemsParameters

Contains all available parameters of this operation (query and path parameters)

-> m (Response List_account_line_itemsResponse)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/line_items

The same as list_account_line_items but accepts an explicit configuration.

list_account_line_itemsRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> List_account_line_itemsParameters

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 /accounts/{account_id}/line_items

The same as list_account_line_items but returns the raw ByteString.

list_account_line_itemsWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_account_line_itemsParameters

Contains all available parameters of this operation (query and path parameters)

-> m (Response ByteString)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/line_items

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