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

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.
Files changed (42) hide show
  1. package/dist/es/es2018/analytics-unifiedanalytics.js +1945 -1158
  2. package/dist/es/es2018/types/src/generated/adapters/createDashboard.d.ts +2 -0
  3. package/dist/es/es2018/types/src/generated/adapters/createDataAlert.d.ts +4 -2
  4. package/dist/es/es2018/types/src/generated/adapters/getDataAssetDependencies.d.ts +1 -0
  5. package/dist/es/es2018/types/src/generated/adapters/getDataAssetLineageByIdOrApiName.d.ts +27 -0
  6. package/dist/es/es2018/types/src/generated/adapters/postDataAlertQuery.d.ts +34 -0
  7. package/dist/es/es2018/types/src/generated/adapters/updateDashboard.d.ts +2 -0
  8. package/dist/es/es2018/types/src/generated/adapters/updateDataAlert.d.ts +4 -2
  9. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +2 -0
  10. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +5 -1
  11. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsDependenciesByAssetId.d.ts +1 -0
  12. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsLineageByAssetIdOrApiName.d.ts +15 -0
  13. package/dist/es/es2018/types/src/generated/resources/patchTableauDashboardsByDashboardIdOrApiName.d.ts +2 -0
  14. package/dist/es/es2018/types/src/generated/resources/postTableauDashboards.d.ts +2 -0
  15. package/dist/es/es2018/types/src/generated/resources/postTableauDataAlerts.d.ts +4 -2
  16. package/dist/es/es2018/types/src/generated/resources/postTableauDataAlertsQuery.d.ts +22 -0
  17. package/dist/es/es2018/types/src/generated/resources/putTableauDataAlertsByDataAlertId.d.ts +4 -2
  18. package/dist/es/es2018/types/src/generated/types/DashboardInputRepresentation.d.ts +7 -1
  19. package/dist/es/es2018/types/src/generated/types/DataAlertBriefContentInputRepresentation.d.ts +33 -0
  20. package/dist/es/es2018/types/src/generated/types/DataAlertBriefContentRepresentation.d.ts +32 -0
  21. package/dist/es/es2018/types/src/generated/types/DataAlertContentInputRepresentation.d.ts +1 -0
  22. package/dist/es/es2018/types/src/generated/types/DataAlertDeliveryConfigurationInputRepresentation.d.ts +2 -1
  23. package/dist/es/es2018/types/src/generated/types/DataAlertInputRepresentation.d.ts +8 -4
  24. package/dist/es/es2018/types/src/generated/types/DataAlertMsTeamsRecipientInputRepresentation.d.ts +31 -0
  25. package/dist/es/es2018/types/src/generated/types/DataAlertMsTeamsRecipientRepresentation.d.ts +31 -0
  26. package/dist/es/es2018/types/src/generated/types/DataAlertMsTeamsRecipientsInputRepresentation.d.ts +31 -0
  27. package/dist/es/es2018/types/src/generated/types/DataAlertMsTeamsRecipientsRepresentation.d.ts +30 -0
  28. package/dist/es/es2018/types/src/generated/types/DataAlertPropertyFilterInputRepresentation.d.ts +31 -0
  29. package/dist/es/es2018/types/src/generated/types/DataAlertPropertyFilterOutputRepresentation.d.ts +28 -0
  30. package/dist/es/es2018/types/src/generated/types/DataAlertQueryCollectionRepresentation.d.ts +30 -0
  31. package/dist/es/es2018/types/src/generated/types/DataAlertQueryInputRepresentation.d.ts +43 -0
  32. package/dist/es/es2018/types/src/generated/types/DataAlertReceiversInputRepresentation.d.ts +1 -0
  33. package/dist/es/es2018/types/src/generated/types/DataAlertRepresentation.d.ts +10 -3
  34. package/dist/es/es2018/types/src/generated/types/DataAssetLineageRepresentation.d.ts +37 -0
  35. package/dist/es/es2018/types/src/generated/types/DataAssetRepresentation.d.ts +4 -1
  36. package/dist/es/es2018/types/src/generated/types/DataAssetRequestDebugInfo.d.ts +31 -0
  37. package/dist/es/es2018/types/src/generated/types/DataAssetRequestRepresentation.d.ts +9 -1
  38. package/dist/es/es2018/types/src/generated/types/PromotionContentAssetRepresentation.d.ts +49 -0
  39. package/package.json +3 -3
  40. package/sfdc/index.js +3366 -2557
  41. package/src/raml/api.raml +302 -0
  42. package/src/raml/luvio.raml +15 -0
package/src/raml/api.raml CHANGED
@@ -931,6 +931,14 @@ types:
931
931
  description: Unique developer name.
932
932
  type: string
933
933
  required: false
934
+ lastModifiedBy:
935
+ description: Last modified by of the asset.
936
+ type: any
937
+ required: false
938
+ lastModifiedDate:
939
+ description: Last modified date of the asset.
940
+ type: string
941
+ required: false
934
942
  layouts:
935
943
  description: List of layouts in the dashboard.
936
944
  type: array
@@ -1057,6 +1065,22 @@ types:
1057
1065
  dataAsset:
1058
1066
  description: Represents a Data asset
1059
1067
  type: DataAssetRepresentation
1068
+ DataAssetLineageRepresentation:
1069
+ description: Data Asset Lineage
1070
+ type: object
1071
+ properties:
1072
+ sourceDeveloperName:
1073
+ description: Source Developer Name
1074
+ type: string
1075
+ sourceRecordId:
1076
+ description: Source Record Id
1077
+ type: string
1078
+ targetDeveloperName:
1079
+ description: Target Developer Name
1080
+ type: string
1081
+ targetRecordId:
1082
+ description: Target Record Id
1083
+ type: string
1060
1084
  DataAssetRepresentation:
1061
1085
  description: Represents a Data asset
1062
1086
  discriminator: assetId # TODO Hand-rolled W-17712133: invalid inheritance
@@ -1126,6 +1150,17 @@ types:
1126
1150
  description: Whether the DataAsset is the primary asset in a list of data asset dependencies
1127
1151
  type: boolean
1128
1152
  required: false
1153
+ reusedAssetStatus:
1154
+ description: The reused asset status of the DataAsset
1155
+ type: string | nil
1156
+ enum:
1157
+ - Conflict
1158
+ - Editable
1159
+ - Locked
1160
+ - Modified
1161
+ - OutOfSyncLocked
1162
+ - UpdateAvailable
1163
+ required: false
1129
1164
  assetTypeFingerprint:
1130
1165
  description: Schema fingerprint of the asset type of the DataAsset
1131
1166
  type: string
@@ -1161,6 +1196,89 @@ types:
1161
1196
  nextPageUrl:
1162
1197
  description: Next page url for pagination.
1163
1198
  type: string | nil
1199
+
1200
+ DataAlertQueryCollectionRepresentation:
1201
+ description: A collection of unified analytics data alerts that match the query.
1202
+ type: object
1203
+ properties:
1204
+ dataAlerts:
1205
+ description: List of data alerts being returned.
1206
+ type: array
1207
+ items:
1208
+ type: DataAlertRepresentation
1209
+
1210
+ DataAlertQueryInputRepresentation:
1211
+ description: Abstract input representation for complex queries with computed properties and filtering
1212
+ type: object
1213
+ properties:
1214
+ ownerId:
1215
+ description: User ID to filter alerts
1216
+ type: string
1217
+ required: true
1218
+ assetId:
1219
+ description: Filter by metric/asset ID
1220
+ type: string
1221
+ required: false
1222
+ dataAlertTypes:
1223
+ description: Filter alerts by one or more data alert types
1224
+ type: array
1225
+ required: false
1226
+ items:
1227
+ type: string
1228
+ enum:
1229
+ - AgentHealthMonitoring
1230
+ - AgentPowered
1231
+ - Brief
1232
+ timeRange:
1233
+ required: false
1234
+ description: Filter alerts by time range context
1235
+ type: UnifiedFilterInputRepresentation # TODO Hand-rolled @W-21386585
1236
+ includeProperties:
1237
+ required: false
1238
+ type: array
1239
+ items:
1240
+ type: string
1241
+ enum:
1242
+ - ConditionCategory
1243
+ propertyFilters:
1244
+ required: false
1245
+ type: array
1246
+ description: Structured filter for computed properties
1247
+ items:
1248
+ type: DataAlertPropertyFilterInputRepresentation # TODO Hand-rolled @W-21386585
1249
+ DataAlertPropertyFilterInputRepresentation:
1250
+ description: Filter by computed property values. Automatically computes filtered properties (no need to specify in includeProperties)
1251
+ type: object
1252
+ properties:
1253
+ property:
1254
+ description: Property description
1255
+ type: string
1256
+ enum:
1257
+ - ConditionCategory
1258
+ values:
1259
+ description: Values matching the property
1260
+ type: array
1261
+ items:
1262
+ type: string
1263
+ enum:
1264
+ - PeriodOverPeriodChange
1265
+ - UnusualChange
1266
+ - Goal
1267
+ - Threshold
1268
+ - Custom
1269
+ DataAlertPropertyFilterOutputRepresentation:
1270
+ description: Property Filter Output Representation
1271
+ type: object
1272
+ properties:
1273
+ conditionCategory:
1274
+ description: Computed Properties to Include
1275
+ type: string
1276
+ enum:
1277
+ - PeriodOverPeriodChange
1278
+ - UnusualChange
1279
+ - Goal
1280
+ - Threshold
1281
+ - Custom
1164
1282
  DataAlertValueInputRepresentation:
1165
1283
  description: Abstract input representation for operands
1166
1284
  type: object
@@ -1365,6 +1483,7 @@ types:
1365
1483
  description: content type
1366
1484
  type: string
1367
1485
  enum:
1486
+ - Brief
1368
1487
  - Metric
1369
1488
  DataAlertMetricContentInputRepresentation:
1370
1489
  description: Input representation for content based on metric value
@@ -1379,6 +1498,20 @@ types:
1379
1498
  type: array
1380
1499
  items:
1381
1500
  type: string
1501
+ DataAlertBriefContentInputRepresentation:
1502
+ description: Input representation for content based on brief
1503
+ type: DataAlertContentInputRepresentation
1504
+ discriminatorValue: Brief
1505
+ properties:
1506
+ skillInstruction:
1507
+ description: Skill instruction for the brief content
1508
+ type: string
1509
+ modelApiNameOrIdList:
1510
+ description: Ids or API names of the semantic data models used to generate the brief
1511
+ type: array
1512
+ items:
1513
+ type: string
1514
+ required: false
1382
1515
  DataAlertDailyScheduleInputRepresentation:
1383
1516
  description: Input representation for daily alert schedule
1384
1517
  type: DataAlertScheduleInputRepresentation
@@ -1413,6 +1546,7 @@ types:
1413
1546
  enum:
1414
1547
  - AgentHealthMonitoring
1415
1548
  - AgentPowered
1549
+ - Brief
1416
1550
  deliveryConfigurations:
1417
1551
  type: DataAlertDeliveryConfigurationInputRepresentation # TODO Hand-rolled @W-17927490
1418
1552
  schedule:
@@ -1421,6 +1555,7 @@ types:
1421
1555
  thresholds:
1422
1556
  description: thresholds to be evaluated
1423
1557
  type: DataAlertThresholdsInputRepresentation # TODO Hand-rolled @W-17927490
1558
+ required: false
1424
1559
  utterance:
1425
1560
  description: user entered utterance
1426
1561
  type: string
@@ -1428,6 +1563,10 @@ types:
1428
1563
  description: ID of the associated BotDefinition agent.
1429
1564
  type: string | nil
1430
1565
  required: false
1566
+ isEnabled:
1567
+ description: Whether this data alert is enabled. Set to false to pause alert execution.
1568
+ type: boolean
1569
+ required: false
1431
1570
  DataAlertNotificationRecipientsInputRepresentation:
1432
1571
  description: 'List of UNS recipients for Data alerts. May contain user or group
1433
1572
  Ids. '
@@ -1439,6 +1578,28 @@ types:
1439
1578
  type: array
1440
1579
  items:
1441
1580
  type: string
1581
+ DataAlertMsTeamsRecipientsInputRepresentation:
1582
+ description: List of Microsoft Teams recipients for Data alerts.
1583
+ type: DataAlertReceiversInputRepresentation
1584
+ discriminatorValue: MsTeams
1585
+ properties:
1586
+ recipients:
1587
+ description: Microsoft Teams recipients
1588
+ type: array
1589
+ items:
1590
+ type: DataAlertMsTeamsRecipientInputRepresentation
1591
+ DataAlertMsTeamsRecipientInputRepresentation:
1592
+ description: A single Microsoft Teams recipient
1593
+ type: object
1594
+ properties:
1595
+ recipient:
1596
+ description: Recipient identifier
1597
+ type: string
1598
+ recipientType:
1599
+ description: Type of recipient
1600
+ type: string
1601
+ enum:
1602
+ - SalesforceUser
1442
1603
  DataAlertReceiversInputRepresentation:
1443
1604
  description: Input representation for data alert recipients
1444
1605
  type: object
@@ -1449,6 +1610,7 @@ types:
1449
1610
  type: string
1450
1611
  enum:
1451
1612
  - Email
1613
+ - MsTeams
1452
1614
  - Notification
1453
1615
  - Slack
1454
1616
  DataAlertScheduleInputRepresentation:
@@ -1524,7 +1686,21 @@ types:
1524
1686
  description: Type of content
1525
1687
  type: string
1526
1688
  enum:
1689
+ - Brief
1527
1690
  - Metric
1691
+ DataAlertBriefContentRepresentation:
1692
+ description: Represents the brief content for a data alert
1693
+ type: DataAlertContentRepresentation
1694
+ properties:
1695
+ skillInstruction:
1696
+ description: Skill instruction for the brief content
1697
+ type: string
1698
+ modelApiNameOrIdList:
1699
+ description: Ids or API names of the semantic data models used to generate the brief
1700
+ type: array
1701
+ items:
1702
+ type: string
1703
+ required: false
1528
1704
  DataAlertCronScheduleRepresentation:
1529
1705
  description: Represents the cron schedule for a data alert
1530
1706
  type: DataAlertScheduleRepresentation
@@ -1634,8 +1810,31 @@ types:
1634
1810
  type: string
1635
1811
  enum:
1636
1812
  - Email
1813
+ - MsTeams
1637
1814
  - Notification
1638
1815
  - Slack
1816
+ DataAlertMsTeamsRecipientsRepresentation:
1817
+ description: Represents Microsoft Teams recipients for a data alert
1818
+ type: DataAlertReceiversRepresentation
1819
+ properties:
1820
+ recipients:
1821
+ description: list of Microsoft Teams recipients
1822
+ type: array
1823
+ items:
1824
+ type: DataAlertMsTeamsRecipientRepresentation
1825
+ DataAlertMsTeamsRecipientRepresentation:
1826
+ description: Represents a single Microsoft Teams recipient
1827
+ type: object
1828
+ properties:
1829
+ recipient:
1830
+ description: Recipient identifier
1831
+ type: string
1832
+ recipientType:
1833
+ description: Type of recipient
1834
+ type: string
1835
+ enum:
1836
+ - SalesforceUser
1837
+
1639
1838
  DataAlertRepresentation:
1640
1839
  description: Output representation for Data Alert
1641
1840
  discriminatorValue: DataAlert
@@ -1657,6 +1856,7 @@ types:
1657
1856
  enum:
1658
1857
  - AgentHealthMonitoring
1659
1858
  - AgentPowered
1859
+ - Brief
1660
1860
  deliveryConfigurations:
1661
1861
  description: Data alert delivery configurations.
1662
1862
  type: DataAlertDeliveryConfigurationRepresentation
@@ -1672,10 +1872,18 @@ types:
1672
1872
  thresholds:
1673
1873
  description: Thresholds to be evaluated.
1674
1874
  type: DataAlertThresholdsRepresentation
1875
+ required: false
1675
1876
  agent:
1676
1877
  description: ID of the associated BotDefinition agent.
1677
1878
  type: string | nil
1678
1879
  required: false
1880
+ properties?: #Field may be absent
1881
+ description: Additional properties for the data alert used when sending the query response.
1882
+ type: DataAlertPropertyFilterOutputRepresentation
1883
+ isEnabled:
1884
+ description: Whether this data alert is enabled. False indicates the alert is paused.
1885
+ type: boolean
1886
+ required: false
1679
1887
  DataAlertScheduleRepresentation:
1680
1888
  description: Represents the schedule for a data alert
1681
1889
  type: object
@@ -1824,6 +2032,10 @@ types:
1824
2032
  description: Additional Info
1825
2033
  type: DataAssetRequestAdditionalInfoRepresentation | nil
1826
2034
  required: false
2035
+ debugInfo:
2036
+ description: debugInfo
2037
+ type: DataAssetRequestDebugInfo | nil
2038
+ required: false
1827
2039
  assetId:
1828
2040
  description: assetId associated with the request
1829
2041
  type: string
@@ -1965,6 +2177,12 @@ types:
1965
2177
  description: Indicates whether the promotion request includes a DLO that is unsupported for guided promotions (e.g., non-CSV file type)
1966
2178
  type: boolean | nil
1967
2179
  required: false
2180
+ promotionContentAssets:
2181
+ description: List of content assets from promotion additional info
2182
+ type: array
2183
+ items:
2184
+ type: PromotionContentAssetRepresentation
2185
+ required: false
1968
2186
  DataSpaceInfoRepresentation:
1969
2187
  description: DataSpace Info Representation
1970
2188
  type: object
@@ -1979,6 +2197,18 @@ types:
1979
2197
  dataSpaceDeveloperName:
1980
2198
  description: DataSpace developer name.
1981
2199
  type: string
2200
+ DataAssetRequestDebugInfo:
2201
+ description: DataAssetRequest Debug Info Representation
2202
+ type: object
2203
+ properties:
2204
+ errorCode:
2205
+ description: errorCode
2206
+ type: string
2207
+ required: false
2208
+ errorMessage:
2209
+ description: errorMessage
2210
+ type: string
2211
+ required: false
1982
2212
  DataAssetRequestAdditionalInfoRepresentation:
1983
2213
  description: DataAssetRequest Additional Info Representation
1984
2214
  type: object
@@ -2069,6 +2299,44 @@ types:
2069
2299
  items:
2070
2300
  type: string
2071
2301
  required: false
2302
+ PromotionContentAssetRepresentation:
2303
+ description: Represents a content asset in a promotion request
2304
+ type: object
2305
+ properties:
2306
+ assetType:
2307
+ description: The type of the asset
2308
+ type: string
2309
+ isFirstLevelReuse:
2310
+ description: Indicates whether the asset is a first-level reuse
2311
+ type: boolean
2312
+ isReused:
2313
+ description: Indicates whether the asset is reused from another promotion
2314
+ type: boolean
2315
+ reusedAssetStatus:
2316
+ description: The reused asset status of the asset
2317
+ type: string | nil
2318
+ enum:
2319
+ - Conflict
2320
+ - Editable
2321
+ - Locked
2322
+ - Modified
2323
+ - OutOfSyncLocked
2324
+ - UpdateAvailable
2325
+ required: false
2326
+ sourceDevName:
2327
+ description: The source developer name of the asset
2328
+ type: string
2329
+ sourceId:
2330
+ description: The source ID of the asset
2331
+ type: string
2332
+ targetDevName:
2333
+ description: The target developer name of the asset
2334
+ type: string | nil
2335
+ required: false
2336
+ targetId:
2337
+ description: The target ID of the asset
2338
+ type: string | nil
2339
+ required: false
2072
2340
  TableauMarketplaceListingInstallationProgressResponse:
2073
2341
  description: Representation of tableau marketplace's listing installation progress
2074
2342
  type: object
@@ -3322,6 +3590,20 @@ types:
3322
3590
  application/json:
3323
3591
  type: DataAlertInputRepresentation
3324
3592
  (oas-body-name): dataAlert
3593
+ /dataAlerts/query:
3594
+ post:
3595
+ displayName: postDataAlertQuery
3596
+ description: Create a new data alert query.
3597
+ responses:
3598
+ '200':
3599
+ description: Success
3600
+ body:
3601
+ application/json:
3602
+ type: DataAlertQueryCollectionRepresentation
3603
+ body:
3604
+ application/json:
3605
+ type: DataAlertQueryInputRepresentation
3606
+ (oas-body-name): dataAlertQuery
3325
3607
  /dataAlerts/{dataAlertId}:
3326
3608
  get: #This is a mocked path only.
3327
3609
  displayName: getDataAlertCollection
@@ -3374,6 +3656,7 @@ types:
3374
3656
  dataAlertId:
3375
3657
  type: string
3376
3658
  required: true
3659
+
3377
3660
  /data-assets:
3378
3661
  /requests:
3379
3662
  get:
@@ -3512,6 +3795,10 @@ types:
3512
3795
  type: boolean
3513
3796
  required: false
3514
3797
  description: Perform asset type schema mismatch validation and include schema fingerprint in the response
3798
+ includeReusedAssets:
3799
+ type: boolean
3800
+ required: false
3801
+ description: Includes assets that were reused from the production org in the dependency list
3515
3802
  responses:
3516
3803
  '200':
3517
3804
  description: Success
@@ -3522,6 +3809,21 @@ types:
3522
3809
  assetId:
3523
3810
  type: string
3524
3811
  required: true
3812
+ /lineage:
3813
+ /{assetIdOrApiName}:
3814
+ get:
3815
+ displayName: getDataAssetLineage
3816
+ description: Get data asset lineage by asset Id or Api Name
3817
+ responses:
3818
+ '200':
3819
+ description: Success
3820
+ body:
3821
+ application/json:
3822
+ type: DataAssetLineageRepresentation
3823
+ uriParameters:
3824
+ assetIdOrApiName:
3825
+ type: string
3826
+ required: true
3525
3827
  /follow/followers/{followerId}/follows:
3526
3828
  post:
3527
3829
  displayName: postFollow
@@ -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):
@@ -503,6 +512,12 @@ types:
503
512
  get:
504
513
  (luvio.adapter):
505
514
  name: getDataAssetDependencies
515
+
516
+ /tableau/data-assets/lineage/{assetIdOrApiName}:
517
+ get:
518
+ (luvio.adapter):
519
+ name: getDataAssetLineageByIdOrApiName
520
+
506
521
  /tableau/marketplace/listings:
507
522
  post:
508
523
  (luvio.adapter):