@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5

package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts

@@ -14,7 +14,7 @@ export = FileStoragePlatformValidator;
  *   files(products, orders, logistics etc), Required for validating the data of
  *   the file being uploaded, decides where exactly the file will be stored
  *   inside the storage bucket.
- * @property {FileStoragePlatformModel.StartResponse} body
+ * @property {FileStoragePlatformModel.FileUpload} body
  */
 /**
  * @typedef CopyFilesParam
@@ -23,7 +23,7 @@ export = FileStoragePlatformValidator;
  */
 /**
  * @typedef GetSignUrlsParam
- * @property {FileStoragePlatformModel.SignUrlRequest} body
+ * @property {FileStoragePlatformModel.SignUrl} body
  */
 /**
  * @typedef ProxyParam
@@ -35,7 +35,7 @@ export = FileStoragePlatformValidator;
  *   files(products, orders, logistics etc), Required for validating the data of
  *   the file being uploaded, decides where exactly the file will be stored
  *   inside the storage bucket.
- * @property {FileStoragePlatformModel.StartRequest} body
+ * @property {FileStoragePlatformModel.FileUploadStart} body
  */
 declare class FileStoragePlatformValidator {
     /** @returns {BrowseParam} */
@@ -79,14 +79,14 @@ type CompleteUploadParam = {
      * inside the storage bucket.
      */
     namespace: string;
-    body: FileStoragePlatformModel.StartResponse;
+    body: FileStoragePlatformModel.FileUpload;
 };
 type CopyFilesParam = {
     sync?: boolean;
     body: FileStoragePlatformModel.CopyFiles;
 };
 type GetSignUrlsParam = {
-    body: FileStoragePlatformModel.SignUrlRequest;
+    body: FileStoragePlatformModel.SignUrl;
 };
 type ProxyParam = {
     /**
@@ -102,6 +102,6 @@ type StartUploadParam = {
      * inside the storage bucket.
      */
     namespace: string;
-    body: FileStoragePlatformModel.StartRequest;
+    body: FileStoragePlatformModel.FileUploadStart;
 };
 import FileStoragePlatformModel = require("./FileStoragePlatformModel");

package/sdk/platform/FileStorage/FileStoragePlatformValidator.js

@@ -18,7 +18,7 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
  *   files(products, orders, logistics etc), Required for validating the data of
  *   the file being uploaded, decides where exactly the file will be stored
  *   inside the storage bucket.
- * @property {FileStoragePlatformModel.StartResponse} body
+ * @property {FileStoragePlatformModel.FileUpload} body
  */
 
 /**
@@ -29,7 +29,7 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
 
 /**
  * @typedef GetSignUrlsParam
- * @property {FileStoragePlatformModel.SignUrlRequest} body
+ * @property {FileStoragePlatformModel.SignUrl} body
  */
 
 /**
@@ -43,7 +43,7 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
  *   files(products, orders, logistics etc), Required for validating the data of
  *   the file being uploaded, decides where exactly the file will be stored
  *   inside the storage bucket.
- * @property {FileStoragePlatformModel.StartRequest} body
+ * @property {FileStoragePlatformModel.FileUploadStart} body
  */
 
 class FileStoragePlatformValidator {
@@ -60,7 +60,7 @@ class FileStoragePlatformValidator {
   static completeUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
-      body: FileStoragePlatformModel.StartResponse().required(),
+      body: FileStoragePlatformModel.FileUpload().required(),
     }).required();
   }
 
@@ -75,7 +75,7 @@ class FileStoragePlatformValidator {
   /** @returns {GetSignUrlsParam} */
   static getSignUrls() {
     return Joi.object({
-      body: FileStoragePlatformModel.SignUrlRequest().required(),
+      body: FileStoragePlatformModel.SignUrl().required(),
     }).required();
   }
 
@@ -90,7 +90,7 @@ class FileStoragePlatformValidator {
   static startUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
-      body: FileStoragePlatformModel.StartRequest().required(),
+      body: FileStoragePlatformModel.FileUploadStart().required(),
     }).required();
   }
 }

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

@@ -46,12 +46,12 @@ declare class Lead {
      * @param {LeadPlatformValidator.GetGeneralConfigParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<LeadPlatformModel.GeneralConfigResponse>} - Success response
+     * @returns {Promise<LeadPlatformModel.GeneralConfigDetails>} - Success response
      * @name getGeneralConfig
      * @summary: Get general configuration
      * @description: Get general configuration settings related to support system for company tickets - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
      */
-    getGeneralConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.GeneralConfigResponse>;
+    getGeneralConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.GeneralConfigDetails>;
     /**
      * @param {LeadPlatformValidator.GetPlatformTicketParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Lead/LeadPlatformClient.js

@@ -336,7 +336,7 @@ class Lead {
    * @param {LeadPlatformValidator.GetGeneralConfigParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<LeadPlatformModel.GeneralConfigResponse>} - Success response
+   * @returns {Promise<LeadPlatformModel.GeneralConfigDetails>} - Success response
    * @name getGeneralConfig
    * @summary: Get general configuration
    * @description: Get general configuration settings related to support system for company tickets - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
@@ -388,7 +388,7 @@ class Lead {
 
     const {
       error: res_error,
-    } = LeadPlatformModel.GeneralConfigResponse().validate(responseData, {
+    } = LeadPlatformModel.GeneralConfigDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

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

@@ -1,6 +1,6 @@
 export = LeadPlatformModel;
 /**
- * @typedef GeneralConfigResponse
+ * @typedef GeneralConfigDetails
  * @property {string} [_id]
  * @property {SupportCommunicationSchema[]} [support_communication]
  * @property {boolean} [show_communication_info]
@@ -288,11 +288,11 @@ export = LeadPlatformModel;
 declare class LeadPlatformModel {
 }
 declare namespace LeadPlatformModel {
-    export { GeneralConfigResponse, SupportCommunicationSchema, SupportSchema, GeneralConfigIntegrationSchema, TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, SLA, Status, TicketFeedbackList, TicketFeedbackPayload, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, FeedbackResponseItem, TicketFeedback, TicketHistory, Ticket, ErrorMessage, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
+    export { GeneralConfigDetails, SupportCommunicationSchema, SupportSchema, GeneralConfigIntegrationSchema, TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, SLA, Status, TicketFeedbackList, TicketFeedbackPayload, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, FeedbackResponseItem, TicketFeedback, TicketHistory, Ticket, ErrorMessage, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
 }
-/** @returns {GeneralConfigResponse} */
-declare function GeneralConfigResponse(): GeneralConfigResponse;
-type GeneralConfigResponse = {
+/** @returns {GeneralConfigDetails} */
+declare function GeneralConfigDetails(): GeneralConfigDetails;
+type GeneralConfigDetails = {
     _id?: string;
     support_communication?: SupportCommunicationSchema[];
     show_communication_info?: boolean;

package/sdk/platform/Lead/LeadPlatformModel.js

@@ -1,7 +1,7 @@
 const Joi = require("joi");
 
 /**
- * @typedef GeneralConfigResponse
+ * @typedef GeneralConfigDetails
  * @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 {GeneralConfigResponse} */
-  static GeneralConfigResponse() {
+  /** @returns {GeneralConfigDetails} */
+  static GeneralConfigDetails() {
     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.any().required(),
+      value: Joi.object().pattern(/\S/, Joi.any()).required(),
       type: LeadPlatformModel.HistoryTypeEnum().required(),
     });
   }
@@ -515,12 +515,12 @@ class LeadPlatformModel {
   /** @returns {AddTicketPayload} */
   static AddTicketPayload() {
     return Joi.object({
-      created_by: Joi.any(),
+      created_by: Joi.object().pattern(/\S/, Joi.any()),
       status: Joi.string().allow(""),
       priority: LeadPlatformModel.PriorityEnum(),
       category: Joi.string().allow("").required(),
       content: LeadPlatformModel.TicketContent().required(),
-      _custom_json: Joi.any(),
+      _custom_json: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -559,7 +559,7 @@ class LeadPlatformModel {
   /** @returns {TicketFeedbackPayload} */
   static TicketFeedbackPayload() {
     return Joi.object({
-      form_response: Joi.any(),
+      form_response: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -605,9 +605,9 @@ class LeadPlatformModel {
   /** @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()),
     });
   }
 
@@ -641,7 +641,7 @@ class LeadPlatformModel {
         .items(LeadPlatformModel.FeedbackResponseItem())
         .required(),
       category: Joi.string().allow(""),
-      user: Joi.any(),
+      user: Joi.object().pattern(/\S/, 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.any().required(),
+      value: Joi.object().pattern(/\S/, Joi.any()).required(),
       ticket_id: Joi.string().allow("").required(),
       created_on: LeadPlatformModel.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(""),
@@ -674,12 +674,12 @@ class LeadPlatformModel {
       status: LeadPlatformModel.Status().required(),
       priority: LeadPlatformModel.Priority().required(),
       sla: LeadPlatformModel.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(""),

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

@@ -9,26 +9,37 @@ declare class Order {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
+     * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
      *   - 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.ShipmentInternalPlatformViewResponse>;
+    getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
     /**
      * @param {OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam} arg
      *   - Arg object
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
+     * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>} -
+     *   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.ShipmentReasonsResponse>;
+    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>;
     /**
      * @param {OrderPlatformApplicationValidator.GetShipmentBagReasonsParam} arg
      *   - Arg object
@@ -37,8 +48,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
      * @name getShipmentBagReasons
-     * @summary: List bag 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/getShipmentBagReasons/).
+     * @summary: Retrieve Reasons for Cancellation and Return journey
+     * @description: Allows users to retrieve a comprehensive list of reasons for cancellation  or returning a shipment. It provides both cancellation and return reasons, with an emphasis  on Quality Control (QC) evaluations. - 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>;
     /**

package/sdk/platform/Order/OrderPlatformApplicationClient.js

@@ -21,7 +21,7 @@ class Order {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
+   * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
    *   - Success response
    *
    * @name getApplicationShipments
@@ -139,7 +139,7 @@ class Order {
 
     const {
       error: res_error,
-    } = OrderPlatformModel.ShipmentInternalPlatformViewResponse().validate(
+    } = OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -164,7 +164,8 @@ class Order {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
+   * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>} -
+   *   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/).
@@ -220,7 +221,84 @@ class Order {
 
     const {
       error: res_error,
-    } = OrderPlatformModel.ShipmentReasonsResponse().validate(responseData, {
+    } = 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, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -231,7 +309,7 @@ class Order {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for platform > Order > getPlatformShipmentReasons \n ${res_error}`,
+          message: `Response Validation Warnings for platform > Order > getRules \n ${res_error}`,
         });
       }
     }
@@ -247,8 +325,8 @@ class Order {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
    * @name getShipmentBagReasons
-   * @summary: List bag 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/getShipmentBagReasons/).
+   * @summary: Retrieve Reasons for Cancellation and Return journey
+   * @description: Allows users to retrieve a comprehensive list of reasons for cancellation  or returning a shipment. It provides both cancellation and return reasons, with an emphasis  on Quality Control (QC) evaluations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
    */
   async getShipmentBagReasons(
     { shipmentId, lineNumber, requestHeaders } = { requestHeaders: {} },

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

@@ -1,83 +1,154 @@
 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]
+ * @property {string} [lane] - Optional parameter to specify the lane for
+ *   filtering results.
+ * @property {string} [searchType] - Search_type refers to the field that will
+ *   be used as the target for the search operation
+ * @property {string} [searchId] - Identifier used for the search operation
+ *   based on the selected search type.
+ * @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} [dpIds] - Comma-separated list of delivery partner IDs to
+ *   filter results.
+ * @property {string} [orderingCompanyId] - ID of the company placing the order,
+ *   used for filtering results.
+ * @property {string} [stores] - Comma-separated list of store IDs to filter results.
+ * @property {string} [salesChannel] - The sales channel to filter results.
+ * @property {string} [requestByExt] - Identifier for external requests.
+ * @property {number} [pageNo] - The page number for pagination of results.
+ * @property {number} [pageSize] - The number of results to return per page for
+ *   pagination.
+ * @property {string} [customerId] - ID of the customer to filter results
+ *   related to specific customer.
+ * @property {boolean} [isPrioritySort] - Flag to determine if results should be
+ *   sorted by priority. Defaults to true.
+ * @property {boolean} [excludeLockedShipments] - Flag to exclude shipments that
+ *   are currently locked from the results.
  */
 /**
  * @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
- *   items and may get divided into one or more shipment, each having its own ID.
- * @property {number} lineNumber - Line number of bag.
+ * @property {string} shipmentId - The unique identifier for the shipment
+ * @property {number} lineNumber - A unique identifier of the bag's line number.
  */
 /**
  * @typedef TrackShipmentPlatformParam
- * @property {string} shipmentId - Shipment Id
+ * @property {string} shipmentId - The unique identifier for the shipment
  */
 declare class OrderPlatformApplicationValidator {
     /** @returns {GetApplicationShipmentsParam} */
     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 { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
+    export { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetRulesParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
 }
 type GetApplicationShipmentsParam = {
+    /**
+     * - Optional parameter to specify the lane for
+     * filtering results.
+     */
     lane?: string;
+    /**
+     * - Search_type refers to the field that will
+     * be used as the target for the search operation
+     */
     searchType?: string;
+    /**
+     * - Identifier used for the search operation
+     * based on the selected search type.
+     */
     searchId?: string;
+    /**
+     * - Date time in UTC timezone as per ISO format.
+     */
     fromDate?: string;
+    /**
+     * - Date time in UTC timezone as per ISO format.
+     */
     toDate?: string;
+    /**
+     * - Comma-separated list of delivery partner IDs to
+     * filter results.
+     */
     dpIds?: string;
+    /**
+     * - ID of the company placing the order,
+     * used for filtering results.
+     */
     orderingCompanyId?: string;
+    /**
+     * - Comma-separated list of store IDs to filter results.
+     */
     stores?: string;
+    /**
+     * - The sales channel to filter results.
+     */
     salesChannel?: string;
+    /**
+     * - Identifier for external requests.
+     */
     requestByExt?: string;
+    /**
+     * - The page number for pagination of results.
+     */
     pageNo?: number;
+    /**
+     * - The number of results to return per page for
+     * pagination.
+     */
     pageSize?: number;
+    /**
+     * - ID of the customer to filter results
+     * related to specific customer.
+     */
     customerId?: string;
+    /**
+     * - Flag to determine if results should be
+     * sorted by priority. Defaults to true.
+     */
     isPrioritySort?: boolean;
+    /**
+     * - Flag to exclude shipments that
+     * are currently locked from the results.
+     */
     excludeLockedShipments?: boolean;
 };
 type GetPlatformShipmentReasonsParam = {
     action: string;
 };
+type GetRulesParam = {
+    body: OrderPlatformModel.RuleListRequestSchema;
+};
 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.
+     * - The unique identifier for the shipment
      */
     shipmentId: string;
     /**
-     * - Line number of bag.
+     * - A unique identifier of the bag's line number.
      */
     lineNumber: number;
 };
 type TrackShipmentPlatformParam = {
     /**
-     * - Shipment Id
+     * - The unique identifier for the shipment
      */
     shipmentId: string;
 };
+import OrderPlatformModel = require("./OrderPlatformModel");