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

package/src/raml/api.raml

@@ -177,6 +177,9 @@ types:
       workspace?:
         description: The workspace of the asset.
         type: AnalyticsAssetsQueryResultsWorkspaceRepresentation | nil
+      assetParentIdentifier?:
+        description: Id of an asset's parent
+        type: string | nil
   AnalyticsAssetsQueryInputRepresentation:
     description: Unified Analytics Assets Query Input Representation
     type: object
@@ -287,18 +290,23 @@ types:
       searchTerm:
         description: Search term parameter value
         type: string
+        required: false
       userCapability:
         description: User permission
         type: string
+        required: false
       useAutoSuggest:
         description: Use auto suggest term parameter value
         type: boolean
+        required: false
       limit:
         description: Limit parameter value
         type: integer
+        required: false
       offset:
         description: Offset parameter value
         type: integer
+        required: false
   AnalyticsUsersQueryResultsRepresentation:
     description: Results of Users Query
     type: object
@@ -1022,6 +1030,21 @@ types:
       count:
         description: Count of data asset requests
         type: integer
+  DataAlertCollectionRepresentation:
+    description: A collection of unified analytics data alerts.
+    type: object
+    properties:
+      dataAlerts:
+        description: List of data alerts being returned.
+        type: array
+        items:
+          type: DataAlertRepresentation
+      totalSize:
+        description: Total size of data alert array returned.
+        type: integer
+      nextPageUrl:
+        description: Next page url for pagination.
+        type: string | nil
   DataAlertValueInputRepresentation:
     description: Abstract input representation for operands
     type: object
@@ -1262,13 +1285,6 @@ types:
         type: array
         items:
           type: DataAlertReceiversInputRepresentation
-  DataAlertRepresentation:
-    description: Output of Data Alert
-    type: object
-    properties:
-      id:
-        description: Database record id of the data alert.
-        type: string
   DataAlertInputRepresentation:
     description: A top level data alert metadata representation.
     type: object
@@ -1339,6 +1355,238 @@ types:
       customLogicalOperation:
         description: logical operations between conditions
         type: string
+  DataAlertRunOutputRepresentation:
+    description: Output of running a Data Alert
+    type: object
+    properties:
+      executedAt:
+        description: Timestamp when the data alert was executed.
+        type: string
+      id:
+        description: Database record id of the data alert.
+        type: string
+      triggered:
+        description: Whether the data alert was triggered by this run.
+        type: boolean
+  DataAlertConditionRepresentation:
+    description: Represents a condition for a data alert
+    type: object
+    properties:
+      leftOperand:
+        description: Left operand of the condition
+        type: DataAlertValueRepresentation
+      operator:
+        description: Operator for the condition
+        type: string
+        enum:
+          - Equals
+          - GreaterOrEqual
+          - GreaterThan
+          - LessOrEqual
+          - LessThan
+          - NotEqual
+      rightOperand:
+        description: Right operand of the condition
+        type: DataAlertValueRepresentation
+  DataAlertContentRepresentation:
+    description: Represents the content for a data alert
+    type: object
+    discriminator: type
+    properties:
+      type:
+        description: Type of content
+        type: string
+        enum:
+          - Metric
+  DataAlertCronScheduleRepresentation:
+    description: Represents the cron schedule for a data alert
+    type: DataAlertScheduleRepresentation
+    properties:
+      cronExpression:
+        description: Cron expression for the schedule
+        type: string
+  DataAlertDailyScheduleRepresentation:
+    description: Represents the daily schedule for a data alert
+    type: DataAlertScheduleRepresentation
+    properties: {}
+  DataAlertDeliveryConfigurationRepresentation:
+    description: Represents the delivery configuration for a data alert
+    type: object
+    properties:
+      receivers:
+        description: Receivers for the data alert
+        type: array
+        items:
+          type: DataAlertReceiversRepresentation
+  DataAlertMetricContentRepresentation:
+    description: Represents the metric content for a data alert
+    type: DataAlertContentRepresentation
+    properties:
+      instruction:
+        description: Instructions to generate notification content
+        type: string
+      modelApiNameOrId:
+        description: Id or API name of the semantic data model
+        type: array
+        items:
+          type: string
+  DataAlertMetricValueRepresentation:
+    description: Represents a metric value for a data alert condition
+    type: DataAlertValueRepresentation
+    properties:
+      factKey:
+        description: fact key
+        type: string
+      filterContext:
+        description: filter context
+        type: array
+        items:
+          type: UnifiedFilterRepresentation
+      insightType:
+        description: type of insight
+        type: string
+        enum:
+          - GoalProgress
+          - Popc
+          - RecordLevelOutliers
+          - RiskyMonopoly
+          - Unspecified
+          - UnusualChange
+      metricId:
+        description: metric or sub-metric Id
+        type: string
+      modelApiNameOrId:
+        description: Id or API name of the semantic data model
+        type: string
+      params:
+        description: additional metric params
+        type: object
+        properties:
+          //:
+            type: string
+      timeContext:
+        description: time filter
+        type: UnifiedFilterRepresentation
+  DataAlertNotificationRecipientsRepresentation:
+    description: Represents notification recipients for a data alert
+    type: DataAlertReceiversRepresentation
+    properties:
+      recipients:
+        description: list of notification recipients
+        type: array
+        items:
+          type: string
+  DataAlertRawValueRepresentation:
+    description: Represents a raw value for a data alert condition
+    type: DataAlertValueRepresentation
+    properties:
+      dataType:
+        description: Data type of the raw value
+        type: string
+        enum:
+          - Number
+          - Percent
+          - Text
+      value:
+        description: Raw value
+        type: string
+  DataAlertReceiversRepresentation:
+    description: Represents receivers for a data alert
+    type: object
+    discriminator: type
+    properties:
+      type:
+        description: delivery type
+        type: string
+        enum:
+          - Notification
+  DataAlertRepresentation:
+    description: Output representation for Data Alert
+    discriminatorValue: DataAlert
+    type: object #Hand-rolled W-18183450: invalid inheritance
+    properties:
+      id:
+        description: ID of the Data Alert
+        type: string
+      alertName:
+        description: User entered alert name.
+        type: string
+      content:
+        description: Notification content configuration. Contains the config needed
+          to generate the notification content.
+        type: DataAlertContentRepresentation
+      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
+      thresholds:
+        description: Thresholds to be evaluated.
+        type: DataAlertThresholdsRepresentation
+  DataAlertScheduleRepresentation:
+    description: Represents the schedule for a data alert
+    type: object
+    discriminator: type
+    properties:
+      hoursOfDay:
+        description: Schedule time
+        type: array
+        items:
+          type: integer
+      type:
+        description: Type of schedule
+        type: string
+        enum:
+          - Cron
+          - Daily
+          - Weekly
+  DataAlertThresholdsRepresentation:
+    description: Represents the thresholds for a data alert
+    type: object
+    properties:
+      conditions:
+        description: Conditions for the data alert
+        type: array
+        items:
+          type: DataAlertConditionRepresentation
+      customLogicalOperation:
+        description: Logical operations between conditions
+        type: string
+  DataAlertValueRepresentation:
+    description: Represents a value for a data alert condition
+    discriminator: type
+    type: object
+    properties:
+      type:
+        description: Type of data value
+        type: string
+        enum:
+          - Insights
+          - RawValue
+  DataAlertWeeklyScheduleRepresentation:
+    description: Represents the weekly schedule for a data alert
+    type: DataAlertScheduleRepresentation
+    properties:
+      daysOfWeek:
+        description: Days of the week for the schedule
+        type: array
+        items:
+          type: string
+          enum:
+            - Friday
+            - Monday
+            - Saturday
+            - Sunday
+            - Thursday
+            - Tuesday
+            - Wednesday
   DataAssetRequestInputRepresentation:
     description: DataAssetRequest input representation in unified analytics.
     type: object
@@ -1922,6 +2170,30 @@ types:
       userOrGroupId:
         description: Id of the User/Group
         type: string
+  SetupRecordShareUserOrGroupRepresentation:
+    description: User or Group Representation
+    type: object
+    properties:
+      id:
+        description: Id of the User or Group
+        type: string
+        required: false
+      displayName:
+        description: Display name of the User or Group
+        type: string
+        required: false
+      profilePhotoUrl:
+        description: Profile Photo URL of the User
+        type: string
+        required: false
+      email:
+        description: Email of the User
+        type: string
+        required: false
+      username:
+        description: Username of the User
+        type: string
+        required: false
   SetupRecordAccessRepresentation:
     description: Record Access mapping for specific  UserOrGroup
     discriminatorValue: RecordAccessMappingForUserOrGroup
@@ -1943,6 +2215,12 @@ types:
       userOrGroupId:
         description: User/Group Id
         type: string
+      userOrGroup:
+        description: User/Group
+        type: SetupRecordShareUserOrGroupRepresentation
+      createdDate:
+        description: Created Date
+        type: string
   SetupRecordShareCollectionRepresentation:
     description: A collection of shares for a record
     type: object
@@ -2238,6 +2516,21 @@ types:
         type: array
         items:
           type: any
+  UnifiedFilterRepresentation:
+    description: Unified filter representation.
+    type: object
+    properties:
+      fieldName:
+        description: fieldName
+        type: string
+      operator:
+        description: operator
+        type: string
+      values:
+        description: values
+        type: array
+        items:
+          type: object
   UpdateSetupRecordAccessInputRepresentation:
     description: Update record share input representation
     type: object
@@ -2594,6 +2887,25 @@ types:
         type: string
         required: true
   /dataAlerts:
+    get:
+      displayName: getDataAlertCollection
+      description: Get all available Data Alerts.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataAlertCollectionRepresentation
+      queryParameters:
+        ownerId:
+          type: string
+          required: true
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
     post:
       displayName: postDataAlertCollection
       description: Create a new data alert.
@@ -2613,6 +2925,21 @@ types:
           type: DataAlertInputRepresentation
           (oas-body-name): dataAlert
   /dataAlerts/{dataAlertId}:
+    get:
+      displayName: getDataAlertCollection
+      description: Get all available Data Alerts.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataAlertRepresentation
+    delete:
+      displayName: deleteDataAlert
+      description: Delete a data alert
+      responses:
+        '200':
+          description: Success
     put:
       displayName: updateDataAlert
       description: update a data alert
@@ -2635,6 +2962,20 @@ types:
       dataAlertId:
         type: string
         required: true
+  /dataAlerts/{dataAlertId}/run:
+    post:
+      displayName: postDataAlertRun
+      description: Run a data alert immediately.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataAlertRunOutputRepresentation
+    uriParameters:
+      dataAlertId:
+        type: string
+        required: true
   /data-assets:
     /requests:
       get:
@@ -2941,6 +3282,20 @@ types:
         userOrGroupId:
           type: string
           required: false
+        orderBy:
+          description: Order By value, default is Created Date
+          type: string
+          required: false
+          enum:
+            - CreatedDate
+            - UserDisplayName
+        sortOrder:
+          description: Sort Order value, default is descending
+          type: string
+          required: false
+          enum:
+            - DESC
+            - ASC
     patch:
       displayName: patchSetupRecordShareCollection
       description: Update an record share to be associated with a record Item

package/src/raml/luvio.raml

@@ -34,11 +34,18 @@ types:
   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
@@ -405,15 +412,31 @@ types:
       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):