agentmail 0.0.64 → 0.0.67

package/reference.md

@@ -2,7 +2,7 @@
 
 ## Inboxes
 
-<details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListInboxesResponse</code></summary>
+<details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">list</a>({ ...params }) -> core.Page<AgentMail.Inbox></code></summary>
 <dl>
 <dd>
 
@@ -15,7 +15,16 @@
 <dd>
 
 ```typescript
-await client.inboxes.list();
+const response = await client.inboxes.list();
+for await (const item of response) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.inboxes.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
 ```
 
 </dd>
@@ -201,7 +210,7 @@ await client.inboxes.delete("inbox_id");
 
 ## Webhooks
 
-<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListWebhooksResponse</code></summary>
+<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>({ ...params }) -> core.Page<AgentMail.Webhook></code></summary>
 <dl>
 <dd>
 
@@ -214,7 +223,16 @@ await client.inboxes.delete("inbox_id");
 <dd>
 
 ```typescript
-await client.webhooks.list();
+const response = await client.webhooks.list();
+for await (const item of response) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.webhooks.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
 ```
 
 </dd>
@@ -400,7 +418,7 @@ await client.webhooks.delete("webhook_id");
 
 ## Domains
 
-<details><summary><code>client.domains.<a href="/src/api/resources/domains/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListDomainsResponse</code></summary>
+<details><summary><code>client.domains.<a href="/src/api/resources/domains/client/Client.ts">list</a>({ ...params }) -> core.Page<AgentMail.DomainSummary></code></summary>
 <dl>
 <dd>
 
@@ -413,7 +431,16 @@ await client.webhooks.delete("webhook_id");
 <dd>
 
 ```typescript
-await client.domains.list();
+const response = await client.domains.list();
+for await (const item of response) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.domains.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
 ```
 
 </dd>
@@ -461,7 +488,7 @@ await client.domains.list();
 <dd>
 
 ```typescript
-await client.domains.get(" your-domain.com");
+await client.domains.get("domain");
 ```
 
 </dd>
@@ -510,7 +537,8 @@ await client.domains.get(" your-domain.com");
 
 ```typescript
 await client.domains.create({
-    domain: "your-domain.com",
+    domain: "domain",
+    feedbackEnabled: undefined,
 });
 ```
 
@@ -559,7 +587,7 @@ await client.domains.create({
 <dd>
 
 ```typescript
-await client.domains.delete("dom_12345");
+await client.domains.delete("domain");
 ```
 
 </dd>
@@ -596,7 +624,7 @@ await client.domains.delete("dom_12345");
 
 ## Drafts
 
-<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListDraftsResponse</code></summary>
+<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">list</a>({ ...params }) -> core.Page<AgentMail.DraftItem></code></summary>
 <dl>
 <dd>
 
@@ -609,7 +637,16 @@ await client.domains.delete("dom_12345");
 <dd>
 
 ```typescript
-await client.drafts.list();
+const response = await client.drafts.list();
+for await (const item of response) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.drafts.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
 ```
 
 </dd>
@@ -694,7 +731,7 @@ await client.drafts.get("draft_id");
 
 ## Inboxes Drafts
 
-<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMail.ListDraftsResponse</code></summary>
+<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">list</a>(inboxId, { ...params }) -> core.Page<AgentMail.DraftItem></code></summary>
 <dl>
 <dd>
 
@@ -707,7 +744,16 @@ await client.drafts.get("draft_id");
 <dd>
 
 ```typescript
-await client.inboxes.drafts.list("inbox_id");
+const response = await client.inboxes.drafts.list("inbox_id");
+for await (const item of response) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.inboxes.drafts.list("inbox_id");
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
 ```
 
 </dd>
@@ -998,7 +1044,7 @@ await client.inboxes.drafts.delete("inbox_id", "draft_id");
 
 ## Inboxes Messages
 
-<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMail.ListMessagesResponse</code></summary>
+<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">list</a>(inboxId, { ...params }) -> core.Page<AgentMail.MessageItem></code></summary>
 <dl>
 <dd>
 
@@ -1011,7 +1057,16 @@ await client.inboxes.drafts.delete("inbox_id", "draft_id");
 <dd>
 
 ```typescript
-await client.inboxes.messages.list("inbox_id");
+const response = await client.inboxes.messages.list("inbox_id");
+for await (const item of response) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.inboxes.messages.list("inbox_id");
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
 ```
 
 </dd>
@@ -1499,7 +1554,7 @@ await client.inboxes.metrics.get("inbox_id", {
 
 ## Inboxes Threads
 
-<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMail.ListThreadsResponse</code></summary>
+<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">list</a>(inboxId, { ...params }) -> core.Page<AgentMail.ThreadItem></code></summary>
 <dl>
 <dd>
 
@@ -1512,7 +1567,16 @@ await client.inboxes.metrics.get("inbox_id", {
 <dd>
 
 ```typescript
-await client.inboxes.threads.list("inbox_id");
+const response = await client.inboxes.threads.list("inbox_id");
+for await (const item of response) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.inboxes.threads.list("inbox_id");
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
 ```
 
 </dd>
@@ -1786,7 +1850,7 @@ await client.metrics.list({
 
 ## Threads
 
-<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListThreadsResponse</code></summary>
+<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>({ ...params }) -> core.Page<AgentMail.ThreadItem></code></summary>
 <dl>
 <dd>
 
@@ -1799,7 +1863,16 @@ await client.metrics.list({
 <dd>
 
 ```typescript
-await client.threads.list();
+const response = await client.threads.list();
+for await (const item of response) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.threads.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
 ```
 
 </dd>