SudoSOS Back-end API / service/inactive-administrative-cost-service / InactiveAdministrativeCostService

Class: InactiveAdministrativeCostService

Extends

• WithManager

Constructors

Constructor

new InactiveAdministrativeCostService(manager?): InactiveAdministrativeCostService;

Parameters

Parameter	Type
manager?	EntityManager

Returns

InactiveAdministrativeCostService

Inherited from

WithManager.constructor

Properties

Property	Modifier	Type	Inherited from
manager	protected	EntityManager	WithManager.manager

Methods

checkInactiveUsers()

checkInactiveUsers(params): Promise<UserToInactiveAdministrativeCostResponse[]>;

Checks which users are eligible for either a notification or a fine.

Parameters

Parameter	Type	Description
params	InactiveAdministrativeCostFilterParameters	-

Returns

Promise<UserToInactiveAdministrativeCostResponse[]>

---

createInactiveAdministrativeCost()

createInactiveAdministrativeCost(inactiveAdministrativeCostRequest): Promise<InactiveAdministrativeCost>;

Creates an InactiveAdministrativeCost from an InactiveAdministrativeCostRequest

Parameters

Parameter	Type	Description
inactiveAdministrativeCostRequest	CreateInactiveAdministrativeCostRequest	The InactiveAdministrativeCost request to create

Returns

Promise<InactiveAdministrativeCost>

---

deleteInactiveAdministrativeCost()

deleteInactiveAdministrativeCost(inactiveAdministrativeCostId): Promise<void>;

Hard deletes the given InactiveAdministrativeCost and its linked Transfer.

Parameters

Parameter	Type	Description
inactiveAdministrativeCostId	number	-

Returns

Promise<void>

---

getInactiveAdministrativeCostReport()

getInactiveAdministrativeCostReport(fromDate, toDate): Promise<InactiveAdministrativeCostReport>;

Gets a report of inactive administrative costs within the given date range

Parameters

Parameter	Type	Description
fromDate	Date	The start date of the report (inclusive)
toDate	Date	The end date of the report (exclusive)

Returns

Promise<InactiveAdministrativeCostReport>

---

getInactiveAdministrativeCosts()

getInactiveAdministrativeCosts(params?): Promise<InactiveAdministrativeCost[]>;

Returns database entities based on the given filter params

Parameters

Parameter	Type	Description
params	InactiveAdministrativeCostFilterParameters	-

Returns

Promise<InactiveAdministrativeCost[]>

---

getPaginatedInactiveAdministrativeCosts()

getPaginatedInactiveAdministrativeCosts(params?, pagination?): Promise<[InactiveAdministrativeCost[], number]>;

Function that returns all inactive administrative cost entitites based on given params.

Parameters

Parameter	Type	Description
params	InactiveAdministrativeCostFilterParameters	-
pagination	PaginationParameters	The pagination params to apply

Returns

Promise<[InactiveAdministrativeCost[], number]>

---

handOutInactiveAdministrativeCost()

handOutInactiveAdministrativeCost(users): Promise<InactiveAdministrativeCost[]>;

Email all users with the given ids. These user will get notified that an administrative cost has been deducted from their account.

Parameters

Parameter	Type	Description
users	HandoutInactiveAdministrativeCostsRequest	-

Returns

Promise<InactiveAdministrativeCost[]>

---

sendInactiveNotification()

sendInactiveNotification(users): Promise<void>;

Email all users with the given ids. These users will get notified that in a year time money will be deducted from their account as they have been inactive for three years.

Parameters

Parameter	Type	Description
users	HandoutInactiveAdministrativeCostsRequest	-

Returns

Promise<void>

---

getOptions()

static getOptions(params): FindManyOptions<InactiveAdministrativeCost>;

Parameters

Parameter	Type
params	InactiveAdministrativeCostFilterParameters

Returns

FindManyOptions<InactiveAdministrativeCost>

---

toArrayResponse()

static toArrayResponse(inactiveAdministrativeCosts): InactiveAdministrativeCostResponse[];

Parameters

Parameter	Type
inactiveAdministrativeCosts	InactiveAdministrativeCost[]

Returns

InactiveAdministrativeCostResponse[]