@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,257 +14,97 @@ 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 AutomationAFM
19
17
  */
20
18
  export interface AutomationAFM {
21
19
  /**
22
20
  * Attributes to be used in the computation.
23
- * @type {Array<AutomationAttributeItem>}
24
- * @memberof AutomationAFM
25
21
  */
26
22
  attributes: Array<AutomationAttributeItem>;
27
23
  /**
28
24
  * Various filter types to filter the execution result.
29
- * @type {Array<AutomationAbstractMeasureValueFilter | AutomationFilterDefinitionForSimpleMeasure | AutomationInlineFilterDefinition>}
30
- * @memberof AutomationAFM
31
25
  */
32
- filters: Array<AutomationAbstractMeasureValueFilter | AutomationFilterDefinitionForSimpleMeasure | AutomationInlineFilterDefinition>;
26
+ filters: Array<AutomationAFMFiltersInner>;
33
27
  /**
34
28
  * Metrics to be computed.
35
- * @type {Array<AutomationMeasureItem>}
36
- * @memberof AutomationAFM
37
29
  */
38
30
  measures: Array<AutomationMeasureItem>;
39
31
  /**
40
32
  * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
41
- * @type {Array<AutomationMeasureItem>}
42
- * @memberof AutomationAFM
43
33
  */
44
34
  auxMeasures?: Array<AutomationMeasureItem>;
45
35
  }
36
+ /**
37
+ * @type AutomationAFMFiltersInner
38
+ */
39
+ export type AutomationAFMFiltersInner = AutomationAbstractMeasureValueFilter | AutomationFilterDefinitionForSimpleMeasure | AutomationInlineFilterDefinition;
46
40
  /**
47
41
  * A datetime filter specifying exact from and to values.
48
- * @export
49
- * @interface AutomationAbsoluteDateFilter
50
42
  */
51
43
  export interface AutomationAbsoluteDateFilter {
52
- /**
53
- *
54
- * @type {AutomationAbsoluteDateFilterAbsoluteDateFilter}
55
- * @memberof AutomationAbsoluteDateFilter
56
- */
57
44
  absoluteDateFilter: AutomationAbsoluteDateFilterAbsoluteDateFilter;
58
45
  }
59
- /**
60
- *
61
- * @export
62
- * @interface AutomationAbsoluteDateFilterAbsoluteDateFilter
63
- */
64
46
  export interface AutomationAbsoluteDateFilterAbsoluteDateFilter {
65
- /**
66
- *
67
- * @type {string}
68
- * @memberof AutomationAbsoluteDateFilterAbsoluteDateFilter
69
- */
70
47
  from: string;
71
- /**
72
- *
73
- * @type {string}
74
- * @memberof AutomationAbsoluteDateFilterAbsoluteDateFilter
75
- */
76
48
  to: string;
77
- /**
78
- *
79
- * @type {string}
80
- * @memberof AutomationAbsoluteDateFilterAbsoluteDateFilter
81
- */
82
49
  localIdentifier?: string;
83
- /**
84
- *
85
- * @type {boolean}
86
- * @memberof AutomationAbsoluteDateFilterAbsoluteDateFilter
87
- */
88
50
  applyOnResult?: boolean;
89
- /**
90
- *
91
- * @type {AutomationAfmObjectIdentifierDataset}
92
- * @memberof AutomationAbsoluteDateFilterAbsoluteDateFilter
93
- */
94
51
  dataset: AutomationAfmObjectIdentifierDataset;
95
52
  }
96
53
  /**
97
54
  * @type AutomationAbstractMeasureValueFilter
98
- * @export
99
55
  */
100
56
  export type AutomationAbstractMeasureValueFilter = AutomationComparisonMeasureValueFilter | AutomationRangeMeasureValueFilter | AutomationRankingFilter;
101
- /**
102
- *
103
- * @export
104
- * @interface AutomationAdHocAutomation
105
- */
106
57
  export interface AutomationAdHocAutomation {
107
- /**
108
- *
109
- * @type {string}
110
- * @memberof AutomationAdHocAutomation
111
- */
112
58
  title?: string;
113
- /**
114
- *
115
- * @type {string}
116
- * @memberof AutomationAdHocAutomation
117
- */
118
59
  description?: string;
119
60
  /**
120
61
  * A list of tags.
121
- * @type {Array<string>}
122
- * @memberof AutomationAdHocAutomation
123
62
  */
124
63
  tags?: Array<string>;
125
64
  /**
126
65
  * Additional details to be included in the automated message.
127
- * @type {{ [key: string]: string; }}
128
- * @memberof AutomationAdHocAutomation
129
66
  */
130
67
  details?: {
131
68
  [key: string]: string;
132
69
  };
133
- /**
134
- *
135
- * @type {AutomationAutomationMetadata}
136
- * @memberof AutomationAdHocAutomation
137
- */
138
70
  metadata?: AutomationAutomationMetadata | null;
139
- /**
140
- *
141
- * @type {AutomationAutomationAlert}
142
- * @memberof AutomationAdHocAutomation
143
- */
144
71
  alert?: AutomationAutomationAlert;
145
- /**
146
- *
147
- * @type {Array<AutomationAutomationTabularExport>}
148
- * @memberof AutomationAdHocAutomation
149
- */
150
72
  tabularExports?: Array<AutomationAutomationTabularExport>;
151
- /**
152
- *
153
- * @type {Array<AutomationAutomationVisualExport>}
154
- * @memberof AutomationAdHocAutomation
155
- */
156
73
  visualExports?: Array<AutomationAutomationVisualExport>;
157
- /**
158
- *
159
- * @type {Array<AutomationAutomationImageExport>}
160
- * @memberof AutomationAdHocAutomation
161
- */
162
74
  imageExports?: Array<AutomationAutomationImageExport>;
163
- /**
164
- *
165
- * @type {Array<AutomationAutomationRawExport>}
166
- * @memberof AutomationAdHocAutomation
167
- */
168
75
  rawExports?: Array<AutomationAutomationRawExport>;
169
- /**
170
- *
171
- * @type {Array<AutomationAutomationSlidesExport>}
172
- * @memberof AutomationAdHocAutomation
173
- */
174
76
  slidesExports?: Array<AutomationAutomationSlidesExport>;
175
- /**
176
- *
177
- * @type {Array<AutomationAutomationDashboardTabularExport>}
178
- * @memberof AutomationAdHocAutomation
179
- */
180
77
  dashboardTabularExports?: Array<AutomationAutomationDashboardTabularExport>;
181
78
  /**
182
79
  * External recipients of the automation action results.
183
- * @type {Array<AutomationAutomationExternalRecipient>}
184
- * @memberof AutomationAdHocAutomation
185
80
  */
186
81
  externalRecipients?: Array<AutomationAutomationExternalRecipient>;
187
- /**
188
- *
189
- * @type {AutomationDeclarativeNotificationChannelIdentifier}
190
- * @memberof AutomationAdHocAutomation
191
- */
192
82
  notificationChannel?: AutomationDeclarativeNotificationChannelIdentifier;
193
- /**
194
- *
195
- * @type {Array<AutomationDeclarativeUserIdentifier>}
196
- * @memberof AutomationAdHocAutomation
197
- */
198
83
  recipients?: Array<AutomationDeclarativeUserIdentifier>;
199
- /**
200
- *
201
- * @type {AutomationDeclarativeAnalyticalDashboardIdentifier}
202
- * @memberof AutomationAdHocAutomation
203
- */
204
84
  analyticalDashboard?: AutomationDeclarativeAnalyticalDashboardIdentifier;
205
85
  }
206
86
  /**
207
87
  * @type AutomationAfmIdentifier
208
88
  * Reference to the attribute label to which the filter should be applied.
209
- * @export
210
89
  */
211
90
  export type AutomationAfmIdentifier = AutomationAfmLocalIdentifier | AutomationAfmObjectIdentifier;
212
- /**
213
- *
214
- * @export
215
- * @interface AutomationAfmLocalIdentifier
216
- */
217
91
  export interface AutomationAfmLocalIdentifier {
218
- /**
219
- *
220
- * @type {string}
221
- * @memberof AutomationAfmLocalIdentifier
222
- */
223
92
  localIdentifier: string;
224
93
  }
225
94
  /**
226
95
  * ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.
227
- * @export
228
- * @interface AutomationAfmObjectIdentifier
229
96
  */
230
97
  export interface AutomationAfmObjectIdentifier {
231
- /**
232
- *
233
- * @type {AutomationAfmObjectIdentifierIdentifier}
234
- * @memberof AutomationAfmObjectIdentifier
235
- */
236
98
  identifier: AutomationAfmObjectIdentifierIdentifier;
237
99
  }
238
100
  /**
239
101
  * Reference to the date attribute to use.
240
- * @export
241
- * @interface AutomationAfmObjectIdentifierAttribute
242
102
  */
243
103
  export interface AutomationAfmObjectIdentifierAttribute {
244
- /**
245
- *
246
- * @type {AutomationAfmObjectIdentifierAttributeIdentifier}
247
- * @memberof AutomationAfmObjectIdentifierAttribute
248
- */
249
104
  identifier: AutomationAfmObjectIdentifierAttributeIdentifier;
250
105
  }
251
- /**
252
- *
253
- * @export
254
- * @interface AutomationAfmObjectIdentifierAttributeIdentifier
255
- */
256
106
  export interface AutomationAfmObjectIdentifierAttributeIdentifier {
257
- /**
258
- *
259
- * @type {string}
260
- * @memberof AutomationAfmObjectIdentifierAttributeIdentifier
261
- */
262
107
  id: string;
263
- /**
264
- *
265
- * @type {string}
266
- * @memberof AutomationAfmObjectIdentifierAttributeIdentifier
267
- */
268
108
  type: AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum;
269
109
  }
270
110
  export declare const AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum: {
@@ -273,34 +113,12 @@ export declare const AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum: {
273
113
  export type AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum = (typeof AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum)[keyof typeof AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum];
274
114
  /**
275
115
  * Reference to the metric, fact or attribute object to use for the metric.
276
- * @export
277
- * @interface AutomationAfmObjectIdentifierCore
278
116
  */
279
117
  export interface AutomationAfmObjectIdentifierCore {
280
- /**
281
- *
282
- * @type {AutomationAfmObjectIdentifierCoreIdentifier}
283
- * @memberof AutomationAfmObjectIdentifierCore
284
- */
285
118
  identifier: AutomationAfmObjectIdentifierCoreIdentifier;
286
119
  }
287
- /**
288
- *
289
- * @export
290
- * @interface AutomationAfmObjectIdentifierCoreIdentifier
291
- */
292
120
  export interface AutomationAfmObjectIdentifierCoreIdentifier {
293
- /**
294
- *
295
- * @type {string}
296
- * @memberof AutomationAfmObjectIdentifierCoreIdentifier
297
- */
298
121
  id: string;
299
- /**
300
- *
301
- * @type {string}
302
- * @memberof AutomationAfmObjectIdentifierCoreIdentifier
303
- */
304
122
  type: AutomationAfmObjectIdentifierCoreIdentifierTypeEnum;
305
123
  }
306
124
  export declare const AutomationAfmObjectIdentifierCoreIdentifierTypeEnum: {
@@ -312,57 +130,20 @@ export declare const AutomationAfmObjectIdentifierCoreIdentifierTypeEnum: {
312
130
  export type AutomationAfmObjectIdentifierCoreIdentifierTypeEnum = (typeof AutomationAfmObjectIdentifierCoreIdentifierTypeEnum)[keyof typeof AutomationAfmObjectIdentifierCoreIdentifierTypeEnum];
313
131
  /**
314
132
  * Reference to the date dataset to which the filter should be applied.
315
- * @export
316
- * @interface AutomationAfmObjectIdentifierDataset
317
133
  */
318
134
  export interface AutomationAfmObjectIdentifierDataset {
319
- /**
320
- *
321
- * @type {AutomationAfmObjectIdentifierDatasetIdentifier}
322
- * @memberof AutomationAfmObjectIdentifierDataset
323
- */
324
135
  identifier: AutomationAfmObjectIdentifierDatasetIdentifier;
325
136
  }
326
- /**
327
- *
328
- * @export
329
- * @interface AutomationAfmObjectIdentifierDatasetIdentifier
330
- */
331
137
  export interface AutomationAfmObjectIdentifierDatasetIdentifier {
332
- /**
333
- *
334
- * @type {string}
335
- * @memberof AutomationAfmObjectIdentifierDatasetIdentifier
336
- */
337
138
  id: string;
338
- /**
339
- *
340
- * @type {string}
341
- * @memberof AutomationAfmObjectIdentifierDatasetIdentifier
342
- */
343
139
  type: AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum;
344
140
  }
345
141
  export declare const AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum: {
346
142
  readonly DATASET: "dataset";
347
143
  };
348
144
  export type AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum = (typeof AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum)[keyof typeof AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum];
349
- /**
350
- *
351
- * @export
352
- * @interface AutomationAfmObjectIdentifierIdentifier
353
- */
354
145
  export interface AutomationAfmObjectIdentifierIdentifier {
355
- /**
356
- *
357
- * @type {string}
358
- * @memberof AutomationAfmObjectIdentifierIdentifier
359
- */
360
146
  type: AutomationAfmObjectIdentifierIdentifierTypeEnum;
361
- /**
362
- *
363
- * @type {string}
364
- * @memberof AutomationAfmObjectIdentifierIdentifier
365
- */
366
147
  id: string;
367
148
  }
368
149
  export declare const AutomationAfmObjectIdentifierIdentifierTypeEnum: {
@@ -378,180 +159,60 @@ export declare const AutomationAfmObjectIdentifierIdentifierTypeEnum: {
378
159
  readonly FILTER_CONTEXT: "filterContext";
379
160
  };
380
161
  export type AutomationAfmObjectIdentifierIdentifierTypeEnum = (typeof AutomationAfmObjectIdentifierIdentifierTypeEnum)[keyof typeof AutomationAfmObjectIdentifierIdentifierTypeEnum];
381
- /**
382
- *
383
- * @export
384
- * @interface AutomationAfmObjectIdentifierLabel
385
- */
386
162
  export interface AutomationAfmObjectIdentifierLabel {
387
- /**
388
- *
389
- * @type {AutomationAfmObjectIdentifierLabelIdentifier}
390
- * @memberof AutomationAfmObjectIdentifierLabel
391
- */
392
163
  identifier: AutomationAfmObjectIdentifierLabelIdentifier;
393
164
  }
394
- /**
395
- *
396
- * @export
397
- * @interface AutomationAfmObjectIdentifierLabelIdentifier
398
- */
399
165
  export interface AutomationAfmObjectIdentifierLabelIdentifier {
400
- /**
401
- *
402
- * @type {string}
403
- * @memberof AutomationAfmObjectIdentifierLabelIdentifier
404
- */
405
166
  type: AutomationAfmObjectIdentifierLabelIdentifierTypeEnum;
406
- /**
407
- *
408
- * @type {string}
409
- * @memberof AutomationAfmObjectIdentifierLabelIdentifier
410
- */
411
167
  id: string;
412
168
  }
413
169
  export declare const AutomationAfmObjectIdentifierLabelIdentifierTypeEnum: {
414
170
  readonly LABEL: "label";
415
171
  };
416
172
  export type AutomationAfmObjectIdentifierLabelIdentifierTypeEnum = (typeof AutomationAfmObjectIdentifierLabelIdentifierTypeEnum)[keyof typeof AutomationAfmObjectIdentifierLabelIdentifierTypeEnum];
417
- /**
418
- *
419
- * @export
420
- * @interface AutomationAlertAfm
421
- */
422
173
  export interface AutomationAlertAfm {
423
174
  /**
424
175
  * Attributes to be used in the computation.
425
- * @type {Array<AutomationAttributeItem>}
426
- * @memberof AutomationAlertAfm
427
176
  */
428
177
  attributes?: Array<AutomationAttributeItem>;
429
178
  /**
430
179
  * Various filter types to filter execution result.
431
- * @type {Array<AutomationFilterDefinition>}
432
- * @memberof AutomationAlertAfm
433
180
  */
434
181
  filters: Array<AutomationFilterDefinition>;
435
182
  /**
436
183
  * Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other.
437
- * @type {Array<AutomationMeasureItem>}
438
- * @memberof AutomationAlertAfm
439
184
  */
440
185
  measures: Array<AutomationMeasureItem>;
441
186
  /**
442
187
  * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
443
- * @type {Array<AutomationMeasureItem>}
444
- * @memberof AutomationAlertAfm
445
188
  */
446
189
  auxMeasures?: Array<AutomationMeasureItem>;
447
190
  }
448
191
  /**
449
192
  * @type AutomationAlertCondition
450
193
  * Alert trigger condition.
451
- * @export
452
194
  */
453
195
  export type AutomationAlertCondition = AutomationComparisonWrapper | AutomationRangeWrapper | AutomationRelativeWrapper;
454
196
  /**
455
197
  * @type AutomationAlertConditionOperand
456
198
  * Operand of the alert condition.
457
- * @export
458
199
  */
459
200
  export type AutomationAlertConditionOperand = AutomationLocalIdentifier | AutomationValue;
460
- /**
461
- *
462
- * @export
463
- * @interface AutomationAlertDescription
464
- */
465
201
  export interface AutomationAlertDescription {
466
- /**
467
- *
468
- * @type {string}
469
- * @memberof AutomationAlertDescription
470
- */
471
202
  metric: string;
472
- /**
473
- *
474
- * @type {string}
475
- * @memberof AutomationAlertDescription
476
- */
477
203
  condition: string;
478
- /**
479
- *
480
- * @type {Array<AutomationAlertEvaluationRow>}
481
- * @memberof AutomationAlertDescription
482
- */
483
204
  currentValues?: Array<AutomationAlertEvaluationRow>;
484
- /**
485
- *
486
- * @type {string}
487
- * @memberof AutomationAlertDescription
488
- */
489
205
  attribute?: string;
490
- /**
491
- *
492
- * @type {number}
493
- * @memberof AutomationAlertDescription
494
- */
495
206
  totalValueCount?: number;
496
- /**
497
- *
498
- * @type {number}
499
- * @memberof AutomationAlertDescription
500
- */
501
207
  triggeredCount?: number;
502
- /**
503
- *
504
- * @type {string}
505
- * @memberof AutomationAlertDescription
506
- */
507
208
  triggeredAt?: string;
508
- /**
509
- *
510
- * @type {number}
511
- * @memberof AutomationAlertDescription
512
- */
513
209
  threshold?: number;
514
- /**
515
- *
516
- * @type {string}
517
- * @memberof AutomationAlertDescription
518
- */
519
210
  formattedThreshold?: string;
520
- /**
521
- *
522
- * @type {number}
523
- * @memberof AutomationAlertDescription
524
- */
525
211
  lowerThreshold?: number;
526
- /**
527
- *
528
- * @type {number}
529
- * @memberof AutomationAlertDescription
530
- */
531
212
  upperThreshold?: number;
532
- /**
533
- *
534
- * @type {number}
535
- * @memberof AutomationAlertDescription
536
- */
537
213
  remainingAlertEvaluationCount?: number;
538
- /**
539
- *
540
- * @type {string}
541
- * @memberof AutomationAlertDescription
542
- */
543
214
  status?: AutomationAlertDescriptionStatusEnum;
544
- /**
545
- *
546
- * @type {string}
547
- * @memberof AutomationAlertDescription
548
- */
549
215
  errorMessage?: string;
550
- /**
551
- *
552
- * @type {string}
553
- * @memberof AutomationAlertDescription
554
- */
555
216
  traceId?: string;
556
217
  }
557
218
  export declare const AutomationAlertDescriptionStatusEnum: {
@@ -561,60 +222,18 @@ export declare const AutomationAlertDescriptionStatusEnum: {
561
222
  readonly TIMEOUT: "TIMEOUT";
562
223
  };
563
224
  export type AutomationAlertDescriptionStatusEnum = (typeof AutomationAlertDescriptionStatusEnum)[keyof typeof AutomationAlertDescriptionStatusEnum];
564
- /**
565
- *
566
- * @export
567
- * @interface AutomationAlertEvaluationRow
568
- */
569
225
  export interface AutomationAlertEvaluationRow {
570
- /**
571
- *
572
- * @type {AutomationMetricRecord}
573
- * @memberof AutomationAlertEvaluationRow
574
- */
575
226
  primaryMetric?: AutomationMetricRecord;
576
- /**
577
- *
578
- * @type {AutomationMetricRecord}
579
- * @memberof AutomationAlertEvaluationRow
580
- */
581
227
  secondaryMetric?: AutomationMetricRecord;
582
- /**
583
- *
584
- * @type {AutomationMetricRecord}
585
- * @memberof AutomationAlertEvaluationRow
586
- */
587
228
  computedMetric?: AutomationMetricRecord;
588
- /**
589
- *
590
- * @type {string}
591
- * @memberof AutomationAlertEvaluationRow
592
- */
593
229
  labelValue?: string;
594
230
  }
595
- /**
596
- *
597
- * @export
598
- * @interface AutomationArithmeticMeasure
599
- */
600
231
  export interface AutomationArithmeticMeasure {
601
232
  /**
602
233
  * Arithmetic operator. DIFFERENCE - m₁−m₂ - the difference between two metrics. CHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics.
603
- * @type {string}
604
- * @memberof AutomationArithmeticMeasure
605
234
  */
606
235
  operator: AutomationArithmeticMeasureOperatorEnum;
607
- /**
608
- *
609
- * @type {AutomationLocalIdentifier}
610
- * @memberof AutomationArithmeticMeasure
611
- */
612
236
  left: AutomationLocalIdentifier;
613
- /**
614
- *
615
- * @type {AutomationLocalIdentifier}
616
- * @memberof AutomationArithmeticMeasure
617
- */
618
237
  right: AutomationLocalIdentifier;
619
238
  }
620
239
  export declare const AutomationArithmeticMeasureOperatorEnum: {
@@ -624,33 +243,17 @@ export declare const AutomationArithmeticMeasureOperatorEnum: {
624
243
  export type AutomationArithmeticMeasureOperatorEnum = (typeof AutomationArithmeticMeasureOperatorEnum)[keyof typeof AutomationArithmeticMeasureOperatorEnum];
625
244
  /**
626
245
  * Metric representing arithmetics between other metrics.
627
- * @export
628
- * @interface AutomationArithmeticMeasureDefinition
629
246
  */
630
247
  export interface AutomationArithmeticMeasureDefinition {
631
- /**
632
- *
633
- * @type {AutomationArithmeticMeasureDefinitionArithmeticMeasure}
634
- * @memberof AutomationArithmeticMeasureDefinition
635
- */
636
248
  arithmeticMeasure: AutomationArithmeticMeasureDefinitionArithmeticMeasure;
637
249
  }
638
- /**
639
- *
640
- * @export
641
- * @interface AutomationArithmeticMeasureDefinitionArithmeticMeasure
642
- */
643
250
  export interface AutomationArithmeticMeasureDefinitionArithmeticMeasure {
644
251
  /**
645
252
  * List of metrics to apply arithmetic operation by chosen operator.
646
- * @type {Array<AutomationAfmLocalIdentifier>}
647
- * @memberof AutomationArithmeticMeasureDefinitionArithmeticMeasure
648
253
  */
649
254
  measureIdentifiers: Array<AutomationAfmLocalIdentifier>;
650
255
  /**
651
256
  * Arithmetic operator describing operation between metrics.
652
- * @type {string}
653
- * @memberof AutomationArithmeticMeasureDefinitionArithmeticMeasure
654
257
  */
655
258
  operator: AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum;
656
259
  }
@@ -664,139 +267,58 @@ export declare const AutomationArithmeticMeasureDefinitionArithmeticMeasureOpera
664
267
  export type AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = (typeof AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum)[keyof typeof AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum];
665
268
  /**
666
269
  * @type AutomationAttributeElements
667
- * @export
668
270
  */
669
271
  export type AutomationAttributeElements = AutomationAttributeElementsByRef | AutomationAttributeElementsByValue;
670
- /**
671
- *
672
- * @export
673
- * @interface AutomationAttributeElementsByRef
674
- */
675
272
  export interface AutomationAttributeElementsByRef {
676
273
  /**
677
274
  * List of attribute elements by reference
678
- * @type {Array<string>}
679
- * @memberof AutomationAttributeElementsByRef
680
275
  */
681
- uris: Array<string>;
276
+ uris: Array<string | null>;
682
277
  }
683
- /**
684
- *
685
- * @export
686
- * @interface AutomationAttributeElementsByValue
687
- */
688
278
  export interface AutomationAttributeElementsByValue {
689
279
  /**
690
280
  * List of attribute elements by value
691
- * @type {Array<string>}
692
- * @memberof AutomationAttributeElementsByValue
693
281
  */
694
- values: Array<string>;
282
+ values: Array<string | null>;
695
283
  }
696
284
  /**
697
285
  * @type AutomationAttributeFilter
698
286
  * Abstract filter definition type attributes
699
- * @export
700
287
  */
701
288
  export type AutomationAttributeFilter = AutomationNegativeAttributeFilter | AutomationPositiveAttributeFilter;
702
- /**
703
- *
704
- * @export
705
- * @interface AutomationAttributeFilterByDate
706
- */
707
289
  export interface AutomationAttributeFilterByDate {
708
- /**
709
- *
710
- * @type {string}
711
- * @memberof AutomationAttributeFilterByDate
712
- */
713
290
  filterLocalIdentifier: string;
714
- /**
715
- *
716
- * @type {boolean}
717
- * @memberof AutomationAttributeFilterByDate
718
- */
719
291
  isCommonDate: boolean;
720
292
  }
721
293
  /**
722
294
  * Filter on specific set of label values.
723
- * @export
724
- * @interface AutomationAttributeFilterElements
725
295
  */
726
296
  export interface AutomationAttributeFilterElements {
727
297
  /**
728
298
  * Set of label values.
729
- * @type {Array<string>}
730
- * @memberof AutomationAttributeFilterElements
731
299
  */
732
300
  values: Array<string | null>;
733
301
  }
734
- /**
735
- *
736
- * @export
737
- * @interface AutomationAttributeFilterParent
738
- */
739
302
  export interface AutomationAttributeFilterParent {
740
- /**
741
- *
742
- * @type {string}
743
- * @memberof AutomationAttributeFilterParent
744
- */
745
303
  filterLocalIdentifier: string;
746
- /**
747
- *
748
- * @type {AutomationOver}
749
- * @memberof AutomationAttributeFilterParent
750
- */
751
304
  over: AutomationOver;
752
305
  }
753
- /**
754
- *
755
- * @export
756
- * @interface AutomationAttributeItem
757
- */
758
306
  export interface AutomationAttributeItem {
759
307
  /**
760
308
  * Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
761
- * @type {string}
762
- * @memberof AutomationAttributeItem
763
309
  */
764
310
  localIdentifier: string;
765
- /**
766
- *
767
- * @type {AutomationAfmObjectIdentifierLabel}
768
- * @memberof AutomationAttributeItem
769
- */
770
311
  label: AutomationAfmObjectIdentifierLabel;
771
312
  /**
772
313
  * Indicates whether to show all values of given attribute even if the data bound to those values is not available.
773
- * @type {boolean}
774
- * @memberof AutomationAttributeItem
775
314
  */
776
315
  showAllValues?: boolean;
777
316
  }
778
- /**
779
- *
780
- * @export
781
- * @interface AutomationAutomationAlert
782
- */
783
317
  export interface AutomationAutomationAlert {
784
- /**
785
- *
786
- * @type {AutomationAlertAfm}
787
- * @memberof AutomationAutomationAlert
788
- */
789
318
  execution: AutomationAlertAfm;
790
- /**
791
- *
792
- * @type {AutomationComparisonWrapper | AutomationRangeWrapper | AutomationRelativeWrapper}
793
- * @memberof AutomationAutomationAlert
794
- */
795
- condition: AutomationComparisonWrapper | AutomationRangeWrapper | AutomationRelativeWrapper;
319
+ condition: AutomationAutomationAlertCondition;
796
320
  /**
797
321
  * Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met.
798
- * @type {string}
799
- * @memberof AutomationAutomationAlert
800
322
  */
801
323
  trigger?: AutomationAutomationAlertTriggerEnum;
802
324
  }
@@ -806,163 +328,57 @@ export declare const AutomationAutomationAlertTriggerEnum: {
806
328
  };
807
329
  export type AutomationAutomationAlertTriggerEnum = (typeof AutomationAutomationAlertTriggerEnum)[keyof typeof AutomationAutomationAlertTriggerEnum];
808
330
  /**
809
- *
810
- * @export
811
- * @interface AutomationAutomationDashboardTabularExport
331
+ * @type AutomationAutomationAlertCondition
812
332
  */
333
+ export type AutomationAutomationAlertCondition = AutomationComparisonWrapper | AutomationRangeWrapper | AutomationRelativeWrapper;
813
334
  export interface AutomationAutomationDashboardTabularExport {
814
- /**
815
- *
816
- * @type {AutomationDashboardTabularExportRequestV2}
817
- * @memberof AutomationAutomationDashboardTabularExport
818
- */
819
335
  requestPayload: AutomationDashboardTabularExportRequestV2;
820
336
  }
821
- /**
822
- *
823
- * @export
824
- * @interface AutomationAutomationExternalRecipient
825
- */
826
337
  export interface AutomationAutomationExternalRecipient {
827
338
  /**
828
339
  * E-mail address to send notifications from.
829
- * @type {string}
830
- * @memberof AutomationAutomationExternalRecipient
831
340
  */
832
341
  email: string;
833
342
  }
834
- /**
835
- *
836
- * @export
837
- * @interface AutomationAutomationImageExport
838
- */
839
343
  export interface AutomationAutomationImageExport {
840
- /**
841
- *
842
- * @type {AutomationImageExportRequest}
843
- * @memberof AutomationAutomationImageExport
844
- */
845
344
  requestPayload: AutomationImageExportRequest;
846
345
  }
847
346
  /**
848
347
  * Additional information for the automation.
849
- * @export
850
- * @interface AutomationAutomationMetadata
851
348
  */
852
349
  export interface AutomationAutomationMetadata {
853
- /**
854
- *
855
- * @type {string}
856
- * @memberof AutomationAutomationMetadata
857
- */
858
350
  widget?: string;
859
- /**
860
- *
861
- * @type {Array<AutomationVisibleFilter>}
862
- * @memberof AutomationAutomationMetadata
863
- */
864
351
  visibleFilters?: Array<AutomationVisibleFilter>;
865
352
  }
866
- /**
867
- *
868
- * @export
869
- * @interface AutomationAutomationNotification
870
- */
871
353
  export interface AutomationAutomationNotification extends AutomationNotificationContent {
872
- /**
873
- *
874
- * @type {AutomationWebhookMessage}
875
- * @memberof AutomationAutomationNotification
876
- */
877
354
  content: AutomationWebhookMessage;
878
355
  }
879
- /**
880
- *
881
- * @export
882
- * @interface AutomationAutomationNotificationAllOf
883
- */
884
- export interface AutomationAutomationNotificationAllOf {
885
- /**
886
- *
887
- * @type {AutomationWebhookMessage}
888
- * @memberof AutomationAutomationNotificationAllOf
889
- */
890
- content?: AutomationWebhookMessage;
891
- }
892
- /**
893
- *
894
- * @export
895
- * @interface AutomationAutomationRawExport
896
- */
897
356
  export interface AutomationAutomationRawExport {
898
- /**
899
- *
900
- * @type {AutomationRawExportAutomationRequest}
901
- * @memberof AutomationAutomationRawExport
902
- */
903
357
  requestPayload: AutomationRawExportAutomationRequest;
904
358
  }
905
- /**
906
- *
907
- * @export
908
- * @interface AutomationAutomationSlidesExport
909
- */
910
359
  export interface AutomationAutomationSlidesExport {
911
- /**
912
- *
913
- * @type {AutomationSlidesExportRequest}
914
- * @memberof AutomationAutomationSlidesExport
915
- */
916
360
  requestPayload: AutomationSlidesExportRequest;
917
361
  }
918
- /**
919
- *
920
- * @export
921
- * @interface AutomationAutomationTabularExport
922
- */
923
362
  export interface AutomationAutomationTabularExport {
924
- /**
925
- *
926
- * @type {AutomationTabularExportRequest}
927
- * @memberof AutomationAutomationTabularExport
928
- */
929
363
  requestPayload: AutomationTabularExportRequest;
930
364
  }
931
- /**
932
- *
933
- * @export
934
- * @interface AutomationAutomationVisualExport
935
- */
936
365
  export interface AutomationAutomationVisualExport {
937
- /**
938
- *
939
- * @type {AutomationVisualExportRequest}
940
- * @memberof AutomationAutomationVisualExport
941
- */
942
366
  requestPayload: AutomationVisualExportRequest;
943
367
  }
944
368
  /**
945
369
  * 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.
946
- * @export
947
- * @interface AutomationBoundedFilter
948
370
  */
949
371
  export interface AutomationBoundedFilter {
950
372
  /**
951
373
  * Date granularity specifying particular date attribute in given dimension.
952
- * @type {string}
953
- * @memberof AutomationBoundedFilter
954
374
  */
955
375
  granularity: AutomationBoundedFilterGranularityEnum;
956
376
  /**
957
377
  * 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.
958
- * @type {number}
959
- * @memberof AutomationBoundedFilter
960
378
  */
961
379
  from?: number | null;
962
380
  /**
963
381
  * 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.
964
- * @type {number}
965
- * @memberof AutomationBoundedFilter
966
382
  */
967
383
  to?: number | null;
968
384
  }
@@ -985,29 +401,9 @@ export declare const AutomationBoundedFilterGranularityEnum: {
985
401
  readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
986
402
  };
987
403
  export type AutomationBoundedFilterGranularityEnum = (typeof AutomationBoundedFilterGranularityEnum)[keyof typeof AutomationBoundedFilterGranularityEnum];
988
- /**
989
- *
990
- * @export
991
- * @interface AutomationComparison
992
- */
993
404
  export interface AutomationComparison {
994
- /**
995
- *
996
- * @type {string}
997
- * @memberof AutomationComparison
998
- */
999
405
  operator: AutomationComparisonOperatorEnum;
1000
- /**
1001
- *
1002
- * @type {AutomationLocalIdentifier}
1003
- * @memberof AutomationComparison
1004
- */
1005
406
  left: AutomationLocalIdentifier;
1006
- /**
1007
- *
1008
- * @type {AutomationAlertConditionOperand}
1009
- * @memberof AutomationComparison
1010
- */
1011
407
  right: AutomationAlertConditionOperand;
1012
408
  }
1013
409
  export declare const AutomationComparisonOperatorEnum: {
@@ -1021,64 +417,23 @@ export declare const AutomationComparisonOperatorEnum: {
1021
417
  export type AutomationComparisonOperatorEnum = (typeof AutomationComparisonOperatorEnum)[keyof typeof AutomationComparisonOperatorEnum];
1022
418
  /**
1023
419
  * Filter the result by comparing specified metric to given constant value, using given comparison operator.
1024
- * @export
1025
- * @interface AutomationComparisonMeasureValueFilter
1026
420
  */
1027
421
  export interface AutomationComparisonMeasureValueFilter {
1028
- /**
1029
- *
1030
- * @type {AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter}
1031
- * @memberof AutomationComparisonMeasureValueFilter
1032
- */
1033
- comparisonMeasureValueFilter: AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter;
1034
- }
1035
- /**
1036
- *
1037
- * @export
1038
- * @interface AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter
1039
- */
422
+ comparisonMeasureValueFilter: AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter;
423
+ }
1040
424
  export interface AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter {
1041
425
  /**
1042
426
  * References to the attributes to be used when filtering.
1043
- * @type {Array<AutomationAfmIdentifier>}
1044
- * @memberof AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter
1045
427
  */
1046
428
  dimensionality?: Array<AutomationAfmIdentifier>;
1047
429
  /**
1048
430
  * A value that will be substituted for null values in the metric for the comparisons.
1049
- * @type {number}
1050
- * @memberof AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter
1051
431
  */
1052
432
  treatNullValuesAs?: number;
1053
- /**
1054
- *
1055
- * @type {string}
1056
- * @memberof AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter
1057
- */
1058
433
  operator: AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
1059
- /**
1060
- *
1061
- * @type {number}
1062
- * @memberof AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter
1063
- */
1064
434
  value: number;
1065
- /**
1066
- *
1067
- * @type {string}
1068
- * @memberof AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter
1069
- */
1070
435
  localIdentifier?: string;
1071
- /**
1072
- *
1073
- * @type {boolean}
1074
- * @memberof AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter
1075
- */
1076
436
  applyOnResult?: boolean;
1077
- /**
1078
- *
1079
- * @type {AutomationAfmIdentifier}
1080
- * @memberof AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter
1081
- */
1082
437
  measure: AutomationAfmIdentifier;
1083
438
  }
1084
439
  export declare const AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum: {
@@ -1090,146 +445,60 @@ export declare const AutomationComparisonMeasureValueFilterComparisonMeasureValu
1090
445
  readonly NOT_EQUAL_TO: "NOT_EQUAL_TO";
1091
446
  };
1092
447
  export type AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = (typeof AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum)[keyof typeof AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum];
1093
- /**
1094
- *
1095
- * @export
1096
- * @interface AutomationComparisonWrapper
1097
- */
1098
448
  export interface AutomationComparisonWrapper {
1099
- /**
1100
- *
1101
- * @type {AutomationComparison}
1102
- * @memberof AutomationComparisonWrapper
1103
- */
1104
449
  comparison: AutomationComparison;
1105
450
  }
1106
451
  /**
1107
452
  * Custom label object override.
1108
- * @export
1109
- * @interface AutomationCustomLabel
1110
453
  */
1111
454
  export interface AutomationCustomLabel {
1112
455
  /**
1113
456
  * Override value.
1114
- * @type {string}
1115
- * @memberof AutomationCustomLabel
1116
457
  */
1117
458
  title: string;
1118
459
  }
1119
460
  /**
1120
461
  * Custom metric object override.
1121
- * @export
1122
- * @interface AutomationCustomMetric
1123
462
  */
1124
463
  export interface AutomationCustomMetric {
1125
464
  /**
1126
465
  * Metric title override.
1127
- * @type {string}
1128
- * @memberof AutomationCustomMetric
1129
466
  */
1130
467
  title: string;
1131
468
  /**
1132
469
  * Format override.
1133
- * @type {string}
1134
- * @memberof AutomationCustomMetric
1135
470
  */
1136
471
  format: string;
1137
472
  }
1138
473
  /**
1139
474
  * Custom cell value overrides (IDs will be replaced with specified values).
1140
- * @export
1141
- * @interface AutomationCustomOverride
1142
475
  */
1143
476
  export interface AutomationCustomOverride {
1144
477
  /**
1145
478
  * Map of CustomLabels with keys used as placeholders in document.
1146
- * @type {{ [key: string]: AutomationCustomLabel; }}
1147
- * @memberof AutomationCustomOverride
1148
479
  */
1149
480
  labels?: {
1150
481
  [key: string]: AutomationCustomLabel;
1151
482
  };
1152
483
  /**
1153
484
  * Map of CustomMetrics with keys used as placeholders in document.
1154
- * @type {{ [key: string]: AutomationCustomMetric; }}
1155
- * @memberof AutomationCustomOverride
1156
485
  */
1157
486
  metrics?: {
1158
487
  [key: string]: AutomationCustomMetric;
1159
488
  };
1160
489
  }
1161
- /**
1162
- *
1163
- * @export
1164
- * @interface AutomationDashboardAttributeFilter
1165
- */
1166
490
  export interface AutomationDashboardAttributeFilter {
1167
- /**
1168
- *
1169
- * @type {AutomationDashboardAttributeFilterAttributeFilter}
1170
- * @memberof AutomationDashboardAttributeFilter
1171
- */
1172
491
  attributeFilter: AutomationDashboardAttributeFilterAttributeFilter;
1173
492
  }
1174
- /**
1175
- *
1176
- * @export
1177
- * @interface AutomationDashboardAttributeFilterAttributeFilter
1178
- */
1179
493
  export interface AutomationDashboardAttributeFilterAttributeFilter {
1180
- /**
1181
- *
1182
- * @type {AutomationIdentifierRef}
1183
- * @memberof AutomationDashboardAttributeFilterAttributeFilter
1184
- */
1185
494
  displayForm: AutomationIdentifierRef;
1186
- /**
1187
- *
1188
- * @type {boolean}
1189
- * @memberof AutomationDashboardAttributeFilterAttributeFilter
1190
- */
1191
495
  negativeSelection: boolean;
1192
- /**
1193
- *
1194
- * @type {AutomationAttributeElements}
1195
- * @memberof AutomationDashboardAttributeFilterAttributeFilter
1196
- */
1197
496
  attributeElements: AutomationAttributeElements;
1198
- /**
1199
- *
1200
- * @type {Array<AutomationAttributeFilterParent>}
1201
- * @memberof AutomationDashboardAttributeFilterAttributeFilter
1202
- */
1203
497
  filterElementsBy?: Array<AutomationAttributeFilterParent>;
1204
- /**
1205
- *
1206
- * @type {Array<AutomationAttributeFilterByDate>}
1207
- * @memberof AutomationDashboardAttributeFilterAttributeFilter
1208
- */
1209
498
  filterElementsByDate?: Array<AutomationAttributeFilterByDate>;
1210
- /**
1211
- *
1212
- * @type {Array<AutomationIdentifierRef>}
1213
- * @memberof AutomationDashboardAttributeFilterAttributeFilter
1214
- */
1215
499
  validateElementsBy?: Array<AutomationIdentifierRef>;
1216
- /**
1217
- *
1218
- * @type {string}
1219
- * @memberof AutomationDashboardAttributeFilterAttributeFilter
1220
- */
1221
500
  title?: string;
1222
- /**
1223
- *
1224
- * @type {string}
1225
- * @memberof AutomationDashboardAttributeFilterAttributeFilter
1226
- */
1227
501
  selectionMode?: AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum;
1228
- /**
1229
- *
1230
- * @type {string}
1231
- * @memberof AutomationDashboardAttributeFilterAttributeFilter
1232
- */
1233
502
  localIdentifier?: string;
1234
503
  }
1235
504
  export declare const AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum: {
@@ -1237,72 +506,17 @@ export declare const AutomationDashboardAttributeFilterAttributeFilterSelectionM
1237
506
  readonly MULTI: "multi";
1238
507
  };
1239
508
  export type AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum = (typeof AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum)[keyof typeof AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum];
1240
- /**
1241
- *
1242
- * @export
1243
- * @interface AutomationDashboardDateFilter
1244
- */
1245
509
  export interface AutomationDashboardDateFilter {
1246
- /**
1247
- *
1248
- * @type {AutomationDashboardDateFilterDateFilter}
1249
- * @memberof AutomationDashboardDateFilter
1250
- */
1251
510
  dateFilter: AutomationDashboardDateFilterDateFilter;
1252
511
  }
1253
- /**
1254
- *
1255
- * @export
1256
- * @interface AutomationDashboardDateFilterDateFilter
1257
- */
1258
512
  export interface AutomationDashboardDateFilterDateFilter {
1259
- /**
1260
- *
1261
- * @type {string}
1262
- * @memberof AutomationDashboardDateFilterDateFilter
1263
- */
1264
513
  type: AutomationDashboardDateFilterDateFilterTypeEnum;
1265
- /**
1266
- *
1267
- * @type {string}
1268
- * @memberof AutomationDashboardDateFilterDateFilter
1269
- */
1270
514
  granularity: AutomationDashboardDateFilterDateFilterGranularityEnum;
1271
- /**
1272
- *
1273
- * @type {string | number}
1274
- * @memberof AutomationDashboardDateFilterDateFilter
1275
- */
1276
- from?: string | number;
1277
- /**
1278
- *
1279
- * @type {string | number}
1280
- * @memberof AutomationDashboardDateFilterDateFilter
1281
- */
1282
- to?: string | number;
1283
- /**
1284
- *
1285
- * @type {AutomationIdentifierRef}
1286
- * @memberof AutomationDashboardDateFilterDateFilter
1287
- */
515
+ from?: AutomationDashboardDateFilterDateFilterFrom;
516
+ to?: AutomationDashboardDateFilterDateFilterFrom;
1288
517
  dataSet?: AutomationIdentifierRef;
1289
- /**
1290
- *
1291
- * @type {AutomationIdentifierRef}
1292
- * @memberof AutomationDashboardDateFilterDateFilter
1293
- */
1294
518
  attribute?: AutomationIdentifierRef;
1295
- /**
1296
- *
1297
- * @type {AutomationRelativeBoundedDateFilter}
1298
- * @memberof AutomationDashboardDateFilterDateFilter
1299
- */
1300
519
  boundedFilter?: AutomationRelativeBoundedDateFilter;
1301
- /**
1302
- *
1303
- * @type {string}
1304
- * @memberof AutomationDashboardDateFilterDateFilter
1305
- */
1306
520
  localIdentifier?: string;
1307
521
  }
1308
522
  export declare const AutomationDashboardDateFilterDateFilterTypeEnum: {
@@ -1336,71 +550,51 @@ export declare const AutomationDashboardDateFilterDateFilterGranularityEnum: {
1336
550
  readonly GDC_TIME_MINUTE_IN_HOUR: "GDC.time.minute_in_hour";
1337
551
  };
1338
552
  export type AutomationDashboardDateFilterDateFilterGranularityEnum = (typeof AutomationDashboardDateFilterDateFilterGranularityEnum)[keyof typeof AutomationDashboardDateFilterDateFilterGranularityEnum];
553
+ /**
554
+ * @type AutomationDashboardDateFilterDateFilterFrom
555
+ */
556
+ export type AutomationDashboardDateFilterDateFilterFrom = number | string;
1339
557
  /**
1340
558
  * Additional settings.
1341
- * @export
1342
- * @interface AutomationDashboardExportSettings
1343
559
  */
1344
560
  export interface AutomationDashboardExportSettings {
1345
561
  /**
1346
562
  * If true, the export will contain the information about the exported date and dashboard filters.
1347
- * @type {boolean}
1348
- * @memberof AutomationDashboardExportSettings
1349
563
  */
1350
564
  exportInfo?: boolean;
1351
565
  /**
1352
566
  * Merge equal headers in neighbouring cells. Used for [XLSX] format only.
1353
- * @type {boolean}
1354
- * @memberof AutomationDashboardExportSettings
1355
567
  */
1356
568
  mergeHeaders?: boolean;
1357
569
  }
1358
570
  /**
1359
571
  * @type AutomationDashboardFilter
1360
- * @export
1361
572
  */
1362
573
  export type AutomationDashboardFilter = AutomationDashboardAttributeFilter | AutomationDashboardDateFilter;
1363
574
  /**
1364
575
  * Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).
1365
- * @export
1366
- * @interface AutomationDashboardTabularExportRequestV2
1367
576
  */
1368
577
  export interface AutomationDashboardTabularExportRequestV2 {
1369
578
  /**
1370
579
  * Requested tabular export type.
1371
- * @type {string}
1372
- * @memberof AutomationDashboardTabularExportRequestV2
1373
580
  */
1374
581
  format: AutomationDashboardTabularExportRequestV2FormatEnum;
1375
582
  /**
1376
583
  * Filename of downloaded file without extension.
1377
- * @type {string}
1378
- * @memberof AutomationDashboardTabularExportRequestV2
1379
584
  */
1380
585
  fileName: string;
1381
586
  /**
1382
587
  * List of filters that will be used instead of the default dashboard filters.
1383
- * @type {Array<AutomationDashboardFilter>}
1384
- * @memberof AutomationDashboardTabularExportRequestV2
1385
588
  */
1386
589
  dashboardFiltersOverride?: Array<AutomationDashboardFilter>;
1387
590
  /**
1388
591
  * Dashboard identifier
1389
- * @type {string}
1390
- * @memberof AutomationDashboardTabularExportRequestV2
1391
592
  */
1392
593
  dashboardId: string;
1393
594
  /**
1394
595
  * List of widget identifiers to be exported. Note that only one widget is currently supported.
1395
- * @type {Array<string>}
1396
- * @memberof AutomationDashboardTabularExportRequestV2
1397
596
  */
1398
597
  widgetIds?: Array<string>;
1399
- /**
1400
- *
1401
- * @type {AutomationDashboardExportSettings}
1402
- * @memberof AutomationDashboardTabularExportRequestV2
1403
- */
1404
598
  settings?: AutomationDashboardExportSettings;
1405
599
  }
1406
600
  export declare const AutomationDashboardTabularExportRequestV2FormatEnum: {
@@ -1410,38 +604,21 @@ export type AutomationDashboardTabularExportRequestV2FormatEnum = (typeof Automa
1410
604
  /**
1411
605
  * @type AutomationDateFilter
1412
606
  * Abstract filter definition type for dates.
1413
- * @export
1414
607
  */
1415
608
  export type AutomationDateFilter = AutomationAbsoluteDateFilter | AutomationRelativeDateFilter;
1416
- /**
1417
- *
1418
- * @export
1419
- * @interface AutomationDateValue
1420
- */
1421
609
  export interface AutomationDateValue {
1422
- /**
1423
- *
1424
- * @type {string}
1425
- * @memberof AutomationDateValue
1426
- */
1427
610
  value: string;
1428
611
  }
1429
612
  /**
1430
613
  * An analytical dashboard identifier.
1431
- * @export
1432
- * @interface AutomationDeclarativeAnalyticalDashboardIdentifier
1433
614
  */
1434
615
  export interface AutomationDeclarativeAnalyticalDashboardIdentifier {
1435
616
  /**
1436
617
  * Identifier of the analytical dashboard.
1437
- * @type {string}
1438
- * @memberof AutomationDeclarativeAnalyticalDashboardIdentifier
1439
618
  */
1440
619
  id: string;
1441
620
  /**
1442
621
  * A type.
1443
- * @type {string}
1444
- * @memberof AutomationDeclarativeAnalyticalDashboardIdentifier
1445
622
  */
1446
623
  type: AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum;
1447
624
  }
@@ -1451,20 +628,14 @@ export declare const AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum:
1451
628
  export type AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum = (typeof AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum)[keyof typeof AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum];
1452
629
  /**
1453
630
  * A notification channel identifier.
1454
- * @export
1455
- * @interface AutomationDeclarativeNotificationChannelIdentifier
1456
631
  */
1457
632
  export interface AutomationDeclarativeNotificationChannelIdentifier {
1458
633
  /**
1459
634
  * Notification channel identifier.
1460
- * @type {string}
1461
- * @memberof AutomationDeclarativeNotificationChannelIdentifier
1462
635
  */
1463
636
  id: string;
1464
637
  /**
1465
638
  * A type.
1466
- * @type {string}
1467
- * @memberof AutomationDeclarativeNotificationChannelIdentifier
1468
639
  */
1469
640
  type: AutomationDeclarativeNotificationChannelIdentifierTypeEnum;
1470
641
  }
@@ -1474,20 +645,14 @@ export declare const AutomationDeclarativeNotificationChannelIdentifierTypeEnum:
1474
645
  export type AutomationDeclarativeNotificationChannelIdentifierTypeEnum = (typeof AutomationDeclarativeNotificationChannelIdentifierTypeEnum)[keyof typeof AutomationDeclarativeNotificationChannelIdentifierTypeEnum];
1475
646
  /**
1476
647
  * A user identifier.
1477
- * @export
1478
- * @interface AutomationDeclarativeUserIdentifier
1479
648
  */
1480
649
  export interface AutomationDeclarativeUserIdentifier {
1481
650
  /**
1482
651
  * User identifier.
1483
- * @type {string}
1484
- * @memberof AutomationDeclarativeUserIdentifier
1485
652
  */
1486
653
  id: string;
1487
654
  /**
1488
655
  * A type.
1489
- * @type {string}
1490
- * @memberof AutomationDeclarativeUserIdentifier
1491
656
  */
1492
657
  type: AutomationDeclarativeUserIdentifierTypeEnum;
1493
658
  }
@@ -1497,26 +662,18 @@ export declare const AutomationDeclarativeUserIdentifierTypeEnum: {
1497
662
  export type AutomationDeclarativeUserIdentifierTypeEnum = (typeof AutomationDeclarativeUserIdentifierTypeEnum)[keyof typeof AutomationDeclarativeUserIdentifierTypeEnum];
1498
663
  /**
1499
664
  * Default SMTP destination for notifications.
1500
- * @export
1501
- * @interface AutomationDefaultSmtp
1502
665
  */
1503
666
  export interface AutomationDefaultSmtp {
1504
667
  /**
1505
668
  * E-mail address to send notifications from. Currently this does not have any effect. E-mail \'no-reply@gooddata.com\' is used instead.
1506
- * @type {string}
1507
- * @memberof AutomationDefaultSmtp
1508
669
  */
1509
670
  fromEmail?: string;
1510
671
  /**
1511
672
  * An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name \'GoodData\' is used instead.
1512
- * @type {string}
1513
- * @memberof AutomationDefaultSmtp
1514
673
  */
1515
674
  fromEmailName?: string;
1516
675
  /**
1517
676
  * The destination type.
1518
- * @type {string}
1519
- * @memberof AutomationDefaultSmtp
1520
677
  */
1521
678
  type: AutomationDefaultSmtpTypeEnum;
1522
679
  }
@@ -1526,82 +683,26 @@ export declare const AutomationDefaultSmtpTypeEnum: {
1526
683
  export type AutomationDefaultSmtpTypeEnum = (typeof AutomationDefaultSmtpTypeEnum)[keyof typeof AutomationDefaultSmtpTypeEnum];
1527
684
  /**
1528
685
  * Various settings affecting the process of AFM execution or its result
1529
- * @export
1530
- * @interface AutomationExecutionSettings
1531
686
  */
1532
687
  export interface AutomationExecutionSettings {
1533
688
  /**
1534
689
  * 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.
1535
- * @type {number}
1536
- * @memberof AutomationExecutionSettings
1537
690
  */
1538
691
  dataSamplingPercentage?: number;
1539
692
  /**
1540
693
  * Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.
1541
- * @type {string}
1542
- * @memberof AutomationExecutionSettings
1543
694
  */
1544
695
  timestamp?: string;
1545
696
  }
1546
- /**
1547
- *
1548
- * @export
1549
- * @interface AutomationExportResult
1550
- */
1551
697
  export interface AutomationExportResult {
1552
- /**
1553
- *
1554
- * @type {string}
1555
- * @memberof AutomationExportResult
1556
- */
1557
698
  fileName: string;
1558
- /**
1559
- *
1560
- * @type {string}
1561
- * @memberof AutomationExportResult
1562
- */
1563
699
  exportId: string;
1564
- /**
1565
- *
1566
- * @type {string}
1567
- * @memberof AutomationExportResult
1568
- */
1569
700
  status: AutomationExportResultStatusEnum;
1570
- /**
1571
- *
1572
- * @type {string}
1573
- * @memberof AutomationExportResult
1574
- */
1575
701
  fileUri?: string;
1576
- /**
1577
- *
1578
- * @type {string}
1579
- * @memberof AutomationExportResult
1580
- */
1581
702
  expiresAt?: string;
1582
- /**
1583
- *
1584
- * @type {number}
1585
- * @memberof AutomationExportResult
1586
- */
1587
703
  fileSize?: number;
1588
- /**
1589
- *
1590
- * @type {string}
1591
- * @memberof AutomationExportResult
1592
- */
1593
704
  errorMessage?: string;
1594
- /**
1595
- *
1596
- * @type {string}
1597
- * @memberof AutomationExportResult
1598
- */
1599
705
  traceId?: string;
1600
- /**
1601
- *
1602
- * @type {string}
1603
- * @memberof AutomationExportResult
1604
- */
1605
706
  triggeredAt?: string;
1606
707
  }
1607
708
  export declare const AutomationExportResultStatusEnum: {
@@ -1614,45 +715,18 @@ export type AutomationExportResultStatusEnum = (typeof AutomationExportResultSta
1614
715
  /**
1615
716
  * @type AutomationFilterDefinition
1616
717
  * Abstract filter definition type
1617
- * @export
1618
718
  */
1619
719
  export type AutomationFilterDefinition = AutomationAbsoluteDateFilter | AutomationComparisonMeasureValueFilter | AutomationInlineFilterDefinition | AutomationNegativeAttributeFilter | AutomationPositiveAttributeFilter | AutomationRangeMeasureValueFilter | AutomationRankingFilter | AutomationRelativeDateFilter;
1620
720
  /**
1621
721
  * @type AutomationFilterDefinitionForSimpleMeasure
1622
722
  * Abstract filter definition type for simple metric.
1623
- * @export
1624
723
  */
1625
724
  export type AutomationFilterDefinitionForSimpleMeasure = AutomationAttributeFilter | AutomationDateFilter;
1626
- /**
1627
- *
1628
- * @export
1629
- * @interface AutomationIdentifierRef
1630
- */
1631
725
  export interface AutomationIdentifierRef {
1632
- /**
1633
- *
1634
- * @type {AutomationIdentifierRefIdentifier}
1635
- * @memberof AutomationIdentifierRef
1636
- */
1637
726
  identifier?: AutomationIdentifierRefIdentifier;
1638
727
  }
1639
- /**
1640
- *
1641
- * @export
1642
- * @interface AutomationIdentifierRefIdentifier
1643
- */
1644
728
  export interface AutomationIdentifierRefIdentifier {
1645
- /**
1646
- *
1647
- * @type {string}
1648
- * @memberof AutomationIdentifierRefIdentifier
1649
- */
1650
729
  id: string;
1651
- /**
1652
- *
1653
- * @type {string}
1654
- * @memberof AutomationIdentifierRefIdentifier
1655
- */
1656
730
  type: AutomationIdentifierRefIdentifierTypeEnum;
1657
731
  }
1658
732
  export declare const AutomationIdentifierRefIdentifierTypeEnum: {
@@ -1681,38 +755,26 @@ export declare const AutomationIdentifierRefIdentifierTypeEnum: {
1681
755
  export type AutomationIdentifierRefIdentifierTypeEnum = (typeof AutomationIdentifierRefIdentifierTypeEnum)[keyof typeof AutomationIdentifierRefIdentifierTypeEnum];
1682
756
  /**
1683
757
  * Export request object describing the export properties and metadata for image exports.
1684
- * @export
1685
- * @interface AutomationImageExportRequest
1686
758
  */
1687
759
  export interface AutomationImageExportRequest {
1688
760
  /**
1689
761
  * Requested resulting file type.
1690
- * @type {string}
1691
- * @memberof AutomationImageExportRequest
1692
762
  */
1693
763
  format: AutomationImageExportRequestFormatEnum;
1694
764
  /**
1695
765
  * File name to be used for retrieving the image document.
1696
- * @type {string}
1697
- * @memberof AutomationImageExportRequest
1698
766
  */
1699
767
  fileName: string;
1700
768
  /**
1701
769
  * Dashboard identifier
1702
- * @type {string}
1703
- * @memberof AutomationImageExportRequest
1704
770
  */
1705
771
  dashboardId: string;
1706
772
  /**
1707
773
  * List of widget identifiers to be exported. Note that only one widget is currently supported.
1708
- * @type {Array<string>}
1709
- * @memberof AutomationImageExportRequest
1710
774
  */
1711
775
  widgetIds: Array<string>;
1712
776
  /**
1713
777
  * Metadata definition in free-form JSON format.
1714
- * @type {object}
1715
- * @memberof AutomationImageExportRequest
1716
778
  */
1717
779
  metadata?: object | null;
1718
780
  }
@@ -1722,14 +784,10 @@ export declare const AutomationImageExportRequestFormatEnum: {
1722
784
  export type AutomationImageExportRequestFormatEnum = (typeof AutomationImageExportRequestFormatEnum)[keyof typeof AutomationImageExportRequestFormatEnum];
1723
785
  /**
1724
786
  * In-platform destination for notifications.
1725
- * @export
1726
- * @interface AutomationInPlatform
1727
787
  */
1728
788
  export interface AutomationInPlatform {
1729
789
  /**
1730
790
  * The destination type.
1731
- * @type {string}
1732
- * @memberof AutomationInPlatform
1733
791
  */
1734
792
  type: AutomationInPlatformTypeEnum;
1735
793
  }
@@ -1739,549 +797,213 @@ export declare const AutomationInPlatformTypeEnum: {
1739
797
  export type AutomationInPlatformTypeEnum = (typeof AutomationInPlatformTypeEnum)[keyof typeof AutomationInPlatformTypeEnum];
1740
798
  /**
1741
799
  * Filter in form of direct MAQL query.
1742
- * @export
1743
- * @interface AutomationInlineFilterDefinition
1744
800
  */
1745
801
  export interface AutomationInlineFilterDefinition {
1746
- /**
1747
- *
1748
- * @type {AutomationInlineFilterDefinitionInline}
1749
- * @memberof AutomationInlineFilterDefinition
1750
- */
1751
802
  inline: AutomationInlineFilterDefinitionInline;
1752
803
  }
1753
- /**
1754
- *
1755
- * @export
1756
- * @interface AutomationInlineFilterDefinitionInline
1757
- */
1758
804
  export interface AutomationInlineFilterDefinitionInline {
1759
805
  /**
1760
806
  * MAQL query representing the filter.
1761
- * @type {string}
1762
- * @memberof AutomationInlineFilterDefinitionInline
1763
807
  */
1764
808
  filter: string;
1765
- /**
1766
- *
1767
- * @type {string}
1768
- * @memberof AutomationInlineFilterDefinitionInline
1769
- */
1770
809
  localIdentifier?: string;
1771
- /**
1772
- *
1773
- * @type {boolean}
1774
- * @memberof AutomationInlineFilterDefinitionInline
1775
- */
1776
810
  applyOnResult?: boolean;
1777
811
  }
1778
812
  /**
1779
813
  * Metric defined by the raw MAQL query.
1780
- * @export
1781
- * @interface AutomationInlineMeasureDefinition
1782
814
  */
1783
815
  export interface AutomationInlineMeasureDefinition {
1784
- /**
1785
- *
1786
- * @type {AutomationInlineMeasureDefinitionInline}
1787
- * @memberof AutomationInlineMeasureDefinition
1788
- */
1789
816
  inline: AutomationInlineMeasureDefinitionInline;
1790
817
  }
1791
- /**
1792
- *
1793
- * @export
1794
- * @interface AutomationInlineMeasureDefinitionInline
1795
- */
1796
818
  export interface AutomationInlineMeasureDefinitionInline {
1797
819
  /**
1798
820
  * MAQL query defining the metric.
1799
- * @type {string}
1800
- * @memberof AutomationInlineMeasureDefinitionInline
1801
821
  */
1802
822
  maql: string;
1803
823
  }
1804
- /**
1805
- *
1806
- * @export
1807
- * @interface AutomationLocalIdentifier
1808
- */
1809
824
  export interface AutomationLocalIdentifier {
1810
825
  /**
1811
826
  * Local identifier of the metric to be compared.
1812
- * @type {string}
1813
- * @memberof AutomationLocalIdentifier
1814
827
  */
1815
828
  localIdentifier: string;
1816
829
  /**
1817
830
  * Metric format.
1818
- * @type {string}
1819
- * @memberof AutomationLocalIdentifier
1820
831
  */
1821
832
  format?: string | null;
1822
833
  /**
1823
834
  * Metric title.
1824
- * @type {string}
1825
- * @memberof AutomationLocalIdentifier
1826
835
  */
1827
836
  title?: string | null;
1828
837
  }
1829
838
  /**
1830
839
  * @type AutomationMeasureDefinition
1831
840
  * Abstract metric definition type
1832
- * @export
1833
841
  */
1834
842
  export type AutomationMeasureDefinition = AutomationArithmeticMeasureDefinition | AutomationInlineMeasureDefinition | AutomationPopMeasureDefinition | AutomationSimpleMeasureDefinition;
1835
843
  /**
1836
844
  * Metric is a quantity that is calculated from the data.
1837
- * @export
1838
- * @interface AutomationMeasureItem
1839
845
  */
1840
846
  export interface AutomationMeasureItem {
1841
847
  /**
1842
848
  * Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
1843
- * @type {string}
1844
- * @memberof AutomationMeasureItem
1845
- */
1846
- localIdentifier: string;
1847
- /**
1848
- *
1849
- * @type {AutomationArithmeticMeasureDefinition | AutomationInlineMeasureDefinition | AutomationPopDatasetMeasureDefinition | AutomationPopDateMeasureDefinition | AutomationPopMeasureDefinition | AutomationSimpleMeasureDefinition}
1850
- * @memberof AutomationMeasureItem
1851
849
  */
1852
- definition: AutomationArithmeticMeasureDefinition | AutomationInlineMeasureDefinition | AutomationPopDatasetMeasureDefinition | AutomationPopDateMeasureDefinition | AutomationPopMeasureDefinition | AutomationSimpleMeasureDefinition;
850
+ localIdentifier: string;
851
+ definition: AutomationMeasureItemDefinition;
1853
852
  }
853
+ /**
854
+ * @type AutomationMeasureItemDefinition
855
+ */
856
+ export type AutomationMeasureItemDefinition = AutomationArithmeticMeasureDefinition | AutomationInlineMeasureDefinition | AutomationPopDatasetMeasureDefinition | AutomationPopDateMeasureDefinition | AutomationPopMeasureDefinition | AutomationSimpleMeasureDefinition;
1854
857
  /**
1855
858
  * @type AutomationMeasureValueFilter
1856
859
  * Abstract filter definition type filtering by the value of the metric.
1857
- * @export
1858
860
  */
1859
861
  export type AutomationMeasureValueFilter = AutomationComparisonMeasureValueFilter | AutomationRangeMeasureValueFilter;
1860
- /**
1861
- *
1862
- * @export
1863
- * @interface AutomationMetricRecord
1864
- */
1865
862
  export interface AutomationMetricRecord {
1866
- /**
1867
- *
1868
- * @type {number}
1869
- * @memberof AutomationMetricRecord
1870
- */
1871
863
  value: number;
1872
- /**
1873
- *
1874
- * @type {string}
1875
- * @memberof AutomationMetricRecord
1876
- */
1877
864
  formattedValue?: string;
1878
865
  }
1879
866
  /**
1880
867
  * Filter able to limit element values by label and related selected negated elements.
1881
- * @export
1882
- * @interface AutomationNegativeAttributeFilter
1883
868
  */
1884
869
  export interface AutomationNegativeAttributeFilter {
1885
- /**
1886
- *
1887
- * @type {AutomationNegativeAttributeFilterNegativeAttributeFilter}
1888
- * @memberof AutomationNegativeAttributeFilter
1889
- */
1890
870
  negativeAttributeFilter: AutomationNegativeAttributeFilterNegativeAttributeFilter;
1891
871
  }
1892
- /**
1893
- *
1894
- * @export
1895
- * @interface AutomationNegativeAttributeFilterNegativeAttributeFilter
1896
- */
1897
872
  export interface AutomationNegativeAttributeFilterNegativeAttributeFilter {
1898
- /**
1899
- *
1900
- * @type {AutomationAttributeFilterElements}
1901
- * @memberof AutomationNegativeAttributeFilterNegativeAttributeFilter
1902
- */
1903
873
  notIn: AutomationAttributeFilterElements;
1904
- /**
1905
- *
1906
- * @type {string}
1907
- * @memberof AutomationNegativeAttributeFilterNegativeAttributeFilter
1908
- */
1909
874
  localIdentifier?: string;
1910
- /**
1911
- *
1912
- * @type {boolean}
1913
- * @memberof AutomationNegativeAttributeFilterNegativeAttributeFilter
1914
- */
1915
875
  applyOnResult?: boolean;
1916
- /**
1917
- *
1918
- * @type {AutomationAfmIdentifier}
1919
- * @memberof AutomationNegativeAttributeFilterNegativeAttributeFilter
1920
- */
1921
876
  label: AutomationAfmIdentifier;
1922
877
  }
1923
- /**
1924
- *
1925
- * @export
1926
- * @interface AutomationNotification
1927
- */
1928
878
  export interface AutomationNotification {
1929
- /**
1930
- *
1931
- * @type {string}
1932
- * @memberof AutomationNotification
1933
- */
1934
879
  id: string;
1935
- /**
1936
- *
1937
- * @type {string}
1938
- * @memberof AutomationNotification
1939
- */
1940
880
  workspaceId?: string;
1941
- /**
1942
- *
1943
- * @type {string}
1944
- * @memberof AutomationNotification
1945
- */
1946
881
  automationId?: string;
1947
- /**
1948
- *
1949
- * @type {AutomationAutomationNotification | AutomationTestNotification}
1950
- * @memberof AutomationNotification
1951
- */
1952
- data: AutomationAutomationNotification | AutomationTestNotification;
1953
- /**
1954
- *
1955
- * @type {boolean}
1956
- * @memberof AutomationNotification
1957
- */
882
+ data: AutomationNotificationData;
1958
883
  isRead: boolean;
1959
- /**
1960
- *
1961
- * @type {string}
1962
- * @memberof AutomationNotification
1963
- */
1964
884
  createdAt: string;
1965
885
  }
1966
886
  /**
1967
887
  * @type AutomationNotificationChannelDestination
1968
- * @export
1969
888
  */
1970
889
  export type AutomationNotificationChannelDestination = AutomationDefaultSmtp | AutomationInPlatform | AutomationSmtp | AutomationWebhook;
1971
- /**
1972
- *
1973
- * @export
1974
- * @interface AutomationNotificationContent
1975
- */
1976
890
  export interface AutomationNotificationContent {
1977
- /**
1978
- *
1979
- * @type {string}
1980
- * @memberof AutomationNotificationContent
1981
- */
1982
891
  type: string;
1983
892
  }
1984
893
  /**
1985
- *
1986
- * @export
1987
- * @interface AutomationNotificationFilter
894
+ * @type AutomationNotificationData
1988
895
  */
896
+ export type AutomationNotificationData = AutomationAutomationNotification | AutomationTestNotification;
1989
897
  export interface AutomationNotificationFilter {
1990
- /**
1991
- *
1992
- * @type {string}
1993
- * @memberof AutomationNotificationFilter
1994
- */
1995
898
  title: string;
1996
- /**
1997
- *
1998
- * @type {string}
1999
- * @memberof AutomationNotificationFilter
2000
- */
2001
899
  filter: string;
2002
900
  }
2003
- /**
2004
- *
2005
- * @export
2006
- * @interface AutomationNotifications
2007
- */
2008
901
  export interface AutomationNotifications {
2009
- /**
2010
- *
2011
- * @type {Array<AutomationNotification>}
2012
- * @memberof AutomationNotifications
2013
- */
2014
902
  data: Array<AutomationNotification>;
2015
- /**
2016
- *
2017
- * @type {AutomationNotificationsMeta}
2018
- * @memberof AutomationNotifications
2019
- */
2020
903
  meta: AutomationNotificationsMeta;
2021
904
  }
2022
- /**
2023
- *
2024
- * @export
2025
- * @interface AutomationNotificationsMeta
2026
- */
2027
905
  export interface AutomationNotificationsMeta {
2028
- /**
2029
- *
2030
- * @type {AutomationNotificationsMetaTotal}
2031
- * @memberof AutomationNotificationsMeta
2032
- */
2033
906
  total?: AutomationNotificationsMetaTotal;
2034
907
  }
2035
- /**
2036
- *
2037
- * @export
2038
- * @interface AutomationNotificationsMetaTotal
2039
- */
2040
908
  export interface AutomationNotificationsMetaTotal {
2041
- /**
2042
- *
2043
- * @type {number}
2044
- * @memberof AutomationNotificationsMetaTotal
2045
- */
2046
909
  unread: number;
2047
- /**
2048
- *
2049
- * @type {number}
2050
- * @memberof AutomationNotificationsMetaTotal
2051
- */
2052
910
  all: number;
2053
911
  }
2054
- /**
2055
- *
2056
- * @export
2057
- * @interface AutomationOver
2058
- */
2059
912
  export interface AutomationOver {
2060
- /**
2061
- *
2062
- * @type {Array<AutomationIdentifierRef>}
2063
- * @memberof AutomationOver
2064
- */
2065
913
  attributes: Array<AutomationIdentifierRef>;
2066
914
  }
2067
915
  /**
2068
916
  * Custom CSS styles for the table. (PDF, HTML)
2069
- * @export
2070
- * @interface AutomationPdfTableStyle
2071
917
  */
2072
918
  export interface AutomationPdfTableStyle {
2073
919
  /**
2074
920
  * CSS selector where to apply given properties.
2075
- * @type {string}
2076
- * @memberof AutomationPdfTableStyle
2077
921
  */
2078
922
  selector: string;
2079
923
  /**
2080
924
  * List of CSS properties.
2081
- * @type {Array<AutomationPdfTableStyleProperty>}
2082
- * @memberof AutomationPdfTableStyle
2083
925
  */
2084
926
  properties?: Array<AutomationPdfTableStyleProperty>;
2085
927
  }
2086
928
  /**
2087
929
  * CSS property.
2088
- * @export
2089
- * @interface AutomationPdfTableStyleProperty
2090
930
  */
2091
931
  export interface AutomationPdfTableStyleProperty {
2092
932
  /**
2093
933
  * CSS property key.
2094
- * @type {string}
2095
- * @memberof AutomationPdfTableStyleProperty
2096
934
  */
2097
935
  key: string;
2098
936
  /**
2099
937
  * CSS property value.
2100
- * @type {string}
2101
- * @memberof AutomationPdfTableStyleProperty
2102
938
  */
2103
939
  value: string;
2104
940
  }
2105
941
  /**
2106
942
  * Combination of the date data set to use and how many periods ago to calculate the previous period for.
2107
- * @export
2108
- * @interface AutomationPopDataset
2109
943
  */
2110
944
  export interface AutomationPopDataset {
2111
- /**
2112
- *
2113
- * @type {AutomationAfmObjectIdentifierDataset}
2114
- * @memberof AutomationPopDataset
2115
- */
2116
945
  dataset: AutomationAfmObjectIdentifierDataset;
2117
946
  /**
2118
947
  * Number of periods ago to calculate the previous period for.
2119
- * @type {number}
2120
- * @memberof AutomationPopDataset
2121
948
  */
2122
949
  periodsAgo: number;
2123
950
  }
2124
951
  /**
2125
952
  * Previous period type of metric.
2126
- * @export
2127
- * @interface AutomationPopDatasetMeasureDefinition
2128
953
  */
2129
954
  export interface AutomationPopDatasetMeasureDefinition {
2130
- /**
2131
- *
2132
- * @type {AutomationPopDatasetMeasureDefinitionPreviousPeriodMeasure}
2133
- * @memberof AutomationPopDatasetMeasureDefinition
2134
- */
2135
955
  previousPeriodMeasure: AutomationPopDatasetMeasureDefinitionPreviousPeriodMeasure;
2136
956
  }
2137
- /**
2138
- *
2139
- * @export
2140
- * @interface AutomationPopDatasetMeasureDefinitionPreviousPeriodMeasure
2141
- */
2142
957
  export interface AutomationPopDatasetMeasureDefinitionPreviousPeriodMeasure {
2143
- /**
2144
- *
2145
- * @type {AutomationAfmLocalIdentifier}
2146
- * @memberof AutomationPopDatasetMeasureDefinitionPreviousPeriodMeasure
2147
- */
2148
958
  measureIdentifier: AutomationAfmLocalIdentifier;
2149
959
  /**
2150
960
  * Specification of which date data sets to use for determining the period to calculate the previous period for.
2151
- * @type {Array<AutomationPopDataset>}
2152
- * @memberof AutomationPopDatasetMeasureDefinitionPreviousPeriodMeasure
2153
961
  */
2154
962
  dateDatasets: Array<AutomationPopDataset>;
2155
963
  }
2156
964
  /**
2157
965
  * Combination of the date attribute to use and how many periods ago to calculate the PoP for.
2158
- * @export
2159
- * @interface AutomationPopDate
2160
966
  */
2161
967
  export interface AutomationPopDate {
2162
- /**
2163
- *
2164
- * @type {AutomationAfmObjectIdentifierAttribute}
2165
- * @memberof AutomationPopDate
2166
- */
2167
968
  attribute: AutomationAfmObjectIdentifierAttribute;
2168
969
  /**
2169
970
  * Number of periods ago to calculate the previous period for.
2170
- * @type {number}
2171
- * @memberof AutomationPopDate
2172
971
  */
2173
972
  periodsAgo: number;
2174
973
  }
2175
974
  /**
2176
975
  * Period over period type of metric.
2177
- * @export
2178
- * @interface AutomationPopDateMeasureDefinition
2179
976
  */
2180
977
  export interface AutomationPopDateMeasureDefinition {
2181
- /**
2182
- *
2183
- * @type {AutomationPopDateMeasureDefinitionOverPeriodMeasure}
2184
- * @memberof AutomationPopDateMeasureDefinition
2185
- */
2186
978
  overPeriodMeasure: AutomationPopDateMeasureDefinitionOverPeriodMeasure;
2187
979
  }
2188
- /**
2189
- *
2190
- * @export
2191
- * @interface AutomationPopDateMeasureDefinitionOverPeriodMeasure
2192
- */
2193
980
  export interface AutomationPopDateMeasureDefinitionOverPeriodMeasure {
2194
- /**
2195
- *
2196
- * @type {AutomationAfmLocalIdentifier}
2197
- * @memberof AutomationPopDateMeasureDefinitionOverPeriodMeasure
2198
- */
2199
981
  measureIdentifier: AutomationAfmLocalIdentifier;
2200
982
  /**
2201
983
  * Attributes to use for determining the period to calculate the PoP for.
2202
- * @type {Array<AutomationPopDate>}
2203
- * @memberof AutomationPopDateMeasureDefinitionOverPeriodMeasure
2204
984
  */
2205
985
  dateAttributes: Array<AutomationPopDate>;
2206
986
  }
2207
987
  /**
2208
988
  * @type AutomationPopMeasureDefinition
2209
- * @export
2210
989
  */
2211
990
  export type AutomationPopMeasureDefinition = AutomationPopDatasetMeasureDefinition | AutomationPopDateMeasureDefinition;
2212
991
  /**
2213
992
  * Filter able to limit element values by label and related selected elements.
2214
- * @export
2215
- * @interface AutomationPositiveAttributeFilter
2216
993
  */
2217
994
  export interface AutomationPositiveAttributeFilter {
2218
- /**
2219
- *
2220
- * @type {AutomationPositiveAttributeFilterPositiveAttributeFilter}
2221
- * @memberof AutomationPositiveAttributeFilter
2222
- */
2223
995
  positiveAttributeFilter: AutomationPositiveAttributeFilterPositiveAttributeFilter;
2224
996
  }
2225
- /**
2226
- *
2227
- * @export
2228
- * @interface AutomationPositiveAttributeFilterPositiveAttributeFilter
2229
- */
2230
997
  export interface AutomationPositiveAttributeFilterPositiveAttributeFilter {
2231
- /**
2232
- *
2233
- * @type {AutomationAttributeFilterElements}
2234
- * @memberof AutomationPositiveAttributeFilterPositiveAttributeFilter
2235
- */
2236
998
  in: AutomationAttributeFilterElements;
2237
- /**
2238
- *
2239
- * @type {string}
2240
- * @memberof AutomationPositiveAttributeFilterPositiveAttributeFilter
2241
- */
2242
999
  localIdentifier?: string;
2243
- /**
2244
- *
2245
- * @type {boolean}
2246
- * @memberof AutomationPositiveAttributeFilterPositiveAttributeFilter
2247
- */
2248
1000
  applyOnResult?: boolean;
2249
- /**
2250
- *
2251
- * @type {AutomationAfmIdentifier}
2252
- * @memberof AutomationPositiveAttributeFilterPositiveAttributeFilter
2253
- */
2254
1001
  label: AutomationAfmIdentifier;
2255
1002
  }
2256
- /**
2257
- *
2258
- * @export
2259
- * @interface AutomationRange
2260
- */
2261
1003
  export interface AutomationRange {
2262
- /**
2263
- *
2264
- * @type {string}
2265
- * @memberof AutomationRange
2266
- */
2267
1004
  operator: AutomationRangeOperatorEnum;
2268
- /**
2269
- *
2270
- * @type {AutomationLocalIdentifier}
2271
- * @memberof AutomationRange
2272
- */
2273
1005
  measure: AutomationLocalIdentifier;
2274
- /**
2275
- *
2276
- * @type {AutomationValue}
2277
- * @memberof AutomationRange
2278
- */
2279
1006
  from: AutomationValue;
2280
- /**
2281
- *
2282
- * @type {AutomationValue}
2283
- * @memberof AutomationRange
2284
- */
2285
1007
  to: AutomationValue;
2286
1008
  }
2287
1009
  export declare const AutomationRangeOperatorEnum: {
@@ -2291,70 +1013,24 @@ export declare const AutomationRangeOperatorEnum: {
2291
1013
  export type AutomationRangeOperatorEnum = (typeof AutomationRangeOperatorEnum)[keyof typeof AutomationRangeOperatorEnum];
2292
1014
  /**
2293
1015
  * Filter the result by comparing specified metric to given range of values.
2294
- * @export
2295
- * @interface AutomationRangeMeasureValueFilter
2296
1016
  */
2297
1017
  export interface AutomationRangeMeasureValueFilter {
2298
- /**
2299
- *
2300
- * @type {AutomationRangeMeasureValueFilterRangeMeasureValueFilter}
2301
- * @memberof AutomationRangeMeasureValueFilter
2302
- */
2303
1018
  rangeMeasureValueFilter: AutomationRangeMeasureValueFilterRangeMeasureValueFilter;
2304
1019
  }
2305
- /**
2306
- *
2307
- * @export
2308
- * @interface AutomationRangeMeasureValueFilterRangeMeasureValueFilter
2309
- */
2310
1020
  export interface AutomationRangeMeasureValueFilterRangeMeasureValueFilter {
2311
1021
  /**
2312
1022
  * References to the attributes to be used when filtering.
2313
- * @type {Array<AutomationAfmIdentifier>}
2314
- * @memberof AutomationRangeMeasureValueFilterRangeMeasureValueFilter
2315
1023
  */
2316
1024
  dimensionality?: Array<AutomationAfmIdentifier>;
2317
1025
  /**
2318
1026
  * A value that will be substituted for null values in the metric for the comparisons.
2319
- * @type {number}
2320
- * @memberof AutomationRangeMeasureValueFilterRangeMeasureValueFilter
2321
1027
  */
2322
1028
  treatNullValuesAs?: number;
2323
- /**
2324
- *
2325
- * @type {string}
2326
- * @memberof AutomationRangeMeasureValueFilterRangeMeasureValueFilter
2327
- */
2328
1029
  operator: AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
2329
- /**
2330
- *
2331
- * @type {number}
2332
- * @memberof AutomationRangeMeasureValueFilterRangeMeasureValueFilter
2333
- */
2334
1030
  from: number;
2335
- /**
2336
- *
2337
- * @type {number}
2338
- * @memberof AutomationRangeMeasureValueFilterRangeMeasureValueFilter
2339
- */
2340
1031
  to: number;
2341
- /**
2342
- *
2343
- * @type {string}
2344
- * @memberof AutomationRangeMeasureValueFilterRangeMeasureValueFilter
2345
- */
2346
1032
  localIdentifier?: string;
2347
- /**
2348
- *
2349
- * @type {boolean}
2350
- * @memberof AutomationRangeMeasureValueFilterRangeMeasureValueFilter
2351
- */
2352
1033
  applyOnResult?: boolean;
2353
- /**
2354
- *
2355
- * @type {AutomationAfmIdentifier}
2356
- * @memberof AutomationRangeMeasureValueFilterRangeMeasureValueFilter
2357
- */
2358
1034
  measure: AutomationAfmIdentifier;
2359
1035
  }
2360
1036
  export declare const AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum: {
@@ -2362,73 +1038,33 @@ export declare const AutomationRangeMeasureValueFilterRangeMeasureValueFilterOpe
2362
1038
  readonly NOT_BETWEEN: "NOT_BETWEEN";
2363
1039
  };
2364
1040
  export type AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = (typeof AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum)[keyof typeof AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum];
2365
- /**
2366
- *
2367
- * @export
2368
- * @interface AutomationRangeWrapper
2369
- */
2370
1041
  export interface AutomationRangeWrapper {
2371
- /**
2372
- *
2373
- * @type {AutomationRange}
2374
- * @memberof AutomationRangeWrapper
2375
- */
2376
1042
  range: AutomationRange;
2377
1043
  }
2378
1044
  /**
2379
1045
  * Filter the result on top/bottom N values according to given metric(s).
2380
- * @export
2381
- * @interface AutomationRankingFilter
2382
1046
  */
2383
1047
  export interface AutomationRankingFilter {
2384
- /**
2385
- *
2386
- * @type {AutomationRankingFilterRankingFilter}
2387
- * @memberof AutomationRankingFilter
2388
- */
2389
1048
  rankingFilter: AutomationRankingFilterRankingFilter;
2390
1049
  }
2391
- /**
2392
- *
2393
- * @export
2394
- * @interface AutomationRankingFilterRankingFilter
2395
- */
2396
1050
  export interface AutomationRankingFilterRankingFilter {
2397
1051
  /**
2398
1052
  * References to the attributes to be used when filtering.
2399
- * @type {Array<AutomationAfmIdentifier>}
2400
- * @memberof AutomationRankingFilterRankingFilter
2401
1053
  */
2402
1054
  dimensionality?: Array<AutomationAfmIdentifier>;
2403
1055
  /**
2404
1056
  * References to the metrics to be used when filtering.
2405
- * @type {Array<AutomationAfmIdentifier>}
2406
- * @memberof AutomationRankingFilterRankingFilter
2407
1057
  */
2408
1058
  measures: Array<AutomationAfmIdentifier>;
2409
1059
  /**
2410
1060
  * The type of ranking to use, TOP or BOTTOM.
2411
- * @type {string}
2412
- * @memberof AutomationRankingFilterRankingFilter
2413
1061
  */
2414
1062
  operator: AutomationRankingFilterRankingFilterOperatorEnum;
2415
1063
  /**
2416
1064
  * Number of top/bottom values to filter.
2417
- * @type {number}
2418
- * @memberof AutomationRankingFilterRankingFilter
2419
1065
  */
2420
1066
  value: number;
2421
- /**
2422
- *
2423
- * @type {string}
2424
- * @memberof AutomationRankingFilterRankingFilter
2425
- */
2426
1067
  localIdentifier?: string;
2427
- /**
2428
- *
2429
- * @type {boolean}
2430
- * @memberof AutomationRankingFilterRankingFilter
2431
- */
2432
1068
  applyOnResult?: boolean;
2433
1069
  }
2434
1070
  export declare const AutomationRankingFilterRankingFilterOperatorEnum: {
@@ -2438,48 +1074,34 @@ export declare const AutomationRankingFilterRankingFilterOperatorEnum: {
2438
1074
  export type AutomationRankingFilterRankingFilterOperatorEnum = (typeof AutomationRankingFilterRankingFilterOperatorEnum)[keyof typeof AutomationRankingFilterRankingFilterOperatorEnum];
2439
1075
  /**
2440
1076
  * Custom label object override.
2441
- * @export
2442
- * @interface AutomationRawCustomLabel
2443
1077
  */
2444
1078
  export interface AutomationRawCustomLabel {
2445
1079
  /**
2446
1080
  * Override value.
2447
- * @type {string}
2448
- * @memberof AutomationRawCustomLabel
2449
1081
  */
2450
1082
  title: string;
2451
1083
  }
2452
1084
  /**
2453
1085
  * Custom metric object override.
2454
- * @export
2455
- * @interface AutomationRawCustomMetric
2456
1086
  */
2457
1087
  export interface AutomationRawCustomMetric {
2458
1088
  /**
2459
1089
  * Metric title override.
2460
- * @type {string}
2461
- * @memberof AutomationRawCustomMetric
2462
1090
  */
2463
1091
  title: string;
2464
1092
  }
2465
1093
  /**
2466
1094
  * Custom cell value overrides (IDs will be replaced with specified values).
2467
- * @export
2468
- * @interface AutomationRawCustomOverride
2469
1095
  */
2470
1096
  export interface AutomationRawCustomOverride {
2471
1097
  /**
2472
1098
  * Map of CustomLabels with keys used as placeholders in export result.
2473
- * @type {{ [key: string]: AutomationRawCustomLabel; }}
2474
- * @memberof AutomationRawCustomOverride
2475
1099
  */
2476
1100
  labels?: {
2477
1101
  [key: string]: AutomationRawCustomLabel;
2478
1102
  };
2479
1103
  /**
2480
1104
  * Map of CustomMetrics with keys used as placeholders in export result.
2481
- * @type {{ [key: string]: AutomationRawCustomMetric; }}
2482
- * @memberof AutomationRawCustomOverride
2483
1105
  */
2484
1106
  metrics?: {
2485
1107
  [key: string]: AutomationRawCustomMetric;
@@ -2487,44 +1109,21 @@ export interface AutomationRawCustomOverride {
2487
1109
  }
2488
1110
  /**
2489
1111
  * Export request object describing the export properties and overrides for raw exports.
2490
- * @export
2491
- * @interface AutomationRawExportAutomationRequest
2492
1112
  */
2493
1113
  export interface AutomationRawExportAutomationRequest {
2494
1114
  /**
2495
1115
  * Requested resulting file type.
2496
- * @type {string}
2497
- * @memberof AutomationRawExportAutomationRequest
2498
- */
2499
- format: AutomationRawExportAutomationRequestFormatEnum;
2500
- /**
2501
- *
2502
- * @type {AutomationAFM}
2503
- * @memberof AutomationRawExportAutomationRequest
2504
1116
  */
1117
+ format: AutomationRawExportAutomationRequestFormatEnum;
2505
1118
  execution: AutomationAFM;
2506
1119
  /**
2507
1120
  * Filename of downloaded file without extension.
2508
- * @type {string}
2509
- * @memberof AutomationRawExportAutomationRequest
2510
1121
  */
2511
1122
  fileName: string;
2512
- /**
2513
- *
2514
- * @type {AutomationRawCustomOverride}
2515
- * @memberof AutomationRawExportAutomationRequest
2516
- */
2517
1123
  customOverride?: AutomationRawCustomOverride;
2518
- /**
2519
- *
2520
- * @type {AutomationExecutionSettings}
2521
- * @memberof AutomationRawExportAutomationRequest
2522
- */
2523
1124
  executionSettings?: AutomationExecutionSettings;
2524
1125
  /**
2525
1126
  * Metadata definition in free-form JSON format.
2526
- * @type {object}
2527
- * @memberof AutomationRawExportAutomationRequest
2528
1127
  */
2529
1128
  metadata?: object | null;
2530
1129
  }
@@ -2534,29 +1133,12 @@ export declare const AutomationRawExportAutomationRequestFormatEnum: {
2534
1133
  readonly CSV: "CSV";
2535
1134
  };
2536
1135
  export type AutomationRawExportAutomationRequestFormatEnum = (typeof AutomationRawExportAutomationRequestFormatEnum)[keyof typeof AutomationRawExportAutomationRequestFormatEnum];
2537
- /**
2538
- *
2539
- * @export
2540
- * @interface AutomationRelative
2541
- */
2542
1136
  export interface AutomationRelative {
2543
1137
  /**
2544
1138
  * Relative condition operator. INCREASES_BY - the metric increases by the specified value. DECREASES_BY - the metric decreases by the specified value. CHANGES_BY - the metric increases or decreases by the specified value.
2545
- * @type {string}
2546
- * @memberof AutomationRelative
2547
1139
  */
2548
1140
  operator: AutomationRelativeOperatorEnum;
2549
- /**
2550
- *
2551
- * @type {AutomationArithmeticMeasure}
2552
- * @memberof AutomationRelative
2553
- */
2554
1141
  measure: AutomationArithmeticMeasure;
2555
- /**
2556
- *
2557
- * @type {AutomationValue}
2558
- * @memberof AutomationRelative
2559
- */
2560
1142
  threshold: AutomationValue;
2561
1143
  }
2562
1144
  export declare const AutomationRelativeOperatorEnum: {
@@ -2565,29 +1147,9 @@ export declare const AutomationRelativeOperatorEnum: {
2565
1147
  readonly CHANGES_BY: "CHANGES_BY";
2566
1148
  };
2567
1149
  export type AutomationRelativeOperatorEnum = (typeof AutomationRelativeOperatorEnum)[keyof typeof AutomationRelativeOperatorEnum];
2568
- /**
2569
- *
2570
- * @export
2571
- * @interface AutomationRelativeBoundedDateFilter
2572
- */
2573
1150
  export interface AutomationRelativeBoundedDateFilter {
2574
- /**
2575
- *
2576
- * @type {string}
2577
- * @memberof AutomationRelativeBoundedDateFilter
2578
- */
2579
1151
  granularity: AutomationRelativeBoundedDateFilterGranularityEnum;
2580
- /**
2581
- *
2582
- * @type {number}
2583
- * @memberof AutomationRelativeBoundedDateFilter
2584
- */
2585
1152
  from?: number;
2586
- /**
2587
- *
2588
- * @type {number}
2589
- * @memberof AutomationRelativeBoundedDateFilter
2590
- */
2591
1153
  to?: number;
2592
1154
  }
2593
1155
  export declare const AutomationRelativeBoundedDateFilterGranularityEnum: {
@@ -2618,64 +1180,26 @@ export declare const AutomationRelativeBoundedDateFilterGranularityEnum: {
2618
1180
  export type AutomationRelativeBoundedDateFilterGranularityEnum = (typeof AutomationRelativeBoundedDateFilterGranularityEnum)[keyof typeof AutomationRelativeBoundedDateFilterGranularityEnum];
2619
1181
  /**
2620
1182
  * 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.
2621
- * @export
2622
- * @interface AutomationRelativeDateFilter
2623
1183
  */
2624
1184
  export interface AutomationRelativeDateFilter {
2625
- /**
2626
- *
2627
- * @type {AutomationRelativeDateFilterRelativeDateFilter}
2628
- * @memberof AutomationRelativeDateFilter
2629
- */
2630
1185
  relativeDateFilter: AutomationRelativeDateFilterRelativeDateFilter;
2631
1186
  }
2632
- /**
2633
- *
2634
- * @export
2635
- * @interface AutomationRelativeDateFilterRelativeDateFilter
2636
- */
2637
1187
  export interface AutomationRelativeDateFilterRelativeDateFilter {
2638
1188
  /**
2639
1189
  * Date granularity specifying particular date attribute in given dimension.
2640
- * @type {string}
2641
- * @memberof AutomationRelativeDateFilterRelativeDateFilter
2642
1190
  */
2643
1191
  granularity: AutomationRelativeDateFilterRelativeDateFilterGranularityEnum;
2644
1192
  /**
2645
1193
  * 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\').
2646
- * @type {number}
2647
- * @memberof AutomationRelativeDateFilterRelativeDateFilter
2648
1194
  */
2649
1195
  from: number;
2650
1196
  /**
2651
1197
  * 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, ...).
2652
- * @type {number}
2653
- * @memberof AutomationRelativeDateFilterRelativeDateFilter
2654
1198
  */
2655
1199
  to: number;
2656
- /**
2657
- *
2658
- * @type {string}
2659
- * @memberof AutomationRelativeDateFilterRelativeDateFilter
2660
- */
2661
1200
  localIdentifier?: string;
2662
- /**
2663
- *
2664
- * @type {boolean}
2665
- * @memberof AutomationRelativeDateFilterRelativeDateFilter
2666
- */
2667
1201
  applyOnResult?: boolean;
2668
- /**
2669
- *
2670
- * @type {AutomationBoundedFilter}
2671
- * @memberof AutomationRelativeDateFilterRelativeDateFilter
2672
- */
2673
1202
  boundedFilter?: AutomationBoundedFilter;
2674
- /**
2675
- *
2676
- * @type {AutomationAfmObjectIdentifierDataset}
2677
- * @memberof AutomationRelativeDateFilterRelativeDateFilter
2678
- */
2679
1203
  dataset: AutomationAfmObjectIdentifierDataset;
2680
1204
  }
2681
1205
  export declare const AutomationRelativeDateFilterRelativeDateFilterGranularityEnum: {
@@ -2697,109 +1221,60 @@ export declare const AutomationRelativeDateFilterRelativeDateFilterGranularityEn
2697
1221
  readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
2698
1222
  };
2699
1223
  export type AutomationRelativeDateFilterRelativeDateFilterGranularityEnum = (typeof AutomationRelativeDateFilterRelativeDateFilterGranularityEnum)[keyof typeof AutomationRelativeDateFilterRelativeDateFilterGranularityEnum];
2700
- /**
2701
- *
2702
- * @export
2703
- * @interface AutomationRelativeWrapper
2704
- */
2705
1224
  export interface AutomationRelativeWrapper {
2706
- /**
2707
- *
2708
- * @type {AutomationRelative}
2709
- * @memberof AutomationRelativeWrapper
2710
- */
2711
1225
  relative: AutomationRelative;
2712
1226
  }
2713
1227
  /**
2714
1228
  * Additional settings.
2715
- * @export
2716
- * @interface AutomationSettings
2717
1229
  */
2718
1230
  export interface AutomationSettings {
2719
1231
  /**
2720
1232
  * Include export info sheet in the exported file. Works only with `visualizationObject`. (XLSX)
2721
- * @type {boolean}
2722
- * @memberof AutomationSettings
2723
1233
  */
2724
1234
  exportInfo?: boolean;
2725
1235
  /**
2726
1236
  * Merge equal headers in neighbouring cells. (XLSX)
2727
- * @type {boolean}
2728
- * @memberof AutomationSettings
2729
1237
  */
2730
1238
  mergeHeaders?: boolean;
2731
1239
  /**
2732
1240
  * Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)
2733
- * @type {boolean}
2734
- * @memberof AutomationSettings
2735
1241
  */
2736
1242
  showFilters?: boolean;
2737
1243
  /**
2738
1244
  * Page size and orientation. (PDF)
2739
- * @type {string}
2740
- * @memberof AutomationSettings
2741
1245
  */
2742
1246
  pdfPageSize?: string;
2743
1247
  /**
2744
1248
  * Custom CSS styles for the table. (PDF, HTML)
2745
- * @type {Array<AutomationPdfTableStyle>}
2746
- * @memberof AutomationSettings
2747
1249
  */
2748
1250
  pdfTableStyle?: Array<AutomationPdfTableStyle>;
2749
1251
  /**
2750
1252
  * Top left header content. (PDF)
2751
- * @type {string}
2752
- * @memberof AutomationSettings
2753
1253
  */
2754
1254
  pdfTopLeftContent?: string;
2755
1255
  /**
2756
1256
  * Top right header content. (PDF)
2757
- * @type {string}
2758
- * @memberof AutomationSettings
2759
1257
  */
2760
1258
  pdfTopRightContent?: string;
2761
1259
  }
2762
1260
  /**
2763
1261
  * Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
2764
- * @export
2765
- * @interface AutomationSimpleMeasureDefinition
2766
1262
  */
2767
1263
  export interface AutomationSimpleMeasureDefinition {
2768
- /**
2769
- *
2770
- * @type {AutomationSimpleMeasureDefinitionMeasure}
2771
- * @memberof AutomationSimpleMeasureDefinition
2772
- */
2773
1264
  measure: AutomationSimpleMeasureDefinitionMeasure;
2774
1265
  }
2775
- /**
2776
- *
2777
- * @export
2778
- * @interface AutomationSimpleMeasureDefinitionMeasure
2779
- */
2780
1266
  export interface AutomationSimpleMeasureDefinitionMeasure {
2781
- /**
2782
- *
2783
- * @type {AutomationAfmObjectIdentifierCore}
2784
- * @memberof AutomationSimpleMeasureDefinitionMeasure
2785
- */
2786
1267
  item: AutomationAfmObjectIdentifierCore;
2787
1268
  /**
2788
1269
  * Definition of aggregation type of the metric.
2789
- * @type {string}
2790
- * @memberof AutomationSimpleMeasureDefinitionMeasure
2791
1270
  */
2792
1271
  aggregation?: AutomationSimpleMeasureDefinitionMeasureAggregationEnum;
2793
1272
  /**
2794
1273
  * If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).
2795
- * @type {boolean}
2796
- * @memberof AutomationSimpleMeasureDefinitionMeasure
2797
1274
  */
2798
1275
  computeRatio?: boolean;
2799
1276
  /**
2800
1277
  * Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.
2801
- * @type {Array<AutomationFilterDefinitionForSimpleMeasure>}
2802
- * @memberof AutomationSimpleMeasureDefinitionMeasure
2803
1278
  */
2804
1279
  filters?: Array<AutomationFilterDefinitionForSimpleMeasure>;
2805
1280
  }
@@ -2816,50 +1291,34 @@ export declare const AutomationSimpleMeasureDefinitionMeasureAggregationEnum: {
2816
1291
  export type AutomationSimpleMeasureDefinitionMeasureAggregationEnum = (typeof AutomationSimpleMeasureDefinitionMeasureAggregationEnum)[keyof typeof AutomationSimpleMeasureDefinitionMeasureAggregationEnum];
2817
1292
  /**
2818
1293
  * Export request object describing the export properties and metadata for slides exports.
2819
- * @export
2820
- * @interface AutomationSlidesExportRequest
2821
1294
  */
2822
1295
  export interface AutomationSlidesExportRequest {
2823
1296
  /**
2824
1297
  * Requested resulting file type.
2825
- * @type {string}
2826
- * @memberof AutomationSlidesExportRequest
2827
1298
  */
2828
1299
  format: AutomationSlidesExportRequestFormatEnum;
2829
1300
  /**
2830
1301
  * File name to be used for retrieving the pdf document.
2831
- * @type {string}
2832
- * @memberof AutomationSlidesExportRequest
2833
1302
  */
2834
1303
  fileName: string;
2835
1304
  /**
2836
1305
  * Dashboard identifier
2837
- * @type {string}
2838
- * @memberof AutomationSlidesExportRequest
2839
1306
  */
2840
1307
  dashboardId?: string;
2841
1308
  /**
2842
1309
  * List of widget identifiers to be exported. Note that only one widget is currently supported.
2843
- * @type {Array<string>}
2844
- * @memberof AutomationSlidesExportRequest
2845
1310
  */
2846
1311
  widgetIds?: Array<string>;
2847
1312
  /**
2848
1313
  * List of visualization ids to be exported. Note that only one visualization is currently supported.
2849
- * @type {Array<string>}
2850
- * @memberof AutomationSlidesExportRequest
2851
1314
  */
2852
1315
  visualizationIds?: Array<string>;
2853
1316
  /**
2854
1317
  * Metadata definition in free-form JSON format.
2855
- * @type {object}
2856
- * @memberof AutomationSlidesExportRequest
2857
1318
  */
2858
1319
  metadata?: object | null;
2859
1320
  /**
2860
1321
  * Export template identifier.
2861
- * @type {string}
2862
- * @memberof AutomationSlidesExportRequest
2863
1322
  */
2864
1323
  templateId?: string | null;
2865
1324
  }
@@ -2870,50 +1329,34 @@ export declare const AutomationSlidesExportRequestFormatEnum: {
2870
1329
  export type AutomationSlidesExportRequestFormatEnum = (typeof AutomationSlidesExportRequestFormatEnum)[keyof typeof AutomationSlidesExportRequestFormatEnum];
2871
1330
  /**
2872
1331
  * Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update
2873
- * @export
2874
- * @interface AutomationSmtp
2875
1332
  */
2876
1333
  export interface AutomationSmtp {
2877
1334
  /**
2878
1335
  * E-mail address to send notifications from.
2879
- * @type {string}
2880
- * @memberof AutomationSmtp
2881
1336
  */
2882
1337
  fromEmail?: string;
2883
1338
  /**
2884
1339
  * An optional e-mail name to send notifications from.
2885
- * @type {string}
2886
- * @memberof AutomationSmtp
2887
1340
  */
2888
1341
  fromEmailName?: string;
2889
1342
  /**
2890
1343
  * The SMTP server address.
2891
- * @type {string}
2892
- * @memberof AutomationSmtp
2893
1344
  */
2894
1345
  host?: string;
2895
1346
  /**
2896
1347
  * The SMTP server port.
2897
- * @type {number}
2898
- * @memberof AutomationSmtp
2899
1348
  */
2900
1349
  port?: AutomationSmtpPortEnum;
2901
1350
  /**
2902
1351
  * The SMTP server username.
2903
- * @type {string}
2904
- * @memberof AutomationSmtp
2905
1352
  */
2906
1353
  username?: string;
2907
1354
  /**
2908
1355
  * The SMTP server password.
2909
- * @type {string}
2910
- * @memberof AutomationSmtp
2911
1356
  */
2912
1357
  password?: string;
2913
1358
  /**
2914
1359
  * The destination type.
2915
- * @type {string}
2916
- * @memberof AutomationSmtp
2917
1360
  */
2918
1361
  type: AutomationSmtpTypeEnum;
2919
1362
  }
@@ -2930,62 +1373,36 @@ export declare const AutomationSmtpTypeEnum: {
2930
1373
  export type AutomationSmtpTypeEnum = (typeof AutomationSmtpTypeEnum)[keyof typeof AutomationSmtpTypeEnum];
2931
1374
  /**
2932
1375
  * Export request object describing the export properties and overrides for tabular exports.
2933
- * @export
2934
- * @interface AutomationTabularExportRequest
2935
1376
  */
2936
1377
  export interface AutomationTabularExportRequest {
2937
1378
  /**
2938
1379
  * Expected file format.
2939
- * @type {string}
2940
- * @memberof AutomationTabularExportRequest
2941
1380
  */
2942
1381
  format: AutomationTabularExportRequestFormatEnum;
2943
1382
  /**
2944
1383
  * Execution result identifier.
2945
- * @type {string}
2946
- * @memberof AutomationTabularExportRequest
2947
1384
  */
2948
1385
  executionResult?: string;
2949
1386
  /**
2950
1387
  * Filename of downloaded file without extension.
2951
- * @type {string}
2952
- * @memberof AutomationTabularExportRequest
2953
1388
  */
2954
1389
  fileName: string;
2955
- /**
2956
- *
2957
- * @type {AutomationSettings}
2958
- * @memberof AutomationTabularExportRequest
2959
- */
2960
1390
  settings?: AutomationSettings;
2961
- /**
2962
- *
2963
- * @type {AutomationCustomOverride}
2964
- * @memberof AutomationTabularExportRequest
2965
- */
2966
1391
  customOverride?: AutomationCustomOverride;
2967
1392
  /**
2968
1393
  * Visualization object identifier. Alternative to executionResult property.
2969
- * @type {string}
2970
- * @memberof AutomationTabularExportRequest
2971
1394
  */
2972
1395
  visualizationObject?: string;
2973
1396
  /**
2974
1397
  * Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given.
2975
- * @type {Array<object>}
2976
- * @memberof AutomationTabularExportRequest
2977
1398
  */
2978
1399
  visualizationObjectCustomFilters?: Array<object>;
2979
1400
  /**
2980
1401
  * Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
2981
- * @type {string}
2982
- * @memberof AutomationTabularExportRequest
2983
1402
  */
2984
1403
  relatedDashboardId?: string;
2985
1404
  /**
2986
1405
  * Metadata definition in free-form JSON format.
2987
- * @type {object}
2988
- * @memberof AutomationTabularExportRequest
2989
1406
  */
2990
1407
  metadata?: object | null;
2991
1408
  }
@@ -2998,172 +1415,86 @@ export declare const AutomationTabularExportRequestFormatEnum: {
2998
1415
  export type AutomationTabularExportRequestFormatEnum = (typeof AutomationTabularExportRequestFormatEnum)[keyof typeof AutomationTabularExportRequestFormatEnum];
2999
1416
  /**
3000
1417
  * Request body with notification channel destination to test.
3001
- * @export
3002
- * @interface AutomationTestDestinationRequest
3003
1418
  */
3004
1419
  export interface AutomationTestDestinationRequest {
3005
- /**
3006
- *
3007
- * @type {AutomationDefaultSmtp | AutomationInPlatform | AutomationSmtp | AutomationWebhook}
3008
- * @memberof AutomationTestDestinationRequest
3009
- */
3010
- destination: AutomationDefaultSmtp | AutomationInPlatform | AutomationSmtp | AutomationWebhook;
1420
+ destination: AutomationTestDestinationRequestDestination;
3011
1421
  /**
3012
1422
  * External recipients of the test result.
3013
- * @type {Array<AutomationAutomationExternalRecipient>}
3014
- * @memberof AutomationTestDestinationRequest
3015
1423
  */
3016
1424
  externalRecipients?: Array<AutomationAutomationExternalRecipient> | null;
3017
1425
  }
3018
1426
  /**
3019
- *
3020
- * @export
3021
- * @interface AutomationTestNotification
1427
+ * @type AutomationTestDestinationRequestDestination
3022
1428
  */
1429
+ export type AutomationTestDestinationRequestDestination = AutomationDefaultSmtp | AutomationInPlatform | AutomationSmtp | AutomationWebhook;
3023
1430
  export interface AutomationTestNotification extends AutomationNotificationContent {
3024
- /**
3025
- *
3026
- * @type {string}
3027
- * @memberof AutomationTestNotification
3028
- */
3029
1431
  message: string;
3030
1432
  }
3031
- /**
3032
- *
3033
- * @export
3034
- * @interface AutomationTestNotificationAllOf
3035
- */
3036
- export interface AutomationTestNotificationAllOf {
3037
- /**
3038
- *
3039
- * @type {string}
3040
- * @memberof AutomationTestNotificationAllOf
3041
- */
3042
- message?: string;
3043
- }
3044
1433
  /**
3045
1434
  * Response from notification channel testing.
3046
- * @export
3047
- * @interface AutomationTestResponse
3048
1435
  */
3049
1436
  export interface AutomationTestResponse {
3050
1437
  /**
3051
1438
  * A flag indicating whether test passed or not.
3052
- * @type {boolean}
3053
- * @memberof AutomationTestResponse
3054
1439
  */
3055
1440
  successful: boolean;
3056
1441
  /**
3057
1442
  * Field containing more details in case of a failure. Details are available to a privileged user only.
3058
- * @type {string}
3059
- * @memberof AutomationTestResponse
3060
1443
  */
3061
1444
  error?: string;
3062
1445
  }
3063
- /**
3064
- *
3065
- * @export
3066
- * @interface AutomationTriggerAutomationRequest
3067
- */
3068
1446
  export interface AutomationTriggerAutomationRequest {
3069
- /**
3070
- *
3071
- * @type {AutomationAdHocAutomation}
3072
- * @memberof AutomationTriggerAutomationRequest
3073
- */
3074
1447
  automation: AutomationAdHocAutomation;
3075
1448
  }
3076
- /**
3077
- *
3078
- * @export
3079
- * @interface AutomationValue
3080
- */
3081
1449
  export interface AutomationValue {
3082
1450
  /**
3083
1451
  * Value of the alert threshold to compare the metric to.
3084
- * @type {number}
3085
- * @memberof AutomationValue
3086
1452
  */
3087
1453
  value: number;
3088
1454
  }
3089
- /**
3090
- *
3091
- * @export
3092
- * @interface AutomationVisibleFilter
3093
- */
3094
1455
  export interface AutomationVisibleFilter {
3095
- /**
3096
- *
3097
- * @type {string}
3098
- * @memberof AutomationVisibleFilter
3099
- */
3100
1456
  localIdentifier?: string;
3101
- /**
3102
- *
3103
- * @type {string}
3104
- * @memberof AutomationVisibleFilter
3105
- */
3106
1457
  title?: string;
3107
1458
  /**
3108
1459
  * Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same \'localIdentifier\' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.
3109
- * @type {boolean}
3110
- * @memberof AutomationVisibleFilter
3111
1460
  */
3112
1461
  isAllTimeDateFilter?: boolean;
3113
1462
  }
3114
1463
  /**
3115
1464
  * Export request object describing the export properties and metadata for dashboard PDF exports.
3116
- * @export
3117
- * @interface AutomationVisualExportRequest
3118
1465
  */
3119
1466
  export interface AutomationVisualExportRequest {
3120
1467
  /**
3121
1468
  * File name to be used for retrieving the pdf document.
3122
- * @type {string}
3123
- * @memberof AutomationVisualExportRequest
3124
1469
  */
3125
1470
  fileName: string;
3126
1471
  /**
3127
1472
  * Dashboard identifier
3128
- * @type {string}
3129
- * @memberof AutomationVisualExportRequest
3130
1473
  */
3131
1474
  dashboardId: string;
3132
1475
  /**
3133
1476
  * Metadata definition in free-form JSON format.
3134
- * @type {object}
3135
- * @memberof AutomationVisualExportRequest
3136
1477
  */
3137
1478
  metadata?: object;
3138
1479
  }
3139
1480
  /**
3140
1481
  * Webhook destination for notifications. The property url is required on create and update.
3141
- * @export
3142
- * @interface AutomationWebhook
3143
1482
  */
3144
1483
  export interface AutomationWebhook {
3145
1484
  /**
3146
1485
  * The webhook URL.
3147
- * @type {string}
3148
- * @memberof AutomationWebhook
3149
1486
  */
3150
1487
  url?: string;
3151
1488
  /**
3152
1489
  * Bearer token for the webhook.
3153
- * @type {string}
3154
- * @memberof AutomationWebhook
3155
1490
  */
3156
1491
  token?: string | null;
3157
1492
  /**
3158
1493
  * Flag indicating if webhook has a token.
3159
- * @type {boolean}
3160
- * @memberof AutomationWebhook
3161
1494
  */
3162
1495
  hasToken?: boolean | null;
3163
1496
  /**
3164
1497
  * The destination type.
3165
- * @type {string}
3166
- * @memberof AutomationWebhook
3167
1498
  */
3168
1499
  type: AutomationWebhookTypeEnum;
3169
1500
  }
@@ -3171,177 +1502,42 @@ export declare const AutomationWebhookTypeEnum: {
3171
1502
  readonly WEBHOOK: "WEBHOOK";
3172
1503
  };
3173
1504
  export type AutomationWebhookTypeEnum = (typeof AutomationWebhookTypeEnum)[keyof typeof AutomationWebhookTypeEnum];
3174
- /**
3175
- *
3176
- * @export
3177
- * @interface AutomationWebhookAutomationInfo
3178
- */
3179
1505
  export interface AutomationWebhookAutomationInfo {
3180
- /**
3181
- *
3182
- * @type {string}
3183
- * @memberof AutomationWebhookAutomationInfo
3184
- */
3185
1506
  id: string;
3186
- /**
3187
- *
3188
- * @type {string}
3189
- * @memberof AutomationWebhookAutomationInfo
3190
- */
3191
1507
  title?: string;
3192
- /**
3193
- *
3194
- * @type {string}
3195
- * @memberof AutomationWebhookAutomationInfo
3196
- */
3197
1508
  dashboardTitle?: string;
3198
- /**
3199
- *
3200
- * @type {string}
3201
- * @memberof AutomationWebhookAutomationInfo
3202
- */
3203
1509
  dashboardURL: string;
3204
- /**
3205
- *
3206
- * @type {boolean}
3207
- * @memberof AutomationWebhookAutomationInfo
3208
- */
3209
1510
  isCustomDashboardURL: boolean;
3210
1511
  }
3211
- /**
3212
- *
3213
- * @export
3214
- * @interface AutomationWebhookMessage
3215
- */
3216
1512
  export interface AutomationWebhookMessage {
3217
- /**
3218
- *
3219
- * @type {string}
3220
- * @memberof AutomationWebhookMessage
3221
- */
3222
1513
  timestamp: string;
3223
- /**
3224
- *
3225
- * @type {AutomationWebhookMessageData}
3226
- * @memberof AutomationWebhookMessage
3227
- */
3228
1514
  data: AutomationWebhookMessageData;
3229
- /**
3230
- *
3231
- * @type {string}
3232
- * @memberof AutomationWebhookMessage
3233
- */
3234
1515
  type: AutomationWebhookMessageTypeEnum;
3235
1516
  }
3236
1517
  export declare const AutomationWebhookMessageTypeEnum: {
3237
- readonly COMPLETED: "automation-task.completed";
3238
- readonly LIMIT_EXCEEDED: "automation-task.limit-exceeded";
1518
+ readonly AUTOMATION_TASK_COMPLETED: "automation-task.completed";
1519
+ readonly AUTOMATION_TASK_LIMIT_EXCEEDED: "automation-task.limit-exceeded";
3239
1520
  };
3240
1521
  export type AutomationWebhookMessageTypeEnum = (typeof AutomationWebhookMessageTypeEnum)[keyof typeof AutomationWebhookMessageTypeEnum];
3241
- /**
3242
- *
3243
- * @export
3244
- * @interface AutomationWebhookMessageData
3245
- */
3246
1522
  export interface AutomationWebhookMessageData {
3247
- /**
3248
- *
3249
- * @type {AutomationWebhookAutomationInfo}
3250
- * @memberof AutomationWebhookMessageData
3251
- */
3252
1523
  automation: AutomationWebhookAutomationInfo;
3253
- /**
3254
- *
3255
- * @type {Array<AutomationWebhookRecipient>}
3256
- * @memberof AutomationWebhookMessageData
3257
- */
3258
1524
  recipients?: Array<AutomationWebhookRecipient>;
3259
- /**
3260
- *
3261
- * @type {{ [key: string]: string; }}
3262
- * @memberof AutomationWebhookMessageData
3263
- */
3264
1525
  details?: {
3265
1526
  [key: string]: string;
3266
1527
  };
3267
- /**
3268
- *
3269
- * @type {number}
3270
- * @memberof AutomationWebhookMessageData
3271
- */
3272
1528
  remainingActionCount?: number;
3273
- /**
3274
- *
3275
- * @type {Array<AutomationExportResult>}
3276
- * @memberof AutomationWebhookMessageData
3277
- */
3278
1529
  tabularExports?: Array<AutomationExportResult>;
3279
- /**
3280
- *
3281
- * @type {Array<AutomationExportResult>}
3282
- * @memberof AutomationWebhookMessageData
3283
- */
3284
1530
  visualExports?: Array<AutomationExportResult>;
3285
- /**
3286
- *
3287
- * @type {Array<AutomationExportResult>}
3288
- * @memberof AutomationWebhookMessageData
3289
- */
3290
1531
  imageExports?: Array<AutomationExportResult>;
3291
- /**
3292
- *
3293
- * @type {Array<AutomationExportResult>}
3294
- * @memberof AutomationWebhookMessageData
3295
- */
3296
1532
  rawExports?: Array<AutomationExportResult>;
3297
- /**
3298
- *
3299
- * @type {Array<AutomationExportResult>}
3300
- * @memberof AutomationWebhookMessageData
3301
- */
3302
1533
  slidesExports?: Array<AutomationExportResult>;
3303
- /**
3304
- *
3305
- * @type {Array<AutomationExportResult>}
3306
- * @memberof AutomationWebhookMessageData
3307
- */
3308
1534
  dashboardTabularExports?: Array<AutomationExportResult>;
3309
- /**
3310
- *
3311
- * @type {AutomationAlertDescription}
3312
- * @memberof AutomationWebhookMessageData
3313
- */
3314
1535
  alert?: AutomationAlertDescription;
3315
- /**
3316
- *
3317
- * @type {Array<AutomationNotificationFilter>}
3318
- * @memberof AutomationWebhookMessageData
3319
- */
3320
1536
  filters?: Array<AutomationNotificationFilter>;
3321
- /**
3322
- *
3323
- * @type {string}
3324
- * @memberof AutomationWebhookMessageData
3325
- */
3326
1537
  notificationSource?: string;
3327
1538
  }
3328
- /**
3329
- *
3330
- * @export
3331
- * @interface AutomationWebhookRecipient
3332
- */
3333
1539
  export interface AutomationWebhookRecipient {
3334
- /**
3335
- *
3336
- * @type {string}
3337
- * @memberof AutomationWebhookRecipient
3338
- */
3339
1540
  id: string;
3340
- /**
3341
- *
3342
- * @type {string}
3343
- * @memberof AutomationWebhookRecipient
3344
- */
3345
1541
  email: string;
3346
1542
  }
3347
1543
  /**