@sp-api-sdk/data-kiosk-api-2023-11-15 1.2.1 → 1.3.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/dist/cjs/src/api-model/api/queries-api.js +28 -8
- package/dist/cjs/src/api-model/base.js +7 -2
- package/dist/cjs/src/api-model/common.js +1 -1
- package/dist/cjs/src/api-model/configuration.js +8 -0
- package/dist/es/src/api-model/api/queries-api.js +28 -8
- package/dist/es/src/api-model/base.js +6 -1
- package/dist/es/src/api-model/common.js +1 -1
- package/dist/es/src/api-model/configuration.js +8 -0
- package/dist/types/src/api-model/api/queries-api.d.ts +41 -30
- package/dist/types/src/api-model/base.d.ts +14 -2
- package/dist/types/src/api-model/configuration.d.ts +8 -0
- package/dist/types/src/api-model/models/get-queries-response.d.ts +2 -2
- package/dist/types/src/api-model/models/query.d.ts +1 -1
- package/package.json +5 -5
|
@@ -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.QueriesApi = exports.QueriesApiFactory = exports.QueriesApiFp = exports.QueriesApiAxiosParamCreator = void 0;
|
|
19
|
+
exports.GetQueriesProcessingStatusesEnum = exports.QueriesApi = exports.QueriesApiFactory = exports.QueriesApiFp = exports.QueriesApiAxiosParamCreator = void 0;
|
|
20
20
|
const axios_1 = __importDefault(require("axios"));
|
|
21
21
|
// Some imports not used depending on template conditions
|
|
22
22
|
// @ts-ignore
|
|
@@ -116,7 +116,7 @@ const QueriesApiAxiosParamCreator = function (configuration) {
|
|
|
116
116
|
},
|
|
117
117
|
/**
|
|
118
118
|
* 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).
|
|
119
|
-
* @param {Array<
|
|
119
|
+
* @param {Array<GetQueriesProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter queries.
|
|
120
120
|
* @param {number} [pageSize] The maximum number of queries to return in a single call.
|
|
121
121
|
* @param {string} [createdSince] The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
|
|
122
122
|
* @param {string} [createdUntil] The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.
|
|
@@ -208,7 +208,9 @@ const QueriesApiFp = function (configuration) {
|
|
|
208
208
|
*/
|
|
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;
|
|
213
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
212
214
|
},
|
|
213
215
|
/**
|
|
214
216
|
* 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).
|
|
@@ -218,7 +220,9 @@ const QueriesApiFp = function (configuration) {
|
|
|
218
220
|
*/
|
|
219
221
|
async createQuery(body, options) {
|
|
220
222
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createQuery(body, options);
|
|
221
|
-
|
|
223
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
224
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['QueriesApi.createQuery']?.[localVarOperationServerIndex]?.url;
|
|
225
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
222
226
|
},
|
|
223
227
|
/**
|
|
224
228
|
* 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).
|
|
@@ -228,11 +232,13 @@ const QueriesApiFp = function (configuration) {
|
|
|
228
232
|
*/
|
|
229
233
|
async getDocument(documentId, options) {
|
|
230
234
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(documentId, options);
|
|
231
|
-
|
|
235
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
236
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['QueriesApi.getDocument']?.[localVarOperationServerIndex]?.url;
|
|
237
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
232
238
|
},
|
|
233
239
|
/**
|
|
234
240
|
* 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).
|
|
235
|
-
* @param {Array<
|
|
241
|
+
* @param {Array<GetQueriesProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter queries.
|
|
236
242
|
* @param {number} [pageSize] The maximum number of queries to return in a single call.
|
|
237
243
|
* @param {string} [createdSince] The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
|
|
238
244
|
* @param {string} [createdUntil] The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.
|
|
@@ -242,7 +248,9 @@ const QueriesApiFp = function (configuration) {
|
|
|
242
248
|
*/
|
|
243
249
|
async getQueries(processingStatuses, pageSize, createdSince, createdUntil, paginationToken, options) {
|
|
244
250
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getQueries(processingStatuses, pageSize, createdSince, createdUntil, paginationToken, options);
|
|
245
|
-
|
|
251
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
252
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['QueriesApi.getQueries']?.[localVarOperationServerIndex]?.url;
|
|
253
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
246
254
|
},
|
|
247
255
|
/**
|
|
248
256
|
* 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).
|
|
@@ -252,7 +260,9 @@ const QueriesApiFp = function (configuration) {
|
|
|
252
260
|
*/
|
|
253
261
|
async getQuery(queryId, options) {
|
|
254
262
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getQuery(queryId, options);
|
|
255
|
-
|
|
263
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
264
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['QueriesApi.getQuery']?.[localVarOperationServerIndex]?.url;
|
|
265
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
256
266
|
},
|
|
257
267
|
};
|
|
258
268
|
};
|
|
@@ -371,3 +381,13 @@ class QueriesApi extends base_1.BaseAPI {
|
|
|
371
381
|
}
|
|
372
382
|
}
|
|
373
383
|
exports.QueriesApi = QueriesApi;
|
|
384
|
+
/**
|
|
385
|
+
* @export
|
|
386
|
+
*/
|
|
387
|
+
exports.GetQueriesProcessingStatusesEnum = {
|
|
388
|
+
Cancelled: 'CANCELLED',
|
|
389
|
+
Done: 'DONE',
|
|
390
|
+
Fatal: 'FATAL',
|
|
391
|
+
InProgress: 'IN_PROGRESS',
|
|
392
|
+
InQueue: 'IN_QUEUE'
|
|
393
|
+
};
|
|
@@ -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.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
19
|
+
exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
20
20
|
const axios_1 = __importDefault(require("axios"));
|
|
21
21
|
exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
|
|
22
22
|
/**
|
|
@@ -43,7 +43,7 @@ class BaseAPI {
|
|
|
43
43
|
this.axios = axios;
|
|
44
44
|
if (configuration) {
|
|
45
45
|
this.configuration = configuration;
|
|
46
|
-
this.basePath = configuration.basePath
|
|
46
|
+
this.basePath = configuration.basePath ?? basePath;
|
|
47
47
|
}
|
|
48
48
|
}
|
|
49
49
|
}
|
|
@@ -64,3 +64,8 @@ class RequiredError extends Error {
|
|
|
64
64
|
}
|
|
65
65
|
}
|
|
66
66
|
exports.RequiredError = RequiredError;
|
|
67
|
+
/**
|
|
68
|
+
*
|
|
69
|
+
* @export
|
|
70
|
+
*/
|
|
71
|
+
exports.operationServerMap = {};
|
|
@@ -138,7 +138,7 @@ exports.toPathString = toPathString;
|
|
|
138
138
|
*/
|
|
139
139
|
const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
140
140
|
return (axios = globalAxios, basePath = BASE_PATH) => {
|
|
141
|
-
const axiosRequestArgs = { ...axiosArgs.options, url: (configuration?.basePath
|
|
141
|
+
const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
|
|
142
142
|
return axios.request(axiosRequestArgs);
|
|
143
143
|
};
|
|
144
144
|
};
|
|
@@ -49,6 +49,13 @@ class Configuration {
|
|
|
49
49
|
* @memberof Configuration
|
|
50
50
|
*/
|
|
51
51
|
basePath;
|
|
52
|
+
/**
|
|
53
|
+
* override server index
|
|
54
|
+
*
|
|
55
|
+
* @type {number}
|
|
56
|
+
* @memberof Configuration
|
|
57
|
+
*/
|
|
58
|
+
serverIndex;
|
|
52
59
|
/**
|
|
53
60
|
* base options for axios calls
|
|
54
61
|
*
|
|
@@ -70,6 +77,7 @@ class Configuration {
|
|
|
70
77
|
this.password = param.password;
|
|
71
78
|
this.accessToken = param.accessToken;
|
|
72
79
|
this.basePath = param.basePath;
|
|
80
|
+
this.serverIndex = param.serverIndex;
|
|
73
81
|
this.baseOptions = param.baseOptions;
|
|
74
82
|
this.formDataCtor = param.formDataCtor;
|
|
75
83
|
}
|
|
@@ -16,7 +16,7 @@ import globalAxios from 'axios';
|
|
|
16
16
|
// @ts-ignore
|
|
17
17
|
import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
18
18
|
// @ts-ignore
|
|
19
|
-
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
|
|
19
|
+
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
|
|
20
20
|
/**
|
|
21
21
|
* QueriesApi - axios parameter creator
|
|
22
22
|
* @export
|
|
@@ -110,7 +110,7 @@ export const QueriesApiAxiosParamCreator = function (configuration) {
|
|
|
110
110
|
},
|
|
111
111
|
/**
|
|
112
112
|
* 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).
|
|
113
|
-
* @param {Array<
|
|
113
|
+
* @param {Array<GetQueriesProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter queries.
|
|
114
114
|
* @param {number} [pageSize] The maximum number of queries to return in a single call.
|
|
115
115
|
* @param {string} [createdSince] The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
|
|
116
116
|
* @param {string} [createdUntil] The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.
|
|
@@ -201,7 +201,9 @@ export const QueriesApiFp = function (configuration) {
|
|
|
201
201
|
*/
|
|
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;
|
|
206
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
205
207
|
},
|
|
206
208
|
/**
|
|
207
209
|
* 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).
|
|
@@ -211,7 +213,9 @@ export const QueriesApiFp = function (configuration) {
|
|
|
211
213
|
*/
|
|
212
214
|
async createQuery(body, options) {
|
|
213
215
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createQuery(body, options);
|
|
214
|
-
|
|
216
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
217
|
+
const localVarOperationServerBasePath = operationServerMap['QueriesApi.createQuery']?.[localVarOperationServerIndex]?.url;
|
|
218
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
215
219
|
},
|
|
216
220
|
/**
|
|
217
221
|
* 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).
|
|
@@ -221,11 +225,13 @@ export const QueriesApiFp = function (configuration) {
|
|
|
221
225
|
*/
|
|
222
226
|
async getDocument(documentId, options) {
|
|
223
227
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(documentId, options);
|
|
224
|
-
|
|
228
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
229
|
+
const localVarOperationServerBasePath = operationServerMap['QueriesApi.getDocument']?.[localVarOperationServerIndex]?.url;
|
|
230
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
225
231
|
},
|
|
226
232
|
/**
|
|
227
233
|
* 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).
|
|
228
|
-
* @param {Array<
|
|
234
|
+
* @param {Array<GetQueriesProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter queries.
|
|
229
235
|
* @param {number} [pageSize] The maximum number of queries to return in a single call.
|
|
230
236
|
* @param {string} [createdSince] The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
|
|
231
237
|
* @param {string} [createdUntil] The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.
|
|
@@ -235,7 +241,9 @@ export const QueriesApiFp = function (configuration) {
|
|
|
235
241
|
*/
|
|
236
242
|
async getQueries(processingStatuses, pageSize, createdSince, createdUntil, paginationToken, options) {
|
|
237
243
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getQueries(processingStatuses, pageSize, createdSince, createdUntil, paginationToken, options);
|
|
238
|
-
|
|
244
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
245
|
+
const localVarOperationServerBasePath = operationServerMap['QueriesApi.getQueries']?.[localVarOperationServerIndex]?.url;
|
|
246
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
239
247
|
},
|
|
240
248
|
/**
|
|
241
249
|
* 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).
|
|
@@ -245,7 +253,9 @@ export const QueriesApiFp = function (configuration) {
|
|
|
245
253
|
*/
|
|
246
254
|
async getQuery(queryId, options) {
|
|
247
255
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getQuery(queryId, options);
|
|
248
|
-
|
|
256
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
257
|
+
const localVarOperationServerBasePath = operationServerMap['QueriesApi.getQuery']?.[localVarOperationServerIndex]?.url;
|
|
258
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
249
259
|
},
|
|
250
260
|
};
|
|
251
261
|
};
|
|
@@ -361,3 +371,13 @@ export class QueriesApi extends BaseAPI {
|
|
|
361
371
|
return QueriesApiFp(this.configuration).getQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
|
|
362
372
|
}
|
|
363
373
|
}
|
|
374
|
+
/**
|
|
375
|
+
* @export
|
|
376
|
+
*/
|
|
377
|
+
export const GetQueriesProcessingStatusesEnum = {
|
|
378
|
+
Cancelled: 'CANCELLED',
|
|
379
|
+
Done: 'DONE',
|
|
380
|
+
Fatal: 'FATAL',
|
|
381
|
+
InProgress: 'IN_PROGRESS',
|
|
382
|
+
InQueue: 'IN_QUEUE'
|
|
383
|
+
};
|
|
@@ -37,7 +37,7 @@ export class BaseAPI {
|
|
|
37
37
|
this.axios = axios;
|
|
38
38
|
if (configuration) {
|
|
39
39
|
this.configuration = configuration;
|
|
40
|
-
this.basePath = configuration.basePath
|
|
40
|
+
this.basePath = configuration.basePath ?? basePath;
|
|
41
41
|
}
|
|
42
42
|
}
|
|
43
43
|
}
|
|
@@ -56,3 +56,8 @@ export class RequiredError extends Error {
|
|
|
56
56
|
this.name = "RequiredError";
|
|
57
57
|
}
|
|
58
58
|
}
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @export
|
|
62
|
+
*/
|
|
63
|
+
export const operationServerMap = {};
|
|
@@ -127,7 +127,7 @@ export const toPathString = function (url) {
|
|
|
127
127
|
*/
|
|
128
128
|
export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
129
129
|
return (axios = globalAxios, basePath = BASE_PATH) => {
|
|
130
|
-
const axiosRequestArgs = { ...axiosArgs.options, url: (configuration?.basePath
|
|
130
|
+
const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
|
|
131
131
|
return axios.request(axiosRequestArgs);
|
|
132
132
|
};
|
|
133
133
|
};
|
|
@@ -46,6 +46,13 @@ export class Configuration {
|
|
|
46
46
|
* @memberof Configuration
|
|
47
47
|
*/
|
|
48
48
|
basePath;
|
|
49
|
+
/**
|
|
50
|
+
* override server index
|
|
51
|
+
*
|
|
52
|
+
* @type {number}
|
|
53
|
+
* @memberof Configuration
|
|
54
|
+
*/
|
|
55
|
+
serverIndex;
|
|
49
56
|
/**
|
|
50
57
|
* base options for axios calls
|
|
51
58
|
*
|
|
@@ -67,6 +74,7 @@ export class Configuration {
|
|
|
67
74
|
this.password = param.password;
|
|
68
75
|
this.accessToken = param.accessToken;
|
|
69
76
|
this.basePath = param.basePath;
|
|
77
|
+
this.serverIndex = param.serverIndex;
|
|
70
78
|
this.baseOptions = param.baseOptions;
|
|
71
79
|
this.formDataCtor = param.formDataCtor;
|
|
72
80
|
}
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
|
-
import type { AxiosPromise, AxiosInstance,
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import globalAxios from 'axios';
|
|
15
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
16
|
-
import { CreateQueryResponse } from '../models';
|
|
17
|
-
import { CreateQuerySpecification } from '../models';
|
|
18
|
-
import { GetDocumentResponse } from '../models';
|
|
19
|
-
import { GetQueriesResponse } from '../models';
|
|
20
|
-
import { Query } from '../models';
|
|
15
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
16
|
+
import type { CreateQueryResponse } from '../models';
|
|
17
|
+
import type { CreateQuerySpecification } from '../models';
|
|
18
|
+
import type { GetDocumentResponse } from '../models';
|
|
19
|
+
import type { GetQueriesResponse } from '../models';
|
|
20
|
+
import type { Query } from '../models';
|
|
21
21
|
/**
|
|
22
22
|
* QueriesApi - axios parameter creator
|
|
23
23
|
* @export
|
|
@@ -29,24 +29,24 @@ export declare const QueriesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
29
29
|
* @param {*} [options] Override http request option.
|
|
30
30
|
* @throws {RequiredError}
|
|
31
31
|
*/
|
|
32
|
-
cancelQuery: (queryId: string, options?:
|
|
32
|
+
cancelQuery: (queryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
33
|
/**
|
|
34
34
|
* 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).
|
|
35
35
|
* @param {CreateQuerySpecification} body The body of the request.
|
|
36
36
|
* @param {*} [options] Override http request option.
|
|
37
37
|
* @throws {RequiredError}
|
|
38
38
|
*/
|
|
39
|
-
createQuery: (body: CreateQuerySpecification, options?:
|
|
39
|
+
createQuery: (body: CreateQuerySpecification, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
40
|
/**
|
|
41
41
|
* 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).
|
|
42
42
|
* @param {string} documentId The identifier for the Data Kiosk document.
|
|
43
43
|
* @param {*} [options] Override http request option.
|
|
44
44
|
* @throws {RequiredError}
|
|
45
45
|
*/
|
|
46
|
-
getDocument: (documentId: string, options?:
|
|
46
|
+
getDocument: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
47
|
/**
|
|
48
48
|
* 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).
|
|
49
|
-
* @param {Array<
|
|
49
|
+
* @param {Array<GetQueriesProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter queries.
|
|
50
50
|
* @param {number} [pageSize] The maximum number of queries to return in a single call.
|
|
51
51
|
* @param {string} [createdSince] The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
|
|
52
52
|
* @param {string} [createdUntil] The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.
|
|
@@ -54,14 +54,14 @@ export declare const QueriesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
54
54
|
* @param {*} [options] Override http request option.
|
|
55
55
|
* @throws {RequiredError}
|
|
56
56
|
*/
|
|
57
|
-
getQueries: (processingStatuses?: Array<
|
|
57
|
+
getQueries: (processingStatuses?: Array<GetQueriesProcessingStatusesEnum>, pageSize?: number, createdSince?: string, createdUntil?: string, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
58
|
/**
|
|
59
59
|
* 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).
|
|
60
60
|
* @param {string} queryId The query identifier.
|
|
61
61
|
* @param {*} [options] Override http request option.
|
|
62
62
|
* @throws {RequiredError}
|
|
63
63
|
*/
|
|
64
|
-
getQuery: (queryId: string, options?:
|
|
64
|
+
getQuery: (queryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
65
|
};
|
|
66
66
|
/**
|
|
67
67
|
* QueriesApi - functional programming interface
|
|
@@ -74,24 +74,24 @@ export declare const QueriesApiFp: (configuration?: Configuration) => {
|
|
|
74
74
|
* @param {*} [options] Override http request option.
|
|
75
75
|
* @throws {RequiredError}
|
|
76
76
|
*/
|
|
77
|
-
cancelQuery(queryId: string, options?:
|
|
77
|
+
cancelQuery(queryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
78
78
|
/**
|
|
79
79
|
* 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).
|
|
80
80
|
* @param {CreateQuerySpecification} body The body of the request.
|
|
81
81
|
* @param {*} [options] Override http request option.
|
|
82
82
|
* @throws {RequiredError}
|
|
83
83
|
*/
|
|
84
|
-
createQuery(body: CreateQuerySpecification, options?:
|
|
84
|
+
createQuery(body: CreateQuerySpecification, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateQueryResponse>>;
|
|
85
85
|
/**
|
|
86
86
|
* 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).
|
|
87
87
|
* @param {string} documentId The identifier for the Data Kiosk document.
|
|
88
88
|
* @param {*} [options] Override http request option.
|
|
89
89
|
* @throws {RequiredError}
|
|
90
90
|
*/
|
|
91
|
-
getDocument(documentId: string, options?:
|
|
91
|
+
getDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentResponse>>;
|
|
92
92
|
/**
|
|
93
93
|
* 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).
|
|
94
|
-
* @param {Array<
|
|
94
|
+
* @param {Array<GetQueriesProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter queries.
|
|
95
95
|
* @param {number} [pageSize] The maximum number of queries to return in a single call.
|
|
96
96
|
* @param {string} [createdSince] The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
|
|
97
97
|
* @param {string} [createdUntil] The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.
|
|
@@ -99,14 +99,14 @@ export declare const QueriesApiFp: (configuration?: Configuration) => {
|
|
|
99
99
|
* @param {*} [options] Override http request option.
|
|
100
100
|
* @throws {RequiredError}
|
|
101
101
|
*/
|
|
102
|
-
getQueries(processingStatuses?: Array<
|
|
102
|
+
getQueries(processingStatuses?: Array<GetQueriesProcessingStatusesEnum>, pageSize?: number, createdSince?: string, createdUntil?: string, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQueriesResponse>>;
|
|
103
103
|
/**
|
|
104
104
|
* 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).
|
|
105
105
|
* @param {string} queryId The query identifier.
|
|
106
106
|
* @param {*} [options] Override http request option.
|
|
107
107
|
* @throws {RequiredError}
|
|
108
108
|
*/
|
|
109
|
-
getQuery(queryId: string, options?:
|
|
109
|
+
getQuery(queryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Query>>;
|
|
110
110
|
};
|
|
111
111
|
/**
|
|
112
112
|
* QueriesApi - factory interface
|
|
@@ -119,35 +119,35 @@ export declare const QueriesApiFactory: (configuration?: Configuration, basePath
|
|
|
119
119
|
* @param {*} [options] Override http request option.
|
|
120
120
|
* @throws {RequiredError}
|
|
121
121
|
*/
|
|
122
|
-
cancelQuery(requestParameters: QueriesApiCancelQueryRequest, options?:
|
|
122
|
+
cancelQuery(requestParameters: QueriesApiCancelQueryRequest, 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
125
|
* @param {QueriesApiCreateQueryRequest} requestParameters Request parameters.
|
|
126
126
|
* @param {*} [options] Override http request option.
|
|
127
127
|
* @throws {RequiredError}
|
|
128
128
|
*/
|
|
129
|
-
createQuery(requestParameters: QueriesApiCreateQueryRequest, options?:
|
|
129
|
+
createQuery(requestParameters: QueriesApiCreateQueryRequest, 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
132
|
* @param {QueriesApiGetDocumentRequest} requestParameters Request parameters.
|
|
133
133
|
* @param {*} [options] Override http request option.
|
|
134
134
|
* @throws {RequiredError}
|
|
135
135
|
*/
|
|
136
|
-
getDocument(requestParameters: QueriesApiGetDocumentRequest, options?:
|
|
136
|
+
getDocument(requestParameters: QueriesApiGetDocumentRequest, 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
139
|
* @param {QueriesApiGetQueriesRequest} requestParameters Request parameters.
|
|
140
140
|
* @param {*} [options] Override http request option.
|
|
141
141
|
* @throws {RequiredError}
|
|
142
142
|
*/
|
|
143
|
-
getQueries(requestParameters?: QueriesApiGetQueriesRequest, options?:
|
|
143
|
+
getQueries(requestParameters?: QueriesApiGetQueriesRequest, 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
146
|
* @param {QueriesApiGetQueryRequest} requestParameters Request parameters.
|
|
147
147
|
* @param {*} [options] Override http request option.
|
|
148
148
|
* @throws {RequiredError}
|
|
149
149
|
*/
|
|
150
|
-
getQuery(requestParameters: QueriesApiGetQueryRequest, options?:
|
|
150
|
+
getQuery(requestParameters: QueriesApiGetQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Query>;
|
|
151
151
|
};
|
|
152
152
|
/**
|
|
153
153
|
* Request parameters for cancelQuery operation in QueriesApi.
|
|
@@ -199,7 +199,7 @@ export interface QueriesApiGetQueriesRequest {
|
|
|
199
199
|
* @type {Array<'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'>}
|
|
200
200
|
* @memberof QueriesApiGetQueries
|
|
201
201
|
*/
|
|
202
|
-
readonly processingStatuses?: Array<
|
|
202
|
+
readonly processingStatuses?: Array<GetQueriesProcessingStatusesEnum>;
|
|
203
203
|
/**
|
|
204
204
|
* The maximum number of queries to return in a single call.
|
|
205
205
|
* @type {number}
|
|
@@ -252,7 +252,7 @@ export declare class QueriesApi extends BaseAPI {
|
|
|
252
252
|
* @throws {RequiredError}
|
|
253
253
|
* @memberof QueriesApi
|
|
254
254
|
*/
|
|
255
|
-
cancelQuery(requestParameters: QueriesApiCancelQueryRequest, options?:
|
|
255
|
+
cancelQuery(requestParameters: QueriesApiCancelQueryRequest, 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
258
|
* @param {QueriesApiCreateQueryRequest} requestParameters Request parameters.
|
|
@@ -260,7 +260,7 @@ export declare class QueriesApi extends BaseAPI {
|
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
* @memberof QueriesApi
|
|
262
262
|
*/
|
|
263
|
-
createQuery(requestParameters: QueriesApiCreateQueryRequest, options?:
|
|
263
|
+
createQuery(requestParameters: QueriesApiCreateQueryRequest, 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
266
|
* @param {QueriesApiGetDocumentRequest} requestParameters Request parameters.
|
|
@@ -268,7 +268,7 @@ export declare class QueriesApi extends BaseAPI {
|
|
|
268
268
|
* @throws {RequiredError}
|
|
269
269
|
* @memberof QueriesApi
|
|
270
270
|
*/
|
|
271
|
-
getDocument(requestParameters: QueriesApiGetDocumentRequest, options?:
|
|
271
|
+
getDocument(requestParameters: QueriesApiGetDocumentRequest, 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
274
|
* @param {QueriesApiGetQueriesRequest} requestParameters Request parameters.
|
|
@@ -276,7 +276,7 @@ export declare class QueriesApi extends BaseAPI {
|
|
|
276
276
|
* @throws {RequiredError}
|
|
277
277
|
* @memberof QueriesApi
|
|
278
278
|
*/
|
|
279
|
-
getQueries(requestParameters?: QueriesApiGetQueriesRequest, options?:
|
|
279
|
+
getQueries(requestParameters?: QueriesApiGetQueriesRequest, 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
282
|
* @param {QueriesApiGetQueryRequest} requestParameters Request parameters.
|
|
@@ -284,5 +284,16 @@ export declare class QueriesApi extends BaseAPI {
|
|
|
284
284
|
* @throws {RequiredError}
|
|
285
285
|
* @memberof QueriesApi
|
|
286
286
|
*/
|
|
287
|
-
getQuery(requestParameters: QueriesApiGetQueryRequest, options?:
|
|
287
|
+
getQuery(requestParameters: QueriesApiGetQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Query, any>>;
|
|
288
288
|
}
|
|
289
|
+
/**
|
|
290
|
+
* @export
|
|
291
|
+
*/
|
|
292
|
+
export declare const GetQueriesProcessingStatusesEnum: {
|
|
293
|
+
readonly Cancelled: "CANCELLED";
|
|
294
|
+
readonly Done: "DONE";
|
|
295
|
+
readonly Fatal: "FATAL";
|
|
296
|
+
readonly InProgress: "IN_PROGRESS";
|
|
297
|
+
readonly InQueue: "IN_QUEUE";
|
|
298
|
+
};
|
|
299
|
+
export type GetQueriesProcessingStatusesEnum = typeof GetQueriesProcessingStatusesEnum[keyof typeof GetQueriesProcessingStatusesEnum];
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from './configuration';
|
|
13
|
-
import type { AxiosInstance,
|
|
13
|
+
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
export declare const BASE_PATH: string;
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
@@ -29,7 +29,7 @@ export declare const COLLECTION_FORMATS: {
|
|
|
29
29
|
*/
|
|
30
30
|
export interface RequestArgs {
|
|
31
31
|
url: string;
|
|
32
|
-
options:
|
|
32
|
+
options: RawAxiosRequestConfig;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
35
|
*
|
|
@@ -52,3 +52,15 @@ export declare class RequiredError extends Error {
|
|
|
52
52
|
field: string;
|
|
53
53
|
constructor(field: string, msg?: string);
|
|
54
54
|
}
|
|
55
|
+
interface ServerMap {
|
|
56
|
+
[key: string]: {
|
|
57
|
+
url: string;
|
|
58
|
+
description: string;
|
|
59
|
+
}[];
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const operationServerMap: ServerMap;
|
|
66
|
+
export {};
|
|
@@ -15,6 +15,7 @@ export interface ConfigurationParameters {
|
|
|
15
15
|
password?: string;
|
|
16
16
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
17
17
|
basePath?: string;
|
|
18
|
+
serverIndex?: number;
|
|
18
19
|
baseOptions?: any;
|
|
19
20
|
formDataCtor?: new () => any;
|
|
20
21
|
}
|
|
@@ -53,6 +54,13 @@ export declare class Configuration {
|
|
|
53
54
|
* @memberof Configuration
|
|
54
55
|
*/
|
|
55
56
|
basePath?: string;
|
|
57
|
+
/**
|
|
58
|
+
* override server index
|
|
59
|
+
*
|
|
60
|
+
* @type {number}
|
|
61
|
+
* @memberof Configuration
|
|
62
|
+
*/
|
|
63
|
+
serverIndex?: number;
|
|
56
64
|
/**
|
|
57
65
|
* base options for axios calls
|
|
58
66
|
*
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { GetQueriesResponsePagination } from './get-queries-response-pagination';
|
|
13
|
-
import { Query } from './query';
|
|
12
|
+
import type { GetQueriesResponsePagination } from './get-queries-response-pagination';
|
|
13
|
+
import type { Query } from './query';
|
|
14
14
|
/**
|
|
15
15
|
* The response for the `getQueries` operation.
|
|
16
16
|
* @export
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sp-api-sdk/data-kiosk-api-2023-11-15",
|
|
3
|
-
"author": "
|
|
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": "1.
|
|
5
|
+
"version": "1.3.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.0.
|
|
22
|
-
"axios": "^1.
|
|
21
|
+
"@sp-api-sdk/common": "2.0.8",
|
|
22
|
+
"axios": "^1.7.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": "
|
|
43
|
+
"gitHead": "5a245a25a9f1765c825e2178668d4b0f4e44689b"
|
|
44
44
|
}
|