agentmail 0.1.1 → 0.1.3

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.
Files changed (94) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/apiKeys/client/Client.d.ts +2 -1
  3. package/dist/cjs/api/resources/apiKeys/client/Client.js +52 -62
  4. package/dist/cjs/api/resources/domains/client/Client.d.ts +2 -1
  5. package/dist/cjs/api/resources/domains/client/Client.js +52 -62
  6. package/dist/cjs/api/resources/drafts/client/Client.d.ts +2 -1
  7. package/dist/cjs/api/resources/drafts/client/Client.js +70 -83
  8. package/dist/cjs/api/resources/inboxes/client/Client.d.ts +2 -1
  9. package/dist/cjs/api/resources/inboxes/client/Client.js +52 -62
  10. package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.d.ts +2 -1
  11. package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.js +70 -83
  12. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +2 -1
  13. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +70 -83
  14. package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.d.ts +2 -1
  15. package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.js +70 -83
  16. package/dist/cjs/api/resources/pods/client/Client.d.ts +2 -1
  17. package/dist/cjs/api/resources/pods/client/Client.js +52 -62
  18. package/dist/cjs/api/resources/pods/resources/domains/client/Client.d.ts +2 -1
  19. package/dist/cjs/api/resources/pods/resources/domains/client/Client.js +70 -83
  20. package/dist/cjs/api/resources/pods/resources/drafts/client/Client.d.ts +2 -1
  21. package/dist/cjs/api/resources/pods/resources/drafts/client/Client.js +70 -83
  22. package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.d.ts +2 -1
  23. package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.js +70 -83
  24. package/dist/cjs/api/resources/pods/resources/threads/client/Client.d.ts +2 -1
  25. package/dist/cjs/api/resources/pods/resources/threads/client/Client.js +70 -83
  26. package/dist/cjs/api/resources/threads/client/Client.d.ts +2 -1
  27. package/dist/cjs/api/resources/threads/client/Client.js +70 -83
  28. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +2 -1
  29. package/dist/cjs/api/resources/webhooks/client/Client.js +52 -62
  30. package/dist/cjs/core/exports.d.ts +0 -1
  31. package/dist/cjs/core/exports.js +0 -1
  32. package/dist/cjs/core/index.d.ts +0 -2
  33. package/dist/cjs/core/index.js +0 -2
  34. package/dist/cjs/version.d.ts +1 -1
  35. package/dist/cjs/version.js +1 -1
  36. package/dist/esm/Client.mjs +2 -2
  37. package/dist/esm/api/resources/apiKeys/client/Client.d.mts +2 -1
  38. package/dist/esm/api/resources/apiKeys/client/Client.mjs +52 -62
  39. package/dist/esm/api/resources/domains/client/Client.d.mts +2 -1
  40. package/dist/esm/api/resources/domains/client/Client.mjs +52 -62
  41. package/dist/esm/api/resources/drafts/client/Client.d.mts +2 -1
  42. package/dist/esm/api/resources/drafts/client/Client.mjs +70 -83
  43. package/dist/esm/api/resources/inboxes/client/Client.d.mts +2 -1
  44. package/dist/esm/api/resources/inboxes/client/Client.mjs +52 -62
  45. package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.d.mts +2 -1
  46. package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.mjs +70 -83
  47. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +2 -1
  48. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +70 -83
  49. package/dist/esm/api/resources/inboxes/resources/threads/client/Client.d.mts +2 -1
  50. package/dist/esm/api/resources/inboxes/resources/threads/client/Client.mjs +70 -83
  51. package/dist/esm/api/resources/pods/client/Client.d.mts +2 -1
  52. package/dist/esm/api/resources/pods/client/Client.mjs +52 -62
  53. package/dist/esm/api/resources/pods/resources/domains/client/Client.d.mts +2 -1
  54. package/dist/esm/api/resources/pods/resources/domains/client/Client.mjs +70 -83
  55. package/dist/esm/api/resources/pods/resources/drafts/client/Client.d.mts +2 -1
  56. package/dist/esm/api/resources/pods/resources/drafts/client/Client.mjs +70 -83
  57. package/dist/esm/api/resources/pods/resources/inboxes/client/Client.d.mts +2 -1
  58. package/dist/esm/api/resources/pods/resources/inboxes/client/Client.mjs +70 -83
  59. package/dist/esm/api/resources/pods/resources/threads/client/Client.d.mts +2 -1
  60. package/dist/esm/api/resources/pods/resources/threads/client/Client.mjs +70 -83
  61. package/dist/esm/api/resources/threads/client/Client.d.mts +2 -1
  62. package/dist/esm/api/resources/threads/client/Client.mjs +70 -83
  63. package/dist/esm/api/resources/webhooks/client/Client.d.mts +2 -1
  64. package/dist/esm/api/resources/webhooks/client/Client.mjs +52 -62
  65. package/dist/esm/core/exports.d.mts +0 -1
  66. package/dist/esm/core/exports.mjs +0 -1
  67. package/dist/esm/core/index.d.mts +0 -2
  68. package/dist/esm/core/index.mjs +0 -2
  69. package/dist/esm/version.d.mts +1 -1
  70. package/dist/esm/version.mjs +1 -1
  71. package/dist/llms-full.txt +21118 -0
  72. package/dist/llms.txt +101 -0
  73. package/package.json +2 -2
  74. package/reference.md +28 -196
  75. package/dist/cjs/core/pagination/Page.d.ts +0 -33
  76. package/dist/cjs/core/pagination/Page.js +0 -101
  77. package/dist/cjs/core/pagination/exports.d.ts +0 -1
  78. package/dist/cjs/core/pagination/exports.js +0 -2
  79. package/dist/cjs/core/pagination/index.d.ts +0 -1
  80. package/dist/cjs/core/pagination/index.js +0 -5
  81. package/dist/cjs/core/utils/index.d.ts +0 -1
  82. package/dist/cjs/core/utils/index.js +0 -5
  83. package/dist/cjs/core/utils/setObjectProperty.d.ts +0 -11
  84. package/dist/cjs/core/utils/setObjectProperty.js +0 -42
  85. package/dist/esm/core/pagination/Page.d.mts +0 -33
  86. package/dist/esm/core/pagination/Page.mjs +0 -97
  87. package/dist/esm/core/pagination/exports.d.mts +0 -1
  88. package/dist/esm/core/pagination/exports.mjs +0 -1
  89. package/dist/esm/core/pagination/index.d.mts +0 -1
  90. package/dist/esm/core/pagination/index.mjs +0 -1
  91. package/dist/esm/core/utils/index.d.mts +0 -1
  92. package/dist/esm/core/utils/index.mjs +0 -1
  93. package/dist/esm/core/utils/setObjectProperty.d.mts +0 -11
  94. package/dist/esm/core/utils/setObjectProperty.mjs +0 -39
package/dist/llms.txt ADDED
@@ -0,0 +1,101 @@
1
+ # AgentMail | Documentation
2
+
3
+ ## Docs
4
+
5
+ - [Welcome](https://docs.agentmail.to/welcome.mdx): Your starting point for building with the AgentMail API.
6
+ - [Introduction](https://docs.agentmail.to/introduction.mdx): Give AI agents email inboxes
7
+ - [Quickstart](https://docs.agentmail.to/quickstart.mdx): Follow this guide to make your first AgentMail API request and create a new email inbox.
8
+ - [Inboxes](https://docs.agentmail.to/inboxes.mdx): Learn how AgentMail Inboxes act as scalable, API-first email accounts for your agents.
9
+ - [Messages](https://docs.agentmail.to/messages.mdx): Learn how to send, receive, and manage emails as Message objects with the AgentMail API.
10
+ - [Threads](https://docs.agentmail.to/threads.mdx): Learn how AgentMail Threads group messages into conversations and how to query them across your entire organization.
11
+ - [Drafts](https://docs.agentmail.to/drafts.mdx): Learn how to create, manage, and send Drafts to enable advanced agent workflows like human-in-the-loop review and scheduled sending.
12
+ - [Labels](https://docs.agentmail.to/labels.mdx): Learn how to use Labels to manage state, track campaigns, and filter messages for powerful agentic workflows.
13
+ - [Attachments](https://docs.agentmail.to/attachments.mdx): Learn how to send files as attachments, and download incoming attachments from both messages and threads.
14
+ - [Pods](https://docs.agentmail.to/documentation/core-concepts/pods.mdx): Learn how to use pods for multi-tenant email management
15
+ - [Guide: Sending & Receiving Email](https://docs.agentmail.to/sending-receiving-email.mdx): A step-by-step guide to the practical workflow of sending initial emails and handling replies to have a full conversation.
16
+ - [Using Custom Domains](https://docs.agentmail.to/custom-domains.mdx): A step-by-step guide to configuring your custom domain with AgentMail for enhanced branding and trust.
17
+ - [Managing Your Domains](https://docs.agentmail.to/managing-domains.mdx): Learn how to manage your custom domains effectively using AgentMail's API for enhanced deliverability and reputation management.
18
+ - [Integrate LiveKit Agents](https://docs.agentmail.to/integrate-livekit-agents.mdx): A step-by-step guide to integrate with the LiveKit Agents SDK.
19
+ - [Webhooks Overview](https://docs.agentmail.to/overview.mdx): Learn how to use Webhooks to build responsive, event-driven email agents with AgentMail.
20
+ - [Webhook Events](https://docs.agentmail.to/events.mdx): A complete reference of the AgentMail webhook event and its payload.
21
+ - [Webhook Setup Guide](https://docs.agentmail.to/webhook-setup.mdx): A comprehensive guide to setting up webhooks with ngrok and AgentMail, including account creation, inbox setup, and code examples.
22
+ - [Email Deliverability](https://docs.agentmail.to/email-deliverability.mdx): Learn the strategies and best practices for maximizing your email deliverability with AgentMail.
23
+ - [Idempotent Requests](https://docs.agentmail.to/idempotency.mdx): A guide to using the client_id parameter in AgentMail to prevent duplicate resources and safely retry API requests.
24
+ - [Example: Event-Driven Agent](https://docs.agentmail.to/webhook-agent.mdx): A step-by-step guide to building a sophisticated agent that performs proactive outreach and uses webhooks for inbound message processing.
25
+ - [Auto-Reply Email Agent](https://docs.agentmail.to/documentation/examples/auto-reply-agent.mdx): Build a simple agent that automatically responds to incoming emails with personalized messages
26
+ - [Smart Email Labeling Agent](https://docs.agentmail.to/documentation/examples/smart-labeling-agent.mdx): Build an AI-powered agent that automatically classifies and labels incoming emails across multiple dimensions
27
+ - [Live AgentMail Examples](https://docs.agentmail.to/documentation/examples/live-agent-mail-examples.mdx)
28
+ - [Frequently Asked Questions (FAQ)](https://docs.agentmail.to/faq.mdx): Find answers to common questions about AgentMail, from core concepts to best practices and security.
29
+ - [Join the AgentMail Community](https://docs.agentmail.to/community.mdx): Connect with the AgentMail team and developers, share what you're building, and get support.
30
+ - [Support](https://docs.agentmail.to/documentation/resources/support.mdx)
31
+ - [Understanding Email Authentication (SPF, DKIM, DMARC)](https://docs.agentmail.to/email-protocols.mdx): Learn why we ask for DNS records and what SPF, DKIM, and DMARC are.
32
+ - [SOC 2 Compliance](https://docs.agentmail.to/documentation/resources/security-privacy/soc-2-compliance.mdx)
33
+ - [API Welcome](https://docs.agentmail.to/api-reference.mdx): Quick overview of the AgentMail SDK
34
+ - [August 13, 2025](https://docs.agentmail.to/changelog/2025/8/13.mdx)
35
+
36
+ ## API Docs
37
+
38
+ - API Reference > Inboxes [List Inboxes](https://docs.agentmail.to/api-reference/inboxes/list.mdx)
39
+ - API Reference > Inboxes [Get Inbox](https://docs.agentmail.to/api-reference/inboxes/get.mdx)
40
+ - API Reference > Inboxes [Create Inbox](https://docs.agentmail.to/api-reference/inboxes/create.mdx)
41
+ - API Reference > Inboxes [Delete Inbox](https://docs.agentmail.to/api-reference/inboxes/delete.mdx)
42
+ - API Reference > Inboxes > Threads [List Threads](https://docs.agentmail.to/api-reference/inboxes/threads/list.mdx)
43
+ - API Reference > Inboxes > Threads [Get Thread](https://docs.agentmail.to/api-reference/inboxes/threads/get.mdx)
44
+ - API Reference > Inboxes > Threads [Get Attachment](https://docs.agentmail.to/api-reference/inboxes/threads/get-attachment.mdx)
45
+ - API Reference > Inboxes > Threads [Delete Thread](https://docs.agentmail.to/api-reference/inboxes/threads/delete.mdx)
46
+ - API Reference > Inboxes > Messages [List Messages](https://docs.agentmail.to/api-reference/inboxes/messages/list.mdx)
47
+ - API Reference > Inboxes > Messages [Get Message](https://docs.agentmail.to/api-reference/inboxes/messages/get.mdx)
48
+ - API Reference > Inboxes > Messages [Get Attachment](https://docs.agentmail.to/api-reference/inboxes/messages/get-attachment.mdx)
49
+ - API Reference > Inboxes > Messages [Get Raw Message](https://docs.agentmail.to/api-reference/inboxes/messages/get-raw.mdx)
50
+ - API Reference > Inboxes > Messages [Send Message](https://docs.agentmail.to/api-reference/inboxes/messages/send.mdx)
51
+ - API Reference > Inboxes > Messages [Reply To Message](https://docs.agentmail.to/api-reference/inboxes/messages/reply.mdx)
52
+ - API Reference > Inboxes > Messages [Update Message](https://docs.agentmail.to/api-reference/inboxes/messages/update.mdx)
53
+ - API Reference > Inboxes > Drafts [List Drafts](https://docs.agentmail.to/api-reference/inboxes/drafts/list.mdx)
54
+ - API Reference > Inboxes > Drafts [Get Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/get.mdx)
55
+ - API Reference > Inboxes > Drafts [Create Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/create.mdx)
56
+ - API Reference > Inboxes > Drafts [Update Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/update.mdx)
57
+ - API Reference > Inboxes > Drafts [Send Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/send.mdx)
58
+ - API Reference > Inboxes > Drafts [Delete Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/delete.mdx)
59
+ - API Reference > Inboxes > Metrics [List Metrics](https://docs.agentmail.to/api-reference/inboxes/metrics/get.mdx)
60
+ - API Reference > Threads [List Threads](https://docs.agentmail.to/api-reference/threads/list.mdx)
61
+ - API Reference > Threads [Get Thread](https://docs.agentmail.to/api-reference/threads/get.mdx)
62
+ - API Reference > Threads [Get Attachment](https://docs.agentmail.to/api-reference/threads/get-attachment.mdx)
63
+ - API Reference > Drafts [List Drafts](https://docs.agentmail.to/api-reference/drafts/list.mdx)
64
+ - API Reference > Drafts [Get Draft](https://docs.agentmail.to/api-reference/drafts/get.mdx)
65
+ - API Reference > Domains [List Domains](https://docs.agentmail.to/api-reference/domains/list.mdx)
66
+ - API Reference > Domains [Get Domain](https://docs.agentmail.to/api-reference/domains/get.mdx)
67
+ - API Reference > Domains [Get Zone File](https://docs.agentmail.to/api-reference/domains/get-zone-file.mdx)
68
+ - API Reference > Domains [Create Domain](https://docs.agentmail.to/api-reference/domains/create.mdx)
69
+ - API Reference > Domains [Delete Domain](https://docs.agentmail.to/api-reference/domains/delete.mdx)
70
+ - API Reference > Domains [Verify Domain](https://docs.agentmail.to/api-reference/domains/verify.mdx)
71
+ - API Reference > Webhooks [List Webhooks](https://docs.agentmail.to/api-reference/webhooks/list.mdx)
72
+ - API Reference > Webhooks [Get Webhook](https://docs.agentmail.to/api-reference/webhooks/get.mdx)
73
+ - API Reference > Webhooks [Create Webhook](https://docs.agentmail.to/api-reference/webhooks/create.mdx)
74
+ - API Reference > Webhooks [Delete Webhook](https://docs.agentmail.to/api-reference/webhooks/delete.mdx)
75
+ - API Reference > Webhooks > Events [Message Received](https://docs.agentmail.to/api-reference/webhooks/events/message-received.mdx)
76
+ - API Reference > Webhooks > Events [Message Sent](https://docs.agentmail.to/api-reference/webhooks/events/message-sent.mdx)
77
+ - API Reference > Webhooks > Events [Message Delivered](https://docs.agentmail.to/api-reference/webhooks/events/message-delivered.mdx)
78
+ - API Reference > Webhooks > Events [Message Bounced](https://docs.agentmail.to/api-reference/webhooks/events/message-bounced.mdx)
79
+ - API Reference > Webhooks > Events [Message Complained](https://docs.agentmail.to/api-reference/webhooks/events/message-complained.mdx)
80
+ - API Reference > Webhooks > Events [Message Rejected](https://docs.agentmail.to/api-reference/webhooks/events/message-rejected.mdx)
81
+ - API Reference > Websockets [Connect](https://docs.agentmail.to/api-reference/websockets/websockets.mdx)
82
+ - API Reference > Metrics [List Metrics](https://docs.agentmail.to/api-reference/metrics/list.mdx)
83
+ - API Reference > API Keys [List API Keys](https://docs.agentmail.to/api-reference/api-keys/list.mdx)
84
+ - API Reference > API Keys [Create API Key](https://docs.agentmail.to/api-reference/api-keys/create.mdx)
85
+ - API Reference > API Keys [Delete API Key](https://docs.agentmail.to/api-reference/api-keys/delete.mdx)
86
+ - API Reference > Pods [List Pods](https://docs.agentmail.to/api-reference/pods/list.mdx)
87
+ - API Reference > Pods [Get Pod](https://docs.agentmail.to/api-reference/pods/get.mdx)
88
+ - API Reference > Pods [Create Pod](https://docs.agentmail.to/api-reference/pods/create.mdx)
89
+ - API Reference > Pods [Delete Pod](https://docs.agentmail.to/api-reference/pods/delete.mdx)
90
+ - API Reference > Pods > Inboxes [List Inboxes](https://docs.agentmail.to/api-reference/pods/inboxes/list.mdx)
91
+ - API Reference > Pods > Inboxes [Get Inbox](https://docs.agentmail.to/api-reference/pods/inboxes/get.mdx)
92
+ - API Reference > Pods > Inboxes [Create Inbox](https://docs.agentmail.to/api-reference/pods/inboxes/create.mdx)
93
+ - API Reference > Pods > Inboxes [Delete Inbox](https://docs.agentmail.to/api-reference/pods/inboxes/delete.mdx)
94
+ - API Reference > Pods > Threads [List Threads](https://docs.agentmail.to/api-reference/pods/threads/list.mdx)
95
+ - API Reference > Pods > Threads [Get Thread](https://docs.agentmail.to/api-reference/pods/threads/get.mdx)
96
+ - API Reference > Pods > Threads [Get Attachment](https://docs.agentmail.to/api-reference/pods/threads/get-attachment.mdx)
97
+ - API Reference > Pods > Drafts [List Drafts](https://docs.agentmail.to/api-reference/pods/drafts/list.mdx)
98
+ - API Reference > Pods > Drafts [Get Draft](https://docs.agentmail.to/api-reference/pods/drafts/get.mdx)
99
+ - API Reference > Pods > Domains [List Domains](https://docs.agentmail.to/api-reference/pods/domains/list.mdx)
100
+ - API Reference > Pods > Domains [Create Domain](https://docs.agentmail.to/api-reference/pods/domains/create.mdx)
101
+ - API Reference > Pods > Domains [Delete Domain](https://docs.agentmail.to/api-reference/pods/domains/delete.mdx)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agentmail",
3
- "version": "0.1.1",
3
+ "version": "0.1.3",
4
4
  "private": false,
5
5
  "repository": "github:agentmail-to/agentmail-node",
6
6
  "type": "commonjs",
@@ -47,7 +47,7 @@
47
47
  "lint:fix": "biome lint --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
48
48
  "check": "biome check --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
49
49
  "check:fix": "biome check --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
50
- "build": "pnpm build:cjs && pnpm build:esm",
50
+ "build": "npm run build:cjs && npm run build:esm && node -e \"const https=require('https'),fs=require('fs');const download=(f)=>new Promise((res,rej)=>https.get('https://docs.agentmail.to/'+f,r=>r.pipe(fs.createWriteStream('dist/'+f)).on('finish',res).on('error',rej)));Promise.all(['llms.txt','llms-full.txt'].map(download)).catch(e=>{console.error(e);process.exit(1)});\"",
51
51
  "build:cjs": "tsc --project ./tsconfig.cjs.json",
52
52
  "build:esm": "tsc --project ./tsconfig.esm.json && node scripts/rename-to-esm-files.js dist/esm",
53
53
  "test": "vitest",
package/reference.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Reference
2
2
  ## Inboxes
3
- <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>
3
+ <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListInboxesResponse</code></summary>
4
4
  <dl>
5
5
  <dd>
6
6
 
@@ -13,19 +13,7 @@
13
13
  <dd>
14
14
 
15
15
  ```typescript
16
- const pageableResponse = await client.inboxes.list();
17
- for await (const item of pageableResponse) {
18
- console.log(item);
19
- }
20
-
21
- // Or you can manually iterate page-by-page
22
- let page = await client.inboxes.list();
23
- while (page.hasNextPage()) {
24
- page = page.getNextPage();
25
- }
26
-
27
- // You can also access the underlying response
28
- const response = page.response;
16
+ await client.inboxes.list();
29
17
 
30
18
  ```
31
19
  </dd>
@@ -209,7 +197,7 @@ await client.inboxes.delete("inbox_id");
209
197
  </details>
210
198
 
211
199
  ## Pods
212
- <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>
200
+ <details><summary><code>client.pods.<a href="/src/api/resources/pods/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListPodsResponse</code></summary>
213
201
  <dl>
214
202
  <dd>
215
203
 
@@ -222,19 +210,7 @@ await client.inboxes.delete("inbox_id");
222
210
  <dd>
223
211
 
224
212
  ```typescript
225
- const pageableResponse = await client.pods.list();
226
- for await (const item of pageableResponse) {
227
- console.log(item);
228
- }
229
-
230
- // Or you can manually iterate page-by-page
231
- let page = await client.pods.list();
232
- while (page.hasNextPage()) {
233
- page = page.getNextPage();
234
- }
235
-
236
- // You can also access the underlying response
237
- const response = page.response;
213
+ await client.pods.list();
238
214
 
239
215
  ```
240
216
  </dd>
@@ -418,7 +394,7 @@ await client.pods.delete("pod_id");
418
394
  </details>
419
395
 
420
396
  ## Webhooks
421
- <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>
397
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListWebhooksResponse</code></summary>
422
398
  <dl>
423
399
  <dd>
424
400
 
@@ -431,19 +407,7 @@ await client.pods.delete("pod_id");
431
407
  <dd>
432
408
 
433
409
  ```typescript
434
- const pageableResponse = await client.webhooks.list();
435
- for await (const item of pageableResponse) {
436
- console.log(item);
437
- }
438
-
439
- // Or you can manually iterate page-by-page
440
- let page = await client.webhooks.list();
441
- while (page.hasNextPage()) {
442
- page = page.getNextPage();
443
- }
444
-
445
- // You can also access the underlying response
446
- const response = page.response;
410
+ await client.webhooks.list();
447
411
 
448
412
  ```
449
413
  </dd>
@@ -630,7 +594,7 @@ await client.webhooks.delete("webhook_id");
630
594
  </details>
631
595
 
632
596
  ## ApiKeys
633
- <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>
597
+ <details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListApiKeysResponse</code></summary>
634
598
  <dl>
635
599
  <dd>
636
600
 
@@ -643,19 +607,7 @@ await client.webhooks.delete("webhook_id");
643
607
  <dd>
644
608
 
645
609
  ```typescript
646
- const pageableResponse = await client.apiKeys.list();
647
- for await (const item of pageableResponse) {
648
- console.log(item);
649
- }
650
-
651
- // Or you can manually iterate page-by-page
652
- let page = await client.apiKeys.list();
653
- while (page.hasNextPage()) {
654
- page = page.getNextPage();
655
- }
656
-
657
- // You can also access the underlying response
658
- const response = page.response;
610
+ await client.apiKeys.list();
659
611
 
660
612
  ```
661
613
  </dd>
@@ -792,7 +744,7 @@ await client.apiKeys.delete("api_key");
792
744
  </details>
793
745
 
794
746
  ## Domains
795
- <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>
747
+ <details><summary><code>client.domains.<a href="/src/api/resources/domains/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListDomainsResponse</code></summary>
796
748
  <dl>
797
749
  <dd>
798
750
 
@@ -805,19 +757,7 @@ await client.apiKeys.delete("api_key");
805
757
  <dd>
806
758
 
807
759
  ```typescript
808
- const pageableResponse = await client.domains.list();
809
- for await (const item of pageableResponse) {
810
- console.log(item);
811
- }
812
-
813
- // Or you can manually iterate page-by-page
814
- let page = await client.domains.list();
815
- while (page.hasNextPage()) {
816
- page = page.getNextPage();
817
- }
818
-
819
- // You can also access the underlying response
820
- const response = page.response;
760
+ await client.domains.list();
821
761
 
822
762
  ```
823
763
  </dd>
@@ -1102,7 +1042,7 @@ await client.domains.verify("domain_id");
1102
1042
  </details>
1103
1043
 
1104
1044
  ## Drafts
1105
- <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>
1045
+ <details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListDraftsResponse</code></summary>
1106
1046
  <dl>
1107
1047
  <dd>
1108
1048
 
@@ -1115,19 +1055,7 @@ await client.domains.verify("domain_id");
1115
1055
  <dd>
1116
1056
 
1117
1057
  ```typescript
1118
- const pageableResponse = await client.drafts.list();
1119
- for await (const item of pageableResponse) {
1120
- console.log(item);
1121
- }
1122
-
1123
- // Or you can manually iterate page-by-page
1124
- let page = await client.drafts.list();
1125
- while (page.hasNextPage()) {
1126
- page = page.getNextPage();
1127
- }
1128
-
1129
- // You can also access the underlying response
1130
- const response = page.response;
1058
+ await client.drafts.list();
1131
1059
 
1132
1060
  ```
1133
1061
  </dd>
@@ -1213,7 +1141,7 @@ await client.drafts.get("draft_id");
1213
1141
  </details>
1214
1142
 
1215
1143
  ## Inboxes Drafts
1216
- <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>
1144
+ <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>
1217
1145
  <dl>
1218
1146
  <dd>
1219
1147
 
@@ -1226,19 +1154,7 @@ await client.drafts.get("draft_id");
1226
1154
  <dd>
1227
1155
 
1228
1156
  ```typescript
1229
- const pageableResponse = await client.inboxes.drafts.list("inbox_id");
1230
- for await (const item of pageableResponse) {
1231
- console.log(item);
1232
- }
1233
-
1234
- // Or you can manually iterate page-by-page
1235
- let page = await client.inboxes.drafts.list("inbox_id");
1236
- while (page.hasNextPage()) {
1237
- page = page.getNextPage();
1238
- }
1239
-
1240
- // You can also access the underlying response
1241
- const response = page.response;
1157
+ await client.inboxes.drafts.list("inbox_id");
1242
1158
 
1243
1159
  ```
1244
1160
  </dd>
@@ -1584,7 +1500,7 @@ await client.inboxes.drafts.delete("inbox_id", "draft_id");
1584
1500
  </details>
1585
1501
 
1586
1502
  ## Inboxes Messages
1587
- <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>
1503
+ <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>
1588
1504
  <dl>
1589
1505
  <dd>
1590
1506
 
@@ -1597,19 +1513,7 @@ await client.inboxes.drafts.delete("inbox_id", "draft_id");
1597
1513
  <dd>
1598
1514
 
1599
1515
  ```typescript
1600
- const pageableResponse = await client.inboxes.messages.list("inbox_id");
1601
- for await (const item of pageableResponse) {
1602
- console.log(item);
1603
- }
1604
-
1605
- // Or you can manually iterate page-by-page
1606
- let page = await client.inboxes.messages.list("inbox_id");
1607
- while (page.hasNextPage()) {
1608
- page = page.getNextPage();
1609
- }
1610
-
1611
- // You can also access the underlying response
1612
- const response = page.response;
1516
+ await client.inboxes.messages.list("inbox_id");
1613
1517
 
1614
1518
  ```
1615
1519
  </dd>
@@ -2081,7 +1985,7 @@ await client.inboxes.metrics.get("inbox_id", {
2081
1985
  </details>
2082
1986
 
2083
1987
  ## Inboxes Threads
2084
- <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>
1988
+ <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>
2085
1989
  <dl>
2086
1990
  <dd>
2087
1991
 
@@ -2094,19 +1998,7 @@ await client.inboxes.metrics.get("inbox_id", {
2094
1998
  <dd>
2095
1999
 
2096
2000
  ```typescript
2097
- const pageableResponse = await client.inboxes.threads.list("inbox_id");
2098
- for await (const item of pageableResponse) {
2099
- console.log(item);
2100
- }
2101
-
2102
- // Or you can manually iterate page-by-page
2103
- let page = await client.inboxes.threads.list("inbox_id");
2104
- while (page.hasNextPage()) {
2105
- page = page.getNextPage();
2106
- }
2107
-
2108
- // You can also access the underlying response
2109
- const response = page.response;
2001
+ await client.inboxes.threads.list("inbox_id");
2110
2002
 
2111
2003
  ```
2112
2004
  </dd>
@@ -2383,7 +2275,7 @@ await client.metrics.list({
2383
2275
  </details>
2384
2276
 
2385
2277
  ## Pods Domains
2386
- <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>
2278
+ <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>
2387
2279
  <dl>
2388
2280
  <dd>
2389
2281
 
@@ -2396,19 +2288,7 @@ await client.metrics.list({
2396
2288
  <dd>
2397
2289
 
2398
2290
  ```typescript
2399
- const pageableResponse = await client.pods.domains.list("pod_id");
2400
- for await (const item of pageableResponse) {
2401
- console.log(item);
2402
- }
2403
-
2404
- // Or you can manually iterate page-by-page
2405
- let page = await client.pods.domains.list("pod_id");
2406
- while (page.hasNextPage()) {
2407
- page = page.getNextPage();
2408
- }
2409
-
2410
- // You can also access the underlying response
2411
- const response = page.response;
2291
+ await client.pods.domains.list("pod_id");
2412
2292
 
2413
2293
  ```
2414
2294
  </dd>
@@ -2570,7 +2450,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
2570
2450
  </details>
2571
2451
 
2572
2452
  ## Pods Drafts
2573
- <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>
2453
+ <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>
2574
2454
  <dl>
2575
2455
  <dd>
2576
2456
 
@@ -2583,19 +2463,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
2583
2463
  <dd>
2584
2464
 
2585
2465
  ```typescript
2586
- const pageableResponse = await client.pods.drafts.list("pod_id");
2587
- for await (const item of pageableResponse) {
2588
- console.log(item);
2589
- }
2590
-
2591
- // Or you can manually iterate page-by-page
2592
- let page = await client.pods.drafts.list("pod_id");
2593
- while (page.hasNextPage()) {
2594
- page = page.getNextPage();
2595
- }
2596
-
2597
- // You can also access the underlying response
2598
- const response = page.response;
2466
+ await client.pods.drafts.list("pod_id");
2599
2467
 
2600
2468
  ```
2601
2469
  </dd>
@@ -2697,7 +2565,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
2697
2565
  </details>
2698
2566
 
2699
2567
  ## Pods Inboxes
2700
- <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>
2568
+ <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>
2701
2569
  <dl>
2702
2570
  <dd>
2703
2571
 
@@ -2710,19 +2578,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
2710
2578
  <dd>
2711
2579
 
2712
2580
  ```typescript
2713
- const pageableResponse = await client.pods.inboxes.list("pod_id");
2714
- for await (const item of pageableResponse) {
2715
- console.log(item);
2716
- }
2717
-
2718
- // Or you can manually iterate page-by-page
2719
- let page = await client.pods.inboxes.list("pod_id");
2720
- while (page.hasNextPage()) {
2721
- page = page.getNextPage();
2722
- }
2723
-
2724
- // You can also access the underlying response
2725
- const response = page.response;
2581
+ await client.pods.inboxes.list("pod_id");
2726
2582
 
2727
2583
  ```
2728
2584
  </dd>
@@ -2938,7 +2794,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
2938
2794
  </details>
2939
2795
 
2940
2796
  ## Pods Threads
2941
- <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>
2797
+ <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>
2942
2798
  <dl>
2943
2799
  <dd>
2944
2800
 
@@ -2951,19 +2807,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
2951
2807
  <dd>
2952
2808
 
2953
2809
  ```typescript
2954
- const pageableResponse = await client.pods.threads.list("pod_id");
2955
- for await (const item of pageableResponse) {
2956
- console.log(item);
2957
- }
2958
-
2959
- // Or you can manually iterate page-by-page
2960
- let page = await client.pods.threads.list("pod_id");
2961
- while (page.hasNextPage()) {
2962
- page = page.getNextPage();
2963
- }
2964
-
2965
- // You can also access the underlying response
2966
- const response = page.response;
2810
+ await client.pods.threads.list("pod_id");
2967
2811
 
2968
2812
  ```
2969
2813
  </dd>
@@ -3130,7 +2974,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
3130
2974
  </details>
3131
2975
 
3132
2976
  ## Threads
3133
- <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>
2977
+ <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListThreadsResponse</code></summary>
3134
2978
  <dl>
3135
2979
  <dd>
3136
2980
 
@@ -3143,19 +2987,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
3143
2987
  <dd>
3144
2988
 
3145
2989
  ```typescript
3146
- const pageableResponse = await client.threads.list();
3147
- for await (const item of pageableResponse) {
3148
- console.log(item);
3149
- }
3150
-
3151
- // Or you can manually iterate page-by-page
3152
- let page = await client.threads.list();
3153
- while (page.hasNextPage()) {
3154
- page = page.getNextPage();
3155
- }
3156
-
3157
- // You can also access the underlying response
3158
- const response = page.response;
2990
+ await client.threads.list();
3159
2991
 
3160
2992
  ```
3161
2993
  </dd>
@@ -1,33 +0,0 @@
1
- import type { HttpResponsePromise, RawResponse } from "../fetcher/index.js";
2
- /**
3
- * A page of results from a paginated API.
4
- *
5
- * @template T The type of the items in the page.
6
- * @template R The type of the API response.
7
- */
8
- export declare class Page<T, R = unknown> implements AsyncIterable<T> {
9
- data: T[];
10
- rawResponse: RawResponse;
11
- response: R;
12
- private _hasNextPage;
13
- private getItems;
14
- private loadNextPage;
15
- constructor({ response, rawResponse, hasNextPage, getItems, loadPage, }: {
16
- response: R;
17
- rawResponse: RawResponse;
18
- hasNextPage: (response: R) => boolean;
19
- getItems: (response: R) => T[];
20
- loadPage: (response: R) => HttpResponsePromise<R>;
21
- });
22
- /**
23
- * Retrieves the next page
24
- * @returns this
25
- */
26
- getNextPage(): Promise<this>;
27
- /**
28
- * @returns whether there is a next page to load
29
- */
30
- hasNextPage(): boolean;
31
- private iterMessages;
32
- [Symbol.asyncIterator](): AsyncIterator<T, void, any>;
33
- }