@sp-api-sdk/aplus-content-api-2020-11-01 1.7.4 → 1.7.8
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 +38 -15
- package/dist/cjs/src/client.js +12 -9
- package/dist/es/src/client.js +12 -9
- package/dist/types/src/api-model/api/aplus-content-api.d.ts +10 -10
- package/dist/types/src/api-model/common.d.ts +1 -1
- package/dist/types/src/client.d.ts +4 -4
- package/package.json +5 -5
- package/dist/cjs/src/api-model/models/get-content-document-included-data-type.js +0 -26
- package/dist/cjs/src/api-model/models/list-content-document-asin-relations-included-data-type.js +0 -25
- package/dist/es/src/api-model/models/get-content-document-included-data-type.js +0 -23
- package/dist/es/src/api-model/models/list-content-document-asin-relations-included-data-type.js +0 -22
- package/dist/types/src/api-model/models/get-content-document-included-data-type.d.ts +0 -20
- package/dist/types/src/api-model/models/list-content-document-asin-relations-included-data-type.d.ts +0 -19
package/README.md
CHANGED
|
@@ -2,6 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
With the A+ Content API, you can build applications that help selling partners add rich marketing content to their Amazon product detail pages. A+ content helps selling partners share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners assemble content by choosing from content modules and adding images and text.
|
|
4
4
|
|
|
5
|
+
[](https://www.npmjs.com/package/@sp-api-sdk/aplus-content-api-2020-11-01)
|
|
6
|
+
[](https://github.com/xojs/xo)
|
|
7
|
+
|
|
8
|
+
## Documentation
|
|
9
|
+
|
|
10
|
+
Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/aplus-content-api/aplusContent_2020-11-01.md).
|
|
11
|
+
|
|
12
|
+
Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_aplus_content_api_2020_11_01.html) for this API client.
|
|
13
|
+
|
|
5
14
|
## Installing
|
|
6
15
|
|
|
7
16
|
```sh
|
|
@@ -19,26 +28,25 @@ import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
|
|
|
19
28
|
import {AplusContentApiClient} from '@sp-api-sdk/aplus-content-api-2020-11-01'
|
|
20
29
|
|
|
21
30
|
const auth = new SellingPartnerApiAuth({
|
|
22
|
-
clientId:
|
|
23
|
-
clientSecret:
|
|
24
|
-
refreshToken: '',
|
|
25
|
-
secretAccessKey: '',
|
|
31
|
+
clientId: process.env.LWA_CLIENT_ID,
|
|
32
|
+
clientSecret: process.env.LWA_CLIENT_SECRET,
|
|
33
|
+
refreshToken: 'Atzr|…',
|
|
26
34
|
accessKeyId: '',
|
|
27
|
-
|
|
35
|
+
secretAccessKey: '',
|
|
28
36
|
role: {
|
|
29
|
-
arn: '',
|
|
30
|
-
}
|
|
37
|
+
arn: 'arn:aws:iam::…',
|
|
38
|
+
},
|
|
31
39
|
})
|
|
32
40
|
|
|
33
41
|
const client = new AplusContentApiClient({
|
|
34
42
|
auth,
|
|
35
|
-
region: 'eu'
|
|
43
|
+
region: 'eu',
|
|
36
44
|
})
|
|
37
45
|
```
|
|
38
46
|
|
|
39
|
-
##
|
|
47
|
+
## Rate Limiting
|
|
40
48
|
|
|
41
|
-
|
|
49
|
+
In order to retry rate limited requests (HTTP 429), you can configure the API client as such:
|
|
42
50
|
|
|
43
51
|
```javascript
|
|
44
52
|
const client = new AplusContentApiClient({
|
|
@@ -46,13 +54,28 @@ const client = new AplusContentApiClient({
|
|
|
46
54
|
region: 'eu',
|
|
47
55
|
rateLimiting: {
|
|
48
56
|
retry: true,
|
|
49
|
-
|
|
50
|
-
|
|
57
|
+
// Optionally specify a callback that will be called on every retry.
|
|
58
|
+
onRetry: (retryInfo) => {
|
|
59
|
+
console.log(retryInfo)
|
|
60
|
+
},
|
|
61
|
+
},
|
|
51
62
|
})
|
|
52
63
|
```
|
|
53
64
|
|
|
54
|
-
The
|
|
65
|
+
The rate limits used for each route are specified in the [API documentation]((https://github.com/amzn/selling-partner-api-docs/tree/main/references/aplus-content-api/aplusContent_2020-11-01.md)).
|
|
66
|
+
|
|
67
|
+
## License
|
|
68
|
+
|
|
69
|
+
MIT
|
|
55
70
|
|
|
56
|
-
##
|
|
71
|
+
## Miscellaneous
|
|
57
72
|
|
|
58
|
-
|
|
73
|
+
```
|
|
74
|
+
╚⊙ ⊙╝
|
|
75
|
+
╚═(███)═╝
|
|
76
|
+
╚═(███)═╝
|
|
77
|
+
╚═(███)═╝
|
|
78
|
+
╚═(███)═╝
|
|
79
|
+
╚═(███)═╝
|
|
80
|
+
╚═(███)═╝
|
|
81
|
+
```
|
package/dist/cjs/src/client.js
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.AplusContentApiClient = exports.
|
|
3
|
+
exports.AplusContentApiClient = exports.clientRateLimits = void 0;
|
|
4
4
|
/* eslint-disable prefer-regex-literals */
|
|
5
5
|
const common_1 = require("@sp-api-sdk/common");
|
|
6
6
|
const api_model_1 = require("./api-model");
|
|
7
7
|
const error_1 = require("./error");
|
|
8
|
-
exports.
|
|
8
|
+
exports.clientRateLimits = [
|
|
9
9
|
{
|
|
10
10
|
method: 'get',
|
|
11
11
|
urlRegex: new RegExp('^/aplus/2020-11-01/contentDocuments$'),
|
|
@@ -69,20 +69,23 @@ exports.RATE_LIMITS = [
|
|
|
69
69
|
];
|
|
70
70
|
class AplusContentApiClient extends api_model_1.AplusContentApi {
|
|
71
71
|
constructor(parameters) {
|
|
72
|
-
const
|
|
72
|
+
const config = common_1.sellingPartnerRegions[parameters.region];
|
|
73
|
+
if (!config) {
|
|
74
|
+
throw new error_1.AplusContentApiError(`Unknown region: ${parameters.region}`);
|
|
75
|
+
}
|
|
73
76
|
const { rateLimiting, ...clientParameters } = parameters;
|
|
74
|
-
const axiosParameters = {
|
|
77
|
+
const axiosParameters = {
|
|
78
|
+
...clientParameters,
|
|
79
|
+
region: config.awsRegion,
|
|
80
|
+
};
|
|
75
81
|
if (rateLimiting?.retry) {
|
|
76
|
-
axiosParameters.rateLimits = exports.
|
|
82
|
+
axiosParameters.rateLimits = exports.clientRateLimits;
|
|
77
83
|
axiosParameters.onRetry = rateLimiting.onRetry;
|
|
78
84
|
}
|
|
79
85
|
const axiosInstance = (0, common_1.createAxiosInstance)(axiosParameters);
|
|
80
86
|
const configuration = new api_model_1.Configuration();
|
|
81
87
|
const environment = parameters.sandbox ? 'sandbox' : 'production';
|
|
82
|
-
const endpoint =
|
|
83
|
-
if (!endpoint) {
|
|
84
|
-
throw new error_1.AplusContentApiError(`Unknown region : ${region}`);
|
|
85
|
-
}
|
|
88
|
+
const endpoint = config.endpoints[environment];
|
|
86
89
|
super(configuration, endpoint, axiosInstance);
|
|
87
90
|
}
|
|
88
91
|
}
|
package/dist/es/src/client.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/* eslint-disable prefer-regex-literals */
|
|
2
|
-
import {
|
|
2
|
+
import { sellingPartnerRegions, createAxiosInstance } from '@sp-api-sdk/common';
|
|
3
3
|
import { Configuration, AplusContentApi } from './api-model';
|
|
4
4
|
import { AplusContentApiError } from './error';
|
|
5
|
-
export const
|
|
5
|
+
export const clientRateLimits = [
|
|
6
6
|
{
|
|
7
7
|
method: 'get',
|
|
8
8
|
urlRegex: new RegExp('^/aplus/2020-11-01/contentDocuments$'),
|
|
@@ -66,20 +66,23 @@ export const RATE_LIMITS = [
|
|
|
66
66
|
];
|
|
67
67
|
export class AplusContentApiClient extends AplusContentApi {
|
|
68
68
|
constructor(parameters) {
|
|
69
|
-
const
|
|
69
|
+
const config = sellingPartnerRegions[parameters.region];
|
|
70
|
+
if (!config) {
|
|
71
|
+
throw new AplusContentApiError(`Unknown region: ${parameters.region}`);
|
|
72
|
+
}
|
|
70
73
|
const { rateLimiting, ...clientParameters } = parameters;
|
|
71
|
-
const axiosParameters = {
|
|
74
|
+
const axiosParameters = {
|
|
75
|
+
...clientParameters,
|
|
76
|
+
region: config.awsRegion,
|
|
77
|
+
};
|
|
72
78
|
if (rateLimiting?.retry) {
|
|
73
|
-
axiosParameters.rateLimits =
|
|
79
|
+
axiosParameters.rateLimits = clientRateLimits;
|
|
74
80
|
axiosParameters.onRetry = rateLimiting.onRetry;
|
|
75
81
|
}
|
|
76
82
|
const axiosInstance = createAxiosInstance(axiosParameters);
|
|
77
83
|
const configuration = new Configuration();
|
|
78
84
|
const environment = parameters.sandbox ? 'sandbox' : 'production';
|
|
79
|
-
const endpoint = endpoints[environment]
|
|
80
|
-
if (!endpoint) {
|
|
81
|
-
throw new AplusContentApiError(`Unknown region : ${region}`);
|
|
82
|
-
}
|
|
85
|
+
const endpoint = config.endpoints[environment];
|
|
83
86
|
super(configuration, endpoint, axiosInstance);
|
|
84
87
|
}
|
|
85
88
|
}
|
|
@@ -557,7 +557,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
557
557
|
* @throws {RequiredError}
|
|
558
558
|
* @memberof AplusContentApi
|
|
559
559
|
*/
|
|
560
|
-
createContentDocument(requestParameters: AplusContentApiCreateContentDocumentRequest, options?: any): Promise<import("axios").AxiosResponse<PostContentDocumentResponse>>;
|
|
560
|
+
createContentDocument(requestParameters: AplusContentApiCreateContentDocumentRequest, options?: any): Promise<import("axios").AxiosResponse<PostContentDocumentResponse, any>>;
|
|
561
561
|
/**
|
|
562
562
|
* Returns an A+ Content document, if available. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
563
563
|
* @param {AplusContentApiGetContentDocumentRequest} requestParameters Request parameters.
|
|
@@ -565,7 +565,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
565
565
|
* @throws {RequiredError}
|
|
566
566
|
* @memberof AplusContentApi
|
|
567
567
|
*/
|
|
568
|
-
getContentDocument(requestParameters: AplusContentApiGetContentDocumentRequest, options?: any): Promise<import("axios").AxiosResponse<GetContentDocumentResponse>>;
|
|
568
|
+
getContentDocument(requestParameters: AplusContentApiGetContentDocumentRequest, options?: any): Promise<import("axios").AxiosResponse<GetContentDocumentResponse, any>>;
|
|
569
569
|
/**
|
|
570
570
|
* 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
571
571
|
* @param {AplusContentApiListContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
@@ -573,7 +573,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
573
573
|
* @throws {RequiredError}
|
|
574
574
|
* @memberof AplusContentApi
|
|
575
575
|
*/
|
|
576
|
-
listContentDocumentAsinRelations(requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest, options?: any): Promise<import("axios").AxiosResponse<ListContentDocumentAsinRelationsResponse>>;
|
|
576
|
+
listContentDocumentAsinRelations(requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest, options?: any): Promise<import("axios").AxiosResponse<ListContentDocumentAsinRelationsResponse, any>>;
|
|
577
577
|
/**
|
|
578
578
|
* Submits an A+ Content document for review, approval, and publishing. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
579
579
|
* @param {AplusContentApiPostContentDocumentApprovalSubmissionRequest} requestParameters Request parameters.
|
|
@@ -581,7 +581,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
581
581
|
* @throws {RequiredError}
|
|
582
582
|
* @memberof AplusContentApi
|
|
583
583
|
*/
|
|
584
|
-
postContentDocumentApprovalSubmission(requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest, options?: any): Promise<import("axios").AxiosResponse<import("../models").AplusResponse>>;
|
|
584
|
+
postContentDocumentApprovalSubmission(requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest, options?: any): Promise<import("axios").AxiosResponse<import("../models").AplusResponse, any>>;
|
|
585
585
|
/**
|
|
586
586
|
* 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
587
587
|
* @param {AplusContentApiPostContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
@@ -589,7 +589,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
589
589
|
* @throws {RequiredError}
|
|
590
590
|
* @memberof AplusContentApi
|
|
591
591
|
*/
|
|
592
|
-
postContentDocumentAsinRelations(requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest, options?: any): Promise<import("axios").AxiosResponse<import("../models").AplusResponse>>;
|
|
592
|
+
postContentDocumentAsinRelations(requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest, options?: any): Promise<import("axios").AxiosResponse<import("../models").AplusResponse, any>>;
|
|
593
593
|
/**
|
|
594
594
|
* Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
595
595
|
* @param {AplusContentApiPostContentDocumentSuspendSubmissionRequest} requestParameters Request parameters.
|
|
@@ -597,7 +597,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
597
597
|
* @throws {RequiredError}
|
|
598
598
|
* @memberof AplusContentApi
|
|
599
599
|
*/
|
|
600
|
-
postContentDocumentSuspendSubmission(requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest, options?: any): Promise<import("axios").AxiosResponse<import("../models").AplusResponse>>;
|
|
600
|
+
postContentDocumentSuspendSubmission(requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest, options?: any): Promise<import("axios").AxiosResponse<import("../models").AplusResponse, any>>;
|
|
601
601
|
/**
|
|
602
602
|
* 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
603
603
|
* @param {AplusContentApiSearchContentDocumentsRequest} requestParameters Request parameters.
|
|
@@ -605,7 +605,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
605
605
|
* @throws {RequiredError}
|
|
606
606
|
* @memberof AplusContentApi
|
|
607
607
|
*/
|
|
608
|
-
searchContentDocuments(requestParameters: AplusContentApiSearchContentDocumentsRequest, options?: any): Promise<import("axios").AxiosResponse<SearchContentDocumentsResponse>>;
|
|
608
|
+
searchContentDocuments(requestParameters: AplusContentApiSearchContentDocumentsRequest, options?: any): Promise<import("axios").AxiosResponse<SearchContentDocumentsResponse, any>>;
|
|
609
609
|
/**
|
|
610
610
|
* Searches for A+ Content publishing records, if available. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
611
611
|
* @param {AplusContentApiSearchContentPublishRecordsRequest} requestParameters Request parameters.
|
|
@@ -613,7 +613,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
613
613
|
* @throws {RequiredError}
|
|
614
614
|
* @memberof AplusContentApi
|
|
615
615
|
*/
|
|
616
|
-
searchContentPublishRecords(requestParameters: AplusContentApiSearchContentPublishRecordsRequest, options?: any): Promise<import("axios").AxiosResponse<SearchContentPublishRecordsResponse>>;
|
|
616
|
+
searchContentPublishRecords(requestParameters: AplusContentApiSearchContentPublishRecordsRequest, options?: any): Promise<import("axios").AxiosResponse<SearchContentPublishRecordsResponse, any>>;
|
|
617
617
|
/**
|
|
618
618
|
* Updates an existing A+ Content document. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
619
619
|
* @param {AplusContentApiUpdateContentDocumentRequest} requestParameters Request parameters.
|
|
@@ -621,7 +621,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
621
621
|
* @throws {RequiredError}
|
|
622
622
|
* @memberof AplusContentApi
|
|
623
623
|
*/
|
|
624
|
-
updateContentDocument(requestParameters: AplusContentApiUpdateContentDocumentRequest, options?: any): Promise<import("axios").AxiosResponse<PostContentDocumentResponse>>;
|
|
624
|
+
updateContentDocument(requestParameters: AplusContentApiUpdateContentDocumentRequest, options?: any): Promise<import("axios").AxiosResponse<PostContentDocumentResponse, any>>;
|
|
625
625
|
/**
|
|
626
626
|
* Checks if the A+ Content document is valid for use on a set of ASINs. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
627
627
|
* @param {AplusContentApiValidateContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
@@ -629,5 +629,5 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
629
629
|
* @throws {RequiredError}
|
|
630
630
|
* @memberof AplusContentApi
|
|
631
631
|
*/
|
|
632
|
-
validateContentDocumentAsinRelations(requestParameters: AplusContentApiValidateContentDocumentAsinRelationsRequest, options?: any): Promise<import("axios").AxiosResponse<ValidateContentDocumentAsinRelationsResponse>>;
|
|
632
|
+
validateContentDocumentAsinRelations(requestParameters: AplusContentApiValidateContentDocumentAsinRelationsRequest, options?: any): Promise<import("axios").AxiosResponse<ValidateContentDocumentAsinRelationsResponse, any>>;
|
|
633
633
|
}
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any>>;
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any, any>>;
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
|
|
1
|
+
import type { ClientConfiguration, SellingPartnerRegion, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
|
|
3
2
|
import { AplusContentApi } from './api-model';
|
|
4
|
-
export declare const
|
|
3
|
+
export declare const clientRateLimits: RateLimit[];
|
|
5
4
|
export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
|
|
5
|
+
region: SellingPartnerRegion;
|
|
6
6
|
rateLimiting?: {
|
|
7
7
|
retry: boolean;
|
|
8
|
-
onRetry?:
|
|
8
|
+
onRetry?: OnRetryHandler;
|
|
9
9
|
};
|
|
10
10
|
}
|
|
11
11
|
export declare class AplusContentApiClient extends AplusContentApi {
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/aplus-content-api-2020-11-01",
|
|
3
3
|
"author": "Vincent Mesquita <vincent.mesquita@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": "1.7.
|
|
5
|
+
"version": "1.7.8",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -25,9 +25,9 @@
|
|
|
25
25
|
"test": "NODE_ENV='test' yarn jest"
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@sp-api-sdk/auth": "^1.9.
|
|
29
|
-
"@sp-api-sdk/common": "^1.7.
|
|
30
|
-
"axios": "^0.
|
|
28
|
+
"@sp-api-sdk/auth": "^1.9.6",
|
|
29
|
+
"@sp-api-sdk/common": "^1.7.8",
|
|
30
|
+
"axios": "^0.24.0"
|
|
31
31
|
},
|
|
32
32
|
"repository": {
|
|
33
33
|
"type": "git",
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"sp sdk",
|
|
49
49
|
"aplus content api"
|
|
50
50
|
],
|
|
51
|
-
"gitHead": "
|
|
51
|
+
"gitHead": "c3e42b71400941563ab1e3ec689fada6111e629d"
|
|
52
52
|
}
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/* tslint:disable */
|
|
3
|
-
/* eslint-disable */
|
|
4
|
-
/**
|
|
5
|
-
* Selling Partner API for A+ Content Management
|
|
6
|
-
* 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.
|
|
7
|
-
*
|
|
8
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
-
* https://openapi-generator.tech
|
|
13
|
-
* Do not edit the class manually.
|
|
14
|
-
*/
|
|
15
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.GetContentDocumentIncludedDataType = void 0;
|
|
17
|
-
/**
|
|
18
|
-
* The type of data to include in the response, such as the contents or the metadata of the A+ Content documents.
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
|
-
*/
|
|
22
|
-
var GetContentDocumentIncludedDataType;
|
|
23
|
-
(function (GetContentDocumentIncludedDataType) {
|
|
24
|
-
GetContentDocumentIncludedDataType["Contents"] = "CONTENTS";
|
|
25
|
-
GetContentDocumentIncludedDataType["Metadata"] = "METADATA";
|
|
26
|
-
})(GetContentDocumentIncludedDataType = exports.GetContentDocumentIncludedDataType || (exports.GetContentDocumentIncludedDataType = {}));
|
package/dist/cjs/src/api-model/models/list-content-document-asin-relations-included-data-type.js
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/* tslint:disable */
|
|
3
|
-
/* eslint-disable */
|
|
4
|
-
/**
|
|
5
|
-
* Selling Partner API for A+ Content Management
|
|
6
|
-
* 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.
|
|
7
|
-
*
|
|
8
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
-
* https://openapi-generator.tech
|
|
13
|
-
* Do not edit the class manually.
|
|
14
|
-
*/
|
|
15
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.ListContentDocumentAsinRelationsIncludedDataType = void 0;
|
|
17
|
-
/**
|
|
18
|
-
* The type of data to include in the response, such as metadata about the related ASINs.
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
|
-
*/
|
|
22
|
-
var ListContentDocumentAsinRelationsIncludedDataType;
|
|
23
|
-
(function (ListContentDocumentAsinRelationsIncludedDataType) {
|
|
24
|
-
ListContentDocumentAsinRelationsIncludedDataType["Metadata"] = "METADATA";
|
|
25
|
-
})(ListContentDocumentAsinRelationsIncludedDataType = exports.ListContentDocumentAsinRelationsIncludedDataType || (exports.ListContentDocumentAsinRelationsIncludedDataType = {}));
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Selling Partner API for A+ Content Management
|
|
5
|
-
* 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.
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
/**
|
|
15
|
-
* The type of data to include in the response, such as the contents or the metadata of the A+ Content documents.
|
|
16
|
-
* @export
|
|
17
|
-
* @enum {string}
|
|
18
|
-
*/
|
|
19
|
-
export var GetContentDocumentIncludedDataType;
|
|
20
|
-
(function (GetContentDocumentIncludedDataType) {
|
|
21
|
-
GetContentDocumentIncludedDataType["Contents"] = "CONTENTS";
|
|
22
|
-
GetContentDocumentIncludedDataType["Metadata"] = "METADATA";
|
|
23
|
-
})(GetContentDocumentIncludedDataType || (GetContentDocumentIncludedDataType = {}));
|
package/dist/es/src/api-model/models/list-content-document-asin-relations-included-data-type.js
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Selling Partner API for A+ Content Management
|
|
5
|
-
* 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.
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
/**
|
|
15
|
-
* The type of data to include in the response, such as metadata about the related ASINs.
|
|
16
|
-
* @export
|
|
17
|
-
* @enum {string}
|
|
18
|
-
*/
|
|
19
|
-
export var ListContentDocumentAsinRelationsIncludedDataType;
|
|
20
|
-
(function (ListContentDocumentAsinRelationsIncludedDataType) {
|
|
21
|
-
ListContentDocumentAsinRelationsIncludedDataType["Metadata"] = "METADATA";
|
|
22
|
-
})(ListContentDocumentAsinRelationsIncludedDataType || (ListContentDocumentAsinRelationsIncludedDataType = {}));
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Selling Partner API for A+ Content Management
|
|
3
|
-
* With the A+ Content API, you can build applications that help selling partners add rich marketing content to their Amazon product detail pages. A+ content helps selling partners share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners assemble content by choosing from content modules and adding images and text.
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
-
* https://openapi-generator.tech
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
/**
|
|
13
|
-
* The type of data to include in the response, such as the contents or the metadata of the A+ Content documents.
|
|
14
|
-
* @export
|
|
15
|
-
* @enum {string}
|
|
16
|
-
*/
|
|
17
|
-
export declare enum GetContentDocumentIncludedDataType {
|
|
18
|
-
Contents = "CONTENTS",
|
|
19
|
-
Metadata = "METADATA"
|
|
20
|
-
}
|
package/dist/types/src/api-model/models/list-content-document-asin-relations-included-data-type.d.ts
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Selling Partner API for A+ Content Management
|
|
3
|
-
* With the A+ Content API, you can build applications that help selling partners add rich marketing content to their Amazon product detail pages. A+ content helps selling partners share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners assemble content by choosing from content modules and adding images and text.
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 2020-11-01
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
-
* https://openapi-generator.tech
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
/**
|
|
13
|
-
* The type of data to include in the response, such as metadata about the related ASINs.
|
|
14
|
-
* @export
|
|
15
|
-
* @enum {string}
|
|
16
|
-
*/
|
|
17
|
-
export declare enum ListContentDocumentAsinRelationsIncludedDataType {
|
|
18
|
-
Metadata = "METADATA"
|
|
19
|
-
}
|