@gofynd/fdk-client-javascript 1.6.3 → 2.0.0

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js

@@ -2,30 +2,70 @@ const Joi = require("joi");
 
 const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
+/**
+ * @typedef CreateBulkExportParam
+ * @property {ServiceabilityPlatformModel.BulkCreateZoneExport} body
+ */
+
+/**
+ * @typedef CreateBulkGeoAreaParam
+ * @property {ServiceabilityPlatformModel.BulkGeoAreaDetails} body
+ */
+
 /**
  * @typedef CreateCourierPartnerRuleParam
  * @property {ServiceabilityPlatformModel.CourierPartnerRule} body
  */
 
+/**
+ * @typedef CreateGeoAreaParam
+ * @property {ServiceabilityPlatformModel.GeoAreaRequestBody} body
+ */
+
+/**
+ * @typedef CreateGeoAreaExportJobParam
+ * @property {string} geoareaId - The unique identifier of the Geoarea.
+ */
+
 /**
  * @typedef CreateStoreRulesParam
  * @property {ServiceabilityPlatformModel.CreateStoreRuleDetailsSchema} body
  */
 
+/**
+ * @typedef CreateZoneParam
+ * @property {ServiceabilityPlatformModel.CreateZoneDataSchema} body
+ */
+
+/**
+ * @typedef DeleteZoneParam
+ * @property {string} zoneId - Unique identifier for a particular zone
+ */
+
+/** @typedef DownloadGeoareaSampleFileParam */
+
 /** @typedef GetApplicationConfigParam */
 
 /** @typedef GetApplicationConfigurationParam */
 
-/** @typedef GetApplicationServiceabilitySelfShipmentParam */
+/**
+ * @typedef GetBulkExportParam
+ * @property {string} batchId - A `batch_id` is a unique identifier for a particular zone.
+ */
+
+/**
+ * @typedef GetBulkGeoAreaParam
+ * @property {string} geoareaId - A unique identifier for the GeoArea.
+ */
 
 /**
  * @typedef GetCourierPartnerRuleParam
- * @property {string} ruleId - Unique identifier of the 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
  */
@@ -35,6 +75,31 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {ServiceabilityPlatformModel.ShipmentCourierPartnerDetails} body
  */
 
+/**
+ * @typedef GetGeoAreaParam
+ * @property {string} geoareaId - A unique identifier for the GeoArea.
+ */
+
+/**
+ * @typedef GetGeoAreaExportJobStatusParam
+ * @property {string} geoareaId - The unique identifier of the Geoarea.
+ */
+
+/**
+ * @typedef GetGeoAreasParam
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @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] - 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
+ * @property {string} [pincode] - Pincode value to search geoareas
+ * @property {string} [sector] - Sector value to search geoareas
+ */
+
 /**
  * @typedef GetStoreRuleParam
  * @property {string} ruleUid - A `rule_uid` is a unique identifier for a
@@ -43,9 +108,29 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @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
+ */
+
+/**
+ * @typedef GetZoneParam
+ * @property {string} zoneId - Unique identifier for a particular zone
+ */
+
+/**
+ * @typedef GetZonesParam
+ * @property {string} [stage] - Identifies the specific stage of zone bing requested.
+ * @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] - 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.
+ * @property {string} [city] - City of the country.
+ * @property {string} [sector] - Sector name of mentioned address.
  */
 
 /**
@@ -54,13 +139,19 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  */
 
 /**
- * @typedef PatchApplicationServiceabilitySelfShipmentParam
- * @property {ServiceabilityPlatformModel.SelfShipResult} body
+ * @typedef PatchApplicationConfigurationParam
+ * @property {ServiceabilityPlatformModel.ApplicationConfigPatch} body
  */
 
 /**
  * @typedef UpdateApplicationConfigurationParam
- * @property {ServiceabilityPlatformModel.ApplicationConfig} body
+ * @property {ServiceabilityPlatformModel.ApplicationConfigPutDetail} body
+ */
+
+/**
+ * @typedef UpdateBulkGeoAreaParam
+ * @property {string} geoareaId - A unique identifier for the GeoArea.
+ * @property {ServiceabilityPlatformModel.BulkGeoAreaDetails} body
  */
 
 /**
@@ -70,10 +161,16 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef UpdateCourierRuleParam
- * @property {string} ruleId - Unique identifier of the courier partner rule.
+ * @property {string} ruleUid - Unique identifier of the courier partner rule.
  * @property {ServiceabilityPlatformModel.CourierPartnerRule} body
  */
 
+/**
+ * @typedef UpdateGeoAreaParam
+ * @property {string} geoareaId - A unique identifier for the GeoArea.
+ * @property {ServiceabilityPlatformModel.GeoAreaRequestBody} body
+ */
+
 /**
  * @typedef UpdatePincodeAuditHistoryParam
  * @property {number} [pageNumber] - Page number to be fetched.
@@ -98,6 +195,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {ServiceabilityPlatformModel.PincodeMopData} body
  */
 
+/**
+ * @typedef UpdateStoreRulePriorityParam
+ * @property {ServiceabilityPlatformModel.RulePriorityDetails} body
+ */
+
 /**
  * @typedef UpdateStoreRulesParam
  * @property {string} ruleUid - A `rule_uid` is a unique identifier for a
@@ -110,7 +212,27 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {ServiceabilityPlatformModel.StoreRuleConfigData} body
  */
 
+/**
+ * @typedef UpdateZoneParam
+ * @property {string} zoneId - Unique identifier for a particular zone
+ * @property {ServiceabilityPlatformModel.UpdateZoneData} body
+ */
+
 class ServiceabilityPlatformApplicationValidator {
+  /** @returns {CreateBulkExportParam} */
+  static createBulkExport() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.BulkCreateZoneExport().required(),
+    }).required();
+  }
+
+  /** @returns {CreateBulkGeoAreaParam} */
+  static createBulkGeoArea() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.BulkGeoAreaDetails().required(),
+    }).required();
+  }
+
   /** @returns {CreateCourierPartnerRuleParam} */
   static createCourierPartnerRule() {
     return Joi.object({
@@ -118,6 +240,20 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {CreateGeoAreaParam} */
+  static createGeoArea() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.GeoAreaRequestBody().required(),
+    }).required();
+  }
+
+  /** @returns {CreateGeoAreaExportJobParam} */
+  static createGeoAreaExportJob() {
+    return Joi.object({
+      geoareaId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {CreateStoreRulesParam} */
   static createStoreRules() {
     return Joi.object({
@@ -125,6 +261,25 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {CreateZoneParam} */
+  static createZone() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.CreateZoneDataSchema().required(),
+    }).required();
+  }
+
+  /** @returns {DeleteZoneParam} */
+  static deleteZone() {
+    return Joi.object({
+      zoneId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {DownloadGeoareaSampleFileParam} */
+  static downloadGeoareaSampleFile() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {GetApplicationConfigParam} */
   static getApplicationConfig() {
     return Joi.object({}).required();
@@ -135,15 +290,24 @@ class ServiceabilityPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetApplicationServiceabilitySelfShipmentParam} */
-  static getApplicationServiceabilitySelfShipment() {
-    return Joi.object({}).required();
+  /** @returns {GetBulkExportParam} */
+  static getBulkExport() {
+    return Joi.object({
+      batchId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetBulkGeoAreaParam} */
+  static getBulkGeoArea() {
+    return Joi.object({
+      geoareaId: Joi.string().allow("").required(),
+    }).required();
   }
 
   /** @returns {GetCourierPartnerRuleParam} */
   static getCourierPartnerRule() {
     return Joi.object({
-      ruleId: Joi.string().allow("").required(),
+      ruleUid: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -163,6 +327,36 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetGeoAreaParam} */
+  static getGeoArea() {
+    return Joi.object({
+      geoareaId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetGeoAreaExportJobStatusParam} */
+  static getGeoAreaExportJobStatus() {
+    return Joi.object({
+      geoareaId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetGeoAreasParam} */
+  static getGeoAreas() {
+    return Joi.object({
+      pageSize: Joi.number(),
+      isActive: Joi.boolean(),
+      pageNo: Joi.number(),
+      type: Joi.string().allow(""),
+      q: Joi.string().allow(""),
+      countryIsoCode: Joi.string().allow(""),
+      state: Joi.string().allow(""),
+      city: Joi.string().allow(""),
+      pincode: Joi.string().allow(""),
+      sector: Joi.string().allow(""),
+    }).required();
+  }
+
   /** @returns {GetStoreRuleParam} */
   static getStoreRule() {
     return Joi.object({
@@ -179,6 +373,29 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetZoneParam} */
+  static getZone() {
+    return Joi.object({
+      zoneId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetZonesParam} */
+  static getZones() {
+    return Joi.object({
+      stage: Joi.string().allow(""),
+      pageSize: Joi.number(),
+      pageNo: Joi.number(),
+      isActive: Joi.boolean(),
+      q: Joi.string().allow(""),
+      countryIsoCode: Joi.string().allow(""),
+      pincode: Joi.string().allow(""),
+      state: Joi.string().allow(""),
+      city: Joi.string().allow(""),
+      sector: Joi.string().allow(""),
+    }).required();
+  }
+
   /** @returns {InsertApplicationConfigParam} */
   static insertApplicationConfig() {
     return Joi.object({
@@ -186,17 +403,25 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {PatchApplicationServiceabilitySelfShipmentParam} */
-  static patchApplicationServiceabilitySelfShipment() {
+  /** @returns {PatchApplicationConfigurationParam} */
+  static patchApplicationConfiguration() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.SelfShipResult().required(),
+      body: ServiceabilityPlatformModel.ApplicationConfigPatch().required(),
     }).required();
   }
 
   /** @returns {UpdateApplicationConfigurationParam} */
   static updateApplicationConfiguration() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.ApplicationConfig().required(),
+      body: ServiceabilityPlatformModel.ApplicationConfigPutDetail().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateBulkGeoAreaParam} */
+  static updateBulkGeoArea() {
+    return Joi.object({
+      geoareaId: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.BulkGeoAreaDetails().required(),
     }).required();
   }
 
@@ -210,11 +435,20 @@ class ServiceabilityPlatformApplicationValidator {
   /** @returns {UpdateCourierRuleParam} */
   static updateCourierRule() {
     return Joi.object({
-      ruleId: Joi.string().allow("").required(),
+      ruleUid: Joi.string().allow("").required(),
       body: ServiceabilityPlatformModel.CourierPartnerRule().required(),
     }).required();
   }
 
+  /** @returns {UpdateGeoAreaParam} */
+  static updateGeoArea() {
+    return Joi.object({
+      geoareaId: Joi.string().allow("").required(),
+
+      body: ServiceabilityPlatformModel.GeoAreaRequestBody().required(),
+    }).required();
+  }
+
   /** @returns {UpdatePincodeAuditHistoryParam} */
   static updatePincodeAuditHistory() {
     return Joi.object({
@@ -247,6 +481,13 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {UpdateStoreRulePriorityParam} */
+  static updateStoreRulePriority() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.RulePriorityDetails().required(),
+    }).required();
+  }
+
   /** @returns {UpdateStoreRulesParam} */
   static updateStoreRules() {
     return Joi.object({
@@ -261,6 +502,15 @@ class ServiceabilityPlatformApplicationValidator {
       body: ServiceabilityPlatformModel.StoreRuleConfigData().required(),
     }).required();
   }
+
+  /** @returns {UpdateZoneParam} */
+  static updateZone() {
+    return Joi.object({
+      zoneId: Joi.string().allow("").required(),
+
+      body: ServiceabilityPlatformModel.UpdateZoneData().required(),
+    }).required();
+  }
 }
 
 module.exports = ServiceabilityPlatformApplicationValidator;