@sp-api-sdk/data-kiosk-api-2023-11-15 2.0.4 → 3.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.
@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
16
16
  return (mod && mod.__esModule) ? mod : { "default": mod };
17
17
  };
18
18
  Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.GetQueriesProcessingStatusesEnum = exports.QueriesApi = exports.QueriesApiFactory = exports.QueriesApiFp = exports.QueriesApiAxiosParamCreator = void 0;
19
+ exports.GetQueriesProcessingStatusesEnum = exports.DataKioskApi = exports.DataKioskApiFactory = exports.DataKioskApiFp = exports.DataKioskApiAxiosParamCreator = void 0;
20
20
  const axios_1 = __importDefault(require("axios"));
21
21
  // Some imports not used depending on template conditions
22
22
  // @ts-ignore
@@ -24,10 +24,10 @@ const common_1 = require("../common");
24
24
  // @ts-ignore
25
25
  const base_1 = require("../base");
26
26
  /**
27
- * QueriesApi - axios parameter creator
27
+ * DataKioskApi - axios parameter creator
28
28
  * @export
29
29
  */
30
- const QueriesApiAxiosParamCreator = function (configuration) {
30
+ const DataKioskApiAxiosParamCreator = function (configuration) {
31
31
  return {
32
32
  /**
33
33
  * 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).
@@ -192,13 +192,13 @@ const QueriesApiAxiosParamCreator = function (configuration) {
192
192
  },
193
193
  };
194
194
  };
195
- exports.QueriesApiAxiosParamCreator = QueriesApiAxiosParamCreator;
195
+ exports.DataKioskApiAxiosParamCreator = DataKioskApiAxiosParamCreator;
196
196
  /**
197
- * QueriesApi - functional programming interface
197
+ * DataKioskApi - functional programming interface
198
198
  * @export
199
199
  */
200
- const QueriesApiFp = function (configuration) {
201
- const localVarAxiosParamCreator = (0, exports.QueriesApiAxiosParamCreator)(configuration);
200
+ const DataKioskApiFp = function (configuration) {
201
+ const localVarAxiosParamCreator = (0, exports.DataKioskApiAxiosParamCreator)(configuration);
202
202
  return {
203
203
  /**
204
204
  * 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).
@@ -209,7 +209,7 @@ const QueriesApiFp = function (configuration) {
209
209
  async cancelQuery(queryId, options) {
210
210
  const localVarAxiosArgs = await localVarAxiosParamCreator.cancelQuery(queryId, options);
211
211
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
212
- const localVarOperationServerBasePath = base_1.operationServerMap['QueriesApi.cancelQuery']?.[localVarOperationServerIndex]?.url;
212
+ const localVarOperationServerBasePath = base_1.operationServerMap['DataKioskApi.cancelQuery']?.[localVarOperationServerIndex]?.url;
213
213
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
214
214
  },
215
215
  /**
@@ -221,7 +221,7 @@ const QueriesApiFp = function (configuration) {
221
221
  async createQuery(body, options) {
222
222
  const localVarAxiosArgs = await localVarAxiosParamCreator.createQuery(body, options);
223
223
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
224
- const localVarOperationServerBasePath = base_1.operationServerMap['QueriesApi.createQuery']?.[localVarOperationServerIndex]?.url;
224
+ const localVarOperationServerBasePath = base_1.operationServerMap['DataKioskApi.createQuery']?.[localVarOperationServerIndex]?.url;
225
225
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
226
226
  },
227
227
  /**
@@ -233,7 +233,7 @@ const QueriesApiFp = function (configuration) {
233
233
  async getDocument(documentId, options) {
234
234
  const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(documentId, options);
235
235
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
236
- const localVarOperationServerBasePath = base_1.operationServerMap['QueriesApi.getDocument']?.[localVarOperationServerIndex]?.url;
236
+ const localVarOperationServerBasePath = base_1.operationServerMap['DataKioskApi.getDocument']?.[localVarOperationServerIndex]?.url;
237
237
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
238
238
  },
239
239
  /**
@@ -249,7 +249,7 @@ const QueriesApiFp = function (configuration) {
249
249
  async getQueries(processingStatuses, pageSize, createdSince, createdUntil, paginationToken, options) {
250
250
  const localVarAxiosArgs = await localVarAxiosParamCreator.getQueries(processingStatuses, pageSize, createdSince, createdUntil, paginationToken, options);
251
251
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
252
- const localVarOperationServerBasePath = base_1.operationServerMap['QueriesApi.getQueries']?.[localVarOperationServerIndex]?.url;
252
+ const localVarOperationServerBasePath = base_1.operationServerMap['DataKioskApi.getQueries']?.[localVarOperationServerIndex]?.url;
253
253
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
254
254
  },
255
255
  /**
@@ -261,22 +261,22 @@ const QueriesApiFp = function (configuration) {
261
261
  async getQuery(queryId, options) {
262
262
  const localVarAxiosArgs = await localVarAxiosParamCreator.getQuery(queryId, options);
263
263
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
264
- const localVarOperationServerBasePath = base_1.operationServerMap['QueriesApi.getQuery']?.[localVarOperationServerIndex]?.url;
264
+ const localVarOperationServerBasePath = base_1.operationServerMap['DataKioskApi.getQuery']?.[localVarOperationServerIndex]?.url;
265
265
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
266
266
  },
267
267
  };
268
268
  };
269
- exports.QueriesApiFp = QueriesApiFp;
269
+ exports.DataKioskApiFp = DataKioskApiFp;
270
270
  /**
271
- * QueriesApi - factory interface
271
+ * DataKioskApi - factory interface
272
272
  * @export
273
273
  */
274
- const QueriesApiFactory = function (configuration, basePath, axios) {
275
- const localVarFp = (0, exports.QueriesApiFp)(configuration);
274
+ const DataKioskApiFactory = function (configuration, basePath, axios) {
275
+ const localVarFp = (0, exports.DataKioskApiFp)(configuration);
276
276
  return {
277
277
  /**
278
278
  * 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).
279
- * @param {QueriesApiCancelQueryRequest} requestParameters Request parameters.
279
+ * @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
280
280
  * @param {*} [options] Override http request option.
281
281
  * @throws {RequiredError}
282
282
  */
@@ -285,7 +285,7 @@ const QueriesApiFactory = function (configuration, basePath, axios) {
285
285
  },
286
286
  /**
287
287
  * 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).
288
- * @param {QueriesApiCreateQueryRequest} requestParameters Request parameters.
288
+ * @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
289
289
  * @param {*} [options] Override http request option.
290
290
  * @throws {RequiredError}
291
291
  */
@@ -294,7 +294,7 @@ const QueriesApiFactory = function (configuration, basePath, axios) {
294
294
  },
295
295
  /**
296
296
  * 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).
297
- * @param {QueriesApiGetDocumentRequest} requestParameters Request parameters.
297
+ * @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
298
298
  * @param {*} [options] Override http request option.
299
299
  * @throws {RequiredError}
300
300
  */
@@ -303,7 +303,7 @@ const QueriesApiFactory = function (configuration, basePath, axios) {
303
303
  },
304
304
  /**
305
305
  * 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).
306
- * @param {QueriesApiGetQueriesRequest} requestParameters Request parameters.
306
+ * @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
307
307
  * @param {*} [options] Override http request option.
308
308
  * @throws {RequiredError}
309
309
  */
@@ -312,7 +312,7 @@ const QueriesApiFactory = function (configuration, basePath, axios) {
312
312
  },
313
313
  /**
314
314
  * 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).
315
- * @param {QueriesApiGetQueryRequest} requestParameters Request parameters.
315
+ * @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
316
316
  * @param {*} [options] Override http request option.
317
317
  * @throws {RequiredError}
318
318
  */
@@ -321,66 +321,66 @@ const QueriesApiFactory = function (configuration, basePath, axios) {
321
321
  },
322
322
  };
323
323
  };
324
- exports.QueriesApiFactory = QueriesApiFactory;
324
+ exports.DataKioskApiFactory = DataKioskApiFactory;
325
325
  /**
326
- * QueriesApi - object-oriented interface
326
+ * DataKioskApi - object-oriented interface
327
327
  * @export
328
- * @class QueriesApi
328
+ * @class DataKioskApi
329
329
  * @extends {BaseAPI}
330
330
  */
331
- class QueriesApi extends base_1.BaseAPI {
331
+ class DataKioskApi extends base_1.BaseAPI {
332
332
  /**
333
333
  * 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).
334
- * @param {QueriesApiCancelQueryRequest} requestParameters Request parameters.
334
+ * @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
335
335
  * @param {*} [options] Override http request option.
336
336
  * @throws {RequiredError}
337
- * @memberof QueriesApi
337
+ * @memberof DataKioskApi
338
338
  */
339
339
  cancelQuery(requestParameters, options) {
340
- return (0, exports.QueriesApiFp)(this.configuration).cancelQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
340
+ return (0, exports.DataKioskApiFp)(this.configuration).cancelQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
341
341
  }
342
342
  /**
343
343
  * 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).
344
- * @param {QueriesApiCreateQueryRequest} requestParameters Request parameters.
344
+ * @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
345
345
  * @param {*} [options] Override http request option.
346
346
  * @throws {RequiredError}
347
- * @memberof QueriesApi
347
+ * @memberof DataKioskApi
348
348
  */
349
349
  createQuery(requestParameters, options) {
350
- return (0, exports.QueriesApiFp)(this.configuration).createQuery(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
350
+ return (0, exports.DataKioskApiFp)(this.configuration).createQuery(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
351
351
  }
352
352
  /**
353
353
  * 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).
354
- * @param {QueriesApiGetDocumentRequest} requestParameters Request parameters.
354
+ * @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
355
355
  * @param {*} [options] Override http request option.
356
356
  * @throws {RequiredError}
357
- * @memberof QueriesApi
357
+ * @memberof DataKioskApi
358
358
  */
359
359
  getDocument(requestParameters, options) {
360
- return (0, exports.QueriesApiFp)(this.configuration).getDocument(requestParameters.documentId, options).then((request) => request(this.axios, this.basePath));
360
+ return (0, exports.DataKioskApiFp)(this.configuration).getDocument(requestParameters.documentId, options).then((request) => request(this.axios, this.basePath));
361
361
  }
362
362
  /**
363
363
  * 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).
364
- * @param {QueriesApiGetQueriesRequest} requestParameters Request parameters.
364
+ * @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
365
365
  * @param {*} [options] Override http request option.
366
366
  * @throws {RequiredError}
367
- * @memberof QueriesApi
367
+ * @memberof DataKioskApi
368
368
  */
369
369
  getQueries(requestParameters = {}, options) {
370
- return (0, exports.QueriesApiFp)(this.configuration).getQueries(requestParameters.processingStatuses, requestParameters.pageSize, requestParameters.createdSince, requestParameters.createdUntil, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
370
+ return (0, exports.DataKioskApiFp)(this.configuration).getQueries(requestParameters.processingStatuses, requestParameters.pageSize, requestParameters.createdSince, requestParameters.createdUntil, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
371
371
  }
372
372
  /**
373
373
  * 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).
374
- * @param {QueriesApiGetQueryRequest} requestParameters Request parameters.
374
+ * @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
375
375
  * @param {*} [options] Override http request option.
376
376
  * @throws {RequiredError}
377
- * @memberof QueriesApi
377
+ * @memberof DataKioskApi
378
378
  */
379
379
  getQuery(requestParameters, options) {
380
- return (0, exports.QueriesApiFp)(this.configuration).getQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
380
+ return (0, exports.DataKioskApiFp)(this.configuration).getQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
381
381
  }
382
382
  }
383
- exports.QueriesApi = QueriesApi;
383
+ exports.DataKioskApi = DataKioskApi;
384
384
  /**
385
385
  * @export
386
386
  */
@@ -27,4 +27,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
27
27
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
28
28
  };
29
29
  Object.defineProperty(exports, "__esModule", { value: true });
30
- __exportStar(require("./api/queries-api"), exports);
30
+ __exportStar(require("./api/data-kiosk-api"), exports);
@@ -40,7 +40,7 @@ exports.clientRateLimits = [
40
40
  burst: 15,
41
41
  },
42
42
  ];
43
- class DataKioskApiClient extends api_model_1.QueriesApi {
43
+ class DataKioskApiClient extends api_model_1.DataKioskApi {
44
44
  constructor(configuration) {
45
45
  const { axios, endpoint } = (0, common_1.createAxiosInstance)(configuration, exports.clientRateLimits);
46
46
  super(new api_model_1.Configuration(), endpoint, axios);
@@ -18,10 +18,10 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeed
18
18
  // @ts-ignore
19
19
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
20
20
  /**
21
- * QueriesApi - axios parameter creator
21
+ * DataKioskApi - axios parameter creator
22
22
  * @export
23
23
  */
24
- export const QueriesApiAxiosParamCreator = function (configuration) {
24
+ export const DataKioskApiAxiosParamCreator = function (configuration) {
25
25
  return {
26
26
  /**
27
27
  * 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).
@@ -187,11 +187,11 @@ export const QueriesApiAxiosParamCreator = function (configuration) {
187
187
  };
188
188
  };
189
189
  /**
190
- * QueriesApi - functional programming interface
190
+ * DataKioskApi - functional programming interface
191
191
  * @export
192
192
  */
193
- export const QueriesApiFp = function (configuration) {
194
- const localVarAxiosParamCreator = QueriesApiAxiosParamCreator(configuration);
193
+ export const DataKioskApiFp = function (configuration) {
194
+ const localVarAxiosParamCreator = DataKioskApiAxiosParamCreator(configuration);
195
195
  return {
196
196
  /**
197
197
  * 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).
@@ -202,7 +202,7 @@ export const QueriesApiFp = function (configuration) {
202
202
  async cancelQuery(queryId, options) {
203
203
  const localVarAxiosArgs = await localVarAxiosParamCreator.cancelQuery(queryId, options);
204
204
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
205
- const localVarOperationServerBasePath = operationServerMap['QueriesApi.cancelQuery']?.[localVarOperationServerIndex]?.url;
205
+ const localVarOperationServerBasePath = operationServerMap['DataKioskApi.cancelQuery']?.[localVarOperationServerIndex]?.url;
206
206
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
207
207
  },
208
208
  /**
@@ -214,7 +214,7 @@ export const QueriesApiFp = function (configuration) {
214
214
  async createQuery(body, options) {
215
215
  const localVarAxiosArgs = await localVarAxiosParamCreator.createQuery(body, options);
216
216
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
217
- const localVarOperationServerBasePath = operationServerMap['QueriesApi.createQuery']?.[localVarOperationServerIndex]?.url;
217
+ const localVarOperationServerBasePath = operationServerMap['DataKioskApi.createQuery']?.[localVarOperationServerIndex]?.url;
218
218
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
219
219
  },
220
220
  /**
@@ -226,7 +226,7 @@ export const QueriesApiFp = function (configuration) {
226
226
  async getDocument(documentId, options) {
227
227
  const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(documentId, options);
228
228
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
229
- const localVarOperationServerBasePath = operationServerMap['QueriesApi.getDocument']?.[localVarOperationServerIndex]?.url;
229
+ const localVarOperationServerBasePath = operationServerMap['DataKioskApi.getDocument']?.[localVarOperationServerIndex]?.url;
230
230
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
231
231
  },
232
232
  /**
@@ -242,7 +242,7 @@ export const QueriesApiFp = function (configuration) {
242
242
  async getQueries(processingStatuses, pageSize, createdSince, createdUntil, paginationToken, options) {
243
243
  const localVarAxiosArgs = await localVarAxiosParamCreator.getQueries(processingStatuses, pageSize, createdSince, createdUntil, paginationToken, options);
244
244
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
245
- const localVarOperationServerBasePath = operationServerMap['QueriesApi.getQueries']?.[localVarOperationServerIndex]?.url;
245
+ const localVarOperationServerBasePath = operationServerMap['DataKioskApi.getQueries']?.[localVarOperationServerIndex]?.url;
246
246
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
247
247
  },
248
248
  /**
@@ -254,21 +254,21 @@ export const QueriesApiFp = function (configuration) {
254
254
  async getQuery(queryId, options) {
255
255
  const localVarAxiosArgs = await localVarAxiosParamCreator.getQuery(queryId, options);
256
256
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
257
- const localVarOperationServerBasePath = operationServerMap['QueriesApi.getQuery']?.[localVarOperationServerIndex]?.url;
257
+ const localVarOperationServerBasePath = operationServerMap['DataKioskApi.getQuery']?.[localVarOperationServerIndex]?.url;
258
258
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
259
259
  },
260
260
  };
261
261
  };
262
262
  /**
263
- * QueriesApi - factory interface
263
+ * DataKioskApi - factory interface
264
264
  * @export
265
265
  */
266
- export const QueriesApiFactory = function (configuration, basePath, axios) {
267
- const localVarFp = QueriesApiFp(configuration);
266
+ export const DataKioskApiFactory = function (configuration, basePath, axios) {
267
+ const localVarFp = DataKioskApiFp(configuration);
268
268
  return {
269
269
  /**
270
270
  * 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).
271
- * @param {QueriesApiCancelQueryRequest} requestParameters Request parameters.
271
+ * @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
272
272
  * @param {*} [options] Override http request option.
273
273
  * @throws {RequiredError}
274
274
  */
@@ -277,7 +277,7 @@ export const QueriesApiFactory = function (configuration, basePath, axios) {
277
277
  },
278
278
  /**
279
279
  * 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).
280
- * @param {QueriesApiCreateQueryRequest} requestParameters Request parameters.
280
+ * @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
281
281
  * @param {*} [options] Override http request option.
282
282
  * @throws {RequiredError}
283
283
  */
@@ -286,7 +286,7 @@ export const QueriesApiFactory = function (configuration, basePath, axios) {
286
286
  },
287
287
  /**
288
288
  * 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).
289
- * @param {QueriesApiGetDocumentRequest} requestParameters Request parameters.
289
+ * @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
290
290
  * @param {*} [options] Override http request option.
291
291
  * @throws {RequiredError}
292
292
  */
@@ -295,7 +295,7 @@ export const QueriesApiFactory = function (configuration, basePath, axios) {
295
295
  },
296
296
  /**
297
297
  * 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).
298
- * @param {QueriesApiGetQueriesRequest} requestParameters Request parameters.
298
+ * @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
299
299
  * @param {*} [options] Override http request option.
300
300
  * @throws {RequiredError}
301
301
  */
@@ -304,7 +304,7 @@ export const QueriesApiFactory = function (configuration, basePath, axios) {
304
304
  },
305
305
  /**
306
306
  * 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).
307
- * @param {QueriesApiGetQueryRequest} requestParameters Request parameters.
307
+ * @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
308
308
  * @param {*} [options] Override http request option.
309
309
  * @throws {RequiredError}
310
310
  */
@@ -314,61 +314,61 @@ export const QueriesApiFactory = function (configuration, basePath, axios) {
314
314
  };
315
315
  };
316
316
  /**
317
- * QueriesApi - object-oriented interface
317
+ * DataKioskApi - object-oriented interface
318
318
  * @export
319
- * @class QueriesApi
319
+ * @class DataKioskApi
320
320
  * @extends {BaseAPI}
321
321
  */
322
- export class QueriesApi extends BaseAPI {
322
+ export class DataKioskApi extends BaseAPI {
323
323
  /**
324
324
  * 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).
325
- * @param {QueriesApiCancelQueryRequest} requestParameters Request parameters.
325
+ * @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
326
326
  * @param {*} [options] Override http request option.
327
327
  * @throws {RequiredError}
328
- * @memberof QueriesApi
328
+ * @memberof DataKioskApi
329
329
  */
330
330
  cancelQuery(requestParameters, options) {
331
- return QueriesApiFp(this.configuration).cancelQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
331
+ return DataKioskApiFp(this.configuration).cancelQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
332
332
  }
333
333
  /**
334
334
  * 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).
335
- * @param {QueriesApiCreateQueryRequest} requestParameters Request parameters.
335
+ * @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
336
336
  * @param {*} [options] Override http request option.
337
337
  * @throws {RequiredError}
338
- * @memberof QueriesApi
338
+ * @memberof DataKioskApi
339
339
  */
340
340
  createQuery(requestParameters, options) {
341
- return QueriesApiFp(this.configuration).createQuery(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
341
+ return DataKioskApiFp(this.configuration).createQuery(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
342
342
  }
343
343
  /**
344
344
  * 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).
345
- * @param {QueriesApiGetDocumentRequest} requestParameters Request parameters.
345
+ * @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
346
346
  * @param {*} [options] Override http request option.
347
347
  * @throws {RequiredError}
348
- * @memberof QueriesApi
348
+ * @memberof DataKioskApi
349
349
  */
350
350
  getDocument(requestParameters, options) {
351
- return QueriesApiFp(this.configuration).getDocument(requestParameters.documentId, options).then((request) => request(this.axios, this.basePath));
351
+ return DataKioskApiFp(this.configuration).getDocument(requestParameters.documentId, options).then((request) => request(this.axios, this.basePath));
352
352
  }
353
353
  /**
354
354
  * 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).
355
- * @param {QueriesApiGetQueriesRequest} requestParameters Request parameters.
355
+ * @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
356
356
  * @param {*} [options] Override http request option.
357
357
  * @throws {RequiredError}
358
- * @memberof QueriesApi
358
+ * @memberof DataKioskApi
359
359
  */
360
360
  getQueries(requestParameters = {}, options) {
361
- return QueriesApiFp(this.configuration).getQueries(requestParameters.processingStatuses, requestParameters.pageSize, requestParameters.createdSince, requestParameters.createdUntil, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
361
+ return DataKioskApiFp(this.configuration).getQueries(requestParameters.processingStatuses, requestParameters.pageSize, requestParameters.createdSince, requestParameters.createdUntil, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
362
362
  }
363
363
  /**
364
364
  * 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).
365
- * @param {QueriesApiGetQueryRequest} requestParameters Request parameters.
365
+ * @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
366
366
  * @param {*} [options] Override http request option.
367
367
  * @throws {RequiredError}
368
- * @memberof QueriesApi
368
+ * @memberof DataKioskApi
369
369
  */
370
370
  getQuery(requestParameters, options) {
371
- return QueriesApiFp(this.configuration).getQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
371
+ return DataKioskApiFp(this.configuration).getQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
372
372
  }
373
373
  }
374
374
  /**
@@ -11,4 +11,4 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- export * from './api/queries-api';
14
+ export * from './api/data-kiosk-api';
package/dist/es/client.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import { createAxiosInstance } from '@sp-api-sdk/common';
2
- import { Configuration, QueriesApi } from './api-model';
2
+ import { Configuration, DataKioskApi } from './api-model';
3
3
  export const clientRateLimits = [
4
4
  {
5
5
  method: 'get',
@@ -37,7 +37,7 @@ export const clientRateLimits = [
37
37
  burst: 15,
38
38
  },
39
39
  ];
40
- export class DataKioskApiClient extends QueriesApi {
40
+ export class DataKioskApiClient extends DataKioskApi {
41
41
  constructor(configuration) {
42
42
  const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
43
43
  super(new Configuration(), endpoint, axios);
@@ -19,10 +19,10 @@ import type { GetDocumentResponse } from '../models';
19
19
  import type { GetQueriesResponse } from '../models';
20
20
  import type { Query } from '../models';
21
21
  /**
22
- * QueriesApi - axios parameter creator
22
+ * DataKioskApi - axios parameter creator
23
23
  * @export
24
24
  */
25
- export declare const QueriesApiAxiosParamCreator: (configuration?: Configuration) => {
25
+ export declare const DataKioskApiAxiosParamCreator: (configuration?: Configuration) => {
26
26
  /**
27
27
  * 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).
28
28
  * @param {string} queryId The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
@@ -64,10 +64,10 @@ export declare const QueriesApiAxiosParamCreator: (configuration?: Configuration
64
64
  getQuery: (queryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
65
65
  };
66
66
  /**
67
- * QueriesApi - functional programming interface
67
+ * DataKioskApi - functional programming interface
68
68
  * @export
69
69
  */
70
- export declare const QueriesApiFp: (configuration?: Configuration) => {
70
+ export declare const DataKioskApiFp: (configuration?: Configuration) => {
71
71
  /**
72
72
  * 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).
73
73
  * @param {string} queryId The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
@@ -109,182 +109,182 @@ export declare const QueriesApiFp: (configuration?: Configuration) => {
109
109
  getQuery(queryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Query>>;
110
110
  };
111
111
  /**
112
- * QueriesApi - factory interface
112
+ * DataKioskApi - factory interface
113
113
  * @export
114
114
  */
115
- export declare const QueriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
115
+ export declare const DataKioskApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
116
116
  /**
117
117
  * 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).
118
- * @param {QueriesApiCancelQueryRequest} requestParameters Request parameters.
118
+ * @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
119
119
  * @param {*} [options] Override http request option.
120
120
  * @throws {RequiredError}
121
121
  */
122
- cancelQuery(requestParameters: QueriesApiCancelQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
122
+ cancelQuery(requestParameters: DataKioskApiCancelQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
123
123
  /**
124
124
  * 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).
125
- * @param {QueriesApiCreateQueryRequest} requestParameters Request parameters.
125
+ * @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
126
126
  * @param {*} [options] Override http request option.
127
127
  * @throws {RequiredError}
128
128
  */
129
- createQuery(requestParameters: QueriesApiCreateQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateQueryResponse>;
129
+ createQuery(requestParameters: DataKioskApiCreateQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateQueryResponse>;
130
130
  /**
131
131
  * 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).
132
- * @param {QueriesApiGetDocumentRequest} requestParameters Request parameters.
132
+ * @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
133
133
  * @param {*} [options] Override http request option.
134
134
  * @throws {RequiredError}
135
135
  */
136
- getDocument(requestParameters: QueriesApiGetDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDocumentResponse>;
136
+ getDocument(requestParameters: DataKioskApiGetDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDocumentResponse>;
137
137
  /**
138
138
  * 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).
139
- * @param {QueriesApiGetQueriesRequest} requestParameters Request parameters.
139
+ * @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
140
140
  * @param {*} [options] Override http request option.
141
141
  * @throws {RequiredError}
142
142
  */
143
- getQueries(requestParameters?: QueriesApiGetQueriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetQueriesResponse>;
143
+ getQueries(requestParameters?: DataKioskApiGetQueriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetQueriesResponse>;
144
144
  /**
145
145
  * 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).
146
- * @param {QueriesApiGetQueryRequest} requestParameters Request parameters.
146
+ * @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
147
147
  * @param {*} [options] Override http request option.
148
148
  * @throws {RequiredError}
149
149
  */
150
- getQuery(requestParameters: QueriesApiGetQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Query>;
150
+ getQuery(requestParameters: DataKioskApiGetQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Query>;
151
151
  };
152
152
  /**
153
- * Request parameters for cancelQuery operation in QueriesApi.
153
+ * Request parameters for cancelQuery operation in DataKioskApi.
154
154
  * @export
155
- * @interface QueriesApiCancelQueryRequest
155
+ * @interface DataKioskApiCancelQueryRequest
156
156
  */
157
- export interface QueriesApiCancelQueryRequest {
157
+ export interface DataKioskApiCancelQueryRequest {
158
158
  /**
159
159
  * The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
160
160
  * @type {string}
161
- * @memberof QueriesApiCancelQuery
161
+ * @memberof DataKioskApiCancelQuery
162
162
  */
163
163
  readonly queryId: string;
164
164
  }
165
165
  /**
166
- * Request parameters for createQuery operation in QueriesApi.
166
+ * Request parameters for createQuery operation in DataKioskApi.
167
167
  * @export
168
- * @interface QueriesApiCreateQueryRequest
168
+ * @interface DataKioskApiCreateQueryRequest
169
169
  */
170
- export interface QueriesApiCreateQueryRequest {
170
+ export interface DataKioskApiCreateQueryRequest {
171
171
  /**
172
172
  * The body of the request.
173
173
  * @type {CreateQuerySpecification}
174
- * @memberof QueriesApiCreateQuery
174
+ * @memberof DataKioskApiCreateQuery
175
175
  */
176
176
  readonly body: CreateQuerySpecification;
177
177
  }
178
178
  /**
179
- * Request parameters for getDocument operation in QueriesApi.
179
+ * Request parameters for getDocument operation in DataKioskApi.
180
180
  * @export
181
- * @interface QueriesApiGetDocumentRequest
181
+ * @interface DataKioskApiGetDocumentRequest
182
182
  */
183
- export interface QueriesApiGetDocumentRequest {
183
+ export interface DataKioskApiGetDocumentRequest {
184
184
  /**
185
185
  * The identifier for the Data Kiosk document.
186
186
  * @type {string}
187
- * @memberof QueriesApiGetDocument
187
+ * @memberof DataKioskApiGetDocument
188
188
  */
189
189
  readonly documentId: string;
190
190
  }
191
191
  /**
192
- * Request parameters for getQueries operation in QueriesApi.
192
+ * Request parameters for getQueries operation in DataKioskApi.
193
193
  * @export
194
- * @interface QueriesApiGetQueriesRequest
194
+ * @interface DataKioskApiGetQueriesRequest
195
195
  */
196
- export interface QueriesApiGetQueriesRequest {
196
+ export interface DataKioskApiGetQueriesRequest {
197
197
  /**
198
198
  * A list of processing statuses used to filter queries.
199
199
  * @type {Array<'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'>}
200
- * @memberof QueriesApiGetQueries
200
+ * @memberof DataKioskApiGetQueries
201
201
  */
202
202
  readonly processingStatuses?: Array<GetQueriesProcessingStatusesEnum>;
203
203
  /**
204
204
  * The maximum number of queries to return in a single call.
205
205
  * @type {number}
206
- * @memberof QueriesApiGetQueries
206
+ * @memberof DataKioskApiGetQueries
207
207
  */
208
208
  readonly pageSize?: number;
209
209
  /**
210
210
  * 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.
211
211
  * @type {string}
212
- * @memberof QueriesApiGetQueries
212
+ * @memberof DataKioskApiGetQueries
213
213
  */
214
214
  readonly createdSince?: string;
215
215
  /**
216
216
  * 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 &#x60;getQueries&#x60; request.
217
217
  * @type {string}
218
- * @memberof QueriesApiGetQueries
218
+ * @memberof DataKioskApiGetQueries
219
219
  */
220
220
  readonly createdUntil?: string;
221
221
  /**
222
222
  * 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 &#x60;pagination.nextToken&#x60; field returned in the &#x60;GetQueriesResponse&#x60; 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 &#x60;pageSize&#x60; which can be modified between calls to &#x60;getQueries&#x60;. In the absence of this token value, &#x60;getQueries&#x60; returns the first page of results.
223
223
  * @type {string}
224
- * @memberof QueriesApiGetQueries
224
+ * @memberof DataKioskApiGetQueries
225
225
  */
226
226
  readonly paginationToken?: string;
227
227
  }
228
228
  /**
229
- * Request parameters for getQuery operation in QueriesApi.
229
+ * Request parameters for getQuery operation in DataKioskApi.
230
230
  * @export
231
- * @interface QueriesApiGetQueryRequest
231
+ * @interface DataKioskApiGetQueryRequest
232
232
  */
233
- export interface QueriesApiGetQueryRequest {
233
+ export interface DataKioskApiGetQueryRequest {
234
234
  /**
235
235
  * The query identifier.
236
236
  * @type {string}
237
- * @memberof QueriesApiGetQuery
237
+ * @memberof DataKioskApiGetQuery
238
238
  */
239
239
  readonly queryId: string;
240
240
  }
241
241
  /**
242
- * QueriesApi - object-oriented interface
242
+ * DataKioskApi - object-oriented interface
243
243
  * @export
244
- * @class QueriesApi
244
+ * @class DataKioskApi
245
245
  * @extends {BaseAPI}
246
246
  */
247
- export declare class QueriesApi extends BaseAPI {
247
+ export declare class DataKioskApi extends BaseAPI {
248
248
  /**
249
249
  * 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).
250
- * @param {QueriesApiCancelQueryRequest} requestParameters Request parameters.
250
+ * @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
251
251
  * @param {*} [options] Override http request option.
252
252
  * @throws {RequiredError}
253
- * @memberof QueriesApi
253
+ * @memberof DataKioskApi
254
254
  */
255
- cancelQuery(requestParameters: QueriesApiCancelQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
255
+ cancelQuery(requestParameters: DataKioskApiCancelQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
256
256
  /**
257
257
  * 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).
258
- * @param {QueriesApiCreateQueryRequest} requestParameters Request parameters.
258
+ * @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
259
259
  * @param {*} [options] Override http request option.
260
260
  * @throws {RequiredError}
261
- * @memberof QueriesApi
261
+ * @memberof DataKioskApi
262
262
  */
263
- createQuery(requestParameters: QueriesApiCreateQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateQueryResponse, any>>;
263
+ createQuery(requestParameters: DataKioskApiCreateQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateQueryResponse, any>>;
264
264
  /**
265
265
  * 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).
266
- * @param {QueriesApiGetDocumentRequest} requestParameters Request parameters.
266
+ * @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
267
267
  * @param {*} [options] Override http request option.
268
268
  * @throws {RequiredError}
269
- * @memberof QueriesApi
269
+ * @memberof DataKioskApi
270
270
  */
271
- getDocument(requestParameters: QueriesApiGetDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDocumentResponse, any>>;
271
+ getDocument(requestParameters: DataKioskApiGetDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDocumentResponse, any>>;
272
272
  /**
273
273
  * 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).
274
- * @param {QueriesApiGetQueriesRequest} requestParameters Request parameters.
274
+ * @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
275
275
  * @param {*} [options] Override http request option.
276
276
  * @throws {RequiredError}
277
- * @memberof QueriesApi
277
+ * @memberof DataKioskApi
278
278
  */
279
- getQueries(requestParameters?: QueriesApiGetQueriesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetQueriesResponse, any>>;
279
+ getQueries(requestParameters?: DataKioskApiGetQueriesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetQueriesResponse, any>>;
280
280
  /**
281
281
  * 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).
282
- * @param {QueriesApiGetQueryRequest} requestParameters Request parameters.
282
+ * @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
283
283
  * @param {*} [options] Override http request option.
284
284
  * @throws {RequiredError}
285
- * @memberof QueriesApi
285
+ * @memberof DataKioskApi
286
286
  */
287
- getQuery(requestParameters: QueriesApiGetQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Query, any>>;
287
+ getQuery(requestParameters: DataKioskApiGetQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Query, any>>;
288
288
  }
289
289
  /**
290
290
  * @export
@@ -9,4 +9,4 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- export * from './api/queries-api';
12
+ export * from './api/data-kiosk-api';
@@ -1,6 +1,6 @@
1
1
  import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
2
- import { QueriesApi } from './api-model';
2
+ import { DataKioskApi } from './api-model';
3
3
  export declare const clientRateLimits: RateLimit[];
4
- export declare class DataKioskApiClient extends QueriesApi {
4
+ export declare class DataKioskApiClient extends DataKioskApi {
5
5
  constructor(configuration: ClientConfiguration);
6
6
  }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/data-kiosk-api-2023-11-15",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.",
5
- "version": "2.0.4",
5
+ "version": "3.0.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.13",
22
- "axios": "^1.8.4"
21
+ "@sp-api-sdk/common": "2.1.14",
22
+ "axios": "^1.9.0"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "data kiosk api"
42
42
  ],
43
- "gitHead": "287508bdc050a25bac20889ed0afb6d3f6518cd6"
43
+ "gitHead": "773f45c3f4aab28e0bd9f6033045988800d7f258"
44
44
  }