@salesforce/lds-adapters-analytics-unifiedanalytics 1.332.0-dev1 → 1.332.0-dev11

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 (32) hide show
  1. package/dist/es/es2018/analytics-unifiedanalytics.js +2335 -759
  2. package/dist/es/es2018/types/src/generated/adapters/createDataAssetRequest.d.ts +24 -0
  3. package/dist/es/es2018/types/src/generated/adapters/getDataAssetDependencies.d.ts +27 -0
  4. package/dist/es/es2018/types/src/generated/adapters/getDataAssetRequestByIdOrApiName.d.ts +28 -0
  5. package/dist/es/es2018/types/src/generated/adapters/getDataAssetRequests.d.ts +37 -0
  6. package/dist/es/es2018/types/src/generated/adapters/getDataAssetRequestsCount.d.ts +33 -0
  7. package/dist/es/es2018/types/src/generated/adapters/getOrg.d.ts +4 -5
  8. package/dist/es/es2018/types/src/generated/adapters/updateDataAssetRequest.d.ts +25 -0
  9. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +6 -0
  10. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +12 -1
  11. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsDependenciesByAssetId.d.ts +15 -0
  12. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsRequests.d.ts +25 -0
  13. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsRequestsByRequestIdOrApiName.d.ts +16 -0
  14. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsRequestsCount.d.ts +21 -0
  15. package/dist/es/es2018/types/src/generated/resources/{getTableauOrgsByUserName.d.ts → getTableauOrgs.d.ts} +0 -3
  16. package/dist/es/es2018/types/src/generated/resources/patchTableauDataAssetsRequestsByRequestIdOrApiName.d.ts +24 -0
  17. package/dist/es/es2018/types/src/generated/resources/postTableauDataAssetsRequests.d.ts +21 -0
  18. package/dist/es/es2018/types/src/generated/types/AnalyticsLibraryDashboardTemplateRepresentation.d.ts +7 -4
  19. package/dist/es/es2018/types/src/generated/types/DataAssetDependentCollectionRepresentation.d.ts +30 -0
  20. package/dist/es/es2018/types/src/generated/types/DataAssetDependentRepresentation.d.ts +29 -0
  21. package/dist/es/es2018/types/src/generated/types/DataAssetRepresentation.d.ts +44 -0
  22. package/dist/es/es2018/types/src/generated/types/DataAssetRequestCollectionRepresentation.d.ts +30 -0
  23. package/dist/es/es2018/types/src/generated/types/DataAssetRequestCountRepresentation.d.ts +29 -0
  24. package/dist/es/es2018/types/src/generated/types/DataAssetRequestInputRepresentation.d.ts +55 -0
  25. package/dist/es/es2018/types/src/generated/types/DataAssetRequestRepresentation.d.ts +117 -0
  26. package/dist/es/es2018/types/src/generated/types/OrgCollectionRepresentation.d.ts +6 -6
  27. package/dist/es/es2018/types/src/generated/types/OrgRepresentation.d.ts +4 -4
  28. package/package.json +3 -3
  29. package/sfdc/index.js +4379 -2705
  30. package/src/raml/api.raml +371 -23
  31. package/src/raml/luvio.raml +51 -1
  32. package/dist/es/es2018/types/src/generated/types/OrgInputRepresentation.d.ts +0 -28
package/src/raml/api.raml CHANGED
@@ -883,6 +883,227 @@ types:
883
883
  properties:
884
884
  //:
885
885
  type: any
886
+ DataAssetDependentCollectionRepresentation:
887
+ description: Represents a List of dependent assets for a given asset
888
+ type: object
889
+ properties:
890
+ dependentDataAssets:
891
+ description: Array of Dependent Assets
892
+ type: array
893
+ items:
894
+ type: DataAssetDependentRepresentation
895
+ DataAssetDependentRepresentation:
896
+ description: Represents a Dependent asset
897
+ type: object
898
+ properties:
899
+ dataAsset:
900
+ description: Represents a Data asset
901
+ type: DataAssetRepresentation
902
+ DataAssetRepresentation:
903
+ description: Represents a Data asset
904
+ type: object
905
+ properties:
906
+ assetId:
907
+ description: Represents id of the Data asset
908
+ type: string
909
+ assetType:
910
+ description: Type of the Data asset
911
+ type: string
912
+ enum:
913
+ - AnalyticsDashboard
914
+ - AnalyticsVisualization
915
+ - MktCalculatedInsightsObject
916
+ - MktDataModelObject
917
+ - SemanticModel
918
+ workspaceId:
919
+ description: Id of the workspace
920
+ type: string
921
+ DataAssetRequestCollectionRepresentation:
922
+ description: Collection of Data Asset Requests
923
+ type: object
924
+ properties:
925
+ dataAssetRequests:
926
+ description: List of data asset requests being returned
927
+ type: array
928
+ items:
929
+ type: DataAssetRequestRepresentation
930
+ DataAssetRequestCountRepresentation:
931
+ description: Represents a data asset request count
932
+ type: object
933
+ properties:
934
+ count:
935
+ description: Count of data asset requests
936
+ type: integer
937
+ DataAssetRequestInputRepresentation:
938
+ description: DataAssetRequest input representation in unified analytics.
939
+ type: object
940
+ properties:
941
+ assetId:
942
+ description: Id of Asset being promoted
943
+ type: string
944
+ required: false
945
+ id:
946
+ description: Id for the request
947
+ type: string
948
+ required: false
949
+ label:
950
+ description: Label to be used for the request
951
+ type: string
952
+ required: false
953
+ numberOfDependencies:
954
+ description: Number of dependencies associated with the asset being tracked
955
+ type: integer
956
+ required: false
957
+ rejectionComment:
958
+ description: Rejection comment
959
+ type: string
960
+ required: false
961
+ requestType:
962
+ description: Type of the request
963
+ type: string
964
+ required: false
965
+ enum:
966
+ - Promotion
967
+ - Reuse
968
+ requesterComment:
969
+ description: Requester comment
970
+ type: string
971
+ required: false
972
+ sourceRequestId:
973
+ description: Id for the source request
974
+ type: string
975
+ required: false
976
+ status:
977
+ description: Status of the request
978
+ type: string
979
+ required: false
980
+ enum:
981
+ - Accepted
982
+ - Cancelled
983
+ - Completed
984
+ - Extracting
985
+ - ExtractionComplete
986
+ - Failed
987
+ - ManageAccess
988
+ - ManageCsv
989
+ - ManageDataPolicy
990
+ - MarkAcceptedOrRejected
991
+ - MarkComplete
992
+ - Migrating
993
+ - MigrationSucceeded
994
+ - Rejected
995
+ - Requested
996
+ - ReviewContent
997
+ workspaceIdOrApiName:
998
+ description: Workspace id or name of personal org related to the request
999
+ type: string
1000
+ required: false
1001
+ DataAssetRequestRepresentation:
1002
+ description: Represents a data asset request
1003
+ type: object
1004
+ properties:
1005
+ acknowledgedBy:
1006
+ description: The user who approved or rejected this request
1007
+ type: AnalyticsUserRepresentation | nil
1008
+ acknowledgedDate:
1009
+ description: Acknowledged date
1010
+ type: string | nil
1011
+ assetId:
1012
+ description: assetId associated with the request
1013
+ type: string
1014
+ assetLabel:
1015
+ description: Asset Label
1016
+ type: string | nil
1017
+ cancelledBy:
1018
+ description: The user who cancelled this request
1019
+ type: AnalyticsUserRepresentation | nil
1020
+ cancelledDate:
1021
+ description: Cancelled date
1022
+ type: string | nil
1023
+ completedBy:
1024
+ description: The user who completed this request
1025
+ type: AnalyticsUserRepresentation | nil
1026
+ completedDate:
1027
+ description: Completed date
1028
+ type: string | nil
1029
+ failedDate:
1030
+ description: Failed date
1031
+ type: string | nil
1032
+ id:
1033
+ description: Data Asset Request Id
1034
+ type: string
1035
+ installedDate:
1036
+ description: Installed date
1037
+ type: string | nil
1038
+ label:
1039
+ description: Data Asset Request Label
1040
+ type: string
1041
+ migrationSucceededDate:
1042
+ description: Migration Succeeded date
1043
+ type: string | nil
1044
+ numberOfDependencies:
1045
+ description: Number of dependencies associated with workspace asset being
1046
+ tracked in the request
1047
+ type: integer | nil
1048
+ personalOrgId:
1049
+ description: ID of personal org
1050
+ type: string | nil
1051
+ personalOrgWorkspaceId:
1052
+ description: Workspace ID from personal org
1053
+ type: string | nil
1054
+ productionOrgId:
1055
+ description: ID of production org
1056
+ type: string | nil
1057
+ productionOrgWorkspaceId:
1058
+ description: Workspace ID from production org
1059
+ type: string | nil
1060
+ rejectionComment:
1061
+ description: Rejection Comment
1062
+ type: string | nil
1063
+ requestType:
1064
+ description: Type of the request
1065
+ type: string
1066
+ enum:
1067
+ - Promotion
1068
+ - Reuse
1069
+ requestedBy:
1070
+ description: The user who requested this request
1071
+ type: AnalyticsUserRepresentation
1072
+ requestedDate:
1073
+ description: Requested date
1074
+ type: string
1075
+ requesterComment:
1076
+ description: Requester Comment
1077
+ type: string
1078
+ sourceRequestId:
1079
+ description: Data Asset Request Source Id
1080
+ type: string | nil
1081
+ status:
1082
+ description: Data Asset Request Status
1083
+ type: string
1084
+ enum:
1085
+ - Accepted
1086
+ - Cancelled
1087
+ - Completed
1088
+ - Extracting
1089
+ - ExtractionComplete
1090
+ - Failed
1091
+ - ManageAccess
1092
+ - ManageCsv
1093
+ - ManageDataPolicy
1094
+ - MarkAcceptedOrRejected
1095
+ - MarkComplete
1096
+ - Migrating
1097
+ - MigrationSucceeded
1098
+ - Rejected
1099
+ - Requested
1100
+ - ReviewContent
1101
+ targetRequestId:
1102
+ description: Data Asset Request Target Id
1103
+ type: string | nil
1104
+ workspaceAssetId:
1105
+ description: workspaceAssetId in the workspace
1106
+ type: string
886
1107
 
887
1108
  TableauMarketplaceListingInstallationProgressResponse:
888
1109
  description: Representation of tableau marketplace's listing installation progress
@@ -957,9 +1178,14 @@ types:
957
1178
  library
958
1179
  type: BaseAnalyticsLibraryAssetRepresentation
959
1180
  properties:
960
- previewImage:
961
- description: The icons configured for dashboard template preview
962
- type: AnalyticsLibraryImageRepresentation
1181
+ templateBadge:
1182
+ description: The badge icon configured for template
1183
+ type: string
1184
+ templatePreviews:
1185
+ description: The preview images configured for the template
1186
+ type: array
1187
+ items:
1188
+ type: string
963
1189
  AnalyticsLibraryImageRepresentation:
964
1190
  description: AnalyticsLibrary Image reference representation
965
1191
  type: object
@@ -1179,21 +1405,14 @@ types:
1179
1405
  description: A collection of unified analytics orgs.
1180
1406
  type: object
1181
1407
  properties:
1182
- currentOrg:
1183
- description: Current org.
1184
- type: OrgRepresentation
1185
- orgs:
1186
- description: List of orgs being returned.
1408
+ personalOrgs:
1409
+ description: List of Personal Orgs.
1187
1410
  type: array
1188
1411
  items:
1189
1412
  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
1413
+ productionOrg:
1414
+ description: Production Org.
1415
+ type: OrgRepresentation
1197
1416
  OrgRepresentation:
1198
1417
  description: Unified analytics org representation.
1199
1418
  discriminatorValue: Org
@@ -1202,12 +1421,12 @@ types:
1202
1421
  id:
1203
1422
  description: ID of this org.
1204
1423
  type: string
1424
+ isCurrentOrg:
1425
+ description: Is user currently logged in this org
1426
+ type: boolean
1205
1427
  label:
1206
1428
  description: Named label to display for this org
1207
1429
  type: string
1208
- orgUrl:
1209
- description: URL to display for this org
1210
- type: string
1211
1430
  targetUrl:
1212
1431
  description: URL to switch to this org.
1213
1432
  type: string
@@ -1915,6 +2134,139 @@ types:
1915
2134
  dashboardIdOrApiName:
1916
2135
  type: string
1917
2136
  required: true
2137
+ /data-assets:
2138
+ /requests:
2139
+ get:
2140
+ displayName: getDataAssetRequestCollection
2141
+ description: Gets data asset requests based on query parameters
2142
+ responses:
2143
+ '200':
2144
+ description: Success
2145
+ body:
2146
+ application/json:
2147
+ type: DataAssetRequestCollectionRepresentation
2148
+ queryParameters:
2149
+ assetId:
2150
+ type: string
2151
+ required: false
2152
+ assetType:
2153
+ type: string
2154
+ required: false
2155
+ createdBy:
2156
+ type: string
2157
+ required: false
2158
+ limit:
2159
+ type: integer
2160
+ required: false
2161
+ offset:
2162
+ type: integer
2163
+ required: false
2164
+ orderBy:
2165
+ type: string
2166
+ required: false
2167
+ requestType:
2168
+ type: string
2169
+ required: false
2170
+ searchQueryTerm:
2171
+ type: string
2172
+ required: false
2173
+ sortBy:
2174
+ type: string
2175
+ required: false
2176
+ status:
2177
+ type: string
2178
+ required: false
2179
+ workspaceIdOrApiName:
2180
+ type: string
2181
+ required: false
2182
+ post:
2183
+ displayName: postDataAssetRequest
2184
+ description: Request creation of a task for a data asset
2185
+ responses:
2186
+ '200':
2187
+ description: Success
2188
+ body:
2189
+ application/json:
2190
+ type: DataAssetRequestRepresentation
2191
+ body:
2192
+ application/json:
2193
+ type: DataAssetRequestInputRepresentation
2194
+ # required: false # TODO Hand-rolled W-17118037 not supported
2195
+ (oas-body-name): dataAssetRequestInput
2196
+ /count:
2197
+ get:
2198
+ displayName: getDataAssetRequestCount
2199
+ description: Gets data asset requests count based on query parameters
2200
+ responses:
2201
+ '200':
2202
+ description: Success
2203
+ body:
2204
+ application/json:
2205
+ type: DataAssetRequestCountRepresentation
2206
+ queryParameters:
2207
+ assetId:
2208
+ type: string
2209
+ required: false
2210
+ assetType:
2211
+ type: string
2212
+ required: false
2213
+ createdBy:
2214
+ type: string
2215
+ required: false
2216
+ searchQueryTerm:
2217
+ type: string
2218
+ required: false
2219
+ status:
2220
+ type: string
2221
+ required: false
2222
+ taskType:
2223
+ type: string
2224
+ required: false
2225
+ workspaceIdOrApiName:
2226
+ type: string
2227
+ required: false
2228
+ /{requestIdOrApiName}:
2229
+ get:
2230
+ displayName: getDataAssetRequest
2231
+ description: Get data asset request by Id or Api Name
2232
+ responses:
2233
+ '200':
2234
+ description: Success
2235
+ body:
2236
+ application/json:
2237
+ type: DataAssetRequestRepresentation
2238
+ patch:
2239
+ displayName: patchDataAssetRequest
2240
+ description: Request update of a data asset request
2241
+ responses:
2242
+ '200':
2243
+ description: Success
2244
+ body:
2245
+ application/json:
2246
+ type: DataAssetRequestRepresentation
2247
+ body:
2248
+ application/json:
2249
+ type: DataAssetRequestInputRepresentation
2250
+ (oas-body-name): dataAssetRequestInput
2251
+ uriParameters:
2252
+ requestIdOrApiName:
2253
+ type: string
2254
+ required: true
2255
+ /dependencies:
2256
+ /{assetId}:
2257
+ get:
2258
+ displayName: getDataAssetDependencies
2259
+ description: Gets the dependencies of an Data asset
2260
+ responses:
2261
+ '200':
2262
+ description: Success
2263
+ body:
2264
+ application/json:
2265
+ type: DataAssetDependentCollectionRepresentation
2266
+ uriParameters:
2267
+ assetId:
2268
+ type: string
2269
+ required: true
1918
2270
  /follow/followers/{followerId}/follows:
1919
2271
  post:
1920
2272
  displayName: postFollow
@@ -2039,7 +2391,7 @@ types:
2039
2391
  type: UnifiedAnalyticsLoglinesInputRepresentation
2040
2392
  # required: false # TODO Hand-rolled W-15315791 not supported
2041
2393
  (oas-body-name): loglines
2042
- /orgs/{userName}:
2394
+ /orgs:
2043
2395
  get:
2044
2396
  displayName: getOrg
2045
2397
  description: Get all available Unified Analytics Orgs.
@@ -2049,10 +2401,6 @@ types:
2049
2401
  body:
2050
2402
  application/json:
2051
2403
  type: OrgCollectionRepresentation
2052
- uriParameters:
2053
- userName:
2054
- type: string
2055
- required: true
2056
2404
  /records/{recordId}/shares:
2057
2405
  delete:
2058
2406
  displayName: deleteSetupRecordShareCollection
@@ -28,6 +28,28 @@ types:
28
28
  searchId: queryKey
29
29
  SlackAppInfoRepresentation:
30
30
  (luvio.ttl): 5000
31
+ DataAssetRequestCollectionRepresentation:
32
+ (luvio.ttl): 500
33
+ (luvio.opaque): true
34
+ DataAssetRequestCountRepresentation:
35
+ (luvio.ttl): 500
36
+ (luvio.opaque): true
37
+ DataAssetRequestRepresentation:
38
+ (luvio.ttl): 500
39
+ (luvio.opaque): true
40
+ (luvio.key):
41
+ dataAssetRequestId: id
42
+ DataAssetDependentCollectionRepresentation:
43
+ (luvio.ttl): 500
44
+ (luvio.opaque): true
45
+ DataAssetDependentRepresentation:
46
+ (luvio.ttl): 500
47
+ (luvio.opaque): true
48
+ DataAssetRepresentation:
49
+ (luvio.ttl): 500
50
+ (luvio.opaque): true
51
+ (luvio.key):
52
+ assetId: assetId
31
53
  FollowerCollectionRepresentation:
32
54
  (luvio.ttl): 500
33
55
  (luvio.opaque): true
@@ -195,7 +217,7 @@ types:
195
217
  (luvio.adapter):
196
218
  name: getUniqueFollowerCount
197
219
 
198
- /tableau/orgs/{userName}:
220
+ /tableau/orgs:
199
221
  get:
200
222
  (luvio.adapter):
201
223
  name: getOrg
@@ -358,3 +380,31 @@ types:
358
380
  get:
359
381
  (luvio.adapter):
360
382
  name: getMarketplaceListingInstallationProgress
383
+
384
+ /tableau/data-assets/requests:
385
+ get:
386
+ (luvio.adapter):
387
+ name: getDataAssetRequests
388
+ post:
389
+ (luvio.adapter):
390
+ name: createDataAssetRequest
391
+
392
+ /tableau/data-assets/requests/count:
393
+ get:
394
+ (luvio.adapter):
395
+ name: getDataAssetRequestsCount
396
+
397
+ /tableau/data-assets/requests/{requestIdOrApiName}:
398
+ get:
399
+ (luvio.adapter):
400
+ name: getDataAssetRequestByIdOrApiName
401
+ (luvio.key):
402
+ dataAssetRequestId: urlParams.requestIdOrApiName
403
+ patch:
404
+ (luvio.adapter):
405
+ name: updateDataAssetRequest
406
+
407
+ /tableau/data-assets/dependencies/{assetId}:
408
+ get:
409
+ (luvio.adapter):
410
+ name: getDataAssetDependencies
@@ -1,28 +0,0 @@
1
- import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
2
- export declare const VERSION = "91822a5a0b6152c95ee4b82259676e3b";
3
- export declare function validate(obj: any, path?: string): TypeError | null;
4
- export declare const RepresentationType: string;
5
- export declare function normalize(input: OrgInputRepresentation, existing: OrgInputRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): OrgInputRepresentationNormalized;
6
- export declare const select: () => $64$luvio_engine_FragmentSelection;
7
- export declare function equals(existing: OrgInputRepresentationNormalized, incoming: OrgInputRepresentationNormalized): boolean;
8
- export declare const ingest: $64$luvio_engine_ResourceIngest;
9
- export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: OrgInputRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
10
- /**
11
- * Unified Analytics Org Input Representation
12
- *
13
- * Keys:
14
- * (none)
15
- */
16
- export interface OrgInputRepresentationNormalized {
17
- /** The name of the user to query to orgs for. */
18
- userName: string;
19
- }
20
- /**
21
- * Unified Analytics Org Input Representation
22
- *
23
- * Keys:
24
- * (none)
25
- */
26
- export interface OrgInputRepresentation {
27
- userName: string;
28
- }