agentmail 0.5.41 → 0.5.43
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.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/calendar/types/UpdateCalendarEventRequest.d.ts +2 -1
- package/dist/cjs/api/resources/inboxes/resources/calendar/client/Client.d.ts +21 -21
- package/dist/cjs/api/resources/inboxes/resources/calendar/client/Client.js +21 -21
- package/dist/cjs/api/resources/inboxes/resources/webhooks/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/client/Client.js +5 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/exports.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/exports.js +1 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/index.js +1 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/index.js +41 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/client/Client.d.ts +89 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/client/Client.js +351 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/client/index.js +17 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/client/requests/InboxListPollingWebhooksRequest.d.ts +10 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/client/requests/InboxListPollingWebhooksRequest.js +3 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/exports.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/exports.js +21 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/resources/polling/index.js +17 -0
- package/dist/cjs/api/resources/messages/types/Message.d.ts +1 -0
- package/dist/cjs/api/resources/messages/types/MessageCalendarEventId.d.ts +8 -0
- package/dist/cjs/api/resources/messages/types/MessageCalendarEventId.js +3 -0
- package/dist/cjs/api/resources/messages/types/MessageItem.d.ts +1 -0
- package/dist/cjs/api/resources/messages/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/types/index.js +1 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/client/Client.js +5 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/exports.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/exports.js +1 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/index.js +1 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/index.js +41 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/client/Client.d.ts +89 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/client/Client.js +351 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/client/index.js +17 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/client/requests/PodListPollingWebhooksRequest.d.ts +10 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/client/requests/PodListPollingWebhooksRequest.js +3 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/exports.d.ts +2 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/exports.js +21 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/resources/polling/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +5 -0
- package/dist/cjs/api/resources/webhooks/resources/index.d.ts +3 -0
- package/dist/cjs/api/resources/webhooks/resources/index.js +4 -1
- package/dist/cjs/api/resources/webhooks/resources/polling/client/Client.d.ts +92 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/client/Client.js +354 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/client/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/client/requests/ListPollingWebhooksRequest.d.ts +10 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/client/requests/ListPollingWebhooksRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/exports.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/exports.js +21 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/index.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/index.js +18 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/CreateInboxPollingWebhookRequest.d.ts +9 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/CreateInboxPollingWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/CreatePodPollingWebhookRequest.d.ts +9 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/CreatePodPollingWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/CreatePollingWebhookRequest.d.ts +9 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/CreatePollingWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/CreatePollingWebhookResponse.d.ts +7 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/CreatePollingWebhookResponse.js +3 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/ListPollingWebhooksResponse.d.ts +12 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/ListPollingWebhooksResponse.js +3 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/PollingClientId.d.ts +7 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/PollingClientId.js +3 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/PollingToken.d.ts +8 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/PollingToken.js +3 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/PollingWebhook.d.ts +27 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/PollingWebhook.js +3 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/index.d.ts +8 -0
- package/dist/cjs/api/resources/webhooks/resources/polling/types/index.js +24 -0
- package/dist/cjs/serialization/resources/messages/types/Message.d.ts +2 -0
- package/dist/cjs/serialization/resources/messages/types/Message.js +2 -0
- package/dist/cjs/serialization/resources/messages/types/MessageCalendarEventId.d.ts +7 -0
- package/dist/cjs/serialization/resources/messages/types/MessageCalendarEventId.js +39 -0
- package/dist/cjs/serialization/resources/messages/types/MessageItem.d.ts +2 -0
- package/dist/cjs/serialization/resources/messages/types/MessageItem.js +2 -0
- package/dist/cjs/serialization/resources/messages/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/messages/types/index.js +1 -0
- package/dist/cjs/serialization/resources/webhooks/resources/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/webhooks/resources/index.js +3 -1
- package/dist/cjs/serialization/resources/webhooks/resources/polling/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/index.js +17 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/CreateInboxPollingWebhookRequest.d.ts +12 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/CreateInboxPollingWebhookRequest.js +44 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/CreatePodPollingWebhookRequest.d.ts +11 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/CreatePodPollingWebhookRequest.js +45 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/CreatePollingWebhookRequest.d.ts +11 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/CreatePollingWebhookRequest.js +45 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/CreatePollingWebhookResponse.d.ts +11 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/CreatePollingWebhookResponse.js +45 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/ListPollingWebhooksResponse.d.ts +16 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/ListPollingWebhooksResponse.js +48 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/PollingClientId.d.ts +8 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/PollingClientId.js +6 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/PollingToken.d.ts +7 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/PollingToken.js +39 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/PollingWebhook.d.ts +22 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/PollingWebhook.js +54 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/index.d.ts +8 -0
- package/dist/cjs/serialization/resources/webhooks/resources/polling/types/index.js +24 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/calendar/types/UpdateCalendarEventRequest.d.mts +2 -1
- package/dist/esm/api/resources/inboxes/resources/calendar/client/Client.d.mts +21 -21
- package/dist/esm/api/resources/inboxes/resources/calendar/client/Client.mjs +21 -21
- package/dist/esm/api/resources/inboxes/resources/webhooks/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/client/Client.mjs +5 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/exports.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/exports.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/index.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/client/Client.d.mts +89 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/client/Client.mjs +314 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/client/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/client/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/client/requests/InboxListPollingWebhooksRequest.d.mts +10 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/client/requests/InboxListPollingWebhooksRequest.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/exports.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/exports.mjs +3 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/resources/polling/index.mjs +1 -0
- package/dist/esm/api/resources/messages/types/Message.d.mts +1 -0
- package/dist/esm/api/resources/messages/types/MessageCalendarEventId.d.mts +8 -0
- package/dist/esm/api/resources/messages/types/MessageCalendarEventId.mjs +2 -0
- package/dist/esm/api/resources/messages/types/MessageItem.d.mts +1 -0
- package/dist/esm/api/resources/messages/types/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/types/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/pods/resources/webhooks/client/Client.mjs +5 -0
- package/dist/esm/api/resources/pods/resources/webhooks/exports.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/exports.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/index.mjs +2 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/client/Client.d.mts +89 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/client/Client.mjs +314 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/client/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/client/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/client/requests/PodListPollingWebhooksRequest.d.mts +10 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/client/requests/PodListPollingWebhooksRequest.mjs +2 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/exports.d.mts +2 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/exports.mjs +3 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/resources/polling/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +5 -0
- package/dist/esm/api/resources/webhooks/resources/index.d.mts +3 -0
- package/dist/esm/api/resources/webhooks/resources/index.mjs +3 -0
- package/dist/esm/api/resources/webhooks/resources/polling/client/Client.d.mts +92 -0
- package/dist/esm/api/resources/webhooks/resources/polling/client/Client.mjs +317 -0
- package/dist/esm/api/resources/webhooks/resources/polling/client/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/resources/polling/client/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/resources/polling/client/requests/ListPollingWebhooksRequest.d.mts +10 -0
- package/dist/esm/api/resources/webhooks/resources/polling/client/requests/ListPollingWebhooksRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/resources/polling/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/resources/polling/exports.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/exports.mjs +3 -0
- package/dist/esm/api/resources/webhooks/resources/polling/index.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/index.mjs +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/CreateInboxPollingWebhookRequest.d.mts +9 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/CreateInboxPollingWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/CreatePodPollingWebhookRequest.d.mts +9 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/CreatePodPollingWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/CreatePollingWebhookRequest.d.mts +9 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/CreatePollingWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/CreatePollingWebhookResponse.d.mts +7 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/CreatePollingWebhookResponse.mjs +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/ListPollingWebhooksResponse.d.mts +12 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/ListPollingWebhooksResponse.mjs +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/PollingClientId.d.mts +7 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/PollingClientId.mjs +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/PollingToken.d.mts +8 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/PollingToken.mjs +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/PollingWebhook.d.mts +27 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/PollingWebhook.mjs +2 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/index.d.mts +8 -0
- package/dist/esm/api/resources/webhooks/resources/polling/types/index.mjs +8 -0
- package/dist/esm/serialization/resources/messages/types/Message.d.mts +2 -0
- package/dist/esm/serialization/resources/messages/types/Message.mjs +2 -0
- package/dist/esm/serialization/resources/messages/types/MessageCalendarEventId.d.mts +7 -0
- package/dist/esm/serialization/resources/messages/types/MessageCalendarEventId.mjs +3 -0
- package/dist/esm/serialization/resources/messages/types/MessageItem.d.mts +2 -0
- package/dist/esm/serialization/resources/messages/types/MessageItem.mjs +2 -0
- package/dist/esm/serialization/resources/messages/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/messages/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/webhooks/resources/index.d.mts +2 -0
- package/dist/esm/serialization/resources/webhooks/resources/index.mjs +2 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/index.d.mts +1 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/index.mjs +1 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/CreateInboxPollingWebhookRequest.d.mts +12 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/CreateInboxPollingWebhookRequest.mjs +8 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/CreatePodPollingWebhookRequest.d.mts +11 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/CreatePodPollingWebhookRequest.mjs +9 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/CreatePollingWebhookRequest.d.mts +11 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/CreatePollingWebhookRequest.mjs +9 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/CreatePollingWebhookResponse.d.mts +11 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/CreatePollingWebhookResponse.mjs +9 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/ListPollingWebhooksResponse.d.mts +16 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/ListPollingWebhooksResponse.mjs +12 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/PollingClientId.d.mts +8 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/PollingClientId.mjs +3 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/PollingToken.d.mts +7 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/PollingToken.mjs +3 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/PollingWebhook.d.mts +22 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/PollingWebhook.mjs +18 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/index.d.mts +8 -0
- package/dist/esm/serialization/resources/webhooks/resources/polling/types/index.mjs +8 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +34 -1
- package/reference.md +1462 -575
package/reference.md
CHANGED
|
@@ -3643,9 +3643,9 @@ Gets the inbox's calendar. Every inbox has one calendar, so this works before an
|
|
|
3643
3643
|
created. Its `etag` (also the `ETag` response header) is the value to send in `If-Match` to
|
|
3644
3644
|
make an update conditional.
|
|
3645
3645
|
|
|
3646
|
-
Requires the `calendar_read` permission. Calendar is in
|
|
3647
|
-
|
|
3648
|
-
|
|
3646
|
+
Requires the `calendar_read` permission. Calendar is in AgentMail Labs, available in US production (`api.agentmail.to`)
|
|
3647
|
+
but not yet in EU production (`api.agentmail.eu`). Organizations that have not joined
|
|
3648
|
+
Labs receive a `403`.
|
|
3649
3649
|
</dd>
|
|
3650
3650
|
</dl>
|
|
3651
3651
|
</dd>
|
|
@@ -3723,8 +3723,8 @@ Requires the `calendar_update` permission. To make the update conditional, send
|
|
|
3723
3723
|
calendar's current `etag` in `If-Match`: a stale value returns `412`. Without `If-Match` the
|
|
3724
3724
|
update applies to the calendar as it is.
|
|
3725
3725
|
|
|
3726
|
-
Calendar is in
|
|
3727
|
-
production (`api.agentmail.eu`). Organizations
|
|
3726
|
+
Calendar is in AgentMail Labs, available in US production (`api.agentmail.to`) but not yet
|
|
3727
|
+
in EU production (`api.agentmail.eu`). Organizations that have not joined Labs receive a `403`.
|
|
3728
3728
|
</dd>
|
|
3729
3729
|
</dl>
|
|
3730
3730
|
</dd>
|
|
@@ -3806,8 +3806,8 @@ use Get Agenda.
|
|
|
3806
3806
|
The list is always read in the region that serves the request, so it can trail a change made
|
|
3807
3807
|
moments earlier by a few seconds. Requires the `calendar_event_read` permission.
|
|
3808
3808
|
|
|
3809
|
-
Calendar is in
|
|
3810
|
-
production (`api.agentmail.eu`). Organizations
|
|
3809
|
+
Calendar is in AgentMail Labs, available in US production (`api.agentmail.to`) but not yet
|
|
3810
|
+
in EU production (`api.agentmail.eu`). Organizations that have not joined Labs receive a `403`.
|
|
3811
3811
|
</dd>
|
|
3812
3812
|
</dl>
|
|
3813
3813
|
</dd>
|
|
@@ -3897,8 +3897,8 @@ The agenda is read in the region that serves the request, so it can trail a chan
|
|
|
3897
3897
|
moments earlier by a few seconds. Pass `consistency=primary` to read your own change right
|
|
3898
3898
|
away. Requires the `calendar_event_read` permission.
|
|
3899
3899
|
|
|
3900
|
-
Calendar is in
|
|
3901
|
-
production (`api.agentmail.eu`). Organizations
|
|
3900
|
+
Calendar is in AgentMail Labs, available in US production (`api.agentmail.to`) but not yet
|
|
3901
|
+
in EU production (`api.agentmail.eu`). Organizations that have not joined Labs receive a `403`.
|
|
3902
3902
|
</dd>
|
|
3903
3903
|
</dl>
|
|
3904
3904
|
</dd>
|
|
@@ -3993,8 +3993,8 @@ charged again.
|
|
|
3993
3993
|
The event's `etag` is the value to send in `If-Match` to make a later update or delete
|
|
3994
3994
|
conditional. Requires the `calendar_event_create` permission.
|
|
3995
3995
|
|
|
3996
|
-
Calendar is in
|
|
3997
|
-
production (`api.agentmail.eu`). Organizations
|
|
3996
|
+
Calendar is in AgentMail Labs, available in US production (`api.agentmail.to`) but not yet
|
|
3997
|
+
in EU production (`api.agentmail.eu`). Organizations that have not joined Labs receive a `403`.
|
|
3998
3998
|
</dd>
|
|
3999
3999
|
</dl>
|
|
4000
4000
|
</dd>
|
|
@@ -4093,8 +4093,8 @@ to read the latest state of an event or a date. A date that has already started
|
|
|
4093
4093
|
reads back as it ran, even if a later change to the series no longer produces it. Requires
|
|
4094
4094
|
the `calendar_event_read` permission.
|
|
4095
4095
|
|
|
4096
|
-
Calendar is in
|
|
4097
|
-
production (`api.agentmail.eu`). Organizations
|
|
4096
|
+
Calendar is in AgentMail Labs, available in US production (`api.agentmail.to`) but not yet
|
|
4097
|
+
in EU production (`api.agentmail.eu`). Organizations that have not joined Labs receive a `403`.
|
|
4098
4098
|
</dd>
|
|
4099
4099
|
</dl>
|
|
4100
4100
|
</dd>
|
|
@@ -4198,8 +4198,8 @@ Emailing attendees counts one send per attendee against the organization, pod an
|
|
|
4198
4198
|
send limits, charged before the change is saved; an over-limit request returns `429`
|
|
4199
4199
|
`rate_limit_exceeded` and changes nothing.
|
|
4200
4200
|
|
|
4201
|
-
Calendar is in
|
|
4202
|
-
production (`api.agentmail.eu`). Organizations
|
|
4201
|
+
Calendar is in AgentMail Labs, available in US production (`api.agentmail.to`) but not yet
|
|
4202
|
+
in EU production (`api.agentmail.eu`). Organizations that have not joined Labs receive a `403`.
|
|
4203
4203
|
</dd>
|
|
4204
4204
|
</dl>
|
|
4205
4205
|
</dd>
|
|
@@ -4304,8 +4304,8 @@ Emailing cancellations counts one send per attendee against the organization, po
|
|
|
4304
4304
|
send limits, charged before the delete; an over-limit request returns `429`
|
|
4305
4305
|
`rate_limit_exceeded` and deletes nothing.
|
|
4306
4306
|
|
|
4307
|
-
Calendar is in
|
|
4308
|
-
production (`api.agentmail.eu`). Organizations
|
|
4307
|
+
Calendar is in AgentMail Labs, available in US production (`api.agentmail.to`) but not yet
|
|
4308
|
+
in EU production (`api.agentmail.eu`). Organizations that have not joined Labs receive a `403`.
|
|
4309
4309
|
</dd>
|
|
4310
4310
|
</dl>
|
|
4311
4311
|
</dd>
|
|
@@ -4396,8 +4396,8 @@ and `attendees`; get a date by its ID for the full object. Like other reads, the
|
|
|
4396
4396
|
trail a change made moments earlier by a few seconds; pass `consistency=primary` to read
|
|
4397
4397
|
your own change right away. Requires the `calendar_event_read` permission.
|
|
4398
4398
|
|
|
4399
|
-
Calendar is in
|
|
4400
|
-
production (`api.agentmail.eu`). Organizations
|
|
4399
|
+
Calendar is in AgentMail Labs, available in US production (`api.agentmail.to`) but not yet
|
|
4400
|
+
in EU production (`api.agentmail.eu`). Organizations that have not joined Labs receive a `403`.
|
|
4401
4401
|
</dd>
|
|
4402
4402
|
</dl>
|
|
4403
4403
|
</dd>
|
|
@@ -4494,8 +4494,8 @@ A reply email counts as one send against the organization, pod and inbox send li
|
|
|
4494
4494
|
charged before the response is saved; an over-limit request returns `429`
|
|
4495
4495
|
`rate_limit_exceeded` and changes nothing.
|
|
4496
4496
|
|
|
4497
|
-
Calendar is in
|
|
4498
|
-
production (`api.agentmail.eu`). Organizations
|
|
4497
|
+
Calendar is in AgentMail Labs, available in US production (`api.agentmail.to`) but not yet
|
|
4498
|
+
in EU production (`api.agentmail.eu`). Organizations that have not joined Labs receive a `403`.
|
|
4499
4499
|
</dd>
|
|
4500
4500
|
</dl>
|
|
4501
4501
|
</dd>
|
|
@@ -7840,8 +7840,8 @@ await client.inboxes.webhooks.delete("inbox_id", "webhook_id");
|
|
|
7840
7840
|
</dl>
|
|
7841
7841
|
</details>
|
|
7842
7842
|
|
|
7843
|
-
##
|
|
7844
|
-
<details><summary><code>client.
|
|
7843
|
+
## Inboxes Webhooks Polling
|
|
7844
|
+
<details><summary><code>client.inboxes.webhooks.polling.<a href="/src/api/resources/inboxes/resources/webhooks/resources/polling/client/Client.ts">list</a>(inbox_id, { ...params }) -> AgentMail.ListPollingWebhooksResponse</code></summary>
|
|
7845
7845
|
<dl>
|
|
7846
7846
|
<dd>
|
|
7847
7847
|
|
|
@@ -7853,9 +7853,11 @@ await client.inboxes.webhooks.delete("inbox_id", "webhook_id");
|
|
|
7853
7853
|
<dl>
|
|
7854
7854
|
<dd>
|
|
7855
7855
|
|
|
7856
|
+
Lists the polling webhooks created through this inbox route.
|
|
7857
|
+
|
|
7856
7858
|
**CLI:**
|
|
7857
7859
|
```bash
|
|
7858
|
-
agentmail
|
|
7860
|
+
agentmail inboxes webhooks polling list --inbox-id <inbox_id>
|
|
7859
7861
|
```
|
|
7860
7862
|
</dd>
|
|
7861
7863
|
</dl>
|
|
@@ -7871,7 +7873,7 @@ agentmail lists list --direction <direction> --type <type>
|
|
|
7871
7873
|
<dd>
|
|
7872
7874
|
|
|
7873
7875
|
```typescript
|
|
7874
|
-
await client.
|
|
7876
|
+
await client.inboxes.webhooks.polling.list("inbox_id");
|
|
7875
7877
|
|
|
7876
7878
|
```
|
|
7877
7879
|
</dd>
|
|
@@ -7887,7 +7889,7 @@ await client.lists.list("send", "allow");
|
|
|
7887
7889
|
<dl>
|
|
7888
7890
|
<dd>
|
|
7889
7891
|
|
|
7890
|
-
**
|
|
7892
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
7891
7893
|
|
|
7892
7894
|
</dd>
|
|
7893
7895
|
</dl>
|
|
@@ -7895,7 +7897,7 @@ await client.lists.list("send", "allow");
|
|
|
7895
7897
|
<dl>
|
|
7896
7898
|
<dd>
|
|
7897
7899
|
|
|
7898
|
-
**
|
|
7900
|
+
**request:** `AgentMail.inboxes.webhooks.InboxListPollingWebhooksRequest`
|
|
7899
7901
|
|
|
7900
7902
|
</dd>
|
|
7901
7903
|
</dl>
|
|
@@ -7903,15 +7905,81 @@ await client.lists.list("send", "allow");
|
|
|
7903
7905
|
<dl>
|
|
7904
7906
|
<dd>
|
|
7905
7907
|
|
|
7906
|
-
**
|
|
7908
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
7907
7909
|
|
|
7908
7910
|
</dd>
|
|
7909
7911
|
</dl>
|
|
7912
|
+
</dd>
|
|
7913
|
+
</dl>
|
|
7914
|
+
|
|
7915
|
+
|
|
7916
|
+
</dd>
|
|
7917
|
+
</dl>
|
|
7918
|
+
</details>
|
|
7910
7919
|
|
|
7920
|
+
<details><summary><code>client.inboxes.webhooks.polling.<a href="/src/api/resources/inboxes/resources/webhooks/resources/polling/client/Client.ts">get</a>(inbox_id, webhook_id) -> AgentMail.PollingWebhook</code></summary>
|
|
7911
7921
|
<dl>
|
|
7912
7922
|
<dd>
|
|
7913
7923
|
|
|
7914
|
-
|
|
7924
|
+
#### 📝 Description
|
|
7925
|
+
|
|
7926
|
+
<dl>
|
|
7927
|
+
<dd>
|
|
7928
|
+
|
|
7929
|
+
<dl>
|
|
7930
|
+
<dd>
|
|
7931
|
+
|
|
7932
|
+
**CLI:**
|
|
7933
|
+
```bash
|
|
7934
|
+
agentmail inboxes webhooks polling get --inbox-id <inbox_id> --webhook-id <webhook_id>
|
|
7935
|
+
```
|
|
7936
|
+
</dd>
|
|
7937
|
+
</dl>
|
|
7938
|
+
</dd>
|
|
7939
|
+
</dl>
|
|
7940
|
+
|
|
7941
|
+
#### 🔌 Usage
|
|
7942
|
+
|
|
7943
|
+
<dl>
|
|
7944
|
+
<dd>
|
|
7945
|
+
|
|
7946
|
+
<dl>
|
|
7947
|
+
<dd>
|
|
7948
|
+
|
|
7949
|
+
```typescript
|
|
7950
|
+
await client.inboxes.webhooks.polling.get("inbox_id", "webhook_id");
|
|
7951
|
+
|
|
7952
|
+
```
|
|
7953
|
+
</dd>
|
|
7954
|
+
</dl>
|
|
7955
|
+
</dd>
|
|
7956
|
+
</dl>
|
|
7957
|
+
|
|
7958
|
+
#### ⚙️ Parameters
|
|
7959
|
+
|
|
7960
|
+
<dl>
|
|
7961
|
+
<dd>
|
|
7962
|
+
|
|
7963
|
+
<dl>
|
|
7964
|
+
<dd>
|
|
7965
|
+
|
|
7966
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
7967
|
+
|
|
7968
|
+
</dd>
|
|
7969
|
+
</dl>
|
|
7970
|
+
|
|
7971
|
+
<dl>
|
|
7972
|
+
<dd>
|
|
7973
|
+
|
|
7974
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
7975
|
+
|
|
7976
|
+
</dd>
|
|
7977
|
+
</dl>
|
|
7978
|
+
|
|
7979
|
+
<dl>
|
|
7980
|
+
<dd>
|
|
7981
|
+
|
|
7982
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
7915
7983
|
|
|
7916
7984
|
</dd>
|
|
7917
7985
|
</dl>
|
|
@@ -7923,7 +7991,7 @@ await client.lists.list("send", "allow");
|
|
|
7923
7991
|
</dl>
|
|
7924
7992
|
</details>
|
|
7925
7993
|
|
|
7926
|
-
<details><summary><code>client.
|
|
7994
|
+
<details><summary><code>client.inboxes.webhooks.polling.<a href="/src/api/resources/inboxes/resources/webhooks/resources/polling/client/Client.ts">create</a>(inbox_id, { ...params }) -> AgentMail.CreatePollingWebhookResponse</code></summary>
|
|
7927
7995
|
<dl>
|
|
7928
7996
|
<dd>
|
|
7929
7997
|
|
|
@@ -7935,9 +8003,11 @@ await client.lists.list("send", "allow");
|
|
|
7935
8003
|
<dl>
|
|
7936
8004
|
<dd>
|
|
7937
8005
|
|
|
8006
|
+
Create a polling webhook scoped to this inbox and return the `token` that reads it.
|
|
8007
|
+
|
|
7938
8008
|
**CLI:**
|
|
7939
8009
|
```bash
|
|
7940
|
-
agentmail
|
|
8010
|
+
agentmail inboxes webhooks polling create --inbox-id <inbox_id> --client-id my-agent --event-types message.received
|
|
7941
8011
|
```
|
|
7942
8012
|
</dd>
|
|
7943
8013
|
</dl>
|
|
@@ -7953,7 +8023,159 @@ agentmail lists get --direction <direction> --type <type> --entry <entry>
|
|
|
7953
8023
|
<dd>
|
|
7954
8024
|
|
|
7955
8025
|
```typescript
|
|
7956
|
-
await client.
|
|
8026
|
+
await client.inboxes.webhooks.polling.create("inbox_id", {
|
|
8027
|
+
clientId: "client_id",
|
|
8028
|
+
eventTypes: ["message.received", "message.received"]
|
|
8029
|
+
});
|
|
8030
|
+
|
|
8031
|
+
```
|
|
8032
|
+
</dd>
|
|
8033
|
+
</dl>
|
|
8034
|
+
</dd>
|
|
8035
|
+
</dl>
|
|
8036
|
+
|
|
8037
|
+
#### ⚙️ Parameters
|
|
8038
|
+
|
|
8039
|
+
<dl>
|
|
8040
|
+
<dd>
|
|
8041
|
+
|
|
8042
|
+
<dl>
|
|
8043
|
+
<dd>
|
|
8044
|
+
|
|
8045
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
8046
|
+
|
|
8047
|
+
</dd>
|
|
8048
|
+
</dl>
|
|
8049
|
+
|
|
8050
|
+
<dl>
|
|
8051
|
+
<dd>
|
|
8052
|
+
|
|
8053
|
+
**request:** `AgentMail.CreateInboxPollingWebhookRequest`
|
|
8054
|
+
|
|
8055
|
+
</dd>
|
|
8056
|
+
</dl>
|
|
8057
|
+
|
|
8058
|
+
<dl>
|
|
8059
|
+
<dd>
|
|
8060
|
+
|
|
8061
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
8062
|
+
|
|
8063
|
+
</dd>
|
|
8064
|
+
</dl>
|
|
8065
|
+
</dd>
|
|
8066
|
+
</dl>
|
|
8067
|
+
|
|
8068
|
+
|
|
8069
|
+
</dd>
|
|
8070
|
+
</dl>
|
|
8071
|
+
</details>
|
|
8072
|
+
|
|
8073
|
+
<details><summary><code>client.inboxes.webhooks.polling.<a href="/src/api/resources/inboxes/resources/webhooks/resources/polling/client/Client.ts">delete</a>(inbox_id, webhook_id) -> void</code></summary>
|
|
8074
|
+
<dl>
|
|
8075
|
+
<dd>
|
|
8076
|
+
|
|
8077
|
+
#### 📝 Description
|
|
8078
|
+
|
|
8079
|
+
<dl>
|
|
8080
|
+
<dd>
|
|
8081
|
+
|
|
8082
|
+
<dl>
|
|
8083
|
+
<dd>
|
|
8084
|
+
|
|
8085
|
+
**CLI:**
|
|
8086
|
+
```bash
|
|
8087
|
+
agentmail inboxes webhooks polling delete --inbox-id <inbox_id> --webhook-id <webhook_id>
|
|
8088
|
+
```
|
|
8089
|
+
</dd>
|
|
8090
|
+
</dl>
|
|
8091
|
+
</dd>
|
|
8092
|
+
</dl>
|
|
8093
|
+
|
|
8094
|
+
#### 🔌 Usage
|
|
8095
|
+
|
|
8096
|
+
<dl>
|
|
8097
|
+
<dd>
|
|
8098
|
+
|
|
8099
|
+
<dl>
|
|
8100
|
+
<dd>
|
|
8101
|
+
|
|
8102
|
+
```typescript
|
|
8103
|
+
await client.inboxes.webhooks.polling.delete("inbox_id", "webhook_id");
|
|
8104
|
+
|
|
8105
|
+
```
|
|
8106
|
+
</dd>
|
|
8107
|
+
</dl>
|
|
8108
|
+
</dd>
|
|
8109
|
+
</dl>
|
|
8110
|
+
|
|
8111
|
+
#### ⚙️ Parameters
|
|
8112
|
+
|
|
8113
|
+
<dl>
|
|
8114
|
+
<dd>
|
|
8115
|
+
|
|
8116
|
+
<dl>
|
|
8117
|
+
<dd>
|
|
8118
|
+
|
|
8119
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
8120
|
+
|
|
8121
|
+
</dd>
|
|
8122
|
+
</dl>
|
|
8123
|
+
|
|
8124
|
+
<dl>
|
|
8125
|
+
<dd>
|
|
8126
|
+
|
|
8127
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
8128
|
+
|
|
8129
|
+
</dd>
|
|
8130
|
+
</dl>
|
|
8131
|
+
|
|
8132
|
+
<dl>
|
|
8133
|
+
<dd>
|
|
8134
|
+
|
|
8135
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
8136
|
+
|
|
8137
|
+
</dd>
|
|
8138
|
+
</dl>
|
|
8139
|
+
</dd>
|
|
8140
|
+
</dl>
|
|
8141
|
+
|
|
8142
|
+
|
|
8143
|
+
</dd>
|
|
8144
|
+
</dl>
|
|
8145
|
+
</details>
|
|
8146
|
+
|
|
8147
|
+
## Lists
|
|
8148
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">list</a>(direction, type, { ...params }) -> AgentMail.ListListEntriesResponse</code></summary>
|
|
8149
|
+
<dl>
|
|
8150
|
+
<dd>
|
|
8151
|
+
|
|
8152
|
+
#### 📝 Description
|
|
8153
|
+
|
|
8154
|
+
<dl>
|
|
8155
|
+
<dd>
|
|
8156
|
+
|
|
8157
|
+
<dl>
|
|
8158
|
+
<dd>
|
|
8159
|
+
|
|
8160
|
+
**CLI:**
|
|
8161
|
+
```bash
|
|
8162
|
+
agentmail lists list --direction <direction> --type <type>
|
|
8163
|
+
```
|
|
8164
|
+
</dd>
|
|
8165
|
+
</dl>
|
|
8166
|
+
</dd>
|
|
8167
|
+
</dl>
|
|
8168
|
+
|
|
8169
|
+
#### 🔌 Usage
|
|
8170
|
+
|
|
8171
|
+
<dl>
|
|
8172
|
+
<dd>
|
|
8173
|
+
|
|
8174
|
+
<dl>
|
|
8175
|
+
<dd>
|
|
8176
|
+
|
|
8177
|
+
```typescript
|
|
8178
|
+
await client.lists.list("send", "allow");
|
|
7957
8179
|
|
|
7958
8180
|
```
|
|
7959
8181
|
</dd>
|
|
@@ -7985,7 +8207,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
7985
8207
|
<dl>
|
|
7986
8208
|
<dd>
|
|
7987
8209
|
|
|
7988
|
-
**
|
|
8210
|
+
**request:** `AgentMail.ListListEntriesRequest`
|
|
7989
8211
|
|
|
7990
8212
|
</dd>
|
|
7991
8213
|
</dl>
|
|
@@ -8005,7 +8227,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
8005
8227
|
</dl>
|
|
8006
8228
|
</details>
|
|
8007
8229
|
|
|
8008
|
-
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">
|
|
8230
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">get</a>(direction, type, entry) -> AgentMail.ListEntry</code></summary>
|
|
8009
8231
|
<dl>
|
|
8010
8232
|
<dd>
|
|
8011
8233
|
|
|
@@ -8019,7 +8241,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
8019
8241
|
|
|
8020
8242
|
**CLI:**
|
|
8021
8243
|
```bash
|
|
8022
|
-
agentmail lists
|
|
8244
|
+
agentmail lists get --direction <direction> --type <type> --entry <entry>
|
|
8023
8245
|
```
|
|
8024
8246
|
</dd>
|
|
8025
8247
|
</dl>
|
|
@@ -8035,9 +8257,7 @@ agentmail lists create --direction <direction> --type <type> --entry user@exampl
|
|
|
8035
8257
|
<dd>
|
|
8036
8258
|
|
|
8037
8259
|
```typescript
|
|
8038
|
-
await client.lists.
|
|
8039
|
-
entry: "entry"
|
|
8040
|
-
});
|
|
8260
|
+
await client.lists.get("send", "allow", "entry");
|
|
8041
8261
|
|
|
8042
8262
|
```
|
|
8043
8263
|
</dd>
|
|
@@ -8053,15 +8273,679 @@ await client.lists.create("send", "allow", {
|
|
|
8053
8273
|
<dl>
|
|
8054
8274
|
<dd>
|
|
8055
8275
|
|
|
8056
|
-
**direction:** `AgentMail.Direction`
|
|
8057
|
-
|
|
8058
|
-
</dd>
|
|
8059
|
-
</dl>
|
|
8060
|
-
|
|
8276
|
+
**direction:** `AgentMail.Direction`
|
|
8277
|
+
|
|
8278
|
+
</dd>
|
|
8279
|
+
</dl>
|
|
8280
|
+
|
|
8281
|
+
<dl>
|
|
8282
|
+
<dd>
|
|
8283
|
+
|
|
8284
|
+
**type:** `AgentMail.ListType`
|
|
8285
|
+
|
|
8286
|
+
</dd>
|
|
8287
|
+
</dl>
|
|
8288
|
+
|
|
8289
|
+
<dl>
|
|
8290
|
+
<dd>
|
|
8291
|
+
|
|
8292
|
+
**entry:** `string` — Email address or domain.
|
|
8293
|
+
|
|
8294
|
+
</dd>
|
|
8295
|
+
</dl>
|
|
8296
|
+
|
|
8297
|
+
<dl>
|
|
8298
|
+
<dd>
|
|
8299
|
+
|
|
8300
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
8301
|
+
|
|
8302
|
+
</dd>
|
|
8303
|
+
</dl>
|
|
8304
|
+
</dd>
|
|
8305
|
+
</dl>
|
|
8306
|
+
|
|
8307
|
+
|
|
8308
|
+
</dd>
|
|
8309
|
+
</dl>
|
|
8310
|
+
</details>
|
|
8311
|
+
|
|
8312
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">create</a>(direction, type, { ...params }) -> AgentMail.ListEntry</code></summary>
|
|
8313
|
+
<dl>
|
|
8314
|
+
<dd>
|
|
8315
|
+
|
|
8316
|
+
#### 📝 Description
|
|
8317
|
+
|
|
8318
|
+
<dl>
|
|
8319
|
+
<dd>
|
|
8320
|
+
|
|
8321
|
+
<dl>
|
|
8322
|
+
<dd>
|
|
8323
|
+
|
|
8324
|
+
**CLI:**
|
|
8325
|
+
```bash
|
|
8326
|
+
agentmail lists create --direction <direction> --type <type> --entry user@example.com
|
|
8327
|
+
```
|
|
8328
|
+
</dd>
|
|
8329
|
+
</dl>
|
|
8330
|
+
</dd>
|
|
8331
|
+
</dl>
|
|
8332
|
+
|
|
8333
|
+
#### 🔌 Usage
|
|
8334
|
+
|
|
8335
|
+
<dl>
|
|
8336
|
+
<dd>
|
|
8337
|
+
|
|
8338
|
+
<dl>
|
|
8339
|
+
<dd>
|
|
8340
|
+
|
|
8341
|
+
```typescript
|
|
8342
|
+
await client.lists.create("send", "allow", {
|
|
8343
|
+
entry: "entry"
|
|
8344
|
+
});
|
|
8345
|
+
|
|
8346
|
+
```
|
|
8347
|
+
</dd>
|
|
8348
|
+
</dl>
|
|
8349
|
+
</dd>
|
|
8350
|
+
</dl>
|
|
8351
|
+
|
|
8352
|
+
#### ⚙️ Parameters
|
|
8353
|
+
|
|
8354
|
+
<dl>
|
|
8355
|
+
<dd>
|
|
8356
|
+
|
|
8357
|
+
<dl>
|
|
8358
|
+
<dd>
|
|
8359
|
+
|
|
8360
|
+
**direction:** `AgentMail.Direction`
|
|
8361
|
+
|
|
8362
|
+
</dd>
|
|
8363
|
+
</dl>
|
|
8364
|
+
|
|
8365
|
+
<dl>
|
|
8366
|
+
<dd>
|
|
8367
|
+
|
|
8368
|
+
**type:** `AgentMail.ListType`
|
|
8369
|
+
|
|
8370
|
+
</dd>
|
|
8371
|
+
</dl>
|
|
8372
|
+
|
|
8373
|
+
<dl>
|
|
8374
|
+
<dd>
|
|
8375
|
+
|
|
8376
|
+
**request:** `AgentMail.CreateListEntryRequest`
|
|
8377
|
+
|
|
8378
|
+
</dd>
|
|
8379
|
+
</dl>
|
|
8380
|
+
|
|
8381
|
+
<dl>
|
|
8382
|
+
<dd>
|
|
8383
|
+
|
|
8384
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
8385
|
+
|
|
8386
|
+
</dd>
|
|
8387
|
+
</dl>
|
|
8388
|
+
</dd>
|
|
8389
|
+
</dl>
|
|
8390
|
+
|
|
8391
|
+
|
|
8392
|
+
</dd>
|
|
8393
|
+
</dl>
|
|
8394
|
+
</details>
|
|
8395
|
+
|
|
8396
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">delete</a>(direction, type, entry) -> void</code></summary>
|
|
8397
|
+
<dl>
|
|
8398
|
+
<dd>
|
|
8399
|
+
|
|
8400
|
+
#### 📝 Description
|
|
8401
|
+
|
|
8402
|
+
<dl>
|
|
8403
|
+
<dd>
|
|
8404
|
+
|
|
8405
|
+
<dl>
|
|
8406
|
+
<dd>
|
|
8407
|
+
|
|
8408
|
+
**CLI:**
|
|
8409
|
+
```bash
|
|
8410
|
+
agentmail lists delete --direction <direction> --type <type> --entry <entry>
|
|
8411
|
+
```
|
|
8412
|
+
</dd>
|
|
8413
|
+
</dl>
|
|
8414
|
+
</dd>
|
|
8415
|
+
</dl>
|
|
8416
|
+
|
|
8417
|
+
#### 🔌 Usage
|
|
8418
|
+
|
|
8419
|
+
<dl>
|
|
8420
|
+
<dd>
|
|
8421
|
+
|
|
8422
|
+
<dl>
|
|
8423
|
+
<dd>
|
|
8424
|
+
|
|
8425
|
+
```typescript
|
|
8426
|
+
await client.lists.delete("send", "allow", "entry");
|
|
8427
|
+
|
|
8428
|
+
```
|
|
8429
|
+
</dd>
|
|
8430
|
+
</dl>
|
|
8431
|
+
</dd>
|
|
8432
|
+
</dl>
|
|
8433
|
+
|
|
8434
|
+
#### ⚙️ Parameters
|
|
8435
|
+
|
|
8436
|
+
<dl>
|
|
8437
|
+
<dd>
|
|
8438
|
+
|
|
8439
|
+
<dl>
|
|
8440
|
+
<dd>
|
|
8441
|
+
|
|
8442
|
+
**direction:** `AgentMail.Direction`
|
|
8443
|
+
|
|
8444
|
+
</dd>
|
|
8445
|
+
</dl>
|
|
8446
|
+
|
|
8447
|
+
<dl>
|
|
8448
|
+
<dd>
|
|
8449
|
+
|
|
8450
|
+
**type:** `AgentMail.ListType`
|
|
8451
|
+
|
|
8452
|
+
</dd>
|
|
8453
|
+
</dl>
|
|
8454
|
+
|
|
8455
|
+
<dl>
|
|
8456
|
+
<dd>
|
|
8457
|
+
|
|
8458
|
+
**entry:** `string` — Email address or domain.
|
|
8459
|
+
|
|
8460
|
+
</dd>
|
|
8461
|
+
</dl>
|
|
8462
|
+
|
|
8463
|
+
<dl>
|
|
8464
|
+
<dd>
|
|
8465
|
+
|
|
8466
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
8467
|
+
|
|
8468
|
+
</dd>
|
|
8469
|
+
</dl>
|
|
8470
|
+
</dd>
|
|
8471
|
+
</dl>
|
|
8472
|
+
|
|
8473
|
+
|
|
8474
|
+
</dd>
|
|
8475
|
+
</dl>
|
|
8476
|
+
</details>
|
|
8477
|
+
|
|
8478
|
+
## Metrics
|
|
8479
|
+
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryEvents</a>({ ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
8480
|
+
<dl>
|
|
8481
|
+
<dd>
|
|
8482
|
+
|
|
8483
|
+
#### 📝 Description
|
|
8484
|
+
|
|
8485
|
+
<dl>
|
|
8486
|
+
<dd>
|
|
8487
|
+
|
|
8488
|
+
<dl>
|
|
8489
|
+
<dd>
|
|
8490
|
+
|
|
8491
|
+
Counts of email events (sent, delivered, bounced, etc.) over time for
|
|
8492
|
+
the organization. Defaults to the last 24 hours; `start` must be within
|
|
8493
|
+
the last 90 days, and a future `end` is clamped to now. Omit `period`
|
|
8494
|
+
for individual event counts, or set it to sum counts into buckets of
|
|
8495
|
+
that many seconds.
|
|
8496
|
+
|
|
8497
|
+
**CLI:**
|
|
8498
|
+
```bash
|
|
8499
|
+
agentmail metrics query-events
|
|
8500
|
+
```
|
|
8501
|
+
</dd>
|
|
8502
|
+
</dl>
|
|
8503
|
+
</dd>
|
|
8504
|
+
</dl>
|
|
8505
|
+
|
|
8506
|
+
#### 🔌 Usage
|
|
8507
|
+
|
|
8508
|
+
<dl>
|
|
8509
|
+
<dd>
|
|
8510
|
+
|
|
8511
|
+
<dl>
|
|
8512
|
+
<dd>
|
|
8513
|
+
|
|
8514
|
+
```typescript
|
|
8515
|
+
await client.metrics.queryEvents();
|
|
8516
|
+
|
|
8517
|
+
```
|
|
8518
|
+
</dd>
|
|
8519
|
+
</dl>
|
|
8520
|
+
</dd>
|
|
8521
|
+
</dl>
|
|
8522
|
+
|
|
8523
|
+
#### ⚙️ Parameters
|
|
8524
|
+
|
|
8525
|
+
<dl>
|
|
8526
|
+
<dd>
|
|
8527
|
+
|
|
8528
|
+
<dl>
|
|
8529
|
+
<dd>
|
|
8530
|
+
|
|
8531
|
+
**request:** `AgentMail.QueryEventsRequest`
|
|
8532
|
+
|
|
8533
|
+
</dd>
|
|
8534
|
+
</dl>
|
|
8535
|
+
|
|
8536
|
+
<dl>
|
|
8537
|
+
<dd>
|
|
8538
|
+
|
|
8539
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
8540
|
+
|
|
8541
|
+
</dd>
|
|
8542
|
+
</dl>
|
|
8543
|
+
</dd>
|
|
8544
|
+
</dl>
|
|
8545
|
+
|
|
8546
|
+
|
|
8547
|
+
</dd>
|
|
8548
|
+
</dl>
|
|
8549
|
+
</details>
|
|
8550
|
+
|
|
8551
|
+
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryUsage</a>({ ...params }) -> AgentMail.QueryUsageResponse</code></summary>
|
|
8552
|
+
<dl>
|
|
8553
|
+
<dd>
|
|
8554
|
+
|
|
8555
|
+
#### 📝 Description
|
|
8556
|
+
|
|
8557
|
+
<dl>
|
|
8558
|
+
<dd>
|
|
8559
|
+
|
|
8560
|
+
<dl>
|
|
8561
|
+
<dd>
|
|
8562
|
+
|
|
8563
|
+
Cumulative usage series for the organization. Each point is the running
|
|
8564
|
+
total of the usage type at that timestamp, not the change within the
|
|
8565
|
+
bucket. Defaults to the last 24 hours; `start` must be within the last
|
|
8566
|
+
90 days, and a future `end` is clamped to now. The range divided by
|
|
8567
|
+
`period` must not exceed 1000 buckets.
|
|
8568
|
+
</dd>
|
|
8569
|
+
</dl>
|
|
8570
|
+
</dd>
|
|
8571
|
+
</dl>
|
|
8572
|
+
|
|
8573
|
+
#### 🔌 Usage
|
|
8574
|
+
|
|
8575
|
+
<dl>
|
|
8576
|
+
<dd>
|
|
8577
|
+
|
|
8578
|
+
<dl>
|
|
8579
|
+
<dd>
|
|
8580
|
+
|
|
8581
|
+
```typescript
|
|
8582
|
+
await client.metrics.queryUsage();
|
|
8583
|
+
|
|
8584
|
+
```
|
|
8585
|
+
</dd>
|
|
8586
|
+
</dl>
|
|
8587
|
+
</dd>
|
|
8588
|
+
</dl>
|
|
8589
|
+
|
|
8590
|
+
#### ⚙️ Parameters
|
|
8591
|
+
|
|
8592
|
+
<dl>
|
|
8593
|
+
<dd>
|
|
8594
|
+
|
|
8595
|
+
<dl>
|
|
8596
|
+
<dd>
|
|
8597
|
+
|
|
8598
|
+
**request:** `AgentMail.QueryUsageRequest`
|
|
8599
|
+
|
|
8600
|
+
</dd>
|
|
8601
|
+
</dl>
|
|
8602
|
+
|
|
8603
|
+
<dl>
|
|
8604
|
+
<dd>
|
|
8605
|
+
|
|
8606
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
8607
|
+
|
|
8608
|
+
</dd>
|
|
8609
|
+
</dl>
|
|
8610
|
+
</dd>
|
|
8611
|
+
</dl>
|
|
8612
|
+
|
|
8613
|
+
|
|
8614
|
+
</dd>
|
|
8615
|
+
</dl>
|
|
8616
|
+
</details>
|
|
8617
|
+
|
|
8618
|
+
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryRates</a>({ ...params }) -> AgentMail.QueryRatesResponse</code></summary>
|
|
8619
|
+
<dl>
|
|
8620
|
+
<dd>
|
|
8621
|
+
|
|
8622
|
+
#### 📝 Description
|
|
8623
|
+
|
|
8624
|
+
<dl>
|
|
8625
|
+
<dd>
|
|
8626
|
+
|
|
8627
|
+
<dl>
|
|
8628
|
+
<dd>
|
|
8629
|
+
|
|
8630
|
+
Rolling bounce and complaint rates for the organization. At each
|
|
8631
|
+
`period` grid point, the bounced (or complained) messages over the
|
|
8632
|
+
preceding `window` divided by the messages sent over the same window,
|
|
8633
|
+
with the send count alongside so you can see the volume behind
|
|
8634
|
+
it. This is the number AgentMail's account moderation acts on: a
|
|
8635
|
+
warning at a 5% bounce rate and suspension at 10%, evaluated over a
|
|
8636
|
+
rolling 24 hours once at least 1,000 messages were sent in that
|
|
8637
|
+
window. Defaults to the rolling 24-hour rate sampled hourly over the
|
|
8638
|
+
last day; `start` must be within the last 90 days, `window` must be a
|
|
8639
|
+
whole multiple of `period`, and the range plus window divided by
|
|
8640
|
+
`period` must not exceed 1000 buckets.
|
|
8641
|
+
|
|
8642
|
+
**CLI:**
|
|
8643
|
+
```bash
|
|
8644
|
+
agentmail metrics query-rates
|
|
8645
|
+
```
|
|
8646
|
+
</dd>
|
|
8647
|
+
</dl>
|
|
8648
|
+
</dd>
|
|
8649
|
+
</dl>
|
|
8650
|
+
|
|
8651
|
+
#### 🔌 Usage
|
|
8652
|
+
|
|
8653
|
+
<dl>
|
|
8654
|
+
<dd>
|
|
8655
|
+
|
|
8656
|
+
<dl>
|
|
8657
|
+
<dd>
|
|
8658
|
+
|
|
8659
|
+
```typescript
|
|
8660
|
+
await client.metrics.queryRates();
|
|
8661
|
+
|
|
8662
|
+
```
|
|
8663
|
+
</dd>
|
|
8664
|
+
</dl>
|
|
8665
|
+
</dd>
|
|
8666
|
+
</dl>
|
|
8667
|
+
|
|
8668
|
+
#### ⚙️ Parameters
|
|
8669
|
+
|
|
8670
|
+
<dl>
|
|
8671
|
+
<dd>
|
|
8672
|
+
|
|
8673
|
+
<dl>
|
|
8674
|
+
<dd>
|
|
8675
|
+
|
|
8676
|
+
**request:** `AgentMail.QueryRatesRequest`
|
|
8677
|
+
|
|
8678
|
+
</dd>
|
|
8679
|
+
</dl>
|
|
8680
|
+
|
|
8681
|
+
<dl>
|
|
8682
|
+
<dd>
|
|
8683
|
+
|
|
8684
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
8685
|
+
|
|
8686
|
+
</dd>
|
|
8687
|
+
</dl>
|
|
8688
|
+
</dd>
|
|
8689
|
+
</dl>
|
|
8690
|
+
|
|
8691
|
+
|
|
8692
|
+
</dd>
|
|
8693
|
+
</dl>
|
|
8694
|
+
</details>
|
|
8695
|
+
|
|
8696
|
+
## Organizations
|
|
8697
|
+
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">get</a>() -> AgentMail.Organization</code></summary>
|
|
8698
|
+
<dl>
|
|
8699
|
+
<dd>
|
|
8700
|
+
|
|
8701
|
+
#### 📝 Description
|
|
8702
|
+
|
|
8703
|
+
<dl>
|
|
8704
|
+
<dd>
|
|
8705
|
+
|
|
8706
|
+
<dl>
|
|
8707
|
+
<dd>
|
|
8708
|
+
|
|
8709
|
+
Returns the organization for the authenticated API key (usage limits, counts, and billing metadata).
|
|
8710
|
+
|
|
8711
|
+
**CLI:**
|
|
8712
|
+
```bash
|
|
8713
|
+
agentmail organizations get
|
|
8714
|
+
```
|
|
8715
|
+
</dd>
|
|
8716
|
+
</dl>
|
|
8717
|
+
</dd>
|
|
8718
|
+
</dl>
|
|
8719
|
+
|
|
8720
|
+
#### 🔌 Usage
|
|
8721
|
+
|
|
8722
|
+
<dl>
|
|
8723
|
+
<dd>
|
|
8724
|
+
|
|
8725
|
+
<dl>
|
|
8726
|
+
<dd>
|
|
8727
|
+
|
|
8728
|
+
```typescript
|
|
8729
|
+
await client.organizations.get();
|
|
8730
|
+
|
|
8731
|
+
```
|
|
8732
|
+
</dd>
|
|
8733
|
+
</dl>
|
|
8734
|
+
</dd>
|
|
8735
|
+
</dl>
|
|
8736
|
+
|
|
8737
|
+
#### ⚙️ Parameters
|
|
8738
|
+
|
|
8739
|
+
<dl>
|
|
8740
|
+
<dd>
|
|
8741
|
+
|
|
8742
|
+
<dl>
|
|
8743
|
+
<dd>
|
|
8744
|
+
|
|
8745
|
+
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
8746
|
+
|
|
8747
|
+
</dd>
|
|
8748
|
+
</dl>
|
|
8749
|
+
</dd>
|
|
8750
|
+
</dl>
|
|
8751
|
+
|
|
8752
|
+
|
|
8753
|
+
</dd>
|
|
8754
|
+
</dl>
|
|
8755
|
+
</details>
|
|
8756
|
+
|
|
8757
|
+
## Pods Accounts
|
|
8758
|
+
<details><summary><code>client.pods.accounts.<a href="/src/api/resources/pods/resources/accounts/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListAccountsResponse</code></summary>
|
|
8759
|
+
<dl>
|
|
8760
|
+
<dd>
|
|
8761
|
+
|
|
8762
|
+
#### 📝 Description
|
|
8763
|
+
|
|
8764
|
+
<dl>
|
|
8765
|
+
<dd>
|
|
8766
|
+
|
|
8767
|
+
<dl>
|
|
8768
|
+
<dd>
|
|
8769
|
+
|
|
8770
|
+
Lists accounts held by inboxes in the pod, across all apps. Requires `inbox_read`.
|
|
8771
|
+
</dd>
|
|
8772
|
+
</dl>
|
|
8773
|
+
</dd>
|
|
8774
|
+
</dl>
|
|
8775
|
+
|
|
8776
|
+
#### 🔌 Usage
|
|
8777
|
+
|
|
8778
|
+
<dl>
|
|
8779
|
+
<dd>
|
|
8780
|
+
|
|
8781
|
+
<dl>
|
|
8782
|
+
<dd>
|
|
8783
|
+
|
|
8784
|
+
```typescript
|
|
8785
|
+
await client.pods.accounts.list("pod_id");
|
|
8786
|
+
|
|
8787
|
+
```
|
|
8788
|
+
</dd>
|
|
8789
|
+
</dl>
|
|
8790
|
+
</dd>
|
|
8791
|
+
</dl>
|
|
8792
|
+
|
|
8793
|
+
#### ⚙️ Parameters
|
|
8794
|
+
|
|
8795
|
+
<dl>
|
|
8796
|
+
<dd>
|
|
8797
|
+
|
|
8798
|
+
<dl>
|
|
8799
|
+
<dd>
|
|
8800
|
+
|
|
8801
|
+
**pod_id:** `AgentMail.PodId`
|
|
8802
|
+
|
|
8803
|
+
</dd>
|
|
8804
|
+
</dl>
|
|
8805
|
+
|
|
8806
|
+
<dl>
|
|
8807
|
+
<dd>
|
|
8808
|
+
|
|
8809
|
+
**request:** `AgentMail.pods.ListAccountsRequest`
|
|
8810
|
+
|
|
8811
|
+
</dd>
|
|
8812
|
+
</dl>
|
|
8813
|
+
|
|
8814
|
+
<dl>
|
|
8815
|
+
<dd>
|
|
8816
|
+
|
|
8817
|
+
**requestOptions:** `AccountsClient.RequestOptions`
|
|
8818
|
+
|
|
8819
|
+
</dd>
|
|
8820
|
+
</dl>
|
|
8821
|
+
</dd>
|
|
8822
|
+
</dl>
|
|
8823
|
+
|
|
8824
|
+
|
|
8825
|
+
</dd>
|
|
8826
|
+
</dl>
|
|
8827
|
+
</details>
|
|
8828
|
+
|
|
8829
|
+
<details><summary><code>client.pods.accounts.<a href="/src/api/resources/pods/resources/accounts/client/Client.ts">get</a>(pod_id, account_id) -> AgentMail.Account</code></summary>
|
|
8830
|
+
<dl>
|
|
8831
|
+
<dd>
|
|
8832
|
+
|
|
8833
|
+
#### 📝 Description
|
|
8834
|
+
|
|
8835
|
+
<dl>
|
|
8836
|
+
<dd>
|
|
8837
|
+
|
|
8838
|
+
<dl>
|
|
8839
|
+
<dd>
|
|
8840
|
+
|
|
8841
|
+
Returns one account held by inboxes in the pod. An account elsewhere is a 404. Requires
|
|
8842
|
+
`inbox_read`.
|
|
8843
|
+
</dd>
|
|
8844
|
+
</dl>
|
|
8845
|
+
</dd>
|
|
8846
|
+
</dl>
|
|
8847
|
+
|
|
8848
|
+
#### 🔌 Usage
|
|
8849
|
+
|
|
8850
|
+
<dl>
|
|
8851
|
+
<dd>
|
|
8852
|
+
|
|
8853
|
+
<dl>
|
|
8854
|
+
<dd>
|
|
8855
|
+
|
|
8856
|
+
```typescript
|
|
8857
|
+
await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
8858
|
+
|
|
8859
|
+
```
|
|
8860
|
+
</dd>
|
|
8861
|
+
</dl>
|
|
8862
|
+
</dd>
|
|
8863
|
+
</dl>
|
|
8864
|
+
|
|
8865
|
+
#### ⚙️ Parameters
|
|
8866
|
+
|
|
8867
|
+
<dl>
|
|
8868
|
+
<dd>
|
|
8869
|
+
|
|
8870
|
+
<dl>
|
|
8871
|
+
<dd>
|
|
8872
|
+
|
|
8873
|
+
**pod_id:** `AgentMail.PodId`
|
|
8874
|
+
|
|
8875
|
+
</dd>
|
|
8876
|
+
</dl>
|
|
8877
|
+
|
|
8878
|
+
<dl>
|
|
8879
|
+
<dd>
|
|
8880
|
+
|
|
8881
|
+
**account_id:** `AgentMail.AccountId`
|
|
8882
|
+
|
|
8883
|
+
</dd>
|
|
8884
|
+
</dl>
|
|
8885
|
+
|
|
8886
|
+
<dl>
|
|
8887
|
+
<dd>
|
|
8888
|
+
|
|
8889
|
+
**requestOptions:** `AccountsClient.RequestOptions`
|
|
8890
|
+
|
|
8891
|
+
</dd>
|
|
8892
|
+
</dl>
|
|
8893
|
+
</dd>
|
|
8894
|
+
</dl>
|
|
8895
|
+
|
|
8896
|
+
|
|
8897
|
+
</dd>
|
|
8898
|
+
</dl>
|
|
8899
|
+
</details>
|
|
8900
|
+
|
|
8901
|
+
## Pods ApiKeys
|
|
8902
|
+
<details><summary><code>client.pods.apiKeys.<a href="/src/api/resources/pods/resources/apiKeys/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListApiKeysResponse</code></summary>
|
|
8903
|
+
<dl>
|
|
8904
|
+
<dd>
|
|
8905
|
+
|
|
8906
|
+
#### 📝 Description
|
|
8907
|
+
|
|
8908
|
+
<dl>
|
|
8909
|
+
<dd>
|
|
8910
|
+
|
|
8911
|
+
<dl>
|
|
8912
|
+
<dd>
|
|
8913
|
+
|
|
8914
|
+
**CLI:**
|
|
8915
|
+
```bash
|
|
8916
|
+
agentmail pods api-keys list --pod-id <pod_id>
|
|
8917
|
+
```
|
|
8918
|
+
</dd>
|
|
8919
|
+
</dl>
|
|
8920
|
+
</dd>
|
|
8921
|
+
</dl>
|
|
8922
|
+
|
|
8923
|
+
#### 🔌 Usage
|
|
8924
|
+
|
|
8925
|
+
<dl>
|
|
8926
|
+
<dd>
|
|
8927
|
+
|
|
8928
|
+
<dl>
|
|
8929
|
+
<dd>
|
|
8930
|
+
|
|
8931
|
+
```typescript
|
|
8932
|
+
await client.pods.apiKeys.list("pod_id");
|
|
8933
|
+
|
|
8934
|
+
```
|
|
8935
|
+
</dd>
|
|
8936
|
+
</dl>
|
|
8937
|
+
</dd>
|
|
8938
|
+
</dl>
|
|
8939
|
+
|
|
8940
|
+
#### ⚙️ Parameters
|
|
8941
|
+
|
|
8942
|
+
<dl>
|
|
8943
|
+
<dd>
|
|
8944
|
+
|
|
8061
8945
|
<dl>
|
|
8062
8946
|
<dd>
|
|
8063
8947
|
|
|
8064
|
-
**
|
|
8948
|
+
**pod_id:** `AgentMail.PodId`
|
|
8065
8949
|
|
|
8066
8950
|
</dd>
|
|
8067
8951
|
</dl>
|
|
@@ -8069,7 +8953,7 @@ await client.lists.create("send", "allow", {
|
|
|
8069
8953
|
<dl>
|
|
8070
8954
|
<dd>
|
|
8071
8955
|
|
|
8072
|
-
**request:** `AgentMail.
|
|
8956
|
+
**request:** `AgentMail.pods.ListApiKeysRequest`
|
|
8073
8957
|
|
|
8074
8958
|
</dd>
|
|
8075
8959
|
</dl>
|
|
@@ -8077,7 +8961,7 @@ await client.lists.create("send", "allow", {
|
|
|
8077
8961
|
<dl>
|
|
8078
8962
|
<dd>
|
|
8079
8963
|
|
|
8080
|
-
**requestOptions:** `
|
|
8964
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
8081
8965
|
|
|
8082
8966
|
</dd>
|
|
8083
8967
|
</dl>
|
|
@@ -8089,7 +8973,7 @@ await client.lists.create("send", "allow", {
|
|
|
8089
8973
|
</dl>
|
|
8090
8974
|
</details>
|
|
8091
8975
|
|
|
8092
|
-
<details><summary><code>client.
|
|
8976
|
+
<details><summary><code>client.pods.apiKeys.<a href="/src/api/resources/pods/resources/apiKeys/client/Client.ts">create</a>(pod_id, { ...params }) -> AgentMail.CreateApiKeyResponse</code></summary>
|
|
8093
8977
|
<dl>
|
|
8094
8978
|
<dd>
|
|
8095
8979
|
|
|
@@ -8103,7 +8987,7 @@ await client.lists.create("send", "allow", {
|
|
|
8103
8987
|
|
|
8104
8988
|
**CLI:**
|
|
8105
8989
|
```bash
|
|
8106
|
-
agentmail
|
|
8990
|
+
agentmail pods api-keys create --pod-id <pod_id> --name "My Key"
|
|
8107
8991
|
```
|
|
8108
8992
|
</dd>
|
|
8109
8993
|
</dl>
|
|
@@ -8119,7 +9003,7 @@ agentmail lists delete --direction <direction> --type <type> --entry <entry>
|
|
|
8119
9003
|
<dd>
|
|
8120
9004
|
|
|
8121
9005
|
```typescript
|
|
8122
|
-
await client.
|
|
9006
|
+
await client.pods.apiKeys.create("pod_id", {});
|
|
8123
9007
|
|
|
8124
9008
|
```
|
|
8125
9009
|
</dd>
|
|
@@ -8135,15 +9019,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
8135
9019
|
<dl>
|
|
8136
9020
|
<dd>
|
|
8137
9021
|
|
|
8138
|
-
**
|
|
8139
|
-
|
|
8140
|
-
</dd>
|
|
8141
|
-
</dl>
|
|
8142
|
-
|
|
8143
|
-
<dl>
|
|
8144
|
-
<dd>
|
|
8145
|
-
|
|
8146
|
-
**type:** `AgentMail.ListType`
|
|
9022
|
+
**pod_id:** `AgentMail.PodId`
|
|
8147
9023
|
|
|
8148
9024
|
</dd>
|
|
8149
9025
|
</dl>
|
|
@@ -8151,7 +9027,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
8151
9027
|
<dl>
|
|
8152
9028
|
<dd>
|
|
8153
9029
|
|
|
8154
|
-
**
|
|
9030
|
+
**request:** `AgentMail.CreateApiKeyRequest`
|
|
8155
9031
|
|
|
8156
9032
|
</dd>
|
|
8157
9033
|
</dl>
|
|
@@ -8159,7 +9035,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
8159
9035
|
<dl>
|
|
8160
9036
|
<dd>
|
|
8161
9037
|
|
|
8162
|
-
**requestOptions:** `
|
|
9038
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
8163
9039
|
|
|
8164
9040
|
</dd>
|
|
8165
9041
|
</dl>
|
|
@@ -8171,8 +9047,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
8171
9047
|
</dl>
|
|
8172
9048
|
</details>
|
|
8173
9049
|
|
|
8174
|
-
|
|
8175
|
-
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryEvents</a>({ ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
9050
|
+
<details><summary><code>client.pods.apiKeys.<a href="/src/api/resources/pods/resources/apiKeys/client/Client.ts">update</a>(pod_id, api_key_id, { ...params }) -> AgentMail.ApiKey</code></summary>
|
|
8176
9051
|
<dl>
|
|
8177
9052
|
<dd>
|
|
8178
9053
|
|
|
@@ -8184,15 +9059,9 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
8184
9059
|
<dl>
|
|
8185
9060
|
<dd>
|
|
8186
9061
|
|
|
8187
|
-
Counts of email events (sent, delivered, bounced, etc.) over time for
|
|
8188
|
-
the organization. Defaults to the last 24 hours; `start` must be within
|
|
8189
|
-
the last 90 days, and a future `end` is clamped to now. Omit `period`
|
|
8190
|
-
for individual event counts, or set it to sum counts into buckets of
|
|
8191
|
-
that many seconds.
|
|
8192
|
-
|
|
8193
9062
|
**CLI:**
|
|
8194
9063
|
```bash
|
|
8195
|
-
agentmail
|
|
9064
|
+
agentmail pods api-keys update --pod-id <pod_id> --api-key-id <api_key_id> --name "Renamed"
|
|
8196
9065
|
```
|
|
8197
9066
|
</dd>
|
|
8198
9067
|
</dl>
|
|
@@ -8208,7 +9077,7 @@ agentmail metrics query-events
|
|
|
8208
9077
|
<dd>
|
|
8209
9078
|
|
|
8210
9079
|
```typescript
|
|
8211
|
-
await client.
|
|
9080
|
+
await client.pods.apiKeys.update("pod_id", "api_key_id", {});
|
|
8212
9081
|
|
|
8213
9082
|
```
|
|
8214
9083
|
</dd>
|
|
@@ -8224,7 +9093,7 @@ await client.metrics.queryEvents();
|
|
|
8224
9093
|
<dl>
|
|
8225
9094
|
<dd>
|
|
8226
9095
|
|
|
8227
|
-
**
|
|
9096
|
+
**pod_id:** `AgentMail.PodId`
|
|
8228
9097
|
|
|
8229
9098
|
</dd>
|
|
8230
9099
|
</dl>
|
|
@@ -8232,7 +9101,23 @@ await client.metrics.queryEvents();
|
|
|
8232
9101
|
<dl>
|
|
8233
9102
|
<dd>
|
|
8234
9103
|
|
|
8235
|
-
**
|
|
9104
|
+
**api_key_id:** `AgentMail.ApiKeyId`
|
|
9105
|
+
|
|
9106
|
+
</dd>
|
|
9107
|
+
</dl>
|
|
9108
|
+
|
|
9109
|
+
<dl>
|
|
9110
|
+
<dd>
|
|
9111
|
+
|
|
9112
|
+
**request:** `AgentMail.UpdateApiKeyRequest`
|
|
9113
|
+
|
|
9114
|
+
</dd>
|
|
9115
|
+
</dl>
|
|
9116
|
+
|
|
9117
|
+
<dl>
|
|
9118
|
+
<dd>
|
|
9119
|
+
|
|
9120
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
8236
9121
|
|
|
8237
9122
|
</dd>
|
|
8238
9123
|
</dl>
|
|
@@ -8244,7 +9129,7 @@ await client.metrics.queryEvents();
|
|
|
8244
9129
|
</dl>
|
|
8245
9130
|
</details>
|
|
8246
9131
|
|
|
8247
|
-
<details><summary><code>client.
|
|
9132
|
+
<details><summary><code>client.pods.apiKeys.<a href="/src/api/resources/pods/resources/apiKeys/client/Client.ts">delete</a>(pod_id, api_key_id) -> void</code></summary>
|
|
8248
9133
|
<dl>
|
|
8249
9134
|
<dd>
|
|
8250
9135
|
|
|
@@ -8256,11 +9141,10 @@ await client.metrics.queryEvents();
|
|
|
8256
9141
|
<dl>
|
|
8257
9142
|
<dd>
|
|
8258
9143
|
|
|
8259
|
-
|
|
8260
|
-
|
|
8261
|
-
|
|
8262
|
-
|
|
8263
|
-
`period` must not exceed 1000 buckets.
|
|
9144
|
+
**CLI:**
|
|
9145
|
+
```bash
|
|
9146
|
+
agentmail pods api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
|
|
9147
|
+
```
|
|
8264
9148
|
</dd>
|
|
8265
9149
|
</dl>
|
|
8266
9150
|
</dd>
|
|
@@ -8275,7 +9159,7 @@ bucket. Defaults to the last 24 hours; `start` must be within the last
|
|
|
8275
9159
|
<dd>
|
|
8276
9160
|
|
|
8277
9161
|
```typescript
|
|
8278
|
-
await client.
|
|
9162
|
+
await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
8279
9163
|
|
|
8280
9164
|
```
|
|
8281
9165
|
</dd>
|
|
@@ -8291,7 +9175,7 @@ await client.metrics.queryUsage();
|
|
|
8291
9175
|
<dl>
|
|
8292
9176
|
<dd>
|
|
8293
9177
|
|
|
8294
|
-
**
|
|
9178
|
+
**pod_id:** `AgentMail.PodId`
|
|
8295
9179
|
|
|
8296
9180
|
</dd>
|
|
8297
9181
|
</dl>
|
|
@@ -8299,7 +9183,15 @@ await client.metrics.queryUsage();
|
|
|
8299
9183
|
<dl>
|
|
8300
9184
|
<dd>
|
|
8301
9185
|
|
|
8302
|
-
**
|
|
9186
|
+
**api_key_id:** `AgentMail.ApiKeyId`
|
|
9187
|
+
|
|
9188
|
+
</dd>
|
|
9189
|
+
</dl>
|
|
9190
|
+
|
|
9191
|
+
<dl>
|
|
9192
|
+
<dd>
|
|
9193
|
+
|
|
9194
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
8303
9195
|
|
|
8304
9196
|
</dd>
|
|
8305
9197
|
</dl>
|
|
@@ -8311,7 +9203,8 @@ await client.metrics.queryUsage();
|
|
|
8311
9203
|
</dl>
|
|
8312
9204
|
</details>
|
|
8313
9205
|
|
|
8314
|
-
|
|
9206
|
+
## Pods Domains
|
|
9207
|
+
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListDomainsResponse</code></summary>
|
|
8315
9208
|
<dl>
|
|
8316
9209
|
<dd>
|
|
8317
9210
|
|
|
@@ -8323,21 +9216,9 @@ await client.metrics.queryUsage();
|
|
|
8323
9216
|
<dl>
|
|
8324
9217
|
<dd>
|
|
8325
9218
|
|
|
8326
|
-
Rolling bounce and complaint rates for the organization. At each
|
|
8327
|
-
`period` grid point, the bounced (or complained) messages over the
|
|
8328
|
-
preceding `window` divided by the messages sent over the same window,
|
|
8329
|
-
with the send count alongside so you can see the volume behind
|
|
8330
|
-
it. This is the number AgentMail's account moderation acts on: a
|
|
8331
|
-
warning at a 5% bounce rate and suspension at 10%, evaluated over a
|
|
8332
|
-
rolling 24 hours once at least 1,000 messages were sent in that
|
|
8333
|
-
window. Defaults to the rolling 24-hour rate sampled hourly over the
|
|
8334
|
-
last day; `start` must be within the last 90 days, `window` must be a
|
|
8335
|
-
whole multiple of `period`, and the range plus window divided by
|
|
8336
|
-
`period` must not exceed 1000 buckets.
|
|
8337
|
-
|
|
8338
9219
|
**CLI:**
|
|
8339
9220
|
```bash
|
|
8340
|
-
agentmail
|
|
9221
|
+
agentmail pods domains list --pod-id <pod_id>
|
|
8341
9222
|
```
|
|
8342
9223
|
</dd>
|
|
8343
9224
|
</dl>
|
|
@@ -8353,7 +9234,7 @@ agentmail metrics query-rates
|
|
|
8353
9234
|
<dd>
|
|
8354
9235
|
|
|
8355
9236
|
```typescript
|
|
8356
|
-
await client.
|
|
9237
|
+
await client.pods.domains.list("pod_id");
|
|
8357
9238
|
|
|
8358
9239
|
```
|
|
8359
9240
|
</dd>
|
|
@@ -8369,7 +9250,7 @@ await client.metrics.queryRates();
|
|
|
8369
9250
|
<dl>
|
|
8370
9251
|
<dd>
|
|
8371
9252
|
|
|
8372
|
-
**
|
|
9253
|
+
**pod_id:** `AgentMail.PodId`
|
|
8373
9254
|
|
|
8374
9255
|
</dd>
|
|
8375
9256
|
</dl>
|
|
@@ -8377,7 +9258,15 @@ await client.metrics.queryRates();
|
|
|
8377
9258
|
<dl>
|
|
8378
9259
|
<dd>
|
|
8379
9260
|
|
|
8380
|
-
**
|
|
9261
|
+
**request:** `AgentMail.pods.ListDomainsRequest`
|
|
9262
|
+
|
|
9263
|
+
</dd>
|
|
9264
|
+
</dl>
|
|
9265
|
+
|
|
9266
|
+
<dl>
|
|
9267
|
+
<dd>
|
|
9268
|
+
|
|
9269
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8381
9270
|
|
|
8382
9271
|
</dd>
|
|
8383
9272
|
</dl>
|
|
@@ -8389,8 +9278,7 @@ await client.metrics.queryRates();
|
|
|
8389
9278
|
</dl>
|
|
8390
9279
|
</details>
|
|
8391
9280
|
|
|
8392
|
-
|
|
8393
|
-
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">get</a>() -> AgentMail.Organization</code></summary>
|
|
9281
|
+
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">get</a>(pod_id, domain_id) -> AgentMail.Domain</code></summary>
|
|
8394
9282
|
<dl>
|
|
8395
9283
|
<dd>
|
|
8396
9284
|
|
|
@@ -8402,11 +9290,9 @@ await client.metrics.queryRates();
|
|
|
8402
9290
|
<dl>
|
|
8403
9291
|
<dd>
|
|
8404
9292
|
|
|
8405
|
-
Returns the organization for the authenticated API key (usage limits, counts, and billing metadata).
|
|
8406
|
-
|
|
8407
9293
|
**CLI:**
|
|
8408
9294
|
```bash
|
|
8409
|
-
agentmail
|
|
9295
|
+
agentmail pods domains get --pod-id <pod_id> --domain-id <domain_id>
|
|
8410
9296
|
```
|
|
8411
9297
|
</dd>
|
|
8412
9298
|
</dl>
|
|
@@ -8422,7 +9308,7 @@ agentmail organizations get
|
|
|
8422
9308
|
<dd>
|
|
8423
9309
|
|
|
8424
9310
|
```typescript
|
|
8425
|
-
await client.
|
|
9311
|
+
await client.pods.domains.get("pod_id", "domain_id");
|
|
8426
9312
|
|
|
8427
9313
|
```
|
|
8428
9314
|
</dd>
|
|
@@ -8438,7 +9324,23 @@ await client.organizations.get();
|
|
|
8438
9324
|
<dl>
|
|
8439
9325
|
<dd>
|
|
8440
9326
|
|
|
8441
|
-
**
|
|
9327
|
+
**pod_id:** `AgentMail.PodId`
|
|
9328
|
+
|
|
9329
|
+
</dd>
|
|
9330
|
+
</dl>
|
|
9331
|
+
|
|
9332
|
+
<dl>
|
|
9333
|
+
<dd>
|
|
9334
|
+
|
|
9335
|
+
**domain_id:** `AgentMail.DomainId`
|
|
9336
|
+
|
|
9337
|
+
</dd>
|
|
9338
|
+
</dl>
|
|
9339
|
+
|
|
9340
|
+
<dl>
|
|
9341
|
+
<dd>
|
|
9342
|
+
|
|
9343
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8442
9344
|
|
|
8443
9345
|
</dd>
|
|
8444
9346
|
</dl>
|
|
@@ -8450,8 +9352,7 @@ await client.organizations.get();
|
|
|
8450
9352
|
</dl>
|
|
8451
9353
|
</details>
|
|
8452
9354
|
|
|
8453
|
-
|
|
8454
|
-
<details><summary><code>client.pods.accounts.<a href="/src/api/resources/pods/resources/accounts/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListAccountsResponse</code></summary>
|
|
9355
|
+
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">getZoneFile</a>(pod_id, domain_id) -> core.BinaryResponse</code></summary>
|
|
8455
9356
|
<dl>
|
|
8456
9357
|
<dd>
|
|
8457
9358
|
|
|
@@ -8463,7 +9364,10 @@ await client.organizations.get();
|
|
|
8463
9364
|
<dl>
|
|
8464
9365
|
<dd>
|
|
8465
9366
|
|
|
8466
|
-
|
|
9367
|
+
**CLI:**
|
|
9368
|
+
```bash
|
|
9369
|
+
agentmail pods domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
|
|
9370
|
+
```
|
|
8467
9371
|
</dd>
|
|
8468
9372
|
</dl>
|
|
8469
9373
|
</dd>
|
|
@@ -8478,7 +9382,7 @@ Lists accounts held by inboxes in the pod, across all apps. Requires `inbox_read
|
|
|
8478
9382
|
<dd>
|
|
8479
9383
|
|
|
8480
9384
|
```typescript
|
|
8481
|
-
await client.pods.
|
|
9385
|
+
await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
8482
9386
|
|
|
8483
9387
|
```
|
|
8484
9388
|
</dd>
|
|
@@ -8502,7 +9406,7 @@ await client.pods.accounts.list("pod_id");
|
|
|
8502
9406
|
<dl>
|
|
8503
9407
|
<dd>
|
|
8504
9408
|
|
|
8505
|
-
**
|
|
9409
|
+
**domain_id:** `AgentMail.DomainId`
|
|
8506
9410
|
|
|
8507
9411
|
</dd>
|
|
8508
9412
|
</dl>
|
|
@@ -8510,7 +9414,7 @@ await client.pods.accounts.list("pod_id");
|
|
|
8510
9414
|
<dl>
|
|
8511
9415
|
<dd>
|
|
8512
9416
|
|
|
8513
|
-
**requestOptions:** `
|
|
9417
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8514
9418
|
|
|
8515
9419
|
</dd>
|
|
8516
9420
|
</dl>
|
|
@@ -8522,7 +9426,7 @@ await client.pods.accounts.list("pod_id");
|
|
|
8522
9426
|
</dl>
|
|
8523
9427
|
</details>
|
|
8524
9428
|
|
|
8525
|
-
<details><summary><code>client.pods.
|
|
9429
|
+
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">create</a>(pod_id, { ...params }) -> AgentMail.Domain</code></summary>
|
|
8526
9430
|
<dl>
|
|
8527
9431
|
<dd>
|
|
8528
9432
|
|
|
@@ -8534,8 +9438,10 @@ await client.pods.accounts.list("pod_id");
|
|
|
8534
9438
|
<dl>
|
|
8535
9439
|
<dd>
|
|
8536
9440
|
|
|
8537
|
-
|
|
8538
|
-
|
|
9441
|
+
**CLI:**
|
|
9442
|
+
```bash
|
|
9443
|
+
agentmail pods domains create --pod-id <pod_id> --domain example.com
|
|
9444
|
+
```
|
|
8539
9445
|
</dd>
|
|
8540
9446
|
</dl>
|
|
8541
9447
|
</dd>
|
|
@@ -8550,7 +9456,9 @@ Returns one account held by inboxes in the pod. An account elsewhere is a 404. R
|
|
|
8550
9456
|
<dd>
|
|
8551
9457
|
|
|
8552
9458
|
```typescript
|
|
8553
|
-
await client.pods.
|
|
9459
|
+
await client.pods.domains.create("pod_id", {
|
|
9460
|
+
domain: "domain"
|
|
9461
|
+
});
|
|
8554
9462
|
|
|
8555
9463
|
```
|
|
8556
9464
|
</dd>
|
|
@@ -8574,7 +9482,7 @@ await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
|
8574
9482
|
<dl>
|
|
8575
9483
|
<dd>
|
|
8576
9484
|
|
|
8577
|
-
**
|
|
9485
|
+
**request:** `AgentMail.CreateDomainRequest`
|
|
8578
9486
|
|
|
8579
9487
|
</dd>
|
|
8580
9488
|
</dl>
|
|
@@ -8582,7 +9490,7 @@ await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
|
8582
9490
|
<dl>
|
|
8583
9491
|
<dd>
|
|
8584
9492
|
|
|
8585
|
-
**requestOptions:** `
|
|
9493
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8586
9494
|
|
|
8587
9495
|
</dd>
|
|
8588
9496
|
</dl>
|
|
@@ -8594,8 +9502,7 @@ await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
|
8594
9502
|
</dl>
|
|
8595
9503
|
</details>
|
|
8596
9504
|
|
|
8597
|
-
|
|
8598
|
-
<details><summary><code>client.pods.apiKeys.<a href="/src/api/resources/pods/resources/apiKeys/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListApiKeysResponse</code></summary>
|
|
9505
|
+
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">update</a>(pod_id, domain_id, { ...params }) -> AgentMail.Domain</code></summary>
|
|
8599
9506
|
<dl>
|
|
8600
9507
|
<dd>
|
|
8601
9508
|
|
|
@@ -8609,7 +9516,7 @@ await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
|
8609
9516
|
|
|
8610
9517
|
**CLI:**
|
|
8611
9518
|
```bash
|
|
8612
|
-
agentmail pods
|
|
9519
|
+
agentmail pods domains update --pod-id <pod_id> --domain-id <domain_id>
|
|
8613
9520
|
```
|
|
8614
9521
|
</dd>
|
|
8615
9522
|
</dl>
|
|
@@ -8625,7 +9532,7 @@ agentmail pods api-keys list --pod-id <pod_id>
|
|
|
8625
9532
|
<dd>
|
|
8626
9533
|
|
|
8627
9534
|
```typescript
|
|
8628
|
-
await client.pods.
|
|
9535
|
+
await client.pods.domains.update("pod_id", "domain_id", {});
|
|
8629
9536
|
|
|
8630
9537
|
```
|
|
8631
9538
|
</dd>
|
|
@@ -8649,7 +9556,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
8649
9556
|
<dl>
|
|
8650
9557
|
<dd>
|
|
8651
9558
|
|
|
8652
|
-
**
|
|
9559
|
+
**domain_id:** `AgentMail.DomainId`
|
|
8653
9560
|
|
|
8654
9561
|
</dd>
|
|
8655
9562
|
</dl>
|
|
@@ -8657,7 +9564,15 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
8657
9564
|
<dl>
|
|
8658
9565
|
<dd>
|
|
8659
9566
|
|
|
8660
|
-
**
|
|
9567
|
+
**request:** `AgentMail.UpdateDomainRequest`
|
|
9568
|
+
|
|
9569
|
+
</dd>
|
|
9570
|
+
</dl>
|
|
9571
|
+
|
|
9572
|
+
<dl>
|
|
9573
|
+
<dd>
|
|
9574
|
+
|
|
9575
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8661
9576
|
|
|
8662
9577
|
</dd>
|
|
8663
9578
|
</dl>
|
|
@@ -8669,7 +9584,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
8669
9584
|
</dl>
|
|
8670
9585
|
</details>
|
|
8671
9586
|
|
|
8672
|
-
<details><summary><code>client.pods.
|
|
9587
|
+
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">delete</a>(pod_id, domain_id) -> void</code></summary>
|
|
8673
9588
|
<dl>
|
|
8674
9589
|
<dd>
|
|
8675
9590
|
|
|
@@ -8683,7 +9598,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
8683
9598
|
|
|
8684
9599
|
**CLI:**
|
|
8685
9600
|
```bash
|
|
8686
|
-
agentmail pods
|
|
9601
|
+
agentmail pods domains delete --pod-id <pod_id> --domain-id <domain_id>
|
|
8687
9602
|
```
|
|
8688
9603
|
</dd>
|
|
8689
9604
|
</dl>
|
|
@@ -8699,7 +9614,7 @@ agentmail pods api-keys create --pod-id <pod_id> --name "My Key"
|
|
|
8699
9614
|
<dd>
|
|
8700
9615
|
|
|
8701
9616
|
```typescript
|
|
8702
|
-
await client.pods.
|
|
9617
|
+
await client.pods.domains.delete("pod_id", "domain_id");
|
|
8703
9618
|
|
|
8704
9619
|
```
|
|
8705
9620
|
</dd>
|
|
@@ -8723,7 +9638,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
8723
9638
|
<dl>
|
|
8724
9639
|
<dd>
|
|
8725
9640
|
|
|
8726
|
-
**
|
|
9641
|
+
**domain_id:** `AgentMail.DomainId`
|
|
8727
9642
|
|
|
8728
9643
|
</dd>
|
|
8729
9644
|
</dl>
|
|
@@ -8731,7 +9646,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
8731
9646
|
<dl>
|
|
8732
9647
|
<dd>
|
|
8733
9648
|
|
|
8734
|
-
**requestOptions:** `
|
|
9649
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8735
9650
|
|
|
8736
9651
|
</dd>
|
|
8737
9652
|
</dl>
|
|
@@ -8743,7 +9658,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
8743
9658
|
</dl>
|
|
8744
9659
|
</details>
|
|
8745
9660
|
|
|
8746
|
-
<details><summary><code>client.pods.
|
|
9661
|
+
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">verify</a>(pod_id, domain_id) -> void</code></summary>
|
|
8747
9662
|
<dl>
|
|
8748
9663
|
<dd>
|
|
8749
9664
|
|
|
@@ -8757,7 +9672,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
8757
9672
|
|
|
8758
9673
|
**CLI:**
|
|
8759
9674
|
```bash
|
|
8760
|
-
agentmail pods
|
|
9675
|
+
agentmail pods domains verify --pod-id <pod_id> --domain-id <domain_id>
|
|
8761
9676
|
```
|
|
8762
9677
|
</dd>
|
|
8763
9678
|
</dl>
|
|
@@ -8773,7 +9688,7 @@ agentmail pods api-keys update --pod-id <pod_id> --api-key-id <api_key_id> --nam
|
|
|
8773
9688
|
<dd>
|
|
8774
9689
|
|
|
8775
9690
|
```typescript
|
|
8776
|
-
await client.pods.
|
|
9691
|
+
await client.pods.domains.verify("pod_id", "domain_id");
|
|
8777
9692
|
|
|
8778
9693
|
```
|
|
8779
9694
|
</dd>
|
|
@@ -8797,15 +9712,7 @@ await client.pods.apiKeys.update("pod_id", "api_key_id", {});
|
|
|
8797
9712
|
<dl>
|
|
8798
9713
|
<dd>
|
|
8799
9714
|
|
|
8800
|
-
**
|
|
8801
|
-
|
|
8802
|
-
</dd>
|
|
8803
|
-
</dl>
|
|
8804
|
-
|
|
8805
|
-
<dl>
|
|
8806
|
-
<dd>
|
|
8807
|
-
|
|
8808
|
-
**request:** `AgentMail.UpdateApiKeyRequest`
|
|
9715
|
+
**domain_id:** `AgentMail.DomainId`
|
|
8809
9716
|
|
|
8810
9717
|
</dd>
|
|
8811
9718
|
</dl>
|
|
@@ -8813,7 +9720,7 @@ await client.pods.apiKeys.update("pod_id", "api_key_id", {});
|
|
|
8813
9720
|
<dl>
|
|
8814
9721
|
<dd>
|
|
8815
9722
|
|
|
8816
|
-
**requestOptions:** `
|
|
9723
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8817
9724
|
|
|
8818
9725
|
</dd>
|
|
8819
9726
|
</dl>
|
|
@@ -8825,7 +9732,8 @@ await client.pods.apiKeys.update("pod_id", "api_key_id", {});
|
|
|
8825
9732
|
</dl>
|
|
8826
9733
|
</details>
|
|
8827
9734
|
|
|
8828
|
-
|
|
9735
|
+
## Pods Drafts
|
|
9736
|
+
<details><summary><code>client.pods.drafts.<a href="/src/api/resources/pods/resources/drafts/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListDraftsResponse</code></summary>
|
|
8829
9737
|
<dl>
|
|
8830
9738
|
<dd>
|
|
8831
9739
|
|
|
@@ -8839,7 +9747,7 @@ await client.pods.apiKeys.update("pod_id", "api_key_id", {});
|
|
|
8839
9747
|
|
|
8840
9748
|
**CLI:**
|
|
8841
9749
|
```bash
|
|
8842
|
-
agentmail pods
|
|
9750
|
+
agentmail pods drafts list --pod-id <pod_id>
|
|
8843
9751
|
```
|
|
8844
9752
|
</dd>
|
|
8845
9753
|
</dl>
|
|
@@ -8855,7 +9763,7 @@ agentmail pods api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
|
|
|
8855
9763
|
<dd>
|
|
8856
9764
|
|
|
8857
9765
|
```typescript
|
|
8858
|
-
await client.pods.
|
|
9766
|
+
await client.pods.drafts.list("pod_id");
|
|
8859
9767
|
|
|
8860
9768
|
```
|
|
8861
9769
|
</dd>
|
|
@@ -8879,7 +9787,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
8879
9787
|
<dl>
|
|
8880
9788
|
<dd>
|
|
8881
9789
|
|
|
8882
|
-
**
|
|
9790
|
+
**request:** `AgentMail.pods.ListDraftsRequest`
|
|
8883
9791
|
|
|
8884
9792
|
</dd>
|
|
8885
9793
|
</dl>
|
|
@@ -8887,7 +9795,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
8887
9795
|
<dl>
|
|
8888
9796
|
<dd>
|
|
8889
9797
|
|
|
8890
|
-
**requestOptions:** `
|
|
9798
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
8891
9799
|
|
|
8892
9800
|
</dd>
|
|
8893
9801
|
</dl>
|
|
@@ -8899,8 +9807,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
8899
9807
|
</dl>
|
|
8900
9808
|
</details>
|
|
8901
9809
|
|
|
8902
|
-
|
|
8903
|
-
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListDomainsResponse</code></summary>
|
|
9810
|
+
<details><summary><code>client.pods.drafts.<a href="/src/api/resources/pods/resources/drafts/client/Client.ts">get</a>(pod_id, draft_id) -> AgentMail.Draft</code></summary>
|
|
8904
9811
|
<dl>
|
|
8905
9812
|
<dd>
|
|
8906
9813
|
|
|
@@ -8914,7 +9821,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
8914
9821
|
|
|
8915
9822
|
**CLI:**
|
|
8916
9823
|
```bash
|
|
8917
|
-
agentmail pods
|
|
9824
|
+
agentmail pods drafts get --pod-id <pod_id> --draft-id <draft_id>
|
|
8918
9825
|
```
|
|
8919
9826
|
</dd>
|
|
8920
9827
|
</dl>
|
|
@@ -8930,7 +9837,7 @@ agentmail pods domains list --pod-id <pod_id>
|
|
|
8930
9837
|
<dd>
|
|
8931
9838
|
|
|
8932
9839
|
```typescript
|
|
8933
|
-
await client.pods.
|
|
9840
|
+
await client.pods.drafts.get("pod_id", "draft_id");
|
|
8934
9841
|
|
|
8935
9842
|
```
|
|
8936
9843
|
</dd>
|
|
@@ -8954,7 +9861,7 @@ await client.pods.domains.list("pod_id");
|
|
|
8954
9861
|
<dl>
|
|
8955
9862
|
<dd>
|
|
8956
9863
|
|
|
8957
|
-
**
|
|
9864
|
+
**draft_id:** `AgentMail.DraftId`
|
|
8958
9865
|
|
|
8959
9866
|
</dd>
|
|
8960
9867
|
</dl>
|
|
@@ -8962,7 +9869,7 @@ await client.pods.domains.list("pod_id");
|
|
|
8962
9869
|
<dl>
|
|
8963
9870
|
<dd>
|
|
8964
9871
|
|
|
8965
|
-
**requestOptions:** `
|
|
9872
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
8966
9873
|
|
|
8967
9874
|
</dd>
|
|
8968
9875
|
</dl>
|
|
@@ -8974,7 +9881,7 @@ await client.pods.domains.list("pod_id");
|
|
|
8974
9881
|
</dl>
|
|
8975
9882
|
</details>
|
|
8976
9883
|
|
|
8977
|
-
<details><summary><code>client.pods.
|
|
9884
|
+
<details><summary><code>client.pods.drafts.<a href="/src/api/resources/pods/resources/drafts/client/Client.ts">getAttachment</a>(pod_id, draft_id, attachment_id) -> AgentMail.AttachmentResponse</code></summary>
|
|
8978
9885
|
<dl>
|
|
8979
9886
|
<dd>
|
|
8980
9887
|
|
|
@@ -8988,7 +9895,7 @@ await client.pods.domains.list("pod_id");
|
|
|
8988
9895
|
|
|
8989
9896
|
**CLI:**
|
|
8990
9897
|
```bash
|
|
8991
|
-
agentmail pods
|
|
9898
|
+
agentmail pods drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --attachment-id <attachment_id>
|
|
8992
9899
|
```
|
|
8993
9900
|
</dd>
|
|
8994
9901
|
</dl>
|
|
@@ -9004,7 +9911,7 @@ agentmail pods domains get --pod-id <pod_id> --domain-id <domain_id>
|
|
|
9004
9911
|
<dd>
|
|
9005
9912
|
|
|
9006
9913
|
```typescript
|
|
9007
|
-
await client.pods.
|
|
9914
|
+
await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
9008
9915
|
|
|
9009
9916
|
```
|
|
9010
9917
|
</dd>
|
|
@@ -9020,7 +9927,15 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
9020
9927
|
<dl>
|
|
9021
9928
|
<dd>
|
|
9022
9929
|
|
|
9023
|
-
**pod_id:** `AgentMail.PodId`
|
|
9930
|
+
**pod_id:** `AgentMail.PodId`
|
|
9931
|
+
|
|
9932
|
+
</dd>
|
|
9933
|
+
</dl>
|
|
9934
|
+
|
|
9935
|
+
<dl>
|
|
9936
|
+
<dd>
|
|
9937
|
+
|
|
9938
|
+
**draft_id:** `AgentMail.DraftId`
|
|
9024
9939
|
|
|
9025
9940
|
</dd>
|
|
9026
9941
|
</dl>
|
|
@@ -9028,7 +9943,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
9028
9943
|
<dl>
|
|
9029
9944
|
<dd>
|
|
9030
9945
|
|
|
9031
|
-
**
|
|
9946
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
9032
9947
|
|
|
9033
9948
|
</dd>
|
|
9034
9949
|
</dl>
|
|
@@ -9036,7 +9951,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
9036
9951
|
<dl>
|
|
9037
9952
|
<dd>
|
|
9038
9953
|
|
|
9039
|
-
**requestOptions:** `
|
|
9954
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
9040
9955
|
|
|
9041
9956
|
</dd>
|
|
9042
9957
|
</dl>
|
|
@@ -9048,7 +9963,8 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
9048
9963
|
</dl>
|
|
9049
9964
|
</details>
|
|
9050
9965
|
|
|
9051
|
-
|
|
9966
|
+
## Pods Inboxes
|
|
9967
|
+
<details><summary><code>client.pods.inboxes.<a href="/src/api/resources/pods/resources/inboxes/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListInboxesResponse</code></summary>
|
|
9052
9968
|
<dl>
|
|
9053
9969
|
<dd>
|
|
9054
9970
|
|
|
@@ -9062,7 +9978,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
9062
9978
|
|
|
9063
9979
|
**CLI:**
|
|
9064
9980
|
```bash
|
|
9065
|
-
agentmail pods
|
|
9981
|
+
agentmail pods inboxes list --pod-id <pod_id>
|
|
9066
9982
|
```
|
|
9067
9983
|
</dd>
|
|
9068
9984
|
</dl>
|
|
@@ -9078,7 +9994,7 @@ agentmail pods domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
|
|
|
9078
9994
|
<dd>
|
|
9079
9995
|
|
|
9080
9996
|
```typescript
|
|
9081
|
-
await client.pods.
|
|
9997
|
+
await client.pods.inboxes.list("pod_id");
|
|
9082
9998
|
|
|
9083
9999
|
```
|
|
9084
10000
|
</dd>
|
|
@@ -9102,7 +10018,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
9102
10018
|
<dl>
|
|
9103
10019
|
<dd>
|
|
9104
10020
|
|
|
9105
|
-
**
|
|
10021
|
+
**request:** `AgentMail.pods.ListInboxesRequest`
|
|
9106
10022
|
|
|
9107
10023
|
</dd>
|
|
9108
10024
|
</dl>
|
|
@@ -9110,7 +10026,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
9110
10026
|
<dl>
|
|
9111
10027
|
<dd>
|
|
9112
10028
|
|
|
9113
|
-
**requestOptions:** `
|
|
10029
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9114
10030
|
|
|
9115
10031
|
</dd>
|
|
9116
10032
|
</dl>
|
|
@@ -9122,7 +10038,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
9122
10038
|
</dl>
|
|
9123
10039
|
</details>
|
|
9124
10040
|
|
|
9125
|
-
<details><summary><code>client.pods.
|
|
10041
|
+
<details><summary><code>client.pods.inboxes.<a href="/src/api/resources/pods/resources/inboxes/client/Client.ts">search</a>(pod_id, { ...params }) -> AgentMail.SearchInboxesResponse</code></summary>
|
|
9126
10042
|
<dl>
|
|
9127
10043
|
<dd>
|
|
9128
10044
|
|
|
@@ -9134,10 +10050,12 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
9134
10050
|
<dl>
|
|
9135
10051
|
<dd>
|
|
9136
10052
|
|
|
9137
|
-
|
|
9138
|
-
|
|
9139
|
-
|
|
9140
|
-
|
|
10053
|
+
Searches inboxes in the pod by address or display name, ranked by
|
|
10054
|
+
relevance. Each word in the query matches the start of a word in the
|
|
10055
|
+
address or display name, so `sup` matches `support@example.com` but
|
|
10056
|
+
`port` does not. An exact address match always ranks first. `limit`
|
|
10057
|
+
cannot exceed 100. A page can be empty and still carry a
|
|
10058
|
+
`next_page_token`; keep paging until the token is absent.
|
|
9141
10059
|
</dd>
|
|
9142
10060
|
</dl>
|
|
9143
10061
|
</dd>
|
|
@@ -9152,8 +10070,8 @@ agentmail pods domains create --pod-id <pod_id> --domain example.com
|
|
|
9152
10070
|
<dd>
|
|
9153
10071
|
|
|
9154
10072
|
```typescript
|
|
9155
|
-
await client.pods.
|
|
9156
|
-
|
|
10073
|
+
await client.pods.inboxes.search("pod_id", {
|
|
10074
|
+
q: "q"
|
|
9157
10075
|
});
|
|
9158
10076
|
|
|
9159
10077
|
```
|
|
@@ -9178,7 +10096,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
9178
10096
|
<dl>
|
|
9179
10097
|
<dd>
|
|
9180
10098
|
|
|
9181
|
-
**request:** `AgentMail.
|
|
10099
|
+
**request:** `AgentMail.pods.SearchInboxesRequest`
|
|
9182
10100
|
|
|
9183
10101
|
</dd>
|
|
9184
10102
|
</dl>
|
|
@@ -9186,7 +10104,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
9186
10104
|
<dl>
|
|
9187
10105
|
<dd>
|
|
9188
10106
|
|
|
9189
|
-
**requestOptions:** `
|
|
10107
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9190
10108
|
|
|
9191
10109
|
</dd>
|
|
9192
10110
|
</dl>
|
|
@@ -9198,7 +10116,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
9198
10116
|
</dl>
|
|
9199
10117
|
</details>
|
|
9200
10118
|
|
|
9201
|
-
<details><summary><code>client.pods.
|
|
10119
|
+
<details><summary><code>client.pods.inboxes.<a href="/src/api/resources/pods/resources/inboxes/client/Client.ts">get</a>(pod_id, inbox_id) -> AgentMail.Inbox</code></summary>
|
|
9202
10120
|
<dl>
|
|
9203
10121
|
<dd>
|
|
9204
10122
|
|
|
@@ -9212,7 +10130,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
9212
10130
|
|
|
9213
10131
|
**CLI:**
|
|
9214
10132
|
```bash
|
|
9215
|
-
agentmail pods
|
|
10133
|
+
agentmail pods inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
|
|
9216
10134
|
```
|
|
9217
10135
|
</dd>
|
|
9218
10136
|
</dl>
|
|
@@ -9228,7 +10146,7 @@ agentmail pods domains update --pod-id <pod_id> --domain-id <domain_id>
|
|
|
9228
10146
|
<dd>
|
|
9229
10147
|
|
|
9230
10148
|
```typescript
|
|
9231
|
-
await client.pods.
|
|
10149
|
+
await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
9232
10150
|
|
|
9233
10151
|
```
|
|
9234
10152
|
</dd>
|
|
@@ -9252,15 +10170,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
9252
10170
|
<dl>
|
|
9253
10171
|
<dd>
|
|
9254
10172
|
|
|
9255
|
-
**
|
|
9256
|
-
|
|
9257
|
-
</dd>
|
|
9258
|
-
</dl>
|
|
9259
|
-
|
|
9260
|
-
<dl>
|
|
9261
|
-
<dd>
|
|
9262
|
-
|
|
9263
|
-
**request:** `AgentMail.UpdateDomainRequest`
|
|
10173
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
9264
10174
|
|
|
9265
10175
|
</dd>
|
|
9266
10176
|
</dl>
|
|
@@ -9268,7 +10178,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
9268
10178
|
<dl>
|
|
9269
10179
|
<dd>
|
|
9270
10180
|
|
|
9271
|
-
**requestOptions:** `
|
|
10181
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9272
10182
|
|
|
9273
10183
|
</dd>
|
|
9274
10184
|
</dl>
|
|
@@ -9280,7 +10190,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
9280
10190
|
</dl>
|
|
9281
10191
|
</details>
|
|
9282
10192
|
|
|
9283
|
-
<details><summary><code>client.pods.
|
|
10193
|
+
<details><summary><code>client.pods.inboxes.<a href="/src/api/resources/pods/resources/inboxes/client/Client.ts">create</a>(pod_id, { ...params }) -> AgentMail.Inbox</code></summary>
|
|
9284
10194
|
<dl>
|
|
9285
10195
|
<dd>
|
|
9286
10196
|
|
|
@@ -9294,7 +10204,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
9294
10204
|
|
|
9295
10205
|
**CLI:**
|
|
9296
10206
|
```bash
|
|
9297
|
-
agentmail pods
|
|
10207
|
+
agentmail pods inboxes create --pod-id <pod_id> --username myagent --domain example.com
|
|
9298
10208
|
```
|
|
9299
10209
|
</dd>
|
|
9300
10210
|
</dl>
|
|
@@ -9310,7 +10220,7 @@ agentmail pods domains delete --pod-id <pod_id> --domain-id <domain_id>
|
|
|
9310
10220
|
<dd>
|
|
9311
10221
|
|
|
9312
10222
|
```typescript
|
|
9313
|
-
await client.pods.
|
|
10223
|
+
await client.pods.inboxes.create("pod_id", {});
|
|
9314
10224
|
|
|
9315
10225
|
```
|
|
9316
10226
|
</dd>
|
|
@@ -9334,7 +10244,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
9334
10244
|
<dl>
|
|
9335
10245
|
<dd>
|
|
9336
10246
|
|
|
9337
|
-
**
|
|
10247
|
+
**request:** `AgentMail.CreateInboxRequest`
|
|
9338
10248
|
|
|
9339
10249
|
</dd>
|
|
9340
10250
|
</dl>
|
|
@@ -9342,7 +10252,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
9342
10252
|
<dl>
|
|
9343
10253
|
<dd>
|
|
9344
10254
|
|
|
9345
|
-
**requestOptions:** `
|
|
10255
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9346
10256
|
|
|
9347
10257
|
</dd>
|
|
9348
10258
|
</dl>
|
|
@@ -9354,7 +10264,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
9354
10264
|
</dl>
|
|
9355
10265
|
</details>
|
|
9356
10266
|
|
|
9357
|
-
<details><summary><code>client.pods.
|
|
10267
|
+
<details><summary><code>client.pods.inboxes.<a href="/src/api/resources/pods/resources/inboxes/client/Client.ts">update</a>(pod_id, inbox_id, { ...params }) -> AgentMail.Inbox</code></summary>
|
|
9358
10268
|
<dl>
|
|
9359
10269
|
<dd>
|
|
9360
10270
|
|
|
@@ -9368,7 +10278,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
9368
10278
|
|
|
9369
10279
|
**CLI:**
|
|
9370
10280
|
```bash
|
|
9371
|
-
agentmail pods
|
|
10281
|
+
agentmail pods inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
|
|
9372
10282
|
```
|
|
9373
10283
|
</dd>
|
|
9374
10284
|
</dl>
|
|
@@ -9384,7 +10294,7 @@ agentmail pods domains verify --pod-id <pod_id> --domain-id <domain_id>
|
|
|
9384
10294
|
<dd>
|
|
9385
10295
|
|
|
9386
10296
|
```typescript
|
|
9387
|
-
await client.pods.
|
|
10297
|
+
await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
9388
10298
|
|
|
9389
10299
|
```
|
|
9390
10300
|
</dd>
|
|
@@ -9408,7 +10318,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
9408
10318
|
<dl>
|
|
9409
10319
|
<dd>
|
|
9410
10320
|
|
|
9411
|
-
**
|
|
10321
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
9412
10322
|
|
|
9413
10323
|
</dd>
|
|
9414
10324
|
</dl>
|
|
@@ -9416,7 +10326,15 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
9416
10326
|
<dl>
|
|
9417
10327
|
<dd>
|
|
9418
10328
|
|
|
9419
|
-
**
|
|
10329
|
+
**request:** `AgentMail.UpdateInboxRequest`
|
|
10330
|
+
|
|
10331
|
+
</dd>
|
|
10332
|
+
</dl>
|
|
10333
|
+
|
|
10334
|
+
<dl>
|
|
10335
|
+
<dd>
|
|
10336
|
+
|
|
10337
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9420
10338
|
|
|
9421
10339
|
</dd>
|
|
9422
10340
|
</dl>
|
|
@@ -9428,8 +10346,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
9428
10346
|
</dl>
|
|
9429
10347
|
</details>
|
|
9430
10348
|
|
|
9431
|
-
|
|
9432
|
-
<details><summary><code>client.pods.drafts.<a href="/src/api/resources/pods/resources/drafts/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListDraftsResponse</code></summary>
|
|
10349
|
+
<details><summary><code>client.pods.inboxes.<a href="/src/api/resources/pods/resources/inboxes/client/Client.ts">delete</a>(pod_id, inbox_id) -> void</code></summary>
|
|
9433
10350
|
<dl>
|
|
9434
10351
|
<dd>
|
|
9435
10352
|
|
|
@@ -9443,7 +10360,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
9443
10360
|
|
|
9444
10361
|
**CLI:**
|
|
9445
10362
|
```bash
|
|
9446
|
-
agentmail pods
|
|
10363
|
+
agentmail pods inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>
|
|
9447
10364
|
```
|
|
9448
10365
|
</dd>
|
|
9449
10366
|
</dl>
|
|
@@ -9459,7 +10376,7 @@ agentmail pods drafts list --pod-id <pod_id>
|
|
|
9459
10376
|
<dd>
|
|
9460
10377
|
|
|
9461
10378
|
```typescript
|
|
9462
|
-
await client.pods.
|
|
10379
|
+
await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
9463
10380
|
|
|
9464
10381
|
```
|
|
9465
10382
|
</dd>
|
|
@@ -9483,7 +10400,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
9483
10400
|
<dl>
|
|
9484
10401
|
<dd>
|
|
9485
10402
|
|
|
9486
|
-
**
|
|
10403
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
9487
10404
|
|
|
9488
10405
|
</dd>
|
|
9489
10406
|
</dl>
|
|
@@ -9491,7 +10408,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
9491
10408
|
<dl>
|
|
9492
10409
|
<dd>
|
|
9493
10410
|
|
|
9494
|
-
**requestOptions:** `
|
|
10411
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9495
10412
|
|
|
9496
10413
|
</dd>
|
|
9497
10414
|
</dl>
|
|
@@ -9503,7 +10420,8 @@ await client.pods.drafts.list("pod_id");
|
|
|
9503
10420
|
</dl>
|
|
9504
10421
|
</details>
|
|
9505
10422
|
|
|
9506
|
-
|
|
10423
|
+
## Pods Lists
|
|
10424
|
+
<details><summary><code>client.pods.lists.<a href="/src/api/resources/pods/resources/lists/client/Client.ts">list</a>(pod_id, direction, type, { ...params }) -> AgentMail.PodListListEntriesResponse</code></summary>
|
|
9507
10425
|
<dl>
|
|
9508
10426
|
<dd>
|
|
9509
10427
|
|
|
@@ -9517,7 +10435,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
9517
10435
|
|
|
9518
10436
|
**CLI:**
|
|
9519
10437
|
```bash
|
|
9520
|
-
agentmail pods
|
|
10438
|
+
agentmail pods lists list --pod-id <pod_id> --direction <direction> --type <type>
|
|
9521
10439
|
```
|
|
9522
10440
|
</dd>
|
|
9523
10441
|
</dl>
|
|
@@ -9533,7 +10451,7 @@ agentmail pods drafts get --pod-id <pod_id> --draft-id <draft_id>
|
|
|
9533
10451
|
<dd>
|
|
9534
10452
|
|
|
9535
10453
|
```typescript
|
|
9536
|
-
await client.pods.
|
|
10454
|
+
await client.pods.lists.list("pod_id", "send", "allow");
|
|
9537
10455
|
|
|
9538
10456
|
```
|
|
9539
10457
|
</dd>
|
|
@@ -9557,7 +10475,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
9557
10475
|
<dl>
|
|
9558
10476
|
<dd>
|
|
9559
10477
|
|
|
9560
|
-
**
|
|
10478
|
+
**direction:** `AgentMail.Direction`
|
|
9561
10479
|
|
|
9562
10480
|
</dd>
|
|
9563
10481
|
</dl>
|
|
@@ -9565,7 +10483,23 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
9565
10483
|
<dl>
|
|
9566
10484
|
<dd>
|
|
9567
10485
|
|
|
9568
|
-
**
|
|
10486
|
+
**type:** `AgentMail.ListType`
|
|
10487
|
+
|
|
10488
|
+
</dd>
|
|
10489
|
+
</dl>
|
|
10490
|
+
|
|
10491
|
+
<dl>
|
|
10492
|
+
<dd>
|
|
10493
|
+
|
|
10494
|
+
**request:** `AgentMail.pods.ListListEntriesRequest`
|
|
10495
|
+
|
|
10496
|
+
</dd>
|
|
10497
|
+
</dl>
|
|
10498
|
+
|
|
10499
|
+
<dl>
|
|
10500
|
+
<dd>
|
|
10501
|
+
|
|
10502
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
9569
10503
|
|
|
9570
10504
|
</dd>
|
|
9571
10505
|
</dl>
|
|
@@ -9577,7 +10511,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
9577
10511
|
</dl>
|
|
9578
10512
|
</details>
|
|
9579
10513
|
|
|
9580
|
-
<details><summary><code>client.pods.
|
|
10514
|
+
<details><summary><code>client.pods.lists.<a href="/src/api/resources/pods/resources/lists/client/Client.ts">get</a>(pod_id, direction, type, entry) -> AgentMail.PodListEntry</code></summary>
|
|
9581
10515
|
<dl>
|
|
9582
10516
|
<dd>
|
|
9583
10517
|
|
|
@@ -9591,7 +10525,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
9591
10525
|
|
|
9592
10526
|
**CLI:**
|
|
9593
10527
|
```bash
|
|
9594
|
-
agentmail pods
|
|
10528
|
+
agentmail pods lists get --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
9595
10529
|
```
|
|
9596
10530
|
</dd>
|
|
9597
10531
|
</dl>
|
|
@@ -9607,7 +10541,7 @@ agentmail pods drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --a
|
|
|
9607
10541
|
<dd>
|
|
9608
10542
|
|
|
9609
10543
|
```typescript
|
|
9610
|
-
await client.pods.
|
|
10544
|
+
await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
9611
10545
|
|
|
9612
10546
|
```
|
|
9613
10547
|
</dd>
|
|
@@ -9631,7 +10565,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
9631
10565
|
<dl>
|
|
9632
10566
|
<dd>
|
|
9633
10567
|
|
|
9634
|
-
**
|
|
10568
|
+
**direction:** `AgentMail.Direction`
|
|
9635
10569
|
|
|
9636
10570
|
</dd>
|
|
9637
10571
|
</dl>
|
|
@@ -9639,7 +10573,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
9639
10573
|
<dl>
|
|
9640
10574
|
<dd>
|
|
9641
10575
|
|
|
9642
|
-
**
|
|
10576
|
+
**type:** `AgentMail.ListType`
|
|
9643
10577
|
|
|
9644
10578
|
</dd>
|
|
9645
10579
|
</dl>
|
|
@@ -9647,7 +10581,15 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
9647
10581
|
<dl>
|
|
9648
10582
|
<dd>
|
|
9649
10583
|
|
|
9650
|
-
**
|
|
10584
|
+
**entry:** `string` — Email address or domain.
|
|
10585
|
+
|
|
10586
|
+
</dd>
|
|
10587
|
+
</dl>
|
|
10588
|
+
|
|
10589
|
+
<dl>
|
|
10590
|
+
<dd>
|
|
10591
|
+
|
|
10592
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
9651
10593
|
|
|
9652
10594
|
</dd>
|
|
9653
10595
|
</dl>
|
|
@@ -9659,8 +10601,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
9659
10601
|
</dl>
|
|
9660
10602
|
</details>
|
|
9661
10603
|
|
|
9662
|
-
|
|
9663
|
-
<details><summary><code>client.pods.inboxes.<a href="/src/api/resources/pods/resources/inboxes/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListInboxesResponse</code></summary>
|
|
10604
|
+
<details><summary><code>client.pods.lists.<a href="/src/api/resources/pods/resources/lists/client/Client.ts">create</a>(pod_id, direction, type, { ...params }) -> AgentMail.PodListEntry</code></summary>
|
|
9664
10605
|
<dl>
|
|
9665
10606
|
<dd>
|
|
9666
10607
|
|
|
@@ -9674,7 +10615,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
9674
10615
|
|
|
9675
10616
|
**CLI:**
|
|
9676
10617
|
```bash
|
|
9677
|
-
agentmail pods
|
|
10618
|
+
agentmail pods lists create --pod-id <pod_id> --direction <direction> --type <type> --entry user@example.com
|
|
9678
10619
|
```
|
|
9679
10620
|
</dd>
|
|
9680
10621
|
</dl>
|
|
@@ -9690,7 +10631,9 @@ agentmail pods inboxes list --pod-id <pod_id>
|
|
|
9690
10631
|
<dd>
|
|
9691
10632
|
|
|
9692
10633
|
```typescript
|
|
9693
|
-
await client.pods.
|
|
10634
|
+
await client.pods.lists.create("pod_id", "send", "allow", {
|
|
10635
|
+
entry: "entry"
|
|
10636
|
+
});
|
|
9694
10637
|
|
|
9695
10638
|
```
|
|
9696
10639
|
</dd>
|
|
@@ -9714,7 +10657,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
9714
10657
|
<dl>
|
|
9715
10658
|
<dd>
|
|
9716
10659
|
|
|
9717
|
-
**
|
|
10660
|
+
**direction:** `AgentMail.Direction`
|
|
9718
10661
|
|
|
9719
10662
|
</dd>
|
|
9720
10663
|
</dl>
|
|
@@ -9722,7 +10665,23 @@ await client.pods.inboxes.list("pod_id");
|
|
|
9722
10665
|
<dl>
|
|
9723
10666
|
<dd>
|
|
9724
10667
|
|
|
9725
|
-
**
|
|
10668
|
+
**type:** `AgentMail.ListType`
|
|
10669
|
+
|
|
10670
|
+
</dd>
|
|
10671
|
+
</dl>
|
|
10672
|
+
|
|
10673
|
+
<dl>
|
|
10674
|
+
<dd>
|
|
10675
|
+
|
|
10676
|
+
**request:** `AgentMail.CreateListEntryRequest`
|
|
10677
|
+
|
|
10678
|
+
</dd>
|
|
10679
|
+
</dl>
|
|
10680
|
+
|
|
10681
|
+
<dl>
|
|
10682
|
+
<dd>
|
|
10683
|
+
|
|
10684
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
9726
10685
|
|
|
9727
10686
|
</dd>
|
|
9728
10687
|
</dl>
|
|
@@ -9734,7 +10693,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
9734
10693
|
</dl>
|
|
9735
10694
|
</details>
|
|
9736
10695
|
|
|
9737
|
-
<details><summary><code>client.pods.
|
|
10696
|
+
<details><summary><code>client.pods.lists.<a href="/src/api/resources/pods/resources/lists/client/Client.ts">delete</a>(pod_id, direction, type, entry) -> void</code></summary>
|
|
9738
10697
|
<dl>
|
|
9739
10698
|
<dd>
|
|
9740
10699
|
|
|
@@ -9746,12 +10705,10 @@ await client.pods.inboxes.list("pod_id");
|
|
|
9746
10705
|
<dl>
|
|
9747
10706
|
<dd>
|
|
9748
10707
|
|
|
9749
|
-
|
|
9750
|
-
|
|
9751
|
-
|
|
9752
|
-
|
|
9753
|
-
cannot exceed 100. A page can be empty and still carry a
|
|
9754
|
-
`next_page_token`; keep paging until the token is absent.
|
|
10708
|
+
**CLI:**
|
|
10709
|
+
```bash
|
|
10710
|
+
agentmail pods lists delete --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
10711
|
+
```
|
|
9755
10712
|
</dd>
|
|
9756
10713
|
</dl>
|
|
9757
10714
|
</dd>
|
|
@@ -9766,9 +10723,7 @@ cannot exceed 100. A page can be empty and still carry a
|
|
|
9766
10723
|
<dd>
|
|
9767
10724
|
|
|
9768
10725
|
```typescript
|
|
9769
|
-
await client.pods.
|
|
9770
|
-
q: "q"
|
|
9771
|
-
});
|
|
10726
|
+
await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
9772
10727
|
|
|
9773
10728
|
```
|
|
9774
10729
|
</dd>
|
|
@@ -9792,7 +10747,7 @@ await client.pods.inboxes.search("pod_id", {
|
|
|
9792
10747
|
<dl>
|
|
9793
10748
|
<dd>
|
|
9794
10749
|
|
|
9795
|
-
**
|
|
10750
|
+
**direction:** `AgentMail.Direction`
|
|
9796
10751
|
|
|
9797
10752
|
</dd>
|
|
9798
10753
|
</dl>
|
|
@@ -9800,7 +10755,23 @@ await client.pods.inboxes.search("pod_id", {
|
|
|
9800
10755
|
<dl>
|
|
9801
10756
|
<dd>
|
|
9802
10757
|
|
|
9803
|
-
**
|
|
10758
|
+
**type:** `AgentMail.ListType`
|
|
10759
|
+
|
|
10760
|
+
</dd>
|
|
10761
|
+
</dl>
|
|
10762
|
+
|
|
10763
|
+
<dl>
|
|
10764
|
+
<dd>
|
|
10765
|
+
|
|
10766
|
+
**entry:** `string` — Email address or domain.
|
|
10767
|
+
|
|
10768
|
+
</dd>
|
|
10769
|
+
</dl>
|
|
10770
|
+
|
|
10771
|
+
<dl>
|
|
10772
|
+
<dd>
|
|
10773
|
+
|
|
10774
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
9804
10775
|
|
|
9805
10776
|
</dd>
|
|
9806
10777
|
</dl>
|
|
@@ -9812,7 +10783,8 @@ await client.pods.inboxes.search("pod_id", {
|
|
|
9812
10783
|
</dl>
|
|
9813
10784
|
</details>
|
|
9814
10785
|
|
|
9815
|
-
|
|
10786
|
+
## Pods Metrics
|
|
10787
|
+
<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>
|
|
9816
10788
|
<dl>
|
|
9817
10789
|
<dd>
|
|
9818
10790
|
|
|
@@ -9824,9 +10796,15 @@ await client.pods.inboxes.search("pod_id", {
|
|
|
9824
10796
|
<dl>
|
|
9825
10797
|
<dd>
|
|
9826
10798
|
|
|
10799
|
+
Counts of email events (sent, delivered, bounced, etc.) over time for
|
|
10800
|
+
the pod. Defaults to the last 24 hours; `start` must be within the last
|
|
10801
|
+
90 days, and a future `end` is clamped to now. Omit `period` for
|
|
10802
|
+
individual event counts, or set it to sum counts into buckets of that
|
|
10803
|
+
many seconds.
|
|
10804
|
+
|
|
9827
10805
|
**CLI:**
|
|
9828
10806
|
```bash
|
|
9829
|
-
agentmail pods
|
|
10807
|
+
agentmail pods metrics query-events --pod-id <pod_id>
|
|
9830
10808
|
```
|
|
9831
10809
|
</dd>
|
|
9832
10810
|
</dl>
|
|
@@ -9842,7 +10820,7 @@ agentmail pods inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
9842
10820
|
<dd>
|
|
9843
10821
|
|
|
9844
10822
|
```typescript
|
|
9845
|
-
await client.pods.
|
|
10823
|
+
await client.pods.metrics.queryEvents("pod_id");
|
|
9846
10824
|
|
|
9847
10825
|
```
|
|
9848
10826
|
</dd>
|
|
@@ -9866,7 +10844,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
9866
10844
|
<dl>
|
|
9867
10845
|
<dd>
|
|
9868
10846
|
|
|
9869
|
-
**
|
|
10847
|
+
**request:** `AgentMail.pods.QueryEventsRequest`
|
|
9870
10848
|
|
|
9871
10849
|
</dd>
|
|
9872
10850
|
</dl>
|
|
@@ -9874,7 +10852,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
9874
10852
|
<dl>
|
|
9875
10853
|
<dd>
|
|
9876
10854
|
|
|
9877
|
-
**requestOptions:** `
|
|
10855
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
9878
10856
|
|
|
9879
10857
|
</dd>
|
|
9880
10858
|
</dl>
|
|
@@ -9886,7 +10864,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
9886
10864
|
</dl>
|
|
9887
10865
|
</details>
|
|
9888
10866
|
|
|
9889
|
-
<details><summary><code>client.pods.
|
|
10867
|
+
<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>
|
|
9890
10868
|
<dl>
|
|
9891
10869
|
<dd>
|
|
9892
10870
|
|
|
@@ -9898,10 +10876,13 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
9898
10876
|
<dl>
|
|
9899
10877
|
<dd>
|
|
9900
10878
|
|
|
9901
|
-
|
|
9902
|
-
|
|
9903
|
-
|
|
9904
|
-
|
|
10879
|
+
Cumulative usage series for the pod. Each point is the running total of
|
|
10880
|
+
the usage type at that timestamp, not the change within the bucket.
|
|
10881
|
+
Pod-scoped queries carry every usage type except `pod_count`; requested
|
|
10882
|
+
types that don't apply to the scope are ignored. Defaults to the last
|
|
10883
|
+
24 hours; `start` must be within the last 90 days, and a future `end`
|
|
10884
|
+
is clamped to now. The range divided by `period` must not exceed 1000
|
|
10885
|
+
buckets.
|
|
9905
10886
|
</dd>
|
|
9906
10887
|
</dl>
|
|
9907
10888
|
</dd>
|
|
@@ -9916,7 +10897,7 @@ agentmail pods inboxes create --pod-id <pod_id> --username myagent --domain exam
|
|
|
9916
10897
|
<dd>
|
|
9917
10898
|
|
|
9918
10899
|
```typescript
|
|
9919
|
-
await client.pods.
|
|
10900
|
+
await client.pods.metrics.queryUsage("pod_id");
|
|
9920
10901
|
|
|
9921
10902
|
```
|
|
9922
10903
|
</dd>
|
|
@@ -9940,7 +10921,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
9940
10921
|
<dl>
|
|
9941
10922
|
<dd>
|
|
9942
10923
|
|
|
9943
|
-
**request:** `AgentMail.
|
|
10924
|
+
**request:** `AgentMail.pods.QueryUsageRequest`
|
|
9944
10925
|
|
|
9945
10926
|
</dd>
|
|
9946
10927
|
</dl>
|
|
@@ -9948,7 +10929,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
9948
10929
|
<dl>
|
|
9949
10930
|
<dd>
|
|
9950
10931
|
|
|
9951
|
-
**requestOptions:** `
|
|
10932
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
9952
10933
|
|
|
9953
10934
|
</dd>
|
|
9954
10935
|
</dl>
|
|
@@ -9960,7 +10941,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
9960
10941
|
</dl>
|
|
9961
10942
|
</details>
|
|
9962
10943
|
|
|
9963
|
-
<details><summary><code>client.pods.
|
|
10944
|
+
<details><summary><code>client.pods.metrics.<a href="/src/api/resources/pods/resources/metrics/client/Client.ts">queryRates</a>(pod_id, { ...params }) -> AgentMail.QueryRatesResponse</code></summary>
|
|
9964
10945
|
<dl>
|
|
9965
10946
|
<dd>
|
|
9966
10947
|
|
|
@@ -9972,9 +10953,20 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
9972
10953
|
<dl>
|
|
9973
10954
|
<dd>
|
|
9974
10955
|
|
|
10956
|
+
Rolling bounce and complaint rates for the pod. At each `period` grid
|
|
10957
|
+
point, the bounced (or complained) messages over the preceding
|
|
10958
|
+
`window` divided by the messages sent over the same window, with the
|
|
10959
|
+
send count alongside. Account moderation evaluates the organization-wide
|
|
10960
|
+
rate, so use the organization endpoint to see the number it acts on;
|
|
10961
|
+
the pod view shows which pods contribute. Defaults to the rolling
|
|
10962
|
+
24-hour rate sampled hourly over the last day; `start` must be within
|
|
10963
|
+
the last 90 days, `window` must be a whole multiple of `period`, and
|
|
10964
|
+
the range plus window divided by `period` must not exceed 1000
|
|
10965
|
+
buckets.
|
|
10966
|
+
|
|
9975
10967
|
**CLI:**
|
|
9976
10968
|
```bash
|
|
9977
|
-
agentmail pods
|
|
10969
|
+
agentmail pods metrics query-rates --pod-id <pod_id>
|
|
9978
10970
|
```
|
|
9979
10971
|
</dd>
|
|
9980
10972
|
</dl>
|
|
@@ -9990,7 +10982,7 @@ agentmail pods inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
9990
10982
|
<dd>
|
|
9991
10983
|
|
|
9992
10984
|
```typescript
|
|
9993
|
-
await client.pods.
|
|
10985
|
+
await client.pods.metrics.queryRates("pod_id");
|
|
9994
10986
|
|
|
9995
10987
|
```
|
|
9996
10988
|
</dd>
|
|
@@ -10014,15 +11006,7 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
10014
11006
|
<dl>
|
|
10015
11007
|
<dd>
|
|
10016
11008
|
|
|
10017
|
-
**
|
|
10018
|
-
|
|
10019
|
-
</dd>
|
|
10020
|
-
</dl>
|
|
10021
|
-
|
|
10022
|
-
<dl>
|
|
10023
|
-
<dd>
|
|
10024
|
-
|
|
10025
|
-
**request:** `AgentMail.UpdateInboxRequest`
|
|
11009
|
+
**request:** `AgentMail.pods.QueryRatesRequest`
|
|
10026
11010
|
|
|
10027
11011
|
</dd>
|
|
10028
11012
|
</dl>
|
|
@@ -10030,7 +11014,7 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
10030
11014
|
<dl>
|
|
10031
11015
|
<dd>
|
|
10032
11016
|
|
|
10033
|
-
**requestOptions:** `
|
|
11017
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
10034
11018
|
|
|
10035
11019
|
</dd>
|
|
10036
11020
|
</dl>
|
|
@@ -10042,7 +11026,8 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
10042
11026
|
</dl>
|
|
10043
11027
|
</details>
|
|
10044
11028
|
|
|
10045
|
-
|
|
11029
|
+
## Pods Threads
|
|
11030
|
+
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
10046
11031
|
<dl>
|
|
10047
11032
|
<dd>
|
|
10048
11033
|
|
|
@@ -10054,9 +11039,14 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
10054
11039
|
<dl>
|
|
10055
11040
|
<dd>
|
|
10056
11041
|
|
|
11042
|
+
Lists threads in the pod, most recent first. Pass `senders`,
|
|
11043
|
+
`recipients`, or `subject` to filter by substring. Filtered requests are
|
|
11044
|
+
served by search, which caps `limit` at 100. For relevance-ranked
|
|
11045
|
+
full-text search, use `Search Threads`.
|
|
11046
|
+
|
|
10057
11047
|
**CLI:**
|
|
10058
11048
|
```bash
|
|
10059
|
-
agentmail pods
|
|
11049
|
+
agentmail pods threads list --pod-id <pod_id>
|
|
10060
11050
|
```
|
|
10061
11051
|
</dd>
|
|
10062
11052
|
</dl>
|
|
@@ -10072,7 +11062,7 @@ agentmail pods inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
10072
11062
|
<dd>
|
|
10073
11063
|
|
|
10074
11064
|
```typescript
|
|
10075
|
-
await client.pods.
|
|
11065
|
+
await client.pods.threads.list("pod_id");
|
|
10076
11066
|
|
|
10077
11067
|
```
|
|
10078
11068
|
</dd>
|
|
@@ -10096,7 +11086,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
10096
11086
|
<dl>
|
|
10097
11087
|
<dd>
|
|
10098
11088
|
|
|
10099
|
-
**
|
|
11089
|
+
**request:** `AgentMail.pods.ListThreadsRequest`
|
|
10100
11090
|
|
|
10101
11091
|
</dd>
|
|
10102
11092
|
</dl>
|
|
@@ -10104,7 +11094,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
10104
11094
|
<dl>
|
|
10105
11095
|
<dd>
|
|
10106
11096
|
|
|
10107
|
-
**requestOptions:** `
|
|
11097
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10108
11098
|
|
|
10109
11099
|
</dd>
|
|
10110
11100
|
</dl>
|
|
@@ -10116,8 +11106,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
10116
11106
|
</dl>
|
|
10117
11107
|
</details>
|
|
10118
11108
|
|
|
10119
|
-
|
|
10120
|
-
<details><summary><code>client.pods.lists.<a href="/src/api/resources/pods/resources/lists/client/Client.ts">list</a>(pod_id, direction, type, { ...params }) -> AgentMail.PodListListEntriesResponse</code></summary>
|
|
11109
|
+
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">search</a>(pod_id, { ...params }) -> AgentMail.SearchThreadsResponse</code></summary>
|
|
10121
11110
|
<dl>
|
|
10122
11111
|
<dd>
|
|
10123
11112
|
|
|
@@ -10129,10 +11118,10 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
10129
11118
|
<dl>
|
|
10130
11119
|
<dd>
|
|
10131
11120
|
|
|
10132
|
-
|
|
10133
|
-
|
|
10134
|
-
|
|
10135
|
-
|
|
11121
|
+
Full-text search across threads in the pod, ranked by relevance. The
|
|
11122
|
+
query is matched against senders, recipients, and subject (substring)
|
|
11123
|
+
and the message body (tokenized full text). Spam, trash, blocked, and
|
|
11124
|
+
unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
10136
11125
|
</dd>
|
|
10137
11126
|
</dl>
|
|
10138
11127
|
</dd>
|
|
@@ -10147,7 +11136,9 @@ agentmail pods lists list --pod-id <pod_id> --direction <direction> --type <type
|
|
|
10147
11136
|
<dd>
|
|
10148
11137
|
|
|
10149
11138
|
```typescript
|
|
10150
|
-
await client.pods.
|
|
11139
|
+
await client.pods.threads.search("pod_id", {
|
|
11140
|
+
q: "q"
|
|
11141
|
+
});
|
|
10151
11142
|
|
|
10152
11143
|
```
|
|
10153
11144
|
</dd>
|
|
@@ -10171,23 +11162,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
10171
11162
|
<dl>
|
|
10172
11163
|
<dd>
|
|
10173
11164
|
|
|
10174
|
-
**
|
|
10175
|
-
|
|
10176
|
-
</dd>
|
|
10177
|
-
</dl>
|
|
10178
|
-
|
|
10179
|
-
<dl>
|
|
10180
|
-
<dd>
|
|
10181
|
-
|
|
10182
|
-
**type:** `AgentMail.ListType`
|
|
10183
|
-
|
|
10184
|
-
</dd>
|
|
10185
|
-
</dl>
|
|
10186
|
-
|
|
10187
|
-
<dl>
|
|
10188
|
-
<dd>
|
|
10189
|
-
|
|
10190
|
-
**request:** `AgentMail.pods.ListListEntriesRequest`
|
|
11165
|
+
**request:** `AgentMail.pods.SearchThreadsRequest`
|
|
10191
11166
|
|
|
10192
11167
|
</dd>
|
|
10193
11168
|
</dl>
|
|
@@ -10195,7 +11170,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
10195
11170
|
<dl>
|
|
10196
11171
|
<dd>
|
|
10197
11172
|
|
|
10198
|
-
**requestOptions:** `
|
|
11173
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10199
11174
|
|
|
10200
11175
|
</dd>
|
|
10201
11176
|
</dl>
|
|
@@ -10207,7 +11182,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
10207
11182
|
</dl>
|
|
10208
11183
|
</details>
|
|
10209
11184
|
|
|
10210
|
-
<details><summary><code>client.pods.
|
|
11185
|
+
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">get</a>(pod_id, thread_id, { ...params }) -> AgentMail.Thread</code></summary>
|
|
10211
11186
|
<dl>
|
|
10212
11187
|
<dd>
|
|
10213
11188
|
|
|
@@ -10221,7 +11196,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
10221
11196
|
|
|
10222
11197
|
**CLI:**
|
|
10223
11198
|
```bash
|
|
10224
|
-
agentmail pods
|
|
11199
|
+
agentmail pods threads get --pod-id <pod_id> --thread-id <thread_id>
|
|
10225
11200
|
```
|
|
10226
11201
|
</dd>
|
|
10227
11202
|
</dl>
|
|
@@ -10237,7 +11212,7 @@ agentmail pods lists get --pod-id <pod_id> --direction <direction> --type <type>
|
|
|
10237
11212
|
<dd>
|
|
10238
11213
|
|
|
10239
11214
|
```typescript
|
|
10240
|
-
await client.pods.
|
|
11215
|
+
await client.pods.threads.get("pod_id", "thread_id");
|
|
10241
11216
|
|
|
10242
11217
|
```
|
|
10243
11218
|
</dd>
|
|
@@ -10261,15 +11236,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
10261
11236
|
<dl>
|
|
10262
11237
|
<dd>
|
|
10263
11238
|
|
|
10264
|
-
**
|
|
10265
|
-
|
|
10266
|
-
</dd>
|
|
10267
|
-
</dl>
|
|
10268
|
-
|
|
10269
|
-
<dl>
|
|
10270
|
-
<dd>
|
|
10271
|
-
|
|
10272
|
-
**type:** `AgentMail.ListType`
|
|
11239
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
10273
11240
|
|
|
10274
11241
|
</dd>
|
|
10275
11242
|
</dl>
|
|
@@ -10277,7 +11244,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
10277
11244
|
<dl>
|
|
10278
11245
|
<dd>
|
|
10279
11246
|
|
|
10280
|
-
**
|
|
11247
|
+
**request:** `AgentMail.pods.GetPodThreadRequest`
|
|
10281
11248
|
|
|
10282
11249
|
</dd>
|
|
10283
11250
|
</dl>
|
|
@@ -10285,7 +11252,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
10285
11252
|
<dl>
|
|
10286
11253
|
<dd>
|
|
10287
11254
|
|
|
10288
|
-
**requestOptions:** `
|
|
11255
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10289
11256
|
|
|
10290
11257
|
</dd>
|
|
10291
11258
|
</dl>
|
|
@@ -10297,7 +11264,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
10297
11264
|
</dl>
|
|
10298
11265
|
</details>
|
|
10299
11266
|
|
|
10300
|
-
<details><summary><code>client.pods.
|
|
11267
|
+
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">getAttachment</a>(pod_id, thread_id, attachment_id) -> AgentMail.AttachmentResponse</code></summary>
|
|
10301
11268
|
<dl>
|
|
10302
11269
|
<dd>
|
|
10303
11270
|
|
|
@@ -10311,7 +11278,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
10311
11278
|
|
|
10312
11279
|
**CLI:**
|
|
10313
11280
|
```bash
|
|
10314
|
-
agentmail pods
|
|
11281
|
+
agentmail pods threads get-attachment --pod-id <pod_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
10315
11282
|
```
|
|
10316
11283
|
</dd>
|
|
10317
11284
|
</dl>
|
|
@@ -10327,9 +11294,7 @@ agentmail pods lists create --pod-id <pod_id> --direction <direction> --type <ty
|
|
|
10327
11294
|
<dd>
|
|
10328
11295
|
|
|
10329
11296
|
```typescript
|
|
10330
|
-
await client.pods.
|
|
10331
|
-
entry: "entry"
|
|
10332
|
-
});
|
|
11297
|
+
await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
10333
11298
|
|
|
10334
11299
|
```
|
|
10335
11300
|
</dd>
|
|
@@ -10353,15 +11318,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
10353
11318
|
<dl>
|
|
10354
11319
|
<dd>
|
|
10355
11320
|
|
|
10356
|
-
**
|
|
10357
|
-
|
|
10358
|
-
</dd>
|
|
10359
|
-
</dl>
|
|
10360
|
-
|
|
10361
|
-
<dl>
|
|
10362
|
-
<dd>
|
|
10363
|
-
|
|
10364
|
-
**type:** `AgentMail.ListType`
|
|
11321
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
10365
11322
|
|
|
10366
11323
|
</dd>
|
|
10367
11324
|
</dl>
|
|
@@ -10369,7 +11326,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
10369
11326
|
<dl>
|
|
10370
11327
|
<dd>
|
|
10371
11328
|
|
|
10372
|
-
**
|
|
11329
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
10373
11330
|
|
|
10374
11331
|
</dd>
|
|
10375
11332
|
</dl>
|
|
@@ -10377,7 +11334,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
10377
11334
|
<dl>
|
|
10378
11335
|
<dd>
|
|
10379
11336
|
|
|
10380
|
-
**requestOptions:** `
|
|
11337
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10381
11338
|
|
|
10382
11339
|
</dd>
|
|
10383
11340
|
</dl>
|
|
@@ -10389,7 +11346,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
10389
11346
|
</dl>
|
|
10390
11347
|
</details>
|
|
10391
11348
|
|
|
10392
|
-
<details><summary><code>client.pods.
|
|
11349
|
+
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">update</a>(pod_id, thread_id, { ...params }) -> AgentMail.UpdateThreadResponse</code></summary>
|
|
10393
11350
|
<dl>
|
|
10394
11351
|
<dd>
|
|
10395
11352
|
|
|
@@ -10401,10 +11358,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
10401
11358
|
<dl>
|
|
10402
11359
|
<dd>
|
|
10403
11360
|
|
|
10404
|
-
|
|
10405
|
-
```bash
|
|
10406
|
-
agentmail pods lists delete --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
10407
|
-
```
|
|
11361
|
+
Updates thread labels. Cannot add or remove system labels (sent, received, bounced, etc.). Rejects requests with a `422` for threads with 100 or more messages.
|
|
10408
11362
|
</dd>
|
|
10409
11363
|
</dl>
|
|
10410
11364
|
</dd>
|
|
@@ -10419,7 +11373,7 @@ agentmail pods lists delete --pod-id <pod_id> --direction <direction> --type <ty
|
|
|
10419
11373
|
<dd>
|
|
10420
11374
|
|
|
10421
11375
|
```typescript
|
|
10422
|
-
await client.pods.
|
|
11376
|
+
await client.pods.threads.update("pod_id", "thread_id", {});
|
|
10423
11377
|
|
|
10424
11378
|
```
|
|
10425
11379
|
</dd>
|
|
@@ -10443,15 +11397,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
10443
11397
|
<dl>
|
|
10444
11398
|
<dd>
|
|
10445
11399
|
|
|
10446
|
-
**
|
|
10447
|
-
|
|
10448
|
-
</dd>
|
|
10449
|
-
</dl>
|
|
10450
|
-
|
|
10451
|
-
<dl>
|
|
10452
|
-
<dd>
|
|
10453
|
-
|
|
10454
|
-
**type:** `AgentMail.ListType`
|
|
11400
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
10455
11401
|
|
|
10456
11402
|
</dd>
|
|
10457
11403
|
</dl>
|
|
@@ -10459,7 +11405,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
10459
11405
|
<dl>
|
|
10460
11406
|
<dd>
|
|
10461
11407
|
|
|
10462
|
-
**
|
|
11408
|
+
**request:** `AgentMail.UpdateThreadRequest`
|
|
10463
11409
|
|
|
10464
11410
|
</dd>
|
|
10465
11411
|
</dl>
|
|
@@ -10467,7 +11413,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
10467
11413
|
<dl>
|
|
10468
11414
|
<dd>
|
|
10469
11415
|
|
|
10470
|
-
**requestOptions:** `
|
|
11416
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10471
11417
|
|
|
10472
11418
|
</dd>
|
|
10473
11419
|
</dl>
|
|
@@ -10479,8 +11425,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
10479
11425
|
</dl>
|
|
10480
11426
|
</details>
|
|
10481
11427
|
|
|
10482
|
-
|
|
10483
|
-
<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>
|
|
11428
|
+
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">delete</a>(pod_id, thread_id) -> void</code></summary>
|
|
10484
11429
|
<dl>
|
|
10485
11430
|
<dd>
|
|
10486
11431
|
|
|
@@ -10492,15 +11437,11 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
10492
11437
|
<dl>
|
|
10493
11438
|
<dd>
|
|
10494
11439
|
|
|
10495
|
-
|
|
10496
|
-
the pod. Defaults to the last 24 hours; `start` must be within the last
|
|
10497
|
-
90 days, and a future `end` is clamped to now. Omit `period` for
|
|
10498
|
-
individual event counts, or set it to sum counts into buckets of that
|
|
10499
|
-
many seconds.
|
|
11440
|
+
Permanently deletes a thread and all of its messages.
|
|
10500
11441
|
|
|
10501
11442
|
**CLI:**
|
|
10502
11443
|
```bash
|
|
10503
|
-
agentmail pods
|
|
11444
|
+
agentmail pods threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
10504
11445
|
```
|
|
10505
11446
|
</dd>
|
|
10506
11447
|
</dl>
|
|
@@ -10516,7 +11457,7 @@ agentmail pods metrics query-events --pod-id <pod_id>
|
|
|
10516
11457
|
<dd>
|
|
10517
11458
|
|
|
10518
11459
|
```typescript
|
|
10519
|
-
await client.pods.
|
|
11460
|
+
await client.pods.threads.delete("pod_id", "thread_id");
|
|
10520
11461
|
|
|
10521
11462
|
```
|
|
10522
11463
|
</dd>
|
|
@@ -10540,7 +11481,7 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
10540
11481
|
<dl>
|
|
10541
11482
|
<dd>
|
|
10542
11483
|
|
|
10543
|
-
**
|
|
11484
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
10544
11485
|
|
|
10545
11486
|
</dd>
|
|
10546
11487
|
</dl>
|
|
@@ -10548,7 +11489,7 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
10548
11489
|
<dl>
|
|
10549
11490
|
<dd>
|
|
10550
11491
|
|
|
10551
|
-
**requestOptions:** `
|
|
11492
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10552
11493
|
|
|
10553
11494
|
</dd>
|
|
10554
11495
|
</dl>
|
|
@@ -10560,7 +11501,8 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
10560
11501
|
</dl>
|
|
10561
11502
|
</details>
|
|
10562
11503
|
|
|
10563
|
-
|
|
11504
|
+
## Pods Webhooks
|
|
11505
|
+
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListWebhooksResponse</code></summary>
|
|
10564
11506
|
<dl>
|
|
10565
11507
|
<dd>
|
|
10566
11508
|
|
|
@@ -10572,13 +11514,10 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
10572
11514
|
<dl>
|
|
10573
11515
|
<dd>
|
|
10574
11516
|
|
|
10575
|
-
|
|
10576
|
-
|
|
10577
|
-
|
|
10578
|
-
|
|
10579
|
-
24 hours; `start` must be within the last 90 days, and a future `end`
|
|
10580
|
-
is clamped to now. The range divided by `period` must not exceed 1000
|
|
10581
|
-
buckets.
|
|
11517
|
+
**CLI:**
|
|
11518
|
+
```bash
|
|
11519
|
+
agentmail pods webhooks list --pod-id <pod_id>
|
|
11520
|
+
```
|
|
10582
11521
|
</dd>
|
|
10583
11522
|
</dl>
|
|
10584
11523
|
</dd>
|
|
@@ -10593,7 +11532,7 @@ buckets.
|
|
|
10593
11532
|
<dd>
|
|
10594
11533
|
|
|
10595
11534
|
```typescript
|
|
10596
|
-
await client.pods.
|
|
11535
|
+
await client.pods.webhooks.list("pod_id");
|
|
10597
11536
|
|
|
10598
11537
|
```
|
|
10599
11538
|
</dd>
|
|
@@ -10617,7 +11556,7 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
10617
11556
|
<dl>
|
|
10618
11557
|
<dd>
|
|
10619
11558
|
|
|
10620
|
-
**request:** `AgentMail.pods.
|
|
11559
|
+
**request:** `AgentMail.pods.PodListWebhooksRequest`
|
|
10621
11560
|
|
|
10622
11561
|
</dd>
|
|
10623
11562
|
</dl>
|
|
@@ -10625,7 +11564,7 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
10625
11564
|
<dl>
|
|
10626
11565
|
<dd>
|
|
10627
11566
|
|
|
10628
|
-
**requestOptions:** `
|
|
11567
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
10629
11568
|
|
|
10630
11569
|
</dd>
|
|
10631
11570
|
</dl>
|
|
@@ -10637,7 +11576,7 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
10637
11576
|
</dl>
|
|
10638
11577
|
</details>
|
|
10639
11578
|
|
|
10640
|
-
<details><summary><code>client.pods.
|
|
11579
|
+
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">get</a>(pod_id, webhook_id) -> AgentMail.Webhook</code></summary>
|
|
10641
11580
|
<dl>
|
|
10642
11581
|
<dd>
|
|
10643
11582
|
|
|
@@ -10649,20 +11588,9 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
10649
11588
|
<dl>
|
|
10650
11589
|
<dd>
|
|
10651
11590
|
|
|
10652
|
-
Rolling bounce and complaint rates for the pod. At each `period` grid
|
|
10653
|
-
point, the bounced (or complained) messages over the preceding
|
|
10654
|
-
`window` divided by the messages sent over the same window, with the
|
|
10655
|
-
send count alongside. Account moderation evaluates the organization-wide
|
|
10656
|
-
rate, so use the organization endpoint to see the number it acts on;
|
|
10657
|
-
the pod view shows which pods contribute. Defaults to the rolling
|
|
10658
|
-
24-hour rate sampled hourly over the last day; `start` must be within
|
|
10659
|
-
the last 90 days, `window` must be a whole multiple of `period`, and
|
|
10660
|
-
the range plus window divided by `period` must not exceed 1000
|
|
10661
|
-
buckets.
|
|
10662
|
-
|
|
10663
11591
|
**CLI:**
|
|
10664
11592
|
```bash
|
|
10665
|
-
agentmail pods
|
|
11593
|
+
agentmail pods webhooks get --pod-id <pod_id> --webhook-id <webhook_id>
|
|
10666
11594
|
```
|
|
10667
11595
|
</dd>
|
|
10668
11596
|
</dl>
|
|
@@ -10678,7 +11606,7 @@ agentmail pods metrics query-rates --pod-id <pod_id>
|
|
|
10678
11606
|
<dd>
|
|
10679
11607
|
|
|
10680
11608
|
```typescript
|
|
10681
|
-
await client.pods.
|
|
11609
|
+
await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
10682
11610
|
|
|
10683
11611
|
```
|
|
10684
11612
|
</dd>
|
|
@@ -10702,7 +11630,7 @@ await client.pods.metrics.queryRates("pod_id");
|
|
|
10702
11630
|
<dl>
|
|
10703
11631
|
<dd>
|
|
10704
11632
|
|
|
10705
|
-
**
|
|
11633
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
10706
11634
|
|
|
10707
11635
|
</dd>
|
|
10708
11636
|
</dl>
|
|
@@ -10710,7 +11638,7 @@ await client.pods.metrics.queryRates("pod_id");
|
|
|
10710
11638
|
<dl>
|
|
10711
11639
|
<dd>
|
|
10712
11640
|
|
|
10713
|
-
**requestOptions:** `
|
|
11641
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
10714
11642
|
|
|
10715
11643
|
</dd>
|
|
10716
11644
|
</dl>
|
|
@@ -10722,8 +11650,7 @@ await client.pods.metrics.queryRates("pod_id");
|
|
|
10722
11650
|
</dl>
|
|
10723
11651
|
</details>
|
|
10724
11652
|
|
|
10725
|
-
|
|
10726
|
-
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
11653
|
+
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">getHeaders</a>(pod_id, webhook_id) -> AgentMail.WebhookHeaderNamesResponse</code></summary>
|
|
10727
11654
|
<dl>
|
|
10728
11655
|
<dd>
|
|
10729
11656
|
|
|
@@ -10735,15 +11662,8 @@ await client.pods.metrics.queryRates("pod_id");
|
|
|
10735
11662
|
<dl>
|
|
10736
11663
|
<dd>
|
|
10737
11664
|
|
|
10738
|
-
|
|
10739
|
-
|
|
10740
|
-
served by search, which caps `limit` at 100. For relevance-ranked
|
|
10741
|
-
full-text search, use `Search Threads`.
|
|
10742
|
-
|
|
10743
|
-
**CLI:**
|
|
10744
|
-
```bash
|
|
10745
|
-
agentmail pods threads list --pod-id <pod_id>
|
|
10746
|
-
```
|
|
11665
|
+
List the names of custom HTTP headers included with deliveries to this pod-scoped webhook.
|
|
11666
|
+
Header values are write-only and are never returned.
|
|
10747
11667
|
</dd>
|
|
10748
11668
|
</dl>
|
|
10749
11669
|
</dd>
|
|
@@ -10758,7 +11678,7 @@ agentmail pods threads list --pod-id <pod_id>
|
|
|
10758
11678
|
<dd>
|
|
10759
11679
|
|
|
10760
11680
|
```typescript
|
|
10761
|
-
await client.pods.
|
|
11681
|
+
await client.pods.webhooks.getHeaders("pod_id", "webhook_id");
|
|
10762
11682
|
|
|
10763
11683
|
```
|
|
10764
11684
|
</dd>
|
|
@@ -10782,7 +11702,7 @@ await client.pods.threads.list("pod_id");
|
|
|
10782
11702
|
<dl>
|
|
10783
11703
|
<dd>
|
|
10784
11704
|
|
|
10785
|
-
**
|
|
11705
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
10786
11706
|
|
|
10787
11707
|
</dd>
|
|
10788
11708
|
</dl>
|
|
@@ -10790,7 +11710,7 @@ await client.pods.threads.list("pod_id");
|
|
|
10790
11710
|
<dl>
|
|
10791
11711
|
<dd>
|
|
10792
11712
|
|
|
10793
|
-
**requestOptions:** `
|
|
11713
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
10794
11714
|
|
|
10795
11715
|
</dd>
|
|
10796
11716
|
</dl>
|
|
@@ -10802,7 +11722,7 @@ await client.pods.threads.list("pod_id");
|
|
|
10802
11722
|
</dl>
|
|
10803
11723
|
</details>
|
|
10804
11724
|
|
|
10805
|
-
<details><summary><code>client.pods.
|
|
11725
|
+
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">create</a>(pod_id, { ...params }) -> AgentMail.Webhook</code></summary>
|
|
10806
11726
|
<dl>
|
|
10807
11727
|
<dd>
|
|
10808
11728
|
|
|
@@ -10814,10 +11734,12 @@ await client.pods.threads.list("pod_id");
|
|
|
10814
11734
|
<dl>
|
|
10815
11735
|
<dd>
|
|
10816
11736
|
|
|
10817
|
-
|
|
10818
|
-
|
|
10819
|
-
|
|
10820
|
-
|
|
11737
|
+
Create a webhook scoped to this pod.
|
|
11738
|
+
|
|
11739
|
+
**CLI:**
|
|
11740
|
+
```bash
|
|
11741
|
+
agentmail pods webhooks create --pod-id <pod_id> --url https://example.com/webhook --event-types message.received
|
|
11742
|
+
```
|
|
10821
11743
|
</dd>
|
|
10822
11744
|
</dl>
|
|
10823
11745
|
</dd>
|
|
@@ -10832,8 +11754,9 @@ unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
|
10832
11754
|
<dd>
|
|
10833
11755
|
|
|
10834
11756
|
```typescript
|
|
10835
|
-
await client.pods.
|
|
10836
|
-
|
|
11757
|
+
await client.pods.webhooks.create("pod_id", {
|
|
11758
|
+
url: "url",
|
|
11759
|
+
eventTypes: ["message.received", "message.received"]
|
|
10837
11760
|
});
|
|
10838
11761
|
|
|
10839
11762
|
```
|
|
@@ -10858,7 +11781,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
10858
11781
|
<dl>
|
|
10859
11782
|
<dd>
|
|
10860
11783
|
|
|
10861
|
-
**request:** `AgentMail.
|
|
11784
|
+
**request:** `AgentMail.CreatePodWebhookRequest`
|
|
10862
11785
|
|
|
10863
11786
|
</dd>
|
|
10864
11787
|
</dl>
|
|
@@ -10866,7 +11789,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
10866
11789
|
<dl>
|
|
10867
11790
|
<dd>
|
|
10868
11791
|
|
|
10869
|
-
**requestOptions:** `
|
|
11792
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
10870
11793
|
|
|
10871
11794
|
</dd>
|
|
10872
11795
|
</dl>
|
|
@@ -10878,7 +11801,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
10878
11801
|
</dl>
|
|
10879
11802
|
</details>
|
|
10880
11803
|
|
|
10881
|
-
<details><summary><code>client.pods.
|
|
11804
|
+
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">update</a>(pod_id, webhook_id, { ...params }) -> AgentMail.Webhook</code></summary>
|
|
10882
11805
|
<dl>
|
|
10883
11806
|
<dd>
|
|
10884
11807
|
|
|
@@ -10892,7 +11815,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
10892
11815
|
|
|
10893
11816
|
**CLI:**
|
|
10894
11817
|
```bash
|
|
10895
|
-
agentmail pods
|
|
11818
|
+
agentmail pods webhooks update --pod-id <pod_id> --webhook-id <webhook_id> --add-inbox-ids <inbox_id>
|
|
10896
11819
|
```
|
|
10897
11820
|
</dd>
|
|
10898
11821
|
</dl>
|
|
@@ -10908,7 +11831,7 @@ agentmail pods threads get --pod-id <pod_id> --thread-id <thread_id>
|
|
|
10908
11831
|
<dd>
|
|
10909
11832
|
|
|
10910
11833
|
```typescript
|
|
10911
|
-
await client.pods.
|
|
11834
|
+
await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
10912
11835
|
|
|
10913
11836
|
```
|
|
10914
11837
|
</dd>
|
|
@@ -10932,7 +11855,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
10932
11855
|
<dl>
|
|
10933
11856
|
<dd>
|
|
10934
11857
|
|
|
10935
|
-
**
|
|
11858
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
10936
11859
|
|
|
10937
11860
|
</dd>
|
|
10938
11861
|
</dl>
|
|
@@ -10940,7 +11863,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
10940
11863
|
<dl>
|
|
10941
11864
|
<dd>
|
|
10942
11865
|
|
|
10943
|
-
**request:** `AgentMail.
|
|
11866
|
+
**request:** `AgentMail.UpdatePodWebhookRequest`
|
|
10944
11867
|
|
|
10945
11868
|
</dd>
|
|
10946
11869
|
</dl>
|
|
@@ -10948,7 +11871,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
10948
11871
|
<dl>
|
|
10949
11872
|
<dd>
|
|
10950
11873
|
|
|
10951
|
-
**requestOptions:** `
|
|
11874
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
10952
11875
|
|
|
10953
11876
|
</dd>
|
|
10954
11877
|
</dl>
|
|
@@ -10960,7 +11883,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
10960
11883
|
</dl>
|
|
10961
11884
|
</details>
|
|
10962
11885
|
|
|
10963
|
-
<details><summary><code>client.pods.
|
|
11886
|
+
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">updateHeaders</a>(pod_id, webhook_id, { ...params }) -> void</code></summary>
|
|
10964
11887
|
<dl>
|
|
10965
11888
|
<dd>
|
|
10966
11889
|
|
|
@@ -10972,10 +11895,8 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
10972
11895
|
<dl>
|
|
10973
11896
|
<dd>
|
|
10974
11897
|
|
|
10975
|
-
|
|
10976
|
-
|
|
10977
|
-
agentmail pods threads get-attachment --pod-id <pod_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
10978
|
-
```
|
|
11898
|
+
Atomically set, replace, or remove custom HTTP headers included with deliveries to this
|
|
11899
|
+
pod-scoped webhook. Header values remain write-only.
|
|
10979
11900
|
</dd>
|
|
10980
11901
|
</dl>
|
|
10981
11902
|
</dd>
|
|
@@ -10990,7 +11911,7 @@ agentmail pods threads get-attachment --pod-id <pod_id> --thread-id <thread_id>
|
|
|
10990
11911
|
<dd>
|
|
10991
11912
|
|
|
10992
11913
|
```typescript
|
|
10993
|
-
await client.pods.
|
|
11914
|
+
await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
10994
11915
|
|
|
10995
11916
|
```
|
|
10996
11917
|
</dd>
|
|
@@ -11014,7 +11935,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
11014
11935
|
<dl>
|
|
11015
11936
|
<dd>
|
|
11016
11937
|
|
|
11017
|
-
**
|
|
11938
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
11018
11939
|
|
|
11019
11940
|
</dd>
|
|
11020
11941
|
</dl>
|
|
@@ -11022,7 +11943,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
11022
11943
|
<dl>
|
|
11023
11944
|
<dd>
|
|
11024
11945
|
|
|
11025
|
-
**
|
|
11946
|
+
**request:** `AgentMail.UpdateWebhookHeadersRequest`
|
|
11026
11947
|
|
|
11027
11948
|
</dd>
|
|
11028
11949
|
</dl>
|
|
@@ -11030,7 +11951,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
11030
11951
|
<dl>
|
|
11031
11952
|
<dd>
|
|
11032
11953
|
|
|
11033
|
-
**requestOptions:** `
|
|
11954
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
11034
11955
|
|
|
11035
11956
|
</dd>
|
|
11036
11957
|
</dl>
|
|
@@ -11042,7 +11963,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
11042
11963
|
</dl>
|
|
11043
11964
|
</details>
|
|
11044
11965
|
|
|
11045
|
-
<details><summary><code>client.pods.
|
|
11966
|
+
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">delete</a>(pod_id, webhook_id) -> void</code></summary>
|
|
11046
11967
|
<dl>
|
|
11047
11968
|
<dd>
|
|
11048
11969
|
|
|
@@ -11054,7 +11975,10 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
11054
11975
|
<dl>
|
|
11055
11976
|
<dd>
|
|
11056
11977
|
|
|
11057
|
-
|
|
11978
|
+
**CLI:**
|
|
11979
|
+
```bash
|
|
11980
|
+
agentmail pods webhooks delete --pod-id <pod_id> --webhook-id <webhook_id>
|
|
11981
|
+
```
|
|
11058
11982
|
</dd>
|
|
11059
11983
|
</dl>
|
|
11060
11984
|
</dd>
|
|
@@ -11069,7 +11993,7 @@ Updates thread labels. Cannot add or remove system labels (sent, received, bounc
|
|
|
11069
11993
|
<dd>
|
|
11070
11994
|
|
|
11071
11995
|
```typescript
|
|
11072
|
-
await client.pods.
|
|
11996
|
+
await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
11073
11997
|
|
|
11074
11998
|
```
|
|
11075
11999
|
</dd>
|
|
@@ -11093,15 +12017,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
11093
12017
|
<dl>
|
|
11094
12018
|
<dd>
|
|
11095
12019
|
|
|
11096
|
-
**
|
|
11097
|
-
|
|
11098
|
-
</dd>
|
|
11099
|
-
</dl>
|
|
11100
|
-
|
|
11101
|
-
<dl>
|
|
11102
|
-
<dd>
|
|
11103
|
-
|
|
11104
|
-
**request:** `AgentMail.UpdateThreadRequest`
|
|
12020
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
11105
12021
|
|
|
11106
12022
|
</dd>
|
|
11107
12023
|
</dl>
|
|
@@ -11109,7 +12025,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
11109
12025
|
<dl>
|
|
11110
12026
|
<dd>
|
|
11111
12027
|
|
|
11112
|
-
**requestOptions:** `
|
|
12028
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
11113
12029
|
|
|
11114
12030
|
</dd>
|
|
11115
12031
|
</dl>
|
|
@@ -11121,7 +12037,8 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
11121
12037
|
</dl>
|
|
11122
12038
|
</details>
|
|
11123
12039
|
|
|
11124
|
-
|
|
12040
|
+
## Pods Webhooks Polling
|
|
12041
|
+
<details><summary><code>client.pods.webhooks.polling.<a href="/src/api/resources/pods/resources/webhooks/resources/polling/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListPollingWebhooksResponse</code></summary>
|
|
11125
12042
|
<dl>
|
|
11126
12043
|
<dd>
|
|
11127
12044
|
|
|
@@ -11133,11 +12050,11 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
11133
12050
|
<dl>
|
|
11134
12051
|
<dd>
|
|
11135
12052
|
|
|
11136
|
-
|
|
12053
|
+
Lists the polling webhooks created through this pod route.
|
|
11137
12054
|
|
|
11138
12055
|
**CLI:**
|
|
11139
12056
|
```bash
|
|
11140
|
-
agentmail pods
|
|
12057
|
+
agentmail pods webhooks polling list --pod-id <pod_id>
|
|
11141
12058
|
```
|
|
11142
12059
|
</dd>
|
|
11143
12060
|
</dl>
|
|
@@ -11153,7 +12070,7 @@ agentmail pods threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
|
11153
12070
|
<dd>
|
|
11154
12071
|
|
|
11155
12072
|
```typescript
|
|
11156
|
-
await client.pods.
|
|
12073
|
+
await client.pods.webhooks.polling.list("pod_id");
|
|
11157
12074
|
|
|
11158
12075
|
```
|
|
11159
12076
|
</dd>
|
|
@@ -11177,7 +12094,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
11177
12094
|
<dl>
|
|
11178
12095
|
<dd>
|
|
11179
12096
|
|
|
11180
|
-
**
|
|
12097
|
+
**request:** `AgentMail.pods.webhooks.PodListPollingWebhooksRequest`
|
|
11181
12098
|
|
|
11182
12099
|
</dd>
|
|
11183
12100
|
</dl>
|
|
@@ -11185,7 +12102,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
11185
12102
|
<dl>
|
|
11186
12103
|
<dd>
|
|
11187
12104
|
|
|
11188
|
-
**requestOptions:** `
|
|
12105
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
11189
12106
|
|
|
11190
12107
|
</dd>
|
|
11191
12108
|
</dl>
|
|
@@ -11197,8 +12114,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
11197
12114
|
</dl>
|
|
11198
12115
|
</details>
|
|
11199
12116
|
|
|
11200
|
-
|
|
11201
|
-
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListWebhooksResponse</code></summary>
|
|
12117
|
+
<details><summary><code>client.pods.webhooks.polling.<a href="/src/api/resources/pods/resources/webhooks/resources/polling/client/Client.ts">get</a>(pod_id, webhook_id) -> AgentMail.PollingWebhook</code></summary>
|
|
11202
12118
|
<dl>
|
|
11203
12119
|
<dd>
|
|
11204
12120
|
|
|
@@ -11212,7 +12128,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
11212
12128
|
|
|
11213
12129
|
**CLI:**
|
|
11214
12130
|
```bash
|
|
11215
|
-
agentmail pods webhooks
|
|
12131
|
+
agentmail pods webhooks polling get --pod-id <pod_id> --webhook-id <webhook_id>
|
|
11216
12132
|
```
|
|
11217
12133
|
</dd>
|
|
11218
12134
|
</dl>
|
|
@@ -11228,7 +12144,7 @@ agentmail pods webhooks list --pod-id <pod_id>
|
|
|
11228
12144
|
<dd>
|
|
11229
12145
|
|
|
11230
12146
|
```typescript
|
|
11231
|
-
await client.pods.webhooks.
|
|
12147
|
+
await client.pods.webhooks.polling.get("pod_id", "webhook_id");
|
|
11232
12148
|
|
|
11233
12149
|
```
|
|
11234
12150
|
</dd>
|
|
@@ -11252,7 +12168,7 @@ await client.pods.webhooks.list("pod_id");
|
|
|
11252
12168
|
<dl>
|
|
11253
12169
|
<dd>
|
|
11254
12170
|
|
|
11255
|
-
**
|
|
12171
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
11256
12172
|
|
|
11257
12173
|
</dd>
|
|
11258
12174
|
</dl>
|
|
@@ -11260,7 +12176,7 @@ await client.pods.webhooks.list("pod_id");
|
|
|
11260
12176
|
<dl>
|
|
11261
12177
|
<dd>
|
|
11262
12178
|
|
|
11263
|
-
**requestOptions:** `
|
|
12179
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
11264
12180
|
|
|
11265
12181
|
</dd>
|
|
11266
12182
|
</dl>
|
|
@@ -11272,7 +12188,7 @@ await client.pods.webhooks.list("pod_id");
|
|
|
11272
12188
|
</dl>
|
|
11273
12189
|
</details>
|
|
11274
12190
|
|
|
11275
|
-
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">
|
|
12191
|
+
<details><summary><code>client.pods.webhooks.polling.<a href="/src/api/resources/pods/resources/webhooks/resources/polling/client/Client.ts">create</a>(pod_id, { ...params }) -> AgentMail.CreatePollingWebhookResponse</code></summary>
|
|
11276
12192
|
<dl>
|
|
11277
12193
|
<dd>
|
|
11278
12194
|
|
|
@@ -11284,9 +12200,11 @@ await client.pods.webhooks.list("pod_id");
|
|
|
11284
12200
|
<dl>
|
|
11285
12201
|
<dd>
|
|
11286
12202
|
|
|
12203
|
+
Create a polling webhook scoped to this pod and return the `token` that reads it.
|
|
12204
|
+
|
|
11287
12205
|
**CLI:**
|
|
11288
12206
|
```bash
|
|
11289
|
-
agentmail pods webhooks
|
|
12207
|
+
agentmail pods webhooks polling create --pod-id <pod_id> --client-id my-agent --event-types message.received
|
|
11290
12208
|
```
|
|
11291
12209
|
</dd>
|
|
11292
12210
|
</dl>
|
|
@@ -11302,7 +12220,10 @@ agentmail pods webhooks get --pod-id <pod_id> --webhook-id <webhook_id>
|
|
|
11302
12220
|
<dd>
|
|
11303
12221
|
|
|
11304
12222
|
```typescript
|
|
11305
|
-
await client.pods.webhooks.
|
|
12223
|
+
await client.pods.webhooks.polling.create("pod_id", {
|
|
12224
|
+
clientId: "client_id",
|
|
12225
|
+
eventTypes: ["message.received", "message.received"]
|
|
12226
|
+
});
|
|
11306
12227
|
|
|
11307
12228
|
```
|
|
11308
12229
|
</dd>
|
|
@@ -11326,7 +12247,7 @@ await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
|
11326
12247
|
<dl>
|
|
11327
12248
|
<dd>
|
|
11328
12249
|
|
|
11329
|
-
**
|
|
12250
|
+
**request:** `AgentMail.CreatePodPollingWebhookRequest`
|
|
11330
12251
|
|
|
11331
12252
|
</dd>
|
|
11332
12253
|
</dl>
|
|
@@ -11334,7 +12255,7 @@ await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
|
11334
12255
|
<dl>
|
|
11335
12256
|
<dd>
|
|
11336
12257
|
|
|
11337
|
-
**requestOptions:** `
|
|
12258
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
11338
12259
|
|
|
11339
12260
|
</dd>
|
|
11340
12261
|
</dl>
|
|
@@ -11346,7 +12267,7 @@ await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
|
11346
12267
|
</dl>
|
|
11347
12268
|
</details>
|
|
11348
12269
|
|
|
11349
|
-
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">
|
|
12270
|
+
<details><summary><code>client.pods.webhooks.polling.<a href="/src/api/resources/pods/resources/webhooks/resources/polling/client/Client.ts">delete</a>(pod_id, webhook_id) -> void</code></summary>
|
|
11350
12271
|
<dl>
|
|
11351
12272
|
<dd>
|
|
11352
12273
|
|
|
@@ -11358,8 +12279,10 @@ await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
|
11358
12279
|
<dl>
|
|
11359
12280
|
<dd>
|
|
11360
12281
|
|
|
11361
|
-
|
|
11362
|
-
|
|
12282
|
+
**CLI:**
|
|
12283
|
+
```bash
|
|
12284
|
+
agentmail pods webhooks polling delete --pod-id <pod_id> --webhook-id <webhook_id>
|
|
12285
|
+
```
|
|
11363
12286
|
</dd>
|
|
11364
12287
|
</dl>
|
|
11365
12288
|
</dd>
|
|
@@ -11374,7 +12297,7 @@ Header values are write-only and are never returned.
|
|
|
11374
12297
|
<dd>
|
|
11375
12298
|
|
|
11376
12299
|
```typescript
|
|
11377
|
-
await client.pods.webhooks.
|
|
12300
|
+
await client.pods.webhooks.polling.delete("pod_id", "webhook_id");
|
|
11378
12301
|
|
|
11379
12302
|
```
|
|
11380
12303
|
</dd>
|
|
@@ -11406,7 +12329,7 @@ await client.pods.webhooks.getHeaders("pod_id", "webhook_id");
|
|
|
11406
12329
|
<dl>
|
|
11407
12330
|
<dd>
|
|
11408
12331
|
|
|
11409
|
-
**requestOptions:** `
|
|
12332
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
11410
12333
|
|
|
11411
12334
|
</dd>
|
|
11412
12335
|
</dl>
|
|
@@ -11418,7 +12341,8 @@ await client.pods.webhooks.getHeaders("pod_id", "webhook_id");
|
|
|
11418
12341
|
</dl>
|
|
11419
12342
|
</details>
|
|
11420
12343
|
|
|
11421
|
-
|
|
12344
|
+
## Threads
|
|
12345
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
11422
12346
|
<dl>
|
|
11423
12347
|
<dd>
|
|
11424
12348
|
|
|
@@ -11430,11 +12354,15 @@ await client.pods.webhooks.getHeaders("pod_id", "webhook_id");
|
|
|
11430
12354
|
<dl>
|
|
11431
12355
|
<dd>
|
|
11432
12356
|
|
|
11433
|
-
|
|
12357
|
+
Lists threads, most recent first. Pass `senders`, `recipients`, or
|
|
12358
|
+
`subject` to filter by substring. Filtered requests are served by
|
|
12359
|
+
search, which caps `limit` at 100. For relevance-ranked full-text
|
|
12360
|
+
search across senders, recipients, subject, and message body, use
|
|
12361
|
+
`Search Threads`.
|
|
11434
12362
|
|
|
11435
12363
|
**CLI:**
|
|
11436
12364
|
```bash
|
|
11437
|
-
agentmail
|
|
12365
|
+
agentmail threads list
|
|
11438
12366
|
```
|
|
11439
12367
|
</dd>
|
|
11440
12368
|
</dl>
|
|
@@ -11450,10 +12378,7 @@ agentmail pods webhooks create --pod-id <pod_id> --url https://example.com/webho
|
|
|
11450
12378
|
<dd>
|
|
11451
12379
|
|
|
11452
12380
|
```typescript
|
|
11453
|
-
await client.
|
|
11454
|
-
url: "url",
|
|
11455
|
-
eventTypes: ["message.received", "message.received"]
|
|
11456
|
-
});
|
|
12381
|
+
await client.threads.list();
|
|
11457
12382
|
|
|
11458
12383
|
```
|
|
11459
12384
|
</dd>
|
|
@@ -11469,15 +12394,7 @@ await client.pods.webhooks.create("pod_id", {
|
|
|
11469
12394
|
<dl>
|
|
11470
12395
|
<dd>
|
|
11471
12396
|
|
|
11472
|
-
**
|
|
11473
|
-
|
|
11474
|
-
</dd>
|
|
11475
|
-
</dl>
|
|
11476
|
-
|
|
11477
|
-
<dl>
|
|
11478
|
-
<dd>
|
|
11479
|
-
|
|
11480
|
-
**request:** `AgentMail.CreatePodWebhookRequest`
|
|
12397
|
+
**request:** `AgentMail.ListThreadsRequest`
|
|
11481
12398
|
|
|
11482
12399
|
</dd>
|
|
11483
12400
|
</dl>
|
|
@@ -11485,7 +12402,7 @@ await client.pods.webhooks.create("pod_id", {
|
|
|
11485
12402
|
<dl>
|
|
11486
12403
|
<dd>
|
|
11487
12404
|
|
|
11488
|
-
**requestOptions:** `
|
|
12405
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
11489
12406
|
|
|
11490
12407
|
</dd>
|
|
11491
12408
|
</dl>
|
|
@@ -11497,7 +12414,7 @@ await client.pods.webhooks.create("pod_id", {
|
|
|
11497
12414
|
</dl>
|
|
11498
12415
|
</details>
|
|
11499
12416
|
|
|
11500
|
-
<details><summary><code>client.
|
|
12417
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">search</a>({ ...params }) -> AgentMail.SearchThreadsResponse</code></summary>
|
|
11501
12418
|
<dl>
|
|
11502
12419
|
<dd>
|
|
11503
12420
|
|
|
@@ -11509,10 +12426,11 @@ await client.pods.webhooks.create("pod_id", {
|
|
|
11509
12426
|
<dl>
|
|
11510
12427
|
<dd>
|
|
11511
12428
|
|
|
11512
|
-
|
|
11513
|
-
|
|
11514
|
-
|
|
11515
|
-
|
|
12429
|
+
Full-text search across threads in the organization, ranked by
|
|
12430
|
+
relevance. The query is matched against senders, recipients, and
|
|
12431
|
+
subject (substring) and the message body (tokenized full text). Spam,
|
|
12432
|
+
trash, blocked, and unauthenticated threads are always excluded.
|
|
12433
|
+
`limit` cannot exceed 100.
|
|
11516
12434
|
</dd>
|
|
11517
12435
|
</dl>
|
|
11518
12436
|
</dd>
|
|
@@ -11527,7 +12445,9 @@ agentmail pods webhooks update --pod-id <pod_id> --webhook-id <webhook_id> --add
|
|
|
11527
12445
|
<dd>
|
|
11528
12446
|
|
|
11529
12447
|
```typescript
|
|
11530
|
-
await client.
|
|
12448
|
+
await client.threads.search({
|
|
12449
|
+
q: "q"
|
|
12450
|
+
});
|
|
11531
12451
|
|
|
11532
12452
|
```
|
|
11533
12453
|
</dd>
|
|
@@ -11543,23 +12463,7 @@ await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
|
11543
12463
|
<dl>
|
|
11544
12464
|
<dd>
|
|
11545
12465
|
|
|
11546
|
-
**
|
|
11547
|
-
|
|
11548
|
-
</dd>
|
|
11549
|
-
</dl>
|
|
11550
|
-
|
|
11551
|
-
<dl>
|
|
11552
|
-
<dd>
|
|
11553
|
-
|
|
11554
|
-
**webhook_id:** `AgentMail.WebhookId`
|
|
11555
|
-
|
|
11556
|
-
</dd>
|
|
11557
|
-
</dl>
|
|
11558
|
-
|
|
11559
|
-
<dl>
|
|
11560
|
-
<dd>
|
|
11561
|
-
|
|
11562
|
-
**request:** `AgentMail.UpdatePodWebhookRequest`
|
|
12466
|
+
**request:** `AgentMail.SearchThreadsRequest`
|
|
11563
12467
|
|
|
11564
12468
|
</dd>
|
|
11565
12469
|
</dl>
|
|
@@ -11567,7 +12471,7 @@ await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
|
11567
12471
|
<dl>
|
|
11568
12472
|
<dd>
|
|
11569
12473
|
|
|
11570
|
-
**requestOptions:** `
|
|
12474
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
11571
12475
|
|
|
11572
12476
|
</dd>
|
|
11573
12477
|
</dl>
|
|
@@ -11579,7 +12483,7 @@ await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
|
11579
12483
|
</dl>
|
|
11580
12484
|
</details>
|
|
11581
12485
|
|
|
11582
|
-
<details><summary><code>client.
|
|
12486
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">get</a>(thread_id, { ...params }) -> AgentMail.Thread</code></summary>
|
|
11583
12487
|
<dl>
|
|
11584
12488
|
<dd>
|
|
11585
12489
|
|
|
@@ -11591,8 +12495,10 @@ await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
|
11591
12495
|
<dl>
|
|
11592
12496
|
<dd>
|
|
11593
12497
|
|
|
11594
|
-
|
|
11595
|
-
|
|
12498
|
+
**CLI:**
|
|
12499
|
+
```bash
|
|
12500
|
+
agentmail threads get --thread-id <thread_id>
|
|
12501
|
+
```
|
|
11596
12502
|
</dd>
|
|
11597
12503
|
</dl>
|
|
11598
12504
|
</dd>
|
|
@@ -11607,7 +12513,7 @@ pod-scoped webhook. Header values remain write-only.
|
|
|
11607
12513
|
<dd>
|
|
11608
12514
|
|
|
11609
12515
|
```typescript
|
|
11610
|
-
await client.
|
|
12516
|
+
await client.threads.get("thread_id");
|
|
11611
12517
|
|
|
11612
12518
|
```
|
|
11613
12519
|
</dd>
|
|
@@ -11623,15 +12529,7 @@ await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
|
11623
12529
|
<dl>
|
|
11624
12530
|
<dd>
|
|
11625
12531
|
|
|
11626
|
-
**
|
|
11627
|
-
|
|
11628
|
-
</dd>
|
|
11629
|
-
</dl>
|
|
11630
|
-
|
|
11631
|
-
<dl>
|
|
11632
|
-
<dd>
|
|
11633
|
-
|
|
11634
|
-
**webhook_id:** `AgentMail.WebhookId`
|
|
12532
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
11635
12533
|
|
|
11636
12534
|
</dd>
|
|
11637
12535
|
</dl>
|
|
@@ -11639,7 +12537,7 @@ await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
|
11639
12537
|
<dl>
|
|
11640
12538
|
<dd>
|
|
11641
12539
|
|
|
11642
|
-
**request:** `AgentMail.
|
|
12540
|
+
**request:** `AgentMail.GetThreadRequest`
|
|
11643
12541
|
|
|
11644
12542
|
</dd>
|
|
11645
12543
|
</dl>
|
|
@@ -11647,7 +12545,7 @@ await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
|
11647
12545
|
<dl>
|
|
11648
12546
|
<dd>
|
|
11649
12547
|
|
|
11650
|
-
**requestOptions:** `
|
|
12548
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
11651
12549
|
|
|
11652
12550
|
</dd>
|
|
11653
12551
|
</dl>
|
|
@@ -11659,7 +12557,7 @@ await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
|
11659
12557
|
</dl>
|
|
11660
12558
|
</details>
|
|
11661
12559
|
|
|
11662
|
-
<details><summary><code>client.
|
|
12560
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">getAttachment</a>(thread_id, attachment_id) -> AgentMail.AttachmentResponse</code></summary>
|
|
11663
12561
|
<dl>
|
|
11664
12562
|
<dd>
|
|
11665
12563
|
|
|
@@ -11673,7 +12571,7 @@ await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
|
11673
12571
|
|
|
11674
12572
|
**CLI:**
|
|
11675
12573
|
```bash
|
|
11676
|
-
agentmail
|
|
12574
|
+
agentmail threads get-attachment --thread-id <thread_id> --attachment-id <attachment_id>
|
|
11677
12575
|
```
|
|
11678
12576
|
</dd>
|
|
11679
12577
|
</dl>
|
|
@@ -11689,7 +12587,7 @@ agentmail pods webhooks delete --pod-id <pod_id> --webhook-id <webhook_id>
|
|
|
11689
12587
|
<dd>
|
|
11690
12588
|
|
|
11691
12589
|
```typescript
|
|
11692
|
-
await client.
|
|
12590
|
+
await client.threads.getAttachment("thread_id", "attachment_id");
|
|
11693
12591
|
|
|
11694
12592
|
```
|
|
11695
12593
|
</dd>
|
|
@@ -11705,7 +12603,7 @@ await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
|
11705
12603
|
<dl>
|
|
11706
12604
|
<dd>
|
|
11707
12605
|
|
|
11708
|
-
**
|
|
12606
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
11709
12607
|
|
|
11710
12608
|
</dd>
|
|
11711
12609
|
</dl>
|
|
@@ -11713,7 +12611,7 @@ await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
|
11713
12611
|
<dl>
|
|
11714
12612
|
<dd>
|
|
11715
12613
|
|
|
11716
|
-
**
|
|
12614
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
11717
12615
|
|
|
11718
12616
|
</dd>
|
|
11719
12617
|
</dl>
|
|
@@ -11721,7 +12619,7 @@ await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
|
11721
12619
|
<dl>
|
|
11722
12620
|
<dd>
|
|
11723
12621
|
|
|
11724
|
-
**requestOptions:** `
|
|
12622
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
11725
12623
|
|
|
11726
12624
|
</dd>
|
|
11727
12625
|
</dl>
|
|
@@ -11733,8 +12631,7 @@ await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
|
11733
12631
|
</dl>
|
|
11734
12632
|
</details>
|
|
11735
12633
|
|
|
11736
|
-
|
|
11737
|
-
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
12634
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">update</a>(thread_id, { ...params }) -> AgentMail.UpdateThreadResponse</code></summary>
|
|
11738
12635
|
<dl>
|
|
11739
12636
|
<dd>
|
|
11740
12637
|
|
|
@@ -11746,16 +12643,7 @@ await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
|
11746
12643
|
<dl>
|
|
11747
12644
|
<dd>
|
|
11748
12645
|
|
|
11749
|
-
|
|
11750
|
-
`subject` to filter by substring. Filtered requests are served by
|
|
11751
|
-
search, which caps `limit` at 100. For relevance-ranked full-text
|
|
11752
|
-
search across senders, recipients, subject, and message body, use
|
|
11753
|
-
`Search Threads`.
|
|
11754
|
-
|
|
11755
|
-
**CLI:**
|
|
11756
|
-
```bash
|
|
11757
|
-
agentmail threads list
|
|
11758
|
-
```
|
|
12646
|
+
Updates thread labels. Cannot add or remove system labels (sent, received, bounced, etc.). Rejects requests with a `422` for threads with 100 or more messages.
|
|
11759
12647
|
</dd>
|
|
11760
12648
|
</dl>
|
|
11761
12649
|
</dd>
|
|
@@ -11770,7 +12658,7 @@ agentmail threads list
|
|
|
11770
12658
|
<dd>
|
|
11771
12659
|
|
|
11772
12660
|
```typescript
|
|
11773
|
-
await client.threads.
|
|
12661
|
+
await client.threads.update("thread_id", {});
|
|
11774
12662
|
|
|
11775
12663
|
```
|
|
11776
12664
|
</dd>
|
|
@@ -11786,7 +12674,15 @@ await client.threads.list();
|
|
|
11786
12674
|
<dl>
|
|
11787
12675
|
<dd>
|
|
11788
12676
|
|
|
11789
|
-
**
|
|
12677
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
12678
|
+
|
|
12679
|
+
</dd>
|
|
12680
|
+
</dl>
|
|
12681
|
+
|
|
12682
|
+
<dl>
|
|
12683
|
+
<dd>
|
|
12684
|
+
|
|
12685
|
+
**request:** `AgentMail.UpdateThreadRequest`
|
|
11790
12686
|
|
|
11791
12687
|
</dd>
|
|
11792
12688
|
</dl>
|
|
@@ -11806,7 +12702,7 @@ await client.threads.list();
|
|
|
11806
12702
|
</dl>
|
|
11807
12703
|
</details>
|
|
11808
12704
|
|
|
11809
|
-
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">
|
|
12705
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">delete</a>(thread_id) -> void</code></summary>
|
|
11810
12706
|
<dl>
|
|
11811
12707
|
<dd>
|
|
11812
12708
|
|
|
@@ -11818,11 +12714,12 @@ await client.threads.list();
|
|
|
11818
12714
|
<dl>
|
|
11819
12715
|
<dd>
|
|
11820
12716
|
|
|
11821
|
-
|
|
11822
|
-
|
|
11823
|
-
|
|
11824
|
-
|
|
11825
|
-
|
|
12717
|
+
Permanently deletes a thread and all of its messages.
|
|
12718
|
+
|
|
12719
|
+
**CLI:**
|
|
12720
|
+
```bash
|
|
12721
|
+
agentmail threads delete --thread-id <thread_id>
|
|
12722
|
+
```
|
|
11826
12723
|
</dd>
|
|
11827
12724
|
</dl>
|
|
11828
12725
|
</dd>
|
|
@@ -11837,9 +12734,7 @@ trash, blocked, and unauthenticated threads are always excluded.
|
|
|
11837
12734
|
<dd>
|
|
11838
12735
|
|
|
11839
12736
|
```typescript
|
|
11840
|
-
await client.threads.
|
|
11841
|
-
q: "q"
|
|
11842
|
-
});
|
|
12737
|
+
await client.threads.delete("thread_id");
|
|
11843
12738
|
|
|
11844
12739
|
```
|
|
11845
12740
|
</dd>
|
|
@@ -11855,7 +12750,7 @@ await client.threads.search({
|
|
|
11855
12750
|
<dl>
|
|
11856
12751
|
<dd>
|
|
11857
12752
|
|
|
11858
|
-
**
|
|
12753
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
11859
12754
|
|
|
11860
12755
|
</dd>
|
|
11861
12756
|
</dl>
|
|
@@ -11875,7 +12770,8 @@ await client.threads.search({
|
|
|
11875
12770
|
</dl>
|
|
11876
12771
|
</details>
|
|
11877
12772
|
|
|
11878
|
-
|
|
12773
|
+
## Webhooks Polling
|
|
12774
|
+
<details><summary><code>client.webhooks.polling.<a href="/src/api/resources/webhooks/resources/polling/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListPollingWebhooksResponse</code></summary>
|
|
11879
12775
|
<dl>
|
|
11880
12776
|
<dd>
|
|
11881
12777
|
|
|
@@ -11887,9 +12783,12 @@ await client.threads.search({
|
|
|
11887
12783
|
<dl>
|
|
11888
12784
|
<dd>
|
|
11889
12785
|
|
|
12786
|
+
Lists the polling webhooks created through this route. `page_token` must come from this
|
|
12787
|
+
endpoint; a token from another list endpoint is rejected.
|
|
12788
|
+
|
|
11890
12789
|
**CLI:**
|
|
11891
12790
|
```bash
|
|
11892
|
-
agentmail
|
|
12791
|
+
agentmail webhooks polling list
|
|
11893
12792
|
```
|
|
11894
12793
|
</dd>
|
|
11895
12794
|
</dl>
|
|
@@ -11905,7 +12804,7 @@ agentmail threads get --thread-id <thread_id>
|
|
|
11905
12804
|
<dd>
|
|
11906
12805
|
|
|
11907
12806
|
```typescript
|
|
11908
|
-
await client.
|
|
12807
|
+
await client.webhooks.polling.list();
|
|
11909
12808
|
|
|
11910
12809
|
```
|
|
11911
12810
|
</dd>
|
|
@@ -11921,15 +12820,7 @@ await client.threads.get("thread_id");
|
|
|
11921
12820
|
<dl>
|
|
11922
12821
|
<dd>
|
|
11923
12822
|
|
|
11924
|
-
**
|
|
11925
|
-
|
|
11926
|
-
</dd>
|
|
11927
|
-
</dl>
|
|
11928
|
-
|
|
11929
|
-
<dl>
|
|
11930
|
-
<dd>
|
|
11931
|
-
|
|
11932
|
-
**request:** `AgentMail.GetThreadRequest`
|
|
12823
|
+
**request:** `AgentMail.webhooks.ListPollingWebhooksRequest`
|
|
11933
12824
|
|
|
11934
12825
|
</dd>
|
|
11935
12826
|
</dl>
|
|
@@ -11937,7 +12828,7 @@ await client.threads.get("thread_id");
|
|
|
11937
12828
|
<dl>
|
|
11938
12829
|
<dd>
|
|
11939
12830
|
|
|
11940
|
-
**requestOptions:** `
|
|
12831
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
11941
12832
|
|
|
11942
12833
|
</dd>
|
|
11943
12834
|
</dl>
|
|
@@ -11949,7 +12840,7 @@ await client.threads.get("thread_id");
|
|
|
11949
12840
|
</dl>
|
|
11950
12841
|
</details>
|
|
11951
12842
|
|
|
11952
|
-
<details><summary><code>client.
|
|
12843
|
+
<details><summary><code>client.webhooks.polling.<a href="/src/api/resources/webhooks/resources/polling/client/Client.ts">get</a>(webhook_id) -> AgentMail.PollingWebhook</code></summary>
|
|
11953
12844
|
<dl>
|
|
11954
12845
|
<dd>
|
|
11955
12846
|
|
|
@@ -11961,9 +12852,11 @@ await client.threads.get("thread_id");
|
|
|
11961
12852
|
<dl>
|
|
11962
12853
|
<dd>
|
|
11963
12854
|
|
|
12855
|
+
The `token` is never returned here: create again with the same `client_id` to get a new one.
|
|
12856
|
+
|
|
11964
12857
|
**CLI:**
|
|
11965
12858
|
```bash
|
|
11966
|
-
agentmail
|
|
12859
|
+
agentmail webhooks polling get --webhook-id <webhook_id>
|
|
11967
12860
|
```
|
|
11968
12861
|
</dd>
|
|
11969
12862
|
</dl>
|
|
@@ -11979,7 +12872,7 @@ agentmail threads get-attachment --thread-id <thread_id> --attachment-id <attach
|
|
|
11979
12872
|
<dd>
|
|
11980
12873
|
|
|
11981
12874
|
```typescript
|
|
11982
|
-
await client.
|
|
12875
|
+
await client.webhooks.polling.get("webhook_id");
|
|
11983
12876
|
|
|
11984
12877
|
```
|
|
11985
12878
|
</dd>
|
|
@@ -11995,15 +12888,7 @@ await client.threads.getAttachment("thread_id", "attachment_id");
|
|
|
11995
12888
|
<dl>
|
|
11996
12889
|
<dd>
|
|
11997
12890
|
|
|
11998
|
-
**
|
|
11999
|
-
|
|
12000
|
-
</dd>
|
|
12001
|
-
</dl>
|
|
12002
|
-
|
|
12003
|
-
<dl>
|
|
12004
|
-
<dd>
|
|
12005
|
-
|
|
12006
|
-
**attachment_id:** `AgentMail.AttachmentId`
|
|
12891
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
12007
12892
|
|
|
12008
12893
|
</dd>
|
|
12009
12894
|
</dl>
|
|
@@ -12011,7 +12896,7 @@ await client.threads.getAttachment("thread_id", "attachment_id");
|
|
|
12011
12896
|
<dl>
|
|
12012
12897
|
<dd>
|
|
12013
12898
|
|
|
12014
|
-
**requestOptions:** `
|
|
12899
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
12015
12900
|
|
|
12016
12901
|
</dd>
|
|
12017
12902
|
</dl>
|
|
@@ -12023,7 +12908,7 @@ await client.threads.getAttachment("thread_id", "attachment_id");
|
|
|
12023
12908
|
</dl>
|
|
12024
12909
|
</details>
|
|
12025
12910
|
|
|
12026
|
-
<details><summary><code>client.
|
|
12911
|
+
<details><summary><code>client.webhooks.polling.<a href="/src/api/resources/webhooks/resources/polling/client/Client.ts">create</a>({ ...params }) -> AgentMail.CreatePollingWebhookResponse</code></summary>
|
|
12027
12912
|
<dl>
|
|
12028
12913
|
<dd>
|
|
12029
12914
|
|
|
@@ -12035,7 +12920,14 @@ await client.threads.getAttachment("thread_id", "attachment_id");
|
|
|
12035
12920
|
<dl>
|
|
12036
12921
|
<dd>
|
|
12037
12922
|
|
|
12038
|
-
|
|
12923
|
+
Creates a subscription the agent polls for events, and returns the `token` that reads it. Each
|
|
12924
|
+
organization, pod, and inbox holds at most 10 polling webhooks; a repeat create with the same
|
|
12925
|
+
`client_id` re-issues the token of the existing one instead of counting against that limit.
|
|
12926
|
+
|
|
12927
|
+
**CLI:**
|
|
12928
|
+
```bash
|
|
12929
|
+
agentmail webhooks polling create --client-id my-agent --event-types message.received
|
|
12930
|
+
```
|
|
12039
12931
|
</dd>
|
|
12040
12932
|
</dl>
|
|
12041
12933
|
</dd>
|
|
@@ -12050,7 +12942,10 @@ Updates thread labels. Cannot add or remove system labels (sent, received, bounc
|
|
|
12050
12942
|
<dd>
|
|
12051
12943
|
|
|
12052
12944
|
```typescript
|
|
12053
|
-
await client.
|
|
12945
|
+
await client.webhooks.polling.create({
|
|
12946
|
+
clientId: "client_id",
|
|
12947
|
+
eventTypes: ["message.received", "message.received"]
|
|
12948
|
+
});
|
|
12054
12949
|
|
|
12055
12950
|
```
|
|
12056
12951
|
</dd>
|
|
@@ -12066,15 +12961,7 @@ await client.threads.update("thread_id", {});
|
|
|
12066
12961
|
<dl>
|
|
12067
12962
|
<dd>
|
|
12068
12963
|
|
|
12069
|
-
**
|
|
12070
|
-
|
|
12071
|
-
</dd>
|
|
12072
|
-
</dl>
|
|
12073
|
-
|
|
12074
|
-
<dl>
|
|
12075
|
-
<dd>
|
|
12076
|
-
|
|
12077
|
-
**request:** `AgentMail.UpdateThreadRequest`
|
|
12964
|
+
**request:** `AgentMail.CreatePollingWebhookRequest`
|
|
12078
12965
|
|
|
12079
12966
|
</dd>
|
|
12080
12967
|
</dl>
|
|
@@ -12082,7 +12969,7 @@ await client.threads.update("thread_id", {});
|
|
|
12082
12969
|
<dl>
|
|
12083
12970
|
<dd>
|
|
12084
12971
|
|
|
12085
|
-
**requestOptions:** `
|
|
12972
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
12086
12973
|
|
|
12087
12974
|
</dd>
|
|
12088
12975
|
</dl>
|
|
@@ -12094,7 +12981,7 @@ await client.threads.update("thread_id", {});
|
|
|
12094
12981
|
</dl>
|
|
12095
12982
|
</details>
|
|
12096
12983
|
|
|
12097
|
-
<details><summary><code>client.
|
|
12984
|
+
<details><summary><code>client.webhooks.polling.<a href="/src/api/resources/webhooks/resources/polling/client/Client.ts">delete</a>(webhook_id) -> void</code></summary>
|
|
12098
12985
|
<dl>
|
|
12099
12986
|
<dd>
|
|
12100
12987
|
|
|
@@ -12106,11 +12993,11 @@ await client.threads.update("thread_id", {});
|
|
|
12106
12993
|
<dl>
|
|
12107
12994
|
<dd>
|
|
12108
12995
|
|
|
12109
|
-
|
|
12996
|
+
Stops delivery and invalidates the subscription's token.
|
|
12110
12997
|
|
|
12111
12998
|
**CLI:**
|
|
12112
12999
|
```bash
|
|
12113
|
-
agentmail
|
|
13000
|
+
agentmail webhooks polling delete --webhook-id <webhook_id>
|
|
12114
13001
|
```
|
|
12115
13002
|
</dd>
|
|
12116
13003
|
</dl>
|
|
@@ -12126,7 +13013,7 @@ agentmail threads delete --thread-id <thread_id>
|
|
|
12126
13013
|
<dd>
|
|
12127
13014
|
|
|
12128
13015
|
```typescript
|
|
12129
|
-
await client.
|
|
13016
|
+
await client.webhooks.polling.delete("webhook_id");
|
|
12130
13017
|
|
|
12131
13018
|
```
|
|
12132
13019
|
</dd>
|
|
@@ -12142,7 +13029,7 @@ await client.threads.delete("thread_id");
|
|
|
12142
13029
|
<dl>
|
|
12143
13030
|
<dd>
|
|
12144
13031
|
|
|
12145
|
-
**
|
|
13032
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
12146
13033
|
|
|
12147
13034
|
</dd>
|
|
12148
13035
|
</dl>
|
|
@@ -12150,7 +13037,7 @@ await client.threads.delete("thread_id");
|
|
|
12150
13037
|
<dl>
|
|
12151
13038
|
<dd>
|
|
12152
13039
|
|
|
12153
|
-
**requestOptions:** `
|
|
13040
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
12154
13041
|
|
|
12155
13042
|
</dd>
|
|
12156
13043
|
</dl>
|