@sp-api-sdk/catalog-items-api-v0 4.0.17 → 5.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.
Files changed (44) hide show
  1. package/README.md +4 -4
  2. package/dist/index.cjs +310 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +276 -0
  5. package/dist/index.d.ts +276 -0
  6. package/dist/index.js +268 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +23 -12
  9. package/dist/cjs/api-model/api/catalog-items-api.js +0 -128
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/categories.js +0 -15
  16. package/dist/cjs/api-model/models/index.js +0 -19
  17. package/dist/cjs/api-model/models/list-catalog-categories-response.js +0 -15
  18. package/dist/cjs/api-model/models/model-error.js +0 -15
  19. package/dist/cjs/client.js +0 -21
  20. package/dist/cjs/index.js +0 -18
  21. package/dist/es/api-model/api/catalog-items-api.js +0 -118
  22. package/dist/es/api-model/api.js +0 -14
  23. package/dist/es/api-model/base.js +0 -44
  24. package/dist/es/api-model/common.js +0 -110
  25. package/dist/es/api-model/configuration.js +0 -94
  26. package/dist/es/api-model/index.js +0 -16
  27. package/dist/es/api-model/models/categories.js +0 -14
  28. package/dist/es/api-model/models/index.js +0 -3
  29. package/dist/es/api-model/models/list-catalog-categories-response.js +0 -14
  30. package/dist/es/api-model/models/model-error.js +0 -14
  31. package/dist/es/client.js +0 -17
  32. package/dist/es/index.js +0 -2
  33. package/dist/types/api-model/api/catalog-items-api.d.ts +0 -85
  34. package/dist/types/api-model/api.d.ts +0 -12
  35. package/dist/types/api-model/base.d.ts +0 -42
  36. package/dist/types/api-model/common.d.ts +0 -34
  37. package/dist/types/api-model/configuration.d.ts +0 -98
  38. package/dist/types/api-model/index.d.ts +0 -14
  39. package/dist/types/api-model/models/categories.d.ts +0 -25
  40. package/dist/types/api-model/models/index.d.ts +0 -3
  41. package/dist/types/api-model/models/list-catalog-categories-response.d.ts +0 -19
  42. package/dist/types/api-model/models/model-error.d.ts +0 -28
  43. package/dist/types/client.d.ts +0 -6
  44. package/dist/types/index.d.ts +0 -3
@@ -1,118 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Catalog Items
5
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
6
- *
7
- * The version of the OpenAPI document: v0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- import globalAxios from 'axios';
15
- // Some imports not used depending on template conditions
16
- // @ts-ignore
17
- import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, createRequestFunction } from '../common';
18
- // @ts-ignore
19
- import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
20
- /**
21
- * CatalogItemsApi - axios parameter creator
22
- */
23
- export const CatalogItemsApiAxiosParamCreator = function (configuration) {
24
- return {
25
- /**
26
- * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 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 see higher rate and burst values than those shown here. For more information, see [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).
27
- * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item.
28
- * @param {string} [aSIN] The Amazon Standard Identification Number (ASIN) of the item.
29
- * @param {string} [sellerSKU] Used to identify items in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit.
30
- * @param {*} [options] Override http request option.
31
- * @throws {RequiredError}
32
- */
33
- listCatalogCategories: async (marketplaceId, aSIN, sellerSKU, options = {}) => {
34
- // verify required parameter 'marketplaceId' is not null or undefined
35
- assertParamExists('listCatalogCategories', 'marketplaceId', marketplaceId);
36
- const localVarPath = `/catalog/v0/categories`;
37
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
38
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
39
- let baseOptions;
40
- if (configuration) {
41
- baseOptions = configuration.baseOptions;
42
- }
43
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
44
- const localVarHeaderParameter = {};
45
- const localVarQueryParameter = {};
46
- if (marketplaceId !== undefined) {
47
- localVarQueryParameter['MarketplaceId'] = marketplaceId;
48
- }
49
- if (aSIN !== undefined) {
50
- localVarQueryParameter['ASIN'] = aSIN;
51
- }
52
- if (sellerSKU !== undefined) {
53
- localVarQueryParameter['SellerSKU'] = sellerSKU;
54
- }
55
- localVarHeaderParameter['Accept'] = 'application/json';
56
- setSearchParams(localVarUrlObj, localVarQueryParameter);
57
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
58
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
59
- return {
60
- url: toPathString(localVarUrlObj),
61
- options: localVarRequestOptions,
62
- };
63
- },
64
- };
65
- };
66
- /**
67
- * CatalogItemsApi - functional programming interface
68
- */
69
- export const CatalogItemsApiFp = function (configuration) {
70
- const localVarAxiosParamCreator = CatalogItemsApiAxiosParamCreator(configuration);
71
- return {
72
- /**
73
- * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 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 see higher rate and burst values than those shown here. For more information, see [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).
74
- * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item.
75
- * @param {string} [aSIN] The Amazon Standard Identification Number (ASIN) of the item.
76
- * @param {string} [sellerSKU] Used to identify items in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit.
77
- * @param {*} [options] Override http request option.
78
- * @throws {RequiredError}
79
- */
80
- async listCatalogCategories(marketplaceId, aSIN, sellerSKU, options) {
81
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCatalogCategories(marketplaceId, aSIN, sellerSKU, options);
82
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
83
- const localVarOperationServerBasePath = operationServerMap['CatalogItemsApi.listCatalogCategories']?.[localVarOperationServerIndex]?.url;
84
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
85
- },
86
- };
87
- };
88
- /**
89
- * CatalogItemsApi - factory interface
90
- */
91
- export const CatalogItemsApiFactory = function (configuration, basePath, axios) {
92
- const localVarFp = CatalogItemsApiFp(configuration);
93
- return {
94
- /**
95
- * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 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 see higher rate and burst values than those shown here. For more information, see [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).
96
- * @param {CatalogItemsApiListCatalogCategoriesRequest} requestParameters Request parameters.
97
- * @param {*} [options] Override http request option.
98
- * @throws {RequiredError}
99
- */
100
- listCatalogCategories(requestParameters, options) {
101
- return localVarFp.listCatalogCategories(requestParameters.marketplaceId, requestParameters.aSIN, requestParameters.sellerSKU, options).then((request) => request(axios, basePath));
102
- },
103
- };
104
- };
105
- /**
106
- * CatalogItemsApi - object-oriented interface
107
- */
108
- export class CatalogItemsApi extends BaseAPI {
109
- /**
110
- * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 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 see higher rate and burst values than those shown here. For more information, see [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).
111
- * @param {CatalogItemsApiListCatalogCategoriesRequest} requestParameters Request parameters.
112
- * @param {*} [options] Override http request option.
113
- * @throws {RequiredError}
114
- */
115
- listCatalogCategories(requestParameters, options) {
116
- return CatalogItemsApiFp(this.configuration).listCatalogCategories(requestParameters.marketplaceId, requestParameters.aSIN, requestParameters.sellerSKU, options).then((request) => request(this.axios, this.basePath));
117
- }
118
- }
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Catalog Items
5
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
6
- *
7
- * The version of the OpenAPI document: v0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export * from './api/catalog-items-api';
@@ -1,44 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Catalog Items
5
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
6
- *
7
- * The version of the OpenAPI document: v0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- import globalAxios from 'axios';
15
- export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
16
- export const COLLECTION_FORMATS = {
17
- csv: ",",
18
- ssv: " ",
19
- tsv: "\t",
20
- pipes: "|",
21
- };
22
- export class BaseAPI {
23
- basePath;
24
- axios;
25
- configuration;
26
- constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
27
- this.basePath = basePath;
28
- this.axios = axios;
29
- if (configuration) {
30
- this.configuration = configuration;
31
- this.basePath = configuration.basePath ?? basePath;
32
- }
33
- }
34
- }
35
- ;
36
- export class RequiredError extends Error {
37
- field;
38
- constructor(field, msg) {
39
- super(msg);
40
- this.field = field;
41
- this.name = "RequiredError";
42
- }
43
- }
44
- export const operationServerMap = {};
@@ -1,110 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Catalog Items
5
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
6
- *
7
- * The version of the OpenAPI document: v0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- import { RequiredError } from "./base";
15
- export const DUMMY_BASE_URL = 'https://example.com';
16
- /**
17
- *
18
- * @throws {RequiredError}
19
- */
20
- export const assertParamExists = function (functionName, paramName, paramValue) {
21
- if (paramValue === null || paramValue === undefined) {
22
- throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
23
- }
24
- };
25
- export const setApiKeyToObject = async function (object, keyParamName, configuration) {
26
- if (configuration && configuration.apiKey) {
27
- const localVarApiKeyValue = typeof configuration.apiKey === 'function'
28
- ? await configuration.apiKey(keyParamName)
29
- : await configuration.apiKey;
30
- object[keyParamName] = localVarApiKeyValue;
31
- }
32
- };
33
- export const setBasicAuthToObject = function (object, configuration) {
34
- if (configuration && (configuration.username || configuration.password)) {
35
- object["auth"] = { username: configuration.username, password: configuration.password };
36
- }
37
- };
38
- export const setBearerAuthToObject = async function (object, configuration) {
39
- if (configuration && configuration.accessToken) {
40
- const accessToken = typeof configuration.accessToken === 'function'
41
- ? await configuration.accessToken()
42
- : await configuration.accessToken;
43
- object["Authorization"] = "Bearer " + accessToken;
44
- }
45
- };
46
- export const setOAuthToObject = async function (object, name, scopes, configuration) {
47
- if (configuration && configuration.accessToken) {
48
- const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
49
- ? await configuration.accessToken(name, scopes)
50
- : await configuration.accessToken;
51
- object["Authorization"] = "Bearer " + localVarAccessTokenValue;
52
- }
53
- };
54
- function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
55
- if (parameter == null)
56
- return;
57
- if (typeof parameter === "object") {
58
- if (Array.isArray(parameter) || parameter instanceof Set) {
59
- parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
60
- }
61
- else {
62
- Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
63
- }
64
- }
65
- else {
66
- if (urlSearchParams.has(key)) {
67
- urlSearchParams.append(key, parameter);
68
- }
69
- else {
70
- urlSearchParams.set(key, parameter);
71
- }
72
- }
73
- }
74
- export const setSearchParams = function (url, ...objects) {
75
- const searchParams = new URLSearchParams(url.search);
76
- setFlattenedQueryParams(searchParams, objects);
77
- url.search = searchParams.toString();
78
- };
79
- /**
80
- * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
81
- * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
82
- * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
83
- */
84
- // @ts-ignore
85
- export const replaceWithSerializableTypeIfNeeded = function (key, value) {
86
- if (value instanceof Set) {
87
- return Array.from(value);
88
- }
89
- else {
90
- return value;
91
- }
92
- };
93
- export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
94
- const nonString = typeof value !== 'string';
95
- const needsSerialization = nonString && configuration && configuration.isJsonMime
96
- ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
97
- : nonString;
98
- return needsSerialization
99
- ? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
100
- : (value || "");
101
- };
102
- export const toPathString = function (url) {
103
- return url.pathname + url.search + url.hash;
104
- };
105
- export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
106
- return (axios = globalAxios, basePath = BASE_PATH) => {
107
- const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
108
- return axios.request(axiosRequestArgs);
109
- };
110
- };
@@ -1,94 +0,0 @@
1
- /* tslint:disable */
2
- /**
3
- * Selling Partner API for Catalog Items
4
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
5
- *
6
- * The version of the OpenAPI document: v0
7
- *
8
- *
9
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
10
- * https://openapi-generator.tech
11
- * Do not edit the class manually.
12
- */
13
- export class Configuration {
14
- /**
15
- * parameter for apiKey security
16
- * @param name security name
17
- */
18
- apiKey;
19
- /**
20
- * parameter for basic security
21
- */
22
- username;
23
- /**
24
- * parameter for basic security
25
- */
26
- password;
27
- /**
28
- * parameter for oauth2 security
29
- * @param name security name
30
- * @param scopes oauth2 scope
31
- */
32
- accessToken;
33
- /**
34
- * parameter for aws4 signature security
35
- * @param {Object} AWS4Signature - AWS4 Signature security
36
- * @param {string} options.region - aws region
37
- * @param {string} options.service - name of the service.
38
- * @param {string} credentials.accessKeyId - aws access key id
39
- * @param {string} credentials.secretAccessKey - aws access key
40
- * @param {string} credentials.sessionToken - aws session token
41
- * @memberof Configuration
42
- */
43
- awsv4;
44
- /**
45
- * override base path
46
- */
47
- basePath;
48
- /**
49
- * override server index
50
- */
51
- serverIndex;
52
- /**
53
- * base options for axios calls
54
- */
55
- baseOptions;
56
- /**
57
- * The FormData constructor that will be used to create multipart form data
58
- * requests. You can inject this here so that execution environments that
59
- * do not support the FormData class can still run the generated client.
60
- *
61
- * @type {new () => FormData}
62
- */
63
- formDataCtor;
64
- constructor(param = {}) {
65
- this.apiKey = param.apiKey;
66
- this.username = param.username;
67
- this.password = param.password;
68
- this.accessToken = param.accessToken;
69
- this.awsv4 = param.awsv4;
70
- this.basePath = param.basePath;
71
- this.serverIndex = param.serverIndex;
72
- this.baseOptions = {
73
- ...param.baseOptions,
74
- headers: {
75
- ...param.baseOptions?.headers,
76
- },
77
- };
78
- this.formDataCtor = param.formDataCtor;
79
- }
80
- /**
81
- * Check if the given MIME is a JSON MIME.
82
- * JSON MIME examples:
83
- * application/json
84
- * application/json; charset=UTF8
85
- * APPLICATION/JSON
86
- * application/vnd.company+json
87
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
88
- * @return True if the given MIME is JSON, false otherwise.
89
- */
90
- isJsonMime(mime) {
91
- const jsonMime = /^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$/i;
92
- return mime !== null && jsonMime.test(mime);
93
- }
94
- }
@@ -1,16 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Catalog Items
5
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
6
- *
7
- * The version of the OpenAPI document: v0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export * from "./api";
15
- export * from "./configuration";
16
- export * from "./models";
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Catalog Items
5
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
6
- *
7
- * The version of the OpenAPI document: v0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,3 +0,0 @@
1
- export * from './categories';
2
- export * from './list-catalog-categories-response';
3
- export * from './model-error';
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Catalog Items
5
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
6
- *
7
- * The version of the OpenAPI document: v0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Catalog Items
5
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
6
- *
7
- * The version of the OpenAPI document: v0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
package/dist/es/client.js DELETED
@@ -1,17 +0,0 @@
1
- import { createAxiosInstance } from '@sp-api-sdk/common';
2
- import { CatalogItemsApi, Configuration } from './api-model';
3
- export const clientRateLimits = [
4
- {
5
- method: 'get',
6
- // eslint-disable-next-line prefer-regex-literals
7
- urlRegex: new RegExp('^/catalog/v0/categories$'),
8
- rate: 1,
9
- burst: 2,
10
- },
11
- ];
12
- export class CatalogItemsApiClient extends CatalogItemsApi {
13
- constructor(configuration) {
14
- const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
15
- super(new Configuration(), endpoint, axios);
16
- }
17
- }
package/dist/es/index.js DELETED
@@ -1,2 +0,0 @@
1
- export * from './client';
2
- export * from './api-model/api';
@@ -1,85 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
4
- *
5
- * The version of the OpenAPI document: v0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from '../configuration';
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- import globalAxios from 'axios';
15
- import { type RequestArgs, BaseAPI } from '../base';
16
- import type { ListCatalogCategoriesResponse } from '../models';
17
- /**
18
- * CatalogItemsApi - axios parameter creator
19
- */
20
- export declare const CatalogItemsApiAxiosParamCreator: (configuration?: Configuration) => {
21
- /**
22
- * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 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 see higher rate and burst values than those shown here. For more information, see [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).
23
- * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item.
24
- * @param {string} [aSIN] The Amazon Standard Identification Number (ASIN) of the item.
25
- * @param {string} [sellerSKU] Used to identify items in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit.
26
- * @param {*} [options] Override http request option.
27
- * @throws {RequiredError}
28
- */
29
- listCatalogCategories: (marketplaceId: string, aSIN?: string, sellerSKU?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
30
- };
31
- /**
32
- * CatalogItemsApi - functional programming interface
33
- */
34
- export declare const CatalogItemsApiFp: (configuration?: Configuration) => {
35
- /**
36
- * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 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 see higher rate and burst values than those shown here. For more information, see [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).
37
- * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item.
38
- * @param {string} [aSIN] The Amazon Standard Identification Number (ASIN) of the item.
39
- * @param {string} [sellerSKU] Used to identify items in the given marketplace. SellerSKU is qualified by the seller\&#39;s SellerId, which is included with every operation that you submit.
40
- * @param {*} [options] Override http request option.
41
- * @throws {RequiredError}
42
- */
43
- listCatalogCategories(marketplaceId: string, aSIN?: string, sellerSKU?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCatalogCategoriesResponse>>;
44
- };
45
- /**
46
- * CatalogItemsApi - factory interface
47
- */
48
- export declare const CatalogItemsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
49
- /**
50
- * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 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 see higher rate and burst values than those shown here. For more information, see [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).
51
- * @param {CatalogItemsApiListCatalogCategoriesRequest} requestParameters Request parameters.
52
- * @param {*} [options] Override http request option.
53
- * @throws {RequiredError}
54
- */
55
- listCatalogCategories(requestParameters: CatalogItemsApiListCatalogCategoriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCatalogCategoriesResponse>;
56
- };
57
- /**
58
- * Request parameters for listCatalogCategories operation in CatalogItemsApi.
59
- */
60
- export interface CatalogItemsApiListCatalogCategoriesRequest {
61
- /**
62
- * A marketplace identifier. Specifies the marketplace for the item.
63
- */
64
- readonly marketplaceId: string;
65
- /**
66
- * The Amazon Standard Identification Number (ASIN) of the item.
67
- */
68
- readonly aSIN?: string;
69
- /**
70
- * Used to identify items in the given marketplace. SellerSKU is qualified by the seller\&#39;s SellerId, which is included with every operation that you submit.
71
- */
72
- readonly sellerSKU?: string;
73
- }
74
- /**
75
- * CatalogItemsApi - object-oriented interface
76
- */
77
- export declare class CatalogItemsApi extends BaseAPI {
78
- /**
79
- * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 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 see higher rate and burst values than those shown here. For more information, see [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).
80
- * @param {CatalogItemsApiListCatalogCategoriesRequest} requestParameters Request parameters.
81
- * @param {*} [options] Override http request option.
82
- * @throws {RequiredError}
83
- */
84
- listCatalogCategories(requestParameters: CatalogItemsApiListCatalogCategoriesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListCatalogCategoriesResponse, any, {}>>;
85
- }
@@ -1,12 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
4
- *
5
- * The version of the OpenAPI document: v0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- export * from './api/catalog-items-api';
@@ -1,42 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
4
- *
5
- * The version of the OpenAPI document: v0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from './configuration';
13
- import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- export declare const BASE_PATH: string;
15
- export declare const COLLECTION_FORMATS: {
16
- csv: string;
17
- ssv: string;
18
- tsv: string;
19
- pipes: string;
20
- };
21
- export interface RequestArgs {
22
- url: string;
23
- options: RawAxiosRequestConfig;
24
- }
25
- export declare class BaseAPI {
26
- protected basePath: string;
27
- protected axios: AxiosInstance;
28
- protected configuration: Configuration | undefined;
29
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
30
- }
31
- export declare class RequiredError extends Error {
32
- field: string;
33
- constructor(field: string, msg?: string);
34
- }
35
- interface ServerMap {
36
- [key: string]: {
37
- url: string;
38
- description: string;
39
- }[];
40
- }
41
- export declare const operationServerMap: ServerMap;
42
- export {};
@@ -1,34 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
4
- *
5
- * The version of the OpenAPI document: v0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from "./configuration";
13
- import type { RequestArgs } from "./base";
14
- import type { AxiosInstance, AxiosResponse } from 'axios';
15
- export declare const DUMMY_BASE_URL = "https://example.com";
16
- /**
17
- *
18
- * @throws {RequiredError}
19
- */
20
- export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
21
- export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
22
- export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
23
- export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
24
- export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
25
- export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
26
- /**
27
- * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
28
- * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
29
- * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
30
- */
31
- export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
32
- export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
33
- export declare const toPathString: (url: URL) => string;
34
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;