@cube-dev/platform-client 0.14.0 → 0.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/schema.d.ts CHANGED
@@ -1046,6 +1046,78 @@ export interface paths {
1046
1046
  patch?: never;
1047
1047
  trace?: never;
1048
1048
  };
1049
+ "/api/v1/deployments/{deploymentId}/report-deliveries": {
1050
+ parameters: {
1051
+ query?: never;
1052
+ header?: never;
1053
+ path?: never;
1054
+ cookie?: never;
1055
+ };
1056
+ /**
1057
+ * List report deliveries
1058
+ * @description In preview: ask Cube support to enable it. Newest first. Filter by `reportId`, `ownerUserId` or `spreadsheet`. Admins see every delivery; others only their own.
1059
+ */
1060
+ get: operations["ReportDeliveriesPublicController.getReportDeliveries"];
1061
+ put?: never;
1062
+ /**
1063
+ * Create a report delivery
1064
+ * @description In preview: ask Cube support to enable it. Writes a report’s results into a Google Sheets tab from `destination.anchorCell`. The caller owns it: their Google account writes, with their data access. Needs read access to the report.
1065
+ */
1066
+ post: operations["ReportDeliveriesPublicController.createReportDelivery"];
1067
+ delete?: never;
1068
+ options?: never;
1069
+ head?: never;
1070
+ patch?: never;
1071
+ trace?: never;
1072
+ };
1073
+ "/api/v1/deployments/{deploymentId}/report-deliveries/{id}": {
1074
+ parameters: {
1075
+ query?: never;
1076
+ header?: never;
1077
+ path?: never;
1078
+ cookie?: never;
1079
+ };
1080
+ /**
1081
+ * Get a report delivery
1082
+ * @description In preview: ask Cube support to enable it. `404` if the caller cannot see it. Admins see every delivery; others only their own.
1083
+ */
1084
+ get: operations["ReportDeliveriesPublicController.getReportDelivery"];
1085
+ /**
1086
+ * Update a report delivery
1087
+ * @description In preview: ask Cube support to enable it. Omitted fields stay unchanged; `destination` and `schedule` are replaced whole, and `schedule: null` removes it. A new `reportId` needs read access to that report.
1088
+ */
1089
+ put: operations["ReportDeliveriesPublicController.updateReportDelivery"];
1090
+ post?: never;
1091
+ /**
1092
+ * Delete a report delivery
1093
+ * @description In preview: ask Cube support to enable it. Also deletes its run history. Cells it already wrote stay in the spreadsheet.
1094
+ */
1095
+ delete: operations["ReportDeliveriesPublicController.deleteReportDelivery"];
1096
+ options?: never;
1097
+ head?: never;
1098
+ patch?: never;
1099
+ trace?: never;
1100
+ };
1101
+ "/api/v1/deployments/{deploymentId}/report-deliveries/{id}/runs": {
1102
+ parameters: {
1103
+ query?: never;
1104
+ header?: never;
1105
+ path?: never;
1106
+ cookie?: never;
1107
+ };
1108
+ get?: never;
1109
+ put?: never;
1110
+ /**
1111
+ * Run a report delivery now
1112
+ * @description In preview: ask Cube support to enable it. Starts a run in the background and returns its id. The run writes the report’s current results into the destination, whether or not the delivery is paused. `409` while another run of it is still going.
1113
+ */
1114
+ post: operations["ReportDeliveriesPublicController.startReportDeliveryRun"];
1115
+ delete?: never;
1116
+ options?: never;
1117
+ head?: never;
1118
+ patch?: never;
1119
+ trace?: never;
1120
+ };
1049
1121
  "/api/v1/deployments/{deploymentId}/report-folders": {
1050
1122
  parameters: {
1051
1123
  query?: never;
@@ -1232,6 +1304,95 @@ export interface paths {
1232
1304
  patch?: never;
1233
1305
  trace?: never;
1234
1306
  };
1307
+ "/api/v1/deployments/{deploymentId}/scheduled-tasks": {
1308
+ parameters: {
1309
+ query?: never;
1310
+ header?: never;
1311
+ path?: never;
1312
+ cookie?: never;
1313
+ };
1314
+ /**
1315
+ * List scheduled tasks
1316
+ * @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`.
1317
+ */
1318
+ get: operations["ScheduledTasksPublicController.listScheduledTasks"];
1319
+ put?: never;
1320
+ /**
1321
+ * Create a scheduled task
1322
+ * @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).
1323
+ */
1324
+ post: operations["ScheduledTasksPublicController.createScheduledTask"];
1325
+ delete?: never;
1326
+ options?: never;
1327
+ head?: never;
1328
+ patch?: never;
1329
+ trace?: never;
1330
+ };
1331
+ "/api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}": {
1332
+ parameters: {
1333
+ query?: never;
1334
+ header?: never;
1335
+ path?: never;
1336
+ cookie?: never;
1337
+ };
1338
+ /** Get a scheduled task */
1339
+ get: operations["ScheduledTasksPublicController.getScheduledTask"];
1340
+ /**
1341
+ * Update a scheduled task
1342
+ * @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).
1343
+ */
1344
+ put: operations["ScheduledTasksPublicController.updateScheduledTask"];
1345
+ post?: never;
1346
+ /**
1347
+ * Delete a scheduled task
1348
+ * @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).
1349
+ */
1350
+ delete: operations["ScheduledTasksPublicController.deleteScheduledTask"];
1351
+ options?: never;
1352
+ head?: never;
1353
+ patch?: never;
1354
+ trace?: never;
1355
+ };
1356
+ "/api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}/run": {
1357
+ parameters: {
1358
+ query?: never;
1359
+ header?: never;
1360
+ path?: never;
1361
+ cookie?: never;
1362
+ };
1363
+ get?: never;
1364
+ put?: never;
1365
+ /**
1366
+ * Run a scheduled task now
1367
+ * @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).
1368
+ */
1369
+ post: operations["ScheduledTasksPublicController.runScheduledTask"];
1370
+ delete?: never;
1371
+ options?: never;
1372
+ head?: never;
1373
+ patch?: never;
1374
+ trace?: never;
1375
+ };
1376
+ "/api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}/runs": {
1377
+ parameters: {
1378
+ query?: never;
1379
+ header?: never;
1380
+ path?: never;
1381
+ cookie?: never;
1382
+ };
1383
+ /**
1384
+ * List a scheduled task's runs
1385
+ * @description The chat threads of the task's latest 50 runs, newest first. Opening a thread follows the usual chat-history access rules.
1386
+ */
1387
+ get: operations["ScheduledTasksPublicController.listScheduledTaskRuns"];
1388
+ put?: never;
1389
+ post?: never;
1390
+ delete?: never;
1391
+ options?: never;
1392
+ head?: never;
1393
+ patch?: never;
1394
+ trace?: never;
1395
+ };
1235
1396
  "/api/v1/deployments/{deploymentId}/settings": {
1236
1397
  parameters: {
1237
1398
  query?: never;
@@ -1276,6 +1437,126 @@ export interface paths {
1276
1437
  patch?: never;
1277
1438
  trace?: never;
1278
1439
  };
1440
+ "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-pulls": {
1441
+ parameters: {
1442
+ query?: never;
1443
+ header?: never;
1444
+ path?: never;
1445
+ cookie?: never;
1446
+ };
1447
+ get?: never;
1448
+ put?: never;
1449
+ /**
1450
+ * Pull Snowflake Semantic Views into Cube
1451
+ * @description Pulls Snowflake Semantic Views into a Cube branch and returns a job ID to poll. Generated files are committed to the branch. Requires an API key or OAuth deployment.write token, SQL runner access, and preview enablement.
1452
+ */
1453
+ post: operations["SnowflakeSemanticViewSyncPublicController.startSnowflakeSemanticViewPull"];
1454
+ delete?: never;
1455
+ options?: never;
1456
+ head?: never;
1457
+ patch?: never;
1458
+ trace?: never;
1459
+ };
1460
+ "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-pulls/{syncJobId}": {
1461
+ parameters: {
1462
+ query?: never;
1463
+ header?: never;
1464
+ path?: never;
1465
+ cookie?: never;
1466
+ };
1467
+ /**
1468
+ * Get Snowflake Semantic View pull status
1469
+ * @description Poll the syncJobId returned by the pull start request. COMPLETED and FAILED are terminal; a 404 means the job is not visible to this deployment.
1470
+ */
1471
+ get: operations["SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPullStatus"];
1472
+ put?: never;
1473
+ post?: never;
1474
+ delete?: never;
1475
+ options?: never;
1476
+ head?: never;
1477
+ patch?: never;
1478
+ trace?: never;
1479
+ };
1480
+ "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-pulls/{syncJobId}/result": {
1481
+ parameters: {
1482
+ query?: never;
1483
+ header?: never;
1484
+ path?: never;
1485
+ cookie?: never;
1486
+ };
1487
+ /**
1488
+ * Get the result of a completed Snowflake Semantic View pull
1489
+ * @description Returns the generated file paths committed to the Cube branch, view count, and duration. Poll status first; this endpoint returns 404 until the pull completes.
1490
+ */
1491
+ get: operations["SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPullResult"];
1492
+ put?: never;
1493
+ post?: never;
1494
+ delete?: never;
1495
+ options?: never;
1496
+ head?: never;
1497
+ patch?: never;
1498
+ trace?: never;
1499
+ };
1500
+ "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-syncs": {
1501
+ parameters: {
1502
+ query?: never;
1503
+ header?: never;
1504
+ path?: never;
1505
+ cookie?: never;
1506
+ };
1507
+ get?: never;
1508
+ put?: never;
1509
+ /**
1510
+ * Push Cube views to Snowflake Semantic Views
1511
+ * @description Queues a push of selected Cube views to Snowflake and returns a syncJobId for polling. Requires an API key or OAuth deployment.write token, Semantic View sync, SQL DDL access, and preview enablement.
1512
+ */
1513
+ post: operations["SnowflakeSemanticViewSyncPublicController.startSnowflakeSemanticViewPush"];
1514
+ delete?: never;
1515
+ options?: never;
1516
+ head?: never;
1517
+ patch?: never;
1518
+ trace?: never;
1519
+ };
1520
+ "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-syncs/{syncJobId}": {
1521
+ parameters: {
1522
+ query?: never;
1523
+ header?: never;
1524
+ path?: never;
1525
+ cookie?: never;
1526
+ };
1527
+ /**
1528
+ * Get Snowflake Semantic View push status
1529
+ * @description Poll the syncJobId returned by the push start request. COMPLETED and FAILED are terminal; a 404 means the job is not visible to this deployment.
1530
+ */
1531
+ get: operations["SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPushStatus"];
1532
+ put?: never;
1533
+ post?: never;
1534
+ delete?: never;
1535
+ options?: never;
1536
+ head?: never;
1537
+ patch?: never;
1538
+ trace?: never;
1539
+ };
1540
+ "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-syncs/{syncJobId}/result": {
1541
+ parameters: {
1542
+ query?: never;
1543
+ header?: never;
1544
+ path?: never;
1545
+ cookie?: never;
1546
+ };
1547
+ /**
1548
+ * Get the result of a completed Snowflake Semantic View push
1549
+ * @description Returns the number of Snowflake Semantic Views published and the duration. Poll status first; this endpoint returns 404 until the push completes.
1550
+ */
1551
+ get: operations["SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPushResult"];
1552
+ put?: never;
1553
+ post?: never;
1554
+ delete?: never;
1555
+ options?: never;
1556
+ head?: never;
1557
+ patch?: never;
1558
+ trace?: never;
1559
+ };
1279
1560
  "/api/v1/deployments/{deploymentId}/token": {
1280
1561
  parameters: {
1281
1562
  query?: never;
@@ -1569,7 +1850,10 @@ export interface paths {
1569
1850
  };
1570
1851
  get?: never;
1571
1852
  put?: never;
1572
- /** Publish dashboard */
1853
+ /**
1854
+ * Publish a dashboard
1855
+ * @description Publishes the saved dashboard draft when config is omitted. Save layout or app changes to the workbook draft before publishing; the request only needs workbookId. An explicit config remains supported for existing clients.
1856
+ */
1573
1857
  post: operations["WorkbooksPublicController.publishDashboard"];
1574
1858
  delete?: never;
1575
1859
  options?: never;
@@ -3367,6 +3651,7 @@ export interface components {
3367
3651
  pageInfo: components["schemas"]["PageInfo"];
3368
3652
  };
3369
3653
  AppConfigResponse: {
3654
+ aiPaywalled: boolean;
3370
3655
  appTheme?: components["schemas"]["AppTheme"] | null;
3371
3656
  applyThemeGlobally: boolean;
3372
3657
  creatorMode?: components["schemas"]["CreatorMode"] | null;
@@ -3681,6 +3966,14 @@ export interface components {
3681
3966
  subFormat?: string | null;
3682
3967
  targetEnvVar?: string | null;
3683
3968
  };
3969
+ CreateReportDeliveryInput: {
3970
+ destination: components["schemas"]["ReportDeliveryDestinationInput"];
3971
+ name: string;
3972
+ /** @description Id of the report whose results are delivered. It must belong to this deployment, and the caller must be able to read it. */
3973
+ reportId: number;
3974
+ schedule?: components["schemas"]["ReportDeliveryScheduleInput"] | null;
3975
+ shape?: components["schemas"]["ReportDeliveryShapeInput"] | null;
3976
+ };
3684
3977
  CreateReportInput: {
3685
3978
  endResultCell?: string | null;
3686
3979
  externalWorkbookId?: string | null;
@@ -3706,6 +3999,16 @@ export interface components {
3706
3999
  CreateReportInputHost: "GOOGLE_SHEETS" | "EXCEL";
3707
4000
  /** @enum {string} */
3708
4001
  CreateReportInputSource: "GOOGLE_SHEETS" | "EXCEL" | "PLAYGROUND" | "D3";
4002
+ CreateScheduledTaskInput: {
4003
+ agentId?: number | null;
4004
+ cronExpression?: string | null;
4005
+ description?: string | null;
4006
+ isEnabled?: boolean | null;
4007
+ name: string;
4008
+ /** @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. */
4009
+ prompt: string;
4010
+ timezone?: string | null;
4011
+ };
3709
4012
  CreateWorkbookInput: {
3710
4013
  folderId?: number | null;
3711
4014
  meta?: {
@@ -5259,6 +5562,7 @@ export interface components {
5259
5562
  };
5260
5563
  PythonAnalysisFilteredRun: {
5261
5564
  at: string;
5565
+ dataRefreshedAt?: string | null;
5262
5566
  executionError?: string | null;
5263
5567
  inputRowCount: number;
5264
5568
  outputData?: any | null;
@@ -5417,6 +5721,68 @@ export interface components {
5417
5721
  version?: number | null;
5418
5722
  workbookId?: number | null;
5419
5723
  };
5724
+ ReportDeliveriesListResponse: {
5725
+ items: components["schemas"]["ReportDeliveryResponse"][];
5726
+ pageInfo?: components["schemas"]["PageInfo"] | null;
5727
+ };
5728
+ ReportDeliveryColumn: {
5729
+ column?: string | null;
5730
+ header?: string | null;
5731
+ placeholder?: boolean | null;
5732
+ };
5733
+ ReportDeliveryColumnInput: {
5734
+ column?: string | null;
5735
+ header?: string | null;
5736
+ placeholder?: components["schemas"]["ReportDeliveryColumnInputPlaceholder"] | null;
5737
+ };
5738
+ /** @enum {boolean} */
5739
+ ReportDeliveryColumnInputPlaceholder: true;
5740
+ ReportDeliveryDestination: {
5741
+ /** @description Top-left cell of the delivered block, in A1 notation. */
5742
+ anchorCell: string;
5743
+ sheetId?: number | null;
5744
+ sheetName?: string | null;
5745
+ spreadsheetId: string;
5746
+ };
5747
+ ReportDeliveryDestinationInput: {
5748
+ anchorCell?: string | null;
5749
+ sheetId?: number | null;
5750
+ sheetName?: string | null;
5751
+ /** @description The Google Sheets spreadsheet: its URL or its id. */
5752
+ spreadsheet: string;
5753
+ };
5754
+ ReportDeliveryResponse: {
5755
+ deploymentId: number;
5756
+ destination: components["schemas"]["ReportDeliveryDestination"];
5757
+ id: number;
5758
+ name: string;
5759
+ nextRunAt?: any | null;
5760
+ ownerUserId?: number | null;
5761
+ pausedAt?: any | null;
5762
+ reportId?: number | null;
5763
+ runAsUserId?: number | null;
5764
+ schedule?: components["schemas"]["ReportDeliverySchedule"] | null;
5765
+ shape?: components["schemas"]["ReportDeliveryShape"] | null;
5766
+ status: components["schemas"]["ReportDeliveryResponseStatus"];
5767
+ };
5768
+ /** @enum {string} */
5769
+ ReportDeliveryResponseStatus: "active" | "failing" | "needs_reconnect" | "orphaned";
5770
+ ReportDeliverySchedule: {
5771
+ cronExpressions: string[];
5772
+ timezone: string;
5773
+ };
5774
+ ReportDeliveryScheduleInput: {
5775
+ /** @description Five-field cron expressions; the delivery runs whenever any matches. The minute field must be a single number (at most one run an hour): `0 9,13,17 * * 1-5` is 09:00, 13:00 and 17:00 on weekdays. */
5776
+ cronExpressions: string[];
5777
+ timezone?: string | null;
5778
+ };
5779
+ ReportDeliveryShape: {
5780
+ columns: components["schemas"]["ReportDeliveryColumn"][];
5781
+ };
5782
+ ReportDeliveryShapeInput: {
5783
+ /** @description The delivered columns, left to right. A column the query stops returning fails the run rather than shifting the ones after it. */
5784
+ columns: components["schemas"]["ReportDeliveryColumnInput"][];
5785
+ };
5420
5786
  /** @enum {string} */
5421
5787
  ReportDtoSource: "GOOGLE_SHEETS" | "EXCEL" | "PLAYGROUND" | "D3";
5422
5788
  /** @enum {string} */
@@ -5459,10 +5825,12 @@ export interface components {
5459
5825
  ReportPlacementHost: "GOOGLE_SHEETS" | "EXCEL";
5460
5826
  ReportPlacementResultChecksum: {
5461
5827
  chunks: components["schemas"]["ReportPlacementResultChunk"][];
5828
+ payload?: string | null;
5462
5829
  v: number;
5463
5830
  };
5464
5831
  ReportPlacementResultChecksumInput: {
5465
5832
  chunks: components["schemas"]["ReportPlacementResultChunkInput"][];
5833
+ payload?: string | null;
5466
5834
  v: number;
5467
5835
  };
5468
5836
  ReportPlacementResultChunk: {
@@ -5552,6 +5920,10 @@ export interface components {
5552
5920
  id: number;
5553
5921
  name: string;
5554
5922
  };
5923
+ RunScheduledTaskResponse: {
5924
+ /** @description The chat thread this run writes to. */
5925
+ chatThreadUuid: string;
5926
+ };
5555
5927
  SaveDatabricksMetricViewIntegrationInput: {
5556
5928
  deletionPolicy?: components["schemas"]["SaveDatabricksMetricViewIntegrationInputDeletionPolicy"];
5557
5929
  enabled: boolean;
@@ -5570,17 +5942,47 @@ export interface components {
5570
5942
  viewNameRegex?: string;
5571
5943
  viewNames?: string[];
5572
5944
  };
5573
- /** @enum {string} */
5574
5945
  SaveDatabricksMetricViewIntegrationInputDeletionPolicy: "retain" | "delete-managed";
5575
5946
  /** @enum {string} */
5576
5947
  SaveDatabricksMetricViewIntegrationInputSelectionMode: "all" | "selected" | "pattern";
5577
- SetBranchStagingEnvironmentRequest: {
5578
- branchId?: number | null;
5579
- branchName?: string | null;
5580
- enabled: boolean;
5948
+ ScheduledTaskListResponse: {
5949
+ items: components["schemas"]["ScheduledTaskResponse"][];
5950
+ pageInfo: components["schemas"]["PageInfo"];
5581
5951
  };
5582
- SetBranchStagingEnvironmentResponse: {
5583
- data: components["schemas"]["BranchResponse"];
5952
+ ScheduledTaskResponse: {
5953
+ agentId?: number | null;
5954
+ cronExpression?: string | null;
5955
+ deploymentId: number;
5956
+ description?: string | null;
5957
+ id: number;
5958
+ /** @description False while the schedule is paused. */
5959
+ isEnabled: boolean;
5960
+ name: string;
5961
+ nextRunAt?: string | null;
5962
+ /** @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. */
5963
+ prompt: string;
5964
+ /** @description IANA time zone the cron is read in, e.g. `America/New_York`. Defaults to `UTC`. */
5965
+ timezone: string;
5966
+ /** @description The creator. Every run executes as this user, and only they or an admin may change, delete or run the task. */
5967
+ userId: number;
5968
+ };
5969
+ ScheduledTaskRunResponse: {
5970
+ /** @description The chat thread the run produced. */
5971
+ chatThreadUuid: string;
5972
+ createdAt: string;
5973
+ status?: string | null;
5974
+ };
5975
+ ScheduledTaskRunsListResponse: {
5976
+ items: components["schemas"]["ScheduledTaskRunResponse"][];
5977
+ pageInfo: components["schemas"]["PageInfo"];
5978
+ };
5979
+ SetBranchStagingEnvironmentRequest: {
5980
+ branchId?: number | null;
5981
+ branchName?: string | null;
5982
+ enabled: boolean;
5983
+ };
5984
+ SetBranchStagingEnvironmentResponse: {
5985
+ data: components["schemas"]["BranchResponse"];
5584
5986
  };
5585
5987
  SetEmbedDashboardCommentResolvedBody: {
5586
5988
  resolved: boolean;
@@ -5598,6 +6000,41 @@ export interface components {
5598
6000
  showAppliedFilters?: boolean | null;
5599
6001
  suppressDuplicateValues?: boolean | null;
5600
6002
  };
6003
+ SnowflakeSemanticViewGeneratedFileResponse: {
6004
+ hash?: string | null;
6005
+ path: string;
6006
+ };
6007
+ SnowflakeSemanticViewPullResultResponse: {
6008
+ completedAt: string;
6009
+ durationMs: number;
6010
+ generatedFiles: components["schemas"]["SnowflakeSemanticViewGeneratedFileResponse"][];
6011
+ syncJobId: string;
6012
+ viewCount: number;
6013
+ };
6014
+ SnowflakeSemanticViewPushResultResponse: {
6015
+ completedAt: string;
6016
+ durationMs: number;
6017
+ syncJobId: string;
6018
+ viewCount: number;
6019
+ };
6020
+ SnowflakeSemanticViewSyncProgressResponse: {
6021
+ message?: string | null;
6022
+ percentComplete: number;
6023
+ stage: string;
6024
+ };
6025
+ SnowflakeSemanticViewSyncStartResponse: {
6026
+ /** Format: uuid */
6027
+ syncJobId: string;
6028
+ workflowId: string;
6029
+ };
6030
+ SnowflakeSemanticViewSyncStatusResponse: {
6031
+ error?: string | null;
6032
+ progress: components["schemas"]["SnowflakeSemanticViewSyncProgressResponse"];
6033
+ /** @description COMPLETED and FAILED are terminal. Treat other values as in progress. */
6034
+ status: string;
6035
+ syncJobId: string;
6036
+ updatedAt: string;
6037
+ };
5601
6038
  SourceTreeResponse: {
5602
6039
  /**
5603
6040
  * @deprecated
@@ -5648,6 +6085,30 @@ export interface components {
5648
6085
  branchName: string;
5649
6086
  questionFile?: string | null;
5650
6087
  };
6088
+ StartReportDeliveryRunResponse: {
6089
+ /** @description Id of the run, which writes the sheet in the background. */
6090
+ runId: number;
6091
+ };
6092
+ StartSnowflakeSemanticViewPullInput: {
6093
+ branchName?: string | null;
6094
+ commitMessage?: string | null;
6095
+ dataSource?: string | null;
6096
+ idempotencyKey?: string | null;
6097
+ namePrefix?: string | null;
6098
+ outputPath: string;
6099
+ schema: string;
6100
+ titlePrefix?: string | null;
6101
+ viewNames?: string[] | null;
6102
+ };
6103
+ StartSnowflakeSemanticViewSyncInput: {
6104
+ branchName?: string | null;
6105
+ dataSource?: string | null;
6106
+ idempotencyKey?: string | null;
6107
+ prefix: string;
6108
+ schema: string;
6109
+ schemaPath?: string | null;
6110
+ viewNames: string[];
6111
+ };
5651
6112
  StartUploadResponse: {
5652
6113
  deploymentName: string;
5653
6114
  transaction: components["schemas"]["UploadTransaction"];
@@ -5801,6 +6262,13 @@ export interface components {
5801
6262
  threadId: string;
5802
6263
  widgetId: string;
5803
6264
  };
6265
+ UpdateReportDeliveryInput: {
6266
+ destination?: components["schemas"]["ReportDeliveryDestinationInput"] | null;
6267
+ name?: string | null;
6268
+ reportId?: number | null;
6269
+ schedule?: components["schemas"]["ReportDeliveryScheduleInput"] | null;
6270
+ shape?: components["schemas"]["ReportDeliveryShapeInput"] | null;
6271
+ };
5804
6272
  UpdateReportInput: {
5805
6273
  endResultCell?: string | null;
5806
6274
  externalWorkbookId?: string | null;
@@ -5844,6 +6312,15 @@ export interface components {
5844
6312
  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";
5845
6313
  /** @enum {string} */
5846
6314
  UpdateResourceUserPolicyBodyResourceType: "Global" | "Deployment" | "Report" | "ReportFolder" | "Agent" | "AgentSpace" | "Workbook" | "Dashboard" | "Folder" | "ChatThread";
6315
+ UpdateScheduledTaskInput: {
6316
+ agentId?: number | null;
6317
+ cronExpression?: string | null;
6318
+ description?: string | null;
6319
+ isEnabled?: boolean | null;
6320
+ name?: string | null;
6321
+ prompt?: string | null;
6322
+ timezone?: string | null;
6323
+ };
5847
6324
  UpdateWorkbookInput: {
5848
6325
  folderId?: number | null;
5849
6326
  meta?: {
@@ -8084,6 +8561,170 @@ export interface operations {
8084
8561
  };
8085
8562
  };
8086
8563
  };
8564
+ "ReportDeliveriesPublicController.getReportDeliveries": {
8565
+ parameters: {
8566
+ query?: {
8567
+ reportId?: number | null;
8568
+ ownerUserId?: number | null;
8569
+ spreadsheet?: string | null;
8570
+ after?: string;
8571
+ first?: number;
8572
+ };
8573
+ header?: never;
8574
+ path: {
8575
+ /** @description Numeric id of the deployment that owns the delivery. */
8576
+ deploymentId: number;
8577
+ };
8578
+ cookie?: never;
8579
+ };
8580
+ requestBody?: never;
8581
+ responses: {
8582
+ 200: {
8583
+ headers: {
8584
+ [name: string]: any;
8585
+ };
8586
+ content: {
8587
+ "application/json": components["schemas"]["ReportDeliveriesListResponse"];
8588
+ };
8589
+ };
8590
+ };
8591
+ };
8592
+ "ReportDeliveriesPublicController.createReportDelivery": {
8593
+ parameters: {
8594
+ query?: never;
8595
+ header?: never;
8596
+ path: {
8597
+ /** @description Numeric id of the deployment that owns the delivery. */
8598
+ deploymentId: number;
8599
+ };
8600
+ cookie?: never;
8601
+ };
8602
+ /** @description CreateReportDeliveryInput */
8603
+ requestBody?: {
8604
+ content: {
8605
+ "application/json": components["schemas"]["CreateReportDeliveryInput"];
8606
+ };
8607
+ };
8608
+ responses: {
8609
+ 200: {
8610
+ headers: {
8611
+ [name: string]: any;
8612
+ };
8613
+ content: {
8614
+ "application/json": components["schemas"]["ReportDeliveryResponse"];
8615
+ };
8616
+ };
8617
+ };
8618
+ };
8619
+ "ReportDeliveriesPublicController.getReportDelivery": {
8620
+ parameters: {
8621
+ query?: never;
8622
+ header?: never;
8623
+ path: {
8624
+ /** @description Numeric id of the deployment that owns the delivery. */
8625
+ deploymentId: number;
8626
+ /** @description Numeric id of the report delivery. */
8627
+ id: number;
8628
+ };
8629
+ cookie?: never;
8630
+ };
8631
+ requestBody?: never;
8632
+ responses: {
8633
+ 200: {
8634
+ headers: {
8635
+ [name: string]: any;
8636
+ };
8637
+ content: {
8638
+ "application/json": components["schemas"]["ReportDeliveryResponse"];
8639
+ };
8640
+ };
8641
+ };
8642
+ };
8643
+ "ReportDeliveriesPublicController.updateReportDelivery": {
8644
+ parameters: {
8645
+ query?: never;
8646
+ header?: never;
8647
+ path: {
8648
+ /** @description Numeric id of the deployment that owns the delivery. */
8649
+ deploymentId: number;
8650
+ /** @description Numeric id of the report delivery. */
8651
+ id: number;
8652
+ };
8653
+ cookie?: never;
8654
+ };
8655
+ /** @description UpdateReportDeliveryInput */
8656
+ requestBody?: {
8657
+ content: {
8658
+ "application/json": components["schemas"]["UpdateReportDeliveryInput"];
8659
+ };
8660
+ };
8661
+ responses: {
8662
+ 200: {
8663
+ headers: {
8664
+ [name: string]: any;
8665
+ };
8666
+ content: {
8667
+ "application/json": components["schemas"]["ReportDeliveryResponse"];
8668
+ };
8669
+ };
8670
+ };
8671
+ };
8672
+ "ReportDeliveriesPublicController.deleteReportDelivery": {
8673
+ parameters: {
8674
+ query?: never;
8675
+ header?: never;
8676
+ path: {
8677
+ /** @description Numeric id of the deployment that owns the delivery. */
8678
+ deploymentId: number;
8679
+ /** @description Numeric id of the report delivery. */
8680
+ id: number;
8681
+ };
8682
+ cookie?: never;
8683
+ };
8684
+ requestBody?: never;
8685
+ responses: {
8686
+ /** @description Successful response */
8687
+ 200: {
8688
+ headers: {
8689
+ [name: string]: any;
8690
+ };
8691
+ content: {
8692
+ "application/json": any;
8693
+ };
8694
+ };
8695
+ /** @description Report delivery deleted. */
8696
+ 204: {
8697
+ headers: {
8698
+ [name: string]: any;
8699
+ };
8700
+ content?: never;
8701
+ };
8702
+ };
8703
+ };
8704
+ "ReportDeliveriesPublicController.startReportDeliveryRun": {
8705
+ parameters: {
8706
+ query?: never;
8707
+ header?: never;
8708
+ path: {
8709
+ /** @description Numeric id of the deployment that owns the delivery. */
8710
+ deploymentId: number;
8711
+ /** @description Numeric id of the report delivery. */
8712
+ id: number;
8713
+ };
8714
+ cookie?: never;
8715
+ };
8716
+ requestBody?: never;
8717
+ responses: {
8718
+ 202: {
8719
+ headers: {
8720
+ [name: string]: any;
8721
+ };
8722
+ content: {
8723
+ "application/json": components["schemas"]["StartReportDeliveryRunResponse"];
8724
+ };
8725
+ };
8726
+ };
8727
+ };
8087
8728
  "ReportsPublicController.getReportFolders": {
8088
8729
  parameters: {
8089
8730
  query?: {
@@ -8346,6 +8987,175 @@ export interface operations {
8346
8987
  };
8347
8988
  };
8348
8989
  };
8990
+ "ScheduledTasksPublicController.listScheduledTasks": {
8991
+ parameters: {
8992
+ query?: {
8993
+ after?: string | null;
8994
+ first?: number | null;
8995
+ };
8996
+ header?: never;
8997
+ path: {
8998
+ deploymentId: number;
8999
+ };
9000
+ cookie?: never;
9001
+ };
9002
+ requestBody?: never;
9003
+ responses: {
9004
+ 200: {
9005
+ headers: {
9006
+ [name: string]: any;
9007
+ };
9008
+ content: {
9009
+ "application/json": components["schemas"]["ScheduledTaskListResponse"];
9010
+ };
9011
+ };
9012
+ };
9013
+ };
9014
+ "ScheduledTasksPublicController.createScheduledTask": {
9015
+ parameters: {
9016
+ query?: never;
9017
+ header?: never;
9018
+ path: {
9019
+ deploymentId: number;
9020
+ };
9021
+ cookie?: never;
9022
+ };
9023
+ /** @description CreateScheduledTaskInput */
9024
+ requestBody: {
9025
+ content: {
9026
+ "application/json": components["schemas"]["CreateScheduledTaskInput"];
9027
+ };
9028
+ };
9029
+ responses: {
9030
+ 200: {
9031
+ headers: {
9032
+ [name: string]: any;
9033
+ };
9034
+ content: {
9035
+ "application/json": components["schemas"]["ScheduledTaskResponse"];
9036
+ };
9037
+ };
9038
+ };
9039
+ };
9040
+ "ScheduledTasksPublicController.getScheduledTask": {
9041
+ parameters: {
9042
+ query?: never;
9043
+ header?: never;
9044
+ path: {
9045
+ deploymentId: number;
9046
+ taskId: number;
9047
+ };
9048
+ cookie?: never;
9049
+ };
9050
+ requestBody?: never;
9051
+ responses: {
9052
+ 200: {
9053
+ headers: {
9054
+ [name: string]: any;
9055
+ };
9056
+ content: {
9057
+ "application/json": components["schemas"]["ScheduledTaskResponse"];
9058
+ };
9059
+ };
9060
+ };
9061
+ };
9062
+ "ScheduledTasksPublicController.updateScheduledTask": {
9063
+ parameters: {
9064
+ query?: never;
9065
+ header?: never;
9066
+ path: {
9067
+ deploymentId: number;
9068
+ taskId: number;
9069
+ };
9070
+ cookie?: never;
9071
+ };
9072
+ /** @description UpdateScheduledTaskInput */
9073
+ requestBody: {
9074
+ content: {
9075
+ "application/json": components["schemas"]["UpdateScheduledTaskInput"];
9076
+ };
9077
+ };
9078
+ responses: {
9079
+ 200: {
9080
+ headers: {
9081
+ [name: string]: any;
9082
+ };
9083
+ content: {
9084
+ "application/json": components["schemas"]["ScheduledTaskResponse"];
9085
+ };
9086
+ };
9087
+ };
9088
+ };
9089
+ "ScheduledTasksPublicController.deleteScheduledTask": {
9090
+ parameters: {
9091
+ query?: never;
9092
+ header?: never;
9093
+ path: {
9094
+ deploymentId: number;
9095
+ taskId: number;
9096
+ };
9097
+ cookie?: never;
9098
+ };
9099
+ requestBody?: never;
9100
+ responses: {
9101
+ /** @description Successful response */
9102
+ 200: {
9103
+ headers: {
9104
+ [name: string]: any;
9105
+ };
9106
+ content: {
9107
+ "application/json": any;
9108
+ };
9109
+ };
9110
+ };
9111
+ };
9112
+ "ScheduledTasksPublicController.runScheduledTask": {
9113
+ parameters: {
9114
+ query?: never;
9115
+ header?: never;
9116
+ path: {
9117
+ deploymentId: number;
9118
+ taskId: number;
9119
+ };
9120
+ cookie?: never;
9121
+ };
9122
+ requestBody?: never;
9123
+ responses: {
9124
+ 200: {
9125
+ headers: {
9126
+ [name: string]: any;
9127
+ };
9128
+ content: {
9129
+ "application/json": components["schemas"]["RunScheduledTaskResponse"];
9130
+ };
9131
+ };
9132
+ };
9133
+ };
9134
+ "ScheduledTasksPublicController.listScheduledTaskRuns": {
9135
+ parameters: {
9136
+ query?: {
9137
+ after?: string | null;
9138
+ first?: number | null;
9139
+ };
9140
+ header?: never;
9141
+ path: {
9142
+ deploymentId: number;
9143
+ taskId: number;
9144
+ };
9145
+ cookie?: never;
9146
+ };
9147
+ requestBody?: never;
9148
+ responses: {
9149
+ 200: {
9150
+ headers: {
9151
+ [name: string]: any;
9152
+ };
9153
+ content: {
9154
+ "application/json": components["schemas"]["ScheduledTaskRunsListResponse"];
9155
+ };
9156
+ };
9157
+ };
9158
+ };
8349
9159
  "DeploymentsPublicController.getDeploymentSettings": {
8350
9160
  parameters: {
8351
9161
  query?: never;
@@ -8396,6 +9206,146 @@ export interface operations {
8396
9206
  };
8397
9207
  };
8398
9208
  };
9209
+ "SnowflakeSemanticViewSyncPublicController.startSnowflakeSemanticViewPull": {
9210
+ parameters: {
9211
+ query?: never;
9212
+ header?: never;
9213
+ path: {
9214
+ deploymentId: number;
9215
+ };
9216
+ cookie?: never;
9217
+ };
9218
+ /** @description StartSnowflakeSemanticViewPullInput */
9219
+ requestBody: {
9220
+ content: {
9221
+ "application/json": components["schemas"]["StartSnowflakeSemanticViewPullInput"];
9222
+ };
9223
+ };
9224
+ responses: {
9225
+ 202: {
9226
+ headers: {
9227
+ [name: string]: any;
9228
+ };
9229
+ content: {
9230
+ "application/json": components["schemas"]["SnowflakeSemanticViewSyncStartResponse"];
9231
+ };
9232
+ };
9233
+ };
9234
+ };
9235
+ "SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPullStatus": {
9236
+ parameters: {
9237
+ query?: never;
9238
+ header?: never;
9239
+ path: {
9240
+ deploymentId: number;
9241
+ syncJobId: string;
9242
+ };
9243
+ cookie?: never;
9244
+ };
9245
+ requestBody?: never;
9246
+ responses: {
9247
+ 200: {
9248
+ headers: {
9249
+ [name: string]: any;
9250
+ };
9251
+ content: {
9252
+ "application/json": components["schemas"]["SnowflakeSemanticViewSyncStatusResponse"];
9253
+ };
9254
+ };
9255
+ };
9256
+ };
9257
+ "SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPullResult": {
9258
+ parameters: {
9259
+ query?: never;
9260
+ header?: never;
9261
+ path: {
9262
+ deploymentId: number;
9263
+ syncJobId: string;
9264
+ };
9265
+ cookie?: never;
9266
+ };
9267
+ requestBody?: never;
9268
+ responses: {
9269
+ 200: {
9270
+ headers: {
9271
+ [name: string]: any;
9272
+ };
9273
+ content: {
9274
+ "application/json": components["schemas"]["SnowflakeSemanticViewPullResultResponse"];
9275
+ };
9276
+ };
9277
+ };
9278
+ };
9279
+ "SnowflakeSemanticViewSyncPublicController.startSnowflakeSemanticViewPush": {
9280
+ parameters: {
9281
+ query?: never;
9282
+ header?: never;
9283
+ path: {
9284
+ deploymentId: number;
9285
+ };
9286
+ cookie?: never;
9287
+ };
9288
+ /** @description StartSnowflakeSemanticViewSyncInput */
9289
+ requestBody: {
9290
+ content: {
9291
+ "application/json": components["schemas"]["StartSnowflakeSemanticViewSyncInput"];
9292
+ };
9293
+ };
9294
+ responses: {
9295
+ 202: {
9296
+ headers: {
9297
+ [name: string]: any;
9298
+ };
9299
+ content: {
9300
+ "application/json": components["schemas"]["SnowflakeSemanticViewSyncStartResponse"];
9301
+ };
9302
+ };
9303
+ };
9304
+ };
9305
+ "SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPushStatus": {
9306
+ parameters: {
9307
+ query?: never;
9308
+ header?: never;
9309
+ path: {
9310
+ deploymentId: number;
9311
+ syncJobId: string;
9312
+ };
9313
+ cookie?: never;
9314
+ };
9315
+ requestBody?: never;
9316
+ responses: {
9317
+ 200: {
9318
+ headers: {
9319
+ [name: string]: any;
9320
+ };
9321
+ content: {
9322
+ "application/json": components["schemas"]["SnowflakeSemanticViewSyncStatusResponse"];
9323
+ };
9324
+ };
9325
+ };
9326
+ };
9327
+ "SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPushResult": {
9328
+ parameters: {
9329
+ query?: never;
9330
+ header?: never;
9331
+ path: {
9332
+ deploymentId: number;
9333
+ syncJobId: string;
9334
+ };
9335
+ cookie?: never;
9336
+ };
9337
+ requestBody?: never;
9338
+ responses: {
9339
+ 200: {
9340
+ headers: {
9341
+ [name: string]: any;
9342
+ };
9343
+ content: {
9344
+ "application/json": components["schemas"]["SnowflakeSemanticViewPushResultResponse"];
9345
+ };
9346
+ };
9347
+ };
9348
+ };
8399
9349
  "DeploymentsPublicController.deploymentToken": {
8400
9350
  parameters: {
8401
9351
  query?: never;