export = CatalogPlatformValidator; /** * @typedef AddInventoryParam * @property {number} itemId - Item id of the product of which size is to be get. * @property {string} size - Size in which inventory is to be added. * @property {CatalogPlatformModel.InventoryRequestSchema} body */ /** * @typedef AllSizesParam * @property {number} itemId - Id of the product to be updated. */ /** * @typedef BulkHsnCodeParam * @property {CatalogPlatformModel.BulkHsnUpsert} body */ /** * @typedef CreateBulkInventoryParam * @property {string} batchId - Batch Id of the bulk create job. * @property {CatalogPlatformModel.InventoryBulkRequestSchema} body */ /** * @typedef CreateBulkInventoryJobParam * @property {CatalogPlatformModel.BulkInventoryJob} body */ /** * @typedef CreateBulkProductUploadJobParam * @property {CatalogPlatformModel.BulkJob} body */ /** * @typedef CreateHsCodeParam * @property {CatalogPlatformModel.HSCodeItem} body */ /** * @typedef CreateInventoryExportParam * @property {CatalogPlatformModel.InventoryCreateRequestSchema} body */ /** * @typedef CreateInventoryExportJobParam * @property {CatalogPlatformModel.InventoryExportRequestSchema} body */ /** * @typedef CreateMarketplaceOptinParam * @property {string} marketplaceSlug - The marketplace for which the detail * needs to be retrieved. * @property {CatalogPlatformModel.OptInPostRequestSchema} body */ /** * @typedef CreateProductParam * @property {CatalogPlatformModel.ProductCreateSchemaV3} body */ /** * @typedef CreateProductAssetsInBulkParam * @property {CatalogPlatformModel.ProductBulkAssets} body */ /** * @typedef CreateProductExportJobParam * @property {CatalogPlatformModel.ProductTemplateDownloadsExport} body */ /** * @typedef CreateProductsInBulkParam * @property {string} batchId - Batch Id in which assets to be uploaded. * @property {CatalogPlatformModel.BulkProductRequestSchema} body */ /** * @typedef CreateSizeGuideParam * @property {CatalogPlatformModel.ValidateSizeGuide} body */ /** * @typedef CreateTaxParam * @property {CatalogPlatformModel.CreateTaxRequestBody} body */ /** * @typedef CreateTaxComponentNameParam * @property {CatalogPlatformModel.CreateTaxComponentNameRequestSchema} body */ /** * @typedef CreateTaxVersionParam * @property {string} ruleId - Unique identifier of the tax rule * @property {CatalogPlatformModel.CreateTaxVersionRequestBody} body */ /** * @typedef DeleteBulkInventoryJobParam * @property {string} batchId - Batch Id of the bulk delete job. */ /** * @typedef DeleteProductParam * @property {number} itemId - Id of the product to be deleted. */ /** * @typedef DeleteProductBulkJobParam * @property {number} batchId - Batch Id of the bulk product job to be deleted. */ /** * @typedef DeleteRealtimeInventoryParam * @property {number} itemId - Item code of the product of which size is to be get. * @property {string} sellerIdentifier - Size Identifier (Seller Identifier or * Primary Identifier) of which inventory is to get. * @property {CatalogPlatformModel.InventoryRequestSchemaV2} body */ /** * @typedef DeleteSizeParam * @property {number} itemId - Item Id of the product associated with size to be deleted. * @property {string} size - Size to be deleted. */ /** * @typedef DeleteTaxRuleParam * @property {string} ruleId - Unique identifier of the tax rule to be deleted */ /** * @typedef DeleteTaxVersionParam * @property {string} ruleId - Unique identifier of the tax rule to be deleted * @property {string} versionId - Unique identifier of the tax version to be deleted */ /** * @typedef DownloadInventoryTemplateViewParam * @property {string} schemaType - Specifies the type of template to download. * Either quantity or price * @property {string} type - File extension type */ /** * @typedef DownloadProductTemplateViewsParam * @property {string} slug - A `slug` is a unique identifier for a particular template. * @property {string} [itemType] - An `item_type` defines the type of item. The * default value is standard. * @property {string} [type] - Format type of the sample file. The default value is excel. */ /** * @typedef EditProductParam * @property {number} itemId - Id of the product to be updated. * @property {CatalogPlatformModel.ProductUpdateSchemaV3} body */ /** * @typedef ExportInventoryConfigParam * @property {string} [filterType] - Filter type from any one of ['brand', * 'store', 'type'] */ /** * @typedef GetAllProductHsnCodesParam * @property {number} [pageNo] - Indicates current page number * @property {number} [pageSize] - Indicates page size * @property {string} [q] - Search using hsn code, description, reporting_hsn * @property {string} [type] - Search using type */ /** * @typedef GetAllTaxRulesParam * @property {string} [q] - Search query to filter tax rules * @property {string} [statuses] - Filter tax rules based on their lifecycle status. * @property {number} [page] - The page number to retrieve * @property {number} [limit] - Maximum number of tax rule items per page * @property {string} [versionStatus] - Filter tax rules to include only those * with versions in the specified status. */ /** * @typedef GetAttributeParam * @property {string} attributeSlug - Slug of the attribute for which you want * to view the details */ /** * @typedef GetCategoryDataParam * @property {string} uid - Category unique id */ /** * @typedef GetCompanyBrandDetailParam * @property {boolean} [isActive] - The is_active status for the optin id. * @property {string} [q] - The search value to filter the list. * @property {number} [pageNo] - The number of page for the company id. * @property {number} [pageSize] - Number of records that can be seen on the * page for the company id. * @property {string} [marketplace] - The marketplace platform associated with * the company id. */ /** @typedef GetCompanyDetailParam */ /** @typedef GetCompanyMetricsParam */ /** * @typedef GetDepartmentDataParam * @property {string} uid - A `uid` is a unique identifier of a department. */ /** * @typedef GetHsCodesParam * @property {number} [page] - The page number for pagination. * @property {number} [limit] - The number of items to return per page. * @property {string} [type] - Filter by HS/SAC code type. * @property {string} [q] - Search query to filter HS/SAC codes by code or description. */ /** * @typedef GetHsnCodeParam * @property {string} id - Unique id */ /** * @typedef GetInventoriesParam * @property {string} [itemId] - Item code of the product of which size is to be get. * @property {string} [size] - Size of which inventory is to get. * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 12. * @property {string} [pageId] - Alphanumeric Page ID to retrieve next set of results. * @property {string} [pageType] - Available pagination types are cursor or number. * @property {string} [q] - Search with help of store code. * @property {boolean} [sellable] - Filter on whether product is in stock or not. * @property {number[]} [storeIds] - The Store Id of products to fetch inventory. * @property {number[]} [brandIds] - The Brand Id of products to fetch inventory. * @property {string[]} [sellerIdentifiers] - The Seller Identifier or Primary * Identifier of the inventory. * @property {number} [qtyGt] - This field allows you to filter for inventories * that have quantity greater than to the specified value based on qty_type filter. * @property {number} [qtyLt] - This field allows you to filter for inventories * that have a quantity less than to the specified value based on qty_type filter. * @property {string} [qtyType] - This field provides flexibility in selecting * filter for inventory quantity counts and date queries. For example, you * might use this field to specify "total" or "sellable" quantity. * @property {string} [fromDate] - Inventory updated on filter to get * inventories greater then or equal to provided date based on qty_type value. * @property {string} [toDate] - Inventory updated on filter to get inventories * less then or equal to provided date based on qty_type value. * @property {string} [sizeIdentifier] - Size Identifier (Seller Identifier or * Primary Identifier) of which inventory is to get. */ /** * @typedef GetInventoryBulkUploadHistoryParam * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 12. * @property {string} [search] - Search string to filter the results by batch id * @property {string} [startDate] - Filter results by the job's start date. * @property {string} [endDate] - Filter results by the job's end date. * @property {string} [stage] - Filter results by the current stage of the import job. * @property {string} [tags] - Filter results by the tags of the import job. */ /** * @typedef GetInventoryBySizeParam * @property {number} itemId - Item code of the product of which size is to be get. * @property {string} size - Size of which inventory is to get. * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 12. * @property {string} [q] - Search with help of store code. * @property {boolean} [sellable] - Filter on whether product is in stock or not. */ /** * @typedef GetInventoryBySizeIdentifierParam * @property {number} itemId - Item code of the product of which size is to be get. * @property {string} sizeIdentifier - Size Identifier (Seller Identifier or * Primary Identifier) of which inventory is to get. * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 12. * @property {string} [q] - Search with help of store code. * @property {number[]} [locationIds] - Search by store ids. */ /** @typedef GetInventoryExportParam */ /** @typedef GetMarketplaceOptinDetailParam */ /** @typedef GetMarketplacesParam */ /** * @typedef GetProductParam * @property {number} itemId - Item Id of the product. * @property {number} [brandUid] - Brand Id of the product. * @property {string} [itemCode] - Item code of the product. */ /** * @typedef GetProductAssetsInBulkParam * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 12. */ /** * @typedef GetProductAttributesParam * @property {string} category - It is the name of the l3 cateogry * @property {boolean} [filter] - If true, returns filtered values, else returns * all the attributes */ /** * @typedef GetProductBulkUploadHistoryParam * @property {string} [search] - Search string to filter the results by batch id * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 12. */ /** * @typedef GetProductExportJobsParam * @property {string} [status] - This is a parameter used to find all the jobs * with the specified status. * @property {string} [fromDate] - This is a parameter used to find the job from * the date specified to the current date. * @property {string} [toDate] - This is a parameter used to find the job from * the from_date specified to the to_date. * @property {string} [q] - It is a query parameter to search the export job * with the task ID. * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 12. */ /** * @typedef GetProductSizeParam * @property {string} [itemCode] - Item code of the product size. * @property {number} itemId - Item Id of the product size. * @property {number} [brandUid] - Brand Id of the product size. * @property {number} [uid] - Id of the product size. */ /** @typedef GetProductTagsParam */ /** @typedef GetProductValidationParam */ /** * @typedef GetProductsParam * @property {number[]} [brandIds] - Get multiple products filtered by Brand Ids * @property {number[]} [categoryIds] - Get multiple products filtered by Category Ids * @property {number[]} [itemIds] - Get multiple products filtered by Item Ids * @property {number[]} [departmentIds] - Get multiple products filtered by Department Ids * @property {string[]} [itemCode] - Get multiple products filtered by Item Code * @property {string} [name] - Get multiple products filtered by Name (Pattern Match) * @property {string} [slug] - Get multiple products filtered by Slug * @property {string[]} [allIdentifiers] - Get multiple products filtered by All * Identifiers * @property {string} [q] - Get multiple products filtered by q string * @property {string[]} [tags] - Get multiple products filtered by tags * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 10. * @property {string} [pageType] - For pagination type value can be cursor or * number. Default is number. * @property {string} [sortOn] - Field which is to be used for sorting, default * is latest. Value can be latest (modified_on) or created (record id) * @property {string} [pageId] - If page_type is cursor, each response will * contain **next_id** param (datetime or id depending upon sort_on), which * should be sent back as page_id to make cursor pagination work. */ /** * @typedef GetSellerInsightsParam * @property {string} sellerAppId - Id of the seller application which is * serving the invetory/catalog of the company */ /** * @typedef GetSingleProductHSNCodeParam * @property {string} reportingHsn - Reporting_hsn */ /** * @typedef GetSizeGuideParam * @property {string} id - Id of the size guide to be viewed. */ /** * @typedef GetSizeGuidesParam * @property {boolean} [active] - Filter size guide on basis of active, in-active * @property {string} [q] - Query that is to be searched. * @property {string} [tag] - To filter size guide on basis of tag. * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 10. * @property {number} [brandId] - Brand id that is to be searched. */ /** * @typedef GetStoreDetailParam * @property {string} [q] - The search related the store for the company id. * @property {number} [pageNo] - The number of page for the company id. * @property {number} [pageSize] - Number of records that can be seen on the * page for the company id. */ /** @typedef GetTaxComponentNamesParam */ /** * @typedef GetTaxVersionDetailsParam * @property {string} ruleId - Unique identifier of the tax rule * @property {string} [versionStatus] - Filter by tax version status * @property {string} [q] - Case-insensitive search by region name (e.g., * "john", "New York") to find matching tax versions * @property {string} [limit] - The number of items to return per page for * paginated past versions * @property {string} [page] - The page number for paginated past versions. */ /** * @typedef GetVariantsOfProductsParam * @property {number} itemId - Get list of variants of item Id * @property {string} variantType - Get multiple products filtered by variant type * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 10. */ /** * @typedef ListCategoriesParam * @property {number[]} [level] - Get category for multiple levels * @property {number} [department] - Get category for multiple departments filtered * @property {string} [q] - Get multiple categories filtered by search string * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 10. * @property {number[]} [uids] - Get multiple categories filtered by category uids. * @property {string} [slug] - Get category by slug */ /** * @typedef ListDepartmentsDataParam * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {string} [itemType] - A `item_type` is a type of product eg. set, * standard, digital * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 10. * @property {string} [name] - Can search departments by passing name. * @property {string} [search] - Can search departments by passing name of the * department in search parameter. * @property {boolean} [isActive] - Can query for departments based on whether * they are active or inactive. * @property {string} [slug] - Can filter by slug */ /** @typedef ListHSNCodesParam */ /** * @typedef ListInventoryExportParam * @property {string} [status] - Status of the export job.(Pending, Running, Success) * @property {string} [fromDate] - Inventory export history filtered according * to from_date. * @property {string} [toDate] - Inventory export history filtered according to from_date. * @property {string} [q] - Inventory export history filtered according to task ID. * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 12. */ /** * @typedef ListProductTemplateParam * @property {string} department - A `department` is the name of a particular department. * @property {number} [pageNo] - The page number to navigate through the given * set of results * @property {number} [pageSize] - Number of items to retrieve in each page. * Default is 12. */ /** * @typedef ListProductTemplateCategoriesParam * @property {string} departments - A `department` is name of a departments * whose category needs to be listed. Can specify multiple departments. * @property {string} itemType - An `item_type` is the type of item, it can be * `set`, `standard`, `digital`, etc. */ /** @typedef ListProductTemplateExportDetailsParam */ /** * @typedef ListTemplateBrandTypeValuesParam * @property {string} filter - A `filter` is the unique identifier of the type * of value required. * @property {string} [templateTag] - A `template_tag` is the identifier of the * type of template required. * @property {string} [itemType] - A `item_type` is the identifier of the type * of template required. */ /** * @typedef PartialUpdateProductParam * @property {number} itemId - Item ID of the product to be patched. * @property {CatalogPlatformModel.ProductPatchSchemaV3} body */ /** * @typedef UpdateHsnCodeParam * @property {string} id - Unique id * @property {CatalogPlatformModel.HsnUpsert} body */ /** * @typedef UpdateInventoriesParam * @property {CatalogPlatformModel.InventoryRequestSchemaV2} body */ /** * @typedef UpdateLocationPriceParam * @property {number} storeId - The Store Id to update price of size for specific store. * @property {string} sellerIdentifier - Size Identifier (Seller Identifier or * Primary Identifier) of which article price is to update. * @property {CatalogPlatformModel.LocationPriceRequestSchema} body */ /** * @typedef UpdateLocationQuantityParam * @property {number} storeId - The Store Id to update quantity of size for * specific store. * @property {string} sellerIdentifier - Size Identifier (Seller Identifier or * Primary Identifier) of which article quantity is to update. * @property {CatalogPlatformModel.LocationQuantityRequestSchema} body */ /** * @typedef UpdateMarketplaceOptinParam * @property {string} marketplaceSlug - Slug of the marketplace. * @property {CatalogPlatformModel.UpdateMarketplaceOptinRequestSchema} body */ /** * @typedef UpdateRealtimeInventoryParam * @property {number} itemId - Item code of the product of which size is to be get. * @property {string} sellerIdentifier - Size Identifier (Seller Identifier or * Primary Identifier) of which inventory is to get. * @property {CatalogPlatformModel.InventoryRequestSchemaV2} body */ /** * @typedef UpdateSizeGuideParam * @property {string} id - Identifier of the size guide to be edited * @property {CatalogPlatformModel.ValidateSizeGuide} body */ /** * @typedef UpdateTaxRuleParam * @property {string} ruleId - Unique identifier of the tax rule to update * @property {CatalogPlatformModel.UpdateTaxRequestBody} body */ /** * @typedef UpdateTaxVersionParam * @property {string} ruleId - Unique identifier of the tax rule to be updated * @property {string} versionId - Unique identifier of the tax version to be updated * @property {CatalogPlatformModel.UpdateTaxVersionRequestBody} body */ /** * @typedef ValidateProductGlobalTemplateParam * @property {string} [itemType] - An `item_type` defines the type of item. The * default value is standard. * @property {boolean} [bulk] - This specification determines the schema type to * be retrieved. When set to true, it will return the schema for bulk data; * when set to false, it will provide the schema for a single product. The * default value is false. */ /** * @typedef ValidateProductTemplateParam * @property {string} slug - A `slug` is a unique identifier for a particular template. * @property {string} [itemType] - An `item_type` defines the type of item. The * default value is standard. * @property {boolean} [bulk] - This specification determines the schema type to * be retrieved. When set to true, it will return the schema for bulk data; * when set to false, it will provide the schema for a single product. The * default value is false. */ /** * @typedef ValidateProductTemplateSchemaParam * @property {string} itemType - An `item_type` defines the type of item. The * default value is standard. * @property {string} [schemaType] - Schema of price or quantity template */ declare class CatalogPlatformValidator { /** @returns {AddInventoryParam} */ static addInventory(): AddInventoryParam; /** @returns {AllSizesParam} */ static allSizes(): AllSizesParam; /** @returns {BulkHsnCodeParam} */ static bulkHsnCode(): BulkHsnCodeParam; /** @returns {CreateBulkInventoryParam} */ static createBulkInventory(): CreateBulkInventoryParam; /** @returns {CreateBulkInventoryJobParam} */ static createBulkInventoryJob(): CreateBulkInventoryJobParam; /** @returns {CreateBulkProductUploadJobParam} */ static createBulkProductUploadJob(): CreateBulkProductUploadJobParam; /** @returns {CreateHsCodeParam} */ static createHsCode(): CreateHsCodeParam; /** @returns {CreateInventoryExportParam} */ static createInventoryExport(): CreateInventoryExportParam; /** @returns {CreateInventoryExportJobParam} */ static createInventoryExportJob(): CreateInventoryExportJobParam; /** @returns {CreateMarketplaceOptinParam} */ static createMarketplaceOptin(): CreateMarketplaceOptinParam; /** @returns {CreateProductParam} */ static createProduct(): CreateProductParam; /** @returns {CreateProductAssetsInBulkParam} */ static createProductAssetsInBulk(): CreateProductAssetsInBulkParam; /** @returns {CreateProductExportJobParam} */ static createProductExportJob(): CreateProductExportJobParam; /** @returns {CreateProductsInBulkParam} */ static createProductsInBulk(): CreateProductsInBulkParam; /** @returns {CreateSizeGuideParam} */ static createSizeGuide(): CreateSizeGuideParam; /** @returns {CreateTaxParam} */ static createTax(): CreateTaxParam; /** @returns {CreateTaxComponentNameParam} */ static createTaxComponentName(): CreateTaxComponentNameParam; /** @returns {CreateTaxVersionParam} */ static createTaxVersion(): CreateTaxVersionParam; /** @returns {DeleteBulkInventoryJobParam} */ static deleteBulkInventoryJob(): DeleteBulkInventoryJobParam; /** @returns {DeleteProductParam} */ static deleteProduct(): DeleteProductParam; /** @returns {DeleteProductBulkJobParam} */ static deleteProductBulkJob(): DeleteProductBulkJobParam; /** @returns {DeleteRealtimeInventoryParam} */ static deleteRealtimeInventory(): DeleteRealtimeInventoryParam; /** @returns {DeleteSizeParam} */ static deleteSize(): DeleteSizeParam; /** @returns {DeleteTaxRuleParam} */ static deleteTaxRule(): DeleteTaxRuleParam; /** @returns {DeleteTaxVersionParam} */ static deleteTaxVersion(): DeleteTaxVersionParam; /** @returns {DownloadInventoryTemplateViewParam} */ static downloadInventoryTemplateView(): DownloadInventoryTemplateViewParam; /** @returns {DownloadProductTemplateViewsParam} */ static downloadProductTemplateViews(): DownloadProductTemplateViewsParam; /** @returns {EditProductParam} */ static editProduct(): EditProductParam; /** @returns {ExportInventoryConfigParam} */ static exportInventoryConfig(): ExportInventoryConfigParam; /** @returns {GetAllProductHsnCodesParam} */ static getAllProductHsnCodes(): GetAllProductHsnCodesParam; /** @returns {GetAllTaxRulesParam} */ static getAllTaxRules(): GetAllTaxRulesParam; /** @returns {GetAttributeParam} */ static getAttribute(): GetAttributeParam; /** @returns {GetCategoryDataParam} */ static getCategoryData(): GetCategoryDataParam; /** @returns {GetCompanyBrandDetailParam} */ static getCompanyBrandDetail(): GetCompanyBrandDetailParam; /** @returns {GetCompanyDetailParam} */ static getCompanyDetail(): any; /** @returns {GetCompanyMetricsParam} */ static getCompanyMetrics(): any; /** @returns {GetDepartmentDataParam} */ static getDepartmentData(): GetDepartmentDataParam; /** @returns {GetHsCodesParam} */ static getHsCodes(): GetHsCodesParam; /** @returns {GetHsnCodeParam} */ static getHsnCode(): GetHsnCodeParam; /** @returns {GetInventoriesParam} */ static getInventories(): GetInventoriesParam; /** @returns {GetInventoryBulkUploadHistoryParam} */ static getInventoryBulkUploadHistory(): GetInventoryBulkUploadHistoryParam; /** @returns {GetInventoryBySizeParam} */ static getInventoryBySize(): GetInventoryBySizeParam; /** @returns {GetInventoryBySizeIdentifierParam} */ static getInventoryBySizeIdentifier(): GetInventoryBySizeIdentifierParam; /** @returns {GetInventoryExportParam} */ static getInventoryExport(): any; /** @returns {GetMarketplaceOptinDetailParam} */ static getMarketplaceOptinDetail(): any; /** @returns {GetMarketplacesParam} */ static getMarketplaces(): any; /** @returns {GetProductParam} */ static getProduct(): GetProductParam; /** @returns {GetProductAssetsInBulkParam} */ static getProductAssetsInBulk(): GetProductAssetsInBulkParam; /** @returns {GetProductAttributesParam} */ static getProductAttributes(): GetProductAttributesParam; /** @returns {GetProductBulkUploadHistoryParam} */ static getProductBulkUploadHistory(): GetProductBulkUploadHistoryParam; /** @returns {GetProductExportJobsParam} */ static getProductExportJobs(): GetProductExportJobsParam; /** @returns {GetProductSizeParam} */ static getProductSize(): GetProductSizeParam; /** @returns {GetProductTagsParam} */ static getProductTags(): any; /** @returns {GetProductValidationParam} */ static getProductValidation(): any; /** @returns {GetProductsParam} */ static getProducts(): GetProductsParam; /** @returns {GetSellerInsightsParam} */ static getSellerInsights(): GetSellerInsightsParam; /** @returns {GetSingleProductHSNCodeParam} */ static getSingleProductHSNCode(): GetSingleProductHSNCodeParam; /** @returns {GetSizeGuideParam} */ static getSizeGuide(): GetSizeGuideParam; /** @returns {GetSizeGuidesParam} */ static getSizeGuides(): GetSizeGuidesParam; /** @returns {GetStoreDetailParam} */ static getStoreDetail(): GetStoreDetailParam; /** @returns {GetTaxComponentNamesParam} */ static getTaxComponentNames(): any; /** @returns {GetTaxVersionDetailsParam} */ static getTaxVersionDetails(): GetTaxVersionDetailsParam; /** @returns {GetVariantsOfProductsParam} */ static getVariantsOfProducts(): GetVariantsOfProductsParam; /** @returns {ListCategoriesParam} */ static listCategories(): ListCategoriesParam; /** @returns {ListDepartmentsDataParam} */ static listDepartmentsData(): ListDepartmentsDataParam; /** @returns {ListHSNCodesParam} */ static listHSNCodes(): any; /** @returns {ListInventoryExportParam} */ static listInventoryExport(): ListInventoryExportParam; /** @returns {ListProductTemplateParam} */ static listProductTemplate(): ListProductTemplateParam; /** @returns {ListProductTemplateCategoriesParam} */ static listProductTemplateCategories(): ListProductTemplateCategoriesParam; /** @returns {ListProductTemplateExportDetailsParam} */ static listProductTemplateExportDetails(): any; /** @returns {ListTemplateBrandTypeValuesParam} */ static listTemplateBrandTypeValues(): ListTemplateBrandTypeValuesParam; /** @returns {PartialUpdateProductParam} */ static partialUpdateProduct(): PartialUpdateProductParam; /** @returns {UpdateHsnCodeParam} */ static updateHsnCode(): UpdateHsnCodeParam; /** @returns {UpdateInventoriesParam} */ static updateInventories(): UpdateInventoriesParam; /** @returns {UpdateLocationPriceParam} */ static updateLocationPrice(): UpdateLocationPriceParam; /** @returns {UpdateLocationQuantityParam} */ static updateLocationQuantity(): UpdateLocationQuantityParam; /** @returns {UpdateMarketplaceOptinParam} */ static updateMarketplaceOptin(): UpdateMarketplaceOptinParam; /** @returns {UpdateRealtimeInventoryParam} */ static updateRealtimeInventory(): UpdateRealtimeInventoryParam; /** @returns {UpdateSizeGuideParam} */ static updateSizeGuide(): UpdateSizeGuideParam; /** @returns {UpdateTaxRuleParam} */ static updateTaxRule(): UpdateTaxRuleParam; /** @returns {UpdateTaxVersionParam} */ static updateTaxVersion(): UpdateTaxVersionParam; /** @returns {ValidateProductGlobalTemplateParam} */ static validateProductGlobalTemplate(): ValidateProductGlobalTemplateParam; /** @returns {ValidateProductTemplateParam} */ static validateProductTemplate(): ValidateProductTemplateParam; /** @returns {ValidateProductTemplateSchemaParam} */ static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam; } declare namespace CatalogPlatformValidator { export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateHsCodeParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, CreateTaxParam, CreateTaxComponentNameParam, CreateTaxVersionParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DeleteTaxRuleParam, DeleteTaxVersionParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetAllTaxRulesParam, GetAttributeParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetHsCodesParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetTaxComponentNamesParam, GetTaxVersionDetailsParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, PartialUpdateProductParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateLocationPriceParam, UpdateLocationQuantityParam, UpdateMarketplaceOptinParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UpdateTaxRuleParam, UpdateTaxVersionParam, ValidateProductGlobalTemplateParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam }; } type AddInventoryParam = { /** * - Item id of the product of which size is to be get. */ itemId: number; /** * - Size in which inventory is to be added. */ size: string; body: CatalogPlatformModel.InventoryRequestSchema; }; type AllSizesParam = { /** * - Id of the product to be updated. */ itemId: number; }; type BulkHsnCodeParam = { body: CatalogPlatformModel.BulkHsnUpsert; }; type CreateBulkInventoryParam = { /** * - Batch Id of the bulk create job. */ batchId: string; body: CatalogPlatformModel.InventoryBulkRequestSchema; }; type CreateBulkInventoryJobParam = { body: CatalogPlatformModel.BulkInventoryJob; }; type CreateBulkProductUploadJobParam = { body: CatalogPlatformModel.BulkJob; }; type CreateHsCodeParam = { body: CatalogPlatformModel.HSCodeItem; }; type CreateInventoryExportParam = { body: CatalogPlatformModel.InventoryCreateRequestSchema; }; type CreateInventoryExportJobParam = { body: CatalogPlatformModel.InventoryExportRequestSchema; }; type CreateMarketplaceOptinParam = { /** * - The marketplace for which the detail * needs to be retrieved. */ marketplaceSlug: string; body: CatalogPlatformModel.OptInPostRequestSchema; }; type CreateProductParam = { body: CatalogPlatformModel.ProductCreateSchemaV3; }; type CreateProductAssetsInBulkParam = { body: CatalogPlatformModel.ProductBulkAssets; }; type CreateProductExportJobParam = { body: CatalogPlatformModel.ProductTemplateDownloadsExport; }; type CreateProductsInBulkParam = { /** * - Batch Id in which assets to be uploaded. */ batchId: string; body: CatalogPlatformModel.BulkProductRequestSchema; }; type CreateSizeGuideParam = { body: CatalogPlatformModel.ValidateSizeGuide; }; type CreateTaxParam = { body: CatalogPlatformModel.CreateTaxRequestBody; }; type CreateTaxComponentNameParam = { body: CatalogPlatformModel.CreateTaxComponentNameRequestSchema; }; type CreateTaxVersionParam = { /** * - Unique identifier of the tax rule */ ruleId: string; body: CatalogPlatformModel.CreateTaxVersionRequestBody; }; type DeleteBulkInventoryJobParam = { /** * - Batch Id of the bulk delete job. */ batchId: string; }; type DeleteProductParam = { /** * - Id of the product to be deleted. */ itemId: number; }; type DeleteProductBulkJobParam = { /** * - Batch Id of the bulk product job to be deleted. */ batchId: number; }; type DeleteRealtimeInventoryParam = { /** * - Item code of the product of which size is to be get. */ itemId: number; /** * - Size Identifier (Seller Identifier or * Primary Identifier) of which inventory is to get. */ sellerIdentifier: string; body: CatalogPlatformModel.InventoryRequestSchemaV2; }; type DeleteSizeParam = { /** * - Item Id of the product associated with size to be deleted. */ itemId: number; /** * - Size to be deleted. */ size: string; }; type DeleteTaxRuleParam = { /** * - Unique identifier of the tax rule to be deleted */ ruleId: string; }; type DeleteTaxVersionParam = { /** * - Unique identifier of the tax rule to be deleted */ ruleId: string; /** * - Unique identifier of the tax version to be deleted */ versionId: string; }; type DownloadInventoryTemplateViewParam = { /** * - Specifies the type of template to download. * Either quantity or price */ schemaType: string; /** * - File extension type */ type: string; }; type DownloadProductTemplateViewsParam = { /** * - A `slug` is a unique identifier for a particular template. */ slug: string; /** * - An `item_type` defines the type of item. The * default value is standard. */ itemType?: string; /** * - Format type of the sample file. The default value is excel. */ type?: string; }; type EditProductParam = { /** * - Id of the product to be updated. */ itemId: number; body: CatalogPlatformModel.ProductUpdateSchemaV3; }; type ExportInventoryConfigParam = { /** * - Filter type from any one of ['brand', * 'store', 'type'] */ filterType?: string; }; type GetAllProductHsnCodesParam = { /** * - Indicates current page number */ pageNo?: number; /** * - Indicates page size */ pageSize?: number; /** * - Search using hsn code, description, reporting_hsn */ q?: string; /** * - Search using type */ type?: string; }; type GetAllTaxRulesParam = { /** * - Search query to filter tax rules */ q?: string; /** * - Filter tax rules based on their lifecycle status. */ statuses?: string; /** * - The page number to retrieve */ page?: number; /** * - Maximum number of tax rule items per page */ limit?: number; /** * - Filter tax rules to include only those * with versions in the specified status. */ versionStatus?: string; }; type GetAttributeParam = { /** * - Slug of the attribute for which you want * to view the details */ attributeSlug: string; }; type GetCategoryDataParam = { /** * - Category unique id */ uid: string; }; type GetCompanyBrandDetailParam = { /** * - The is_active status for the optin id. */ isActive?: boolean; /** * - The search value to filter the list. */ q?: string; /** * - The number of page for the company id. */ pageNo?: number; /** * - Number of records that can be seen on the * page for the company id. */ pageSize?: number; /** * - The marketplace platform associated with * the company id. */ marketplace?: string; }; type GetDepartmentDataParam = { /** * - A `uid` is a unique identifier of a department. */ uid: string; }; type GetHsCodesParam = { /** * - The page number for pagination. */ page?: number; /** * - The number of items to return per page. */ limit?: number; /** * - Filter by HS/SAC code type. */ type?: string; /** * - Search query to filter HS/SAC codes by code or description. */ q?: string; }; type GetHsnCodeParam = { /** * - Unique id */ id: string; }; type GetInventoriesParam = { /** * - Item code of the product of which size is to be get. */ itemId?: string; /** * - Size of which inventory is to get. */ size?: string; /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 12. */ pageSize?: number; /** * - Alphanumeric Page ID to retrieve next set of results. */ pageId?: string; /** * - Available pagination types are cursor or number. */ pageType?: string; /** * - Search with help of store code. */ q?: string; /** * - Filter on whether product is in stock or not. */ sellable?: boolean; /** * - The Store Id of products to fetch inventory. */ storeIds?: number[]; /** * - The Brand Id of products to fetch inventory. */ brandIds?: number[]; /** * - The Seller Identifier or Primary * Identifier of the inventory. */ sellerIdentifiers?: string[]; /** * - This field allows you to filter for inventories * that have quantity greater than to the specified value based on qty_type filter. */ qtyGt?: number; /** * - This field allows you to filter for inventories * that have a quantity less than to the specified value based on qty_type filter. */ qtyLt?: number; /** * - This field provides flexibility in selecting * filter for inventory quantity counts and date queries. For example, you * might use this field to specify "total" or "sellable" quantity. */ qtyType?: string; /** * - Inventory updated on filter to get * inventories greater then or equal to provided date based on qty_type value. */ fromDate?: string; /** * - Inventory updated on filter to get inventories * less then or equal to provided date based on qty_type value. */ toDate?: string; /** * - Size Identifier (Seller Identifier or * Primary Identifier) of which inventory is to get. */ sizeIdentifier?: string; }; type GetInventoryBulkUploadHistoryParam = { /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 12. */ pageSize?: number; /** * - Search string to filter the results by batch id */ search?: string; /** * - Filter results by the job's start date. */ startDate?: string; /** * - Filter results by the job's end date. */ endDate?: string; /** * - Filter results by the current stage of the import job. */ stage?: string; /** * - Filter results by the tags of the import job. */ tags?: string; }; type GetInventoryBySizeParam = { /** * - Item code of the product of which size is to be get. */ itemId: number; /** * - Size of which inventory is to get. */ size: string; /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 12. */ pageSize?: number; /** * - Search with help of store code. */ q?: string; /** * - Filter on whether product is in stock or not. */ sellable?: boolean; }; type GetInventoryBySizeIdentifierParam = { /** * - Item code of the product of which size is to be get. */ itemId: number; /** * - Size Identifier (Seller Identifier or * Primary Identifier) of which inventory is to get. */ sizeIdentifier: string; /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 12. */ pageSize?: number; /** * - Search with help of store code. */ q?: string; /** * - Search by store ids. */ locationIds?: number[]; }; type GetProductParam = { /** * - Item Id of the product. */ itemId: number; /** * - Brand Id of the product. */ brandUid?: number; /** * - Item code of the product. */ itemCode?: string; }; type GetProductAssetsInBulkParam = { /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 12. */ pageSize?: number; }; type GetProductAttributesParam = { /** * - It is the name of the l3 cateogry */ category: string; /** * - If true, returns filtered values, else returns * all the attributes */ filter?: boolean; }; type GetProductBulkUploadHistoryParam = { /** * - Search string to filter the results by batch id */ search?: string; /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 12. */ pageSize?: number; }; type GetProductExportJobsParam = { /** * - This is a parameter used to find all the jobs * with the specified status. */ status?: string; /** * - This is a parameter used to find the job from * the date specified to the current date. */ fromDate?: string; /** * - This is a parameter used to find the job from * the from_date specified to the to_date. */ toDate?: string; /** * - It is a query parameter to search the export job * with the task ID. */ q?: string; /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 12. */ pageSize?: number; }; type GetProductSizeParam = { /** * - Item code of the product size. */ itemCode?: string; /** * - Item Id of the product size. */ itemId: number; /** * - Brand Id of the product size. */ brandUid?: number; /** * - Id of the product size. */ uid?: number; }; type GetProductsParam = { /** * - Get multiple products filtered by Brand Ids */ brandIds?: number[]; /** * - Get multiple products filtered by Category Ids */ categoryIds?: number[]; /** * - Get multiple products filtered by Item Ids */ itemIds?: number[]; /** * - Get multiple products filtered by Department Ids */ departmentIds?: number[]; /** * - Get multiple products filtered by Item Code */ itemCode?: string[]; /** * - Get multiple products filtered by Name (Pattern Match) */ name?: string; /** * - Get multiple products filtered by Slug */ slug?: string; /** * - Get multiple products filtered by All * Identifiers */ allIdentifiers?: string[]; /** * - Get multiple products filtered by q string */ q?: string; /** * - Get multiple products filtered by tags */ tags?: string[]; /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 10. */ pageSize?: number; /** * - For pagination type value can be cursor or * number. Default is number. */ pageType?: string; /** * - Field which is to be used for sorting, default * is latest. Value can be latest (modified_on) or created (record id) */ sortOn?: string; /** * - If page_type is cursor, each response will * contain **next_id** param (datetime or id depending upon sort_on), which * should be sent back as page_id to make cursor pagination work. */ pageId?: string; }; type GetSellerInsightsParam = { /** * - Id of the seller application which is * serving the invetory/catalog of the company */ sellerAppId: string; }; type GetSingleProductHSNCodeParam = { /** * - Reporting_hsn */ reportingHsn: string; }; type GetSizeGuideParam = { /** * - Id of the size guide to be viewed. */ id: string; }; type GetSizeGuidesParam = { /** * - Filter size guide on basis of active, in-active */ active?: boolean; /** * - Query that is to be searched. */ q?: string; /** * - To filter size guide on basis of tag. */ tag?: string; /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 10. */ pageSize?: number; /** * - Brand id that is to be searched. */ brandId?: number; }; type GetStoreDetailParam = { /** * - The search related the store for the company id. */ q?: string; /** * - The number of page for the company id. */ pageNo?: number; /** * - Number of records that can be seen on the * page for the company id. */ pageSize?: number; }; type GetTaxVersionDetailsParam = { /** * - Unique identifier of the tax rule */ ruleId: string; /** * - Filter by tax version status */ versionStatus?: string; /** * - Case-insensitive search by region name (e.g., * "john", "New York") to find matching tax versions */ q?: string; /** * - The number of items to return per page for * paginated past versions */ limit?: string; /** * - The page number for paginated past versions. */ page?: string; }; type GetVariantsOfProductsParam = { /** * - Get list of variants of item Id */ itemId: number; /** * - Get multiple products filtered by variant type */ variantType: string; /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 10. */ pageSize?: number; }; type ListCategoriesParam = { /** * - Get category for multiple levels */ level?: number[]; /** * - Get category for multiple departments filtered */ department?: number; /** * - Get multiple categories filtered by search string */ q?: string; /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 10. */ pageSize?: number; /** * - Get multiple categories filtered by category uids. */ uids?: number[]; /** * - Get category by slug */ slug?: string; }; type ListDepartmentsDataParam = { /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - A `item_type` is a type of product eg. set, * standard, digital */ itemType?: string; /** * - Number of items to retrieve in each page. * Default is 10. */ pageSize?: number; /** * - Can search departments by passing name. */ name?: string; /** * - Can search departments by passing name of the * department in search parameter. */ search?: string; /** * - Can query for departments based on whether * they are active or inactive. */ isActive?: boolean; /** * - Can filter by slug */ slug?: string; }; type ListInventoryExportParam = { /** * - Status of the export job.(Pending, Running, Success) */ status?: string; /** * - Inventory export history filtered according * to from_date. */ fromDate?: string; /** * - Inventory export history filtered according to from_date. */ toDate?: string; /** * - Inventory export history filtered according to task ID. */ q?: string; /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 12. */ pageSize?: number; }; type ListProductTemplateParam = { /** * - A `department` is the name of a particular department. */ department: string; /** * - The page number to navigate through the given * set of results */ pageNo?: number; /** * - Number of items to retrieve in each page. * Default is 12. */ pageSize?: number; }; type ListProductTemplateCategoriesParam = { /** * - A `department` is name of a departments * whose category needs to be listed. Can specify multiple departments. */ departments: string; /** * - An `item_type` is the type of item, it can be * `set`, `standard`, `digital`, etc. */ itemType: string; }; type ListTemplateBrandTypeValuesParam = { /** * - A `filter` is the unique identifier of the type * of value required. */ filter: string; /** * - A `template_tag` is the identifier of the * type of template required. */ templateTag?: string; /** * - A `item_type` is the identifier of the type * of template required. */ itemType?: string; }; type PartialUpdateProductParam = { /** * - Item ID of the product to be patched. */ itemId: number; body: CatalogPlatformModel.ProductPatchSchemaV3; }; type UpdateHsnCodeParam = { /** * - Unique id */ id: string; body: CatalogPlatformModel.HsnUpsert; }; type UpdateInventoriesParam = { body: CatalogPlatformModel.InventoryRequestSchemaV2; }; type UpdateLocationPriceParam = { /** * - The Store Id to update price of size for specific store. */ storeId: number; /** * - Size Identifier (Seller Identifier or * Primary Identifier) of which article price is to update. */ sellerIdentifier: string; body: CatalogPlatformModel.LocationPriceRequestSchema; }; type UpdateLocationQuantityParam = { /** * - The Store Id to update quantity of size for * specific store. */ storeId: number; /** * - Size Identifier (Seller Identifier or * Primary Identifier) of which article quantity is to update. */ sellerIdentifier: string; body: CatalogPlatformModel.LocationQuantityRequestSchema; }; type UpdateMarketplaceOptinParam = { /** * - Slug of the marketplace. */ marketplaceSlug: string; body: CatalogPlatformModel.UpdateMarketplaceOptinRequestSchema; }; type UpdateRealtimeInventoryParam = { /** * - Item code of the product of which size is to be get. */ itemId: number; /** * - Size Identifier (Seller Identifier or * Primary Identifier) of which inventory is to get. */ sellerIdentifier: string; body: CatalogPlatformModel.InventoryRequestSchemaV2; }; type UpdateSizeGuideParam = { /** * - Identifier of the size guide to be edited */ id: string; body: CatalogPlatformModel.ValidateSizeGuide; }; type UpdateTaxRuleParam = { /** * - Unique identifier of the tax rule to update */ ruleId: string; body: CatalogPlatformModel.UpdateTaxRequestBody; }; type UpdateTaxVersionParam = { /** * - Unique identifier of the tax rule to be updated */ ruleId: string; /** * - Unique identifier of the tax version to be updated */ versionId: string; body: CatalogPlatformModel.UpdateTaxVersionRequestBody; }; type ValidateProductGlobalTemplateParam = { /** * - An `item_type` defines the type of item. The * default value is standard. */ itemType?: string; /** * - This specification determines the schema type to * be retrieved. When set to true, it will return the schema for bulk data; * when set to false, it will provide the schema for a single product. The * default value is false. */ bulk?: boolean; }; type ValidateProductTemplateParam = { /** * - A `slug` is a unique identifier for a particular template. */ slug: string; /** * - An `item_type` defines the type of item. The * default value is standard. */ itemType?: string; /** * - This specification determines the schema type to * be retrieved. When set to true, it will return the schema for bulk data; * when set to false, it will provide the schema for a single product. The * default value is false. */ bulk?: boolean; }; type ValidateProductTemplateSchemaParam = { /** * - An `item_type` defines the type of item. The * default value is standard. */ itemType: string; /** * - Schema of price or quantity template */ schemaType?: string; }; type GetCompanyDetailParam = any; type GetCompanyMetricsParam = any; type GetInventoryExportParam = any; type GetMarketplaceOptinDetailParam = any; type GetMarketplacesParam = any; type GetProductTagsParam = any; type GetProductValidationParam = any; type GetTaxComponentNamesParam = any; type ListHSNCodesParam = any; type ListProductTemplateExportDetailsParam = any; import CatalogPlatformModel = require("./CatalogPlatformModel");