@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

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

@@ -1,14 +1,175 @@
-export = LeadValidator;
-declare class LeadValidator {
-    static createHistory(): any;
-    static createTicket(): any;
-    static editTicket(): any;
-    static getFeedbacks(): any;
+export = LeadPlatformValidator;
+/**
+ * @typedef CreateHistoryParam
+ * @property {string} id - Ticket ID for which history is created
+ * @property {LeadPlatformModel.TicketHistoryPayload} body
+ */
+/**
+ * @typedef CreateTicketParam
+ * @property {LeadPlatformModel.AddTicketPayload} body
+ */
+/**
+ * @typedef EditTicketParam
+ * @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 GetTicketParam
+ * @property {string} id - Tiket ID of the ticket to be fetched
+ */
+/**
+ * @typedef GetTicketHistoryParam
+ * @property {string} id - Ticket ID for which history is to be fetched
+ */
+/**
+ * @typedef GetTicketsParam
+ * @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
+ * @property {string} [q] - Search through ticket titles and description
+ * @property {string} [status] - Filter tickets on status
+ * @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 GetTokenForVideoRoomParam
+ * @property {string} uniqueName - Unique name of video room
+ */
+/**
+ * @typedef GetVideoParticipantsParam
+ * @property {string} uniqueName - Unique name of Video Room
+ */
+/**
+ * @typedef SubmitFeedbackParam
+ * @property {string} id - Ticket ID for which feedback is to be submitted
+ * @property {LeadPlatformModel.TicketFeedbackPayload} body
+ */
+declare class LeadPlatformValidator {
+    /** @returns {CreateHistoryParam} */
+    static createHistory(): CreateHistoryParam;
+    /** @returns {CreateTicketParam} */
+    static createTicket(): CreateTicketParam;
+    /** @returns {EditTicketParam} */
+    static editTicket(): EditTicketParam;
+    /** @returns {GetFeedbacksParam} */
+    static getFeedbacks(): GetFeedbacksParam;
+    /** @returns {GetGeneralConfigParam} */
     static getGeneralConfig(): any;
-    static getTicket(): any;
-    static getTicketHistory(): any;
-    static getTickets(): any;
-    static getTokenForVideoRoom(): any;
-    static getVideoParticipants(): any;
-    static submitFeedback(): 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 {SubmitFeedbackParam} */
+    static submitFeedback(): SubmitFeedbackParam;
 }
+declare namespace LeadPlatformValidator {
+    export { CreateHistoryParam, CreateTicketParam, EditTicketParam, GetFeedbacksParam, GetGeneralConfigParam, GetTicketParam, GetTicketHistoryParam, GetTicketsParam, GetTokenForVideoRoomParam, GetVideoParticipantsParam, SubmitFeedbackParam };
+}
+type CreateHistoryParam = {
+    /**
+     * - Ticket ID for which history is created
+     */
+    id: string;
+    body: LeadPlatformModel.TicketHistoryPayload;
+};
+type CreateTicketParam = {
+    body: LeadPlatformModel.AddTicketPayload;
+};
+type EditTicketParam = {
+    /**
+     * - Ticket ID of ticket to be edited
+     */
+    id: string;
+    body: LeadPlatformModel.EditTicketPayload;
+};
+type GetFeedbacksParam = {
+    /**
+     * - Ticket ID for which feedbacks are to be fetched
+     */
+    id: string;
+};
+type GetTicketParam = {
+    /**
+     * - Tiket ID of the ticket to be fetched
+     */
+    id: string;
+};
+type GetTicketHistoryParam = {
+    /**
+     * - Ticket ID for which history is to be fetched
+     */
+    id: string;
+};
+type GetTicketsParam = {
+    /**
+     * - Decides that the reponse will contain the list of tickets
+     */
+    items?: boolean;
+    /**
+     * - Decides that the reponse will contain the
+     * ticket filters
+     */
+    filters?: boolean;
+    /**
+     * - Search through ticket titles and description
+     */
+    q?: string;
+    /**
+     * - Filter tickets on status
+     */
+    status?: string;
+    /**
+     * - Filter tickets on priority
+     */
+    priority?: LeadPlatformModel.PriorityEnum;
+    /**
+     * - Filter tickets on category
+     */
+    category?: string;
+    /**
+     * - The page number to navigate through the given
+     * set of results.
+     */
+    pageNo?: number;
+    /**
+     * - Number of items to retrieve in each page.
+     * Default is 12.
+     */
+    pageSize?: number;
+};
+type GetTokenForVideoRoomParam = {
+    /**
+     * - Unique name of video room
+     */
+    uniqueName: string;
+};
+type GetVideoParticipantsParam = {
+    /**
+     * - Unique name of Video Room
+     */
+    uniqueName: string;
+};
+type SubmitFeedbackParam = {
+    /**
+     * - Ticket ID for which feedback is to be submitted
+     */
+    id: string;
+    body: LeadPlatformModel.TicketFeedbackPayload;
+};
+type GetGeneralConfigParam = any;
+import LeadPlatformModel = require("./LeadPlatformModel");

package/sdk/platform/Lead/LeadPlatformValidator.js

@@ -1,80 +1,157 @@
 const Joi = require("joi");
 
-const LeadModel = require("./LeadPlatformModel");
-class LeadValidator {
+const LeadPlatformModel = require("./LeadPlatformModel");
+
+/**
+ * @typedef CreateHistoryParam
+ * @property {string} id - Ticket ID for which history is created
+ * @property {LeadPlatformModel.TicketHistoryPayload} body
+ */
+
+/**
+ * @typedef CreateTicketParam
+ * @property {LeadPlatformModel.AddTicketPayload} body
+ */
+
+/**
+ * @typedef EditTicketParam
+ * @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 GetTicketParam
+ * @property {string} id - Tiket ID of the ticket to be fetched
+ */
+
+/**
+ * @typedef GetTicketHistoryParam
+ * @property {string} id - Ticket ID for which history is to be fetched
+ */
+
+/**
+ * @typedef GetTicketsParam
+ * @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
+ * @property {string} [q] - Search through ticket titles and description
+ * @property {string} [status] - Filter tickets on status
+ * @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 GetTokenForVideoRoomParam
+ * @property {string} uniqueName - Unique name of video room
+ */
+
+/**
+ * @typedef GetVideoParticipantsParam
+ * @property {string} uniqueName - Unique name of Video Room
+ */
+
+/**
+ * @typedef SubmitFeedbackParam
+ * @property {string} id - Ticket ID for which feedback is to be submitted
+ * @property {LeadPlatformModel.TicketFeedbackPayload} body
+ */
+
+class LeadPlatformValidator {
+  /** @returns {CreateHistoryParam} */
   static createHistory() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: LeadModel.TicketHistoryPayload().required(),
+      body: LeadPlatformModel.TicketHistoryPayload().required(),
     }).required();
   }
 
+  /** @returns {CreateTicketParam} */
   static createTicket() {
     return Joi.object({
-      body: LeadModel.AddTicketPayload().required(),
+      body: LeadPlatformModel.AddTicketPayload().required(),
     }).required();
   }
 
+  /** @returns {EditTicketParam} */
   static editTicket() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: LeadModel.EditTicketPayload().required(),
+      body: LeadPlatformModel.EditTicketPayload().required(),
     }).required();
   }
 
+  /** @returns {GetFeedbacksParam} */
   static getFeedbacks() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetGeneralConfigParam} */
   static getGeneralConfig() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetTicketParam} */
   static getTicket() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetTicketHistoryParam} */
   static getTicketHistory() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetTicketsParam} */
   static getTickets() {
     return Joi.object({
       items: Joi.boolean(),
       filters: Joi.boolean(),
       q: Joi.string().allow(""),
       status: Joi.string().allow(""),
-      priority: LeadModel.PriorityEnum(),
+      priority: LeadPlatformModel.PriorityEnum(),
       category: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
     }).required();
   }
 
+  /** @returns {GetTokenForVideoRoomParam} */
   static getTokenForVideoRoom() {
     return Joi.object({
       uniqueName: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetVideoParticipantsParam} */
   static getVideoParticipants() {
     return Joi.object({
       uniqueName: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {SubmitFeedbackParam} */
   static submitFeedback() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: LeadModel.TicketFeedbackPayload().required(),
+      body: LeadPlatformModel.TicketFeedbackPayload().required(),
     }).required();
   }
 }
 
-module.exports = LeadValidator;
+module.exports = LeadPlatformValidator;

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

@@ -4,23 +4,27 @@ declare class Order {
     config: any;
     applicationId: any;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.action -
-     * @returns {Promise<ShipmentReasonsResponse>} - Success response
+     * @param {OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam} arg
+     *   - Arg object
+     *
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
+     * @name getPlatformShipmentReasons
      * @summary: Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
-     * @description: Using action, get reasons behind full or partial cancellation of a shipment
+     * @description: Using action, get reasons behind full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
      */
-    getPlatformShipmentReasons({ action }?: {
-        action: string;
-    }): Promise<ShipmentReasonsResponse>;
+    getPlatformShipmentReasons({ action }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.ShipmentReasonsResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.shipmentId - Shipment Id
-     * @returns {Promise<PlatformShipmentTrack>} - Success response
+     * @param {OrderPlatformApplicationValidator.TrackShipmentPlatformParam} arg
+     *   - Arg object
+     *
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
+     * @name trackShipmentPlatform
      * @summary: Track shipment
-     * @description: Track Shipment by shipment id, for application based on application Id
+     * @description: Track Shipment by shipment id, for application based on application Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
      */
-    trackShipmentPlatform({ shipmentId }?: {
-        shipmentId: string;
-    }): Promise<PlatformShipmentTrack>;
+    trackShipmentPlatform({ shipmentId }?: OrderPlatformApplicationValidator.TrackShipmentPlatformParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.PlatformShipmentTrack>;
 }
+import OrderPlatformApplicationValidator = require("./OrderPlatformApplicationValidator");
+import OrderPlatformModel = require("./OrderPlatformModel");

package/sdk/platform/Order/OrderPlatformApplicationClient.js

@@ -1,8 +1,8 @@
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const Paginator = require("../../common/Paginator");
-const OrderValidator = require("./OrderPlatformApplicationValidator");
-const OrderModel = require("./OrderPlatformModel");
+const OrderPlatformApplicationValidator = require("./OrderPlatformApplicationValidator");
+const OrderPlatformModel = require("./OrderPlatformModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -13,14 +13,22 @@ class Order {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.action -
-   * @returns {Promise<ShipmentReasonsResponse>} - Success response
+   * @param {OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam} arg
+   *   - Arg object
+   *
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
+   * @name getPlatformShipmentReasons
    * @summary: Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
-   * @description: Using action, get reasons behind full or partial cancellation of a shipment
+   * @description: Using action, get reasons behind full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
    */
-  async getPlatformShipmentReasons({ action } = {}) {
-    const { error } = OrderValidator.getPlatformShipmentReasons().validate(
+  async getPlatformShipmentReasons(
+    { action } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = OrderPlatformApplicationValidator.getPlatformShipmentReasons().validate(
       {
         action,
       },
@@ -33,7 +41,7 @@ class Order {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = OrderValidator.getPlatformShipmentReasons().validate(
+    } = OrderPlatformApplicationValidator.getPlatformShipmentReasons().validate(
       {
         action,
       },
@@ -42,10 +50,8 @@ class Order {
     if (warrning) {
       Logger({
         level: "WARN",
-        message:
-          "Parameter Validation warrnings for getPlatformShipmentReasons",
+        message: `Parameter Validation warrnings for platform > Order > getPlatformShipmentReasons \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -55,12 +61,19 @@ class Order {
       "get",
       `/service/platform/order/v1.0/company/${this.config.companyId}/application/${this.applicationId}/orders/shipments/reasons/${action}`,
       query_params,
-      undefined
+      undefined,
+      undefined,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = OrderModel.ShipmentReasonsResponse().validate(response, {
+    } = OrderPlatformModel.ShipmentReasonsResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -68,23 +81,30 @@ class Order {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getPlatformShipmentReasons",
+        message: `Response Validation Warnnings for platform > Order > getPlatformShipmentReasons \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.shipmentId - Shipment Id
-   * @returns {Promise<PlatformShipmentTrack>} - Success response
+   * @param {OrderPlatformApplicationValidator.TrackShipmentPlatformParam} arg
+   *   - Arg object
+   *
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
+   * @name trackShipmentPlatform
    * @summary: Track shipment
-   * @description: Track Shipment by shipment id, for application based on application Id
+   * @description: Track Shipment by shipment id, for application based on application Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
    */
-  async trackShipmentPlatform({ shipmentId } = {}) {
-    const { error } = OrderValidator.trackShipmentPlatform().validate(
+  async trackShipmentPlatform(
+    { shipmentId } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = OrderPlatformApplicationValidator.trackShipmentPlatform().validate(
       {
         shipmentId,
       },
@@ -95,7 +115,9 @@ class Order {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = OrderValidator.trackShipmentPlatform().validate(
+    const {
+      error: warrning,
+    } = OrderPlatformApplicationValidator.trackShipmentPlatform().validate(
       {
         shipmentId,
       },
@@ -104,9 +126,8 @@ class Order {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for trackShipmentPlatform",
+        message: `Parameter Validation warrnings for platform > Order > trackShipmentPlatform \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -116,12 +137,19 @@ class Order {
       "get",
       `/service/platform/order/v1.0/company/${this.config.companyId}/application/${this.applicationId}/orders/shipments/${shipmentId}/track`,
       query_params,
-      undefined
+      undefined,
+      undefined,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = OrderModel.PlatformShipmentTrack().validate(response, {
+    } = OrderPlatformModel.PlatformShipmentTrack().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -129,9 +157,8 @@ class Order {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for trackShipmentPlatform",
+        message: `Response Validation Warnnings for platform > Order > trackShipmentPlatform \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;

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

@@ -1,5 +1,27 @@
-export = OrderValidator;
-declare class OrderValidator {
-    static getPlatformShipmentReasons(): any;
-    static trackShipmentPlatform(): any;
+export = OrderPlatformApplicationValidator;
+/**
+ * @typedef GetPlatformShipmentReasonsParam
+ * @property {string} action
+ */
+/**
+ * @typedef TrackShipmentPlatformParam
+ * @property {string} shipmentId - Shipment Id
+ */
+declare class OrderPlatformApplicationValidator {
+    /** @returns {GetPlatformShipmentReasonsParam} */
+    static getPlatformShipmentReasons(): GetPlatformShipmentReasonsParam;
+    /** @returns {TrackShipmentPlatformParam} */
+    static trackShipmentPlatform(): TrackShipmentPlatformParam;
 }
+declare namespace OrderPlatformApplicationValidator {
+    export { GetPlatformShipmentReasonsParam, TrackShipmentPlatformParam };
+}
+type GetPlatformShipmentReasonsParam = {
+    action: string;
+};
+type TrackShipmentPlatformParam = {
+    /**
+     * - Shipment Id
+     */
+    shipmentId: string;
+};

package/sdk/platform/Order/OrderPlatformApplicationValidator.js

@@ -1,13 +1,26 @@
 const Joi = require("joi");
 
-const OrderModel = require("./OrderPlatformModel");
-class OrderValidator {
+const OrderPlatformModel = require("./OrderPlatformModel");
+
+/**
+ * @typedef GetPlatformShipmentReasonsParam
+ * @property {string} action
+ */
+
+/**
+ * @typedef TrackShipmentPlatformParam
+ * @property {string} shipmentId - Shipment Id
+ */
+
+class OrderPlatformApplicationValidator {
+  /** @returns {GetPlatformShipmentReasonsParam} */
   static getPlatformShipmentReasons() {
     return Joi.object({
       action: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {TrackShipmentPlatformParam} */
   static trackShipmentPlatform() {
     return Joi.object({
       shipmentId: Joi.string().allow("").required(),
@@ -15,4 +28,4 @@ class OrderValidator {
   }
 }
 
-module.exports = OrderValidator;
+module.exports = OrderPlatformApplicationValidator;