Interface: UsageApi

The methods of Talkline.usage.

Methods

iterate()

iterate(query?): AsyncIterable<UsageGroup>;

GET /v1/usage, every group of one window. An absent to is read as now, so the window is the one the first page answered, and each later page asks for it by its bounds.

Parameters

Parameter	Type
query?	Pageless<UsageQuery>

Returns

AsyncIterable<UsageGroup>

---

list()

list(query?): Promise<UsagePage>;

GET /v1/usage: one page of groups. A seat counts in the window it started in; a live one as of the last flush (final: false).

Parameters

Parameter	Type
query?	UsageQuery

Returns

Promise<UsagePage>

---

rates()

rates(): Promise<UsageRates>;

GET /v1/usage/rates: what a credit buys. A dimension the table does not name costs nothing.

Returns

Promise<UsageRates>

---

setRates()

setRates(body): Promise<UsageRates>;

PUT /v1/usage/rates: the whole table; a dimension left out is free from now on.

Parameters

Parameter	Type
body	UsageRates

Returns

Promise<UsageRates>