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