@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15

package/sdk/partner/Lead/LeadPartnerClient.js

@@ -21,7 +21,7 @@ class Lead {
    * @returns {Promise<LeadPartnerModel.TicketList>} - Success response
    * @name getTickets
    * @summary: Gets the list of partner level tickets and/or ticket filters depending on query params
-   * @description: Gets the list of partner level tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTickets/).
+   * @description: Gets the list of partner level tickets and/or ticket filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getTickets/).
    */
   async getTickets(
     {
@@ -178,7 +178,7 @@ class Lead {
    * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
    * @name createTicket
    * @summary: Creates a partner level ticket
-   * @description: Creates a partner level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/createTicket/).
+   * @description: Creates a partner level ticket - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/createTicket/).
    */
   async createTicket(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -253,7 +253,7 @@ class Lead {
    * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
    * @name getTicket
    * @summary: Retreives ticket details of a partner level ticket with ticket ID
-   * @description: Retreives ticket details of a partner level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTicket/).
+   * @description: Retreives ticket details of a partner level ticket - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getTicket/).
    */
   async getTicket(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -328,7 +328,7 @@ class Lead {
    * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
    * @name editTicket
    * @summary: Edits ticket details of a partner level ticket
-   * @description: Edits ticket details of a partner level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/editTicket/).
+   * @description: Edits ticket details of a partner level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/editTicket/).
    */
   async editTicket(
     { id, body, requestHeaders } = { requestHeaders: {} },
@@ -405,7 +405,7 @@ class Lead {
    * @returns {Promise<LeadPartnerModel.TicketHistory>} - Success response
    * @name createHistory
    * @summary: Create history for specific partner level ticket
-   * @description: Create history for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/createHistory/).
+   * @description: Create history for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/createHistory/).
    */
   async createHistory(
     { id, body, requestHeaders } = { requestHeaders: {} },
@@ -482,7 +482,7 @@ class Lead {
    * @returns {Promise<LeadPartnerModel.TicketHistoryList>} - Success response
    * @name getTicketHistory
    * @summary: Gets history list for specific partner level ticket
-   * @description: Gets history list for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTicketHistory/).
+   * @description: Gets history list for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getTicketHistory/).
    */
   async getTicketHistory(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -556,10 +556,10 @@ class Lead {
    * @param {LeadPartnerValidator.GetGeneralConfigParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<LeadPartnerModel.GeneralConfigResponse>} - Success response
+   * @returns {Promise<LeadPartnerModel.GeneralConfigDetails>} - Success response
    * @name getGeneralConfig
    * @summary: Get general support configuration
-   * @description: Get general support configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getGeneralConfig/).
+   * @description: Get general support configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getGeneralConfig/).
    */
   async getGeneralConfig(
     { requestHeaders } = { requestHeaders: {} },
@@ -606,7 +606,7 @@ class Lead {
 
     const {
       error: res_error,
-    } = LeadPartnerModel.GeneralConfigResponse().validate(responseData, {
+    } = LeadPartnerModel.GeneralConfigDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

package/sdk/partner/Lead/LeadPartnerModel.d.ts

@@ -7,13 +7,14 @@ export = LeadPartnerModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
  * @property {number} [current] - The current page number.
- * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [page_size] - The number of items per page.
  */
 /**
  * @typedef TicketHistoryList
@@ -37,7 +38,7 @@ export = LeadPartnerModel;
  * @property {string} agent_id - Agent's unique ID
  */
 /**
- * @typedef GeneralConfigResponse
+ * @typedef GeneralConfigDetails
  * @property {SupportCommunicationSchema[]} [support_communication]
  * @property {string} [type]
  * @property {GeneralConfigIntegrationSchema} [integration]
@@ -179,7 +180,7 @@ export = LeadPartnerModel;
 declare class LeadPartnerModel {
 }
 declare namespace LeadPartnerModel {
-    export { TicketList, Page, TicketHistoryList, EditTicketPayload, AgentChangePayload, GeneralConfigResponse, SupportCommunicationSchema, GeneralConfigIntegrationSchema, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, SLA, Status, FeedbackForm, TicketCategory, TicketHistory, Ticket, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
+    export { TicketList, Page, TicketHistoryList, EditTicketPayload, AgentChangePayload, GeneralConfigDetails, SupportCommunicationSchema, GeneralConfigIntegrationSchema, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, SLA, Status, FeedbackForm, TicketCategory, TicketHistory, Ticket, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
 }
 /** @returns {TicketList} */
 declare function TicketList(): TicketList;
@@ -195,7 +196,7 @@ type TicketList = {
 declare function Page(): Page;
 type Page = {
     /**
-     * - The total number of items on the page.
+     * - The total number of all items across all pages.
      */
     item_total?: number;
     /**
@@ -215,13 +216,17 @@ type Page = {
      */
     current?: number;
     /**
-     * - The type of the page, such as 'PageType'.
+     * - The type of the page, can be 'cursor' or 'number'.
      */
     type: string;
     /**
      * - The number of items per page.
      */
     size?: number;
+    /**
+     * - The number of items per page.
+     */
+    page_size?: number;
 };
 /** @returns {TicketHistoryList} */
 declare function TicketHistoryList(): TicketHistoryList;
@@ -268,9 +273,9 @@ type AgentChangePayload = {
      */
     agent_id: string;
 };
-/** @returns {GeneralConfigResponse} */
-declare function GeneralConfigResponse(): GeneralConfigResponse;
-type GeneralConfigResponse = {
+/** @returns {GeneralConfigDetails} */
+declare function GeneralConfigDetails(): GeneralConfigDetails;
+type GeneralConfigDetails = {
     support_communication?: SupportCommunicationSchema[];
     type?: string;
     integration?: GeneralConfigIntegrationSchema;

package/sdk/partner/Lead/LeadPartnerModel.js

@@ -9,13 +9,14 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
  * @property {number} [current] - The current page number.
- * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [page_size] - The number of items per page.
  */
 
 /**
@@ -43,7 +44,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef GeneralConfigResponse
+ * @typedef GeneralConfigDetails
  * @property {SupportCommunicationSchema[]} [support_communication]
  * @property {string} [type]
  * @property {GeneralConfigIntegrationSchema} [integration]
@@ -223,6 +224,7 @@ class LeadPartnerModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 
@@ -255,8 +257,8 @@ class LeadPartnerModel {
     });
   }
 
-  /** @returns {GeneralConfigResponse} */
-  static GeneralConfigResponse() {
+  /** @returns {GeneralConfigDetails} */
+  static GeneralConfigDetails() {
     return Joi.object({
       support_communication: Joi.array().items(
         LeadPartnerModel.SupportCommunicationSchema()
@@ -272,7 +274,7 @@ class LeadPartnerModel {
     return Joi.object({
       type: Joi.string().allow(""),
       title: Joi.string().allow(""),
-      value: Joi.any(),
+      value: Joi.object().pattern(/\S/, Joi.any()),
       description: Joi.string().allow(""),
       enabled: Joi.boolean(),
     });
@@ -298,7 +300,7 @@ class LeadPartnerModel {
   /** @returns {TicketHistoryPayload} */
   static TicketHistoryPayload() {
     return Joi.object({
-      value: Joi.any().required(),
+      value: Joi.object().pattern(/\S/, Joi.any()).required(),
       type: LeadPartnerModel.HistoryTypeEnum().required(),
     });
   }
@@ -339,12 +341,12 @@ 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: LeadPartnerModel.PriorityEnum(),
       category: Joi.string().allow("").required(),
       content: LeadPartnerModel.TicketContent().required(),
-      _custom_json: Joi.any(),
+      _custom_json: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -376,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()),
     });
   }
 
@@ -397,10 +399,10 @@ class LeadPartnerModel {
   static TicketHistory() {
     return Joi.object({
       type: Joi.string().allow("").required(),
-      value: Joi.any().required(),
+      value: Joi.object().pattern(/\S/, Joi.any()).required(),
       ticket_id: Joi.string().allow("").required(),
       created_on: LeadPartnerModel.CreatedOn(),
-      created_by: Joi.any(),
+      created_by: Joi.object().pattern(/\S/, Joi.any()),
       _id: Joi.string().allow("").required(),
       updated_at: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
@@ -420,12 +422,12 @@ class LeadPartnerModel {
       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("")),
-      _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(""),