@sp-api-sdk/customer-feedback-api-2024-06-01 1.1.0 → 1.1.2

package/dist/types/api-model/models/browse-node-review-topic.d.ts

@@ -13,32 +13,19 @@ import type { BrowseNodeReviewTopicMetrics } from './browse-node-review-topic-me
 import type { BrowseNodeSubtopic } from './browse-node-subtopic';
 /**
  * The browse node review topic.
- * @export
- * @interface BrowseNodeReviewTopic
  */
 export interface BrowseNodeReviewTopic {
     /**
      * The name browse node review topic.
-     * @type {string}
-     * @memberof BrowseNodeReviewTopic
      */
     'topic': string;
-    /**
-     *
-     * @type {BrowseNodeReviewTopicMetrics}
-     * @memberof BrowseNodeReviewTopic
-     */
     'browseNodeMetrics': BrowseNodeReviewTopicMetrics;
     /**
      * A list of up to three snippets from reviews that contain the topic. This value is `null` if there aren\'t enough review snippets for the topic.
-     * @type {Array<string>}
-     * @memberof BrowseNodeReviewTopic
      */
     'reviewSnippets'?: Array<string>;
     /**
      * A list of the five subtopics that occur most frequently. This value is `null` if there are no subtopics.
-     * @type {Array<BrowseNodeSubtopic>}
-     * @memberof BrowseNodeReviewTopic
      */
     'subtopics'?: Array<BrowseNodeSubtopic>;
 }

package/dist/types/api-model/models/browse-node-review-topics-response.d.ts

@@ -13,44 +13,24 @@ import type { BrowseNodeReviewTopics } from './browse-node-review-topics';
 import type { DateRange } from './date-range';
 /**
  * The response for the `getBrowseNodeReviewTopics` operation.
- * @export
- * @interface BrowseNodeReviewTopicsResponse
  */
 export interface BrowseNodeReviewTopicsResponse {
     /**
      * The requested browse node id. A browse node id is the unique identifier of a given browse node.
-     * @type {string}
-     * @memberof BrowseNodeReviewTopicsResponse
      */
     'browseNodeId': string;
     /**
      * The display name of the requested browse node id. The display name of the browse node as visible on the Amazon retail website.
-     * @type {string}
-     * @memberof BrowseNodeReviewTopicsResponse
      */
     'displayName': string;
     /**
      * The requested marketplace id.
-     * @type {string}
-     * @memberof BrowseNodeReviewTopicsResponse
      */
     'marketplaceId': string;
     /**
      * The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
-     * @type {string}
-     * @memberof BrowseNodeReviewTopicsResponse
      */
     'countryCode': string;
-    /**
-     *
-     * @type {DateRange}
-     * @memberof BrowseNodeReviewTopicsResponse
-     */
     'dateRange': DateRange;
-    /**
-     *
-     * @type {BrowseNodeReviewTopics}
-     * @memberof BrowseNodeReviewTopicsResponse
-     */
     'topics': BrowseNodeReviewTopics;
 }

package/dist/types/api-model/models/browse-node-review-topics.d.ts

@@ -12,20 +12,14 @@
 import type { BrowseNodeReviewTopic } from './browse-node-review-topic';
 /**
  * The 10 most positive and most negative review topics for all items in a browse node.
- * @export
- * @interface BrowseNodeReviewTopics
  */
 export interface BrowseNodeReviewTopics {
     /**
      * A list of the most positive review topics. When the `sortBy` query parameter is set to `MENTIONS`, the number of reviews of items within the requested browse node that mention the topic determine the topic\'s placement in the list. When `sortBy` is set to `STAR_RATING_IMPACT`, the effect that the topic has on the star rating of items within the requested browse node determine placement in the list. This value is `null` if there are not enough positive reviews for the requested browse node.  **Max length:** 10
-     * @type {Array<BrowseNodeReviewTopic>}
-     * @memberof BrowseNodeReviewTopics
      */
     'positiveTopics'?: Array<BrowseNodeReviewTopic>;
     /**
      * A list of the most negative review topics. When the `sortBy` query parameter is set to `MENTIONS`, the number of reviews of items within the requested browse node that mention the topic determine the topic\'s placement in the list. When `sortBy` is set to `STAR_RATING_IMPACT`, the effect that the topic has on the star rating of items within the requested browse node determine placement in the list. This value is `null` if there are not enough negative reviews for the requested browse node.  **Max length:** 10
-     * @type {Array<BrowseNodeReviewTopic>}
-     * @memberof BrowseNodeReviewTopics
      */
     'negativeTopics'?: Array<BrowseNodeReviewTopic>;
 }

package/dist/types/api-model/models/browse-node-review-trend-metrics.d.ts

@@ -12,14 +12,7 @@
 import type { BrowseNodeAllOccurrence } from './browse-node-all-occurrence';
 /**
  * The browse node review topic metrics.
- * @export
- * @interface BrowseNodeReviewTrendMetrics
  */
 export interface BrowseNodeReviewTrendMetrics {
-    /**
-     *
-     * @type {BrowseNodeAllOccurrence}
-     * @memberof BrowseNodeReviewTrendMetrics
-     */
     'occurrencePercentage': BrowseNodeAllOccurrence;
 }

package/dist/types/api-model/models/browse-node-review-trend-point.d.ts

@@ -13,20 +13,8 @@ import type { BrowseNodeReviewTrendMetrics } from './browse-node-review-trend-me
 import type { DateRange } from './date-range';
 /**
  * The browse node\'s review metrics for a certain month.
- * @export
- * @interface BrowseNodeReviewTrendPoint
  */
 export interface BrowseNodeReviewTrendPoint {
-    /**
-     *
-     * @type {DateRange}
-     * @memberof BrowseNodeReviewTrendPoint
-     */
     'dateRange': DateRange;
-    /**
-     *
-     * @type {BrowseNodeReviewTrendMetrics}
-     * @memberof BrowseNodeReviewTrendPoint
-     */
     'browseNodeMetrics': BrowseNodeReviewTrendMetrics;
 }

package/dist/types/api-model/models/browse-node-review-trend.d.ts

@@ -12,20 +12,14 @@
 import type { BrowseNodeReviewTrendPoint } from './browse-node-review-trend-point';
 /**
  * The trend of review topic metrics for all items in the requested browse node.
- * @export
- * @interface BrowseNodeReviewTrend
  */
 export interface BrowseNodeReviewTrend {
     /**
      * The name of the topic.
-     * @type {string}
-     * @memberof BrowseNodeReviewTrend
      */
     'topic': string;
     /**
      * The browse node\'s review trend metrics for the past six months.
-     * @type {Array<BrowseNodeReviewTrendPoint>}
-     * @memberof BrowseNodeReviewTrend
      */
     'trendMetrics': Array<BrowseNodeReviewTrendPoint>;
 }

package/dist/types/api-model/models/browse-node-review-trends-response.d.ts

@@ -13,44 +13,24 @@ import type { BrowseNodeReviewTrends } from './browse-node-review-trends';
 import type { DateRange } from './date-range';
 /**
  * The response for the `getBrowseNodeReviewTrends` operation.
- * @export
- * @interface BrowseNodeReviewTrendsResponse
  */
 export interface BrowseNodeReviewTrendsResponse {
     /**
      * The requested browse node id. A browse node id is the unique identifier of a given browse node.
-     * @type {string}
-     * @memberof BrowseNodeReviewTrendsResponse
      */
     'browseNodeId': string;
     /**
      * The display name of the requested browse node id. The display name of the browse node as visible on the Amazon retail website.
-     * @type {string}
-     * @memberof BrowseNodeReviewTrendsResponse
      */
     'displayName': string;
     /**
      * The requested marketplace id.
-     * @type {string}
-     * @memberof BrowseNodeReviewTrendsResponse
      */
     'marketplaceId': string;
     /**
      * The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
-     * @type {string}
-     * @memberof BrowseNodeReviewTrendsResponse
      */
     'countryCode': string;
-    /**
-     *
-     * @type {DateRange}
-     * @memberof BrowseNodeReviewTrendsResponse
-     */
     'dateRange': DateRange;
-    /**
-     *
-     * @type {BrowseNodeReviewTrends}
-     * @memberof BrowseNodeReviewTrendsResponse
-     */
     'reviewTrends': BrowseNodeReviewTrends;
 }

package/dist/types/api-model/models/browse-node-review-trends.d.ts

@@ -12,20 +12,14 @@
 import type { BrowseNodeReviewTrend } from './browse-node-review-trend';
 /**
  * The 10 most positive and most negative review topics for all items in a browse node.
- * @export
- * @interface BrowseNodeReviewTrends
  */
 export interface BrowseNodeReviewTrends {
     /**
      * The trends of the most positive review topics. The percentage of reviews that contain the topic across all products in the requested browse node determine the topic\'s placement in the list. This value is `null` if there aren\'t enough positive reviews for the requested browse node.  **Max length:** 10
-     * @type {Array<BrowseNodeReviewTrend>}
-     * @memberof BrowseNodeReviewTrends
      */
     'positiveTopics'?: Array<BrowseNodeReviewTrend>;
     /**
      * The trends of the most negative review topics. The percentage of reviews that contain the topic across all products in the requested browse node determine the topic\'s placement in the list. This value is `null` if there aren\'t enough positive reviews for the requested browse node.  **Max length:** 10
-     * @type {Array<BrowseNodeReviewTrend>}
-     * @memberof BrowseNodeReviewTrends
      */
     'negativeTopics'?: Array<BrowseNodeReviewTrend>;
 }

package/dist/types/api-model/models/browse-node-star-rating-impact.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * The effects of a topic on a browse node\'s star rating.
- * @export
- * @interface BrowseNodeStarRatingImpact
  */
 export interface BrowseNodeStarRatingImpact {
     /**
      * The effect of the topic on the star rating for all products in this browse node. This value can be positive or negative.
-     * @type {number}
-     * @memberof BrowseNodeStarRatingImpact
      */
     'allProducts': number;
 }

package/dist/types/api-model/models/browse-node-subtopic.d.ts

@@ -12,26 +12,15 @@
 import type { BrowseNodeReviewSubtopicMetrics } from './browse-node-review-subtopic-metrics';
 /**
  * The browse node review subtopic.
- * @export
- * @interface BrowseNodeSubtopic
  */
 export interface BrowseNodeSubtopic {
     /**
      * The name of the browse node review subtopic.
-     * @type {string}
-     * @memberof BrowseNodeSubtopic
      */
     'subtopic': string;
-    /**
-     *
-     * @type {BrowseNodeReviewSubtopicMetrics}
-     * @memberof BrowseNodeSubtopic
-     */
     'metrics': BrowseNodeReviewSubtopicMetrics;
     /**
      * A list of up to three snippets from reviews that contain the topic. This value is `null` if there aren\'t enough review snippets for the subtopic.
-     * @type {Array<string>}
-     * @memberof BrowseNodeSubtopic
      */
     'reviewSnippets'?: Array<string>;
 }

package/dist/types/api-model/models/browse-node-trend-metrics.d.ts

@@ -12,14 +12,7 @@
 import type { BrowseNodeOccurrence } from './browse-node-occurrence';
 /**
  * A single browse node review or return trend metric.
- * @export
- * @interface BrowseNodeTrendMetrics
  */
 export interface BrowseNodeTrendMetrics {
-    /**
-     *
-     * @type {BrowseNodeOccurrence}
-     * @memberof BrowseNodeTrendMetrics
-     */
     'occurrencePercentage': BrowseNodeOccurrence;
 }

package/dist/types/api-model/models/child-asin-mention-metrics.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * The child ASIN review topic mention metrics.
- * @export
- * @interface ChildAsinMentionMetrics
  */
 export interface ChildAsinMentionMetrics {
     /**
      * The child ASIN of the requested item.
-     * @type {string}
-     * @memberof ChildAsinMentionMetrics
      */
     'asin': string;
     /**
      * The number of times reviews of the child ASIN mention the topic.
-     * @type {number}
-     * @memberof ChildAsinMentionMetrics
      */
     'numberOfMentions': number;
 }

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

@@ -12,20 +12,8 @@
 import type { ChildAsinMentionMetrics } from './child-asin-mention-metrics';
 /**
  * The review topic metrics for other child ASINs that have the same parent ASIN. This value is `null` if there isn\'t any child ASIN metric data.
- * @export
- * @interface ChildAsinMetrics
  */
 export interface ChildAsinMetrics {
-    /**
-     *
-     * @type {ChildAsinMentionMetrics}
-     * @memberof ChildAsinMetrics
-     */
     'mostMentions'?: ChildAsinMentionMetrics;
-    /**
-     *
-     * @type {ChildAsinMentionMetrics}
-     * @memberof ChildAsinMetrics
-     */
     'leastMentions'?: ChildAsinMentionMetrics;
 }

package/dist/types/api-model/models/date-range.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * A date range.
- * @export
- * @interface DateRange
  */
 export interface DateRange {
     /**
      * The start date of the date range in ISO-8601 date/time format.
-     * @type {string}
-     * @memberof DateRange
      */
     'startDate': string;
     /**
      * The end date of the date range in ISO-8601 date/time format.
-     * @type {string}
-     * @memberof DateRange
      */
     'endDate': string;
 }

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

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

package/dist/types/api-model/models/item-review-browse-node-metrics.d.ts

@@ -13,20 +13,8 @@ import type { BrowseNodeOccurrence } from './browse-node-occurrence';
 import type { BrowseNodeStarRatingImpact } from './browse-node-star-rating-impact';
 /**
  * The browse node review topic metrics.
- * @export
- * @interface ItemReviewBrowseNodeMetrics
  */
 export interface ItemReviewBrowseNodeMetrics {
-    /**
-     *
-     * @type {BrowseNodeOccurrence}
-     * @memberof ItemReviewBrowseNodeMetrics
-     */
     'occurrencePercentage'?: BrowseNodeOccurrence;
-    /**
-     *
-     * @type {BrowseNodeStarRatingImpact}
-     * @memberof ItemReviewBrowseNodeMetrics
-     */
     'starRatingImpact'?: BrowseNodeStarRatingImpact;
 }

package/dist/types/api-model/models/item-review-subtopic-metrics.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * The item review subtopic metrics.
- * @export
- * @interface ItemReviewSubtopicMetrics
  */
 export interface ItemReviewSubtopicMetrics {
     /**
      * The number of times that reviews mention the subtopic.
-     * @type {number}
-     * @memberof ItemReviewSubtopicMetrics
      */
     'numberOfMentions': number;
     /**
      * The percentage of reviews that mention the subtopic.
-     * @type {number}
-     * @memberof ItemReviewSubtopicMetrics
      */
     'occurrencePercentage': number;
 }

package/dist/types/api-model/models/item-review-subtopic.d.ts

@@ -12,26 +12,15 @@
 import type { ItemReviewSubtopicMetrics } from './item-review-subtopic-metrics';
 /**
  * Details of the subtopic for an item review topic.
- * @export
- * @interface ItemReviewSubtopic
  */
 export interface ItemReviewSubtopic {
     /**
      * The name of the subtopic.
-     * @type {string}
-     * @memberof ItemReviewSubtopic
      */
     'subtopic': string;
-    /**
-     *
-     * @type {ItemReviewSubtopicMetrics}
-     * @memberof ItemReviewSubtopic
-     */
     'metrics': ItemReviewSubtopicMetrics;
     /**
      * A list of up to three snippets from reviews that contain the subtopic. This value is `null` if there aren\'t enough review snippets for the subtopic.
-     * @type {Array<string>}
-     * @memberof ItemReviewSubtopic
      */
     'reviewSnippets'?: Array<string>;
 }

package/dist/types/api-model/models/item-review-topic-metrics.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * The item review topic metrics.
- * @export
- * @interface ItemReviewTopicMetrics
  */
 export interface ItemReviewTopicMetrics {
     /**
      * The number of times that reviews mention the topic. This value is `null` if reviews do not mention the topic frequently enough.
-     * @type {number}
-     * @memberof ItemReviewTopicMetrics
      */
     'numberOfMentions'?: number;
     /**
      * The percentage of customer reviews that mention the topic. This value is `null` if reviews do not mention the topic frequently enough.
-     * @type {number}
-     * @memberof ItemReviewTopicMetrics
      */
     'occurrencePercentage'?: number;
     /**
      * The effect of the topic on the star rating of the ASIN. This value can be positive or negative. This value is `null` if the topic does\'t affect the star rating of the ASIN.
-     * @type {number}
-     * @memberof ItemReviewTopicMetrics
      */
     'starRatingImpact'?: number;
 }

package/dist/types/api-model/models/item-review-topic.d.ts

@@ -15,50 +15,22 @@ import type { ItemReviewSubtopic } from './item-review-subtopic';
 import type { ItemReviewTopicMetrics } from './item-review-topic-metrics';
 /**
  * Details of item review topic.
- * @export
- * @interface ItemReviewTopic
  */
 export interface ItemReviewTopic {
     /**
      * The name of the item review topic.
-     * @type {string}
-     * @memberof ItemReviewTopic
      */
     'topic': string;
-    /**
-     *
-     * @type {ItemReviewTopicMetrics}
-     * @memberof ItemReviewTopic
-     */
     'asinMetrics': ItemReviewTopicMetrics;
-    /**
-     *
-     * @type {ItemReviewTopicMetrics}
-     * @memberof ItemReviewTopic
-     */
     'parentAsinMetrics'?: ItemReviewTopicMetrics;
-    /**
-     *
-     * @type {ItemReviewBrowseNodeMetrics}
-     * @memberof ItemReviewTopic
-     */
     'browseNodeMetrics'?: ItemReviewBrowseNodeMetrics;
-    /**
-     *
-     * @type {ChildAsinMetrics}
-     * @memberof ItemReviewTopic
-     */
     'childAsinMetrics'?: ChildAsinMetrics;
     /**
      * A list of up to three snippets from reviews that contain the topic. This value is `null` if there aren\'t enough review snippets for the topic.
-     * @type {Array<string>}
-     * @memberof ItemReviewTopic
      */
     'reviewSnippets'?: Array<string>;
     /**
      * A list of up to five top subtopics for the topic. The percentage of customer reviews that mention the subtopic determine the topic\'s placement in the list. This value is `null` if there are no subtopics.
-     * @type {Array<ItemReviewSubtopic>}
-     * @memberof ItemReviewTopic
      */
     'subtopics'?: Array<ItemReviewSubtopic>;
 }

package/dist/types/api-model/models/item-review-topics-response.d.ts

@@ -13,44 +13,24 @@ import type { DateRange } from './date-range';
 import type { ItemReviewTopics } from './item-review-topics';
 /**
  * The response for the `getItemReviewTopics` operation.
- * @export
- * @interface ItemReviewTopicsResponse
  */
 export interface ItemReviewTopicsResponse {
     /**
      * The requested ASIN. The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
-     * @type {string}
-     * @memberof ItemReviewTopicsResponse
      */
     'asin': string;
     /**
      * The product title of the requested ASIN.
-     * @type {string}
-     * @memberof ItemReviewTopicsResponse
      */
     'itemName': string;
     /**
      * The requested marketplace id.
-     * @type {string}
-     * @memberof ItemReviewTopicsResponse
      */
     'marketplaceId': string;
     /**
      * The two digit country code of the requested marketplace id, in ISO 3166-1 alpha-2 format.
-     * @type {string}
-     * @memberof ItemReviewTopicsResponse
      */
     'countryCode': string;
-    /**
-     *
-     * @type {DateRange}
-     * @memberof ItemReviewTopicsResponse
-     */
     'dateRange': DateRange;
-    /**
-     *
-     * @type {ItemReviewTopics}
-     * @memberof ItemReviewTopicsResponse
-     */
     'topics': ItemReviewTopics;
 }

package/dist/types/api-model/models/item-review-topics.d.ts

@@ -12,20 +12,14 @@
 import type { ItemReviewTopic } from './item-review-topic';
 /**
  * The top 10 positive and negative item review topics.
- * @export
- * @interface ItemReviewTopics
  */
 export interface ItemReviewTopics {
     /**
      * A list of the most positive review topics. When the `sortBy` query parameter is set to `MENTIONS`, the number of reviews that mention the topic determines the topic\'s placement in the list. When `sortBy` is set to `STAR_RATING_IMPACT`, the effect that the topic has on the star rating of the item determines placement in the list. This value is `null` if there are not enough positive reviews for the specified ASIN.  **Max length:** 10
-     * @type {Array<ItemReviewTopic>}
-     * @memberof ItemReviewTopics
      */
     'positiveTopics'?: Array<ItemReviewTopic>;
     /**
      * A list of the most negative review topics. When the `sortBy` query parameter is set to `MENTIONS`, the number of reviews that mention the topic determines the topic\'s placement in the list. When `sortBy` is set to `STAR_RATING_IMPACT`, the effect that the topic has on the star rating of the item determines placement in the list. This value is `null` if there are not enough negative reviews for the specified ASIN.  **Max length:** 10
-     * @type {Array<ItemReviewTopic>}
-     * @memberof ItemReviewTopics
      */
     'negativeTopics'?: Array<ItemReviewTopic>;
 }

package/dist/types/api-model/models/item-review-trend-point.d.ts

@@ -14,32 +14,10 @@ import type { DateRange } from './date-range';
 import type { ReviewTrendMetrics } from './review-trend-metrics';
 /**
  * The review metrics for a certain month.
- * @export
- * @interface ItemReviewTrendPoint
  */
 export interface ItemReviewTrendPoint {
-    /**
-     *
-     * @type {DateRange}
-     * @memberof ItemReviewTrendPoint
-     */
     'dateRange': DateRange;
-    /**
-     *
-     * @type {ReviewTrendMetrics}
-     * @memberof ItemReviewTrendPoint
-     */
     'asinMetrics': ReviewTrendMetrics;
-    /**
-     *
-     * @type {ReviewTrendMetrics}
-     * @memberof ItemReviewTrendPoint
-     */
     'parentAsinMetrics'?: ReviewTrendMetrics;
-    /**
-     *
-     * @type {BrowseNodeTrendMetrics}
-     * @memberof ItemReviewTrendPoint
-     */
     'browseNodeMetrics'?: BrowseNodeTrendMetrics;
 }

package/dist/types/api-model/models/item-review-trend.d.ts

@@ -12,20 +12,14 @@
 import type { ItemReviewTrendPoint } from './item-review-trend-point';
 /**
  * The trend of review topic metrics for the requested item.
- * @export
- * @interface ItemReviewTrend
  */
 export interface ItemReviewTrend {
     /**
      * The name of the item review topic.
-     * @type {string}
-     * @memberof ItemReviewTrend
      */
     'topic': string;
     /**
      * The item\'s review trend metrics for the past six months.
-     * @type {Array<ItemReviewTrendPoint>}
-     * @memberof ItemReviewTrend
      */
     'trendMetrics': Array<ItemReviewTrendPoint>;
 }