@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15

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

@@ -1,83 +1,187 @@
 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 GetOrderingSourceConfigBySlugParam
+ * @property {string} slug
  */
 /**
  * @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 ListOrderingSourcesParam
+ * @property {string} [type]
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
  */
 /**
  * @typedef TrackShipmentPlatformParam
- * @property {string} shipmentId - Shipment Id
+ * @property {string} shipmentId - The unique identifier for the shipment
+ */
+/**
+ * @typedef UpdateOrderingSourceConfigBySlugParam
+ * @property {string} slug
+ * @property {OrderPlatformModel.OrderingSourceConfig} body
  */
 declare class OrderPlatformApplicationValidator {
     /** @returns {GetApplicationShipmentsParam} */
     static getApplicationShipments(): GetApplicationShipmentsParam;
+    /** @returns {GetOrderingSourceConfigBySlugParam} */
+    static getOrderingSourceConfigBySlug(): GetOrderingSourceConfigBySlugParam;
     /** @returns {GetPlatformShipmentReasonsParam} */
     static getPlatformShipmentReasons(): GetPlatformShipmentReasonsParam;
+    /** @returns {GetRulesParam} */
+    static getRules(): GetRulesParam;
     /** @returns {GetShipmentBagReasonsParam} */
     static getShipmentBagReasons(): GetShipmentBagReasonsParam;
+    /** @returns {ListOrderingSourcesParam} */
+    static listOrderingSources(): ListOrderingSourcesParam;
     /** @returns {TrackShipmentPlatformParam} */
     static trackShipmentPlatform(): TrackShipmentPlatformParam;
+    /** @returns {UpdateOrderingSourceConfigBySlugParam} */
+    static updateOrderingSourceConfigBySlug(): UpdateOrderingSourceConfigBySlugParam;
 }
 declare namespace OrderPlatformApplicationValidator {
-    export { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
+    export { GetApplicationShipmentsParam, GetOrderingSourceConfigBySlugParam, GetPlatformShipmentReasonsParam, GetRulesParam, GetShipmentBagReasonsParam, ListOrderingSourcesParam, TrackShipmentPlatformParam, UpdateOrderingSourceConfigBySlugParam };
 }
 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 GetOrderingSourceConfigBySlugParam = {
+    slug: string;
+};
 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 ListOrderingSourcesParam = {
+    type?: string;
+    pageNo?: number;
+    pageSize?: number;
+};
 type TrackShipmentPlatformParam = {
     /**
-     * - Shipment Id
+     * - The unique identifier for the shipment
      */
     shipmentId: string;
 };
+type UpdateOrderingSourceConfigBySlugParam = {
+    slug: string;
+    body: OrderPlatformModel.OrderingSourceConfig;
+};
+import OrderPlatformModel = require("./OrderPlatformModel");

package/sdk/platform/Order/OrderPlatformApplicationValidator.js

@@ -4,21 +4,35 @@ 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.
+ */
+
+/**
+ * @typedef GetOrderingSourceConfigBySlugParam
+ * @property {string} slug
  */
 
 /**
@@ -26,16 +40,33 @@ 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 ListOrderingSourcesParam
+ * @property {string} [type]
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
  */
 
 /**
  * @typedef TrackShipmentPlatformParam
- * @property {string} shipmentId - Shipment Id
+ * @property {string} shipmentId - The unique identifier for the shipment
+ */
+
+/**
+ * @typedef UpdateOrderingSourceConfigBySlugParam
+ * @property {string} slug
+ * @property {OrderPlatformModel.OrderingSourceConfig} body
  */
 
 class OrderPlatformApplicationValidator {
@@ -60,6 +91,13 @@ class OrderPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetOrderingSourceConfigBySlugParam} */
+  static getOrderingSourceConfigBySlug() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetPlatformShipmentReasonsParam} */
   static getPlatformShipmentReasons() {
     return Joi.object({
@@ -67,6 +105,13 @@ class OrderPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetRulesParam} */
+  static getRules() {
+    return Joi.object({
+      body: OrderPlatformModel.RuleListRequestSchema().required(),
+    }).required();
+  }
+
   /** @returns {GetShipmentBagReasonsParam} */
   static getShipmentBagReasons() {
     return Joi.object({
@@ -75,12 +120,29 @@ class OrderPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {ListOrderingSourcesParam} */
+  static listOrderingSources() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
   /** @returns {TrackShipmentPlatformParam} */
   static trackShipmentPlatform() {
     return Joi.object({
       shipmentId: Joi.string().allow("").required(),
     }).required();
   }
+
+  /** @returns {UpdateOrderingSourceConfigBySlugParam} */
+  static updateOrderingSourceConfigBySlug() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+      body: OrderPlatformModel.OrderingSourceConfig().required(),
+    }).required();
+  }
 }
 
 module.exports = OrderPlatformApplicationValidator;