/
home
/
infinitibizsol
/
insurcrm.infinitibizsol.com
/
docs
/
common
/
File Upload :
llllll
Current File: /home/infinitibizsol/insurcrm.infinitibizsol.com/docs/common/socialMedia.js
/** * @swagger * components: * schemas: * SocialMedia: * type: object * required: * - user_id * properties: * facebook: * type: string * description: The Facebook profile URL of the user * twitter: * type: string * description: The Twitter profile URL of the user * linkedin: * type: string * description: The LinkedIn profile URL of the user * other: * type: string * description: Other social media profile URL of the user * sms: * type: string * description: SMS contact of the user * rss_feed1: * type: string * description: First RSS feed URL of the user * rss_feed2: * type: string * description: Second RSS feed URL of the user * pages: * type: array * items: * type: string * description: Array of associated page URLs * contact_id: * type: string * description: The ID of the contact associated with this entry * example: * facebook: "https://www.instagram.com" * twitter: "https://www.X.com" * linkedin: "https://www.test1.com" * other: "https://www.other-social-media.com" * sms: "+1234567890" * rss_feed1: "https://www.rssfeed1.com" * rss_feed2: "https://www.rssfeed2.com" * pages: ["https://www.page1.com", "https://www.page2.com"] * contact_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: SocialMedia * description: Social media profile-related operations */ /** * @swagger * /social-media/list: * get: * summary: Returns the list of social media profiles * tags: [SocialMedia] * security: * - bearerAuth: [] * parameters: * - in: query * name: contact_id * schema: * type: string * required: false * description: ID of the contact * responses: * 200: * description: The list of social media profiles * content: * application/json: * schema: * type: array * items: * $ref: '#/components/schemas/SocialMedia' */ /** * @swagger * /social-media/add: * post: * summary: Create a new social media profile entry you have to send contact_id key only when you're creating social-media for CONTACT.NOTE for agent it will take from JWT-TOKEN. * tags: [SocialMedia] * security: * - bearerAuth: [] * requestBody: * required: true * content: * application/json: * schema: * $ref: '#/components/schemas/SocialMedia' * responses: * 201: * description: The social media profile entry was successfully created * content: * application/json: * schema: * $ref: '#/components/schemas/SocialMedia' */ /** * @swagger * /social-media/edit/{id}: * put: * summary: Update the social media profile entry by ID * tags: [SocialMedia] * security: * - bearerAuth: [] * parameters: * - in: path * name: id * schema: * type: string * required: true * description: The ID of the social media profile entry * requestBody: * required: true * content: * application/json: * schema: * $ref: '#/components/schemas/SocialMedia' * responses: * 200: * description: The social media profile entry was successfully updated * content: * application/json: * schema: * $ref: '#/components/schemas/UpdateResponse' */ /** * @swagger * /social-media/delete/{id}: * delete: * summary: Delete the social media profile entry by ID * tags: [SocialMedia] * security: * - bearerAuth: [] * parameters: * - in: path * name: id * schema: * type: string * required: true * description: The ID of the social media profile entry * responses: * 200: * description: The social media profile entry was successfully deleted * content: * application/json: * schema: * $ref: '#/components/schemas/DeleteResponse' */ "use strict";
Copyright ©2k19 -
Hexid
|
Tex7ure