@gooddata/api-client-tiger 10.21.0-alpha.3 → 10.21.0-alpha.30

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.
Files changed (38) hide show
  1. package/esm/__version.d.ts +1 -1
  2. package/esm/__version.d.ts.map +1 -1
  3. package/esm/__version.js +1 -1
  4. package/esm/__version.js.map +1 -1
  5. package/esm/api-client-tiger.d.ts +2700 -1516
  6. package/esm/client.d.ts +3 -3
  7. package/esm/client.d.ts.map +1 -1
  8. package/esm/client.js +3 -3
  9. package/esm/client.js.map +1 -1
  10. package/esm/export.d.ts +3 -3
  11. package/esm/export.d.ts.map +1 -1
  12. package/esm/export.js +2 -2
  13. package/esm/export.js.map +1 -1
  14. package/esm/generated/afm-rest-api/api.js +1 -1
  15. package/esm/generated/afm-rest-api/api.js.map +1 -1
  16. package/esm/generated/afm-rest-api/openapi-spec.json +1 -1
  17. package/esm/generated/auth-json-api/api.js +1 -1
  18. package/esm/generated/automation-json-api/api.js +1 -1
  19. package/esm/generated/automation-json-api/api.js.map +1 -1
  20. package/esm/generated/automation-json-api/base.js +1 -1
  21. package/esm/generated/automation-json-api/common.js +1 -1
  22. package/esm/generated/automation-json-api/configuration.js +1 -1
  23. package/esm/generated/automation-json-api/index.js +1 -1
  24. package/esm/generated/export-json-api/api.d.ts +1495 -30
  25. package/esm/generated/export-json-api/api.d.ts.map +1 -1
  26. package/esm/generated/export-json-api/api.js +569 -1
  27. package/esm/generated/export-json-api/api.js.map +1 -1
  28. package/esm/generated/export-json-api/openapi-spec.json +1001 -1
  29. package/esm/generated/metadata-json-api/api.d.ts +1328 -1349
  30. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  31. package/esm/generated/metadata-json-api/api.js +41 -38
  32. package/esm/generated/metadata-json-api/api.js.map +1 -1
  33. package/esm/generated/metadata-json-api/openapi-spec.json +5704 -5717
  34. package/esm/generated/scan-json-api/api.js +1 -1
  35. package/esm/index.d.ts +1 -1
  36. package/esm/index.d.ts.map +1 -1
  37. package/esm/index.js.map +1 -1
  38. package/package.json +3 -3
@@ -1,4 +1,4 @@
1
- // (C) 2024 GoodData Corporation
1
+ // (C) 2025 GoodData Corporation
2
2
  import globalAxios from "axios";
3
3
  // Some imports not used depending on template conditions, we also need prettier-ignore so that the import does not get split and ts-ignore still works
4
4
  // prettier-ignore
@@ -8,6 +8,88 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, creat
8
8
  // prettier-ignore
9
9
  // @ts-ignore
10
10
  import { BASE_PATH, BaseAPI } from './base.js';
11
+ export const AfmObjectIdentifierAttributeIdentifierTypeEnum = {
12
+ ATTRIBUTE: "attribute",
13
+ };
14
+ export const AfmObjectIdentifierCoreIdentifierTypeEnum = {
15
+ ATTRIBUTE: "attribute",
16
+ LABEL: "label",
17
+ FACT: "fact",
18
+ METRIC: "metric",
19
+ };
20
+ export const AfmObjectIdentifierDatasetIdentifierTypeEnum = {
21
+ DATASET: "dataset",
22
+ };
23
+ export const AfmObjectIdentifierIdentifierTypeEnum = {
24
+ ANALYTICAL_DASHBOARD: "analyticalDashboard",
25
+ ATTRIBUTE: "attribute",
26
+ DASHBOARD_PLUGIN: "dashboardPlugin",
27
+ DATASET: "dataset",
28
+ FACT: "fact",
29
+ LABEL: "label",
30
+ METRIC: "metric",
31
+ PROMPT: "prompt",
32
+ VISUALIZATION_OBJECT: "visualizationObject",
33
+ FILTER_CONTEXT: "filterContext",
34
+ };
35
+ export const AfmObjectIdentifierLabelIdentifierTypeEnum = {
36
+ LABEL: "label",
37
+ };
38
+ export const ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = {
39
+ SUM: "SUM",
40
+ DIFFERENCE: "DIFFERENCE",
41
+ MULTIPLICATION: "MULTIPLICATION",
42
+ RATIO: "RATIO",
43
+ CHANGE: "CHANGE",
44
+ };
45
+ export const ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = {
46
+ GREATER_THAN: "GREATER_THAN",
47
+ GREATER_THAN_OR_EQUAL_TO: "GREATER_THAN_OR_EQUAL_TO",
48
+ LESS_THAN: "LESS_THAN",
49
+ LESS_THAN_OR_EQUAL_TO: "LESS_THAN_OR_EQUAL_TO",
50
+ EQUAL_TO: "EQUAL_TO",
51
+ NOT_EQUAL_TO: "NOT_EQUAL_TO",
52
+ };
53
+ export const RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = {
54
+ BETWEEN: "BETWEEN",
55
+ NOT_BETWEEN: "NOT_BETWEEN",
56
+ };
57
+ export const RankingFilterRankingFilterOperatorEnum = {
58
+ TOP: "TOP",
59
+ BOTTOM: "BOTTOM",
60
+ };
61
+ export const RawExportRequestFormatEnum = {
62
+ ARROW_FILE: "ARROW_FILE",
63
+ ARROW_STREAM: "ARROW_STREAM",
64
+ CSV: "CSV",
65
+ };
66
+ export const RelativeDateFilterRelativeDateFilterGranularityEnum = {
67
+ MINUTE: "MINUTE",
68
+ HOUR: "HOUR",
69
+ DAY: "DAY",
70
+ WEEK: "WEEK",
71
+ MONTH: "MONTH",
72
+ QUARTER: "QUARTER",
73
+ YEAR: "YEAR",
74
+ MINUTE_OF_HOUR: "MINUTE_OF_HOUR",
75
+ HOUR_OF_DAY: "HOUR_OF_DAY",
76
+ DAY_OF_WEEK: "DAY_OF_WEEK",
77
+ DAY_OF_MONTH: "DAY_OF_MONTH",
78
+ DAY_OF_YEAR: "DAY_OF_YEAR",
79
+ WEEK_OF_YEAR: "WEEK_OF_YEAR",
80
+ MONTH_OF_YEAR: "MONTH_OF_YEAR",
81
+ QUARTER_OF_YEAR: "QUARTER_OF_YEAR",
82
+ };
83
+ export const SimpleMeasureDefinitionMeasureAggregationEnum = {
84
+ SUM: "SUM",
85
+ COUNT: "COUNT",
86
+ AVG: "AVG",
87
+ MIN: "MIN",
88
+ MAX: "MAX",
89
+ MEDIAN: "MEDIAN",
90
+ RUNSUM: "RUNSUM",
91
+ APPROXIMATE_COUNT: "APPROXIMATE_COUNT",
92
+ };
11
93
  export const TabularExportRequestFormatEnum = {
12
94
  CSV: "CSV",
13
95
  XLSX: "XLSX",
@@ -20,6 +102,43 @@ export const TabularExportRequestFormatEnum = {
20
102
  */
21
103
  export const ActionsApiAxiosParamCreator = function (configuration) {
22
104
  return {
105
+ /**
106
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
107
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
108
+ * @param {string} workspaceId
109
+ * @param {string} dashboardId
110
+ * @param {*} [options] Override http request option.
111
+ * @throws {RequiredError}
112
+ */
113
+ createDashboardExportRequest: async (workspaceId, dashboardId, options = {}) => {
114
+ // verify required parameter 'workspaceId' is not null or undefined
115
+ assertParamExists("createDashboardExportRequest", "workspaceId", workspaceId);
116
+ // verify required parameter 'dashboardId' is not null or undefined
117
+ assertParamExists("createDashboardExportRequest", "dashboardId", dashboardId);
118
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular`
119
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
120
+ .replace(`{${"dashboardId"}}`, encodeURIComponent(String(dashboardId)));
121
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
122
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
123
+ let baseOptions;
124
+ if (configuration) {
125
+ baseOptions = configuration.baseOptions;
126
+ }
127
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
128
+ const localVarHeaderParameter = {};
129
+ const localVarQueryParameter = {};
130
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
131
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
132
+ localVarRequestOptions.headers = {
133
+ ...localVarHeaderParameter,
134
+ ...headersFromBaseOptions,
135
+ ...options.headers,
136
+ };
137
+ return {
138
+ url: toPathString(localVarUrlObj),
139
+ options: localVarRequestOptions,
140
+ };
141
+ },
23
142
  /**
24
143
  * An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
25
144
  * @summary Create visual - pdf export request
@@ -61,6 +180,47 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
61
180
  options: localVarRequestOptions,
62
181
  };
63
182
  },
183
+ /**
184
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
185
+ * @summary (EXPERIMENTAL) Create raw export request
186
+ * @param {string} workspaceId
187
+ * @param {RawExportRequest} rawExportRequest
188
+ * @param {*} [options] Override http request option.
189
+ * @throws {RequiredError}
190
+ */
191
+ createRawExport: async (workspaceId, rawExportRequest, options = {}) => {
192
+ // verify required parameter 'workspaceId' is not null or undefined
193
+ assertParamExists("createRawExport", "workspaceId", workspaceId);
194
+ // verify required parameter 'rawExportRequest' is not null or undefined
195
+ assertParamExists("createRawExport", "rawExportRequest", rawExportRequest);
196
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
197
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
198
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
199
+ let baseOptions;
200
+ if (configuration) {
201
+ baseOptions = configuration.baseOptions;
202
+ }
203
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
204
+ const localVarHeaderParameter = {};
205
+ const localVarQueryParameter = {};
206
+ localVarHeaderParameter["Content-Type"] = "application/json";
207
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
208
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
209
+ localVarRequestOptions.headers = {
210
+ ...localVarHeaderParameter,
211
+ ...headersFromBaseOptions,
212
+ ...options.headers,
213
+ };
214
+ const needsSerialization = typeof rawExportRequest !== "string" ||
215
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
216
+ localVarRequestOptions.data = needsSerialization
217
+ ? JSON.stringify(rawExportRequest !== undefined ? rawExportRequest : {})
218
+ : rawExportRequest || "";
219
+ return {
220
+ url: toPathString(localVarUrlObj),
221
+ options: localVarRequestOptions,
222
+ };
223
+ },
64
224
  /**
65
225
  * An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
66
226
  * @summary Create tabular export request
@@ -176,6 +336,43 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
176
336
  options: localVarRequestOptions,
177
337
  };
178
338
  },
339
+ /**
340
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
341
+ * @summary (EXPERIMENTAL) Retrieve exported files
342
+ * @param {string} workspaceId
343
+ * @param {string} exportId
344
+ * @param {*} [options] Override http request option.
345
+ * @throws {RequiredError}
346
+ */
347
+ getRawExport: async (workspaceId, exportId, options = {}) => {
348
+ // verify required parameter 'workspaceId' is not null or undefined
349
+ assertParamExists("getRawExport", "workspaceId", workspaceId);
350
+ // verify required parameter 'exportId' is not null or undefined
351
+ assertParamExists("getRawExport", "exportId", exportId);
352
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}`
353
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
354
+ .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
355
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
356
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
357
+ let baseOptions;
358
+ if (configuration) {
359
+ baseOptions = configuration.baseOptions;
360
+ }
361
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
362
+ const localVarHeaderParameter = {};
363
+ const localVarQueryParameter = {};
364
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
365
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
366
+ localVarRequestOptions.headers = {
367
+ ...localVarHeaderParameter,
368
+ ...headersFromBaseOptions,
369
+ ...options.headers,
370
+ };
371
+ return {
372
+ url: toPathString(localVarUrlObj),
373
+ options: localVarRequestOptions,
374
+ };
375
+ },
179
376
  /**
180
377
  * After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
181
378
  * @summary Retrieve exported files
@@ -222,6 +419,18 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
222
419
  export const ActionsApiFp = function (configuration) {
223
420
  const localVarAxiosParamCreator = ActionsApiAxiosParamCreator(configuration);
224
421
  return {
422
+ /**
423
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
424
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
425
+ * @param {string} workspaceId
426
+ * @param {string} dashboardId
427
+ * @param {*} [options] Override http request option.
428
+ * @throws {RequiredError}
429
+ */
430
+ async createDashboardExportRequest(workspaceId, dashboardId, options) {
431
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, options);
432
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
433
+ },
225
434
  /**
226
435
  * An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
227
436
  * @summary Create visual - pdf export request
@@ -234,6 +443,18 @@ export const ActionsApiFp = function (configuration) {
234
443
  const localVarAxiosArgs = await localVarAxiosParamCreator.createPdfExport(workspaceId, visualExportRequest, options);
235
444
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
236
445
  },
446
+ /**
447
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
448
+ * @summary (EXPERIMENTAL) Create raw export request
449
+ * @param {string} workspaceId
450
+ * @param {RawExportRequest} rawExportRequest
451
+ * @param {*} [options] Override http request option.
452
+ * @throws {RequiredError}
453
+ */
454
+ async createRawExport(workspaceId, rawExportRequest, options) {
455
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId, rawExportRequest, options);
456
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
457
+ },
237
458
  /**
238
459
  * An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
239
460
  * @summary Create tabular export request
@@ -270,6 +491,18 @@ export const ActionsApiFp = function (configuration) {
270
491
  const localVarAxiosArgs = await localVarAxiosParamCreator.getMetadata(workspaceId, exportId, options);
271
492
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
272
493
  },
494
+ /**
495
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
496
+ * @summary (EXPERIMENTAL) Retrieve exported files
497
+ * @param {string} workspaceId
498
+ * @param {string} exportId
499
+ * @param {*} [options] Override http request option.
500
+ * @throws {RequiredError}
501
+ */
502
+ async getRawExport(workspaceId, exportId, options) {
503
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getRawExport(workspaceId, exportId, options);
504
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
505
+ },
273
506
  /**
274
507
  * After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
275
508
  * @summary Retrieve exported files
@@ -291,6 +524,18 @@ export const ActionsApiFp = function (configuration) {
291
524
  export const ActionsApiFactory = function (configuration, basePath, axios) {
292
525
  const localVarFp = ActionsApiFp(configuration);
293
526
  return {
527
+ /**
528
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
529
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
530
+ * @param {ActionsApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
531
+ * @param {*} [options] Override http request option.
532
+ * @throws {RequiredError}
533
+ */
534
+ createDashboardExportRequest(requestParameters, options) {
535
+ return localVarFp
536
+ .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
537
+ .then((request) => request(axios, basePath));
538
+ },
294
539
  /**
295
540
  * An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
296
541
  * @summary Create visual - pdf export request
@@ -303,6 +548,18 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
303
548
  .createPdfExport(requestParameters.workspaceId, requestParameters.visualExportRequest, options)
304
549
  .then((request) => request(axios, basePath));
305
550
  },
551
+ /**
552
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
553
+ * @summary (EXPERIMENTAL) Create raw export request
554
+ * @param {ActionsApiCreateRawExportRequest} requestParameters Request parameters.
555
+ * @param {*} [options] Override http request option.
556
+ * @throws {RequiredError}
557
+ */
558
+ createRawExport(requestParameters, options) {
559
+ return localVarFp
560
+ .createRawExport(requestParameters.workspaceId, requestParameters.rawExportRequest, options)
561
+ .then((request) => request(axios, basePath));
562
+ },
306
563
  /**
307
564
  * An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
308
565
  * @summary Create tabular export request
@@ -339,6 +596,18 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
339
596
  .getMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
340
597
  .then((request) => request(axios, basePath));
341
598
  },
599
+ /**
600
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
601
+ * @summary (EXPERIMENTAL) Retrieve exported files
602
+ * @param {ActionsApiGetRawExportRequest} requestParameters Request parameters.
603
+ * @param {*} [options] Override http request option.
604
+ * @throws {RequiredError}
605
+ */
606
+ getRawExport(requestParameters, options) {
607
+ return localVarFp
608
+ .getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
609
+ .then((request) => request(axios, basePath));
610
+ },
342
611
  /**
343
612
  * After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
344
613
  * @summary Retrieve exported files
@@ -360,6 +629,19 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
360
629
  * @extends {BaseAPI}
361
630
  */
362
631
  export class ActionsApi extends BaseAPI {
632
+ /**
633
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
634
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
635
+ * @param {ActionsApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
636
+ * @param {*} [options] Override http request option.
637
+ * @throws {RequiredError}
638
+ * @memberof ActionsApi
639
+ */
640
+ createDashboardExportRequest(requestParameters, options) {
641
+ return ActionsApiFp(this.configuration)
642
+ .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
643
+ .then((request) => request(this.axios, this.basePath));
644
+ }
363
645
  /**
364
646
  * An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
365
647
  * @summary Create visual - pdf export request
@@ -373,6 +655,19 @@ export class ActionsApi extends BaseAPI {
373
655
  .createPdfExport(requestParameters.workspaceId, requestParameters.visualExportRequest, options)
374
656
  .then((request) => request(this.axios, this.basePath));
375
657
  }
658
+ /**
659
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
660
+ * @summary (EXPERIMENTAL) Create raw export request
661
+ * @param {ActionsApiCreateRawExportRequest} requestParameters Request parameters.
662
+ * @param {*} [options] Override http request option.
663
+ * @throws {RequiredError}
664
+ * @memberof ActionsApi
665
+ */
666
+ createRawExport(requestParameters, options) {
667
+ return ActionsApiFp(this.configuration)
668
+ .createRawExport(requestParameters.workspaceId, requestParameters.rawExportRequest, options)
669
+ .then((request) => request(this.axios, this.basePath));
670
+ }
376
671
  /**
377
672
  * An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
378
673
  * @summary Create tabular export request
@@ -412,6 +707,19 @@ export class ActionsApi extends BaseAPI {
412
707
  .getMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
413
708
  .then((request) => request(this.axios, this.basePath));
414
709
  }
710
+ /**
711
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
712
+ * @summary (EXPERIMENTAL) Retrieve exported files
713
+ * @param {ActionsApiGetRawExportRequest} requestParameters Request parameters.
714
+ * @param {*} [options] Override http request option.
715
+ * @throws {RequiredError}
716
+ * @memberof ActionsApi
717
+ */
718
+ getRawExport(requestParameters, options) {
719
+ return ActionsApiFp(this.configuration)
720
+ .getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
721
+ .then((request) => request(this.axios, this.basePath));
722
+ }
415
723
  /**
416
724
  * After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
417
725
  * @summary Retrieve exported files
@@ -426,12 +734,235 @@ export class ActionsApi extends BaseAPI {
426
734
  .then((request) => request(this.axios, this.basePath));
427
735
  }
428
736
  }
737
+ /**
738
+ * RawExportApi - axios parameter creator
739
+ * @export
740
+ */
741
+ export const RawExportApiAxiosParamCreator = function (configuration) {
742
+ return {
743
+ /**
744
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
745
+ * @summary (EXPERIMENTAL) Create raw export request
746
+ * @param {string} workspaceId
747
+ * @param {RawExportRequest} rawExportRequest
748
+ * @param {*} [options] Override http request option.
749
+ * @throws {RequiredError}
750
+ */
751
+ createRawExport: async (workspaceId, rawExportRequest, options = {}) => {
752
+ // verify required parameter 'workspaceId' is not null or undefined
753
+ assertParamExists("createRawExport", "workspaceId", workspaceId);
754
+ // verify required parameter 'rawExportRequest' is not null or undefined
755
+ assertParamExists("createRawExport", "rawExportRequest", rawExportRequest);
756
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
757
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
758
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
759
+ let baseOptions;
760
+ if (configuration) {
761
+ baseOptions = configuration.baseOptions;
762
+ }
763
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
764
+ const localVarHeaderParameter = {};
765
+ const localVarQueryParameter = {};
766
+ localVarHeaderParameter["Content-Type"] = "application/json";
767
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
768
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
769
+ localVarRequestOptions.headers = {
770
+ ...localVarHeaderParameter,
771
+ ...headersFromBaseOptions,
772
+ ...options.headers,
773
+ };
774
+ const needsSerialization = typeof rawExportRequest !== "string" ||
775
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
776
+ localVarRequestOptions.data = needsSerialization
777
+ ? JSON.stringify(rawExportRequest !== undefined ? rawExportRequest : {})
778
+ : rawExportRequest || "";
779
+ return {
780
+ url: toPathString(localVarUrlObj),
781
+ options: localVarRequestOptions,
782
+ };
783
+ },
784
+ /**
785
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
786
+ * @summary (EXPERIMENTAL) Retrieve exported files
787
+ * @param {string} workspaceId
788
+ * @param {string} exportId
789
+ * @param {*} [options] Override http request option.
790
+ * @throws {RequiredError}
791
+ */
792
+ getRawExport: async (workspaceId, exportId, options = {}) => {
793
+ // verify required parameter 'workspaceId' is not null or undefined
794
+ assertParamExists("getRawExport", "workspaceId", workspaceId);
795
+ // verify required parameter 'exportId' is not null or undefined
796
+ assertParamExists("getRawExport", "exportId", exportId);
797
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}`
798
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
799
+ .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
800
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
801
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
802
+ let baseOptions;
803
+ if (configuration) {
804
+ baseOptions = configuration.baseOptions;
805
+ }
806
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
807
+ const localVarHeaderParameter = {};
808
+ const localVarQueryParameter = {};
809
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
810
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
811
+ localVarRequestOptions.headers = {
812
+ ...localVarHeaderParameter,
813
+ ...headersFromBaseOptions,
814
+ ...options.headers,
815
+ };
816
+ return {
817
+ url: toPathString(localVarUrlObj),
818
+ options: localVarRequestOptions,
819
+ };
820
+ },
821
+ };
822
+ };
823
+ /**
824
+ * RawExportApi - functional programming interface
825
+ * @export
826
+ */
827
+ export const RawExportApiFp = function (configuration) {
828
+ const localVarAxiosParamCreator = RawExportApiAxiosParamCreator(configuration);
829
+ return {
830
+ /**
831
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
832
+ * @summary (EXPERIMENTAL) Create raw export request
833
+ * @param {string} workspaceId
834
+ * @param {RawExportRequest} rawExportRequest
835
+ * @param {*} [options] Override http request option.
836
+ * @throws {RequiredError}
837
+ */
838
+ async createRawExport(workspaceId, rawExportRequest, options) {
839
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId, rawExportRequest, options);
840
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
841
+ },
842
+ /**
843
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
844
+ * @summary (EXPERIMENTAL) Retrieve exported files
845
+ * @param {string} workspaceId
846
+ * @param {string} exportId
847
+ * @param {*} [options] Override http request option.
848
+ * @throws {RequiredError}
849
+ */
850
+ async getRawExport(workspaceId, exportId, options) {
851
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getRawExport(workspaceId, exportId, options);
852
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
853
+ },
854
+ };
855
+ };
856
+ /**
857
+ * RawExportApi - factory interface
858
+ * @export
859
+ */
860
+ export const RawExportApiFactory = function (configuration, basePath, axios) {
861
+ const localVarFp = RawExportApiFp(configuration);
862
+ return {
863
+ /**
864
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
865
+ * @summary (EXPERIMENTAL) Create raw export request
866
+ * @param {RawExportApiCreateRawExportRequest} requestParameters Request parameters.
867
+ * @param {*} [options] Override http request option.
868
+ * @throws {RequiredError}
869
+ */
870
+ createRawExport(requestParameters, options) {
871
+ return localVarFp
872
+ .createRawExport(requestParameters.workspaceId, requestParameters.rawExportRequest, options)
873
+ .then((request) => request(axios, basePath));
874
+ },
875
+ /**
876
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
877
+ * @summary (EXPERIMENTAL) Retrieve exported files
878
+ * @param {RawExportApiGetRawExportRequest} requestParameters Request parameters.
879
+ * @param {*} [options] Override http request option.
880
+ * @throws {RequiredError}
881
+ */
882
+ getRawExport(requestParameters, options) {
883
+ return localVarFp
884
+ .getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
885
+ .then((request) => request(axios, basePath));
886
+ },
887
+ };
888
+ };
889
+ /**
890
+ * RawExportApi - object-oriented interface
891
+ * @export
892
+ * @class RawExportApi
893
+ * @extends {BaseAPI}
894
+ */
895
+ export class RawExportApi extends BaseAPI {
896
+ /**
897
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
898
+ * @summary (EXPERIMENTAL) Create raw export request
899
+ * @param {RawExportApiCreateRawExportRequest} requestParameters Request parameters.
900
+ * @param {*} [options] Override http request option.
901
+ * @throws {RequiredError}
902
+ * @memberof RawExportApi
903
+ */
904
+ createRawExport(requestParameters, options) {
905
+ return RawExportApiFp(this.configuration)
906
+ .createRawExport(requestParameters.workspaceId, requestParameters.rawExportRequest, options)
907
+ .then((request) => request(this.axios, this.basePath));
908
+ }
909
+ /**
910
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
911
+ * @summary (EXPERIMENTAL) Retrieve exported files
912
+ * @param {RawExportApiGetRawExportRequest} requestParameters Request parameters.
913
+ * @param {*} [options] Override http request option.
914
+ * @throws {RequiredError}
915
+ * @memberof RawExportApi
916
+ */
917
+ getRawExport(requestParameters, options) {
918
+ return RawExportApiFp(this.configuration)
919
+ .getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
920
+ .then((request) => request(this.axios, this.basePath));
921
+ }
922
+ }
429
923
  /**
430
924
  * TabularExportApi - axios parameter creator
431
925
  * @export
432
926
  */
433
927
  export const TabularExportApiAxiosParamCreator = function (configuration) {
434
928
  return {
929
+ /**
930
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
931
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
932
+ * @param {string} workspaceId
933
+ * @param {string} dashboardId
934
+ * @param {*} [options] Override http request option.
935
+ * @throws {RequiredError}
936
+ */
937
+ createDashboardExportRequest: async (workspaceId, dashboardId, options = {}) => {
938
+ // verify required parameter 'workspaceId' is not null or undefined
939
+ assertParamExists("createDashboardExportRequest", "workspaceId", workspaceId);
940
+ // verify required parameter 'dashboardId' is not null or undefined
941
+ assertParamExists("createDashboardExportRequest", "dashboardId", dashboardId);
942
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular`
943
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
944
+ .replace(`{${"dashboardId"}}`, encodeURIComponent(String(dashboardId)));
945
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
946
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
947
+ let baseOptions;
948
+ if (configuration) {
949
+ baseOptions = configuration.baseOptions;
950
+ }
951
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
952
+ const localVarHeaderParameter = {};
953
+ const localVarQueryParameter = {};
954
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
955
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
956
+ localVarRequestOptions.headers = {
957
+ ...localVarHeaderParameter,
958
+ ...headersFromBaseOptions,
959
+ ...options.headers,
960
+ };
961
+ return {
962
+ url: toPathString(localVarUrlObj),
963
+ options: localVarRequestOptions,
964
+ };
965
+ },
435
966
  /**
436
967
  * An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
437
968
  * @summary Create tabular export request
@@ -519,6 +1050,18 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
519
1050
  export const TabularExportApiFp = function (configuration) {
520
1051
  const localVarAxiosParamCreator = TabularExportApiAxiosParamCreator(configuration);
521
1052
  return {
1053
+ /**
1054
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1055
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1056
+ * @param {string} workspaceId
1057
+ * @param {string} dashboardId
1058
+ * @param {*} [options] Override http request option.
1059
+ * @throws {RequiredError}
1060
+ */
1061
+ async createDashboardExportRequest(workspaceId, dashboardId, options) {
1062
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, options);
1063
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1064
+ },
522
1065
  /**
523
1066
  * An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
524
1067
  * @summary Create tabular export request
@@ -552,6 +1095,18 @@ export const TabularExportApiFp = function (configuration) {
552
1095
  export const TabularExportApiFactory = function (configuration, basePath, axios) {
553
1096
  const localVarFp = TabularExportApiFp(configuration);
554
1097
  return {
1098
+ /**
1099
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1100
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1101
+ * @param {TabularExportApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
1102
+ * @param {*} [options] Override http request option.
1103
+ * @throws {RequiredError}
1104
+ */
1105
+ createDashboardExportRequest(requestParameters, options) {
1106
+ return localVarFp
1107
+ .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
1108
+ .then((request) => request(axios, basePath));
1109
+ },
555
1110
  /**
556
1111
  * An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
557
1112
  * @summary Create tabular export request
@@ -585,6 +1140,19 @@ export const TabularExportApiFactory = function (configuration, basePath, axios)
585
1140
  * @extends {BaseAPI}
586
1141
  */
587
1142
  export class TabularExportApi extends BaseAPI {
1143
+ /**
1144
+ * Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1145
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1146
+ * @param {TabularExportApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
1147
+ * @param {*} [options] Override http request option.
1148
+ * @throws {RequiredError}
1149
+ * @memberof TabularExportApi
1150
+ */
1151
+ createDashboardExportRequest(requestParameters, options) {
1152
+ return TabularExportApiFp(this.configuration)
1153
+ .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
1154
+ .then((request) => request(this.axios, this.basePath));
1155
+ }
588
1156
  /**
589
1157
  * An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
590
1158
  * @summary Create tabular export request