@sp-api-sdk/catalog-items-api-2022-04-01 3.2.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api-model/api/{catalog-api.js → catalog-items-api.js} +26 -26
- package/dist/cjs/api-model/api.js +1 -1
- package/dist/cjs/client.js +1 -1
- package/dist/es/api-model/api/{catalog-api.js → catalog-items-api.js} +21 -21
- package/dist/es/api-model/api.js +1 -1
- package/dist/es/client.js +2 -2
- package/dist/types/api-model/api/{catalog-api.d.ts → catalog-items-api.d.ts} +41 -41
- package/dist/types/api-model/api.d.ts +1 -1
- package/dist/types/client.d.ts +2 -2
- package/package.json +4 -4
|
@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
16
16
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
17
|
};
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.SearchCatalogItemsIncludedDataEnum = exports.SearchCatalogItemsIdentifiersTypeEnum = exports.GetCatalogItemIncludedDataEnum = exports.
|
|
19
|
+
exports.SearchCatalogItemsIncludedDataEnum = exports.SearchCatalogItemsIdentifiersTypeEnum = exports.GetCatalogItemIncludedDataEnum = exports.CatalogItemsApi = exports.CatalogItemsApiFactory = exports.CatalogItemsApiFp = exports.CatalogItemsApiAxiosParamCreator = void 0;
|
|
20
20
|
const axios_1 = __importDefault(require("axios"));
|
|
21
21
|
// Some imports not used depending on template conditions
|
|
22
22
|
// @ts-ignore
|
|
@@ -24,10 +24,10 @@ const common_1 = require("../common");
|
|
|
24
24
|
// @ts-ignore
|
|
25
25
|
const base_1 = require("../base");
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* CatalogItemsApi - axios parameter creator
|
|
28
28
|
* @export
|
|
29
29
|
*/
|
|
30
|
-
const
|
|
30
|
+
const CatalogItemsApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
33
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
@@ -147,13 +147,13 @@ const CatalogApiAxiosParamCreator = function (configuration) {
|
|
|
147
147
|
},
|
|
148
148
|
};
|
|
149
149
|
};
|
|
150
|
-
exports.
|
|
150
|
+
exports.CatalogItemsApiAxiosParamCreator = CatalogItemsApiAxiosParamCreator;
|
|
151
151
|
/**
|
|
152
|
-
*
|
|
152
|
+
* CatalogItemsApi - functional programming interface
|
|
153
153
|
* @export
|
|
154
154
|
*/
|
|
155
|
-
const
|
|
156
|
-
const localVarAxiosParamCreator = (0, exports.
|
|
155
|
+
const CatalogItemsApiFp = function (configuration) {
|
|
156
|
+
const localVarAxiosParamCreator = (0, exports.CatalogItemsApiAxiosParamCreator)(configuration);
|
|
157
157
|
return {
|
|
158
158
|
/**
|
|
159
159
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
@@ -167,7 +167,7 @@ const CatalogApiFp = function (configuration) {
|
|
|
167
167
|
async getCatalogItem(asin, marketplaceIds, includedData, locale, options) {
|
|
168
168
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getCatalogItem(asin, marketplaceIds, includedData, locale, options);
|
|
169
169
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
170
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
170
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['CatalogItemsApi.getCatalogItem']?.[localVarOperationServerIndex]?.url;
|
|
171
171
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
172
172
|
},
|
|
173
173
|
/**
|
|
@@ -190,22 +190,22 @@ const CatalogApiFp = function (configuration) {
|
|
|
190
190
|
async searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options) {
|
|
191
191
|
const localVarAxiosArgs = await localVarAxiosParamCreator.searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options);
|
|
192
192
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
193
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
193
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['CatalogItemsApi.searchCatalogItems']?.[localVarOperationServerIndex]?.url;
|
|
194
194
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
195
195
|
},
|
|
196
196
|
};
|
|
197
197
|
};
|
|
198
|
-
exports.
|
|
198
|
+
exports.CatalogItemsApiFp = CatalogItemsApiFp;
|
|
199
199
|
/**
|
|
200
|
-
*
|
|
200
|
+
* CatalogItemsApi - factory interface
|
|
201
201
|
* @export
|
|
202
202
|
*/
|
|
203
|
-
const
|
|
204
|
-
const localVarFp = (0, exports.
|
|
203
|
+
const CatalogItemsApiFactory = function (configuration, basePath, axios) {
|
|
204
|
+
const localVarFp = (0, exports.CatalogItemsApiFp)(configuration);
|
|
205
205
|
return {
|
|
206
206
|
/**
|
|
207
207
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
208
|
-
* @param {
|
|
208
|
+
* @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
|
|
209
209
|
* @param {*} [options] Override http request option.
|
|
210
210
|
* @throws {RequiredError}
|
|
211
211
|
*/
|
|
@@ -214,7 +214,7 @@ const CatalogApiFactory = function (configuration, basePath, axios) {
|
|
|
214
214
|
},
|
|
215
215
|
/**
|
|
216
216
|
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
217
|
-
* @param {
|
|
217
|
+
* @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
|
|
218
218
|
* @param {*} [options] Override http request option.
|
|
219
219
|
* @throws {RequiredError}
|
|
220
220
|
*/
|
|
@@ -223,36 +223,36 @@ const CatalogApiFactory = function (configuration, basePath, axios) {
|
|
|
223
223
|
},
|
|
224
224
|
};
|
|
225
225
|
};
|
|
226
|
-
exports.
|
|
226
|
+
exports.CatalogItemsApiFactory = CatalogItemsApiFactory;
|
|
227
227
|
/**
|
|
228
|
-
*
|
|
228
|
+
* CatalogItemsApi - object-oriented interface
|
|
229
229
|
* @export
|
|
230
|
-
* @class
|
|
230
|
+
* @class CatalogItemsApi
|
|
231
231
|
* @extends {BaseAPI}
|
|
232
232
|
*/
|
|
233
|
-
class
|
|
233
|
+
class CatalogItemsApi extends base_1.BaseAPI {
|
|
234
234
|
/**
|
|
235
235
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
236
|
-
* @param {
|
|
236
|
+
* @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
|
|
237
237
|
* @param {*} [options] Override http request option.
|
|
238
238
|
* @throws {RequiredError}
|
|
239
|
-
* @memberof
|
|
239
|
+
* @memberof CatalogItemsApi
|
|
240
240
|
*/
|
|
241
241
|
getCatalogItem(requestParameters, options) {
|
|
242
|
-
return (0, exports.
|
|
242
|
+
return (0, exports.CatalogItemsApiFp)(this.configuration).getCatalogItem(requestParameters.asin, requestParameters.marketplaceIds, requestParameters.includedData, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
|
|
243
243
|
}
|
|
244
244
|
/**
|
|
245
245
|
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
246
|
-
* @param {
|
|
246
|
+
* @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
|
|
247
247
|
* @param {*} [options] Override http request option.
|
|
248
248
|
* @throws {RequiredError}
|
|
249
|
-
* @memberof
|
|
249
|
+
* @memberof CatalogItemsApi
|
|
250
250
|
*/
|
|
251
251
|
searchCatalogItems(requestParameters, options) {
|
|
252
|
-
return (0, exports.
|
|
252
|
+
return (0, exports.CatalogItemsApiFp)(this.configuration).searchCatalogItems(requestParameters.marketplaceIds, requestParameters.identifiers, requestParameters.identifiersType, requestParameters.includedData, requestParameters.locale, requestParameters.sellerId, requestParameters.keywords, requestParameters.brandNames, requestParameters.classificationIds, requestParameters.pageSize, requestParameters.pageToken, requestParameters.keywordsLocale, options).then((request) => request(this.axios, this.basePath));
|
|
253
253
|
}
|
|
254
254
|
}
|
|
255
|
-
exports.
|
|
255
|
+
exports.CatalogItemsApi = CatalogItemsApi;
|
|
256
256
|
/**
|
|
257
257
|
* @export
|
|
258
258
|
*/
|
|
@@ -27,4 +27,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
27
27
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
28
28
|
};
|
|
29
29
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
30
|
-
__exportStar(require("./api/catalog-api"), exports);
|
|
30
|
+
__exportStar(require("./api/catalog-items-api"), exports);
|
package/dist/cjs/client.js
CHANGED
|
@@ -19,7 +19,7 @@ exports.clientRateLimits = [
|
|
|
19
19
|
burst: 5,
|
|
20
20
|
},
|
|
21
21
|
];
|
|
22
|
-
class CatalogItemsApiClient extends api_model_1.
|
|
22
|
+
class CatalogItemsApiClient extends api_model_1.CatalogItemsApi {
|
|
23
23
|
constructor(configuration) {
|
|
24
24
|
const { axios, endpoint } = (0, common_1.createAxiosInstance)(configuration, exports.clientRateLimits);
|
|
25
25
|
super(new api_model_1.Configuration(), endpoint, axios);
|
|
@@ -18,10 +18,10 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, creat
|
|
|
18
18
|
// @ts-ignore
|
|
19
19
|
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* CatalogItemsApi - axios parameter creator
|
|
22
22
|
* @export
|
|
23
23
|
*/
|
|
24
|
-
export const
|
|
24
|
+
export const CatalogItemsApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
27
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
@@ -142,11 +142,11 @@ export const CatalogApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
};
|
|
143
143
|
};
|
|
144
144
|
/**
|
|
145
|
-
*
|
|
145
|
+
* CatalogItemsApi - functional programming interface
|
|
146
146
|
* @export
|
|
147
147
|
*/
|
|
148
|
-
export const
|
|
149
|
-
const localVarAxiosParamCreator =
|
|
148
|
+
export const CatalogItemsApiFp = function (configuration) {
|
|
149
|
+
const localVarAxiosParamCreator = CatalogItemsApiAxiosParamCreator(configuration);
|
|
150
150
|
return {
|
|
151
151
|
/**
|
|
152
152
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
@@ -160,7 +160,7 @@ export const CatalogApiFp = function (configuration) {
|
|
|
160
160
|
async getCatalogItem(asin, marketplaceIds, includedData, locale, options) {
|
|
161
161
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getCatalogItem(asin, marketplaceIds, includedData, locale, options);
|
|
162
162
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
163
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
163
|
+
const localVarOperationServerBasePath = operationServerMap['CatalogItemsApi.getCatalogItem']?.[localVarOperationServerIndex]?.url;
|
|
164
164
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
165
165
|
},
|
|
166
166
|
/**
|
|
@@ -183,21 +183,21 @@ export const CatalogApiFp = function (configuration) {
|
|
|
183
183
|
async searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options) {
|
|
184
184
|
const localVarAxiosArgs = await localVarAxiosParamCreator.searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options);
|
|
185
185
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
186
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
186
|
+
const localVarOperationServerBasePath = operationServerMap['CatalogItemsApi.searchCatalogItems']?.[localVarOperationServerIndex]?.url;
|
|
187
187
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
188
188
|
},
|
|
189
189
|
};
|
|
190
190
|
};
|
|
191
191
|
/**
|
|
192
|
-
*
|
|
192
|
+
* CatalogItemsApi - factory interface
|
|
193
193
|
* @export
|
|
194
194
|
*/
|
|
195
|
-
export const
|
|
196
|
-
const localVarFp =
|
|
195
|
+
export const CatalogItemsApiFactory = function (configuration, basePath, axios) {
|
|
196
|
+
const localVarFp = CatalogItemsApiFp(configuration);
|
|
197
197
|
return {
|
|
198
198
|
/**
|
|
199
199
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
200
|
-
* @param {
|
|
200
|
+
* @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
|
|
201
201
|
* @param {*} [options] Override http request option.
|
|
202
202
|
* @throws {RequiredError}
|
|
203
203
|
*/
|
|
@@ -206,7 +206,7 @@ export const CatalogApiFactory = function (configuration, basePath, axios) {
|
|
|
206
206
|
},
|
|
207
207
|
/**
|
|
208
208
|
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
209
|
-
* @param {
|
|
209
|
+
* @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
|
|
210
210
|
* @param {*} [options] Override http request option.
|
|
211
211
|
* @throws {RequiredError}
|
|
212
212
|
*/
|
|
@@ -216,31 +216,31 @@ export const CatalogApiFactory = function (configuration, basePath, axios) {
|
|
|
216
216
|
};
|
|
217
217
|
};
|
|
218
218
|
/**
|
|
219
|
-
*
|
|
219
|
+
* CatalogItemsApi - object-oriented interface
|
|
220
220
|
* @export
|
|
221
|
-
* @class
|
|
221
|
+
* @class CatalogItemsApi
|
|
222
222
|
* @extends {BaseAPI}
|
|
223
223
|
*/
|
|
224
|
-
export class
|
|
224
|
+
export class CatalogItemsApi extends BaseAPI {
|
|
225
225
|
/**
|
|
226
226
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
227
|
-
* @param {
|
|
227
|
+
* @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
|
|
228
228
|
* @param {*} [options] Override http request option.
|
|
229
229
|
* @throws {RequiredError}
|
|
230
|
-
* @memberof
|
|
230
|
+
* @memberof CatalogItemsApi
|
|
231
231
|
*/
|
|
232
232
|
getCatalogItem(requestParameters, options) {
|
|
233
|
-
return
|
|
233
|
+
return CatalogItemsApiFp(this.configuration).getCatalogItem(requestParameters.asin, requestParameters.marketplaceIds, requestParameters.includedData, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
|
|
234
234
|
}
|
|
235
235
|
/**
|
|
236
236
|
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
237
|
-
* @param {
|
|
237
|
+
* @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
240
|
-
* @memberof
|
|
240
|
+
* @memberof CatalogItemsApi
|
|
241
241
|
*/
|
|
242
242
|
searchCatalogItems(requestParameters, options) {
|
|
243
|
-
return
|
|
243
|
+
return CatalogItemsApiFp(this.configuration).searchCatalogItems(requestParameters.marketplaceIds, requestParameters.identifiers, requestParameters.identifiersType, requestParameters.includedData, requestParameters.locale, requestParameters.sellerId, requestParameters.keywords, requestParameters.brandNames, requestParameters.classificationIds, requestParameters.pageSize, requestParameters.pageToken, requestParameters.keywordsLocale, options).then((request) => request(this.axios, this.basePath));
|
|
244
244
|
}
|
|
245
245
|
}
|
|
246
246
|
/**
|
package/dist/es/api-model/api.js
CHANGED
package/dist/es/client.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { createAxiosInstance } from '@sp-api-sdk/common';
|
|
2
|
-
import {
|
|
2
|
+
import { CatalogItemsApi, Configuration } from './api-model';
|
|
3
3
|
export const clientRateLimits = [
|
|
4
4
|
{
|
|
5
5
|
method: 'get',
|
|
@@ -16,7 +16,7 @@ export const clientRateLimits = [
|
|
|
16
16
|
burst: 5,
|
|
17
17
|
},
|
|
18
18
|
];
|
|
19
|
-
export class CatalogItemsApiClient extends
|
|
19
|
+
export class CatalogItemsApiClient extends CatalogItemsApi {
|
|
20
20
|
constructor(configuration) {
|
|
21
21
|
const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
|
|
22
22
|
super(new Configuration(), endpoint, axios);
|
|
@@ -16,10 +16,10 @@ import { type RequestArgs, BaseAPI } from '../base';
|
|
|
16
16
|
import type { Item } from '../models';
|
|
17
17
|
import type { ItemSearchResults } from '../models';
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* CatalogItemsApi - axios parameter creator
|
|
20
20
|
* @export
|
|
21
21
|
*/
|
|
22
|
-
export declare const
|
|
22
|
+
export declare const CatalogItemsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
23
|
/**
|
|
24
24
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
25
25
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
@@ -50,10 +50,10 @@ export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration
|
|
|
50
50
|
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>;
|
|
51
51
|
};
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
53
|
+
* CatalogItemsApi - functional programming interface
|
|
54
54
|
* @export
|
|
55
55
|
*/
|
|
56
|
-
export declare const
|
|
56
|
+
export declare const CatalogItemsApiFp: (configuration?: Configuration) => {
|
|
57
57
|
/**
|
|
58
58
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
59
59
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
@@ -84,158 +84,158 @@ export declare const CatalogApiFp: (configuration?: Configuration) => {
|
|
|
84
84
|
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>>;
|
|
85
85
|
};
|
|
86
86
|
/**
|
|
87
|
-
*
|
|
87
|
+
* CatalogItemsApi - factory interface
|
|
88
88
|
* @export
|
|
89
89
|
*/
|
|
90
|
-
export declare const
|
|
90
|
+
export declare const CatalogItemsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
91
91
|
/**
|
|
92
92
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
93
|
-
* @param {
|
|
93
|
+
* @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
|
|
94
94
|
* @param {*} [options] Override http request option.
|
|
95
95
|
* @throws {RequiredError}
|
|
96
96
|
*/
|
|
97
|
-
getCatalogItem(requestParameters:
|
|
97
|
+
getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<Item>;
|
|
98
98
|
/**
|
|
99
99
|
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
100
|
-
* @param {
|
|
100
|
+
* @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
|
|
101
101
|
* @param {*} [options] Override http request option.
|
|
102
102
|
* @throws {RequiredError}
|
|
103
103
|
*/
|
|
104
|
-
searchCatalogItems(requestParameters:
|
|
104
|
+
searchCatalogItems(requestParameters: CatalogItemsApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemSearchResults>;
|
|
105
105
|
};
|
|
106
106
|
/**
|
|
107
|
-
* Request parameters for getCatalogItem operation in
|
|
107
|
+
* Request parameters for getCatalogItem operation in CatalogItemsApi.
|
|
108
108
|
* @export
|
|
109
|
-
* @interface
|
|
109
|
+
* @interface CatalogItemsApiGetCatalogItemRequest
|
|
110
110
|
*/
|
|
111
|
-
export interface
|
|
111
|
+
export interface CatalogItemsApiGetCatalogItemRequest {
|
|
112
112
|
/**
|
|
113
113
|
* The Amazon Standard Identification Number (ASIN) of the item.
|
|
114
114
|
* @type {string}
|
|
115
|
-
* @memberof
|
|
115
|
+
* @memberof CatalogItemsApiGetCatalogItem
|
|
116
116
|
*/
|
|
117
117
|
readonly asin: string;
|
|
118
118
|
/**
|
|
119
119
|
* A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
120
120
|
* @type {Array<string>}
|
|
121
|
-
* @memberof
|
|
121
|
+
* @memberof CatalogItemsApiGetCatalogItem
|
|
122
122
|
*/
|
|
123
123
|
readonly marketplaceIds: Array<string>;
|
|
124
124
|
/**
|
|
125
125
|
* A comma-delimited list of datasets to include in the response.
|
|
126
126
|
* @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>}
|
|
127
|
-
* @memberof
|
|
127
|
+
* @memberof CatalogItemsApiGetCatalogItem
|
|
128
128
|
*/
|
|
129
129
|
readonly includedData?: Array<GetCatalogItemIncludedDataEnum>;
|
|
130
130
|
/**
|
|
131
131
|
* The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
|
|
132
132
|
* @type {string}
|
|
133
|
-
* @memberof
|
|
133
|
+
* @memberof CatalogItemsApiGetCatalogItem
|
|
134
134
|
*/
|
|
135
135
|
readonly locale?: string;
|
|
136
136
|
}
|
|
137
137
|
/**
|
|
138
|
-
* Request parameters for searchCatalogItems operation in
|
|
138
|
+
* Request parameters for searchCatalogItems operation in CatalogItemsApi.
|
|
139
139
|
* @export
|
|
140
|
-
* @interface
|
|
140
|
+
* @interface CatalogItemsApiSearchCatalogItemsRequest
|
|
141
141
|
*/
|
|
142
|
-
export interface
|
|
142
|
+
export interface CatalogItemsApiSearchCatalogItemsRequest {
|
|
143
143
|
/**
|
|
144
144
|
* A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
145
145
|
* @type {Array<string>}
|
|
146
|
-
* @memberof
|
|
146
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
147
147
|
*/
|
|
148
148
|
readonly marketplaceIds: Array<string>;
|
|
149
149
|
/**
|
|
150
150
|
* A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include `identifiers` and `keywords` in the same request.
|
|
151
151
|
* @type {Array<string>}
|
|
152
|
-
* @memberof
|
|
152
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
153
153
|
*/
|
|
154
154
|
readonly identifiers?: Array<string>;
|
|
155
155
|
/**
|
|
156
156
|
* The type of product identifiers that you can use to search the Amazon catalog. **Note:** `identifiersType` is required when `identifiers` is in the request.
|
|
157
157
|
* @type {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'}
|
|
158
|
-
* @memberof
|
|
158
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
159
159
|
*/
|
|
160
160
|
readonly identifiersType?: SearchCatalogItemsIdentifiersTypeEnum;
|
|
161
161
|
/**
|
|
162
162
|
* A comma-delimited list of datasets to include in the response.
|
|
163
163
|
* @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>}
|
|
164
|
-
* @memberof
|
|
164
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
165
165
|
*/
|
|
166
166
|
readonly includedData?: Array<SearchCatalogItemsIncludedDataEnum>;
|
|
167
167
|
/**
|
|
168
168
|
* The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
|
|
169
169
|
* @type {string}
|
|
170
|
-
* @memberof
|
|
170
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
171
171
|
*/
|
|
172
172
|
readonly locale?: string;
|
|
173
173
|
/**
|
|
174
174
|
* A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`.
|
|
175
175
|
* @type {string}
|
|
176
|
-
* @memberof
|
|
176
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
177
177
|
*/
|
|
178
178
|
readonly sellerId?: string;
|
|
179
179
|
/**
|
|
180
180
|
* A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include `keywords` and `identifiers` in the same request.
|
|
181
181
|
* @type {Array<string>}
|
|
182
|
-
* @memberof
|
|
182
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
183
183
|
*/
|
|
184
184
|
readonly keywords?: Array<string>;
|
|
185
185
|
/**
|
|
186
186
|
* A comma-delimited list of brand names that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
|
|
187
187
|
* @type {Array<string>}
|
|
188
|
-
* @memberof
|
|
188
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
189
189
|
*/
|
|
190
190
|
readonly brandNames?: Array<string>;
|
|
191
191
|
/**
|
|
192
192
|
* A comma-delimited list of classification identifiers that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
|
|
193
193
|
* @type {Array<string>}
|
|
194
|
-
* @memberof
|
|
194
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
195
195
|
*/
|
|
196
196
|
readonly classificationIds?: Array<string>;
|
|
197
197
|
/**
|
|
198
198
|
* The number of results to include on each page.
|
|
199
199
|
* @type {number}
|
|
200
|
-
* @memberof
|
|
200
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
201
201
|
*/
|
|
202
202
|
readonly pageSize?: number;
|
|
203
203
|
/**
|
|
204
204
|
* A token that you can use to fetch a specific page when there are multiple pages of results.
|
|
205
205
|
* @type {string}
|
|
206
|
-
* @memberof
|
|
206
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
207
207
|
*/
|
|
208
208
|
readonly pageToken?: string;
|
|
209
209
|
/**
|
|
210
210
|
* The language of the keywords that are included in queries based on `keywords`. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`.
|
|
211
211
|
* @type {string}
|
|
212
|
-
* @memberof
|
|
212
|
+
* @memberof CatalogItemsApiSearchCatalogItems
|
|
213
213
|
*/
|
|
214
214
|
readonly keywordsLocale?: string;
|
|
215
215
|
}
|
|
216
216
|
/**
|
|
217
|
-
*
|
|
217
|
+
* CatalogItemsApi - object-oriented interface
|
|
218
218
|
* @export
|
|
219
|
-
* @class
|
|
219
|
+
* @class CatalogItemsApi
|
|
220
220
|
* @extends {BaseAPI}
|
|
221
221
|
*/
|
|
222
|
-
export declare class
|
|
222
|
+
export declare class CatalogItemsApi extends BaseAPI {
|
|
223
223
|
/**
|
|
224
224
|
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
225
|
-
* @param {
|
|
225
|
+
* @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
|
|
226
226
|
* @param {*} [options] Override http request option.
|
|
227
227
|
* @throws {RequiredError}
|
|
228
|
-
* @memberof
|
|
228
|
+
* @memberof CatalogItemsApi
|
|
229
229
|
*/
|
|
230
|
-
getCatalogItem(requestParameters:
|
|
230
|
+
getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Item, any>>;
|
|
231
231
|
/**
|
|
232
232
|
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
233
|
-
* @param {
|
|
233
|
+
* @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
|
|
234
234
|
* @param {*} [options] Override http request option.
|
|
235
235
|
* @throws {RequiredError}
|
|
236
|
-
* @memberof
|
|
236
|
+
* @memberof CatalogItemsApi
|
|
237
237
|
*/
|
|
238
|
-
searchCatalogItems(requestParameters:
|
|
238
|
+
searchCatalogItems(requestParameters: CatalogItemsApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ItemSearchResults, any>>;
|
|
239
239
|
}
|
|
240
240
|
/**
|
|
241
241
|
* @export
|
package/dist/types/client.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
|
|
2
|
-
import {
|
|
2
|
+
import { CatalogItemsApi } from './api-model';
|
|
3
3
|
export declare const clientRateLimits: RateLimit[];
|
|
4
|
-
export declare class CatalogItemsApiClient extends
|
|
4
|
+
export declare class CatalogItemsApiClient extends CatalogItemsApi {
|
|
5
5
|
constructor(configuration: ClientConfiguration);
|
|
6
6
|
}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/catalog-items-api-2022-04-01",
|
|
3
3
|
"author": "Bertrand Marron <bertrand@bizon.solutions>",
|
|
4
4
|
"description": "Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the Catalog Items API Use Case Guide.",
|
|
5
|
-
"version": "
|
|
5
|
+
"version": "4.0.0",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"dist/**/*.d.ts"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@sp-api-sdk/common": "2.1.
|
|
22
|
-
"axios": "^1.
|
|
21
|
+
"@sp-api-sdk/common": "2.1.14",
|
|
22
|
+
"axios": "^1.9.0"
|
|
23
23
|
},
|
|
24
24
|
"repository": {
|
|
25
25
|
"type": "git",
|
|
@@ -40,5 +40,5 @@
|
|
|
40
40
|
"sp sdk",
|
|
41
41
|
"catalog items api"
|
|
42
42
|
],
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "773f45c3f4aab28e0bd9f6033045988800d7f258"
|
|
44
44
|
}
|