@athenaintel/sdk 4.3.2244 → 4.3.2246

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@athenaintel/sdk",
-        "X-Fern-SDK-Version": "4.3.2244",
-        "User-Agent": "@athenaintel/sdk/4.3.2244",
+        "X-Fern-SDK-Version": "4.3.2246",
+        "User-Agent": "@athenaintel/sdk/4.3.2246",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "X-Athena-Session-Credential": options === null || options === void 0 ? void 0 : options.sessionCredential,

package/dist/cjs/api/resources/assets/client/Client.d.ts

@@ -50,7 +50,7 @@ export declare class AssetsClient {
     convertExcelToSheet(request: AthenaIntelligence.ConvertExcelToSheetRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.ConvertExcelToSheetResponseOut>;
     private __convertExcelToSheet;
     /**
-     * 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.
+     * 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.
      *
      * @param {AthenaIntelligence.CreateAssetRequestIn} request
      * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -157,6 +157,24 @@ export declare class AssetsClient {
      */
     rename(request: AthenaIntelligence.RenameAssetRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.RenameAssetResponseOut>;
     private __rename;
+    /**
+     * Read the access that you, or another user, have on an asset, and every grant that gives it. The level is what Athena's permission checks decide for the user in the asset's own workspace, whichever workspace is active for your key: 'view' can open the asset, 'edit' can also change it and manage its sharing, 'owner' created it and can edit it, and 'none' cannot open it. Each source names one grant: 'owner', 'direct' (shared with the user), 'group' (shared with a workspace group the user belongs to), 'workspace' (shared with the whole workspace), 'drive' (a role on the drive) or 'other' (access the share list does not hold, for example an environment admin). A folder's sharing reaches each asset inside it as that asset's own share, so a 'workspace' source on a sub-folder shows that a share of its parent folder reached it. Without user_id the route reads your own access; you need view access to the asset and membership in its workspace. To read another user's access, pass their user_id; you need edit access to the asset, as for sharing it. A user who is not a member of the asset's workspace, or who does not exist, reads as 'none' with is_member false. A suspended member reads as 'none' with no sources, and is_member still reports their membership. When a permission check cannot be answered (for example on an asset in a drive while the authorization service is unavailable), the route answers 503 and never a level. The route never changes a permission.
+     *
+     * @param {AthenaIntelligence.GetAccessAssetsRequest} request
+     * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.assets.getAccess({
+     *         asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f"
+     *     })
+     */
+    getAccess(request: AthenaIntelligence.GetAccessAssetsRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.AssetAccessOut>;
+    private __getAccess;
     /**
      * Admin only. List the edit history of a collaborative asset, newest first: who edited it, when, and under which agent/session attribution. Works for every collaborative asset type. Each item's from_clock/to_clock identify the edit for the companion delta endpoint, which reports what actually changed.
      *

package/dist/cjs/api/resources/assets/client/Client.js

@@ -252,7 +252,7 @@ class AssetsClient {
         });
     }
     /**
-     * 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.
+     * 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.
      *
      * @param {AthenaIntelligence.CreateAssetRequestIn} request
      * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -699,6 +699,91 @@ class AssetsClient {
             }
         });
     }
+    /**
+     * Read the access that you, or another user, have on an asset, and every grant that gives it. The level is what Athena's permission checks decide for the user in the asset's own workspace, whichever workspace is active for your key: 'view' can open the asset, 'edit' can also change it and manage its sharing, 'owner' created it and can edit it, and 'none' cannot open it. Each source names one grant: 'owner', 'direct' (shared with the user), 'group' (shared with a workspace group the user belongs to), 'workspace' (shared with the whole workspace), 'drive' (a role on the drive) or 'other' (access the share list does not hold, for example an environment admin). A folder's sharing reaches each asset inside it as that asset's own share, so a 'workspace' source on a sub-folder shows that a share of its parent folder reached it. Without user_id the route reads your own access; you need view access to the asset and membership in its workspace. To read another user's access, pass their user_id; you need edit access to the asset, as for sharing it. A user who is not a member of the asset's workspace, or who does not exist, reads as 'none' with is_member false. A suspended member reads as 'none' with no sources, and is_member still reports their membership. When a permission check cannot be answered (for example on an asset in a drive while the authorization service is unavailable), the route answers 503 and never a level. The route never changes a permission.
+     *
+     * @param {AthenaIntelligence.GetAccessAssetsRequest} request
+     * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.assets.getAccess({
+     *         asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f"
+     *     })
+     */
+    getAccess(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getAccess(request, requestOptions));
+    }
+    __getAccess(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { asset_id: assetId, user_id: userId } = request;
+            const _queryParams = {};
+            if (userId !== undefined) {
+                _queryParams.user_id = userId;
+            }
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                "X-Athena-Session-Credential": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sessionCredential) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sessionCredential,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
+                url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.AthenaIntelligenceEnvironment.Production, `api/v0/assets/${core.url.encodePathParam(assetId)}/access`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 60) * 1000,
+                maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new AthenaIntelligence.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new AthenaIntelligence.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new AthenaIntelligence.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new AthenaIntelligence.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.AthenaIntelligenceError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.AthenaIntelligenceError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "body-is-null":
+                    throw new errors.AthenaIntelligenceError({
+                        statusCode: _response.error.statusCode,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.AthenaIntelligenceTimeoutError("Timeout exceeded when calling GET /api/v0/assets/{asset_id}/access.");
+                case "unknown":
+                    throw new errors.AthenaIntelligenceError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Admin only. List the edit history of a collaborative asset, newest first: who edited it, when, and under which agent/session attribution. Works for every collaborative asset type. Each item's from_clock/to_clock identify the edit for the companion delta endpoint, which reports what actually changed.
      *

package/dist/cjs/api/resources/assets/client/requests/CreateAssetRequestIn.d.ts

@@ -28,6 +28,8 @@ export interface CreateAssetRequestIn {
     provider?: string | null;
     /** skill only. The skill's SKILL.md content. Created as a draft; publish it with POST /api/v0/assets/{asset_id}/publish. */
     skill_config?: AthenaIntelligence.PublicSkillConfigIn | null;
+    /** Database only. Seconds without activity after which the database suspends (scales to zero): 0 means it never suspends (the compute keeps running, and keeps using capacity), otherwise 60 to 86400 (24 hours). Defaults to 1800 (30 minutes). Applied while the database is provisioned; if it cannot be applied, the database is not created and compute-status reports failed. Read or change it later with GET/PATCH /api/v0/databases/{asset_id}/settings. */
+    suspend_timeout_seconds?: number | null;
     /** Computer only. Template key to create the computer from, as picked in the Athena UI's computer creation dialog (e.g. 'default'), or an 'environment:<asset_id>' reference to a saved environment. Defaults to the default template. Also accepted as 'snapshot'. */
     template?: string | null;
     /** Title for the new asset */

package/dist/cjs/api/resources/assets/client/requests/GetAccessAssetsRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @example
+ *     {
+ *         asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f"
+ *     }
+ */
+export interface GetAccessAssetsRequest {
+    /** Unique identifier of the asset */
+    asset_id: string;
+    /** The user whose access to read. Leave it out to read your own. Reading another user's access needs edit access to the asset. */
+    user_id?: string | null;
+}

package/dist/cjs/api/resources/assets/client/requests/GetAccessAssetsRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/assets/client/requests/index.d.ts

@@ -7,6 +7,7 @@ export type { CreateAssetRequestIn } from "./CreateAssetRequestIn.js";
 export type { CreateProjectRequestIn } from "./CreateProjectRequestIn.js";
 export type { DownloadAssetsRequest } from "./DownloadAssetsRequest.js";
 export type { DuplicateAssetRequestIn } from "./DuplicateAssetRequestIn.js";
+export type { GetAccessAssetsRequest } from "./GetAccessAssetsRequest.js";
 export type { GetActivityDeltaAssetsRequest } from "./GetActivityDeltaAssetsRequest.js";
 export type { GetAssetsRequest } from "./GetAssetsRequest.js";
 export type { ListActivityAssetsRequest } from "./ListActivityAssetsRequest.js";

package/dist/cjs/api/resources/databases/client/Client.d.ts

@@ -16,10 +16,13 @@ export declare class DatabasesClient {
      *
      * **Status Values:**
      * - `running` - Database is active and accepting connections
-     * - `suspended` - Database is suspended (scale-to-zero), will auto-resume on first query
-     * - `starting` - Database is waking up
-     * - `failed` - Database failed to start
-     * - `unknown` - Status could not be determined
+     * - `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
+     * - `starting` - Database is waking up, or its compute is being recreated
+     * - `creating` - Database is being created; it has no compute yet
+     * - `failed` - Database failed to start, or its creation failed (`message` says which)
+     * - `unknown` - Status could not be determined (the control plane did not answer); retry
+     *
+     * 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.
      *
      * @param {AthenaIntelligence.GetStatusDatabasesRequest} request
      * @param {DatabasesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -217,6 +220,53 @@ export declare class DatabasesClient {
      */
     getTableSchema(request: AthenaIntelligence.GetTableSchemaDatabasesRequest, requestOptions?: DatabasesClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DatabaseTableSchemaResponse>;
     private __getTableSchema;
+    /**
+     * 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.
+     *
+     * 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.
+     *
+     * @param {AthenaIntelligence.GetSettingsDatabasesRequest} request
+     * @param {DatabasesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.ConflictError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.getSettings({
+     *         asset_id: "asset_id"
+     *     })
+     */
+    getSettings(request: AthenaIntelligence.GetSettingsDatabasesRequest, requestOptions?: DatabasesClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DatabaseComputeSettingsResponseOut>;
+    private __getSettings;
+    /**
+     * 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.
+     *
+     * 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.
+     *
+     * @param {AthenaIntelligence.DatabaseComputeSettingsUpdateRequestIn} request
+     * @param {DatabasesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.ConflictError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.updateSettings({
+     *         asset_id: "asset_id",
+     *         suspend_timeout_seconds: 3600
+     *     })
+     */
+    updateSettings(request: AthenaIntelligence.DatabaseComputeSettingsUpdateRequestIn, requestOptions?: DatabasesClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DatabaseComputeSettingsResponseOut>;
+    private __updateSettings;
     /**
      * Execute a SQL statement against the database. SELECT queries return columns and rows. Non-SELECT statements (CREATE, INSERT, UPDATE, DELETE, ALTER, DROP, etc.) return execution statuses.
      *
@@ -239,4 +289,27 @@ export declare class DatabasesClient {
      */
     executeSql(request: AthenaIntelligence.DatabaseSqlRequest, requestOptions?: DatabasesClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DatabaseSqlResponse>;
     private __executeSql;
+    /**
+     * 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.
+     *
+     * 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.
+     *
+     * @param {AthenaIntelligence.WakeDatabasesRequest} request
+     * @param {DatabasesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.ConflictError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.wake({
+     *         asset_id: "asset_id"
+     *     })
+     */
+    wake(request: AthenaIntelligence.WakeDatabasesRequest, requestOptions?: DatabasesClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DatabaseWakeResponseOut>;
+    private __wake;
 }

package/dist/cjs/api/resources/databases/client/Client.js

@@ -70,10 +70,13 @@ class DatabasesClient {
      *
      * **Status Values:**
      * - `running` - Database is active and accepting connections
-     * - `suspended` - Database is suspended (scale-to-zero), will auto-resume on first query
-     * - `starting` - Database is waking up
-     * - `failed` - Database failed to start
-     * - `unknown` - Status could not be determined
+     * - `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
+     * - `starting` - Database is waking up, or its compute is being recreated
+     * - `creating` - Database is being created; it has no compute yet
+     * - `failed` - Database failed to start, or its creation failed (`message` says which)
+     * - `unknown` - Status could not be determined (the control plane did not answer); retry
+     *
+     * 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.
      *
      * @param {AthenaIntelligence.GetStatusDatabasesRequest} request
      * @param {DatabasesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -793,6 +796,200 @@ class DatabasesClient {
             }
         });
     }
+    /**
+     * 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.
+     *
+     * 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.
+     *
+     * @param {AthenaIntelligence.GetSettingsDatabasesRequest} request
+     * @param {DatabasesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.ConflictError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.getSettings({
+     *         asset_id: "asset_id"
+     *     })
+     */
+    getSettings(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getSettings(request, requestOptions));
+    }
+    __getSettings(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { asset_id: assetId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                "X-Athena-Session-Credential": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sessionCredential) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sessionCredential,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
+                url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.AthenaIntelligenceEnvironment.Production, `api/v0/databases/${core.url.encodePathParam(assetId)}/settings`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 60) * 1000,
+                maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new AthenaIntelligence.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new AthenaIntelligence.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new AthenaIntelligence.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new AthenaIntelligence.ConflictError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new AthenaIntelligence.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new AthenaIntelligence.NotImplementedError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new AthenaIntelligence.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.AthenaIntelligenceError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.AthenaIntelligenceError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "body-is-null":
+                    throw new errors.AthenaIntelligenceError({
+                        statusCode: _response.error.statusCode,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.AthenaIntelligenceTimeoutError("Timeout exceeded when calling GET /api/v0/databases/{asset_id}/settings.");
+                case "unknown":
+                    throw new errors.AthenaIntelligenceError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * 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.
+     *
+     * 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.
+     *
+     * @param {AthenaIntelligence.DatabaseComputeSettingsUpdateRequestIn} request
+     * @param {DatabasesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.ConflictError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.updateSettings({
+     *         asset_id: "asset_id",
+     *         suspend_timeout_seconds: 3600
+     *     })
+     */
+    updateSettings(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updateSettings(request, requestOptions));
+    }
+    __updateSettings(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { asset_id: assetId } = request, _body = __rest(request, ["asset_id"]);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                "X-Athena-Session-Credential": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sessionCredential) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sessionCredential,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
+                url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.AthenaIntelligenceEnvironment.Production, `api/v0/databases/${core.url.encodePathParam(assetId)}/settings`),
+                method: "PATCH",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: _body,
+                timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 60) * 1000,
+                maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new AthenaIntelligence.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new AthenaIntelligence.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new AthenaIntelligence.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new AthenaIntelligence.ConflictError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new AthenaIntelligence.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new AthenaIntelligence.NotImplementedError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new AthenaIntelligence.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.AthenaIntelligenceError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.AthenaIntelligenceError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "body-is-null":
+                    throw new errors.AthenaIntelligenceError({
+                        statusCode: _response.error.statusCode,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.AthenaIntelligenceTimeoutError("Timeout exceeded when calling PATCH /api/v0/databases/{asset_id}/settings.");
+                case "unknown":
+                    throw new errors.AthenaIntelligenceError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Execute a SQL statement against the database. SELECT queries return columns and rows. Non-SELECT statements (CREATE, INSERT, UPDATE, DELETE, ALTER, DROP, etc.) return execution statuses.
      *
@@ -890,5 +1087,100 @@ class DatabasesClient {
             }
         });
     }
+    /**
+     * 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.
+     *
+     * 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.
+     *
+     * @param {AthenaIntelligence.WakeDatabasesRequest} request
+     * @param {DatabasesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.ConflictError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.wake({
+     *         asset_id: "asset_id"
+     *     })
+     */
+    wake(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__wake(request, requestOptions));
+    }
+    __wake(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { asset_id: assetId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                "X-Athena-Session-Credential": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sessionCredential) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sessionCredential,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
+                url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.AthenaIntelligenceEnvironment.Production, `api/v0/databases/${core.url.encodePathParam(assetId)}/wake`),
+                method: "POST",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 60) * 1000,
+                maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new AthenaIntelligence.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new AthenaIntelligence.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new AthenaIntelligence.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new AthenaIntelligence.ConflictError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new AthenaIntelligence.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new AthenaIntelligence.NotImplementedError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new AthenaIntelligence.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.AthenaIntelligenceError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.AthenaIntelligenceError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "body-is-null":
+                    throw new errors.AthenaIntelligenceError({
+                        statusCode: _response.error.statusCode,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.AthenaIntelligenceTimeoutError("Timeout exceeded when calling POST /api/v0/databases/{asset_id}/wake.");
+                case "unknown":
+                    throw new errors.AthenaIntelligenceError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
 }
 exports.DatabasesClient = DatabasesClient;

package/dist/cjs/api/resources/databases/client/requests/DatabaseComputeSettingsUpdateRequestIn.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @example
+ *     {
+ *         asset_id: "asset_id",
+ *         suspend_timeout_seconds: 3600
+ *     }
+ */
+export interface DatabaseComputeSettingsUpdateRequestIn {
+    asset_id: string;
+    /** 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. */
+    suspend_timeout_seconds: number;
+}