@salesforce/lds-adapters-analytics-unifiedanalytics 1.332.0-dev2 → 1.332.0-dev21

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 (84) hide show
  1. package/dist/es/es2018/analytics-unifiedanalytics.js +3050 -671
  2. package/dist/es/es2018/types/src/generated/adapters/createDashboard.d.ts +1 -0
  3. package/dist/es/es2018/types/src/generated/adapters/createDataAlert.d.ts +27 -0
  4. package/dist/es/es2018/types/src/generated/adapters/createDataAssetRequest.d.ts +24 -0
  5. package/dist/es/es2018/types/src/generated/adapters/createVisualization.d.ts +1 -0
  6. package/dist/es/es2018/types/src/generated/adapters/follow.d.ts +2 -0
  7. package/dist/es/es2018/types/src/generated/adapters/getDashboardByName.d.ts +1 -0
  8. package/dist/es/es2018/types/src/generated/adapters/getDashboards.d.ts +1 -0
  9. package/dist/es/es2018/types/src/generated/adapters/getDataAssetDependencies.d.ts +27 -0
  10. package/dist/es/es2018/types/src/generated/adapters/getDataAssetRequestByIdOrApiName.d.ts +28 -0
  11. package/dist/es/es2018/types/src/generated/adapters/getDataAssetRequests.d.ts +37 -0
  12. package/dist/es/es2018/types/src/generated/adapters/getDataAssetRequestsCount.d.ts +33 -0
  13. package/dist/es/es2018/types/src/generated/adapters/getOrg.d.ts +4 -5
  14. package/dist/es/es2018/types/src/generated/adapters/getVisualization.d.ts +1 -0
  15. package/dist/es/es2018/types/src/generated/adapters/getVisualizationBundle.d.ts +1 -0
  16. package/dist/es/es2018/types/src/generated/adapters/getVisualizations.d.ts +1 -0
  17. package/dist/es/es2018/types/src/generated/adapters/queryUsers.d.ts +3 -0
  18. package/dist/es/es2018/types/src/generated/adapters/updateDashboard.d.ts +1 -0
  19. package/dist/es/es2018/types/src/generated/adapters/updateDataAlert.d.ts +28 -0
  20. package/dist/es/es2018/types/src/generated/adapters/updateDataAssetRequest.d.ts +25 -0
  21. package/dist/es/es2018/types/src/generated/adapters/updateFollowedAsset.d.ts +20 -0
  22. package/dist/es/es2018/types/src/generated/adapters/updateVisualization.d.ts +1 -0
  23. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +9 -0
  24. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +15 -1
  25. package/dist/es/es2018/types/src/generated/resources/getTableauDashboards.d.ts +1 -0
  26. package/dist/es/es2018/types/src/generated/resources/getTableauDashboardsByDashboardIdOrApiName.d.ts +3 -0
  27. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsDependenciesByAssetId.d.ts +15 -0
  28. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsRequests.d.ts +25 -0
  29. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsRequestsByRequestIdOrApiName.d.ts +16 -0
  30. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsRequestsCount.d.ts +21 -0
  31. package/dist/es/es2018/types/src/generated/resources/{getTableauOrgsByUserName.d.ts → getTableauOrgs.d.ts} +0 -3
  32. package/dist/es/es2018/types/src/generated/resources/getTableauVisualizations.d.ts +1 -0
  33. package/dist/es/es2018/types/src/generated/resources/getTableauVisualizationsBundleByVisualizationIdOrApiName.d.ts +3 -0
  34. package/dist/es/es2018/types/src/generated/resources/getTableauVisualizationsByVisualizationIdOrApiName.d.ts +3 -0
  35. package/dist/es/es2018/types/src/generated/resources/patchTableauDashboardsByDashboardIdOrApiName.d.ts +3 -0
  36. package/dist/es/es2018/types/src/generated/resources/patchTableauDataAssetsRequestsByRequestIdOrApiName.d.ts +24 -0
  37. package/dist/es/es2018/types/src/generated/resources/patchTableauFollowFollowersFollowsByFollowerId.d.ts +19 -0
  38. package/dist/es/es2018/types/src/generated/resources/patchTableauVisualizationsByVisualizationIdOrApiName.d.ts +3 -0
  39. package/dist/es/es2018/types/src/generated/resources/postTableauDashboards.d.ts +3 -0
  40. package/dist/es/es2018/types/src/generated/resources/postTableauDataAlerts.d.ts +26 -0
  41. package/dist/es/es2018/types/src/generated/resources/postTableauDataAssetsRequests.d.ts +21 -0
  42. package/dist/es/es2018/types/src/generated/resources/postTableauFollowFollowersFollowsByFollowerId.d.ts +2 -0
  43. package/dist/es/es2018/types/src/generated/resources/postTableauUsersQuery.d.ts +3 -0
  44. package/dist/es/es2018/types/src/generated/resources/postTableauVisualizations.d.ts +3 -0
  45. package/dist/es/es2018/types/src/generated/resources/putTableauDataAlertsByDataAlertId.d.ts +29 -0
  46. package/dist/es/es2018/types/src/generated/types/AnalyticsLibraryDashboardTemplateRepresentation.d.ts +7 -4
  47. package/dist/es/es2018/types/src/generated/types/AnalyticsUsersQueryInputRepresentation.d.ts +10 -1
  48. package/dist/es/es2018/types/src/generated/types/DataAlertConditionInputRepresentation.d.ts +38 -0
  49. package/dist/es/es2018/types/src/generated/types/DataAlertContentInputRepresentation.d.ts +33 -0
  50. package/dist/es/es2018/types/src/generated/types/DataAlertCronScheduleInputRepresentation.d.ts +30 -0
  51. package/dist/es/es2018/types/src/generated/types/DataAlertDailyScheduleInputRepresentation.d.ts +26 -0
  52. package/dist/es/es2018/types/src/generated/types/DataAlertDeliveryConfigurationInputRepresentation.d.ts +30 -0
  53. package/dist/es/es2018/types/src/generated/types/DataAlertInputRepresentation.d.ts +47 -0
  54. package/dist/es/es2018/types/src/generated/types/DataAlertMetricContentInputRepresentation.d.ts +33 -0
  55. package/dist/es/es2018/types/src/generated/types/DataAlertMetricValueInputRepresentation.d.ts +55 -0
  56. package/dist/es/es2018/types/src/generated/types/DataAlertNotificationRecipientsInputRepresentation.d.ts +30 -0
  57. package/dist/es/es2018/types/src/generated/types/DataAlertRawValueInputRepresentation.d.ts +33 -0
  58. package/dist/es/es2018/types/src/generated/types/DataAlertReceiversInputRepresentation.d.ts +33 -0
  59. package/dist/es/es2018/types/src/generated/types/DataAlertRepresentation.d.ts +38 -0
  60. package/dist/es/es2018/types/src/generated/types/DataAlertScheduleInputRepresentation.d.ts +38 -0
  61. package/dist/es/es2018/types/src/generated/types/DataAlertThresholdsInputRepresentation.d.ts +32 -0
  62. package/dist/es/es2018/types/src/generated/types/DataAlertValueInputRepresentation.d.ts +34 -0
  63. package/dist/es/es2018/types/src/generated/types/DataAlertValueRightOperandInputRepresentation.d.ts +28 -0
  64. package/dist/es/es2018/types/src/generated/types/DataAlertWeeklyScheduleInputRepresentation.d.ts +30 -0
  65. package/dist/es/es2018/types/src/generated/types/DataAssetDependentCollectionRepresentation.d.ts +30 -0
  66. package/dist/es/es2018/types/src/generated/types/DataAssetDependentRepresentation.d.ts +29 -0
  67. package/dist/es/es2018/types/src/generated/types/DataAssetRepresentation.d.ts +69 -0
  68. package/dist/es/es2018/types/src/generated/types/DataAssetRequestCollectionRepresentation.d.ts +30 -0
  69. package/dist/es/es2018/types/src/generated/types/DataAssetRequestCountRepresentation.d.ts +29 -0
  70. package/dist/es/es2018/types/src/generated/types/DataAssetRequestInputRepresentation.d.ts +55 -0
  71. package/dist/es/es2018/types/src/generated/types/DataAssetRequestRepresentation.d.ts +123 -0
  72. package/dist/es/es2018/types/src/generated/types/FollowInputRepresentation.d.ts +4 -1
  73. package/dist/es/es2018/types/src/generated/types/FollowedAssetRepresentation.d.ts +5 -1
  74. package/dist/es/es2018/types/src/generated/types/FollowedTimeRangeRepresentation.d.ts +31 -0
  75. package/dist/es/es2018/types/src/generated/types/FollowerAssetRepresentation.d.ts +5 -1
  76. package/dist/es/es2018/types/src/generated/types/OrgCollectionRepresentation.d.ts +6 -6
  77. package/dist/es/es2018/types/src/generated/types/OrgRepresentation.d.ts +4 -4
  78. package/dist/es/es2018/types/src/generated/types/UnifiedFilterInputRepresentation.d.ts +33 -0
  79. package/dist/es/es2018/types/src/generated/types/UpdateFollowedAssetInputRepresentation.d.ts +38 -0
  80. package/package.json +3 -3
  81. package/sfdc/index.js +5055 -2566
  82. package/src/raml/api.raml +868 -23
  83. package/src/raml/luvio.raml +69 -1
  84. package/dist/es/es2018/types/src/generated/types/OrgInputRepresentation.d.ts +0 -28
package/src/raml/api.raml CHANGED
@@ -287,9 +287,18 @@ types:
287
287
  searchTerm:
288
288
  description: Search term parameter value
289
289
  type: string
290
+ userCapability:
291
+ description: User permission
292
+ type: string
290
293
  useAutoSuggest:
291
294
  description: Use auto suggest term parameter value
292
295
  type: boolean
296
+ limit:
297
+ description: Limit parameter value
298
+ type: integer
299
+ offset:
300
+ description: Offset parameter value
301
+ type: integer
293
302
  AnalyticsUsersQueryResultsRepresentation:
294
303
  description: Results of Users Query
295
304
  type: object
@@ -327,6 +336,35 @@ types:
327
336
  enum:
328
337
  - Group
329
338
  - User
339
+ followedTimeRange:
340
+ description: Time Range filter representation
341
+ type: FollowedTimeRangeRepresentation
342
+ required: false
343
+ UpdateFollowedAssetInputRepresentation:
344
+ description: Update followed asset input representation in unified analytics.
345
+ type: object
346
+ properties:
347
+ assetId:
348
+ description: Asset ID
349
+ type: string
350
+ assetType:
351
+ description: Followed asset type
352
+ type: string
353
+ enum:
354
+ - SemanticMetricDefinition
355
+ - SemanticSubMetric
356
+ required: false
357
+ followerType:
358
+ description: Follower type
359
+ type: string
360
+ enum:
361
+ - Group
362
+ - User
363
+ required: false
364
+ followedTimeRange:
365
+ description: Time Range filter representation
366
+ type: FollowedTimeRangeRepresentation | nil
367
+ required: false
330
368
  FollowedAssetCollectionRepresentation:
331
369
  description: Collection of Followed Assets
332
370
  type: object
@@ -393,6 +431,20 @@ types:
393
431
  enum:
394
432
  - SemanticMetricDefinition
395
433
  - SemanticSubMetric
434
+ followedTimeRange:
435
+ description: Time Range filter representation
436
+ type: FollowedTimeRangeRepresentation | nil
437
+ required: false
438
+ FollowedTimeRangeRepresentation:
439
+ description: Followed Time Range Representation
440
+ type: object
441
+ properties:
442
+ fieldName: string
443
+ operator: string # SemanticFilterOperatorTypeEnum
444
+ values:
445
+ type: array
446
+ items:
447
+ type: string | number
396
448
  FollowerAssetRepresentation:
397
449
  description: Represent follower and asset mapping
398
450
  type: object
@@ -421,6 +473,10 @@ types:
421
473
  createdDate:
422
474
  description: Created date
423
475
  type: string
476
+ followedTimeRange:
477
+ description: Time Range filter representation
478
+ type: FollowedTimeRangeRepresentation | nil
479
+ required: false
424
480
  FollowerCollectionRepresentation:
425
481
  description: Collection of Followers
426
482
  type: object
@@ -883,6 +939,579 @@ types:
883
939
  properties:
884
940
  //:
885
941
  type: any
942
+ DataAssetDependentCollectionRepresentation:
943
+ description: Represents a List of dependent assets for a given asset
944
+ type: object
945
+ properties:
946
+ dependentDataAssets:
947
+ description: Array of Dependent Assets
948
+ type: array
949
+ items:
950
+ type: DataAssetDependentRepresentation
951
+ DataAssetDependentRepresentation:
952
+ description: Represents a Dependent asset
953
+ type: object
954
+ properties:
955
+ dataAsset:
956
+ description: Represents a Data asset
957
+ type: DataAssetRepresentation
958
+ DataAssetRepresentation:
959
+ description: Represents a Data asset
960
+ discriminator: assetId # TODO Hand-rolled W-17712133: invalid inheritance
961
+ type: object
962
+ properties:
963
+ id:
964
+ description: DataAsset id.
965
+ type: string
966
+ required: false
967
+ description:
968
+ description: Description of the DataAsset.
969
+ type: string
970
+ required: false
971
+ label:
972
+ description: Label of the DataAsset.
973
+ type: string
974
+ name:
975
+ description: Name of the DataAsset.
976
+ type: string
977
+ createdBy:
978
+ description: Created by of the DataAsset.
979
+ type: AnalyticsUserRepresentation
980
+ createdDate:
981
+ description: Created date of the DataAsset
982
+ type: string
983
+ required: false
984
+ lastModifiedBy:
985
+ description: Last modified by of the DataAsset.
986
+ type: AnalyticsUserRepresentation
987
+ lastModifiedDate:
988
+ description: Last modified date of the DataAsset.
989
+ type: string
990
+ assetId:
991
+ description: Represents id of the DataAsset
992
+ type: string
993
+ assetType:
994
+ description: Type of the DataAsset
995
+ type: string
996
+ enum:
997
+ - AnalyticsDashboard
998
+ - AnalyticsVisualization
999
+ - MktCalculatedInsightsObject
1000
+ - MktDataModelObject
1001
+ - SemanticModel
1002
+ workspaceId:
1003
+ description: Id of the workspace which the DataAsset is part of
1004
+ type: string
1005
+ required: false
1006
+ DataAssetRequestCollectionRepresentation:
1007
+ description: Collection of Data Asset Requests
1008
+ type: object
1009
+ properties:
1010
+ dataAssetRequests:
1011
+ description: List of data asset requests being returned
1012
+ type: array
1013
+ items:
1014
+ type: DataAssetRequestRepresentation
1015
+ DataAssetRequestCountRepresentation:
1016
+ description: Represents a data asset request count
1017
+ type: object
1018
+ properties:
1019
+ count:
1020
+ description: Count of data asset requests
1021
+ type: integer
1022
+ DataAlertValueInputRepresentation:
1023
+ description: Abstract input representation for operands
1024
+ type: object
1025
+ discriminator: type
1026
+ properties:
1027
+ type:
1028
+ description: type of operand
1029
+ type: string
1030
+ enum:
1031
+ - Insights
1032
+ - RawValue
1033
+ DataAlertValueRightOperandInputRepresentation:
1034
+ description: Abstract input representation for operands
1035
+ type: object
1036
+ discriminator: type
1037
+ properties:
1038
+ type:
1039
+ description: type of operand
1040
+ type: string
1041
+ enum:
1042
+ - Insights
1043
+ - RawValue
1044
+ DataAlertRawValueInputRepresentation:
1045
+ description: Abstract input representation for raw value operands
1046
+ type: DataAlertValueInputRepresentation
1047
+ discriminatorValue: RawValue
1048
+ properties:
1049
+ dataType:
1050
+ description: 'data types for the raw value: percentage, currency etc. '
1051
+ type: string
1052
+ enum:
1053
+ - Number
1054
+ - Currency
1055
+ - Percentage
1056
+ value:
1057
+ description: raw value of the operand
1058
+ type: string
1059
+ DataAlertMetricValueInputRepresentation:
1060
+ description: Input representation for metric operands
1061
+ type: DataAlertValueInputRepresentation
1062
+ discriminatorValue: Insights
1063
+ properties:
1064
+ metricId:
1065
+ description: metric or sub-metric Id
1066
+ type: string
1067
+ insightType:
1068
+ description: type of insight
1069
+ type: string
1070
+ enum:
1071
+ - GoalProgress
1072
+ - Popc
1073
+ - RecordLevelOutliers
1074
+ - RiskyMonopoly
1075
+ - Unspecified
1076
+ - UnusualChange
1077
+ params:
1078
+ description: additional metric params
1079
+ type: object
1080
+ properties:
1081
+ //:
1082
+ type: string
1083
+ factKey:
1084
+ description: fact key
1085
+ type: string
1086
+ timeContext:
1087
+ description: time filter
1088
+ type: UnifiedFilterInputRepresentation # TODO Hand-rolled @W-17927490
1089
+ filterContext:
1090
+ description: filter context
1091
+ type: array
1092
+ items:
1093
+ type: UnifiedFilterInputRepresentation # TODO Hand-rolled @W-17927490
1094
+ modelApiNameOrId:
1095
+ description: Id or API name of the semantic data model
1096
+ type: string
1097
+ sdmId:
1098
+ description: SDM ID of the semantic data model
1099
+ type: string
1100
+ UnifiedFilterInputRepresentation:
1101
+ description: Message representing the Unified Filter.
1102
+ type: object
1103
+ properties:
1104
+ fieldName:
1105
+ description: FieldName
1106
+ type: string
1107
+ required: false
1108
+ operator:
1109
+ enum:
1110
+ - Equals
1111
+ - DoesNotEquals
1112
+ - EqualsIgnoreCase
1113
+ - DoesNotEqualsIgnoreCase
1114
+ - Between
1115
+ - LessThan
1116
+ - LessThanOrEqualTo
1117
+ - GreaterThan
1118
+ - GreaterThanOrEqualTo
1119
+ - IsEmpty
1120
+ - IsNotEmpty
1121
+ - Contains
1122
+ - ContainsIgnoreCase
1123
+ - NotContains
1124
+ - NotContainsIgnoreCase
1125
+ - StartsWith
1126
+ - StartsWithIgnoreCase
1127
+ - DoesNotStartWith
1128
+ - DoesNotStartWithIgnoreCase
1129
+ - EndsWith
1130
+ - EndsWithIgnoreCase
1131
+ - DoesNotEndWith
1132
+ - DoesNotEndWithIgnoreCase
1133
+ - IsNull
1134
+ - IsNotNull
1135
+ - LastNDays
1136
+ - NextNDays
1137
+ - PreviousWeek
1138
+ - CurrentWeek
1139
+ - NextWeek
1140
+ - PreviousMonth
1141
+ - CurrentMonth
1142
+ - NextMonth
1143
+ - PreviousQuarter
1144
+ - CurrentQuarter
1145
+ - NextQuarter
1146
+ - PreviousYear
1147
+ - CurrentYear
1148
+ - NextYear
1149
+ - PreviousFiscalQuarter
1150
+ - CurrentFiscalQuarter
1151
+ - NextFiscalQuarter
1152
+ - PreviousFiscalYear
1153
+ - CurrentFiscalYear
1154
+ - NextFiscalYear
1155
+ - PreviousMonthToDate
1156
+ - CurrentMonthToDate
1157
+ - PreviousQuarterToDate
1158
+ - CurrentQuarterToDate
1159
+ - PreviousYearToDate
1160
+ - CurrentYearToDate
1161
+ - PreviousFiscalQuarterToDate
1162
+ - CurrentFiscalQuarterToDate
1163
+ - PreviousFiscalYearToDate
1164
+ - CurrentFiscalYearToDate
1165
+ - Values
1166
+ type: string
1167
+ (amf-format): enum
1168
+ required: false
1169
+ values:
1170
+ description: An array of values. All values must be of the same type. We support strings, numbers, and booleans.
1171
+ type: array
1172
+ items:
1173
+ (amf-xone):
1174
+ - type: number
1175
+ - type: string
1176
+ - type: boolean
1177
+ type: any
1178
+ required: false
1179
+ DataAlertConditionInputRepresentation:
1180
+ description: A single condition representation
1181
+ type: object
1182
+ properties:
1183
+ leftOperand:
1184
+ description: Left operand of the condition
1185
+ type: DataAlertValueInputRepresentation # TODO Hand-rolled @W-17927490
1186
+ rightOperand:
1187
+ description: Right operand of the condition
1188
+ type: DataAlertValueRightOperandInputRepresentation # TODO Hand-rolled @W-17927490
1189
+ operator:
1190
+ description: operator of the condition
1191
+ type: string
1192
+ enum:
1193
+ - Equals
1194
+ - GreaterOrEqual
1195
+ - GreaterThan
1196
+ - LessOrEqual
1197
+ - LessThan
1198
+ - NotEqual
1199
+ DataAlertWeeklyScheduleInputRepresentation:
1200
+ description: Input representation for weekly alert alert schedule
1201
+ type: DataAlertScheduleInputRepresentation
1202
+ discriminatorValue: Weekly
1203
+ properties:
1204
+ daysOfWeek:
1205
+ description: days of the week to receive data alerts
1206
+ type: array
1207
+ items:
1208
+ type: string
1209
+ enum:
1210
+ - Friday
1211
+ - Monday
1212
+ - Saturday
1213
+ - Sunday
1214
+ - Thursday
1215
+ - Tuesday
1216
+ - Wednesday
1217
+ DataAlertContentInputRepresentation:
1218
+ description: Input representation for data alert content
1219
+ type: object
1220
+ discriminator: type
1221
+ properties:
1222
+ type:
1223
+ description: content type
1224
+ type: string
1225
+ enum:
1226
+ - Metric
1227
+ DataAlertMetricContentInputRepresentation:
1228
+ description: Input representation for content based on metric value
1229
+ type: DataAlertContentInputRepresentation
1230
+ discriminatorValue: Metric
1231
+ properties:
1232
+ instruction:
1233
+ description: input string instruction
1234
+ type: string
1235
+ modelApiNameOrId:
1236
+ description: Id or API name of the semantic data model
1237
+ type: array
1238
+ items:
1239
+ type: string
1240
+ DataAlertCronScheduleInputRepresentation:
1241
+ description: Input representation for cron based data alert schedule
1242
+ type: DataAlertScheduleInputRepresentation
1243
+ discriminatorValue: Cron
1244
+ properties:
1245
+ cronExpression:
1246
+ description: cron expression
1247
+ type: string
1248
+ DataAlertDailyScheduleInputRepresentation:
1249
+ description: Input representation for daily alert schedule
1250
+ type: DataAlertScheduleInputRepresentation
1251
+ discriminatorValue: Daily
1252
+ properties: {}
1253
+ DataAlertDeliveryConfigurationInputRepresentation:
1254
+ description: Delivery configuration for data alerts.
1255
+ type: object
1256
+ properties:
1257
+ receivers:
1258
+ description: list of recipients to be notified.
1259
+ type: array
1260
+ items:
1261
+ type: DataAlertReceiversInputRepresentation
1262
+ DataAlertRepresentation:
1263
+ description: Output of Data Alert
1264
+ type: object
1265
+ properties:
1266
+ id:
1267
+ description: Database record id of the data alert.
1268
+ type: string
1269
+ DataAlertInputRepresentation:
1270
+ description: A top level data alert metadata representation.
1271
+ type: object
1272
+ properties:
1273
+ analysisUtterance:
1274
+ description: user entered utterance for generating analysis.
1275
+ type: string
1276
+ content:
1277
+ type: DataAlertContentInputRepresentation # TODO Hand-rolled @W-17927490
1278
+ deliveryConfigurations:
1279
+ type: DataAlertDeliveryConfigurationInputRepresentation # TODO Hand-rolled @W-17927490
1280
+ schedule:
1281
+ description: data alert schedule
1282
+ type: DataAlertScheduleInputRepresentation # TODO Hand-rolled @W-17927490
1283
+ thresholds:
1284
+ description: thresholds to be evaluated
1285
+ type: DataAlertThresholdsInputRepresentation # TODO Hand-rolled @W-17927490
1286
+ utterance:
1287
+ description: user entered utterance
1288
+ type: string
1289
+ DataAlertNotificationRecipientsInputRepresentation:
1290
+ description: 'List of UNS recipients for Data alerts. May contain user or group
1291
+ Ids. '
1292
+ type: DataAlertReceiversInputRepresentation
1293
+ discriminatorValue: Notification
1294
+ properties:
1295
+ recipients:
1296
+ description: group or user Ids
1297
+ type: array
1298
+ items:
1299
+ type: string
1300
+ DataAlertReceiversInputRepresentation:
1301
+ description: Input representation for data alert recipients
1302
+ type: object
1303
+ discriminator: type
1304
+ properties:
1305
+ type:
1306
+ description: delivery type
1307
+ type: string
1308
+ enum:
1309
+ - Notification
1310
+ DataAlertScheduleInputRepresentation:
1311
+ description: Input representation for data alert schedule
1312
+ discriminator: type
1313
+ type: object
1314
+ properties:
1315
+ hoursOfDay:
1316
+ description: schedule time
1317
+ type: array
1318
+ items:
1319
+ type: integer
1320
+ type:
1321
+ description: schedule type
1322
+ type: string
1323
+ enum:
1324
+ - Cron
1325
+ - Daily
1326
+ - Weekly
1327
+ DataAlertThresholdsInputRepresentation:
1328
+ description: Data alert thresholds input representation.
1329
+ type: object
1330
+ properties:
1331
+ conditions:
1332
+ description: list of conditions to be evaluated.
1333
+ type: array
1334
+ items:
1335
+ type: DataAlertConditionInputRepresentation
1336
+ customLogicalOperation:
1337
+ description: logical operations between conditions
1338
+ type: string
1339
+ DataAssetRequestInputRepresentation:
1340
+ description: DataAssetRequest input representation in unified analytics.
1341
+ type: object
1342
+ properties:
1343
+ assetId:
1344
+ description: Id of Asset being promoted
1345
+ type: string
1346
+ required: false
1347
+ id:
1348
+ description: Id for the request
1349
+ type: string
1350
+ required: false
1351
+ label:
1352
+ description: Label to be used for the request
1353
+ type: string
1354
+ required: false
1355
+ numberOfDependencies:
1356
+ description: Number of dependencies associated with the asset being tracked
1357
+ type: integer
1358
+ required: false
1359
+ rejectionComment:
1360
+ description: Rejection comment
1361
+ type: string
1362
+ required: false
1363
+ requestType:
1364
+ description: Type of the request
1365
+ type: string
1366
+ required: false
1367
+ enum:
1368
+ - Promotion
1369
+ - Reuse
1370
+ requesterComment:
1371
+ description: Requester comment
1372
+ type: string
1373
+ required: false
1374
+ sourceRequestId:
1375
+ description: Id for the source request
1376
+ type: string
1377
+ required: false
1378
+ status:
1379
+ description: Status of the request
1380
+ type: string
1381
+ required: false
1382
+ enum:
1383
+ - Accepted
1384
+ - Cancelled
1385
+ - Completed
1386
+ - Extracting
1387
+ - ExtractionComplete
1388
+ - Failed
1389
+ - ManageAccess
1390
+ - ManageCsv
1391
+ - ManageDataPolicy
1392
+ - MarkAcceptedOrRejected
1393
+ - MarkComplete
1394
+ - Migrating
1395
+ - MigrationSucceeded
1396
+ - Rejected
1397
+ - Requested
1398
+ - ReviewContent
1399
+ workspaceIdOrApiName:
1400
+ description: Workspace id or name of personal org related to the request
1401
+ type: string
1402
+ required: false
1403
+ DataAssetRequestRepresentation:
1404
+ description: Represents a data asset request
1405
+ type: object
1406
+ properties:
1407
+ acknowledgedBy:
1408
+ description: The user who approved or rejected this request
1409
+ type: AnalyticsUserRepresentation | nil
1410
+ acknowledgedDate:
1411
+ description: Acknowledged date
1412
+ type: string | nil
1413
+ assetId:
1414
+ description: assetId associated with the request
1415
+ type: string
1416
+ assetLabel:
1417
+ description: Asset Label
1418
+ type: string | nil
1419
+ cancelledBy:
1420
+ description: The user who cancelled this request
1421
+ type: AnalyticsUserRepresentation | nil
1422
+ cancelledDate:
1423
+ description: Cancelled date
1424
+ type: string | nil
1425
+ completedBy:
1426
+ description: The user who completed this request
1427
+ type: AnalyticsUserRepresentation | nil
1428
+ completedDate:
1429
+ description: Completed date
1430
+ type: string | nil
1431
+ failedDate:
1432
+ description: Failed date
1433
+ type: string | nil
1434
+ lastModifiedDate:
1435
+ description: Last modified date for the data asset record
1436
+ type: string
1437
+ lastModifiedBy:
1438
+ description: The user who last modified this request
1439
+ type: AnalyticsUserRepresentation
1440
+ id:
1441
+ description: Data Asset Request Id
1442
+ type: string
1443
+ installedDate:
1444
+ description: Installed date
1445
+ type: string | nil
1446
+ label:
1447
+ description: Data Asset Request Label
1448
+ type: string
1449
+ migrationSucceededDate:
1450
+ description: Migration Succeeded date
1451
+ type: string | nil
1452
+ numberOfDependencies:
1453
+ description: Number of dependencies associated with workspace asset being
1454
+ tracked in the request
1455
+ type: integer | nil
1456
+ personalOrgId:
1457
+ description: ID of personal org
1458
+ type: string | nil
1459
+ personalOrgWorkspaceId:
1460
+ description: Workspace ID from personal org
1461
+ type: string | nil
1462
+ productionOrgId:
1463
+ description: ID of production org
1464
+ type: string | nil
1465
+ productionOrgWorkspaceId:
1466
+ description: Workspace ID from production org
1467
+ type: string | nil
1468
+ rejectionComment:
1469
+ description: Rejection Comment
1470
+ type: string | nil
1471
+ requestType:
1472
+ description: Type of the request
1473
+ type: string
1474
+ enum:
1475
+ - Promotion
1476
+ - Reuse
1477
+ requestedBy:
1478
+ description: The user who requested this request
1479
+ type: AnalyticsUserRepresentation
1480
+ requestedDate:
1481
+ description: Requested date
1482
+ type: string
1483
+ requesterComment:
1484
+ description: Requester Comment
1485
+ type: string
1486
+ sourceRequestId:
1487
+ description: Data Asset Request Source Id
1488
+ type: string | nil
1489
+ status:
1490
+ description: Data Asset Request Status
1491
+ type: string
1492
+ enum:
1493
+ - Accepted
1494
+ - Cancelled
1495
+ - Completed
1496
+ - Extracting
1497
+ - ExtractionComplete
1498
+ - Failed
1499
+ - ManageAccess
1500
+ - ManageCsv
1501
+ - ManageDataPolicy
1502
+ - MarkAcceptedOrRejected
1503
+ - MarkComplete
1504
+ - Migrating
1505
+ - MigrationSucceeded
1506
+ - Rejected
1507
+ - Requested
1508
+ - ReviewContent
1509
+ targetRequestId:
1510
+ description: Data Asset Request Target Id
1511
+ type: string | nil
1512
+ workspaceAssetId:
1513
+ description: workspaceAssetId in the workspace
1514
+ type: string | nil
886
1515
 
887
1516
  TableauMarketplaceListingInstallationProgressResponse:
888
1517
  description: Representation of tableau marketplace's listing installation progress
@@ -957,9 +1586,14 @@ types:
957
1586
  library
958
1587
  type: BaseAnalyticsLibraryAssetRepresentation
959
1588
  properties:
960
- previewImage:
961
- description: The icons configured for dashboard template preview
962
- type: AnalyticsLibraryImageRepresentation
1589
+ templateBadge:
1590
+ description: The badge icon configured for template
1591
+ type: string
1592
+ templatePreviews:
1593
+ description: The preview images configured for the template
1594
+ type: array
1595
+ items:
1596
+ type: string
963
1597
  AnalyticsLibraryImageRepresentation:
964
1598
  description: AnalyticsLibrary Image reference representation
965
1599
  type: object
@@ -1179,21 +1813,14 @@ types:
1179
1813
  description: A collection of unified analytics orgs.
1180
1814
  type: object
1181
1815
  properties:
1182
- currentOrg:
1183
- description: Current org.
1184
- type: OrgRepresentation
1185
- orgs:
1186
- description: List of orgs being returned.
1816
+ personalOrgs:
1817
+ description: List of Personal Orgs.
1187
1818
  type: array
1188
1819
  items:
1189
1820
  type: OrgRepresentation
1190
- OrgInputRepresentation:
1191
- description: Unified Analytics Org Input Representation
1192
- type: object
1193
- properties:
1194
- userName:
1195
- description: The name of the user to query to orgs for.
1196
- type: string
1821
+ productionOrg:
1822
+ description: Production Org.
1823
+ type: OrgRepresentation
1197
1824
  OrgRepresentation:
1198
1825
  description: Unified analytics org representation.
1199
1826
  discriminatorValue: Org
@@ -1202,12 +1829,12 @@ types:
1202
1829
  id:
1203
1830
  description: ID of this org.
1204
1831
  type: string
1832
+ isCurrentOrg:
1833
+ description: Is user currently logged in this org
1834
+ type: boolean
1205
1835
  label:
1206
1836
  description: Named label to display for this org
1207
1837
  type: string
1208
- orgUrl:
1209
- description: URL to display for this org
1210
- type: string
1211
1838
  targetUrl:
1212
1839
  description: URL to switch to this org.
1213
1840
  type: string
@@ -1866,6 +2493,9 @@ types:
1866
2493
  limit:
1867
2494
  type: integer
1868
2495
  required: false
2496
+ minorVersion:
2497
+ type: integer
2498
+ required: false
1869
2499
  offset:
1870
2500
  type: integer
1871
2501
  required: false
@@ -1878,6 +2508,10 @@ types:
1878
2508
  body:
1879
2509
  application/json:
1880
2510
  type: DashboardRepresentation
2511
+ queryParameters:
2512
+ minorVersion:
2513
+ type: integer
2514
+ required: false
1881
2515
  body:
1882
2516
  application/json:
1883
2517
  type: DashboardInputRepresentation
@@ -1898,6 +2532,10 @@ types:
1898
2532
  body:
1899
2533
  application/json:
1900
2534
  type: DashboardRepresentation
2535
+ queryParameters:
2536
+ minorVersion:
2537
+ type: integer
2538
+ required: false
1901
2539
  patch:
1902
2540
  displayName: patchDashboard
1903
2541
  description: Update Unified Analytics Dashboard Metadata by Id or Name.
@@ -1907,6 +2545,10 @@ types:
1907
2545
  body:
1908
2546
  application/json:
1909
2547
  type: DashboardRepresentation
2548
+ queryParameters:
2549
+ minorVersion:
2550
+ type: integer
2551
+ required: false
1910
2552
  body:
1911
2553
  application/json:
1912
2554
  type: DashboardInputRepresentation
@@ -1915,6 +2557,181 @@ types:
1915
2557
  dashboardIdOrApiName:
1916
2558
  type: string
1917
2559
  required: true
2560
+ /dataAlerts:
2561
+ post:
2562
+ displayName: postDataAlertCollection
2563
+ description: Create a new data alert.
2564
+ responses:
2565
+ '200':
2566
+ description: Success
2567
+ body:
2568
+ application/json:
2569
+ type: DataAlertRepresentation
2570
+ queryParameters:
2571
+ runNow:
2572
+ description: optional parameter to trigger data alert flow to run immediately.
2573
+ type: boolean
2574
+ required: false
2575
+ body:
2576
+ application/json:
2577
+ type: DataAlertInputRepresentation
2578
+ (oas-body-name): dataAlert
2579
+ /dataAlerts/{dataAlertId}:
2580
+ put:
2581
+ displayName: updateDataAlert
2582
+ description: update a data alert
2583
+ responses:
2584
+ '200':
2585
+ description: Success
2586
+ body:
2587
+ application/json:
2588
+ type: DataAlertRepresentation
2589
+ queryParameters:
2590
+ runNow:
2591
+ description: optional parameter to trigger data alert flow to run immediately.
2592
+ type: boolean
2593
+ required: false
2594
+ body:
2595
+ application/json:
2596
+ type: DataAlertInputRepresentation
2597
+ (oas-body-name): dataAlert
2598
+ uriParameters:
2599
+ dataAlertId:
2600
+ type: string
2601
+ required: true
2602
+ /data-assets:
2603
+ /requests:
2604
+ get:
2605
+ displayName: getDataAssetRequestCollection
2606
+ description: Gets data asset requests based on query parameters
2607
+ responses:
2608
+ '200':
2609
+ description: Success
2610
+ body:
2611
+ application/json:
2612
+ type: DataAssetRequestCollectionRepresentation
2613
+ queryParameters:
2614
+ assetId:
2615
+ type: string
2616
+ required: false
2617
+ assetType:
2618
+ type: string
2619
+ required: false
2620
+ createdBy:
2621
+ type: string
2622
+ required: false
2623
+ limit:
2624
+ type: integer
2625
+ required: false
2626
+ offset:
2627
+ type: integer
2628
+ required: false
2629
+ orderBy:
2630
+ type: string
2631
+ required: false
2632
+ requestType:
2633
+ type: string
2634
+ required: false
2635
+ searchQueryTerm:
2636
+ type: string
2637
+ required: false
2638
+ sortBy:
2639
+ type: string
2640
+ required: false
2641
+ status:
2642
+ type: string
2643
+ required: false
2644
+ workspaceIdOrApiName:
2645
+ type: string
2646
+ required: false
2647
+ post:
2648
+ displayName: postDataAssetRequest
2649
+ description: Request creation of a task for a data asset
2650
+ responses:
2651
+ '200':
2652
+ description: Success
2653
+ body:
2654
+ application/json:
2655
+ type: DataAssetRequestRepresentation
2656
+ body:
2657
+ application/json:
2658
+ type: DataAssetRequestInputRepresentation
2659
+ # required: false # TODO Hand-rolled W-17118037 not supported
2660
+ (oas-body-name): dataAssetRequestInput
2661
+ /count:
2662
+ get:
2663
+ displayName: getDataAssetRequestCount
2664
+ description: Gets data asset requests count based on query parameters
2665
+ responses:
2666
+ '200':
2667
+ description: Success
2668
+ body:
2669
+ application/json:
2670
+ type: DataAssetRequestCountRepresentation
2671
+ queryParameters:
2672
+ assetId:
2673
+ type: string
2674
+ required: false
2675
+ assetType:
2676
+ type: string
2677
+ required: false
2678
+ createdBy:
2679
+ type: string
2680
+ required: false
2681
+ searchQueryTerm:
2682
+ type: string
2683
+ required: false
2684
+ status:
2685
+ type: string
2686
+ required: false
2687
+ taskType:
2688
+ type: string
2689
+ required: false
2690
+ workspaceIdOrApiName:
2691
+ type: string
2692
+ required: false
2693
+ /{requestIdOrApiName}:
2694
+ get:
2695
+ displayName: getDataAssetRequest
2696
+ description: Get data asset request by Id or Api Name
2697
+ responses:
2698
+ '200':
2699
+ description: Success
2700
+ body:
2701
+ application/json:
2702
+ type: DataAssetRequestRepresentation
2703
+ patch:
2704
+ displayName: patchDataAssetRequest
2705
+ description: Request update of a data asset request
2706
+ responses:
2707
+ '200':
2708
+ description: Success
2709
+ body:
2710
+ application/json:
2711
+ type: DataAssetRequestRepresentation
2712
+ body:
2713
+ application/json:
2714
+ type: DataAssetRequestInputRepresentation
2715
+ (oas-body-name): dataAssetRequestInput
2716
+ uriParameters:
2717
+ requestIdOrApiName:
2718
+ type: string
2719
+ required: true
2720
+ /dependencies:
2721
+ /{assetId}:
2722
+ get:
2723
+ displayName: getDataAssetDependencies
2724
+ description: Gets the dependencies of an Data asset
2725
+ responses:
2726
+ '200':
2727
+ description: Success
2728
+ body:
2729
+ application/json:
2730
+ type: DataAssetDependentCollectionRepresentation
2731
+ uriParameters:
2732
+ assetId:
2733
+ type: string
2734
+ required: true
1918
2735
  /follow/followers/{followerId}/follows:
1919
2736
  post:
1920
2737
  displayName: postFollow
@@ -1929,6 +2746,19 @@ types:
1929
2746
  application/json:
1930
2747
  type: FollowInputRepresentation
1931
2748
  (oas-body-name): followerAsset
2749
+ patch:
2750
+ displayName: patchFollow
2751
+ description: Update a followed asset
2752
+ responses:
2753
+ '200':
2754
+ description: Success
2755
+ body:
2756
+ application/json:
2757
+ type: FollowerAssetRepresentation
2758
+ body:
2759
+ application/json:
2760
+ type: UpdateFollowedAssetInputRepresentation
2761
+ (oas-body-name): followerAsset
1932
2762
  uriParameters:
1933
2763
  followerId:
1934
2764
  type: string
@@ -2039,7 +2869,7 @@ types:
2039
2869
  type: UnifiedAnalyticsLoglinesInputRepresentation
2040
2870
  # required: false # TODO Hand-rolled W-15315791 not supported
2041
2871
  (oas-body-name): loglines
2042
- /orgs/{userName}:
2872
+ /orgs:
2043
2873
  get:
2044
2874
  displayName: getOrg
2045
2875
  description: Get all available Unified Analytics Orgs.
@@ -2049,10 +2879,6 @@ types:
2049
2879
  body:
2050
2880
  application/json:
2051
2881
  type: OrgCollectionRepresentation
2052
- uriParameters:
2053
- userName:
2054
- type: string
2055
- required: true
2056
2882
  /records/{recordId}/shares:
2057
2883
  delete:
2058
2884
  displayName: deleteSetupRecordShareCollection
@@ -2190,6 +3016,9 @@ types:
2190
3016
  offset:
2191
3017
  type: integer
2192
3018
  required: false
3019
+ minorVersion:
3020
+ type: integer
3021
+ required: false
2193
3022
  post:
2194
3023
  displayName: postVisualization
2195
3024
  description: Creates a new Visualization.
@@ -2199,6 +3028,10 @@ types:
2199
3028
  body:
2200
3029
  application/json:
2201
3030
  type: VisualizationRepresentation
3031
+ queryParameters:
3032
+ minorVersion:
3033
+ type: integer
3034
+ required: false
2202
3035
  body:
2203
3036
  application/json:
2204
3037
  type: VisualizationInputRepresentation
@@ -2219,6 +3052,10 @@ types:
2219
3052
  body:
2220
3053
  application/json:
2221
3054
  type: VisualizationRepresentation
3055
+ queryParameters:
3056
+ minorVersion:
3057
+ type: integer
3058
+ required: false
2222
3059
  patch:
2223
3060
  displayName: patchVisualization
2224
3061
  description: Update Visualization Metadata by Id or Name.
@@ -2228,6 +3065,10 @@ types:
2228
3065
  body:
2229
3066
  application/json:
2230
3067
  type: VisualizationRepresentation
3068
+ queryParameters:
3069
+ minorVersion:
3070
+ type: integer
3071
+ required: false
2231
3072
  body:
2232
3073
  application/json:
2233
3074
  type: VisualizationInputRepresentation
@@ -2246,6 +3087,10 @@ types:
2246
3087
  body:
2247
3088
  application/json:
2248
3089
  type: VisualizationBundleRepresentation
3090
+ queryParameters:
3091
+ minorVersion:
3092
+ type: integer
3093
+ required: false
2249
3094
  uriParameters:
2250
3095
  visualizationIdOrApiName:
2251
3096
  type: string