@gooddata/sdk-backend-spi 10.9.0-alpha.9 → 10.10.0-alpha.0

package/esm/organization/notificationChannels/index.d.ts

@@ -1,38 +1,84 @@
-import { IWebhookMetadataObject, IWebhookMetadataObjectDefinition } from "@gooddata/sdk-model";
+import { INotificationChannelDefinitionObject, IWebhookDefinitionObject, IWebhookDefinition, ISmtpDefinitionObject, ISmtpDefinition } from "@gooddata/sdk-model";
 /**
  * This service provides access to organization notifications channels.
  *
  * @alpha
  */
 export interface IOrganizationNotificationChannelService {
+    /**
+     * Get all notification channels
+     */
+    getAll(): Promise<INotificationChannelDefinitionObject[]>;
+    /**
+     * Delete channel
+     *
+     * @param id - id of the channel
+     * @returns Promise resolved when the channel is deleted.
+     */
+    deleteChannel(id: string): Promise<void>;
+    /**
+     * Get all emails
+     *
+     * @returns Promise resolved with array of emails.
+     * @throws In case of error.
+     */
+    getEmails(): Promise<ISmtpDefinitionObject[]>;
+    /**
+     * Get email by id
+     *
+     * @param id - id of the smtp
+     * @returns Promise resolved with smtp definition or undefined if not found.
+     */
+    getEmail(id: string): Promise<ISmtpDefinitionObject>;
+    /**
+     * Create new email
+     *
+     * @param smtp - definition of the smtp
+     * @returns Promise resolved with created smtp.
+     */
+    createEmail(smtp: ISmtpDefinition): Promise<ISmtpDefinitionObject>;
+    /**
+     * Update existing email
+     *
+     * @param smtp - definition of the smtp
+     * @returns Promise resolved when the smtp is updated.
+     */
+    updateEmail(smtp: ISmtpDefinitionObject): Promise<ISmtpDefinitionObject>;
+    /**
+     * Delete email
+     *
+     * @param id - id of the smtp
+     * @returns Promise resolved when the smtp is deleted.
+     */
+    deleteEmail(id: string): Promise<void>;
     /**
      * Get all webhooks
      *
      * @returns Promise resolved with array of webhooks.
      * @throws In case of error.
      */
-    getWebhooks(): Promise<IWebhookMetadataObject[]>;
+    getWebhooks(): Promise<IWebhookDefinitionObject[]>;
     /**
      * Get webhook by id
      *
      * @param id - id of the webhook
      * @returns Promise resolved with webhook definition or undefined if not found.
      */
-    getWebhook(id: string): Promise<IWebhookMetadataObject>;
+    getWebhook(id: string): Promise<IWebhookDefinitionObject>;
     /**
      * Create new webhook
      *
      * @param webhook - definition of the webhook
      * @returns Promise resolved with created webhook.
      */
-    createWebhook(webhook: IWebhookMetadataObjectDefinition): Promise<IWebhookMetadataObject>;
+    createWebhook(webhook: IWebhookDefinition): Promise<IWebhookDefinitionObject>;
     /**
      * Update existing webhook
      *
      * @param webhook - definition of the webhook
      * @returns Promise resolved when the webhook is updated.
      */
-    updateWebhook(webhook: IWebhookMetadataObject): Promise<IWebhookMetadataObject>;
+    updateWebhook(webhook: IWebhookDefinitionObject): Promise<IWebhookDefinitionObject>;
     /**
      * Delete webhook
      *

package/esm/organization/notificationChannels/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/organization/notificationChannels/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,sBAAsB,EAAE,gCAAgC,EAAE,MAAM,qBAAqB,CAAC;AAE/F;;;;GAIG;AACH,MAAM,WAAW,uCAAuC;IACpD;;;;;OAKG;IACH,WAAW,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAExD;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,gCAAgC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAEhF;;;;;OAKG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C"}
+{"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"}

package/esm/sdk-backend-spi.d.ts

@@ -71,6 +71,7 @@ import { IMeasure } from '@gooddata/sdk-model';
 import { IMeasureMetadataObject } from '@gooddata/sdk-model';
 import { IMeasureMetadataObjectDefinition } from '@gooddata/sdk-model';
 import { IMetadataObject } from '@gooddata/sdk-model';
+import { INotificationChannelDefinitionObject } from '@gooddata/sdk-model';
 import { INullableFilter } from '@gooddata/sdk-model';
 import { IOpenAiConfig } from '@gooddata/sdk-model';
 import { IOrganizationAssignee } from '@gooddata/sdk-model';
@@ -88,6 +89,8 @@ import { ISemanticSearchRelationship } from '@gooddata/sdk-model';
 import { ISemanticSearchResultItem } from '@gooddata/sdk-model';
 import { ISeparators } from '@gooddata/sdk-model';
 import { ISettings } from '@gooddata/sdk-model';
+import { ISmtpDefinition } from '@gooddata/sdk-model';
+import { ISmtpDefinitionObject } from '@gooddata/sdk-model';
 import { ISortItem } from '@gooddata/sdk-model';
 import { ITheme } from '@gooddata/sdk-model';
 import { IThemeDefinition } from '@gooddata/sdk-model';
@@ -95,8 +98,8 @@ import { IThemeMetadataObject } from '@gooddata/sdk-model';
 import { IUser } from '@gooddata/sdk-model';
 import { IUserGroup } from '@gooddata/sdk-model';
 import { IVisualizationClass } from '@gooddata/sdk-model';
-import { IWebhookMetadataObject } from '@gooddata/sdk-model';
-import { IWebhookMetadataObjectDefinition } from '@gooddata/sdk-model';
+import { IWebhookDefinition } from '@gooddata/sdk-model';
+import { IWebhookDefinitionObject } from '@gooddata/sdk-model';
 import { IWhiteLabeling } from '@gooddata/sdk-model';
 import { IWidget } from '@gooddata/sdk-model';
 import { IWidgetAlert } from '@gooddata/sdk-model';
@@ -524,7 +527,7 @@ export declare interface IAnalyticalWorkspace {
     logicalModel(): IWorkspaceLogicalModelService;
     /**
      * Returns service that can be used to access GenAI services.
-     * @alpha
+     * @beta
      */
     genAI(): IGenAIService;
 }
@@ -2107,7 +2110,7 @@ export declare interface IForecastView {
 
 /**
  * GenAI-powered semantic search service.
- * @alpha
+ * @beta
  */
 export declare interface IGenAIService {
     /**
@@ -2563,34 +2566,80 @@ export declare interface IOrganization {
  * @alpha
  */
 export declare interface IOrganizationNotificationChannelService {
+    /**
+     * Get all notification channels
+     */
+    getAll(): Promise<INotificationChannelDefinitionObject[]>;
+    /**
+     * Delete channel
+     *
+     * @param id - id of the channel
+     * @returns Promise resolved when the channel is deleted.
+     */
+    deleteChannel(id: string): Promise<void>;
+    /**
+     * Get all emails
+     *
+     * @returns Promise resolved with array of emails.
+     * @throws In case of error.
+     */
+    getEmails(): Promise<ISmtpDefinitionObject[]>;
+    /**
+     * Get email by id
+     *
+     * @param id - id of the smtp
+     * @returns Promise resolved with smtp definition or undefined if not found.
+     */
+    getEmail(id: string): Promise<ISmtpDefinitionObject>;
+    /**
+     * Create new email
+     *
+     * @param smtp - definition of the smtp
+     * @returns Promise resolved with created smtp.
+     */
+    createEmail(smtp: ISmtpDefinition): Promise<ISmtpDefinitionObject>;
+    /**
+     * Update existing email
+     *
+     * @param smtp - definition of the smtp
+     * @returns Promise resolved when the smtp is updated.
+     */
+    updateEmail(smtp: ISmtpDefinitionObject): Promise<ISmtpDefinitionObject>;
+    /**
+     * Delete email
+     *
+     * @param id - id of the smtp
+     * @returns Promise resolved when the smtp is deleted.
+     */
+    deleteEmail(id: string): Promise<void>;
     /**
      * Get all webhooks
      *
      * @returns Promise resolved with array of webhooks.
      * @throws In case of error.
      */
-    getWebhooks(): Promise<IWebhookMetadataObject[]>;
+    getWebhooks(): Promise<IWebhookDefinitionObject[]>;
     /**
      * Get webhook by id
      *
      * @param id - id of the webhook
      * @returns Promise resolved with webhook definition or undefined if not found.
      */
-    getWebhook(id: string): Promise<IWebhookMetadataObject>;
+    getWebhook(id: string): Promise<IWebhookDefinitionObject>;
     /**
      * Create new webhook
      *
      * @param webhook - definition of the webhook
      * @returns Promise resolved with created webhook.
      */
-    createWebhook(webhook: IWebhookMetadataObjectDefinition): Promise<IWebhookMetadataObject>;
+    createWebhook(webhook: IWebhookDefinition): Promise<IWebhookDefinitionObject>;
     /**
      * Update existing webhook
      *
      * @param webhook - definition of the webhook
      * @returns Promise resolved when the webhook is updated.
      */
-    updateWebhook(webhook: IWebhookMetadataObject): Promise<IWebhookMetadataObject>;
+    updateWebhook(webhook: IWebhookDefinitionObject): Promise<IWebhookDefinitionObject>;
     /**
      * Delete webhook
      *
@@ -3333,7 +3382,7 @@ export declare function isElementsQueryOptionsElementsByValue(obj: unknown): obj
 
 /**
  * Semantic search query.
- * @alpha
+ * @beta
  */
 export declare interface ISemanticSearchQuery {
     /**
@@ -3362,7 +3411,7 @@ export declare interface ISemanticSearchQuery {
 
 /**
  * A single search result returned by semantic search.
- * @alpha
+ * @beta
  */
 export declare interface ISemanticSearchResult {
     results: ISemanticSearchResultItem[];
@@ -4654,6 +4703,31 @@ export declare interface IWorkspaceSettingsService {
      * @returns promise
      */
     setLocale(locale: string): Promise<void>;
+    /**
+     * Sets timezone for current workspace.
+     *
+     * @param timezone - the value based on IANA time zone database naming convention.
+     * for example: "America/Los_Angeles", etc.
+     *
+     * @returns promise
+     */
+    setTimezone(timezone: string): Promise<void>;
+    /**
+     * Sets date format for current workspace.
+     *
+     * @param dateFormat - the format based on the ICU standard, for example: "en-US", "cs-CZ", etc.
+     *
+     * @returns promise
+     */
+    setDateFormat(dateFormat: string): Promise<void>;
+    /**
+     * Sets first day of week for current workspace.
+     *
+     * @param weekStart - "Sunday | "Monday"
+     *
+     * @returns promise
+     */
+    setWeekStart(weekStart: string): Promise<void>;
     /**
      * Sets color palette for current workspace.
      *

package/esm/workspace/genAI/index.d.ts

@@ -1,7 +1,7 @@
 import { GenAISemanticSearchType, ISemanticSearchRelationship, ISemanticSearchResultItem } from "@gooddata/sdk-model";
 /**
  * GenAI-powered semantic search service.
- * @alpha
+ * @beta
  */
 export interface IGenAIService {
     /**
@@ -15,7 +15,7 @@ export interface IGenAIService {
 }
 /**
  * Semantic search query.
- * @alpha
+ * @beta
  */
 export interface ISemanticSearchQuery {
     /**
@@ -43,7 +43,7 @@ export interface ISemanticSearchQuery {
 }
 /**
  * A single search result returned by semantic search.
- * @alpha
+ * @beta
  */
 export interface ISemanticSearchResult {
     results: ISemanticSearchResultItem[];

package/esm/workspace/index.d.ts

@@ -139,7 +139,7 @@ export interface IAnalyticalWorkspace {
     logicalModel(): IWorkspaceLogicalModelService;
     /**
      * Returns service that can be used to access GenAI services.
-     * @alpha
+     * @beta
      */
     genAI(): IGenAIService;
 }

package/esm/workspace/settings/index.d.ts

@@ -25,6 +25,31 @@ export interface IWorkspaceSettingsService {
      * @returns promise
      */
     setLocale(locale: string): Promise<void>;
+    /**
+     * Sets timezone for current workspace.
+     *
+     * @param timezone - the value based on IANA time zone database naming convention.
+     * for example: "America/Los_Angeles", etc.
+     *
+     * @returns promise
+     */
+    setTimezone(timezone: string): Promise<void>;
+    /**
+     * Sets date format for current workspace.
+     *
+     * @param dateFormat - the format based on the ICU standard, for example: "en-US", "cs-CZ", etc.
+     *
+     * @returns promise
+     */
+    setDateFormat(dateFormat: string): Promise<void>;
+    /**
+     * Sets first day of week for current workspace.
+     *
+     * @param weekStart - "Sunday | "Monday"
+     *
+     * @returns promise
+     */
+    setWeekStart(weekStart: string): Promise<void>;
     /**
      * Sets color palette for current workspace.
      *

package/esm/workspace/settings/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/settings/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEtF;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE3C;;;;OAIG;IACH,yBAAyB,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE7D;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/settings/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEtF;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE3C;;;;OAIG;IACH,yBAAyB,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE7D;;;;;;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,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-backend-spi",
-  "version": "10.9.0-alpha.9",
+  "version": "10.10.0-alpha.0",
   "author": "GoodData",
   "description": "GoodData Backend SPI abstraction interfaces",
   "repository": {
@@ -24,7 +24,7 @@
     "lodash": "^4.17.21",
     "ts-invariant": "^0.7.5",
     "tslib": "^2.5.0",
-    "@gooddata/sdk-model": "10.9.0-alpha.9"
+    "@gooddata/sdk-model": "10.10.0-alpha.0"
   },
   "devDependencies": {
     "@gooddata/eslint-config": "^4.1.0",