Class AplusContentApiClient

AplusContentApi - object-oriented interface

Export

AplusContentApi

Hierarchy (View Summary)

AplusContentApi
- AplusContentApiClient

Index

Constructors

constructor

new AplusContentApiClient(
configuration: ClientConfiguration,
): AplusContentApiClient
Parameters
- configuration: ClientConfiguration
Returns AplusContentApiClient
Overrides AplusContentApi.constructor
- Defined in client.ts:79

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

createContentDocument

createContentDocument(
requestParameters: AplusContentApiCreateContentDocumentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PostContentDocumentResponse, any>>
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: AplusContentApiCreateContentDocumentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PostContentDocumentResponse, any>>
Throws
Memberof
AplusContentApi
Inherited from AplusContentApi.createContentDocument
- Defined in api-model/api/aplus-content-api.ts:1037

getContentDocument

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

listContentDocumentAsinRelations

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

postContentDocumentApprovalSubmission

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

postContentDocumentAsinRelations

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

postContentDocumentSuspendSubmission

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

searchContentDocuments

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

searchContentPublishRecords

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

updateContentDocument

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

validateContentDocumentAsinRelations

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

Class AplusContentApiClient

Export

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AplusContentApiClient

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

createContentDocument

Parameters

Returns Promise<AxiosResponse<PostContentDocumentResponse, any>>

Throws

Memberof

getContentDocument

Parameters

Returns Promise<AxiosResponse<GetContentDocumentResponse, any>>

Throws

Memberof

listContentDocumentAsinRelations

Parameters

Returns Promise<AxiosResponse<ListContentDocumentAsinRelationsResponse, any>>

Throws

Memberof

postContentDocumentApprovalSubmission

Parameters

Returns Promise<AxiosResponse<AplusResponse, any>>

Throws

Memberof

postContentDocumentAsinRelations

Parameters

Returns Promise<AxiosResponse<AplusResponse, any>>

Throws

Memberof

postContentDocumentSuspendSubmission

Parameters

Returns Promise<AxiosResponse<AplusResponse, any>>

Throws

Memberof

searchContentDocuments

Parameters

Returns Promise<AxiosResponse<SearchContentDocumentsResponse, any>>

Throws

Memberof

searchContentPublishRecords

Parameters

Returns Promise<AxiosResponse<SearchContentPublishRecordsResponse, any>>

Throws

Memberof

updateContentDocument

Parameters

Returns Promise<AxiosResponse<PostContentDocumentResponse, any>>

Throws

Memberof

validateContentDocumentAsinRelations

Parameters

Returns Promise<AxiosResponse<ValidateContentDocumentAsinRelationsResponse, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration