Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.List_account_invoices

Description

Contains the different functions to run the operation list_account_invoices

Synopsis

list_account_invoices :: forall m. MonadHTTP m => List_account_invoicesParameters -> ClientT m (Response List_account_invoicesResponse)
data List_account_invoicesParameters = List_account_invoicesParameters {
}
mkList_account_invoicesParameters :: Text -> List_account_invoicesParameters
data List_account_invoicesParametersQueryOrder
data List_account_invoicesParametersQuerySort
data List_account_invoicesParametersQueryState
data List_account_invoicesParametersQueryType
data List_account_invoicesResponse
list_account_invoicesWithConfiguration :: forall m. MonadHTTP m => Configuration -> List_account_invoicesParameters -> m (Response List_account_invoicesResponse)
list_account_invoicesRaw :: forall m. MonadHTTP m => List_account_invoicesParameters -> ClientT m (Response ByteString)
list_account_invoicesWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> List_account_invoicesParameters -> m (Response ByteString)

Documentation

list_account_invoices Source #

Arguments

:: forall m. MonadHTTP m
=> List_account_invoicesParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response List_account_invoicesResponse)	Monadic computation which returns the result of the operation

GET /accounts/{account_id}/invoices

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

data List_account_invoicesParameters Source #

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

Constructors

List_account_invoicesParameters

Fields

list_account_invoicesParametersPathAccount_id :: Text
pathAccount_id: Represents the parameter named 'account_id'
Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.
list_account_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_account_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_account_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_account_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_account_invoicesParametersQueryOrder :: Maybe List_account_invoicesParametersQueryOrder
queryOrder: Represents the parameter named 'order'
Sort order.
list_account_invoicesParametersQuerySort :: Maybe List_account_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_account_invoicesParametersQueryState :: Maybe List_account_invoicesParametersQueryState
queryState: Represents the parameter named 'state'
Invoice state.
list_account_invoicesParametersQueryType :: Maybe List_account_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_account_invoicesParameters Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods parseJSON :: Value -> Parser List_account_invoicesParameters # parseJSONList :: Value -> Parser [List_account_invoicesParameters] #
ToJSON List_account_invoicesParameters Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods toJSON :: List_account_invoicesParameters -> Value # toEncoding :: List_account_invoicesParameters -> Encoding # toJSONList :: [List_account_invoicesParameters] -> Value # toEncodingList :: [List_account_invoicesParameters] -> Encoding #
Show List_account_invoicesParameters Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods showsPrec :: Int -> List_account_invoicesParameters -> ShowS # show :: List_account_invoicesParameters -> String # showList :: [List_account_invoicesParameters] -> ShowS #
Eq List_account_invoicesParameters Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods (==) :: List_account_invoicesParameters -> List_account_invoicesParameters -> Bool # (/=) :: List_account_invoicesParameters -> List_account_invoicesParameters -> Bool #

mkList_account_invoicesParameters Source #

Arguments

:: Text	`list_account_invoicesParametersPathAccount_id`
-> List_account_invoicesParameters

Create a new List_account_invoicesParameters with all required fields.

data List_account_invoicesParametersQueryOrder Source #

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

Represents the parameter named 'order'

Sort order.

Constructors

List_account_invoicesParametersQueryOrderOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_account_invoicesParametersQueryOrderTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_account_invoicesParametersQueryOrderEnumAsc	Represents the JSON value `"asc"`
List_account_invoicesParametersQueryOrderEnumDesc	Represents the JSON value `"desc"`

Instances

Instances details

FromJSON List_account_invoicesParametersQueryOrder Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods parseJSON :: Value -> Parser List_account_invoicesParametersQueryOrder # parseJSONList :: Value -> Parser [List_account_invoicesParametersQueryOrder] #
ToJSON List_account_invoicesParametersQueryOrder Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods toJSON :: List_account_invoicesParametersQueryOrder -> Value # toEncoding :: List_account_invoicesParametersQueryOrder -> Encoding # toJSONList :: [List_account_invoicesParametersQueryOrder] -> Value # toEncodingList :: [List_account_invoicesParametersQueryOrder] -> Encoding #
Show List_account_invoicesParametersQueryOrder Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods showsPrec :: Int -> List_account_invoicesParametersQueryOrder -> ShowS # show :: List_account_invoicesParametersQueryOrder -> String # showList :: [List_account_invoicesParametersQueryOrder] -> ShowS #
Eq List_account_invoicesParametersQueryOrder Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods (==) :: List_account_invoicesParametersQueryOrder -> List_account_invoicesParametersQueryOrder -> Bool # (/=) :: List_account_invoicesParametersQueryOrder -> List_account_invoicesParametersQueryOrder -> Bool #

data List_account_invoicesParametersQuerySort Source #

Defines the enum schema located at paths./accounts/{account_id}/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_account_invoicesParametersQuerySortOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_account_invoicesParametersQuerySortTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_account_invoicesParametersQuerySortEnumCreated_at	Represents the JSON value `"created_at"`
List_account_invoicesParametersQuerySortEnumUpdated_at	Represents the JSON value `"updated_at"`

Instances

Instances details

FromJSON List_account_invoicesParametersQuerySort Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods parseJSON :: Value -> Parser List_account_invoicesParametersQuerySort # parseJSONList :: Value -> Parser [List_account_invoicesParametersQuerySort] #
ToJSON List_account_invoicesParametersQuerySort Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods toJSON :: List_account_invoicesParametersQuerySort -> Value # toEncoding :: List_account_invoicesParametersQuerySort -> Encoding # toJSONList :: [List_account_invoicesParametersQuerySort] -> Value # toEncodingList :: [List_account_invoicesParametersQuerySort] -> Encoding #
Show List_account_invoicesParametersQuerySort Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods showsPrec :: Int -> List_account_invoicesParametersQuerySort -> ShowS # show :: List_account_invoicesParametersQuerySort -> String # showList :: [List_account_invoicesParametersQuerySort] -> ShowS #
Eq List_account_invoicesParametersQuerySort Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods (==) :: List_account_invoicesParametersQuerySort -> List_account_invoicesParametersQuerySort -> Bool # (/=) :: List_account_invoicesParametersQuerySort -> List_account_invoicesParametersQuerySort -> Bool #

data List_account_invoicesParametersQueryState Source #

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

Represents the parameter named 'state'

Invoice state.

Constructors

List_account_invoicesParametersQueryStateOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_account_invoicesParametersQueryStateTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_account_invoicesParametersQueryStateEnumPending	Represents the JSON value `"pending"`
List_account_invoicesParametersQueryStateEnumPast_due	Represents the JSON value `"past_due"`
List_account_invoicesParametersQueryStateEnumPaid	Represents the JSON value `"paid"`
List_account_invoicesParametersQueryStateEnumFailed	Represents the JSON value `"failed"`

Instances

Instances details

FromJSON List_account_invoicesParametersQueryState Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods parseJSON :: Value -> Parser List_account_invoicesParametersQueryState # parseJSONList :: Value -> Parser [List_account_invoicesParametersQueryState] #
ToJSON List_account_invoicesParametersQueryState Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods toJSON :: List_account_invoicesParametersQueryState -> Value # toEncoding :: List_account_invoicesParametersQueryState -> Encoding # toJSONList :: [List_account_invoicesParametersQueryState] -> Value # toEncodingList :: [List_account_invoicesParametersQueryState] -> Encoding #
Show List_account_invoicesParametersQueryState Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods showsPrec :: Int -> List_account_invoicesParametersQueryState -> ShowS # show :: List_account_invoicesParametersQueryState -> String # showList :: [List_account_invoicesParametersQueryState] -> ShowS #
Eq List_account_invoicesParametersQueryState Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods (==) :: List_account_invoicesParametersQueryState -> List_account_invoicesParametersQueryState -> Bool # (/=) :: List_account_invoicesParametersQueryState -> List_account_invoicesParametersQueryState -> Bool #

data List_account_invoicesParametersQueryType Source #

Defines the enum schema located at paths./accounts/{account_id}/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_account_invoicesParametersQueryTypeOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_account_invoicesParametersQueryTypeTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_account_invoicesParametersQueryTypeEnumCharge	Represents the JSON value `"charge"`
List_account_invoicesParametersQueryTypeEnumCredit	Represents the JSON value `"credit"`
List_account_invoicesParametersQueryTypeEnumLegacy	Represents the JSON value `"legacy"`
List_account_invoicesParametersQueryTypeEnumNon_legacy	Represents the JSON value `"non-legacy"`

Instances

Instances details

FromJSON List_account_invoicesParametersQueryType Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods parseJSON :: Value -> Parser List_account_invoicesParametersQueryType # parseJSONList :: Value -> Parser [List_account_invoicesParametersQueryType] #
ToJSON List_account_invoicesParametersQueryType Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods toJSON :: List_account_invoicesParametersQueryType -> Value # toEncoding :: List_account_invoicesParametersQueryType -> Encoding # toJSONList :: [List_account_invoicesParametersQueryType] -> Value # toEncodingList :: [List_account_invoicesParametersQueryType] -> Encoding #
Show List_account_invoicesParametersQueryType Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods showsPrec :: Int -> List_account_invoicesParametersQueryType -> ShowS # show :: List_account_invoicesParametersQueryType -> String # showList :: [List_account_invoicesParametersQueryType] -> ShowS #
Eq List_account_invoicesParametersQueryType Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods (==) :: List_account_invoicesParametersQueryType -> List_account_invoicesParametersQueryType -> Bool # (/=) :: List_account_invoicesParametersQueryType -> List_account_invoicesParametersQueryType -> Bool #

data List_account_invoicesResponse Source #

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

Constructors

List_account_invoicesResponseError String	Means either no matching case available or a parse error
List_account_invoicesResponse200 InvoiceList	A list of the account's invoices.
List_account_invoicesResponse400 Error	Invalid or unpermitted parameter.
List_account_invoicesResponse404 Error	Incorrect site or account ID.
List_account_invoicesResponseDefault Error	Unexpected error.

Instances

Instances details

Show List_account_invoicesResponse Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods showsPrec :: Int -> List_account_invoicesResponse -> ShowS # show :: List_account_invoicesResponse -> String # showList :: [List_account_invoicesResponse] -> ShowS #
Eq List_account_invoicesResponse Source #
Instance details Defined in RecurlyClient.Operations.List_account_invoices Methods (==) :: List_account_invoicesResponse -> List_account_invoicesResponse -> Bool # (/=) :: List_account_invoicesResponse -> List_account_invoicesResponse -> Bool #

list_account_invoicesWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> List_account_invoicesParameters	Contains all available parameters of this operation (query and path parameters)
-> m (Response List_account_invoicesResponse)	Monadic computation which returns the result of the operation

GET /accounts/{account_id}/invoices

The same as list_account_invoices but accepts an explicit configuration.

list_account_invoicesRaw Source #

Arguments

:: forall m. MonadHTTP m
=> List_account_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 /accounts/{account_id}/invoices

The same as list_account_invoices but returns the raw ByteString.

list_account_invoicesWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> List_account_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 /accounts/{account_id}/invoices

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