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

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js

@@ -12,11 +12,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {ServiceabilityPlatformModel.BulkGeoAreaDetails} body
  */
 
-/**
- * @typedef CreateBulkZoneParam
- * @property {ServiceabilityPlatformModel.CreateBulkZoneData} body
- */
-
 /**
  * @typedef CreateCourierPartnerRuleParam
  * @property {ServiceabilityPlatformModel.CourierPartnerRule} body
@@ -34,12 +29,12 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef CreateStoreRulesParam
- * @property {ServiceabilityPlatformModel.CreateStoreRuleRequestSchema} body
+ * @property {ServiceabilityPlatformModel.CreateStoreRuleDetailsSchema} body
  */
 
 /**
  * @typedef CreateZoneParam
- * @property {ServiceabilityPlatformModel.CreateZoneV2Data} body
+ * @property {ServiceabilityPlatformModel.CreateZoneDataSchema} body
  */
 
 /**
@@ -49,11 +44,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /** @typedef DownloadGeoareaSampleFileParam */
 
-/**
- * @typedef DownloadZoneSampleFileParam
- * @property {string} productType - It denotes the attribute of the product
- */
-
 /** @typedef GetApplicationConfigParam */
 
 /** @typedef GetApplicationConfigurationParam */
@@ -68,26 +58,23 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {string} geoareaId - A unique identifier for the GeoArea.
  */
 
-/** @typedef GetBulkZoneParam */
-
 /**
  * @typedef GetCourierPartnerRuleParam
- * @property {string} ruleUid - A `rule_uid` is a unique identifier for a particular Dp.
- */
-
-/**
- * @typedef GetCourierPartnerRuleDetailsParam
- * @property {string} ruleUid - A `rule_uid` is a unique identifier for a
- *   courier partner rule.
+ * @property {string} ruleUid - Unique identifier of the courier partner rule
  */
 
 /**
  * @typedef GetCourierPartnerRulesParam
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageNo] - The current page number for paginated results.
  * @property {number} [pageSize] - Determines the items to be displayed in a page
  * @property {string} [status] - Filter rules based on rule status
  */
 
+/**
+ * @typedef GetCourierPartnersParam
+ * @property {ServiceabilityPlatformModel.ShipmentCourierPartnerDetails} body
+ */
+
 /**
  * @typedef GetGeoAreaParam
  * @property {string} geoareaId - A unique identifier for the GeoArea.
@@ -104,7 +91,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {boolean} [isActive] - Status of GeoAreas (either active or inactive)
  * @property {number} [pageNo] - Current page number
  * @property {string} [type] - To fetch the type of a specific geoarea.
- * @property {string} [q] - Search with name as a free text
+ * @property {string} [q] - Used to search for matching results based on the
+ *   provided input.
  * @property {string} [countryIsoCode] - ISO2 code of the country
  * @property {string} [state] - State name
  * @property {string} [city] - City name
@@ -118,17 +106,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  *   particular rule object.
  */
 
-/**
- * @typedef GetStoreRuleDetailsParam
- * @property {string} ruleUid - A `rule_uid` is a unique identifier for a order
- *   routing rule.
- */
-
 /**
  * @typedef GetStoreRulesParam
- * @property {number} [pageNo]
- * @property {number} [pageSize]
- * @property {string} [status]
+ * @property {number} [pageNo] - The current page number for paginated results.
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [status] - Filter rules based on rule status
  */
 
 /**
@@ -136,19 +118,14 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {string} zoneId - Unique identifier for a particular zone
  */
 
-/**
- * @typedef GetZoneDetailsParam
- * @property {string} zoneId - Unique identifier of a particular zone
- */
-
 /**
  * @typedef GetZonesParam
  * @property {string} [stage] - Identifies the specific stage of zone bing requested.
- * @property {string} [type] - Using type, you can filter custom or default zones
  * @property {number} [pageSize] - Defines the number of items displayed per page.
  * @property {number} [pageNo] - Current page number.
  * @property {boolean} [isActive] - Status of Zone (either active or inactive)
- * @property {string} [q] - Search with name as a free text.
+ * @property {string} [q] - Used to search for matching results based on the
+ *   provided input.
  * @property {string} [countryIsoCode] - ISO2 code of the country.
  * @property {string} [pincode] - PIN Code of the country.
  * @property {string} [state] - State of the country.
@@ -163,12 +140,12 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef PatchApplicationConfigurationParam
- * @property {ServiceabilityPlatformModel.ApplicationConfigPatchRequest} body
+ * @property {ServiceabilityPlatformModel.ApplicationConfigPatch} body
  */
 
 /**
  * @typedef UpdateApplicationConfigurationParam
- * @property {ServiceabilityPlatformModel.ApplicationConfigPutRequest} body
+ * @property {ServiceabilityPlatformModel.ApplicationConfigPutDetail} body
  */
 
 /**
@@ -179,12 +156,12 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef UpdateCourierPartnerRulePriorityParam
- * @property {ServiceabilityPlatformModel.RulePriorityRequest} body
+ * @property {ServiceabilityPlatformModel.RulePriorityDetails} body
  */
 
 /**
  * @typedef UpdateCourierRuleParam
- * @property {string} ruleUid - A `rule_uid` is a unique identifier for a particular Dp.
+ * @property {string} ruleUid - Unique identifier of the courier partner rule.
  * @property {ServiceabilityPlatformModel.CourierPartnerRule} body
  */
 
@@ -196,7 +173,9 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef UpdatePincodeAuditHistoryParam
- * @property {ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryRequest} body
+ * @property {number} [pageNumber] - Page number to be fetched.
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryDetails} body
  */
 
 /**
@@ -206,7 +185,9 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef UpdatePincodeCoDListingParam
- * @property {ServiceabilityPlatformModel.PincodeCodStatusListingRequest} body
+ * @property {number} [pageNumber] - Page number to be fetched.
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {ServiceabilityPlatformModel.PincodeCodStatusListingDetails} body
  */
 
 /**
@@ -216,14 +197,14 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef UpdateStoreRulePriorityParam
- * @property {ServiceabilityPlatformModel.RulePriorityRequest} body
+ * @property {ServiceabilityPlatformModel.RulePriorityDetails} body
  */
 
 /**
  * @typedef UpdateStoreRulesParam
  * @property {string} ruleUid - A `rule_uid` is a unique identifier for a
  *   particular rule object.
- * @property {ServiceabilityPlatformModel.CreateStoreRuleRequestSchema} body
+ * @property {ServiceabilityPlatformModel.CreateStoreRuleDetailsSchema} body
  */
 
 /**
@@ -234,7 +215,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 /**
  * @typedef UpdateZoneParam
  * @property {string} zoneId - Unique identifier for a particular zone
- * @property {ServiceabilityPlatformModel.UpdateZoneDataV2} body
+ * @property {ServiceabilityPlatformModel.UpdateZoneData} body
  */
 
 class ServiceabilityPlatformApplicationValidator {
@@ -252,13 +233,6 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {CreateBulkZoneParam} */
-  static createBulkZone() {
-    return Joi.object({
-      body: ServiceabilityPlatformModel.CreateBulkZoneData().required(),
-    }).required();
-  }
-
   /** @returns {CreateCourierPartnerRuleParam} */
   static createCourierPartnerRule() {
     return Joi.object({
@@ -283,14 +257,14 @@ class ServiceabilityPlatformApplicationValidator {
   /** @returns {CreateStoreRulesParam} */
   static createStoreRules() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.CreateStoreRuleRequestSchema().required(),
+      body: ServiceabilityPlatformModel.CreateStoreRuleDetailsSchema().required(),
     }).required();
   }
 
   /** @returns {CreateZoneParam} */
   static createZone() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.CreateZoneV2Data().required(),
+      body: ServiceabilityPlatformModel.CreateZoneDataSchema().required(),
     }).required();
   }
 
@@ -306,13 +280,6 @@ class ServiceabilityPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {DownloadZoneSampleFileParam} */
-  static downloadZoneSampleFile() {
-    return Joi.object({
-      productType: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {GetApplicationConfigParam} */
   static getApplicationConfig() {
     return Joi.object({}).required();
@@ -337,11 +304,6 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetBulkZoneParam} */
-  static getBulkZone() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {GetCourierPartnerRuleParam} */
   static getCourierPartnerRule() {
     return Joi.object({
@@ -349,13 +311,6 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetCourierPartnerRuleDetailsParam} */
-  static getCourierPartnerRuleDetails() {
-    return Joi.object({
-      ruleUid: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {GetCourierPartnerRulesParam} */
   static getCourierPartnerRules() {
     return Joi.object({
@@ -365,6 +320,13 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetCourierPartnersParam} */
+  static getCourierPartners() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.ShipmentCourierPartnerDetails().required(),
+    }).required();
+  }
+
   /** @returns {GetGeoAreaParam} */
   static getGeoArea() {
     return Joi.object({
@@ -402,13 +364,6 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetStoreRuleDetailsParam} */
-  static getStoreRuleDetails() {
-    return Joi.object({
-      ruleUid: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {GetStoreRulesParam} */
   static getStoreRules() {
     return Joi.object({
@@ -425,18 +380,10 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetZoneDetailsParam} */
-  static getZoneDetails() {
-    return Joi.object({
-      zoneId: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {GetZonesParam} */
   static getZones() {
     return Joi.object({
       stage: Joi.string().allow(""),
-      type: Joi.string().allow(""),
       pageSize: Joi.number(),
       pageNo: Joi.number(),
       isActive: Joi.boolean(),
@@ -459,14 +406,14 @@ class ServiceabilityPlatformApplicationValidator {
   /** @returns {PatchApplicationConfigurationParam} */
   static patchApplicationConfiguration() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.ApplicationConfigPatchRequest().required(),
+      body: ServiceabilityPlatformModel.ApplicationConfigPatch().required(),
     }).required();
   }
 
   /** @returns {UpdateApplicationConfigurationParam} */
   static updateApplicationConfiguration() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.ApplicationConfigPutRequest().required(),
+      body: ServiceabilityPlatformModel.ApplicationConfigPutDetail().required(),
     }).required();
   }
 
@@ -481,7 +428,7 @@ class ServiceabilityPlatformApplicationValidator {
   /** @returns {UpdateCourierPartnerRulePriorityParam} */
   static updateCourierPartnerRulePriority() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.RulePriorityRequest().required(),
+      body: ServiceabilityPlatformModel.RulePriorityDetails().required(),
     }).required();
   }
 
@@ -505,7 +452,9 @@ class ServiceabilityPlatformApplicationValidator {
   /** @returns {UpdatePincodeAuditHistoryParam} */
   static updatePincodeAuditHistory() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryRequest().required(),
+      pageNumber: Joi.number(),
+      pageSize: Joi.number(),
+      body: ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryDetails().required(),
     }).required();
   }
 
@@ -519,7 +468,9 @@ class ServiceabilityPlatformApplicationValidator {
   /** @returns {UpdatePincodeCoDListingParam} */
   static updatePincodeCoDListing() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.PincodeCodStatusListingRequest().required(),
+      pageNumber: Joi.number(),
+      pageSize: Joi.number(),
+      body: ServiceabilityPlatformModel.PincodeCodStatusListingDetails().required(),
     }).required();
   }
 
@@ -533,7 +484,7 @@ class ServiceabilityPlatformApplicationValidator {
   /** @returns {UpdateStoreRulePriorityParam} */
   static updateStoreRulePriority() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.RulePriorityRequest().required(),
+      body: ServiceabilityPlatformModel.RulePriorityDetails().required(),
     }).required();
   }
 
@@ -541,7 +492,7 @@ class ServiceabilityPlatformApplicationValidator {
   static updateStoreRules() {
     return Joi.object({
       ruleUid: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.CreateStoreRuleRequestSchema().required(),
+      body: ServiceabilityPlatformModel.CreateStoreRuleDetailsSchema().required(),
     }).required();
   }
 
@@ -557,7 +508,7 @@ class ServiceabilityPlatformApplicationValidator {
     return Joi.object({
       zoneId: Joi.string().allow("").required(),
 
-      body: ServiceabilityPlatformModel.UpdateZoneDataV2().required(),
+      body: ServiceabilityPlatformModel.UpdateZoneData().required(),
     }).required();
   }
 }