@sp-api-sdk/feeds-api-2021-06-30 4.0.0 → 4.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 +651 -664
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +464 -476
- package/dist/index.d.ts +464 -476
- package/dist/index.js +625 -625
- package/dist/index.js.map +1 -1
- package/package.json +7 -4
package/dist/index.d.cts
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 Feeds
|
|
7
6
|
* The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
|
|
@@ -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 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
|
-
|
|
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/create-feed-document-response.d.ts
|
|
126
115
|
/**
|
|
127
116
|
* Selling Partner API for Feeds
|
|
128
117
|
* The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
|
|
@@ -138,16 +127,17 @@ declare class BaseAPI {
|
|
|
138
127
|
* Information required to upload a feed document\'s contents.
|
|
139
128
|
*/
|
|
140
129
|
interface CreateFeedDocumentResponse {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
130
|
+
/**
|
|
131
|
+
* The identifier of the feed document.
|
|
132
|
+
*/
|
|
133
|
+
'feedDocumentId': string;
|
|
134
|
+
/**
|
|
135
|
+
* The presigned URL for uploading the feed contents. This URL expires after 5 minutes.
|
|
136
|
+
*/
|
|
137
|
+
'url': string;
|
|
149
138
|
}
|
|
150
|
-
|
|
139
|
+
//#endregion
|
|
140
|
+
//#region src/api-model/models/create-feed-document-specification.d.ts
|
|
151
141
|
/**
|
|
152
142
|
* Selling Partner API for Feeds
|
|
153
143
|
* The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
|
|
@@ -163,12 +153,13 @@ interface CreateFeedDocumentResponse {
|
|
|
163
153
|
* Specifies the content type for the createFeedDocument operation.
|
|
164
154
|
*/
|
|
165
155
|
interface CreateFeedDocumentSpecification {
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
156
|
+
/**
|
|
157
|
+
* The content type of the feed.
|
|
158
|
+
*/
|
|
159
|
+
'contentType': string;
|
|
170
160
|
}
|
|
171
|
-
|
|
161
|
+
//#endregion
|
|
162
|
+
//#region src/api-model/models/create-feed-response.d.ts
|
|
172
163
|
/**
|
|
173
164
|
* Selling Partner API for Feeds
|
|
174
165
|
* The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
|
|
@@ -184,12 +175,13 @@ interface CreateFeedDocumentSpecification {
|
|
|
184
175
|
* Response schema.
|
|
185
176
|
*/
|
|
186
177
|
interface CreateFeedResponse {
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
178
|
+
/**
|
|
179
|
+
* The identifier for the feed. This identifier is unique only in combination with a seller ID.
|
|
180
|
+
*/
|
|
181
|
+
'feedId': string;
|
|
191
182
|
}
|
|
192
|
-
|
|
183
|
+
//#endregion
|
|
184
|
+
//#region src/api-model/models/create-feed-specification.d.ts
|
|
193
185
|
/**
|
|
194
186
|
* Selling Partner API for Feeds
|
|
195
187
|
* The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
|
|
@@ -205,26 +197,27 @@ interface CreateFeedResponse {
|
|
|
205
197
|
* Information required to create the feed.
|
|
206
198
|
*/
|
|
207
199
|
interface CreateFeedSpecification {
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
200
|
+
/**
|
|
201
|
+
* The feed type.
|
|
202
|
+
*/
|
|
203
|
+
'feedType': string;
|
|
204
|
+
/**
|
|
205
|
+
* A list of identifiers for marketplaces that you want the feed to be applied to.
|
|
206
|
+
*/
|
|
207
|
+
'marketplaceIds': Array<string>;
|
|
208
|
+
/**
|
|
209
|
+
* The document identifier returned by the createFeedDocument operation. Upload the feed document contents before calling the createFeed operation.
|
|
210
|
+
*/
|
|
211
|
+
'inputFeedDocumentId': string;
|
|
212
|
+
/**
|
|
213
|
+
* Additional options to control the feed. These vary by feed type.
|
|
214
|
+
*/
|
|
215
|
+
'feedOptions'?: {
|
|
216
|
+
[key: string]: string;
|
|
217
|
+
};
|
|
226
218
|
}
|
|
227
|
-
|
|
219
|
+
//#endregion
|
|
220
|
+
//#region src/api-model/models/error-list.d.ts
|
|
228
221
|
/**
|
|
229
222
|
* Selling Partner API for Feeds
|
|
230
223
|
* The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
|
|
@@ -240,12 +233,13 @@ interface CreateFeedSpecification {
|
|
|
240
233
|
* A list of error responses returned when a request is unsuccessful.
|
|
241
234
|
*/
|
|
242
235
|
interface ErrorList {
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
236
|
+
/**
|
|
237
|
+
* An error response returned when the request is unsuccessful.
|
|
238
|
+
*/
|
|
239
|
+
'errors': Array<Error>;
|
|
247
240
|
}
|
|
248
|
-
|
|
241
|
+
//#endregion
|
|
242
|
+
//#region src/api-model/models/feed.d.ts
|
|
249
243
|
/**
|
|
250
244
|
* Selling Partner API for Feeds
|
|
251
245
|
* The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
|
|
@@ -261,48 +255,49 @@ interface ErrorList {
|
|
|
261
255
|
* Detailed information about the feed.
|
|
262
256
|
*/
|
|
263
257
|
interface Feed {
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
258
|
+
/**
|
|
259
|
+
* The identifier for the feed. This identifier is unique only in combination with a seller ID.
|
|
260
|
+
*/
|
|
261
|
+
'feedId': string;
|
|
262
|
+
/**
|
|
263
|
+
* The feed type.
|
|
264
|
+
*/
|
|
265
|
+
'feedType': string;
|
|
266
|
+
/**
|
|
267
|
+
* A list of identifiers for the marketplaces that the feed is applied to.
|
|
268
|
+
*/
|
|
269
|
+
'marketplaceIds'?: Array<string>;
|
|
270
|
+
/**
|
|
271
|
+
* The date and time when the feed was created, in ISO 8601 date time format.
|
|
272
|
+
*/
|
|
273
|
+
'createdTime': string;
|
|
274
|
+
/**
|
|
275
|
+
* The processing status of the feed.
|
|
276
|
+
*/
|
|
277
|
+
'processingStatus': FeedProcessingStatusEnum;
|
|
278
|
+
/**
|
|
279
|
+
* The date and time when feed processing started, in ISO 8601 date time format.
|
|
280
|
+
*/
|
|
281
|
+
'processingStartTime'?: string;
|
|
282
|
+
/**
|
|
283
|
+
* The date and time when feed processing completed, in ISO 8601 date time format.
|
|
284
|
+
*/
|
|
285
|
+
'processingEndTime'?: string;
|
|
286
|
+
/**
|
|
287
|
+
* The identifier for the feed document. This identifier is unique only in combination with a seller ID.
|
|
288
|
+
*/
|
|
289
|
+
'resultFeedDocumentId'?: string;
|
|
296
290
|
}
|
|
297
291
|
declare const FeedProcessingStatusEnum: {
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
292
|
+
readonly Cancelled: "CANCELLED";
|
|
293
|
+
readonly Done: "DONE";
|
|
294
|
+
readonly Fatal: "FATAL";
|
|
295
|
+
readonly InProgress: "IN_PROGRESS";
|
|
296
|
+
readonly InQueue: "IN_QUEUE";
|
|
303
297
|
};
|
|
304
298
|
type FeedProcessingStatusEnum = typeof FeedProcessingStatusEnum[keyof typeof FeedProcessingStatusEnum];
|
|
305
|
-
|
|
299
|
+
//#endregion
|
|
300
|
+
//#region src/api-model/models/feed-document.d.ts
|
|
306
301
|
/**
|
|
307
302
|
* Selling Partner API for Feeds
|
|
308
303
|
* The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
|
|
@@ -318,50 +313,40 @@ type FeedProcessingStatusEnum = typeof FeedProcessingStatusEnum[keyof typeof Fee
|
|
|
318
313
|
* Information required for the feed document.
|
|
319
314
|
*/
|
|
320
315
|
interface FeedDocument {
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
316
|
+
/**
|
|
317
|
+
* The identifier for the feed document. This identifier is unique only in combination with a seller ID.
|
|
318
|
+
*/
|
|
319
|
+
'feedDocumentId': string;
|
|
320
|
+
/**
|
|
321
|
+
* 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.
|
|
322
|
+
*/
|
|
323
|
+
'url': string;
|
|
324
|
+
/**
|
|
325
|
+
* 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.
|
|
326
|
+
*/
|
|
327
|
+
'compressionAlgorithm'?: FeedDocumentCompressionAlgorithmEnum;
|
|
333
328
|
}
|
|
334
329
|
declare const FeedDocumentCompressionAlgorithmEnum: {
|
|
335
|
-
|
|
330
|
+
readonly Gzip: "GZIP";
|
|
336
331
|
};
|
|
337
332
|
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
|
-
|
|
333
|
+
//#endregion
|
|
334
|
+
//#region src/api-model/models/get-feeds-response.d.ts
|
|
351
335
|
/**
|
|
352
336
|
* Response schema.
|
|
353
337
|
*/
|
|
354
338
|
interface GetFeedsResponse {
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
339
|
+
/**
|
|
340
|
+
* A list of feeds.
|
|
341
|
+
*/
|
|
342
|
+
'feeds': Array<Feed>;
|
|
343
|
+
/**
|
|
344
|
+
* 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.
|
|
345
|
+
*/
|
|
346
|
+
'nextToken'?: string;
|
|
363
347
|
}
|
|
364
|
-
|
|
348
|
+
//#endregion
|
|
349
|
+
//#region src/api-model/models/model-error.d.ts
|
|
365
350
|
/**
|
|
366
351
|
* Selling Partner API for Feeds
|
|
367
352
|
* The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
|
|
@@ -377,316 +362,319 @@ interface GetFeedsResponse {
|
|
|
377
362
|
* An error response returned when the request is unsuccessful.
|
|
378
363
|
*/
|
|
379
364
|
interface ModelError {
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
365
|
+
/**
|
|
366
|
+
* An error code that identifies the type of error that occurred.
|
|
367
|
+
*/
|
|
368
|
+
'code': string;
|
|
369
|
+
/**
|
|
370
|
+
* A message that describes the error condition.
|
|
371
|
+
*/
|
|
372
|
+
'message': string;
|
|
373
|
+
/**
|
|
374
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
375
|
+
*/
|
|
376
|
+
'details'?: string;
|
|
392
377
|
}
|
|
393
|
-
|
|
378
|
+
//#endregion
|
|
379
|
+
//#region src/api-model/api/feeds-api.d.ts
|
|
394
380
|
/**
|
|
395
381
|
* FeedsApi - axios parameter creator
|
|
396
382
|
*/
|
|
397
383
|
declare const FeedsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
384
|
+
/**
|
|
385
|
+
* 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).
|
|
386
|
+
* @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID.
|
|
387
|
+
* @param {*} [options] Override http request option.
|
|
388
|
+
* @throws {RequiredError}
|
|
389
|
+
*/
|
|
390
|
+
cancelFeed: (feedId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
391
|
+
/**
|
|
392
|
+
* 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).
|
|
393
|
+
* @param {CreateFeedSpecification} body Information required to create the feed.
|
|
394
|
+
* @param {*} [options] Override http request option.
|
|
395
|
+
* @throws {RequiredError}
|
|
396
|
+
*/
|
|
397
|
+
createFeed: (body: CreateFeedSpecification, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
398
|
+
/**
|
|
399
|
+
* 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).
|
|
400
|
+
* @param {CreateFeedDocumentSpecification} body Specifies the content type for the createFeedDocument operation.
|
|
401
|
+
* @param {*} [options] Override http request option.
|
|
402
|
+
* @throws {RequiredError}
|
|
403
|
+
*/
|
|
404
|
+
createFeedDocument: (body: CreateFeedDocumentSpecification, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
405
|
+
/**
|
|
406
|
+
* 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).
|
|
407
|
+
* @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID.
|
|
408
|
+
* @param {*} [options] Override http request option.
|
|
409
|
+
* @throws {RequiredError}
|
|
410
|
+
*/
|
|
411
|
+
getFeed: (feedId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
412
|
+
/**
|
|
413
|
+
* 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).
|
|
414
|
+
* @param {string} feedDocumentId The identifier of the feed document.
|
|
415
|
+
* @param {boolean} [enableContentEncodingUrlHeader] When `true`, the Content-Encoding header on the returned URL is set to `gzip` instead of the default `identity` when `compressionAlgorithm` is `GZIP`. This allows automatic decompression by HTTP clients.
|
|
416
|
+
* @param {*} [options] Override http request option.
|
|
417
|
+
* @throws {RequiredError}
|
|
418
|
+
*/
|
|
419
|
+
getFeedDocument: (feedDocumentId: string, enableContentEncodingUrlHeader?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
420
|
+
/**
|
|
421
|
+
* 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).
|
|
422
|
+
* @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.
|
|
423
|
+
* @param {Array<string>} [marketplaceIds] A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify.
|
|
424
|
+
* @param {number} [pageSize] The maximum number of feeds to return in a single call.
|
|
425
|
+
* @param {Array<GetFeedsProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter feeds.
|
|
426
|
+
* @param {string} [createdSince] The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.
|
|
427
|
+
* @param {string} [createdUntil] The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.
|
|
428
|
+
* @param {string} [nextToken] A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.
|
|
429
|
+
* @param {*} [options] Override http request option.
|
|
430
|
+
* @throws {RequiredError}
|
|
431
|
+
*/
|
|
432
|
+
getFeeds: (feedTypes?: Array<string>, marketplaceIds?: Array<string>, pageSize?: number, processingStatuses?: Array<GetFeedsProcessingStatusesEnum>, createdSince?: string, createdUntil?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
447
433
|
};
|
|
448
434
|
/**
|
|
449
435
|
* FeedsApi - functional programming interface
|
|
450
436
|
*/
|
|
451
437
|
declare const FeedsApiFp: (configuration?: Configuration) => {
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
438
|
+
/**
|
|
439
|
+
* 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).
|
|
440
|
+
* @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID.
|
|
441
|
+
* @param {*} [options] Override http request option.
|
|
442
|
+
* @throws {RequiredError}
|
|
443
|
+
*/
|
|
444
|
+
cancelFeed(feedId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
445
|
+
/**
|
|
446
|
+
* 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).
|
|
447
|
+
* @param {CreateFeedSpecification} body Information required to create the feed.
|
|
448
|
+
* @param {*} [options] Override http request option.
|
|
449
|
+
* @throws {RequiredError}
|
|
450
|
+
*/
|
|
451
|
+
createFeed(body: CreateFeedSpecification, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFeedResponse>>;
|
|
452
|
+
/**
|
|
453
|
+
* 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).
|
|
454
|
+
* @param {CreateFeedDocumentSpecification} body Specifies the content type for the createFeedDocument operation.
|
|
455
|
+
* @param {*} [options] Override http request option.
|
|
456
|
+
* @throws {RequiredError}
|
|
457
|
+
*/
|
|
458
|
+
createFeedDocument(body: CreateFeedDocumentSpecification, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFeedDocumentResponse>>;
|
|
459
|
+
/**
|
|
460
|
+
* 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).
|
|
461
|
+
* @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID.
|
|
462
|
+
* @param {*} [options] Override http request option.
|
|
463
|
+
* @throws {RequiredError}
|
|
464
|
+
*/
|
|
465
|
+
getFeed(feedId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Feed>>;
|
|
466
|
+
/**
|
|
467
|
+
* 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).
|
|
468
|
+
* @param {string} feedDocumentId The identifier of the feed document.
|
|
469
|
+
* @param {boolean} [enableContentEncodingUrlHeader] When `true`, the Content-Encoding header on the returned URL is set to `gzip` instead of the default `identity` when `compressionAlgorithm` is `GZIP`. This allows automatic decompression by HTTP clients.
|
|
470
|
+
* @param {*} [options] Override http request option.
|
|
471
|
+
* @throws {RequiredError}
|
|
472
|
+
*/
|
|
473
|
+
getFeedDocument(feedDocumentId: string, enableContentEncodingUrlHeader?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeedDocument>>;
|
|
474
|
+
/**
|
|
475
|
+
* 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).
|
|
476
|
+
* @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.
|
|
477
|
+
* @param {Array<string>} [marketplaceIds] A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify.
|
|
478
|
+
* @param {number} [pageSize] The maximum number of feeds to return in a single call.
|
|
479
|
+
* @param {Array<GetFeedsProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter feeds.
|
|
480
|
+
* @param {string} [createdSince] The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.
|
|
481
|
+
* @param {string} [createdUntil] The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.
|
|
482
|
+
* @param {string} [nextToken] A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.
|
|
483
|
+
* @param {*} [options] Override http request option.
|
|
484
|
+
* @throws {RequiredError}
|
|
485
|
+
*/
|
|
486
|
+
getFeeds(feedTypes?: Array<string>, marketplaceIds?: Array<string>, pageSize?: number, processingStatuses?: Array<GetFeedsProcessingStatusesEnum>, createdSince?: string, createdUntil?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFeedsResponse>>;
|
|
501
487
|
};
|
|
502
488
|
/**
|
|
503
489
|
* FeedsApi - factory interface
|
|
504
490
|
*/
|
|
505
491
|
declare const FeedsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
492
|
+
/**
|
|
493
|
+
* 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).
|
|
494
|
+
* @param {FeedsApiCancelFeedRequest} requestParameters Request parameters.
|
|
495
|
+
* @param {*} [options] Override http request option.
|
|
496
|
+
* @throws {RequiredError}
|
|
497
|
+
*/
|
|
498
|
+
cancelFeed(requestParameters: FeedsApiCancelFeedRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
499
|
+
/**
|
|
500
|
+
* 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).
|
|
501
|
+
* @param {FeedsApiCreateFeedRequest} requestParameters Request parameters.
|
|
502
|
+
* @param {*} [options] Override http request option.
|
|
503
|
+
* @throws {RequiredError}
|
|
504
|
+
*/
|
|
505
|
+
createFeed(requestParameters: FeedsApiCreateFeedRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateFeedResponse>;
|
|
506
|
+
/**
|
|
507
|
+
* 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).
|
|
508
|
+
* @param {FeedsApiCreateFeedDocumentRequest} requestParameters Request parameters.
|
|
509
|
+
* @param {*} [options] Override http request option.
|
|
510
|
+
* @throws {RequiredError}
|
|
511
|
+
*/
|
|
512
|
+
createFeedDocument(requestParameters: FeedsApiCreateFeedDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateFeedDocumentResponse>;
|
|
513
|
+
/**
|
|
514
|
+
* 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).
|
|
515
|
+
* @param {FeedsApiGetFeedRequest} requestParameters Request parameters.
|
|
516
|
+
* @param {*} [options] Override http request option.
|
|
517
|
+
* @throws {RequiredError}
|
|
518
|
+
*/
|
|
519
|
+
getFeed(requestParameters: FeedsApiGetFeedRequest, options?: RawAxiosRequestConfig): AxiosPromise<Feed>;
|
|
520
|
+
/**
|
|
521
|
+
* 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).
|
|
522
|
+
* @param {FeedsApiGetFeedDocumentRequest} requestParameters Request parameters.
|
|
523
|
+
* @param {*} [options] Override http request option.
|
|
524
|
+
* @throws {RequiredError}
|
|
525
|
+
*/
|
|
526
|
+
getFeedDocument(requestParameters: FeedsApiGetFeedDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<FeedDocument>;
|
|
527
|
+
/**
|
|
528
|
+
* 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).
|
|
529
|
+
* @param {FeedsApiGetFeedsRequest} requestParameters Request parameters.
|
|
530
|
+
* @param {*} [options] Override http request option.
|
|
531
|
+
* @throws {RequiredError}
|
|
532
|
+
*/
|
|
533
|
+
getFeeds(requestParameters?: FeedsApiGetFeedsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFeedsResponse>;
|
|
548
534
|
};
|
|
549
535
|
/**
|
|
550
536
|
* Request parameters for cancelFeed operation in FeedsApi.
|
|
551
537
|
*/
|
|
552
538
|
interface FeedsApiCancelFeedRequest {
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
539
|
+
/**
|
|
540
|
+
* The identifier for the feed. This identifier is unique only in combination with a seller ID.
|
|
541
|
+
*/
|
|
542
|
+
readonly feedId: string;
|
|
557
543
|
}
|
|
558
544
|
/**
|
|
559
545
|
* Request parameters for createFeed operation in FeedsApi.
|
|
560
546
|
*/
|
|
561
547
|
interface FeedsApiCreateFeedRequest {
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
548
|
+
/**
|
|
549
|
+
* Information required to create the feed.
|
|
550
|
+
*/
|
|
551
|
+
readonly body: CreateFeedSpecification;
|
|
566
552
|
}
|
|
567
553
|
/**
|
|
568
554
|
* Request parameters for createFeedDocument operation in FeedsApi.
|
|
569
555
|
*/
|
|
570
556
|
interface FeedsApiCreateFeedDocumentRequest {
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
557
|
+
/**
|
|
558
|
+
* Specifies the content type for the createFeedDocument operation.
|
|
559
|
+
*/
|
|
560
|
+
readonly body: CreateFeedDocumentSpecification;
|
|
575
561
|
}
|
|
576
562
|
/**
|
|
577
563
|
* Request parameters for getFeed operation in FeedsApi.
|
|
578
564
|
*/
|
|
579
565
|
interface FeedsApiGetFeedRequest {
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
566
|
+
/**
|
|
567
|
+
* The identifier for the feed. This identifier is unique only in combination with a seller ID.
|
|
568
|
+
*/
|
|
569
|
+
readonly feedId: string;
|
|
584
570
|
}
|
|
585
571
|
/**
|
|
586
572
|
* Request parameters for getFeedDocument operation in FeedsApi.
|
|
587
573
|
*/
|
|
588
574
|
interface FeedsApiGetFeedDocumentRequest {
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
575
|
+
/**
|
|
576
|
+
* The identifier of the feed document.
|
|
577
|
+
*/
|
|
578
|
+
readonly feedDocumentId: string;
|
|
579
|
+
/**
|
|
580
|
+
* When `true`, the Content-Encoding header on the returned URL is set to `gzip` instead of the default `identity` when `compressionAlgorithm` is `GZIP`. This allows automatic decompression by HTTP clients.
|
|
581
|
+
*/
|
|
582
|
+
readonly enableContentEncodingUrlHeader?: boolean;
|
|
597
583
|
}
|
|
598
584
|
/**
|
|
599
585
|
* Request parameters for getFeeds operation in FeedsApi.
|
|
600
586
|
*/
|
|
601
587
|
interface FeedsApiGetFeedsRequest {
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
588
|
+
/**
|
|
589
|
+
* 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.
|
|
590
|
+
*/
|
|
591
|
+
readonly feedTypes?: Array<string>;
|
|
592
|
+
/**
|
|
593
|
+
* A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify.
|
|
594
|
+
*/
|
|
595
|
+
readonly marketplaceIds?: Array<string>;
|
|
596
|
+
/**
|
|
597
|
+
* The maximum number of feeds to return in a single call.
|
|
598
|
+
*/
|
|
599
|
+
readonly pageSize?: number;
|
|
600
|
+
/**
|
|
601
|
+
* A list of processing statuses used to filter feeds.
|
|
602
|
+
*/
|
|
603
|
+
readonly processingStatuses?: Array<GetFeedsProcessingStatusesEnum>;
|
|
604
|
+
/**
|
|
605
|
+
* The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.
|
|
606
|
+
*/
|
|
607
|
+
readonly createdSince?: string;
|
|
608
|
+
/**
|
|
609
|
+
* The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.
|
|
610
|
+
*/
|
|
611
|
+
readonly createdUntil?: string;
|
|
612
|
+
/**
|
|
613
|
+
* A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.
|
|
614
|
+
*/
|
|
615
|
+
readonly nextToken?: string;
|
|
630
616
|
}
|
|
631
617
|
/**
|
|
632
618
|
* FeedsApi - object-oriented interface
|
|
633
619
|
*/
|
|
634
620
|
declare class FeedsApi extends BaseAPI {
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
621
|
+
/**
|
|
622
|
+
* 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).
|
|
623
|
+
* @param {FeedsApiCancelFeedRequest} requestParameters Request parameters.
|
|
624
|
+
* @param {*} [options] Override http request option.
|
|
625
|
+
* @throws {RequiredError}
|
|
626
|
+
*/
|
|
627
|
+
cancelFeed(requestParameters: FeedsApiCancelFeedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
628
|
+
/**
|
|
629
|
+
* 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).
|
|
630
|
+
* @param {FeedsApiCreateFeedRequest} requestParameters Request parameters.
|
|
631
|
+
* @param {*} [options] Override http request option.
|
|
632
|
+
* @throws {RequiredError}
|
|
633
|
+
*/
|
|
634
|
+
createFeed(requestParameters: FeedsApiCreateFeedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFeedResponse, any, {}>>;
|
|
635
|
+
/**
|
|
636
|
+
* 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).
|
|
637
|
+
* @param {FeedsApiCreateFeedDocumentRequest} requestParameters Request parameters.
|
|
638
|
+
* @param {*} [options] Override http request option.
|
|
639
|
+
* @throws {RequiredError}
|
|
640
|
+
*/
|
|
641
|
+
createFeedDocument(requestParameters: FeedsApiCreateFeedDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFeedDocumentResponse, any, {}>>;
|
|
642
|
+
/**
|
|
643
|
+
* 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).
|
|
644
|
+
* @param {FeedsApiGetFeedRequest} requestParameters Request parameters.
|
|
645
|
+
* @param {*} [options] Override http request option.
|
|
646
|
+
* @throws {RequiredError}
|
|
647
|
+
*/
|
|
648
|
+
getFeed(requestParameters: FeedsApiGetFeedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Feed, any, {}>>;
|
|
649
|
+
/**
|
|
650
|
+
* 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).
|
|
651
|
+
* @param {FeedsApiGetFeedDocumentRequest} requestParameters Request parameters.
|
|
652
|
+
* @param {*} [options] Override http request option.
|
|
653
|
+
* @throws {RequiredError}
|
|
654
|
+
*/
|
|
655
|
+
getFeedDocument(requestParameters: FeedsApiGetFeedDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FeedDocument, any, {}>>;
|
|
656
|
+
/**
|
|
657
|
+
* 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).
|
|
658
|
+
* @param {FeedsApiGetFeedsRequest} requestParameters Request parameters.
|
|
659
|
+
* @param {*} [options] Override http request option.
|
|
660
|
+
* @throws {RequiredError}
|
|
661
|
+
*/
|
|
662
|
+
getFeeds(requestParameters?: FeedsApiGetFeedsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFeedsResponse, any, {}>>;
|
|
677
663
|
}
|
|
678
664
|
declare const GetFeedsProcessingStatusesEnum: {
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
665
|
+
readonly Cancelled: "CANCELLED";
|
|
666
|
+
readonly Done: "DONE";
|
|
667
|
+
readonly Fatal: "FATAL";
|
|
668
|
+
readonly InProgress: "IN_PROGRESS";
|
|
669
|
+
readonly InQueue: "IN_QUEUE";
|
|
684
670
|
};
|
|
685
671
|
type GetFeedsProcessingStatusesEnum = typeof GetFeedsProcessingStatusesEnum[keyof typeof GetFeedsProcessingStatusesEnum];
|
|
686
|
-
|
|
672
|
+
//#endregion
|
|
673
|
+
//#region src/client.d.ts
|
|
687
674
|
declare const clientRateLimits: RateLimit[];
|
|
688
675
|
declare class FeedsApiClient extends FeedsApi {
|
|
689
|
-
|
|
676
|
+
constructor(configuration: ClientConfiguration);
|
|
690
677
|
}
|
|
691
|
-
|
|
692
|
-
export {
|
|
678
|
+
//#endregion
|
|
679
|
+
export { CreateFeedDocumentResponse, CreateFeedDocumentSpecification, CreateFeedResponse, CreateFeedSpecification, ErrorList, Feed, FeedDocument, FeedDocumentCompressionAlgorithmEnum, FeedProcessingStatusEnum, FeedsApi, FeedsApiAxiosParamCreator, FeedsApiCancelFeedRequest, FeedsApiClient, FeedsApiCreateFeedDocumentRequest, FeedsApiCreateFeedRequest, FeedsApiFactory, FeedsApiFp, FeedsApiGetFeedDocumentRequest, FeedsApiGetFeedRequest, FeedsApiGetFeedsRequest, GetFeedsProcessingStatusesEnum, GetFeedsResponse, ModelError, clientRateLimits };
|
|
680
|
+
//# sourceMappingURL=index.d.cts.map
|