@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,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 browse node review occurrence metrics.
14
+ * @export
15
+ * @interface BrowseNodeAllOccurrence
16
+ */
17
+ export interface BrowseNodeAllOccurrence {
18
+ /**
19
+ * The percentage of reviews of the top 25 percent of products in the browse node that mention the topic.
20
+ * @type {number}
21
+ * @memberof BrowseNodeAllOccurrence
22
+ */
23
+ 'topTwentyFivePercentProducts': number;
24
+ /**
25
+ * The percentage of reviews of products in the browse node that mention the topic.
26
+ * @type {number}
27
+ * @memberof BrowseNodeAllOccurrence
28
+ */
29
+ 'allProducts': number;
30
+ }
@@ -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 effects of a topic on the star ratings in a browse node.
14
+ * @export
15
+ * @interface BrowseNodeAllStarRatingImpact
16
+ */
17
+ export interface BrowseNodeAllStarRatingImpact {
18
+ /**
19
+ * The effect of the topic on the star rating of the top 25 percent of products in the browse node. This value can be positive or negative.
20
+ * @type {number}
21
+ * @memberof BrowseNodeAllStarRatingImpact
22
+ */
23
+ 'topTwentyFivePercentProducts': number;
24
+ /**
25
+ * The effect of the topic on the star rating of all products in the browse node. This value can be positive or negative.
26
+ * @type {number}
27
+ * @memberof BrowseNodeAllStarRatingImpact
28
+ */
29
+ 'allProducts': number;
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
+ * The browse node review trend occurrence metrics.
14
+ * @export
15
+ * @interface BrowseNodeOccurrence
16
+ */
17
+ export interface BrowseNodeOccurrence {
18
+ /**
19
+ * The percentage of reviews of products in the browse node that mention a topic.
20
+ * @type {number}
21
+ * @memberof BrowseNodeOccurrence
22
+ */
23
+ 'allProducts': number;
24
+ }
@@ -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 response for the `getItemBrowseNode` operation.
14
+ * @export
15
+ * @interface BrowseNodeResponse
16
+ */
17
+ export interface BrowseNodeResponse {
18
+ /**
19
+ * A browse node id is the unique identifier of a given browse node. A browse node is a location in a browse tree that is used for navigation, product classification, and website content.
20
+ * @type {string}
21
+ * @memberof BrowseNodeResponse
22
+ */
23
+ 'browseNodeId': string;
24
+ /**
25
+ * The display name of the browse node as visible on the Amazon retail website.
26
+ * @type {string}
27
+ * @memberof BrowseNodeResponse
28
+ */
29
+ 'displayName': string;
30
+ }
@@ -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 { BrowseNodeReturnTopics } from './browse-node-return-topics';
13
+ import type { DateRange } from './date-range';
14
+ /**
15
+ * The response for the `getBrowseNodeReturnTopics` operation.
16
+ * @export
17
+ * @interface BrowseNodeReturnTopicsResponse
18
+ */
19
+ export interface BrowseNodeReturnTopicsResponse {
20
+ /**
21
+ * The requested browse node id. A browse node id is the unique identifier of a given browse node.
22
+ * @type {string}
23
+ * @memberof BrowseNodeReturnTopicsResponse
24
+ */
25
+ 'browseNodeId': string;
26
+ /**
27
+ * The display name of the browse node, as visible on the Amazon retail website.
28
+ * @type {string}
29
+ * @memberof BrowseNodeReturnTopicsResponse
30
+ */
31
+ 'displayName': string;
32
+ /**
33
+ * The requested marketplace id.
34
+ * @type {string}
35
+ * @memberof BrowseNodeReturnTopicsResponse
36
+ */
37
+ 'marketplaceId': string;
38
+ /**
39
+ * The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
40
+ * @type {string}
41
+ * @memberof BrowseNodeReturnTopicsResponse
42
+ */
43
+ 'countryCode': string;
44
+ /**
45
+ *
46
+ * @type {DateRange}
47
+ * @memberof BrowseNodeReturnTopicsResponse
48
+ */
49
+ 'dateRange': DateRange;
50
+ /**
51
+ * The list of browse node return topics.
52
+ * @type {Array<BrowseNodeReturnTopics>}
53
+ * @memberof BrowseNodeReturnTopicsResponse
54
+ */
55
+ 'topics': Array<BrowseNodeReturnTopics>;
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 { BrowseNodeTrendMetrics } from './browse-node-trend-metrics';
13
+ /**
14
+ * Topics from returns for all items in a browse node.
15
+ * @export
16
+ * @interface BrowseNodeReturnTopics
17
+ */
18
+ export interface BrowseNodeReturnTopics {
19
+ /**
20
+ * The name of the return feedback topic .
21
+ * @type {string}
22
+ * @memberof BrowseNodeReturnTopics
23
+ */
24
+ 'topic': string;
25
+ /**
26
+ *
27
+ * @type {BrowseNodeTrendMetrics}
28
+ * @memberof BrowseNodeReturnTopics
29
+ */
30
+ 'browseNodeMetrics': BrowseNodeTrendMetrics;
31
+ }
@@ -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 { BrowseNodeTrendMetrics } from './browse-node-trend-metrics';
13
+ import type { DateRange } from './date-range';
14
+ /**
15
+ * The return metrics for a certain month.
16
+ * @export
17
+ * @interface BrowseNodeReturnTrendPoint
18
+ */
19
+ export interface BrowseNodeReturnTrendPoint {
20
+ /**
21
+ *
22
+ * @type {DateRange}
23
+ * @memberof BrowseNodeReturnTrendPoint
24
+ */
25
+ 'dateRange': DateRange;
26
+ /**
27
+ *
28
+ * @type {BrowseNodeTrendMetrics}
29
+ * @memberof BrowseNodeReturnTrendPoint
30
+ */
31
+ 'browseNodeMetrics': BrowseNodeTrendMetrics;
32
+ }
@@ -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 { BrowseNodeReturnTrendPoint } from './browse-node-return-trend-point';
13
+ /**
14
+ * The trend of return topic metrics for all items in the requested browse node.
15
+ * @export
16
+ * @interface BrowseNodeReturnTrend
17
+ */
18
+ export interface BrowseNodeReturnTrend {
19
+ /**
20
+ * The name of the topic.
21
+ * @type {string}
22
+ * @memberof BrowseNodeReturnTrend
23
+ */
24
+ 'topic': string;
25
+ /**
26
+ * The browse node return trend metrics.
27
+ * @type {Array<BrowseNodeReturnTrendPoint>}
28
+ * @memberof BrowseNodeReturnTrend
29
+ */
30
+ 'trendMetrics': Array<BrowseNodeReturnTrendPoint>;
31
+ }
@@ -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 { BrowseNodeReturnTrend } from './browse-node-return-trend';
13
+ import type { DateRange } from './date-range';
14
+ /**
15
+ * The response for the `getBrowseNodeReturnTrends` operation.
16
+ * @export
17
+ * @interface BrowseNodeReturnTrendsResponse
18
+ */
19
+ export interface BrowseNodeReturnTrendsResponse {
20
+ /**
21
+ * The requested browse node id. A browse node id is the unique identifier of a given browse node.
22
+ * @type {string}
23
+ * @memberof BrowseNodeReturnTrendsResponse
24
+ */
25
+ 'browseNodeId': string;
26
+ /**
27
+ * The display name of the browse node, as visible on the Amazon retail website.
28
+ * @type {string}
29
+ * @memberof BrowseNodeReturnTrendsResponse
30
+ */
31
+ 'displayName': string;
32
+ /**
33
+ * The requested marketplace id.
34
+ * @type {string}
35
+ * @memberof BrowseNodeReturnTrendsResponse
36
+ */
37
+ 'marketplaceId': string;
38
+ /**
39
+ * The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
40
+ * @type {string}
41
+ * @memberof BrowseNodeReturnTrendsResponse
42
+ */
43
+ 'countryCode': string;
44
+ /**
45
+ *
46
+ * @type {DateRange}
47
+ * @memberof BrowseNodeReturnTrendsResponse
48
+ */
49
+ 'dateRange': DateRange;
50
+ /**
51
+ * The browse node return trends.
52
+ * @type {Array<BrowseNodeReturnTrend>}
53
+ * @memberof BrowseNodeReturnTrendsResponse
54
+ */
55
+ 'returnTrends': Array<BrowseNodeReturnTrend>;
56
+ }
@@ -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 browse node review subtopic metrics.
14
+ * @export
15
+ * @interface BrowseNodeReviewSubtopicMetrics
16
+ */
17
+ export interface BrowseNodeReviewSubtopicMetrics {
18
+ /**
19
+ * The percentage of reviews that mention the subtopic.
20
+ * @type {number}
21
+ * @memberof BrowseNodeReviewSubtopicMetrics
22
+ */
23
+ 'occurrencePercentage': number;
24
+ }
@@ -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 { BrowseNodeAllOccurrence } from './browse-node-all-occurrence';
13
+ import type { BrowseNodeAllStarRatingImpact } from './browse-node-all-star-rating-impact';
14
+ /**
15
+ * The browse node review topic metrics.
16
+ * @export
17
+ * @interface BrowseNodeReviewTopicMetrics
18
+ */
19
+ export interface BrowseNodeReviewTopicMetrics {
20
+ /**
21
+ *
22
+ * @type {BrowseNodeAllOccurrence}
23
+ * @memberof BrowseNodeReviewTopicMetrics
24
+ */
25
+ 'occurrencePercentage'?: BrowseNodeAllOccurrence;
26
+ /**
27
+ *
28
+ * @type {BrowseNodeAllStarRatingImpact}
29
+ * @memberof BrowseNodeReviewTopicMetrics
30
+ */
31
+ 'starRatingImpact'?: BrowseNodeAllStarRatingImpact;
32
+ }
@@ -0,0 +1,44 @@
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 { BrowseNodeReviewTopicMetrics } from './browse-node-review-topic-metrics';
13
+ import type { BrowseNodeSubtopic } from './browse-node-subtopic';
14
+ /**
15
+ * The browse node review topic.
16
+ * @export
17
+ * @interface BrowseNodeReviewTopic
18
+ */
19
+ export interface BrowseNodeReviewTopic {
20
+ /**
21
+ * The name browse node review topic.
22
+ * @type {string}
23
+ * @memberof BrowseNodeReviewTopic
24
+ */
25
+ 'topic': string;
26
+ /**
27
+ *
28
+ * @type {BrowseNodeReviewTopicMetrics}
29
+ * @memberof BrowseNodeReviewTopic
30
+ */
31
+ 'browseNodeMetrics': BrowseNodeReviewTopicMetrics;
32
+ /**
33
+ * 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.
34
+ * @type {Array<string>}
35
+ * @memberof BrowseNodeReviewTopic
36
+ */
37
+ 'reviewSnippets'?: Array<string>;
38
+ /**
39
+ * A list of the five subtopics that occur most frequently. This value is `null` if there are no subtopics.
40
+ * @type {Array<BrowseNodeSubtopic>}
41
+ * @memberof BrowseNodeReviewTopic
42
+ */
43
+ 'subtopics'?: Array<BrowseNodeSubtopic>;
44
+ }
@@ -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 { BrowseNodeReviewTopics } from './browse-node-review-topics';
13
+ import type { DateRange } from './date-range';
14
+ /**
15
+ * The response for the `getBrowseNodeReviewTopics` operation.
16
+ * @export
17
+ * @interface BrowseNodeReviewTopicsResponse
18
+ */
19
+ export interface BrowseNodeReviewTopicsResponse {
20
+ /**
21
+ * The requested browse node id. A browse node id is the unique identifier of a given browse node.
22
+ * @type {string}
23
+ * @memberof BrowseNodeReviewTopicsResponse
24
+ */
25
+ 'browseNodeId': string;
26
+ /**
27
+ * The display name of the requested browse node id. The display name of the browse node as visible on the Amazon retail website.
28
+ * @type {string}
29
+ * @memberof BrowseNodeReviewTopicsResponse
30
+ */
31
+ 'displayName': string;
32
+ /**
33
+ * The requested marketplace id.
34
+ * @type {string}
35
+ * @memberof BrowseNodeReviewTopicsResponse
36
+ */
37
+ 'marketplaceId': string;
38
+ /**
39
+ * The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
40
+ * @type {string}
41
+ * @memberof BrowseNodeReviewTopicsResponse
42
+ */
43
+ 'countryCode': string;
44
+ /**
45
+ *
46
+ * @type {DateRange}
47
+ * @memberof BrowseNodeReviewTopicsResponse
48
+ */
49
+ 'dateRange': DateRange;
50
+ /**
51
+ *
52
+ * @type {BrowseNodeReviewTopics}
53
+ * @memberof BrowseNodeReviewTopicsResponse
54
+ */
55
+ 'topics': BrowseNodeReviewTopics;
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 { BrowseNodeReviewTopic } from './browse-node-review-topic';
13
+ /**
14
+ * The 10 most positive and most negative review topics for all items in a browse node.
15
+ * @export
16
+ * @interface BrowseNodeReviewTopics
17
+ */
18
+ export interface BrowseNodeReviewTopics {
19
+ /**
20
+ * 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
21
+ * @type {Array<BrowseNodeReviewTopic>}
22
+ * @memberof BrowseNodeReviewTopics
23
+ */
24
+ 'positiveTopics'?: Array<BrowseNodeReviewTopic>;
25
+ /**
26
+ * 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
27
+ * @type {Array<BrowseNodeReviewTopic>}
28
+ * @memberof BrowseNodeReviewTopics
29
+ */
30
+ 'negativeTopics'?: Array<BrowseNodeReviewTopic>;
31
+ }
@@ -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 { BrowseNodeAllOccurrence } from './browse-node-all-occurrence';
13
+ /**
14
+ * The browse node review topic metrics.
15
+ * @export
16
+ * @interface BrowseNodeReviewTrendMetrics
17
+ */
18
+ export interface BrowseNodeReviewTrendMetrics {
19
+ /**
20
+ *
21
+ * @type {BrowseNodeAllOccurrence}
22
+ * @memberof BrowseNodeReviewTrendMetrics
23
+ */
24
+ 'occurrencePercentage': BrowseNodeAllOccurrence;
25
+ }
@@ -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 { BrowseNodeReviewTrendMetrics } from './browse-node-review-trend-metrics';
13
+ import type { DateRange } from './date-range';
14
+ /**
15
+ * The browse node\'s review metrics for a certain month.
16
+ * @export
17
+ * @interface BrowseNodeReviewTrendPoint
18
+ */
19
+ export interface BrowseNodeReviewTrendPoint {
20
+ /**
21
+ *
22
+ * @type {DateRange}
23
+ * @memberof BrowseNodeReviewTrendPoint
24
+ */
25
+ 'dateRange': DateRange;
26
+ /**
27
+ *
28
+ * @type {BrowseNodeReviewTrendMetrics}
29
+ * @memberof BrowseNodeReviewTrendPoint
30
+ */
31
+ 'browseNodeMetrics': BrowseNodeReviewTrendMetrics;
32
+ }
@@ -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 { BrowseNodeReviewTrendPoint } from './browse-node-review-trend-point';
13
+ /**
14
+ * The trend of review topic metrics for all items in the requested browse node.
15
+ * @export
16
+ * @interface BrowseNodeReviewTrend
17
+ */
18
+ export interface BrowseNodeReviewTrend {
19
+ /**
20
+ * The name of the topic.
21
+ * @type {string}
22
+ * @memberof BrowseNodeReviewTrend
23
+ */
24
+ 'topic': string;
25
+ /**
26
+ * The browse node\'s review trend metrics for the past six months.
27
+ * @type {Array<BrowseNodeReviewTrendPoint>}
28
+ * @memberof BrowseNodeReviewTrend
29
+ */
30
+ 'trendMetrics': Array<BrowseNodeReviewTrendPoint>;
31
+ }
@@ -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 { BrowseNodeReviewTrends } from './browse-node-review-trends';
13
+ import type { DateRange } from './date-range';
14
+ /**
15
+ * The response for the `getBrowseNodeReviewTrends` operation.
16
+ * @export
17
+ * @interface BrowseNodeReviewTrendsResponse
18
+ */
19
+ export interface BrowseNodeReviewTrendsResponse {
20
+ /**
21
+ * The requested browse node id. A browse node id is the unique identifier of a given browse node.
22
+ * @type {string}
23
+ * @memberof BrowseNodeReviewTrendsResponse
24
+ */
25
+ 'browseNodeId': string;
26
+ /**
27
+ * The display name of the requested browse node id. The display name of the browse node as visible on the Amazon retail website.
28
+ * @type {string}
29
+ * @memberof BrowseNodeReviewTrendsResponse
30
+ */
31
+ 'displayName': string;
32
+ /**
33
+ * The requested marketplace id.
34
+ * @type {string}
35
+ * @memberof BrowseNodeReviewTrendsResponse
36
+ */
37
+ 'marketplaceId': string;
38
+ /**
39
+ * The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
40
+ * @type {string}
41
+ * @memberof BrowseNodeReviewTrendsResponse
42
+ */
43
+ 'countryCode': string;
44
+ /**
45
+ *
46
+ * @type {DateRange}
47
+ * @memberof BrowseNodeReviewTrendsResponse
48
+ */
49
+ 'dateRange': DateRange;
50
+ /**
51
+ *
52
+ * @type {BrowseNodeReviewTrends}
53
+ * @memberof BrowseNodeReviewTrendsResponse
54
+ */
55
+ 'reviewTrends': BrowseNodeReviewTrends;
56
+ }