SudoSOS Back-end API / balance / BalanceService

Class: BalanceService

Extends

• WithManager

Constructors

Constructor

new BalanceService(manager?): BalanceService;

Parameters

Parameter	Type
manager?	EntityManager

Returns

BalanceService

Inherited from

WithManager.constructor

Properties

Property	Modifier	Type	Inherited from
manager	protected	EntityManager	WithManager.manager

Methods

calculateTotalBalances()

calculateTotalBalances(date, allowDeleted?): Promise<TotalBalanceResponse>;

Get the total balance of SudoSOS and

Parameters

Parameter	Type	Description
date	Date	Date to check the balances for
allowDeleted?	boolean	allow balances of deleted users to be returned

Returns

Promise<TotalBalanceResponse>

---

clearBalanceCache()

clearBalanceCache(ids?): Promise<void>;

Clear balance cache

Parameters

Parameter	Type
ids?	number | number[]

Returns

Promise<void>

---

configureLogger()

protected configureLogger(logger): void;

Parameters

Parameter	Type
logger	Logger

Returns

void

Inherited from

WithManager.configureLogger

---

getBalance()

getBalance(id, date?): Promise<BalanceResponse>;

Get balance for single user

Parameters

Parameter	Type	Description
id	number	ID of user
date?	Date	Date to calculate balance for

Returns

Promise<BalanceResponse>

---

getBalances()

getBalances(params, pagination?): Promise<[BalanceResponse[], number]>;

Get balance of users matching the given filters.

See GetBalanceParameters for the full list of filter fields (user ids, date snapshot, min/max balance and fine, user types, ordering, allowDeleted, inactive).

Parameters

Parameter	Type	Description
params	GetBalanceParameters	filter fields; see GetBalanceParameters.
pagination	PaginationParameters	pagination options.

Returns

Promise<[BalanceResponse[], number]>

the balances and the total count.

---

updateBalances()

updateBalances(params): Promise<void>;

Update the balance cache with active values Insafe Query! Safety leveraged by type safety

Parameters

Parameter	Type
params	UpdateBalanceParameters

Returns

Promise<void>