@gofynd/fdk-client-javascript 1.4.2-beta.1 → 1.4.2-beta.10

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js

@@ -2,230 +2,115 @@ const Joi = require("joi");
 
 const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
-/**
- * @typedef BulkServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
- * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
- */
-
-/**
- * @typedef BulkTatParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
- * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
- */
-
-/**
- * @typedef CreateCourierPartnerAccountParam
- * @property {ServiceabilityPlatformModel.CourierAccount} body
- */
-
-/**
- * @typedef CreatePackageMaterialParam
- * @property {ServiceabilityPlatformModel.PackageMaterial} body
- */
-
-/**
- * @typedef CreatePackageMaterialRuleParam
- * @property {ServiceabilityPlatformModel.PackageRule} body
- */
-
 /**
  * @typedef CreateZoneParam
- * @property {ServiceabilityPlatformModel.CreateZoneData} body
+ * @property {ServiceabilityPlatformModel.ZoneRequest} body
  */
 
 /** @typedef GetAllStoresParam */
 
 /**
- * @typedef GetBulkServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
- * @property {number} [pageNo] - Index of the item to start returning with
- * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [batchId] - Unique identifier of bulk job
- * @property {string} [action] - Import or export bulk type
- * @property {string} [status] - Status of the bulk actions
- * @property {string} [country] - Country for which bulk job is initiated
- * @property {string} [region] - Region for which bulk job is initiated
- * @property {string} [startDate] - Fetch job history after a particule date
- * @property {string} [endDate] - Fetch job history before a particule date
- */
-
-/**
- * @typedef GetBulkTatParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @typedef GetCompanyStoreViewParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [batchId] - Unique identifier of bulk job
- * @property {string} [action] - Import or export bulk type
- * @property {string} [status] - Status of the bulk actions
- * @property {string} [country] - Country for which bulk job is initiated
- * @property {string} [region] - Region for which bulk job is initiated
- * @property {string} [startDate] - Fetch job history after a particule date
- * @property {string} [endDate] - Fetch job history before a particule date
- */
-
-/** @typedef GetCompanyConfigurationParam */
-
-/**
- * @typedef GetCourierPartnerAccountParam
- * @property {string} accountId - Unique ID of courier account
  */
 
 /**
- * @typedef GetCourierPartnerAccountsParam
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @typedef GetDpAccountParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
  * @property {string} [stage] - Stage of the account. enabled/disabled
  * @property {string} [paymentMode] - Filters dp accounts based on payment mode
  * @property {string} [transportType] - Filters dp accounts based on transport_type
  */
 
+/** @typedef GetDpCompanyRulesParam */
+
 /**
- * @typedef GetOptimalLocationsParam
- * @property {ServiceabilityPlatformModel.ReAssignStoreRequest} body
+ * @typedef GetDpRuleInsertParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
  */
 
 /**
- * @typedef GetPackageMaterialListParam
- * @property {number} [pageNo] - Index of the item to start returning with
- * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [q] - Perform regex search on items matching name for given value
- * @property {string} [size] - Filters items based on given size
- * @property {string} [packageType] - Filters items based on given package_type
+ * @typedef GetDpRulesParam
+ * @property {string} ruleUid - A `rule_uid` is a unique identifier for a particular Dp.
  */
 
 /**
- * @typedef GetPackageMaterialRuleParam
- * @property {string} ruleId - A `package_material_rule_id` is a unique
- *   identifier for a Package Material Rule
+ * @typedef GetEntityRegionViewParam
+ * @property {ServiceabilityPlatformModel.EntityRegionView_Request} body
  */
 
 /**
- * @typedef GetPackageMaterialRulesParam
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @typedef GetListViewParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [isActive] - Filters items based on given is_active
+ * @property {string} [name] - Name of particular zone in the seller account
+ * @property {boolean} [isActive] - Status of zone whether active or inactive
+ * @property {string} [channelIds] - Zones associated with the given channel ids'
+ * @property {string} [q] - Search with name as a free text
  */
 
 /**
- * @typedef GetPackageMaterialsParam
- * @property {string} packageMaterialId - A `package_material_id` is a unique
- *   identifier for a Package Material
+ * @typedef GetOptimalLocationsParam
+ * @property {ServiceabilityPlatformModel.ReAssignStoreRequest} body
  */
 
 /**
- * @typedef GetServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
- * @property {string} regionId - Unique identifier of a region
+ * @typedef GetStoreParam
+ * @property {number} storeUid - A `store_uid` contains a specific ID of a store.
  */
 
 /**
- * @typedef GetZoneByIdParam
+ * @typedef GetZoneDataViewParam
  * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
  */
 
 /**
- * @typedef GetZonesParam
+ * @typedef GetZoneListViewParam
+ * @property {number} [pageNumber] - Index of the item to start returning with
  * @property {number} [pageNo] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {boolean} [isActive] - Status of Zone (either active or inactive)
- * @property {string} [channelId] - Zones filtered by an application
+ * @property {string} [name] - Name of particular zone in the seller account
+ * @property {boolean} [isActive] - Status of zone whether active or inactive
+ * @property {string} [channelIds] - Zones associated with the given channel ids'
  * @property {string} [q] - Search with name as a free text
- * @property {string} [country] - ISO2 code of the country
- * @property {string} [state] - State name
- * @property {string} [city] - City name
- * @property {string} [pincode] - Pincode value to search zones
- * @property {string} [sector] - Sector value to search zones
+ * @property {string[]} [zoneId] - List of zones to query for
  */
 
 /**
- * @typedef UpdateCompanyConfigurationParam
- * @property {ServiceabilityPlatformModel.CompanyConfig} body
+ * @typedef UpdateDpRuleParam
+ * @property {string} ruleUid - A `rule_uid` is a unique identifier for a particular Dp.
+ * @property {ServiceabilityPlatformModel.DpRulesUpdateRequest} body
  */
 
 /**
- * @typedef UpdateCourierPartnerAccountParam
- * @property {string} accountId - Unique ID of courier account
- * @property {ServiceabilityPlatformModel.CourierAccount} body
- */
-
-/**
- * @typedef UpdatePackageMaterialRuleParam
- * @property {string} ruleId - A `package_material_rule_id` is a unique
- *   identifier for a Package Material Rule
- * @property {ServiceabilityPlatformModel.PackageRule} body
+ * @typedef UpdateZoneControllerViewParam
+ * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
+ * @property {ServiceabilityPlatformModel.ZoneUpdateRequest} body
  */
 
 /**
- * @typedef UpdatePackageMaterialsParam
- * @property {string} packageMaterialId - A `package_material_id` is a unique
- *   identifier for a Package Material
- * @property {ServiceabilityPlatformModel.PackageMaterial} body
+ * @typedef UpsertDpAccountParam
+ * @property {ServiceabilityPlatformModel.CompanyDpAccountRequest} body
  */
 
 /**
- * @typedef UpdateServiceabilityParam
- * @property {string} extensionId - Unique Identifier of CP Extension
- * @property {string} schemeId - Unique identifier of a scheme
- * @property {string} regionId - Unique identifier of a region
- * @property {ServiceabilityPlatformModel.ServiceabilityModel} body
+ * @typedef UpsertDpCompanyRulesParam
+ * @property {ServiceabilityPlatformModel.DPCompanyRuleRequest} body
  */
 
 /**
- * @typedef UpdateZoneByIdParam
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
- * @property {ServiceabilityPlatformModel.UpdateZoneData} body
+ * @typedef UpsertDpRulesParam
+ * @property {ServiceabilityPlatformModel.DpRuleRequest} body
  */
 
 class ServiceabilityPlatformValidator {
-  /** @returns {BulkServiceabilityParam} */
-  static bulkServiceability() {
-    return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      schemeId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.BulkRegionJobSerializer().required(),
-    }).required();
-  }
-
-  /** @returns {BulkTatParam} */
-  static bulkTat() {
-    return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      schemeId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.BulkRegionJobSerializer().required(),
-    }).required();
-  }
-
-  /** @returns {CreateCourierPartnerAccountParam} */
-  static createCourierPartnerAccount() {
-    return Joi.object({
-      body: ServiceabilityPlatformModel.CourierAccount().required(),
-    }).required();
-  }
-
-  /** @returns {CreatePackageMaterialParam} */
-  static createPackageMaterial() {
-    return Joi.object({
-      body: ServiceabilityPlatformModel.PackageMaterial().required(),
-    }).required();
-  }
-
-  /** @returns {CreatePackageMaterialRuleParam} */
-  static createPackageMaterialRule() {
-    return Joi.object({
-      body: ServiceabilityPlatformModel.PackageRule().required(),
-    }).required();
-  }
-
   /** @returns {CreateZoneParam} */
   static createZone() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.CreateZoneData().required(),
+      body: ServiceabilityPlatformModel.ZoneRequest().required(),
     }).required();
   }
 
@@ -234,182 +119,133 @@ class ServiceabilityPlatformValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetBulkServiceabilityParam} */
-  static getBulkServiceability() {
+  /** @returns {GetCompanyStoreViewParam} */
+  static getCompanyStoreView() {
     return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      schemeId: Joi.string().allow("").required(),
-      pageNo: Joi.number(),
+      pageNumber: Joi.number(),
       pageSize: Joi.number(),
-      batchId: Joi.string().allow(""),
-      action: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      country: Joi.string().allow(""),
-      region: Joi.string().allow(""),
-      startDate: Joi.string().allow(""),
-      endDate: Joi.string().allow(""),
     }).required();
   }
 
-  /** @returns {GetBulkTatParam} */
-  static getBulkTat() {
+  /** @returns {GetDpAccountParam} */
+  static getDpAccount() {
     return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      schemeId: Joi.string().allow("").required(),
-      pageNo: Joi.number(),
+      pageNumber: Joi.number(),
       pageSize: Joi.number(),
-      batchId: Joi.string().allow(""),
-      action: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      country: Joi.string().allow(""),
-      region: Joi.string().allow(""),
-      startDate: Joi.string().allow(""),
-      endDate: Joi.string().allow(""),
+      stage: Joi.string().allow(""),
+      paymentMode: Joi.string().allow(""),
+      transportType: Joi.string().allow(""),
     }).required();
   }
 
-  /** @returns {GetCompanyConfigurationParam} */
-  static getCompanyConfiguration() {
+  /** @returns {GetDpCompanyRulesParam} */
+  static getDpCompanyRules() {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetCourierPartnerAccountParam} */
-  static getCourierPartnerAccount() {
+  /** @returns {GetDpRuleInsertParam} */
+  static getDpRuleInsert() {
     return Joi.object({
-      accountId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetCourierPartnerAccountsParam} */
-  static getCourierPartnerAccounts() {
-    return Joi.object({
-      pageNo: Joi.number(),
+      pageNumber: Joi.number(),
       pageSize: Joi.number(),
-      stage: Joi.string().allow(""),
-      paymentMode: Joi.string().allow(""),
-      transportType: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetOptimalLocationsParam} */
-  static getOptimalLocations() {
-    return Joi.object({
-      body: ServiceabilityPlatformModel.ReAssignStoreRequest().required(),
     }).required();
   }
 
-  /** @returns {GetPackageMaterialListParam} */
-  static getPackageMaterialList() {
+  /** @returns {GetDpRulesParam} */
+  static getDpRules() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      q: Joi.string().allow(""),
-      size: Joi.string().allow(""),
-      packageType: Joi.string().allow(""),
+      ruleUid: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetPackageMaterialRuleParam} */
-  static getPackageMaterialRule() {
+  /** @returns {GetEntityRegionViewParam} */
+  static getEntityRegionView() {
     return Joi.object({
-      ruleId: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.EntityRegionView_Request().required(),
     }).required();
   }
 
-  /** @returns {GetPackageMaterialRulesParam} */
-  static getPackageMaterialRules() {
+  /** @returns {GetListViewParam} */
+  static getListView() {
     return Joi.object({
-      pageNo: Joi.number(),
+      pageNumber: Joi.number(),
       pageSize: Joi.number(),
-      isActive: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      isActive: Joi.boolean(),
+      channelIds: Joi.string().allow(""),
+      q: Joi.string().allow(""),
     }).required();
   }
 
-  /** @returns {GetPackageMaterialsParam} */
-  static getPackageMaterials() {
+  /** @returns {GetOptimalLocationsParam} */
+  static getOptimalLocations() {
     return Joi.object({
-      packageMaterialId: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.ReAssignStoreRequest().required(),
     }).required();
   }
 
-  /** @returns {GetServiceabilityParam} */
-  static getServiceability() {
+  /** @returns {GetStoreParam} */
+  static getStore() {
     return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      schemeId: Joi.string().allow("").required(),
-      regionId: Joi.string().allow("").required(),
+      storeUid: Joi.number().required(),
     }).required();
   }
 
-  /** @returns {GetZoneByIdParam} */
-  static getZoneById() {
+  /** @returns {GetZoneDataViewParam} */
+  static getZoneDataView() {
     return Joi.object({
       zoneId: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetZonesParam} */
-  static getZones() {
+  /** @returns {GetZoneListViewParam} */
+  static getZoneListView() {
     return Joi.object({
+      pageNumber: Joi.number(),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
+      name: Joi.string().allow(""),
       isActive: Joi.boolean(),
-      channelId: Joi.string().allow(""),
+      channelIds: Joi.string().allow(""),
       q: Joi.string().allow(""),
-      country: Joi.string().allow(""),
-      state: Joi.string().allow(""),
-      city: Joi.string().allow(""),
-      pincode: Joi.string().allow(""),
-      sector: Joi.string().allow(""),
+      zoneId: Joi.array().items(Joi.string().allow("")),
     }).required();
   }
 
-  /** @returns {UpdateCompanyConfigurationParam} */
-  static updateCompanyConfiguration() {
+  /** @returns {UpdateDpRuleParam} */
+  static updateDpRule() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.CompanyConfig().required(),
+      ruleUid: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.DpRulesUpdateRequest().required(),
     }).required();
   }
 
-  /** @returns {UpdateCourierPartnerAccountParam} */
-  static updateCourierPartnerAccount() {
+  /** @returns {UpdateZoneControllerViewParam} */
+  static updateZoneControllerView() {
     return Joi.object({
-      accountId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.CourierAccount().required(),
-    }).required();
-  }
-
-  /** @returns {UpdatePackageMaterialRuleParam} */
-  static updatePackageMaterialRule() {
-    return Joi.object({
-      ruleId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.PackageRule().required(),
+      zoneId: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.ZoneUpdateRequest().required(),
     }).required();
   }
 
-  /** @returns {UpdatePackageMaterialsParam} */
-  static updatePackageMaterials() {
+  /** @returns {UpsertDpAccountParam} */
+  static upsertDpAccount() {
     return Joi.object({
-      packageMaterialId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.PackageMaterial().required(),
+      body: ServiceabilityPlatformModel.CompanyDpAccountRequest().required(),
     }).required();
   }
 
-  /** @returns {UpdateServiceabilityParam} */
-  static updateServiceability() {
+  /** @returns {UpsertDpCompanyRulesParam} */
+  static upsertDpCompanyRules() {
     return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      schemeId: Joi.string().allow("").required(),
-      regionId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.ServiceabilityModel().required(),
+      body: ServiceabilityPlatformModel.DPCompanyRuleRequest().required(),
     }).required();
   }
 
-  /** @returns {UpdateZoneByIdParam} */
-  static updateZoneById() {
+  /** @returns {UpsertDpRulesParam} */
+  static upsertDpRules() {
     return Joi.object({
-      zoneId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.UpdateZoneData().required(),
+      body: ServiceabilityPlatformModel.DpRuleRequest().required(),
     }).required();
   }
 }