@salesforce/lds-adapters-analytics-unifiedanalytics 1.332.0-dev2 → 1.332.0-dev20

package/src/raml/api.raml

@@ -287,9 +287,18 @@ types:
       searchTerm:
         description: Search term parameter value
         type: string
+      userCapability:
+        description: User permission
+        type: string
       useAutoSuggest:
         description: Use auto suggest term parameter value
         type: boolean
+      limit:
+        description: Limit parameter value
+        type: integer
+      offset:
+        description: Offset parameter value
+        type: integer
   AnalyticsUsersQueryResultsRepresentation:
     description: Results of Users Query
     type: object
@@ -327,6 +336,34 @@ types:
         enum:
           - Group
           - User
+      followedTimeRange:
+        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
@@ -393,6 +430,20 @@ types:
         enum:
           - SemanticMetricDefinition
           - SemanticSubMetric
+      followedTimeRange:
+        description: Time Range filter representation
+        type: FollowedTimeRangeRepresentation | nil
+        required: false
+  FollowedTimeRangeRepresentation:
+    description: Followed Time Range Representation
+    type: object
+    properties:
+      fieldName: string
+      operator: string # SemanticFilterOperatorTypeEnum
+      values:
+        type: array
+        items:
+          type: string | number
   FollowerAssetRepresentation:
     description: Represent follower and asset mapping
     type: object
@@ -421,6 +472,10 @@ types:
       createdDate:
         description: Created date
         type: string
+      followedTimeRange:
+        description: Time Range filter representation
+        type: FollowedTimeRangeRepresentation | nil
+        required: false
   FollowerCollectionRepresentation:
     description: Collection of Followers
     type: object
@@ -883,6 +938,579 @@ types:
         properties:
           //:
             type: any
+  DataAssetDependentCollectionRepresentation:
+    description: Represents a List of dependent assets for a given asset
+    type: object
+    properties:
+      dependentDataAssets:
+        description: Array of Dependent Assets
+        type: array
+        items:
+          type: DataAssetDependentRepresentation
+  DataAssetDependentRepresentation:
+    description: Represents a Dependent asset
+    type: object
+    properties:
+      dataAsset:
+        description: Represents a Data asset
+        type: DataAssetRepresentation
+  DataAssetRepresentation:
+    description: Represents a Data asset
+    discriminator: assetId # TODO Hand-rolled W-17712133: invalid inheritance
+    type: object
+    properties:
+      id:
+        description: DataAsset id.
+        type: string
+        required: false
+      description:
+        description: Description of the DataAsset.
+        type: string
+        required: false
+      label:
+        description: Label of the DataAsset.
+        type: string
+      name:
+        description: Name of the DataAsset.
+        type: string
+      createdBy:
+        description: Created by of the DataAsset.
+        type: AnalyticsUserRepresentation
+      createdDate:
+        description: Created date of the DataAsset
+        type: string
+        required: false
+      lastModifiedBy:
+        description: Last modified by of the DataAsset.
+        type: AnalyticsUserRepresentation
+      lastModifiedDate:
+        description: Last modified date of the DataAsset.
+        type: string
+      assetId:
+        description: Represents id of the DataAsset
+        type: string
+      assetType:
+        description: Type of the DataAsset
+        type: string
+        enum:
+          - AnalyticsDashboard
+          - AnalyticsVisualization
+          - MktCalculatedInsightsObject
+          - MktDataModelObject
+          - SemanticModel
+      workspaceId:
+        description: Id of the workspace which the DataAsset is part of
+        type: string
+        required: false
+  DataAssetRequestCollectionRepresentation:
+    description: Collection of Data Asset Requests
+    type: object
+    properties:
+      dataAssetRequests:
+        description: List of data asset requests being returned
+        type: array
+        items:
+          type: DataAssetRequestRepresentation
+  DataAssetRequestCountRepresentation:
+    description: Represents a data asset request count
+    type: object
+    properties:
+      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
+    properties:
+      assetId:
+        description: Id of Asset being promoted
+        type: string
+        required: false
+      id:
+        description: Id for the request
+        type: string
+        required: false
+      label:
+        description: Label to be used for the request
+        type: string
+        required: false
+      numberOfDependencies:
+        description: Number of dependencies associated with the asset being tracked
+        type: integer
+        required: false
+      rejectionComment:
+        description: Rejection comment
+        type: string
+        required: false
+      requestType:
+        description: Type of the request
+        type: string
+        required: false
+        enum:
+          - Promotion
+          - Reuse
+      requesterComment:
+        description: Requester comment
+        type: string
+        required: false
+      sourceRequestId:
+        description: Id for the source request
+        type: string
+        required: false
+      status:
+        description: Status of the request
+        type: string
+        required: false
+        enum:
+          - Accepted
+          - Cancelled
+          - Completed
+          - Extracting
+          - ExtractionComplete
+          - Failed
+          - ManageAccess
+          - ManageCsv
+          - ManageDataPolicy
+          - MarkAcceptedOrRejected
+          - MarkComplete
+          - Migrating
+          - MigrationSucceeded
+          - Rejected
+          - Requested
+          - ReviewContent
+      workspaceIdOrApiName:
+        description: Workspace id or name of personal org related to the request
+        type: string
+        required: false
+  DataAssetRequestRepresentation:
+    description: Represents a data asset request
+    type: object
+    properties:
+      acknowledgedBy:
+        description: The user who approved or rejected this request
+        type: AnalyticsUserRepresentation | nil
+      acknowledgedDate:
+        description: Acknowledged date
+        type: string | nil
+      assetId:
+        description: assetId associated with the request
+        type: string
+      assetLabel:
+        description: Asset Label
+        type: string | nil
+      cancelledBy:
+        description: The user who cancelled this request
+        type: AnalyticsUserRepresentation | nil
+      cancelledDate:
+        description: Cancelled date
+        type: string | nil
+      completedBy:
+        description: The user who completed this request
+        type: AnalyticsUserRepresentation | nil
+      completedDate:
+        description: Completed date
+        type: string | nil
+      failedDate:
+        description: Failed date
+        type: string | nil
+      lastModifiedDate:
+        description: Last modified date for the data asset record
+        type: string
+      lastModifiedBy:
+        description: The user who last modified this request
+        type: AnalyticsUserRepresentation
+      id:
+        description: Data Asset Request Id
+        type: string
+      installedDate:
+        description: Installed date
+        type: string | nil
+      label:
+        description: Data Asset Request Label
+        type: string
+      migrationSucceededDate:
+        description: Migration Succeeded date
+        type: string | nil
+      numberOfDependencies:
+        description: Number of dependencies associated with workspace asset being
+          tracked in the request
+        type: integer | nil
+      personalOrgId:
+        description: ID of personal org
+        type: string | nil
+      personalOrgWorkspaceId:
+        description: Workspace ID from personal org
+        type: string | nil
+      productionOrgId:
+        description: ID of production org
+        type: string | nil
+      productionOrgWorkspaceId:
+        description: Workspace ID from production org
+        type: string | nil
+      rejectionComment:
+        description: Rejection Comment
+        type: string | nil
+      requestType:
+        description: Type of the request
+        type: string
+        enum:
+          - Promotion
+          - Reuse
+      requestedBy:
+        description: The user who requested this request
+        type: AnalyticsUserRepresentation
+      requestedDate:
+        description: Requested date
+        type: string
+      requesterComment:
+        description: Requester Comment
+        type: string
+      sourceRequestId:
+        description: Data Asset Request Source Id
+        type: string | nil
+      status:
+        description: Data Asset Request Status
+        type: string
+        enum:
+          - Accepted
+          - Cancelled
+          - Completed
+          - Extracting
+          - ExtractionComplete
+          - Failed
+          - ManageAccess
+          - ManageCsv
+          - ManageDataPolicy
+          - MarkAcceptedOrRejected
+          - MarkComplete
+          - Migrating
+          - MigrationSucceeded
+          - Rejected
+          - Requested
+          - ReviewContent
+      targetRequestId:
+        description: Data Asset Request Target Id
+        type: string | nil
+      workspaceAssetId:
+        description: workspaceAssetId in the workspace
+        type: string | nil
 
   TableauMarketplaceListingInstallationProgressResponse:
     description: Representation of tableau marketplace's listing installation progress
@@ -957,9 +1585,14 @@ types:
       library
     type: BaseAnalyticsLibraryAssetRepresentation
     properties:
-      previewImage:
-        description: The icons configured for dashboard template preview
-        type: AnalyticsLibraryImageRepresentation
+      templateBadge:
+        description: The badge icon configured for template
+        type: string
+      templatePreviews:
+        description: The preview images configured for the template
+        type: array
+        items:
+          type: string
   AnalyticsLibraryImageRepresentation:
     description: AnalyticsLibrary Image reference representation
     type: object
@@ -1179,21 +1812,14 @@ types:
     description: A collection of unified analytics orgs.
     type: object
     properties:
-      currentOrg:
-        description: Current org.
-        type: OrgRepresentation
-      orgs:
-        description: List of orgs being returned.
+      personalOrgs:
+        description: List of Personal Orgs.
         type: array
         items:
           type: OrgRepresentation
-  OrgInputRepresentation:
-    description: Unified Analytics Org Input Representation
-    type: object
-    properties:
-      userName:
-        description: The name of the user to query to orgs for.
-        type: string
+      productionOrg:
+        description: Production Org.
+        type: OrgRepresentation
   OrgRepresentation:
     description: Unified analytics org representation.
     discriminatorValue: Org
@@ -1202,12 +1828,12 @@ types:
       id:
         description: ID of this org.
         type: string
+      isCurrentOrg:
+        description: Is user currently logged in this org
+        type: boolean
       label:
         description: Named label to display for this org
         type: string
-      orgUrl:
-        description: URL to display for this org
-        type: string
       targetUrl:
         description: URL to switch to this org.
         type: string
@@ -1915,6 +2541,181 @@ 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:
+        displayName: getDataAssetRequestCollection
+        description: Gets data asset requests based on query parameters
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataAssetRequestCollectionRepresentation
+        queryParameters:
+          assetId:
+            type: string
+            required: false
+          assetType:
+            type: string
+            required: false
+          createdBy:
+            type: string
+            required: false
+          limit:
+            type: integer
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderBy:
+            type: string
+            required: false
+          requestType:
+            type: string
+            required: false
+          searchQueryTerm:
+            type: string
+            required: false
+          sortBy:
+            type: string
+            required: false
+          status:
+            type: string
+            required: false
+          workspaceIdOrApiName:
+            type: string
+            required: false
+      post:
+        displayName: postDataAssetRequest
+        description: Request creation of a task for a data asset
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataAssetRequestRepresentation
+        body:
+          application/json:
+            type: DataAssetRequestInputRepresentation
+            # required: false # TODO Hand-rolled W-17118037 not supported
+            (oas-body-name): dataAssetRequestInput
+      /count:
+        get:
+          displayName: getDataAssetRequestCount
+          description: Gets data asset requests count based on query parameters
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DataAssetRequestCountRepresentation
+          queryParameters:
+            assetId:
+              type: string
+              required: false
+            assetType:
+              type: string
+              required: false
+            createdBy:
+              type: string
+              required: false
+            searchQueryTerm:
+              type: string
+              required: false
+            status:
+              type: string
+              required: false
+            taskType:
+              type: string
+              required: false
+            workspaceIdOrApiName:
+              type: string
+              required: false
+      /{requestIdOrApiName}:
+        get:
+          displayName: getDataAssetRequest
+          description: Get data asset request by Id or Api Name
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DataAssetRequestRepresentation
+        patch:
+          displayName: patchDataAssetRequest
+          description: Request update of a data asset request
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DataAssetRequestRepresentation
+          body:
+            application/json:
+              type: DataAssetRequestInputRepresentation
+              (oas-body-name): dataAssetRequestInput
+        uriParameters:
+          requestIdOrApiName:
+            type: string
+            required: true
+    /dependencies:
+      /{assetId}:
+        get:
+          displayName: getDataAssetDependencies
+          description: Gets the dependencies of an Data asset
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DataAssetDependentCollectionRepresentation
+        uriParameters:
+          assetId:
+            type: string
+            required: true
   /follow/followers/{followerId}/follows:
     post:
       displayName: postFollow
@@ -1929,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
@@ -2039,7 +2853,7 @@ types:
           type: UnifiedAnalyticsLoglinesInputRepresentation
           # required: false # TODO Hand-rolled W-15315791 not supported
           (oas-body-name): loglines
-  /orgs/{userName}:
+  /orgs:
     get:
       displayName: getOrg
       description: Get all available Unified Analytics Orgs.
@@ -2049,10 +2863,6 @@ types:
           body:
             application/json:
               type: OrgCollectionRepresentation
-    uriParameters:
-      userName:
-        type: string
-        required: true
   /records/{recordId}/shares:
     delete:
       displayName: deleteSetupRecordShareCollection