/home/infinitibizsol/insurcrm.infinitibizsol.com/docs/common/ Current File: /home/infinitibizsol/insurcrm.infinitibizsol.com/docs/common/emails.js
/**
 * @swagger
 * components:
 *   schemas:
 *     Email:
 *       type: object
 *       required:
 *         - to
 *         - from
 *       properties:
 *         id:
 *           type: string
 *           description: The auto-generated ID of the email
 *         to:
 *           type: string
 *           description: The recipient of the email
 *         from:
 *           type: string
 *           description: The sender of the email
 *         subject:
 *           type: string
 *           description: The subject of the email
 *         description:
 *           type: string
 *           description: The content or description of the email
 *         date:
 *           type: string
 *           format: date-time
 *           description: The date and time the email was sent
 *         contact_id:
 *           type: string
 *           description: The ID of the contact associated with the email
 *         user_id:
 *           type: string
 *           description: The ID of the user who sent the email
 *         policy_id:
 *           type: string
 *           description: The ID of the policy related to the email
 *       example:
 *         to: "recipient@example.com"
 *         from: "sender@example.com"
 *         subject: "Policy Update Notification"
 *         description: "Details about the policy changes."
 *         date: "2024-11-25T14:30:00Z"
 *         contact_id: "603e3c9f062ce7bda0dcb013"
 *         user_id: "605c5f30f5a3b8d4cc9b80b1"
 *         policy_id: "604f1c2d7b45f8b1fc8b78b6"
 *   securitySchemes:
 *     bearerAuth:
 *       type: http
 *       scheme: bearer
 *       bearerFormat: JWT
 */

/**
 * @swagger
 * tags:
 *   - name: Email
 *     description: Email related operations
 */

/**
 * @swagger
 * /email/list:
 *   get:
 *     summary: Returns the list of emails. NOTE *contact_id & policy_id is required*
 *     tags: [Email]
 *     security:
 *       - bearerAuth: []
 *     parameters:
 *       - in: query
 *         name: contact_id
 *         schema:
 *           type: string
 *         required: false
 *         description: ID of the contact
 *       - in: query
 *         name: user_id
 *         schema:
 *           type: string
 *         required: false
 *         description: ID of the contact
 *       - in: query
 *         name: policy_id
 *         schema:
 *           type: string
 *         required: false
 *         description: ID of the contact
 *     responses:
 *       200:
 *         description: The list of addresses
 *         content:
 *           application/json:
 *             schema:
 *               type: array
 *               items:
 *                 $ref: '#/components/schemas/Email'
 */

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

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

/**
 * @swagger
 * /email/delete/{id}:
 *   delete:
 *     summary: Delete the email by ID
 *     tags: [Email]
 *     security:
 *       - bearerAuth: []
 *     parameters:
 *       - in: path
 *         name: id
 *         schema:
 *           type: string
 *         required: true
 *         description: The email ID
 *     responses:
 *       200:
 *         description: The email was successfully deleted
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '#/components/schemas/DeleteResponse'
 
 */
"use strict";