@salesforce/lds-adapters-analytics-unifiedanalytics 1.387.0 → 1.389.0

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
@@ -2156,6 +2216,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
@@ -2220,6 +2315,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
@@ -2247,11 +2346,6 @@ types:
       createdDate:
         description: Created Date
         type: string
-      groupMemberCount:
-        description: Count for groupMembers
-        type: integer
-        required: false
-
   SetupRecordShareCollectionRepresentation:
     description: A collection of shares for a record
     type: object
@@ -3299,6 +3393,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
@@ -3341,6 +3450,11 @@ types:
             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

package/src/raml/luvio.raml

@@ -86,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):
@@ -156,10 +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
@@ -262,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):