@sp-api-sdk/catalog-items-api-v0 5.0.0 → 5.1.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/README.md +3 -4
- package/dist/index.cjs +255 -282
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +178 -196
- package/dist/index.d.ts +178 -196
- package/dist/index.js +232 -246
- package/dist/index.js.map +1 -1
- package/package.json +7 -4
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import { ClientConfiguration, RateLimit } from
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
|
|
2
|
+
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
|
+
//#region src/api-model/configuration.d.ts
|
|
5
4
|
/**
|
|
6
5
|
* Selling Partner API for Catalog Items
|
|
7
6
|
* The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
|
|
@@ -14,115 +13,105 @@ import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
|
|
|
14
13
|
* Do not edit the class manually.
|
|
15
14
|
*/
|
|
16
15
|
interface AWSv4Configuration {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
16
|
+
options?: {
|
|
17
|
+
region?: string;
|
|
18
|
+
service?: string;
|
|
19
|
+
};
|
|
20
|
+
credentials?: {
|
|
21
|
+
accessKeyId?: string;
|
|
22
|
+
secretAccessKey?: string;
|
|
23
|
+
sessionToken?: string;
|
|
24
|
+
};
|
|
26
25
|
}
|
|
27
26
|
interface ConfigurationParameters {
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
27
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
28
|
+
username?: string;
|
|
29
|
+
password?: string;
|
|
30
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
31
|
+
awsv4?: AWSv4Configuration;
|
|
32
|
+
basePath?: string;
|
|
33
|
+
serverIndex?: number;
|
|
34
|
+
baseOptions?: any;
|
|
35
|
+
formDataCtor?: new () => any;
|
|
37
36
|
}
|
|
38
37
|
declare class Configuration {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
38
|
+
/**
|
|
39
|
+
* parameter for apiKey security
|
|
40
|
+
* @param name security name
|
|
41
|
+
*/
|
|
42
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
43
|
+
/**
|
|
44
|
+
* parameter for basic security
|
|
45
|
+
*/
|
|
46
|
+
username?: string;
|
|
47
|
+
/**
|
|
48
|
+
* parameter for basic security
|
|
49
|
+
*/
|
|
50
|
+
password?: string;
|
|
51
|
+
/**
|
|
52
|
+
* parameter for oauth2 security
|
|
53
|
+
* @param name security name
|
|
54
|
+
* @param scopes oauth2 scope
|
|
55
|
+
*/
|
|
56
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
57
|
+
/**
|
|
58
|
+
* parameter for aws4 signature security
|
|
59
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
60
|
+
* @param {string} options.region - aws region
|
|
61
|
+
* @param {string} options.service - name of the service.
|
|
62
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
63
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
64
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
65
|
+
* @memberof Configuration
|
|
66
|
+
*/
|
|
67
|
+
awsv4?: AWSv4Configuration;
|
|
68
|
+
/**
|
|
69
|
+
* override base path
|
|
70
|
+
*/
|
|
71
|
+
basePath?: string;
|
|
72
|
+
/**
|
|
73
|
+
* override server index
|
|
74
|
+
*/
|
|
75
|
+
serverIndex?: number;
|
|
76
|
+
/**
|
|
77
|
+
* base options for axios calls
|
|
78
|
+
*/
|
|
79
|
+
baseOptions?: any;
|
|
80
|
+
/**
|
|
81
|
+
* The FormData constructor that will be used to create multipart form data
|
|
82
|
+
* requests. You can inject this here so that execution environments that
|
|
83
|
+
* do not support the FormData class can still run the generated client.
|
|
84
|
+
*
|
|
85
|
+
* @type {new () => FormData}
|
|
86
|
+
*/
|
|
87
|
+
formDataCtor?: new () => any;
|
|
88
|
+
constructor(param?: ConfigurationParameters);
|
|
89
|
+
/**
|
|
90
|
+
* Check if the given MIME is a JSON MIME.
|
|
91
|
+
* JSON MIME examples:
|
|
92
|
+
* application/json
|
|
93
|
+
* application/json; charset=UTF8
|
|
94
|
+
* APPLICATION/JSON
|
|
95
|
+
* application/vnd.company+json
|
|
96
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
97
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
98
|
+
*/
|
|
99
|
+
isJsonMime(mime: string): boolean;
|
|
101
100
|
}
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
* Selling Partner API for Catalog Items
|
|
105
|
-
* The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
|
|
106
|
-
*
|
|
107
|
-
* The version of the OpenAPI document: v0
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
111
|
-
* https://openapi-generator.tech
|
|
112
|
-
* Do not edit the class manually.
|
|
113
|
-
*/
|
|
114
|
-
|
|
101
|
+
//#endregion
|
|
102
|
+
//#region src/api-model/base.d.ts
|
|
115
103
|
interface RequestArgs {
|
|
116
|
-
|
|
117
|
-
|
|
104
|
+
url: string;
|
|
105
|
+
options: RawAxiosRequestConfig;
|
|
118
106
|
}
|
|
119
107
|
declare class BaseAPI {
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
108
|
+
protected basePath: string;
|
|
109
|
+
protected axios: AxiosInstance;
|
|
110
|
+
protected configuration: Configuration | undefined;
|
|
111
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
124
112
|
}
|
|
125
|
-
|
|
113
|
+
//#endregion
|
|
114
|
+
//#region src/api-model/models/categories.d.ts
|
|
126
115
|
/**
|
|
127
116
|
* Selling Partner API for Catalog Items
|
|
128
117
|
* The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
|
|
@@ -135,40 +124,30 @@ declare class BaseAPI {
|
|
|
135
124
|
* Do not edit the class manually.
|
|
136
125
|
*/
|
|
137
126
|
interface Categories {
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
127
|
+
/**
|
|
128
|
+
* The identifier for the product category (or browse node).
|
|
129
|
+
*/
|
|
130
|
+
'ProductCategoryId'?: string;
|
|
131
|
+
/**
|
|
132
|
+
* The name of the product category (or browse node).
|
|
133
|
+
*/
|
|
134
|
+
'ProductCategoryName'?: string;
|
|
135
|
+
/**
|
|
136
|
+
* The parent product category.
|
|
137
|
+
*/
|
|
138
|
+
'parent'?: object;
|
|
150
139
|
}
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
* Selling Partner API for Catalog Items
|
|
154
|
-
* The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
|
|
155
|
-
*
|
|
156
|
-
* The version of the OpenAPI document: v0
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
160
|
-
* https://openapi-generator.tech
|
|
161
|
-
* Do not edit the class manually.
|
|
162
|
-
*/
|
|
163
|
-
|
|
140
|
+
//#endregion
|
|
141
|
+
//#region src/api-model/models/list-catalog-categories-response.d.ts
|
|
164
142
|
interface ListCatalogCategoriesResponse {
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
143
|
+
'payload'?: Array<Categories>;
|
|
144
|
+
/**
|
|
145
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
146
|
+
*/
|
|
147
|
+
'errors'?: Array<Error>;
|
|
170
148
|
}
|
|
171
|
-
|
|
149
|
+
//#endregion
|
|
150
|
+
//#region src/api-model/models/model-error.d.ts
|
|
172
151
|
/**
|
|
173
152
|
* Selling Partner API for Catalog Items
|
|
174
153
|
* The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
|
|
@@ -184,93 +163,96 @@ interface ListCatalogCategoriesResponse {
|
|
|
184
163
|
* Error response returned when the request is unsuccessful.
|
|
185
164
|
*/
|
|
186
165
|
interface ModelError {
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
166
|
+
/**
|
|
167
|
+
* An error code that identifies the type of error that occurred.
|
|
168
|
+
*/
|
|
169
|
+
'code': string;
|
|
170
|
+
/**
|
|
171
|
+
* A message that describes the error condition in a human-readable form.
|
|
172
|
+
*/
|
|
173
|
+
'message': string;
|
|
174
|
+
/**
|
|
175
|
+
* Additional information that can help the caller understand or fix the issue.
|
|
176
|
+
*/
|
|
177
|
+
'details'?: string;
|
|
199
178
|
}
|
|
200
|
-
|
|
179
|
+
//#endregion
|
|
180
|
+
//#region src/api-model/api/catalog-items-api.d.ts
|
|
201
181
|
/**
|
|
202
182
|
* CatalogItemsApi - axios parameter creator
|
|
203
183
|
*/
|
|
204
184
|
declare const CatalogItemsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
185
|
+
/**
|
|
186
|
+
* 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).
|
|
187
|
+
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item.
|
|
188
|
+
* @param {string} [aSIN] The Amazon Standard Identification Number (ASIN) of the item.
|
|
189
|
+
* @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.
|
|
190
|
+
* @param {*} [options] Override http request option.
|
|
191
|
+
* @throws {RequiredError}
|
|
192
|
+
*/
|
|
193
|
+
listCatalogCategories: (marketplaceId: string, aSIN?: string, sellerSKU?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
214
194
|
};
|
|
215
195
|
/**
|
|
216
196
|
* CatalogItemsApi - functional programming interface
|
|
217
197
|
*/
|
|
218
198
|
declare const CatalogItemsApiFp: (configuration?: Configuration) => {
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
199
|
+
/**
|
|
200
|
+
* 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).
|
|
201
|
+
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item.
|
|
202
|
+
* @param {string} [aSIN] The Amazon Standard Identification Number (ASIN) of the item.
|
|
203
|
+
* @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.
|
|
204
|
+
* @param {*} [options] Override http request option.
|
|
205
|
+
* @throws {RequiredError}
|
|
206
|
+
*/
|
|
207
|
+
listCatalogCategories(marketplaceId: string, aSIN?: string, sellerSKU?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCatalogCategoriesResponse>>;
|
|
228
208
|
};
|
|
229
209
|
/**
|
|
230
210
|
* CatalogItemsApi - factory interface
|
|
231
211
|
*/
|
|
232
212
|
declare const CatalogItemsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
213
|
+
/**
|
|
214
|
+
* 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).
|
|
215
|
+
* @param {CatalogItemsApiListCatalogCategoriesRequest} requestParameters Request parameters.
|
|
216
|
+
* @param {*} [options] Override http request option.
|
|
217
|
+
* @throws {RequiredError}
|
|
218
|
+
*/
|
|
219
|
+
listCatalogCategories(requestParameters: CatalogItemsApiListCatalogCategoriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCatalogCategoriesResponse>;
|
|
240
220
|
};
|
|
241
221
|
/**
|
|
242
222
|
* Request parameters for listCatalogCategories operation in CatalogItemsApi.
|
|
243
223
|
*/
|
|
244
224
|
interface CatalogItemsApiListCatalogCategoriesRequest {
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
225
|
+
/**
|
|
226
|
+
* A marketplace identifier. Specifies the marketplace for the item.
|
|
227
|
+
*/
|
|
228
|
+
readonly marketplaceId: string;
|
|
229
|
+
/**
|
|
230
|
+
* The Amazon Standard Identification Number (ASIN) of the item.
|
|
231
|
+
*/
|
|
232
|
+
readonly aSIN?: string;
|
|
233
|
+
/**
|
|
234
|
+
* 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.
|
|
235
|
+
*/
|
|
236
|
+
readonly sellerSKU?: string;
|
|
257
237
|
}
|
|
258
238
|
/**
|
|
259
239
|
* CatalogItemsApi - object-oriented interface
|
|
260
240
|
*/
|
|
261
241
|
declare class CatalogItemsApi extends BaseAPI {
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
242
|
+
/**
|
|
243
|
+
* 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).
|
|
244
|
+
* @param {CatalogItemsApiListCatalogCategoriesRequest} requestParameters Request parameters.
|
|
245
|
+
* @param {*} [options] Override http request option.
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
*/
|
|
248
|
+
listCatalogCategories(requestParameters: CatalogItemsApiListCatalogCategoriesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCatalogCategoriesResponse, any, {}>>;
|
|
269
249
|
}
|
|
270
|
-
|
|
250
|
+
//#endregion
|
|
251
|
+
//#region src/client.d.ts
|
|
271
252
|
declare const clientRateLimits: RateLimit[];
|
|
272
253
|
declare class CatalogItemsApiClient extends CatalogItemsApi {
|
|
273
|
-
|
|
254
|
+
constructor(configuration: ClientConfiguration);
|
|
274
255
|
}
|
|
275
|
-
|
|
276
|
-
export { CatalogItemsApi, CatalogItemsApiAxiosParamCreator, CatalogItemsApiClient, CatalogItemsApiFactory, CatalogItemsApiFp,
|
|
256
|
+
//#endregion
|
|
257
|
+
export { CatalogItemsApi, CatalogItemsApiAxiosParamCreator, CatalogItemsApiClient, CatalogItemsApiFactory, CatalogItemsApiFp, CatalogItemsApiListCatalogCategoriesRequest, type Categories, type ListCatalogCategoriesResponse, type ModelError, clientRateLimits };
|
|
258
|
+
//# sourceMappingURL=index.d.ts.map
|