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

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts

@@ -7,10 +7,6 @@ export = ServiceabilityPlatformApplicationValidator;
  * @typedef CreateBulkGeoAreaParam
  * @property {ServiceabilityPlatformModel.BulkGeoAreaDetails} body
  */
-/**
- * @typedef CreateBulkZoneParam
- * @property {ServiceabilityPlatformModel.CreateBulkZoneData} body
- */
 /**
  * @typedef CreateCourierPartnerRuleParam
  * @property {ServiceabilityPlatformModel.CourierPartnerRule} body
@@ -25,21 +21,17 @@ export = ServiceabilityPlatformApplicationValidator;
  */
 /**
  * @typedef CreateStoreRulesParam
- * @property {ServiceabilityPlatformModel.CreateStoreRuleRequestSchema} body
+ * @property {ServiceabilityPlatformModel.CreateStoreRuleDetailsSchema} body
  */
 /**
  * @typedef CreateZoneParam
- * @property {ServiceabilityPlatformModel.CreateZoneV2Data} body
+ * @property {ServiceabilityPlatformModel.CreateZoneDataSchema} body
  */
 /**
  * @typedef DeleteZoneParam
  * @property {string} zoneId - Unique identifier for a particular zone
  */
 /** @typedef DownloadGeoareaSampleFileParam */
-/**
- * @typedef DownloadZoneSampleFileParam
- * @property {string} productType - It denotes the attribute of the product
- */
 /** @typedef GetApplicationConfigParam */
 /** @typedef GetApplicationConfigurationParam */
 /**
@@ -50,22 +42,20 @@ export = ServiceabilityPlatformApplicationValidator;
  * @typedef GetBulkGeoAreaParam
  * @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.
@@ -80,7 +70,8 @@ export = ServiceabilityPlatformApplicationValidator;
  * @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
@@ -92,33 +83,24 @@ export = ServiceabilityPlatformApplicationValidator;
  * @property {string} ruleUid - A `rule_uid` is a unique identifier for a
  *   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
  */
 /**
  * @typedef GetZoneParam
  * @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.
@@ -131,11 +113,11 @@ export = ServiceabilityPlatformApplicationValidator;
  */
 /**
  * @typedef PatchApplicationConfigurationParam
- * @property {ServiceabilityPlatformModel.ApplicationConfigPatchRequest} body
+ * @property {ServiceabilityPlatformModel.ApplicationConfigPatch} body
  */
 /**
  * @typedef UpdateApplicationConfigurationParam
- * @property {ServiceabilityPlatformModel.ApplicationConfigPutRequest} body
+ * @property {ServiceabilityPlatformModel.ApplicationConfigPutDetail} body
  */
 /**
  * @typedef UpdateBulkGeoAreaParam
@@ -144,11 +126,11 @@ export = ServiceabilityPlatformApplicationValidator;
  */
 /**
  * @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
  */
 /**
@@ -158,7 +140,9 @@ export = ServiceabilityPlatformApplicationValidator;
  */
 /**
  * @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
  */
 /**
  * @typedef UpdatePincodeBulkViewParam
@@ -166,7 +150,9 @@ export = ServiceabilityPlatformApplicationValidator;
  */
 /**
  * @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
  */
 /**
  * @typedef UpdatePincodeMopViewParam
@@ -174,13 +160,13 @@ export = ServiceabilityPlatformApplicationValidator;
  */
 /**
  * @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
  */
 /**
  * @typedef UpdateStoreRulesConfigParam
@@ -189,15 +175,13 @@ export = ServiceabilityPlatformApplicationValidator;
 /**
  * @typedef UpdateZoneParam
  * @property {string} zoneId - Unique identifier for a particular zone
- * @property {ServiceabilityPlatformModel.UpdateZoneDataV2} body
+ * @property {ServiceabilityPlatformModel.UpdateZoneData} body
  */
 declare class ServiceabilityPlatformApplicationValidator {
     /** @returns {CreateBulkExportParam} */
     static createBulkExport(): CreateBulkExportParam;
     /** @returns {CreateBulkGeoAreaParam} */
     static createBulkGeoArea(): CreateBulkGeoAreaParam;
-    /** @returns {CreateBulkZoneParam} */
-    static createBulkZone(): CreateBulkZoneParam;
     /** @returns {CreateCourierPartnerRuleParam} */
     static createCourierPartnerRule(): CreateCourierPartnerRuleParam;
     /** @returns {CreateGeoAreaParam} */
@@ -212,8 +196,6 @@ declare class ServiceabilityPlatformApplicationValidator {
     static deleteZone(): DeleteZoneParam;
     /** @returns {DownloadGeoareaSampleFileParam} */
     static downloadGeoareaSampleFile(): any;
-    /** @returns {DownloadZoneSampleFileParam} */
-    static downloadZoneSampleFile(): DownloadZoneSampleFileParam;
     /** @returns {GetApplicationConfigParam} */
     static getApplicationConfig(): any;
     /** @returns {GetApplicationConfigurationParam} */
@@ -222,14 +204,12 @@ declare class ServiceabilityPlatformApplicationValidator {
     static getBulkExport(): GetBulkExportParam;
     /** @returns {GetBulkGeoAreaParam} */
     static getBulkGeoArea(): GetBulkGeoAreaParam;
-    /** @returns {GetBulkZoneParam} */
-    static getBulkZone(): any;
     /** @returns {GetCourierPartnerRuleParam} */
     static getCourierPartnerRule(): GetCourierPartnerRuleParam;
-    /** @returns {GetCourierPartnerRuleDetailsParam} */
-    static getCourierPartnerRuleDetails(): GetCourierPartnerRuleDetailsParam;
     /** @returns {GetCourierPartnerRulesParam} */
     static getCourierPartnerRules(): GetCourierPartnerRulesParam;
+    /** @returns {GetCourierPartnersParam} */
+    static getCourierPartners(): GetCourierPartnersParam;
     /** @returns {GetGeoAreaParam} */
     static getGeoArea(): GetGeoAreaParam;
     /** @returns {GetGeoAreaExportJobStatusParam} */
@@ -238,14 +218,10 @@ declare class ServiceabilityPlatformApplicationValidator {
     static getGeoAreas(): GetGeoAreasParam;
     /** @returns {GetStoreRuleParam} */
     static getStoreRule(): GetStoreRuleParam;
-    /** @returns {GetStoreRuleDetailsParam} */
-    static getStoreRuleDetails(): GetStoreRuleDetailsParam;
     /** @returns {GetStoreRulesParam} */
     static getStoreRules(): GetStoreRulesParam;
     /** @returns {GetZoneParam} */
     static getZone(): GetZoneParam;
-    /** @returns {GetZoneDetailsParam} */
-    static getZoneDetails(): GetZoneDetailsParam;
     /** @returns {GetZonesParam} */
     static getZones(): GetZonesParam;
     /** @returns {InsertApplicationConfigParam} */
@@ -280,7 +256,7 @@ declare class ServiceabilityPlatformApplicationValidator {
     static updateZone(): UpdateZoneParam;
 }
 declare namespace ServiceabilityPlatformApplicationValidator {
-    export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateBulkZoneParam, CreateCourierPartnerRuleParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreateStoreRulesParam, CreateZoneParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, DownloadZoneSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetBulkExportParam, GetBulkGeoAreaParam, GetBulkZoneParam, GetCourierPartnerRuleParam, GetCourierPartnerRuleDetailsParam, GetCourierPartnerRulesParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetStoreRuleParam, GetStoreRuleDetailsParam, GetStoreRulesParam, GetZoneParam, GetZoneDetailsParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, UpdateApplicationConfigurationParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam };
+    export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateCourierPartnerRuleParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreateStoreRulesParam, CreateZoneParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetBulkExportParam, GetBulkGeoAreaParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetStoreRuleParam, GetStoreRulesParam, GetZoneParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, UpdateApplicationConfigurationParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam };
 }
 type CreateBulkExportParam = {
     body: ServiceabilityPlatformModel.BulkCreateZoneExport;
@@ -288,9 +264,6 @@ type CreateBulkExportParam = {
 type CreateBulkGeoAreaParam = {
     body: ServiceabilityPlatformModel.BulkGeoAreaDetails;
 };
-type CreateBulkZoneParam = {
-    body: ServiceabilityPlatformModel.CreateBulkZoneData;
-};
 type CreateCourierPartnerRuleParam = {
     body: ServiceabilityPlatformModel.CourierPartnerRule;
 };
@@ -304,10 +277,10 @@ type CreateGeoAreaExportJobParam = {
     geoareaId: string;
 };
 type CreateStoreRulesParam = {
-    body: ServiceabilityPlatformModel.CreateStoreRuleRequestSchema;
+    body: ServiceabilityPlatformModel.CreateStoreRuleDetailsSchema;
 };
 type CreateZoneParam = {
-    body: ServiceabilityPlatformModel.CreateZoneV2Data;
+    body: ServiceabilityPlatformModel.CreateZoneDataSchema;
 };
 type DeleteZoneParam = {
     /**
@@ -315,12 +288,6 @@ type DeleteZoneParam = {
      */
     zoneId: string;
 };
-type DownloadZoneSampleFileParam = {
-    /**
-     * - It denotes the attribute of the product
-     */
-    productType: string;
-};
 type GetBulkExportParam = {
     /**
      * - A `batch_id` is a unique identifier for a particular zone.
@@ -335,20 +302,13 @@ type GetBulkGeoAreaParam = {
 };
 type GetCourierPartnerRuleParam = {
     /**
-     * - A `rule_uid` is a unique identifier for a particular Dp.
-     */
-    ruleUid: string;
-};
-type GetCourierPartnerRuleDetailsParam = {
-    /**
-     * - A `rule_uid` is a unique identifier for a
-     * courier partner rule.
+     * - Unique identifier of the courier partner rule
      */
     ruleUid: string;
 };
 type GetCourierPartnerRulesParam = {
     /**
-     * - Index of the item to start returning with
+     * - The current page number for paginated results.
      */
     pageNo?: number;
     /**
@@ -360,6 +320,9 @@ type GetCourierPartnerRulesParam = {
      */
     status?: string;
 };
+type GetCourierPartnersParam = {
+    body: ServiceabilityPlatformModel.ShipmentCourierPartnerDetails;
+};
 type GetGeoAreaParam = {
     /**
      * - A unique identifier for the GeoArea.
@@ -390,7 +353,8 @@ type GetGeoAreasParam = {
      */
     type?: string;
     /**
-     * - Search with name as a free text
+     * - Used to search for matching results based on the
+     * provided input.
      */
     q?: string;
     /**
@@ -421,16 +385,18 @@ type GetStoreRuleParam = {
      */
     ruleUid: string;
 };
-type GetStoreRuleDetailsParam = {
+type GetStoreRulesParam = {
     /**
-     * - A `rule_uid` is a unique identifier for a order
-     * routing rule.
+     * - The current page number for paginated results.
      */
-    ruleUid: string;
-};
-type GetStoreRulesParam = {
     pageNo?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
     pageSize?: number;
+    /**
+     * - Filter rules based on rule status
+     */
     status?: string;
 };
 type GetZoneParam = {
@@ -439,21 +405,11 @@ type GetZoneParam = {
      */
     zoneId: string;
 };
-type GetZoneDetailsParam = {
-    /**
-     * - Unique identifier of a particular zone
-     */
-    zoneId: string;
-};
 type GetZonesParam = {
     /**
      * - Identifies the specific stage of zone bing requested.
      */
     stage?: string;
-    /**
-     * - Using type, you can filter custom or default zones
-     */
-    type?: string;
     /**
      * - Defines the number of items displayed per page.
      */
@@ -467,7 +423,8 @@ type GetZonesParam = {
      */
     isActive?: boolean;
     /**
-     * - Search with name as a free text.
+     * - Used to search for matching results based on the
+     * provided input.
      */
     q?: string;
     /**
@@ -495,10 +452,10 @@ type InsertApplicationConfigParam = {
     body: ServiceabilityPlatformModel.StoreRuleConfigData;
 };
 type PatchApplicationConfigurationParam = {
-    body: ServiceabilityPlatformModel.ApplicationConfigPatchRequest;
+    body: ServiceabilityPlatformModel.ApplicationConfigPatch;
 };
 type UpdateApplicationConfigurationParam = {
-    body: ServiceabilityPlatformModel.ApplicationConfigPutRequest;
+    body: ServiceabilityPlatformModel.ApplicationConfigPutDetail;
 };
 type UpdateBulkGeoAreaParam = {
     /**
@@ -508,11 +465,11 @@ type UpdateBulkGeoAreaParam = {
     body: ServiceabilityPlatformModel.BulkGeoAreaDetails;
 };
 type UpdateCourierPartnerRulePriorityParam = {
-    body: ServiceabilityPlatformModel.RulePriorityRequest;
+    body: ServiceabilityPlatformModel.RulePriorityDetails;
 };
 type UpdateCourierRuleParam = {
     /**
-     * - A `rule_uid` is a unique identifier for a particular Dp.
+     * - Unique identifier of the courier partner rule.
      */
     ruleUid: string;
     body: ServiceabilityPlatformModel.CourierPartnerRule;
@@ -525,19 +482,35 @@ type UpdateGeoAreaParam = {
     body: ServiceabilityPlatformModel.GeoAreaRequestBody;
 };
 type UpdatePincodeAuditHistoryParam = {
-    body: ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryRequest;
+    /**
+     * - Page number to be fetched.
+     */
+    pageNumber?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+    body: ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryDetails;
 };
 type UpdatePincodeBulkViewParam = {
     body: ServiceabilityPlatformModel.PincodeMopBulkData;
 };
 type UpdatePincodeCoDListingParam = {
-    body: ServiceabilityPlatformModel.PincodeCodStatusListingRequest;
+    /**
+     * - Page number to be fetched.
+     */
+    pageNumber?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+    body: ServiceabilityPlatformModel.PincodeCodStatusListingDetails;
 };
 type UpdatePincodeMopViewParam = {
     body: ServiceabilityPlatformModel.PincodeMopData;
 };
 type UpdateStoreRulePriorityParam = {
-    body: ServiceabilityPlatformModel.RulePriorityRequest;
+    body: ServiceabilityPlatformModel.RulePriorityDetails;
 };
 type UpdateStoreRulesParam = {
     /**
@@ -545,7 +518,7 @@ type UpdateStoreRulesParam = {
      * particular rule object.
      */
     ruleUid: string;
-    body: ServiceabilityPlatformModel.CreateStoreRuleRequestSchema;
+    body: ServiceabilityPlatformModel.CreateStoreRuleDetailsSchema;
 };
 type UpdateStoreRulesConfigParam = {
     body: ServiceabilityPlatformModel.StoreRuleConfigData;
@@ -555,10 +528,9 @@ type UpdateZoneParam = {
      * - Unique identifier for a particular zone
      */
     zoneId: string;
-    body: ServiceabilityPlatformModel.UpdateZoneDataV2;
+    body: ServiceabilityPlatformModel.UpdateZoneData;
 };
 type DownloadGeoareaSampleFileParam = any;
 type GetApplicationConfigParam = any;
 type GetApplicationConfigurationParam = any;
-type GetBulkZoneParam = any;
 import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");