agentmail 0.0.78 → 0.1.1

package/reference.md

@@ -1,6 +1,6 @@
 # Reference
 ## 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, AgentMail.ListInboxesResponse></code></summary>
 <dl>
 <dd>
 
@@ -13,7 +13,19 @@
 <dd>
 
 ```typescript
-await client.inboxes.list();
+const pageableResponse = await client.inboxes.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.inboxes.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -197,7 +209,7 @@ await client.inboxes.delete("inbox_id");
 </details>
 
 ## Pods
-<details><summary><code>client.pods.<a href="/src/api/resources/pods/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListPodsResponse</code></summary>
+<details><summary><code>client.pods.<a href="/src/api/resources/pods/client/Client.ts">list</a>({ ...params }) -> core.Page<AgentMail.Pod, AgentMail.ListPodsResponse></code></summary>
 <dl>
 <dd>
 
@@ -210,7 +222,19 @@ await client.inboxes.delete("inbox_id");
 <dd>
 
 ```typescript
-await client.pods.list();
+const pageableResponse = await client.pods.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.pods.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -394,7 +418,7 @@ await client.pods.delete("pod_id");
 </details>
 
 ## 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, AgentMail.ListWebhooksResponse></code></summary>
 <dl>
 <dd>
 
@@ -407,7 +431,19 @@ await client.pods.delete("pod_id");
 <dd>
 
 ```typescript
-await client.webhooks.list();
+const pageableResponse = await client.webhooks.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.webhooks.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -594,7 +630,7 @@ await client.webhooks.delete("webhook_id");
 </details>
 
 ## ApiKeys
-<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListApiKeysResponse</code></summary>
+<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">list</a>({ ...params }) -> core.Page<AgentMail.ApiKey, AgentMail.ListApiKeysResponse></code></summary>
 <dl>
 <dd>
 
@@ -607,7 +643,19 @@ await client.webhooks.delete("webhook_id");
 <dd>
 
 ```typescript
-await client.apiKeys.list();
+const pageableResponse = await client.apiKeys.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.apiKeys.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -744,7 +792,7 @@ await client.apiKeys.delete("api_key");
 </details>
 
 ## 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, AgentMail.ListDomainsResponse></code></summary>
 <dl>
 <dd>
 
@@ -757,7 +805,19 @@ await client.apiKeys.delete("api_key");
 <dd>
 
 ```typescript
-await client.domains.list();
+const pageableResponse = await client.domains.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.domains.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -1042,7 +1102,7 @@ await client.domains.verify("domain_id");
 </details>
 
 ## 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, AgentMail.ListDraftsResponse></code></summary>
 <dl>
 <dd>
 
@@ -1055,7 +1115,19 @@ await client.domains.verify("domain_id");
 <dd>
 
 ```typescript
-await client.drafts.list();
+const pageableResponse = await client.drafts.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.drafts.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -1141,7 +1213,7 @@ await client.drafts.get("draft_id");
 </details>
 
 ## 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, AgentMail.ListDraftsResponse></code></summary>
 <dl>
 <dd>
 
@@ -1154,7 +1226,19 @@ await client.drafts.get("draft_id");
 <dd>
 
 ```typescript
-await client.inboxes.drafts.list("inbox_id");
+const pageableResponse = await client.inboxes.drafts.list("inbox_id");
+for await (const item of pageableResponse) {
+    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();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -1500,7 +1584,7 @@ await client.inboxes.drafts.delete("inbox_id", "draft_id");
 </details>
 
 ## 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, AgentMail.ListMessagesResponse></code></summary>
 <dl>
 <dd>
 
@@ -1513,7 +1597,19 @@ await client.inboxes.drafts.delete("inbox_id", "draft_id");
 <dd>
 
 ```typescript
-await client.inboxes.messages.list("inbox_id");
+const pageableResponse = await client.inboxes.messages.list("inbox_id");
+for await (const item of pageableResponse) {
+    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();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -1985,7 +2081,7 @@ await client.inboxes.metrics.get("inbox_id", {
 </details>
 
 ## 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, AgentMail.ListThreadsResponse></code></summary>
 <dl>
 <dd>
 
@@ -1998,7 +2094,19 @@ await client.inboxes.metrics.get("inbox_id", {
 <dd>
 
 ```typescript
-await client.inboxes.threads.list("inbox_id");
+const pageableResponse = await client.inboxes.threads.list("inbox_id");
+for await (const item of pageableResponse) {
+    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();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -2275,7 +2383,7 @@ await client.metrics.list({
 </details>
 
 ## Pods Domains
-<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">list</a>(podId, { ...params }) -> AgentMail.ListDomainsResponse</code></summary>
+<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">list</a>(podId, { ...params }) -> core.Page<AgentMail.DomainSummary, AgentMail.ListDomainsResponse></code></summary>
 <dl>
 <dd>
 
@@ -2288,7 +2396,19 @@ await client.metrics.list({
 <dd>
 
 ```typescript
-await client.pods.domains.list("pod_id");
+const pageableResponse = await client.pods.domains.list("pod_id");
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.pods.domains.list("pod_id");
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -2450,7 +2570,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
 </details>
 
 ## Pods Drafts
-<details><summary><code>client.pods.drafts.<a href="/src/api/resources/pods/resources/drafts/client/Client.ts">list</a>(podId, { ...params }) -> AgentMail.ListDraftsResponse</code></summary>
+<details><summary><code>client.pods.drafts.<a href="/src/api/resources/pods/resources/drafts/client/Client.ts">list</a>(podId, { ...params }) -> core.Page<AgentMail.DraftItem, AgentMail.ListDraftsResponse></code></summary>
 <dl>
 <dd>
 
@@ -2463,7 +2583,19 @@ await client.pods.domains.delete("pod_id", "domain_id");
 <dd>
 
 ```typescript
-await client.pods.drafts.list("pod_id");
+const pageableResponse = await client.pods.drafts.list("pod_id");
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.pods.drafts.list("pod_id");
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -2565,7 +2697,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
 </details>
 
 ## Pods Inboxes
-<details><summary><code>client.pods.inboxes.<a href="/src/api/resources/pods/resources/inboxes/client/Client.ts">list</a>(podId, { ...params }) -> AgentMail.ListInboxesResponse</code></summary>
+<details><summary><code>client.pods.inboxes.<a href="/src/api/resources/pods/resources/inboxes/client/Client.ts">list</a>(podId, { ...params }) -> core.Page<AgentMail.Inbox, AgentMail.ListInboxesResponse></code></summary>
 <dl>
 <dd>
 
@@ -2578,7 +2710,19 @@ await client.pods.drafts.get("pod_id", "draft_id");
 <dd>
 
 ```typescript
-await client.pods.inboxes.list("pod_id");
+const pageableResponse = await client.pods.inboxes.list("pod_id");
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.pods.inboxes.list("pod_id");
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -2794,7 +2938,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
 </details>
 
 ## Pods Threads
-<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">list</a>(podId, { ...params }) -> AgentMail.ListThreadsResponse</code></summary>
+<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">list</a>(podId, { ...params }) -> core.Page<AgentMail.ThreadItem, AgentMail.ListThreadsResponse></code></summary>
 <dl>
 <dd>
 
@@ -2807,7 +2951,19 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
 <dd>
 
 ```typescript
-await client.pods.threads.list("pod_id");
+const pageableResponse = await client.pods.threads.list("pod_id");
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.pods.threads.list("pod_id");
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -2974,7 +3130,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
 </details>
 
 ## 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, AgentMail.ListThreadsResponse></code></summary>
 <dl>
 <dd>
 
@@ -2987,7 +3143,19 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
 <dd>
 
 ```typescript
-await client.threads.list();
+const pageableResponse = await client.threads.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.threads.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>