@sp-api-sdk/catalog-items-api-2022-04-01
Advanced tools
Comparing version 2.0.7 to 2.1.0
@@ -19,3 +19,3 @@ "use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.CatalogApi = exports.CatalogApiFactory = exports.CatalogApiFp = exports.CatalogApiAxiosParamCreator = void 0; | ||
exports.SearchCatalogItemsIncludedDataEnum = exports.SearchCatalogItemsIdentifiersTypeEnum = exports.GetCatalogItemIncludedDataEnum = exports.CatalogApi = exports.CatalogApiFactory = exports.CatalogApiFp = exports.CatalogApiAxiosParamCreator = void 0; | ||
const axios_1 = __importDefault(require("axios")); | ||
@@ -37,3 +37,3 @@ // Some imports not used depending on template conditions | ||
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -80,4 +80,4 @@ * @param {*} [options] Override http request option. | ||
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. | ||
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -165,3 +165,3 @@ * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. | ||
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -173,3 +173,5 @@ * @param {*} [options] Override http request option. | ||
const localVarAxiosArgs = await localVarAxiosParamCreator.getCatalogItem(asin, marketplaceIds, includedData, locale, options); | ||
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration); | ||
const localVarOperationServerIndex = configuration?.serverIndex ?? 0; | ||
const localVarOperationServerBasePath = base_1.operationServerMap['CatalogApi.getCatalogItem']?.[localVarOperationServerIndex]?.url; | ||
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); | ||
}, | ||
@@ -180,4 +182,4 @@ /** | ||
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. | ||
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -196,3 +198,5 @@ * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. | ||
const localVarAxiosArgs = await localVarAxiosParamCreator.searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options); | ||
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration); | ||
const localVarOperationServerIndex = configuration?.serverIndex ?? 0; | ||
const localVarOperationServerBasePath = base_1.operationServerMap['CatalogApi.searchCatalogItems']?.[localVarOperationServerIndex]?.url; | ||
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); | ||
}, | ||
@@ -259,1 +263,42 @@ }; | ||
exports.CatalogApi = CatalogApi; | ||
/** | ||
* @export | ||
*/ | ||
exports.GetCatalogItemIncludedDataEnum = { | ||
Attributes: 'attributes', | ||
Dimensions: 'dimensions', | ||
Identifiers: 'identifiers', | ||
Images: 'images', | ||
ProductTypes: 'productTypes', | ||
Relationships: 'relationships', | ||
SalesRanks: 'salesRanks', | ||
Summaries: 'summaries', | ||
VendorDetails: 'vendorDetails' | ||
}; | ||
/** | ||
* @export | ||
*/ | ||
exports.SearchCatalogItemsIdentifiersTypeEnum = { | ||
Asin: 'ASIN', | ||
Ean: 'EAN', | ||
Gtin: 'GTIN', | ||
Isbn: 'ISBN', | ||
Jan: 'JAN', | ||
Minsan: 'MINSAN', | ||
Sku: 'SKU', | ||
Upc: 'UPC' | ||
}; | ||
/** | ||
* @export | ||
*/ | ||
exports.SearchCatalogItemsIncludedDataEnum = { | ||
Attributes: 'attributes', | ||
Dimensions: 'dimensions', | ||
Identifiers: 'identifiers', | ||
Images: 'images', | ||
ProductTypes: 'productTypes', | ||
Relationships: 'relationships', | ||
SalesRanks: 'salesRanks', | ||
Summaries: 'summaries', | ||
VendorDetails: 'vendorDetails' | ||
}; |
@@ -19,3 +19,3 @@ "use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0; | ||
exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0; | ||
const axios_1 = __importDefault(require("axios")); | ||
@@ -47,3 +47,3 @@ exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, ""); | ||
this.configuration = configuration; | ||
this.basePath = configuration.basePath || this.basePath; | ||
this.basePath = configuration.basePath ?? basePath; | ||
} | ||
@@ -69,1 +69,6 @@ } | ||
exports.RequiredError = RequiredError; | ||
/** | ||
* | ||
* @export | ||
*/ | ||
exports.operationServerMap = {}; |
@@ -141,3 +141,3 @@ "use strict"; | ||
return (axios = globalAxios, basePath = BASE_PATH) => { | ||
const axiosRequestArgs = { ...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url }; | ||
const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url }; | ||
return axios.request(axiosRequestArgs); | ||
@@ -144,0 +144,0 @@ }; |
@@ -53,2 +53,9 @@ "use strict"; | ||
/** | ||
* override server index | ||
* | ||
* @type {number} | ||
* @memberof Configuration | ||
*/ | ||
serverIndex; | ||
/** | ||
* base options for axios calls | ||
@@ -74,2 +81,3 @@ * | ||
this.basePath = param.basePath; | ||
this.serverIndex = param.serverIndex; | ||
this.baseOptions = param.baseOptions; | ||
@@ -76,0 +84,0 @@ this.formDataCtor = param.formDataCtor; |
@@ -19,3 +19,3 @@ /* tslint:disable */ | ||
// @ts-ignore | ||
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base'; | ||
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base'; | ||
/** | ||
@@ -31,3 +31,3 @@ * CatalogApi - axios parameter creator | ||
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -74,4 +74,4 @@ * @param {*} [options] Override http request option. | ||
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. | ||
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -158,3 +158,3 @@ * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. | ||
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -166,3 +166,5 @@ * @param {*} [options] Override http request option. | ||
const localVarAxiosArgs = await localVarAxiosParamCreator.getCatalogItem(asin, marketplaceIds, includedData, locale, options); | ||
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); | ||
const localVarOperationServerIndex = configuration?.serverIndex ?? 0; | ||
const localVarOperationServerBasePath = operationServerMap['CatalogApi.getCatalogItem']?.[localVarOperationServerIndex]?.url; | ||
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); | ||
}, | ||
@@ -173,4 +175,4 @@ /** | ||
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. | ||
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -189,3 +191,5 @@ * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. | ||
const localVarAxiosArgs = await localVarAxiosParamCreator.searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options); | ||
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); | ||
const localVarOperationServerIndex = configuration?.serverIndex ?? 0; | ||
const localVarOperationServerBasePath = operationServerMap['CatalogApi.searchCatalogItems']?.[localVarOperationServerIndex]?.url; | ||
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); | ||
}, | ||
@@ -249,1 +253,42 @@ }; | ||
} | ||
/** | ||
* @export | ||
*/ | ||
export const GetCatalogItemIncludedDataEnum = { | ||
Attributes: 'attributes', | ||
Dimensions: 'dimensions', | ||
Identifiers: 'identifiers', | ||
Images: 'images', | ||
ProductTypes: 'productTypes', | ||
Relationships: 'relationships', | ||
SalesRanks: 'salesRanks', | ||
Summaries: 'summaries', | ||
VendorDetails: 'vendorDetails' | ||
}; | ||
/** | ||
* @export | ||
*/ | ||
export const SearchCatalogItemsIdentifiersTypeEnum = { | ||
Asin: 'ASIN', | ||
Ean: 'EAN', | ||
Gtin: 'GTIN', | ||
Isbn: 'ISBN', | ||
Jan: 'JAN', | ||
Minsan: 'MINSAN', | ||
Sku: 'SKU', | ||
Upc: 'UPC' | ||
}; | ||
/** | ||
* @export | ||
*/ | ||
export const SearchCatalogItemsIncludedDataEnum = { | ||
Attributes: 'attributes', | ||
Dimensions: 'dimensions', | ||
Identifiers: 'identifiers', | ||
Images: 'images', | ||
ProductTypes: 'productTypes', | ||
Relationships: 'relationships', | ||
SalesRanks: 'salesRanks', | ||
Summaries: 'summaries', | ||
VendorDetails: 'vendorDetails' | ||
}; |
@@ -40,3 +40,3 @@ /* tslint:disable */ | ||
this.configuration = configuration; | ||
this.basePath = configuration.basePath || this.basePath; | ||
this.basePath = configuration.basePath ?? basePath; | ||
} | ||
@@ -60,1 +60,6 @@ } | ||
} | ||
/** | ||
* | ||
* @export | ||
*/ | ||
export const operationServerMap = {}; |
@@ -130,5 +130,5 @@ /* tslint:disable */ | ||
return (axios = globalAxios, basePath = BASE_PATH) => { | ||
const axiosRequestArgs = { ...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url }; | ||
const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url }; | ||
return axios.request(axiosRequestArgs); | ||
}; | ||
}; |
@@ -50,2 +50,9 @@ /* tslint:disable */ | ||
/** | ||
* override server index | ||
* | ||
* @type {number} | ||
* @memberof Configuration | ||
*/ | ||
serverIndex; | ||
/** | ||
* base options for axios calls | ||
@@ -71,2 +78,3 @@ * | ||
this.basePath = param.basePath; | ||
this.serverIndex = param.serverIndex; | ||
this.baseOptions = param.baseOptions; | ||
@@ -73,0 +81,0 @@ this.formDataCtor = param.formDataCtor; |
@@ -13,7 +13,7 @@ /** | ||
import type { Configuration } from '../configuration'; | ||
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; | ||
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; | ||
import globalAxios from 'axios'; | ||
import { RequestArgs, BaseAPI } from '../base'; | ||
import { Item } from '../models'; | ||
import { ItemSearchResults } from '../models'; | ||
import { type RequestArgs, BaseAPI } from '../base'; | ||
import type { Item } from '../models'; | ||
import type { ItemSearchResults } from '../models'; | ||
/** | ||
@@ -28,3 +28,3 @@ * CatalogApi - axios parameter creator | ||
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -34,3 +34,3 @@ * @param {*} [options] Override http request option. | ||
*/ | ||
getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; | ||
getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; | ||
/** | ||
@@ -40,4 +40,4 @@ * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). | ||
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. | ||
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -54,3 +54,3 @@ * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. | ||
*/ | ||
searchCatalogItems: (marketplaceIds: Array<string>, identifiers?: Array<string>, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; | ||
searchCatalogItems: (marketplaceIds: Array<string>, identifiers?: Array<string>, identifiersType?: SearchCatalogItemsIdentifiersTypeEnum, includedData?: Array<SearchCatalogItemsIncludedDataEnum>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; | ||
}; | ||
@@ -66,3 +66,3 @@ /** | ||
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -72,3 +72,3 @@ * @param {*} [options] Override http request option. | ||
*/ | ||
getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>; | ||
getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>; | ||
/** | ||
@@ -78,4 +78,4 @@ * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). | ||
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. | ||
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. | ||
* @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
* @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
@@ -92,3 +92,3 @@ * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. | ||
*/ | ||
searchCatalogItems(marketplaceIds: Array<string>, identifiers?: Array<string>, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemSearchResults>>; | ||
searchCatalogItems(marketplaceIds: Array<string>, identifiers?: Array<string>, identifiersType?: SearchCatalogItemsIdentifiersTypeEnum, includedData?: Array<SearchCatalogItemsIncludedDataEnum>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemSearchResults>>; | ||
}; | ||
@@ -106,3 +106,3 @@ /** | ||
*/ | ||
getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: AxiosRequestConfig): AxiosPromise<Item>; | ||
getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<Item>; | ||
/** | ||
@@ -114,3 +114,3 @@ * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). | ||
*/ | ||
searchCatalogItems(requestParameters: CatalogApiSearchCatalogItemsRequest, options?: AxiosRequestConfig): AxiosPromise<ItemSearchResults>; | ||
searchCatalogItems(requestParameters: CatalogApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemSearchResults>; | ||
}; | ||
@@ -140,3 +140,3 @@ /** | ||
*/ | ||
readonly includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>; | ||
readonly includedData?: Array<GetCatalogItemIncludedDataEnum>; | ||
/** | ||
@@ -172,3 +172,3 @@ * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
*/ | ||
readonly identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'; | ||
readonly identifiersType?: SearchCatalogItemsIdentifiersTypeEnum; | ||
/** | ||
@@ -179,3 +179,3 @@ * A comma-delimited list of data sets to include in the response. Default: `summaries`. | ||
*/ | ||
readonly includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>; | ||
readonly includedData?: Array<SearchCatalogItemsIncludedDataEnum>; | ||
/** | ||
@@ -244,3 +244,3 @@ * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | ||
*/ | ||
getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<Item, any>>; | ||
getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Item, any>>; | ||
/** | ||
@@ -253,3 +253,47 @@ * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). | ||
*/ | ||
searchCatalogItems(requestParameters: CatalogApiSearchCatalogItemsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ItemSearchResults, any>>; | ||
searchCatalogItems(requestParameters: CatalogApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ItemSearchResults, any>>; | ||
} | ||
/** | ||
* @export | ||
*/ | ||
export declare const GetCatalogItemIncludedDataEnum: { | ||
readonly Attributes: "attributes"; | ||
readonly Dimensions: "dimensions"; | ||
readonly Identifiers: "identifiers"; | ||
readonly Images: "images"; | ||
readonly ProductTypes: "productTypes"; | ||
readonly Relationships: "relationships"; | ||
readonly SalesRanks: "salesRanks"; | ||
readonly Summaries: "summaries"; | ||
readonly VendorDetails: "vendorDetails"; | ||
}; | ||
export type GetCatalogItemIncludedDataEnum = typeof GetCatalogItemIncludedDataEnum[keyof typeof GetCatalogItemIncludedDataEnum]; | ||
/** | ||
* @export | ||
*/ | ||
export declare const SearchCatalogItemsIdentifiersTypeEnum: { | ||
readonly Asin: "ASIN"; | ||
readonly Ean: "EAN"; | ||
readonly Gtin: "GTIN"; | ||
readonly Isbn: "ISBN"; | ||
readonly Jan: "JAN"; | ||
readonly Minsan: "MINSAN"; | ||
readonly Sku: "SKU"; | ||
readonly Upc: "UPC"; | ||
}; | ||
export type SearchCatalogItemsIdentifiersTypeEnum = typeof SearchCatalogItemsIdentifiersTypeEnum[keyof typeof SearchCatalogItemsIdentifiersTypeEnum]; | ||
/** | ||
* @export | ||
*/ | ||
export declare const SearchCatalogItemsIncludedDataEnum: { | ||
readonly Attributes: "attributes"; | ||
readonly Dimensions: "dimensions"; | ||
readonly Identifiers: "identifiers"; | ||
readonly Images: "images"; | ||
readonly ProductTypes: "productTypes"; | ||
readonly Relationships: "relationships"; | ||
readonly SalesRanks: "salesRanks"; | ||
readonly Summaries: "summaries"; | ||
readonly VendorDetails: "vendorDetails"; | ||
}; | ||
export type SearchCatalogItemsIncludedDataEnum = typeof SearchCatalogItemsIncludedDataEnum[keyof typeof SearchCatalogItemsIncludedDataEnum]; |
@@ -13,3 +13,3 @@ /** | ||
import type { Configuration } from './configuration'; | ||
import type { AxiosInstance, AxiosRequestConfig } from 'axios'; | ||
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios'; | ||
export declare const BASE_PATH: string; | ||
@@ -33,3 +33,3 @@ /** | ||
url: string; | ||
options: AxiosRequestConfig; | ||
options: RawAxiosRequestConfig; | ||
} | ||
@@ -57,1 +57,13 @@ /** | ||
} | ||
interface ServerMap { | ||
[key: string]: { | ||
url: string; | ||
description: string; | ||
}[]; | ||
} | ||
/** | ||
* | ||
* @export | ||
*/ | ||
export declare const operationServerMap: ServerMap; | ||
export {}; |
@@ -18,2 +18,3 @@ /** | ||
basePath?: string; | ||
serverIndex?: number; | ||
baseOptions?: any; | ||
@@ -58,2 +59,9 @@ formDataCtor?: new () => any; | ||
/** | ||
* override server index | ||
* | ||
* @type {number} | ||
* @memberof Configuration | ||
*/ | ||
serverIndex?: number; | ||
/** | ||
* base options for axios calls | ||
@@ -60,0 +68,0 @@ * |
@@ -12,3 +12,3 @@ /** | ||
*/ | ||
import { Dimension } from './dimension'; | ||
import type { Dimension } from './dimension'; | ||
/** | ||
@@ -15,0 +15,0 @@ * Dimensions of an Amazon catalog item or item in its packaging. |
@@ -12,3 +12,3 @@ /** | ||
*/ | ||
import { ItemContributorRole } from './item-contributor-role'; | ||
import type { ItemContributorRole } from './item-contributor-role'; | ||
/** | ||
@@ -15,0 +15,0 @@ * Individual contributor to the creation of an item, such as an author or actor. |
@@ -12,3 +12,3 @@ /** | ||
*/ | ||
import { Dimensions } from './dimensions'; | ||
import type { Dimensions } from './dimensions'; | ||
/** | ||
@@ -15,0 +15,0 @@ * Dimensions associated with the item in the Amazon catalog for the indicated Amazon marketplace. |
@@ -12,3 +12,3 @@ /** | ||
*/ | ||
import { ItemIdentifier } from './item-identifier'; | ||
import type { ItemIdentifier } from './item-identifier'; | ||
/** | ||
@@ -15,0 +15,0 @@ * Identifiers associated with the item in the Amazon catalog for the indicated Amazon marketplace. |
@@ -12,3 +12,3 @@ /** | ||
*/ | ||
import { ItemImage } from './item-image'; | ||
import type { ItemImage } from './item-image'; | ||
/** | ||
@@ -15,0 +15,0 @@ * Images for an item in the Amazon catalog for the indicated Amazon marketplace. |
@@ -12,3 +12,3 @@ /** | ||
*/ | ||
import { ItemVariationTheme } from './item-variation-theme'; | ||
import type { ItemVariationTheme } from './item-variation-theme'; | ||
/** | ||
@@ -15,0 +15,0 @@ * Relationship details for an Amazon catalog item. |
@@ -12,3 +12,3 @@ /** | ||
*/ | ||
import { ItemRelationship } from './item-relationship'; | ||
import type { ItemRelationship } from './item-relationship'; | ||
/** | ||
@@ -15,0 +15,0 @@ * Relationship details for the Amazon catalog item for the indicated Amazon marketplace. |
@@ -12,4 +12,4 @@ /** | ||
*/ | ||
import { ItemClassificationSalesRank } from './item-classification-sales-rank'; | ||
import { ItemDisplayGroupSalesRank } from './item-display-group-sales-rank'; | ||
import type { ItemClassificationSalesRank } from './item-classification-sales-rank'; | ||
import type { ItemDisplayGroupSalesRank } from './item-display-group-sales-rank'; | ||
/** | ||
@@ -16,0 +16,0 @@ * Sales ranks of an Amazon catalog item for the indicated Amazon marketplace. |
@@ -12,5 +12,5 @@ /** | ||
*/ | ||
import { Item } from './item'; | ||
import { Pagination } from './pagination'; | ||
import { Refinements } from './refinements'; | ||
import type { Item } from './item'; | ||
import type { Pagination } from './pagination'; | ||
import type { Refinements } from './refinements'; | ||
/** | ||
@@ -17,0 +17,0 @@ * Items in the Amazon catalog and search related metadata. |
@@ -12,4 +12,4 @@ /** | ||
*/ | ||
import { ItemBrowseClassification } from './item-browse-classification'; | ||
import { ItemContributor } from './item-contributor'; | ||
import type { ItemBrowseClassification } from './item-browse-classification'; | ||
import type { ItemContributor } from './item-contributor'; | ||
/** | ||
@@ -16,0 +16,0 @@ * Summary details of an Amazon catalog item for the indicated Amazon marketplace. |
@@ -12,3 +12,3 @@ /** | ||
*/ | ||
import { ItemVendorDetailsCategory } from './item-vendor-details-category'; | ||
import type { ItemVendorDetailsCategory } from './item-vendor-details-category'; | ||
/** | ||
@@ -15,0 +15,0 @@ * Vendor details associated with an Amazon catalog item for the indicated Amazon marketplace. |
@@ -12,10 +12,10 @@ /** | ||
*/ | ||
import { ItemDimensionsByMarketplace } from './item-dimensions-by-marketplace'; | ||
import { ItemIdentifiersByMarketplace } from './item-identifiers-by-marketplace'; | ||
import { ItemImagesByMarketplace } from './item-images-by-marketplace'; | ||
import { ItemProductTypeByMarketplace } from './item-product-type-by-marketplace'; | ||
import { ItemRelationshipsByMarketplace } from './item-relationships-by-marketplace'; | ||
import { ItemSalesRanksByMarketplace } from './item-sales-ranks-by-marketplace'; | ||
import { ItemSummaryByMarketplace } from './item-summary-by-marketplace'; | ||
import { ItemVendorDetailsByMarketplace } from './item-vendor-details-by-marketplace'; | ||
import type { ItemDimensionsByMarketplace } from './item-dimensions-by-marketplace'; | ||
import type { ItemIdentifiersByMarketplace } from './item-identifiers-by-marketplace'; | ||
import type { ItemImagesByMarketplace } from './item-images-by-marketplace'; | ||
import type { ItemProductTypeByMarketplace } from './item-product-type-by-marketplace'; | ||
import type { ItemRelationshipsByMarketplace } from './item-relationships-by-marketplace'; | ||
import type { ItemSalesRanksByMarketplace } from './item-sales-ranks-by-marketplace'; | ||
import type { ItemSummaryByMarketplace } from './item-summary-by-marketplace'; | ||
import type { ItemVendorDetailsByMarketplace } from './item-vendor-details-by-marketplace'; | ||
/** | ||
@@ -35,6 +35,8 @@ * An item in the Amazon catalog. | ||
* A JSON object that contains structured item attribute data keyed by attribute name. Catalog item attributes conform to the related product type definitions available in the Selling Partner API for Product Type Definitions. | ||
* @type {object} | ||
* @type {{ [key: string]: any; }} | ||
* @memberof Item | ||
*/ | ||
'attributes'?: object; | ||
'attributes'?: { | ||
[key: string]: any; | ||
}; | ||
/** | ||
@@ -41,0 +43,0 @@ * Array of dimensions associated with the item in the Amazon catalog by Amazon marketplace. |
@@ -12,4 +12,4 @@ /** | ||
*/ | ||
import { BrandRefinement } from './brand-refinement'; | ||
import { ClassificationRefinement } from './classification-refinement'; | ||
import type { BrandRefinement } from './brand-refinement'; | ||
import type { ClassificationRefinement } from './classification-refinement'; | ||
/** | ||
@@ -16,0 +16,0 @@ * Search refinements. |
@@ -5,3 +5,3 @@ { | ||
"description": "The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the Catalog Items API Use Case Guide.", | ||
"version": "2.0.7", | ||
"version": "2.1.0", | ||
"main": "dist/cjs/index.js", | ||
@@ -22,4 +22,4 @@ "module": "dist/es/index.js", | ||
"dependencies": { | ||
"@sp-api-sdk/common": "2.0.7", | ||
"axios": "^1.6.8" | ||
"@sp-api-sdk/common": "2.0.8", | ||
"axios": "^1.7.0" | ||
}, | ||
@@ -45,3 +45,3 @@ "repository": { | ||
], | ||
"gitHead": "556cf5234c43b36ddaffa12f795a925b1c7fc63b" | ||
"gitHead": "5a245a25a9f1765c825e2178668d4b0f4e44689b" | ||
} |
192943
4116
+ Added@sp-api-sdk/auth@2.0.8(transitive)
+ Added@sp-api-sdk/common@2.0.8(transitive)
- Removed@sp-api-sdk/auth@2.0.7(transitive)
- Removed@sp-api-sdk/common@2.0.7(transitive)
Updated@sp-api-sdk/common@2.0.8
Updatedaxios@^1.7.0