@keboola/api-client 8.0.2 → 10.0.0

package/dist/verify/index.d.ts

@@ -1,5 +1,6 @@
-import { S as StorageToken } from '../types-bjHzGr0s.js';
+import { S as StorageToken } from '../types-GmAeMsok.js';
 import { ManagementToken } from './types.js';
+import '../backends-BgUzAQul.js';
 import '../types-jKnx7Tm_.js';
 
 declare const createVerifyClient: () => {

package/dist/verify/index.js

@@ -1,5 +1,4 @@
-export { createVerifyClient } from '../chunk-4HORTOGH.js';
-import '../chunk-D2SWTZFS.js';
-import '../chunk-SI5TFV5M.js';
+export { createVerifyClient } from '../chunk-LUHYZXJH.js';
+import '../chunk-FBGUBMJ7.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keboola/api-client",
-  "version": "8.0.2",
+  "version": "10.0.0",
   "description": "TypeScript SDK for Keboola APIs",
   "license": "MIT",
   "type": "module",
@@ -9,7 +9,9 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "API-SURFACE.md",
+    "surface"
   ],
   "typesVersions": {
     "*": {
@@ -720,7 +722,7 @@
     "vite": "^8.0.16",
     "vitest": "^4.1.8",
     "yaml": "^2.8.3",
-    "@keboola/oxlint-config": "^1.0.0",
+    "@keboola/oxlint-config": "^2.0.0",
     "@keboola/tsconfig": "^0.1.2"
   },
   "scripts": {
@@ -732,6 +734,8 @@
     "knip:fix": "pnpm --dir ../.. exec knip --workspace packages/api-client --fix-type types,exports,files",
     "lint:oxlint": "oxlint . --quiet",
     "lint:format": "oxfmt --check",
+    "surface": "node scripts/gen-surface.mjs",
+    "surface:check": "node scripts/gen-surface.mjs && git diff --exit-code -- API-SURFACE.md surface",
     "transit": "pnpm build",
     "build": "NODE_OPTIONS=--max-old-space-size=8192 tsup",
     "build:check": "attw --pack .",

package/surface/ai.md

@@ -0,0 +1,14 @@
+# `api.ai` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.ai.describeConfiguration(body: { branchId: string; componentId: string; configId: string; rowId?: string | undefined; }): Promise<{ description: string; correlationId: string; }>`
+- `api.ai.describeConfigurationMerge(body: { componentId: string; configId: string; baseBranchId: string; currentBranchId: string; }): Promise<{ description: string; correlationId: string; }>`
+- `api.ai.describeConfigurationVersion(body: { branchId: string; componentId: string; configId: string; currentVersionId: string; previousVersionId?: string | undefined; rowId?: string | undefined; }): Promise<{ description: string; correlationId: string; }>`
+- `api.ai.docsQuestion(body: { query: string; }): Promise<{ response: string; metadata: { sources: string[]; }; }>`
+- `api.ai.explainError(body: { error?: string | undefined; jobId: string; }): Promise<{ answer: string; correlationId: string; }>`
+- `api.ai.feedback(body: { value: "good" | "bad" | "cancel"; correlationId?: string | undefined; comment?: string | undefined; subject?: { type: "failed-job"; jobId: string; } | { type: "configuration"; branchId: string; componentId: string; configId: string; rowId?: string | undefined; } | { type: "conversation"; conversationId: string; } | { type: "component-suggestions"; searchTerm: string; } | undefined; }): Promise<never>`
+- `api.ai.getComponentDetail(componentId: string): Promise<{ componentId: string; componentType: string; componentName: string; componentCategories: string[]; description: string; longDescription: string; documentationUrl: string | null; documentation: string | null; configurationSchema: Record<string, never> | null; configurationRowSchema: Record<string, never> | null; configurationDescription: string | null; rootConfigurationExamples: Record<string, never>[] | null; rowConfigurationExamples: Record<string, never>[] | null; componentFlags: string[] | null; }>`
+- `api.ai.suggestComponent(body: { prompt: string; }): Promise<{ components: { componentId: string; score: number; }[]; correlationId: string; }>`

package/surface/assets.md

@@ -0,0 +1,7 @@
+# `api.assets` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.assets.getPublishedChangelogPosts(signal?: AbortSignal | undefined): Promise<Post[]>`

package/surface/chat.md

@@ -0,0 +1,19 @@
+# `api.chat` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.chat.createChat(request: { id: string; message: { id: string; role: "user" | "assistant"; parts: ({ type: "text"; text: string; state?: "done" | undefined; } | { type: "tool-result"; toolCallId: string; toolName: string; result: string; } | { type: "step-start"; } | { type: string; toolCallId: string; state: "output-available" | "output-error" | "output-denied" | "input-available" | "input-streaming" | "approval-requested" | "approval-responded"; input?: { [key: string]: unknown; } | undefined; output?: unknown; errorText?: string | undefined; approval?: { id?: string | undefined; approved?: boolean | undefined; reason?: string | undefined; } | undefined; })[]; metadata?: { createdAt?: string | undefined; hidden?: boolean | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; compactedTo?: string | undefined; compactedFrom?: string | undefined; } | undefined; status?: "failed" | "completed" | "pending" | "interrupted" | undefined; }; selectedChatModel: "chat-model" | "chat-model-reasoning"; selectedVisibilityType: "public" | "private"; branchId?: number | undefined; telemetryMetadata?: { [key: string]: string | number | boolean; } | undefined; }): Promise<Response>`
+- `api.chat.deleteChat(chatId: string): Promise<{ id: string; title: string; userId: string; createdAt: string; lastMessageAt: string; visibility: "public" | "private"; branchId?: number | null | undefined; }>`
+- `api.chat.getAgentSettings(signal?: AbortSignal | undefined): Promise<{ projectId: string; customInstructions: string | null; createdAt: string; updatedAt: string; }>`
+- `api.chat.getChat(chatId: string, signal?: AbortSignal | undefined): Promise<{ id: string; title: string; userId: string; createdAt: string; lastMessageAt: string; visibility: "public" | "private"; branchId?: number | null | undefined; messages: { id: string; role: "user" | "assistant"; parts: ({ type: "text"; text: string; state?: "done" | undefined; } | { type: "tool-result"; toolCallId: string; toolName: string; result: string; } | { type: "step-start"; } | { type: string; toolCallId: string; state: "output-available" | "output-error" | "output-denied" | "input-available" | "input-streaming" | "approval-requested" | "approval-responded"; input?: { [key: string]: unknown; } | undefined; output?: unknown; errorText?: string | undefined; approval?: { id?: string | undefined; approved?: boolean | undefined; reason?: string | undefined; } | undefined; })[]; metadata?: { createdAt?: string | undefined; hidden?: boolean | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; compactedTo?: string | undefined; compactedFrom?: string | undefined; } | undefined; status?: "failed" | "completed" | "pending" | "interrupted" | undefined; }[]; }>`
+- `api.chat.getHistory(params?: { limit?: number | undefined; starting_after?: string | undefined; ending_before?: string | undefined; } | undefined): Promise<{ chats: { id: string; title: string; userId: string; createdAt: string; lastMessageAt: string; visibility: "public" | "private"; branchId?: number | null | undefined; }[]; hasMore: boolean; }>`
+- `api.chat.getSuggestions(request: { context: "dashboard"; data: { recentFailedJobs: { id: string; status: "error" | "warning"; component: string; configId: string; createdTime: string; configName?: string | undefined; durationSeconds?: number | undefined; errorMessage?: string | undefined; }[]; deprecatedComponents: { id: string; name: string; type: string; expiredOn: string; configCount: number; }[]; userRecentEdits: { component: string; configId: string; configName: string; lastEdited: string; }[]; currentUserEmail: string; }; } | { context: "job-detail"; data: { job: { id: string; status: "error" | "warning" | "success" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; component: string; createdTime: string; configId?: string | undefined; configName?: string | undefined; startTime?: string | undefined; endTime?: string | undefined; durationSeconds?: number | undefined; errorMessage?: string | undefined; errorType?: "user" | "application" | undefined; backendSize?: string | undefined; }; currentUserEmail: string; component?: { id: string; name: string; type: string; } | undefined; runtimeHistory?: { recentJobsCount: number; averageDurationSeconds?: number | undefined; minDurationSeconds?: number | undefined; maxDurationSeconds?: number | undefined; isSlowerThanAverage?: boolean | undefined; isFasterThanAverage?: boolean | undefined; percentageDifference?: number | undefined; } | undefined; }; } | { context: "configuration-detail"; data: { configuration: { id: string; name: string; component: string; hasRows: boolean; description?: string | undefined; rowCount?: number | undefined; lastChangeDescription?: string | undefined; }; currentUserEmail: string; component?: { id: string; name: string; type: string; } | undefined; latestJobs?: { id: string; status: "error" | "warning" | "success" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; createdTime: string; durationSeconds?: number | undefined; errorMessage?: string | undefined; }[] | undefined; }; }, signal?: AbortSignal | undefined): Promise<{ suggestions: { label: string; prompt: string; priority: number; category: "documentation" | "error" | "maintenance"; reasoning: string; id: string; }[]; suggestionSessionId: string; }>`
+- `api.chat.getToolsList(signal?: AbortSignal | undefined): Promise<{ tools: { name: string; description: string; readOnly: boolean; }[]; }>`
+- `api.chat.getUsage(signal?: AbortSignal | undefined): Promise<{ messagesUsed: number; messagesLimit: number; resetDate: string; }>`
+- `api.chat.getUserAgentSettings(signal?: AbortSignal | undefined): Promise<{ projectId: string; userId: string; customInstructions: string | null; toolPermissions: { [key: string]: "always_allow" | "always_ask" | "blocked"; } | null; createdAt: string; updatedAt: string; }>`
+- `api.chat.getVotes(chatId: string): Promise<{ chatId: string; messageId: string; isUpvoted: boolean; }[]>`
+- `api.chat.submitVote(params: { chatId: string; messageId: string; type: "up" | "down"; }): Promise<void>`
+- `api.chat.updateAgentSettings(request: { customInstructions?: string | null | undefined; }, signal?: AbortSignal | undefined): Promise<{ projectId: string; customInstructions: string | null; createdAt: string; updatedAt: string; }>`
+- `api.chat.updateUserAgentSettings(request: { customInstructions?: string | null | undefined; toolPermissions?: { [key: string]: "always_allow" | "always_ask" | "blocked"; } | null | undefined; }, signal?: AbortSignal | undefined): Promise<{ projectId: string; userId: string; customInstructions: string | null; toolPermissions: { [key: string]: "always_allow" | "always_ask" | "blocked"; } | null; createdAt: string; updatedAt: string; }>`

package/surface/context.md

@@ -0,0 +1,40 @@
+# `api.context` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+
+### `api.context.defaultBranch`
+
+- `api.context.defaultBranch.getType(branchId?: string | number | undefined): BranchType`
+- `api.context.defaultBranch.isDefault(branchId?: string | number | undefined): boolean`
+- `api.context.defaultBranch.isDev(branchId?: string | number | undefined): boolean`
+
+### `api.context.project`
+
+- `api.context.project.hasAdminFeature(...feature: string[]): boolean`
+- `api.context.project.hasBackend(backend: Backend): boolean`
+- `api.context.project.hasFeature(...feature: string[]): boolean`
+
+### `api.context.st`
+
+- `api.context.st.createBucket(input: { stage: BucketStage; name: string; branchId?: string | null | undefined; }): StorageTableInstance`
+- `api.context.st.createDefaultBucket(input: { stage: BucketStage; name: string; }): StorageTableInstance`
+- `api.context.st.createDefaultConfigBucket(input: { stage: BucketStage; componentId: string; configId: string; }): StorageTableInstance`
+- `api.context.st.createDefaultConfigTable(input: { stage: BucketStage; componentId: string; configId: string; tableName: string; }): StorageTableInstance`
+- `api.context.st.createDefaultCsvImportTable(configId: string): StorageTableInstance`
+- `api.context.st.createTable(input: { stage: BucketStage; tableName: string; bucketName: string; branchId?: string | null | undefined; }): StorageTableInstance`
+- `api.context.st.parse(id: string): StorageTableInstance`
+- `api.context.st.parseBucket(id: string): StorageTableInstance`
+- `api.context.st.safeCreateDefaultBucket(input: { stage: BucketStage; name: string; }): StorageTableInstance | null`
+- `api.context.st.safeParse(id: string): StorageTableInstance | null`
+- `api.context.st.safeParseBucket(id: string): StorageTableInstance | null`
+
+### `api.context.stack`
+
+- `api.context.stack.getComponent(componentId: string): StackComponent | null`
+- `api.context.stack.getServiceUrl(serviceId: ServiceId): string | null`
+- `api.context.stack.hasComponent(...componentId: string[]): boolean`
+- `api.context.stack.hasFeature(...feature: string[]): boolean`
+- `api.context.stack.hasService(serviceId: ServiceId): boolean`

package/surface/dataScience.md

@@ -0,0 +1,19 @@
+# `api.dataScience` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.dataScience.createApp(body: { type: string; branchId: string | null; name: string; description?: string | null | undefined; config?: { [key: string]: unknown; } | null | undefined; useManagedGitRepo?: boolean | undefined; mode?: "dev" | "prod" | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; type?: string | null | undefined; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; state: "created" | "starting" | "running" | "restarting" | "stopping" | "stopped" | "deleting" | "deleted"; desiredState: "running" | "stopped" | "deleted"; mode: "dev" | "prod"; lastRequestTimestamp: string | null; lastStartTimestamp?: string | null | undefined; url?: string | null | undefined; autoSuspendAfterSeconds?: number | undefined; autoRestartEnabled?: boolean | undefined; size?: string | null | undefined; provisioningStrategy: "jobQueue" | "operator"; hasManagedGitRepo?: boolean | undefined; }>`
+- `api.dataScience.deleteApp(appId: string, signal?: AbortSignal | undefined): Promise<ApiResponse<never>>`
+- `api.dataScience.getApp(appId: string, signal?: AbortSignal | undefined): Promise<{ id: string; type?: string | null | undefined; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; state: "created" | "starting" | "running" | "restarting" | "stopping" | "stopped" | "deleting" | "deleted"; desiredState: "running" | "stopped" | "deleted"; mode: "dev" | "prod"; lastRequestTimestamp: string | null; lastStartTimestamp?: string | null | undefined; url?: string | null | undefined; autoSuspendAfterSeconds?: number | undefined; autoRestartEnabled?: boolean | undefined; size?: string | null | undefined; provisioningStrategy: "jobQueue" | "operator"; hasManagedGitRepo?: boolean | undefined; }>`
+- `api.dataScience.getAppLogsDownload(id: string, signal?: AbortSignal | undefined): Promise<{ logs: string; fileName: string; }>`
+- `api.dataScience.getAppLogsTail(id: string, { query, signal }?: { query?: { since?: string | undefined; lines?: number | undefined; } | undefined; signal?: AbortSignal | undefined; }): Promise<{ entries: LogEntry[]; nextLogTimestamp: string | null; }>`
+- `api.dataScience.getAppPassword(appId: string, signal?: AbortSignal | undefined): Promise<{ password?: string | undefined; }>`
+- `api.dataScience.getAppRun(appId: string, runId: string, signal?: AbortSignal | undefined): Promise<{ state: "starting" | "running" | "failed" | "finished"; id: string; appId: string; createdAt?: string | null | undefined; startedAt?: string | null | undefined; stoppedAt?: string | null | undefined; startupLogs?: string | null | undefined; runtimeSize?: string | null | undefined; configVersion?: string | null | undefined; failureReason?: { reason?: string | null | undefined; message?: string | null | undefined; } | null | undefined; mode: "dev" | "prod"; }>`
+- `api.dataScience.getAppRuns(appId: string, query?: { offset?: number | undefined; limit?: number | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ state: "starting" | "running" | "failed" | "finished"; id: string; appId: string; createdAt?: string | null | undefined; startedAt?: string | null | undefined; stoppedAt?: string | null | undefined; startupLogs?: string | null | undefined; runtimeSize?: string | null | undefined; configVersion?: string | null | undefined; failureReason?: { reason?: string | null | undefined; message?: string | null | undefined; } | null | undefined; mode: "dev" | "prod"; }[]>`
+- `api.dataScience.getApps(query: { offset?: number | undefined; limit?: number | undefined; componentId?: string | undefined; type?: ("bigquery" | "python" | "r" | "snowflake" | "streamlit" | "python-js")[] | undefined; branchId?: string | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; type?: string | null | undefined; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; state: "created" | "starting" | "running" | "restarting" | "stopping" | "stopped" | "deleting" | "deleted"; desiredState: "running" | "stopped" | "deleted"; mode: "dev" | "prod"; lastRequestTimestamp: string | null; lastStartTimestamp?: string | null | undefined; url?: string | null | undefined; autoSuspendAfterSeconds?: number | undefined; autoRestartEnabled?: boolean | undefined; size?: string | null | undefined; provisioningStrategy: "jobQueue" | "operator"; hasManagedGitRepo?: boolean | undefined; }[]>`
+- `api.dataScience.getRuntimes(signal?: AbortSignal | undefined): Promise<{ description: string; type: string; isTypeDefault: boolean; releaseDate: string; endOfLifeDate?: string | null | undefined; imageName?: string | null | undefined; imageTag?: string | null | undefined; transformationComponentId?: string | null | undefined; transformationComponentTag?: string | null | undefined; sandboxImageName?: string | null | undefined; sandboxImageTag?: string | null | undefined; }[]>`
+- `api.dataScience.getSandbox(appId: string, signal?: AbortSignal | undefined): Promise<{ id?: string | undefined; projectId?: string | undefined; tokenId?: string | undefined; branchId?: string | null | undefined; configurationId?: string | undefined; physicalId?: string | undefined; type?: string | undefined; active?: boolean | undefined; createdTimestamp?: string | undefined; startTimestamp?: string | undefined; updatedTimestamp?: string | undefined; persistentStorage?: { pvcName?: string | null | undefined; k8sManifest?: string | null | undefined; isEnabled?: boolean | undefined; ready?: boolean | null | undefined; k8sStorageClassName?: string | null | undefined; } | undefined; shared?: boolean | undefined; componentId?: string | undefined; configurationVersion?: string | undefined; size?: string | null | undefined; lastAutosaveTimestamp?: string | null | undefined; expirationTimestamp?: string | null | undefined; autoSuspendAfterSeconds?: number | undefined; expirationAfterHours?: number | undefined; user?: string | null | undefined; url?: string | null | undefined; password?: string | null | undefined; autosaveTokenId?: string | null | undefined; host?: string | null | undefined; imageVersion?: string | null | undefined; packages?: string[] | null | undefined; sizeParameters?: unknown; stagingWorkspaceId?: unknown; stagingWorkspaceType?: unknown; workspaceDetails?: unknown; databricks?: unknown; credentials?: unknown; }>`
+- `api.dataScience.patchApp(appId: string, body: PatchDataAppBody, signal?: AbortSignal | undefined): Promise<{ id: string; type?: string | null | undefined; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; state: "created" | "starting" | "running" | "restarting" | "stopping" | "stopped" | "deleting" | "deleted"; desiredState: "running" | "stopped" | "deleted"; mode: "dev" | "prod"; lastRequestTimestamp: string | null; lastStartTimestamp?: string | null | undefined; url?: string | null | undefined; autoSuspendAfterSeconds?: number | undefined; autoRestartEnabled?: boolean | undefined; size?: string | null | undefined; provisioningStrategy: "jobQueue" | "operator"; hasManagedGitRepo?: boolean | undefined; }>`
+- `api.dataScience.resetAppPassword(appId: string, signal?: AbortSignal | undefined): Promise<{ id: string; type?: string | null | undefined; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; state: "created" | "starting" | "running" | "restarting" | "stopping" | "stopped" | "deleting" | "deleted"; desiredState: "running" | "stopped" | "deleted"; mode: "dev" | "prod"; lastRequestTimestamp: string | null; lastStartTimestamp?: string | null | undefined; url?: string | null | undefined; autoSuspendAfterSeconds?: number | undefined; autoRestartEnabled?: boolean | undefined; size?: string | null | undefined; provisioningStrategy: "jobQueue" | "operator"; hasManagedGitRepo?: boolean | undefined; }>`

package/surface/editor.md

@@ -0,0 +1,17 @@
+# `api.editor` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.editor.createQueryJob({ id }: { id: string; }, body: { queries: string[]; }): Promise<{ queryJobId: string; url: string; }>`
+- `api.editor.createSession(body: { branchId: string; componentId: string | null; configurationId: string | null; }): Promise<{ id: string; createdAt: string; updatedAt: string; status: "failed" | "deleted" | "initializing" | "ready" | "loading" | "unloading"; userId: string; branchId: string; componentId: string; configurationId: string; workspaceSchema: string; workspaceDatabase?: string | null | undefined; workspaceId: string; workspaceCreateJobId: string | null; workspaceLoadJobs: { id: string; type: string; }[]; snowflakePrivateKey?: string | undefined; readOnlyStorageAccess?: boolean | undefined; backendType?: "bigquery" | "snowflake" | null | undefined; backendSize?: string | null | undefined; lastError?: string | null | undefined; shared: boolean; workspaceLoginType?: "default" | "snowflake-person-sso" | "snowflake-legacy-service" | "snowflake-person-keypair" | "snowflake-service-keypair" | null | undefined; lastLoadedAt?: string | null | undefined; }>`
+- `api.editor.getSession({ id }: { id: string; }, signal?: AbortSignal | undefined): Promise<{ id: string; createdAt: string; updatedAt: string; status: "failed" | "deleted" | "initializing" | "ready" | "loading" | "unloading"; userId: string; branchId: string; componentId: string; configurationId: string; workspaceSchema: string; workspaceDatabase?: string | null | undefined; workspaceId: string; workspaceCreateJobId: string | null; workspaceLoadJobs: { id: string; type: string; }[]; snowflakePrivateKey?: string | undefined; readOnlyStorageAccess?: boolean | undefined; backendType?: "bigquery" | "snowflake" | null | undefined; backendSize?: string | null | undefined; lastError?: string | null | undefined; shared: boolean; workspaceLoginType?: "default" | "snowflake-person-sso" | "snowflake-legacy-service" | "snowflake-person-keypair" | "snowflake-service-keypair" | null | undefined; lastLoadedAt?: string | null | undefined; }>`
+- `api.editor.getSessionCredentials(id: string, signal?: AbortSignal | undefined): Promise<{ [key: string]: unknown; }>`
+- `api.editor.getSessionSchema({ id, onlyWorkspaceSchema, loadTables, }: { id: string; } & { onlyWorkspaceSchema?: "0" | "1" | undefined; loadTables?: "0" | "1" | undefined; }, signal?: AbortSignal | undefined): Promise<{ databases: { name: string | null; displayName?: string | null | undefined; schemas: { name: string; isBranched: boolean; displayName?: string | null | undefined; tables: { name: string; type: "BASE TABLE" | "VIEW" | "ALIAS" | "LOCAL TEMPORARY"; displayName?: string | null | undefined; id?: string | null | undefined; columns: { name: string; type?: string | undefined; }[]; metrics?: { rowCount?: number | null | undefined; byteSize?: number | null | undefined; } | null | undefined; lifecycle?: { createdAt?: string | null | undefined; modifiedAt?: string | null | undefined; lastImportAt?: string | null | undefined; } | null | undefined; }[]; }[]; }[]; }>`
+- `api.editor.getSessions(query: { listAll?: "0" | "1" | undefined; branchId?: string | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; createdAt: string; updatedAt: string; status: "failed" | "deleted" | "initializing" | "ready" | "loading" | "unloading"; userId: string; branchId: string; componentId: string; configurationId: string; workspaceSchema: string; workspaceDatabase?: string | null | undefined; workspaceId: string; workspaceCreateJobId: string | null; workspaceLoadJobs: { id: string; type: string; }[]; snowflakePrivateKey?: string | undefined; readOnlyStorageAccess?: boolean | undefined; backendType?: "bigquery" | "snowflake" | null | undefined; backendSize?: string | null | undefined; lastError?: string | null | undefined; shared: boolean; workspaceLoginType?: "default" | "snowflake-person-sso" | "snowflake-legacy-service" | "snowflake-person-keypair" | "snowflake-service-keypair" | null | undefined; lastLoadedAt?: string | null | undefined; }[]>`
+- `api.editor.load({ id }: { id: string; }, body: { mode: "input" | "input-preserve" | "clean"; tableId?: string | null | undefined; }): Promise<{ id: string; createdAt: string; updatedAt: string; status: "failed" | "deleted" | "initializing" | "ready" | "loading" | "unloading"; userId: string; branchId: string; componentId: string; configurationId: string; workspaceSchema: string; workspaceDatabase?: string | null | undefined; workspaceId: string; workspaceCreateJobId: string | null; workspaceLoadJobs: { id: string; type: string; }[]; snowflakePrivateKey?: string | undefined; readOnlyStorageAccess?: boolean | undefined; backendType?: "bigquery" | "snowflake" | null | undefined; backendSize?: string | null | undefined; lastError?: string | null | undefined; shared: boolean; workspaceLoginType?: "default" | "snowflake-person-sso" | "snowflake-legacy-service" | "snowflake-person-keypair" | "snowflake-service-keypair" | null | undefined; lastLoadedAt?: string | null | undefined; }>`
+- `api.editor.resetWorkspacePassword(id: string): Promise<{ username: string; password: string; host: string; database: string; schema: string; warehouse: string; }>`
+- `api.editor.tableDefinition({ id, ...query }: { id: string; } & { tableName: string; schemaName: string; databaseName?: string | null | undefined; }, signal?: AbortSignal | undefined): Promise<{ ddl: string; }>`
+- `api.editor.tablePreview({ id }: { id: string; }, body: { tableName: string; databaseName?: string | null | undefined; schemaName?: string | null | undefined; }): Promise<{ queryJobId: string; url: string; }>`
+- `api.editor.unload({ id }: { id: string; }, body?: { tableId?: string | null | undefined; } | undefined): Promise<{ id: string; createdAt: string; updatedAt: string; status: "failed" | "deleted" | "initializing" | "ready" | "loading" | "unloading"; userId: string; branchId: string; componentId: string; configurationId: string; workspaceSchema: string; workspaceDatabase?: string | null | undefined; workspaceId: string; workspaceCreateJobId: string | null; workspaceLoadJobs: { id: string; type: string; }[]; snowflakePrivateKey?: string | undefined; readOnlyStorageAccess?: boolean | undefined; backendType?: "bigquery" | "snowflake" | null | undefined; backendSize?: string | null | undefined; lastError?: string | null | undefined; shared: boolean; workspaceLoginType?: "default" | "snowflake-person-sso" | "snowflake-legacy-service" | "snowflake-person-keypair" | "snowflake-service-keypair" | null | undefined; lastLoadedAt?: string | null | undefined; }>`

package/surface/encryption.md

@@ -0,0 +1,9 @@
+# `api.encryption` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.encryption.encrypt(data: EncryptQuery & { data: string; }, signal?: AbortSignal | undefined): Promise<string>`
+- `api.encryption.encryptScopedSecrets<T extends Record<string, unknown>>({ scope, ...params }: ScopedSecrets<T>, signal?: AbortSignal | undefined): Promise<T>`
+- `api.encryption.encryptSecrets<T extends Record<string, unknown>>(data: EncryptQuery & { data: T; }, signal?: AbortSignal | undefined): Promise<T>`

package/surface/import.md

@@ -0,0 +1,7 @@
+# `api.import` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.import.uploadFile(file: File, params?: UploadFileParams, signal?: AbortSignal | undefined): Promise<UploadedFile>`

package/surface/kaiAgent.md

@@ -0,0 +1,26 @@
+# `api.kaiAgent` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.kaiAgent.approveToolCall(chatId: string, body: { toolUseId: string; approved: boolean; reason?: string | undefined; updatedInput?: { [key: string]: unknown; } | undefined; answers?: { [key: string]: string; } | undefined; }): Promise<void>`
+- `api.kaiAgent.createChat(request: { id: string; message: { id: string; role: "user" | "assistant"; parts: { [key: string]: unknown; }[]; metadata?: { hidden?: boolean | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; } | undefined; }; selectedChatModel?: string | undefined; selectedVisibilityType?: "public" | "private" | undefined; branchId?: number | undefined; telemetryMetadata?: { [key: string]: string | number | boolean; } | undefined; }): Promise<Response>`
+- `api.kaiAgent.deleteChat(chatId: string): Promise<{ id?: string | undefined; title?: string | undefined; userId?: string | undefined; createdAt?: string | undefined; visibility?: "public" | "private" | undefined; branchId?: number | null | undefined; }>`
+- `api.kaiAgent.getAgentSettings(signal?: AbortSignal | undefined): Promise<{ projectId: string; customInstructions: string | null; createdAt: string; updatedAt: string; }>`
+- `api.kaiAgent.getChat(chatId: string, signal?: AbortSignal | undefined): Promise<{ id: string; title: string; userId: string; createdAt: string; lastMessageAt: string; visibility: "public" | "private"; branchId?: number | null | undefined; messages: { id: string; role: "user" | "assistant"; parts: ({ type: "text"; text: string; state?: "done" | undefined; } | { type: "tool-result"; toolCallId: string; toolName: string; result: string; } | { type: "step-start"; } | { type: "data-compact-boundary"; data: { trigger: "manual" | "auto"; preTokens: number; preservedSegment?: { headUuid: string; anchorUuid: string; tailUuid: string; } | undefined; summary: string; sdkSessionId: string; }; } | { type: string; toolCallId: string; state: "output-available" | "output-error" | "output-denied" | "input-available" | "input-streaming" | "approval-requested" | "approval-responded"; input?: { [key: string]: unknown; } | undefined; output?: unknown; errorText?: string | undefined; approval?: { id: string; approved: boolean; reason?: string | undefined; } | undefined; })[]; metadata?: { createdAt?: string | undefined; hidden?: boolean | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; } | undefined; status?: "failed" | "completed" | "pending" | "interrupted" | undefined; }[]; }>`
+- `api.kaiAgent.getHistory(params?: { limit?: number | undefined; starting_after?: string | undefined; ending_before?: string | undefined; } | undefined): Promise<{ chats: { id?: string | undefined; title?: string | undefined; userId?: string | undefined; createdAt?: string | undefined; lastMessageAt?: string | undefined; visibility?: "public" | "private" | undefined; branchId?: number | null | undefined; }[]; hasMore: boolean; }>`
+- `api.kaiAgent.getSandboxGitBranch(chatId: string, signal?: AbortSignal | undefined): Promise<{ branch: string | null; }>`
+- `api.kaiAgent.getSkillsList(signal?: AbortSignal | undefined): Promise<{ skills: { name: string; description: string | null; source: "first-party" | "vendored" | "project"; }[]; commands: { name: string; description: string; }[]; }>`
+- `api.kaiAgent.getSuggestions(request: { context: "dashboard"; data: { recentFailedJobs: { id: string; status: "error" | "warning"; component: string; configId: string; createdTime: string; configName?: string | undefined; durationSeconds?: number | undefined; errorMessage?: string | undefined; }[]; deprecatedComponents: { id: string; name: string; type: string; expiredOn: string; configCount: number; }[]; userRecentEdits: { component: string; configId: string; configName: string; lastEdited: string; }[]; currentUserEmail: string; }; } | { context: "job-detail"; data: { job: { id: string; status: "error" | "warning" | "success" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; component: string; createdTime: string; configId?: string | undefined; configName?: string | undefined; startTime?: string | undefined; endTime?: string | undefined; durationSeconds?: number | undefined; errorMessage?: string | undefined; errorType?: "user" | "application" | undefined; backendSize?: string | undefined; }; currentUserEmail: string; component?: { id: string; name: string; type: string; } | undefined; runtimeHistory?: { recentJobsCount: number; averageDurationSeconds?: number | undefined; minDurationSeconds?: number | undefined; maxDurationSeconds?: number | undefined; isSlowerThanAverage?: boolean | undefined; isFasterThanAverage?: boolean | undefined; percentageDifference?: number | undefined; } | undefined; }; } | { context: "configuration-detail"; data: { configuration: { id: string; name: string; component: string; hasRows: boolean; description?: string | undefined; rowCount?: number | undefined; lastChangeDescription?: string | undefined; }; currentUserEmail: string; component?: { id: string; name: string; type: string; } | undefined; latestJobs?: { id: string; status: "error" | "warning" | "success" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; createdTime: string; durationSeconds?: number | undefined; errorMessage?: string | undefined; }[] | undefined; }; }, signal?: AbortSignal | undefined): Promise<{ suggestions: { label: string; prompt: string; priority: number; category: "documentation" | "error" | "maintenance"; reasoning: string; id: string; }[]; suggestionSessionId: string; }>`
+- `api.kaiAgent.getToolsList(signal?: AbortSignal | undefined): Promise<{ tools: { name: string; description: string; readOnly: boolean; }[]; }>`
+- `api.kaiAgent.getUsage(signal?: AbortSignal | undefined): Promise<{ messagesUsed: number; messagesLimit: number; resetDate: string; }>`
+- `api.kaiAgent.getUserAgentSettings(signal?: AbortSignal | undefined): Promise<{ projectId: string; userId: string; customInstructions: string | null; toolPermissions: Record<string, "always_allow" | "always_ask" | "blocked"> | null; createdAt: string; updatedAt: string; }>`
+- `api.kaiAgent.getVotes(chatId: string): Promise<{ chatId: string; messageId: string; isUpvoted: boolean; }[]>`
+- `api.kaiAgent.listSandboxFiles(chatId: string, path?: string | undefined, signal?: AbortSignal | undefined): Promise<{ entries: { name: string; path: string; type: "file" | "dir"; size?: number | undefined; }[]; }>`
+- `api.kaiAgent.readSandboxFile(chatId: string, path: string, signal?: AbortSignal | undefined): Promise<{ content: string; encoding: "utf-8" | "binary"; truncated: boolean; size: number; }>`
+- `api.kaiAgent.stopChat(chatId: string): Promise<{ stopped: boolean; }>`
+- `api.kaiAgent.submitToolOutput(chatId: string, body: { toolUseId: string; output?: string | undefined; errorText?: string | undefined; }): Promise<void>`
+- `api.kaiAgent.submitVote(params: { chatId: string; messageId: string; type: "up" | "down"; }): Promise<void>`
+- `api.kaiAgent.updateAgentSettings(request: UpdateAgentSettingsRequest, signal?: AbortSignal | undefined): Promise<{ projectId: string; customInstructions: string | null; createdAt: string; updatedAt: string; }>`
+- `api.kaiAgent.updateUserAgentSettings(request: UpdateUserAgentSettingsRequest, signal?: AbortSignal | undefined): Promise<{ projectId: string; userId: string; customInstructions: string | null; toolPermissions: Record<string, "always_allow" | "always_ask" | "blocked"> | null; createdAt: string; updatedAt: string; }>`

package/surface/management.md

@@ -0,0 +1,109 @@
+# `api.management` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.management.verifyToken(signal?: AbortSignal | undefined): Promise<{ id: number; description: string; created: string; lastUsed: string | null; expires: string | null; isSessionToken: boolean; isExpired: boolean; isDisabled: boolean; scopes: string[]; type: string; creator: { id: number; name: string; }; user?: { id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; } | null | undefined; }>`
+
+### `api.management.currentUser`
+
+- `api.management.currentUser.acceptMaintainerInvitation(id: number): Promise<void>`
+- `api.management.currentUser.acceptOrganizationInvitation(id: number): Promise<void>`
+- `api.management.currentUser.acceptProjectInvitation(id: number): Promise<void>`
+- `api.management.currentUser.deleteProjectJoinRequest(id: number): Promise<void>`
+- `api.management.currentUser.getMaintainerInvitation(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; maintainer: { id?: number | undefined; name?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
+- `api.management.currentUser.getMaintainerInvitations(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; maintainer: { id?: number | undefined; name?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }[]>`
+- `api.management.currentUser.getOrganizationInvitation(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; organization: { id?: number | undefined; name?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
+- `api.management.currentUser.getOrganizationInvitations(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; organization: { id?: number | undefined; name?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }[]>`
+- `api.management.currentUser.getProjectInvitation(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires?: string | null | undefined; reason?: string | null | undefined; role?: string | null | undefined; project: { id?: number | undefined; name?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
+- `api.management.currentUser.getProjectInvitations(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires?: string | null | undefined; reason?: string | null | undefined; role?: string | null | undefined; project: { id?: number | undefined; name?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }[]>`
+- `api.management.currentUser.getProjectJoinRequests(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires?: string | null | undefined; reason?: string | null | undefined; project: { id?: number | undefined; name?: string | undefined; }; }[]>`
+- `api.management.currentUser.rejectMaintainerInvitation(id: number): Promise<void>`
+- `api.management.currentUser.rejectOrganizationInvitation(id: number): Promise<void>`
+- `api.management.currentUser.rejectProjectInvitation(id: number): Promise<void>`
+
+### `api.management.deletedProjects`
+
+- `api.management.deletedProjects.getDeletedProject(projectId: number, signal?: AbortSignal | undefined): Promise<DeletedProject>`
+- `api.management.deletedProjects.getDeletedProjects(query?: { limit?: number | null | undefined; offset?: number | null | undefined; organizationId?: number | null | undefined; name?: string | null | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<DeletedProject[]>`
+- `api.management.deletedProjects.purgeDeletedProject(projectId: number, ignoreBackendErrors?: boolean): Promise<{ commandExecutionId: string; }>`
+- `api.management.deletedProjects.restoreDeletedProject(projectId: number): Promise<void>`
+
+### `api.management.features`
+
+- `api.management.features.getAllFeatures(query: GetAllFeaturesQuery, signal?: AbortSignal | undefined): Promise<Feature[]>`
+- `api.management.features.getFeature(featureId: number, signal?: AbortSignal | undefined): Promise<Feature>`
+- `api.management.features.getFeatureAdmins(featureId: number, signal?: AbortSignal | undefined): Promise<FeatureAdmin[]>`
+- `api.management.features.getFeatureProjects(featureId: number, signal?: AbortSignal | undefined): Promise<FeatureProject[]>`
+
+### `api.management.maintainers`
+
+- `api.management.maintainers.addMaintainerUser({ maintainerId, ...body }: { maintainerId: number; } & { id?: number | null | undefined; email?: string | null | undefined; }): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }>`
+- `api.management.maintainers.createMaintainer(body: { name: string; defaultConnectionMysqlId?: number | null | undefined; defaultConnectionSnowflakeId?: number | null | undefined; defaultConnectionSynapseId?: number | null | undefined; defaultConnectionExasolId?: number | null | undefined; defaultConnectionBigqueryId?: number | null | undefined; defaultConnectionTeradataId?: number | null | undefined; zendeskUrl?: string | null | undefined; defaultFileStorageId?: number | null | undefined; }): Promise<{ id: number; name: string; created: string; defaultConnectionMysqlId?: number | null | undefined; defaultConnectionSnowflakeId?: number | null | undefined; defaultConnectionSynapseId?: number | null | undefined; defaultConnectionExasolId?: number | null | undefined; defaultConnectionBigqueryId?: number | null | undefined; defaultConnectionTeradataId?: number | null | undefined; defaultFileStorageId?: number | null | undefined; zendeskUrl?: string | null | undefined; organizations: { id?: number | undefined; name?: string | undefined; }[]; }>`
+- `api.management.maintainers.createMaintainerInvitation({ maintainerId, ...body }: { maintainerId: number; } & { email: string; }): Promise<{ id: number; created?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
+- `api.management.maintainers.createMaintainerOrganization({ maintainerId, ...body }: { maintainerId: number; } & { name: string; crmId?: string | null | undefined; }): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId?: string | null | undefined; activityCenterProjectId?: number | null | undefined; mfaRequired: boolean; }>`
+- `api.management.maintainers.deleteMaintainer(maintainerId: number): Promise<void>`
+- `api.management.maintainers.deleteMaintainerInvitation({ maintainerId, invitationId, }: { maintainerId: number; invitationId: number; }): Promise<void>`
+- `api.management.maintainers.deleteMaintainerMetadata({ maintainerId, metadataId, }: { maintainerId: number; metadataId: number; }): Promise<void>`
+- `api.management.maintainers.getMaintainer(maintainerId: number, signal?: AbortSignal | undefined): Promise<MaintainerDetail>`
+- `api.management.maintainers.getMaintainerInvitation({ maintainerId, invitationId }: { maintainerId: number; invitationId: number; }, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
+- `api.management.maintainers.getMaintainerInvitations(maintainerId: number, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }[]>`
+- `api.management.maintainers.getMaintainerMetadata(maintainerId: number, signal?: AbortSignal | undefined): Promise<MetadataItem[]>`
+- `api.management.maintainers.getMaintainerUsers(maintainerId: number, signal?: AbortSignal | undefined): Promise<MaintainerUser[]>`
+- `api.management.maintainers.getMaintainers(signal?: AbortSignal | undefined): Promise<Maintainer[]>`
+- `api.management.maintainers.removeMaintainerUser({ maintainerId, adminId, }: { maintainerId: number; adminId: number; }): Promise<void>`
+- `api.management.maintainers.setMaintainerMetadata({ maintainerId, ...body }: { maintainerId: number; } & { provider: "user" | "system"; metadata: { key: string; value: string; }[]; }): Promise<MetadataItem[]>`
+- `api.management.maintainers.updateMaintainer({ maintainerId, ...body }: { maintainerId: number; } & { name?: string | null | undefined; defaultConnectionMysqlId?: number | null | undefined; defaultConnectionSnowflakeId?: number | null | undefined; defaultConnectionSynapseId?: number | null | undefined; defaultConnectionExasolId?: number | null | undefined; defaultConnectionBigqueryId?: number | null | undefined; defaultConnectionTeradataId?: number | null | undefined; zendeskUrl?: string | null | undefined; defaultFileStorageId?: number | null | undefined; }): Promise<{ id: number; name: string; created: string; defaultConnectionMysqlId?: number | null | undefined; defaultConnectionSnowflakeId?: number | null | undefined; defaultConnectionSynapseId?: number | null | undefined; defaultConnectionExasolId?: number | null | undefined; defaultConnectionBigqueryId?: number | null | undefined; defaultConnectionTeradataId?: number | null | undefined; defaultFileStorageId?: number | null | undefined; zendeskUrl?: string | null | undefined; organizations: { id?: number | undefined; name?: string | undefined; }[]; }>`
+
+### `api.management.organizations`
+
+- `api.management.organizations.addOrganizationUser({ organizationId, ...body }: { organizationId: number; } & { id?: number | null | undefined; email?: string | null | undefined; }): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }>`
+- `api.management.organizations.createOrganizationInvitation({ organizationId, ...body }: { organizationId: number; } & { email: string; }): Promise<{ id: number; created?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
+- `api.management.organizations.createOrganizationProject({ organizationId, ...body }: { organizationId: number; } & { name: string; type?: "production" | "poc" | "demo" | undefined; defaultBackend?: string | undefined; dataRetentionTimeInDays?: number | undefined; }): Promise<{ id: number; name: string; type: string; region: string; created?: string | null | undefined; expires?: string | null | undefined; features: string[]; dataSizeBytes: number; rowsCount: number; hasMysql: boolean; hasSynapse: boolean; hasSnowflake: boolean; hasExasol: boolean; hasTeradata: boolean; hasBigquery: boolean; defaultBackend: string; hasTryModeOn: string; limits: { [key: string]: { name?: string | undefined; value?: number | undefined; }; }; metrics: { [key: string]: { name?: string | undefined; value?: number | undefined; }; }; isDisabled: boolean; billedMonthlyPrice?: number | null | undefined; dataRetentionTimeInDays: number; isBYODB: boolean; assignedBackends: string[]; fileStorageProvider?: string | null | undefined; payAsYouGo?: { purchasedCredits?: number | undefined; } | null | undefined; disabled?: { reason?: string | undefined; estimatedEndTime?: string | null | undefined; } | null | undefined; } & { fileStorage?: Record<string, never> | undefined; backends?: Record<string, never> | undefined; }>`
+- `api.management.organizations.deleteOrganization(organizationId: number): Promise<void>`
+- `api.management.organizations.deleteOrganizationInvitation({ organizationId, invitationId, }: { organizationId: number; invitationId: number; }): Promise<void>`
+- `api.management.organizations.deleteOrganizationMetadata({ organizationId, metadataId, }: { organizationId: number; metadataId: number; }): Promise<void>`
+- `api.management.organizations.forceMfa(organizationId: number): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId?: string | null | undefined; activityCenterProjectId?: number | null | undefined; mfaRequired: boolean; } & { projects: { id: number; name: string; created: string; }[]; }>`
+- `api.management.organizations.getOrganization(organizationId: number, signal?: AbortSignal | undefined): Promise<OrganizationDetail>`
+- `api.management.organizations.getOrganizationInvitation({ organizationId, invitationId }: { organizationId: number; invitationId: number; }, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
+- `api.management.organizations.getOrganizationInvitations(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }[]>`
+- `api.management.organizations.getOrganizationMetadata(organizationId: number, signal?: AbortSignal | undefined): Promise<MetadataItem[]>`
+- `api.management.organizations.getOrganizationProjects(organizationId: number, signal?: AbortSignal | undefined): Promise<Project[]>`
+- `api.management.organizations.getOrganizationProjectsUsers(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }[]>`
+- `api.management.organizations.getOrganizationUsers(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }[]>`
+- `api.management.organizations.getOrganizations(signal?: AbortSignal | undefined): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string; activityCenterProjectId?: number | null | undefined; mfaRequired: boolean; maintainer: { id?: number | undefined; name?: string | undefined; created?: string | undefined; defaultConnectionMysqlId?: number | null | undefined; defaultConnectionSnowflakeId?: number | null | undefined; defaultConnectionSynapseId?: number | null | undefined; defaultConnectionExasolId?: number | null | undefined; defaultConnectionBigqueryId?: number | null | undefined; defaultConnectionTeradataId?: number | null | undefined; defaultFileStorageId?: number | null | undefined; zendeskUrl?: string | null | undefined; }; }[]>`
+- `api.management.organizations.joinOrganization(organizationId: number): Promise<void>`
+- `api.management.organizations.removeOrganizationUser({ organizationId, userId, }: { organizationId: number; userId: number; }): Promise<void>`
+- `api.management.organizations.setOrganizationMetadata({ organizationId, ...body }: { organizationId: number; } & { provider: "user" | "system" | "maintainer"; metadata: { key: string; value: string; }[]; }): Promise<MetadataItem[]>`
+- `api.management.organizations.updateOrganization({ organizationId, ...body }: { organizationId: number; } & { name?: string | undefined; maintainerId?: number | undefined; allowAutoJoin?: boolean | undefined; crmId?: string | null | undefined; activityCenterProjectId?: number | null | undefined; mfaRequired?: boolean | undefined; } & { mfaRequired?: boolean | undefined; crmId?: string | null | undefined; activityCenterProjectId?: number | null | undefined; maintainerId?: number | undefined; }): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId?: string | null | undefined; activityCenterProjectId?: number | null | undefined; mfaRequired: boolean; } & { projects: { id: number; name: string; created: string; }[]; }>`
+
+### `api.management.projects`
+
+- `api.management.projects.addProjectFeature({ projectId, feature, }: CreateProjectFeaturePath & CreateProjectFeatureBody): Promise<Project>`
+- `api.management.projects.addProjectUser({ projectId, ...body }: AddProjectUserPath & AddProjectUserBody): Promise<User>`
+- `api.management.projects.changeProjectUserRole({ projectId, userId, role, }: { projectId: number; userId: number; role: "readOnly" | "guest" | "admin" | "share" | "productionManager" | "developer" | "reviewer"; }): Promise<User>`
+- `api.management.projects.createProjectInvitation({ projectId, ...body }: CreateProjectInvitationPath & CreateProjectInvitationBody): Promise<{ id: number; created?: string | null | undefined; expires?: string | null | undefined; reason?: string | null | undefined; role?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
+- `api.management.projects.deleteProject(projectId: number): Promise<null>`
+- `api.management.projects.deleteProjectInvitation({ projectId, invitationId, }: DeleteProjectInvitationPath): Promise<null>`
+- `api.management.projects.getProject(projectId: string | number, signal?: AbortSignal | undefined): Promise<Project>`
+- `api.management.projects.getProjectInvitations(projectId: string | number, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; expires?: string | null | undefined; reason?: string | null | undefined; role?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }[]>`
+- `api.management.projects.getProjectMetadata(projectId: number, signal?: AbortSignal | undefined): Promise<ProjectMetadataItem[]>`
+- `api.management.projects.getProjectReviewers(projectId: number, signal?: AbortSignal | undefined): Promise<Reviewer[]>`
+- `api.management.projects.getProjectUsers(projectId: string | number, signal?: AbortSignal | undefined): Promise<User[]>`
+- `api.management.projects.moveProject({ projectId, organizationId, }: { projectId: number; } & { organizationId: number; }): Promise<Project>`
+- `api.management.projects.removeProjectFeature(path: RemoveProjectFeaturePath): Promise<null>`
+- `api.management.projects.removeProjectUser({ projectId, idOrEmail }: RemoveProjectUserPath): Promise<null>`
+- `api.management.projects.setProjectDisabled({ projectId, ...body }: { projectId: number; } & SetProjectDisabledBody): Promise<Project>`
+- `api.management.projects.setProjectMetadata({ projectId, provider, metadata, }: SetProjectMetadataPath & SetProjectMetadataBody): Promise<ProjectMetadataItem[]>`
+- `api.management.projects.setProjectReviewers({ projectId, adminIds, }: SetProjectReviewersPath & SetProjectReviewersBody): Promise<void>`
+- `api.management.projects.updateProject({ projectId, ...body }: { projectId: number; } & { name?: string | null | undefined; defaultBackend?: string | null | undefined; hasTryModeOn?: boolean | null | undefined; type?: string | null | undefined; expirationDays?: number | null | undefined; billedMonthlyPrice?: number | null | undefined; dataRetentionTimeInDays?: number | null | undefined; timezone?: string | null | undefined; }): Promise<Project>`
+
+### `api.management.storageBackends`
+
+- `api.management.storageBackends.getStorageBackend(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; host?: string | null | undefined; backend: string; region: string; owner: string; technicalOwner: string; username?: string | null | undefined; stats: { projectsCount?: number | undefined; bucketsCount?: number | undefined; dataSizeGB?: number | undefined; rowsCount?: number | undefined; }; created: string; creator: { id?: number | null | undefined; name?: string | null | undefined; }; warehouse?: string | null | undefined; database?: string | null | undefined; useSynapseManagedIdentity?: boolean | null | undefined; saml2Configuration?: { idpEntityId?: string | undefined; spEntityId?: string | undefined; spAcsUrl?: string | undefined; publicKey?: string | undefined; } | null | undefined; useDynamicBackends: boolean; useSso?: boolean | null | undefined; isSsoEnabled?: boolean | null | undefined; isSsoConfigured?: boolean | null | undefined; technicalOwnerContactEmails: string[]; }>`
+
+### `api.management.users`
+
+- `api.management.users.addUserAdminFeature({ feature, userIdOrMail }: AddUserFeatureBody & AddUserFeaturePath, signal?: AbortSignal | undefined): Promise<User>`
+- `api.management.users.removeUserAdminFeature({ userIdOrMail, feature }: RemoveUserFeaturePath, signal?: AbortSignal | undefined): Promise<User>`

package/surface/notifications.md

@@ -0,0 +1,10 @@
+# `api.notifications` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.notifications.createSubscription(body: { event: string; expiresAt?: string | undefined; projectId: string; filters?: { field?: string | undefined; value?: string | number | boolean | undefined; }[] | undefined; recipient: { channel: "RecipientChannel_Email"; address: string; } | { channel: "RecipientChannel_Webhook"; url: string; }; }, signal?: AbortSignal | undefined): Promise<{ id?: string | undefined; } & { event: string; expiresAt?: string | undefined; projectId: string; filters?: { field?: string | undefined; value?: string | number | boolean | undefined; }[] | undefined; recipient: { channel: "RecipientChannel_Email"; address: string; } | { channel: "RecipientChannel_Webhook"; url: string; }; }>`
+- `api.notifications.deleteSubscription(subscriptionId: number, signal?: AbortSignal | undefined): Promise<void>`
+- `api.notifications.getSubscription(subscriptionId: number, signal?: AbortSignal | undefined): Promise<{ id?: string | undefined; } & { event: string; expiresAt?: string | undefined; projectId: string; filters?: { field?: string | undefined; value?: string | number | boolean | undefined; }[] | undefined; recipient: { channel: "RecipientChannel_Email"; address: string; } | { channel: "RecipientChannel_Webhook"; url: string; }; }>`
+- `api.notifications.getSubscriptions(query?: { event?: string | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<({ id?: string | undefined; } & { event: string; expiresAt?: string | undefined; projectId: string; filters?: { field?: string | undefined; value?: string | number | boolean | undefined; }[] | undefined; recipient: { channel: "RecipientChannel_Email"; address: string; } | { channel: "RecipientChannel_Webhook"; url: string; }; })[]>`

package/surface/oauth.md

@@ -0,0 +1,10 @@
+# `api.oauth` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.oauth.createCredential(componentId: string, body: CreateCredentialBody, signal?: AbortSignal | undefined): Promise<Credential>`
+- `api.oauth.deleteCredential(componentId: string, id: string, signal?: AbortSignal | undefined): Promise<void>`
+- `api.oauth.getCredential(componentId: string, id: string, signal?: AbortSignal | undefined): Promise<Credential>`
+- `api.oauth.getCredentials(query?: GetCredentialsQuery | undefined, signal?: AbortSignal | undefined): Promise<Credential[]>`

package/surface/queryService.md

@@ -0,0 +1,12 @@
+# `api.queryService` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.queryService.cancelQueryJob(queryJobId: string): Promise<{ queryJobId: string; }>`
+- `api.queryService.createQueryJob(branchId: string, workspaceId: string, body: { actorType?: "user" | "system" | undefined; refreshMetadataOnSuccess?: boolean | undefined; sessionId?: string | undefined; statements: string[]; timeout?: string | undefined; transactional: boolean; }): Promise<{ queryJobId: string; sessionId?: string | undefined; }>`
+- `api.queryService.exportResults(queryJobId: string, statementId: string, query: { fileType: "csv" | "parquet"; gzip?: boolean | undefined; }, signal?: AbortSignal | undefined): Promise<ExportResultsResponse>`
+- `api.queryService.getQueryHistory(branchId: string, workspaceId: string, query?: { afterId?: string | undefined; pageSize?: number | undefined; } | undefined): Promise<{ statements: { backendSize?: string | undefined; completedAt?: string | undefined; createdAt?: string | undefined; error?: string | undefined; executedAt?: string | undefined; id: string; numberOfRows?: number | undefined; query: string; queryId?: string | undefined; queryJobId: string; rowsAffected?: number | undefined; status: "waiting" | "processing" | "failed" | "canceled" | "completed" | "notExecuted"; warehouse?: string | undefined; }[]; }>`
+- `api.queryService.getQueryJob(queryJobId: string): Promise<{ actorType: "user" | "system"; canceledAt?: string | undefined; cancellationReason?: string | undefined; changedAt: string; createdAt: string; expiration?: string | undefined; queryJobId: string; statements: { completedAt?: string | undefined; createdAt?: string | undefined; error?: string | undefined; executedAt?: string | undefined; id: string; numberOfRows?: number | undefined; query: string; queryId?: string | undefined; rowsAffected?: number | undefined; status: "waiting" | "processing" | "failed" | "canceled" | "completed" | "notExecuted"; }[]; status: "created" | "processing" | "failed" | "enqueued" | "canceled" | "completed"; }>`
+- `api.queryService.getQueryResults(queryJobId: string, statementId: string, query?: { offset?: number | undefined; pageSize?: number | undefined; } | undefined): Promise<{ columns?: { length: number; name: string; nullable: boolean; type: string; }[] | undefined; data?: string[][] | undefined; message?: string | undefined; numberOfRows?: number | undefined; rowsAffected?: number | undefined; status: "waiting" | "processing" | "failed" | "canceled" | "completed" | "notExecuted"; }>`

package/surface/queue.md

@@ -0,0 +1,8 @@
+# `api.queue` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.queue.getJob(jobId: string, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "warning" | "success" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; }>`
+- `api.queue.searchJobs(query?: { id?: string[] | undefined; runId?: string[] | undefined; branchId?: string[] | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; componentId?: string[] | undefined; component?: string[] | undefined; configId?: string[] | undefined; config?: string[] | undefined; configRowIds?: string[] | undefined; mode?: ("run" | "debug")[] | undefined; status?: ("error" | "warning" | "success" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled")[] | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; componentProps?: { type?: string | undefined; } | undefined; createdTimeFrom?: string | undefined; createdTimeTo?: string | undefined; startTimeFrom?: string | undefined; startTimeTo?: string | undefined; endTimeFrom?: string | undefined; endTimeTo?: string | undefined; durationSecondsFrom?: number | undefined; durationSecondsTo?: number | undefined; offset?: number | undefined; limit?: number | undefined; sortBy?: "status" | "branchId" | "runId" | "componentId" | "projectId" | "configId" | "id" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "tokenDescription" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "warning" | "success" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; }[]>`

package/surface/scheduler.md

@@ -0,0 +1,12 @@
+# `api.scheduler` — `@keboola/api-client` surface
+
+<!-- GENERATED FILE — do not edit by hand. Run `pnpm --filter @keboola/api-client surface` to regenerate. -->
+
+Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
+
+- `api.scheduler.activateSchedule(body: { configurationId: string; configurationVersionId?: string | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; tokenId: string; configurationId: string; configurationVersionId: string; schedule: { cronTab: string; timezone: string; state: "enabled" | "disabled"; }; target: { componentId: string; configurationId: string; mode: string; tag: string; }; executions: { jobId: string; executionTime: string; }[]; }>`
+- `api.scheduler.deleteSchedule(scheduleId: string, signal?: AbortSignal | undefined): Promise<void>`
+- `api.scheduler.deleteSchedulesForConfiguration(configurationId: string, signal?: AbortSignal | undefined): Promise<void>`
+- `api.scheduler.getSchedule(scheduleId: string, signal?: AbortSignal | undefined): Promise<{ id: string; tokenId: string; configurationId: string; configurationVersionId: string; schedule: { cronTab: string; timezone: string; state: "enabled" | "disabled"; }; target: { componentId: string; configurationId: string; mode: string; tag: string; }; executions: { jobId: string; executionTime: string; }[]; }>`
+- `api.scheduler.getSchedules(query?: { componentId?: string | undefined; configurationId?: string | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ id: string; tokenId: string; configurationId: string; configurationVersionId: string; schedule: { cronTab: string; timezone: string; state: "enabled" | "disabled"; }; target: { componentId: string; configurationId: string; mode: string; tag: string; }; executions: { jobId: string; executionTime: string; }[]; }[]>`
+- `api.scheduler.refreshScheduleToken(scheduleId: string, signal?: AbortSignal | undefined): Promise<void>`