@athenaintel/sdk 4.3.1157 → 4.3.1923

package/dist/cjs/api/types/PublicAssetOut.d.ts

@@ -5,13 +5,13 @@ export interface PublicAssetOut {
     /** File type after Athena processing/conversion (e.g., 'txt', 'pdf', 'md') */
     athena_converted_type: string;
     /** Internal metadata used by Athena system (e.g., {'source': 'kb', 'topic': 'insights'}) */
-    athena_metadata?: Record<string, unknown>;
+    athena_metadata?: Record<string, unknown> | null;
     /** Original asset type from AssetType enum (e.g., 'document', 'presentation', 'spreadsheet') */
     athena_original_type: string;
     /** Timestamp when the asset was created (ISO 8601 format) */
     created_at: string;
     /** Email address of the user who created this asset */
-    created_by_email?: string;
+    created_by_email?: string | null;
     /** Unique identifier of the user who created this asset */
     created_by_id: string;
     /** Unique identifier of the asset (e.g., 'asset_abc123-def456-ghi789') */
@@ -23,15 +23,17 @@ export interface PublicAssetOut {
     /** MIME type or Athena-specific media type (e.g., 'text/plain', 'application/pdf', 'athena/document') */
     media_type: string;
     /** AI-generated summary of the asset content */
-    summary?: string;
+    summary?: string | null;
     /** Whether the AI summary has been generated and is available */
     summary_ready: boolean;
     /** Status of summary generation process ('READY', 'PENDING', 'FAILED', etc.) */
-    summary_status?: string;
+    summary_status?: string | null;
     /** Custom tags associated with the asset as key-value pairs (e.g., {'project': 'alpha', 'team': 'ml'}) */
-    tags?: Record<string, unknown>;
+    tags?: Record<string, unknown> | null;
     /** Display name/title of the asset */
     title: string;
     /** Timestamp when the asset was last modified (ISO 8601 format) */
     updated_at: string;
+    /** Unique identifier of the workspace this asset belongs to */
+    workspace_id?: string | null;
 }

package/dist/cjs/api/types/ReadCapabilitiesOut.d.ts

@@ -0,0 +1,19 @@
+/**
+ * The read capabilities advertised for an asset type.
+ */
+export interface ReadCapabilitiesOut {
+    /** Anchor types accepted for this asset type */
+    anchors?: string[];
+    /** The asset type these capabilities describe */
+    asset_type: string;
+    /** Format used when none is requested */
+    default_format: string;
+    /** Output formats this asset type supports */
+    formats: string[];
+    /** Handler-specific guidance for reading this asset type */
+    notes?: string | null;
+    /** Pagination protocol: char_offset, cell_offset, page_range, sheet_range, or null when the asset type is not paginated */
+    pagination?: string | null;
+    /** Anchor types recommended for precise reads */
+    preferred_anchors?: string[];
+}

package/dist/cjs/api/types/ReadCapabilitiesOut.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/types/RedactedThinkingContent.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A redacted thinking content item (when Claude's thinking is redacted for safety).
+ */
+export interface RedactedThinkingContent {
+    data: string;
+}

package/dist/cjs/api/types/RedactedThinkingContent.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/types/RevokeSshAccessResponseOut.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Response model for revoking SSH access to a computer asset.
+ */
+export interface RevokeSshAccessResponseOut {
+    /** Whether the SSH token was revoked */
+    revoked: boolean;
+}

package/dist/cjs/api/types/RevokeSshAccessResponseOut.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/types/RunTaskResponse.d.ts

@@ -3,11 +3,11 @@
  */
 export interface RunTaskResponse {
     /** Error message if failed */
-    error?: string;
+    error?: string | null;
     /** Error type: 'timeout', 'execution_error', 'not_found', 'validation_error' */
-    error_type?: string;
+    error_type?: string | null;
     /** Job ID for debugging */
-    job_id?: string;
+    job_id?: string | null;
     /** The task result */
     result?: unknown;
     /** Whether execution succeeded */

package/dist/cjs/api/types/SemanticModelMetaResponseOut.d.ts

@@ -1,7 +1,15 @@
 /**
- * Metadata response listing cubes, measures, and dimensions.
+ * Metadata response listing cubes, views, measures, and dimensions.
+ *
+ * The ``cubes`` field preserves Cube's native ``/v1/meta`` shape and
+ * contains both cubes and views interleaved (each entry has a ``type``
+ * field of ``cube`` or ``view``). The ``views`` field is a convenience
+ * filter that lists only the view-typed entries — recommended for
+ * AI agents that should query the curated surface.
  */
 export interface SemanticModelMetaResponseOut {
-    /** List of cubes with their measures and dimensions */
+    /** All meta entries (cubes + views) in author order. Each entry has a 'type' field — 'cube' or 'view'. */
     cubes: Record<string, unknown>[];
+    /** View-only subset of 'cubes' for convenience. Empty when no views are defined. */
+    views?: Record<string, unknown>[];
 }

package/dist/cjs/api/types/SessionOut.d.ts

@@ -0,0 +1,41 @@
+/**
+ * An agent session (conversation) asset with flattened metadata.
+ */
+export interface SessionOut {
+    /** Agent identity the session ran with, when set */
+    agent?: string | null;
+    /** Application identifier the session belongs to, when set */
+    app_id?: string | null;
+    /** Timestamp when the session was created (ISO 8601) */
+    created_at: string;
+    /** Unique identifier of the user who created this session */
+    created_by_id?: string | null;
+    /** Unique identifier of the session asset (e.g., 'asset_abc123') */
+    id: string;
+    /** Whether this is a branched sub-session of another session */
+    is_sub_session?: boolean;
+    /** Plain-text preview of the most recent message, when available */
+    last_message_preview?: string | null;
+    /** Model the session ran with, when set */
+    model?: string | null;
+    /** Number of messages in the session, when tracked */
+    num_messages?: number | null;
+    /** Asset ID of the parent session for sub-sessions */
+    parent_session_id?: string | null;
+    /** Kind of session: 'session' (chat), 'video_session', 'desktop_session', or 'mobile_session' */
+    session_type?: string | null;
+    /** Channel the session originated from (e.g., 'web', 'api', 'agent_email', 'agent_slack', 'agent_sms') */
+    source_channel?: string | null;
+    /** Execution state of the session (e.g., 'running', 'completed') */
+    state?: string | null;
+    /** LangChain thread ID backing this session's message history */
+    thread_id: string;
+    /** Display title of the session */
+    title?: string | null;
+    /** Total LLM cost of the session in USD, when tracked */
+    total_cost_usd?: number | null;
+    /** Timestamp when the session was last updated (ISO 8601) */
+    updated_at: string;
+    /** Unique identifier of the workspace this session belongs to */
+    workspace_id?: string | null;
+}

package/dist/cjs/api/types/SessionOut.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/types/ShareAssetResponseOut.d.ts

@@ -0,0 +1,10 @@
+import type * as AthenaIntelligence from "../index.js";
+/**
+ * Response model for sharing an asset with specific users.
+ */
+export interface ShareAssetResponseOut {
+    /** ID of the shared asset */
+    asset_id: string;
+    /** Results for each recipient that was shared with */
+    recipients_result: AthenaIntelligence.ShareRecipientResultOut[];
+}

package/dist/cjs/api/types/ShareAssetResponseOut.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/types/SharePermissionType.d.ts

@@ -0,0 +1,6 @@
+/** Permission level to grant when sharing an asset. */
+export declare const SharePermissionType: {
+    readonly View: "view";
+    readonly Edit: "edit";
+};
+export type SharePermissionType = (typeof SharePermissionType)[keyof typeof SharePermissionType];

package/dist/cjs/api/types/SharePermissionType.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharePermissionType = void 0;
+/** Permission level to grant when sharing an asset. */
+exports.SharePermissionType = {
+    View: "view",
+    Edit: "edit",
+};

package/dist/cjs/api/types/ShareRecipient.d.ts

@@ -0,0 +1,10 @@
+import type * as AthenaIntelligence from "../index.js";
+/**
+ * A single recipient for asset sharing.
+ */
+export interface ShareRecipient {
+    /** Email address of the user to share with */
+    email: string;
+    /** Permission level to grant: 'view' or 'edit' */
+    permission?: AthenaIntelligence.SharePermissionType;
+}

package/dist/cjs/api/types/ShareRecipient.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/types/ShareRecipientResultOut.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Result for a single share recipient.
+ */
+export interface ShareRecipientResultOut {
+    /** Email address of the recipient */
+    email: string;
+    /** Error message if sharing failed for this recipient */
+    error?: string | null;
+    /** Permission level granted ('view' or 'edit') */
+    permission: string;
+    /** Whether sharing was successful for this recipient */
+    success: boolean;
+}

package/dist/cjs/api/types/ShareRecipientResultOut.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/types/Sheet.d.ts

@@ -3,10 +3,10 @@ export interface Sheet {
     /** Column count (Defaults to 100) */
     columnCount: number;
     /** Array of column properties, one per column (1-indexed). REQUIRED when changing column widths. Each entry defines width, visibility for that column. Example: To set column C (index 3) width to 150px: columnMetadata[3] = DimensionProperties(size=150). Example: To hide column B: columnMetadata[2] = DimensionProperties(hiddenByUser=True). Common widths: 100px (default), 150px (wide text), 200px (very wide), 50px (narrow IDs) */
-    columnMetadata?: (AthenaIntelligence.DimensionProperties | undefined)[];
-    frozenColumnCount?: number;
-    frozenRowCount?: number;
-    hidden?: boolean;
+    columnMetadata?: (AthenaIntelligence.DimensionProperties | null)[] | null;
+    frozenColumnCount?: number | null;
+    frozenRowCount?: number | null;
+    hidden?: boolean | null;
     /** The order of the new sheet */
     index: number;
     /** List of merged cell ranges in the sheet. Each merge combines multiple cells into a single cell. The top-left cell (startRowIndex, startColumnIndex) becomes the anchor cell that displays the content. Example: To merge cells A1:C3, use GridRange(startRowIndex=1, endRowIndex=3, startColumnIndex=1, endColumnIndex=3). Defaults to empty list (no merged cells). */
@@ -14,13 +14,13 @@ export interface Sheet {
     /** Row count (Defaults to 1000) */
     rowCount: number;
     /** Array of row properties, one per row (1-indexed). REQUIRED when changing row heights. Each entry defines height, visibility for that row. Example: To set row 5 height to 50px: rowMetadata[5] = DimensionProperties(size=50). Example: To hide row 3: rowMetadata[3] = DimensionProperties(hiddenByUser=True). Common heights: 21px (default), 30px (comfortable), 50px (tall headers) */
-    rowMetadata?: (AthenaIntelligence.DimensionProperties | undefined)[];
+    rowMetadata?: (AthenaIntelligence.DimensionProperties | null)[] | null;
     /** Sheet ID (required) */
     sheetId: number;
-    showGridLines?: boolean;
+    showGridLines?: boolean | null;
     /** Tab color as hex string (e.g., '#FF0000'). Use either tabColor_hex or tabColor_theme, not both. */
-    tabColor_hex?: string;
+    tabColor_hex?: string | null;
     /** Tab color as theme reference. Use either tabColor_hex or tabColor_theme, not both. */
-    tabColor_theme?: AthenaIntelligence.ThemeColor;
+    tabColor_theme?: AthenaIntelligence.ThemeColor | null;
     title: string;
 }

package/dist/cjs/api/types/SheetOperationResponse.d.ts

@@ -3,6 +3,8 @@ export interface SheetOperationResponse {
     asset_id: string;
     /** Success message or error description */
     message: string;
+    /** ID of the newly created sheet when the operation creates one (e.g. duplicate). For rnc-engine sheets this is the engine-assigned id, which may differ from a requested new_sheet_id. */
+    new_sheet_id?: number | null;
     /** Whether the operation was successful */
     success: boolean;
 }

package/dist/cjs/api/types/SshAccessResponseOut.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Response model containing SSH connection details for a computer asset.
+ */
+export interface SshAccessResponseOut {
+    /** Full SSH command to connect to the computer (e.g., 'ssh token@host') */
+    command: string;
+    /** Number of minutes until the SSH access token expires */
+    expires_in_minutes: number;
+    /** Alternative SSH command via proxy (only available for admin users) */
+    proxy_command?: string | null;
+    /** SSH access token used for authentication */
+    token: string;
+}

package/dist/cjs/api/types/SshAccessResponseOut.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/types/StructuredDataExtractorResponse.d.ts

@@ -4,7 +4,7 @@ import type * as AthenaIntelligence from "../index.js";
  */
 export interface StructuredDataExtractorResponse {
     /** The extracted structured data for each chunk.  A list where each element is guaranteed to match `json_schema`. */
-    chunk_by_chunk_data?: AthenaIntelligence.ChunkResult[];
+    chunk_by_chunk_data: AthenaIntelligence.ChunkResult[] | null;
     /** If reduce is True, the reduced structured data, otherwise null.  Guaranteed to match `json_schema`. */
-    reduced_data?: Record<string, unknown>;
+    reduced_data: Record<string, unknown> | null;
 }

package/dist/cjs/api/types/TextFormatModel.d.ts

@@ -1,13 +1,13 @@
 import type * as AthenaIntelligence from "../index.js";
 export interface TextFormatModel {
-    bold?: boolean;
+    bold?: boolean | null;
     /** Text color as hex string (e.g., '#FF0000'). Use either color_hex or color_theme, not both. */
-    color_hex?: string;
+    color_hex?: string | null;
     /** Text color as theme reference. Use either color_hex or color_theme, not both. */
-    color_theme?: AthenaIntelligence.ThemeColor;
-    fontFamily?: string;
-    fontSize?: number;
-    italic?: boolean;
-    strikethrough?: boolean;
-    underline?: boolean;
+    color_theme?: AthenaIntelligence.ThemeColor | null;
+    fontFamily?: string | null;
+    fontSize?: number | null;
+    italic?: boolean | null;
+    strikethrough?: boolean | null;
+    underline?: boolean | null;
 }

package/dist/cjs/api/types/ThemeColor.d.ts

@@ -1,4 +1,4 @@
 export interface ThemeColor {
     theme: number;
-    tint?: number;
+    tint?: number | null;
 }

package/dist/cjs/api/types/ThinkingContent.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A thinking content item (Claude's extended thinking).
+ */
+export interface ThinkingContent {
+    signature: string;
+    thinking: string;
+}

package/dist/cjs/api/types/ThinkingContent.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/types/ThreadBatchStopResultItem.d.ts

@@ -3,7 +3,7 @@
  */
 export interface ThreadBatchStopResultItem {
     /** Error message if stop failed */
-    error?: string;
+    error?: string | null;
     /** Whether the stop was successful */
     success: boolean;
     /** The thread ID */

package/dist/cjs/api/types/ThreadStatusResponseOut.d.ts

@@ -4,11 +4,11 @@ import type * as AthenaIntelligence from "../index.js";
  */
 export interface ThreadStatusResponseOut {
     /** Information about the associated conversation asset */
-    conversation_asset?: AthenaIntelligence.ConversationAssetInfo;
+    conversation_asset: AthenaIntelligence.ConversationAssetInfo | null;
     /** ISO timestamp when thread was created */
     created_at: string;
     /** Error message if thread execution failed */
-    error?: string;
+    error?: string | null;
     /** Current status of the thread (e.g., 'running', 'completed', 'failed') */
     status: string;
     /** The thread ID that was checked */

package/dist/cjs/api/types/ToolResultContent.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A tool result content item (response from a tool call).
+ */
+export interface ToolResultContent {
+    content: ToolResultContent.Content;
+    is_error: boolean;
+    tool_use_id: string;
+}
+export declare namespace ToolResultContent {
+    type Content = string | Record<string, unknown>[];
+}

package/dist/cjs/api/types/ToolResultContent.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/types/ToolUseContent.d.ts

@@ -0,0 +1,8 @@
+/**
+ * A tool use content item (when the model calls a tool).
+ */
+export interface ToolUseContent {
+    id: string;
+    input: Record<string, unknown>;
+    name: string;
+}

package/dist/cjs/api/types/ToolUseContent.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/types/UpdateWorkspaceDisclaimerIn.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Input model for updating workspace disclaimer.
+ */
+export interface UpdateWorkspaceDisclaimerIn {
+    /** Text for the accept button */
+    acceptButtonText?: string | null;
+    /** Whether the disclaimer is enabled */
+    enabled: boolean;
+    /** Markdown content of the disclaimer message */
+    markdownText?: string | null;
+    /** Title displayed at the top of the disclaimer modal */
+    title?: string | null;
+}

package/dist/cjs/api/types/UpdateWorkspaceDisclaimerIn.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/types/UserInfoOut.d.ts

@@ -0,0 +1,14 @@
+import type * as AthenaIntelligence from "../index.js";
+/**
+ * Response model for user information.
+ */
+export interface UserInfoOut {
+    email: string;
+    first_name: string | null;
+    last_name: string | null;
+    user_id: string;
+    workspace_id: string | null;
+    workspace_name: string | null;
+    /** All workspaces the user has access to */
+    workspaces?: AthenaIntelligence.WorkspaceInfoOut[];
+}

package/dist/cjs/api/types/UserInfoOut.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/types/WorkspaceAccessResponseOut.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Response model for updating workspace access on an asset.
+ */
+export interface WorkspaceAccessResponseOut {
+    /** ID of the asset */
+    asset_id: string;
+    /** Workspace access level that was set ('view' or 'edit') */
+    workspace_access: string;
+}

package/dist/cjs/api/types/WorkspaceAccessResponseOut.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/types/WorkspaceConfigurationResponseOut.d.ts

@@ -0,0 +1,10 @@
+import type * as AthenaIntelligence from "../index.js";
+/**
+ * Response model for workspace configuration.
+ */
+export interface WorkspaceConfigurationResponseOut {
+    /** Workspace disclaimer settings */
+    workspace_disclaimer?: AthenaIntelligence.WorkspaceDisclaimerOut | null;
+    /** The workspace ID */
+    workspace_id: string;
+}

package/dist/cjs/api/types/WorkspaceConfigurationResponseOut.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/types/WorkspaceDisclaimerOut.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Workspace disclaimer configuration.
+ */
+export interface WorkspaceDisclaimerOut {
+    /** Text for the accept button */
+    accept_button_text?: string | null;
+    /** Whether the disclaimer is enabled */
+    enabled: boolean;
+    /** Markdown content of the disclaimer message */
+    markdown_text?: string | null;
+    /** Title displayed at the top of the disclaimer modal */
+    title?: string | null;
+}

package/dist/cjs/api/types/WorkspaceDisclaimerOut.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/types/WorkspaceInfoOut.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Workspace summary returned in user info.
+ */
+export interface WorkspaceInfoOut {
+    /** Display name of the workspace */
+    name: string | null;
+    /** User's role in this workspace (owner, manager, user) */
+    role: string;
+    /** Unique workspace identifier */
+    workspace_id: string;
+}

package/dist/cjs/api/types/WorkspaceInfoOut.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/types/WorkspaceShareAccess.d.ts

@@ -0,0 +1,6 @@
+/** Workspace-level access to grant on an asset. */
+export declare const WorkspaceShareAccess: {
+    readonly View: "view";
+    readonly Edit: "edit";
+};
+export type WorkspaceShareAccess = (typeof WorkspaceShareAccess)[keyof typeof WorkspaceShareAccess];

package/dist/cjs/api/types/WorkspaceShareAccess.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspaceShareAccess = void 0;
+/** Workspace-level access to grant on an asset. */
+exports.WorkspaceShareAccess = {
+    View: "view",
+    Edit: "edit",
+};