@gooddata/api-client-tiger 11.19.0-alpha.9 → 11.19.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 (121) hide show
  1. package/esm/__version.d.ts +1 -1
  2. package/esm/__version.d.ts.map +1 -1
  3. package/esm/__version.js +1 -1
  4. package/esm/__version.js.map +1 -1
  5. package/esm/api-client-tiger.d.ts +1313 -1309
  6. package/esm/endpoints/aac/index.d.ts.map +1 -1
  7. package/esm/endpoints/aac/index.js +2 -0
  8. package/esm/endpoints/aac/index.js.map +1 -1
  9. package/esm/endpoints/actions/index.js +1 -1
  10. package/esm/endpoints/authActions/index.js +1 -1
  11. package/esm/endpoints/automation/index.js +1 -1
  12. package/esm/endpoints/entitiesObjects/index.js +1 -1
  13. package/esm/endpoints/execution/index.js +1 -1
  14. package/esm/endpoints/explain/index.js +1 -1
  15. package/esm/endpoints/export/index.js +1 -1
  16. package/esm/endpoints/genAI/index.js +1 -1
  17. package/esm/endpoints/labelElements/index.js +1 -1
  18. package/esm/endpoints/layout/index.js +1 -1
  19. package/esm/endpoints/locationStyle/index.js +1 -1
  20. package/esm/endpoints/profile/index.js +1 -1
  21. package/esm/endpoints/scanModel/index.js +1 -1
  22. package/esm/endpoints/smartFunctions/index.js +1 -1
  23. package/esm/endpoints/userManagement/index.js +1 -1
  24. package/esm/endpoints/validDescendants/index.js +1 -1
  25. package/esm/endpoints/validObjects/index.js +1 -1
  26. package/esm/gd-tiger-model/index.js +4 -4
  27. package/esm/generated/afm-rest-api/api.d.ts +560 -556
  28. package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
  29. package/esm/generated/afm-rest-api/api.js +540 -410
  30. package/esm/generated/afm-rest-api/api.js.map +1 -1
  31. package/esm/generated/afm-rest-api/base.d.ts +2 -2
  32. package/esm/generated/afm-rest-api/base.d.ts.map +1 -1
  33. package/esm/generated/afm-rest-api/base.js +3 -1
  34. package/esm/generated/afm-rest-api/base.js.map +1 -1
  35. package/esm/generated/afm-rest-api/common.d.ts +1 -1
  36. package/esm/generated/afm-rest-api/common.d.ts.map +1 -1
  37. package/esm/generated/afm-rest-api/common.js +24 -14
  38. package/esm/generated/afm-rest-api/common.js.map +1 -1
  39. package/esm/generated/afm-rest-api/configuration.d.ts.map +1 -1
  40. package/esm/generated/afm-rest-api/configuration.js +3 -2
  41. package/esm/generated/afm-rest-api/configuration.js.map +1 -1
  42. package/esm/generated/afm-rest-api/index.d.ts.map +1 -1
  43. package/esm/generated/afm-rest-api/index.js +1 -0
  44. package/esm/generated/afm-rest-api/index.js.map +1 -1
  45. package/esm/generated/auth-json-api/api.d.ts +54 -54
  46. package/esm/generated/auth-json-api/api.d.ts.map +1 -1
  47. package/esm/generated/auth-json-api/api.js +89 -56
  48. package/esm/generated/auth-json-api/api.js.map +1 -1
  49. package/esm/generated/auth-json-api/base.d.ts +2 -2
  50. package/esm/generated/auth-json-api/base.d.ts.map +1 -1
  51. package/esm/generated/auth-json-api/base.js +3 -1
  52. package/esm/generated/auth-json-api/base.js.map +1 -1
  53. package/esm/generated/auth-json-api/common.d.ts +1 -1
  54. package/esm/generated/auth-json-api/common.d.ts.map +1 -1
  55. package/esm/generated/auth-json-api/common.js +24 -14
  56. package/esm/generated/auth-json-api/common.js.map +1 -1
  57. package/esm/generated/auth-json-api/configuration.d.ts.map +1 -1
  58. package/esm/generated/auth-json-api/configuration.js +3 -2
  59. package/esm/generated/auth-json-api/configuration.js.map +1 -1
  60. package/esm/generated/auth-json-api/index.d.ts.map +1 -1
  61. package/esm/generated/auth-json-api/index.js +1 -0
  62. package/esm/generated/auth-json-api/index.js.map +1 -1
  63. package/esm/generated/automation-json-api/api.d.ts +430 -430
  64. package/esm/generated/automation-json-api/api.d.ts.map +1 -1
  65. package/esm/generated/automation-json-api/api.js +95 -66
  66. package/esm/generated/automation-json-api/api.js.map +1 -1
  67. package/esm/generated/automation-json-api/base.d.ts +2 -2
  68. package/esm/generated/automation-json-api/base.d.ts.map +1 -1
  69. package/esm/generated/automation-json-api/base.js +3 -1
  70. package/esm/generated/automation-json-api/base.js.map +1 -1
  71. package/esm/generated/automation-json-api/common.d.ts +1 -1
  72. package/esm/generated/automation-json-api/common.d.ts.map +1 -1
  73. package/esm/generated/automation-json-api/common.js +24 -14
  74. package/esm/generated/automation-json-api/common.js.map +1 -1
  75. package/esm/generated/automation-json-api/configuration.d.ts.map +1 -1
  76. package/esm/generated/automation-json-api/configuration.js +3 -2
  77. package/esm/generated/automation-json-api/configuration.js.map +1 -1
  78. package/esm/generated/automation-json-api/index.d.ts.map +1 -1
  79. package/esm/generated/automation-json-api/index.js +1 -0
  80. package/esm/generated/automation-json-api/index.js.map +1 -1
  81. package/esm/generated/export-json-api/api.d.ts +257 -257
  82. package/esm/generated/export-json-api/api.d.ts.map +1 -1
  83. package/esm/generated/export-json-api/api.js +183 -138
  84. package/esm/generated/export-json-api/api.js.map +1 -1
  85. package/esm/generated/export-json-api/base.d.ts +2 -2
  86. package/esm/generated/export-json-api/base.d.ts.map +1 -1
  87. package/esm/generated/export-json-api/base.js +3 -1
  88. package/esm/generated/export-json-api/base.js.map +1 -1
  89. package/esm/generated/export-json-api/common.d.ts +1 -1
  90. package/esm/generated/export-json-api/common.d.ts.map +1 -1
  91. package/esm/generated/export-json-api/common.js +24 -14
  92. package/esm/generated/export-json-api/common.js.map +1 -1
  93. package/esm/generated/export-json-api/configuration.d.ts.map +1 -1
  94. package/esm/generated/export-json-api/configuration.js +3 -2
  95. package/esm/generated/export-json-api/configuration.js.map +1 -1
  96. package/esm/generated/export-json-api/index.d.ts.map +1 -1
  97. package/esm/generated/export-json-api/index.js +1 -0
  98. package/esm/generated/export-json-api/index.js.map +1 -1
  99. package/esm/generated/scan-json-api/api.d.ts +92 -92
  100. package/esm/generated/scan-json-api/api.d.ts.map +1 -1
  101. package/esm/generated/scan-json-api/api.js +115 -74
  102. package/esm/generated/scan-json-api/api.js.map +1 -1
  103. package/esm/generated/scan-json-api/base.d.ts +2 -2
  104. package/esm/generated/scan-json-api/base.d.ts.map +1 -1
  105. package/esm/generated/scan-json-api/base.js +3 -1
  106. package/esm/generated/scan-json-api/base.js.map +1 -1
  107. package/esm/generated/scan-json-api/common.d.ts +1 -1
  108. package/esm/generated/scan-json-api/common.d.ts.map +1 -1
  109. package/esm/generated/scan-json-api/common.js +24 -14
  110. package/esm/generated/scan-json-api/common.js.map +1 -1
  111. package/esm/generated/scan-json-api/configuration.d.ts.map +1 -1
  112. package/esm/generated/scan-json-api/configuration.js +3 -2
  113. package/esm/generated/scan-json-api/configuration.js.map +1 -1
  114. package/esm/generated/scan-json-api/index.d.ts.map +1 -1
  115. package/esm/generated/scan-json-api/index.js +1 -0
  116. package/esm/generated/scan-json-api/index.js.map +1 -1
  117. package/esm/index.d.ts +1 -1
  118. package/esm/index.d.ts.map +1 -1
  119. package/esm/index.js +1 -1
  120. package/esm/index.js.map +1 -1
  121. package/package.json +14 -8
@@ -9,8 +9,8 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { Configuration } from "./configuration.js";
13
- import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from "axios";
12
+ import { Configuration } from './configuration.js';
13
+ 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.
@@ -19,19 +19,19 @@ export interface AutomationAFM {
19
19
  /**
20
20
  * Attributes to be used in the computation.
21
21
  */
22
- attributes: Array<AutomationAttributeItem>;
22
+ 'attributes': Array<AutomationAttributeItem>;
23
23
  /**
24
24
  * Various filter types to filter the execution result.
25
25
  */
26
- filters: Array<AutomationAFMFiltersInner>;
26
+ 'filters': Array<AutomationAFMFiltersInner>;
27
27
  /**
28
28
  * Metrics to be computed.
29
29
  */
30
- measures: Array<AutomationMeasureItem>;
30
+ 'measures': Array<AutomationMeasureItem>;
31
31
  /**
32
32
  * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
33
33
  */
34
- auxMeasures?: Array<AutomationMeasureItem>;
34
+ 'auxMeasures'?: Array<AutomationMeasureItem>;
35
35
  }
36
36
  /**
37
37
  * @type AutomationAFMFiltersInner
@@ -41,51 +41,51 @@ export type AutomationAFMFiltersInner = AutomationAbstractMeasureValueFilter | A
41
41
  * A datetime filter specifying exact from and to values.
42
42
  */
43
43
  export interface AutomationAbsoluteDateFilter {
44
- absoluteDateFilter: AutomationAbsoluteDateFilterAbsoluteDateFilter;
44
+ 'absoluteDateFilter': AutomationAbsoluteDateFilterAbsoluteDateFilter;
45
45
  }
46
46
  export interface AutomationAbsoluteDateFilterAbsoluteDateFilter {
47
- from: string;
48
- to: string;
49
- localIdentifier?: string;
50
- applyOnResult?: boolean;
47
+ 'from': string;
48
+ 'to': string;
49
+ 'localIdentifier'?: string;
50
+ 'applyOnResult'?: boolean;
51
51
  /**
52
52
  * If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).
53
53
  */
54
- includeEmptyValues?: boolean;
55
- dataset: AutomationAfmObjectIdentifierDataset;
54
+ 'includeEmptyValues'?: boolean;
55
+ 'dataset': AutomationAfmObjectIdentifierDataset;
56
56
  }
57
57
  /**
58
58
  * @type AutomationAbstractMeasureValueFilter
59
59
  */
60
60
  export type AutomationAbstractMeasureValueFilter = AutomationComparisonMeasureValueFilter | AutomationCompoundMeasureValueFilter | AutomationRangeMeasureValueFilter | AutomationRankingFilter;
61
61
  export interface AutomationAdHocAutomation {
62
- title?: string;
63
- description?: string;
62
+ 'title'?: string;
63
+ 'description'?: string;
64
64
  /**
65
65
  * A list of tags.
66
66
  */
67
- tags?: Array<string>;
67
+ 'tags'?: Array<string>;
68
68
  /**
69
69
  * Additional details to be included in the automated message.
70
70
  */
71
- details?: {
71
+ 'details'?: {
72
72
  [key: string]: string;
73
73
  };
74
- metadata?: AutomationAutomationMetadata | null;
75
- alert?: AutomationAutomationAlert;
76
- tabularExports?: Array<AutomationAutomationTabularExport>;
77
- visualExports?: Array<AutomationAutomationVisualExport>;
78
- imageExports?: Array<AutomationAutomationImageExport>;
79
- rawExports?: Array<AutomationAutomationRawExport>;
80
- slidesExports?: Array<AutomationAutomationSlidesExport>;
81
- dashboardTabularExports?: Array<AutomationAutomationDashboardTabularExport>;
74
+ 'metadata'?: AutomationAutomationMetadata | null;
75
+ 'alert'?: AutomationAutomationAlert;
76
+ 'tabularExports'?: Array<AutomationAutomationTabularExport>;
77
+ 'visualExports'?: Array<AutomationAutomationVisualExport>;
78
+ 'imageExports'?: Array<AutomationAutomationImageExport>;
79
+ 'rawExports'?: Array<AutomationAutomationRawExport>;
80
+ 'slidesExports'?: Array<AutomationAutomationSlidesExport>;
81
+ 'dashboardTabularExports'?: Array<AutomationAutomationDashboardTabularExport>;
82
82
  /**
83
83
  * External recipients of the automation action results.
84
84
  */
85
- externalRecipients?: Array<AutomationAutomationExternalRecipient>;
86
- notificationChannel?: AutomationDeclarativeNotificationChannelIdentifier;
87
- recipients?: Array<AutomationDeclarativeUserIdentifier>;
88
- analyticalDashboard?: AutomationDeclarativeAnalyticalDashboardIdentifier;
85
+ 'externalRecipients'?: Array<AutomationAutomationExternalRecipient>;
86
+ 'notificationChannel'?: AutomationDeclarativeNotificationChannelIdentifier;
87
+ 'recipients'?: Array<AutomationDeclarativeUserIdentifier>;
88
+ 'analyticalDashboard'?: AutomationDeclarativeAnalyticalDashboardIdentifier;
89
89
  }
90
90
  /**
91
91
  * @type AutomationAfmIdentifier
@@ -93,77 +93,77 @@ export interface AutomationAdHocAutomation {
93
93
  */
94
94
  export type AutomationAfmIdentifier = AutomationAfmLocalIdentifier | AutomationAfmObjectIdentifier;
95
95
  export interface AutomationAfmLocalIdentifier {
96
- localIdentifier: string;
96
+ 'localIdentifier': string;
97
97
  }
98
98
  /**
99
99
  * ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.
100
100
  */
101
101
  export interface AutomationAfmObjectIdentifier {
102
- identifier: AutomationAfmObjectIdentifierIdentifier;
102
+ 'identifier': AutomationAfmObjectIdentifierIdentifier;
103
103
  }
104
104
  /**
105
105
  * Reference to the date attribute to use.
106
106
  */
107
107
  export interface AutomationAfmObjectIdentifierAttribute {
108
- identifier: AutomationAfmObjectIdentifierAttributeIdentifier;
108
+ 'identifier': AutomationAfmObjectIdentifierAttributeIdentifier;
109
109
  }
110
110
  export interface AutomationAfmObjectIdentifierAttributeIdentifier {
111
- id: string;
112
- type: AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum;
111
+ 'id': string;
112
+ 'type': AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum;
113
113
  }
114
- export type AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum = "attribute";
114
+ export type AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum = 'attribute';
115
115
  /**
116
116
  * Reference to the metric, fact or attribute object to use for the metric.
117
117
  */
118
118
  export interface AutomationAfmObjectIdentifierCore {
119
- identifier: AutomationAfmObjectIdentifierCoreIdentifier;
119
+ 'identifier': AutomationAfmObjectIdentifierCoreIdentifier;
120
120
  }
121
121
  export interface AutomationAfmObjectIdentifierCoreIdentifier {
122
- id: string;
123
- type: AutomationAfmObjectIdentifierCoreIdentifierTypeEnum;
122
+ 'id': string;
123
+ 'type': AutomationAfmObjectIdentifierCoreIdentifierTypeEnum;
124
124
  }
125
- export type AutomationAfmObjectIdentifierCoreIdentifierTypeEnum = "attribute" | "label" | "fact" | "metric";
125
+ export type AutomationAfmObjectIdentifierCoreIdentifierTypeEnum = 'attribute' | 'label' | 'fact' | 'metric';
126
126
  /**
127
127
  * Date dataset used for anomaly detection.
128
128
  */
129
129
  export interface AutomationAfmObjectIdentifierDataset {
130
- identifier: AutomationAfmObjectIdentifierDatasetIdentifier;
130
+ 'identifier': AutomationAfmObjectIdentifierDatasetIdentifier;
131
131
  }
132
132
  export interface AutomationAfmObjectIdentifierDatasetIdentifier {
133
- id: string;
134
- type: AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum;
133
+ 'id': string;
134
+ 'type': AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum;
135
135
  }
136
- export type AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum = "dataset";
136
+ export type AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum = 'dataset';
137
137
  export interface AutomationAfmObjectIdentifierIdentifier {
138
- type: AutomationAfmObjectIdentifierIdentifierTypeEnum;
139
- id: string;
138
+ 'type': AutomationAfmObjectIdentifierIdentifierTypeEnum;
139
+ 'id': string;
140
140
  }
141
- export type AutomationAfmObjectIdentifierIdentifierTypeEnum = "analyticalDashboard" | "attribute" | "dashboardPlugin" | "dataset" | "fact" | "label" | "metric" | "prompt" | "visualizationObject" | "filterContext";
141
+ export type AutomationAfmObjectIdentifierIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'dashboardPlugin' | 'dataset' | 'fact' | 'label' | 'metric' | 'prompt' | 'visualizationObject' | 'filterContext';
142
142
  export interface AutomationAfmObjectIdentifierLabel {
143
- identifier: AutomationAfmObjectIdentifierLabelIdentifier;
143
+ 'identifier': AutomationAfmObjectIdentifierLabelIdentifier;
144
144
  }
145
145
  export interface AutomationAfmObjectIdentifierLabelIdentifier {
146
- type: AutomationAfmObjectIdentifierLabelIdentifierTypeEnum;
147
- id: string;
146
+ 'type': AutomationAfmObjectIdentifierLabelIdentifierTypeEnum;
147
+ 'id': string;
148
148
  }
149
- export type AutomationAfmObjectIdentifierLabelIdentifierTypeEnum = "label";
149
+ export type AutomationAfmObjectIdentifierLabelIdentifierTypeEnum = 'label';
150
150
  export interface AutomationAlertAfm {
151
151
  /**
152
152
  * Attributes to be used in the computation.
153
153
  */
154
- attributes?: Array<AutomationAttributeItem>;
154
+ 'attributes'?: Array<AutomationAttributeItem>;
155
155
  /**
156
156
  * Various filter types to filter execution result. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection.
157
157
  */
158
- filters: Array<AutomationFilterDefinition>;
158
+ 'filters': Array<AutomationFilterDefinition>;
159
159
  /**
160
160
  * 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.
161
161
  */
162
- measures: Array<AutomationMeasureItem>;
162
+ 'measures': Array<AutomationMeasureItem>;
163
163
  /**
164
164
  * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
165
165
  */
166
- auxMeasures?: Array<AutomationMeasureItem>;
166
+ 'auxMeasures'?: Array<AutomationMeasureItem>;
167
167
  }
168
168
  /**
169
169
  * @type AutomationAlertCondition
@@ -176,72 +176,72 @@ export type AutomationAlertCondition = AutomationAnomalyDetectionWrapper | Autom
176
176
  */
177
177
  export type AutomationAlertConditionOperand = AutomationLocalIdentifier | AutomationValue;
178
178
  export interface AutomationAlertDescription {
179
- metric: string;
180
- condition: string;
181
- currentValues?: Array<AutomationAlertEvaluationRow>;
182
- attribute?: string;
183
- totalValueCount?: number;
184
- triggeredCount?: number;
185
- triggeredAt?: string;
186
- threshold?: number;
187
- formattedThreshold?: string;
188
- lowerThreshold?: number;
189
- upperThreshold?: number;
190
- remainingAlertEvaluationCount?: number;
191
- status?: AutomationAlertDescriptionStatusEnum;
192
- errorMessage?: string;
193
- traceId?: string;
194
- }
195
- export type AutomationAlertDescriptionStatusEnum = "SUCCESS" | "ERROR" | "INTERNAL_ERROR" | "TIMEOUT";
179
+ 'metric': string;
180
+ 'condition': string;
181
+ 'currentValues'?: Array<AutomationAlertEvaluationRow>;
182
+ 'attribute'?: string;
183
+ 'totalValueCount'?: number;
184
+ 'triggeredCount'?: number;
185
+ 'triggeredAt'?: string;
186
+ 'threshold'?: number;
187
+ 'formattedThreshold'?: string;
188
+ 'lowerThreshold'?: number;
189
+ 'upperThreshold'?: number;
190
+ 'remainingAlertEvaluationCount'?: number;
191
+ 'status'?: AutomationAlertDescriptionStatusEnum;
192
+ 'errorMessage'?: string;
193
+ 'traceId'?: string;
194
+ }
195
+ export type AutomationAlertDescriptionStatusEnum = 'SUCCESS' | 'ERROR' | 'INTERNAL_ERROR' | 'TIMEOUT';
196
196
  export interface AutomationAlertEvaluationRow {
197
- primaryMetric?: AutomationMetricRecord;
198
- secondaryMetric?: AutomationMetricRecord;
199
- computedMetric?: AutomationMetricRecord;
200
- labelValue?: string;
197
+ 'primaryMetric'?: AutomationMetricRecord;
198
+ 'secondaryMetric'?: AutomationMetricRecord;
199
+ 'computedMetric'?: AutomationMetricRecord;
200
+ 'labelValue'?: string;
201
201
  }
202
202
  export interface AutomationAnomalyDetection {
203
- measure: AutomationLocalIdentifier;
203
+ 'measure': AutomationLocalIdentifier;
204
204
  /**
205
205
  * Sensitivity level for anomaly detection
206
206
  */
207
- sensitivity: AutomationAnomalyDetectionSensitivityEnum;
207
+ 'sensitivity': AutomationAnomalyDetectionSensitivityEnum;
208
208
  /**
209
209
  * Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).
210
210
  */
211
- granularity: AutomationAnomalyDetectionGranularityEnum;
212
- dataset: AutomationAfmObjectIdentifierDataset;
211
+ 'granularity': AutomationAnomalyDetectionGranularityEnum;
212
+ 'dataset': AutomationAfmObjectIdentifierDataset;
213
213
  }
214
- export type AutomationAnomalyDetectionSensitivityEnum = "LOW" | "MEDIUM" | "HIGH";
215
- export type AutomationAnomalyDetectionGranularityEnum = "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR";
214
+ export type AutomationAnomalyDetectionSensitivityEnum = 'LOW' | 'MEDIUM' | 'HIGH';
215
+ export type AutomationAnomalyDetectionGranularityEnum = 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
216
216
  export interface AutomationAnomalyDetectionWrapper {
217
- anomaly: AutomationAnomalyDetection;
217
+ 'anomaly': AutomationAnomalyDetection;
218
218
  }
219
219
  export interface AutomationArithmeticMeasure {
220
220
  /**
221
221
  * Arithmetic operator. DIFFERENCE - m₁−m₂ - the difference between two metrics. CHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics.
222
222
  */
223
- operator: AutomationArithmeticMeasureOperatorEnum;
224
- left: AutomationLocalIdentifier;
225
- right: AutomationLocalIdentifier;
223
+ 'operator': AutomationArithmeticMeasureOperatorEnum;
224
+ 'left': AutomationLocalIdentifier;
225
+ 'right': AutomationLocalIdentifier;
226
226
  }
227
- export type AutomationArithmeticMeasureOperatorEnum = "DIFFERENCE" | "CHANGE";
227
+ export type AutomationArithmeticMeasureOperatorEnum = 'DIFFERENCE' | 'CHANGE';
228
228
  /**
229
229
  * Metric representing arithmetics between other metrics.
230
230
  */
231
231
  export interface AutomationArithmeticMeasureDefinition {
232
- arithmeticMeasure: AutomationArithmeticMeasureDefinitionArithmeticMeasure;
232
+ 'arithmeticMeasure': AutomationArithmeticMeasureDefinitionArithmeticMeasure;
233
233
  }
234
234
  export interface AutomationArithmeticMeasureDefinitionArithmeticMeasure {
235
235
  /**
236
236
  * List of metrics to apply arithmetic operation by chosen operator.
237
237
  */
238
- measureIdentifiers: Array<AutomationAfmLocalIdentifier>;
238
+ 'measureIdentifiers': Array<AutomationAfmLocalIdentifier>;
239
239
  /**
240
240
  * Arithmetic operator describing operation between metrics.
241
241
  */
242
- operator: AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum;
242
+ 'operator': AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum;
243
243
  }
244
- export type AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = "SUM" | "DIFFERENCE" | "MULTIPLICATION" | "RATIO" | "CHANGE";
244
+ export type AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = 'SUM' | 'DIFFERENCE' | 'MULTIPLICATION' | 'RATIO' | 'CHANGE';
245
245
  /**
246
246
  * @type AutomationAttributeElements
247
247
  */
@@ -250,13 +250,13 @@ export interface AutomationAttributeElementsByRef {
250
250
  /**
251
251
  * List of attribute elements by reference
252
252
  */
253
- uris: Array<string | null>;
253
+ 'uris': Array<string | null>;
254
254
  }
255
255
  export interface AutomationAttributeElementsByValue {
256
256
  /**
257
257
  * List of attribute elements by value
258
258
  */
259
- values: Array<string | null>;
259
+ 'values': Array<string | null>;
260
260
  }
261
261
  /**
262
262
  * @type AutomationAttributeFilter
@@ -264,8 +264,8 @@ export interface AutomationAttributeElementsByValue {
264
264
  */
265
265
  export type AutomationAttributeFilter = AutomationNegativeAttributeFilter | AutomationPositiveAttributeFilter;
266
266
  export interface AutomationAttributeFilterByDate {
267
- filterLocalIdentifier: string;
268
- isCommonDate: boolean;
267
+ 'filterLocalIdentifier': string;
268
+ 'isCommonDate': boolean;
269
269
  }
270
270
  /**
271
271
  * Filter on specific set of label values.
@@ -274,70 +274,70 @@ export interface AutomationAttributeFilterElements {
274
274
  /**
275
275
  * Set of label values.
276
276
  */
277
- values: Array<string | null>;
277
+ 'values': Array<string | null>;
278
278
  }
279
279
  export interface AutomationAttributeFilterParent {
280
- filterLocalIdentifier: string;
281
- over: AutomationOver;
280
+ 'filterLocalIdentifier': string;
281
+ 'over': AutomationOver;
282
282
  }
283
283
  export interface AutomationAttributeItem {
284
284
  /**
285
285
  * Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
286
286
  */
287
- localIdentifier: string;
288
- label: AutomationAfmObjectIdentifierLabel;
287
+ 'localIdentifier': string;
288
+ 'label': AutomationAfmObjectIdentifierLabel;
289
289
  /**
290
290
  * Indicates whether to show all values of given attribute even if the data bound to those values is not available.
291
291
  */
292
- showAllValues?: boolean;
292
+ 'showAllValues'?: boolean;
293
293
  }
294
294
  export interface AutomationAutomationAlert {
295
- execution: AutomationAlertAfm;
296
- condition: AutomationAutomationAlertCondition;
295
+ 'execution': AutomationAlertAfm;
296
+ 'condition': AutomationAutomationAlertCondition;
297
297
  /**
298
298
  * 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.
299
299
  */
300
- trigger?: AutomationAutomationAlertTriggerEnum;
300
+ 'trigger'?: AutomationAutomationAlertTriggerEnum;
301
301
  }
302
- export type AutomationAutomationAlertTriggerEnum = "ALWAYS" | "ONCE";
302
+ export type AutomationAutomationAlertTriggerEnum = 'ALWAYS' | 'ONCE';
303
303
  /**
304
304
  * @type AutomationAutomationAlertCondition
305
305
  */
306
306
  export type AutomationAutomationAlertCondition = AutomationAnomalyDetectionWrapper | AutomationComparisonWrapper | AutomationRangeWrapper | AutomationRelativeWrapper;
307
307
  export interface AutomationAutomationDashboardTabularExport {
308
- requestPayload: AutomationDashboardTabularExportRequestV2;
308
+ 'requestPayload': AutomationDashboardTabularExportRequestV2;
309
309
  }
310
310
  export interface AutomationAutomationExternalRecipient {
311
311
  /**
312
312
  * E-mail address to send notifications from.
313
313
  */
314
- email: string;
314
+ 'email': string;
315
315
  }
316
316
  export interface AutomationAutomationImageExport {
317
- requestPayload: AutomationImageExportRequest;
317
+ 'requestPayload': AutomationImageExportRequest;
318
318
  }
319
319
  /**
320
320
  * Additional information for the automation.
321
321
  */
322
322
  export interface AutomationAutomationMetadata {
323
323
  [key: string]: any;
324
- widget?: string;
325
- visibleFilters?: Array<AutomationVisibleFilter>;
324
+ 'widget'?: string;
325
+ 'visibleFilters'?: Array<AutomationVisibleFilter>;
326
326
  }
327
327
  export interface AutomationAutomationNotification extends AutomationNotificationContent {
328
- content: AutomationWebhookMessage;
328
+ 'content': AutomationWebhookMessage;
329
329
  }
330
330
  export interface AutomationAutomationRawExport {
331
- requestPayload: AutomationRawExportAutomationRequest;
331
+ 'requestPayload': AutomationRawExportAutomationRequest;
332
332
  }
333
333
  export interface AutomationAutomationSlidesExport {
334
- requestPayload: AutomationSlidesExportRequest;
334
+ 'requestPayload': AutomationSlidesExportRequest;
335
335
  }
336
336
  export interface AutomationAutomationTabularExport {
337
- requestPayload: AutomationTabularExportRequest;
337
+ 'requestPayload': AutomationTabularExportRequest;
338
338
  }
339
339
  export interface AutomationAutomationVisualExport {
340
- requestPayload: AutomationVisualExportRequest;
340
+ 'requestPayload': AutomationVisualExportRequest;
341
341
  }
342
342
  /**
343
343
  * 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.
@@ -346,81 +346,81 @@ export interface AutomationBoundedFilter {
346
346
  /**
347
347
  * Date granularity specifying particular date attribute in given dimension.
348
348
  */
349
- granularity: AutomationBoundedFilterGranularityEnum;
349
+ 'granularity': AutomationBoundedFilterGranularityEnum;
350
350
  /**
351
351
  * 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.
352
352
  */
353
- from?: number | null;
353
+ 'from'?: number | null;
354
354
  /**
355
355
  * 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.
356
356
  */
357
- to?: number | null;
357
+ 'to'?: number | null;
358
358
  }
359
- export type AutomationBoundedFilterGranularityEnum = "MINUTE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR" | "MINUTE_OF_HOUR" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_QUARTER" | "DAY_OF_YEAR" | "WEEK_OF_YEAR" | "MONTH_OF_YEAR" | "QUARTER_OF_YEAR" | "FISCAL_MONTH" | "FISCAL_QUARTER" | "FISCAL_YEAR";
359
+ export type AutomationBoundedFilterGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
360
360
  export interface AutomationComparison {
361
- operator: AutomationComparisonOperatorEnum;
362
- left: AutomationLocalIdentifier;
363
- right: AutomationAlertConditionOperand;
361
+ 'operator': AutomationComparisonOperatorEnum;
362
+ 'left': AutomationLocalIdentifier;
363
+ 'right': AutomationAlertConditionOperand;
364
364
  }
365
- export type AutomationComparisonOperatorEnum = "GREATER_THAN" | "GREATER_THAN_OR_EQUAL_TO" | "LESS_THAN" | "LESS_THAN_OR_EQUAL_TO" | "EQUAL_TO" | "NOT_EQUAL_TO";
365
+ export type AutomationComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
366
366
  /**
367
367
  * Condition that compares the metric value to a given constant value using a comparison operator.
368
368
  */
369
369
  export interface AutomationComparisonCondition {
370
- comparison: AutomationComparisonConditionComparison;
370
+ 'comparison': AutomationComparisonConditionComparison;
371
371
  }
372
372
  export interface AutomationComparisonConditionComparison {
373
- operator: AutomationComparisonConditionComparisonOperatorEnum;
374
- value: number;
373
+ 'operator': AutomationComparisonConditionComparisonOperatorEnum;
374
+ 'value': number;
375
375
  }
376
- export type AutomationComparisonConditionComparisonOperatorEnum = "GREATER_THAN" | "GREATER_THAN_OR_EQUAL_TO" | "LESS_THAN" | "LESS_THAN_OR_EQUAL_TO" | "EQUAL_TO" | "NOT_EQUAL_TO";
376
+ export type AutomationComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
377
377
  /**
378
378
  * Filter the result by comparing specified metric to given constant value, using given comparison operator.
379
379
  */
380
380
  export interface AutomationComparisonMeasureValueFilter {
381
- comparisonMeasureValueFilter: AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter;
381
+ 'comparisonMeasureValueFilter': AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter;
382
382
  }
383
383
  export interface AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter {
384
384
  /**
385
385
  * References to the attributes to be used when filtering.
386
386
  */
387
- dimensionality?: Array<AutomationAfmIdentifier>;
387
+ 'dimensionality'?: Array<AutomationAfmIdentifier>;
388
388
  /**
389
389
  * A value that will be substituted for null values in the metric for the comparisons.
390
390
  */
391
- treatNullValuesAs?: number;
392
- operator: AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
393
- value: number;
394
- localIdentifier?: string;
395
- applyOnResult?: boolean;
396
- measure: AutomationAfmIdentifier;
391
+ 'treatNullValuesAs'?: number;
392
+ 'operator': AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
393
+ 'value': number;
394
+ 'localIdentifier'?: string;
395
+ 'applyOnResult'?: boolean;
396
+ 'measure': AutomationAfmIdentifier;
397
397
  }
398
- export type AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = "GREATER_THAN" | "GREATER_THAN_OR_EQUAL_TO" | "LESS_THAN" | "LESS_THAN_OR_EQUAL_TO" | "EQUAL_TO" | "NOT_EQUAL_TO";
398
+ export type AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
399
399
  export interface AutomationComparisonWrapper {
400
- comparison: AutomationComparison;
400
+ 'comparison': AutomationComparison;
401
401
  }
402
402
  /**
403
403
  * Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned).
404
404
  */
405
405
  export interface AutomationCompoundMeasureValueFilter {
406
- compoundMeasureValueFilter: AutomationCompoundMeasureValueFilterCompoundMeasureValueFilter;
406
+ 'compoundMeasureValueFilter': AutomationCompoundMeasureValueFilterCompoundMeasureValueFilter;
407
407
  }
408
408
  export interface AutomationCompoundMeasureValueFilterCompoundMeasureValueFilter {
409
409
  /**
410
410
  * References to the attributes to be used when filtering.
411
411
  */
412
- dimensionality?: Array<AutomationAfmIdentifier>;
412
+ 'dimensionality'?: Array<AutomationAfmIdentifier>;
413
413
  /**
414
414
  * A value that will be substituted for null values in the metric for the comparisons.
415
415
  */
416
- treatNullValuesAs?: number;
416
+ 'treatNullValuesAs'?: number;
417
417
  /**
418
418
  * List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.
419
419
  */
420
- conditions: Array<AutomationMeasureValueCondition>;
421
- localIdentifier?: string;
422
- applyOnResult?: boolean;
423
- measure: AutomationAfmIdentifier;
420
+ 'conditions': Array<AutomationMeasureValueCondition>;
421
+ 'localIdentifier'?: string;
422
+ 'applyOnResult'?: boolean;
423
+ 'measure': AutomationAfmIdentifier;
424
424
  }
425
425
  /**
426
426
  * Custom label object override.
@@ -429,7 +429,7 @@ export interface AutomationCustomLabel {
429
429
  /**
430
430
  * Override value.
431
431
  */
432
- title: string;
432
+ 'title': string;
433
433
  }
434
434
  /**
435
435
  * Custom metric object override.
@@ -438,11 +438,11 @@ export interface AutomationCustomMetric {
438
438
  /**
439
439
  * Metric title override.
440
440
  */
441
- title: string;
441
+ 'title': string;
442
442
  /**
443
443
  * Format override.
444
444
  */
445
- format: string;
445
+ 'format': string;
446
446
  }
447
447
  /**
448
448
  * Custom cell value overrides (IDs will be replaced with specified values).
@@ -451,47 +451,47 @@ export interface AutomationCustomOverride {
451
451
  /**
452
452
  * Map of CustomLabels with keys used as placeholders in document.
453
453
  */
454
- labels?: {
454
+ 'labels'?: {
455
455
  [key: string]: AutomationCustomLabel;
456
456
  };
457
457
  /**
458
458
  * Map of CustomMetrics with keys used as placeholders in document.
459
459
  */
460
- metrics?: {
460
+ 'metrics'?: {
461
461
  [key: string]: AutomationCustomMetric;
462
462
  };
463
463
  }
464
464
  export interface AutomationDashboardAttributeFilter {
465
- attributeFilter: AutomationDashboardAttributeFilterAttributeFilter;
465
+ 'attributeFilter': AutomationDashboardAttributeFilterAttributeFilter;
466
466
  }
467
467
  export interface AutomationDashboardAttributeFilterAttributeFilter {
468
- displayForm: AutomationIdentifierRef;
469
- negativeSelection: boolean;
470
- attributeElements: AutomationAttributeElements;
471
- filterElementsBy?: Array<AutomationAttributeFilterParent>;
472
- filterElementsByDate?: Array<AutomationAttributeFilterByDate>;
473
- validateElementsBy?: Array<AutomationIdentifierRef>;
474
- title?: string;
475
- selectionMode?: AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum;
476
- localIdentifier?: string;
477
- }
478
- export type AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum = "single" | "multi";
468
+ 'displayForm': AutomationIdentifierRef;
469
+ 'negativeSelection': boolean;
470
+ 'attributeElements': AutomationAttributeElements;
471
+ 'filterElementsBy'?: Array<AutomationAttributeFilterParent>;
472
+ 'filterElementsByDate'?: Array<AutomationAttributeFilterByDate>;
473
+ 'validateElementsBy'?: Array<AutomationIdentifierRef>;
474
+ 'title'?: string;
475
+ 'selectionMode'?: AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum;
476
+ 'localIdentifier'?: string;
477
+ }
478
+ export type AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
479
479
  export interface AutomationDashboardDateFilter {
480
- dateFilter: AutomationDashboardDateFilterDateFilter;
480
+ 'dateFilter': AutomationDashboardDateFilterDateFilter;
481
481
  }
482
482
  export interface AutomationDashboardDateFilterDateFilter {
483
- type: AutomationDashboardDateFilterDateFilterTypeEnum;
484
- granularity: AutomationDashboardDateFilterDateFilterGranularityEnum;
485
- from?: AutomationDashboardDateFilterDateFilterFrom;
486
- to?: AutomationDashboardDateFilterDateFilterFrom;
487
- dataSet?: AutomationIdentifierRef;
488
- attribute?: AutomationIdentifierRef;
489
- boundedFilter?: AutomationRelativeBoundedDateFilter;
490
- includeEmptyValues?: boolean;
491
- localIdentifier?: string;
492
- }
493
- export type AutomationDashboardDateFilterDateFilterTypeEnum = "relative" | "absolute";
494
- export type AutomationDashboardDateFilterDateFilterGranularityEnum = "ALL_TIME_GRANULARITY" | "GDC.time.year" | "GDC.time.week_us" | "GDC.time.week_in_year" | "GDC.time.week_in_quarter" | "GDC.time.week" | "GDC.time.euweek_in_year" | "GDC.time.euweek_in_quarter" | "GDC.time.quarter" | "GDC.time.quarter_in_year" | "GDC.time.month" | "GDC.time.month_in_quarter" | "GDC.time.month_in_year" | "GDC.time.day_in_year" | "GDC.time.day_in_quarter" | "GDC.time.day_in_month" | "GDC.time.day_in_week" | "GDC.time.day_in_euweek" | "GDC.time.date" | "GDC.time.hour" | "GDC.time.hour_in_day" | "GDC.time.minute" | "GDC.time.minute_in_hour" | "GDC.time.fiscal_month" | "GDC.time.fiscal_quarter" | "GDC.time.fiscal_year";
483
+ 'type': AutomationDashboardDateFilterDateFilterTypeEnum;
484
+ 'granularity': AutomationDashboardDateFilterDateFilterGranularityEnum;
485
+ 'from'?: AutomationDashboardDateFilterDateFilterFrom;
486
+ 'to'?: AutomationDashboardDateFilterDateFilterFrom;
487
+ 'dataSet'?: AutomationIdentifierRef;
488
+ 'attribute'?: AutomationIdentifierRef;
489
+ 'boundedFilter'?: AutomationRelativeBoundedDateFilter;
490
+ 'includeEmptyValues'?: boolean;
491
+ 'localIdentifier'?: string;
492
+ }
493
+ export type AutomationDashboardDateFilterDateFilterTypeEnum = 'relative' | 'absolute';
494
+ export type AutomationDashboardDateFilterDateFilterGranularityEnum = 'ALL_TIME_GRANULARITY' | 'GDC.time.year' | 'GDC.time.week_us' | 'GDC.time.week_in_year' | 'GDC.time.week_in_quarter' | 'GDC.time.week' | 'GDC.time.euweek_in_year' | 'GDC.time.euweek_in_quarter' | 'GDC.time.quarter' | 'GDC.time.quarter_in_year' | 'GDC.time.month' | 'GDC.time.month_in_quarter' | 'GDC.time.month_in_year' | 'GDC.time.day_in_year' | 'GDC.time.day_in_quarter' | 'GDC.time.day_in_month' | 'GDC.time.day_in_week' | 'GDC.time.day_in_euweek' | 'GDC.time.date' | 'GDC.time.hour' | 'GDC.time.hour_in_day' | 'GDC.time.minute' | 'GDC.time.minute_in_hour' | 'GDC.time.fiscal_month' | 'GDC.time.fiscal_quarter' | 'GDC.time.fiscal_year';
495
495
  /**
496
496
  * @type AutomationDashboardDateFilterDateFilterFrom
497
497
  */
@@ -503,22 +503,22 @@ export interface AutomationDashboardExportSettings {
503
503
  /**
504
504
  * If true, the export will contain the information about the export – exported date, dashboard filters, etc.
505
505
  */
506
- exportInfo?: boolean;
506
+ 'exportInfo'?: boolean;
507
507
  /**
508
508
  * Merge equal headers in neighbouring cells. Used for [XLSX] format only.
509
509
  */
510
- mergeHeaders?: boolean;
510
+ 'mergeHeaders'?: boolean;
511
511
  /**
512
512
  * Set page size. (PDF)
513
513
  */
514
- pageSize?: AutomationDashboardExportSettingsPageSizeEnum;
514
+ 'pageSize'?: AutomationDashboardExportSettingsPageSizeEnum;
515
515
  /**
516
516
  * Set page orientation. (PDF)
517
517
  */
518
- pageOrientation?: AutomationDashboardExportSettingsPageOrientationEnum;
518
+ 'pageOrientation'?: AutomationDashboardExportSettingsPageOrientationEnum;
519
519
  }
520
- export type AutomationDashboardExportSettingsPageSizeEnum = "A3" | "A4" | "LETTER";
521
- export type AutomationDashboardExportSettingsPageOrientationEnum = "PORTRAIT" | "LANDSCAPE";
520
+ export type AutomationDashboardExportSettingsPageSizeEnum = 'A3' | 'A4' | 'LETTER';
521
+ export type AutomationDashboardExportSettingsPageOrientationEnum = 'PORTRAIT' | 'LANDSCAPE';
522
522
  /**
523
523
  * @type AutomationDashboardFilter
524
524
  */
@@ -530,39 +530,39 @@ export interface AutomationDashboardTabularExportRequestV2 {
530
530
  /**
531
531
  * Requested tabular export type.
532
532
  */
533
- format: AutomationDashboardTabularExportRequestV2FormatEnum;
533
+ 'format': AutomationDashboardTabularExportRequestV2FormatEnum;
534
534
  /**
535
535
  * Filename of downloaded file without extension.
536
536
  */
537
- fileName: string;
537
+ 'fileName': string;
538
538
  /**
539
539
  * List of filters that will be used instead of the default dashboard filters.
540
540
  */
541
- dashboardFiltersOverride?: Array<AutomationDashboardFilter>;
541
+ 'dashboardFiltersOverride'?: Array<AutomationDashboardFilter>;
542
542
  /**
543
543
  * Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.
544
544
  */
545
- dashboardTabsFiltersOverrides?: {
545
+ 'dashboardTabsFiltersOverrides'?: {
546
546
  [key: string]: Array<AutomationDashboardFilter>;
547
547
  };
548
548
  /**
549
549
  * Dashboard identifier
550
550
  */
551
- dashboardId: string;
551
+ 'dashboardId': string;
552
552
  /**
553
553
  * List of widget identifiers to be exported. Note that only one widget is currently supported.
554
554
  */
555
- widgetIds?: Array<string>;
556
- settings?: AutomationDashboardExportSettings;
555
+ 'widgetIds'?: Array<string>;
556
+ 'settings'?: AutomationDashboardExportSettings;
557
557
  }
558
- export type AutomationDashboardTabularExportRequestV2FormatEnum = "XLSX" | "PDF";
558
+ export type AutomationDashboardTabularExportRequestV2FormatEnum = 'XLSX' | 'PDF';
559
559
  /**
560
560
  * @type AutomationDateFilter
561
561
  * Abstract filter definition type for dates.
562
562
  */
563
563
  export type AutomationDateFilter = AutomationAbsoluteDateFilter | AutomationRelativeDateFilter;
564
564
  export interface AutomationDateValue {
565
- value: string;
565
+ 'value': string;
566
566
  }
567
567
  /**
568
568
  * An analytical dashboard identifier.
@@ -571,13 +571,13 @@ export interface AutomationDeclarativeAnalyticalDashboardIdentifier {
571
571
  /**
572
572
  * Identifier of the analytical dashboard.
573
573
  */
574
- id: string;
574
+ 'id': string;
575
575
  /**
576
576
  * A type.
577
577
  */
578
- type: AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum;
578
+ 'type': AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum;
579
579
  }
580
- export type AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum = "analyticalDashboard";
580
+ export type AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum = 'analyticalDashboard';
581
581
  /**
582
582
  * A notification channel identifier.
583
583
  */
@@ -585,13 +585,13 @@ export interface AutomationDeclarativeNotificationChannelIdentifier {
585
585
  /**
586
586
  * Notification channel identifier.
587
587
  */
588
- id: string;
588
+ 'id': string;
589
589
  /**
590
590
  * A type.
591
591
  */
592
- type: AutomationDeclarativeNotificationChannelIdentifierTypeEnum;
592
+ 'type': AutomationDeclarativeNotificationChannelIdentifierTypeEnum;
593
593
  }
594
- export type AutomationDeclarativeNotificationChannelIdentifierTypeEnum = "notificationChannel";
594
+ export type AutomationDeclarativeNotificationChannelIdentifierTypeEnum = 'notificationChannel';
595
595
  /**
596
596
  * A user identifier.
597
597
  */
@@ -599,13 +599,13 @@ export interface AutomationDeclarativeUserIdentifier {
599
599
  /**
600
600
  * User identifier.
601
601
  */
602
- id: string;
602
+ 'id': string;
603
603
  /**
604
604
  * A type.
605
605
  */
606
- type: AutomationDeclarativeUserIdentifierTypeEnum;
606
+ 'type': AutomationDeclarativeUserIdentifierTypeEnum;
607
607
  }
608
- export type AutomationDeclarativeUserIdentifierTypeEnum = "user";
608
+ export type AutomationDeclarativeUserIdentifierTypeEnum = 'user';
609
609
  /**
610
610
  * Default SMTP destination for notifications.
611
611
  */
@@ -613,17 +613,17 @@ export interface AutomationDefaultSmtp {
613
613
  /**
614
614
  * E-mail address to send notifications from. Currently this does not have any effect. E-mail \'no-reply@gooddata.com\' is used instead.
615
615
  */
616
- fromEmail?: string;
616
+ 'fromEmail'?: string;
617
617
  /**
618
618
  * An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name \'GoodData\' is used instead.
619
619
  */
620
- fromEmailName?: string;
620
+ 'fromEmailName'?: string;
621
621
  /**
622
622
  * The destination type.
623
623
  */
624
- type: AutomationDefaultSmtpTypeEnum;
624
+ 'type': AutomationDefaultSmtpTypeEnum;
625
625
  }
626
- export type AutomationDefaultSmtpTypeEnum = "DEFAULT_SMTP";
626
+ export type AutomationDefaultSmtpTypeEnum = 'DEFAULT_SMTP';
627
627
  /**
628
628
  * Various settings affecting the process of AFM execution or its result
629
629
  */
@@ -631,24 +631,24 @@ export interface AutomationExecutionSettings {
631
631
  /**
632
632
  * 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.
633
633
  */
634
- dataSamplingPercentage?: number;
634
+ 'dataSamplingPercentage'?: number;
635
635
  /**
636
636
  * Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.
637
637
  */
638
- timestamp?: string;
638
+ 'timestamp'?: string;
639
639
  }
640
640
  export interface AutomationExportResult {
641
- fileName: string;
642
- exportId: string;
643
- status: AutomationExportResultStatusEnum;
644
- fileUri?: string;
645
- expiresAt?: string;
646
- fileSize?: number;
647
- errorMessage?: string;
648
- traceId?: string;
649
- triggeredAt?: string;
650
- }
651
- export type AutomationExportResultStatusEnum = "SUCCESS" | "ERROR" | "INTERNAL_ERROR" | "TIMEOUT";
641
+ 'fileName': string;
642
+ 'exportId': string;
643
+ 'status': AutomationExportResultStatusEnum;
644
+ 'fileUri'?: string;
645
+ 'expiresAt'?: string;
646
+ 'fileSize'?: number;
647
+ 'errorMessage'?: string;
648
+ 'traceId'?: string;
649
+ 'triggeredAt'?: string;
650
+ }
651
+ export type AutomationExportResultStatusEnum = 'SUCCESS' | 'ERROR' | 'INTERNAL_ERROR' | 'TIMEOUT';
652
652
  /**
653
653
  * @type AutomationFilterDefinition
654
654
  * Abstract filter definition type
@@ -660,13 +660,13 @@ export type AutomationFilterDefinition = AutomationAbsoluteDateFilter | Automati
660
660
  */
661
661
  export type AutomationFilterDefinitionForSimpleMeasure = AutomationAttributeFilter | AutomationDateFilter;
662
662
  export interface AutomationIdentifierRef {
663
- identifier?: AutomationIdentifierRefIdentifier;
663
+ 'identifier'?: AutomationIdentifierRefIdentifier;
664
664
  }
665
665
  export interface AutomationIdentifierRefIdentifier {
666
- id: string;
667
- type: AutomationIdentifierRefIdentifierTypeEnum;
666
+ 'id': string;
667
+ 'type': AutomationIdentifierRefIdentifierTypeEnum;
668
668
  }
669
- export type AutomationIdentifierRefIdentifierTypeEnum = "analyticalDashboard" | "attribute" | "attributeHierarchy" | "dashboardPlugin" | "dataset" | "fact" | "aggregatedFact" | "label" | "metric" | "userDataFilter" | "exportDefinition" | "automation" | "automationResult" | "memoryItem" | "knowledgeRecommendation" | "prompt" | "visualizationObject" | "filterContext" | "workspaceSettings" | "customApplicationSetting" | "workspaceDataFilter" | "workspaceDataFilterSetting" | "filterView";
669
+ export type AutomationIdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'userDataFilter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView';
670
670
  /**
671
671
  * Export request object describing the export properties and metadata for image exports.
672
672
  */
@@ -674,25 +674,25 @@ export interface AutomationImageExportRequest {
674
674
  /**
675
675
  * Requested resulting file type.
676
676
  */
677
- format: AutomationImageExportRequestFormatEnum;
677
+ 'format': AutomationImageExportRequestFormatEnum;
678
678
  /**
679
679
  * File name to be used for retrieving the image document.
680
680
  */
681
- fileName: string;
681
+ 'fileName': string;
682
682
  /**
683
683
  * Dashboard identifier
684
684
  */
685
- dashboardId: string;
685
+ 'dashboardId': string;
686
686
  /**
687
687
  * List of widget identifiers to be exported. Note that only one widget is currently supported.
688
688
  */
689
- widgetIds: Array<string>;
689
+ 'widgetIds': Array<string>;
690
690
  /**
691
691
  * Metadata definition in free-form JSON format.
692
692
  */
693
- metadata?: object | null;
693
+ 'metadata'?: object | null;
694
694
  }
695
- export type AutomationImageExportRequestFormatEnum = "PNG";
695
+ export type AutomationImageExportRequestFormatEnum = 'PNG';
696
696
  /**
697
697
  * In-platform destination for notifications.
698
698
  */
@@ -700,48 +700,48 @@ export interface AutomationInPlatform {
700
700
  /**
701
701
  * The destination type.
702
702
  */
703
- type: AutomationInPlatformTypeEnum;
703
+ 'type': AutomationInPlatformTypeEnum;
704
704
  }
705
- export type AutomationInPlatformTypeEnum = "IN_PLATFORM";
705
+ export type AutomationInPlatformTypeEnum = 'IN_PLATFORM';
706
706
  /**
707
707
  * Filter in form of direct MAQL query.
708
708
  */
709
709
  export interface AutomationInlineFilterDefinition {
710
- inline: AutomationInlineFilterDefinitionInline;
710
+ 'inline': AutomationInlineFilterDefinitionInline;
711
711
  }
712
712
  export interface AutomationInlineFilterDefinitionInline {
713
713
  /**
714
714
  * MAQL query representing the filter.
715
715
  */
716
- filter: string;
717
- localIdentifier?: string;
718
- applyOnResult?: boolean;
716
+ 'filter': string;
717
+ 'localIdentifier'?: string;
718
+ 'applyOnResult'?: boolean;
719
719
  }
720
720
  /**
721
721
  * Metric defined by the raw MAQL query.
722
722
  */
723
723
  export interface AutomationInlineMeasureDefinition {
724
- inline: AutomationInlineMeasureDefinitionInline;
724
+ 'inline': AutomationInlineMeasureDefinitionInline;
725
725
  }
726
726
  export interface AutomationInlineMeasureDefinitionInline {
727
727
  /**
728
728
  * MAQL query defining the metric.
729
729
  */
730
- maql: string;
730
+ 'maql': string;
731
731
  }
732
732
  export interface AutomationLocalIdentifier {
733
733
  /**
734
734
  * Local identifier of the metric to be compared.
735
735
  */
736
- localIdentifier: string;
736
+ 'localIdentifier': string;
737
737
  /**
738
738
  * Metric format.
739
739
  */
740
- format?: string | null;
740
+ 'format'?: string | null;
741
741
  /**
742
742
  * Metric title.
743
743
  */
744
- title?: string | null;
744
+ 'title'?: string | null;
745
745
  }
746
746
  /**
747
747
  * @type AutomationMeasureDefinition
@@ -755,8 +755,8 @@ export interface AutomationMeasureItem {
755
755
  /**
756
756
  * Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
757
757
  */
758
- localIdentifier: string;
759
- definition: AutomationMeasureItemDefinition;
758
+ 'localIdentifier': string;
759
+ 'definition': AutomationMeasureItemDefinition;
760
760
  }
761
761
  /**
762
762
  * @type AutomationMeasureItemDefinition
@@ -773,57 +773,57 @@ export type AutomationMeasureValueCondition = AutomationComparisonCondition | Au
773
773
  */
774
774
  export type AutomationMeasureValueFilter = AutomationComparisonMeasureValueFilter | AutomationCompoundMeasureValueFilter | AutomationRangeMeasureValueFilter;
775
775
  export interface AutomationMetricRecord {
776
- value: number;
777
- formattedValue?: string;
776
+ 'value': number;
777
+ 'formattedValue'?: string;
778
778
  }
779
779
  /**
780
780
  * Filter able to limit element values by label and related selected negated elements.
781
781
  */
782
782
  export interface AutomationNegativeAttributeFilter {
783
- negativeAttributeFilter: AutomationNegativeAttributeFilterNegativeAttributeFilter;
783
+ 'negativeAttributeFilter': AutomationNegativeAttributeFilterNegativeAttributeFilter;
784
784
  }
785
785
  export interface AutomationNegativeAttributeFilterNegativeAttributeFilter {
786
- notIn: AutomationAttributeFilterElements;
787
- localIdentifier?: string;
788
- applyOnResult?: boolean;
789
- label: AutomationAfmIdentifier;
786
+ 'notIn': AutomationAttributeFilterElements;
787
+ 'localIdentifier'?: string;
788
+ 'applyOnResult'?: boolean;
789
+ 'label': AutomationAfmIdentifier;
790
790
  }
791
791
  export interface AutomationNotification {
792
- id: string;
793
- workspaceId?: string;
794
- automationId?: string;
795
- data: AutomationNotificationData;
796
- isRead: boolean;
797
- createdAt: string;
792
+ 'id': string;
793
+ 'workspaceId'?: string;
794
+ 'automationId'?: string;
795
+ 'data': AutomationNotificationData;
796
+ 'isRead': boolean;
797
+ 'createdAt': string;
798
798
  }
799
799
  /**
800
800
  * @type AutomationNotificationChannelDestination
801
801
  */
802
802
  export type AutomationNotificationChannelDestination = AutomationDefaultSmtp | AutomationInPlatform | AutomationSmtp | AutomationWebhook;
803
803
  export interface AutomationNotificationContent {
804
- type: string;
804
+ 'type': string;
805
805
  }
806
806
  /**
807
807
  * @type AutomationNotificationData
808
808
  */
809
809
  export type AutomationNotificationData = AutomationAutomationNotification | AutomationTestNotification;
810
810
  export interface AutomationNotificationFilter {
811
- title: string;
812
- filter: string;
811
+ 'title': string;
812
+ 'filter': string;
813
813
  }
814
814
  export interface AutomationNotifications {
815
- data: Array<AutomationNotification>;
816
- meta: AutomationNotificationsMeta;
815
+ 'data': Array<AutomationNotification>;
816
+ 'meta': AutomationNotificationsMeta;
817
817
  }
818
818
  export interface AutomationNotificationsMeta {
819
- total?: AutomationNotificationsMetaTotal;
819
+ 'total'?: AutomationNotificationsMetaTotal;
820
820
  }
821
821
  export interface AutomationNotificationsMetaTotal {
822
- unread: number;
823
- all: number;
822
+ 'unread': number;
823
+ 'all': number;
824
824
  }
825
825
  export interface AutomationOver {
826
- attributes: Array<AutomationIdentifierRef>;
826
+ 'attributes': Array<AutomationIdentifierRef>;
827
827
  }
828
828
  /**
829
829
  * Custom CSS styles for the table. (PDF, HTML)
@@ -832,11 +832,11 @@ export interface AutomationPdfTableStyle {
832
832
  /**
833
833
  * CSS selector where to apply given properties.
834
834
  */
835
- selector: string;
835
+ 'selector': string;
836
836
  /**
837
837
  * List of CSS properties.
838
838
  */
839
- properties?: Array<AutomationPdfTableStyleProperty>;
839
+ 'properties'?: Array<AutomationPdfTableStyleProperty>;
840
840
  }
841
841
  /**
842
842
  * CSS property.
@@ -845,57 +845,57 @@ export interface AutomationPdfTableStyleProperty {
845
845
  /**
846
846
  * CSS property key.
847
847
  */
848
- key: string;
848
+ 'key': string;
849
849
  /**
850
850
  * CSS property value.
851
851
  */
852
- value: string;
852
+ 'value': string;
853
853
  }
854
854
  /**
855
855
  * Combination of the date data set to use and how many periods ago to calculate the previous period for.
856
856
  */
857
857
  export interface AutomationPopDataset {
858
- dataset: AutomationAfmObjectIdentifierDataset;
858
+ 'dataset': AutomationAfmObjectIdentifierDataset;
859
859
  /**
860
860
  * Number of periods ago to calculate the previous period for.
861
861
  */
862
- periodsAgo: number;
862
+ 'periodsAgo': number;
863
863
  }
864
864
  /**
865
865
  * Previous period type of metric.
866
866
  */
867
867
  export interface AutomationPopDatasetMeasureDefinition {
868
- previousPeriodMeasure: AutomationPopDatasetMeasureDefinitionPreviousPeriodMeasure;
868
+ 'previousPeriodMeasure': AutomationPopDatasetMeasureDefinitionPreviousPeriodMeasure;
869
869
  }
870
870
  export interface AutomationPopDatasetMeasureDefinitionPreviousPeriodMeasure {
871
- measureIdentifier: AutomationAfmLocalIdentifier;
871
+ 'measureIdentifier': AutomationAfmLocalIdentifier;
872
872
  /**
873
873
  * Specification of which date data sets to use for determining the period to calculate the previous period for.
874
874
  */
875
- dateDatasets: Array<AutomationPopDataset>;
875
+ 'dateDatasets': Array<AutomationPopDataset>;
876
876
  }
877
877
  /**
878
878
  * Combination of the date attribute to use and how many periods ago to calculate the PoP for.
879
879
  */
880
880
  export interface AutomationPopDate {
881
- attribute: AutomationAfmObjectIdentifierAttribute;
881
+ 'attribute': AutomationAfmObjectIdentifierAttribute;
882
882
  /**
883
883
  * Number of periods ago to calculate the previous period for.
884
884
  */
885
- periodsAgo: number;
885
+ 'periodsAgo': number;
886
886
  }
887
887
  /**
888
888
  * Period over period type of metric.
889
889
  */
890
890
  export interface AutomationPopDateMeasureDefinition {
891
- overPeriodMeasure: AutomationPopDateMeasureDefinitionOverPeriodMeasure;
891
+ 'overPeriodMeasure': AutomationPopDateMeasureDefinitionOverPeriodMeasure;
892
892
  }
893
893
  export interface AutomationPopDateMeasureDefinitionOverPeriodMeasure {
894
- measureIdentifier: AutomationAfmLocalIdentifier;
894
+ 'measureIdentifier': AutomationAfmLocalIdentifier;
895
895
  /**
896
896
  * Attributes to use for determining the period to calculate the PoP for.
897
897
  */
898
- dateAttributes: Array<AutomationPopDate>;
898
+ 'dateAttributes': Array<AutomationPopDate>;
899
899
  }
900
900
  /**
901
901
  * @type AutomationPopMeasureDefinition
@@ -905,86 +905,86 @@ export type AutomationPopMeasureDefinition = AutomationPopDatasetMeasureDefiniti
905
905
  * Filter able to limit element values by label and related selected elements.
906
906
  */
907
907
  export interface AutomationPositiveAttributeFilter {
908
- positiveAttributeFilter: AutomationPositiveAttributeFilterPositiveAttributeFilter;
908
+ 'positiveAttributeFilter': AutomationPositiveAttributeFilterPositiveAttributeFilter;
909
909
  }
910
910
  export interface AutomationPositiveAttributeFilterPositiveAttributeFilter {
911
- in: AutomationAttributeFilterElements;
912
- localIdentifier?: string;
913
- applyOnResult?: boolean;
914
- label: AutomationAfmIdentifier;
911
+ 'in': AutomationAttributeFilterElements;
912
+ 'localIdentifier'?: string;
913
+ 'applyOnResult'?: boolean;
914
+ 'label': AutomationAfmIdentifier;
915
915
  }
916
916
  export interface AutomationRange {
917
- operator: AutomationRangeOperatorEnum;
918
- measure: AutomationLocalIdentifier;
919
- from: AutomationValue;
920
- to: AutomationValue;
917
+ 'operator': AutomationRangeOperatorEnum;
918
+ 'measure': AutomationLocalIdentifier;
919
+ 'from': AutomationValue;
920
+ 'to': AutomationValue;
921
921
  }
922
- export type AutomationRangeOperatorEnum = "BETWEEN" | "NOT_BETWEEN";
922
+ export type AutomationRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
923
923
  /**
924
924
  * Condition that checks if the metric value is within a given range.
925
925
  */
926
926
  export interface AutomationRangeCondition {
927
- range: AutomationRangeConditionRange;
927
+ 'range': AutomationRangeConditionRange;
928
928
  }
929
929
  export interface AutomationRangeConditionRange {
930
- operator: AutomationRangeConditionRangeOperatorEnum;
931
- from: number;
932
- to: number;
930
+ 'operator': AutomationRangeConditionRangeOperatorEnum;
931
+ 'from': number;
932
+ 'to': number;
933
933
  }
934
- export type AutomationRangeConditionRangeOperatorEnum = "BETWEEN" | "NOT_BETWEEN";
934
+ export type AutomationRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
935
935
  /**
936
936
  * Filter the result by comparing specified metric to given range of values.
937
937
  */
938
938
  export interface AutomationRangeMeasureValueFilter {
939
- rangeMeasureValueFilter: AutomationRangeMeasureValueFilterRangeMeasureValueFilter;
939
+ 'rangeMeasureValueFilter': AutomationRangeMeasureValueFilterRangeMeasureValueFilter;
940
940
  }
941
941
  export interface AutomationRangeMeasureValueFilterRangeMeasureValueFilter {
942
942
  /**
943
943
  * References to the attributes to be used when filtering.
944
944
  */
945
- dimensionality?: Array<AutomationAfmIdentifier>;
945
+ 'dimensionality'?: Array<AutomationAfmIdentifier>;
946
946
  /**
947
947
  * A value that will be substituted for null values in the metric for the comparisons.
948
948
  */
949
- treatNullValuesAs?: number;
950
- operator: AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
951
- from: number;
952
- to: number;
953
- localIdentifier?: string;
954
- applyOnResult?: boolean;
955
- measure: AutomationAfmIdentifier;
949
+ 'treatNullValuesAs'?: number;
950
+ 'operator': AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
951
+ 'from': number;
952
+ 'to': number;
953
+ 'localIdentifier'?: string;
954
+ 'applyOnResult'?: boolean;
955
+ 'measure': AutomationAfmIdentifier;
956
956
  }
957
- export type AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = "BETWEEN" | "NOT_BETWEEN";
957
+ export type AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
958
958
  export interface AutomationRangeWrapper {
959
- range: AutomationRange;
959
+ 'range': AutomationRange;
960
960
  }
961
961
  /**
962
962
  * Filter the result on top/bottom N values according to given metric(s).
963
963
  */
964
964
  export interface AutomationRankingFilter {
965
- rankingFilter: AutomationRankingFilterRankingFilter;
965
+ 'rankingFilter': AutomationRankingFilterRankingFilter;
966
966
  }
967
967
  export interface AutomationRankingFilterRankingFilter {
968
968
  /**
969
969
  * References to the attributes to be used when filtering.
970
970
  */
971
- dimensionality?: Array<AutomationAfmIdentifier>;
971
+ 'dimensionality'?: Array<AutomationAfmIdentifier>;
972
972
  /**
973
973
  * References to the metrics to be used when filtering.
974
974
  */
975
- measures: Array<AutomationAfmIdentifier>;
975
+ 'measures': Array<AutomationAfmIdentifier>;
976
976
  /**
977
977
  * The type of ranking to use, TOP or BOTTOM.
978
978
  */
979
- operator: AutomationRankingFilterRankingFilterOperatorEnum;
979
+ 'operator': AutomationRankingFilterRankingFilterOperatorEnum;
980
980
  /**
981
981
  * Number of top/bottom values to filter.
982
982
  */
983
- value: number;
984
- localIdentifier?: string;
985
- applyOnResult?: boolean;
983
+ 'value': number;
984
+ 'localIdentifier'?: string;
985
+ 'applyOnResult'?: boolean;
986
986
  }
987
- export type AutomationRankingFilterRankingFilterOperatorEnum = "TOP" | "BOTTOM";
987
+ export type AutomationRankingFilterRankingFilterOperatorEnum = 'TOP' | 'BOTTOM';
988
988
  /**
989
989
  * Custom label object override.
990
990
  */
@@ -992,7 +992,7 @@ export interface AutomationRawCustomLabel {
992
992
  /**
993
993
  * Override value.
994
994
  */
995
- title: string;
995
+ 'title': string;
996
996
  }
997
997
  /**
998
998
  * Custom metric object override.
@@ -1001,7 +1001,7 @@ export interface AutomationRawCustomMetric {
1001
1001
  /**
1002
1002
  * Metric title override.
1003
1003
  */
1004
- title: string;
1004
+ 'title': string;
1005
1005
  }
1006
1006
  /**
1007
1007
  * Custom cell value overrides (IDs will be replaced with specified values).
@@ -1010,13 +1010,13 @@ export interface AutomationRawCustomOverride {
1010
1010
  /**
1011
1011
  * Map of CustomLabels with keys used as placeholders in export result.
1012
1012
  */
1013
- labels?: {
1013
+ 'labels'?: {
1014
1014
  [key: string]: AutomationRawCustomLabel;
1015
1015
  };
1016
1016
  /**
1017
1017
  * Map of CustomMetrics with keys used as placeholders in export result.
1018
1018
  */
1019
- metrics?: {
1019
+ 'metrics'?: {
1020
1020
  [key: string]: AutomationRawCustomMetric;
1021
1021
  };
1022
1022
  }
@@ -1027,70 +1027,70 @@ export interface AutomationRawExportAutomationRequest {
1027
1027
  /**
1028
1028
  * Requested resulting file type.
1029
1029
  */
1030
- format: AutomationRawExportAutomationRequestFormatEnum;
1031
- execution: AutomationAFM;
1030
+ 'format': AutomationRawExportAutomationRequestFormatEnum;
1031
+ 'execution': AutomationAFM;
1032
1032
  /**
1033
1033
  * Filename of downloaded file without extension.
1034
1034
  */
1035
- fileName: string;
1036
- customOverride?: AutomationRawCustomOverride;
1037
- executionSettings?: AutomationExecutionSettings;
1035
+ 'fileName': string;
1036
+ 'customOverride'?: AutomationRawCustomOverride;
1037
+ 'executionSettings'?: AutomationExecutionSettings;
1038
1038
  /**
1039
1039
  * Set column delimiter. (CSV)
1040
1040
  */
1041
- delimiter?: string;
1041
+ 'delimiter'?: string;
1042
1042
  /**
1043
1043
  * Metadata definition in free-form JSON format.
1044
1044
  */
1045
- metadata?: object | null;
1045
+ 'metadata'?: object | null;
1046
1046
  }
1047
- export type AutomationRawExportAutomationRequestFormatEnum = "ARROW_FILE" | "ARROW_STREAM" | "CSV";
1047
+ export type AutomationRawExportAutomationRequestFormatEnum = 'ARROW_FILE' | 'ARROW_STREAM' | 'CSV';
1048
1048
  export interface AutomationRelative {
1049
1049
  /**
1050
1050
  * 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.
1051
1051
  */
1052
- operator: AutomationRelativeOperatorEnum;
1053
- measure: AutomationArithmeticMeasure;
1054
- threshold: AutomationValue;
1052
+ 'operator': AutomationRelativeOperatorEnum;
1053
+ 'measure': AutomationArithmeticMeasure;
1054
+ 'threshold': AutomationValue;
1055
1055
  }
1056
- export type AutomationRelativeOperatorEnum = "INCREASES_BY" | "DECREASES_BY" | "CHANGES_BY";
1056
+ export type AutomationRelativeOperatorEnum = 'INCREASES_BY' | 'DECREASES_BY' | 'CHANGES_BY';
1057
1057
  export interface AutomationRelativeBoundedDateFilter {
1058
- granularity: AutomationRelativeBoundedDateFilterGranularityEnum;
1059
- from?: number;
1060
- to?: number;
1058
+ 'granularity': AutomationRelativeBoundedDateFilterGranularityEnum;
1059
+ 'from'?: number;
1060
+ 'to'?: number;
1061
1061
  }
1062
- export type AutomationRelativeBoundedDateFilterGranularityEnum = "ALL_TIME_GRANULARITY" | "GDC.time.year" | "GDC.time.week_us" | "GDC.time.week_in_year" | "GDC.time.week_in_quarter" | "GDC.time.week" | "GDC.time.euweek_in_year" | "GDC.time.euweek_in_quarter" | "GDC.time.quarter" | "GDC.time.quarter_in_year" | "GDC.time.month" | "GDC.time.month_in_quarter" | "GDC.time.month_in_year" | "GDC.time.day_in_year" | "GDC.time.day_in_quarter" | "GDC.time.day_in_month" | "GDC.time.day_in_week" | "GDC.time.day_in_euweek" | "GDC.time.date" | "GDC.time.hour" | "GDC.time.hour_in_day" | "GDC.time.minute" | "GDC.time.minute_in_hour" | "GDC.time.fiscal_month" | "GDC.time.fiscal_quarter" | "GDC.time.fiscal_year";
1062
+ export type AutomationRelativeBoundedDateFilterGranularityEnum = 'ALL_TIME_GRANULARITY' | 'GDC.time.year' | 'GDC.time.week_us' | 'GDC.time.week_in_year' | 'GDC.time.week_in_quarter' | 'GDC.time.week' | 'GDC.time.euweek_in_year' | 'GDC.time.euweek_in_quarter' | 'GDC.time.quarter' | 'GDC.time.quarter_in_year' | 'GDC.time.month' | 'GDC.time.month_in_quarter' | 'GDC.time.month_in_year' | 'GDC.time.day_in_year' | 'GDC.time.day_in_quarter' | 'GDC.time.day_in_month' | 'GDC.time.day_in_week' | 'GDC.time.day_in_euweek' | 'GDC.time.date' | 'GDC.time.hour' | 'GDC.time.hour_in_day' | 'GDC.time.minute' | 'GDC.time.minute_in_hour' | 'GDC.time.fiscal_month' | 'GDC.time.fiscal_quarter' | 'GDC.time.fiscal_year';
1063
1063
  /**
1064
1064
  * 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.
1065
1065
  */
1066
1066
  export interface AutomationRelativeDateFilter {
1067
- relativeDateFilter: AutomationRelativeDateFilterRelativeDateFilter;
1067
+ 'relativeDateFilter': AutomationRelativeDateFilterRelativeDateFilter;
1068
1068
  }
1069
1069
  export interface AutomationRelativeDateFilterRelativeDateFilter {
1070
1070
  /**
1071
1071
  * Date granularity specifying particular date attribute in given dimension.
1072
1072
  */
1073
- granularity: AutomationRelativeDateFilterRelativeDateFilterGranularityEnum;
1073
+ 'granularity': AutomationRelativeDateFilterRelativeDateFilterGranularityEnum;
1074
1074
  /**
1075
1075
  * 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\').
1076
1076
  */
1077
- from: number;
1077
+ 'from': number;
1078
1078
  /**
1079
1079
  * 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, ...).
1080
1080
  */
1081
- to: number;
1082
- localIdentifier?: string;
1083
- applyOnResult?: boolean;
1084
- boundedFilter?: AutomationBoundedFilter;
1081
+ 'to': number;
1082
+ 'localIdentifier'?: string;
1083
+ 'applyOnResult'?: boolean;
1084
+ 'boundedFilter'?: AutomationBoundedFilter;
1085
1085
  /**
1086
1086
  * If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).
1087
1087
  */
1088
- includeEmptyValues?: boolean;
1089
- dataset: AutomationAfmObjectIdentifierDataset;
1088
+ 'includeEmptyValues'?: boolean;
1089
+ 'dataset': AutomationAfmObjectIdentifierDataset;
1090
1090
  }
1091
- export type AutomationRelativeDateFilterRelativeDateFilterGranularityEnum = "MINUTE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR" | "MINUTE_OF_HOUR" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_QUARTER" | "DAY_OF_YEAR" | "WEEK_OF_YEAR" | "MONTH_OF_YEAR" | "QUARTER_OF_YEAR" | "FISCAL_MONTH" | "FISCAL_QUARTER" | "FISCAL_YEAR";
1091
+ export type AutomationRelativeDateFilterRelativeDateFilterGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
1092
1092
  export interface AutomationRelativeWrapper {
1093
- relative: AutomationRelative;
1093
+ 'relative': AutomationRelative;
1094
1094
  }
1095
1095
  /**
1096
1096
  * Additional settings.
@@ -1099,73 +1099,73 @@ export interface AutomationSettings {
1099
1099
  /**
1100
1100
  * If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)
1101
1101
  */
1102
- exportInfo?: boolean;
1102
+ 'exportInfo'?: boolean;
1103
1103
  /**
1104
1104
  * Merge equal headers in neighbouring cells. (XLSX)
1105
1105
  */
1106
- mergeHeaders?: boolean;
1106
+ 'mergeHeaders'?: boolean;
1107
1107
  /**
1108
1108
  * Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)
1109
1109
  * @deprecated
1110
1110
  */
1111
- showFilters?: boolean;
1111
+ 'showFilters'?: boolean;
1112
1112
  /**
1113
1113
  * Page size and orientation. (PDF)
1114
1114
  * @deprecated
1115
1115
  */
1116
- pdfPageSize?: string;
1116
+ 'pdfPageSize'?: string;
1117
1117
  /**
1118
1118
  * Custom CSS styles for the table. (PDF, HTML)
1119
1119
  * @deprecated
1120
1120
  */
1121
- pdfTableStyle?: Array<AutomationPdfTableStyle>;
1121
+ 'pdfTableStyle'?: Array<AutomationPdfTableStyle>;
1122
1122
  /**
1123
1123
  * Top left header content. (PDF)
1124
1124
  * @deprecated
1125
1125
  */
1126
- pdfTopLeftContent?: string;
1126
+ 'pdfTopLeftContent'?: string;
1127
1127
  /**
1128
1128
  * Top right header content. (PDF)
1129
1129
  * @deprecated
1130
1130
  */
1131
- pdfTopRightContent?: string;
1131
+ 'pdfTopRightContent'?: string;
1132
1132
  /**
1133
1133
  * Set page size. (PDF)
1134
1134
  */
1135
- pageSize?: AutomationSettingsPageSizeEnum;
1135
+ 'pageSize'?: AutomationSettingsPageSizeEnum;
1136
1136
  /**
1137
1137
  * Set page orientation. (PDF)
1138
1138
  */
1139
- pageOrientation?: AutomationSettingsPageOrientationEnum;
1139
+ 'pageOrientation'?: AutomationSettingsPageOrientationEnum;
1140
1140
  /**
1141
1141
  * Set column delimiter. (CSV)
1142
1142
  */
1143
- delimiter?: string;
1143
+ 'delimiter'?: string;
1144
1144
  }
1145
- export type AutomationSettingsPageSizeEnum = "A3" | "A4" | "LETTER";
1146
- export type AutomationSettingsPageOrientationEnum = "PORTRAIT" | "LANDSCAPE";
1145
+ export type AutomationSettingsPageSizeEnum = 'A3' | 'A4' | 'LETTER';
1146
+ export type AutomationSettingsPageOrientationEnum = 'PORTRAIT' | 'LANDSCAPE';
1147
1147
  /**
1148
1148
  * Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
1149
1149
  */
1150
1150
  export interface AutomationSimpleMeasureDefinition {
1151
- measure: AutomationSimpleMeasureDefinitionMeasure;
1151
+ 'measure': AutomationSimpleMeasureDefinitionMeasure;
1152
1152
  }
1153
1153
  export interface AutomationSimpleMeasureDefinitionMeasure {
1154
- item: AutomationAfmObjectIdentifierCore;
1154
+ 'item': AutomationAfmObjectIdentifierCore;
1155
1155
  /**
1156
1156
  * Definition of aggregation type of the metric.
1157
1157
  */
1158
- aggregation?: AutomationSimpleMeasureDefinitionMeasureAggregationEnum;
1158
+ 'aggregation'?: AutomationSimpleMeasureDefinitionMeasureAggregationEnum;
1159
1159
  /**
1160
1160
  * If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).
1161
1161
  */
1162
- computeRatio?: boolean;
1162
+ 'computeRatio'?: boolean;
1163
1163
  /**
1164
1164
  * Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.
1165
1165
  */
1166
- filters?: Array<AutomationFilterDefinitionForSimpleMeasure>;
1166
+ 'filters'?: Array<AutomationFilterDefinitionForSimpleMeasure>;
1167
1167
  }
1168
- export type AutomationSimpleMeasureDefinitionMeasureAggregationEnum = "SUM" | "COUNT" | "AVG" | "MIN" | "MAX" | "MEDIAN" | "RUNSUM" | "APPROXIMATE_COUNT";
1168
+ export type AutomationSimpleMeasureDefinitionMeasureAggregationEnum = 'SUM' | 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'RUNSUM' | 'APPROXIMATE_COUNT';
1169
1169
  /**
1170
1170
  * Export request object describing the export properties and metadata for slides exports.
1171
1171
  */
@@ -1173,33 +1173,33 @@ export interface AutomationSlidesExportRequest {
1173
1173
  /**
1174
1174
  * Requested resulting file type.
1175
1175
  */
1176
- format: AutomationSlidesExportRequestFormatEnum;
1176
+ 'format': AutomationSlidesExportRequestFormatEnum;
1177
1177
  /**
1178
1178
  * File name to be used for retrieving the pdf document.
1179
1179
  */
1180
- fileName: string;
1180
+ 'fileName': string;
1181
1181
  /**
1182
1182
  * Dashboard identifier
1183
1183
  */
1184
- dashboardId?: string;
1184
+ 'dashboardId'?: string;
1185
1185
  /**
1186
1186
  * List of widget identifiers to be exported. Note that only one widget is currently supported.
1187
1187
  */
1188
- widgetIds?: Array<string>;
1188
+ 'widgetIds'?: Array<string>;
1189
1189
  /**
1190
1190
  * List of visualization ids to be exported. Note that only one visualization is currently supported.
1191
1191
  */
1192
- visualizationIds?: Array<string>;
1192
+ 'visualizationIds'?: Array<string>;
1193
1193
  /**
1194
1194
  * Metadata definition in free-form JSON format.
1195
1195
  */
1196
- metadata?: object | null;
1196
+ 'metadata'?: object | null;
1197
1197
  /**
1198
1198
  * Export template identifier.
1199
1199
  */
1200
- templateId?: string | null;
1200
+ 'templateId'?: string | null;
1201
1201
  }
1202
- export type AutomationSlidesExportRequestFormatEnum = "PDF" | "PPTX";
1202
+ export type AutomationSlidesExportRequestFormatEnum = 'PDF' | 'PPTX';
1203
1203
  /**
1204
1204
  * Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update
1205
1205
  */
@@ -1207,34 +1207,34 @@ export interface AutomationSmtp {
1207
1207
  /**
1208
1208
  * E-mail address to send notifications from.
1209
1209
  */
1210
- fromEmail?: string;
1210
+ 'fromEmail'?: string;
1211
1211
  /**
1212
1212
  * An optional e-mail name to send notifications from.
1213
1213
  */
1214
- fromEmailName?: string;
1214
+ 'fromEmailName'?: string;
1215
1215
  /**
1216
1216
  * The SMTP server address.
1217
1217
  */
1218
- host?: string;
1218
+ 'host'?: string;
1219
1219
  /**
1220
1220
  * The SMTP server port.
1221
1221
  */
1222
- port?: AutomationSmtpPortEnum;
1222
+ 'port'?: AutomationSmtpPortEnum;
1223
1223
  /**
1224
1224
  * The SMTP server username.
1225
1225
  */
1226
- username?: string;
1226
+ 'username'?: string;
1227
1227
  /**
1228
1228
  * The SMTP server password.
1229
1229
  */
1230
- password?: string;
1230
+ 'password'?: string;
1231
1231
  /**
1232
1232
  * The destination type.
1233
1233
  */
1234
- type: AutomationSmtpTypeEnum;
1234
+ 'type': AutomationSmtpTypeEnum;
1235
1235
  }
1236
1236
  export type AutomationSmtpPortEnum = 25 | 465 | 587 | 2525;
1237
- export type AutomationSmtpTypeEnum = "SMTP";
1237
+ export type AutomationSmtpTypeEnum = 'SMTP';
1238
1238
  /**
1239
1239
  * Export request object describing the export properties and overrides for tabular exports.
1240
1240
  */
@@ -1242,51 +1242,51 @@ export interface AutomationTabularExportRequest {
1242
1242
  /**
1243
1243
  * Expected file format.
1244
1244
  */
1245
- format: AutomationTabularExportRequestFormatEnum;
1245
+ 'format': AutomationTabularExportRequestFormatEnum;
1246
1246
  /**
1247
1247
  * Execution result identifier.
1248
1248
  */
1249
- executionResult?: string;
1249
+ 'executionResult'?: string;
1250
1250
  /**
1251
1251
  * Filename of downloaded file without extension.
1252
1252
  */
1253
- fileName: string;
1254
- settings?: AutomationSettings;
1255
- customOverride?: AutomationCustomOverride;
1253
+ 'fileName': string;
1254
+ 'settings'?: AutomationSettings;
1255
+ 'customOverride'?: AutomationCustomOverride;
1256
1256
  /**
1257
1257
  * Visualization object identifier. Alternative to executionResult property.
1258
1258
  */
1259
- visualizationObject?: string;
1259
+ 'visualizationObject'?: string;
1260
1260
  /**
1261
1261
  * Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.
1262
1262
  */
1263
- visualizationObjectCustomFilters?: Array<object>;
1263
+ 'visualizationObjectCustomFilters'?: Array<object>;
1264
1264
  /**
1265
1265
  * Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
1266
1266
  */
1267
- relatedDashboardId?: string;
1267
+ 'relatedDashboardId'?: string;
1268
1268
  /**
1269
1269
  * Metadata definition in free-form JSON format.
1270
1270
  */
1271
- metadata?: object | null;
1271
+ 'metadata'?: object | null;
1272
1272
  }
1273
- export type AutomationTabularExportRequestFormatEnum = "CSV" | "XLSX" | "HTML" | "PDF";
1273
+ export type AutomationTabularExportRequestFormatEnum = 'CSV' | 'XLSX' | 'HTML' | 'PDF';
1274
1274
  /**
1275
1275
  * Request body with notification channel destination to test.
1276
1276
  */
1277
1277
  export interface AutomationTestDestinationRequest {
1278
- destination: AutomationTestDestinationRequestDestination;
1278
+ 'destination': AutomationTestDestinationRequestDestination;
1279
1279
  /**
1280
1280
  * External recipients of the test result.
1281
1281
  */
1282
- externalRecipients?: Array<AutomationAutomationExternalRecipient> | null;
1282
+ 'externalRecipients'?: Array<AutomationAutomationExternalRecipient> | null;
1283
1283
  }
1284
1284
  /**
1285
1285
  * @type AutomationTestDestinationRequestDestination
1286
1286
  */
1287
1287
  export type AutomationTestDestinationRequestDestination = AutomationDefaultSmtp | AutomationInPlatform | AutomationSmtp | AutomationWebhook;
1288
1288
  export interface AutomationTestNotification extends AutomationNotificationContent {
1289
- message: string;
1289
+ 'message': string;
1290
1290
  }
1291
1291
  /**
1292
1292
  * Response from notification channel testing.
@@ -1295,28 +1295,28 @@ export interface AutomationTestResponse {
1295
1295
  /**
1296
1296
  * A flag indicating whether test passed or not.
1297
1297
  */
1298
- successful: boolean;
1298
+ 'successful': boolean;
1299
1299
  /**
1300
1300
  * Field containing more details in case of a failure. Details are available to a privileged user only.
1301
1301
  */
1302
- error?: string;
1302
+ 'error'?: string;
1303
1303
  }
1304
1304
  export interface AutomationTriggerAutomationRequest {
1305
- automation: AutomationAdHocAutomation;
1305
+ 'automation': AutomationAdHocAutomation;
1306
1306
  }
1307
1307
  export interface AutomationValue {
1308
1308
  /**
1309
1309
  * Value of the alert threshold to compare the metric to.
1310
1310
  */
1311
- value: number;
1311
+ 'value': number;
1312
1312
  }
1313
1313
  export interface AutomationVisibleFilter {
1314
- localIdentifier?: string;
1315
- title?: string;
1314
+ 'localIdentifier'?: string;
1315
+ 'title'?: string;
1316
1316
  /**
1317
1317
  * 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.
1318
1318
  */
1319
- isAllTimeDateFilter?: boolean;
1319
+ 'isAllTimeDateFilter'?: boolean;
1320
1320
  }
1321
1321
  /**
1322
1322
  * Export request object describing the export properties and metadata for dashboard PDF exports.
@@ -1325,15 +1325,15 @@ export interface AutomationVisualExportRequest {
1325
1325
  /**
1326
1326
  * File name to be used for retrieving the pdf document.
1327
1327
  */
1328
- fileName: string;
1328
+ 'fileName': string;
1329
1329
  /**
1330
1330
  * Dashboard identifier
1331
1331
  */
1332
- dashboardId: string;
1332
+ 'dashboardId': string;
1333
1333
  /**
1334
1334
  * Metadata definition in free-form JSON format.
1335
1335
  */
1336
- metadata?: object;
1336
+ 'metadata'?: object;
1337
1337
  }
1338
1338
  /**
1339
1339
  * Webhook destination for notifications. The property url is required on create and update.
@@ -1342,62 +1342,62 @@ export interface AutomationWebhook {
1342
1342
  /**
1343
1343
  * The webhook URL.
1344
1344
  */
1345
- url?: string;
1345
+ 'url'?: string;
1346
1346
  /**
1347
1347
  * Bearer token for the webhook.
1348
1348
  */
1349
- token?: string | null;
1349
+ 'token'?: string | null;
1350
1350
  /**
1351
1351
  * Flag indicating if webhook has a token.
1352
1352
  */
1353
- hasToken?: boolean | null;
1353
+ 'hasToken'?: boolean | null;
1354
1354
  /**
1355
1355
  * Hmac secret key for the webhook signature.
1356
1356
  */
1357
- secretKey?: string | null;
1357
+ 'secretKey'?: string | null;
1358
1358
  /**
1359
1359
  * Flag indicating if webhook has a hmac secret key.
1360
1360
  */
1361
- hasSecretKey?: boolean | null;
1361
+ 'hasSecretKey'?: boolean | null;
1362
1362
  /**
1363
1363
  * The destination type.
1364
1364
  */
1365
- type: AutomationWebhookTypeEnum;
1365
+ 'type': AutomationWebhookTypeEnum;
1366
1366
  }
1367
- export type AutomationWebhookTypeEnum = "WEBHOOK";
1367
+ export type AutomationWebhookTypeEnum = 'WEBHOOK';
1368
1368
  export interface AutomationWebhookAutomationInfo {
1369
- id: string;
1370
- title?: string;
1371
- dashboardTitle?: string;
1372
- dashboardURL: string;
1373
- isCustomDashboardURL: boolean;
1369
+ 'id': string;
1370
+ 'title'?: string;
1371
+ 'dashboardTitle'?: string;
1372
+ 'dashboardURL': string;
1373
+ 'isCustomDashboardURL': boolean;
1374
1374
  }
1375
1375
  export interface AutomationWebhookMessage {
1376
- timestamp: string;
1377
- data: AutomationWebhookMessageData;
1378
- type: AutomationWebhookMessageTypeEnum;
1376
+ 'timestamp': string;
1377
+ 'data': AutomationWebhookMessageData;
1378
+ 'type': AutomationWebhookMessageTypeEnum;
1379
1379
  }
1380
- export type AutomationWebhookMessageTypeEnum = "automation-task.completed" | "automation-task.limit-exceeded";
1380
+ export type AutomationWebhookMessageTypeEnum = 'automation-task.completed' | 'automation-task.limit-exceeded';
1381
1381
  export interface AutomationWebhookMessageData {
1382
- automation: AutomationWebhookAutomationInfo;
1383
- recipients?: Array<AutomationWebhookRecipient>;
1384
- details?: {
1382
+ 'automation': AutomationWebhookAutomationInfo;
1383
+ 'recipients'?: Array<AutomationWebhookRecipient>;
1384
+ 'details'?: {
1385
1385
  [key: string]: string;
1386
1386
  };
1387
- remainingActionCount?: number;
1388
- tabularExports?: Array<AutomationExportResult>;
1389
- visualExports?: Array<AutomationExportResult>;
1390
- imageExports?: Array<AutomationExportResult>;
1391
- rawExports?: Array<AutomationExportResult>;
1392
- slidesExports?: Array<AutomationExportResult>;
1393
- dashboardTabularExports?: Array<AutomationExportResult>;
1394
- alert?: AutomationAlertDescription;
1395
- filters?: Array<AutomationNotificationFilter>;
1396
- notificationSource?: string;
1387
+ 'remainingActionCount'?: number;
1388
+ 'tabularExports'?: Array<AutomationExportResult>;
1389
+ 'visualExports'?: Array<AutomationExportResult>;
1390
+ 'imageExports'?: Array<AutomationExportResult>;
1391
+ 'rawExports'?: Array<AutomationExportResult>;
1392
+ 'slidesExports'?: Array<AutomationExportResult>;
1393
+ 'dashboardTabularExports'?: Array<AutomationExportResult>;
1394
+ 'alert'?: AutomationAlertDescription;
1395
+ 'filters'?: Array<AutomationNotificationFilter>;
1396
+ 'notificationSource'?: string;
1397
1397
  }
1398
1398
  export interface AutomationWebhookRecipient {
1399
- id: string;
1400
- email: string;
1399
+ 'id': string;
1400
+ 'email': string;
1401
1401
  }
1402
1402
  /**
1403
1403
  * Get latest in-platform notifications for the current user.
@@ -1411,7 +1411,7 @@ export interface AutomationWebhookRecipient {
1411
1411
  * @param {Configuration} [configuration] Optional configuration.
1412
1412
  * @throws {RequiredError}
1413
1413
  */
1414
- export declare function ActionsAutomationAxiosParamCreator_GetNotifications(workspaceId?: string, isRead?: boolean, page?: string, size?: string, metaInclude?: Array<"total" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1414
+ export declare function ActionsAutomationAxiosParamCreator_GetNotifications(workspaceId?: string, isRead?: boolean, page?: string, size?: string, metaInclude?: Array<'total' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1415
1415
  /**
1416
1416
  * Mark in-platform notification by its ID as read.
1417
1417
  * @summary Mark notification as read.
@@ -1651,7 +1651,7 @@ export interface ActionsAutomationGetNotificationsRequest {
1651
1651
  * @type {Array<'total' | 'ALL'>}
1652
1652
  * @memberof ActionsAutomationGetNotifications
1653
1653
  */
1654
- readonly metaInclude?: Array<"total" | "ALL">;
1654
+ readonly metaInclude?: Array<'total' | 'ALL'>;
1655
1655
  }
1656
1656
  /**
1657
1657
  * Request parameters for markAsReadNotification operation in ActionsAutomation.
@@ -1963,7 +1963,7 @@ export declare class AutomationsAutomation extends BaseAPI implements Automation
1963
1963
  * @param {Configuration} [configuration] Optional configuration.
1964
1964
  * @throws {RequiredError}
1965
1965
  */
1966
- export declare function NotificationChannelsAutomationAxiosParamCreator_GetNotifications(workspaceId?: string, isRead?: boolean, page?: string, size?: string, metaInclude?: Array<"total" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1966
+ export declare function NotificationChannelsAutomationAxiosParamCreator_GetNotifications(workspaceId?: string, isRead?: boolean, page?: string, size?: string, metaInclude?: Array<'total' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1967
1967
  /**
1968
1968
  * Mark in-platform notification by its ID as read.
1969
1969
  * @summary Mark notification as read.
@@ -2143,7 +2143,7 @@ export interface NotificationChannelsAutomationGetNotificationsRequest {
2143
2143
  * @type {Array<'total' | 'ALL'>}
2144
2144
  * @memberof NotificationChannelsAutomationGetNotifications
2145
2145
  */
2146
- readonly metaInclude?: Array<"total" | "ALL">;
2146
+ readonly metaInclude?: Array<'total' | 'ALL'>;
2147
2147
  }
2148
2148
  /**
2149
2149
  * Request parameters for markAsReadNotification operation in NotificationChannelsAutomation.