@sp-api-sdk/aplus-content-api-2020-11-01 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 +1143 -1052
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1025 -1601
- package/dist/index.d.ts +1025 -1601
- package/dist/index.js +1110 -1006
- package/dist/index.js.map +1 -1
- package/package.json +7 -4
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import { ClientConfiguration, RateLimit } from
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
|
|
2
|
+
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
|
+
//#region src/api-model/models/aplus-response.d.ts
|
|
5
4
|
/**
|
|
6
5
|
* Selling Partner API for A+ Content Management
|
|
7
6
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -17,12 +16,13 @@ import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
|
|
|
17
16
|
* The base response data for all A+ Content operations when a request is successful or partially successful. Individual operations can extend this with additional data.
|
|
18
17
|
*/
|
|
19
18
|
interface AplusResponse {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
19
|
+
/**
|
|
20
|
+
* A set of messages to the user, such as warnings or comments.
|
|
21
|
+
*/
|
|
22
|
+
'warnings'?: Set<Error>;
|
|
24
23
|
}
|
|
25
|
-
|
|
24
|
+
//#endregion
|
|
25
|
+
//#region src/api-model/configuration.d.ts
|
|
26
26
|
/**
|
|
27
27
|
* Selling Partner API for A+ Content Management
|
|
28
28
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -35,115 +35,105 @@ interface AplusResponse {
|
|
|
35
35
|
* Do not edit the class manually.
|
|
36
36
|
*/
|
|
37
37
|
interface AWSv4Configuration {
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
38
|
+
options?: {
|
|
39
|
+
region?: string;
|
|
40
|
+
service?: string;
|
|
41
|
+
};
|
|
42
|
+
credentials?: {
|
|
43
|
+
accessKeyId?: string;
|
|
44
|
+
secretAccessKey?: string;
|
|
45
|
+
sessionToken?: string;
|
|
46
|
+
};
|
|
47
47
|
}
|
|
48
48
|
interface ConfigurationParameters {
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
49
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
50
|
+
username?: string;
|
|
51
|
+
password?: string;
|
|
52
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
53
|
+
awsv4?: AWSv4Configuration;
|
|
54
|
+
basePath?: string;
|
|
55
|
+
serverIndex?: number;
|
|
56
|
+
baseOptions?: any;
|
|
57
|
+
formDataCtor?: new () => any;
|
|
58
58
|
}
|
|
59
59
|
declare class Configuration {
|
|
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
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
* Selling Partner API for A+ Content Management
|
|
126
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
127
|
-
*
|
|
128
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
132
|
-
* https://openapi-generator.tech
|
|
133
|
-
* Do not edit the class manually.
|
|
134
|
-
*/
|
|
135
|
-
|
|
60
|
+
/**
|
|
61
|
+
* parameter for apiKey security
|
|
62
|
+
* @param name security name
|
|
63
|
+
*/
|
|
64
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
65
|
+
/**
|
|
66
|
+
* parameter for basic security
|
|
67
|
+
*/
|
|
68
|
+
username?: string;
|
|
69
|
+
/**
|
|
70
|
+
* parameter for basic security
|
|
71
|
+
*/
|
|
72
|
+
password?: string;
|
|
73
|
+
/**
|
|
74
|
+
* parameter for oauth2 security
|
|
75
|
+
* @param name security name
|
|
76
|
+
* @param scopes oauth2 scope
|
|
77
|
+
*/
|
|
78
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
79
|
+
/**
|
|
80
|
+
* parameter for aws4 signature security
|
|
81
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
82
|
+
* @param {string} options.region - aws region
|
|
83
|
+
* @param {string} options.service - name of the service.
|
|
84
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
85
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
86
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
87
|
+
* @memberof Configuration
|
|
88
|
+
*/
|
|
89
|
+
awsv4?: AWSv4Configuration;
|
|
90
|
+
/**
|
|
91
|
+
* override base path
|
|
92
|
+
*/
|
|
93
|
+
basePath?: string;
|
|
94
|
+
/**
|
|
95
|
+
* override server index
|
|
96
|
+
*/
|
|
97
|
+
serverIndex?: number;
|
|
98
|
+
/**
|
|
99
|
+
* base options for axios calls
|
|
100
|
+
*/
|
|
101
|
+
baseOptions?: any;
|
|
102
|
+
/**
|
|
103
|
+
* The FormData constructor that will be used to create multipart form data
|
|
104
|
+
* requests. You can inject this here so that execution environments that
|
|
105
|
+
* do not support the FormData class can still run the generated client.
|
|
106
|
+
*
|
|
107
|
+
* @type {new () => FormData}
|
|
108
|
+
*/
|
|
109
|
+
formDataCtor?: new () => any;
|
|
110
|
+
constructor(param?: ConfigurationParameters);
|
|
111
|
+
/**
|
|
112
|
+
* Check if the given MIME is a JSON MIME.
|
|
113
|
+
* JSON MIME examples:
|
|
114
|
+
* application/json
|
|
115
|
+
* application/json; charset=UTF8
|
|
116
|
+
* APPLICATION/JSON
|
|
117
|
+
* application/vnd.company+json
|
|
118
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
119
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
120
|
+
*/
|
|
121
|
+
isJsonMime(mime: string): boolean;
|
|
122
|
+
}
|
|
123
|
+
//#endregion
|
|
124
|
+
//#region src/api-model/base.d.ts
|
|
136
125
|
interface RequestArgs {
|
|
137
|
-
|
|
138
|
-
|
|
126
|
+
url: string;
|
|
127
|
+
options: RawAxiosRequestConfig;
|
|
139
128
|
}
|
|
140
129
|
declare class BaseAPI {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
130
|
+
protected basePath: string;
|
|
131
|
+
protected axios: AxiosInstance;
|
|
132
|
+
protected configuration: Configuration | undefined;
|
|
133
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
145
134
|
}
|
|
146
|
-
|
|
135
|
+
//#endregion
|
|
136
|
+
//#region src/api-model/models/aplus-paginated-response-all-of.d.ts
|
|
147
137
|
/**
|
|
148
138
|
* Selling Partner API for A+ Content Management
|
|
149
139
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -156,30 +146,20 @@ declare class BaseAPI {
|
|
|
156
146
|
* Do not edit the class manually.
|
|
157
147
|
*/
|
|
158
148
|
interface AplusPaginatedResponseAllOf {
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
149
|
+
/**
|
|
150
|
+
* A token that you use to fetch a specific page when there are multiple pages of results.
|
|
151
|
+
*/
|
|
152
|
+
'nextPageToken'?: string;
|
|
163
153
|
}
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
* Selling Partner API for A+ Content Management
|
|
167
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
168
|
-
*
|
|
169
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
173
|
-
* https://openapi-generator.tech
|
|
174
|
-
* Do not edit the class manually.
|
|
175
|
-
*/
|
|
176
|
-
|
|
154
|
+
//#endregion
|
|
155
|
+
//#region src/api-model/models/aplus-paginated-response.d.ts
|
|
177
156
|
/**
|
|
178
157
|
* @type AplusPaginatedResponse
|
|
179
158
|
* A token that you use to retrieve the next page of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextPageToken` is null. Note that this operation can return empty pages.
|
|
180
159
|
*/
|
|
181
160
|
type AplusPaginatedResponse = AplusPaginatedResponseAllOf & AplusResponse;
|
|
182
|
-
|
|
161
|
+
//#endregion
|
|
162
|
+
//#region src/api-model/models/asin-badge.d.ts
|
|
183
163
|
/**
|
|
184
164
|
* Selling Partner API for A+ Content Management
|
|
185
165
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -195,55 +175,45 @@ type AplusPaginatedResponse = AplusPaginatedResponseAllOf & AplusResponse;
|
|
|
195
175
|
* A flag that provides additional information about an ASIN. This is contextual and can change depending on the request that generated it.
|
|
196
176
|
*/
|
|
197
177
|
declare const AsinBadge: {
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
178
|
+
readonly BrandNotEligible: "BRAND_NOT_ELIGIBLE";
|
|
179
|
+
readonly CatalogNotFound: "CATALOG_NOT_FOUND";
|
|
180
|
+
readonly ContentNotPublished: "CONTENT_NOT_PUBLISHED";
|
|
181
|
+
readonly ContentPublished: "CONTENT_PUBLISHED";
|
|
202
182
|
};
|
|
203
183
|
type AsinBadge = typeof AsinBadge[keyof typeof AsinBadge];
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
* Selling Partner API for A+ Content Management
|
|
207
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
208
|
-
*
|
|
209
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
213
|
-
* https://openapi-generator.tech
|
|
214
|
-
* Do not edit the class manually.
|
|
215
|
-
*/
|
|
216
|
-
|
|
184
|
+
//#endregion
|
|
185
|
+
//#region src/api-model/models/asin-metadata.d.ts
|
|
217
186
|
/**
|
|
218
187
|
* The A+ Content ASIN with additional metadata for content management. If you don\'t include the `includedDataSet` parameter in a call to the `listContentDocumentAsinRelations` operation, the related ASINs are returned without metadata.
|
|
219
188
|
*/
|
|
220
189
|
interface AsinMetadata {
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
}
|
|
246
|
-
|
|
190
|
+
/**
|
|
191
|
+
* The Amazon Standard Identification Number (ASIN).
|
|
192
|
+
*/
|
|
193
|
+
'asin': string;
|
|
194
|
+
/**
|
|
195
|
+
* The set of ASIN badges.
|
|
196
|
+
*/
|
|
197
|
+
'badgeSet'?: Set<AsinBadge>;
|
|
198
|
+
/**
|
|
199
|
+
* The Amazon Standard Identification Number (ASIN).
|
|
200
|
+
*/
|
|
201
|
+
'parent'?: string;
|
|
202
|
+
/**
|
|
203
|
+
* The title for the ASIN in the Amazon catalog.
|
|
204
|
+
*/
|
|
205
|
+
'title'?: string;
|
|
206
|
+
/**
|
|
207
|
+
* The default image for the ASIN in the Amazon catalog.
|
|
208
|
+
*/
|
|
209
|
+
'imageUrl'?: string;
|
|
210
|
+
/**
|
|
211
|
+
* A set of content reference keys.
|
|
212
|
+
*/
|
|
213
|
+
'contentReferenceKeySet'?: Set<string>;
|
|
214
|
+
}
|
|
215
|
+
//#endregion
|
|
216
|
+
//#region src/api-model/models/color-type.d.ts
|
|
247
217
|
/**
|
|
248
218
|
* Selling Partner API for A+ Content Management
|
|
249
219
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -259,11 +229,12 @@ interface AsinMetadata {
|
|
|
259
229
|
* The relative color scheme of your content.
|
|
260
230
|
*/
|
|
261
231
|
declare const ColorType: {
|
|
262
|
-
|
|
263
|
-
|
|
232
|
+
readonly Dark: "DARK";
|
|
233
|
+
readonly Light: "LIGHT";
|
|
264
234
|
};
|
|
265
235
|
type ColorType = typeof ColorType[keyof typeof ColorType];
|
|
266
|
-
|
|
236
|
+
//#endregion
|
|
237
|
+
//#region src/api-model/models/content-badge.d.ts
|
|
267
238
|
/**
|
|
268
239
|
* Selling Partner API for A+ Content Management
|
|
269
240
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -279,14 +250,15 @@ type ColorType = typeof ColorType[keyof typeof ColorType];
|
|
|
279
250
|
* A flag that provides additional information about an A+ Content document.
|
|
280
251
|
*/
|
|
281
252
|
declare const ContentBadge: {
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
253
|
+
readonly Bulk: "BULK";
|
|
254
|
+
readonly Generated: "GENERATED";
|
|
255
|
+
readonly Launchpad: "LAUNCHPAD";
|
|
256
|
+
readonly Premium: "PREMIUM";
|
|
257
|
+
readonly Standard: "STANDARD";
|
|
287
258
|
};
|
|
288
259
|
type ContentBadge = typeof ContentBadge[keyof typeof ContentBadge];
|
|
289
|
-
|
|
260
|
+
//#endregion
|
|
261
|
+
//#region src/api-model/models/content-module-type.d.ts
|
|
290
262
|
/**
|
|
291
263
|
* Selling Partner API for A+ Content Management
|
|
292
264
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -302,24 +274,25 @@ type ContentBadge = typeof ContentBadge[keyof typeof ContentBadge];
|
|
|
302
274
|
* The type of A+ Content module.
|
|
303
275
|
*/
|
|
304
276
|
declare const ContentModuleType: {
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
277
|
+
readonly StandardCompanyLogo: "STANDARD_COMPANY_LOGO";
|
|
278
|
+
readonly StandardComparisonTable: "STANDARD_COMPARISON_TABLE";
|
|
279
|
+
readonly StandardFourImageText: "STANDARD_FOUR_IMAGE_TEXT";
|
|
280
|
+
readonly StandardFourImageTextQuadrant: "STANDARD_FOUR_IMAGE_TEXT_QUADRANT";
|
|
281
|
+
readonly StandardHeaderImageText: "STANDARD_HEADER_IMAGE_TEXT";
|
|
282
|
+
readonly StandardImageSidebar: "STANDARD_IMAGE_SIDEBAR";
|
|
283
|
+
readonly StandardImageTextOverlay: "STANDARD_IMAGE_TEXT_OVERLAY";
|
|
284
|
+
readonly StandardMultipleImageText: "STANDARD_MULTIPLE_IMAGE_TEXT";
|
|
285
|
+
readonly StandardProductDescription: "STANDARD_PRODUCT_DESCRIPTION";
|
|
286
|
+
readonly StandardSingleImageHighlights: "STANDARD_SINGLE_IMAGE_HIGHLIGHTS";
|
|
287
|
+
readonly StandardSingleImageSpecsDetail: "STANDARD_SINGLE_IMAGE_SPECS_DETAIL";
|
|
288
|
+
readonly StandardSingleSideImage: "STANDARD_SINGLE_SIDE_IMAGE";
|
|
289
|
+
readonly StandardTechSpecs: "STANDARD_TECH_SPECS";
|
|
290
|
+
readonly StandardText: "STANDARD_TEXT";
|
|
291
|
+
readonly StandardThreeImageText: "STANDARD_THREE_IMAGE_TEXT";
|
|
320
292
|
};
|
|
321
293
|
type ContentModuleType = typeof ContentModuleType[keyof typeof ContentModuleType];
|
|
322
|
-
|
|
294
|
+
//#endregion
|
|
295
|
+
//#region src/api-model/models/integer-with-units.d.ts
|
|
323
296
|
/**
|
|
324
297
|
* Selling Partner API for A+ Content Management
|
|
325
298
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -335,122 +308,68 @@ type ContentModuleType = typeof ContentModuleType[keyof typeof ContentModuleType
|
|
|
335
308
|
* A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.
|
|
336
309
|
*/
|
|
337
310
|
interface IntegerWithUnits {
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
}
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
* Selling Partner API for A+ Content Management
|
|
350
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
351
|
-
*
|
|
352
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
353
|
-
*
|
|
354
|
-
*
|
|
355
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
356
|
-
* https://openapi-generator.tech
|
|
357
|
-
* Do not edit the class manually.
|
|
358
|
-
*/
|
|
359
|
-
|
|
311
|
+
/**
|
|
312
|
+
* The dimension value.
|
|
313
|
+
*/
|
|
314
|
+
'value': number;
|
|
315
|
+
/**
|
|
316
|
+
* The unit of measurement.
|
|
317
|
+
*/
|
|
318
|
+
'units': string;
|
|
319
|
+
}
|
|
320
|
+
//#endregion
|
|
321
|
+
//#region src/api-model/models/image-dimensions.d.ts
|
|
360
322
|
/**
|
|
361
323
|
* The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.
|
|
362
324
|
*/
|
|
363
325
|
interface ImageDimensions {
|
|
364
|
-
|
|
365
|
-
|
|
326
|
+
'width': IntegerWithUnits;
|
|
327
|
+
'height': IntegerWithUnits;
|
|
366
328
|
}
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
* Selling Partner API for A+ Content Management
|
|
370
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
371
|
-
*
|
|
372
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
376
|
-
* https://openapi-generator.tech
|
|
377
|
-
* Do not edit the class manually.
|
|
378
|
-
*/
|
|
379
|
-
|
|
329
|
+
//#endregion
|
|
330
|
+
//#region src/api-model/models/image-offsets.d.ts
|
|
380
331
|
/**
|
|
381
332
|
* The top left corner of the cropped image, specified in the original image\'s coordinate space.
|
|
382
333
|
*/
|
|
383
334
|
interface ImageOffsets {
|
|
384
|
-
|
|
385
|
-
|
|
335
|
+
'x': IntegerWithUnits;
|
|
336
|
+
'y': IntegerWithUnits;
|
|
386
337
|
}
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
* Selling Partner API for A+ Content Management
|
|
390
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
391
|
-
*
|
|
392
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
396
|
-
* https://openapi-generator.tech
|
|
397
|
-
* Do not edit the class manually.
|
|
398
|
-
*/
|
|
399
|
-
|
|
338
|
+
//#endregion
|
|
339
|
+
//#region src/api-model/models/image-crop-specification.d.ts
|
|
400
340
|
/**
|
|
401
341
|
* The instructions for optionally cropping an image. If you don\'t want to crop the image, set the dimensions to the original image size. If the image is cropped and you don\'t include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.
|
|
402
342
|
*/
|
|
403
343
|
interface ImageCropSpecification {
|
|
404
|
-
|
|
405
|
-
|
|
344
|
+
'size': ImageDimensions;
|
|
345
|
+
'offset'?: ImageOffsets;
|
|
406
346
|
}
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
* Selling Partner API for A+ Content Management
|
|
410
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
411
|
-
*
|
|
412
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
416
|
-
* https://openapi-generator.tech
|
|
417
|
-
* Do not edit the class manually.
|
|
418
|
-
*/
|
|
419
|
-
|
|
347
|
+
//#endregion
|
|
348
|
+
//#region src/api-model/models/image-component.d.ts
|
|
420
349
|
/**
|
|
421
350
|
* A reference to an image, hosted in the A+ Content media library.
|
|
422
351
|
*/
|
|
423
352
|
interface ImageComponent {
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
}
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
* Selling Partner API for A+ Content Management
|
|
437
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
438
|
-
*
|
|
439
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
443
|
-
* https://openapi-generator.tech
|
|
444
|
-
* Do not edit the class manually.
|
|
445
|
-
*/
|
|
446
|
-
|
|
353
|
+
/**
|
|
354
|
+
* This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).
|
|
355
|
+
*/
|
|
356
|
+
'uploadDestinationId': string;
|
|
357
|
+
'imageCropSpecification': ImageCropSpecification;
|
|
358
|
+
/**
|
|
359
|
+
* The alternative text for the image.
|
|
360
|
+
*/
|
|
361
|
+
'altText': string;
|
|
362
|
+
}
|
|
363
|
+
//#endregion
|
|
364
|
+
//#region src/api-model/models/standard-company-logo-module.d.ts
|
|
447
365
|
/**
|
|
448
366
|
* The standard company logo image.
|
|
449
367
|
*/
|
|
450
368
|
interface StandardCompanyLogoModule {
|
|
451
|
-
|
|
369
|
+
'companyLogo': ImageComponent;
|
|
452
370
|
}
|
|
453
|
-
|
|
371
|
+
//#endregion
|
|
372
|
+
//#region src/api-model/models/plain-text-item.d.ts
|
|
454
373
|
/**
|
|
455
374
|
* Selling Partner API for A+ Content Management
|
|
456
375
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -466,75 +385,54 @@ interface StandardCompanyLogoModule {
|
|
|
466
385
|
* Plain positional text that is used in collections of brief labels and descriptors.
|
|
467
386
|
*/
|
|
468
387
|
interface PlainTextItem {
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
}
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
* Selling Partner API for A+ Content Management
|
|
481
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
482
|
-
*
|
|
483
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
484
|
-
*
|
|
485
|
-
*
|
|
486
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
487
|
-
* https://openapi-generator.tech
|
|
488
|
-
* Do not edit the class manually.
|
|
489
|
-
*/
|
|
490
|
-
|
|
388
|
+
/**
|
|
389
|
+
* The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection.
|
|
390
|
+
*/
|
|
391
|
+
'position': number;
|
|
392
|
+
/**
|
|
393
|
+
* The actual plain text.
|
|
394
|
+
*/
|
|
395
|
+
'value': string;
|
|
396
|
+
}
|
|
397
|
+
//#endregion
|
|
398
|
+
//#region src/api-model/models/standard-comparison-product-block.d.ts
|
|
491
399
|
/**
|
|
492
400
|
* The A+ Content standard comparison product block.
|
|
493
401
|
*/
|
|
494
402
|
interface StandardComparisonProductBlock {
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
}
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
* Selling Partner API for A+ Content Management
|
|
520
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
521
|
-
*
|
|
522
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
523
|
-
*
|
|
524
|
-
*
|
|
525
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
526
|
-
* https://openapi-generator.tech
|
|
527
|
-
* Do not edit the class manually.
|
|
528
|
-
*/
|
|
529
|
-
|
|
403
|
+
/**
|
|
404
|
+
* The rank or index of this comparison product block within the module. Different blocks cannot occupy the same position within a single module.
|
|
405
|
+
*/
|
|
406
|
+
'position': number;
|
|
407
|
+
'image'?: ImageComponent;
|
|
408
|
+
/**
|
|
409
|
+
* The comparison product title.
|
|
410
|
+
*/
|
|
411
|
+
'title'?: string;
|
|
412
|
+
/**
|
|
413
|
+
* The Amazon Standard Identification Number (ASIN).
|
|
414
|
+
*/
|
|
415
|
+
'asin'?: string;
|
|
416
|
+
/**
|
|
417
|
+
* When true, indicates that this content block is visually highlighted.
|
|
418
|
+
*/
|
|
419
|
+
'highlight'?: boolean;
|
|
420
|
+
/**
|
|
421
|
+
* Comparison metrics for the product.
|
|
422
|
+
*/
|
|
423
|
+
'metrics'?: Array<PlainTextItem>;
|
|
424
|
+
}
|
|
425
|
+
//#endregion
|
|
426
|
+
//#region src/api-model/models/standard-comparison-table-module.d.ts
|
|
530
427
|
/**
|
|
531
428
|
* The standard product comparison table.
|
|
532
429
|
*/
|
|
533
430
|
interface StandardComparisonTableModule {
|
|
534
|
-
|
|
535
|
-
|
|
431
|
+
'productColumns'?: Array<StandardComparisonProductBlock>;
|
|
432
|
+
'metricRowLabels'?: Array<PlainTextItem>;
|
|
536
433
|
}
|
|
537
|
-
|
|
434
|
+
//#endregion
|
|
435
|
+
//#region src/api-model/models/decorator-type.d.ts
|
|
538
436
|
/**
|
|
539
437
|
* Selling Partner API for A+ Content Management
|
|
540
438
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -550,433 +448,225 @@ interface StandardComparisonTableModule {
|
|
|
550
448
|
* The type of rich text decorator.
|
|
551
449
|
*/
|
|
552
450
|
declare const DecoratorType: {
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
451
|
+
readonly ListItem: "LIST_ITEM";
|
|
452
|
+
readonly ListOrdered: "LIST_ORDERED";
|
|
453
|
+
readonly ListUnordered: "LIST_UNORDERED";
|
|
454
|
+
readonly StyleBold: "STYLE_BOLD";
|
|
455
|
+
readonly StyleItalic: "STYLE_ITALIC";
|
|
456
|
+
readonly StyleLinebreak: "STYLE_LINEBREAK";
|
|
457
|
+
readonly StyleParagraph: "STYLE_PARAGRAPH";
|
|
458
|
+
readonly StyleUnderline: "STYLE_UNDERLINE";
|
|
561
459
|
};
|
|
562
460
|
type DecoratorType = typeof DecoratorType[keyof typeof DecoratorType];
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
* Selling Partner API for A+ Content Management
|
|
566
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
567
|
-
*
|
|
568
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
569
|
-
*
|
|
570
|
-
*
|
|
571
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
572
|
-
* https://openapi-generator.tech
|
|
573
|
-
* Do not edit the class manually.
|
|
574
|
-
*/
|
|
575
|
-
|
|
461
|
+
//#endregion
|
|
462
|
+
//#region src/api-model/models/decorator.d.ts
|
|
576
463
|
/**
|
|
577
464
|
* A decorator that is applied to a content string value in order to create rich text.
|
|
578
465
|
*/
|
|
579
466
|
interface Decorator {
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
}
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
* Selling Partner API for A+ Content Management
|
|
597
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
598
|
-
*
|
|
599
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
600
|
-
*
|
|
601
|
-
*
|
|
602
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
603
|
-
* https://openapi-generator.tech
|
|
604
|
-
* Do not edit the class manually.
|
|
605
|
-
*/
|
|
606
|
-
|
|
467
|
+
'type'?: DecoratorType;
|
|
468
|
+
/**
|
|
469
|
+
* The starting value of this decorator within the content string. Use zero (`0`) for the first value.
|
|
470
|
+
*/
|
|
471
|
+
'offset'?: number;
|
|
472
|
+
/**
|
|
473
|
+
* The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters.
|
|
474
|
+
*/
|
|
475
|
+
'length'?: number;
|
|
476
|
+
/**
|
|
477
|
+
* The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths.
|
|
478
|
+
*/
|
|
479
|
+
'depth'?: number;
|
|
480
|
+
}
|
|
481
|
+
//#endregion
|
|
482
|
+
//#region src/api-model/models/text-component.d.ts
|
|
607
483
|
/**
|
|
608
484
|
* Rich text content.
|
|
609
485
|
*/
|
|
610
486
|
interface TextComponent {
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
}
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
* Selling Partner API for A+ Content Management
|
|
623
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
624
|
-
*
|
|
625
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
626
|
-
*
|
|
627
|
-
*
|
|
628
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
629
|
-
* https://openapi-generator.tech
|
|
630
|
-
* Do not edit the class manually.
|
|
631
|
-
*/
|
|
632
|
-
|
|
487
|
+
/**
|
|
488
|
+
* The actual plain text.
|
|
489
|
+
*/
|
|
490
|
+
'value': string;
|
|
491
|
+
/**
|
|
492
|
+
* A set of content decorators.
|
|
493
|
+
*/
|
|
494
|
+
'decoratorSet'?: Set<Decorator>;
|
|
495
|
+
}
|
|
496
|
+
//#endregion
|
|
497
|
+
//#region src/api-model/models/paragraph-component.d.ts
|
|
633
498
|
/**
|
|
634
499
|
* A list of rich text content that is typically presented in a text box.
|
|
635
500
|
*/
|
|
636
501
|
interface ParagraphComponent {
|
|
637
|
-
|
|
502
|
+
'textList': Array<TextComponent>;
|
|
638
503
|
}
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
* Selling Partner API for A+ Content Management
|
|
642
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
643
|
-
*
|
|
644
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
645
|
-
*
|
|
646
|
-
*
|
|
647
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
648
|
-
* https://openapi-generator.tech
|
|
649
|
-
* Do not edit the class manually.
|
|
650
|
-
*/
|
|
651
|
-
|
|
504
|
+
//#endregion
|
|
505
|
+
//#region src/api-model/models/standard-image-text-block.d.ts
|
|
652
506
|
/**
|
|
653
507
|
* The A+ Content standard image and text box block.
|
|
654
508
|
*/
|
|
655
509
|
interface StandardImageTextBlock {
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
510
|
+
'image'?: ImageComponent;
|
|
511
|
+
'headline'?: TextComponent;
|
|
512
|
+
'body'?: ParagraphComponent;
|
|
659
513
|
}
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
* Selling Partner API for A+ Content Management
|
|
663
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
664
|
-
*
|
|
665
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
666
|
-
*
|
|
667
|
-
*
|
|
668
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
669
|
-
* https://openapi-generator.tech
|
|
670
|
-
* Do not edit the class manually.
|
|
671
|
-
*/
|
|
672
|
-
|
|
514
|
+
//#endregion
|
|
515
|
+
//#region src/api-model/models/standard-four-image-text-module.d.ts
|
|
673
516
|
/**
|
|
674
517
|
* Four standard images with text, presented across a single row.
|
|
675
518
|
*/
|
|
676
519
|
interface StandardFourImageTextModule {
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
520
|
+
'headline'?: TextComponent;
|
|
521
|
+
'block1'?: StandardImageTextBlock;
|
|
522
|
+
'block2'?: StandardImageTextBlock;
|
|
523
|
+
'block3'?: StandardImageTextBlock;
|
|
524
|
+
'block4'?: StandardImageTextBlock;
|
|
682
525
|
}
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
* Selling Partner API for A+ Content Management
|
|
686
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
687
|
-
*
|
|
688
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
689
|
-
*
|
|
690
|
-
*
|
|
691
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
692
|
-
* https://openapi-generator.tech
|
|
693
|
-
* Do not edit the class manually.
|
|
694
|
-
*/
|
|
695
|
-
|
|
526
|
+
//#endregion
|
|
527
|
+
//#region src/api-model/models/standard-four-image-text-quadrant-module.d.ts
|
|
696
528
|
/**
|
|
697
529
|
* Four standard images with text, presented on a grid of four quadrants.
|
|
698
530
|
*/
|
|
699
531
|
interface StandardFourImageTextQuadrantModule {
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
532
|
+
'block1': StandardImageTextBlock;
|
|
533
|
+
'block2': StandardImageTextBlock;
|
|
534
|
+
'block3': StandardImageTextBlock;
|
|
535
|
+
'block4': StandardImageTextBlock;
|
|
704
536
|
}
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
* Selling Partner API for A+ Content Management
|
|
708
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
709
|
-
*
|
|
710
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
711
|
-
*
|
|
712
|
-
*
|
|
713
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
714
|
-
* https://openapi-generator.tech
|
|
715
|
-
* Do not edit the class manually.
|
|
716
|
-
*/
|
|
717
|
-
|
|
537
|
+
//#endregion
|
|
538
|
+
//#region src/api-model/models/standard-header-image-text-module.d.ts
|
|
718
539
|
/**
|
|
719
540
|
* Standard headline text, an image, and body text.
|
|
720
541
|
*/
|
|
721
542
|
interface StandardHeaderImageTextModule {
|
|
722
|
-
|
|
723
|
-
|
|
543
|
+
'headline'?: TextComponent;
|
|
544
|
+
'block'?: StandardImageTextBlock;
|
|
724
545
|
}
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
* Selling Partner API for A+ Content Management
|
|
728
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
729
|
-
*
|
|
730
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
731
|
-
*
|
|
732
|
-
*
|
|
733
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
734
|
-
* https://openapi-generator.tech
|
|
735
|
-
* Do not edit the class manually.
|
|
736
|
-
*/
|
|
737
|
-
|
|
546
|
+
//#endregion
|
|
547
|
+
//#region src/api-model/models/standard-image-caption-block.d.ts
|
|
738
548
|
/**
|
|
739
549
|
* The A+ Content standard image and caption block.
|
|
740
550
|
*/
|
|
741
551
|
interface StandardImageCaptionBlock {
|
|
742
|
-
|
|
743
|
-
|
|
552
|
+
'image'?: ImageComponent;
|
|
553
|
+
'caption'?: TextComponent;
|
|
744
554
|
}
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
* Selling Partner API for A+ Content Management
|
|
748
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
749
|
-
*
|
|
750
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
754
|
-
* https://openapi-generator.tech
|
|
755
|
-
* Do not edit the class manually.
|
|
756
|
-
*/
|
|
757
|
-
|
|
555
|
+
//#endregion
|
|
556
|
+
//#region src/api-model/models/standard-text-block.d.ts
|
|
758
557
|
/**
|
|
759
558
|
* The A+ Content standard text box block, which contains a paragraph and a headline.
|
|
760
559
|
*/
|
|
761
560
|
interface StandardTextBlock {
|
|
762
|
-
|
|
763
|
-
|
|
561
|
+
'headline'?: TextComponent;
|
|
562
|
+
'body'?: ParagraphComponent;
|
|
764
563
|
}
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
* Selling Partner API for A+ Content Management
|
|
768
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
769
|
-
*
|
|
770
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
771
|
-
*
|
|
772
|
-
*
|
|
773
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
774
|
-
* https://openapi-generator.tech
|
|
775
|
-
* Do not edit the class manually.
|
|
776
|
-
*/
|
|
777
|
-
|
|
564
|
+
//#endregion
|
|
565
|
+
//#region src/api-model/models/text-item.d.ts
|
|
778
566
|
/**
|
|
779
567
|
* Rich positional text that is usually presented as a collection of bullet points.
|
|
780
568
|
*/
|
|
781
569
|
interface TextItem {
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
570
|
+
/**
|
|
571
|
+
* The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection.
|
|
572
|
+
*/
|
|
573
|
+
'position': number;
|
|
574
|
+
'text': TextComponent;
|
|
787
575
|
}
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
* Selling Partner API for A+ Content Management
|
|
791
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
792
|
-
*
|
|
793
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
794
|
-
*
|
|
795
|
-
*
|
|
796
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
797
|
-
* https://openapi-generator.tech
|
|
798
|
-
* Do not edit the class manually.
|
|
799
|
-
*/
|
|
800
|
-
|
|
576
|
+
//#endregion
|
|
577
|
+
//#region src/api-model/models/standard-text-list-block.d.ts
|
|
801
578
|
/**
|
|
802
579
|
* The A+ Content standard fixed-length list of text, usually presented as bullet points.
|
|
803
580
|
*/
|
|
804
581
|
interface StandardTextListBlock {
|
|
805
|
-
|
|
582
|
+
'textList': Array<TextItem>;
|
|
806
583
|
}
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
* Selling Partner API for A+ Content Management
|
|
810
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
811
|
-
*
|
|
812
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
813
|
-
*
|
|
814
|
-
*
|
|
815
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
816
|
-
* https://openapi-generator.tech
|
|
817
|
-
* Do not edit the class manually.
|
|
818
|
-
*/
|
|
819
|
-
|
|
584
|
+
//#endregion
|
|
585
|
+
//#region src/api-model/models/standard-image-sidebar-module.d.ts
|
|
820
586
|
/**
|
|
821
587
|
* Two images, two paragraphs, and two bulleted lists. One image is smaller and displayed in the sidebar.
|
|
822
588
|
*/
|
|
823
589
|
interface StandardImageSidebarModule {
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
590
|
+
'headline'?: TextComponent;
|
|
591
|
+
'imageCaptionBlock'?: StandardImageCaptionBlock;
|
|
592
|
+
'descriptionTextBlock'?: StandardTextBlock;
|
|
593
|
+
'descriptionListBlock'?: StandardTextListBlock;
|
|
594
|
+
'sidebarImageTextBlock'?: StandardImageTextBlock;
|
|
595
|
+
'sidebarListBlock'?: StandardTextListBlock;
|
|
830
596
|
}
|
|
831
|
-
|
|
597
|
+
//#endregion
|
|
598
|
+
//#region src/api-model/models/standard-image-text-overlay-module.d.ts
|
|
832
599
|
/**
|
|
833
|
-
*
|
|
834
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
835
|
-
*
|
|
836
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
837
|
-
*
|
|
838
|
-
*
|
|
839
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
840
|
-
* https://openapi-generator.tech
|
|
841
|
-
* Do not edit the class manually.
|
|
842
|
-
*/
|
|
843
|
-
|
|
844
|
-
/**
|
|
845
|
-
* A standard background image with a floating text box.
|
|
600
|
+
* A standard background image with a floating text box.
|
|
846
601
|
*/
|
|
847
602
|
interface StandardImageTextOverlayModule {
|
|
848
|
-
|
|
849
|
-
|
|
603
|
+
'overlayColorType': ColorType;
|
|
604
|
+
'block'?: StandardImageTextBlock;
|
|
850
605
|
}
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
* Selling Partner API for A+ Content Management
|
|
854
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
855
|
-
*
|
|
856
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
857
|
-
*
|
|
858
|
-
*
|
|
859
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
860
|
-
* https://openapi-generator.tech
|
|
861
|
-
* Do not edit the class manually.
|
|
862
|
-
*/
|
|
863
|
-
|
|
606
|
+
//#endregion
|
|
607
|
+
//#region src/api-model/models/standard-image-text-caption-block.d.ts
|
|
864
608
|
/**
|
|
865
609
|
* The A+ Content standard image and text block, with a related caption. The caption might not display on all devices.
|
|
866
610
|
*/
|
|
867
611
|
interface StandardImageTextCaptionBlock {
|
|
868
|
-
|
|
869
|
-
|
|
612
|
+
'block'?: StandardImageTextBlock;
|
|
613
|
+
'caption'?: TextComponent;
|
|
870
614
|
}
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
* Selling Partner API for A+ Content Management
|
|
874
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
875
|
-
*
|
|
876
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
877
|
-
*
|
|
878
|
-
*
|
|
879
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
880
|
-
* https://openapi-generator.tech
|
|
881
|
-
* Do not edit the class manually.
|
|
882
|
-
*/
|
|
883
|
-
|
|
615
|
+
//#endregion
|
|
616
|
+
//#region src/api-model/models/standard-multiple-image-text-module.d.ts
|
|
884
617
|
/**
|
|
885
618
|
* Standard images with text, presented one at a time. The user clicks on thumbnails to view each block.
|
|
886
619
|
*/
|
|
887
620
|
interface StandardMultipleImageTextModule {
|
|
888
|
-
|
|
621
|
+
'blocks'?: Array<StandardImageTextCaptionBlock>;
|
|
889
622
|
}
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
* Selling Partner API for A+ Content Management
|
|
893
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
894
|
-
*
|
|
895
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
896
|
-
*
|
|
897
|
-
*
|
|
898
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
899
|
-
* https://openapi-generator.tech
|
|
900
|
-
* Do not edit the class manually.
|
|
901
|
-
*/
|
|
902
|
-
|
|
623
|
+
//#endregion
|
|
624
|
+
//#region src/api-model/models/standard-product-description-module.d.ts
|
|
903
625
|
/**
|
|
904
626
|
* Standard product description text.
|
|
905
627
|
*/
|
|
906
628
|
interface StandardProductDescriptionModule {
|
|
907
|
-
|
|
629
|
+
'body': ParagraphComponent;
|
|
908
630
|
}
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
* Selling Partner API for A+ Content Management
|
|
912
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
913
|
-
*
|
|
914
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
915
|
-
*
|
|
916
|
-
*
|
|
917
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
918
|
-
* https://openapi-generator.tech
|
|
919
|
-
* Do not edit the class manually.
|
|
920
|
-
*/
|
|
921
|
-
|
|
631
|
+
//#endregion
|
|
632
|
+
//#region src/api-model/models/standard-header-text-list-block.d.ts
|
|
922
633
|
/**
|
|
923
634
|
* The A+ standard fixed-length list of text and a related headline.
|
|
924
635
|
*/
|
|
925
636
|
interface StandardHeaderTextListBlock {
|
|
926
|
-
|
|
927
|
-
|
|
637
|
+
'headline'?: TextComponent;
|
|
638
|
+
'block'?: StandardTextListBlock;
|
|
928
639
|
}
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
* Selling Partner API for A+ Content Management
|
|
932
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
933
|
-
*
|
|
934
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
935
|
-
*
|
|
936
|
-
*
|
|
937
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
938
|
-
* https://openapi-generator.tech
|
|
939
|
-
* Do not edit the class manually.
|
|
940
|
-
*/
|
|
941
|
-
|
|
640
|
+
//#endregion
|
|
641
|
+
//#region src/api-model/models/standard-single-image-highlights-module.d.ts
|
|
942
642
|
/**
|
|
943
643
|
* A standard image with several paragraphs and a bulleted list.
|
|
944
644
|
*/
|
|
945
645
|
interface StandardSingleImageHighlightsModule {
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
646
|
+
'image'?: ImageComponent;
|
|
647
|
+
'headline'?: TextComponent;
|
|
648
|
+
'textBlock1'?: StandardTextBlock;
|
|
649
|
+
'textBlock2'?: StandardTextBlock;
|
|
650
|
+
'textBlock3'?: StandardTextBlock;
|
|
651
|
+
'bulletedListBlock'?: StandardHeaderTextListBlock;
|
|
952
652
|
}
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
* Selling Partner API for A+ Content Management
|
|
956
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
957
|
-
*
|
|
958
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
959
|
-
*
|
|
960
|
-
*
|
|
961
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
962
|
-
* https://openapi-generator.tech
|
|
963
|
-
* Do not edit the class manually.
|
|
964
|
-
*/
|
|
965
|
-
|
|
653
|
+
//#endregion
|
|
654
|
+
//#region src/api-model/models/standard-single-image-specs-detail-module.d.ts
|
|
966
655
|
/**
|
|
967
656
|
* A standard image with paragraphs, a bulleted list, and extra space for technical details.
|
|
968
657
|
*/
|
|
969
658
|
interface StandardSingleImageSpecsDetailModule {
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
659
|
+
'headline'?: TextComponent;
|
|
660
|
+
'image'?: ImageComponent;
|
|
661
|
+
'descriptionHeadline'?: TextComponent;
|
|
662
|
+
'descriptionBlock1'?: StandardTextBlock;
|
|
663
|
+
'descriptionBlock2'?: StandardTextBlock;
|
|
664
|
+
'specificationHeadline'?: TextComponent;
|
|
665
|
+
'specificationListBlock'?: StandardHeaderTextListBlock;
|
|
666
|
+
'specificationTextBlock'?: StandardTextBlock;
|
|
978
667
|
}
|
|
979
|
-
|
|
668
|
+
//#endregion
|
|
669
|
+
//#region src/api-model/models/position-type.d.ts
|
|
980
670
|
/**
|
|
981
671
|
* Selling Partner API for A+ Content Management
|
|
982
672
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -992,154 +682,89 @@ interface StandardSingleImageSpecsDetailModule {
|
|
|
992
682
|
* The content\'s relative positioning.
|
|
993
683
|
*/
|
|
994
684
|
declare const PositionType: {
|
|
995
|
-
|
|
996
|
-
|
|
685
|
+
readonly Left: "LEFT";
|
|
686
|
+
readonly Right: "RIGHT";
|
|
997
687
|
};
|
|
998
688
|
type PositionType = typeof PositionType[keyof typeof PositionType];
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
* Selling Partner API for A+ Content Management
|
|
1002
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1003
|
-
*
|
|
1004
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1005
|
-
*
|
|
1006
|
-
*
|
|
1007
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1008
|
-
* https://openapi-generator.tech
|
|
1009
|
-
* Do not edit the class manually.
|
|
1010
|
-
*/
|
|
1011
|
-
|
|
689
|
+
//#endregion
|
|
690
|
+
//#region src/api-model/models/standard-single-side-image-module.d.ts
|
|
1012
691
|
/**
|
|
1013
692
|
* A standard headline and body text with an image on the side.
|
|
1014
693
|
*/
|
|
1015
694
|
interface StandardSingleSideImageModule {
|
|
1016
|
-
|
|
1017
|
-
|
|
695
|
+
'imagePositionType': PositionType;
|
|
696
|
+
'block'?: StandardImageTextBlock;
|
|
1018
697
|
}
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
* Selling Partner API for A+ Content Management
|
|
1022
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1023
|
-
*
|
|
1024
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1025
|
-
*
|
|
1026
|
-
*
|
|
1027
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1028
|
-
* https://openapi-generator.tech
|
|
1029
|
-
* Do not edit the class manually.
|
|
1030
|
-
*/
|
|
1031
|
-
|
|
698
|
+
//#endregion
|
|
699
|
+
//#region src/api-model/models/standard-text-pair-block.d.ts
|
|
1032
700
|
/**
|
|
1033
701
|
* The A+ Content standard label and description block, which contains a pair of text components.
|
|
1034
702
|
*/
|
|
1035
703
|
interface StandardTextPairBlock {
|
|
1036
|
-
|
|
1037
|
-
|
|
704
|
+
'label'?: TextComponent;
|
|
705
|
+
'description'?: TextComponent;
|
|
1038
706
|
}
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
* Selling Partner API for A+ Content Management
|
|
1042
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1043
|
-
*
|
|
1044
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1045
|
-
*
|
|
1046
|
-
*
|
|
1047
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1048
|
-
* https://openapi-generator.tech
|
|
1049
|
-
* Do not edit the class manually.
|
|
1050
|
-
*/
|
|
1051
|
-
|
|
707
|
+
//#endregion
|
|
708
|
+
//#region src/api-model/models/standard-tech-specs-module.d.ts
|
|
1052
709
|
/**
|
|
1053
710
|
* The standard table of technical feature names and definitions.
|
|
1054
711
|
*/
|
|
1055
712
|
interface StandardTechSpecsModule {
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
}
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
* Selling Partner API for A+ Content Management
|
|
1069
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1070
|
-
*
|
|
1071
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1072
|
-
*
|
|
1073
|
-
*
|
|
1074
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1075
|
-
* https://openapi-generator.tech
|
|
1076
|
-
* Do not edit the class manually.
|
|
1077
|
-
*/
|
|
1078
|
-
|
|
713
|
+
'headline'?: TextComponent;
|
|
714
|
+
/**
|
|
715
|
+
* The specification list.
|
|
716
|
+
*/
|
|
717
|
+
'specificationList': Array<StandardTextPairBlock>;
|
|
718
|
+
/**
|
|
719
|
+
* The number of tables you want present. Features are evenly divided between the tables.
|
|
720
|
+
*/
|
|
721
|
+
'tableCount'?: number;
|
|
722
|
+
}
|
|
723
|
+
//#endregion
|
|
724
|
+
//#region src/api-model/models/standard-text-module.d.ts
|
|
1079
725
|
/**
|
|
1080
726
|
* A standard headline and body text.
|
|
1081
727
|
*/
|
|
1082
728
|
interface StandardTextModule {
|
|
1083
|
-
|
|
1084
|
-
|
|
729
|
+
'headline'?: TextComponent;
|
|
730
|
+
'body': ParagraphComponent;
|
|
1085
731
|
}
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
* Selling Partner API for A+ Content Management
|
|
1089
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1090
|
-
*
|
|
1091
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1092
|
-
*
|
|
1093
|
-
*
|
|
1094
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1095
|
-
* https://openapi-generator.tech
|
|
1096
|
-
* Do not edit the class manually.
|
|
1097
|
-
*/
|
|
1098
|
-
|
|
732
|
+
//#endregion
|
|
733
|
+
//#region src/api-model/models/standard-three-image-text-module.d.ts
|
|
1099
734
|
/**
|
|
1100
735
|
* Three standard images with text, presented across a single row.
|
|
1101
736
|
*/
|
|
1102
737
|
interface StandardThreeImageTextModule {
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
738
|
+
'headline'?: TextComponent;
|
|
739
|
+
'block1'?: StandardImageTextBlock;
|
|
740
|
+
'block2'?: StandardImageTextBlock;
|
|
741
|
+
'block3'?: StandardImageTextBlock;
|
|
1107
742
|
}
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
* Selling Partner API for A+ Content Management
|
|
1111
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1112
|
-
*
|
|
1113
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1114
|
-
*
|
|
1115
|
-
*
|
|
1116
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1117
|
-
* https://openapi-generator.tech
|
|
1118
|
-
* Do not edit the class manually.
|
|
1119
|
-
*/
|
|
1120
|
-
|
|
743
|
+
//#endregion
|
|
744
|
+
//#region src/api-model/models/content-module.d.ts
|
|
1121
745
|
/**
|
|
1122
746
|
* An A+ Content module. An A+ Content document is composed of content modules. The `contentModuleType` property selects which content module types to use.
|
|
1123
747
|
*/
|
|
1124
748
|
interface ContentModule {
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
}
|
|
1142
|
-
|
|
749
|
+
'contentModuleType': ContentModuleType;
|
|
750
|
+
'standardCompanyLogo'?: StandardCompanyLogoModule;
|
|
751
|
+
'standardComparisonTable'?: StandardComparisonTableModule;
|
|
752
|
+
'standardFourImageText'?: StandardFourImageTextModule;
|
|
753
|
+
'standardFourImageTextQuadrant'?: StandardFourImageTextQuadrantModule;
|
|
754
|
+
'standardHeaderImageText'?: StandardHeaderImageTextModule;
|
|
755
|
+
'standardImageSidebar'?: StandardImageSidebarModule;
|
|
756
|
+
'standardImageTextOverlay'?: StandardImageTextOverlayModule;
|
|
757
|
+
'standardMultipleImageText'?: StandardMultipleImageTextModule;
|
|
758
|
+
'standardProductDescription'?: StandardProductDescriptionModule;
|
|
759
|
+
'standardSingleImageHighlights'?: StandardSingleImageHighlightsModule;
|
|
760
|
+
'standardSingleImageSpecsDetail'?: StandardSingleImageSpecsDetailModule;
|
|
761
|
+
'standardSingleSideImage'?: StandardSingleSideImageModule;
|
|
762
|
+
'standardTechSpecs'?: StandardTechSpecsModule;
|
|
763
|
+
'standardText'?: StandardTextModule;
|
|
764
|
+
'standardThreeImageText'?: StandardThreeImageTextModule;
|
|
765
|
+
}
|
|
766
|
+
//#endregion
|
|
767
|
+
//#region src/api-model/models/content-type.d.ts
|
|
1143
768
|
/**
|
|
1144
769
|
* Selling Partner API for A+ Content Management
|
|
1145
770
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -1155,46 +780,36 @@ interface ContentModule {
|
|
|
1155
780
|
* The A+ Content document type.
|
|
1156
781
|
*/
|
|
1157
782
|
declare const ContentType: {
|
|
1158
|
-
|
|
1159
|
-
|
|
783
|
+
readonly Ebc: "EBC";
|
|
784
|
+
readonly Emc: "EMC";
|
|
1160
785
|
};
|
|
1161
786
|
type ContentType = typeof ContentType[keyof typeof ContentType];
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
* Selling Partner API for A+ Content Management
|
|
1165
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1166
|
-
*
|
|
1167
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1168
|
-
*
|
|
1169
|
-
*
|
|
1170
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1171
|
-
* https://openapi-generator.tech
|
|
1172
|
-
* Do not edit the class manually.
|
|
1173
|
-
*/
|
|
1174
|
-
|
|
787
|
+
//#endregion
|
|
788
|
+
//#region src/api-model/models/content-document.d.ts
|
|
1175
789
|
/**
|
|
1176
790
|
* The A+ Content document. This is the enhanced content that is published to product detail pages.
|
|
1177
791
|
*/
|
|
1178
792
|
interface ContentDocument {
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
}
|
|
1197
|
-
|
|
793
|
+
/**
|
|
794
|
+
* The A+ Content document name.
|
|
795
|
+
*/
|
|
796
|
+
'name': string;
|
|
797
|
+
'contentType': ContentType;
|
|
798
|
+
/**
|
|
799
|
+
* The A+ Content document subtype. This represents a special-purpose type of an A+ Content document. Not every A+ Content document type has a subtype, and subtypes can change at any time.
|
|
800
|
+
*/
|
|
801
|
+
'contentSubType'?: string;
|
|
802
|
+
/**
|
|
803
|
+
* The IETF language tag, which supports the primary language subtag and one secondary language subtag. The secondary language subtag is usually a regional designation. This doesn\'t support subtags other than the primary and secondary subtags. **Pattern:** ^[a-z]{2,}-[A-Z0-9]{2,}$
|
|
804
|
+
*/
|
|
805
|
+
'locale': string;
|
|
806
|
+
/**
|
|
807
|
+
* A list of A+ Content modules.
|
|
808
|
+
*/
|
|
809
|
+
'contentModuleList': Array<ContentModule>;
|
|
810
|
+
}
|
|
811
|
+
//#endregion
|
|
812
|
+
//#region src/api-model/models/content-status.d.ts
|
|
1198
813
|
/**
|
|
1199
814
|
* Selling Partner API for A+ Content Management
|
|
1200
815
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -1210,95 +825,63 @@ interface ContentDocument {
|
|
|
1210
825
|
* The submission status of the content document.
|
|
1211
826
|
*/
|
|
1212
827
|
declare const ContentStatus: {
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
828
|
+
readonly Approved: "APPROVED";
|
|
829
|
+
readonly Draft: "DRAFT";
|
|
830
|
+
readonly Rejected: "REJECTED";
|
|
831
|
+
readonly Submitted: "SUBMITTED";
|
|
1217
832
|
};
|
|
1218
833
|
type ContentStatus = typeof ContentStatus[keyof typeof ContentStatus];
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
* Selling Partner API for A+ Content Management
|
|
1222
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1223
|
-
*
|
|
1224
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1225
|
-
*
|
|
1226
|
-
*
|
|
1227
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1228
|
-
* https://openapi-generator.tech
|
|
1229
|
-
* Do not edit the class manually.
|
|
1230
|
-
*/
|
|
1231
|
-
|
|
834
|
+
//#endregion
|
|
835
|
+
//#region src/api-model/models/content-metadata.d.ts
|
|
1232
836
|
/**
|
|
1233
837
|
* The A+ Content document\'s metadata.
|
|
1234
838
|
*/
|
|
1235
839
|
interface ContentMetadata {
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
}
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
* Selling Partner API for A+ Content Management
|
|
1257
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1258
|
-
*
|
|
1259
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1260
|
-
*
|
|
1261
|
-
*
|
|
1262
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1263
|
-
* https://openapi-generator.tech
|
|
1264
|
-
* Do not edit the class manually.
|
|
1265
|
-
*/
|
|
1266
|
-
|
|
840
|
+
/**
|
|
841
|
+
* The A+ Content document\'s name.
|
|
842
|
+
*/
|
|
843
|
+
'name': string;
|
|
844
|
+
/**
|
|
845
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
846
|
+
*/
|
|
847
|
+
'marketplaceId': string;
|
|
848
|
+
'status': ContentStatus;
|
|
849
|
+
/**
|
|
850
|
+
* The set of content badges.
|
|
851
|
+
*/
|
|
852
|
+
'badgeSet': Set<ContentBadge>;
|
|
853
|
+
/**
|
|
854
|
+
* The approximate age of the A+ Content document and metadata.
|
|
855
|
+
*/
|
|
856
|
+
'updateTime': string;
|
|
857
|
+
}
|
|
858
|
+
//#endregion
|
|
859
|
+
//#region src/api-model/models/content-metadata-record.d.ts
|
|
1267
860
|
/**
|
|
1268
861
|
* The metadata for an A+ Content document, with additional information for content management.
|
|
1269
862
|
*/
|
|
1270
863
|
interface ContentMetadataRecord {
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
|
|
864
|
+
/**
|
|
865
|
+
* A unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
866
|
+
*/
|
|
867
|
+
'contentReferenceKey': string;
|
|
868
|
+
'contentMetadata': ContentMetadata;
|
|
1276
869
|
}
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
* Selling Partner API for A+ Content Management
|
|
1280
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1281
|
-
*
|
|
1282
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1285
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1286
|
-
* https://openapi-generator.tech
|
|
1287
|
-
* Do not edit the class manually.
|
|
1288
|
-
*/
|
|
1289
|
-
|
|
870
|
+
//#endregion
|
|
871
|
+
//#region src/api-model/models/content-record.d.ts
|
|
1290
872
|
/**
|
|
1291
873
|
* A content document with additional information for content management.
|
|
1292
874
|
*/
|
|
1293
875
|
interface ContentRecord {
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
876
|
+
/**
|
|
877
|
+
* A unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
878
|
+
*/
|
|
879
|
+
'contentReferenceKey': string;
|
|
880
|
+
'contentMetadata'?: ContentMetadata;
|
|
881
|
+
'contentDocument'?: ContentDocument;
|
|
1300
882
|
}
|
|
1301
|
-
|
|
883
|
+
//#endregion
|
|
884
|
+
//#region src/api-model/models/error-list.d.ts
|
|
1302
885
|
/**
|
|
1303
886
|
* Selling Partner API for A+ Content Management
|
|
1304
887
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -1314,81 +897,38 @@ interface ContentRecord {
|
|
|
1314
897
|
* The error response that is returned when a request is unsuccessful.
|
|
1315
898
|
*/
|
|
1316
899
|
interface ErrorList {
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
900
|
+
/**
|
|
901
|
+
* A list of error responses that are returned when a request is unsuccessful.
|
|
902
|
+
*/
|
|
903
|
+
'errors': Array<Error>;
|
|
1321
904
|
}
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
* Selling Partner API for A+ Content Management
|
|
1325
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1326
|
-
*
|
|
1327
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1328
|
-
*
|
|
1329
|
-
*
|
|
1330
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1331
|
-
* https://openapi-generator.tech
|
|
1332
|
-
* Do not edit the class manually.
|
|
1333
|
-
*/
|
|
1334
|
-
|
|
905
|
+
//#endregion
|
|
906
|
+
//#region src/api-model/models/get-content-document-response-all-of.d.ts
|
|
1335
907
|
interface GetContentDocumentResponseAllOf {
|
|
1336
|
-
|
|
908
|
+
'contentRecord': ContentRecord;
|
|
1337
909
|
}
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
* Selling Partner API for A+ Content Management
|
|
1341
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1342
|
-
*
|
|
1343
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1344
|
-
*
|
|
1345
|
-
*
|
|
1346
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1347
|
-
* https://openapi-generator.tech
|
|
1348
|
-
* Do not edit the class manually.
|
|
1349
|
-
*/
|
|
1350
|
-
|
|
910
|
+
//#endregion
|
|
911
|
+
//#region src/api-model/models/get-content-document-response.d.ts
|
|
1351
912
|
/**
|
|
1352
913
|
* @type GetContentDocumentResponse
|
|
1353
914
|
*/
|
|
1354
915
|
type GetContentDocumentResponse = AplusResponse & GetContentDocumentResponseAllOf;
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
* Selling Partner API for A+ Content Management
|
|
1358
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1359
|
-
*
|
|
1360
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1361
|
-
*
|
|
1362
|
-
*
|
|
1363
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1364
|
-
* https://openapi-generator.tech
|
|
1365
|
-
* Do not edit the class manually.
|
|
1366
|
-
*/
|
|
1367
|
-
|
|
916
|
+
//#endregion
|
|
917
|
+
//#region src/api-model/models/list-content-document-asin-relations-response-all-of.d.ts
|
|
1368
918
|
interface ListContentDocumentAsinRelationsResponseAllOf {
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
919
|
+
/**
|
|
920
|
+
* The set of ASIN metadata.
|
|
921
|
+
*/
|
|
922
|
+
'asinMetadataSet': Set<AsinMetadata>;
|
|
1373
923
|
}
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
* Selling Partner API for A+ Content Management
|
|
1377
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1378
|
-
*
|
|
1379
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1380
|
-
*
|
|
1381
|
-
*
|
|
1382
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1383
|
-
* https://openapi-generator.tech
|
|
1384
|
-
* Do not edit the class manually.
|
|
1385
|
-
*/
|
|
1386
|
-
|
|
924
|
+
//#endregion
|
|
925
|
+
//#region src/api-model/models/list-content-document-asin-relations-response.d.ts
|
|
1387
926
|
/**
|
|
1388
927
|
* @type ListContentDocumentAsinRelationsResponse
|
|
1389
928
|
*/
|
|
1390
929
|
type ListContentDocumentAsinRelationsResponse = AplusPaginatedResponse & ListContentDocumentAsinRelationsResponseAllOf;
|
|
1391
|
-
|
|
930
|
+
//#endregion
|
|
931
|
+
//#region src/api-model/models/model-error.d.ts
|
|
1392
932
|
/**
|
|
1393
933
|
* Selling Partner API for A+ Content Management
|
|
1394
934
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -1404,37 +944,27 @@ type ListContentDocumentAsinRelationsResponse = AplusPaginatedResponse & ListCon
|
|
|
1404
944
|
* The error response that is returned when the request is unsuccessful.
|
|
1405
945
|
*/
|
|
1406
946
|
interface ModelError {
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
}
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
* Selling Partner API for A+ Content Management
|
|
1423
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1424
|
-
*
|
|
1425
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1426
|
-
*
|
|
1427
|
-
*
|
|
1428
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1429
|
-
* https://openapi-generator.tech
|
|
1430
|
-
* Do not edit the class manually.
|
|
1431
|
-
*/
|
|
1432
|
-
|
|
947
|
+
/**
|
|
948
|
+
* An error code that identifies the type of error that occurred.
|
|
949
|
+
*/
|
|
950
|
+
'code': string;
|
|
951
|
+
/**
|
|
952
|
+
* A message that describes the error condition.
|
|
953
|
+
*/
|
|
954
|
+
'message': string;
|
|
955
|
+
/**
|
|
956
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
957
|
+
*/
|
|
958
|
+
'details'?: string;
|
|
959
|
+
}
|
|
960
|
+
//#endregion
|
|
961
|
+
//#region src/api-model/models/post-content-document-approval-submission-response.d.ts
|
|
1433
962
|
/**
|
|
1434
963
|
* @type PostContentDocumentApprovalSubmissionResponse
|
|
1435
964
|
*/
|
|
1436
965
|
type PostContentDocumentApprovalSubmissionResponse = AplusResponse;
|
|
1437
|
-
|
|
966
|
+
//#endregion
|
|
967
|
+
//#region src/api-model/models/post-content-document-asin-relations-request.d.ts
|
|
1438
968
|
/**
|
|
1439
969
|
* Selling Partner API for A+ Content Management
|
|
1440
970
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -1447,45 +977,24 @@ type PostContentDocumentApprovalSubmissionResponse = AplusResponse;
|
|
|
1447
977
|
* Do not edit the class manually.
|
|
1448
978
|
*/
|
|
1449
979
|
interface PostContentDocumentAsinRelationsRequest {
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
|
|
980
|
+
/**
|
|
981
|
+
* The set of ASINs.
|
|
982
|
+
*/
|
|
983
|
+
'asinSet': Set<string>;
|
|
1454
984
|
}
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
* Selling Partner API for A+ Content Management
|
|
1458
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1459
|
-
*
|
|
1460
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1461
|
-
*
|
|
1462
|
-
*
|
|
1463
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1464
|
-
* https://openapi-generator.tech
|
|
1465
|
-
* Do not edit the class manually.
|
|
1466
|
-
*/
|
|
1467
|
-
|
|
985
|
+
//#endregion
|
|
986
|
+
//#region src/api-model/models/post-content-document-asin-relations-response.d.ts
|
|
1468
987
|
/**
|
|
1469
988
|
* @type PostContentDocumentAsinRelationsResponse
|
|
1470
989
|
*/
|
|
1471
990
|
type PostContentDocumentAsinRelationsResponse = AplusResponse;
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
* Selling Partner API for A+ Content Management
|
|
1475
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1476
|
-
*
|
|
1477
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1478
|
-
*
|
|
1479
|
-
*
|
|
1480
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1481
|
-
* https://openapi-generator.tech
|
|
1482
|
-
* Do not edit the class manually.
|
|
1483
|
-
*/
|
|
1484
|
-
|
|
991
|
+
//#endregion
|
|
992
|
+
//#region src/api-model/models/post-content-document-request.d.ts
|
|
1485
993
|
interface PostContentDocumentRequest {
|
|
1486
|
-
|
|
994
|
+
'contentDocument': ContentDocument;
|
|
1487
995
|
}
|
|
1488
|
-
|
|
996
|
+
//#endregion
|
|
997
|
+
//#region src/api-model/models/post-content-document-response-all-of.d.ts
|
|
1489
998
|
/**
|
|
1490
999
|
* Selling Partner API for A+ Content Management
|
|
1491
1000
|
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
@@ -1498,685 +1007,600 @@ interface PostContentDocumentRequest {
|
|
|
1498
1007
|
* Do not edit the class manually.
|
|
1499
1008
|
*/
|
|
1500
1009
|
interface PostContentDocumentResponseAllOf {
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
|
|
1010
|
+
/**
|
|
1011
|
+
* A unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
1012
|
+
*/
|
|
1013
|
+
'contentReferenceKey': string;
|
|
1505
1014
|
}
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
* Selling Partner API for A+ Content Management
|
|
1509
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1510
|
-
*
|
|
1511
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1512
|
-
*
|
|
1513
|
-
*
|
|
1514
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1515
|
-
* https://openapi-generator.tech
|
|
1516
|
-
* Do not edit the class manually.
|
|
1517
|
-
*/
|
|
1518
|
-
|
|
1015
|
+
//#endregion
|
|
1016
|
+
//#region src/api-model/models/post-content-document-response.d.ts
|
|
1519
1017
|
/**
|
|
1520
1018
|
* @type PostContentDocumentResponse
|
|
1521
1019
|
*/
|
|
1522
1020
|
type PostContentDocumentResponse = AplusResponse & PostContentDocumentResponseAllOf;
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
* Selling Partner API for A+ Content Management
|
|
1526
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1527
|
-
*
|
|
1528
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1529
|
-
*
|
|
1530
|
-
*
|
|
1531
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1532
|
-
* https://openapi-generator.tech
|
|
1533
|
-
* Do not edit the class manually.
|
|
1534
|
-
*/
|
|
1535
|
-
|
|
1021
|
+
//#endregion
|
|
1022
|
+
//#region src/api-model/models/post-content-document-suspend-submission-response.d.ts
|
|
1536
1023
|
/**
|
|
1537
1024
|
* @type PostContentDocumentSuspendSubmissionResponse
|
|
1538
1025
|
*/
|
|
1539
1026
|
type PostContentDocumentSuspendSubmissionResponse = AplusResponse;
|
|
1540
|
-
|
|
1541
|
-
|
|
1542
|
-
* Selling Partner API for A+ Content Management
|
|
1543
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1544
|
-
*
|
|
1545
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1546
|
-
*
|
|
1547
|
-
*
|
|
1548
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1549
|
-
* https://openapi-generator.tech
|
|
1550
|
-
* Do not edit the class manually.
|
|
1551
|
-
*/
|
|
1552
|
-
|
|
1027
|
+
//#endregion
|
|
1028
|
+
//#region src/api-model/models/publish-record.d.ts
|
|
1553
1029
|
/**
|
|
1554
1030
|
* The full context for an A+ Content publishing event.
|
|
1555
1031
|
*/
|
|
1556
1032
|
interface PublishRecord {
|
|
1557
|
-
|
|
1558
|
-
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
}
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
* Selling Partner API for A+ Content Management
|
|
1582
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1583
|
-
*
|
|
1584
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1585
|
-
*
|
|
1586
|
-
*
|
|
1587
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1588
|
-
* https://openapi-generator.tech
|
|
1589
|
-
* Do not edit the class manually.
|
|
1590
|
-
*/
|
|
1591
|
-
|
|
1033
|
+
/**
|
|
1034
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1035
|
+
*/
|
|
1036
|
+
'marketplaceId': string;
|
|
1037
|
+
/**
|
|
1038
|
+
* The IETF language tag, which supports the primary language subtag and one secondary language subtag. The secondary language subtag is usually a regional designation. This doesn\'t support subtags other than the primary and secondary subtags. **Pattern:** ^[a-z]{2,}-[A-Z0-9]{2,}$
|
|
1039
|
+
*/
|
|
1040
|
+
'locale': string;
|
|
1041
|
+
/**
|
|
1042
|
+
* The Amazon Standard Identification Number (ASIN).
|
|
1043
|
+
*/
|
|
1044
|
+
'asin': string;
|
|
1045
|
+
'contentType': ContentType;
|
|
1046
|
+
/**
|
|
1047
|
+
* The A+ Content document subtype. This represents a special-purpose type of an A+ Content document. Not every A+ Content document type has a subtype, and subtypes can change at any time.
|
|
1048
|
+
*/
|
|
1049
|
+
'contentSubType'?: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* A unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
1052
|
+
*/
|
|
1053
|
+
'contentReferenceKey': string;
|
|
1054
|
+
}
|
|
1055
|
+
//#endregion
|
|
1056
|
+
//#region src/api-model/models/search-content-documents-response-all-of.d.ts
|
|
1592
1057
|
interface SearchContentDocumentsResponseAllOf {
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
|
|
1596
|
-
|
|
1058
|
+
/**
|
|
1059
|
+
* A list of A+ Content metadata records.
|
|
1060
|
+
*/
|
|
1061
|
+
'contentMetadataRecords': Array<ContentMetadataRecord>;
|
|
1597
1062
|
}
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
* Selling Partner API for A+ Content Management
|
|
1601
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1602
|
-
*
|
|
1603
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1604
|
-
*
|
|
1605
|
-
*
|
|
1606
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1607
|
-
* https://openapi-generator.tech
|
|
1608
|
-
* Do not edit the class manually.
|
|
1609
|
-
*/
|
|
1610
|
-
|
|
1063
|
+
//#endregion
|
|
1064
|
+
//#region src/api-model/models/search-content-documents-response.d.ts
|
|
1611
1065
|
/**
|
|
1612
1066
|
* @type SearchContentDocumentsResponse
|
|
1613
1067
|
*/
|
|
1614
1068
|
type SearchContentDocumentsResponse = AplusPaginatedResponse & SearchContentDocumentsResponseAllOf;
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
* Selling Partner API for A+ Content Management
|
|
1618
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1619
|
-
*
|
|
1620
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1621
|
-
*
|
|
1622
|
-
*
|
|
1623
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1624
|
-
* https://openapi-generator.tech
|
|
1625
|
-
* Do not edit the class manually.
|
|
1626
|
-
*/
|
|
1627
|
-
|
|
1069
|
+
//#endregion
|
|
1070
|
+
//#region src/api-model/models/search-content-publish-records-response-all-of.d.ts
|
|
1628
1071
|
interface SearchContentPublishRecordsResponseAllOf {
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
|
|
1072
|
+
/**
|
|
1073
|
+
* A list of A+ Content publishing records.
|
|
1074
|
+
*/
|
|
1075
|
+
'publishRecordList': Array<PublishRecord>;
|
|
1633
1076
|
}
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
* Selling Partner API for A+ Content Management
|
|
1637
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1638
|
-
*
|
|
1639
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1640
|
-
*
|
|
1641
|
-
*
|
|
1642
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1643
|
-
* https://openapi-generator.tech
|
|
1644
|
-
* Do not edit the class manually.
|
|
1645
|
-
*/
|
|
1646
|
-
|
|
1077
|
+
//#endregion
|
|
1078
|
+
//#region src/api-model/models/search-content-publish-records-response.d.ts
|
|
1647
1079
|
/**
|
|
1648
1080
|
* @type SearchContentPublishRecordsResponse
|
|
1649
1081
|
*/
|
|
1650
1082
|
type SearchContentPublishRecordsResponse = AplusPaginatedResponse & SearchContentPublishRecordsResponseAllOf;
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
* Selling Partner API for A+ Content Management
|
|
1654
|
-
* Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
|
|
1655
|
-
*
|
|
1656
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
1657
|
-
*
|
|
1658
|
-
*
|
|
1659
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1660
|
-
* https://openapi-generator.tech
|
|
1661
|
-
* Do not edit the class manually.
|
|
1662
|
-
*/
|
|
1663
|
-
|
|
1083
|
+
//#endregion
|
|
1084
|
+
//#region src/api-model/models/validate-content-document-asin-relations-response.d.ts
|
|
1664
1085
|
/**
|
|
1665
1086
|
* @type ValidateContentDocumentAsinRelationsResponse
|
|
1666
1087
|
*/
|
|
1667
1088
|
type ValidateContentDocumentAsinRelationsResponse = AplusResponse & ErrorList;
|
|
1668
|
-
|
|
1089
|
+
//#endregion
|
|
1090
|
+
//#region src/api-model/api/aplus-content-api.d.ts
|
|
1669
1091
|
/**
|
|
1670
1092
|
* AplusContentApi - axios parameter creator
|
|
1671
1093
|
*/
|
|
1672
1094
|
declare const AplusContentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
|
|
1690
|
-
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
|
|
1700
|
-
|
|
1701
|
-
|
|
1702
|
-
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
|
|
1743
|
-
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
|
|
1760
|
-
|
|
1095
|
+
/**
|
|
1096
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1097
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1098
|
+
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
1099
|
+
* @param {*} [options] Override http request option.
|
|
1100
|
+
* @throws {RequiredError}
|
|
1101
|
+
*/
|
|
1102
|
+
createContentDocument: (marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1103
|
+
/**
|
|
1104
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1105
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
1106
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1107
|
+
* @param {Set<GetContentDocumentIncludedDataSetEnum>} includedDataSet The set of A+ Content data types to include in the response.
|
|
1108
|
+
* @param {*} [options] Override http request option.
|
|
1109
|
+
* @throws {RequiredError}
|
|
1110
|
+
*/
|
|
1111
|
+
getContentDocument: (contentReferenceKey: string, marketplaceId: string, includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1112
|
+
/**
|
|
1113
|
+
* Returns a list of ASINs that are related to the specified A+ Content document, if available. If you don\'t include the `asinSet` parameter, this operation returns all ASINs related to the content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1114
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
1115
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1116
|
+
* @param {Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>} [includedDataSet] The set of A+ Content data types to include in the response. If you don\'t include this parameter, the operation returns the related ASINs without metadata.
|
|
1117
|
+
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
1118
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
1119
|
+
* @param {*} [options] Override http request option.
|
|
1120
|
+
* @throws {RequiredError}
|
|
1121
|
+
*/
|
|
1122
|
+
listContentDocumentAsinRelations: (contentReferenceKey: string, marketplaceId: string, includedDataSet?: Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>, asinSet?: Set<string>, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1123
|
+
/**
|
|
1124
|
+
* Submits an A+ Content document for review, approval, and publishing. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1125
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
1126
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1127
|
+
* @param {*} [options] Override http request option.
|
|
1128
|
+
* @throws {RequiredError}
|
|
1129
|
+
*/
|
|
1130
|
+
postContentDocumentApprovalSubmission: (contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1131
|
+
/**
|
|
1132
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This operation can add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN will suspend the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1133
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
1134
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1135
|
+
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The request details for the content document ASIN relations.
|
|
1136
|
+
* @param {*} [options] Override http request option.
|
|
1137
|
+
* @throws {RequiredError}
|
|
1138
|
+
*/
|
|
1139
|
+
postContentDocumentAsinRelations: (contentReferenceKey: string, marketplaceId: string, postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1140
|
+
/**
|
|
1141
|
+
* Submits a request to suspend visible A+ Content. This doesn\'t delete the content document or the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1142
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
1143
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1144
|
+
* @param {*} [options] Override http request option.
|
|
1145
|
+
* @throws {RequiredError}
|
|
1146
|
+
*/
|
|
1147
|
+
postContentDocumentSuspendSubmission: (contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1148
|
+
/**
|
|
1149
|
+
* Returns a list of all A+ Content documents, including metadata, that are assigned to a selling partner. To get the actual contents of the A+ Content documents, call the `getContentDocument` operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1150
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1151
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
1152
|
+
* @param {*} [options] Override http request option.
|
|
1153
|
+
* @throws {RequiredError}
|
|
1154
|
+
*/
|
|
1155
|
+
searchContentDocuments: (marketplaceId: string, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1156
|
+
/**
|
|
1157
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1158
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1159
|
+
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
1160
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
1161
|
+
* @param {*} [options] Override http request option.
|
|
1162
|
+
* @throws {RequiredError}
|
|
1163
|
+
*/
|
|
1164
|
+
searchContentPublishRecords: (marketplaceId: string, asin: string, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1165
|
+
/**
|
|
1166
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1167
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
1168
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1169
|
+
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
1170
|
+
* @param {*} [options] Override http request option.
|
|
1171
|
+
* @throws {RequiredError}
|
|
1172
|
+
*/
|
|
1173
|
+
updateContentDocument: (contentReferenceKey: string, marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1174
|
+
/**
|
|
1175
|
+
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1176
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1177
|
+
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
1178
|
+
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
1179
|
+
* @param {*} [options] Override http request option.
|
|
1180
|
+
* @throws {RequiredError}
|
|
1181
|
+
*/
|
|
1182
|
+
validateContentDocumentAsinRelations: (marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, asinSet?: Set<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1761
1183
|
};
|
|
1762
1184
|
/**
|
|
1763
1185
|
* AplusContentApi - functional programming interface
|
|
1764
1186
|
*/
|
|
1765
1187
|
declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
|
|
1773
|
-
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1780
|
-
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
|
|
1818
|
-
|
|
1819
|
-
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
|
|
1823
|
-
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
|
|
1830
|
-
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
1843
|
-
|
|
1844
|
-
|
|
1845
|
-
|
|
1846
|
-
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
|
|
1851
|
-
|
|
1852
|
-
|
|
1853
|
-
|
|
1188
|
+
/**
|
|
1189
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1190
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1191
|
+
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
1192
|
+
* @param {*} [options] Override http request option.
|
|
1193
|
+
* @throws {RequiredError}
|
|
1194
|
+
*/
|
|
1195
|
+
createContentDocument(marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentResponse>>;
|
|
1196
|
+
/**
|
|
1197
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1198
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
1199
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1200
|
+
* @param {Set<GetContentDocumentIncludedDataSetEnum>} includedDataSet The set of A+ Content data types to include in the response.
|
|
1201
|
+
* @param {*} [options] Override http request option.
|
|
1202
|
+
* @throws {RequiredError}
|
|
1203
|
+
*/
|
|
1204
|
+
getContentDocument(contentReferenceKey: string, marketplaceId: string, includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetContentDocumentResponse>>;
|
|
1205
|
+
/**
|
|
1206
|
+
* Returns a list of ASINs that are related to the specified A+ Content document, if available. If you don\'t include the `asinSet` parameter, this operation returns all ASINs related to the content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1207
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
1208
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1209
|
+
* @param {Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>} [includedDataSet] The set of A+ Content data types to include in the response. If you don\'t include this parameter, the operation returns the related ASINs without metadata.
|
|
1210
|
+
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
1211
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
1212
|
+
* @param {*} [options] Override http request option.
|
|
1213
|
+
* @throws {RequiredError}
|
|
1214
|
+
*/
|
|
1215
|
+
listContentDocumentAsinRelations(contentReferenceKey: string, marketplaceId: string, includedDataSet?: Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>, asinSet?: Set<string>, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListContentDocumentAsinRelationsResponse>>;
|
|
1216
|
+
/**
|
|
1217
|
+
* Submits an A+ Content document for review, approval, and publishing. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1218
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
1219
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1220
|
+
* @param {*} [options] Override http request option.
|
|
1221
|
+
* @throws {RequiredError}
|
|
1222
|
+
*/
|
|
1223
|
+
postContentDocumentApprovalSubmission(contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentApprovalSubmissionResponse>>;
|
|
1224
|
+
/**
|
|
1225
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This operation can add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN will suspend the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1226
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
1227
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1228
|
+
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The request details for the content document ASIN relations.
|
|
1229
|
+
* @param {*} [options] Override http request option.
|
|
1230
|
+
* @throws {RequiredError}
|
|
1231
|
+
*/
|
|
1232
|
+
postContentDocumentAsinRelations(contentReferenceKey: string, marketplaceId: string, postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentAsinRelationsResponse>>;
|
|
1233
|
+
/**
|
|
1234
|
+
* Submits a request to suspend visible A+ Content. This doesn\'t delete the content document or the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1235
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
1236
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1237
|
+
* @param {*} [options] Override http request option.
|
|
1238
|
+
* @throws {RequiredError}
|
|
1239
|
+
*/
|
|
1240
|
+
postContentDocumentSuspendSubmission(contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentSuspendSubmissionResponse>>;
|
|
1241
|
+
/**
|
|
1242
|
+
* Returns a list of all A+ Content documents, including metadata, that are assigned to a selling partner. To get the actual contents of the A+ Content documents, call the `getContentDocument` operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1243
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1244
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
1245
|
+
* @param {*} [options] Override http request option.
|
|
1246
|
+
* @throws {RequiredError}
|
|
1247
|
+
*/
|
|
1248
|
+
searchContentDocuments(marketplaceId: string, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchContentDocumentsResponse>>;
|
|
1249
|
+
/**
|
|
1250
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1251
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1252
|
+
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
1253
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
1254
|
+
* @param {*} [options] Override http request option.
|
|
1255
|
+
* @throws {RequiredError}
|
|
1256
|
+
*/
|
|
1257
|
+
searchContentPublishRecords(marketplaceId: string, asin: string, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchContentPublishRecordsResponse>>;
|
|
1258
|
+
/**
|
|
1259
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1260
|
+
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
1261
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1262
|
+
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
1263
|
+
* @param {*} [options] Override http request option.
|
|
1264
|
+
* @throws {RequiredError}
|
|
1265
|
+
*/
|
|
1266
|
+
updateContentDocument(contentReferenceKey: string, marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentResponse>>;
|
|
1267
|
+
/**
|
|
1268
|
+
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1269
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1270
|
+
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
1271
|
+
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
1272
|
+
* @param {*} [options] Override http request option.
|
|
1273
|
+
* @throws {RequiredError}
|
|
1274
|
+
*/
|
|
1275
|
+
validateContentDocumentAsinRelations(marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, asinSet?: Set<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValidateContentDocumentAsinRelationsResponse>>;
|
|
1854
1276
|
};
|
|
1855
1277
|
/**
|
|
1856
1278
|
* AplusContentApi - factory interface
|
|
1857
1279
|
*/
|
|
1858
1280
|
declare const AplusContentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
|
|
1865
|
-
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
|
|
1892
|
-
|
|
1893
|
-
|
|
1894
|
-
|
|
1895
|
-
|
|
1896
|
-
|
|
1897
|
-
|
|
1898
|
-
|
|
1899
|
-
|
|
1900
|
-
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
|
|
1906
|
-
|
|
1907
|
-
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
|
|
1925
|
-
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
|
|
1281
|
+
/**
|
|
1282
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1283
|
+
* @param {AplusContentApiCreateContentDocumentRequest} requestParameters Request parameters.
|
|
1284
|
+
* @param {*} [options] Override http request option.
|
|
1285
|
+
* @throws {RequiredError}
|
|
1286
|
+
*/
|
|
1287
|
+
createContentDocument(requestParameters: AplusContentApiCreateContentDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentResponse>;
|
|
1288
|
+
/**
|
|
1289
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1290
|
+
* @param {AplusContentApiGetContentDocumentRequest} requestParameters Request parameters.
|
|
1291
|
+
* @param {*} [options] Override http request option.
|
|
1292
|
+
* @throws {RequiredError}
|
|
1293
|
+
*/
|
|
1294
|
+
getContentDocument(requestParameters: AplusContentApiGetContentDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetContentDocumentResponse>;
|
|
1295
|
+
/**
|
|
1296
|
+
* Returns a list of ASINs that are related to the specified A+ Content document, if available. If you don\'t include the `asinSet` parameter, this operation returns all ASINs related to the content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1297
|
+
* @param {AplusContentApiListContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
1298
|
+
* @param {*} [options] Override http request option.
|
|
1299
|
+
* @throws {RequiredError}
|
|
1300
|
+
*/
|
|
1301
|
+
listContentDocumentAsinRelations(requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListContentDocumentAsinRelationsResponse>;
|
|
1302
|
+
/**
|
|
1303
|
+
* Submits an A+ Content document for review, approval, and publishing. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1304
|
+
* @param {AplusContentApiPostContentDocumentApprovalSubmissionRequest} requestParameters Request parameters.
|
|
1305
|
+
* @param {*} [options] Override http request option.
|
|
1306
|
+
* @throws {RequiredError}
|
|
1307
|
+
*/
|
|
1308
|
+
postContentDocumentApprovalSubmission(requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentApprovalSubmissionResponse>;
|
|
1309
|
+
/**
|
|
1310
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This operation can add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN will suspend the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1311
|
+
* @param {AplusContentApiPostContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
1312
|
+
* @param {*} [options] Override http request option.
|
|
1313
|
+
* @throws {RequiredError}
|
|
1314
|
+
*/
|
|
1315
|
+
postContentDocumentAsinRelations(requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentAsinRelationsResponse>;
|
|
1316
|
+
/**
|
|
1317
|
+
* Submits a request to suspend visible A+ Content. This doesn\'t delete the content document or the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1318
|
+
* @param {AplusContentApiPostContentDocumentSuspendSubmissionRequest} requestParameters Request parameters.
|
|
1319
|
+
* @param {*} [options] Override http request option.
|
|
1320
|
+
* @throws {RequiredError}
|
|
1321
|
+
*/
|
|
1322
|
+
postContentDocumentSuspendSubmission(requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentSuspendSubmissionResponse>;
|
|
1323
|
+
/**
|
|
1324
|
+
* Returns a list of all A+ Content documents, including metadata, that are assigned to a selling partner. To get the actual contents of the A+ Content documents, call the `getContentDocument` operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1325
|
+
* @param {AplusContentApiSearchContentDocumentsRequest} requestParameters Request parameters.
|
|
1326
|
+
* @param {*} [options] Override http request option.
|
|
1327
|
+
* @throws {RequiredError}
|
|
1328
|
+
*/
|
|
1329
|
+
searchContentDocuments(requestParameters: AplusContentApiSearchContentDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchContentDocumentsResponse>;
|
|
1330
|
+
/**
|
|
1331
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1332
|
+
* @param {AplusContentApiSearchContentPublishRecordsRequest} requestParameters Request parameters.
|
|
1333
|
+
* @param {*} [options] Override http request option.
|
|
1334
|
+
* @throws {RequiredError}
|
|
1335
|
+
*/
|
|
1336
|
+
searchContentPublishRecords(requestParameters: AplusContentApiSearchContentPublishRecordsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchContentPublishRecordsResponse>;
|
|
1337
|
+
/**
|
|
1338
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1339
|
+
* @param {AplusContentApiUpdateContentDocumentRequest} requestParameters Request parameters.
|
|
1340
|
+
* @param {*} [options] Override http request option.
|
|
1341
|
+
* @throws {RequiredError}
|
|
1342
|
+
*/
|
|
1343
|
+
updateContentDocument(requestParameters: AplusContentApiUpdateContentDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentResponse>;
|
|
1344
|
+
/**
|
|
1345
|
+
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1346
|
+
* @param {AplusContentApiValidateContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
1347
|
+
* @param {*} [options] Override http request option.
|
|
1348
|
+
* @throws {RequiredError}
|
|
1349
|
+
*/
|
|
1350
|
+
validateContentDocumentAsinRelations(requestParameters: AplusContentApiValidateContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ValidateContentDocumentAsinRelationsResponse>;
|
|
1929
1351
|
};
|
|
1930
1352
|
/**
|
|
1931
1353
|
* Request parameters for createContentDocument operation in AplusContentApi.
|
|
1932
1354
|
*/
|
|
1933
1355
|
interface AplusContentApiCreateContentDocumentRequest {
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
|
|
1937
|
-
|
|
1938
|
-
|
|
1939
|
-
|
|
1940
|
-
|
|
1941
|
-
|
|
1356
|
+
/**
|
|
1357
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1358
|
+
*/
|
|
1359
|
+
readonly marketplaceId: string;
|
|
1360
|
+
/**
|
|
1361
|
+
* The content document request details.
|
|
1362
|
+
*/
|
|
1363
|
+
readonly postContentDocumentRequest: PostContentDocumentRequest;
|
|
1942
1364
|
}
|
|
1943
1365
|
/**
|
|
1944
1366
|
* Request parameters for getContentDocument operation in AplusContentApi.
|
|
1945
1367
|
*/
|
|
1946
1368
|
interface AplusContentApiGetContentDocumentRequest {
|
|
1947
|
-
|
|
1948
|
-
|
|
1949
|
-
|
|
1950
|
-
|
|
1951
|
-
|
|
1952
|
-
|
|
1953
|
-
|
|
1954
|
-
|
|
1955
|
-
|
|
1956
|
-
|
|
1957
|
-
|
|
1958
|
-
|
|
1369
|
+
/**
|
|
1370
|
+
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
1371
|
+
*/
|
|
1372
|
+
readonly contentReferenceKey: string;
|
|
1373
|
+
/**
|
|
1374
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1375
|
+
*/
|
|
1376
|
+
readonly marketplaceId: string;
|
|
1377
|
+
/**
|
|
1378
|
+
* The set of A+ Content data types to include in the response.
|
|
1379
|
+
*/
|
|
1380
|
+
readonly includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>;
|
|
1959
1381
|
}
|
|
1960
1382
|
/**
|
|
1961
1383
|
* Request parameters for listContentDocumentAsinRelations operation in AplusContentApi.
|
|
1962
1384
|
*/
|
|
1963
1385
|
interface AplusContentApiListContentDocumentAsinRelationsRequest {
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
|
|
1967
|
-
|
|
1968
|
-
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
|
|
1972
|
-
|
|
1973
|
-
|
|
1974
|
-
|
|
1975
|
-
|
|
1976
|
-
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
|
-
|
|
1386
|
+
/**
|
|
1387
|
+
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
1388
|
+
*/
|
|
1389
|
+
readonly contentReferenceKey: string;
|
|
1390
|
+
/**
|
|
1391
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1392
|
+
*/
|
|
1393
|
+
readonly marketplaceId: string;
|
|
1394
|
+
/**
|
|
1395
|
+
* The set of A+ Content data types to include in the response. If you don\'t include this parameter, the operation returns the related ASINs without metadata.
|
|
1396
|
+
*/
|
|
1397
|
+
readonly includedDataSet?: Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>;
|
|
1398
|
+
/**
|
|
1399
|
+
* The set of ASINs.
|
|
1400
|
+
*/
|
|
1401
|
+
readonly asinSet?: Set<string>;
|
|
1402
|
+
/**
|
|
1403
|
+
* A token that you use to fetch a specific page when there are multiple pages of results.
|
|
1404
|
+
*/
|
|
1405
|
+
readonly pageToken?: string;
|
|
1984
1406
|
}
|
|
1985
1407
|
/**
|
|
1986
1408
|
* Request parameters for postContentDocumentApprovalSubmission operation in AplusContentApi.
|
|
1987
1409
|
*/
|
|
1988
1410
|
interface AplusContentApiPostContentDocumentApprovalSubmissionRequest {
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
|
|
1994
|
-
|
|
1995
|
-
|
|
1996
|
-
|
|
1411
|
+
/**
|
|
1412
|
+
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
1413
|
+
*/
|
|
1414
|
+
readonly contentReferenceKey: string;
|
|
1415
|
+
/**
|
|
1416
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1417
|
+
*/
|
|
1418
|
+
readonly marketplaceId: string;
|
|
1997
1419
|
}
|
|
1998
1420
|
/**
|
|
1999
1421
|
* Request parameters for postContentDocumentAsinRelations operation in AplusContentApi.
|
|
2000
1422
|
*/
|
|
2001
1423
|
interface AplusContentApiPostContentDocumentAsinRelationsRequest {
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
|
|
2005
|
-
|
|
2006
|
-
|
|
2007
|
-
|
|
2008
|
-
|
|
2009
|
-
|
|
2010
|
-
|
|
2011
|
-
|
|
2012
|
-
|
|
2013
|
-
|
|
1424
|
+
/**
|
|
1425
|
+
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
1426
|
+
*/
|
|
1427
|
+
readonly contentReferenceKey: string;
|
|
1428
|
+
/**
|
|
1429
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1430
|
+
*/
|
|
1431
|
+
readonly marketplaceId: string;
|
|
1432
|
+
/**
|
|
1433
|
+
* The request details for the content document ASIN relations.
|
|
1434
|
+
*/
|
|
1435
|
+
readonly postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest;
|
|
2014
1436
|
}
|
|
2015
1437
|
/**
|
|
2016
1438
|
* Request parameters for postContentDocumentSuspendSubmission operation in AplusContentApi.
|
|
2017
1439
|
*/
|
|
2018
1440
|
interface AplusContentApiPostContentDocumentSuspendSubmissionRequest {
|
|
2019
|
-
|
|
2020
|
-
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
|
|
1441
|
+
/**
|
|
1442
|
+
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
1443
|
+
*/
|
|
1444
|
+
readonly contentReferenceKey: string;
|
|
1445
|
+
/**
|
|
1446
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1447
|
+
*/
|
|
1448
|
+
readonly marketplaceId: string;
|
|
2027
1449
|
}
|
|
2028
1450
|
/**
|
|
2029
1451
|
* Request parameters for searchContentDocuments operation in AplusContentApi.
|
|
2030
1452
|
*/
|
|
2031
1453
|
interface AplusContentApiSearchContentDocumentsRequest {
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
|
|
2035
|
-
|
|
2036
|
-
|
|
2037
|
-
|
|
2038
|
-
|
|
2039
|
-
|
|
1454
|
+
/**
|
|
1455
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1456
|
+
*/
|
|
1457
|
+
readonly marketplaceId: string;
|
|
1458
|
+
/**
|
|
1459
|
+
* A token that you use to fetch a specific page when there are multiple pages of results.
|
|
1460
|
+
*/
|
|
1461
|
+
readonly pageToken?: string;
|
|
2040
1462
|
}
|
|
2041
1463
|
/**
|
|
2042
1464
|
* Request parameters for searchContentPublishRecords operation in AplusContentApi.
|
|
2043
1465
|
*/
|
|
2044
1466
|
interface AplusContentApiSearchContentPublishRecordsRequest {
|
|
2045
|
-
|
|
2046
|
-
|
|
2047
|
-
|
|
2048
|
-
|
|
2049
|
-
|
|
2050
|
-
|
|
2051
|
-
|
|
2052
|
-
|
|
2053
|
-
|
|
2054
|
-
|
|
2055
|
-
|
|
2056
|
-
|
|
1467
|
+
/**
|
|
1468
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1469
|
+
*/
|
|
1470
|
+
readonly marketplaceId: string;
|
|
1471
|
+
/**
|
|
1472
|
+
* The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
1473
|
+
*/
|
|
1474
|
+
readonly asin: string;
|
|
1475
|
+
/**
|
|
1476
|
+
* A token that you use to fetch a specific page when there are multiple pages of results.
|
|
1477
|
+
*/
|
|
1478
|
+
readonly pageToken?: string;
|
|
2057
1479
|
}
|
|
2058
1480
|
/**
|
|
2059
1481
|
* Request parameters for updateContentDocument operation in AplusContentApi.
|
|
2060
1482
|
*/
|
|
2061
1483
|
interface AplusContentApiUpdateContentDocumentRequest {
|
|
2062
|
-
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
|
|
2067
|
-
|
|
2068
|
-
|
|
2069
|
-
|
|
2070
|
-
|
|
2071
|
-
|
|
2072
|
-
|
|
2073
|
-
|
|
1484
|
+
/**
|
|
1485
|
+
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
1486
|
+
*/
|
|
1487
|
+
readonly contentReferenceKey: string;
|
|
1488
|
+
/**
|
|
1489
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1490
|
+
*/
|
|
1491
|
+
readonly marketplaceId: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* The content document request details.
|
|
1494
|
+
*/
|
|
1495
|
+
readonly postContentDocumentRequest: PostContentDocumentRequest;
|
|
2074
1496
|
}
|
|
2075
1497
|
/**
|
|
2076
1498
|
* Request parameters for validateContentDocumentAsinRelations operation in AplusContentApi.
|
|
2077
1499
|
*/
|
|
2078
1500
|
interface AplusContentApiValidateContentDocumentAsinRelationsRequest {
|
|
2079
|
-
|
|
2080
|
-
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
1501
|
+
/**
|
|
1502
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1503
|
+
*/
|
|
1504
|
+
readonly marketplaceId: string;
|
|
1505
|
+
/**
|
|
1506
|
+
* The content document request details.
|
|
1507
|
+
*/
|
|
1508
|
+
readonly postContentDocumentRequest: PostContentDocumentRequest;
|
|
1509
|
+
/**
|
|
1510
|
+
* The set of ASINs.
|
|
1511
|
+
*/
|
|
1512
|
+
readonly asinSet?: Set<string>;
|
|
2091
1513
|
}
|
|
2092
1514
|
/**
|
|
2093
1515
|
* AplusContentApi - object-oriented interface
|
|
2094
1516
|
*/
|
|
2095
1517
|
declare class AplusContentApi extends BaseAPI {
|
|
2096
|
-
|
|
2097
|
-
|
|
2098
|
-
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
|
-
|
|
2104
|
-
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
|
|
2116
|
-
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
|
-
|
|
2122
|
-
|
|
2123
|
-
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
|
-
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
|
|
2136
|
-
|
|
2137
|
-
|
|
2138
|
-
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
|
|
2147
|
-
|
|
2148
|
-
|
|
2149
|
-
|
|
2150
|
-
|
|
2151
|
-
|
|
2152
|
-
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
|
|
2156
|
-
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
1518
|
+
/**
|
|
1519
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1520
|
+
* @param {AplusContentApiCreateContentDocumentRequest} requestParameters Request parameters.
|
|
1521
|
+
* @param {*} [options] Override http request option.
|
|
1522
|
+
* @throws {RequiredError}
|
|
1523
|
+
*/
|
|
1524
|
+
createContentDocument(requestParameters: AplusContentApiCreateContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PostContentDocumentResponse, any, {}>>;
|
|
1525
|
+
/**
|
|
1526
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1527
|
+
* @param {AplusContentApiGetContentDocumentRequest} requestParameters Request parameters.
|
|
1528
|
+
* @param {*} [options] Override http request option.
|
|
1529
|
+
* @throws {RequiredError}
|
|
1530
|
+
*/
|
|
1531
|
+
getContentDocument(requestParameters: AplusContentApiGetContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetContentDocumentResponse, any, {}>>;
|
|
1532
|
+
/**
|
|
1533
|
+
* Returns a list of ASINs that are related to the specified A+ Content document, if available. If you don\'t include the `asinSet` parameter, this operation returns all ASINs related to the content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1534
|
+
* @param {AplusContentApiListContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
1535
|
+
* @param {*} [options] Override http request option.
|
|
1536
|
+
* @throws {RequiredError}
|
|
1537
|
+
*/
|
|
1538
|
+
listContentDocumentAsinRelations(requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListContentDocumentAsinRelationsResponse, any, {}>>;
|
|
1539
|
+
/**
|
|
1540
|
+
* Submits an A+ Content document for review, approval, and publishing. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1541
|
+
* @param {AplusContentApiPostContentDocumentApprovalSubmissionRequest} requestParameters Request parameters.
|
|
1542
|
+
* @param {*} [options] Override http request option.
|
|
1543
|
+
* @throws {RequiredError}
|
|
1544
|
+
*/
|
|
1545
|
+
postContentDocumentApprovalSubmission(requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AplusResponse, any, {}>>;
|
|
1546
|
+
/**
|
|
1547
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This operation can add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN will suspend the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1548
|
+
* @param {AplusContentApiPostContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
1549
|
+
* @param {*} [options] Override http request option.
|
|
1550
|
+
* @throws {RequiredError}
|
|
1551
|
+
*/
|
|
1552
|
+
postContentDocumentAsinRelations(requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AplusResponse, any, {}>>;
|
|
1553
|
+
/**
|
|
1554
|
+
* Submits a request to suspend visible A+ Content. This doesn\'t delete the content document or the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1555
|
+
* @param {AplusContentApiPostContentDocumentSuspendSubmissionRequest} requestParameters Request parameters.
|
|
1556
|
+
* @param {*} [options] Override http request option.
|
|
1557
|
+
* @throws {RequiredError}
|
|
1558
|
+
*/
|
|
1559
|
+
postContentDocumentSuspendSubmission(requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AplusResponse, any, {}>>;
|
|
1560
|
+
/**
|
|
1561
|
+
* Returns a list of all A+ Content documents, including metadata, that are assigned to a selling partner. To get the actual contents of the A+ Content documents, call the `getContentDocument` operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1562
|
+
* @param {AplusContentApiSearchContentDocumentsRequest} requestParameters Request parameters.
|
|
1563
|
+
* @param {*} [options] Override http request option.
|
|
1564
|
+
* @throws {RequiredError}
|
|
1565
|
+
*/
|
|
1566
|
+
searchContentDocuments(requestParameters: AplusContentApiSearchContentDocumentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchContentDocumentsResponse, any, {}>>;
|
|
1567
|
+
/**
|
|
1568
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1569
|
+
* @param {AplusContentApiSearchContentPublishRecordsRequest} requestParameters Request parameters.
|
|
1570
|
+
* @param {*} [options] Override http request option.
|
|
1571
|
+
* @throws {RequiredError}
|
|
1572
|
+
*/
|
|
1573
|
+
searchContentPublishRecords(requestParameters: AplusContentApiSearchContentPublishRecordsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchContentPublishRecordsResponse, any, {}>>;
|
|
1574
|
+
/**
|
|
1575
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1576
|
+
* @param {AplusContentApiUpdateContentDocumentRequest} requestParameters Request parameters.
|
|
1577
|
+
* @param {*} [options] Override http request option.
|
|
1578
|
+
* @throws {RequiredError}
|
|
1579
|
+
*/
|
|
1580
|
+
updateContentDocument(requestParameters: AplusContentApiUpdateContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PostContentDocumentResponse, any, {}>>;
|
|
1581
|
+
/**
|
|
1582
|
+
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1583
|
+
* @param {AplusContentApiValidateContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
1584
|
+
* @param {*} [options] Override http request option.
|
|
1585
|
+
* @throws {RequiredError}
|
|
1586
|
+
*/
|
|
1587
|
+
validateContentDocumentAsinRelations(requestParameters: AplusContentApiValidateContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValidateContentDocumentAsinRelationsResponse, any, {}>>;
|
|
2166
1588
|
}
|
|
2167
1589
|
declare const GetContentDocumentIncludedDataSetEnum: {
|
|
2168
|
-
|
|
2169
|
-
|
|
1590
|
+
readonly Contents: "CONTENTS";
|
|
1591
|
+
readonly Metadata: "METADATA";
|
|
2170
1592
|
};
|
|
2171
1593
|
type GetContentDocumentIncludedDataSetEnum = typeof GetContentDocumentIncludedDataSetEnum[keyof typeof GetContentDocumentIncludedDataSetEnum];
|
|
2172
1594
|
declare const ListContentDocumentAsinRelationsIncludedDataSetEnum: {
|
|
2173
|
-
|
|
1595
|
+
readonly Metadata: "METADATA";
|
|
2174
1596
|
};
|
|
2175
1597
|
type ListContentDocumentAsinRelationsIncludedDataSetEnum = typeof ListContentDocumentAsinRelationsIncludedDataSetEnum[keyof typeof ListContentDocumentAsinRelationsIncludedDataSetEnum];
|
|
2176
|
-
|
|
1598
|
+
//#endregion
|
|
1599
|
+
//#region src/client.d.ts
|
|
2177
1600
|
declare const clientRateLimits: RateLimit[];
|
|
2178
1601
|
declare class AplusContentApiClient extends AplusContentApi {
|
|
2179
|
-
|
|
1602
|
+
constructor(configuration: ClientConfiguration);
|
|
2180
1603
|
}
|
|
2181
|
-
|
|
2182
|
-
export { AplusContentApi, AplusContentApiAxiosParamCreator, AplusContentApiClient,
|
|
1604
|
+
//#endregion
|
|
1605
|
+
export { AplusContentApi, AplusContentApiAxiosParamCreator, AplusContentApiClient, AplusContentApiCreateContentDocumentRequest, AplusContentApiFactory, AplusContentApiFp, AplusContentApiGetContentDocumentRequest, AplusContentApiListContentDocumentAsinRelationsRequest, AplusContentApiPostContentDocumentApprovalSubmissionRequest, AplusContentApiPostContentDocumentAsinRelationsRequest, AplusContentApiPostContentDocumentSuspendSubmissionRequest, AplusContentApiSearchContentDocumentsRequest, AplusContentApiSearchContentPublishRecordsRequest, AplusContentApiUpdateContentDocumentRequest, AplusContentApiValidateContentDocumentAsinRelationsRequest, AplusPaginatedResponse, AplusPaginatedResponseAllOf, AplusResponse, AsinBadge, AsinMetadata, ColorType, ContentBadge, ContentDocument, ContentMetadata, ContentMetadataRecord, ContentModule, ContentModuleType, ContentRecord, ContentStatus, ContentType, Decorator, DecoratorType, ErrorList, GetContentDocumentIncludedDataSetEnum, GetContentDocumentResponse, GetContentDocumentResponseAllOf, ImageComponent, ImageCropSpecification, ImageDimensions, ImageOffsets, IntegerWithUnits, ListContentDocumentAsinRelationsIncludedDataSetEnum, ListContentDocumentAsinRelationsResponse, ListContentDocumentAsinRelationsResponseAllOf, ModelError, ParagraphComponent, PlainTextItem, PositionType, PostContentDocumentApprovalSubmissionResponse, PostContentDocumentAsinRelationsRequest, PostContentDocumentAsinRelationsResponse, PostContentDocumentRequest, PostContentDocumentResponse, PostContentDocumentResponseAllOf, PostContentDocumentSuspendSubmissionResponse, PublishRecord, SearchContentDocumentsResponse, SearchContentDocumentsResponseAllOf, SearchContentPublishRecordsResponse, SearchContentPublishRecordsResponseAllOf, StandardCompanyLogoModule, StandardComparisonProductBlock, StandardComparisonTableModule, StandardFourImageTextModule, StandardFourImageTextQuadrantModule, StandardHeaderImageTextModule, StandardHeaderTextListBlock, StandardImageCaptionBlock, StandardImageSidebarModule, StandardImageTextBlock, StandardImageTextCaptionBlock, StandardImageTextOverlayModule, StandardMultipleImageTextModule, StandardProductDescriptionModule, StandardSingleImageHighlightsModule, StandardSingleImageSpecsDetailModule, StandardSingleSideImageModule, StandardTechSpecsModule, StandardTextBlock, StandardTextListBlock, StandardTextModule, StandardTextPairBlock, StandardThreeImageTextModule, TextComponent, TextItem, ValidateContentDocumentAsinRelationsResponse, clientRateLimits };
|
|
1606
|
+
//# sourceMappingURL=index.d.ts.map
|