@keboola/api-client 46.0.0 → 47.0.0

package/surface/apps.md

@@ -6,7 +6,7 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 
 - `api.apps.createApp(body: { branchId: string | null; name: string; type: "streamlit" | "python-js"; description?: string | null | undefined; config?: { [key: string]: unknown; } | undefined; useManagedGitRepo: boolean; }, options?: WriteOptions): Promise<{ id: string; projectId: string; componentId: string; branchId: string | null; configId: string; type?: "streamlit" | "python-js" | null | undefined; url: string | null; production: { desiredDeploymentId?: string | null | undefined; actualDeploymentId?: string | null | undefined; }; state: "disabled" | "starting" | "running" | "notDeployed" | "suspended"; }>`
 - `api.apps.createAppGitRepoCredential(appId: string, body: { type: "ssh_key" | "http_token"; publicKey?: string | undefined; name: string; permissions: "readOnly" | "readWrite"; }, options?: WriteOptions): Promise<{ id: string; type: "ssh_key" | "http_token"; name: string; permissions: "readOnly" | "readWrite"; ownerAdminId: string; createdAt: string; } & { secret?: string | undefined; }>`
-- `api.apps.createDeployment(appId: string, body?: { promote: boolean; configVersion?: string | null | undefined; } | undefined, options?: WriteOptions): Promise<{ id: string; configVersion: string; gitCommitSha: string | null; runtimeSize?: "small" | "external" | "micro" | "tiny" | "medium" | "large" | null | undefined; buildState: "pending" | "failed" | "building" | "ready"; runState: "pending" | "failed" | "starting" | "running" | "stopping" | "stopped" | "neverRun"; archived: boolean; archivedAt: string | null; createdAt: string; }>`
+- `api.apps.createDeployment(appId: string, body?: { promote: boolean; configVersion?: string | null | undefined; } | undefined, options?: WriteOptions): Promise<{ id: string; configVersion: string; gitCommitSha: string | null; runtimeSize?: "small" | "external" | "micro" | "tiny" | "medium" | "large" | null | undefined; buildState: "pending" | "failed" | "building" | "ready"; runState: "pending" | "starting" | "running" | "failed" | "stopping" | "stopped" | "neverRun"; archived: boolean; archivedAt: string | null; createdAt: string; }>`
 - `api.apps.deleteApp(appId: string, signal?: AbortSignal | undefined): Promise<void>`
 - `api.apps.deleteAppGitRepoCredential(appId: string, credentialId: string, signal?: AbortSignal | undefined): Promise<void>`
 - `api.apps.deleteDeployment(appId: string, deploymentId: string, signal?: AbortSignal | undefined): Promise<void>`
@@ -17,13 +17,13 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.apps.getAppLogsDownload(appId: string, signal?: AbortSignal | undefined): Promise<{ logs: string; fileName: string; }>`
 - `api.apps.getAppLogsTail(appId: string, { query, signal }?: LogsTailOptions): Promise<{ entries: LogEntry[]; nextLogTimestamp: string | null; }>`
 - `api.apps.getAppPassword(appId: string, signal?: AbortSignal | undefined): Promise<{ password?: string | null | undefined; }>`
-- `api.apps.getAppRun(appId: string, runId: string, signal?: AbortSignal | undefined): Promise<{ id: string; appId: string; deploymentId: string | null; state?: "failed" | "starting" | "running" | "finished" | null | undefined; createdAt?: string | null | undefined; startedAt?: string | null | undefined; stoppedAt?: string | null | undefined; startupLogs?: string | null | undefined; runtimeSize?: string | null | undefined; runtimeBackendType?: string | null | undefined; configVersion?: string | null | undefined; imageVersion?: string | null | undefined; failureReason?: { reason?: string | null | undefined; message?: string | null | undefined; } | null | undefined; mode?: string | undefined; }>`
-- `api.apps.getAppRuns(appId: string, query?: { deploymentId?: string | undefined; since?: string | undefined; until?: string | undefined; offset?: number | undefined; limit?: number | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; appId: string; deploymentId: string | null; state?: "failed" | "starting" | "running" | "finished" | null | undefined; createdAt?: string | null | undefined; startedAt?: string | null | undefined; stoppedAt?: string | null | undefined; startupLogs?: string | null | undefined; runtimeSize?: string | null | undefined; runtimeBackendType?: string | null | undefined; configVersion?: string | null | undefined; imageVersion?: string | null | undefined; failureReason?: { reason?: string | null | undefined; message?: string | null | undefined; } | null | undefined; mode?: string | undefined; }[]>`
+- `api.apps.getAppRun(appId: string, runId: string, signal?: AbortSignal | undefined): Promise<{ id: string; appId: string; deploymentId: string | null; state?: "starting" | "running" | "failed" | "finished" | null | undefined; createdAt?: string | null | undefined; startedAt?: string | null | undefined; stoppedAt?: string | null | undefined; startupLogs?: string | null | undefined; runtimeSize?: string | null | undefined; runtimeBackendType?: string | null | undefined; configVersion?: string | null | undefined; imageVersion?: string | null | undefined; failureReason?: { reason?: string | null | undefined; message?: string | null | undefined; } | null | undefined; mode?: string | undefined; }>`
+- `api.apps.getAppRuns(appId: string, query?: { deploymentId?: string | undefined; since?: string | undefined; until?: string | undefined; offset?: number | undefined; limit?: number | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; appId: string; deploymentId: string | null; state?: "starting" | "running" | "failed" | "finished" | null | undefined; createdAt?: string | null | undefined; startedAt?: string | null | undefined; stoppedAt?: string | null | undefined; startupLogs?: string | null | undefined; runtimeSize?: string | null | undefined; runtimeBackendType?: string | null | undefined; configVersion?: string | null | undefined; imageVersion?: string | null | undefined; failureReason?: { reason?: string | null | undefined; message?: string | null | undefined; } | null | undefined; mode?: string | undefined; }[]>`
 - `api.apps.getApps(query?: { offset?: number | undefined; limit?: number | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; projectId: string; componentId: string; branchId: string | null; configId: string; type?: "streamlit" | "python-js" | null | undefined; url: string | null; production: { desiredDeploymentId?: string | null | undefined; actualDeploymentId?: string | null | undefined; }; state: "disabled" | "starting" | "running" | "notDeployed" | "suspended"; }[]>`
-- `api.apps.getDeployment(appId: string, deploymentId: string, signal?: AbortSignal | undefined): Promise<{ id: string; configVersion: string; gitCommitSha: string | null; runtimeSize?: "small" | "external" | "micro" | "tiny" | "medium" | "large" | null | undefined; buildState: "pending" | "failed" | "building" | "ready"; runState: "pending" | "failed" | "starting" | "running" | "stopping" | "stopped" | "neverRun"; archived: boolean; archivedAt: string | null; createdAt: string; }>`
+- `api.apps.getDeployment(appId: string, deploymentId: string, signal?: AbortSignal | undefined): Promise<{ id: string; configVersion: string; gitCommitSha: string | null; runtimeSize?: "small" | "external" | "micro" | "tiny" | "medium" | "large" | null | undefined; buildState: "pending" | "failed" | "building" | "ready"; runState: "pending" | "starting" | "running" | "failed" | "stopping" | "stopped" | "neverRun"; archived: boolean; archivedAt: string | null; createdAt: string; }>`
 - `api.apps.getDeploymentLogsDownload(appId: string, deploymentId: string, signal?: AbortSignal | undefined): Promise<{ logs: string; fileName: string; }>`
 - `api.apps.getDeploymentLogsTail(appId: string, deploymentId: string, { query, signal }?: LogsTailOptions): Promise<{ entries: LogEntry[]; nextLogTimestamp: string | null; }>`
-- `api.apps.getDeployments(appId: string, query?: { archived?: boolean | undefined; offset?: number | undefined; limit?: number | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; configVersion: string; gitCommitSha: string | null; runtimeSize?: "small" | "external" | "micro" | "tiny" | "medium" | "large" | null | undefined; buildState: "pending" | "failed" | "building" | "ready"; runState: "pending" | "failed" | "starting" | "running" | "stopping" | "stopped" | "neverRun"; archived: boolean; archivedAt: string | null; createdAt: string; }[]>`
+- `api.apps.getDeployments(appId: string, query?: { archived?: boolean | undefined; offset?: number | undefined; limit?: number | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; configVersion: string; gitCommitSha: string | null; runtimeSize?: "small" | "external" | "micro" | "tiny" | "medium" | "large" | null | undefined; buildState: "pending" | "failed" | "building" | "ready"; runState: "pending" | "starting" | "running" | "failed" | "stopping" | "stopped" | "neverRun"; archived: boolean; archivedAt: string | null; createdAt: string; }[]>`
 - `api.apps.healthCheck(signal?: AbortSignal | undefined): Promise<{ appName?: string | undefined; appVersion?: string | undefined; apiDocs?: string | undefined; }>`
 - `api.apps.promoteDeployment(appId: string, deploymentId: string, signal?: AbortSignal | undefined): Promise<{ id: string; projectId: string; componentId: string; branchId: string | null; configId: string; type?: "streamlit" | "python-js" | null | undefined; url: string | null; production: { desiredDeploymentId?: string | null | undefined; actualDeploymentId?: string | null | undefined; }; state: "disabled" | "starting" | "running" | "notDeployed" | "suspended"; }>`
 - `api.apps.resetAppPassword(appId: string, signal?: AbortSignal | undefined): Promise<{ password: string; }>`

package/surface/auth.md

@@ -27,6 +27,8 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 ### `api.auth.me`
 
 - `api.auth.me.get(signal?: AbortSignal | undefined): Promise<{ user: { id: number; name: string; email: string; isSuperAdmin: boolean; hasMfaEnabled: boolean; features: string[]; }; organizations: { count: number; preview: { id: number; name: string; mfaRequired: boolean; maintainer: { id: number; name: string | null; }; isAdmin: boolean; hasAccess: boolean; canLeave: boolean; projectsCount: number; }[]; hasMore: boolean; }; maintainers: { count: number; preview: { id: number; name: string | null; }[]; hasMore: boolean; }; projects: { count: number; preview: { id: number; name: string; organizationId: number; role: string | null; isDisabled: boolean; disabledReason: string | null; }[]; hasMore: boolean; }; }>`
+- `api.auth.me.getAllOrganizations(signal?: AbortSignal | undefined): Promise<{ id: number; name: string; mfaRequired: boolean; maintainer: { id: number; name: string | null; }; isAdmin: boolean; hasAccess: boolean; canLeave: boolean; projectsCount: number; }[]>`
+- `api.auth.me.getAllProjects(signal?: AbortSignal | undefined): Promise<{ id: number; name: string; organizationId: number; role: string | null; isDisabled: boolean; disabledReason: string | null; }[]>`
 - `api.auth.me.getMaintainers(query?: { page?: { after?: string | undefined; limit?: number | undefined; } | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ data: Record<string, never>[]; meta: { total: number; limit: number; cursor: { param: string; encoding: string; fields: { name: string; type: "string" | "integer" | "date-time"; nullable: boolean; }[]; order: string; }; }; links: { self: string; first: string; next: string | null; }; } & { data?: { id: number; name: string | null; }[] | undefined; }>`
 - `api.auth.me.getOrganizations(query?: { page?: { after?: string | undefined; limit?: number | undefined; } | undefined; filter?: { maintainerId?: number | undefined; } | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ data: Record<string, never>[]; meta: { total: number; limit: number; cursor: { param: string; encoding: string; fields: { name: string; type: "string" | "integer" | "date-time"; nullable: boolean; }[]; order: string; }; }; links: { self: string; first: string; next: string | null; }; } & { data?: { id: number; name: string; mfaRequired: boolean; maintainer: { id: number; name: string | null; }; isAdmin: boolean; hasAccess: boolean; canLeave: boolean; projectsCount: number; }[] | undefined; }>`
 - `api.auth.me.getProjects(query?: { page?: { after?: string | undefined; limit?: number | undefined; } | undefined; filter?: { organizationId?: number | undefined; name?: string | undefined; } | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ data: Record<string, never>[]; meta: { total: number; limit: number; cursor: { param: string; encoding: string; fields: { name: string; type: "string" | "integer" | "date-time"; nullable: boolean; }[]; order: string; }; }; links: { self: string; first: string; next: string | null; }; } & { data?: { id: number; name: string; organizationId: number; role: string | null; isDisabled: boolean; disabledReason: string | null; }[] | undefined; }>`

package/surface/chat.md

@@ -4,10 +4,10 @@
 
 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?: "pending" | "completed" | "failed" | "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.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?: "pending" | "failed" | "completed" | "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<AgentSettings>`
-- `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?: "pending" | "completed" | "failed" | "interrupted" | undefined; }[]; }>`
+- `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?: "pending" | "failed" | "completed" | "interrupted" | undefined; }[]; }>`
 - `api.chat.getHistory(params?: { limit?: number | undefined; starting_after?: string | undefined; ending_before?: string | undefined; } | undefined, signal?: AbortSignal | 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" | "success" | "warning" | "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" | "success" | "warning" | "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: "error" | "maintenance" | "documentation"; reasoning: string; id: string; }[]; suggestionSessionId: string; }>`
 - `api.chat.getToolsList(signal?: AbortSignal | undefined): Promise<{ tools: { name: string; description: string; readOnly: boolean; }[]; }>`

package/surface/componentsMcp.md

@@ -0,0 +1,9 @@
+# `api.componentsMcp` — `@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.componentsMcp.getConnectors(query?: { provider?: string | null | undefined; }, signal?: AbortSignal | undefined): Promise<{ [x: string]: unknown; providers: Record<string, number>; connectors: { [x: string]: unknown; id: string; provider: string; display_name: string; description: string; has_stored_credentials: boolean; credentials_schema: Record<string, unknown>; }[]; }>`
+- `api.componentsMcp.healthCheck(signal?: AbortSignal | undefined): Promise<{ [key: string]: unknown; }>`
+- `api.componentsMcp.setConnectorCredentials(path: { connector_id: string; }, body: { credentials: { [key: string]: unknown; }; label: string; note?: string | null | undefined; }, signal?: AbortSignal | undefined): Promise<{ [x: string]: unknown; connector: string; label: string; status: "stored"; }>`

package/surface/dataScience.md

@@ -12,8 +12,8 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `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: "failed" | "starting" | "running" | "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; runtimeBackendType?: string | null | undefined; configVersion?: string | null | undefined; imageVersion?: 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: "failed" | "starting" | "running" | "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; runtimeBackendType?: string | null | undefined; configVersion?: string | null | undefined; imageVersion?: string | null | undefined; failureReason?: { reason?: string | null | undefined; message?: string | null | undefined; } | null | undefined; mode: "dev" | "prod"; }[]>`
+- `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; runtimeBackendType?: string | null | undefined; configVersion?: string | null | undefined; imageVersion?: 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; runtimeBackendType?: string | null | undefined; configVersion?: string | null | undefined; imageVersion?: 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?: ("snowflake" | "bigquery" | "python" | "r" | "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; 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; }>`

package/surface/kaiAgent.md

@@ -5,14 +5,14 @@
 Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 
 - `api.kaiAgent.approveToolCall(chatId: string, body: { toolUseId: string; approved: boolean; reason?: string | undefined; dismissed?: boolean | 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; autoForwarded?: boolean | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; deployPreapproval?: { configurationId: string; } | undefined; tableContext?: { tableName: string; tableId: string; bucketId: string; fileName: string; }[] | undefined; } | undefined; }; selectedChatModel?: string | undefined; selectedVisibilityType?: "public" | "private" | undefined; branchId?: number | undefined; model?: string | undefined; toolRestrictions?: { allowedTools?: string[] | undefined; disallowedTools?: string[] | undefined; readOnlyMode?: boolean | undefined; } | undefined; telemetryMetadata?: { [key: string]: string | number | boolean; } | undefined; supportsApprovalRequestedEvent?: boolean | undefined; client?: "kbc-ui" | "business-chat" | undefined; }): Promise<Response>`
+- `api.kaiAgent.createChat(request: { id: string; message: { id: string; role: "user" | "assistant"; parts: { [key: string]: unknown; }[]; metadata?: { hidden?: boolean | undefined; autoForwarded?: boolean | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; deployPreapproval?: { configurationId: string; } | undefined; tableContext?: { tableName: string; tableId: string; bucketId: string; fileName: string; }[] | undefined; previewSelections?: { source: string | null; sourceTrail: string[]; selector: string; tag: string; text: string; html: string; rect: { x: number; y: number; width: number; height: number; }; page: string; viewport: { width: number; height: number; }; area?: { inside: { source: string | null; tag: string; text: string; }[]; within: { source: string | null; tag: string; text: string; } | null; above: { source: string | null; tag: string; text: string; } | null; below: { source: string | null; tag: string; text: string; } | null; } | undefined; }[] | undefined; previewIntent?: "data-source" | undefined; } | undefined; }; selectedChatModel?: string | undefined; selectedVisibilityType?: "public" | "private" | undefined; branchId?: number | undefined; model?: string | undefined; toolRestrictions?: { allowedTools?: string[] | undefined; disallowedTools?: string[] | undefined; readOnlyMode?: boolean | undefined; } | undefined; telemetryMetadata?: { [key: string]: string | number | boolean; } | undefined; supportsApprovalRequestedEvent?: boolean | undefined; client?: "kbc-ui" | "business-chat" | 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.deleteUserMemory(memoryId: string, signal?: AbortSignal | undefined): Promise<void>`
 - `api.kaiAgent.downloadSandboxFile(chatId: string, path: string, signal?: AbortSignal | undefined): Promise<Blob>`
 - `api.kaiAgent.getAgentSettings(signal?: AbortSignal | undefined): Promise<{ projectId: string; customInstructions: string | null; createdAt: string; updatedAt: string; toolPermissions?: Record<string, ProjectToolPolicyValue> | null | undefined; canWriteToolPolicy?: boolean | undefined; }>`
 - `api.kaiAgent.getArtifact(artifactId: string, signal?: AbortSignal | undefined): Promise<{ id: string; chatId: string; messageId: string; kind: "table" | "chart" | "document"; title: string; summary: string | null; spec: { [key: string]: unknown; }; recipe: { [key: string]: unknown; }; createdAt: string; }>`
 - `api.kaiAgent.getArtifacts(chatId: string, signal?: AbortSignal | undefined): Promise<{ id: string; chatId: string; messageId: string; kind: "table" | "chart" | "document"; title: string; summary: string | null; spec: { [key: string]: unknown; }; recipe: { [key: string]: unknown; }; createdAt: 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; contextWindow?: { usedTokens: number; maxTokens: number; percentage: number; } | null | undefined; ppuUsed: number | null; ppuPercentage: number | null; model: string | null; effort: "medium" | "low" | "high" | "xhigh" | "max" | null; effectiveModel: string | null; 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; autoForwarded?: boolean | undefined; pausedReason?: "turn-budget" | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; } | undefined; status?: "pending" | "completed" | "failed" | "interrupted" | undefined; }[]; }>`
+- `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; contextWindow?: { usedTokens: number; maxTokens: number; percentage: number; } | null | undefined; ppuUsed: number | null; ppuPercentage: number | null; model: string | null; effort: "medium" | "low" | "high" | "xhigh" | "max" | null; effectiveModel: string | null; 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; autoForwarded?: boolean | undefined; pausedReason?: "turn-budget" | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; } | undefined; status?: "pending" | "failed" | "completed" | "interrupted" | undefined; }[]; }>`
 - `api.kaiAgent.getHistory(params?: { limit?: number | undefined; starting_after?: string | undefined; ending_before?: string | undefined; client?: "kbc-ui" | "business-chat" | undefined; } | undefined, signal?: AbortSignal | 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; client?: "kbc-ui" | "business-chat" | 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; }[]; }>`

package/surface/management.md

@@ -175,14 +175,16 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 ### `api.management.storageBackends`
 
 - `api.management.storageBackends.activateStorageBackend(backendId: number): Promise<{ id: number; backend: string; region: string; owner: string | null; technicalOwner: string; technicalOwnerContactEmails: string[]; host?: string | undefined; credentials?: Record<string, never> | undefined; folderId?: string | null | undefined; useDynamicBackends?: boolean | undefined; useNetworkPolicies?: boolean | undefined; useSso?: boolean | undefined; isSsoEnabled?: boolean | undefined; isSsoConfigured?: boolean | undefined; isEnabled?: boolean | undefined; }>`
-- `api.management.storageBackends.createBigqueryStorageBackend(body: { owner: "client" | "keboola"; technicalOwner: "keboola" | "internal" | "kbdb" | "byodb"; folderId: string; region: string; credentials: { type: string; project_id: string; private_key_id: string; private_key: string; client_email: string; client_id: string; auth_uri: string; token_uri: string; auth_provider_x509_cert_url: string; client_x509_cert_url: string; }; bqExternalSharingRoleName?: string | null | undefined; }): Promise<{ id: number; backend: string; region: string; owner: string; technicalOwner: string; technicalOwnerContactEmails: string[]; credentials: Record<string, never>; folderId: string | null; bqExternalSharingRoleName: string | null; policyTagsEnabled: boolean; }>`
+- `api.management.storageBackends.createBigqueryServerSideStorageBackend(body: { adminCredentials: { [key: string]: unknown; }; masterServiceAccountResourceName: string; folderId: string; region: string; owner: "client" | "keboola"; technicalOwner: "keboola" | "internal" | "kbdb" | "byodb"; bqExternalSharingRoleName?: string | null | undefined; }): Promise<StorageBackendBigquery>`
+- `api.management.storageBackends.createBigqueryStorageBackend(body: { owner: "client" | "keboola"; technicalOwner: "keboola" | "internal" | "kbdb" | "byodb"; folderId: string; region: string; credentials: { type: string; project_id: string; private_key_id: string; private_key: string; client_email: string; client_id: string; auth_uri: string; token_uri: string; auth_provider_x509_cert_url: string; client_x509_cert_url: string; }; bqExternalSharingRoleName?: string | null | undefined; }): Promise<StorageBackendBigquery>`
 - `api.management.storageBackends.createSnowflakeStorageBackend(body: { host: string; warehouse: string; username: string; region: string; owner: string; technicalOwner: "keboola" | "internal" | "kbdb" | "byodb"; technicalOwnerContactEmails?: string[] | null | undefined; useDynamicBackends?: boolean | null | undefined; useNetworkPolicies?: boolean | null | undefined; useSso?: boolean | null | undefined; edition?: "standard" | "enterprise" | null | undefined; }): Promise<{ id: number; host: string; warehouse: string; username: string; owner: string; technicalOwner: string; region: string; created: string; creatorId: number; creatorName: string; useDynamicBackends: boolean; useNetworkPolicies: boolean; useSso: boolean; isSsoEnabled: boolean; isSsoConfigured: boolean; edition: string; sqlTemplate: string; isEnabled: boolean; userPublicKey: string; securityIntegrationKey: string | null; }>`
 - `api.management.storageBackends.deleteStorageBackend(id: number): Promise<void>`
+- `api.management.storageBackends.getPolicyTagEnablementGuide({ id, ...query }: PolicyTagEnablementGuideInput, signal?: AbortSignal | undefined): Promise<{ format: "markdown" | "terraform"; content: string; }>`
 - `api.management.storageBackends.getStorageBackend(id: number, signal?: AbortSignal | undefined): Promise<StorageBackend>`
 - `api.management.storageBackends.getStorageBackendMaintainers(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; }[]>`
 - `api.management.storageBackends.getStorageBackendProjects(id: number, query?: { limit?: number | undefined; offset?: number | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; }[]>`
 - `api.management.storageBackends.getStorageBackends(signal?: AbortSignal | undefined): Promise<StorageBackend[]>`
-- `api.management.storageBackends.updateBigqueryStorageBackend({ id, ...body }: UpdateBigqueryStorageBackendInput): Promise<{ id: number; backend: string; region: string; owner: string; technicalOwner: string; technicalOwnerContactEmails: string[]; credentials: Record<string, never>; folderId: string | null; bqExternalSharingRoleName: string | null; policyTagsEnabled: boolean; }>`
+- `api.management.storageBackends.updateBigqueryStorageBackend({ id, ...body }: UpdateBigqueryStorageBackendInput): Promise<StorageBackendBigquery>`
 - `api.management.storageBackends.updateStorageBackend({ id, ...body }: UpdateStorageBackendInput): Promise<{ id: number; backend: string; region: string; owner: string | null; technicalOwner: string; technicalOwnerContactEmails: string[]; host?: string | undefined; credentials?: Record<string, never> | undefined; folderId?: string | null | undefined; useDynamicBackends?: boolean | undefined; useNetworkPolicies?: boolean | undefined; useSso?: boolean | undefined; isSsoEnabled?: boolean | undefined; isSsoConfigured?: boolean | undefined; isEnabled?: boolean | undefined; }>`
 
 ### `api.management.uiApps`

package/surface/oauth.md

@@ -8,4 +8,5 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.oauth.deleteCredential({ componentId, id }: CredentialInput, signal?: AbortSignal | undefined): Promise<void>`
 - `api.oauth.getCredential({ componentId, id }: CredentialInput, signal?: AbortSignal | undefined): Promise<{ id: string; branchId: string | null; authorizedFor: string; creator: { id: string; description: string | null; }; created: string; oauthVersion: string; appKey: string; '#appSecret': string; '#data': string; }>`
 - `api.oauth.getCredentials(scope: GetCredentialsInput, signal?: AbortSignal | undefined): Promise<{ id: string; branchId: string | null; authorizedFor: string; creator: { id: string; description: string | null; }; created: string; oauthVersion: string; appKey: string; '#appSecret': string; '#data': string; }[]>`
+- `api.oauth.getOrganizationConnections(signal?: AbortSignal | undefined): Promise<{ accountLogin: string; host: string; }[]>`
 - `api.oauth.healthCheck(signal?: AbortSignal | undefined): Promise<unknown>`

package/surface/queryService.md

@@ -7,8 +7,8 @@ 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" | "canceled" | "completed" | "failed" | "notExecuted"; warehouse?: string | undefined; }[]; }>`
-- `api.queryService.getQueryJob(queryJobId: string, signal?: AbortSignal | undefined): 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" | "canceled" | "completed" | "failed" | "notExecuted"; }[]; status: "created" | "processing" | "enqueued" | "canceled" | "completed" | "failed"; }>`
-- `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" | "canceled" | "completed" | "failed" | "notExecuted"; }>`
+- `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, signal?: AbortSignal | undefined): 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"; }>`
 - `api.queryService.healthCheck(signal?: AbortSignal | undefined): Promise<unknown>`
-- `api.queryService.poller({ id }: { id: string; }, { interval, maxAttempts, timeout, signal }?: QueryJobPollOptions): Poller<{ 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" | "canceled" | "completed" | "failed" | "notExecuted"; }[]; status: "created" | "processing" | "enqueued" | "canceled" | "completed" | "failed"; }>`
+- `api.queryService.poller({ init, interval, maxAttempts, timeout, signal, }: QueryJobPollOptions & { init: JobRef | ((signal: AbortSignal) => Promise<JobRef>); }): Poller<{ 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"; }, { 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"; }>`

package/surface/queue.md

@@ -9,7 +9,7 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.queue.getOrchestrationRerunPlan(jobId: string, signal?: AbortSignal | undefined): Promise<{ jobId?: string | undefined; configId?: string | null | undefined; matchedTasks?: { taskId?: string | undefined; matched?: boolean | undefined; jobId?: string | null | undefined; componentId?: string | null | undefined; configId?: string | null | undefined; status?: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled" | undefined; }[] | undefined; }>`
 - `api.queue.healthCheck(signal?: AbortSignal | undefined): Promise<unknown>`
 - `api.queue.killJob(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" | "success" | "warning" | "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; isSuccess: boolean | null; 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; onlyFlowTaskIds?: string[] | null | undefined; }>`
-- `api.queue.poller({ id, component }: { id: string; component: string; }, { interval, maxAttempts, timeout, signal }?: QueueJobPollOptions): Poller<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "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; isSuccess: boolean | null; 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; onlyFlowTaskIds?: string[] | null | undefined; }>`
-- `api.queue.searchAllJobs(query: { branchId?: string[] | undefined; runId?: string[] | undefined; mode?: ("run" | "debug")[] | undefined; componentId?: string[] | undefined; configId?: string[] | undefined; id?: string[] | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; config?: string[] | undefined; component?: string[] | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; configRowIds?: string[] | undefined; status?: ("error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled")[] | 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; limit?: number | undefined; sortBy?: "branchId" | "runId" | "componentId" | "projectId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; parentRunId?: string | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "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; isSuccess: boolean | null; 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; onlyFlowTaskIds?: string[] | null | undefined; }[]>`
+- `api.queue.poller({ init, interval, maxAttempts, timeout, signal, }: QueueJobPollOptions & { init: JobRef | ((signal: AbortSignal) => Promise<JobRef>); }): Poller<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "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; isSuccess: boolean | null; 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; onlyFlowTaskIds?: string[] | null | undefined; }, { id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "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; isSuccess: boolean | null; 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; onlyFlowTaskIds?: string[] | null | undefined; }>`
+- `api.queue.searchAllJobs(query: { branchId?: string[] | undefined; runId?: string[] | undefined; mode?: ("run" | "debug")[] | undefined; componentId?: string[] | undefined; configId?: string[] | undefined; id?: string[] | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; config?: string[] | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; component?: string[] | undefined; configRowIds?: string[] | undefined; status?: ("error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled")[] | 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; limit?: number | undefined; sortBy?: "branchId" | "runId" | "componentId" | "projectId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; parentRunId?: string | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "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; isSuccess: boolean | null; 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; onlyFlowTaskIds?: string[] | null | undefined; }[]>`
 - `api.queue.searchGroupedJobs(query: { groupBy: ("branchId" | "componentId" | "projectId" | "configId")[]; jobsPerGroup?: number | undefined; sortBy?: "branchId" | "runId" | "componentId" | "projectId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; limit?: number | undefined; id?: number[] | undefined; runId?: string[] | undefined; branchId?: string[] | undefined; configId?: string[] | undefined; config?: string[] | undefined; configRowIds?: string[] | undefined; projectId?: string[] | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; componentId?: string[] | undefined; component?: string[] | undefined; status?: string[] | undefined; desiredStatus?: string[] | undefined; mode?: string[] | undefined; tag?: string[] | undefined; startTimeFrom?: string | undefined; startTimeTo?: string | undefined; createdTimeFrom?: string | undefined; createdTimeTo?: string | undefined; endTimeFrom?: string | undefined; endTimeTo?: string | undefined; durationSecondsFrom?: number | undefined; durationSecondsTo?: number | undefined; variableValuesId?: string[] | undefined; parentRunId?: string[] | undefined; type?: string[] | undefined; componentProps?: { type?: string | undefined; } | undefined; }, signal?: AbortSignal | undefined): Promise<{ group?: { [key: string]: string; } | undefined; jobs?: { id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "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; isSuccess: boolean | null; 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; onlyFlowTaskIds?: string[] | null | undefined; }[] | 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" | "success" | "warning" | "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?: "branchId" | "runId" | "componentId" | "projectId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; parentRunId?: string | 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" | "success" | "warning" | "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; isSuccess: boolean | null; 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; onlyFlowTaskIds?: string[] | null | undefined; }[]>`

package/surface/sdk.md

@@ -43,30 +43,6 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.sdk.semanticLayer.updateObject<T extends SemanticChildObjectType>(objectType: T, objectUUID: string, data: Partial<SemanticChildObjectDataMap[T]>, meta?: UpdateSemanticObjectMeta): Promise<SemanticObject<SemanticChildObjectDataMap[T]>>`
 - `api.sdk.semanticLayer.withdrawScopeElevationRequest(objectType: SemanticObjectType, objectUUID: string): Promise<void>`
 
-### `api.sdk.storage`
-
-- `api.sdk.storage.addTableColumn(input: AddTableColumnInput, options?: Options | undefined): Promise<AddTableColumnJob>`
-- `api.sdk.storage.createBucketListing(input: CreateBucketListingInput, options?: Options | undefined): Promise<BucketListingCreateJob>`
-- `api.sdk.storage.createSnapshot(input: CreateSnapshotInput, options?: Options | undefined): Promise<CreateSnapshotJob>`
-- `api.sdk.storage.createTable(input: CreateTableAsyncInput, options?: Options | undefined): Promise<TableCreateJob>`
-- `api.sdk.storage.createTableDefinition(input: CreateTableDefinitionInput, options?: Options | undefined): Promise<TableDefinitionCreateJob>`
-- `api.sdk.storage.createTablePrimaryKey(input: CreateTablePrimaryKeyInput, options?: Options | undefined): Promise<CreateTablePrimaryKeyJob>`
-- `api.sdk.storage.deleteBucketListing(input: { bucketId: string; branchId: string; }, options?: Options | undefined): Promise<BucketListingDeleteJob>`
-- `api.sdk.storage.deleteTableColumn(input: DeleteTableColumnInput, options?: Options | undefined): Promise<DeleteTableColumnJob>`
-- `api.sdk.storage.exportToFile(input: ExportAsyncInput, options?: Options | undefined): Promise<TableExportJob>`
-- `api.sdk.storage.forceUnlinkBucket(input: { bucketId: string; linkedProjectId: number; branchId: string; }, options?: Options | undefined): Promise<ForceUnlinkBucketJob>`
-- `api.sdk.storage.importFromFile(input: ImportAsyncInput, options?: Options | undefined): Promise<TableImportJob>`
-- `api.sdk.storage.pullTable(input: PullTableAsyncPath, options?: Options | undefined): Promise<PullTableJob>`
-- `api.sdk.storage.refreshExternalBucket(input: RefreshExternalBucketInput, options?: Options | undefined): Promise<RefreshBucketJob>`
-- `api.sdk.storage.registerBucket(input: RegisterBucketInput, options?: Options | undefined): Promise<RegisterBucketJob>`
-- `api.sdk.storage.removeTablePrimaryKey(input: { tableId: string; branchId: string; }, options?: Options | undefined): Promise<RemoveTablePrimaryKeyJob>`
-- `api.sdk.storage.shareBucketToOrganization(input: { bucketId: string; branchId: string; }, options?: Options | undefined): Promise<ShareBucketToOrganizationJob>`
-- `api.sdk.storage.shareBucketToOrganizationProject(input: { bucketId: string; branchId: string; }, options?: Options | undefined): Promise<ShareBucketToOrganizationProjectJob>`
-- `api.sdk.storage.shareBucketToProjects(input: ShareBucketToProjectsInput, options?: Options | undefined): Promise<ShareBucketToProjectsJob>`
-- `api.sdk.storage.shareBucketToUsers(input: ShareBucketToUsersInput, options?: Options | undefined): Promise<ShareBucketToAdminsJob>`
-- `api.sdk.storage.unshareBucket(input: { bucketId: string; branchId: string; }, options?: Options | undefined): Promise<RemoveBucketShareJob>`
-- `api.sdk.storage.updateBucketListing(input: UpdateBucketListingInput, options?: Options | undefined): Promise<BucketListingUpdateJob>`
-
 ### `api.sdk.tag`
 
 - `api.sdk.tag.assignTags(tagUUIDs: string[], objectId: KeboolaObjectId, meta?: CreateMetaObjectMetaDataInput): Promise<void>`