@sp-api-sdk/aplus-content-api-2020-11-01 2.3.8 → 3.0.1
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 +4 -2
- package/dist/cjs/api-model/api/aplus-content-api.js +40 -40
- package/dist/cjs/api-model/configuration.js +7 -1
- package/dist/cjs/api-model/models/content-module-type.js +15 -15
- package/dist/es/api-model/api/aplus-content-api.js +40 -40
- package/dist/es/api-model/configuration.js +7 -1
- package/dist/es/api-model/models/content-module-type.js +15 -15
- package/dist/types/api-model/api/aplus-content-api.d.ts +40 -40
- package/dist/types/api-model/models/content-module-type.d.ts +15 -15
- package/dist/types/api-model/models/model-error.d.ts +3 -3
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -2,8 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
With the A+ Content API, you can build applications that help selling partners add rich marketing content to their Amazon product detail pages. A+ content helps selling partners share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners assemble content by choosing from content modules and adding images and text.
|
|
4
4
|
|
|
5
|
-
[](https://www.npmjs.com/package/@sp-api-sdk/aplus-content-api-2020-11-01)
|
|
6
|
+
[](https://github.com/xojs/xo)
|
|
7
|
+
|
|
8
|
+
[<img src="https://files.bizon.solutions/images/logo/bizon-horizontal.png" alt="Bizon" width="250"/>](https://www.bizon.solutions?utm_source=github&utm_medium=readme&utm_campaign=selling-partner-api-sdk)
|
|
7
9
|
|
|
8
10
|
## Documentation
|
|
9
11
|
|
|
@@ -30,7 +30,7 @@ const base_1 = require("../base");
|
|
|
30
30
|
const AplusContentApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
|
-
* Creates a new A+ Content document. **Usage
|
|
33
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
34
34
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
35
35
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
36
36
|
* @param {*} [options] Override http request option.
|
|
@@ -65,7 +65,7 @@ const AplusContentApiAxiosParamCreator = function (configuration) {
|
|
|
65
65
|
};
|
|
66
66
|
},
|
|
67
67
|
/**
|
|
68
|
-
* Returns an A+ Content document, if available. **Usage
|
|
68
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
69
69
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
70
70
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
71
71
|
* @param {Set<GetContentDocumentIncludedDataSetEnum>} includedDataSet The set of A+ Content data types to include in the response.
|
|
@@ -105,7 +105,7 @@ const AplusContentApiAxiosParamCreator = function (configuration) {
|
|
|
105
105
|
};
|
|
106
106
|
},
|
|
107
107
|
/**
|
|
108
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. **Usage
|
|
108
|
+
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the `asinSet` parameter, the 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
109
109
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
110
110
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
111
111
|
* @param {Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>} [includedDataSet] The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata.
|
|
@@ -151,7 +151,7 @@ const AplusContentApiAxiosParamCreator = function (configuration) {
|
|
|
151
151
|
};
|
|
152
152
|
},
|
|
153
153
|
/**
|
|
154
|
-
* Submits an A+ Content document for review, approval, and publishing. **Usage
|
|
154
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
155
155
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
156
156
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
157
157
|
* @param {*} [options] Override http request option.
|
|
@@ -185,7 +185,7 @@ const AplusContentApiAxiosParamCreator = function (configuration) {
|
|
|
185
185
|
};
|
|
186
186
|
},
|
|
187
187
|
/**
|
|
188
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage
|
|
188
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
189
189
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
190
190
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
191
191
|
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The content document ASIN relations request details.
|
|
@@ -224,7 +224,7 @@ const AplusContentApiAxiosParamCreator = function (configuration) {
|
|
|
224
224
|
};
|
|
225
225
|
},
|
|
226
226
|
/**
|
|
227
|
-
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage
|
|
227
|
+
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
228
228
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
229
229
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
230
230
|
* @param {*} [options] Override http request option.
|
|
@@ -258,7 +258,7 @@ const AplusContentApiAxiosParamCreator = function (configuration) {
|
|
|
258
258
|
};
|
|
259
259
|
},
|
|
260
260
|
/**
|
|
261
|
-
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage
|
|
261
|
+
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
262
262
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
263
263
|
* @param {string} [pageToken] A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations.
|
|
264
264
|
* @param {*} [options] Override http request option.
|
|
@@ -292,7 +292,7 @@ const AplusContentApiAxiosParamCreator = function (configuration) {
|
|
|
292
292
|
};
|
|
293
293
|
},
|
|
294
294
|
/**
|
|
295
|
-
* Searches for A+ Content publishing records, if available. **Usage
|
|
295
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
296
296
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
297
297
|
* @param {string} asin The Amazon Standard Identification Number (ASIN).
|
|
298
298
|
* @param {string} [pageToken] A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations.
|
|
@@ -332,7 +332,7 @@ const AplusContentApiAxiosParamCreator = function (configuration) {
|
|
|
332
332
|
};
|
|
333
333
|
},
|
|
334
334
|
/**
|
|
335
|
-
* Updates an existing A+ Content document. **Usage
|
|
335
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
336
336
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
337
337
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
338
338
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
@@ -371,7 +371,7 @@ const AplusContentApiAxiosParamCreator = function (configuration) {
|
|
|
371
371
|
};
|
|
372
372
|
},
|
|
373
373
|
/**
|
|
374
|
-
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage
|
|
374
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
375
375
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
376
376
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
377
377
|
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
@@ -420,7 +420,7 @@ const AplusContentApiFp = function (configuration) {
|
|
|
420
420
|
const localVarAxiosParamCreator = (0, exports.AplusContentApiAxiosParamCreator)(configuration);
|
|
421
421
|
return {
|
|
422
422
|
/**
|
|
423
|
-
* Creates a new A+ Content document. **Usage
|
|
423
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
424
424
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
425
425
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
426
426
|
* @param {*} [options] Override http request option.
|
|
@@ -433,7 +433,7 @@ const AplusContentApiFp = function (configuration) {
|
|
|
433
433
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
434
434
|
},
|
|
435
435
|
/**
|
|
436
|
-
* Returns an A+ Content document, if available. **Usage
|
|
436
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
437
437
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
438
438
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
439
439
|
* @param {Set<GetContentDocumentIncludedDataSetEnum>} includedDataSet The set of A+ Content data types to include in the response.
|
|
@@ -447,7 +447,7 @@ const AplusContentApiFp = function (configuration) {
|
|
|
447
447
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
448
448
|
},
|
|
449
449
|
/**
|
|
450
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. **Usage
|
|
450
|
+
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the `asinSet` parameter, the 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
451
451
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
452
452
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
453
453
|
* @param {Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>} [includedDataSet] The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata.
|
|
@@ -463,7 +463,7 @@ const AplusContentApiFp = function (configuration) {
|
|
|
463
463
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
464
464
|
},
|
|
465
465
|
/**
|
|
466
|
-
* Submits an A+ Content document for review, approval, and publishing. **Usage
|
|
466
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
467
467
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
468
468
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
469
469
|
* @param {*} [options] Override http request option.
|
|
@@ -476,7 +476,7 @@ const AplusContentApiFp = function (configuration) {
|
|
|
476
476
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
477
477
|
},
|
|
478
478
|
/**
|
|
479
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage
|
|
479
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
480
480
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
481
481
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
482
482
|
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The content document ASIN relations request details.
|
|
@@ -490,7 +490,7 @@ const AplusContentApiFp = function (configuration) {
|
|
|
490
490
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
491
491
|
},
|
|
492
492
|
/**
|
|
493
|
-
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage
|
|
493
|
+
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
494
494
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
495
495
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
496
496
|
* @param {*} [options] Override http request option.
|
|
@@ -503,7 +503,7 @@ const AplusContentApiFp = function (configuration) {
|
|
|
503
503
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
504
504
|
},
|
|
505
505
|
/**
|
|
506
|
-
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage
|
|
506
|
+
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
507
507
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
508
508
|
* @param {string} [pageToken] A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations.
|
|
509
509
|
* @param {*} [options] Override http request option.
|
|
@@ -516,7 +516,7 @@ const AplusContentApiFp = function (configuration) {
|
|
|
516
516
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
517
517
|
},
|
|
518
518
|
/**
|
|
519
|
-
* Searches for A+ Content publishing records, if available. **Usage
|
|
519
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
520
520
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
521
521
|
* @param {string} asin The Amazon Standard Identification Number (ASIN).
|
|
522
522
|
* @param {string} [pageToken] A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations.
|
|
@@ -530,7 +530,7 @@ const AplusContentApiFp = function (configuration) {
|
|
|
530
530
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
531
531
|
},
|
|
532
532
|
/**
|
|
533
|
-
* Updates an existing A+ Content document. **Usage
|
|
533
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
534
534
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
535
535
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
536
536
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
@@ -544,7 +544,7 @@ const AplusContentApiFp = function (configuration) {
|
|
|
544
544
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
545
545
|
},
|
|
546
546
|
/**
|
|
547
|
-
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage
|
|
547
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
548
548
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
549
549
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
550
550
|
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
@@ -568,7 +568,7 @@ const AplusContentApiFactory = function (configuration, basePath, axios) {
|
|
|
568
568
|
const localVarFp = (0, exports.AplusContentApiFp)(configuration);
|
|
569
569
|
return {
|
|
570
570
|
/**
|
|
571
|
-
* Creates a new A+ Content document. **Usage
|
|
571
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
572
572
|
* @param {AplusContentApiCreateContentDocumentRequest} requestParameters Request parameters.
|
|
573
573
|
* @param {*} [options] Override http request option.
|
|
574
574
|
* @throws {RequiredError}
|
|
@@ -577,7 +577,7 @@ const AplusContentApiFactory = function (configuration, basePath, axios) {
|
|
|
577
577
|
return localVarFp.createContentDocument(requestParameters.marketplaceId, requestParameters.postContentDocumentRequest, options).then((request) => request(axios, basePath));
|
|
578
578
|
},
|
|
579
579
|
/**
|
|
580
|
-
* Returns an A+ Content document, if available. **Usage
|
|
580
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
581
581
|
* @param {AplusContentApiGetContentDocumentRequest} requestParameters Request parameters.
|
|
582
582
|
* @param {*} [options] Override http request option.
|
|
583
583
|
* @throws {RequiredError}
|
|
@@ -586,7 +586,7 @@ const AplusContentApiFactory = function (configuration, basePath, axios) {
|
|
|
586
586
|
return localVarFp.getContentDocument(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.includedDataSet, options).then((request) => request(axios, basePath));
|
|
587
587
|
},
|
|
588
588
|
/**
|
|
589
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. **Usage
|
|
589
|
+
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the `asinSet` parameter, the 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
590
590
|
* @param {AplusContentApiListContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
591
591
|
* @param {*} [options] Override http request option.
|
|
592
592
|
* @throws {RequiredError}
|
|
@@ -595,7 +595,7 @@ const AplusContentApiFactory = function (configuration, basePath, axios) {
|
|
|
595
595
|
return localVarFp.listContentDocumentAsinRelations(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.includedDataSet, requestParameters.asinSet, requestParameters.pageToken, options).then((request) => request(axios, basePath));
|
|
596
596
|
},
|
|
597
597
|
/**
|
|
598
|
-
* Submits an A+ Content document for review, approval, and publishing. **Usage
|
|
598
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
599
599
|
* @param {AplusContentApiPostContentDocumentApprovalSubmissionRequest} requestParameters Request parameters.
|
|
600
600
|
* @param {*} [options] Override http request option.
|
|
601
601
|
* @throws {RequiredError}
|
|
@@ -604,7 +604,7 @@ const AplusContentApiFactory = function (configuration, basePath, axios) {
|
|
|
604
604
|
return localVarFp.postContentDocumentApprovalSubmission(requestParameters.contentReferenceKey, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
|
|
605
605
|
},
|
|
606
606
|
/**
|
|
607
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage
|
|
607
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
608
608
|
* @param {AplusContentApiPostContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
609
609
|
* @param {*} [options] Override http request option.
|
|
610
610
|
* @throws {RequiredError}
|
|
@@ -613,7 +613,7 @@ const AplusContentApiFactory = function (configuration, basePath, axios) {
|
|
|
613
613
|
return localVarFp.postContentDocumentAsinRelations(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.postContentDocumentAsinRelationsRequest, options).then((request) => request(axios, basePath));
|
|
614
614
|
},
|
|
615
615
|
/**
|
|
616
|
-
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage
|
|
616
|
+
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
617
617
|
* @param {AplusContentApiPostContentDocumentSuspendSubmissionRequest} requestParameters Request parameters.
|
|
618
618
|
* @param {*} [options] Override http request option.
|
|
619
619
|
* @throws {RequiredError}
|
|
@@ -622,7 +622,7 @@ const AplusContentApiFactory = function (configuration, basePath, axios) {
|
|
|
622
622
|
return localVarFp.postContentDocumentSuspendSubmission(requestParameters.contentReferenceKey, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
|
|
623
623
|
},
|
|
624
624
|
/**
|
|
625
|
-
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage
|
|
625
|
+
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
626
626
|
* @param {AplusContentApiSearchContentDocumentsRequest} requestParameters Request parameters.
|
|
627
627
|
* @param {*} [options] Override http request option.
|
|
628
628
|
* @throws {RequiredError}
|
|
@@ -631,7 +631,7 @@ const AplusContentApiFactory = function (configuration, basePath, axios) {
|
|
|
631
631
|
return localVarFp.searchContentDocuments(requestParameters.marketplaceId, requestParameters.pageToken, options).then((request) => request(axios, basePath));
|
|
632
632
|
},
|
|
633
633
|
/**
|
|
634
|
-
* Searches for A+ Content publishing records, if available. **Usage
|
|
634
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
635
635
|
* @param {AplusContentApiSearchContentPublishRecordsRequest} requestParameters Request parameters.
|
|
636
636
|
* @param {*} [options] Override http request option.
|
|
637
637
|
* @throws {RequiredError}
|
|
@@ -640,7 +640,7 @@ const AplusContentApiFactory = function (configuration, basePath, axios) {
|
|
|
640
640
|
return localVarFp.searchContentPublishRecords(requestParameters.marketplaceId, requestParameters.asin, requestParameters.pageToken, options).then((request) => request(axios, basePath));
|
|
641
641
|
},
|
|
642
642
|
/**
|
|
643
|
-
* Updates an existing A+ Content document. **Usage
|
|
643
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
644
644
|
* @param {AplusContentApiUpdateContentDocumentRequest} requestParameters Request parameters.
|
|
645
645
|
* @param {*} [options] Override http request option.
|
|
646
646
|
* @throws {RequiredError}
|
|
@@ -649,7 +649,7 @@ const AplusContentApiFactory = function (configuration, basePath, axios) {
|
|
|
649
649
|
return localVarFp.updateContentDocument(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.postContentDocumentRequest, options).then((request) => request(axios, basePath));
|
|
650
650
|
},
|
|
651
651
|
/**
|
|
652
|
-
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage
|
|
652
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
653
653
|
* @param {AplusContentApiValidateContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
654
654
|
* @param {*} [options] Override http request option.
|
|
655
655
|
* @throws {RequiredError}
|
|
@@ -668,7 +668,7 @@ exports.AplusContentApiFactory = AplusContentApiFactory;
|
|
|
668
668
|
*/
|
|
669
669
|
class AplusContentApi extends base_1.BaseAPI {
|
|
670
670
|
/**
|
|
671
|
-
* Creates a new A+ Content document. **Usage
|
|
671
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
672
672
|
* @param {AplusContentApiCreateContentDocumentRequest} requestParameters Request parameters.
|
|
673
673
|
* @param {*} [options] Override http request option.
|
|
674
674
|
* @throws {RequiredError}
|
|
@@ -678,7 +678,7 @@ class AplusContentApi extends base_1.BaseAPI {
|
|
|
678
678
|
return (0, exports.AplusContentApiFp)(this.configuration).createContentDocument(requestParameters.marketplaceId, requestParameters.postContentDocumentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
679
679
|
}
|
|
680
680
|
/**
|
|
681
|
-
* Returns an A+ Content document, if available. **Usage
|
|
681
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
682
682
|
* @param {AplusContentApiGetContentDocumentRequest} requestParameters Request parameters.
|
|
683
683
|
* @param {*} [options] Override http request option.
|
|
684
684
|
* @throws {RequiredError}
|
|
@@ -688,7 +688,7 @@ class AplusContentApi extends base_1.BaseAPI {
|
|
|
688
688
|
return (0, exports.AplusContentApiFp)(this.configuration).getContentDocument(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.includedDataSet, options).then((request) => request(this.axios, this.basePath));
|
|
689
689
|
}
|
|
690
690
|
/**
|
|
691
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. **Usage
|
|
691
|
+
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the `asinSet` parameter, the 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
692
692
|
* @param {AplusContentApiListContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
693
693
|
* @param {*} [options] Override http request option.
|
|
694
694
|
* @throws {RequiredError}
|
|
@@ -698,7 +698,7 @@ class AplusContentApi extends base_1.BaseAPI {
|
|
|
698
698
|
return (0, exports.AplusContentApiFp)(this.configuration).listContentDocumentAsinRelations(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.includedDataSet, requestParameters.asinSet, requestParameters.pageToken, options).then((request) => request(this.axios, this.basePath));
|
|
699
699
|
}
|
|
700
700
|
/**
|
|
701
|
-
* Submits an A+ Content document for review, approval, and publishing. **Usage
|
|
701
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
702
702
|
* @param {AplusContentApiPostContentDocumentApprovalSubmissionRequest} requestParameters Request parameters.
|
|
703
703
|
* @param {*} [options] Override http request option.
|
|
704
704
|
* @throws {RequiredError}
|
|
@@ -708,7 +708,7 @@ class AplusContentApi extends base_1.BaseAPI {
|
|
|
708
708
|
return (0, exports.AplusContentApiFp)(this.configuration).postContentDocumentApprovalSubmission(requestParameters.contentReferenceKey, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath));
|
|
709
709
|
}
|
|
710
710
|
/**
|
|
711
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage
|
|
711
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
712
712
|
* @param {AplusContentApiPostContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
713
713
|
* @param {*} [options] Override http request option.
|
|
714
714
|
* @throws {RequiredError}
|
|
@@ -718,7 +718,7 @@ class AplusContentApi extends base_1.BaseAPI {
|
|
|
718
718
|
return (0, exports.AplusContentApiFp)(this.configuration).postContentDocumentAsinRelations(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.postContentDocumentAsinRelationsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
719
719
|
}
|
|
720
720
|
/**
|
|
721
|
-
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage
|
|
721
|
+
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
722
722
|
* @param {AplusContentApiPostContentDocumentSuspendSubmissionRequest} requestParameters Request parameters.
|
|
723
723
|
* @param {*} [options] Override http request option.
|
|
724
724
|
* @throws {RequiredError}
|
|
@@ -728,7 +728,7 @@ class AplusContentApi extends base_1.BaseAPI {
|
|
|
728
728
|
return (0, exports.AplusContentApiFp)(this.configuration).postContentDocumentSuspendSubmission(requestParameters.contentReferenceKey, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath));
|
|
729
729
|
}
|
|
730
730
|
/**
|
|
731
|
-
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage
|
|
731
|
+
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
732
732
|
* @param {AplusContentApiSearchContentDocumentsRequest} requestParameters Request parameters.
|
|
733
733
|
* @param {*} [options] Override http request option.
|
|
734
734
|
* @throws {RequiredError}
|
|
@@ -738,7 +738,7 @@ class AplusContentApi extends base_1.BaseAPI {
|
|
|
738
738
|
return (0, exports.AplusContentApiFp)(this.configuration).searchContentDocuments(requestParameters.marketplaceId, requestParameters.pageToken, options).then((request) => request(this.axios, this.basePath));
|
|
739
739
|
}
|
|
740
740
|
/**
|
|
741
|
-
* Searches for A+ Content publishing records, if available. **Usage
|
|
741
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
742
742
|
* @param {AplusContentApiSearchContentPublishRecordsRequest} requestParameters Request parameters.
|
|
743
743
|
* @param {*} [options] Override http request option.
|
|
744
744
|
* @throws {RequiredError}
|
|
@@ -748,7 +748,7 @@ class AplusContentApi extends base_1.BaseAPI {
|
|
|
748
748
|
return (0, exports.AplusContentApiFp)(this.configuration).searchContentPublishRecords(requestParameters.marketplaceId, requestParameters.asin, requestParameters.pageToken, options).then((request) => request(this.axios, this.basePath));
|
|
749
749
|
}
|
|
750
750
|
/**
|
|
751
|
-
* Updates an existing A+ Content document. **Usage
|
|
751
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
752
752
|
* @param {AplusContentApiUpdateContentDocumentRequest} requestParameters Request parameters.
|
|
753
753
|
* @param {*} [options] Override http request option.
|
|
754
754
|
* @throws {RequiredError}
|
|
@@ -758,7 +758,7 @@ class AplusContentApi extends base_1.BaseAPI {
|
|
|
758
758
|
return (0, exports.AplusContentApiFp)(this.configuration).updateContentDocument(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.postContentDocumentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
759
759
|
}
|
|
760
760
|
/**
|
|
761
|
-
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage
|
|
761
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
762
762
|
* @param {AplusContentApiValidateContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
763
763
|
* @param {*} [options] Override http request option.
|
|
764
764
|
* @throws {RequiredError}
|
|
@@ -78,7 +78,13 @@ class Configuration {
|
|
|
78
78
|
this.accessToken = param.accessToken;
|
|
79
79
|
this.basePath = param.basePath;
|
|
80
80
|
this.serverIndex = param.serverIndex;
|
|
81
|
-
this.baseOptions =
|
|
81
|
+
this.baseOptions = {
|
|
82
|
+
headers: {
|
|
83
|
+
...param.baseOptions?.headers,
|
|
84
|
+
'User-Agent': "OpenAPI-Generator/typescript-axios"
|
|
85
|
+
},
|
|
86
|
+
...param.baseOptions
|
|
87
|
+
};
|
|
82
88
|
this.formDataCtor = param.formDataCtor;
|
|
83
89
|
}
|
|
84
90
|
/**
|
|
@@ -20,19 +20,19 @@ exports.ContentModuleType = void 0;
|
|
|
20
20
|
* @enum {string}
|
|
21
21
|
*/
|
|
22
22
|
exports.ContentModuleType = {
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
23
|
+
StandardCompanyLogo: 'STANDARD_COMPANY_LOGO',
|
|
24
|
+
StandardComparisonTable: 'STANDARD_COMPARISON_TABLE',
|
|
25
|
+
StandardFourImageText: 'STANDARD_FOUR_IMAGE_TEXT',
|
|
26
|
+
StandardFourImageTextQuadrant: 'STANDARD_FOUR_IMAGE_TEXT_QUADRANT',
|
|
27
|
+
StandardHeaderImageText: 'STANDARD_HEADER_IMAGE_TEXT',
|
|
28
|
+
StandardImageSidebar: 'STANDARD_IMAGE_SIDEBAR',
|
|
29
|
+
StandardImageTextOverlay: 'STANDARD_IMAGE_TEXT_OVERLAY',
|
|
30
|
+
StandardMultipleImageText: 'STANDARD_MULTIPLE_IMAGE_TEXT',
|
|
31
|
+
StandardProductDescription: 'STANDARD_PRODUCT_DESCRIPTION',
|
|
32
|
+
StandardSingleImageHighlights: 'STANDARD_SINGLE_IMAGE_HIGHLIGHTS',
|
|
33
|
+
StandardSingleImageSpecsDetail: 'STANDARD_SINGLE_IMAGE_SPECS_DETAIL',
|
|
34
|
+
StandardSingleSideImage: 'STANDARD_SINGLE_SIDE_IMAGE',
|
|
35
|
+
StandardTechSpecs: 'STANDARD_TECH_SPECS',
|
|
36
|
+
StandardText: 'STANDARD_TEXT',
|
|
37
|
+
StandardThreeImageText: 'STANDARD_THREE_IMAGE_TEXT'
|
|
38
38
|
};
|