agentmail 0.5.7 → 0.5.9

package/reference.md

@@ -1295,6 +1295,67 @@ await client.apiKeys.delete("api_key_id");
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Auth
+<details><summary><code>client.auth.<a href="/src/api/resources/auth/client/Client.ts">me</a>() -> AgentMail.Identity</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns the identity and scope of the authenticated credential. Useful when a client holds a pod-scoped or inbox-scoped API key and needs to discover the parent organization, pod, or inbox without prior knowledge.
+
+**CLI:**
+```bash
+agentmail auth me
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.auth.me();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `AuthClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -3199,6 +3260,12 @@ await client.inboxes.lists.delete("inbox_id", "send", "allow", "entry");
 <dl>
 <dd>
 
+Lists messages in the inbox, most recent first. Pass `from`, `to`, or
+`subject` to filter by substring. Filtered requests are served by
+search, which caps `limit` at 100. For relevance-ranked full-text
+search across sender, recipients, subject, and message body, use
+`Search Messages`.
+
 **CLI:**
 ```bash
 agentmail inboxes:messages list --inbox-id <inbox_id>
@@ -3257,6 +3324,82 @@ await client.inboxes.messages.list("inbox_id");
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">search</a>(inbox_id, { ...params }) -> AgentMail.SearchMessagesResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Full-text search across messages in the inbox, ranked by relevance. The
+query is matched against the sender, recipients, and subject (substring)
+and the message body (tokenized full text). Spam, trash, blocked, and
+unauthenticated messages are always excluded. `limit` cannot exceed 100.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.inboxes.messages.search("inbox_id", {
+    q: "q"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**inbox_id:** `AgentMail.InboxId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `AgentMail.inboxes.SearchMessagesRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `MessagesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -4137,6 +4280,11 @@ await client.inboxes.metrics.query("inbox_id");
 <dl>
 <dd>
 
+Lists threads in the inbox, most recent first. Pass `senders`,
+`recipients`, or `subject` to filter by substring. Filtered requests are
+served by search, which caps `limit` at 100. For relevance-ranked
+full-text search, use `Search Threads`.
+
 **CLI:**
 ```bash
 agentmail inboxes:threads list --inbox-id <inbox_id>
@@ -4195,6 +4343,82 @@ await client.inboxes.threads.list("inbox_id");
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">search</a>(inbox_id, { ...params }) -> AgentMail.SearchThreadsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Full-text search across threads in the inbox, ranked by relevance. The
+query is matched against senders, recipients, and subject (substring)
+and the message body (tokenized full text). Spam, trash, blocked, and
+unauthenticated threads are always excluded. `limit` cannot exceed 100.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.inboxes.threads.search("inbox_id", {
+    q: "q"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**inbox_id:** `AgentMail.InboxId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `AgentMail.inboxes.SearchThreadsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ThreadsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -6791,6 +7015,11 @@ await client.pods.metrics.query("pod_id");
 <dl>
 <dd>
 
+Lists threads in the pod, most recent first. Pass `senders`,
+`recipients`, or `subject` to filter by substring. Filtered requests are
+served by search, which caps `limit` at 100. For relevance-ranked
+full-text search, use `Search Threads`.
+
 **CLI:**
 ```bash
 agentmail pods:threads list --pod-id <pod_id>
@@ -6849,6 +7078,82 @@ await client.pods.threads.list("pod_id");
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">search</a>(pod_id, { ...params }) -> AgentMail.SearchThreadsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Full-text search across threads in the pod, ranked by relevance. The
+query is matched against senders, recipients, and subject (substring)
+and the message body (tokenized full text). Spam, trash, blocked, and
+unauthenticated threads are always excluded. `limit` cannot exceed 100.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.pods.threads.search("pod_id", {
+    q: "q"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**pod_id:** `AgentMail.PodId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `AgentMail.pods.SearchThreadsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ThreadsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -7185,6 +7490,12 @@ await client.pods.threads.delete("pod_id", "thread_id");
 <dl>
 <dd>
 
+Lists threads, most recent first. Pass `senders`, `recipients`, or
+`subject` to filter by substring. Filtered requests are served by
+search, which caps `limit` at 100. For relevance-ranked full-text
+search across senders, recipients, subject, and message body, use
+`Search Threads`.
+
 **CLI:**
 ```bash
 agentmail threads list
@@ -7235,6 +7546,75 @@ await client.threads.list();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">search</a>({ ...params }) -> AgentMail.SearchThreadsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Full-text search across threads in the organization, ranked by
+relevance. The query is matched against senders, recipients, and
+subject (substring) and the message body (tokenized full text). Spam,
+trash, blocked, and unauthenticated threads are always excluded.
+`limit` cannot exceed 100.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.threads.search({
+    q: "q"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `AgentMail.SearchThreadsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ThreadsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>