@sp-api-sdk/aplus-content-api-2020-11-01 3.1.3 → 3.1.5

package/dist/types/api-model/models/aplus-response.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * The base response data for all A+ Content operations when a request is successful or partially successful. Individual operations can extend this with additional data.
- * @export
- * @interface AplusResponse
  */
 export interface AplusResponse {
     /**
      * A set of messages to the user, such as warnings or comments.
-     * @type {Set<Error>}
-     * @memberof AplusResponse
      */
     'warnings'?: Set<Error>;
 }

package/dist/types/api-model/models/asin-badge.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * A flag that provides additional information about an ASIN. This is contextual and can change depending on the request that generated it.
- * @export
- * @enum {string}
  */
 export declare const AsinBadge: {
     readonly BrandNotEligible: "BRAND_NOT_ELIGIBLE";

package/dist/types/api-model/models/asin-metadata.d.ts

@@ -12,44 +12,30 @@
 import type { AsinBadge } from './asin-badge';
 /**
  * The A+ Content ASIN with additional metadata for content management. If you don\'t include the `includedDataSet` parameter in a call to the `listContentDocumentAsinRelations` operation, the related ASINs are returned without metadata.
- * @export
- * @interface AsinMetadata
  */
 export interface AsinMetadata {
     /**
      * The Amazon Standard Identification Number (ASIN).
-     * @type {string}
-     * @memberof AsinMetadata
      */
     'asin': string;
     /**
      * The set of ASIN badges.
-     * @type {Set<AsinBadge>}
-     * @memberof AsinMetadata
      */
     'badgeSet'?: Set<AsinBadge>;
     /**
      * The Amazon Standard Identification Number (ASIN).
-     * @type {string}
-     * @memberof AsinMetadata
      */
     'parent'?: string;
     /**
      * The title for the ASIN in the Amazon catalog.
-     * @type {string}
-     * @memberof AsinMetadata
      */
     'title'?: string;
     /**
      * The default image for the ASIN in the Amazon catalog.
-     * @type {string}
-     * @memberof AsinMetadata
      */
     'imageUrl'?: string;
     /**
      * A set of content reference keys.
-     * @type {Set<string>}
-     * @memberof AsinMetadata
      */
     'contentReferenceKeySet'?: Set<string>;
 }

package/dist/types/api-model/models/color-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The relative color scheme of your content.
- * @export
- * @enum {string}
  */
 export declare const ColorType: {
     readonly Dark: "DARK";

package/dist/types/api-model/models/content-badge.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * A flag that provides additional information about an A+ Content document.
- * @export
- * @enum {string}
  */
 export declare const ContentBadge: {
     readonly Bulk: "BULK";

package/dist/types/api-model/models/content-document.d.ts

@@ -13,38 +13,23 @@ import type { ContentModule } from './content-module';
 import type { ContentType } from './content-type';
 /**
  * The A+ Content document. This is the enhanced content that is published to product detail pages.
- * @export
- * @interface ContentDocument
  */
 export interface ContentDocument {
     /**
      * The A+ Content document name.
-     * @type {string}
-     * @memberof ContentDocument
      */
     'name': string;
-    /**
-     *
-     * @type {ContentType}
-     * @memberof ContentDocument
-     */
     'contentType': ContentType;
     /**
      * The A+ Content document subtype. This represents a special-purpose type of an A+ Content document. Not every A+ Content document type has a subtype, and subtypes can change at any time.
-     * @type {string}
-     * @memberof ContentDocument
      */
     'contentSubType'?: string;
     /**
      * The IETF language tag, which supports the primary language subtag and one secondary language subtag. The secondary language subtag is usually a regional designation. This doesn\'t support subtags other than the primary and secondary subtags. **Pattern:** ^[a-z]{2,}-[A-Z0-9]{2,}$
-     * @type {string}
-     * @memberof ContentDocument
      */
     'locale': string;
     /**
      * A list of A+ Content modules.
-     * @type {Array<ContentModule>}
-     * @memberof ContentDocument
      */
     'contentModuleList': Array<ContentModule>;
 }

package/dist/types/api-model/models/content-metadata-record.d.ts

@@ -12,20 +12,11 @@
 import type { ContentMetadata } from './content-metadata';
 /**
  * The metadata for an A+ Content document, with additional information for content management.
- * @export
- * @interface ContentMetadataRecord
  */
 export interface ContentMetadataRecord {
     /**
      * A unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
-     * @type {string}
-     * @memberof ContentMetadataRecord
      */
     'contentReferenceKey': string;
-    /**
-     *
-     * @type {ContentMetadata}
-     * @memberof ContentMetadataRecord
-     */
     'contentMetadata': ContentMetadata;
 }

package/dist/types/api-model/models/content-metadata.d.ts

@@ -13,38 +13,23 @@ import type { ContentBadge } from './content-badge';
 import type { ContentStatus } from './content-status';
 /**
  * The A+ Content document\'s metadata.
- * @export
- * @interface ContentMetadata
  */
 export interface ContentMetadata {
     /**
      * The A+ Content document\'s name.
-     * @type {string}
-     * @memberof ContentMetadata
      */
     'name': string;
     /**
      * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
-     * @type {string}
-     * @memberof ContentMetadata
      */
     'marketplaceId': string;
-    /**
-     *
-     * @type {ContentStatus}
-     * @memberof ContentMetadata
-     */
     'status': ContentStatus;
     /**
      * The set of content badges.
-     * @type {Set<ContentBadge>}
-     * @memberof ContentMetadata
      */
     'badgeSet': Set<ContentBadge>;
     /**
      * The approximate age of the A+ Content document and metadata.
-     * @type {string}
-     * @memberof ContentMetadata
      */
     'updateTime': string;
 }

package/dist/types/api-model/models/content-module-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The type of A+ Content module.
- * @export
- * @enum {string}
  */
 export declare const ContentModuleType: {
     readonly StandardCompanyLogo: "STANDARD_COMPANY_LOGO";

package/dist/types/api-model/models/content-module.d.ts

@@ -27,104 +27,22 @@ import type { StandardTextModule } from './standard-text-module';
 import type { StandardThreeImageTextModule } from './standard-three-image-text-module';
 /**
  * An A+ Content module. An A+ Content document is composed of content modules. The `contentModuleType` property selects which content module types to use.
- * @export
- * @interface ContentModule
  */
 export interface ContentModule {
-    /**
-     *
-     * @type {ContentModuleType}
-     * @memberof ContentModule
-     */
     'contentModuleType': ContentModuleType;
-    /**
-     *
-     * @type {StandardCompanyLogoModule}
-     * @memberof ContentModule
-     */
     'standardCompanyLogo'?: StandardCompanyLogoModule;
-    /**
-     *
-     * @type {StandardComparisonTableModule}
-     * @memberof ContentModule
-     */
     'standardComparisonTable'?: StandardComparisonTableModule;
-    /**
-     *
-     * @type {StandardFourImageTextModule}
-     * @memberof ContentModule
-     */
     'standardFourImageText'?: StandardFourImageTextModule;
-    /**
-     *
-     * @type {StandardFourImageTextQuadrantModule}
-     * @memberof ContentModule
-     */
     'standardFourImageTextQuadrant'?: StandardFourImageTextQuadrantModule;
-    /**
-     *
-     * @type {StandardHeaderImageTextModule}
-     * @memberof ContentModule
-     */
     'standardHeaderImageText'?: StandardHeaderImageTextModule;
-    /**
-     *
-     * @type {StandardImageSidebarModule}
-     * @memberof ContentModule
-     */
     'standardImageSidebar'?: StandardImageSidebarModule;
-    /**
-     *
-     * @type {StandardImageTextOverlayModule}
-     * @memberof ContentModule
-     */
     'standardImageTextOverlay'?: StandardImageTextOverlayModule;
-    /**
-     *
-     * @type {StandardMultipleImageTextModule}
-     * @memberof ContentModule
-     */
     'standardMultipleImageText'?: StandardMultipleImageTextModule;
-    /**
-     *
-     * @type {StandardProductDescriptionModule}
-     * @memberof ContentModule
-     */
     'standardProductDescription'?: StandardProductDescriptionModule;
-    /**
-     *
-     * @type {StandardSingleImageHighlightsModule}
-     * @memberof ContentModule
-     */
     'standardSingleImageHighlights'?: StandardSingleImageHighlightsModule;
-    /**
-     *
-     * @type {StandardSingleImageSpecsDetailModule}
-     * @memberof ContentModule
-     */
     'standardSingleImageSpecsDetail'?: StandardSingleImageSpecsDetailModule;
-    /**
-     *
-     * @type {StandardSingleSideImageModule}
-     * @memberof ContentModule
-     */
     'standardSingleSideImage'?: StandardSingleSideImageModule;
-    /**
-     *
-     * @type {StandardTechSpecsModule}
-     * @memberof ContentModule
-     */
     'standardTechSpecs'?: StandardTechSpecsModule;
-    /**
-     *
-     * @type {StandardTextModule}
-     * @memberof ContentModule
-     */
     'standardText'?: StandardTextModule;
-    /**
-     *
-     * @type {StandardThreeImageTextModule}
-     * @memberof ContentModule
-     */
     'standardThreeImageText'?: StandardThreeImageTextModule;
 }

package/dist/types/api-model/models/content-record.d.ts

@@ -13,26 +13,12 @@ import type { ContentDocument } from './content-document';
 import type { ContentMetadata } from './content-metadata';
 /**
  * A content document with additional information for content management.
- * @export
- * @interface ContentRecord
  */
 export interface ContentRecord {
     /**
      * A unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
-     * @type {string}
-     * @memberof ContentRecord
      */
     'contentReferenceKey': string;
-    /**
-     *
-     * @type {ContentMetadata}
-     * @memberof ContentRecord
-     */
     'contentMetadata'?: ContentMetadata;
-    /**
-     *
-     * @type {ContentDocument}
-     * @memberof ContentRecord
-     */
     'contentDocument'?: ContentDocument;
 }

package/dist/types/api-model/models/content-status.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The submission status of the content document.
- * @export
- * @enum {string}
  */
 export declare const ContentStatus: {
     readonly Approved: "APPROVED";

package/dist/types/api-model/models/content-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The A+ Content document type.
- * @export
- * @enum {string}
  */
 export declare const ContentType: {
     readonly Ebc: "EBC";

package/dist/types/api-model/models/decorator-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The type of rich text decorator.
- * @export
- * @enum {string}
  */
 export declare const DecoratorType: {
     readonly ListItem: "LIST_ITEM";

package/dist/types/api-model/models/decorator.d.ts

@@ -12,32 +12,19 @@
 import type { DecoratorType } from './decorator-type';
 /**
  * A decorator that is applied to a content string value in order to create rich text.
- * @export
- * @interface Decorator
  */
 export interface Decorator {
-    /**
-     *
-     * @type {DecoratorType}
-     * @memberof Decorator
-     */
     'type'?: DecoratorType;
     /**
      * The starting value of this decorator within the content string. Use zero (`0`) for the first value.
-     * @type {number}
-     * @memberof Decorator
      */
     'offset'?: number;
     /**
      * The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters.
-     * @type {number}
-     * @memberof Decorator
      */
     'length'?: number;
     /**
      * The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths.
-     * @type {number}
-     * @memberof Decorator
      */
     'depth'?: number;
 }

package/dist/types/api-model/models/error-list.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * The error response that is returned when a request is unsuccessful.
- * @export
- * @interface ErrorList
  */
 export interface ErrorList {
     /**
      * A list of error responses that are returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof ErrorList
      */
     'errors': Array<Error>;
 }

package/dist/types/api-model/models/get-content-document-response-all-of.d.ts

@@ -10,16 +10,6 @@
  * Do not edit the class manually.
  */
 import type { ContentRecord } from './content-record';
-/**
- *
- * @export
- * @interface GetContentDocumentResponseAllOf
- */
 export interface GetContentDocumentResponseAllOf {
-    /**
-     *
-     * @type {ContentRecord}
-     * @memberof GetContentDocumentResponseAllOf
-     */
     'contentRecord': ContentRecord;
 }

package/dist/types/api-model/models/get-content-document-response.d.ts

@@ -13,6 +13,5 @@ import type { AplusResponse } from './aplus-response';
 import type { GetContentDocumentResponseAllOf } from './get-content-document-response-all-of';
 /**
  * @type GetContentDocumentResponse
- * @export
  */
 export type GetContentDocumentResponse = AplusResponse & GetContentDocumentResponseAllOf;

package/dist/types/api-model/models/image-component.d.ts

@@ -12,26 +12,15 @@
 import type { ImageCropSpecification } from './image-crop-specification';
 /**
  * A reference to an image, hosted in the A+ Content media library.
- * @export
- * @interface ImageComponent
  */
 export interface ImageComponent {
     /**
      * This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).
-     * @type {string}
-     * @memberof ImageComponent
      */
     'uploadDestinationId': string;
-    /**
-     *
-     * @type {ImageCropSpecification}
-     * @memberof ImageComponent
-     */
     'imageCropSpecification': ImageCropSpecification;
     /**
      * The alternative text for the image.
-     * @type {string}
-     * @memberof ImageComponent
      */
     'altText': string;
 }

package/dist/types/api-model/models/image-crop-specification.d.ts

@@ -13,20 +13,8 @@ import type { ImageDimensions } from './image-dimensions';
 import type { ImageOffsets } from './image-offsets';
 /**
  * The instructions for optionally cropping an image. If you don\'t want to crop the image, set the dimensions to the original image size. If the image is cropped and you don\'t include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.
- * @export
- * @interface ImageCropSpecification
  */
 export interface ImageCropSpecification {
-    /**
-     *
-     * @type {ImageDimensions}
-     * @memberof ImageCropSpecification
-     */
     'size': ImageDimensions;
-    /**
-     *
-     * @type {ImageOffsets}
-     * @memberof ImageCropSpecification
-     */
     'offset'?: ImageOffsets;
 }

package/dist/types/api-model/models/image-dimensions.d.ts

@@ -12,20 +12,8 @@
 import type { IntegerWithUnits } from './integer-with-units';
 /**
  * The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.
- * @export
- * @interface ImageDimensions
  */
 export interface ImageDimensions {
-    /**
-     *
-     * @type {IntegerWithUnits}
-     * @memberof ImageDimensions
-     */
     'width': IntegerWithUnits;
-    /**
-     *
-     * @type {IntegerWithUnits}
-     * @memberof ImageDimensions
-     */
     'height': IntegerWithUnits;
 }

package/dist/types/api-model/models/image-offsets.d.ts

@@ -12,20 +12,8 @@
 import type { IntegerWithUnits } from './integer-with-units';
 /**
  * The top left corner of the cropped image, specified in the original image\'s coordinate space.
- * @export
- * @interface ImageOffsets
  */
 export interface ImageOffsets {
-    /**
-     *
-     * @type {IntegerWithUnits}
-     * @memberof ImageOffsets
-     */
     'x': IntegerWithUnits;
-    /**
-     *
-     * @type {IntegerWithUnits}
-     * @memberof ImageOffsets
-     */
     'y': IntegerWithUnits;
 }

package/dist/types/api-model/models/integer-with-units.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.
- * @export
- * @interface IntegerWithUnits
  */
 export interface IntegerWithUnits {
     /**
      * The dimension value.
-     * @type {number}
-     * @memberof IntegerWithUnits
      */
     'value': number;
     /**
      * The unit of measurement.
-     * @type {string}
-     * @memberof IntegerWithUnits
      */
     'units': string;
 }

package/dist/types/api-model/models/list-content-document-asin-relations-response-all-of.d.ts

@@ -10,16 +10,9 @@
  * Do not edit the class manually.
  */
 import type { AsinMetadata } from './asin-metadata';
-/**
- *
- * @export
- * @interface ListContentDocumentAsinRelationsResponseAllOf
- */
 export interface ListContentDocumentAsinRelationsResponseAllOf {
     /**
      * The set of ASIN metadata.
-     * @type {Set<AsinMetadata>}
-     * @memberof ListContentDocumentAsinRelationsResponseAllOf
      */
     'asinMetadataSet': Set<AsinMetadata>;
 }

package/dist/types/api-model/models/list-content-document-asin-relations-response.d.ts

@@ -13,6 +13,5 @@ import type { AplusPaginatedResponse } from './aplus-paginated-response';
 import type { ListContentDocumentAsinRelationsResponseAllOf } from './list-content-document-asin-relations-response-all-of';
 /**
  * @type ListContentDocumentAsinRelationsResponse
- * @export
  */
 export type ListContentDocumentAsinRelationsResponse = AplusPaginatedResponse & ListContentDocumentAsinRelationsResponseAllOf;

package/dist/types/api-model/models/model-error.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * The error response that is returned when the request is unsuccessful.
- * @export
- * @interface ModelError
  */
 export interface ModelError {
     /**
      * An error code that identifies the type of error that occurred.
-     * @type {string}
-     * @memberof ModelError
      */
     'code': string;
     /**
      * A message that describes the error condition.
-     * @type {string}
-     * @memberof ModelError
      */
     'message': string;
     /**
      * Additional details that can help the caller understand or fix the issue.
-     * @type {string}
-     * @memberof ModelError
      */
     'details'?: string;
 }

package/dist/types/api-model/models/paragraph-component.d.ts

@@ -12,14 +12,7 @@
 import type { TextComponent } from './text-component';
 /**
  * A list of rich text content that is typically presented in a text box.
- * @export
- * @interface ParagraphComponent
  */
 export interface ParagraphComponent {
-    /**
-     *
-     * @type {Array<TextComponent>}
-     * @memberof ParagraphComponent
-     */
     'textList': Array<TextComponent>;
 }

package/dist/types/api-model/models/plain-text-item.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Plain positional text that is used in collections of brief labels and descriptors.
- * @export
- * @interface PlainTextItem
  */
 export interface PlainTextItem {
     /**
      * The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection.
-     * @type {number}
-     * @memberof PlainTextItem
      */
     'position': number;
     /**
      * The actual plain text.
-     * @type {string}
-     * @memberof PlainTextItem
      */
     'value': string;
 }

package/dist/types/api-model/models/position-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The content\'s relative positioning.
- * @export
- * @enum {string}
  */
 export declare const PositionType: {
     readonly Left: "LEFT";

package/dist/types/api-model/models/post-content-document-approval-submission-response.d.ts

@@ -12,6 +12,5 @@
 import type { AplusResponse } from './aplus-response';
 /**
  * @type PostContentDocumentApprovalSubmissionResponse
- * @export
  */
 export type PostContentDocumentApprovalSubmissionResponse = AplusResponse;