@salesforce/lds-adapters-analytics-unifiedanalytics 0.1.0-dev1

package/src/raml/luvio.raml

@@ -0,0 +1,479 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'UnifiedAnalytics'
+(luvio.ttl): 60000
+
+types:
+  AnnotationCollectionRepresentation:
+    (luvio.ttl): 1000
+  AnnotationRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  AssetSlackChannelCollectionRepresentation:
+    (luvio.ttl): 1000
+  AssetSlackChannelRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: id
+  AnalyticsUsersQueryResultsRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      searchId: queryKey
+  SlackAppInfoRepresentation:
+    (luvio.ttl): 5000
+  DataAssetRequestCollectionRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+  DataAssetRequestCountRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+  DataAlertCollectionRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+  DataAlertRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      dataAlertId: id
+  DataAlertRunOutputRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      dataAlertId: id
+  DataAssetRequestRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      dataAssetRequestId: id
+  DataAssetDependentCollectionRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+  DataAssetDependentRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+  DataAssetRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      assetId: assetId
+  FollowerCollectionRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+  FollowedAssetCollectionRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+  FollowedAssetRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      followedAssetId: id
+  FollowerAssetCollectionRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      followerId: followerId
+  FollowerAssetRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      followerId: followerId
+  UniqueFollowerCountRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+  VisualizationRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      name: name
+  VisualizationBundleRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      name: visualization.name
+  DashboardRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      name: name
+  WorkspaceAssetRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      assetId: assetId
+  WorkspaceRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      name: cacheableKey
+  OrgCollectionRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+  LibraryAssetsPreviewOutputCollectionRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  AnalyticsAssetsQueryResultsRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      searchId: queryKey
+  AnalyticsLibraryAssetCollectionOutputRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  SubscriptionDigestConfigOutputRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      userId: userId
+  FlowRepresentation:
+    (luvio.opaque): true
+  UnifiedAnalyticsLogLinesRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  MarketplaceTemplateOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  MarketplaceListingRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  TableauExternalMonitoringEventItemRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  SetupRecordAccessCollectionRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      recordId: recordId
+    (luvio.updateAvailable):
+      name: notifySharesUpdateAvailable
+      parameters:
+        recordId: recordId
+  SetupRecordAccessRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      userOrGroupId: userOrGroupId
+  SetupRecordShareCollectionRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      recordId: recordId
+  SetupRecordShareErrorRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+  SetupRecordShareRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+  SFDriveCredentialRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      fullyQualifiedLocationInDrive: fullyQualifiedLocationInDrive
+
+/tableau/admin/monitoring/events:
+  post:
+    (luvio.adapter):
+      name: publish
+
+/tableau/annotations:
+  get:
+    (luvio.adapter):
+      name: getAnnotations
+  post:
+    (luvio.adapter):
+      name: createAnnotation
+
+/tableau/slack/channels:
+  get:
+    (luvio.adapter):
+      name: getAssetSlackChannels
+  post:
+    (luvio.adapter):
+      name: createAssetSlackChannel
+
+/tableau/annotations/slack-app-info:
+  get:
+    (luvio.adapter):
+      name: getSlackAppInfo
+
+/tableau/dashboards:
+  get:
+    (luvio.adapter):
+      name: getDashboards
+  post:
+    (luvio.adapter):
+      name: createDashboard
+
+/tableau/loglines:
+  post:
+    (luvio.adapter):
+      name: createLoglines
+
+/tableau/follow/followers/{followerId}/follows:
+  post:
+    (luvio.adapter):
+      name: follow
+  patch:
+    (luvio.adapter):
+      name: updateFollowedAsset
+
+/tableau/follow/followers/{followerId}/follows/{followedAssetId}:
+  delete:
+    (luvio.adapter):
+      name: unfollow
+    (luvio.key):
+      followedAssetId: urlParams.followedAssetId
+
+/tableau/follow/assets/{followedAssetId}/followers:
+  get:
+    (luvio.adapter):
+      name: getFollowers
+
+/tableau/follow/followers/{followerId}/followed-assets:
+  get:
+    (luvio.adapter):
+      name: getFollowedAssets
+
+/tableau/follow/assets/{followedAssetId}/follower-count:
+  get:
+    (luvio.adapter):
+      name: getUniqueFollowerCount
+
+/tableau/orgs:
+  get:
+    (luvio.adapter):
+      name: getOrg
+
+/tableau/records/{recordId}/shares:
+  get:
+    (luvio.adapter):
+      name: getShares
+    (luvio.key):
+      recordId: urlParams.recordId
+
+  delete:
+    (luvio.adapter):
+      name: deleteAllShares
+    (luvio.key):
+      recordId: urlParams.recordId
+
+  post:
+    (luvio.adapter):
+      name: createRecordShares
+
+  patch:
+    (luvio.adapter):
+      name: updateRecordShares
+
+/tableau/records/{recordId}/shares/{userOrGroupId}:
+  delete:
+    (luvio.adapter):
+      name: deleteRecordShare
+    (luvio.key):
+      recordId: urlParams.recordId
+      userOrGroupId: urlParams.userOrGroupId
+
+/tableau/workspaces:
+  get:
+    (luvio.adapter):
+      name: getWorkspaces
+  post:
+    (luvio.adapter):
+      name: createWorkspace
+
+/tableau/workspaces/{workspaceIdOrApiName}:
+  delete:
+    (luvio.adapter):
+      name: deleteWorkspace
+    (luvio.key):
+      name: urlParams.workspaceIdOrApiName
+  get:
+    (luvio.adapter):
+      name: getWorkspaceByIdOrName
+    (luvio.key):
+      name: urlParams.workspaceIdOrApiName
+  patch:
+    (luvio.adapter):
+      name: updateWorkspace
+
+/tableau/workspaces/{workspaceIdOrApiName}/assets:
+  post:
+    (luvio.adapter):
+      name: createWorkspaceAsset
+
+/tableau/workspaces/{workspaceIdOrApiName}/assets/{assetId}:
+  delete:
+    (luvio.adapter):
+      name: deleteWorkspaceAsset
+    (luvio.key):
+      assetId: urlParams.assetId
+
+/tableau/dashboards/{dashboardIdOrApiName}:
+  get:
+    (luvio.adapter):
+      name: getDashboardByName
+    (luvio.key):
+      name: urlParams.dashboardIdOrApiName
+  patch:
+    (luvio.adapter):
+      name: updateDashboard
+  delete:
+    (luvio.adapter):
+      name: deleteDashboard
+    (luvio.key):
+      name: urlParams.dashboardIdOrApiName
+
+/tableau/visualizations:
+  get:
+    (luvio.adapter):
+      name: getVisualizations
+  post:
+    (luvio.adapter):
+      name: createVisualization
+
+/tableau/visualizations/{visualizationIdOrApiName}:
+  get:
+    (luvio.adapter):
+      name: getVisualization
+    (luvio.key):
+      name: urlParams.visualizationIdOrApiName
+  delete:
+    (luvio.adapter):
+      name: deleteVisualization
+    (luvio.key):
+      name: urlParams.visualizationIdOrApiName
+  patch:
+    (luvio.adapter):
+      name: updateVisualization
+
+/tableau/visualizations/{visualizationIdOrApiName}/bundle:
+  get:
+    (luvio.adapter):
+      name: getVisualizationBundle
+    (luvio.key):
+      name: urlParams.visualizationIdOrApiName
+
+/tableau/assets/query:
+  post:
+    (luvio.adapter):
+      name: queryAssets
+
+/tableau/users/query:
+  post:
+    (luvio.adapter):
+      name: queryUsers
+
+/tableau/flows:
+  get:
+    (luvio.adapter):
+      name: getFlows
+
+/tableau/flows/{flowApiName}:
+  get:
+    (luvio.adapter):
+      name: getFlowByName
+
+/tableau/library/assets/query:
+  post:
+    (luvio.adapter):
+      name: getUnifiedAnalyticsLibraryAssets
+
+/tableau/subscriptions/digest/{digestConfigOwner}:
+  get:
+    (luvio.adapter):
+      name: getSubscriptionDigestConfig
+    (luvio.key):
+      userId: urlParams.digestConfigOwner
+  patch:
+    (luvio.adapter):
+      name: updateSubscriptionDigestConfig
+
+/ssot/sf-drive/actions/generate-credential:
+  post:
+    (luvio.adapter):
+      name: generateSFDriveCredentials
+
+/tableau/marketplace/listings/{listingId}/install:
+  get:
+    (luvio.adapter):
+      name: initiateMarketplaceListingInstallation
+
+/tableau/marketplace/installations/{installationId}:
+  get:
+    (luvio.adapter):
+      name: getMarketplaceListingInstallationProgress
+
+/tableau/marketplace/templates:
+  post:
+    (luvio.adapter):
+      name: createTemplate
+
+/tableau/dataAlerts:
+  get:
+    (luvio.adapter):
+      name: getDataAlertCollection
+  post:
+    (luvio.adapter):
+      name: createDataAlert
+
+/tableau/dataAlerts/{dataAlertId}:
+  get:
+    (luvio.adapter):
+      name: getDataAlert
+    (luvio.key):
+      dataAlertId: urlParams.dataAlertId
+  delete:
+    (luvio.adapter):
+      name: deleteDataAlert
+    (luvio.key):
+      dataAlertId: urlParams.dataAlertId
+  put:
+    (luvio.adapter):
+      name: updateDataAlert
+/tableau/dataAlerts/{dataAlertId}/run:
+  post:
+    (luvio.adapter):
+      name: postDataAlertRun
+/tableau/data-assets/requests:
+  get:
+    (luvio.adapter):
+      name: getDataAssetRequests
+  post:
+    (luvio.adapter):
+      name: createDataAssetRequest
+
+/tableau/data-assets/requests/count:
+  get:
+    (luvio.adapter):
+      name: getDataAssetRequestsCount
+
+/tableau/data-assets/requests/{requestIdOrApiName}:
+  get:
+    (luvio.adapter):
+      name: getDataAssetRequestByIdOrApiName
+    (luvio.key):
+      dataAssetRequestId: urlParams.requestIdOrApiName
+  patch:
+    (luvio.adapter):
+      name: updateDataAssetRequest
+
+/tableau/data-assets/dependencies/{assetId}:
+  get:
+    (luvio.adapter):
+      name: getDataAssetDependencies
+/tableau/marketplace/listings:
+  post:
+    (luvio.adapter):
+      name: publishToMarketplace