SudoSOS Back-end API / debtors / DebtorController

Class: DebtorController

The BaseController class is responsible for:

• Storing route definitions.
• Generating router objects based on the policy.

Extends

• BaseController

Constructors

Constructor

new DebtorController(options): DebtorController;

Parameters

Parameter	Type
options	BaseControllerOptions

Returns

DebtorController

Overrides

BaseController.constructor

Properties

Property	Modifier	Type	Description	Inherited from
roleManager	protected	RoleManager	A reference to the role manager passed in the base controller options.	BaseController.roleManager
specification	public	SwaggerSpecification	A reference to the swagger specification passed in the base controller options.	BaseController.specification

Methods

calculateFines()

calculateFines(req, res): Promise<void>;

GET /fines/eligible

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - List of eligible fines

Tags

debtors - Operations of the debtor controller

Operation Id

calculateFines

Security

JWT

---

deleteFine()

deleteFine(req, res): Promise<void>;

DELETE /fines/single/

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

204 - Success

Tags

debtors - Operations of the debtor controller

Operation Id

deleteFine

Security

JWT

---

deleteFineHandout()

deleteFineHandout(req, res): Promise<void>;

DELETE /fines/handout/

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

204 - Success

Tags

debtors - Operations of the debtor controller

Operation Id

deleteFineHandout

Security

JWT

---

getFineReport()

getFineReport(req, res): Promise<void>;

GET /fines/report

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - The requested report

Tags

debtors - Operations of the debtor controller

Operation Id

getFineReport

Security

JWT

---

getFineReportPdf()

getFineReportPdf(req, res): Promise<void>;

GET /fines/report/pdf

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - The requested report - application/pdf

Tags

debtors - Operations of the debtor controller

Operation Id

getFineReportPdf

Security

JWT

---

getPolicy()

getPolicy(): Policy;

Gets the policy defined by child classes. This policy includes all routes that the controller accepts, the authorization middleware, and the final handler function for every route.

Returns

Policy

The policy of this controller.

Overrides

BaseController.getPolicy

---

getRouter()

getRouter(): Router;

Returns

Router

the router used by this controller.

Inherited from

BaseController.getRouter

---

handoutFines()

handoutFines(req, res): Promise<void>;

POST /fines/handout

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - Created fine handout event with corresponding fines

Tags

debtors - Operations of the debtor controller

Operation Id

handoutFines

Security

JWT

---

notifyAboutFutureFines()

notifyAboutFutureFines(req, res): Promise<void>;

POST /fines/notify

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

204 - Success

Tags

debtors - Operations of the debtor controller

Operation Id

notifyAboutFutureFines

Security

JWT

---

returnAllFineHandoutEvents()

returnAllFineHandoutEvents(req, res): Promise<void>;

GET /fines

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - All existing fine handout events

Tags

debtors - Operations of the debtor controller

Operation Id

returnAllFineHandoutEvents

Security

JWT

---

returnSingleFineHandoutEvent()

returnSingleFineHandoutEvent(req, res): Promise<void>;

GET /fines/

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - Requested fine handout event with corresponding fines

Tags

debtors - Operations of the debtor controller

Operation Id

returnSingleFineHandoutEvent

Security

JWT