@sp-api-sdk/aplus-content-api-2020-11-01 3.1.20 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/index.cjs +1093 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +2182 -0
- package/dist/index.d.ts +2182 -0
- package/dist/index.js +1041 -0
- package/dist/index.js.map +1 -0
- package/package.json +23 -12
- package/dist/cjs/api-model/api/aplus-content-api.js +0 -772
- package/dist/cjs/api-model/api.js +0 -30
- package/dist/cjs/api-model/base.js +0 -52
- package/dist/cjs/api-model/common.js +0 -123
- package/dist/cjs/api-model/configuration.js +0 -98
- package/dist/cjs/api-model/index.js +0 -32
- package/dist/cjs/api-model/models/aplus-paginated-response-all-of.js +0 -15
- package/dist/cjs/api-model/models/aplus-paginated-response.js +0 -15
- package/dist/cjs/api-model/models/aplus-response.js +0 -15
- package/dist/cjs/api-model/models/asin-badge.js +0 -25
- package/dist/cjs/api-model/models/asin-metadata.js +0 -15
- package/dist/cjs/api-model/models/color-type.js +0 -23
- package/dist/cjs/api-model/models/content-badge.js +0 -26
- package/dist/cjs/api-model/models/content-document.js +0 -15
- package/dist/cjs/api-model/models/content-metadata-record.js +0 -15
- package/dist/cjs/api-model/models/content-metadata.js +0 -15
- package/dist/cjs/api-model/models/content-module-type.js +0 -36
- package/dist/cjs/api-model/models/content-module.js +0 -15
- package/dist/cjs/api-model/models/content-record.js +0 -15
- package/dist/cjs/api-model/models/content-status.js +0 -25
- package/dist/cjs/api-model/models/content-type.js +0 -23
- package/dist/cjs/api-model/models/decorator-type.js +0 -29
- package/dist/cjs/api-model/models/decorator.js +0 -15
- package/dist/cjs/api-model/models/error-list.js +0 -15
- package/dist/cjs/api-model/models/get-content-document-response-all-of.js +0 -15
- package/dist/cjs/api-model/models/get-content-document-response.js +0 -15
- package/dist/cjs/api-model/models/image-component.js +0 -15
- package/dist/cjs/api-model/models/image-crop-specification.js +0 -15
- package/dist/cjs/api-model/models/image-dimensions.js +0 -15
- package/dist/cjs/api-model/models/image-offsets.js +0 -15
- package/dist/cjs/api-model/models/index.js +0 -85
- package/dist/cjs/api-model/models/integer-with-units.js +0 -15
- package/dist/cjs/api-model/models/list-content-document-asin-relations-response-all-of.js +0 -15
- package/dist/cjs/api-model/models/list-content-document-asin-relations-response.js +0 -15
- package/dist/cjs/api-model/models/model-error.js +0 -15
- package/dist/cjs/api-model/models/paragraph-component.js +0 -15
- package/dist/cjs/api-model/models/plain-text-item.js +0 -15
- package/dist/cjs/api-model/models/position-type.js +0 -23
- package/dist/cjs/api-model/models/post-content-document-approval-submission-response.js +0 -15
- package/dist/cjs/api-model/models/post-content-document-asin-relations-request.js +0 -15
- package/dist/cjs/api-model/models/post-content-document-asin-relations-response.js +0 -15
- package/dist/cjs/api-model/models/post-content-document-request.js +0 -15
- package/dist/cjs/api-model/models/post-content-document-response-all-of.js +0 -15
- package/dist/cjs/api-model/models/post-content-document-response.js +0 -15
- package/dist/cjs/api-model/models/post-content-document-suspend-submission-response.js +0 -15
- package/dist/cjs/api-model/models/publish-record.js +0 -15
- package/dist/cjs/api-model/models/search-content-documents-response-all-of.js +0 -15
- package/dist/cjs/api-model/models/search-content-documents-response.js +0 -15
- package/dist/cjs/api-model/models/search-content-publish-records-response-all-of.js +0 -15
- package/dist/cjs/api-model/models/search-content-publish-records-response.js +0 -15
- package/dist/cjs/api-model/models/standard-company-logo-module.js +0 -15
- package/dist/cjs/api-model/models/standard-comparison-product-block.js +0 -15
- package/dist/cjs/api-model/models/standard-comparison-table-module.js +0 -15
- package/dist/cjs/api-model/models/standard-four-image-text-module.js +0 -15
- package/dist/cjs/api-model/models/standard-four-image-text-quadrant-module.js +0 -15
- package/dist/cjs/api-model/models/standard-header-image-text-module.js +0 -15
- package/dist/cjs/api-model/models/standard-header-text-list-block.js +0 -15
- package/dist/cjs/api-model/models/standard-image-caption-block.js +0 -15
- package/dist/cjs/api-model/models/standard-image-sidebar-module.js +0 -15
- package/dist/cjs/api-model/models/standard-image-text-block.js +0 -15
- package/dist/cjs/api-model/models/standard-image-text-caption-block.js +0 -15
- package/dist/cjs/api-model/models/standard-image-text-overlay-module.js +0 -15
- package/dist/cjs/api-model/models/standard-multiple-image-text-module.js +0 -15
- package/dist/cjs/api-model/models/standard-product-description-module.js +0 -15
- package/dist/cjs/api-model/models/standard-single-image-highlights-module.js +0 -15
- package/dist/cjs/api-model/models/standard-single-image-specs-detail-module.js +0 -15
- package/dist/cjs/api-model/models/standard-single-side-image-module.js +0 -15
- package/dist/cjs/api-model/models/standard-tech-specs-module.js +0 -15
- package/dist/cjs/api-model/models/standard-text-block.js +0 -15
- package/dist/cjs/api-model/models/standard-text-list-block.js +0 -15
- package/dist/cjs/api-model/models/standard-text-module.js +0 -15
- package/dist/cjs/api-model/models/standard-text-pair-block.js +0 -15
- package/dist/cjs/api-model/models/standard-three-image-text-module.js +0 -15
- package/dist/cjs/api-model/models/text-component.js +0 -15
- package/dist/cjs/api-model/models/text-item.js +0 -15
- package/dist/cjs/api-model/models/validate-content-document-asin-relations-response.js +0 -15
- package/dist/cjs/client.js +0 -84
- package/dist/cjs/index.js +0 -19
- package/dist/es/api-model/api/aplus-content-api.js +0 -762
- package/dist/es/api-model/api.js +0 -14
- package/dist/es/api-model/base.js +0 -44
- package/dist/es/api-model/common.js +0 -110
- package/dist/es/api-model/configuration.js +0 -94
- package/dist/es/api-model/index.js +0 -16
- package/dist/es/api-model/models/aplus-paginated-response-all-of.js +0 -14
- package/dist/es/api-model/models/aplus-paginated-response.js +0 -14
- package/dist/es/api-model/models/aplus-response.js +0 -14
- package/dist/es/api-model/models/asin-badge.js +0 -22
- package/dist/es/api-model/models/asin-metadata.js +0 -14
- package/dist/es/api-model/models/color-type.js +0 -20
- package/dist/es/api-model/models/content-badge.js +0 -23
- package/dist/es/api-model/models/content-document.js +0 -14
- package/dist/es/api-model/models/content-metadata-record.js +0 -14
- package/dist/es/api-model/models/content-metadata.js +0 -14
- package/dist/es/api-model/models/content-module-type.js +0 -33
- package/dist/es/api-model/models/content-module.js +0 -14
- package/dist/es/api-model/models/content-record.js +0 -14
- package/dist/es/api-model/models/content-status.js +0 -22
- package/dist/es/api-model/models/content-type.js +0 -20
- package/dist/es/api-model/models/decorator-type.js +0 -26
- package/dist/es/api-model/models/decorator.js +0 -14
- package/dist/es/api-model/models/error-list.js +0 -14
- package/dist/es/api-model/models/get-content-document-response-all-of.js +0 -14
- package/dist/es/api-model/models/get-content-document-response.js +0 -14
- package/dist/es/api-model/models/image-component.js +0 -14
- package/dist/es/api-model/models/image-crop-specification.js +0 -14
- package/dist/es/api-model/models/image-dimensions.js +0 -14
- package/dist/es/api-model/models/image-offsets.js +0 -14
- package/dist/es/api-model/models/index.js +0 -69
- package/dist/es/api-model/models/integer-with-units.js +0 -14
- package/dist/es/api-model/models/list-content-document-asin-relations-response-all-of.js +0 -14
- package/dist/es/api-model/models/list-content-document-asin-relations-response.js +0 -14
- package/dist/es/api-model/models/model-error.js +0 -14
- package/dist/es/api-model/models/paragraph-component.js +0 -14
- package/dist/es/api-model/models/plain-text-item.js +0 -14
- package/dist/es/api-model/models/position-type.js +0 -20
- package/dist/es/api-model/models/post-content-document-approval-submission-response.js +0 -14
- package/dist/es/api-model/models/post-content-document-asin-relations-request.js +0 -14
- package/dist/es/api-model/models/post-content-document-asin-relations-response.js +0 -14
- package/dist/es/api-model/models/post-content-document-request.js +0 -14
- package/dist/es/api-model/models/post-content-document-response-all-of.js +0 -14
- package/dist/es/api-model/models/post-content-document-response.js +0 -14
- package/dist/es/api-model/models/post-content-document-suspend-submission-response.js +0 -14
- package/dist/es/api-model/models/publish-record.js +0 -14
- package/dist/es/api-model/models/search-content-documents-response-all-of.js +0 -14
- package/dist/es/api-model/models/search-content-documents-response.js +0 -14
- package/dist/es/api-model/models/search-content-publish-records-response-all-of.js +0 -14
- package/dist/es/api-model/models/search-content-publish-records-response.js +0 -14
- package/dist/es/api-model/models/standard-company-logo-module.js +0 -14
- package/dist/es/api-model/models/standard-comparison-product-block.js +0 -14
- package/dist/es/api-model/models/standard-comparison-table-module.js +0 -14
- package/dist/es/api-model/models/standard-four-image-text-module.js +0 -14
- package/dist/es/api-model/models/standard-four-image-text-quadrant-module.js +0 -14
- package/dist/es/api-model/models/standard-header-image-text-module.js +0 -14
- package/dist/es/api-model/models/standard-header-text-list-block.js +0 -14
- package/dist/es/api-model/models/standard-image-caption-block.js +0 -14
- package/dist/es/api-model/models/standard-image-sidebar-module.js +0 -14
- package/dist/es/api-model/models/standard-image-text-block.js +0 -14
- package/dist/es/api-model/models/standard-image-text-caption-block.js +0 -14
- package/dist/es/api-model/models/standard-image-text-overlay-module.js +0 -14
- package/dist/es/api-model/models/standard-multiple-image-text-module.js +0 -14
- package/dist/es/api-model/models/standard-product-description-module.js +0 -14
- package/dist/es/api-model/models/standard-single-image-highlights-module.js +0 -14
- package/dist/es/api-model/models/standard-single-image-specs-detail-module.js +0 -14
- package/dist/es/api-model/models/standard-single-side-image-module.js +0 -14
- package/dist/es/api-model/models/standard-tech-specs-module.js +0 -14
- package/dist/es/api-model/models/standard-text-block.js +0 -14
- package/dist/es/api-model/models/standard-text-list-block.js +0 -14
- package/dist/es/api-model/models/standard-text-module.js +0 -14
- package/dist/es/api-model/models/standard-text-pair-block.js +0 -14
- package/dist/es/api-model/models/standard-three-image-text-module.js +0 -14
- package/dist/es/api-model/models/text-component.js +0 -14
- package/dist/es/api-model/models/text-item.js +0 -14
- package/dist/es/api-model/models/validate-content-document-asin-relations-response.js +0 -14
- package/dist/es/client.js +0 -80
- package/dist/es/index.js +0 -3
- package/dist/types/api-model/api/aplus-content-api.d.ts +0 -533
- package/dist/types/api-model/api.d.ts +0 -12
- package/dist/types/api-model/base.d.ts +0 -42
- package/dist/types/api-model/common.d.ts +0 -34
- package/dist/types/api-model/configuration.d.ts +0 -98
- package/dist/types/api-model/index.d.ts +0 -14
- package/dist/types/api-model/models/aplus-paginated-response-all-of.d.ts +0 -17
- package/dist/types/api-model/models/aplus-paginated-response.d.ts +0 -18
- package/dist/types/api-model/models/aplus-response.d.ts +0 -20
- package/dist/types/api-model/models/asin-badge.d.ts +0 -21
- package/dist/types/api-model/models/asin-metadata.d.ts +0 -41
- package/dist/types/api-model/models/color-type.d.ts +0 -19
- package/dist/types/api-model/models/content-badge.d.ts +0 -22
- package/dist/types/api-model/models/content-document.d.ts +0 -35
- package/dist/types/api-model/models/content-metadata-record.d.ts +0 -22
- package/dist/types/api-model/models/content-metadata.d.ts +0 -35
- package/dist/types/api-model/models/content-module-type.d.ts +0 -32
- package/dist/types/api-model/models/content-module.d.ts +0 -48
- package/dist/types/api-model/models/content-record.d.ts +0 -24
- package/dist/types/api-model/models/content-status.d.ts +0 -21
- package/dist/types/api-model/models/content-type.d.ts +0 -19
- package/dist/types/api-model/models/decorator-type.d.ts +0 -25
- package/dist/types/api-model/models/decorator.d.ts +0 -30
- package/dist/types/api-model/models/error-list.d.ts +0 -20
- package/dist/types/api-model/models/get-content-document-response-all-of.d.ts +0 -15
- package/dist/types/api-model/models/get-content-document-response.d.ts +0 -17
- package/dist/types/api-model/models/image-component.d.ts +0 -26
- package/dist/types/api-model/models/image-crop-specification.d.ts +0 -20
- package/dist/types/api-model/models/image-dimensions.d.ts +0 -19
- package/dist/types/api-model/models/image-offsets.d.ts +0 -19
- package/dist/types/api-model/models/index.d.ts +0 -69
- package/dist/types/api-model/models/integer-with-units.d.ts +0 -24
- package/dist/types/api-model/models/list-content-document-asin-relations-response-all-of.d.ts +0 -18
- package/dist/types/api-model/models/list-content-document-asin-relations-response.d.ts +0 -17
- package/dist/types/api-model/models/model-error.d.ts +0 -28
- package/dist/types/api-model/models/paragraph-component.d.ts +0 -18
- package/dist/types/api-model/models/plain-text-item.d.ts +0 -24
- package/dist/types/api-model/models/position-type.d.ts +0 -19
- package/dist/types/api-model/models/post-content-document-approval-submission-response.d.ts +0 -16
- package/dist/types/api-model/models/post-content-document-asin-relations-request.d.ts +0 -17
- package/dist/types/api-model/models/post-content-document-asin-relations-response.d.ts +0 -16
- package/dist/types/api-model/models/post-content-document-request.d.ts +0 -15
- package/dist/types/api-model/models/post-content-document-response-all-of.d.ts +0 -17
- package/dist/types/api-model/models/post-content-document-response.d.ts +0 -17
- package/dist/types/api-model/models/post-content-document-suspend-submission-response.d.ts +0 -16
- package/dist/types/api-model/models/publish-record.d.ts +0 -38
- package/dist/types/api-model/models/search-content-documents-response-all-of.d.ts +0 -18
- package/dist/types/api-model/models/search-content-documents-response.d.ts +0 -17
- package/dist/types/api-model/models/search-content-publish-records-response-all-of.d.ts +0 -18
- package/dist/types/api-model/models/search-content-publish-records-response.d.ts +0 -17
- package/dist/types/api-model/models/standard-company-logo-module.d.ts +0 -18
- package/dist/types/api-model/models/standard-comparison-product-block.d.ts +0 -39
- package/dist/types/api-model/models/standard-comparison-table-module.d.ts +0 -20
- package/dist/types/api-model/models/standard-four-image-text-module.d.ts +0 -23
- package/dist/types/api-model/models/standard-four-image-text-quadrant-module.d.ts +0 -21
- package/dist/types/api-model/models/standard-header-image-text-module.d.ts +0 -20
- package/dist/types/api-model/models/standard-header-text-list-block.d.ts +0 -20
- package/dist/types/api-model/models/standard-image-caption-block.d.ts +0 -20
- package/dist/types/api-model/models/standard-image-sidebar-module.d.ts +0 -27
- package/dist/types/api-model/models/standard-image-text-block.d.ts +0 -22
- package/dist/types/api-model/models/standard-image-text-caption-block.d.ts +0 -20
- package/dist/types/api-model/models/standard-image-text-overlay-module.d.ts +0 -20
- package/dist/types/api-model/models/standard-multiple-image-text-module.d.ts +0 -18
- package/dist/types/api-model/models/standard-product-description-module.d.ts +0 -18
- package/dist/types/api-model/models/standard-single-image-highlights-module.d.ts +0 -26
- package/dist/types/api-model/models/standard-single-image-specs-detail-module.d.ts +0 -28
- package/dist/types/api-model/models/standard-single-side-image-module.d.ts +0 -20
- package/dist/types/api-model/models/standard-tech-specs-module.d.ts +0 -27
- package/dist/types/api-model/models/standard-text-block.d.ts +0 -20
- package/dist/types/api-model/models/standard-text-list-block.d.ts +0 -18
- package/dist/types/api-model/models/standard-text-module.d.ts +0 -20
- package/dist/types/api-model/models/standard-text-pair-block.d.ts +0 -19
- package/dist/types/api-model/models/standard-three-image-text-module.d.ts +0 -22
- package/dist/types/api-model/models/text-component.d.ts +0 -25
- package/dist/types/api-model/models/text-item.d.ts +0 -22
- package/dist/types/api-model/models/validate-content-document-asin-relations-response.d.ts +0 -17
- package/dist/types/client.d.ts +0 -6
- package/dist/types/index.d.ts +0 -3
|
@@ -1,772 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/* tslint:disable */
|
|
3
|
-
/* eslint-disable */
|
|
4
|
-
/**
|
|
5
|
-
* Selling Partner API for A+ Content Management
|
|
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.
|
|
7
|
-
*
|
|
8
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
-
* https://openapi-generator.tech
|
|
13
|
-
* Do not edit the class manually.
|
|
14
|
-
*/
|
|
15
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
16
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
|
-
};
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.ListContentDocumentAsinRelationsIncludedDataSetEnum = exports.GetContentDocumentIncludedDataSetEnum = exports.AplusContentApi = exports.AplusContentApiFactory = exports.AplusContentApiFp = exports.AplusContentApiAxiosParamCreator = void 0;
|
|
20
|
-
const axios_1 = __importDefault(require("axios"));
|
|
21
|
-
// Some imports not used depending on template conditions
|
|
22
|
-
// @ts-ignore
|
|
23
|
-
const common_1 = require("../common");
|
|
24
|
-
// @ts-ignore
|
|
25
|
-
const base_1 = require("../base");
|
|
26
|
-
/**
|
|
27
|
-
* AplusContentApi - axios parameter creator
|
|
28
|
-
*/
|
|
29
|
-
const AplusContentApiAxiosParamCreator = function (configuration) {
|
|
30
|
-
return {
|
|
31
|
-
/**
|
|
32
|
-
* 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).
|
|
33
|
-
* @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).
|
|
34
|
-
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
35
|
-
* @param {*} [options] Override http request option.
|
|
36
|
-
* @throws {RequiredError}
|
|
37
|
-
*/
|
|
38
|
-
createContentDocument: async (marketplaceId, postContentDocumentRequest, options = {}) => {
|
|
39
|
-
// verify required parameter 'marketplaceId' is not null or undefined
|
|
40
|
-
(0, common_1.assertParamExists)('createContentDocument', 'marketplaceId', marketplaceId);
|
|
41
|
-
// verify required parameter 'postContentDocumentRequest' is not null or undefined
|
|
42
|
-
(0, common_1.assertParamExists)('createContentDocument', 'postContentDocumentRequest', postContentDocumentRequest);
|
|
43
|
-
const localVarPath = `/aplus/2020-11-01/contentDocuments`;
|
|
44
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
45
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
46
|
-
let baseOptions;
|
|
47
|
-
if (configuration) {
|
|
48
|
-
baseOptions = configuration.baseOptions;
|
|
49
|
-
}
|
|
50
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
51
|
-
const localVarHeaderParameter = {};
|
|
52
|
-
const localVarQueryParameter = {};
|
|
53
|
-
if (marketplaceId !== undefined) {
|
|
54
|
-
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
55
|
-
}
|
|
56
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
57
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
58
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
59
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
60
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
61
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(postContentDocumentRequest, localVarRequestOptions, configuration);
|
|
62
|
-
return {
|
|
63
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
64
|
-
options: localVarRequestOptions,
|
|
65
|
-
};
|
|
66
|
-
},
|
|
67
|
-
/**
|
|
68
|
-
* 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).
|
|
69
|
-
* @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.
|
|
70
|
-
* @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).
|
|
71
|
-
* @param {Set<GetContentDocumentIncludedDataSetEnum>} includedDataSet The set of A+ Content data types to include in the response.
|
|
72
|
-
* @param {*} [options] Override http request option.
|
|
73
|
-
* @throws {RequiredError}
|
|
74
|
-
*/
|
|
75
|
-
getContentDocument: async (contentReferenceKey, marketplaceId, includedDataSet, options = {}) => {
|
|
76
|
-
// verify required parameter 'contentReferenceKey' is not null or undefined
|
|
77
|
-
(0, common_1.assertParamExists)('getContentDocument', 'contentReferenceKey', contentReferenceKey);
|
|
78
|
-
// verify required parameter 'marketplaceId' is not null or undefined
|
|
79
|
-
(0, common_1.assertParamExists)('getContentDocument', 'marketplaceId', marketplaceId);
|
|
80
|
-
// verify required parameter 'includedDataSet' is not null or undefined
|
|
81
|
-
(0, common_1.assertParamExists)('getContentDocument', 'includedDataSet', includedDataSet);
|
|
82
|
-
const localVarPath = `/aplus/2020-11-01/contentDocuments/{contentReferenceKey}`
|
|
83
|
-
.replace('{contentReferenceKey}', encodeURIComponent(String(contentReferenceKey)));
|
|
84
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
85
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
86
|
-
let baseOptions;
|
|
87
|
-
if (configuration) {
|
|
88
|
-
baseOptions = configuration.baseOptions;
|
|
89
|
-
}
|
|
90
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
91
|
-
const localVarHeaderParameter = {};
|
|
92
|
-
const localVarQueryParameter = {};
|
|
93
|
-
if (marketplaceId !== undefined) {
|
|
94
|
-
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
95
|
-
}
|
|
96
|
-
if (includedDataSet) {
|
|
97
|
-
localVarQueryParameter['includedDataSet'] = Array.from(includedDataSet).join(base_1.COLLECTION_FORMATS.csv);
|
|
98
|
-
}
|
|
99
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
100
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
101
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
102
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
103
|
-
return {
|
|
104
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
105
|
-
options: localVarRequestOptions,
|
|
106
|
-
};
|
|
107
|
-
},
|
|
108
|
-
/**
|
|
109
|
-
* 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).
|
|
110
|
-
* @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.
|
|
111
|
-
* @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).
|
|
112
|
-
* @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.
|
|
113
|
-
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
114
|
-
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
115
|
-
* @param {*} [options] Override http request option.
|
|
116
|
-
* @throws {RequiredError}
|
|
117
|
-
*/
|
|
118
|
-
listContentDocumentAsinRelations: async (contentReferenceKey, marketplaceId, includedDataSet, asinSet, pageToken, options = {}) => {
|
|
119
|
-
// verify required parameter 'contentReferenceKey' is not null or undefined
|
|
120
|
-
(0, common_1.assertParamExists)('listContentDocumentAsinRelations', 'contentReferenceKey', contentReferenceKey);
|
|
121
|
-
// verify required parameter 'marketplaceId' is not null or undefined
|
|
122
|
-
(0, common_1.assertParamExists)('listContentDocumentAsinRelations', 'marketplaceId', marketplaceId);
|
|
123
|
-
const localVarPath = `/aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins`
|
|
124
|
-
.replace('{contentReferenceKey}', encodeURIComponent(String(contentReferenceKey)));
|
|
125
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
126
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
127
|
-
let baseOptions;
|
|
128
|
-
if (configuration) {
|
|
129
|
-
baseOptions = configuration.baseOptions;
|
|
130
|
-
}
|
|
131
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
132
|
-
const localVarHeaderParameter = {};
|
|
133
|
-
const localVarQueryParameter = {};
|
|
134
|
-
if (marketplaceId !== undefined) {
|
|
135
|
-
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
136
|
-
}
|
|
137
|
-
if (includedDataSet) {
|
|
138
|
-
localVarQueryParameter['includedDataSet'] = Array.from(includedDataSet).join(base_1.COLLECTION_FORMATS.csv);
|
|
139
|
-
}
|
|
140
|
-
if (asinSet) {
|
|
141
|
-
localVarQueryParameter['asinSet'] = Array.from(asinSet).join(base_1.COLLECTION_FORMATS.csv);
|
|
142
|
-
}
|
|
143
|
-
if (pageToken !== undefined) {
|
|
144
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
145
|
-
}
|
|
146
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
147
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
148
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
149
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
150
|
-
return {
|
|
151
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
152
|
-
options: localVarRequestOptions,
|
|
153
|
-
};
|
|
154
|
-
},
|
|
155
|
-
/**
|
|
156
|
-
* 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).
|
|
157
|
-
* @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.
|
|
158
|
-
* @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).
|
|
159
|
-
* @param {*} [options] Override http request option.
|
|
160
|
-
* @throws {RequiredError}
|
|
161
|
-
*/
|
|
162
|
-
postContentDocumentApprovalSubmission: async (contentReferenceKey, marketplaceId, options = {}) => {
|
|
163
|
-
// verify required parameter 'contentReferenceKey' is not null or undefined
|
|
164
|
-
(0, common_1.assertParamExists)('postContentDocumentApprovalSubmission', 'contentReferenceKey', contentReferenceKey);
|
|
165
|
-
// verify required parameter 'marketplaceId' is not null or undefined
|
|
166
|
-
(0, common_1.assertParamExists)('postContentDocumentApprovalSubmission', 'marketplaceId', marketplaceId);
|
|
167
|
-
const localVarPath = `/aplus/2020-11-01/contentDocuments/{contentReferenceKey}/approvalSubmissions`
|
|
168
|
-
.replace('{contentReferenceKey}', encodeURIComponent(String(contentReferenceKey)));
|
|
169
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
170
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
171
|
-
let baseOptions;
|
|
172
|
-
if (configuration) {
|
|
173
|
-
baseOptions = configuration.baseOptions;
|
|
174
|
-
}
|
|
175
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
176
|
-
const localVarHeaderParameter = {};
|
|
177
|
-
const localVarQueryParameter = {};
|
|
178
|
-
if (marketplaceId !== undefined) {
|
|
179
|
-
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
180
|
-
}
|
|
181
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
182
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
183
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
184
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
185
|
-
return {
|
|
186
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
187
|
-
options: localVarRequestOptions,
|
|
188
|
-
};
|
|
189
|
-
},
|
|
190
|
-
/**
|
|
191
|
-
* 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).
|
|
192
|
-
* @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.
|
|
193
|
-
* @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).
|
|
194
|
-
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The request details for the content document ASIN relations.
|
|
195
|
-
* @param {*} [options] Override http request option.
|
|
196
|
-
* @throws {RequiredError}
|
|
197
|
-
*/
|
|
198
|
-
postContentDocumentAsinRelations: async (contentReferenceKey, marketplaceId, postContentDocumentAsinRelationsRequest, options = {}) => {
|
|
199
|
-
// verify required parameter 'contentReferenceKey' is not null or undefined
|
|
200
|
-
(0, common_1.assertParamExists)('postContentDocumentAsinRelations', 'contentReferenceKey', contentReferenceKey);
|
|
201
|
-
// verify required parameter 'marketplaceId' is not null or undefined
|
|
202
|
-
(0, common_1.assertParamExists)('postContentDocumentAsinRelations', 'marketplaceId', marketplaceId);
|
|
203
|
-
// verify required parameter 'postContentDocumentAsinRelationsRequest' is not null or undefined
|
|
204
|
-
(0, common_1.assertParamExists)('postContentDocumentAsinRelations', 'postContentDocumentAsinRelationsRequest', postContentDocumentAsinRelationsRequest);
|
|
205
|
-
const localVarPath = `/aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins`
|
|
206
|
-
.replace('{contentReferenceKey}', encodeURIComponent(String(contentReferenceKey)));
|
|
207
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
208
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
209
|
-
let baseOptions;
|
|
210
|
-
if (configuration) {
|
|
211
|
-
baseOptions = configuration.baseOptions;
|
|
212
|
-
}
|
|
213
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
214
|
-
const localVarHeaderParameter = {};
|
|
215
|
-
const localVarQueryParameter = {};
|
|
216
|
-
if (marketplaceId !== undefined) {
|
|
217
|
-
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
218
|
-
}
|
|
219
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
220
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
221
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
222
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
223
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
224
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(postContentDocumentAsinRelationsRequest, localVarRequestOptions, configuration);
|
|
225
|
-
return {
|
|
226
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
227
|
-
options: localVarRequestOptions,
|
|
228
|
-
};
|
|
229
|
-
},
|
|
230
|
-
/**
|
|
231
|
-
* 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).
|
|
232
|
-
* @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.
|
|
233
|
-
* @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).
|
|
234
|
-
* @param {*} [options] Override http request option.
|
|
235
|
-
* @throws {RequiredError}
|
|
236
|
-
*/
|
|
237
|
-
postContentDocumentSuspendSubmission: async (contentReferenceKey, marketplaceId, options = {}) => {
|
|
238
|
-
// verify required parameter 'contentReferenceKey' is not null or undefined
|
|
239
|
-
(0, common_1.assertParamExists)('postContentDocumentSuspendSubmission', 'contentReferenceKey', contentReferenceKey);
|
|
240
|
-
// verify required parameter 'marketplaceId' is not null or undefined
|
|
241
|
-
(0, common_1.assertParamExists)('postContentDocumentSuspendSubmission', 'marketplaceId', marketplaceId);
|
|
242
|
-
const localVarPath = `/aplus/2020-11-01/contentDocuments/{contentReferenceKey}/suspendSubmissions`
|
|
243
|
-
.replace('{contentReferenceKey}', encodeURIComponent(String(contentReferenceKey)));
|
|
244
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
245
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
246
|
-
let baseOptions;
|
|
247
|
-
if (configuration) {
|
|
248
|
-
baseOptions = configuration.baseOptions;
|
|
249
|
-
}
|
|
250
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
251
|
-
const localVarHeaderParameter = {};
|
|
252
|
-
const localVarQueryParameter = {};
|
|
253
|
-
if (marketplaceId !== undefined) {
|
|
254
|
-
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
255
|
-
}
|
|
256
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
257
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
258
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
259
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
260
|
-
return {
|
|
261
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
262
|
-
options: localVarRequestOptions,
|
|
263
|
-
};
|
|
264
|
-
},
|
|
265
|
-
/**
|
|
266
|
-
* 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).
|
|
267
|
-
* @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).
|
|
268
|
-
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
269
|
-
* @param {*} [options] Override http request option.
|
|
270
|
-
* @throws {RequiredError}
|
|
271
|
-
*/
|
|
272
|
-
searchContentDocuments: async (marketplaceId, pageToken, options = {}) => {
|
|
273
|
-
// verify required parameter 'marketplaceId' is not null or undefined
|
|
274
|
-
(0, common_1.assertParamExists)('searchContentDocuments', 'marketplaceId', marketplaceId);
|
|
275
|
-
const localVarPath = `/aplus/2020-11-01/contentDocuments`;
|
|
276
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
277
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
278
|
-
let baseOptions;
|
|
279
|
-
if (configuration) {
|
|
280
|
-
baseOptions = configuration.baseOptions;
|
|
281
|
-
}
|
|
282
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
283
|
-
const localVarHeaderParameter = {};
|
|
284
|
-
const localVarQueryParameter = {};
|
|
285
|
-
if (marketplaceId !== undefined) {
|
|
286
|
-
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
287
|
-
}
|
|
288
|
-
if (pageToken !== undefined) {
|
|
289
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
290
|
-
}
|
|
291
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
292
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
293
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
294
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
295
|
-
return {
|
|
296
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
297
|
-
options: localVarRequestOptions,
|
|
298
|
-
};
|
|
299
|
-
},
|
|
300
|
-
/**
|
|
301
|
-
* 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).
|
|
302
|
-
* @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).
|
|
303
|
-
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
304
|
-
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
305
|
-
* @param {*} [options] Override http request option.
|
|
306
|
-
* @throws {RequiredError}
|
|
307
|
-
*/
|
|
308
|
-
searchContentPublishRecords: async (marketplaceId, asin, pageToken, options = {}) => {
|
|
309
|
-
// verify required parameter 'marketplaceId' is not null or undefined
|
|
310
|
-
(0, common_1.assertParamExists)('searchContentPublishRecords', 'marketplaceId', marketplaceId);
|
|
311
|
-
// verify required parameter 'asin' is not null or undefined
|
|
312
|
-
(0, common_1.assertParamExists)('searchContentPublishRecords', 'asin', asin);
|
|
313
|
-
const localVarPath = `/aplus/2020-11-01/contentPublishRecords`;
|
|
314
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
315
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
316
|
-
let baseOptions;
|
|
317
|
-
if (configuration) {
|
|
318
|
-
baseOptions = configuration.baseOptions;
|
|
319
|
-
}
|
|
320
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
321
|
-
const localVarHeaderParameter = {};
|
|
322
|
-
const localVarQueryParameter = {};
|
|
323
|
-
if (marketplaceId !== undefined) {
|
|
324
|
-
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
325
|
-
}
|
|
326
|
-
if (asin !== undefined) {
|
|
327
|
-
localVarQueryParameter['asin'] = asin;
|
|
328
|
-
}
|
|
329
|
-
if (pageToken !== undefined) {
|
|
330
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
331
|
-
}
|
|
332
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
333
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
334
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
335
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
336
|
-
return {
|
|
337
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
338
|
-
options: localVarRequestOptions,
|
|
339
|
-
};
|
|
340
|
-
},
|
|
341
|
-
/**
|
|
342
|
-
* 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).
|
|
343
|
-
* @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.
|
|
344
|
-
* @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).
|
|
345
|
-
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
346
|
-
* @param {*} [options] Override http request option.
|
|
347
|
-
* @throws {RequiredError}
|
|
348
|
-
*/
|
|
349
|
-
updateContentDocument: async (contentReferenceKey, marketplaceId, postContentDocumentRequest, options = {}) => {
|
|
350
|
-
// verify required parameter 'contentReferenceKey' is not null or undefined
|
|
351
|
-
(0, common_1.assertParamExists)('updateContentDocument', 'contentReferenceKey', contentReferenceKey);
|
|
352
|
-
// verify required parameter 'marketplaceId' is not null or undefined
|
|
353
|
-
(0, common_1.assertParamExists)('updateContentDocument', 'marketplaceId', marketplaceId);
|
|
354
|
-
// verify required parameter 'postContentDocumentRequest' is not null or undefined
|
|
355
|
-
(0, common_1.assertParamExists)('updateContentDocument', 'postContentDocumentRequest', postContentDocumentRequest);
|
|
356
|
-
const localVarPath = `/aplus/2020-11-01/contentDocuments/{contentReferenceKey}`
|
|
357
|
-
.replace('{contentReferenceKey}', encodeURIComponent(String(contentReferenceKey)));
|
|
358
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
359
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
360
|
-
let baseOptions;
|
|
361
|
-
if (configuration) {
|
|
362
|
-
baseOptions = configuration.baseOptions;
|
|
363
|
-
}
|
|
364
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
365
|
-
const localVarHeaderParameter = {};
|
|
366
|
-
const localVarQueryParameter = {};
|
|
367
|
-
if (marketplaceId !== undefined) {
|
|
368
|
-
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
369
|
-
}
|
|
370
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
371
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
372
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
373
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
374
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
375
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(postContentDocumentRequest, localVarRequestOptions, configuration);
|
|
376
|
-
return {
|
|
377
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
378
|
-
options: localVarRequestOptions,
|
|
379
|
-
};
|
|
380
|
-
},
|
|
381
|
-
/**
|
|
382
|
-
* 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).
|
|
383
|
-
* @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).
|
|
384
|
-
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
385
|
-
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
386
|
-
* @param {*} [options] Override http request option.
|
|
387
|
-
* @throws {RequiredError}
|
|
388
|
-
*/
|
|
389
|
-
validateContentDocumentAsinRelations: async (marketplaceId, postContentDocumentRequest, asinSet, options = {}) => {
|
|
390
|
-
// verify required parameter 'marketplaceId' is not null or undefined
|
|
391
|
-
(0, common_1.assertParamExists)('validateContentDocumentAsinRelations', 'marketplaceId', marketplaceId);
|
|
392
|
-
// verify required parameter 'postContentDocumentRequest' is not null or undefined
|
|
393
|
-
(0, common_1.assertParamExists)('validateContentDocumentAsinRelations', 'postContentDocumentRequest', postContentDocumentRequest);
|
|
394
|
-
const localVarPath = `/aplus/2020-11-01/contentAsinValidations`;
|
|
395
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
396
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
397
|
-
let baseOptions;
|
|
398
|
-
if (configuration) {
|
|
399
|
-
baseOptions = configuration.baseOptions;
|
|
400
|
-
}
|
|
401
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
402
|
-
const localVarHeaderParameter = {};
|
|
403
|
-
const localVarQueryParameter = {};
|
|
404
|
-
if (marketplaceId !== undefined) {
|
|
405
|
-
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
406
|
-
}
|
|
407
|
-
if (asinSet) {
|
|
408
|
-
localVarQueryParameter['asinSet'] = Array.from(asinSet).join(base_1.COLLECTION_FORMATS.csv);
|
|
409
|
-
}
|
|
410
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
411
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
412
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
413
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
414
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
415
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(postContentDocumentRequest, localVarRequestOptions, configuration);
|
|
416
|
-
return {
|
|
417
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
418
|
-
options: localVarRequestOptions,
|
|
419
|
-
};
|
|
420
|
-
},
|
|
421
|
-
};
|
|
422
|
-
};
|
|
423
|
-
exports.AplusContentApiAxiosParamCreator = AplusContentApiAxiosParamCreator;
|
|
424
|
-
/**
|
|
425
|
-
* AplusContentApi - functional programming interface
|
|
426
|
-
*/
|
|
427
|
-
const AplusContentApiFp = function (configuration) {
|
|
428
|
-
const localVarAxiosParamCreator = (0, exports.AplusContentApiAxiosParamCreator)(configuration);
|
|
429
|
-
return {
|
|
430
|
-
/**
|
|
431
|
-
* 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).
|
|
432
|
-
* @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).
|
|
433
|
-
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
434
|
-
* @param {*} [options] Override http request option.
|
|
435
|
-
* @throws {RequiredError}
|
|
436
|
-
*/
|
|
437
|
-
async createContentDocument(marketplaceId, postContentDocumentRequest, options) {
|
|
438
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createContentDocument(marketplaceId, postContentDocumentRequest, options);
|
|
439
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
440
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AplusContentApi.createContentDocument']?.[localVarOperationServerIndex]?.url;
|
|
441
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
442
|
-
},
|
|
443
|
-
/**
|
|
444
|
-
* 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).
|
|
445
|
-
* @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.
|
|
446
|
-
* @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).
|
|
447
|
-
* @param {Set<GetContentDocumentIncludedDataSetEnum>} includedDataSet The set of A+ Content data types to include in the response.
|
|
448
|
-
* @param {*} [options] Override http request option.
|
|
449
|
-
* @throws {RequiredError}
|
|
450
|
-
*/
|
|
451
|
-
async getContentDocument(contentReferenceKey, marketplaceId, includedDataSet, options) {
|
|
452
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getContentDocument(contentReferenceKey, marketplaceId, includedDataSet, options);
|
|
453
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
454
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AplusContentApi.getContentDocument']?.[localVarOperationServerIndex]?.url;
|
|
455
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
456
|
-
},
|
|
457
|
-
/**
|
|
458
|
-
* 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).
|
|
459
|
-
* @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.
|
|
460
|
-
* @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).
|
|
461
|
-
* @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.
|
|
462
|
-
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
463
|
-
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
464
|
-
* @param {*} [options] Override http request option.
|
|
465
|
-
* @throws {RequiredError}
|
|
466
|
-
*/
|
|
467
|
-
async listContentDocumentAsinRelations(contentReferenceKey, marketplaceId, includedDataSet, asinSet, pageToken, options) {
|
|
468
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listContentDocumentAsinRelations(contentReferenceKey, marketplaceId, includedDataSet, asinSet, pageToken, options);
|
|
469
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
470
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AplusContentApi.listContentDocumentAsinRelations']?.[localVarOperationServerIndex]?.url;
|
|
471
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
472
|
-
},
|
|
473
|
-
/**
|
|
474
|
-
* 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).
|
|
475
|
-
* @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.
|
|
476
|
-
* @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).
|
|
477
|
-
* @param {*} [options] Override http request option.
|
|
478
|
-
* @throws {RequiredError}
|
|
479
|
-
*/
|
|
480
|
-
async postContentDocumentApprovalSubmission(contentReferenceKey, marketplaceId, options) {
|
|
481
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postContentDocumentApprovalSubmission(contentReferenceKey, marketplaceId, options);
|
|
482
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
483
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AplusContentApi.postContentDocumentApprovalSubmission']?.[localVarOperationServerIndex]?.url;
|
|
484
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
485
|
-
},
|
|
486
|
-
/**
|
|
487
|
-
* 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).
|
|
488
|
-
* @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.
|
|
489
|
-
* @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).
|
|
490
|
-
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The request details for the content document ASIN relations.
|
|
491
|
-
* @param {*} [options] Override http request option.
|
|
492
|
-
* @throws {RequiredError}
|
|
493
|
-
*/
|
|
494
|
-
async postContentDocumentAsinRelations(contentReferenceKey, marketplaceId, postContentDocumentAsinRelationsRequest, options) {
|
|
495
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postContentDocumentAsinRelations(contentReferenceKey, marketplaceId, postContentDocumentAsinRelationsRequest, options);
|
|
496
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
497
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AplusContentApi.postContentDocumentAsinRelations']?.[localVarOperationServerIndex]?.url;
|
|
498
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
499
|
-
},
|
|
500
|
-
/**
|
|
501
|
-
* 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).
|
|
502
|
-
* @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.
|
|
503
|
-
* @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).
|
|
504
|
-
* @param {*} [options] Override http request option.
|
|
505
|
-
* @throws {RequiredError}
|
|
506
|
-
*/
|
|
507
|
-
async postContentDocumentSuspendSubmission(contentReferenceKey, marketplaceId, options) {
|
|
508
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postContentDocumentSuspendSubmission(contentReferenceKey, marketplaceId, options);
|
|
509
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
510
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AplusContentApi.postContentDocumentSuspendSubmission']?.[localVarOperationServerIndex]?.url;
|
|
511
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
512
|
-
},
|
|
513
|
-
/**
|
|
514
|
-
* 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).
|
|
515
|
-
* @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).
|
|
516
|
-
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
517
|
-
* @param {*} [options] Override http request option.
|
|
518
|
-
* @throws {RequiredError}
|
|
519
|
-
*/
|
|
520
|
-
async searchContentDocuments(marketplaceId, pageToken, options) {
|
|
521
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.searchContentDocuments(marketplaceId, pageToken, options);
|
|
522
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
523
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AplusContentApi.searchContentDocuments']?.[localVarOperationServerIndex]?.url;
|
|
524
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
525
|
-
},
|
|
526
|
-
/**
|
|
527
|
-
* 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).
|
|
528
|
-
* @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).
|
|
529
|
-
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
530
|
-
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
531
|
-
* @param {*} [options] Override http request option.
|
|
532
|
-
* @throws {RequiredError}
|
|
533
|
-
*/
|
|
534
|
-
async searchContentPublishRecords(marketplaceId, asin, pageToken, options) {
|
|
535
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.searchContentPublishRecords(marketplaceId, asin, pageToken, options);
|
|
536
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
537
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AplusContentApi.searchContentPublishRecords']?.[localVarOperationServerIndex]?.url;
|
|
538
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
539
|
-
},
|
|
540
|
-
/**
|
|
541
|
-
* 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).
|
|
542
|
-
* @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.
|
|
543
|
-
* @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).
|
|
544
|
-
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
545
|
-
* @param {*} [options] Override http request option.
|
|
546
|
-
* @throws {RequiredError}
|
|
547
|
-
*/
|
|
548
|
-
async updateContentDocument(contentReferenceKey, marketplaceId, postContentDocumentRequest, options) {
|
|
549
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateContentDocument(contentReferenceKey, marketplaceId, postContentDocumentRequest, options);
|
|
550
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
551
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AplusContentApi.updateContentDocument']?.[localVarOperationServerIndex]?.url;
|
|
552
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
553
|
-
},
|
|
554
|
-
/**
|
|
555
|
-
* 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).
|
|
556
|
-
* @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).
|
|
557
|
-
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
558
|
-
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
559
|
-
* @param {*} [options] Override http request option.
|
|
560
|
-
* @throws {RequiredError}
|
|
561
|
-
*/
|
|
562
|
-
async validateContentDocumentAsinRelations(marketplaceId, postContentDocumentRequest, asinSet, options) {
|
|
563
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.validateContentDocumentAsinRelations(marketplaceId, postContentDocumentRequest, asinSet, options);
|
|
564
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
565
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AplusContentApi.validateContentDocumentAsinRelations']?.[localVarOperationServerIndex]?.url;
|
|
566
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
567
|
-
},
|
|
568
|
-
};
|
|
569
|
-
};
|
|
570
|
-
exports.AplusContentApiFp = AplusContentApiFp;
|
|
571
|
-
/**
|
|
572
|
-
* AplusContentApi - factory interface
|
|
573
|
-
*/
|
|
574
|
-
const AplusContentApiFactory = function (configuration, basePath, axios) {
|
|
575
|
-
const localVarFp = (0, exports.AplusContentApiFp)(configuration);
|
|
576
|
-
return {
|
|
577
|
-
/**
|
|
578
|
-
* 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).
|
|
579
|
-
* @param {AplusContentApiCreateContentDocumentRequest} requestParameters Request parameters.
|
|
580
|
-
* @param {*} [options] Override http request option.
|
|
581
|
-
* @throws {RequiredError}
|
|
582
|
-
*/
|
|
583
|
-
createContentDocument(requestParameters, options) {
|
|
584
|
-
return localVarFp.createContentDocument(requestParameters.marketplaceId, requestParameters.postContentDocumentRequest, options).then((request) => request(axios, basePath));
|
|
585
|
-
},
|
|
586
|
-
/**
|
|
587
|
-
* 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).
|
|
588
|
-
* @param {AplusContentApiGetContentDocumentRequest} requestParameters Request parameters.
|
|
589
|
-
* @param {*} [options] Override http request option.
|
|
590
|
-
* @throws {RequiredError}
|
|
591
|
-
*/
|
|
592
|
-
getContentDocument(requestParameters, options) {
|
|
593
|
-
return localVarFp.getContentDocument(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.includedDataSet, options).then((request) => request(axios, basePath));
|
|
594
|
-
},
|
|
595
|
-
/**
|
|
596
|
-
* 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).
|
|
597
|
-
* @param {AplusContentApiListContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
598
|
-
* @param {*} [options] Override http request option.
|
|
599
|
-
* @throws {RequiredError}
|
|
600
|
-
*/
|
|
601
|
-
listContentDocumentAsinRelations(requestParameters, options) {
|
|
602
|
-
return localVarFp.listContentDocumentAsinRelations(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.includedDataSet, requestParameters.asinSet, requestParameters.pageToken, options).then((request) => request(axios, basePath));
|
|
603
|
-
},
|
|
604
|
-
/**
|
|
605
|
-
* 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).
|
|
606
|
-
* @param {AplusContentApiPostContentDocumentApprovalSubmissionRequest} requestParameters Request parameters.
|
|
607
|
-
* @param {*} [options] Override http request option.
|
|
608
|
-
* @throws {RequiredError}
|
|
609
|
-
*/
|
|
610
|
-
postContentDocumentApprovalSubmission(requestParameters, options) {
|
|
611
|
-
return localVarFp.postContentDocumentApprovalSubmission(requestParameters.contentReferenceKey, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
|
|
612
|
-
},
|
|
613
|
-
/**
|
|
614
|
-
* 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).
|
|
615
|
-
* @param {AplusContentApiPostContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
616
|
-
* @param {*} [options] Override http request option.
|
|
617
|
-
* @throws {RequiredError}
|
|
618
|
-
*/
|
|
619
|
-
postContentDocumentAsinRelations(requestParameters, options) {
|
|
620
|
-
return localVarFp.postContentDocumentAsinRelations(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.postContentDocumentAsinRelationsRequest, options).then((request) => request(axios, basePath));
|
|
621
|
-
},
|
|
622
|
-
/**
|
|
623
|
-
* 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).
|
|
624
|
-
* @param {AplusContentApiPostContentDocumentSuspendSubmissionRequest} requestParameters Request parameters.
|
|
625
|
-
* @param {*} [options] Override http request option.
|
|
626
|
-
* @throws {RequiredError}
|
|
627
|
-
*/
|
|
628
|
-
postContentDocumentSuspendSubmission(requestParameters, options) {
|
|
629
|
-
return localVarFp.postContentDocumentSuspendSubmission(requestParameters.contentReferenceKey, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
|
|
630
|
-
},
|
|
631
|
-
/**
|
|
632
|
-
* 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).
|
|
633
|
-
* @param {AplusContentApiSearchContentDocumentsRequest} requestParameters Request parameters.
|
|
634
|
-
* @param {*} [options] Override http request option.
|
|
635
|
-
* @throws {RequiredError}
|
|
636
|
-
*/
|
|
637
|
-
searchContentDocuments(requestParameters, options) {
|
|
638
|
-
return localVarFp.searchContentDocuments(requestParameters.marketplaceId, requestParameters.pageToken, options).then((request) => request(axios, basePath));
|
|
639
|
-
},
|
|
640
|
-
/**
|
|
641
|
-
* 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).
|
|
642
|
-
* @param {AplusContentApiSearchContentPublishRecordsRequest} requestParameters Request parameters.
|
|
643
|
-
* @param {*} [options] Override http request option.
|
|
644
|
-
* @throws {RequiredError}
|
|
645
|
-
*/
|
|
646
|
-
searchContentPublishRecords(requestParameters, options) {
|
|
647
|
-
return localVarFp.searchContentPublishRecords(requestParameters.marketplaceId, requestParameters.asin, requestParameters.pageToken, options).then((request) => request(axios, basePath));
|
|
648
|
-
},
|
|
649
|
-
/**
|
|
650
|
-
* 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).
|
|
651
|
-
* @param {AplusContentApiUpdateContentDocumentRequest} requestParameters Request parameters.
|
|
652
|
-
* @param {*} [options] Override http request option.
|
|
653
|
-
* @throws {RequiredError}
|
|
654
|
-
*/
|
|
655
|
-
updateContentDocument(requestParameters, options) {
|
|
656
|
-
return localVarFp.updateContentDocument(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.postContentDocumentRequest, options).then((request) => request(axios, basePath));
|
|
657
|
-
},
|
|
658
|
-
/**
|
|
659
|
-
* 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).
|
|
660
|
-
* @param {AplusContentApiValidateContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
661
|
-
* @param {*} [options] Override http request option.
|
|
662
|
-
* @throws {RequiredError}
|
|
663
|
-
*/
|
|
664
|
-
validateContentDocumentAsinRelations(requestParameters, options) {
|
|
665
|
-
return localVarFp.validateContentDocumentAsinRelations(requestParameters.marketplaceId, requestParameters.postContentDocumentRequest, requestParameters.asinSet, options).then((request) => request(axios, basePath));
|
|
666
|
-
},
|
|
667
|
-
};
|
|
668
|
-
};
|
|
669
|
-
exports.AplusContentApiFactory = AplusContentApiFactory;
|
|
670
|
-
/**
|
|
671
|
-
* AplusContentApi - object-oriented interface
|
|
672
|
-
*/
|
|
673
|
-
class AplusContentApi extends base_1.BaseAPI {
|
|
674
|
-
/**
|
|
675
|
-
* 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).
|
|
676
|
-
* @param {AplusContentApiCreateContentDocumentRequest} requestParameters Request parameters.
|
|
677
|
-
* @param {*} [options] Override http request option.
|
|
678
|
-
* @throws {RequiredError}
|
|
679
|
-
*/
|
|
680
|
-
createContentDocument(requestParameters, options) {
|
|
681
|
-
return (0, exports.AplusContentApiFp)(this.configuration).createContentDocument(requestParameters.marketplaceId, requestParameters.postContentDocumentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
682
|
-
}
|
|
683
|
-
/**
|
|
684
|
-
* 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).
|
|
685
|
-
* @param {AplusContentApiGetContentDocumentRequest} requestParameters Request parameters.
|
|
686
|
-
* @param {*} [options] Override http request option.
|
|
687
|
-
* @throws {RequiredError}
|
|
688
|
-
*/
|
|
689
|
-
getContentDocument(requestParameters, options) {
|
|
690
|
-
return (0, exports.AplusContentApiFp)(this.configuration).getContentDocument(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.includedDataSet, options).then((request) => request(this.axios, this.basePath));
|
|
691
|
-
}
|
|
692
|
-
/**
|
|
693
|
-
* 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).
|
|
694
|
-
* @param {AplusContentApiListContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
695
|
-
* @param {*} [options] Override http request option.
|
|
696
|
-
* @throws {RequiredError}
|
|
697
|
-
*/
|
|
698
|
-
listContentDocumentAsinRelations(requestParameters, options) {
|
|
699
|
-
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));
|
|
700
|
-
}
|
|
701
|
-
/**
|
|
702
|
-
* 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).
|
|
703
|
-
* @param {AplusContentApiPostContentDocumentApprovalSubmissionRequest} requestParameters Request parameters.
|
|
704
|
-
* @param {*} [options] Override http request option.
|
|
705
|
-
* @throws {RequiredError}
|
|
706
|
-
*/
|
|
707
|
-
postContentDocumentApprovalSubmission(requestParameters, options) {
|
|
708
|
-
return (0, exports.AplusContentApiFp)(this.configuration).postContentDocumentApprovalSubmission(requestParameters.contentReferenceKey, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath));
|
|
709
|
-
}
|
|
710
|
-
/**
|
|
711
|
-
* 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).
|
|
712
|
-
* @param {AplusContentApiPostContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
713
|
-
* @param {*} [options] Override http request option.
|
|
714
|
-
* @throws {RequiredError}
|
|
715
|
-
*/
|
|
716
|
-
postContentDocumentAsinRelations(requestParameters, options) {
|
|
717
|
-
return (0, exports.AplusContentApiFp)(this.configuration).postContentDocumentAsinRelations(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.postContentDocumentAsinRelationsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
718
|
-
}
|
|
719
|
-
/**
|
|
720
|
-
* 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).
|
|
721
|
-
* @param {AplusContentApiPostContentDocumentSuspendSubmissionRequest} requestParameters Request parameters.
|
|
722
|
-
* @param {*} [options] Override http request option.
|
|
723
|
-
* @throws {RequiredError}
|
|
724
|
-
*/
|
|
725
|
-
postContentDocumentSuspendSubmission(requestParameters, options) {
|
|
726
|
-
return (0, exports.AplusContentApiFp)(this.configuration).postContentDocumentSuspendSubmission(requestParameters.contentReferenceKey, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath));
|
|
727
|
-
}
|
|
728
|
-
/**
|
|
729
|
-
* 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).
|
|
730
|
-
* @param {AplusContentApiSearchContentDocumentsRequest} requestParameters Request parameters.
|
|
731
|
-
* @param {*} [options] Override http request option.
|
|
732
|
-
* @throws {RequiredError}
|
|
733
|
-
*/
|
|
734
|
-
searchContentDocuments(requestParameters, options) {
|
|
735
|
-
return (0, exports.AplusContentApiFp)(this.configuration).searchContentDocuments(requestParameters.marketplaceId, requestParameters.pageToken, options).then((request) => request(this.axios, this.basePath));
|
|
736
|
-
}
|
|
737
|
-
/**
|
|
738
|
-
* 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).
|
|
739
|
-
* @param {AplusContentApiSearchContentPublishRecordsRequest} requestParameters Request parameters.
|
|
740
|
-
* @param {*} [options] Override http request option.
|
|
741
|
-
* @throws {RequiredError}
|
|
742
|
-
*/
|
|
743
|
-
searchContentPublishRecords(requestParameters, options) {
|
|
744
|
-
return (0, exports.AplusContentApiFp)(this.configuration).searchContentPublishRecords(requestParameters.marketplaceId, requestParameters.asin, requestParameters.pageToken, options).then((request) => request(this.axios, this.basePath));
|
|
745
|
-
}
|
|
746
|
-
/**
|
|
747
|
-
* 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).
|
|
748
|
-
* @param {AplusContentApiUpdateContentDocumentRequest} requestParameters Request parameters.
|
|
749
|
-
* @param {*} [options] Override http request option.
|
|
750
|
-
* @throws {RequiredError}
|
|
751
|
-
*/
|
|
752
|
-
updateContentDocument(requestParameters, options) {
|
|
753
|
-
return (0, exports.AplusContentApiFp)(this.configuration).updateContentDocument(requestParameters.contentReferenceKey, requestParameters.marketplaceId, requestParameters.postContentDocumentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
754
|
-
}
|
|
755
|
-
/**
|
|
756
|
-
* 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).
|
|
757
|
-
* @param {AplusContentApiValidateContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
758
|
-
* @param {*} [options] Override http request option.
|
|
759
|
-
* @throws {RequiredError}
|
|
760
|
-
*/
|
|
761
|
-
validateContentDocumentAsinRelations(requestParameters, options) {
|
|
762
|
-
return (0, exports.AplusContentApiFp)(this.configuration).validateContentDocumentAsinRelations(requestParameters.marketplaceId, requestParameters.postContentDocumentRequest, requestParameters.asinSet, options).then((request) => request(this.axios, this.basePath));
|
|
763
|
-
}
|
|
764
|
-
}
|
|
765
|
-
exports.AplusContentApi = AplusContentApi;
|
|
766
|
-
exports.GetContentDocumentIncludedDataSetEnum = {
|
|
767
|
-
Contents: 'CONTENTS',
|
|
768
|
-
Metadata: 'METADATA',
|
|
769
|
-
};
|
|
770
|
-
exports.ListContentDocumentAsinRelationsIncludedDataSetEnum = {
|
|
771
|
-
Metadata: 'METADATA',
|
|
772
|
-
};
|