@gooddata/api-client-tiger 10.24.0-alpha.5 → 10.24.0-alpha.51
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 +2578 -604
- package/esm/automation.d.ts +2 -2
- package/esm/automation.d.ts.map +1 -1
- 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.map +1 -1
- package/esm/gd-tiger-model/index.d.ts +1 -1
- package/esm/gd-tiger-model/index.d.ts.map +1 -1
- package/esm/gd-tiger-model/index.js +1 -1
- package/esm/gd-tiger-model/index.js.map +1 -1
- package/esm/gd-tiger-model/typeGuards.d.ts +13 -1
- package/esm/gd-tiger-model/typeGuards.d.ts.map +1 -1
- package/esm/gd-tiger-model/typeGuards.js +19 -1
- package/esm/gd-tiger-model/typeGuards.js.map +1 -1
- package/esm/generated/afm-rest-api/api.d.ts +15 -15
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +18 -10
- package/esm/generated/automation-json-api/api.d.ts +858 -0
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js +490 -0
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +477 -2
- package/esm/generated/export-json-api/api.d.ts +125 -52
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +23 -23
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/openapi-spec.json +95 -8
- package/esm/generated/metadata-json-api/api.d.ts +1909 -563
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +998 -17
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +6687 -5930
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +1 -1
- package/esm/index.js.map +1 -1
- package/esm/metadataUtilities.js +1 -1
- package/package.json +4 -4
|
@@ -12,6 +12,81 @@
|
|
|
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
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
* @interface AdHocAutomation
|
|
19
|
+
*/
|
|
20
|
+
export interface AdHocAutomation {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {string}
|
|
24
|
+
* @memberof AdHocAutomation
|
|
25
|
+
*/
|
|
26
|
+
title?: string;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {string}
|
|
30
|
+
* @memberof AdHocAutomation
|
|
31
|
+
*/
|
|
32
|
+
description?: string;
|
|
33
|
+
/**
|
|
34
|
+
* A list of tags.
|
|
35
|
+
* @type {Array<string>}
|
|
36
|
+
* @memberof AdHocAutomation
|
|
37
|
+
*/
|
|
38
|
+
tags?: Array<string>;
|
|
39
|
+
/**
|
|
40
|
+
* Additional details to be included in the automated message.
|
|
41
|
+
* @type {{ [key: string]: string; }}
|
|
42
|
+
* @memberof AdHocAutomation
|
|
43
|
+
*/
|
|
44
|
+
details?: {
|
|
45
|
+
[key: string]: string;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {AutomationMetadata}
|
|
50
|
+
* @memberof AdHocAutomation
|
|
51
|
+
*/
|
|
52
|
+
metadata?: AutomationMetadata | null;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {Array<AutomationTabularExport>}
|
|
56
|
+
* @memberof AdHocAutomation
|
|
57
|
+
*/
|
|
58
|
+
tabularExports?: Array<AutomationTabularExport>;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @type {Array<AutomationVisualExport>}
|
|
62
|
+
* @memberof AdHocAutomation
|
|
63
|
+
*/
|
|
64
|
+
visualExports?: Array<AutomationVisualExport>;
|
|
65
|
+
/**
|
|
66
|
+
* External recipients of the automation action results.
|
|
67
|
+
* @type {Array<AutomationExternalRecipient>}
|
|
68
|
+
* @memberof AdHocAutomation
|
|
69
|
+
*/
|
|
70
|
+
externalRecipients?: Array<AutomationExternalRecipient>;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {DeclarativeNotificationChannelIdentifier}
|
|
74
|
+
* @memberof AdHocAutomation
|
|
75
|
+
*/
|
|
76
|
+
notificationChannel?: DeclarativeNotificationChannelIdentifier;
|
|
77
|
+
/**
|
|
78
|
+
*
|
|
79
|
+
* @type {Array<DeclarativeUserIdentifier>}
|
|
80
|
+
* @memberof AdHocAutomation
|
|
81
|
+
*/
|
|
82
|
+
recipients?: Array<DeclarativeUserIdentifier>;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @type {DeclarativeAnalyticalDashboardIdentifier}
|
|
86
|
+
* @memberof AdHocAutomation
|
|
87
|
+
*/
|
|
88
|
+
analyticalDashboard?: DeclarativeAnalyticalDashboardIdentifier;
|
|
89
|
+
}
|
|
15
90
|
/**
|
|
16
91
|
*
|
|
17
92
|
* @export
|
|
@@ -147,6 +222,38 @@ export interface AlertEvaluationRow {
|
|
|
147
222
|
*/
|
|
148
223
|
labelValue?: string;
|
|
149
224
|
}
|
|
225
|
+
/**
|
|
226
|
+
*
|
|
227
|
+
* @export
|
|
228
|
+
* @interface AutomationExternalRecipient
|
|
229
|
+
*/
|
|
230
|
+
export interface AutomationExternalRecipient {
|
|
231
|
+
/**
|
|
232
|
+
* E-mail address to send notifications from.
|
|
233
|
+
* @type {string}
|
|
234
|
+
* @memberof AutomationExternalRecipient
|
|
235
|
+
*/
|
|
236
|
+
email: string;
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* Additional information for the automation.
|
|
240
|
+
* @export
|
|
241
|
+
* @interface AutomationMetadata
|
|
242
|
+
*/
|
|
243
|
+
export interface AutomationMetadata {
|
|
244
|
+
/**
|
|
245
|
+
*
|
|
246
|
+
* @type {string}
|
|
247
|
+
* @memberof AutomationMetadata
|
|
248
|
+
*/
|
|
249
|
+
widget?: string;
|
|
250
|
+
/**
|
|
251
|
+
*
|
|
252
|
+
* @type {Array<VisibleFilter>}
|
|
253
|
+
* @memberof AutomationMetadata
|
|
254
|
+
*/
|
|
255
|
+
visibleFilters?: Array<VisibleFilter>;
|
|
256
|
+
}
|
|
150
257
|
/**
|
|
151
258
|
*
|
|
152
259
|
* @export
|
|
@@ -173,6 +280,156 @@ export interface AutomationNotificationAllOf {
|
|
|
173
280
|
*/
|
|
174
281
|
content?: WebhookMessage;
|
|
175
282
|
}
|
|
283
|
+
/**
|
|
284
|
+
*
|
|
285
|
+
* @export
|
|
286
|
+
* @interface AutomationTabularExport
|
|
287
|
+
*/
|
|
288
|
+
export interface AutomationTabularExport {
|
|
289
|
+
/**
|
|
290
|
+
*
|
|
291
|
+
* @type {TabularExportRequest}
|
|
292
|
+
* @memberof AutomationTabularExport
|
|
293
|
+
*/
|
|
294
|
+
requestPayload: TabularExportRequest;
|
|
295
|
+
}
|
|
296
|
+
/**
|
|
297
|
+
*
|
|
298
|
+
* @export
|
|
299
|
+
* @interface AutomationVisualExport
|
|
300
|
+
*/
|
|
301
|
+
export interface AutomationVisualExport {
|
|
302
|
+
/**
|
|
303
|
+
*
|
|
304
|
+
* @type {VisualExportRequest}
|
|
305
|
+
* @memberof AutomationVisualExport
|
|
306
|
+
*/
|
|
307
|
+
requestPayload: VisualExportRequest;
|
|
308
|
+
}
|
|
309
|
+
/**
|
|
310
|
+
* Custom label object override.
|
|
311
|
+
* @export
|
|
312
|
+
* @interface CustomLabel
|
|
313
|
+
*/
|
|
314
|
+
export interface CustomLabel {
|
|
315
|
+
/**
|
|
316
|
+
* Override value.
|
|
317
|
+
* @type {string}
|
|
318
|
+
* @memberof CustomLabel
|
|
319
|
+
*/
|
|
320
|
+
title: string;
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* Custom metric object override.
|
|
324
|
+
* @export
|
|
325
|
+
* @interface CustomMetric
|
|
326
|
+
*/
|
|
327
|
+
export interface CustomMetric {
|
|
328
|
+
/**
|
|
329
|
+
* Metric title override.
|
|
330
|
+
* @type {string}
|
|
331
|
+
* @memberof CustomMetric
|
|
332
|
+
*/
|
|
333
|
+
title: string;
|
|
334
|
+
/**
|
|
335
|
+
* Format override.
|
|
336
|
+
* @type {string}
|
|
337
|
+
* @memberof CustomMetric
|
|
338
|
+
*/
|
|
339
|
+
format: string;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* Custom cell value overrides (IDs will be replaced with specified values).
|
|
343
|
+
* @export
|
|
344
|
+
* @interface CustomOverride
|
|
345
|
+
*/
|
|
346
|
+
export interface CustomOverride {
|
|
347
|
+
/**
|
|
348
|
+
* Map of CustomLabels with keys used as placeholders in document.
|
|
349
|
+
* @type {{ [key: string]: CustomLabel; }}
|
|
350
|
+
* @memberof CustomOverride
|
|
351
|
+
*/
|
|
352
|
+
labels?: {
|
|
353
|
+
[key: string]: CustomLabel;
|
|
354
|
+
};
|
|
355
|
+
/**
|
|
356
|
+
* Map of CustomMetrics with keys used as placeholders in document.
|
|
357
|
+
* @type {{ [key: string]: CustomMetric; }}
|
|
358
|
+
* @memberof CustomOverride
|
|
359
|
+
*/
|
|
360
|
+
metrics?: {
|
|
361
|
+
[key: string]: CustomMetric;
|
|
362
|
+
};
|
|
363
|
+
}
|
|
364
|
+
/**
|
|
365
|
+
* An analytical dashboard identifier.
|
|
366
|
+
* @export
|
|
367
|
+
* @interface DeclarativeAnalyticalDashboardIdentifier
|
|
368
|
+
*/
|
|
369
|
+
export interface DeclarativeAnalyticalDashboardIdentifier {
|
|
370
|
+
/**
|
|
371
|
+
* Identifier of the analytical dashboard.
|
|
372
|
+
* @type {string}
|
|
373
|
+
* @memberof DeclarativeAnalyticalDashboardIdentifier
|
|
374
|
+
*/
|
|
375
|
+
id: string;
|
|
376
|
+
/**
|
|
377
|
+
* A type.
|
|
378
|
+
* @type {string}
|
|
379
|
+
* @memberof DeclarativeAnalyticalDashboardIdentifier
|
|
380
|
+
*/
|
|
381
|
+
type: DeclarativeAnalyticalDashboardIdentifierTypeEnum;
|
|
382
|
+
}
|
|
383
|
+
export declare const DeclarativeAnalyticalDashboardIdentifierTypeEnum: {
|
|
384
|
+
readonly ANALYTICAL_DASHBOARD: "analyticalDashboard";
|
|
385
|
+
};
|
|
386
|
+
export type DeclarativeAnalyticalDashboardIdentifierTypeEnum = typeof DeclarativeAnalyticalDashboardIdentifierTypeEnum[keyof typeof DeclarativeAnalyticalDashboardIdentifierTypeEnum];
|
|
387
|
+
/**
|
|
388
|
+
* A notification channel identifier.
|
|
389
|
+
* @export
|
|
390
|
+
* @interface DeclarativeNotificationChannelIdentifier
|
|
391
|
+
*/
|
|
392
|
+
export interface DeclarativeNotificationChannelIdentifier {
|
|
393
|
+
/**
|
|
394
|
+
* Notification channel identifier.
|
|
395
|
+
* @type {string}
|
|
396
|
+
* @memberof DeclarativeNotificationChannelIdentifier
|
|
397
|
+
*/
|
|
398
|
+
id: string;
|
|
399
|
+
/**
|
|
400
|
+
* A type.
|
|
401
|
+
* @type {string}
|
|
402
|
+
* @memberof DeclarativeNotificationChannelIdentifier
|
|
403
|
+
*/
|
|
404
|
+
type: DeclarativeNotificationChannelIdentifierTypeEnum;
|
|
405
|
+
}
|
|
406
|
+
export declare const DeclarativeNotificationChannelIdentifierTypeEnum: {
|
|
407
|
+
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
408
|
+
};
|
|
409
|
+
export type DeclarativeNotificationChannelIdentifierTypeEnum = typeof DeclarativeNotificationChannelIdentifierTypeEnum[keyof typeof DeclarativeNotificationChannelIdentifierTypeEnum];
|
|
410
|
+
/**
|
|
411
|
+
* A user identifier.
|
|
412
|
+
* @export
|
|
413
|
+
* @interface DeclarativeUserIdentifier
|
|
414
|
+
*/
|
|
415
|
+
export interface DeclarativeUserIdentifier {
|
|
416
|
+
/**
|
|
417
|
+
* User identifier.
|
|
418
|
+
* @type {string}
|
|
419
|
+
* @memberof DeclarativeUserIdentifier
|
|
420
|
+
*/
|
|
421
|
+
id: string;
|
|
422
|
+
/**
|
|
423
|
+
* A type.
|
|
424
|
+
* @type {string}
|
|
425
|
+
* @memberof DeclarativeUserIdentifier
|
|
426
|
+
*/
|
|
427
|
+
type: DeclarativeUserIdentifierTypeEnum;
|
|
428
|
+
}
|
|
429
|
+
export declare const DeclarativeUserIdentifierTypeEnum: {
|
|
430
|
+
readonly USER: "user";
|
|
431
|
+
};
|
|
432
|
+
export type DeclarativeUserIdentifierTypeEnum = typeof DeclarativeUserIdentifierTypeEnum[keyof typeof DeclarativeUserIdentifierTypeEnum];
|
|
176
433
|
/**
|
|
177
434
|
* Default SMTP destination for notifications.
|
|
178
435
|
* @export
|
|
@@ -400,6 +657,87 @@ export interface NotificationsMetaTotal {
|
|
|
400
657
|
*/
|
|
401
658
|
all: number;
|
|
402
659
|
}
|
|
660
|
+
/**
|
|
661
|
+
* Custom CSS styles for the table. (PDF, HTML)
|
|
662
|
+
* @export
|
|
663
|
+
* @interface PdfTableStyle
|
|
664
|
+
*/
|
|
665
|
+
export interface PdfTableStyle {
|
|
666
|
+
/**
|
|
667
|
+
* CSS selector where to apply given properties.
|
|
668
|
+
* @type {string}
|
|
669
|
+
* @memberof PdfTableStyle
|
|
670
|
+
*/
|
|
671
|
+
selector: string;
|
|
672
|
+
/**
|
|
673
|
+
* List of CSS properties.
|
|
674
|
+
* @type {Array<PdfTableStyleProperty>}
|
|
675
|
+
* @memberof PdfTableStyle
|
|
676
|
+
*/
|
|
677
|
+
properties?: Array<PdfTableStyleProperty>;
|
|
678
|
+
}
|
|
679
|
+
/**
|
|
680
|
+
* CSS property.
|
|
681
|
+
* @export
|
|
682
|
+
* @interface PdfTableStyleProperty
|
|
683
|
+
*/
|
|
684
|
+
export interface PdfTableStyleProperty {
|
|
685
|
+
/**
|
|
686
|
+
* CSS property key.
|
|
687
|
+
* @type {string}
|
|
688
|
+
* @memberof PdfTableStyleProperty
|
|
689
|
+
*/
|
|
690
|
+
key: string;
|
|
691
|
+
/**
|
|
692
|
+
* CSS property value.
|
|
693
|
+
* @type {string}
|
|
694
|
+
* @memberof PdfTableStyleProperty
|
|
695
|
+
*/
|
|
696
|
+
value: string;
|
|
697
|
+
}
|
|
698
|
+
/**
|
|
699
|
+
* Additional settings.
|
|
700
|
+
* @export
|
|
701
|
+
* @interface Settings
|
|
702
|
+
*/
|
|
703
|
+
export interface Settings {
|
|
704
|
+
/**
|
|
705
|
+
* Merge equal headers in neighbouring cells. (XLSX)
|
|
706
|
+
* @type {boolean}
|
|
707
|
+
* @memberof Settings
|
|
708
|
+
*/
|
|
709
|
+
mergeHeaders?: boolean;
|
|
710
|
+
/**
|
|
711
|
+
* Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)
|
|
712
|
+
* @type {boolean}
|
|
713
|
+
* @memberof Settings
|
|
714
|
+
*/
|
|
715
|
+
showFilters?: boolean;
|
|
716
|
+
/**
|
|
717
|
+
* Page size and orientation. (PDF)
|
|
718
|
+
* @type {string}
|
|
719
|
+
* @memberof Settings
|
|
720
|
+
*/
|
|
721
|
+
pdfPageSize?: string;
|
|
722
|
+
/**
|
|
723
|
+
* Custom CSS styles for the table. (PDF, HTML)
|
|
724
|
+
* @type {Array<PdfTableStyle>}
|
|
725
|
+
* @memberof Settings
|
|
726
|
+
*/
|
|
727
|
+
pdfTableStyle?: Array<PdfTableStyle>;
|
|
728
|
+
/**
|
|
729
|
+
* Top left header content. (PDF)
|
|
730
|
+
* @type {string}
|
|
731
|
+
* @memberof Settings
|
|
732
|
+
*/
|
|
733
|
+
pdfTopLeftContent?: string;
|
|
734
|
+
/**
|
|
735
|
+
* Top right header content. (PDF)
|
|
736
|
+
* @type {string}
|
|
737
|
+
* @memberof Settings
|
|
738
|
+
*/
|
|
739
|
+
pdfTopRightContent?: string;
|
|
740
|
+
}
|
|
403
741
|
/**
|
|
404
742
|
* Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update
|
|
405
743
|
* @export
|
|
@@ -460,6 +798,74 @@ export declare const SmtpTypeEnum: {
|
|
|
460
798
|
readonly SMTP: "SMTP";
|
|
461
799
|
};
|
|
462
800
|
export type SmtpTypeEnum = typeof SmtpTypeEnum[keyof typeof SmtpTypeEnum];
|
|
801
|
+
/**
|
|
802
|
+
* Export request object describing the export properties and overrides for tabular exports.
|
|
803
|
+
* @export
|
|
804
|
+
* @interface TabularExportRequest
|
|
805
|
+
*/
|
|
806
|
+
export interface TabularExportRequest {
|
|
807
|
+
/**
|
|
808
|
+
* Expected file format.
|
|
809
|
+
* @type {string}
|
|
810
|
+
* @memberof TabularExportRequest
|
|
811
|
+
*/
|
|
812
|
+
format: TabularExportRequestFormatEnum;
|
|
813
|
+
/**
|
|
814
|
+
* Execution result identifier.
|
|
815
|
+
* @type {string}
|
|
816
|
+
* @memberof TabularExportRequest
|
|
817
|
+
*/
|
|
818
|
+
executionResult?: string;
|
|
819
|
+
/**
|
|
820
|
+
* Filename of downloaded file without extension.
|
|
821
|
+
* @type {string}
|
|
822
|
+
* @memberof TabularExportRequest
|
|
823
|
+
*/
|
|
824
|
+
fileName: string;
|
|
825
|
+
/**
|
|
826
|
+
*
|
|
827
|
+
* @type {Settings}
|
|
828
|
+
* @memberof TabularExportRequest
|
|
829
|
+
*/
|
|
830
|
+
settings?: Settings;
|
|
831
|
+
/**
|
|
832
|
+
*
|
|
833
|
+
* @type {CustomOverride}
|
|
834
|
+
* @memberof TabularExportRequest
|
|
835
|
+
*/
|
|
836
|
+
customOverride?: CustomOverride;
|
|
837
|
+
/**
|
|
838
|
+
* Visualization object identifier. Alternative to executionResult property.
|
|
839
|
+
* @type {string}
|
|
840
|
+
* @memberof TabularExportRequest
|
|
841
|
+
*/
|
|
842
|
+
visualizationObject?: string;
|
|
843
|
+
/**
|
|
844
|
+
* Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given.
|
|
845
|
+
* @type {Array<object>}
|
|
846
|
+
* @memberof TabularExportRequest
|
|
847
|
+
*/
|
|
848
|
+
visualizationObjectCustomFilters?: Array<object>;
|
|
849
|
+
/**
|
|
850
|
+
* Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
|
|
851
|
+
* @type {string}
|
|
852
|
+
* @memberof TabularExportRequest
|
|
853
|
+
*/
|
|
854
|
+
relatedDashboardId?: string;
|
|
855
|
+
/**
|
|
856
|
+
* Metadata definition in free-form JSON format.
|
|
857
|
+
* @type {object}
|
|
858
|
+
* @memberof TabularExportRequest
|
|
859
|
+
*/
|
|
860
|
+
metadata?: object | null;
|
|
861
|
+
}
|
|
862
|
+
export declare const TabularExportRequestFormatEnum: {
|
|
863
|
+
readonly CSV: "CSV";
|
|
864
|
+
readonly XLSX: "XLSX";
|
|
865
|
+
readonly HTML: "HTML";
|
|
866
|
+
readonly PDF: "PDF";
|
|
867
|
+
};
|
|
868
|
+
export type TabularExportRequestFormatEnum = typeof TabularExportRequestFormatEnum[keyof typeof TabularExportRequestFormatEnum];
|
|
463
869
|
/**
|
|
464
870
|
* Request body with notification channel destination to test.
|
|
465
871
|
* @export
|
|
@@ -518,6 +924,63 @@ export interface TestResponse {
|
|
|
518
924
|
*/
|
|
519
925
|
error?: string;
|
|
520
926
|
}
|
|
927
|
+
/**
|
|
928
|
+
*
|
|
929
|
+
* @export
|
|
930
|
+
* @interface TriggerAutomationRequest
|
|
931
|
+
*/
|
|
932
|
+
export interface TriggerAutomationRequest {
|
|
933
|
+
/**
|
|
934
|
+
*
|
|
935
|
+
* @type {AdHocAutomation}
|
|
936
|
+
* @memberof TriggerAutomationRequest
|
|
937
|
+
*/
|
|
938
|
+
automation: AdHocAutomation;
|
|
939
|
+
}
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @export
|
|
943
|
+
* @interface VisibleFilter
|
|
944
|
+
*/
|
|
945
|
+
export interface VisibleFilter {
|
|
946
|
+
/**
|
|
947
|
+
*
|
|
948
|
+
* @type {string}
|
|
949
|
+
* @memberof VisibleFilter
|
|
950
|
+
*/
|
|
951
|
+
localIdentifier?: string;
|
|
952
|
+
/**
|
|
953
|
+
*
|
|
954
|
+
* @type {string}
|
|
955
|
+
* @memberof VisibleFilter
|
|
956
|
+
*/
|
|
957
|
+
title?: string;
|
|
958
|
+
}
|
|
959
|
+
/**
|
|
960
|
+
* Export request object describing the export properties and metadata for dashboard PDF exports.
|
|
961
|
+
* @export
|
|
962
|
+
* @interface VisualExportRequest
|
|
963
|
+
*/
|
|
964
|
+
export interface VisualExportRequest {
|
|
965
|
+
/**
|
|
966
|
+
* File name to be used for retrieving the pdf document.
|
|
967
|
+
* @type {string}
|
|
968
|
+
* @memberof VisualExportRequest
|
|
969
|
+
*/
|
|
970
|
+
fileName: string;
|
|
971
|
+
/**
|
|
972
|
+
* Dashboard identifier
|
|
973
|
+
* @type {string}
|
|
974
|
+
* @memberof VisualExportRequest
|
|
975
|
+
*/
|
|
976
|
+
dashboardId: string;
|
|
977
|
+
/**
|
|
978
|
+
* Metadata definition in free-form JSON format.
|
|
979
|
+
* @type {object}
|
|
980
|
+
* @memberof VisualExportRequest
|
|
981
|
+
*/
|
|
982
|
+
metadata?: object;
|
|
983
|
+
}
|
|
521
984
|
/**
|
|
522
985
|
* Webhook destination for notifications. The property url is required on create and update.
|
|
523
986
|
* @export
|
|
@@ -734,6 +1197,24 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
734
1197
|
* @throws {RequiredError}
|
|
735
1198
|
*/
|
|
736
1199
|
testNotificationChannel: (testDestinationRequest: TestDestinationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1200
|
+
/**
|
|
1201
|
+
* Trigger the automation in the request.
|
|
1202
|
+
* @summary Trigger automation.
|
|
1203
|
+
* @param {string} workspaceId
|
|
1204
|
+
* @param {TriggerAutomationRequest} triggerAutomationRequest
|
|
1205
|
+
* @param {*} [options] Override http request option.
|
|
1206
|
+
* @throws {RequiredError}
|
|
1207
|
+
*/
|
|
1208
|
+
triggerAutomation: (workspaceId: string, triggerAutomationRequest: TriggerAutomationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1209
|
+
/**
|
|
1210
|
+
* Trigger the existing automation to execute immediately.
|
|
1211
|
+
* @summary Trigger existing automation.
|
|
1212
|
+
* @param {string} workspaceId
|
|
1213
|
+
* @param {string} automationId
|
|
1214
|
+
* @param {*} [options] Override http request option.
|
|
1215
|
+
* @throws {RequiredError}
|
|
1216
|
+
*/
|
|
1217
|
+
triggerExistingAutomation: (workspaceId: string, automationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
737
1218
|
};
|
|
738
1219
|
/**
|
|
739
1220
|
* ActionsApi - functional programming interface
|
|
@@ -785,6 +1266,24 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
785
1266
|
* @throws {RequiredError}
|
|
786
1267
|
*/
|
|
787
1268
|
testNotificationChannel(testDestinationRequest: TestDestinationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestResponse>>;
|
|
1269
|
+
/**
|
|
1270
|
+
* Trigger the automation in the request.
|
|
1271
|
+
* @summary Trigger automation.
|
|
1272
|
+
* @param {string} workspaceId
|
|
1273
|
+
* @param {TriggerAutomationRequest} triggerAutomationRequest
|
|
1274
|
+
* @param {*} [options] Override http request option.
|
|
1275
|
+
* @throws {RequiredError}
|
|
1276
|
+
*/
|
|
1277
|
+
triggerAutomation(workspaceId: string, triggerAutomationRequest: TriggerAutomationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1278
|
+
/**
|
|
1279
|
+
* Trigger the existing automation to execute immediately.
|
|
1280
|
+
* @summary Trigger existing automation.
|
|
1281
|
+
* @param {string} workspaceId
|
|
1282
|
+
* @param {string} automationId
|
|
1283
|
+
* @param {*} [options] Override http request option.
|
|
1284
|
+
* @throws {RequiredError}
|
|
1285
|
+
*/
|
|
1286
|
+
triggerExistingAutomation(workspaceId: string, automationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
788
1287
|
};
|
|
789
1288
|
/**
|
|
790
1289
|
* ActionsApi - factory interface
|
|
@@ -831,6 +1330,22 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
831
1330
|
* @throws {RequiredError}
|
|
832
1331
|
*/
|
|
833
1332
|
testNotificationChannel(requestParameters: ActionsApiTestNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<TestResponse>;
|
|
1333
|
+
/**
|
|
1334
|
+
* Trigger the automation in the request.
|
|
1335
|
+
* @summary Trigger automation.
|
|
1336
|
+
* @param {ActionsApiTriggerAutomationRequest} requestParameters Request parameters.
|
|
1337
|
+
* @param {*} [options] Override http request option.
|
|
1338
|
+
* @throws {RequiredError}
|
|
1339
|
+
*/
|
|
1340
|
+
triggerAutomation(requestParameters: ActionsApiTriggerAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1341
|
+
/**
|
|
1342
|
+
* Trigger the existing automation to execute immediately.
|
|
1343
|
+
* @summary Trigger existing automation.
|
|
1344
|
+
* @param {ActionsApiTriggerExistingAutomationRequest} requestParameters Request parameters.
|
|
1345
|
+
* @param {*} [options] Override http request option.
|
|
1346
|
+
* @throws {RequiredError}
|
|
1347
|
+
*/
|
|
1348
|
+
triggerExistingAutomation(requestParameters: ActionsApiTriggerExistingAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
834
1349
|
};
|
|
835
1350
|
/**
|
|
836
1351
|
* ActionsApi - interface
|
|
@@ -883,6 +1398,24 @@ export interface ActionsApiInterface {
|
|
|
883
1398
|
* @memberof ActionsApiInterface
|
|
884
1399
|
*/
|
|
885
1400
|
testNotificationChannel(requestParameters: ActionsApiTestNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<TestResponse>;
|
|
1401
|
+
/**
|
|
1402
|
+
* Trigger the automation in the request.
|
|
1403
|
+
* @summary Trigger automation.
|
|
1404
|
+
* @param {ActionsApiTriggerAutomationRequest} requestParameters Request parameters.
|
|
1405
|
+
* @param {*} [options] Override http request option.
|
|
1406
|
+
* @throws {RequiredError}
|
|
1407
|
+
* @memberof ActionsApiInterface
|
|
1408
|
+
*/
|
|
1409
|
+
triggerAutomation(requestParameters: ActionsApiTriggerAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1410
|
+
/**
|
|
1411
|
+
* Trigger the existing automation to execute immediately.
|
|
1412
|
+
* @summary Trigger existing automation.
|
|
1413
|
+
* @param {ActionsApiTriggerExistingAutomationRequest} requestParameters Request parameters.
|
|
1414
|
+
* @param {*} [options] Override http request option.
|
|
1415
|
+
* @throws {RequiredError}
|
|
1416
|
+
* @memberof ActionsApiInterface
|
|
1417
|
+
*/
|
|
1418
|
+
triggerExistingAutomation(requestParameters: ActionsApiTriggerExistingAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
886
1419
|
}
|
|
887
1420
|
/**
|
|
888
1421
|
* Request parameters for getNotifications operation in ActionsApi.
|
|
@@ -979,6 +1512,44 @@ export interface ActionsApiTestNotificationChannelRequest {
|
|
|
979
1512
|
*/
|
|
980
1513
|
readonly testDestinationRequest: TestDestinationRequest;
|
|
981
1514
|
}
|
|
1515
|
+
/**
|
|
1516
|
+
* Request parameters for triggerAutomation operation in ActionsApi.
|
|
1517
|
+
* @export
|
|
1518
|
+
* @interface ActionsApiTriggerAutomationRequest
|
|
1519
|
+
*/
|
|
1520
|
+
export interface ActionsApiTriggerAutomationRequest {
|
|
1521
|
+
/**
|
|
1522
|
+
*
|
|
1523
|
+
* @type {string}
|
|
1524
|
+
* @memberof ActionsApiTriggerAutomation
|
|
1525
|
+
*/
|
|
1526
|
+
readonly workspaceId: string;
|
|
1527
|
+
/**
|
|
1528
|
+
*
|
|
1529
|
+
* @type {TriggerAutomationRequest}
|
|
1530
|
+
* @memberof ActionsApiTriggerAutomation
|
|
1531
|
+
*/
|
|
1532
|
+
readonly triggerAutomationRequest: TriggerAutomationRequest;
|
|
1533
|
+
}
|
|
1534
|
+
/**
|
|
1535
|
+
* Request parameters for triggerExistingAutomation operation in ActionsApi.
|
|
1536
|
+
* @export
|
|
1537
|
+
* @interface ActionsApiTriggerExistingAutomationRequest
|
|
1538
|
+
*/
|
|
1539
|
+
export interface ActionsApiTriggerExistingAutomationRequest {
|
|
1540
|
+
/**
|
|
1541
|
+
*
|
|
1542
|
+
* @type {string}
|
|
1543
|
+
* @memberof ActionsApiTriggerExistingAutomation
|
|
1544
|
+
*/
|
|
1545
|
+
readonly workspaceId: string;
|
|
1546
|
+
/**
|
|
1547
|
+
*
|
|
1548
|
+
* @type {string}
|
|
1549
|
+
* @memberof ActionsApiTriggerExistingAutomation
|
|
1550
|
+
*/
|
|
1551
|
+
readonly automationId: string;
|
|
1552
|
+
}
|
|
982
1553
|
/**
|
|
983
1554
|
* ActionsApi - object-oriented interface
|
|
984
1555
|
* @export
|
|
@@ -1031,6 +1602,183 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
1031
1602
|
* @memberof ActionsApi
|
|
1032
1603
|
*/
|
|
1033
1604
|
testNotificationChannel(requestParameters: ActionsApiTestNotificationChannelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TestResponse, any>>;
|
|
1605
|
+
/**
|
|
1606
|
+
* Trigger the automation in the request.
|
|
1607
|
+
* @summary Trigger automation.
|
|
1608
|
+
* @param {ActionsApiTriggerAutomationRequest} requestParameters Request parameters.
|
|
1609
|
+
* @param {*} [options] Override http request option.
|
|
1610
|
+
* @throws {RequiredError}
|
|
1611
|
+
* @memberof ActionsApi
|
|
1612
|
+
*/
|
|
1613
|
+
triggerAutomation(requestParameters: ActionsApiTriggerAutomationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1614
|
+
/**
|
|
1615
|
+
* Trigger the existing automation to execute immediately.
|
|
1616
|
+
* @summary Trigger existing automation.
|
|
1617
|
+
* @param {ActionsApiTriggerExistingAutomationRequest} requestParameters Request parameters.
|
|
1618
|
+
* @param {*} [options] Override http request option.
|
|
1619
|
+
* @throws {RequiredError}
|
|
1620
|
+
* @memberof ActionsApi
|
|
1621
|
+
*/
|
|
1622
|
+
triggerExistingAutomation(requestParameters: ActionsApiTriggerExistingAutomationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1623
|
+
}
|
|
1624
|
+
/**
|
|
1625
|
+
* AutomationsApi - axios parameter creator
|
|
1626
|
+
* @export
|
|
1627
|
+
*/
|
|
1628
|
+
export declare const AutomationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1629
|
+
/**
|
|
1630
|
+
* Trigger the automation in the request.
|
|
1631
|
+
* @summary Trigger automation.
|
|
1632
|
+
* @param {string} workspaceId
|
|
1633
|
+
* @param {TriggerAutomationRequest} triggerAutomationRequest
|
|
1634
|
+
* @param {*} [options] Override http request option.
|
|
1635
|
+
* @throws {RequiredError}
|
|
1636
|
+
*/
|
|
1637
|
+
triggerAutomation: (workspaceId: string, triggerAutomationRequest: TriggerAutomationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1638
|
+
/**
|
|
1639
|
+
* Trigger the existing automation to execute immediately.
|
|
1640
|
+
* @summary Trigger existing automation.
|
|
1641
|
+
* @param {string} workspaceId
|
|
1642
|
+
* @param {string} automationId
|
|
1643
|
+
* @param {*} [options] Override http request option.
|
|
1644
|
+
* @throws {RequiredError}
|
|
1645
|
+
*/
|
|
1646
|
+
triggerExistingAutomation: (workspaceId: string, automationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1647
|
+
};
|
|
1648
|
+
/**
|
|
1649
|
+
* AutomationsApi - functional programming interface
|
|
1650
|
+
* @export
|
|
1651
|
+
*/
|
|
1652
|
+
export declare const AutomationsApiFp: (configuration?: Configuration) => {
|
|
1653
|
+
/**
|
|
1654
|
+
* Trigger the automation in the request.
|
|
1655
|
+
* @summary Trigger automation.
|
|
1656
|
+
* @param {string} workspaceId
|
|
1657
|
+
* @param {TriggerAutomationRequest} triggerAutomationRequest
|
|
1658
|
+
* @param {*} [options] Override http request option.
|
|
1659
|
+
* @throws {RequiredError}
|
|
1660
|
+
*/
|
|
1661
|
+
triggerAutomation(workspaceId: string, triggerAutomationRequest: TriggerAutomationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1662
|
+
/**
|
|
1663
|
+
* Trigger the existing automation to execute immediately.
|
|
1664
|
+
* @summary Trigger existing automation.
|
|
1665
|
+
* @param {string} workspaceId
|
|
1666
|
+
* @param {string} automationId
|
|
1667
|
+
* @param {*} [options] Override http request option.
|
|
1668
|
+
* @throws {RequiredError}
|
|
1669
|
+
*/
|
|
1670
|
+
triggerExistingAutomation(workspaceId: string, automationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1671
|
+
};
|
|
1672
|
+
/**
|
|
1673
|
+
* AutomationsApi - factory interface
|
|
1674
|
+
* @export
|
|
1675
|
+
*/
|
|
1676
|
+
export declare const AutomationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1677
|
+
/**
|
|
1678
|
+
* Trigger the automation in the request.
|
|
1679
|
+
* @summary Trigger automation.
|
|
1680
|
+
* @param {AutomationsApiTriggerAutomationRequest} requestParameters Request parameters.
|
|
1681
|
+
* @param {*} [options] Override http request option.
|
|
1682
|
+
* @throws {RequiredError}
|
|
1683
|
+
*/
|
|
1684
|
+
triggerAutomation(requestParameters: AutomationsApiTriggerAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1685
|
+
/**
|
|
1686
|
+
* Trigger the existing automation to execute immediately.
|
|
1687
|
+
* @summary Trigger existing automation.
|
|
1688
|
+
* @param {AutomationsApiTriggerExistingAutomationRequest} requestParameters Request parameters.
|
|
1689
|
+
* @param {*} [options] Override http request option.
|
|
1690
|
+
* @throws {RequiredError}
|
|
1691
|
+
*/
|
|
1692
|
+
triggerExistingAutomation(requestParameters: AutomationsApiTriggerExistingAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1693
|
+
};
|
|
1694
|
+
/**
|
|
1695
|
+
* AutomationsApi - interface
|
|
1696
|
+
* @export
|
|
1697
|
+
* @interface AutomationsApi
|
|
1698
|
+
*/
|
|
1699
|
+
export interface AutomationsApiInterface {
|
|
1700
|
+
/**
|
|
1701
|
+
* Trigger the automation in the request.
|
|
1702
|
+
* @summary Trigger automation.
|
|
1703
|
+
* @param {AutomationsApiTriggerAutomationRequest} requestParameters Request parameters.
|
|
1704
|
+
* @param {*} [options] Override http request option.
|
|
1705
|
+
* @throws {RequiredError}
|
|
1706
|
+
* @memberof AutomationsApiInterface
|
|
1707
|
+
*/
|
|
1708
|
+
triggerAutomation(requestParameters: AutomationsApiTriggerAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1709
|
+
/**
|
|
1710
|
+
* Trigger the existing automation to execute immediately.
|
|
1711
|
+
* @summary Trigger existing automation.
|
|
1712
|
+
* @param {AutomationsApiTriggerExistingAutomationRequest} requestParameters Request parameters.
|
|
1713
|
+
* @param {*} [options] Override http request option.
|
|
1714
|
+
* @throws {RequiredError}
|
|
1715
|
+
* @memberof AutomationsApiInterface
|
|
1716
|
+
*/
|
|
1717
|
+
triggerExistingAutomation(requestParameters: AutomationsApiTriggerExistingAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1718
|
+
}
|
|
1719
|
+
/**
|
|
1720
|
+
* Request parameters for triggerAutomation operation in AutomationsApi.
|
|
1721
|
+
* @export
|
|
1722
|
+
* @interface AutomationsApiTriggerAutomationRequest
|
|
1723
|
+
*/
|
|
1724
|
+
export interface AutomationsApiTriggerAutomationRequest {
|
|
1725
|
+
/**
|
|
1726
|
+
*
|
|
1727
|
+
* @type {string}
|
|
1728
|
+
* @memberof AutomationsApiTriggerAutomation
|
|
1729
|
+
*/
|
|
1730
|
+
readonly workspaceId: string;
|
|
1731
|
+
/**
|
|
1732
|
+
*
|
|
1733
|
+
* @type {TriggerAutomationRequest}
|
|
1734
|
+
* @memberof AutomationsApiTriggerAutomation
|
|
1735
|
+
*/
|
|
1736
|
+
readonly triggerAutomationRequest: TriggerAutomationRequest;
|
|
1737
|
+
}
|
|
1738
|
+
/**
|
|
1739
|
+
* Request parameters for triggerExistingAutomation operation in AutomationsApi.
|
|
1740
|
+
* @export
|
|
1741
|
+
* @interface AutomationsApiTriggerExistingAutomationRequest
|
|
1742
|
+
*/
|
|
1743
|
+
export interface AutomationsApiTriggerExistingAutomationRequest {
|
|
1744
|
+
/**
|
|
1745
|
+
*
|
|
1746
|
+
* @type {string}
|
|
1747
|
+
* @memberof AutomationsApiTriggerExistingAutomation
|
|
1748
|
+
*/
|
|
1749
|
+
readonly workspaceId: string;
|
|
1750
|
+
/**
|
|
1751
|
+
*
|
|
1752
|
+
* @type {string}
|
|
1753
|
+
* @memberof AutomationsApiTriggerExistingAutomation
|
|
1754
|
+
*/
|
|
1755
|
+
readonly automationId: string;
|
|
1756
|
+
}
|
|
1757
|
+
/**
|
|
1758
|
+
* AutomationsApi - object-oriented interface
|
|
1759
|
+
* @export
|
|
1760
|
+
* @class AutomationsApi
|
|
1761
|
+
* @extends {BaseAPI}
|
|
1762
|
+
*/
|
|
1763
|
+
export declare class AutomationsApi extends BaseAPI implements AutomationsApiInterface {
|
|
1764
|
+
/**
|
|
1765
|
+
* Trigger the automation in the request.
|
|
1766
|
+
* @summary Trigger automation.
|
|
1767
|
+
* @param {AutomationsApiTriggerAutomationRequest} requestParameters Request parameters.
|
|
1768
|
+
* @param {*} [options] Override http request option.
|
|
1769
|
+
* @throws {RequiredError}
|
|
1770
|
+
* @memberof AutomationsApi
|
|
1771
|
+
*/
|
|
1772
|
+
triggerAutomation(requestParameters: AutomationsApiTriggerAutomationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1773
|
+
/**
|
|
1774
|
+
* Trigger the existing automation to execute immediately.
|
|
1775
|
+
* @summary Trigger existing automation.
|
|
1776
|
+
* @param {AutomationsApiTriggerExistingAutomationRequest} requestParameters Request parameters.
|
|
1777
|
+
* @param {*} [options] Override http request option.
|
|
1778
|
+
* @throws {RequiredError}
|
|
1779
|
+
* @memberof AutomationsApi
|
|
1780
|
+
*/
|
|
1781
|
+
triggerExistingAutomation(requestParameters: AutomationsApiTriggerExistingAutomationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1034
1782
|
}
|
|
1035
1783
|
/**
|
|
1036
1784
|
* NotificationChannelsApi - axios parameter creator
|
|
@@ -1049,6 +1797,22 @@ export declare const NotificationChannelsApiAxiosParamCreator: (configuration?:
|
|
|
1049
1797
|
* @throws {RequiredError}
|
|
1050
1798
|
*/
|
|
1051
1799
|
getNotifications: (workspaceId?: string, isRead?: boolean, page?: string, size?: string, metaInclude?: Array<"total" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1800
|
+
/**
|
|
1801
|
+
* Mark in-platform notification by its ID as read.
|
|
1802
|
+
* @summary Mark notification as read.
|
|
1803
|
+
* @param {string} notificationId Notification ID to mark as read.
|
|
1804
|
+
* @param {*} [options] Override http request option.
|
|
1805
|
+
* @throws {RequiredError}
|
|
1806
|
+
*/
|
|
1807
|
+
markAsReadNotification: (notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1808
|
+
/**
|
|
1809
|
+
* Mark all user in-platform notifications as read.
|
|
1810
|
+
* @summary Mark all notifications as read.
|
|
1811
|
+
* @param {string} [workspaceId] Workspace ID where to mark notifications as read.
|
|
1812
|
+
* @param {*} [options] Override http request option.
|
|
1813
|
+
* @throws {RequiredError}
|
|
1814
|
+
*/
|
|
1815
|
+
markAsReadNotificationAll: (workspaceId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1052
1816
|
/**
|
|
1053
1817
|
* Tests the existing notification channel by sending a test notification.
|
|
1054
1818
|
* @summary Test existing notification channel.
|
|
@@ -1084,6 +1848,22 @@ export declare const NotificationChannelsApiFp: (configuration?: Configuration)
|
|
|
1084
1848
|
* @throws {RequiredError}
|
|
1085
1849
|
*/
|
|
1086
1850
|
getNotifications(workspaceId?: string, isRead?: boolean, page?: string, size?: string, metaInclude?: Array<"total" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notifications>>;
|
|
1851
|
+
/**
|
|
1852
|
+
* Mark in-platform notification by its ID as read.
|
|
1853
|
+
* @summary Mark notification as read.
|
|
1854
|
+
* @param {string} notificationId Notification ID to mark as read.
|
|
1855
|
+
* @param {*} [options] Override http request option.
|
|
1856
|
+
* @throws {RequiredError}
|
|
1857
|
+
*/
|
|
1858
|
+
markAsReadNotification(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1859
|
+
/**
|
|
1860
|
+
* Mark all user in-platform notifications as read.
|
|
1861
|
+
* @summary Mark all notifications as read.
|
|
1862
|
+
* @param {string} [workspaceId] Workspace ID where to mark notifications as read.
|
|
1863
|
+
* @param {*} [options] Override http request option.
|
|
1864
|
+
* @throws {RequiredError}
|
|
1865
|
+
*/
|
|
1866
|
+
markAsReadNotificationAll(workspaceId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1087
1867
|
/**
|
|
1088
1868
|
* Tests the existing notification channel by sending a test notification.
|
|
1089
1869
|
* @summary Test existing notification channel.
|
|
@@ -1115,6 +1895,22 @@ export declare const NotificationChannelsApiFactory: (configuration?: Configurat
|
|
|
1115
1895
|
* @throws {RequiredError}
|
|
1116
1896
|
*/
|
|
1117
1897
|
getNotifications(requestParameters: NotificationChannelsApiGetNotificationsRequest, options?: AxiosRequestConfig): AxiosPromise<Notifications>;
|
|
1898
|
+
/**
|
|
1899
|
+
* Mark in-platform notification by its ID as read.
|
|
1900
|
+
* @summary Mark notification as read.
|
|
1901
|
+
* @param {NotificationChannelsApiMarkAsReadNotificationRequest} requestParameters Request parameters.
|
|
1902
|
+
* @param {*} [options] Override http request option.
|
|
1903
|
+
* @throws {RequiredError}
|
|
1904
|
+
*/
|
|
1905
|
+
markAsReadNotification(requestParameters: NotificationChannelsApiMarkAsReadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1906
|
+
/**
|
|
1907
|
+
* Mark all user in-platform notifications as read.
|
|
1908
|
+
* @summary Mark all notifications as read.
|
|
1909
|
+
* @param {NotificationChannelsApiMarkAsReadNotificationAllRequest} requestParameters Request parameters.
|
|
1910
|
+
* @param {*} [options] Override http request option.
|
|
1911
|
+
* @throws {RequiredError}
|
|
1912
|
+
*/
|
|
1913
|
+
markAsReadNotificationAll(requestParameters: NotificationChannelsApiMarkAsReadNotificationAllRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1118
1914
|
/**
|
|
1119
1915
|
* Tests the existing notification channel by sending a test notification.
|
|
1120
1916
|
* @summary Test existing notification channel.
|
|
@@ -1147,6 +1943,24 @@ export interface NotificationChannelsApiInterface {
|
|
|
1147
1943
|
* @memberof NotificationChannelsApiInterface
|
|
1148
1944
|
*/
|
|
1149
1945
|
getNotifications(requestParameters: NotificationChannelsApiGetNotificationsRequest, options?: AxiosRequestConfig): AxiosPromise<Notifications>;
|
|
1946
|
+
/**
|
|
1947
|
+
* Mark in-platform notification by its ID as read.
|
|
1948
|
+
* @summary Mark notification as read.
|
|
1949
|
+
* @param {NotificationChannelsApiMarkAsReadNotificationRequest} requestParameters Request parameters.
|
|
1950
|
+
* @param {*} [options] Override http request option.
|
|
1951
|
+
* @throws {RequiredError}
|
|
1952
|
+
* @memberof NotificationChannelsApiInterface
|
|
1953
|
+
*/
|
|
1954
|
+
markAsReadNotification(requestParameters: NotificationChannelsApiMarkAsReadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1955
|
+
/**
|
|
1956
|
+
* Mark all user in-platform notifications as read.
|
|
1957
|
+
* @summary Mark all notifications as read.
|
|
1958
|
+
* @param {NotificationChannelsApiMarkAsReadNotificationAllRequest} requestParameters Request parameters.
|
|
1959
|
+
* @param {*} [options] Override http request option.
|
|
1960
|
+
* @throws {RequiredError}
|
|
1961
|
+
* @memberof NotificationChannelsApiInterface
|
|
1962
|
+
*/
|
|
1963
|
+
markAsReadNotificationAll(requestParameters: NotificationChannelsApiMarkAsReadNotificationAllRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1150
1964
|
/**
|
|
1151
1965
|
* Tests the existing notification channel by sending a test notification.
|
|
1152
1966
|
* @summary Test existing notification channel.
|
|
@@ -1203,6 +2017,32 @@ export interface NotificationChannelsApiGetNotificationsRequest {
|
|
|
1203
2017
|
*/
|
|
1204
2018
|
readonly metaInclude?: Array<"total" | "ALL">;
|
|
1205
2019
|
}
|
|
2020
|
+
/**
|
|
2021
|
+
* Request parameters for markAsReadNotification operation in NotificationChannelsApi.
|
|
2022
|
+
* @export
|
|
2023
|
+
* @interface NotificationChannelsApiMarkAsReadNotificationRequest
|
|
2024
|
+
*/
|
|
2025
|
+
export interface NotificationChannelsApiMarkAsReadNotificationRequest {
|
|
2026
|
+
/**
|
|
2027
|
+
* Notification ID to mark as read.
|
|
2028
|
+
* @type {string}
|
|
2029
|
+
* @memberof NotificationChannelsApiMarkAsReadNotification
|
|
2030
|
+
*/
|
|
2031
|
+
readonly notificationId: string;
|
|
2032
|
+
}
|
|
2033
|
+
/**
|
|
2034
|
+
* Request parameters for markAsReadNotificationAll operation in NotificationChannelsApi.
|
|
2035
|
+
* @export
|
|
2036
|
+
* @interface NotificationChannelsApiMarkAsReadNotificationAllRequest
|
|
2037
|
+
*/
|
|
2038
|
+
export interface NotificationChannelsApiMarkAsReadNotificationAllRequest {
|
|
2039
|
+
/**
|
|
2040
|
+
* Workspace ID where to mark notifications as read.
|
|
2041
|
+
* @type {string}
|
|
2042
|
+
* @memberof NotificationChannelsApiMarkAsReadNotificationAll
|
|
2043
|
+
*/
|
|
2044
|
+
readonly workspaceId?: string;
|
|
2045
|
+
}
|
|
1206
2046
|
/**
|
|
1207
2047
|
* Request parameters for testExistingNotificationChannel operation in NotificationChannelsApi.
|
|
1208
2048
|
* @export
|
|
@@ -1251,6 +2091,24 @@ export declare class NotificationChannelsApi extends BaseAPI implements Notifica
|
|
|
1251
2091
|
* @memberof NotificationChannelsApi
|
|
1252
2092
|
*/
|
|
1253
2093
|
getNotifications(requestParameters?: NotificationChannelsApiGetNotificationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notifications, any>>;
|
|
2094
|
+
/**
|
|
2095
|
+
* Mark in-platform notification by its ID as read.
|
|
2096
|
+
* @summary Mark notification as read.
|
|
2097
|
+
* @param {NotificationChannelsApiMarkAsReadNotificationRequest} requestParameters Request parameters.
|
|
2098
|
+
* @param {*} [options] Override http request option.
|
|
2099
|
+
* @throws {RequiredError}
|
|
2100
|
+
* @memberof NotificationChannelsApi
|
|
2101
|
+
*/
|
|
2102
|
+
markAsReadNotification(requestParameters: NotificationChannelsApiMarkAsReadNotificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2103
|
+
/**
|
|
2104
|
+
* Mark all user in-platform notifications as read.
|
|
2105
|
+
* @summary Mark all notifications as read.
|
|
2106
|
+
* @param {NotificationChannelsApiMarkAsReadNotificationAllRequest} requestParameters Request parameters.
|
|
2107
|
+
* @param {*} [options] Override http request option.
|
|
2108
|
+
* @throws {RequiredError}
|
|
2109
|
+
* @memberof NotificationChannelsApi
|
|
2110
|
+
*/
|
|
2111
|
+
markAsReadNotificationAll(requestParameters?: NotificationChannelsApiMarkAsReadNotificationAllRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1254
2112
|
/**
|
|
1255
2113
|
* Tests the existing notification channel by sending a test notification.
|
|
1256
2114
|
* @summary Test existing notification channel.
|