@athenaintel/sdk 4.3.307

package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/Client.mjs

@@ -0,0 +1,144 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as environments from "../../../../../../environments.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as AthenaIntelligence from "../../../../../index.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
+import * as errors from "../../../../../../errors/index.mjs";
+export class StructuredDataExtractor {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Extract structured data.
+     *
+     * tl;dr:
+     * - pass a valid JSON schema in `json_schema`
+     * - pass the page chunks as a list of `Chunk` objects, by default: `{"type": "text", "content": "..."}`
+     * - leave all other fields as default
+     *
+     * Detailed configuration (only relevant for complex use cases):
+     *
+     * The structured data extractor's architecture follows the map-reduce pattern,
+     * where the asset is divided into chunks, the schema is extracted from each chunk,
+     * and the chunks are then reduced to a single structured data object.
+     *
+     * In some applications, you may not want to:
+     *
+     * - map (if your input asset is small enough)
+     * - reduce (if your output object is large enough that it will overflow the output length;
+     *     if you're extracting a long list of entities; if youre )
+     *     to extract all instances of the schema).
+     *
+     * You can configure these behaviors with the `map` and `reduce` fields.
+     *
+     * @param {AthenaIntelligence.tools.StructuredDataExtractorRequest} request
+     * @param {StructuredDataExtractor.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tools.structuredDataExtractor.invoke({
+     *         chunks: [{
+     *                 chunk_id: "1",
+     *                 content: [{
+     *                         type: "text",
+     *                         text: "John Smith is a 35 year old developer. You can reach him at john.smith@example.com"
+     *                     }]
+     *             }, {
+     *                 chunk_id: "2",
+     *                 content: [{
+     *                         type: "text",
+     *                         text: "Jane Doe is a 25 year old developer. You can reach her at jane@example.com"
+     *                     }]
+     *             }],
+     *         json_schema: {
+     *             "description": "A person",
+     *             "properties": {
+     *                 "age": {
+     *                     "type": "integer"
+     *                 },
+     *                 "email": {
+     *                     "type": "string"
+     *                 },
+     *                 "name": {
+     *                     "type": "string"
+     *                 }
+     *             },
+     *             "required": [
+     *                 "name"
+     *             ],
+     *             "title": "Person",
+     *             "type": "object"
+     *         }
+     *     })
+     */
+    invoke(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__invoke(request, requestOptions));
+    }
+    __invoke(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.AthenaIntelligenceEnvironment.Production, "api/v0/tools/structured-data-extractor/invoke"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new AthenaIntelligence.UnprocessableEntityError(_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 "timeout":
+                    throw new errors.AthenaIntelligenceTimeoutError("Timeout exceeded when calling POST /api/v0/tools/structured-data-extractor/invoke.");
+                case "unknown":
+                    throw new errors.AthenaIntelligenceError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    _getCustomAuthorizationHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
+            return { "X-API-KEY": apiKeyValue };
+        });
+    }
+}

package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/index.d.mts

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/index.mjs

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/requests/StructuredDataExtractorRequest.d.mts

@@ -0,0 +1,50 @@
+import * as AthenaIntelligence from "../../../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         chunks: [{
+ *                 chunk_id: "1",
+ *                 content: [{
+ *                         type: "text",
+ *                         text: "John Smith is a 35 year old developer. You can reach him at john.smith@example.com"
+ *                     }]
+ *             }, {
+ *                 chunk_id: "2",
+ *                 content: [{
+ *                         type: "text",
+ *                         text: "Jane Doe is a 25 year old developer. You can reach her at jane@example.com"
+ *                     }]
+ *             }],
+ *         json_schema: {
+ *             "description": "A person",
+ *             "properties": {
+ *                 "age": {
+ *                     "type": "integer"
+ *                 },
+ *                 "email": {
+ *                     "type": "string"
+ *                 },
+ *                 "name": {
+ *                     "type": "string"
+ *                 }
+ *             },
+ *             "required": [
+ *                 "name"
+ *             ],
+ *             "title": "Person",
+ *             "type": "object"
+ *         }
+ *     }
+ */
+export interface StructuredDataExtractorRequest {
+    /** The prompt to use for the data extraction over *each individual chunk*. It must be a list of messages.  The chunk content will be appended as a list of human messages. */
+    chunk_messages?: AthenaIntelligence.PromptMessage[];
+    /** The chunks from which to extract structured data. */
+    chunks: AthenaIntelligence.Chunk[];
+    /** The JSON schema to use for validation (version draft 2020-12). See the docs [here](https://json-schema.org/learn/getting-started-step-by-step). */
+    json_schema: Record<string, unknown>;
+    /** If `map`, whether to reduce the chunks to a single structured object (true) or return the full list (false).  Use True unless you want to preserve duplicates from each page or expect the object to overflow the output context. */
+    reduce?: boolean;
+    /** The prompt to use for the reduce steps. It must be a list of messages. The two extraction attempts will be appended as a list of human messages. */
+    reduce_messages?: AthenaIntelligence.PromptMessage[];
+}

package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/requests/StructuredDataExtractorRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as AthenaIntelligence from "../../../../../../index.mjs";

package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/requests/index.d.mts

@@ -0,0 +1 @@
+export { type StructuredDataExtractorRequest } from "./StructuredDataExtractorRequest.mjs";

package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/requests/index.mjs

@@ -0,0 +1 @@
+export {} from "./StructuredDataExtractorRequest.mjs";

package/dist/esm/api/resources/tools/resources/structuredDataExtractor/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/tools/resources/structuredDataExtractor/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/tools/resources/tasks/client/Client.d.mts

@@ -0,0 +1,31 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as AthenaIntelligence from "../../../../../index.mjs";
+export declare namespace Tasks {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Tasks {
+    protected readonly _options: Tasks.Options;
+    constructor(_options: Tasks.Options);
+    /**
+     * Run a [task](https://resources.athenaintel.com/docs/task-studio/home) and wait for the result.
+     *
+     * Executes a Windmill script or flow synchronously. Server handles polling internally.
+     *
+     * @param {AthenaIntelligence.tools.RunTaskRequest} request
+     * @param {Tasks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tools.tasks.runTask({
+     *         task_id: "task_id"
+     *     })
+     */
+    runTask(request: AthenaIntelligence.tools.RunTaskRequest, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.RunTaskResponse>;
+    private __runTask;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+}

package/dist/esm/api/resources/tools/resources/tasks/client/Client.mjs

@@ -0,0 +1,92 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as environments from "../../../../../../environments.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as AthenaIntelligence from "../../../../../index.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
+import * as errors from "../../../../../../errors/index.mjs";
+export class Tasks {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Run a [task](https://resources.athenaintel.com/docs/task-studio/home) and wait for the result.
+     *
+     * Executes a Windmill script or flow synchronously. Server handles polling internally.
+     *
+     * @param {AthenaIntelligence.tools.RunTaskRequest} request
+     * @param {Tasks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AthenaIntelligence.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tools.tasks.runTask({
+     *         task_id: "task_id"
+     *     })
+     */
+    runTask(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__runTask(request, requestOptions));
+    }
+    __runTask(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.AthenaIntelligenceEnvironment.Production, "api/v0/tools/tasks/run"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new AthenaIntelligence.UnprocessableEntityError(_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 "timeout":
+                    throw new errors.AthenaIntelligenceTimeoutError("Timeout exceeded when calling POST /api/v0/tools/tasks/run.");
+                case "unknown":
+                    throw new errors.AthenaIntelligenceError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    _getCustomAuthorizationHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
+            return { "X-API-KEY": apiKeyValue };
+        });
+    }
+}

package/dist/esm/api/resources/tools/resources/tasks/client/index.d.mts

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/tools/resources/tasks/client/index.mjs

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/tools/resources/tasks/client/requests/RunTaskRequest.d.mts

@@ -0,0 +1,22 @@
+/**
+ * @example
+ *     {
+ *         task_id: "task_id"
+ *     }
+ */
+export interface RunTaskRequest {
+    /** Arguments to pass to the task */
+    arguments?: Record<string, unknown>;
+    /** The unique identifier (path) of the task. Example: 'f/public/databricks_describe_table' */
+    task_id: string;
+    /** Type: 'script' or 'flow' */
+    task_type?: RunTaskRequest.TaskType;
+}
+export declare namespace RunTaskRequest {
+    /** Type: 'script' or 'flow' */
+    const TaskType: {
+        readonly Script: "script";
+        readonly Flow: "flow";
+    };
+    type TaskType = (typeof TaskType)[keyof typeof TaskType];
+}

package/dist/esm/api/resources/tools/resources/tasks/client/requests/RunTaskRequest.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var RunTaskRequest;
+(function (RunTaskRequest) {
+    /** Type: 'script' or 'flow' */
+    RunTaskRequest.TaskType = {
+        Script: "script",
+        Flow: "flow",
+    };
+})(RunTaskRequest || (RunTaskRequest = {}));

package/dist/esm/api/resources/tools/resources/tasks/client/requests/index.d.mts

@@ -0,0 +1 @@
+export { type RunTaskRequest } from "./RunTaskRequest.mjs";

package/dist/esm/api/resources/tools/resources/tasks/client/requests/index.mjs

@@ -0,0 +1 @@
+export {} from "./RunTaskRequest.mjs";

package/dist/esm/api/resources/tools/resources/tasks/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/tools/resources/tasks/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/tools/types/ToolsDataFrameRequestColumnsItem.d.mts

@@ -0,0 +1 @@
+export type ToolsDataFrameRequestColumnsItem = number | string;

package/dist/esm/api/resources/tools/types/ToolsDataFrameRequestColumnsItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/tools/types/index.d.mts

@@ -0,0 +1 @@
+export * from "./ToolsDataFrameRequestColumnsItem.mjs";

package/dist/esm/api/resources/tools/types/index.mjs

@@ -0,0 +1 @@
+export * from "./ToolsDataFrameRequestColumnsItem.mjs";

package/dist/esm/api/types/AopAsyncExecuteResponseOut.d.mts

@@ -0,0 +1,25 @@
+/**
+ * Response model for async AOP execution.
+ */
+export interface AopAsyncExecuteResponseOut {
+    /** ID of the AOP asset that was executed */
+    aop_asset_id: string;
+    /** Full configuration of the AOP asset */
+    aop_config: Record<string, unknown>;
+    /** Title of the AOP asset */
+    aop_title: string;
+    /** Base prompt of the AOP before user inputs were added */
+    base_prompt: string;
+    /** Final prompt used for execution including user inputs */
+    final_prompt: string;
+    /** Status message about the async execution */
+    message: string;
+    /** Status of the execution (always 'started' for async) */
+    status: string;
+    /** Sync server URL used for execution */
+    sync_server: string;
+    /** Unique thread ID for tracking the execution */
+    thread_id: string;
+    /** Type of trigger that initiated the execution */
+    trigger_type: string;
+}

package/dist/esm/api/types/AopAsyncExecuteResponseOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AopExecuteRequestIn.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Request model for executing an AOP (Agent Operating Procedure).
+ */
+export interface AopExecuteRequestIn {
+    /** ID of the existing AOP asset to execute */
+    asset_id: string;
+    /** Optional user inputs to append to the AOP's prompt as key-value pairs */
+    user_inputs?: Record<string, string | undefined>;
+}

package/dist/esm/api/types/AopExecuteRequestIn.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AopExecuteResponseOut.d.mts

@@ -0,0 +1,28 @@
+import * as AthenaIntelligence from "../index.mjs";
+/**
+ * Response model for AOP execution.
+ */
+export interface AopExecuteResponseOut {
+    /** ID of the AOP asset that was executed */
+    aop_asset_id: string;
+    /** Full configuration of the AOP asset */
+    aop_config: Record<string, unknown>;
+    /** Title of the AOP asset */
+    aop_title: string;
+    /** Base prompt of the AOP before user inputs were added */
+    base_prompt: string;
+    /** The conversation result from the AOP execution */
+    conversation?: AthenaIntelligence.ConversationResult;
+    /** Error message if execution failed */
+    error?: string;
+    /** Final prompt used for execution including user inputs */
+    final_prompt: string;
+    /** Status of the execution (e.g., 'submitted') */
+    status: string;
+    /** Sync server URL used for execution */
+    sync_server: string;
+    /** Unique thread ID for tracking the execution */
+    thread_id: string;
+    /** Type of trigger that initiated the execution */
+    trigger_type: string;
+}

package/dist/esm/api/types/AopExecuteResponseOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as AthenaIntelligence from "../index.mjs";

package/dist/esm/api/types/AssetContentRequestOut.d.mts

@@ -0,0 +1,7 @@
+/**
+ * Response model with asset content.
+ */
+export interface AssetContentRequestOut {
+    /** The content of the asset */
+    content: string;
+}

package/dist/esm/api/types/AssetContentRequestOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AssetNode.d.mts

@@ -0,0 +1,11 @@
+import * as AthenaIntelligence from "../index.mjs";
+/**
+ * Model representing a node in the folder tree.
+ */
+export interface AssetNode {
+    children?: Record<string, AthenaIntelligence.AssetNode | undefined>;
+    id: string;
+    media_type: string;
+    name: string;
+    type: string;
+}

package/dist/esm/api/types/AssetNode.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as AthenaIntelligence from "../index.mjs";

package/dist/esm/api/types/AssetScreenshotResponseOut.d.mts

@@ -0,0 +1,13 @@
+/**
+ * Response model with screenshot data.
+ */
+export interface AssetScreenshotResponseOut {
+    /** Base64-encoded image data */
+    base64_image: string;
+    /** Status message */
+    message: string;
+    /** The page number that was captured */
+    page_number: number;
+    /** Total number of pages in the document */
+    total_pages: number;
+}

package/dist/esm/api/types/AssetScreenshotResponseOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/BorderModel.d.mts

@@ -0,0 +1,9 @@
+import * as AthenaIntelligence from "../index.mjs";
+export interface BorderModel {
+    /** Border color as hex string (e.g., '#FF0000'). Use either color_hex or color_theme, not both. */
+    color_hex?: string;
+    /** Border color as theme reference. Use either color_hex or color_theme, not both. Defaults to theme color 1 if neither is specified. */
+    color_theme?: AthenaIntelligence.ThemeColor;
+    style: AthenaIntelligence.BorderStyle;
+    width: number;
+}

package/dist/esm/api/types/BorderModel.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as AthenaIntelligence from "../index.mjs";

package/dist/esm/api/types/BorderStyle.d.mts

@@ -0,0 +1,9 @@
+export declare const BorderStyle: {
+    readonly Dotted: "dotted";
+    readonly Dashed: "dashed";
+    readonly Solid: "solid";
+    readonly SolidMedium: "solid_medium";
+    readonly SolidThick: "solid_thick";
+    readonly Double: "double";
+};
+export type BorderStyle = (typeof BorderStyle)[keyof typeof BorderStyle];

package/dist/esm/api/types/BorderStyle.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export const BorderStyle = {
+    Dotted: "dotted",
+    Dashed: "dashed",
+    Solid: "solid",
+    SolidMedium: "solid_medium",
+    SolidThick: "solid_thick",
+    Double: "double",
+};

package/dist/esm/api/types/BordersModel.d.mts

@@ -0,0 +1,30 @@
+import * as AthenaIntelligence from "../index.mjs";
+/**
+ * Border configuration for spreadsheet cells. Set individual borders (top, right, bottom, left) to apply borders around cells.
+ *
+ * Common border patterns:
+ * - All borders: Set all four sides (top, right, bottom, left) to create borders around every cell
+ * - Outer border only: For a range A1:C3, only the perimeter cells get borders (first row gets top, last row gets bottom, etc.)
+ * - Inner borders only: Only borders between cells, not on the outer edges
+ * - Horizontal lines: Set only top and/or bottom borders
+ * - Vertical lines: Set only left and/or right borders
+ * - Single side: Set only one border (e.g., just bottom for underline effect)
+ *
+ * Note: Borders are applied per-cell. Each cell's border properties control which edges of that specific cell have borders. Overlapping borders between adjacent cells will appear as a single line.
+ *
+ * Examples:
+ * - Box around range: Set all four borders on all cells in the range
+ * - Table with grid: Set all four borders to create a complete grid
+ * - Underline header: Set only bottom border on header row
+ * - Separate sections: Set bottom border to divide content
+ */
+export interface BordersModel {
+    /** Bottom border of the cell */
+    bottom?: AthenaIntelligence.BorderModel;
+    /** Left border of the cell */
+    left?: AthenaIntelligence.BorderModel;
+    /** Right border of the cell */
+    right?: AthenaIntelligence.BorderModel;
+    /** Top border of the cell */
+    top?: AthenaIntelligence.BorderModel;
+}

package/dist/esm/api/types/BordersModel.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as AthenaIntelligence from "../index.mjs";