@gooddata/api-client-tiger 10.21.0-alpha.5 → 10.21.0-alpha.51

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 (40) 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 +2689 -1313
  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.d.ts +6 -0
  15. package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
  16. package/esm/generated/afm-rest-api/api.js +1 -1
  17. package/esm/generated/afm-rest-api/api.js.map +1 -1
  18. package/esm/generated/afm-rest-api/openapi-spec.json +6 -2
  19. package/esm/generated/auth-json-api/api.js +1 -1
  20. package/esm/generated/automation-json-api/api.js +1 -1
  21. package/esm/generated/automation-json-api/api.js.map +1 -1
  22. package/esm/generated/automation-json-api/base.js +1 -1
  23. package/esm/generated/automation-json-api/common.js +1 -1
  24. package/esm/generated/automation-json-api/configuration.js +1 -1
  25. package/esm/generated/automation-json-api/index.js +1 -1
  26. package/esm/generated/export-json-api/api.d.ts +2257 -345
  27. package/esm/generated/export-json-api/api.d.ts.map +1 -1
  28. package/esm/generated/export-json-api/api.js +1251 -193
  29. package/esm/generated/export-json-api/api.js.map +1 -1
  30. package/esm/generated/export-json-api/openapi-spec.json +1261 -87
  31. package/esm/generated/metadata-json-api/api.d.ts +1309 -1277
  32. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  33. package/esm/generated/metadata-json-api/api.js +52 -31
  34. package/esm/generated/metadata-json-api/api.js.map +1 -1
  35. package/esm/generated/metadata-json-api/openapi-spec.json +6188 -6182
  36. package/esm/generated/scan-json-api/api.js +1 -1
  37. package/esm/index.d.ts +1 -1
  38. package/esm/index.d.ts.map +1 -1
  39. package/esm/index.js.map +1 -1
  40. package/package.json +3 -3
@@ -13,600 +13,2458 @@ import { Configuration } from "./configuration.js";
13
13
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from "axios";
14
14
  import { RequestArgs, BaseAPI } from './base.js';
15
15
  /**
16
- * Custom label object override.
16
+ * Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.
17
17
  * @export
18
- * @interface CustomLabel
18
+ * @interface AFM
19
19
  */
20
- export interface CustomLabel {
20
+ export interface AFM {
21
21
  /**
22
- * Override value.
23
- * @type {string}
24
- * @memberof CustomLabel
22
+ * Attributes to be used in the computation.
23
+ * @type {Array<AttributeItem>}
24
+ * @memberof AFM
25
25
  */
26
- title: string;
26
+ attributes: Array<AttributeItem>;
27
+ /**
28
+ * Various filter types to filter the execution result.
29
+ * @type {Array<FilterDefinition>}
30
+ * @memberof AFM
31
+ */
32
+ filters: Array<FilterDefinition>;
33
+ /**
34
+ * Metrics to be computed.
35
+ * @type {Array<MeasureItem>}
36
+ * @memberof AFM
37
+ */
38
+ measures: Array<MeasureItem>;
39
+ /**
40
+ * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
41
+ * @type {Array<MeasureItem>}
42
+ * @memberof AFM
43
+ */
44
+ auxMeasures?: Array<MeasureItem>;
27
45
  }
28
46
  /**
29
- * Custom metric object override.
47
+ * A datetime filter specifying exact from and to values.
30
48
  * @export
31
- * @interface CustomMetric
49
+ * @interface AbsoluteDateFilter
32
50
  */
33
- export interface CustomMetric {
51
+ export interface AbsoluteDateFilter {
34
52
  /**
35
- * Metric title override.
36
- * @type {string}
37
- * @memberof CustomMetric
38
- */
39
- title: string;
40
- /**
41
- * Format override.
42
- * @type {string}
43
- * @memberof CustomMetric
53
+ *
54
+ * @type {AbsoluteDateFilterAbsoluteDateFilter}
55
+ * @memberof AbsoluteDateFilter
44
56
  */
45
- format: string;
57
+ absoluteDateFilter: AbsoluteDateFilterAbsoluteDateFilter;
46
58
  }
47
59
  /**
48
- * Custom cell value overrides (IDs will be replaced with specified values).
60
+ *
49
61
  * @export
50
- * @interface CustomOverride
62
+ * @interface AbsoluteDateFilterAbsoluteDateFilter
51
63
  */
52
- export interface CustomOverride {
64
+ export interface AbsoluteDateFilterAbsoluteDateFilter {
53
65
  /**
54
- * Map of CustomLabels with keys used as placeholders in document.
55
- * @type {{ [key: string]: CustomLabel; }}
56
- * @memberof CustomOverride
66
+ *
67
+ * @type {string}
68
+ * @memberof AbsoluteDateFilterAbsoluteDateFilter
57
69
  */
58
- labels?: {
59
- [key: string]: CustomLabel;
60
- };
70
+ from: string;
61
71
  /**
62
- * Map of CustomMetrics with keys used as placeholders in document.
63
- * @type {{ [key: string]: CustomMetric; }}
64
- * @memberof CustomOverride
72
+ *
73
+ * @type {string}
74
+ * @memberof AbsoluteDateFilterAbsoluteDateFilter
65
75
  */
66
- metrics?: {
67
- [key: string]: CustomMetric;
68
- };
76
+ to: string;
77
+ /**
78
+ *
79
+ * @type {string}
80
+ * @memberof AbsoluteDateFilterAbsoluteDateFilter
81
+ */
82
+ localIdentifier?: string;
83
+ /**
84
+ *
85
+ * @type {boolean}
86
+ * @memberof AbsoluteDateFilterAbsoluteDateFilter
87
+ */
88
+ applyOnResult?: boolean;
89
+ /**
90
+ *
91
+ * @type {AfmObjectIdentifierDataset}
92
+ * @memberof AbsoluteDateFilterAbsoluteDateFilter
93
+ */
94
+ dataset: AfmObjectIdentifierDataset;
69
95
  }
96
+ /**
97
+ * @type AbstractMeasureValueFilter
98
+ * @export
99
+ */
100
+ export type AbstractMeasureValueFilter = ComparisonMeasureValueFilter | RangeMeasureValueFilter | RankingFilter;
101
+ /**
102
+ * @type AfmIdentifier
103
+ * Reference to the attribute label to which the filter should be applied.
104
+ * @export
105
+ */
106
+ export type AfmIdentifier = AfmLocalIdentifier | AfmObjectIdentifier;
70
107
  /**
71
108
  *
72
109
  * @export
73
- * @interface ExportResponse
110
+ * @interface AfmLocalIdentifier
74
111
  */
75
- export interface ExportResponse {
112
+ export interface AfmLocalIdentifier {
76
113
  /**
77
114
  *
78
115
  * @type {string}
79
- * @memberof ExportResponse
116
+ * @memberof AfmLocalIdentifier
80
117
  */
81
- exportResult: string;
118
+ localIdentifier: string;
82
119
  }
83
120
  /**
84
- * Custom CSS styles for the table. (PDF, HTML)
121
+ * ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.
85
122
  * @export
86
- * @interface PdfTableStyle
123
+ * @interface AfmObjectIdentifier
87
124
  */
88
- export interface PdfTableStyle {
125
+ export interface AfmObjectIdentifier {
89
126
  /**
90
- * CSS selector where to apply given properties.
91
- * @type {string}
92
- * @memberof PdfTableStyle
127
+ *
128
+ * @type {AfmObjectIdentifierIdentifier}
129
+ * @memberof AfmObjectIdentifier
93
130
  */
94
- selector: string;
131
+ identifier: AfmObjectIdentifierIdentifier;
132
+ }
133
+ /**
134
+ * Reference to the date attribute to use.
135
+ * @export
136
+ * @interface AfmObjectIdentifierAttribute
137
+ */
138
+ export interface AfmObjectIdentifierAttribute {
95
139
  /**
96
- * List of CSS properties.
97
- * @type {Array<PdfTableStyleProperty>}
98
- * @memberof PdfTableStyle
140
+ *
141
+ * @type {AfmObjectIdentifierAttributeIdentifier}
142
+ * @memberof AfmObjectIdentifierAttribute
99
143
  */
100
- properties?: Array<PdfTableStyleProperty>;
144
+ identifier: AfmObjectIdentifierAttributeIdentifier;
101
145
  }
102
146
  /**
103
- * CSS property.
147
+ *
104
148
  * @export
105
- * @interface PdfTableStyleProperty
149
+ * @interface AfmObjectIdentifierAttributeIdentifier
106
150
  */
107
- export interface PdfTableStyleProperty {
151
+ export interface AfmObjectIdentifierAttributeIdentifier {
108
152
  /**
109
- * CSS property key.
153
+ *
110
154
  * @type {string}
111
- * @memberof PdfTableStyleProperty
155
+ * @memberof AfmObjectIdentifierAttributeIdentifier
112
156
  */
113
- key: string;
157
+ id: string;
114
158
  /**
115
- * CSS property value.
159
+ *
116
160
  * @type {string}
117
- * @memberof PdfTableStyleProperty
161
+ * @memberof AfmObjectIdentifierAttributeIdentifier
118
162
  */
119
- value: string;
163
+ type: AfmObjectIdentifierAttributeIdentifierTypeEnum;
120
164
  }
165
+ export declare const AfmObjectIdentifierAttributeIdentifierTypeEnum: {
166
+ readonly ATTRIBUTE: "attribute";
167
+ };
168
+ export type AfmObjectIdentifierAttributeIdentifierTypeEnum = typeof AfmObjectIdentifierAttributeIdentifierTypeEnum[keyof typeof AfmObjectIdentifierAttributeIdentifierTypeEnum];
121
169
  /**
122
- * Additional settings.
170
+ * Reference to the metric, fact or attribute object to use for the metric.
123
171
  * @export
124
- * @interface Settings
172
+ * @interface AfmObjectIdentifierCore
125
173
  */
126
- export interface Settings {
174
+ export interface AfmObjectIdentifierCore {
127
175
  /**
128
- * Merge equal headers in neighbouring cells. (XLSX)
129
- * @type {boolean}
130
- * @memberof Settings
176
+ *
177
+ * @type {AfmObjectIdentifierCoreIdentifier}
178
+ * @memberof AfmObjectIdentifierCore
131
179
  */
132
- mergeHeaders?: boolean;
180
+ identifier: AfmObjectIdentifierCoreIdentifier;
181
+ }
182
+ /**
183
+ *
184
+ * @export
185
+ * @interface AfmObjectIdentifierCoreIdentifier
186
+ */
187
+ export interface AfmObjectIdentifierCoreIdentifier {
133
188
  /**
134
- * Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)
135
- * @type {boolean}
136
- * @memberof Settings
189
+ *
190
+ * @type {string}
191
+ * @memberof AfmObjectIdentifierCoreIdentifier
137
192
  */
138
- showFilters?: boolean;
193
+ id: string;
139
194
  /**
140
- * Page size and orientation. (PDF)
195
+ *
141
196
  * @type {string}
142
- * @memberof Settings
197
+ * @memberof AfmObjectIdentifierCoreIdentifier
143
198
  */
144
- pdfPageSize?: string;
199
+ type: AfmObjectIdentifierCoreIdentifierTypeEnum;
200
+ }
201
+ export declare const AfmObjectIdentifierCoreIdentifierTypeEnum: {
202
+ readonly ATTRIBUTE: "attribute";
203
+ readonly LABEL: "label";
204
+ readonly FACT: "fact";
205
+ readonly METRIC: "metric";
206
+ };
207
+ export type AfmObjectIdentifierCoreIdentifierTypeEnum = typeof AfmObjectIdentifierCoreIdentifierTypeEnum[keyof typeof AfmObjectIdentifierCoreIdentifierTypeEnum];
208
+ /**
209
+ * Reference to the date dataset to which the filter should be applied.
210
+ * @export
211
+ * @interface AfmObjectIdentifierDataset
212
+ */
213
+ export interface AfmObjectIdentifierDataset {
145
214
  /**
146
- * Custom CSS styles for the table. (PDF, HTML)
147
- * @type {Array<PdfTableStyle>}
148
- * @memberof Settings
215
+ *
216
+ * @type {AfmObjectIdentifierDatasetIdentifier}
217
+ * @memberof AfmObjectIdentifierDataset
149
218
  */
150
- pdfTableStyle?: Array<PdfTableStyle>;
219
+ identifier: AfmObjectIdentifierDatasetIdentifier;
220
+ }
221
+ /**
222
+ *
223
+ * @export
224
+ * @interface AfmObjectIdentifierDatasetIdentifier
225
+ */
226
+ export interface AfmObjectIdentifierDatasetIdentifier {
151
227
  /**
152
- * Top left header content. (PDF)
228
+ *
153
229
  * @type {string}
154
- * @memberof Settings
230
+ * @memberof AfmObjectIdentifierDatasetIdentifier
155
231
  */
156
- pdfTopLeftContent?: string;
232
+ id: string;
157
233
  /**
158
- * Top right header content. (PDF)
234
+ *
159
235
  * @type {string}
160
- * @memberof Settings
236
+ * @memberof AfmObjectIdentifierDatasetIdentifier
161
237
  */
162
- pdfTopRightContent?: string;
238
+ type: AfmObjectIdentifierDatasetIdentifierTypeEnum;
163
239
  }
240
+ export declare const AfmObjectIdentifierDatasetIdentifierTypeEnum: {
241
+ readonly DATASET: "dataset";
242
+ };
243
+ export type AfmObjectIdentifierDatasetIdentifierTypeEnum = typeof AfmObjectIdentifierDatasetIdentifierTypeEnum[keyof typeof AfmObjectIdentifierDatasetIdentifierTypeEnum];
164
244
  /**
165
- * Export request object describing the export properties and overrides for tabular exports.
245
+ *
166
246
  * @export
167
- * @interface TabularExportRequest
247
+ * @interface AfmObjectIdentifierIdentifier
168
248
  */
169
- export interface TabularExportRequest {
249
+ export interface AfmObjectIdentifierIdentifier {
170
250
  /**
171
- * Expected file format.
251
+ *
172
252
  * @type {string}
173
- * @memberof TabularExportRequest
253
+ * @memberof AfmObjectIdentifierIdentifier
174
254
  */
175
- format: TabularExportRequestFormatEnum;
255
+ type: AfmObjectIdentifierIdentifierTypeEnum;
176
256
  /**
177
- * Execution result identifier.
257
+ *
178
258
  * @type {string}
179
- * @memberof TabularExportRequest
259
+ * @memberof AfmObjectIdentifierIdentifier
180
260
  */
181
- executionResult?: string;
261
+ id: string;
262
+ }
263
+ export declare const AfmObjectIdentifierIdentifierTypeEnum: {
264
+ readonly ANALYTICAL_DASHBOARD: "analyticalDashboard";
265
+ readonly ATTRIBUTE: "attribute";
266
+ readonly DASHBOARD_PLUGIN: "dashboardPlugin";
267
+ readonly DATASET: "dataset";
268
+ readonly FACT: "fact";
269
+ readonly LABEL: "label";
270
+ readonly METRIC: "metric";
271
+ readonly PROMPT: "prompt";
272
+ readonly VISUALIZATION_OBJECT: "visualizationObject";
273
+ readonly FILTER_CONTEXT: "filterContext";
274
+ };
275
+ export type AfmObjectIdentifierIdentifierTypeEnum = typeof AfmObjectIdentifierIdentifierTypeEnum[keyof typeof AfmObjectIdentifierIdentifierTypeEnum];
276
+ /**
277
+ *
278
+ * @export
279
+ * @interface AfmObjectIdentifierLabel
280
+ */
281
+ export interface AfmObjectIdentifierLabel {
182
282
  /**
183
- * Filename of downloaded file without extension.
283
+ *
284
+ * @type {AfmObjectIdentifierLabelIdentifier}
285
+ * @memberof AfmObjectIdentifierLabel
286
+ */
287
+ identifier: AfmObjectIdentifierLabelIdentifier;
288
+ }
289
+ /**
290
+ *
291
+ * @export
292
+ * @interface AfmObjectIdentifierLabelIdentifier
293
+ */
294
+ export interface AfmObjectIdentifierLabelIdentifier {
295
+ /**
296
+ *
184
297
  * @type {string}
185
- * @memberof TabularExportRequest
298
+ * @memberof AfmObjectIdentifierLabelIdentifier
186
299
  */
187
- fileName: string;
300
+ type: AfmObjectIdentifierLabelIdentifierTypeEnum;
188
301
  /**
189
302
  *
190
- * @type {Settings}
191
- * @memberof TabularExportRequest
303
+ * @type {string}
304
+ * @memberof AfmObjectIdentifierLabelIdentifier
192
305
  */
193
- settings?: Settings;
306
+ id: string;
307
+ }
308
+ export declare const AfmObjectIdentifierLabelIdentifierTypeEnum: {
309
+ readonly LABEL: "label";
310
+ };
311
+ export type AfmObjectIdentifierLabelIdentifierTypeEnum = typeof AfmObjectIdentifierLabelIdentifierTypeEnum[keyof typeof AfmObjectIdentifierLabelIdentifierTypeEnum];
312
+ /**
313
+ * Metric representing arithmetics between other metrics.
314
+ * @export
315
+ * @interface ArithmeticMeasureDefinition
316
+ */
317
+ export interface ArithmeticMeasureDefinition {
194
318
  /**
195
319
  *
196
- * @type {CustomOverride}
197
- * @memberof TabularExportRequest
320
+ * @type {ArithmeticMeasureDefinitionArithmeticMeasure}
321
+ * @memberof ArithmeticMeasureDefinition
198
322
  */
199
- customOverride?: CustomOverride;
323
+ arithmeticMeasure: ArithmeticMeasureDefinitionArithmeticMeasure;
324
+ }
325
+ /**
326
+ *
327
+ * @export
328
+ * @interface ArithmeticMeasureDefinitionArithmeticMeasure
329
+ */
330
+ export interface ArithmeticMeasureDefinitionArithmeticMeasure {
200
331
  /**
201
- * Visualization object identifier. Alternative to executionResult property.
332
+ * List of metrics to apply arithmetic operation by chosen operator.
333
+ * @type {Array<AfmLocalIdentifier>}
334
+ * @memberof ArithmeticMeasureDefinitionArithmeticMeasure
335
+ */
336
+ measureIdentifiers: Array<AfmLocalIdentifier>;
337
+ /**
338
+ * Arithmetic operator describing operation between metrics.
202
339
  * @type {string}
203
- * @memberof TabularExportRequest
340
+ * @memberof ArithmeticMeasureDefinitionArithmeticMeasure
204
341
  */
205
- visualizationObject?: string;
342
+ operator: ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum;
343
+ }
344
+ export declare const ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum: {
345
+ readonly SUM: "SUM";
346
+ readonly DIFFERENCE: "DIFFERENCE";
347
+ readonly MULTIPLICATION: "MULTIPLICATION";
348
+ readonly RATIO: "RATIO";
349
+ readonly CHANGE: "CHANGE";
350
+ };
351
+ export type ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = typeof ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum[keyof typeof ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum];
352
+ /**
353
+ * @type AttributeFilter
354
+ * Abstract filter definition type attributes
355
+ * @export
356
+ */
357
+ export type AttributeFilter = NegativeAttributeFilter | PositiveAttributeFilter;
358
+ /**
359
+ * Filter on specific set of label values.
360
+ * @export
361
+ * @interface AttributeFilterElements
362
+ */
363
+ export interface AttributeFilterElements {
206
364
  /**
207
- * Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. (HTML/PDF only)
208
- * @type {Array<object>}
209
- * @memberof TabularExportRequest
365
+ * Set of label values.
366
+ * @type {Array<string>}
367
+ * @memberof AttributeFilterElements
210
368
  */
211
- visualizationObjectCustomFilters?: Array<object>;
369
+ values: Array<string>;
370
+ }
371
+ /**
372
+ *
373
+ * @export
374
+ * @interface AttributeItem
375
+ */
376
+ export interface AttributeItem {
212
377
  /**
213
- * Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
378
+ * Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
214
379
  * @type {string}
215
- * @memberof TabularExportRequest
380
+ * @memberof AttributeItem
216
381
  */
217
- relatedDashboardId?: string;
382
+ localIdentifier: string;
218
383
  /**
219
- * Metadata definition in free-form JSON format.
220
- * @type {object}
221
- * @memberof TabularExportRequest
384
+ *
385
+ * @type {AfmObjectIdentifierLabel}
386
+ * @memberof AttributeItem
222
387
  */
223
- metadata?: object | null;
388
+ label: AfmObjectIdentifierLabel;
389
+ /**
390
+ * Indicates whether to show all values of given attribute even if the data bound to those values is not available.
391
+ * @type {boolean}
392
+ * @memberof AttributeItem
393
+ */
394
+ showAllValues?: boolean;
224
395
  }
225
- export declare const TabularExportRequestFormatEnum: {
226
- readonly CSV: "CSV";
227
- readonly XLSX: "XLSX";
228
- readonly HTML: "HTML";
229
- readonly PDF: "PDF";
230
- };
231
- export type TabularExportRequestFormatEnum = typeof TabularExportRequestFormatEnum[keyof typeof TabularExportRequestFormatEnum];
232
396
  /**
233
- * Export request object describing the export properties and metadata for dashboard PDF exports.
397
+ * Filter the result by comparing specified metric to given constant value, using given comparison operator.
234
398
  * @export
235
- * @interface VisualExportRequest
399
+ * @interface ComparisonMeasureValueFilter
236
400
  */
237
- export interface VisualExportRequest {
401
+ export interface ComparisonMeasureValueFilter {
238
402
  /**
239
- * File name to be used for retrieving the pdf document.
240
- * @type {string}
241
- * @memberof VisualExportRequest
403
+ *
404
+ * @type {ComparisonMeasureValueFilterComparisonMeasureValueFilter}
405
+ * @memberof ComparisonMeasureValueFilter
242
406
  */
243
- fileName: string;
407
+ comparisonMeasureValueFilter: ComparisonMeasureValueFilterComparisonMeasureValueFilter;
408
+ }
409
+ /**
410
+ *
411
+ * @export
412
+ * @interface ComparisonMeasureValueFilterComparisonMeasureValueFilter
413
+ */
414
+ export interface ComparisonMeasureValueFilterComparisonMeasureValueFilter {
244
415
  /**
245
- * Dashboard identifier
416
+ * References to the attributes to be used when filtering.
417
+ * @type {Array<AfmIdentifier>}
418
+ * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
419
+ */
420
+ dimensionality?: Array<AfmIdentifier>;
421
+ /**
422
+ * A value that will be substituted for null values in the metric for the comparisons.
423
+ * @type {number}
424
+ * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
425
+ */
426
+ treatNullValuesAs?: number;
427
+ /**
428
+ *
246
429
  * @type {string}
247
- * @memberof VisualExportRequest
430
+ * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
248
431
  */
249
- dashboardId: string;
432
+ operator: ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
250
433
  /**
251
- * Metadata definition in free-form JSON format.
252
- * @type {object}
253
- * @memberof VisualExportRequest
434
+ *
435
+ * @type {number}
436
+ * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
437
+ */
438
+ value: number;
439
+ /**
440
+ *
441
+ * @type {string}
442
+ * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
443
+ */
444
+ localIdentifier?: string;
445
+ /**
446
+ *
447
+ * @type {boolean}
448
+ * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
449
+ */
450
+ applyOnResult?: boolean;
451
+ /**
452
+ *
453
+ * @type {AfmIdentifier}
454
+ * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
455
+ */
456
+ measure: AfmIdentifier;
457
+ }
458
+ export declare const ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum: {
459
+ readonly GREATER_THAN: "GREATER_THAN";
460
+ readonly GREATER_THAN_OR_EQUAL_TO: "GREATER_THAN_OR_EQUAL_TO";
461
+ readonly LESS_THAN: "LESS_THAN";
462
+ readonly LESS_THAN_OR_EQUAL_TO: "LESS_THAN_OR_EQUAL_TO";
463
+ readonly EQUAL_TO: "EQUAL_TO";
464
+ readonly NOT_EQUAL_TO: "NOT_EQUAL_TO";
465
+ };
466
+ export type ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = typeof ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum[keyof typeof ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum];
467
+ /**
468
+ * Custom label object override.
469
+ * @export
470
+ * @interface CustomLabel
471
+ */
472
+ export interface CustomLabel {
473
+ /**
474
+ * Override value.
475
+ * @type {string}
476
+ * @memberof CustomLabel
477
+ */
478
+ title: string;
479
+ }
480
+ /**
481
+ * Custom metric object override.
482
+ * @export
483
+ * @interface CustomMetric
484
+ */
485
+ export interface CustomMetric {
486
+ /**
487
+ * Metric title override.
488
+ * @type {string}
489
+ * @memberof CustomMetric
490
+ */
491
+ title: string;
492
+ /**
493
+ * Format override.
494
+ * @type {string}
495
+ * @memberof CustomMetric
496
+ */
497
+ format: string;
498
+ }
499
+ /**
500
+ * Custom cell value overrides (IDs will be replaced with specified values).
501
+ * @export
502
+ * @interface CustomOverride
503
+ */
504
+ export interface CustomOverride {
505
+ /**
506
+ * Map of CustomLabels with keys used as placeholders in document.
507
+ * @type {{ [key: string]: CustomLabel; }}
508
+ * @memberof CustomOverride
509
+ */
510
+ labels?: {
511
+ [key: string]: CustomLabel;
512
+ };
513
+ /**
514
+ * Map of CustomMetrics with keys used as placeholders in document.
515
+ * @type {{ [key: string]: CustomMetric; }}
516
+ * @memberof CustomOverride
517
+ */
518
+ metrics?: {
519
+ [key: string]: CustomMetric;
520
+ };
521
+ }
522
+ /**
523
+ * @type DateFilter
524
+ * Abstract filter definition type for dates.
525
+ * @export
526
+ */
527
+ export type DateFilter = AbsoluteDateFilter | RelativeDateFilter;
528
+ /**
529
+ *
530
+ * @export
531
+ * @interface ExportResponse
532
+ */
533
+ export interface ExportResponse {
534
+ /**
535
+ *
536
+ * @type {string}
537
+ * @memberof ExportResponse
538
+ */
539
+ exportResult: string;
540
+ }
541
+ /**
542
+ * @type FilterDefinition
543
+ * Abstract filter definition type
544
+ * @export
545
+ */
546
+ export type FilterDefinition = AbsoluteDateFilter | ComparisonMeasureValueFilter | InlineFilterDefinition | NegativeAttributeFilter | PositiveAttributeFilter | RangeMeasureValueFilter | RankingFilter | RelativeDateFilter;
547
+ /**
548
+ * @type FilterDefinitionForSimpleMeasure
549
+ * Abstract filter definition type for simple metric.
550
+ * @export
551
+ */
552
+ export type FilterDefinitionForSimpleMeasure = AttributeFilter | DateFilter;
553
+ /**
554
+ * Filter in form of direct MAQL query.
555
+ * @export
556
+ * @interface InlineFilterDefinition
557
+ */
558
+ export interface InlineFilterDefinition {
559
+ /**
560
+ *
561
+ * @type {InlineFilterDefinitionInline}
562
+ * @memberof InlineFilterDefinition
563
+ */
564
+ inline: InlineFilterDefinitionInline;
565
+ }
566
+ /**
567
+ *
568
+ * @export
569
+ * @interface InlineFilterDefinitionInline
570
+ */
571
+ export interface InlineFilterDefinitionInline {
572
+ /**
573
+ * MAQL query representing the filter.
574
+ * @type {string}
575
+ * @memberof InlineFilterDefinitionInline
576
+ */
577
+ filter: string;
578
+ /**
579
+ *
580
+ * @type {string}
581
+ * @memberof InlineFilterDefinitionInline
582
+ */
583
+ localIdentifier?: string;
584
+ /**
585
+ *
586
+ * @type {boolean}
587
+ * @memberof InlineFilterDefinitionInline
588
+ */
589
+ applyOnResult?: boolean;
590
+ }
591
+ /**
592
+ * Metric defined by the raw MAQL query.
593
+ * @export
594
+ * @interface InlineMeasureDefinition
595
+ */
596
+ export interface InlineMeasureDefinition {
597
+ /**
598
+ *
599
+ * @type {InlineMeasureDefinitionInline}
600
+ * @memberof InlineMeasureDefinition
601
+ */
602
+ inline: InlineMeasureDefinitionInline;
603
+ }
604
+ /**
605
+ *
606
+ * @export
607
+ * @interface InlineMeasureDefinitionInline
608
+ */
609
+ export interface InlineMeasureDefinitionInline {
610
+ /**
611
+ * MAQL query defining the metric.
612
+ * @type {string}
613
+ * @memberof InlineMeasureDefinitionInline
614
+ */
615
+ maql: string;
616
+ }
617
+ /**
618
+ * @type MeasureDefinition
619
+ * Abstract metric definition type
620
+ * @export
621
+ */
622
+ export type MeasureDefinition = ArithmeticMeasureDefinition | InlineMeasureDefinition | PopMeasureDefinition | SimpleMeasureDefinition;
623
+ /**
624
+ * Metric is a quantity that is calculated from the data.
625
+ * @export
626
+ * @interface MeasureItem
627
+ */
628
+ export interface MeasureItem {
629
+ /**
630
+ * Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
631
+ * @type {string}
632
+ * @memberof MeasureItem
633
+ */
634
+ localIdentifier: string;
635
+ /**
636
+ *
637
+ * @type {MeasureDefinition}
638
+ * @memberof MeasureItem
639
+ */
640
+ definition: MeasureDefinition;
641
+ }
642
+ /**
643
+ * @type MeasureValueFilter
644
+ * Abstract filter definition type filtering by the value of the metric.
645
+ * @export
646
+ */
647
+ export type MeasureValueFilter = ComparisonMeasureValueFilter | RangeMeasureValueFilter;
648
+ /**
649
+ * Filter able to limit element values by label and related selected negated elements.
650
+ * @export
651
+ * @interface NegativeAttributeFilter
652
+ */
653
+ export interface NegativeAttributeFilter {
654
+ /**
655
+ *
656
+ * @type {NegativeAttributeFilterNegativeAttributeFilter}
657
+ * @memberof NegativeAttributeFilter
658
+ */
659
+ negativeAttributeFilter: NegativeAttributeFilterNegativeAttributeFilter;
660
+ }
661
+ /**
662
+ *
663
+ * @export
664
+ * @interface NegativeAttributeFilterNegativeAttributeFilter
665
+ */
666
+ export interface NegativeAttributeFilterNegativeAttributeFilter {
667
+ /**
668
+ *
669
+ * @type {AttributeFilterElements}
670
+ * @memberof NegativeAttributeFilterNegativeAttributeFilter
671
+ */
672
+ notIn: AttributeFilterElements;
673
+ /**
674
+ *
675
+ * @type {string}
676
+ * @memberof NegativeAttributeFilterNegativeAttributeFilter
677
+ */
678
+ localIdentifier?: string;
679
+ /**
680
+ *
681
+ * @type {boolean}
682
+ * @memberof NegativeAttributeFilterNegativeAttributeFilter
683
+ */
684
+ applyOnResult?: boolean;
685
+ /**
686
+ *
687
+ * @type {AfmIdentifier}
688
+ * @memberof NegativeAttributeFilterNegativeAttributeFilter
689
+ */
690
+ label: AfmIdentifier;
691
+ }
692
+ /**
693
+ * Custom CSS styles for the table. (PDF, HTML)
694
+ * @export
695
+ * @interface PdfTableStyle
696
+ */
697
+ export interface PdfTableStyle {
698
+ /**
699
+ * CSS selector where to apply given properties.
700
+ * @type {string}
701
+ * @memberof PdfTableStyle
702
+ */
703
+ selector: string;
704
+ /**
705
+ * List of CSS properties.
706
+ * @type {Array<PdfTableStyleProperty>}
707
+ * @memberof PdfTableStyle
708
+ */
709
+ properties?: Array<PdfTableStyleProperty>;
710
+ }
711
+ /**
712
+ * CSS property.
713
+ * @export
714
+ * @interface PdfTableStyleProperty
715
+ */
716
+ export interface PdfTableStyleProperty {
717
+ /**
718
+ * CSS property key.
719
+ * @type {string}
720
+ * @memberof PdfTableStyleProperty
721
+ */
722
+ key: string;
723
+ /**
724
+ * CSS property value.
725
+ * @type {string}
726
+ * @memberof PdfTableStyleProperty
727
+ */
728
+ value: string;
729
+ }
730
+ /**
731
+ * Combination of the date data set to use and how many periods ago to calculate the previous period for.
732
+ * @export
733
+ * @interface PopDataset
734
+ */
735
+ export interface PopDataset {
736
+ /**
737
+ *
738
+ * @type {AfmObjectIdentifierDataset}
739
+ * @memberof PopDataset
740
+ */
741
+ dataset: AfmObjectIdentifierDataset;
742
+ /**
743
+ * Number of periods ago to calculate the previous period for.
744
+ * @type {number}
745
+ * @memberof PopDataset
746
+ */
747
+ periodsAgo: number;
748
+ }
749
+ /**
750
+ * Previous period type of metric.
751
+ * @export
752
+ * @interface PopDatasetMeasureDefinition
753
+ */
754
+ export interface PopDatasetMeasureDefinition {
755
+ /**
756
+ *
757
+ * @type {PopDatasetMeasureDefinitionPreviousPeriodMeasure}
758
+ * @memberof PopDatasetMeasureDefinition
759
+ */
760
+ previousPeriodMeasure: PopDatasetMeasureDefinitionPreviousPeriodMeasure;
761
+ }
762
+ /**
763
+ *
764
+ * @export
765
+ * @interface PopDatasetMeasureDefinitionPreviousPeriodMeasure
766
+ */
767
+ export interface PopDatasetMeasureDefinitionPreviousPeriodMeasure {
768
+ /**
769
+ *
770
+ * @type {AfmLocalIdentifier}
771
+ * @memberof PopDatasetMeasureDefinitionPreviousPeriodMeasure
772
+ */
773
+ measureIdentifier: AfmLocalIdentifier;
774
+ /**
775
+ * Specification of which date data sets to use for determining the period to calculate the previous period for.
776
+ * @type {Array<PopDataset>}
777
+ * @memberof PopDatasetMeasureDefinitionPreviousPeriodMeasure
778
+ */
779
+ dateDatasets: Array<PopDataset>;
780
+ }
781
+ /**
782
+ * Combination of the date attribute to use and how many periods ago to calculate the PoP for.
783
+ * @export
784
+ * @interface PopDate
785
+ */
786
+ export interface PopDate {
787
+ /**
788
+ *
789
+ * @type {AfmObjectIdentifierAttribute}
790
+ * @memberof PopDate
791
+ */
792
+ attribute: AfmObjectIdentifierAttribute;
793
+ /**
794
+ * Number of periods ago to calculate the previous period for.
795
+ * @type {number}
796
+ * @memberof PopDate
797
+ */
798
+ periodsAgo: number;
799
+ }
800
+ /**
801
+ * Period over period type of metric.
802
+ * @export
803
+ * @interface PopDateMeasureDefinition
804
+ */
805
+ export interface PopDateMeasureDefinition {
806
+ /**
807
+ *
808
+ * @type {PopDateMeasureDefinitionOverPeriodMeasure}
809
+ * @memberof PopDateMeasureDefinition
810
+ */
811
+ overPeriodMeasure: PopDateMeasureDefinitionOverPeriodMeasure;
812
+ }
813
+ /**
814
+ *
815
+ * @export
816
+ * @interface PopDateMeasureDefinitionOverPeriodMeasure
817
+ */
818
+ export interface PopDateMeasureDefinitionOverPeriodMeasure {
819
+ /**
820
+ *
821
+ * @type {AfmLocalIdentifier}
822
+ * @memberof PopDateMeasureDefinitionOverPeriodMeasure
823
+ */
824
+ measureIdentifier: AfmLocalIdentifier;
825
+ /**
826
+ * Attributes to use for determining the period to calculate the PoP for.
827
+ * @type {Array<PopDate>}
828
+ * @memberof PopDateMeasureDefinitionOverPeriodMeasure
829
+ */
830
+ dateAttributes: Array<PopDate>;
831
+ }
832
+ /**
833
+ * @type PopMeasureDefinition
834
+ * @export
835
+ */
836
+ export type PopMeasureDefinition = PopDatasetMeasureDefinition | PopDateMeasureDefinition;
837
+ /**
838
+ * Filter able to limit element values by label and related selected elements.
839
+ * @export
840
+ * @interface PositiveAttributeFilter
841
+ */
842
+ export interface PositiveAttributeFilter {
843
+ /**
844
+ *
845
+ * @type {PositiveAttributeFilterPositiveAttributeFilter}
846
+ * @memberof PositiveAttributeFilter
847
+ */
848
+ positiveAttributeFilter: PositiveAttributeFilterPositiveAttributeFilter;
849
+ }
850
+ /**
851
+ *
852
+ * @export
853
+ * @interface PositiveAttributeFilterPositiveAttributeFilter
854
+ */
855
+ export interface PositiveAttributeFilterPositiveAttributeFilter {
856
+ /**
857
+ *
858
+ * @type {AttributeFilterElements}
859
+ * @memberof PositiveAttributeFilterPositiveAttributeFilter
860
+ */
861
+ in: AttributeFilterElements;
862
+ /**
863
+ *
864
+ * @type {string}
865
+ * @memberof PositiveAttributeFilterPositiveAttributeFilter
866
+ */
867
+ localIdentifier?: string;
868
+ /**
869
+ *
870
+ * @type {boolean}
871
+ * @memberof PositiveAttributeFilterPositiveAttributeFilter
872
+ */
873
+ applyOnResult?: boolean;
874
+ /**
875
+ *
876
+ * @type {AfmIdentifier}
877
+ * @memberof PositiveAttributeFilterPositiveAttributeFilter
878
+ */
879
+ label: AfmIdentifier;
880
+ }
881
+ /**
882
+ * Filter the result by comparing specified metric to given range of values.
883
+ * @export
884
+ * @interface RangeMeasureValueFilter
885
+ */
886
+ export interface RangeMeasureValueFilter {
887
+ /**
888
+ *
889
+ * @type {RangeMeasureValueFilterRangeMeasureValueFilter}
890
+ * @memberof RangeMeasureValueFilter
891
+ */
892
+ rangeMeasureValueFilter: RangeMeasureValueFilterRangeMeasureValueFilter;
893
+ }
894
+ /**
895
+ *
896
+ * @export
897
+ * @interface RangeMeasureValueFilterRangeMeasureValueFilter
898
+ */
899
+ export interface RangeMeasureValueFilterRangeMeasureValueFilter {
900
+ /**
901
+ * References to the attributes to be used when filtering.
902
+ * @type {Array<AfmIdentifier>}
903
+ * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
904
+ */
905
+ dimensionality?: Array<AfmIdentifier>;
906
+ /**
907
+ * A value that will be substituted for null values in the metric for the comparisons.
908
+ * @type {number}
909
+ * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
910
+ */
911
+ treatNullValuesAs?: number;
912
+ /**
913
+ *
914
+ * @type {string}
915
+ * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
916
+ */
917
+ operator: RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
918
+ /**
919
+ *
920
+ * @type {number}
921
+ * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
922
+ */
923
+ from: number;
924
+ /**
925
+ *
926
+ * @type {number}
927
+ * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
928
+ */
929
+ to: number;
930
+ /**
931
+ *
932
+ * @type {string}
933
+ * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
934
+ */
935
+ localIdentifier?: string;
936
+ /**
937
+ *
938
+ * @type {boolean}
939
+ * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
940
+ */
941
+ applyOnResult?: boolean;
942
+ /**
943
+ *
944
+ * @type {AfmIdentifier}
945
+ * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
946
+ */
947
+ measure: AfmIdentifier;
948
+ }
949
+ export declare const RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum: {
950
+ readonly BETWEEN: "BETWEEN";
951
+ readonly NOT_BETWEEN: "NOT_BETWEEN";
952
+ };
953
+ export type RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = typeof RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum[keyof typeof RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum];
954
+ /**
955
+ * Filter the result on top/bottom N values according to given metric(s).
956
+ * @export
957
+ * @interface RankingFilter
958
+ */
959
+ export interface RankingFilter {
960
+ /**
961
+ *
962
+ * @type {RankingFilterRankingFilter}
963
+ * @memberof RankingFilter
964
+ */
965
+ rankingFilter: RankingFilterRankingFilter;
966
+ }
967
+ /**
968
+ *
969
+ * @export
970
+ * @interface RankingFilterRankingFilter
971
+ */
972
+ export interface RankingFilterRankingFilter {
973
+ /**
974
+ * References to the attributes to be used when filtering.
975
+ * @type {Array<AfmIdentifier>}
976
+ * @memberof RankingFilterRankingFilter
977
+ */
978
+ dimensionality?: Array<AfmIdentifier>;
979
+ /**
980
+ * References to the metrics to be used when filtering.
981
+ * @type {Array<AfmIdentifier>}
982
+ * @memberof RankingFilterRankingFilter
983
+ */
984
+ measures: Array<AfmIdentifier>;
985
+ /**
986
+ * The type of ranking to use, TOP or BOTTOM.
987
+ * @type {string}
988
+ * @memberof RankingFilterRankingFilter
989
+ */
990
+ operator: RankingFilterRankingFilterOperatorEnum;
991
+ /**
992
+ * Number of top/bottom values to filter.
993
+ * @type {number}
994
+ * @memberof RankingFilterRankingFilter
995
+ */
996
+ value: number;
997
+ /**
998
+ *
999
+ * @type {string}
1000
+ * @memberof RankingFilterRankingFilter
1001
+ */
1002
+ localIdentifier?: string;
1003
+ /**
1004
+ *
1005
+ * @type {boolean}
1006
+ * @memberof RankingFilterRankingFilter
1007
+ */
1008
+ applyOnResult?: boolean;
1009
+ }
1010
+ export declare const RankingFilterRankingFilterOperatorEnum: {
1011
+ readonly TOP: "TOP";
1012
+ readonly BOTTOM: "BOTTOM";
1013
+ };
1014
+ export type RankingFilterRankingFilterOperatorEnum = typeof RankingFilterRankingFilterOperatorEnum[keyof typeof RankingFilterRankingFilterOperatorEnum];
1015
+ /**
1016
+ * Export request object describing the export properties and overrides for raw exports.
1017
+ * @export
1018
+ * @interface RawExportRequest
1019
+ */
1020
+ export interface RawExportRequest {
1021
+ /**
1022
+ * Requested resulting file type.
1023
+ * @type {string}
1024
+ * @memberof RawExportRequest
1025
+ */
1026
+ format: RawExportRequestFormatEnum;
1027
+ /**
1028
+ *
1029
+ * @type {AFM}
1030
+ * @memberof RawExportRequest
1031
+ */
1032
+ execution: AFM;
1033
+ /**
1034
+ * Filename of downloaded file without extension.
1035
+ * @type {string}
1036
+ * @memberof RawExportRequest
1037
+ */
1038
+ fileName: string;
1039
+ }
1040
+ export declare const RawExportRequestFormatEnum: {
1041
+ readonly ARROW_FILE: "ARROW_FILE";
1042
+ readonly ARROW_STREAM: "ARROW_STREAM";
1043
+ readonly CSV: "CSV";
1044
+ };
1045
+ export type RawExportRequestFormatEnum = typeof RawExportRequestFormatEnum[keyof typeof RawExportRequestFormatEnum];
1046
+ /**
1047
+ * A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension.
1048
+ * @export
1049
+ * @interface RelativeDateFilter
1050
+ */
1051
+ export interface RelativeDateFilter {
1052
+ /**
1053
+ *
1054
+ * @type {RelativeDateFilterRelativeDateFilter}
1055
+ * @memberof RelativeDateFilter
1056
+ */
1057
+ relativeDateFilter: RelativeDateFilterRelativeDateFilter;
1058
+ }
1059
+ /**
1060
+ *
1061
+ * @export
1062
+ * @interface RelativeDateFilterRelativeDateFilter
1063
+ */
1064
+ export interface RelativeDateFilterRelativeDateFilter {
1065
+ /**
1066
+ * Date granularity specifying particular date attribute in given dimension.
1067
+ * @type {string}
1068
+ * @memberof RelativeDateFilterRelativeDateFilter
1069
+ */
1070
+ granularity: RelativeDateFilterRelativeDateFilterGranularityEnum;
1071
+ /**
1072
+ * Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for \'2 days/weeks, ... ago\').
1073
+ * @type {number}
1074
+ * @memberof RelativeDateFilterRelativeDateFilter
1075
+ */
1076
+ from: number;
1077
+ /**
1078
+ * End of the filtering interval. Specified by number of periods (with respect to given granularity). Value \'O\' is representing current time-interval (current day, week, ...).
1079
+ * @type {number}
1080
+ * @memberof RelativeDateFilterRelativeDateFilter
1081
+ */
1082
+ to: number;
1083
+ /**
1084
+ *
1085
+ * @type {string}
1086
+ * @memberof RelativeDateFilterRelativeDateFilter
1087
+ */
1088
+ localIdentifier?: string;
1089
+ /**
1090
+ *
1091
+ * @type {boolean}
1092
+ * @memberof RelativeDateFilterRelativeDateFilter
1093
+ */
1094
+ applyOnResult?: boolean;
1095
+ /**
1096
+ *
1097
+ * @type {AfmObjectIdentifierDataset}
1098
+ * @memberof RelativeDateFilterRelativeDateFilter
1099
+ */
1100
+ dataset: AfmObjectIdentifierDataset;
1101
+ }
1102
+ export declare const RelativeDateFilterRelativeDateFilterGranularityEnum: {
1103
+ readonly MINUTE: "MINUTE";
1104
+ readonly HOUR: "HOUR";
1105
+ readonly DAY: "DAY";
1106
+ readonly WEEK: "WEEK";
1107
+ readonly MONTH: "MONTH";
1108
+ readonly QUARTER: "QUARTER";
1109
+ readonly YEAR: "YEAR";
1110
+ readonly MINUTE_OF_HOUR: "MINUTE_OF_HOUR";
1111
+ readonly HOUR_OF_DAY: "HOUR_OF_DAY";
1112
+ readonly DAY_OF_WEEK: "DAY_OF_WEEK";
1113
+ readonly DAY_OF_MONTH: "DAY_OF_MONTH";
1114
+ readonly DAY_OF_YEAR: "DAY_OF_YEAR";
1115
+ readonly WEEK_OF_YEAR: "WEEK_OF_YEAR";
1116
+ readonly MONTH_OF_YEAR: "MONTH_OF_YEAR";
1117
+ readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
1118
+ };
1119
+ export type RelativeDateFilterRelativeDateFilterGranularityEnum = typeof RelativeDateFilterRelativeDateFilterGranularityEnum[keyof typeof RelativeDateFilterRelativeDateFilterGranularityEnum];
1120
+ /**
1121
+ * Additional settings.
1122
+ * @export
1123
+ * @interface Settings
1124
+ */
1125
+ export interface Settings {
1126
+ /**
1127
+ * Merge equal headers in neighbouring cells. (XLSX)
1128
+ * @type {boolean}
1129
+ * @memberof Settings
1130
+ */
1131
+ mergeHeaders?: boolean;
1132
+ /**
1133
+ * Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)
1134
+ * @type {boolean}
1135
+ * @memberof Settings
1136
+ */
1137
+ showFilters?: boolean;
1138
+ /**
1139
+ * Page size and orientation. (PDF)
1140
+ * @type {string}
1141
+ * @memberof Settings
1142
+ */
1143
+ pdfPageSize?: string;
1144
+ /**
1145
+ * Custom CSS styles for the table. (PDF, HTML)
1146
+ * @type {Array<PdfTableStyle>}
1147
+ * @memberof Settings
1148
+ */
1149
+ pdfTableStyle?: Array<PdfTableStyle>;
1150
+ /**
1151
+ * Top left header content. (PDF)
1152
+ * @type {string}
1153
+ * @memberof Settings
1154
+ */
1155
+ pdfTopLeftContent?: string;
1156
+ /**
1157
+ * Top right header content. (PDF)
1158
+ * @type {string}
1159
+ * @memberof Settings
1160
+ */
1161
+ pdfTopRightContent?: string;
1162
+ }
1163
+ /**
1164
+ * Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
1165
+ * @export
1166
+ * @interface SimpleMeasureDefinition
1167
+ */
1168
+ export interface SimpleMeasureDefinition {
1169
+ /**
1170
+ *
1171
+ * @type {SimpleMeasureDefinitionMeasure}
1172
+ * @memberof SimpleMeasureDefinition
1173
+ */
1174
+ measure: SimpleMeasureDefinitionMeasure;
1175
+ }
1176
+ /**
1177
+ *
1178
+ * @export
1179
+ * @interface SimpleMeasureDefinitionMeasure
1180
+ */
1181
+ export interface SimpleMeasureDefinitionMeasure {
1182
+ /**
1183
+ *
1184
+ * @type {AfmObjectIdentifierCore}
1185
+ * @memberof SimpleMeasureDefinitionMeasure
1186
+ */
1187
+ item: AfmObjectIdentifierCore;
1188
+ /**
1189
+ * Definition of aggregation type of the metric.
1190
+ * @type {string}
1191
+ * @memberof SimpleMeasureDefinitionMeasure
1192
+ */
1193
+ aggregation?: SimpleMeasureDefinitionMeasureAggregationEnum;
1194
+ /**
1195
+ * If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).
1196
+ * @type {boolean}
1197
+ * @memberof SimpleMeasureDefinitionMeasure
1198
+ */
1199
+ computeRatio?: boolean;
1200
+ /**
1201
+ * Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.
1202
+ * @type {Array<FilterDefinitionForSimpleMeasure>}
1203
+ * @memberof SimpleMeasureDefinitionMeasure
1204
+ */
1205
+ filters?: Array<FilterDefinitionForSimpleMeasure>;
1206
+ }
1207
+ export declare const SimpleMeasureDefinitionMeasureAggregationEnum: {
1208
+ readonly SUM: "SUM";
1209
+ readonly COUNT: "COUNT";
1210
+ readonly AVG: "AVG";
1211
+ readonly MIN: "MIN";
1212
+ readonly MAX: "MAX";
1213
+ readonly MEDIAN: "MEDIAN";
1214
+ readonly RUNSUM: "RUNSUM";
1215
+ readonly APPROXIMATE_COUNT: "APPROXIMATE_COUNT";
1216
+ };
1217
+ export type SimpleMeasureDefinitionMeasureAggregationEnum = typeof SimpleMeasureDefinitionMeasureAggregationEnum[keyof typeof SimpleMeasureDefinitionMeasureAggregationEnum];
1218
+ /**
1219
+ * Export request object describing the export properties and metadata for slideshow PDF exports.
1220
+ * @export
1221
+ * @interface SlideshowExportRequest
1222
+ */
1223
+ export interface SlideshowExportRequest {
1224
+ /**
1225
+ * Requested resulting file type.
1226
+ * @type {string}
1227
+ * @memberof SlideshowExportRequest
1228
+ */
1229
+ format: SlideshowExportRequestFormatEnum;
1230
+ /**
1231
+ * File name to be used for retrieving the pdf document.
1232
+ * @type {string}
1233
+ * @memberof SlideshowExportRequest
1234
+ */
1235
+ fileName: string;
1236
+ /**
1237
+ * Dashboard identifier
1238
+ * @type {string}
1239
+ * @memberof SlideshowExportRequest
1240
+ */
1241
+ dashboardId: string;
1242
+ /**
1243
+ * Metadata definition in free-form JSON format.
1244
+ * @type {object}
1245
+ * @memberof SlideshowExportRequest
1246
+ */
1247
+ metadata?: object | null;
1248
+ }
1249
+ export declare const SlideshowExportRequestFormatEnum: {
1250
+ readonly PDF: "PDF";
1251
+ readonly PPTX: "PPTX";
1252
+ };
1253
+ export type SlideshowExportRequestFormatEnum = typeof SlideshowExportRequestFormatEnum[keyof typeof SlideshowExportRequestFormatEnum];
1254
+ /**
1255
+ * Export request object describing the export properties and overrides for tabular exports.
1256
+ * @export
1257
+ * @interface TabularExportRequest
1258
+ */
1259
+ export interface TabularExportRequest {
1260
+ /**
1261
+ * Expected file format.
1262
+ * @type {string}
1263
+ * @memberof TabularExportRequest
1264
+ */
1265
+ format: TabularExportRequestFormatEnum;
1266
+ /**
1267
+ * Execution result identifier.
1268
+ * @type {string}
1269
+ * @memberof TabularExportRequest
1270
+ */
1271
+ executionResult?: string;
1272
+ /**
1273
+ * Filename of downloaded file without extension.
1274
+ * @type {string}
1275
+ * @memberof TabularExportRequest
1276
+ */
1277
+ fileName: string;
1278
+ /**
1279
+ *
1280
+ * @type {Settings}
1281
+ * @memberof TabularExportRequest
1282
+ */
1283
+ settings?: Settings;
1284
+ /**
1285
+ *
1286
+ * @type {CustomOverride}
1287
+ * @memberof TabularExportRequest
1288
+ */
1289
+ customOverride?: CustomOverride;
1290
+ /**
1291
+ * Visualization object identifier. Alternative to executionResult property.
1292
+ * @type {string}
1293
+ * @memberof TabularExportRequest
1294
+ */
1295
+ visualizationObject?: string;
1296
+ /**
1297
+ * Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given.
1298
+ * @type {Array<object>}
1299
+ * @memberof TabularExportRequest
1300
+ */
1301
+ visualizationObjectCustomFilters?: Array<object>;
1302
+ /**
1303
+ * Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
1304
+ * @type {string}
1305
+ * @memberof TabularExportRequest
1306
+ */
1307
+ relatedDashboardId?: string;
1308
+ /**
1309
+ * Metadata definition in free-form JSON format.
1310
+ * @type {object}
1311
+ * @memberof TabularExportRequest
1312
+ */
1313
+ metadata?: object | null;
1314
+ }
1315
+ export declare const TabularExportRequestFormatEnum: {
1316
+ readonly CSV: "CSV";
1317
+ readonly XLSX: "XLSX";
1318
+ readonly HTML: "HTML";
1319
+ readonly PDF: "PDF";
1320
+ };
1321
+ export type TabularExportRequestFormatEnum = typeof TabularExportRequestFormatEnum[keyof typeof TabularExportRequestFormatEnum];
1322
+ /**
1323
+ * Export request object describing the export properties and metadata for dashboard PDF exports.
1324
+ * @export
1325
+ * @interface VisualExportRequest
1326
+ */
1327
+ export interface VisualExportRequest {
1328
+ /**
1329
+ * File name to be used for retrieving the pdf document.
1330
+ * @type {string}
1331
+ * @memberof VisualExportRequest
1332
+ */
1333
+ fileName: string;
1334
+ /**
1335
+ * Dashboard identifier
1336
+ * @type {string}
1337
+ * @memberof VisualExportRequest
1338
+ */
1339
+ dashboardId: string;
1340
+ /**
1341
+ * Metadata definition in free-form JSON format.
1342
+ * @type {object}
1343
+ * @memberof VisualExportRequest
1344
+ */
1345
+ metadata?: object;
1346
+ }
1347
+ /**
1348
+ * ActionsApi - axios parameter creator
1349
+ * @export
1350
+ */
1351
+ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration) => {
1352
+ /**
1353
+ * 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.
1354
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1355
+ * @param {string} workspaceId
1356
+ * @param {string} dashboardId
1357
+ * @param {*} [options] Override http request option.
1358
+ * @throws {RequiredError}
1359
+ */
1360
+ createDashboardExportRequest: (workspaceId: string, dashboardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1361
+ /**
1362
+ * 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.
1363
+ * @summary Create visual - pdf export request
1364
+ * @param {string} workspaceId
1365
+ * @param {VisualExportRequest} visualExportRequest
1366
+ * @param {*} [options] Override http request option.
1367
+ * @throws {RequiredError}
1368
+ */
1369
+ createPdfExport: (workspaceId: string, visualExportRequest: VisualExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1370
+ /**
1371
+ * 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.
1372
+ * @summary (EXPERIMENTAL) Create raw export request
1373
+ * @param {string} workspaceId
1374
+ * @param {RawExportRequest} rawExportRequest
1375
+ * @param {*} [options] Override http request option.
1376
+ * @throws {RequiredError}
1377
+ */
1378
+ createRawExport: (workspaceId: string, rawExportRequest: RawExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1379
+ /**
1380
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
1381
+ * @summary (EXPERIMENTAL) Create slideshow export request
1382
+ * @param {string} workspaceId
1383
+ * @param {SlideshowExportRequest} slideshowExportRequest
1384
+ * @param {*} [options] Override http request option.
1385
+ * @throws {RequiredError}
1386
+ */
1387
+ createSlideshowExport: (workspaceId: string, slideshowExportRequest: SlideshowExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1388
+ /**
1389
+ * 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.
1390
+ * @summary Create tabular export request
1391
+ * @param {string} workspaceId
1392
+ * @param {TabularExportRequest} tabularExportRequest
1393
+ * @param {*} [options] Override http request option.
1394
+ * @throws {RequiredError}
1395
+ */
1396
+ createTabularExport: (workspaceId: string, tabularExportRequest: TabularExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1397
+ /**
1398
+ * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
1399
+ * @summary Retrieve exported files
1400
+ * @param {string} workspaceId
1401
+ * @param {string} exportId
1402
+ * @param {*} [options] Override http request option.
1403
+ * @throws {RequiredError}
1404
+ */
1405
+ getExportedFile: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1406
+ /**
1407
+ * This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
1408
+ * @summary Retrieve metadata context
1409
+ * @param {string} workspaceId
1410
+ * @param {string} exportId
1411
+ * @param {*} [options] Override http request option.
1412
+ * @throws {RequiredError}
1413
+ */
1414
+ getMetadata: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1415
+ /**
1416
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
1417
+ * @summary (EXPERIMENTAL) Retrieve metadata context
1418
+ * @param {string} workspaceId
1419
+ * @param {string} exportId
1420
+ * @param {*} [options] Override http request option.
1421
+ * @throws {RequiredError}
1422
+ */
1423
+ getMetadata1: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1424
+ /**
1425
+ * 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.
1426
+ * @summary (EXPERIMENTAL) Retrieve exported files
1427
+ * @param {string} workspaceId
1428
+ * @param {string} exportId
1429
+ * @param {*} [options] Override http request option.
1430
+ * @throws {RequiredError}
1431
+ */
1432
+ getRawExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1433
+ /**
1434
+ * 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.
1435
+ * @summary (EXPERIMENTAL) Retrieve exported files
1436
+ * @param {string} workspaceId
1437
+ * @param {string} exportId
1438
+ * @param {*} [options] Override http request option.
1439
+ * @throws {RequiredError}
1440
+ */
1441
+ getSlideshowExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1442
+ /**
1443
+ * 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.
1444
+ * @summary Retrieve exported files
1445
+ * @param {string} workspaceId
1446
+ * @param {string} exportId
1447
+ * @param {*} [options] Override http request option.
1448
+ * @throws {RequiredError}
1449
+ */
1450
+ getTabularExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1451
+ };
1452
+ /**
1453
+ * ActionsApi - functional programming interface
1454
+ * @export
1455
+ */
1456
+ export declare const ActionsApiFp: (configuration?: Configuration) => {
1457
+ /**
1458
+ * 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.
1459
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1460
+ * @param {string} workspaceId
1461
+ * @param {string} dashboardId
1462
+ * @param {*} [options] Override http request option.
1463
+ * @throws {RequiredError}
1464
+ */
1465
+ createDashboardExportRequest(workspaceId: string, dashboardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
1466
+ /**
1467
+ * 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.
1468
+ * @summary Create visual - pdf export request
1469
+ * @param {string} workspaceId
1470
+ * @param {VisualExportRequest} visualExportRequest
1471
+ * @param {*} [options] Override http request option.
1472
+ * @throws {RequiredError}
1473
+ */
1474
+ createPdfExport(workspaceId: string, visualExportRequest: VisualExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
1475
+ /**
1476
+ * 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.
1477
+ * @summary (EXPERIMENTAL) Create raw export request
1478
+ * @param {string} workspaceId
1479
+ * @param {RawExportRequest} rawExportRequest
1480
+ * @param {*} [options] Override http request option.
1481
+ * @throws {RequiredError}
1482
+ */
1483
+ createRawExport(workspaceId: string, rawExportRequest: RawExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
1484
+ /**
1485
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
1486
+ * @summary (EXPERIMENTAL) Create slideshow export request
1487
+ * @param {string} workspaceId
1488
+ * @param {SlideshowExportRequest} slideshowExportRequest
1489
+ * @param {*} [options] Override http request option.
1490
+ * @throws {RequiredError}
1491
+ */
1492
+ createSlideshowExport(workspaceId: string, slideshowExportRequest: SlideshowExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
1493
+ /**
1494
+ * 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.
1495
+ * @summary Create tabular export request
1496
+ * @param {string} workspaceId
1497
+ * @param {TabularExportRequest} tabularExportRequest
1498
+ * @param {*} [options] Override http request option.
1499
+ * @throws {RequiredError}
1500
+ */
1501
+ createTabularExport(workspaceId: string, tabularExportRequest: TabularExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
1502
+ /**
1503
+ * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
1504
+ * @summary Retrieve exported files
1505
+ * @param {string} workspaceId
1506
+ * @param {string} exportId
1507
+ * @param {*} [options] Override http request option.
1508
+ * @throws {RequiredError}
1509
+ */
1510
+ getExportedFile(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1511
+ /**
1512
+ * This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
1513
+ * @summary Retrieve metadata context
1514
+ * @param {string} workspaceId
1515
+ * @param {string} exportId
1516
+ * @param {*} [options] Override http request option.
1517
+ * @throws {RequiredError}
1518
+ */
1519
+ getMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1520
+ /**
1521
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
1522
+ * @summary (EXPERIMENTAL) Retrieve metadata context
1523
+ * @param {string} workspaceId
1524
+ * @param {string} exportId
1525
+ * @param {*} [options] Override http request option.
1526
+ * @throws {RequiredError}
1527
+ */
1528
+ getMetadata1(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1529
+ /**
1530
+ * 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.
1531
+ * @summary (EXPERIMENTAL) Retrieve exported files
1532
+ * @param {string} workspaceId
1533
+ * @param {string} exportId
1534
+ * @param {*} [options] Override http request option.
1535
+ * @throws {RequiredError}
1536
+ */
1537
+ getRawExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1538
+ /**
1539
+ * 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.
1540
+ * @summary (EXPERIMENTAL) Retrieve exported files
1541
+ * @param {string} workspaceId
1542
+ * @param {string} exportId
1543
+ * @param {*} [options] Override http request option.
1544
+ * @throws {RequiredError}
1545
+ */
1546
+ getSlideshowExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1547
+ /**
1548
+ * 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.
1549
+ * @summary Retrieve exported files
1550
+ * @param {string} workspaceId
1551
+ * @param {string} exportId
1552
+ * @param {*} [options] Override http request option.
1553
+ * @throws {RequiredError}
1554
+ */
1555
+ getTabularExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1556
+ };
1557
+ /**
1558
+ * ActionsApi - factory interface
1559
+ * @export
1560
+ */
1561
+ export declare const ActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1562
+ /**
1563
+ * 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.
1564
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1565
+ * @param {ActionsApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
1566
+ * @param {*} [options] Override http request option.
1567
+ * @throws {RequiredError}
1568
+ */
1569
+ createDashboardExportRequest(requestParameters: ActionsApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1570
+ /**
1571
+ * 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.
1572
+ * @summary Create visual - pdf export request
1573
+ * @param {ActionsApiCreatePdfExportRequest} requestParameters Request parameters.
1574
+ * @param {*} [options] Override http request option.
1575
+ * @throws {RequiredError}
1576
+ */
1577
+ createPdfExport(requestParameters: ActionsApiCreatePdfExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1578
+ /**
1579
+ * 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.
1580
+ * @summary (EXPERIMENTAL) Create raw export request
1581
+ * @param {ActionsApiCreateRawExportRequest} requestParameters Request parameters.
1582
+ * @param {*} [options] Override http request option.
1583
+ * @throws {RequiredError}
1584
+ */
1585
+ createRawExport(requestParameters: ActionsApiCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1586
+ /**
1587
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
1588
+ * @summary (EXPERIMENTAL) Create slideshow export request
1589
+ * @param {ActionsApiCreateSlideshowExportRequest} requestParameters Request parameters.
1590
+ * @param {*} [options] Override http request option.
1591
+ * @throws {RequiredError}
1592
+ */
1593
+ createSlideshowExport(requestParameters: ActionsApiCreateSlideshowExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1594
+ /**
1595
+ * 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.
1596
+ * @summary Create tabular export request
1597
+ * @param {ActionsApiCreateTabularExportRequest} requestParameters Request parameters.
1598
+ * @param {*} [options] Override http request option.
1599
+ * @throws {RequiredError}
1600
+ */
1601
+ createTabularExport(requestParameters: ActionsApiCreateTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1602
+ /**
1603
+ * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
1604
+ * @summary Retrieve exported files
1605
+ * @param {ActionsApiGetExportedFileRequest} requestParameters Request parameters.
1606
+ * @param {*} [options] Override http request option.
1607
+ * @throws {RequiredError}
1608
+ */
1609
+ getExportedFile(requestParameters: ActionsApiGetExportedFileRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1610
+ /**
1611
+ * This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
1612
+ * @summary Retrieve metadata context
1613
+ * @param {ActionsApiGetMetadataRequest} requestParameters Request parameters.
1614
+ * @param {*} [options] Override http request option.
1615
+ * @throws {RequiredError}
1616
+ */
1617
+ getMetadata(requestParameters: ActionsApiGetMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1618
+ /**
1619
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
1620
+ * @summary (EXPERIMENTAL) Retrieve metadata context
1621
+ * @param {ActionsApiGetMetadata1Request} requestParameters Request parameters.
1622
+ * @param {*} [options] Override http request option.
1623
+ * @throws {RequiredError}
1624
+ */
1625
+ getMetadata1(requestParameters: ActionsApiGetMetadata1Request, options?: AxiosRequestConfig): AxiosPromise<void>;
1626
+ /**
1627
+ * 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.
1628
+ * @summary (EXPERIMENTAL) Retrieve exported files
1629
+ * @param {ActionsApiGetRawExportRequest} requestParameters Request parameters.
1630
+ * @param {*} [options] Override http request option.
1631
+ * @throws {RequiredError}
1632
+ */
1633
+ getRawExport(requestParameters: ActionsApiGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1634
+ /**
1635
+ * 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.
1636
+ * @summary (EXPERIMENTAL) Retrieve exported files
1637
+ * @param {ActionsApiGetSlideshowExportRequest} requestParameters Request parameters.
1638
+ * @param {*} [options] Override http request option.
1639
+ * @throws {RequiredError}
1640
+ */
1641
+ getSlideshowExport(requestParameters: ActionsApiGetSlideshowExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1642
+ /**
1643
+ * 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.
1644
+ * @summary Retrieve exported files
1645
+ * @param {ActionsApiGetTabularExportRequest} requestParameters Request parameters.
1646
+ * @param {*} [options] Override http request option.
1647
+ * @throws {RequiredError}
1648
+ */
1649
+ getTabularExport(requestParameters: ActionsApiGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1650
+ };
1651
+ /**
1652
+ * ActionsApi - interface
1653
+ * @export
1654
+ * @interface ActionsApi
1655
+ */
1656
+ export interface ActionsApiInterface {
1657
+ /**
1658
+ * 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.
1659
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1660
+ * @param {ActionsApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
1661
+ * @param {*} [options] Override http request option.
1662
+ * @throws {RequiredError}
1663
+ * @memberof ActionsApiInterface
1664
+ */
1665
+ createDashboardExportRequest(requestParameters: ActionsApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1666
+ /**
1667
+ * 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.
1668
+ * @summary Create visual - pdf export request
1669
+ * @param {ActionsApiCreatePdfExportRequest} requestParameters Request parameters.
1670
+ * @param {*} [options] Override http request option.
1671
+ * @throws {RequiredError}
1672
+ * @memberof ActionsApiInterface
1673
+ */
1674
+ createPdfExport(requestParameters: ActionsApiCreatePdfExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1675
+ /**
1676
+ * 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.
1677
+ * @summary (EXPERIMENTAL) Create raw export request
1678
+ * @param {ActionsApiCreateRawExportRequest} requestParameters Request parameters.
1679
+ * @param {*} [options] Override http request option.
1680
+ * @throws {RequiredError}
1681
+ * @memberof ActionsApiInterface
1682
+ */
1683
+ createRawExport(requestParameters: ActionsApiCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1684
+ /**
1685
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
1686
+ * @summary (EXPERIMENTAL) Create slideshow export request
1687
+ * @param {ActionsApiCreateSlideshowExportRequest} requestParameters Request parameters.
1688
+ * @param {*} [options] Override http request option.
1689
+ * @throws {RequiredError}
1690
+ * @memberof ActionsApiInterface
1691
+ */
1692
+ createSlideshowExport(requestParameters: ActionsApiCreateSlideshowExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1693
+ /**
1694
+ * 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.
1695
+ * @summary Create tabular export request
1696
+ * @param {ActionsApiCreateTabularExportRequest} requestParameters Request parameters.
1697
+ * @param {*} [options] Override http request option.
1698
+ * @throws {RequiredError}
1699
+ * @memberof ActionsApiInterface
1700
+ */
1701
+ createTabularExport(requestParameters: ActionsApiCreateTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1702
+ /**
1703
+ * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
1704
+ * @summary Retrieve exported files
1705
+ * @param {ActionsApiGetExportedFileRequest} requestParameters Request parameters.
1706
+ * @param {*} [options] Override http request option.
1707
+ * @throws {RequiredError}
1708
+ * @memberof ActionsApiInterface
1709
+ */
1710
+ getExportedFile(requestParameters: ActionsApiGetExportedFileRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1711
+ /**
1712
+ * This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
1713
+ * @summary Retrieve metadata context
1714
+ * @param {ActionsApiGetMetadataRequest} requestParameters Request parameters.
1715
+ * @param {*} [options] Override http request option.
1716
+ * @throws {RequiredError}
1717
+ * @memberof ActionsApiInterface
1718
+ */
1719
+ getMetadata(requestParameters: ActionsApiGetMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1720
+ /**
1721
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
1722
+ * @summary (EXPERIMENTAL) Retrieve metadata context
1723
+ * @param {ActionsApiGetMetadata1Request} requestParameters Request parameters.
1724
+ * @param {*} [options] Override http request option.
1725
+ * @throws {RequiredError}
1726
+ * @memberof ActionsApiInterface
1727
+ */
1728
+ getMetadata1(requestParameters: ActionsApiGetMetadata1Request, options?: AxiosRequestConfig): AxiosPromise<void>;
1729
+ /**
1730
+ * 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.
1731
+ * @summary (EXPERIMENTAL) Retrieve exported files
1732
+ * @param {ActionsApiGetRawExportRequest} requestParameters Request parameters.
1733
+ * @param {*} [options] Override http request option.
1734
+ * @throws {RequiredError}
1735
+ * @memberof ActionsApiInterface
1736
+ */
1737
+ getRawExport(requestParameters: ActionsApiGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1738
+ /**
1739
+ * 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.
1740
+ * @summary (EXPERIMENTAL) Retrieve exported files
1741
+ * @param {ActionsApiGetSlideshowExportRequest} requestParameters Request parameters.
1742
+ * @param {*} [options] Override http request option.
1743
+ * @throws {RequiredError}
1744
+ * @memberof ActionsApiInterface
1745
+ */
1746
+ getSlideshowExport(requestParameters: ActionsApiGetSlideshowExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1747
+ /**
1748
+ * 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.
1749
+ * @summary Retrieve exported files
1750
+ * @param {ActionsApiGetTabularExportRequest} requestParameters Request parameters.
1751
+ * @param {*} [options] Override http request option.
1752
+ * @throws {RequiredError}
1753
+ * @memberof ActionsApiInterface
1754
+ */
1755
+ getTabularExport(requestParameters: ActionsApiGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1756
+ }
1757
+ /**
1758
+ * Request parameters for createDashboardExportRequest operation in ActionsApi.
1759
+ * @export
1760
+ * @interface ActionsApiCreateDashboardExportRequestRequest
1761
+ */
1762
+ export interface ActionsApiCreateDashboardExportRequestRequest {
1763
+ /**
1764
+ *
1765
+ * @type {string}
1766
+ * @memberof ActionsApiCreateDashboardExportRequest
1767
+ */
1768
+ readonly workspaceId: string;
1769
+ /**
1770
+ *
1771
+ * @type {string}
1772
+ * @memberof ActionsApiCreateDashboardExportRequest
1773
+ */
1774
+ readonly dashboardId: string;
1775
+ }
1776
+ /**
1777
+ * Request parameters for createPdfExport operation in ActionsApi.
1778
+ * @export
1779
+ * @interface ActionsApiCreatePdfExportRequest
1780
+ */
1781
+ export interface ActionsApiCreatePdfExportRequest {
1782
+ /**
1783
+ *
1784
+ * @type {string}
1785
+ * @memberof ActionsApiCreatePdfExport
1786
+ */
1787
+ readonly workspaceId: string;
1788
+ /**
1789
+ *
1790
+ * @type {VisualExportRequest}
1791
+ * @memberof ActionsApiCreatePdfExport
1792
+ */
1793
+ readonly visualExportRequest: VisualExportRequest;
1794
+ }
1795
+ /**
1796
+ * Request parameters for createRawExport operation in ActionsApi.
1797
+ * @export
1798
+ * @interface ActionsApiCreateRawExportRequest
1799
+ */
1800
+ export interface ActionsApiCreateRawExportRequest {
1801
+ /**
1802
+ *
1803
+ * @type {string}
1804
+ * @memberof ActionsApiCreateRawExport
1805
+ */
1806
+ readonly workspaceId: string;
1807
+ /**
1808
+ *
1809
+ * @type {RawExportRequest}
1810
+ * @memberof ActionsApiCreateRawExport
1811
+ */
1812
+ readonly rawExportRequest: RawExportRequest;
1813
+ }
1814
+ /**
1815
+ * Request parameters for createSlideshowExport operation in ActionsApi.
1816
+ * @export
1817
+ * @interface ActionsApiCreateSlideshowExportRequest
1818
+ */
1819
+ export interface ActionsApiCreateSlideshowExportRequest {
1820
+ /**
1821
+ *
1822
+ * @type {string}
1823
+ * @memberof ActionsApiCreateSlideshowExport
1824
+ */
1825
+ readonly workspaceId: string;
1826
+ /**
1827
+ *
1828
+ * @type {SlideshowExportRequest}
1829
+ * @memberof ActionsApiCreateSlideshowExport
1830
+ */
1831
+ readonly slideshowExportRequest: SlideshowExportRequest;
1832
+ }
1833
+ /**
1834
+ * Request parameters for createTabularExport operation in ActionsApi.
1835
+ * @export
1836
+ * @interface ActionsApiCreateTabularExportRequest
1837
+ */
1838
+ export interface ActionsApiCreateTabularExportRequest {
1839
+ /**
1840
+ *
1841
+ * @type {string}
1842
+ * @memberof ActionsApiCreateTabularExport
1843
+ */
1844
+ readonly workspaceId: string;
1845
+ /**
1846
+ *
1847
+ * @type {TabularExportRequest}
1848
+ * @memberof ActionsApiCreateTabularExport
1849
+ */
1850
+ readonly tabularExportRequest: TabularExportRequest;
1851
+ }
1852
+ /**
1853
+ * Request parameters for getExportedFile operation in ActionsApi.
1854
+ * @export
1855
+ * @interface ActionsApiGetExportedFileRequest
1856
+ */
1857
+ export interface ActionsApiGetExportedFileRequest {
1858
+ /**
1859
+ *
1860
+ * @type {string}
1861
+ * @memberof ActionsApiGetExportedFile
1862
+ */
1863
+ readonly workspaceId: string;
1864
+ /**
1865
+ *
1866
+ * @type {string}
1867
+ * @memberof ActionsApiGetExportedFile
1868
+ */
1869
+ readonly exportId: string;
1870
+ }
1871
+ /**
1872
+ * Request parameters for getMetadata operation in ActionsApi.
1873
+ * @export
1874
+ * @interface ActionsApiGetMetadataRequest
1875
+ */
1876
+ export interface ActionsApiGetMetadataRequest {
1877
+ /**
1878
+ *
1879
+ * @type {string}
1880
+ * @memberof ActionsApiGetMetadata
1881
+ */
1882
+ readonly workspaceId: string;
1883
+ /**
1884
+ *
1885
+ * @type {string}
1886
+ * @memberof ActionsApiGetMetadata
1887
+ */
1888
+ readonly exportId: string;
1889
+ }
1890
+ /**
1891
+ * Request parameters for getMetadata1 operation in ActionsApi.
1892
+ * @export
1893
+ * @interface ActionsApiGetMetadata1Request
1894
+ */
1895
+ export interface ActionsApiGetMetadata1Request {
1896
+ /**
1897
+ *
1898
+ * @type {string}
1899
+ * @memberof ActionsApiGetMetadata1
1900
+ */
1901
+ readonly workspaceId: string;
1902
+ /**
1903
+ *
1904
+ * @type {string}
1905
+ * @memberof ActionsApiGetMetadata1
1906
+ */
1907
+ readonly exportId: string;
1908
+ }
1909
+ /**
1910
+ * Request parameters for getRawExport operation in ActionsApi.
1911
+ * @export
1912
+ * @interface ActionsApiGetRawExportRequest
1913
+ */
1914
+ export interface ActionsApiGetRawExportRequest {
1915
+ /**
1916
+ *
1917
+ * @type {string}
1918
+ * @memberof ActionsApiGetRawExport
1919
+ */
1920
+ readonly workspaceId: string;
1921
+ /**
1922
+ *
1923
+ * @type {string}
1924
+ * @memberof ActionsApiGetRawExport
1925
+ */
1926
+ readonly exportId: string;
1927
+ }
1928
+ /**
1929
+ * Request parameters for getSlideshowExport operation in ActionsApi.
1930
+ * @export
1931
+ * @interface ActionsApiGetSlideshowExportRequest
1932
+ */
1933
+ export interface ActionsApiGetSlideshowExportRequest {
1934
+ /**
1935
+ *
1936
+ * @type {string}
1937
+ * @memberof ActionsApiGetSlideshowExport
1938
+ */
1939
+ readonly workspaceId: string;
1940
+ /**
1941
+ *
1942
+ * @type {string}
1943
+ * @memberof ActionsApiGetSlideshowExport
1944
+ */
1945
+ readonly exportId: string;
1946
+ }
1947
+ /**
1948
+ * Request parameters for getTabularExport operation in ActionsApi.
1949
+ * @export
1950
+ * @interface ActionsApiGetTabularExportRequest
1951
+ */
1952
+ export interface ActionsApiGetTabularExportRequest {
1953
+ /**
1954
+ *
1955
+ * @type {string}
1956
+ * @memberof ActionsApiGetTabularExport
1957
+ */
1958
+ readonly workspaceId: string;
1959
+ /**
1960
+ *
1961
+ * @type {string}
1962
+ * @memberof ActionsApiGetTabularExport
1963
+ */
1964
+ readonly exportId: string;
1965
+ }
1966
+ /**
1967
+ * ActionsApi - object-oriented interface
1968
+ * @export
1969
+ * @class ActionsApi
1970
+ * @extends {BaseAPI}
1971
+ */
1972
+ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
1973
+ /**
1974
+ * 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.
1975
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1976
+ * @param {ActionsApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
1977
+ * @param {*} [options] Override http request option.
1978
+ * @throws {RequiredError}
1979
+ * @memberof ActionsApi
1980
+ */
1981
+ createDashboardExportRequest(requestParameters: ActionsApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
1982
+ /**
1983
+ * 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.
1984
+ * @summary Create visual - pdf export request
1985
+ * @param {ActionsApiCreatePdfExportRequest} requestParameters Request parameters.
1986
+ * @param {*} [options] Override http request option.
1987
+ * @throws {RequiredError}
1988
+ * @memberof ActionsApi
1989
+ */
1990
+ createPdfExport(requestParameters: ActionsApiCreatePdfExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
1991
+ /**
1992
+ * 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.
1993
+ * @summary (EXPERIMENTAL) Create raw export request
1994
+ * @param {ActionsApiCreateRawExportRequest} requestParameters Request parameters.
1995
+ * @param {*} [options] Override http request option.
1996
+ * @throws {RequiredError}
1997
+ * @memberof ActionsApi
1998
+ */
1999
+ createRawExport(requestParameters: ActionsApiCreateRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
2000
+ /**
2001
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
2002
+ * @summary (EXPERIMENTAL) Create slideshow export request
2003
+ * @param {ActionsApiCreateSlideshowExportRequest} requestParameters Request parameters.
2004
+ * @param {*} [options] Override http request option.
2005
+ * @throws {RequiredError}
2006
+ * @memberof ActionsApi
2007
+ */
2008
+ createSlideshowExport(requestParameters: ActionsApiCreateSlideshowExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
2009
+ /**
2010
+ * 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.
2011
+ * @summary Create tabular export request
2012
+ * @param {ActionsApiCreateTabularExportRequest} requestParameters Request parameters.
2013
+ * @param {*} [options] Override http request option.
2014
+ * @throws {RequiredError}
2015
+ * @memberof ActionsApi
2016
+ */
2017
+ createTabularExport(requestParameters: ActionsApiCreateTabularExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
2018
+ /**
2019
+ * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
2020
+ * @summary Retrieve exported files
2021
+ * @param {ActionsApiGetExportedFileRequest} requestParameters Request parameters.
2022
+ * @param {*} [options] Override http request option.
2023
+ * @throws {RequiredError}
2024
+ * @memberof ActionsApi
2025
+ */
2026
+ getExportedFile(requestParameters: ActionsApiGetExportedFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2027
+ /**
2028
+ * This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
2029
+ * @summary Retrieve metadata context
2030
+ * @param {ActionsApiGetMetadataRequest} requestParameters Request parameters.
2031
+ * @param {*} [options] Override http request option.
2032
+ * @throws {RequiredError}
2033
+ * @memberof ActionsApi
2034
+ */
2035
+ getMetadata(requestParameters: ActionsApiGetMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2036
+ /**
2037
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
2038
+ * @summary (EXPERIMENTAL) Retrieve metadata context
2039
+ * @param {ActionsApiGetMetadata1Request} requestParameters Request parameters.
2040
+ * @param {*} [options] Override http request option.
2041
+ * @throws {RequiredError}
2042
+ * @memberof ActionsApi
2043
+ */
2044
+ getMetadata1(requestParameters: ActionsApiGetMetadata1Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2045
+ /**
2046
+ * 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.
2047
+ * @summary (EXPERIMENTAL) Retrieve exported files
2048
+ * @param {ActionsApiGetRawExportRequest} requestParameters Request parameters.
2049
+ * @param {*} [options] Override http request option.
2050
+ * @throws {RequiredError}
2051
+ * @memberof ActionsApi
2052
+ */
2053
+ getRawExport(requestParameters: ActionsApiGetRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2054
+ /**
2055
+ * 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.
2056
+ * @summary (EXPERIMENTAL) Retrieve exported files
2057
+ * @param {ActionsApiGetSlideshowExportRequest} requestParameters Request parameters.
2058
+ * @param {*} [options] Override http request option.
2059
+ * @throws {RequiredError}
2060
+ * @memberof ActionsApi
2061
+ */
2062
+ getSlideshowExport(requestParameters: ActionsApiGetSlideshowExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2063
+ /**
2064
+ * 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.
2065
+ * @summary Retrieve exported files
2066
+ * @param {ActionsApiGetTabularExportRequest} requestParameters Request parameters.
2067
+ * @param {*} [options] Override http request option.
2068
+ * @throws {RequiredError}
2069
+ * @memberof ActionsApi
2070
+ */
2071
+ getTabularExport(requestParameters: ActionsApiGetTabularExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2072
+ }
2073
+ /**
2074
+ * RawExportApi - axios parameter creator
2075
+ * @export
2076
+ */
2077
+ export declare const RawExportApiAxiosParamCreator: (configuration?: Configuration) => {
2078
+ /**
2079
+ * 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.
2080
+ * @summary (EXPERIMENTAL) Create raw export request
2081
+ * @param {string} workspaceId
2082
+ * @param {RawExportRequest} rawExportRequest
2083
+ * @param {*} [options] Override http request option.
2084
+ * @throws {RequiredError}
2085
+ */
2086
+ createRawExport: (workspaceId: string, rawExportRequest: RawExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2087
+ /**
2088
+ * 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.
2089
+ * @summary (EXPERIMENTAL) Retrieve exported files
2090
+ * @param {string} workspaceId
2091
+ * @param {string} exportId
2092
+ * @param {*} [options] Override http request option.
2093
+ * @throws {RequiredError}
2094
+ */
2095
+ getRawExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2096
+ };
2097
+ /**
2098
+ * RawExportApi - functional programming interface
2099
+ * @export
2100
+ */
2101
+ export declare const RawExportApiFp: (configuration?: Configuration) => {
2102
+ /**
2103
+ * 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.
2104
+ * @summary (EXPERIMENTAL) Create raw export request
2105
+ * @param {string} workspaceId
2106
+ * @param {RawExportRequest} rawExportRequest
2107
+ * @param {*} [options] Override http request option.
2108
+ * @throws {RequiredError}
2109
+ */
2110
+ createRawExport(workspaceId: string, rawExportRequest: RawExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
2111
+ /**
2112
+ * 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.
2113
+ * @summary (EXPERIMENTAL) Retrieve exported files
2114
+ * @param {string} workspaceId
2115
+ * @param {string} exportId
2116
+ * @param {*} [options] Override http request option.
2117
+ * @throws {RequiredError}
2118
+ */
2119
+ getRawExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2120
+ };
2121
+ /**
2122
+ * RawExportApi - factory interface
2123
+ * @export
2124
+ */
2125
+ export declare const RawExportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2126
+ /**
2127
+ * 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.
2128
+ * @summary (EXPERIMENTAL) Create raw export request
2129
+ * @param {RawExportApiCreateRawExportRequest} requestParameters Request parameters.
2130
+ * @param {*} [options] Override http request option.
2131
+ * @throws {RequiredError}
2132
+ */
2133
+ createRawExport(requestParameters: RawExportApiCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
2134
+ /**
2135
+ * 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.
2136
+ * @summary (EXPERIMENTAL) Retrieve exported files
2137
+ * @param {RawExportApiGetRawExportRequest} requestParameters Request parameters.
2138
+ * @param {*} [options] Override http request option.
2139
+ * @throws {RequiredError}
2140
+ */
2141
+ getRawExport(requestParameters: RawExportApiGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
2142
+ };
2143
+ /**
2144
+ * RawExportApi - interface
2145
+ * @export
2146
+ * @interface RawExportApi
2147
+ */
2148
+ export interface RawExportApiInterface {
2149
+ /**
2150
+ * 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.
2151
+ * @summary (EXPERIMENTAL) Create raw export request
2152
+ * @param {RawExportApiCreateRawExportRequest} requestParameters Request parameters.
2153
+ * @param {*} [options] Override http request option.
2154
+ * @throws {RequiredError}
2155
+ * @memberof RawExportApiInterface
2156
+ */
2157
+ createRawExport(requestParameters: RawExportApiCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
2158
+ /**
2159
+ * 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.
2160
+ * @summary (EXPERIMENTAL) Retrieve exported files
2161
+ * @param {RawExportApiGetRawExportRequest} requestParameters Request parameters.
2162
+ * @param {*} [options] Override http request option.
2163
+ * @throws {RequiredError}
2164
+ * @memberof RawExportApiInterface
2165
+ */
2166
+ getRawExport(requestParameters: RawExportApiGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
2167
+ }
2168
+ /**
2169
+ * Request parameters for createRawExport operation in RawExportApi.
2170
+ * @export
2171
+ * @interface RawExportApiCreateRawExportRequest
2172
+ */
2173
+ export interface RawExportApiCreateRawExportRequest {
2174
+ /**
2175
+ *
2176
+ * @type {string}
2177
+ * @memberof RawExportApiCreateRawExport
2178
+ */
2179
+ readonly workspaceId: string;
2180
+ /**
2181
+ *
2182
+ * @type {RawExportRequest}
2183
+ * @memberof RawExportApiCreateRawExport
2184
+ */
2185
+ readonly rawExportRequest: RawExportRequest;
2186
+ }
2187
+ /**
2188
+ * Request parameters for getRawExport operation in RawExportApi.
2189
+ * @export
2190
+ * @interface RawExportApiGetRawExportRequest
2191
+ */
2192
+ export interface RawExportApiGetRawExportRequest {
2193
+ /**
2194
+ *
2195
+ * @type {string}
2196
+ * @memberof RawExportApiGetRawExport
2197
+ */
2198
+ readonly workspaceId: string;
2199
+ /**
2200
+ *
2201
+ * @type {string}
2202
+ * @memberof RawExportApiGetRawExport
254
2203
  */
255
- metadata?: object;
2204
+ readonly exportId: string;
256
2205
  }
257
2206
  /**
258
- * ActionsApi - axios parameter creator
2207
+ * RawExportApi - object-oriented interface
259
2208
  * @export
2209
+ * @class RawExportApi
2210
+ * @extends {BaseAPI}
260
2211
  */
261
- export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration) => {
2212
+ export declare class RawExportApi extends BaseAPI implements RawExportApiInterface {
262
2213
  /**
263
- * 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.
264
- * @summary Create visual - pdf export request
265
- * @param {string} workspaceId
266
- * @param {VisualExportRequest} visualExportRequest
2214
+ * 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.
2215
+ * @summary (EXPERIMENTAL) Create raw export request
2216
+ * @param {RawExportApiCreateRawExportRequest} requestParameters Request parameters.
267
2217
  * @param {*} [options] Override http request option.
268
2218
  * @throws {RequiredError}
2219
+ * @memberof RawExportApi
269
2220
  */
270
- createPdfExport: (workspaceId: string, visualExportRequest: VisualExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2221
+ createRawExport(requestParameters: RawExportApiCreateRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
271
2222
  /**
272
- * 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.
273
- * @summary Create tabular export request
274
- * @param {string} workspaceId
275
- * @param {TabularExportRequest} tabularExportRequest
2223
+ * 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.
2224
+ * @summary (EXPERIMENTAL) Retrieve exported files
2225
+ * @param {RawExportApiGetRawExportRequest} requestParameters Request parameters.
276
2226
  * @param {*} [options] Override http request option.
277
2227
  * @throws {RequiredError}
2228
+ * @memberof RawExportApi
278
2229
  */
279
- createTabularExport: (workspaceId: string, tabularExportRequest: TabularExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2230
+ getRawExport(requestParameters: RawExportApiGetRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2231
+ }
2232
+ /**
2233
+ * SlideshowExportApi - axios parameter creator
2234
+ * @export
2235
+ */
2236
+ export declare const SlideshowExportApiAxiosParamCreator: (configuration?: Configuration) => {
280
2237
  /**
281
- * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
282
- * @summary Retrieve exported files
2238
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
2239
+ * @summary (EXPERIMENTAL) Create slideshow export request
283
2240
  * @param {string} workspaceId
284
- * @param {string} exportId
2241
+ * @param {SlideshowExportRequest} slideshowExportRequest
285
2242
  * @param {*} [options] Override http request option.
286
2243
  * @throws {RequiredError}
287
2244
  */
288
- getExportedFile: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2245
+ createSlideshowExport: (workspaceId: string, slideshowExportRequest: SlideshowExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
289
2246
  /**
290
- * This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
291
- * @summary Retrieve metadata context
2247
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
2248
+ * @summary (EXPERIMENTAL) Retrieve metadata context
292
2249
  * @param {string} workspaceId
293
2250
  * @param {string} exportId
294
2251
  * @param {*} [options] Override http request option.
295
2252
  * @throws {RequiredError}
296
2253
  */
297
- getMetadata: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2254
+ getMetadata1: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
298
2255
  /**
299
- * 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.
300
- * @summary Retrieve exported files
2256
+ * 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.
2257
+ * @summary (EXPERIMENTAL) Retrieve exported files
301
2258
  * @param {string} workspaceId
302
2259
  * @param {string} exportId
303
2260
  * @param {*} [options] Override http request option.
304
2261
  * @throws {RequiredError}
305
2262
  */
306
- getTabularExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2263
+ getSlideshowExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
307
2264
  };
308
2265
  /**
309
- * ActionsApi - functional programming interface
2266
+ * SlideshowExportApi - functional programming interface
310
2267
  * @export
311
2268
  */
312
- export declare const ActionsApiFp: (configuration?: Configuration) => {
313
- /**
314
- * 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.
315
- * @summary Create visual - pdf export request
316
- * @param {string} workspaceId
317
- * @param {VisualExportRequest} visualExportRequest
318
- * @param {*} [options] Override http request option.
319
- * @throws {RequiredError}
320
- */
321
- createPdfExport(workspaceId: string, visualExportRequest: VisualExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
322
- /**
323
- * 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.
324
- * @summary Create tabular export request
325
- * @param {string} workspaceId
326
- * @param {TabularExportRequest} tabularExportRequest
327
- * @param {*} [options] Override http request option.
328
- * @throws {RequiredError}
329
- */
330
- createTabularExport(workspaceId: string, tabularExportRequest: TabularExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
2269
+ export declare const SlideshowExportApiFp: (configuration?: Configuration) => {
331
2270
  /**
332
- * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
333
- * @summary Retrieve exported files
2271
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
2272
+ * @summary (EXPERIMENTAL) Create slideshow export request
334
2273
  * @param {string} workspaceId
335
- * @param {string} exportId
2274
+ * @param {SlideshowExportRequest} slideshowExportRequest
336
2275
  * @param {*} [options] Override http request option.
337
2276
  * @throws {RequiredError}
338
2277
  */
339
- getExportedFile(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2278
+ createSlideshowExport(workspaceId: string, slideshowExportRequest: SlideshowExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
340
2279
  /**
341
- * This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
342
- * @summary Retrieve metadata context
2280
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
2281
+ * @summary (EXPERIMENTAL) Retrieve metadata context
343
2282
  * @param {string} workspaceId
344
2283
  * @param {string} exportId
345
2284
  * @param {*} [options] Override http request option.
346
2285
  * @throws {RequiredError}
347
2286
  */
348
- getMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2287
+ getMetadata1(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
349
2288
  /**
350
- * 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.
351
- * @summary Retrieve exported files
2289
+ * 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.
2290
+ * @summary (EXPERIMENTAL) Retrieve exported files
352
2291
  * @param {string} workspaceId
353
2292
  * @param {string} exportId
354
2293
  * @param {*} [options] Override http request option.
355
2294
  * @throws {RequiredError}
356
2295
  */
357
- getTabularExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2296
+ getSlideshowExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
358
2297
  };
359
2298
  /**
360
- * ActionsApi - factory interface
2299
+ * SlideshowExportApi - factory interface
361
2300
  * @export
362
2301
  */
363
- export declare const ActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2302
+ export declare const SlideshowExportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
364
2303
  /**
365
- * 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.
366
- * @summary Create visual - pdf export request
367
- * @param {ActionsApiCreatePdfExportRequest} requestParameters Request parameters.
368
- * @param {*} [options] Override http request option.
369
- * @throws {RequiredError}
370
- */
371
- createPdfExport(requestParameters: ActionsApiCreatePdfExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
372
- /**
373
- * 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.
374
- * @summary Create tabular export request
375
- * @param {ActionsApiCreateTabularExportRequest} requestParameters Request parameters.
376
- * @param {*} [options] Override http request option.
377
- * @throws {RequiredError}
378
- */
379
- createTabularExport(requestParameters: ActionsApiCreateTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
380
- /**
381
- * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
382
- * @summary Retrieve exported files
383
- * @param {ActionsApiGetExportedFileRequest} requestParameters Request parameters.
2304
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
2305
+ * @summary (EXPERIMENTAL) Create slideshow export request
2306
+ * @param {SlideshowExportApiCreateSlideshowExportRequest} requestParameters Request parameters.
384
2307
  * @param {*} [options] Override http request option.
385
2308
  * @throws {RequiredError}
386
2309
  */
387
- getExportedFile(requestParameters: ActionsApiGetExportedFileRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
2310
+ createSlideshowExport(requestParameters: SlideshowExportApiCreateSlideshowExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
388
2311
  /**
389
- * This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
390
- * @summary Retrieve metadata context
391
- * @param {ActionsApiGetMetadataRequest} requestParameters Request parameters.
2312
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
2313
+ * @summary (EXPERIMENTAL) Retrieve metadata context
2314
+ * @param {SlideshowExportApiGetMetadata1Request} requestParameters Request parameters.
392
2315
  * @param {*} [options] Override http request option.
393
2316
  * @throws {RequiredError}
394
2317
  */
395
- getMetadata(requestParameters: ActionsApiGetMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
2318
+ getMetadata1(requestParameters: SlideshowExportApiGetMetadata1Request, options?: AxiosRequestConfig): AxiosPromise<void>;
396
2319
  /**
397
- * 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.
398
- * @summary Retrieve exported files
399
- * @param {ActionsApiGetTabularExportRequest} requestParameters Request parameters.
2320
+ * 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.
2321
+ * @summary (EXPERIMENTAL) Retrieve exported files
2322
+ * @param {SlideshowExportApiGetSlideshowExportRequest} requestParameters Request parameters.
400
2323
  * @param {*} [options] Override http request option.
401
2324
  * @throws {RequiredError}
402
2325
  */
403
- getTabularExport(requestParameters: ActionsApiGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
2326
+ getSlideshowExport(requestParameters: SlideshowExportApiGetSlideshowExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
404
2327
  };
405
2328
  /**
406
- * ActionsApi - interface
2329
+ * SlideshowExportApi - interface
407
2330
  * @export
408
- * @interface ActionsApi
2331
+ * @interface SlideshowExportApi
409
2332
  */
410
- export interface ActionsApiInterface {
411
- /**
412
- * 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.
413
- * @summary Create visual - pdf export request
414
- * @param {ActionsApiCreatePdfExportRequest} requestParameters Request parameters.
415
- * @param {*} [options] Override http request option.
416
- * @throws {RequiredError}
417
- * @memberof ActionsApiInterface
418
- */
419
- createPdfExport(requestParameters: ActionsApiCreatePdfExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
420
- /**
421
- * 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.
422
- * @summary Create tabular export request
423
- * @param {ActionsApiCreateTabularExportRequest} requestParameters Request parameters.
424
- * @param {*} [options] Override http request option.
425
- * @throws {RequiredError}
426
- * @memberof ActionsApiInterface
427
- */
428
- createTabularExport(requestParameters: ActionsApiCreateTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
2333
+ export interface SlideshowExportApiInterface {
429
2334
  /**
430
- * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
431
- * @summary Retrieve exported files
432
- * @param {ActionsApiGetExportedFileRequest} requestParameters Request parameters.
2335
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
2336
+ * @summary (EXPERIMENTAL) Create slideshow export request
2337
+ * @param {SlideshowExportApiCreateSlideshowExportRequest} requestParameters Request parameters.
433
2338
  * @param {*} [options] Override http request option.
434
2339
  * @throws {RequiredError}
435
- * @memberof ActionsApiInterface
2340
+ * @memberof SlideshowExportApiInterface
436
2341
  */
437
- getExportedFile(requestParameters: ActionsApiGetExportedFileRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
2342
+ createSlideshowExport(requestParameters: SlideshowExportApiCreateSlideshowExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
438
2343
  /**
439
- * This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
440
- * @summary Retrieve metadata context
441
- * @param {ActionsApiGetMetadataRequest} requestParameters Request parameters.
2344
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
2345
+ * @summary (EXPERIMENTAL) Retrieve metadata context
2346
+ * @param {SlideshowExportApiGetMetadata1Request} requestParameters Request parameters.
442
2347
  * @param {*} [options] Override http request option.
443
2348
  * @throws {RequiredError}
444
- * @memberof ActionsApiInterface
2349
+ * @memberof SlideshowExportApiInterface
445
2350
  */
446
- getMetadata(requestParameters: ActionsApiGetMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
2351
+ getMetadata1(requestParameters: SlideshowExportApiGetMetadata1Request, options?: AxiosRequestConfig): AxiosPromise<void>;
447
2352
  /**
448
- * 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.
449
- * @summary Retrieve exported files
450
- * @param {ActionsApiGetTabularExportRequest} requestParameters Request parameters.
2353
+ * 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.
2354
+ * @summary (EXPERIMENTAL) Retrieve exported files
2355
+ * @param {SlideshowExportApiGetSlideshowExportRequest} requestParameters Request parameters.
451
2356
  * @param {*} [options] Override http request option.
452
2357
  * @throws {RequiredError}
453
- * @memberof ActionsApiInterface
454
- */
455
- getTabularExport(requestParameters: ActionsApiGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
456
- }
457
- /**
458
- * Request parameters for createPdfExport operation in ActionsApi.
459
- * @export
460
- * @interface ActionsApiCreatePdfExportRequest
461
- */
462
- export interface ActionsApiCreatePdfExportRequest {
463
- /**
464
- *
465
- * @type {string}
466
- * @memberof ActionsApiCreatePdfExport
467
- */
468
- readonly workspaceId: string;
469
- /**
470
- *
471
- * @type {VisualExportRequest}
472
- * @memberof ActionsApiCreatePdfExport
473
- */
474
- readonly visualExportRequest: VisualExportRequest;
475
- }
476
- /**
477
- * Request parameters for createTabularExport operation in ActionsApi.
478
- * @export
479
- * @interface ActionsApiCreateTabularExportRequest
480
- */
481
- export interface ActionsApiCreateTabularExportRequest {
482
- /**
483
- *
484
- * @type {string}
485
- * @memberof ActionsApiCreateTabularExport
486
- */
487
- readonly workspaceId: string;
488
- /**
489
- *
490
- * @type {TabularExportRequest}
491
- * @memberof ActionsApiCreateTabularExport
2358
+ * @memberof SlideshowExportApiInterface
492
2359
  */
493
- readonly tabularExportRequest: TabularExportRequest;
2360
+ getSlideshowExport(requestParameters: SlideshowExportApiGetSlideshowExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
494
2361
  }
495
2362
  /**
496
- * Request parameters for getExportedFile operation in ActionsApi.
2363
+ * Request parameters for createSlideshowExport operation in SlideshowExportApi.
497
2364
  * @export
498
- * @interface ActionsApiGetExportedFileRequest
2365
+ * @interface SlideshowExportApiCreateSlideshowExportRequest
499
2366
  */
500
- export interface ActionsApiGetExportedFileRequest {
2367
+ export interface SlideshowExportApiCreateSlideshowExportRequest {
501
2368
  /**
502
2369
  *
503
2370
  * @type {string}
504
- * @memberof ActionsApiGetExportedFile
2371
+ * @memberof SlideshowExportApiCreateSlideshowExport
505
2372
  */
506
2373
  readonly workspaceId: string;
507
2374
  /**
508
2375
  *
509
- * @type {string}
510
- * @memberof ActionsApiGetExportedFile
2376
+ * @type {SlideshowExportRequest}
2377
+ * @memberof SlideshowExportApiCreateSlideshowExport
511
2378
  */
512
- readonly exportId: string;
2379
+ readonly slideshowExportRequest: SlideshowExportRequest;
513
2380
  }
514
2381
  /**
515
- * Request parameters for getMetadata operation in ActionsApi.
2382
+ * Request parameters for getMetadata1 operation in SlideshowExportApi.
516
2383
  * @export
517
- * @interface ActionsApiGetMetadataRequest
2384
+ * @interface SlideshowExportApiGetMetadata1Request
518
2385
  */
519
- export interface ActionsApiGetMetadataRequest {
2386
+ export interface SlideshowExportApiGetMetadata1Request {
520
2387
  /**
521
2388
  *
522
2389
  * @type {string}
523
- * @memberof ActionsApiGetMetadata
2390
+ * @memberof SlideshowExportApiGetMetadata1
524
2391
  */
525
2392
  readonly workspaceId: string;
526
2393
  /**
527
2394
  *
528
2395
  * @type {string}
529
- * @memberof ActionsApiGetMetadata
2396
+ * @memberof SlideshowExportApiGetMetadata1
530
2397
  */
531
2398
  readonly exportId: string;
532
2399
  }
533
2400
  /**
534
- * Request parameters for getTabularExport operation in ActionsApi.
2401
+ * Request parameters for getSlideshowExport operation in SlideshowExportApi.
535
2402
  * @export
536
- * @interface ActionsApiGetTabularExportRequest
2403
+ * @interface SlideshowExportApiGetSlideshowExportRequest
537
2404
  */
538
- export interface ActionsApiGetTabularExportRequest {
2405
+ export interface SlideshowExportApiGetSlideshowExportRequest {
539
2406
  /**
540
2407
  *
541
2408
  * @type {string}
542
- * @memberof ActionsApiGetTabularExport
2409
+ * @memberof SlideshowExportApiGetSlideshowExport
543
2410
  */
544
2411
  readonly workspaceId: string;
545
2412
  /**
546
2413
  *
547
2414
  * @type {string}
548
- * @memberof ActionsApiGetTabularExport
2415
+ * @memberof SlideshowExportApiGetSlideshowExport
549
2416
  */
550
2417
  readonly exportId: string;
551
2418
  }
552
2419
  /**
553
- * ActionsApi - object-oriented interface
2420
+ * SlideshowExportApi - object-oriented interface
554
2421
  * @export
555
- * @class ActionsApi
2422
+ * @class SlideshowExportApi
556
2423
  * @extends {BaseAPI}
557
2424
  */
558
- export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
559
- /**
560
- * 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.
561
- * @summary Create visual - pdf export request
562
- * @param {ActionsApiCreatePdfExportRequest} requestParameters Request parameters.
563
- * @param {*} [options] Override http request option.
564
- * @throws {RequiredError}
565
- * @memberof ActionsApi
566
- */
567
- createPdfExport(requestParameters: ActionsApiCreatePdfExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
568
- /**
569
- * 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.
570
- * @summary Create tabular export request
571
- * @param {ActionsApiCreateTabularExportRequest} requestParameters Request parameters.
572
- * @param {*} [options] Override http request option.
573
- * @throws {RequiredError}
574
- * @memberof ActionsApi
575
- */
576
- createTabularExport(requestParameters: ActionsApiCreateTabularExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
2425
+ export declare class SlideshowExportApi extends BaseAPI implements SlideshowExportApiInterface {
577
2426
  /**
578
- * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
579
- * @summary Retrieve exported files
580
- * @param {ActionsApiGetExportedFileRequest} requestParameters Request parameters.
2427
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
2428
+ * @summary (EXPERIMENTAL) Create slideshow export request
2429
+ * @param {SlideshowExportApiCreateSlideshowExportRequest} requestParameters Request parameters.
581
2430
  * @param {*} [options] Override http request option.
582
2431
  * @throws {RequiredError}
583
- * @memberof ActionsApi
2432
+ * @memberof SlideshowExportApi
584
2433
  */
585
- getExportedFile(requestParameters: ActionsApiGetExportedFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2434
+ createSlideshowExport(requestParameters: SlideshowExportApiCreateSlideshowExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
586
2435
  /**
587
- * This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
588
- * @summary Retrieve metadata context
589
- * @param {ActionsApiGetMetadataRequest} requestParameters Request parameters.
2436
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
2437
+ * @summary (EXPERIMENTAL) Retrieve metadata context
2438
+ * @param {SlideshowExportApiGetMetadata1Request} requestParameters Request parameters.
590
2439
  * @param {*} [options] Override http request option.
591
2440
  * @throws {RequiredError}
592
- * @memberof ActionsApi
2441
+ * @memberof SlideshowExportApi
593
2442
  */
594
- getMetadata(requestParameters: ActionsApiGetMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2443
+ getMetadata1(requestParameters: SlideshowExportApiGetMetadata1Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
595
2444
  /**
596
- * 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.
597
- * @summary Retrieve exported files
598
- * @param {ActionsApiGetTabularExportRequest} requestParameters Request parameters.
2445
+ * 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.
2446
+ * @summary (EXPERIMENTAL) Retrieve exported files
2447
+ * @param {SlideshowExportApiGetSlideshowExportRequest} requestParameters Request parameters.
599
2448
  * @param {*} [options] Override http request option.
600
2449
  * @throws {RequiredError}
601
- * @memberof ActionsApi
2450
+ * @memberof SlideshowExportApi
602
2451
  */
603
- getTabularExport(requestParameters: ActionsApiGetTabularExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2452
+ getSlideshowExport(requestParameters: SlideshowExportApiGetSlideshowExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
604
2453
  }
605
2454
  /**
606
2455
  * TabularExportApi - axios parameter creator
607
2456
  * @export
608
2457
  */
609
2458
  export declare const TabularExportApiAxiosParamCreator: (configuration?: Configuration) => {
2459
+ /**
2460
+ * 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.
2461
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
2462
+ * @param {string} workspaceId
2463
+ * @param {string} dashboardId
2464
+ * @param {*} [options] Override http request option.
2465
+ * @throws {RequiredError}
2466
+ */
2467
+ createDashboardExportRequest: (workspaceId: string, dashboardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
610
2468
  /**
611
2469
  * 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.
612
2470
  * @summary Create tabular export request
@@ -631,6 +2489,15 @@ export declare const TabularExportApiAxiosParamCreator: (configuration?: Configu
631
2489
  * @export
632
2490
  */
633
2491
  export declare const TabularExportApiFp: (configuration?: Configuration) => {
2492
+ /**
2493
+ * 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.
2494
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
2495
+ * @param {string} workspaceId
2496
+ * @param {string} dashboardId
2497
+ * @param {*} [options] Override http request option.
2498
+ * @throws {RequiredError}
2499
+ */
2500
+ createDashboardExportRequest(workspaceId: string, dashboardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
634
2501
  /**
635
2502
  * 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.
636
2503
  * @summary Create tabular export request
@@ -655,6 +2522,14 @@ export declare const TabularExportApiFp: (configuration?: Configuration) => {
655
2522
  * @export
656
2523
  */
657
2524
  export declare const TabularExportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2525
+ /**
2526
+ * 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.
2527
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
2528
+ * @param {TabularExportApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
2529
+ * @param {*} [options] Override http request option.
2530
+ * @throws {RequiredError}
2531
+ */
2532
+ createDashboardExportRequest(requestParameters: TabularExportApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
658
2533
  /**
659
2534
  * 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.
660
2535
  * @summary Create tabular export request
@@ -678,6 +2553,15 @@ export declare const TabularExportApiFactory: (configuration?: Configuration, ba
678
2553
  * @interface TabularExportApi
679
2554
  */
680
2555
  export interface TabularExportApiInterface {
2556
+ /**
2557
+ * 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.
2558
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
2559
+ * @param {TabularExportApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
2560
+ * @param {*} [options] Override http request option.
2561
+ * @throws {RequiredError}
2562
+ * @memberof TabularExportApiInterface
2563
+ */
2564
+ createDashboardExportRequest(requestParameters: TabularExportApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
681
2565
  /**
682
2566
  * 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.
683
2567
  * @summary Create tabular export request
@@ -697,6 +2581,25 @@ export interface TabularExportApiInterface {
697
2581
  */
698
2582
  getTabularExport(requestParameters: TabularExportApiGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
699
2583
  }
2584
+ /**
2585
+ * Request parameters for createDashboardExportRequest operation in TabularExportApi.
2586
+ * @export
2587
+ * @interface TabularExportApiCreateDashboardExportRequestRequest
2588
+ */
2589
+ export interface TabularExportApiCreateDashboardExportRequestRequest {
2590
+ /**
2591
+ *
2592
+ * @type {string}
2593
+ * @memberof TabularExportApiCreateDashboardExportRequest
2594
+ */
2595
+ readonly workspaceId: string;
2596
+ /**
2597
+ *
2598
+ * @type {string}
2599
+ * @memberof TabularExportApiCreateDashboardExportRequest
2600
+ */
2601
+ readonly dashboardId: string;
2602
+ }
700
2603
  /**
701
2604
  * Request parameters for createTabularExport operation in TabularExportApi.
702
2605
  * @export
@@ -742,6 +2645,15 @@ export interface TabularExportApiGetTabularExportRequest {
742
2645
  * @extends {BaseAPI}
743
2646
  */
744
2647
  export declare class TabularExportApi extends BaseAPI implements TabularExportApiInterface {
2648
+ /**
2649
+ * 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.
2650
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
2651
+ * @param {TabularExportApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
2652
+ * @param {*} [options] Override http request option.
2653
+ * @throws {RequiredError}
2654
+ * @memberof TabularExportApi
2655
+ */
2656
+ createDashboardExportRequest(requestParameters: TabularExportApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
745
2657
  /**
746
2658
  * 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.
747
2659
  * @summary Create tabular export request