@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,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 { ItemReviewTrends } from './item-review-trends';
14
+ /**
15
+ * The response for the `getItemReviewTrends` operation.
16
+ * @export
17
+ * @interface ItemReviewTrendsResponse
18
+ */
19
+ export interface ItemReviewTrendsResponse {
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 ItemReviewTrendsResponse
24
+ */
25
+ 'asin': string;
26
+ /**
27
+ * The product title of the requested ASIN.
28
+ * @type {string}
29
+ * @memberof ItemReviewTrendsResponse
30
+ */
31
+ 'itemName': string;
32
+ /**
33
+ * The requested marketplace id.
34
+ * @type {string}
35
+ * @memberof ItemReviewTrendsResponse
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 ItemReviewTrendsResponse
42
+ */
43
+ 'countryCode': string;
44
+ /**
45
+ *
46
+ * @type {DateRange}
47
+ * @memberof ItemReviewTrendsResponse
48
+ */
49
+ 'dateRange': DateRange;
50
+ /**
51
+ *
52
+ * @type {ItemReviewTrends}
53
+ * @memberof ItemReviewTrendsResponse
54
+ */
55
+ 'reviewTrends': ItemReviewTrends;
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 { ItemReviewTrend } from './item-review-trend';
13
+ /**
14
+ * The 10 most positive and most negative review topics for all items in a browse node.
15
+ * @export
16
+ * @interface ItemReviewTrends
17
+ */
18
+ export interface ItemReviewTrends {
19
+ /**
20
+ * A list of the most positive review topics. The percentage of reviews that contain the topic determines the topic\'s 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<ItemReviewTrend>}
22
+ * @memberof ItemReviewTrends
23
+ */
24
+ 'positiveTopics'?: Array<ItemReviewTrend>;
25
+ /**
26
+ * A list of the most negative review topics. The percentage of reviews that contain the topic determines the topic\'s 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<ItemReviewTrend>}
28
+ * @memberof ItemReviewTrends
29
+ */
30
+ 'negativeTopics'?: Array<ItemReviewTrend>;
31
+ }
@@ -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
+ * Error response returned when the request is unsuccessful.
14
+ * @export
15
+ * @interface ModelError
16
+ */
17
+ export interface ModelError {
18
+ /**
19
+ * An error code that identifies the type of error that occurred.
20
+ * @type {string}
21
+ * @memberof ModelError
22
+ */
23
+ 'code': string;
24
+ /**
25
+ * A message that describes the error condition.
26
+ * @type {string}
27
+ * @memberof ModelError
28
+ */
29
+ 'message': string;
30
+ /**
31
+ * Additional details that can help the caller understand or fix the issue.
32
+ * @type {string}
33
+ * @memberof ModelError
34
+ */
35
+ 'details'?: string;
36
+ }
@@ -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 item review trend metrics.
14
+ * @export
15
+ * @interface ReviewTrendMetrics
16
+ */
17
+ export interface ReviewTrendMetrics {
18
+ /**
19
+ * The percentage of reviews that mention the topic.
20
+ * @type {number}
21
+ * @memberof ReviewTrendMetrics
22
+ */
23
+ 'occurrencePercentage': number;
24
+ }
@@ -0,0 +1,6 @@
1
+ import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
2
+ import { CustomerFeedbackApi } from './api-model';
3
+ export declare const clientRateLimits: RateLimit[];
4
+ export declare class CustomerFeedbackApiClient extends CustomerFeedbackApi {
5
+ constructor(configuration: ClientConfiguration);
6
+ }
@@ -0,0 +1,3 @@
1
+ export * from './client';
2
+ export * from './api-model/api';
3
+ export * from './api-model/models';
package/package.json ADDED
@@ -0,0 +1,44 @@
1
+ {
2
+ "name": "@sp-api-sdk/customer-feedback-api-2024-06-01",
3
+ "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
+ "description": "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.",
5
+ "version": "1.1.0",
6
+ "main": "dist/cjs/index.js",
7
+ "module": "dist/es/index.js",
8
+ "types": "dist/types/index.d.ts",
9
+ "license": "MIT",
10
+ "publishConfig": {
11
+ "access": "public"
12
+ },
13
+ "directories": {
14
+ "lib": "dist"
15
+ },
16
+ "files": [
17
+ "dist/**/*.js",
18
+ "dist/**/*.d.ts"
19
+ ],
20
+ "dependencies": {
21
+ "@sp-api-sdk/common": "2.1.15",
22
+ "axios": "^1.10.0"
23
+ },
24
+ "repository": {
25
+ "type": "git",
26
+ "url": "https://github.com/bizon/selling-partner-api-sdk.git",
27
+ "directory": "clients/customer-feedback-api-2024-06-01"
28
+ },
29
+ "bugs": {
30
+ "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
31
+ },
32
+ "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/customer-feedback-api-2024-06-01",
33
+ "keywords": [
34
+ "amazon",
35
+ "bizon",
36
+ "marketplace web services",
37
+ "mws",
38
+ "selling partner api",
39
+ "sp api",
40
+ "sp sdk",
41
+ "customer feedback api"
42
+ ],
43
+ "gitHead": "b36600f33d62a2b6c3a9035968a93bc83e9838a9"
44
+ }