@gooddata/sdk-backend-spi 10.16.0-alpha.28 → 10.16.0-alpha.29
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/index.d.ts +1 -0
- package/esm/index.d.ts.map +1 -1
- package/esm/organization/notificationChannels/index.d.ts +17 -81
- package/esm/organization/notificationChannels/index.d.ts.map +1 -1
- package/esm/organization/notificationChannels/query.d.ts +59 -0
- package/esm/organization/notificationChannels/query.d.ts.map +1 -0
- package/esm/organization/notificationChannels/query.js +3 -0
- package/esm/organization/notificationChannels/query.js.map +1 -0
- package/esm/sdk-backend-spi.d.ts +76 -85
- package/package.json +2 -2
package/esm/index.d.ts
CHANGED
|
@@ -51,6 +51,7 @@ export type { IWorkspaceAccessControlService } from "./workspace/accessControl/i
|
|
|
51
51
|
export type { IOrganizationUserService, IOrganizationUsersQuery, IOrganizationUsersQueryResult, IOrganizationUserGroupsQuery, IOrganizationUserGroupsQueryResult, } from "./organization/users/index.js";
|
|
52
52
|
export type { IOrganizationPermissionService, IPermissionsAssignment, } from "./organization/permissions/index.js";
|
|
53
53
|
export type { IOrganizationNotificationChannelService } from "./organization/notificationChannels/index.js";
|
|
54
|
+
export type { INotificationChannelsQuery, INotificationChannelsQueryResult, } from "./organization/notificationChannels/query.js";
|
|
54
55
|
export type { IDataFiltersService } from "./workspace/dataFilter/index.js";
|
|
55
56
|
export type { IWorkspaceLogicalModelService, IDateDataset } from "./workspace/ldm/model.js";
|
|
56
57
|
export type { IWorkspaceAutomationService, IGetAutomationOptions, IGetAutomationsOptions, AutomationType, IAutomationsQuery, IAutomationsQueryResult, } from "./workspace/automations/index.js";
|
package/esm/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,YAAY,EACR,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,YAAY,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEtG,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,YAAY,EACR,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,gCAAgC,CAAC;AAExC,YAAY,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE/E,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE7E,YAAY,EACR,kBAAkB,EAClB,+BAA+B,EAC/B,yBAAyB,EACzB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,GACjC,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EACR,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,6BAA6B,EAC7B,kCAAkC,EAClC,oCAAoC,EACpC,sDAAsD,EACtD,yCAAyC,EACzC,oBAAoB,EACpB,4BAA4B,GAC/B,MAAM,0CAA0C,CAAC;AAClD,OAAO,EACH,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,GAC3C,MAAM,0CAA0C,CAAC;AAElD,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEtG,YAAY,EACR,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,GACvB,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAC7E,YAAY,EAAE,sBAAsB,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACpG,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,YAAY,EACR,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,GAC7B,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAE9F,YAAY,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAErF,YAAY,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAEnF,YAAY,EACR,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACrB,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEzE,YAAY,EACR,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,6BAA6B,EAC7B,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,iCAAiC,CAAC;AACzC,YAAY,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AACzF,OAAO,EACH,sBAAsB,EACtB,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACR,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACR,uBAAuB,EACvB,6BAA6B,GAChC,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,wBAAwB,EACxB,sCAAsC,EACtC,iBAAiB,EACjB,+BAA+B,EAC/B,mCAAmC,EACnC,iDAAiD,EACjD,+BAA+B,EAC/B,wBAAwB,GAC3B,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,YAAY,EACR,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC7E,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,YAAY,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAClE,YAAY,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAC5G,YAAY,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AACnF,YAAY,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAErF,YAAY,EACR,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,GAClC,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAEzF,YAAY,EACR,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,kCAAkC,GACrC,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACR,8BAA8B,EAC9B,sBAAsB,GACzB,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EAAE,uCAAuC,EAAE,MAAM,8CAA8C,CAAC;AAC5G,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAE3E,YAAY,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE5F,YAAY,EACR,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,iBAAiB,EACjB,uBAAuB,GAC1B,MAAM,kCAAkC,CAAC;AAE1C,YAAY,EAAE,gCAAgC,EAAE,MAAM,sCAAsC,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,YAAY,EACR,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,YAAY,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEtG,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,YAAY,EACR,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,gCAAgC,CAAC;AAExC,YAAY,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE/E,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE7E,YAAY,EACR,kBAAkB,EAClB,+BAA+B,EAC/B,yBAAyB,EACzB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,GACjC,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EACR,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,6BAA6B,EAC7B,kCAAkC,EAClC,oCAAoC,EACpC,sDAAsD,EACtD,yCAAyC,EACzC,oBAAoB,EACpB,4BAA4B,GAC/B,MAAM,0CAA0C,CAAC;AAClD,OAAO,EACH,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,GAC3C,MAAM,0CAA0C,CAAC;AAElD,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEtG,YAAY,EACR,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,GACvB,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAC7E,YAAY,EAAE,sBAAsB,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACpG,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,YAAY,EACR,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,GAC7B,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAE9F,YAAY,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAErF,YAAY,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAEnF,YAAY,EACR,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACrB,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEzE,YAAY,EACR,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,6BAA6B,EAC7B,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,iCAAiC,CAAC;AACzC,YAAY,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AACzF,OAAO,EACH,sBAAsB,EACtB,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACR,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACR,uBAAuB,EACvB,6BAA6B,GAChC,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,wBAAwB,EACxB,sCAAsC,EACtC,iBAAiB,EACjB,+BAA+B,EAC/B,mCAAmC,EACnC,iDAAiD,EACjD,+BAA+B,EAC/B,wBAAwB,GAC3B,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,YAAY,EACR,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC7E,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,YAAY,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAClE,YAAY,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAC5G,YAAY,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AACnF,YAAY,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAErF,YAAY,EACR,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,GAClC,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAEzF,YAAY,EACR,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,kCAAkC,GACrC,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACR,8BAA8B,EAC9B,sBAAsB,GACzB,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EAAE,uCAAuC,EAAE,MAAM,8CAA8C,CAAC;AAC5G,YAAY,EACR,0BAA0B,EAC1B,gCAAgC,GACnC,MAAM,8CAA8C,CAAC;AACtD,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAE3E,YAAY,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE5F,YAAY,EACR,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,iBAAiB,EACjB,uBAAuB,GAC1B,MAAM,kCAAkC,CAAC;AAE1C,YAAY,EAAE,gCAAgC,EAAE,MAAM,sCAAsC,CAAC"}
|
|
@@ -1,102 +1,38 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { INotificationChannelTestResponse, INotificationChannelMetadataObject, INotificationChannelMetadataObjectDefinition } from "@gooddata/sdk-model";
|
|
2
|
+
import { INotificationChannelsQuery } from "./query.js";
|
|
2
3
|
/**
|
|
3
4
|
* This service provides access to organization notifications channels.
|
|
4
5
|
*
|
|
5
|
-
* @
|
|
6
|
+
* @beta
|
|
6
7
|
*/
|
|
7
8
|
export interface IOrganizationNotificationChannelService {
|
|
8
9
|
/**
|
|
9
|
-
*
|
|
10
|
-
*/
|
|
11
|
-
getCount(): Promise<number>;
|
|
12
|
-
/**
|
|
13
|
-
* Get all notification channels
|
|
14
|
-
*/
|
|
15
|
-
getAll(): Promise<INotificationChannelDefinitionObject[]>;
|
|
16
|
-
/**
|
|
17
|
-
* Test channel
|
|
10
|
+
* Test notification channel
|
|
18
11
|
*
|
|
19
12
|
* @param channel - definition of the channel
|
|
20
13
|
* @param notificationId - id of the notification to test if its already created
|
|
21
14
|
* @returns Promise resolved with test response.
|
|
22
15
|
*/
|
|
23
|
-
|
|
16
|
+
testNotificationChannel(channel: INotificationChannelMetadataObjectDefinition): Promise<INotificationChannelTestResponse>;
|
|
17
|
+
getNotificationChannel(id: string): Promise<INotificationChannelMetadataObject>;
|
|
18
|
+
createNotificationChannel(notificationChannel: INotificationChannelMetadataObjectDefinition): Promise<INotificationChannelMetadataObject>;
|
|
24
19
|
/**
|
|
25
|
-
*
|
|
20
|
+
* Update existing notification channel
|
|
26
21
|
*
|
|
27
|
-
* @param
|
|
28
|
-
* @returns Promise resolved
|
|
22
|
+
* @param notificationChannel - definition of the notification channel
|
|
23
|
+
* @returns Promise resolved with updated notification channel.
|
|
29
24
|
*/
|
|
30
|
-
|
|
25
|
+
updateNotificationChannel(notificationChannel: INotificationChannelMetadataObject): Promise<INotificationChannelMetadataObject>;
|
|
31
26
|
/**
|
|
32
|
-
*
|
|
27
|
+
* Delete notification channel
|
|
33
28
|
*
|
|
34
|
-
* @
|
|
35
|
-
* @
|
|
29
|
+
* @param id - id of the notification channel
|
|
30
|
+
* @returns Promise resolved when the notification channel is deleted.
|
|
36
31
|
*/
|
|
37
|
-
|
|
32
|
+
deleteNotificationChannel(id: string): Promise<void>;
|
|
38
33
|
/**
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* @param id - id of the smtp
|
|
42
|
-
* @returns Promise resolved with smtp definition or undefined if not found.
|
|
43
|
-
*/
|
|
44
|
-
getEmail(id: string): Promise<ISmtpDefinitionObject>;
|
|
45
|
-
/**
|
|
46
|
-
* Create new email
|
|
47
|
-
*
|
|
48
|
-
* @param smtp - definition of the smtp
|
|
49
|
-
* @returns Promise resolved with created smtp.
|
|
50
|
-
*/
|
|
51
|
-
createEmail(smtp: ISmtpDefinition): Promise<ISmtpDefinitionObject>;
|
|
52
|
-
/**
|
|
53
|
-
* Update existing email
|
|
54
|
-
*
|
|
55
|
-
* @param smtp - definition of the smtp
|
|
56
|
-
* @returns Promise resolved when the smtp is updated.
|
|
57
|
-
*/
|
|
58
|
-
updateEmail(smtp: ISmtpDefinitionObject): Promise<ISmtpDefinitionObject>;
|
|
59
|
-
/**
|
|
60
|
-
* Delete email
|
|
61
|
-
*
|
|
62
|
-
* @param id - id of the smtp
|
|
63
|
-
* @returns Promise resolved when the smtp is deleted.
|
|
64
|
-
*/
|
|
65
|
-
deleteEmail(id: string): Promise<void>;
|
|
66
|
-
/**
|
|
67
|
-
* Get all webhooks
|
|
68
|
-
*
|
|
69
|
-
* @returns Promise resolved with array of webhooks.
|
|
70
|
-
* @throws In case of error.
|
|
71
|
-
*/
|
|
72
|
-
getWebhooks(): Promise<IWebhookDefinitionObject[]>;
|
|
73
|
-
/**
|
|
74
|
-
* Get webhook by id
|
|
75
|
-
*
|
|
76
|
-
* @param id - id of the webhook
|
|
77
|
-
* @returns Promise resolved with webhook definition or undefined if not found.
|
|
78
|
-
*/
|
|
79
|
-
getWebhook(id: string): Promise<IWebhookDefinitionObject>;
|
|
80
|
-
/**
|
|
81
|
-
* Create new webhook
|
|
82
|
-
*
|
|
83
|
-
* @param webhook - definition of the webhook
|
|
84
|
-
* @returns Promise resolved with created webhook.
|
|
85
|
-
*/
|
|
86
|
-
createWebhook(webhook: IWebhookDefinition): Promise<IWebhookDefinitionObject>;
|
|
87
|
-
/**
|
|
88
|
-
* Update existing webhook
|
|
89
|
-
*
|
|
90
|
-
* @param webhook - definition of the webhook
|
|
91
|
-
* @returns Promise resolved when the webhook is updated.
|
|
92
|
-
*/
|
|
93
|
-
updateWebhook(webhook: IWebhookDefinitionObject): Promise<IWebhookDefinitionObject>;
|
|
94
|
-
/**
|
|
95
|
-
* Delete webhook
|
|
96
|
-
*
|
|
97
|
-
* @param id - id of the webhook
|
|
98
|
-
* @returns Promise resolved when the webhook is deleted.
|
|
34
|
+
* Query list of notification channels
|
|
99
35
|
*/
|
|
100
|
-
|
|
36
|
+
getNotificationChannelsQuery(): INotificationChannelsQuery;
|
|
101
37
|
}
|
|
102
38
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/organization/notificationChannels/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/organization/notificationChannels/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,gCAAgC,EAChC,kCAAkC,EAClC,4CAA4C,EAC/C,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AAExD;;;;GAIG;AACH,MAAM,WAAW,uCAAuC;IACpD;;;;;;OAMG;IACH,uBAAuB,CACnB,OAAO,EAAE,4CAA4C,GACtD,OAAO,CAAC,gCAAgC,CAAC,CAAC;IAQ7C,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kCAAkC,CAAC,CAAC;IAQhF,yBAAyB,CACrB,mBAAmB,EAAE,4CAA4C,GAClE,OAAO,CAAC,kCAAkC,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,yBAAyB,CACrB,mBAAmB,EAAE,kCAAkC,GACxD,OAAO,CAAC,kCAAkC,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD;;OAEG;IACH,4BAA4B,IAAI,0BAA0B,CAAC;CAC9D"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { INotificationChannelMetadataObject, NotificationChannelDestinationType } from "@gooddata/sdk-model";
|
|
2
|
+
import { IPagedResource } from "../../common/paging.js";
|
|
3
|
+
/**
|
|
4
|
+
* Service to query notification channels.
|
|
5
|
+
*
|
|
6
|
+
* @beta
|
|
7
|
+
*/
|
|
8
|
+
export interface INotificationChannelsQuery {
|
|
9
|
+
/**
|
|
10
|
+
* Sets number of notification channels to return per page.
|
|
11
|
+
* Default size: 100
|
|
12
|
+
*
|
|
13
|
+
* @param size - desired max number of notification channels per page must be a positive number
|
|
14
|
+
* @returns notification channels query
|
|
15
|
+
*/
|
|
16
|
+
withSize(size: number): INotificationChannelsQuery;
|
|
17
|
+
/**
|
|
18
|
+
* Sets starting page for the query. Backend WILL return no data if the page is greater than
|
|
19
|
+
* total number of pages.
|
|
20
|
+
* Default page: 0
|
|
21
|
+
*
|
|
22
|
+
* @param page - zero indexed, must be non-negative
|
|
23
|
+
* @returns notification channels query
|
|
24
|
+
*/
|
|
25
|
+
withPage(page: number): INotificationChannelsQuery;
|
|
26
|
+
/**
|
|
27
|
+
* Sets sorting for the query.
|
|
28
|
+
*
|
|
29
|
+
* @param sort - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
30
|
+
* @returns notification channels query
|
|
31
|
+
*/
|
|
32
|
+
withSorting(sort: string[]): INotificationChannelsQuery;
|
|
33
|
+
/**
|
|
34
|
+
* Sets type of the automation for the query.
|
|
35
|
+
*
|
|
36
|
+
* @param type - type of the automation, e.g. "schedule" or "trigger"
|
|
37
|
+
* @returns notification channels query
|
|
38
|
+
*/
|
|
39
|
+
withTypes(type: NotificationChannelDestinationType[]): INotificationChannelsQuery;
|
|
40
|
+
/**
|
|
41
|
+
* Starts the notification channels query.
|
|
42
|
+
*
|
|
43
|
+
* @returns promise of first page of the results
|
|
44
|
+
*/
|
|
45
|
+
query(): Promise<INotificationChannelsQueryResult>;
|
|
46
|
+
/**
|
|
47
|
+
* Starts the notification channels query.
|
|
48
|
+
*
|
|
49
|
+
* @returns promise with a list of all notification channels matching the specified options
|
|
50
|
+
*/
|
|
51
|
+
queryAll(): Promise<INotificationChannelMetadataObject[]>;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Queried notification channels are returned in a paged representation.
|
|
55
|
+
*
|
|
56
|
+
* @beta
|
|
57
|
+
*/
|
|
58
|
+
export type INotificationChannelsQueryResult = IPagedResource<INotificationChannelMetadataObject>;
|
|
59
|
+
//# sourceMappingURL=query.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../src/organization/notificationChannels/query.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kCAAkC,EAAE,kCAAkC,EAAE,MAAM,qBAAqB,CAAC;AAC7G,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,0BAA0B,CAAC;IAEnD;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,0BAA0B,CAAC;IAEnD;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,0BAA0B,CAAC;IAExD;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,kCAAkC,EAAE,GAAG,0BAA0B,CAAC;IAElF;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,gCAAgC,CAAC,CAAC;IAEnD;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,kCAAkC,EAAE,CAAC,CAAC;CAC7D;AAED;;;;GAIG;AACH,MAAM,MAAM,gCAAgC,GAAG,cAAc,CAAC,kCAAkC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../src/organization/notificationChannels/query.ts"],"names":[],"mappings":"AAAA,qCAAqC"}
|
package/esm/sdk-backend-spi.d.ts
CHANGED
|
@@ -79,7 +79,8 @@ import { IMeasure } from '@gooddata/sdk-model';
|
|
|
79
79
|
import { IMeasureMetadataObject } from '@gooddata/sdk-model';
|
|
80
80
|
import { IMeasureMetadataObjectDefinition } from '@gooddata/sdk-model';
|
|
81
81
|
import { IMetadataObject } from '@gooddata/sdk-model';
|
|
82
|
-
import {
|
|
82
|
+
import { INotificationChannelMetadataObject } from '@gooddata/sdk-model';
|
|
83
|
+
import { INotificationChannelMetadataObjectDefinition } from '@gooddata/sdk-model';
|
|
83
84
|
import { INotificationChannelTestResponse } from '@gooddata/sdk-model';
|
|
84
85
|
import { INullableFilter } from '@gooddata/sdk-model';
|
|
85
86
|
import { IOpenAiConfig } from '@gooddata/sdk-model';
|
|
@@ -98,8 +99,6 @@ import { ISemanticSearchRelationship } from '@gooddata/sdk-model';
|
|
|
98
99
|
import { ISemanticSearchResultItem } from '@gooddata/sdk-model';
|
|
99
100
|
import { ISeparators } from '@gooddata/sdk-model';
|
|
100
101
|
import { ISettings } from '@gooddata/sdk-model';
|
|
101
|
-
import { ISmtpDefinition } from '@gooddata/sdk-model';
|
|
102
|
-
import { ISmtpDefinitionObject } from '@gooddata/sdk-model';
|
|
103
102
|
import { ISortItem } from '@gooddata/sdk-model';
|
|
104
103
|
import { ITheme } from '@gooddata/sdk-model';
|
|
105
104
|
import { IThemeDefinition } from '@gooddata/sdk-model';
|
|
@@ -107,8 +106,6 @@ import { IThemeMetadataObject } from '@gooddata/sdk-model';
|
|
|
107
106
|
import { IUser } from '@gooddata/sdk-model';
|
|
108
107
|
import { IUserGroup } from '@gooddata/sdk-model';
|
|
109
108
|
import { IVisualizationClass } from '@gooddata/sdk-model';
|
|
110
|
-
import { IWebhookDefinition } from '@gooddata/sdk-model';
|
|
111
|
-
import { IWebhookDefinitionObject } from '@gooddata/sdk-model';
|
|
112
109
|
import { IWhiteLabeling } from '@gooddata/sdk-model';
|
|
113
110
|
import { IWidget } from '@gooddata/sdk-model';
|
|
114
111
|
import { IWidgetAlert } from '@gooddata/sdk-model';
|
|
@@ -121,6 +118,7 @@ import { IWorkspacePermissions } from '@gooddata/sdk-model';
|
|
|
121
118
|
import { IWorkspaceUser } from '@gooddata/sdk-model';
|
|
122
119
|
import { IWorkspaceUserGroup } from '@gooddata/sdk-model';
|
|
123
120
|
import { LlmEndpointOpenAIPatch } from '@gooddata/sdk-model';
|
|
121
|
+
import { NotificationChannelDestinationType } from '@gooddata/sdk-model';
|
|
124
122
|
import { ObjectType } from '@gooddata/sdk-model';
|
|
125
123
|
import { ObjRef } from '@gooddata/sdk-model';
|
|
126
124
|
import { OrganizationPermissionAssignment } from '@gooddata/sdk-model';
|
|
@@ -2606,6 +2604,64 @@ export declare interface IMeasureReferencing {
|
|
|
2606
2604
|
insights?: IInsight[];
|
|
2607
2605
|
}
|
|
2608
2606
|
|
|
2607
|
+
/**
|
|
2608
|
+
* Service to query notification channels.
|
|
2609
|
+
*
|
|
2610
|
+
* @beta
|
|
2611
|
+
*/
|
|
2612
|
+
export declare interface INotificationChannelsQuery {
|
|
2613
|
+
/**
|
|
2614
|
+
* Sets number of notification channels to return per page.
|
|
2615
|
+
* Default size: 100
|
|
2616
|
+
*
|
|
2617
|
+
* @param size - desired max number of notification channels per page must be a positive number
|
|
2618
|
+
* @returns notification channels query
|
|
2619
|
+
*/
|
|
2620
|
+
withSize(size: number): INotificationChannelsQuery;
|
|
2621
|
+
/**
|
|
2622
|
+
* Sets starting page for the query. Backend WILL return no data if the page is greater than
|
|
2623
|
+
* total number of pages.
|
|
2624
|
+
* Default page: 0
|
|
2625
|
+
*
|
|
2626
|
+
* @param page - zero indexed, must be non-negative
|
|
2627
|
+
* @returns notification channels query
|
|
2628
|
+
*/
|
|
2629
|
+
withPage(page: number): INotificationChannelsQuery;
|
|
2630
|
+
/**
|
|
2631
|
+
* Sets sorting for the query.
|
|
2632
|
+
*
|
|
2633
|
+
* @param sort - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
2634
|
+
* @returns notification channels query
|
|
2635
|
+
*/
|
|
2636
|
+
withSorting(sort: string[]): INotificationChannelsQuery;
|
|
2637
|
+
/**
|
|
2638
|
+
* Sets type of the automation for the query.
|
|
2639
|
+
*
|
|
2640
|
+
* @param type - type of the automation, e.g. "schedule" or "trigger"
|
|
2641
|
+
* @returns notification channels query
|
|
2642
|
+
*/
|
|
2643
|
+
withTypes(type: NotificationChannelDestinationType[]): INotificationChannelsQuery;
|
|
2644
|
+
/**
|
|
2645
|
+
* Starts the notification channels query.
|
|
2646
|
+
*
|
|
2647
|
+
* @returns promise of first page of the results
|
|
2648
|
+
*/
|
|
2649
|
+
query(): Promise<INotificationChannelsQueryResult>;
|
|
2650
|
+
/**
|
|
2651
|
+
* Starts the notification channels query.
|
|
2652
|
+
*
|
|
2653
|
+
* @returns promise with a list of all notification channels matching the specified options
|
|
2654
|
+
*/
|
|
2655
|
+
queryAll(): Promise<INotificationChannelMetadataObject[]>;
|
|
2656
|
+
}
|
|
2657
|
+
|
|
2658
|
+
/**
|
|
2659
|
+
* Queried notification channels are returned in a paged representation.
|
|
2660
|
+
*
|
|
2661
|
+
* @beta
|
|
2662
|
+
*/
|
|
2663
|
+
export declare type INotificationChannelsQueryResult = IPagedResource<INotificationChannelMetadataObject>;
|
|
2664
|
+
|
|
2609
2665
|
/**
|
|
2610
2666
|
* Ordering options for insight query.
|
|
2611
2667
|
*
|
|
@@ -2758,102 +2814,37 @@ export declare interface IOrganizationLlmEndpointsService {
|
|
|
2758
2814
|
/**
|
|
2759
2815
|
* This service provides access to organization notifications channels.
|
|
2760
2816
|
*
|
|
2761
|
-
* @
|
|
2817
|
+
* @beta
|
|
2762
2818
|
*/
|
|
2763
2819
|
export declare interface IOrganizationNotificationChannelService {
|
|
2764
2820
|
/**
|
|
2765
|
-
*
|
|
2766
|
-
*/
|
|
2767
|
-
getCount(): Promise<number>;
|
|
2768
|
-
/**
|
|
2769
|
-
* Get all notification channels
|
|
2770
|
-
*/
|
|
2771
|
-
getAll(): Promise<INotificationChannelDefinitionObject[]>;
|
|
2772
|
-
/**
|
|
2773
|
-
* Test channel
|
|
2821
|
+
* Test notification channel
|
|
2774
2822
|
*
|
|
2775
2823
|
* @param channel - definition of the channel
|
|
2776
2824
|
* @param notificationId - id of the notification to test if its already created
|
|
2777
2825
|
* @returns Promise resolved with test response.
|
|
2778
2826
|
*/
|
|
2779
|
-
|
|
2780
|
-
|
|
2781
|
-
|
|
2782
|
-
*
|
|
2783
|
-
* @param id - id of the channel
|
|
2784
|
-
* @returns Promise resolved when the channel is deleted.
|
|
2785
|
-
*/
|
|
2786
|
-
deleteChannel(id: string): Promise<void>;
|
|
2787
|
-
/**
|
|
2788
|
-
* Get all emails
|
|
2789
|
-
*
|
|
2790
|
-
* @returns Promise resolved with array of emails.
|
|
2791
|
-
* @throws In case of error.
|
|
2792
|
-
*/
|
|
2793
|
-
getEmails(): Promise<ISmtpDefinitionObject[]>;
|
|
2794
|
-
/**
|
|
2795
|
-
* Get email by id
|
|
2796
|
-
*
|
|
2797
|
-
* @param id - id of the smtp
|
|
2798
|
-
* @returns Promise resolved with smtp definition or undefined if not found.
|
|
2799
|
-
*/
|
|
2800
|
-
getEmail(id: string): Promise<ISmtpDefinitionObject>;
|
|
2801
|
-
/**
|
|
2802
|
-
* Create new email
|
|
2803
|
-
*
|
|
2804
|
-
* @param smtp - definition of the smtp
|
|
2805
|
-
* @returns Promise resolved with created smtp.
|
|
2806
|
-
*/
|
|
2807
|
-
createEmail(smtp: ISmtpDefinition): Promise<ISmtpDefinitionObject>;
|
|
2808
|
-
/**
|
|
2809
|
-
* Update existing email
|
|
2810
|
-
*
|
|
2811
|
-
* @param smtp - definition of the smtp
|
|
2812
|
-
* @returns Promise resolved when the smtp is updated.
|
|
2813
|
-
*/
|
|
2814
|
-
updateEmail(smtp: ISmtpDefinitionObject): Promise<ISmtpDefinitionObject>;
|
|
2815
|
-
/**
|
|
2816
|
-
* Delete email
|
|
2817
|
-
*
|
|
2818
|
-
* @param id - id of the smtp
|
|
2819
|
-
* @returns Promise resolved when the smtp is deleted.
|
|
2820
|
-
*/
|
|
2821
|
-
deleteEmail(id: string): Promise<void>;
|
|
2822
|
-
/**
|
|
2823
|
-
* Get all webhooks
|
|
2824
|
-
*
|
|
2825
|
-
* @returns Promise resolved with array of webhooks.
|
|
2826
|
-
* @throws In case of error.
|
|
2827
|
-
*/
|
|
2828
|
-
getWebhooks(): Promise<IWebhookDefinitionObject[]>;
|
|
2827
|
+
testNotificationChannel(channel: INotificationChannelMetadataObjectDefinition): Promise<INotificationChannelTestResponse>;
|
|
2828
|
+
getNotificationChannel(id: string): Promise<INotificationChannelMetadataObject>;
|
|
2829
|
+
createNotificationChannel(notificationChannel: INotificationChannelMetadataObjectDefinition): Promise<INotificationChannelMetadataObject>;
|
|
2829
2830
|
/**
|
|
2830
|
-
*
|
|
2831
|
+
* Update existing notification channel
|
|
2831
2832
|
*
|
|
2832
|
-
* @param
|
|
2833
|
-
* @returns Promise resolved with
|
|
2833
|
+
* @param notificationChannel - definition of the notification channel
|
|
2834
|
+
* @returns Promise resolved with updated notification channel.
|
|
2834
2835
|
*/
|
|
2835
|
-
|
|
2836
|
+
updateNotificationChannel(notificationChannel: INotificationChannelMetadataObject): Promise<INotificationChannelMetadataObject>;
|
|
2836
2837
|
/**
|
|
2837
|
-
*
|
|
2838
|
+
* Delete notification channel
|
|
2838
2839
|
*
|
|
2839
|
-
* @param
|
|
2840
|
-
* @returns Promise resolved
|
|
2840
|
+
* @param id - id of the notification channel
|
|
2841
|
+
* @returns Promise resolved when the notification channel is deleted.
|
|
2841
2842
|
*/
|
|
2842
|
-
|
|
2843
|
+
deleteNotificationChannel(id: string): Promise<void>;
|
|
2843
2844
|
/**
|
|
2844
|
-
*
|
|
2845
|
-
*
|
|
2846
|
-
* @param webhook - definition of the webhook
|
|
2847
|
-
* @returns Promise resolved when the webhook is updated.
|
|
2848
|
-
*/
|
|
2849
|
-
updateWebhook(webhook: IWebhookDefinitionObject): Promise<IWebhookDefinitionObject>;
|
|
2850
|
-
/**
|
|
2851
|
-
* Delete webhook
|
|
2852
|
-
*
|
|
2853
|
-
* @param id - id of the webhook
|
|
2854
|
-
* @returns Promise resolved when the webhook is deleted.
|
|
2845
|
+
* Query list of notification channels
|
|
2855
2846
|
*/
|
|
2856
|
-
|
|
2847
|
+
getNotificationChannelsQuery(): INotificationChannelsQuery;
|
|
2857
2848
|
}
|
|
2858
2849
|
|
|
2859
2850
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-backend-spi",
|
|
3
|
-
"version": "10.16.0-alpha.
|
|
3
|
+
"version": "10.16.0-alpha.29",
|
|
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.16.0-alpha.
|
|
27
|
+
"@gooddata/sdk-model": "10.16.0-alpha.29"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@gooddata/eslint-config": "^4.1.0",
|