@cube-dev/platform-client 0.14.0 → 0.15.0

package/CHANGELOG.md

@@ -9,7 +9,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- Curate public-facing entries here before the next release. -->
 
+## [0.15.0] - 2026-09-25
+
+### Added
+
+- `GET /api/v1/app-config` returns `aiPaywalled` (CUB-4684): `true` when the tenant uses the new UI without having enabled AI. An embed then offers no AI, whatever the session's `allowAi` says, because the server refuses its AI credentials.
+- New public REST endpoints for agent scheduled tasks: `GET` / `POST /api/v1/deployments/{deploymentId}/scheduled-tasks`, `GET` / `PUT` / `DELETE …/scheduled-tasks/{taskId}`, `POST …/scheduled-tasks/{taskId}/run` and `GET …/scheduled-tasks/{taskId}/runs` (`ScheduledTasksPublicController.listScheduledTasks` / `createScheduledTask` / `getScheduledTask` / `updateScheduledTask` / `deleteScheduledTask` / `runScheduledTask` / `listScheduledTaskRuns`). A scheduled task is a saved prompt the deployment's agent runs on a cron in an IANA time zone, or only on demand, and each run writes a new chat thread. The endpoints answer `403` unless scheduled tasks are enabled for the account, the caller holds read access to the deployment, and the request is not an embed session. Anyone with that access can list and read the deployment's tasks; only a task's creator, whom every run acts as, or an admin can update, delete or run it. A cron must fire at most once an hour (its minute field is a single number), and a user can have at most 20 active (scheduled and enabled) tasks across the account's deployments. A bad cron or time zone answers `400`, and a create or resume past the limit answers `409`; Manual and paused tasks don't count toward the limit. Each task carries `userId` (the creator) and `nextRunAt`. Both lists support cursor pagination; the tasks list has no cap (omitting `first` returns every task), but the runs list only ever holds the 50 most recent runs, so `first`/`after` page within that window rather than a longer history. New schemas: `ScheduledTaskResponse`, `ScheduledTaskListResponse`, `CreateScheduledTaskInput`, `UpdateScheduledTaskInput`, `RunScheduledTaskResponse`, `ScheduledTaskRunResponse`, `ScheduledTaskRunsListResponse`.
+- `ReportPlacementResultChecksum` / `ReportPlacementResultChecksumInput` — used by `PUT /api/v1/deployments/{deploymentId}/reports/{reportId}/refresh` and `.../connect-workbook` — gained an optional `payload` field (1–128 chars, CUB-4966): a hash of the grid the add-in just wrote, opaque to the server, so a later refresh can skip rewriting an unchanged block.
+
 ## [0.14.0] - 2026-09-23
+
 ### Added
 
 - Public REST parity for API key management (CORE-730): `GET` / `POST /api/v1/api-keys` and `GET` / `DELETE /api/v1/api-keys/{id}` (`ApiKeysPublicController.listApiKeys` / `createApiKey` / `getApiKey` / `deleteApiKey`), matching the `cube api-keys list/create/get/delete` CLI commands, which previously had no REST route to target. Admin-only. List and get responses omit the real secret — only a SHA-256 hash is persisted — so only the create response carries the one-time-revealed `token`. New schemas: `ApiKeyResponse`, `ApiKeyCreatedResponse`, `ApiKeysListResponse`, `CreateApiKeyInput`.

package/dist/schema.d.ts

@@ -1232,6 +1232,95 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/deployments/{deploymentId}/scheduled-tasks": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List scheduled tasks
+         * @description Every scheduled task in the deployment, most recently updated first, with its next run time. Needs access to the deployment; embed sessions get `403`.
+         */
+        get: operations["ScheduledTasksPublicController.listScheduledTasks"];
+        put?: never;
+        /**
+         * Create a scheduled task
+         * @description Saves a prompt for the agent to run on `cronExpression` in `timezone`, or only on demand without a cron. Runs act as the caller. A cron fires at most hourly (`400` otherwise), and a user can have 20 active tasks (`409` past that).
+         */
+        post: operations["ScheduledTasksPublicController.createScheduledTask"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get a scheduled task */
+        get: operations["ScheduledTasksPublicController.getScheduledTask"];
+        /**
+         * Update a scheduled task
+         * @description Changes the fields sent; `cronExpression: null` makes the task Manual. Only the creator or an admin may do this (`403` otherwise). A cron fires at most hourly (`400` otherwise), and a user can have 20 active tasks (`409` past that).
+         */
+        put: operations["ScheduledTasksPublicController.updateScheduledTask"];
+        post?: never;
+        /**
+         * Delete a scheduled task
+         * @description Deletes the task and its schedule; the chat threads of past runs are kept. Only the creator or an admin may do this (`403` otherwise).
+         */
+        delete: operations["ScheduledTasksPublicController.deleteScheduledTask"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}/run": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Run a scheduled task now
+         * @description Starts one run now, even for a paused or Manual task, and returns its chat thread. Only the creator or an admin may do this (`403` otherwise).
+         */
+        post: operations["ScheduledTasksPublicController.runScheduledTask"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}/runs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List a scheduled task's runs
+         * @description The chat threads of the task's latest 50 runs, newest first. Opening a thread follows the usual chat-history access rules.
+         */
+        get: operations["ScheduledTasksPublicController.listScheduledTaskRuns"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/deployments/{deploymentId}/settings": {
         parameters: {
             query?: never;
@@ -3367,6 +3456,7 @@ export interface components {
             pageInfo: components["schemas"]["PageInfo"];
         };
         AppConfigResponse: {
+            aiPaywalled: boolean;
             appTheme?: components["schemas"]["AppTheme"] | null;
             applyThemeGlobally: boolean;
             creatorMode?: components["schemas"]["CreatorMode"] | null;
@@ -3706,6 +3796,16 @@ export interface components {
         CreateReportInputHost: "GOOGLE_SHEETS" | "EXCEL";
         /** @enum {string} */
         CreateReportInputSource: "GOOGLE_SHEETS" | "EXCEL" | "PLAYGROUND" | "D3";
+        CreateScheduledTaskInput: {
+            agentId?: number | null;
+            cronExpression?: string | null;
+            description?: string | null;
+            isEnabled?: boolean | null;
+            name: string;
+            /** @description What the agent is asked on every run, shown as the task's Instructions in Cube. Each run starts a new chat thread with no memory of earlier ones, so write the whole request. */
+            prompt: string;
+            timezone?: string | null;
+        };
         CreateWorkbookInput: {
             folderId?: number | null;
             meta?: {
@@ -5459,10 +5559,12 @@ export interface components {
         ReportPlacementHost: "GOOGLE_SHEETS" | "EXCEL";
         ReportPlacementResultChecksum: {
             chunks: components["schemas"]["ReportPlacementResultChunk"][];
+            payload?: string | null;
             v: number;
         };
         ReportPlacementResultChecksumInput: {
             chunks: components["schemas"]["ReportPlacementResultChunkInput"][];
+            payload?: string | null;
             v: number;
         };
         ReportPlacementResultChunk: {
@@ -5552,6 +5654,10 @@ export interface components {
             id: number;
             name: string;
         };
+        RunScheduledTaskResponse: {
+            /** @description The chat thread this run writes to. */
+            chatThreadUuid: string;
+        };
         SaveDatabricksMetricViewIntegrationInput: {
             deletionPolicy?: components["schemas"]["SaveDatabricksMetricViewIntegrationInputDeletionPolicy"];
             enabled: boolean;
@@ -5570,10 +5676,40 @@ export interface components {
             viewNameRegex?: string;
             viewNames?: string[];
         };
-        /** @enum {string} */
         SaveDatabricksMetricViewIntegrationInputDeletionPolicy: "retain" | "delete-managed";
         /** @enum {string} */
         SaveDatabricksMetricViewIntegrationInputSelectionMode: "all" | "selected" | "pattern";
+        ScheduledTaskListResponse: {
+            items: components["schemas"]["ScheduledTaskResponse"][];
+            pageInfo: components["schemas"]["PageInfo"];
+        };
+        ScheduledTaskResponse: {
+            agentId?: number | null;
+            cronExpression?: string | null;
+            deploymentId: number;
+            description?: string | null;
+            id: number;
+            /** @description False while the schedule is paused. */
+            isEnabled: boolean;
+            name: string;
+            nextRunAt?: string | null;
+            /** @description What the agent is asked on every run, shown as the task's Instructions in Cube. Each run starts a new chat thread, so the prompt has to stand on its own. */
+            prompt: string;
+            /** @description IANA time zone the cron is read in, e.g. `America/New_York`. Defaults to `UTC`. */
+            timezone: string;
+            /** @description The creator. Every run executes as this user, and only they or an admin may change, delete or run the task. */
+            userId: number;
+        };
+        ScheduledTaskRunResponse: {
+            /** @description The chat thread the run produced. */
+            chatThreadUuid: string;
+            createdAt: string;
+            status?: string | null;
+        };
+        ScheduledTaskRunsListResponse: {
+            items: components["schemas"]["ScheduledTaskRunResponse"][];
+            pageInfo: components["schemas"]["PageInfo"];
+        };
         SetBranchStagingEnvironmentRequest: {
             branchId?: number | null;
             branchName?: string | null;
@@ -5844,6 +5980,15 @@ export interface components {
         UpdateResourceUserPolicyBodyAction: "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";
         /** @enum {string} */
         UpdateResourceUserPolicyBodyResourceType: "Global" | "Deployment" | "Report" | "ReportFolder" | "Agent" | "AgentSpace" | "Workbook" | "Dashboard" | "Folder" | "ChatThread";
+        UpdateScheduledTaskInput: {
+            agentId?: number | null;
+            cronExpression?: string | null;
+            description?: string | null;
+            isEnabled?: boolean | null;
+            name?: string | null;
+            prompt?: string | null;
+            timezone?: string | null;
+        };
         UpdateWorkbookInput: {
             folderId?: number | null;
             meta?: {
@@ -8346,6 +8491,175 @@ export interface operations {
             };
         };
     };
+    "ScheduledTasksPublicController.listScheduledTasks": {
+        parameters: {
+            query?: {
+                after?: string | null;
+                first?: number | null;
+            };
+            header?: never;
+            path: {
+                deploymentId: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["ScheduledTaskListResponse"];
+                };
+            };
+        };
+    };
+    "ScheduledTasksPublicController.createScheduledTask": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+            };
+            cookie?: never;
+        };
+        /** @description CreateScheduledTaskInput */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateScheduledTaskInput"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["ScheduledTaskResponse"];
+                };
+            };
+        };
+    };
+    "ScheduledTasksPublicController.getScheduledTask": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                taskId: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["ScheduledTaskResponse"];
+                };
+            };
+        };
+    };
+    "ScheduledTasksPublicController.updateScheduledTask": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                taskId: number;
+            };
+            cookie?: never;
+        };
+        /** @description UpdateScheduledTaskInput */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateScheduledTaskInput"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["ScheduledTaskResponse"];
+                };
+            };
+        };
+    };
+    "ScheduledTasksPublicController.deleteScheduledTask": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                taskId: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": any;
+                };
+            };
+        };
+    };
+    "ScheduledTasksPublicController.runScheduledTask": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                taskId: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["RunScheduledTaskResponse"];
+                };
+            };
+        };
+    };
+    "ScheduledTasksPublicController.listScheduledTaskRuns": {
+        parameters: {
+            query?: {
+                after?: string | null;
+                first?: number | null;
+            };
+            header?: never;
+            path: {
+                deploymentId: number;
+                taskId: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["ScheduledTaskRunsListResponse"];
+                };
+            };
+        };
+    };
     "DeploymentsPublicController.getDeploymentSettings": {
         parameters: {
             query?: never;