@sp-api-sdk/aplus-content-api-2020-11-01 2.3.7 → 3.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/dist/cjs/api-model/api/aplus-content-api.js +40 -40
- package/dist/cjs/api-model/configuration.js +7 -1
- package/dist/cjs/api-model/models/content-module-type.js +15 -15
- package/dist/es/api-model/api/aplus-content-api.js +40 -40
- package/dist/es/api-model/configuration.js +7 -1
- package/dist/es/api-model/models/content-module-type.js +15 -15
- package/dist/types/api-model/api/aplus-content-api.d.ts +40 -40
- package/dist/types/api-model/models/content-module-type.d.ts +15 -15
- package/dist/types/api-model/models/model-error.d.ts +3 -3
- package/package.json +3 -3
|
@@ -30,7 +30,7 @@ import type { ValidateContentDocumentAsinRelationsResponse } from '../models';
|
|
|
30
30
|
*/
|
|
31
31
|
export declare const AplusContentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32
32
|
/**
|
|
33
|
-
* Creates a new A+ Content document. **Usage
|
|
33
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
34
34
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
35
35
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
36
36
|
* @param {*} [options] Override http request option.
|
|
@@ -38,7 +38,7 @@ export declare const AplusContentApiAxiosParamCreator: (configuration?: Configur
|
|
|
38
38
|
*/
|
|
39
39
|
createContentDocument: (marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
40
|
/**
|
|
41
|
-
* Returns an A+ Content document, if available. **Usage
|
|
41
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
42
42
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
43
43
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
44
44
|
* @param {Set<GetContentDocumentIncludedDataSetEnum>} includedDataSet The set of A+ Content data types to include in the response.
|
|
@@ -47,7 +47,7 @@ export declare const AplusContentApiAxiosParamCreator: (configuration?: Configur
|
|
|
47
47
|
*/
|
|
48
48
|
getContentDocument: (contentReferenceKey: string, marketplaceId: string, includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
49
|
/**
|
|
50
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. **Usage
|
|
50
|
+
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the `asinSet` parameter, the operation returns all ASINs related to the content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
51
51
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
52
52
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
53
53
|
* @param {Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>} [includedDataSet] The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata.
|
|
@@ -58,7 +58,7 @@ export declare const AplusContentApiAxiosParamCreator: (configuration?: Configur
|
|
|
58
58
|
*/
|
|
59
59
|
listContentDocumentAsinRelations: (contentReferenceKey: string, marketplaceId: string, includedDataSet?: Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>, asinSet?: Set<string>, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
60
|
/**
|
|
61
|
-
* Submits an A+ Content document for review, approval, and publishing. **Usage
|
|
61
|
+
* Submits an A+ Content document for review, approval, and publishing. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
62
62
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
63
63
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +66,7 @@ export declare const AplusContentApiAxiosParamCreator: (configuration?: Configur
|
|
|
66
66
|
*/
|
|
67
67
|
postContentDocumentApprovalSubmission: (contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
68
|
/**
|
|
69
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage
|
|
69
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
70
70
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
71
71
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
72
72
|
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The content document ASIN relations request details.
|
|
@@ -75,7 +75,7 @@ export declare const AplusContentApiAxiosParamCreator: (configuration?: Configur
|
|
|
75
75
|
*/
|
|
76
76
|
postContentDocumentAsinRelations: (contentReferenceKey: string, marketplaceId: string, postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
77
|
/**
|
|
78
|
-
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage
|
|
78
|
+
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
79
79
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
80
80
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
81
81
|
* @param {*} [options] Override http request option.
|
|
@@ -83,7 +83,7 @@ export declare const AplusContentApiAxiosParamCreator: (configuration?: Configur
|
|
|
83
83
|
*/
|
|
84
84
|
postContentDocumentSuspendSubmission: (contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
85
85
|
/**
|
|
86
|
-
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage
|
|
86
|
+
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
87
87
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
88
88
|
* @param {string} [pageToken] A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations.
|
|
89
89
|
* @param {*} [options] Override http request option.
|
|
@@ -91,7 +91,7 @@ export declare const AplusContentApiAxiosParamCreator: (configuration?: Configur
|
|
|
91
91
|
*/
|
|
92
92
|
searchContentDocuments: (marketplaceId: string, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
93
93
|
/**
|
|
94
|
-
* Searches for A+ Content publishing records, if available. **Usage
|
|
94
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
95
95
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
96
96
|
* @param {string} asin The Amazon Standard Identification Number (ASIN).
|
|
97
97
|
* @param {string} [pageToken] A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations.
|
|
@@ -100,7 +100,7 @@ export declare const AplusContentApiAxiosParamCreator: (configuration?: Configur
|
|
|
100
100
|
*/
|
|
101
101
|
searchContentPublishRecords: (marketplaceId: string, asin: string, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
102
102
|
/**
|
|
103
|
-
* Updates an existing A+ Content document. **Usage
|
|
103
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
104
104
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
105
105
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
106
106
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
@@ -109,7 +109,7 @@ export declare const AplusContentApiAxiosParamCreator: (configuration?: Configur
|
|
|
109
109
|
*/
|
|
110
110
|
updateContentDocument: (contentReferenceKey: string, marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
111
|
/**
|
|
112
|
-
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage
|
|
112
|
+
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
113
113
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
114
114
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
115
115
|
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
@@ -124,7 +124,7 @@ export declare const AplusContentApiAxiosParamCreator: (configuration?: Configur
|
|
|
124
124
|
*/
|
|
125
125
|
export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
126
126
|
/**
|
|
127
|
-
* Creates a new A+ Content document. **Usage
|
|
127
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
128
128
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
129
129
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
130
130
|
* @param {*} [options] Override http request option.
|
|
@@ -132,7 +132,7 @@ export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
|
132
132
|
*/
|
|
133
133
|
createContentDocument(marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentResponse>>;
|
|
134
134
|
/**
|
|
135
|
-
* Returns an A+ Content document, if available. **Usage
|
|
135
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
136
136
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
137
137
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
138
138
|
* @param {Set<GetContentDocumentIncludedDataSetEnum>} includedDataSet The set of A+ Content data types to include in the response.
|
|
@@ -141,7 +141,7 @@ export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
|
141
141
|
*/
|
|
142
142
|
getContentDocument(contentReferenceKey: string, marketplaceId: string, includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetContentDocumentResponse>>;
|
|
143
143
|
/**
|
|
144
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. **Usage
|
|
144
|
+
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the `asinSet` parameter, the operation returns all ASINs related to the content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
145
145
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
146
146
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
147
147
|
* @param {Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>} [includedDataSet] The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata.
|
|
@@ -152,7 +152,7 @@ export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
|
152
152
|
*/
|
|
153
153
|
listContentDocumentAsinRelations(contentReferenceKey: string, marketplaceId: string, includedDataSet?: Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>, asinSet?: Set<string>, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListContentDocumentAsinRelationsResponse>>;
|
|
154
154
|
/**
|
|
155
|
-
* Submits an A+ Content document for review, approval, and publishing. **Usage
|
|
155
|
+
* Submits an A+ Content document for review, approval, and publishing. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
156
156
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
157
157
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
158
158
|
* @param {*} [options] Override http request option.
|
|
@@ -160,7 +160,7 @@ export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
|
160
160
|
*/
|
|
161
161
|
postContentDocumentApprovalSubmission(contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentApprovalSubmissionResponse>>;
|
|
162
162
|
/**
|
|
163
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage
|
|
163
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
164
164
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
165
165
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
166
166
|
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The content document ASIN relations request details.
|
|
@@ -169,7 +169,7 @@ export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
|
169
169
|
*/
|
|
170
170
|
postContentDocumentAsinRelations(contentReferenceKey: string, marketplaceId: string, postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentAsinRelationsResponse>>;
|
|
171
171
|
/**
|
|
172
|
-
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage
|
|
172
|
+
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
173
173
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
|
|
174
174
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
175
175
|
* @param {*} [options] Override http request option.
|
|
@@ -177,7 +177,7 @@ export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
|
177
177
|
*/
|
|
178
178
|
postContentDocumentSuspendSubmission(contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentSuspendSubmissionResponse>>;
|
|
179
179
|
/**
|
|
180
|
-
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage
|
|
180
|
+
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
181
181
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
182
182
|
* @param {string} [pageToken] A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations.
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
@@ -185,7 +185,7 @@ export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
|
185
185
|
*/
|
|
186
186
|
searchContentDocuments(marketplaceId: string, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchContentDocumentsResponse>>;
|
|
187
187
|
/**
|
|
188
|
-
* Searches for A+ Content publishing records, if available. **Usage
|
|
188
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
189
189
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
190
190
|
* @param {string} asin The Amazon Standard Identification Number (ASIN).
|
|
191
191
|
* @param {string} [pageToken] A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations.
|
|
@@ -194,7 +194,7 @@ export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
|
194
194
|
*/
|
|
195
195
|
searchContentPublishRecords(marketplaceId: string, asin: string, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchContentPublishRecordsResponse>>;
|
|
196
196
|
/**
|
|
197
|
-
* Updates an existing A+ Content document. **Usage
|
|
197
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
198
198
|
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
|
|
199
199
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
200
200
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
@@ -203,7 +203,7 @@ export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
|
203
203
|
*/
|
|
204
204
|
updateContentDocument(contentReferenceKey: string, marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentResponse>>;
|
|
205
205
|
/**
|
|
206
|
-
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage
|
|
206
|
+
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
207
207
|
* @param {string} marketplaceId The identifier for the marketplace where the A+ Content is published.
|
|
208
208
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
209
209
|
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
@@ -218,70 +218,70 @@ export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
|
218
218
|
*/
|
|
219
219
|
export declare const AplusContentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
220
220
|
/**
|
|
221
|
-
* Creates a new A+ Content document. **Usage
|
|
221
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
222
222
|
* @param {AplusContentApiCreateContentDocumentRequest} requestParameters Request parameters.
|
|
223
223
|
* @param {*} [options] Override http request option.
|
|
224
224
|
* @throws {RequiredError}
|
|
225
225
|
*/
|
|
226
226
|
createContentDocument(requestParameters: AplusContentApiCreateContentDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentResponse>;
|
|
227
227
|
/**
|
|
228
|
-
* Returns an A+ Content document, if available. **Usage
|
|
228
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
229
229
|
* @param {AplusContentApiGetContentDocumentRequest} requestParameters Request parameters.
|
|
230
230
|
* @param {*} [options] Override http request option.
|
|
231
231
|
* @throws {RequiredError}
|
|
232
232
|
*/
|
|
233
233
|
getContentDocument(requestParameters: AplusContentApiGetContentDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetContentDocumentResponse>;
|
|
234
234
|
/**
|
|
235
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. **Usage
|
|
235
|
+
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the `asinSet` parameter, the operation returns all ASINs related to the content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
236
236
|
* @param {AplusContentApiListContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
237
237
|
* @param {*} [options] Override http request option.
|
|
238
238
|
* @throws {RequiredError}
|
|
239
239
|
*/
|
|
240
240
|
listContentDocumentAsinRelations(requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListContentDocumentAsinRelationsResponse>;
|
|
241
241
|
/**
|
|
242
|
-
* Submits an A+ Content document for review, approval, and publishing. **Usage
|
|
242
|
+
* Submits an A+ Content document for review, approval, and publishing. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
243
243
|
* @param {AplusContentApiPostContentDocumentApprovalSubmissionRequest} requestParameters Request parameters.
|
|
244
244
|
* @param {*} [options] Override http request option.
|
|
245
245
|
* @throws {RequiredError}
|
|
246
246
|
*/
|
|
247
247
|
postContentDocumentApprovalSubmission(requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentApprovalSubmissionResponse>;
|
|
248
248
|
/**
|
|
249
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage
|
|
249
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
250
250
|
* @param {AplusContentApiPostContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
251
251
|
* @param {*} [options] Override http request option.
|
|
252
252
|
* @throws {RequiredError}
|
|
253
253
|
*/
|
|
254
254
|
postContentDocumentAsinRelations(requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentAsinRelationsResponse>;
|
|
255
255
|
/**
|
|
256
|
-
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage
|
|
256
|
+
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
257
257
|
* @param {AplusContentApiPostContentDocumentSuspendSubmissionRequest} requestParameters Request parameters.
|
|
258
258
|
* @param {*} [options] Override http request option.
|
|
259
259
|
* @throws {RequiredError}
|
|
260
260
|
*/
|
|
261
261
|
postContentDocumentSuspendSubmission(requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentSuspendSubmissionResponse>;
|
|
262
262
|
/**
|
|
263
|
-
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage
|
|
263
|
+
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
264
264
|
* @param {AplusContentApiSearchContentDocumentsRequest} requestParameters Request parameters.
|
|
265
265
|
* @param {*} [options] Override http request option.
|
|
266
266
|
* @throws {RequiredError}
|
|
267
267
|
*/
|
|
268
268
|
searchContentDocuments(requestParameters: AplusContentApiSearchContentDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchContentDocumentsResponse>;
|
|
269
269
|
/**
|
|
270
|
-
* Searches for A+ Content publishing records, if available. **Usage
|
|
270
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
271
271
|
* @param {AplusContentApiSearchContentPublishRecordsRequest} requestParameters Request parameters.
|
|
272
272
|
* @param {*} [options] Override http request option.
|
|
273
273
|
* @throws {RequiredError}
|
|
274
274
|
*/
|
|
275
275
|
searchContentPublishRecords(requestParameters: AplusContentApiSearchContentPublishRecordsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchContentPublishRecordsResponse>;
|
|
276
276
|
/**
|
|
277
|
-
* Updates an existing A+ Content document. **Usage
|
|
277
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
278
278
|
* @param {AplusContentApiUpdateContentDocumentRequest} requestParameters Request parameters.
|
|
279
279
|
* @param {*} [options] Override http request option.
|
|
280
280
|
* @throws {RequiredError}
|
|
281
281
|
*/
|
|
282
282
|
updateContentDocument(requestParameters: AplusContentApiUpdateContentDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentResponse>;
|
|
283
283
|
/**
|
|
284
|
-
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage
|
|
284
|
+
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
285
285
|
* @param {AplusContentApiValidateContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
286
286
|
* @param {*} [options] Override http request option.
|
|
287
287
|
* @throws {RequiredError}
|
|
@@ -534,7 +534,7 @@ export interface AplusContentApiValidateContentDocumentAsinRelationsRequest {
|
|
|
534
534
|
*/
|
|
535
535
|
export declare class AplusContentApi extends BaseAPI {
|
|
536
536
|
/**
|
|
537
|
-
* Creates a new A+ Content document. **Usage
|
|
537
|
+
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
538
538
|
* @param {AplusContentApiCreateContentDocumentRequest} requestParameters Request parameters.
|
|
539
539
|
* @param {*} [options] Override http request option.
|
|
540
540
|
* @throws {RequiredError}
|
|
@@ -542,7 +542,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
542
542
|
*/
|
|
543
543
|
createContentDocument(requestParameters: AplusContentApiCreateContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PostContentDocumentResponse, any>>;
|
|
544
544
|
/**
|
|
545
|
-
* Returns an A+ Content document, if available. **Usage
|
|
545
|
+
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
546
546
|
* @param {AplusContentApiGetContentDocumentRequest} requestParameters Request parameters.
|
|
547
547
|
* @param {*} [options] Override http request option.
|
|
548
548
|
* @throws {RequiredError}
|
|
@@ -550,7 +550,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
550
550
|
*/
|
|
551
551
|
getContentDocument(requestParameters: AplusContentApiGetContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetContentDocumentResponse, any>>;
|
|
552
552
|
/**
|
|
553
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. **Usage
|
|
553
|
+
* Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the `asinSet` parameter, the operation returns all ASINs related to the content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
554
554
|
* @param {AplusContentApiListContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
555
555
|
* @param {*} [options] Override http request option.
|
|
556
556
|
* @throws {RequiredError}
|
|
@@ -558,7 +558,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
558
558
|
*/
|
|
559
559
|
listContentDocumentAsinRelations(requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListContentDocumentAsinRelationsResponse, any>>;
|
|
560
560
|
/**
|
|
561
|
-
* Submits an A+ Content document for review, approval, and publishing. **Usage
|
|
561
|
+
* Submits an A+ Content document for review, approval, and publishing. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
562
562
|
* @param {AplusContentApiPostContentDocumentApprovalSubmissionRequest} requestParameters Request parameters.
|
|
563
563
|
* @param {*} [options] Override http request option.
|
|
564
564
|
* @throws {RequiredError}
|
|
@@ -566,7 +566,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
566
566
|
*/
|
|
567
567
|
postContentDocumentApprovalSubmission(requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<import("../models").AplusResponse, any>>;
|
|
568
568
|
/**
|
|
569
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage
|
|
569
|
+
* Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
570
570
|
* @param {AplusContentApiPostContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
571
571
|
* @param {*} [options] Override http request option.
|
|
572
572
|
* @throws {RequiredError}
|
|
@@ -574,7 +574,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
574
574
|
*/
|
|
575
575
|
postContentDocumentAsinRelations(requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<import("../models").AplusResponse, any>>;
|
|
576
576
|
/**
|
|
577
|
-
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage
|
|
577
|
+
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
578
578
|
* @param {AplusContentApiPostContentDocumentSuspendSubmissionRequest} requestParameters Request parameters.
|
|
579
579
|
* @param {*} [options] Override http request option.
|
|
580
580
|
* @throws {RequiredError}
|
|
@@ -582,7 +582,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
582
582
|
*/
|
|
583
583
|
postContentDocumentSuspendSubmission(requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<import("../models").AplusResponse, any>>;
|
|
584
584
|
/**
|
|
585
|
-
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage
|
|
585
|
+
* Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
586
586
|
* @param {AplusContentApiSearchContentDocumentsRequest} requestParameters Request parameters.
|
|
587
587
|
* @param {*} [options] Override http request option.
|
|
588
588
|
* @throws {RequiredError}
|
|
@@ -590,7 +590,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
590
590
|
*/
|
|
591
591
|
searchContentDocuments(requestParameters: AplusContentApiSearchContentDocumentsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SearchContentDocumentsResponse, any>>;
|
|
592
592
|
/**
|
|
593
|
-
* Searches for A+ Content publishing records, if available. **Usage
|
|
593
|
+
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
594
594
|
* @param {AplusContentApiSearchContentPublishRecordsRequest} requestParameters Request parameters.
|
|
595
595
|
* @param {*} [options] Override http request option.
|
|
596
596
|
* @throws {RequiredError}
|
|
@@ -598,7 +598,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
598
598
|
*/
|
|
599
599
|
searchContentPublishRecords(requestParameters: AplusContentApiSearchContentPublishRecordsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SearchContentPublishRecordsResponse, any>>;
|
|
600
600
|
/**
|
|
601
|
-
* Updates an existing A+ Content document. **Usage
|
|
601
|
+
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
602
602
|
* @param {AplusContentApiUpdateContentDocumentRequest} requestParameters Request parameters.
|
|
603
603
|
* @param {*} [options] Override http request option.
|
|
604
604
|
* @throws {RequiredError}
|
|
@@ -606,7 +606,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
606
606
|
*/
|
|
607
607
|
updateContentDocument(requestParameters: AplusContentApiUpdateContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PostContentDocumentResponse, any>>;
|
|
608
608
|
/**
|
|
609
|
-
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage
|
|
609
|
+
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
610
610
|
* @param {AplusContentApiValidateContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
611
611
|
* @param {*} [options] Override http request option.
|
|
612
612
|
* @throws {RequiredError}
|
|
@@ -15,20 +15,20 @@
|
|
|
15
15
|
* @enum {string}
|
|
16
16
|
*/
|
|
17
17
|
export declare const ContentModuleType: {
|
|
18
|
-
readonly
|
|
19
|
-
readonly
|
|
20
|
-
readonly
|
|
21
|
-
readonly
|
|
22
|
-
readonly
|
|
23
|
-
readonly
|
|
24
|
-
readonly
|
|
25
|
-
readonly
|
|
26
|
-
readonly
|
|
27
|
-
readonly
|
|
28
|
-
readonly
|
|
29
|
-
readonly
|
|
30
|
-
readonly
|
|
31
|
-
readonly
|
|
32
|
-
readonly
|
|
18
|
+
readonly StandardCompanyLogo: "STANDARD_COMPANY_LOGO";
|
|
19
|
+
readonly StandardComparisonTable: "STANDARD_COMPARISON_TABLE";
|
|
20
|
+
readonly StandardFourImageText: "STANDARD_FOUR_IMAGE_TEXT";
|
|
21
|
+
readonly StandardFourImageTextQuadrant: "STANDARD_FOUR_IMAGE_TEXT_QUADRANT";
|
|
22
|
+
readonly StandardHeaderImageText: "STANDARD_HEADER_IMAGE_TEXT";
|
|
23
|
+
readonly StandardImageSidebar: "STANDARD_IMAGE_SIDEBAR";
|
|
24
|
+
readonly StandardImageTextOverlay: "STANDARD_IMAGE_TEXT_OVERLAY";
|
|
25
|
+
readonly StandardMultipleImageText: "STANDARD_MULTIPLE_IMAGE_TEXT";
|
|
26
|
+
readonly StandardProductDescription: "STANDARD_PRODUCT_DESCRIPTION";
|
|
27
|
+
readonly StandardSingleImageHighlights: "STANDARD_SINGLE_IMAGE_HIGHLIGHTS";
|
|
28
|
+
readonly StandardSingleImageSpecsDetail: "STANDARD_SINGLE_IMAGE_SPECS_DETAIL";
|
|
29
|
+
readonly StandardSingleSideImage: "STANDARD_SINGLE_SIDE_IMAGE";
|
|
30
|
+
readonly StandardTechSpecs: "STANDARD_TECH_SPECS";
|
|
31
|
+
readonly StandardText: "STANDARD_TEXT";
|
|
32
|
+
readonly StandardThreeImageText: "STANDARD_THREE_IMAGE_TEXT";
|
|
33
33
|
};
|
|
34
34
|
export type ContentModuleType = typeof ContentModuleType[keyof typeof ContentModuleType];
|
|
@@ -16,19 +16,19 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface ModelError {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* An error code that identifies the type of error that occurred.
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof ModelError
|
|
22
22
|
*/
|
|
23
23
|
'code': string;
|
|
24
24
|
/**
|
|
25
|
-
* A
|
|
25
|
+
* A message that describes the error condition.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof ModelError
|
|
28
28
|
*/
|
|
29
29
|
'message': string;
|
|
30
30
|
/**
|
|
31
|
-
* Additional
|
|
31
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof ModelError
|
|
34
34
|
*/
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/aplus-content-api-2020-11-01",
|
|
3
3
|
"author": "Bertrand Marron <bertrand@bizon.solutions>",
|
|
4
4
|
"description": "With the A+ Content API, you can build applications that help selling partners add rich marketing content to their Amazon product detail pages. A+ content helps selling partners share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners assemble content by choosing from content modules and adding images and text.",
|
|
5
|
-
"version": "
|
|
5
|
+
"version": "3.0.0",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"dist/**/*.d.ts"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@sp-api-sdk/common": "2.1.
|
|
21
|
+
"@sp-api-sdk/common": "2.1.9",
|
|
22
22
|
"axios": "^1.7.9"
|
|
23
23
|
},
|
|
24
24
|
"repository": {
|
|
@@ -40,5 +40,5 @@
|
|
|
40
40
|
"sp sdk",
|
|
41
41
|
"aplus content api"
|
|
42
42
|
],
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "00dfa4e5e7dd2f486f00e85e5dab73ea2685eb0f"
|
|
44
44
|
}
|