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

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

@@ -1,19 +1,66 @@
 export = ServiceabilityPlatformValidator;
+/**
+ * @typedef BulkServiceabilityParam
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
+ */
+/**
+ * @typedef BulkTatParam
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
+ */
 /**
  * @typedef CreateCourierPartnerAccountParam
- * @property {ServiceabilityPlatformModel.CourierAccount} body
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
+ */
+/**
+ * @typedef CreateCourierPartnerSchemeParam
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel} body
  */
 /**
  * @typedef CreatePackageMaterialParam
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageNo] - The current page number for paginated results.
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
  */
 /**
  * @typedef CreatePackageMaterialRuleParam
- * @property {ServiceabilityPlatformModel.PackageRuleRequest} body
+ * @property {ServiceabilityPlatformModel.PackageRule} body
+ */
+/**
+ * @typedef GetBulkServiceabilityParam
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {number} [pageNo] - The current page number for paginated results.
+ * @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 courier partner extension.
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {number} [pageNo] - The current page number for paginated results.
+ * @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 GetCompanySelfShipParam */
 /**
  * @typedef GetCountriesParam
  * @property {boolean} [onboard] - Only fetch countries which allowed for
@@ -26,72 +73,43 @@ export = ServiceabilityPlatformValidator;
  * @property {string} [hierarchy] - The search filter to filter countries based
  *   on their available hierarchy.
  */
-/**
- * @typedef GetCountryParam
- * @property {string} countryIsoCode - The `country_iso_code` is ISO-2 (alpha-2)
- *   code for the country.
- */
 /**
  * @typedef GetCourierPartnerAccountParam
  * @property {string} accountId - Unique ID of courier account
  */
 /**
  * @typedef GetCourierPartnerAccountsParam
- * @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} [stage] - Stage of the account. enabled/disabled
+ * @property {string} [stage] - Stage of the account.
  * @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 {boolean} [ownAccount] - Filters seller owned or Fynd Managed dp accounts
  * @property {string} [q] - Filters dp accounts based on case sensitive partial
  *   account name
  */
 /**
- * @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} [isInstalled] - Filter to get installed extensions only
+ * @typedef GetCourierPartnerSchemeParam
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
  */
 /**
- * @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} [isActive] - Filters items based on given is_active
+ * @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 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} [name] - Search for localities. Either provide a full name
- *   or a search term.
- */
-/**
- * @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 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 GetInstalledCourierPartnerExtensionsParam
+ * @property {number} [pageNo] - The current page number for paginated results.
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [isInstalled] - Filter to get installed extensions only
  */
 /**
  * @typedef GetOptimalLocationsParam
@@ -99,9 +117,10 @@ export = ServiceabilityPlatformValidator;
  */
 /**
  * @typedef GetPackageMaterialListParam
- * @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} [q] - Perform regex search on items matching name for given value
+ * @property {string} [q] - Used to search for matching results based on the
+ *   provided input.
  * @property {string} [size] - Filters items based on given size
  * @property {string} [packageType] - Filters items based on given package_type
  */
@@ -110,37 +129,42 @@ export = ServiceabilityPlatformValidator;
  * @property {string} ruleId - A `package_material_rule_id` is a unique
  *   identifier for a Package Material Rule
  */
-/**
- * @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 - A `package_material_id` is a unique
  *   identifier for a Package Material
  */
 /**
- * @typedef UpdateCompanyConfigurationParam
- * @property {ServiceabilityPlatformModel.CompanyConfigurationShema} body
+ * @typedef GetSampleFileServiceabilityStatusParam
+ * @property {number} [pageNo] - The current page number for paginated results.
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [batchId] - Batch id of the execution
+ */
+/** @typedef GetSelfShipDetailsParam */
+/**
+ * @typedef SampleFileServiceabilityParam
+ * @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
  */
 /**
- * @typedef UpdateCompanySelfShipParam
- * @property {ServiceabilityPlatformModel.CompanySelfShip} body
+ * @typedef UpdateCompanyConfigurationParam
+ * @property {ServiceabilityPlatformModel.CompanyConfigurationSchema} body
  */
 /**
  * @typedef UpdateCourierPartnerAccountParam
  * @property {string} accountId - Unique ID of courier account
- * @property {ServiceabilityPlatformModel.CourierAccount} body
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
+ */
+/**
+ * @typedef UpdateCourierPartnerSchemeParam
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema} body
  */
 /**
  * @typedef UpdatePackageMaterialRuleParam
  * @property {string} ruleId - A `package_material_rule_id` is a unique
  *   identifier for a Package Material Rule
- * @property {ServiceabilityPlatformModel.PackageRuleRequest} body
+ * @property {ServiceabilityPlatformModel.PackageRule} body
  */
 /**
  * @typedef UpdatePackageMaterialsParam
@@ -149,78 +173,203 @@ export = ServiceabilityPlatformValidator;
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
  */
 /**
- * @typedef ValidateAddressParam
- * @property {string} countryIsoCode - The ISO code of the country.
- * @property {string} templateName - The type of address form.
- * @property {ServiceabilityPlatformModel.ValidateAddressRequest} body
+ * @typedef UpdateSelfShipDetailsParam
+ * @property {ServiceabilityPlatformModel.SelfshipSchema} 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 {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 {GetPackageMaterialRuleDetailsParam} */
-    static getPackageMaterialRuleDetails(): GetPackageMaterialRuleDetailsParam;
     /** @returns {GetPackageMaterialsParam} */
     static getPackageMaterials(): GetPackageMaterialsParam;
+    /** @returns {GetSampleFileServiceabilityStatusParam} */
+    static getSampleFileServiceabilityStatus(): GetSampleFileServiceabilityStatusParam;
+    /** @returns {GetSelfShipDetailsParam} */
+    static getSelfShipDetails(): any;
+    /** @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 {ValidateAddressParam} */
-    static validateAddress(): ValidateAddressParam;
+    /** @returns {UpdateSelfShipDetailsParam} */
+    static updateSelfShipDetails(): UpdateSelfShipDetailsParam;
 }
 declare namespace ServiceabilityPlatformValidator {
-    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 };
+    export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreateCourierPartnerSchemeParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCountriesParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetCourierPartnerSchemeParam, GetCourierPartnerSchemesParam, GetInstalledCourierPartnerExtensionsParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialsParam, GetSampleFileServiceabilityStatusParam, GetSelfShipDetailsParam, SampleFileServiceabilityParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdateCourierPartnerSchemeParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateSelfShipDetailsParam };
 }
+type BulkServiceabilityParam = {
+    /**
+     * - Unique Identifier of courier partner extension.
+     */
+    extensionId: string;
+    /**
+     * - Unique identifier for the scheme, used to fetch
+     * or modify scheme details.
+     */
+    schemeId: string;
+    body: ServiceabilityPlatformModel.BulkRegionJobDetails;
+};
+type BulkTatParam = {
+    /**
+     * - Unique Identifier of courier partner extension.
+     */
+    extensionId: string;
+    /**
+     * - Unique identifier for the scheme, used to fetch
+     * or modify scheme details.
+     */
+    schemeId: string;
+    body: ServiceabilityPlatformModel.BulkRegionJobDetails;
+};
 type CreateCourierPartnerAccountParam = {
-    body: ServiceabilityPlatformModel.CourierAccount;
+    body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
+};
+type CreateCourierPartnerSchemeParam = {
+    body: ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel;
 };
 type CreatePackageMaterialParam = {
     /**
-     * - Index of the item to start returning with
+     * - The current page number for paginated results.
      */
     pageNo?: number;
     body: ServiceabilityPlatformModel.PackageMaterial;
 };
 type CreatePackageMaterialRuleParam = {
-    body: ServiceabilityPlatformModel.PackageRuleRequest;
+    body: ServiceabilityPlatformModel.PackageRule;
+};
+type GetBulkServiceabilityParam = {
+    /**
+     * - Unique Identifier of courier partner extension.
+     */
+    extensionId: string;
+    /**
+     * - Unique identifier for the scheme, used to fetch
+     * or modify scheme details.
+     */
+    schemeId: string;
+    /**
+     * - The current page number for paginated results.
+     */
+    pageNo?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+    /**
+     * - Unique identifier of bulk job
+     */
+    batchId?: string;
+    /**
+     * - Import or export bulk type
+     */
+    action?: string;
+    /**
+     * - Status of the bulk actions
+     */
+    status?: string;
+    /**
+     * - Country for which bulk job is initiated
+     */
+    country?: string;
+    /**
+     * - Region for which bulk job is initiated
+     */
+    region?: string;
+    /**
+     * - Fetch job history after a particule date
+     */
+    startDate?: string;
+    /**
+     * - Fetch job history before a particule date
+     */
+    endDate?: string;
+};
+type GetBulkTatParam = {
+    /**
+     * - Unique Identifier of courier partner extension.
+     */
+    extensionId: string;
+    /**
+     * - Unique identifier for the scheme, used to fetch
+     * or modify scheme details.
+     */
+    schemeId: string;
+    /**
+     * - The current page number for paginated results.
+     */
+    pageNo?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+    /**
+     * - Unique identifier of bulk job
+     */
+    batchId?: string;
+    /**
+     * - Import or export bulk type
+     */
+    action?: string;
+    /**
+     * - Status of the bulk actions
+     */
+    status?: string;
+    /**
+     * - Country for which bulk job is initiated
+     */
+    country?: string;
+    /**
+     * - Region for which bulk job is initiated
+     */
+    region?: string;
+    /**
+     * - Fetch job history after a particule date
+     */
+    startDate?: string;
+    /**
+     * - Fetch job history before a particule date
+     */
+    endDate?: string;
 };
 type GetCountriesParam = {
     /**
@@ -248,13 +397,6 @@ type GetCountriesParam = {
      */
     hierarchy?: string;
 };
-type GetCountryParam = {
-    /**
-     * - The `country_iso_code` is ISO-2 (alpha-2)
-     * code for the country.
-     */
-    countryIsoCode: string;
-};
 type GetCourierPartnerAccountParam = {
     /**
      * - Unique ID of courier account
@@ -263,7 +405,7 @@ type GetCourierPartnerAccountParam = {
 };
 type GetCourierPartnerAccountsParam = {
     /**
-     * - Index of the item to start returning with
+     * - The current page number for paginated results.
      */
     pageNo?: number;
     /**
@@ -271,7 +413,7 @@ type GetCourierPartnerAccountsParam = {
      */
     pageSize?: number;
     /**
-     * - Stage of the account. enabled/disabled
+     * - Stage of the account.
      */
     stage?: string;
     /**
@@ -291,7 +433,7 @@ type GetCourierPartnerAccountsParam = {
      */
     selfShip?: boolean;
     /**
-     * - Filters seller owned or admin owned dp accounts
+     * - Filters seller owned or Fynd Managed dp accounts
      */
     ownAccount?: boolean;
     /**
@@ -300,118 +442,54 @@ type GetCourierPartnerAccountsParam = {
      */
     q?: string;
 };
-type GetInstalledCourierPartnerExtensionsParam = {
-    /**
-     * - Index of the item to start returning with
-     */
-    pageNo?: number;
-    /**
-     * - Determines the items to be displayed in a page
-     */
-    pageSize?: number;
-    /**
-     * - Filter to get installed extensions only
-     */
-    isInstalled?: string;
-};
-type GetListPackageMaterialRuleDetailsParam = {
-    /**
-     * - Index of the item to start returning with
-     */
-    pageNo?: number;
-    /**
-     * - Determines the items to be displayed in a page
-     */
-    pageSize?: number;
+type GetCourierPartnerSchemeParam = {
     /**
-     * - Filters items based on given is_active
+     * - Unique identifier for the scheme, used to fetch
+     * or modify scheme details.
      */
-    isActive?: string;
+    schemeId: string;
 };
-type GetLocalitiesParam = {
-    /**
-     * - A `locality_type` contains unique
-     * geographical division.
-     */
-    localityType: string;
-    /**
-     * - A `country` contains a specific value of the
-     * country iso2 code.
-     */
-    country?: string;
-    /**
-     * - A `state` contains a specific value of the
-     * state, province.
-     */
-    state?: string;
-    /**
-     * - A `city` contains a specific value of the city.
-     */
-    city?: string;
+type GetCourierPartnerSchemesParam = {
     /**
-     * - Page number.
+     * - Indicates whether a scheme is created by an
+     * admin for global purposes or customized for a specific company.
      */
-    pageNo?: number;
+    schemeType?: string;
     /**
-     * - Page size.
+     * - Indicates payment mode for a scheme.
      */
-    pageSize?: number;
+    paymentMode?: string;
     /**
-     * - Search.
+     * - Indicates whether the scheme possesses
+     * certain capabilities.
      */
-    q?: string;
+    capabilities?: string[];
     /**
-     * - Search for localities. Either provide a full name
-     * or a search term.
+     * - List of scheme ids which need to be
+     * returned in the response.
      */
-    name?: string;
+    schemeIds?: string[];
 };
-type GetLocalitiesByPrefixParam = {
+type GetInstalledCourierPartnerExtensionsParam = {
     /**
-     * - Starting index of the items.
+     * - The current page number for paginated results.
      */
     pageNo?: number;
     /**
-     * - Number of items per page.
+     * - Determines the items to be displayed in a page
      */
     pageSize?: number;
     /**
-     * - Localities starting with the specified prefix.
-     */
-    q?: string;
-};
-type GetLocalityParam = {
-    /**
-     * - A `locality_type` contains value
-     * geographical division.
-     */
-    localityType: string;
-    /**
-     * - A `locality_value` contains a specific
-     * name of the locality.
-     */
-    localityValue: string;
-    /**
-     * - A `country` contains a specific value of the
-     * country iso2 code.
-     */
-    country?: string;
-    /**
-     * - A `state` contains a specific value of the
-     * state, province.
-     */
-    state?: string;
-    /**
-     * - A `city` contains a specific value of the city.
+     * - Filter to get installed extensions only
      */
-    city?: string;
+    isInstalled?: string;
 };
 type GetOptimalLocationsParam = {
     body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema;
 };
 type GetPackageMaterialListParam = {
     /**
-     * - Index of the item to start returning with
+     * - The current page number for paginated results.
      */
     pageNo?: number;
     /**
@@ -419,7 +497,8 @@ type GetPackageMaterialListParam = {
      */
     pageSize?: number;
     /**
-     * - Perform regex search on items matching name for given value
+     * - Used to search for matching results based on the
+     * provided input.
      */
     q?: string;
     /**
@@ -438,14 +517,16 @@ type GetPackageMaterialRuleParam = {
      */
     ruleId: string;
 };
-type GetPackageMaterialRuleDetailsParam = {
+type GetPackageMaterialsParam = {
     /**
-     * - A `package_material_rule_id` is a unique
-     * identifier for a Package Material Rule
+     * - A `package_material_id` is a unique
+     * identifier for a Package Material
      */
-    ruleId: string;
+    packageMaterialId: string;
+};
+type GetSampleFileServiceabilityStatusParam = {
     /**
-     * - Index of the item to start returning with
+     * - The current page number for paginated results.
      */
     pageNo?: number;
     /**
@@ -453,29 +534,30 @@ type GetPackageMaterialRuleDetailsParam = {
      */
     pageSize?: number;
     /**
-     * - Filters items based on given is_active
+     * - Batch id of the execution
      */
-    isActive?: string;
+    batchId?: string;
 };
-type GetPackageMaterialsParam = {
-    /**
-     * - A `package_material_id` is a unique
-     * identifier for a Package Material
-     */
-    packageMaterialId: string;
+type SampleFileServiceabilityParam = {
+    body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails;
 };
 type UpdateCompanyConfigurationParam = {
-    body: ServiceabilityPlatformModel.CompanyConfigurationShema;
-};
-type UpdateCompanySelfShipParam = {
-    body: ServiceabilityPlatformModel.CompanySelfShip;
+    body: ServiceabilityPlatformModel.CompanyConfigurationSchema;
 };
 type UpdateCourierPartnerAccountParam = {
     /**
      * - Unique ID of courier account
      */
     accountId: string;
-    body: ServiceabilityPlatformModel.CourierAccount;
+    body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
+};
+type UpdateCourierPartnerSchemeParam = {
+    /**
+     * - Unique identifier for the scheme, used to fetch
+     * or modify scheme details.
+     */
+    schemeId: string;
+    body: ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema;
 };
 type UpdatePackageMaterialRuleParam = {
     /**
@@ -483,7 +565,7 @@ type UpdatePackageMaterialRuleParam = {
      * identifier for a Package Material Rule
      */
     ruleId: string;
-    body: ServiceabilityPlatformModel.PackageRuleRequest;
+    body: ServiceabilityPlatformModel.PackageRule;
 };
 type UpdatePackageMaterialsParam = {
     /**
@@ -493,17 +575,9 @@ type UpdatePackageMaterialsParam = {
     packageMaterialId: string;
     body: ServiceabilityPlatformModel.PackageMaterial;
 };
-type ValidateAddressParam = {
-    /**
-     * - The ISO code of the country.
-     */
-    countryIsoCode: string;
-    /**
-     * - The type of address form.
-     */
-    templateName: string;
-    body: ServiceabilityPlatformModel.ValidateAddressRequest;
+type UpdateSelfShipDetailsParam = {
+    body: ServiceabilityPlatformModel.SelfshipSchema;
 };
 type GetCompanyConfigurationParam = any;
-type GetCompanySelfShipParam = any;
+type GetSelfShipDetailsParam = any;
 import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");