@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

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

@@ -1,181 +1,154 @@
 export = OrderPlatformApplicationValidator;
-/**
- * @typedef CreateRuleParam
- * @property {OrderPlatformModel.RuleRequest} body
- */
-/**
- * @typedef DeleteRuleParam
- * @property {string} ruleId
- */
 /**
  * @typedef GetApplicationShipmentsParam
- * @property {string} [lane]
- * @property {string} [searchType]
- * @property {string} [searchId]
- * @property {string} [searchValue]
- * @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 GetQuestionsParam
- * @property {number} [pageNo]
- * @property {number} [pageSize]
- * @property {string} [q] - To search questions using query
- * @property {boolean} [isActive] - To get active questions
- */
-/**
- * @typedef GetRuleByIdParam
- * @property {string} ruleId
- */
-/**
- * @typedef GetRuleLaneConfigParam
- * @property {string} [searchValue]
+ * @typedef GetRulesParam
+ * @property {OrderPlatformModel.RuleListRequestSchema} body
  */
-/**
- * @typedef GetRuleListParam
- * @property {OrderPlatformModel.RuleListRequest} body
- */
-/** @typedef GetRuleParametersParam */
 /**
  * @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} bagId - The ID of the 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
- */
-/**
- * @typedef UpdateRuleParam
- * @property {string} ruleId
- * @property {OrderPlatformModel.RuleUpdateRequest} body
- */
-/**
- * @typedef UpdateRulePositionParam
- * @property {OrderPlatformModel.UpdateRulePositionRequest} body
+ * @property {string} shipmentId - The unique identifier for the shipment
  */
 declare class OrderPlatformApplicationValidator {
-    /** @returns {CreateRuleParam} */
-    static createRule(): CreateRuleParam;
-    /** @returns {DeleteRuleParam} */
-    static deleteRule(): DeleteRuleParam;
     /** @returns {GetApplicationShipmentsParam} */
     static getApplicationShipments(): GetApplicationShipmentsParam;
     /** @returns {GetPlatformShipmentReasonsParam} */
     static getPlatformShipmentReasons(): GetPlatformShipmentReasonsParam;
-    /** @returns {GetQuestionsParam} */
-    static getQuestions(): GetQuestionsParam;
-    /** @returns {GetRuleByIdParam} */
-    static getRuleById(): GetRuleByIdParam;
-    /** @returns {GetRuleLaneConfigParam} */
-    static getRuleLaneConfig(): GetRuleLaneConfigParam;
-    /** @returns {GetRuleListParam} */
-    static getRuleList(): GetRuleListParam;
-    /** @returns {GetRuleParametersParam} */
-    static getRuleParameters(): any;
+    /** @returns {GetRulesParam} */
+    static getRules(): GetRulesParam;
     /** @returns {GetShipmentBagReasonsParam} */
     static getShipmentBagReasons(): GetShipmentBagReasonsParam;
     /** @returns {TrackShipmentPlatformParam} */
     static trackShipmentPlatform(): TrackShipmentPlatformParam;
-    /** @returns {UpdateRuleParam} */
-    static updateRule(): UpdateRuleParam;
-    /** @returns {UpdateRulePositionParam} */
-    static updateRulePosition(): UpdateRulePositionParam;
 }
 declare namespace OrderPlatformApplicationValidator {
-    export { CreateRuleParam, DeleteRuleParam, GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetQuestionsParam, GetRuleByIdParam, GetRuleLaneConfigParam, GetRuleListParam, GetRuleParametersParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam, UpdateRuleParam, UpdateRulePositionParam };
+    export { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetRulesParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
 }
-type CreateRuleParam = {
-    body: OrderPlatformModel.RuleRequest;
-};
-type DeleteRuleParam = {
-    ruleId: string;
-};
 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;
-    searchValue?: 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;
-    isPrioritySort?: boolean;
-    excludeLockedShipments?: boolean;
-};
-type GetPlatformShipmentReasonsParam = {
-    action: string;
-};
-type GetQuestionsParam = {
-    pageNo?: number;
-    pageSize?: number;
     /**
-     * - To search questions using query
+     * - Flag to determine if results should be
+     * sorted by priority. Defaults to true.
      */
-    q?: string;
+    isPrioritySort?: boolean;
     /**
-     * - To get active questions
+     * - Flag to exclude shipments that
+     * are currently locked from the results.
      */
-    isActive?: boolean;
-};
-type GetRuleByIdParam = {
-    ruleId: string;
+    excludeLockedShipments?: boolean;
 };
-type GetRuleLaneConfigParam = {
-    searchValue?: string;
+type GetPlatformShipmentReasonsParam = {
+    action: string;
 };
-type GetRuleListParam = {
-    body: OrderPlatformModel.RuleListRequest;
+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;
-    /**
-     * - The ID of the bag.
-     */
-    bagId: string;
 };
 type TrackShipmentPlatformParam = {
     /**
-     * - Shipment Id
+     * - The unique identifier for the shipment
      */
     shipmentId: string;
 };
-type UpdateRuleParam = {
-    ruleId: string;
-    body: OrderPlatformModel.RuleUpdateRequest;
-};
-type UpdateRulePositionParam = {
-    body: OrderPlatformModel.UpdateRulePositionRequest;
-};
-type GetRuleParametersParam = any;
 import OrderPlatformModel = require("./OrderPlatformModel");

package/sdk/platform/Order/OrderPlatformApplicationValidator.js

@@ -2,34 +2,32 @@ const Joi = require("joi");
 
 const OrderPlatformModel = require("./OrderPlatformModel");
 
-/**
- * @typedef CreateRuleParam
- * @property {OrderPlatformModel.RuleRequest} body
- */
-
-/**
- * @typedef DeleteRuleParam
- * @property {string} ruleId
- */
-
 /**
  * @typedef GetApplicationShipmentsParam
- * @property {string} [lane]
- * @property {string} [searchType]
- * @property {string} [searchId]
- * @property {string} [searchValue]
- * @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.
  */
 
 /**
@@ -38,76 +36,28 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 /**
- * @typedef GetQuestionsParam
- * @property {number} [pageNo]
- * @property {number} [pageSize]
- * @property {string} [q] - To search questions using query
- * @property {boolean} [isActive] - To get active questions
- */
-
-/**
- * @typedef GetRuleByIdParam
- * @property {string} ruleId
+ * @typedef GetRulesParam
+ * @property {OrderPlatformModel.RuleListRequestSchema} body
  */
 
-/**
- * @typedef GetRuleLaneConfigParam
- * @property {string} [searchValue]
- */
-
-/**
- * @typedef GetRuleListParam
- * @property {OrderPlatformModel.RuleListRequest} body
- */
-
-/** @typedef GetRuleParametersParam */
-
 /**
  * @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} bagId - The ID of the 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
- */
-
-/**
- * @typedef UpdateRuleParam
- * @property {string} ruleId
- * @property {OrderPlatformModel.RuleUpdateRequest} body
- */
-
-/**
- * @typedef UpdateRulePositionParam
- * @property {OrderPlatformModel.UpdateRulePositionRequest} body
+ * @property {string} shipmentId - The unique identifier for the shipment
  */
 
 class OrderPlatformApplicationValidator {
-  /** @returns {CreateRuleParam} */
-  static createRule() {
-    return Joi.object({
-      body: OrderPlatformModel.RuleRequest().required(),
-    }).required();
-  }
-
-  /** @returns {DeleteRuleParam} */
-  static deleteRule() {
-    return Joi.object({
-      ruleId: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {GetApplicationShipmentsParam} */
   static getApplicationShipments() {
     return Joi.object({
       lane: Joi.string().allow(""),
       searchType: Joi.string().allow(""),
       searchId: Joi.string().allow(""),
-      searchValue: Joi.string().allow(""),
       fromDate: Joi.string().allow(""),
       toDate: Joi.string().allow(""),
       dpIds: Joi.string().allow(""),
@@ -130,48 +80,18 @@ class OrderPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetQuestionsParam} */
-  static getQuestions() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      q: Joi.string().allow(""),
-      isActive: Joi.boolean(),
-    }).required();
-  }
-
-  /** @returns {GetRuleByIdParam} */
-  static getRuleById() {
+  /** @returns {GetRulesParam} */
+  static getRules() {
     return Joi.object({
-      ruleId: Joi.string().allow("").required(),
+      body: OrderPlatformModel.RuleListRequestSchema().required(),
     }).required();
   }
 
-  /** @returns {GetRuleLaneConfigParam} */
-  static getRuleLaneConfig() {
-    return Joi.object({
-      searchValue: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetRuleListParam} */
-  static getRuleList() {
-    return Joi.object({
-      body: OrderPlatformModel.RuleListRequest().required(),
-    }).required();
-  }
-
-  /** @returns {GetRuleParametersParam} */
-  static getRuleParameters() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {GetShipmentBagReasonsParam} */
   static getShipmentBagReasons() {
     return Joi.object({
       shipmentId: Joi.string().allow("").required(),
       lineNumber: Joi.number().required(),
-      bagId: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -181,21 +101,6 @@ class OrderPlatformApplicationValidator {
       shipmentId: Joi.string().allow("").required(),
     }).required();
   }
-
-  /** @returns {UpdateRuleParam} */
-  static updateRule() {
-    return Joi.object({
-      ruleId: Joi.string().allow("").required(),
-      body: OrderPlatformModel.RuleUpdateRequest().required(),
-    }).required();
-  }
-
-  /** @returns {UpdateRulePositionParam} */
-  static updateRulePosition() {
-    return Joi.object({
-      body: OrderPlatformModel.UpdateRulePositionRequest().required(),
-    }).required();
-  }
 }
 
 module.exports = OrderPlatformApplicationValidator;