@sp-api-sdk/data-kiosk-api-2023-11-15 3.0.17 → 4.0.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 +4 -4
- package/dist/index.cjs +611 -0
- package/dist/index.cjs.map +1 -0
- package/dist/{types/api-model/api/data-kiosk-api.d.ts → index.d.cts} +382 -25
- package/dist/index.d.ts +614 -0
- package/dist/index.js +567 -0
- package/dist/index.js.map +1 -0
- package/package.json +23 -12
- package/dist/cjs/api-model/api/data-kiosk-api.js +0 -384
- 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/create-query-response.js +0 -15
- package/dist/cjs/api-model/models/create-query-specification.js +0 -15
- package/dist/cjs/api-model/models/error-list.js +0 -15
- package/dist/cjs/api-model/models/get-document-response.js +0 -15
- package/dist/cjs/api-model/models/get-queries-response-pagination.js +0 -15
- package/dist/cjs/api-model/models/get-queries-response.js +0 -15
- package/dist/cjs/api-model/models/index.js +0 -25
- package/dist/cjs/api-model/models/model-error.js +0 -15
- package/dist/cjs/api-model/models/query-pagination.js +0 -15
- package/dist/cjs/api-model/models/query.js +0 -23
- package/dist/cjs/client.js +0 -49
- package/dist/cjs/index.js +0 -19
- package/dist/es/api-model/api/data-kiosk-api.js +0 -374
- 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/create-query-response.js +0 -14
- package/dist/es/api-model/models/create-query-specification.js +0 -14
- package/dist/es/api-model/models/error-list.js +0 -14
- package/dist/es/api-model/models/get-document-response.js +0 -14
- package/dist/es/api-model/models/get-queries-response-pagination.js +0 -14
- package/dist/es/api-model/models/get-queries-response.js +0 -14
- package/dist/es/api-model/models/index.js +0 -9
- package/dist/es/api-model/models/model-error.js +0 -14
- package/dist/es/api-model/models/query-pagination.js +0 -14
- package/dist/es/api-model/models/query.js +0 -20
- package/dist/es/client.js +0 -45
- package/dist/es/index.js +0 -3
- 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/create-query-response.d.ts +0 -20
- package/dist/types/api-model/models/create-query-specification.d.ts +0 -24
- package/dist/types/api-model/models/error-list.d.ts +0 -20
- package/dist/types/api-model/models/get-document-response.d.ts +0 -24
- package/dist/types/api-model/models/get-queries-response-pagination.d.ts +0 -20
- package/dist/types/api-model/models/get-queries-response.d.ts +0 -23
- package/dist/types/api-model/models/index.d.ts +0 -9
- package/dist/types/api-model/models/model-error.d.ts +0 -28
- package/dist/types/api-model/models/query-pagination.d.ts +0 -20
- package/dist/types/api-model/models/query.d.ts +0 -58
- package/dist/types/client.d.ts +0 -6
- package/dist/types/index.d.ts +0 -3
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
|
|
2
|
+
import * as axios from 'axios';
|
|
3
|
+
import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
|
|
4
|
+
|
|
1
5
|
/**
|
|
2
6
|
* Selling Partner API for Data Kiosk
|
|
3
7
|
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
@@ -9,19 +13,365 @@
|
|
|
9
13
|
* https://openapi-generator.tech
|
|
10
14
|
* Do not edit the class manually.
|
|
11
15
|
*/
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
16
|
+
interface AWSv4Configuration {
|
|
17
|
+
options?: {
|
|
18
|
+
region?: string;
|
|
19
|
+
service?: string;
|
|
20
|
+
};
|
|
21
|
+
credentials?: {
|
|
22
|
+
accessKeyId?: string;
|
|
23
|
+
secretAccessKey?: string;
|
|
24
|
+
sessionToken?: string;
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
interface ConfigurationParameters {
|
|
28
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
|
+
username?: string;
|
|
30
|
+
password?: string;
|
|
31
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
32
|
+
awsv4?: AWSv4Configuration;
|
|
33
|
+
basePath?: string;
|
|
34
|
+
serverIndex?: number;
|
|
35
|
+
baseOptions?: any;
|
|
36
|
+
formDataCtor?: new () => any;
|
|
37
|
+
}
|
|
38
|
+
declare class Configuration {
|
|
39
|
+
/**
|
|
40
|
+
* parameter for apiKey security
|
|
41
|
+
* @param name security name
|
|
42
|
+
*/
|
|
43
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
44
|
+
/**
|
|
45
|
+
* parameter for basic security
|
|
46
|
+
*/
|
|
47
|
+
username?: string;
|
|
48
|
+
/**
|
|
49
|
+
* parameter for basic security
|
|
50
|
+
*/
|
|
51
|
+
password?: string;
|
|
52
|
+
/**
|
|
53
|
+
* parameter for oauth2 security
|
|
54
|
+
* @param name security name
|
|
55
|
+
* @param scopes oauth2 scope
|
|
56
|
+
*/
|
|
57
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
58
|
+
/**
|
|
59
|
+
* parameter for aws4 signature security
|
|
60
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
61
|
+
* @param {string} options.region - aws region
|
|
62
|
+
* @param {string} options.service - name of the service.
|
|
63
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
64
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
65
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
66
|
+
* @memberof Configuration
|
|
67
|
+
*/
|
|
68
|
+
awsv4?: AWSv4Configuration;
|
|
69
|
+
/**
|
|
70
|
+
* override base path
|
|
71
|
+
*/
|
|
72
|
+
basePath?: string;
|
|
73
|
+
/**
|
|
74
|
+
* override server index
|
|
75
|
+
*/
|
|
76
|
+
serverIndex?: number;
|
|
77
|
+
/**
|
|
78
|
+
* base options for axios calls
|
|
79
|
+
*/
|
|
80
|
+
baseOptions?: any;
|
|
81
|
+
/**
|
|
82
|
+
* The FormData constructor that will be used to create multipart form data
|
|
83
|
+
* requests. You can inject this here so that execution environments that
|
|
84
|
+
* do not support the FormData class can still run the generated client.
|
|
85
|
+
*
|
|
86
|
+
* @type {new () => FormData}
|
|
87
|
+
*/
|
|
88
|
+
formDataCtor?: new () => any;
|
|
89
|
+
constructor(param?: ConfigurationParameters);
|
|
90
|
+
/**
|
|
91
|
+
* Check if the given MIME is a JSON MIME.
|
|
92
|
+
* JSON MIME examples:
|
|
93
|
+
* application/json
|
|
94
|
+
* application/json; charset=UTF8
|
|
95
|
+
* APPLICATION/JSON
|
|
96
|
+
* application/vnd.company+json
|
|
97
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
98
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
99
|
+
*/
|
|
100
|
+
isJsonMime(mime: string): boolean;
|
|
101
|
+
}
|
|
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
|
+
|
|
115
|
+
interface RequestArgs {
|
|
116
|
+
url: string;
|
|
117
|
+
options: RawAxiosRequestConfig;
|
|
118
|
+
}
|
|
119
|
+
declare class BaseAPI {
|
|
120
|
+
protected basePath: string;
|
|
121
|
+
protected axios: AxiosInstance;
|
|
122
|
+
protected configuration: Configuration | undefined;
|
|
123
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* Selling Partner API for Data Kiosk
|
|
128
|
+
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
129
|
+
*
|
|
130
|
+
* The version of the OpenAPI document: 2023-11-15
|
|
131
|
+
*
|
|
132
|
+
*
|
|
133
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
134
|
+
* https://openapi-generator.tech
|
|
135
|
+
* Do not edit the class manually.
|
|
136
|
+
*/
|
|
137
|
+
/**
|
|
138
|
+
* The response for the `createQuery` operation.
|
|
139
|
+
*/
|
|
140
|
+
interface CreateQueryResponse {
|
|
141
|
+
/**
|
|
142
|
+
* The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
|
|
143
|
+
*/
|
|
144
|
+
'queryId': string;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Selling Partner API for Data Kiosk
|
|
149
|
+
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
150
|
+
*
|
|
151
|
+
* The version of the OpenAPI document: 2023-11-15
|
|
152
|
+
*
|
|
153
|
+
*
|
|
154
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
155
|
+
* https://openapi-generator.tech
|
|
156
|
+
* Do not edit the class manually.
|
|
157
|
+
*/
|
|
158
|
+
/**
|
|
159
|
+
* Information required to create the query.
|
|
160
|
+
*/
|
|
161
|
+
interface CreateQuerySpecification {
|
|
162
|
+
/**
|
|
163
|
+
* The GraphQL query to submit. A query must be at most 8000 characters after unnecessary whitespace is removed.
|
|
164
|
+
*/
|
|
165
|
+
'query': string;
|
|
166
|
+
/**
|
|
167
|
+
* 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.
|
|
168
|
+
*/
|
|
169
|
+
'paginationToken'?: string;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* Selling Partner API for Data Kiosk
|
|
174
|
+
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
175
|
+
*
|
|
176
|
+
* The version of the OpenAPI document: 2023-11-15
|
|
177
|
+
*
|
|
178
|
+
*
|
|
179
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
180
|
+
* https://openapi-generator.tech
|
|
181
|
+
* Do not edit the class manually.
|
|
182
|
+
*/
|
|
183
|
+
/**
|
|
184
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
185
|
+
*/
|
|
186
|
+
interface ErrorList {
|
|
187
|
+
/**
|
|
188
|
+
* Error response returned when the request is unsuccessful.
|
|
189
|
+
*/
|
|
190
|
+
'errors': Array<Error>;
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* Selling Partner API for Data Kiosk
|
|
195
|
+
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
196
|
+
*
|
|
197
|
+
* The version of the OpenAPI document: 2023-11-15
|
|
198
|
+
*
|
|
199
|
+
*
|
|
200
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
201
|
+
* https://openapi-generator.tech
|
|
202
|
+
* Do not edit the class manually.
|
|
203
|
+
*/
|
|
204
|
+
/**
|
|
205
|
+
* The response for the `getDocument` operation.
|
|
206
|
+
*/
|
|
207
|
+
interface GetDocumentResponse {
|
|
208
|
+
/**
|
|
209
|
+
* The identifier for the Data Kiosk document. This identifier is unique only in combination with a selling partner account ID.
|
|
210
|
+
*/
|
|
211
|
+
'documentId': string;
|
|
212
|
+
/**
|
|
213
|
+
* 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.
|
|
214
|
+
*/
|
|
215
|
+
'documentUrl': string;
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
/**
|
|
219
|
+
* Selling Partner API for Data Kiosk
|
|
220
|
+
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
221
|
+
*
|
|
222
|
+
* The version of the OpenAPI document: 2023-11-15
|
|
223
|
+
*
|
|
224
|
+
*
|
|
225
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
226
|
+
* https://openapi-generator.tech
|
|
227
|
+
* Do not edit the class manually.
|
|
228
|
+
*/
|
|
229
|
+
/**
|
|
230
|
+
* 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
|
+
*/
|
|
232
|
+
interface GetQueriesResponsePagination {
|
|
233
|
+
/**
|
|
234
|
+
* A token that can be used to fetch the next page of results.
|
|
235
|
+
*/
|
|
236
|
+
'nextToken'?: string;
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* Selling Partner API for Data Kiosk
|
|
241
|
+
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
242
|
+
*
|
|
243
|
+
* The version of the OpenAPI document: 2023-11-15
|
|
244
|
+
*
|
|
245
|
+
*
|
|
246
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
247
|
+
* https://openapi-generator.tech
|
|
248
|
+
* Do not edit the class manually.
|
|
249
|
+
*/
|
|
250
|
+
/**
|
|
251
|
+
* 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
|
+
*/
|
|
253
|
+
interface QueryPagination {
|
|
254
|
+
/**
|
|
255
|
+
* A token that can be used to fetch the next page of results.
|
|
256
|
+
*/
|
|
257
|
+
'nextToken'?: string;
|
|
258
|
+
}
|
|
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
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Detailed information about the query.
|
|
274
|
+
*/
|
|
275
|
+
interface Query {
|
|
276
|
+
/**
|
|
277
|
+
* The query identifier. This identifier is unique only in combination with a selling partner account ID.
|
|
278
|
+
*/
|
|
279
|
+
'queryId': string;
|
|
280
|
+
/**
|
|
281
|
+
* The submitted query.
|
|
282
|
+
*/
|
|
283
|
+
'query': string;
|
|
284
|
+
/**
|
|
285
|
+
* The date and time when the query was created, in ISO 8601 date time format.
|
|
286
|
+
*/
|
|
287
|
+
'createdTime': string;
|
|
288
|
+
/**
|
|
289
|
+
* The processing status of the query.
|
|
290
|
+
*/
|
|
291
|
+
'processingStatus': QueryProcessingStatusEnum;
|
|
292
|
+
/**
|
|
293
|
+
* The date and time when the query processing started, in ISO 8601 date time format.
|
|
294
|
+
*/
|
|
295
|
+
'processingStartTime'?: string;
|
|
296
|
+
/**
|
|
297
|
+
* The date and time when the query processing completed, in ISO 8601 date time format.
|
|
298
|
+
*/
|
|
299
|
+
'processingEndTime'?: string;
|
|
300
|
+
/**
|
|
301
|
+
* 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.
|
|
302
|
+
*/
|
|
303
|
+
'dataDocumentId'?: string;
|
|
304
|
+
/**
|
|
305
|
+
* 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.
|
|
306
|
+
*/
|
|
307
|
+
'errorDocumentId'?: string;
|
|
308
|
+
'pagination'?: QueryPagination;
|
|
309
|
+
}
|
|
310
|
+
declare const QueryProcessingStatusEnum: {
|
|
311
|
+
readonly Cancelled: "CANCELLED";
|
|
312
|
+
readonly Done: "DONE";
|
|
313
|
+
readonly Fatal: "FATAL";
|
|
314
|
+
readonly InProgress: "IN_PROGRESS";
|
|
315
|
+
readonly InQueue: "IN_QUEUE";
|
|
316
|
+
};
|
|
317
|
+
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
|
+
|
|
331
|
+
/**
|
|
332
|
+
* The response for the `getQueries` operation.
|
|
333
|
+
*/
|
|
334
|
+
interface GetQueriesResponse {
|
|
335
|
+
/**
|
|
336
|
+
* A list of queries.
|
|
337
|
+
*/
|
|
338
|
+
'queries': Array<Query>;
|
|
339
|
+
'pagination'?: GetQueriesResponsePagination;
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
/**
|
|
343
|
+
* Selling Partner API for Data Kiosk
|
|
344
|
+
* The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
|
|
345
|
+
*
|
|
346
|
+
* The version of the OpenAPI document: 2023-11-15
|
|
347
|
+
*
|
|
348
|
+
*
|
|
349
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
350
|
+
* https://openapi-generator.tech
|
|
351
|
+
* Do not edit the class manually.
|
|
352
|
+
*/
|
|
353
|
+
/**
|
|
354
|
+
* Error response returned when the request is unsuccessful.
|
|
355
|
+
*/
|
|
356
|
+
interface ModelError {
|
|
357
|
+
/**
|
|
358
|
+
* An error code that identifies the type of error that occurred.
|
|
359
|
+
*/
|
|
360
|
+
'code': string;
|
|
361
|
+
/**
|
|
362
|
+
* A message that describes the error condition.
|
|
363
|
+
*/
|
|
364
|
+
'message': string;
|
|
365
|
+
/**
|
|
366
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
367
|
+
*/
|
|
368
|
+
'details'?: string;
|
|
369
|
+
}
|
|
370
|
+
|
|
21
371
|
/**
|
|
22
372
|
* DataKioskApi - axios parameter creator
|
|
23
373
|
*/
|
|
24
|
-
|
|
374
|
+
declare const DataKioskApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
375
|
/**
|
|
26
376
|
* 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).
|
|
27
377
|
* @param {string} queryId The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
|
|
@@ -65,7 +415,7 @@ export declare const DataKioskApiAxiosParamCreator: (configuration?: Configurati
|
|
|
65
415
|
/**
|
|
66
416
|
* DataKioskApi - functional programming interface
|
|
67
417
|
*/
|
|
68
|
-
|
|
418
|
+
declare const DataKioskApiFp: (configuration?: Configuration) => {
|
|
69
419
|
/**
|
|
70
420
|
* 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).
|
|
71
421
|
* @param {string} queryId The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
|
|
@@ -109,7 +459,7 @@ export declare const DataKioskApiFp: (configuration?: Configuration) => {
|
|
|
109
459
|
/**
|
|
110
460
|
* DataKioskApi - factory interface
|
|
111
461
|
*/
|
|
112
|
-
|
|
462
|
+
declare const DataKioskApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
113
463
|
/**
|
|
114
464
|
* 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).
|
|
115
465
|
* @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
|
|
@@ -149,7 +499,7 @@ export declare const DataKioskApiFactory: (configuration?: Configuration, basePa
|
|
|
149
499
|
/**
|
|
150
500
|
* Request parameters for cancelQuery operation in DataKioskApi.
|
|
151
501
|
*/
|
|
152
|
-
|
|
502
|
+
interface DataKioskApiCancelQueryRequest {
|
|
153
503
|
/**
|
|
154
504
|
* The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
|
|
155
505
|
*/
|
|
@@ -158,7 +508,7 @@ export interface DataKioskApiCancelQueryRequest {
|
|
|
158
508
|
/**
|
|
159
509
|
* Request parameters for createQuery operation in DataKioskApi.
|
|
160
510
|
*/
|
|
161
|
-
|
|
511
|
+
interface DataKioskApiCreateQueryRequest {
|
|
162
512
|
/**
|
|
163
513
|
* The body of the request.
|
|
164
514
|
*/
|
|
@@ -167,7 +517,7 @@ export interface DataKioskApiCreateQueryRequest {
|
|
|
167
517
|
/**
|
|
168
518
|
* Request parameters for getDocument operation in DataKioskApi.
|
|
169
519
|
*/
|
|
170
|
-
|
|
520
|
+
interface DataKioskApiGetDocumentRequest {
|
|
171
521
|
/**
|
|
172
522
|
* The identifier for the Data Kiosk document.
|
|
173
523
|
*/
|
|
@@ -176,7 +526,7 @@ export interface DataKioskApiGetDocumentRequest {
|
|
|
176
526
|
/**
|
|
177
527
|
* Request parameters for getQueries operation in DataKioskApi.
|
|
178
528
|
*/
|
|
179
|
-
|
|
529
|
+
interface DataKioskApiGetQueriesRequest {
|
|
180
530
|
/**
|
|
181
531
|
* A list of processing statuses used to filter queries.
|
|
182
532
|
*/
|
|
@@ -201,7 +551,7 @@ export interface DataKioskApiGetQueriesRequest {
|
|
|
201
551
|
/**
|
|
202
552
|
* Request parameters for getQuery operation in DataKioskApi.
|
|
203
553
|
*/
|
|
204
|
-
|
|
554
|
+
interface DataKioskApiGetQueryRequest {
|
|
205
555
|
/**
|
|
206
556
|
* The query identifier.
|
|
207
557
|
*/
|
|
@@ -210,48 +560,55 @@ export interface DataKioskApiGetQueryRequest {
|
|
|
210
560
|
/**
|
|
211
561
|
* DataKioskApi - object-oriented interface
|
|
212
562
|
*/
|
|
213
|
-
|
|
563
|
+
declare class DataKioskApi extends BaseAPI {
|
|
214
564
|
/**
|
|
215
565
|
* 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).
|
|
216
566
|
* @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
|
|
217
567
|
* @param {*} [options] Override http request option.
|
|
218
568
|
* @throws {RequiredError}
|
|
219
569
|
*/
|
|
220
|
-
cancelQuery(requestParameters: DataKioskApiCancelQueryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
570
|
+
cancelQuery(requestParameters: DataKioskApiCancelQueryRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
|
|
221
571
|
/**
|
|
222
572
|
* 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).
|
|
223
573
|
* @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
|
|
224
574
|
* @param {*} [options] Override http request option.
|
|
225
575
|
* @throws {RequiredError}
|
|
226
576
|
*/
|
|
227
|
-
createQuery(requestParameters: DataKioskApiCreateQueryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
577
|
+
createQuery(requestParameters: DataKioskApiCreateQueryRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CreateQueryResponse, any, {}>>;
|
|
228
578
|
/**
|
|
229
579
|
* 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).
|
|
230
580
|
* @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
|
|
231
581
|
* @param {*} [options] Override http request option.
|
|
232
582
|
* @throws {RequiredError}
|
|
233
583
|
*/
|
|
234
|
-
getDocument(requestParameters: DataKioskApiGetDocumentRequest, options?: RawAxiosRequestConfig): Promise<
|
|
584
|
+
getDocument(requestParameters: DataKioskApiGetDocumentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetDocumentResponse, any, {}>>;
|
|
235
585
|
/**
|
|
236
586
|
* 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).
|
|
237
587
|
* @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
|
|
238
588
|
* @param {*} [options] Override http request option.
|
|
239
589
|
* @throws {RequiredError}
|
|
240
590
|
*/
|
|
241
|
-
getQueries(requestParameters?: DataKioskApiGetQueriesRequest, options?: RawAxiosRequestConfig): Promise<
|
|
591
|
+
getQueries(requestParameters?: DataKioskApiGetQueriesRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetQueriesResponse, any, {}>>;
|
|
242
592
|
/**
|
|
243
593
|
* 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).
|
|
244
594
|
* @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
|
|
245
595
|
* @param {*} [options] Override http request option.
|
|
246
596
|
* @throws {RequiredError}
|
|
247
597
|
*/
|
|
248
|
-
getQuery(requestParameters: DataKioskApiGetQueryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
598
|
+
getQuery(requestParameters: DataKioskApiGetQueryRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<Query, any, {}>>;
|
|
249
599
|
}
|
|
250
|
-
|
|
600
|
+
declare const GetQueriesProcessingStatusesEnum: {
|
|
251
601
|
readonly Cancelled: "CANCELLED";
|
|
252
602
|
readonly Done: "DONE";
|
|
253
603
|
readonly Fatal: "FATAL";
|
|
254
604
|
readonly InProgress: "IN_PROGRESS";
|
|
255
605
|
readonly InQueue: "IN_QUEUE";
|
|
256
606
|
};
|
|
257
|
-
|
|
607
|
+
type GetQueriesProcessingStatusesEnum = typeof GetQueriesProcessingStatusesEnum[keyof typeof GetQueriesProcessingStatusesEnum];
|
|
608
|
+
|
|
609
|
+
declare const clientRateLimits: RateLimit[];
|
|
610
|
+
declare class DataKioskApiClient extends DataKioskApi {
|
|
611
|
+
constructor(configuration: ClientConfiguration);
|
|
612
|
+
}
|
|
613
|
+
|
|
614
|
+
export { type CreateQueryResponse, type CreateQuerySpecification, DataKioskApi, DataKioskApiAxiosParamCreator, type DataKioskApiCancelQueryRequest, DataKioskApiClient, type DataKioskApiCreateQueryRequest, DataKioskApiFactory, DataKioskApiFp, type DataKioskApiGetDocumentRequest, type DataKioskApiGetQueriesRequest, type DataKioskApiGetQueryRequest, type ErrorList, type GetDocumentResponse, GetQueriesProcessingStatusesEnum, type GetQueriesResponse, type GetQueriesResponsePagination, type ModelError, type Query, type QueryPagination, QueryProcessingStatusEnum, clientRateLimits };
|