@athenaintel/sdk 4.3.2243 → 4.3.2245

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 (62) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/assets/client/Client.d.ts +1 -1
  3. package/dist/cjs/api/resources/assets/client/Client.js +1 -1
  4. package/dist/cjs/api/resources/assets/client/requests/CreateAssetRequestIn.d.ts +2 -0
  5. package/dist/cjs/api/resources/computer/client/Client.d.ts +30 -2
  6. package/dist/cjs/api/resources/computer/client/Client.js +100 -2
  7. package/dist/cjs/api/resources/computer/client/requests/GetStatusComputerRequest.d.ts +9 -0
  8. package/dist/cjs/api/resources/computer/client/requests/GetStatusComputerRequest.js +3 -0
  9. package/dist/cjs/api/resources/computer/client/requests/index.d.ts +1 -0
  10. package/dist/cjs/api/resources/databases/client/Client.d.ts +77 -4
  11. package/dist/cjs/api/resources/databases/client/Client.js +296 -4
  12. package/dist/cjs/api/resources/databases/client/requests/DatabaseComputeSettingsUpdateRequestIn.d.ts +12 -0
  13. package/dist/cjs/api/resources/databases/client/requests/DatabaseComputeSettingsUpdateRequestIn.js +3 -0
  14. package/dist/cjs/api/resources/databases/client/requests/GetSettingsDatabasesRequest.d.ts +9 -0
  15. package/dist/cjs/api/resources/databases/client/requests/GetSettingsDatabasesRequest.js +3 -0
  16. package/dist/cjs/api/resources/databases/client/requests/WakeDatabasesRequest.d.ts +9 -0
  17. package/dist/cjs/api/resources/databases/client/requests/WakeDatabasesRequest.js +3 -0
  18. package/dist/cjs/api/resources/databases/client/requests/index.d.ts +3 -0
  19. package/dist/cjs/api/resources/tools/resources/sheets/client/requests/UpdateSheetCellRequest.d.ts +3 -0
  20. package/dist/cjs/api/types/ComputerStatusResponseOut.d.ts +33 -0
  21. package/dist/cjs/api/types/ComputerStatusResponseOut.js +19 -0
  22. package/dist/cjs/api/types/DatabaseComputeSettingsResponseOut.d.ts +9 -0
  23. package/dist/cjs/api/types/DatabaseComputeSettingsResponseOut.js +3 -0
  24. package/dist/cjs/api/types/DatabaseStatusResponse.d.ts +2 -0
  25. package/dist/cjs/api/types/DatabaseWakeResponseOut.d.ts +19 -0
  26. package/dist/cjs/api/types/DatabaseWakeResponseOut.js +12 -0
  27. package/dist/cjs/api/types/index.d.ts +3 -0
  28. package/dist/cjs/api/types/index.js +3 -0
  29. package/dist/cjs/version.d.ts +1 -1
  30. package/dist/cjs/version.js +1 -1
  31. package/dist/esm/BaseClient.mjs +2 -2
  32. package/dist/esm/api/resources/assets/client/Client.d.mts +1 -1
  33. package/dist/esm/api/resources/assets/client/Client.mjs +1 -1
  34. package/dist/esm/api/resources/assets/client/requests/CreateAssetRequestIn.d.mts +2 -0
  35. package/dist/esm/api/resources/computer/client/Client.d.mts +30 -2
  36. package/dist/esm/api/resources/computer/client/Client.mjs +100 -2
  37. package/dist/esm/api/resources/computer/client/requests/GetStatusComputerRequest.d.mts +9 -0
  38. package/dist/esm/api/resources/computer/client/requests/GetStatusComputerRequest.mjs +2 -0
  39. package/dist/esm/api/resources/computer/client/requests/index.d.mts +1 -0
  40. package/dist/esm/api/resources/databases/client/Client.d.mts +77 -4
  41. package/dist/esm/api/resources/databases/client/Client.mjs +296 -4
  42. package/dist/esm/api/resources/databases/client/requests/DatabaseComputeSettingsUpdateRequestIn.d.mts +12 -0
  43. package/dist/esm/api/resources/databases/client/requests/DatabaseComputeSettingsUpdateRequestIn.mjs +2 -0
  44. package/dist/esm/api/resources/databases/client/requests/GetSettingsDatabasesRequest.d.mts +9 -0
  45. package/dist/esm/api/resources/databases/client/requests/GetSettingsDatabasesRequest.mjs +2 -0
  46. package/dist/esm/api/resources/databases/client/requests/WakeDatabasesRequest.d.mts +9 -0
  47. package/dist/esm/api/resources/databases/client/requests/WakeDatabasesRequest.mjs +2 -0
  48. package/dist/esm/api/resources/databases/client/requests/index.d.mts +3 -0
  49. package/dist/esm/api/resources/tools/resources/sheets/client/requests/UpdateSheetCellRequest.d.mts +3 -0
  50. package/dist/esm/api/types/ComputerStatusResponseOut.d.mts +33 -0
  51. package/dist/esm/api/types/ComputerStatusResponseOut.mjs +16 -0
  52. package/dist/esm/api/types/DatabaseComputeSettingsResponseOut.d.mts +9 -0
  53. package/dist/esm/api/types/DatabaseComputeSettingsResponseOut.mjs +2 -0
  54. package/dist/esm/api/types/DatabaseStatusResponse.d.mts +2 -0
  55. package/dist/esm/api/types/DatabaseWakeResponseOut.d.mts +19 -0
  56. package/dist/esm/api/types/DatabaseWakeResponseOut.mjs +9 -0
  57. package/dist/esm/api/types/index.d.mts +3 -0
  58. package/dist/esm/api/types/index.mjs +3 -0
  59. package/dist/esm/version.d.mts +1 -1
  60. package/dist/esm/version.mjs +1 -1
  61. package/package.json +1 -1
  62. package/reference.md +285 -7
@@ -0,0 +1,12 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * asset_id: "asset_id",
5
+ * suspend_timeout_seconds: 3600
6
+ * }
7
+ */
8
+ export interface DatabaseComputeSettingsUpdateRequestIn {
9
+ asset_id: string;
10
+ /** Seconds without activity after which the database suspends (scales to zero). 0 means it never suspends: the compute keeps running, and keeps using capacity, until you change this. Otherwise 60 to 86400 (24 hours). A new database starts with 1800 (30 minutes). The same setting as auto-suspend in the database's Settings in Athena. */
11
+ suspend_timeout_seconds: number;
12
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * asset_id: "asset_id"
5
+ * }
6
+ */
7
+ export interface GetSettingsDatabasesRequest {
8
+ asset_id: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * asset_id: "asset_id"
5
+ * }
6
+ */
7
+ export interface WakeDatabasesRequest {
8
+ asset_id: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1,8 +1,11 @@
1
+ export type { DatabaseComputeSettingsUpdateRequestIn } from "./DatabaseComputeSettingsUpdateRequestIn.mjs";
1
2
  export type { DatabaseSqlRequest } from "./DatabaseSqlRequest.mjs";
2
3
  export type { DeleteDatabasesRequest } from "./DeleteDatabasesRequest.mjs";
4
+ export type { GetSettingsDatabasesRequest } from "./GetSettingsDatabasesRequest.mjs";
3
5
  export type { GetStatusDatabasesRequest } from "./GetStatusDatabasesRequest.mjs";
4
6
  export type { GetTableSchemaDatabasesRequest } from "./GetTableSchemaDatabasesRequest.mjs";
5
7
  export type { InsertDataRequest } from "./InsertDataRequest.mjs";
6
8
  export type { ListTablesDatabasesRequest } from "./ListTablesDatabasesRequest.mjs";
7
9
  export type { SelectDatabasesRequest } from "./SelectDatabasesRequest.mjs";
8
10
  export type { UpdateDataRequest } from "./UpdateDataRequest.mjs";
11
+ export type { WakeDatabasesRequest } from "./WakeDatabasesRequest.mjs";
@@ -1,3 +1,4 @@
1
+ import type * as AthenaIntelligence from "../../../../../../index.mjs";
1
2
  /**
2
3
  * @example
3
4
  * {
@@ -12,6 +13,8 @@ export interface UpdateSheetCellRequest {
12
13
  asset_id: string;
13
14
  /** 1-based column index (e.g., 1 = column A) */
14
15
  column: number;
16
+ /** Optional cell format (textFormat, backgroundColor, numberFormat, alignment, borders) applied in the same write as the value, like `formatting` on range/update. */
17
+ formatting?: AthenaIntelligence.CellFormat | null;
15
18
  /** 1-based row index (e.g., 1 = first row) */
16
19
  row: number;
17
20
  /** Sheet ID (defaults to 1) */
@@ -0,0 +1,33 @@
1
+ /**
2
+ * A computer's live runtime state, read without starting or waking it.
3
+ */
4
+ export interface ComputerStatusResponseOut {
5
+ /** The computer asset id. */
6
+ asset_id: string;
7
+ /** Set when someone stopped the computer with Stop. While it is `stopping`, `stopped` or `uncertain`, implicit wakes are refused: minting SSH access answers 409 and an SSH connection does not start it. Call `start_computer` to clear it. `null` or `cleared` means no explicit stop is in force. */
8
+ explicit_stop?: ComputerStatusResponseOut.ExplicitStop | null;
9
+ /** Why `ready` is false; `null` when it is true. `not_started`: the computer is not running — call `start_computer`. `starting`: it is running and its guest is still coming up — keep polling. `unobservable`: readiness could not be read this time — keep polling. `launcher_outdated`: the computer runs an outdated runtime component that polling will not change — stop it and start it again to update it. */
10
+ not_ready_reason?: ComputerStatusResponseOut.NotReadyReason | null;
11
+ /** The computer's runtime provider (e.g. `talos_v2`). */
12
+ provider?: string | null;
13
+ /** Whether the computer serves work now: `state` is `started` and the guest answers ready (its workspace attached and its environment applied). Only then do commands, SSH sessions and deployed URLs reach the computer without first waiting for a start. `started` alone can come a few seconds before `ready`. */
14
+ ready: boolean;
15
+ /** The runtime's current state: `started` (running; check `ready`), `stopped` (suspended — by idle auto-stop or by Stop; files are kept), `restoring` (a start is in progress), `error` (the runtime failed; start or restart it), or `unknown` (the state could not be read this time; retry). `started`, `stopped` and `error` hold until something changes them; `restoring` and `unknown` are transient. */
16
+ state: string;
17
+ }
18
+ export declare namespace ComputerStatusResponseOut {
19
+ const ExplicitStop: {
20
+ readonly Stopping: "stopping";
21
+ readonly Stopped: "stopped";
22
+ readonly Uncertain: "uncertain";
23
+ readonly Cleared: "cleared";
24
+ };
25
+ type ExplicitStop = (typeof ExplicitStop)[keyof typeof ExplicitStop];
26
+ const NotReadyReason: {
27
+ readonly NotStarted: "not_started";
28
+ readonly Starting: "starting";
29
+ readonly LauncherOutdated: "launcher_outdated";
30
+ readonly Unobservable: "unobservable";
31
+ };
32
+ type NotReadyReason = (typeof NotReadyReason)[keyof typeof NotReadyReason];
33
+ }
@@ -0,0 +1,16 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var ComputerStatusResponseOut;
3
+ (function (ComputerStatusResponseOut) {
4
+ ComputerStatusResponseOut.ExplicitStop = {
5
+ Stopping: "stopping",
6
+ Stopped: "stopped",
7
+ Uncertain: "uncertain",
8
+ Cleared: "cleared",
9
+ };
10
+ ComputerStatusResponseOut.NotReadyReason = {
11
+ NotStarted: "not_started",
12
+ Starting: "starting",
13
+ LauncherOutdated: "launcher_outdated",
14
+ Unobservable: "unobservable",
15
+ };
16
+ })(ComputerStatusResponseOut || (ComputerStatusResponseOut = {}));
@@ -0,0 +1,9 @@
1
+ /**
2
+ * The database's compute settings that the public API can read and set.
3
+ */
4
+ export interface DatabaseComputeSettingsResponseOut {
5
+ /** The database asset ID */
6
+ asset_id: string;
7
+ /** Seconds without activity after which the database suspends (scales to zero). 0 means it never suspends: the compute keeps running, and keeps using capacity, until you change this. Otherwise 60 to 86400 (24 hours). A new database starts with 1800 (30 minutes). The same setting as auto-suspend in the database's Settings in Athena. */
8
+ suspend_timeout_seconds: number;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -11,6 +11,8 @@ export interface DatabaseStatusResponse {
11
11
  message?: string | null;
12
12
  /** Database provider ('kronos') */
13
13
  provider: string;
14
+ /** Why the compute is in this state, when the control plane says: `ComputeUnschedulable` on a `suspended` database means no node could host its compute size, so a wake only restarts the same wait; choose a smaller compute size in the database's Settings in Athena first. Absent on older control planes. */
15
+ reason?: string | null;
14
16
  /** Standardized database status */
15
17
  status: DatabaseStatusResponse.Status;
16
18
  }
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Response for a wake request.
3
+ */
4
+ export interface DatabaseWakeResponseOut {
5
+ /** The database asset ID */
6
+ asset_id: string;
7
+ /** Optional detail from the control plane */
8
+ message?: string | null;
9
+ /** `running`: the compute was already running; its idle clock was reset. `starting`: the compute is starting; poll `GET /databases/{asset_id}/compute-status` until it reports `running`. */
10
+ status: DatabaseWakeResponseOut.Status;
11
+ }
12
+ export declare namespace DatabaseWakeResponseOut {
13
+ /** `running`: the compute was already running; its idle clock was reset. `starting`: the compute is starting; poll `GET /databases/{asset_id}/compute-status` until it reports `running`. */
14
+ const Status: {
15
+ readonly Running: "running";
16
+ readonly Starting: "starting";
17
+ };
18
+ type Status = (typeof Status)[keyof typeof Status];
19
+ }
@@ -0,0 +1,9 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var DatabaseWakeResponseOut;
3
+ (function (DatabaseWakeResponseOut) {
4
+ /** `running`: the compute was already running; its idle clock was reset. `starting`: the compute is starting; poll `GET /databases/{asset_id}/compute-status` until it reports `running`. */
5
+ DatabaseWakeResponseOut.Status = {
6
+ Running: "running",
7
+ Starting: "starting",
8
+ };
9
+ })(DatabaseWakeResponseOut || (DatabaseWakeResponseOut = {}));
@@ -41,6 +41,7 @@ export * from "./CollabAgentSendMessageResponseOut.mjs";
41
41
  export * from "./CollabTokenResponse.mjs";
42
42
  export * from "./ComputerInitializationResponse.mjs";
43
43
  export * from "./ComputerLifecycleResponseOut.mjs";
44
+ export * from "./ComputerStatusResponseOut.mjs";
44
45
  export * from "./ConversationAssetInfo.mjs";
45
46
  export * from "./ConversationMessage.mjs";
46
47
  export * from "./ConversationResult.mjs";
@@ -51,6 +52,7 @@ export * from "./CreateAssetResponseOut.mjs";
51
52
  export * from "./CreateNewSheetTabResponse.mjs";
52
53
  export * from "./CreateProjectResponseOut.mjs";
53
54
  export * from "./DatabaseColumnInfo.mjs";
55
+ export * from "./DatabaseComputeSettingsResponseOut.mjs";
54
56
  export * from "./DatabaseDataResponse.mjs";
55
57
  export * from "./DatabaseMutationResponse.mjs";
56
58
  export * from "./DatabaseSqlResponse.mjs";
@@ -58,6 +60,7 @@ export * from "./DatabaseStatusResponse.mjs";
58
60
  export * from "./DatabaseTableInfo.mjs";
59
61
  export * from "./DatabaseTableSchemaResponse.mjs";
60
62
  export * from "./DatabaseTablesResponse.mjs";
63
+ export * from "./DatabaseWakeResponseOut.mjs";
61
64
  export * from "./DataFrameRequestOut.mjs";
62
65
  export * from "./DataFrameUnknownFormatError.mjs";
63
66
  export * from "./DefaultVisibility.mjs";
@@ -41,6 +41,7 @@ export * from "./CollabAgentSendMessageResponseOut.mjs";
41
41
  export * from "./CollabTokenResponse.mjs";
42
42
  export * from "./ComputerInitializationResponse.mjs";
43
43
  export * from "./ComputerLifecycleResponseOut.mjs";
44
+ export * from "./ComputerStatusResponseOut.mjs";
44
45
  export * from "./ConversationAssetInfo.mjs";
45
46
  export * from "./ConversationMessage.mjs";
46
47
  export * from "./ConversationResult.mjs";
@@ -51,6 +52,7 @@ export * from "./CreateAssetResponseOut.mjs";
51
52
  export * from "./CreateNewSheetTabResponse.mjs";
52
53
  export * from "./CreateProjectResponseOut.mjs";
53
54
  export * from "./DatabaseColumnInfo.mjs";
55
+ export * from "./DatabaseComputeSettingsResponseOut.mjs";
54
56
  export * from "./DatabaseDataResponse.mjs";
55
57
  export * from "./DatabaseMutationResponse.mjs";
56
58
  export * from "./DatabaseSqlResponse.mjs";
@@ -58,6 +60,7 @@ export * from "./DatabaseStatusResponse.mjs";
58
60
  export * from "./DatabaseTableInfo.mjs";
59
61
  export * from "./DatabaseTableSchemaResponse.mjs";
60
62
  export * from "./DatabaseTablesResponse.mjs";
63
+ export * from "./DatabaseWakeResponseOut.mjs";
61
64
  export * from "./DataFrameRequestOut.mjs";
62
65
  export * from "./DataFrameUnknownFormatError.mjs";
63
66
  export * from "./DefaultVisibility.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.3.2243";
1
+ export declare const SDK_VERSION = "4.3.2245";
@@ -1 +1 @@
1
- export const SDK_VERSION = "4.3.2243";
1
+ export const SDK_VERSION = "4.3.2245";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@athenaintel/sdk",
3
- "version": "4.3.2243",
3
+ "version": "4.3.2245",
4
4
  "private": false,
5
5
  "repository": "github:Athena-Intel/athena-typescript",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -648,7 +648,7 @@ await client.assets.convertExcelToSheet({
648
648
  <dl>
649
649
  <dd>
650
650
 
651
- Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied.
651
+ Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended.
652
652
  </dd>
653
653
  </dl>
654
654
  </dd>
@@ -1991,7 +1991,7 @@ await client.computer.getSshAccess({
1991
1991
  <dl>
1992
1992
  <dd>
1993
1993
 
1994
- Generate a time-limited SSH access token for a computer asset. Returns a full SSH command and token that can be used to connect to the computer's underlying VM and run commands. The computer must support SSH access and be in a running state.
1994
+ Generate a time-limited SSH access token for a computer asset. Returns a full SSH command and token that can be used to connect to the computer's underlying VM and run commands. The computer must support SSH access. If it is stopped, this call starts it first and can take as long as `start_computer`; after an explicit Stop it returns 409 until you call `start_computer`. Use `get_status` to see whether the computer is ready.
1995
1995
  </dd>
1996
1996
  </dl>
1997
1997
  </dd>
@@ -2254,7 +2254,7 @@ await client.computer.revokeSshAccessToken({
2254
2254
  <dl>
2255
2255
  <dd>
2256
2256
 
2257
- Start a stopped computer's runtime and wait for it to come up — the same operation as the Start button in Athena. Idempotent for a running computer. Returns 409 when the computer's provider does not support lifecycle operations.
2257
+ Start a stopped computer's runtime and wait for it to come up — the same operation as the Start button in Athena. Idempotent for a running computer, and it clears an explicit stop. `state` is `started` once the runtime is up; the guest can need a few more seconds, so poll `get_status` until `ready` is true before you rely on commands or SSH. A proxy in front of the API can end this request after about 60 seconds while the start continues on the server; then poll `get_status`. Returns 409 when the computer's provider does not support lifecycle operations.
2258
2258
  </dd>
2259
2259
  </dl>
2260
2260
  </dd>
@@ -2303,6 +2303,79 @@ await client.computer.startComputer({
2303
2303
  </dl>
2304
2304
 
2305
2305
 
2306
+ </dd>
2307
+ </dl>
2308
+ </details>
2309
+
2310
+ <details><summary><code>client.computer.<a href="/src/api/resources/computer/client/Client.ts">getStatus</a>({ ...params }) -> AthenaIntelligence.ComputerStatusResponseOut</code></summary>
2311
+ <dl>
2312
+ <dd>
2313
+
2314
+ #### 📝 Description
2315
+
2316
+ <dl>
2317
+ <dd>
2318
+
2319
+ <dl>
2320
+ <dd>
2321
+
2322
+ Read an existing computer's live runtime state and whether it is ready, without starting, waking, or repairing it. Works for every computer, including those created before durable initialization (`get_initialization` reports creation-time progress only). Requires membership in the computer's workspace and VIEW access. This read does not count as activity, so polling it does not keep the computer awake.
2323
+
2324
+ **Waiting for a computer.** Call `start_computer`, then poll this endpoint every few seconds until `ready` is true; stop polling when `not_ready_reason` is `launcher_outdated`. `start_computer` waits for the computer, but a proxy in front of the API can end a long request (about 60 seconds on Athena's ingress) while the start continues on the server. The server waits up to 210 seconds by default for the computer's runtime to boot before it reports a failure, and Athena alerts its operators when the 90th percentile of starts goes above 3 minutes.
2325
+
2326
+ **Auto-stop.** A computer stops after its `auto_stop_minutes` of inactivity (60 minutes unless the computer or the deployment sets another value; 0 means it never stops on its own). Activity is work inside the computer — commands, terminal and SSH sessions, file operations — and requests to its deployed URLs. Status reads are not activity.
2327
+
2328
+ **The asset record's `status`.** The computer's `status` in `GET /assets/{asset_id}` records the last lifecycle change Athena recorded (create, Start, Stop); it is not a live read. It can read `running` while the computer is stopped, for example after an idle auto-stop, or `stopped` after something woke it. Use this endpoint for the live state.
2329
+
2330
+ Returns 403 when the caller is not a member of the computer's workspace, 409 while the computer is still being created or when its creation failed, 404 when the asset does not exist or its runtime is gone for good (stop polling), and 502 when the runtime could not be read (retry).
2331
+ </dd>
2332
+ </dl>
2333
+ </dd>
2334
+ </dl>
2335
+
2336
+ #### 🔌 Usage
2337
+
2338
+ <dl>
2339
+ <dd>
2340
+
2341
+ <dl>
2342
+ <dd>
2343
+
2344
+ ```typescript
2345
+ await client.computer.getStatus({
2346
+ asset_id: "asset_id"
2347
+ });
2348
+
2349
+ ```
2350
+ </dd>
2351
+ </dl>
2352
+ </dd>
2353
+ </dl>
2354
+
2355
+ #### ⚙️ Parameters
2356
+
2357
+ <dl>
2358
+ <dd>
2359
+
2360
+ <dl>
2361
+ <dd>
2362
+
2363
+ **request:** `AthenaIntelligence.GetStatusComputerRequest`
2364
+
2365
+ </dd>
2366
+ </dl>
2367
+
2368
+ <dl>
2369
+ <dd>
2370
+
2371
+ **requestOptions:** `ComputerClient.RequestOptions`
2372
+
2373
+ </dd>
2374
+ </dl>
2375
+ </dd>
2376
+ </dl>
2377
+
2378
+
2306
2379
  </dd>
2307
2380
  </dl>
2308
2381
  </details>
@@ -2389,10 +2462,13 @@ Check if a database is running, suspended, or starting up. Poll this endpoint to
2389
2462
 
2390
2463
  **Status Values:**
2391
2464
  - `running` - Database is active and accepting connections
2392
- - `suspended` - Database is suspended (scale-to-zero), will auto-resume on first query
2393
- - `starting` - Database is waking up
2394
- - `failed` - Database failed to start
2395
- - `unknown` - Status could not be determined
2465
+ - `suspended` - Database is suspended (scale-to-zero). It wakes on `POST /databases/{asset_id}/wake` or on the first SQL request. When `reason` is `ComputeUnschedulable`, no node could host its compute size: waking it only restarts the same wait
2466
+ - `starting` - Database is waking up, or its compute is being recreated
2467
+ - `creating` - Database is being created; it has no compute yet
2468
+ - `failed` - Database failed to start, or its creation failed (`message` says which)
2469
+ - `unknown` - Status could not be determined (the control plane did not answer); retry
2470
+
2471
+ A database suspends (scales to zero) after `suspend_timeout_seconds` without activity; `GET`/`PATCH /databases/{asset_id}/settings` read and set that window, and 0 keeps it running. Reading the compute status or the settings never wakes a suspended database. Two things do: `POST /databases/{asset_id}/wake`, which answers at once while the compute starts, or any request that runs SQL on it, such as `POST /databases/{asset_id}/sql`, which waits for the compute up to 120 seconds; if the compute is still starting then, the answer is 503 with `Retry-After` and the statement did not run. A cold start usually takes 30 seconds to 2 minutes.
2396
2472
  </dd>
2397
2473
  </dl>
2398
2474
  </dd>
@@ -2889,6 +2965,141 @@ await client.databases.getTableSchema({
2889
2965
  </dl>
2890
2966
 
2891
2967
 
2968
+ </dd>
2969
+ </dl>
2970
+ </details>
2971
+
2972
+ <details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">getSettings</a>({ ...params }) -> AthenaIntelligence.DatabaseComputeSettingsResponseOut</code></summary>
2973
+ <dl>
2974
+ <dd>
2975
+
2976
+ #### 📝 Description
2977
+
2978
+ <dl>
2979
+ <dd>
2980
+
2981
+ <dl>
2982
+ <dd>
2983
+
2984
+ Read the database's auto-suspend window, the same setting as auto-suspend in the database's Settings in Athena. Reading never wakes the database.
2985
+
2986
+ A database suspends (scales to zero) after `suspend_timeout_seconds` without activity; `GET`/`PATCH /databases/{asset_id}/settings` read and set that window, and 0 keeps it running. Reading the compute status or the settings never wakes a suspended database. Two things do: `POST /databases/{asset_id}/wake`, which answers at once while the compute starts, or any request that runs SQL on it, such as `POST /databases/{asset_id}/sql`, which waits for the compute up to 120 seconds; if the compute is still starting then, the answer is 503 with `Retry-After` and the statement did not run. A cold start usually takes 30 seconds to 2 minutes.
2987
+ </dd>
2988
+ </dl>
2989
+ </dd>
2990
+ </dl>
2991
+
2992
+ #### 🔌 Usage
2993
+
2994
+ <dl>
2995
+ <dd>
2996
+
2997
+ <dl>
2998
+ <dd>
2999
+
3000
+ ```typescript
3001
+ await client.databases.getSettings({
3002
+ asset_id: "asset_id"
3003
+ });
3004
+
3005
+ ```
3006
+ </dd>
3007
+ </dl>
3008
+ </dd>
3009
+ </dl>
3010
+
3011
+ #### ⚙️ Parameters
3012
+
3013
+ <dl>
3014
+ <dd>
3015
+
3016
+ <dl>
3017
+ <dd>
3018
+
3019
+ **request:** `AthenaIntelligence.GetSettingsDatabasesRequest`
3020
+
3021
+ </dd>
3022
+ </dl>
3023
+
3024
+ <dl>
3025
+ <dd>
3026
+
3027
+ **requestOptions:** `DatabasesClient.RequestOptions`
3028
+
3029
+ </dd>
3030
+ </dl>
3031
+ </dd>
3032
+ </dl>
3033
+
3034
+
3035
+ </dd>
3036
+ </dl>
3037
+ </details>
3038
+
3039
+ <details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">updateSettings</a>({ ...params }) -> AthenaIntelligence.DatabaseComputeSettingsResponseOut</code></summary>
3040
+ <dl>
3041
+ <dd>
3042
+
3043
+ #### 📝 Description
3044
+
3045
+ <dl>
3046
+ <dd>
3047
+
3048
+ <dl>
3049
+ <dd>
3050
+
3051
+ Set the database's auto-suspend window: 0 keeps the database running (it never suspends, and keeps using compute capacity), otherwise 60 to 86400 seconds. The same setting, values and edit-access rule as auto-suspend in the database's Settings in Athena; the change applies at once and does not restart or wake the database.
3052
+
3053
+ A database suspends (scales to zero) after `suspend_timeout_seconds` without activity; `GET`/`PATCH /databases/{asset_id}/settings` read and set that window, and 0 keeps it running. Reading the compute status or the settings never wakes a suspended database. Two things do: `POST /databases/{asset_id}/wake`, which answers at once while the compute starts, or any request that runs SQL on it, such as `POST /databases/{asset_id}/sql`, which waits for the compute up to 120 seconds; if the compute is still starting then, the answer is 503 with `Retry-After` and the statement did not run. A cold start usually takes 30 seconds to 2 minutes.
3054
+ </dd>
3055
+ </dl>
3056
+ </dd>
3057
+ </dl>
3058
+
3059
+ #### 🔌 Usage
3060
+
3061
+ <dl>
3062
+ <dd>
3063
+
3064
+ <dl>
3065
+ <dd>
3066
+
3067
+ ```typescript
3068
+ await client.databases.updateSettings({
3069
+ asset_id: "asset_id",
3070
+ suspend_timeout_seconds: 3600
3071
+ });
3072
+
3073
+ ```
3074
+ </dd>
3075
+ </dl>
3076
+ </dd>
3077
+ </dl>
3078
+
3079
+ #### ⚙️ Parameters
3080
+
3081
+ <dl>
3082
+ <dd>
3083
+
3084
+ <dl>
3085
+ <dd>
3086
+
3087
+ **request:** `AthenaIntelligence.DatabaseComputeSettingsUpdateRequestIn`
3088
+
3089
+ </dd>
3090
+ </dl>
3091
+
3092
+ <dl>
3093
+ <dd>
3094
+
3095
+ **requestOptions:** `DatabasesClient.RequestOptions`
3096
+
3097
+ </dd>
3098
+ </dl>
3099
+ </dd>
3100
+ </dl>
3101
+
3102
+
2892
3103
  </dd>
2893
3104
  </dl>
2894
3105
  </details>
@@ -2955,6 +3166,73 @@ await client.databases.executeSql({
2955
3166
  </dl>
2956
3167
 
2957
3168
 
3169
+ </dd>
3170
+ </dl>
3171
+ </details>
3172
+
3173
+ <details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">wake</a>({ ...params }) -> AthenaIntelligence.DatabaseWakeResponseOut</code></summary>
3174
+ <dl>
3175
+ <dd>
3176
+
3177
+ #### 📝 Description
3178
+
3179
+ <dl>
3180
+ <dd>
3181
+
3182
+ <dl>
3183
+ <dd>
3184
+
3185
+ Start a suspended database's compute and answer at once, without waiting for it to run. Poll `GET /databases/{asset_id}/compute-status` until it reports `running`. Waking a running database resets its idle clock and answers 200 with `running`, so it is safe to call before every batch of work. The same action as Resume Database in Athena; it needs edit access to the database.
3186
+
3187
+ A database suspends (scales to zero) after `suspend_timeout_seconds` without activity; `GET`/`PATCH /databases/{asset_id}/settings` read and set that window, and 0 keeps it running. Reading the compute status or the settings never wakes a suspended database. Two things do: `POST /databases/{asset_id}/wake`, which answers at once while the compute starts, or any request that runs SQL on it, such as `POST /databases/{asset_id}/sql`, which waits for the compute up to 120 seconds; if the compute is still starting then, the answer is 503 with `Retry-After` and the statement did not run. A cold start usually takes 30 seconds to 2 minutes.
3188
+ </dd>
3189
+ </dl>
3190
+ </dd>
3191
+ </dl>
3192
+
3193
+ #### 🔌 Usage
3194
+
3195
+ <dl>
3196
+ <dd>
3197
+
3198
+ <dl>
3199
+ <dd>
3200
+
3201
+ ```typescript
3202
+ await client.databases.wake({
3203
+ asset_id: "asset_id"
3204
+ });
3205
+
3206
+ ```
3207
+ </dd>
3208
+ </dl>
3209
+ </dd>
3210
+ </dl>
3211
+
3212
+ #### ⚙️ Parameters
3213
+
3214
+ <dl>
3215
+ <dd>
3216
+
3217
+ <dl>
3218
+ <dd>
3219
+
3220
+ **request:** `AthenaIntelligence.WakeDatabasesRequest`
3221
+
3222
+ </dd>
3223
+ </dl>
3224
+
3225
+ <dl>
3226
+ <dd>
3227
+
3228
+ **requestOptions:** `DatabasesClient.RequestOptions`
3229
+
3230
+ </dd>
3231
+ </dl>
3232
+ </dd>
3233
+ </dl>
3234
+
3235
+
2958
3236
  </dd>
2959
3237
  </dl>
2960
3238
  </details>