@keboola/api-client 35.0.0 → 36.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/dist/apps/index.cjs +26 -19
  3. package/dist/apps/index.cjs.map +1 -1
  4. package/dist/apps/index.d.cts +31 -73
  5. package/dist/apps/index.d.ts +31 -73
  6. package/dist/apps/index.js +26 -19
  7. package/dist/apps/index.js.map +1 -1
  8. package/dist/apps/types.d.cts +2 -2
  9. package/dist/apps/types.d.ts +2 -2
  10. package/dist/{index-DFBFa3SS.d.ts → index-2JM0gyAf.d.ts} +27 -64
  11. package/dist/{index-Dodwl64k.d.cts → index-BDG-LKXj.d.cts} +2 -2
  12. package/dist/{index-P-iT5THa.d.ts → index-BXF-bs2d.d.ts} +2 -2
  13. package/dist/{index-BLx14ZI4.d.cts → index-DIAyi-EZ.d.cts} +27 -64
  14. package/dist/index.d.cts +2 -2
  15. package/dist/index.d.ts +2 -2
  16. package/dist/management/index.d.cts +1 -1
  17. package/dist/management/index.d.ts +1 -1
  18. package/dist/management/types.d.cts +1 -1
  19. package/dist/management/types.d.ts +1 -1
  20. package/dist/queryService/index.d.cts +1 -1
  21. package/dist/queryService/index.d.ts +1 -1
  22. package/dist/queue/index.d.cts +1 -1
  23. package/dist/queue/index.d.ts +1 -1
  24. package/dist/sdk/configurations/index.d.cts +1 -1
  25. package/dist/sdk/configurations/index.d.ts +1 -1
  26. package/dist/sdk/queryService/index.d.cts +1 -1
  27. package/dist/sdk/queryService/index.d.ts +1 -1
  28. package/dist/sdk/storage/index.d.cts +1 -1
  29. package/dist/sdk/storage/index.d.ts +1 -1
  30. package/dist/storage/index.d.cts +1 -1
  31. package/dist/storage/index.d.ts +1 -1
  32. package/dist/{types-BMeDOB_D.d.ts → types-BuqxXXYP.d.ts} +13 -1
  33. package/dist/{types-B3GOGUJ7.d.cts → types-CzsnuPFh.d.cts} +13 -1
  34. package/dist/{types-CBgLCkYe.d.ts → types-D6UmMa6E.d.ts} +224 -401
  35. package/dist/{types-DARv_P6O.d.cts → types-DXskkNp8.d.cts} +224 -401
  36. package/package.json +8 -8
  37. package/surface/apps.md +11 -11
  38. package/surface/billing.md +2 -2
  39. package/surface/editor.md +5 -5
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@keboola/api-client",
3
- "version": "35.0.0",
3
+ "version": "36.0.0",
4
4
  "description": "TypeScript SDK for Keboola APIs",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -923,19 +923,19 @@
923
923
  "@types/node": "24.12.0",
924
924
  "@types/qs": "^6",
925
925
  "@typescript/native": "npm:typescript@^7.0.2",
926
- "@vitest/coverage-v8": "^4.1.10",
927
- "msw": "^2.14.6",
926
+ "@vitest/coverage-v8": "^4.1.11",
927
+ "msw": "^2.15.0",
928
928
  "openapi-typescript": "7.10.1",
929
929
  "oxfmt": "^0.66.0",
930
930
  "oxlint": "^1.81.0",
931
931
  "tsdown": "^0.22.14",
932
932
  "typescript": "npm:@typescript/typescript6@^6.0.2",
933
- "vite": "^8.1.5",
934
- "vitest": "^4.1.10",
933
+ "vite": "^8.3.0",
934
+ "vitest": "^4.1.11",
935
935
  "yaml": "^2.8.3",
936
- "@keboola/oxlint-config": "^10.0.2",
937
- "@keboola/vitest-config": "^1.0.0",
938
- "@keboola/tsconfig": "^0.2.1"
936
+ "@keboola/oxlint-config": "^10.1.0",
937
+ "@keboola/tsconfig": "^0.2.1",
938
+ "@keboola/vitest-config": "^1.0.0"
939
939
  },
940
940
  "scripts": {
941
941
  "gen:types": "node scripts/gen-types.mjs",
package/surface/apps.md CHANGED
@@ -4,13 +4,13 @@
4
4
 
5
5
  Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
6
6
 
7
- - `api.apps.createApp(body: { name: string; type: "streamlit" | "python-js"; description?: string | null | undefined; }, options?: WriteOptions): Promise<{ id: string; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; type?: "streamlit" | "python-js" | null | undefined; mode?: "dev" | "prod" | undefined; url: string | null; production: { desiredNumber?: number | null | undefined; desiredId?: string | null | undefined; actualNumber?: number | null | undefined; actualId?: string | null | undefined; }; undeployedChanges?: boolean | undefined; state: "NOT_DEPLOYED" | "STARTING" | "RUNNING" | "SLEEPING" | "SUSPENDED"; }>`
7
+ - `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"; }>`
8
8
  - `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; }>`
9
- - `api.apps.createDeployment(appId: string, body?: { promote: boolean; } | undefined, options?: WriteOptions): Promise<{ id: string; number: number; configId: string; configVersion: string; gitCommitSha: string | null; size?: "small" | "external" | "micro" | "tiny" | "medium" | "large" | null | undefined; buildState: "PREBUILT" | "PENDING" | "BUILDING" | "BUILT" | "FAILED"; runState: "STARTING" | "RUNNING" | "PENDING" | "FAILED" | "NEVER_RUN" | "STOPPING" | "STOPPED"; archived: boolean; archivedAt: string | null; createdAt: string; }>`
9
+ - `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: "failed" | "pending" | "building" | "ready"; runState: "failed" | "starting" | "running" | "stopping" | "stopped" | "pending" | "neverRun"; archived: boolean; archivedAt: string | null; createdAt: string; }>`
10
10
  - `api.apps.deleteApp(appId: string, signal?: AbortSignal | undefined): Promise<void>`
11
11
  - `api.apps.deleteAppGitRepoCredential(appId: string, credentialId: string, signal?: AbortSignal | undefined): Promise<void>`
12
12
  - `api.apps.deleteDeployment(appId: string, deploymentId: string, signal?: AbortSignal | undefined): Promise<void>`
13
- - `api.apps.getApp(appId: string, signal?: AbortSignal | undefined): Promise<{ id: string; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; type?: "streamlit" | "python-js" | null | undefined; mode?: "dev" | "prod" | undefined; url: string | null; production: { desiredNumber?: number | null | undefined; desiredId?: string | null | undefined; actualNumber?: number | null | undefined; actualId?: string | null | undefined; }; undeployedChanges?: boolean | undefined; state: "NOT_DEPLOYED" | "STARTING" | "RUNNING" | "SLEEPING" | "SUSPENDED"; }>`
13
+ - `api.apps.getApp(appId: 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"; }>`
14
14
  - `api.apps.getAppGitRepo(appId: string, signal?: AbortSignal | undefined): Promise<{ sshUrl: string | null; httpsUrl: string | null; isManagedGitRepo: boolean; }>`
15
15
  - `api.apps.getAppGitRepoCredential(appId: string, credentialId: string, signal?: AbortSignal | undefined): Promise<{ id: string; type: "ssh_key" | "http_token"; name: string; permissions: "readOnly" | "readWrite"; ownerAdminId: string; createdAt: string; }>`
16
16
  - `api.apps.getAppGitRepoCredentials(appId: string, signal?: AbortSignal | undefined): Promise<{ credentials: { id: string; type: "ssh_key" | "http_token"; name: string; permissions: "readOnly" | "readWrite"; ownerAdminId: string; createdAt: string; }[]; }>`
@@ -19,14 +19,14 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
19
19
  - `api.apps.getAppPassword(appId: string, signal?: AbortSignal | undefined): Promise<{ password?: string | null | undefined; }>`
20
20
  - `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; }>`
21
21
  - `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; }[]>`
22
- - `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; configVersion: string; type?: "streamlit" | "python-js" | null | undefined; mode?: "dev" | "prod" | undefined; url: string | null; production: { desiredNumber?: number | null | undefined; desiredId?: string | null | undefined; actualNumber?: number | null | undefined; actualId?: string | null | undefined; }; undeployedChanges?: boolean | undefined; state: "NOT_DEPLOYED" | "STARTING" | "RUNNING" | "SLEEPING" | "SUSPENDED"; }[]>`
23
- - `api.apps.getDeployment(appId: string, deploymentId: string, signal?: AbortSignal | undefined): Promise<{ id: string; number: number; configId: string; configVersion: string; gitCommitSha: string | null; size?: "small" | "external" | "micro" | "tiny" | "medium" | "large" | null | undefined; buildState: "PREBUILT" | "PENDING" | "BUILDING" | "BUILT" | "FAILED"; runState: "STARTING" | "RUNNING" | "PENDING" | "FAILED" | "NEVER_RUN" | "STOPPING" | "STOPPED"; archived: boolean; archivedAt: string | null; createdAt: string; }>`
22
+ - `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"; }[]>`
23
+ - `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: "failed" | "pending" | "building" | "ready"; runState: "failed" | "starting" | "running" | "stopping" | "stopped" | "pending" | "neverRun"; archived: boolean; archivedAt: string | null; createdAt: string; }>`
24
24
  - `api.apps.getDeploymentLogsDownload(appId: string, deploymentId: string, signal?: AbortSignal | undefined): Promise<{ logs: string; fileName: string; }>`
25
25
  - `api.apps.getDeploymentLogsTail(appId: string, deploymentId: string, { query, signal }?: LogsTailOptions): Promise<{ entries: LogEntry[]; nextLogTimestamp: string | null; }>`
26
- - `api.apps.getDeployments(appId: string, signal?: AbortSignal | undefined): Promise<{ id: string; number: number; configId: string; configVersion: string; gitCommitSha: string | null; size?: "small" | "external" | "micro" | "tiny" | "medium" | "large" | null | undefined; buildState: "PREBUILT" | "PENDING" | "BUILDING" | "BUILT" | "FAILED"; runState: "STARTING" | "RUNNING" | "PENDING" | "FAILED" | "NEVER_RUN" | "STOPPING" | "STOPPED"; archived: boolean; archivedAt: string | null; createdAt: string; }[]>`
26
+ - `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: "failed" | "pending" | "building" | "ready"; runState: "failed" | "starting" | "running" | "stopping" | "stopped" | "pending" | "neverRun"; archived: boolean; archivedAt: string | null; createdAt: string; }[]>`
27
27
  - `api.apps.healthCheck(signal?: AbortSignal | undefined): Promise<{ appName?: string | undefined; appVersion?: string | undefined; apiDocs?: string | undefined; }>`
28
- - `api.apps.promoteDeployment(appId: string, deploymentId: string, signal?: AbortSignal | undefined): Promise<{ id: string; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; type?: "streamlit" | "python-js" | null | undefined; mode?: "dev" | "prod" | undefined; url: string | null; production: { desiredNumber?: number | null | undefined; desiredId?: string | null | undefined; actualNumber?: number | null | undefined; actualId?: string | null | undefined; }; undeployedChanges?: boolean | undefined; state: "NOT_DEPLOYED" | "STARTING" | "RUNNING" | "SLEEPING" | "SUSPENDED"; } | null>`
29
- - `api.apps.resetAppPassword(appId: string, signal?: AbortSignal | undefined): Promise<{ id: string; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; type?: "streamlit" | "python-js" | null | undefined; mode?: "dev" | "prod" | undefined; url: string | null; production: { desiredNumber?: number | null | undefined; desiredId?: string | null | undefined; actualNumber?: number | null | undefined; actualId?: string | null | undefined; }; undeployedChanges?: boolean | undefined; state: "NOT_DEPLOYED" | "STARTING" | "RUNNING" | "SLEEPING" | "SUSPENDED"; }>`
30
- - `api.apps.resumeApp(appId: string, signal?: AbortSignal | undefined): Promise<{ id: string; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; type?: "streamlit" | "python-js" | null | undefined; mode?: "dev" | "prod" | undefined; url: string | null; production: { desiredNumber?: number | null | undefined; desiredId?: string | null | undefined; actualNumber?: number | null | undefined; actualId?: string | null | undefined; }; undeployedChanges?: boolean | undefined; state: "NOT_DEPLOYED" | "STARTING" | "RUNNING" | "SLEEPING" | "SUSPENDED"; } | null>`
31
- - `api.apps.suspendApp(appId: string, signal?: AbortSignal | undefined): Promise<{ id: string; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; type?: "streamlit" | "python-js" | null | undefined; mode?: "dev" | "prod" | undefined; url: string | null; production: { desiredNumber?: number | null | undefined; desiredId?: string | null | undefined; actualNumber?: number | null | undefined; actualId?: string | null | undefined; }; undeployedChanges?: boolean | undefined; state: "NOT_DEPLOYED" | "STARTING" | "RUNNING" | "SLEEPING" | "SUSPENDED"; } | null>`
32
- - `api.apps.unpublishApp(appId: string, signal?: AbortSignal | undefined): Promise<{ id: string; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; type?: "streamlit" | "python-js" | null | undefined; mode?: "dev" | "prod" | undefined; url: string | null; production: { desiredNumber?: number | null | undefined; desiredId?: string | null | undefined; actualNumber?: number | null | undefined; actualId?: string | null | undefined; }; undeployedChanges?: boolean | undefined; state: "NOT_DEPLOYED" | "STARTING" | "RUNNING" | "SLEEPING" | "SUSPENDED"; } | null>`
28
+ - `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"; }>`
29
+ - `api.apps.resetAppPassword(appId: string, signal?: AbortSignal | undefined): Promise<{ password: string; }>`
30
+ - `api.apps.resumeApp(appId: 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"; }>`
31
+ - `api.apps.suspendApp(appId: 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"; }>`
32
+ - `api.apps.unpublishApp(appId: 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"; }>`
@@ -4,6 +4,6 @@
4
4
 
5
5
  Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
6
6
 
7
- - `api.billing.getCredits(signal?: AbortSignal | undefined): Promise<{ consumed: number; remaining: number; stats?: { componentJobs?: { consumed?: number | undefined; } | undefined; workspaceJobs?: { workspaceType?: "writer" | "sandbox-sql" | "transformation" | "sandbox-data-science" | undefined; warehouseSize?: "small" | "medium" | "large" | "x-small" | "x-large" | "2x-large" | "3x-large" | "4x-large" | undefined; consumed?: number | undefined; } | undefined; marketplaceSubscription?: { vendor: "aws" | "azure"; state: "inactive" | "active" | "suspended" | "unsubscribed"; billingLink: string; } | undefined; } | undefined; }>`
8
- - `api.billing.getCreditsAndTopUp(signal?: AbortSignal | undefined): Promise<{ consumed: number; remaining: number; stats?: { componentJobs?: { consumed?: number | undefined; } | undefined; workspaceJobs?: { workspaceType?: "writer" | "sandbox-sql" | "transformation" | "sandbox-data-science" | undefined; warehouseSize?: "small" | "medium" | "large" | "x-small" | "x-large" | "2x-large" | "3x-large" | "4x-large" | undefined; consumed?: number | undefined; } | undefined; marketplaceSubscription?: { vendor: "aws" | "azure"; state: "inactive" | "active" | "suspended" | "unsubscribed"; billingLink: string; } | undefined; } | undefined; }>`
7
+ - `api.billing.getCredits(signal?: AbortSignal | undefined): Promise<{ consumed: number; remaining: number; stats?: { componentJobs?: { consumed?: number | undefined; } | undefined; workspaceJobs?: { workspaceType?: "writer" | "sandbox-sql" | "transformation" | "sandbox-data-science" | undefined; warehouseSize?: "small" | "medium" | "large" | "x-small" | "x-large" | "2x-large" | "3x-large" | "4x-large" | undefined; consumed?: number | undefined; } | undefined; marketplaceSubscription?: { vendor: "aws" | "azure"; state: "suspended" | "inactive" | "active" | "unsubscribed"; billingLink: string; } | undefined; } | undefined; }>`
8
+ - `api.billing.getCreditsAndTopUp(signal?: AbortSignal | undefined): Promise<{ consumed: number; remaining: number; stats?: { componentJobs?: { consumed?: number | undefined; } | undefined; workspaceJobs?: { workspaceType?: "writer" | "sandbox-sql" | "transformation" | "sandbox-data-science" | undefined; warehouseSize?: "small" | "medium" | "large" | "x-small" | "x-large" | "2x-large" | "3x-large" | "4x-large" | undefined; consumed?: number | undefined; } | undefined; marketplaceSubscription?: { vendor: "aws" | "azure"; state: "suspended" | "inactive" | "active" | "unsubscribed"; billingLink: string; } | undefined; } | undefined; }>`
9
9
  - `api.billing.healthCheck(signal?: AbortSignal | undefined): Promise<{ status?: string | undefined; }>`
package/surface/editor.md CHANGED
@@ -5,14 +5,14 @@
5
5
  Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
6
6
 
7
7
  - `api.editor.createQueryJob({ id }: { id: string; }, body: { queries: string[]; }): Promise<{ queryJobId: string; url: string; }>`
8
- - `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?: "snowflake" | "bigquery" | 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; }>`
9
- - `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?: "snowflake" | "bigquery" | 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; }>`
8
+ - `api.editor.createSession(body: { branchId: string; componentId: string | null; configurationId: string | null; }): Promise<{ id: string; createdAt: string; updatedAt: string; status: "failed" | "deleted" | "ready" | "initializing" | "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?: "snowflake" | "bigquery" | 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; }>`
9
+ - `api.editor.getSession({ id }: { id: string; }, signal?: AbortSignal | undefined): Promise<{ id: string; createdAt: string; updatedAt: string; status: "failed" | "deleted" | "ready" | "initializing" | "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?: "snowflake" | "bigquery" | 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; }>`
10
10
  - `api.editor.getSessionCredentials(id: string, signal?: AbortSignal | undefined): Promise<{ [key: string]: unknown; }>`
11
11
  - `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; }[]; }[]; }[]; }>`
12
- - `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?: "snowflake" | "bigquery" | 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; }[]>`
12
+ - `api.editor.getSessions(query: { listAll?: "0" | "1" | undefined; branchId?: string | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; createdAt: string; updatedAt: string; status: "failed" | "deleted" | "ready" | "initializing" | "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?: "snowflake" | "bigquery" | 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; }[]>`
13
13
  - `api.editor.healthCheck(signal?: AbortSignal | undefined): Promise<{ status: "ok"; }>`
14
- - `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?: "snowflake" | "bigquery" | 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; }>`
14
+ - `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" | "ready" | "initializing" | "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?: "snowflake" | "bigquery" | 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; }>`
15
15
  - `api.editor.resetWorkspacePassword(id: string): Promise<{ username: string; password: string; host: string; database: string; schema: string; warehouse: string; }>`
16
16
  - `api.editor.tableDefinition({ id, ...query }: { id: string; } & { tableName: string; schemaName: string; databaseName?: string | null | undefined; }, signal?: AbortSignal | undefined): Promise<{ ddl: string; }>`
17
17
  - `api.editor.tablePreview({ id }: { id: string; }, body: { tableName: string; databaseName?: string | null | undefined; schemaName?: string | null | undefined; }): Promise<{ queryJobId: string; url: string; }>`
18
- - `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?: "snowflake" | "bigquery" | 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; }>`
18
+ - `api.editor.unload({ id }: { id: string; }, body?: { tableId?: string | null | undefined; } | undefined): Promise<{ id: string; createdAt: string; updatedAt: string; status: "failed" | "deleted" | "ready" | "initializing" | "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?: "snowflake" | "bigquery" | 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; }>`