@sp-api-sdk/feeds-api-2021-06-30 3.2.14 → 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.
Files changed (61) hide show
  1. package/README.md +4 -4
  2. package/dist/index.cjs +698 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/{types/api-model/api/feeds-api.d.ts → index.d.cts} +415 -31
  5. package/dist/index.d.ts +692 -0
  6. package/dist/index.js +653 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +23 -12
  9. package/dist/cjs/api-model/api/feeds-api.js +0 -454
  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/create-feed-document-response.js +0 -15
  16. package/dist/cjs/api-model/models/create-feed-document-specification.js +0 -15
  17. package/dist/cjs/api-model/models/create-feed-response.js +0 -15
  18. package/dist/cjs/api-model/models/create-feed-specification.js +0 -15
  19. package/dist/cjs/api-model/models/error-list.js +0 -15
  20. package/dist/cjs/api-model/models/feed-document.js +0 -19
  21. package/dist/cjs/api-model/models/feed.js +0 -23
  22. package/dist/cjs/api-model/models/get-feeds-response.js +0 -15
  23. package/dist/cjs/api-model/models/index.js +0 -25
  24. package/dist/cjs/api-model/models/model-error.js +0 -15
  25. package/dist/cjs/client.js +0 -56
  26. package/dist/cjs/index.js +0 -19
  27. package/dist/es/api-model/api/feeds-api.js +0 -444
  28. package/dist/es/api-model/api.js +0 -14
  29. package/dist/es/api-model/base.js +0 -44
  30. package/dist/es/api-model/common.js +0 -110
  31. package/dist/es/api-model/configuration.js +0 -94
  32. package/dist/es/api-model/index.js +0 -16
  33. package/dist/es/api-model/models/create-feed-document-response.js +0 -14
  34. package/dist/es/api-model/models/create-feed-document-specification.js +0 -14
  35. package/dist/es/api-model/models/create-feed-response.js +0 -14
  36. package/dist/es/api-model/models/create-feed-specification.js +0 -14
  37. package/dist/es/api-model/models/error-list.js +0 -14
  38. package/dist/es/api-model/models/feed-document.js +0 -16
  39. package/dist/es/api-model/models/feed.js +0 -20
  40. package/dist/es/api-model/models/get-feeds-response.js +0 -14
  41. package/dist/es/api-model/models/index.js +0 -9
  42. package/dist/es/api-model/models/model-error.js +0 -14
  43. package/dist/es/client.js +0 -52
  44. package/dist/es/index.js +0 -3
  45. package/dist/types/api-model/api.d.ts +0 -12
  46. package/dist/types/api-model/base.d.ts +0 -42
  47. package/dist/types/api-model/common.d.ts +0 -34
  48. package/dist/types/api-model/configuration.d.ts +0 -98
  49. package/dist/types/api-model/index.d.ts +0 -14
  50. package/dist/types/api-model/models/create-feed-document-response.d.ts +0 -24
  51. package/dist/types/api-model/models/create-feed-document-specification.d.ts +0 -20
  52. package/dist/types/api-model/models/create-feed-response.d.ts +0 -20
  53. package/dist/types/api-model/models/create-feed-specification.d.ts +0 -34
  54. package/dist/types/api-model/models/error-list.d.ts +0 -20
  55. package/dist/types/api-model/models/feed-document.d.ts +0 -32
  56. package/dist/types/api-model/models/feed.d.ts +0 -56
  57. package/dist/types/api-model/models/get-feeds-response.d.ts +0 -25
  58. package/dist/types/api-model/models/index.d.ts +0 -9
  59. package/dist/types/api-model/models/model-error.d.ts +0 -28
  60. package/dist/types/client.d.ts +0 -6
  61. package/dist/types/index.d.ts +0 -3
@@ -1,3 +1,7 @@
1
+ import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
2
+ import * as axios from 'axios';
3
+ import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
4
+
1
5
  /**
2
6
  * Selling Partner API for Feeds
3
7
  * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
@@ -9,21 +13,388 @@
9
13
  * https://openapi-generator.tech
10
14
  * Do not edit the class manually.
11
15
  */
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 { CreateFeedDocumentResponse } from '../models';
17
- import type { CreateFeedDocumentSpecification } from '../models';
18
- import type { CreateFeedResponse } from '../models';
19
- import type { CreateFeedSpecification } from '../models';
20
- import type { Feed } from '../models';
21
- import type { FeedDocument } from '../models';
22
- import type { GetFeedsResponse } from '../models';
16
+ interface AWSv4Configuration {
17
+ options?: {
18
+ region?: string;
19
+ service?: string;
20
+ };
21
+ credentials?: {
22
+ accessKeyId?: string;
23
+ secretAccessKey?: string;
24
+ sessionToken?: string;
25
+ };
26
+ }
27
+ interface ConfigurationParameters {
28
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
+ username?: string;
30
+ password?: string;
31
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
32
+ awsv4?: AWSv4Configuration;
33
+ basePath?: string;
34
+ serverIndex?: number;
35
+ baseOptions?: any;
36
+ formDataCtor?: new () => any;
37
+ }
38
+ declare class Configuration {
39
+ /**
40
+ * parameter for apiKey security
41
+ * @param name security name
42
+ */
43
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
44
+ /**
45
+ * parameter for basic security
46
+ */
47
+ username?: string;
48
+ /**
49
+ * parameter for basic security
50
+ */
51
+ password?: string;
52
+ /**
53
+ * parameter for oauth2 security
54
+ * @param name security name
55
+ * @param scopes oauth2 scope
56
+ */
57
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
58
+ /**
59
+ * parameter for aws4 signature security
60
+ * @param {Object} AWS4Signature - AWS4 Signature security
61
+ * @param {string} options.region - aws region
62
+ * @param {string} options.service - name of the service.
63
+ * @param {string} credentials.accessKeyId - aws access key id
64
+ * @param {string} credentials.secretAccessKey - aws access key
65
+ * @param {string} credentials.sessionToken - aws session token
66
+ * @memberof Configuration
67
+ */
68
+ awsv4?: AWSv4Configuration;
69
+ /**
70
+ * override base path
71
+ */
72
+ basePath?: string;
73
+ /**
74
+ * override server index
75
+ */
76
+ serverIndex?: number;
77
+ /**
78
+ * base options for axios calls
79
+ */
80
+ baseOptions?: any;
81
+ /**
82
+ * The FormData constructor that will be used to create multipart form data
83
+ * requests. You can inject this here so that execution environments that
84
+ * do not support the FormData class can still run the generated client.
85
+ *
86
+ * @type {new () => FormData}
87
+ */
88
+ formDataCtor?: new () => any;
89
+ constructor(param?: ConfigurationParameters);
90
+ /**
91
+ * Check if the given MIME is a JSON MIME.
92
+ * JSON MIME examples:
93
+ * application/json
94
+ * application/json; charset=UTF8
95
+ * APPLICATION/JSON
96
+ * application/vnd.company+json
97
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
98
+ * @return True if the given MIME is JSON, false otherwise.
99
+ */
100
+ isJsonMime(mime: string): boolean;
101
+ }
102
+
103
+ /**
104
+ * Selling Partner API for Feeds
105
+ * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
106
+ *
107
+ * The version of the OpenAPI document: 2021-06-30
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
+
115
+ interface RequestArgs {
116
+ url: string;
117
+ options: RawAxiosRequestConfig;
118
+ }
119
+ declare class BaseAPI {
120
+ protected basePath: string;
121
+ protected axios: AxiosInstance;
122
+ protected configuration: Configuration | undefined;
123
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
124
+ }
125
+
126
+ /**
127
+ * Selling Partner API for Feeds
128
+ * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
129
+ *
130
+ * The version of the OpenAPI document: 2021-06-30
131
+ *
132
+ *
133
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
134
+ * https://openapi-generator.tech
135
+ * Do not edit the class manually.
136
+ */
137
+ /**
138
+ * Information required to upload a feed document\'s contents.
139
+ */
140
+ interface CreateFeedDocumentResponse {
141
+ /**
142
+ * The identifier of the feed document.
143
+ */
144
+ 'feedDocumentId': string;
145
+ /**
146
+ * The presigned URL for uploading the feed contents. This URL expires after 5 minutes.
147
+ */
148
+ 'url': string;
149
+ }
150
+
151
+ /**
152
+ * Selling Partner API for Feeds
153
+ * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
154
+ *
155
+ * The version of the OpenAPI document: 2021-06-30
156
+ *
157
+ *
158
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
159
+ * https://openapi-generator.tech
160
+ * Do not edit the class manually.
161
+ */
162
+ /**
163
+ * Specifies the content type for the createFeedDocument operation.
164
+ */
165
+ interface CreateFeedDocumentSpecification {
166
+ /**
167
+ * The content type of the feed.
168
+ */
169
+ 'contentType': string;
170
+ }
171
+
172
+ /**
173
+ * Selling Partner API for Feeds
174
+ * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
175
+ *
176
+ * The version of the OpenAPI document: 2021-06-30
177
+ *
178
+ *
179
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
180
+ * https://openapi-generator.tech
181
+ * Do not edit the class manually.
182
+ */
183
+ /**
184
+ * Response schema.
185
+ */
186
+ interface CreateFeedResponse {
187
+ /**
188
+ * The identifier for the feed. This identifier is unique only in combination with a seller ID.
189
+ */
190
+ 'feedId': string;
191
+ }
192
+
193
+ /**
194
+ * Selling Partner API for Feeds
195
+ * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
196
+ *
197
+ * The version of the OpenAPI document: 2021-06-30
198
+ *
199
+ *
200
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
201
+ * https://openapi-generator.tech
202
+ * Do not edit the class manually.
203
+ */
204
+ /**
205
+ * Information required to create the feed.
206
+ */
207
+ interface CreateFeedSpecification {
208
+ /**
209
+ * The feed type.
210
+ */
211
+ 'feedType': string;
212
+ /**
213
+ * A list of identifiers for marketplaces that you want the feed to be applied to.
214
+ */
215
+ 'marketplaceIds': Array<string>;
216
+ /**
217
+ * The document identifier returned by the createFeedDocument operation. Upload the feed document contents before calling the createFeed operation.
218
+ */
219
+ 'inputFeedDocumentId': string;
220
+ /**
221
+ * Additional options to control the feed. These vary by feed type.
222
+ */
223
+ 'feedOptions'?: {
224
+ [key: string]: string;
225
+ };
226
+ }
227
+
228
+ /**
229
+ * Selling Partner API for Feeds
230
+ * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
231
+ *
232
+ * The version of the OpenAPI document: 2021-06-30
233
+ *
234
+ *
235
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
236
+ * https://openapi-generator.tech
237
+ * Do not edit the class manually.
238
+ */
239
+ /**
240
+ * A list of error responses returned when a request is unsuccessful.
241
+ */
242
+ interface ErrorList {
243
+ /**
244
+ * An error response returned when the request is unsuccessful.
245
+ */
246
+ 'errors': Array<Error>;
247
+ }
248
+
249
+ /**
250
+ * Selling Partner API for Feeds
251
+ * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
252
+ *
253
+ * The version of the OpenAPI document: 2021-06-30
254
+ *
255
+ *
256
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
257
+ * https://openapi-generator.tech
258
+ * Do not edit the class manually.
259
+ */
260
+ /**
261
+ * Detailed information about the feed.
262
+ */
263
+ interface Feed {
264
+ /**
265
+ * The identifier for the feed. This identifier is unique only in combination with a seller ID.
266
+ */
267
+ 'feedId': string;
268
+ /**
269
+ * The feed type.
270
+ */
271
+ 'feedType': string;
272
+ /**
273
+ * A list of identifiers for the marketplaces that the feed is applied to.
274
+ */
275
+ 'marketplaceIds'?: Array<string>;
276
+ /**
277
+ * The date and time when the feed was created, in ISO 8601 date time format.
278
+ */
279
+ 'createdTime': string;
280
+ /**
281
+ * The processing status of the feed.
282
+ */
283
+ 'processingStatus': FeedProcessingStatusEnum;
284
+ /**
285
+ * The date and time when feed processing started, in ISO 8601 date time format.
286
+ */
287
+ 'processingStartTime'?: string;
288
+ /**
289
+ * The date and time when feed processing completed, in ISO 8601 date time format.
290
+ */
291
+ 'processingEndTime'?: string;
292
+ /**
293
+ * The identifier for the feed document. This identifier is unique only in combination with a seller ID.
294
+ */
295
+ 'resultFeedDocumentId'?: string;
296
+ }
297
+ declare const FeedProcessingStatusEnum: {
298
+ readonly Cancelled: "CANCELLED";
299
+ readonly Done: "DONE";
300
+ readonly Fatal: "FATAL";
301
+ readonly InProgress: "IN_PROGRESS";
302
+ readonly InQueue: "IN_QUEUE";
303
+ };
304
+ type FeedProcessingStatusEnum = typeof FeedProcessingStatusEnum[keyof typeof FeedProcessingStatusEnum];
305
+
306
+ /**
307
+ * Selling Partner API for Feeds
308
+ * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
309
+ *
310
+ * The version of the OpenAPI document: 2021-06-30
311
+ *
312
+ *
313
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
314
+ * https://openapi-generator.tech
315
+ * Do not edit the class manually.
316
+ */
317
+ /**
318
+ * Information required for the feed document.
319
+ */
320
+ interface FeedDocument {
321
+ /**
322
+ * The identifier for the feed document. This identifier is unique only in combination with a seller ID.
323
+ */
324
+ 'feedDocumentId': string;
325
+ /**
326
+ * A presigned URL for the feed document. If `compressionAlgorithm` is not returned, you can download the feed directly from this URL. This URL expires after 5 minutes.
327
+ */
328
+ 'url': string;
329
+ /**
330
+ * If the feed document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the feed when you download. Otherwise, you can download the feed directly. Refer to [Step 7. Download the feed processing report](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-use-case-guide#step-7-download-the-feed-processing-report) in the use case guide, where sample code is provided.
331
+ */
332
+ 'compressionAlgorithm'?: FeedDocumentCompressionAlgorithmEnum;
333
+ }
334
+ declare const FeedDocumentCompressionAlgorithmEnum: {
335
+ readonly Gzip: "GZIP";
336
+ };
337
+ type FeedDocumentCompressionAlgorithmEnum = typeof FeedDocumentCompressionAlgorithmEnum[keyof typeof FeedDocumentCompressionAlgorithmEnum];
338
+
339
+ /**
340
+ * Selling Partner API for Feeds
341
+ * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
342
+ *
343
+ * The version of the OpenAPI document: 2021-06-30
344
+ *
345
+ *
346
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
347
+ * https://openapi-generator.tech
348
+ * Do not edit the class manually.
349
+ */
350
+
351
+ /**
352
+ * Response schema.
353
+ */
354
+ interface GetFeedsResponse {
355
+ /**
356
+ * A list of feeds.
357
+ */
358
+ 'feeds': Array<Feed>;
359
+ /**
360
+ * Returned when the number of results exceeds pageSize. To get the next page of results, call the getFeeds operation with this token as the only parameter.
361
+ */
362
+ 'nextToken'?: string;
363
+ }
364
+
365
+ /**
366
+ * Selling Partner API for Feeds
367
+ * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
368
+ *
369
+ * The version of the OpenAPI document: 2021-06-30
370
+ *
371
+ *
372
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
373
+ * https://openapi-generator.tech
374
+ * Do not edit the class manually.
375
+ */
376
+ /**
377
+ * An error response returned when the request is unsuccessful.
378
+ */
379
+ interface ModelError {
380
+ /**
381
+ * An error code that identifies the type of error that occurred.
382
+ */
383
+ 'code': string;
384
+ /**
385
+ * A message that describes the error condition.
386
+ */
387
+ 'message': string;
388
+ /**
389
+ * Additional details that can help the caller understand or fix the issue.
390
+ */
391
+ 'details'?: string;
392
+ }
393
+
23
394
  /**
24
395
  * FeedsApi - axios parameter creator
25
396
  */
26
- export declare const FeedsApiAxiosParamCreator: (configuration?: Configuration) => {
397
+ declare const FeedsApiAxiosParamCreator: (configuration?: Configuration) => {
27
398
  /**
28
399
  * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/reference/getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/reference/getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
29
400
  * @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID.
@@ -55,10 +426,11 @@ export declare const FeedsApiAxiosParamCreator: (configuration?: Configuration)
55
426
  /**
56
427
  * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
57
428
  * @param {string} feedDocumentId The identifier of the feed document.
429
+ * @param {boolean} [enableContentEncodingUrlHeader] When &#x60;true&#x60;, the Content-Encoding header on the returned URL is set to &#x60;gzip&#x60; instead of the default &#x60;identity&#x60; when &#x60;compressionAlgorithm&#x60; is &#x60;GZIP&#x60;. This allows automatic decompression by HTTP clients.
58
430
  * @param {*} [options] Override http request option.
59
431
  * @throws {RequiredError}
60
432
  */
61
- getFeedDocument: (feedDocumentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
433
+ getFeedDocument: (feedDocumentId: string, enableContentEncodingUrlHeader?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62
434
  /**
63
435
  * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
64
436
  * @param {Array<string>} [feedTypes] A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.
@@ -76,7 +448,7 @@ export declare const FeedsApiAxiosParamCreator: (configuration?: Configuration)
76
448
  /**
77
449
  * FeedsApi - functional programming interface
78
450
  */
79
- export declare const FeedsApiFp: (configuration?: Configuration) => {
451
+ declare const FeedsApiFp: (configuration?: Configuration) => {
80
452
  /**
81
453
  * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/reference/getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/reference/getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
82
454
  * @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID.
@@ -108,10 +480,11 @@ export declare const FeedsApiFp: (configuration?: Configuration) => {
108
480
  /**
109
481
  * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
110
482
  * @param {string} feedDocumentId The identifier of the feed document.
483
+ * @param {boolean} [enableContentEncodingUrlHeader] When &#x60;true&#x60;, the Content-Encoding header on the returned URL is set to &#x60;gzip&#x60; instead of the default &#x60;identity&#x60; when &#x60;compressionAlgorithm&#x60; is &#x60;GZIP&#x60;. This allows automatic decompression by HTTP clients.
111
484
  * @param {*} [options] Override http request option.
112
485
  * @throws {RequiredError}
113
486
  */
114
- getFeedDocument(feedDocumentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeedDocument>>;
487
+ getFeedDocument(feedDocumentId: string, enableContentEncodingUrlHeader?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeedDocument>>;
115
488
  /**
116
489
  * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
117
490
  * @param {Array<string>} [feedTypes] A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.
@@ -129,7 +502,7 @@ export declare const FeedsApiFp: (configuration?: Configuration) => {
129
502
  /**
130
503
  * FeedsApi - factory interface
131
504
  */
132
- export declare const FeedsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
505
+ declare const FeedsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
133
506
  /**
134
507
  * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/reference/getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/reference/getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
135
508
  * @param {FeedsApiCancelFeedRequest} requestParameters Request parameters.
@@ -176,7 +549,7 @@ export declare const FeedsApiFactory: (configuration?: Configuration, basePath?:
176
549
  /**
177
550
  * Request parameters for cancelFeed operation in FeedsApi.
178
551
  */
179
- export interface FeedsApiCancelFeedRequest {
552
+ interface FeedsApiCancelFeedRequest {
180
553
  /**
181
554
  * The identifier for the feed. This identifier is unique only in combination with a seller ID.
182
555
  */
@@ -185,7 +558,7 @@ export interface FeedsApiCancelFeedRequest {
185
558
  /**
186
559
  * Request parameters for createFeed operation in FeedsApi.
187
560
  */
188
- export interface FeedsApiCreateFeedRequest {
561
+ interface FeedsApiCreateFeedRequest {
189
562
  /**
190
563
  * Information required to create the feed.
191
564
  */
@@ -194,7 +567,7 @@ export interface FeedsApiCreateFeedRequest {
194
567
  /**
195
568
  * Request parameters for createFeedDocument operation in FeedsApi.
196
569
  */
197
- export interface FeedsApiCreateFeedDocumentRequest {
570
+ interface FeedsApiCreateFeedDocumentRequest {
198
571
  /**
199
572
  * Specifies the content type for the createFeedDocument operation.
200
573
  */
@@ -203,7 +576,7 @@ export interface FeedsApiCreateFeedDocumentRequest {
203
576
  /**
204
577
  * Request parameters for getFeed operation in FeedsApi.
205
578
  */
206
- export interface FeedsApiGetFeedRequest {
579
+ interface FeedsApiGetFeedRequest {
207
580
  /**
208
581
  * The identifier for the feed. This identifier is unique only in combination with a seller ID.
209
582
  */
@@ -212,16 +585,20 @@ export interface FeedsApiGetFeedRequest {
212
585
  /**
213
586
  * Request parameters for getFeedDocument operation in FeedsApi.
214
587
  */
215
- export interface FeedsApiGetFeedDocumentRequest {
588
+ interface FeedsApiGetFeedDocumentRequest {
216
589
  /**
217
590
  * The identifier of the feed document.
218
591
  */
219
592
  readonly feedDocumentId: string;
593
+ /**
594
+ * When &#x60;true&#x60;, the Content-Encoding header on the returned URL is set to &#x60;gzip&#x60; instead of the default &#x60;identity&#x60; when &#x60;compressionAlgorithm&#x60; is &#x60;GZIP&#x60;. This allows automatic decompression by HTTP clients.
595
+ */
596
+ readonly enableContentEncodingUrlHeader?: boolean;
220
597
  }
221
598
  /**
222
599
  * Request parameters for getFeeds operation in FeedsApi.
223
600
  */
224
- export interface FeedsApiGetFeedsRequest {
601
+ interface FeedsApiGetFeedsRequest {
225
602
  /**
226
603
  * A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.
227
604
  */
@@ -254,55 +631,62 @@ export interface FeedsApiGetFeedsRequest {
254
631
  /**
255
632
  * FeedsApi - object-oriented interface
256
633
  */
257
- export declare class FeedsApi extends BaseAPI {
634
+ declare class FeedsApi extends BaseAPI {
258
635
  /**
259
636
  * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/reference/getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/reference/getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
260
637
  * @param {FeedsApiCancelFeedRequest} requestParameters Request parameters.
261
638
  * @param {*} [options] Override http request option.
262
639
  * @throws {RequiredError}
263
640
  */
264
- cancelFeed(requestParameters: FeedsApiCancelFeedRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
641
+ cancelFeed(requestParameters: FeedsApiCancelFeedRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
265
642
  /**
266
643
  * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api).
267
644
  * @param {FeedsApiCreateFeedRequest} requestParameters Request parameters.
268
645
  * @param {*} [options] Override http request option.
269
646
  * @throws {RequiredError}
270
647
  */
271
- createFeed(requestParameters: FeedsApiCreateFeedRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateFeedResponse, any, {}>>;
648
+ createFeed(requestParameters: FeedsApiCreateFeedRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CreateFeedResponse, any, {}>>;
272
649
  /**
273
650
  * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
274
651
  * @param {FeedsApiCreateFeedDocumentRequest} requestParameters Request parameters.
275
652
  * @param {*} [options] Override http request option.
276
653
  * @throws {RequiredError}
277
654
  */
278
- createFeedDocument(requestParameters: FeedsApiCreateFeedDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateFeedDocumentResponse, any, {}>>;
655
+ createFeedDocument(requestParameters: FeedsApiCreateFeedDocumentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CreateFeedDocumentResponse, any, {}>>;
279
656
  /**
280
657
  * Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
281
658
  * @param {FeedsApiGetFeedRequest} requestParameters Request parameters.
282
659
  * @param {*} [options] Override http request option.
283
660
  * @throws {RequiredError}
284
661
  */
285
- getFeed(requestParameters: FeedsApiGetFeedRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Feed, any, {}>>;
662
+ getFeed(requestParameters: FeedsApiGetFeedRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<Feed, any, {}>>;
286
663
  /**
287
664
  * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
288
665
  * @param {FeedsApiGetFeedDocumentRequest} requestParameters Request parameters.
289
666
  * @param {*} [options] Override http request option.
290
667
  * @throws {RequiredError}
291
668
  */
292
- getFeedDocument(requestParameters: FeedsApiGetFeedDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<FeedDocument, any, {}>>;
669
+ getFeedDocument(requestParameters: FeedsApiGetFeedDocumentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<FeedDocument, any, {}>>;
293
670
  /**
294
671
  * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
295
672
  * @param {FeedsApiGetFeedsRequest} requestParameters Request parameters.
296
673
  * @param {*} [options] Override http request option.
297
674
  * @throws {RequiredError}
298
675
  */
299
- getFeeds(requestParameters?: FeedsApiGetFeedsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFeedsResponse, any, {}>>;
676
+ getFeeds(requestParameters?: FeedsApiGetFeedsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetFeedsResponse, any, {}>>;
300
677
  }
301
- export declare const GetFeedsProcessingStatusesEnum: {
678
+ declare const GetFeedsProcessingStatusesEnum: {
302
679
  readonly Cancelled: "CANCELLED";
303
680
  readonly Done: "DONE";
304
681
  readonly Fatal: "FATAL";
305
682
  readonly InProgress: "IN_PROGRESS";
306
683
  readonly InQueue: "IN_QUEUE";
307
684
  };
308
- export type GetFeedsProcessingStatusesEnum = typeof GetFeedsProcessingStatusesEnum[keyof typeof GetFeedsProcessingStatusesEnum];
685
+ type GetFeedsProcessingStatusesEnum = typeof GetFeedsProcessingStatusesEnum[keyof typeof GetFeedsProcessingStatusesEnum];
686
+
687
+ declare const clientRateLimits: RateLimit[];
688
+ declare class FeedsApiClient extends FeedsApi {
689
+ constructor(configuration: ClientConfiguration);
690
+ }
691
+
692
+ export { type CreateFeedDocumentResponse, type CreateFeedDocumentSpecification, type CreateFeedResponse, type CreateFeedSpecification, type ErrorList, type Feed, type FeedDocument, FeedDocumentCompressionAlgorithmEnum, FeedProcessingStatusEnum, FeedsApi, FeedsApiAxiosParamCreator, type FeedsApiCancelFeedRequest, FeedsApiClient, type FeedsApiCreateFeedDocumentRequest, type FeedsApiCreateFeedRequest, FeedsApiFactory, FeedsApiFp, type FeedsApiGetFeedDocumentRequest, type FeedsApiGetFeedRequest, type FeedsApiGetFeedsRequest, GetFeedsProcessingStatusesEnum, type GetFeedsResponse, type ModelError, clientRateLimits };