@athenaintel/sdk 4.3.2158 → 4.3.2160

package/reference.md

@@ -1,82 +1,4 @@
 # Reference
-## Agents
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">invokeById</a>({ ...params }) -> AthenaIntelligence.CustomAgentResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Coming soon!
-
-Invoke a custom agent created in [spaces](https://resources.athenaintel.com/docs/agents/create-your-agent).
-
-Custom agents can be created and configured in spaces to perform specialized tasks.
-Refer to the specific agent's documentation for details on configuration options
-and expected responses.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.agents.invokeById({
-    agent_id: "agent_id",
-    config: {
-        "key": "value"
-    },
-    messages: [{
-            "key": "value"
-        }]
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `AthenaIntelligence.CustomAgentRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `AgentsClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
 ## Aop
 <details><summary><code>client.aop.<a href="/src/api/resources/aop/client/Client.ts">create</a>({ ...params }) -> AthenaIntelligence.AopCreateResponseOut</code></summary>
 <dl>
@@ -4314,6 +4236,29 @@ await client.tools.listContents();
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Read a tabular asset as a JSON data frame.
+
+Returns `columns`, an optional `index`, and `data` rows (pandas "split"
+orientation) for an asset the caller can read: an Athena spreadsheet, a
+file-backed live spreadsheet (SharePoint, OneDrive, Drive, iManage), or an
+uploaded CSV, Excel or Parquet file. `row_limit` caps the rows returned,
+`columns` selects columns by name or position, `sheet_name` picks the sheet
+of an Excel file (the first by default), and `separator` sets the delimiter
+of a CSV file. Any other asset type is a 415; a file the parser cannot read
+is a 500 carrying the parser's message.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -4752,153 +4697,11 @@ await client.workspaces.updateToolRegistry({
 </dl>
 
 
-</dd>
-</dl>
-</details>
-
-## Agents Drive
-<details><summary><code>client.agents.drive.<a href="/src/api/resources/agents/resources/drive/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.DriveAgentResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Coming soon! Manage folders and search for files in the internal drive.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.agents.drive.invoke({
-    config: {
-        "key": "value"
-    },
-    messages: [{
-            "key": "value"
-        }]
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `AthenaIntelligence.agents.DriveAgentRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `DriveClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
 </dd>
 </dl>
 </details>
 
 ## Agents General
-<details><summary><code>client.agents.general.<a href="/src/api/resources/agents/resources/general/client/Client.ts">batch</a>({ ...params }) -> AthenaIntelligence.GeneralAgentResponse[]</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Coming soon! Call the general agent with batched requests and return the results.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.agents.general.batch([{
-        config: {
-            enabled_tools: ["search"]
-        },
-        messages: [{
-                content: "Please call the search tool for AAPL news.",
-                role: "user"
-            }]
-    }]);
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `AthenaIntelligence.GeneralAgentRequest[]` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `GeneralClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
 <details><summary><code>client.agents.general.<a href="/src/api/resources/agents/resources/general/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.GeneralAgentResponse</code></summary>
 <dl>
 <dd>
@@ -4953,78 +4756,7 @@ await client.agents.general.invoke({
 <dl>
 <dd>
 
-**request:** `AthenaIntelligence.GeneralAgentRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `GeneralClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.agents.general.<a href="/src/api/resources/agents/resources/general/client/Client.ts">streamEvents</a>({ ...params }) -> AthenaIntelligence.GeneralAgentResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Coming soon! Call the general agent and stream events for real-time chat applications.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.agents.general.streamEvents({
-    config: {
-        enabled_tools: ["search"]
-    },
-    messages: [{
-            content: "Please call the search tool for AAPL news.",
-            role: "user"
-        }]
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `AthenaIntelligence.GeneralAgentRequest` 
+**request:** `AthenaIntelligence.agents.GeneralAgentRequest` 
     
 </dd>
 </dl>
@@ -5044,8 +4776,8 @@ await client.agents.general.streamEvents({
 </dl>
 </details>
 
-## Agents Research
-<details><summary><code>client.agents.research.<a href="/src/api/resources/agents/resources/research/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.ResearchAgentResponse</code></summary>
+## Tools Calendar
+<details><summary><code>client.tools.calendar.<a href="/src/api/resources/tools/resources/calendar/client/Client.ts">listEvents</a>({ ...params }) -> AthenaIntelligence.CalendarEventsResponseOut</code></summary>
 <dl>
 <dd>
 
@@ -5057,78 +4789,13 @@ await client.agents.general.streamEvents({
 <dl>
 <dd>
 
-Coming soon! Conduct research using web and other sources.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.agents.research.invoke({
-    config: {
-        "key": "value"
-    },
-    messages: [{
-            "key": "value"
-        }]
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `AthenaIntelligence.agents.ResearchAgentRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
+List events on the calendar of the caller's connected account.
 
-**requestOptions:** `ResearchClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-## Agents Sql
-<details><summary><code>client.agents.sql.<a href="/src/api/resources/agents/resources/sql/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.SqlAgentResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Coming soon! Generate, execute, and test SQL queries. Returns an asset ID for the query object.
+Reads the primary Google Calendar of a Gmail account or the default calendar
+of an Outlook account. `start`/`end` select the events overlapping that
+window; without them, Outlook returns recurring series as single entries, so
+supply a window to expand them. `title`, `location` and `attendees` filter the
+events that were read.
 </dd>
 </dl>
 </dd>
@@ -5143,13 +4810,8 @@ Coming soon! Generate, execute, and test SQL queries. Returns an asset ID for th
 <dd>
 
 ```typescript
-await client.agents.sql.invoke({
-    config: {
-        "key": "value"
-    },
-    messages: [{
-            "key": "value"
-        }]
+await client.tools.calendar.listEvents({
+    limit: 50
 });
 
 ```
@@ -5166,7 +4828,7 @@ await client.agents.sql.invoke({
 <dl>
 <dd>
 
-**request:** `AthenaIntelligence.agents.SqlAgentRequest` 
+**request:** `AthenaIntelligence.tools.ListEventsCalendarRequest` 
     
 </dd>
 </dl>
@@ -5174,62 +4836,6 @@ await client.agents.sql.invoke({
 <dl>
 <dd>
 
-**requestOptions:** `SqlClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-## Tools Calendar
-<details><summary><code>client.tools.calendar.<a href="/src/api/resources/tools/resources/calendar/client/Client.ts">listEvents</a>() -> unknown</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Coming soon! List calendar events with optional filtering.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.tools.calendar.listEvents();
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
 **requestOptions:** `CalendarClient.RequestOptions` 
     
 </dd>
@@ -5242,7 +4848,8 @@ await client.tools.calendar.listEvents();
 </dl>
 </details>
 
-<details><summary><code>client.tools.calendar.<a href="/src/api/resources/tools/resources/calendar/client/Client.ts">createEvent</a>() -> unknown</code></summary>
+## Tools Email
+<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">createDraft</a>({ ...params }) -> AthenaIntelligence.EmailDraftResponseOut</code></summary>
 <dl>
 <dd>
 
@@ -5254,7 +4861,12 @@ await client.tools.calendar.listEvents();
 <dl>
 <dd>
 
-Coming soon! Create new calendar events.
+Save a draft in the caller's connected Gmail or Outlook account.
+
+Nothing is sent. The draft appears in the account's Drafts folder, where it
+is reviewed, edited and sent from the mail client — that review step is why
+drafting is available here while sending is not. Set `reply_to_message_id`
+to thread the draft as a reply.
 </dd>
 </dl>
 </dd>
@@ -5269,7 +4881,12 @@ Coming soon! Create new calendar events.
 <dd>
 
 ```typescript
-await client.tools.calendar.createEvent();
+await client.tools.email.createDraft({
+    body: "Hi Ada,<br><br>Attached below is the Q3 forecast summary.",
+    cc: ["grace@example.com"],
+    subject: "Q3 forecast",
+    to: ["ada@example.com"]
+});
 
 ```
 </dd>
@@ -5285,58 +4902,10 @@ await client.tools.calendar.createEvent();
 <dl>
 <dd>
 
-**requestOptions:** `CalendarClient.RequestOptions` 
+**request:** `AthenaIntelligence.tools.EmailDraftRequestIn` 
     
 </dd>
 </dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-## Tools Email
-<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">createDraft</a>() -> unknown</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Coming soon! Create email drafts with specified content and recipients.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.tools.email.createDraft();
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
 
 <dl>
 <dd>
@@ -5353,7 +4922,7 @@ await client.tools.email.createDraft();
 </dl>
 </details>
 
-<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">search</a>() -> unknown</code></summary>
+<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">search</a>({ ...params }) -> AthenaIntelligence.EmailSearchResponseOut</code></summary>
 <dl>
 <dd>
 
@@ -5365,7 +4934,11 @@ await client.tools.email.createDraft();
 <dl>
 <dd>
 
-Coming soon! Search through emails with configurable filters.
+Search the caller's connected Gmail or Outlook mailbox.
+
+Results come from the connected account the caller can access in their
+current workspace (the default account unless `catalog_id` names another).
+Unsent drafts are included and flagged with `is_draft`.
 </dd>
 </dl>
 </dd>
@@ -5380,7 +4953,10 @@ Coming soon! Search through emails with configurable filters.
 <dd>
 
 ```typescript
-await client.tools.email.search();
+await client.tools.email.search({
+    query: "from:ada@example.com newer_than:7d",
+    limit: 20
+});
 
 ```
 </dd>
@@ -5396,57 +4972,10 @@ await client.tools.email.search();
 <dl>
 <dd>
 
-**requestOptions:** `EmailClient.RequestOptions` 
+**request:** `AthenaIntelligence.tools.SearchEmailRequest` 
     
 </dd>
 </dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">send</a>() -> unknown</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Coming soon! Send emails to specified recipients.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.tools.email.send();
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
 
 <dl>
 <dd>