@salesforce/lds-adapters-analytics-unifiedanalytics 1.404.0-dev21 → 1.404.0-dev22

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
@@ -1155,6 +1155,79 @@ types:
1155
1155
  nextPageUrl:
1156
1156
  description: Next page url for pagination.
1157
1157
  type: string | nil
1158
+
1159
+ DataAlertQueryCollectionRepresentation:
1160
+ description: A collection of unified analytics data alerts that match the query.
1161
+ type: object
1162
+ properties:
1163
+ dataAlerts:
1164
+ description: List of data alerts being returned.
1165
+ type: array
1166
+ items:
1167
+ type: DataAlertRepresentation
1168
+
1169
+ DataAlertQueryInputRepresentation:
1170
+ description: Abstract input representation for complex queries with computed properties and filtering
1171
+ type: object
1172
+ properties:
1173
+ ownerId:
1174
+ description: User ID to filter alerts
1175
+ type: string
1176
+ required: true
1177
+ assetId:
1178
+ description: Filter by metric/asset ID
1179
+ type: string
1180
+ required: false
1181
+ timeRange:
1182
+ required: false
1183
+ description: Filter alerts by time range context
1184
+ type: UnifiedFilterInputRepresentation # TODO Hand-rolled @W-21386585
1185
+ includeProperties:
1186
+ required: false
1187
+ type: array
1188
+ items:
1189
+ type: string
1190
+ enum:
1191
+ - ConditionCategory
1192
+ propertyFilters:
1193
+ required: false
1194
+ type: array
1195
+ description: Structured filter for computed properties
1196
+ items:
1197
+ type: DataAlertPropertyFilterInputRepresentation # TODO Hand-rolled @W-21386585
1198
+ DataAlertPropertyFilterInputRepresentation:
1199
+ description: Filter by computed property values. Automatically computes filtered properties (no need to specify in includeProperties)
1200
+ type: object
1201
+ properties:
1202
+ property:
1203
+ description: Property description
1204
+ type: string
1205
+ enum:
1206
+ - ConditionCategory
1207
+ values:
1208
+ description: Values matching the property
1209
+ type: array
1210
+ items:
1211
+ type: string
1212
+ enum:
1213
+ - PeriodOverPeriodChange
1214
+ - UnusualChange
1215
+ - Goal
1216
+ - Threshold
1217
+ - Custom
1218
+ DataAlertPropertyFilterOutputRepresentation:
1219
+ description: Property Filter Output Representation
1220
+ type: object
1221
+ properties:
1222
+ conditionCategory:
1223
+ description: Computed Properties to Include
1224
+ type: string
1225
+ enum:
1226
+ - PeriodOverPeriodChange
1227
+ - UnusualChange
1228
+ - Goal
1229
+ - Threshold
1230
+ - Custom
1158
1231
  DataAlertValueInputRepresentation:
1159
1232
  description: Abstract input representation for operands
1160
1233
  type: object
@@ -1630,6 +1703,7 @@ types:
1630
1703
  - Email
1631
1704
  - Notification
1632
1705
  - Slack
1706
+
1633
1707
  DataAlertRepresentation:
1634
1708
  description: Output representation for Data Alert
1635
1709
  discriminatorValue: DataAlert
@@ -1670,6 +1744,9 @@ types:
1670
1744
  description: ID of the associated BotDefinition agent.
1671
1745
  type: string | nil
1672
1746
  required: false
1747
+ properties?: #Field may be absent
1748
+ description: Additional properties for the data alert used when sending the query response.
1749
+ type: DataAlertPropertyFilterOutputRepresentation
1673
1750
  DataAlertScheduleRepresentation:
1674
1751
  description: Represents the schedule for a data alert
1675
1752
  type: object
@@ -3317,6 +3394,20 @@ types:
3317
3394
  application/json:
3318
3395
  type: DataAlertInputRepresentation
3319
3396
  (oas-body-name): dataAlert
3397
+ /dataAlerts/query:
3398
+ post:
3399
+ displayName: postDataAlertQuery
3400
+ description: Create a new data alert query.
3401
+ responses:
3402
+ '200':
3403
+ description: Success
3404
+ body:
3405
+ application/json:
3406
+ type: DataAlertQueryCollectionRepresentation
3407
+ body:
3408
+ application/json:
3409
+ type: DataAlertQueryInputRepresentation
3410
+ (oas-body-name): dataAlertQuery
3320
3411
  /dataAlerts/{dataAlertId}:
3321
3412
  get: #This is a mocked path only.
3322
3413
  displayName: getDataAlertCollection
@@ -3369,6 +3460,7 @@ types:
3369
3460
  dataAlertId:
3370
3461
  type: string
3371
3462
  required: true
3463
+
3372
3464
  /data-assets:
3373
3465
  /requests:
3374
3466
  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):