@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1

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

@@ -1,104 +1,101 @@
 export = ServiceabilityPlatformValidator;
 /**
- * @typedef BulkServiceabilityParam
- * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
- * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
+ * @typedef CreateCourierPartnerAccountParam
+ * @property {ServiceabilityPlatformModel.CourierAccount} body
  */
 /**
- * @typedef BulkTatParam
- * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
- * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
+ * @typedef CreatePackageMaterialParam
+ * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {ServiceabilityPlatformModel.PackageMaterial} body
  */
 /**
- * @typedef CreateCourierPartnerAccountParam
- * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
+ * @typedef CreatePackageMaterialRuleParam
+ * @property {ServiceabilityPlatformModel.PackageRuleRequest} body
  */
+/** @typedef GetCompanyConfigurationParam */
+/** @typedef GetCompanySelfShipParam */
 /**
- * @typedef CreateCourierPartnerSchemeParam
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
+ * @typedef GetCountriesParam
+ * @property {boolean} [onboard] - Only fetch countries which allowed for
+ *   onboard on Platform.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default value is 1.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ *   Default value is 12
+ * @property {string} [q] - The search string to search in the list of countries by name.
+ * @property {string} [hierarchy] - The search filter to filter countries based
+ *   on their available hierarchy.
  */
 /**
- * @typedef CreatePackageMaterialParam
- * @property {ServiceabilityPlatformModel.PackageMaterial} body
+ * @typedef GetCountryParam
+ * @property {string} countryIsoCode - The `country_iso_code` is ISO-2 (alpha-2)
+ *   code for the country.
  */
 /**
- * @typedef CreatePackageMaterialRuleParam
- * @property {ServiceabilityPlatformModel.PackageRule} body
+ * @typedef GetCourierPartnerAccountParam
+ * @property {string} accountId - Unique ID of courier account
  */
 /**
- * @typedef CreateZoneParam
- * @property {ServiceabilityPlatformModel.CreateZoneData} body
+ * @typedef GetCourierPartnerAccountsParam
+ * @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} [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
+ * @property {string[]} [accountIds] - Filters dp accounts based on their ids
+ * @property {boolean} [selfShip] - To filter self ship/non self ship dp accounts
+ * @property {boolean} [ownAccount] - Filters seller owned or admin owned dp accounts
+ * @property {string} [q] - Filters dp accounts based on case sensitive partial
+ *   account name
  */
-/** @typedef GetAllStoresParam */
 /**
- * @typedef GetBulkServiceabilityParam
- * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
+ * @typedef GetInstalledCourierPartnerExtensionsParam
  * @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
+ * @property {string} [isInstalled] - Filter to get installed extensions only
  */
 /**
- * @typedef GetBulkTatParam
- * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
+ * @typedef GetListPackageMaterialRuleDetailsParam
  * @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
+ * @property {string} [isActive] - Filters items based on given is_active
  */
-/** @typedef GetCompanyConfigurationParam */
 /**
- * @typedef GetCountriesParam
- * @property {boolean} [onboarding] - Only fetch countries which allowed for
- *   onboard on Platform.
+ * @typedef GetLocalitiesParam
+ * @property {string} localityType - A `locality_type` contains unique
+ *   geographical division.
+ * @property {string} [country] - A `country` contains a specific value of the
+ *   country iso2 code.
+ * @property {string} [state] - A `state` contains a specific value of the
+ *   state, province.
+ * @property {string} [city] - A `city` contains a specific value of the city.
  * @property {number} [pageNo] - Page number.
  * @property {number} [pageSize] - Page size.
  * @property {string} [q] - Search.
- * @property {string} [hierarchy] - Fetch countries that has certain heirarchy present.
- */
-/**
- * @typedef GetCourierPartnerAccountParam
- * @property {string} accountId - Unique ID of courier partner account
+ * @property {string} [name] - Search for localities. Either provide a full name
+ *   or a search term.
  */
 /**
- * @typedef GetCourierPartnerAccountsParam
- * @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} [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 GetLocalitiesByPrefixParam
+ * @property {number} [pageNo] - Starting index of the items.
+ * @property {number} [pageSize] - Number of items per page.
+ * @property {string} [q] - Localities starting with the specified prefix.
  */
 /**
- * @typedef GetCourierPartnerSchemeParam
- * @property {string} schemeId - Unique Identifier of Scheme
- */
-/**
- * @typedef GetCourierPartnerSchemesParam
- * @property {string} [schemeType] - Indicates whether a scheme is created by an
- *   admin for global purposes or customized for a specific company.
- * @property {string} [paymentMode] - Indicates payment mode for a scheme.
- * @property {string[]} [capabilities] - Indicates whether the scheme possesses
- *   certain capabilities.
- * @property {string[]} [schemeIds] - List of scheme ids which need to be
- *   returned in the response.
+ * @typedef GetLocalityParam
+ * @property {string} localityType - A `locality_type` contains value
+ *   geographical division.
+ * @property {string} localityValue - A `locality_value` contains a specific
+ *   name of the locality.
+ * @property {string} [country] - A `country` contains a specific value of the
+ *   country iso2 code.
+ * @property {string} [state] - A `state` contains a specific value of the
+ *   state, province.
+ * @property {string} [city] - A `city` contains a specific value of the city.
  */
 /**
  * @typedef GetOptimalLocationsParam
- * @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
+ * @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
  */
 /**
  * @typedef GetPackageMaterialListParam
@@ -114,202 +111,157 @@ export = ServiceabilityPlatformValidator;
  *   identifier for a Package Material Rule
  */
 /**
- * @typedef GetPackageMaterialRulesParam
+ * @typedef GetPackageMaterialRuleDetailsParam
+ * @property {string} ruleId - A `package_material_rule_id` is a unique
+ *   identifier for a Package Material Rule
  * @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} [isActive] - Filters items based on given is_active
  */
 /**
  * @typedef GetPackageMaterialsParam
- * @property {string} packageMaterialId - Unique identifier for a Package. Material
- */
-/**
- * @typedef GetSampleFileServiceabilityStatusParam
- * @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] - Batch id of the execution
- */
-/**
- * @typedef GetServiceabilityParam
- * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
- * @property {string} regionId - Unique identifier of a region
- */
-/**
- * @typedef GetZoneByIdParam
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
- */
-/**
- * @typedef GetZonesParam
- * @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} [q] - Search with name as a free text
- * @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 zones
- * @property {string} [sector] - Sector value to search zones
- */
-/**
- * @typedef SampleFileServiceabilityParam
- * @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
+ *   identifier for a Package Material
  */
 /**
  * @typedef UpdateCompanyConfigurationParam
- * @property {ServiceabilityPlatformModel.CompanyConfig} body
+ * @property {ServiceabilityPlatformModel.CompanyConfigurationShema} body
  */
 /**
- * @typedef UpdateCourierPartnerAccountParam
- * @property {string} accountId - Unique ID of courier partner account
- * @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
+ * @typedef UpdateCompanySelfShipParam
+ * @property {ServiceabilityPlatformModel.CompanySelfShip} body
  */
 /**
- * @typedef UpdateCourierPartnerSchemeParam
- * @property {string} schemeId - Unique Identifier of Scheme
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} 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
+ * @property {ServiceabilityPlatformModel.PackageRuleRequest} body
  */
 /**
  * @typedef UpdatePackageMaterialsParam
- * @property {string} packageMaterialId - Unique identifier for a Package. Material
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
+ *   identifier for a Package Material
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
  */
 /**
- * @typedef UpdateServiceabilityParam
- * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
- * @property {string} regionId - Unique identifier of a region
- * @property {ServiceabilityPlatformModel.ServiceabilityModel} body
- */
-/**
- * @typedef UpdateZoneByIdParam
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
- * @property {ServiceabilityPlatformModel.UpdateZoneData} body
+ * @typedef ValidateAddressParam
+ * @property {string} countryIsoCode - The ISO code of the country.
+ * @property {string} templateName - The type of address form.
+ * @property {ServiceabilityPlatformModel.ValidateAddressRequest} body
  */
 declare class ServiceabilityPlatformValidator {
-    /** @returns {BulkServiceabilityParam} */
-    static bulkServiceability(): BulkServiceabilityParam;
-    /** @returns {BulkTatParam} */
-    static bulkTat(): BulkTatParam;
     /** @returns {CreateCourierPartnerAccountParam} */
     static createCourierPartnerAccount(): CreateCourierPartnerAccountParam;
-    /** @returns {CreateCourierPartnerSchemeParam} */
-    static createCourierPartnerScheme(): CreateCourierPartnerSchemeParam;
     /** @returns {CreatePackageMaterialParam} */
     static createPackageMaterial(): CreatePackageMaterialParam;
     /** @returns {CreatePackageMaterialRuleParam} */
     static createPackageMaterialRule(): CreatePackageMaterialRuleParam;
-    /** @returns {CreateZoneParam} */
-    static createZone(): CreateZoneParam;
-    /** @returns {GetAllStoresParam} */
-    static getAllStores(): any;
-    /** @returns {GetBulkServiceabilityParam} */
-    static getBulkServiceability(): GetBulkServiceabilityParam;
-    /** @returns {GetBulkTatParam} */
-    static getBulkTat(): GetBulkTatParam;
     /** @returns {GetCompanyConfigurationParam} */
     static getCompanyConfiguration(): any;
+    /** @returns {GetCompanySelfShipParam} */
+    static getCompanySelfShip(): any;
     /** @returns {GetCountriesParam} */
     static getCountries(): GetCountriesParam;
+    /** @returns {GetCountryParam} */
+    static getCountry(): GetCountryParam;
     /** @returns {GetCourierPartnerAccountParam} */
     static getCourierPartnerAccount(): GetCourierPartnerAccountParam;
     /** @returns {GetCourierPartnerAccountsParam} */
     static getCourierPartnerAccounts(): GetCourierPartnerAccountsParam;
-    /** @returns {GetCourierPartnerSchemeParam} */
-    static getCourierPartnerScheme(): GetCourierPartnerSchemeParam;
-    /** @returns {GetCourierPartnerSchemesParam} */
-    static getCourierPartnerSchemes(): GetCourierPartnerSchemesParam;
+    /** @returns {GetInstalledCourierPartnerExtensionsParam} */
+    static getInstalledCourierPartnerExtensions(): GetInstalledCourierPartnerExtensionsParam;
+    /** @returns {GetListPackageMaterialRuleDetailsParam} */
+    static getListPackageMaterialRuleDetails(): GetListPackageMaterialRuleDetailsParam;
+    /** @returns {GetLocalitiesParam} */
+    static getLocalities(): GetLocalitiesParam;
+    /** @returns {GetLocalitiesByPrefixParam} */
+    static getLocalitiesByPrefix(): GetLocalitiesByPrefixParam;
+    /** @returns {GetLocalityParam} */
+    static getLocality(): GetLocalityParam;
     /** @returns {GetOptimalLocationsParam} */
     static getOptimalLocations(): GetOptimalLocationsParam;
     /** @returns {GetPackageMaterialListParam} */
     static getPackageMaterialList(): GetPackageMaterialListParam;
     /** @returns {GetPackageMaterialRuleParam} */
     static getPackageMaterialRule(): GetPackageMaterialRuleParam;
-    /** @returns {GetPackageMaterialRulesParam} */
-    static getPackageMaterialRules(): GetPackageMaterialRulesParam;
+    /** @returns {GetPackageMaterialRuleDetailsParam} */
+    static getPackageMaterialRuleDetails(): GetPackageMaterialRuleDetailsParam;
     /** @returns {GetPackageMaterialsParam} */
     static getPackageMaterials(): GetPackageMaterialsParam;
-    /** @returns {GetSampleFileServiceabilityStatusParam} */
-    static getSampleFileServiceabilityStatus(): GetSampleFileServiceabilityStatusParam;
-    /** @returns {GetServiceabilityParam} */
-    static getServiceability(): GetServiceabilityParam;
-    /** @returns {GetZoneByIdParam} */
-    static getZoneById(): GetZoneByIdParam;
-    /** @returns {GetZonesParam} */
-    static getZones(): GetZonesParam;
-    /** @returns {SampleFileServiceabilityParam} */
-    static sampleFileServiceability(): SampleFileServiceabilityParam;
     /** @returns {UpdateCompanyConfigurationParam} */
     static updateCompanyConfiguration(): UpdateCompanyConfigurationParam;
+    /** @returns {UpdateCompanySelfShipParam} */
+    static updateCompanySelfShip(): UpdateCompanySelfShipParam;
     /** @returns {UpdateCourierPartnerAccountParam} */
     static updateCourierPartnerAccount(): UpdateCourierPartnerAccountParam;
-    /** @returns {UpdateCourierPartnerSchemeParam} */
-    static updateCourierPartnerScheme(): UpdateCourierPartnerSchemeParam;
     /** @returns {UpdatePackageMaterialRuleParam} */
     static updatePackageMaterialRule(): UpdatePackageMaterialRuleParam;
     /** @returns {UpdatePackageMaterialsParam} */
     static updatePackageMaterials(): UpdatePackageMaterialsParam;
-    /** @returns {UpdateServiceabilityParam} */
-    static updateServiceability(): UpdateServiceabilityParam;
-    /** @returns {UpdateZoneByIdParam} */
-    static updateZoneById(): UpdateZoneByIdParam;
+    /** @returns {ValidateAddressParam} */
+    static validateAddress(): ValidateAddressParam;
 }
 declare namespace ServiceabilityPlatformValidator {
-    export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreateCourierPartnerSchemeParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCountriesParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetCourierPartnerSchemeParam, GetCourierPartnerSchemesParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetSampleFileServiceabilityStatusParam, GetServiceabilityParam, GetZoneByIdParam, GetZonesParam, SampleFileServiceabilityParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdateCourierPartnerSchemeParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
+    export { CreateCourierPartnerAccountParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, GetCompanyConfigurationParam, GetCompanySelfShipParam, GetCountriesParam, GetCountryParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetInstalledCourierPartnerExtensionsParam, GetListPackageMaterialRuleDetailsParam, GetLocalitiesParam, GetLocalitiesByPrefixParam, GetLocalityParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRuleDetailsParam, GetPackageMaterialsParam, UpdateCompanyConfigurationParam, UpdateCompanySelfShipParam, UpdateCourierPartnerAccountParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, ValidateAddressParam };
 }
-type BulkServiceabilityParam = {
+type CreateCourierPartnerAccountParam = {
+    body: ServiceabilityPlatformModel.CourierAccount;
+};
+type CreatePackageMaterialParam = {
     /**
-     * - Unique Identifier of courier partner extension.
+     * - Index of the item to start returning with
      */
-    extensionId: string;
+    pageNo?: number;
+    body: ServiceabilityPlatformModel.PackageMaterial;
+};
+type CreatePackageMaterialRuleParam = {
+    body: ServiceabilityPlatformModel.PackageRuleRequest;
+};
+type GetCountriesParam = {
     /**
-     * - Unique identifier of courier partner scheme.
+     * - Only fetch countries which allowed for
+     * onboard on Platform.
      */
-    schemeId: string;
-    body: ServiceabilityPlatformModel.BulkRegionJobDetails;
-};
-type BulkTatParam = {
+    onboard?: boolean;
     /**
-     * - Unique Identifier of courier partner extension.
+     * - The page number to navigate through the given
+     * set of results. Default value is 1.
      */
-    extensionId: string;
+    pageNo?: number;
     /**
-     * - Unique identifier of courier partner scheme.
+     * - The number of items to retrieve in each page.
+     * Default value is 12
      */
-    schemeId: string;
-    body: ServiceabilityPlatformModel.BulkRegionJobDetails;
-};
-type CreateCourierPartnerAccountParam = {
-    body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
-};
-type CreateCourierPartnerSchemeParam = {
-    body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel;
-};
-type CreatePackageMaterialParam = {
-    body: ServiceabilityPlatformModel.PackageMaterial;
-};
-type CreatePackageMaterialRuleParam = {
-    body: ServiceabilityPlatformModel.PackageRule;
-};
-type CreateZoneParam = {
-    body: ServiceabilityPlatformModel.CreateZoneData;
+    pageSize?: number;
+    /**
+     * - The search string to search in the list of countries by name.
+     */
+    q?: string;
+    /**
+     * - The search filter to filter countries based
+     * on their available hierarchy.
+     */
+    hierarchy?: string;
 };
-type GetBulkServiceabilityParam = {
+type GetCountryParam = {
     /**
-     * - Unique Identifier of courier partner extension.
+     * - The `country_iso_code` is ISO-2 (alpha-2)
+     * code for the country.
      */
-    extensionId: string;
+    countryIsoCode: string;
+};
+type GetCourierPartnerAccountParam = {
     /**
-     * - Unique identifier of courier partner scheme.
+     * - Unique ID of courier account
      */
-    schemeId: string;
+    accountId: string;
+};
+type GetCourierPartnerAccountsParam = {
     /**
      * - Index of the item to start returning with
      */
@@ -319,43 +271,36 @@ type GetBulkServiceabilityParam = {
      */
     pageSize?: number;
     /**
-     * - Unique identifier of bulk job
+     * - Stage of the account. enabled/disabled
      */
-    batchId?: string;
+    stage?: string;
     /**
-     * - Import or export bulk type
+     * - Filters dp accounts based on payment mode
      */
-    action?: string;
+    paymentMode?: string;
     /**
-     * - Status of the bulk actions
+     * - Filters dp accounts based on transport_type
      */
-    status?: string;
+    transportType?: string;
     /**
-     * - Country for which bulk job is initiated
+     * - Filters dp accounts based on their ids
      */
-    country?: string;
+    accountIds?: string[];
     /**
-     * - Region for which bulk job is initiated
+     * - To filter self ship/non self ship dp accounts
      */
-    region?: string;
+    selfShip?: boolean;
     /**
-     * - Fetch job history after a particule date
+     * - Filters seller owned or admin owned dp accounts
      */
-    startDate?: string;
+    ownAccount?: boolean;
     /**
-     * - Fetch job history before a particule date
+     * - Filters dp accounts based on case sensitive partial
+     * account name
      */
-    endDate?: string;
+    q?: string;
 };
-type GetBulkTatParam = {
-    /**
-     * - Unique Identifier of courier partner extension.
-     */
-    extensionId: string;
-    /**
-     * - Unique identifier of courier partner scheme.
-     */
-    schemeId: string;
+type GetInstalledCourierPartnerExtensionsParam = {
     /**
      * - Index of the item to start returning with
      */
@@ -365,40 +310,44 @@ type GetBulkTatParam = {
      */
     pageSize?: number;
     /**
-     * - Unique identifier of bulk job
+     * - Filter to get installed extensions only
      */
-    batchId?: string;
+    isInstalled?: string;
+};
+type GetListPackageMaterialRuleDetailsParam = {
     /**
-     * - Import or export bulk type
+     * - Index of the item to start returning with
      */
-    action?: string;
+    pageNo?: number;
     /**
-     * - Status of the bulk actions
+     * - Determines the items to be displayed in a page
      */
-    status?: string;
+    pageSize?: number;
     /**
-     * - Country for which bulk job is initiated
+     * - Filters items based on given is_active
      */
-    country?: string;
+    isActive?: string;
+};
+type GetLocalitiesParam = {
     /**
-     * - Region for which bulk job is initiated
+     * - A `locality_type` contains unique
+     * geographical division.
      */
-    region?: string;
+    localityType: string;
     /**
-     * - Fetch job history after a particule date
+     * - A `country` contains a specific value of the
+     * country iso2 code.
      */
-    startDate?: string;
+    country?: string;
     /**
-     * - Fetch job history before a particule date
+     * - A `state` contains a specific value of the
+     * state, province.
      */
-    endDate?: string;
-};
-type GetCountriesParam = {
+    state?: string;
     /**
-     * - Only fetch countries which allowed for
-     * onboard on Platform.
+     * - A `city` contains a specific value of the city.
      */
-    onboarding?: boolean;
+    city?: string;
     /**
      * - Page number.
      */
@@ -412,67 +361,53 @@ type GetCountriesParam = {
      */
     q?: string;
     /**
-     * - Fetch countries that has certain heirarchy present.
+     * - Search for localities. Either provide a full name
+     * or a search term.
      */
-    hierarchy?: string;
+    name?: string;
 };
-type GetCourierPartnerAccountParam = {
+type GetLocalitiesByPrefixParam = {
     /**
-     * - Unique ID of courier partner account
-     */
-    accountId: string;
-};
-type GetCourierPartnerAccountsParam = {
-    /**
-     * - Index of the item to start returning with
+     * - Starting index of the items.
      */
     pageNo?: number;
     /**
-     * - Determines the items to be displayed in a page
+     * - Number of items per page.
      */
     pageSize?: number;
     /**
-     * - Stage of the account. enabled/disabled
-     */
-    stage?: string;
-    /**
-     * - Filters dp accounts based on payment mode
+     * - Localities starting with the specified prefix.
      */
-    paymentMode?: string;
-    /**
-     * - Filters dp accounts based on transport_type
-     */
-    transportType?: string;
+    q?: string;
 };
-type GetCourierPartnerSchemeParam = {
+type GetLocalityParam = {
     /**
-     * - Unique Identifier of Scheme
+     * - A `locality_type` contains value
+     * geographical division.
      */
-    schemeId: string;
-};
-type GetCourierPartnerSchemesParam = {
+    localityType: string;
     /**
-     * - Indicates whether a scheme is created by an
-     * admin for global purposes or customized for a specific company.
+     * - A `locality_value` contains a specific
+     * name of the locality.
      */
-    schemeType?: string;
+    localityValue: string;
     /**
-     * - Indicates payment mode for a scheme.
+     * - A `country` contains a specific value of the
+     * country iso2 code.
      */
-    paymentMode?: string;
+    country?: string;
     /**
-     * - Indicates whether the scheme possesses
-     * certain capabilities.
+     * - A `state` contains a specific value of the
+     * state, province.
      */
-    capabilities?: string[];
+    state?: string;
     /**
-     * - List of scheme ids which need to be
-     * returned in the response.
+     * - A `city` contains a specific value of the city.
      */
-    schemeIds?: string[];
+    city?: string;
 };
 type GetOptimalLocationsParam = {
-    body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema;
+    body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema;
 };
 type GetPackageMaterialListParam = {
     /**
@@ -503,7 +438,12 @@ type GetPackageMaterialRuleParam = {
      */
     ruleId: string;
 };
-type GetPackageMaterialRulesParam = {
+type GetPackageMaterialRuleDetailsParam = {
+    /**
+     * - A `package_material_rule_id` is a unique
+     * identifier for a Package Material Rule
+     */
+    ruleId: string;
     /**
      * - Index of the item to start returning with
      */
@@ -519,105 +459,23 @@ type GetPackageMaterialRulesParam = {
 };
 type GetPackageMaterialsParam = {
     /**
-     * - Unique identifier for a Package. Material
+     * - A `package_material_id` is a unique
+     * identifier for a Package Material
      */
     packageMaterialId: string;
 };
-type GetSampleFileServiceabilityStatusParam = {
-    /**
-     * - Index of the item to start returning with
-     */
-    pageNo?: number;
-    /**
-     * - Determines the items to be displayed in a page
-     */
-    pageSize?: number;
-    /**
-     * - Batch id of the execution
-     */
-    batchId?: string;
-};
-type GetServiceabilityParam = {
-    /**
-     * - Unique Identifier of courier partner extension.
-     */
-    extensionId: string;
-    /**
-     * - Unique identifier of courier partner scheme.
-     */
-    schemeId: string;
-    /**
-     * - Unique identifier of a region
-     */
-    regionId: string;
-};
-type GetZoneByIdParam = {
-    /**
-     * - A `zone_id` is a unique identifier for a particular zone.
-     */
-    zoneId: string;
-};
-type GetZonesParam = {
-    /**
-     * - Index of the item to start returning with
-     */
-    pageNo?: number;
-    /**
-     * - Determines the items to be displayed in a page
-     */
-    pageSize?: number;
-    /**
-     * - Status of Zone (either active or inactive)
-     */
-    isActive?: boolean;
-    /**
-     * - Zones filtered by an application
-     */
-    channelId?: string;
-    /**
-     * - Search with name as a free text
-     */
-    q?: string;
-    /**
-     * - ISO2 code of the country
-     */
-    countryIsoCode?: string;
-    /**
-     * - State name
-     */
-    state?: string;
-    /**
-     * - City name
-     */
-    city?: string;
-    /**
-     * - Pincode value to search zones
-     */
-    pincode?: string;
-    /**
-     * - Sector value to search zones
-     */
-    sector?: string;
-};
-type SampleFileServiceabilityParam = {
-    body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails;
-};
 type UpdateCompanyConfigurationParam = {
-    body: ServiceabilityPlatformModel.CompanyConfig;
+    body: ServiceabilityPlatformModel.CompanyConfigurationShema;
+};
+type UpdateCompanySelfShipParam = {
+    body: ServiceabilityPlatformModel.CompanySelfShip;
 };
 type UpdateCourierPartnerAccountParam = {
     /**
-     * - Unique ID of courier partner account
+     * - Unique ID of courier account
      */
     accountId: string;
-    body: ServiceabilityPlatformModel.CourierAccountUpdateDetails;
-};
-type UpdateCourierPartnerSchemeParam = {
-    /**
-     * - Unique Identifier of Scheme
-     */
-    schemeId: string;
-    body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails;
+    body: ServiceabilityPlatformModel.CourierAccount;
 };
 type UpdatePackageMaterialRuleParam = {
     /**
@@ -625,37 +483,27 @@ type UpdatePackageMaterialRuleParam = {
      * identifier for a Package Material Rule
      */
     ruleId: string;
-    body: ServiceabilityPlatformModel.PackageRule;
+    body: ServiceabilityPlatformModel.PackageRuleRequest;
 };
 type UpdatePackageMaterialsParam = {
     /**
-     * - Unique identifier for a Package. Material
+     * - A `package_material_id` is a unique
+     * identifier for a Package Material
      */
     packageMaterialId: string;
     body: ServiceabilityPlatformModel.PackageMaterial;
 };
-type UpdateServiceabilityParam = {
-    /**
-     * - Unique Identifier of courier partner extension.
-     */
-    extensionId: string;
+type ValidateAddressParam = {
     /**
-     * - Unique identifier of courier partner scheme.
+     * - The ISO code of the country.
      */
-    schemeId: string;
-    /**
-     * - Unique identifier of a region
-     */
-    regionId: string;
-    body: ServiceabilityPlatformModel.ServiceabilityModel;
-};
-type UpdateZoneByIdParam = {
+    countryIsoCode: string;
     /**
-     * - A `zone_id` is a unique identifier for a particular zone.
+     * - The type of address form.
      */
-    zoneId: string;
-    body: ServiceabilityPlatformModel.UpdateZoneData;
+    templateName: string;
+    body: ServiceabilityPlatformModel.ValidateAddressRequest;
 };
-type GetAllStoresParam = any;
 type GetCompanyConfigurationParam = any;
+type GetCompanySelfShipParam = any;
 import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");