@gooddata/api-client-tiger 10.16.0-alpha.2 → 10.16.0-alpha.21
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 +2108 -1304
- package/esm/automation.d.ts +8 -0
- package/esm/automation.d.ts.map +1 -0
- package/esm/automation.js +6 -0
- package/esm/automation.js.map +1 -0
- package/esm/client.d.ts +4 -2
- package/esm/client.d.ts.map +1 -1
- package/esm/client.js +4 -1
- package/esm/client.js.map +1 -1
- package/esm/generated/afm-rest-api/api.d.ts +24 -7
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +9 -5
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +15 -7
- package/esm/generated/automation-json-api/api.d.ts +1030 -0
- package/esm/generated/automation-json-api/api.d.ts.map +1 -0
- package/esm/generated/automation-json-api/api.js +544 -0
- package/esm/generated/automation-json-api/api.js.map +1 -0
- package/esm/generated/automation-json-api/base.d.ts +56 -0
- package/esm/generated/automation-json-api/base.d.ts.map +1 -0
- package/esm/generated/automation-json-api/base.js +48 -0
- package/esm/generated/automation-json-api/base.js.map +1 -0
- package/esm/generated/automation-json-api/common.d.ts +66 -0
- package/esm/generated/automation-json-api/common.d.ts.map +1 -0
- package/esm/generated/automation-json-api/common.js +123 -0
- package/esm/generated/automation-json-api/common.js.map +1 -0
- package/esm/generated/automation-json-api/configuration.d.ts +84 -0
- package/esm/generated/automation-json-api/configuration.d.ts.map +1 -0
- package/esm/generated/automation-json-api/configuration.js +76 -0
- package/esm/generated/automation-json-api/configuration.js.map +1 -0
- package/esm/generated/automation-json-api/index.d.ts +14 -0
- package/esm/generated/automation-json-api/index.d.ts.map +1 -0
- package/esm/generated/automation-json-api/index.js +17 -0
- package/esm/generated/automation-json-api/index.js.map +1 -0
- package/esm/generated/automation-json-api/openapi-spec.json +646 -0
- package/esm/generated/metadata-json-api/api.d.ts +1296 -1258
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +31 -35
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +7560 -7524
- package/esm/generated/scan-json-api/api.d.ts +24 -1
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.js +0 -1
- package/esm/generated/scan-json-api/api.js.map +1 -1
- package/esm/generated/scan-json-api/openapi-spec.json +16 -1
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js.map +1 -1
- package/package.json +4 -3
|
@@ -0,0 +1,1030 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenAPI definition
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { Configuration } from "./configuration.js";
|
|
13
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from "axios";
|
|
14
|
+
import { RequestArgs, BaseAPI } from './base.js';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
* @interface AlertDescription
|
|
19
|
+
*/
|
|
20
|
+
export interface AlertDescription {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {string}
|
|
24
|
+
* @memberof AlertDescription
|
|
25
|
+
*/
|
|
26
|
+
metric: string;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {string}
|
|
30
|
+
* @memberof AlertDescription
|
|
31
|
+
*/
|
|
32
|
+
condition: string;
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @type {Array<AlertEvaluationRow>}
|
|
36
|
+
* @memberof AlertDescription
|
|
37
|
+
*/
|
|
38
|
+
currentValues?: Array<AlertEvaluationRow>;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @type {string}
|
|
42
|
+
* @memberof AlertDescription
|
|
43
|
+
*/
|
|
44
|
+
attribute?: string;
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @type {number}
|
|
48
|
+
* @memberof AlertDescription
|
|
49
|
+
*/
|
|
50
|
+
totalValueCount?: number;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @type {number}
|
|
54
|
+
* @memberof AlertDescription
|
|
55
|
+
*/
|
|
56
|
+
triggeredCount?: number;
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* @type {number}
|
|
60
|
+
* @memberof AlertDescription
|
|
61
|
+
*/
|
|
62
|
+
threshold?: number;
|
|
63
|
+
/**
|
|
64
|
+
*
|
|
65
|
+
* @type {string}
|
|
66
|
+
* @memberof AlertDescription
|
|
67
|
+
*/
|
|
68
|
+
formattedThreshold?: string;
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @type {number}
|
|
72
|
+
* @memberof AlertDescription
|
|
73
|
+
*/
|
|
74
|
+
lowerThreshold?: number;
|
|
75
|
+
/**
|
|
76
|
+
*
|
|
77
|
+
* @type {number}
|
|
78
|
+
* @memberof AlertDescription
|
|
79
|
+
*/
|
|
80
|
+
upperThreshold?: number;
|
|
81
|
+
/**
|
|
82
|
+
*
|
|
83
|
+
* @type {string}
|
|
84
|
+
* @memberof AlertDescription
|
|
85
|
+
*/
|
|
86
|
+
status?: AlertDescriptionStatusEnum;
|
|
87
|
+
/**
|
|
88
|
+
*
|
|
89
|
+
* @type {string}
|
|
90
|
+
* @memberof AlertDescription
|
|
91
|
+
*/
|
|
92
|
+
errorMessage?: string;
|
|
93
|
+
/**
|
|
94
|
+
*
|
|
95
|
+
* @type {string}
|
|
96
|
+
* @memberof AlertDescription
|
|
97
|
+
*/
|
|
98
|
+
traceId?: string;
|
|
99
|
+
}
|
|
100
|
+
export declare const AlertDescriptionStatusEnum: {
|
|
101
|
+
readonly SUCCESS: "SUCCESS";
|
|
102
|
+
readonly ERROR: "ERROR";
|
|
103
|
+
readonly INTERNAL_ERROR: "INTERNAL_ERROR";
|
|
104
|
+
readonly TIMEOUT: "TIMEOUT";
|
|
105
|
+
};
|
|
106
|
+
export type AlertDescriptionStatusEnum = typeof AlertDescriptionStatusEnum[keyof typeof AlertDescriptionStatusEnum];
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @export
|
|
110
|
+
* @interface AlertEvaluationRow
|
|
111
|
+
*/
|
|
112
|
+
export interface AlertEvaluationRow {
|
|
113
|
+
/**
|
|
114
|
+
*
|
|
115
|
+
* @type {MetricRecord}
|
|
116
|
+
* @memberof AlertEvaluationRow
|
|
117
|
+
*/
|
|
118
|
+
primaryMetric?: MetricRecord;
|
|
119
|
+
/**
|
|
120
|
+
*
|
|
121
|
+
* @type {MetricRecord}
|
|
122
|
+
* @memberof AlertEvaluationRow
|
|
123
|
+
*/
|
|
124
|
+
secondaryMetric?: MetricRecord;
|
|
125
|
+
/**
|
|
126
|
+
*
|
|
127
|
+
* @type {MetricRecord}
|
|
128
|
+
* @memberof AlertEvaluationRow
|
|
129
|
+
*/
|
|
130
|
+
computedMetric?: MetricRecord;
|
|
131
|
+
/**
|
|
132
|
+
*
|
|
133
|
+
* @type {string}
|
|
134
|
+
* @memberof AlertEvaluationRow
|
|
135
|
+
*/
|
|
136
|
+
labelValue?: string;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
*
|
|
140
|
+
* @export
|
|
141
|
+
* @interface AutomationNotification
|
|
142
|
+
*/
|
|
143
|
+
export interface AutomationNotification extends NotificationContent {
|
|
144
|
+
/**
|
|
145
|
+
*
|
|
146
|
+
* @type {WebhookMessage}
|
|
147
|
+
* @memberof AutomationNotification
|
|
148
|
+
*/
|
|
149
|
+
content: WebhookMessage;
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
*
|
|
153
|
+
* @export
|
|
154
|
+
* @interface AutomationNotificationAllOf
|
|
155
|
+
*/
|
|
156
|
+
export interface AutomationNotificationAllOf {
|
|
157
|
+
/**
|
|
158
|
+
*
|
|
159
|
+
* @type {WebhookMessage}
|
|
160
|
+
* @memberof AutomationNotificationAllOf
|
|
161
|
+
*/
|
|
162
|
+
content?: WebhookMessage;
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* Default SMTP destination for notifications.
|
|
166
|
+
* @export
|
|
167
|
+
* @interface DefaultSmtp
|
|
168
|
+
*/
|
|
169
|
+
export interface DefaultSmtp {
|
|
170
|
+
/**
|
|
171
|
+
* E-mail address to send notifications from. Currently this does not have any effect. E-mail \'no-reply@gooddata.com\' is used instead.
|
|
172
|
+
* @type {string}
|
|
173
|
+
* @memberof DefaultSmtp
|
|
174
|
+
*/
|
|
175
|
+
fromEmail?: string;
|
|
176
|
+
/**
|
|
177
|
+
* An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name \'GoodData\' is used instead.
|
|
178
|
+
* @type {string}
|
|
179
|
+
* @memberof DefaultSmtp
|
|
180
|
+
*/
|
|
181
|
+
fromEmailName?: string;
|
|
182
|
+
/**
|
|
183
|
+
* The destination type.
|
|
184
|
+
* @type {string}
|
|
185
|
+
* @memberof DefaultSmtp
|
|
186
|
+
*/
|
|
187
|
+
type: DefaultSmtpTypeEnum;
|
|
188
|
+
}
|
|
189
|
+
export declare const DefaultSmtpTypeEnum: {
|
|
190
|
+
readonly DEFAULT_SMTP: "DEFAULT_SMTP";
|
|
191
|
+
};
|
|
192
|
+
export type DefaultSmtpTypeEnum = typeof DefaultSmtpTypeEnum[keyof typeof DefaultSmtpTypeEnum];
|
|
193
|
+
/**
|
|
194
|
+
*
|
|
195
|
+
* @export
|
|
196
|
+
* @interface ExportResult
|
|
197
|
+
*/
|
|
198
|
+
export interface ExportResult {
|
|
199
|
+
/**
|
|
200
|
+
*
|
|
201
|
+
* @type {string}
|
|
202
|
+
* @memberof ExportResult
|
|
203
|
+
*/
|
|
204
|
+
fileName: string;
|
|
205
|
+
/**
|
|
206
|
+
*
|
|
207
|
+
* @type {string}
|
|
208
|
+
* @memberof ExportResult
|
|
209
|
+
*/
|
|
210
|
+
exportId: string;
|
|
211
|
+
/**
|
|
212
|
+
*
|
|
213
|
+
* @type {string}
|
|
214
|
+
* @memberof ExportResult
|
|
215
|
+
*/
|
|
216
|
+
status: ExportResultStatusEnum;
|
|
217
|
+
/**
|
|
218
|
+
*
|
|
219
|
+
* @type {string}
|
|
220
|
+
* @memberof ExportResult
|
|
221
|
+
*/
|
|
222
|
+
fileUri?: string;
|
|
223
|
+
/**
|
|
224
|
+
*
|
|
225
|
+
* @type {string}
|
|
226
|
+
* @memberof ExportResult
|
|
227
|
+
*/
|
|
228
|
+
errorMessage?: string;
|
|
229
|
+
/**
|
|
230
|
+
*
|
|
231
|
+
* @type {string}
|
|
232
|
+
* @memberof ExportResult
|
|
233
|
+
*/
|
|
234
|
+
traceId?: string;
|
|
235
|
+
}
|
|
236
|
+
export declare const ExportResultStatusEnum: {
|
|
237
|
+
readonly SUCCESS: "SUCCESS";
|
|
238
|
+
readonly ERROR: "ERROR";
|
|
239
|
+
readonly INTERNAL_ERROR: "INTERNAL_ERROR";
|
|
240
|
+
readonly TIMEOUT: "TIMEOUT";
|
|
241
|
+
};
|
|
242
|
+
export type ExportResultStatusEnum = typeof ExportResultStatusEnum[keyof typeof ExportResultStatusEnum];
|
|
243
|
+
/**
|
|
244
|
+
* In-platform destination for notifications.
|
|
245
|
+
* @export
|
|
246
|
+
* @interface InPlatform
|
|
247
|
+
*/
|
|
248
|
+
export interface InPlatform {
|
|
249
|
+
/**
|
|
250
|
+
* The destination type.
|
|
251
|
+
* @type {string}
|
|
252
|
+
* @memberof InPlatform
|
|
253
|
+
*/
|
|
254
|
+
type: InPlatformTypeEnum;
|
|
255
|
+
}
|
|
256
|
+
export declare const InPlatformTypeEnum: {
|
|
257
|
+
readonly IN_PLATFORM: "IN_PLATFORM";
|
|
258
|
+
};
|
|
259
|
+
export type InPlatformTypeEnum = typeof InPlatformTypeEnum[keyof typeof InPlatformTypeEnum];
|
|
260
|
+
/**
|
|
261
|
+
*
|
|
262
|
+
* @export
|
|
263
|
+
* @interface MetricRecord
|
|
264
|
+
*/
|
|
265
|
+
export interface MetricRecord {
|
|
266
|
+
/**
|
|
267
|
+
*
|
|
268
|
+
* @type {number}
|
|
269
|
+
* @memberof MetricRecord
|
|
270
|
+
*/
|
|
271
|
+
value: number;
|
|
272
|
+
/**
|
|
273
|
+
*
|
|
274
|
+
* @type {string}
|
|
275
|
+
* @memberof MetricRecord
|
|
276
|
+
*/
|
|
277
|
+
formattedValue?: string;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
*
|
|
281
|
+
* @export
|
|
282
|
+
* @interface Notification
|
|
283
|
+
*/
|
|
284
|
+
export interface Notification {
|
|
285
|
+
/**
|
|
286
|
+
*
|
|
287
|
+
* @type {string}
|
|
288
|
+
* @memberof Notification
|
|
289
|
+
*/
|
|
290
|
+
id: string;
|
|
291
|
+
/**
|
|
292
|
+
*
|
|
293
|
+
* @type {string}
|
|
294
|
+
* @memberof Notification
|
|
295
|
+
*/
|
|
296
|
+
workspaceId?: string;
|
|
297
|
+
/**
|
|
298
|
+
*
|
|
299
|
+
* @type {string}
|
|
300
|
+
* @memberof Notification
|
|
301
|
+
*/
|
|
302
|
+
automationId?: string;
|
|
303
|
+
/**
|
|
304
|
+
*
|
|
305
|
+
* @type {AutomationNotification | TestNotification}
|
|
306
|
+
* @memberof Notification
|
|
307
|
+
*/
|
|
308
|
+
data: AutomationNotification | TestNotification;
|
|
309
|
+
/**
|
|
310
|
+
*
|
|
311
|
+
* @type {boolean}
|
|
312
|
+
* @memberof Notification
|
|
313
|
+
*/
|
|
314
|
+
isRead: boolean;
|
|
315
|
+
/**
|
|
316
|
+
*
|
|
317
|
+
* @type {string}
|
|
318
|
+
* @memberof Notification
|
|
319
|
+
*/
|
|
320
|
+
createdAt: string;
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* @type NotificationChannelDestination
|
|
324
|
+
* @export
|
|
325
|
+
*/
|
|
326
|
+
export type NotificationChannelDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
327
|
+
/**
|
|
328
|
+
*
|
|
329
|
+
* @export
|
|
330
|
+
* @interface NotificationContent
|
|
331
|
+
*/
|
|
332
|
+
export interface NotificationContent {
|
|
333
|
+
/**
|
|
334
|
+
*
|
|
335
|
+
* @type {string}
|
|
336
|
+
* @memberof NotificationContent
|
|
337
|
+
*/
|
|
338
|
+
type: string;
|
|
339
|
+
}
|
|
340
|
+
/**
|
|
341
|
+
* Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update
|
|
342
|
+
* @export
|
|
343
|
+
* @interface Smtp
|
|
344
|
+
*/
|
|
345
|
+
export interface Smtp {
|
|
346
|
+
/**
|
|
347
|
+
* E-mail address to send notifications from.
|
|
348
|
+
* @type {string}
|
|
349
|
+
* @memberof Smtp
|
|
350
|
+
*/
|
|
351
|
+
fromEmail?: string;
|
|
352
|
+
/**
|
|
353
|
+
* An optional e-mail name to send notifications from.
|
|
354
|
+
* @type {string}
|
|
355
|
+
* @memberof Smtp
|
|
356
|
+
*/
|
|
357
|
+
fromEmailName?: string;
|
|
358
|
+
/**
|
|
359
|
+
* The SMTP server address.
|
|
360
|
+
* @type {string}
|
|
361
|
+
* @memberof Smtp
|
|
362
|
+
*/
|
|
363
|
+
host?: string;
|
|
364
|
+
/**
|
|
365
|
+
* The SMTP server port.
|
|
366
|
+
* @type {number}
|
|
367
|
+
* @memberof Smtp
|
|
368
|
+
*/
|
|
369
|
+
port?: SmtpPortEnum;
|
|
370
|
+
/**
|
|
371
|
+
* The SMTP server username.
|
|
372
|
+
* @type {string}
|
|
373
|
+
* @memberof Smtp
|
|
374
|
+
*/
|
|
375
|
+
username?: string;
|
|
376
|
+
/**
|
|
377
|
+
* The SMTP server password.
|
|
378
|
+
* @type {string}
|
|
379
|
+
* @memberof Smtp
|
|
380
|
+
*/
|
|
381
|
+
password?: string;
|
|
382
|
+
/**
|
|
383
|
+
* The destination type.
|
|
384
|
+
* @type {string}
|
|
385
|
+
* @memberof Smtp
|
|
386
|
+
*/
|
|
387
|
+
type: SmtpTypeEnum;
|
|
388
|
+
}
|
|
389
|
+
export declare const SmtpPortEnum: {
|
|
390
|
+
readonly NUMBER_25: 25;
|
|
391
|
+
readonly NUMBER_465: 465;
|
|
392
|
+
readonly NUMBER_587: 587;
|
|
393
|
+
readonly NUMBER_2525: 2525;
|
|
394
|
+
};
|
|
395
|
+
export type SmtpPortEnum = typeof SmtpPortEnum[keyof typeof SmtpPortEnum];
|
|
396
|
+
export declare const SmtpTypeEnum: {
|
|
397
|
+
readonly SMTP: "SMTP";
|
|
398
|
+
};
|
|
399
|
+
export type SmtpTypeEnum = typeof SmtpTypeEnum[keyof typeof SmtpTypeEnum];
|
|
400
|
+
/**
|
|
401
|
+
* Request body with notification channel destination to test.
|
|
402
|
+
* @export
|
|
403
|
+
* @interface TestDestinationRequest
|
|
404
|
+
*/
|
|
405
|
+
export interface TestDestinationRequest {
|
|
406
|
+
/**
|
|
407
|
+
*
|
|
408
|
+
* @type {DefaultSmtp | InPlatform | Smtp | Webhook}
|
|
409
|
+
* @memberof TestDestinationRequest
|
|
410
|
+
*/
|
|
411
|
+
destination: DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
412
|
+
}
|
|
413
|
+
/**
|
|
414
|
+
*
|
|
415
|
+
* @export
|
|
416
|
+
* @interface TestNotification
|
|
417
|
+
*/
|
|
418
|
+
export interface TestNotification extends NotificationContent {
|
|
419
|
+
/**
|
|
420
|
+
*
|
|
421
|
+
* @type {string}
|
|
422
|
+
* @memberof TestNotification
|
|
423
|
+
*/
|
|
424
|
+
message: string;
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
*
|
|
428
|
+
* @export
|
|
429
|
+
* @interface TestNotificationAllOf
|
|
430
|
+
*/
|
|
431
|
+
export interface TestNotificationAllOf {
|
|
432
|
+
/**
|
|
433
|
+
*
|
|
434
|
+
* @type {string}
|
|
435
|
+
* @memberof TestNotificationAllOf
|
|
436
|
+
*/
|
|
437
|
+
message?: string;
|
|
438
|
+
}
|
|
439
|
+
/**
|
|
440
|
+
* Response from notification channel testing.
|
|
441
|
+
* @export
|
|
442
|
+
* @interface TestResponse
|
|
443
|
+
*/
|
|
444
|
+
export interface TestResponse {
|
|
445
|
+
/**
|
|
446
|
+
* A flag indicating whether test passed or not.
|
|
447
|
+
* @type {boolean}
|
|
448
|
+
* @memberof TestResponse
|
|
449
|
+
*/
|
|
450
|
+
successful: boolean;
|
|
451
|
+
/**
|
|
452
|
+
* Field containing more details in case of a failure. Details are available to a privileged user only.
|
|
453
|
+
* @type {string}
|
|
454
|
+
* @memberof TestResponse
|
|
455
|
+
*/
|
|
456
|
+
error?: string;
|
|
457
|
+
}
|
|
458
|
+
/**
|
|
459
|
+
* Webhook destination for notifications. The property url is required on create and update.
|
|
460
|
+
* @export
|
|
461
|
+
* @interface Webhook
|
|
462
|
+
*/
|
|
463
|
+
export interface Webhook {
|
|
464
|
+
/**
|
|
465
|
+
* The webhook URL.
|
|
466
|
+
* @type {string}
|
|
467
|
+
* @memberof Webhook
|
|
468
|
+
*/
|
|
469
|
+
url?: string;
|
|
470
|
+
/**
|
|
471
|
+
* Bearer token for the webhook.
|
|
472
|
+
* @type {string}
|
|
473
|
+
* @memberof Webhook
|
|
474
|
+
*/
|
|
475
|
+
token?: string | null;
|
|
476
|
+
/**
|
|
477
|
+
* Flag indicating if webhook has a token.
|
|
478
|
+
* @type {boolean}
|
|
479
|
+
* @memberof Webhook
|
|
480
|
+
*/
|
|
481
|
+
hasToken?: boolean | null;
|
|
482
|
+
/**
|
|
483
|
+
* The destination type.
|
|
484
|
+
* @type {string}
|
|
485
|
+
* @memberof Webhook
|
|
486
|
+
*/
|
|
487
|
+
type: WebhookTypeEnum;
|
|
488
|
+
}
|
|
489
|
+
export declare const WebhookTypeEnum: {
|
|
490
|
+
readonly WEBHOOK: "WEBHOOK";
|
|
491
|
+
};
|
|
492
|
+
export type WebhookTypeEnum = typeof WebhookTypeEnum[keyof typeof WebhookTypeEnum];
|
|
493
|
+
/**
|
|
494
|
+
*
|
|
495
|
+
* @export
|
|
496
|
+
* @interface WebhookAutomationInfo
|
|
497
|
+
*/
|
|
498
|
+
export interface WebhookAutomationInfo {
|
|
499
|
+
/**
|
|
500
|
+
*
|
|
501
|
+
* @type {string}
|
|
502
|
+
* @memberof WebhookAutomationInfo
|
|
503
|
+
*/
|
|
504
|
+
id: string;
|
|
505
|
+
/**
|
|
506
|
+
*
|
|
507
|
+
* @type {string}
|
|
508
|
+
* @memberof WebhookAutomationInfo
|
|
509
|
+
*/
|
|
510
|
+
title?: string;
|
|
511
|
+
/**
|
|
512
|
+
*
|
|
513
|
+
* @type {string}
|
|
514
|
+
* @memberof WebhookAutomationInfo
|
|
515
|
+
*/
|
|
516
|
+
dashboardURL: string;
|
|
517
|
+
}
|
|
518
|
+
/**
|
|
519
|
+
*
|
|
520
|
+
* @export
|
|
521
|
+
* @interface WebhookMessage
|
|
522
|
+
*/
|
|
523
|
+
export interface WebhookMessage {
|
|
524
|
+
/**
|
|
525
|
+
*
|
|
526
|
+
* @type {string}
|
|
527
|
+
* @memberof WebhookMessage
|
|
528
|
+
*/
|
|
529
|
+
timestamp: string;
|
|
530
|
+
/**
|
|
531
|
+
*
|
|
532
|
+
* @type {WebhookMessageData}
|
|
533
|
+
* @memberof WebhookMessage
|
|
534
|
+
*/
|
|
535
|
+
data: WebhookMessageData;
|
|
536
|
+
/**
|
|
537
|
+
*
|
|
538
|
+
* @type {string}
|
|
539
|
+
* @memberof WebhookMessage
|
|
540
|
+
*/
|
|
541
|
+
type: WebhookMessageTypeEnum;
|
|
542
|
+
}
|
|
543
|
+
export declare const WebhookMessageTypeEnum: {
|
|
544
|
+
readonly COMPLETED: "automation-task.completed";
|
|
545
|
+
readonly LIMIT_EXCEEDED: "automation-task.limit-exceeded";
|
|
546
|
+
};
|
|
547
|
+
export type WebhookMessageTypeEnum = typeof WebhookMessageTypeEnum[keyof typeof WebhookMessageTypeEnum];
|
|
548
|
+
/**
|
|
549
|
+
*
|
|
550
|
+
* @export
|
|
551
|
+
* @interface WebhookMessageData
|
|
552
|
+
*/
|
|
553
|
+
export interface WebhookMessageData {
|
|
554
|
+
/**
|
|
555
|
+
*
|
|
556
|
+
* @type {WebhookAutomationInfo}
|
|
557
|
+
* @memberof WebhookMessageData
|
|
558
|
+
*/
|
|
559
|
+
automation: WebhookAutomationInfo;
|
|
560
|
+
/**
|
|
561
|
+
*
|
|
562
|
+
* @type {Array<WebhookRecipient>}
|
|
563
|
+
* @memberof WebhookMessageData
|
|
564
|
+
*/
|
|
565
|
+
recipients?: Array<WebhookRecipient>;
|
|
566
|
+
/**
|
|
567
|
+
*
|
|
568
|
+
* @type {{ [key: string]: string; }}
|
|
569
|
+
* @memberof WebhookMessageData
|
|
570
|
+
*/
|
|
571
|
+
details?: {
|
|
572
|
+
[key: string]: string;
|
|
573
|
+
};
|
|
574
|
+
/**
|
|
575
|
+
*
|
|
576
|
+
* @type {number}
|
|
577
|
+
* @memberof WebhookMessageData
|
|
578
|
+
*/
|
|
579
|
+
remainingActionCount?: number;
|
|
580
|
+
/**
|
|
581
|
+
*
|
|
582
|
+
* @type {Array<ExportResult>}
|
|
583
|
+
* @memberof WebhookMessageData
|
|
584
|
+
*/
|
|
585
|
+
tabularExports?: Array<ExportResult>;
|
|
586
|
+
/**
|
|
587
|
+
*
|
|
588
|
+
* @type {Array<ExportResult>}
|
|
589
|
+
* @memberof WebhookMessageData
|
|
590
|
+
*/
|
|
591
|
+
visualExports?: Array<ExportResult>;
|
|
592
|
+
/**
|
|
593
|
+
*
|
|
594
|
+
* @type {AlertDescription}
|
|
595
|
+
* @memberof WebhookMessageData
|
|
596
|
+
*/
|
|
597
|
+
alert?: AlertDescription;
|
|
598
|
+
}
|
|
599
|
+
/**
|
|
600
|
+
*
|
|
601
|
+
* @export
|
|
602
|
+
* @interface WebhookRecipient
|
|
603
|
+
*/
|
|
604
|
+
export interface WebhookRecipient {
|
|
605
|
+
/**
|
|
606
|
+
*
|
|
607
|
+
* @type {string}
|
|
608
|
+
* @memberof WebhookRecipient
|
|
609
|
+
*/
|
|
610
|
+
id: string;
|
|
611
|
+
/**
|
|
612
|
+
*
|
|
613
|
+
* @type {string}
|
|
614
|
+
* @memberof WebhookRecipient
|
|
615
|
+
*/
|
|
616
|
+
email: string;
|
|
617
|
+
}
|
|
618
|
+
/**
|
|
619
|
+
* ActionsApi - axios parameter creator
|
|
620
|
+
* @export
|
|
621
|
+
*/
|
|
622
|
+
export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
623
|
+
/**
|
|
624
|
+
* Get latest in-platform notifications for the current user.
|
|
625
|
+
* @summary Get latest notifications.
|
|
626
|
+
* @param {string} [workspaceId] Workspace ID to filter notifications by.
|
|
627
|
+
* @param {string} [page] Zero-based page index (0..N)
|
|
628
|
+
* @param {string} [size] The size of the page to be returned.
|
|
629
|
+
* @param {*} [options] Override http request option.
|
|
630
|
+
* @throws {RequiredError}
|
|
631
|
+
*/
|
|
632
|
+
getNotifications: (workspaceId?: string, page?: string, size?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
633
|
+
/**
|
|
634
|
+
* Mark in-platform notification by its ID as read.
|
|
635
|
+
* @summary Mark notification as read.
|
|
636
|
+
* @param {string} notificationId Notification ID to mark as read.
|
|
637
|
+
* @param {*} [options] Override http request option.
|
|
638
|
+
* @throws {RequiredError}
|
|
639
|
+
*/
|
|
640
|
+
markAsReadNotification: (notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
641
|
+
/**
|
|
642
|
+
* Tests the existing notification channel by sending a test notification.
|
|
643
|
+
* @summary Test existing notification channel.
|
|
644
|
+
* @param {string} notificationChannelId
|
|
645
|
+
* @param {*} [options] Override http request option.
|
|
646
|
+
* @throws {RequiredError}
|
|
647
|
+
*/
|
|
648
|
+
testExistingNotificationChannel: (notificationChannelId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
649
|
+
/**
|
|
650
|
+
* Tests the notification channel by sending a test notification.
|
|
651
|
+
* @summary Test notification channel.
|
|
652
|
+
* @param {TestDestinationRequest} testDestinationRequest
|
|
653
|
+
* @param {*} [options] Override http request option.
|
|
654
|
+
* @throws {RequiredError}
|
|
655
|
+
*/
|
|
656
|
+
testNotificationChannel: (testDestinationRequest: TestDestinationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
657
|
+
};
|
|
658
|
+
/**
|
|
659
|
+
* ActionsApi - functional programming interface
|
|
660
|
+
* @export
|
|
661
|
+
*/
|
|
662
|
+
export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
663
|
+
/**
|
|
664
|
+
* Get latest in-platform notifications for the current user.
|
|
665
|
+
* @summary Get latest notifications.
|
|
666
|
+
* @param {string} [workspaceId] Workspace ID to filter notifications by.
|
|
667
|
+
* @param {string} [page] Zero-based page index (0..N)
|
|
668
|
+
* @param {string} [size] The size of the page to be returned.
|
|
669
|
+
* @param {*} [options] Override http request option.
|
|
670
|
+
* @throws {RequiredError}
|
|
671
|
+
*/
|
|
672
|
+
getNotifications(workspaceId?: string, page?: string, size?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Notification>>>;
|
|
673
|
+
/**
|
|
674
|
+
* Mark in-platform notification by its ID as read.
|
|
675
|
+
* @summary Mark notification as read.
|
|
676
|
+
* @param {string} notificationId Notification ID to mark as read.
|
|
677
|
+
* @param {*} [options] Override http request option.
|
|
678
|
+
* @throws {RequiredError}
|
|
679
|
+
*/
|
|
680
|
+
markAsReadNotification(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
681
|
+
/**
|
|
682
|
+
* Tests the existing notification channel by sending a test notification.
|
|
683
|
+
* @summary Test existing notification channel.
|
|
684
|
+
* @param {string} notificationChannelId
|
|
685
|
+
* @param {*} [options] Override http request option.
|
|
686
|
+
* @throws {RequiredError}
|
|
687
|
+
*/
|
|
688
|
+
testExistingNotificationChannel(notificationChannelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestResponse>>;
|
|
689
|
+
/**
|
|
690
|
+
* Tests the notification channel by sending a test notification.
|
|
691
|
+
* @summary Test notification channel.
|
|
692
|
+
* @param {TestDestinationRequest} testDestinationRequest
|
|
693
|
+
* @param {*} [options] Override http request option.
|
|
694
|
+
* @throws {RequiredError}
|
|
695
|
+
*/
|
|
696
|
+
testNotificationChannel(testDestinationRequest: TestDestinationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestResponse>>;
|
|
697
|
+
};
|
|
698
|
+
/**
|
|
699
|
+
* ActionsApi - factory interface
|
|
700
|
+
* @export
|
|
701
|
+
*/
|
|
702
|
+
export declare const ActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
703
|
+
/**
|
|
704
|
+
* Get latest in-platform notifications for the current user.
|
|
705
|
+
* @summary Get latest notifications.
|
|
706
|
+
* @param {ActionsApiGetNotificationsRequest} requestParameters Request parameters.
|
|
707
|
+
* @param {*} [options] Override http request option.
|
|
708
|
+
* @throws {RequiredError}
|
|
709
|
+
*/
|
|
710
|
+
getNotifications(requestParameters: ActionsApiGetNotificationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Notification>>;
|
|
711
|
+
/**
|
|
712
|
+
* Mark in-platform notification by its ID as read.
|
|
713
|
+
* @summary Mark notification as read.
|
|
714
|
+
* @param {ActionsApiMarkAsReadNotificationRequest} requestParameters Request parameters.
|
|
715
|
+
* @param {*} [options] Override http request option.
|
|
716
|
+
* @throws {RequiredError}
|
|
717
|
+
*/
|
|
718
|
+
markAsReadNotification(requestParameters: ActionsApiMarkAsReadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
719
|
+
/**
|
|
720
|
+
* Tests the existing notification channel by sending a test notification.
|
|
721
|
+
* @summary Test existing notification channel.
|
|
722
|
+
* @param {ActionsApiTestExistingNotificationChannelRequest} requestParameters Request parameters.
|
|
723
|
+
* @param {*} [options] Override http request option.
|
|
724
|
+
* @throws {RequiredError}
|
|
725
|
+
*/
|
|
726
|
+
testExistingNotificationChannel(requestParameters: ActionsApiTestExistingNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<TestResponse>;
|
|
727
|
+
/**
|
|
728
|
+
* Tests the notification channel by sending a test notification.
|
|
729
|
+
* @summary Test notification channel.
|
|
730
|
+
* @param {ActionsApiTestNotificationChannelRequest} requestParameters Request parameters.
|
|
731
|
+
* @param {*} [options] Override http request option.
|
|
732
|
+
* @throws {RequiredError}
|
|
733
|
+
*/
|
|
734
|
+
testNotificationChannel(requestParameters: ActionsApiTestNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<TestResponse>;
|
|
735
|
+
};
|
|
736
|
+
/**
|
|
737
|
+
* ActionsApi - interface
|
|
738
|
+
* @export
|
|
739
|
+
* @interface ActionsApi
|
|
740
|
+
*/
|
|
741
|
+
export interface ActionsApiInterface {
|
|
742
|
+
/**
|
|
743
|
+
* Get latest in-platform notifications for the current user.
|
|
744
|
+
* @summary Get latest notifications.
|
|
745
|
+
* @param {ActionsApiGetNotificationsRequest} requestParameters Request parameters.
|
|
746
|
+
* @param {*} [options] Override http request option.
|
|
747
|
+
* @throws {RequiredError}
|
|
748
|
+
* @memberof ActionsApiInterface
|
|
749
|
+
*/
|
|
750
|
+
getNotifications(requestParameters: ActionsApiGetNotificationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Notification>>;
|
|
751
|
+
/**
|
|
752
|
+
* Mark in-platform notification by its ID as read.
|
|
753
|
+
* @summary Mark notification as read.
|
|
754
|
+
* @param {ActionsApiMarkAsReadNotificationRequest} requestParameters Request parameters.
|
|
755
|
+
* @param {*} [options] Override http request option.
|
|
756
|
+
* @throws {RequiredError}
|
|
757
|
+
* @memberof ActionsApiInterface
|
|
758
|
+
*/
|
|
759
|
+
markAsReadNotification(requestParameters: ActionsApiMarkAsReadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
760
|
+
/**
|
|
761
|
+
* Tests the existing notification channel by sending a test notification.
|
|
762
|
+
* @summary Test existing notification channel.
|
|
763
|
+
* @param {ActionsApiTestExistingNotificationChannelRequest} requestParameters Request parameters.
|
|
764
|
+
* @param {*} [options] Override http request option.
|
|
765
|
+
* @throws {RequiredError}
|
|
766
|
+
* @memberof ActionsApiInterface
|
|
767
|
+
*/
|
|
768
|
+
testExistingNotificationChannel(requestParameters: ActionsApiTestExistingNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<TestResponse>;
|
|
769
|
+
/**
|
|
770
|
+
* Tests the notification channel by sending a test notification.
|
|
771
|
+
* @summary Test notification channel.
|
|
772
|
+
* @param {ActionsApiTestNotificationChannelRequest} requestParameters Request parameters.
|
|
773
|
+
* @param {*} [options] Override http request option.
|
|
774
|
+
* @throws {RequiredError}
|
|
775
|
+
* @memberof ActionsApiInterface
|
|
776
|
+
*/
|
|
777
|
+
testNotificationChannel(requestParameters: ActionsApiTestNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<TestResponse>;
|
|
778
|
+
}
|
|
779
|
+
/**
|
|
780
|
+
* Request parameters for getNotifications operation in ActionsApi.
|
|
781
|
+
* @export
|
|
782
|
+
* @interface ActionsApiGetNotificationsRequest
|
|
783
|
+
*/
|
|
784
|
+
export interface ActionsApiGetNotificationsRequest {
|
|
785
|
+
/**
|
|
786
|
+
* Workspace ID to filter notifications by.
|
|
787
|
+
* @type {string}
|
|
788
|
+
* @memberof ActionsApiGetNotifications
|
|
789
|
+
*/
|
|
790
|
+
readonly workspaceId?: string;
|
|
791
|
+
/**
|
|
792
|
+
* Zero-based page index (0..N)
|
|
793
|
+
* @type {string}
|
|
794
|
+
* @memberof ActionsApiGetNotifications
|
|
795
|
+
*/
|
|
796
|
+
readonly page?: string;
|
|
797
|
+
/**
|
|
798
|
+
* The size of the page to be returned.
|
|
799
|
+
* @type {string}
|
|
800
|
+
* @memberof ActionsApiGetNotifications
|
|
801
|
+
*/
|
|
802
|
+
readonly size?: string;
|
|
803
|
+
}
|
|
804
|
+
/**
|
|
805
|
+
* Request parameters for markAsReadNotification operation in ActionsApi.
|
|
806
|
+
* @export
|
|
807
|
+
* @interface ActionsApiMarkAsReadNotificationRequest
|
|
808
|
+
*/
|
|
809
|
+
export interface ActionsApiMarkAsReadNotificationRequest {
|
|
810
|
+
/**
|
|
811
|
+
* Notification ID to mark as read.
|
|
812
|
+
* @type {string}
|
|
813
|
+
* @memberof ActionsApiMarkAsReadNotification
|
|
814
|
+
*/
|
|
815
|
+
readonly notificationId: string;
|
|
816
|
+
}
|
|
817
|
+
/**
|
|
818
|
+
* Request parameters for testExistingNotificationChannel operation in ActionsApi.
|
|
819
|
+
* @export
|
|
820
|
+
* @interface ActionsApiTestExistingNotificationChannelRequest
|
|
821
|
+
*/
|
|
822
|
+
export interface ActionsApiTestExistingNotificationChannelRequest {
|
|
823
|
+
/**
|
|
824
|
+
*
|
|
825
|
+
* @type {string}
|
|
826
|
+
* @memberof ActionsApiTestExistingNotificationChannel
|
|
827
|
+
*/
|
|
828
|
+
readonly notificationChannelId: string;
|
|
829
|
+
}
|
|
830
|
+
/**
|
|
831
|
+
* Request parameters for testNotificationChannel operation in ActionsApi.
|
|
832
|
+
* @export
|
|
833
|
+
* @interface ActionsApiTestNotificationChannelRequest
|
|
834
|
+
*/
|
|
835
|
+
export interface ActionsApiTestNotificationChannelRequest {
|
|
836
|
+
/**
|
|
837
|
+
*
|
|
838
|
+
* @type {TestDestinationRequest}
|
|
839
|
+
* @memberof ActionsApiTestNotificationChannel
|
|
840
|
+
*/
|
|
841
|
+
readonly testDestinationRequest: TestDestinationRequest;
|
|
842
|
+
}
|
|
843
|
+
/**
|
|
844
|
+
* ActionsApi - object-oriented interface
|
|
845
|
+
* @export
|
|
846
|
+
* @class ActionsApi
|
|
847
|
+
* @extends {BaseAPI}
|
|
848
|
+
*/
|
|
849
|
+
export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
850
|
+
/**
|
|
851
|
+
* Get latest in-platform notifications for the current user.
|
|
852
|
+
* @summary Get latest notifications.
|
|
853
|
+
* @param {ActionsApiGetNotificationsRequest} requestParameters Request parameters.
|
|
854
|
+
* @param {*} [options] Override http request option.
|
|
855
|
+
* @throws {RequiredError}
|
|
856
|
+
* @memberof ActionsApi
|
|
857
|
+
*/
|
|
858
|
+
getNotifications(requestParameters?: ActionsApiGetNotificationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification[], any>>;
|
|
859
|
+
/**
|
|
860
|
+
* Mark in-platform notification by its ID as read.
|
|
861
|
+
* @summary Mark notification as read.
|
|
862
|
+
* @param {ActionsApiMarkAsReadNotificationRequest} requestParameters Request parameters.
|
|
863
|
+
* @param {*} [options] Override http request option.
|
|
864
|
+
* @throws {RequiredError}
|
|
865
|
+
* @memberof ActionsApi
|
|
866
|
+
*/
|
|
867
|
+
markAsReadNotification(requestParameters: ActionsApiMarkAsReadNotificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
868
|
+
/**
|
|
869
|
+
* Tests the existing notification channel by sending a test notification.
|
|
870
|
+
* @summary Test existing notification channel.
|
|
871
|
+
* @param {ActionsApiTestExistingNotificationChannelRequest} requestParameters Request parameters.
|
|
872
|
+
* @param {*} [options] Override http request option.
|
|
873
|
+
* @throws {RequiredError}
|
|
874
|
+
* @memberof ActionsApi
|
|
875
|
+
*/
|
|
876
|
+
testExistingNotificationChannel(requestParameters: ActionsApiTestExistingNotificationChannelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TestResponse, any>>;
|
|
877
|
+
/**
|
|
878
|
+
* Tests the notification channel by sending a test notification.
|
|
879
|
+
* @summary Test notification channel.
|
|
880
|
+
* @param {ActionsApiTestNotificationChannelRequest} requestParameters Request parameters.
|
|
881
|
+
* @param {*} [options] Override http request option.
|
|
882
|
+
* @throws {RequiredError}
|
|
883
|
+
* @memberof ActionsApi
|
|
884
|
+
*/
|
|
885
|
+
testNotificationChannel(requestParameters: ActionsApiTestNotificationChannelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TestResponse, any>>;
|
|
886
|
+
}
|
|
887
|
+
/**
|
|
888
|
+
* NotificationChannelsApi - axios parameter creator
|
|
889
|
+
* @export
|
|
890
|
+
*/
|
|
891
|
+
export declare const NotificationChannelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
892
|
+
/**
|
|
893
|
+
* Tests the existing notification channel by sending a test notification.
|
|
894
|
+
* @summary Test existing notification channel.
|
|
895
|
+
* @param {string} notificationChannelId
|
|
896
|
+
* @param {*} [options] Override http request option.
|
|
897
|
+
* @throws {RequiredError}
|
|
898
|
+
*/
|
|
899
|
+
testExistingNotificationChannel: (notificationChannelId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
900
|
+
/**
|
|
901
|
+
* Tests the notification channel by sending a test notification.
|
|
902
|
+
* @summary Test notification channel.
|
|
903
|
+
* @param {TestDestinationRequest} testDestinationRequest
|
|
904
|
+
* @param {*} [options] Override http request option.
|
|
905
|
+
* @throws {RequiredError}
|
|
906
|
+
*/
|
|
907
|
+
testNotificationChannel: (testDestinationRequest: TestDestinationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
908
|
+
};
|
|
909
|
+
/**
|
|
910
|
+
* NotificationChannelsApi - functional programming interface
|
|
911
|
+
* @export
|
|
912
|
+
*/
|
|
913
|
+
export declare const NotificationChannelsApiFp: (configuration?: Configuration) => {
|
|
914
|
+
/**
|
|
915
|
+
* Tests the existing notification channel by sending a test notification.
|
|
916
|
+
* @summary Test existing notification channel.
|
|
917
|
+
* @param {string} notificationChannelId
|
|
918
|
+
* @param {*} [options] Override http request option.
|
|
919
|
+
* @throws {RequiredError}
|
|
920
|
+
*/
|
|
921
|
+
testExistingNotificationChannel(notificationChannelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestResponse>>;
|
|
922
|
+
/**
|
|
923
|
+
* Tests the notification channel by sending a test notification.
|
|
924
|
+
* @summary Test notification channel.
|
|
925
|
+
* @param {TestDestinationRequest} testDestinationRequest
|
|
926
|
+
* @param {*} [options] Override http request option.
|
|
927
|
+
* @throws {RequiredError}
|
|
928
|
+
*/
|
|
929
|
+
testNotificationChannel(testDestinationRequest: TestDestinationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestResponse>>;
|
|
930
|
+
};
|
|
931
|
+
/**
|
|
932
|
+
* NotificationChannelsApi - factory interface
|
|
933
|
+
* @export
|
|
934
|
+
*/
|
|
935
|
+
export declare const NotificationChannelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
936
|
+
/**
|
|
937
|
+
* Tests the existing notification channel by sending a test notification.
|
|
938
|
+
* @summary Test existing notification channel.
|
|
939
|
+
* @param {NotificationChannelsApiTestExistingNotificationChannelRequest} requestParameters Request parameters.
|
|
940
|
+
* @param {*} [options] Override http request option.
|
|
941
|
+
* @throws {RequiredError}
|
|
942
|
+
*/
|
|
943
|
+
testExistingNotificationChannel(requestParameters: NotificationChannelsApiTestExistingNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<TestResponse>;
|
|
944
|
+
/**
|
|
945
|
+
* Tests the notification channel by sending a test notification.
|
|
946
|
+
* @summary Test notification channel.
|
|
947
|
+
* @param {NotificationChannelsApiTestNotificationChannelRequest} requestParameters Request parameters.
|
|
948
|
+
* @param {*} [options] Override http request option.
|
|
949
|
+
* @throws {RequiredError}
|
|
950
|
+
*/
|
|
951
|
+
testNotificationChannel(requestParameters: NotificationChannelsApiTestNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<TestResponse>;
|
|
952
|
+
};
|
|
953
|
+
/**
|
|
954
|
+
* NotificationChannelsApi - interface
|
|
955
|
+
* @export
|
|
956
|
+
* @interface NotificationChannelsApi
|
|
957
|
+
*/
|
|
958
|
+
export interface NotificationChannelsApiInterface {
|
|
959
|
+
/**
|
|
960
|
+
* Tests the existing notification channel by sending a test notification.
|
|
961
|
+
* @summary Test existing notification channel.
|
|
962
|
+
* @param {NotificationChannelsApiTestExistingNotificationChannelRequest} requestParameters Request parameters.
|
|
963
|
+
* @param {*} [options] Override http request option.
|
|
964
|
+
* @throws {RequiredError}
|
|
965
|
+
* @memberof NotificationChannelsApiInterface
|
|
966
|
+
*/
|
|
967
|
+
testExistingNotificationChannel(requestParameters: NotificationChannelsApiTestExistingNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<TestResponse>;
|
|
968
|
+
/**
|
|
969
|
+
* Tests the notification channel by sending a test notification.
|
|
970
|
+
* @summary Test notification channel.
|
|
971
|
+
* @param {NotificationChannelsApiTestNotificationChannelRequest} requestParameters Request parameters.
|
|
972
|
+
* @param {*} [options] Override http request option.
|
|
973
|
+
* @throws {RequiredError}
|
|
974
|
+
* @memberof NotificationChannelsApiInterface
|
|
975
|
+
*/
|
|
976
|
+
testNotificationChannel(requestParameters: NotificationChannelsApiTestNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<TestResponse>;
|
|
977
|
+
}
|
|
978
|
+
/**
|
|
979
|
+
* Request parameters for testExistingNotificationChannel operation in NotificationChannelsApi.
|
|
980
|
+
* @export
|
|
981
|
+
* @interface NotificationChannelsApiTestExistingNotificationChannelRequest
|
|
982
|
+
*/
|
|
983
|
+
export interface NotificationChannelsApiTestExistingNotificationChannelRequest {
|
|
984
|
+
/**
|
|
985
|
+
*
|
|
986
|
+
* @type {string}
|
|
987
|
+
* @memberof NotificationChannelsApiTestExistingNotificationChannel
|
|
988
|
+
*/
|
|
989
|
+
readonly notificationChannelId: string;
|
|
990
|
+
}
|
|
991
|
+
/**
|
|
992
|
+
* Request parameters for testNotificationChannel operation in NotificationChannelsApi.
|
|
993
|
+
* @export
|
|
994
|
+
* @interface NotificationChannelsApiTestNotificationChannelRequest
|
|
995
|
+
*/
|
|
996
|
+
export interface NotificationChannelsApiTestNotificationChannelRequest {
|
|
997
|
+
/**
|
|
998
|
+
*
|
|
999
|
+
* @type {TestDestinationRequest}
|
|
1000
|
+
* @memberof NotificationChannelsApiTestNotificationChannel
|
|
1001
|
+
*/
|
|
1002
|
+
readonly testDestinationRequest: TestDestinationRequest;
|
|
1003
|
+
}
|
|
1004
|
+
/**
|
|
1005
|
+
* NotificationChannelsApi - object-oriented interface
|
|
1006
|
+
* @export
|
|
1007
|
+
* @class NotificationChannelsApi
|
|
1008
|
+
* @extends {BaseAPI}
|
|
1009
|
+
*/
|
|
1010
|
+
export declare class NotificationChannelsApi extends BaseAPI implements NotificationChannelsApiInterface {
|
|
1011
|
+
/**
|
|
1012
|
+
* Tests the existing notification channel by sending a test notification.
|
|
1013
|
+
* @summary Test existing notification channel.
|
|
1014
|
+
* @param {NotificationChannelsApiTestExistingNotificationChannelRequest} requestParameters Request parameters.
|
|
1015
|
+
* @param {*} [options] Override http request option.
|
|
1016
|
+
* @throws {RequiredError}
|
|
1017
|
+
* @memberof NotificationChannelsApi
|
|
1018
|
+
*/
|
|
1019
|
+
testExistingNotificationChannel(requestParameters: NotificationChannelsApiTestExistingNotificationChannelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TestResponse, any>>;
|
|
1020
|
+
/**
|
|
1021
|
+
* Tests the notification channel by sending a test notification.
|
|
1022
|
+
* @summary Test notification channel.
|
|
1023
|
+
* @param {NotificationChannelsApiTestNotificationChannelRequest} requestParameters Request parameters.
|
|
1024
|
+
* @param {*} [options] Override http request option.
|
|
1025
|
+
* @throws {RequiredError}
|
|
1026
|
+
* @memberof NotificationChannelsApi
|
|
1027
|
+
*/
|
|
1028
|
+
testNotificationChannel(requestParameters: NotificationChannelsApiTestNotificationChannelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TestResponse, any>>;
|
|
1029
|
+
}
|
|
1030
|
+
//# sourceMappingURL=api.d.ts.map
|