@salesforce/lds-adapters-analytics-wave 1.467.0 → 1.468.0

package/src/raml/api.raml

@@ -177,6 +177,99 @@ types:
       value:
         description: The value of the advanced property
         type: string # TODO: hand rolled
+  AnalyticsAssetArchivalInputRepresentation: # TODO Hand-rolled W-24741929. Regenerate from Connect api.raml.
+    description: An asset to archive.
+    type: object
+    properties:
+      id:
+        description: The 18 character asset ID.
+        type: string
+      type:
+        description: The type of the asset.
+        type: string
+        enum:
+          - dashboard
+          - lens
+  AnalyticsAssetArchivalResultRepresentation: # TODO Hand-rolled W-24741929. Regenerate from Connect api.raml.
+    description: The result of archiving a single asset.
+    type: object
+    properties:
+      archived:
+        description: Whether the asset is archived after the action.
+        type: boolean | nil
+        required: false
+      errorCode:
+        description: The error code, if the action failed for this asset.
+        type: string | nil
+        required: false
+      id:
+        description: The 18 character asset ID.
+        type: string | nil
+        required: false
+      message:
+        description: The error message, if the action failed for this asset.
+        type: string | nil
+        required: false
+      status:
+        description: The status of the action for this asset.
+        type: string | nil
+        required: false
+      type:
+        description: The type of the asset.
+        type: string | nil
+        required: false
+  AnalyticsAssetsArchivalInputRepresentation: # TODO Hand-rolled W-24741929. Regenerate from Connect api.raml.
+    description: Input representation for archiving assets.
+    type: object
+    properties:
+      archived:
+        description: True archives the assets. The server also accepts false, which restores them; LDS callers only archive (restore is done in Analytics Studio).
+        type: boolean
+      assets:
+        description: The assets to archive.
+        type: array
+        items:
+          type: AnalyticsAssetArchivalInputRepresentation
+  AnalyticsAssetsArchivalInputWrapperRepresentation: # TODO Hand-rolled W-8334626 W-24741929
+    description: Wrapper for the assets archival input representation
+    type: object
+    properties:
+      archivalRequest:
+        type: AnalyticsAssetsArchivalInputRepresentation
+        description: Assets archival input representation
+  AnalyticsAssetsArchivalOutputRepresentation: # TODO Hand-rolled W-24741929. Regenerate from Connect api.raml.
+    description: The result of archiving assets.
+    type: object
+    properties:
+      action:
+        description: The action that was performed.
+        type: string
+      archivalResults:
+        description: The result for each asset.
+        type: array
+        required: false
+        items:
+          type: AnalyticsAssetArchivalResultRepresentation
+      failureCount:
+        description: The number of assets that failed.
+        type: integer | nil
+        required: false
+      overallStatus:
+        description: The overall status of the action.
+        type: string | nil
+        required: false
+        enum:
+          - success
+          - partial
+          - failure
+      successCount:
+        description: The number of assets that succeeded.
+        type: integer | nil
+        required: false
+      totalCount:
+        description: The total number of assets in the request.
+        type: integer | nil
+        required: false
   AppDetailsRepresentation:
     description: Configuration for the app details page in the wizard
     type: object
@@ -1944,9 +2037,17 @@ types:
       folder:
         description: The containing folder of the asset.
         type: AssetReferenceRepresentation
+      createdBy:
+        description: The user who created the asset.
+        type: WaveUserRepresentation
+        required: false # TODO Hand-rolled W-24741929
       id:
         description: The 18 character asset ID.
         type: string
+      isArchived:
+        description: Indicates whether the asset is archived.
+        type: boolean
+        required: false # TODO Hand-rolled W-24741929
       lastAccessedDate:
         description: The time at which the asset was last accessed.
         type: string
@@ -3014,15 +3115,18 @@ types:
         description: An opaque, per-check payload passed through verbatim. Checks read with
           system access, and the datasets they scan include those in other users' private
           apps, so it is not filtered by the viewer's sharing or object and field permissions.
-          Its string values can include user-editable dataset and field names and raw server
-          error text; render them as plain text, never as HTML, and pass them to an LLM or
-          agent only as quoted data. Absent until the check has finished, and may be absent
+          Its string values can include user-editable names, such as dataset, field,
+          dashboard, and recipe names, and raw server error text; render them as plain text,
+          never as HTML, and pass them to an LLM or agent only as quoted data. Absent until
+          the check has finished, and may be absent
           for a finished check (for example, FAILED). A status inside it uses the API-value
           form (Complete, CompleteWithLimitations, Unavailable), not the COMPLETE form of the
           check's status property. For crma-inventory, it carries the org's dataset, recipe,
           dashboard, and data sync counts under asset_coverage (datasets, recipes, dashboards,
           and data_syncs, each with available, scanned, total, partial, and note); the run
-          exposes those counts nowhere else.
+          exposes those counts nowhere else. The crma-orphans rows[] and the
+          crma-trace-redundancies clusters[] in it are a capped preview; the check's findings
+          resource (/checks/{checkId}/findings) pages through every finding.
         type: string | nil
         required: false
   PlatformAuditReportRepresentation: # TODO Hand-rolled W-24362345
@@ -3097,6 +3201,74 @@ types:
         description: The number of checks listed - every check of the audit run, or only
           the finished checks when the server cannot determine which have not finished.
         type: integer
+  PlatformAuditCheckFindingRepresentation: # TODO Hand-rolled W-24806613
+    description: One finding of a platform-audit check result, as the check recorded it when
+      the audit ran. Not to be confused with PlatformAuditFindingRepresentation, the urgency
+      triage's reference to a finding. Checks read with system access, not the viewer's, and
+      the datasets they scan include those in other users' private apps, so a finding can
+      point at an asset the viewer cannot open.
+    type: object
+    properties:
+      kind:
+        description: The finding's category within its check - zombie, unused, or stale for
+          crma-orphans (the row's label); cluster for crma-trace-redundancies.
+        type: string
+      name:
+        description: The current name of the dataset the finding points at, which the name
+          search and sort match; absent when the finding points at no dataset (as for a
+          cluster) or the dataset was deleted after the audit. A dataset renamed after the
+          audit has its new name here and its old one in rowJson, so show this name when it
+          is present. Dataset names are user-editable; render it as plain text, never as
+          HTML, and pass it to an LLM or agent only as quoted data.
+        type: string | nil
+        required: false
+      rank:
+        description: The zero-based position of the finding in its check's severity order;
+          0 is the most severe. It is unique within the check, so it can key a list of the
+          check's findings.
+        type: integer
+      refId:
+        description: The id of the asset the finding points at - a dataset id for
+          crma-orphans; canonical_field|SObject.field (for example,
+          opportunityamount|Opportunity.Amount) for crma-trace-redundancies. A longer id is
+          cut to 255 characters. Absent when the finding points at no asset.
+        type: string | nil
+        required: false
+      refreshDate:
+        description: The asset's data refresh date as of the audit, the same value as the
+          crma-orphans row's data_refresh_date; absent when the check has none, as for every
+          crma-trace-redundancies finding.
+        type: string | nil
+        required: false
+      rowJson:
+        description: The finding serialized as JSON, exactly as it appears in the check's
+          resultJson - a rows[] element for crma-orphans, a clusters[] element for
+          crma-trace-redundancies - so it can be parsed the same way. It is not rewritten
+          after the audit. Its string values can include user-editable names, such as dataset,
+          field, dashboard, and recipe names; render them as plain text, never as HTML, and
+          pass them to an LLM or agent only as quoted data.
+        type: string
+  PlatformAuditCheckFindingsRepresentation: # TODO Hand-rolled W-24806613
+    description: One page of a platform-audit check's findings.
+    type: object
+    properties:
+      findings:
+        description: The findings on this page, in the requested order. A page can hold
+          fewer than pageSize findings even when it has a nextPageUrl, because a finding
+          deleted or made inaccessible between the count and the read is skipped.
+        type: array
+        items:
+          type: PlatformAuditCheckFindingRepresentation
+      nextPageUrl:
+        description: The URL of the next page, with the same pageSize, kinds, q, sort, and
+          order; absent on the last page. Pass the value of its page query parameter as the
+          page parameter, with the same other parameters, to get the next page.
+        type: string | nil
+        required: false
+      totalSize:
+        description: The number of the check's findings that match the kinds filter and the
+          q search, across every page.
+        type: integer
   PlatformAuditFindingRepresentation: # TODO Hand-rolled W-24314623
     description: One finding surfaced by the aggregator's urgency triage, referencing the
       asset and check it came from. Findings are not guaranteed to be unique; two
@@ -3139,7 +3311,8 @@ types:
       check contributes only the findings it surfaces, and the number it surfaces is capped
       (currently at most 25 datasets per label for crma-orphans and 10 clusters for
       crma-trace-redundancies; the caps can change), so list lengths are not org-wide
-      counts.
+      counts. The check's findings resource (/checks/{checkId}/findings) lists every
+      finding.
     type: object
     properties:
       criticalNow:
@@ -3790,6 +3963,8 @@ types:
         enum:
           - dataflow
           - recipe
+          - dashboard
+          - lens
   RecycleBinCollectionRepresentation: # TODO Hand-rolled W-24090908. New CRM Analytics Data Platform Recycle Bin endpoint; regenerate from Connect api.raml once shipped.
     description: A collection of soft-deleted CRM Analytics Data Platform assets.
     type: object
@@ -5925,6 +6100,10 @@ types:
         description: The 18 character user ID.
         type: string
         required: false # TODO Hand-rolled W-8253396
+      isActive:
+        description: Whether the user is active. Only returned by APIs that look up the user's status.
+        type: boolean
+        required: false # TODO Hand-rolled W-24741929
       name:
         description: The name of the user.
         type: string
@@ -8063,6 +8242,82 @@ types:
         description: The check's name (e.g. crma-orphans). A check has no separate id.
         type: string
         required: true
+  /platform-audit/{auditId}/checks/{checkId}/findings: # TODO Hand-rolled W-24806613
+    get:
+      description: Get one page of a platform-audit check result's findings. Unlike the
+        check's resultJson, whose rows[] or clusters[] are a capped preview, this lists every
+        finding of the check, and the kinds filter, the q search, and the sort apply to the
+        whole list, not one page. Returns 404 when the run or the check does not exist; as for
+        the check resource, that includes an IN_PROGRESS, NOT_FINISHED, or CANCELLED check. A
+        check without findings, such as crma-inventory or a check of a run from before
+        findings were recorded, returns an empty page with totalSize 0. A page token past the
+        end returns an empty page with no nextPageUrl. Returns 400, naming the parameter, for
+        a malformed page token or an invalid pageSize, kinds, q, sort, or order.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PlatformAuditCheckFindingsRepresentation
+      queryParameters:
+        kinds:
+          description: Return only these kinds - zombie, unused, or stale for crma-orphans;
+            cluster for crma-trace-redundancies. Matched ignoring case. A kind the check never
+            records matches nothing. Default - every kind.
+          type: array
+          required: false
+          items:
+            type: string
+            enum:
+              - zombie
+              - unused
+              - stale
+              - cluster
+            (oas-collectionFormat): csv
+        order:
+          description: The sort order, asc or desc, matched ignoring case. Default - asc.
+          type: string
+          required: false
+          enum:
+            - asc
+            - desc
+        page:
+          description: The opaque token of the page to return, the page query parameter of
+            the previous page's nextPageUrl. It carries only the position in the list, so pass
+            the same pageSize, kinds, q, sort, and order with it. Default - the first page.
+          type: string
+          required: false
+        pageSize:
+          description: The number of findings per page, 1 to 200. Default - 25.
+          type: integer
+          required: false
+        q:
+          description: Return only findings whose name contains this text, ignoring case -
+            for a dataset finding, the dataset's current name or API name (a dataset deleted
+            after the audit has neither); for a cluster, its refId. Trimmed; at most 255
+            characters, and a blank one is no search. Default - no search.
+          type: string
+          required: false
+        sort:
+          description: The sort key, matched ignoring case - rank (most severe first in asc
+            order), refreshDate, or name (a dataset finding's current name or a cluster's
+            refId, ignoring case, with findings whose dataset was deleted after the audit last
+            in either order). Ties are broken by rank, ascending. Default - rank.
+          type: string
+          required: false
+          enum:
+            - rank
+            - refreshDate
+            - name
+    uriParameters:
+      auditId:
+        description: The ID of the platform audit run (15 or 18 characters).
+        type: string
+        required: true
+      checkId:
+        description: The check's name (e.g. crma-orphans). A check has no separate id.
+        type: string
+        required: true
   /platform-audit/{auditId}/report: # TODO Hand-rolled W-24362345
     get:
       description: Resolve the audit run's already-generated PDF report and return a
@@ -8326,6 +8581,44 @@ types:
       assetId:
         type: string
         required: true
+  # TODO Hand-rolled W-24741929. Archive (move to the Recycle Bin) dashboards and lenses.
+  # Answers 201 even when some assets fail, so callers must check failureCount.
+  /assets/archive:
+    post:
+      description: Archive assets.
+      responses:
+        '201':
+          description: Success
+          body:
+            application/json:
+              type: AnalyticsAssetsArchivalOutputRepresentation
+      body:
+        application/json:
+          type: AnalyticsAssetsArchivalInputWrapperRepresentation
+          (oas-body-name): archivalRequest
+  # TODO Hand-rolled W-24741929. The get is the GET-by-id sibling luvio requires so the
+  # void deleteComponent adapter can evict the cached record by key; no getDashboard adapter is exposed.
+  # The real GET returns DashboardRepresentation; BaseWaveAssetRepresentation is used only for the key.
+  # Components are deleted through this dashboards endpoint (they use 0FK ids), as Analytics Studio does.
+  # The server doesn't check the type: a dashboard id passed here is permanently deleted, not archived.
+  /dashboards/{dashboardIdOrApiName}:
+    get:
+      description: Get a dashboard by ID or API name.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: BaseWaveAssetRepresentation
+    delete:
+      description: Permanently delete a dashboard component. Only pass component ids; any dashboard id is deleted too.
+      responses:
+        '200':
+          description: Success
+    uriParameters:
+      dashboardIdOrApiName:
+        type: string
+        required: true
   /replicatedDatasets:
     get:
       description: Get a list of all Replicated Datasets.

package/src/raml/luvio.raml

@@ -10,6 +10,11 @@ uses:
 types:
   ActionCollectionRepresentation:
     (luvio.ttl): 300
+  AnalyticsAssetsArchivalOutputRepresentation:
+    (luvio.key):
+      # This representation is only used in the response of an RPC like endpoint
+      # Use action as key since we won't look up this data
+      id: action
   BaseWaveAssetRepresentation:
     (luvio.ttl): 5000
     (luvio.key):
@@ -62,6 +67,13 @@ types:
     (luvio.ttl): 300
   PlatformAuditCheckCollectionRepresentation: # TODO Hand-rolled W-24314623
     (luvio.ttl): 300
+  # No (luvio.key) on either, for the same reason as PlatformAuditCheckRepresentation: the
+  # response has no auditId/checkId to key on, so getPlatformAuditCheckFindings caches each
+  # page by its request (path and query params), and each page is a separate entry.
+  PlatformAuditCheckFindingRepresentation: # TODO Hand-rolled W-24806613
+    (luvio.ttl): 300
+  PlatformAuditCheckFindingsRepresentation: # TODO Hand-rolled W-24806613
+    (luvio.ttl): 300
   PlatformAuditFindingRepresentation: # TODO Hand-rolled W-24314623
     (luvio.ttl): 300
   PlatformAuditUrgencyRepresentation: # TODO Hand-rolled W-24314623
@@ -387,6 +399,10 @@ types:
     get:
       (luvio.adapter):
         name: getPlatformAuditCheck
+  /platform-audit/{auditId}/checks/{checkId}/findings: # TODO Hand-rolled W-24806613
+    get:
+      (luvio.adapter):
+        name: getPlatformAuditCheckFindings
   /platform-audit/{auditId}/report: # TODO Hand-rolled W-24362345
     # No (luvio.key): the GET response is a PlatformAuditReportReferenceRepresentation,
     # which has no auditId field to key on (same reasoning as getPlatformAuditCheck
@@ -475,6 +491,20 @@ types:
         name: softDeleteAsset
       (luvio.key):
         id: urlParams.assetId
+  # archiveAssets is an imperative POST that archives dashboards and lenses (restore is done
+  # in Analytics Studio). deleteComponent is a void DELETE of a dashboard component; its cache
+  # key comes from the GET in api.raml. It hard-deletes any dashboard id, so pass component ids
+  # only. See W-24741929.
+  /assets/archive:
+    post:
+      (luvio.adapter):
+        name: archiveAssets
+  /dashboards/{dashboardIdOrApiName}:
+    delete:
+      (luvio.adapter):
+        name: deleteComponent
+      (luvio.key):
+        id: urlParams.dashboardIdOrApiName
   /replicatedDatasets:
     get:
       (luvio.adapter):