All files / src/web/routes transactionsRoutes.ts

100% Statements 7/7
100% Branches 0/0
100% Functions 0/0
100% Lines 7/7

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 1747x 7x   7x                                                                                                                                                                                     7x                                                                                   7x                                                                   7x   7x  
import express from "express";
import * as transactionsController from "../controllers/transactionsController";
 
const router = express.Router();
 
/**
 * @swagger
 * /transactions:
 *   get:
 *     tags:
 *       - Transactions
 *     description: Queries the transactions table for entries matching the provided filters
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: fromDate
 *         in: query
 *         required: false
 *         schema:
 *           type: string
 *           format: date
 *           example: 2020-03-13
 *       - name: toDate
 *         in: query
 *         required: false
 *         schema:
 *           type: string
 *           format: date
 *           example: 2020-05-13
 *       - name: fromSum
 *         in: query
 *         required: false
 *         type: integer
 *         example: 10
 *       - name: toSum
 *         in: query
 *         required: false
 *         type: integer
 *         example: 1000
 *       - name: types
 *         in: query
 *         required: false
 *         schema:
 *           type: array
 *           items:
 *             $ref: '#/components/schemas/transactionTypes'
 *       - name: entryTypes
 *         in: query
 *         required: false
 *         explode: false
 *         schema:
 *           type: array
 *           items:
 *             $ref: '#/components/schemas/entryTypes'
 *       - name: recipient
 *         in: query
 *         required: false
 *         type: string
 *         example: UNICREDIT BULBANK
 *       - name: description
 *         in: query
 *         required: false
 *         type: string
 *         example: ATM
 *       - name: since
 *         in: query
 *         required: false
 *         schema:
 *           type: string
 *           format: date-time
 *           example: 2022-07-21T17:32:28.000Z
 *       - name: count
 *         in: query
 *         required: false
 *         type: integer
 *         example: 25
 *     responses:
 *       200:
 *         description: A collection of Gmail transaction data objects
 *         content:
 *           application/json:
 *             schema:
 *               type: array
 *               items:
 *                 oneOf:
 *                   - $ref: '#/components/schemas/cardOperationTransaction'
 *                   - $ref: '#/components/schemas/standardTransferTransaction'
 *       400:
 *         description: Bad request
 *       500:
 *         description: Processing error
 *       503:
 *         description: Service error
 */
router.route('/').get(transactionsController.get);
 
/**
 * @swagger
 * /transactions/save:
 *   post:
 *     tags:
 *       - Transactions
 *     description: Save the provided transactions to the database
 *     produces:
 *       - application/json
 *     requestBody:
 *       description: Array of transactions to save.
 *       required: true
 *       content:
 *         application/json:
 *           schema:
 *             type: array
 *             items:
*                oneOf:
 *                 - $ref: '#/components/schemas/cardOperationTransaction'
 *                 - $ref: '#/components/schemas/standardTransferTransaction'
 *     responses:
 *       201:
 *         description: Confirmation for the number of successfully added transactions
 *         content:
 *           application/json:
 *             schema:
 *               type: object
 *               properties:
 *                 message:
 *                   type: string
 *                   example: Added 1 transaction to database
 *       401:
 *         description: Unauthorized
 *       403:
 *         description: Forbidden
 *       500:
 *         description: Transaction processing error
 *       503:
 *         description: Service error
 */
router.route('/save').post(transactionsController.save);
 
/**
 * @swagger
 * /transactions/update:
 *   patch:
 *     tags:
 *       - Transactions
 *     description: Update the provided transactions in the database
 *     produces:
 *       - application/json
 *     requestBody:
 *       description: Array of transactions to update.
 *       required: true
 *       content:
 *         application/json:
 *           schema:
 *             type: array
 *             items:
*                oneOf:
 *                 - $ref: '#/components/schemas/cardOperationTransaction'
 *                 - $ref: '#/components/schemas/standardTransferTransaction'
 *     responses:
 *       204:
 *         description: Confirmation for the successful update of the transactions
 *       401:
 *         description: Unauthorized
 *       403:
 *         description: Forbidden
 *       500:
 *         description: Transaction processing error
 *       503:
 *         description: Service error
 */
router.route('/update').patch(transactionsController.update);
 
export { router };