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

RecurlyClient.Operations.List_invoices

Description

Contains the different functions to run the operation list_invoices

Synopsis

Documentation

list_invoices Source #

Arguments

:: forall m. MonadHTTP m 
=> List_invoicesParameters

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

-> ClientT m (Response List_invoicesResponse)

Monadic computation which returns the result of the operation

GET /invoices

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

data List_invoicesParameters Source #

Defines the object schema located at paths./invoices.GET.parameters in the specification.

Constructors

List_invoicesParameters 

Fields

  • list_invoicesParametersQueryBegin_time :: Maybe JsonDateTime

    queryBegin_time: Represents the parameter named 'begin_time'

    Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

  • list_invoicesParametersQueryEnd_time :: Maybe JsonDateTime

    queryEnd_time: Represents the parameter named 'end_time'

    Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

  • list_invoicesParametersQueryIds :: Maybe [Text]

    queryIds: Represents the parameter named 'ids'

    Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.

    • *Important notes:**
    • The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
    • Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request.
    • Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.
  • list_invoicesParametersQueryLimit :: Maybe Int

    queryLimit: Represents the parameter named 'limit'

    Limit number of records 1-200.

    Constraints:

    • Maxium of 200.0
    • Minimum of 1.0
  • list_invoicesParametersQueryOrder :: Maybe List_invoicesParametersQueryOrder

    queryOrder: Represents the parameter named 'order'

    Sort order.

  • list_invoicesParametersQuerySort :: Maybe List_invoicesParametersQuerySort

    querySort: 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.

  • list_invoicesParametersQueryState :: Maybe List_invoicesParametersQueryState

    queryState: Represents the parameter named 'state'

    Invoice state.

  • list_invoicesParametersQueryType :: Maybe List_invoicesParametersQueryType

    queryType: Represents the parameter named 'type'

    Filter by type when: - `type=charge`, only charge invoices will be returned. - `type=credit`, only credit invoices will be returned. - `type=non-legacy`, only charge and credit invoices will be returned. - `type=legacy`, only legacy invoices will be returned.

Instances

Instances details
FromJSON List_invoicesParameters Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

parseJSON :: Value -> Parser List_invoicesParameters #

parseJSONList :: Value -> Parser [List_invoicesParameters] #

ToJSON List_invoicesParameters Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

toJSON :: List_invoicesParameters -> Value #

toEncoding :: List_invoicesParameters -> Encoding #

toJSONList :: [List_invoicesParameters] -> Value #

toEncodingList :: [List_invoicesParameters] -> Encoding #

Show List_invoicesParameters Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

showsPrec :: Int -> List_invoicesParameters -> ShowS #

show :: List_invoicesParameters -> String #

showList :: [List_invoicesParameters] -> ShowS #

Eq List_invoicesParameters Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

(==) :: List_invoicesParameters -> List_invoicesParameters -> Bool #

(/=) :: List_invoicesParameters -> List_invoicesParameters -> Bool #

mkList_invoicesParameters :: List_invoicesParameters Source #

Create a new List_invoicesParameters with all required fields.

data List_invoicesParametersQueryOrder Source #

Defines the enum schema located at paths./invoices.GET.parameters.properties.queryOrder in the specification.

Represents the parameter named 'order'

Sort order.

Constructors

List_invoicesParametersQueryOrderOther Value

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

List_invoicesParametersQueryOrderTyped Text

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

List_invoicesParametersQueryOrderEnumAsc

Represents the JSON value "asc"

List_invoicesParametersQueryOrderEnumDesc

Represents the JSON value "desc"

Instances

Instances details
FromJSON List_invoicesParametersQueryOrder Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

parseJSON :: Value -> Parser List_invoicesParametersQueryOrder #

parseJSONList :: Value -> Parser [List_invoicesParametersQueryOrder] #

ToJSON List_invoicesParametersQueryOrder Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

toJSON :: List_invoicesParametersQueryOrder -> Value #

toEncoding :: List_invoicesParametersQueryOrder -> Encoding #

toJSONList :: [List_invoicesParametersQueryOrder] -> Value #

toEncodingList :: [List_invoicesParametersQueryOrder] -> Encoding #

Show List_invoicesParametersQueryOrder Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

showsPrec :: Int -> List_invoicesParametersQueryOrder -> ShowS #

show :: List_invoicesParametersQueryOrder -> String #

showList :: [List_invoicesParametersQueryOrder] -> ShowS #

Eq List_invoicesParametersQueryOrder Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

(==) :: List_invoicesParametersQueryOrder -> List_invoicesParametersQueryOrder -> Bool #

(/=) :: List_invoicesParametersQueryOrder -> List_invoicesParametersQueryOrder -> Bool #

data List_invoicesParametersQuerySort Source #

Defines the enum schema located at paths./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_invoicesParametersQuerySortOther Value

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

List_invoicesParametersQuerySortTyped Text

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

List_invoicesParametersQuerySortEnumCreated_at

Represents the JSON value "created_at"

List_invoicesParametersQuerySortEnumUpdated_at

Represents the JSON value "updated_at"

Instances

Instances details
FromJSON List_invoicesParametersQuerySort Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

parseJSON :: Value -> Parser List_invoicesParametersQuerySort #

parseJSONList :: Value -> Parser [List_invoicesParametersQuerySort] #

ToJSON List_invoicesParametersQuerySort Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

toJSON :: List_invoicesParametersQuerySort -> Value #

toEncoding :: List_invoicesParametersQuerySort -> Encoding #

toJSONList :: [List_invoicesParametersQuerySort] -> Value #

toEncodingList :: [List_invoicesParametersQuerySort] -> Encoding #

Show List_invoicesParametersQuerySort Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

showsPrec :: Int -> List_invoicesParametersQuerySort -> ShowS #

show :: List_invoicesParametersQuerySort -> String #

showList :: [List_invoicesParametersQuerySort] -> ShowS #

Eq List_invoicesParametersQuerySort Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

(==) :: List_invoicesParametersQuerySort -> List_invoicesParametersQuerySort -> Bool #

(/=) :: List_invoicesParametersQuerySort -> List_invoicesParametersQuerySort -> Bool #

data List_invoicesParametersQueryState Source #

Defines the enum schema located at paths./invoices.GET.parameters.properties.queryState in the specification.

Represents the parameter named 'state'

Invoice state.

Constructors

List_invoicesParametersQueryStateOther Value

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

List_invoicesParametersQueryStateTyped Text

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

List_invoicesParametersQueryStateEnumPending

Represents the JSON value "pending"

List_invoicesParametersQueryStateEnumPast_due

Represents the JSON value "past_due"

List_invoicesParametersQueryStateEnumPaid

Represents the JSON value "paid"

List_invoicesParametersQueryStateEnumFailed

Represents the JSON value "failed"

Instances

Instances details
FromJSON List_invoicesParametersQueryState Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

parseJSON :: Value -> Parser List_invoicesParametersQueryState #

parseJSONList :: Value -> Parser [List_invoicesParametersQueryState] #

ToJSON List_invoicesParametersQueryState Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

toJSON :: List_invoicesParametersQueryState -> Value #

toEncoding :: List_invoicesParametersQueryState -> Encoding #

toJSONList :: [List_invoicesParametersQueryState] -> Value #

toEncodingList :: [List_invoicesParametersQueryState] -> Encoding #

Show List_invoicesParametersQueryState Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

showsPrec :: Int -> List_invoicesParametersQueryState -> ShowS #

show :: List_invoicesParametersQueryState -> String #

showList :: [List_invoicesParametersQueryState] -> ShowS #

Eq List_invoicesParametersQueryState Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

(==) :: List_invoicesParametersQueryState -> List_invoicesParametersQueryState -> Bool #

(/=) :: List_invoicesParametersQueryState -> List_invoicesParametersQueryState -> Bool #

data List_invoicesParametersQueryType Source #

Defines the enum schema located at paths./invoices.GET.parameters.properties.queryType in the specification.

Represents the parameter named 'type'

Filter by type when: - `type=charge`, only charge invoices will be returned. - `type=credit`, only credit invoices will be returned. - `type=non-legacy`, only charge and credit invoices will be returned. - `type=legacy`, only legacy invoices will be returned.

Constructors

List_invoicesParametersQueryTypeOther Value

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

List_invoicesParametersQueryTypeTyped Text

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

List_invoicesParametersQueryTypeEnumCharge

Represents the JSON value "charge"

List_invoicesParametersQueryTypeEnumCredit

Represents the JSON value "credit"

List_invoicesParametersQueryTypeEnumLegacy

Represents the JSON value "legacy"

List_invoicesParametersQueryTypeEnumNon_legacy

Represents the JSON value "non-legacy"

Instances

Instances details
FromJSON List_invoicesParametersQueryType Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

parseJSON :: Value -> Parser List_invoicesParametersQueryType #

parseJSONList :: Value -> Parser [List_invoicesParametersQueryType] #

ToJSON List_invoicesParametersQueryType Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

toJSON :: List_invoicesParametersQueryType -> Value #

toEncoding :: List_invoicesParametersQueryType -> Encoding #

toJSONList :: [List_invoicesParametersQueryType] -> Value #

toEncodingList :: [List_invoicesParametersQueryType] -> Encoding #

Show List_invoicesParametersQueryType Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

showsPrec :: Int -> List_invoicesParametersQueryType -> ShowS #

show :: List_invoicesParametersQueryType -> String #

showList :: [List_invoicesParametersQueryType] -> ShowS #

Eq List_invoicesParametersQueryType Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

(==) :: List_invoicesParametersQueryType -> List_invoicesParametersQueryType -> Bool #

(/=) :: List_invoicesParametersQueryType -> List_invoicesParametersQueryType -> Bool #

data List_invoicesResponse Source #

Represents a response of the operation list_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_invoicesResponseError is used.

Constructors

List_invoicesResponseError String

Means either no matching case available or a parse error

List_invoicesResponse200 InvoiceList

A list of the site's invoices.

List_invoicesResponse400 Error

Invalid or unpermitted parameter.

List_invoicesResponse404 Error

Incorrect site ID.

List_invoicesResponseDefault Error

Unexpected error.

Instances

Instances details
Show List_invoicesResponse Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

showsPrec :: Int -> List_invoicesResponse -> ShowS #

show :: List_invoicesResponse -> String #

showList :: [List_invoicesResponse] -> ShowS #

Eq List_invoicesResponse Source # 
Instance details

Defined in RecurlyClient.Operations.List_invoices

Methods

(==) :: List_invoicesResponse -> List_invoicesResponse -> Bool #

(/=) :: List_invoicesResponse -> List_invoicesResponse -> Bool #

list_invoicesWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_invoicesParameters

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

-> m (Response List_invoicesResponse)

Monadic computation which returns the result of the operation

GET /invoices

The same as list_invoices but accepts an explicit configuration.

list_invoicesRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> List_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 /invoices

The same as list_invoices but returns the raw ByteString.

list_invoicesWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_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 /invoices

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