@gofynd/fdk-client-javascript 1.6.3 → 3.0.0-beta.1

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

@@ -1,181 +1,181 @@
 export = OrderPlatformApplicationValidator;
 /**
- * @typedef FailedOrderLogsParam
- * @property {number} [pageNo] - Page Number
- * @property {number} [pageSize] - Page Size
- * @property {string} [searchType] - Search type for filter
- * @property {string} [searchValue] - Search value for filter
+ * @typedef CreateRuleParam
+ * @property {OrderPlatformModel.RuleRequest} body
+ */
+/**
+ * @typedef DeleteRuleParam
+ * @property {string} ruleId
  */
 /**
  * @typedef GetApplicationShipmentsParam
- * @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.
+ * @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]
  */
 /**
  * @typedef GetPlatformShipmentReasonsParam
  * @property {string} action
  */
 /**
- * @typedef GetRulesParam
- * @property {OrderPlatformModel.RuleListRequestSchema} body
+ * @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 GetRuleListParam
+ * @property {OrderPlatformModel.RuleListRequest} body
+ */
+/** @typedef GetRuleParametersParam */
 /**
  * @typedef GetShipmentBagReasonsParam
- * @property {string} shipmentId - The unique identifier for the shipment
- * @property {number} lineNumber - A unique identifier of the bag's line number.
+ * @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.
  */
 /**
  * @typedef TrackShipmentPlatformParam
- * @property {string} shipmentId - The unique identifier for the shipment
+ * @property {string} shipmentId - Shipment Id
+ */
+/**
+ * @typedef UpdateRuleParam
+ * @property {string} ruleId
+ * @property {OrderPlatformModel.RuleUpdateRequest} body
+ */
+/**
+ * @typedef UpdateRulePositionParam
+ * @property {OrderPlatformModel.UpdateRulePositionRequest} body
  */
 declare class OrderPlatformApplicationValidator {
-    /** @returns {FailedOrderLogsParam} */
-    static failedOrderLogs(): FailedOrderLogsParam;
+    /** @returns {CreateRuleParam} */
+    static createRule(): CreateRuleParam;
+    /** @returns {DeleteRuleParam} */
+    static deleteRule(): DeleteRuleParam;
     /** @returns {GetApplicationShipmentsParam} */
     static getApplicationShipments(): GetApplicationShipmentsParam;
     /** @returns {GetPlatformShipmentReasonsParam} */
     static getPlatformShipmentReasons(): GetPlatformShipmentReasonsParam;
-    /** @returns {GetRulesParam} */
-    static getRules(): GetRulesParam;
+    /** @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 {GetShipmentBagReasonsParam} */
     static getShipmentBagReasons(): GetShipmentBagReasonsParam;
     /** @returns {TrackShipmentPlatformParam} */
     static trackShipmentPlatform(): TrackShipmentPlatformParam;
+    /** @returns {UpdateRuleParam} */
+    static updateRule(): UpdateRuleParam;
+    /** @returns {UpdateRulePositionParam} */
+    static updateRulePosition(): UpdateRulePositionParam;
 }
 declare namespace OrderPlatformApplicationValidator {
-    export { FailedOrderLogsParam, GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetRulesParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
+    export { CreateRuleParam, DeleteRuleParam, GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetQuestionsParam, GetRuleByIdParam, GetRuleLaneConfigParam, GetRuleListParam, GetRuleParametersParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam, UpdateRuleParam, UpdateRulePositionParam };
 }
-type FailedOrderLogsParam = {
-    /**
-     * - Page Number
-     */
-    pageNo?: number;
-    /**
-     * - Page Size
-     */
-    pageSize?: number;
-    /**
-     * - Search type for filter
-     */
-    searchType?: string;
-    /**
-     * - Search value for filter
-     */
-    searchValue?: string;
+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;
-    /**
-     * - Date time in UTC timezone as per ISO format.
-     */
+    searchValue?: string;
     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 GetQuestionsParam = {
+    pageNo?: number;
+    pageSize?: number;
+    /**
+     * - To search questions using query
+     */
+    q?: string;
+    /**
+     * - To get active questions
+     */
+    isActive?: boolean;
+};
+type GetRuleByIdParam = {
+    ruleId: string;
+};
+type GetRuleLaneConfigParam = {
+    searchValue?: string;
+};
+type GetRuleListParam = {
+    body: OrderPlatformModel.RuleListRequest;
 };
 type GetShipmentBagReasonsParam = {
     /**
-     * - The unique identifier for the shipment
+     * - ID of the bag. An order may contain multiple
+     * items and may get divided into one or more shipment, each having its own ID.
      */
     shipmentId: string;
     /**
-     * - A unique identifier of the bag's line number.
+     * - Line number of bag.
      */
     lineNumber: number;
+    /**
+     * - The ID of the bag.
+     */
+    bagId: string;
 };
 type TrackShipmentPlatformParam = {
     /**
-     * - The unique identifier for the shipment
+     * - Shipment Id
      */
     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

@@ -3,39 +3,33 @@ const Joi = require("joi");
 const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
- * @typedef FailedOrderLogsParam
- * @property {number} [pageNo] - Page Number
- * @property {number} [pageSize] - Page Size
- * @property {string} [searchType] - Search type for filter
- * @property {string} [searchValue] - Search value for filter
+ * @typedef CreateRuleParam
+ * @property {OrderPlatformModel.RuleRequest} body
+ */
+
+/**
+ * @typedef DeleteRuleParam
+ * @property {string} ruleId
  */
 
 /**
  * @typedef GetApplicationShipmentsParam
- * @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.
+ * @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]
  */
 
 /**
@@ -44,29 +38,66 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 /**
- * @typedef GetRulesParam
- * @property {OrderPlatformModel.RuleListRequestSchema} body
+ * @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 GetRuleListParam
+ * @property {OrderPlatformModel.RuleListRequest} body
+ */
+
+/** @typedef GetRuleParametersParam */
+
 /**
  * @typedef GetShipmentBagReasonsParam
- * @property {string} shipmentId - The unique identifier for the shipment
- * @property {number} lineNumber - A unique identifier of the bag's line number.
+ * @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.
  */
 
 /**
  * @typedef TrackShipmentPlatformParam
- * @property {string} shipmentId - The unique identifier for the shipment
+ * @property {string} shipmentId - Shipment Id
+ */
+
+/**
+ * @typedef UpdateRuleParam
+ * @property {string} ruleId
+ * @property {OrderPlatformModel.RuleUpdateRequest} body
+ */
+
+/**
+ * @typedef UpdateRulePositionParam
+ * @property {OrderPlatformModel.UpdateRulePositionRequest} body
  */
 
 class OrderPlatformApplicationValidator {
-  /** @returns {FailedOrderLogsParam} */
-  static failedOrderLogs() {
+  /** @returns {CreateRuleParam} */
+  static createRule() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      searchType: Joi.string().allow(""),
-      searchValue: Joi.string().allow(""),
+      body: OrderPlatformModel.RuleRequest().required(),
+    }).required();
+  }
+
+  /** @returns {DeleteRuleParam} */
+  static deleteRule() {
+    return Joi.object({
+      ruleId: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -76,6 +107,7 @@ class OrderPlatformApplicationValidator {
       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(""),
@@ -98,18 +130,48 @@ class OrderPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetRulesParam} */
-  static getRules() {
+  /** @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() {
+    return Joi.object({
+      ruleId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetRuleLaneConfigParam} */
+  static getRuleLaneConfig() {
+    return Joi.object({
+      searchValue: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {GetRuleListParam} */
+  static getRuleList() {
     return Joi.object({
-      body: OrderPlatformModel.RuleListRequestSchema().required(),
+      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();
   }
 
@@ -119,6 +181,21 @@ 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;