@sp-api-sdk/customer-feedback-api-2024-06-01 1.1.16 → 2.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.
- package/README.md +7 -8
- package/dist/index.cjs +683 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +1202 -0
- package/dist/index.d.ts +1202 -0
- package/dist/index.js +654 -0
- package/dist/index.js.map +1 -0
- package/package.json +26 -12
- package/dist/cjs/api-model/api/customer-feedback-api.js +0 -533
- package/dist/cjs/api-model/api.js +0 -30
- package/dist/cjs/api-model/base.js +0 -52
- package/dist/cjs/api-model/common.js +0 -123
- package/dist/cjs/api-model/configuration.js +0 -98
- package/dist/cjs/api-model/index.js +0 -32
- package/dist/cjs/api-model/models/browse-node-all-occurrence.js +0 -15
- package/dist/cjs/api-model/models/browse-node-all-star-rating-impact.js +0 -15
- package/dist/cjs/api-model/models/browse-node-occurrence.js +0 -15
- package/dist/cjs/api-model/models/browse-node-response.js +0 -15
- package/dist/cjs/api-model/models/browse-node-return-topics-response.js +0 -15
- package/dist/cjs/api-model/models/browse-node-return-topics.js +0 -15
- package/dist/cjs/api-model/models/browse-node-return-trend-point.js +0 -15
- package/dist/cjs/api-model/models/browse-node-return-trend.js +0 -15
- package/dist/cjs/api-model/models/browse-node-return-trends-response.js +0 -15
- package/dist/cjs/api-model/models/browse-node-review-subtopic-metrics.js +0 -15
- package/dist/cjs/api-model/models/browse-node-review-topic-metrics.js +0 -15
- package/dist/cjs/api-model/models/browse-node-review-topic.js +0 -15
- package/dist/cjs/api-model/models/browse-node-review-topics-response.js +0 -15
- package/dist/cjs/api-model/models/browse-node-review-topics.js +0 -15
- package/dist/cjs/api-model/models/browse-node-review-trend-metrics.js +0 -15
- package/dist/cjs/api-model/models/browse-node-review-trend-point.js +0 -15
- package/dist/cjs/api-model/models/browse-node-review-trend.js +0 -15
- package/dist/cjs/api-model/models/browse-node-review-trends-response.js +0 -15
- package/dist/cjs/api-model/models/browse-node-review-trends.js +0 -15
- package/dist/cjs/api-model/models/browse-node-star-rating-impact.js +0 -15
- package/dist/cjs/api-model/models/browse-node-subtopic.js +0 -15
- package/dist/cjs/api-model/models/browse-node-trend-metrics.js +0 -15
- package/dist/cjs/api-model/models/child-asin-mention-metrics.js +0 -15
- package/dist/cjs/api-model/models/child-asin-metrics.js +0 -15
- package/dist/cjs/api-model/models/date-range.js +0 -15
- package/dist/cjs/api-model/models/error-list.js +0 -15
- package/dist/cjs/api-model/models/index.js +0 -55
- package/dist/cjs/api-model/models/item-review-browse-node-metrics.js +0 -15
- package/dist/cjs/api-model/models/item-review-subtopic-metrics.js +0 -15
- package/dist/cjs/api-model/models/item-review-subtopic.js +0 -15
- package/dist/cjs/api-model/models/item-review-topic-metrics.js +0 -15
- package/dist/cjs/api-model/models/item-review-topic.js +0 -15
- package/dist/cjs/api-model/models/item-review-topics-response.js +0 -15
- package/dist/cjs/api-model/models/item-review-topics.js +0 -15
- package/dist/cjs/api-model/models/item-review-trend-point.js +0 -15
- package/dist/cjs/api-model/models/item-review-trend.js +0 -15
- package/dist/cjs/api-model/models/item-review-trends-response.js +0 -15
- package/dist/cjs/api-model/models/item-review-trends.js +0 -15
- package/dist/cjs/api-model/models/model-error.js +0 -15
- package/dist/cjs/api-model/models/review-trend-metrics.js +0 -15
- package/dist/cjs/client.js +0 -13
- package/dist/cjs/index.js +0 -18
- package/dist/es/api-model/api/customer-feedback-api.js +0 -523
- package/dist/es/api-model/api.js +0 -14
- package/dist/es/api-model/base.js +0 -44
- package/dist/es/api-model/common.js +0 -110
- package/dist/es/api-model/configuration.js +0 -94
- package/dist/es/api-model/index.js +0 -16
- package/dist/es/api-model/models/browse-node-all-occurrence.js +0 -14
- package/dist/es/api-model/models/browse-node-all-star-rating-impact.js +0 -14
- package/dist/es/api-model/models/browse-node-occurrence.js +0 -14
- package/dist/es/api-model/models/browse-node-response.js +0 -14
- package/dist/es/api-model/models/browse-node-return-topics-response.js +0 -14
- package/dist/es/api-model/models/browse-node-return-topics.js +0 -14
- package/dist/es/api-model/models/browse-node-return-trend-point.js +0 -14
- package/dist/es/api-model/models/browse-node-return-trend.js +0 -14
- package/dist/es/api-model/models/browse-node-return-trends-response.js +0 -14
- package/dist/es/api-model/models/browse-node-review-subtopic-metrics.js +0 -14
- package/dist/es/api-model/models/browse-node-review-topic-metrics.js +0 -14
- package/dist/es/api-model/models/browse-node-review-topic.js +0 -14
- package/dist/es/api-model/models/browse-node-review-topics-response.js +0 -14
- package/dist/es/api-model/models/browse-node-review-topics.js +0 -14
- package/dist/es/api-model/models/browse-node-review-trend-metrics.js +0 -14
- package/dist/es/api-model/models/browse-node-review-trend-point.js +0 -14
- package/dist/es/api-model/models/browse-node-review-trend.js +0 -14
- package/dist/es/api-model/models/browse-node-review-trends-response.js +0 -14
- package/dist/es/api-model/models/browse-node-review-trends.js +0 -14
- package/dist/es/api-model/models/browse-node-star-rating-impact.js +0 -14
- package/dist/es/api-model/models/browse-node-subtopic.js +0 -14
- package/dist/es/api-model/models/browse-node-trend-metrics.js +0 -14
- package/dist/es/api-model/models/child-asin-mention-metrics.js +0 -14
- package/dist/es/api-model/models/child-asin-metrics.js +0 -14
- package/dist/es/api-model/models/date-range.js +0 -14
- package/dist/es/api-model/models/error-list.js +0 -14
- package/dist/es/api-model/models/index.js +0 -39
- package/dist/es/api-model/models/item-review-browse-node-metrics.js +0 -14
- package/dist/es/api-model/models/item-review-subtopic-metrics.js +0 -14
- package/dist/es/api-model/models/item-review-subtopic.js +0 -14
- package/dist/es/api-model/models/item-review-topic-metrics.js +0 -14
- package/dist/es/api-model/models/item-review-topic.js +0 -14
- package/dist/es/api-model/models/item-review-topics-response.js +0 -14
- package/dist/es/api-model/models/item-review-topics.js +0 -14
- package/dist/es/api-model/models/item-review-trend-point.js +0 -14
- package/dist/es/api-model/models/item-review-trend.js +0 -14
- package/dist/es/api-model/models/item-review-trends-response.js +0 -14
- package/dist/es/api-model/models/item-review-trends.js +0 -14
- package/dist/es/api-model/models/model-error.js +0 -14
- package/dist/es/api-model/models/review-trend-metrics.js +0 -14
- package/dist/es/client.js +0 -9
- package/dist/es/index.js +0 -2
- package/dist/types/api-model/api/customer-feedback-api.d.ts +0 -355
- package/dist/types/api-model/api.d.ts +0 -12
- package/dist/types/api-model/base.d.ts +0 -42
- package/dist/types/api-model/common.d.ts +0 -34
- package/dist/types/api-model/configuration.d.ts +0 -98
- package/dist/types/api-model/index.d.ts +0 -14
- package/dist/types/api-model/models/browse-node-all-occurrence.d.ts +0 -24
- package/dist/types/api-model/models/browse-node-all-star-rating-impact.d.ts +0 -24
- package/dist/types/api-model/models/browse-node-occurrence.d.ts +0 -20
- package/dist/types/api-model/models/browse-node-response.d.ts +0 -24
- package/dist/types/api-model/models/browse-node-return-topics-response.d.ts +0 -39
- package/dist/types/api-model/models/browse-node-return-topics.d.ts +0 -22
- package/dist/types/api-model/models/browse-node-return-trend-point.d.ts +0 -20
- package/dist/types/api-model/models/browse-node-return-trend.d.ts +0 -25
- package/dist/types/api-model/models/browse-node-return-trends-response.d.ts +0 -39
- package/dist/types/api-model/models/browse-node-review-subtopic-metrics.d.ts +0 -20
- package/dist/types/api-model/models/browse-node-review-topic-metrics.d.ts +0 -20
- package/dist/types/api-model/models/browse-node-review-topic.d.ts +0 -31
- package/dist/types/api-model/models/browse-node-review-topics-response.d.ts +0 -36
- package/dist/types/api-model/models/browse-node-review-topics.d.ts +0 -25
- package/dist/types/api-model/models/browse-node-review-trend-metrics.d.ts +0 -18
- package/dist/types/api-model/models/browse-node-review-trend-point.d.ts +0 -20
- package/dist/types/api-model/models/browse-node-review-trend.d.ts +0 -25
- package/dist/types/api-model/models/browse-node-review-trends-response.d.ts +0 -36
- package/dist/types/api-model/models/browse-node-review-trends.d.ts +0 -25
- package/dist/types/api-model/models/browse-node-star-rating-impact.d.ts +0 -20
- package/dist/types/api-model/models/browse-node-subtopic.d.ts +0 -26
- package/dist/types/api-model/models/browse-node-trend-metrics.d.ts +0 -18
- package/dist/types/api-model/models/child-asin-mention-metrics.d.ts +0 -24
- package/dist/types/api-model/models/child-asin-metrics.d.ts +0 -19
- package/dist/types/api-model/models/date-range.d.ts +0 -24
- package/dist/types/api-model/models/error-list.d.ts +0 -20
- package/dist/types/api-model/models/index.d.ts +0 -39
- package/dist/types/api-model/models/item-review-browse-node-metrics.d.ts +0 -20
- package/dist/types/api-model/models/item-review-subtopic-metrics.d.ts +0 -24
- package/dist/types/api-model/models/item-review-subtopic.d.ts +0 -26
- package/dist/types/api-model/models/item-review-topic-metrics.d.ts +0 -28
- package/dist/types/api-model/models/item-review-topic.d.ts +0 -36
- package/dist/types/api-model/models/item-review-topics-response.d.ts +0 -36
- package/dist/types/api-model/models/item-review-topics.d.ts +0 -25
- package/dist/types/api-model/models/item-review-trend-point.d.ts +0 -23
- package/dist/types/api-model/models/item-review-trend.d.ts +0 -25
- package/dist/types/api-model/models/item-review-trends-response.d.ts +0 -36
- package/dist/types/api-model/models/item-review-trends.d.ts +0 -25
- package/dist/types/api-model/models/model-error.d.ts +0 -28
- package/dist/types/api-model/models/review-trend-metrics.d.ts +0 -20
- package/dist/types/client.d.ts +0 -6
- package/dist/types/index.d.ts +0 -3
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,1202 @@
|
|
|
1
|
+
import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
|
|
2
|
+
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
|
+
//#region src/api-model/configuration.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* The Selling Partner API for CustomerFeedback
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
interface AWSv4Configuration {
|
|
16
|
+
options?: {
|
|
17
|
+
region?: string;
|
|
18
|
+
service?: string;
|
|
19
|
+
};
|
|
20
|
+
credentials?: {
|
|
21
|
+
accessKeyId?: string;
|
|
22
|
+
secretAccessKey?: string;
|
|
23
|
+
sessionToken?: string;
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
interface ConfigurationParameters {
|
|
27
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
28
|
+
username?: string;
|
|
29
|
+
password?: string;
|
|
30
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
31
|
+
awsv4?: AWSv4Configuration;
|
|
32
|
+
basePath?: string;
|
|
33
|
+
serverIndex?: number;
|
|
34
|
+
baseOptions?: any;
|
|
35
|
+
formDataCtor?: new () => any;
|
|
36
|
+
}
|
|
37
|
+
declare class Configuration {
|
|
38
|
+
/**
|
|
39
|
+
* parameter for apiKey security
|
|
40
|
+
* @param name security name
|
|
41
|
+
*/
|
|
42
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
43
|
+
/**
|
|
44
|
+
* parameter for basic security
|
|
45
|
+
*/
|
|
46
|
+
username?: string;
|
|
47
|
+
/**
|
|
48
|
+
* parameter for basic security
|
|
49
|
+
*/
|
|
50
|
+
password?: string;
|
|
51
|
+
/**
|
|
52
|
+
* parameter for oauth2 security
|
|
53
|
+
* @param name security name
|
|
54
|
+
* @param scopes oauth2 scope
|
|
55
|
+
*/
|
|
56
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
57
|
+
/**
|
|
58
|
+
* parameter for aws4 signature security
|
|
59
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
60
|
+
* @param {string} options.region - aws region
|
|
61
|
+
* @param {string} options.service - name of the service.
|
|
62
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
63
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
64
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
65
|
+
* @memberof Configuration
|
|
66
|
+
*/
|
|
67
|
+
awsv4?: AWSv4Configuration;
|
|
68
|
+
/**
|
|
69
|
+
* override base path
|
|
70
|
+
*/
|
|
71
|
+
basePath?: string;
|
|
72
|
+
/**
|
|
73
|
+
* override server index
|
|
74
|
+
*/
|
|
75
|
+
serverIndex?: number;
|
|
76
|
+
/**
|
|
77
|
+
* base options for axios calls
|
|
78
|
+
*/
|
|
79
|
+
baseOptions?: any;
|
|
80
|
+
/**
|
|
81
|
+
* The FormData constructor that will be used to create multipart form data
|
|
82
|
+
* requests. You can inject this here so that execution environments that
|
|
83
|
+
* do not support the FormData class can still run the generated client.
|
|
84
|
+
*
|
|
85
|
+
* @type {new () => FormData}
|
|
86
|
+
*/
|
|
87
|
+
formDataCtor?: new () => any;
|
|
88
|
+
constructor(param?: ConfigurationParameters);
|
|
89
|
+
/**
|
|
90
|
+
* Check if the given MIME is a JSON MIME.
|
|
91
|
+
* JSON MIME examples:
|
|
92
|
+
* application/json
|
|
93
|
+
* application/json; charset=UTF8
|
|
94
|
+
* APPLICATION/JSON
|
|
95
|
+
* application/vnd.company+json
|
|
96
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
97
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
98
|
+
*/
|
|
99
|
+
isJsonMime(mime: string): boolean;
|
|
100
|
+
}
|
|
101
|
+
//#endregion
|
|
102
|
+
//#region src/api-model/base.d.ts
|
|
103
|
+
interface RequestArgs {
|
|
104
|
+
url: string;
|
|
105
|
+
options: RawAxiosRequestConfig;
|
|
106
|
+
}
|
|
107
|
+
declare class BaseAPI {
|
|
108
|
+
protected basePath: string;
|
|
109
|
+
protected axios: AxiosInstance;
|
|
110
|
+
protected configuration: Configuration | undefined;
|
|
111
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
112
|
+
}
|
|
113
|
+
//#endregion
|
|
114
|
+
//#region src/api-model/models/browse-node-all-occurrence.d.ts
|
|
115
|
+
/**
|
|
116
|
+
* The Selling Partner API for CustomerFeedback
|
|
117
|
+
* 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.
|
|
118
|
+
*
|
|
119
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
120
|
+
*
|
|
121
|
+
*
|
|
122
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
123
|
+
* https://openapi-generator.tech
|
|
124
|
+
* Do not edit the class manually.
|
|
125
|
+
*/
|
|
126
|
+
/**
|
|
127
|
+
* The browse node review occurrence metrics.
|
|
128
|
+
*/
|
|
129
|
+
interface BrowseNodeAllOccurrence {
|
|
130
|
+
/**
|
|
131
|
+
* The percentage of reviews of the top 25 percent of products in the browse node that mention the topic.
|
|
132
|
+
*/
|
|
133
|
+
'topTwentyFivePercentProducts': number;
|
|
134
|
+
/**
|
|
135
|
+
* The percentage of reviews of products in the browse node that mention the topic.
|
|
136
|
+
*/
|
|
137
|
+
'allProducts': number;
|
|
138
|
+
}
|
|
139
|
+
//#endregion
|
|
140
|
+
//#region src/api-model/models/browse-node-all-star-rating-impact.d.ts
|
|
141
|
+
/**
|
|
142
|
+
* The Selling Partner API for CustomerFeedback
|
|
143
|
+
* 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.
|
|
144
|
+
*
|
|
145
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
146
|
+
*
|
|
147
|
+
*
|
|
148
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
149
|
+
* https://openapi-generator.tech
|
|
150
|
+
* Do not edit the class manually.
|
|
151
|
+
*/
|
|
152
|
+
/**
|
|
153
|
+
* The effects of a topic on the star ratings in a browse node.
|
|
154
|
+
*/
|
|
155
|
+
interface BrowseNodeAllStarRatingImpact {
|
|
156
|
+
/**
|
|
157
|
+
* 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.
|
|
158
|
+
*/
|
|
159
|
+
'topTwentyFivePercentProducts': number;
|
|
160
|
+
/**
|
|
161
|
+
* The effect of the topic on the star rating of all products in the browse node. This value can be positive or negative.
|
|
162
|
+
*/
|
|
163
|
+
'allProducts': number;
|
|
164
|
+
}
|
|
165
|
+
//#endregion
|
|
166
|
+
//#region src/api-model/models/browse-node-occurrence.d.ts
|
|
167
|
+
/**
|
|
168
|
+
* The Selling Partner API for CustomerFeedback
|
|
169
|
+
* 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.
|
|
170
|
+
*
|
|
171
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
172
|
+
*
|
|
173
|
+
*
|
|
174
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
175
|
+
* https://openapi-generator.tech
|
|
176
|
+
* Do not edit the class manually.
|
|
177
|
+
*/
|
|
178
|
+
/**
|
|
179
|
+
* The browse node review trend occurrence metrics.
|
|
180
|
+
*/
|
|
181
|
+
interface BrowseNodeOccurrence {
|
|
182
|
+
/**
|
|
183
|
+
* The percentage of reviews of products in the browse node that mention a topic.
|
|
184
|
+
*/
|
|
185
|
+
'allProducts': number;
|
|
186
|
+
}
|
|
187
|
+
//#endregion
|
|
188
|
+
//#region src/api-model/models/browse-node-response.d.ts
|
|
189
|
+
/**
|
|
190
|
+
* The Selling Partner API for CustomerFeedback
|
|
191
|
+
* 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.
|
|
192
|
+
*
|
|
193
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
194
|
+
*
|
|
195
|
+
*
|
|
196
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
197
|
+
* https://openapi-generator.tech
|
|
198
|
+
* Do not edit the class manually.
|
|
199
|
+
*/
|
|
200
|
+
/**
|
|
201
|
+
* The response for the `getItemBrowseNode` operation.
|
|
202
|
+
*/
|
|
203
|
+
interface BrowseNodeResponse {
|
|
204
|
+
/**
|
|
205
|
+
* 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.
|
|
206
|
+
*/
|
|
207
|
+
'browseNodeId': string;
|
|
208
|
+
/**
|
|
209
|
+
* The display name of the browse node as visible on the Amazon retail website.
|
|
210
|
+
*/
|
|
211
|
+
'displayName': string;
|
|
212
|
+
}
|
|
213
|
+
//#endregion
|
|
214
|
+
//#region src/api-model/models/browse-node-trend-metrics.d.ts
|
|
215
|
+
/**
|
|
216
|
+
* A single browse node review or return trend metric.
|
|
217
|
+
*/
|
|
218
|
+
interface BrowseNodeTrendMetrics {
|
|
219
|
+
'occurrencePercentage': BrowseNodeOccurrence;
|
|
220
|
+
}
|
|
221
|
+
//#endregion
|
|
222
|
+
//#region src/api-model/models/browse-node-return-topics.d.ts
|
|
223
|
+
/**
|
|
224
|
+
* Topics from returns for all items in a browse node.
|
|
225
|
+
*/
|
|
226
|
+
interface BrowseNodeReturnTopics {
|
|
227
|
+
/**
|
|
228
|
+
* The name of the return feedback topic .
|
|
229
|
+
*/
|
|
230
|
+
'topic': string;
|
|
231
|
+
'browseNodeMetrics': BrowseNodeTrendMetrics;
|
|
232
|
+
}
|
|
233
|
+
//#endregion
|
|
234
|
+
//#region src/api-model/models/date-range.d.ts
|
|
235
|
+
/**
|
|
236
|
+
* The Selling Partner API for CustomerFeedback
|
|
237
|
+
* 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.
|
|
238
|
+
*
|
|
239
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
240
|
+
*
|
|
241
|
+
*
|
|
242
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
243
|
+
* https://openapi-generator.tech
|
|
244
|
+
* Do not edit the class manually.
|
|
245
|
+
*/
|
|
246
|
+
/**
|
|
247
|
+
* A date range.
|
|
248
|
+
*/
|
|
249
|
+
interface DateRange {
|
|
250
|
+
/**
|
|
251
|
+
* The start date of the date range in ISO-8601 date/time format.
|
|
252
|
+
*/
|
|
253
|
+
'startDate': string;
|
|
254
|
+
/**
|
|
255
|
+
* The end date of the date range in ISO-8601 date/time format.
|
|
256
|
+
*/
|
|
257
|
+
'endDate': string;
|
|
258
|
+
}
|
|
259
|
+
//#endregion
|
|
260
|
+
//#region src/api-model/models/browse-node-return-topics-response.d.ts
|
|
261
|
+
/**
|
|
262
|
+
* The response for the `getBrowseNodeReturnTopics` operation.
|
|
263
|
+
*/
|
|
264
|
+
interface BrowseNodeReturnTopicsResponse {
|
|
265
|
+
/**
|
|
266
|
+
* The requested browse node id. A browse node id is the unique identifier of a given browse node.
|
|
267
|
+
*/
|
|
268
|
+
'browseNodeId': string;
|
|
269
|
+
/**
|
|
270
|
+
* The display name of the browse node, as visible on the Amazon retail website.
|
|
271
|
+
*/
|
|
272
|
+
'displayName': string;
|
|
273
|
+
/**
|
|
274
|
+
* The requested marketplace id.
|
|
275
|
+
*/
|
|
276
|
+
'marketplaceId': string;
|
|
277
|
+
/**
|
|
278
|
+
* The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
|
|
279
|
+
*/
|
|
280
|
+
'countryCode': string;
|
|
281
|
+
'dateRange': DateRange;
|
|
282
|
+
/**
|
|
283
|
+
* The list of browse node return topics.
|
|
284
|
+
*/
|
|
285
|
+
'topics': Array<BrowseNodeReturnTopics>;
|
|
286
|
+
}
|
|
287
|
+
//#endregion
|
|
288
|
+
//#region src/api-model/models/browse-node-return-trend-point.d.ts
|
|
289
|
+
/**
|
|
290
|
+
* The return metrics for a certain month.
|
|
291
|
+
*/
|
|
292
|
+
interface BrowseNodeReturnTrendPoint {
|
|
293
|
+
'dateRange': DateRange;
|
|
294
|
+
'browseNodeMetrics': BrowseNodeTrendMetrics;
|
|
295
|
+
}
|
|
296
|
+
//#endregion
|
|
297
|
+
//#region src/api-model/models/browse-node-return-trend.d.ts
|
|
298
|
+
/**
|
|
299
|
+
* The trend of return topic metrics for all items in the requested browse node.
|
|
300
|
+
*/
|
|
301
|
+
interface BrowseNodeReturnTrend {
|
|
302
|
+
/**
|
|
303
|
+
* The name of the topic.
|
|
304
|
+
*/
|
|
305
|
+
'topic': string;
|
|
306
|
+
/**
|
|
307
|
+
* The browse node return trend metrics.
|
|
308
|
+
*/
|
|
309
|
+
'trendMetrics': Array<BrowseNodeReturnTrendPoint>;
|
|
310
|
+
}
|
|
311
|
+
//#endregion
|
|
312
|
+
//#region src/api-model/models/browse-node-return-trends-response.d.ts
|
|
313
|
+
/**
|
|
314
|
+
* The response for the `getBrowseNodeReturnTrends` operation.
|
|
315
|
+
*/
|
|
316
|
+
interface BrowseNodeReturnTrendsResponse {
|
|
317
|
+
/**
|
|
318
|
+
* The requested browse node id. A browse node id is the unique identifier of a given browse node.
|
|
319
|
+
*/
|
|
320
|
+
'browseNodeId': string;
|
|
321
|
+
/**
|
|
322
|
+
* The display name of the browse node, as visible on the Amazon retail website.
|
|
323
|
+
*/
|
|
324
|
+
'displayName': string;
|
|
325
|
+
/**
|
|
326
|
+
* The requested marketplace id.
|
|
327
|
+
*/
|
|
328
|
+
'marketplaceId': string;
|
|
329
|
+
/**
|
|
330
|
+
* The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
|
|
331
|
+
*/
|
|
332
|
+
'countryCode': string;
|
|
333
|
+
'dateRange': DateRange;
|
|
334
|
+
/**
|
|
335
|
+
* The browse node return trends.
|
|
336
|
+
*/
|
|
337
|
+
'returnTrends': Array<BrowseNodeReturnTrend>;
|
|
338
|
+
}
|
|
339
|
+
//#endregion
|
|
340
|
+
//#region src/api-model/models/browse-node-review-subtopic-metrics.d.ts
|
|
341
|
+
/**
|
|
342
|
+
* The Selling Partner API for CustomerFeedback
|
|
343
|
+
* 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.
|
|
344
|
+
*
|
|
345
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
346
|
+
*
|
|
347
|
+
*
|
|
348
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
349
|
+
* https://openapi-generator.tech
|
|
350
|
+
* Do not edit the class manually.
|
|
351
|
+
*/
|
|
352
|
+
/**
|
|
353
|
+
* The browse node review subtopic metrics.
|
|
354
|
+
*/
|
|
355
|
+
interface BrowseNodeReviewSubtopicMetrics {
|
|
356
|
+
/**
|
|
357
|
+
* The percentage of reviews that mention the subtopic.
|
|
358
|
+
*/
|
|
359
|
+
'occurrencePercentage': number;
|
|
360
|
+
}
|
|
361
|
+
//#endregion
|
|
362
|
+
//#region src/api-model/models/browse-node-review-topic-metrics.d.ts
|
|
363
|
+
/**
|
|
364
|
+
* The browse node review topic metrics.
|
|
365
|
+
*/
|
|
366
|
+
interface BrowseNodeReviewTopicMetrics {
|
|
367
|
+
'occurrencePercentage'?: BrowseNodeAllOccurrence;
|
|
368
|
+
'starRatingImpact'?: BrowseNodeAllStarRatingImpact;
|
|
369
|
+
}
|
|
370
|
+
//#endregion
|
|
371
|
+
//#region src/api-model/models/browse-node-subtopic.d.ts
|
|
372
|
+
/**
|
|
373
|
+
* The browse node review subtopic.
|
|
374
|
+
*/
|
|
375
|
+
interface BrowseNodeSubtopic {
|
|
376
|
+
/**
|
|
377
|
+
* The name of the browse node review subtopic.
|
|
378
|
+
*/
|
|
379
|
+
'subtopic': string;
|
|
380
|
+
'metrics': BrowseNodeReviewSubtopicMetrics;
|
|
381
|
+
/**
|
|
382
|
+
* 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.
|
|
383
|
+
*/
|
|
384
|
+
'reviewSnippets'?: Array<string>;
|
|
385
|
+
}
|
|
386
|
+
//#endregion
|
|
387
|
+
//#region src/api-model/models/browse-node-review-topic.d.ts
|
|
388
|
+
/**
|
|
389
|
+
* The browse node review topic.
|
|
390
|
+
*/
|
|
391
|
+
interface BrowseNodeReviewTopic {
|
|
392
|
+
/**
|
|
393
|
+
* The name browse node review topic.
|
|
394
|
+
*/
|
|
395
|
+
'topic': string;
|
|
396
|
+
'browseNodeMetrics': BrowseNodeReviewTopicMetrics;
|
|
397
|
+
/**
|
|
398
|
+
* 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.
|
|
399
|
+
*/
|
|
400
|
+
'reviewSnippets'?: Array<string>;
|
|
401
|
+
/**
|
|
402
|
+
* A list of the five subtopics that occur most frequently. This value is `null` if there are no subtopics.
|
|
403
|
+
*/
|
|
404
|
+
'subtopics'?: Array<BrowseNodeSubtopic>;
|
|
405
|
+
}
|
|
406
|
+
//#endregion
|
|
407
|
+
//#region src/api-model/models/browse-node-review-topics.d.ts
|
|
408
|
+
/**
|
|
409
|
+
* The 10 most positive and most negative review topics for all items in a browse node.
|
|
410
|
+
*/
|
|
411
|
+
interface BrowseNodeReviewTopics {
|
|
412
|
+
/**
|
|
413
|
+
* 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
|
|
414
|
+
*/
|
|
415
|
+
'positiveTopics'?: Array<BrowseNodeReviewTopic>;
|
|
416
|
+
/**
|
|
417
|
+
* 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
|
|
418
|
+
*/
|
|
419
|
+
'negativeTopics'?: Array<BrowseNodeReviewTopic>;
|
|
420
|
+
}
|
|
421
|
+
//#endregion
|
|
422
|
+
//#region src/api-model/models/browse-node-review-topics-response.d.ts
|
|
423
|
+
/**
|
|
424
|
+
* The response for the `getBrowseNodeReviewTopics` operation.
|
|
425
|
+
*/
|
|
426
|
+
interface BrowseNodeReviewTopicsResponse {
|
|
427
|
+
/**
|
|
428
|
+
* The requested browse node id. A browse node id is the unique identifier of a given browse node.
|
|
429
|
+
*/
|
|
430
|
+
'browseNodeId': string;
|
|
431
|
+
/**
|
|
432
|
+
* The display name of the requested browse node id. The display name of the browse node as visible on the Amazon retail website.
|
|
433
|
+
*/
|
|
434
|
+
'displayName': string;
|
|
435
|
+
/**
|
|
436
|
+
* The requested marketplace id.
|
|
437
|
+
*/
|
|
438
|
+
'marketplaceId': string;
|
|
439
|
+
/**
|
|
440
|
+
* The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
|
|
441
|
+
*/
|
|
442
|
+
'countryCode': string;
|
|
443
|
+
'dateRange': DateRange;
|
|
444
|
+
'topics': BrowseNodeReviewTopics;
|
|
445
|
+
}
|
|
446
|
+
//#endregion
|
|
447
|
+
//#region src/api-model/models/browse-node-review-trend-metrics.d.ts
|
|
448
|
+
/**
|
|
449
|
+
* The browse node review topic metrics.
|
|
450
|
+
*/
|
|
451
|
+
interface BrowseNodeReviewTrendMetrics {
|
|
452
|
+
'occurrencePercentage': BrowseNodeAllOccurrence;
|
|
453
|
+
}
|
|
454
|
+
//#endregion
|
|
455
|
+
//#region src/api-model/models/browse-node-review-trend-point.d.ts
|
|
456
|
+
/**
|
|
457
|
+
* The browse node\'s review metrics for a certain month.
|
|
458
|
+
*/
|
|
459
|
+
interface BrowseNodeReviewTrendPoint {
|
|
460
|
+
'dateRange': DateRange;
|
|
461
|
+
'browseNodeMetrics': BrowseNodeReviewTrendMetrics;
|
|
462
|
+
}
|
|
463
|
+
//#endregion
|
|
464
|
+
//#region src/api-model/models/browse-node-review-trend.d.ts
|
|
465
|
+
/**
|
|
466
|
+
* The trend of review topic metrics for all items in the requested browse node.
|
|
467
|
+
*/
|
|
468
|
+
interface BrowseNodeReviewTrend {
|
|
469
|
+
/**
|
|
470
|
+
* The name of the topic.
|
|
471
|
+
*/
|
|
472
|
+
'topic': string;
|
|
473
|
+
/**
|
|
474
|
+
* The browse node\'s review trend metrics for the past six months.
|
|
475
|
+
*/
|
|
476
|
+
'trendMetrics': Array<BrowseNodeReviewTrendPoint>;
|
|
477
|
+
}
|
|
478
|
+
//#endregion
|
|
479
|
+
//#region src/api-model/models/browse-node-review-trends.d.ts
|
|
480
|
+
/**
|
|
481
|
+
* The 10 most positive and most negative review topics for all items in a browse node.
|
|
482
|
+
*/
|
|
483
|
+
interface BrowseNodeReviewTrends {
|
|
484
|
+
/**
|
|
485
|
+
* 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
|
|
486
|
+
*/
|
|
487
|
+
'positiveTopics'?: Array<BrowseNodeReviewTrend>;
|
|
488
|
+
/**
|
|
489
|
+
* 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
|
|
490
|
+
*/
|
|
491
|
+
'negativeTopics'?: Array<BrowseNodeReviewTrend>;
|
|
492
|
+
}
|
|
493
|
+
//#endregion
|
|
494
|
+
//#region src/api-model/models/browse-node-review-trends-response.d.ts
|
|
495
|
+
/**
|
|
496
|
+
* The response for the `getBrowseNodeReviewTrends` operation.
|
|
497
|
+
*/
|
|
498
|
+
interface BrowseNodeReviewTrendsResponse {
|
|
499
|
+
/**
|
|
500
|
+
* The requested browse node id. A browse node id is the unique identifier of a given browse node.
|
|
501
|
+
*/
|
|
502
|
+
'browseNodeId': string;
|
|
503
|
+
/**
|
|
504
|
+
* The display name of the requested browse node id. The display name of the browse node as visible on the Amazon retail website.
|
|
505
|
+
*/
|
|
506
|
+
'displayName': string;
|
|
507
|
+
/**
|
|
508
|
+
* The requested marketplace id.
|
|
509
|
+
*/
|
|
510
|
+
'marketplaceId': string;
|
|
511
|
+
/**
|
|
512
|
+
* The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
|
|
513
|
+
*/
|
|
514
|
+
'countryCode': string;
|
|
515
|
+
'dateRange': DateRange;
|
|
516
|
+
'reviewTrends': BrowseNodeReviewTrends;
|
|
517
|
+
}
|
|
518
|
+
//#endregion
|
|
519
|
+
//#region src/api-model/models/browse-node-star-rating-impact.d.ts
|
|
520
|
+
/**
|
|
521
|
+
* The Selling Partner API for CustomerFeedback
|
|
522
|
+
* 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.
|
|
523
|
+
*
|
|
524
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
525
|
+
*
|
|
526
|
+
*
|
|
527
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
528
|
+
* https://openapi-generator.tech
|
|
529
|
+
* Do not edit the class manually.
|
|
530
|
+
*/
|
|
531
|
+
/**
|
|
532
|
+
* The effects of a topic on a browse node\'s star rating.
|
|
533
|
+
*/
|
|
534
|
+
interface BrowseNodeStarRatingImpact {
|
|
535
|
+
/**
|
|
536
|
+
* The effect of the topic on the star rating for all products in this browse node. This value can be positive or negative.
|
|
537
|
+
*/
|
|
538
|
+
'allProducts': number;
|
|
539
|
+
}
|
|
540
|
+
//#endregion
|
|
541
|
+
//#region src/api-model/models/child-asin-mention-metrics.d.ts
|
|
542
|
+
/**
|
|
543
|
+
* The Selling Partner API for CustomerFeedback
|
|
544
|
+
* 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.
|
|
545
|
+
*
|
|
546
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
547
|
+
*
|
|
548
|
+
*
|
|
549
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
550
|
+
* https://openapi-generator.tech
|
|
551
|
+
* Do not edit the class manually.
|
|
552
|
+
*/
|
|
553
|
+
/**
|
|
554
|
+
* The child ASIN review topic mention metrics.
|
|
555
|
+
*/
|
|
556
|
+
interface ChildAsinMentionMetrics {
|
|
557
|
+
/**
|
|
558
|
+
* The child ASIN of the requested item.
|
|
559
|
+
*/
|
|
560
|
+
'asin': string;
|
|
561
|
+
/**
|
|
562
|
+
* The number of times reviews of the child ASIN mention the topic.
|
|
563
|
+
*/
|
|
564
|
+
'numberOfMentions': number;
|
|
565
|
+
}
|
|
566
|
+
//#endregion
|
|
567
|
+
//#region src/api-model/models/child-asin-metrics.d.ts
|
|
568
|
+
/**
|
|
569
|
+
* 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.
|
|
570
|
+
*/
|
|
571
|
+
interface ChildAsinMetrics {
|
|
572
|
+
'mostMentions'?: ChildAsinMentionMetrics;
|
|
573
|
+
'leastMentions'?: ChildAsinMentionMetrics;
|
|
574
|
+
}
|
|
575
|
+
//#endregion
|
|
576
|
+
//#region src/api-model/models/error-list.d.ts
|
|
577
|
+
/**
|
|
578
|
+
* The Selling Partner API for CustomerFeedback
|
|
579
|
+
* 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.
|
|
580
|
+
*
|
|
581
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
582
|
+
*
|
|
583
|
+
*
|
|
584
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
585
|
+
* https://openapi-generator.tech
|
|
586
|
+
* Do not edit the class manually.
|
|
587
|
+
*/
|
|
588
|
+
/**
|
|
589
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
590
|
+
*/
|
|
591
|
+
interface ErrorList {
|
|
592
|
+
/**
|
|
593
|
+
* List of errors.
|
|
594
|
+
*/
|
|
595
|
+
'errors': Array<Error>;
|
|
596
|
+
}
|
|
597
|
+
//#endregion
|
|
598
|
+
//#region src/api-model/models/item-review-browse-node-metrics.d.ts
|
|
599
|
+
/**
|
|
600
|
+
* The browse node review topic metrics.
|
|
601
|
+
*/
|
|
602
|
+
interface ItemReviewBrowseNodeMetrics {
|
|
603
|
+
'occurrencePercentage'?: BrowseNodeOccurrence;
|
|
604
|
+
'starRatingImpact'?: BrowseNodeStarRatingImpact;
|
|
605
|
+
}
|
|
606
|
+
//#endregion
|
|
607
|
+
//#region src/api-model/models/item-review-subtopic-metrics.d.ts
|
|
608
|
+
/**
|
|
609
|
+
* The Selling Partner API for CustomerFeedback
|
|
610
|
+
* 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.
|
|
611
|
+
*
|
|
612
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
613
|
+
*
|
|
614
|
+
*
|
|
615
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
616
|
+
* https://openapi-generator.tech
|
|
617
|
+
* Do not edit the class manually.
|
|
618
|
+
*/
|
|
619
|
+
/**
|
|
620
|
+
* The item review subtopic metrics.
|
|
621
|
+
*/
|
|
622
|
+
interface ItemReviewSubtopicMetrics {
|
|
623
|
+
/**
|
|
624
|
+
* The number of times that reviews mention the subtopic.
|
|
625
|
+
*/
|
|
626
|
+
'numberOfMentions': number;
|
|
627
|
+
/**
|
|
628
|
+
* The percentage of reviews that mention the subtopic.
|
|
629
|
+
*/
|
|
630
|
+
'occurrencePercentage': number;
|
|
631
|
+
}
|
|
632
|
+
//#endregion
|
|
633
|
+
//#region src/api-model/models/item-review-subtopic.d.ts
|
|
634
|
+
/**
|
|
635
|
+
* Details of the subtopic for an item review topic.
|
|
636
|
+
*/
|
|
637
|
+
interface ItemReviewSubtopic {
|
|
638
|
+
/**
|
|
639
|
+
* The name of the subtopic.
|
|
640
|
+
*/
|
|
641
|
+
'subtopic': string;
|
|
642
|
+
'metrics': ItemReviewSubtopicMetrics;
|
|
643
|
+
/**
|
|
644
|
+
* 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.
|
|
645
|
+
*/
|
|
646
|
+
'reviewSnippets'?: Array<string>;
|
|
647
|
+
}
|
|
648
|
+
//#endregion
|
|
649
|
+
//#region src/api-model/models/item-review-topic-metrics.d.ts
|
|
650
|
+
/**
|
|
651
|
+
* The Selling Partner API for CustomerFeedback
|
|
652
|
+
* 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.
|
|
653
|
+
*
|
|
654
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
655
|
+
*
|
|
656
|
+
*
|
|
657
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
658
|
+
* https://openapi-generator.tech
|
|
659
|
+
* Do not edit the class manually.
|
|
660
|
+
*/
|
|
661
|
+
/**
|
|
662
|
+
* The item review topic metrics.
|
|
663
|
+
*/
|
|
664
|
+
interface ItemReviewTopicMetrics {
|
|
665
|
+
/**
|
|
666
|
+
* The number of times that reviews mention the topic. This value is `null` if reviews do not mention the topic frequently enough.
|
|
667
|
+
*/
|
|
668
|
+
'numberOfMentions'?: number;
|
|
669
|
+
/**
|
|
670
|
+
* The percentage of customer reviews that mention the topic. This value is `null` if reviews do not mention the topic frequently enough.
|
|
671
|
+
*/
|
|
672
|
+
'occurrencePercentage'?: number;
|
|
673
|
+
/**
|
|
674
|
+
* 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.
|
|
675
|
+
*/
|
|
676
|
+
'starRatingImpact'?: number;
|
|
677
|
+
}
|
|
678
|
+
//#endregion
|
|
679
|
+
//#region src/api-model/models/item-review-topic.d.ts
|
|
680
|
+
/**
|
|
681
|
+
* Details of item review topic.
|
|
682
|
+
*/
|
|
683
|
+
interface ItemReviewTopic {
|
|
684
|
+
/**
|
|
685
|
+
* The name of the item review topic.
|
|
686
|
+
*/
|
|
687
|
+
'topic': string;
|
|
688
|
+
'asinMetrics': ItemReviewTopicMetrics;
|
|
689
|
+
'parentAsinMetrics'?: ItemReviewTopicMetrics;
|
|
690
|
+
'browseNodeMetrics'?: ItemReviewBrowseNodeMetrics;
|
|
691
|
+
'childAsinMetrics'?: ChildAsinMetrics;
|
|
692
|
+
/**
|
|
693
|
+
* 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.
|
|
694
|
+
*/
|
|
695
|
+
'reviewSnippets'?: Array<string>;
|
|
696
|
+
/**
|
|
697
|
+
* 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.
|
|
698
|
+
*/
|
|
699
|
+
'subtopics'?: Array<ItemReviewSubtopic>;
|
|
700
|
+
}
|
|
701
|
+
//#endregion
|
|
702
|
+
//#region src/api-model/models/item-review-topics.d.ts
|
|
703
|
+
/**
|
|
704
|
+
* The top 10 positive and negative item review topics.
|
|
705
|
+
*/
|
|
706
|
+
interface ItemReviewTopics {
|
|
707
|
+
/**
|
|
708
|
+
* 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
|
|
709
|
+
*/
|
|
710
|
+
'positiveTopics'?: Array<ItemReviewTopic>;
|
|
711
|
+
/**
|
|
712
|
+
* 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
|
|
713
|
+
*/
|
|
714
|
+
'negativeTopics'?: Array<ItemReviewTopic>;
|
|
715
|
+
}
|
|
716
|
+
//#endregion
|
|
717
|
+
//#region src/api-model/models/item-review-topics-response.d.ts
|
|
718
|
+
/**
|
|
719
|
+
* The response for the `getItemReviewTopics` operation.
|
|
720
|
+
*/
|
|
721
|
+
interface ItemReviewTopicsResponse {
|
|
722
|
+
/**
|
|
723
|
+
* The requested ASIN. The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
724
|
+
*/
|
|
725
|
+
'asin': string;
|
|
726
|
+
/**
|
|
727
|
+
* The product title of the requested ASIN.
|
|
728
|
+
*/
|
|
729
|
+
'itemName': string;
|
|
730
|
+
/**
|
|
731
|
+
* The requested marketplace id.
|
|
732
|
+
*/
|
|
733
|
+
'marketplaceId': string;
|
|
734
|
+
/**
|
|
735
|
+
* The two digit country code of the requested marketplace id, in ISO 3166-1 alpha-2 format.
|
|
736
|
+
*/
|
|
737
|
+
'countryCode': string;
|
|
738
|
+
'dateRange': DateRange;
|
|
739
|
+
'topics': ItemReviewTopics;
|
|
740
|
+
}
|
|
741
|
+
//#endregion
|
|
742
|
+
//#region src/api-model/models/review-trend-metrics.d.ts
|
|
743
|
+
/**
|
|
744
|
+
* The Selling Partner API for CustomerFeedback
|
|
745
|
+
* 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.
|
|
746
|
+
*
|
|
747
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
748
|
+
*
|
|
749
|
+
*
|
|
750
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
751
|
+
* https://openapi-generator.tech
|
|
752
|
+
* Do not edit the class manually.
|
|
753
|
+
*/
|
|
754
|
+
/**
|
|
755
|
+
* The item review trend metrics.
|
|
756
|
+
*/
|
|
757
|
+
interface ReviewTrendMetrics {
|
|
758
|
+
/**
|
|
759
|
+
* The percentage of reviews that mention the topic.
|
|
760
|
+
*/
|
|
761
|
+
'occurrencePercentage': number;
|
|
762
|
+
}
|
|
763
|
+
//#endregion
|
|
764
|
+
//#region src/api-model/models/item-review-trend-point.d.ts
|
|
765
|
+
/**
|
|
766
|
+
* The review metrics for a certain month.
|
|
767
|
+
*/
|
|
768
|
+
interface ItemReviewTrendPoint {
|
|
769
|
+
'dateRange': DateRange;
|
|
770
|
+
'asinMetrics': ReviewTrendMetrics;
|
|
771
|
+
'parentAsinMetrics'?: ReviewTrendMetrics;
|
|
772
|
+
'browseNodeMetrics'?: BrowseNodeTrendMetrics;
|
|
773
|
+
}
|
|
774
|
+
//#endregion
|
|
775
|
+
//#region src/api-model/models/item-review-trend.d.ts
|
|
776
|
+
/**
|
|
777
|
+
* The trend of review topic metrics for the requested item.
|
|
778
|
+
*/
|
|
779
|
+
interface ItemReviewTrend {
|
|
780
|
+
/**
|
|
781
|
+
* The name of the item review topic.
|
|
782
|
+
*/
|
|
783
|
+
'topic': string;
|
|
784
|
+
/**
|
|
785
|
+
* The item\'s review trend metrics for the past six months.
|
|
786
|
+
*/
|
|
787
|
+
'trendMetrics': Array<ItemReviewTrendPoint>;
|
|
788
|
+
}
|
|
789
|
+
//#endregion
|
|
790
|
+
//#region src/api-model/models/item-review-trends.d.ts
|
|
791
|
+
/**
|
|
792
|
+
* The 10 most positive and most negative review topics for all items in a browse node.
|
|
793
|
+
*/
|
|
794
|
+
interface ItemReviewTrends {
|
|
795
|
+
/**
|
|
796
|
+
* 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
|
|
797
|
+
*/
|
|
798
|
+
'positiveTopics'?: Array<ItemReviewTrend>;
|
|
799
|
+
/**
|
|
800
|
+
* 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
|
|
801
|
+
*/
|
|
802
|
+
'negativeTopics'?: Array<ItemReviewTrend>;
|
|
803
|
+
}
|
|
804
|
+
//#endregion
|
|
805
|
+
//#region src/api-model/models/item-review-trends-response.d.ts
|
|
806
|
+
/**
|
|
807
|
+
* The response for the `getItemReviewTrends` operation.
|
|
808
|
+
*/
|
|
809
|
+
interface ItemReviewTrendsResponse {
|
|
810
|
+
/**
|
|
811
|
+
* The requested ASIN. The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
812
|
+
*/
|
|
813
|
+
'asin': string;
|
|
814
|
+
/**
|
|
815
|
+
* The product title of the requested ASIN.
|
|
816
|
+
*/
|
|
817
|
+
'itemName': string;
|
|
818
|
+
/**
|
|
819
|
+
* The requested marketplace id.
|
|
820
|
+
*/
|
|
821
|
+
'marketplaceId': string;
|
|
822
|
+
/**
|
|
823
|
+
* The two digit country code of the requested marketplace id, in ISO 3166-1 alpha-2 format.
|
|
824
|
+
*/
|
|
825
|
+
'countryCode': string;
|
|
826
|
+
'dateRange': DateRange;
|
|
827
|
+
'reviewTrends': ItemReviewTrends;
|
|
828
|
+
}
|
|
829
|
+
//#endregion
|
|
830
|
+
//#region src/api-model/models/model-error.d.ts
|
|
831
|
+
/**
|
|
832
|
+
* The Selling Partner API for CustomerFeedback
|
|
833
|
+
* 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.
|
|
834
|
+
*
|
|
835
|
+
* The version of the OpenAPI document: 2024-06-01
|
|
836
|
+
*
|
|
837
|
+
*
|
|
838
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
839
|
+
* https://openapi-generator.tech
|
|
840
|
+
* Do not edit the class manually.
|
|
841
|
+
*/
|
|
842
|
+
/**
|
|
843
|
+
* Error response returned when the request is unsuccessful.
|
|
844
|
+
*/
|
|
845
|
+
interface ModelError {
|
|
846
|
+
/**
|
|
847
|
+
* An error code that identifies the type of error that occurred.
|
|
848
|
+
*/
|
|
849
|
+
'code': string;
|
|
850
|
+
/**
|
|
851
|
+
* A message that describes the error condition.
|
|
852
|
+
*/
|
|
853
|
+
'message': string;
|
|
854
|
+
/**
|
|
855
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
856
|
+
*/
|
|
857
|
+
'details'?: string;
|
|
858
|
+
}
|
|
859
|
+
//#endregion
|
|
860
|
+
//#region src/api-model/api/customer-feedback-api.d.ts
|
|
861
|
+
/**
|
|
862
|
+
* CustomerFeedbackApi - axios parameter creator
|
|
863
|
+
*/
|
|
864
|
+
declare const CustomerFeedbackApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
865
|
+
/**
|
|
866
|
+
* Retrieve the topics that customers mention when they return items in a browse node.
|
|
867
|
+
* @param {string} browseNodeId A browse node ID is a unique identifier for a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
868
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
869
|
+
* @param {*} [options] Override http request option.
|
|
870
|
+
* @throws {RequiredError}
|
|
871
|
+
*/
|
|
872
|
+
getBrowseNodeReturnTopics: (browseNodeId: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
873
|
+
/**
|
|
874
|
+
* Retrieve the trends of topics that customers mention when they return items in a browse node.
|
|
875
|
+
* @param {string} browseNodeId A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
876
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
877
|
+
* @param {*} [options] Override http request option.
|
|
878
|
+
* @throws {RequiredError}
|
|
879
|
+
*/
|
|
880
|
+
getBrowseNodeReturnTrends: (browseNodeId: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
881
|
+
/**
|
|
882
|
+
* Retrieve a browse node\'s ten most positive and ten most negative review topics.
|
|
883
|
+
* @param {string} browseNodeId The ID of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
884
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
885
|
+
* @param {string} sortBy The metric by which to sort the data in the response.
|
|
886
|
+
* @param {*} [options] Override http request option.
|
|
887
|
+
* @throws {RequiredError}
|
|
888
|
+
*/
|
|
889
|
+
getBrowseNodeReviewTopics: (browseNodeId: string, marketplaceId: string, sortBy: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
890
|
+
/**
|
|
891
|
+
* Retrieve the positive and negative review trends of items in a browse node for the past six months.
|
|
892
|
+
* @param {string} browseNodeId A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
893
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. For more information, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
894
|
+
* @param {*} [options] Override http request option.
|
|
895
|
+
* @throws {RequiredError}
|
|
896
|
+
*/
|
|
897
|
+
getBrowseNodeReviewTrends: (browseNodeId: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
898
|
+
/**
|
|
899
|
+
* This API returns the associated browse node of the requested ASIN. A browse node is a location in a browse tree that is used for navigation, product classification, and website content on the Amazon retail website.
|
|
900
|
+
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
901
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
902
|
+
* @param {*} [options] Override http request option.
|
|
903
|
+
* @throws {RequiredError}
|
|
904
|
+
*/
|
|
905
|
+
getItemBrowseNode: (asin: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
906
|
+
/**
|
|
907
|
+
* Retrieve an item\'s ten most positive and ten most negative review topics.
|
|
908
|
+
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. The value must be a child ASIN.
|
|
909
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
910
|
+
* @param {string} sortBy The metric by which to sort data in the response.
|
|
911
|
+
* @param {*} [options] Override http request option.
|
|
912
|
+
* @throws {RequiredError}
|
|
913
|
+
*/
|
|
914
|
+
getItemReviewTopics: (asin: string, marketplaceId: string, sortBy: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
915
|
+
/**
|
|
916
|
+
* Retrieve an item\'s positive and negative review trends for the past six months.
|
|
917
|
+
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. This API takes child ASIN as an input.
|
|
918
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
919
|
+
* @param {*} [options] Override http request option.
|
|
920
|
+
* @throws {RequiredError}
|
|
921
|
+
*/
|
|
922
|
+
getItemReviewTrends: (asin: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
923
|
+
};
|
|
924
|
+
/**
|
|
925
|
+
* CustomerFeedbackApi - functional programming interface
|
|
926
|
+
*/
|
|
927
|
+
declare const CustomerFeedbackApiFp: (configuration?: Configuration) => {
|
|
928
|
+
/**
|
|
929
|
+
* Retrieve the topics that customers mention when they return items in a browse node.
|
|
930
|
+
* @param {string} browseNodeId A browse node ID is a unique identifier for a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
931
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
932
|
+
* @param {*} [options] Override http request option.
|
|
933
|
+
* @throws {RequiredError}
|
|
934
|
+
*/
|
|
935
|
+
getBrowseNodeReturnTopics(browseNodeId: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrowseNodeReturnTopicsResponse>>;
|
|
936
|
+
/**
|
|
937
|
+
* Retrieve the trends of topics that customers mention when they return items in a browse node.
|
|
938
|
+
* @param {string} browseNodeId A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
939
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
940
|
+
* @param {*} [options] Override http request option.
|
|
941
|
+
* @throws {RequiredError}
|
|
942
|
+
*/
|
|
943
|
+
getBrowseNodeReturnTrends(browseNodeId: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrowseNodeReturnTrendsResponse>>;
|
|
944
|
+
/**
|
|
945
|
+
* Retrieve a browse node\'s ten most positive and ten most negative review topics.
|
|
946
|
+
* @param {string} browseNodeId The ID of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
947
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
948
|
+
* @param {string} sortBy The metric by which to sort the data in the response.
|
|
949
|
+
* @param {*} [options] Override http request option.
|
|
950
|
+
* @throws {RequiredError}
|
|
951
|
+
*/
|
|
952
|
+
getBrowseNodeReviewTopics(browseNodeId: string, marketplaceId: string, sortBy: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrowseNodeReviewTopicsResponse>>;
|
|
953
|
+
/**
|
|
954
|
+
* Retrieve the positive and negative review trends of items in a browse node for the past six months.
|
|
955
|
+
* @param {string} browseNodeId A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
956
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. For more information, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
957
|
+
* @param {*} [options] Override http request option.
|
|
958
|
+
* @throws {RequiredError}
|
|
959
|
+
*/
|
|
960
|
+
getBrowseNodeReviewTrends(browseNodeId: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrowseNodeReviewTrendsResponse>>;
|
|
961
|
+
/**
|
|
962
|
+
* This API returns the associated browse node of the requested ASIN. A browse node is a location in a browse tree that is used for navigation, product classification, and website content on the Amazon retail website.
|
|
963
|
+
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
964
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
965
|
+
* @param {*} [options] Override http request option.
|
|
966
|
+
* @throws {RequiredError}
|
|
967
|
+
*/
|
|
968
|
+
getItemBrowseNode(asin: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrowseNodeResponse>>;
|
|
969
|
+
/**
|
|
970
|
+
* Retrieve an item\'s ten most positive and ten most negative review topics.
|
|
971
|
+
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. The value must be a child ASIN.
|
|
972
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
973
|
+
* @param {string} sortBy The metric by which to sort data in the response.
|
|
974
|
+
* @param {*} [options] Override http request option.
|
|
975
|
+
* @throws {RequiredError}
|
|
976
|
+
*/
|
|
977
|
+
getItemReviewTopics(asin: string, marketplaceId: string, sortBy: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemReviewTopicsResponse>>;
|
|
978
|
+
/**
|
|
979
|
+
* Retrieve an item\'s positive and negative review trends for the past six months.
|
|
980
|
+
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. This API takes child ASIN as an input.
|
|
981
|
+
* @param {string} marketplaceId The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
982
|
+
* @param {*} [options] Override http request option.
|
|
983
|
+
* @throws {RequiredError}
|
|
984
|
+
*/
|
|
985
|
+
getItemReviewTrends(asin: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemReviewTrendsResponse>>;
|
|
986
|
+
};
|
|
987
|
+
/**
|
|
988
|
+
* CustomerFeedbackApi - factory interface
|
|
989
|
+
*/
|
|
990
|
+
declare const CustomerFeedbackApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
991
|
+
/**
|
|
992
|
+
* Retrieve the topics that customers mention when they return items in a browse node.
|
|
993
|
+
* @param {CustomerFeedbackApiGetBrowseNodeReturnTopicsRequest} requestParameters Request parameters.
|
|
994
|
+
* @param {*} [options] Override http request option.
|
|
995
|
+
* @throws {RequiredError}
|
|
996
|
+
*/
|
|
997
|
+
getBrowseNodeReturnTopics(requestParameters: CustomerFeedbackApiGetBrowseNodeReturnTopicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BrowseNodeReturnTopicsResponse>;
|
|
998
|
+
/**
|
|
999
|
+
* Retrieve the trends of topics that customers mention when they return items in a browse node.
|
|
1000
|
+
* @param {CustomerFeedbackApiGetBrowseNodeReturnTrendsRequest} requestParameters Request parameters.
|
|
1001
|
+
* @param {*} [options] Override http request option.
|
|
1002
|
+
* @throws {RequiredError}
|
|
1003
|
+
*/
|
|
1004
|
+
getBrowseNodeReturnTrends(requestParameters: CustomerFeedbackApiGetBrowseNodeReturnTrendsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BrowseNodeReturnTrendsResponse>;
|
|
1005
|
+
/**
|
|
1006
|
+
* Retrieve a browse node\'s ten most positive and ten most negative review topics.
|
|
1007
|
+
* @param {CustomerFeedbackApiGetBrowseNodeReviewTopicsRequest} requestParameters Request parameters.
|
|
1008
|
+
* @param {*} [options] Override http request option.
|
|
1009
|
+
* @throws {RequiredError}
|
|
1010
|
+
*/
|
|
1011
|
+
getBrowseNodeReviewTopics(requestParameters: CustomerFeedbackApiGetBrowseNodeReviewTopicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BrowseNodeReviewTopicsResponse>;
|
|
1012
|
+
/**
|
|
1013
|
+
* Retrieve the positive and negative review trends of items in a browse node for the past six months.
|
|
1014
|
+
* @param {CustomerFeedbackApiGetBrowseNodeReviewTrendsRequest} requestParameters Request parameters.
|
|
1015
|
+
* @param {*} [options] Override http request option.
|
|
1016
|
+
* @throws {RequiredError}
|
|
1017
|
+
*/
|
|
1018
|
+
getBrowseNodeReviewTrends(requestParameters: CustomerFeedbackApiGetBrowseNodeReviewTrendsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BrowseNodeReviewTrendsResponse>;
|
|
1019
|
+
/**
|
|
1020
|
+
* This API returns the associated browse node of the requested ASIN. A browse node is a location in a browse tree that is used for navigation, product classification, and website content on the Amazon retail website.
|
|
1021
|
+
* @param {CustomerFeedbackApiGetItemBrowseNodeRequest} requestParameters Request parameters.
|
|
1022
|
+
* @param {*} [options] Override http request option.
|
|
1023
|
+
* @throws {RequiredError}
|
|
1024
|
+
*/
|
|
1025
|
+
getItemBrowseNode(requestParameters: CustomerFeedbackApiGetItemBrowseNodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<BrowseNodeResponse>;
|
|
1026
|
+
/**
|
|
1027
|
+
* Retrieve an item\'s ten most positive and ten most negative review topics.
|
|
1028
|
+
* @param {CustomerFeedbackApiGetItemReviewTopicsRequest} requestParameters Request parameters.
|
|
1029
|
+
* @param {*} [options] Override http request option.
|
|
1030
|
+
* @throws {RequiredError}
|
|
1031
|
+
*/
|
|
1032
|
+
getItemReviewTopics(requestParameters: CustomerFeedbackApiGetItemReviewTopicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemReviewTopicsResponse>;
|
|
1033
|
+
/**
|
|
1034
|
+
* Retrieve an item\'s positive and negative review trends for the past six months.
|
|
1035
|
+
* @param {CustomerFeedbackApiGetItemReviewTrendsRequest} requestParameters Request parameters.
|
|
1036
|
+
* @param {*} [options] Override http request option.
|
|
1037
|
+
* @throws {RequiredError}
|
|
1038
|
+
*/
|
|
1039
|
+
getItemReviewTrends(requestParameters: CustomerFeedbackApiGetItemReviewTrendsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemReviewTrendsResponse>;
|
|
1040
|
+
};
|
|
1041
|
+
/**
|
|
1042
|
+
* Request parameters for getBrowseNodeReturnTopics operation in CustomerFeedbackApi.
|
|
1043
|
+
*/
|
|
1044
|
+
interface CustomerFeedbackApiGetBrowseNodeReturnTopicsRequest {
|
|
1045
|
+
/**
|
|
1046
|
+
* A browse node ID is a unique identifier for a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
1047
|
+
*/
|
|
1048
|
+
readonly browseNodeId: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
1051
|
+
*/
|
|
1052
|
+
readonly marketplaceId: string;
|
|
1053
|
+
}
|
|
1054
|
+
/**
|
|
1055
|
+
* Request parameters for getBrowseNodeReturnTrends operation in CustomerFeedbackApi.
|
|
1056
|
+
*/
|
|
1057
|
+
interface CustomerFeedbackApiGetBrowseNodeReturnTrendsRequest {
|
|
1058
|
+
/**
|
|
1059
|
+
* A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
1060
|
+
*/
|
|
1061
|
+
readonly browseNodeId: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
1064
|
+
*/
|
|
1065
|
+
readonly marketplaceId: string;
|
|
1066
|
+
}
|
|
1067
|
+
/**
|
|
1068
|
+
* Request parameters for getBrowseNodeReviewTopics operation in CustomerFeedbackApi.
|
|
1069
|
+
*/
|
|
1070
|
+
interface CustomerFeedbackApiGetBrowseNodeReviewTopicsRequest {
|
|
1071
|
+
/**
|
|
1072
|
+
* The ID of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
1073
|
+
*/
|
|
1074
|
+
readonly browseNodeId: string;
|
|
1075
|
+
/**
|
|
1076
|
+
* The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
1077
|
+
*/
|
|
1078
|
+
readonly marketplaceId: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* The metric by which to sort the data in the response.
|
|
1081
|
+
*/
|
|
1082
|
+
readonly sortBy: string;
|
|
1083
|
+
}
|
|
1084
|
+
/**
|
|
1085
|
+
* Request parameters for getBrowseNodeReviewTrends operation in CustomerFeedbackApi.
|
|
1086
|
+
*/
|
|
1087
|
+
interface CustomerFeedbackApiGetBrowseNodeReviewTrendsRequest {
|
|
1088
|
+
/**
|
|
1089
|
+
* A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
|
|
1090
|
+
*/
|
|
1091
|
+
readonly browseNodeId: string;
|
|
1092
|
+
/**
|
|
1093
|
+
* The marketplace ID is the globally unique identifier of a marketplace. For more information, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1094
|
+
*/
|
|
1095
|
+
readonly marketplaceId: string;
|
|
1096
|
+
}
|
|
1097
|
+
/**
|
|
1098
|
+
* Request parameters for getItemBrowseNode operation in CustomerFeedbackApi.
|
|
1099
|
+
*/
|
|
1100
|
+
interface CustomerFeedbackApiGetItemBrowseNodeRequest {
|
|
1101
|
+
/**
|
|
1102
|
+
* The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
1103
|
+
*/
|
|
1104
|
+
readonly asin: string;
|
|
1105
|
+
/**
|
|
1106
|
+
* The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
1107
|
+
*/
|
|
1108
|
+
readonly marketplaceId: string;
|
|
1109
|
+
}
|
|
1110
|
+
/**
|
|
1111
|
+
* Request parameters for getItemReviewTopics operation in CustomerFeedbackApi.
|
|
1112
|
+
*/
|
|
1113
|
+
interface CustomerFeedbackApiGetItemReviewTopicsRequest {
|
|
1114
|
+
/**
|
|
1115
|
+
* The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. The value must be a child ASIN.
|
|
1116
|
+
*/
|
|
1117
|
+
readonly asin: string;
|
|
1118
|
+
/**
|
|
1119
|
+
* The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
1120
|
+
*/
|
|
1121
|
+
readonly marketplaceId: string;
|
|
1122
|
+
/**
|
|
1123
|
+
* The metric by which to sort data in the response.
|
|
1124
|
+
*/
|
|
1125
|
+
readonly sortBy: string;
|
|
1126
|
+
}
|
|
1127
|
+
/**
|
|
1128
|
+
* Request parameters for getItemReviewTrends operation in CustomerFeedbackApi.
|
|
1129
|
+
*/
|
|
1130
|
+
interface CustomerFeedbackApiGetItemReviewTrendsRequest {
|
|
1131
|
+
/**
|
|
1132
|
+
* The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. This API takes child ASIN as an input.
|
|
1133
|
+
*/
|
|
1134
|
+
readonly asin: string;
|
|
1135
|
+
/**
|
|
1136
|
+
* The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
|
|
1137
|
+
*/
|
|
1138
|
+
readonly marketplaceId: string;
|
|
1139
|
+
}
|
|
1140
|
+
/**
|
|
1141
|
+
* CustomerFeedbackApi - object-oriented interface
|
|
1142
|
+
*/
|
|
1143
|
+
declare class CustomerFeedbackApi extends BaseAPI {
|
|
1144
|
+
/**
|
|
1145
|
+
* Retrieve the topics that customers mention when they return items in a browse node.
|
|
1146
|
+
* @param {CustomerFeedbackApiGetBrowseNodeReturnTopicsRequest} requestParameters Request parameters.
|
|
1147
|
+
* @param {*} [options] Override http request option.
|
|
1148
|
+
* @throws {RequiredError}
|
|
1149
|
+
*/
|
|
1150
|
+
getBrowseNodeReturnTopics(requestParameters: CustomerFeedbackApiGetBrowseNodeReturnTopicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrowseNodeReturnTopicsResponse, any, {}>>;
|
|
1151
|
+
/**
|
|
1152
|
+
* Retrieve the trends of topics that customers mention when they return items in a browse node.
|
|
1153
|
+
* @param {CustomerFeedbackApiGetBrowseNodeReturnTrendsRequest} requestParameters Request parameters.
|
|
1154
|
+
* @param {*} [options] Override http request option.
|
|
1155
|
+
* @throws {RequiredError}
|
|
1156
|
+
*/
|
|
1157
|
+
getBrowseNodeReturnTrends(requestParameters: CustomerFeedbackApiGetBrowseNodeReturnTrendsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrowseNodeReturnTrendsResponse, any, {}>>;
|
|
1158
|
+
/**
|
|
1159
|
+
* Retrieve a browse node\'s ten most positive and ten most negative review topics.
|
|
1160
|
+
* @param {CustomerFeedbackApiGetBrowseNodeReviewTopicsRequest} requestParameters Request parameters.
|
|
1161
|
+
* @param {*} [options] Override http request option.
|
|
1162
|
+
* @throws {RequiredError}
|
|
1163
|
+
*/
|
|
1164
|
+
getBrowseNodeReviewTopics(requestParameters: CustomerFeedbackApiGetBrowseNodeReviewTopicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrowseNodeReviewTopicsResponse, any, {}>>;
|
|
1165
|
+
/**
|
|
1166
|
+
* Retrieve the positive and negative review trends of items in a browse node for the past six months.
|
|
1167
|
+
* @param {CustomerFeedbackApiGetBrowseNodeReviewTrendsRequest} requestParameters Request parameters.
|
|
1168
|
+
* @param {*} [options] Override http request option.
|
|
1169
|
+
* @throws {RequiredError}
|
|
1170
|
+
*/
|
|
1171
|
+
getBrowseNodeReviewTrends(requestParameters: CustomerFeedbackApiGetBrowseNodeReviewTrendsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrowseNodeReviewTrendsResponse, any, {}>>;
|
|
1172
|
+
/**
|
|
1173
|
+
* This API returns the associated browse node of the requested ASIN. A browse node is a location in a browse tree that is used for navigation, product classification, and website content on the Amazon retail website.
|
|
1174
|
+
* @param {CustomerFeedbackApiGetItemBrowseNodeRequest} requestParameters Request parameters.
|
|
1175
|
+
* @param {*} [options] Override http request option.
|
|
1176
|
+
* @throws {RequiredError}
|
|
1177
|
+
*/
|
|
1178
|
+
getItemBrowseNode(requestParameters: CustomerFeedbackApiGetItemBrowseNodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrowseNodeResponse, any, {}>>;
|
|
1179
|
+
/**
|
|
1180
|
+
* Retrieve an item\'s ten most positive and ten most negative review topics.
|
|
1181
|
+
* @param {CustomerFeedbackApiGetItemReviewTopicsRequest} requestParameters Request parameters.
|
|
1182
|
+
* @param {*} [options] Override http request option.
|
|
1183
|
+
* @throws {RequiredError}
|
|
1184
|
+
*/
|
|
1185
|
+
getItemReviewTopics(requestParameters: CustomerFeedbackApiGetItemReviewTopicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ItemReviewTopicsResponse, any, {}>>;
|
|
1186
|
+
/**
|
|
1187
|
+
* Retrieve an item\'s positive and negative review trends for the past six months.
|
|
1188
|
+
* @param {CustomerFeedbackApiGetItemReviewTrendsRequest} requestParameters Request parameters.
|
|
1189
|
+
* @param {*} [options] Override http request option.
|
|
1190
|
+
* @throws {RequiredError}
|
|
1191
|
+
*/
|
|
1192
|
+
getItemReviewTrends(requestParameters: CustomerFeedbackApiGetItemReviewTrendsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ItemReviewTrendsResponse, any, {}>>;
|
|
1193
|
+
}
|
|
1194
|
+
//#endregion
|
|
1195
|
+
//#region src/client.d.ts
|
|
1196
|
+
declare const clientRateLimits: RateLimit[];
|
|
1197
|
+
declare class CustomerFeedbackApiClient extends CustomerFeedbackApi {
|
|
1198
|
+
constructor(configuration: ClientConfiguration);
|
|
1199
|
+
}
|
|
1200
|
+
//#endregion
|
|
1201
|
+
export { type BrowseNodeAllOccurrence, type BrowseNodeAllStarRatingImpact, type BrowseNodeOccurrence, type BrowseNodeResponse, type BrowseNodeReturnTopics, type BrowseNodeReturnTopicsResponse, type BrowseNodeReturnTrend, type BrowseNodeReturnTrendPoint, type BrowseNodeReturnTrendsResponse, type BrowseNodeReviewSubtopicMetrics, type BrowseNodeReviewTopic, type BrowseNodeReviewTopicMetrics, type BrowseNodeReviewTopics, type BrowseNodeReviewTopicsResponse, type BrowseNodeReviewTrend, type BrowseNodeReviewTrendMetrics, type BrowseNodeReviewTrendPoint, type BrowseNodeReviewTrends, type BrowseNodeReviewTrendsResponse, type BrowseNodeStarRatingImpact, type BrowseNodeSubtopic, type BrowseNodeTrendMetrics, type ChildAsinMentionMetrics, type ChildAsinMetrics, CustomerFeedbackApi, CustomerFeedbackApiAxiosParamCreator, CustomerFeedbackApiClient, CustomerFeedbackApiFactory, CustomerFeedbackApiFp, CustomerFeedbackApiGetBrowseNodeReturnTopicsRequest, CustomerFeedbackApiGetBrowseNodeReturnTrendsRequest, CustomerFeedbackApiGetBrowseNodeReviewTopicsRequest, CustomerFeedbackApiGetBrowseNodeReviewTrendsRequest, CustomerFeedbackApiGetItemBrowseNodeRequest, CustomerFeedbackApiGetItemReviewTopicsRequest, CustomerFeedbackApiGetItemReviewTrendsRequest, type DateRange, type ErrorList, type ItemReviewBrowseNodeMetrics, type ItemReviewSubtopic, type ItemReviewSubtopicMetrics, type ItemReviewTopic, type ItemReviewTopicMetrics, type ItemReviewTopics, type ItemReviewTopicsResponse, type ItemReviewTrend, type ItemReviewTrendPoint, type ItemReviewTrends, type ItemReviewTrendsResponse, type ModelError, type ReviewTrendMetrics, clientRateLimits };
|
|
1202
|
+
//# sourceMappingURL=index.d.ts.map
|