@salesforce/lds-adapters-analytics-unifiedanalytics 1.428.0-dev2 → 1.428.0-dev4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/raml/api.raml CHANGED
@@ -1161,6 +1161,79 @@ types:
1161
1161
  nextPageUrl:
1162
1162
  description: Next page url for pagination.
1163
1163
  type: string | nil
1164
+
1165
+ DataAlertQueryCollectionRepresentation:
1166
+ description: A collection of unified analytics data alerts that match the query.
1167
+ type: object
1168
+ properties:
1169
+ dataAlerts:
1170
+ description: List of data alerts being returned.
1171
+ type: array
1172
+ items:
1173
+ type: DataAlertRepresentation
1174
+
1175
+ DataAlertQueryInputRepresentation:
1176
+ description: Abstract input representation for complex queries with computed properties and filtering
1177
+ type: object
1178
+ properties:
1179
+ ownerId:
1180
+ description: User ID to filter alerts
1181
+ type: string
1182
+ required: true
1183
+ assetId:
1184
+ description: Filter by metric/asset ID
1185
+ type: string
1186
+ required: false
1187
+ timeRange:
1188
+ required: false
1189
+ description: Filter alerts by time range context
1190
+ type: UnifiedFilterInputRepresentation # TODO Hand-rolled @W-21386585
1191
+ includeProperties:
1192
+ required: false
1193
+ type: array
1194
+ items:
1195
+ type: string
1196
+ enum:
1197
+ - ConditionCategory
1198
+ propertyFilters:
1199
+ required: false
1200
+ type: array
1201
+ description: Structured filter for computed properties
1202
+ items:
1203
+ type: DataAlertPropertyFilterInputRepresentation # TODO Hand-rolled @W-21386585
1204
+ DataAlertPropertyFilterInputRepresentation:
1205
+ description: Filter by computed property values. Automatically computes filtered properties (no need to specify in includeProperties)
1206
+ type: object
1207
+ properties:
1208
+ property:
1209
+ description: Property description
1210
+ type: string
1211
+ enum:
1212
+ - ConditionCategory
1213
+ values:
1214
+ description: Values matching the property
1215
+ type: array
1216
+ items:
1217
+ type: string
1218
+ enum:
1219
+ - PeriodOverPeriodChange
1220
+ - UnusualChange
1221
+ - Goal
1222
+ - Threshold
1223
+ - Custom
1224
+ DataAlertPropertyFilterOutputRepresentation:
1225
+ description: Property Filter Output Representation
1226
+ type: object
1227
+ properties:
1228
+ conditionCategory:
1229
+ description: Computed Properties to Include
1230
+ type: string
1231
+ enum:
1232
+ - PeriodOverPeriodChange
1233
+ - UnusualChange
1234
+ - Goal
1235
+ - Threshold
1236
+ - Custom
1164
1237
  DataAlertValueInputRepresentation:
1165
1238
  description: Abstract input representation for operands
1166
1239
  type: object
@@ -1636,6 +1709,7 @@ types:
1636
1709
  - Email
1637
1710
  - Notification
1638
1711
  - Slack
1712
+
1639
1713
  DataAlertRepresentation:
1640
1714
  description: Output representation for Data Alert
1641
1715
  discriminatorValue: DataAlert
@@ -1676,6 +1750,9 @@ types:
1676
1750
  description: ID of the associated BotDefinition agent.
1677
1751
  type: string | nil
1678
1752
  required: false
1753
+ properties?: #Field may be absent
1754
+ description: Additional properties for the data alert used when sending the query response.
1755
+ type: DataAlertPropertyFilterOutputRepresentation
1679
1756
  DataAlertScheduleRepresentation:
1680
1757
  description: Represents the schedule for a data alert
1681
1758
  type: object
@@ -3322,6 +3399,20 @@ types:
3322
3399
  application/json:
3323
3400
  type: DataAlertInputRepresentation
3324
3401
  (oas-body-name): dataAlert
3402
+ /dataAlerts/query:
3403
+ post:
3404
+ displayName: postDataAlertQuery
3405
+ description: Create a new data alert query.
3406
+ responses:
3407
+ '200':
3408
+ description: Success
3409
+ body:
3410
+ application/json:
3411
+ type: DataAlertQueryCollectionRepresentation
3412
+ body:
3413
+ application/json:
3414
+ type: DataAlertQueryInputRepresentation
3415
+ (oas-body-name): dataAlertQuery
3325
3416
  /dataAlerts/{dataAlertId}:
3326
3417
  get: #This is a mocked path only.
3327
3418
  displayName: getDataAlertCollection
@@ -3374,6 +3465,7 @@ types:
3374
3465
  dataAlertId:
3375
3466
  type: string
3376
3467
  required: true
3468
+
3377
3469
  /data-assets:
3378
3470
  /requests:
3379
3471
  get:
@@ -34,6 +34,9 @@ types:
34
34
  DataAssetRequestCountRepresentation:
35
35
  (luvio.ttl): 500
36
36
  (luvio.opaque): true
37
+ DataAlertQueryCollectionRepresentation:
38
+ (luvio.ttl): 500
39
+ (luvio.opaque): true
37
40
  DataAlertCollectionRepresentation:
38
41
  (luvio.ttl): 500
39
42
  (luvio.opaque): true
@@ -458,6 +461,12 @@ types:
458
461
  (luvio.adapter):
459
462
  name: createDataAlert
460
463
 
464
+ /tableau/dataAlerts/query:
465
+ post:
466
+ (luvio.adapter):
467
+ name: postDataAlertQuery
468
+ (luvio.method): get
469
+
461
470
  /tableau/dataAlerts/{dataAlertId}:
462
471
  get:
463
472
  (luvio.adapter):