SudoSOS Back-end API / transfers / TransferController
Class: TransferController ​
The BaseController class is responsible for:
- Storing route definitions.
- Generating router objects based on the policy.
Extends ​
Constructors ​
Constructor ​
new TransferController(options): TransferController;Creates a new transfer controller instance.
Parameters ​
| Parameter | Type | Description |
|---|---|---|
options | BaseControllerOptions | The options passed to the base controller. |
Returns ​
TransferController
Overrides ​
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 ​
deleteTransfer() ​
deleteTransfer(req, res): Promise<void>;DELETE /transfers/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Transfer successfully deleted
Operation Id ​
deleteTransfer
Tags ​
transfers - Operations of transfer 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 ​
The policy of this controller.
Overrides ​
getRouter() ​
getRouter(): Router;Returns ​
Router
the router used by this controller.
Inherited from ​
getTransferPdf() ​
getTransferPdf(req, res): Promise<void>;GET /transfers/{id}/pdf
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The requested pdf of the transfer - application/pdf
Operation Id ​
getTransferPdf
Tags ​
transfers - Operations of the transfer controller
Security ​
JWT
postTransfer() ​
postTransfer(req, res): Promise<void>;POST /transfers
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The created transfer entity
Operation Id ​
createTransfer
Tags ​
transfers - Operations of transfer controller
Security ​
JWT
returnAllTransfers() ​
returnAllTransfers(req, res): Promise<void>;GET /transfers
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - All existing transfers
Operation Id ​
getAllTransfers
Tags ​
transfers - Operations of transfer controller
Security ​
JWT
returnTransfer() ​
returnTransfer(req, res): Promise<void>;GET /transfers/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The requested transfer entity
Operation Id ​
getSingleTransfer
Tags ​
transfers - Operations of transfer controller
Security ​
JWT
returnTransferAggregate() ​
returnTransferAggregate(req, res): Promise<void>;GET /transfers/aggregate
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - Aggregate sum and count of matching transfers
Operation Id ​
getTransferAggregate
Tags ​
transfers - Operations of transfer controller
Security ​
JWT
getRelation() ​
static getRelation(req): Promise<string>;Function to determine which credentials are needed to get transaction all if user is not connected to transaction own if user is connected to transaction organ if user is connected to transaction via organ
Parameters ​
| Parameter | Type | Description |
|---|---|---|
req | RequestWithToken | - |
Returns ​
Promise<string>
whether transaction is connected to used token