@salesforce/lds-adapters-analytics-unifiedanalytics 1.332.0-dev17 → 1.332.0-dev18

package/src/raml/api.raml

@@ -340,6 +340,30 @@ types:
         description: Time Range filter representation
         type: FollowedTimeRangeRepresentation
         required: false
+  UpdateFollowedAssetInputRepresentation:
+    description: Update followed asset input representation in unified analytics.
+    type: object
+    properties:
+      assetId:
+        description: Asset ID
+        type: string
+      assetType:
+        description: Followed asset type
+        type: string
+        enum:
+          - SemanticMetricDefinition
+          - SemanticSubMetric
+        required: false
+      followerType:
+        description: Follower type
+        type: string
+        enum:
+          - Group
+          - User
+        required: false
+      followedTimeRange:
+        description: Time Range filter representation
+        type: FollowedTimeRangeRepresentation
   FollowedAssetCollectionRepresentation:
     description: Collection of Followed Assets
     type: object
@@ -994,6 +1018,323 @@ types:
       count:
         description: Count of data asset requests
         type: integer
+  DataAlertValueInputRepresentation:
+    description: Abstract input representation for operands
+    type: object
+    discriminator: type
+    properties:
+      type:
+        description: type of operand
+        type: string
+        enum:
+          - Insights
+          - RawValue
+  DataAlertValueRightOperandInputRepresentation:
+    description: Abstract input representation for operands
+    type: object
+    discriminator: type
+    properties:
+      type:
+        description: type of operand
+        type: string
+        enum:
+          - Insights
+          - RawValue
+  DataAlertRawValueInputRepresentation:
+    description: Abstract input representation for raw value operands
+    type: DataAlertValueInputRepresentation
+    discriminatorValue: RawValue
+    properties:
+      dataType:
+        description: 'data types for the raw value: percentage, currency etc. '
+        type: string
+        enum:
+          - Number
+          - Currency
+          - Percentage
+      value:
+        description: raw value of the operand
+        type: string
+  DataAlertMetricValueInputRepresentation:
+    description: Input representation for metric operands
+    type: DataAlertValueInputRepresentation
+    discriminatorValue: Insights
+    properties:
+      metricId:
+        description: metric or sub-metric Id
+        type: string
+      insightType:
+        description: type of insight
+        type: string
+        enum:
+          - GoalProgress
+          - Popc
+          - RecordLevelOutliers
+          - RiskyMonopoly
+          - Unspecified
+          - UnusualChange
+      params:
+        description: additional metric params
+        type: object
+        properties:
+          //:
+            type: string
+      factKey:
+        description: fact key
+        type: string
+      timeContext:
+        description: time filter
+        type: UnifiedFilterInputRepresentation # TODO Hand-rolled @W-17927490
+      filterContext:
+        description: filter context
+        type: array
+        items:
+          type: UnifiedFilterInputRepresentation # TODO Hand-rolled @W-17927490
+      modelApiNameOrId:
+        description: Id or API name of the semantic data model
+        type: string
+      sdmId:
+        description: SDM ID of the semantic data model
+        type: string
+  UnifiedFilterInputRepresentation:
+    description: Message representing the Unified Filter.
+    type: object
+    properties:
+      fieldName:
+        description: FieldName
+        type: string
+        required: false
+      operator:
+        enum:
+          - Equals
+          - DoesNotEquals
+          - EqualsIgnoreCase
+          - DoesNotEqualsIgnoreCase
+          - Between
+          - LessThan
+          - LessThanOrEqualTo
+          - GreaterThan
+          - GreaterThanOrEqualTo
+          - IsEmpty
+          - IsNotEmpty
+          - Contains
+          - ContainsIgnoreCase
+          - NotContains
+          - NotContainsIgnoreCase
+          - StartsWith
+          - StartsWithIgnoreCase
+          - DoesNotStartWith
+          - DoesNotStartWithIgnoreCase
+          - EndsWith
+          - EndsWithIgnoreCase
+          - DoesNotEndWith
+          - DoesNotEndWithIgnoreCase
+          - IsNull
+          - IsNotNull
+          - LastNDays
+          - NextNDays
+          - PreviousWeek
+          - CurrentWeek
+          - NextWeek
+          - PreviousMonth
+          - CurrentMonth
+          - NextMonth
+          - PreviousQuarter
+          - CurrentQuarter
+          - NextQuarter
+          - PreviousYear
+          - CurrentYear
+          - NextYear
+          - PreviousFiscalQuarter
+          - CurrentFiscalQuarter
+          - NextFiscalQuarter
+          - PreviousFiscalYear
+          - CurrentFiscalYear
+          - NextFiscalYear
+          - PreviousMonthToDate
+          - CurrentMonthToDate
+          - PreviousQuarterToDate
+          - CurrentQuarterToDate
+          - PreviousYearToDate
+          - CurrentYearToDate
+          - PreviousFiscalQuarterToDate
+          - CurrentFiscalQuarterToDate
+          - PreviousFiscalYearToDate
+          - CurrentFiscalYearToDate
+          - Values
+        type: string
+        (amf-format): enum
+        required: false
+      values:
+        description: An array of values. All values must be of the same type. We support  strings, numbers, and booleans.
+        type: array
+        items:
+          (amf-xone):
+            - type: number
+            - type: string
+            - type: boolean
+          type: any
+        required: false
+  DataAlertConditionInputRepresentation:
+    description: A single condition representation
+    type: object
+    properties:
+      leftOperand:
+        description: Left operand of the condition
+        type: DataAlertValueInputRepresentation # TODO Hand-rolled @W-17927490
+      rightOperand:
+        description: Right operand of the condition
+        type: DataAlertValueRightOperandInputRepresentation # TODO Hand-rolled @W-17927490
+      operator:
+        description: operator of the condition
+        type: string
+        enum:
+          - Equals
+          - GreaterOrEqual
+          - GreaterThan
+          - LessOrEqual
+          - LessThan
+          - NotEqual
+  DataAlertWeeklyScheduleInputRepresentation:
+    description: Input representation for weekly alert alert schedule
+    type: DataAlertScheduleInputRepresentation
+    discriminatorValue: Weekly
+    properties:
+      daysOfWeek:
+        description: days of the week to receive data alerts
+        type: array
+        items:
+          type: string
+          enum:
+            - Friday
+            - Monday
+            - Saturday
+            - Sunday
+            - Thursday
+            - Tuesday
+            - Wednesday
+  DataAlertContentInputRepresentation:
+    description: Input representation for data alert content
+    type: object
+    discriminator: type
+    properties:
+      type:
+        description: content type
+        type: string
+        enum:
+          - Metric
+  DataAlertMetricContentInputRepresentation:
+    description: Input representation for content based on metric value
+    type: DataAlertContentInputRepresentation
+    discriminatorValue: Metric
+    properties:
+      instruction:
+        description: input string instruction
+        type: string
+      modelApiNameOrId:
+        description: Id or API name of the semantic data model
+        type: array
+        items:
+          type: string
+  DataAlertCronScheduleInputRepresentation:
+    description: Input representation for cron based data alert schedule
+    type: DataAlertScheduleInputRepresentation
+    discriminatorValue: Cron
+    properties:
+      cronExpression:
+        description: cron expression
+        type: string
+  DataAlertDailyScheduleInputRepresentation:
+    description: Input representation for daily alert schedule
+    type: DataAlertScheduleInputRepresentation
+    discriminatorValue: Daily
+    properties: {}
+  DataAlertDeliveryConfigurationInputRepresentation:
+    description: Delivery configuration for data alerts.
+    type: object
+    properties:
+      receivers:
+        description: list of recipients to be notified.
+        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
+    properties:
+      analysisUtterance:
+        description: user entered utterance for generating analysis.
+        type: string
+      content:
+        type: DataAlertContentInputRepresentation # TODO Hand-rolled @W-17927490
+      deliveryConfigurations:
+        type: DataAlertDeliveryConfigurationInputRepresentation # TODO Hand-rolled @W-17927490
+      schedule:
+        description: data alert schedule
+        type: DataAlertScheduleInputRepresentation # TODO Hand-rolled @W-17927490
+      thresholds:
+        description: thresholds to be evaluated
+        type: DataAlertThresholdsInputRepresentation # TODO Hand-rolled @W-17927490
+      utterance:
+        description: user entered utterance
+        type: string
+  DataAlertNotificationRecipientsInputRepresentation:
+    description: 'List of UNS recipients for Data alerts. May contain user or group
+      Ids. '
+    type: DataAlertReceiversInputRepresentation
+    discriminatorValue: Notification
+    properties:
+      recipients:
+        description: group or user Ids
+        type: array
+        items:
+          type: string
+  DataAlertReceiversInputRepresentation:
+    description: Input representation for data alert recipients
+    type: object
+    discriminator: type
+    properties:
+      type:
+        description: delivery type
+        type: string
+        enum:
+          - Notification
+  DataAlertScheduleInputRepresentation:
+    description: Input representation for data alert schedule
+    discriminator: type
+    type: object
+    properties:
+      hoursOfDay:
+        description: schedule time
+        type: array
+        items:
+          type: integer
+      type:
+        description: schedule type
+        type: string
+        enum:
+          - Cron
+          - Daily
+          - Weekly
+  DataAlertThresholdsInputRepresentation:
+    description: Data alert thresholds input representation.
+    type: object
+    properties:
+      conditions:
+        description: list of conditions to be evaluated.
+        type: array
+        items:
+          type: DataAlertConditionInputRepresentation
+      customLogicalOperation:
+        description: logical operations between conditions
+        type: string
   DataAssetRequestInputRepresentation:
     description: DataAssetRequest input representation in unified analytics.
     type: object
@@ -2200,6 +2541,48 @@ types:
       dashboardIdOrApiName:
         type: string
         required: true
+  /dataAlerts:
+    post:
+      displayName: postDataAlertCollection
+      description: Create a new data alert.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataAlertRepresentation
+      queryParameters:
+        runNow:
+          description: optional parameter to trigger data alert flow to run immediately.
+          type: boolean
+          required: false
+      body:
+        application/json:
+          type: DataAlertInputRepresentation
+          (oas-body-name): dataAlert
+  /dataAlerts/{dataAlertId}:
+    put:
+      displayName: updateDataAlert
+      description: update a data alert
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataAlertRepresentation
+      queryParameters:
+        runNow:
+          description: optional parameter to trigger data alert flow to run immediately.
+          type: boolean
+          required: false
+      body:
+        application/json:
+          type: DataAlertInputRepresentation
+          (oas-body-name): dataAlert
+    uriParameters:
+      dataAlertId:
+        type: string
+        required: true
   /data-assets:
     /requests:
       get:
@@ -2347,6 +2730,19 @@ types:
         application/json:
           type: FollowInputRepresentation
           (oas-body-name): followerAsset
+    patch:
+      displayName: patchFollow
+      description: Update a followed asset
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FollowerAssetRepresentation
+      body:
+        application/json:
+          type: UpdateFollowedAssetInputRepresentation
+          (oas-body-name): followerAsset
     uriParameters:
       followerId:
         type: string

package/src/raml/luvio.raml

@@ -34,6 +34,11 @@ types:
   DataAssetRequestCountRepresentation:
     (luvio.ttl): 500
     (luvio.opaque): true
+  DataAlertRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      dataAlertId: id
   DataAssetRequestRepresentation:
     (luvio.ttl): 500
     (luvio.opaque): true
@@ -194,6 +199,9 @@ types:
   post:
     (luvio.adapter):
       name: follow
+  patch:
+    (luvio.adapter):
+      name: updateFollowedAsset
 
 /tableau/follow/followers/{followerId}/follows/{followedAssetId}:
   delete:
@@ -381,6 +389,16 @@ types:
     (luvio.adapter):
       name: getMarketplaceListingInstallationProgress
 
+/tableau/dataAlerts:
+  post:
+    (luvio.adapter):
+      name: createDataAlert
+
+/tableau/dataAlerts/{dataAlertId}:
+  put:
+    (luvio.adapter):
+      name: updateDataAlert
+
 /tableau/data-assets/requests:
   get:
     (luvio.adapter):