agentmail 0.5.42 → 0.5.44
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/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.js +1 -0
- package/dist/cjs/api/resources/messages/types/MessageCalendarEventId.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/client/Client.d.ts +41 -1
- package/dist/cjs/api/resources/organizations/client/Client.js +159 -0
- package/dist/cjs/api/resources/organizations/errors/OrganizationForbiddenError.d.ts +6 -0
- package/dist/cjs/api/resources/organizations/errors/OrganizationForbiddenError.js +54 -0
- package/dist/cjs/api/resources/organizations/errors/index.d.ts +1 -0
- package/dist/cjs/api/resources/organizations/errors/index.js +17 -0
- package/dist/cjs/api/resources/organizations/index.d.ts +1 -0
- package/dist/cjs/api/resources/organizations/index.js +1 -0
- package/dist/cjs/api/resources/organizations/types/OrganizationLabs.d.ts +11 -0
- package/dist/cjs/api/resources/organizations/types/OrganizationLabs.js +3 -0
- package/dist/cjs/api/resources/organizations/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/organizations/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/organizations/types/OrganizationLabs.d.ts +11 -0
- package/dist/cjs/serialization/resources/organizations/types/OrganizationLabs.js +43 -0
- package/dist/cjs/serialization/resources/organizations/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/organizations/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/index.d.mts +1 -0
- package/dist/esm/api/resources/index.mjs +1 -0
- package/dist/esm/api/resources/messages/types/MessageCalendarEventId.d.mts +1 -1
- package/dist/esm/api/resources/organizations/client/Client.d.mts +41 -1
- package/dist/esm/api/resources/organizations/client/Client.mjs +159 -0
- package/dist/esm/api/resources/organizations/errors/OrganizationForbiddenError.d.mts +6 -0
- package/dist/esm/api/resources/organizations/errors/OrganizationForbiddenError.mjs +17 -0
- package/dist/esm/api/resources/organizations/errors/index.d.mts +1 -0
- package/dist/esm/api/resources/organizations/errors/index.mjs +1 -0
- package/dist/esm/api/resources/organizations/index.d.mts +1 -0
- package/dist/esm/api/resources/organizations/index.mjs +1 -0
- package/dist/esm/api/resources/organizations/types/OrganizationLabs.d.mts +11 -0
- package/dist/esm/api/resources/organizations/types/OrganizationLabs.mjs +2 -0
- package/dist/esm/api/resources/organizations/types/index.d.mts +1 -0
- package/dist/esm/api/resources/organizations/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/organizations/types/OrganizationLabs.d.mts +11 -0
- package/dist/esm/serialization/resources/organizations/types/OrganizationLabs.mjs +7 -0
- package/dist/esm/serialization/resources/organizations/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/organizations/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/dist/llms.txt +14 -0
- package/package.json +34 -1
- package/reference.md +1586 -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,803 @@ 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
|
+
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">getLabs</a>() -> AgentMail.OrganizationLabs</code></summary>
|
|
8758
|
+
<dl>
|
|
8759
|
+
<dd>
|
|
8760
|
+
|
|
8761
|
+
#### 📝 Description
|
|
8762
|
+
|
|
8763
|
+
<dl>
|
|
8764
|
+
<dd>
|
|
8765
|
+
|
|
8766
|
+
<dl>
|
|
8767
|
+
<dd>
|
|
8768
|
+
|
|
8769
|
+
Returns whether the organization is in [AgentMail Labs](https://docs.agentmail.to/calendar), which turns on features that are still in preview, such as calendar. Requires an organization-scoped API key.
|
|
8770
|
+
|
|
8771
|
+
**CLI:**
|
|
8772
|
+
```bash
|
|
8773
|
+
agentmail organizations get-labs
|
|
8774
|
+
```
|
|
8775
|
+
</dd>
|
|
8776
|
+
</dl>
|
|
8777
|
+
</dd>
|
|
8778
|
+
</dl>
|
|
8779
|
+
|
|
8780
|
+
#### 🔌 Usage
|
|
8781
|
+
|
|
8782
|
+
<dl>
|
|
8783
|
+
<dd>
|
|
8784
|
+
|
|
8785
|
+
<dl>
|
|
8786
|
+
<dd>
|
|
8787
|
+
|
|
8788
|
+
```typescript
|
|
8789
|
+
await client.organizations.getLabs();
|
|
8790
|
+
|
|
8791
|
+
```
|
|
8792
|
+
</dd>
|
|
8793
|
+
</dl>
|
|
8794
|
+
</dd>
|
|
8795
|
+
</dl>
|
|
8796
|
+
|
|
8797
|
+
#### ⚙️ Parameters
|
|
8798
|
+
|
|
8799
|
+
<dl>
|
|
8800
|
+
<dd>
|
|
8801
|
+
|
|
8802
|
+
<dl>
|
|
8803
|
+
<dd>
|
|
8804
|
+
|
|
8805
|
+
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
8806
|
+
|
|
8807
|
+
</dd>
|
|
8808
|
+
</dl>
|
|
8809
|
+
</dd>
|
|
8810
|
+
</dl>
|
|
8811
|
+
|
|
8812
|
+
|
|
8813
|
+
</dd>
|
|
8814
|
+
</dl>
|
|
8815
|
+
</details>
|
|
8816
|
+
|
|
8817
|
+
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">joinLabs</a>() -> AgentMail.OrganizationLabs</code></summary>
|
|
8818
|
+
<dl>
|
|
8819
|
+
<dd>
|
|
8820
|
+
|
|
8821
|
+
#### 📝 Description
|
|
8822
|
+
|
|
8823
|
+
<dl>
|
|
8824
|
+
<dd>
|
|
8825
|
+
|
|
8826
|
+
<dl>
|
|
8827
|
+
<dd>
|
|
8828
|
+
|
|
8829
|
+
Joins AgentMail Labs for the whole organization, which turns on every feature in Labs for every inbox. Joining again has no effect. There is no leave on the API; an organization admin can leave in the console under [Settings, then Labs](https://console.agentmail.to/dashboard/settings/labs).
|
|
8830
|
+
|
|
8831
|
+
Join only when your organization has decided to. Get Labs reads the same for an organization that never joined and one whose admin left Labs on purpose, so don't join just because `enabled` is `false`.
|
|
8832
|
+
|
|
8833
|
+
Requires an organization-scoped API key with no permissions restriction, and a verified organization. API keys see the change within five minutes. Where Labs isn't offered (`available` is `false` on Get Labs), joining returns `403`.
|
|
8834
|
+
|
|
8835
|
+
**CLI:**
|
|
8836
|
+
```bash
|
|
8837
|
+
agentmail organizations join-labs
|
|
8838
|
+
```
|
|
8839
|
+
</dd>
|
|
8840
|
+
</dl>
|
|
8841
|
+
</dd>
|
|
8842
|
+
</dl>
|
|
8843
|
+
|
|
8844
|
+
#### 🔌 Usage
|
|
8845
|
+
|
|
8846
|
+
<dl>
|
|
8847
|
+
<dd>
|
|
8848
|
+
|
|
8849
|
+
<dl>
|
|
8850
|
+
<dd>
|
|
8851
|
+
|
|
8852
|
+
```typescript
|
|
8853
|
+
await client.organizations.joinLabs();
|
|
8854
|
+
|
|
8855
|
+
```
|
|
8856
|
+
</dd>
|
|
8857
|
+
</dl>
|
|
8858
|
+
</dd>
|
|
8859
|
+
</dl>
|
|
8860
|
+
|
|
8861
|
+
#### ⚙️ Parameters
|
|
8862
|
+
|
|
8863
|
+
<dl>
|
|
8864
|
+
<dd>
|
|
8865
|
+
|
|
8866
|
+
<dl>
|
|
8867
|
+
<dd>
|
|
8868
|
+
|
|
8869
|
+
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
8870
|
+
|
|
8871
|
+
</dd>
|
|
8872
|
+
</dl>
|
|
8873
|
+
</dd>
|
|
8874
|
+
</dl>
|
|
8875
|
+
|
|
8876
|
+
|
|
8877
|
+
</dd>
|
|
8878
|
+
</dl>
|
|
8879
|
+
</details>
|
|
8880
|
+
|
|
8881
|
+
## Pods Accounts
|
|
8882
|
+
<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>
|
|
8883
|
+
<dl>
|
|
8884
|
+
<dd>
|
|
8885
|
+
|
|
8886
|
+
#### 📝 Description
|
|
8887
|
+
|
|
8888
|
+
<dl>
|
|
8889
|
+
<dd>
|
|
8890
|
+
|
|
8891
|
+
<dl>
|
|
8892
|
+
<dd>
|
|
8893
|
+
|
|
8894
|
+
Lists accounts held by inboxes in the pod, across all apps. Requires `inbox_read`.
|
|
8895
|
+
</dd>
|
|
8896
|
+
</dl>
|
|
8897
|
+
</dd>
|
|
8898
|
+
</dl>
|
|
8899
|
+
|
|
8900
|
+
#### 🔌 Usage
|
|
8901
|
+
|
|
8902
|
+
<dl>
|
|
8903
|
+
<dd>
|
|
8904
|
+
|
|
8905
|
+
<dl>
|
|
8906
|
+
<dd>
|
|
8907
|
+
|
|
8908
|
+
```typescript
|
|
8909
|
+
await client.pods.accounts.list("pod_id");
|
|
8910
|
+
|
|
8911
|
+
```
|
|
8912
|
+
</dd>
|
|
8913
|
+
</dl>
|
|
8914
|
+
</dd>
|
|
8915
|
+
</dl>
|
|
8916
|
+
|
|
8917
|
+
#### ⚙️ Parameters
|
|
8918
|
+
|
|
8919
|
+
<dl>
|
|
8920
|
+
<dd>
|
|
8921
|
+
|
|
8922
|
+
<dl>
|
|
8923
|
+
<dd>
|
|
8924
|
+
|
|
8925
|
+
**pod_id:** `AgentMail.PodId`
|
|
8926
|
+
|
|
8927
|
+
</dd>
|
|
8928
|
+
</dl>
|
|
8929
|
+
|
|
8930
|
+
<dl>
|
|
8931
|
+
<dd>
|
|
8932
|
+
|
|
8933
|
+
**request:** `AgentMail.pods.ListAccountsRequest`
|
|
8934
|
+
|
|
8935
|
+
</dd>
|
|
8936
|
+
</dl>
|
|
8937
|
+
|
|
8938
|
+
<dl>
|
|
8939
|
+
<dd>
|
|
8940
|
+
|
|
8941
|
+
**requestOptions:** `AccountsClient.RequestOptions`
|
|
8942
|
+
|
|
8943
|
+
</dd>
|
|
8944
|
+
</dl>
|
|
8945
|
+
</dd>
|
|
8946
|
+
</dl>
|
|
8947
|
+
|
|
8948
|
+
|
|
8949
|
+
</dd>
|
|
8950
|
+
</dl>
|
|
8951
|
+
</details>
|
|
8952
|
+
|
|
8953
|
+
<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>
|
|
8954
|
+
<dl>
|
|
8955
|
+
<dd>
|
|
8956
|
+
|
|
8957
|
+
#### 📝 Description
|
|
8958
|
+
|
|
8959
|
+
<dl>
|
|
8960
|
+
<dd>
|
|
8961
|
+
|
|
8962
|
+
<dl>
|
|
8963
|
+
<dd>
|
|
8964
|
+
|
|
8965
|
+
Returns one account held by inboxes in the pod. An account elsewhere is a 404. Requires
|
|
8966
|
+
`inbox_read`.
|
|
8967
|
+
</dd>
|
|
8968
|
+
</dl>
|
|
8969
|
+
</dd>
|
|
8970
|
+
</dl>
|
|
8971
|
+
|
|
8972
|
+
#### 🔌 Usage
|
|
8973
|
+
|
|
8974
|
+
<dl>
|
|
8975
|
+
<dd>
|
|
8976
|
+
|
|
8977
|
+
<dl>
|
|
8978
|
+
<dd>
|
|
8979
|
+
|
|
8980
|
+
```typescript
|
|
8981
|
+
await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
8982
|
+
|
|
8983
|
+
```
|
|
8984
|
+
</dd>
|
|
8985
|
+
</dl>
|
|
8986
|
+
</dd>
|
|
8987
|
+
</dl>
|
|
8988
|
+
|
|
8989
|
+
#### ⚙️ Parameters
|
|
8990
|
+
|
|
8991
|
+
<dl>
|
|
8992
|
+
<dd>
|
|
8993
|
+
|
|
8994
|
+
<dl>
|
|
8995
|
+
<dd>
|
|
8996
|
+
|
|
8997
|
+
**pod_id:** `AgentMail.PodId`
|
|
8998
|
+
|
|
8999
|
+
</dd>
|
|
9000
|
+
</dl>
|
|
9001
|
+
|
|
9002
|
+
<dl>
|
|
9003
|
+
<dd>
|
|
9004
|
+
|
|
9005
|
+
**account_id:** `AgentMail.AccountId`
|
|
9006
|
+
|
|
9007
|
+
</dd>
|
|
9008
|
+
</dl>
|
|
9009
|
+
|
|
9010
|
+
<dl>
|
|
9011
|
+
<dd>
|
|
9012
|
+
|
|
9013
|
+
**requestOptions:** `AccountsClient.RequestOptions`
|
|
9014
|
+
|
|
9015
|
+
</dd>
|
|
9016
|
+
</dl>
|
|
9017
|
+
</dd>
|
|
9018
|
+
</dl>
|
|
9019
|
+
|
|
9020
|
+
|
|
9021
|
+
</dd>
|
|
9022
|
+
</dl>
|
|
9023
|
+
</details>
|
|
9024
|
+
|
|
9025
|
+
## Pods ApiKeys
|
|
9026
|
+
<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>
|
|
9027
|
+
<dl>
|
|
9028
|
+
<dd>
|
|
9029
|
+
|
|
9030
|
+
#### 📝 Description
|
|
9031
|
+
|
|
9032
|
+
<dl>
|
|
9033
|
+
<dd>
|
|
9034
|
+
|
|
9035
|
+
<dl>
|
|
9036
|
+
<dd>
|
|
9037
|
+
|
|
9038
|
+
**CLI:**
|
|
9039
|
+
```bash
|
|
9040
|
+
agentmail pods api-keys list --pod-id <pod_id>
|
|
9041
|
+
```
|
|
9042
|
+
</dd>
|
|
9043
|
+
</dl>
|
|
9044
|
+
</dd>
|
|
9045
|
+
</dl>
|
|
9046
|
+
|
|
9047
|
+
#### 🔌 Usage
|
|
9048
|
+
|
|
9049
|
+
<dl>
|
|
9050
|
+
<dd>
|
|
9051
|
+
|
|
9052
|
+
<dl>
|
|
9053
|
+
<dd>
|
|
9054
|
+
|
|
9055
|
+
```typescript
|
|
9056
|
+
await client.pods.apiKeys.list("pod_id");
|
|
9057
|
+
|
|
9058
|
+
```
|
|
9059
|
+
</dd>
|
|
9060
|
+
</dl>
|
|
9061
|
+
</dd>
|
|
9062
|
+
</dl>
|
|
9063
|
+
|
|
9064
|
+
#### ⚙️ Parameters
|
|
9065
|
+
|
|
9066
|
+
<dl>
|
|
9067
|
+
<dd>
|
|
9068
|
+
|
|
8061
9069
|
<dl>
|
|
8062
9070
|
<dd>
|
|
8063
9071
|
|
|
8064
|
-
**
|
|
9072
|
+
**pod_id:** `AgentMail.PodId`
|
|
8065
9073
|
|
|
8066
9074
|
</dd>
|
|
8067
9075
|
</dl>
|
|
@@ -8069,7 +9077,7 @@ await client.lists.create("send", "allow", {
|
|
|
8069
9077
|
<dl>
|
|
8070
9078
|
<dd>
|
|
8071
9079
|
|
|
8072
|
-
**request:** `AgentMail.
|
|
9080
|
+
**request:** `AgentMail.pods.ListApiKeysRequest`
|
|
8073
9081
|
|
|
8074
9082
|
</dd>
|
|
8075
9083
|
</dl>
|
|
@@ -8077,7 +9085,7 @@ await client.lists.create("send", "allow", {
|
|
|
8077
9085
|
<dl>
|
|
8078
9086
|
<dd>
|
|
8079
9087
|
|
|
8080
|
-
**requestOptions:** `
|
|
9088
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
8081
9089
|
|
|
8082
9090
|
</dd>
|
|
8083
9091
|
</dl>
|
|
@@ -8089,7 +9097,7 @@ await client.lists.create("send", "allow", {
|
|
|
8089
9097
|
</dl>
|
|
8090
9098
|
</details>
|
|
8091
9099
|
|
|
8092
|
-
<details><summary><code>client.
|
|
9100
|
+
<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
9101
|
<dl>
|
|
8094
9102
|
<dd>
|
|
8095
9103
|
|
|
@@ -8103,7 +9111,7 @@ await client.lists.create("send", "allow", {
|
|
|
8103
9111
|
|
|
8104
9112
|
**CLI:**
|
|
8105
9113
|
```bash
|
|
8106
|
-
agentmail
|
|
9114
|
+
agentmail pods api-keys create --pod-id <pod_id> --name "My Key"
|
|
8107
9115
|
```
|
|
8108
9116
|
</dd>
|
|
8109
9117
|
</dl>
|
|
@@ -8119,7 +9127,7 @@ agentmail lists delete --direction <direction> --type <type> --entry <entry>
|
|
|
8119
9127
|
<dd>
|
|
8120
9128
|
|
|
8121
9129
|
```typescript
|
|
8122
|
-
await client.
|
|
9130
|
+
await client.pods.apiKeys.create("pod_id", {});
|
|
8123
9131
|
|
|
8124
9132
|
```
|
|
8125
9133
|
</dd>
|
|
@@ -8135,15 +9143,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
8135
9143
|
<dl>
|
|
8136
9144
|
<dd>
|
|
8137
9145
|
|
|
8138
|
-
**
|
|
8139
|
-
|
|
8140
|
-
</dd>
|
|
8141
|
-
</dl>
|
|
8142
|
-
|
|
8143
|
-
<dl>
|
|
8144
|
-
<dd>
|
|
8145
|
-
|
|
8146
|
-
**type:** `AgentMail.ListType`
|
|
9146
|
+
**pod_id:** `AgentMail.PodId`
|
|
8147
9147
|
|
|
8148
9148
|
</dd>
|
|
8149
9149
|
</dl>
|
|
@@ -8151,7 +9151,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
8151
9151
|
<dl>
|
|
8152
9152
|
<dd>
|
|
8153
9153
|
|
|
8154
|
-
**
|
|
9154
|
+
**request:** `AgentMail.CreateApiKeyRequest`
|
|
8155
9155
|
|
|
8156
9156
|
</dd>
|
|
8157
9157
|
</dl>
|
|
@@ -8159,7 +9159,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
8159
9159
|
<dl>
|
|
8160
9160
|
<dd>
|
|
8161
9161
|
|
|
8162
|
-
**requestOptions:** `
|
|
9162
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
8163
9163
|
|
|
8164
9164
|
</dd>
|
|
8165
9165
|
</dl>
|
|
@@ -8171,8 +9171,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
8171
9171
|
</dl>
|
|
8172
9172
|
</details>
|
|
8173
9173
|
|
|
8174
|
-
|
|
8175
|
-
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryEvents</a>({ ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
9174
|
+
<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
9175
|
<dl>
|
|
8177
9176
|
<dd>
|
|
8178
9177
|
|
|
@@ -8184,15 +9183,9 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
8184
9183
|
<dl>
|
|
8185
9184
|
<dd>
|
|
8186
9185
|
|
|
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
9186
|
**CLI:**
|
|
8194
9187
|
```bash
|
|
8195
|
-
agentmail
|
|
9188
|
+
agentmail pods api-keys update --pod-id <pod_id> --api-key-id <api_key_id> --name "Renamed"
|
|
8196
9189
|
```
|
|
8197
9190
|
</dd>
|
|
8198
9191
|
</dl>
|
|
@@ -8208,7 +9201,7 @@ agentmail metrics query-events
|
|
|
8208
9201
|
<dd>
|
|
8209
9202
|
|
|
8210
9203
|
```typescript
|
|
8211
|
-
await client.
|
|
9204
|
+
await client.pods.apiKeys.update("pod_id", "api_key_id", {});
|
|
8212
9205
|
|
|
8213
9206
|
```
|
|
8214
9207
|
</dd>
|
|
@@ -8224,7 +9217,7 @@ await client.metrics.queryEvents();
|
|
|
8224
9217
|
<dl>
|
|
8225
9218
|
<dd>
|
|
8226
9219
|
|
|
8227
|
-
**
|
|
9220
|
+
**pod_id:** `AgentMail.PodId`
|
|
8228
9221
|
|
|
8229
9222
|
</dd>
|
|
8230
9223
|
</dl>
|
|
@@ -8232,7 +9225,23 @@ await client.metrics.queryEvents();
|
|
|
8232
9225
|
<dl>
|
|
8233
9226
|
<dd>
|
|
8234
9227
|
|
|
8235
|
-
**
|
|
9228
|
+
**api_key_id:** `AgentMail.ApiKeyId`
|
|
9229
|
+
|
|
9230
|
+
</dd>
|
|
9231
|
+
</dl>
|
|
9232
|
+
|
|
9233
|
+
<dl>
|
|
9234
|
+
<dd>
|
|
9235
|
+
|
|
9236
|
+
**request:** `AgentMail.UpdateApiKeyRequest`
|
|
9237
|
+
|
|
9238
|
+
</dd>
|
|
9239
|
+
</dl>
|
|
9240
|
+
|
|
9241
|
+
<dl>
|
|
9242
|
+
<dd>
|
|
9243
|
+
|
|
9244
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
8236
9245
|
|
|
8237
9246
|
</dd>
|
|
8238
9247
|
</dl>
|
|
@@ -8244,7 +9253,7 @@ await client.metrics.queryEvents();
|
|
|
8244
9253
|
</dl>
|
|
8245
9254
|
</details>
|
|
8246
9255
|
|
|
8247
|
-
<details><summary><code>client.
|
|
9256
|
+
<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
9257
|
<dl>
|
|
8249
9258
|
<dd>
|
|
8250
9259
|
|
|
@@ -8256,11 +9265,10 @@ await client.metrics.queryEvents();
|
|
|
8256
9265
|
<dl>
|
|
8257
9266
|
<dd>
|
|
8258
9267
|
|
|
8259
|
-
|
|
8260
|
-
|
|
8261
|
-
|
|
8262
|
-
|
|
8263
|
-
`period` must not exceed 1000 buckets.
|
|
9268
|
+
**CLI:**
|
|
9269
|
+
```bash
|
|
9270
|
+
agentmail pods api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
|
|
9271
|
+
```
|
|
8264
9272
|
</dd>
|
|
8265
9273
|
</dl>
|
|
8266
9274
|
</dd>
|
|
@@ -8275,7 +9283,7 @@ bucket. Defaults to the last 24 hours; `start` must be within the last
|
|
|
8275
9283
|
<dd>
|
|
8276
9284
|
|
|
8277
9285
|
```typescript
|
|
8278
|
-
await client.
|
|
9286
|
+
await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
8279
9287
|
|
|
8280
9288
|
```
|
|
8281
9289
|
</dd>
|
|
@@ -8291,7 +9299,7 @@ await client.metrics.queryUsage();
|
|
|
8291
9299
|
<dl>
|
|
8292
9300
|
<dd>
|
|
8293
9301
|
|
|
8294
|
-
**
|
|
9302
|
+
**pod_id:** `AgentMail.PodId`
|
|
8295
9303
|
|
|
8296
9304
|
</dd>
|
|
8297
9305
|
</dl>
|
|
@@ -8299,7 +9307,15 @@ await client.metrics.queryUsage();
|
|
|
8299
9307
|
<dl>
|
|
8300
9308
|
<dd>
|
|
8301
9309
|
|
|
8302
|
-
**
|
|
9310
|
+
**api_key_id:** `AgentMail.ApiKeyId`
|
|
9311
|
+
|
|
9312
|
+
</dd>
|
|
9313
|
+
</dl>
|
|
9314
|
+
|
|
9315
|
+
<dl>
|
|
9316
|
+
<dd>
|
|
9317
|
+
|
|
9318
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
8303
9319
|
|
|
8304
9320
|
</dd>
|
|
8305
9321
|
</dl>
|
|
@@ -8311,7 +9327,8 @@ await client.metrics.queryUsage();
|
|
|
8311
9327
|
</dl>
|
|
8312
9328
|
</details>
|
|
8313
9329
|
|
|
8314
|
-
|
|
9330
|
+
## Pods Domains
|
|
9331
|
+
<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
9332
|
<dl>
|
|
8316
9333
|
<dd>
|
|
8317
9334
|
|
|
@@ -8323,21 +9340,9 @@ await client.metrics.queryUsage();
|
|
|
8323
9340
|
<dl>
|
|
8324
9341
|
<dd>
|
|
8325
9342
|
|
|
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
9343
|
**CLI:**
|
|
8339
9344
|
```bash
|
|
8340
|
-
agentmail
|
|
9345
|
+
agentmail pods domains list --pod-id <pod_id>
|
|
8341
9346
|
```
|
|
8342
9347
|
</dd>
|
|
8343
9348
|
</dl>
|
|
@@ -8353,7 +9358,7 @@ agentmail metrics query-rates
|
|
|
8353
9358
|
<dd>
|
|
8354
9359
|
|
|
8355
9360
|
```typescript
|
|
8356
|
-
await client.
|
|
9361
|
+
await client.pods.domains.list("pod_id");
|
|
8357
9362
|
|
|
8358
9363
|
```
|
|
8359
9364
|
</dd>
|
|
@@ -8369,7 +9374,7 @@ await client.metrics.queryRates();
|
|
|
8369
9374
|
<dl>
|
|
8370
9375
|
<dd>
|
|
8371
9376
|
|
|
8372
|
-
**
|
|
9377
|
+
**pod_id:** `AgentMail.PodId`
|
|
8373
9378
|
|
|
8374
9379
|
</dd>
|
|
8375
9380
|
</dl>
|
|
@@ -8377,7 +9382,15 @@ await client.metrics.queryRates();
|
|
|
8377
9382
|
<dl>
|
|
8378
9383
|
<dd>
|
|
8379
9384
|
|
|
8380
|
-
**
|
|
9385
|
+
**request:** `AgentMail.pods.ListDomainsRequest`
|
|
9386
|
+
|
|
9387
|
+
</dd>
|
|
9388
|
+
</dl>
|
|
9389
|
+
|
|
9390
|
+
<dl>
|
|
9391
|
+
<dd>
|
|
9392
|
+
|
|
9393
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8381
9394
|
|
|
8382
9395
|
</dd>
|
|
8383
9396
|
</dl>
|
|
@@ -8389,8 +9402,7 @@ await client.metrics.queryRates();
|
|
|
8389
9402
|
</dl>
|
|
8390
9403
|
</details>
|
|
8391
9404
|
|
|
8392
|
-
|
|
8393
|
-
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">get</a>() -> AgentMail.Organization</code></summary>
|
|
9405
|
+
<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
9406
|
<dl>
|
|
8395
9407
|
<dd>
|
|
8396
9408
|
|
|
@@ -8402,11 +9414,9 @@ await client.metrics.queryRates();
|
|
|
8402
9414
|
<dl>
|
|
8403
9415
|
<dd>
|
|
8404
9416
|
|
|
8405
|
-
Returns the organization for the authenticated API key (usage limits, counts, and billing metadata).
|
|
8406
|
-
|
|
8407
9417
|
**CLI:**
|
|
8408
9418
|
```bash
|
|
8409
|
-
agentmail
|
|
9419
|
+
agentmail pods domains get --pod-id <pod_id> --domain-id <domain_id>
|
|
8410
9420
|
```
|
|
8411
9421
|
</dd>
|
|
8412
9422
|
</dl>
|
|
@@ -8422,7 +9432,7 @@ agentmail organizations get
|
|
|
8422
9432
|
<dd>
|
|
8423
9433
|
|
|
8424
9434
|
```typescript
|
|
8425
|
-
await client.
|
|
9435
|
+
await client.pods.domains.get("pod_id", "domain_id");
|
|
8426
9436
|
|
|
8427
9437
|
```
|
|
8428
9438
|
</dd>
|
|
@@ -8438,7 +9448,23 @@ await client.organizations.get();
|
|
|
8438
9448
|
<dl>
|
|
8439
9449
|
<dd>
|
|
8440
9450
|
|
|
8441
|
-
**
|
|
9451
|
+
**pod_id:** `AgentMail.PodId`
|
|
9452
|
+
|
|
9453
|
+
</dd>
|
|
9454
|
+
</dl>
|
|
9455
|
+
|
|
9456
|
+
<dl>
|
|
9457
|
+
<dd>
|
|
9458
|
+
|
|
9459
|
+
**domain_id:** `AgentMail.DomainId`
|
|
9460
|
+
|
|
9461
|
+
</dd>
|
|
9462
|
+
</dl>
|
|
9463
|
+
|
|
9464
|
+
<dl>
|
|
9465
|
+
<dd>
|
|
9466
|
+
|
|
9467
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8442
9468
|
|
|
8443
9469
|
</dd>
|
|
8444
9470
|
</dl>
|
|
@@ -8450,8 +9476,7 @@ await client.organizations.get();
|
|
|
8450
9476
|
</dl>
|
|
8451
9477
|
</details>
|
|
8452
9478
|
|
|
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>
|
|
9479
|
+
<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
9480
|
<dl>
|
|
8456
9481
|
<dd>
|
|
8457
9482
|
|
|
@@ -8463,7 +9488,10 @@ await client.organizations.get();
|
|
|
8463
9488
|
<dl>
|
|
8464
9489
|
<dd>
|
|
8465
9490
|
|
|
8466
|
-
|
|
9491
|
+
**CLI:**
|
|
9492
|
+
```bash
|
|
9493
|
+
agentmail pods domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
|
|
9494
|
+
```
|
|
8467
9495
|
</dd>
|
|
8468
9496
|
</dl>
|
|
8469
9497
|
</dd>
|
|
@@ -8478,7 +9506,7 @@ Lists accounts held by inboxes in the pod, across all apps. Requires `inbox_read
|
|
|
8478
9506
|
<dd>
|
|
8479
9507
|
|
|
8480
9508
|
```typescript
|
|
8481
|
-
await client.pods.
|
|
9509
|
+
await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
8482
9510
|
|
|
8483
9511
|
```
|
|
8484
9512
|
</dd>
|
|
@@ -8502,7 +9530,7 @@ await client.pods.accounts.list("pod_id");
|
|
|
8502
9530
|
<dl>
|
|
8503
9531
|
<dd>
|
|
8504
9532
|
|
|
8505
|
-
**
|
|
9533
|
+
**domain_id:** `AgentMail.DomainId`
|
|
8506
9534
|
|
|
8507
9535
|
</dd>
|
|
8508
9536
|
</dl>
|
|
@@ -8510,7 +9538,7 @@ await client.pods.accounts.list("pod_id");
|
|
|
8510
9538
|
<dl>
|
|
8511
9539
|
<dd>
|
|
8512
9540
|
|
|
8513
|
-
**requestOptions:** `
|
|
9541
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8514
9542
|
|
|
8515
9543
|
</dd>
|
|
8516
9544
|
</dl>
|
|
@@ -8522,7 +9550,7 @@ await client.pods.accounts.list("pod_id");
|
|
|
8522
9550
|
</dl>
|
|
8523
9551
|
</details>
|
|
8524
9552
|
|
|
8525
|
-
<details><summary><code>client.pods.
|
|
9553
|
+
<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
9554
|
<dl>
|
|
8527
9555
|
<dd>
|
|
8528
9556
|
|
|
@@ -8534,8 +9562,10 @@ await client.pods.accounts.list("pod_id");
|
|
|
8534
9562
|
<dl>
|
|
8535
9563
|
<dd>
|
|
8536
9564
|
|
|
8537
|
-
|
|
8538
|
-
|
|
9565
|
+
**CLI:**
|
|
9566
|
+
```bash
|
|
9567
|
+
agentmail pods domains create --pod-id <pod_id> --domain example.com
|
|
9568
|
+
```
|
|
8539
9569
|
</dd>
|
|
8540
9570
|
</dl>
|
|
8541
9571
|
</dd>
|
|
@@ -8550,7 +9580,9 @@ Returns one account held by inboxes in the pod. An account elsewhere is a 404. R
|
|
|
8550
9580
|
<dd>
|
|
8551
9581
|
|
|
8552
9582
|
```typescript
|
|
8553
|
-
await client.pods.
|
|
9583
|
+
await client.pods.domains.create("pod_id", {
|
|
9584
|
+
domain: "domain"
|
|
9585
|
+
});
|
|
8554
9586
|
|
|
8555
9587
|
```
|
|
8556
9588
|
</dd>
|
|
@@ -8574,7 +9606,7 @@ await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
|
8574
9606
|
<dl>
|
|
8575
9607
|
<dd>
|
|
8576
9608
|
|
|
8577
|
-
**
|
|
9609
|
+
**request:** `AgentMail.CreateDomainRequest`
|
|
8578
9610
|
|
|
8579
9611
|
</dd>
|
|
8580
9612
|
</dl>
|
|
@@ -8582,7 +9614,7 @@ await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
|
8582
9614
|
<dl>
|
|
8583
9615
|
<dd>
|
|
8584
9616
|
|
|
8585
|
-
**requestOptions:** `
|
|
9617
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8586
9618
|
|
|
8587
9619
|
</dd>
|
|
8588
9620
|
</dl>
|
|
@@ -8594,8 +9626,7 @@ await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
|
8594
9626
|
</dl>
|
|
8595
9627
|
</details>
|
|
8596
9628
|
|
|
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>
|
|
9629
|
+
<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
9630
|
<dl>
|
|
8600
9631
|
<dd>
|
|
8601
9632
|
|
|
@@ -8609,7 +9640,7 @@ await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
|
8609
9640
|
|
|
8610
9641
|
**CLI:**
|
|
8611
9642
|
```bash
|
|
8612
|
-
agentmail pods
|
|
9643
|
+
agentmail pods domains update --pod-id <pod_id> --domain-id <domain_id>
|
|
8613
9644
|
```
|
|
8614
9645
|
</dd>
|
|
8615
9646
|
</dl>
|
|
@@ -8625,7 +9656,7 @@ agentmail pods api-keys list --pod-id <pod_id>
|
|
|
8625
9656
|
<dd>
|
|
8626
9657
|
|
|
8627
9658
|
```typescript
|
|
8628
|
-
await client.pods.
|
|
9659
|
+
await client.pods.domains.update("pod_id", "domain_id", {});
|
|
8629
9660
|
|
|
8630
9661
|
```
|
|
8631
9662
|
</dd>
|
|
@@ -8649,7 +9680,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
8649
9680
|
<dl>
|
|
8650
9681
|
<dd>
|
|
8651
9682
|
|
|
8652
|
-
**
|
|
9683
|
+
**domain_id:** `AgentMail.DomainId`
|
|
8653
9684
|
|
|
8654
9685
|
</dd>
|
|
8655
9686
|
</dl>
|
|
@@ -8657,7 +9688,15 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
8657
9688
|
<dl>
|
|
8658
9689
|
<dd>
|
|
8659
9690
|
|
|
8660
|
-
**
|
|
9691
|
+
**request:** `AgentMail.UpdateDomainRequest`
|
|
9692
|
+
|
|
9693
|
+
</dd>
|
|
9694
|
+
</dl>
|
|
9695
|
+
|
|
9696
|
+
<dl>
|
|
9697
|
+
<dd>
|
|
9698
|
+
|
|
9699
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8661
9700
|
|
|
8662
9701
|
</dd>
|
|
8663
9702
|
</dl>
|
|
@@ -8669,7 +9708,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
8669
9708
|
</dl>
|
|
8670
9709
|
</details>
|
|
8671
9710
|
|
|
8672
|
-
<details><summary><code>client.pods.
|
|
9711
|
+
<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
9712
|
<dl>
|
|
8674
9713
|
<dd>
|
|
8675
9714
|
|
|
@@ -8683,7 +9722,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
8683
9722
|
|
|
8684
9723
|
**CLI:**
|
|
8685
9724
|
```bash
|
|
8686
|
-
agentmail pods
|
|
9725
|
+
agentmail pods domains delete --pod-id <pod_id> --domain-id <domain_id>
|
|
8687
9726
|
```
|
|
8688
9727
|
</dd>
|
|
8689
9728
|
</dl>
|
|
@@ -8699,7 +9738,7 @@ agentmail pods api-keys create --pod-id <pod_id> --name "My Key"
|
|
|
8699
9738
|
<dd>
|
|
8700
9739
|
|
|
8701
9740
|
```typescript
|
|
8702
|
-
await client.pods.
|
|
9741
|
+
await client.pods.domains.delete("pod_id", "domain_id");
|
|
8703
9742
|
|
|
8704
9743
|
```
|
|
8705
9744
|
</dd>
|
|
@@ -8723,7 +9762,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
8723
9762
|
<dl>
|
|
8724
9763
|
<dd>
|
|
8725
9764
|
|
|
8726
|
-
**
|
|
9765
|
+
**domain_id:** `AgentMail.DomainId`
|
|
8727
9766
|
|
|
8728
9767
|
</dd>
|
|
8729
9768
|
</dl>
|
|
@@ -8731,7 +9770,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
8731
9770
|
<dl>
|
|
8732
9771
|
<dd>
|
|
8733
9772
|
|
|
8734
|
-
**requestOptions:** `
|
|
9773
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8735
9774
|
|
|
8736
9775
|
</dd>
|
|
8737
9776
|
</dl>
|
|
@@ -8743,7 +9782,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
8743
9782
|
</dl>
|
|
8744
9783
|
</details>
|
|
8745
9784
|
|
|
8746
|
-
<details><summary><code>client.pods.
|
|
9785
|
+
<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
9786
|
<dl>
|
|
8748
9787
|
<dd>
|
|
8749
9788
|
|
|
@@ -8757,7 +9796,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
8757
9796
|
|
|
8758
9797
|
**CLI:**
|
|
8759
9798
|
```bash
|
|
8760
|
-
agentmail pods
|
|
9799
|
+
agentmail pods domains verify --pod-id <pod_id> --domain-id <domain_id>
|
|
8761
9800
|
```
|
|
8762
9801
|
</dd>
|
|
8763
9802
|
</dl>
|
|
@@ -8773,7 +9812,7 @@ agentmail pods api-keys update --pod-id <pod_id> --api-key-id <api_key_id> --nam
|
|
|
8773
9812
|
<dd>
|
|
8774
9813
|
|
|
8775
9814
|
```typescript
|
|
8776
|
-
await client.pods.
|
|
9815
|
+
await client.pods.domains.verify("pod_id", "domain_id");
|
|
8777
9816
|
|
|
8778
9817
|
```
|
|
8779
9818
|
</dd>
|
|
@@ -8797,15 +9836,7 @@ await client.pods.apiKeys.update("pod_id", "api_key_id", {});
|
|
|
8797
9836
|
<dl>
|
|
8798
9837
|
<dd>
|
|
8799
9838
|
|
|
8800
|
-
**
|
|
8801
|
-
|
|
8802
|
-
</dd>
|
|
8803
|
-
</dl>
|
|
8804
|
-
|
|
8805
|
-
<dl>
|
|
8806
|
-
<dd>
|
|
8807
|
-
|
|
8808
|
-
**request:** `AgentMail.UpdateApiKeyRequest`
|
|
9839
|
+
**domain_id:** `AgentMail.DomainId`
|
|
8809
9840
|
|
|
8810
9841
|
</dd>
|
|
8811
9842
|
</dl>
|
|
@@ -8813,7 +9844,7 @@ await client.pods.apiKeys.update("pod_id", "api_key_id", {});
|
|
|
8813
9844
|
<dl>
|
|
8814
9845
|
<dd>
|
|
8815
9846
|
|
|
8816
|
-
**requestOptions:** `
|
|
9847
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
8817
9848
|
|
|
8818
9849
|
</dd>
|
|
8819
9850
|
</dl>
|
|
@@ -8825,7 +9856,8 @@ await client.pods.apiKeys.update("pod_id", "api_key_id", {});
|
|
|
8825
9856
|
</dl>
|
|
8826
9857
|
</details>
|
|
8827
9858
|
|
|
8828
|
-
|
|
9859
|
+
## Pods Drafts
|
|
9860
|
+
<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
9861
|
<dl>
|
|
8830
9862
|
<dd>
|
|
8831
9863
|
|
|
@@ -8839,7 +9871,7 @@ await client.pods.apiKeys.update("pod_id", "api_key_id", {});
|
|
|
8839
9871
|
|
|
8840
9872
|
**CLI:**
|
|
8841
9873
|
```bash
|
|
8842
|
-
agentmail pods
|
|
9874
|
+
agentmail pods drafts list --pod-id <pod_id>
|
|
8843
9875
|
```
|
|
8844
9876
|
</dd>
|
|
8845
9877
|
</dl>
|
|
@@ -8855,7 +9887,7 @@ agentmail pods api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
|
|
|
8855
9887
|
<dd>
|
|
8856
9888
|
|
|
8857
9889
|
```typescript
|
|
8858
|
-
await client.pods.
|
|
9890
|
+
await client.pods.drafts.list("pod_id");
|
|
8859
9891
|
|
|
8860
9892
|
```
|
|
8861
9893
|
</dd>
|
|
@@ -8879,7 +9911,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
8879
9911
|
<dl>
|
|
8880
9912
|
<dd>
|
|
8881
9913
|
|
|
8882
|
-
**
|
|
9914
|
+
**request:** `AgentMail.pods.ListDraftsRequest`
|
|
8883
9915
|
|
|
8884
9916
|
</dd>
|
|
8885
9917
|
</dl>
|
|
@@ -8887,7 +9919,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
8887
9919
|
<dl>
|
|
8888
9920
|
<dd>
|
|
8889
9921
|
|
|
8890
|
-
**requestOptions:** `
|
|
9922
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
8891
9923
|
|
|
8892
9924
|
</dd>
|
|
8893
9925
|
</dl>
|
|
@@ -8899,8 +9931,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
8899
9931
|
</dl>
|
|
8900
9932
|
</details>
|
|
8901
9933
|
|
|
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>
|
|
9934
|
+
<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
9935
|
<dl>
|
|
8905
9936
|
<dd>
|
|
8906
9937
|
|
|
@@ -8914,7 +9945,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
8914
9945
|
|
|
8915
9946
|
**CLI:**
|
|
8916
9947
|
```bash
|
|
8917
|
-
agentmail pods
|
|
9948
|
+
agentmail pods drafts get --pod-id <pod_id> --draft-id <draft_id>
|
|
8918
9949
|
```
|
|
8919
9950
|
</dd>
|
|
8920
9951
|
</dl>
|
|
@@ -8930,7 +9961,7 @@ agentmail pods domains list --pod-id <pod_id>
|
|
|
8930
9961
|
<dd>
|
|
8931
9962
|
|
|
8932
9963
|
```typescript
|
|
8933
|
-
await client.pods.
|
|
9964
|
+
await client.pods.drafts.get("pod_id", "draft_id");
|
|
8934
9965
|
|
|
8935
9966
|
```
|
|
8936
9967
|
</dd>
|
|
@@ -8954,7 +9985,7 @@ await client.pods.domains.list("pod_id");
|
|
|
8954
9985
|
<dl>
|
|
8955
9986
|
<dd>
|
|
8956
9987
|
|
|
8957
|
-
**
|
|
9988
|
+
**draft_id:** `AgentMail.DraftId`
|
|
8958
9989
|
|
|
8959
9990
|
</dd>
|
|
8960
9991
|
</dl>
|
|
@@ -8962,7 +9993,7 @@ await client.pods.domains.list("pod_id");
|
|
|
8962
9993
|
<dl>
|
|
8963
9994
|
<dd>
|
|
8964
9995
|
|
|
8965
|
-
**requestOptions:** `
|
|
9996
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
8966
9997
|
|
|
8967
9998
|
</dd>
|
|
8968
9999
|
</dl>
|
|
@@ -8974,7 +10005,7 @@ await client.pods.domains.list("pod_id");
|
|
|
8974
10005
|
</dl>
|
|
8975
10006
|
</details>
|
|
8976
10007
|
|
|
8977
|
-
<details><summary><code>client.pods.
|
|
10008
|
+
<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
10009
|
<dl>
|
|
8979
10010
|
<dd>
|
|
8980
10011
|
|
|
@@ -8988,7 +10019,7 @@ await client.pods.domains.list("pod_id");
|
|
|
8988
10019
|
|
|
8989
10020
|
**CLI:**
|
|
8990
10021
|
```bash
|
|
8991
|
-
agentmail pods
|
|
10022
|
+
agentmail pods drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --attachment-id <attachment_id>
|
|
8992
10023
|
```
|
|
8993
10024
|
</dd>
|
|
8994
10025
|
</dl>
|
|
@@ -9004,7 +10035,7 @@ agentmail pods domains get --pod-id <pod_id> --domain-id <domain_id>
|
|
|
9004
10035
|
<dd>
|
|
9005
10036
|
|
|
9006
10037
|
```typescript
|
|
9007
|
-
await client.pods.
|
|
10038
|
+
await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
9008
10039
|
|
|
9009
10040
|
```
|
|
9010
10041
|
</dd>
|
|
@@ -9020,7 +10051,15 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
9020
10051
|
<dl>
|
|
9021
10052
|
<dd>
|
|
9022
10053
|
|
|
9023
|
-
**pod_id:** `AgentMail.PodId`
|
|
10054
|
+
**pod_id:** `AgentMail.PodId`
|
|
10055
|
+
|
|
10056
|
+
</dd>
|
|
10057
|
+
</dl>
|
|
10058
|
+
|
|
10059
|
+
<dl>
|
|
10060
|
+
<dd>
|
|
10061
|
+
|
|
10062
|
+
**draft_id:** `AgentMail.DraftId`
|
|
9024
10063
|
|
|
9025
10064
|
</dd>
|
|
9026
10065
|
</dl>
|
|
@@ -9028,7 +10067,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
9028
10067
|
<dl>
|
|
9029
10068
|
<dd>
|
|
9030
10069
|
|
|
9031
|
-
**
|
|
10070
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
9032
10071
|
|
|
9033
10072
|
</dd>
|
|
9034
10073
|
</dl>
|
|
@@ -9036,7 +10075,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
9036
10075
|
<dl>
|
|
9037
10076
|
<dd>
|
|
9038
10077
|
|
|
9039
|
-
**requestOptions:** `
|
|
10078
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
9040
10079
|
|
|
9041
10080
|
</dd>
|
|
9042
10081
|
</dl>
|
|
@@ -9048,7 +10087,8 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
9048
10087
|
</dl>
|
|
9049
10088
|
</details>
|
|
9050
10089
|
|
|
9051
|
-
|
|
10090
|
+
## Pods Inboxes
|
|
10091
|
+
<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
10092
|
<dl>
|
|
9053
10093
|
<dd>
|
|
9054
10094
|
|
|
@@ -9062,7 +10102,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
9062
10102
|
|
|
9063
10103
|
**CLI:**
|
|
9064
10104
|
```bash
|
|
9065
|
-
agentmail pods
|
|
10105
|
+
agentmail pods inboxes list --pod-id <pod_id>
|
|
9066
10106
|
```
|
|
9067
10107
|
</dd>
|
|
9068
10108
|
</dl>
|
|
@@ -9078,7 +10118,7 @@ agentmail pods domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
|
|
|
9078
10118
|
<dd>
|
|
9079
10119
|
|
|
9080
10120
|
```typescript
|
|
9081
|
-
await client.pods.
|
|
10121
|
+
await client.pods.inboxes.list("pod_id");
|
|
9082
10122
|
|
|
9083
10123
|
```
|
|
9084
10124
|
</dd>
|
|
@@ -9102,7 +10142,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
9102
10142
|
<dl>
|
|
9103
10143
|
<dd>
|
|
9104
10144
|
|
|
9105
|
-
**
|
|
10145
|
+
**request:** `AgentMail.pods.ListInboxesRequest`
|
|
9106
10146
|
|
|
9107
10147
|
</dd>
|
|
9108
10148
|
</dl>
|
|
@@ -9110,7 +10150,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
9110
10150
|
<dl>
|
|
9111
10151
|
<dd>
|
|
9112
10152
|
|
|
9113
|
-
**requestOptions:** `
|
|
10153
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9114
10154
|
|
|
9115
10155
|
</dd>
|
|
9116
10156
|
</dl>
|
|
@@ -9122,7 +10162,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
9122
10162
|
</dl>
|
|
9123
10163
|
</details>
|
|
9124
10164
|
|
|
9125
|
-
<details><summary><code>client.pods.
|
|
10165
|
+
<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
10166
|
<dl>
|
|
9127
10167
|
<dd>
|
|
9128
10168
|
|
|
@@ -9134,10 +10174,12 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
9134
10174
|
<dl>
|
|
9135
10175
|
<dd>
|
|
9136
10176
|
|
|
9137
|
-
|
|
9138
|
-
|
|
9139
|
-
|
|
9140
|
-
|
|
10177
|
+
Searches inboxes in the pod by address or display name, ranked by
|
|
10178
|
+
relevance. Each word in the query matches the start of a word in the
|
|
10179
|
+
address or display name, so `sup` matches `support@example.com` but
|
|
10180
|
+
`port` does not. An exact address match always ranks first. `limit`
|
|
10181
|
+
cannot exceed 100. A page can be empty and still carry a
|
|
10182
|
+
`next_page_token`; keep paging until the token is absent.
|
|
9141
10183
|
</dd>
|
|
9142
10184
|
</dl>
|
|
9143
10185
|
</dd>
|
|
@@ -9152,8 +10194,8 @@ agentmail pods domains create --pod-id <pod_id> --domain example.com
|
|
|
9152
10194
|
<dd>
|
|
9153
10195
|
|
|
9154
10196
|
```typescript
|
|
9155
|
-
await client.pods.
|
|
9156
|
-
|
|
10197
|
+
await client.pods.inboxes.search("pod_id", {
|
|
10198
|
+
q: "q"
|
|
9157
10199
|
});
|
|
9158
10200
|
|
|
9159
10201
|
```
|
|
@@ -9178,7 +10220,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
9178
10220
|
<dl>
|
|
9179
10221
|
<dd>
|
|
9180
10222
|
|
|
9181
|
-
**request:** `AgentMail.
|
|
10223
|
+
**request:** `AgentMail.pods.SearchInboxesRequest`
|
|
9182
10224
|
|
|
9183
10225
|
</dd>
|
|
9184
10226
|
</dl>
|
|
@@ -9186,7 +10228,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
9186
10228
|
<dl>
|
|
9187
10229
|
<dd>
|
|
9188
10230
|
|
|
9189
|
-
**requestOptions:** `
|
|
10231
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9190
10232
|
|
|
9191
10233
|
</dd>
|
|
9192
10234
|
</dl>
|
|
@@ -9198,7 +10240,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
9198
10240
|
</dl>
|
|
9199
10241
|
</details>
|
|
9200
10242
|
|
|
9201
|
-
<details><summary><code>client.pods.
|
|
10243
|
+
<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
10244
|
<dl>
|
|
9203
10245
|
<dd>
|
|
9204
10246
|
|
|
@@ -9212,7 +10254,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
9212
10254
|
|
|
9213
10255
|
**CLI:**
|
|
9214
10256
|
```bash
|
|
9215
|
-
agentmail pods
|
|
10257
|
+
agentmail pods inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
|
|
9216
10258
|
```
|
|
9217
10259
|
</dd>
|
|
9218
10260
|
</dl>
|
|
@@ -9228,7 +10270,7 @@ agentmail pods domains update --pod-id <pod_id> --domain-id <domain_id>
|
|
|
9228
10270
|
<dd>
|
|
9229
10271
|
|
|
9230
10272
|
```typescript
|
|
9231
|
-
await client.pods.
|
|
10273
|
+
await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
9232
10274
|
|
|
9233
10275
|
```
|
|
9234
10276
|
</dd>
|
|
@@ -9252,15 +10294,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
9252
10294
|
<dl>
|
|
9253
10295
|
<dd>
|
|
9254
10296
|
|
|
9255
|
-
**
|
|
9256
|
-
|
|
9257
|
-
</dd>
|
|
9258
|
-
</dl>
|
|
9259
|
-
|
|
9260
|
-
<dl>
|
|
9261
|
-
<dd>
|
|
9262
|
-
|
|
9263
|
-
**request:** `AgentMail.UpdateDomainRequest`
|
|
10297
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
9264
10298
|
|
|
9265
10299
|
</dd>
|
|
9266
10300
|
</dl>
|
|
@@ -9268,7 +10302,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
9268
10302
|
<dl>
|
|
9269
10303
|
<dd>
|
|
9270
10304
|
|
|
9271
|
-
**requestOptions:** `
|
|
10305
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9272
10306
|
|
|
9273
10307
|
</dd>
|
|
9274
10308
|
</dl>
|
|
@@ -9280,7 +10314,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
9280
10314
|
</dl>
|
|
9281
10315
|
</details>
|
|
9282
10316
|
|
|
9283
|
-
<details><summary><code>client.pods.
|
|
10317
|
+
<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
10318
|
<dl>
|
|
9285
10319
|
<dd>
|
|
9286
10320
|
|
|
@@ -9294,7 +10328,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
9294
10328
|
|
|
9295
10329
|
**CLI:**
|
|
9296
10330
|
```bash
|
|
9297
|
-
agentmail pods
|
|
10331
|
+
agentmail pods inboxes create --pod-id <pod_id> --username myagent --domain example.com
|
|
9298
10332
|
```
|
|
9299
10333
|
</dd>
|
|
9300
10334
|
</dl>
|
|
@@ -9310,7 +10344,7 @@ agentmail pods domains delete --pod-id <pod_id> --domain-id <domain_id>
|
|
|
9310
10344
|
<dd>
|
|
9311
10345
|
|
|
9312
10346
|
```typescript
|
|
9313
|
-
await client.pods.
|
|
10347
|
+
await client.pods.inboxes.create("pod_id", {});
|
|
9314
10348
|
|
|
9315
10349
|
```
|
|
9316
10350
|
</dd>
|
|
@@ -9334,7 +10368,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
9334
10368
|
<dl>
|
|
9335
10369
|
<dd>
|
|
9336
10370
|
|
|
9337
|
-
**
|
|
10371
|
+
**request:** `AgentMail.CreateInboxRequest`
|
|
9338
10372
|
|
|
9339
10373
|
</dd>
|
|
9340
10374
|
</dl>
|
|
@@ -9342,7 +10376,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
9342
10376
|
<dl>
|
|
9343
10377
|
<dd>
|
|
9344
10378
|
|
|
9345
|
-
**requestOptions:** `
|
|
10379
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9346
10380
|
|
|
9347
10381
|
</dd>
|
|
9348
10382
|
</dl>
|
|
@@ -9354,7 +10388,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
9354
10388
|
</dl>
|
|
9355
10389
|
</details>
|
|
9356
10390
|
|
|
9357
|
-
<details><summary><code>client.pods.
|
|
10391
|
+
<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
10392
|
<dl>
|
|
9359
10393
|
<dd>
|
|
9360
10394
|
|
|
@@ -9368,7 +10402,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
9368
10402
|
|
|
9369
10403
|
**CLI:**
|
|
9370
10404
|
```bash
|
|
9371
|
-
agentmail pods
|
|
10405
|
+
agentmail pods inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
|
|
9372
10406
|
```
|
|
9373
10407
|
</dd>
|
|
9374
10408
|
</dl>
|
|
@@ -9384,7 +10418,7 @@ agentmail pods domains verify --pod-id <pod_id> --domain-id <domain_id>
|
|
|
9384
10418
|
<dd>
|
|
9385
10419
|
|
|
9386
10420
|
```typescript
|
|
9387
|
-
await client.pods.
|
|
10421
|
+
await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
9388
10422
|
|
|
9389
10423
|
```
|
|
9390
10424
|
</dd>
|
|
@@ -9408,7 +10442,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
9408
10442
|
<dl>
|
|
9409
10443
|
<dd>
|
|
9410
10444
|
|
|
9411
|
-
**
|
|
10445
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
9412
10446
|
|
|
9413
10447
|
</dd>
|
|
9414
10448
|
</dl>
|
|
@@ -9416,7 +10450,15 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
9416
10450
|
<dl>
|
|
9417
10451
|
<dd>
|
|
9418
10452
|
|
|
9419
|
-
**
|
|
10453
|
+
**request:** `AgentMail.UpdateInboxRequest`
|
|
10454
|
+
|
|
10455
|
+
</dd>
|
|
10456
|
+
</dl>
|
|
10457
|
+
|
|
10458
|
+
<dl>
|
|
10459
|
+
<dd>
|
|
10460
|
+
|
|
10461
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9420
10462
|
|
|
9421
10463
|
</dd>
|
|
9422
10464
|
</dl>
|
|
@@ -9428,8 +10470,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
9428
10470
|
</dl>
|
|
9429
10471
|
</details>
|
|
9430
10472
|
|
|
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>
|
|
10473
|
+
<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
10474
|
<dl>
|
|
9434
10475
|
<dd>
|
|
9435
10476
|
|
|
@@ -9443,7 +10484,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
9443
10484
|
|
|
9444
10485
|
**CLI:**
|
|
9445
10486
|
```bash
|
|
9446
|
-
agentmail pods
|
|
10487
|
+
agentmail pods inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>
|
|
9447
10488
|
```
|
|
9448
10489
|
</dd>
|
|
9449
10490
|
</dl>
|
|
@@ -9459,7 +10500,7 @@ agentmail pods drafts list --pod-id <pod_id>
|
|
|
9459
10500
|
<dd>
|
|
9460
10501
|
|
|
9461
10502
|
```typescript
|
|
9462
|
-
await client.pods.
|
|
10503
|
+
await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
9463
10504
|
|
|
9464
10505
|
```
|
|
9465
10506
|
</dd>
|
|
@@ -9483,7 +10524,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
9483
10524
|
<dl>
|
|
9484
10525
|
<dd>
|
|
9485
10526
|
|
|
9486
|
-
**
|
|
10527
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
9487
10528
|
|
|
9488
10529
|
</dd>
|
|
9489
10530
|
</dl>
|
|
@@ -9491,7 +10532,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
9491
10532
|
<dl>
|
|
9492
10533
|
<dd>
|
|
9493
10534
|
|
|
9494
|
-
**requestOptions:** `
|
|
10535
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
9495
10536
|
|
|
9496
10537
|
</dd>
|
|
9497
10538
|
</dl>
|
|
@@ -9503,7 +10544,8 @@ await client.pods.drafts.list("pod_id");
|
|
|
9503
10544
|
</dl>
|
|
9504
10545
|
</details>
|
|
9505
10546
|
|
|
9506
|
-
|
|
10547
|
+
## Pods Lists
|
|
10548
|
+
<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
10549
|
<dl>
|
|
9508
10550
|
<dd>
|
|
9509
10551
|
|
|
@@ -9517,7 +10559,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
9517
10559
|
|
|
9518
10560
|
**CLI:**
|
|
9519
10561
|
```bash
|
|
9520
|
-
agentmail pods
|
|
10562
|
+
agentmail pods lists list --pod-id <pod_id> --direction <direction> --type <type>
|
|
9521
10563
|
```
|
|
9522
10564
|
</dd>
|
|
9523
10565
|
</dl>
|
|
@@ -9533,7 +10575,7 @@ agentmail pods drafts get --pod-id <pod_id> --draft-id <draft_id>
|
|
|
9533
10575
|
<dd>
|
|
9534
10576
|
|
|
9535
10577
|
```typescript
|
|
9536
|
-
await client.pods.
|
|
10578
|
+
await client.pods.lists.list("pod_id", "send", "allow");
|
|
9537
10579
|
|
|
9538
10580
|
```
|
|
9539
10581
|
</dd>
|
|
@@ -9557,7 +10599,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
9557
10599
|
<dl>
|
|
9558
10600
|
<dd>
|
|
9559
10601
|
|
|
9560
|
-
**
|
|
10602
|
+
**direction:** `AgentMail.Direction`
|
|
9561
10603
|
|
|
9562
10604
|
</dd>
|
|
9563
10605
|
</dl>
|
|
@@ -9565,7 +10607,23 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
9565
10607
|
<dl>
|
|
9566
10608
|
<dd>
|
|
9567
10609
|
|
|
9568
|
-
**
|
|
10610
|
+
**type:** `AgentMail.ListType`
|
|
10611
|
+
|
|
10612
|
+
</dd>
|
|
10613
|
+
</dl>
|
|
10614
|
+
|
|
10615
|
+
<dl>
|
|
10616
|
+
<dd>
|
|
10617
|
+
|
|
10618
|
+
**request:** `AgentMail.pods.ListListEntriesRequest`
|
|
10619
|
+
|
|
10620
|
+
</dd>
|
|
10621
|
+
</dl>
|
|
10622
|
+
|
|
10623
|
+
<dl>
|
|
10624
|
+
<dd>
|
|
10625
|
+
|
|
10626
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
9569
10627
|
|
|
9570
10628
|
</dd>
|
|
9571
10629
|
</dl>
|
|
@@ -9577,7 +10635,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
9577
10635
|
</dl>
|
|
9578
10636
|
</details>
|
|
9579
10637
|
|
|
9580
|
-
<details><summary><code>client.pods.
|
|
10638
|
+
<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
10639
|
<dl>
|
|
9582
10640
|
<dd>
|
|
9583
10641
|
|
|
@@ -9591,7 +10649,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
9591
10649
|
|
|
9592
10650
|
**CLI:**
|
|
9593
10651
|
```bash
|
|
9594
|
-
agentmail pods
|
|
10652
|
+
agentmail pods lists get --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
9595
10653
|
```
|
|
9596
10654
|
</dd>
|
|
9597
10655
|
</dl>
|
|
@@ -9607,7 +10665,7 @@ agentmail pods drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --a
|
|
|
9607
10665
|
<dd>
|
|
9608
10666
|
|
|
9609
10667
|
```typescript
|
|
9610
|
-
await client.pods.
|
|
10668
|
+
await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
9611
10669
|
|
|
9612
10670
|
```
|
|
9613
10671
|
</dd>
|
|
@@ -9631,7 +10689,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
9631
10689
|
<dl>
|
|
9632
10690
|
<dd>
|
|
9633
10691
|
|
|
9634
|
-
**
|
|
10692
|
+
**direction:** `AgentMail.Direction`
|
|
9635
10693
|
|
|
9636
10694
|
</dd>
|
|
9637
10695
|
</dl>
|
|
@@ -9639,7 +10697,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
9639
10697
|
<dl>
|
|
9640
10698
|
<dd>
|
|
9641
10699
|
|
|
9642
|
-
**
|
|
10700
|
+
**type:** `AgentMail.ListType`
|
|
9643
10701
|
|
|
9644
10702
|
</dd>
|
|
9645
10703
|
</dl>
|
|
@@ -9647,7 +10705,15 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
9647
10705
|
<dl>
|
|
9648
10706
|
<dd>
|
|
9649
10707
|
|
|
9650
|
-
**
|
|
10708
|
+
**entry:** `string` — Email address or domain.
|
|
10709
|
+
|
|
10710
|
+
</dd>
|
|
10711
|
+
</dl>
|
|
10712
|
+
|
|
10713
|
+
<dl>
|
|
10714
|
+
<dd>
|
|
10715
|
+
|
|
10716
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
9651
10717
|
|
|
9652
10718
|
</dd>
|
|
9653
10719
|
</dl>
|
|
@@ -9659,8 +10725,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
9659
10725
|
</dl>
|
|
9660
10726
|
</details>
|
|
9661
10727
|
|
|
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>
|
|
10728
|
+
<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
10729
|
<dl>
|
|
9665
10730
|
<dd>
|
|
9666
10731
|
|
|
@@ -9674,7 +10739,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
9674
10739
|
|
|
9675
10740
|
**CLI:**
|
|
9676
10741
|
```bash
|
|
9677
|
-
agentmail pods
|
|
10742
|
+
agentmail pods lists create --pod-id <pod_id> --direction <direction> --type <type> --entry user@example.com
|
|
9678
10743
|
```
|
|
9679
10744
|
</dd>
|
|
9680
10745
|
</dl>
|
|
@@ -9690,7 +10755,9 @@ agentmail pods inboxes list --pod-id <pod_id>
|
|
|
9690
10755
|
<dd>
|
|
9691
10756
|
|
|
9692
10757
|
```typescript
|
|
9693
|
-
await client.pods.
|
|
10758
|
+
await client.pods.lists.create("pod_id", "send", "allow", {
|
|
10759
|
+
entry: "entry"
|
|
10760
|
+
});
|
|
9694
10761
|
|
|
9695
10762
|
```
|
|
9696
10763
|
</dd>
|
|
@@ -9714,7 +10781,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
9714
10781
|
<dl>
|
|
9715
10782
|
<dd>
|
|
9716
10783
|
|
|
9717
|
-
**
|
|
10784
|
+
**direction:** `AgentMail.Direction`
|
|
9718
10785
|
|
|
9719
10786
|
</dd>
|
|
9720
10787
|
</dl>
|
|
@@ -9722,7 +10789,23 @@ await client.pods.inboxes.list("pod_id");
|
|
|
9722
10789
|
<dl>
|
|
9723
10790
|
<dd>
|
|
9724
10791
|
|
|
9725
|
-
**
|
|
10792
|
+
**type:** `AgentMail.ListType`
|
|
10793
|
+
|
|
10794
|
+
</dd>
|
|
10795
|
+
</dl>
|
|
10796
|
+
|
|
10797
|
+
<dl>
|
|
10798
|
+
<dd>
|
|
10799
|
+
|
|
10800
|
+
**request:** `AgentMail.CreateListEntryRequest`
|
|
10801
|
+
|
|
10802
|
+
</dd>
|
|
10803
|
+
</dl>
|
|
10804
|
+
|
|
10805
|
+
<dl>
|
|
10806
|
+
<dd>
|
|
10807
|
+
|
|
10808
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
9726
10809
|
|
|
9727
10810
|
</dd>
|
|
9728
10811
|
</dl>
|
|
@@ -9734,7 +10817,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
9734
10817
|
</dl>
|
|
9735
10818
|
</details>
|
|
9736
10819
|
|
|
9737
|
-
<details><summary><code>client.pods.
|
|
10820
|
+
<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
10821
|
<dl>
|
|
9739
10822
|
<dd>
|
|
9740
10823
|
|
|
@@ -9746,12 +10829,10 @@ await client.pods.inboxes.list("pod_id");
|
|
|
9746
10829
|
<dl>
|
|
9747
10830
|
<dd>
|
|
9748
10831
|
|
|
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.
|
|
10832
|
+
**CLI:**
|
|
10833
|
+
```bash
|
|
10834
|
+
agentmail pods lists delete --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
10835
|
+
```
|
|
9755
10836
|
</dd>
|
|
9756
10837
|
</dl>
|
|
9757
10838
|
</dd>
|
|
@@ -9766,9 +10847,7 @@ cannot exceed 100. A page can be empty and still carry a
|
|
|
9766
10847
|
<dd>
|
|
9767
10848
|
|
|
9768
10849
|
```typescript
|
|
9769
|
-
await client.pods.
|
|
9770
|
-
q: "q"
|
|
9771
|
-
});
|
|
10850
|
+
await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
9772
10851
|
|
|
9773
10852
|
```
|
|
9774
10853
|
</dd>
|
|
@@ -9792,7 +10871,7 @@ await client.pods.inboxes.search("pod_id", {
|
|
|
9792
10871
|
<dl>
|
|
9793
10872
|
<dd>
|
|
9794
10873
|
|
|
9795
|
-
**
|
|
10874
|
+
**direction:** `AgentMail.Direction`
|
|
9796
10875
|
|
|
9797
10876
|
</dd>
|
|
9798
10877
|
</dl>
|
|
@@ -9800,7 +10879,23 @@ await client.pods.inboxes.search("pod_id", {
|
|
|
9800
10879
|
<dl>
|
|
9801
10880
|
<dd>
|
|
9802
10881
|
|
|
9803
|
-
**
|
|
10882
|
+
**type:** `AgentMail.ListType`
|
|
10883
|
+
|
|
10884
|
+
</dd>
|
|
10885
|
+
</dl>
|
|
10886
|
+
|
|
10887
|
+
<dl>
|
|
10888
|
+
<dd>
|
|
10889
|
+
|
|
10890
|
+
**entry:** `string` — Email address or domain.
|
|
10891
|
+
|
|
10892
|
+
</dd>
|
|
10893
|
+
</dl>
|
|
10894
|
+
|
|
10895
|
+
<dl>
|
|
10896
|
+
<dd>
|
|
10897
|
+
|
|
10898
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
9804
10899
|
|
|
9805
10900
|
</dd>
|
|
9806
10901
|
</dl>
|
|
@@ -9812,7 +10907,8 @@ await client.pods.inboxes.search("pod_id", {
|
|
|
9812
10907
|
</dl>
|
|
9813
10908
|
</details>
|
|
9814
10909
|
|
|
9815
|
-
|
|
10910
|
+
## Pods Metrics
|
|
10911
|
+
<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
10912
|
<dl>
|
|
9817
10913
|
<dd>
|
|
9818
10914
|
|
|
@@ -9824,9 +10920,15 @@ await client.pods.inboxes.search("pod_id", {
|
|
|
9824
10920
|
<dl>
|
|
9825
10921
|
<dd>
|
|
9826
10922
|
|
|
10923
|
+
Counts of email events (sent, delivered, bounced, etc.) over time for
|
|
10924
|
+
the pod. Defaults to the last 24 hours; `start` must be within the last
|
|
10925
|
+
90 days, and a future `end` is clamped to now. Omit `period` for
|
|
10926
|
+
individual event counts, or set it to sum counts into buckets of that
|
|
10927
|
+
many seconds.
|
|
10928
|
+
|
|
9827
10929
|
**CLI:**
|
|
9828
10930
|
```bash
|
|
9829
|
-
agentmail pods
|
|
10931
|
+
agentmail pods metrics query-events --pod-id <pod_id>
|
|
9830
10932
|
```
|
|
9831
10933
|
</dd>
|
|
9832
10934
|
</dl>
|
|
@@ -9842,7 +10944,7 @@ agentmail pods inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
9842
10944
|
<dd>
|
|
9843
10945
|
|
|
9844
10946
|
```typescript
|
|
9845
|
-
await client.pods.
|
|
10947
|
+
await client.pods.metrics.queryEvents("pod_id");
|
|
9846
10948
|
|
|
9847
10949
|
```
|
|
9848
10950
|
</dd>
|
|
@@ -9866,7 +10968,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
9866
10968
|
<dl>
|
|
9867
10969
|
<dd>
|
|
9868
10970
|
|
|
9869
|
-
**
|
|
10971
|
+
**request:** `AgentMail.pods.QueryEventsRequest`
|
|
9870
10972
|
|
|
9871
10973
|
</dd>
|
|
9872
10974
|
</dl>
|
|
@@ -9874,7 +10976,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
9874
10976
|
<dl>
|
|
9875
10977
|
<dd>
|
|
9876
10978
|
|
|
9877
|
-
**requestOptions:** `
|
|
10979
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
9878
10980
|
|
|
9879
10981
|
</dd>
|
|
9880
10982
|
</dl>
|
|
@@ -9886,7 +10988,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
9886
10988
|
</dl>
|
|
9887
10989
|
</details>
|
|
9888
10990
|
|
|
9889
|
-
<details><summary><code>client.pods.
|
|
10991
|
+
<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
10992
|
<dl>
|
|
9891
10993
|
<dd>
|
|
9892
10994
|
|
|
@@ -9898,10 +11000,13 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
9898
11000
|
<dl>
|
|
9899
11001
|
<dd>
|
|
9900
11002
|
|
|
9901
|
-
|
|
9902
|
-
|
|
9903
|
-
|
|
9904
|
-
|
|
11003
|
+
Cumulative usage series for the pod. Each point is the running total of
|
|
11004
|
+
the usage type at that timestamp, not the change within the bucket.
|
|
11005
|
+
Pod-scoped queries carry every usage type except `pod_count`; requested
|
|
11006
|
+
types that don't apply to the scope are ignored. Defaults to the last
|
|
11007
|
+
24 hours; `start` must be within the last 90 days, and a future `end`
|
|
11008
|
+
is clamped to now. The range divided by `period` must not exceed 1000
|
|
11009
|
+
buckets.
|
|
9905
11010
|
</dd>
|
|
9906
11011
|
</dl>
|
|
9907
11012
|
</dd>
|
|
@@ -9916,7 +11021,7 @@ agentmail pods inboxes create --pod-id <pod_id> --username myagent --domain exam
|
|
|
9916
11021
|
<dd>
|
|
9917
11022
|
|
|
9918
11023
|
```typescript
|
|
9919
|
-
await client.pods.
|
|
11024
|
+
await client.pods.metrics.queryUsage("pod_id");
|
|
9920
11025
|
|
|
9921
11026
|
```
|
|
9922
11027
|
</dd>
|
|
@@ -9940,7 +11045,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
9940
11045
|
<dl>
|
|
9941
11046
|
<dd>
|
|
9942
11047
|
|
|
9943
|
-
**request:** `AgentMail.
|
|
11048
|
+
**request:** `AgentMail.pods.QueryUsageRequest`
|
|
9944
11049
|
|
|
9945
11050
|
</dd>
|
|
9946
11051
|
</dl>
|
|
@@ -9948,7 +11053,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
9948
11053
|
<dl>
|
|
9949
11054
|
<dd>
|
|
9950
11055
|
|
|
9951
|
-
**requestOptions:** `
|
|
11056
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
9952
11057
|
|
|
9953
11058
|
</dd>
|
|
9954
11059
|
</dl>
|
|
@@ -9960,7 +11065,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
9960
11065
|
</dl>
|
|
9961
11066
|
</details>
|
|
9962
11067
|
|
|
9963
|
-
<details><summary><code>client.pods.
|
|
11068
|
+
<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
11069
|
<dl>
|
|
9965
11070
|
<dd>
|
|
9966
11071
|
|
|
@@ -9972,9 +11077,20 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
9972
11077
|
<dl>
|
|
9973
11078
|
<dd>
|
|
9974
11079
|
|
|
11080
|
+
Rolling bounce and complaint rates for the pod. At each `period` grid
|
|
11081
|
+
point, the bounced (or complained) messages over the preceding
|
|
11082
|
+
`window` divided by the messages sent over the same window, with the
|
|
11083
|
+
send count alongside. Account moderation evaluates the organization-wide
|
|
11084
|
+
rate, so use the organization endpoint to see the number it acts on;
|
|
11085
|
+
the pod view shows which pods contribute. Defaults to the rolling
|
|
11086
|
+
24-hour rate sampled hourly over the last day; `start` must be within
|
|
11087
|
+
the last 90 days, `window` must be a whole multiple of `period`, and
|
|
11088
|
+
the range plus window divided by `period` must not exceed 1000
|
|
11089
|
+
buckets.
|
|
11090
|
+
|
|
9975
11091
|
**CLI:**
|
|
9976
11092
|
```bash
|
|
9977
|
-
agentmail pods
|
|
11093
|
+
agentmail pods metrics query-rates --pod-id <pod_id>
|
|
9978
11094
|
```
|
|
9979
11095
|
</dd>
|
|
9980
11096
|
</dl>
|
|
@@ -9990,7 +11106,7 @@ agentmail pods inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
9990
11106
|
<dd>
|
|
9991
11107
|
|
|
9992
11108
|
```typescript
|
|
9993
|
-
await client.pods.
|
|
11109
|
+
await client.pods.metrics.queryRates("pod_id");
|
|
9994
11110
|
|
|
9995
11111
|
```
|
|
9996
11112
|
</dd>
|
|
@@ -10014,15 +11130,7 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
10014
11130
|
<dl>
|
|
10015
11131
|
<dd>
|
|
10016
11132
|
|
|
10017
|
-
**
|
|
10018
|
-
|
|
10019
|
-
</dd>
|
|
10020
|
-
</dl>
|
|
10021
|
-
|
|
10022
|
-
<dl>
|
|
10023
|
-
<dd>
|
|
10024
|
-
|
|
10025
|
-
**request:** `AgentMail.UpdateInboxRequest`
|
|
11133
|
+
**request:** `AgentMail.pods.QueryRatesRequest`
|
|
10026
11134
|
|
|
10027
11135
|
</dd>
|
|
10028
11136
|
</dl>
|
|
@@ -10030,7 +11138,7 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
10030
11138
|
<dl>
|
|
10031
11139
|
<dd>
|
|
10032
11140
|
|
|
10033
|
-
**requestOptions:** `
|
|
11141
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
10034
11142
|
|
|
10035
11143
|
</dd>
|
|
10036
11144
|
</dl>
|
|
@@ -10042,7 +11150,8 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
10042
11150
|
</dl>
|
|
10043
11151
|
</details>
|
|
10044
11152
|
|
|
10045
|
-
|
|
11153
|
+
## Pods Threads
|
|
11154
|
+
<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
11155
|
<dl>
|
|
10047
11156
|
<dd>
|
|
10048
11157
|
|
|
@@ -10054,9 +11163,14 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
10054
11163
|
<dl>
|
|
10055
11164
|
<dd>
|
|
10056
11165
|
|
|
11166
|
+
Lists threads in the pod, most recent first. Pass `senders`,
|
|
11167
|
+
`recipients`, or `subject` to filter by substring. Filtered requests are
|
|
11168
|
+
served by search, which caps `limit` at 100. For relevance-ranked
|
|
11169
|
+
full-text search, use `Search Threads`.
|
|
11170
|
+
|
|
10057
11171
|
**CLI:**
|
|
10058
11172
|
```bash
|
|
10059
|
-
agentmail pods
|
|
11173
|
+
agentmail pods threads list --pod-id <pod_id>
|
|
10060
11174
|
```
|
|
10061
11175
|
</dd>
|
|
10062
11176
|
</dl>
|
|
@@ -10072,7 +11186,7 @@ agentmail pods inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
10072
11186
|
<dd>
|
|
10073
11187
|
|
|
10074
11188
|
```typescript
|
|
10075
|
-
await client.pods.
|
|
11189
|
+
await client.pods.threads.list("pod_id");
|
|
10076
11190
|
|
|
10077
11191
|
```
|
|
10078
11192
|
</dd>
|
|
@@ -10096,7 +11210,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
10096
11210
|
<dl>
|
|
10097
11211
|
<dd>
|
|
10098
11212
|
|
|
10099
|
-
**
|
|
11213
|
+
**request:** `AgentMail.pods.ListThreadsRequest`
|
|
10100
11214
|
|
|
10101
11215
|
</dd>
|
|
10102
11216
|
</dl>
|
|
@@ -10104,7 +11218,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
10104
11218
|
<dl>
|
|
10105
11219
|
<dd>
|
|
10106
11220
|
|
|
10107
|
-
**requestOptions:** `
|
|
11221
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10108
11222
|
|
|
10109
11223
|
</dd>
|
|
10110
11224
|
</dl>
|
|
@@ -10116,8 +11230,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
10116
11230
|
</dl>
|
|
10117
11231
|
</details>
|
|
10118
11232
|
|
|
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>
|
|
11233
|
+
<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
11234
|
<dl>
|
|
10122
11235
|
<dd>
|
|
10123
11236
|
|
|
@@ -10129,10 +11242,10 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
10129
11242
|
<dl>
|
|
10130
11243
|
<dd>
|
|
10131
11244
|
|
|
10132
|
-
|
|
10133
|
-
|
|
10134
|
-
|
|
10135
|
-
|
|
11245
|
+
Full-text search across threads in the pod, ranked by relevance. The
|
|
11246
|
+
query is matched against senders, recipients, and subject (substring)
|
|
11247
|
+
and the message body (tokenized full text). Spam, trash, blocked, and
|
|
11248
|
+
unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
10136
11249
|
</dd>
|
|
10137
11250
|
</dl>
|
|
10138
11251
|
</dd>
|
|
@@ -10147,7 +11260,9 @@ agentmail pods lists list --pod-id <pod_id> --direction <direction> --type <type
|
|
|
10147
11260
|
<dd>
|
|
10148
11261
|
|
|
10149
11262
|
```typescript
|
|
10150
|
-
await client.pods.
|
|
11263
|
+
await client.pods.threads.search("pod_id", {
|
|
11264
|
+
q: "q"
|
|
11265
|
+
});
|
|
10151
11266
|
|
|
10152
11267
|
```
|
|
10153
11268
|
</dd>
|
|
@@ -10171,23 +11286,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
10171
11286
|
<dl>
|
|
10172
11287
|
<dd>
|
|
10173
11288
|
|
|
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`
|
|
11289
|
+
**request:** `AgentMail.pods.SearchThreadsRequest`
|
|
10191
11290
|
|
|
10192
11291
|
</dd>
|
|
10193
11292
|
</dl>
|
|
@@ -10195,7 +11294,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
10195
11294
|
<dl>
|
|
10196
11295
|
<dd>
|
|
10197
11296
|
|
|
10198
|
-
**requestOptions:** `
|
|
11297
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10199
11298
|
|
|
10200
11299
|
</dd>
|
|
10201
11300
|
</dl>
|
|
@@ -10207,7 +11306,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
10207
11306
|
</dl>
|
|
10208
11307
|
</details>
|
|
10209
11308
|
|
|
10210
|
-
<details><summary><code>client.pods.
|
|
11309
|
+
<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
11310
|
<dl>
|
|
10212
11311
|
<dd>
|
|
10213
11312
|
|
|
@@ -10221,7 +11320,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
10221
11320
|
|
|
10222
11321
|
**CLI:**
|
|
10223
11322
|
```bash
|
|
10224
|
-
agentmail pods
|
|
11323
|
+
agentmail pods threads get --pod-id <pod_id> --thread-id <thread_id>
|
|
10225
11324
|
```
|
|
10226
11325
|
</dd>
|
|
10227
11326
|
</dl>
|
|
@@ -10237,7 +11336,7 @@ agentmail pods lists get --pod-id <pod_id> --direction <direction> --type <type>
|
|
|
10237
11336
|
<dd>
|
|
10238
11337
|
|
|
10239
11338
|
```typescript
|
|
10240
|
-
await client.pods.
|
|
11339
|
+
await client.pods.threads.get("pod_id", "thread_id");
|
|
10241
11340
|
|
|
10242
11341
|
```
|
|
10243
11342
|
</dd>
|
|
@@ -10261,15 +11360,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
10261
11360
|
<dl>
|
|
10262
11361
|
<dd>
|
|
10263
11362
|
|
|
10264
|
-
**
|
|
10265
|
-
|
|
10266
|
-
</dd>
|
|
10267
|
-
</dl>
|
|
10268
|
-
|
|
10269
|
-
<dl>
|
|
10270
|
-
<dd>
|
|
10271
|
-
|
|
10272
|
-
**type:** `AgentMail.ListType`
|
|
11363
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
10273
11364
|
|
|
10274
11365
|
</dd>
|
|
10275
11366
|
</dl>
|
|
@@ -10277,7 +11368,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
10277
11368
|
<dl>
|
|
10278
11369
|
<dd>
|
|
10279
11370
|
|
|
10280
|
-
**
|
|
11371
|
+
**request:** `AgentMail.pods.GetPodThreadRequest`
|
|
10281
11372
|
|
|
10282
11373
|
</dd>
|
|
10283
11374
|
</dl>
|
|
@@ -10285,7 +11376,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
10285
11376
|
<dl>
|
|
10286
11377
|
<dd>
|
|
10287
11378
|
|
|
10288
|
-
**requestOptions:** `
|
|
11379
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10289
11380
|
|
|
10290
11381
|
</dd>
|
|
10291
11382
|
</dl>
|
|
@@ -10297,7 +11388,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
10297
11388
|
</dl>
|
|
10298
11389
|
</details>
|
|
10299
11390
|
|
|
10300
|
-
<details><summary><code>client.pods.
|
|
11391
|
+
<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
11392
|
<dl>
|
|
10302
11393
|
<dd>
|
|
10303
11394
|
|
|
@@ -10311,7 +11402,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
10311
11402
|
|
|
10312
11403
|
**CLI:**
|
|
10313
11404
|
```bash
|
|
10314
|
-
agentmail pods
|
|
11405
|
+
agentmail pods threads get-attachment --pod-id <pod_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
10315
11406
|
```
|
|
10316
11407
|
</dd>
|
|
10317
11408
|
</dl>
|
|
@@ -10327,9 +11418,7 @@ agentmail pods lists create --pod-id <pod_id> --direction <direction> --type <ty
|
|
|
10327
11418
|
<dd>
|
|
10328
11419
|
|
|
10329
11420
|
```typescript
|
|
10330
|
-
await client.pods.
|
|
10331
|
-
entry: "entry"
|
|
10332
|
-
});
|
|
11421
|
+
await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
10333
11422
|
|
|
10334
11423
|
```
|
|
10335
11424
|
</dd>
|
|
@@ -10353,15 +11442,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
10353
11442
|
<dl>
|
|
10354
11443
|
<dd>
|
|
10355
11444
|
|
|
10356
|
-
**
|
|
10357
|
-
|
|
10358
|
-
</dd>
|
|
10359
|
-
</dl>
|
|
10360
|
-
|
|
10361
|
-
<dl>
|
|
10362
|
-
<dd>
|
|
10363
|
-
|
|
10364
|
-
**type:** `AgentMail.ListType`
|
|
11445
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
10365
11446
|
|
|
10366
11447
|
</dd>
|
|
10367
11448
|
</dl>
|
|
@@ -10369,7 +11450,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
10369
11450
|
<dl>
|
|
10370
11451
|
<dd>
|
|
10371
11452
|
|
|
10372
|
-
**
|
|
11453
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
10373
11454
|
|
|
10374
11455
|
</dd>
|
|
10375
11456
|
</dl>
|
|
@@ -10377,7 +11458,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
10377
11458
|
<dl>
|
|
10378
11459
|
<dd>
|
|
10379
11460
|
|
|
10380
|
-
**requestOptions:** `
|
|
11461
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10381
11462
|
|
|
10382
11463
|
</dd>
|
|
10383
11464
|
</dl>
|
|
@@ -10389,7 +11470,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
10389
11470
|
</dl>
|
|
10390
11471
|
</details>
|
|
10391
11472
|
|
|
10392
|
-
<details><summary><code>client.pods.
|
|
11473
|
+
<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
11474
|
<dl>
|
|
10394
11475
|
<dd>
|
|
10395
11476
|
|
|
@@ -10401,10 +11482,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
10401
11482
|
<dl>
|
|
10402
11483
|
<dd>
|
|
10403
11484
|
|
|
10404
|
-
|
|
10405
|
-
```bash
|
|
10406
|
-
agentmail pods lists delete --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
10407
|
-
```
|
|
11485
|
+
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
11486
|
</dd>
|
|
10409
11487
|
</dl>
|
|
10410
11488
|
</dd>
|
|
@@ -10419,7 +11497,7 @@ agentmail pods lists delete --pod-id <pod_id> --direction <direction> --type <ty
|
|
|
10419
11497
|
<dd>
|
|
10420
11498
|
|
|
10421
11499
|
```typescript
|
|
10422
|
-
await client.pods.
|
|
11500
|
+
await client.pods.threads.update("pod_id", "thread_id", {});
|
|
10423
11501
|
|
|
10424
11502
|
```
|
|
10425
11503
|
</dd>
|
|
@@ -10443,15 +11521,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
10443
11521
|
<dl>
|
|
10444
11522
|
<dd>
|
|
10445
11523
|
|
|
10446
|
-
**
|
|
10447
|
-
|
|
10448
|
-
</dd>
|
|
10449
|
-
</dl>
|
|
10450
|
-
|
|
10451
|
-
<dl>
|
|
10452
|
-
<dd>
|
|
10453
|
-
|
|
10454
|
-
**type:** `AgentMail.ListType`
|
|
11524
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
10455
11525
|
|
|
10456
11526
|
</dd>
|
|
10457
11527
|
</dl>
|
|
@@ -10459,7 +11529,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
10459
11529
|
<dl>
|
|
10460
11530
|
<dd>
|
|
10461
11531
|
|
|
10462
|
-
**
|
|
11532
|
+
**request:** `AgentMail.UpdateThreadRequest`
|
|
10463
11533
|
|
|
10464
11534
|
</dd>
|
|
10465
11535
|
</dl>
|
|
@@ -10467,7 +11537,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
10467
11537
|
<dl>
|
|
10468
11538
|
<dd>
|
|
10469
11539
|
|
|
10470
|
-
**requestOptions:** `
|
|
11540
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10471
11541
|
|
|
10472
11542
|
</dd>
|
|
10473
11543
|
</dl>
|
|
@@ -10479,8 +11549,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
10479
11549
|
</dl>
|
|
10480
11550
|
</details>
|
|
10481
11551
|
|
|
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>
|
|
11552
|
+
<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
11553
|
<dl>
|
|
10485
11554
|
<dd>
|
|
10486
11555
|
|
|
@@ -10492,15 +11561,11 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
10492
11561
|
<dl>
|
|
10493
11562
|
<dd>
|
|
10494
11563
|
|
|
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.
|
|
11564
|
+
Permanently deletes a thread and all of its messages.
|
|
10500
11565
|
|
|
10501
11566
|
**CLI:**
|
|
10502
11567
|
```bash
|
|
10503
|
-
agentmail pods
|
|
11568
|
+
agentmail pods threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
10504
11569
|
```
|
|
10505
11570
|
</dd>
|
|
10506
11571
|
</dl>
|
|
@@ -10516,7 +11581,7 @@ agentmail pods metrics query-events --pod-id <pod_id>
|
|
|
10516
11581
|
<dd>
|
|
10517
11582
|
|
|
10518
11583
|
```typescript
|
|
10519
|
-
await client.pods.
|
|
11584
|
+
await client.pods.threads.delete("pod_id", "thread_id");
|
|
10520
11585
|
|
|
10521
11586
|
```
|
|
10522
11587
|
</dd>
|
|
@@ -10540,7 +11605,7 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
10540
11605
|
<dl>
|
|
10541
11606
|
<dd>
|
|
10542
11607
|
|
|
10543
|
-
**
|
|
11608
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
10544
11609
|
|
|
10545
11610
|
</dd>
|
|
10546
11611
|
</dl>
|
|
@@ -10548,7 +11613,7 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
10548
11613
|
<dl>
|
|
10549
11614
|
<dd>
|
|
10550
11615
|
|
|
10551
|
-
**requestOptions:** `
|
|
11616
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
10552
11617
|
|
|
10553
11618
|
</dd>
|
|
10554
11619
|
</dl>
|
|
@@ -10560,7 +11625,8 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
10560
11625
|
</dl>
|
|
10561
11626
|
</details>
|
|
10562
11627
|
|
|
10563
|
-
|
|
11628
|
+
## Pods Webhooks
|
|
11629
|
+
<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
11630
|
<dl>
|
|
10565
11631
|
<dd>
|
|
10566
11632
|
|
|
@@ -10572,13 +11638,10 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
10572
11638
|
<dl>
|
|
10573
11639
|
<dd>
|
|
10574
11640
|
|
|
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.
|
|
11641
|
+
**CLI:**
|
|
11642
|
+
```bash
|
|
11643
|
+
agentmail pods webhooks list --pod-id <pod_id>
|
|
11644
|
+
```
|
|
10582
11645
|
</dd>
|
|
10583
11646
|
</dl>
|
|
10584
11647
|
</dd>
|
|
@@ -10593,7 +11656,7 @@ buckets.
|
|
|
10593
11656
|
<dd>
|
|
10594
11657
|
|
|
10595
11658
|
```typescript
|
|
10596
|
-
await client.pods.
|
|
11659
|
+
await client.pods.webhooks.list("pod_id");
|
|
10597
11660
|
|
|
10598
11661
|
```
|
|
10599
11662
|
</dd>
|
|
@@ -10617,7 +11680,7 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
10617
11680
|
<dl>
|
|
10618
11681
|
<dd>
|
|
10619
11682
|
|
|
10620
|
-
**request:** `AgentMail.pods.
|
|
11683
|
+
**request:** `AgentMail.pods.PodListWebhooksRequest`
|
|
10621
11684
|
|
|
10622
11685
|
</dd>
|
|
10623
11686
|
</dl>
|
|
@@ -10625,7 +11688,7 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
10625
11688
|
<dl>
|
|
10626
11689
|
<dd>
|
|
10627
11690
|
|
|
10628
|
-
**requestOptions:** `
|
|
11691
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
10629
11692
|
|
|
10630
11693
|
</dd>
|
|
10631
11694
|
</dl>
|
|
@@ -10637,7 +11700,7 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
10637
11700
|
</dl>
|
|
10638
11701
|
</details>
|
|
10639
11702
|
|
|
10640
|
-
<details><summary><code>client.pods.
|
|
11703
|
+
<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
11704
|
<dl>
|
|
10642
11705
|
<dd>
|
|
10643
11706
|
|
|
@@ -10649,20 +11712,9 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
10649
11712
|
<dl>
|
|
10650
11713
|
<dd>
|
|
10651
11714
|
|
|
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
11715
|
**CLI:**
|
|
10664
11716
|
```bash
|
|
10665
|
-
agentmail pods
|
|
11717
|
+
agentmail pods webhooks get --pod-id <pod_id> --webhook-id <webhook_id>
|
|
10666
11718
|
```
|
|
10667
11719
|
</dd>
|
|
10668
11720
|
</dl>
|
|
@@ -10678,7 +11730,7 @@ agentmail pods metrics query-rates --pod-id <pod_id>
|
|
|
10678
11730
|
<dd>
|
|
10679
11731
|
|
|
10680
11732
|
```typescript
|
|
10681
|
-
await client.pods.
|
|
11733
|
+
await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
10682
11734
|
|
|
10683
11735
|
```
|
|
10684
11736
|
</dd>
|
|
@@ -10702,7 +11754,7 @@ await client.pods.metrics.queryRates("pod_id");
|
|
|
10702
11754
|
<dl>
|
|
10703
11755
|
<dd>
|
|
10704
11756
|
|
|
10705
|
-
**
|
|
11757
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
10706
11758
|
|
|
10707
11759
|
</dd>
|
|
10708
11760
|
</dl>
|
|
@@ -10710,7 +11762,7 @@ await client.pods.metrics.queryRates("pod_id");
|
|
|
10710
11762
|
<dl>
|
|
10711
11763
|
<dd>
|
|
10712
11764
|
|
|
10713
|
-
**requestOptions:** `
|
|
11765
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
10714
11766
|
|
|
10715
11767
|
</dd>
|
|
10716
11768
|
</dl>
|
|
@@ -10722,8 +11774,7 @@ await client.pods.metrics.queryRates("pod_id");
|
|
|
10722
11774
|
</dl>
|
|
10723
11775
|
</details>
|
|
10724
11776
|
|
|
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>
|
|
11777
|
+
<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
11778
|
<dl>
|
|
10728
11779
|
<dd>
|
|
10729
11780
|
|
|
@@ -10735,15 +11786,8 @@ await client.pods.metrics.queryRates("pod_id");
|
|
|
10735
11786
|
<dl>
|
|
10736
11787
|
<dd>
|
|
10737
11788
|
|
|
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
|
-
```
|
|
11789
|
+
List the names of custom HTTP headers included with deliveries to this pod-scoped webhook.
|
|
11790
|
+
Header values are write-only and are never returned.
|
|
10747
11791
|
</dd>
|
|
10748
11792
|
</dl>
|
|
10749
11793
|
</dd>
|
|
@@ -10758,7 +11802,7 @@ agentmail pods threads list --pod-id <pod_id>
|
|
|
10758
11802
|
<dd>
|
|
10759
11803
|
|
|
10760
11804
|
```typescript
|
|
10761
|
-
await client.pods.
|
|
11805
|
+
await client.pods.webhooks.getHeaders("pod_id", "webhook_id");
|
|
10762
11806
|
|
|
10763
11807
|
```
|
|
10764
11808
|
</dd>
|
|
@@ -10782,7 +11826,7 @@ await client.pods.threads.list("pod_id");
|
|
|
10782
11826
|
<dl>
|
|
10783
11827
|
<dd>
|
|
10784
11828
|
|
|
10785
|
-
**
|
|
11829
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
10786
11830
|
|
|
10787
11831
|
</dd>
|
|
10788
11832
|
</dl>
|
|
@@ -10790,7 +11834,7 @@ await client.pods.threads.list("pod_id");
|
|
|
10790
11834
|
<dl>
|
|
10791
11835
|
<dd>
|
|
10792
11836
|
|
|
10793
|
-
**requestOptions:** `
|
|
11837
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
10794
11838
|
|
|
10795
11839
|
</dd>
|
|
10796
11840
|
</dl>
|
|
@@ -10802,7 +11846,7 @@ await client.pods.threads.list("pod_id");
|
|
|
10802
11846
|
</dl>
|
|
10803
11847
|
</details>
|
|
10804
11848
|
|
|
10805
|
-
<details><summary><code>client.pods.
|
|
11849
|
+
<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
11850
|
<dl>
|
|
10807
11851
|
<dd>
|
|
10808
11852
|
|
|
@@ -10814,10 +11858,12 @@ await client.pods.threads.list("pod_id");
|
|
|
10814
11858
|
<dl>
|
|
10815
11859
|
<dd>
|
|
10816
11860
|
|
|
10817
|
-
|
|
10818
|
-
|
|
10819
|
-
|
|
10820
|
-
|
|
11861
|
+
Create a webhook scoped to this pod.
|
|
11862
|
+
|
|
11863
|
+
**CLI:**
|
|
11864
|
+
```bash
|
|
11865
|
+
agentmail pods webhooks create --pod-id <pod_id> --url https://example.com/webhook --event-types message.received
|
|
11866
|
+
```
|
|
10821
11867
|
</dd>
|
|
10822
11868
|
</dl>
|
|
10823
11869
|
</dd>
|
|
@@ -10832,8 +11878,9 @@ unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
|
10832
11878
|
<dd>
|
|
10833
11879
|
|
|
10834
11880
|
```typescript
|
|
10835
|
-
await client.pods.
|
|
10836
|
-
|
|
11881
|
+
await client.pods.webhooks.create("pod_id", {
|
|
11882
|
+
url: "url",
|
|
11883
|
+
eventTypes: ["message.received", "message.received"]
|
|
10837
11884
|
});
|
|
10838
11885
|
|
|
10839
11886
|
```
|
|
@@ -10858,7 +11905,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
10858
11905
|
<dl>
|
|
10859
11906
|
<dd>
|
|
10860
11907
|
|
|
10861
|
-
**request:** `AgentMail.
|
|
11908
|
+
**request:** `AgentMail.CreatePodWebhookRequest`
|
|
10862
11909
|
|
|
10863
11910
|
</dd>
|
|
10864
11911
|
</dl>
|
|
@@ -10866,7 +11913,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
10866
11913
|
<dl>
|
|
10867
11914
|
<dd>
|
|
10868
11915
|
|
|
10869
|
-
**requestOptions:** `
|
|
11916
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
10870
11917
|
|
|
10871
11918
|
</dd>
|
|
10872
11919
|
</dl>
|
|
@@ -10878,7 +11925,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
10878
11925
|
</dl>
|
|
10879
11926
|
</details>
|
|
10880
11927
|
|
|
10881
|
-
<details><summary><code>client.pods.
|
|
11928
|
+
<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
11929
|
<dl>
|
|
10883
11930
|
<dd>
|
|
10884
11931
|
|
|
@@ -10892,7 +11939,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
10892
11939
|
|
|
10893
11940
|
**CLI:**
|
|
10894
11941
|
```bash
|
|
10895
|
-
agentmail pods
|
|
11942
|
+
agentmail pods webhooks update --pod-id <pod_id> --webhook-id <webhook_id> --add-inbox-ids <inbox_id>
|
|
10896
11943
|
```
|
|
10897
11944
|
</dd>
|
|
10898
11945
|
</dl>
|
|
@@ -10908,7 +11955,7 @@ agentmail pods threads get --pod-id <pod_id> --thread-id <thread_id>
|
|
|
10908
11955
|
<dd>
|
|
10909
11956
|
|
|
10910
11957
|
```typescript
|
|
10911
|
-
await client.pods.
|
|
11958
|
+
await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
10912
11959
|
|
|
10913
11960
|
```
|
|
10914
11961
|
</dd>
|
|
@@ -10932,7 +11979,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
10932
11979
|
<dl>
|
|
10933
11980
|
<dd>
|
|
10934
11981
|
|
|
10935
|
-
**
|
|
11982
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
10936
11983
|
|
|
10937
11984
|
</dd>
|
|
10938
11985
|
</dl>
|
|
@@ -10940,7 +11987,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
10940
11987
|
<dl>
|
|
10941
11988
|
<dd>
|
|
10942
11989
|
|
|
10943
|
-
**request:** `AgentMail.
|
|
11990
|
+
**request:** `AgentMail.UpdatePodWebhookRequest`
|
|
10944
11991
|
|
|
10945
11992
|
</dd>
|
|
10946
11993
|
</dl>
|
|
@@ -10948,7 +11995,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
10948
11995
|
<dl>
|
|
10949
11996
|
<dd>
|
|
10950
11997
|
|
|
10951
|
-
**requestOptions:** `
|
|
11998
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
10952
11999
|
|
|
10953
12000
|
</dd>
|
|
10954
12001
|
</dl>
|
|
@@ -10960,7 +12007,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
10960
12007
|
</dl>
|
|
10961
12008
|
</details>
|
|
10962
12009
|
|
|
10963
|
-
<details><summary><code>client.pods.
|
|
12010
|
+
<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
12011
|
<dl>
|
|
10965
12012
|
<dd>
|
|
10966
12013
|
|
|
@@ -10972,10 +12019,8 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
10972
12019
|
<dl>
|
|
10973
12020
|
<dd>
|
|
10974
12021
|
|
|
10975
|
-
|
|
10976
|
-
|
|
10977
|
-
agentmail pods threads get-attachment --pod-id <pod_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
10978
|
-
```
|
|
12022
|
+
Atomically set, replace, or remove custom HTTP headers included with deliveries to this
|
|
12023
|
+
pod-scoped webhook. Header values remain write-only.
|
|
10979
12024
|
</dd>
|
|
10980
12025
|
</dl>
|
|
10981
12026
|
</dd>
|
|
@@ -10990,7 +12035,7 @@ agentmail pods threads get-attachment --pod-id <pod_id> --thread-id <thread_id>
|
|
|
10990
12035
|
<dd>
|
|
10991
12036
|
|
|
10992
12037
|
```typescript
|
|
10993
|
-
await client.pods.
|
|
12038
|
+
await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
10994
12039
|
|
|
10995
12040
|
```
|
|
10996
12041
|
</dd>
|
|
@@ -11014,7 +12059,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
11014
12059
|
<dl>
|
|
11015
12060
|
<dd>
|
|
11016
12061
|
|
|
11017
|
-
**
|
|
12062
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
11018
12063
|
|
|
11019
12064
|
</dd>
|
|
11020
12065
|
</dl>
|
|
@@ -11022,7 +12067,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
11022
12067
|
<dl>
|
|
11023
12068
|
<dd>
|
|
11024
12069
|
|
|
11025
|
-
**
|
|
12070
|
+
**request:** `AgentMail.UpdateWebhookHeadersRequest`
|
|
11026
12071
|
|
|
11027
12072
|
</dd>
|
|
11028
12073
|
</dl>
|
|
@@ -11030,7 +12075,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
11030
12075
|
<dl>
|
|
11031
12076
|
<dd>
|
|
11032
12077
|
|
|
11033
|
-
**requestOptions:** `
|
|
12078
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
11034
12079
|
|
|
11035
12080
|
</dd>
|
|
11036
12081
|
</dl>
|
|
@@ -11042,7 +12087,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
11042
12087
|
</dl>
|
|
11043
12088
|
</details>
|
|
11044
12089
|
|
|
11045
|
-
<details><summary><code>client.pods.
|
|
12090
|
+
<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
12091
|
<dl>
|
|
11047
12092
|
<dd>
|
|
11048
12093
|
|
|
@@ -11054,7 +12099,10 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
11054
12099
|
<dl>
|
|
11055
12100
|
<dd>
|
|
11056
12101
|
|
|
11057
|
-
|
|
12102
|
+
**CLI:**
|
|
12103
|
+
```bash
|
|
12104
|
+
agentmail pods webhooks delete --pod-id <pod_id> --webhook-id <webhook_id>
|
|
12105
|
+
```
|
|
11058
12106
|
</dd>
|
|
11059
12107
|
</dl>
|
|
11060
12108
|
</dd>
|
|
@@ -11069,7 +12117,7 @@ Updates thread labels. Cannot add or remove system labels (sent, received, bounc
|
|
|
11069
12117
|
<dd>
|
|
11070
12118
|
|
|
11071
12119
|
```typescript
|
|
11072
|
-
await client.pods.
|
|
12120
|
+
await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
11073
12121
|
|
|
11074
12122
|
```
|
|
11075
12123
|
</dd>
|
|
@@ -11093,15 +12141,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
11093
12141
|
<dl>
|
|
11094
12142
|
<dd>
|
|
11095
12143
|
|
|
11096
|
-
**
|
|
11097
|
-
|
|
11098
|
-
</dd>
|
|
11099
|
-
</dl>
|
|
11100
|
-
|
|
11101
|
-
<dl>
|
|
11102
|
-
<dd>
|
|
11103
|
-
|
|
11104
|
-
**request:** `AgentMail.UpdateThreadRequest`
|
|
12144
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
11105
12145
|
|
|
11106
12146
|
</dd>
|
|
11107
12147
|
</dl>
|
|
@@ -11109,7 +12149,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
11109
12149
|
<dl>
|
|
11110
12150
|
<dd>
|
|
11111
12151
|
|
|
11112
|
-
**requestOptions:** `
|
|
12152
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
11113
12153
|
|
|
11114
12154
|
</dd>
|
|
11115
12155
|
</dl>
|
|
@@ -11121,7 +12161,8 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
11121
12161
|
</dl>
|
|
11122
12162
|
</details>
|
|
11123
12163
|
|
|
11124
|
-
|
|
12164
|
+
## Pods Webhooks Polling
|
|
12165
|
+
<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
12166
|
<dl>
|
|
11126
12167
|
<dd>
|
|
11127
12168
|
|
|
@@ -11133,11 +12174,11 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
11133
12174
|
<dl>
|
|
11134
12175
|
<dd>
|
|
11135
12176
|
|
|
11136
|
-
|
|
12177
|
+
Lists the polling webhooks created through this pod route.
|
|
11137
12178
|
|
|
11138
12179
|
**CLI:**
|
|
11139
12180
|
```bash
|
|
11140
|
-
agentmail pods
|
|
12181
|
+
agentmail pods webhooks polling list --pod-id <pod_id>
|
|
11141
12182
|
```
|
|
11142
12183
|
</dd>
|
|
11143
12184
|
</dl>
|
|
@@ -11153,7 +12194,7 @@ agentmail pods threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
|
11153
12194
|
<dd>
|
|
11154
12195
|
|
|
11155
12196
|
```typescript
|
|
11156
|
-
await client.pods.
|
|
12197
|
+
await client.pods.webhooks.polling.list("pod_id");
|
|
11157
12198
|
|
|
11158
12199
|
```
|
|
11159
12200
|
</dd>
|
|
@@ -11177,7 +12218,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
11177
12218
|
<dl>
|
|
11178
12219
|
<dd>
|
|
11179
12220
|
|
|
11180
|
-
**
|
|
12221
|
+
**request:** `AgentMail.pods.webhooks.PodListPollingWebhooksRequest`
|
|
11181
12222
|
|
|
11182
12223
|
</dd>
|
|
11183
12224
|
</dl>
|
|
@@ -11185,7 +12226,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
11185
12226
|
<dl>
|
|
11186
12227
|
<dd>
|
|
11187
12228
|
|
|
11188
|
-
**requestOptions:** `
|
|
12229
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
11189
12230
|
|
|
11190
12231
|
</dd>
|
|
11191
12232
|
</dl>
|
|
@@ -11197,8 +12238,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
11197
12238
|
</dl>
|
|
11198
12239
|
</details>
|
|
11199
12240
|
|
|
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>
|
|
12241
|
+
<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
12242
|
<dl>
|
|
11203
12243
|
<dd>
|
|
11204
12244
|
|
|
@@ -11212,7 +12252,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
11212
12252
|
|
|
11213
12253
|
**CLI:**
|
|
11214
12254
|
```bash
|
|
11215
|
-
agentmail pods webhooks
|
|
12255
|
+
agentmail pods webhooks polling get --pod-id <pod_id> --webhook-id <webhook_id>
|
|
11216
12256
|
```
|
|
11217
12257
|
</dd>
|
|
11218
12258
|
</dl>
|
|
@@ -11228,7 +12268,7 @@ agentmail pods webhooks list --pod-id <pod_id>
|
|
|
11228
12268
|
<dd>
|
|
11229
12269
|
|
|
11230
12270
|
```typescript
|
|
11231
|
-
await client.pods.webhooks.
|
|
12271
|
+
await client.pods.webhooks.polling.get("pod_id", "webhook_id");
|
|
11232
12272
|
|
|
11233
12273
|
```
|
|
11234
12274
|
</dd>
|
|
@@ -11252,7 +12292,7 @@ await client.pods.webhooks.list("pod_id");
|
|
|
11252
12292
|
<dl>
|
|
11253
12293
|
<dd>
|
|
11254
12294
|
|
|
11255
|
-
**
|
|
12295
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
11256
12296
|
|
|
11257
12297
|
</dd>
|
|
11258
12298
|
</dl>
|
|
@@ -11260,7 +12300,7 @@ await client.pods.webhooks.list("pod_id");
|
|
|
11260
12300
|
<dl>
|
|
11261
12301
|
<dd>
|
|
11262
12302
|
|
|
11263
|
-
**requestOptions:** `
|
|
12303
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
11264
12304
|
|
|
11265
12305
|
</dd>
|
|
11266
12306
|
</dl>
|
|
@@ -11272,7 +12312,7 @@ await client.pods.webhooks.list("pod_id");
|
|
|
11272
12312
|
</dl>
|
|
11273
12313
|
</details>
|
|
11274
12314
|
|
|
11275
|
-
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">
|
|
12315
|
+
<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
12316
|
<dl>
|
|
11277
12317
|
<dd>
|
|
11278
12318
|
|
|
@@ -11284,9 +12324,11 @@ await client.pods.webhooks.list("pod_id");
|
|
|
11284
12324
|
<dl>
|
|
11285
12325
|
<dd>
|
|
11286
12326
|
|
|
12327
|
+
Create a polling webhook scoped to this pod and return the `token` that reads it.
|
|
12328
|
+
|
|
11287
12329
|
**CLI:**
|
|
11288
12330
|
```bash
|
|
11289
|
-
agentmail pods webhooks
|
|
12331
|
+
agentmail pods webhooks polling create --pod-id <pod_id> --client-id my-agent --event-types message.received
|
|
11290
12332
|
```
|
|
11291
12333
|
</dd>
|
|
11292
12334
|
</dl>
|
|
@@ -11302,7 +12344,10 @@ agentmail pods webhooks get --pod-id <pod_id> --webhook-id <webhook_id>
|
|
|
11302
12344
|
<dd>
|
|
11303
12345
|
|
|
11304
12346
|
```typescript
|
|
11305
|
-
await client.pods.webhooks.
|
|
12347
|
+
await client.pods.webhooks.polling.create("pod_id", {
|
|
12348
|
+
clientId: "client_id",
|
|
12349
|
+
eventTypes: ["message.received", "message.received"]
|
|
12350
|
+
});
|
|
11306
12351
|
|
|
11307
12352
|
```
|
|
11308
12353
|
</dd>
|
|
@@ -11326,7 +12371,7 @@ await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
|
11326
12371
|
<dl>
|
|
11327
12372
|
<dd>
|
|
11328
12373
|
|
|
11329
|
-
**
|
|
12374
|
+
**request:** `AgentMail.CreatePodPollingWebhookRequest`
|
|
11330
12375
|
|
|
11331
12376
|
</dd>
|
|
11332
12377
|
</dl>
|
|
@@ -11334,7 +12379,7 @@ await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
|
11334
12379
|
<dl>
|
|
11335
12380
|
<dd>
|
|
11336
12381
|
|
|
11337
|
-
**requestOptions:** `
|
|
12382
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
11338
12383
|
|
|
11339
12384
|
</dd>
|
|
11340
12385
|
</dl>
|
|
@@ -11346,7 +12391,7 @@ await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
|
11346
12391
|
</dl>
|
|
11347
12392
|
</details>
|
|
11348
12393
|
|
|
11349
|
-
<details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">
|
|
12394
|
+
<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
12395
|
<dl>
|
|
11351
12396
|
<dd>
|
|
11352
12397
|
|
|
@@ -11358,8 +12403,10 @@ await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
|
11358
12403
|
<dl>
|
|
11359
12404
|
<dd>
|
|
11360
12405
|
|
|
11361
|
-
|
|
11362
|
-
|
|
12406
|
+
**CLI:**
|
|
12407
|
+
```bash
|
|
12408
|
+
agentmail pods webhooks polling delete --pod-id <pod_id> --webhook-id <webhook_id>
|
|
12409
|
+
```
|
|
11363
12410
|
</dd>
|
|
11364
12411
|
</dl>
|
|
11365
12412
|
</dd>
|
|
@@ -11374,7 +12421,7 @@ Header values are write-only and are never returned.
|
|
|
11374
12421
|
<dd>
|
|
11375
12422
|
|
|
11376
12423
|
```typescript
|
|
11377
|
-
await client.pods.webhooks.
|
|
12424
|
+
await client.pods.webhooks.polling.delete("pod_id", "webhook_id");
|
|
11378
12425
|
|
|
11379
12426
|
```
|
|
11380
12427
|
</dd>
|
|
@@ -11406,7 +12453,7 @@ await client.pods.webhooks.getHeaders("pod_id", "webhook_id");
|
|
|
11406
12453
|
<dl>
|
|
11407
12454
|
<dd>
|
|
11408
12455
|
|
|
11409
|
-
**requestOptions:** `
|
|
12456
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
11410
12457
|
|
|
11411
12458
|
</dd>
|
|
11412
12459
|
</dl>
|
|
@@ -11418,7 +12465,8 @@ await client.pods.webhooks.getHeaders("pod_id", "webhook_id");
|
|
|
11418
12465
|
</dl>
|
|
11419
12466
|
</details>
|
|
11420
12467
|
|
|
11421
|
-
|
|
12468
|
+
## Threads
|
|
12469
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
11422
12470
|
<dl>
|
|
11423
12471
|
<dd>
|
|
11424
12472
|
|
|
@@ -11430,11 +12478,15 @@ await client.pods.webhooks.getHeaders("pod_id", "webhook_id");
|
|
|
11430
12478
|
<dl>
|
|
11431
12479
|
<dd>
|
|
11432
12480
|
|
|
11433
|
-
|
|
12481
|
+
Lists threads, most recent first. Pass `senders`, `recipients`, or
|
|
12482
|
+
`subject` to filter by substring. Filtered requests are served by
|
|
12483
|
+
search, which caps `limit` at 100. For relevance-ranked full-text
|
|
12484
|
+
search across senders, recipients, subject, and message body, use
|
|
12485
|
+
`Search Threads`.
|
|
11434
12486
|
|
|
11435
12487
|
**CLI:**
|
|
11436
12488
|
```bash
|
|
11437
|
-
agentmail
|
|
12489
|
+
agentmail threads list
|
|
11438
12490
|
```
|
|
11439
12491
|
</dd>
|
|
11440
12492
|
</dl>
|
|
@@ -11450,10 +12502,7 @@ agentmail pods webhooks create --pod-id <pod_id> --url https://example.com/webho
|
|
|
11450
12502
|
<dd>
|
|
11451
12503
|
|
|
11452
12504
|
```typescript
|
|
11453
|
-
await client.
|
|
11454
|
-
url: "url",
|
|
11455
|
-
eventTypes: ["message.received", "message.received"]
|
|
11456
|
-
});
|
|
12505
|
+
await client.threads.list();
|
|
11457
12506
|
|
|
11458
12507
|
```
|
|
11459
12508
|
</dd>
|
|
@@ -11469,15 +12518,7 @@ await client.pods.webhooks.create("pod_id", {
|
|
|
11469
12518
|
<dl>
|
|
11470
12519
|
<dd>
|
|
11471
12520
|
|
|
11472
|
-
**
|
|
11473
|
-
|
|
11474
|
-
</dd>
|
|
11475
|
-
</dl>
|
|
11476
|
-
|
|
11477
|
-
<dl>
|
|
11478
|
-
<dd>
|
|
11479
|
-
|
|
11480
|
-
**request:** `AgentMail.CreatePodWebhookRequest`
|
|
12521
|
+
**request:** `AgentMail.ListThreadsRequest`
|
|
11481
12522
|
|
|
11482
12523
|
</dd>
|
|
11483
12524
|
</dl>
|
|
@@ -11485,7 +12526,7 @@ await client.pods.webhooks.create("pod_id", {
|
|
|
11485
12526
|
<dl>
|
|
11486
12527
|
<dd>
|
|
11487
12528
|
|
|
11488
|
-
**requestOptions:** `
|
|
12529
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
11489
12530
|
|
|
11490
12531
|
</dd>
|
|
11491
12532
|
</dl>
|
|
@@ -11497,7 +12538,7 @@ await client.pods.webhooks.create("pod_id", {
|
|
|
11497
12538
|
</dl>
|
|
11498
12539
|
</details>
|
|
11499
12540
|
|
|
11500
|
-
<details><summary><code>client.
|
|
12541
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">search</a>({ ...params }) -> AgentMail.SearchThreadsResponse</code></summary>
|
|
11501
12542
|
<dl>
|
|
11502
12543
|
<dd>
|
|
11503
12544
|
|
|
@@ -11509,10 +12550,11 @@ await client.pods.webhooks.create("pod_id", {
|
|
|
11509
12550
|
<dl>
|
|
11510
12551
|
<dd>
|
|
11511
12552
|
|
|
11512
|
-
|
|
11513
|
-
|
|
11514
|
-
|
|
11515
|
-
|
|
12553
|
+
Full-text search across threads in the organization, ranked by
|
|
12554
|
+
relevance. The query is matched against senders, recipients, and
|
|
12555
|
+
subject (substring) and the message body (tokenized full text). Spam,
|
|
12556
|
+
trash, blocked, and unauthenticated threads are always excluded.
|
|
12557
|
+
`limit` cannot exceed 100.
|
|
11516
12558
|
</dd>
|
|
11517
12559
|
</dl>
|
|
11518
12560
|
</dd>
|
|
@@ -11527,7 +12569,9 @@ agentmail pods webhooks update --pod-id <pod_id> --webhook-id <webhook_id> --add
|
|
|
11527
12569
|
<dd>
|
|
11528
12570
|
|
|
11529
12571
|
```typescript
|
|
11530
|
-
await client.
|
|
12572
|
+
await client.threads.search({
|
|
12573
|
+
q: "q"
|
|
12574
|
+
});
|
|
11531
12575
|
|
|
11532
12576
|
```
|
|
11533
12577
|
</dd>
|
|
@@ -11543,23 +12587,7 @@ await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
|
11543
12587
|
<dl>
|
|
11544
12588
|
<dd>
|
|
11545
12589
|
|
|
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`
|
|
12590
|
+
**request:** `AgentMail.SearchThreadsRequest`
|
|
11563
12591
|
|
|
11564
12592
|
</dd>
|
|
11565
12593
|
</dl>
|
|
@@ -11567,7 +12595,7 @@ await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
|
11567
12595
|
<dl>
|
|
11568
12596
|
<dd>
|
|
11569
12597
|
|
|
11570
|
-
**requestOptions:** `
|
|
12598
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
11571
12599
|
|
|
11572
12600
|
</dd>
|
|
11573
12601
|
</dl>
|
|
@@ -11579,7 +12607,7 @@ await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
|
11579
12607
|
</dl>
|
|
11580
12608
|
</details>
|
|
11581
12609
|
|
|
11582
|
-
<details><summary><code>client.
|
|
12610
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">get</a>(thread_id, { ...params }) -> AgentMail.Thread</code></summary>
|
|
11583
12611
|
<dl>
|
|
11584
12612
|
<dd>
|
|
11585
12613
|
|
|
@@ -11591,8 +12619,10 @@ await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
|
11591
12619
|
<dl>
|
|
11592
12620
|
<dd>
|
|
11593
12621
|
|
|
11594
|
-
|
|
11595
|
-
|
|
12622
|
+
**CLI:**
|
|
12623
|
+
```bash
|
|
12624
|
+
agentmail threads get --thread-id <thread_id>
|
|
12625
|
+
```
|
|
11596
12626
|
</dd>
|
|
11597
12627
|
</dl>
|
|
11598
12628
|
</dd>
|
|
@@ -11607,7 +12637,7 @@ pod-scoped webhook. Header values remain write-only.
|
|
|
11607
12637
|
<dd>
|
|
11608
12638
|
|
|
11609
12639
|
```typescript
|
|
11610
|
-
await client.
|
|
12640
|
+
await client.threads.get("thread_id");
|
|
11611
12641
|
|
|
11612
12642
|
```
|
|
11613
12643
|
</dd>
|
|
@@ -11623,15 +12653,7 @@ await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
|
11623
12653
|
<dl>
|
|
11624
12654
|
<dd>
|
|
11625
12655
|
|
|
11626
|
-
**
|
|
11627
|
-
|
|
11628
|
-
</dd>
|
|
11629
|
-
</dl>
|
|
11630
|
-
|
|
11631
|
-
<dl>
|
|
11632
|
-
<dd>
|
|
11633
|
-
|
|
11634
|
-
**webhook_id:** `AgentMail.WebhookId`
|
|
12656
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
11635
12657
|
|
|
11636
12658
|
</dd>
|
|
11637
12659
|
</dl>
|
|
@@ -11639,7 +12661,7 @@ await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
|
11639
12661
|
<dl>
|
|
11640
12662
|
<dd>
|
|
11641
12663
|
|
|
11642
|
-
**request:** `AgentMail.
|
|
12664
|
+
**request:** `AgentMail.GetThreadRequest`
|
|
11643
12665
|
|
|
11644
12666
|
</dd>
|
|
11645
12667
|
</dl>
|
|
@@ -11647,7 +12669,7 @@ await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
|
11647
12669
|
<dl>
|
|
11648
12670
|
<dd>
|
|
11649
12671
|
|
|
11650
|
-
**requestOptions:** `
|
|
12672
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
11651
12673
|
|
|
11652
12674
|
</dd>
|
|
11653
12675
|
</dl>
|
|
@@ -11659,7 +12681,7 @@ await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
|
11659
12681
|
</dl>
|
|
11660
12682
|
</details>
|
|
11661
12683
|
|
|
11662
|
-
<details><summary><code>client.
|
|
12684
|
+
<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
12685
|
<dl>
|
|
11664
12686
|
<dd>
|
|
11665
12687
|
|
|
@@ -11673,7 +12695,7 @@ await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
|
|
|
11673
12695
|
|
|
11674
12696
|
**CLI:**
|
|
11675
12697
|
```bash
|
|
11676
|
-
agentmail
|
|
12698
|
+
agentmail threads get-attachment --thread-id <thread_id> --attachment-id <attachment_id>
|
|
11677
12699
|
```
|
|
11678
12700
|
</dd>
|
|
11679
12701
|
</dl>
|
|
@@ -11689,7 +12711,7 @@ agentmail pods webhooks delete --pod-id <pod_id> --webhook-id <webhook_id>
|
|
|
11689
12711
|
<dd>
|
|
11690
12712
|
|
|
11691
12713
|
```typescript
|
|
11692
|
-
await client.
|
|
12714
|
+
await client.threads.getAttachment("thread_id", "attachment_id");
|
|
11693
12715
|
|
|
11694
12716
|
```
|
|
11695
12717
|
</dd>
|
|
@@ -11705,7 +12727,7 @@ await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
|
11705
12727
|
<dl>
|
|
11706
12728
|
<dd>
|
|
11707
12729
|
|
|
11708
|
-
**
|
|
12730
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
11709
12731
|
|
|
11710
12732
|
</dd>
|
|
11711
12733
|
</dl>
|
|
@@ -11713,7 +12735,7 @@ await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
|
11713
12735
|
<dl>
|
|
11714
12736
|
<dd>
|
|
11715
12737
|
|
|
11716
|
-
**
|
|
12738
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
11717
12739
|
|
|
11718
12740
|
</dd>
|
|
11719
12741
|
</dl>
|
|
@@ -11721,7 +12743,7 @@ await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
|
11721
12743
|
<dl>
|
|
11722
12744
|
<dd>
|
|
11723
12745
|
|
|
11724
|
-
**requestOptions:** `
|
|
12746
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
11725
12747
|
|
|
11726
12748
|
</dd>
|
|
11727
12749
|
</dl>
|
|
@@ -11733,8 +12755,7 @@ await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
|
11733
12755
|
</dl>
|
|
11734
12756
|
</details>
|
|
11735
12757
|
|
|
11736
|
-
|
|
11737
|
-
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
12758
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">update</a>(thread_id, { ...params }) -> AgentMail.UpdateThreadResponse</code></summary>
|
|
11738
12759
|
<dl>
|
|
11739
12760
|
<dd>
|
|
11740
12761
|
|
|
@@ -11746,16 +12767,7 @@ await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
|
11746
12767
|
<dl>
|
|
11747
12768
|
<dd>
|
|
11748
12769
|
|
|
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
|
-
```
|
|
12770
|
+
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
12771
|
</dd>
|
|
11760
12772
|
</dl>
|
|
11761
12773
|
</dd>
|
|
@@ -11770,7 +12782,7 @@ agentmail threads list
|
|
|
11770
12782
|
<dd>
|
|
11771
12783
|
|
|
11772
12784
|
```typescript
|
|
11773
|
-
await client.threads.
|
|
12785
|
+
await client.threads.update("thread_id", {});
|
|
11774
12786
|
|
|
11775
12787
|
```
|
|
11776
12788
|
</dd>
|
|
@@ -11786,7 +12798,15 @@ await client.threads.list();
|
|
|
11786
12798
|
<dl>
|
|
11787
12799
|
<dd>
|
|
11788
12800
|
|
|
11789
|
-
**
|
|
12801
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
12802
|
+
|
|
12803
|
+
</dd>
|
|
12804
|
+
</dl>
|
|
12805
|
+
|
|
12806
|
+
<dl>
|
|
12807
|
+
<dd>
|
|
12808
|
+
|
|
12809
|
+
**request:** `AgentMail.UpdateThreadRequest`
|
|
11790
12810
|
|
|
11791
12811
|
</dd>
|
|
11792
12812
|
</dl>
|
|
@@ -11806,7 +12826,7 @@ await client.threads.list();
|
|
|
11806
12826
|
</dl>
|
|
11807
12827
|
</details>
|
|
11808
12828
|
|
|
11809
|
-
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">
|
|
12829
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">delete</a>(thread_id) -> void</code></summary>
|
|
11810
12830
|
<dl>
|
|
11811
12831
|
<dd>
|
|
11812
12832
|
|
|
@@ -11818,11 +12838,12 @@ await client.threads.list();
|
|
|
11818
12838
|
<dl>
|
|
11819
12839
|
<dd>
|
|
11820
12840
|
|
|
11821
|
-
|
|
11822
|
-
|
|
11823
|
-
|
|
11824
|
-
|
|
11825
|
-
|
|
12841
|
+
Permanently deletes a thread and all of its messages.
|
|
12842
|
+
|
|
12843
|
+
**CLI:**
|
|
12844
|
+
```bash
|
|
12845
|
+
agentmail threads delete --thread-id <thread_id>
|
|
12846
|
+
```
|
|
11826
12847
|
</dd>
|
|
11827
12848
|
</dl>
|
|
11828
12849
|
</dd>
|
|
@@ -11837,9 +12858,7 @@ trash, blocked, and unauthenticated threads are always excluded.
|
|
|
11837
12858
|
<dd>
|
|
11838
12859
|
|
|
11839
12860
|
```typescript
|
|
11840
|
-
await client.threads.
|
|
11841
|
-
q: "q"
|
|
11842
|
-
});
|
|
12861
|
+
await client.threads.delete("thread_id");
|
|
11843
12862
|
|
|
11844
12863
|
```
|
|
11845
12864
|
</dd>
|
|
@@ -11855,7 +12874,7 @@ await client.threads.search({
|
|
|
11855
12874
|
<dl>
|
|
11856
12875
|
<dd>
|
|
11857
12876
|
|
|
11858
|
-
**
|
|
12877
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
11859
12878
|
|
|
11860
12879
|
</dd>
|
|
11861
12880
|
</dl>
|
|
@@ -11875,7 +12894,8 @@ await client.threads.search({
|
|
|
11875
12894
|
</dl>
|
|
11876
12895
|
</details>
|
|
11877
12896
|
|
|
11878
|
-
|
|
12897
|
+
## Webhooks Polling
|
|
12898
|
+
<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
12899
|
<dl>
|
|
11880
12900
|
<dd>
|
|
11881
12901
|
|
|
@@ -11887,9 +12907,12 @@ await client.threads.search({
|
|
|
11887
12907
|
<dl>
|
|
11888
12908
|
<dd>
|
|
11889
12909
|
|
|
12910
|
+
Lists the polling webhooks created through this route. `page_token` must come from this
|
|
12911
|
+
endpoint; a token from another list endpoint is rejected.
|
|
12912
|
+
|
|
11890
12913
|
**CLI:**
|
|
11891
12914
|
```bash
|
|
11892
|
-
agentmail
|
|
12915
|
+
agentmail webhooks polling list
|
|
11893
12916
|
```
|
|
11894
12917
|
</dd>
|
|
11895
12918
|
</dl>
|
|
@@ -11905,7 +12928,7 @@ agentmail threads get --thread-id <thread_id>
|
|
|
11905
12928
|
<dd>
|
|
11906
12929
|
|
|
11907
12930
|
```typescript
|
|
11908
|
-
await client.
|
|
12931
|
+
await client.webhooks.polling.list();
|
|
11909
12932
|
|
|
11910
12933
|
```
|
|
11911
12934
|
</dd>
|
|
@@ -11921,15 +12944,7 @@ await client.threads.get("thread_id");
|
|
|
11921
12944
|
<dl>
|
|
11922
12945
|
<dd>
|
|
11923
12946
|
|
|
11924
|
-
**
|
|
11925
|
-
|
|
11926
|
-
</dd>
|
|
11927
|
-
</dl>
|
|
11928
|
-
|
|
11929
|
-
<dl>
|
|
11930
|
-
<dd>
|
|
11931
|
-
|
|
11932
|
-
**request:** `AgentMail.GetThreadRequest`
|
|
12947
|
+
**request:** `AgentMail.webhooks.ListPollingWebhooksRequest`
|
|
11933
12948
|
|
|
11934
12949
|
</dd>
|
|
11935
12950
|
</dl>
|
|
@@ -11937,7 +12952,7 @@ await client.threads.get("thread_id");
|
|
|
11937
12952
|
<dl>
|
|
11938
12953
|
<dd>
|
|
11939
12954
|
|
|
11940
|
-
**requestOptions:** `
|
|
12955
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
11941
12956
|
|
|
11942
12957
|
</dd>
|
|
11943
12958
|
</dl>
|
|
@@ -11949,7 +12964,7 @@ await client.threads.get("thread_id");
|
|
|
11949
12964
|
</dl>
|
|
11950
12965
|
</details>
|
|
11951
12966
|
|
|
11952
|
-
<details><summary><code>client.
|
|
12967
|
+
<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
12968
|
<dl>
|
|
11954
12969
|
<dd>
|
|
11955
12970
|
|
|
@@ -11961,9 +12976,11 @@ await client.threads.get("thread_id");
|
|
|
11961
12976
|
<dl>
|
|
11962
12977
|
<dd>
|
|
11963
12978
|
|
|
12979
|
+
The `token` is never returned here: create again with the same `client_id` to get a new one.
|
|
12980
|
+
|
|
11964
12981
|
**CLI:**
|
|
11965
12982
|
```bash
|
|
11966
|
-
agentmail
|
|
12983
|
+
agentmail webhooks polling get --webhook-id <webhook_id>
|
|
11967
12984
|
```
|
|
11968
12985
|
</dd>
|
|
11969
12986
|
</dl>
|
|
@@ -11979,7 +12996,7 @@ agentmail threads get-attachment --thread-id <thread_id> --attachment-id <attach
|
|
|
11979
12996
|
<dd>
|
|
11980
12997
|
|
|
11981
12998
|
```typescript
|
|
11982
|
-
await client.
|
|
12999
|
+
await client.webhooks.polling.get("webhook_id");
|
|
11983
13000
|
|
|
11984
13001
|
```
|
|
11985
13002
|
</dd>
|
|
@@ -11995,15 +13012,7 @@ await client.threads.getAttachment("thread_id", "attachment_id");
|
|
|
11995
13012
|
<dl>
|
|
11996
13013
|
<dd>
|
|
11997
13014
|
|
|
11998
|
-
**
|
|
11999
|
-
|
|
12000
|
-
</dd>
|
|
12001
|
-
</dl>
|
|
12002
|
-
|
|
12003
|
-
<dl>
|
|
12004
|
-
<dd>
|
|
12005
|
-
|
|
12006
|
-
**attachment_id:** `AgentMail.AttachmentId`
|
|
13015
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
12007
13016
|
|
|
12008
13017
|
</dd>
|
|
12009
13018
|
</dl>
|
|
@@ -12011,7 +13020,7 @@ await client.threads.getAttachment("thread_id", "attachment_id");
|
|
|
12011
13020
|
<dl>
|
|
12012
13021
|
<dd>
|
|
12013
13022
|
|
|
12014
|
-
**requestOptions:** `
|
|
13023
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
12015
13024
|
|
|
12016
13025
|
</dd>
|
|
12017
13026
|
</dl>
|
|
@@ -12023,7 +13032,7 @@ await client.threads.getAttachment("thread_id", "attachment_id");
|
|
|
12023
13032
|
</dl>
|
|
12024
13033
|
</details>
|
|
12025
13034
|
|
|
12026
|
-
<details><summary><code>client.
|
|
13035
|
+
<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
13036
|
<dl>
|
|
12028
13037
|
<dd>
|
|
12029
13038
|
|
|
@@ -12035,7 +13044,14 @@ await client.threads.getAttachment("thread_id", "attachment_id");
|
|
|
12035
13044
|
<dl>
|
|
12036
13045
|
<dd>
|
|
12037
13046
|
|
|
12038
|
-
|
|
13047
|
+
Creates a subscription the agent polls for events, and returns the `token` that reads it. Each
|
|
13048
|
+
organization, pod, and inbox holds at most 10 polling webhooks; a repeat create with the same
|
|
13049
|
+
`client_id` re-issues the token of the existing one instead of counting against that limit.
|
|
13050
|
+
|
|
13051
|
+
**CLI:**
|
|
13052
|
+
```bash
|
|
13053
|
+
agentmail webhooks polling create --client-id my-agent --event-types message.received
|
|
13054
|
+
```
|
|
12039
13055
|
</dd>
|
|
12040
13056
|
</dl>
|
|
12041
13057
|
</dd>
|
|
@@ -12050,7 +13066,10 @@ Updates thread labels. Cannot add or remove system labels (sent, received, bounc
|
|
|
12050
13066
|
<dd>
|
|
12051
13067
|
|
|
12052
13068
|
```typescript
|
|
12053
|
-
await client.
|
|
13069
|
+
await client.webhooks.polling.create({
|
|
13070
|
+
clientId: "client_id",
|
|
13071
|
+
eventTypes: ["message.received", "message.received"]
|
|
13072
|
+
});
|
|
12054
13073
|
|
|
12055
13074
|
```
|
|
12056
13075
|
</dd>
|
|
@@ -12066,15 +13085,7 @@ await client.threads.update("thread_id", {});
|
|
|
12066
13085
|
<dl>
|
|
12067
13086
|
<dd>
|
|
12068
13087
|
|
|
12069
|
-
**
|
|
12070
|
-
|
|
12071
|
-
</dd>
|
|
12072
|
-
</dl>
|
|
12073
|
-
|
|
12074
|
-
<dl>
|
|
12075
|
-
<dd>
|
|
12076
|
-
|
|
12077
|
-
**request:** `AgentMail.UpdateThreadRequest`
|
|
13088
|
+
**request:** `AgentMail.CreatePollingWebhookRequest`
|
|
12078
13089
|
|
|
12079
13090
|
</dd>
|
|
12080
13091
|
</dl>
|
|
@@ -12082,7 +13093,7 @@ await client.threads.update("thread_id", {});
|
|
|
12082
13093
|
<dl>
|
|
12083
13094
|
<dd>
|
|
12084
13095
|
|
|
12085
|
-
**requestOptions:** `
|
|
13096
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
12086
13097
|
|
|
12087
13098
|
</dd>
|
|
12088
13099
|
</dl>
|
|
@@ -12094,7 +13105,7 @@ await client.threads.update("thread_id", {});
|
|
|
12094
13105
|
</dl>
|
|
12095
13106
|
</details>
|
|
12096
13107
|
|
|
12097
|
-
<details><summary><code>client.
|
|
13108
|
+
<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
13109
|
<dl>
|
|
12099
13110
|
<dd>
|
|
12100
13111
|
|
|
@@ -12106,11 +13117,11 @@ await client.threads.update("thread_id", {});
|
|
|
12106
13117
|
<dl>
|
|
12107
13118
|
<dd>
|
|
12108
13119
|
|
|
12109
|
-
|
|
13120
|
+
Stops delivery and invalidates the subscription's token.
|
|
12110
13121
|
|
|
12111
13122
|
**CLI:**
|
|
12112
13123
|
```bash
|
|
12113
|
-
agentmail
|
|
13124
|
+
agentmail webhooks polling delete --webhook-id <webhook_id>
|
|
12114
13125
|
```
|
|
12115
13126
|
</dd>
|
|
12116
13127
|
</dl>
|
|
@@ -12126,7 +13137,7 @@ agentmail threads delete --thread-id <thread_id>
|
|
|
12126
13137
|
<dd>
|
|
12127
13138
|
|
|
12128
13139
|
```typescript
|
|
12129
|
-
await client.
|
|
13140
|
+
await client.webhooks.polling.delete("webhook_id");
|
|
12130
13141
|
|
|
12131
13142
|
```
|
|
12132
13143
|
</dd>
|
|
@@ -12142,7 +13153,7 @@ await client.threads.delete("thread_id");
|
|
|
12142
13153
|
<dl>
|
|
12143
13154
|
<dd>
|
|
12144
13155
|
|
|
12145
|
-
**
|
|
13156
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
12146
13157
|
|
|
12147
13158
|
</dd>
|
|
12148
13159
|
</dl>
|
|
@@ -12150,7 +13161,7 @@ await client.threads.delete("thread_id");
|
|
|
12150
13161
|
<dl>
|
|
12151
13162
|
<dd>
|
|
12152
13163
|
|
|
12153
|
-
**requestOptions:** `
|
|
13164
|
+
**requestOptions:** `PollingClient.RequestOptions`
|
|
12154
13165
|
|
|
12155
13166
|
</dd>
|
|
12156
13167
|
</dl>
|