Interface: CreditsApi

The methods of Talkline.credits.

Methods

append()

append(identity, body): Promise<CreditEntryResult>;

POST /v1/credits/{identity}: a grant, refund, expiry or adjustment, and the balance it leaves. The same entry again under one idempotencyKey is answered with the one written (replayed: true).

Parameters

Parameter	Type
identity	string
body	CreditEntryRequest

Returns

Promise<CreditEntryResult>

---

get()

get(identity): Promise<CreditAccount>;

GET /v1/credits/{identity}: an identity with no account is 404, and is never charged.

Parameters

Parameter	Type
identity	string

Returns

Promise<CreditAccount>

---

iterateLedger()

iterateLedger(identity, query?): AsyncIterable<LedgerEntry>;

GET /v1/credits/{identity}/ledger, every page in turn.

Parameters

Parameter	Type
identity	string
query?	Pageless<PageQuery>

Returns

AsyncIterable<LedgerEntry>

---

ledger()

ledger(identity, query?): Promise<Page<LedgerEntry>>;

GET /v1/credits/{identity}/ledger: one page, newest first; consumption is one entry per seat.

Parameters

Parameter	Type
identity	string
query?	PageQuery

Returns

Promise<Page<LedgerEntry>>