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