@salesforce/lds-adapters-analytics-unifiedanalytics 1.380.0-dev2 → 1.380.0-dev22

package/src/raml/api.raml

@@ -530,7 +530,7 @@ types:
         description: List of visualizations being returned.
         type: array
         items:
-          type: VisualizationRepresentation
+          type: VisualizationShallowRepresentation
   VisualizationInputRepresentation:
     description: Unified Analytics Visualization Input Representation
     type: object
@@ -588,6 +588,63 @@ types:
         required: false
         items:
           type: any
+  AnalyticsVersionRepresentation:
+    description: Unified analytics version representation.
+    type: object
+    properties:
+      major:
+        description: Major version of the visualization.
+        type: integer
+      minor:
+        description: Minor version of the visualization.
+        type: integer
+  VisualizationShallowRepresentation:
+    description: Unified analytics visualization shallow representation with base properties only.
+    discriminator: name # TODO Hand-rolled W-15315791: invalid inheritance
+    type: object # TODO Hand-rolled W-15315791: invalid inheritance
+    properties:
+      id:
+        description: Visualization id.
+        type: string
+      description:
+        description: Description of the asset.
+        type: string
+        required: false
+      label:
+        description: Label of the asset.
+        type: string
+      name:
+        description: Name of the asset.
+        type: string
+      createdBy:
+        description: Created by of the asset.
+        type: AnalyticsUserRepresentation
+      createdDate:
+        description: Created date of the asset
+        type: string
+      lastModifiedBy:
+        description: Last modified by of the asset.
+        type: AnalyticsUserRepresentation
+        required: false
+      lastModifiedDate:
+        description: Last modified date of the asset.
+        type: string
+        required: false
+      dataSource:
+        description: Datasource of this visualization.
+        type: object
+        properties:
+          //:
+            type: any
+      workspace:
+        description: The workspace name the visualization belongs to.
+        type: object
+        properties:
+          //:
+            type: any
+      sourceVersion:
+        description: Api version of the visualization.
+        type: AnalyticsVersionRepresentation
   VisualizationRepresentation:
     description: Unified analytics visualization representation.
     discriminator: name # TODO Hand-rolled W-15315791: invalid inheritance
@@ -658,6 +715,9 @@ types:
         required: false
         items:
           type: any
+      sourceVersion:
+        description: Api version of the visualization.
+        type: AnalyticsVersionRepresentation
   VisualizationBundleRepresentation:
     description: Unified analytics visualization with additional information.
     type: object
@@ -1010,6 +1070,23 @@ types:
         description: Id of the workspace which the DataAsset is part of
         type: string
         required: false
+      synchronizationStatus:
+        description: Synchronization status of the DataAsset
+        type: string
+        enum:
+          - SYNC
+          - NEW
+        required: false
+      createdWorkspace:
+        description: Workspace where the DataAsset was created
+        type: string
+        required: false
+      dataSpaceInfo:
+        description: List of DataSpace Info
+        type: array
+        items:
+          type: DataSpaceInfoRepresentation
+        required: false
   DataAssetRequestCollectionRepresentation:
     description: Collection of Data Asset Requests
     type: object
@@ -1040,7 +1117,7 @@ types:
         type: integer
       nextPageUrl:
         description: Next page url for pagination.
-        type: string
+        type: string | nil
   DataAlertValueInputRepresentation:
     description: Abstract input representation for operands
     type: object
@@ -1277,11 +1354,14 @@ types:
     description: A top level data alert metadata representation.
     type: object
     properties:
-      analysisUtterance:
-        description: user entered utterance for generating analysis.
-        type: string
       content:
         type: DataAlertContentInputRepresentation # TODO Hand-rolled @W-17927490
+      dataAlertType:
+        description: Type of data alert
+        type: string
+        enum:
+          - AgentHealthMonitoring
+          - AgentPowered
       deliveryConfigurations:
         type: DataAlertDeliveryConfigurationInputRepresentation # TODO Hand-rolled @W-17927490
       schedule:
@@ -1313,7 +1393,9 @@ types:
         description: delivery type
         type: string
         enum:
+          - Email
           - Notification
+          - Slack
   DataAlertScheduleInputRepresentation:
     description: Input representation for data alert schedule
     discriminator: type
@@ -1324,6 +1406,7 @@ types:
         type: array
         items:
           type: integer
+        required: false
       type:
         description: schedule type
         type: string
@@ -1331,6 +1414,15 @@ types:
           - Cron
           - Daily
           - Weekly
+          - EveryNMinutes
+  DataAlertEveryNMinutesScheduleInputRepresentation:
+    description: Input representation for an every N minutes alert schedule
+    type: DataAlertScheduleInputRepresentation
+    discriminatorValue: EveryNMinutes
+    properties:
+      minuteLevelFrequency:
+        description: Frequency in minutes at which to run the data alert
+        type: integer
   DataAlertThresholdsInputRepresentation:
     description: Data alert thresholds input representation.
     type: object
@@ -1397,6 +1489,13 @@ types:
     description: Represents the daily schedule for a data alert
     type: DataAlertScheduleRepresentation
     properties: {}
+  DataAlertEveryNMinutesScheduleRepresentation:
+    description: Represents the every N minutes schedule for a data alert
+    type: DataAlertScheduleRepresentation
+    properties:
+      minuteLevelFrequency:
+        description: Frequency in minutes at which to run the data alert
+        type: integer
   DataAlertDeliveryConfigurationRepresentation:
     description: Represents the delivery configuration for a data alert
     type: object
@@ -1487,7 +1586,9 @@ types:
         description: delivery type
         type: string
         enum:
+          - Email
           - Notification
+          - Slack
   DataAlertRepresentation:
     description: Output representation for Data Alert
     discriminatorValue: DataAlert
@@ -1503,9 +1604,21 @@ types:
         description: Notification content configuration. Contains the config needed
           to generate the notification content.
         type: DataAlertContentRepresentation
+      dataAlertType:
+        description: Type of data alert.
+        type: string
+        enum:
+          - AgentHealthMonitoring
+          - AgentPowered
       deliveryConfigurations:
         description: Data alert delivery configurations.
         type: DataAlertDeliveryConfigurationRepresentation
+      createdDate:
+        description: Creation date of the data alert
+        type: string
+      lastModifiedDate:
+        description: Last modified date of the data alert
+        type: string
       schedule:
         description: Data alert schedule.
         type: DataAlertScheduleRepresentation
@@ -1522,6 +1635,7 @@ types:
         type: array
         items:
           type: integer
+        required: false
       type:
         description: Type of schedule
         type: string
@@ -1529,6 +1643,7 @@ types:
           - Cron
           - Daily
           - Weekly
+          - EveryNMinutes
   DataAlertThresholdsRepresentation:
     description: Represents the thresholds for a data alert
     type: object
@@ -1633,6 +1748,17 @@ types:
         description: Workspace id or name of personal org related to the request
         type: string
         required: false
+      packageExportStatus:
+        description: Export status of the promotion metadata package
+        type: string
+        required: false
+        enum:
+          - Accepted
+          - Completed
+          - Failed
+          - Packaging
+          - Ready
+          - Rejected
   DataAssetRequestRepresentation:
     description: Represents a data asset request
     type: object
@@ -1745,6 +1871,35 @@ types:
       workspaceAssetId:
         description: workspaceAssetId in the workspace
         type: string
+      packageExportStatus:
+        description: Export status of the metadata package request
+        type: string | nil
+        enum:
+          - Accepted
+          - Completed
+          - Failed
+          - Packaging
+          - Ready
+          - Rejected
+      packageExportedBy:
+        description: User that last exported the metadata package request
+        type: AnalyticsUserRepresentation | nil
+      packageExportedDate:
+        description: Date and time the metadata package was exported
+        type: string | nil
+  DataSpaceInfoRepresentation:
+    description: DataSpace Info Representation
+    type: object
+    properties:
+      dataSpacePrefix:
+        description: DataSpace prefix.
+        type: string
+      dataSpaceLabel:
+        description: DataSpace label.
+        type: string
+      dataSpaceDeveloperName:
+        description: DataSpace developer name.
+        type: string
   TableauMarketplaceListingInstallationProgressResponse:
     description: Representation of tableau marketplace's listing installation progress
     type: object
@@ -2139,6 +2294,41 @@ types:
       recordId:
         description: Id for record
         type: string
+      orderBy:
+        description: Order By value for response
+        type: string
+        required: true
+        enum:
+          - createddate
+          - userdisplayname
+      sortOrder:
+        description: Sort Order value for response
+        type: string
+        required: true
+        enum:
+          - DESC
+          - ASC
+      filterByRecipientType:
+        description: recipient filter value, default is none
+        type: array
+        required: true
+        items:
+          type: string
+          enum:
+            - User
+            - Group
+      filterByUserOrGroupId:
+        description: Id of the User/Group
+        type: string | nil
+        required: true
+      offset:
+        description: Offset parameter value
+        type: integer
+        required: true
+      limit:
+        description: Limit parameter value
+        type: integer
+        required: true
   SetupRecordAccessInputRepresentation:
     description: User Or Role Access Input Representation
     type: object
@@ -2148,6 +2338,10 @@ types:
         type: array
         items:
           type: any
+      sendNotificationToRecipients:
+        description: check for sending notification to recipients
+        type: boolean
+        required: false
   SetupRecordAccessItemInputRepresentation:
     description: Record Access Item Input Representation
     type: object
@@ -2199,6 +2393,10 @@ types:
         description: Username of the User
         type: string
         required: false
+      groupMemberCount:
+        description: Count of users in group
+        type: integer
+        required: false
   SetupRecordAccessRepresentation:
     description: Record Access mapping for specific  UserOrGroup
     discriminatorValue: RecordAccessMappingForUserOrGroup
@@ -3104,6 +3302,11 @@ types:
         get:
           displayName: getDataAssetDependencies
           description: Gets the dependencies of an Data asset
+          queryParameters:
+            includeSynchronizationInfo:
+              type: boolean
+              required: false
+              description: Include synchronization information in the response
           responses:
             '200':
               description: Success
@@ -3268,6 +3471,21 @@ types:
       responses:
         '200':
           description: Success
+      queryParameters:
+        userOrGroupId:
+          type: string | nil
+          required: false
+        orderBy:
+          type: string
+          required: false
+        sortOrder:
+          type: string
+          required: false
+        filterByRecipientType:
+          type: array
+          required: false
+          items:
+            type: string
     get:
       displayName: getSetupRecordShareCollection
       description: Get record shares for requested registered grantee for a record
@@ -3292,8 +3510,8 @@ types:
           type: string
           required: false
           enum:
-            - CreatedDate
-            - UserDisplayName
+            - createddate
+            - userdisplayname
         sortOrder:
           description: Sort Order value, default is descending
           type: string
@@ -3301,6 +3519,20 @@ types:
           enum:
             - DESC
             - ASC
+        filterByRecipientType:
+          description: recipient filter value, default is none
+          type: array
+          required: false
+          items:
+            type: string
+            enum:
+              - User
+              - Group
+        recipientSearchTerm:
+          description: Search term parameter value
+          type: string
+          required: false
+
     patch:
       displayName: patchSetupRecordShareCollection
       description: Update an record share to be associated with a record Item
@@ -3631,6 +3863,9 @@ types:
         offset:
           type: integer
           required: false
+        searchTerm:
+          type: string
+          required: false
   /flows/{flowApiName}:
     get:
       displayName: getFlowByName

package/src/raml/luvio.raml

@@ -36,6 +36,7 @@ types:
     (luvio.opaque): true
   DataAlertCollectionRepresentation:
     (luvio.ttl): 500
+    (luvio.opaque): true
   DataAlertRepresentation:
     (luvio.ttl): 500
     (luvio.opaque): true
@@ -85,6 +86,10 @@ types:
   UniqueFollowerCountRepresentation:
     (luvio.ttl): 500
     (luvio.opaque): true
+  VisualizationShallowRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      name: name
   VisualizationRepresentation:
     (luvio.opaque): true
     (luvio.key):
@@ -155,6 +160,18 @@ types:
     (luvio.opaque): true
     (luvio.key):
       recordId: recordId
+      filterByUserOrGroupId: filterByUserOrGroupId
+      orderBy: orderBy
+      sortOrder: sortOrder
+      filterByRecipientType: filterByRecipientType
+    (luvio.updateAvailable):
+      name: notifySharesUpdateAvailable
+      parameters:
+        recordId: recordId
+        filterByUserOrGroupId: filterByUserOrGroupId
+        orderBy: orderBy
+        sortOrder: sortOrder
+        filterByRecipientType: filterByRecipientType
   SetupRecordAccessRepresentation:
     (luvio.ttl): 500
     (luvio.opaque): true
@@ -257,12 +274,20 @@ types:
       name: getShares
     (luvio.key):
       recordId: urlParams.recordId
+      filterByUserOrGroupId: queryParams.userOrGroupId || null
+      orderBy: queryParams.orderBy?.toLowerCase() || 'createddate'
+      sortOrder: queryParams.sortOrder || 'DESC'
+      filterByRecipientType: queryParams.filterByRecipientType || []
 
   delete:
     (luvio.adapter):
       name: deleteAllShares
     (luvio.key):
       recordId: urlParams.recordId
+      filterByUserOrGroupId: queryParams.userOrGroupId || null
+      orderBy: queryParams.orderBy?.toLowerCase() || 'createddate'
+      sortOrder: queryParams.sortOrder || 'DESC'
+      filterByRecipientType: queryParams.filterByRecipientType || []
 
   post:
     (luvio.adapter):