@gofynd/fdk-client-javascript 1.4.6 → 1.4.8-beta.2

package/sdk/platform/Lead/LeadPlatformModel.js

@@ -1,5 +1,42 @@
 const Joi = require("joi");
 
+/**
+ * @typedef GeneralConfigResponse
+ * @property {string} [_id]
+ * @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 SupportCommunicationSchema
+ * @property {string} [type]
+ * @property {string} [title]
+ * @property {string} [description]
+ * @property {boolean} [enabled]
+ */
+
+/**
+ * @typedef SupportSchema
+ * @property {string} [value]
+ * @property {string} [description]
+ * @property {boolean} [enabled]
+ */
+
+/**
+ * @typedef GeneralConfigIntegrationSchema
+ * @property {string} [type]
+ */
+
 /**
  * @typedef TicketList
  * @property {Ticket[]} [items] - List of tickets
@@ -77,28 +114,6 @@ const Joi = require("joi");
  * @property {string} agent_id - Agent's unique ID
  */
 
-/**
- * @typedef CreateVideoRoomResponse
- * @property {string} unique_name - Video Room's unique name
- */
-
-/**
- * @typedef CloseVideoRoomResponse
- * @property {boolean} success - Denotes if operation was successfully
- */
-
-/**
- * @typedef CreateVideoRoomPayload
- * @property {string} unique_name - Ticket id
- * @property {NotifyUser[]} [notify] - List of people to be notified
- */
-
-/**
- * @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
@@ -113,45 +128,6 @@ const Joi = require("joi");
  * @property {HistoryTypeEnum} type
  */
 
-/**
- * @typedef GetTokenForVideoRoomResponse
- * @property {string} access_token - Access token to be used for video room
- */
-
-/**
- * @typedef GetParticipantsInsideVideoRoomResponse
- * @property {Participant[]} participants - List of participants of the video room
- */
-
-/**
- * @typedef Participant
- * @property {UserSchema} [user]
- * @property {string} [identity] - Unique identifier of participant
- * @property {string} [status] - Status of participant
- */
-
-/**
- * @typedef UserSchema
- * @property {string} [application_id]
- * @property {string} [user_id]
- * @property {string} [first_name]
- * @property {Object} [meta]
- * @property {string} [last_name]
- * @property {PhoneNumber[]} [phone_numbers]
- * @property {Email[]} [emails]
- * @property {string} [gender]
- * @property {string} [dob]
- * @property {boolean} [active]
- * @property {string} [profile_pic_url]
- * @property {string} [username]
- * @property {string} [account_type]
- * @property {string} [_id]
- * @property {string} [created_at]
- * @property {string} [updated_at]
- * @property {string} [external_id]
- * @property {string} [rr_id]
- */
-
 /**
  * @typedef TicketContext
  * @property {string} [application_id] - Application ID related to the ticket
@@ -194,6 +170,11 @@ const Joi = require("joi");
  * @property {string} color - Color for priority
  */
 
+/**
+ * @typedef SLA
+ * @property {string} resolution_time
+ */
+
 /**
  * @typedef Status
  * @property {string} key - Key for status
@@ -307,6 +288,7 @@ const Joi = require("joi");
  * @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
@@ -324,23 +306,6 @@ const Joi = require("joi");
  * @property {string} [message]
  */
 
-/**
- * @typedef PhoneNumber
- * @property {string} [phone] - Phone number
- * @property {number} [country_code] - Country code
- * @property {boolean} [active] - Is the phone number active
- * @property {boolean} [primary] - Is it a primary phone number
- * @property {boolean} [verified] - Is the phone number verified
- */
-
-/**
- * @typedef Email
- * @property {string} [email] - Email address
- * @property {boolean} [active] - Is the email active
- * @property {boolean} [primary] - Is it a primary email
- * @property {boolean} [verified] - Is the email verified
- */
-
 /** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
 
 /** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
@@ -360,6 +325,53 @@ const Joi = require("joi");
 /** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
 
 class LeadPlatformModel {
+  /** @returns {GeneralConfigResponse} */
+  static GeneralConfigResponse() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      support_communication: Joi.array().items(
+        LeadPlatformModel.SupportCommunicationSchema()
+      ),
+      show_communication_info: Joi.boolean(),
+      show_support_dris: Joi.boolean(),
+      type: Joi.string().allow(""),
+      integration: LeadPlatformModel.GeneralConfigIntegrationSchema(),
+      allow_ticket_creation: Joi.boolean(),
+      show_listing: Joi.boolean(),
+      available_integration: Joi.array().items(Joi.string().allow("")),
+      enable_dris: Joi.boolean(),
+      support_email: LeadPlatformModel.SupportSchema(),
+      support_phone: LeadPlatformModel.SupportSchema(),
+      support_faq: LeadPlatformModel.SupportSchema(),
+    });
+  }
+
+  /** @returns {SupportCommunicationSchema} */
+  static SupportCommunicationSchema() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+      title: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      enabled: Joi.boolean(),
+    });
+  }
+
+  /** @returns {SupportSchema} */
+  static SupportSchema() {
+    return Joi.object({
+      value: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      enabled: Joi.boolean(),
+    });
+  }
+
+  /** @returns {GeneralConfigIntegrationSchema} */
+  static GeneralConfigIntegrationSchema() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {TicketList} */
   static TicketList() {
     return Joi.object({
@@ -449,36 +461,6 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {CreateVideoRoomResponse} */
-  static CreateVideoRoomResponse() {
-    return Joi.object({
-      unique_name: Joi.string().allow("").required(),
-    });
-  }
-
-  /** @returns {CloseVideoRoomResponse} */
-  static CloseVideoRoomResponse() {
-    return Joi.object({
-      success: Joi.boolean().required(),
-    });
-  }
-
-  /** @returns {CreateVideoRoomPayload} */
-  static CreateVideoRoomPayload() {
-    return Joi.object({
-      unique_name: Joi.string().allow("").required(),
-      notify: Joi.array().items(LeadPlatformModel.NotifyUser()),
-    });
-  }
-
-  /** @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({
@@ -497,55 +479,6 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {GetTokenForVideoRoomResponse} */
-  static GetTokenForVideoRoomResponse() {
-    return Joi.object({
-      access_token: Joi.string().allow("").required(),
-    });
-  }
-
-  /** @returns {GetParticipantsInsideVideoRoomResponse} */
-  static GetParticipantsInsideVideoRoomResponse() {
-    return Joi.object({
-      participants: Joi.array()
-        .items(LeadPlatformModel.Participant())
-        .required(),
-    });
-  }
-
-  /** @returns {Participant} */
-  static Participant() {
-    return Joi.object({
-      user: LeadPlatformModel.UserSchema(),
-      identity: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {UserSchema} */
-  static UserSchema() {
-    return Joi.object({
-      application_id: Joi.string().allow(""),
-      user_id: Joi.string().allow(""),
-      first_name: Joi.string().allow(""),
-      meta: Joi.any(),
-      last_name: Joi.string().allow(""),
-      phone_numbers: Joi.array().items(LeadPlatformModel.PhoneNumber()),
-      emails: Joi.array().items(LeadPlatformModel.Email()),
-      gender: Joi.string().allow(""),
-      dob: Joi.string().allow(""),
-      active: Joi.boolean(),
-      profile_pic_url: Joi.string().allow(""),
-      username: Joi.string().allow(""),
-      account_type: Joi.string().allow(""),
-      _id: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      updated_at: Joi.string().allow(""),
-      external_id: Joi.string().allow(""),
-      rr_id: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {TicketContext} */
   static TicketContext() {
     return Joi.object({
@@ -600,6 +533,13 @@ class LeadPlatformModel {
     });
   }
 
+  /** @returns {SLA} */
+  static SLA() {
+    return Joi.object({
+      resolution_time: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {Status} */
   static Status() {
     return Joi.object({
@@ -733,6 +673,7 @@ class LeadPlatformModel {
       source: LeadPlatformModel.TicketSourceEnum().required(),
       status: LeadPlatformModel.Status().required(),
       priority: LeadPlatformModel.Priority().required(),
+      sla: LeadPlatformModel.SLA(),
       created_by: Joi.any(),
       assigned_to: Joi.any(),
       tags: Joi.array().items(Joi.string().allow("")),
@@ -752,27 +693,6 @@ class LeadPlatformModel {
     });
   }
 
-  /** @returns {PhoneNumber} */
-  static PhoneNumber() {
-    return Joi.object({
-      phone: Joi.string().allow(""),
-      country_code: Joi.number(),
-      active: Joi.boolean(),
-      primary: Joi.boolean(),
-      verified: Joi.boolean(),
-    });
-  }
-
-  /** @returns {Email} */
-  static Email() {
-    return Joi.object({
-      email: Joi.string().allow(""),
-      active: Joi.boolean(),
-      primary: Joi.boolean(),
-      verified: Joi.boolean(),
-    });
-  }
-
   /**
    * Enum: PriorityEnum Used By: Lead
    *

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

@@ -40,14 +40,6 @@ export = LeadPlatformValidator;
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 12.
  */
-/**
- * @typedef GetPlatformVideoParticipantsParam
- * @property {string} uniqueName - Unique name of Video Room
- */
-/**
- * @typedef GetTokenForPlatformVideoRoomParam
- * @property {string} uniqueName - Unique name of video room
- */
 /**
  * @typedef SubmitFeedbackParam
  * @property {string} id - Ticket ID for which feedback is to be submitted
@@ -70,15 +62,11 @@ declare class LeadPlatformValidator {
     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 { CreatePlatformTicketHistoryParam, CreateTicketParam, EditPlatformTicketParam, GetFeedbacksParam, GetGeneralConfigParam, GetPlatformTicketParam, GetPlatformTicketHistoryParam, GetPlatformTicketsParam, GetPlatformVideoParticipantsParam, GetTokenForPlatformVideoRoomParam, SubmitFeedbackParam };
+    export { CreatePlatformTicketHistoryParam, CreateTicketParam, EditPlatformTicketParam, GetFeedbacksParam, GetGeneralConfigParam, GetPlatformTicketParam, GetPlatformTicketHistoryParam, GetPlatformTicketsParam, SubmitFeedbackParam };
 }
 type CreatePlatformTicketHistoryParam = {
     /**
@@ -152,18 +140,6 @@ type GetPlatformTicketsParam = {
      */
     pageSize?: number;
 };
-type GetPlatformVideoParticipantsParam = {
-    /**
-     * - Unique name of Video Room
-     */
-    uniqueName: string;
-};
-type GetTokenForPlatformVideoRoomParam = {
-    /**
-     * - Unique name of video room
-     */
-    uniqueName: string;
-};
 type SubmitFeedbackParam = {
     /**
      * - Ticket ID for which feedback is to be submitted

package/sdk/platform/Lead/LeadPlatformValidator.js

@@ -51,16 +51,6 @@ const LeadPlatformModel = require("./LeadPlatformModel");
  *   Default is 12.
  */
 
-/**
- * @typedef GetPlatformVideoParticipantsParam
- * @property {string} uniqueName - Unique name of Video Room
- */
-
-/**
- * @typedef GetTokenForPlatformVideoRoomParam
- * @property {string} uniqueName - Unique name of video room
- */
-
 /**
  * @typedef SubmitFeedbackParam
  * @property {string} id - Ticket ID for which feedback is to be submitted
@@ -131,20 +121,6 @@ class LeadPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetPlatformVideoParticipantsParam} */
-  static getPlatformVideoParticipants() {
-    return Joi.object({
-      uniqueName: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetTokenForPlatformVideoRoomParam} */
-  static getTokenForPlatformVideoRoom() {
-    return Joi.object({
-      uniqueName: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {SubmitFeedbackParam} */
   static submitFeedback() {
     return Joi.object({

package/sdk/platform/Order/OrderPlatformClient.d.ts

@@ -73,7 +73,7 @@ declare class Order {
      * @summary: Dispatch manifest
      * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
      */
-    dispatchManifests({ manifestId, body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
+    dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
     /**
      * @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -159,6 +159,16 @@ declare class Order {
      * @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
      */
     generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
+    /**
+     * @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<OrderPlatformModel.ManifestResponse>} - Success response
+     * @name generateProcessManifest
+     * @summary: Process Order Manifest
+     * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
+     */
+    generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponse>;
     /**
      * @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Order/OrderPlatformClient.js

@@ -524,12 +524,11 @@ class Order {
    * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
    */
   async dispatchManifests(
-    { manifestId, body, requestHeaders } = { requestHeaders: {} },
+    { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = OrderPlatformValidator.dispatchManifests().validate(
       {
-        manifestId,
         body,
       },
       { abortEarly: false, allowUnknown: true }
@@ -543,7 +542,6 @@ class Order {
       error: warrning,
     } = OrderPlatformValidator.dispatchManifests().validate(
       {
-        manifestId,
         body,
       },
       { abortEarly: false, allowUnknown: false }
@@ -562,7 +560,7 @@ class Order {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/${manifestId}/dispatch`,
+      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/dispatch`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -1247,6 +1245,85 @@ class Order {
     return response;
   }
 
+  /**
+   * @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<OrderPlatformModel.ManifestResponse>} - Success response
+   * @name generateProcessManifest
+   * @summary: Process Order Manifest
+   * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
+   */
+  async generateProcessManifest(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = OrderPlatformValidator.generateProcessManifest().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderPlatformValidator.generateProcessManifest().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Order > generateProcessManifest \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/process-manifest`,
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = OrderPlatformModel.ManifestResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Order > generateProcessManifest \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -2376,7 +2453,7 @@ class Order {
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifests/shipments`,
+      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/shipments-listing`,
       query_params,
       undefined,
       { ...xHeaders, ...requestHeaders },