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

package/sdk/partner/Lead/LeadPartnerModel.js

@@ -16,7 +16,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.
  */
 
 /**
@@ -33,7 +33,7 @@ const Joi = require("joi");
  * @property {string} [source] - Denotes if the ticket was created at partner or
  *   application level
  * @property {string} [status] - Denotes in what state is the ticket
- * @property {string} [priority]
+ * @property {PriorityEnum} [priority]
  * @property {AgentChangePayload} [assigned_to]
  * @property {string[]} [tags] - Tags relevant to ticket
  */
@@ -44,33 +44,18 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef GeneralConfigResponse
- * @property {string} [_id]
+ * @typedef GeneralConfigDetails
  * @property {SupportCommunicationSchema[]} [support_communication]
- * @property {boolean} [show_communication_info]
- * @property {boolean} [show_support_dris]
  * @property {string} [type]
  * @property {GeneralConfigIntegrationSchema} [integration]
- * @property {boolean} [allow_ticket_creation]
- * @property {boolean} [show_listing]
  * @property {string[]} [available_integration]
- * @property {boolean} [enable_dris]
- * @property {SupportSchema} [support_email]
- * @property {SupportSchema} [support_phone]
- * @property {SupportSchema} [support_faq]
- */
-
-/**
- * @typedef SupportSchema
- * @property {string} [value]
- * @property {string} [description]
- * @property {boolean} [enabled]
  */
 
 /**
  * @typedef SupportCommunicationSchema
  * @property {string} [type]
  * @property {string} [title]
+ * @property {Object} [value]
  * @property {string} [description]
  * @property {boolean} [enabled]
  */
@@ -85,27 +70,24 @@ const Joi = require("joi");
  * @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
  */
 
 /**
  * @typedef TicketHistoryPayload
  * @property {Object} value - Details of history event
- * @property {string} type
+ * @property {HistoryTypeEnum} type
  */
 
 /**
  * @typedef TicketContext
  * @property {string} [application_id] - Application ID related to the ticket
- * @property {string} organization_id - Organization ID related to the ticket
+ * @property {string} partner_id - Partner ID related to the ticket
  */
 
 /**
  * @typedef CreatedOn
  * @property {string} user_agent - Useragent details
- * @property {string} [platform]
  */
 
 /**
@@ -126,7 +108,7 @@ const Joi = require("joi");
  * @typedef AddTicketPayload
  * @property {Object} [created_by] - Creator of the ticket
  * @property {string} [status] - Status of the ticket
- * @property {string} [priority]
+ * @property {PriorityEnum} [priority]
  * @property {string} category - Category of the ticket
  * @property {TicketContent} content
  * @property {Object} [_custom_json] - Optional custom data that needs to be sent
@@ -134,7 +116,7 @@ const Joi = require("joi");
 
 /**
  * @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
  */
@@ -162,7 +144,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]
  */
@@ -177,7 +159,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]
  */
 
 /**
@@ -189,14 +170,13 @@ const Joi = require("joi");
  * @property {TicketContent} [content]
  * @property {TicketCategory} category
  * @property {string} [sub_category] - Sub-category assigned to the ticket
- * @property {string} source
+ * @property {TicketSourceEnum} source
  * @property {Status} status
  * @property {Priority} priority
  * @property {SLA} [sla]
  * @property {Object} [created_by] - User details of ticket creator
  * @property {Object} [assigned_to] - Details of support staff to whom ticket is assigned
  * @property {string[]} [tags] - Tags relevant to ticket
- * @property {string[]} [subscribers]
  * @property {Object} [_custom_json] - Custom json relevant to the ticket
  * @property {boolean} [is_feedback_pending] - Denotes if feedback submission is
  *   pending for the ticket
@@ -204,22 +184,11 @@ 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 {Object[]} [additional_info]
- * @property {string} [ticket_link]
- * @property {number} [__v]
  */
 
-/**
- * @typedef Error4XX
- * @property {Object} [message]
- * @property {string} [stack]
- * @property {string} [sentry]
- */
+/** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
 
-/**
- * @typedef NotFoundError
- * @property {string} [message]
- */
+/** @typedef {"rating" | "log" | "comment"} HistoryTypeEnum */
 
 /**
  * @typedef {| "image"
@@ -233,6 +202,8 @@ const Joi = require("joi");
  *   | "order"} TicketAssetTypeEnum
  */
 
+/** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
+
 class LeadPartnerModel {
   /** @returns {TicketList} */
   static TicketList() {
@@ -253,7 +224,7 @@ class LeadPartnerModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
-      total: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 
@@ -273,7 +244,7 @@ class LeadPartnerModel {
       sub_category: Joi.string().allow(""),
       source: Joi.string().allow(""),
       status: Joi.string().allow(""),
-      priority: Joi.string().allow(""),
+      priority: LeadPartnerModel.PriorityEnum(),
       assigned_to: LeadPartnerModel.AgentChangePayload(),
       tags: Joi.array().items(Joi.string().allow("")),
     });
@@ -286,33 +257,15 @@ class LeadPartnerModel {
     });
   }
 
-  /** @returns {GeneralConfigResponse} */
-  static GeneralConfigResponse() {
+  /** @returns {GeneralConfigDetails} */
+  static GeneralConfigDetails() {
     return Joi.object({
-      _id: Joi.string().allow(""),
       support_communication: Joi.array().items(
         LeadPartnerModel.SupportCommunicationSchema()
       ),
-      show_communication_info: Joi.boolean(),
-      show_support_dris: Joi.boolean(),
       type: Joi.string().allow(""),
       integration: LeadPartnerModel.GeneralConfigIntegrationSchema(),
-      allow_ticket_creation: Joi.boolean(),
-      show_listing: Joi.boolean(),
       available_integration: Joi.array().items(Joi.string().allow("")),
-      enable_dris: Joi.boolean(),
-      support_email: LeadPartnerModel.SupportSchema(),
-      support_phone: LeadPartnerModel.SupportSchema(),
-      support_faq: LeadPartnerModel.SupportSchema(),
-    });
-  }
-
-  /** @returns {SupportSchema} */
-  static SupportSchema() {
-    return Joi.object({
-      value: Joi.string().allow(""),
-      description: Joi.string().allow(""),
-      enabled: Joi.boolean(),
     });
   }
 
@@ -321,6 +274,7 @@ class LeadPartnerModel {
     return Joi.object({
       type: Joi.string().allow(""),
       title: Joi.string().allow(""),
+      value: Joi.object().pattern(/\S/, Joi.any()),
       description: Joi.string().allow(""),
       enabled: Joi.boolean(),
     });
@@ -339,8 +293,7 @@ class LeadPartnerModel {
       priorities: Joi.array().items(LeadPartnerModel.Priority()).required(),
       categories: Joi.array().items(LeadPartnerModel.TicketCategory()),
       statuses: Joi.array().items(LeadPartnerModel.Status()).required(),
-      assignees: Joi.array().items(Joi.any()),
-      all_categories: Joi.object().pattern(/\S/, Joi.any()),
+      assignees: Joi.array().items(Joi.any()).required(),
     });
   }
 
@@ -348,7 +301,7 @@ class LeadPartnerModel {
   static TicketHistoryPayload() {
     return Joi.object({
       value: Joi.object().pattern(/\S/, Joi.any()).required(),
-      type: Joi.string().allow("").required(),
+      type: LeadPartnerModel.HistoryTypeEnum().required(),
     });
   }
 
@@ -356,7 +309,7 @@ class LeadPartnerModel {
   static TicketContext() {
     return Joi.object({
       application_id: Joi.string().allow(""),
-      organization_id: Joi.string().allow("").required(),
+      partner_id: Joi.string().allow("").required(),
     });
   }
 
@@ -364,7 +317,6 @@ class LeadPartnerModel {
   static CreatedOn() {
     return Joi.object({
       user_agent: Joi.string().allow("").required(),
-      platform: Joi.string().allow(""),
     });
   }
 
@@ -389,19 +341,19 @@ class LeadPartnerModel {
   /** @returns {AddTicketPayload} */
   static AddTicketPayload() {
     return Joi.object({
-      created_by: Joi.any(),
+      created_by: Joi.object().pattern(/\S/, Joi.any()),
       status: Joi.string().allow(""),
-      priority: Joi.string().allow(""),
+      priority: LeadPartnerModel.PriorityEnum(),
       category: Joi.string().allow("").required(),
       content: LeadPartnerModel.TicketContent().required(),
-      _custom_json: Joi.any(),
+      _custom_json: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
   /** @returns {Priority} */
   static Priority() {
     return Joi.object({
-      key: Joi.string().allow("").required(),
+      key: LeadPartnerModel.PriorityEnum().required(),
       display: Joi.string().allow("").required(),
       color: Joi.string().allow("").required(),
     });
@@ -426,9 +378,9 @@ class LeadPartnerModel {
   /** @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()),
     });
   }
 
@@ -437,7 +389,7 @@ class LeadPartnerModel {
     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: LeadPartnerModel.FeedbackForm(),
     }).id("TicketCategory");
@@ -454,7 +406,6 @@ class LeadPartnerModel {
       _id: Joi.string().allow("").required(),
       updated_at: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
-      __v: Joi.number(),
     });
   }
 
@@ -467,40 +418,52 @@ class LeadPartnerModel {
       content: LeadPartnerModel.TicketContent(),
       category: LeadPartnerModel.TicketCategory().required(),
       sub_category: Joi.string().allow(""),
-      source: Joi.string().allow("").required(),
+      source: LeadPartnerModel.TicketSourceEnum().required(),
       status: LeadPartnerModel.Status().required(),
       priority: LeadPartnerModel.Priority().required(),
       sla: LeadPartnerModel.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("")),
-      subscribers: 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(""),
-      additional_info: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
-      ticket_link: Joi.string().allow(""),
-      __v: Joi.number(),
     });
   }
 
-  /** @returns {Error4XX} */
-  static Error4XX() {
-    return Joi.object({
-      message: Joi.object().pattern(/\S/, Joi.any()),
-      stack: Joi.string().allow(""),
-      sentry: Joi.string().allow(""),
-    });
+  /**
+   * Enum: PriorityEnum Used By: Lead
+   *
+   * @returns {PriorityEnum}
+   */
+  static PriorityEnum() {
+    return Joi.string().valid(
+      "low",
+
+      "medium",
+
+      "high",
+
+      "urgent"
+    );
   }
 
-  /** @returns {NotFoundError} */
-  static NotFoundError() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
+  /**
+   * Enum: HistoryTypeEnum Used By: Lead
+   *
+   * @returns {HistoryTypeEnum}
+   */
+  static HistoryTypeEnum() {
+    return Joi.string().valid(
+      "rating",
+
+      "log",
+
+      "comment"
+    );
   }
 
   /**
@@ -529,5 +492,18 @@ class LeadPartnerModel {
       "order"
     );
   }
+
+  /**
+   * Enum: TicketSourceEnum Used By: Lead
+   *
+   * @returns {TicketSourceEnum}
+   */
+  static TicketSourceEnum() {
+    return Joi.string().valid(
+      "platform_panel",
+
+      "sales_channel"
+    );
+  }
 }
 module.exports = LeadPartnerModel;

package/sdk/partner/Lead/LeadPartnerValidator.js

@@ -8,7 +8,7 @@ class LeadValidator {
       filters: Joi.boolean(),
       q: Joi.string().allow(""),
       status: Joi.string().allow(""),
-      priority: Joi.string().allow(""),
+      priority: LeadModel.PriorityEnum(),
       category: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),