@athenaintel/sdk 4.3.2158 → 4.3.2159
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/errors/TooManyRequestsError.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/calendar/client/Client.d.ts +20 -13
- package/dist/cjs/api/resources/tools/resources/calendar/client/Client.js +70 -71
- package/dist/cjs/api/resources/tools/resources/calendar/client/index.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/calendar/client/index.js +15 -0
- package/dist/cjs/api/resources/tools/resources/calendar/client/requests/ListEventsCalendarRequest.d.ts +22 -0
- package/dist/cjs/api/resources/tools/resources/calendar/client/requests/ListEventsCalendarRequest.js +3 -0
- package/dist/cjs/api/resources/tools/resources/calendar/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/tools/resources/calendar/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tools/resources/email/client/Client.d.ts +40 -16
- package/dist/cjs/api/resources/tools/resources/email/client/Client.js +105 -82
- package/dist/cjs/api/resources/tools/resources/email/client/index.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/email/client/index.js +15 -0
- package/dist/cjs/api/resources/tools/resources/email/client/requests/EmailDraftRequestIn.d.ts +27 -0
- package/dist/cjs/api/resources/tools/resources/email/client/requests/EmailDraftRequestIn.js +3 -0
- package/dist/cjs/api/resources/tools/resources/email/client/requests/SearchEmailRequest.d.ts +15 -0
- package/dist/cjs/api/resources/tools/resources/email/client/requests/SearchEmailRequest.js +3 -0
- package/dist/cjs/api/resources/tools/resources/email/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/tools/resources/email/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tools/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/tools/resources/index.js +5 -3
- package/dist/cjs/api/types/CalendarAttendeeOut.d.ts +11 -0
- package/dist/cjs/api/types/CalendarAttendeeOut.js +3 -0
- package/dist/cjs/api/types/CalendarEventOut.d.ts +28 -0
- package/dist/cjs/api/types/CalendarEventOut.js +3 -0
- package/dist/cjs/api/types/CalendarEventsResponseOut.d.ts +14 -0
- package/dist/cjs/api/types/CalendarEventsResponseOut.js +3 -0
- package/dist/cjs/api/types/EmailDraftResponseOut.d.ts +23 -0
- package/dist/cjs/api/types/EmailDraftResponseOut.js +3 -0
- package/dist/cjs/api/types/EmailSearchResponseOut.d.ts +22 -0
- package/dist/cjs/api/types/EmailSearchResponseOut.js +3 -0
- package/dist/cjs/api/types/EmailSearchResultOut.d.ts +25 -0
- package/dist/cjs/api/types/EmailSearchResultOut.js +3 -0
- package/dist/cjs/api/types/index.d.ts +6 -0
- package/dist/cjs/api/types/index.js +6 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/errors/TooManyRequestsError.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/calendar/client/Client.d.mts +20 -13
- package/dist/esm/api/resources/tools/resources/calendar/client/Client.mjs +70 -71
- package/dist/esm/api/resources/tools/resources/calendar/client/index.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/calendar/client/index.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/calendar/client/requests/ListEventsCalendarRequest.d.mts +22 -0
- package/dist/esm/api/resources/tools/resources/calendar/client/requests/ListEventsCalendarRequest.mjs +2 -0
- package/dist/esm/api/resources/tools/resources/calendar/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/tools/resources/calendar/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tools/resources/email/client/Client.d.mts +40 -16
- package/dist/esm/api/resources/tools/resources/email/client/Client.mjs +105 -82
- package/dist/esm/api/resources/tools/resources/email/client/index.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/email/client/index.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/email/client/requests/EmailDraftRequestIn.d.mts +27 -0
- package/dist/esm/api/resources/tools/resources/email/client/requests/EmailDraftRequestIn.mjs +2 -0
- package/dist/esm/api/resources/tools/resources/email/client/requests/SearchEmailRequest.d.mts +15 -0
- package/dist/esm/api/resources/tools/resources/email/client/requests/SearchEmailRequest.mjs +2 -0
- package/dist/esm/api/resources/tools/resources/email/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/tools/resources/email/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tools/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/tools/resources/index.mjs +2 -0
- package/dist/esm/api/types/CalendarAttendeeOut.d.mts +11 -0
- package/dist/esm/api/types/CalendarAttendeeOut.mjs +2 -0
- package/dist/esm/api/types/CalendarEventOut.d.mts +28 -0
- package/dist/esm/api/types/CalendarEventOut.mjs +2 -0
- package/dist/esm/api/types/CalendarEventsResponseOut.d.mts +14 -0
- package/dist/esm/api/types/CalendarEventsResponseOut.mjs +2 -0
- package/dist/esm/api/types/EmailDraftResponseOut.d.mts +23 -0
- package/dist/esm/api/types/EmailDraftResponseOut.mjs +2 -0
- package/dist/esm/api/types/EmailSearchResponseOut.d.mts +22 -0
- package/dist/esm/api/types/EmailSearchResponseOut.mjs +2 -0
- package/dist/esm/api/types/EmailSearchResultOut.d.mts +25 -0
- package/dist/esm/api/types/EmailSearchResultOut.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +6 -0
- package/dist/esm/api/types/index.mjs +6 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +44 -105
package/dist/esm/api/resources/tools/resources/email/client/requests/EmailDraftRequestIn.d.mts
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* body: "Hi Ada,<br><br>Attached below is the Q3 forecast summary.",
|
|
5
|
+
* cc: ["grace@example.com"],
|
|
6
|
+
* subject: "Q3 forecast",
|
|
7
|
+
* to: ["ada@example.com"]
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface EmailDraftRequestIn {
|
|
11
|
+
/** BCC recipients. */
|
|
12
|
+
bcc?: string[] | null;
|
|
13
|
+
/** Body content. HTML is supported; plain-text newlines become line breaks. Do not write a signature into it — the account's signature is appended automatically (see `include_signature`). */
|
|
14
|
+
body: string;
|
|
15
|
+
/** Connected email account to use, as the catalog asset id returned by the Athena UI or the assets API. Defaults to the caller's default email account. An id that is not one of the caller's own connected accounts in the current workspace is a 404. */
|
|
16
|
+
catalog_id?: string | null;
|
|
17
|
+
/** CC recipients. */
|
|
18
|
+
cc?: string[] | null;
|
|
19
|
+
/** Optional: Whether to append the sending account's own signature at the end of the body. Leave unset to follow the user's saved preference for this account (which distinguishes new messages from replies) — that is almost always the right choice. Set false only when the user asks for no signature. Never write a signature into the body yourself: the real one is read from the account and appended automatically. */
|
|
20
|
+
include_signature?: boolean | null;
|
|
21
|
+
/** Provider message id (from `GET /tools/email/search`) to reply to, so the draft is threaded under that message. Outlook rejects an id it cannot find (404). Gmail saves the draft *unthreaded* when the referenced message cannot be read, and `reply_to_message_id` in the response tells you which happened. */
|
|
22
|
+
reply_to_message_id?: string | null;
|
|
23
|
+
/** Subject line. */
|
|
24
|
+
subject: string;
|
|
25
|
+
/** Recipient email addresses. */
|
|
26
|
+
to: string[];
|
|
27
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* query: "from:ada@example.com newer_than:7d",
|
|
5
|
+
* limit: 20
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface SearchEmailRequest {
|
|
9
|
+
/** Search query. Gmail operators (`from:`, `to:`, `subject:`, `has:attachment`, `newer_than:7d`, `-term`, …) are accepted for both providers; operators with no Outlook equivalent are dropped and reported in `ignored_operators`. Use `in:drafts` to search only unsent drafts. */
|
|
10
|
+
query: string;
|
|
11
|
+
/** Connected email account to use, as the catalog asset id returned by the Athena UI or the assets API. Defaults to the caller's default email account. An id that is not one of the caller's own connected accounts in the current workspace is a 404. */
|
|
12
|
+
catalog_id?: string | null;
|
|
13
|
+
/** Maximum number of results (1-50). */
|
|
14
|
+
limit?: number;
|
|
15
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,4 +1,6 @@
|
|
|
1
|
+
export * from "./calendar/client/requests/index.mjs";
|
|
1
2
|
export * as calendar from "./calendar/index.mjs";
|
|
3
|
+
export * from "./email/client/requests/index.mjs";
|
|
2
4
|
export * as email from "./email/index.mjs";
|
|
3
5
|
export * from "./sheets/client/requests/index.mjs";
|
|
4
6
|
export * as sheets from "./sheets/index.mjs";
|
|
@@ -1,4 +1,6 @@
|
|
|
1
|
+
export * from "./calendar/client/requests/index.mjs";
|
|
1
2
|
export * as calendar from "./calendar/index.mjs";
|
|
3
|
+
export * from "./email/client/requests/index.mjs";
|
|
2
4
|
export * as email from "./email/index.mjs";
|
|
3
5
|
export * from "./sheets/client/requests/index.mjs";
|
|
4
6
|
export * as sheets from "./sheets/index.mjs";
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One attendee of a calendar event.
|
|
3
|
+
*/
|
|
4
|
+
export interface CalendarAttendeeOut {
|
|
5
|
+
/** Attendee email address. */
|
|
6
|
+
email?: string;
|
|
7
|
+
/** Attendee display name, if known. */
|
|
8
|
+
name?: string;
|
|
9
|
+
/** Attendee response, in the provider's vocabulary. */
|
|
10
|
+
response_status?: string;
|
|
11
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type * as AthenaIntelligence from "../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* One calendar event.
|
|
4
|
+
*/
|
|
5
|
+
export interface CalendarEventOut {
|
|
6
|
+
/** Attendees and their responses. */
|
|
7
|
+
attendees?: AthenaIntelligence.CalendarAttendeeOut[];
|
|
8
|
+
/** Meet / Teams / other conferencing join link, if any. */
|
|
9
|
+
conferencing_url?: string;
|
|
10
|
+
/** Description or body preview. */
|
|
11
|
+
description?: string;
|
|
12
|
+
/** End time, ISO 8601. */
|
|
13
|
+
end?: string;
|
|
14
|
+
/** Link to the event in Google Calendar. Gmail accounts only. */
|
|
15
|
+
html_link?: string | null;
|
|
16
|
+
/** Provider event id. */
|
|
17
|
+
id: string;
|
|
18
|
+
/** Location, if set. */
|
|
19
|
+
location?: string;
|
|
20
|
+
/** Start time, ISO 8601. */
|
|
21
|
+
start?: string;
|
|
22
|
+
/** Event status. Gmail accounts only. */
|
|
23
|
+
status?: string | null;
|
|
24
|
+
/** Event title. */
|
|
25
|
+
title?: string;
|
|
26
|
+
/** Link to the event in Outlook. Outlook accounts only. */
|
|
27
|
+
web_link?: string | null;
|
|
28
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type * as AthenaIntelligence from "../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Result of `GET /tools/calendar/events`.
|
|
4
|
+
*/
|
|
5
|
+
export interface CalendarEventsResponseOut {
|
|
6
|
+
/** The connected account that was read. */
|
|
7
|
+
catalog_id: string;
|
|
8
|
+
/** Number of events returned. */
|
|
9
|
+
count: number;
|
|
10
|
+
/** Account provider as Athena reports it: `gmail` or `outlook` for accounts connected through the Integrations page; `google` or `microsoft365` for directly-connected accounts (read-only for drafts). */
|
|
11
|
+
provider: string;
|
|
12
|
+
/** Matching events in ascending start order. */
|
|
13
|
+
results?: AthenaIntelligence.CalendarEventOut[];
|
|
14
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Result of `POST /tools/email/draft`.
|
|
3
|
+
*/
|
|
4
|
+
export interface EmailDraftResponseOut {
|
|
5
|
+
/** The connected account the draft is in. */
|
|
6
|
+
catalog_id: string;
|
|
7
|
+
/** Provider draft id. Open, edit, or send it in the mail client. */
|
|
8
|
+
draft_id?: string | null;
|
|
9
|
+
/** The address the draft will be sent from. */
|
|
10
|
+
email_address?: string | null;
|
|
11
|
+
/** Human-readable outcome, when the provider reports one. */
|
|
12
|
+
message?: string | null;
|
|
13
|
+
/** Provider message id backing the draft. Gmail accounts only. */
|
|
14
|
+
message_id?: string | null;
|
|
15
|
+
/** Account provider as Athena reports it: `gmail` or `outlook` for accounts connected through the Integrations page; `google` or `microsoft365` for directly-connected accounts (read-only for drafts). */
|
|
16
|
+
provider: string;
|
|
17
|
+
/** The message this draft replies to, when it is a reply. */
|
|
18
|
+
reply_to_message_id?: string | null;
|
|
19
|
+
/** Whether the draft was saved. */
|
|
20
|
+
success: boolean;
|
|
21
|
+
/** Athena email-tracking id, when tracking is enabled on the account. */
|
|
22
|
+
tracking_id?: string | null;
|
|
23
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type * as AthenaIntelligence from "../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Result of `GET /tools/email/search`.
|
|
4
|
+
*/
|
|
5
|
+
export interface EmailSearchResponseOut {
|
|
6
|
+
/** The connected account that was searched. */
|
|
7
|
+
catalog_id: string;
|
|
8
|
+
/** Number of results returned. */
|
|
9
|
+
count: number;
|
|
10
|
+
/** How many of the results are unsent drafts. */
|
|
11
|
+
draft_count?: number;
|
|
12
|
+
/** Gmail search operators that have no Outlook equivalent and were dropped from the query. Outlook accounts only. */
|
|
13
|
+
ignored_operators?: string[] | null;
|
|
14
|
+
/** Human-readable caveats about the results, when there are any. */
|
|
15
|
+
note?: string | null;
|
|
16
|
+
/** Account provider as Athena reports it: `gmail` or `outlook` for accounts connected through the Integrations page; `google` or `microsoft365` for directly-connected accounts (read-only for drafts). */
|
|
17
|
+
provider: string;
|
|
18
|
+
/** The query as executed. */
|
|
19
|
+
query: string;
|
|
20
|
+
/** Matching messages, newest first. */
|
|
21
|
+
results?: AthenaIntelligence.EmailSearchResultOut[];
|
|
22
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One message matched by an email search.
|
|
3
|
+
*/
|
|
4
|
+
export interface EmailSearchResultOut {
|
|
5
|
+
/** Microsoft Graph conversation id. Outlook accounts only. */
|
|
6
|
+
conversation_id?: string | null;
|
|
7
|
+
/** Sent or received timestamp, in the provider's format. */
|
|
8
|
+
date?: string;
|
|
9
|
+
/** Provider draft id, when the provider exposes one for a draft. */
|
|
10
|
+
draft_id?: string | null;
|
|
11
|
+
/** Sender, as the provider reports it. */
|
|
12
|
+
from?: string;
|
|
13
|
+
/** Provider message id (Gmail message id, or Microsoft Graph message id for Outlook). This — never an Athena asset id — is what `reply_to_message_id` accepts. */
|
|
14
|
+
id: string;
|
|
15
|
+
/** True when the message is an unsent draft sitting in the mailbox. Drafts are never sent or received mail and cannot be replied to. */
|
|
16
|
+
is_draft?: boolean;
|
|
17
|
+
/** Short plain-text preview. */
|
|
18
|
+
snippet?: string;
|
|
19
|
+
/** Subject line. */
|
|
20
|
+
subject?: string;
|
|
21
|
+
/** Gmail thread id. Gmail accounts only. */
|
|
22
|
+
thread_id?: string | null;
|
|
23
|
+
/** Recipients, comma-separated as the provider reports them. */
|
|
24
|
+
to?: string;
|
|
25
|
+
}
|
|
@@ -23,6 +23,9 @@ export * from "./AssetScreenshotResponseOut.mjs";
|
|
|
23
23
|
export * from "./BorderModel.mjs";
|
|
24
24
|
export * from "./BorderStyle.mjs";
|
|
25
25
|
export * from "./BordersModel.mjs";
|
|
26
|
+
export * from "./CalendarAttendeeOut.mjs";
|
|
27
|
+
export * from "./CalendarEventOut.mjs";
|
|
28
|
+
export * from "./CalendarEventsResponseOut.mjs";
|
|
26
29
|
export * from "./CellFormat.mjs";
|
|
27
30
|
export * from "./Chunk.mjs";
|
|
28
31
|
export * from "./ChunkContentItem.mjs";
|
|
@@ -56,6 +59,9 @@ export * from "./DeployComputerResponseOut.mjs";
|
|
|
56
59
|
export * from "./DimensionProperties.mjs";
|
|
57
60
|
export * from "./DriveAgentResponse.mjs";
|
|
58
61
|
export * from "./DuplicateAssetResponseOut.mjs";
|
|
62
|
+
export * from "./EmailDraftResponseOut.mjs";
|
|
63
|
+
export * from "./EmailSearchResponseOut.mjs";
|
|
64
|
+
export * from "./EmailSearchResultOut.mjs";
|
|
59
65
|
export * from "./FileTooLargeError.mjs";
|
|
60
66
|
export * from "./FolderResponse.mjs";
|
|
61
67
|
export * from "./GeneralAgentConfig.mjs";
|
|
@@ -23,6 +23,9 @@ export * from "./AssetScreenshotResponseOut.mjs";
|
|
|
23
23
|
export * from "./BorderModel.mjs";
|
|
24
24
|
export * from "./BorderStyle.mjs";
|
|
25
25
|
export * from "./BordersModel.mjs";
|
|
26
|
+
export * from "./CalendarAttendeeOut.mjs";
|
|
27
|
+
export * from "./CalendarEventOut.mjs";
|
|
28
|
+
export * from "./CalendarEventsResponseOut.mjs";
|
|
26
29
|
export * from "./CellFormat.mjs";
|
|
27
30
|
export * from "./Chunk.mjs";
|
|
28
31
|
export * from "./ChunkContentItem.mjs";
|
|
@@ -56,6 +59,9 @@ export * from "./DeployComputerResponseOut.mjs";
|
|
|
56
59
|
export * from "./DimensionProperties.mjs";
|
|
57
60
|
export * from "./DriveAgentResponse.mjs";
|
|
58
61
|
export * from "./DuplicateAssetResponseOut.mjs";
|
|
62
|
+
export * from "./EmailDraftResponseOut.mjs";
|
|
63
|
+
export * from "./EmailSearchResponseOut.mjs";
|
|
64
|
+
export * from "./EmailSearchResultOut.mjs";
|
|
59
65
|
export * from "./FileTooLargeError.mjs";
|
|
60
66
|
export * from "./FolderResponse.mjs";
|
|
61
67
|
export * from "./GeneralAgentConfig.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "4.3.
|
|
1
|
+
export declare const SDK_VERSION = "4.3.2159";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "4.3.
|
|
1
|
+
export const SDK_VERSION = "4.3.2159";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -5187,7 +5187,7 @@ await client.agents.sql.invoke({
|
|
|
5187
5187
|
</details>
|
|
5188
5188
|
|
|
5189
5189
|
## Tools Calendar
|
|
5190
|
-
<details><summary><code>client.tools.calendar.<a href="/src/api/resources/tools/resources/calendar/client/Client.ts">listEvents</a>() ->
|
|
5190
|
+
<details><summary><code>client.tools.calendar.<a href="/src/api/resources/tools/resources/calendar/client/Client.ts">listEvents</a>({ ...params }) -> AthenaIntelligence.CalendarEventsResponseOut</code></summary>
|
|
5191
5191
|
<dl>
|
|
5192
5192
|
<dd>
|
|
5193
5193
|
|
|
@@ -5199,7 +5199,13 @@ await client.agents.sql.invoke({
|
|
|
5199
5199
|
<dl>
|
|
5200
5200
|
<dd>
|
|
5201
5201
|
|
|
5202
|
-
|
|
5202
|
+
List events on the calendar of the caller's connected account.
|
|
5203
|
+
|
|
5204
|
+
Reads the primary Google Calendar of a Gmail account or the default calendar
|
|
5205
|
+
of an Outlook account. `start`/`end` select the events overlapping that
|
|
5206
|
+
window; without them, Outlook returns recurring series as single entries, so
|
|
5207
|
+
supply a window to expand them. `title`, `location` and `attendees` filter the
|
|
5208
|
+
events that were read.
|
|
5203
5209
|
</dd>
|
|
5204
5210
|
</dl>
|
|
5205
5211
|
</dd>
|
|
@@ -5214,7 +5220,9 @@ Coming soon! List calendar events with optional filtering.
|
|
|
5214
5220
|
<dd>
|
|
5215
5221
|
|
|
5216
5222
|
```typescript
|
|
5217
|
-
await client.tools.calendar.listEvents(
|
|
5223
|
+
await client.tools.calendar.listEvents({
|
|
5224
|
+
limit: 50
|
|
5225
|
+
});
|
|
5218
5226
|
|
|
5219
5227
|
```
|
|
5220
5228
|
</dd>
|
|
@@ -5230,58 +5238,11 @@ await client.tools.calendar.listEvents();
|
|
|
5230
5238
|
<dl>
|
|
5231
5239
|
<dd>
|
|
5232
5240
|
|
|
5233
|
-
**
|
|
5241
|
+
**request:** `AthenaIntelligence.tools.ListEventsCalendarRequest`
|
|
5234
5242
|
|
|
5235
|
-
</dd>
|
|
5236
|
-
</dl>
|
|
5237
|
-
</dd>
|
|
5238
|
-
</dl>
|
|
5239
|
-
|
|
5240
|
-
|
|
5241
|
-
</dd>
|
|
5242
|
-
</dl>
|
|
5243
|
-
</details>
|
|
5244
|
-
|
|
5245
|
-
<details><summary><code>client.tools.calendar.<a href="/src/api/resources/tools/resources/calendar/client/Client.ts">createEvent</a>() -> unknown</code></summary>
|
|
5246
|
-
<dl>
|
|
5247
|
-
<dd>
|
|
5248
|
-
|
|
5249
|
-
#### 📝 Description
|
|
5250
|
-
|
|
5251
|
-
<dl>
|
|
5252
|
-
<dd>
|
|
5253
|
-
|
|
5254
|
-
<dl>
|
|
5255
|
-
<dd>
|
|
5256
|
-
|
|
5257
|
-
Coming soon! Create new calendar events.
|
|
5258
|
-
</dd>
|
|
5259
|
-
</dl>
|
|
5260
5243
|
</dd>
|
|
5261
5244
|
</dl>
|
|
5262
5245
|
|
|
5263
|
-
#### 🔌 Usage
|
|
5264
|
-
|
|
5265
|
-
<dl>
|
|
5266
|
-
<dd>
|
|
5267
|
-
|
|
5268
|
-
<dl>
|
|
5269
|
-
<dd>
|
|
5270
|
-
|
|
5271
|
-
```typescript
|
|
5272
|
-
await client.tools.calendar.createEvent();
|
|
5273
|
-
|
|
5274
|
-
```
|
|
5275
|
-
</dd>
|
|
5276
|
-
</dl>
|
|
5277
|
-
</dd>
|
|
5278
|
-
</dl>
|
|
5279
|
-
|
|
5280
|
-
#### ⚙️ Parameters
|
|
5281
|
-
|
|
5282
|
-
<dl>
|
|
5283
|
-
<dd>
|
|
5284
|
-
|
|
5285
5246
|
<dl>
|
|
5286
5247
|
<dd>
|
|
5287
5248
|
|
|
@@ -5298,7 +5259,7 @@ await client.tools.calendar.createEvent();
|
|
|
5298
5259
|
</details>
|
|
5299
5260
|
|
|
5300
5261
|
## Tools Email
|
|
5301
|
-
<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">createDraft</a>() ->
|
|
5262
|
+
<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">createDraft</a>({ ...params }) -> AthenaIntelligence.EmailDraftResponseOut</code></summary>
|
|
5302
5263
|
<dl>
|
|
5303
5264
|
<dd>
|
|
5304
5265
|
|
|
@@ -5310,7 +5271,12 @@ await client.tools.calendar.createEvent();
|
|
|
5310
5271
|
<dl>
|
|
5311
5272
|
<dd>
|
|
5312
5273
|
|
|
5313
|
-
|
|
5274
|
+
Save a draft in the caller's connected Gmail or Outlook account.
|
|
5275
|
+
|
|
5276
|
+
Nothing is sent. The draft appears in the account's Drafts folder, where it
|
|
5277
|
+
is reviewed, edited and sent from the mail client — that review step is why
|
|
5278
|
+
drafting is available here while sending is not. Set `reply_to_message_id`
|
|
5279
|
+
to thread the draft as a reply.
|
|
5314
5280
|
</dd>
|
|
5315
5281
|
</dl>
|
|
5316
5282
|
</dd>
|
|
@@ -5325,7 +5291,12 @@ Coming soon! Create email drafts with specified content and recipients.
|
|
|
5325
5291
|
<dd>
|
|
5326
5292
|
|
|
5327
5293
|
```typescript
|
|
5328
|
-
await client.tools.email.createDraft(
|
|
5294
|
+
await client.tools.email.createDraft({
|
|
5295
|
+
body: "Hi Ada,<br><br>Attached below is the Q3 forecast summary.",
|
|
5296
|
+
cc: ["grace@example.com"],
|
|
5297
|
+
subject: "Q3 forecast",
|
|
5298
|
+
to: ["ada@example.com"]
|
|
5299
|
+
});
|
|
5329
5300
|
|
|
5330
5301
|
```
|
|
5331
5302
|
</dd>
|
|
@@ -5341,57 +5312,10 @@ await client.tools.email.createDraft();
|
|
|
5341
5312
|
<dl>
|
|
5342
5313
|
<dd>
|
|
5343
5314
|
|
|
5344
|
-
**
|
|
5315
|
+
**request:** `AthenaIntelligence.tools.EmailDraftRequestIn`
|
|
5345
5316
|
|
|
5346
5317
|
</dd>
|
|
5347
5318
|
</dl>
|
|
5348
|
-
</dd>
|
|
5349
|
-
</dl>
|
|
5350
|
-
|
|
5351
|
-
|
|
5352
|
-
</dd>
|
|
5353
|
-
</dl>
|
|
5354
|
-
</details>
|
|
5355
|
-
|
|
5356
|
-
<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">search</a>() -> unknown</code></summary>
|
|
5357
|
-
<dl>
|
|
5358
|
-
<dd>
|
|
5359
|
-
|
|
5360
|
-
#### 📝 Description
|
|
5361
|
-
|
|
5362
|
-
<dl>
|
|
5363
|
-
<dd>
|
|
5364
|
-
|
|
5365
|
-
<dl>
|
|
5366
|
-
<dd>
|
|
5367
|
-
|
|
5368
|
-
Coming soon! Search through emails with configurable filters.
|
|
5369
|
-
</dd>
|
|
5370
|
-
</dl>
|
|
5371
|
-
</dd>
|
|
5372
|
-
</dl>
|
|
5373
|
-
|
|
5374
|
-
#### 🔌 Usage
|
|
5375
|
-
|
|
5376
|
-
<dl>
|
|
5377
|
-
<dd>
|
|
5378
|
-
|
|
5379
|
-
<dl>
|
|
5380
|
-
<dd>
|
|
5381
|
-
|
|
5382
|
-
```typescript
|
|
5383
|
-
await client.tools.email.search();
|
|
5384
|
-
|
|
5385
|
-
```
|
|
5386
|
-
</dd>
|
|
5387
|
-
</dl>
|
|
5388
|
-
</dd>
|
|
5389
|
-
</dl>
|
|
5390
|
-
|
|
5391
|
-
#### ⚙️ Parameters
|
|
5392
|
-
|
|
5393
|
-
<dl>
|
|
5394
|
-
<dd>
|
|
5395
5319
|
|
|
5396
5320
|
<dl>
|
|
5397
5321
|
<dd>
|
|
@@ -5408,7 +5332,7 @@ await client.tools.email.search();
|
|
|
5408
5332
|
</dl>
|
|
5409
5333
|
</details>
|
|
5410
5334
|
|
|
5411
|
-
<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">
|
|
5335
|
+
<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">search</a>({ ...params }) -> AthenaIntelligence.EmailSearchResponseOut</code></summary>
|
|
5412
5336
|
<dl>
|
|
5413
5337
|
<dd>
|
|
5414
5338
|
|
|
@@ -5420,7 +5344,11 @@ await client.tools.email.search();
|
|
|
5420
5344
|
<dl>
|
|
5421
5345
|
<dd>
|
|
5422
5346
|
|
|
5423
|
-
|
|
5347
|
+
Search the caller's connected Gmail or Outlook mailbox.
|
|
5348
|
+
|
|
5349
|
+
Results come from the connected account the caller can access in their
|
|
5350
|
+
current workspace (the default account unless `catalog_id` names another).
|
|
5351
|
+
Unsent drafts are included and flagged with `is_draft`.
|
|
5424
5352
|
</dd>
|
|
5425
5353
|
</dl>
|
|
5426
5354
|
</dd>
|
|
@@ -5435,7 +5363,10 @@ Coming soon! Send emails to specified recipients.
|
|
|
5435
5363
|
<dd>
|
|
5436
5364
|
|
|
5437
5365
|
```typescript
|
|
5438
|
-
await client.tools.email.
|
|
5366
|
+
await client.tools.email.search({
|
|
5367
|
+
query: "from:ada@example.com newer_than:7d",
|
|
5368
|
+
limit: 20
|
|
5369
|
+
});
|
|
5439
5370
|
|
|
5440
5371
|
```
|
|
5441
5372
|
</dd>
|
|
@@ -5451,6 +5382,14 @@ await client.tools.email.send();
|
|
|
5451
5382
|
<dl>
|
|
5452
5383
|
<dd>
|
|
5453
5384
|
|
|
5385
|
+
**request:** `AthenaIntelligence.tools.SearchEmailRequest`
|
|
5386
|
+
|
|
5387
|
+
</dd>
|
|
5388
|
+
</dl>
|
|
5389
|
+
|
|
5390
|
+
<dl>
|
|
5391
|
+
<dd>
|
|
5392
|
+
|
|
5454
5393
|
**requestOptions:** `EmailClient.RequestOptions`
|
|
5455
5394
|
|
|
5456
5395
|
</dd>
|