@gooddata/api-client-tiger 11.42.0 → 11.43.0-alpha.1

package/esm/generated/ai-json-api/api.d.ts

@@ -61,64 +61,87 @@ export interface AiAgentListItemResponse {
 export interface AiAgentListResponse {
     'agents': Array<AiAgentListItemResponse>;
 }
-export interface AiAlertProposal {
-    [key: string]: any;
+export interface AiAlertDatasetIdentifier {
     /**
-     * Alert title.
+     * Date dataset identifier.
      */
-    'title': string;
+    'id': string;
     /**
-     * Metric identifier to monitor.
+     * Dataset object type.
      */
-    'metricId': string;
+    'type'?: AiAlertDatasetIdentifierTypeEnum;
+}
+export type AiAlertDatasetIdentifierTypeEnum = 'dataset';
+export interface AiAlertDatasetRef {
     /**
-     * Alert condition operator.
+     * Date dataset identifier.
      */
-    'operator': string;
+    'identifier': AiAlertDatasetIdentifier;
+    'title'?: string | null;
+}
+/**
+ * The alert itself (mirrors canonical AutomationAlert).
+ */
+export interface AiAlertDefinition {
     /**
-     * Notification channel identifier.
+     * Execution (AFM) definition of the alert.
      */
-    'notificationChannelId': string;
-    'description'?: AiDescription;
-    'automationId'?: AiAutomationid;
-    'metricTitle'?: AiMetrictitle;
-    'metricFormat'?: AiMetricformat;
-    'threshold'?: AiThreshold;
-    'fromValue'?: AiFromvalue;
-    'toValue'?: AiTovalue;
-    'compareMetricId'?: AiComparemetricid;
-    'compareMetricTitle'?: AiComparemetrictitle;
-    'compareMetricFormat'?: AiComparemetricformat;
-    'arithmeticOperator'?: AiArithmeticoperator;
-    'granularity'?: AiGranularity;
-    'dateDatasetId'?: AiDatedatasetid;
-    'dateDatasetTitle'?: AiDatedatasettitle;
-    'sensitivity'?: AiSensitivity;
+    'execution': AiAlertExecution;
+    'condition': AiCondition;
     /**
-     * Alert execution filters.
+     * Trigger behavior.
      */
-    'filters': Array<object>;
+    'trigger'?: AiAlertTrigger;
+    'interval'?: AiIntervalGranularity | null;
+}
+/**
+ * Execution definition (AFM) of the alert.  ``measures`` / ``attributes`` / ``filters`` are opaque AFM wire objects (same treatment as ``KeyDriverAnalysis.filters``); the semantic typing the FE renders lives on the typed ``condition`` union.
+ */
+export interface AiAlertExecution {
+    [key: string]: any;
+    /**
+     * Metrics computed by the alert (1-2).
+     */
+    'measures'?: Array<object>;
     /**
      * Attribute slicing configuration.
      */
-    'attributes': Array<object>;
-    'forMode'?: AiFormode;
-    'forLabel'?: AiForlabel;
-    'notificationChannelName'?: AiNotificationchannelname;
+    'attributes'?: Array<object>;
+    /**
+     * Alert execution filters.
+     */
+    'filters'?: Array<object>;
+}
+/**
+ * Structured pre-creation alert proposal — the single model used as the HTTP DTO, the persisted shape, and the in-memory conversation-state object.
+ */
+export interface AiAlertProposal {
+    /**
+     * Alert title.
+     */
+    'title': string;
+    /**
+     * The alert definition (condition, execution, trigger).
+     */
+    'alert': AiAlertDefinition;
+    /**
+     * Notification channel for delivery.
+     */
+    'notificationChannel': AiNotificationChannelRef;
+    'description'?: string | null;
+    'automationId'?: string | null;
     /**
      * Recipients shown in the proposal.
      */
-    'recipients': Array<AiAlertRecipient>;
-    'trigger'?: AiTrigger;
-    'triggerInterval'?: AiTriggerinterval;
-    'cron'?: AiCron;
-    'timezone'?: AiTimezone;
-    'dashboardId'?: AiDashboardid;
-    'dashboardTitle'?: AiDashboardtitle;
+    'recipients'?: Array<AiAlertRecipient>;
+    'schedule'?: AiAlertSchedule | null;
+    'dashboard'?: AiDashboardRef | null;
+    'forMode'?: string | null;
+    'forLabel'?: string | null;
     /**
      * Confirmation call to action.
      */
-    'cta': string;
+    'cta'?: string;
 }
 export interface AiAlertProposalPart {
     /**
@@ -136,6 +159,19 @@ export interface AiAlertRecipient {
     'id'?: string | null;
     'email'?: string | null;
 }
+export interface AiAlertSchedule {
+    'cron'?: string | null;
+    'timezone'?: string | null;
+}
+/**
+ * Trigger behavior for the alert.
+ */
+export declare const AiAlertTrigger: {
+    readonly ALWAYS: "ALWAYS";
+    readonly ONCE: "ONCE";
+    readonly ONCE_PER_INTERVAL: "ONCE_PER_INTERVAL";
+};
+export type AiAlertTrigger = typeof AiAlertTrigger[keyof typeof AiAlertTrigger];
 export interface AiAllTimeDateFilterBodyInput {
     'dataset': AiAfmObjectIdentifier;
     'granularity'?: AiDateGranularityInput | null;
@@ -161,6 +197,39 @@ export interface AiAllowedRelationshipType {
     'targetType': string;
     'allowOrphans'?: boolean;
 }
+export interface AiAnomalyCondition {
+    /**
+     * Anomaly detection condition.
+     */
+    'anomaly': AiAnomalyDetection;
+}
+export interface AiAnomalyDetection {
+    /**
+     * Metric analyzed for anomalies.
+     */
+    'measure': AiMetricOperand;
+    'sensitivity': AiSensitivity;
+    /**
+     * Time-based granularity of the analysis.
+     */
+    'granularity': AiAnomalyDetectionGranularity;
+    /**
+     * Date dataset used for anomaly detection.
+     */
+    'dataset': AiAlertDatasetRef;
+}
+/**
+ * Time-based granularity supported by anomaly detection.
+ */
+export declare const AiAnomalyDetectionGranularity: {
+    readonly HOUR: "HOUR";
+    readonly DAY: "DAY";
+    readonly WEEK: "WEEK";
+    readonly MONTH: "MONTH";
+    readonly QUARTER: "QUARTER";
+    readonly YEAR: "YEAR";
+};
+export type AiAnomalyDetectionGranularity = typeof AiAnomalyDetectionGranularity[keyof typeof AiAnomalyDetectionGranularity];
 export declare const AiAppApplicationDtosAfmFilterDefinitionDateGranularity: {
     readonly MINUTE: "MINUTE";
     readonly HOUR: "HOUR";
@@ -205,11 +274,28 @@ export interface AiAppDomainConversationsVisualizationRankingFilter {
     'bottom'?: number;
 }
 export type AiAppDomainConversationsVisualizationRankingFilterTypeEnum = 'ranking_filter';
+export interface AiArithmeticMeasure {
+    /**
+     * Arithmetic operator between the two metrics.
+     */
+    'operator': AiArithmeticOperator;
+    /**
+     * First metric.
+     */
+    'left': AiMetricOperand;
+    /**
+     * Second metric.
+     */
+    'right': AiMetricOperand;
+}
 /**
- * Relative alert arithmetic operator.
+ * Arithmetic operator between two metrics of a relative condition.
  */
-export interface AiArithmeticoperator {
-}
+export declare const AiArithmeticOperator: {
+    readonly DIFFERENCE: "DIFFERENCE";
+    readonly CHANGE: "CHANGE";
+};
+export type AiArithmeticOperator = typeof AiArithmeticOperator[keyof typeof AiArithmeticOperator];
 export interface AiAttributeFilter {
     'type': AiAttributeFilterTypeEnum;
     'using': string;
@@ -232,11 +318,6 @@ export interface AiAttributeSortItem {
 export type AiAttributeSortItemTypeEnum = 'attribute_sort';
 export type AiAttributeSortItemDirectionEnum = 'ASC' | 'DESC';
 export type AiAttributeSortItemAggregationEnum = 'SUM';
-/**
- * Automation identifier proposed for creation.
- */
-export interface AiAutomationid {
-}
 export interface AiBoundedFilterInput {
     'granularity': AiDateGranularityInput;
     'from'?: number | null;
@@ -252,21 +333,35 @@ export interface AiBucketRefObject {
 }
 export interface AiClusteringAmount {
 }
-/**
- * Comparison metric display format.
- */
-export interface AiComparemetricformat {
+export interface AiComparison {
+    /**
+     * Comparison operator.
+     */
+    'operator': AiComparisonConditionOperator;
+    /**
+     * Metric being compared.
+     */
+    'left': AiMetricOperand;
+    'right': AiRight;
 }
-/**
- * Comparison metric identifier.
- */
-export interface AiComparemetricid {
+export interface AiComparisonCondition {
+    /**
+     * Scalar comparison condition.
+     */
+    'comparison': AiComparison;
 }
 /**
- * Comparison metric display title.
+ * Operator of a scalar comparison condition.
  */
-export interface AiComparemetrictitle {
-}
+export declare const AiComparisonConditionOperator: {
+    readonly GREATER_THAN: "GREATER_THAN";
+    readonly GREATER_THAN_OR_EQUAL_TO: "GREATER_THAN_OR_EQUAL_TO";
+    readonly LESS_THAN: "LESS_THAN";
+    readonly LESS_THAN_OR_EQUAL_TO: "LESS_THAN_OR_EQUAL_TO";
+    readonly EQUAL_TO: "EQUAL_TO";
+    readonly NOT_EQUAL_TO: "NOT_EQUAL_TO";
+};
+export type AiComparisonConditionOperator = typeof AiComparisonConditionOperator[keyof typeof AiComparisonConditionOperator];
 export interface AiComparisonMeasureValueFilter {
     'comparisonMeasureValueFilter': AiComparisonMeasureValueFilterBody;
 }
@@ -307,6 +402,11 @@ export interface AiCompoundMeasureValueFilterBodyConditionsInner {
     'comparison': AiMeasureValueComparisonInner;
     'range': AiMeasureValueRangeInner;
 }
+/**
+ * @type AiCondition
+ * Alert trigger condition.
+ */
+export type AiCondition = AiAnomalyCondition | AiComparisonCondition | AiRangeCondition | AiRelativeCondition;
 /**
  * @type AiContent
  * Conversation item content payload.
@@ -465,20 +565,12 @@ export interface AiConversationUpdateRequest {
 export interface AiCreateConversationRequest {
     'agentId'?: string | null;
 }
-/**
- * Optional cron schedule.
- */
-export interface AiCron {
-}
-/**
- * Bound dashboard identifier.
- */
-export interface AiDashboardid {
-}
-/**
- * Bound dashboard display title.
- */
-export interface AiDashboardtitle {
+export interface AiDashboardRef {
+    /**
+     * Bound dashboard identifier.
+     */
+    'id': string;
+    'title'?: string | null;
 }
 export interface AiDateFilterAbsolute {
     'type': AiDateFilterAbsoluteTypeEnum;
@@ -535,16 +627,6 @@ export declare const AiDateGranularityInput: {
     readonly FISCAL_YEAR: "FISCAL_YEAR";
 };
 export type AiDateGranularityInput = typeof AiDateGranularityInput[keyof typeof AiDateGranularityInput];
-/**
- * Anomaly date dataset identifier.
- */
-export interface AiDatedatasetid {
-}
-/**
- * Anomaly date dataset display title.
- */
-export interface AiDatedatasettitle {
-}
 /**
  * Response for DELETE /documents/{documentId}.
  */
@@ -552,11 +634,6 @@ export interface AiDeleteDocumentResponse {
     'success': boolean;
     'message': string;
 }
-/**
- * Alert description.
- */
-export interface AiDescription {
-}
 /**
  * Document metadata returned by GET /documents/{document_id} and list.
  */
@@ -614,23 +691,8 @@ export type AiFilterByValueTypeEnum = 'attribute_filter' | 'date_filter' | 'rank
 export type AiFilterByValueConditionEnum = 'contains' | 'doesNotContain' | 'startsWith' | 'doesNotStartWith' | 'endsWith' | 'doesNotEndWith';
 export interface AiForecastPeriod {
 }
-/**
- * Human-readable \'For\' summary.
- */
-export interface AiForlabel {
-}
-/**
- * Display mode for the monitored population.
- */
-export interface AiFormode {
-}
 export interface AiFrom {
 }
-/**
- * Range lower bound.
- */
-export interface AiFromvalue {
-}
 export interface AiFunctionCallContent {
     [key: string]: any;
     /**
@@ -669,11 +731,6 @@ export interface AiFunctionResultContent {
     'result': string;
 }
 export type AiFunctionResultContentTypeEnum = 'toolResult';
-/**
- * Anomaly granularity.
- */
-export interface AiGranularity {
-}
 export interface AiHTTPValidationError {
     'detail'?: Array<AiValidationError>;
 }
@@ -685,6 +742,17 @@ export interface AiInlineFilterDefinitionBody {
     'applyOnResult'?: boolean | null;
     'localIdentifier'?: string | null;
 }
+/**
+ * Date granularity for the interval of an ONCE_PER_INTERVAL trigger.
+ */
+export declare const AiIntervalGranularity: {
+    readonly DAY: "DAY";
+    readonly WEEK: "WEEK";
+    readonly MONTH: "MONTH";
+    readonly QUARTER: "QUARTER";
+    readonly YEAR: "YEAR";
+};
+export type AiIntervalGranularity = typeof AiIntervalGranularity[keyof typeof AiIntervalGranularity];
 export interface AiKeyDriverAnalysis {
     [key: string]: any;
     /**
@@ -784,6 +852,17 @@ export interface AiMeasureValueRangeInner {
     'from': number;
     'to': number;
 }
+/**
+ * Reference to a metric by AFM local identifier.
+ */
+export interface AiMetricOperand {
+    /**
+     * Local identifier of the metric to be compared.
+     */
+    'localIdentifier': string;
+    'format'?: string | null;
+    'title'?: string | null;
+}
 export interface AiMetricSortItem {
     'type': AiMetricSortItemTypeEnum;
     'direction': AiMetricSortItemDirectionEnum;
@@ -821,16 +900,6 @@ export declare const AiMetricValueFilterConditionRange: {
     readonly NOT_BETWEEN: "NOT_BETWEEN";
 };
 export type AiMetricValueFilterConditionRange = typeof AiMetricValueFilterConditionRange[keyof typeof AiMetricValueFilterConditionRange];
-/**
- * Metric display format.
- */
-export interface AiMetricformat {
-}
-/**
- * Metric display title.
- */
-export interface AiMetrictitle {
-}
 export interface AiMultipartContent {
     /**
      * Type of item content.
@@ -869,10 +938,12 @@ export interface AiNegativeAttributeFilterBody {
     'localIdentifier'?: string | null;
     'usesArbitraryValues'?: boolean | null;
 }
-/**
- * Notification channel display name.
- */
-export interface AiNotificationchannelname {
+export interface AiNotificationChannelRef {
+    /**
+     * Notification channel identifier.
+     */
+    'id': string;
+    'name'?: string | null;
 }
 export declare const AiObjectType: {
     readonly UNIDENTIFIED: "unidentified";
@@ -953,6 +1024,38 @@ export interface AiQuerySortByInner {
 export type AiQuerySortByInnerTypeEnum = 'attribute_sort' | 'metric_sort';
 export type AiQuerySortByInnerDirectionEnum = 'ASC' | 'DESC';
 export type AiQuerySortByInnerAggregationEnum = 'SUM';
+export interface AiRange {
+    /**
+     * Range operator.
+     */
+    'operator': AiRangeConditionOperator;
+    /**
+     * Metric being compared.
+     */
+    'measure': AiMetricOperand;
+    /**
+     * Range lower bound.
+     */
+    'from': AiValueOperand;
+    /**
+     * Range upper bound.
+     */
+    'to': AiValueOperand;
+}
+export interface AiRangeCondition {
+    /**
+     * Range condition.
+     */
+    'range': AiRange;
+}
+/**
+ * Operator of a range condition.
+ */
+export declare const AiRangeConditionOperator: {
+    readonly BETWEEN: "BETWEEN";
+    readonly NOT_BETWEEN: "NOT_BETWEEN";
+};
+export type AiRangeConditionOperator = typeof AiRangeConditionOperator[keyof typeof AiRangeConditionOperator];
 export interface AiRangeMeasureValueFilter {
     'rangeMeasureValueFilter': AiRangeMeasureValueFilterBody;
 }
@@ -998,6 +1101,35 @@ export interface AiReasoningContent {
     'summary': string;
 }
 export type AiReasoningContentTypeEnum = 'reasoning';
+export interface AiRelative {
+    /**
+     * Relative condition operator.
+     */
+    'operator': AiRelativeConditionOperator;
+    /**
+     * Arithmetic combination of the two metrics.
+     */
+    'measure': AiArithmeticMeasure;
+    /**
+     * Threshold the relative change is compared to.
+     */
+    'threshold': AiValueOperand;
+}
+export interface AiRelativeCondition {
+    /**
+     * Relative (metric-to-metric) condition.
+     */
+    'relative': AiRelative;
+}
+/**
+ * Operator of a relative (metric-to-metric) condition.
+ */
+export declare const AiRelativeConditionOperator: {
+    readonly INCREASES_BY: "INCREASES_BY";
+    readonly DECREASES_BY: "DECREASES_BY";
+    readonly CHANGES_BY: "CHANGES_BY";
+};
+export type AiRelativeConditionOperator = typeof AiRelativeConditionOperator[keyof typeof AiRelativeConditionOperator];
 export interface AiRelativeDateFilterBodyInput {
     'dataset': AiAfmObjectIdentifier;
     'granularity': AiDateGranularityInput;
@@ -1032,6 +1164,11 @@ export type AiResponseFeedbackTypeEnum = 'POSITIVE' | 'NEGATIVE';
 export interface AiResponseFeedbackRequest {
     'feedback': AiResponseFeedback | null;
 }
+/**
+ * @type AiRight
+ * Value or metric the left side is compared to.
+ */
+export type AiRight = AiMetricOperand | AiValueOperand;
 /**
  * Response for GET /search.
  */
@@ -1167,13 +1304,19 @@ export interface AiSendMessageRequest {
 export interface AiSendMessageSearchOptions {
     'objectTypes'?: Array<AiObjectType> | null;
     'searchLimit'?: number | null;
+    'includeTags'?: Array<string> | null;
+    'excludeTags'?: Array<string> | null;
     'allowedRelationshipTypes'?: Array<AiAllowedRelationshipType> | null;
 }
 /**
- * Anomaly sensitivity.
+ * Sensitivity level for anomaly detection.
  */
-export interface AiSensitivity {
-}
+export declare const AiSensitivity: {
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+    readonly HIGH: "HIGH";
+};
+export type AiSensitivity = typeof AiSensitivity[keyof typeof AiSensitivity];
 /**
  * A single skill available to the organization.
  */
@@ -1281,33 +1424,8 @@ export interface AiTextPart {
     'text': string;
 }
 export type AiTextPartTypeEnum = 'text';
-/**
- * Comparison threshold.
- */
-export interface AiThreshold {
-}
-/**
- * Schedule timezone.
- */
-export interface AiTimezone {
-}
 export interface AiTo {
 }
-/**
- * Range upper bound.
- */
-export interface AiTovalue {
-}
-/**
- * Alert trigger behavior.
- */
-export interface AiTrigger {
-}
-/**
- * Trigger interval for once-per-interval alerts.
- */
-export interface AiTriggerinterval {
-}
 /**
  * Response for POST/PUT /documents.
  */
@@ -1388,8 +1506,19 @@ export interface AiValidationError {
 }
 export interface AiValidationErrorLocInner {
 }
+/**
+ * Value of the alert threshold to compare the metric to.
+ */
 export interface AiValue {
 }
+export interface AiValue1 {
+}
+/**
+ * Literal threshold value.
+ */
+export interface AiValueOperand {
+    'value': AiValue | null;
+}
 export interface AiVisualization {
     'type': AiVisualizationTypeEnum;
     'id': string;
@@ -1463,7 +1592,7 @@ export interface AiVisualizationMetricValueComparisonFilter {
     'type': AiVisualizationMetricValueComparisonFilterTypeEnum;
     'using': string;
     'condition': AiMetricValueFilterConditionComparison;
-    'value': AiValue;
+    'value': AiValue1;
     'nullValuesAsZero': boolean;
 }
 export type AiVisualizationMetricValueComparisonFilterTypeEnum = 'metric_value_filter';