@gooddata/api-client-tiger 10.42.0-alpha.3 → 10.42.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/esm/__version.d.ts +2 -1
  2. package/esm/__version.d.ts.map +1 -1
  3. package/esm/__version.js +2 -1
  4. package/esm/__version.js.map +1 -1
  5. package/esm/api-client-tiger.d.ts +658 -17668
  6. package/esm/generated/afm-rest-api/api.d.ts +41 -1883
  7. package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
  8. package/esm/generated/afm-rest-api/api.js +0 -18
  9. package/esm/generated/afm-rest-api/api.js.map +1 -1
  10. package/esm/generated/afm-rest-api/base.d.ts +11 -24
  11. package/esm/generated/afm-rest-api/base.d.ts.map +1 -1
  12. package/esm/generated/afm-rest-api/base.js +3 -19
  13. package/esm/generated/afm-rest-api/base.js.map +1 -1
  14. package/esm/generated/afm-rest-api/configuration.d.ts +5 -14
  15. package/esm/generated/afm-rest-api/configuration.d.ts.map +1 -1
  16. package/esm/generated/afm-rest-api/configuration.js +11 -15
  17. package/esm/generated/afm-rest-api/configuration.js.map +1 -1
  18. package/esm/generated/auth-json-api/api.d.ts +15 -230
  19. package/esm/generated/auth-json-api/api.d.ts.map +1 -1
  20. package/esm/generated/auth-json-api/api.js.map +1 -1
  21. package/esm/generated/auth-json-api/base.d.ts +11 -24
  22. package/esm/generated/auth-json-api/base.d.ts.map +1 -1
  23. package/esm/generated/auth-json-api/base.js +3 -19
  24. package/esm/generated/auth-json-api/base.js.map +1 -1
  25. package/esm/generated/auth-json-api/configuration.d.ts +5 -14
  26. package/esm/generated/auth-json-api/configuration.d.ts.map +1 -1
  27. package/esm/generated/auth-json-api/configuration.js +11 -15
  28. package/esm/generated/auth-json-api/configuration.js.map +1 -1
  29. package/esm/generated/automation-json-api/api.d.ts +33 -1837
  30. package/esm/generated/automation-json-api/api.d.ts.map +1 -1
  31. package/esm/generated/automation-json-api/api.js +2 -2
  32. package/esm/generated/automation-json-api/api.js.map +1 -1
  33. package/esm/generated/automation-json-api/base.d.ts +11 -24
  34. package/esm/generated/automation-json-api/base.d.ts.map +1 -1
  35. package/esm/generated/automation-json-api/base.js +3 -19
  36. package/esm/generated/automation-json-api/base.js.map +1 -1
  37. package/esm/generated/automation-json-api/configuration.d.ts +5 -14
  38. package/esm/generated/automation-json-api/configuration.d.ts.map +1 -1
  39. package/esm/generated/automation-json-api/configuration.js +11 -15
  40. package/esm/generated/automation-json-api/configuration.js.map +1 -1
  41. package/esm/generated/export-json-api/api.d.ts +35 -1046
  42. package/esm/generated/export-json-api/api.d.ts.map +1 -1
  43. package/esm/generated/export-json-api/api.js.map +1 -1
  44. package/esm/generated/export-json-api/base.d.ts +11 -24
  45. package/esm/generated/export-json-api/base.d.ts.map +1 -1
  46. package/esm/generated/export-json-api/base.js +3 -19
  47. package/esm/generated/export-json-api/base.js.map +1 -1
  48. package/esm/generated/export-json-api/configuration.d.ts +5 -14
  49. package/esm/generated/export-json-api/configuration.d.ts.map +1 -1
  50. package/esm/generated/export-json-api/configuration.js +11 -15
  51. package/esm/generated/export-json-api/configuration.js.map +1 -1
  52. package/esm/generated/metadata-json-api/api.d.ts +496 -12213
  53. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  54. package/esm/generated/metadata-json-api/api.js +92 -110
  55. package/esm/generated/metadata-json-api/api.js.map +1 -1
  56. package/esm/generated/metadata-json-api/base.d.ts +11 -24
  57. package/esm/generated/metadata-json-api/base.d.ts.map +1 -1
  58. package/esm/generated/metadata-json-api/base.js +3 -19
  59. package/esm/generated/metadata-json-api/base.js.map +1 -1
  60. package/esm/generated/metadata-json-api/configuration.d.ts +5 -14
  61. package/esm/generated/metadata-json-api/configuration.d.ts.map +1 -1
  62. package/esm/generated/metadata-json-api/configuration.js +11 -15
  63. package/esm/generated/metadata-json-api/configuration.js.map +1 -1
  64. package/esm/generated/metadata-json-api/openapi-spec.json +9762 -9762
  65. package/esm/generated/result-json-api/api.d.ts +12 -317
  66. package/esm/generated/result-json-api/api.d.ts.map +1 -1
  67. package/esm/generated/result-json-api/api.js +4 -4
  68. package/esm/generated/result-json-api/api.js.map +1 -1
  69. package/esm/generated/result-json-api/base.d.ts +11 -24
  70. package/esm/generated/result-json-api/base.d.ts.map +1 -1
  71. package/esm/generated/result-json-api/base.js +3 -19
  72. package/esm/generated/result-json-api/base.js.map +1 -1
  73. package/esm/generated/result-json-api/configuration.d.ts +5 -14
  74. package/esm/generated/result-json-api/configuration.d.ts.map +1 -1
  75. package/esm/generated/result-json-api/configuration.js +11 -15
  76. package/esm/generated/result-json-api/configuration.js.map +1 -1
  77. package/esm/generated/scan-json-api/api.d.ts +4 -369
  78. package/esm/generated/scan-json-api/api.d.ts.map +1 -1
  79. package/esm/generated/scan-json-api/api.js.map +1 -1
  80. package/esm/generated/scan-json-api/base.d.ts +11 -24
  81. package/esm/generated/scan-json-api/base.d.ts.map +1 -1
  82. package/esm/generated/scan-json-api/base.js +3 -19
  83. package/esm/generated/scan-json-api/base.js.map +1 -1
  84. package/esm/generated/scan-json-api/configuration.d.ts +5 -14
  85. package/esm/generated/scan-json-api/configuration.d.ts.map +1 -1
  86. package/esm/generated/scan-json-api/configuration.js +11 -15
  87. package/esm/generated/scan-json-api/configuration.js.map +1 -1
  88. package/esm/index.d.ts +4 -3
  89. package/esm/index.d.ts.map +1 -1
  90. package/esm/index.js +1 -1
  91. package/esm/index.js.map +1 -1
  92. package/package.json +5 -5
@@ -14,152 +14,64 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from "axios";
14
14
  import { RequestArgs, BaseAPI } from './base.js';
15
15
  /**
16
16
  * Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.
17
- * @export
18
- * @interface ExportAFM
19
17
  */
20
18
  export interface ExportAFM {
21
19
  /**
22
20
  * Attributes to be used in the computation.
23
- * @type {Array<ExportAttributeItem>}
24
- * @memberof ExportAFM
25
21
  */
26
22
  attributes: Array<ExportAttributeItem>;
27
23
  /**
28
24
  * Various filter types to filter the execution result.
29
- * @type {Array<ExportFilterDefinition>}
30
- * @memberof ExportAFM
31
25
  */
32
26
  filters: Array<ExportFilterDefinition>;
33
27
  /**
34
28
  * Metrics to be computed.
35
- * @type {Array<ExportMeasureItem>}
36
- * @memberof ExportAFM
37
29
  */
38
30
  measures: Array<ExportMeasureItem>;
39
31
  /**
40
32
  * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
41
- * @type {Array<ExportMeasureItem>}
42
- * @memberof ExportAFM
43
33
  */
44
34
  auxMeasures?: Array<ExportMeasureItem>;
45
35
  }
46
36
  /**
47
37
  * A datetime filter specifying exact from and to values.
48
- * @export
49
- * @interface ExportAbsoluteDateFilter
50
38
  */
51
39
  export interface ExportAbsoluteDateFilter {
52
- /**
53
- *
54
- * @type {ExportAbsoluteDateFilterAbsoluteDateFilter}
55
- * @memberof ExportAbsoluteDateFilter
56
- */
57
40
  absoluteDateFilter: ExportAbsoluteDateFilterAbsoluteDateFilter;
58
41
  }
59
- /**
60
- *
61
- * @export
62
- * @interface ExportAbsoluteDateFilterAbsoluteDateFilter
63
- */
64
42
  export interface ExportAbsoluteDateFilterAbsoluteDateFilter {
65
- /**
66
- *
67
- * @type {string}
68
- * @memberof ExportAbsoluteDateFilterAbsoluteDateFilter
69
- */
70
43
  from: string;
71
- /**
72
- *
73
- * @type {string}
74
- * @memberof ExportAbsoluteDateFilterAbsoluteDateFilter
75
- */
76
44
  to: string;
77
- /**
78
- *
79
- * @type {string}
80
- * @memberof ExportAbsoluteDateFilterAbsoluteDateFilter
81
- */
82
45
  localIdentifier?: string;
83
- /**
84
- *
85
- * @type {boolean}
86
- * @memberof ExportAbsoluteDateFilterAbsoluteDateFilter
87
- */
88
46
  applyOnResult?: boolean;
89
- /**
90
- *
91
- * @type {ExportAfmObjectIdentifierDataset}
92
- * @memberof ExportAbsoluteDateFilterAbsoluteDateFilter
93
- */
94
47
  dataset: ExportAfmObjectIdentifierDataset;
95
48
  }
96
49
  /**
97
50
  * @type ExportAbstractMeasureValueFilter
98
- * @export
99
51
  */
100
52
  export type ExportAbstractMeasureValueFilter = ExportComparisonMeasureValueFilter | ExportRangeMeasureValueFilter | ExportRankingFilter;
101
53
  /**
102
54
  * @type ExportAfmIdentifier
103
55
  * Reference to the attribute label to which the filter should be applied.
104
- * @export
105
56
  */
106
57
  export type ExportAfmIdentifier = ExportAfmLocalIdentifier | ExportAfmObjectIdentifier;
107
- /**
108
- *
109
- * @export
110
- * @interface ExportAfmLocalIdentifier
111
- */
112
58
  export interface ExportAfmLocalIdentifier {
113
- /**
114
- *
115
- * @type {string}
116
- * @memberof ExportAfmLocalIdentifier
117
- */
118
59
  localIdentifier: string;
119
60
  }
120
61
  /**
121
62
  * ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.
122
- * @export
123
- * @interface ExportAfmObjectIdentifier
124
63
  */
125
64
  export interface ExportAfmObjectIdentifier {
126
- /**
127
- *
128
- * @type {ExportAfmObjectIdentifierIdentifier}
129
- * @memberof ExportAfmObjectIdentifier
130
- */
131
65
  identifier: ExportAfmObjectIdentifierIdentifier;
132
66
  }
133
67
  /**
134
68
  * Reference to the date attribute to use.
135
- * @export
136
- * @interface ExportAfmObjectIdentifierAttribute
137
69
  */
138
70
  export interface ExportAfmObjectIdentifierAttribute {
139
- /**
140
- *
141
- * @type {ExportAfmObjectIdentifierAttributeIdentifier}
142
- * @memberof ExportAfmObjectIdentifierAttribute
143
- */
144
71
  identifier: ExportAfmObjectIdentifierAttributeIdentifier;
145
72
  }
146
- /**
147
- *
148
- * @export
149
- * @interface ExportAfmObjectIdentifierAttributeIdentifier
150
- */
151
73
  export interface ExportAfmObjectIdentifierAttributeIdentifier {
152
- /**
153
- *
154
- * @type {string}
155
- * @memberof ExportAfmObjectIdentifierAttributeIdentifier
156
- */
157
74
  id: string;
158
- /**
159
- *
160
- * @type {string}
161
- * @memberof ExportAfmObjectIdentifierAttributeIdentifier
162
- */
163
75
  type: ExportAfmObjectIdentifierAttributeIdentifierTypeEnum;
164
76
  }
165
77
  export declare const ExportAfmObjectIdentifierAttributeIdentifierTypeEnum: {
@@ -168,34 +80,12 @@ export declare const ExportAfmObjectIdentifierAttributeIdentifierTypeEnum: {
168
80
  export type ExportAfmObjectIdentifierAttributeIdentifierTypeEnum = (typeof ExportAfmObjectIdentifierAttributeIdentifierTypeEnum)[keyof typeof ExportAfmObjectIdentifierAttributeIdentifierTypeEnum];
169
81
  /**
170
82
  * Reference to the metric, fact or attribute object to use for the metric.
171
- * @export
172
- * @interface ExportAfmObjectIdentifierCore
173
83
  */
174
84
  export interface ExportAfmObjectIdentifierCore {
175
- /**
176
- *
177
- * @type {ExportAfmObjectIdentifierCoreIdentifier}
178
- * @memberof ExportAfmObjectIdentifierCore
179
- */
180
85
  identifier: ExportAfmObjectIdentifierCoreIdentifier;
181
86
  }
182
- /**
183
- *
184
- * @export
185
- * @interface ExportAfmObjectIdentifierCoreIdentifier
186
- */
187
87
  export interface ExportAfmObjectIdentifierCoreIdentifier {
188
- /**
189
- *
190
- * @type {string}
191
- * @memberof ExportAfmObjectIdentifierCoreIdentifier
192
- */
193
88
  id: string;
194
- /**
195
- *
196
- * @type {string}
197
- * @memberof ExportAfmObjectIdentifierCoreIdentifier
198
- */
199
89
  type: ExportAfmObjectIdentifierCoreIdentifierTypeEnum;
200
90
  }
201
91
  export declare const ExportAfmObjectIdentifierCoreIdentifierTypeEnum: {
@@ -207,57 +97,20 @@ export declare const ExportAfmObjectIdentifierCoreIdentifierTypeEnum: {
207
97
  export type ExportAfmObjectIdentifierCoreIdentifierTypeEnum = (typeof ExportAfmObjectIdentifierCoreIdentifierTypeEnum)[keyof typeof ExportAfmObjectIdentifierCoreIdentifierTypeEnum];
208
98
  /**
209
99
  * Reference to the date dataset to which the filter should be applied.
210
- * @export
211
- * @interface ExportAfmObjectIdentifierDataset
212
100
  */
213
101
  export interface ExportAfmObjectIdentifierDataset {
214
- /**
215
- *
216
- * @type {ExportAfmObjectIdentifierDatasetIdentifier}
217
- * @memberof ExportAfmObjectIdentifierDataset
218
- */
219
102
  identifier: ExportAfmObjectIdentifierDatasetIdentifier;
220
103
  }
221
- /**
222
- *
223
- * @export
224
- * @interface ExportAfmObjectIdentifierDatasetIdentifier
225
- */
226
104
  export interface ExportAfmObjectIdentifierDatasetIdentifier {
227
- /**
228
- *
229
- * @type {string}
230
- * @memberof ExportAfmObjectIdentifierDatasetIdentifier
231
- */
232
105
  id: string;
233
- /**
234
- *
235
- * @type {string}
236
- * @memberof ExportAfmObjectIdentifierDatasetIdentifier
237
- */
238
106
  type: ExportAfmObjectIdentifierDatasetIdentifierTypeEnum;
239
107
  }
240
108
  export declare const ExportAfmObjectIdentifierDatasetIdentifierTypeEnum: {
241
109
  readonly DATASET: "dataset";
242
110
  };
243
111
  export type ExportAfmObjectIdentifierDatasetIdentifierTypeEnum = (typeof ExportAfmObjectIdentifierDatasetIdentifierTypeEnum)[keyof typeof ExportAfmObjectIdentifierDatasetIdentifierTypeEnum];
244
- /**
245
- *
246
- * @export
247
- * @interface ExportAfmObjectIdentifierIdentifier
248
- */
249
112
  export interface ExportAfmObjectIdentifierIdentifier {
250
- /**
251
- *
252
- * @type {string}
253
- * @memberof ExportAfmObjectIdentifierIdentifier
254
- */
255
113
  type: ExportAfmObjectIdentifierIdentifierTypeEnum;
256
- /**
257
- *
258
- * @type {string}
259
- * @memberof ExportAfmObjectIdentifierIdentifier
260
- */
261
114
  id: string;
262
115
  }
263
116
  export declare const ExportAfmObjectIdentifierIdentifierTypeEnum: {
@@ -273,36 +126,11 @@ export declare const ExportAfmObjectIdentifierIdentifierTypeEnum: {
273
126
  readonly FILTER_CONTEXT: "filterContext";
274
127
  };
275
128
  export type ExportAfmObjectIdentifierIdentifierTypeEnum = (typeof ExportAfmObjectIdentifierIdentifierTypeEnum)[keyof typeof ExportAfmObjectIdentifierIdentifierTypeEnum];
276
- /**
277
- *
278
- * @export
279
- * @interface ExportAfmObjectIdentifierLabel
280
- */
281
129
  export interface ExportAfmObjectIdentifierLabel {
282
- /**
283
- *
284
- * @type {ExportAfmObjectIdentifierLabelIdentifier}
285
- * @memberof ExportAfmObjectIdentifierLabel
286
- */
287
130
  identifier: ExportAfmObjectIdentifierLabelIdentifier;
288
131
  }
289
- /**
290
- *
291
- * @export
292
- * @interface ExportAfmObjectIdentifierLabelIdentifier
293
- */
294
132
  export interface ExportAfmObjectIdentifierLabelIdentifier {
295
- /**
296
- *
297
- * @type {string}
298
- * @memberof ExportAfmObjectIdentifierLabelIdentifier
299
- */
300
133
  type: ExportAfmObjectIdentifierLabelIdentifierTypeEnum;
301
- /**
302
- *
303
- * @type {string}
304
- * @memberof ExportAfmObjectIdentifierLabelIdentifier
305
- */
306
134
  id: string;
307
135
  }
308
136
  export declare const ExportAfmObjectIdentifierLabelIdentifierTypeEnum: {
@@ -311,33 +139,17 @@ export declare const ExportAfmObjectIdentifierLabelIdentifierTypeEnum: {
311
139
  export type ExportAfmObjectIdentifierLabelIdentifierTypeEnum = (typeof ExportAfmObjectIdentifierLabelIdentifierTypeEnum)[keyof typeof ExportAfmObjectIdentifierLabelIdentifierTypeEnum];
312
140
  /**
313
141
  * Metric representing arithmetics between other metrics.
314
- * @export
315
- * @interface ExportArithmeticMeasureDefinition
316
142
  */
317
143
  export interface ExportArithmeticMeasureDefinition {
318
- /**
319
- *
320
- * @type {ExportArithmeticMeasureDefinitionArithmeticMeasure}
321
- * @memberof ExportArithmeticMeasureDefinition
322
- */
323
144
  arithmeticMeasure: ExportArithmeticMeasureDefinitionArithmeticMeasure;
324
145
  }
325
- /**
326
- *
327
- * @export
328
- * @interface ExportArithmeticMeasureDefinitionArithmeticMeasure
329
- */
330
146
  export interface ExportArithmeticMeasureDefinitionArithmeticMeasure {
331
147
  /**
332
148
  * List of metrics to apply arithmetic operation by chosen operator.
333
- * @type {Array<ExportAfmLocalIdentifier>}
334
- * @memberof ExportArithmeticMeasureDefinitionArithmeticMeasure
335
149
  */
336
150
  measureIdentifiers: Array<ExportAfmLocalIdentifier>;
337
151
  /**
338
152
  * Arithmetic operator describing operation between metrics.
339
- * @type {string}
340
- * @memberof ExportArithmeticMeasureDefinitionArithmeticMeasure
341
153
  */
342
154
  operator: ExportArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum;
343
155
  }
@@ -351,139 +163,67 @@ export declare const ExportArithmeticMeasureDefinitionArithmeticMeasureOperatorE
351
163
  export type ExportArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = (typeof ExportArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum)[keyof typeof ExportArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum];
352
164
  /**
353
165
  * @type ExportAttributeElements
354
- * @export
355
166
  */
356
167
  export type ExportAttributeElements = ExportAttributeElementsByRef | ExportAttributeElementsByValue;
357
- /**
358
- *
359
- * @export
360
- * @interface ExportAttributeElementsByRef
361
- */
362
168
  export interface ExportAttributeElementsByRef {
363
169
  /**
364
170
  * List of attribute elements by reference
365
- * @type {Array<string>}
366
- * @memberof ExportAttributeElementsByRef
367
171
  */
368
- uris: Array<string>;
172
+ uris: Array<string | null>;
369
173
  }
370
- /**
371
- *
372
- * @export
373
- * @interface ExportAttributeElementsByValue
374
- */
375
174
  export interface ExportAttributeElementsByValue {
376
175
  /**
377
176
  * List of attribute elements by value
378
- * @type {Array<string>}
379
- * @memberof ExportAttributeElementsByValue
380
177
  */
381
- values: Array<string>;
178
+ values: Array<string | null>;
382
179
  }
383
180
  /**
384
181
  * @type ExportAttributeFilter
385
182
  * Abstract filter definition type attributes
386
- * @export
387
183
  */
388
184
  export type ExportAttributeFilter = ExportNegativeAttributeFilter | ExportPositiveAttributeFilter;
389
- /**
390
- *
391
- * @export
392
- * @interface ExportAttributeFilterByDate
393
- */
394
185
  export interface ExportAttributeFilterByDate {
395
- /**
396
- *
397
- * @type {string}
398
- * @memberof ExportAttributeFilterByDate
399
- */
400
186
  filterLocalIdentifier: string;
401
- /**
402
- *
403
- * @type {boolean}
404
- * @memberof ExportAttributeFilterByDate
405
- */
406
187
  isCommonDate: boolean;
407
188
  }
408
189
  /**
409
190
  * Filter on specific set of label values.
410
- * @export
411
- * @interface ExportAttributeFilterElements
412
191
  */
413
192
  export interface ExportAttributeFilterElements {
414
193
  /**
415
194
  * Set of label values.
416
- * @type {Array<string>}
417
- * @memberof ExportAttributeFilterElements
418
195
  */
419
- values: Array<string>;
196
+ values: Array<string | null>;
420
197
  }
421
- /**
422
- *
423
- * @export
424
- * @interface ExportAttributeFilterParent
425
- */
426
198
  export interface ExportAttributeFilterParent {
427
- /**
428
- *
429
- * @type {string}
430
- * @memberof ExportAttributeFilterParent
431
- */
432
199
  filterLocalIdentifier: string;
433
- /**
434
- *
435
- * @type {ExportOver}
436
- * @memberof ExportAttributeFilterParent
437
- */
438
200
  over: ExportOver;
439
201
  }
440
- /**
441
- *
442
- * @export
443
- * @interface ExportAttributeItem
444
- */
445
202
  export interface ExportAttributeItem {
446
203
  /**
447
204
  * Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
448
- * @type {string}
449
- * @memberof ExportAttributeItem
450
205
  */
451
206
  localIdentifier: string;
452
- /**
453
- *
454
- * @type {ExportAfmObjectIdentifierLabel}
455
- * @memberof ExportAttributeItem
456
- */
457
207
  label: ExportAfmObjectIdentifierLabel;
458
208
  /**
459
209
  * Indicates whether to show all values of given attribute even if the data bound to those values is not available.
460
- * @type {boolean}
461
- * @memberof ExportAttributeItem
462
210
  */
463
211
  showAllValues?: boolean;
464
212
  }
465
213
  /**
466
214
  * Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.
467
- * @export
468
- * @interface ExportBoundedFilter
469
215
  */
470
216
  export interface ExportBoundedFilter {
471
217
  /**
472
218
  * Date granularity specifying particular date attribute in given dimension.
473
- * @type {string}
474
- * @memberof ExportBoundedFilter
475
219
  */
476
220
  granularity: ExportBoundedFilterGranularityEnum;
477
221
  /**
478
222
  * 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\'). If null, then start of the range is unbounded.
479
- * @type {number}
480
- * @memberof ExportBoundedFilter
481
223
  */
482
224
  from?: number | null;
483
225
  /**
484
226
  * 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, ...). If null, then end of the range is unbounded.
485
- * @type {number}
486
- * @memberof ExportBoundedFilter
487
227
  */
488
228
  to?: number | null;
489
229
  }
@@ -508,64 +248,23 @@ export declare const ExportBoundedFilterGranularityEnum: {
508
248
  export type ExportBoundedFilterGranularityEnum = (typeof ExportBoundedFilterGranularityEnum)[keyof typeof ExportBoundedFilterGranularityEnum];
509
249
  /**
510
250
  * Filter the result by comparing specified metric to given constant value, using given comparison operator.
511
- * @export
512
- * @interface ExportComparisonMeasureValueFilter
513
251
  */
514
252
  export interface ExportComparisonMeasureValueFilter {
515
- /**
516
- *
517
- * @type {ExportComparisonMeasureValueFilterComparisonMeasureValueFilter}
518
- * @memberof ExportComparisonMeasureValueFilter
519
- */
520
253
  comparisonMeasureValueFilter: ExportComparisonMeasureValueFilterComparisonMeasureValueFilter;
521
254
  }
522
- /**
523
- *
524
- * @export
525
- * @interface ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
526
- */
527
255
  export interface ExportComparisonMeasureValueFilterComparisonMeasureValueFilter {
528
256
  /**
529
257
  * References to the attributes to be used when filtering.
530
- * @type {Array<ExportAfmIdentifier>}
531
- * @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
532
258
  */
533
259
  dimensionality?: Array<ExportAfmIdentifier>;
534
260
  /**
535
261
  * A value that will be substituted for null values in the metric for the comparisons.
536
- * @type {number}
537
- * @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
538
262
  */
539
263
  treatNullValuesAs?: number;
540
- /**
541
- *
542
- * @type {string}
543
- * @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
544
- */
545
264
  operator: ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
546
- /**
547
- *
548
- * @type {number}
549
- * @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
550
- */
551
265
  value: number;
552
- /**
553
- *
554
- * @type {string}
555
- * @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
556
- */
557
266
  localIdentifier?: string;
558
- /**
559
- *
560
- * @type {boolean}
561
- * @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
562
- */
563
267
  applyOnResult?: boolean;
564
- /**
565
- *
566
- * @type {ExportAfmIdentifier}
567
- * @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
568
- */
569
268
  measure: ExportAfmIdentifier;
570
269
  }
571
270
  export declare const ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum: {
@@ -579,131 +278,55 @@ export declare const ExportComparisonMeasureValueFilterComparisonMeasureValueFil
579
278
  export type ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = (typeof ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum)[keyof typeof ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum];
580
279
  /**
581
280
  * Custom label object override.
582
- * @export
583
- * @interface ExportCustomLabel
584
281
  */
585
282
  export interface ExportCustomLabel {
586
283
  /**
587
284
  * Override value.
588
- * @type {string}
589
- * @memberof ExportCustomLabel
590
285
  */
591
286
  title: string;
592
287
  }
593
288
  /**
594
289
  * Custom metric object override.
595
- * @export
596
- * @interface ExportCustomMetric
597
290
  */
598
291
  export interface ExportCustomMetric {
599
292
  /**
600
293
  * Metric title override.
601
- * @type {string}
602
- * @memberof ExportCustomMetric
603
294
  */
604
295
  title: string;
605
296
  /**
606
297
  * Format override.
607
- * @type {string}
608
- * @memberof ExportCustomMetric
609
298
  */
610
299
  format: string;
611
300
  }
612
301
  /**
613
302
  * Custom cell value overrides (IDs will be replaced with specified values).
614
- * @export
615
- * @interface ExportCustomOverride
616
303
  */
617
304
  export interface ExportCustomOverride {
618
305
  /**
619
306
  * Map of CustomLabels with keys used as placeholders in document.
620
- * @type {{ [key: string]: ExportCustomLabel; }}
621
- * @memberof ExportCustomOverride
622
307
  */
623
308
  labels?: {
624
309
  [key: string]: ExportCustomLabel;
625
310
  };
626
311
  /**
627
312
  * Map of CustomMetrics with keys used as placeholders in document.
628
- * @type {{ [key: string]: ExportCustomMetric; }}
629
- * @memberof ExportCustomOverride
630
313
  */
631
314
  metrics?: {
632
315
  [key: string]: ExportCustomMetric;
633
316
  };
634
317
  }
635
- /**
636
- *
637
- * @export
638
- * @interface ExportDashboardAttributeFilter
639
- */
640
318
  export interface ExportDashboardAttributeFilter {
641
- /**
642
- *
643
- * @type {ExportDashboardAttributeFilterAttributeFilter}
644
- * @memberof ExportDashboardAttributeFilter
645
- */
646
319
  attributeFilter: ExportDashboardAttributeFilterAttributeFilter;
647
320
  }
648
- /**
649
- *
650
- * @export
651
- * @interface ExportDashboardAttributeFilterAttributeFilter
652
- */
653
321
  export interface ExportDashboardAttributeFilterAttributeFilter {
654
- /**
655
- *
656
- * @type {ExportIdentifierRef}
657
- * @memberof ExportDashboardAttributeFilterAttributeFilter
658
- */
659
322
  displayForm: ExportIdentifierRef;
660
- /**
661
- *
662
- * @type {boolean}
663
- * @memberof ExportDashboardAttributeFilterAttributeFilter
664
- */
665
323
  negativeSelection: boolean;
666
- /**
667
- *
668
- * @type {ExportAttributeElements}
669
- * @memberof ExportDashboardAttributeFilterAttributeFilter
670
- */
671
324
  attributeElements: ExportAttributeElements;
672
- /**
673
- *
674
- * @type {Array<ExportAttributeFilterParent>}
675
- * @memberof ExportDashboardAttributeFilterAttributeFilter
676
- */
677
325
  filterElementsBy?: Array<ExportAttributeFilterParent>;
678
- /**
679
- *
680
- * @type {Array<ExportAttributeFilterByDate>}
681
- * @memberof ExportDashboardAttributeFilterAttributeFilter
682
- */
683
326
  filterElementsByDate?: Array<ExportAttributeFilterByDate>;
684
- /**
685
- *
686
- * @type {Array<ExportIdentifierRef>}
687
- * @memberof ExportDashboardAttributeFilterAttributeFilter
688
- */
689
327
  validateElementsBy?: Array<ExportIdentifierRef>;
690
- /**
691
- *
692
- * @type {string}
693
- * @memberof ExportDashboardAttributeFilterAttributeFilter
694
- */
695
328
  title?: string;
696
- /**
697
- *
698
- * @type {string}
699
- * @memberof ExportDashboardAttributeFilterAttributeFilter
700
- */
701
329
  selectionMode?: ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum;
702
- /**
703
- *
704
- * @type {string}
705
- * @memberof ExportDashboardAttributeFilterAttributeFilter
706
- */
707
330
  localIdentifier?: string;
708
331
  }
709
332
  export declare const ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum: {
@@ -711,72 +334,17 @@ export declare const ExportDashboardAttributeFilterAttributeFilterSelectionModeE
711
334
  readonly MULTI: "multi";
712
335
  };
713
336
  export type ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum = (typeof ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum)[keyof typeof ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum];
714
- /**
715
- *
716
- * @export
717
- * @interface ExportDashboardDateFilter
718
- */
719
337
  export interface ExportDashboardDateFilter {
720
- /**
721
- *
722
- * @type {ExportDashboardDateFilterDateFilter}
723
- * @memberof ExportDashboardDateFilter
724
- */
725
338
  dateFilter: ExportDashboardDateFilterDateFilter;
726
339
  }
727
- /**
728
- *
729
- * @export
730
- * @interface ExportDashboardDateFilterDateFilter
731
- */
732
340
  export interface ExportDashboardDateFilterDateFilter {
733
- /**
734
- *
735
- * @type {string}
736
- * @memberof ExportDashboardDateFilterDateFilter
737
- */
738
341
  type: ExportDashboardDateFilterDateFilterTypeEnum;
739
- /**
740
- *
741
- * @type {string}
742
- * @memberof ExportDashboardDateFilterDateFilter
743
- */
744
342
  granularity: ExportDashboardDateFilterDateFilterGranularityEnum;
745
- /**
746
- *
747
- * @type {string | number}
748
- * @memberof ExportDashboardDateFilterDateFilter
749
- */
750
- from?: string | number;
751
- /**
752
- *
753
- * @type {string | number}
754
- * @memberof ExportDashboardDateFilterDateFilter
755
- */
756
- to?: string | number;
757
- /**
758
- *
759
- * @type {ExportIdentifierRef}
760
- * @memberof ExportDashboardDateFilterDateFilter
761
- */
343
+ from?: ExportDashboardDateFilterDateFilterFrom;
344
+ to?: ExportDashboardDateFilterDateFilterFrom;
762
345
  dataSet?: ExportIdentifierRef;
763
- /**
764
- *
765
- * @type {ExportIdentifierRef}
766
- * @memberof ExportDashboardDateFilterDateFilter
767
- */
768
346
  attribute?: ExportIdentifierRef;
769
- /**
770
- *
771
- * @type {ExportRelativeBoundedDateFilter}
772
- * @memberof ExportDashboardDateFilterDateFilter
773
- */
774
347
  boundedFilter?: ExportRelativeBoundedDateFilter;
775
- /**
776
- *
777
- * @type {string}
778
- * @memberof ExportDashboardDateFilterDateFilter
779
- */
780
348
  localIdentifier?: string;
781
349
  }
782
350
  export declare const ExportDashboardDateFilterDateFilterTypeEnum: {
@@ -810,65 +378,47 @@ export declare const ExportDashboardDateFilterDateFilterGranularityEnum: {
810
378
  readonly GDC_TIME_MINUTE_IN_HOUR: "GDC.time.minute_in_hour";
811
379
  };
812
380
  export type ExportDashboardDateFilterDateFilterGranularityEnum = (typeof ExportDashboardDateFilterDateFilterGranularityEnum)[keyof typeof ExportDashboardDateFilterDateFilterGranularityEnum];
381
+ /**
382
+ * @type ExportDashboardDateFilterDateFilterFrom
383
+ */
384
+ export type ExportDashboardDateFilterDateFilterFrom = number | string;
813
385
  /**
814
386
  * Additional settings.
815
- * @export
816
- * @interface ExportDashboardExportSettings
817
387
  */
818
388
  export interface ExportDashboardExportSettings {
819
389
  /**
820
390
  * If true, the export will contain the information about the exported date and dashboard filters.
821
- * @type {boolean}
822
- * @memberof ExportDashboardExportSettings
823
391
  */
824
392
  exportInfo?: boolean;
825
393
  /**
826
394
  * Merge equal headers in neighbouring cells. Used for [XLSX] format only.
827
- * @type {boolean}
828
- * @memberof ExportDashboardExportSettings
829
395
  */
830
396
  mergeHeaders?: boolean;
831
397
  }
832
398
  /**
833
399
  * @type ExportDashboardFilter
834
- * @export
835
400
  */
836
401
  export type ExportDashboardFilter = ExportDashboardAttributeFilter | ExportDashboardDateFilter;
837
402
  /**
838
403
  * Export request object describing the export properties for dashboard tabular exports.
839
- * @export
840
- * @interface ExportDashboardTabularExportRequest
841
404
  */
842
405
  export interface ExportDashboardTabularExportRequest {
843
406
  /**
844
407
  * Requested tabular export type.
845
- * @type {string}
846
- * @memberof ExportDashboardTabularExportRequest
847
408
  */
848
409
  format: ExportDashboardTabularExportRequestFormatEnum;
849
410
  /**
850
411
  * Filename of downloaded file without extension.
851
- * @type {string}
852
- * @memberof ExportDashboardTabularExportRequest
853
412
  */
854
413
  fileName: string;
855
414
  /**
856
415
  * List of filters that will be used instead of the default dashboard filters.
857
- * @type {Array<ExportDashboardFilter>}
858
- * @memberof ExportDashboardTabularExportRequest
859
416
  */
860
417
  dashboardFiltersOverride?: Array<ExportDashboardFilter>;
861
418
  /**
862
419
  * List of widget identifiers to be exported. Note that only one widget is currently supported.
863
- * @type {Array<string>}
864
- * @memberof ExportDashboardTabularExportRequest
865
420
  */
866
421
  widgetIds?: Array<string>;
867
- /**
868
- *
869
- * @type {ExportDashboardExportSettings}
870
- * @memberof ExportDashboardTabularExportRequest
871
- */
872
422
  settings?: ExportDashboardExportSettings;
873
423
  }
874
424
  export declare const ExportDashboardTabularExportRequestFormatEnum: {
@@ -878,96 +428,52 @@ export type ExportDashboardTabularExportRequestFormatEnum = (typeof ExportDashbo
878
428
  /**
879
429
  * @type ExportDateFilter
880
430
  * Abstract filter definition type for dates.
881
- * @export
882
431
  */
883
432
  export type ExportDateFilter = ExportAbsoluteDateFilter | ExportRelativeDateFilter;
884
- /**
885
- *
886
- * @export
887
- * @interface ExportDateValue
888
- */
889
433
  export interface ExportDateValue {
890
- /**
891
- *
892
- * @type {string}
893
- * @memberof ExportDateValue
894
- */
895
434
  value: string;
896
435
  }
897
436
  /**
898
437
  * Various settings affecting the process of AFM execution or its result
899
- * @export
900
- * @interface ExportExecutionSettings
901
438
  */
902
439
  export interface ExportExecutionSettings {
903
440
  /**
904
441
  * Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.
905
- * @type {number}
906
- * @memberof ExportExecutionSettings
907
442
  */
908
443
  dataSamplingPercentage?: number;
909
444
  /**
910
445
  * Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.
911
- * @type {string}
912
- * @memberof ExportExecutionSettings
913
446
  */
914
447
  timestamp?: string;
915
448
  }
916
- /**
917
- *
918
- * @export
919
- * @interface ExportExportResponse
920
- */
921
449
  export interface ExportExportResponse {
922
- /**
923
- *
924
- * @type {string}
925
- * @memberof ExportExportResponse
926
- */
927
450
  exportResult: string;
928
451
  }
929
452
  /**
930
453
  * @type ExportFilterDefinition
931
454
  * Abstract filter definition type
932
- * @export
933
455
  */
934
456
  export type ExportFilterDefinition = ExportAbsoluteDateFilter | ExportComparisonMeasureValueFilter | ExportInlineFilterDefinition | ExportNegativeAttributeFilter | ExportPositiveAttributeFilter | ExportRangeMeasureValueFilter | ExportRankingFilter | ExportRelativeDateFilter;
935
457
  /**
936
458
  * @type ExportFilterDefinitionForSimpleMeasure
937
459
  * Abstract filter definition type for simple metric.
938
- * @export
939
460
  */
940
461
  export type ExportFilterDefinitionForSimpleMeasure = ExportAttributeFilter | ExportDateFilter;
941
- /**
942
- *
943
- * @export
944
- * @interface ExportIdentifierRef
945
- */
462
+ export interface ExportGetSlidesExport202ResponseInner {
463
+ short?: number;
464
+ char?: string;
465
+ int?: number;
466
+ long?: number;
467
+ float?: number;
468
+ double?: number;
469
+ direct?: boolean;
470
+ readOnly?: boolean;
471
+ }
946
472
  export interface ExportIdentifierRef {
947
- /**
948
- *
949
- * @type {ExportIdentifierRefIdentifier}
950
- * @memberof ExportIdentifierRef
951
- */
952
473
  identifier?: ExportIdentifierRefIdentifier;
953
474
  }
954
- /**
955
- *
956
- * @export
957
- * @interface ExportIdentifierRefIdentifier
958
- */
959
475
  export interface ExportIdentifierRefIdentifier {
960
- /**
961
- *
962
- * @type {string}
963
- * @memberof ExportIdentifierRefIdentifier
964
- */
965
476
  id: string;
966
- /**
967
- *
968
- * @type {string}
969
- * @memberof ExportIdentifierRefIdentifier
970
- */
971
477
  type: ExportIdentifierRefIdentifierTypeEnum;
972
478
  }
973
479
  export declare const ExportIdentifierRefIdentifierTypeEnum: {
@@ -996,38 +502,26 @@ export declare const ExportIdentifierRefIdentifierTypeEnum: {
996
502
  export type ExportIdentifierRefIdentifierTypeEnum = (typeof ExportIdentifierRefIdentifierTypeEnum)[keyof typeof ExportIdentifierRefIdentifierTypeEnum];
997
503
  /**
998
504
  * Export request object describing the export properties and metadata for image exports.
999
- * @export
1000
- * @interface ExportImageExportRequest
1001
505
  */
1002
506
  export interface ExportImageExportRequest {
1003
507
  /**
1004
508
  * Requested resulting file type.
1005
- * @type {string}
1006
- * @memberof ExportImageExportRequest
1007
509
  */
1008
510
  format: ExportImageExportRequestFormatEnum;
1009
511
  /**
1010
512
  * File name to be used for retrieving the image document.
1011
- * @type {string}
1012
- * @memberof ExportImageExportRequest
1013
513
  */
1014
514
  fileName: string;
1015
515
  /**
1016
516
  * Dashboard identifier
1017
- * @type {string}
1018
- * @memberof ExportImageExportRequest
1019
517
  */
1020
518
  dashboardId: string;
1021
519
  /**
1022
520
  * List of widget identifiers to be exported. Note that only one widget is currently supported.
1023
- * @type {Array<string>}
1024
- * @memberof ExportImageExportRequest
1025
521
  */
1026
522
  widgetIds: Array<string>;
1027
523
  /**
1028
524
  * Metadata definition in free-form JSON format.
1029
- * @type {object}
1030
- * @memberof ExportImageExportRequest
1031
525
  */
1032
526
  metadata?: object | null;
1033
527
  }
@@ -1037,466 +531,173 @@ export declare const ExportImageExportRequestFormatEnum: {
1037
531
  export type ExportImageExportRequestFormatEnum = (typeof ExportImageExportRequestFormatEnum)[keyof typeof ExportImageExportRequestFormatEnum];
1038
532
  /**
1039
533
  * Filter in form of direct MAQL query.
1040
- * @export
1041
- * @interface ExportInlineFilterDefinition
1042
534
  */
1043
535
  export interface ExportInlineFilterDefinition {
1044
- /**
1045
- *
1046
- * @type {ExportInlineFilterDefinitionInline}
1047
- * @memberof ExportInlineFilterDefinition
1048
- */
1049
536
  inline: ExportInlineFilterDefinitionInline;
1050
- }
1051
- /**
1052
- *
1053
- * @export
1054
- * @interface ExportInlineFilterDefinitionInline
1055
- */
1056
- export interface ExportInlineFilterDefinitionInline {
1057
- /**
1058
- * MAQL query representing the filter.
1059
- * @type {string}
1060
- * @memberof ExportInlineFilterDefinitionInline
1061
- */
1062
- filter: string;
1063
- /**
1064
- *
1065
- * @type {string}
1066
- * @memberof ExportInlineFilterDefinitionInline
1067
- */
1068
- localIdentifier?: string;
1069
- /**
1070
- *
1071
- * @type {boolean}
1072
- * @memberof ExportInlineFilterDefinitionInline
1073
- */
1074
- applyOnResult?: boolean;
1075
- }
1076
- /**
1077
- * Metric defined by the raw MAQL query.
1078
- * @export
1079
- * @interface ExportInlineMeasureDefinition
1080
- */
1081
- export interface ExportInlineMeasureDefinition {
1082
- /**
1083
- *
1084
- * @type {ExportInlineMeasureDefinitionInline}
1085
- * @memberof ExportInlineMeasureDefinition
1086
- */
1087
- inline: ExportInlineMeasureDefinitionInline;
1088
- }
1089
- /**
1090
- *
1091
- * @export
1092
- * @interface ExportInlineMeasureDefinitionInline
1093
- */
1094
- export interface ExportInlineMeasureDefinitionInline {
1095
- /**
1096
- * MAQL query defining the metric.
1097
- * @type {string}
1098
- * @memberof ExportInlineMeasureDefinitionInline
1099
- */
1100
- maql: string;
1101
- }
1102
- /**
1103
- *
1104
- * @export
1105
- * @interface ExportInlineResponse202
1106
- */
1107
- export interface ExportInlineResponse202 {
1108
- /**
1109
- *
1110
- * @type {number}
1111
- * @memberof ExportInlineResponse202
1112
- */
1113
- short?: number;
1114
- /**
1115
- *
1116
- * @type {string}
1117
- * @memberof ExportInlineResponse202
1118
- */
1119
- char?: string;
1120
- /**
1121
- *
1122
- * @type {number}
1123
- * @memberof ExportInlineResponse202
1124
- */
1125
- int?: number;
1126
- /**
1127
- *
1128
- * @type {number}
1129
- * @memberof ExportInlineResponse202
1130
- */
1131
- long?: number;
1132
- /**
1133
- *
1134
- * @type {number}
1135
- * @memberof ExportInlineResponse202
1136
- */
1137
- float?: number;
1138
- /**
1139
- *
1140
- * @type {number}
1141
- * @memberof ExportInlineResponse202
1142
- */
1143
- double?: number;
537
+ }
538
+ export interface ExportInlineFilterDefinitionInline {
1144
539
  /**
1145
- *
1146
- * @type {boolean}
1147
- * @memberof ExportInlineResponse202
540
+ * MAQL query representing the filter.
1148
541
  */
1149
- direct?: boolean;
542
+ filter: string;
543
+ localIdentifier?: string;
544
+ applyOnResult?: boolean;
545
+ }
546
+ /**
547
+ * Metric defined by the raw MAQL query.
548
+ */
549
+ export interface ExportInlineMeasureDefinition {
550
+ inline: ExportInlineMeasureDefinitionInline;
551
+ }
552
+ export interface ExportInlineMeasureDefinitionInline {
1150
553
  /**
1151
- *
1152
- * @type {boolean}
1153
- * @memberof ExportInlineResponse202
554
+ * MAQL query defining the metric.
1154
555
  */
1155
- readOnly?: boolean;
556
+ maql: string;
1156
557
  }
1157
558
  /**
1158
559
  * @type ExportMeasureDefinition
1159
560
  * Abstract metric definition type
1160
- * @export
1161
561
  */
1162
562
  export type ExportMeasureDefinition = ExportArithmeticMeasureDefinition | ExportInlineMeasureDefinition | ExportPopMeasureDefinition | ExportSimpleMeasureDefinition;
1163
563
  /**
1164
564
  * Metric is a quantity that is calculated from the data.
1165
- * @export
1166
- * @interface ExportMeasureItem
1167
565
  */
1168
566
  export interface ExportMeasureItem {
1169
567
  /**
1170
568
  * Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
1171
- * @type {string}
1172
- * @memberof ExportMeasureItem
1173
569
  */
1174
570
  localIdentifier: string;
1175
- /**
1176
- *
1177
- * @type {ExportMeasureDefinition}
1178
- * @memberof ExportMeasureItem
1179
- */
1180
571
  definition: ExportMeasureDefinition;
1181
572
  }
1182
573
  /**
1183
574
  * @type ExportMeasureValueFilter
1184
575
  * Abstract filter definition type filtering by the value of the metric.
1185
- * @export
1186
576
  */
1187
577
  export type ExportMeasureValueFilter = ExportComparisonMeasureValueFilter | ExportRangeMeasureValueFilter;
1188
578
  /**
1189
579
  * Filter able to limit element values by label and related selected negated elements.
1190
- * @export
1191
- * @interface ExportNegativeAttributeFilter
1192
580
  */
1193
581
  export interface ExportNegativeAttributeFilter {
1194
- /**
1195
- *
1196
- * @type {ExportNegativeAttributeFilterNegativeAttributeFilter}
1197
- * @memberof ExportNegativeAttributeFilter
1198
- */
1199
582
  negativeAttributeFilter: ExportNegativeAttributeFilterNegativeAttributeFilter;
1200
583
  }
1201
- /**
1202
- *
1203
- * @export
1204
- * @interface ExportNegativeAttributeFilterNegativeAttributeFilter
1205
- */
1206
584
  export interface ExportNegativeAttributeFilterNegativeAttributeFilter {
1207
- /**
1208
- *
1209
- * @type {ExportAttributeFilterElements}
1210
- * @memberof ExportNegativeAttributeFilterNegativeAttributeFilter
1211
- */
1212
585
  notIn: ExportAttributeFilterElements;
1213
- /**
1214
- *
1215
- * @type {string}
1216
- * @memberof ExportNegativeAttributeFilterNegativeAttributeFilter
1217
- */
1218
586
  localIdentifier?: string;
1219
- /**
1220
- *
1221
- * @type {boolean}
1222
- * @memberof ExportNegativeAttributeFilterNegativeAttributeFilter
1223
- */
1224
587
  applyOnResult?: boolean;
1225
- /**
1226
- *
1227
- * @type {ExportAfmIdentifier}
1228
- * @memberof ExportNegativeAttributeFilterNegativeAttributeFilter
1229
- */
1230
588
  label: ExportAfmIdentifier;
1231
589
  }
1232
- /**
1233
- *
1234
- * @export
1235
- * @interface ExportOver
1236
- */
1237
590
  export interface ExportOver {
1238
- /**
1239
- *
1240
- * @type {Array<ExportIdentifierRef>}
1241
- * @memberof ExportOver
1242
- */
1243
591
  attributes: Array<ExportIdentifierRef>;
1244
592
  }
1245
593
  /**
1246
594
  * Custom CSS styles for the table. (PDF, HTML)
1247
- * @export
1248
- * @interface ExportPdfTableStyle
1249
595
  */
1250
596
  export interface ExportPdfTableStyle {
1251
597
  /**
1252
598
  * CSS selector where to apply given properties.
1253
- * @type {string}
1254
- * @memberof ExportPdfTableStyle
1255
599
  */
1256
600
  selector: string;
1257
601
  /**
1258
602
  * List of CSS properties.
1259
- * @type {Array<ExportPdfTableStyleProperty>}
1260
- * @memberof ExportPdfTableStyle
1261
603
  */
1262
604
  properties?: Array<ExportPdfTableStyleProperty>;
1263
605
  }
1264
606
  /**
1265
607
  * CSS property.
1266
- * @export
1267
- * @interface ExportPdfTableStyleProperty
1268
608
  */
1269
609
  export interface ExportPdfTableStyleProperty {
1270
610
  /**
1271
611
  * CSS property key.
1272
- * @type {string}
1273
- * @memberof ExportPdfTableStyleProperty
1274
612
  */
1275
613
  key: string;
1276
614
  /**
1277
615
  * CSS property value.
1278
- * @type {string}
1279
- * @memberof ExportPdfTableStyleProperty
1280
616
  */
1281
617
  value: string;
1282
618
  }
1283
619
  /**
1284
620
  * Combination of the date data set to use and how many periods ago to calculate the previous period for.
1285
- * @export
1286
- * @interface ExportPopDataset
1287
621
  */
1288
622
  export interface ExportPopDataset {
1289
- /**
1290
- *
1291
- * @type {ExportAfmObjectIdentifierDataset}
1292
- * @memberof ExportPopDataset
1293
- */
1294
623
  dataset: ExportAfmObjectIdentifierDataset;
1295
624
  /**
1296
625
  * Number of periods ago to calculate the previous period for.
1297
- * @type {number}
1298
- * @memberof ExportPopDataset
1299
626
  */
1300
627
  periodsAgo: number;
1301
628
  }
1302
629
  /**
1303
630
  * Previous period type of metric.
1304
- * @export
1305
- * @interface ExportPopDatasetMeasureDefinition
1306
631
  */
1307
632
  export interface ExportPopDatasetMeasureDefinition {
1308
- /**
1309
- *
1310
- * @type {ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure}
1311
- * @memberof ExportPopDatasetMeasureDefinition
1312
- */
1313
633
  previousPeriodMeasure: ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure;
1314
634
  }
1315
- /**
1316
- *
1317
- * @export
1318
- * @interface ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure
1319
- */
1320
635
  export interface ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure {
1321
- /**
1322
- *
1323
- * @type {ExportAfmLocalIdentifier}
1324
- * @memberof ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure
1325
- */
1326
636
  measureIdentifier: ExportAfmLocalIdentifier;
1327
637
  /**
1328
638
  * Specification of which date data sets to use for determining the period to calculate the previous period for.
1329
- * @type {Array<ExportPopDataset>}
1330
- * @memberof ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure
1331
639
  */
1332
640
  dateDatasets: Array<ExportPopDataset>;
1333
641
  }
1334
642
  /**
1335
643
  * Combination of the date attribute to use and how many periods ago to calculate the PoP for.
1336
- * @export
1337
- * @interface ExportPopDate
1338
644
  */
1339
645
  export interface ExportPopDate {
1340
- /**
1341
- *
1342
- * @type {ExportAfmObjectIdentifierAttribute}
1343
- * @memberof ExportPopDate
1344
- */
1345
646
  attribute: ExportAfmObjectIdentifierAttribute;
1346
647
  /**
1347
648
  * Number of periods ago to calculate the previous period for.
1348
- * @type {number}
1349
- * @memberof ExportPopDate
1350
649
  */
1351
650
  periodsAgo: number;
1352
651
  }
1353
652
  /**
1354
653
  * Period over period type of metric.
1355
- * @export
1356
- * @interface ExportPopDateMeasureDefinition
1357
654
  */
1358
655
  export interface ExportPopDateMeasureDefinition {
1359
- /**
1360
- *
1361
- * @type {ExportPopDateMeasureDefinitionOverPeriodMeasure}
1362
- * @memberof ExportPopDateMeasureDefinition
1363
- */
1364
656
  overPeriodMeasure: ExportPopDateMeasureDefinitionOverPeriodMeasure;
1365
657
  }
1366
- /**
1367
- *
1368
- * @export
1369
- * @interface ExportPopDateMeasureDefinitionOverPeriodMeasure
1370
- */
1371
658
  export interface ExportPopDateMeasureDefinitionOverPeriodMeasure {
1372
- /**
1373
- *
1374
- * @type {ExportAfmLocalIdentifier}
1375
- * @memberof ExportPopDateMeasureDefinitionOverPeriodMeasure
1376
- */
1377
659
  measureIdentifier: ExportAfmLocalIdentifier;
1378
660
  /**
1379
661
  * Attributes to use for determining the period to calculate the PoP for.
1380
- * @type {Array<ExportPopDate>}
1381
- * @memberof ExportPopDateMeasureDefinitionOverPeriodMeasure
1382
662
  */
1383
663
  dateAttributes: Array<ExportPopDate>;
1384
664
  }
1385
665
  /**
1386
666
  * @type ExportPopMeasureDefinition
1387
- * @export
1388
667
  */
1389
668
  export type ExportPopMeasureDefinition = ExportPopDatasetMeasureDefinition | ExportPopDateMeasureDefinition;
1390
669
  /**
1391
670
  * Filter able to limit element values by label and related selected elements.
1392
- * @export
1393
- * @interface ExportPositiveAttributeFilter
1394
671
  */
1395
672
  export interface ExportPositiveAttributeFilter {
1396
- /**
1397
- *
1398
- * @type {ExportPositiveAttributeFilterPositiveAttributeFilter}
1399
- * @memberof ExportPositiveAttributeFilter
1400
- */
1401
673
  positiveAttributeFilter: ExportPositiveAttributeFilterPositiveAttributeFilter;
1402
674
  }
1403
- /**
1404
- *
1405
- * @export
1406
- * @interface ExportPositiveAttributeFilterPositiveAttributeFilter
1407
- */
1408
675
  export interface ExportPositiveAttributeFilterPositiveAttributeFilter {
1409
- /**
1410
- *
1411
- * @type {ExportAttributeFilterElements}
1412
- * @memberof ExportPositiveAttributeFilterPositiveAttributeFilter
1413
- */
1414
676
  in: ExportAttributeFilterElements;
1415
- /**
1416
- *
1417
- * @type {string}
1418
- * @memberof ExportPositiveAttributeFilterPositiveAttributeFilter
1419
- */
1420
677
  localIdentifier?: string;
1421
- /**
1422
- *
1423
- * @type {boolean}
1424
- * @memberof ExportPositiveAttributeFilterPositiveAttributeFilter
1425
- */
1426
678
  applyOnResult?: boolean;
1427
- /**
1428
- *
1429
- * @type {ExportAfmIdentifier}
1430
- * @memberof ExportPositiveAttributeFilterPositiveAttributeFilter
1431
- */
1432
679
  label: ExportAfmIdentifier;
1433
680
  }
1434
681
  /**
1435
682
  * Filter the result by comparing specified metric to given range of values.
1436
- * @export
1437
- * @interface ExportRangeMeasureValueFilter
1438
683
  */
1439
684
  export interface ExportRangeMeasureValueFilter {
1440
- /**
1441
- *
1442
- * @type {ExportRangeMeasureValueFilterRangeMeasureValueFilter}
1443
- * @memberof ExportRangeMeasureValueFilter
1444
- */
1445
685
  rangeMeasureValueFilter: ExportRangeMeasureValueFilterRangeMeasureValueFilter;
1446
686
  }
1447
- /**
1448
- *
1449
- * @export
1450
- * @interface ExportRangeMeasureValueFilterRangeMeasureValueFilter
1451
- */
1452
687
  export interface ExportRangeMeasureValueFilterRangeMeasureValueFilter {
1453
688
  /**
1454
689
  * References to the attributes to be used when filtering.
1455
- * @type {Array<ExportAfmIdentifier>}
1456
- * @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
1457
690
  */
1458
691
  dimensionality?: Array<ExportAfmIdentifier>;
1459
692
  /**
1460
693
  * A value that will be substituted for null values in the metric for the comparisons.
1461
- * @type {number}
1462
- * @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
1463
694
  */
1464
695
  treatNullValuesAs?: number;
1465
- /**
1466
- *
1467
- * @type {string}
1468
- * @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
1469
- */
1470
696
  operator: ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
1471
- /**
1472
- *
1473
- * @type {number}
1474
- * @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
1475
- */
1476
697
  from: number;
1477
- /**
1478
- *
1479
- * @type {number}
1480
- * @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
1481
- */
1482
698
  to: number;
1483
- /**
1484
- *
1485
- * @type {string}
1486
- * @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
1487
- */
1488
699
  localIdentifier?: string;
1489
- /**
1490
- *
1491
- * @type {boolean}
1492
- * @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
1493
- */
1494
700
  applyOnResult?: boolean;
1495
- /**
1496
- *
1497
- * @type {ExportAfmIdentifier}
1498
- * @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
1499
- */
1500
701
  measure: ExportAfmIdentifier;
1501
702
  }
1502
703
  export declare const ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum: {
@@ -1506,58 +707,28 @@ export declare const ExportRangeMeasureValueFilterRangeMeasureValueFilterOperato
1506
707
  export type ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = (typeof ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum)[keyof typeof ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum];
1507
708
  /**
1508
709
  * Filter the result on top/bottom N values according to given metric(s).
1509
- * @export
1510
- * @interface ExportRankingFilter
1511
710
  */
1512
711
  export interface ExportRankingFilter {
1513
- /**
1514
- *
1515
- * @type {ExportRankingFilterRankingFilter}
1516
- * @memberof ExportRankingFilter
1517
- */
1518
712
  rankingFilter: ExportRankingFilterRankingFilter;
1519
713
  }
1520
- /**
1521
- *
1522
- * @export
1523
- * @interface ExportRankingFilterRankingFilter
1524
- */
1525
714
  export interface ExportRankingFilterRankingFilter {
1526
715
  /**
1527
716
  * References to the attributes to be used when filtering.
1528
- * @type {Array<ExportAfmIdentifier>}
1529
- * @memberof ExportRankingFilterRankingFilter
1530
717
  */
1531
718
  dimensionality?: Array<ExportAfmIdentifier>;
1532
719
  /**
1533
720
  * References to the metrics to be used when filtering.
1534
- * @type {Array<ExportAfmIdentifier>}
1535
- * @memberof ExportRankingFilterRankingFilter
1536
721
  */
1537
722
  measures: Array<ExportAfmIdentifier>;
1538
723
  /**
1539
724
  * The type of ranking to use, TOP or BOTTOM.
1540
- * @type {string}
1541
- * @memberof ExportRankingFilterRankingFilter
1542
725
  */
1543
726
  operator: ExportRankingFilterRankingFilterOperatorEnum;
1544
727
  /**
1545
728
  * Number of top/bottom values to filter.
1546
- * @type {number}
1547
- * @memberof ExportRankingFilterRankingFilter
1548
729
  */
1549
730
  value: number;
1550
- /**
1551
- *
1552
- * @type {string}
1553
- * @memberof ExportRankingFilterRankingFilter
1554
- */
1555
731
  localIdentifier?: string;
1556
- /**
1557
- *
1558
- * @type {boolean}
1559
- * @memberof ExportRankingFilterRankingFilter
1560
- */
1561
732
  applyOnResult?: boolean;
1562
733
  }
1563
734
  export declare const ExportRankingFilterRankingFilterOperatorEnum: {
@@ -1567,48 +738,34 @@ export declare const ExportRankingFilterRankingFilterOperatorEnum: {
1567
738
  export type ExportRankingFilterRankingFilterOperatorEnum = (typeof ExportRankingFilterRankingFilterOperatorEnum)[keyof typeof ExportRankingFilterRankingFilterOperatorEnum];
1568
739
  /**
1569
740
  * Custom label object override.
1570
- * @export
1571
- * @interface ExportRawCustomLabel
1572
741
  */
1573
742
  export interface ExportRawCustomLabel {
1574
743
  /**
1575
744
  * Override value.
1576
- * @type {string}
1577
- * @memberof ExportRawCustomLabel
1578
745
  */
1579
746
  title: string;
1580
747
  }
1581
748
  /**
1582
749
  * Custom metric object override.
1583
- * @export
1584
- * @interface ExportRawCustomMetric
1585
750
  */
1586
751
  export interface ExportRawCustomMetric {
1587
752
  /**
1588
753
  * Metric title override.
1589
- * @type {string}
1590
- * @memberof ExportRawCustomMetric
1591
754
  */
1592
755
  title: string;
1593
756
  }
1594
757
  /**
1595
758
  * Custom cell value overrides (IDs will be replaced with specified values).
1596
- * @export
1597
- * @interface ExportRawCustomOverride
1598
759
  */
1599
760
  export interface ExportRawCustomOverride {
1600
761
  /**
1601
762
  * Map of CustomLabels with keys used as placeholders in export result.
1602
- * @type {{ [key: string]: ExportRawCustomLabel; }}
1603
- * @memberof ExportRawCustomOverride
1604
763
  */
1605
764
  labels?: {
1606
765
  [key: string]: ExportRawCustomLabel;
1607
766
  };
1608
767
  /**
1609
768
  * Map of CustomMetrics with keys used as placeholders in export result.
1610
- * @type {{ [key: string]: ExportRawCustomMetric; }}
1611
- * @memberof ExportRawCustomOverride
1612
769
  */
1613
770
  metrics?: {
1614
771
  [key: string]: ExportRawCustomMetric;
@@ -1616,39 +773,18 @@ export interface ExportRawCustomOverride {
1616
773
  }
1617
774
  /**
1618
775
  * Export request object describing the export properties and overrides for raw exports.
1619
- * @export
1620
- * @interface ExportRawExportRequest
1621
776
  */
1622
777
  export interface ExportRawExportRequest {
1623
778
  /**
1624
779
  * Requested resulting file type.
1625
- * @type {string}
1626
- * @memberof ExportRawExportRequest
1627
780
  */
1628
781
  format: ExportRawExportRequestFormatEnum;
1629
- /**
1630
- *
1631
- * @type {ExportAFM}
1632
- * @memberof ExportRawExportRequest
1633
- */
1634
782
  execution: ExportAFM;
1635
783
  /**
1636
784
  * Filename of downloaded file without extension.
1637
- * @type {string}
1638
- * @memberof ExportRawExportRequest
1639
785
  */
1640
786
  fileName: string;
1641
- /**
1642
- *
1643
- * @type {ExportRawCustomOverride}
1644
- * @memberof ExportRawExportRequest
1645
- */
1646
787
  customOverride?: ExportRawCustomOverride;
1647
- /**
1648
- *
1649
- * @type {ExportExecutionSettings}
1650
- * @memberof ExportRawExportRequest
1651
- */
1652
788
  executionSettings?: ExportExecutionSettings;
1653
789
  }
1654
790
  export declare const ExportRawExportRequestFormatEnum: {
@@ -1657,29 +793,9 @@ export declare const ExportRawExportRequestFormatEnum: {
1657
793
  readonly CSV: "CSV";
1658
794
  };
1659
795
  export type ExportRawExportRequestFormatEnum = (typeof ExportRawExportRequestFormatEnum)[keyof typeof ExportRawExportRequestFormatEnum];
1660
- /**
1661
- *
1662
- * @export
1663
- * @interface ExportRelativeBoundedDateFilter
1664
- */
1665
796
  export interface ExportRelativeBoundedDateFilter {
1666
- /**
1667
- *
1668
- * @type {string}
1669
- * @memberof ExportRelativeBoundedDateFilter
1670
- */
1671
797
  granularity: ExportRelativeBoundedDateFilterGranularityEnum;
1672
- /**
1673
- *
1674
- * @type {number}
1675
- * @memberof ExportRelativeBoundedDateFilter
1676
- */
1677
798
  from?: number;
1678
- /**
1679
- *
1680
- * @type {number}
1681
- * @memberof ExportRelativeBoundedDateFilter
1682
- */
1683
799
  to?: number;
1684
800
  }
1685
801
  export declare const ExportRelativeBoundedDateFilterGranularityEnum: {
@@ -1710,64 +826,26 @@ export declare const ExportRelativeBoundedDateFilterGranularityEnum: {
1710
826
  export type ExportRelativeBoundedDateFilterGranularityEnum = (typeof ExportRelativeBoundedDateFilterGranularityEnum)[keyof typeof ExportRelativeBoundedDateFilterGranularityEnum];
1711
827
  /**
1712
828
  * 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. The \'from\' and \'to\' properties mark the boundaries of the interval. If \'from\' is omitted, all values earlier than \'to\' are included. If \'to\' is omitted, all values later than \'from\' are included. It is not allowed to omit both.
1713
- * @export
1714
- * @interface ExportRelativeDateFilter
1715
829
  */
1716
830
  export interface ExportRelativeDateFilter {
1717
- /**
1718
- *
1719
- * @type {ExportRelativeDateFilterRelativeDateFilter}
1720
- * @memberof ExportRelativeDateFilter
1721
- */
1722
831
  relativeDateFilter: ExportRelativeDateFilterRelativeDateFilter;
1723
832
  }
1724
- /**
1725
- *
1726
- * @export
1727
- * @interface ExportRelativeDateFilterRelativeDateFilter
1728
- */
1729
833
  export interface ExportRelativeDateFilterRelativeDateFilter {
1730
834
  /**
1731
835
  * Date granularity specifying particular date attribute in given dimension.
1732
- * @type {string}
1733
- * @memberof ExportRelativeDateFilterRelativeDateFilter
1734
836
  */
1735
837
  granularity: ExportRelativeDateFilterRelativeDateFilterGranularityEnum;
1736
838
  /**
1737
839
  * 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\').
1738
- * @type {number}
1739
- * @memberof ExportRelativeDateFilterRelativeDateFilter
1740
840
  */
1741
841
  from: number;
1742
842
  /**
1743
843
  * 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, ...).
1744
- * @type {number}
1745
- * @memberof ExportRelativeDateFilterRelativeDateFilter
1746
844
  */
1747
845
  to: number;
1748
- /**
1749
- *
1750
- * @type {string}
1751
- * @memberof ExportRelativeDateFilterRelativeDateFilter
1752
- */
1753
846
  localIdentifier?: string;
1754
- /**
1755
- *
1756
- * @type {boolean}
1757
- * @memberof ExportRelativeDateFilterRelativeDateFilter
1758
- */
1759
847
  applyOnResult?: boolean;
1760
- /**
1761
- *
1762
- * @type {ExportBoundedFilter}
1763
- * @memberof ExportRelativeDateFilterRelativeDateFilter
1764
- */
1765
848
  boundedFilter?: ExportBoundedFilter;
1766
- /**
1767
- *
1768
- * @type {ExportAfmObjectIdentifierDataset}
1769
- * @memberof ExportRelativeDateFilterRelativeDateFilter
1770
- */
1771
849
  dataset: ExportAfmObjectIdentifierDataset;
1772
850
  }
1773
851
  export declare const ExportRelativeDateFilterRelativeDateFilterGranularityEnum: {
@@ -1791,94 +869,55 @@ export declare const ExportRelativeDateFilterRelativeDateFilterGranularityEnum:
1791
869
  export type ExportRelativeDateFilterRelativeDateFilterGranularityEnum = (typeof ExportRelativeDateFilterRelativeDateFilterGranularityEnum)[keyof typeof ExportRelativeDateFilterRelativeDateFilterGranularityEnum];
1792
870
  /**
1793
871
  * Additional settings.
1794
- * @export
1795
- * @interface ExportSettings
1796
872
  */
1797
873
  export interface ExportSettings {
1798
874
  /**
1799
875
  * Include export info sheet in the exported file. Works only with `visualizationObject`. (XLSX)
1800
- * @type {boolean}
1801
- * @memberof ExportSettings
1802
876
  */
1803
877
  exportInfo?: boolean;
1804
878
  /**
1805
879
  * Merge equal headers in neighbouring cells. (XLSX)
1806
- * @type {boolean}
1807
- * @memberof ExportSettings
1808
880
  */
1809
881
  mergeHeaders?: boolean;
1810
882
  /**
1811
883
  * Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)
1812
- * @type {boolean}
1813
- * @memberof ExportSettings
1814
884
  */
1815
885
  showFilters?: boolean;
1816
886
  /**
1817
887
  * Page size and orientation. (PDF)
1818
- * @type {string}
1819
- * @memberof ExportSettings
1820
888
  */
1821
889
  pdfPageSize?: string;
1822
890
  /**
1823
891
  * Custom CSS styles for the table. (PDF, HTML)
1824
- * @type {Array<ExportPdfTableStyle>}
1825
- * @memberof ExportSettings
1826
892
  */
1827
893
  pdfTableStyle?: Array<ExportPdfTableStyle>;
1828
894
  /**
1829
895
  * Top left header content. (PDF)
1830
- * @type {string}
1831
- * @memberof ExportSettings
1832
896
  */
1833
897
  pdfTopLeftContent?: string;
1834
898
  /**
1835
899
  * Top right header content. (PDF)
1836
- * @type {string}
1837
- * @memberof ExportSettings
1838
900
  */
1839
901
  pdfTopRightContent?: string;
1840
902
  }
1841
903
  /**
1842
904
  * Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
1843
- * @export
1844
- * @interface ExportSimpleMeasureDefinition
1845
905
  */
1846
906
  export interface ExportSimpleMeasureDefinition {
1847
- /**
1848
- *
1849
- * @type {ExportSimpleMeasureDefinitionMeasure}
1850
- * @memberof ExportSimpleMeasureDefinition
1851
- */
1852
907
  measure: ExportSimpleMeasureDefinitionMeasure;
1853
908
  }
1854
- /**
1855
- *
1856
- * @export
1857
- * @interface ExportSimpleMeasureDefinitionMeasure
1858
- */
1859
909
  export interface ExportSimpleMeasureDefinitionMeasure {
1860
- /**
1861
- *
1862
- * @type {ExportAfmObjectIdentifierCore}
1863
- * @memberof ExportSimpleMeasureDefinitionMeasure
1864
- */
1865
910
  item: ExportAfmObjectIdentifierCore;
1866
911
  /**
1867
912
  * Definition of aggregation type of the metric.
1868
- * @type {string}
1869
- * @memberof ExportSimpleMeasureDefinitionMeasure
1870
913
  */
1871
914
  aggregation?: ExportSimpleMeasureDefinitionMeasureAggregationEnum;
1872
915
  /**
1873
916
  * If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).
1874
- * @type {boolean}
1875
- * @memberof ExportSimpleMeasureDefinitionMeasure
1876
917
  */
1877
918
  computeRatio?: boolean;
1878
919
  /**
1879
920
  * Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.
1880
- * @type {Array<ExportFilterDefinitionForSimpleMeasure>}
1881
- * @memberof ExportSimpleMeasureDefinitionMeasure
1882
921
  */
1883
922
  filters?: Array<ExportFilterDefinitionForSimpleMeasure>;
1884
923
  }
@@ -1895,50 +934,34 @@ export declare const ExportSimpleMeasureDefinitionMeasureAggregationEnum: {
1895
934
  export type ExportSimpleMeasureDefinitionMeasureAggregationEnum = (typeof ExportSimpleMeasureDefinitionMeasureAggregationEnum)[keyof typeof ExportSimpleMeasureDefinitionMeasureAggregationEnum];
1896
935
  /**
1897
936
  * Export request object describing the export properties and metadata for slides exports.
1898
- * @export
1899
- * @interface ExportSlidesExportRequest
1900
937
  */
1901
938
  export interface ExportSlidesExportRequest {
1902
939
  /**
1903
940
  * Requested resulting file type.
1904
- * @type {string}
1905
- * @memberof ExportSlidesExportRequest
1906
941
  */
1907
942
  format: ExportSlidesExportRequestFormatEnum;
1908
943
  /**
1909
944
  * File name to be used for retrieving the pdf document.
1910
- * @type {string}
1911
- * @memberof ExportSlidesExportRequest
1912
945
  */
1913
946
  fileName: string;
1914
947
  /**
1915
948
  * Dashboard identifier
1916
- * @type {string}
1917
- * @memberof ExportSlidesExportRequest
1918
949
  */
1919
950
  dashboardId?: string;
1920
951
  /**
1921
952
  * List of widget identifiers to be exported. Note that only one widget is currently supported.
1922
- * @type {Array<string>}
1923
- * @memberof ExportSlidesExportRequest
1924
953
  */
1925
954
  widgetIds?: Array<string>;
1926
955
  /**
1927
956
  * List of visualization ids to be exported. Note that only one visualization is currently supported.
1928
- * @type {Array<string>}
1929
- * @memberof ExportSlidesExportRequest
1930
957
  */
1931
958
  visualizationIds?: Array<string>;
1932
959
  /**
1933
960
  * Metadata definition in free-form JSON format.
1934
- * @type {object}
1935
- * @memberof ExportSlidesExportRequest
1936
961
  */
1937
962
  metadata?: object | null;
1938
963
  /**
1939
964
  * Export template identifier.
1940
- * @type {string}
1941
- * @memberof ExportSlidesExportRequest
1942
965
  */
1943
966
  templateId?: string | null;
1944
967
  }
@@ -1949,62 +972,36 @@ export declare const ExportSlidesExportRequestFormatEnum: {
1949
972
  export type ExportSlidesExportRequestFormatEnum = (typeof ExportSlidesExportRequestFormatEnum)[keyof typeof ExportSlidesExportRequestFormatEnum];
1950
973
  /**
1951
974
  * Export request object describing the export properties and overrides for tabular exports.
1952
- * @export
1953
- * @interface ExportTabularExportRequest
1954
975
  */
1955
976
  export interface ExportTabularExportRequest {
1956
977
  /**
1957
978
  * Expected file format.
1958
- * @type {string}
1959
- * @memberof ExportTabularExportRequest
1960
979
  */
1961
980
  format: ExportTabularExportRequestFormatEnum;
1962
981
  /**
1963
982
  * Execution result identifier.
1964
- * @type {string}
1965
- * @memberof ExportTabularExportRequest
1966
983
  */
1967
984
  executionResult?: string;
1968
985
  /**
1969
986
  * Filename of downloaded file without extension.
1970
- * @type {string}
1971
- * @memberof ExportTabularExportRequest
1972
987
  */
1973
988
  fileName: string;
1974
- /**
1975
- *
1976
- * @type {ExportSettings}
1977
- * @memberof ExportTabularExportRequest
1978
- */
1979
989
  settings?: ExportSettings;
1980
- /**
1981
- *
1982
- * @type {ExportCustomOverride}
1983
- * @memberof ExportTabularExportRequest
1984
- */
1985
990
  customOverride?: ExportCustomOverride;
1986
991
  /**
1987
992
  * Visualization object identifier. Alternative to executionResult property.
1988
- * @type {string}
1989
- * @memberof ExportTabularExportRequest
1990
993
  */
1991
994
  visualizationObject?: string;
1992
995
  /**
1993
996
  * Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given.
1994
- * @type {Array<object>}
1995
- * @memberof ExportTabularExportRequest
1996
997
  */
1997
998
  visualizationObjectCustomFilters?: Array<object>;
1998
999
  /**
1999
1000
  * Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
2000
- * @type {string}
2001
- * @memberof ExportTabularExportRequest
2002
1001
  */
2003
1002
  relatedDashboardId?: string;
2004
1003
  /**
2005
1004
  * Metadata definition in free-form JSON format.
2006
- * @type {object}
2007
- * @memberof ExportTabularExportRequest
2008
1005
  */
2009
1006
  metadata?: object | null;
2010
1007
  }
@@ -2017,26 +1014,18 @@ export declare const ExportTabularExportRequestFormatEnum: {
2017
1014
  export type ExportTabularExportRequestFormatEnum = (typeof ExportTabularExportRequestFormatEnum)[keyof typeof ExportTabularExportRequestFormatEnum];
2018
1015
  /**
2019
1016
  * Export request object describing the export properties and metadata for dashboard PDF exports.
2020
- * @export
2021
- * @interface ExportVisualExportRequest
2022
1017
  */
2023
1018
  export interface ExportVisualExportRequest {
2024
1019
  /**
2025
1020
  * File name to be used for retrieving the pdf document.
2026
- * @type {string}
2027
- * @memberof ExportVisualExportRequest
2028
1021
  */
2029
1022
  fileName: string;
2030
1023
  /**
2031
1024
  * Dashboard identifier
2032
- * @type {string}
2033
- * @memberof ExportVisualExportRequest
2034
1025
  */
2035
1026
  dashboardId: string;
2036
1027
  /**
2037
1028
  * Metadata definition in free-form JSON format.
2038
- * @type {object}
2039
- * @memberof ExportVisualExportRequest
2040
1029
  */
2041
1030
  metadata?: object;
2042
1031
  }