@gooddata/sdk-backend-spi 10.9.0-alpha.2 → 10.9.0-alpha.20
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/organization/notificationChannels/index.d.ts +51 -5
- package/esm/organization/notificationChannels/index.d.ts.map +1 -1
- package/esm/organization/settings/index.d.ts +9 -1
- package/esm/organization/settings/index.d.ts.map +1 -1
- package/esm/sdk-backend-spi.d.ts +64 -6
- package/package.json +2 -2
|
@@ -1,38 +1,84 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { INotificationChannelDefinitionObject, IWebhookDefinitionObject, IWebhookDefinition, ISmtpDefinitionObject, ISmtpDefinition } from "@gooddata/sdk-model";
|
|
2
2
|
/**
|
|
3
3
|
* This service provides access to organization notifications channels.
|
|
4
4
|
*
|
|
5
5
|
* @alpha
|
|
6
6
|
*/
|
|
7
7
|
export interface IOrganizationNotificationChannelService {
|
|
8
|
+
/**
|
|
9
|
+
* Get all notification channels
|
|
10
|
+
*/
|
|
11
|
+
getAll(): Promise<INotificationChannelDefinitionObject[]>;
|
|
12
|
+
/**
|
|
13
|
+
* Delete channel
|
|
14
|
+
*
|
|
15
|
+
* @param id - id of the channel
|
|
16
|
+
* @returns Promise resolved when the channel is deleted.
|
|
17
|
+
*/
|
|
18
|
+
deleteChannel(id: string): Promise<void>;
|
|
19
|
+
/**
|
|
20
|
+
* Get all emails
|
|
21
|
+
*
|
|
22
|
+
* @returns Promise resolved with array of emails.
|
|
23
|
+
* @throws In case of error.
|
|
24
|
+
*/
|
|
25
|
+
getEmails(): Promise<ISmtpDefinitionObject[]>;
|
|
26
|
+
/**
|
|
27
|
+
* Get email by id
|
|
28
|
+
*
|
|
29
|
+
* @param id - id of the smtp
|
|
30
|
+
* @returns Promise resolved with smtp definition or undefined if not found.
|
|
31
|
+
*/
|
|
32
|
+
getEmail(id: string): Promise<ISmtpDefinitionObject>;
|
|
33
|
+
/**
|
|
34
|
+
* Create new email
|
|
35
|
+
*
|
|
36
|
+
* @param smtp - definition of the smtp
|
|
37
|
+
* @returns Promise resolved with created smtp.
|
|
38
|
+
*/
|
|
39
|
+
createEmail(smtp: ISmtpDefinition): Promise<ISmtpDefinitionObject>;
|
|
40
|
+
/**
|
|
41
|
+
* Update existing email
|
|
42
|
+
*
|
|
43
|
+
* @param smtp - definition of the smtp
|
|
44
|
+
* @returns Promise resolved when the smtp is updated.
|
|
45
|
+
*/
|
|
46
|
+
updateEmail(smtp: ISmtpDefinitionObject): Promise<ISmtpDefinitionObject>;
|
|
47
|
+
/**
|
|
48
|
+
* Delete email
|
|
49
|
+
*
|
|
50
|
+
* @param id - id of the smtp
|
|
51
|
+
* @returns Promise resolved when the smtp is deleted.
|
|
52
|
+
*/
|
|
53
|
+
deleteEmail(id: string): Promise<void>;
|
|
8
54
|
/**
|
|
9
55
|
* Get all webhooks
|
|
10
56
|
*
|
|
11
57
|
* @returns Promise resolved with array of webhooks.
|
|
12
58
|
* @throws In case of error.
|
|
13
59
|
*/
|
|
14
|
-
getWebhooks(): Promise<
|
|
60
|
+
getWebhooks(): Promise<IWebhookDefinitionObject[]>;
|
|
15
61
|
/**
|
|
16
62
|
* Get webhook by id
|
|
17
63
|
*
|
|
18
64
|
* @param id - id of the webhook
|
|
19
65
|
* @returns Promise resolved with webhook definition or undefined if not found.
|
|
20
66
|
*/
|
|
21
|
-
getWebhook(id: string): Promise<
|
|
67
|
+
getWebhook(id: string): Promise<IWebhookDefinitionObject>;
|
|
22
68
|
/**
|
|
23
69
|
* Create new webhook
|
|
24
70
|
*
|
|
25
71
|
* @param webhook - definition of the webhook
|
|
26
72
|
* @returns Promise resolved with created webhook.
|
|
27
73
|
*/
|
|
28
|
-
createWebhook(webhook:
|
|
74
|
+
createWebhook(webhook: IWebhookDefinition): Promise<IWebhookDefinitionObject>;
|
|
29
75
|
/**
|
|
30
76
|
* Update existing webhook
|
|
31
77
|
*
|
|
32
78
|
* @param webhook - definition of the webhook
|
|
33
79
|
* @returns Promise resolved when the webhook is updated.
|
|
34
80
|
*/
|
|
35
|
-
updateWebhook(webhook:
|
|
81
|
+
updateWebhook(webhook: IWebhookDefinitionObject): Promise<IWebhookDefinitionObject>;
|
|
36
82
|
/**
|
|
37
83
|
* Delete webhook
|
|
38
84
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/organization/notificationChannels/index.ts"],"names":[],"mappings":"AAEA,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/organization/notificationChannels/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,oCAAoC,EACpC,wBAAwB,EACxB,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EAClB,MAAM,qBAAqB,CAAC;AAE7B;;;;GAIG;AACH,MAAM,WAAW,uCAAuC;IACpD;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,oCAAoC,EAAE,CAAC,CAAC;IAE1D;;;;;OAKG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;OAKG;IACH,SAAS,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAErD;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAEnE;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAEzE;;;;;OAKG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,WAAW,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC;IAEnD;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAE1D;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEpF;;;;;OAKG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ISettings, IWhiteLabeling, IOpenAiConfig } from "@gooddata/sdk-model";
|
|
1
|
+
import { ISettings, IWhiteLabeling, IOpenAiConfig, IAlertDefault } from "@gooddata/sdk-model";
|
|
2
2
|
/**
|
|
3
3
|
* This service provides access to organization settings
|
|
4
4
|
*
|
|
@@ -54,6 +54,14 @@ export interface IOrganizationSettingsService {
|
|
|
54
54
|
* @returns promise
|
|
55
55
|
*/
|
|
56
56
|
setTheme(themeId: string): Promise<void>;
|
|
57
|
+
/**
|
|
58
|
+
* Sets alert default
|
|
59
|
+
*
|
|
60
|
+
* @param value - describes parameters for alerting.
|
|
61
|
+
*
|
|
62
|
+
* @returns promise
|
|
63
|
+
*/
|
|
64
|
+
setAlertDefault(value: IAlertDefault): Promise<void>;
|
|
57
65
|
/**
|
|
58
66
|
* Sets color palette for organization.
|
|
59
67
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/organization/settings/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/organization/settings/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAE9F;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IACzC;;;;;;OAMG;IACH,gBAAgB,CAAC,aAAa,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;OAMG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,eAAe,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD;;;;;;OAMG;IACH,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;;;;;OAOG;IACH,eAAe,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B;;;;OAIG;IACH,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;;;;OAOG;IACH,WAAW,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;CACrC"}
|
package/esm/sdk-backend-spi.d.ts
CHANGED
|
@@ -17,6 +17,7 @@ import { FilterContextItem } from '@gooddata/sdk-model';
|
|
|
17
17
|
import { GenAISemanticSearchType } from '@gooddata/sdk-model';
|
|
18
18
|
import { IAbsoluteDateFilter } from '@gooddata/sdk-model';
|
|
19
19
|
import { IAccessGrantee } from '@gooddata/sdk-model';
|
|
20
|
+
import { IAlertDefault } from '@gooddata/sdk-model';
|
|
20
21
|
import { IAttributeDisplayFormMetadataObject } from '@gooddata/sdk-model';
|
|
21
22
|
import { IAttributeElement } from '@gooddata/sdk-model';
|
|
22
23
|
import { IAttributeFilter } from '@gooddata/sdk-model';
|
|
@@ -70,6 +71,7 @@ import { IMeasure } from '@gooddata/sdk-model';
|
|
|
70
71
|
import { IMeasureMetadataObject } from '@gooddata/sdk-model';
|
|
71
72
|
import { IMeasureMetadataObjectDefinition } from '@gooddata/sdk-model';
|
|
72
73
|
import { IMetadataObject } from '@gooddata/sdk-model';
|
|
74
|
+
import { INotificationChannelDefinitionObject } from '@gooddata/sdk-model';
|
|
73
75
|
import { INullableFilter } from '@gooddata/sdk-model';
|
|
74
76
|
import { IOpenAiConfig } from '@gooddata/sdk-model';
|
|
75
77
|
import { IOrganizationAssignee } from '@gooddata/sdk-model';
|
|
@@ -87,6 +89,8 @@ import { ISemanticSearchRelationship } from '@gooddata/sdk-model';
|
|
|
87
89
|
import { ISemanticSearchResultItem } from '@gooddata/sdk-model';
|
|
88
90
|
import { ISeparators } from '@gooddata/sdk-model';
|
|
89
91
|
import { ISettings } from '@gooddata/sdk-model';
|
|
92
|
+
import { ISmtpDefinition } from '@gooddata/sdk-model';
|
|
93
|
+
import { ISmtpDefinitionObject } from '@gooddata/sdk-model';
|
|
90
94
|
import { ISortItem } from '@gooddata/sdk-model';
|
|
91
95
|
import { ITheme } from '@gooddata/sdk-model';
|
|
92
96
|
import { IThemeDefinition } from '@gooddata/sdk-model';
|
|
@@ -94,8 +98,8 @@ import { IThemeMetadataObject } from '@gooddata/sdk-model';
|
|
|
94
98
|
import { IUser } from '@gooddata/sdk-model';
|
|
95
99
|
import { IUserGroup } from '@gooddata/sdk-model';
|
|
96
100
|
import { IVisualizationClass } from '@gooddata/sdk-model';
|
|
97
|
-
import {
|
|
98
|
-
import {
|
|
101
|
+
import { IWebhookDefinition } from '@gooddata/sdk-model';
|
|
102
|
+
import { IWebhookDefinitionObject } from '@gooddata/sdk-model';
|
|
99
103
|
import { IWhiteLabeling } from '@gooddata/sdk-model';
|
|
100
104
|
import { IWidget } from '@gooddata/sdk-model';
|
|
101
105
|
import { IWidgetAlert } from '@gooddata/sdk-model';
|
|
@@ -2562,34 +2566,80 @@ export declare interface IOrganization {
|
|
|
2562
2566
|
* @alpha
|
|
2563
2567
|
*/
|
|
2564
2568
|
export declare interface IOrganizationNotificationChannelService {
|
|
2569
|
+
/**
|
|
2570
|
+
* Get all notification channels
|
|
2571
|
+
*/
|
|
2572
|
+
getAll(): Promise<INotificationChannelDefinitionObject[]>;
|
|
2573
|
+
/**
|
|
2574
|
+
* Delete channel
|
|
2575
|
+
*
|
|
2576
|
+
* @param id - id of the channel
|
|
2577
|
+
* @returns Promise resolved when the channel is deleted.
|
|
2578
|
+
*/
|
|
2579
|
+
deleteChannel(id: string): Promise<void>;
|
|
2580
|
+
/**
|
|
2581
|
+
* Get all emails
|
|
2582
|
+
*
|
|
2583
|
+
* @returns Promise resolved with array of emails.
|
|
2584
|
+
* @throws In case of error.
|
|
2585
|
+
*/
|
|
2586
|
+
getEmails(): Promise<ISmtpDefinitionObject[]>;
|
|
2587
|
+
/**
|
|
2588
|
+
* Get email by id
|
|
2589
|
+
*
|
|
2590
|
+
* @param id - id of the smtp
|
|
2591
|
+
* @returns Promise resolved with smtp definition or undefined if not found.
|
|
2592
|
+
*/
|
|
2593
|
+
getEmail(id: string): Promise<ISmtpDefinitionObject>;
|
|
2594
|
+
/**
|
|
2595
|
+
* Create new email
|
|
2596
|
+
*
|
|
2597
|
+
* @param smtp - definition of the smtp
|
|
2598
|
+
* @returns Promise resolved with created smtp.
|
|
2599
|
+
*/
|
|
2600
|
+
createEmail(smtp: ISmtpDefinition): Promise<ISmtpDefinitionObject>;
|
|
2601
|
+
/**
|
|
2602
|
+
* Update existing email
|
|
2603
|
+
*
|
|
2604
|
+
* @param smtp - definition of the smtp
|
|
2605
|
+
* @returns Promise resolved when the smtp is updated.
|
|
2606
|
+
*/
|
|
2607
|
+
updateEmail(smtp: ISmtpDefinitionObject): Promise<ISmtpDefinitionObject>;
|
|
2608
|
+
/**
|
|
2609
|
+
* Delete email
|
|
2610
|
+
*
|
|
2611
|
+
* @param id - id of the smtp
|
|
2612
|
+
* @returns Promise resolved when the smtp is deleted.
|
|
2613
|
+
*/
|
|
2614
|
+
deleteEmail(id: string): Promise<void>;
|
|
2565
2615
|
/**
|
|
2566
2616
|
* Get all webhooks
|
|
2567
2617
|
*
|
|
2568
2618
|
* @returns Promise resolved with array of webhooks.
|
|
2569
2619
|
* @throws In case of error.
|
|
2570
2620
|
*/
|
|
2571
|
-
getWebhooks(): Promise<
|
|
2621
|
+
getWebhooks(): Promise<IWebhookDefinitionObject[]>;
|
|
2572
2622
|
/**
|
|
2573
2623
|
* Get webhook by id
|
|
2574
2624
|
*
|
|
2575
2625
|
* @param id - id of the webhook
|
|
2576
2626
|
* @returns Promise resolved with webhook definition or undefined if not found.
|
|
2577
2627
|
*/
|
|
2578
|
-
getWebhook(id: string): Promise<
|
|
2628
|
+
getWebhook(id: string): Promise<IWebhookDefinitionObject>;
|
|
2579
2629
|
/**
|
|
2580
2630
|
* Create new webhook
|
|
2581
2631
|
*
|
|
2582
2632
|
* @param webhook - definition of the webhook
|
|
2583
2633
|
* @returns Promise resolved with created webhook.
|
|
2584
2634
|
*/
|
|
2585
|
-
createWebhook(webhook:
|
|
2635
|
+
createWebhook(webhook: IWebhookDefinition): Promise<IWebhookDefinitionObject>;
|
|
2586
2636
|
/**
|
|
2587
2637
|
* Update existing webhook
|
|
2588
2638
|
*
|
|
2589
2639
|
* @param webhook - definition of the webhook
|
|
2590
2640
|
* @returns Promise resolved when the webhook is updated.
|
|
2591
2641
|
*/
|
|
2592
|
-
updateWebhook(webhook:
|
|
2642
|
+
updateWebhook(webhook: IWebhookDefinitionObject): Promise<IWebhookDefinitionObject>;
|
|
2593
2643
|
/**
|
|
2594
2644
|
* Delete webhook
|
|
2595
2645
|
*
|
|
@@ -2736,6 +2786,14 @@ export declare interface IOrganizationSettingsService {
|
|
|
2736
2786
|
* @returns promise
|
|
2737
2787
|
*/
|
|
2738
2788
|
setTheme(themeId: string): Promise<void>;
|
|
2789
|
+
/**
|
|
2790
|
+
* Sets alert default
|
|
2791
|
+
*
|
|
2792
|
+
* @param value - describes parameters for alerting.
|
|
2793
|
+
*
|
|
2794
|
+
* @returns promise
|
|
2795
|
+
*/
|
|
2796
|
+
setAlertDefault(value: IAlertDefault): Promise<void>;
|
|
2739
2797
|
/**
|
|
2740
2798
|
* Sets color palette for organization.
|
|
2741
2799
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-backend-spi",
|
|
3
|
-
"version": "10.9.0-alpha.
|
|
3
|
+
"version": "10.9.0-alpha.20",
|
|
4
4
|
"author": "GoodData",
|
|
5
5
|
"description": "GoodData Backend SPI abstraction interfaces",
|
|
6
6
|
"repository": {
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"lodash": "^4.17.21",
|
|
25
25
|
"ts-invariant": "^0.7.5",
|
|
26
26
|
"tslib": "^2.5.0",
|
|
27
|
-
"@gooddata/sdk-model": "10.9.0-alpha.
|
|
27
|
+
"@gooddata/sdk-model": "10.9.0-alpha.20"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@gooddata/eslint-config": "^4.1.0",
|