agentmail 0.5.10 → 0.5.12

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 (142) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +26 -0
  3. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +83 -0
  4. package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.d.ts +30 -4
  5. package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.js +102 -7
  6. package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/{QueryMetricsRequest.d.ts → QueryEventsRequest.d.ts} +1 -1
  7. package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/QueryUsageRequest.d.ts +13 -0
  8. package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/index.d.ts +2 -1
  9. package/dist/cjs/api/resources/messages/types/BatchUpdateMessagesMessageIds.d.ts +8 -0
  10. package/dist/cjs/api/resources/messages/types/BatchUpdateMessagesRequest.d.ts +8 -0
  11. package/dist/cjs/api/resources/messages/types/BatchUpdateMessagesRequest.js +3 -0
  12. package/dist/cjs/api/resources/messages/types/BatchUpdateMessagesResponse.d.ts +11 -0
  13. package/dist/cjs/api/resources/messages/types/BatchUpdateMessagesResponse.js +3 -0
  14. package/dist/cjs/api/resources/messages/types/index.d.ts +3 -0
  15. package/dist/cjs/api/resources/messages/types/index.js +3 -0
  16. package/dist/cjs/api/resources/metrics/client/Client.d.ts +27 -4
  17. package/dist/cjs/api/resources/metrics/client/Client.js +99 -7
  18. package/dist/cjs/api/resources/metrics/client/requests/{QueryMetricsRequest.d.ts → QueryEventsRequest.d.ts} +1 -1
  19. package/dist/cjs/api/resources/metrics/client/requests/QueryEventsRequest.js +3 -0
  20. package/dist/cjs/api/resources/metrics/client/requests/QueryUsageRequest.d.ts +13 -0
  21. package/dist/cjs/api/resources/metrics/client/requests/QueryUsageRequest.js +3 -0
  22. package/dist/cjs/api/resources/metrics/client/requests/index.d.ts +2 -1
  23. package/dist/cjs/api/resources/metrics/types/MetricEventType.d.ts +6 -3
  24. package/dist/cjs/api/resources/metrics/types/MetricEventType.js +6 -3
  25. package/dist/cjs/api/resources/metrics/types/Period.d.ts +2 -2
  26. package/dist/cjs/api/resources/metrics/types/QueryUsageResponse.d.ts +5 -0
  27. package/dist/cjs/api/resources/metrics/types/QueryUsageResponse.js +3 -0
  28. package/dist/cjs/api/resources/metrics/types/UsagePoint.d.ts +6 -0
  29. package/dist/cjs/api/resources/metrics/types/UsagePoint.js +3 -0
  30. package/dist/cjs/api/resources/metrics/types/UsageType.d.ts +14 -0
  31. package/dist/cjs/api/resources/metrics/types/UsageType.js +17 -0
  32. package/dist/cjs/api/resources/metrics/types/UsageTypes.d.ts +5 -0
  33. package/dist/cjs/api/resources/metrics/types/UsageTypes.js +3 -0
  34. package/dist/cjs/api/resources/metrics/types/index.d.ts +4 -0
  35. package/dist/cjs/api/resources/metrics/types/index.js +4 -0
  36. package/dist/cjs/api/resources/pods/resources/metrics/client/Client.d.ts +30 -4
  37. package/dist/cjs/api/resources/pods/resources/metrics/client/Client.js +102 -7
  38. package/dist/cjs/api/resources/pods/resources/metrics/client/requests/{QueryMetricsRequest.d.ts → QueryEventsRequest.d.ts} +1 -1
  39. package/dist/cjs/api/resources/pods/resources/metrics/client/requests/QueryEventsRequest.js +3 -0
  40. package/dist/cjs/api/resources/pods/resources/metrics/client/requests/QueryUsageRequest.d.ts +13 -0
  41. package/dist/cjs/api/resources/pods/resources/metrics/client/requests/QueryUsageRequest.js +3 -0
  42. package/dist/cjs/api/resources/pods/resources/metrics/client/requests/index.d.ts +2 -1
  43. package/dist/cjs/serialization/resources/messages/types/BatchUpdateMessagesMessageIds.d.ts +8 -0
  44. package/dist/cjs/serialization/resources/messages/types/BatchUpdateMessagesMessageIds.js +40 -0
  45. package/dist/cjs/serialization/resources/messages/types/BatchUpdateMessagesRequest.d.ts +13 -0
  46. package/dist/cjs/serialization/resources/messages/types/BatchUpdateMessagesRequest.js +45 -0
  47. package/dist/cjs/serialization/resources/messages/types/BatchUpdateMessagesResponse.d.ts +14 -0
  48. package/dist/cjs/serialization/resources/messages/types/BatchUpdateMessagesResponse.js +46 -0
  49. package/dist/cjs/serialization/resources/messages/types/index.d.ts +3 -0
  50. package/dist/cjs/serialization/resources/messages/types/index.js +3 -0
  51. package/dist/cjs/serialization/resources/metrics/types/MetricEventType.d.ts +1 -1
  52. package/dist/cjs/serialization/resources/metrics/types/MetricEventType.js +6 -3
  53. package/dist/cjs/serialization/resources/metrics/types/Period.d.ts +1 -1
  54. package/dist/cjs/serialization/resources/metrics/types/Period.js +1 -1
  55. package/dist/cjs/serialization/resources/metrics/types/QueryUsageResponse.d.ts +9 -0
  56. package/dist/cjs/serialization/resources/metrics/types/QueryUsageResponse.js +41 -0
  57. package/dist/cjs/serialization/resources/metrics/types/UsagePoint.d.ts +10 -0
  58. package/dist/cjs/serialization/resources/metrics/types/UsagePoint.js +42 -0
  59. package/dist/cjs/serialization/resources/metrics/types/UsageType.d.ts +7 -0
  60. package/dist/cjs/serialization/resources/metrics/types/UsageType.js +46 -0
  61. package/dist/cjs/serialization/resources/metrics/types/UsageTypes.d.ts +8 -0
  62. package/dist/cjs/serialization/resources/metrics/types/UsageTypes.js +40 -0
  63. package/dist/cjs/serialization/resources/metrics/types/index.d.ts +4 -0
  64. package/dist/cjs/serialization/resources/metrics/types/index.js +4 -0
  65. package/dist/cjs/version.d.ts +1 -1
  66. package/dist/cjs/version.js +1 -1
  67. package/dist/esm/BaseClient.mjs +2 -2
  68. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +26 -0
  69. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +83 -0
  70. package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.d.mts +30 -4
  71. package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.mjs +102 -7
  72. package/dist/esm/api/resources/{pods/resources/metrics/client/requests/QueryMetricsRequest.d.mts → inboxes/resources/metrics/client/requests/QueryEventsRequest.d.mts} +1 -1
  73. package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/QueryUsageRequest.d.mts +13 -0
  74. package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/index.d.mts +2 -1
  75. package/dist/esm/api/resources/messages/types/BatchUpdateMessagesMessageIds.d.mts +8 -0
  76. package/dist/esm/api/resources/messages/types/BatchUpdateMessagesRequest.d.mts +8 -0
  77. package/dist/esm/api/resources/messages/types/BatchUpdateMessagesRequest.mjs +2 -0
  78. package/dist/esm/api/resources/messages/types/BatchUpdateMessagesResponse.d.mts +11 -0
  79. package/dist/esm/api/resources/messages/types/BatchUpdateMessagesResponse.mjs +2 -0
  80. package/dist/esm/api/resources/messages/types/index.d.mts +3 -0
  81. package/dist/esm/api/resources/messages/types/index.mjs +3 -0
  82. package/dist/esm/api/resources/metrics/client/Client.d.mts +27 -4
  83. package/dist/esm/api/resources/metrics/client/Client.mjs +99 -7
  84. package/dist/esm/api/resources/metrics/client/requests/{QueryMetricsRequest.d.mts → QueryEventsRequest.d.mts} +1 -1
  85. package/dist/esm/api/resources/metrics/client/requests/QueryEventsRequest.mjs +2 -0
  86. package/dist/esm/api/resources/metrics/client/requests/QueryUsageRequest.d.mts +13 -0
  87. package/dist/esm/api/resources/metrics/client/requests/QueryUsageRequest.mjs +2 -0
  88. package/dist/esm/api/resources/metrics/client/requests/index.d.mts +2 -1
  89. package/dist/esm/api/resources/metrics/types/MetricEventType.d.mts +6 -3
  90. package/dist/esm/api/resources/metrics/types/MetricEventType.mjs +6 -3
  91. package/dist/esm/api/resources/metrics/types/Period.d.mts +2 -2
  92. package/dist/esm/api/resources/metrics/types/QueryUsageResponse.d.mts +5 -0
  93. package/dist/esm/api/resources/metrics/types/QueryUsageResponse.mjs +2 -0
  94. package/dist/esm/api/resources/metrics/types/UsagePoint.d.mts +6 -0
  95. package/dist/esm/api/resources/metrics/types/UsagePoint.mjs +2 -0
  96. package/dist/esm/api/resources/metrics/types/UsageType.d.mts +14 -0
  97. package/dist/esm/api/resources/metrics/types/UsageType.mjs +14 -0
  98. package/dist/esm/api/resources/metrics/types/UsageTypes.d.mts +5 -0
  99. package/dist/esm/api/resources/metrics/types/UsageTypes.mjs +2 -0
  100. package/dist/esm/api/resources/metrics/types/index.d.mts +4 -0
  101. package/dist/esm/api/resources/metrics/types/index.mjs +4 -0
  102. package/dist/esm/api/resources/pods/resources/metrics/client/Client.d.mts +30 -4
  103. package/dist/esm/api/resources/pods/resources/metrics/client/Client.mjs +102 -7
  104. package/dist/esm/api/resources/{inboxes/resources/metrics/client/requests/QueryMetricsRequest.d.mts → pods/resources/metrics/client/requests/QueryEventsRequest.d.mts} +1 -1
  105. package/dist/esm/api/resources/pods/resources/metrics/client/requests/QueryEventsRequest.mjs +2 -0
  106. package/dist/esm/api/resources/pods/resources/metrics/client/requests/QueryUsageRequest.d.mts +13 -0
  107. package/dist/esm/api/resources/pods/resources/metrics/client/requests/QueryUsageRequest.mjs +2 -0
  108. package/dist/esm/api/resources/pods/resources/metrics/client/requests/index.d.mts +2 -1
  109. package/dist/esm/serialization/resources/messages/types/BatchUpdateMessagesMessageIds.d.mts +8 -0
  110. package/dist/esm/serialization/resources/messages/types/BatchUpdateMessagesMessageIds.mjs +4 -0
  111. package/dist/esm/serialization/resources/messages/types/BatchUpdateMessagesRequest.d.mts +13 -0
  112. package/dist/esm/serialization/resources/messages/types/BatchUpdateMessagesRequest.mjs +9 -0
  113. package/dist/esm/serialization/resources/messages/types/BatchUpdateMessagesResponse.d.mts +14 -0
  114. package/dist/esm/serialization/resources/messages/types/BatchUpdateMessagesResponse.mjs +10 -0
  115. package/dist/esm/serialization/resources/messages/types/index.d.mts +3 -0
  116. package/dist/esm/serialization/resources/messages/types/index.mjs +3 -0
  117. package/dist/esm/serialization/resources/metrics/types/MetricEventType.d.mts +1 -1
  118. package/dist/esm/serialization/resources/metrics/types/MetricEventType.mjs +6 -3
  119. package/dist/esm/serialization/resources/metrics/types/Period.d.mts +1 -1
  120. package/dist/esm/serialization/resources/metrics/types/Period.mjs +1 -1
  121. package/dist/esm/serialization/resources/metrics/types/QueryUsageResponse.d.mts +9 -0
  122. package/dist/esm/serialization/resources/metrics/types/QueryUsageResponse.mjs +5 -0
  123. package/dist/esm/serialization/resources/metrics/types/UsagePoint.d.mts +10 -0
  124. package/dist/esm/serialization/resources/metrics/types/UsagePoint.mjs +6 -0
  125. package/dist/esm/serialization/resources/metrics/types/UsageType.d.mts +7 -0
  126. package/dist/esm/serialization/resources/metrics/types/UsageType.mjs +10 -0
  127. package/dist/esm/serialization/resources/metrics/types/UsageTypes.d.mts +8 -0
  128. package/dist/esm/serialization/resources/metrics/types/UsageTypes.mjs +4 -0
  129. package/dist/esm/serialization/resources/metrics/types/index.d.mts +4 -0
  130. package/dist/esm/serialization/resources/metrics/types/index.mjs +4 -0
  131. package/dist/esm/version.d.mts +1 -1
  132. package/dist/esm/version.mjs +1 -1
  133. package/dist/llms-full.txt +1 -57014
  134. package/dist/llms.txt +0 -1
  135. package/package.json +1 -1
  136. package/reference.md +331 -9
  137. /package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/{QueryMetricsRequest.js → QueryEventsRequest.js} +0 -0
  138. /package/dist/cjs/api/resources/{metrics/client/requests/QueryMetricsRequest.js → inboxes/resources/metrics/client/requests/QueryUsageRequest.js} +0 -0
  139. /package/dist/cjs/api/resources/{pods/resources/metrics/client/requests/QueryMetricsRequest.js → messages/types/BatchUpdateMessagesMessageIds.js} +0 -0
  140. /package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/{QueryMetricsRequest.mjs → QueryEventsRequest.mjs} +0 -0
  141. /package/dist/esm/api/resources/{metrics/client/requests/QueryMetricsRequest.mjs → inboxes/resources/metrics/client/requests/QueryUsageRequest.mjs} +0 -0
  142. /package/dist/esm/api/resources/{pods/resources/metrics/client/requests/QueryMetricsRequest.mjs → messages/types/BatchUpdateMessagesMessageIds.mjs} +0 -0
package/dist/llms.txt CHANGED
@@ -6,7 +6,6 @@
6
6
 
7
7
  - For clean Markdown of any page, append `.md` to the page URL
8
8
  - For a complete documentation index, see https://docs.agentmail.to/llms.txt
9
- - For full documentation content in one file, see https://docs.agentmail.to/llms-full.txt
10
9
  - For section-specific indexes, append `/llms.txt` to any section URL
11
10
  - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.agentmail.to/_mcp/server
12
11
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agentmail",
3
- "version": "0.5.10",
3
+ "version": "0.5.12",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -3553,6 +3553,89 @@ await client.inboxes.messages.batchGet("inbox_id", {
3553
3553
  </dl>
3554
3554
 
3555
3555
 
3556
+ </dd>
3557
+ </dl>
3558
+ </details>
3559
+
3560
+ <details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">batchUpdate</a>(inbox_id, { ...params }) -> AgentMail.BatchUpdateMessagesResponse</code></summary>
3561
+ <dl>
3562
+ <dd>
3563
+
3564
+ #### 📝 Description
3565
+
3566
+ <dl>
3567
+ <dd>
3568
+
3569
+ <dl>
3570
+ <dd>
3571
+
3572
+ Apply one label change to up to 50 messages in a single request. The
3573
+ same add_labels and remove_labels apply to every message id, and at
3574
+ least one of them must be provided. The update is atomic: either all
3575
+ resolved messages are updated or none are. Missing or restricted ids
3576
+ are silently excluded; compare `count` against `limit` to detect
3577
+ exclusions.
3578
+
3579
+ **CLI:**
3580
+ ```bash
3581
+ agentmail inboxes:messages batch-update --inbox-id <inbox_id> --message-id <id1> --message-id <id2> --add-label read --remove-label unread
3582
+ ```
3583
+ </dd>
3584
+ </dl>
3585
+ </dd>
3586
+ </dl>
3587
+
3588
+ #### 🔌 Usage
3589
+
3590
+ <dl>
3591
+ <dd>
3592
+
3593
+ <dl>
3594
+ <dd>
3595
+
3596
+ ```typescript
3597
+ await client.inboxes.messages.batchUpdate("inbox_id", {
3598
+ messageIds: ["message_ids", "message_ids"]
3599
+ });
3600
+
3601
+ ```
3602
+ </dd>
3603
+ </dl>
3604
+ </dd>
3605
+ </dl>
3606
+
3607
+ #### ⚙️ Parameters
3608
+
3609
+ <dl>
3610
+ <dd>
3611
+
3612
+ <dl>
3613
+ <dd>
3614
+
3615
+ **inbox_id:** `AgentMail.InboxId`
3616
+
3617
+ </dd>
3618
+ </dl>
3619
+
3620
+ <dl>
3621
+ <dd>
3622
+
3623
+ **request:** `AgentMail.BatchUpdateMessagesRequest`
3624
+
3625
+ </dd>
3626
+ </dl>
3627
+
3628
+ <dl>
3629
+ <dd>
3630
+
3631
+ **requestOptions:** `MessagesClient.RequestOptions`
3632
+
3633
+ </dd>
3634
+ </dl>
3635
+ </dd>
3636
+ </dl>
3637
+
3638
+
3556
3639
  </dd>
3557
3640
  </dl>
3558
3641
  </details>
@@ -4192,7 +4275,7 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
4192
4275
  </details>
4193
4276
 
4194
4277
  ## Inboxes Metrics
4195
- <details><summary><code>client.inboxes.metrics.<a href="/src/api/resources/inboxes/resources/metrics/client/Client.ts">query</a>(inbox_id, { ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
4278
+ <details><summary><code>client.inboxes.metrics.<a href="/src/api/resources/inboxes/resources/metrics/client/Client.ts">queryEvents</a>(inbox_id, { ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
4196
4279
  <dl>
4197
4280
  <dd>
4198
4281
 
@@ -4204,6 +4287,12 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
4204
4287
  <dl>
4205
4288
  <dd>
4206
4289
 
4290
+ Counts of email events (sent, delivered, bounced, etc.) over time for
4291
+ the inbox. Defaults to the last 24 hours; `start` must be within the
4292
+ last 90 days, and a future `end` is clamped to now. Omit `period` for
4293
+ individual event counts, or set it to sum counts into buckets of that
4294
+ many seconds.
4295
+
4207
4296
  **CLI:**
4208
4297
  ```bash
4209
4298
  agentmail inboxes:metrics query --inbox-id <inbox_id>
@@ -4222,7 +4311,7 @@ agentmail inboxes:metrics query --inbox-id <inbox_id>
4222
4311
  <dd>
4223
4312
 
4224
4313
  ```typescript
4225
- await client.inboxes.metrics.query("inbox_id");
4314
+ await client.inboxes.metrics.queryEvents("inbox_id");
4226
4315
 
4227
4316
  ```
4228
4317
  </dd>
@@ -4246,7 +4335,84 @@ await client.inboxes.metrics.query("inbox_id");
4246
4335
  <dl>
4247
4336
  <dd>
4248
4337
 
4249
- **request:** `AgentMail.inboxes.QueryMetricsRequest`
4338
+ **request:** `AgentMail.inboxes.QueryEventsRequest`
4339
+
4340
+ </dd>
4341
+ </dl>
4342
+
4343
+ <dl>
4344
+ <dd>
4345
+
4346
+ **requestOptions:** `MetricsClient.RequestOptions`
4347
+
4348
+ </dd>
4349
+ </dl>
4350
+ </dd>
4351
+ </dl>
4352
+
4353
+
4354
+ </dd>
4355
+ </dl>
4356
+ </details>
4357
+
4358
+ <details><summary><code>client.inboxes.metrics.<a href="/src/api/resources/inboxes/resources/metrics/client/Client.ts">queryUsage</a>(inbox_id, { ...params }) -> AgentMail.QueryUsageResponse</code></summary>
4359
+ <dl>
4360
+ <dd>
4361
+
4362
+ #### 📝 Description
4363
+
4364
+ <dl>
4365
+ <dd>
4366
+
4367
+ <dl>
4368
+ <dd>
4369
+
4370
+ Cumulative usage series for the inbox. Each point is the running total
4371
+ of the usage type at that timestamp, not the change within the bucket.
4372
+ Inbox-scoped queries carry `storage_bytes`, `message_count`, and
4373
+ `thread_count`; requested types that don't apply to the scope are
4374
+ ignored. Defaults to the last 24 hours; `start` must be within the
4375
+ last 90 days, and a future `end` is clamped to now. The range divided
4376
+ by `period` must not exceed 1000 buckets.
4377
+ </dd>
4378
+ </dl>
4379
+ </dd>
4380
+ </dl>
4381
+
4382
+ #### 🔌 Usage
4383
+
4384
+ <dl>
4385
+ <dd>
4386
+
4387
+ <dl>
4388
+ <dd>
4389
+
4390
+ ```typescript
4391
+ await client.inboxes.metrics.queryUsage("inbox_id");
4392
+
4393
+ ```
4394
+ </dd>
4395
+ </dl>
4396
+ </dd>
4397
+ </dl>
4398
+
4399
+ #### ⚙️ Parameters
4400
+
4401
+ <dl>
4402
+ <dd>
4403
+
4404
+ <dl>
4405
+ <dd>
4406
+
4407
+ **inbox_id:** `AgentMail.InboxId`
4408
+
4409
+ </dd>
4410
+ </dl>
4411
+
4412
+ <dl>
4413
+ <dd>
4414
+
4415
+ **request:** `AgentMail.inboxes.QueryUsageRequest`
4250
4416
 
4251
4417
  </dd>
4252
4418
  </dl>
@@ -5073,7 +5239,7 @@ await client.lists.delete("send", "allow", "entry");
5073
5239
  </details>
5074
5240
 
5075
5241
  ## Metrics
5076
- <details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">query</a>({ ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
5242
+ <details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryEvents</a>({ ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
5077
5243
  <dl>
5078
5244
  <dd>
5079
5245
 
@@ -5085,6 +5251,12 @@ await client.lists.delete("send", "allow", "entry");
5085
5251
  <dl>
5086
5252
  <dd>
5087
5253
 
5254
+ Counts of email events (sent, delivered, bounced, etc.) over time for
5255
+ the organization. Defaults to the last 24 hours; `start` must be within
5256
+ the last 90 days, and a future `end` is clamped to now. Omit `period`
5257
+ for individual event counts, or set it to sum counts into buckets of
5258
+ that many seconds.
5259
+
5088
5260
  **CLI:**
5089
5261
  ```bash
5090
5262
  agentmail metrics list
@@ -5103,7 +5275,7 @@ agentmail metrics list
5103
5275
  <dd>
5104
5276
 
5105
5277
  ```typescript
5106
- await client.metrics.query();
5278
+ await client.metrics.queryEvents();
5107
5279
 
5108
5280
  ```
5109
5281
  </dd>
@@ -5119,7 +5291,74 @@ await client.metrics.query();
5119
5291
  <dl>
5120
5292
  <dd>
5121
5293
 
5122
- **request:** `AgentMail.QueryMetricsRequest`
5294
+ **request:** `AgentMail.QueryEventsRequest`
5295
+
5296
+ </dd>
5297
+ </dl>
5298
+
5299
+ <dl>
5300
+ <dd>
5301
+
5302
+ **requestOptions:** `MetricsClient.RequestOptions`
5303
+
5304
+ </dd>
5305
+ </dl>
5306
+ </dd>
5307
+ </dl>
5308
+
5309
+
5310
+ </dd>
5311
+ </dl>
5312
+ </details>
5313
+
5314
+ <details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryUsage</a>({ ...params }) -> AgentMail.QueryUsageResponse</code></summary>
5315
+ <dl>
5316
+ <dd>
5317
+
5318
+ #### 📝 Description
5319
+
5320
+ <dl>
5321
+ <dd>
5322
+
5323
+ <dl>
5324
+ <dd>
5325
+
5326
+ Cumulative usage series for the organization. Each point is the running
5327
+ total of the usage type at that timestamp, not the change within the
5328
+ bucket. Defaults to the last 24 hours; `start` must be within the last
5329
+ 90 days, and a future `end` is clamped to now. The range divided by
5330
+ `period` must not exceed 1000 buckets.
5331
+ </dd>
5332
+ </dl>
5333
+ </dd>
5334
+ </dl>
5335
+
5336
+ #### 🔌 Usage
5337
+
5338
+ <dl>
5339
+ <dd>
5340
+
5341
+ <dl>
5342
+ <dd>
5343
+
5344
+ ```typescript
5345
+ await client.metrics.queryUsage();
5346
+
5347
+ ```
5348
+ </dd>
5349
+ </dl>
5350
+ </dd>
5351
+ </dl>
5352
+
5353
+ #### ⚙️ Parameters
5354
+
5355
+ <dl>
5356
+ <dd>
5357
+
5358
+ <dl>
5359
+ <dd>
5360
+
5361
+ **request:** `AgentMail.QueryUsageRequest`
5123
5362
 
5124
5363
  </dd>
5125
5364
  </dl>
@@ -6926,7 +7165,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
6926
7165
  </details>
6927
7166
 
6928
7167
  ## Pods Metrics
6929
- <details><summary><code>client.pods.metrics.<a href="/src/api/resources/pods/resources/metrics/client/Client.ts">query</a>(pod_id, { ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
7168
+ <details><summary><code>client.pods.metrics.<a href="/src/api/resources/pods/resources/metrics/client/Client.ts">queryEvents</a>(pod_id, { ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
6930
7169
  <dl>
6931
7170
  <dd>
6932
7171
 
@@ -6938,6 +7177,12 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
6938
7177
  <dl>
6939
7178
  <dd>
6940
7179
 
7180
+ Counts of email events (sent, delivered, bounced, etc.) over time for
7181
+ the pod. Defaults to the last 24 hours; `start` must be within the last
7182
+ 90 days, and a future `end` is clamped to now. Omit `period` for
7183
+ individual event counts, or set it to sum counts into buckets of that
7184
+ many seconds.
7185
+
6941
7186
  **CLI:**
6942
7187
  ```bash
6943
7188
  agentmail pods:metrics query --pod-id <pod_id>
@@ -6956,7 +7201,84 @@ agentmail pods:metrics query --pod-id <pod_id>
6956
7201
  <dd>
6957
7202
 
6958
7203
  ```typescript
6959
- await client.pods.metrics.query("pod_id");
7204
+ await client.pods.metrics.queryEvents("pod_id");
7205
+
7206
+ ```
7207
+ </dd>
7208
+ </dl>
7209
+ </dd>
7210
+ </dl>
7211
+
7212
+ #### ⚙️ Parameters
7213
+
7214
+ <dl>
7215
+ <dd>
7216
+
7217
+ <dl>
7218
+ <dd>
7219
+
7220
+ **pod_id:** `AgentMail.PodId`
7221
+
7222
+ </dd>
7223
+ </dl>
7224
+
7225
+ <dl>
7226
+ <dd>
7227
+
7228
+ **request:** `AgentMail.pods.QueryEventsRequest`
7229
+
7230
+ </dd>
7231
+ </dl>
7232
+
7233
+ <dl>
7234
+ <dd>
7235
+
7236
+ **requestOptions:** `MetricsClient.RequestOptions`
7237
+
7238
+ </dd>
7239
+ </dl>
7240
+ </dd>
7241
+ </dl>
7242
+
7243
+
7244
+ </dd>
7245
+ </dl>
7246
+ </details>
7247
+
7248
+ <details><summary><code>client.pods.metrics.<a href="/src/api/resources/pods/resources/metrics/client/Client.ts">queryUsage</a>(pod_id, { ...params }) -> AgentMail.QueryUsageResponse</code></summary>
7249
+ <dl>
7250
+ <dd>
7251
+
7252
+ #### 📝 Description
7253
+
7254
+ <dl>
7255
+ <dd>
7256
+
7257
+ <dl>
7258
+ <dd>
7259
+
7260
+ Cumulative usage series for the pod. Each point is the running total of
7261
+ the usage type at that timestamp, not the change within the bucket.
7262
+ Pod-scoped queries carry every usage type except `pod_count`; requested
7263
+ types that don't apply to the scope are ignored. Defaults to the last
7264
+ 24 hours; `start` must be within the last 90 days, and a future `end`
7265
+ is clamped to now. The range divided by `period` must not exceed 1000
7266
+ buckets.
7267
+ </dd>
7268
+ </dl>
7269
+ </dd>
7270
+ </dl>
7271
+
7272
+ #### 🔌 Usage
7273
+
7274
+ <dl>
7275
+ <dd>
7276
+
7277
+ <dl>
7278
+ <dd>
7279
+
7280
+ ```typescript
7281
+ await client.pods.metrics.queryUsage("pod_id");
6960
7282
 
6961
7283
  ```
6962
7284
  </dd>
@@ -6980,7 +7302,7 @@ await client.pods.metrics.query("pod_id");
6980
7302
  <dl>
6981
7303
  <dd>
6982
7304
 
6983
- **request:** `AgentMail.pods.QueryMetricsRequest`
7305
+ **request:** `AgentMail.pods.QueryUsageRequest`
6984
7306
 
6985
7307
  </dd>
6986
7308
  </dl>