export = Serviceability; declare class Serviceability { constructor(config: any); config: any; /** * @param {ServiceabilityPlatformValidator.BulkServiceabilityParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name bulkServiceability * @summary: Bulk update serviceability of localities * @description: Bulk operations involve either new serviceability settings or updating existing ones in large quantities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/bulkServiceability/). */ bulkServiceability({ extensionId, schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.BulkServiceabilityParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.BulkTatParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name bulkTat * @summary: Locality TAT import or export * @description: Updates locality wise TAT(Turn Around Time) for particular courier scheme using CSV file. * Export locality wise CSV files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/bulkTat/). */ bulkTat({ extensionId, schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.BulkTatParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.CreateCourierPartnerAccountParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name createCourierPartnerAccount * @summary: Create courier account * @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerAccount/). */ createCourierPartnerAccount({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerAccountParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.CreateCourierPartnerSchemeParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name createCourierPartnerScheme * @summary: Create Scheme for courier partner extension * @description: Create Scheme for courier partner extension - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerScheme/). */ createCourierPartnerScheme({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.CreatePackageMaterialParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name createPackageMaterial * @summary: Create packaging material * @description: Creates a packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createPackageMaterial/). */ createPackageMaterial({ body, pageNo, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.CreatePackageMaterialRuleParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name createPackageMaterialRule * @summary: Create packaging rule * @description: Creates a packaging rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createPackageMaterialRule/). */ createPackageMaterialRule({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialRuleParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetBulkServiceabilityParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getBulkServiceability * @summary: Bulk update history * @description: Retrieves the history of changes made to serviceability settings for a scheme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkServiceability/). */ getBulkServiceability({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, country, region, startDate, endDate, requestHeaders, }?: ServiceabilityPlatformValidator.GetBulkServiceabilityParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetBulkTatParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getBulkTat * @summary: Locality TAT change history * @description: Retrieves the history of changes made to TAT(Turn Around Time) for scheme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkTat/). */ getBulkTat({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, country, region, startDate, endDate, requestHeaders, }?: ServiceabilityPlatformValidator.GetBulkTatParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetCompanyConfigurationParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getCompanyConfiguration * @summary: Get delivery configuration * @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCompanyConfiguration/). */ getCompanyConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetCompanyCourierPartnersListParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name getCompanyCourierPartnersList * @summary: Get available company courier partners * @description: Retrieves a list of courier partners available for shipping based on serviceability criteria, shipment details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCompanyCourierPartnersList/). */ getCompanyCourierPartnersList({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetCompanyCourierPartnersListParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetCountriesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getCountries * @summary: Get all countries and associated data * @description: Retrieve a list of countries for logistical purposes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCountries/). */ getCountries({ onboard, pageNo, pageSize, q, hierarchy, requestHeaders }?: ServiceabilityPlatformValidator.GetCountriesParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetCourierPartnerAccountParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getCourierPartnerAccount * @summary: Get courier account * @description: Retrieves a single courier partner account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerAccount/). */ getCourierPartnerAccount({ accountId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name getCourierPartnerAccounts * @summary: List courier accounts * @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerAccounts/). */ getCourierPartnerAccounts({ pageNo, pageSize, stage, paymentMode, transportType, accountIds, selfShip, ownAccount, q, requestHeaders, }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetCourierPartnerSchemeParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name getCourierPartnerScheme * @summary: Get Scheme for courier partner extension by Id * @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerScheme/). */ getCourierPartnerScheme({ schemeId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemeParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetCourierPartnerSchemesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name getCourierPartnerSchemes * @summary: Get created Schemes for courier partner * @description: Get created Schemes for courier partner - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerSchemes/). */ getCourierPartnerSchemes({ extensionId, schemeType, paymentMode, capabilities, schemeIds, q, requestHeaders, }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemesParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetInstalledCourierPartnerExtensionsParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name getInstalledCourierPartnerExtensions * @summary: Fetching of Package Material Rules from database. * @description: This API returns response of Package Materials Rules. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getInstalledCourierPartnerExtensions/). */ getInstalledCourierPartnerExtensions({ pageNo, pageSize, isInstalled, requestHeaders }?: ServiceabilityPlatformValidator.GetInstalledCourierPartnerExtensionsParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetOptimalLocationsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getOptimalLocations * @summary: Get selling locations * @description: Retrieves a list selling locations which are best suited to fullfil an order for a customer. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getOptimalLocations/). */ getOptimalLocations({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetPackageMaterialListParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getPackageMaterialList * @summary: Get packaging materials * @description: Retrieves a list of packaging materials - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterialList/). */ getPackageMaterialList({ pageNo, pageSize, q, size, packageType, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialListParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetPackageMaterialRuleParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getPackageMaterialRule * @summary: Get packaging material rule * @description: Retrieve packaging rule details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterialRule/). */ getPackageMaterialRule({ ruleId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRuleParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetPackageMaterialsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getPackageMaterials * @summary: Get packaging material * @description: Retrieve a single packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterials/). */ getPackageMaterials({ packageMaterialId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialsParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetSampleFileServiceabilityStatusParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name getSampleFileServiceabilityStatus * @summary: Get Serviceability TAT sample files generator status * @description: Get Serviceability TAT sample file generator status - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getSampleFileServiceabilityStatus/). */ getSampleFileServiceabilityStatus({ pageNo, pageSize, batchId, requestHeaders }?: ServiceabilityPlatformValidator.GetSampleFileServiceabilityStatusParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.GetSelfShipDetailsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getSelfShipDetails * @summary: Get self-ship details * @description: Get the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getSelfShipDetails/). */ getSelfShipDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.SampleFileServiceabilityParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name sampleFileServiceability * @summary: Sample File Download * @description: Sample File Download - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/sampleFileServiceability/). */ sampleFileServiceability({ body, requestHeaders }?: ServiceabilityPlatformValidator.SampleFileServiceabilityParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateCompanyConfiguration * @summary: Update delivery configuration * @description: Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCompanyConfiguration/). */ updateCompanyConfiguration({ fulfillmentOptionSlug, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name updateCourierPartnerAccount * @summary: Update courier account * @description: Updates an existing courier partner account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierPartnerAccount/). */ updateCourierPartnerAccount({ accountId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.UpdateCourierPartnerSchemeParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name updateCourierPartnerScheme * @summary: Update Scheme for courier partner extension * @description: Update Scheme for courier partner extension - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierPartnerScheme/). */ updateCourierPartnerScheme({ schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.UpdatePackageMaterialRuleParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name updatePackageMaterialRule * @summary: Update packaging rule * @description: Update an existing packaging rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePackageMaterialRule/). */ updatePackageMaterialRule({ ruleId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialRuleParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.UpdatePackageMaterialsParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name updatePackageMaterials * @summary: Update packaging material * @description: Update an existing packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePackageMaterials/). */ updatePackageMaterials({ packageMaterialId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialsParam, { responseHeaders }?: object): Promise; /** * @param {ServiceabilityPlatformValidator.UpdateSelfShipDetailsParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateSelfShipDetails * @summary: Update self-ship details * @description: Updates the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateSelfShipDetails/). */ updateSelfShipDetails({ body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateSelfShipDetailsParam, { responseHeaders }?: object): Promise; } import ServiceabilityPlatformValidator = require("./ServiceabilityPlatformValidator"); import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");