@keboola/api-client 0.1.0 → 1.0.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.
Files changed (132) hide show
  1. package/README.md +18 -1
  2. package/dist/ai/index.cjs +7 -1
  3. package/dist/ai/index.cjs.map +1 -1
  4. package/dist/ai/index.js +7 -1
  5. package/dist/ai/index.js.map +1 -1
  6. package/dist/assets/index.cjs +7 -1
  7. package/dist/assets/index.cjs.map +1 -1
  8. package/dist/assets/index.js +7 -1
  9. package/dist/assets/index.js.map +1 -1
  10. package/dist/chat/index.cjs +3 -1
  11. package/dist/chat/index.cjs.map +1 -1
  12. package/dist/chat/index.js +3 -1
  13. package/dist/chat/index.js.map +1 -1
  14. package/dist/constants/index.cjs +145 -0
  15. package/dist/constants/index.cjs.map +1 -0
  16. package/dist/constants/index.d.cts +28 -0
  17. package/dist/constants/index.d.ts +28 -0
  18. package/dist/constants/index.js +142 -0
  19. package/dist/constants/index.js.map +1 -0
  20. package/dist/dataScience/index.cjs +7 -2
  21. package/dist/dataScience/index.cjs.map +1 -1
  22. package/dist/dataScience/index.js +7 -2
  23. package/dist/dataScience/index.js.map +1 -1
  24. package/dist/domain/permissions/index.cjs +13 -0
  25. package/dist/domain/permissions/index.cjs.map +1 -0
  26. package/dist/domain/permissions/index.d.cts +5 -0
  27. package/dist/domain/permissions/index.d.ts +5 -0
  28. package/dist/domain/permissions/index.js +11 -0
  29. package/dist/domain/permissions/index.js.map +1 -0
  30. package/dist/editor/index.cjs +7 -10
  31. package/dist/editor/index.cjs.map +1 -1
  32. package/dist/editor/index.d.cts +11 -19
  33. package/dist/editor/index.d.ts +11 -19
  34. package/dist/editor/index.js +7 -10
  35. package/dist/editor/index.js.map +1 -1
  36. package/dist/editor/types.d.cts +1 -1
  37. package/dist/editor/types.d.ts +1 -1
  38. package/dist/encryption/index.cjs +7 -1
  39. package/dist/encryption/index.cjs.map +1 -1
  40. package/dist/encryption/index.js +7 -1
  41. package/dist/encryption/index.js.map +1 -1
  42. package/dist/import/index.cjs +7 -1
  43. package/dist/import/index.cjs.map +1 -1
  44. package/dist/import/index.js +7 -1
  45. package/dist/import/index.js.map +1 -1
  46. package/dist/index.cjs +143 -40
  47. package/dist/index.cjs.map +1 -1
  48. package/dist/index.d.cts +976 -204
  49. package/dist/index.d.ts +976 -204
  50. package/dist/index.js +143 -40
  51. package/dist/index.js.map +1 -1
  52. package/dist/management/index.cjs +40 -23
  53. package/dist/management/index.cjs.map +1 -1
  54. package/dist/management/index.d.cts +59 -23
  55. package/dist/management/index.d.ts +59 -23
  56. package/dist/management/index.js +40 -23
  57. package/dist/management/index.js.map +1 -1
  58. package/dist/management/types.d.cts +2 -2
  59. package/dist/management/types.d.ts +2 -2
  60. package/dist/metastore/index.cjs +7 -1
  61. package/dist/metastore/index.cjs.map +1 -1
  62. package/dist/metastore/index.js +7 -1
  63. package/dist/metastore/index.js.map +1 -1
  64. package/dist/oauth/index.cjs +234 -0
  65. package/dist/oauth/index.cjs.map +1 -0
  66. package/dist/oauth/index.d.cts +12 -0
  67. package/dist/oauth/index.d.ts +12 -0
  68. package/dist/oauth/index.js +228 -0
  69. package/dist/oauth/index.js.map +1 -0
  70. package/dist/oauth/types.cjs +4 -0
  71. package/dist/oauth/types.cjs.map +1 -0
  72. package/dist/oauth/types.d.cts +34 -0
  73. package/dist/oauth/types.d.ts +34 -0
  74. package/dist/oauth/types.js +3 -0
  75. package/dist/oauth/types.js.map +1 -0
  76. package/dist/queryService/index.cjs +7 -1
  77. package/dist/queryService/index.cjs.map +1 -1
  78. package/dist/queryService/index.js +7 -1
  79. package/dist/queryService/index.js.map +1 -1
  80. package/dist/queue/index.cjs +7 -1
  81. package/dist/queue/index.cjs.map +1 -1
  82. package/dist/queue/index.js +7 -1
  83. package/dist/queue/index.js.map +1 -1
  84. package/dist/sdk/configurations/index.cjs +14 -0
  85. package/dist/sdk/configurations/index.cjs.map +1 -0
  86. package/dist/sdk/configurations/index.d.cts +24 -0
  87. package/dist/sdk/configurations/index.d.ts +24 -0
  88. package/dist/sdk/configurations/index.js +11 -0
  89. package/dist/sdk/configurations/index.js.map +1 -0
  90. package/dist/sdk/storage/index.cjs +159 -0
  91. package/dist/sdk/storage/index.cjs.map +1 -1
  92. package/dist/sdk/storage/index.d.cts +118 -13
  93. package/dist/sdk/storage/index.d.ts +118 -13
  94. package/dist/sdk/storage/index.js +149 -1
  95. package/dist/sdk/storage/index.js.map +1 -1
  96. package/dist/status/index.cjs +7 -1
  97. package/dist/status/index.cjs.map +1 -1
  98. package/dist/status/index.js +7 -1
  99. package/dist/status/index.js.map +1 -1
  100. package/dist/storage/index.cjs +19 -8
  101. package/dist/storage/index.cjs.map +1 -1
  102. package/dist/storage/index.d.cts +1 -1
  103. package/dist/storage/index.d.ts +1 -1
  104. package/dist/storage/index.js +19 -8
  105. package/dist/storage/index.js.map +1 -1
  106. package/dist/storage/types.d.cts +2921 -1309
  107. package/dist/storage/types.d.ts +2921 -1309
  108. package/dist/{storageClient-YVWer22Y.d.ts → storageClient-C8LDO4gr.d.ts} +14 -0
  109. package/dist/{storageClient-DPLh_p0V.d.cts → storageClient-D05fdGHW.d.cts} +14 -0
  110. package/dist/storageSdk-CX03lGn-.d.ts +18 -0
  111. package/dist/storageSdk-DZV4nB3o.d.cts +18 -0
  112. package/dist/syncActions/index.cjs +7 -1
  113. package/dist/syncActions/index.cjs.map +1 -1
  114. package/dist/syncActions/index.js +7 -1
  115. package/dist/syncActions/index.js.map +1 -1
  116. package/dist/telemetry/index.cjs +7 -1
  117. package/dist/telemetry/index.cjs.map +1 -1
  118. package/dist/telemetry/index.js +7 -1
  119. package/dist/telemetry/index.js.map +1 -1
  120. package/dist/{types-B7k8S4ki.d.ts → types-B--u7l2H.d.ts} +33 -118
  121. package/dist/{types-BeShtGlc.d.cts → types-BTcT8Q0T.d.cts} +15 -1
  122. package/dist/{types-BeShtGlc.d.ts → types-BTcT8Q0T.d.ts} +15 -1
  123. package/dist/{types-BNQK_jR_.d.cts → types-C0Owx2P7.d.cts} +33 -118
  124. package/dist/vault/index.cjs +3 -1
  125. package/dist/vault/index.cjs.map +1 -1
  126. package/dist/vault/index.js +3 -1
  127. package/dist/vault/index.js.map +1 -1
  128. package/dist/verify/index.cjs +3 -1
  129. package/dist/verify/index.cjs.map +1 -1
  130. package/dist/verify/index.js +3 -1
  131. package/dist/verify/index.js.map +1 -1
  132. package/package.json +71 -5
package/dist/index.d.ts CHANGED
@@ -1,8 +1,9 @@
1
- import { G as GetAllFeaturesQuery, F as Feature, c as components$5, C as CreateMaintainerBody, U as UpdateMaintainerBody, M as MaintainerUser, A as AddMaintainerUserBody, a as CreateMaintainerInvitationBody, b as CreateMaintainerOrganizationBody, d as MetadataItem, S as SetMaintainerMetadataBody, e as UpdateOrganizationBody, f as AddOrganizationUserBody, g as CreateOrganizationInvitationBody, P as Project, h as CreateOrganizationProjectBody, i as SetOrganizationMetadataBody, j as GetProjectPath, k as CreateProjectFeaturePath, l as CreateProjectFeatureBody, R as RemoveProjectFeaturePath, m as User, L as ListProjectUsersPath, n as GetProjectMetadataPath, o as ProjectMetadataItem, p as SetProjectMetadataPath, q as SetProjectMetadataBody, r as GetProjectReviewersPath, s as Reviewer, t as SetProjectReviewersPath, u as SetProjectReviewersBody, v as AddUserFeatureBody, w as AddUserFeaturePath, x as RemoveUserFeaturePath } from './types-BeShtGlc.js';
1
+ import { G as GetAllFeaturesQuery, F as Feature, c as components$5, C as CreateMaintainerBody, U as UpdateMaintainerBody, M as MaintainerUser, A as AddMaintainerUserBody, a as CreateMaintainerInvitationBody, b as CreateMaintainerOrganizationBody, d as MetadataItem, S as SetMaintainerMetadataBody, O as OrganizationDetail, e as UpdateOrganizationBody, f as AddOrganizationUserBody, g as CreateOrganizationInvitationBody, P as Project, h as CreateOrganizationProjectBody, i as SetOrganizationMetadataBody, j as GetProjectPath, k as CreateProjectFeaturePath, l as CreateProjectFeatureBody, R as RemoveProjectFeaturePath, m as User, L as ListProjectUsersPath, n as GetProjectMetadataPath, o as ProjectMetadataItem, p as SetProjectMetadataPath, q as SetProjectMetadataBody, r as GetProjectReviewersPath, s as Reviewer, t as SetProjectReviewersPath, u as SetProjectReviewersBody, v as AddUserFeatureBody, w as AddUserFeaturePath, x as RemoveUserFeaturePath } from './types-BTcT8Q0T.js';
2
2
  import { M as MiddlewareFn, B as BaseClientOptions, A as ApiResponse, H as HttpMethod } from './types-DgaMV8FF.js';
3
3
  export { c as ApiError, d as CreateCallbackMiddlewareOptions, e as FetchClientError, i as isAbortError, f as isApiError, g as isFetchClientError } from './types-DgaMV8FF.js';
4
4
  import { StatusSummary } from './status/types.js';
5
5
  import { Post } from './assets/types.js';
6
+ import { GetCredentialsQuery, Credential, CreateCredentialBody } from './oauth/types.js';
6
7
  import * as zod from 'zod';
7
8
  import { c as OpenapiQueryType, d as OpenapiPathType, b as OpenapiBodyType, a as OpenapiReturnType } from './types-C7mpAfq-.js';
8
9
  import { U as UploadFileParams, a as UploadedFile } from './types-Dg1tEsVR.js';
@@ -13,15 +14,15 @@ import { G as GetQueueJobPath, c as components$2, S as SearchJobsQuery } from '.
13
14
  import { P as PostQueryPath, a as PostQueryBody, b as PostCancelQueryJobPath, G as GetQueryJobPath, c as components$1, d as GetQueryResultsPath, e as GetQueryResutsQuery, f as GetQueriesPath, g as GetQueriesHistoryQuery, h as GetExportResultsQuery, E as ExportResultsResponse } from './types-CGMJT3JL.js';
14
15
  import { CreateCredentialsBody, WorkspaceData } from './telemetry/types.js';
15
16
  import { EnrollMFAInput, GetDataAppPublicGitRepositoryInput, GetDataAppPasswordPrivateGitRepositoryInput, GetDataAppSSHKeyPrivateGitRepositoryInput, GetPublicGitRepositoryInput, GetGitPrivateRepositoryInput } from './syncActions/types.js';
16
- import { C as CreateSqlSessionBody, G as GetSqlSessionPath, a as GetSqlSessionsQuery, b as GetSqlSessionSchemaPath, c as GetSqlSessionSchemaQuery, d as components, P as PostSqlRunQueryPath, e as PostSqlRunQueryBody, f as PostSqlTablePreviewPath, g as PostSqlTablePreviewBody, h as GetSqlSessionTableDdlPath, i as GetSqlSessionTableDdlQuery, j as PostSqlSessionLoadPath, k as PostSqlSessionLoadBody, l as PostSqlSessionUnloadPath, m as PostSqlSessionUnloadBody } from './types-B7k8S4ki.js';
17
+ import { C as CreateSqlSessionBody, G as GetSqlSessionPath, a as GetSqlSessionsQuery, b as GetSqlSessionSchemaPath, c as GetSqlSessionSchemaQuery, d as components, P as PostSqlRunQueryPath, e as PostSqlRunQueryBody, f as PostSqlTablePreviewPath, g as PostSqlTablePreviewBody, h as GetSqlSessionTableDdlPath, i as GetSqlSessionTableDdlQuery, j as PostSqlSessionLoadPath, k as PostSqlSessionLoadBody, l as PostSqlSessionUnloadPath, m as PostSqlSessionUnloadBody } from './types-B--u7l2H.js';
17
18
  import { EncryptQuery } from './encryption/types.js';
18
19
  import { G as GetDataAppRunsPath, a as GetDataAppRunsQuery, b as GetDataAppRunPath, c as GetDataAppLogsDownloadPath, d as GetDataAppLogsTailPath, e as GetDataAppLogsTailQuery, L as LogEntry, f as GetAppsQuery, g as GetDataAppPath, C as CreateDataAppBody, P as PatchDataAppPath, h as PatchDataAppBody, D as DeleteDataAppPath, i as GetDataAppPasswordPath, R as ResetDataAppPasswordPath, j as GetSandboxPath } from './utils-BNQZiNOu.js';
19
20
  export { p as parseLogLines } from './utils-BNQZiNOu.js';
20
21
  import { CreateVariableBody, DeleteVariablePath, VariableWithHash, GetVariablesQuery, GetVariablesByBranchId } from './vault/types.js';
21
22
  import { ServiceId, CreateTableAsyncBody, TableCreateJob, TableImportAsyncBody, TableImportJob, TableExportAsyncBody, TableExportJob, Service, StackComponent, GetBucketsQuery, Bucket, BucketDetail, CreateBucketBody, UpdateBucketBody, CreateScheduledRefreshPath, CreateScheduledRefreshBody, ScheduledTask, GetEventsQuery, StorageEvent, CreateEventBody, File as File$1, GetFilesQuery, DeleteFileTagPath, PrepareFileBody, PreparedFile, GetTablesQuery, Table, TableDetail, GetDataPreview, PrevieData, DeleteTableRows, JobUnion, DevBranch, CreateDevBranchJobBody, DevBranchPath, BranchMetadata, BranchMetadataEntry, WorkspacePath, Workspace, WorkspacesPath, ResetWorkspacePassword, SetWorkspacePublicInput, GetWorkspaceSaml2LoginPath, WorkspaceSaml2Login, WorkspaceObject, DeleteWorkspaceObjectInput, MergeRequestDetail, MergeRequestDetailWithActivityLog, CreateMergeRequestParams, UpdateMergeRequestParams, JobOperation, GetJobPath, Job, GetJobsQuery, GetComponentPath, Component, GetComponentsPath, GetComponentsQuery, GetSearchComponentConfigurationsPath, SearchComponentConfigurationsQuery, SearchComponentConfiguration, PartialKey, CreateConfigurationInput, BaseComponentConfig, ConfigType, ConfigurationPath, ComponentConfig, GetConfigurationsPath, CreateConfigurationRowInput, Row, CreateConfigurationRowsInput, CreateConfigurationRowBody, DeleteConfigurationRowInput, DeleteConfigurationRowsInput, CreateConfigurationWorkspaceBody, ConfigurationUseCaseType, ConfigurationVersionPath, ConfigurationVersion, ConfigurationVersionDetailPath, ConfigurationVersionDetail, GetStackInfoQuery, StackInfo } from './storage/types.js';
22
23
  import { M as MetaObject } from './types-BY0tjg2Q.js';
23
- import { C as ConcurrentOptions, M as MiddlewareFn$1 } from './storageClient-YVWer22Y.js';
24
- export { a as concurrent } from './storageClient-YVWer22Y.js';
24
+ import { C as ConcurrentOptions, M as MiddlewareFn$1 } from './storageClient-C8LDO4gr.js';
25
+ export { a as concurrent } from './storageClient-C8LDO4gr.js';
25
26
  import { K as KeboolaObjectId } from './keboolaUID-D1DGSbge.js';
26
27
  export { k as keboolaUID } from './keboolaUID-D1DGSbge.js';
27
28
  import { TagWithBindings, TagData, CreateMetaObjectMetaDataInput, UpdateMetaObjectMetaDataInput } from './sdk/tag/types.js';
@@ -29,7 +30,7 @@ import { B as Backend, S as StorageToken } from './types-DYMMsuU0.js';
29
30
  export { c as createGenericFetchClient } from './createGenericFetchClient-DEakI3F1.js';
30
31
  export { M as ManagementClientAuthError, i as isManagementClientAuthError } from './authMiddleware-BTFSCMTE.js';
31
32
  import { ManagementToken } from './verify/types.js';
32
- export { createStorageSdk } from './sdk/storage/index.js';
33
+ export { c as createStorageSdk } from './storageSdk-CX03lGn-.js';
33
34
  import 'qs';
34
35
  import './createOpenapiFetchClient-_sm4bchL.js';
35
36
  import './metastore/index.js';
@@ -181,18 +182,15 @@ type paths = {
181
182
  'application/json': {
182
183
  chats: {
183
184
  /** Format: uuid */
184
- id: string;
185
- title: string;
186
- userId: string;
185
+ id?: string;
186
+ title?: string;
187
+ userId?: string;
187
188
  /** Format: date-time */
188
- createdAt: string;
189
- /**
190
- * Format: date-time
191
- * @description Timestamp of the last message in this chat
192
- */
193
- lastMessageAt: string;
189
+ createdAt?: string;
190
+ /** Format: date-time */
191
+ lastMessageAt?: string;
194
192
  /** @enum {string} */
195
- visibility: 'public' | 'private';
193
+ visibility?: 'public' | 'private';
196
194
  branchId?: number | null;
197
195
  }[];
198
196
  hasMore: boolean;
@@ -276,6 +274,7 @@ type paths = {
276
274
  hidden?: boolean;
277
275
  requestContext?: {
278
276
  path?: string;
277
+ sqlEditorActive?: boolean;
279
278
  };
280
279
  };
281
280
  };
@@ -329,6 +328,21 @@ type paths = {
329
328
  };
330
329
  };
331
330
  };
331
+ /** @description A message is already being processed in this chat */
332
+ 409: {
333
+ headers: {
334
+ [name: string]: unknown;
335
+ };
336
+ content: {
337
+ 'application/json': {
338
+ error: {
339
+ type: string;
340
+ surface: string;
341
+ message: string;
342
+ };
343
+ };
344
+ };
345
+ };
332
346
  /** @description Rate limit exceeded */
333
347
  429: {
334
348
  headers: {
@@ -369,18 +383,13 @@ type paths = {
369
383
  content: {
370
384
  'application/json': {
371
385
  /** Format: uuid */
372
- id: string;
373
- title: string;
374
- userId: string;
386
+ id?: string;
387
+ title?: string;
388
+ userId?: string;
375
389
  /** Format: date-time */
376
- createdAt: string;
377
- /**
378
- * Format: date-time
379
- * @description Timestamp of the last message in this chat
380
- */
381
- lastMessageAt: string;
390
+ createdAt?: string;
382
391
  /** @enum {string} */
383
- visibility: 'public' | 'private';
392
+ visibility?: 'public' | 'private';
384
393
  branchId?: number | null;
385
394
  };
386
395
  };
@@ -437,6 +446,180 @@ type paths = {
437
446
  patch?: never;
438
447
  trace?: never;
439
448
  };
449
+ '/api/chat/{id}/stream': {
450
+ parameters: {
451
+ query?: never;
452
+ header?: never;
453
+ path?: never;
454
+ cookie?: never;
455
+ };
456
+ /**
457
+ * Reattach to the in-flight SSE stream for a chat
458
+ * @description Subscribe to the bus for a running or recently-completed assistant turn. Replays buffered events from the start of the run, then continues live (if the run is still in flight). Returns 404 if no run exists for this chat or its retention window has expired.
459
+ */
460
+ get: {
461
+ parameters: {
462
+ query?: never;
463
+ header?: never;
464
+ path: {
465
+ id: string;
466
+ };
467
+ cookie?: never;
468
+ };
469
+ requestBody?: never;
470
+ responses: {
471
+ /** @description SSE stream of chat events */
472
+ 200: {
473
+ headers: {
474
+ [name: string]: unknown;
475
+ };
476
+ content: {
477
+ 'text/event-stream': unknown;
478
+ };
479
+ };
480
+ /** @description Unauthorized */
481
+ 401: {
482
+ headers: {
483
+ [name: string]: unknown;
484
+ };
485
+ content: {
486
+ 'application/json': {
487
+ error: {
488
+ type: string;
489
+ surface: string;
490
+ message: string;
491
+ };
492
+ };
493
+ };
494
+ };
495
+ /** @description Forbidden */
496
+ 403: {
497
+ headers: {
498
+ [name: string]: unknown;
499
+ };
500
+ content: {
501
+ 'application/json': {
502
+ error: {
503
+ type: string;
504
+ surface: string;
505
+ message: string;
506
+ };
507
+ };
508
+ };
509
+ };
510
+ /** @description No stream for this chat — either never started or retention window expired */
511
+ 404: {
512
+ headers: {
513
+ [name: string]: unknown;
514
+ };
515
+ content: {
516
+ 'application/json': {
517
+ error: {
518
+ type: string;
519
+ surface: string;
520
+ message: string;
521
+ };
522
+ };
523
+ };
524
+ };
525
+ };
526
+ };
527
+ put?: never;
528
+ post?: never;
529
+ delete?: never;
530
+ options?: never;
531
+ head?: never;
532
+ patch?: never;
533
+ trace?: never;
534
+ };
535
+ '/api/chat/{id}/stop': {
536
+ parameters: {
537
+ query?: never;
538
+ header?: never;
539
+ path?: never;
540
+ cookie?: never;
541
+ };
542
+ get?: never;
543
+ put?: never;
544
+ /**
545
+ * Stop the in-flight assistant turn for a chat
546
+ * @description Signals the chat handler to abort the sandbox process. Idempotent — returns 200 even if no run is active.
547
+ */
548
+ post: {
549
+ parameters: {
550
+ query?: never;
551
+ header?: never;
552
+ path: {
553
+ id: string;
554
+ };
555
+ cookie?: never;
556
+ };
557
+ requestBody?: never;
558
+ responses: {
559
+ /** @description Stop requested (or no run was active) */
560
+ 200: {
561
+ headers: {
562
+ [name: string]: unknown;
563
+ };
564
+ content: {
565
+ 'application/json': {
566
+ stopped: boolean;
567
+ };
568
+ };
569
+ };
570
+ /** @description Unauthorized */
571
+ 401: {
572
+ headers: {
573
+ [name: string]: unknown;
574
+ };
575
+ content: {
576
+ 'application/json': {
577
+ error: {
578
+ type: string;
579
+ surface: string;
580
+ message: string;
581
+ };
582
+ };
583
+ };
584
+ };
585
+ /** @description Forbidden */
586
+ 403: {
587
+ headers: {
588
+ [name: string]: unknown;
589
+ };
590
+ content: {
591
+ 'application/json': {
592
+ error: {
593
+ type: string;
594
+ surface: string;
595
+ message: string;
596
+ };
597
+ };
598
+ };
599
+ };
600
+ /** @description Chat not found */
601
+ 404: {
602
+ headers: {
603
+ [name: string]: unknown;
604
+ };
605
+ content: {
606
+ 'application/json': {
607
+ error: {
608
+ type: string;
609
+ surface: string;
610
+ message: string;
611
+ };
612
+ };
613
+ };
614
+ };
615
+ };
616
+ };
617
+ delete?: never;
618
+ options?: never;
619
+ head?: never;
620
+ patch?: never;
621
+ trace?: never;
622
+ };
440
623
  '/api/chat/{id}': {
441
624
  parameters: {
442
625
  query?: never;
@@ -472,10 +655,7 @@ type paths = {
472
655
  userId: string;
473
656
  /** Format: date-time */
474
657
  createdAt: string;
475
- /**
476
- * Format: date-time
477
- * @description Timestamp of the last message in this chat
478
- */
658
+ /** Format: date-time */
479
659
  lastMessageAt: string;
480
660
  /** @enum {string} */
481
661
  visibility: 'public' | 'private';
@@ -508,11 +688,24 @@ type paths = {
508
688
  type: string;
509
689
  toolCallId: string;
510
690
  /** @enum {string} */
511
- state: 'output-available' | 'input-available' | 'input-streaming';
691
+ state:
692
+ | 'output-available'
693
+ | 'output-error'
694
+ | 'output-denied'
695
+ | 'input-available'
696
+ | 'input-streaming'
697
+ | 'approval-requested'
698
+ | 'approval-responded';
512
699
  input?: {
513
700
  [key: string]: unknown;
514
701
  };
515
702
  output?: unknown;
703
+ errorText?: string;
704
+ approval?: {
705
+ id: string;
706
+ approved: boolean;
707
+ reason?: string;
708
+ };
516
709
  }
517
710
  )[];
518
711
  metadata?: {
@@ -521,6 +714,7 @@ type paths = {
521
714
  hidden?: boolean;
522
715
  requestContext?: {
523
716
  path?: string;
717
+ sqlEditorActive?: boolean;
524
718
  };
525
719
  /** Format: uuid */
526
720
  compactedTo?: string;
@@ -760,16 +954,444 @@ type paths = {
760
954
  };
761
955
  content: {
762
956
  'application/json': {
763
- error: {
764
- type: string;
765
- surface: string;
766
- message: string;
767
- };
957
+ error: {
958
+ type: string;
959
+ surface: string;
960
+ message: string;
961
+ };
962
+ };
963
+ };
964
+ };
965
+ /** @description Forbidden */
966
+ 403: {
967
+ headers: {
968
+ [name: string]: unknown;
969
+ };
970
+ content: {
971
+ 'application/json': {
972
+ error: {
973
+ type: string;
974
+ surface: string;
975
+ message: string;
976
+ };
977
+ };
978
+ };
979
+ };
980
+ /** @description Chat not found */
981
+ 404: {
982
+ headers: {
983
+ [name: string]: unknown;
984
+ };
985
+ content: {
986
+ 'application/json': {
987
+ error: {
988
+ type: string;
989
+ surface: string;
990
+ message: string;
991
+ };
992
+ };
993
+ };
994
+ };
995
+ };
996
+ };
997
+ trace?: never;
998
+ };
999
+ '/api/chat/{id}/approval': {
1000
+ parameters: {
1001
+ query?: never;
1002
+ header?: never;
1003
+ path?: never;
1004
+ cookie?: never;
1005
+ };
1006
+ get?: never;
1007
+ put?: never;
1008
+ /**
1009
+ * Approve or deny a pending tool execution
1010
+ * @description Submit approval decision for a tool that requires human-in-the-loop confirmation
1011
+ */
1012
+ post: {
1013
+ parameters: {
1014
+ query?: never;
1015
+ header?: never;
1016
+ path: {
1017
+ id: string;
1018
+ };
1019
+ cookie?: never;
1020
+ };
1021
+ requestBody?: {
1022
+ content: {
1023
+ 'application/json': {
1024
+ toolUseId: string;
1025
+ approved: boolean;
1026
+ reason?: string;
1027
+ updatedInput?: {
1028
+ [key: string]: unknown;
1029
+ };
1030
+ answers?: {
1031
+ [key: string]: string;
1032
+ };
1033
+ };
1034
+ };
1035
+ };
1036
+ responses: {
1037
+ /** @description Approval processed */
1038
+ 200: {
1039
+ headers: {
1040
+ [name: string]: unknown;
1041
+ };
1042
+ content: {
1043
+ 'application/json': {
1044
+ success: boolean;
1045
+ toolUseId: string;
1046
+ approved: boolean;
1047
+ };
1048
+ };
1049
+ };
1050
+ /** @description Bad request */
1051
+ 400: {
1052
+ headers: {
1053
+ [name: string]: unknown;
1054
+ };
1055
+ content: {
1056
+ 'application/json': {
1057
+ error: {
1058
+ type: string;
1059
+ surface: string;
1060
+ message: string;
1061
+ };
1062
+ };
1063
+ };
1064
+ };
1065
+ /** @description Unauthorized */
1066
+ 401: {
1067
+ headers: {
1068
+ [name: string]: unknown;
1069
+ };
1070
+ content: {
1071
+ 'application/json': {
1072
+ error: {
1073
+ type: string;
1074
+ surface: string;
1075
+ message: string;
1076
+ };
1077
+ };
1078
+ };
1079
+ };
1080
+ /** @description Forbidden — approval belongs to different chat */
1081
+ 403: {
1082
+ headers: {
1083
+ [name: string]: unknown;
1084
+ };
1085
+ content: {
1086
+ 'application/json': {
1087
+ error: {
1088
+ type: string;
1089
+ surface: string;
1090
+ message: string;
1091
+ };
1092
+ };
1093
+ };
1094
+ };
1095
+ /** @description No pending approval found */
1096
+ 404: {
1097
+ headers: {
1098
+ [name: string]: unknown;
1099
+ };
1100
+ content: {
1101
+ 'application/json': {
1102
+ error: {
1103
+ type: string;
1104
+ surface: string;
1105
+ message: string;
1106
+ };
1107
+ };
1108
+ };
1109
+ };
1110
+ };
1111
+ };
1112
+ delete?: never;
1113
+ options?: never;
1114
+ head?: never;
1115
+ patch?: never;
1116
+ trace?: never;
1117
+ };
1118
+ '/api/chat/{id}/ui-tool-result': {
1119
+ parameters: {
1120
+ query?: never;
1121
+ header?: never;
1122
+ path?: never;
1123
+ cookie?: never;
1124
+ };
1125
+ get?: never;
1126
+ put?: never;
1127
+ /**
1128
+ * Submit the result of a UI tool (e.g. SQL editor) invocation
1129
+ * @description The frontend executes ui_sql_editor_* tools in the browser and returns the result here. The backend writes the result into the sandbox so the sandbox MCP server unblocks and returns it to the agent.
1130
+ */
1131
+ post: {
1132
+ parameters: {
1133
+ query?: never;
1134
+ header?: never;
1135
+ path: {
1136
+ id: string;
1137
+ };
1138
+ cookie?: never;
1139
+ };
1140
+ requestBody?: {
1141
+ content: {
1142
+ 'application/json': {
1143
+ toolUseId: string;
1144
+ output?: string;
1145
+ errorText?: string;
1146
+ };
1147
+ };
1148
+ };
1149
+ responses: {
1150
+ /** @description Result accepted */
1151
+ 200: {
1152
+ headers: {
1153
+ [name: string]: unknown;
1154
+ };
1155
+ content: {
1156
+ 'application/json': {
1157
+ success: boolean;
1158
+ toolUseId: string;
1159
+ };
1160
+ };
1161
+ };
1162
+ /** @description Bad request */
1163
+ 400: {
1164
+ headers: {
1165
+ [name: string]: unknown;
1166
+ };
1167
+ content: {
1168
+ 'application/json': {
1169
+ error: {
1170
+ type: string;
1171
+ surface: string;
1172
+ message: string;
1173
+ };
1174
+ };
1175
+ };
1176
+ };
1177
+ /** @description Unauthorized */
1178
+ 401: {
1179
+ headers: {
1180
+ [name: string]: unknown;
1181
+ };
1182
+ content: {
1183
+ 'application/json': {
1184
+ error: {
1185
+ type: string;
1186
+ surface: string;
1187
+ message: string;
1188
+ };
1189
+ };
1190
+ };
1191
+ };
1192
+ /** @description Forbidden — request belongs to a different chat */
1193
+ 403: {
1194
+ headers: {
1195
+ [name: string]: unknown;
1196
+ };
1197
+ content: {
1198
+ 'application/json': {
1199
+ error: {
1200
+ type: string;
1201
+ surface: string;
1202
+ message: string;
1203
+ };
1204
+ };
1205
+ };
1206
+ };
1207
+ /** @description No pending UI tool request found */
1208
+ 404: {
1209
+ headers: {
1210
+ [name: string]: unknown;
1211
+ };
1212
+ content: {
1213
+ 'application/json': {
1214
+ error: {
1215
+ type: string;
1216
+ surface: string;
1217
+ message: string;
1218
+ };
1219
+ };
1220
+ };
1221
+ };
1222
+ };
1223
+ };
1224
+ delete?: never;
1225
+ options?: never;
1226
+ head?: never;
1227
+ patch?: never;
1228
+ trace?: never;
1229
+ };
1230
+ '/api/usage': {
1231
+ parameters: {
1232
+ query?: never;
1233
+ header?: never;
1234
+ path?: never;
1235
+ cookie?: never;
1236
+ };
1237
+ /**
1238
+ * Get rate limit usage information
1239
+ * @description Returns the current rate limit usage for the authenticated user in the current project.
1240
+ */
1241
+ get: {
1242
+ parameters: {
1243
+ query?: never;
1244
+ header?: never;
1245
+ path?: never;
1246
+ cookie?: never;
1247
+ };
1248
+ requestBody?: never;
1249
+ responses: {
1250
+ /** @description Rate limit usage information */
1251
+ 200: {
1252
+ headers: {
1253
+ [name: string]: unknown;
1254
+ };
1255
+ content: {
1256
+ 'application/json': {
1257
+ messagesUsed: number;
1258
+ messagesLimit: number;
1259
+ /** Format: date-time */
1260
+ resetDate: string;
1261
+ };
1262
+ };
1263
+ };
1264
+ /** @description Unauthorized */
1265
+ 401: {
1266
+ headers: {
1267
+ [name: string]: unknown;
1268
+ };
1269
+ content: {
1270
+ 'application/json': {
1271
+ error: {
1272
+ type: string;
1273
+ surface: string;
1274
+ message: string;
1275
+ };
1276
+ };
1277
+ };
1278
+ };
1279
+ /** @description Internal server error */
1280
+ 500: {
1281
+ headers: {
1282
+ [name: string]: unknown;
1283
+ };
1284
+ content: {
1285
+ 'application/json': {
1286
+ error: {
1287
+ type: string;
1288
+ surface: string;
1289
+ message: string;
1290
+ };
1291
+ };
1292
+ };
1293
+ };
1294
+ };
1295
+ };
1296
+ put?: never;
1297
+ post?: never;
1298
+ delete?: never;
1299
+ options?: never;
1300
+ head?: never;
1301
+ patch?: never;
1302
+ trace?: never;
1303
+ };
1304
+ '/api/settings': {
1305
+ parameters: {
1306
+ query?: never;
1307
+ header?: never;
1308
+ path?: never;
1309
+ cookie?: never;
1310
+ };
1311
+ /**
1312
+ * Get project settings
1313
+ * @description Retrieve project-level custom instructions
1314
+ */
1315
+ get: {
1316
+ parameters: {
1317
+ query?: never;
1318
+ header?: never;
1319
+ path?: never;
1320
+ cookie?: never;
1321
+ };
1322
+ requestBody?: never;
1323
+ responses: {
1324
+ /** @description Project settings */
1325
+ 200: {
1326
+ headers: {
1327
+ [name: string]: unknown;
1328
+ };
1329
+ content: {
1330
+ 'application/json': {
1331
+ projectId: string;
1332
+ customInstructions: string | null;
1333
+ createdAt: string;
1334
+ updatedAt: string;
1335
+ };
1336
+ };
1337
+ };
1338
+ /** @description Unauthorized */
1339
+ 401: {
1340
+ headers: {
1341
+ [name: string]: unknown;
1342
+ };
1343
+ content: {
1344
+ 'application/json': {
1345
+ error: {
1346
+ type: string;
1347
+ surface: string;
1348
+ message: string;
1349
+ };
1350
+ };
1351
+ };
1352
+ };
1353
+ };
1354
+ };
1355
+ put?: never;
1356
+ post?: never;
1357
+ delete?: never;
1358
+ options?: never;
1359
+ head?: never;
1360
+ /**
1361
+ * Update project settings
1362
+ * @description Update project-level custom instructions
1363
+ */
1364
+ patch: {
1365
+ parameters: {
1366
+ query?: never;
1367
+ header?: never;
1368
+ path?: never;
1369
+ cookie?: never;
1370
+ };
1371
+ requestBody?: {
1372
+ content: {
1373
+ 'application/json': {
1374
+ customInstructions?: string | null;
1375
+ };
1376
+ };
1377
+ };
1378
+ responses: {
1379
+ /** @description Updated project settings */
1380
+ 200: {
1381
+ headers: {
1382
+ [name: string]: unknown;
1383
+ };
1384
+ content: {
1385
+ 'application/json': {
1386
+ projectId: string;
1387
+ customInstructions: string | null;
1388
+ createdAt: string;
1389
+ updatedAt: string;
768
1390
  };
769
1391
  };
770
1392
  };
771
- /** @description Forbidden */
772
- 403: {
1393
+ /** @description Bad request */
1394
+ 400: {
773
1395
  headers: {
774
1396
  [name: string]: unknown;
775
1397
  };
@@ -783,8 +1405,8 @@ type paths = {
783
1405
  };
784
1406
  };
785
1407
  };
786
- /** @description Chat not found */
787
- 404: {
1408
+ /** @description Unauthorized */
1409
+ 401: {
788
1410
  headers: {
789
1411
  [name: string]: unknown;
790
1412
  };
@@ -802,59 +1424,46 @@ type paths = {
802
1424
  };
803
1425
  trace?: never;
804
1426
  };
805
- '/api/chat/{id}/approval': {
1427
+ '/api/settings/user': {
806
1428
  parameters: {
807
1429
  query?: never;
808
1430
  header?: never;
809
1431
  path?: never;
810
1432
  cookie?: never;
811
1433
  };
812
- get?: never;
813
- put?: never;
814
1434
  /**
815
- * Approve or deny a pending tool execution
816
- * @description Submit approval decision for a tool that requires human-in-the-loop confirmation
1435
+ * Get user settings
1436
+ * @description Retrieve user-level custom instructions and tool permissions
817
1437
  */
818
- post: {
1438
+ get: {
819
1439
  parameters: {
820
1440
  query?: never;
821
1441
  header?: never;
822
- path: {
823
- id: string;
824
- };
1442
+ path?: never;
825
1443
  cookie?: never;
826
1444
  };
827
- requestBody?: {
828
- content: {
829
- 'application/json': {
830
- toolUseId: string;
831
- approved: boolean;
832
- reason?: string;
833
- updatedInput?: {
834
- [key: string]: unknown;
835
- };
836
- answers?: {
837
- [key: string]: string | string[];
838
- };
839
- };
840
- };
841
- };
1445
+ requestBody?: never;
842
1446
  responses: {
843
- /** @description Approval processed */
1447
+ /** @description User settings */
844
1448
  200: {
845
1449
  headers: {
846
1450
  [name: string]: unknown;
847
1451
  };
848
1452
  content: {
849
1453
  'application/json': {
850
- success: boolean;
851
- toolUseId: string;
852
- approved: boolean;
1454
+ projectId: string;
1455
+ userId: string;
1456
+ customInstructions: string | null;
1457
+ toolPermissions: {
1458
+ [key: string]: 'always_allow' | 'always_ask' | 'blocked';
1459
+ } | null;
1460
+ createdAt: string;
1461
+ updatedAt: string;
853
1462
  };
854
1463
  };
855
1464
  };
856
- /** @description Bad request */
857
- 400: {
1465
+ /** @description Unauthorized */
1466
+ 401: {
858
1467
  headers: {
859
1468
  [name: string]: unknown;
860
1469
  };
@@ -868,23 +1477,55 @@ type paths = {
868
1477
  };
869
1478
  };
870
1479
  };
871
- /** @description Unauthorized */
872
- 401: {
1480
+ };
1481
+ };
1482
+ put?: never;
1483
+ post?: never;
1484
+ delete?: never;
1485
+ options?: never;
1486
+ head?: never;
1487
+ /**
1488
+ * Update user settings
1489
+ * @description Update user-level custom instructions and/or tool permissions. Tool permissions are merged with existing values.
1490
+ */
1491
+ patch: {
1492
+ parameters: {
1493
+ query?: never;
1494
+ header?: never;
1495
+ path?: never;
1496
+ cookie?: never;
1497
+ };
1498
+ requestBody?: {
1499
+ content: {
1500
+ 'application/json': {
1501
+ customInstructions?: string | null;
1502
+ toolPermissions?: {
1503
+ [key: string]: 'always_allow' | 'always_ask' | 'blocked';
1504
+ } | null;
1505
+ };
1506
+ };
1507
+ };
1508
+ responses: {
1509
+ /** @description Updated user settings */
1510
+ 200: {
873
1511
  headers: {
874
1512
  [name: string]: unknown;
875
1513
  };
876
1514
  content: {
877
1515
  'application/json': {
878
- error: {
879
- type: string;
880
- surface: string;
881
- message: string;
882
- };
1516
+ projectId: string;
1517
+ userId: string;
1518
+ customInstructions: string | null;
1519
+ toolPermissions: {
1520
+ [key: string]: 'always_allow' | 'always_ask' | 'blocked';
1521
+ } | null;
1522
+ createdAt: string;
1523
+ updatedAt: string;
883
1524
  };
884
1525
  };
885
1526
  };
886
- /** @description Forbidden approval belongs to different chat */
887
- 403: {
1527
+ /** @description Bad request */
1528
+ 400: {
888
1529
  headers: {
889
1530
  [name: string]: unknown;
890
1531
  };
@@ -898,8 +1539,8 @@ type paths = {
898
1539
  };
899
1540
  };
900
1541
  };
901
- /** @description No pending approval found */
902
- 404: {
1542
+ /** @description Unauthorized */
1543
+ 401: {
903
1544
  headers: {
904
1545
  [name: string]: unknown;
905
1546
  };
@@ -915,13 +1556,9 @@ type paths = {
915
1556
  };
916
1557
  };
917
1558
  };
918
- delete?: never;
919
- options?: never;
920
- head?: never;
921
- patch?: never;
922
1559
  trace?: never;
923
1560
  };
924
- '/api/chat/{id}/ui-tool-result': {
1561
+ '/api/suggestions': {
925
1562
  parameters: {
926
1563
  query?: never;
927
1564
  header?: never;
@@ -931,37 +1568,159 @@ type paths = {
931
1568
  get?: never;
932
1569
  put?: never;
933
1570
  /**
934
- * Submit the result of a UI tool (e.g. SQL editor) invocation
935
- * @description The frontend executes ui_sql_editor_* tools in the browser and returns the result here. The backend writes the result into the sandbox so the sandbox MCP server unblocks and returns it to the agent.
1571
+ * Generate contextual suggestions
1572
+ * @description Generate AI-powered contextual suggestions for dashboard, job-detail, or configuration-detail contexts
936
1573
  */
937
1574
  post: {
938
1575
  parameters: {
939
1576
  query?: never;
940
1577
  header?: never;
941
- path: {
942
- id: string;
943
- };
1578
+ path?: never;
944
1579
  cookie?: never;
945
1580
  };
946
1581
  requestBody?: {
947
1582
  content: {
948
- 'application/json': {
949
- toolUseId: string;
950
- output?: string;
951
- errorText?: string;
952
- };
1583
+ 'application/json':
1584
+ | {
1585
+ /** @enum {string} */
1586
+ context: 'dashboard';
1587
+ data: {
1588
+ recentFailedJobs: {
1589
+ id: string;
1590
+ /** @enum {string} */
1591
+ status: 'error' | 'warning';
1592
+ component: string;
1593
+ configId: string;
1594
+ configName?: string;
1595
+ createdTime: string;
1596
+ durationSeconds?: number;
1597
+ errorMessage?: string;
1598
+ }[];
1599
+ deprecatedComponents: {
1600
+ id: string;
1601
+ name: string;
1602
+ type: string;
1603
+ expiredOn: string;
1604
+ configCount: number;
1605
+ }[];
1606
+ userRecentEdits: {
1607
+ component: string;
1608
+ configId: string;
1609
+ configName: string;
1610
+ lastEdited: string;
1611
+ }[];
1612
+ /** Format: email */
1613
+ currentUserEmail: string;
1614
+ };
1615
+ }
1616
+ | {
1617
+ /** @enum {string} */
1618
+ context: 'job-detail';
1619
+ data: {
1620
+ job: {
1621
+ id: string;
1622
+ /** @enum {string} */
1623
+ status:
1624
+ | 'created'
1625
+ | 'waiting'
1626
+ | 'processing'
1627
+ | 'success'
1628
+ | 'error'
1629
+ | 'terminating'
1630
+ | 'terminated'
1631
+ | 'cancelled'
1632
+ | 'warning';
1633
+ component: string;
1634
+ configId?: string;
1635
+ configName?: string;
1636
+ createdTime: string;
1637
+ startTime?: string;
1638
+ endTime?: string;
1639
+ durationSeconds?: number;
1640
+ errorMessage?: string;
1641
+ /** @enum {string} */
1642
+ errorType?: 'user' | 'application';
1643
+ backendSize?: string;
1644
+ };
1645
+ component?: {
1646
+ id: string;
1647
+ name: string;
1648
+ type: string;
1649
+ };
1650
+ runtimeHistory?: {
1651
+ averageDurationSeconds?: number;
1652
+ minDurationSeconds?: number;
1653
+ maxDurationSeconds?: number;
1654
+ recentJobsCount: number;
1655
+ isSlowerThanAverage?: boolean;
1656
+ isFasterThanAverage?: boolean;
1657
+ percentageDifference?: number;
1658
+ };
1659
+ /** Format: email */
1660
+ currentUserEmail: string;
1661
+ };
1662
+ }
1663
+ | {
1664
+ /** @enum {string} */
1665
+ context: 'configuration-detail';
1666
+ data: {
1667
+ configuration: {
1668
+ id: string;
1669
+ name: string;
1670
+ description?: string;
1671
+ component: string;
1672
+ hasRows: boolean;
1673
+ rowCount?: number;
1674
+ lastChangeDescription?: string;
1675
+ };
1676
+ component?: {
1677
+ id: string;
1678
+ name: string;
1679
+ type: string;
1680
+ };
1681
+ latestJobs?: {
1682
+ id: string;
1683
+ /** @enum {string} */
1684
+ status:
1685
+ | 'created'
1686
+ | 'waiting'
1687
+ | 'processing'
1688
+ | 'success'
1689
+ | 'error'
1690
+ | 'terminating'
1691
+ | 'terminated'
1692
+ | 'cancelled'
1693
+ | 'warning';
1694
+ durationSeconds?: number;
1695
+ errorMessage?: string;
1696
+ createdTime: string;
1697
+ }[];
1698
+ /** Format: email */
1699
+ currentUserEmail: string;
1700
+ };
1701
+ };
953
1702
  };
954
1703
  };
955
1704
  responses: {
956
- /** @description Result accepted */
1705
+ /** @description Suggestions generated successfully */
957
1706
  200: {
958
1707
  headers: {
959
1708
  [name: string]: unknown;
960
1709
  };
961
1710
  content: {
962
1711
  'application/json': {
963
- success: boolean;
964
- toolUseId: string;
1712
+ suggestions: {
1713
+ /** Format: uuid */
1714
+ id: string;
1715
+ label: string;
1716
+ prompt: string;
1717
+ priority: number;
1718
+ /** @enum {string} */
1719
+ category: 'error' | 'maintenance' | 'documentation';
1720
+ reasoning: string;
1721
+ }[];
1722
+ /** Format: uuid */
1723
+ suggestionSessionId: string;
965
1724
  };
966
1725
  };
967
1726
  };
@@ -995,36 +1754,6 @@ type paths = {
995
1754
  };
996
1755
  };
997
1756
  };
998
- /** @description Forbidden — request belongs to a different chat */
999
- 403: {
1000
- headers: {
1001
- [name: string]: unknown;
1002
- };
1003
- content: {
1004
- 'application/json': {
1005
- error: {
1006
- type: string;
1007
- surface: string;
1008
- message: string;
1009
- };
1010
- };
1011
- };
1012
- };
1013
- /** @description No pending UI tool request found */
1014
- 404: {
1015
- headers: {
1016
- [name: string]: unknown;
1017
- };
1018
- content: {
1019
- 'application/json': {
1020
- error: {
1021
- type: string;
1022
- surface: string;
1023
- message: string;
1024
- };
1025
- };
1026
- };
1027
- };
1028
1757
  };
1029
1758
  };
1030
1759
  delete?: never;
@@ -1033,7 +1762,7 @@ type paths = {
1033
1762
  patch?: never;
1034
1763
  trace?: never;
1035
1764
  };
1036
- '/api/usage': {
1765
+ '/api/settings/tools': {
1037
1766
  parameters: {
1038
1767
  query?: never;
1039
1768
  header?: never;
@@ -1041,8 +1770,8 @@ type paths = {
1041
1770
  cookie?: never;
1042
1771
  };
1043
1772
  /**
1044
- * Get rate limit usage information
1045
- * @description Returns the current rate limit usage for the authenticated user in the current project.
1773
+ * List available tools
1774
+ * @description List all available MCP tools with their metadata
1046
1775
  */
1047
1776
  get: {
1048
1777
  parameters: {
@@ -1053,17 +1782,18 @@ type paths = {
1053
1782
  };
1054
1783
  requestBody?: never;
1055
1784
  responses: {
1056
- /** @description Rate limit usage information */
1785
+ /** @description List of available tools */
1057
1786
  200: {
1058
1787
  headers: {
1059
1788
  [name: string]: unknown;
1060
1789
  };
1061
1790
  content: {
1062
1791
  'application/json': {
1063
- messagesUsed: number;
1064
- messagesLimit: number;
1065
- /** Format: date-time */
1066
- resetDate: string;
1792
+ tools: {
1793
+ name: string;
1794
+ description: string;
1795
+ readOnly: boolean;
1796
+ }[];
1067
1797
  };
1068
1798
  };
1069
1799
  };
@@ -1082,21 +1812,6 @@ type paths = {
1082
1812
  };
1083
1813
  };
1084
1814
  };
1085
- /** @description Internal server error */
1086
- 500: {
1087
- headers: {
1088
- [name: string]: unknown;
1089
- };
1090
- content: {
1091
- 'application/json': {
1092
- error: {
1093
- type: string;
1094
- surface: string;
1095
- message: string;
1096
- };
1097
- };
1098
- };
1099
- };
1100
1815
  };
1101
1816
  };
1102
1817
  put?: never;
@@ -1408,13 +2123,13 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
1408
2123
  id: string;
1409
2124
  createdAt: string;
1410
2125
  updatedAt: string;
1411
- status: string;
2126
+ status: "initializing" | "ready" | "loading" | "unloading" | "failed" | "deleted";
1412
2127
  userId: string;
1413
2128
  branchId: string;
1414
2129
  componentId: string;
1415
2130
  configurationId: string;
1416
2131
  workspaceSchema: string;
1417
- workspaceDatabase: string;
2132
+ workspaceDatabase?: string | null;
1418
2133
  workspaceId: string;
1419
2134
  workspaceCreateJobId: string | null;
1420
2135
  workspaceLoadJobs: {
@@ -1434,13 +2149,13 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
1434
2149
  id: string;
1435
2150
  createdAt: string;
1436
2151
  updatedAt: string;
1437
- status: string;
2152
+ status: "initializing" | "ready" | "loading" | "unloading" | "failed" | "deleted";
1438
2153
  userId: string;
1439
2154
  branchId: string;
1440
2155
  componentId: string;
1441
2156
  configurationId: string;
1442
2157
  workspaceSchema: string;
1443
- workspaceDatabase: string;
2158
+ workspaceDatabase?: string | null;
1444
2159
  workspaceId: string;
1445
2160
  workspaceCreateJobId: string | null;
1446
2161
  workspaceLoadJobs: {
@@ -1460,13 +2175,13 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
1460
2175
  id: string;
1461
2176
  createdAt: string;
1462
2177
  updatedAt: string;
1463
- status: string;
2178
+ status: "initializing" | "ready" | "loading" | "unloading" | "failed" | "deleted";
1464
2179
  userId: string;
1465
2180
  branchId: string;
1466
2181
  componentId: string;
1467
2182
  configurationId: string;
1468
2183
  workspaceSchema: string;
1469
- workspaceDatabase: string;
2184
+ workspaceDatabase?: string | null;
1470
2185
  workspaceId: string;
1471
2186
  workspaceCreateJobId: string | null;
1472
2187
  workspaceLoadJobs: {
@@ -1500,13 +2215,13 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
1500
2215
  id: string;
1501
2216
  createdAt: string;
1502
2217
  updatedAt: string;
1503
- status: string;
2218
+ status: "initializing" | "ready" | "loading" | "unloading" | "failed" | "deleted";
1504
2219
  userId: string;
1505
2220
  branchId: string;
1506
2221
  componentId: string;
1507
2222
  configurationId: string;
1508
2223
  workspaceSchema: string;
1509
- workspaceDatabase: string;
2224
+ workspaceDatabase?: string | null;
1510
2225
  workspaceId: string;
1511
2226
  workspaceCreateJobId: string | null;
1512
2227
  workspaceLoadJobs: {
@@ -1526,13 +2241,13 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
1526
2241
  id: string;
1527
2242
  createdAt: string;
1528
2243
  updatedAt: string;
1529
- status: string;
2244
+ status: "initializing" | "ready" | "loading" | "unloading" | "failed" | "deleted";
1530
2245
  userId: string;
1531
2246
  branchId: string;
1532
2247
  componentId: string;
1533
2248
  configurationId: string;
1534
2249
  workspaceSchema: string;
1535
- workspaceDatabase: string;
2250
+ workspaceDatabase?: string | null;
1536
2251
  workspaceId: string;
1537
2252
  workspaceCreateJobId: string | null;
1538
2253
  workspaceLoadJobs: {
@@ -1548,14 +2263,6 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
1548
2263
  workspaceLoginType?: "snowflake-person-sso" | "snowflake-legacy-service" | "snowflake-person-keypair" | "snowflake-service-keypair" | "default" | null;
1549
2264
  lastLoadedAt?: string | null;
1550
2265
  }>;
1551
- getWorkspacePassword: (id: string, signal?: AbortSignal) => Promise<{
1552
- username: string;
1553
- password: string;
1554
- host: string;
1555
- database: string;
1556
- schema: string;
1557
- warehouse: string;
1558
- }>;
1559
2266
  resetWorkspacePassword: (id: string) => Promise<{
1560
2267
  username: string;
1561
2268
  password: string;
@@ -1884,12 +2591,12 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
1884
2591
  kaiAgent: {
1885
2592
  getHistory: (params?: GetHistoryQuery) => Promise<{
1886
2593
  chats: {
1887
- id: string;
1888
- title: string;
1889
- userId: string;
1890
- createdAt: string;
1891
- lastMessageAt: string;
1892
- visibility: "public" | "private";
2594
+ id?: string;
2595
+ title?: string;
2596
+ userId?: string;
2597
+ createdAt?: string;
2598
+ lastMessageAt?: string;
2599
+ visibility?: "public" | "private";
1893
2600
  branchId?: number | null;
1894
2601
  }[];
1895
2602
  hasMore: boolean;
@@ -1919,17 +2626,24 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
1919
2626
  } | {
1920
2627
  type: string;
1921
2628
  toolCallId: string;
1922
- state: "output-available" | "input-available" | "input-streaming";
2629
+ state: "output-available" | "output-error" | "output-denied" | "input-available" | "input-streaming" | "approval-requested" | "approval-responded";
1923
2630
  input?: {
1924
2631
  [key: string]: unknown;
1925
2632
  };
1926
2633
  output?: unknown;
2634
+ errorText?: string;
2635
+ approval?: {
2636
+ id: string;
2637
+ approved: boolean;
2638
+ reason?: string;
2639
+ };
1927
2640
  })[];
1928
2641
  metadata?: {
1929
2642
  createdAt?: string;
1930
2643
  hidden?: boolean;
1931
2644
  requestContext?: {
1932
2645
  path?: string;
2646
+ sqlEditorActive?: boolean;
1933
2647
  };
1934
2648
  compactedTo?: string;
1935
2649
  compactedFrom?: string;
@@ -1938,12 +2652,11 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
1938
2652
  }[];
1939
2653
  }>;
1940
2654
  deleteChat: (chatId: string) => Promise<{
1941
- id: string;
1942
- title: string;
1943
- userId: string;
1944
- createdAt: string;
1945
- lastMessageAt: string;
1946
- visibility: "public" | "private";
2655
+ id?: string;
2656
+ title?: string;
2657
+ userId?: string;
2658
+ createdAt?: string;
2659
+ visibility?: "public" | "private";
1947
2660
  branchId?: number | null;
1948
2661
  }>;
1949
2662
  createChat: (request: ChatRequest) => Promise<Response>;
@@ -1960,6 +2673,9 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
1960
2673
  output?: string;
1961
2674
  errorText?: string;
1962
2675
  }) => Promise<void>;
2676
+ stopChat: (chatId: string) => Promise<{
2677
+ stopped: boolean;
2678
+ }>;
1963
2679
  getSuggestions: (request: SuggestionsRequestBody, signal?: AbortSignal) => Promise<SuggestionsApiResponse>;
1964
2680
  getAgentSettings: (signal?: AbortSignal) => Promise<{
1965
2681
  projectId: string;
@@ -2007,6 +2723,12 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2007
2723
  }>;
2008
2724
  chatStreamUrl: string;
2009
2725
  };
2726
+ oauth: {
2727
+ getCredentials: (query?: GetCredentialsQuery, signal?: AbortSignal) => Promise<Credential[]>;
2728
+ getCredential: (componentId: string, id: string, signal?: AbortSignal) => Promise<Credential>;
2729
+ createCredential: (componentId: string, body: CreateCredentialBody, signal?: AbortSignal) => Promise<Credential>;
2730
+ deleteCredential: (componentId: string, id: string, signal?: AbortSignal) => Promise<void>;
2731
+ };
2010
2732
  stack: {
2011
2733
  services: Service[];
2012
2734
  features: string[];
@@ -2353,6 +3075,7 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2353
3075
  id?: number;
2354
3076
  name?: string;
2355
3077
  email?: string;
3078
+ status?: "approved" | "rejected" | null;
2356
3079
  }[];
2357
3080
  }[]>;
2358
3081
  getMergeRequest: (id: number, signal?: AbortSignal) => Promise<MergeRequestDetail>;
@@ -2388,6 +3111,7 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2388
3111
  id?: number;
2389
3112
  name?: string;
2390
3113
  email?: string;
3114
+ status?: "approved" | "rejected" | null;
2391
3115
  }[];
2392
3116
  }>;
2393
3117
  updateMergeRequest: (id: number, params: UpdateMergeRequestParams) => Promise<{
@@ -2421,6 +3145,7 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2421
3145
  id?: number;
2422
3146
  name?: string;
2423
3147
  email?: string;
3148
+ status?: "approved" | "rejected" | null;
2424
3149
  }[];
2425
3150
  }>;
2426
3151
  requestReview: (id: number) => Promise<{
@@ -2454,6 +3179,7 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2454
3179
  id?: number;
2455
3180
  name?: string;
2456
3181
  email?: string;
3182
+ status?: "approved" | "rejected" | null;
2457
3183
  }[];
2458
3184
  } & {
2459
3185
  changeLog?: Record<string, never>;
@@ -2489,6 +3215,7 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2489
3215
  id?: number;
2490
3216
  name?: string;
2491
3217
  email?: string;
3218
+ status?: "approved" | "rejected" | null;
2492
3219
  }[];
2493
3220
  } & {
2494
3221
  changeLog?: Record<string, never>;
@@ -2524,10 +3251,19 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2524
3251
  id?: number;
2525
3252
  name?: string;
2526
3253
  email?: string;
3254
+ status?: "approved" | "rejected" | null;
2527
3255
  }[];
2528
3256
  } & {
2529
3257
  changeLog?: Record<string, never>;
2530
3258
  }>;
3259
+ getMergeRequestConflicts: (id: number, signal?: AbortSignal) => Promise<{
3260
+ message: string;
3261
+ componentId: string;
3262
+ configurationId: string;
3263
+ isDeleted: boolean;
3264
+ devBranchVersionIdentifier: string;
3265
+ defaultBranchVersionIdentifier: string;
3266
+ }[]>;
2531
3267
  };
2532
3268
  jobs: {
2533
3269
  getJob: <T extends JobOperation | string = string>(id: GetJobPath["id"], signal?: AbortSignal) => Promise<Job<T>>;
@@ -2706,7 +3442,23 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2706
3442
  getAllFeatures: (query: GetAllFeaturesQuery, signal?: AbortSignal) => Promise<Feature[]>;
2707
3443
  };
2708
3444
  maintainers: {
2709
- getMaintainers: (signal?: AbortSignal) => Promise<Record<string, never>[]>;
3445
+ getMaintainers: (signal?: AbortSignal) => Promise<{
3446
+ id: number;
3447
+ name: string;
3448
+ created: string;
3449
+ defaultConnectionMysqlId?: number | null;
3450
+ defaultConnectionSnowflakeId?: number | null;
3451
+ defaultConnectionSynapseId?: number | null;
3452
+ defaultConnectionExasolId?: number | null;
3453
+ defaultConnectionBigqueryId?: number | null;
3454
+ defaultConnectionTeradataId?: number | null;
3455
+ defaultFileStorageId?: number | null;
3456
+ zendeskUrl?: string | null;
3457
+ organizations: {
3458
+ id: number;
3459
+ name: string;
3460
+ }[];
3461
+ }[]>;
2710
3462
  getMaintainer: (maintainerId: number, signal?: AbortSignal) => Promise<{
2711
3463
  id: number;
2712
3464
  name: string;
@@ -2719,6 +3471,10 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2719
3471
  defaultConnectionTeradataId?: number | null;
2720
3472
  defaultFileStorageId?: number | null;
2721
3473
  zendeskUrl?: string | null;
3474
+ organizations: {
3475
+ id: number;
3476
+ name: string;
3477
+ }[];
2722
3478
  } & {
2723
3479
  organizations?: components$5["schemas"]["OrganizationResponse"][];
2724
3480
  }>;
@@ -2734,6 +3490,10 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2734
3490
  defaultConnectionTeradataId?: number | null;
2735
3491
  defaultFileStorageId?: number | null;
2736
3492
  zendeskUrl?: string | null;
3493
+ organizations: {
3494
+ id: number;
3495
+ name: string;
3496
+ }[];
2737
3497
  }>;
2738
3498
  updateMaintainer: ({ maintainerId, ...body }: {
2739
3499
  maintainerId: number;
@@ -2749,6 +3509,10 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2749
3509
  defaultConnectionTeradataId?: number | null;
2750
3510
  defaultFileStorageId?: number | null;
2751
3511
  zendeskUrl?: string | null;
3512
+ organizations: {
3513
+ id: number;
3514
+ name: string;
3515
+ }[];
2752
3516
  }>;
2753
3517
  deleteMaintainer: (maintainerId: number) => Promise<void>;
2754
3518
  getMaintainerUsers: (maintainerId: number, signal?: AbortSignal) => Promise<MaintainerUser[]>;
@@ -2805,15 +3569,6 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2805
3569
  maintainerId: number;
2806
3570
  invitationId: number;
2807
3571
  }) => Promise<void>;
2808
- getMaintainerOrganizations: (maintainerId: number, signal?: AbortSignal) => Promise<{
2809
- id: number;
2810
- name: string;
2811
- created: string;
2812
- allowAutoJoin: boolean;
2813
- crmId?: string | null;
2814
- activityCenterProjectId?: number | null;
2815
- mfaRequired: boolean;
2816
- }[]>;
2817
3572
  createMaintainerOrganization: ({ maintainerId, ...body }: {
2818
3573
  maintainerId: number;
2819
3574
  } & CreateMaintainerOrganizationBody) => Promise<{
@@ -2824,6 +3579,7 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2824
3579
  crmId?: string | null;
2825
3580
  activityCenterProjectId?: number | null;
2826
3581
  mfaRequired: boolean;
3582
+ projectsCount: number;
2827
3583
  }>;
2828
3584
  getMaintainerMetadata: (maintainerId: number, signal?: AbortSignal) => Promise<MetadataItem[]>;
2829
3585
  setMaintainerMetadata: ({ maintainerId, ...body }: {
@@ -2857,18 +3613,7 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2857
3613
  zendeskUrl?: string | null;
2858
3614
  };
2859
3615
  }[]>;
2860
- getOrganization: (organizationId: number, signal?: AbortSignal) => Promise<{
2861
- id: number;
2862
- name: string;
2863
- created: string;
2864
- allowAutoJoin: boolean;
2865
- crmId?: string | null;
2866
- activityCenterProjectId?: number | null;
2867
- mfaRequired: boolean;
2868
- } & {
2869
- projects?: Record<string, never>[];
2870
- maintainer?: Record<string, never>;
2871
- }>;
3616
+ getOrganization: (organizationId: number, signal?: AbortSignal) => Promise<OrganizationDetail>;
2872
3617
  updateOrganization: ({ organizationId, ...body }: {
2873
3618
  organizationId: number;
2874
3619
  } & UpdateOrganizationBody) => Promise<{
@@ -2879,6 +3624,7 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2879
3624
  crmId?: string | null;
2880
3625
  activityCenterProjectId?: number | null;
2881
3626
  mfaRequired: boolean;
3627
+ projectsCount: number;
2882
3628
  }>;
2883
3629
  deleteOrganization: (organizationId: number) => Promise<void>;
2884
3630
  forceMfa: (organizationId: number) => Promise<{
@@ -2889,6 +3635,7 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
2889
3635
  crmId?: string | null;
2890
3636
  activityCenterProjectId?: number | null;
2891
3637
  mfaRequired: boolean;
3638
+ projectsCount: number;
2892
3639
  }>;
2893
3640
  joinOrganization: (organizationId: number) => Promise<void>;
2894
3641
  getOrganizationUsers: (organizationId: number, signal?: AbortSignal) => Promise<{
@@ -3047,6 +3794,31 @@ declare const createClients: ({ baseUrl, token, callbacks, assetsBaseUrl, status
3047
3794
  addUserAdminFeature: ({ feature, userIdOrMail }: AddUserFeatureBody & AddUserFeaturePath, signal?: AbortSignal) => Promise<User>;
3048
3795
  removeUserAdminFeature: ({ userIdOrMail, feature }: RemoveUserFeaturePath, signal?: AbortSignal) => Promise<User>;
3049
3796
  };
3797
+ verifyToken: (signal?: AbortSignal) => Promise<{
3798
+ id: number;
3799
+ description: string;
3800
+ created: string;
3801
+ lastUsed?: string | null;
3802
+ expires?: string | null;
3803
+ isSessionToken: boolean;
3804
+ isExpired: boolean;
3805
+ isDisabled: boolean;
3806
+ scopes: string[];
3807
+ type: string;
3808
+ creator: {
3809
+ id?: number;
3810
+ name?: string;
3811
+ };
3812
+ user?: {
3813
+ id?: number;
3814
+ name?: string;
3815
+ email?: string;
3816
+ mfaEnabled?: boolean;
3817
+ features?: string[];
3818
+ canAccessLogs?: boolean;
3819
+ isSuperAdmin?: boolean;
3820
+ } | null;
3821
+ }>;
3050
3822
  };
3051
3823
  }>;
3052
3824
  type Clients = Awaited<ReturnType<typeof createClients>>;