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

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.
Files changed (147) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +99 -0
  3. package/dist/cjs/api-model/api/customer-feedback-api.js +539 -0
  4. package/dist/cjs/api-model/api.js +30 -0
  5. package/dist/cjs/api-model/base.js +71 -0
  6. package/dist/cjs/api-model/common.js +145 -0
  7. package/dist/cjs/api-model/configuration.js +104 -0
  8. package/dist/cjs/api-model/index.js +32 -0
  9. package/dist/cjs/api-model/models/browse-node-all-occurrence.js +15 -0
  10. package/dist/cjs/api-model/models/browse-node-all-star-rating-impact.js +15 -0
  11. package/dist/cjs/api-model/models/browse-node-occurrence.js +15 -0
  12. package/dist/cjs/api-model/models/browse-node-response.js +15 -0
  13. package/dist/cjs/api-model/models/browse-node-return-topics-response.js +15 -0
  14. package/dist/cjs/api-model/models/browse-node-return-topics.js +15 -0
  15. package/dist/cjs/api-model/models/browse-node-return-trend-point.js +15 -0
  16. package/dist/cjs/api-model/models/browse-node-return-trend.js +15 -0
  17. package/dist/cjs/api-model/models/browse-node-return-trends-response.js +15 -0
  18. package/dist/cjs/api-model/models/browse-node-review-subtopic-metrics.js +15 -0
  19. package/dist/cjs/api-model/models/browse-node-review-topic-metrics.js +15 -0
  20. package/dist/cjs/api-model/models/browse-node-review-topic.js +15 -0
  21. package/dist/cjs/api-model/models/browse-node-review-topics-response.js +15 -0
  22. package/dist/cjs/api-model/models/browse-node-review-topics.js +15 -0
  23. package/dist/cjs/api-model/models/browse-node-review-trend-metrics.js +15 -0
  24. package/dist/cjs/api-model/models/browse-node-review-trend-point.js +15 -0
  25. package/dist/cjs/api-model/models/browse-node-review-trend.js +15 -0
  26. package/dist/cjs/api-model/models/browse-node-review-trends-response.js +15 -0
  27. package/dist/cjs/api-model/models/browse-node-review-trends.js +15 -0
  28. package/dist/cjs/api-model/models/browse-node-star-rating-impact.js +15 -0
  29. package/dist/cjs/api-model/models/browse-node-subtopic.js +15 -0
  30. package/dist/cjs/api-model/models/browse-node-trend-metrics.js +15 -0
  31. package/dist/cjs/api-model/models/child-asin-mention-metrics.js +15 -0
  32. package/dist/cjs/api-model/models/child-asin-metrics.js +15 -0
  33. package/dist/cjs/api-model/models/date-range.js +15 -0
  34. package/dist/cjs/api-model/models/error-list.js +15 -0
  35. package/dist/cjs/api-model/models/index.js +55 -0
  36. package/dist/cjs/api-model/models/item-review-browse-node-metrics.js +15 -0
  37. package/dist/cjs/api-model/models/item-review-subtopic-metrics.js +15 -0
  38. package/dist/cjs/api-model/models/item-review-subtopic.js +15 -0
  39. package/dist/cjs/api-model/models/item-review-topic-metrics.js +15 -0
  40. package/dist/cjs/api-model/models/item-review-topic.js +15 -0
  41. package/dist/cjs/api-model/models/item-review-topics-response.js +15 -0
  42. package/dist/cjs/api-model/models/item-review-topics.js +15 -0
  43. package/dist/cjs/api-model/models/item-review-trend-point.js +15 -0
  44. package/dist/cjs/api-model/models/item-review-trend.js +15 -0
  45. package/dist/cjs/api-model/models/item-review-trends-response.js +15 -0
  46. package/dist/cjs/api-model/models/item-review-trends.js +15 -0
  47. package/dist/cjs/api-model/models/model-error.js +15 -0
  48. package/dist/cjs/api-model/models/review-trend-metrics.js +15 -0
  49. package/dist/cjs/client.js +13 -0
  50. package/dist/cjs/index.js +19 -0
  51. package/dist/es/api-model/api/customer-feedback-api.js +529 -0
  52. package/dist/es/api-model/api.js +14 -0
  53. package/dist/es/api-model/base.js +63 -0
  54. package/dist/es/api-model/common.js +133 -0
  55. package/dist/es/api-model/configuration.js +100 -0
  56. package/dist/es/api-model/index.js +16 -0
  57. package/dist/es/api-model/models/browse-node-all-occurrence.js +14 -0
  58. package/dist/es/api-model/models/browse-node-all-star-rating-impact.js +14 -0
  59. package/dist/es/api-model/models/browse-node-occurrence.js +14 -0
  60. package/dist/es/api-model/models/browse-node-response.js +14 -0
  61. package/dist/es/api-model/models/browse-node-return-topics-response.js +14 -0
  62. package/dist/es/api-model/models/browse-node-return-topics.js +14 -0
  63. package/dist/es/api-model/models/browse-node-return-trend-point.js +14 -0
  64. package/dist/es/api-model/models/browse-node-return-trend.js +14 -0
  65. package/dist/es/api-model/models/browse-node-return-trends-response.js +14 -0
  66. package/dist/es/api-model/models/browse-node-review-subtopic-metrics.js +14 -0
  67. package/dist/es/api-model/models/browse-node-review-topic-metrics.js +14 -0
  68. package/dist/es/api-model/models/browse-node-review-topic.js +14 -0
  69. package/dist/es/api-model/models/browse-node-review-topics-response.js +14 -0
  70. package/dist/es/api-model/models/browse-node-review-topics.js +14 -0
  71. package/dist/es/api-model/models/browse-node-review-trend-metrics.js +14 -0
  72. package/dist/es/api-model/models/browse-node-review-trend-point.js +14 -0
  73. package/dist/es/api-model/models/browse-node-review-trend.js +14 -0
  74. package/dist/es/api-model/models/browse-node-review-trends-response.js +14 -0
  75. package/dist/es/api-model/models/browse-node-review-trends.js +14 -0
  76. package/dist/es/api-model/models/browse-node-star-rating-impact.js +14 -0
  77. package/dist/es/api-model/models/browse-node-subtopic.js +14 -0
  78. package/dist/es/api-model/models/browse-node-trend-metrics.js +14 -0
  79. package/dist/es/api-model/models/child-asin-mention-metrics.js +14 -0
  80. package/dist/es/api-model/models/child-asin-metrics.js +14 -0
  81. package/dist/es/api-model/models/date-range.js +14 -0
  82. package/dist/es/api-model/models/error-list.js +14 -0
  83. package/dist/es/api-model/models/index.js +39 -0
  84. package/dist/es/api-model/models/item-review-browse-node-metrics.js +14 -0
  85. package/dist/es/api-model/models/item-review-subtopic-metrics.js +14 -0
  86. package/dist/es/api-model/models/item-review-subtopic.js +14 -0
  87. package/dist/es/api-model/models/item-review-topic-metrics.js +14 -0
  88. package/dist/es/api-model/models/item-review-topic.js +14 -0
  89. package/dist/es/api-model/models/item-review-topics-response.js +14 -0
  90. package/dist/es/api-model/models/item-review-topics.js +14 -0
  91. package/dist/es/api-model/models/item-review-trend-point.js +14 -0
  92. package/dist/es/api-model/models/item-review-trend.js +14 -0
  93. package/dist/es/api-model/models/item-review-trends-response.js +14 -0
  94. package/dist/es/api-model/models/item-review-trends.js +14 -0
  95. package/dist/es/api-model/models/model-error.js +14 -0
  96. package/dist/es/api-model/models/review-trend-metrics.js +14 -0
  97. package/dist/es/client.js +9 -0
  98. package/dist/es/index.js +3 -0
  99. package/dist/types/api-model/api/customer-feedback-api.d.ts +414 -0
  100. package/dist/types/api-model/api.d.ts +12 -0
  101. package/dist/types/api-model/base.d.ts +66 -0
  102. package/dist/types/api-model/common.d.ts +65 -0
  103. package/dist/types/api-model/configuration.d.ts +91 -0
  104. package/dist/types/api-model/index.d.ts +14 -0
  105. package/dist/types/api-model/models/browse-node-all-occurrence.d.ts +30 -0
  106. package/dist/types/api-model/models/browse-node-all-star-rating-impact.d.ts +30 -0
  107. package/dist/types/api-model/models/browse-node-occurrence.d.ts +24 -0
  108. package/dist/types/api-model/models/browse-node-response.d.ts +30 -0
  109. package/dist/types/api-model/models/browse-node-return-topics-response.d.ts +56 -0
  110. package/dist/types/api-model/models/browse-node-return-topics.d.ts +31 -0
  111. package/dist/types/api-model/models/browse-node-return-trend-point.d.ts +32 -0
  112. package/dist/types/api-model/models/browse-node-return-trend.d.ts +31 -0
  113. package/dist/types/api-model/models/browse-node-return-trends-response.d.ts +56 -0
  114. package/dist/types/api-model/models/browse-node-review-subtopic-metrics.d.ts +24 -0
  115. package/dist/types/api-model/models/browse-node-review-topic-metrics.d.ts +32 -0
  116. package/dist/types/api-model/models/browse-node-review-topic.d.ts +44 -0
  117. package/dist/types/api-model/models/browse-node-review-topics-response.d.ts +56 -0
  118. package/dist/types/api-model/models/browse-node-review-topics.d.ts +31 -0
  119. package/dist/types/api-model/models/browse-node-review-trend-metrics.d.ts +25 -0
  120. package/dist/types/api-model/models/browse-node-review-trend-point.d.ts +32 -0
  121. package/dist/types/api-model/models/browse-node-review-trend.d.ts +31 -0
  122. package/dist/types/api-model/models/browse-node-review-trends-response.d.ts +56 -0
  123. package/dist/types/api-model/models/browse-node-review-trends.d.ts +31 -0
  124. package/dist/types/api-model/models/browse-node-star-rating-impact.d.ts +24 -0
  125. package/dist/types/api-model/models/browse-node-subtopic.d.ts +37 -0
  126. package/dist/types/api-model/models/browse-node-trend-metrics.d.ts +25 -0
  127. package/dist/types/api-model/models/child-asin-mention-metrics.d.ts +30 -0
  128. package/dist/types/api-model/models/child-asin-metrics.d.ts +31 -0
  129. package/dist/types/api-model/models/date-range.d.ts +30 -0
  130. package/dist/types/api-model/models/error-list.d.ts +24 -0
  131. package/dist/types/api-model/models/index.d.ts +39 -0
  132. package/dist/types/api-model/models/item-review-browse-node-metrics.d.ts +32 -0
  133. package/dist/types/api-model/models/item-review-subtopic-metrics.d.ts +30 -0
  134. package/dist/types/api-model/models/item-review-subtopic.d.ts +37 -0
  135. package/dist/types/api-model/models/item-review-topic-metrics.d.ts +36 -0
  136. package/dist/types/api-model/models/item-review-topic.d.ts +64 -0
  137. package/dist/types/api-model/models/item-review-topics-response.d.ts +56 -0
  138. package/dist/types/api-model/models/item-review-topics.d.ts +31 -0
  139. package/dist/types/api-model/models/item-review-trend-point.d.ts +45 -0
  140. package/dist/types/api-model/models/item-review-trend.d.ts +31 -0
  141. package/dist/types/api-model/models/item-review-trends-response.d.ts +56 -0
  142. package/dist/types/api-model/models/item-review-trends.d.ts +31 -0
  143. package/dist/types/api-model/models/model-error.d.ts +36 -0
  144. package/dist/types/api-model/models/review-trend-metrics.d.ts +24 -0
  145. package/dist/types/client.d.ts +6 -0
  146. package/dist/types/index.d.ts +3 -0
  147. package/package.json +44 -0
@@ -0,0 +1,31 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ import type { BrowseNodeReviewTrend } from './browse-node-review-trend';
13
+ /**
14
+ * The 10 most positive and most negative review topics for all items in a browse node.
15
+ * @export
16
+ * @interface BrowseNodeReviewTrends
17
+ */
18
+ export interface BrowseNodeReviewTrends {
19
+ /**
20
+ * 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
21
+ * @type {Array<BrowseNodeReviewTrend>}
22
+ * @memberof BrowseNodeReviewTrends
23
+ */
24
+ 'positiveTopics'?: Array<BrowseNodeReviewTrend>;
25
+ /**
26
+ * 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
27
+ * @type {Array<BrowseNodeReviewTrend>}
28
+ * @memberof BrowseNodeReviewTrends
29
+ */
30
+ 'negativeTopics'?: Array<BrowseNodeReviewTrend>;
31
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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 effects of a topic on a browse node\'s star rating.
14
+ * @export
15
+ * @interface BrowseNodeStarRatingImpact
16
+ */
17
+ export interface BrowseNodeStarRatingImpact {
18
+ /**
19
+ * The effect of the topic on the star rating for all products in this browse node. This value can be positive or negative.
20
+ * @type {number}
21
+ * @memberof BrowseNodeStarRatingImpact
22
+ */
23
+ 'allProducts': number;
24
+ }
@@ -0,0 +1,37 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ import type { BrowseNodeReviewSubtopicMetrics } from './browse-node-review-subtopic-metrics';
13
+ /**
14
+ * The browse node review subtopic.
15
+ * @export
16
+ * @interface BrowseNodeSubtopic
17
+ */
18
+ export interface BrowseNodeSubtopic {
19
+ /**
20
+ * The name of the browse node review subtopic.
21
+ * @type {string}
22
+ * @memberof BrowseNodeSubtopic
23
+ */
24
+ 'subtopic': string;
25
+ /**
26
+ *
27
+ * @type {BrowseNodeReviewSubtopicMetrics}
28
+ * @memberof BrowseNodeSubtopic
29
+ */
30
+ 'metrics': BrowseNodeReviewSubtopicMetrics;
31
+ /**
32
+ * 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.
33
+ * @type {Array<string>}
34
+ * @memberof BrowseNodeSubtopic
35
+ */
36
+ 'reviewSnippets'?: Array<string>;
37
+ }
@@ -0,0 +1,25 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ import type { BrowseNodeOccurrence } from './browse-node-occurrence';
13
+ /**
14
+ * A single browse node review or return trend metric.
15
+ * @export
16
+ * @interface BrowseNodeTrendMetrics
17
+ */
18
+ export interface BrowseNodeTrendMetrics {
19
+ /**
20
+ *
21
+ * @type {BrowseNodeOccurrence}
22
+ * @memberof BrowseNodeTrendMetrics
23
+ */
24
+ 'occurrencePercentage': BrowseNodeOccurrence;
25
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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 child ASIN review topic mention metrics.
14
+ * @export
15
+ * @interface ChildAsinMentionMetrics
16
+ */
17
+ export interface ChildAsinMentionMetrics {
18
+ /**
19
+ * The child ASIN of the requested item.
20
+ * @type {string}
21
+ * @memberof ChildAsinMentionMetrics
22
+ */
23
+ 'asin': string;
24
+ /**
25
+ * The number of times reviews of the child ASIN mention the topic.
26
+ * @type {number}
27
+ * @memberof ChildAsinMentionMetrics
28
+ */
29
+ 'numberOfMentions': number;
30
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ import type { ChildAsinMentionMetrics } from './child-asin-mention-metrics';
13
+ /**
14
+ * 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.
15
+ * @export
16
+ * @interface ChildAsinMetrics
17
+ */
18
+ export interface ChildAsinMetrics {
19
+ /**
20
+ *
21
+ * @type {ChildAsinMentionMetrics}
22
+ * @memberof ChildAsinMetrics
23
+ */
24
+ 'mostMentions'?: ChildAsinMentionMetrics;
25
+ /**
26
+ *
27
+ * @type {ChildAsinMentionMetrics}
28
+ * @memberof ChildAsinMetrics
29
+ */
30
+ 'leastMentions'?: ChildAsinMentionMetrics;
31
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ * A date range.
14
+ * @export
15
+ * @interface DateRange
16
+ */
17
+ export interface DateRange {
18
+ /**
19
+ * The start date of the date range in ISO-8601 date/time format.
20
+ * @type {string}
21
+ * @memberof DateRange
22
+ */
23
+ 'startDate': string;
24
+ /**
25
+ * The end date of the date range in ISO-8601 date/time format.
26
+ * @type {string}
27
+ * @memberof DateRange
28
+ */
29
+ 'endDate': string;
30
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ * A list of error responses returned when a request is unsuccessful.
14
+ * @export
15
+ * @interface ErrorList
16
+ */
17
+ export interface ErrorList {
18
+ /**
19
+ * List of errors.
20
+ * @type {Array<Error>}
21
+ * @memberof ErrorList
22
+ */
23
+ 'errors': Array<Error>;
24
+ }
@@ -0,0 +1,39 @@
1
+ export * from './browse-node-all-occurrence';
2
+ export * from './browse-node-all-star-rating-impact';
3
+ export * from './browse-node-occurrence';
4
+ export * from './browse-node-response';
5
+ export * from './browse-node-return-topics';
6
+ export * from './browse-node-return-topics-response';
7
+ export * from './browse-node-return-trend';
8
+ export * from './browse-node-return-trend-point';
9
+ export * from './browse-node-return-trends-response';
10
+ export * from './browse-node-review-subtopic-metrics';
11
+ export * from './browse-node-review-topic';
12
+ export * from './browse-node-review-topic-metrics';
13
+ export * from './browse-node-review-topics';
14
+ export * from './browse-node-review-topics-response';
15
+ export * from './browse-node-review-trend';
16
+ export * from './browse-node-review-trend-metrics';
17
+ export * from './browse-node-review-trend-point';
18
+ export * from './browse-node-review-trends';
19
+ export * from './browse-node-review-trends-response';
20
+ export * from './browse-node-star-rating-impact';
21
+ export * from './browse-node-subtopic';
22
+ export * from './browse-node-trend-metrics';
23
+ export * from './child-asin-mention-metrics';
24
+ export * from './child-asin-metrics';
25
+ export * from './date-range';
26
+ export * from './error-list';
27
+ export * from './item-review-browse-node-metrics';
28
+ export * from './item-review-subtopic';
29
+ export * from './item-review-subtopic-metrics';
30
+ export * from './item-review-topic';
31
+ export * from './item-review-topic-metrics';
32
+ export * from './item-review-topics';
33
+ export * from './item-review-topics-response';
34
+ export * from './item-review-trend';
35
+ export * from './item-review-trend-point';
36
+ export * from './item-review-trends';
37
+ export * from './item-review-trends-response';
38
+ export * from './model-error';
39
+ export * from './review-trend-metrics';
@@ -0,0 +1,32 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ import type { BrowseNodeOccurrence } from './browse-node-occurrence';
13
+ import type { BrowseNodeStarRatingImpact } from './browse-node-star-rating-impact';
14
+ /**
15
+ * The browse node review topic metrics.
16
+ * @export
17
+ * @interface ItemReviewBrowseNodeMetrics
18
+ */
19
+ export interface ItemReviewBrowseNodeMetrics {
20
+ /**
21
+ *
22
+ * @type {BrowseNodeOccurrence}
23
+ * @memberof ItemReviewBrowseNodeMetrics
24
+ */
25
+ 'occurrencePercentage'?: BrowseNodeOccurrence;
26
+ /**
27
+ *
28
+ * @type {BrowseNodeStarRatingImpact}
29
+ * @memberof ItemReviewBrowseNodeMetrics
30
+ */
31
+ 'starRatingImpact'?: BrowseNodeStarRatingImpact;
32
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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 item review subtopic metrics.
14
+ * @export
15
+ * @interface ItemReviewSubtopicMetrics
16
+ */
17
+ export interface ItemReviewSubtopicMetrics {
18
+ /**
19
+ * The number of times that reviews mention the subtopic.
20
+ * @type {number}
21
+ * @memberof ItemReviewSubtopicMetrics
22
+ */
23
+ 'numberOfMentions': number;
24
+ /**
25
+ * The percentage of reviews that mention the subtopic.
26
+ * @type {number}
27
+ * @memberof ItemReviewSubtopicMetrics
28
+ */
29
+ 'occurrencePercentage': number;
30
+ }
@@ -0,0 +1,37 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ import type { ItemReviewSubtopicMetrics } from './item-review-subtopic-metrics';
13
+ /**
14
+ * Details of the subtopic for an item review topic.
15
+ * @export
16
+ * @interface ItemReviewSubtopic
17
+ */
18
+ export interface ItemReviewSubtopic {
19
+ /**
20
+ * The name of the subtopic.
21
+ * @type {string}
22
+ * @memberof ItemReviewSubtopic
23
+ */
24
+ 'subtopic': string;
25
+ /**
26
+ *
27
+ * @type {ItemReviewSubtopicMetrics}
28
+ * @memberof ItemReviewSubtopic
29
+ */
30
+ 'metrics': ItemReviewSubtopicMetrics;
31
+ /**
32
+ * 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.
33
+ * @type {Array<string>}
34
+ * @memberof ItemReviewSubtopic
35
+ */
36
+ 'reviewSnippets'?: Array<string>;
37
+ }
@@ -0,0 +1,36 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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 item review topic metrics.
14
+ * @export
15
+ * @interface ItemReviewTopicMetrics
16
+ */
17
+ export interface ItemReviewTopicMetrics {
18
+ /**
19
+ * The number of times that reviews mention the topic. This value is `null` if reviews do not mention the topic frequently enough.
20
+ * @type {number}
21
+ * @memberof ItemReviewTopicMetrics
22
+ */
23
+ 'numberOfMentions'?: number;
24
+ /**
25
+ * The percentage of customer reviews that mention the topic. This value is `null` if reviews do not mention the topic frequently enough.
26
+ * @type {number}
27
+ * @memberof ItemReviewTopicMetrics
28
+ */
29
+ 'occurrencePercentage'?: number;
30
+ /**
31
+ * 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.
32
+ * @type {number}
33
+ * @memberof ItemReviewTopicMetrics
34
+ */
35
+ 'starRatingImpact'?: number;
36
+ }
@@ -0,0 +1,64 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ import type { ChildAsinMetrics } from './child-asin-metrics';
13
+ import type { ItemReviewBrowseNodeMetrics } from './item-review-browse-node-metrics';
14
+ import type { ItemReviewSubtopic } from './item-review-subtopic';
15
+ import type { ItemReviewTopicMetrics } from './item-review-topic-metrics';
16
+ /**
17
+ * Details of item review topic.
18
+ * @export
19
+ * @interface ItemReviewTopic
20
+ */
21
+ export interface ItemReviewTopic {
22
+ /**
23
+ * The name of the item review topic.
24
+ * @type {string}
25
+ * @memberof ItemReviewTopic
26
+ */
27
+ 'topic': string;
28
+ /**
29
+ *
30
+ * @type {ItemReviewTopicMetrics}
31
+ * @memberof ItemReviewTopic
32
+ */
33
+ 'asinMetrics': ItemReviewTopicMetrics;
34
+ /**
35
+ *
36
+ * @type {ItemReviewTopicMetrics}
37
+ * @memberof ItemReviewTopic
38
+ */
39
+ 'parentAsinMetrics'?: ItemReviewTopicMetrics;
40
+ /**
41
+ *
42
+ * @type {ItemReviewBrowseNodeMetrics}
43
+ * @memberof ItemReviewTopic
44
+ */
45
+ 'browseNodeMetrics'?: ItemReviewBrowseNodeMetrics;
46
+ /**
47
+ *
48
+ * @type {ChildAsinMetrics}
49
+ * @memberof ItemReviewTopic
50
+ */
51
+ 'childAsinMetrics'?: ChildAsinMetrics;
52
+ /**
53
+ * 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.
54
+ * @type {Array<string>}
55
+ * @memberof ItemReviewTopic
56
+ */
57
+ 'reviewSnippets'?: Array<string>;
58
+ /**
59
+ * 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.
60
+ * @type {Array<ItemReviewSubtopic>}
61
+ * @memberof ItemReviewTopic
62
+ */
63
+ 'subtopics'?: Array<ItemReviewSubtopic>;
64
+ }
@@ -0,0 +1,56 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ import type { DateRange } from './date-range';
13
+ import type { ItemReviewTopics } from './item-review-topics';
14
+ /**
15
+ * The response for the `getItemReviewTopics` operation.
16
+ * @export
17
+ * @interface ItemReviewTopicsResponse
18
+ */
19
+ export interface ItemReviewTopicsResponse {
20
+ /**
21
+ * The requested ASIN. The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
22
+ * @type {string}
23
+ * @memberof ItemReviewTopicsResponse
24
+ */
25
+ 'asin': string;
26
+ /**
27
+ * The product title of the requested ASIN.
28
+ * @type {string}
29
+ * @memberof ItemReviewTopicsResponse
30
+ */
31
+ 'itemName': string;
32
+ /**
33
+ * The requested marketplace id.
34
+ * @type {string}
35
+ * @memberof ItemReviewTopicsResponse
36
+ */
37
+ 'marketplaceId': string;
38
+ /**
39
+ * The two digit country code of the requested marketplace id, in ISO 3166-1 alpha-2 format.
40
+ * @type {string}
41
+ * @memberof ItemReviewTopicsResponse
42
+ */
43
+ 'countryCode': string;
44
+ /**
45
+ *
46
+ * @type {DateRange}
47
+ * @memberof ItemReviewTopicsResponse
48
+ */
49
+ 'dateRange': DateRange;
50
+ /**
51
+ *
52
+ * @type {ItemReviewTopics}
53
+ * @memberof ItemReviewTopicsResponse
54
+ */
55
+ 'topics': ItemReviewTopics;
56
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ import type { ItemReviewTopic } from './item-review-topic';
13
+ /**
14
+ * The top 10 positive and negative item review topics.
15
+ * @export
16
+ * @interface ItemReviewTopics
17
+ */
18
+ export interface ItemReviewTopics {
19
+ /**
20
+ * 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
21
+ * @type {Array<ItemReviewTopic>}
22
+ * @memberof ItemReviewTopics
23
+ */
24
+ 'positiveTopics'?: Array<ItemReviewTopic>;
25
+ /**
26
+ * 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
27
+ * @type {Array<ItemReviewTopic>}
28
+ * @memberof ItemReviewTopics
29
+ */
30
+ 'negativeTopics'?: Array<ItemReviewTopic>;
31
+ }
@@ -0,0 +1,45 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ import type { BrowseNodeTrendMetrics } from './browse-node-trend-metrics';
13
+ import type { DateRange } from './date-range';
14
+ import type { ReviewTrendMetrics } from './review-trend-metrics';
15
+ /**
16
+ * The review metrics for a certain month.
17
+ * @export
18
+ * @interface ItemReviewTrendPoint
19
+ */
20
+ export interface ItemReviewTrendPoint {
21
+ /**
22
+ *
23
+ * @type {DateRange}
24
+ * @memberof ItemReviewTrendPoint
25
+ */
26
+ 'dateRange': DateRange;
27
+ /**
28
+ *
29
+ * @type {ReviewTrendMetrics}
30
+ * @memberof ItemReviewTrendPoint
31
+ */
32
+ 'asinMetrics': ReviewTrendMetrics;
33
+ /**
34
+ *
35
+ * @type {ReviewTrendMetrics}
36
+ * @memberof ItemReviewTrendPoint
37
+ */
38
+ 'parentAsinMetrics'?: ReviewTrendMetrics;
39
+ /**
40
+ *
41
+ * @type {BrowseNodeTrendMetrics}
42
+ * @memberof ItemReviewTrendPoint
43
+ */
44
+ 'browseNodeMetrics'?: BrowseNodeTrendMetrics;
45
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * The Selling Partner API for CustomerFeedback
3
+ * The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-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
+ import type { ItemReviewTrendPoint } from './item-review-trend-point';
13
+ /**
14
+ * The trend of review topic metrics for the requested item.
15
+ * @export
16
+ * @interface ItemReviewTrend
17
+ */
18
+ export interface ItemReviewTrend {
19
+ /**
20
+ * The name of the item review topic.
21
+ * @type {string}
22
+ * @memberof ItemReviewTrend
23
+ */
24
+ 'topic': string;
25
+ /**
26
+ * The item\'s review trend metrics for the past six months.
27
+ * @type {Array<ItemReviewTrendPoint>}
28
+ * @memberof ItemReviewTrend
29
+ */
30
+ 'trendMetrics': Array<ItemReviewTrendPoint>;
31
+ }