agentmail 0.0.66 → 0.0.67

package/README.md

@@ -64,6 +64,26 @@ try {
 }
 ```
 
+## Pagination
+
+List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:
+
+```typescript
+import { AgentMailClient } from "agentmail";
+
+const client = new AgentMailClient({ apiKey: "YOUR_API_KEY" });
+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();
+}
+```
+
 ## Advanced
 
 ### Additional Headers

package/dist/cjs/Client.js

@@ -51,8 +51,8 @@ class AgentMailClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "agentmail",
-                "X-Fern-SDK-Version": "0.0.66",
-                "User-Agent": "agentmail/0.0.66",
+                "X-Fern-SDK-Version": "0.0.67",
+                "User-Agent": "agentmail/0.0.67",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.66";
+export declare const SDK_VERSION = "0.0.67";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.66";
+exports.SDK_VERSION = "0.0.67";

package/dist/esm/Client.mjs

@@ -15,8 +15,8 @@ export class AgentMailClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "agentmail",
-                "X-Fern-SDK-Version": "0.0.66",
-                "User-Agent": "agentmail/0.0.66",
+                "X-Fern-SDK-Version": "0.0.67",
+                "User-Agent": "agentmail/0.0.67",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.66";
+export declare const SDK_VERSION = "0.0.67";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.0.66";
+export const SDK_VERSION = "0.0.67";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "agentmail",
-    "version": "0.0.66",
+    "version": "0.0.67",
     "private": false,
     "repository": "github:agentmail-to/agentmail-node",
     "type": "commonjs",

package/reference.md

@@ -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>
@@ -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>
@@ -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>
@@ -610,7 +637,16 @@ await client.domains.delete("domain");
 <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>
@@ -708,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>
@@ -1012,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>
@@ -1513,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>
@@ -1800,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>