@gofynd/fdk-client-javascript 1.6.3 → 2.0.0

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

@@ -1,22 +1,54 @@
 export = ServiceabilityPlatformApplicationValidator;
+/**
+ * @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
  */
@@ -24,6 +56,28 @@ export = ServiceabilityPlatformApplicationValidator;
  * @typedef GetCourierPartnersParam
  * @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
@@ -31,21 +85,44 @@ export = ServiceabilityPlatformApplicationValidator;
  */
 /**
  * @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.
  */
 /**
  * @typedef InsertApplicationConfigParam
  * @property {ServiceabilityPlatformModel.StoreRuleConfigData} body
  */
 /**
- * @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
  */
 /**
  * @typedef UpdateCourierPartnerRulePriorityParam
@@ -53,9 +130,14 @@ export = ServiceabilityPlatformApplicationValidator;
  */
 /**
  * @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.
@@ -76,6 +158,10 @@ export = ServiceabilityPlatformApplicationValidator;
  * @typedef UpdatePincodeMopViewParam
  * @property {ServiceabilityPlatformModel.PincodeMopData} body
  */
+/**
+ * @typedef UpdateStoreRulePriorityParam
+ * @property {ServiceabilityPlatformModel.RulePriorityDetails} body
+ */
 /**
  * @typedef UpdateStoreRulesParam
  * @property {string} ruleUid - A `rule_uid` is a unique identifier for a
@@ -86,37 +172,72 @@ export = ServiceabilityPlatformApplicationValidator;
  * @typedef UpdateStoreRulesConfigParam
  * @property {ServiceabilityPlatformModel.StoreRuleConfigData} body
  */
+/**
+ * @typedef UpdateZoneParam
+ * @property {string} zoneId - Unique identifier for a particular zone
+ * @property {ServiceabilityPlatformModel.UpdateZoneData} body
+ */
 declare class ServiceabilityPlatformApplicationValidator {
+    /** @returns {CreateBulkExportParam} */
+    static createBulkExport(): CreateBulkExportParam;
+    /** @returns {CreateBulkGeoAreaParam} */
+    static createBulkGeoArea(): CreateBulkGeoAreaParam;
     /** @returns {CreateCourierPartnerRuleParam} */
     static createCourierPartnerRule(): CreateCourierPartnerRuleParam;
+    /** @returns {CreateGeoAreaParam} */
+    static createGeoArea(): CreateGeoAreaParam;
+    /** @returns {CreateGeoAreaExportJobParam} */
+    static createGeoAreaExportJob(): CreateGeoAreaExportJobParam;
     /** @returns {CreateStoreRulesParam} */
     static createStoreRules(): CreateStoreRulesParam;
+    /** @returns {CreateZoneParam} */
+    static createZone(): CreateZoneParam;
+    /** @returns {DeleteZoneParam} */
+    static deleteZone(): DeleteZoneParam;
+    /** @returns {DownloadGeoareaSampleFileParam} */
+    static downloadGeoareaSampleFile(): any;
     /** @returns {GetApplicationConfigParam} */
     static getApplicationConfig(): any;
     /** @returns {GetApplicationConfigurationParam} */
     static getApplicationConfiguration(): any;
-    /** @returns {GetApplicationServiceabilitySelfShipmentParam} */
-    static getApplicationServiceabilitySelfShipment(): any;
+    /** @returns {GetBulkExportParam} */
+    static getBulkExport(): GetBulkExportParam;
+    /** @returns {GetBulkGeoAreaParam} */
+    static getBulkGeoArea(): GetBulkGeoAreaParam;
     /** @returns {GetCourierPartnerRuleParam} */
     static getCourierPartnerRule(): GetCourierPartnerRuleParam;
     /** @returns {GetCourierPartnerRulesParam} */
     static getCourierPartnerRules(): GetCourierPartnerRulesParam;
     /** @returns {GetCourierPartnersParam} */
     static getCourierPartners(): GetCourierPartnersParam;
+    /** @returns {GetGeoAreaParam} */
+    static getGeoArea(): GetGeoAreaParam;
+    /** @returns {GetGeoAreaExportJobStatusParam} */
+    static getGeoAreaExportJobStatus(): GetGeoAreaExportJobStatusParam;
+    /** @returns {GetGeoAreasParam} */
+    static getGeoAreas(): GetGeoAreasParam;
     /** @returns {GetStoreRuleParam} */
     static getStoreRule(): GetStoreRuleParam;
     /** @returns {GetStoreRulesParam} */
     static getStoreRules(): GetStoreRulesParam;
+    /** @returns {GetZoneParam} */
+    static getZone(): GetZoneParam;
+    /** @returns {GetZonesParam} */
+    static getZones(): GetZonesParam;
     /** @returns {InsertApplicationConfigParam} */
     static insertApplicationConfig(): InsertApplicationConfigParam;
-    /** @returns {PatchApplicationServiceabilitySelfShipmentParam} */
-    static patchApplicationServiceabilitySelfShipment(): PatchApplicationServiceabilitySelfShipmentParam;
+    /** @returns {PatchApplicationConfigurationParam} */
+    static patchApplicationConfiguration(): PatchApplicationConfigurationParam;
     /** @returns {UpdateApplicationConfigurationParam} */
     static updateApplicationConfiguration(): UpdateApplicationConfigurationParam;
+    /** @returns {UpdateBulkGeoAreaParam} */
+    static updateBulkGeoArea(): UpdateBulkGeoAreaParam;
     /** @returns {UpdateCourierPartnerRulePriorityParam} */
     static updateCourierPartnerRulePriority(): UpdateCourierPartnerRulePriorityParam;
     /** @returns {UpdateCourierRuleParam} */
     static updateCourierRule(): UpdateCourierRuleParam;
+    /** @returns {UpdateGeoAreaParam} */
+    static updateGeoArea(): UpdateGeoAreaParam;
     /** @returns {UpdatePincodeAuditHistoryParam} */
     static updatePincodeAuditHistory(): UpdatePincodeAuditHistoryParam;
     /** @returns {UpdatePincodeBulkViewParam} */
@@ -125,29 +246,69 @@ declare class ServiceabilityPlatformApplicationValidator {
     static updatePincodeCoDListing(): UpdatePincodeCoDListingParam;
     /** @returns {UpdatePincodeMopViewParam} */
     static updatePincodeMopView(): UpdatePincodeMopViewParam;
+    /** @returns {UpdateStoreRulePriorityParam} */
+    static updateStoreRulePriority(): UpdateStoreRulePriorityParam;
     /** @returns {UpdateStoreRulesParam} */
     static updateStoreRules(): UpdateStoreRulesParam;
     /** @returns {UpdateStoreRulesConfigParam} */
     static updateStoreRulesConfig(): UpdateStoreRulesConfigParam;
+    /** @returns {UpdateZoneParam} */
+    static updateZone(): UpdateZoneParam;
 }
 declare namespace ServiceabilityPlatformApplicationValidator {
-    export { CreateCourierPartnerRuleParam, CreateStoreRulesParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetApplicationServiceabilitySelfShipmentParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetStoreRuleParam, GetStoreRulesParam, InsertApplicationConfigParam, PatchApplicationServiceabilitySelfShipmentParam, UpdateApplicationConfigurationParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam };
+    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;
+};
+type CreateBulkGeoAreaParam = {
+    body: ServiceabilityPlatformModel.BulkGeoAreaDetails;
+};
 type CreateCourierPartnerRuleParam = {
     body: ServiceabilityPlatformModel.CourierPartnerRule;
 };
+type CreateGeoAreaParam = {
+    body: ServiceabilityPlatformModel.GeoAreaRequestBody;
+};
+type CreateGeoAreaExportJobParam = {
+    /**
+     * - The unique identifier of the Geoarea.
+     */
+    geoareaId: string;
+};
 type CreateStoreRulesParam = {
     body: ServiceabilityPlatformModel.CreateStoreRuleDetailsSchema;
 };
+type CreateZoneParam = {
+    body: ServiceabilityPlatformModel.CreateZoneDataSchema;
+};
+type DeleteZoneParam = {
+    /**
+     * - Unique identifier for a particular zone
+     */
+    zoneId: string;
+};
+type GetBulkExportParam = {
+    /**
+     * - A `batch_id` is a unique identifier for a particular zone.
+     */
+    batchId: string;
+};
+type GetBulkGeoAreaParam = {
+    /**
+     * - A unique identifier for the GeoArea.
+     */
+    geoareaId: string;
+};
 type GetCourierPartnerRuleParam = {
     /**
      * - Unique identifier of the courier partner rule
      */
-    ruleId: string;
+    ruleUid: string;
 };
 type GetCourierPartnerRulesParam = {
     /**
-     * - Index of the item to start returning with
+     * - The current page number for paginated results.
      */
     pageNo?: number;
     /**
@@ -162,6 +323,61 @@ type GetCourierPartnerRulesParam = {
 type GetCourierPartnersParam = {
     body: ServiceabilityPlatformModel.ShipmentCourierPartnerDetails;
 };
+type GetGeoAreaParam = {
+    /**
+     * - A unique identifier for the GeoArea.
+     */
+    geoareaId: string;
+};
+type GetGeoAreaExportJobStatusParam = {
+    /**
+     * - The unique identifier of the Geoarea.
+     */
+    geoareaId: string;
+};
+type GetGeoAreasParam = {
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+    /**
+     * - Status of GeoAreas (either active or inactive)
+     */
+    isActive?: boolean;
+    /**
+     * - Current page number
+     */
+    pageNo?: number;
+    /**
+     * - To fetch the type of a specific geoarea.
+     */
+    type?: string;
+    /**
+     * - Used to search for matching results based on the
+     * provided input.
+     */
+    q?: string;
+    /**
+     * - ISO2 code of the country
+     */
+    countryIsoCode?: string;
+    /**
+     * - State name
+     */
+    state?: string;
+    /**
+     * - City name
+     */
+    city?: string;
+    /**
+     * - Pincode value to search geoareas
+     */
+    pincode?: string;
+    /**
+     * - Sector value to search geoareas
+     */
+    sector?: string;
+};
 type GetStoreRuleParam = {
     /**
      * - A `rule_uid` is a unique identifier for a
@@ -170,18 +386,83 @@ type GetStoreRuleParam = {
     ruleUid: string;
 };
 type GetStoreRulesParam = {
+    /**
+     * - The current page number for paginated results.
+     */
     pageNo?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
     pageSize?: number;
+    /**
+     * - Filter rules based on rule status
+     */
     status?: string;
 };
+type GetZoneParam = {
+    /**
+     * - Unique identifier for a particular zone
+     */
+    zoneId: string;
+};
+type GetZonesParam = {
+    /**
+     * - Identifies the specific stage of zone bing requested.
+     */
+    stage?: string;
+    /**
+     * - Defines the number of items displayed per page.
+     */
+    pageSize?: number;
+    /**
+     * - Current page number.
+     */
+    pageNo?: number;
+    /**
+     * - Status of Zone (either active or inactive)
+     */
+    isActive?: boolean;
+    /**
+     * - Used to search for matching results based on the
+     * provided input.
+     */
+    q?: string;
+    /**
+     * - ISO2 code of the country.
+     */
+    countryIsoCode?: string;
+    /**
+     * - PIN Code of the country.
+     */
+    pincode?: string;
+    /**
+     * - State of the country.
+     */
+    state?: string;
+    /**
+     * - City of the country.
+     */
+    city?: string;
+    /**
+     * - Sector name of mentioned address.
+     */
+    sector?: string;
+};
 type InsertApplicationConfigParam = {
     body: ServiceabilityPlatformModel.StoreRuleConfigData;
 };
-type PatchApplicationServiceabilitySelfShipmentParam = {
-    body: ServiceabilityPlatformModel.SelfShipResult;
+type PatchApplicationConfigurationParam = {
+    body: ServiceabilityPlatformModel.ApplicationConfigPatch;
 };
 type UpdateApplicationConfigurationParam = {
-    body: ServiceabilityPlatformModel.ApplicationConfig;
+    body: ServiceabilityPlatformModel.ApplicationConfigPutDetail;
+};
+type UpdateBulkGeoAreaParam = {
+    /**
+     * - A unique identifier for the GeoArea.
+     */
+    geoareaId: string;
+    body: ServiceabilityPlatformModel.BulkGeoAreaDetails;
 };
 type UpdateCourierPartnerRulePriorityParam = {
     body: ServiceabilityPlatformModel.RulePriorityDetails;
@@ -190,9 +471,16 @@ type UpdateCourierRuleParam = {
     /**
      * - Unique identifier of the courier partner rule.
      */
-    ruleId: string;
+    ruleUid: string;
     body: ServiceabilityPlatformModel.CourierPartnerRule;
 };
+type UpdateGeoAreaParam = {
+    /**
+     * - A unique identifier for the GeoArea.
+     */
+    geoareaId: string;
+    body: ServiceabilityPlatformModel.GeoAreaRequestBody;
+};
 type UpdatePincodeAuditHistoryParam = {
     /**
      * - Page number to be fetched.
@@ -221,6 +509,9 @@ type UpdatePincodeCoDListingParam = {
 type UpdatePincodeMopViewParam = {
     body: ServiceabilityPlatformModel.PincodeMopData;
 };
+type UpdateStoreRulePriorityParam = {
+    body: ServiceabilityPlatformModel.RulePriorityDetails;
+};
 type UpdateStoreRulesParam = {
     /**
      * - A `rule_uid` is a unique identifier for a
@@ -232,7 +523,14 @@ type UpdateStoreRulesParam = {
 type UpdateStoreRulesConfigParam = {
     body: ServiceabilityPlatformModel.StoreRuleConfigData;
 };
+type UpdateZoneParam = {
+    /**
+     * - Unique identifier for a particular zone
+     */
+    zoneId: string;
+    body: ServiceabilityPlatformModel.UpdateZoneData;
+};
+type DownloadGeoareaSampleFileParam = any;
 type GetApplicationConfigParam = any;
 type GetApplicationConfigurationParam = any;
-type GetApplicationServiceabilitySelfShipmentParam = any;
 import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");