@sp-api-sdk/data-kiosk-api-2023-11-15 3.0.0 → 3.0.2

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.
@@ -25,7 +25,6 @@ const common_1 = require("../common");
25
25
  const base_1 = require("../base");
26
26
  /**
27
27
  * DataKioskApi - axios parameter creator
28
- * @export
29
28
  */
30
29
  const DataKioskApiAxiosParamCreator = function (configuration) {
31
30
  return {
@@ -195,7 +194,6 @@ const DataKioskApiAxiosParamCreator = function (configuration) {
195
194
  exports.DataKioskApiAxiosParamCreator = DataKioskApiAxiosParamCreator;
196
195
  /**
197
196
  * DataKioskApi - functional programming interface
198
- * @export
199
197
  */
200
198
  const DataKioskApiFp = function (configuration) {
201
199
  const localVarAxiosParamCreator = (0, exports.DataKioskApiAxiosParamCreator)(configuration);
@@ -269,7 +267,6 @@ const DataKioskApiFp = function (configuration) {
269
267
  exports.DataKioskApiFp = DataKioskApiFp;
270
268
  /**
271
269
  * DataKioskApi - factory interface
272
- * @export
273
270
  */
274
271
  const DataKioskApiFactory = function (configuration, basePath, axios) {
275
272
  const localVarFp = (0, exports.DataKioskApiFp)(configuration);
@@ -324,9 +321,6 @@ const DataKioskApiFactory = function (configuration, basePath, axios) {
324
321
  exports.DataKioskApiFactory = DataKioskApiFactory;
325
322
  /**
326
323
  * DataKioskApi - object-oriented interface
327
- * @export
328
- * @class DataKioskApi
329
- * @extends {BaseAPI}
330
324
  */
331
325
  class DataKioskApi extends base_1.BaseAPI {
332
326
  /**
@@ -334,7 +328,6 @@ class DataKioskApi extends base_1.BaseAPI {
334
328
  * @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
335
329
  * @param {*} [options] Override http request option.
336
330
  * @throws {RequiredError}
337
- * @memberof DataKioskApi
338
331
  */
339
332
  cancelQuery(requestParameters, options) {
340
333
  return (0, exports.DataKioskApiFp)(this.configuration).cancelQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
@@ -344,7 +337,6 @@ class DataKioskApi extends base_1.BaseAPI {
344
337
  * @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
345
338
  * @param {*} [options] Override http request option.
346
339
  * @throws {RequiredError}
347
- * @memberof DataKioskApi
348
340
  */
349
341
  createQuery(requestParameters, options) {
350
342
  return (0, exports.DataKioskApiFp)(this.configuration).createQuery(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -354,7 +346,6 @@ class DataKioskApi extends base_1.BaseAPI {
354
346
  * @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
355
347
  * @param {*} [options] Override http request option.
356
348
  * @throws {RequiredError}
357
- * @memberof DataKioskApi
358
349
  */
359
350
  getDocument(requestParameters, options) {
360
351
  return (0, exports.DataKioskApiFp)(this.configuration).getDocument(requestParameters.documentId, options).then((request) => request(this.axios, this.basePath));
@@ -364,7 +355,6 @@ class DataKioskApi extends base_1.BaseAPI {
364
355
  * @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
365
356
  * @param {*} [options] Override http request option.
366
357
  * @throws {RequiredError}
367
- * @memberof DataKioskApi
368
358
  */
369
359
  getQueries(requestParameters = {}, options) {
370
360
  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));
@@ -374,16 +364,12 @@ class DataKioskApi extends base_1.BaseAPI {
374
364
  * @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
375
365
  * @param {*} [options] Override http request option.
376
366
  * @throws {RequiredError}
377
- * @memberof DataKioskApi
378
367
  */
379
368
  getQuery(requestParameters, options) {
380
369
  return (0, exports.DataKioskApiFp)(this.configuration).getQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
381
370
  }
382
371
  }
383
372
  exports.DataKioskApi = DataKioskApi;
384
- /**
385
- * @export
386
- */
387
373
  exports.GetQueriesProcessingStatusesEnum = {
388
374
  Cancelled: 'CANCELLED',
389
375
  Done: 'DONE',
@@ -19,21 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
19
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
- /**
23
- *
24
- * @export
25
- */
26
22
  exports.COLLECTION_FORMATS = {
27
23
  csv: ",",
28
24
  ssv: " ",
29
25
  tsv: "\t",
30
26
  pipes: "|",
31
27
  };
32
- /**
33
- *
34
- * @export
35
- * @class BaseAPI
36
- */
37
28
  class BaseAPI {
38
29
  basePath;
39
30
  axios;
@@ -49,12 +40,6 @@ class BaseAPI {
49
40
  }
50
41
  exports.BaseAPI = BaseAPI;
51
42
  ;
52
- /**
53
- *
54
- * @export
55
- * @class RequiredError
56
- * @extends {Error}
57
- */
58
43
  class RequiredError extends Error {
59
44
  field;
60
45
  constructor(field, msg) {
@@ -64,8 +49,4 @@ class RequiredError extends Error {
64
49
  }
65
50
  }
66
51
  exports.RequiredError = RequiredError;
67
- /**
68
- *
69
- * @export
70
- */
71
52
  exports.operationServerMap = {};
@@ -15,15 +15,10 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
17
17
  const base_1 = require("./base");
18
- /**
19
- *
20
- * @export
21
- */
22
18
  exports.DUMMY_BASE_URL = 'https://example.com';
23
19
  /**
24
20
  *
25
21
  * @throws {RequiredError}
26
- * @export
27
22
  */
28
23
  const assertParamExists = function (functionName, paramName, paramValue) {
29
24
  if (paramValue === null || paramValue === undefined) {
@@ -31,10 +26,6 @@ const assertParamExists = function (functionName, paramName, paramValue) {
31
26
  }
32
27
  };
33
28
  exports.assertParamExists = assertParamExists;
34
- /**
35
- *
36
- * @export
37
- */
38
29
  const setApiKeyToObject = async function (object, keyParamName, configuration) {
39
30
  if (configuration && configuration.apiKey) {
40
31
  const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -44,20 +35,12 @@ const setApiKeyToObject = async function (object, keyParamName, configuration) {
44
35
  }
45
36
  };
46
37
  exports.setApiKeyToObject = setApiKeyToObject;
47
- /**
48
- *
49
- * @export
50
- */
51
38
  const setBasicAuthToObject = function (object, configuration) {
52
39
  if (configuration && (configuration.username || configuration.password)) {
53
40
  object["auth"] = { username: configuration.username, password: configuration.password };
54
41
  }
55
42
  };
56
43
  exports.setBasicAuthToObject = setBasicAuthToObject;
57
- /**
58
- *
59
- * @export
60
- */
61
44
  const setBearerAuthToObject = async function (object, configuration) {
62
45
  if (configuration && configuration.accessToken) {
63
46
  const accessToken = typeof configuration.accessToken === 'function'
@@ -67,10 +50,6 @@ const setBearerAuthToObject = async function (object, configuration) {
67
50
  }
68
51
  };
69
52
  exports.setBearerAuthToObject = setBearerAuthToObject;
70
- /**
71
- *
72
- * @export
73
- */
74
53
  const setOAuthToObject = async function (object, name, scopes, configuration) {
75
54
  if (configuration && configuration.accessToken) {
76
55
  const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -100,20 +79,12 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
100
79
  }
101
80
  }
102
81
  }
103
- /**
104
- *
105
- * @export
106
- */
107
82
  const setSearchParams = function (url, ...objects) {
108
83
  const searchParams = new URLSearchParams(url.search);
109
84
  setFlattenedQueryParams(searchParams, objects);
110
85
  url.search = searchParams.toString();
111
86
  };
112
87
  exports.setSearchParams = setSearchParams;
113
- /**
114
- *
115
- * @export
116
- */
117
88
  const serializeDataIfNeeded = function (value, requestOptions, configuration) {
118
89
  const nonString = typeof value !== 'string';
119
90
  const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -124,18 +95,10 @@ const serializeDataIfNeeded = function (value, requestOptions, configuration) {
124
95
  : (value || "");
125
96
  };
126
97
  exports.serializeDataIfNeeded = serializeDataIfNeeded;
127
- /**
128
- *
129
- * @export
130
- */
131
98
  const toPathString = function (url) {
132
99
  return url.pathname + url.search + url.hash;
133
100
  };
134
101
  exports.toPathString = toPathString;
135
- /**
136
- *
137
- * @export
138
- */
139
102
  const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
140
103
  return (axios = globalAxios, basePath = BASE_PATH) => {
141
104
  const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
@@ -18,49 +18,32 @@ class Configuration {
18
18
  /**
19
19
  * parameter for apiKey security
20
20
  * @param name security name
21
- * @memberof Configuration
22
21
  */
23
22
  apiKey;
24
23
  /**
25
24
  * parameter for basic security
26
- *
27
- * @type {string}
28
- * @memberof Configuration
29
25
  */
30
26
  username;
31
27
  /**
32
28
  * parameter for basic security
33
- *
34
- * @type {string}
35
- * @memberof Configuration
36
29
  */
37
30
  password;
38
31
  /**
39
32
  * parameter for oauth2 security
40
33
  * @param name security name
41
34
  * @param scopes oauth2 scope
42
- * @memberof Configuration
43
35
  */
44
36
  accessToken;
45
37
  /**
46
38
  * override base path
47
- *
48
- * @type {string}
49
- * @memberof Configuration
50
39
  */
51
40
  basePath;
52
41
  /**
53
42
  * override server index
54
- *
55
- * @type {number}
56
- * @memberof Configuration
57
43
  */
58
44
  serverIndex;
59
45
  /**
60
46
  * base options for axios calls
61
- *
62
- * @type {any}
63
- * @memberof Configuration
64
47
  */
65
48
  baseOptions;
66
49
  /**
@@ -19,7 +19,6 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeed
19
19
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
20
20
  /**
21
21
  * DataKioskApi - axios parameter creator
22
- * @export
23
22
  */
24
23
  export const DataKioskApiAxiosParamCreator = function (configuration) {
25
24
  return {
@@ -188,7 +187,6 @@ export const DataKioskApiAxiosParamCreator = function (configuration) {
188
187
  };
189
188
  /**
190
189
  * DataKioskApi - functional programming interface
191
- * @export
192
190
  */
193
191
  export const DataKioskApiFp = function (configuration) {
194
192
  const localVarAxiosParamCreator = DataKioskApiAxiosParamCreator(configuration);
@@ -261,7 +259,6 @@ export const DataKioskApiFp = function (configuration) {
261
259
  };
262
260
  /**
263
261
  * DataKioskApi - factory interface
264
- * @export
265
262
  */
266
263
  export const DataKioskApiFactory = function (configuration, basePath, axios) {
267
264
  const localVarFp = DataKioskApiFp(configuration);
@@ -315,9 +312,6 @@ export const DataKioskApiFactory = function (configuration, basePath, axios) {
315
312
  };
316
313
  /**
317
314
  * DataKioskApi - object-oriented interface
318
- * @export
319
- * @class DataKioskApi
320
- * @extends {BaseAPI}
321
315
  */
322
316
  export class DataKioskApi extends BaseAPI {
323
317
  /**
@@ -325,7 +319,6 @@ export class DataKioskApi extends BaseAPI {
325
319
  * @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
326
320
  * @param {*} [options] Override http request option.
327
321
  * @throws {RequiredError}
328
- * @memberof DataKioskApi
329
322
  */
330
323
  cancelQuery(requestParameters, options) {
331
324
  return DataKioskApiFp(this.configuration).cancelQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
@@ -335,7 +328,6 @@ export class DataKioskApi extends BaseAPI {
335
328
  * @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
336
329
  * @param {*} [options] Override http request option.
337
330
  * @throws {RequiredError}
338
- * @memberof DataKioskApi
339
331
  */
340
332
  createQuery(requestParameters, options) {
341
333
  return DataKioskApiFp(this.configuration).createQuery(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -345,7 +337,6 @@ export class DataKioskApi extends BaseAPI {
345
337
  * @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
346
338
  * @param {*} [options] Override http request option.
347
339
  * @throws {RequiredError}
348
- * @memberof DataKioskApi
349
340
  */
350
341
  getDocument(requestParameters, options) {
351
342
  return DataKioskApiFp(this.configuration).getDocument(requestParameters.documentId, options).then((request) => request(this.axios, this.basePath));
@@ -355,7 +346,6 @@ export class DataKioskApi extends BaseAPI {
355
346
  * @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
356
347
  * @param {*} [options] Override http request option.
357
348
  * @throws {RequiredError}
358
- * @memberof DataKioskApi
359
349
  */
360
350
  getQueries(requestParameters = {}, options) {
361
351
  return DataKioskApiFp(this.configuration).getQueries(requestParameters.processingStatuses, requestParameters.pageSize, requestParameters.createdSince, requestParameters.createdUntil, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
@@ -365,15 +355,11 @@ export class DataKioskApi extends BaseAPI {
365
355
  * @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
366
356
  * @param {*} [options] Override http request option.
367
357
  * @throws {RequiredError}
368
- * @memberof DataKioskApi
369
358
  */
370
359
  getQuery(requestParameters, options) {
371
360
  return DataKioskApiFp(this.configuration).getQuery(requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
372
361
  }
373
362
  }
374
- /**
375
- * @export
376
- */
377
363
  export const GetQueriesProcessingStatusesEnum = {
378
364
  Cancelled: 'CANCELLED',
379
365
  Done: 'DONE',
@@ -13,21 +13,12 @@
13
13
  */
14
14
  import globalAxios from 'axios';
15
15
  export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
16
- /**
17
- *
18
- * @export
19
- */
20
16
  export const COLLECTION_FORMATS = {
21
17
  csv: ",",
22
18
  ssv: " ",
23
19
  tsv: "\t",
24
20
  pipes: "|",
25
21
  };
26
- /**
27
- *
28
- * @export
29
- * @class BaseAPI
30
- */
31
22
  export class BaseAPI {
32
23
  basePath;
33
24
  axios;
@@ -42,12 +33,6 @@ export class BaseAPI {
42
33
  }
43
34
  }
44
35
  ;
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
36
  export class RequiredError extends Error {
52
37
  field;
53
38
  constructor(field, msg) {
@@ -56,8 +41,4 @@ export class RequiredError extends Error {
56
41
  this.name = "RequiredError";
57
42
  }
58
43
  }
59
- /**
60
- *
61
- * @export
62
- */
63
44
  export const operationServerMap = {};
@@ -12,25 +12,16 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { RequiredError } from "./base";
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export const DUMMY_BASE_URL = 'https://example.com';
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export const assertParamExists = function (functionName, paramName, paramValue) {
26
21
  if (paramValue === null || paramValue === undefined) {
27
22
  throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
28
23
  }
29
24
  };
30
- /**
31
- *
32
- * @export
33
- */
34
25
  export const setApiKeyToObject = async function (object, keyParamName, configuration) {
35
26
  if (configuration && configuration.apiKey) {
36
27
  const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -39,19 +30,11 @@ export const setApiKeyToObject = async function (object, keyParamName, configura
39
30
  object[keyParamName] = localVarApiKeyValue;
40
31
  }
41
32
  };
42
- /**
43
- *
44
- * @export
45
- */
46
33
  export const setBasicAuthToObject = function (object, configuration) {
47
34
  if (configuration && (configuration.username || configuration.password)) {
48
35
  object["auth"] = { username: configuration.username, password: configuration.password };
49
36
  }
50
37
  };
51
- /**
52
- *
53
- * @export
54
- */
55
38
  export const setBearerAuthToObject = async function (object, configuration) {
56
39
  if (configuration && configuration.accessToken) {
57
40
  const accessToken = typeof configuration.accessToken === 'function'
@@ -60,10 +43,6 @@ export const setBearerAuthToObject = async function (object, configuration) {
60
43
  object["Authorization"] = "Bearer " + accessToken;
61
44
  }
62
45
  };
63
- /**
64
- *
65
- * @export
66
- */
67
46
  export const setOAuthToObject = async function (object, name, scopes, configuration) {
68
47
  if (configuration && configuration.accessToken) {
69
48
  const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -92,19 +71,11 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
92
71
  }
93
72
  }
94
73
  }
95
- /**
96
- *
97
- * @export
98
- */
99
74
  export const setSearchParams = function (url, ...objects) {
100
75
  const searchParams = new URLSearchParams(url.search);
101
76
  setFlattenedQueryParams(searchParams, objects);
102
77
  url.search = searchParams.toString();
103
78
  };
104
- /**
105
- *
106
- * @export
107
- */
108
79
  export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
109
80
  const nonString = typeof value !== 'string';
110
81
  const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -114,17 +85,9 @@ export const serializeDataIfNeeded = function (value, requestOptions, configurat
114
85
  ? JSON.stringify(value !== undefined ? value : {})
115
86
  : (value || "");
116
87
  };
117
- /**
118
- *
119
- * @export
120
- */
121
88
  export const toPathString = function (url) {
122
89
  return url.pathname + url.search + url.hash;
123
90
  };
124
- /**
125
- *
126
- * @export
127
- */
128
91
  export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
129
92
  return (axios = globalAxios, basePath = BASE_PATH) => {
130
93
  const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
@@ -15,49 +15,32 @@ export class Configuration {
15
15
  /**
16
16
  * parameter for apiKey security
17
17
  * @param name security name
18
- * @memberof Configuration
19
18
  */
20
19
  apiKey;
21
20
  /**
22
21
  * parameter for basic security
23
- *
24
- * @type {string}
25
- * @memberof Configuration
26
22
  */
27
23
  username;
28
24
  /**
29
25
  * parameter for basic security
30
- *
31
- * @type {string}
32
- * @memberof Configuration
33
26
  */
34
27
  password;
35
28
  /**
36
29
  * parameter for oauth2 security
37
30
  * @param name security name
38
31
  * @param scopes oauth2 scope
39
- * @memberof Configuration
40
32
  */
41
33
  accessToken;
42
34
  /**
43
35
  * override base path
44
- *
45
- * @type {string}
46
- * @memberof Configuration
47
36
  */
48
37
  basePath;
49
38
  /**
50
39
  * override server index
51
- *
52
- * @type {number}
53
- * @memberof Configuration
54
40
  */
55
41
  serverIndex;
56
42
  /**
57
43
  * base options for axios calls
58
- *
59
- * @type {any}
60
- * @memberof Configuration
61
44
  */
62
45
  baseOptions;
63
46
  /**
@@ -20,7 +20,6 @@ import type { GetQueriesResponse } from '../models';
20
20
  import type { Query } from '../models';
21
21
  /**
22
22
  * DataKioskApi - axios parameter creator
23
- * @export
24
23
  */
25
24
  export declare const DataKioskApiAxiosParamCreator: (configuration?: Configuration) => {
26
25
  /**
@@ -65,7 +64,6 @@ export declare const DataKioskApiAxiosParamCreator: (configuration?: Configurati
65
64
  };
66
65
  /**
67
66
  * DataKioskApi - functional programming interface
68
- * @export
69
67
  */
70
68
  export declare const DataKioskApiFp: (configuration?: Configuration) => {
71
69
  /**
@@ -110,7 +108,6 @@ export declare const DataKioskApiFp: (configuration?: Configuration) => {
110
108
  };
111
109
  /**
112
110
  * DataKioskApi - factory interface
113
- * @export
114
111
  */
115
112
  export declare const DataKioskApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
116
113
  /**
@@ -151,98 +148,67 @@ export declare const DataKioskApiFactory: (configuration?: Configuration, basePa
151
148
  };
152
149
  /**
153
150
  * Request parameters for cancelQuery operation in DataKioskApi.
154
- * @export
155
- * @interface DataKioskApiCancelQueryRequest
156
151
  */
157
152
  export interface DataKioskApiCancelQueryRequest {
158
153
  /**
159
154
  * The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
160
- * @type {string}
161
- * @memberof DataKioskApiCancelQuery
162
155
  */
163
156
  readonly queryId: string;
164
157
  }
165
158
  /**
166
159
  * Request parameters for createQuery operation in DataKioskApi.
167
- * @export
168
- * @interface DataKioskApiCreateQueryRequest
169
160
  */
170
161
  export interface DataKioskApiCreateQueryRequest {
171
162
  /**
172
163
  * The body of the request.
173
- * @type {CreateQuerySpecification}
174
- * @memberof DataKioskApiCreateQuery
175
164
  */
176
165
  readonly body: CreateQuerySpecification;
177
166
  }
178
167
  /**
179
168
  * Request parameters for getDocument operation in DataKioskApi.
180
- * @export
181
- * @interface DataKioskApiGetDocumentRequest
182
169
  */
183
170
  export interface DataKioskApiGetDocumentRequest {
184
171
  /**
185
172
  * The identifier for the Data Kiosk document.
186
- * @type {string}
187
- * @memberof DataKioskApiGetDocument
188
173
  */
189
174
  readonly documentId: string;
190
175
  }
191
176
  /**
192
177
  * Request parameters for getQueries operation in DataKioskApi.
193
- * @export
194
- * @interface DataKioskApiGetQueriesRequest
195
178
  */
196
179
  export interface DataKioskApiGetQueriesRequest {
197
180
  /**
198
181
  * A list of processing statuses used to filter queries.
199
- * @type {Array<'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'>}
200
- * @memberof DataKioskApiGetQueries
201
182
  */
202
183
  readonly processingStatuses?: Array<GetQueriesProcessingStatusesEnum>;
203
184
  /**
204
185
  * The maximum number of queries to return in a single call.
205
- * @type {number}
206
- * @memberof DataKioskApiGetQueries
207
186
  */
208
187
  readonly pageSize?: number;
209
188
  /**
210
189
  * 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
- * @type {string}
212
- * @memberof DataKioskApiGetQueries
213
190
  */
214
191
  readonly createdSince?: string;
215
192
  /**
216
193
  * 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
- * @type {string}
218
- * @memberof DataKioskApiGetQueries
219
194
  */
220
195
  readonly createdUntil?: string;
221
196
  /**
222
197
  * 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
- * @type {string}
224
- * @memberof DataKioskApiGetQueries
225
198
  */
226
199
  readonly paginationToken?: string;
227
200
  }
228
201
  /**
229
202
  * Request parameters for getQuery operation in DataKioskApi.
230
- * @export
231
- * @interface DataKioskApiGetQueryRequest
232
203
  */
233
204
  export interface DataKioskApiGetQueryRequest {
234
205
  /**
235
206
  * The query identifier.
236
- * @type {string}
237
- * @memberof DataKioskApiGetQuery
238
207
  */
239
208
  readonly queryId: string;
240
209
  }
241
210
  /**
242
211
  * DataKioskApi - object-oriented interface
243
- * @export
244
- * @class DataKioskApi
245
- * @extends {BaseAPI}
246
212
  */
247
213
  export declare class DataKioskApi extends BaseAPI {
248
214
  /**
@@ -250,7 +216,6 @@ export declare class DataKioskApi extends BaseAPI {
250
216
  * @param {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
251
217
  * @param {*} [options] Override http request option.
252
218
  * @throws {RequiredError}
253
- * @memberof DataKioskApi
254
219
  */
255
220
  cancelQuery(requestParameters: DataKioskApiCancelQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
256
221
  /**
@@ -258,7 +223,6 @@ export declare class DataKioskApi extends BaseAPI {
258
223
  * @param {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
259
224
  * @param {*} [options] Override http request option.
260
225
  * @throws {RequiredError}
261
- * @memberof DataKioskApi
262
226
  */
263
227
  createQuery(requestParameters: DataKioskApiCreateQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateQueryResponse, any>>;
264
228
  /**
@@ -266,7 +230,6 @@ export declare class DataKioskApi extends BaseAPI {
266
230
  * @param {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
267
231
  * @param {*} [options] Override http request option.
268
232
  * @throws {RequiredError}
269
- * @memberof DataKioskApi
270
233
  */
271
234
  getDocument(requestParameters: DataKioskApiGetDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDocumentResponse, any>>;
272
235
  /**
@@ -274,7 +237,6 @@ export declare class DataKioskApi extends BaseAPI {
274
237
  * @param {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
275
238
  * @param {*} [options] Override http request option.
276
239
  * @throws {RequiredError}
277
- * @memberof DataKioskApi
278
240
  */
279
241
  getQueries(requestParameters?: DataKioskApiGetQueriesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetQueriesResponse, any>>;
280
242
  /**
@@ -282,13 +244,9 @@ export declare class DataKioskApi extends BaseAPI {
282
244
  * @param {DataKioskApiGetQueryRequest} requestParameters Request parameters.
283
245
  * @param {*} [options] Override http request option.
284
246
  * @throws {RequiredError}
285
- * @memberof DataKioskApi
286
247
  */
287
248
  getQuery(requestParameters: DataKioskApiGetQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Query, any>>;
288
249
  }
289
- /**
290
- * @export
291
- */
292
250
  export declare const GetQueriesProcessingStatusesEnum: {
293
251
  readonly Cancelled: "CANCELLED";
294
252
  readonly Done: "DONE";
@@ -12,42 +12,22 @@
12
12
  import type { Configuration } from './configuration';
13
13
  import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  export declare const BASE_PATH: string;
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const COLLECTION_FORMATS: {
20
16
  csv: string;
21
17
  ssv: string;
22
18
  tsv: string;
23
19
  pipes: string;
24
20
  };
25
- /**
26
- *
27
- * @export
28
- * @interface RequestArgs
29
- */
30
21
  export interface RequestArgs {
31
22
  url: string;
32
23
  options: RawAxiosRequestConfig;
33
24
  }
34
- /**
35
- *
36
- * @export
37
- * @class BaseAPI
38
- */
39
25
  export declare class BaseAPI {
40
26
  protected basePath: string;
41
27
  protected axios: AxiosInstance;
42
28
  protected configuration: Configuration | undefined;
43
29
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
44
30
  }
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
31
  export declare class RequiredError extends Error {
52
32
  field: string;
53
33
  constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
58
38
  description: string;
59
39
  }[];
60
40
  }
61
- /**
62
- *
63
- * @export
64
- */
65
41
  export declare const operationServerMap: ServerMap;
66
42
  export {};
@@ -12,54 +12,17 @@
12
12
  import type { Configuration } from "./configuration";
13
13
  import type { RequestArgs } from "./base";
14
14
  import type { AxiosInstance, AxiosResponse } from 'axios';
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const DUMMY_BASE_URL = "https://example.com";
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
26
- /**
27
- *
28
- * @export
29
- */
30
21
  export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
31
- /**
32
- *
33
- * @export
34
- */
35
22
  export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
36
- /**
37
- *
38
- * @export
39
- */
40
23
  export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
41
- /**
42
- *
43
- * @export
44
- */
45
24
  export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
46
- /**
47
- *
48
- * @export
49
- */
50
25
  export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
51
- /**
52
- *
53
- * @export
54
- */
55
26
  export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
56
- /**
57
- *
58
- * @export
59
- */
60
27
  export declare const toPathString: (url: URL) => string;
61
- /**
62
- *
63
- * @export
64
- */
65
28
  export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
@@ -23,49 +23,32 @@ export declare class Configuration {
23
23
  /**
24
24
  * parameter for apiKey security
25
25
  * @param name security name
26
- * @memberof Configuration
27
26
  */
28
27
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
28
  /**
30
29
  * parameter for basic security
31
- *
32
- * @type {string}
33
- * @memberof Configuration
34
30
  */
35
31
  username?: string;
36
32
  /**
37
33
  * parameter for basic security
38
- *
39
- * @type {string}
40
- * @memberof Configuration
41
34
  */
42
35
  password?: string;
43
36
  /**
44
37
  * parameter for oauth2 security
45
38
  * @param name security name
46
39
  * @param scopes oauth2 scope
47
- * @memberof Configuration
48
40
  */
49
41
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
50
42
  /**
51
43
  * override base path
52
- *
53
- * @type {string}
54
- * @memberof Configuration
55
44
  */
56
45
  basePath?: string;
57
46
  /**
58
47
  * override server index
59
- *
60
- * @type {number}
61
- * @memberof Configuration
62
48
  */
63
49
  serverIndex?: number;
64
50
  /**
65
51
  * base options for axios calls
66
- *
67
- * @type {any}
68
- * @memberof Configuration
69
52
  */
70
53
  baseOptions?: any;
71
54
  /**
@@ -11,14 +11,10 @@
11
11
  */
12
12
  /**
13
13
  * The response for the `createQuery` operation.
14
- * @export
15
- * @interface CreateQueryResponse
16
14
  */
17
15
  export interface CreateQueryResponse {
18
16
  /**
19
17
  * The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
20
- * @type {string}
21
- * @memberof CreateQueryResponse
22
18
  */
23
19
  'queryId': string;
24
20
  }
@@ -11,20 +11,14 @@
11
11
  */
12
12
  /**
13
13
  * Information required to create the query.
14
- * @export
15
- * @interface CreateQuerySpecification
16
14
  */
17
15
  export interface CreateQuerySpecification {
18
16
  /**
19
17
  * The GraphQL query to submit. A query must be at most 8000 characters after unnecessary whitespace is removed.
20
- * @type {string}
21
- * @memberof CreateQuerySpecification
22
18
  */
23
19
  'query': string;
24
20
  /**
25
21
  * A token to fetch a certain page of query results when there are multiple pages of query results available. The value of this token must be fetched from the `pagination.nextToken` field of the `Query` object, and the `query` field for this object must also be set to the `query` field of the same `Query` object. A `Query` object can be retrieved from either the `getQueries` or `getQuery` operation. In the absence of this token value, the first page of query results will be requested.
26
- * @type {string}
27
- * @memberof CreateQuerySpecification
28
22
  */
29
23
  'paginationToken'?: string;
30
24
  }
@@ -11,14 +11,10 @@
11
11
  */
12
12
  /**
13
13
  * A list of error responses returned when a request is unsuccessful.
14
- * @export
15
- * @interface ErrorList
16
14
  */
17
15
  export interface ErrorList {
18
16
  /**
19
17
  * Error response returned when the request is unsuccessful.
20
- * @type {Array<Error>}
21
- * @memberof ErrorList
22
18
  */
23
19
  'errors': Array<Error>;
24
20
  }
@@ -11,20 +11,14 @@
11
11
  */
12
12
  /**
13
13
  * The response for the `getDocument` operation.
14
- * @export
15
- * @interface GetDocumentResponse
16
14
  */
17
15
  export interface GetDocumentResponse {
18
16
  /**
19
17
  * The identifier for the Data Kiosk document. This identifier is unique only in combination with a selling partner account ID.
20
- * @type {string}
21
- * @memberof GetDocumentResponse
22
18
  */
23
19
  'documentId': string;
24
20
  /**
25
21
  * A presigned URL that can be used to retrieve the Data Kiosk document. This URL expires after 5 minutes. If the Data Kiosk document is compressed, the `Content-Encoding` header will indicate the compression algorithm. **Note:** Most HTTP clients are capable of automatically decompressing downloaded files based on the `Content-Encoding` header.
26
- * @type {string}
27
- * @memberof GetDocumentResponse
28
22
  */
29
23
  'documentUrl': string;
30
24
  }
@@ -11,14 +11,10 @@
11
11
  */
12
12
  /**
13
13
  * When a request has results that are not included in this response, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass the `nextToken` as the `paginationToken` query parameter in the subsequent `getQueries` request. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. When there are no more pages to fetch, the `nextToken` field will be absent.
14
- * @export
15
- * @interface GetQueriesResponsePagination
16
14
  */
17
15
  export interface GetQueriesResponsePagination {
18
16
  /**
19
17
  * A token that can be used to fetch the next page of results.
20
- * @type {string}
21
- * @memberof GetQueriesResponsePagination
22
18
  */
23
19
  'nextToken'?: string;
24
20
  }
@@ -13,20 +13,11 @@ import type { GetQueriesResponsePagination } from './get-queries-response-pagina
13
13
  import type { Query } from './query';
14
14
  /**
15
15
  * The response for the `getQueries` operation.
16
- * @export
17
- * @interface GetQueriesResponse
18
16
  */
19
17
  export interface GetQueriesResponse {
20
18
  /**
21
19
  * A list of queries.
22
- * @type {Array<Query>}
23
- * @memberof GetQueriesResponse
24
20
  */
25
21
  'queries': Array<Query>;
26
- /**
27
- *
28
- * @type {GetQueriesResponsePagination}
29
- * @memberof GetQueriesResponse
30
- */
31
22
  'pagination'?: GetQueriesResponsePagination;
32
23
  }
@@ -11,26 +11,18 @@
11
11
  */
12
12
  /**
13
13
  * Error response returned when the request is unsuccessful.
14
- * @export
15
- * @interface ModelError
16
14
  */
17
15
  export interface ModelError {
18
16
  /**
19
17
  * An error code that identifies the type of error that occurred.
20
- * @type {string}
21
- * @memberof ModelError
22
18
  */
23
19
  'code': string;
24
20
  /**
25
21
  * A message that describes the error condition.
26
- * @type {string}
27
- * @memberof ModelError
28
22
  */
29
23
  'message': string;
30
24
  /**
31
25
  * Additional details that can help the caller understand or fix the issue.
32
- * @type {string}
33
- * @memberof ModelError
34
26
  */
35
27
  'details'?: string;
36
28
  }
@@ -11,14 +11,10 @@
11
11
  */
12
12
  /**
13
13
  * When a query produces results that are not included in the data document, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass a `CreateQuerySpecification` object with `paginationToken` set to this object\'s `nextToken` and with `query` set to this object\'s `query` in the subsequent `createQuery` request. When there are no more pages to fetch, the `nextToken` field will be absent.
14
- * @export
15
- * @interface QueryPagination
16
14
  */
17
15
  export interface QueryPagination {
18
16
  /**
19
17
  * A token that can be used to fetch the next page of results.
20
- * @type {string}
21
- * @memberof QueryPagination
22
18
  */
23
19
  'nextToken'?: string;
24
20
  }
@@ -12,63 +12,40 @@
12
12
  import type { QueryPagination } from './query-pagination';
13
13
  /**
14
14
  * Detailed information about the query.
15
- * @export
16
- * @interface Query
17
15
  */
18
16
  export interface Query {
19
17
  /**
20
18
  * The query identifier. This identifier is unique only in combination with a selling partner account ID.
21
- * @type {string}
22
- * @memberof Query
23
19
  */
24
20
  'queryId': string;
25
21
  /**
26
22
  * The submitted query.
27
- * @type {string}
28
- * @memberof Query
29
23
  */
30
24
  'query': string;
31
25
  /**
32
26
  * The date and time when the query was created, in ISO 8601 date time format.
33
- * @type {string}
34
- * @memberof Query
35
27
  */
36
28
  'createdTime': string;
37
29
  /**
38
30
  * The processing status of the query.
39
- * @type {string}
40
- * @memberof Query
41
31
  */
42
32
  'processingStatus': QueryProcessingStatusEnum;
43
33
  /**
44
34
  * The date and time when the query processing started, in ISO 8601 date time format.
45
- * @type {string}
46
- * @memberof Query
47
35
  */
48
36
  'processingStartTime'?: string;
49
37
  /**
50
38
  * The date and time when the query processing completed, in ISO 8601 date time format.
51
- * @type {string}
52
- * @memberof Query
53
39
  */
54
40
  'processingEndTime'?: string;
55
41
  /**
56
42
  * The data document identifier. This identifier is only present when there is data available as a result of the query. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the `getDocument` operation to get the information required to retrieve the data document\'s contents.
57
- * @type {string}
58
- * @memberof Query
59
43
  */
60
44
  'dataDocumentId'?: string;
61
45
  /**
62
46
  * The error document identifier. This identifier is only present when an error occurs during query processing. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the `getDocument` operation to get the information required to retrieve the error document\'s contents.
63
- * @type {string}
64
- * @memberof Query
65
47
  */
66
48
  'errorDocumentId'?: string;
67
- /**
68
- *
69
- * @type {QueryPagination}
70
- * @memberof Query
71
- */
72
49
  'pagination'?: QueryPagination;
73
50
  }
74
51
  export declare const QueryProcessingStatusEnum: {
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": "3.0.0",
5
+ "version": "3.0.2",
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.14",
22
- "axios": "^1.9.0"
21
+ "@sp-api-sdk/common": "2.1.16",
22
+ "axios": "^1.11.0"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,26 @@
40
40
  "sp sdk",
41
41
  "data kiosk api"
42
42
  ],
43
- "gitHead": "773f45c3f4aab28e0bd9f6033045988800d7f258"
43
+ "xo": {
44
+ "extends": [
45
+ "xo-bizon"
46
+ ],
47
+ "settings": {
48
+ "import/internal-regex": "^@sp-api-sdk/"
49
+ },
50
+ "semicolon": false,
51
+ "space": 2,
52
+ "prettier": true,
53
+ "ignores": [
54
+ "src/api-model/**"
55
+ ],
56
+ "rules": {
57
+ "unicorn/prevent-abbreviations": "off"
58
+ }
59
+ },
60
+ "prettier": {
61
+ "printWidth": 100,
62
+ "jsxSingleQuote": true
63
+ },
64
+ "gitHead": "fc1b46f3bc172469e2fbbc2e0155f6fa7ce3edde"
44
65
  }