@athenaintel/sdk 4.3.307

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

@@ -0,0 +1,166 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as AthenaIntelligence from "../../../index.js";
+export declare namespace Databases {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Databases {
+    protected readonly _options: Databases.Options;
+    constructor(_options: Databases.Options);
+    /**
+     * Get a list of all tables in the database with optional row counts.
+     *
+     * @param {string} assetId
+     * @param {Databases.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.listTables("asset_id")
+     */
+    listTables(assetId: string, requestOptions?: Databases.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DatabaseTablesResponse>;
+    private __listTables;
+    /**
+     * Query rows from a table in the database. Supports filtering, ordering, and pagination using PostgREST-style query parameters.
+     *
+     * **Filter Syntax:**
+     * - `?column=eq.value` - Equal
+     * - `?column=neq.value` - Not equal
+     * - `?column=gt.value` - Greater than
+     * - `?column=gte.value` - Greater than or equal
+     * - `?column=lt.value` - Less than
+     * - `?column=lte.value` - Less than or equal
+     * - `?column=like.*pattern*` - LIKE (case-sensitive)
+     * - `?column=ilike.*pattern*` - ILIKE (case-insensitive)
+     * - `?column=in.(a,b,c)` - IN list
+     * - `?column=is.null` - IS NULL
+     *
+     * @param {string} assetId
+     * @param {string} tableName
+     * @param {AthenaIntelligence.DatabasesSelectRequest} request
+     * @param {Databases.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.select("asset_id", "table_name", {
+     *         select: "select",
+     *         order: "order",
+     *         limit: 1,
+     *         offset: 1
+     *     })
+     */
+    select(assetId: string, tableName: string, request?: AthenaIntelligence.DatabasesSelectRequest, requestOptions?: Databases.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DatabaseDataResponse>;
+    private __select;
+    /**
+     * Insert one or more rows into a table.
+     *
+     * @param {string} assetId
+     * @param {string} tableName
+     * @param {AthenaIntelligence.InsertDataRequest} request
+     * @param {Databases.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.insert("asset_id", "table_name", {
+     *         data: {
+     *             "email": "alice@example.com",
+     *             "name": "Alice"
+     *         },
+     *         return_representation: true
+     *     })
+     */
+    insert(assetId: string, tableName: string, request: AthenaIntelligence.InsertDataRequest, requestOptions?: Databases.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DatabaseMutationResponse>;
+    private __insert;
+    /**
+     * Delete rows matching the filter conditions. Filter conditions are passed as query parameters using PostgREST syntax (e.g., `?id=eq.5`).
+     *
+     * **Warning:** Without filters, this will delete ALL rows in the table.
+     *
+     * @param {string} assetId
+     * @param {string} tableName
+     * @param {AthenaIntelligence.DeleteDataRequest} request
+     * @param {Databases.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.delete("asset_id", "table_name", {
+     *         return_representation: false
+     *     })
+     */
+    delete(assetId: string, tableName: string, request?: AthenaIntelligence.DeleteDataRequest, requestOptions?: Databases.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DatabaseMutationResponse>;
+    private __delete;
+    /**
+     * Update rows matching the filter conditions. Filter conditions are passed as query parameters using PostgREST syntax (e.g., `?id=eq.5`).
+     *
+     * **Warning:** Without filters, this will update ALL rows in the table.
+     *
+     * @param {string} assetId
+     * @param {string} tableName
+     * @param {AthenaIntelligence.UpdateDataRequest} request
+     * @param {Databases.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.update("asset_id", "table_name", {
+     *         data: {
+     *             "email": "alice.smith@example.com",
+     *             "name": "Alice Smith"
+     *         },
+     *         return_representation: true
+     *     })
+     */
+    update(assetId: string, tableName: string, request: AthenaIntelligence.UpdateDataRequest, requestOptions?: Databases.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DatabaseMutationResponse>;
+    private __update;
+    /**
+     * Get the schema for a specific table, including column names, types, nullability, and default values. Useful for agent tooling and dynamic form generation.
+     *
+     * @param {string} assetId
+     * @param {string} tableName
+     * @param {Databases.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.BadRequestError}
+     * @throws {@link AthenaIntelligence.ForbiddenError}
+     * @throws {@link AthenaIntelligence.NotFoundError}
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     * @throws {@link AthenaIntelligence.NotImplementedError}
+     * @throws {@link AthenaIntelligence.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.databases.getTableSchema("asset_id", "table_name")
+     */
+    getTableSchema(assetId: string, tableName: string, requestOptions?: Databases.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DatabaseTableSchemaResponse>;
+    private __getTableSchema;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+}