@gofynd/fdk-client-javascript 1.2.0 → 1.3.1-beta.1

package/sdk/platform/Lead/LeadPlatformModel.js

@@ -4,9 +4,9 @@ const Joi = require("joi");
  * @typedef AddTicketPayload
  * @property {Object} [_custom_json] - Optional custom data that needs to be sent
  * @property {string} category - Category of the ticket
- * @property {TicketContent} content - Content for the ticket
+ * @property {TicketContent} content
  * @property {Object} [created_by] - Creator of the ticket
- * @property {PriorityEnum} [priority] - Priority of the ticket
+ * @property {PriorityEnum} [priority]
  * @property {string} [status] - Status of the ticket
  */
 
@@ -15,34 +15,18 @@ const Joi = require("joi");
  * @property {string} agent_id - Agent's unique ID
  */
 
-/**
- * @typedef CategoryData
- * @property {TicketCategory} [list]
- */
-
 /**
  * @typedef CloseVideoRoomResponse
  * @property {boolean} success - Denotes if operation was successfully
  */
 
-/**
- * @typedef CommunicationDetails
- * @property {string} [description] - Short description for the communication method
- * @property {boolean} [enabled] - Denotes if this communication method has to be shown
- * @property {string} [title] - Title for the communication method
- * @property {string} [type] - Enum type for the communication method
- * @property {string} [value] - Value for the communication method
- */
-
 /**
  * @typedef CreateCustomFormPayload
  * @property {string} [description] - Description of the form
  * @property {string} [header_image] - Header image that is to be shown for the form
  * @property {Object[]} inputs - List of all the form components
- * @property {PollForAssignment} [poll_for_assignment] - Describes how polling
- *   will be done for the tickets createds
- * @property {PriorityEnum} priority - Describes the priority of the tickets
- *   created by the form
+ * @property {PollForAssignment} [poll_for_assignment]
+ * @property {PriorityEnum} priority
  * @property {boolean} [should_notify] - Indicates if staff should be notified
  *   when a response is received
  * @property {string} slug - Slug for the form
@@ -70,19 +54,18 @@ const Joi = require("joi");
  * @typedef CustomForm
  * @property {string} _id - Unique identifier for the form
  * @property {string} application_id - Application ID for form
- * @property {CreatedOn} [created_on] - Gives details of when the form was created
+ * @property {CreatedOn} [created_on]
  * @property {string} [description] - Form description that will be shown to the user
  * @property {string} [header_image] - Form header image that will be shown to the user
  * @property {Object[]} inputs - List of all the form fields
  * @property {boolean} login_required - Denotes if login is required to make a
  *   form response submission
- * @property {PollForAssignment} [poll_for_assignment] - Details of how polling
- *   should be done for support
- * @property {Priority} priority - Sets priority of tickets created by form response
+ * @property {PollForAssignment} [poll_for_assignment]
+ * @property {Priority} priority
  * @property {boolean} should_notify - Denotes if new response submission for
  *   the form should be notified to the assignees
  * @property {string} slug - Slug for the form, which is to be used for accessing the form
- * @property {SubmitButton} [submit_button] - Details for submit button
+ * @property {SubmitButton} [submit_button]
  * @property {string} [success_message] - Message that is to be shown on
  *   succesfull form response submission
  * @property {string} title - Form title that will be shown to the user
@@ -91,13 +74,7 @@ const Joi = require("joi");
 /**
  * @typedef CustomFormList
  * @property {CustomForm[]} [items] - List of forms
- * @property {Page} [page] - Describes the pagination state
- */
-
-/**
- * @typedef CustomFormSubmissionPayload
- * @property {TicketAsset[]} [attachments] - List of all attachments related to the form
- * @property {Object[]} response - Form response
+ * @property {Page} [page]
  */
 
 /**
@@ -113,10 +90,8 @@ const Joi = require("joi");
  * @property {Object[]} inputs - List of all the form components
  * @property {boolean} [login_required] - Denotes if login is required to make a
  *   form response submission
- * @property {PollForAssignment} [poll_for_assignment] - Describes how polling
- *   will be done for the tickets createds
- * @property {PriorityEnum} priority - Describes the priority of the tickets
- *   created by the form
+ * @property {PollForAssignment} [poll_for_assignment]
+ * @property {PriorityEnum} priority
  * @property {boolean} [should_notify] - Indicates if staff should be notified
  *   when a response is received
  * @property {string} [success_message] - Success message that will be shown on submission
@@ -125,11 +100,10 @@ const Joi = require("joi");
 
 /**
  * @typedef EditTicketPayload
- * @property {AgentChangePayload} [assigned_to] - Details of support staff to
- *   whom ticket is assigned
+ * @property {AgentChangePayload} [assigned_to]
  * @property {string} [category] - Category assigned to the ticket
- * @property {TicketContent} [content] - Ticket conetent details
- * @property {PriorityEnum} [priority] - Denotes the priority of ticket
+ * @property {TicketContent} [content]
+ * @property {PriorityEnum} [priority]
  * @property {string} [source] - Denotes if the ticket was created at company or
  *   application level
  * @property {string} [status] - Denotes in what state is the ticket
@@ -177,26 +151,6 @@ const Joi = require("joi");
  * @property {string} access_token - Access token to be used for video room
  */
 
-/**
- * @typedef IntegrationConfig
- * @property {string} [_id] - Unique id
- * @property {boolean} allow_ticket_creation - Denotes ticket creation enable or
- *   disable on platform
- * @property {string} [base_url] - Integration base url for validate and create ticket
- * @property {CategoryData} [category_data] - Support category array list details
- * @property {string} [category_sync_apikey] - Integration apikey to sync
- *   category of selected type
- * @property {boolean} [config_completed] - Denotes the current intergration is
- *   completed or partially done
- * @property {string} [create_ticket_apikey] - Integration apikey to validate
- *   and create ticket
- * @property {string} integration_type - Enum string values for integration
- * @property {boolean} show_listing - Denotes ticket listing enable or disable on platform
- * @property {string} [update_ticket_apikey] - Integration apikey to update ticket
- * @property {string} [webhook_apikey] - Integration webhook apikey to got
- *   callbacks from integration type dashboard like freshdesk, etc
- */
-
 /**
  * @typedef NotifyUser
  * @property {string} country_code - Country code
@@ -218,7 +172,7 @@ const Joi = require("joi");
  * @typedef Participant
  * @property {string} [identity] - Unique identifier of participant
  * @property {string} [status] - Status of participant
- * @property {UserSchema} [user] - Details of participant
+ * @property {UserSchema} [user]
  */
 
 /**
@@ -242,7 +196,7 @@ const Joi = require("joi");
  * @typedef Priority
  * @property {string} color - Color for priority
  * @property {string} display - Display text for priority
- * @property {PriorityEnum} key - Key for priority
+ * @property {PriorityEnum} key
  */
 
 /**
@@ -259,49 +213,25 @@ const Joi = require("joi");
  * @property {string} title_color - Title color submit button
  */
 
-/**
- * @typedef SubmitCustomFormResponse
- * @property {string} message - Success message for form submission
- * @property {Ticket} [ticket] - Ticket created on form submission
- */
-
-/**
- * @typedef SupportGeneralConfig
- * @property {string} [_id] - Unique id
- * @property {Object} [integration] - Contains integrations basic information
- * @property {boolean} [show_communication_info] - Denotes if support
- *   communication info should be shown
- * @property {boolean} [show_support_dris] - Denotes if support DRIS info should be shown
- * @property {CommunicationDetails} [support_communication] - Support
- *   communication array list details
- * @property {CommunicationDetails} [support_email] - Support e-mail details
- * @property {CommunicationDetails} [support_faq] - Support FAQ details
- * @property {CommunicationDetails} [support_phone] - Support Phone number details
- * @property {string} [type] - The enity/platform for which the config is stored
- */
-
 /**
  * @typedef Ticket
  * @property {Object} [_custom_json] - Custom json relevant to the ticket
  * @property {string} _id - Unique identifier for the ticket
  * @property {Object} [assigned_to] - Details of support staff to whom ticket is assigned
- * @property {TicketCategory} category - Category assigned to the ticket
- * @property {TicketContent} [content] - Ticket conetent details
- * @property {TicketContext} [context] - Details of company and application
- *   realated to the ticket
+ * @property {TicketCategory} category
+ * @property {TicketContent} [content]
+ * @property {TicketContext} [context]
  * @property {string} [created_at] - Time when the ticket was created
  * @property {Object} [created_by] - User details of ticket creator
- * @property {CreatedOn} [created_on] - Details of company and application
- *   realated to the ticket
+ * @property {CreatedOn} [created_on]
  * @property {Object} [integration] - Integration type and its details of the ticket
  * @property {boolean} [is_feedback_pending] - Denotes if feedback submission is
  *   pending for the ticket
- * @property {Priority} priority - Denotes the priority of ticket
+ * @property {Priority} priority
  * @property {string} [response_id] - Details of company and application
  *   realated to the ticket
- * @property {TicketSourceEnum} source - Denotes if the ticket was created at
- *   company or application level
- * @property {Status} status - Denotes in what state is the ticket
+ * @property {TicketSourceEnum} source
+ * @property {Status} status
  * @property {string} [sub_category] - Sub-category assigned to the ticket
  * @property {string[]} [tags] - Tags relevant to ticket
  * @property {string} [updated_at] - Time when the ticket was last updated
@@ -310,17 +240,17 @@ const Joi = require("joi");
 /**
  * @typedef TicketAsset
  * @property {string} [display] - Display text for asset
- * @property {TicketAssetTypeEnum} type - Type of asset
+ * @property {TicketAssetTypeEnum} type
  * @property {string} value - To be used for details
  */
 
 /**
  * @typedef TicketCategory
  * @property {string} display - Category display value identifier
- * @property {FeedbackForm} [feedback_form] - Support category array list details
+ * @property {FeedbackForm} [feedback_form]
  * @property {number} [group_id] - Group id of category releted data
  * @property {string} key - Category key value identifier
- * @property {TicketCategory} [sub_categories] - Support category array list details
+ * @property {TicketCategory} [sub_categories]
  */
 
 /**
@@ -348,12 +278,6 @@ const Joi = require("joi");
  * @property {Object} [user] - User who submitted the feedback
  */
 
-/**
- * @typedef TicketFeedbackForm
- * @property {Object[]} [display] - List of all the form fields
- * @property {string} title - Feedback form title that will be shown to the user
- */
-
 /**
  * @typedef TicketFeedbackList
  * @property {TicketFeedback[]} [items] - List of all ticket feedback for the ticket
@@ -370,7 +294,7 @@ const Joi = require("joi");
  * @property {string} _id - Unique identifier of the history event
  * @property {string} [created_at] - Time of creation of the history event
  * @property {Object} [created_by] - User who created the history event
- * @property {CreatedOn} [created_on] - Time of creation of the history event
+ * @property {CreatedOn} [created_on]
  * @property {string} ticket_id - Readable ticket number
  * @property {string} type - Type of the history event
  * @property {string} [updated_at] - Time of last update of the history event
@@ -380,27 +304,20 @@ const Joi = require("joi");
 /**
  * @typedef TicketHistoryList
  * @property {TicketHistory[]} [items] - List of ticket history
- * @property {Page} [page] - Describes the pagination state
+ * @property {Page} [page]
  */
 
 /**
  * @typedef TicketHistoryPayload
- * @property {HistoryTypeEnum} type - Type of history event
+ * @property {HistoryTypeEnum} type
  * @property {Object} value - Details of history event
  */
 
 /**
  * @typedef TicketList
- * @property {Filter} [filters] - All the filters available for tickets
+ * @property {Filter} [filters]
  * @property {Ticket[]} [items] - List of tickets
- * @property {Page} [page] - Describes the pagination state
- */
-
-/**
- * @typedef TicketSubCategory
- * @property {string} display - Display text for sub-category
- * @property {string} key - Key for sub-category
- * @property {TicketSubCategory} [sub_categories]
+ * @property {Page} [page]
  */
 
 /**
@@ -439,8 +356,6 @@ const Joi = require("joi");
  *   | "order"} TicketAssetTypeEnum
  */
 
-/** @typedef {"default" | "freshdesk" | "kapture"} TicketIntegrationDetails */
-
 /** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
 
 class LeadPlatformModel {
@@ -463,13 +378,6 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {CategoryData} */
-  static CategoryData() {
-    return Joi.object({
-      list: LeadPlatformModel.TicketCategory(),
-    });
-  }
-
   /** @returns {CloseVideoRoomResponse} */
   static CloseVideoRoomResponse() {
     return Joi.object({
@@ -477,17 +385,6 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {CommunicationDetails} */
-  static CommunicationDetails() {
-    return Joi.object({
-      description: Joi.string().allow(""),
-      enabled: Joi.boolean(),
-      title: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      value: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {CreateCustomFormPayload} */
   static CreateCustomFormPayload() {
     return Joi.object({
@@ -553,14 +450,6 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {CustomFormSubmissionPayload} */
-  static CustomFormSubmissionPayload() {
-    return Joi.object({
-      attachments: Joi.array().items(LeadPlatformModel.TicketAsset()),
-      response: Joi.array().items(Joi.any()).required(),
-    });
-  }
-
   /** @returns {Debug} */
   static Debug() {
     return Joi.object({
@@ -652,23 +541,6 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {IntegrationConfig} */
-  static IntegrationConfig() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      allow_ticket_creation: Joi.boolean().required(),
-      base_url: Joi.string().allow(""),
-      category_data: LeadPlatformModel.CategoryData(),
-      category_sync_apikey: Joi.string().allow(""),
-      config_completed: Joi.boolean(),
-      create_ticket_apikey: Joi.string().allow(""),
-      integration_type: Joi.string().allow("").required(),
-      show_listing: Joi.boolean().required(),
-      update_ticket_apikey: Joi.string().allow(""),
-      webhook_apikey: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {NotifyUser} */
   static NotifyUser() {
     return Joi.object({
@@ -747,29 +619,6 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {SubmitCustomFormResponse} */
-  static SubmitCustomFormResponse() {
-    return Joi.object({
-      message: Joi.string().allow("").required(),
-      ticket: LeadPlatformModel.Ticket(),
-    });
-  }
-
-  /** @returns {SupportGeneralConfig} */
-  static SupportGeneralConfig() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      integration: Joi.any(),
-      show_communication_info: Joi.boolean(),
-      show_support_dris: Joi.boolean(),
-      support_communication: LeadPlatformModel.CommunicationDetails(),
-      support_email: LeadPlatformModel.CommunicationDetails(),
-      support_faq: LeadPlatformModel.CommunicationDetails(),
-      support_phone: LeadPlatformModel.CommunicationDetails(),
-      type: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {Ticket} */
   static Ticket() {
     return Joi.object({
@@ -847,14 +696,6 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {TicketFeedbackForm} */
-  static TicketFeedbackForm() {
-    return Joi.object({
-      display: Joi.array().items(Joi.any()),
-      title: Joi.string().allow("").required(),
-    });
-  }
-
   /** @returns {TicketFeedbackList} */
   static TicketFeedbackList() {
     return Joi.object({
@@ -908,15 +749,6 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {TicketSubCategory} */
-  static TicketSubCategory() {
-    return Joi.object({
-      display: Joi.string().allow("").required(),
-      key: Joi.string().allow("").required(),
-      sub_categories: Joi.link("#TicketSubCategory"),
-    }).id("TicketSubCategory");
-  }
-
   /** @returns {UserSchema} */
   static UserSchema() {
     return Joi.object({
@@ -998,21 +830,6 @@ class LeadPlatformModel {
     );
   }
 
-  /**
-   * Enum: TicketIntegrationDetails Used By: Lead
-   *
-   * @returns {TicketIntegrationDetails}
-   */
-  static TicketIntegrationDetails() {
-    return Joi.string().valid(
-      "default",
-
-      "freshdesk",
-
-      "kapture"
-    );
-  }
-
   /**
    * Enum: TicketSourceEnum Used By: Lead
    *

package/sdk/platform/Lead/LeadPlatformValidator.d.ts

@@ -1,6 +1,6 @@
 export = LeadPlatformValidator;
 /**
- * @typedef CreateHistoryParam
+ * @typedef CreatePlatformTicketHistoryParam
  * @property {string} id - Ticket ID for which history is created
  * @property {LeadPlatformModel.TicketHistoryPayload} body
  */
@@ -9,7 +9,7 @@ export = LeadPlatformValidator;
  * @property {LeadPlatformModel.AddTicketPayload} body
  */
 /**
- * @typedef EditTicketParam
+ * @typedef EditPlatformTicketParam
  * @property {string} id - Ticket ID of ticket to be edited
  * @property {LeadPlatformModel.EditTicketPayload} body
  */
@@ -19,15 +19,15 @@ export = LeadPlatformValidator;
  */
 /** @typedef GetGeneralConfigParam */
 /**
- * @typedef GetTicketParam
+ * @typedef GetPlatformTicketParam
  * @property {string} id - Tiket ID of the ticket to be fetched
  */
 /**
- * @typedef GetTicketHistoryParam
+ * @typedef GetPlatformTicketHistoryParam
  * @property {string} id - Ticket ID for which history is to be fetched
  */
 /**
- * @typedef GetTicketsParam
+ * @typedef GetPlatformTicketsParam
  * @property {boolean} [items] - Decides that the reponse will contain the list of tickets
  * @property {boolean} [filters] - Decides that the reponse will contain the
  *   ticket filters
@@ -41,12 +41,12 @@ export = LeadPlatformValidator;
  *   Default is 12.
  */
 /**
- * @typedef GetTokenForVideoRoomParam
- * @property {string} uniqueName - Unique name of video room
+ * @typedef GetPlatformVideoParticipantsParam
+ * @property {string} uniqueName - Unique name of Video Room
  */
 /**
- * @typedef GetVideoParticipantsParam
- * @property {string} uniqueName - Unique name of Video Room
+ * @typedef GetTokenForPlatformVideoRoomParam
+ * @property {string} uniqueName - Unique name of video room
  */
 /**
  * @typedef SubmitFeedbackParam
@@ -54,33 +54,33 @@ export = LeadPlatformValidator;
  * @property {LeadPlatformModel.TicketFeedbackPayload} body
  */
 declare class LeadPlatformValidator {
-    /** @returns {CreateHistoryParam} */
-    static createHistory(): CreateHistoryParam;
+    /** @returns {CreatePlatformTicketHistoryParam} */
+    static createPlatformTicketHistory(): CreatePlatformTicketHistoryParam;
     /** @returns {CreateTicketParam} */
     static createTicket(): CreateTicketParam;
-    /** @returns {EditTicketParam} */
-    static editTicket(): EditTicketParam;
+    /** @returns {EditPlatformTicketParam} */
+    static editPlatformTicket(): EditPlatformTicketParam;
     /** @returns {GetFeedbacksParam} */
     static getFeedbacks(): GetFeedbacksParam;
     /** @returns {GetGeneralConfigParam} */
     static getGeneralConfig(): any;
-    /** @returns {GetTicketParam} */
-    static getTicket(): GetTicketParam;
-    /** @returns {GetTicketHistoryParam} */
-    static getTicketHistory(): GetTicketHistoryParam;
-    /** @returns {GetTicketsParam} */
-    static getTickets(): GetTicketsParam;
-    /** @returns {GetTokenForVideoRoomParam} */
-    static getTokenForVideoRoom(): GetTokenForVideoRoomParam;
-    /** @returns {GetVideoParticipantsParam} */
-    static getVideoParticipants(): GetVideoParticipantsParam;
+    /** @returns {GetPlatformTicketParam} */
+    static getPlatformTicket(): GetPlatformTicketParam;
+    /** @returns {GetPlatformTicketHistoryParam} */
+    static getPlatformTicketHistory(): GetPlatformTicketHistoryParam;
+    /** @returns {GetPlatformTicketsParam} */
+    static getPlatformTickets(): GetPlatformTicketsParam;
+    /** @returns {GetPlatformVideoParticipantsParam} */
+    static getPlatformVideoParticipants(): GetPlatformVideoParticipantsParam;
+    /** @returns {GetTokenForPlatformVideoRoomParam} */
+    static getTokenForPlatformVideoRoom(): GetTokenForPlatformVideoRoomParam;
     /** @returns {SubmitFeedbackParam} */
     static submitFeedback(): SubmitFeedbackParam;
 }
 declare namespace LeadPlatformValidator {
-    export { CreateHistoryParam, CreateTicketParam, EditTicketParam, GetFeedbacksParam, GetGeneralConfigParam, GetTicketParam, GetTicketHistoryParam, GetTicketsParam, GetTokenForVideoRoomParam, GetVideoParticipantsParam, SubmitFeedbackParam };
+    export { CreatePlatformTicketHistoryParam, CreateTicketParam, EditPlatformTicketParam, GetFeedbacksParam, GetGeneralConfigParam, GetPlatformTicketParam, GetPlatformTicketHistoryParam, GetPlatformTicketsParam, GetPlatformVideoParticipantsParam, GetTokenForPlatformVideoRoomParam, SubmitFeedbackParam };
 }
-type CreateHistoryParam = {
+type CreatePlatformTicketHistoryParam = {
     /**
      * - Ticket ID for which history is created
      */
@@ -90,7 +90,7 @@ type CreateHistoryParam = {
 type CreateTicketParam = {
     body: LeadPlatformModel.AddTicketPayload;
 };
-type EditTicketParam = {
+type EditPlatformTicketParam = {
     /**
      * - Ticket ID of ticket to be edited
      */
@@ -103,19 +103,19 @@ type GetFeedbacksParam = {
      */
     id: string;
 };
-type GetTicketParam = {
+type GetPlatformTicketParam = {
     /**
      * - Tiket ID of the ticket to be fetched
      */
     id: string;
 };
-type GetTicketHistoryParam = {
+type GetPlatformTicketHistoryParam = {
     /**
      * - Ticket ID for which history is to be fetched
      */
     id: string;
 };
-type GetTicketsParam = {
+type GetPlatformTicketsParam = {
     /**
      * - Decides that the reponse will contain the list of tickets
      */
@@ -152,15 +152,15 @@ type GetTicketsParam = {
      */
     pageSize?: number;
 };
-type GetTokenForVideoRoomParam = {
+type GetPlatformVideoParticipantsParam = {
     /**
-     * - Unique name of video room
+     * - Unique name of Video Room
      */
     uniqueName: string;
 };
-type GetVideoParticipantsParam = {
+type GetTokenForPlatformVideoRoomParam = {
     /**
-     * - Unique name of Video Room
+     * - Unique name of video room
      */
     uniqueName: string;
 };