@cube-dev/platform-client 0.10.0 → 0.12.0

package/CHANGELOG.md

@@ -9,6 +9,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- Curate public-facing entries here before the next release. -->
 
+## [0.12.0] - 2026-09-20
+### Deprecated
+
+- The agent Jira/Atlassian integration is gone (CUB-4773). `Agent.integrations` (`AgentIntegrationsDto`, `AgentIntegrationsJiraDto`), `UpdateAgentInput.integrations`, the `atlassianConfig` / `jiraProjects` / `jiraIssueTypes` queries and `useD3AiJiraIntegration` are **deprecated, not removed** — they remain in the schema returning null/false so existing clients keep working, and are deleted in a later release (CUB-4781). Nothing reads or writes them: the OAuth callback, credential storage and token refresh behind them are gone.
+
+## [0.11.0] - 2026-09-15
+### Added
+
+- `FolderDto` gained `user` (CUB-4611) — the folder's owner, resolved the same way workbook owners are; `null` on a folder shared from the main workspace, which stays masked. Fixes the embed workspace's Owner column always rendering a dash, including for a folder the caller just created.
+- `GenerateSession` gained `branchName` (CUB-4151) — the deployment branch an embed session queries. Omit it (or pass the deployment's production branch) for the production environment, which stays the default; any other branch of the deployment — one with a staging environment enabled, a shared branch, or a personal dev branch — points every Cube query the embedded dashboards, Creator Mode workspace and chat make at that branch's runtime (`<deploymentUrl>/dev-mode/{branchName}/cubejs-api/v1`) instead. The branch must be served when the session is generated: a name that is not a branch of the deployment returns `404`, and a branch nothing is running returns `400` — a branch without a staging environment is only running while someone has it open in Cube, so enable its staging environment for a branch an embedded app should reach at any time. Content is not branch-scoped: the same dashboards and workbooks are rendered against the chosen branch's data model. The embedded chat and AI widgets follow the session onto the branch as well, so an agent answers from the same data model the dashboards show.
+- New public REST endpoint `POST /api/v1/embed/session/revoke` (`EmbedPublicController.revokeSession`) (CUB-4508) ends a signed embed session from the server side — call it from your application's logout handler with the `sessionId` that `POST /api/v1/embed/generate-session` returned. Works on either state a session can be in: an unexchanged id can no longer be redeemed via `POST /api/v1/embed/session/token`, and a token an already-exchanged id produced is rejected with `401` from that point on. Idempotent — revoking an unknown, expired, or already-revoked id also responds `204`, so the response alone never tells you whether a token was still revocable. That depends on Cube, not on the client library you call from: only tokens Cube issued after this endpoint shipped carry the revocation claim, and an older token keeps working until it expires on its own, within 24 hours. Requires admin access and that embedding be enabled for the account. New schema: `RevokeEmbedSessionInput`.
+
 ## [0.10.0] - 2026-09-14
 ### Added
 

package/dist/schema.d.ts

@@ -425,6 +425,54 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}/syncs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List Databricks Metric View publication runs
+         * @description Durable run history for this datasource, newest first. It remains available after a run finishes. Requires a Databricks datasource. This is currently in preview — reach out to the Cube support team to activate it for your account.
+         */
+        get: operations["DatabricksMetricViewIntegrationPublicController.listSyncs"];
+        put?: never;
+        /**
+         * Start a Databricks Metric View publication run
+         * @description Converts the configured Cube views from the deployment's latest successful build and creates or replaces each one's managed Databricks Metric View. Views publish independently: one that is incompatible, fails Databricks validation, or whose destination belongs to another integration keeps its last good definition and does not stop the others, and a view whose definition is unchanged is skipped without a Databricks write. One run per integration at a time; a second start while one is active returns 409. Requires a Databricks datasource, enabled publication settings, and SchemaUpdate access. This is currently in preview — reach out to the Cube support team to activate it for your account.
+         */
+        post: operations["DatabricksMetricViewIntegrationPublicController.startSync"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}/syncs/{runId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a Databricks Metric View publication run
+         * @description Returns the run with its per-view outcomes, plus live stage and published counts while it is still active.
+         */
+        get: operations["DatabricksMetricViewIntegrationPublicController.syncRun"];
+        put?: never;
+        post?: never;
+        /**
+         * Cancel a Databricks Metric View publication run
+         * @description Requests cancellation of an active run and returns its state. Metric Views already written in the run are not rolled back. Requires SchemaUpdate access.
+         */
+        delete: operations["DatabricksMetricViewIntegrationPublicController.cancelSync"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/deployments/{deploymentId}/databricks-metric-view-previews": {
         parameters: {
             query?: never;
@@ -1877,6 +1925,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/embed/session/revoke": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Revoke an embed session
+         * @description **🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
+         *
+         *     Ends an embed session from the server side — call it from your application's logout handler. Pass the `sessionId` that `POST /api/v1/embed/generate-session` returned.
+         *
+         *     Works in either state the session can be in: an id that has not been exchanged yet can no longer be redeemed via `POST /api/v1/embed/session/token`, and the token an already-exchanged id produced is rejected with `401` from this moment on. The embedded iframe does not tear itself down — remove it on logout as before.
+         *
+         *     Idempotent: revoking an unknown, expired or already-revoked id also responds `204` — so the response alone never tells you whether a token was still revocable. That depends on Cube, not on the client library you call from: only tokens Cube issued after this endpoint shipped carry the claim revocation is checked against, and an older token keeps working until it expires on its own, within 24 hours. A Cube API token the embed obtained from `POST /api/v1/deployments/{deploymentId}/token` is a separate credential and is not affected.
+         *
+         *     Embedding must be enabled for the account, otherwise `403` is returned.
+         */
+        post: operations["EmbedPublicController.revokeSession"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/embed/session/token": {
         parameters: {
             query?: never;
@@ -3044,14 +3120,17 @@ export interface components {
             updatedAt?: (string) | null;
             userId?: number | null;
         };
-        AgentSkillDto: {
+        AgentSkill: {
             description: string;
             input?: string | null;
             name: string;
+            source?: components["schemas"]["AgentSkillSource"] | null;
             title: string;
         };
+        /** @enum {string} */
+        AgentSkillSource: "deployment" | "system";
         AgentSkillsResponse: {
-            skills: components["schemas"]["AgentSkillDto"][];
+            skills: components["schemas"]["AgentSkill"][];
         };
         AgentSpace: {
             config?: components["schemas"]["AgentSpaceConfigDto"] | null;
@@ -3072,7 +3151,9 @@ export interface components {
             appTheme?: components["schemas"]["AppTheme"] | null;
             applyThemeGlobally: boolean;
             creatorMode?: components["schemas"]["CreatorMode"] | null;
+            dashboardAppsEnabled: boolean;
             embedding?: components["schemas"]["EmbedSettings"] | null;
+            restrictDataDownload: boolean;
             sheetsAgentChatEnabled: boolean;
             sheetsUi?: components["schemas"]["SheetsUiSettings"] | null;
             timezoneSettings?: components["schemas"]["TimezoneSettings"] | null;
@@ -3917,9 +3998,75 @@ export interface components {
             metricViewYaml?: string | null;
             outcome: components["schemas"]["DatabricksMetricViewPublicationViewResultOutcome"];
             source?: string | null;
+            /** @description Measures this view could not publish, each named with the cube it comes from. A view with entries here is queryable but incomplete. */
+            withheldMembers: components["schemas"]["DatabricksMetricViewPublicationWithheldMember"][];
+        };
+        /** @enum {string} */
+        DatabricksMetricViewPublicationViewResultOutcome: "success" | "partial" | "failed";
+        DatabricksMetricViewPublicationWithheldMember: {
+            /** @description Why it could not be published, as a stable code. */
+            code: string;
+            cube: string;
+            member: string;
+        };
+        DatabricksMetricViewSyncProgressResponse: {
+            published: number;
+            stage: string;
+            total: number;
+        };
+        DatabricksMetricViewSyncRunListResponse: {
+            items: components["schemas"]["DatabricksMetricViewSyncRunResponse"][];
+            pageInfo: components["schemas"]["PageInfo"];
+        };
+        DatabricksMetricViewSyncRunResponse: {
+            buildJobId?: number | null;
+            cancelRequestedAt?: string | null;
+            commit?: string | null;
+            completedAt?: string | null;
+            configurationVersion?: number | null;
+            createdAt: string;
+            dataSourceName: string;
+            deletionPolicy?: string | null;
+            deploymentId: number;
+            durationMs?: number | null;
+            integrationPublicId: string;
+            progress?: components["schemas"]["DatabricksMetricViewSyncProgressResponse"] | null;
+            runId: string;
+            stage?: string | null;
+            startedAt?: string | null;
+            status: components["schemas"]["DatabricksMetricViewSyncRunResponseStatus"];
+            targetCatalog?: string | null;
+            targetSchema?: string | null;
+            trigger: components["schemas"]["DatabricksMetricViewSyncRunResponseTrigger"];
+            /** @description The Cube views this run was planned against. */
+            viewNames: string[];
+            views: components["schemas"]["DatabricksMetricViewSyncViewOutcomeResponse"][];
+        };
+        /** @enum {string} */
+        DatabricksMetricViewSyncRunResponseStatus: "QUEUED" | "RUNNING" | "CANCELLING" | "COMPLETED" | "PARTIAL" | "FAILED" | "CANCELLED";
+        /** @enum {string} */
+        DatabricksMetricViewSyncRunResponseTrigger: "MANUAL";
+        DatabricksMetricViewSyncStartResponse: {
+            /** @description The build whose deployed model this run publishes. */
+            buildJobId: number;
+            commit?: string | null;
+            dataSourceName: string;
+            deploymentId: number;
+            integrationPublicId: string;
+            /** @description True when an idempotent retry returned an existing run. */
+            reused: boolean;
+            runId: string;
+            statusUrl: string;
+        };
+        DatabricksMetricViewSyncViewOutcomeResponse: {
+            cubeViewName: string;
+            detail?: string | null;
+            outcome: components["schemas"]["DatabricksMetricViewSyncViewOutcomeResponseOutcome"];
+            /** @description Measures this view published without, as 'cube.member'. Non-empty means the Metric View is queryable but incomplete. */
+            withheldMembers: string[];
         };
         /** @enum {string} */
-        DatabricksMetricViewPublicationViewResultOutcome: "success" | "failed";
+        DatabricksMetricViewSyncViewOutcomeResponseOutcome: "unchanged" | "created" | "updated" | "blocked" | "validation_failed" | "publish_failed" | "retained_obsolete" | "deleted_obsolete";
         DbtGeneratedFileContent: {
             /** @description The generated YAML. */
             content: string;
@@ -4428,6 +4575,7 @@ export interface components {
             type: components["schemas"]["FolderDtoType"];
             updatedAt: string;
             updatedBy?: number | null;
+            user?: components["schemas"]["ResourceOwner"] | null;
         };
         /** @enum {string} */
         FolderDtoType: "FOLDER" | "WORKBOOK" | "REPORT";
@@ -4445,6 +4593,7 @@ export interface components {
             token: string;
         };
         GenerateSession: {
+            branchName?: string | null;
             creatorMode?: boolean | null;
             deploymentId: number;
             email?: string | null;
@@ -4571,6 +4720,8 @@ export interface components {
             host: string;
             id: string;
         };
+        /** @enum {string} */
+        ListDatabricksMetricViewSyncsQueryStatus: "QUEUED" | "RUNNING" | "CANCELLING" | "COMPLETED" | "PARTIAL" | "FAILED" | "CANCELLED";
         LocalEncryptedSecret: {
             authTagBase64: string;
             ciphertext: string;
@@ -4727,6 +4878,7 @@ export interface components {
             rows: string[];
             showAppliedFilters?: boolean | null;
             showColumnTotals?: boolean | null;
+            showRowTotals?: boolean | null;
         };
         /** @enum {string} */
         PivotItemsDisplayScale: "model" | "absolute" | "thousands" | "millions" | "billions";
@@ -4740,6 +4892,7 @@ export interface components {
             rows: string[];
             showAppliedFilters?: boolean | null;
             showColumnTotals?: boolean | null;
+            showRowTotals?: boolean | null;
         };
         /** @enum {string} */
         PivotItemsInputDisplayScale: "model" | "absolute" | "thousands" | "millions" | "billions";
@@ -5044,6 +5197,7 @@ export interface components {
             name?: string | null;
             periodComparisons?: components["schemas"]["PeriodComparison"][] | null;
             preferences?: components["schemas"]["ReportSnapshotPreferences"] | null;
+            publicId?: string | null;
             pythonCode?: string | null;
             reportId: number;
             spec?: (string | Record<string, never>) | null;
@@ -5097,6 +5251,10 @@ export interface components {
         };
         /** @enum {string} */
         ResourceUserPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
+        RevokeEmbedSessionInput: {
+            /** @description The session id returned by `POST /api/v1/embed/generate-session`. Works whether or not the session has already been exchanged for a token. */
+            sessionId: string;
+        };
         RoleWithAccess: {
             actions: ("All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage")[];
             id: number;
@@ -5172,6 +5330,11 @@ export interface components {
         };
         /** @enum {string} */
         StartDashboardExportInputFormat: "png" | "pdf";
+        StartDatabricksMetricViewSyncInput: {
+            /** @description The configurationVersion returned by GET. A run is refused when settings changed after they were loaded, so a publish always uses the configuration the caller saw. */
+            configurationVersion: number;
+            idempotencyKey?: string | null;
+        };
         StartDbtSyncInput: {
             branchName?: string | null;
             manifest?: {
@@ -5193,6 +5356,9 @@ export interface components {
             transaction: components["schemas"]["UploadTransaction"];
         };
         TenantSettings: {
+            aiTokensAutoPurchaseAmount: number;
+            aiTokensAutoPurchaseEnabled: boolean;
+            aiTokensAutoPurchaseThreshold: number;
             auditLogEnabled: boolean;
             auditLogEnabledCurrent: boolean;
             auditLogEnabledTimestamp: number;
@@ -5204,6 +5370,8 @@ export interface components {
             useAIBIUserInterface: boolean;
         };
         TenantSettingsInput: {
+            aiTokensAutoPurchaseAmount?: number | null;
+            aiTokensAutoPurchaseEnabled?: boolean | null;
             auditLogEnabled?: boolean | null;
             hasSupportAccess?: boolean | null;
             maintenanceWindowDay?: string | null;
@@ -6460,6 +6628,105 @@ export interface operations {
             };
         };
     };
+    "DatabricksMetricViewIntegrationPublicController.listSyncs": {
+        parameters: {
+            query?: {
+                status?: components["schemas"]["ListDatabricksMetricViewSyncsQueryStatus"] | null;
+                after?: string;
+                first?: number;
+            };
+            header?: never;
+            path: {
+                deploymentId: number;
+                dataSourceName: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatabricksMetricViewSyncRunListResponse"];
+                };
+            };
+        };
+    };
+    "DatabricksMetricViewIntegrationPublicController.startSync": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                dataSourceName: string;
+            };
+            cookie?: never;
+        };
+        /** @description StartDatabricksMetricViewSyncInput */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["StartDatabricksMetricViewSyncInput"];
+            };
+        };
+        responses: {
+            202: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatabricksMetricViewSyncStartResponse"];
+                };
+            };
+        };
+    };
+    "DatabricksMetricViewIntegrationPublicController.syncRun": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                dataSourceName: string;
+                runId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatabricksMetricViewSyncRunResponse"];
+                };
+            };
+        };
+    };
+    "DatabricksMetricViewIntegrationPublicController.cancelSync": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                dataSourceName: string;
+                runId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatabricksMetricViewSyncRunResponse"];
+                };
+            };
+        };
+    };
     "DatabricksMetricViewPublicationPublicController.startPreview": {
         parameters: {
             query?: never;
@@ -8703,6 +8970,38 @@ export interface operations {
             };
         };
     };
+    "EmbedPublicController.revokeSession": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description RevokeEmbedSessionInput */
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["RevokeEmbedSessionInput"];
+            };
+        };
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": any;
+                };
+            };
+            /** @description Session revoked, or did not exist. */
+            204: {
+                headers: {
+                    [name: string]: any;
+                };
+                content?: never;
+            };
+        };
+    };
     "EmbedPublicController.postTokenBySessionId": {
         parameters: {
             query?: never;