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

package/sdk/platform/Order/OrderPlatformApplicationValidator.js

@@ -4,21 +4,30 @@ 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]
+ * @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.
  */
 
 /**
@@ -26,16 +35,20 @@ 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
- *   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
  */
 
 class OrderPlatformApplicationValidator {
@@ -67,6 +80,13 @@ class OrderPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetRulesParam} */
+  static getRules() {
+    return Joi.object({
+      body: OrderPlatformModel.RuleListRequestSchema().required(),
+    }).required();
+  }
+
   /** @returns {GetShipmentBagReasonsParam} */
   static getShipmentBagReasons() {
     return Joi.object({