@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/platform/Lead/LeadPlatformModel.js

@@ -1,7 +1,7 @@
 const Joi = require("joi");
 
 /**
- * @typedef GeneralConfigResponse
+ * @typedef GeneralConfigDetails
  * @property {string} [_id]
  * @property {SupportCommunicationSchema[]} [support_communication]
  * @property {boolean} [show_communication_info]
@@ -18,16 +18,16 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef SupportSchema
- * @property {string} [value]
+ * @typedef SupportCommunicationSchema
+ * @property {string} [type]
+ * @property {string} [title]
  * @property {string} [description]
  * @property {boolean} [enabled]
  */
 
 /**
- * @typedef SupportCommunicationSchema
- * @property {string} [type]
- * @property {string} [title]
+ * @typedef SupportSchema
+ * @property {string} [value]
  * @property {string} [description]
  * @property {boolean} [enabled]
  */
@@ -53,7 +53,7 @@ const Joi = require("joi");
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
- * @property {number} [total] - Total number of items.
+ * @property {number} [page_size] - The number of items per page.
  */
 
 /**
@@ -75,7 +75,7 @@ const Joi = require("joi");
  * @property {Object[]} inputs - List of all the form components
  * @property {string} [description] - Description of the form
  * @property {string} [header_image] - Header image that is to be shown for the form
- * @property {string} priority
+ * @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
@@ -87,7 +87,8 @@ const Joi = require("joi");
  * @property {string} title - Title for the form
  * @property {Object[]} inputs - List of all the form components
  * @property {string} [description] - Description of the form
- * @property {string} priority
+ * @property {PriorityEnum} priority
+ * @property {string} [header_image] - Header image that is to be shown for the form
  * @property {boolean} [should_notify] - Indicates if staff should be notified
  *   when a response is received
  * @property {boolean} [login_required] - Denotes if login is required to make a
@@ -114,20 +115,12 @@ const Joi = require("joi");
  * @property {string} agent_id - Agent's unique ID
  */
 
-/**
- * @typedef NotifyUser
- * @property {string} country_code - Country code
- * @property {string} phone_number - Phone number
- */
-
 /**
  * @typedef Filter
  * @property {Priority[]} priorities - List of possible priorities for tickets
  * @property {TicketCategory[]} [categories] - List of possible categories for tickets
  * @property {Status[]} statuses - List of possible statuses for tickets
- * @property {Object[]} [assignees] - List of support staff availble for tickets
- *   assignment
- * @property {Object} [all_categories]
+ * @property {Object[]} assignees - List of support staff availble for tickets assignment
  */
 
 /**
@@ -145,7 +138,6 @@ const Joi = require("joi");
 /**
  * @typedef CreatedOn
  * @property {string} user_agent - Useragent details
- * @property {string} [platform]
  */
 
 /**
@@ -162,28 +154,19 @@ const Joi = require("joi");
  * @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
  */
 
-/**
- * @typedef AdditionalInfoSchema
- * @property {string} [display_name] - Display name for additional info
- * @property {string} [display_value] - Display value for additional info
- * @property {number} [priority] - Priority for additional info
- */
-
 /**
  * @typedef AddTicketPayload
  * @property {Object} [created_by] - Creator of the ticket
  * @property {string} [status] - Status of the ticket
  * @property {PriorityEnum} [priority]
  * @property {string} category - Category of the ticket
- * @property {AdditionalInfoSchema[]} [additional_info]
  * @property {TicketContent} content
  * @property {Object} [_custom_json] - Optional custom data that needs to be sent
- * @property {string[]} [subscribers]
  */
 
 /**
  * @typedef Priority
- * @property {string} key - Priority value of the ticket like urgent, low, medium, high.
+ * @property {PriorityEnum} key
  * @property {string} display - Display text for priority
  * @property {string} color - Color for priority
  */
@@ -233,6 +216,7 @@ const Joi = require("joi");
  * @property {string} [header_image] - Form header image that will be shown to the user
  * @property {string} title - Form title that will be shown to the user
  * @property {string} [description] - Form description that will be shown to the user
+ * @property {Priority} priority
  * @property {boolean} login_required - Denotes if login is required to make a
  *   form response submission
  * @property {boolean} should_notify - Denotes if new response submission for
@@ -243,12 +227,7 @@ const Joi = require("joi");
  * @property {Object[]} inputs - List of all the form fields
  * @property {CreatedOn} [created_on]
  * @property {PollForAssignment} [poll_for_assignment]
- * @property {string[]} [available_assignees]
  * @property {string} _id - Unique identifier for the form
- * @property {string} [created_at]
- * @property {string} [updated_at]
- * @property {number} [__v]
- * @property {string} [created_by]
  */
 
 /**
@@ -262,7 +241,7 @@ const Joi = require("joi");
  * @typedef TicketCategory
  * @property {string} display - Category display value identifier
  * @property {string} key - Category key value identifier
- * @property {TicketCategory[]} [sub_categories]
+ * @property {TicketCategory} [sub_categories]
  * @property {number} [group_id] - Group id of category releted data
  * @property {FeedbackForm} [feedback_form]
  */
@@ -271,6 +250,7 @@ const Joi = require("joi");
  * @typedef FeedbackResponseItem
  * @property {string} display - Question/Title of the form field
  * @property {string} key - Key of the form field
+ * @property {string} value - User response value for the form field
  */
 
 /**
@@ -283,7 +263,6 @@ const Joi = require("joi");
  * @property {Object} [user] - User who submitted the feedback
  * @property {string} [updated_at] - Time when the feedback was last updated
  * @property {string} [created_at] - Time when the feedback was created
- * @property {number} [__v]
  */
 
 /**
@@ -296,7 +275,6 @@ const Joi = require("joi");
  * @property {string} _id - Unique identifier of the history event
  * @property {string} [updated_at] - Time of last update of the history event
  * @property {string} [created_at] - Time of creation of the history event
- * @property {number} [__v]
  */
 
 /**
@@ -322,25 +300,17 @@ const Joi = require("joi");
  * @property {string} _id - Unique identifier for the ticket
  * @property {string} [updated_at] - Time when the ticket was last updated
  * @property {string} [created_at] - Time when the ticket was created
- * @property {string} [video_room_id]
- * @property {string[]} [subscribers]
- * @property {AdditionalInfoSchema[]} [additional_info]
- * @property {number} [__v]
- * @property {TicketAsset[]} [attachments] - List of all attachments related to the form
- */
-
-/**
- * @typedef Error4XX
- * @property {Object} [message]
- * @property {string} [stack]
- * @property {string} [sentry]
  */
 
 /**
- * @typedef NotFoundError
+ * @typedef ErrorMessage
  * @property {string} [message]
  */
 
+/** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
+
+/** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
+
 /**
  * @typedef {| "image"
  *   | "video"
@@ -353,15 +323,11 @@ const Joi = require("joi");
  *   | "order"} TicketAssetTypeEnum
  */
 
-/** @typedef {"high" | "low" | "medium" | "urgent"} PriorityEnum */
-
-/** @typedef {"rating" | "log" | "comment" | "diff" | "thread"} HistoryTypeEnum */
-
-/** @typedef {"platform_panel" | "sales_channel" | "partner_panel"} TicketSourceEnum */
+/** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
 
 class LeadPlatformModel {
-  /** @returns {GeneralConfigResponse} */
-  static GeneralConfigResponse() {
+  /** @returns {GeneralConfigDetails} */
+  static GeneralConfigDetails() {
     return Joi.object({
       _id: Joi.string().allow(""),
       support_communication: Joi.array().items(
@@ -381,20 +347,20 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {SupportSchema} */
-  static SupportSchema() {
+  /** @returns {SupportCommunicationSchema} */
+  static SupportCommunicationSchema() {
     return Joi.object({
-      value: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      title: Joi.string().allow(""),
       description: Joi.string().allow(""),
       enabled: Joi.boolean(),
     });
   }
 
-  /** @returns {SupportCommunicationSchema} */
-  static SupportCommunicationSchema() {
+  /** @returns {SupportSchema} */
+  static SupportSchema() {
     return Joi.object({
-      type: Joi.string().allow(""),
-      title: Joi.string().allow(""),
+      value: Joi.string().allow(""),
       description: Joi.string().allow(""),
       enabled: Joi.boolean(),
     });
@@ -426,7 +392,7 @@ class LeadPlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
-      total: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 
@@ -454,7 +420,7 @@ class LeadPlatformModel {
       inputs: Joi.array().items(Joi.any()).required(),
       description: Joi.string().allow(""),
       header_image: Joi.string().allow(""),
-      priority: Joi.string().allow("").required(),
+      priority: LeadPlatformModel.PriorityEnum().required(),
       should_notify: Joi.boolean(),
       success_message: Joi.string().allow(""),
       poll_for_assignment: LeadPlatformModel.PollForAssignment(),
@@ -467,7 +433,8 @@ class LeadPlatformModel {
       title: Joi.string().allow("").required(),
       inputs: Joi.array().items(Joi.any()).required(),
       description: Joi.string().allow(""),
-      priority: Joi.string().allow("").required(),
+      priority: LeadPlatformModel.PriorityEnum().required(),
+      header_image: Joi.string().allow(""),
       should_notify: Joi.boolean(),
       login_required: Joi.boolean(),
       success_message: Joi.string().allow(""),
@@ -496,22 +463,13 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {NotifyUser} */
-  static NotifyUser() {
-    return Joi.object({
-      country_code: Joi.string().allow("").required(),
-      phone_number: Joi.string().allow("").required(),
-    });
-  }
-
   /** @returns {Filter} */
   static Filter() {
     return Joi.object({
       priorities: Joi.array().items(LeadPlatformModel.Priority()).required(),
       categories: Joi.array().items(LeadPlatformModel.TicketCategory()),
       statuses: Joi.array().items(LeadPlatformModel.Status()).required(),
-      assignees: Joi.array().items(Joi.any()),
-      all_categories: Joi.object().pattern(/\S/, Joi.any()),
+      assignees: Joi.array().items(Joi.any()).required(),
     });
   }
 
@@ -535,7 +493,6 @@ class LeadPlatformModel {
   static CreatedOn() {
     return Joi.object({
       user_agent: Joi.string().allow("").required(),
-      platform: Joi.string().allow(""),
     });
   }
 
@@ -557,35 +514,22 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {AdditionalInfoSchema} */
-  static AdditionalInfoSchema() {
-    return Joi.object({
-      display_name: Joi.string().allow(""),
-      display_value: Joi.string().allow(""),
-      priority: Joi.number(),
-    });
-  }
-
   /** @returns {AddTicketPayload} */
   static AddTicketPayload() {
     return Joi.object({
-      created_by: Joi.any(),
+      created_by: Joi.object().pattern(/\S/, Joi.any()),
       status: Joi.string().allow(""),
       priority: LeadPlatformModel.PriorityEnum(),
       category: Joi.string().allow("").required(),
-      additional_info: Joi.array().items(
-        LeadPlatformModel.AdditionalInfoSchema()
-      ),
       content: LeadPlatformModel.TicketContent().required(),
-      _custom_json: Joi.any(),
-      subscribers: Joi.array().items(Joi.string().allow("")),
+      _custom_json: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
   /** @returns {Priority} */
   static Priority() {
     return Joi.object({
-      key: Joi.string().allow("").required(),
+      key: LeadPlatformModel.PriorityEnum().required(),
       display: Joi.string().allow("").required(),
       color: Joi.string().allow("").required(),
     });
@@ -617,7 +561,7 @@ class LeadPlatformModel {
   /** @returns {TicketFeedbackPayload} */
   static TicketFeedbackPayload() {
     return Joi.object({
-      form_response: Joi.any(),
+      form_response: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -648,6 +592,7 @@ class LeadPlatformModel {
       header_image: Joi.string().allow(""),
       title: Joi.string().allow("").required(),
       description: Joi.string().allow(""),
+      priority: LeadPlatformModel.Priority().required(),
       login_required: Joi.boolean().required(),
       should_notify: Joi.boolean().required(),
       success_message: Joi.string().allow(""),
@@ -655,21 +600,16 @@ class LeadPlatformModel {
       inputs: Joi.array().items(Joi.any()).required(),
       created_on: LeadPlatformModel.CreatedOn(),
       poll_for_assignment: LeadPlatformModel.PollForAssignment(),
-      available_assignees: Joi.array().items(Joi.string().allow("")),
       _id: Joi.string().allow("").required(),
-      created_at: Joi.string().allow(""),
-      updated_at: Joi.string().allow(""),
-      __v: Joi.number(),
-      created_by: Joi.string().allow(""),
     });
   }
 
   /** @returns {FeedbackForm} */
   static FeedbackForm() {
     return Joi.object({
-      inputs: Joi.any(),
+      inputs: Joi.object().pattern(/\S/, Joi.any()),
       title: Joi.string().allow(""),
-      timestamps: Joi.any(),
+      timestamps: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -678,7 +618,7 @@ class LeadPlatformModel {
     return Joi.object({
       display: Joi.string().allow("").required(),
       key: Joi.string().allow("").required(),
-      sub_categories: Joi.array().items(Joi.link("#TicketCategory")),
+      sub_categories: Joi.link("#TicketCategory"),
       group_id: Joi.number(),
       feedback_form: LeadPlatformModel.FeedbackForm(),
     }).id("TicketCategory");
@@ -689,6 +629,7 @@ class LeadPlatformModel {
     return Joi.object({
       display: Joi.string().allow("").required(),
       key: Joi.string().allow("").required(),
+      value: Joi.string().allow("").required(),
     });
   }
 
@@ -702,10 +643,9 @@ class LeadPlatformModel {
         .items(LeadPlatformModel.FeedbackResponseItem())
         .required(),
       category: Joi.string().allow(""),
-      user: Joi.any(),
+      user: Joi.object().pattern(/\S/, Joi.any()),
       updated_at: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
-      __v: Joi.number(),
     });
   }
 
@@ -720,7 +660,6 @@ class LeadPlatformModel {
       _id: Joi.string().allow("").required(),
       updated_at: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
-      __v: Joi.number(),
     });
   }
 
@@ -737,68 +676,25 @@ class LeadPlatformModel {
       status: LeadPlatformModel.Status().required(),
       priority: LeadPlatformModel.Priority().required(),
       sla: LeadPlatformModel.SLA(),
-      created_by: Joi.any(),
-      assigned_to: Joi.any(),
+      created_by: Joi.object().pattern(/\S/, Joi.any()),
+      assigned_to: Joi.object().pattern(/\S/, Joi.any()),
       tags: Joi.array().items(Joi.string().allow("")),
-      _custom_json: Joi.any(),
+      _custom_json: Joi.object().pattern(/\S/, Joi.any()),
       is_feedback_pending: Joi.boolean(),
-      integration: Joi.any(),
+      integration: Joi.object().pattern(/\S/, Joi.any()),
       _id: Joi.string().allow("").required(),
       updated_at: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
-      video_room_id: Joi.string().allow(""),
-      subscribers: Joi.array().items(Joi.string().allow("")),
-      additional_info: Joi.array().items(
-        LeadPlatformModel.AdditionalInfoSchema()
-      ),
-      __v: Joi.number(),
-      attachments: Joi.array().items(LeadPlatformModel.TicketAsset()),
-    });
-  }
-
-  /** @returns {Error4XX} */
-  static Error4XX() {
-    return Joi.object({
-      message: Joi.object().pattern(/\S/, Joi.any()),
-      stack: Joi.string().allow(""),
-      sentry: Joi.string().allow(""),
     });
   }
 
-  /** @returns {NotFoundError} */
-  static NotFoundError() {
+  /** @returns {ErrorMessage} */
+  static ErrorMessage() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
 
-  /**
-   * Enum: TicketAssetTypeEnum Used By: Lead
-   *
-   * @returns {TicketAssetTypeEnum}
-   */
-  static TicketAssetTypeEnum() {
-    return Joi.string().valid(
-      "image",
-
-      "video",
-
-      "file",
-
-      "youtube",
-
-      "product",
-
-      "collection",
-
-      "brand",
-
-      "shipment",
-
-      "order"
-    );
-  }
-
   /**
    * Enum: PriorityEnum Used By: Lead
    *
@@ -806,12 +702,12 @@ class LeadPlatformModel {
    */
   static PriorityEnum() {
     return Joi.string().valid(
-      "high",
-
       "low",
 
       "medium",
 
+      "high",
+
       "urgent"
     );
   }
@@ -829,12 +725,37 @@ class LeadPlatformModel {
 
       "comment",
 
-      "diff",
-
       "thread"
     );
   }
 
+  /**
+   * Enum: TicketAssetTypeEnum Used By: Lead
+   *
+   * @returns {TicketAssetTypeEnum}
+   */
+  static TicketAssetTypeEnum() {
+    return Joi.string().valid(
+      "image",
+
+      "video",
+
+      "file",
+
+      "youtube",
+
+      "product",
+
+      "collection",
+
+      "brand",
+
+      "shipment",
+
+      "order"
+    );
+  }
+
   /**
    * Enum: TicketSourceEnum Used By: Lead
    *
@@ -844,9 +765,7 @@ class LeadPlatformModel {
     return Joi.string().valid(
       "platform_panel",
 
-      "sales_channel",
-
-      "partner_panel"
+      "sales_channel"
     );
   }
 }

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

@@ -13,6 +13,10 @@ export = LeadPlatformValidator;
  * @property {string} id - Ticket ID of ticket to be edited
  * @property {LeadPlatformModel.EditTicketPayload} body
  */
+/**
+ * @typedef GetFeedbacksParam
+ * @property {string} id - Ticket ID for which feedbacks are to be fetched
+ */
 /** @typedef GetGeneralConfigParam */
 /**
  * @typedef GetPlatformTicketParam
@@ -29,13 +33,18 @@ export = LeadPlatformValidator;
  *   ticket filters
  * @property {string} [q] - Search through ticket titles and description
  * @property {string} [status] - Filter tickets on status
- * @property {string} [priority] - Filter tickets on priority
+ * @property {LeadPlatformModel.PriorityEnum} [priority] - Filter tickets on priority
  * @property {string} [category] - Filter tickets on category
  * @property {number} [pageNo] - The page number to navigate through the given
  *   set of results.
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 12.
  */
+/**
+ * @typedef SubmitFeedbackParam
+ * @property {string} id - Ticket ID for which feedback is to be submitted
+ * @property {LeadPlatformModel.TicketFeedbackPayload} body
+ */
 declare class LeadPlatformValidator {
     /** @returns {CreatePlatformTicketHistoryParam} */
     static createPlatformTicketHistory(): CreatePlatformTicketHistoryParam;
@@ -43,6 +52,8 @@ declare class LeadPlatformValidator {
     static createTicket(): CreateTicketParam;
     /** @returns {EditPlatformTicketParam} */
     static editPlatformTicket(): EditPlatformTicketParam;
+    /** @returns {GetFeedbacksParam} */
+    static getFeedbacks(): GetFeedbacksParam;
     /** @returns {GetGeneralConfigParam} */
     static getGeneralConfig(): any;
     /** @returns {GetPlatformTicketParam} */
@@ -51,9 +62,11 @@ declare class LeadPlatformValidator {
     static getPlatformTicketHistory(): GetPlatformTicketHistoryParam;
     /** @returns {GetPlatformTicketsParam} */
     static getPlatformTickets(): GetPlatformTicketsParam;
+    /** @returns {SubmitFeedbackParam} */
+    static submitFeedback(): SubmitFeedbackParam;
 }
 declare namespace LeadPlatformValidator {
-    export { CreatePlatformTicketHistoryParam, CreateTicketParam, EditPlatformTicketParam, GetGeneralConfigParam, GetPlatformTicketParam, GetPlatformTicketHistoryParam, GetPlatformTicketsParam };
+    export { CreatePlatformTicketHistoryParam, CreateTicketParam, EditPlatformTicketParam, GetFeedbacksParam, GetGeneralConfigParam, GetPlatformTicketParam, GetPlatformTicketHistoryParam, GetPlatformTicketsParam, SubmitFeedbackParam };
 }
 type CreatePlatformTicketHistoryParam = {
     /**
@@ -72,6 +85,12 @@ type EditPlatformTicketParam = {
     id: string;
     body: LeadPlatformModel.EditTicketPayload;
 };
+type GetFeedbacksParam = {
+    /**
+     * - Ticket ID for which feedbacks are to be fetched
+     */
+    id: string;
+};
 type GetPlatformTicketParam = {
     /**
      * - Tiket ID of the ticket to be fetched
@@ -105,7 +124,7 @@ type GetPlatformTicketsParam = {
     /**
      * - Filter tickets on priority
      */
-    priority?: string;
+    priority?: LeadPlatformModel.PriorityEnum;
     /**
      * - Filter tickets on category
      */
@@ -121,5 +140,12 @@ type GetPlatformTicketsParam = {
      */
     pageSize?: number;
 };
+type SubmitFeedbackParam = {
+    /**
+     * - Ticket ID for which feedback is to be submitted
+     */
+    id: string;
+    body: LeadPlatformModel.TicketFeedbackPayload;
+};
 type GetGeneralConfigParam = any;
 import LeadPlatformModel = require("./LeadPlatformModel");