@salesforce/lds-adapters-analytics-unifiedanalytics 1.429.0 → 1.431.0

package/src/raml/api.raml

@@ -1147,6 +1147,79 @@ types:
       nextPageUrl:
         description: Next page url for pagination.
         type: string | nil
+
+  DataAlertQueryCollectionRepresentation:
+    description: A collection of unified analytics data alerts that match the query.
+    type: object
+    properties:
+      dataAlerts:
+        description: List of data alerts being returned.
+        type: array
+        items:
+          type: DataAlertRepresentation
+
+  DataAlertQueryInputRepresentation:
+    description: Abstract input representation for complex queries with computed properties and filtering
+    type: object
+    properties:
+      ownerId:
+        description: User ID to filter alerts
+        type: string
+        required: true
+      assetId:
+        description: Filter by metric/asset ID
+        type: string
+        required: false
+      timeRange:
+        required: false
+        description: Filter alerts by time range context
+        type: UnifiedFilterInputRepresentation # TODO Hand-rolled @W-21386585
+      includeProperties:
+        required: false
+        type: array
+        items:
+          type: string
+          enum:
+            - ConditionCategory
+      propertyFilters:
+        required: false
+        type: array
+        description: Structured filter for computed properties
+        items:
+          type: DataAlertPropertyFilterInputRepresentation # TODO Hand-rolled @W-21386585
+  DataAlertPropertyFilterInputRepresentation:
+    description: Filter by computed property values. Automatically computes filtered properties (no need to specify in includeProperties)
+    type: object
+    properties:
+      property:
+        description: Property description
+        type: string
+        enum:
+          - ConditionCategory
+      values:
+        description: Values matching the property
+        type: array
+        items:
+          type: string
+          enum:
+            - PeriodOverPeriodChange
+            - UnusualChange
+            - Goal
+            - Threshold
+            - Custom
+  DataAlertPropertyFilterOutputRepresentation:
+    description: Property Filter Output Representation
+    type: object
+    properties:
+      conditionCategory:
+        description: Computed Properties to Include
+        type: string
+        enum:
+          - PeriodOverPeriodChange
+          - UnusualChange
+          - Goal
+          - Threshold
+          - Custom
   DataAlertValueInputRepresentation:
     description: Abstract input representation for operands
     type: object
@@ -1622,6 +1695,7 @@ types:
           - Email
           - Notification
           - Slack
+
   DataAlertRepresentation:
     description: Output representation for Data Alert
     discriminatorValue: DataAlert
@@ -1662,6 +1736,9 @@ types:
         description: ID of the associated BotDefinition agent.
         type: string | nil
         required: false
+      properties?: #Field may be absent
+        description: Additional properties for the data alert used when sending the query response.
+        type: DataAlertPropertyFilterOutputRepresentation
   DataAlertScheduleRepresentation:
     description: Represents the schedule for a data alert
     type: object
@@ -3308,6 +3385,20 @@ types:
         application/json:
           type: DataAlertInputRepresentation
           (oas-body-name): dataAlert
+  /dataAlerts/query:
+    post:
+      displayName: postDataAlertQuery
+      description: Create a new data alert query.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataAlertQueryCollectionRepresentation
+      body:
+        application/json:
+          type: DataAlertQueryInputRepresentation
+          (oas-body-name): dataAlertQuery
   /dataAlerts/{dataAlertId}:
     get: #This is a mocked path only.
       displayName: getDataAlertCollection
@@ -3360,6 +3451,7 @@ types:
       dataAlertId:
         type: string
         required: true
+
   /data-assets:
     /requests:
       get:

package/src/raml/luvio.raml

@@ -34,6 +34,9 @@ types:
   DataAssetRequestCountRepresentation:
     (luvio.ttl): 500
     (luvio.opaque): true
+  DataAlertQueryCollectionRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
   DataAlertCollectionRepresentation:
     (luvio.ttl): 500
     (luvio.opaque): true
@@ -458,6 +461,12 @@ types:
     (luvio.adapter):
       name: createDataAlert
 
+/tableau/dataAlerts/query:
+  post:
+    (luvio.adapter):
+      name: postDataAlertQuery
+    (luvio.method): get
+
 /tableau/dataAlerts/{dataAlertId}:
   get:
     (luvio.adapter):