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

package/esm/notifications/index.d.ts

@@ -0,0 +1,334 @@
+import { IExportResult } from "../exports/index.js";
+import { IAutomationDetails } from "../automations/index.js";
+/**
+ * Type of the notification.
+ *
+ * @alpha
+ */
+export type NotificationType = "alertNotification" | "scheduleNotification" | "testNotification";
+/**
+ * Notification with details about the automation or test that triggered it.
+ *
+ * @alpha
+ */
+export 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;
+}
+/**
+ * Notification with details about the alert that triggered it.
+ *
+ * @alpha
+ */
+export 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;
+}
+/**
+/**
+ * Notification with details about the schedule that triggered it.
+ *
+ * @alpha
+ */
+export 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;
+}
+/**
+ * Notification with details about the test that triggered it.
+ *
+ * @alpha
+ */
+export 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 interface ITestNotificationDetails {
+    /**
+     * Message of the test notification.
+     */
+    message: string;
+}
+/**
+ * Notification with details about the automation or test that triggered it.
+ *
+ * @alpha
+ */
+export interface IAutomationNotificationDetailsBase {
+    /**
+     * Timestamp when the notification was created.
+     */
+    timestamp: string;
+    /**
+     * Type of the notification.
+     */
+    webhookMessageType: AutomationNotificationType;
+}
+/**
+ * Details of the alert notification.
+ *
+ * @alpha
+ */
+export interface IAlertNotificationDetails extends IAutomationNotificationDetailsBase {
+    /**
+     * Data from the webhook message.
+     */
+    data: IWebhookMessageDataAlert;
+}
+/**
+ * Details of the schedule notification.
+ *
+ * @alpha
+ */
+export interface IScheduleNotificationDetails extends IAutomationNotificationDetailsBase {
+    /**
+     * Data from the webhook message.
+     */
+    data: IWebhookMessageDataSchedule;
+}
+/**
+ * Automation notification type.
+ *
+ * @alpha
+ */
+export type AutomationNotificationType = "automation-task.completed" | "automation-task.limit-exceeded";
+/**
+ * Data from the webhook message.
+ *
+ * @alpha
+ */
+export 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 interface IWebhookMessageDataAlert extends IWebhookMessageDataBase {
+    /**
+     * Alert description.
+     */
+    alert: IAlertDescription;
+}
+/**
+ * Data from the webhook message.
+ *
+ * @alpha
+ */
+export type IWebhookMessageDataSchedule = IWebhookMessageDataBase;
+/**
+ * Automation information.
+ *
+ * @alpha
+ */
+export 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;
+}
+/**
+ * Alert description.
+ *
+ * @alpha
+ */
+export 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 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 interface IAlertEvaluationRowMetric {
+    /**
+     * Metric value.
+     */
+    value: number;
+    /**
+     * Metric value - formatted.
+     */
+    formattedValue?: string;
+}
+/**
+ * Webhook recipient.
+ *
+ * @alpha
+ */
+export type WebhookRecipient = {
+    /**
+     * Identifier of the recipient.
+     */
+    id: string;
+    /**
+     * Email of the recipient.
+     */
+    email: string;
+};
+/**
+ * Alert description status.
+ *
+ * @alpha
+ */
+export type AlertDescriptionStatus = "SUCCESS" | "ERROR" | "INTERNAL_ERROR" | "TIMEOUT";
+/**
+ * Notification.
+ *
+ * @alpha
+ */
+export type INotification = IAlertNotification | IScheduleNotification | ITestNotification;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/notifications/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG,sBAAsB,GAAG,kBAAkB,CAAC;AAEjG;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IACzD,gBAAgB,EAAE,mBAAmB,CAAC;IAEtC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,yBAAyB,CAAC;CACtC;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC5D,gBAAgB,EAAE,sBAAsB,CAAC;IAEzC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,4BAA4B,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IACxD,gBAAgB,EAAE,kBAAkB,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAkC;IAC/C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,EAAE,0BAA0B,CAAC;CAClD;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,kCAAkC;IACjF;;OAEG;IACH,IAAI,EAAE,wBAAwB,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA6B,SAAQ,kCAAkC;IACpF;;OAEG;IACH,IAAI,EAAE,2BAA2B,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,2BAA2B,GAAG,gCAAgC,CAAC;AAExG;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,EAAE,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;IACrE;;OAEG;IACH,KAAK,EAAE,iBAAiB,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,uBAAuB,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAE1C;;OAEG;IACH,eAAe,CAAC,EAAE,yBAAyB,CAAC;IAE5C;;OAEG;IACH,cAAc,CAAC,EAAE,yBAAyB,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,OAAO,GAAG,gBAAgB,GAAG,SAAS,CAAC;AAExF;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,kBAAkB,GAAG,qBAAqB,GAAG,iBAAiB,CAAC"}

package/esm/notifications/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/esm/notifications/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/notifications/index.ts"],"names":[],"mappings":""}