Class AplusContentApiClient

Hierarchy

AplusContentApi
- AplusContentApiClient

Index

Constructors

Methods

createContentDocument getContentDocument listContentDocumentAsinRelations postContentDocumentApprovalSubmission postContentDocumentAsinRelations postContentDocumentSuspendSubmission searchContentDocuments searchContentPublishRecords updateContentDocument validateContentDocumentAsinRelations

Constructors

constructor

new AplusContentApiClient(
parameters: APIConfigurationParameters,
): AplusContentApiClient
Parameters
- parameters: APIConfigurationParameters
Returns AplusContentApiClient
Overrides AplusContentApi.constructor
- Defined in src/api-clients/aplus-content-api-client.ts:7

Methods

createContentDocument

createContentDocument(
requestParameters: AplusContentApiModelAplusContentApiCreateContentDocumentRequest,
options?: any,
): Promise<AxiosResponse<AplusContentApiModelPostContentDocumentResponse>>
Creates a new 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.
Parameters
- requestParameters: AplusContentApiModelAplusContentApiCreateContentDocumentRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<AxiosResponse<AplusContentApiModelPostContentDocumentResponse>>
Throws
Memberof
AplusContentApi
Inherited from AplusContentApi.createContentDocument
- Defined in src/api-models/aplus-content-api-model/api.ts:2547

getContentDocument

getContentDocument(
requestParameters: AplusContentApiModelAplusContentApiGetContentDocumentRequest,
options?: any,
): Promise<AxiosResponse<AplusContentApiModelGetContentDocumentResponse>>
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.
Parameters
- requestParameters: AplusContentApiModelAplusContentApiGetContentDocumentRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<AxiosResponse<AplusContentApiModelGetContentDocumentResponse>>
Throws
Memberof
AplusContentApi
Inherited from AplusContentApi.getContentDocument
- Defined in src/api-models/aplus-content-api-model/api.ts:2558

listContentDocumentAsinRelations

listContentDocumentAsinRelations(
    requestParameters: AplusContentApiModelAplusContentApiListContentDocumentAsinRelationsRequest,
    options?: any,
): Promise<
    AxiosResponse<
        AplusContentApiModelListContentDocumentAsinRelationsResponse,
    >,
>
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.
Parameters
- requestParameters: AplusContentApiModelAplusContentApiListContentDocumentAsinRelationsRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<
    AxiosResponse<
        AplusContentApiModelListContentDocumentAsinRelationsResponse,
    >,
>
Throws
Memberof
AplusContentApi
Inherited from AplusContentApi.listContentDocumentAsinRelations
- Defined in src/api-models/aplus-content-api-model/api.ts:2569

postContentDocumentApprovalSubmission

postContentDocumentApprovalSubmission(
    requestParameters: AplusContentApiModelAplusContentApiPostContentDocumentApprovalSubmissionRequest,
    options?: any,
): Promise<
    AxiosResponse<
        AplusContentApiModelPostContentDocumentApprovalSubmissionResponse,
    >,
>
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.
Parameters
- requestParameters: AplusContentApiModelAplusContentApiPostContentDocumentApprovalSubmissionRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<
    AxiosResponse<
        AplusContentApiModelPostContentDocumentApprovalSubmissionResponse,
    >,
>
Throws
Memberof
AplusContentApi
Inherited from AplusContentApi.postContentDocumentApprovalSubmission
- Defined in src/api-models/aplus-content-api-model/api.ts:2580

postContentDocumentAsinRelations

postContentDocumentAsinRelations(
    requestParameters: AplusContentApiModelAplusContentApiPostContentDocumentAsinRelationsRequest,
    options?: any,
): Promise<
    AxiosResponse<
        AplusContentApiModelPostContentDocumentAsinRelationsResponse,
    >,
>
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.
Parameters
- requestParameters: AplusContentApiModelAplusContentApiPostContentDocumentAsinRelationsRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<
    AxiosResponse<
        AplusContentApiModelPostContentDocumentAsinRelationsResponse,
    >,
>
Throws
Memberof
AplusContentApi
Inherited from AplusContentApi.postContentDocumentAsinRelations
- Defined in src/api-models/aplus-content-api-model/api.ts:2591

postContentDocumentSuspendSubmission

postContentDocumentSuspendSubmission(
    requestParameters: AplusContentApiModelAplusContentApiPostContentDocumentSuspendSubmissionRequest,
    options?: any,
): Promise<
    AxiosResponse<
        AplusContentApiModelPostContentDocumentSuspendSubmissionResponse,
    >,
>
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.
Parameters
- requestParameters: AplusContentApiModelAplusContentApiPostContentDocumentSuspendSubmissionRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<
    AxiosResponse<
        AplusContentApiModelPostContentDocumentSuspendSubmissionResponse,
    >,
>
Throws
Memberof
AplusContentApi
Inherited from AplusContentApi.postContentDocumentSuspendSubmission
- Defined in src/api-models/aplus-content-api-model/api.ts:2602

searchContentDocuments

searchContentDocuments(
    requestParameters: AplusContentApiModelAplusContentApiSearchContentDocumentsRequest,
    options?: any,
): Promise<
    AxiosResponse<AplusContentApiModelSearchContentDocumentsResponse>,
>
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.
Parameters
- requestParameters: AplusContentApiModelAplusContentApiSearchContentDocumentsRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<AxiosResponse<AplusContentApiModelSearchContentDocumentsResponse>>
Throws
Memberof
AplusContentApi
Inherited from AplusContentApi.searchContentDocuments
- Defined in src/api-models/aplus-content-api-model/api.ts:2613

searchContentPublishRecords

searchContentPublishRecords(
    requestParameters: AplusContentApiModelAplusContentApiSearchContentPublishRecordsRequest,
    options?: any,
): Promise<
    AxiosResponse<AplusContentApiModelSearchContentPublishRecordsResponse>,
>
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.
Parameters
- requestParameters: AplusContentApiModelAplusContentApiSearchContentPublishRecordsRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<AxiosResponse<AplusContentApiModelSearchContentPublishRecordsResponse>>
Throws
Memberof
AplusContentApi
Inherited from AplusContentApi.searchContentPublishRecords
- Defined in src/api-models/aplus-content-api-model/api.ts:2624

updateContentDocument

updateContentDocument(
requestParameters: AplusContentApiModelAplusContentApiUpdateContentDocumentRequest,
options?: any,
): Promise<AxiosResponse<AplusContentApiModelPostContentDocumentResponse>>
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.
Parameters
- requestParameters: AplusContentApiModelAplusContentApiUpdateContentDocumentRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<AxiosResponse<AplusContentApiModelPostContentDocumentResponse>>
Throws
Memberof
AplusContentApi
Inherited from AplusContentApi.updateContentDocument
- Defined in src/api-models/aplus-content-api-model/api.ts:2635

validateContentDocumentAsinRelations

validateContentDocumentAsinRelations(
    requestParameters: AplusContentApiModelAplusContentApiValidateContentDocumentAsinRelationsRequest,
    options?: any,
): Promise<
    AxiosResponse<
        AplusContentApiModelValidateContentDocumentAsinRelationsResponse,
    >,
>
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.
Parameters
- requestParameters: AplusContentApiModelAplusContentApiValidateContentDocumentAsinRelationsRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<
    AxiosResponse<
        AplusContentApiModelValidateContentDocumentAsinRelationsResponse,
    >,
>
Throws
Memberof
AplusContentApi
Inherited from AplusContentApi.validateContentDocumentAsinRelations
- Defined in src/api-models/aplus-content-api-model/api.ts:2646

Class AplusContentApiClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AplusContentApiClient

Methods

createContentDocument

Parameters

Returns Promise<AxiosResponse<AplusContentApiModelPostContentDocumentResponse>>

Throws

Memberof

getContentDocument

Parameters

Returns Promise<AxiosResponse<AplusContentApiModelGetContentDocumentResponse>>

Throws

Memberof

listContentDocumentAsinRelations

Parameters

Returns Promise< AxiosResponse< AplusContentApiModelListContentDocumentAsinRelationsResponse, >,>

Throws

Memberof

postContentDocumentApprovalSubmission

Parameters

Returns Promise< AxiosResponse< AplusContentApiModelPostContentDocumentApprovalSubmissionResponse, >,>

Throws

Memberof

postContentDocumentAsinRelations

Parameters

Returns Promise< AxiosResponse< AplusContentApiModelPostContentDocumentAsinRelationsResponse, >,>

Throws

Memberof

postContentDocumentSuspendSubmission

Parameters

Returns Promise< AxiosResponse< AplusContentApiModelPostContentDocumentSuspendSubmissionResponse, >,>

Throws

Memberof

searchContentDocuments

Parameters

Returns Promise<AxiosResponse<AplusContentApiModelSearchContentDocumentsResponse>>

Throws

Memberof

searchContentPublishRecords

Parameters

Returns Promise<AxiosResponse<AplusContentApiModelSearchContentPublishRecordsResponse>>

Throws

Memberof

updateContentDocument

Parameters

Returns Promise<AxiosResponse<AplusContentApiModelPostContentDocumentResponse>>

Throws

Memberof

validateContentDocumentAsinRelations

Parameters

Returns Promise< AxiosResponse< AplusContentApiModelValidateContentDocumentAsinRelationsResponse, >,>

Throws

Memberof

Settings

On This Page

Returns Promise<
AxiosResponse<
AplusContentApiModelListContentDocumentAsinRelationsResponse,
>,
>

Returns Promise<
AxiosResponse<
AplusContentApiModelPostContentDocumentApprovalSubmissionResponse,
>,
>

Returns Promise<
AxiosResponse<
AplusContentApiModelPostContentDocumentAsinRelationsResponse,
>,
>

Returns Promise<
AxiosResponse<
AplusContentApiModelPostContentDocumentSuspendSubmissionResponse,
>,
>

Returns Promise<
AxiosResponse<
AplusContentApiModelValidateContentDocumentAsinRelationsResponse,
>,
>