SudoSOS Back-end API / transfers / TransferService

Class: TransferService

Extends

• WithManager

Constructors

Constructor

new TransferService(manager?): TransferService;

Parameters

Parameter	Type
manager?	EntityManager

Returns

TransferService

Inherited from

WithManager.constructor

Properties

Property	Modifier	Type	Inherited from
manager	protected	EntityManager	WithManager.manager

Methods

configureLogger()

protected configureLogger(logger): void;

Parameters

Parameter	Type
logger	Logger

Returns

void

Inherited from

WithManager.configureLogger

---

createTransfer()

createTransfer(request): Promise<Transfer>;

Parameters

Parameter	Type
request	TransferRequest

Returns

Promise<Transfer>

---

deleteTransfer()

deleteTransfer(id): Promise<void>;

Parameters

Parameter	Type
id	number

Returns

Promise<void>

---

getTransferAggregate()

getTransferAggregate(filters?): Promise<TransferAggregateResult>;

Returns the aggregate (SUM and COUNT) of transfers matching the given filters. The aggregation is performed entirely on the database side.

Parameters

Parameter	Type	Description
filters	TransferAggregateFilterParameters	Optional filters to narrow the set of transfers

Returns

Promise<TransferAggregateResult>

---

getTransfers()

getTransfers(
   filters?, 
   pagination?, 
user?): Promise<[Transfer[], number]>;

Query to return transfers from the database

Parameters

Parameter	Type	Description
filters	TransferFilterParameters	Parameters to query the transfers with
pagination	PaginationParameters	-
user?	User	-

Returns

Promise<[Transfer[], number]>

---

getTransferSummary()

getTransferSummary(filters?): Promise<TransferSummaryResult>;

Returns an aggregate breakdown of transfers for every category plus an overall total. All filters except category are forwarded to each per-category query.

Parameters

Parameter	Type	Description
filters	Omit<TransferAggregateFilterParameters, "category">	Optional filters (fromId, toId, fromDate, tillDate)

Returns

Promise<TransferSummaryResult>

---

postTransfer()

postTransfer(request): Promise<Transfer>;

Parameters

Parameter	Type
request	TransferRequest

Returns

Promise<Transfer>

---

verifyTransferRequest()

verifyTransferRequest(request): Promise<boolean>;

Parameters

Parameter	Type
request	TransferRequest

Returns

Promise<boolean>

---

asTransferResponse()

static asTransferResponse(transfer): TransferResponse;

Parameters

Parameter	Type
transfer	Transfer

Returns

TransferResponse

---

invalidateBalanceCaches()

static invalidateBalanceCaches(transfer): Promise<void>;

Parameters

Parameter	Type
transfer	Transfer

Returns

Promise<void>