@gofynd/fdk-client-javascript 1.3.6-beta.1 → 1.3.6

package/sdk/platform/Lead/LeadPlatformClient.js

@@ -1,5 +1,8 @@
 const PlatformAPIClient = require("../PlatformAPIClient");
-const { FDKClientValidationError } = require("../../common/FDKError");
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
 const Paginator = require("../../common/Paginator");
 const LeadPlatformValidator = require("./LeadPlatformValidator");
 const LeadPlatformModel = require("./LeadPlatformModel");
@@ -81,10 +84,14 @@ class Lead {
     });
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Lead > createPlatformTicketHistory \n ${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 > Lead > createPlatformTicketHistory \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -154,10 +161,14 @@ class Lead {
     });
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Lead > createTicket \n ${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 > Lead > createTicket \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -231,10 +242,14 @@ class Lead {
     });
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Lead > editPlatformTicket \n ${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 > Lead > editPlatformTicket \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -304,10 +319,14 @@ class Lead {
     });
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Lead > getFeedbacks \n ${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 > Lead > getFeedbacks \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -375,10 +394,14 @@ class Lead {
     });
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Lead > getGeneralConfig \n ${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 > Lead > getGeneralConfig \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -450,10 +473,14 @@ class Lead {
     });
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Lead > getPlatformTicket \n ${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 > Lead > getPlatformTicket \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -525,10 +552,14 @@ class Lead {
     });
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Lead > getPlatformTicketHistory \n ${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 > Lead > getPlatformTicketHistory \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -632,10 +663,14 @@ class Lead {
     });
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Lead > getPlatformTickets \n ${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 > Lead > getPlatformTickets \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -761,10 +796,14 @@ class Lead {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Lead > getPlatformVideoParticipants \n ${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 > Lead > getPlatformVideoParticipants \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -839,10 +878,14 @@ class Lead {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Lead > getTokenForPlatformVideoRoom \n ${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 > Lead > getTokenForPlatformVideoRoom \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -914,10 +957,14 @@ class Lead {
     });
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Lead > submitFeedback \n ${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 > Lead > submitFeedback \n ${res_error}`,
+        });
+      }
     }
 
     return response;

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

@@ -3,6 +3,20 @@ declare class Order {
     constructor(config: any, applicationId: any);
     config: any;
     applicationId: any;
+    /**
+     * @param {OrderPlatformApplicationValidator.GetApplicationShipmentsParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
+     *   - Success response
+     *
+     * @name getApplicationShipments
+     * @summary:
+     * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
+     */
+    getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
     /**
      * @param {OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam} arg
      *   - Arg object
@@ -15,6 +29,18 @@ declare class Order {
      * @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, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponse>;
+    /**
+     * @param {OrderPlatformApplicationValidator.GetShipmentBagReasonsParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
+     * @name getShipmentBagReasons
+     * @summary: Get reasons behind full or partial cancellation of a shipment
+     * @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
+     */
+    getShipmentBagReasons({ shipmentId, lineNumber, requestHeaders }?: OrderPlatformApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentBagReasons>;
     /**
      * @param {OrderPlatformApplicationValidator.TrackShipmentPlatformParam} arg
      *   - Arg object

package/sdk/platform/Order/OrderPlatformApplicationClient.js

@@ -12,6 +12,149 @@ class Order {
     this.applicationId = applicationId;
   }
 
+  /**
+   * @param {OrderPlatformApplicationValidator.GetApplicationShipmentsParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
+   *   - Success response
+   *
+   * @name getApplicationShipments
+   * @summary:
+   * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
+   */
+  async getApplicationShipments(
+    {
+      lane,
+      searchType,
+      searchId,
+      fromDate,
+      toDate,
+      dpIds,
+      orderingCompanyId,
+      stores,
+      salesChannel,
+      requestByExt,
+      pageNo,
+      pageSize,
+      customerId,
+      isPrioritySort,
+      excludeLockedShipments,
+      requestHeaders,
+    } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = OrderPlatformApplicationValidator.getApplicationShipments().validate(
+      {
+        lane,
+        searchType,
+        searchId,
+        fromDate,
+        toDate,
+        dpIds,
+        orderingCompanyId,
+        stores,
+        salesChannel,
+        requestByExt,
+        pageNo,
+        pageSize,
+        customerId,
+        isPrioritySort,
+        excludeLockedShipments,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderPlatformApplicationValidator.getApplicationShipments().validate(
+      {
+        lane,
+        searchType,
+        searchId,
+        fromDate,
+        toDate,
+        dpIds,
+        orderingCompanyId,
+        stores,
+        salesChannel,
+        requestByExt,
+        pageNo,
+        pageSize,
+        customerId,
+        isPrioritySort,
+        excludeLockedShipments,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Order > getApplicationShipments \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["lane"] = lane;
+    query_params["search_type"] = searchType;
+    query_params["search_id"] = searchId;
+    query_params["from_date"] = fromDate;
+    query_params["to_date"] = toDate;
+    query_params["dp_ids"] = dpIds;
+    query_params["ordering_company_id"] = orderingCompanyId;
+    query_params["stores"] = stores;
+    query_params["sales_channel"] = salesChannel;
+    query_params["request_by_ext"] = requestByExt;
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["customer_id"] = customerId;
+    query_params["is_priority_sort"] = isPrioritySort;
+    query_params["exclude_locked_shipments"] = excludeLockedShipments;
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/order/v1.0/company/${this.config.companyId}/application/${this.applicationId}/shipments/`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = OrderPlatformModel.ShipmentInternalPlatformViewResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    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 > getApplicationShipments \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam} arg
    *   - Arg object
@@ -80,12 +223,99 @@ class Order {
     });
 
     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 > getPlatformShipmentReasons \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {OrderPlatformApplicationValidator.GetShipmentBagReasonsParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
+   * @name getShipmentBagReasons
+   * @summary: Get reasons behind full or partial cancellation of a shipment
+   * @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
+   */
+  async getShipmentBagReasons(
+    { shipmentId, lineNumber, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = OrderPlatformApplicationValidator.getShipmentBagReasons().validate(
+      {
+        shipmentId,
+        lineNumber,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderPlatformApplicationValidator.getShipmentBagReasons().validate(
+      {
+        shipmentId,
+        lineNumber,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
       Logger({
         level: "WARN",
-        message: `Response Validation Warnnings for platform > Order > getPlatformShipmentReasons \n ${res_error}`,
+        message: `Parameter Validation warrnings for platform > Order > getShipmentBagReasons \n ${warrning}`,
       });
     }
 
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/order/v1.0/company/${this.config.companyId}/application/<application_id>/orders/shipments/<shipment_id>/line_number/<line_number>/reasons`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = OrderPlatformModel.ShipmentBagReasons().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    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 > getShipmentBagReasons \n ${res_error}`,
+        });
+      }
+    }
+
     return response;
   }
 
@@ -157,10 +387,14 @@ class Order {
     });
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Order > trackShipmentPlatform \n ${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 > trackShipmentPlatform \n ${res_error}`,
+        });
+      }
     }
 
     return response;

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

@@ -1,24 +1,80 @@
 export = OrderPlatformApplicationValidator;
+/**
+ * @typedef GetApplicationShipmentsParam
+ * @property {string} [lane]
+ * @property {string} [searchType]
+ * @property {string} [searchId]
+ * @property {string} [fromDate]
+ * @property {string} [toDate]
+ * @property {string} [dpIds]
+ * @property {string} [orderingCompanyId]
+ * @property {string} [stores]
+ * @property {string} [salesChannel]
+ * @property {string} [requestByExt]
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
+ * @property {string} [customerId]
+ * @property {boolean} [isPrioritySort]
+ * @property {boolean} [excludeLockedShipments]
+ */
 /**
  * @typedef GetPlatformShipmentReasonsParam
  * @property {string} action
  */
+/**
+ * @typedef GetShipmentBagReasonsParam
+ * @property {string} shipmentId - ID of the bag. An order may contain multiple
+ *   items and may get divided into one or more shipment, each having its own ID.
+ * @property {number} lineNumber - Line number of bag.
+ */
 /**
  * @typedef TrackShipmentPlatformParam
  * @property {string} shipmentId - Shipment Id
  */
 declare class OrderPlatformApplicationValidator {
+    /** @returns {GetApplicationShipmentsParam} */
+    static getApplicationShipments(): GetApplicationShipmentsParam;
     /** @returns {GetPlatformShipmentReasonsParam} */
     static getPlatformShipmentReasons(): GetPlatformShipmentReasonsParam;
+    /** @returns {GetShipmentBagReasonsParam} */
+    static getShipmentBagReasons(): GetShipmentBagReasonsParam;
     /** @returns {TrackShipmentPlatformParam} */
     static trackShipmentPlatform(): TrackShipmentPlatformParam;
 }
 declare namespace OrderPlatformApplicationValidator {
-    export { GetPlatformShipmentReasonsParam, TrackShipmentPlatformParam };
+    export { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
 }
+type GetApplicationShipmentsParam = {
+    lane?: string;
+    searchType?: string;
+    searchId?: string;
+    fromDate?: string;
+    toDate?: string;
+    dpIds?: string;
+    orderingCompanyId?: string;
+    stores?: string;
+    salesChannel?: string;
+    requestByExt?: string;
+    pageNo?: number;
+    pageSize?: number;
+    customerId?: string;
+    isPrioritySort?: boolean;
+    excludeLockedShipments?: boolean;
+};
 type GetPlatformShipmentReasonsParam = {
     action: string;
 };
+type GetShipmentBagReasonsParam = {
+    /**
+     * - ID of the bag. An order may contain multiple
+     * items and may get divided into one or more shipment, each having its own ID.
+     */
+    shipmentId: string;
+    /**
+     * - Line number of bag.
+     */
+    lineNumber: number;
+};
 type TrackShipmentPlatformParam = {
     /**
      * - Shipment Id

package/sdk/platform/Order/OrderPlatformApplicationValidator.js

@@ -2,17 +2,64 @@ const Joi = require("joi");
 
 const OrderPlatformModel = require("./OrderPlatformModel");
 
+/**
+ * @typedef GetApplicationShipmentsParam
+ * @property {string} [lane]
+ * @property {string} [searchType]
+ * @property {string} [searchId]
+ * @property {string} [fromDate]
+ * @property {string} [toDate]
+ * @property {string} [dpIds]
+ * @property {string} [orderingCompanyId]
+ * @property {string} [stores]
+ * @property {string} [salesChannel]
+ * @property {string} [requestByExt]
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
+ * @property {string} [customerId]
+ * @property {boolean} [isPrioritySort]
+ * @property {boolean} [excludeLockedShipments]
+ */
+
 /**
  * @typedef GetPlatformShipmentReasonsParam
  * @property {string} action
  */
 
+/**
+ * @typedef GetShipmentBagReasonsParam
+ * @property {string} shipmentId - ID of the bag. An order may contain multiple
+ *   items and may get divided into one or more shipment, each having its own ID.
+ * @property {number} lineNumber - Line number of bag.
+ */
+
 /**
  * @typedef TrackShipmentPlatformParam
  * @property {string} shipmentId - Shipment Id
  */
 
 class OrderPlatformApplicationValidator {
+  /** @returns {GetApplicationShipmentsParam} */
+  static getApplicationShipments() {
+    return Joi.object({
+      lane: Joi.string().allow(""),
+      searchType: Joi.string().allow(""),
+      searchId: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      dpIds: Joi.string().allow(""),
+      orderingCompanyId: Joi.string().allow(""),
+      stores: Joi.string().allow(""),
+      salesChannel: Joi.string().allow(""),
+      requestByExt: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      customerId: Joi.string().allow(""),
+      isPrioritySort: Joi.boolean(),
+      excludeLockedShipments: Joi.boolean(),
+    }).required();
+  }
+
   /** @returns {GetPlatformShipmentReasonsParam} */
   static getPlatformShipmentReasons() {
     return Joi.object({
@@ -20,6 +67,14 @@ class OrderPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetShipmentBagReasonsParam} */
+  static getShipmentBagReasons() {
+    return Joi.object({
+      shipmentId: Joi.string().allow("").required(),
+      lineNumber: Joi.number().required(),
+    }).required();
+  }
+
   /** @returns {TrackShipmentPlatformParam} */
   static trackShipmentPlatform() {
     return Joi.object({