agentmail 0.5.11 → 0.5.13
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/drafts/types/CreateDraftForwardRequest.d.ts +21 -0
- package/dist/cjs/api/resources/drafts/types/CreateDraftReplyAllRequest.d.ts +17 -0
- package/dist/cjs/api/resources/drafts/types/CreateDraftReplyRequest.d.ts +22 -0
- package/dist/cjs/api/resources/drafts/types/Draft.d.ts +1 -0
- package/dist/cjs/api/resources/drafts/types/DraftForwardOf.d.ts +4 -0
- package/dist/cjs/api/resources/drafts/types/DraftForwardOf.js +3 -0
- package/dist/cjs/api/resources/drafts/types/DraftItem.d.ts +1 -0
- package/dist/cjs/api/resources/drafts/types/DraftReplyAll.d.ts +4 -0
- package/dist/cjs/api/resources/drafts/types/DraftReplyAll.js +3 -0
- package/dist/cjs/api/resources/drafts/types/index.d.ts +5 -0
- package/dist/cjs/api/resources/drafts/types/index.js +5 -0
- package/dist/cjs/api/resources/inboxes/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/inboxes/client/Client.js +5 -0
- package/dist/cjs/api/resources/inboxes/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/resources/index.js +3 -1
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +69 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +264 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.d.ts +30 -4
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.js +102 -7
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/{QueryMetricsRequest.d.ts → QueryEventsRequest.d.ts} +1 -1
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/QueryEventsRequest.js +3 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/QueryUsageRequest.d.ts +13 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/QueryUsageRequest.js +3 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/index.d.ts +2 -1
- package/dist/cjs/api/resources/inboxes/resources/webhooks/client/Client.d.ts +103 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/client/Client.js +411 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/client/index.js +17 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/client/requests/InboxListWebhooksRequest.d.ts +10 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/client/requests/InboxListWebhooksRequest.js +3 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/exports.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/exports.js +21 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/webhooks/index.js +17 -0
- package/dist/cjs/api/resources/metrics/client/Client.d.ts +27 -4
- package/dist/cjs/api/resources/metrics/client/Client.js +99 -7
- package/dist/cjs/api/resources/metrics/client/requests/{QueryMetricsRequest.d.ts → QueryEventsRequest.d.ts} +1 -1
- package/dist/cjs/api/resources/metrics/client/requests/QueryEventsRequest.js +3 -0
- package/dist/cjs/api/resources/metrics/client/requests/QueryUsageRequest.d.ts +13 -0
- package/dist/cjs/api/resources/metrics/client/requests/QueryUsageRequest.js +3 -0
- package/dist/cjs/api/resources/metrics/client/requests/index.d.ts +2 -1
- package/dist/cjs/api/resources/metrics/types/MetricEventType.d.ts +6 -3
- package/dist/cjs/api/resources/metrics/types/MetricEventType.js +6 -3
- package/dist/cjs/api/resources/metrics/types/Period.d.ts +2 -2
- package/dist/cjs/api/resources/metrics/types/QueryUsageResponse.d.ts +5 -0
- package/dist/cjs/api/resources/metrics/types/QueryUsageResponse.js +3 -0
- package/dist/cjs/api/resources/metrics/types/UsagePoint.d.ts +6 -0
- package/dist/cjs/api/resources/metrics/types/UsagePoint.js +3 -0
- package/dist/cjs/api/resources/metrics/types/UsageType.d.ts +14 -0
- package/dist/cjs/api/resources/metrics/types/UsageType.js +17 -0
- package/dist/cjs/api/resources/metrics/types/UsageTypes.d.ts +5 -0
- package/dist/cjs/api/resources/metrics/types/UsageTypes.js +3 -0
- package/dist/cjs/api/resources/metrics/types/index.d.ts +4 -0
- package/dist/cjs/api/resources/metrics/types/index.js +4 -0
- package/dist/cjs/api/resources/pods/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/pods/client/Client.js +5 -0
- package/dist/cjs/api/resources/pods/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/pods/resources/index.js +3 -1
- package/dist/cjs/api/resources/pods/resources/metrics/client/Client.d.ts +30 -4
- package/dist/cjs/api/resources/pods/resources/metrics/client/Client.js +102 -7
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/{QueryMetricsRequest.d.ts → QueryEventsRequest.d.ts} +1 -1
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/QueryEventsRequest.js +3 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/QueryUsageRequest.d.ts +13 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/QueryUsageRequest.js +3 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/index.d.ts +2 -1
- package/dist/cjs/api/resources/pods/resources/webhooks/client/Client.d.ts +103 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/client/Client.js +411 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/client/index.js +17 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/client/requests/PodListWebhooksRequest.d.ts +10 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/client/requests/PodListWebhooksRequest.js +3 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/exports.d.ts +2 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/exports.js +21 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/webhooks/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/types/CreateInboxWebhookRequest.d.ts +10 -0
- package/dist/cjs/api/resources/webhooks/types/CreateInboxWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/CreatePodWebhookRequest.d.ts +9 -0
- package/dist/cjs/api/resources/webhooks/types/CreatePodWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookEventTypes.d.ts +7 -0
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookEventTypes.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookRequest.d.ts +1 -10
- package/dist/cjs/api/resources/webhooks/types/UpdateInboxWebhookRequest.d.ts +7 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateInboxWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/UpdatePodWebhookRequest.d.ts +11 -0
- package/dist/cjs/api/resources/webhooks/types/UpdatePodWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookEventTypes.d.ts +10 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookEventTypes.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequest.d.ts +1 -14
- package/dist/cjs/api/resources/webhooks/types/index.d.ts +6 -0
- package/dist/cjs/api/resources/webhooks/types/index.js +6 -0
- package/dist/cjs/serialization/resources/drafts/types/CreateDraftForwardRequest.d.ts +30 -0
- package/dist/cjs/serialization/resources/drafts/types/CreateDraftForwardRequest.js +62 -0
- package/dist/cjs/serialization/resources/drafts/types/CreateDraftReplyAllRequest.d.ts +24 -0
- package/dist/cjs/serialization/resources/drafts/types/CreateDraftReplyAllRequest.js +56 -0
- package/dist/cjs/serialization/resources/drafts/types/CreateDraftReplyRequest.d.ts +32 -0
- package/dist/cjs/serialization/resources/drafts/types/CreateDraftReplyRequest.js +64 -0
- package/dist/cjs/serialization/resources/drafts/types/Draft.d.ts +2 -0
- package/dist/cjs/serialization/resources/drafts/types/Draft.js +2 -0
- package/dist/cjs/serialization/resources/drafts/types/DraftForwardOf.d.ts +7 -0
- package/dist/cjs/serialization/resources/drafts/types/DraftForwardOf.js +39 -0
- package/dist/cjs/serialization/resources/drafts/types/DraftItem.d.ts +2 -0
- package/dist/cjs/serialization/resources/drafts/types/DraftItem.js +2 -0
- package/dist/cjs/serialization/resources/drafts/types/DraftReplyAll.d.ts +7 -0
- package/dist/cjs/serialization/resources/drafts/types/DraftReplyAll.js +39 -0
- package/dist/cjs/serialization/resources/drafts/types/index.d.ts +5 -0
- package/dist/cjs/serialization/resources/drafts/types/index.js +5 -0
- package/dist/cjs/serialization/resources/metrics/types/MetricEventType.d.ts +1 -1
- package/dist/cjs/serialization/resources/metrics/types/MetricEventType.js +6 -3
- package/dist/cjs/serialization/resources/metrics/types/Period.d.ts +1 -1
- package/dist/cjs/serialization/resources/metrics/types/Period.js +1 -1
- package/dist/cjs/serialization/resources/metrics/types/QueryUsageResponse.d.ts +9 -0
- package/dist/cjs/serialization/resources/metrics/types/QueryUsageResponse.js +41 -0
- package/dist/cjs/serialization/resources/metrics/types/UsagePoint.d.ts +10 -0
- package/dist/cjs/serialization/resources/metrics/types/UsagePoint.js +42 -0
- package/dist/cjs/serialization/resources/metrics/types/UsageType.d.ts +7 -0
- package/dist/cjs/serialization/resources/metrics/types/UsageType.js +46 -0
- package/dist/cjs/serialization/resources/metrics/types/UsageTypes.d.ts +8 -0
- package/dist/cjs/serialization/resources/metrics/types/UsageTypes.js +40 -0
- package/dist/cjs/serialization/resources/metrics/types/index.d.ts +4 -0
- package/dist/cjs/serialization/resources/metrics/types/index.js +4 -0
- package/dist/cjs/serialization/resources/webhooks/types/CreateInboxWebhookRequest.d.ts +14 -0
- package/dist/cjs/serialization/resources/webhooks/types/CreateInboxWebhookRequest.js +46 -0
- package/dist/cjs/serialization/resources/webhooks/types/CreatePodWebhookRequest.d.ts +11 -0
- package/dist/cjs/serialization/resources/webhooks/types/CreatePodWebhookRequest.js +45 -0
- package/dist/cjs/serialization/resources/webhooks/types/CreateWebhookEventTypes.d.ts +8 -0
- package/dist/cjs/serialization/resources/webhooks/types/CreateWebhookEventTypes.js +6 -0
- package/dist/cjs/serialization/resources/webhooks/types/CreateWebhookRequest.d.ts +2 -9
- package/dist/cjs/serialization/resources/webhooks/types/CreateWebhookRequest.js +5 -10
- package/dist/cjs/serialization/resources/webhooks/types/UpdateInboxWebhookRequest.d.ts +10 -0
- package/dist/cjs/serialization/resources/webhooks/types/UpdateInboxWebhookRequest.js +42 -0
- package/dist/cjs/serialization/resources/webhooks/types/UpdatePodWebhookRequest.d.ts +12 -0
- package/dist/cjs/serialization/resources/webhooks/types/UpdatePodWebhookRequest.js +46 -0
- package/dist/cjs/serialization/resources/webhooks/types/UpdateWebhookEventTypes.d.ts +8 -0
- package/dist/cjs/serialization/resources/webhooks/types/UpdateWebhookEventTypes.js +6 -0
- package/dist/cjs/serialization/resources/webhooks/types/UpdateWebhookRequest.d.ts +2 -6
- package/dist/cjs/serialization/resources/webhooks/types/UpdateWebhookRequest.js +5 -7
- package/dist/cjs/serialization/resources/webhooks/types/index.d.ts +6 -0
- package/dist/cjs/serialization/resources/webhooks/types/index.js +6 -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/drafts/types/CreateDraftForwardRequest.d.mts +21 -0
- package/dist/esm/api/resources/drafts/types/CreateDraftReplyAllRequest.d.mts +17 -0
- package/dist/esm/api/resources/drafts/types/CreateDraftReplyRequest.d.mts +22 -0
- package/dist/esm/api/resources/drafts/types/Draft.d.mts +1 -0
- package/dist/esm/api/resources/drafts/types/DraftForwardOf.d.mts +4 -0
- package/dist/esm/api/resources/drafts/types/DraftForwardOf.mjs +2 -0
- package/dist/esm/api/resources/drafts/types/DraftItem.d.mts +1 -0
- package/dist/esm/api/resources/drafts/types/DraftReplyAll.d.mts +4 -0
- package/dist/esm/api/resources/drafts/types/DraftReplyAll.mjs +2 -0
- package/dist/esm/api/resources/drafts/types/index.d.mts +5 -0
- package/dist/esm/api/resources/drafts/types/index.mjs +5 -0
- package/dist/esm/api/resources/inboxes/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/inboxes/client/Client.mjs +5 -0
- package/dist/esm/api/resources/inboxes/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/resources/index.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +69 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +264 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.d.mts +30 -4
- package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.mjs +102 -7
- package/dist/esm/api/resources/{pods/resources/metrics/client/requests/QueryMetricsRequest.d.mts → inboxes/resources/metrics/client/requests/QueryEventsRequest.d.mts} +1 -1
- package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/QueryEventsRequest.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/QueryUsageRequest.d.mts +13 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/QueryUsageRequest.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/index.d.mts +2 -1
- package/dist/esm/api/resources/inboxes/resources/webhooks/client/Client.d.mts +103 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/client/Client.mjs +374 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/client/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/client/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/client/requests/InboxListWebhooksRequest.d.mts +10 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/client/requests/InboxListWebhooksRequest.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/exports.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/resources/webhooks/exports.mjs +3 -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/metrics/client/Client.d.mts +27 -4
- package/dist/esm/api/resources/metrics/client/Client.mjs +99 -7
- package/dist/esm/api/resources/metrics/client/requests/{QueryMetricsRequest.d.mts → QueryEventsRequest.d.mts} +1 -1
- package/dist/esm/api/resources/metrics/client/requests/QueryEventsRequest.mjs +2 -0
- package/dist/esm/api/resources/metrics/client/requests/QueryUsageRequest.d.mts +13 -0
- package/dist/esm/api/resources/metrics/client/requests/QueryUsageRequest.mjs +2 -0
- package/dist/esm/api/resources/metrics/client/requests/index.d.mts +2 -1
- package/dist/esm/api/resources/metrics/types/MetricEventType.d.mts +6 -3
- package/dist/esm/api/resources/metrics/types/MetricEventType.mjs +6 -3
- package/dist/esm/api/resources/metrics/types/Period.d.mts +2 -2
- package/dist/esm/api/resources/metrics/types/QueryUsageResponse.d.mts +5 -0
- package/dist/esm/api/resources/metrics/types/QueryUsageResponse.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/UsagePoint.d.mts +6 -0
- package/dist/esm/api/resources/metrics/types/UsagePoint.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/UsageType.d.mts +14 -0
- package/dist/esm/api/resources/metrics/types/UsageType.mjs +14 -0
- package/dist/esm/api/resources/metrics/types/UsageTypes.d.mts +5 -0
- package/dist/esm/api/resources/metrics/types/UsageTypes.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/index.d.mts +4 -0
- package/dist/esm/api/resources/metrics/types/index.mjs +4 -0
- package/dist/esm/api/resources/pods/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/pods/client/Client.mjs +5 -0
- package/dist/esm/api/resources/pods/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/pods/resources/index.mjs +2 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/Client.d.mts +30 -4
- package/dist/esm/api/resources/pods/resources/metrics/client/Client.mjs +102 -7
- package/dist/esm/api/resources/{inboxes/resources/metrics/client/requests/QueryMetricsRequest.d.mts → pods/resources/metrics/client/requests/QueryEventsRequest.d.mts} +1 -1
- package/dist/esm/api/resources/pods/resources/metrics/client/requests/QueryEventsRequest.mjs +2 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/requests/QueryUsageRequest.d.mts +13 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/requests/QueryUsageRequest.mjs +2 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/requests/index.d.mts +2 -1
- package/dist/esm/api/resources/pods/resources/webhooks/client/Client.d.mts +103 -0
- package/dist/esm/api/resources/pods/resources/webhooks/client/Client.mjs +374 -0
- package/dist/esm/api/resources/pods/resources/webhooks/client/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/client/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/client/requests/PodListWebhooksRequest.d.mts +10 -0
- package/dist/esm/api/resources/pods/resources/webhooks/client/requests/PodListWebhooksRequest.mjs +2 -0
- package/dist/esm/api/resources/pods/resources/webhooks/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/webhooks/exports.d.mts +2 -0
- package/dist/esm/api/resources/pods/resources/webhooks/exports.mjs +3 -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/webhooks/types/CreateInboxWebhookRequest.d.mts +10 -0
- package/dist/esm/api/resources/webhooks/types/CreateInboxWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/CreatePodWebhookRequest.d.mts +9 -0
- package/dist/esm/api/resources/webhooks/types/CreatePodWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/CreateWebhookEventTypes.d.mts +7 -0
- package/dist/esm/api/resources/webhooks/types/CreateWebhookEventTypes.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/CreateWebhookRequest.d.mts +1 -10
- package/dist/esm/api/resources/webhooks/types/UpdateInboxWebhookRequest.d.mts +7 -0
- package/dist/esm/api/resources/webhooks/types/UpdateInboxWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/UpdatePodWebhookRequest.d.mts +11 -0
- package/dist/esm/api/resources/webhooks/types/UpdatePodWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookEventTypes.d.mts +10 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookEventTypes.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequest.d.mts +1 -14
- package/dist/esm/api/resources/webhooks/types/index.d.mts +6 -0
- package/dist/esm/api/resources/webhooks/types/index.mjs +6 -0
- package/dist/esm/serialization/resources/drafts/types/CreateDraftForwardRequest.d.mts +30 -0
- package/dist/esm/serialization/resources/drafts/types/CreateDraftForwardRequest.mjs +26 -0
- package/dist/esm/serialization/resources/drafts/types/CreateDraftReplyAllRequest.d.mts +24 -0
- package/dist/esm/serialization/resources/drafts/types/CreateDraftReplyAllRequest.mjs +20 -0
- package/dist/esm/serialization/resources/drafts/types/CreateDraftReplyRequest.d.mts +32 -0
- package/dist/esm/serialization/resources/drafts/types/CreateDraftReplyRequest.mjs +28 -0
- package/dist/esm/serialization/resources/drafts/types/Draft.d.mts +2 -0
- package/dist/esm/serialization/resources/drafts/types/Draft.mjs +2 -0
- package/dist/esm/serialization/resources/drafts/types/DraftForwardOf.d.mts +7 -0
- package/dist/esm/serialization/resources/drafts/types/DraftForwardOf.mjs +3 -0
- package/dist/esm/serialization/resources/drafts/types/DraftItem.d.mts +2 -0
- package/dist/esm/serialization/resources/drafts/types/DraftItem.mjs +2 -0
- package/dist/esm/serialization/resources/drafts/types/DraftReplyAll.d.mts +7 -0
- package/dist/esm/serialization/resources/drafts/types/DraftReplyAll.mjs +3 -0
- package/dist/esm/serialization/resources/drafts/types/index.d.mts +5 -0
- package/dist/esm/serialization/resources/drafts/types/index.mjs +5 -0
- package/dist/esm/serialization/resources/metrics/types/MetricEventType.d.mts +1 -1
- package/dist/esm/serialization/resources/metrics/types/MetricEventType.mjs +6 -3
- package/dist/esm/serialization/resources/metrics/types/Period.d.mts +1 -1
- package/dist/esm/serialization/resources/metrics/types/Period.mjs +1 -1
- package/dist/esm/serialization/resources/metrics/types/QueryUsageResponse.d.mts +9 -0
- package/dist/esm/serialization/resources/metrics/types/QueryUsageResponse.mjs +5 -0
- package/dist/esm/serialization/resources/metrics/types/UsagePoint.d.mts +10 -0
- package/dist/esm/serialization/resources/metrics/types/UsagePoint.mjs +6 -0
- package/dist/esm/serialization/resources/metrics/types/UsageType.d.mts +7 -0
- package/dist/esm/serialization/resources/metrics/types/UsageType.mjs +10 -0
- package/dist/esm/serialization/resources/metrics/types/UsageTypes.d.mts +8 -0
- package/dist/esm/serialization/resources/metrics/types/UsageTypes.mjs +4 -0
- package/dist/esm/serialization/resources/metrics/types/index.d.mts +4 -0
- package/dist/esm/serialization/resources/metrics/types/index.mjs +4 -0
- package/dist/esm/serialization/resources/webhooks/types/CreateInboxWebhookRequest.d.mts +14 -0
- package/dist/esm/serialization/resources/webhooks/types/CreateInboxWebhookRequest.mjs +10 -0
- package/dist/esm/serialization/resources/webhooks/types/CreatePodWebhookRequest.d.mts +11 -0
- package/dist/esm/serialization/resources/webhooks/types/CreatePodWebhookRequest.mjs +9 -0
- package/dist/esm/serialization/resources/webhooks/types/CreateWebhookEventTypes.d.mts +8 -0
- package/dist/esm/serialization/resources/webhooks/types/CreateWebhookEventTypes.mjs +3 -0
- package/dist/esm/serialization/resources/webhooks/types/CreateWebhookRequest.d.mts +2 -9
- package/dist/esm/serialization/resources/webhooks/types/CreateWebhookRequest.mjs +5 -10
- package/dist/esm/serialization/resources/webhooks/types/UpdateInboxWebhookRequest.d.mts +10 -0
- package/dist/esm/serialization/resources/webhooks/types/UpdateInboxWebhookRequest.mjs +6 -0
- package/dist/esm/serialization/resources/webhooks/types/UpdatePodWebhookRequest.d.mts +12 -0
- package/dist/esm/serialization/resources/webhooks/types/UpdatePodWebhookRequest.mjs +10 -0
- package/dist/esm/serialization/resources/webhooks/types/UpdateWebhookEventTypes.d.mts +8 -0
- package/dist/esm/serialization/resources/webhooks/types/UpdateWebhookEventTypes.mjs +3 -0
- package/dist/esm/serialization/resources/webhooks/types/UpdateWebhookRequest.d.mts +2 -6
- package/dist/esm/serialization/resources/webhooks/types/UpdateWebhookRequest.mjs +5 -7
- package/dist/esm/serialization/resources/webhooks/types/index.d.mts +6 -0
- package/dist/esm/serialization/resources/webhooks/types/index.mjs +6 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms.txt +8 -4
- package/package.json +23 -1
- package/reference.md +1702 -437
- /package/dist/cjs/api/resources/{inboxes/resources/metrics/client/requests/QueryMetricsRequest.js → drafts/types/CreateDraftForwardRequest.js} +0 -0
- /package/dist/cjs/api/resources/{metrics/client/requests/QueryMetricsRequest.js → drafts/types/CreateDraftReplyAllRequest.js} +0 -0
- /package/dist/cjs/api/resources/{pods/resources/metrics/client/requests/QueryMetricsRequest.js → drafts/types/CreateDraftReplyRequest.js} +0 -0
- /package/dist/esm/api/resources/{inboxes/resources/metrics/client/requests/QueryMetricsRequest.mjs → drafts/types/CreateDraftForwardRequest.mjs} +0 -0
- /package/dist/esm/api/resources/{metrics/client/requests/QueryMetricsRequest.mjs → drafts/types/CreateDraftReplyAllRequest.mjs} +0 -0
- /package/dist/esm/api/resources/{pods/resources/metrics/client/requests/QueryMetricsRequest.mjs → drafts/types/CreateDraftReplyRequest.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -4274,8 +4274,7 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
|
|
|
4274
4274
|
</dl>
|
|
4275
4275
|
</details>
|
|
4276
4276
|
|
|
4277
|
-
|
|
4278
|
-
<details><summary><code>client.inboxes.metrics.<a href="/src/api/resources/inboxes/resources/metrics/client/Client.ts">query</a>(inbox_id, { ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
4277
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">draftReply</a>(inbox_id, message_id, { ...params }) -> AgentMail.Draft</code></summary>
|
|
4279
4278
|
<dl>
|
|
4280
4279
|
<dd>
|
|
4281
4280
|
|
|
@@ -4287,9 +4286,13 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
|
|
|
4287
4286
|
<dl>
|
|
4288
4287
|
<dd>
|
|
4289
4288
|
|
|
4289
|
+
Create a draft that replies to a message instead of sending it. The
|
|
4290
|
+
recipients, subject, and threading are derived from the source message.
|
|
4291
|
+
Send it later with `Send Draft`.
|
|
4292
|
+
|
|
4290
4293
|
**CLI:**
|
|
4291
4294
|
```bash
|
|
4292
|
-
agentmail inboxes:
|
|
4295
|
+
agentmail inboxes:messages draft-reply --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
|
|
4293
4296
|
```
|
|
4294
4297
|
</dd>
|
|
4295
4298
|
</dl>
|
|
@@ -4305,7 +4308,7 @@ agentmail inboxes:metrics query --inbox-id <inbox_id>
|
|
|
4305
4308
|
<dd>
|
|
4306
4309
|
|
|
4307
4310
|
```typescript
|
|
4308
|
-
await client.inboxes.
|
|
4311
|
+
await client.inboxes.messages.draftReply("inbox_id", "message_id", {});
|
|
4309
4312
|
|
|
4310
4313
|
```
|
|
4311
4314
|
</dd>
|
|
@@ -4329,7 +4332,7 @@ await client.inboxes.metrics.query("inbox_id");
|
|
|
4329
4332
|
<dl>
|
|
4330
4333
|
<dd>
|
|
4331
4334
|
|
|
4332
|
-
**
|
|
4335
|
+
**message_id:** `AgentMail.MessageId`
|
|
4333
4336
|
|
|
4334
4337
|
</dd>
|
|
4335
4338
|
</dl>
|
|
@@ -4337,7 +4340,15 @@ await client.inboxes.metrics.query("inbox_id");
|
|
|
4337
4340
|
<dl>
|
|
4338
4341
|
<dd>
|
|
4339
4342
|
|
|
4340
|
-
**
|
|
4343
|
+
**request:** `AgentMail.CreateDraftReplyRequest`
|
|
4344
|
+
|
|
4345
|
+
</dd>
|
|
4346
|
+
</dl>
|
|
4347
|
+
|
|
4348
|
+
<dl>
|
|
4349
|
+
<dd>
|
|
4350
|
+
|
|
4351
|
+
**requestOptions:** `MessagesClient.RequestOptions`
|
|
4341
4352
|
|
|
4342
4353
|
</dd>
|
|
4343
4354
|
</dl>
|
|
@@ -4349,8 +4360,7 @@ await client.inboxes.metrics.query("inbox_id");
|
|
|
4349
4360
|
</dl>
|
|
4350
4361
|
</details>
|
|
4351
4362
|
|
|
4352
|
-
|
|
4353
|
-
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">list</a>(inbox_id, { ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
4363
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">draftReplyAll</a>(inbox_id, message_id, { ...params }) -> AgentMail.Draft</code></summary>
|
|
4354
4364
|
<dl>
|
|
4355
4365
|
<dd>
|
|
4356
4366
|
|
|
@@ -4362,14 +4372,13 @@ await client.inboxes.metrics.query("inbox_id");
|
|
|
4362
4372
|
<dl>
|
|
4363
4373
|
<dd>
|
|
4364
4374
|
|
|
4365
|
-
|
|
4366
|
-
|
|
4367
|
-
|
|
4368
|
-
full-text search, use `Search Threads`.
|
|
4375
|
+
Create a draft that replies to every recipient of a message instead of
|
|
4376
|
+
sending it. Recipients, subject, and threading are derived from the
|
|
4377
|
+
source message. Send it later with `Send Draft`.
|
|
4369
4378
|
|
|
4370
4379
|
**CLI:**
|
|
4371
4380
|
```bash
|
|
4372
|
-
agentmail inboxes:
|
|
4381
|
+
agentmail inboxes:messages draft-reply-all --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
|
|
4373
4382
|
```
|
|
4374
4383
|
</dd>
|
|
4375
4384
|
</dl>
|
|
@@ -4385,7 +4394,7 @@ agentmail inboxes:threads list --inbox-id <inbox_id>
|
|
|
4385
4394
|
<dd>
|
|
4386
4395
|
|
|
4387
4396
|
```typescript
|
|
4388
|
-
await client.inboxes.
|
|
4397
|
+
await client.inboxes.messages.draftReplyAll("inbox_id", "message_id", {});
|
|
4389
4398
|
|
|
4390
4399
|
```
|
|
4391
4400
|
</dd>
|
|
@@ -4409,7 +4418,7 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
4409
4418
|
<dl>
|
|
4410
4419
|
<dd>
|
|
4411
4420
|
|
|
4412
|
-
**
|
|
4421
|
+
**message_id:** `AgentMail.MessageId`
|
|
4413
4422
|
|
|
4414
4423
|
</dd>
|
|
4415
4424
|
</dl>
|
|
@@ -4417,7 +4426,15 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
4417
4426
|
<dl>
|
|
4418
4427
|
<dd>
|
|
4419
4428
|
|
|
4420
|
-
**
|
|
4429
|
+
**request:** `AgentMail.CreateDraftReplyAllRequest`
|
|
4430
|
+
|
|
4431
|
+
</dd>
|
|
4432
|
+
</dl>
|
|
4433
|
+
|
|
4434
|
+
<dl>
|
|
4435
|
+
<dd>
|
|
4436
|
+
|
|
4437
|
+
**requestOptions:** `MessagesClient.RequestOptions`
|
|
4421
4438
|
|
|
4422
4439
|
</dd>
|
|
4423
4440
|
</dl>
|
|
@@ -4429,7 +4446,7 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
4429
4446
|
</dl>
|
|
4430
4447
|
</details>
|
|
4431
4448
|
|
|
4432
|
-
<details><summary><code>client.inboxes.
|
|
4449
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">draftForward</a>(inbox_id, message_id, { ...params }) -> AgentMail.Draft</code></summary>
|
|
4433
4450
|
<dl>
|
|
4434
4451
|
<dd>
|
|
4435
4452
|
|
|
@@ -4441,10 +4458,14 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
4441
4458
|
<dl>
|
|
4442
4459
|
<dd>
|
|
4443
4460
|
|
|
4444
|
-
|
|
4445
|
-
|
|
4446
|
-
|
|
4447
|
-
|
|
4461
|
+
Create a draft that forwards a message instead of sending it. The subject
|
|
4462
|
+
and threading are derived from the source message, whose body and
|
|
4463
|
+
attachments are merged in at send time. Send it later with `Send Draft`.
|
|
4464
|
+
|
|
4465
|
+
**CLI:**
|
|
4466
|
+
```bash
|
|
4467
|
+
agentmail inboxes:messages draft-forward --inbox-id <inbox_id> --message-id <message_id> --to recipient@example.com
|
|
4468
|
+
```
|
|
4448
4469
|
</dd>
|
|
4449
4470
|
</dl>
|
|
4450
4471
|
</dd>
|
|
@@ -4459,9 +4480,7 @@ unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
|
4459
4480
|
<dd>
|
|
4460
4481
|
|
|
4461
4482
|
```typescript
|
|
4462
|
-
await client.inboxes.
|
|
4463
|
-
q: "q"
|
|
4464
|
-
});
|
|
4483
|
+
await client.inboxes.messages.draftForward("inbox_id", "message_id", {});
|
|
4465
4484
|
|
|
4466
4485
|
```
|
|
4467
4486
|
</dd>
|
|
@@ -4485,7 +4504,7 @@ await client.inboxes.threads.search("inbox_id", {
|
|
|
4485
4504
|
<dl>
|
|
4486
4505
|
<dd>
|
|
4487
4506
|
|
|
4488
|
-
**
|
|
4507
|
+
**message_id:** `AgentMail.MessageId`
|
|
4489
4508
|
|
|
4490
4509
|
</dd>
|
|
4491
4510
|
</dl>
|
|
@@ -4493,7 +4512,15 @@ await client.inboxes.threads.search("inbox_id", {
|
|
|
4493
4512
|
<dl>
|
|
4494
4513
|
<dd>
|
|
4495
4514
|
|
|
4496
|
-
**
|
|
4515
|
+
**request:** `AgentMail.CreateDraftForwardRequest`
|
|
4516
|
+
|
|
4517
|
+
</dd>
|
|
4518
|
+
</dl>
|
|
4519
|
+
|
|
4520
|
+
<dl>
|
|
4521
|
+
<dd>
|
|
4522
|
+
|
|
4523
|
+
**requestOptions:** `MessagesClient.RequestOptions`
|
|
4497
4524
|
|
|
4498
4525
|
</dd>
|
|
4499
4526
|
</dl>
|
|
@@ -4505,7 +4532,8 @@ await client.inboxes.threads.search("inbox_id", {
|
|
|
4505
4532
|
</dl>
|
|
4506
4533
|
</details>
|
|
4507
4534
|
|
|
4508
|
-
|
|
4535
|
+
## Inboxes Metrics
|
|
4536
|
+
<details><summary><code>client.inboxes.metrics.<a href="/src/api/resources/inboxes/resources/metrics/client/Client.ts">queryEvents</a>(inbox_id, { ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
4509
4537
|
<dl>
|
|
4510
4538
|
<dd>
|
|
4511
4539
|
|
|
@@ -4517,9 +4545,15 @@ await client.inboxes.threads.search("inbox_id", {
|
|
|
4517
4545
|
<dl>
|
|
4518
4546
|
<dd>
|
|
4519
4547
|
|
|
4548
|
+
Counts of email events (sent, delivered, bounced, etc.) over time for
|
|
4549
|
+
the inbox. Defaults to the last 24 hours; `start` must be within the
|
|
4550
|
+
last 90 days, and a future `end` is clamped to now. Omit `period` for
|
|
4551
|
+
individual event counts, or set it to sum counts into buckets of that
|
|
4552
|
+
many seconds.
|
|
4553
|
+
|
|
4520
4554
|
**CLI:**
|
|
4521
4555
|
```bash
|
|
4522
|
-
agentmail inboxes:
|
|
4556
|
+
agentmail inboxes:metrics query --inbox-id <inbox_id>
|
|
4523
4557
|
```
|
|
4524
4558
|
</dd>
|
|
4525
4559
|
</dl>
|
|
@@ -4535,7 +4569,7 @@ agentmail inboxes:threads get --inbox-id <inbox_id> --thread-id <thread_id>
|
|
|
4535
4569
|
<dd>
|
|
4536
4570
|
|
|
4537
4571
|
```typescript
|
|
4538
|
-
await client.inboxes.
|
|
4572
|
+
await client.inboxes.metrics.queryEvents("inbox_id");
|
|
4539
4573
|
|
|
4540
4574
|
```
|
|
4541
4575
|
</dd>
|
|
@@ -4559,7 +4593,7 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
4559
4593
|
<dl>
|
|
4560
4594
|
<dd>
|
|
4561
4595
|
|
|
4562
|
-
**
|
|
4596
|
+
**request:** `AgentMail.inboxes.QueryEventsRequest`
|
|
4563
4597
|
|
|
4564
4598
|
</dd>
|
|
4565
4599
|
</dl>
|
|
@@ -4567,7 +4601,7 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
4567
4601
|
<dl>
|
|
4568
4602
|
<dd>
|
|
4569
4603
|
|
|
4570
|
-
**requestOptions:** `
|
|
4604
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
4571
4605
|
|
|
4572
4606
|
</dd>
|
|
4573
4607
|
</dl>
|
|
@@ -4579,7 +4613,7 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
4579
4613
|
</dl>
|
|
4580
4614
|
</details>
|
|
4581
4615
|
|
|
4582
|
-
<details><summary><code>client.inboxes.
|
|
4616
|
+
<details><summary><code>client.inboxes.metrics.<a href="/src/api/resources/inboxes/resources/metrics/client/Client.ts">queryUsage</a>(inbox_id, { ...params }) -> AgentMail.QueryUsageResponse</code></summary>
|
|
4583
4617
|
<dl>
|
|
4584
4618
|
<dd>
|
|
4585
4619
|
|
|
@@ -4591,10 +4625,13 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
4591
4625
|
<dl>
|
|
4592
4626
|
<dd>
|
|
4593
4627
|
|
|
4594
|
-
|
|
4595
|
-
|
|
4596
|
-
|
|
4597
|
-
|
|
4628
|
+
Cumulative usage series for the inbox. Each point is the running total
|
|
4629
|
+
of the usage type at that timestamp, not the change within the bucket.
|
|
4630
|
+
Inbox-scoped queries carry `storage_bytes`, `message_count`, and
|
|
4631
|
+
`thread_count`; requested types that don't apply to the scope are
|
|
4632
|
+
ignored. Defaults to the last 24 hours; `start` must be within the
|
|
4633
|
+
last 90 days, and a future `end` is clamped to now. The range divided
|
|
4634
|
+
by `period` must not exceed 1000 buckets.
|
|
4598
4635
|
</dd>
|
|
4599
4636
|
</dl>
|
|
4600
4637
|
</dd>
|
|
@@ -4609,7 +4646,7 @@ agentmail inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thre
|
|
|
4609
4646
|
<dd>
|
|
4610
4647
|
|
|
4611
4648
|
```typescript
|
|
4612
|
-
await client.inboxes.
|
|
4649
|
+
await client.inboxes.metrics.queryUsage("inbox_id");
|
|
4613
4650
|
|
|
4614
4651
|
```
|
|
4615
4652
|
</dd>
|
|
@@ -4633,15 +4670,7 @@ await client.inboxes.threads.getAttachment("inbox_id", "thread_id", "attachment_
|
|
|
4633
4670
|
<dl>
|
|
4634
4671
|
<dd>
|
|
4635
4672
|
|
|
4636
|
-
**
|
|
4637
|
-
|
|
4638
|
-
</dd>
|
|
4639
|
-
</dl>
|
|
4640
|
-
|
|
4641
|
-
<dl>
|
|
4642
|
-
<dd>
|
|
4643
|
-
|
|
4644
|
-
**attachment_id:** `AgentMail.AttachmentId`
|
|
4673
|
+
**request:** `AgentMail.inboxes.QueryUsageRequest`
|
|
4645
4674
|
|
|
4646
4675
|
</dd>
|
|
4647
4676
|
</dl>
|
|
@@ -4649,7 +4678,7 @@ await client.inboxes.threads.getAttachment("inbox_id", "thread_id", "attachment_
|
|
|
4649
4678
|
<dl>
|
|
4650
4679
|
<dd>
|
|
4651
4680
|
|
|
4652
|
-
**requestOptions:** `
|
|
4681
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
4653
4682
|
|
|
4654
4683
|
</dd>
|
|
4655
4684
|
</dl>
|
|
@@ -4661,7 +4690,8 @@ await client.inboxes.threads.getAttachment("inbox_id", "thread_id", "attachment_
|
|
|
4661
4690
|
</dl>
|
|
4662
4691
|
</details>
|
|
4663
4692
|
|
|
4664
|
-
|
|
4693
|
+
## Inboxes Threads
|
|
4694
|
+
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">list</a>(inbox_id, { ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
4665
4695
|
<dl>
|
|
4666
4696
|
<dd>
|
|
4667
4697
|
|
|
@@ -4673,7 +4703,15 @@ await client.inboxes.threads.getAttachment("inbox_id", "thread_id", "attachment_
|
|
|
4673
4703
|
<dl>
|
|
4674
4704
|
<dd>
|
|
4675
4705
|
|
|
4676
|
-
|
|
4706
|
+
Lists threads in the inbox, most recent first. Pass `senders`,
|
|
4707
|
+
`recipients`, or `subject` to filter by substring. Filtered requests are
|
|
4708
|
+
served by search, which caps `limit` at 100. For relevance-ranked
|
|
4709
|
+
full-text search, use `Search Threads`.
|
|
4710
|
+
|
|
4711
|
+
**CLI:**
|
|
4712
|
+
```bash
|
|
4713
|
+
agentmail inboxes:threads list --inbox-id <inbox_id>
|
|
4714
|
+
```
|
|
4677
4715
|
</dd>
|
|
4678
4716
|
</dl>
|
|
4679
4717
|
</dd>
|
|
@@ -4688,7 +4726,7 @@ Updates thread labels. Cannot add or remove system labels (sent, received, bounc
|
|
|
4688
4726
|
<dd>
|
|
4689
4727
|
|
|
4690
4728
|
```typescript
|
|
4691
|
-
await client.inboxes.threads.
|
|
4729
|
+
await client.inboxes.threads.list("inbox_id");
|
|
4692
4730
|
|
|
4693
4731
|
```
|
|
4694
4732
|
</dd>
|
|
@@ -4712,15 +4750,7 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
|
4712
4750
|
<dl>
|
|
4713
4751
|
<dd>
|
|
4714
4752
|
|
|
4715
|
-
**
|
|
4716
|
-
|
|
4717
|
-
</dd>
|
|
4718
|
-
</dl>
|
|
4719
|
-
|
|
4720
|
-
<dl>
|
|
4721
|
-
<dd>
|
|
4722
|
-
|
|
4723
|
-
**request:** `AgentMail.UpdateThreadRequest`
|
|
4753
|
+
**request:** `AgentMail.inboxes.ListThreadsRequest`
|
|
4724
4754
|
|
|
4725
4755
|
</dd>
|
|
4726
4756
|
</dl>
|
|
@@ -4740,7 +4770,7 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
|
4740
4770
|
</dl>
|
|
4741
4771
|
</details>
|
|
4742
4772
|
|
|
4743
|
-
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">
|
|
4773
|
+
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">search</a>(inbox_id, { ...params }) -> AgentMail.SearchThreadsResponse</code></summary>
|
|
4744
4774
|
<dl>
|
|
4745
4775
|
<dd>
|
|
4746
4776
|
|
|
@@ -4752,12 +4782,10 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
|
4752
4782
|
<dl>
|
|
4753
4783
|
<dd>
|
|
4754
4784
|
|
|
4755
|
-
|
|
4756
|
-
|
|
4757
|
-
|
|
4758
|
-
|
|
4759
|
-
agentmail inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>
|
|
4760
|
-
```
|
|
4785
|
+
Full-text search across threads in the inbox, ranked by relevance. The
|
|
4786
|
+
query is matched against senders, recipients, and subject (substring)
|
|
4787
|
+
and the message body (tokenized full text). Spam, trash, blocked, and
|
|
4788
|
+
unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
4761
4789
|
</dd>
|
|
4762
4790
|
</dl>
|
|
4763
4791
|
</dd>
|
|
@@ -4772,7 +4800,9 @@ agentmail inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>
|
|
|
4772
4800
|
<dd>
|
|
4773
4801
|
|
|
4774
4802
|
```typescript
|
|
4775
|
-
await client.inboxes.threads.
|
|
4803
|
+
await client.inboxes.threads.search("inbox_id", {
|
|
4804
|
+
q: "q"
|
|
4805
|
+
});
|
|
4776
4806
|
|
|
4777
4807
|
```
|
|
4778
4808
|
</dd>
|
|
@@ -4796,15 +4826,7 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
|
4796
4826
|
<dl>
|
|
4797
4827
|
<dd>
|
|
4798
4828
|
|
|
4799
|
-
**
|
|
4800
|
-
|
|
4801
|
-
</dd>
|
|
4802
|
-
</dl>
|
|
4803
|
-
|
|
4804
|
-
<dl>
|
|
4805
|
-
<dd>
|
|
4806
|
-
|
|
4807
|
-
**request:** `AgentMail.inboxes.DeleteThreadRequest`
|
|
4829
|
+
**request:** `AgentMail.inboxes.SearchThreadsRequest`
|
|
4808
4830
|
|
|
4809
4831
|
</dd>
|
|
4810
4832
|
</dl>
|
|
@@ -4824,8 +4846,7 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
|
4824
4846
|
</dl>
|
|
4825
4847
|
</details>
|
|
4826
4848
|
|
|
4827
|
-
|
|
4828
|
-
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">list</a>(direction, type, { ...params }) -> AgentMail.ListListEntriesResponse</code></summary>
|
|
4849
|
+
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">get</a>(inbox_id, thread_id) -> AgentMail.Thread</code></summary>
|
|
4829
4850
|
<dl>
|
|
4830
4851
|
<dd>
|
|
4831
4852
|
|
|
@@ -4839,7 +4860,7 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
|
4839
4860
|
|
|
4840
4861
|
**CLI:**
|
|
4841
4862
|
```bash
|
|
4842
|
-
agentmail
|
|
4863
|
+
agentmail inboxes:threads get --inbox-id <inbox_id> --thread-id <thread_id>
|
|
4843
4864
|
```
|
|
4844
4865
|
</dd>
|
|
4845
4866
|
</dl>
|
|
@@ -4855,7 +4876,7 @@ agentmail lists list --direction <direction> --type <type>
|
|
|
4855
4876
|
<dd>
|
|
4856
4877
|
|
|
4857
4878
|
```typescript
|
|
4858
|
-
await client.
|
|
4879
|
+
await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
4859
4880
|
|
|
4860
4881
|
```
|
|
4861
4882
|
</dd>
|
|
@@ -4871,15 +4892,7 @@ await client.lists.list("send", "allow");
|
|
|
4871
4892
|
<dl>
|
|
4872
4893
|
<dd>
|
|
4873
4894
|
|
|
4874
|
-
**
|
|
4875
|
-
|
|
4876
|
-
</dd>
|
|
4877
|
-
</dl>
|
|
4878
|
-
|
|
4879
|
-
<dl>
|
|
4880
|
-
<dd>
|
|
4881
|
-
|
|
4882
|
-
**type:** `AgentMail.ListType`
|
|
4895
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
4883
4896
|
|
|
4884
4897
|
</dd>
|
|
4885
4898
|
</dl>
|
|
@@ -4887,7 +4900,7 @@ await client.lists.list("send", "allow");
|
|
|
4887
4900
|
<dl>
|
|
4888
4901
|
<dd>
|
|
4889
4902
|
|
|
4890
|
-
**
|
|
4903
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
4891
4904
|
|
|
4892
4905
|
</dd>
|
|
4893
4906
|
</dl>
|
|
@@ -4895,7 +4908,7 @@ await client.lists.list("send", "allow");
|
|
|
4895
4908
|
<dl>
|
|
4896
4909
|
<dd>
|
|
4897
4910
|
|
|
4898
|
-
**requestOptions:** `
|
|
4911
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
4899
4912
|
|
|
4900
4913
|
</dd>
|
|
4901
4914
|
</dl>
|
|
@@ -4907,7 +4920,7 @@ await client.lists.list("send", "allow");
|
|
|
4907
4920
|
</dl>
|
|
4908
4921
|
</details>
|
|
4909
4922
|
|
|
4910
|
-
<details><summary><code>client.
|
|
4923
|
+
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">getAttachment</a>(inbox_id, thread_id, attachment_id) -> AgentMail.AttachmentResponse</code></summary>
|
|
4911
4924
|
<dl>
|
|
4912
4925
|
<dd>
|
|
4913
4926
|
|
|
@@ -4921,7 +4934,7 @@ await client.lists.list("send", "allow");
|
|
|
4921
4934
|
|
|
4922
4935
|
**CLI:**
|
|
4923
4936
|
```bash
|
|
4924
|
-
agentmail
|
|
4937
|
+
agentmail inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
4925
4938
|
```
|
|
4926
4939
|
</dd>
|
|
4927
4940
|
</dl>
|
|
@@ -4937,7 +4950,7 @@ agentmail lists get --direction <direction> --type <type> --entry <entry>
|
|
|
4937
4950
|
<dd>
|
|
4938
4951
|
|
|
4939
4952
|
```typescript
|
|
4940
|
-
await client.
|
|
4953
|
+
await client.inboxes.threads.getAttachment("inbox_id", "thread_id", "attachment_id");
|
|
4941
4954
|
|
|
4942
4955
|
```
|
|
4943
4956
|
</dd>
|
|
@@ -4953,7 +4966,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
4953
4966
|
<dl>
|
|
4954
4967
|
<dd>
|
|
4955
4968
|
|
|
4956
|
-
**
|
|
4969
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
4957
4970
|
|
|
4958
4971
|
</dd>
|
|
4959
4972
|
</dl>
|
|
@@ -4961,7 +4974,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
4961
4974
|
<dl>
|
|
4962
4975
|
<dd>
|
|
4963
4976
|
|
|
4964
|
-
**
|
|
4977
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
4965
4978
|
|
|
4966
4979
|
</dd>
|
|
4967
4980
|
</dl>
|
|
@@ -4969,7 +4982,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
4969
4982
|
<dl>
|
|
4970
4983
|
<dd>
|
|
4971
4984
|
|
|
4972
|
-
**
|
|
4985
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
4973
4986
|
|
|
4974
4987
|
</dd>
|
|
4975
4988
|
</dl>
|
|
@@ -4977,7 +4990,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
4977
4990
|
<dl>
|
|
4978
4991
|
<dd>
|
|
4979
4992
|
|
|
4980
|
-
**requestOptions:** `
|
|
4993
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
4981
4994
|
|
|
4982
4995
|
</dd>
|
|
4983
4996
|
</dl>
|
|
@@ -4989,7 +5002,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
4989
5002
|
</dl>
|
|
4990
5003
|
</details>
|
|
4991
5004
|
|
|
4992
|
-
<details><summary><code>client.
|
|
5005
|
+
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">update</a>(inbox_id, thread_id, { ...params }) -> AgentMail.UpdateThreadResponse</code></summary>
|
|
4993
5006
|
<dl>
|
|
4994
5007
|
<dd>
|
|
4995
5008
|
|
|
@@ -5001,10 +5014,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
5001
5014
|
<dl>
|
|
5002
5015
|
<dd>
|
|
5003
5016
|
|
|
5004
|
-
|
|
5005
|
-
```bash
|
|
5006
|
-
agentmail lists create --direction <direction> --type <type> --entry user@example.com
|
|
5007
|
-
```
|
|
5017
|
+
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.
|
|
5008
5018
|
</dd>
|
|
5009
5019
|
</dl>
|
|
5010
5020
|
</dd>
|
|
@@ -5019,9 +5029,7 @@ agentmail lists create --direction <direction> --type <type> --entry user@exampl
|
|
|
5019
5029
|
<dd>
|
|
5020
5030
|
|
|
5021
5031
|
```typescript
|
|
5022
|
-
await client.
|
|
5023
|
-
entry: "entry"
|
|
5024
|
-
});
|
|
5032
|
+
await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
5025
5033
|
|
|
5026
5034
|
```
|
|
5027
5035
|
</dd>
|
|
@@ -5037,7 +5045,7 @@ await client.lists.create("send", "allow", {
|
|
|
5037
5045
|
<dl>
|
|
5038
5046
|
<dd>
|
|
5039
5047
|
|
|
5040
|
-
**
|
|
5048
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5041
5049
|
|
|
5042
5050
|
</dd>
|
|
5043
5051
|
</dl>
|
|
@@ -5045,7 +5053,7 @@ await client.lists.create("send", "allow", {
|
|
|
5045
5053
|
<dl>
|
|
5046
5054
|
<dd>
|
|
5047
5055
|
|
|
5048
|
-
**
|
|
5056
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
5049
5057
|
|
|
5050
5058
|
</dd>
|
|
5051
5059
|
</dl>
|
|
@@ -5053,7 +5061,7 @@ await client.lists.create("send", "allow", {
|
|
|
5053
5061
|
<dl>
|
|
5054
5062
|
<dd>
|
|
5055
5063
|
|
|
5056
|
-
**request:** `AgentMail.
|
|
5064
|
+
**request:** `AgentMail.UpdateThreadRequest`
|
|
5057
5065
|
|
|
5058
5066
|
</dd>
|
|
5059
5067
|
</dl>
|
|
@@ -5061,7 +5069,7 @@ await client.lists.create("send", "allow", {
|
|
|
5061
5069
|
<dl>
|
|
5062
5070
|
<dd>
|
|
5063
5071
|
|
|
5064
|
-
**requestOptions:** `
|
|
5072
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
5065
5073
|
|
|
5066
5074
|
</dd>
|
|
5067
5075
|
</dl>
|
|
@@ -5073,7 +5081,7 @@ await client.lists.create("send", "allow", {
|
|
|
5073
5081
|
</dl>
|
|
5074
5082
|
</details>
|
|
5075
5083
|
|
|
5076
|
-
<details><summary><code>client.
|
|
5084
|
+
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">delete</a>(inbox_id, thread_id, { ...params }) -> void</code></summary>
|
|
5077
5085
|
<dl>
|
|
5078
5086
|
<dd>
|
|
5079
5087
|
|
|
@@ -5085,9 +5093,11 @@ await client.lists.create("send", "allow", {
|
|
|
5085
5093
|
<dl>
|
|
5086
5094
|
<dd>
|
|
5087
5095
|
|
|
5096
|
+
Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
|
|
5097
|
+
|
|
5088
5098
|
**CLI:**
|
|
5089
5099
|
```bash
|
|
5090
|
-
agentmail
|
|
5100
|
+
agentmail inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>
|
|
5091
5101
|
```
|
|
5092
5102
|
</dd>
|
|
5093
5103
|
</dl>
|
|
@@ -5103,7 +5113,7 @@ agentmail lists delete --direction <direction> --type <type> --entry <entry>
|
|
|
5103
5113
|
<dd>
|
|
5104
5114
|
|
|
5105
5115
|
```typescript
|
|
5106
|
-
await client.
|
|
5116
|
+
await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
5107
5117
|
|
|
5108
5118
|
```
|
|
5109
5119
|
</dd>
|
|
@@ -5119,7 +5129,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
5119
5129
|
<dl>
|
|
5120
5130
|
<dd>
|
|
5121
5131
|
|
|
5122
|
-
**
|
|
5132
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5123
5133
|
|
|
5124
5134
|
</dd>
|
|
5125
5135
|
</dl>
|
|
@@ -5127,7 +5137,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
5127
5137
|
<dl>
|
|
5128
5138
|
<dd>
|
|
5129
5139
|
|
|
5130
|
-
**
|
|
5140
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
5131
5141
|
|
|
5132
5142
|
</dd>
|
|
5133
5143
|
</dl>
|
|
@@ -5135,7 +5145,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
5135
5145
|
<dl>
|
|
5136
5146
|
<dd>
|
|
5137
5147
|
|
|
5138
|
-
**
|
|
5148
|
+
**request:** `AgentMail.inboxes.DeleteThreadRequest`
|
|
5139
5149
|
|
|
5140
5150
|
</dd>
|
|
5141
5151
|
</dl>
|
|
@@ -5143,7 +5153,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
5143
5153
|
<dl>
|
|
5144
5154
|
<dd>
|
|
5145
5155
|
|
|
5146
|
-
**requestOptions:** `
|
|
5156
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
5147
5157
|
|
|
5148
5158
|
</dd>
|
|
5149
5159
|
</dl>
|
|
@@ -5155,8 +5165,8 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
5155
5165
|
</dl>
|
|
5156
5166
|
</details>
|
|
5157
5167
|
|
|
5158
|
-
##
|
|
5159
|
-
<details><summary><code>client.
|
|
5168
|
+
## Inboxes Webhooks
|
|
5169
|
+
<details><summary><code>client.inboxes.webhooks.<a href="/src/api/resources/inboxes/resources/webhooks/client/Client.ts">list</a>(inbox_id, { ...params }) -> AgentMail.ListWebhooksResponse</code></summary>
|
|
5160
5170
|
<dl>
|
|
5161
5171
|
<dd>
|
|
5162
5172
|
|
|
@@ -5170,7 +5180,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
5170
5180
|
|
|
5171
5181
|
**CLI:**
|
|
5172
5182
|
```bash
|
|
5173
|
-
agentmail
|
|
5183
|
+
agentmail inboxes:webhooks list --inbox-id <inbox_id>
|
|
5174
5184
|
```
|
|
5175
5185
|
</dd>
|
|
5176
5186
|
</dl>
|
|
@@ -5186,7 +5196,7 @@ agentmail metrics list
|
|
|
5186
5196
|
<dd>
|
|
5187
5197
|
|
|
5188
5198
|
```typescript
|
|
5189
|
-
await client.
|
|
5199
|
+
await client.inboxes.webhooks.list("inbox_id");
|
|
5190
5200
|
|
|
5191
5201
|
```
|
|
5192
5202
|
</dd>
|
|
@@ -5202,7 +5212,7 @@ await client.metrics.query();
|
|
|
5202
5212
|
<dl>
|
|
5203
5213
|
<dd>
|
|
5204
5214
|
|
|
5205
|
-
**
|
|
5215
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5206
5216
|
|
|
5207
5217
|
</dd>
|
|
5208
5218
|
</dl>
|
|
@@ -5210,7 +5220,15 @@ await client.metrics.query();
|
|
|
5210
5220
|
<dl>
|
|
5211
5221
|
<dd>
|
|
5212
5222
|
|
|
5213
|
-
**
|
|
5223
|
+
**request:** `AgentMail.inboxes.InboxListWebhooksRequest`
|
|
5224
|
+
|
|
5225
|
+
</dd>
|
|
5226
|
+
</dl>
|
|
5227
|
+
|
|
5228
|
+
<dl>
|
|
5229
|
+
<dd>
|
|
5230
|
+
|
|
5231
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
5214
5232
|
|
|
5215
5233
|
</dd>
|
|
5216
5234
|
</dl>
|
|
@@ -5222,8 +5240,7 @@ await client.metrics.query();
|
|
|
5222
5240
|
</dl>
|
|
5223
5241
|
</details>
|
|
5224
5242
|
|
|
5225
|
-
|
|
5226
|
-
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">get</a>() -> AgentMail.Organization</code></summary>
|
|
5243
|
+
<details><summary><code>client.inboxes.webhooks.<a href="/src/api/resources/inboxes/resources/webhooks/client/Client.ts">get</a>(inbox_id, webhook_id) -> AgentMail.Webhook</code></summary>
|
|
5227
5244
|
<dl>
|
|
5228
5245
|
<dd>
|
|
5229
5246
|
|
|
@@ -5235,11 +5252,9 @@ await client.metrics.query();
|
|
|
5235
5252
|
<dl>
|
|
5236
5253
|
<dd>
|
|
5237
5254
|
|
|
5238
|
-
Returns the organization for the authenticated API key (usage limits, counts, and billing metadata).
|
|
5239
|
-
|
|
5240
5255
|
**CLI:**
|
|
5241
5256
|
```bash
|
|
5242
|
-
agentmail
|
|
5257
|
+
agentmail inboxes:webhooks get --inbox-id <inbox_id> --webhook-id <webhook_id>
|
|
5243
5258
|
```
|
|
5244
5259
|
</dd>
|
|
5245
5260
|
</dl>
|
|
@@ -5255,7 +5270,7 @@ agentmail organizations get
|
|
|
5255
5270
|
<dd>
|
|
5256
5271
|
|
|
5257
5272
|
```typescript
|
|
5258
|
-
await client.
|
|
5273
|
+
await client.inboxes.webhooks.get("inbox_id", "webhook_id");
|
|
5259
5274
|
|
|
5260
5275
|
```
|
|
5261
5276
|
</dd>
|
|
@@ -5271,7 +5286,23 @@ await client.organizations.get();
|
|
|
5271
5286
|
<dl>
|
|
5272
5287
|
<dd>
|
|
5273
5288
|
|
|
5274
|
-
**
|
|
5289
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5290
|
+
|
|
5291
|
+
</dd>
|
|
5292
|
+
</dl>
|
|
5293
|
+
|
|
5294
|
+
<dl>
|
|
5295
|
+
<dd>
|
|
5296
|
+
|
|
5297
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
5298
|
+
|
|
5299
|
+
</dd>
|
|
5300
|
+
</dl>
|
|
5301
|
+
|
|
5302
|
+
<dl>
|
|
5303
|
+
<dd>
|
|
5304
|
+
|
|
5305
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
5275
5306
|
|
|
5276
5307
|
</dd>
|
|
5277
5308
|
</dl>
|
|
@@ -5283,8 +5314,7 @@ await client.organizations.get();
|
|
|
5283
5314
|
</dl>
|
|
5284
5315
|
</details>
|
|
5285
5316
|
|
|
5286
|
-
|
|
5287
|
-
<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>
|
|
5317
|
+
<details><summary><code>client.inboxes.webhooks.<a href="/src/api/resources/inboxes/resources/webhooks/client/Client.ts">create</a>(inbox_id, { ...params }) -> AgentMail.Webhook</code></summary>
|
|
5288
5318
|
<dl>
|
|
5289
5319
|
<dd>
|
|
5290
5320
|
|
|
@@ -5296,9 +5326,11 @@ await client.organizations.get();
|
|
|
5296
5326
|
<dl>
|
|
5297
5327
|
<dd>
|
|
5298
5328
|
|
|
5329
|
+
Create a webhook scoped to this inbox.
|
|
5330
|
+
|
|
5299
5331
|
**CLI:**
|
|
5300
5332
|
```bash
|
|
5301
|
-
agentmail
|
|
5333
|
+
agentmail inboxes:webhooks create --inbox-id <inbox_id> --url https://example.com/webhook --event-type message.received
|
|
5302
5334
|
```
|
|
5303
5335
|
</dd>
|
|
5304
5336
|
</dl>
|
|
@@ -5314,7 +5346,10 @@ agentmail pods:api-keys list --pod-id <pod_id>
|
|
|
5314
5346
|
<dd>
|
|
5315
5347
|
|
|
5316
5348
|
```typescript
|
|
5317
|
-
await client.
|
|
5349
|
+
await client.inboxes.webhooks.create("inbox_id", {
|
|
5350
|
+
url: "url",
|
|
5351
|
+
eventTypes: ["message.received", "message.received"]
|
|
5352
|
+
});
|
|
5318
5353
|
|
|
5319
5354
|
```
|
|
5320
5355
|
</dd>
|
|
@@ -5330,7 +5365,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
5330
5365
|
<dl>
|
|
5331
5366
|
<dd>
|
|
5332
5367
|
|
|
5333
|
-
**
|
|
5368
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5334
5369
|
|
|
5335
5370
|
</dd>
|
|
5336
5371
|
</dl>
|
|
@@ -5338,7 +5373,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
5338
5373
|
<dl>
|
|
5339
5374
|
<dd>
|
|
5340
5375
|
|
|
5341
|
-
**request:** `AgentMail.
|
|
5376
|
+
**request:** `AgentMail.CreateInboxWebhookRequest`
|
|
5342
5377
|
|
|
5343
5378
|
</dd>
|
|
5344
5379
|
</dl>
|
|
@@ -5346,7 +5381,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
5346
5381
|
<dl>
|
|
5347
5382
|
<dd>
|
|
5348
5383
|
|
|
5349
|
-
**requestOptions:** `
|
|
5384
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
5350
5385
|
|
|
5351
5386
|
</dd>
|
|
5352
5387
|
</dl>
|
|
@@ -5358,7 +5393,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
5358
5393
|
</dl>
|
|
5359
5394
|
</details>
|
|
5360
5395
|
|
|
5361
|
-
<details><summary><code>client.
|
|
5396
|
+
<details><summary><code>client.inboxes.webhooks.<a href="/src/api/resources/inboxes/resources/webhooks/client/Client.ts">update</a>(inbox_id, webhook_id, { ...params }) -> AgentMail.Webhook</code></summary>
|
|
5362
5397
|
<dl>
|
|
5363
5398
|
<dd>
|
|
5364
5399
|
|
|
@@ -5372,7 +5407,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
5372
5407
|
|
|
5373
5408
|
**CLI:**
|
|
5374
5409
|
```bash
|
|
5375
|
-
agentmail
|
|
5410
|
+
agentmail inboxes:webhooks update --inbox-id <inbox_id> --webhook-id <webhook_id> --event-type message.received
|
|
5376
5411
|
```
|
|
5377
5412
|
</dd>
|
|
5378
5413
|
</dl>
|
|
@@ -5388,7 +5423,7 @@ agentmail pods:api-keys create --pod-id <pod_id> --name "My Key"
|
|
|
5388
5423
|
<dd>
|
|
5389
5424
|
|
|
5390
5425
|
```typescript
|
|
5391
|
-
await client.
|
|
5426
|
+
await client.inboxes.webhooks.update("inbox_id", "webhook_id", {});
|
|
5392
5427
|
|
|
5393
5428
|
```
|
|
5394
5429
|
</dd>
|
|
@@ -5404,7 +5439,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
5404
5439
|
<dl>
|
|
5405
5440
|
<dd>
|
|
5406
5441
|
|
|
5407
|
-
**
|
|
5442
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5408
5443
|
|
|
5409
5444
|
</dd>
|
|
5410
5445
|
</dl>
|
|
@@ -5412,7 +5447,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
5412
5447
|
<dl>
|
|
5413
5448
|
<dd>
|
|
5414
5449
|
|
|
5415
|
-
**
|
|
5450
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
5416
5451
|
|
|
5417
5452
|
</dd>
|
|
5418
5453
|
</dl>
|
|
@@ -5420,7 +5455,15 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
5420
5455
|
<dl>
|
|
5421
5456
|
<dd>
|
|
5422
5457
|
|
|
5423
|
-
**
|
|
5458
|
+
**request:** `AgentMail.UpdateInboxWebhookRequest`
|
|
5459
|
+
|
|
5460
|
+
</dd>
|
|
5461
|
+
</dl>
|
|
5462
|
+
|
|
5463
|
+
<dl>
|
|
5464
|
+
<dd>
|
|
5465
|
+
|
|
5466
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
5424
5467
|
|
|
5425
5468
|
</dd>
|
|
5426
5469
|
</dl>
|
|
@@ -5432,7 +5475,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
5432
5475
|
</dl>
|
|
5433
5476
|
</details>
|
|
5434
5477
|
|
|
5435
|
-
<details><summary><code>client.
|
|
5478
|
+
<details><summary><code>client.inboxes.webhooks.<a href="/src/api/resources/inboxes/resources/webhooks/client/Client.ts">delete</a>(inbox_id, webhook_id) -> void</code></summary>
|
|
5436
5479
|
<dl>
|
|
5437
5480
|
<dd>
|
|
5438
5481
|
|
|
@@ -5446,7 +5489,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
5446
5489
|
|
|
5447
5490
|
**CLI:**
|
|
5448
5491
|
```bash
|
|
5449
|
-
agentmail
|
|
5492
|
+
agentmail inboxes:webhooks delete --inbox-id <inbox_id> --webhook-id <webhook_id>
|
|
5450
5493
|
```
|
|
5451
5494
|
</dd>
|
|
5452
5495
|
</dl>
|
|
@@ -5462,7 +5505,7 @@ agentmail pods:api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
|
|
|
5462
5505
|
<dd>
|
|
5463
5506
|
|
|
5464
5507
|
```typescript
|
|
5465
|
-
await client.
|
|
5508
|
+
await client.inboxes.webhooks.delete("inbox_id", "webhook_id");
|
|
5466
5509
|
|
|
5467
5510
|
```
|
|
5468
5511
|
</dd>
|
|
@@ -5478,7 +5521,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
5478
5521
|
<dl>
|
|
5479
5522
|
<dd>
|
|
5480
5523
|
|
|
5481
|
-
**
|
|
5524
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5482
5525
|
|
|
5483
5526
|
</dd>
|
|
5484
5527
|
</dl>
|
|
@@ -5486,7 +5529,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
5486
5529
|
<dl>
|
|
5487
5530
|
<dd>
|
|
5488
5531
|
|
|
5489
|
-
**
|
|
5532
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
5490
5533
|
|
|
5491
5534
|
</dd>
|
|
5492
5535
|
</dl>
|
|
@@ -5494,7 +5537,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
5494
5537
|
<dl>
|
|
5495
5538
|
<dd>
|
|
5496
5539
|
|
|
5497
|
-
**requestOptions:** `
|
|
5540
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
5498
5541
|
|
|
5499
5542
|
</dd>
|
|
5500
5543
|
</dl>
|
|
@@ -5506,8 +5549,8 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
5506
5549
|
</dl>
|
|
5507
5550
|
</details>
|
|
5508
5551
|
|
|
5509
|
-
##
|
|
5510
|
-
<details><summary><code>client.
|
|
5552
|
+
## Lists
|
|
5553
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">list</a>(direction, type, { ...params }) -> AgentMail.ListListEntriesResponse</code></summary>
|
|
5511
5554
|
<dl>
|
|
5512
5555
|
<dd>
|
|
5513
5556
|
|
|
@@ -5521,7 +5564,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
5521
5564
|
|
|
5522
5565
|
**CLI:**
|
|
5523
5566
|
```bash
|
|
5524
|
-
agentmail
|
|
5567
|
+
agentmail lists list --direction <direction> --type <type>
|
|
5525
5568
|
```
|
|
5526
5569
|
</dd>
|
|
5527
5570
|
</dl>
|
|
@@ -5537,7 +5580,7 @@ agentmail pods:domains list --pod-id <pod_id>
|
|
|
5537
5580
|
<dd>
|
|
5538
5581
|
|
|
5539
5582
|
```typescript
|
|
5540
|
-
await client.
|
|
5583
|
+
await client.lists.list("send", "allow");
|
|
5541
5584
|
|
|
5542
5585
|
```
|
|
5543
5586
|
</dd>
|
|
@@ -5553,7 +5596,7 @@ await client.pods.domains.list("pod_id");
|
|
|
5553
5596
|
<dl>
|
|
5554
5597
|
<dd>
|
|
5555
5598
|
|
|
5556
|
-
**
|
|
5599
|
+
**direction:** `AgentMail.Direction`
|
|
5557
5600
|
|
|
5558
5601
|
</dd>
|
|
5559
5602
|
</dl>
|
|
@@ -5561,7 +5604,7 @@ await client.pods.domains.list("pod_id");
|
|
|
5561
5604
|
<dl>
|
|
5562
5605
|
<dd>
|
|
5563
5606
|
|
|
5564
|
-
**
|
|
5607
|
+
**type:** `AgentMail.ListType`
|
|
5565
5608
|
|
|
5566
5609
|
</dd>
|
|
5567
5610
|
</dl>
|
|
@@ -5569,7 +5612,15 @@ await client.pods.domains.list("pod_id");
|
|
|
5569
5612
|
<dl>
|
|
5570
5613
|
<dd>
|
|
5571
5614
|
|
|
5572
|
-
**
|
|
5615
|
+
**request:** `AgentMail.ListListEntriesRequest`
|
|
5616
|
+
|
|
5617
|
+
</dd>
|
|
5618
|
+
</dl>
|
|
5619
|
+
|
|
5620
|
+
<dl>
|
|
5621
|
+
<dd>
|
|
5622
|
+
|
|
5623
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
5573
5624
|
|
|
5574
5625
|
</dd>
|
|
5575
5626
|
</dl>
|
|
@@ -5581,7 +5632,7 @@ await client.pods.domains.list("pod_id");
|
|
|
5581
5632
|
</dl>
|
|
5582
5633
|
</details>
|
|
5583
5634
|
|
|
5584
|
-
<details><summary><code>client.
|
|
5635
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">get</a>(direction, type, entry) -> AgentMail.ListEntry</code></summary>
|
|
5585
5636
|
<dl>
|
|
5586
5637
|
<dd>
|
|
5587
5638
|
|
|
@@ -5595,7 +5646,7 @@ await client.pods.domains.list("pod_id");
|
|
|
5595
5646
|
|
|
5596
5647
|
**CLI:**
|
|
5597
5648
|
```bash
|
|
5598
|
-
agentmail
|
|
5649
|
+
agentmail lists get --direction <direction> --type <type> --entry <entry>
|
|
5599
5650
|
```
|
|
5600
5651
|
</dd>
|
|
5601
5652
|
</dl>
|
|
@@ -5611,7 +5662,7 @@ agentmail pods:domains get --pod-id <pod_id> --domain-id <domain_id>
|
|
|
5611
5662
|
<dd>
|
|
5612
5663
|
|
|
5613
5664
|
```typescript
|
|
5614
|
-
await client.
|
|
5665
|
+
await client.lists.get("send", "allow", "entry");
|
|
5615
5666
|
|
|
5616
5667
|
```
|
|
5617
5668
|
</dd>
|
|
@@ -5627,7 +5678,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
5627
5678
|
<dl>
|
|
5628
5679
|
<dd>
|
|
5629
5680
|
|
|
5630
|
-
**
|
|
5681
|
+
**direction:** `AgentMail.Direction`
|
|
5631
5682
|
|
|
5632
5683
|
</dd>
|
|
5633
5684
|
</dl>
|
|
@@ -5635,7 +5686,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
5635
5686
|
<dl>
|
|
5636
5687
|
<dd>
|
|
5637
5688
|
|
|
5638
|
-
**
|
|
5689
|
+
**type:** `AgentMail.ListType`
|
|
5639
5690
|
|
|
5640
5691
|
</dd>
|
|
5641
5692
|
</dl>
|
|
@@ -5643,7 +5694,15 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
5643
5694
|
<dl>
|
|
5644
5695
|
<dd>
|
|
5645
5696
|
|
|
5646
|
-
**
|
|
5697
|
+
**entry:** `string` — Email address or domain.
|
|
5698
|
+
|
|
5699
|
+
</dd>
|
|
5700
|
+
</dl>
|
|
5701
|
+
|
|
5702
|
+
<dl>
|
|
5703
|
+
<dd>
|
|
5704
|
+
|
|
5705
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
5647
5706
|
|
|
5648
5707
|
</dd>
|
|
5649
5708
|
</dl>
|
|
@@ -5655,7 +5714,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
5655
5714
|
</dl>
|
|
5656
5715
|
</details>
|
|
5657
5716
|
|
|
5658
|
-
<details><summary><code>client.
|
|
5717
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">create</a>(direction, type, { ...params }) -> AgentMail.ListEntry</code></summary>
|
|
5659
5718
|
<dl>
|
|
5660
5719
|
<dd>
|
|
5661
5720
|
|
|
@@ -5669,7 +5728,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
5669
5728
|
|
|
5670
5729
|
**CLI:**
|
|
5671
5730
|
```bash
|
|
5672
|
-
agentmail
|
|
5731
|
+
agentmail lists create --direction <direction> --type <type> --entry user@example.com
|
|
5673
5732
|
```
|
|
5674
5733
|
</dd>
|
|
5675
5734
|
</dl>
|
|
@@ -5685,7 +5744,9 @@ agentmail pods:domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
|
|
|
5685
5744
|
<dd>
|
|
5686
5745
|
|
|
5687
5746
|
```typescript
|
|
5688
|
-
await client.
|
|
5747
|
+
await client.lists.create("send", "allow", {
|
|
5748
|
+
entry: "entry"
|
|
5749
|
+
});
|
|
5689
5750
|
|
|
5690
5751
|
```
|
|
5691
5752
|
</dd>
|
|
@@ -5701,7 +5762,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
5701
5762
|
<dl>
|
|
5702
5763
|
<dd>
|
|
5703
5764
|
|
|
5704
|
-
**
|
|
5765
|
+
**direction:** `AgentMail.Direction`
|
|
5705
5766
|
|
|
5706
5767
|
</dd>
|
|
5707
5768
|
</dl>
|
|
@@ -5709,7 +5770,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
5709
5770
|
<dl>
|
|
5710
5771
|
<dd>
|
|
5711
5772
|
|
|
5712
|
-
**
|
|
5773
|
+
**type:** `AgentMail.ListType`
|
|
5713
5774
|
|
|
5714
5775
|
</dd>
|
|
5715
5776
|
</dl>
|
|
@@ -5717,7 +5778,15 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
5717
5778
|
<dl>
|
|
5718
5779
|
<dd>
|
|
5719
5780
|
|
|
5720
|
-
**
|
|
5781
|
+
**request:** `AgentMail.CreateListEntryRequest`
|
|
5782
|
+
|
|
5783
|
+
</dd>
|
|
5784
|
+
</dl>
|
|
5785
|
+
|
|
5786
|
+
<dl>
|
|
5787
|
+
<dd>
|
|
5788
|
+
|
|
5789
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
5721
5790
|
|
|
5722
5791
|
</dd>
|
|
5723
5792
|
</dl>
|
|
@@ -5729,7 +5798,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
5729
5798
|
</dl>
|
|
5730
5799
|
</details>
|
|
5731
5800
|
|
|
5732
|
-
<details><summary><code>client.
|
|
5801
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">delete</a>(direction, type, entry) -> void</code></summary>
|
|
5733
5802
|
<dl>
|
|
5734
5803
|
<dd>
|
|
5735
5804
|
|
|
@@ -5743,7 +5812,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
5743
5812
|
|
|
5744
5813
|
**CLI:**
|
|
5745
5814
|
```bash
|
|
5746
|
-
agentmail
|
|
5815
|
+
agentmail lists delete --direction <direction> --type <type> --entry <entry>
|
|
5747
5816
|
```
|
|
5748
5817
|
</dd>
|
|
5749
5818
|
</dl>
|
|
@@ -5759,9 +5828,7 @@ agentmail pods:domains create --pod-id <pod_id> --domain example.com
|
|
|
5759
5828
|
<dd>
|
|
5760
5829
|
|
|
5761
5830
|
```typescript
|
|
5762
|
-
await client.
|
|
5763
|
-
domain: "domain"
|
|
5764
|
-
});
|
|
5831
|
+
await client.lists.delete("send", "allow", "entry");
|
|
5765
5832
|
|
|
5766
5833
|
```
|
|
5767
5834
|
</dd>
|
|
@@ -5777,7 +5844,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
5777
5844
|
<dl>
|
|
5778
5845
|
<dd>
|
|
5779
5846
|
|
|
5780
|
-
**
|
|
5847
|
+
**direction:** `AgentMail.Direction`
|
|
5781
5848
|
|
|
5782
5849
|
</dd>
|
|
5783
5850
|
</dl>
|
|
@@ -5785,7 +5852,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
5785
5852
|
<dl>
|
|
5786
5853
|
<dd>
|
|
5787
5854
|
|
|
5788
|
-
**
|
|
5855
|
+
**type:** `AgentMail.ListType`
|
|
5789
5856
|
|
|
5790
5857
|
</dd>
|
|
5791
5858
|
</dl>
|
|
@@ -5793,7 +5860,15 @@ await client.pods.domains.create("pod_id", {
|
|
|
5793
5860
|
<dl>
|
|
5794
5861
|
<dd>
|
|
5795
5862
|
|
|
5796
|
-
**
|
|
5863
|
+
**entry:** `string` — Email address or domain.
|
|
5864
|
+
|
|
5865
|
+
</dd>
|
|
5866
|
+
</dl>
|
|
5867
|
+
|
|
5868
|
+
<dl>
|
|
5869
|
+
<dd>
|
|
5870
|
+
|
|
5871
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
5797
5872
|
|
|
5798
5873
|
</dd>
|
|
5799
5874
|
</dl>
|
|
@@ -5805,7 +5880,8 @@ await client.pods.domains.create("pod_id", {
|
|
|
5805
5880
|
</dl>
|
|
5806
5881
|
</details>
|
|
5807
5882
|
|
|
5808
|
-
|
|
5883
|
+
## Metrics
|
|
5884
|
+
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryEvents</a>({ ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
5809
5885
|
<dl>
|
|
5810
5886
|
<dd>
|
|
5811
5887
|
|
|
@@ -5817,9 +5893,15 @@ await client.pods.domains.create("pod_id", {
|
|
|
5817
5893
|
<dl>
|
|
5818
5894
|
<dd>
|
|
5819
5895
|
|
|
5896
|
+
Counts of email events (sent, delivered, bounced, etc.) over time for
|
|
5897
|
+
the organization. Defaults to the last 24 hours; `start` must be within
|
|
5898
|
+
the last 90 days, and a future `end` is clamped to now. Omit `period`
|
|
5899
|
+
for individual event counts, or set it to sum counts into buckets of
|
|
5900
|
+
that many seconds.
|
|
5901
|
+
|
|
5820
5902
|
**CLI:**
|
|
5821
5903
|
```bash
|
|
5822
|
-
agentmail
|
|
5904
|
+
agentmail metrics list
|
|
5823
5905
|
```
|
|
5824
5906
|
</dd>
|
|
5825
5907
|
</dl>
|
|
@@ -5835,7 +5917,7 @@ agentmail pods:domains update --pod-id <pod_id> --domain-id <domain_id>
|
|
|
5835
5917
|
<dd>
|
|
5836
5918
|
|
|
5837
5919
|
```typescript
|
|
5838
|
-
await client.
|
|
5920
|
+
await client.metrics.queryEvents();
|
|
5839
5921
|
|
|
5840
5922
|
```
|
|
5841
5923
|
</dd>
|
|
@@ -5851,23 +5933,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
5851
5933
|
<dl>
|
|
5852
5934
|
<dd>
|
|
5853
5935
|
|
|
5854
|
-
**
|
|
5855
|
-
|
|
5856
|
-
</dd>
|
|
5857
|
-
</dl>
|
|
5858
|
-
|
|
5859
|
-
<dl>
|
|
5860
|
-
<dd>
|
|
5861
|
-
|
|
5862
|
-
**domain_id:** `AgentMail.DomainId`
|
|
5863
|
-
|
|
5864
|
-
</dd>
|
|
5865
|
-
</dl>
|
|
5866
|
-
|
|
5867
|
-
<dl>
|
|
5868
|
-
<dd>
|
|
5869
|
-
|
|
5870
|
-
**request:** `AgentMail.UpdateDomainRequest`
|
|
5936
|
+
**request:** `AgentMail.QueryEventsRequest`
|
|
5871
5937
|
|
|
5872
5938
|
</dd>
|
|
5873
5939
|
</dl>
|
|
@@ -5875,7 +5941,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
5875
5941
|
<dl>
|
|
5876
5942
|
<dd>
|
|
5877
5943
|
|
|
5878
|
-
**requestOptions:** `
|
|
5944
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
5879
5945
|
|
|
5880
5946
|
</dd>
|
|
5881
5947
|
</dl>
|
|
@@ -5887,7 +5953,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
5887
5953
|
</dl>
|
|
5888
5954
|
</details>
|
|
5889
5955
|
|
|
5890
|
-
<details><summary><code>client.
|
|
5956
|
+
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryUsage</a>({ ...params }) -> AgentMail.QueryUsageResponse</code></summary>
|
|
5891
5957
|
<dl>
|
|
5892
5958
|
<dd>
|
|
5893
5959
|
|
|
@@ -5899,10 +5965,11 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
5899
5965
|
<dl>
|
|
5900
5966
|
<dd>
|
|
5901
5967
|
|
|
5902
|
-
|
|
5903
|
-
|
|
5904
|
-
|
|
5905
|
-
|
|
5968
|
+
Cumulative usage series for the organization. Each point is the running
|
|
5969
|
+
total of the usage type at that timestamp, not the change within the
|
|
5970
|
+
bucket. Defaults to the last 24 hours; `start` must be within the last
|
|
5971
|
+
90 days, and a future `end` is clamped to now. The range divided by
|
|
5972
|
+
`period` must not exceed 1000 buckets.
|
|
5906
5973
|
</dd>
|
|
5907
5974
|
</dl>
|
|
5908
5975
|
</dd>
|
|
@@ -5917,7 +5984,7 @@ agentmail pods:domains delete --pod-id <pod_id> --domain-id <domain_id>
|
|
|
5917
5984
|
<dd>
|
|
5918
5985
|
|
|
5919
5986
|
```typescript
|
|
5920
|
-
await client.
|
|
5987
|
+
await client.metrics.queryUsage();
|
|
5921
5988
|
|
|
5922
5989
|
```
|
|
5923
5990
|
</dd>
|
|
@@ -5933,15 +6000,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
5933
6000
|
<dl>
|
|
5934
6001
|
<dd>
|
|
5935
6002
|
|
|
5936
|
-
**
|
|
5937
|
-
|
|
5938
|
-
</dd>
|
|
5939
|
-
</dl>
|
|
5940
|
-
|
|
5941
|
-
<dl>
|
|
5942
|
-
<dd>
|
|
5943
|
-
|
|
5944
|
-
**domain_id:** `AgentMail.DomainId`
|
|
6003
|
+
**request:** `AgentMail.QueryUsageRequest`
|
|
5945
6004
|
|
|
5946
6005
|
</dd>
|
|
5947
6006
|
</dl>
|
|
@@ -5949,7 +6008,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
5949
6008
|
<dl>
|
|
5950
6009
|
<dd>
|
|
5951
6010
|
|
|
5952
|
-
**requestOptions:** `
|
|
6011
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
5953
6012
|
|
|
5954
6013
|
</dd>
|
|
5955
6014
|
</dl>
|
|
@@ -5961,7 +6020,8 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
5961
6020
|
</dl>
|
|
5962
6021
|
</details>
|
|
5963
6022
|
|
|
5964
|
-
|
|
6023
|
+
## Organizations
|
|
6024
|
+
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">get</a>() -> AgentMail.Organization</code></summary>
|
|
5965
6025
|
<dl>
|
|
5966
6026
|
<dd>
|
|
5967
6027
|
|
|
@@ -5973,9 +6033,11 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
5973
6033
|
<dl>
|
|
5974
6034
|
<dd>
|
|
5975
6035
|
|
|
6036
|
+
Returns the organization for the authenticated API key (usage limits, counts, and billing metadata).
|
|
6037
|
+
|
|
5976
6038
|
**CLI:**
|
|
5977
6039
|
```bash
|
|
5978
|
-
agentmail
|
|
6040
|
+
agentmail organizations get
|
|
5979
6041
|
```
|
|
5980
6042
|
</dd>
|
|
5981
6043
|
</dl>
|
|
@@ -5991,7 +6053,7 @@ agentmail pods:domains verify --pod-id <pod_id> --domain-id <domain_id>
|
|
|
5991
6053
|
<dd>
|
|
5992
6054
|
|
|
5993
6055
|
```typescript
|
|
5994
|
-
await client.
|
|
6056
|
+
await client.organizations.get();
|
|
5995
6057
|
|
|
5996
6058
|
```
|
|
5997
6059
|
</dd>
|
|
@@ -6007,23 +6069,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
6007
6069
|
<dl>
|
|
6008
6070
|
<dd>
|
|
6009
6071
|
|
|
6010
|
-
**
|
|
6011
|
-
|
|
6012
|
-
</dd>
|
|
6013
|
-
</dl>
|
|
6014
|
-
|
|
6015
|
-
<dl>
|
|
6016
|
-
<dd>
|
|
6017
|
-
|
|
6018
|
-
**domain_id:** `AgentMail.DomainId`
|
|
6019
|
-
|
|
6020
|
-
</dd>
|
|
6021
|
-
</dl>
|
|
6022
|
-
|
|
6023
|
-
<dl>
|
|
6024
|
-
<dd>
|
|
6025
|
-
|
|
6026
|
-
**requestOptions:** `DomainsClient.RequestOptions`
|
|
6072
|
+
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
6027
6073
|
|
|
6028
6074
|
</dd>
|
|
6029
6075
|
</dl>
|
|
@@ -6035,8 +6081,8 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
6035
6081
|
</dl>
|
|
6036
6082
|
</details>
|
|
6037
6083
|
|
|
6038
|
-
## Pods
|
|
6039
|
-
<details><summary><code>client.pods.
|
|
6084
|
+
## Pods ApiKeys
|
|
6085
|
+
<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>
|
|
6040
6086
|
<dl>
|
|
6041
6087
|
<dd>
|
|
6042
6088
|
|
|
@@ -6050,7 +6096,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
6050
6096
|
|
|
6051
6097
|
**CLI:**
|
|
6052
6098
|
```bash
|
|
6053
|
-
agentmail pods:
|
|
6099
|
+
agentmail pods:api-keys list --pod-id <pod_id>
|
|
6054
6100
|
```
|
|
6055
6101
|
</dd>
|
|
6056
6102
|
</dl>
|
|
@@ -6066,7 +6112,7 @@ agentmail pods:drafts list --pod-id <pod_id>
|
|
|
6066
6112
|
<dd>
|
|
6067
6113
|
|
|
6068
6114
|
```typescript
|
|
6069
|
-
await client.pods.
|
|
6115
|
+
await client.pods.apiKeys.list("pod_id");
|
|
6070
6116
|
|
|
6071
6117
|
```
|
|
6072
6118
|
</dd>
|
|
@@ -6090,7 +6136,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
6090
6136
|
<dl>
|
|
6091
6137
|
<dd>
|
|
6092
6138
|
|
|
6093
|
-
**request:** `AgentMail.pods.
|
|
6139
|
+
**request:** `AgentMail.pods.ListApiKeysRequest`
|
|
6094
6140
|
|
|
6095
6141
|
</dd>
|
|
6096
6142
|
</dl>
|
|
@@ -6098,7 +6144,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
6098
6144
|
<dl>
|
|
6099
6145
|
<dd>
|
|
6100
6146
|
|
|
6101
|
-
**requestOptions:** `
|
|
6147
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
6102
6148
|
|
|
6103
6149
|
</dd>
|
|
6104
6150
|
</dl>
|
|
@@ -6110,7 +6156,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
6110
6156
|
</dl>
|
|
6111
6157
|
</details>
|
|
6112
6158
|
|
|
6113
|
-
<details><summary><code>client.pods.
|
|
6159
|
+
<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>
|
|
6114
6160
|
<dl>
|
|
6115
6161
|
<dd>
|
|
6116
6162
|
|
|
@@ -6124,7 +6170,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
6124
6170
|
|
|
6125
6171
|
**CLI:**
|
|
6126
6172
|
```bash
|
|
6127
|
-
agentmail pods:
|
|
6173
|
+
agentmail pods:api-keys create --pod-id <pod_id> --name "My Key"
|
|
6128
6174
|
```
|
|
6129
6175
|
</dd>
|
|
6130
6176
|
</dl>
|
|
@@ -6140,7 +6186,7 @@ agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id>
|
|
|
6140
6186
|
<dd>
|
|
6141
6187
|
|
|
6142
6188
|
```typescript
|
|
6143
|
-
await client.pods.
|
|
6189
|
+
await client.pods.apiKeys.create("pod_id", {});
|
|
6144
6190
|
|
|
6145
6191
|
```
|
|
6146
6192
|
</dd>
|
|
@@ -6164,7 +6210,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
6164
6210
|
<dl>
|
|
6165
6211
|
<dd>
|
|
6166
6212
|
|
|
6167
|
-
**
|
|
6213
|
+
**request:** `AgentMail.CreateApiKeyRequest`
|
|
6168
6214
|
|
|
6169
6215
|
</dd>
|
|
6170
6216
|
</dl>
|
|
@@ -6172,7 +6218,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
6172
6218
|
<dl>
|
|
6173
6219
|
<dd>
|
|
6174
6220
|
|
|
6175
|
-
**requestOptions:** `
|
|
6221
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
6176
6222
|
|
|
6177
6223
|
</dd>
|
|
6178
6224
|
</dl>
|
|
@@ -6184,7 +6230,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
6184
6230
|
</dl>
|
|
6185
6231
|
</details>
|
|
6186
6232
|
|
|
6187
|
-
<details><summary><code>client.pods.
|
|
6233
|
+
<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>
|
|
6188
6234
|
<dl>
|
|
6189
6235
|
<dd>
|
|
6190
6236
|
|
|
@@ -6198,7 +6244,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
6198
6244
|
|
|
6199
6245
|
**CLI:**
|
|
6200
6246
|
```bash
|
|
6201
|
-
agentmail pods:
|
|
6247
|
+
agentmail pods:api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
|
|
6202
6248
|
```
|
|
6203
6249
|
</dd>
|
|
6204
6250
|
</dl>
|
|
@@ -6214,7 +6260,7 @@ agentmail pods:drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --a
|
|
|
6214
6260
|
<dd>
|
|
6215
6261
|
|
|
6216
6262
|
```typescript
|
|
6217
|
-
await client.pods.
|
|
6263
|
+
await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
6218
6264
|
|
|
6219
6265
|
```
|
|
6220
6266
|
</dd>
|
|
@@ -6238,15 +6284,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
6238
6284
|
<dl>
|
|
6239
6285
|
<dd>
|
|
6240
6286
|
|
|
6241
|
-
**
|
|
6242
|
-
|
|
6243
|
-
</dd>
|
|
6244
|
-
</dl>
|
|
6245
|
-
|
|
6246
|
-
<dl>
|
|
6247
|
-
<dd>
|
|
6248
|
-
|
|
6249
|
-
**attachment_id:** `AgentMail.AttachmentId`
|
|
6287
|
+
**api_key_id:** `AgentMail.ApiKeyId`
|
|
6250
6288
|
|
|
6251
6289
|
</dd>
|
|
6252
6290
|
</dl>
|
|
@@ -6254,7 +6292,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
6254
6292
|
<dl>
|
|
6255
6293
|
<dd>
|
|
6256
6294
|
|
|
6257
|
-
**requestOptions:** `
|
|
6295
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
6258
6296
|
|
|
6259
6297
|
</dd>
|
|
6260
6298
|
</dl>
|
|
@@ -6266,8 +6304,8 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
6266
6304
|
</dl>
|
|
6267
6305
|
</details>
|
|
6268
6306
|
|
|
6269
|
-
## Pods
|
|
6270
|
-
<details><summary><code>client.pods.
|
|
6307
|
+
## Pods Domains
|
|
6308
|
+
<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>
|
|
6271
6309
|
<dl>
|
|
6272
6310
|
<dd>
|
|
6273
6311
|
|
|
@@ -6281,7 +6319,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
6281
6319
|
|
|
6282
6320
|
**CLI:**
|
|
6283
6321
|
```bash
|
|
6284
|
-
agentmail pods:
|
|
6322
|
+
agentmail pods:domains list --pod-id <pod_id>
|
|
6285
6323
|
```
|
|
6286
6324
|
</dd>
|
|
6287
6325
|
</dl>
|
|
@@ -6297,7 +6335,7 @@ agentmail pods:inboxes list --pod-id <pod_id>
|
|
|
6297
6335
|
<dd>
|
|
6298
6336
|
|
|
6299
6337
|
```typescript
|
|
6300
|
-
await client.pods.
|
|
6338
|
+
await client.pods.domains.list("pod_id");
|
|
6301
6339
|
|
|
6302
6340
|
```
|
|
6303
6341
|
</dd>
|
|
@@ -6321,7 +6359,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
6321
6359
|
<dl>
|
|
6322
6360
|
<dd>
|
|
6323
6361
|
|
|
6324
|
-
**request:** `AgentMail.pods.
|
|
6362
|
+
**request:** `AgentMail.pods.ListDomainsRequest`
|
|
6325
6363
|
|
|
6326
6364
|
</dd>
|
|
6327
6365
|
</dl>
|
|
@@ -6329,7 +6367,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
6329
6367
|
<dl>
|
|
6330
6368
|
<dd>
|
|
6331
6369
|
|
|
6332
|
-
**requestOptions:** `
|
|
6370
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
6333
6371
|
|
|
6334
6372
|
</dd>
|
|
6335
6373
|
</dl>
|
|
@@ -6341,7 +6379,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
6341
6379
|
</dl>
|
|
6342
6380
|
</details>
|
|
6343
6381
|
|
|
6344
|
-
<details><summary><code>client.pods.
|
|
6382
|
+
<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>
|
|
6345
6383
|
<dl>
|
|
6346
6384
|
<dd>
|
|
6347
6385
|
|
|
@@ -6355,7 +6393,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
6355
6393
|
|
|
6356
6394
|
**CLI:**
|
|
6357
6395
|
```bash
|
|
6358
|
-
agentmail pods:
|
|
6396
|
+
agentmail pods:domains get --pod-id <pod_id> --domain-id <domain_id>
|
|
6359
6397
|
```
|
|
6360
6398
|
</dd>
|
|
6361
6399
|
</dl>
|
|
@@ -6371,7 +6409,7 @@ agentmail pods:inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
6371
6409
|
<dd>
|
|
6372
6410
|
|
|
6373
6411
|
```typescript
|
|
6374
|
-
await client.pods.
|
|
6412
|
+
await client.pods.domains.get("pod_id", "domain_id");
|
|
6375
6413
|
|
|
6376
6414
|
```
|
|
6377
6415
|
</dd>
|
|
@@ -6395,7 +6433,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
6395
6433
|
<dl>
|
|
6396
6434
|
<dd>
|
|
6397
6435
|
|
|
6398
|
-
**
|
|
6436
|
+
**domain_id:** `AgentMail.DomainId`
|
|
6399
6437
|
|
|
6400
6438
|
</dd>
|
|
6401
6439
|
</dl>
|
|
@@ -6403,7 +6441,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
6403
6441
|
<dl>
|
|
6404
6442
|
<dd>
|
|
6405
6443
|
|
|
6406
|
-
**requestOptions:** `
|
|
6444
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
6407
6445
|
|
|
6408
6446
|
</dd>
|
|
6409
6447
|
</dl>
|
|
@@ -6415,7 +6453,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
6415
6453
|
</dl>
|
|
6416
6454
|
</details>
|
|
6417
6455
|
|
|
6418
|
-
<details><summary><code>client.pods.
|
|
6456
|
+
<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>
|
|
6419
6457
|
<dl>
|
|
6420
6458
|
<dd>
|
|
6421
6459
|
|
|
@@ -6429,7 +6467,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
6429
6467
|
|
|
6430
6468
|
**CLI:**
|
|
6431
6469
|
```bash
|
|
6432
|
-
agentmail pods:
|
|
6470
|
+
agentmail pods:domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
|
|
6433
6471
|
```
|
|
6434
6472
|
</dd>
|
|
6435
6473
|
</dl>
|
|
@@ -6445,7 +6483,7 @@ agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain exam
|
|
|
6445
6483
|
<dd>
|
|
6446
6484
|
|
|
6447
6485
|
```typescript
|
|
6448
|
-
await client.pods.
|
|
6486
|
+
await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
6449
6487
|
|
|
6450
6488
|
```
|
|
6451
6489
|
</dd>
|
|
@@ -6469,7 +6507,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
6469
6507
|
<dl>
|
|
6470
6508
|
<dd>
|
|
6471
6509
|
|
|
6472
|
-
**
|
|
6510
|
+
**domain_id:** `AgentMail.DomainId`
|
|
6473
6511
|
|
|
6474
6512
|
</dd>
|
|
6475
6513
|
</dl>
|
|
@@ -6477,7 +6515,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
6477
6515
|
<dl>
|
|
6478
6516
|
<dd>
|
|
6479
6517
|
|
|
6480
|
-
**requestOptions:** `
|
|
6518
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
6481
6519
|
|
|
6482
6520
|
</dd>
|
|
6483
6521
|
</dl>
|
|
@@ -6489,7 +6527,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
6489
6527
|
</dl>
|
|
6490
6528
|
</details>
|
|
6491
6529
|
|
|
6492
|
-
<details><summary><code>client.pods.
|
|
6530
|
+
<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>
|
|
6493
6531
|
<dl>
|
|
6494
6532
|
<dd>
|
|
6495
6533
|
|
|
@@ -6503,7 +6541,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
6503
6541
|
|
|
6504
6542
|
**CLI:**
|
|
6505
6543
|
```bash
|
|
6506
|
-
agentmail pods:
|
|
6544
|
+
agentmail pods:domains create --pod-id <pod_id> --domain example.com
|
|
6507
6545
|
```
|
|
6508
6546
|
</dd>
|
|
6509
6547
|
</dl>
|
|
@@ -6519,7 +6557,9 @@ agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
6519
6557
|
<dd>
|
|
6520
6558
|
|
|
6521
6559
|
```typescript
|
|
6522
|
-
await client.pods.
|
|
6560
|
+
await client.pods.domains.create("pod_id", {
|
|
6561
|
+
domain: "domain"
|
|
6562
|
+
});
|
|
6523
6563
|
|
|
6524
6564
|
```
|
|
6525
6565
|
</dd>
|
|
@@ -6543,7 +6583,1283 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
6543
6583
|
<dl>
|
|
6544
6584
|
<dd>
|
|
6545
6585
|
|
|
6546
|
-
**
|
|
6586
|
+
**request:** `AgentMail.CreateDomainRequest`
|
|
6587
|
+
|
|
6588
|
+
</dd>
|
|
6589
|
+
</dl>
|
|
6590
|
+
|
|
6591
|
+
<dl>
|
|
6592
|
+
<dd>
|
|
6593
|
+
|
|
6594
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
6595
|
+
|
|
6596
|
+
</dd>
|
|
6597
|
+
</dl>
|
|
6598
|
+
</dd>
|
|
6599
|
+
</dl>
|
|
6600
|
+
|
|
6601
|
+
|
|
6602
|
+
</dd>
|
|
6603
|
+
</dl>
|
|
6604
|
+
</details>
|
|
6605
|
+
|
|
6606
|
+
<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>
|
|
6607
|
+
<dl>
|
|
6608
|
+
<dd>
|
|
6609
|
+
|
|
6610
|
+
#### 📝 Description
|
|
6611
|
+
|
|
6612
|
+
<dl>
|
|
6613
|
+
<dd>
|
|
6614
|
+
|
|
6615
|
+
<dl>
|
|
6616
|
+
<dd>
|
|
6617
|
+
|
|
6618
|
+
**CLI:**
|
|
6619
|
+
```bash
|
|
6620
|
+
agentmail pods:domains update --pod-id <pod_id> --domain-id <domain_id>
|
|
6621
|
+
```
|
|
6622
|
+
</dd>
|
|
6623
|
+
</dl>
|
|
6624
|
+
</dd>
|
|
6625
|
+
</dl>
|
|
6626
|
+
|
|
6627
|
+
#### 🔌 Usage
|
|
6628
|
+
|
|
6629
|
+
<dl>
|
|
6630
|
+
<dd>
|
|
6631
|
+
|
|
6632
|
+
<dl>
|
|
6633
|
+
<dd>
|
|
6634
|
+
|
|
6635
|
+
```typescript
|
|
6636
|
+
await client.pods.domains.update("pod_id", "domain_id", {});
|
|
6637
|
+
|
|
6638
|
+
```
|
|
6639
|
+
</dd>
|
|
6640
|
+
</dl>
|
|
6641
|
+
</dd>
|
|
6642
|
+
</dl>
|
|
6643
|
+
|
|
6644
|
+
#### ⚙️ Parameters
|
|
6645
|
+
|
|
6646
|
+
<dl>
|
|
6647
|
+
<dd>
|
|
6648
|
+
|
|
6649
|
+
<dl>
|
|
6650
|
+
<dd>
|
|
6651
|
+
|
|
6652
|
+
**pod_id:** `AgentMail.PodId`
|
|
6653
|
+
|
|
6654
|
+
</dd>
|
|
6655
|
+
</dl>
|
|
6656
|
+
|
|
6657
|
+
<dl>
|
|
6658
|
+
<dd>
|
|
6659
|
+
|
|
6660
|
+
**domain_id:** `AgentMail.DomainId`
|
|
6661
|
+
|
|
6662
|
+
</dd>
|
|
6663
|
+
</dl>
|
|
6664
|
+
|
|
6665
|
+
<dl>
|
|
6666
|
+
<dd>
|
|
6667
|
+
|
|
6668
|
+
**request:** `AgentMail.UpdateDomainRequest`
|
|
6669
|
+
|
|
6670
|
+
</dd>
|
|
6671
|
+
</dl>
|
|
6672
|
+
|
|
6673
|
+
<dl>
|
|
6674
|
+
<dd>
|
|
6675
|
+
|
|
6676
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
6677
|
+
|
|
6678
|
+
</dd>
|
|
6679
|
+
</dl>
|
|
6680
|
+
</dd>
|
|
6681
|
+
</dl>
|
|
6682
|
+
|
|
6683
|
+
|
|
6684
|
+
</dd>
|
|
6685
|
+
</dl>
|
|
6686
|
+
</details>
|
|
6687
|
+
|
|
6688
|
+
<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>
|
|
6689
|
+
<dl>
|
|
6690
|
+
<dd>
|
|
6691
|
+
|
|
6692
|
+
#### 📝 Description
|
|
6693
|
+
|
|
6694
|
+
<dl>
|
|
6695
|
+
<dd>
|
|
6696
|
+
|
|
6697
|
+
<dl>
|
|
6698
|
+
<dd>
|
|
6699
|
+
|
|
6700
|
+
**CLI:**
|
|
6701
|
+
```bash
|
|
6702
|
+
agentmail pods:domains delete --pod-id <pod_id> --domain-id <domain_id>
|
|
6703
|
+
```
|
|
6704
|
+
</dd>
|
|
6705
|
+
</dl>
|
|
6706
|
+
</dd>
|
|
6707
|
+
</dl>
|
|
6708
|
+
|
|
6709
|
+
#### 🔌 Usage
|
|
6710
|
+
|
|
6711
|
+
<dl>
|
|
6712
|
+
<dd>
|
|
6713
|
+
|
|
6714
|
+
<dl>
|
|
6715
|
+
<dd>
|
|
6716
|
+
|
|
6717
|
+
```typescript
|
|
6718
|
+
await client.pods.domains.delete("pod_id", "domain_id");
|
|
6719
|
+
|
|
6720
|
+
```
|
|
6721
|
+
</dd>
|
|
6722
|
+
</dl>
|
|
6723
|
+
</dd>
|
|
6724
|
+
</dl>
|
|
6725
|
+
|
|
6726
|
+
#### ⚙️ Parameters
|
|
6727
|
+
|
|
6728
|
+
<dl>
|
|
6729
|
+
<dd>
|
|
6730
|
+
|
|
6731
|
+
<dl>
|
|
6732
|
+
<dd>
|
|
6733
|
+
|
|
6734
|
+
**pod_id:** `AgentMail.PodId`
|
|
6735
|
+
|
|
6736
|
+
</dd>
|
|
6737
|
+
</dl>
|
|
6738
|
+
|
|
6739
|
+
<dl>
|
|
6740
|
+
<dd>
|
|
6741
|
+
|
|
6742
|
+
**domain_id:** `AgentMail.DomainId`
|
|
6743
|
+
|
|
6744
|
+
</dd>
|
|
6745
|
+
</dl>
|
|
6746
|
+
|
|
6747
|
+
<dl>
|
|
6748
|
+
<dd>
|
|
6749
|
+
|
|
6750
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
6751
|
+
|
|
6752
|
+
</dd>
|
|
6753
|
+
</dl>
|
|
6754
|
+
</dd>
|
|
6755
|
+
</dl>
|
|
6756
|
+
|
|
6757
|
+
|
|
6758
|
+
</dd>
|
|
6759
|
+
</dl>
|
|
6760
|
+
</details>
|
|
6761
|
+
|
|
6762
|
+
<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>
|
|
6763
|
+
<dl>
|
|
6764
|
+
<dd>
|
|
6765
|
+
|
|
6766
|
+
#### 📝 Description
|
|
6767
|
+
|
|
6768
|
+
<dl>
|
|
6769
|
+
<dd>
|
|
6770
|
+
|
|
6771
|
+
<dl>
|
|
6772
|
+
<dd>
|
|
6773
|
+
|
|
6774
|
+
**CLI:**
|
|
6775
|
+
```bash
|
|
6776
|
+
agentmail pods:domains verify --pod-id <pod_id> --domain-id <domain_id>
|
|
6777
|
+
```
|
|
6778
|
+
</dd>
|
|
6779
|
+
</dl>
|
|
6780
|
+
</dd>
|
|
6781
|
+
</dl>
|
|
6782
|
+
|
|
6783
|
+
#### 🔌 Usage
|
|
6784
|
+
|
|
6785
|
+
<dl>
|
|
6786
|
+
<dd>
|
|
6787
|
+
|
|
6788
|
+
<dl>
|
|
6789
|
+
<dd>
|
|
6790
|
+
|
|
6791
|
+
```typescript
|
|
6792
|
+
await client.pods.domains.verify("pod_id", "domain_id");
|
|
6793
|
+
|
|
6794
|
+
```
|
|
6795
|
+
</dd>
|
|
6796
|
+
</dl>
|
|
6797
|
+
</dd>
|
|
6798
|
+
</dl>
|
|
6799
|
+
|
|
6800
|
+
#### ⚙️ Parameters
|
|
6801
|
+
|
|
6802
|
+
<dl>
|
|
6803
|
+
<dd>
|
|
6804
|
+
|
|
6805
|
+
<dl>
|
|
6806
|
+
<dd>
|
|
6807
|
+
|
|
6808
|
+
**pod_id:** `AgentMail.PodId`
|
|
6809
|
+
|
|
6810
|
+
</dd>
|
|
6811
|
+
</dl>
|
|
6812
|
+
|
|
6813
|
+
<dl>
|
|
6814
|
+
<dd>
|
|
6815
|
+
|
|
6816
|
+
**domain_id:** `AgentMail.DomainId`
|
|
6817
|
+
|
|
6818
|
+
</dd>
|
|
6819
|
+
</dl>
|
|
6820
|
+
|
|
6821
|
+
<dl>
|
|
6822
|
+
<dd>
|
|
6823
|
+
|
|
6824
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
6825
|
+
|
|
6826
|
+
</dd>
|
|
6827
|
+
</dl>
|
|
6828
|
+
</dd>
|
|
6829
|
+
</dl>
|
|
6830
|
+
|
|
6831
|
+
|
|
6832
|
+
</dd>
|
|
6833
|
+
</dl>
|
|
6834
|
+
</details>
|
|
6835
|
+
|
|
6836
|
+
## Pods Drafts
|
|
6837
|
+
<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>
|
|
6838
|
+
<dl>
|
|
6839
|
+
<dd>
|
|
6840
|
+
|
|
6841
|
+
#### 📝 Description
|
|
6842
|
+
|
|
6843
|
+
<dl>
|
|
6844
|
+
<dd>
|
|
6845
|
+
|
|
6846
|
+
<dl>
|
|
6847
|
+
<dd>
|
|
6848
|
+
|
|
6849
|
+
**CLI:**
|
|
6850
|
+
```bash
|
|
6851
|
+
agentmail pods:drafts list --pod-id <pod_id>
|
|
6852
|
+
```
|
|
6853
|
+
</dd>
|
|
6854
|
+
</dl>
|
|
6855
|
+
</dd>
|
|
6856
|
+
</dl>
|
|
6857
|
+
|
|
6858
|
+
#### 🔌 Usage
|
|
6859
|
+
|
|
6860
|
+
<dl>
|
|
6861
|
+
<dd>
|
|
6862
|
+
|
|
6863
|
+
<dl>
|
|
6864
|
+
<dd>
|
|
6865
|
+
|
|
6866
|
+
```typescript
|
|
6867
|
+
await client.pods.drafts.list("pod_id");
|
|
6868
|
+
|
|
6869
|
+
```
|
|
6870
|
+
</dd>
|
|
6871
|
+
</dl>
|
|
6872
|
+
</dd>
|
|
6873
|
+
</dl>
|
|
6874
|
+
|
|
6875
|
+
#### ⚙️ Parameters
|
|
6876
|
+
|
|
6877
|
+
<dl>
|
|
6878
|
+
<dd>
|
|
6879
|
+
|
|
6880
|
+
<dl>
|
|
6881
|
+
<dd>
|
|
6882
|
+
|
|
6883
|
+
**pod_id:** `AgentMail.PodId`
|
|
6884
|
+
|
|
6885
|
+
</dd>
|
|
6886
|
+
</dl>
|
|
6887
|
+
|
|
6888
|
+
<dl>
|
|
6889
|
+
<dd>
|
|
6890
|
+
|
|
6891
|
+
**request:** `AgentMail.pods.ListDraftsRequest`
|
|
6892
|
+
|
|
6893
|
+
</dd>
|
|
6894
|
+
</dl>
|
|
6895
|
+
|
|
6896
|
+
<dl>
|
|
6897
|
+
<dd>
|
|
6898
|
+
|
|
6899
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
6900
|
+
|
|
6901
|
+
</dd>
|
|
6902
|
+
</dl>
|
|
6903
|
+
</dd>
|
|
6904
|
+
</dl>
|
|
6905
|
+
|
|
6906
|
+
|
|
6907
|
+
</dd>
|
|
6908
|
+
</dl>
|
|
6909
|
+
</details>
|
|
6910
|
+
|
|
6911
|
+
<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>
|
|
6912
|
+
<dl>
|
|
6913
|
+
<dd>
|
|
6914
|
+
|
|
6915
|
+
#### 📝 Description
|
|
6916
|
+
|
|
6917
|
+
<dl>
|
|
6918
|
+
<dd>
|
|
6919
|
+
|
|
6920
|
+
<dl>
|
|
6921
|
+
<dd>
|
|
6922
|
+
|
|
6923
|
+
**CLI:**
|
|
6924
|
+
```bash
|
|
6925
|
+
agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id>
|
|
6926
|
+
```
|
|
6927
|
+
</dd>
|
|
6928
|
+
</dl>
|
|
6929
|
+
</dd>
|
|
6930
|
+
</dl>
|
|
6931
|
+
|
|
6932
|
+
#### 🔌 Usage
|
|
6933
|
+
|
|
6934
|
+
<dl>
|
|
6935
|
+
<dd>
|
|
6936
|
+
|
|
6937
|
+
<dl>
|
|
6938
|
+
<dd>
|
|
6939
|
+
|
|
6940
|
+
```typescript
|
|
6941
|
+
await client.pods.drafts.get("pod_id", "draft_id");
|
|
6942
|
+
|
|
6943
|
+
```
|
|
6944
|
+
</dd>
|
|
6945
|
+
</dl>
|
|
6946
|
+
</dd>
|
|
6947
|
+
</dl>
|
|
6948
|
+
|
|
6949
|
+
#### ⚙️ Parameters
|
|
6950
|
+
|
|
6951
|
+
<dl>
|
|
6952
|
+
<dd>
|
|
6953
|
+
|
|
6954
|
+
<dl>
|
|
6955
|
+
<dd>
|
|
6956
|
+
|
|
6957
|
+
**pod_id:** `AgentMail.PodId`
|
|
6958
|
+
|
|
6959
|
+
</dd>
|
|
6960
|
+
</dl>
|
|
6961
|
+
|
|
6962
|
+
<dl>
|
|
6963
|
+
<dd>
|
|
6964
|
+
|
|
6965
|
+
**draft_id:** `AgentMail.DraftId`
|
|
6966
|
+
|
|
6967
|
+
</dd>
|
|
6968
|
+
</dl>
|
|
6969
|
+
|
|
6970
|
+
<dl>
|
|
6971
|
+
<dd>
|
|
6972
|
+
|
|
6973
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
6974
|
+
|
|
6975
|
+
</dd>
|
|
6976
|
+
</dl>
|
|
6977
|
+
</dd>
|
|
6978
|
+
</dl>
|
|
6979
|
+
|
|
6980
|
+
|
|
6981
|
+
</dd>
|
|
6982
|
+
</dl>
|
|
6983
|
+
</details>
|
|
6984
|
+
|
|
6985
|
+
<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>
|
|
6986
|
+
<dl>
|
|
6987
|
+
<dd>
|
|
6988
|
+
|
|
6989
|
+
#### 📝 Description
|
|
6990
|
+
|
|
6991
|
+
<dl>
|
|
6992
|
+
<dd>
|
|
6993
|
+
|
|
6994
|
+
<dl>
|
|
6995
|
+
<dd>
|
|
6996
|
+
|
|
6997
|
+
**CLI:**
|
|
6998
|
+
```bash
|
|
6999
|
+
agentmail pods:drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --attachment-id <attachment_id>
|
|
7000
|
+
```
|
|
7001
|
+
</dd>
|
|
7002
|
+
</dl>
|
|
7003
|
+
</dd>
|
|
7004
|
+
</dl>
|
|
7005
|
+
|
|
7006
|
+
#### 🔌 Usage
|
|
7007
|
+
|
|
7008
|
+
<dl>
|
|
7009
|
+
<dd>
|
|
7010
|
+
|
|
7011
|
+
<dl>
|
|
7012
|
+
<dd>
|
|
7013
|
+
|
|
7014
|
+
```typescript
|
|
7015
|
+
await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
7016
|
+
|
|
7017
|
+
```
|
|
7018
|
+
</dd>
|
|
7019
|
+
</dl>
|
|
7020
|
+
</dd>
|
|
7021
|
+
</dl>
|
|
7022
|
+
|
|
7023
|
+
#### ⚙️ Parameters
|
|
7024
|
+
|
|
7025
|
+
<dl>
|
|
7026
|
+
<dd>
|
|
7027
|
+
|
|
7028
|
+
<dl>
|
|
7029
|
+
<dd>
|
|
7030
|
+
|
|
7031
|
+
**pod_id:** `AgentMail.PodId`
|
|
7032
|
+
|
|
7033
|
+
</dd>
|
|
7034
|
+
</dl>
|
|
7035
|
+
|
|
7036
|
+
<dl>
|
|
7037
|
+
<dd>
|
|
7038
|
+
|
|
7039
|
+
**draft_id:** `AgentMail.DraftId`
|
|
7040
|
+
|
|
7041
|
+
</dd>
|
|
7042
|
+
</dl>
|
|
7043
|
+
|
|
7044
|
+
<dl>
|
|
7045
|
+
<dd>
|
|
7046
|
+
|
|
7047
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
7048
|
+
|
|
7049
|
+
</dd>
|
|
7050
|
+
</dl>
|
|
7051
|
+
|
|
7052
|
+
<dl>
|
|
7053
|
+
<dd>
|
|
7054
|
+
|
|
7055
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
7056
|
+
|
|
7057
|
+
</dd>
|
|
7058
|
+
</dl>
|
|
7059
|
+
</dd>
|
|
7060
|
+
</dl>
|
|
7061
|
+
|
|
7062
|
+
|
|
7063
|
+
</dd>
|
|
7064
|
+
</dl>
|
|
7065
|
+
</details>
|
|
7066
|
+
|
|
7067
|
+
## Pods Inboxes
|
|
7068
|
+
<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>
|
|
7069
|
+
<dl>
|
|
7070
|
+
<dd>
|
|
7071
|
+
|
|
7072
|
+
#### 📝 Description
|
|
7073
|
+
|
|
7074
|
+
<dl>
|
|
7075
|
+
<dd>
|
|
7076
|
+
|
|
7077
|
+
<dl>
|
|
7078
|
+
<dd>
|
|
7079
|
+
|
|
7080
|
+
**CLI:**
|
|
7081
|
+
```bash
|
|
7082
|
+
agentmail pods:inboxes list --pod-id <pod_id>
|
|
7083
|
+
```
|
|
7084
|
+
</dd>
|
|
7085
|
+
</dl>
|
|
7086
|
+
</dd>
|
|
7087
|
+
</dl>
|
|
7088
|
+
|
|
7089
|
+
#### 🔌 Usage
|
|
7090
|
+
|
|
7091
|
+
<dl>
|
|
7092
|
+
<dd>
|
|
7093
|
+
|
|
7094
|
+
<dl>
|
|
7095
|
+
<dd>
|
|
7096
|
+
|
|
7097
|
+
```typescript
|
|
7098
|
+
await client.pods.inboxes.list("pod_id");
|
|
7099
|
+
|
|
7100
|
+
```
|
|
7101
|
+
</dd>
|
|
7102
|
+
</dl>
|
|
7103
|
+
</dd>
|
|
7104
|
+
</dl>
|
|
7105
|
+
|
|
7106
|
+
#### ⚙️ Parameters
|
|
7107
|
+
|
|
7108
|
+
<dl>
|
|
7109
|
+
<dd>
|
|
7110
|
+
|
|
7111
|
+
<dl>
|
|
7112
|
+
<dd>
|
|
7113
|
+
|
|
7114
|
+
**pod_id:** `AgentMail.PodId`
|
|
7115
|
+
|
|
7116
|
+
</dd>
|
|
7117
|
+
</dl>
|
|
7118
|
+
|
|
7119
|
+
<dl>
|
|
7120
|
+
<dd>
|
|
7121
|
+
|
|
7122
|
+
**request:** `AgentMail.pods.ListInboxesRequest`
|
|
7123
|
+
|
|
7124
|
+
</dd>
|
|
7125
|
+
</dl>
|
|
7126
|
+
|
|
7127
|
+
<dl>
|
|
7128
|
+
<dd>
|
|
7129
|
+
|
|
7130
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
7131
|
+
|
|
7132
|
+
</dd>
|
|
7133
|
+
</dl>
|
|
7134
|
+
</dd>
|
|
7135
|
+
</dl>
|
|
7136
|
+
|
|
7137
|
+
|
|
7138
|
+
</dd>
|
|
7139
|
+
</dl>
|
|
7140
|
+
</details>
|
|
7141
|
+
|
|
7142
|
+
<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>
|
|
7143
|
+
<dl>
|
|
7144
|
+
<dd>
|
|
7145
|
+
|
|
7146
|
+
#### 📝 Description
|
|
7147
|
+
|
|
7148
|
+
<dl>
|
|
7149
|
+
<dd>
|
|
7150
|
+
|
|
7151
|
+
<dl>
|
|
7152
|
+
<dd>
|
|
7153
|
+
|
|
7154
|
+
**CLI:**
|
|
7155
|
+
```bash
|
|
7156
|
+
agentmail pods:inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
|
|
7157
|
+
```
|
|
7158
|
+
</dd>
|
|
7159
|
+
</dl>
|
|
7160
|
+
</dd>
|
|
7161
|
+
</dl>
|
|
7162
|
+
|
|
7163
|
+
#### 🔌 Usage
|
|
7164
|
+
|
|
7165
|
+
<dl>
|
|
7166
|
+
<dd>
|
|
7167
|
+
|
|
7168
|
+
<dl>
|
|
7169
|
+
<dd>
|
|
7170
|
+
|
|
7171
|
+
```typescript
|
|
7172
|
+
await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
7173
|
+
|
|
7174
|
+
```
|
|
7175
|
+
</dd>
|
|
7176
|
+
</dl>
|
|
7177
|
+
</dd>
|
|
7178
|
+
</dl>
|
|
7179
|
+
|
|
7180
|
+
#### ⚙️ Parameters
|
|
7181
|
+
|
|
7182
|
+
<dl>
|
|
7183
|
+
<dd>
|
|
7184
|
+
|
|
7185
|
+
<dl>
|
|
7186
|
+
<dd>
|
|
7187
|
+
|
|
7188
|
+
**pod_id:** `AgentMail.PodId`
|
|
7189
|
+
|
|
7190
|
+
</dd>
|
|
7191
|
+
</dl>
|
|
7192
|
+
|
|
7193
|
+
<dl>
|
|
7194
|
+
<dd>
|
|
7195
|
+
|
|
7196
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
7197
|
+
|
|
7198
|
+
</dd>
|
|
7199
|
+
</dl>
|
|
7200
|
+
|
|
7201
|
+
<dl>
|
|
7202
|
+
<dd>
|
|
7203
|
+
|
|
7204
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
7205
|
+
|
|
7206
|
+
</dd>
|
|
7207
|
+
</dl>
|
|
7208
|
+
</dd>
|
|
7209
|
+
</dl>
|
|
7210
|
+
|
|
7211
|
+
|
|
7212
|
+
</dd>
|
|
7213
|
+
</dl>
|
|
7214
|
+
</details>
|
|
7215
|
+
|
|
7216
|
+
<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>
|
|
7217
|
+
<dl>
|
|
7218
|
+
<dd>
|
|
7219
|
+
|
|
7220
|
+
#### 📝 Description
|
|
7221
|
+
|
|
7222
|
+
<dl>
|
|
7223
|
+
<dd>
|
|
7224
|
+
|
|
7225
|
+
<dl>
|
|
7226
|
+
<dd>
|
|
7227
|
+
|
|
7228
|
+
**CLI:**
|
|
7229
|
+
```bash
|
|
7230
|
+
agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain example.com
|
|
7231
|
+
```
|
|
7232
|
+
</dd>
|
|
7233
|
+
</dl>
|
|
7234
|
+
</dd>
|
|
7235
|
+
</dl>
|
|
7236
|
+
|
|
7237
|
+
#### 🔌 Usage
|
|
7238
|
+
|
|
7239
|
+
<dl>
|
|
7240
|
+
<dd>
|
|
7241
|
+
|
|
7242
|
+
<dl>
|
|
7243
|
+
<dd>
|
|
7244
|
+
|
|
7245
|
+
```typescript
|
|
7246
|
+
await client.pods.inboxes.create("pod_id", {});
|
|
7247
|
+
|
|
7248
|
+
```
|
|
7249
|
+
</dd>
|
|
7250
|
+
</dl>
|
|
7251
|
+
</dd>
|
|
7252
|
+
</dl>
|
|
7253
|
+
|
|
7254
|
+
#### ⚙️ Parameters
|
|
7255
|
+
|
|
7256
|
+
<dl>
|
|
7257
|
+
<dd>
|
|
7258
|
+
|
|
7259
|
+
<dl>
|
|
7260
|
+
<dd>
|
|
7261
|
+
|
|
7262
|
+
**pod_id:** `AgentMail.PodId`
|
|
7263
|
+
|
|
7264
|
+
</dd>
|
|
7265
|
+
</dl>
|
|
7266
|
+
|
|
7267
|
+
<dl>
|
|
7268
|
+
<dd>
|
|
7269
|
+
|
|
7270
|
+
**request:** `AgentMail.CreateInboxRequest`
|
|
7271
|
+
|
|
7272
|
+
</dd>
|
|
7273
|
+
</dl>
|
|
7274
|
+
|
|
7275
|
+
<dl>
|
|
7276
|
+
<dd>
|
|
7277
|
+
|
|
7278
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
7279
|
+
|
|
7280
|
+
</dd>
|
|
7281
|
+
</dl>
|
|
7282
|
+
</dd>
|
|
7283
|
+
</dl>
|
|
7284
|
+
|
|
7285
|
+
|
|
7286
|
+
</dd>
|
|
7287
|
+
</dl>
|
|
7288
|
+
</details>
|
|
7289
|
+
|
|
7290
|
+
<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>
|
|
7291
|
+
<dl>
|
|
7292
|
+
<dd>
|
|
7293
|
+
|
|
7294
|
+
#### 📝 Description
|
|
7295
|
+
|
|
7296
|
+
<dl>
|
|
7297
|
+
<dd>
|
|
7298
|
+
|
|
7299
|
+
<dl>
|
|
7300
|
+
<dd>
|
|
7301
|
+
|
|
7302
|
+
**CLI:**
|
|
7303
|
+
```bash
|
|
7304
|
+
agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
|
|
7305
|
+
```
|
|
7306
|
+
</dd>
|
|
7307
|
+
</dl>
|
|
7308
|
+
</dd>
|
|
7309
|
+
</dl>
|
|
7310
|
+
|
|
7311
|
+
#### 🔌 Usage
|
|
7312
|
+
|
|
7313
|
+
<dl>
|
|
7314
|
+
<dd>
|
|
7315
|
+
|
|
7316
|
+
<dl>
|
|
7317
|
+
<dd>
|
|
7318
|
+
|
|
7319
|
+
```typescript
|
|
7320
|
+
await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
7321
|
+
|
|
7322
|
+
```
|
|
7323
|
+
</dd>
|
|
7324
|
+
</dl>
|
|
7325
|
+
</dd>
|
|
7326
|
+
</dl>
|
|
7327
|
+
|
|
7328
|
+
#### ⚙️ Parameters
|
|
7329
|
+
|
|
7330
|
+
<dl>
|
|
7331
|
+
<dd>
|
|
7332
|
+
|
|
7333
|
+
<dl>
|
|
7334
|
+
<dd>
|
|
7335
|
+
|
|
7336
|
+
**pod_id:** `AgentMail.PodId`
|
|
7337
|
+
|
|
7338
|
+
</dd>
|
|
7339
|
+
</dl>
|
|
7340
|
+
|
|
7341
|
+
<dl>
|
|
7342
|
+
<dd>
|
|
7343
|
+
|
|
7344
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
7345
|
+
|
|
7346
|
+
</dd>
|
|
7347
|
+
</dl>
|
|
7348
|
+
|
|
7349
|
+
<dl>
|
|
7350
|
+
<dd>
|
|
7351
|
+
|
|
7352
|
+
**request:** `AgentMail.UpdateInboxRequest`
|
|
7353
|
+
|
|
7354
|
+
</dd>
|
|
7355
|
+
</dl>
|
|
7356
|
+
|
|
7357
|
+
<dl>
|
|
7358
|
+
<dd>
|
|
7359
|
+
|
|
7360
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
7361
|
+
|
|
7362
|
+
</dd>
|
|
7363
|
+
</dl>
|
|
7364
|
+
</dd>
|
|
7365
|
+
</dl>
|
|
7366
|
+
|
|
7367
|
+
|
|
7368
|
+
</dd>
|
|
7369
|
+
</dl>
|
|
7370
|
+
</details>
|
|
7371
|
+
|
|
7372
|
+
<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>
|
|
7373
|
+
<dl>
|
|
7374
|
+
<dd>
|
|
7375
|
+
|
|
7376
|
+
#### 📝 Description
|
|
7377
|
+
|
|
7378
|
+
<dl>
|
|
7379
|
+
<dd>
|
|
7380
|
+
|
|
7381
|
+
<dl>
|
|
7382
|
+
<dd>
|
|
7383
|
+
|
|
7384
|
+
**CLI:**
|
|
7385
|
+
```bash
|
|
7386
|
+
agentmail pods:inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>
|
|
7387
|
+
```
|
|
7388
|
+
</dd>
|
|
7389
|
+
</dl>
|
|
7390
|
+
</dd>
|
|
7391
|
+
</dl>
|
|
7392
|
+
|
|
7393
|
+
#### 🔌 Usage
|
|
7394
|
+
|
|
7395
|
+
<dl>
|
|
7396
|
+
<dd>
|
|
7397
|
+
|
|
7398
|
+
<dl>
|
|
7399
|
+
<dd>
|
|
7400
|
+
|
|
7401
|
+
```typescript
|
|
7402
|
+
await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
7403
|
+
|
|
7404
|
+
```
|
|
7405
|
+
</dd>
|
|
7406
|
+
</dl>
|
|
7407
|
+
</dd>
|
|
7408
|
+
</dl>
|
|
7409
|
+
|
|
7410
|
+
#### ⚙️ Parameters
|
|
7411
|
+
|
|
7412
|
+
<dl>
|
|
7413
|
+
<dd>
|
|
7414
|
+
|
|
7415
|
+
<dl>
|
|
7416
|
+
<dd>
|
|
7417
|
+
|
|
7418
|
+
**pod_id:** `AgentMail.PodId`
|
|
7419
|
+
|
|
7420
|
+
</dd>
|
|
7421
|
+
</dl>
|
|
7422
|
+
|
|
7423
|
+
<dl>
|
|
7424
|
+
<dd>
|
|
7425
|
+
|
|
7426
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
7427
|
+
|
|
7428
|
+
</dd>
|
|
7429
|
+
</dl>
|
|
7430
|
+
|
|
7431
|
+
<dl>
|
|
7432
|
+
<dd>
|
|
7433
|
+
|
|
7434
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
7435
|
+
|
|
7436
|
+
</dd>
|
|
7437
|
+
</dl>
|
|
7438
|
+
</dd>
|
|
7439
|
+
</dl>
|
|
7440
|
+
|
|
7441
|
+
|
|
7442
|
+
</dd>
|
|
7443
|
+
</dl>
|
|
7444
|
+
</details>
|
|
7445
|
+
|
|
7446
|
+
## Pods Lists
|
|
7447
|
+
<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>
|
|
7448
|
+
<dl>
|
|
7449
|
+
<dd>
|
|
7450
|
+
|
|
7451
|
+
#### 📝 Description
|
|
7452
|
+
|
|
7453
|
+
<dl>
|
|
7454
|
+
<dd>
|
|
7455
|
+
|
|
7456
|
+
<dl>
|
|
7457
|
+
<dd>
|
|
7458
|
+
|
|
7459
|
+
**CLI:**
|
|
7460
|
+
```bash
|
|
7461
|
+
agentmail pods:lists list --pod-id <pod_id> --direction <direction> --type <type>
|
|
7462
|
+
```
|
|
7463
|
+
</dd>
|
|
7464
|
+
</dl>
|
|
7465
|
+
</dd>
|
|
7466
|
+
</dl>
|
|
7467
|
+
|
|
7468
|
+
#### 🔌 Usage
|
|
7469
|
+
|
|
7470
|
+
<dl>
|
|
7471
|
+
<dd>
|
|
7472
|
+
|
|
7473
|
+
<dl>
|
|
7474
|
+
<dd>
|
|
7475
|
+
|
|
7476
|
+
```typescript
|
|
7477
|
+
await client.pods.lists.list("pod_id", "send", "allow");
|
|
7478
|
+
|
|
7479
|
+
```
|
|
7480
|
+
</dd>
|
|
7481
|
+
</dl>
|
|
7482
|
+
</dd>
|
|
7483
|
+
</dl>
|
|
7484
|
+
|
|
7485
|
+
#### ⚙️ Parameters
|
|
7486
|
+
|
|
7487
|
+
<dl>
|
|
7488
|
+
<dd>
|
|
7489
|
+
|
|
7490
|
+
<dl>
|
|
7491
|
+
<dd>
|
|
7492
|
+
|
|
7493
|
+
**pod_id:** `AgentMail.PodId`
|
|
7494
|
+
|
|
7495
|
+
</dd>
|
|
7496
|
+
</dl>
|
|
7497
|
+
|
|
7498
|
+
<dl>
|
|
7499
|
+
<dd>
|
|
7500
|
+
|
|
7501
|
+
**direction:** `AgentMail.Direction`
|
|
7502
|
+
|
|
7503
|
+
</dd>
|
|
7504
|
+
</dl>
|
|
7505
|
+
|
|
7506
|
+
<dl>
|
|
7507
|
+
<dd>
|
|
7508
|
+
|
|
7509
|
+
**type:** `AgentMail.ListType`
|
|
7510
|
+
|
|
7511
|
+
</dd>
|
|
7512
|
+
</dl>
|
|
7513
|
+
|
|
7514
|
+
<dl>
|
|
7515
|
+
<dd>
|
|
7516
|
+
|
|
7517
|
+
**request:** `AgentMail.pods.ListListEntriesRequest`
|
|
7518
|
+
|
|
7519
|
+
</dd>
|
|
7520
|
+
</dl>
|
|
7521
|
+
|
|
7522
|
+
<dl>
|
|
7523
|
+
<dd>
|
|
7524
|
+
|
|
7525
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
7526
|
+
|
|
7527
|
+
</dd>
|
|
7528
|
+
</dl>
|
|
7529
|
+
</dd>
|
|
7530
|
+
</dl>
|
|
7531
|
+
|
|
7532
|
+
|
|
7533
|
+
</dd>
|
|
7534
|
+
</dl>
|
|
7535
|
+
</details>
|
|
7536
|
+
|
|
7537
|
+
<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>
|
|
7538
|
+
<dl>
|
|
7539
|
+
<dd>
|
|
7540
|
+
|
|
7541
|
+
#### 📝 Description
|
|
7542
|
+
|
|
7543
|
+
<dl>
|
|
7544
|
+
<dd>
|
|
7545
|
+
|
|
7546
|
+
<dl>
|
|
7547
|
+
<dd>
|
|
7548
|
+
|
|
7549
|
+
**CLI:**
|
|
7550
|
+
```bash
|
|
7551
|
+
agentmail pods:lists get --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
7552
|
+
```
|
|
7553
|
+
</dd>
|
|
7554
|
+
</dl>
|
|
7555
|
+
</dd>
|
|
7556
|
+
</dl>
|
|
7557
|
+
|
|
7558
|
+
#### 🔌 Usage
|
|
7559
|
+
|
|
7560
|
+
<dl>
|
|
7561
|
+
<dd>
|
|
7562
|
+
|
|
7563
|
+
<dl>
|
|
7564
|
+
<dd>
|
|
7565
|
+
|
|
7566
|
+
```typescript
|
|
7567
|
+
await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
7568
|
+
|
|
7569
|
+
```
|
|
7570
|
+
</dd>
|
|
7571
|
+
</dl>
|
|
7572
|
+
</dd>
|
|
7573
|
+
</dl>
|
|
7574
|
+
|
|
7575
|
+
#### ⚙️ Parameters
|
|
7576
|
+
|
|
7577
|
+
<dl>
|
|
7578
|
+
<dd>
|
|
7579
|
+
|
|
7580
|
+
<dl>
|
|
7581
|
+
<dd>
|
|
7582
|
+
|
|
7583
|
+
**pod_id:** `AgentMail.PodId`
|
|
7584
|
+
|
|
7585
|
+
</dd>
|
|
7586
|
+
</dl>
|
|
7587
|
+
|
|
7588
|
+
<dl>
|
|
7589
|
+
<dd>
|
|
7590
|
+
|
|
7591
|
+
**direction:** `AgentMail.Direction`
|
|
7592
|
+
|
|
7593
|
+
</dd>
|
|
7594
|
+
</dl>
|
|
7595
|
+
|
|
7596
|
+
<dl>
|
|
7597
|
+
<dd>
|
|
7598
|
+
|
|
7599
|
+
**type:** `AgentMail.ListType`
|
|
7600
|
+
|
|
7601
|
+
</dd>
|
|
7602
|
+
</dl>
|
|
7603
|
+
|
|
7604
|
+
<dl>
|
|
7605
|
+
<dd>
|
|
7606
|
+
|
|
7607
|
+
**entry:** `string` — Email address or domain.
|
|
7608
|
+
|
|
7609
|
+
</dd>
|
|
7610
|
+
</dl>
|
|
7611
|
+
|
|
7612
|
+
<dl>
|
|
7613
|
+
<dd>
|
|
7614
|
+
|
|
7615
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
7616
|
+
|
|
7617
|
+
</dd>
|
|
7618
|
+
</dl>
|
|
7619
|
+
</dd>
|
|
7620
|
+
</dl>
|
|
7621
|
+
|
|
7622
|
+
|
|
7623
|
+
</dd>
|
|
7624
|
+
</dl>
|
|
7625
|
+
</details>
|
|
7626
|
+
|
|
7627
|
+
<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>
|
|
7628
|
+
<dl>
|
|
7629
|
+
<dd>
|
|
7630
|
+
|
|
7631
|
+
#### 📝 Description
|
|
7632
|
+
|
|
7633
|
+
<dl>
|
|
7634
|
+
<dd>
|
|
7635
|
+
|
|
7636
|
+
<dl>
|
|
7637
|
+
<dd>
|
|
7638
|
+
|
|
7639
|
+
**CLI:**
|
|
7640
|
+
```bash
|
|
7641
|
+
agentmail pods:lists create --pod-id <pod_id> --direction <direction> --type <type> --entry user@example.com
|
|
7642
|
+
```
|
|
7643
|
+
</dd>
|
|
7644
|
+
</dl>
|
|
7645
|
+
</dd>
|
|
7646
|
+
</dl>
|
|
7647
|
+
|
|
7648
|
+
#### 🔌 Usage
|
|
7649
|
+
|
|
7650
|
+
<dl>
|
|
7651
|
+
<dd>
|
|
7652
|
+
|
|
7653
|
+
<dl>
|
|
7654
|
+
<dd>
|
|
7655
|
+
|
|
7656
|
+
```typescript
|
|
7657
|
+
await client.pods.lists.create("pod_id", "send", "allow", {
|
|
7658
|
+
entry: "entry"
|
|
7659
|
+
});
|
|
7660
|
+
|
|
7661
|
+
```
|
|
7662
|
+
</dd>
|
|
7663
|
+
</dl>
|
|
7664
|
+
</dd>
|
|
7665
|
+
</dl>
|
|
7666
|
+
|
|
7667
|
+
#### ⚙️ Parameters
|
|
7668
|
+
|
|
7669
|
+
<dl>
|
|
7670
|
+
<dd>
|
|
7671
|
+
|
|
7672
|
+
<dl>
|
|
7673
|
+
<dd>
|
|
7674
|
+
|
|
7675
|
+
**pod_id:** `AgentMail.PodId`
|
|
7676
|
+
|
|
7677
|
+
</dd>
|
|
7678
|
+
</dl>
|
|
7679
|
+
|
|
7680
|
+
<dl>
|
|
7681
|
+
<dd>
|
|
7682
|
+
|
|
7683
|
+
**direction:** `AgentMail.Direction`
|
|
7684
|
+
|
|
7685
|
+
</dd>
|
|
7686
|
+
</dl>
|
|
7687
|
+
|
|
7688
|
+
<dl>
|
|
7689
|
+
<dd>
|
|
7690
|
+
|
|
7691
|
+
**type:** `AgentMail.ListType`
|
|
7692
|
+
|
|
7693
|
+
</dd>
|
|
7694
|
+
</dl>
|
|
7695
|
+
|
|
7696
|
+
<dl>
|
|
7697
|
+
<dd>
|
|
7698
|
+
|
|
7699
|
+
**request:** `AgentMail.CreateListEntryRequest`
|
|
7700
|
+
|
|
7701
|
+
</dd>
|
|
7702
|
+
</dl>
|
|
7703
|
+
|
|
7704
|
+
<dl>
|
|
7705
|
+
<dd>
|
|
7706
|
+
|
|
7707
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
7708
|
+
|
|
7709
|
+
</dd>
|
|
7710
|
+
</dl>
|
|
7711
|
+
</dd>
|
|
7712
|
+
</dl>
|
|
7713
|
+
|
|
7714
|
+
|
|
7715
|
+
</dd>
|
|
7716
|
+
</dl>
|
|
7717
|
+
</details>
|
|
7718
|
+
|
|
7719
|
+
<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>
|
|
7720
|
+
<dl>
|
|
7721
|
+
<dd>
|
|
7722
|
+
|
|
7723
|
+
#### 📝 Description
|
|
7724
|
+
|
|
7725
|
+
<dl>
|
|
7726
|
+
<dd>
|
|
7727
|
+
|
|
7728
|
+
<dl>
|
|
7729
|
+
<dd>
|
|
7730
|
+
|
|
7731
|
+
**CLI:**
|
|
7732
|
+
```bash
|
|
7733
|
+
agentmail pods:lists delete --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
7734
|
+
```
|
|
7735
|
+
</dd>
|
|
7736
|
+
</dl>
|
|
7737
|
+
</dd>
|
|
7738
|
+
</dl>
|
|
7739
|
+
|
|
7740
|
+
#### 🔌 Usage
|
|
7741
|
+
|
|
7742
|
+
<dl>
|
|
7743
|
+
<dd>
|
|
7744
|
+
|
|
7745
|
+
<dl>
|
|
7746
|
+
<dd>
|
|
7747
|
+
|
|
7748
|
+
```typescript
|
|
7749
|
+
await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
7750
|
+
|
|
7751
|
+
```
|
|
7752
|
+
</dd>
|
|
7753
|
+
</dl>
|
|
7754
|
+
</dd>
|
|
7755
|
+
</dl>
|
|
7756
|
+
|
|
7757
|
+
#### ⚙️ Parameters
|
|
7758
|
+
|
|
7759
|
+
<dl>
|
|
7760
|
+
<dd>
|
|
7761
|
+
|
|
7762
|
+
<dl>
|
|
7763
|
+
<dd>
|
|
7764
|
+
|
|
7765
|
+
**pod_id:** `AgentMail.PodId`
|
|
7766
|
+
|
|
7767
|
+
</dd>
|
|
7768
|
+
</dl>
|
|
7769
|
+
|
|
7770
|
+
<dl>
|
|
7771
|
+
<dd>
|
|
7772
|
+
|
|
7773
|
+
**direction:** `AgentMail.Direction`
|
|
7774
|
+
|
|
7775
|
+
</dd>
|
|
7776
|
+
</dl>
|
|
7777
|
+
|
|
7778
|
+
<dl>
|
|
7779
|
+
<dd>
|
|
7780
|
+
|
|
7781
|
+
**type:** `AgentMail.ListType`
|
|
7782
|
+
|
|
7783
|
+
</dd>
|
|
7784
|
+
</dl>
|
|
7785
|
+
|
|
7786
|
+
<dl>
|
|
7787
|
+
<dd>
|
|
7788
|
+
|
|
7789
|
+
**entry:** `string` — Email address or domain.
|
|
7790
|
+
|
|
7791
|
+
</dd>
|
|
7792
|
+
</dl>
|
|
7793
|
+
|
|
7794
|
+
<dl>
|
|
7795
|
+
<dd>
|
|
7796
|
+
|
|
7797
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
7798
|
+
|
|
7799
|
+
</dd>
|
|
7800
|
+
</dl>
|
|
7801
|
+
</dd>
|
|
7802
|
+
</dl>
|
|
7803
|
+
|
|
7804
|
+
|
|
7805
|
+
</dd>
|
|
7806
|
+
</dl>
|
|
7807
|
+
</details>
|
|
7808
|
+
|
|
7809
|
+
## Pods Metrics
|
|
7810
|
+
<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>
|
|
7811
|
+
<dl>
|
|
7812
|
+
<dd>
|
|
7813
|
+
|
|
7814
|
+
#### 📝 Description
|
|
7815
|
+
|
|
7816
|
+
<dl>
|
|
7817
|
+
<dd>
|
|
7818
|
+
|
|
7819
|
+
<dl>
|
|
7820
|
+
<dd>
|
|
7821
|
+
|
|
7822
|
+
Counts of email events (sent, delivered, bounced, etc.) over time for
|
|
7823
|
+
the pod. Defaults to the last 24 hours; `start` must be within the last
|
|
7824
|
+
90 days, and a future `end` is clamped to now. Omit `period` for
|
|
7825
|
+
individual event counts, or set it to sum counts into buckets of that
|
|
7826
|
+
many seconds.
|
|
7827
|
+
|
|
7828
|
+
**CLI:**
|
|
7829
|
+
```bash
|
|
7830
|
+
agentmail pods:metrics query --pod-id <pod_id>
|
|
7831
|
+
```
|
|
7832
|
+
</dd>
|
|
7833
|
+
</dl>
|
|
7834
|
+
</dd>
|
|
7835
|
+
</dl>
|
|
7836
|
+
|
|
7837
|
+
#### 🔌 Usage
|
|
7838
|
+
|
|
7839
|
+
<dl>
|
|
7840
|
+
<dd>
|
|
7841
|
+
|
|
7842
|
+
<dl>
|
|
7843
|
+
<dd>
|
|
7844
|
+
|
|
7845
|
+
```typescript
|
|
7846
|
+
await client.pods.metrics.queryEvents("pod_id");
|
|
7847
|
+
|
|
7848
|
+
```
|
|
7849
|
+
</dd>
|
|
7850
|
+
</dl>
|
|
7851
|
+
</dd>
|
|
7852
|
+
</dl>
|
|
7853
|
+
|
|
7854
|
+
#### ⚙️ Parameters
|
|
7855
|
+
|
|
7856
|
+
<dl>
|
|
7857
|
+
<dd>
|
|
7858
|
+
|
|
7859
|
+
<dl>
|
|
7860
|
+
<dd>
|
|
7861
|
+
|
|
7862
|
+
**pod_id:** `AgentMail.PodId`
|
|
6547
7863
|
|
|
6548
7864
|
</dd>
|
|
6549
7865
|
</dl>
|
|
@@ -6551,7 +7867,7 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
6551
7867
|
<dl>
|
|
6552
7868
|
<dd>
|
|
6553
7869
|
|
|
6554
|
-
**request:** `AgentMail.
|
|
7870
|
+
**request:** `AgentMail.pods.QueryEventsRequest`
|
|
6555
7871
|
|
|
6556
7872
|
</dd>
|
|
6557
7873
|
</dl>
|
|
@@ -6559,7 +7875,7 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
6559
7875
|
<dl>
|
|
6560
7876
|
<dd>
|
|
6561
7877
|
|
|
6562
|
-
**requestOptions:** `
|
|
7878
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
6563
7879
|
|
|
6564
7880
|
</dd>
|
|
6565
7881
|
</dl>
|
|
@@ -6571,7 +7887,7 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
6571
7887
|
</dl>
|
|
6572
7888
|
</details>
|
|
6573
7889
|
|
|
6574
|
-
<details><summary><code>client.pods.
|
|
7890
|
+
<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>
|
|
6575
7891
|
<dl>
|
|
6576
7892
|
<dd>
|
|
6577
7893
|
|
|
@@ -6583,10 +7899,13 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
6583
7899
|
<dl>
|
|
6584
7900
|
<dd>
|
|
6585
7901
|
|
|
6586
|
-
|
|
6587
|
-
|
|
6588
|
-
|
|
6589
|
-
|
|
7902
|
+
Cumulative usage series for the pod. Each point is the running total of
|
|
7903
|
+
the usage type at that timestamp, not the change within the bucket.
|
|
7904
|
+
Pod-scoped queries carry every usage type except `pod_count`; requested
|
|
7905
|
+
types that don't apply to the scope are ignored. Defaults to the last
|
|
7906
|
+
24 hours; `start` must be within the last 90 days, and a future `end`
|
|
7907
|
+
is clamped to now. The range divided by `period` must not exceed 1000
|
|
7908
|
+
buckets.
|
|
6590
7909
|
</dd>
|
|
6591
7910
|
</dl>
|
|
6592
7911
|
</dd>
|
|
@@ -6601,7 +7920,7 @@ agentmail pods:inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
6601
7920
|
<dd>
|
|
6602
7921
|
|
|
6603
7922
|
```typescript
|
|
6604
|
-
await client.pods.
|
|
7923
|
+
await client.pods.metrics.queryUsage("pod_id");
|
|
6605
7924
|
|
|
6606
7925
|
```
|
|
6607
7926
|
</dd>
|
|
@@ -6625,7 +7944,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
6625
7944
|
<dl>
|
|
6626
7945
|
<dd>
|
|
6627
7946
|
|
|
6628
|
-
**
|
|
7947
|
+
**request:** `AgentMail.pods.QueryUsageRequest`
|
|
6629
7948
|
|
|
6630
7949
|
</dd>
|
|
6631
7950
|
</dl>
|
|
@@ -6633,7 +7952,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
6633
7952
|
<dl>
|
|
6634
7953
|
<dd>
|
|
6635
7954
|
|
|
6636
|
-
**requestOptions:** `
|
|
7955
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
6637
7956
|
|
|
6638
7957
|
</dd>
|
|
6639
7958
|
</dl>
|
|
@@ -6645,8 +7964,8 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
6645
7964
|
</dl>
|
|
6646
7965
|
</details>
|
|
6647
7966
|
|
|
6648
|
-
## Pods
|
|
6649
|
-
<details><summary><code>client.pods.
|
|
7967
|
+
## Pods Threads
|
|
7968
|
+
<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>
|
|
6650
7969
|
<dl>
|
|
6651
7970
|
<dd>
|
|
6652
7971
|
|
|
@@ -6658,9 +7977,14 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
6658
7977
|
<dl>
|
|
6659
7978
|
<dd>
|
|
6660
7979
|
|
|
7980
|
+
Lists threads in the pod, most recent first. Pass `senders`,
|
|
7981
|
+
`recipients`, or `subject` to filter by substring. Filtered requests are
|
|
7982
|
+
served by search, which caps `limit` at 100. For relevance-ranked
|
|
7983
|
+
full-text search, use `Search Threads`.
|
|
7984
|
+
|
|
6661
7985
|
**CLI:**
|
|
6662
7986
|
```bash
|
|
6663
|
-
agentmail pods:
|
|
7987
|
+
agentmail pods:threads list --pod-id <pod_id>
|
|
6664
7988
|
```
|
|
6665
7989
|
</dd>
|
|
6666
7990
|
</dl>
|
|
@@ -6676,7 +8000,7 @@ agentmail pods:lists list --pod-id <pod_id> --direction <direction> --type <type
|
|
|
6676
8000
|
<dd>
|
|
6677
8001
|
|
|
6678
8002
|
```typescript
|
|
6679
|
-
await client.pods.
|
|
8003
|
+
await client.pods.threads.list("pod_id");
|
|
6680
8004
|
|
|
6681
8005
|
```
|
|
6682
8006
|
</dd>
|
|
@@ -6700,23 +8024,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
6700
8024
|
<dl>
|
|
6701
8025
|
<dd>
|
|
6702
8026
|
|
|
6703
|
-
**
|
|
6704
|
-
|
|
6705
|
-
</dd>
|
|
6706
|
-
</dl>
|
|
6707
|
-
|
|
6708
|
-
<dl>
|
|
6709
|
-
<dd>
|
|
6710
|
-
|
|
6711
|
-
**type:** `AgentMail.ListType`
|
|
6712
|
-
|
|
6713
|
-
</dd>
|
|
6714
|
-
</dl>
|
|
6715
|
-
|
|
6716
|
-
<dl>
|
|
6717
|
-
<dd>
|
|
6718
|
-
|
|
6719
|
-
**request:** `AgentMail.pods.ListListEntriesRequest`
|
|
8027
|
+
**request:** `AgentMail.pods.ListThreadsRequest`
|
|
6720
8028
|
|
|
6721
8029
|
</dd>
|
|
6722
8030
|
</dl>
|
|
@@ -6724,7 +8032,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
6724
8032
|
<dl>
|
|
6725
8033
|
<dd>
|
|
6726
8034
|
|
|
6727
|
-
**requestOptions:** `
|
|
8035
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
6728
8036
|
|
|
6729
8037
|
</dd>
|
|
6730
8038
|
</dl>
|
|
@@ -6736,7 +8044,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
6736
8044
|
</dl>
|
|
6737
8045
|
</details>
|
|
6738
8046
|
|
|
6739
|
-
<details><summary><code>client.pods.
|
|
8047
|
+
<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>
|
|
6740
8048
|
<dl>
|
|
6741
8049
|
<dd>
|
|
6742
8050
|
|
|
@@ -6748,10 +8056,10 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
6748
8056
|
<dl>
|
|
6749
8057
|
<dd>
|
|
6750
8058
|
|
|
6751
|
-
|
|
6752
|
-
|
|
6753
|
-
|
|
6754
|
-
|
|
8059
|
+
Full-text search across threads in the pod, ranked by relevance. The
|
|
8060
|
+
query is matched against senders, recipients, and subject (substring)
|
|
8061
|
+
and the message body (tokenized full text). Spam, trash, blocked, and
|
|
8062
|
+
unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
6755
8063
|
</dd>
|
|
6756
8064
|
</dl>
|
|
6757
8065
|
</dd>
|
|
@@ -6766,7 +8074,9 @@ agentmail pods:lists get --pod-id <pod_id> --direction <direction> --type <type>
|
|
|
6766
8074
|
<dd>
|
|
6767
8075
|
|
|
6768
8076
|
```typescript
|
|
6769
|
-
await client.pods.
|
|
8077
|
+
await client.pods.threads.search("pod_id", {
|
|
8078
|
+
q: "q"
|
|
8079
|
+
});
|
|
6770
8080
|
|
|
6771
8081
|
```
|
|
6772
8082
|
</dd>
|
|
@@ -6790,23 +8100,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
6790
8100
|
<dl>
|
|
6791
8101
|
<dd>
|
|
6792
8102
|
|
|
6793
|
-
**
|
|
6794
|
-
|
|
6795
|
-
</dd>
|
|
6796
|
-
</dl>
|
|
6797
|
-
|
|
6798
|
-
<dl>
|
|
6799
|
-
<dd>
|
|
6800
|
-
|
|
6801
|
-
**type:** `AgentMail.ListType`
|
|
6802
|
-
|
|
6803
|
-
</dd>
|
|
6804
|
-
</dl>
|
|
6805
|
-
|
|
6806
|
-
<dl>
|
|
6807
|
-
<dd>
|
|
6808
|
-
|
|
6809
|
-
**entry:** `string` — Email address or domain.
|
|
8103
|
+
**request:** `AgentMail.pods.SearchThreadsRequest`
|
|
6810
8104
|
|
|
6811
8105
|
</dd>
|
|
6812
8106
|
</dl>
|
|
@@ -6814,7 +8108,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
6814
8108
|
<dl>
|
|
6815
8109
|
<dd>
|
|
6816
8110
|
|
|
6817
|
-
**requestOptions:** `
|
|
8111
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
6818
8112
|
|
|
6819
8113
|
</dd>
|
|
6820
8114
|
</dl>
|
|
@@ -6826,7 +8120,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
6826
8120
|
</dl>
|
|
6827
8121
|
</details>
|
|
6828
8122
|
|
|
6829
|
-
<details><summary><code>client.pods.
|
|
8123
|
+
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">get</a>(pod_id, thread_id) -> AgentMail.Thread</code></summary>
|
|
6830
8124
|
<dl>
|
|
6831
8125
|
<dd>
|
|
6832
8126
|
|
|
@@ -6840,7 +8134,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
6840
8134
|
|
|
6841
8135
|
**CLI:**
|
|
6842
8136
|
```bash
|
|
6843
|
-
agentmail pods:
|
|
8137
|
+
agentmail pods:threads get --pod-id <pod_id> --thread-id <thread_id>
|
|
6844
8138
|
```
|
|
6845
8139
|
</dd>
|
|
6846
8140
|
</dl>
|
|
@@ -6856,9 +8150,7 @@ agentmail pods:lists create --pod-id <pod_id> --direction <direction> --type <ty
|
|
|
6856
8150
|
<dd>
|
|
6857
8151
|
|
|
6858
8152
|
```typescript
|
|
6859
|
-
await client.pods.
|
|
6860
|
-
entry: "entry"
|
|
6861
|
-
});
|
|
8153
|
+
await client.pods.threads.get("pod_id", "thread_id");
|
|
6862
8154
|
|
|
6863
8155
|
```
|
|
6864
8156
|
</dd>
|
|
@@ -6882,23 +8174,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
6882
8174
|
<dl>
|
|
6883
8175
|
<dd>
|
|
6884
8176
|
|
|
6885
|
-
**
|
|
6886
|
-
|
|
6887
|
-
</dd>
|
|
6888
|
-
</dl>
|
|
6889
|
-
|
|
6890
|
-
<dl>
|
|
6891
|
-
<dd>
|
|
6892
|
-
|
|
6893
|
-
**type:** `AgentMail.ListType`
|
|
6894
|
-
|
|
6895
|
-
</dd>
|
|
6896
|
-
</dl>
|
|
6897
|
-
|
|
6898
|
-
<dl>
|
|
6899
|
-
<dd>
|
|
6900
|
-
|
|
6901
|
-
**request:** `AgentMail.CreateListEntryRequest`
|
|
8177
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
6902
8178
|
|
|
6903
8179
|
</dd>
|
|
6904
8180
|
</dl>
|
|
@@ -6906,7 +8182,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
6906
8182
|
<dl>
|
|
6907
8183
|
<dd>
|
|
6908
8184
|
|
|
6909
|
-
**requestOptions:** `
|
|
8185
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
6910
8186
|
|
|
6911
8187
|
</dd>
|
|
6912
8188
|
</dl>
|
|
@@ -6918,7 +8194,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
6918
8194
|
</dl>
|
|
6919
8195
|
</details>
|
|
6920
8196
|
|
|
6921
|
-
<details><summary><code>client.pods.
|
|
8197
|
+
<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>
|
|
6922
8198
|
<dl>
|
|
6923
8199
|
<dd>
|
|
6924
8200
|
|
|
@@ -6932,7 +8208,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
6932
8208
|
|
|
6933
8209
|
**CLI:**
|
|
6934
8210
|
```bash
|
|
6935
|
-
agentmail pods:
|
|
8211
|
+
agentmail pods:threads get-attachment --pod-id <pod_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
6936
8212
|
```
|
|
6937
8213
|
</dd>
|
|
6938
8214
|
</dl>
|
|
@@ -6948,7 +8224,7 @@ agentmail pods:lists delete --pod-id <pod_id> --direction <direction> --type <ty
|
|
|
6948
8224
|
<dd>
|
|
6949
8225
|
|
|
6950
8226
|
```typescript
|
|
6951
|
-
await client.pods.
|
|
8227
|
+
await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
6952
8228
|
|
|
6953
8229
|
```
|
|
6954
8230
|
</dd>
|
|
@@ -6972,15 +8248,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
6972
8248
|
<dl>
|
|
6973
8249
|
<dd>
|
|
6974
8250
|
|
|
6975
|
-
**
|
|
6976
|
-
|
|
6977
|
-
</dd>
|
|
6978
|
-
</dl>
|
|
6979
|
-
|
|
6980
|
-
<dl>
|
|
6981
|
-
<dd>
|
|
6982
|
-
|
|
6983
|
-
**type:** `AgentMail.ListType`
|
|
8251
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
6984
8252
|
|
|
6985
8253
|
</dd>
|
|
6986
8254
|
</dl>
|
|
@@ -6988,7 +8256,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
6988
8256
|
<dl>
|
|
6989
8257
|
<dd>
|
|
6990
8258
|
|
|
6991
|
-
**
|
|
8259
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
6992
8260
|
|
|
6993
8261
|
</dd>
|
|
6994
8262
|
</dl>
|
|
@@ -6996,7 +8264,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
6996
8264
|
<dl>
|
|
6997
8265
|
<dd>
|
|
6998
8266
|
|
|
6999
|
-
**requestOptions:** `
|
|
8267
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
7000
8268
|
|
|
7001
8269
|
</dd>
|
|
7002
8270
|
</dl>
|
|
@@ -7008,8 +8276,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
7008
8276
|
</dl>
|
|
7009
8277
|
</details>
|
|
7010
8278
|
|
|
7011
|
-
|
|
7012
|
-
<details><summary><code>client.pods.metrics.<a href="/src/api/resources/pods/resources/metrics/client/Client.ts">query</a>(pod_id, { ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
8279
|
+
<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>
|
|
7013
8280
|
<dl>
|
|
7014
8281
|
<dd>
|
|
7015
8282
|
|
|
@@ -7021,10 +8288,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
7021
8288
|
<dl>
|
|
7022
8289
|
<dd>
|
|
7023
8290
|
|
|
7024
|
-
|
|
7025
|
-
```bash
|
|
7026
|
-
agentmail pods:metrics query --pod-id <pod_id>
|
|
7027
|
-
```
|
|
8291
|
+
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.
|
|
7028
8292
|
</dd>
|
|
7029
8293
|
</dl>
|
|
7030
8294
|
</dd>
|
|
@@ -7039,7 +8303,7 @@ agentmail pods:metrics query --pod-id <pod_id>
|
|
|
7039
8303
|
<dd>
|
|
7040
8304
|
|
|
7041
8305
|
```typescript
|
|
7042
|
-
await client.pods.
|
|
8306
|
+
await client.pods.threads.update("pod_id", "thread_id", {});
|
|
7043
8307
|
|
|
7044
8308
|
```
|
|
7045
8309
|
</dd>
|
|
@@ -7063,7 +8327,7 @@ await client.pods.metrics.query("pod_id");
|
|
|
7063
8327
|
<dl>
|
|
7064
8328
|
<dd>
|
|
7065
8329
|
|
|
7066
|
-
**
|
|
8330
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
7067
8331
|
|
|
7068
8332
|
</dd>
|
|
7069
8333
|
</dl>
|
|
@@ -7071,7 +8335,15 @@ await client.pods.metrics.query("pod_id");
|
|
|
7071
8335
|
<dl>
|
|
7072
8336
|
<dd>
|
|
7073
8337
|
|
|
7074
|
-
**
|
|
8338
|
+
**request:** `AgentMail.UpdateThreadRequest`
|
|
8339
|
+
|
|
8340
|
+
</dd>
|
|
8341
|
+
</dl>
|
|
8342
|
+
|
|
8343
|
+
<dl>
|
|
8344
|
+
<dd>
|
|
8345
|
+
|
|
8346
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
7075
8347
|
|
|
7076
8348
|
</dd>
|
|
7077
8349
|
</dl>
|
|
@@ -7083,8 +8355,7 @@ await client.pods.metrics.query("pod_id");
|
|
|
7083
8355
|
</dl>
|
|
7084
8356
|
</details>
|
|
7085
8357
|
|
|
7086
|
-
|
|
7087
|
-
<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>
|
|
8358
|
+
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">delete</a>(pod_id, thread_id, { ...params }) -> void</code></summary>
|
|
7088
8359
|
<dl>
|
|
7089
8360
|
<dd>
|
|
7090
8361
|
|
|
@@ -7096,14 +8367,11 @@ await client.pods.metrics.query("pod_id");
|
|
|
7096
8367
|
<dl>
|
|
7097
8368
|
<dd>
|
|
7098
8369
|
|
|
7099
|
-
|
|
7100
|
-
`recipients`, or `subject` to filter by substring. Filtered requests are
|
|
7101
|
-
served by search, which caps `limit` at 100. For relevance-ranked
|
|
7102
|
-
full-text search, use `Search Threads`.
|
|
8370
|
+
Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
|
|
7103
8371
|
|
|
7104
8372
|
**CLI:**
|
|
7105
8373
|
```bash
|
|
7106
|
-
agentmail pods:threads
|
|
8374
|
+
agentmail pods:threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
7107
8375
|
```
|
|
7108
8376
|
</dd>
|
|
7109
8377
|
</dl>
|
|
@@ -7119,7 +8387,7 @@ agentmail pods:threads list --pod-id <pod_id>
|
|
|
7119
8387
|
<dd>
|
|
7120
8388
|
|
|
7121
8389
|
```typescript
|
|
7122
|
-
await client.pods.threads.
|
|
8390
|
+
await client.pods.threads.delete("pod_id", "thread_id");
|
|
7123
8391
|
|
|
7124
8392
|
```
|
|
7125
8393
|
</dd>
|
|
@@ -7143,7 +8411,15 @@ await client.pods.threads.list("pod_id");
|
|
|
7143
8411
|
<dl>
|
|
7144
8412
|
<dd>
|
|
7145
8413
|
|
|
7146
|
-
**
|
|
8414
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
8415
|
+
|
|
8416
|
+
</dd>
|
|
8417
|
+
</dl>
|
|
8418
|
+
|
|
8419
|
+
<dl>
|
|
8420
|
+
<dd>
|
|
8421
|
+
|
|
8422
|
+
**request:** `AgentMail.pods.DeleteThreadRequest`
|
|
7147
8423
|
|
|
7148
8424
|
</dd>
|
|
7149
8425
|
</dl>
|
|
@@ -7163,7 +8439,8 @@ await client.pods.threads.list("pod_id");
|
|
|
7163
8439
|
</dl>
|
|
7164
8440
|
</details>
|
|
7165
8441
|
|
|
7166
|
-
|
|
8442
|
+
## Pods Webhooks
|
|
8443
|
+
<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>
|
|
7167
8444
|
<dl>
|
|
7168
8445
|
<dd>
|
|
7169
8446
|
|
|
@@ -7175,10 +8452,10 @@ await client.pods.threads.list("pod_id");
|
|
|
7175
8452
|
<dl>
|
|
7176
8453
|
<dd>
|
|
7177
8454
|
|
|
7178
|
-
|
|
7179
|
-
|
|
7180
|
-
|
|
7181
|
-
|
|
8455
|
+
**CLI:**
|
|
8456
|
+
```bash
|
|
8457
|
+
agentmail pods:webhooks list --pod-id <pod_id>
|
|
8458
|
+
```
|
|
7182
8459
|
</dd>
|
|
7183
8460
|
</dl>
|
|
7184
8461
|
</dd>
|
|
@@ -7193,9 +8470,7 @@ unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
|
7193
8470
|
<dd>
|
|
7194
8471
|
|
|
7195
8472
|
```typescript
|
|
7196
|
-
await client.pods.
|
|
7197
|
-
q: "q"
|
|
7198
|
-
});
|
|
8473
|
+
await client.pods.webhooks.list("pod_id");
|
|
7199
8474
|
|
|
7200
8475
|
```
|
|
7201
8476
|
</dd>
|
|
@@ -7219,7 +8494,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
7219
8494
|
<dl>
|
|
7220
8495
|
<dd>
|
|
7221
8496
|
|
|
7222
|
-
**request:** `AgentMail.pods.
|
|
8497
|
+
**request:** `AgentMail.pods.PodListWebhooksRequest`
|
|
7223
8498
|
|
|
7224
8499
|
</dd>
|
|
7225
8500
|
</dl>
|
|
@@ -7227,7 +8502,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
7227
8502
|
<dl>
|
|
7228
8503
|
<dd>
|
|
7229
8504
|
|
|
7230
|
-
**requestOptions:** `
|
|
8505
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
7231
8506
|
|
|
7232
8507
|
</dd>
|
|
7233
8508
|
</dl>
|
|
@@ -7239,7 +8514,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
7239
8514
|
</dl>
|
|
7240
8515
|
</details>
|
|
7241
8516
|
|
|
7242
|
-
<details><summary><code>client.pods.
|
|
8517
|
+
<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>
|
|
7243
8518
|
<dl>
|
|
7244
8519
|
<dd>
|
|
7245
8520
|
|
|
@@ -7253,7 +8528,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
7253
8528
|
|
|
7254
8529
|
**CLI:**
|
|
7255
8530
|
```bash
|
|
7256
|
-
agentmail pods:
|
|
8531
|
+
agentmail pods:webhooks get --pod-id <pod_id> --webhook-id <webhook_id>
|
|
7257
8532
|
```
|
|
7258
8533
|
</dd>
|
|
7259
8534
|
</dl>
|
|
@@ -7269,7 +8544,7 @@ agentmail pods:threads get --pod-id <pod_id> --thread-id <thread_id>
|
|
|
7269
8544
|
<dd>
|
|
7270
8545
|
|
|
7271
8546
|
```typescript
|
|
7272
|
-
await client.pods.
|
|
8547
|
+
await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
7273
8548
|
|
|
7274
8549
|
```
|
|
7275
8550
|
</dd>
|
|
@@ -7293,7 +8568,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
7293
8568
|
<dl>
|
|
7294
8569
|
<dd>
|
|
7295
8570
|
|
|
7296
|
-
**
|
|
8571
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
7297
8572
|
|
|
7298
8573
|
</dd>
|
|
7299
8574
|
</dl>
|
|
@@ -7301,7 +8576,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
7301
8576
|
<dl>
|
|
7302
8577
|
<dd>
|
|
7303
8578
|
|
|
7304
|
-
**requestOptions:** `
|
|
8579
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
7305
8580
|
|
|
7306
8581
|
</dd>
|
|
7307
8582
|
</dl>
|
|
@@ -7313,7 +8588,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
7313
8588
|
</dl>
|
|
7314
8589
|
</details>
|
|
7315
8590
|
|
|
7316
|
-
<details><summary><code>client.pods.
|
|
8591
|
+
<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>
|
|
7317
8592
|
<dl>
|
|
7318
8593
|
<dd>
|
|
7319
8594
|
|
|
@@ -7325,9 +8600,11 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
7325
8600
|
<dl>
|
|
7326
8601
|
<dd>
|
|
7327
8602
|
|
|
8603
|
+
Create a webhook scoped to this pod.
|
|
8604
|
+
|
|
7328
8605
|
**CLI:**
|
|
7329
8606
|
```bash
|
|
7330
|
-
agentmail pods:
|
|
8607
|
+
agentmail pods:webhooks create --pod-id <pod_id> --url https://example.com/webhook --event-type message.received
|
|
7331
8608
|
```
|
|
7332
8609
|
</dd>
|
|
7333
8610
|
</dl>
|
|
@@ -7343,7 +8620,10 @@ agentmail pods:threads get-attachment --pod-id <pod_id> --thread-id <thread_id>
|
|
|
7343
8620
|
<dd>
|
|
7344
8621
|
|
|
7345
8622
|
```typescript
|
|
7346
|
-
await client.pods.
|
|
8623
|
+
await client.pods.webhooks.create("pod_id", {
|
|
8624
|
+
url: "url",
|
|
8625
|
+
eventTypes: ["message.received", "message.received"]
|
|
8626
|
+
});
|
|
7347
8627
|
|
|
7348
8628
|
```
|
|
7349
8629
|
</dd>
|
|
@@ -7367,15 +8647,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
7367
8647
|
<dl>
|
|
7368
8648
|
<dd>
|
|
7369
8649
|
|
|
7370
|
-
**
|
|
7371
|
-
|
|
7372
|
-
</dd>
|
|
7373
|
-
</dl>
|
|
7374
|
-
|
|
7375
|
-
<dl>
|
|
7376
|
-
<dd>
|
|
7377
|
-
|
|
7378
|
-
**attachment_id:** `AgentMail.AttachmentId`
|
|
8650
|
+
**request:** `AgentMail.CreatePodWebhookRequest`
|
|
7379
8651
|
|
|
7380
8652
|
</dd>
|
|
7381
8653
|
</dl>
|
|
@@ -7383,7 +8655,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
7383
8655
|
<dl>
|
|
7384
8656
|
<dd>
|
|
7385
8657
|
|
|
7386
|
-
**requestOptions:** `
|
|
8658
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
7387
8659
|
|
|
7388
8660
|
</dd>
|
|
7389
8661
|
</dl>
|
|
@@ -7395,7 +8667,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
7395
8667
|
</dl>
|
|
7396
8668
|
</details>
|
|
7397
8669
|
|
|
7398
|
-
<details><summary><code>client.pods.
|
|
8670
|
+
<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>
|
|
7399
8671
|
<dl>
|
|
7400
8672
|
<dd>
|
|
7401
8673
|
|
|
@@ -7407,7 +8679,10 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
7407
8679
|
<dl>
|
|
7408
8680
|
<dd>
|
|
7409
8681
|
|
|
7410
|
-
|
|
8682
|
+
**CLI:**
|
|
8683
|
+
```bash
|
|
8684
|
+
agentmail pods:webhooks update --pod-id <pod_id> --webhook-id <webhook_id> --add-inbox-id <inbox_id>
|
|
8685
|
+
```
|
|
7411
8686
|
</dd>
|
|
7412
8687
|
</dl>
|
|
7413
8688
|
</dd>
|
|
@@ -7422,7 +8697,7 @@ Updates thread labels. Cannot add or remove system labels (sent, received, bounc
|
|
|
7422
8697
|
<dd>
|
|
7423
8698
|
|
|
7424
8699
|
```typescript
|
|
7425
|
-
await client.pods.
|
|
8700
|
+
await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
7426
8701
|
|
|
7427
8702
|
```
|
|
7428
8703
|
</dd>
|
|
@@ -7446,7 +8721,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
7446
8721
|
<dl>
|
|
7447
8722
|
<dd>
|
|
7448
8723
|
|
|
7449
|
-
**
|
|
8724
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
7450
8725
|
|
|
7451
8726
|
</dd>
|
|
7452
8727
|
</dl>
|
|
@@ -7454,7 +8729,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
7454
8729
|
<dl>
|
|
7455
8730
|
<dd>
|
|
7456
8731
|
|
|
7457
|
-
**request:** `AgentMail.
|
|
8732
|
+
**request:** `AgentMail.UpdatePodWebhookRequest`
|
|
7458
8733
|
|
|
7459
8734
|
</dd>
|
|
7460
8735
|
</dl>
|
|
@@ -7462,7 +8737,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
7462
8737
|
<dl>
|
|
7463
8738
|
<dd>
|
|
7464
8739
|
|
|
7465
|
-
**requestOptions:** `
|
|
8740
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
7466
8741
|
|
|
7467
8742
|
</dd>
|
|
7468
8743
|
</dl>
|
|
@@ -7474,7 +8749,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
7474
8749
|
</dl>
|
|
7475
8750
|
</details>
|
|
7476
8751
|
|
|
7477
|
-
<details><summary><code>client.pods.
|
|
8752
|
+
<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>
|
|
7478
8753
|
<dl>
|
|
7479
8754
|
<dd>
|
|
7480
8755
|
|
|
@@ -7486,11 +8761,9 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
7486
8761
|
<dl>
|
|
7487
8762
|
<dd>
|
|
7488
8763
|
|
|
7489
|
-
Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
|
|
7490
|
-
|
|
7491
8764
|
**CLI:**
|
|
7492
8765
|
```bash
|
|
7493
|
-
agentmail pods:
|
|
8766
|
+
agentmail pods:webhooks delete --pod-id <pod_id> --webhook-id <webhook_id>
|
|
7494
8767
|
```
|
|
7495
8768
|
</dd>
|
|
7496
8769
|
</dl>
|
|
@@ -7506,7 +8779,7 @@ agentmail pods:threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
|
7506
8779
|
<dd>
|
|
7507
8780
|
|
|
7508
8781
|
```typescript
|
|
7509
|
-
await client.pods.
|
|
8782
|
+
await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
7510
8783
|
|
|
7511
8784
|
```
|
|
7512
8785
|
</dd>
|
|
@@ -7530,15 +8803,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
7530
8803
|
<dl>
|
|
7531
8804
|
<dd>
|
|
7532
8805
|
|
|
7533
|
-
**
|
|
7534
|
-
|
|
7535
|
-
</dd>
|
|
7536
|
-
</dl>
|
|
7537
|
-
|
|
7538
|
-
<dl>
|
|
7539
|
-
<dd>
|
|
7540
|
-
|
|
7541
|
-
**request:** `AgentMail.pods.DeleteThreadRequest`
|
|
8806
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
7542
8807
|
|
|
7543
8808
|
</dd>
|
|
7544
8809
|
</dl>
|
|
@@ -7546,7 +8811,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
7546
8811
|
<dl>
|
|
7547
8812
|
<dd>
|
|
7548
8813
|
|
|
7549
|
-
**requestOptions:** `
|
|
8814
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
7550
8815
|
|
|
7551
8816
|
</dd>
|
|
7552
8817
|
</dl>
|