/home/infinitibizsol/insurcrm.infinitibizsol.com/docs/common/ Current File: /home/infinitibizsol/insurcrm.infinitibizsol.com/docs/common/folder.js
/**
 * @swagger
 * components:
 *   schemas:
 *     Folder:
 *       type: object
 *       required:
 *         - name
 *       properties:
 *         name:
 *           type: string
 *           description: The name of the folder
 *         parent_id:
 *           type: string
 *           description: The ID of the parent folder, if any (nullable)
 *           nullable: true
 *         contact_id:
 *           type: string
 *           description: The ID of the associated contact
 *         policy_id:
 *           type: string
 *           description: The ID of the associated policy
 *         user_id:
 *           type: string
 *           description: The ID of the associated User
 *       example:
 *         name: "Documents"
 *         parent_id: "64d5bd3aca0be228afc9e267"
 *         contact_id: "60f8f0bce7c8b91c54d8c280"
 *         policy_id: "60f8f0bce7c8b91c54d8c281"
 *         user_id: "60f8f0bce7c8b91c54d8c281"
 *
 *     FolderRequest:
 *       type: object
 *       required:
 *         - contact_id
 *         - policy_id
 *       properties:
 *         contact_id:
 *           type: string
 *           description: The ID of the contact associated with the folder
 *         policy_id:
 *           type: string
 *           description: The ID of the policy associated with the folder
 *         user_id:
 *           type: string
 *           description: The ID of the policy associated with the folder
 *       example:
 *         contact_id: "64d5bd3aca0be228afc9e267"
 *         policy_id: "64d5bd3aca0be228afc9e268"
 *         user_id: "64d5bd3aca0be228afc9e268"
 *
 *   securitySchemes:
 *     bearerAuth:
 *       type: http
 *       scheme: bearer
 *       bearerFormat: JWT
 *
 * tags:
 *   - name: Folders
 *     description: Operations related to folders
 */

/**
 * @swagger
 * /folder/list:
 *   post:
 *     summary: Create a new folder
 *     description: This endpoint allows you to get a folders list. One of the fields (`contact_id`, `policy_id`, or `user_id`) must be provided in the request body.
 *     tags: [Folders]
 *     security:
 *       - bearerAuth: []
 *     requestBody:
 *       required: true
 *       content:
 *         application/json:
 *           schema:
 *             $ref: '#/components/schemas/FolderRequest'
 *     responses:
 *       201:
 *         description: The folder was successfully created
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '#/components/schemas/Folder'
 */

/**
 * @swagger
 * /folder/add:
 *   post:
 *     summary: Create a new folder
 *     tags: [Folders]
 *     security:
 *       - bearerAuth: []
 *     requestBody:
 *       required: true
 *       content:
 *         application/json:
 *           schema:
 *             $ref: '#/components/schemas/Folder'
 *     responses:
 *       201:
 *         description: The folder was successfully created
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '#/components/schemas/Folder'
 */

/**
 * @swagger
 * /folder/edit/{id}:
 *   put:
 *     summary: Update the folder by ID
 *     tags: [Folders]
 *     security:
 *       - bearerAuth: []
 *     parameters:
 *       - in: path
 *         name: id
 *         schema:
 *           type: string
 *         required: true
 *         description: The ID of the folder
 *     requestBody:
 *       required: true
 *       content:
 *         application/json:
 *           schema:
 *             $ref: '#/components/schemas/Folder'
 *     responses:
 *       200:
 *         description: The folder was successfully updated
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '#/components/schemas/UpdateResponse'
 *       404:
 *         description: Folder not found
 */

/**
 * @swagger
 * /folder/delete/{id}:
 *   delete:
 *     summary: Delete the folder by ID
 *     tags: [Folders]
 *     security:
 *       - bearerAuth: []
 *     parameters:
 *       - in: path
 *         name: id
 *         schema:
 *           type: string
 *         required: true
 *         description: The ID of the folder
 *     responses:
 *       200:
 *         description: The folder was successfully deleted
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '#/components/schemas/DeleteResponse'
 *       404:
 *         description: Folder not found
 */

/**
 * @swagger
 * /folder/view/{id}:
 *   get:
 *     summary: Return folder and it's sub-folders.
 *     tags: [Folders]
 *     security:
 *       - bearerAuth: []
 *     parameters:
 *       - in: path
 *         name: id
 *         schema:
 *           type: string
 *         required: true
 *         description: The ID of the folder
 *     responses:
 *       200:
 *         description: The folder was successfully deleted
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '#/components/schemas/DeleteResponse'
 *       404:
 *         description: Folder not found
 */
"use strict";