@gooddata/api-client-tiger 10.21.0-alpha.4 → 10.21.0-alpha.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/esm/__version.d.ts +1 -1
  2. package/esm/__version.d.ts.map +1 -1
  3. package/esm/__version.js +1 -1
  4. package/esm/__version.js.map +1 -1
  5. package/esm/api-client-tiger.d.ts +2700 -1516
  6. package/esm/client.d.ts +3 -3
  7. package/esm/client.d.ts.map +1 -1
  8. package/esm/client.js +3 -3
  9. package/esm/client.js.map +1 -1
  10. package/esm/export.d.ts +3 -3
  11. package/esm/export.d.ts.map +1 -1
  12. package/esm/export.js +2 -2
  13. package/esm/export.js.map +1 -1
  14. package/esm/generated/afm-rest-api/api.js +1 -1
  15. package/esm/generated/afm-rest-api/api.js.map +1 -1
  16. package/esm/generated/afm-rest-api/openapi-spec.json +1 -1
  17. package/esm/generated/auth-json-api/api.js +1 -1
  18. package/esm/generated/automation-json-api/api.js +1 -1
  19. package/esm/generated/automation-json-api/api.js.map +1 -1
  20. package/esm/generated/automation-json-api/base.js +1 -1
  21. package/esm/generated/automation-json-api/common.js +1 -1
  22. package/esm/generated/automation-json-api/configuration.js +1 -1
  23. package/esm/generated/automation-json-api/index.js +1 -1
  24. package/esm/generated/export-json-api/api.d.ts +1495 -30
  25. package/esm/generated/export-json-api/api.d.ts.map +1 -1
  26. package/esm/generated/export-json-api/api.js +569 -1
  27. package/esm/generated/export-json-api/api.js.map +1 -1
  28. package/esm/generated/export-json-api/openapi-spec.json +1001 -1
  29. package/esm/generated/metadata-json-api/api.d.ts +1328 -1349
  30. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  31. package/esm/generated/metadata-json-api/api.js +41 -38
  32. package/esm/generated/metadata-json-api/api.js.map +1 -1
  33. package/esm/generated/metadata-json-api/openapi-spec.json +5704 -5717
  34. package/esm/generated/scan-json-api/api.js +1 -1
  35. package/esm/index.d.ts +1 -1
  36. package/esm/index.d.ts.map +1 -1
  37. package/esm/index.js.map +1 -1
  38. package/package.json +3 -3
@@ -12,6 +12,458 @@
12
12
  import { Configuration } from "./configuration.js";
13
13
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from "axios";
14
14
  import { RequestArgs, BaseAPI } from './base.js';
15
+ /**
16
+ * Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.
17
+ * @export
18
+ * @interface AFM
19
+ */
20
+ export interface AFM {
21
+ /**
22
+ * Attributes to be used in the computation.
23
+ * @type {Array<AttributeItem>}
24
+ * @memberof AFM
25
+ */
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>;
45
+ }
46
+ /**
47
+ * A datetime filter specifying exact from and to values.
48
+ * @export
49
+ * @interface AbsoluteDateFilter
50
+ */
51
+ export interface AbsoluteDateFilter {
52
+ /**
53
+ *
54
+ * @type {AbsoluteDateFilterAbsoluteDateFilter}
55
+ * @memberof AbsoluteDateFilter
56
+ */
57
+ absoluteDateFilter: AbsoluteDateFilterAbsoluteDateFilter;
58
+ }
59
+ /**
60
+ *
61
+ * @export
62
+ * @interface AbsoluteDateFilterAbsoluteDateFilter
63
+ */
64
+ export interface AbsoluteDateFilterAbsoluteDateFilter {
65
+ /**
66
+ *
67
+ * @type {string}
68
+ * @memberof AbsoluteDateFilterAbsoluteDateFilter
69
+ */
70
+ from: string;
71
+ /**
72
+ *
73
+ * @type {string}
74
+ * @memberof AbsoluteDateFilterAbsoluteDateFilter
75
+ */
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;
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;
107
+ /**
108
+ *
109
+ * @export
110
+ * @interface AfmLocalIdentifier
111
+ */
112
+ export interface AfmLocalIdentifier {
113
+ /**
114
+ *
115
+ * @type {string}
116
+ * @memberof AfmLocalIdentifier
117
+ */
118
+ localIdentifier: string;
119
+ }
120
+ /**
121
+ * ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.
122
+ * @export
123
+ * @interface AfmObjectIdentifier
124
+ */
125
+ export interface AfmObjectIdentifier {
126
+ /**
127
+ *
128
+ * @type {AfmObjectIdentifierIdentifier}
129
+ * @memberof AfmObjectIdentifier
130
+ */
131
+ identifier: AfmObjectIdentifierIdentifier;
132
+ }
133
+ /**
134
+ * Reference to the date attribute to use.
135
+ * @export
136
+ * @interface AfmObjectIdentifierAttribute
137
+ */
138
+ export interface AfmObjectIdentifierAttribute {
139
+ /**
140
+ *
141
+ * @type {AfmObjectIdentifierAttributeIdentifier}
142
+ * @memberof AfmObjectIdentifierAttribute
143
+ */
144
+ identifier: AfmObjectIdentifierAttributeIdentifier;
145
+ }
146
+ /**
147
+ *
148
+ * @export
149
+ * @interface AfmObjectIdentifierAttributeIdentifier
150
+ */
151
+ export interface AfmObjectIdentifierAttributeIdentifier {
152
+ /**
153
+ *
154
+ * @type {string}
155
+ * @memberof AfmObjectIdentifierAttributeIdentifier
156
+ */
157
+ id: string;
158
+ /**
159
+ *
160
+ * @type {string}
161
+ * @memberof AfmObjectIdentifierAttributeIdentifier
162
+ */
163
+ type: AfmObjectIdentifierAttributeIdentifierTypeEnum;
164
+ }
165
+ export declare const AfmObjectIdentifierAttributeIdentifierTypeEnum: {
166
+ readonly ATTRIBUTE: "attribute";
167
+ };
168
+ export type AfmObjectIdentifierAttributeIdentifierTypeEnum = typeof AfmObjectIdentifierAttributeIdentifierTypeEnum[keyof typeof AfmObjectIdentifierAttributeIdentifierTypeEnum];
169
+ /**
170
+ * Reference to the metric, fact or attribute object to use for the metric.
171
+ * @export
172
+ * @interface AfmObjectIdentifierCore
173
+ */
174
+ export interface AfmObjectIdentifierCore {
175
+ /**
176
+ *
177
+ * @type {AfmObjectIdentifierCoreIdentifier}
178
+ * @memberof AfmObjectIdentifierCore
179
+ */
180
+ identifier: AfmObjectIdentifierCoreIdentifier;
181
+ }
182
+ /**
183
+ *
184
+ * @export
185
+ * @interface AfmObjectIdentifierCoreIdentifier
186
+ */
187
+ export interface AfmObjectIdentifierCoreIdentifier {
188
+ /**
189
+ *
190
+ * @type {string}
191
+ * @memberof AfmObjectIdentifierCoreIdentifier
192
+ */
193
+ id: string;
194
+ /**
195
+ *
196
+ * @type {string}
197
+ * @memberof AfmObjectIdentifierCoreIdentifier
198
+ */
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 {
214
+ /**
215
+ *
216
+ * @type {AfmObjectIdentifierDatasetIdentifier}
217
+ * @memberof AfmObjectIdentifierDataset
218
+ */
219
+ identifier: AfmObjectIdentifierDatasetIdentifier;
220
+ }
221
+ /**
222
+ *
223
+ * @export
224
+ * @interface AfmObjectIdentifierDatasetIdentifier
225
+ */
226
+ export interface AfmObjectIdentifierDatasetIdentifier {
227
+ /**
228
+ *
229
+ * @type {string}
230
+ * @memberof AfmObjectIdentifierDatasetIdentifier
231
+ */
232
+ id: string;
233
+ /**
234
+ *
235
+ * @type {string}
236
+ * @memberof AfmObjectIdentifierDatasetIdentifier
237
+ */
238
+ type: AfmObjectIdentifierDatasetIdentifierTypeEnum;
239
+ }
240
+ export declare const AfmObjectIdentifierDatasetIdentifierTypeEnum: {
241
+ readonly DATASET: "dataset";
242
+ };
243
+ export type AfmObjectIdentifierDatasetIdentifierTypeEnum = typeof AfmObjectIdentifierDatasetIdentifierTypeEnum[keyof typeof AfmObjectIdentifierDatasetIdentifierTypeEnum];
244
+ /**
245
+ *
246
+ * @export
247
+ * @interface AfmObjectIdentifierIdentifier
248
+ */
249
+ export interface AfmObjectIdentifierIdentifier {
250
+ /**
251
+ *
252
+ * @type {string}
253
+ * @memberof AfmObjectIdentifierIdentifier
254
+ */
255
+ type: AfmObjectIdentifierIdentifierTypeEnum;
256
+ /**
257
+ *
258
+ * @type {string}
259
+ * @memberof AfmObjectIdentifierIdentifier
260
+ */
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 {
282
+ /**
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
+ *
297
+ * @type {string}
298
+ * @memberof AfmObjectIdentifierLabelIdentifier
299
+ */
300
+ type: AfmObjectIdentifierLabelIdentifierTypeEnum;
301
+ /**
302
+ *
303
+ * @type {string}
304
+ * @memberof AfmObjectIdentifierLabelIdentifier
305
+ */
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 {
318
+ /**
319
+ *
320
+ * @type {ArithmeticMeasureDefinitionArithmeticMeasure}
321
+ * @memberof ArithmeticMeasureDefinition
322
+ */
323
+ arithmeticMeasure: ArithmeticMeasureDefinitionArithmeticMeasure;
324
+ }
325
+ /**
326
+ *
327
+ * @export
328
+ * @interface ArithmeticMeasureDefinitionArithmeticMeasure
329
+ */
330
+ export interface ArithmeticMeasureDefinitionArithmeticMeasure {
331
+ /**
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.
339
+ * @type {string}
340
+ * @memberof ArithmeticMeasureDefinitionArithmeticMeasure
341
+ */
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 {
364
+ /**
365
+ * Set of label values.
366
+ * @type {Array<string>}
367
+ * @memberof AttributeFilterElements
368
+ */
369
+ values: Array<string>;
370
+ }
371
+ /**
372
+ *
373
+ * @export
374
+ * @interface AttributeItem
375
+ */
376
+ export interface AttributeItem {
377
+ /**
378
+ * Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
379
+ * @type {string}
380
+ * @memberof AttributeItem
381
+ */
382
+ localIdentifier: string;
383
+ /**
384
+ *
385
+ * @type {AfmObjectIdentifierLabel}
386
+ * @memberof AttributeItem
387
+ */
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;
395
+ }
396
+ /**
397
+ * Filter the result by comparing specified metric to given constant value, using given comparison operator.
398
+ * @export
399
+ * @interface ComparisonMeasureValueFilter
400
+ */
401
+ export interface ComparisonMeasureValueFilter {
402
+ /**
403
+ *
404
+ * @type {ComparisonMeasureValueFilterComparisonMeasureValueFilter}
405
+ * @memberof ComparisonMeasureValueFilter
406
+ */
407
+ comparisonMeasureValueFilter: ComparisonMeasureValueFilterComparisonMeasureValueFilter;
408
+ }
409
+ /**
410
+ *
411
+ * @export
412
+ * @interface ComparisonMeasureValueFilterComparisonMeasureValueFilter
413
+ */
414
+ export interface ComparisonMeasureValueFilterComparisonMeasureValueFilter {
415
+ /**
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
+ *
429
+ * @type {string}
430
+ * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
431
+ */
432
+ operator: ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
433
+ /**
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];
15
467
  /**
16
468
  * Custom label object override.
17
469
  * @export
@@ -45,40 +497,197 @@ export interface CustomMetric {
45
497
  format: string;
46
498
  }
47
499
  /**
48
- * Custom cell value overrides (IDs will be replaced with specified values).
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.
49
650
  * @export
50
- * @interface CustomOverride
651
+ * @interface NegativeAttributeFilter
51
652
  */
52
- export interface CustomOverride {
53
- /**
54
- * Map of CustomLabels with keys used as placeholders in document.
55
- * @type {{ [key: string]: CustomLabel; }}
56
- * @memberof CustomOverride
57
- */
58
- labels?: {
59
- [key: string]: CustomLabel;
60
- };
653
+ export interface NegativeAttributeFilter {
61
654
  /**
62
- * Map of CustomMetrics with keys used as placeholders in document.
63
- * @type {{ [key: string]: CustomMetric; }}
64
- * @memberof CustomOverride
655
+ *
656
+ * @type {NegativeAttributeFilterNegativeAttributeFilter}
657
+ * @memberof NegativeAttributeFilter
65
658
  */
66
- metrics?: {
67
- [key: string]: CustomMetric;
68
- };
659
+ negativeAttributeFilter: NegativeAttributeFilterNegativeAttributeFilter;
69
660
  }
70
661
  /**
71
662
  *
72
663
  * @export
73
- * @interface ExportResponse
664
+ * @interface NegativeAttributeFilterNegativeAttributeFilter
74
665
  */
75
- export interface ExportResponse {
666
+ export interface NegativeAttributeFilterNegativeAttributeFilter {
667
+ /**
668
+ *
669
+ * @type {AttributeFilterElements}
670
+ * @memberof NegativeAttributeFilterNegativeAttributeFilter
671
+ */
672
+ notIn: AttributeFilterElements;
76
673
  /**
77
674
  *
78
675
  * @type {string}
79
- * @memberof ExportResponse
676
+ * @memberof NegativeAttributeFilterNegativeAttributeFilter
80
677
  */
81
- exportResult: string;
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;
82
691
  }
83
692
  /**
84
693
  * Custom CSS styles for the table. (PDF, HTML)
@@ -118,6 +727,396 @@ export interface PdfTableStyleProperty {
118
727
  */
119
728
  value: string;
120
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];
121
1120
  /**
122
1121
  * Additional settings.
123
1122
  * @export
@@ -147,20 +1146,75 @@ export interface Settings {
147
1146
  * @type {Array<PdfTableStyle>}
148
1147
  * @memberof Settings
149
1148
  */
150
- pdfTableStyle?: Array<PdfTableStyle>;
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;
151
1188
  /**
152
- * Top left header content. (PDF)
1189
+ * Definition of aggregation type of the metric.
153
1190
  * @type {string}
154
- * @memberof Settings
1191
+ * @memberof SimpleMeasureDefinitionMeasure
155
1192
  */
156
- pdfTopLeftContent?: string;
1193
+ aggregation?: SimpleMeasureDefinitionMeasureAggregationEnum;
157
1194
  /**
158
- * Top right header content. (PDF)
159
- * @type {string}
160
- * @memberof Settings
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
161
1198
  */
162
- pdfTopRightContent?: string;
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>;
163
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];
164
1218
  /**
165
1219
  * Export request object describing the export properties and overrides for tabular exports.
166
1220
  * @export
@@ -204,7 +1258,7 @@ export interface TabularExportRequest {
204
1258
  */
205
1259
  visualizationObject?: string;
206
1260
  /**
207
- * Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. (HTML/PDF only)
1261
+ * Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given.
208
1262
  * @type {Array<object>}
209
1263
  * @memberof TabularExportRequest
210
1264
  */
@@ -259,6 +1313,15 @@ export interface VisualExportRequest {
259
1313
  * @export
260
1314
  */
261
1315
  export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration) => {
1316
+ /**
1317
+ * 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.
1318
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1319
+ * @param {string} workspaceId
1320
+ * @param {string} dashboardId
1321
+ * @param {*} [options] Override http request option.
1322
+ * @throws {RequiredError}
1323
+ */
1324
+ createDashboardExportRequest: (workspaceId: string, dashboardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
262
1325
  /**
263
1326
  * 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
1327
  * @summary Create visual - pdf export request
@@ -268,6 +1331,15 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
268
1331
  * @throws {RequiredError}
269
1332
  */
270
1333
  createPdfExport: (workspaceId: string, visualExportRequest: VisualExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1334
+ /**
1335
+ * 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.
1336
+ * @summary (EXPERIMENTAL) Create raw export request
1337
+ * @param {string} workspaceId
1338
+ * @param {RawExportRequest} rawExportRequest
1339
+ * @param {*} [options] Override http request option.
1340
+ * @throws {RequiredError}
1341
+ */
1342
+ createRawExport: (workspaceId: string, rawExportRequest: RawExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
271
1343
  /**
272
1344
  * 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
1345
  * @summary Create tabular export request
@@ -295,6 +1367,15 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
295
1367
  * @throws {RequiredError}
296
1368
  */
297
1369
  getMetadata: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1370
+ /**
1371
+ * 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.
1372
+ * @summary (EXPERIMENTAL) Retrieve exported files
1373
+ * @param {string} workspaceId
1374
+ * @param {string} exportId
1375
+ * @param {*} [options] Override http request option.
1376
+ * @throws {RequiredError}
1377
+ */
1378
+ getRawExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
298
1379
  /**
299
1380
  * 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
1381
  * @summary Retrieve exported files
@@ -310,6 +1391,15 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
310
1391
  * @export
311
1392
  */
312
1393
  export declare const ActionsApiFp: (configuration?: Configuration) => {
1394
+ /**
1395
+ * 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.
1396
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1397
+ * @param {string} workspaceId
1398
+ * @param {string} dashboardId
1399
+ * @param {*} [options] Override http request option.
1400
+ * @throws {RequiredError}
1401
+ */
1402
+ createDashboardExportRequest(workspaceId: string, dashboardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
313
1403
  /**
314
1404
  * 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
1405
  * @summary Create visual - pdf export request
@@ -319,6 +1409,15 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
319
1409
  * @throws {RequiredError}
320
1410
  */
321
1411
  createPdfExport(workspaceId: string, visualExportRequest: VisualExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
1412
+ /**
1413
+ * 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.
1414
+ * @summary (EXPERIMENTAL) Create raw export request
1415
+ * @param {string} workspaceId
1416
+ * @param {RawExportRequest} rawExportRequest
1417
+ * @param {*} [options] Override http request option.
1418
+ * @throws {RequiredError}
1419
+ */
1420
+ createRawExport(workspaceId: string, rawExportRequest: RawExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
322
1421
  /**
323
1422
  * 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
1423
  * @summary Create tabular export request
@@ -346,6 +1445,15 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
346
1445
  * @throws {RequiredError}
347
1446
  */
348
1447
  getMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1448
+ /**
1449
+ * 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.
1450
+ * @summary (EXPERIMENTAL) Retrieve exported files
1451
+ * @param {string} workspaceId
1452
+ * @param {string} exportId
1453
+ * @param {*} [options] Override http request option.
1454
+ * @throws {RequiredError}
1455
+ */
1456
+ getRawExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
349
1457
  /**
350
1458
  * 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
1459
  * @summary Retrieve exported files
@@ -361,6 +1469,14 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
361
1469
  * @export
362
1470
  */
363
1471
  export declare const ActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1472
+ /**
1473
+ * 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.
1474
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1475
+ * @param {ActionsApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
1476
+ * @param {*} [options] Override http request option.
1477
+ * @throws {RequiredError}
1478
+ */
1479
+ createDashboardExportRequest(requestParameters: ActionsApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
364
1480
  /**
365
1481
  * 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
1482
  * @summary Create visual - pdf export request
@@ -369,6 +1485,14 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
369
1485
  * @throws {RequiredError}
370
1486
  */
371
1487
  createPdfExport(requestParameters: ActionsApiCreatePdfExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1488
+ /**
1489
+ * 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.
1490
+ * @summary (EXPERIMENTAL) Create raw export request
1491
+ * @param {ActionsApiCreateRawExportRequest} requestParameters Request parameters.
1492
+ * @param {*} [options] Override http request option.
1493
+ * @throws {RequiredError}
1494
+ */
1495
+ createRawExport(requestParameters: ActionsApiCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
372
1496
  /**
373
1497
  * 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
1498
  * @summary Create tabular export request
@@ -393,6 +1517,14 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
393
1517
  * @throws {RequiredError}
394
1518
  */
395
1519
  getMetadata(requestParameters: ActionsApiGetMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1520
+ /**
1521
+ * 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.
1522
+ * @summary (EXPERIMENTAL) Retrieve exported files
1523
+ * @param {ActionsApiGetRawExportRequest} requestParameters Request parameters.
1524
+ * @param {*} [options] Override http request option.
1525
+ * @throws {RequiredError}
1526
+ */
1527
+ getRawExport(requestParameters: ActionsApiGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
396
1528
  /**
397
1529
  * 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
1530
  * @summary Retrieve exported files
@@ -408,6 +1540,15 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
408
1540
  * @interface ActionsApi
409
1541
  */
410
1542
  export interface ActionsApiInterface {
1543
+ /**
1544
+ * 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.
1545
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1546
+ * @param {ActionsApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
1547
+ * @param {*} [options] Override http request option.
1548
+ * @throws {RequiredError}
1549
+ * @memberof ActionsApiInterface
1550
+ */
1551
+ createDashboardExportRequest(requestParameters: ActionsApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
411
1552
  /**
412
1553
  * 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
1554
  * @summary Create visual - pdf export request
@@ -417,6 +1558,15 @@ export interface ActionsApiInterface {
417
1558
  * @memberof ActionsApiInterface
418
1559
  */
419
1560
  createPdfExport(requestParameters: ActionsApiCreatePdfExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1561
+ /**
1562
+ * 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.
1563
+ * @summary (EXPERIMENTAL) Create raw export request
1564
+ * @param {ActionsApiCreateRawExportRequest} requestParameters Request parameters.
1565
+ * @param {*} [options] Override http request option.
1566
+ * @throws {RequiredError}
1567
+ * @memberof ActionsApiInterface
1568
+ */
1569
+ createRawExport(requestParameters: ActionsApiCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
420
1570
  /**
421
1571
  * 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
1572
  * @summary Create tabular export request
@@ -444,6 +1594,15 @@ export interface ActionsApiInterface {
444
1594
  * @memberof ActionsApiInterface
445
1595
  */
446
1596
  getMetadata(requestParameters: ActionsApiGetMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1597
+ /**
1598
+ * 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.
1599
+ * @summary (EXPERIMENTAL) Retrieve exported files
1600
+ * @param {ActionsApiGetRawExportRequest} requestParameters Request parameters.
1601
+ * @param {*} [options] Override http request option.
1602
+ * @throws {RequiredError}
1603
+ * @memberof ActionsApiInterface
1604
+ */
1605
+ getRawExport(requestParameters: ActionsApiGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
447
1606
  /**
448
1607
  * 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
1608
  * @summary Retrieve exported files
@@ -454,6 +1613,25 @@ export interface ActionsApiInterface {
454
1613
  */
455
1614
  getTabularExport(requestParameters: ActionsApiGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
456
1615
  }
1616
+ /**
1617
+ * Request parameters for createDashboardExportRequest operation in ActionsApi.
1618
+ * @export
1619
+ * @interface ActionsApiCreateDashboardExportRequestRequest
1620
+ */
1621
+ export interface ActionsApiCreateDashboardExportRequestRequest {
1622
+ /**
1623
+ *
1624
+ * @type {string}
1625
+ * @memberof ActionsApiCreateDashboardExportRequest
1626
+ */
1627
+ readonly workspaceId: string;
1628
+ /**
1629
+ *
1630
+ * @type {string}
1631
+ * @memberof ActionsApiCreateDashboardExportRequest
1632
+ */
1633
+ readonly dashboardId: string;
1634
+ }
457
1635
  /**
458
1636
  * Request parameters for createPdfExport operation in ActionsApi.
459
1637
  * @export
@@ -473,6 +1651,25 @@ export interface ActionsApiCreatePdfExportRequest {
473
1651
  */
474
1652
  readonly visualExportRequest: VisualExportRequest;
475
1653
  }
1654
+ /**
1655
+ * Request parameters for createRawExport operation in ActionsApi.
1656
+ * @export
1657
+ * @interface ActionsApiCreateRawExportRequest
1658
+ */
1659
+ export interface ActionsApiCreateRawExportRequest {
1660
+ /**
1661
+ *
1662
+ * @type {string}
1663
+ * @memberof ActionsApiCreateRawExport
1664
+ */
1665
+ readonly workspaceId: string;
1666
+ /**
1667
+ *
1668
+ * @type {RawExportRequest}
1669
+ * @memberof ActionsApiCreateRawExport
1670
+ */
1671
+ readonly rawExportRequest: RawExportRequest;
1672
+ }
476
1673
  /**
477
1674
  * Request parameters for createTabularExport operation in ActionsApi.
478
1675
  * @export
@@ -530,6 +1727,25 @@ export interface ActionsApiGetMetadataRequest {
530
1727
  */
531
1728
  readonly exportId: string;
532
1729
  }
1730
+ /**
1731
+ * Request parameters for getRawExport operation in ActionsApi.
1732
+ * @export
1733
+ * @interface ActionsApiGetRawExportRequest
1734
+ */
1735
+ export interface ActionsApiGetRawExportRequest {
1736
+ /**
1737
+ *
1738
+ * @type {string}
1739
+ * @memberof ActionsApiGetRawExport
1740
+ */
1741
+ readonly workspaceId: string;
1742
+ /**
1743
+ *
1744
+ * @type {string}
1745
+ * @memberof ActionsApiGetRawExport
1746
+ */
1747
+ readonly exportId: string;
1748
+ }
533
1749
  /**
534
1750
  * Request parameters for getTabularExport operation in ActionsApi.
535
1751
  * @export
@@ -556,6 +1772,15 @@ export interface ActionsApiGetTabularExportRequest {
556
1772
  * @extends {BaseAPI}
557
1773
  */
558
1774
  export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
1775
+ /**
1776
+ * 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.
1777
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
1778
+ * @param {ActionsApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
1779
+ * @param {*} [options] Override http request option.
1780
+ * @throws {RequiredError}
1781
+ * @memberof ActionsApi
1782
+ */
1783
+ createDashboardExportRequest(requestParameters: ActionsApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
559
1784
  /**
560
1785
  * 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
1786
  * @summary Create visual - pdf export request
@@ -565,6 +1790,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
565
1790
  * @memberof ActionsApi
566
1791
  */
567
1792
  createPdfExport(requestParameters: ActionsApiCreatePdfExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
1793
+ /**
1794
+ * 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.
1795
+ * @summary (EXPERIMENTAL) Create raw export request
1796
+ * @param {ActionsApiCreateRawExportRequest} requestParameters Request parameters.
1797
+ * @param {*} [options] Override http request option.
1798
+ * @throws {RequiredError}
1799
+ * @memberof ActionsApi
1800
+ */
1801
+ createRawExport(requestParameters: ActionsApiCreateRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
568
1802
  /**
569
1803
  * 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
1804
  * @summary Create tabular export request
@@ -592,6 +1826,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
592
1826
  * @memberof ActionsApi
593
1827
  */
594
1828
  getMetadata(requestParameters: ActionsApiGetMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1829
+ /**
1830
+ * 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.
1831
+ * @summary (EXPERIMENTAL) Retrieve exported files
1832
+ * @param {ActionsApiGetRawExportRequest} requestParameters Request parameters.
1833
+ * @param {*} [options] Override http request option.
1834
+ * @throws {RequiredError}
1835
+ * @memberof ActionsApi
1836
+ */
1837
+ getRawExport(requestParameters: ActionsApiGetRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
595
1838
  /**
596
1839
  * 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
1840
  * @summary Retrieve exported files
@@ -602,11 +1845,179 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
602
1845
  */
603
1846
  getTabularExport(requestParameters: ActionsApiGetTabularExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
604
1847
  }
1848
+ /**
1849
+ * RawExportApi - axios parameter creator
1850
+ * @export
1851
+ */
1852
+ export declare const RawExportApiAxiosParamCreator: (configuration?: Configuration) => {
1853
+ /**
1854
+ * 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.
1855
+ * @summary (EXPERIMENTAL) Create raw export request
1856
+ * @param {string} workspaceId
1857
+ * @param {RawExportRequest} rawExportRequest
1858
+ * @param {*} [options] Override http request option.
1859
+ * @throws {RequiredError}
1860
+ */
1861
+ createRawExport: (workspaceId: string, rawExportRequest: RawExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1862
+ /**
1863
+ * 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.
1864
+ * @summary (EXPERIMENTAL) Retrieve exported files
1865
+ * @param {string} workspaceId
1866
+ * @param {string} exportId
1867
+ * @param {*} [options] Override http request option.
1868
+ * @throws {RequiredError}
1869
+ */
1870
+ getRawExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1871
+ };
1872
+ /**
1873
+ * RawExportApi - functional programming interface
1874
+ * @export
1875
+ */
1876
+ export declare const RawExportApiFp: (configuration?: Configuration) => {
1877
+ /**
1878
+ * 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.
1879
+ * @summary (EXPERIMENTAL) Create raw export request
1880
+ * @param {string} workspaceId
1881
+ * @param {RawExportRequest} rawExportRequest
1882
+ * @param {*} [options] Override http request option.
1883
+ * @throws {RequiredError}
1884
+ */
1885
+ createRawExport(workspaceId: string, rawExportRequest: RawExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
1886
+ /**
1887
+ * 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.
1888
+ * @summary (EXPERIMENTAL) Retrieve exported files
1889
+ * @param {string} workspaceId
1890
+ * @param {string} exportId
1891
+ * @param {*} [options] Override http request option.
1892
+ * @throws {RequiredError}
1893
+ */
1894
+ getRawExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1895
+ };
1896
+ /**
1897
+ * RawExportApi - factory interface
1898
+ * @export
1899
+ */
1900
+ export declare const RawExportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1901
+ /**
1902
+ * 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.
1903
+ * @summary (EXPERIMENTAL) Create raw export request
1904
+ * @param {RawExportApiCreateRawExportRequest} requestParameters Request parameters.
1905
+ * @param {*} [options] Override http request option.
1906
+ * @throws {RequiredError}
1907
+ */
1908
+ createRawExport(requestParameters: RawExportApiCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1909
+ /**
1910
+ * 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.
1911
+ * @summary (EXPERIMENTAL) Retrieve exported files
1912
+ * @param {RawExportApiGetRawExportRequest} requestParameters Request parameters.
1913
+ * @param {*} [options] Override http request option.
1914
+ * @throws {RequiredError}
1915
+ */
1916
+ getRawExport(requestParameters: RawExportApiGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1917
+ };
1918
+ /**
1919
+ * RawExportApi - interface
1920
+ * @export
1921
+ * @interface RawExportApi
1922
+ */
1923
+ export interface RawExportApiInterface {
1924
+ /**
1925
+ * 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.
1926
+ * @summary (EXPERIMENTAL) Create raw export request
1927
+ * @param {RawExportApiCreateRawExportRequest} requestParameters Request parameters.
1928
+ * @param {*} [options] Override http request option.
1929
+ * @throws {RequiredError}
1930
+ * @memberof RawExportApiInterface
1931
+ */
1932
+ createRawExport(requestParameters: RawExportApiCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
1933
+ /**
1934
+ * 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.
1935
+ * @summary (EXPERIMENTAL) Retrieve exported files
1936
+ * @param {RawExportApiGetRawExportRequest} requestParameters Request parameters.
1937
+ * @param {*} [options] Override http request option.
1938
+ * @throws {RequiredError}
1939
+ * @memberof RawExportApiInterface
1940
+ */
1941
+ getRawExport(requestParameters: RawExportApiGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1942
+ }
1943
+ /**
1944
+ * Request parameters for createRawExport operation in RawExportApi.
1945
+ * @export
1946
+ * @interface RawExportApiCreateRawExportRequest
1947
+ */
1948
+ export interface RawExportApiCreateRawExportRequest {
1949
+ /**
1950
+ *
1951
+ * @type {string}
1952
+ * @memberof RawExportApiCreateRawExport
1953
+ */
1954
+ readonly workspaceId: string;
1955
+ /**
1956
+ *
1957
+ * @type {RawExportRequest}
1958
+ * @memberof RawExportApiCreateRawExport
1959
+ */
1960
+ readonly rawExportRequest: RawExportRequest;
1961
+ }
1962
+ /**
1963
+ * Request parameters for getRawExport operation in RawExportApi.
1964
+ * @export
1965
+ * @interface RawExportApiGetRawExportRequest
1966
+ */
1967
+ export interface RawExportApiGetRawExportRequest {
1968
+ /**
1969
+ *
1970
+ * @type {string}
1971
+ * @memberof RawExportApiGetRawExport
1972
+ */
1973
+ readonly workspaceId: string;
1974
+ /**
1975
+ *
1976
+ * @type {string}
1977
+ * @memberof RawExportApiGetRawExport
1978
+ */
1979
+ readonly exportId: string;
1980
+ }
1981
+ /**
1982
+ * RawExportApi - object-oriented interface
1983
+ * @export
1984
+ * @class RawExportApi
1985
+ * @extends {BaseAPI}
1986
+ */
1987
+ export declare class RawExportApi extends BaseAPI implements RawExportApiInterface {
1988
+ /**
1989
+ * 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.
1990
+ * @summary (EXPERIMENTAL) Create raw export request
1991
+ * @param {RawExportApiCreateRawExportRequest} requestParameters Request parameters.
1992
+ * @param {*} [options] Override http request option.
1993
+ * @throws {RequiredError}
1994
+ * @memberof RawExportApi
1995
+ */
1996
+ createRawExport(requestParameters: RawExportApiCreateRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
1997
+ /**
1998
+ * 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.
1999
+ * @summary (EXPERIMENTAL) Retrieve exported files
2000
+ * @param {RawExportApiGetRawExportRequest} requestParameters Request parameters.
2001
+ * @param {*} [options] Override http request option.
2002
+ * @throws {RequiredError}
2003
+ * @memberof RawExportApi
2004
+ */
2005
+ getRawExport(requestParameters: RawExportApiGetRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2006
+ }
605
2007
  /**
606
2008
  * TabularExportApi - axios parameter creator
607
2009
  * @export
608
2010
  */
609
2011
  export declare const TabularExportApiAxiosParamCreator: (configuration?: Configuration) => {
2012
+ /**
2013
+ * 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.
2014
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
2015
+ * @param {string} workspaceId
2016
+ * @param {string} dashboardId
2017
+ * @param {*} [options] Override http request option.
2018
+ * @throws {RequiredError}
2019
+ */
2020
+ createDashboardExportRequest: (workspaceId: string, dashboardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
610
2021
  /**
611
2022
  * 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
2023
  * @summary Create tabular export request
@@ -631,6 +2042,15 @@ export declare const TabularExportApiAxiosParamCreator: (configuration?: Configu
631
2042
  * @export
632
2043
  */
633
2044
  export declare const TabularExportApiFp: (configuration?: Configuration) => {
2045
+ /**
2046
+ * 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.
2047
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
2048
+ * @param {string} workspaceId
2049
+ * @param {string} dashboardId
2050
+ * @param {*} [options] Override http request option.
2051
+ * @throws {RequiredError}
2052
+ */
2053
+ createDashboardExportRequest(workspaceId: string, dashboardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
634
2054
  /**
635
2055
  * 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
2056
  * @summary Create tabular export request
@@ -655,6 +2075,14 @@ export declare const TabularExportApiFp: (configuration?: Configuration) => {
655
2075
  * @export
656
2076
  */
657
2077
  export declare const TabularExportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2078
+ /**
2079
+ * 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.
2080
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
2081
+ * @param {TabularExportApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
2082
+ * @param {*} [options] Override http request option.
2083
+ * @throws {RequiredError}
2084
+ */
2085
+ createDashboardExportRequest(requestParameters: TabularExportApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
658
2086
  /**
659
2087
  * 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
2088
  * @summary Create tabular export request
@@ -678,6 +2106,15 @@ export declare const TabularExportApiFactory: (configuration?: Configuration, ba
678
2106
  * @interface TabularExportApi
679
2107
  */
680
2108
  export interface TabularExportApiInterface {
2109
+ /**
2110
+ * 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.
2111
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
2112
+ * @param {TabularExportApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
2113
+ * @param {*} [options] Override http request option.
2114
+ * @throws {RequiredError}
2115
+ * @memberof TabularExportApiInterface
2116
+ */
2117
+ createDashboardExportRequest(requestParameters: TabularExportApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
681
2118
  /**
682
2119
  * 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
2120
  * @summary Create tabular export request
@@ -697,6 +2134,25 @@ export interface TabularExportApiInterface {
697
2134
  */
698
2135
  getTabularExport(requestParameters: TabularExportApiGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
699
2136
  }
2137
+ /**
2138
+ * Request parameters for createDashboardExportRequest operation in TabularExportApi.
2139
+ * @export
2140
+ * @interface TabularExportApiCreateDashboardExportRequestRequest
2141
+ */
2142
+ export interface TabularExportApiCreateDashboardExportRequestRequest {
2143
+ /**
2144
+ *
2145
+ * @type {string}
2146
+ * @memberof TabularExportApiCreateDashboardExportRequest
2147
+ */
2148
+ readonly workspaceId: string;
2149
+ /**
2150
+ *
2151
+ * @type {string}
2152
+ * @memberof TabularExportApiCreateDashboardExportRequest
2153
+ */
2154
+ readonly dashboardId: string;
2155
+ }
700
2156
  /**
701
2157
  * Request parameters for createTabularExport operation in TabularExportApi.
702
2158
  * @export
@@ -742,6 +2198,15 @@ export interface TabularExportApiGetTabularExportRequest {
742
2198
  * @extends {BaseAPI}
743
2199
  */
744
2200
  export declare class TabularExportApi extends BaseAPI implements TabularExportApiInterface {
2201
+ /**
2202
+ * 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.
2203
+ * @summary (EXPERIMENTAL) Create dashboard tabular export request
2204
+ * @param {TabularExportApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
2205
+ * @param {*} [options] Override http request option.
2206
+ * @throws {RequiredError}
2207
+ * @memberof TabularExportApi
2208
+ */
2209
+ createDashboardExportRequest(requestParameters: TabularExportApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
745
2210
  /**
746
2211
  * 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
2212
  * @summary Create tabular export request