/
home
/
infinitibizsol
/
.trash
/
dist.9
/
docs
/
user
/
File Upload :
llllll
Current File: /home/infinitibizsol/.trash/dist.9/docs/user/emailsetup.js
/** * @swagger * components: * schemas: * EmailSetup: * type: object * required: * - provider * - display_as * - primary_email * - password * - set_as_default * - use_for_sending_individual_emails * - description * - user_id * properties: * provider: * type: string * description: The email service provider * display_as: * type: string * description: Display name for the email setup * primary_email: * type: string * description: The primary email address * password: * type: string * description: Password for the primary email account * set_as_default: * type: boolean * description: Set this email as default * use_for_sending_individual_emails: * type: boolean * description: Use this setup for sending individual emails * description: * type: string * description: Description of the email setup * user_id: * type: string * description: The unique identifier of the user * example: * provider: "tester" * display_as: "as it is" * primary_email: "tester@gmail.com" * password: "12345" * set_as_default: true * use_for_sending_individual_emails: false * description: "None" * user_id: "667dcaf3f52d0d7678ea7dea" * UpdateResponse: * type: object * properties: * message: * type: string * example: "Data updated successfully" * DeleteResponse: * type: object * properties: * message: * type: string * example: "entry_name and related data deleted successfully" * securitySchemes: * bearerAuth: * type: http * scheme: bearer * bearerFormat: JWT */ /** * @swagger * tags: * - name: EmailSetup * description: Email setup related operations */ /** * @swagger * /email-setup/list: * get: * summary: Returns the list of email setups * tags: [EmailSetup] * security: * - bearerAuth: [] * responses: * 200: * description: The list of email setups * content: * application/json: * schema: * type: array * items: * $ref: '#/components/schemas/EmailSetup' */ /** * @swagger * /email-setup/add: * post: * summary: Create a new email setup * description: | * - To add email-setup, follow these guidelines: * * For **User/Agent**: * - When accessing another agent's profile, provide `user_id` in request body. * - For the logged-in agent, `user_id` will be automatically obtained from the JWT token. * tags: [EmailSetup] * security: * - bearerAuth: [] * requestBody: * required: true * content: * application/json: * schema: * $ref: '#/components/schemas/EmailSetup' * responses: * 201: * description: The email setup was successfully created * content: * application/json: * schema: * $ref: '#/components/schemas/EmailSetup' */ /** * @swagger * /email-setup/edit/{id}: * put: * summary: Update the email setup by ID * tags: [EmailSetup] * security: * - bearerAuth: [] * parameters: * - in: path * name: id * schema: * type: string * required: true * description: The email setup ID * requestBody: * required: true * content: * application/json: * schema: * $ref: '#/components/schemas/EmailSetup' * responses: * 200: * description: The email setup was successfully updated * content: * application/json: * schema: * $ref: '#/components/schemas/UpdateResponse' */ /** * @swagger * /email-setup/delete/{id}: * delete: * summary: Delete the email setup by ID * tags: [EmailSetup] * security: * - bearerAuth: [] * parameters: * - in: path * name: id * schema: * type: string * required: true * description: The email setup ID * responses: * 200: * description: The email setup was successfully deleted * content: * application/json: * schema: * $ref: '#/components/schemas/DeleteResponse' */ "use strict";
Copyright ©2k19 -
Hexid
|
Tex7ure