@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.2

package/sdk/platform/Lead/LeadPlatformModel.js

@@ -1,7 +1,7 @@
 const Joi = require("joi");
 
 /**
- * @typedef GeneralConfigDetails
+ * @typedef GeneralConfigResponse
  * @property {string} [_id]
  * @property {SupportCommunicationSchema[]} [support_communication]
  * @property {boolean} [show_communication_info]
@@ -325,8 +325,8 @@ const Joi = require("joi");
 /** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
 
 class LeadPlatformModel {
-  /** @returns {GeneralConfigDetails} */
-  static GeneralConfigDetails() {
+  /** @returns {GeneralConfigResponse} */
+  static GeneralConfigResponse() {
     return Joi.object({
       _id: Joi.string().allow(""),
       support_communication: Joi.array().items(
@@ -474,7 +474,7 @@ class LeadPlatformModel {
   /** @returns {TicketHistoryPayload} */
   static TicketHistoryPayload() {
     return Joi.object({
-      value: Joi.object().pattern(/\S/, Joi.any()).required(),
+      value: Joi.any().required(),
       type: LeadPlatformModel.HistoryTypeEnum().required(),
     });
   }
@@ -515,12 +515,12 @@ class LeadPlatformModel {
   /** @returns {AddTicketPayload} */
   static AddTicketPayload() {
     return Joi.object({
-      created_by: Joi.object().pattern(/\S/, Joi.any()),
+      created_by: Joi.any(),
       status: Joi.string().allow(""),
       priority: LeadPlatformModel.PriorityEnum(),
       category: Joi.string().allow("").required(),
       content: LeadPlatformModel.TicketContent().required(),
-      _custom_json: Joi.object().pattern(/\S/, Joi.any()),
+      _custom_json: Joi.any(),
     });
   }
 
@@ -559,7 +559,7 @@ class LeadPlatformModel {
   /** @returns {TicketFeedbackPayload} */
   static TicketFeedbackPayload() {
     return Joi.object({
-      form_response: Joi.object().pattern(/\S/, Joi.any()),
+      form_response: Joi.any(),
     });
   }
 
@@ -605,9 +605,9 @@ class LeadPlatformModel {
   /** @returns {FeedbackForm} */
   static FeedbackForm() {
     return Joi.object({
-      inputs: Joi.object().pattern(/\S/, Joi.any()),
+      inputs: Joi.any(),
       title: Joi.string().allow(""),
-      timestamps: Joi.object().pattern(/\S/, Joi.any()),
+      timestamps: Joi.any(),
     });
   }
 
@@ -641,7 +641,7 @@ class LeadPlatformModel {
         .items(LeadPlatformModel.FeedbackResponseItem())
         .required(),
       category: Joi.string().allow(""),
-      user: Joi.object().pattern(/\S/, Joi.any()),
+      user: Joi.any(),
       updated_at: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
     });
@@ -651,10 +651,10 @@ class LeadPlatformModel {
   static TicketHistory() {
     return Joi.object({
       type: Joi.string().allow("").required(),
-      value: Joi.object().pattern(/\S/, Joi.any()).required(),
+      value: Joi.any().required(),
       ticket_id: Joi.string().allow("").required(),
       created_on: LeadPlatformModel.CreatedOn(),
-      created_by: Joi.object().pattern(/\S/, Joi.any()),
+      created_by: Joi.any(),
       _id: Joi.string().allow("").required(),
       updated_at: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
@@ -674,12 +674,12 @@ class LeadPlatformModel {
       status: LeadPlatformModel.Status().required(),
       priority: LeadPlatformModel.Priority().required(),
       sla: LeadPlatformModel.SLA(),
-      created_by: Joi.object().pattern(/\S/, Joi.any()),
-      assigned_to: Joi.object().pattern(/\S/, Joi.any()),
+      created_by: Joi.any(),
+      assigned_to: Joi.any(),
       tags: Joi.array().items(Joi.string().allow("")),
-      _custom_json: Joi.object().pattern(/\S/, Joi.any()),
+      _custom_json: Joi.any(),
       is_feedback_pending: Joi.boolean(),
-      integration: Joi.object().pattern(/\S/, Joi.any()),
+      integration: Joi.any(),
       _id: Joi.string().allow("").required(),
       updated_at: Joi.string().allow(""),
       created_at: Joi.string().allow(""),

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

@@ -19,37 +19,26 @@ declare class Order {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
+     * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
      *   - Success response
      *
      * @name getApplicationShipments
      * @summary: List sales channel shipments
      * @description: Get shipments of a particular sales channel based on the filters provided - 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.ShipmentInternalPlatformViewResponseSchema>;
+    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
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>} -
-     *   Success response
+     * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
      * @name getPlatformShipmentReasons
      * @summary: List shipment cancellation reasons
      * @description: Get reasons to perform 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.ShipmentReasonsResponseSchema>;
-    /**
-     * @param {OrderPlatformApplicationValidator.GetRulesParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.RuleListResponseSchema>} - Success response
-     * @name getRules
-     * @summary: List of RMA rules based on the given input conditions.
-     * @description: Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with  a specific company and application. These rules dictate the processes for handling returns,  including actions, reasons, quality control (QC) types, and associated questions.  The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRules/).
-     */
-    getRules({ body, requestHeaders }?: OrderPlatformApplicationValidator.GetRulesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleListResponseSchema>;
+    getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponse>;
     /**
      * @param {OrderPlatformApplicationValidator.GetShipmentBagReasonsParam} arg
      *   - Arg object

package/sdk/platform/Order/OrderPlatformApplicationClient.js

@@ -113,7 +113,7 @@ class Order {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
+   * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
    *   - Success response
    *
    * @name getApplicationShipments
@@ -231,7 +231,7 @@ class Order {
 
     const {
       error: res_error,
-    } = OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema().validate(
+    } = OrderPlatformModel.ShipmentInternalPlatformViewResponse().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -256,8 +256,7 @@ class Order {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>} -
-   *   Success response
+   * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
    * @name getPlatformShipmentReasons
    * @summary: List shipment cancellation reasons
    * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
@@ -313,84 +312,7 @@ class Order {
 
     const {
       error: res_error,
-    } = OrderPlatformModel.ShipmentReasonsResponseSchema().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 > getPlatformShipmentReasons \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {OrderPlatformApplicationValidator.GetRulesParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<OrderPlatformModel.RuleListResponseSchema>} - Success response
-   * @name getRules
-   * @summary: List of RMA rules based on the given input conditions.
-   * @description: Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with  a specific company and application. These rules dictate the processes for handling returns,  including actions, reasons, quality control (QC) types, and associated questions.  The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRules/).
-   */
-  async getRules(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = OrderPlatformApplicationValidator.getRules().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,
-    } = OrderPlatformApplicationValidator.getRules().validate(
-      {
-        body,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Order > getRules \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "post",
-      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/application/${this.applicationId}/rule_list`,
-      query_params,
-      body,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = OrderPlatformModel.RuleListResponseSchema().validate(responseData, {
+    } = OrderPlatformModel.ShipmentReasonsResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -401,7 +323,7 @@ class Order {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for platform > Order > getRules \n ${res_error}`,
+          message: `Response Validation Warnings for platform > Order > getPlatformShipmentReasons \n ${res_error}`,
         });
       }
     }

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

@@ -9,11 +9,10 @@ export = OrderPlatformApplicationValidator;
 /**
  * @typedef GetApplicationShipmentsParam
  * @property {string} [lane]
- * @property {string} [searchType] - Search_type refers to the field that will
- *   be used as the target for the search operation
+ * @property {string} [searchType]
  * @property {string} [searchId]
- * @property {string} [fromDate] - Date time in UTC timezone as per ISO format.
- * @property {string} [toDate] - Date time in UTC timezone as per ISO format.
+ * @property {string} [fromDate]
+ * @property {string} [toDate]
  * @property {string} [dpIds]
  * @property {string} [orderingCompanyId]
  * @property {string} [stores]
@@ -29,10 +28,6 @@ export = OrderPlatformApplicationValidator;
  * @typedef GetPlatformShipmentReasonsParam
  * @property {string} action
  */
-/**
- * @typedef GetRulesParam
- * @property {OrderPlatformModel.RuleListRequestSchema} body
- */
 /**
  * @typedef GetShipmentBagReasonsParam
  * @property {string} shipmentId - ID of the bag. An order may contain multiple
@@ -50,15 +45,13 @@ declare class OrderPlatformApplicationValidator {
     static getApplicationShipments(): GetApplicationShipmentsParam;
     /** @returns {GetPlatformShipmentReasonsParam} */
     static getPlatformShipmentReasons(): GetPlatformShipmentReasonsParam;
-    /** @returns {GetRulesParam} */
-    static getRules(): GetRulesParam;
     /** @returns {GetShipmentBagReasonsParam} */
     static getShipmentBagReasons(): GetShipmentBagReasonsParam;
     /** @returns {TrackShipmentPlatformParam} */
     static trackShipmentPlatform(): TrackShipmentPlatformParam;
 }
 declare namespace OrderPlatformApplicationValidator {
-    export { FailedOrderLogsParam, GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetRulesParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
+    export { FailedOrderLogsParam, GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
 }
 type FailedOrderLogsParam = {
     /**
@@ -80,19 +73,9 @@ type FailedOrderLogsParam = {
 };
 type GetApplicationShipmentsParam = {
     lane?: string;
-    /**
-     * - Search_type refers to the field that will
-     * be used as the target for the search operation
-     */
     searchType?: string;
     searchId?: string;
-    /**
-     * - Date time in UTC timezone as per ISO format.
-     */
     fromDate?: string;
-    /**
-     * - Date time in UTC timezone as per ISO format.
-     */
     toDate?: string;
     dpIds?: string;
     orderingCompanyId?: string;
@@ -108,9 +91,6 @@ type GetApplicationShipmentsParam = {
 type GetPlatformShipmentReasonsParam = {
     action: string;
 };
-type GetRulesParam = {
-    body: OrderPlatformModel.RuleListRequestSchema;
-};
 type GetShipmentBagReasonsParam = {
     /**
      * - ID of the bag. An order may contain multiple
@@ -128,4 +108,3 @@ type TrackShipmentPlatformParam = {
      */
     shipmentId: string;
 };
-import OrderPlatformModel = require("./OrderPlatformModel");

package/sdk/platform/Order/OrderPlatformApplicationValidator.js

@@ -13,11 +13,10 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 /**
  * @typedef GetApplicationShipmentsParam
  * @property {string} [lane]
- * @property {string} [searchType] - Search_type refers to the field that will
- *   be used as the target for the search operation
+ * @property {string} [searchType]
  * @property {string} [searchId]
- * @property {string} [fromDate] - Date time in UTC timezone as per ISO format.
- * @property {string} [toDate] - Date time in UTC timezone as per ISO format.
+ * @property {string} [fromDate]
+ * @property {string} [toDate]
  * @property {string} [dpIds]
  * @property {string} [orderingCompanyId]
  * @property {string} [stores]
@@ -35,11 +34,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} action
  */
 
-/**
- * @typedef GetRulesParam
- * @property {OrderPlatformModel.RuleListRequestSchema} body
- */
-
 /**
  * @typedef GetShipmentBagReasonsParam
  * @property {string} shipmentId - ID of the bag. An order may contain multiple
@@ -91,13 +85,6 @@ class OrderPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetRulesParam} */
-  static getRules() {
-    return Joi.object({
-      body: OrderPlatformModel.RuleListRequestSchema().required(),
-    }).required();
-  }
-
   /** @returns {GetShipmentBagReasonsParam} */
   static getShipmentBagReasons() {
     return Joi.object({