@sp-api-sdk/data-kiosk-api-2023-11-15 4.0.0 → 4.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 +3 -4
- package/dist/index.cjs +569 -577
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +393 -417
- package/dist/index.d.ts +393 -417
- package/dist/index.js +544 -539
- package/dist/index.js.map +1 -1
- package/package.json +7 -4
package/dist/index.d.cts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import { ClientConfiguration, RateLimit } from
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
|
|
2
|
+
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
|
+
//#region src/api-model/configuration.d.ts
|
|
5
4
|
/**
|
|
6
5
|
* Selling Partner API for Data Kiosk
|
|
7
6
|
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
@@ -14,115 +13,105 @@ import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
|
|
|
14
13
|
* Do not edit the class manually.
|
|
15
14
|
*/
|
|
16
15
|
interface AWSv4Configuration {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
16
|
+
options?: {
|
|
17
|
+
region?: string;
|
|
18
|
+
service?: string;
|
|
19
|
+
};
|
|
20
|
+
credentials?: {
|
|
21
|
+
accessKeyId?: string;
|
|
22
|
+
secretAccessKey?: string;
|
|
23
|
+
sessionToken?: string;
|
|
24
|
+
};
|
|
26
25
|
}
|
|
27
26
|
interface ConfigurationParameters {
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
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;
|
|
37
36
|
}
|
|
38
37
|
declare class Configuration {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
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;
|
|
101
100
|
}
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
* Selling Partner API for Data Kiosk
|
|
105
|
-
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
106
|
-
*
|
|
107
|
-
* The version of the OpenAPI document: 2023-11-15
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
111
|
-
* https://openapi-generator.tech
|
|
112
|
-
* Do not edit the class manually.
|
|
113
|
-
*/
|
|
114
|
-
|
|
101
|
+
//#endregion
|
|
102
|
+
//#region src/api-model/base.d.ts
|
|
115
103
|
interface RequestArgs {
|
|
116
|
-
|
|
117
|
-
|
|
104
|
+
url: string;
|
|
105
|
+
options: RawAxiosRequestConfig;
|
|
118
106
|
}
|
|
119
107
|
declare class BaseAPI {
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
108
|
+
protected basePath: string;
|
|
109
|
+
protected axios: AxiosInstance;
|
|
110
|
+
protected configuration: Configuration | undefined;
|
|
111
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
124
112
|
}
|
|
125
|
-
|
|
113
|
+
//#endregion
|
|
114
|
+
//#region src/api-model/models/create-query-response.d.ts
|
|
126
115
|
/**
|
|
127
116
|
* Selling Partner API for Data Kiosk
|
|
128
117
|
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
@@ -138,12 +127,13 @@ declare class BaseAPI {
|
|
|
138
127
|
* The response for the `createQuery` operation.
|
|
139
128
|
*/
|
|
140
129
|
interface CreateQueryResponse {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
130
|
+
/**
|
|
131
|
+
* The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
|
|
132
|
+
*/
|
|
133
|
+
'queryId': string;
|
|
145
134
|
}
|
|
146
|
-
|
|
135
|
+
//#endregion
|
|
136
|
+
//#region src/api-model/models/create-query-specification.d.ts
|
|
147
137
|
/**
|
|
148
138
|
* Selling Partner API for Data Kiosk
|
|
149
139
|
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
@@ -159,16 +149,17 @@ interface CreateQueryResponse {
|
|
|
159
149
|
* Information required to create the query.
|
|
160
150
|
*/
|
|
161
151
|
interface CreateQuerySpecification {
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
152
|
+
/**
|
|
153
|
+
* The GraphQL query to submit. A query must be at most 8000 characters after unnecessary whitespace is removed.
|
|
154
|
+
*/
|
|
155
|
+
'query': string;
|
|
156
|
+
/**
|
|
157
|
+
* A token to fetch a certain page of query results when there are multiple pages of query results available. The value of this token must be fetched from the `pagination.nextToken` field of the `Query` object, and the `query` field for this object must also be set to the `query` field of the same `Query` object. A `Query` object can be retrieved from either the `getQueries` or `getQuery` operation. In the absence of this token value, the first page of query results will be requested.
|
|
158
|
+
*/
|
|
159
|
+
'paginationToken'?: string;
|
|
170
160
|
}
|
|
171
|
-
|
|
161
|
+
//#endregion
|
|
162
|
+
//#region src/api-model/models/error-list.d.ts
|
|
172
163
|
/**
|
|
173
164
|
* Selling Partner API for Data Kiosk
|
|
174
165
|
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
@@ -184,12 +175,13 @@ interface CreateQuerySpecification {
|
|
|
184
175
|
* A list of error responses returned when a request is unsuccessful.
|
|
185
176
|
*/
|
|
186
177
|
interface ErrorList {
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
178
|
+
/**
|
|
179
|
+
* Error response returned when the request is unsuccessful.
|
|
180
|
+
*/
|
|
181
|
+
'errors': Array<Error>;
|
|
191
182
|
}
|
|
192
|
-
|
|
183
|
+
//#endregion
|
|
184
|
+
//#region src/api-model/models/get-document-response.d.ts
|
|
193
185
|
/**
|
|
194
186
|
* Selling Partner API for Data Kiosk
|
|
195
187
|
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
@@ -205,16 +197,17 @@ interface ErrorList {
|
|
|
205
197
|
* The response for the `getDocument` operation.
|
|
206
198
|
*/
|
|
207
199
|
interface GetDocumentResponse {
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
200
|
+
/**
|
|
201
|
+
* The identifier for the Data Kiosk document. This identifier is unique only in combination with a selling partner account ID.
|
|
202
|
+
*/
|
|
203
|
+
'documentId': string;
|
|
204
|
+
/**
|
|
205
|
+
* A presigned URL that can be used to retrieve the Data Kiosk document. This URL expires after 5 minutes. If the Data Kiosk document is compressed, the `Content-Encoding` header will indicate the compression algorithm. **Note:** Most HTTP clients are capable of automatically decompressing downloaded files based on the `Content-Encoding` header.
|
|
206
|
+
*/
|
|
207
|
+
'documentUrl': string;
|
|
216
208
|
}
|
|
217
|
-
|
|
209
|
+
//#endregion
|
|
210
|
+
//#region src/api-model/models/get-queries-response-pagination.d.ts
|
|
218
211
|
/**
|
|
219
212
|
* Selling Partner API for Data Kiosk
|
|
220
213
|
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
@@ -230,12 +223,13 @@ interface GetDocumentResponse {
|
|
|
230
223
|
* When a request has results that are not included in this response, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass the `nextToken` as the `paginationToken` query parameter in the subsequent `getQueries` request. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. When there are no more pages to fetch, the `nextToken` field will be absent.
|
|
231
224
|
*/
|
|
232
225
|
interface GetQueriesResponsePagination {
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
226
|
+
/**
|
|
227
|
+
* A token that can be used to fetch the next page of results.
|
|
228
|
+
*/
|
|
229
|
+
'nextToken'?: string;
|
|
237
230
|
}
|
|
238
|
-
|
|
231
|
+
//#endregion
|
|
232
|
+
//#region src/api-model/models/query-pagination.d.ts
|
|
239
233
|
/**
|
|
240
234
|
* Selling Partner API for Data Kiosk
|
|
241
235
|
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
@@ -251,94 +245,73 @@ interface GetQueriesResponsePagination {
|
|
|
251
245
|
* When a query produces results that are not included in the data document, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass a `CreateQuerySpecification` object with `paginationToken` set to this object\'s `nextToken` and with `query` set to this object\'s `query` in the subsequent `createQuery` request. When there are no more pages to fetch, the `nextToken` field will be absent.
|
|
252
246
|
*/
|
|
253
247
|
interface QueryPagination {
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
248
|
+
/**
|
|
249
|
+
* A token that can be used to fetch the next page of results.
|
|
250
|
+
*/
|
|
251
|
+
'nextToken'?: string;
|
|
258
252
|
}
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
* Selling Partner API for Data Kiosk
|
|
262
|
-
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
263
|
-
*
|
|
264
|
-
* The version of the OpenAPI document: 2023-11-15
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
268
|
-
* https://openapi-generator.tech
|
|
269
|
-
* Do not edit the class manually.
|
|
270
|
-
*/
|
|
271
|
-
|
|
253
|
+
//#endregion
|
|
254
|
+
//#region src/api-model/models/query.d.ts
|
|
272
255
|
/**
|
|
273
256
|
* Detailed information about the query.
|
|
274
257
|
*/
|
|
275
258
|
interface Query {
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
259
|
+
/**
|
|
260
|
+
* The query identifier. This identifier is unique only in combination with a selling partner account ID.
|
|
261
|
+
*/
|
|
262
|
+
'queryId': string;
|
|
263
|
+
/**
|
|
264
|
+
* The submitted query.
|
|
265
|
+
*/
|
|
266
|
+
'query': string;
|
|
267
|
+
/**
|
|
268
|
+
* The date and time when the query was created, in ISO 8601 date time format.
|
|
269
|
+
*/
|
|
270
|
+
'createdTime': string;
|
|
271
|
+
/**
|
|
272
|
+
* The processing status of the query.
|
|
273
|
+
*/
|
|
274
|
+
'processingStatus': QueryProcessingStatusEnum;
|
|
275
|
+
/**
|
|
276
|
+
* The date and time when the query processing started, in ISO 8601 date time format.
|
|
277
|
+
*/
|
|
278
|
+
'processingStartTime'?: string;
|
|
279
|
+
/**
|
|
280
|
+
* The date and time when the query processing completed, in ISO 8601 date time format.
|
|
281
|
+
*/
|
|
282
|
+
'processingEndTime'?: string;
|
|
283
|
+
/**
|
|
284
|
+
* The data document identifier. This identifier is only present when there is data available as a result of the query. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the `getDocument` operation to get the information required to retrieve the data document\'s contents.
|
|
285
|
+
*/
|
|
286
|
+
'dataDocumentId'?: string;
|
|
287
|
+
/**
|
|
288
|
+
* The error document identifier. This identifier is only present when an error occurs during query processing. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the `getDocument` operation to get the information required to retrieve the error document\'s contents.
|
|
289
|
+
*/
|
|
290
|
+
'errorDocumentId'?: string;
|
|
291
|
+
'pagination'?: QueryPagination;
|
|
309
292
|
}
|
|
310
293
|
declare const QueryProcessingStatusEnum: {
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
294
|
+
readonly Cancelled: "CANCELLED";
|
|
295
|
+
readonly Done: "DONE";
|
|
296
|
+
readonly Fatal: "FATAL";
|
|
297
|
+
readonly InProgress: "IN_PROGRESS";
|
|
298
|
+
readonly InQueue: "IN_QUEUE";
|
|
316
299
|
};
|
|
317
300
|
type QueryProcessingStatusEnum = typeof QueryProcessingStatusEnum[keyof typeof QueryProcessingStatusEnum];
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
* Selling Partner API for Data Kiosk
|
|
321
|
-
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
322
|
-
*
|
|
323
|
-
* The version of the OpenAPI document: 2023-11-15
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
327
|
-
* https://openapi-generator.tech
|
|
328
|
-
* Do not edit the class manually.
|
|
329
|
-
*/
|
|
330
|
-
|
|
301
|
+
//#endregion
|
|
302
|
+
//#region src/api-model/models/get-queries-response.d.ts
|
|
331
303
|
/**
|
|
332
304
|
* The response for the `getQueries` operation.
|
|
333
305
|
*/
|
|
334
306
|
interface GetQueriesResponse {
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
307
|
+
/**
|
|
308
|
+
* A list of queries.
|
|
309
|
+
*/
|
|
310
|
+
'queries': Array<Query>;
|
|
311
|
+
'pagination'?: GetQueriesResponsePagination;
|
|
340
312
|
}
|
|
341
|
-
|
|
313
|
+
//#endregion
|
|
314
|
+
//#region src/api-model/models/model-error.d.ts
|
|
342
315
|
/**
|
|
343
316
|
* Selling Partner API for Data Kiosk
|
|
344
317
|
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
@@ -354,261 +327,264 @@ interface GetQueriesResponse {
|
|
|
354
327
|
* Error response returned when the request is unsuccessful.
|
|
355
328
|
*/
|
|
356
329
|
interface ModelError {
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
330
|
+
/**
|
|
331
|
+
* An error code that identifies the type of error that occurred.
|
|
332
|
+
*/
|
|
333
|
+
'code': string;
|
|
334
|
+
/**
|
|
335
|
+
* A message that describes the error condition.
|
|
336
|
+
*/
|
|
337
|
+
'message': string;
|
|
338
|
+
/**
|
|
339
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
340
|
+
*/
|
|
341
|
+
'details'?: string;
|
|
369
342
|
}
|
|
370
|
-
|
|
343
|
+
//#endregion
|
|
344
|
+
//#region src/api-model/api/data-kiosk-api.d.ts
|
|
371
345
|
/**
|
|
372
346
|
* DataKioskApi - axios parameter creator
|
|
373
347
|
*/
|
|
374
348
|
declare const DataKioskApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
349
|
+
/**
|
|
350
|
+
* Cancels the query specified by the `queryId` parameter. Only queries with a non-terminal `processingStatus` (`IN_QUEUE`, `IN_PROGRESS`) can be cancelled. Cancelling a query that already has a `processingStatus` of `CANCELLED` will no-op. Cancelled queries are returned in subsequent calls to the `getQuery` and `getQueries` operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
351
|
+
* @param {string} queryId The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
|
|
352
|
+
* @param {*} [options] Override http request option.
|
|
353
|
+
* @throws {RequiredError}
|
|
354
|
+
*/
|
|
355
|
+
cancelQuery: (queryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
356
|
+
/**
|
|
357
|
+
* Creates a Data Kiosk query request. **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
358
|
+
* @param {CreateQuerySpecification} body The body of the request.
|
|
359
|
+
* @param {*} [options] Override http request option.
|
|
360
|
+
* @throws {RequiredError}
|
|
361
|
+
*/
|
|
362
|
+
createQuery: (body: CreateQuerySpecification, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
363
|
+
/**
|
|
364
|
+
* Returns the information required for retrieving a Data Kiosk document\'s contents. See the `createQuery` operation for details about document retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
365
|
+
* @param {string} documentId The identifier for the Data Kiosk document.
|
|
366
|
+
* @param {*} [options] Override http request option.
|
|
367
|
+
* @throws {RequiredError}
|
|
368
|
+
*/
|
|
369
|
+
getDocument: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
370
|
+
/**
|
|
371
|
+
* Returns details for the Data Kiosk queries that match the specified filters. See the `createQuery` operation for details about query retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
372
|
+
* @param {Array<GetQueriesProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter queries.
|
|
373
|
+
* @param {number} [pageSize] The maximum number of queries to return in a single call.
|
|
374
|
+
* @param {string} [createdSince] The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
|
|
375
|
+
* @param {string} [createdUntil] The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.
|
|
376
|
+
* @param {string} [paginationToken] A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the `pagination.nextToken` field returned in the `GetQueriesResponse` object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. In the absence of this token value, `getQueries` returns the first page of results.
|
|
377
|
+
* @param {*} [options] Override http request option.
|
|
378
|
+
* @throws {RequiredError}
|
|
379
|
+
*/
|
|
380
|
+
getQueries: (processingStatuses?: Array<GetQueriesProcessingStatusesEnum>, pageSize?: number, createdSince?: string, createdUntil?: string, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
381
|
+
/**
|
|
382
|
+
* Returns query details for the query specified by the `queryId` parameter. See the `createQuery` operation for details about query retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2.0 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
383
|
+
* @param {string} queryId The query identifier.
|
|
384
|
+
* @param {*} [options] Override http request option.
|
|
385
|
+
* @throws {RequiredError}
|
|
386
|
+
*/
|
|
387
|
+
getQuery: (queryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
414
388
|
};
|
|
415
389
|
/**
|
|
416
390
|
* DataKioskApi - functional programming interface
|
|
417
391
|
*/
|
|
418
392
|
declare const DataKioskApiFp: (configuration?: Configuration) => {
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
393
|
+
/**
|
|
394
|
+
* Cancels the query specified by the `queryId` parameter. Only queries with a non-terminal `processingStatus` (`IN_QUEUE`, `IN_PROGRESS`) can be cancelled. Cancelling a query that already has a `processingStatus` of `CANCELLED` will no-op. Cancelled queries are returned in subsequent calls to the `getQuery` and `getQueries` operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
395
|
+
* @param {string} queryId The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
|
|
396
|
+
* @param {*} [options] Override http request option.
|
|
397
|
+
* @throws {RequiredError}
|
|
398
|
+
*/
|
|
399
|
+
cancelQuery(queryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
400
|
+
/**
|
|
401
|
+
* Creates a Data Kiosk query request. **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
402
|
+
* @param {CreateQuerySpecification} body The body of the request.
|
|
403
|
+
* @param {*} [options] Override http request option.
|
|
404
|
+
* @throws {RequiredError}
|
|
405
|
+
*/
|
|
406
|
+
createQuery(body: CreateQuerySpecification, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateQueryResponse>>;
|
|
407
|
+
/**
|
|
408
|
+
* Returns the information required for retrieving a Data Kiosk document\'s contents. See the `createQuery` operation for details about document retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
409
|
+
* @param {string} documentId The identifier for the Data Kiosk document.
|
|
410
|
+
* @param {*} [options] Override http request option.
|
|
411
|
+
* @throws {RequiredError}
|
|
412
|
+
*/
|
|
413
|
+
getDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentResponse>>;
|
|
414
|
+
/**
|
|
415
|
+
* Returns details for the Data Kiosk queries that match the specified filters. See the `createQuery` operation for details about query retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
416
|
+
* @param {Array<GetQueriesProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter queries.
|
|
417
|
+
* @param {number} [pageSize] The maximum number of queries to return in a single call.
|
|
418
|
+
* @param {string} [createdSince] The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
|
|
419
|
+
* @param {string} [createdUntil] The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.
|
|
420
|
+
* @param {string} [paginationToken] A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the `pagination.nextToken` field returned in the `GetQueriesResponse` object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. In the absence of this token value, `getQueries` returns the first page of results.
|
|
421
|
+
* @param {*} [options] Override http request option.
|
|
422
|
+
* @throws {RequiredError}
|
|
423
|
+
*/
|
|
424
|
+
getQueries(processingStatuses?: Array<GetQueriesProcessingStatusesEnum>, pageSize?: number, createdSince?: string, createdUntil?: string, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQueriesResponse>>;
|
|
425
|
+
/**
|
|
426
|
+
* Returns query details for the query specified by the `queryId` parameter. See the `createQuery` operation for details about query retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2.0 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
427
|
+
* @param {string} queryId The query identifier.
|
|
428
|
+
* @param {*} [options] Override http request option.
|
|
429
|
+
* @throws {RequiredError}
|
|
430
|
+
*/
|
|
431
|
+
getQuery(queryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Query>>;
|
|
458
432
|
};
|
|
459
433
|
/**
|
|
460
434
|
* DataKioskApi - factory interface
|
|
461
435
|
*/
|
|
462
436
|
declare const DataKioskApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
437
|
+
/**
|
|
438
|
+
* Cancels the query specified by the `queryId` parameter. Only queries with a non-terminal `processingStatus` (`IN_QUEUE`, `IN_PROGRESS`) can be cancelled. Cancelling a query that already has a `processingStatus` of `CANCELLED` will no-op. Cancelled queries are returned in subsequent calls to the `getQuery` and `getQueries` operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
439
|
+
* @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
|
|
440
|
+
* @param {*} [options] Override http request option.
|
|
441
|
+
* @throws {RequiredError}
|
|
442
|
+
*/
|
|
443
|
+
cancelQuery(requestParameters: DataKioskApiCancelQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
444
|
+
/**
|
|
445
|
+
* Creates a Data Kiosk query request. **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
446
|
+
* @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
|
|
447
|
+
* @param {*} [options] Override http request option.
|
|
448
|
+
* @throws {RequiredError}
|
|
449
|
+
*/
|
|
450
|
+
createQuery(requestParameters: DataKioskApiCreateQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateQueryResponse>;
|
|
451
|
+
/**
|
|
452
|
+
* Returns the information required for retrieving a Data Kiosk document\'s contents. See the `createQuery` operation for details about document retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
453
|
+
* @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
|
|
454
|
+
* @param {*} [options] Override http request option.
|
|
455
|
+
* @throws {RequiredError}
|
|
456
|
+
*/
|
|
457
|
+
getDocument(requestParameters: DataKioskApiGetDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDocumentResponse>;
|
|
458
|
+
/**
|
|
459
|
+
* Returns details for the Data Kiosk queries that match the specified filters. See the `createQuery` operation for details about query retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
460
|
+
* @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
|
|
461
|
+
* @param {*} [options] Override http request option.
|
|
462
|
+
* @throws {RequiredError}
|
|
463
|
+
*/
|
|
464
|
+
getQueries(requestParameters?: DataKioskApiGetQueriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetQueriesResponse>;
|
|
465
|
+
/**
|
|
466
|
+
* Returns query details for the query specified by the `queryId` parameter. See the `createQuery` operation for details about query retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2.0 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
467
|
+
* @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
|
|
468
|
+
* @param {*} [options] Override http request option.
|
|
469
|
+
* @throws {RequiredError}
|
|
470
|
+
*/
|
|
471
|
+
getQuery(requestParameters: DataKioskApiGetQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Query>;
|
|
498
472
|
};
|
|
499
473
|
/**
|
|
500
474
|
* Request parameters for cancelQuery operation in DataKioskApi.
|
|
501
475
|
*/
|
|
502
476
|
interface DataKioskApiCancelQueryRequest {
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
477
|
+
/**
|
|
478
|
+
* The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
|
|
479
|
+
*/
|
|
480
|
+
readonly queryId: string;
|
|
507
481
|
}
|
|
508
482
|
/**
|
|
509
483
|
* Request parameters for createQuery operation in DataKioskApi.
|
|
510
484
|
*/
|
|
511
485
|
interface DataKioskApiCreateQueryRequest {
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
486
|
+
/**
|
|
487
|
+
* The body of the request.
|
|
488
|
+
*/
|
|
489
|
+
readonly body: CreateQuerySpecification;
|
|
516
490
|
}
|
|
517
491
|
/**
|
|
518
492
|
* Request parameters for getDocument operation in DataKioskApi.
|
|
519
493
|
*/
|
|
520
494
|
interface DataKioskApiGetDocumentRequest {
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
495
|
+
/**
|
|
496
|
+
* The identifier for the Data Kiosk document.
|
|
497
|
+
*/
|
|
498
|
+
readonly documentId: string;
|
|
525
499
|
}
|
|
526
500
|
/**
|
|
527
501
|
* Request parameters for getQueries operation in DataKioskApi.
|
|
528
502
|
*/
|
|
529
503
|
interface DataKioskApiGetQueriesRequest {
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
504
|
+
/**
|
|
505
|
+
* A list of processing statuses used to filter queries.
|
|
506
|
+
*/
|
|
507
|
+
readonly processingStatuses?: Array<GetQueriesProcessingStatusesEnum>;
|
|
508
|
+
/**
|
|
509
|
+
* The maximum number of queries to return in a single call.
|
|
510
|
+
*/
|
|
511
|
+
readonly pageSize?: number;
|
|
512
|
+
/**
|
|
513
|
+
* The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
|
|
514
|
+
*/
|
|
515
|
+
readonly createdSince?: string;
|
|
516
|
+
/**
|
|
517
|
+
* The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.
|
|
518
|
+
*/
|
|
519
|
+
readonly createdUntil?: string;
|
|
520
|
+
/**
|
|
521
|
+
* A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the `pagination.nextToken` field returned in the `GetQueriesResponse` object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. In the absence of this token value, `getQueries` returns the first page of results.
|
|
522
|
+
*/
|
|
523
|
+
readonly paginationToken?: string;
|
|
550
524
|
}
|
|
551
525
|
/**
|
|
552
526
|
* Request parameters for getQuery operation in DataKioskApi.
|
|
553
527
|
*/
|
|
554
528
|
interface DataKioskApiGetQueryRequest {
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
529
|
+
/**
|
|
530
|
+
* The query identifier.
|
|
531
|
+
*/
|
|
532
|
+
readonly queryId: string;
|
|
559
533
|
}
|
|
560
534
|
/**
|
|
561
535
|
* DataKioskApi - object-oriented interface
|
|
562
536
|
*/
|
|
563
537
|
declare class DataKioskApi extends BaseAPI {
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
538
|
+
/**
|
|
539
|
+
* Cancels the query specified by the `queryId` parameter. Only queries with a non-terminal `processingStatus` (`IN_QUEUE`, `IN_PROGRESS`) can be cancelled. Cancelling a query that already has a `processingStatus` of `CANCELLED` will no-op. Cancelled queries are returned in subsequent calls to the `getQuery` and `getQueries` operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
540
|
+
* @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
|
|
541
|
+
* @param {*} [options] Override http request option.
|
|
542
|
+
* @throws {RequiredError}
|
|
543
|
+
*/
|
|
544
|
+
cancelQuery(requestParameters: DataKioskApiCancelQueryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
545
|
+
/**
|
|
546
|
+
* Creates a Data Kiosk query request. **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
547
|
+
* @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
|
|
548
|
+
* @param {*} [options] Override http request option.
|
|
549
|
+
* @throws {RequiredError}
|
|
550
|
+
*/
|
|
551
|
+
createQuery(requestParameters: DataKioskApiCreateQueryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateQueryResponse, any, {}>>;
|
|
552
|
+
/**
|
|
553
|
+
* Returns the information required for retrieving a Data Kiosk document\'s contents. See the `createQuery` operation for details about document retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
554
|
+
* @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
|
|
555
|
+
* @param {*} [options] Override http request option.
|
|
556
|
+
* @throws {RequiredError}
|
|
557
|
+
*/
|
|
558
|
+
getDocument(requestParameters: DataKioskApiGetDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocumentResponse, any, {}>>;
|
|
559
|
+
/**
|
|
560
|
+
* Returns details for the Data Kiosk queries that match the specified filters. See the `createQuery` operation for details about query retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
561
|
+
* @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
|
|
562
|
+
* @param {*} [options] Override http request option.
|
|
563
|
+
* @throws {RequiredError}
|
|
564
|
+
*/
|
|
565
|
+
getQueries(requestParameters?: DataKioskApiGetQueriesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQueriesResponse, any, {}>>;
|
|
566
|
+
/**
|
|
567
|
+
* Returns query details for the query specified by the `queryId` parameter. See the `createQuery` operation for details about query retention. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2.0 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
568
|
+
* @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
|
|
569
|
+
* @param {*} [options] Override http request option.
|
|
570
|
+
* @throws {RequiredError}
|
|
571
|
+
*/
|
|
572
|
+
getQuery(requestParameters: DataKioskApiGetQueryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Query, any, {}>>;
|
|
599
573
|
}
|
|
600
574
|
declare const GetQueriesProcessingStatusesEnum: {
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
575
|
+
readonly Cancelled: "CANCELLED";
|
|
576
|
+
readonly Done: "DONE";
|
|
577
|
+
readonly Fatal: "FATAL";
|
|
578
|
+
readonly InProgress: "IN_PROGRESS";
|
|
579
|
+
readonly InQueue: "IN_QUEUE";
|
|
606
580
|
};
|
|
607
581
|
type GetQueriesProcessingStatusesEnum = typeof GetQueriesProcessingStatusesEnum[keyof typeof GetQueriesProcessingStatusesEnum];
|
|
608
|
-
|
|
582
|
+
//#endregion
|
|
583
|
+
//#region src/client.d.ts
|
|
609
584
|
declare const clientRateLimits: RateLimit[];
|
|
610
585
|
declare class DataKioskApiClient extends DataKioskApi {
|
|
611
|
-
|
|
586
|
+
constructor(configuration: ClientConfiguration);
|
|
612
587
|
}
|
|
613
|
-
|
|
614
|
-
export {
|
|
588
|
+
//#endregion
|
|
589
|
+
export { CreateQueryResponse, CreateQuerySpecification, DataKioskApi, DataKioskApiAxiosParamCreator, DataKioskApiCancelQueryRequest, DataKioskApiClient, DataKioskApiCreateQueryRequest, DataKioskApiFactory, DataKioskApiFp, DataKioskApiGetDocumentRequest, DataKioskApiGetQueriesRequest, DataKioskApiGetQueryRequest, ErrorList, GetDocumentResponse, GetQueriesProcessingStatusesEnum, GetQueriesResponse, GetQueriesResponsePagination, ModelError, Query, QueryPagination, QueryProcessingStatusEnum, clientRateLimits };
|
|
590
|
+
//# sourceMappingURL=index.d.cts.map
|