@gooddata/sdk-model 10.17.0-alpha.2 → 10.17.0-alpha.20

package/esm/sdk-model.d.ts

@@ -38,6 +38,13 @@ export declare type AccessGranteeDetail = IUserAccess | IUserGroupAccess | IGran
  */
 export declare type AccessGranularPermission = "VIEW" | "EDIT" | "SHARE";
 
+/**
+ * Alert description status.
+ *
+ * @alpha
+ */
+export declare type AlertDescriptionStatus = "SUCCESS" | "ERROR" | "INTERNAL_ERROR" | "TIMEOUT";
+
 /**
  * Special granularity used to indicate there should be no date filtering for the given dimension.
  *
@@ -486,6 +493,13 @@ export declare function attributeShowAllValues(attribute: IAttribute): boolean |
  */
 export declare function attributeUri(attribute: IAttribute): string | undefined;
 
+/**
+ * Automation notification type.
+ *
+ * @alpha
+ */
+export declare type AutomationNotificationType = "automation-task.completed" | "automation-task.limit-exceeded";
+
 /**
  * Gets first attribute matching the provided predicate from the bucket.
  *
@@ -1779,6 +1793,139 @@ export declare interface IAlertDefault {
     defaultTimezone: string;
 }
 
+/**
+ * Alert description.
+ *
+ * @alpha
+ */
+export declare interface IAlertDescription {
+    /**
+     * Title of the metric.
+     */
+    metric: string;
+    /**
+     * Condition of the alert (in human readable form).
+     */
+    condition: string;
+    /**
+     * Current values that triggered the alert (if sliced by attribute).
+     */
+    currentValues?: IAlertEvaluationRow[];
+    /**
+     * Attribute of the alert (if sliced by attribute).
+     */
+    attribute?: string;
+    /**
+     * Filter count of the alert.
+     */
+    filterCount?: number;
+    /**
+     * Total values count that can trigger the alert.
+     */
+    totalValueCount?: number;
+    /**
+     * Count of values that triggered the alert.
+     */
+    triggeredCount?: number;
+    /**
+     * Threshold set to trigger the alert.
+     */
+    threshold?: number;
+    /**
+     * Threshold set to trigger the alert - formatted.
+     */
+    formattedThreshold?: string;
+    /**
+     * Lower threshold of the alert.
+     */
+    lowerThreshold?: number;
+    /**
+     * Upper threshold of the alert.
+     */
+    upperThreshold?: number;
+    /**
+     * Result of the execution that evaluated the alert.
+     */
+    status?: AlertDescriptionStatus;
+    /**
+     * Error message of the alert.
+     */
+    errorMessage?: string;
+    /**
+     * Trace ID of the alert.
+     */
+    traceId?: string;
+}
+
+/**
+ * Alert evaluation row.
+ *
+ * @alpha
+ */
+export declare interface IAlertEvaluationRow {
+    /**
+     * Primary metric value.
+     */
+    primaryMetric?: IAlertEvaluationRowMetric;
+    /**
+     * Secondary metric value.
+     */
+    secondaryMetric?: IAlertEvaluationRowMetric;
+    /**
+     * Computed metric value.
+     */
+    computedMetric?: IAlertEvaluationRowMetric;
+    /**
+     * Label element value (if sliced by attribute).
+     */
+    labelValue?: string;
+}
+
+/**
+ * Metric value.
+ *
+ * @alpha
+ */
+export declare interface IAlertEvaluationRowMetric {
+    /**
+     * Metric value.
+     */
+    value: number;
+    /**
+     * Metric value - formatted.
+     */
+    formattedValue?: string;
+}
+
+/**
+ * Notification with details about the alert that triggered it.
+ *
+ * @alpha
+ */
+export declare interface IAlertNotification extends INotificationBase {
+    notificationType: "alertNotification";
+    /**
+     * Identifier of the automation (alert / schedule) if the notification was created in an automation context.
+     */
+    automationId?: string;
+    /**
+     * Details of the automation that triggered the notification.
+     */
+    details: IAlertNotificationDetails;
+}
+
+/**
+ * Details of the alert notification.
+ *
+ * @alpha
+ */
+export declare interface IAlertNotificationDetails extends IAutomationNotificationDetailsBase {
+    /**
+     * Data from the webhook message.
+     */
+    data: IWebhookMessageDataAlert;
+}
+
 /**
  * @alpha
  */
@@ -2430,6 +2577,20 @@ export declare interface IAutomationAlertTrigger {
     state: IAlertTriggerState;
 }
 
+/**
+ * @alpha
+ */
+export declare interface IAutomationDetails {
+    /**
+     * Subject of the email.
+     */
+    subject?: string;
+    /**
+     * Message of the email.
+     */
+    message?: string;
+}
+
 /**
  * @alpha
  */
@@ -2461,22 +2622,12 @@ export declare interface IAutomationMetadataObjectBase {
     exportDefinitions?: IExportDefinitionMetadataObject[];
     /**
      * Recipients of the automation.
-     * Array of strings with user ids.
      */
     recipients?: IAutomationRecipient[];
     /**
      * Details of the automation.
      */
-    details?: {
-        /**
-         * Subject of the email.
-         */
-        subject?: string;
-        /**
-         * Message of the email.
-         */
-        message?: string;
-    };
+    details?: IAutomationDetails;
     /**
      * Dashboard that automation is related to.
      */
@@ -2498,6 +2649,22 @@ export declare interface IAutomationMetadataObjectDefinition extends Omit<IAutom
     exportDefinitions?: (IExportDefinitionMetadataObjectDefinition | IExportDefinitionMetadataObject)[];
 }
 
+/**
+ * Notification with details about the automation or test that triggered it.
+ *
+ * @alpha
+ */
+export declare interface IAutomationNotificationDetailsBase {
+    /**
+     * Timestamp when the notification was created.
+     */
+    timestamp: string;
+    /**
+     * Type of the notification.
+     */
+    webhookMessageType: AutomationNotificationType;
+}
+
 /**
  * @alpha
  */
@@ -3428,6 +3595,21 @@ export declare interface IDashboardLayout<TWidget = IDashboardWidget> {
      * Layout size.
      */
     size?: IDashboardLayoutSize;
+    /**
+     * Layout configuration.
+     *
+     * @alpha
+     */
+    configuration?: IDashboardLayoutConfiguration;
+}
+
+/**
+ * Layout configuration.
+ *
+ * @alpha
+ */
+export declare interface IDashboardLayoutConfiguration {
+    sections?: IDashboardLayoutSectionsConfiguration;
 }
 
 /**
@@ -3486,6 +3668,15 @@ export declare interface IDashboardLayoutSectionHeader {
     description?: string;
 }
 
+/**
+ * Configuration that affects all sections of the layout.
+ *
+ * @alpha
+ */
+export declare interface IDashboardLayoutSectionsConfiguration {
+    enableHeader: boolean;
+}
+
 /**
  * Dashboard layout size definition.
  *
@@ -4509,6 +4700,45 @@ export declare interface IExportOptions {
     mergeHeaders?: boolean;
 }
 
+/**
+ * Export result.
+ *
+ * @alpha
+ */
+export declare interface IExportResult {
+    /**
+     * File name.
+     */
+    fileName: string;
+    /**
+     * Export ID.
+     */
+    exportId: string;
+    /**
+     * Export status.
+     */
+    status: IExportResultStatus;
+    /**
+     * File URI.
+     */
+    fileUri?: string;
+    /**
+     * Error message.
+     */
+    errorMessage?: string;
+    /**
+     * Trace ID.
+     */
+    traceId?: string;
+}
+
+/**
+ * Export result status.
+ *
+ * @alpha
+ */
+export declare type IExportResultStatus = "SUCCESS" | "ERROR" | "INTERNAL_ERROR" | "TIMEOUT";
+
 /**
  * Fact metadata object
  *
@@ -4643,6 +4873,10 @@ export declare interface IGenAIChatInteraction {
      * User feedback for the assistant reply.
      */
     userFeedback?: GenAIChatInteractionUserFeedback;
+    /**
+     * An error message in case the interaction failed.
+     */
+    errorResponse?: string;
 }
 
 /**
@@ -5765,6 +5999,45 @@ export declare class InlineMeasureBuilder extends MeasureBuilderBase<IInlineMeas
  */
 export declare type InlineMeasureBuilderInput = string | IMeasure<IInlineMeasureDefinition>;
 
+/**
+ * Notification.
+ *
+ * @alpha
+ */
+export declare type INotification = IAlertNotification | IScheduleNotification | ITestNotification;
+
+/**
+ * Notification with details about the automation or test that triggered it.
+ *
+ * @alpha
+ */
+export declare interface INotificationBase {
+    /**
+     * Type of the object for type narrowing.
+     */
+    type: "notification";
+    /**
+     * Type of the notification.
+     */
+    notificationType: NotificationType;
+    /**
+     * Unique identifier of the notification.
+     */
+    id: string;
+    /**
+     * Identifier of the workspace if the notification was created in a workspace context.
+     */
+    workspaceId?: string;
+    /**
+     * Indicates whether the notification has been read.
+     */
+    isRead: boolean;
+    /**
+     * Timestamp when the notification was created.
+     */
+    createdAt: string;
+}
+
 /**
  * @beta
  */
@@ -7155,6 +7428,36 @@ export declare interface IScheduledMailBase {
 export declare interface IScheduledMailDefinition extends IScheduledMailBase, Partial<IDashboardObjectIdentity> {
 }
 
+/**
+ /**
+ * Notification with details about the schedule that triggered it.
+ *
+ * @alpha
+ */
+export declare interface IScheduleNotification extends INotificationBase {
+    notificationType: "scheduleNotification";
+    /**
+     * Identifier of the automation (alert / schedule) if the notification was created in an automation context.
+     */
+    automationId?: string;
+    /**
+     * Details of the automation that triggered the notification.
+     */
+    details: IScheduleNotificationDetails;
+}
+
+/**
+ * Details of the schedule notification.
+ *
+ * @alpha
+ */
+export declare interface IScheduleNotificationDetails extends IAutomationNotificationDetailsBase {
+    /**
+     * Data from the webhook message.
+     */
+    data: IWebhookMessageDataSchedule;
+}
+
 /**
  * Type-guard testing whether the provided object is an instance of {@link IColorDescriptor}.
  *
@@ -8664,6 +8967,31 @@ export declare interface ITempFilterContext {
     readonly uri: string;
 }
 
+/**
+ * Notification with details about the test that triggered it.
+ *
+ * @alpha
+ */
+export declare interface ITestNotification extends INotificationBase {
+    notificationType: "testNotification";
+    /**
+     * Details of the test that triggered the notification.
+     */
+    details: ITestNotificationDetails;
+}
+
+/**
+ * Notification with details about the automation or test that triggered it.
+ *
+ * @alpha
+ */
+export declare interface ITestNotificationDetails {
+    /**
+     * Message of the test notification.
+     */
+    message: string;
+}
+
 /**
  * Theme used to customize selected parts of the UI
  *
@@ -9720,6 +10048,26 @@ export declare interface IVisualizationSwitcherWidgetBase extends IAnalyticalWid
 export declare interface IVisualizationSwitcherWidgetDefinition extends IVisualizationSwitcherWidgetBase, Partial<IDashboardObjectIdentity> {
 }
 
+/**
+ * Automation information.
+ *
+ * @alpha
+ */
+export declare interface IWebhookAutomationInfo {
+    /**
+     * Identifier of the automation.
+     */
+    id: string;
+    /**
+     * Title of the automation.
+     */
+    title?: string;
+    /**
+     * URL of the dashboard, or custom dashboard URL (if configured on automation).
+     */
+    dashboardURL: string;
+}
+
 /**
  * @beta
  */
@@ -9738,6 +10086,57 @@ export declare interface IWebhookDestinationConfiguration {
     hasToken?: boolean;
 }
 
+/**
+ * Data from the webhook message.
+ *
+ * @alpha
+ */
+export declare interface IWebhookMessageDataAlert extends IWebhookMessageDataBase {
+    /**
+     * Alert description.
+     */
+    alert: IAlertDescription;
+}
+
+/**
+ * Data from the webhook message.
+ *
+ * @alpha
+ */
+export declare interface IWebhookMessageDataBase {
+    /**
+     * Automation information.
+     */
+    automation: IWebhookAutomationInfo;
+    /**
+     * Recipients of the webhook message.
+     */
+    recipients?: WebhookRecipient[];
+    /**
+     * Automation details.
+     */
+    details?: IAutomationDetails;
+    /**
+     * Remaining export/alert evaluation count
+     */
+    remainingActionCount?: number;
+    /**
+     * Tabular export results
+     */
+    tabularExports?: IExportResult[];
+    /**
+     * Visual export results
+     */
+    visualExports?: IExportResult[];
+}
+
+/**
+ * Data from the webhook message.
+ *
+ * @alpha
+ */
+export declare type IWebhookMessageDataSchedule = IWebhookMessageDataBase;
+
 /**
  * Metadata object for webhook notification channel.
  *
@@ -9956,6 +10355,7 @@ export declare interface IWorkspaceDataFilterSetting {
     ref: ObjRef;
     title?: string;
     filterValues: string[];
+    isInherited: boolean;
 }
 
 /**
@@ -11145,6 +11545,13 @@ export declare type NotificationChannelAllowedRecipients = "creator" | "internal
  */
 export declare type NotificationChannelDestinationType = "webhook" | "smtp" | "inPlatform";
 
+/**
+ * Type of the notification.
+ *
+ * @alpha
+ */
+export declare type NotificationType = "alertNotification" | "scheduleNotification" | "testNotification";
+
 /**
  * Metadata object types
  *
@@ -11563,6 +11970,22 @@ export declare type VisualizationProperties = {
     [key: string]: any;
 };
 
+/**
+ * Webhook recipient.
+ *
+ * @alpha
+ */
+export declare type WebhookRecipient = {
+    /**
+     * Identifier of the recipient.
+     */
+    id: string;
+    /**
+     * Email of the recipient.
+     */
+    email: string;
+};
+
 /**
  * Week start day
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-model",
-  "version": "10.17.0-alpha.2",
+  "version": "10.17.0-alpha.20",
   "author": "GoodData",
   "description": "GoodData Model definitions used by UI components and Backend SPI and its implementations",
   "repository": {

package/esm/exportDefinitions/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/exportDefinitions/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AACtF,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,kCAAkC;IAC/C,WAAW,EAAE,UAAU,GAAG,WAAW,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,4CAA4C;IACzD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,2CAA2C;IACxD,mBAAmB,EAAE,UAAU,CAAC;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCAAiC;IAC9C,SAAS,EAAE,UAAU,CAAC;IACtB,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACnD,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,KAAK,CAAC;IACd,QAAQ,CAAC,EAAE,kCAAkC,CAAC;IAC9C,OAAO,EAAE,iCAAiC,CAAC;CAC9C,CAAC;AAEF;;;GAGG;AACH,wBAAgB,yCAAyC,CACrD,GAAG,EAAE,OAAO,GACb,GAAG,IAAI,wCAAwC,CAEjD;AAED;;;;GAIG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC7D,IAAI,EAAE,qBAAqB,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;IACxC,QAAQ,CAAC,EAAE,4CAA4C,CAAC;IACxD,OAAO,EAAE,2CAA2C,CAAC;CACxD,CAAC;AAEF;;;GAGG;AACH,wBAAgB,mDAAmD,CAC/D,GAAG,EAAE,OAAO,GACb,GAAG,IAAI,kDAAkD,CAK3D;AAED;;;;GAIG;AACH,MAAM,MAAM,+BAA+B,GACrC,wCAAwC,GACxC,kDAAkD,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IAClC,cAAc,EAAE,+BAA+B,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAAgC,SAAQ,qBAAqB,EAAE,eAAe,EAAE,UAAU;IACvG,IAAI,EAAE,kBAAkB,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,yCACb,SAAQ,qBAAqB,EACzB,yBAAyB;IAC7B,IAAI,EAAE,kBAAkB,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,gBAAgB,EAAE,+BAA+B,GAAG,MAAM,CAI/F;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACnC,gBAAgB,EAAE,+BAA+B,GAClD,MAAM,GAAG,SAAS,CAIpB;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACnC,gBAAgB,EAAE,+BAA+B,GAClD,MAAM,GAAG,SAAS,CAIpB"}

package/esm/exportDefinitions/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/exportDefinitions/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAKzC,OAAO,OAAO,MAAM,mBAAmB,CAAC;AAiExC;;;GAGG;AACH,MAAM,UAAU,yCAAyC,CACrD,GAAY;IAEZ,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAK,GAAgD,CAAC,IAAI,KAAK,WAAW,CAAC;AACnG,CAAC;AAeD;;;GAGG;AACH,MAAM,UAAU,mDAAmD,CAC/D,GAAY;IAEZ,OAAO,CACH,CAAC,OAAO,CAAC,GAAG,CAAC;QACZ,GAA0D,CAAC,IAAI,KAAK,qBAAqB,CAC7F,CAAC;AACN,CAAC;AAyCD;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAAC,gBAAiD;IACnF,SAAS,CAAC,gBAAgB,EAAE,uDAAuD,CAAC,CAAC;IAErF,OAAO,gBAAgB,CAAC,KAAK,CAAC;AAClC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CACnC,gBAAiD;IAEjD,SAAS,CAAC,gBAAgB,EAAE,qCAAqC,CAAC,CAAC;IAEnE,OAAO,gBAAgB,CAAC,OAAO,CAAC;AACpC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CACnC,gBAAiD;IAEjD,SAAS,CAAC,gBAAgB,EAAE,qCAAqC,CAAC,CAAC;IAEnE,OAAO,gBAAgB,CAAC,OAAO,CAAC;AACpC,CAAC"}