SudoSOS Back-end API / payout-requests / PayoutRequestController

Class: PayoutRequestController

The BaseController class is responsible for:

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

Extends

• BaseController

Constructors

Constructor

new PayoutRequestController(options): PayoutRequestController;

Parameters

Parameter	Type
options	BaseControllerOptions

Returns

PayoutRequestController

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

createPayoutRequest()

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

POST /payoutrequests

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - The created payout request.

Operation Id

createPayoutRequest

Tags

payoutRequests - Operations of the payout request controller

Security

JWT

---

getPayoutRequestPdf()

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

GET /payoutrequests/{id}/pdf

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - The pdf location information.

Operation Id

getPayoutRequestPdf

Tags

payoutRequests - Operations of the payout request controller

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

---

returnAllPayoutRequests()

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

GET /payoutrequests

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - All existing payout requests

Operation Id

getAllPayoutRequests

Tags

payoutRequests - Operations of the payout request controller

Security

JWT

Array

@items.type

---

returnSinglePayoutRequest()

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

GET /payoutrequests/

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - Single payout request with given id

Operation Id

getSinglePayoutRequest

Tags

payoutRequests - Operations of the payout request controller

Security

JWT

---

updatePayoutRequestStatus()

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

POST /payoutrequests/{id}/status

Parameters

Parameter	Type
req	RequestWithToken
res	Response

Returns

Promise<void>

200 - The updated payout request

Operation Id

setPayoutRequestStatus

Tags

payoutRequests - Operations of the payout request controller

Security

JWT

---

getRelation()

static getRelation(req): Promise<string>;

Parameters

Parameter	Type
req	RequestWithToken

Returns

Promise<string>