agentmail 0.5.12 → 0.5.14
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.d.ts +3 -0
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/errors/ConflictError.d.ts +6 -0
- package/dist/cjs/api/errors/ConflictError.js +54 -0
- package/dist/cjs/api/errors/index.d.ts +1 -0
- package/dist/cjs/api/errors/index.js +1 -0
- package/dist/cjs/api/resources/drafts/types/CreateDraftForwardRequest.d.ts +21 -0
- package/dist/cjs/api/resources/drafts/types/CreateDraftForwardRequest.js +3 -0
- package/dist/cjs/api/resources/drafts/types/CreateDraftReplyAllRequest.d.ts +17 -0
- package/dist/cjs/api/resources/drafts/types/CreateDraftReplyAllRequest.js +3 -0
- package/dist/cjs/api/resources/drafts/types/CreateDraftReplyRequest.d.ts +22 -0
- package/dist/cjs/api/resources/drafts/types/CreateDraftReplyRequest.js +3 -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/drafts/client/Client.d.ts +6 -3
- package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.js +11 -2
- 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 +84 -9
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +308 -8
- 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/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/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/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.d.mts +3 -0
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/errors/ConflictError.d.mts +6 -0
- package/dist/esm/api/errors/ConflictError.mjs +17 -0
- package/dist/esm/api/errors/index.d.mts +1 -0
- package/dist/esm/api/errors/index.mjs +1 -0
- package/dist/esm/api/resources/drafts/types/CreateDraftForwardRequest.d.mts +21 -0
- package/dist/esm/api/resources/drafts/types/CreateDraftForwardRequest.mjs +2 -0
- package/dist/esm/api/resources/drafts/types/CreateDraftReplyAllRequest.d.mts +17 -0
- package/dist/esm/api/resources/drafts/types/CreateDraftReplyAllRequest.mjs +2 -0
- package/dist/esm/api/resources/drafts/types/CreateDraftReplyRequest.d.mts +22 -0
- package/dist/esm/api/resources/drafts/types/CreateDraftReplyRequest.mjs +2 -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/drafts/client/Client.d.mts +6 -3
- package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.mjs +12 -3
- 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 +84 -9
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +309 -9
- 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/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/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/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 +21 -4
- package/package.json +23 -1
- package/reference.md +1466 -440
package/reference.md
CHANGED
|
@@ -2794,7 +2794,7 @@ await client.inboxes.drafts.send("inbox_id", "draft_id", {});
|
|
|
2794
2794
|
<dl>
|
|
2795
2795
|
<dd>
|
|
2796
2796
|
|
|
2797
|
-
**requestOptions:** `DraftsClient.
|
|
2797
|
+
**requestOptions:** `DraftsClient.IdempotentRequestOptions`
|
|
2798
2798
|
|
|
2799
2799
|
</dd>
|
|
2800
2800
|
</dl>
|
|
@@ -4016,7 +4016,7 @@ await client.inboxes.messages.send("inbox_id", {});
|
|
|
4016
4016
|
<dl>
|
|
4017
4017
|
<dd>
|
|
4018
4018
|
|
|
4019
|
-
**requestOptions:** `MessagesClient.
|
|
4019
|
+
**requestOptions:** `MessagesClient.IdempotentRequestOptions`
|
|
4020
4020
|
|
|
4021
4021
|
</dd>
|
|
4022
4022
|
</dl>
|
|
@@ -4098,7 +4098,7 @@ await client.inboxes.messages.reply("inbox_id", "message_id", {});
|
|
|
4098
4098
|
<dl>
|
|
4099
4099
|
<dd>
|
|
4100
4100
|
|
|
4101
|
-
**requestOptions:** `MessagesClient.
|
|
4101
|
+
**requestOptions:** `MessagesClient.IdempotentRequestOptions`
|
|
4102
4102
|
|
|
4103
4103
|
</dd>
|
|
4104
4104
|
</dl>
|
|
@@ -4180,7 +4180,7 @@ await client.inboxes.messages.replyAll("inbox_id", "message_id", {});
|
|
|
4180
4180
|
<dl>
|
|
4181
4181
|
<dd>
|
|
4182
4182
|
|
|
4183
|
-
**requestOptions:** `MessagesClient.
|
|
4183
|
+
**requestOptions:** `MessagesClient.IdempotentRequestOptions`
|
|
4184
4184
|
|
|
4185
4185
|
</dd>
|
|
4186
4186
|
</dl>
|
|
@@ -4262,7 +4262,7 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
|
|
|
4262
4262
|
<dl>
|
|
4263
4263
|
<dd>
|
|
4264
4264
|
|
|
4265
|
-
**requestOptions:** `MessagesClient.
|
|
4265
|
+
**requestOptions:** `MessagesClient.IdempotentRequestOptions`
|
|
4266
4266
|
|
|
4267
4267
|
</dd>
|
|
4268
4268
|
</dl>
|
|
@@ -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">queryEvents</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,15 +4286,13 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
|
|
|
4287
4286
|
<dl>
|
|
4288
4287
|
<dd>
|
|
4289
4288
|
|
|
4290
|
-
|
|
4291
|
-
|
|
4292
|
-
|
|
4293
|
-
individual event counts, or set it to sum counts into buckets of that
|
|
4294
|
-
many seconds.
|
|
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`.
|
|
4295
4292
|
|
|
4296
4293
|
**CLI:**
|
|
4297
4294
|
```bash
|
|
4298
|
-
agentmail inboxes:
|
|
4295
|
+
agentmail inboxes:messages draft-reply --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
|
|
4299
4296
|
```
|
|
4300
4297
|
</dd>
|
|
4301
4298
|
</dl>
|
|
@@ -4311,7 +4308,7 @@ agentmail inboxes:metrics query --inbox-id <inbox_id>
|
|
|
4311
4308
|
<dd>
|
|
4312
4309
|
|
|
4313
4310
|
```typescript
|
|
4314
|
-
await client.inboxes.
|
|
4311
|
+
await client.inboxes.messages.draftReply("inbox_id", "message_id", {});
|
|
4315
4312
|
|
|
4316
4313
|
```
|
|
4317
4314
|
</dd>
|
|
@@ -4335,7 +4332,7 @@ await client.inboxes.metrics.queryEvents("inbox_id");
|
|
|
4335
4332
|
<dl>
|
|
4336
4333
|
<dd>
|
|
4337
4334
|
|
|
4338
|
-
**
|
|
4335
|
+
**message_id:** `AgentMail.MessageId`
|
|
4339
4336
|
|
|
4340
4337
|
</dd>
|
|
4341
4338
|
</dl>
|
|
@@ -4343,7 +4340,15 @@ await client.inboxes.metrics.queryEvents("inbox_id");
|
|
|
4343
4340
|
<dl>
|
|
4344
4341
|
<dd>
|
|
4345
4342
|
|
|
4346
|
-
**
|
|
4343
|
+
**request:** `AgentMail.CreateDraftReplyRequest`
|
|
4344
|
+
|
|
4345
|
+
</dd>
|
|
4346
|
+
</dl>
|
|
4347
|
+
|
|
4348
|
+
<dl>
|
|
4349
|
+
<dd>
|
|
4350
|
+
|
|
4351
|
+
**requestOptions:** `MessagesClient.RequestOptions`
|
|
4347
4352
|
|
|
4348
4353
|
</dd>
|
|
4349
4354
|
</dl>
|
|
@@ -4355,7 +4360,7 @@ await client.inboxes.metrics.queryEvents("inbox_id");
|
|
|
4355
4360
|
</dl>
|
|
4356
4361
|
</details>
|
|
4357
4362
|
|
|
4358
|
-
<details><summary><code>client.inboxes.
|
|
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>
|
|
4359
4364
|
<dl>
|
|
4360
4365
|
<dd>
|
|
4361
4366
|
|
|
@@ -4367,13 +4372,14 @@ await client.inboxes.metrics.queryEvents("inbox_id");
|
|
|
4367
4372
|
<dl>
|
|
4368
4373
|
<dd>
|
|
4369
4374
|
|
|
4370
|
-
|
|
4371
|
-
|
|
4372
|
-
|
|
4373
|
-
|
|
4374
|
-
|
|
4375
|
-
|
|
4376
|
-
|
|
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`.
|
|
4378
|
+
|
|
4379
|
+
**CLI:**
|
|
4380
|
+
```bash
|
|
4381
|
+
agentmail inboxes:messages draft-reply-all --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
|
|
4382
|
+
```
|
|
4377
4383
|
</dd>
|
|
4378
4384
|
</dl>
|
|
4379
4385
|
</dd>
|
|
@@ -4388,7 +4394,7 @@ by `period` must not exceed 1000 buckets.
|
|
|
4388
4394
|
<dd>
|
|
4389
4395
|
|
|
4390
4396
|
```typescript
|
|
4391
|
-
await client.inboxes.
|
|
4397
|
+
await client.inboxes.messages.draftReplyAll("inbox_id", "message_id", {});
|
|
4392
4398
|
|
|
4393
4399
|
```
|
|
4394
4400
|
</dd>
|
|
@@ -4412,7 +4418,7 @@ await client.inboxes.metrics.queryUsage("inbox_id");
|
|
|
4412
4418
|
<dl>
|
|
4413
4419
|
<dd>
|
|
4414
4420
|
|
|
4415
|
-
**
|
|
4421
|
+
**message_id:** `AgentMail.MessageId`
|
|
4416
4422
|
|
|
4417
4423
|
</dd>
|
|
4418
4424
|
</dl>
|
|
@@ -4420,7 +4426,15 @@ await client.inboxes.metrics.queryUsage("inbox_id");
|
|
|
4420
4426
|
<dl>
|
|
4421
4427
|
<dd>
|
|
4422
4428
|
|
|
4423
|
-
**
|
|
4429
|
+
**request:** `AgentMail.CreateDraftReplyAllRequest`
|
|
4430
|
+
|
|
4431
|
+
</dd>
|
|
4432
|
+
</dl>
|
|
4433
|
+
|
|
4434
|
+
<dl>
|
|
4435
|
+
<dd>
|
|
4436
|
+
|
|
4437
|
+
**requestOptions:** `MessagesClient.RequestOptions`
|
|
4424
4438
|
|
|
4425
4439
|
</dd>
|
|
4426
4440
|
</dl>
|
|
@@ -4432,8 +4446,7 @@ await client.inboxes.metrics.queryUsage("inbox_id");
|
|
|
4432
4446
|
</dl>
|
|
4433
4447
|
</details>
|
|
4434
4448
|
|
|
4435
|
-
|
|
4436
|
-
<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>
|
|
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>
|
|
4437
4450
|
<dl>
|
|
4438
4451
|
<dd>
|
|
4439
4452
|
|
|
@@ -4445,14 +4458,13 @@ await client.inboxes.metrics.queryUsage("inbox_id");
|
|
|
4445
4458
|
<dl>
|
|
4446
4459
|
<dd>
|
|
4447
4460
|
|
|
4448
|
-
|
|
4449
|
-
|
|
4450
|
-
|
|
4451
|
-
full-text search, use `Search Threads`.
|
|
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`.
|
|
4452
4464
|
|
|
4453
4465
|
**CLI:**
|
|
4454
4466
|
```bash
|
|
4455
|
-
agentmail inboxes:
|
|
4467
|
+
agentmail inboxes:messages draft-forward --inbox-id <inbox_id> --message-id <message_id> --to recipient@example.com
|
|
4456
4468
|
```
|
|
4457
4469
|
</dd>
|
|
4458
4470
|
</dl>
|
|
@@ -4468,7 +4480,7 @@ agentmail inboxes:threads list --inbox-id <inbox_id>
|
|
|
4468
4480
|
<dd>
|
|
4469
4481
|
|
|
4470
4482
|
```typescript
|
|
4471
|
-
await client.inboxes.
|
|
4483
|
+
await client.inboxes.messages.draftForward("inbox_id", "message_id", {});
|
|
4472
4484
|
|
|
4473
4485
|
```
|
|
4474
4486
|
</dd>
|
|
@@ -4492,7 +4504,7 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
4492
4504
|
<dl>
|
|
4493
4505
|
<dd>
|
|
4494
4506
|
|
|
4495
|
-
**
|
|
4507
|
+
**message_id:** `AgentMail.MessageId`
|
|
4496
4508
|
|
|
4497
4509
|
</dd>
|
|
4498
4510
|
</dl>
|
|
@@ -4500,7 +4512,15 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
4500
4512
|
<dl>
|
|
4501
4513
|
<dd>
|
|
4502
4514
|
|
|
4503
|
-
**
|
|
4515
|
+
**request:** `AgentMail.CreateDraftForwardRequest`
|
|
4516
|
+
|
|
4517
|
+
</dd>
|
|
4518
|
+
</dl>
|
|
4519
|
+
|
|
4520
|
+
<dl>
|
|
4521
|
+
<dd>
|
|
4522
|
+
|
|
4523
|
+
**requestOptions:** `MessagesClient.RequestOptions`
|
|
4504
4524
|
|
|
4505
4525
|
</dd>
|
|
4506
4526
|
</dl>
|
|
@@ -4512,7 +4532,8 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
4512
4532
|
</dl>
|
|
4513
4533
|
</details>
|
|
4514
4534
|
|
|
4515
|
-
|
|
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>
|
|
4516
4537
|
<dl>
|
|
4517
4538
|
<dd>
|
|
4518
4539
|
|
|
@@ -4524,10 +4545,16 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
4524
4545
|
<dl>
|
|
4525
4546
|
<dd>
|
|
4526
4547
|
|
|
4527
|
-
|
|
4528
|
-
|
|
4529
|
-
and
|
|
4530
|
-
|
|
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
|
+
|
|
4554
|
+
**CLI:**
|
|
4555
|
+
```bash
|
|
4556
|
+
agentmail inboxes:metrics query --inbox-id <inbox_id>
|
|
4557
|
+
```
|
|
4531
4558
|
</dd>
|
|
4532
4559
|
</dl>
|
|
4533
4560
|
</dd>
|
|
@@ -4542,9 +4569,7 @@ unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
|
4542
4569
|
<dd>
|
|
4543
4570
|
|
|
4544
4571
|
```typescript
|
|
4545
|
-
await client.inboxes.
|
|
4546
|
-
q: "q"
|
|
4547
|
-
});
|
|
4572
|
+
await client.inboxes.metrics.queryEvents("inbox_id");
|
|
4548
4573
|
|
|
4549
4574
|
```
|
|
4550
4575
|
</dd>
|
|
@@ -4568,7 +4593,7 @@ await client.inboxes.threads.search("inbox_id", {
|
|
|
4568
4593
|
<dl>
|
|
4569
4594
|
<dd>
|
|
4570
4595
|
|
|
4571
|
-
**request:** `AgentMail.inboxes.
|
|
4596
|
+
**request:** `AgentMail.inboxes.QueryEventsRequest`
|
|
4572
4597
|
|
|
4573
4598
|
</dd>
|
|
4574
4599
|
</dl>
|
|
@@ -4576,7 +4601,7 @@ await client.inboxes.threads.search("inbox_id", {
|
|
|
4576
4601
|
<dl>
|
|
4577
4602
|
<dd>
|
|
4578
4603
|
|
|
4579
|
-
**requestOptions:** `
|
|
4604
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
4580
4605
|
|
|
4581
4606
|
</dd>
|
|
4582
4607
|
</dl>
|
|
@@ -4588,7 +4613,7 @@ await client.inboxes.threads.search("inbox_id", {
|
|
|
4588
4613
|
</dl>
|
|
4589
4614
|
</details>
|
|
4590
4615
|
|
|
4591
|
-
<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>
|
|
4592
4617
|
<dl>
|
|
4593
4618
|
<dd>
|
|
4594
4619
|
|
|
@@ -4600,10 +4625,13 @@ await client.inboxes.threads.search("inbox_id", {
|
|
|
4600
4625
|
<dl>
|
|
4601
4626
|
<dd>
|
|
4602
4627
|
|
|
4603
|
-
|
|
4604
|
-
|
|
4605
|
-
|
|
4606
|
-
|
|
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.
|
|
4607
4635
|
</dd>
|
|
4608
4636
|
</dl>
|
|
4609
4637
|
</dd>
|
|
@@ -4618,7 +4646,7 @@ agentmail inboxes:threads get --inbox-id <inbox_id> --thread-id <thread_id>
|
|
|
4618
4646
|
<dd>
|
|
4619
4647
|
|
|
4620
4648
|
```typescript
|
|
4621
|
-
await client.inboxes.
|
|
4649
|
+
await client.inboxes.metrics.queryUsage("inbox_id");
|
|
4622
4650
|
|
|
4623
4651
|
```
|
|
4624
4652
|
</dd>
|
|
@@ -4642,7 +4670,7 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
4642
4670
|
<dl>
|
|
4643
4671
|
<dd>
|
|
4644
4672
|
|
|
4645
|
-
**
|
|
4673
|
+
**request:** `AgentMail.inboxes.QueryUsageRequest`
|
|
4646
4674
|
|
|
4647
4675
|
</dd>
|
|
4648
4676
|
</dl>
|
|
@@ -4650,7 +4678,7 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
4650
4678
|
<dl>
|
|
4651
4679
|
<dd>
|
|
4652
4680
|
|
|
4653
|
-
**requestOptions:** `
|
|
4681
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
4654
4682
|
|
|
4655
4683
|
</dd>
|
|
4656
4684
|
</dl>
|
|
@@ -4662,7 +4690,8 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
4662
4690
|
</dl>
|
|
4663
4691
|
</details>
|
|
4664
4692
|
|
|
4665
|
-
|
|
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>
|
|
4666
4695
|
<dl>
|
|
4667
4696
|
<dd>
|
|
4668
4697
|
|
|
@@ -4674,9 +4703,14 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
4674
4703
|
<dl>
|
|
4675
4704
|
<dd>
|
|
4676
4705
|
|
|
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
|
+
|
|
4677
4711
|
**CLI:**
|
|
4678
4712
|
```bash
|
|
4679
|
-
agentmail inboxes:threads
|
|
4713
|
+
agentmail inboxes:threads list --inbox-id <inbox_id>
|
|
4680
4714
|
```
|
|
4681
4715
|
</dd>
|
|
4682
4716
|
</dl>
|
|
@@ -4692,7 +4726,7 @@ agentmail inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thre
|
|
|
4692
4726
|
<dd>
|
|
4693
4727
|
|
|
4694
4728
|
```typescript
|
|
4695
|
-
await client.inboxes.threads.
|
|
4729
|
+
await client.inboxes.threads.list("inbox_id");
|
|
4696
4730
|
|
|
4697
4731
|
```
|
|
4698
4732
|
</dd>
|
|
@@ -4716,15 +4750,7 @@ await client.inboxes.threads.getAttachment("inbox_id", "thread_id", "attachment_
|
|
|
4716
4750
|
<dl>
|
|
4717
4751
|
<dd>
|
|
4718
4752
|
|
|
4719
|
-
**
|
|
4720
|
-
|
|
4721
|
-
</dd>
|
|
4722
|
-
</dl>
|
|
4723
|
-
|
|
4724
|
-
<dl>
|
|
4725
|
-
<dd>
|
|
4726
|
-
|
|
4727
|
-
**attachment_id:** `AgentMail.AttachmentId`
|
|
4753
|
+
**request:** `AgentMail.inboxes.ListThreadsRequest`
|
|
4728
4754
|
|
|
4729
4755
|
</dd>
|
|
4730
4756
|
</dl>
|
|
@@ -4744,7 +4770,7 @@ await client.inboxes.threads.getAttachment("inbox_id", "thread_id", "attachment_
|
|
|
4744
4770
|
</dl>
|
|
4745
4771
|
</details>
|
|
4746
4772
|
|
|
4747
|
-
<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>
|
|
4748
4774
|
<dl>
|
|
4749
4775
|
<dd>
|
|
4750
4776
|
|
|
@@ -4756,7 +4782,10 @@ await client.inboxes.threads.getAttachment("inbox_id", "thread_id", "attachment_
|
|
|
4756
4782
|
<dl>
|
|
4757
4783
|
<dd>
|
|
4758
4784
|
|
|
4759
|
-
|
|
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.
|
|
4760
4789
|
</dd>
|
|
4761
4790
|
</dl>
|
|
4762
4791
|
</dd>
|
|
@@ -4771,7 +4800,9 @@ Updates thread labels. Cannot add or remove system labels (sent, received, bounc
|
|
|
4771
4800
|
<dd>
|
|
4772
4801
|
|
|
4773
4802
|
```typescript
|
|
4774
|
-
await client.inboxes.threads.
|
|
4803
|
+
await client.inboxes.threads.search("inbox_id", {
|
|
4804
|
+
q: "q"
|
|
4805
|
+
});
|
|
4775
4806
|
|
|
4776
4807
|
```
|
|
4777
4808
|
</dd>
|
|
@@ -4795,15 +4826,7 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
|
4795
4826
|
<dl>
|
|
4796
4827
|
<dd>
|
|
4797
4828
|
|
|
4798
|
-
**
|
|
4799
|
-
|
|
4800
|
-
</dd>
|
|
4801
|
-
</dl>
|
|
4802
|
-
|
|
4803
|
-
<dl>
|
|
4804
|
-
<dd>
|
|
4805
|
-
|
|
4806
|
-
**request:** `AgentMail.UpdateThreadRequest`
|
|
4829
|
+
**request:** `AgentMail.inboxes.SearchThreadsRequest`
|
|
4807
4830
|
|
|
4808
4831
|
</dd>
|
|
4809
4832
|
</dl>
|
|
@@ -4823,7 +4846,7 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
|
4823
4846
|
</dl>
|
|
4824
4847
|
</details>
|
|
4825
4848
|
|
|
4826
|
-
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">
|
|
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>
|
|
4827
4850
|
<dl>
|
|
4828
4851
|
<dd>
|
|
4829
4852
|
|
|
@@ -4835,11 +4858,9 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
|
4835
4858
|
<dl>
|
|
4836
4859
|
<dd>
|
|
4837
4860
|
|
|
4838
|
-
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.
|
|
4839
|
-
|
|
4840
4861
|
**CLI:**
|
|
4841
4862
|
```bash
|
|
4842
|
-
agentmail inboxes:threads
|
|
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 inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>
|
|
|
4855
4876
|
<dd>
|
|
4856
4877
|
|
|
4857
4878
|
```typescript
|
|
4858
|
-
await client.inboxes.threads.
|
|
4879
|
+
await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
4859
4880
|
|
|
4860
4881
|
```
|
|
4861
4882
|
</dd>
|
|
@@ -4887,14 +4908,6 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
|
4887
4908
|
<dl>
|
|
4888
4909
|
<dd>
|
|
4889
4910
|
|
|
4890
|
-
**request:** `AgentMail.inboxes.DeleteThreadRequest`
|
|
4891
|
-
|
|
4892
|
-
</dd>
|
|
4893
|
-
</dl>
|
|
4894
|
-
|
|
4895
|
-
<dl>
|
|
4896
|
-
<dd>
|
|
4897
|
-
|
|
4898
4911
|
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
4899
4912
|
|
|
4900
4913
|
</dd>
|
|
@@ -4907,8 +4920,7 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
|
4907
4920
|
</dl>
|
|
4908
4921
|
</details>
|
|
4909
4922
|
|
|
4910
|
-
|
|
4911
|
-
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">list</a>(direction, type, { ...params }) -> AgentMail.ListListEntriesResponse</code></summary>
|
|
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>
|
|
4912
4924
|
<dl>
|
|
4913
4925
|
<dd>
|
|
4914
4926
|
|
|
@@ -4922,7 +4934,7 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
|
4922
4934
|
|
|
4923
4935
|
**CLI:**
|
|
4924
4936
|
```bash
|
|
4925
|
-
agentmail
|
|
4937
|
+
agentmail inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
4926
4938
|
```
|
|
4927
4939
|
</dd>
|
|
4928
4940
|
</dl>
|
|
@@ -4938,7 +4950,7 @@ agentmail lists list --direction <direction> --type <type>
|
|
|
4938
4950
|
<dd>
|
|
4939
4951
|
|
|
4940
4952
|
```typescript
|
|
4941
|
-
await client.
|
|
4953
|
+
await client.inboxes.threads.getAttachment("inbox_id", "thread_id", "attachment_id");
|
|
4942
4954
|
|
|
4943
4955
|
```
|
|
4944
4956
|
</dd>
|
|
@@ -4954,7 +4966,7 @@ await client.lists.list("send", "allow");
|
|
|
4954
4966
|
<dl>
|
|
4955
4967
|
<dd>
|
|
4956
4968
|
|
|
4957
|
-
**
|
|
4969
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
4958
4970
|
|
|
4959
4971
|
</dd>
|
|
4960
4972
|
</dl>
|
|
@@ -4962,7 +4974,7 @@ await client.lists.list("send", "allow");
|
|
|
4962
4974
|
<dl>
|
|
4963
4975
|
<dd>
|
|
4964
4976
|
|
|
4965
|
-
**
|
|
4977
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
4966
4978
|
|
|
4967
4979
|
</dd>
|
|
4968
4980
|
</dl>
|
|
@@ -4970,7 +4982,7 @@ await client.lists.list("send", "allow");
|
|
|
4970
4982
|
<dl>
|
|
4971
4983
|
<dd>
|
|
4972
4984
|
|
|
4973
|
-
**
|
|
4985
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
4974
4986
|
|
|
4975
4987
|
</dd>
|
|
4976
4988
|
</dl>
|
|
@@ -4978,7 +4990,7 @@ await client.lists.list("send", "allow");
|
|
|
4978
4990
|
<dl>
|
|
4979
4991
|
<dd>
|
|
4980
4992
|
|
|
4981
|
-
**requestOptions:** `
|
|
4993
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
4982
4994
|
|
|
4983
4995
|
</dd>
|
|
4984
4996
|
</dl>
|
|
@@ -4990,7 +5002,7 @@ await client.lists.list("send", "allow");
|
|
|
4990
5002
|
</dl>
|
|
4991
5003
|
</details>
|
|
4992
5004
|
|
|
4993
|
-
<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>
|
|
4994
5006
|
<dl>
|
|
4995
5007
|
<dd>
|
|
4996
5008
|
|
|
@@ -5002,10 +5014,7 @@ await client.lists.list("send", "allow");
|
|
|
5002
5014
|
<dl>
|
|
5003
5015
|
<dd>
|
|
5004
5016
|
|
|
5005
|
-
|
|
5006
|
-
```bash
|
|
5007
|
-
agentmail lists get --direction <direction> --type <type> --entry <entry>
|
|
5008
|
-
```
|
|
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.
|
|
5009
5018
|
</dd>
|
|
5010
5019
|
</dl>
|
|
5011
5020
|
</dd>
|
|
@@ -5020,7 +5029,7 @@ agentmail lists get --direction <direction> --type <type> --entry <entry>
|
|
|
5020
5029
|
<dd>
|
|
5021
5030
|
|
|
5022
5031
|
```typescript
|
|
5023
|
-
await client.
|
|
5032
|
+
await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
5024
5033
|
|
|
5025
5034
|
```
|
|
5026
5035
|
</dd>
|
|
@@ -5036,7 +5045,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
5036
5045
|
<dl>
|
|
5037
5046
|
<dd>
|
|
5038
5047
|
|
|
5039
|
-
**
|
|
5048
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5040
5049
|
|
|
5041
5050
|
</dd>
|
|
5042
5051
|
</dl>
|
|
@@ -5044,7 +5053,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
5044
5053
|
<dl>
|
|
5045
5054
|
<dd>
|
|
5046
5055
|
|
|
5047
|
-
**
|
|
5056
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
5048
5057
|
|
|
5049
5058
|
</dd>
|
|
5050
5059
|
</dl>
|
|
@@ -5052,7 +5061,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
5052
5061
|
<dl>
|
|
5053
5062
|
<dd>
|
|
5054
5063
|
|
|
5055
|
-
**
|
|
5064
|
+
**request:** `AgentMail.UpdateThreadRequest`
|
|
5056
5065
|
|
|
5057
5066
|
</dd>
|
|
5058
5067
|
</dl>
|
|
@@ -5060,7 +5069,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
5060
5069
|
<dl>
|
|
5061
5070
|
<dd>
|
|
5062
5071
|
|
|
5063
|
-
**requestOptions:** `
|
|
5072
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
5064
5073
|
|
|
5065
5074
|
</dd>
|
|
5066
5075
|
</dl>
|
|
@@ -5072,7 +5081,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
5072
5081
|
</dl>
|
|
5073
5082
|
</details>
|
|
5074
5083
|
|
|
5075
|
-
<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>
|
|
5076
5085
|
<dl>
|
|
5077
5086
|
<dd>
|
|
5078
5087
|
|
|
@@ -5084,9 +5093,11 @@ await client.lists.get("send", "allow", "entry");
|
|
|
5084
5093
|
<dl>
|
|
5085
5094
|
<dd>
|
|
5086
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
|
+
|
|
5087
5098
|
**CLI:**
|
|
5088
5099
|
```bash
|
|
5089
|
-
agentmail
|
|
5100
|
+
agentmail inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>
|
|
5090
5101
|
```
|
|
5091
5102
|
</dd>
|
|
5092
5103
|
</dl>
|
|
@@ -5102,9 +5113,7 @@ agentmail lists create --direction <direction> --type <type> --entry user@exampl
|
|
|
5102
5113
|
<dd>
|
|
5103
5114
|
|
|
5104
5115
|
```typescript
|
|
5105
|
-
await client.
|
|
5106
|
-
entry: "entry"
|
|
5107
|
-
});
|
|
5116
|
+
await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
5108
5117
|
|
|
5109
5118
|
```
|
|
5110
5119
|
</dd>
|
|
@@ -5120,7 +5129,7 @@ await client.lists.create("send", "allow", {
|
|
|
5120
5129
|
<dl>
|
|
5121
5130
|
<dd>
|
|
5122
5131
|
|
|
5123
|
-
**
|
|
5132
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5124
5133
|
|
|
5125
5134
|
</dd>
|
|
5126
5135
|
</dl>
|
|
@@ -5128,7 +5137,7 @@ await client.lists.create("send", "allow", {
|
|
|
5128
5137
|
<dl>
|
|
5129
5138
|
<dd>
|
|
5130
5139
|
|
|
5131
|
-
**
|
|
5140
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
5132
5141
|
|
|
5133
5142
|
</dd>
|
|
5134
5143
|
</dl>
|
|
@@ -5136,7 +5145,7 @@ await client.lists.create("send", "allow", {
|
|
|
5136
5145
|
<dl>
|
|
5137
5146
|
<dd>
|
|
5138
5147
|
|
|
5139
|
-
**request:** `AgentMail.
|
|
5148
|
+
**request:** `AgentMail.inboxes.DeleteThreadRequest`
|
|
5140
5149
|
|
|
5141
5150
|
</dd>
|
|
5142
5151
|
</dl>
|
|
@@ -5144,7 +5153,7 @@ await client.lists.create("send", "allow", {
|
|
|
5144
5153
|
<dl>
|
|
5145
5154
|
<dd>
|
|
5146
5155
|
|
|
5147
|
-
**requestOptions:** `
|
|
5156
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
5148
5157
|
|
|
5149
5158
|
</dd>
|
|
5150
5159
|
</dl>
|
|
@@ -5156,7 +5165,8 @@ await client.lists.create("send", "allow", {
|
|
|
5156
5165
|
</dl>
|
|
5157
5166
|
</details>
|
|
5158
5167
|
|
|
5159
|
-
|
|
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.create("send", "allow", {
|
|
|
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 lists delete --direction <direction> --type <type> --entry <entry>
|
|
|
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,15 +5212,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
5202
5212
|
<dl>
|
|
5203
5213
|
<dd>
|
|
5204
5214
|
|
|
5205
|
-
**
|
|
5206
|
-
|
|
5207
|
-
</dd>
|
|
5208
|
-
</dl>
|
|
5209
|
-
|
|
5210
|
-
<dl>
|
|
5211
|
-
<dd>
|
|
5212
|
-
|
|
5213
|
-
**type:** `AgentMail.ListType`
|
|
5215
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5214
5216
|
|
|
5215
5217
|
</dd>
|
|
5216
5218
|
</dl>
|
|
@@ -5218,7 +5220,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
5218
5220
|
<dl>
|
|
5219
5221
|
<dd>
|
|
5220
5222
|
|
|
5221
|
-
**
|
|
5223
|
+
**request:** `AgentMail.inboxes.InboxListWebhooksRequest`
|
|
5222
5224
|
|
|
5223
5225
|
</dd>
|
|
5224
5226
|
</dl>
|
|
@@ -5226,7 +5228,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
5226
5228
|
<dl>
|
|
5227
5229
|
<dd>
|
|
5228
5230
|
|
|
5229
|
-
**requestOptions:** `
|
|
5231
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
5230
5232
|
|
|
5231
5233
|
</dd>
|
|
5232
5234
|
</dl>
|
|
@@ -5238,8 +5240,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
5238
5240
|
</dl>
|
|
5239
5241
|
</details>
|
|
5240
5242
|
|
|
5241
|
-
|
|
5242
|
-
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryEvents</a>({ ...params }) -> AgentMail.QueryMetricsResponse</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>
|
|
5243
5244
|
<dl>
|
|
5244
5245
|
<dd>
|
|
5245
5246
|
|
|
@@ -5251,15 +5252,9 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
5251
5252
|
<dl>
|
|
5252
5253
|
<dd>
|
|
5253
5254
|
|
|
5254
|
-
Counts of email events (sent, delivered, bounced, etc.) over time for
|
|
5255
|
-
the organization. Defaults to the last 24 hours; `start` must be within
|
|
5256
|
-
the last 90 days, and a future `end` is clamped to now. Omit `period`
|
|
5257
|
-
for individual event counts, or set it to sum counts into buckets of
|
|
5258
|
-
that many seconds.
|
|
5259
|
-
|
|
5260
5255
|
**CLI:**
|
|
5261
5256
|
```bash
|
|
5262
|
-
agentmail
|
|
5257
|
+
agentmail inboxes:webhooks get --inbox-id <inbox_id> --webhook-id <webhook_id>
|
|
5263
5258
|
```
|
|
5264
5259
|
</dd>
|
|
5265
5260
|
</dl>
|
|
@@ -5275,7 +5270,7 @@ agentmail metrics list
|
|
|
5275
5270
|
<dd>
|
|
5276
5271
|
|
|
5277
5272
|
```typescript
|
|
5278
|
-
await client.
|
|
5273
|
+
await client.inboxes.webhooks.get("inbox_id", "webhook_id");
|
|
5279
5274
|
|
|
5280
5275
|
```
|
|
5281
5276
|
</dd>
|
|
@@ -5291,7 +5286,7 @@ await client.metrics.queryEvents();
|
|
|
5291
5286
|
<dl>
|
|
5292
5287
|
<dd>
|
|
5293
5288
|
|
|
5294
|
-
**
|
|
5289
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5295
5290
|
|
|
5296
5291
|
</dd>
|
|
5297
5292
|
</dl>
|
|
@@ -5299,19 +5294,869 @@ await client.metrics.queryEvents();
|
|
|
5299
5294
|
<dl>
|
|
5300
5295
|
<dd>
|
|
5301
5296
|
|
|
5302
|
-
**
|
|
5297
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
5303
5298
|
|
|
5304
5299
|
</dd>
|
|
5305
5300
|
</dl>
|
|
5306
|
-
</dd>
|
|
5307
|
-
</dl>
|
|
5308
5301
|
|
|
5302
|
+
<dl>
|
|
5303
|
+
<dd>
|
|
5309
5304
|
|
|
5310
|
-
|
|
5305
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
5306
|
+
|
|
5307
|
+
</dd>
|
|
5308
|
+
</dl>
|
|
5309
|
+
</dd>
|
|
5310
|
+
</dl>
|
|
5311
|
+
|
|
5312
|
+
|
|
5313
|
+
</dd>
|
|
5314
|
+
</dl>
|
|
5315
|
+
</details>
|
|
5316
|
+
|
|
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>
|
|
5318
|
+
<dl>
|
|
5319
|
+
<dd>
|
|
5320
|
+
|
|
5321
|
+
#### 📝 Description
|
|
5322
|
+
|
|
5323
|
+
<dl>
|
|
5324
|
+
<dd>
|
|
5325
|
+
|
|
5326
|
+
<dl>
|
|
5327
|
+
<dd>
|
|
5328
|
+
|
|
5329
|
+
Create a webhook scoped to this inbox.
|
|
5330
|
+
|
|
5331
|
+
**CLI:**
|
|
5332
|
+
```bash
|
|
5333
|
+
agentmail inboxes:webhooks create --inbox-id <inbox_id> --url https://example.com/webhook --event-type message.received
|
|
5334
|
+
```
|
|
5335
|
+
</dd>
|
|
5336
|
+
</dl>
|
|
5337
|
+
</dd>
|
|
5338
|
+
</dl>
|
|
5339
|
+
|
|
5340
|
+
#### 🔌 Usage
|
|
5341
|
+
|
|
5342
|
+
<dl>
|
|
5343
|
+
<dd>
|
|
5344
|
+
|
|
5345
|
+
<dl>
|
|
5346
|
+
<dd>
|
|
5347
|
+
|
|
5348
|
+
```typescript
|
|
5349
|
+
await client.inboxes.webhooks.create("inbox_id", {
|
|
5350
|
+
url: "url",
|
|
5351
|
+
eventTypes: ["message.received", "message.received"]
|
|
5352
|
+
});
|
|
5353
|
+
|
|
5354
|
+
```
|
|
5355
|
+
</dd>
|
|
5356
|
+
</dl>
|
|
5357
|
+
</dd>
|
|
5358
|
+
</dl>
|
|
5359
|
+
|
|
5360
|
+
#### ⚙️ Parameters
|
|
5361
|
+
|
|
5362
|
+
<dl>
|
|
5363
|
+
<dd>
|
|
5364
|
+
|
|
5365
|
+
<dl>
|
|
5366
|
+
<dd>
|
|
5367
|
+
|
|
5368
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5369
|
+
|
|
5370
|
+
</dd>
|
|
5371
|
+
</dl>
|
|
5372
|
+
|
|
5373
|
+
<dl>
|
|
5374
|
+
<dd>
|
|
5375
|
+
|
|
5376
|
+
**request:** `AgentMail.CreateInboxWebhookRequest`
|
|
5377
|
+
|
|
5378
|
+
</dd>
|
|
5379
|
+
</dl>
|
|
5380
|
+
|
|
5381
|
+
<dl>
|
|
5382
|
+
<dd>
|
|
5383
|
+
|
|
5384
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
5385
|
+
|
|
5386
|
+
</dd>
|
|
5387
|
+
</dl>
|
|
5388
|
+
</dd>
|
|
5389
|
+
</dl>
|
|
5390
|
+
|
|
5391
|
+
|
|
5392
|
+
</dd>
|
|
5393
|
+
</dl>
|
|
5394
|
+
</details>
|
|
5395
|
+
|
|
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>
|
|
5397
|
+
<dl>
|
|
5398
|
+
<dd>
|
|
5399
|
+
|
|
5400
|
+
#### 📝 Description
|
|
5401
|
+
|
|
5402
|
+
<dl>
|
|
5403
|
+
<dd>
|
|
5404
|
+
|
|
5405
|
+
<dl>
|
|
5406
|
+
<dd>
|
|
5407
|
+
|
|
5408
|
+
**CLI:**
|
|
5409
|
+
```bash
|
|
5410
|
+
agentmail inboxes:webhooks update --inbox-id <inbox_id> --webhook-id <webhook_id> --event-type message.received
|
|
5411
|
+
```
|
|
5412
|
+
</dd>
|
|
5413
|
+
</dl>
|
|
5414
|
+
</dd>
|
|
5415
|
+
</dl>
|
|
5416
|
+
|
|
5417
|
+
#### 🔌 Usage
|
|
5418
|
+
|
|
5419
|
+
<dl>
|
|
5420
|
+
<dd>
|
|
5421
|
+
|
|
5422
|
+
<dl>
|
|
5423
|
+
<dd>
|
|
5424
|
+
|
|
5425
|
+
```typescript
|
|
5426
|
+
await client.inboxes.webhooks.update("inbox_id", "webhook_id", {});
|
|
5427
|
+
|
|
5428
|
+
```
|
|
5429
|
+
</dd>
|
|
5430
|
+
</dl>
|
|
5431
|
+
</dd>
|
|
5432
|
+
</dl>
|
|
5433
|
+
|
|
5434
|
+
#### ⚙️ Parameters
|
|
5435
|
+
|
|
5436
|
+
<dl>
|
|
5437
|
+
<dd>
|
|
5438
|
+
|
|
5439
|
+
<dl>
|
|
5440
|
+
<dd>
|
|
5441
|
+
|
|
5442
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5443
|
+
|
|
5444
|
+
</dd>
|
|
5445
|
+
</dl>
|
|
5446
|
+
|
|
5447
|
+
<dl>
|
|
5448
|
+
<dd>
|
|
5449
|
+
|
|
5450
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
5451
|
+
|
|
5452
|
+
</dd>
|
|
5453
|
+
</dl>
|
|
5454
|
+
|
|
5455
|
+
<dl>
|
|
5456
|
+
<dd>
|
|
5457
|
+
|
|
5458
|
+
**request:** `AgentMail.UpdateInboxWebhookRequest`
|
|
5459
|
+
|
|
5460
|
+
</dd>
|
|
5461
|
+
</dl>
|
|
5462
|
+
|
|
5463
|
+
<dl>
|
|
5464
|
+
<dd>
|
|
5465
|
+
|
|
5466
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
5467
|
+
|
|
5468
|
+
</dd>
|
|
5469
|
+
</dl>
|
|
5470
|
+
</dd>
|
|
5471
|
+
</dl>
|
|
5472
|
+
|
|
5473
|
+
|
|
5474
|
+
</dd>
|
|
5475
|
+
</dl>
|
|
5476
|
+
</details>
|
|
5477
|
+
|
|
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>
|
|
5479
|
+
<dl>
|
|
5480
|
+
<dd>
|
|
5481
|
+
|
|
5482
|
+
#### 📝 Description
|
|
5483
|
+
|
|
5484
|
+
<dl>
|
|
5485
|
+
<dd>
|
|
5486
|
+
|
|
5487
|
+
<dl>
|
|
5488
|
+
<dd>
|
|
5489
|
+
|
|
5490
|
+
**CLI:**
|
|
5491
|
+
```bash
|
|
5492
|
+
agentmail inboxes:webhooks delete --inbox-id <inbox_id> --webhook-id <webhook_id>
|
|
5493
|
+
```
|
|
5494
|
+
</dd>
|
|
5495
|
+
</dl>
|
|
5496
|
+
</dd>
|
|
5497
|
+
</dl>
|
|
5498
|
+
|
|
5499
|
+
#### 🔌 Usage
|
|
5500
|
+
|
|
5501
|
+
<dl>
|
|
5502
|
+
<dd>
|
|
5503
|
+
|
|
5504
|
+
<dl>
|
|
5505
|
+
<dd>
|
|
5506
|
+
|
|
5507
|
+
```typescript
|
|
5508
|
+
await client.inboxes.webhooks.delete("inbox_id", "webhook_id");
|
|
5509
|
+
|
|
5510
|
+
```
|
|
5511
|
+
</dd>
|
|
5512
|
+
</dl>
|
|
5513
|
+
</dd>
|
|
5514
|
+
</dl>
|
|
5515
|
+
|
|
5516
|
+
#### ⚙️ Parameters
|
|
5517
|
+
|
|
5518
|
+
<dl>
|
|
5519
|
+
<dd>
|
|
5520
|
+
|
|
5521
|
+
<dl>
|
|
5522
|
+
<dd>
|
|
5523
|
+
|
|
5524
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5525
|
+
|
|
5526
|
+
</dd>
|
|
5527
|
+
</dl>
|
|
5528
|
+
|
|
5529
|
+
<dl>
|
|
5530
|
+
<dd>
|
|
5531
|
+
|
|
5532
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
5533
|
+
|
|
5534
|
+
</dd>
|
|
5535
|
+
</dl>
|
|
5536
|
+
|
|
5537
|
+
<dl>
|
|
5538
|
+
<dd>
|
|
5539
|
+
|
|
5540
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
5541
|
+
|
|
5542
|
+
</dd>
|
|
5543
|
+
</dl>
|
|
5544
|
+
</dd>
|
|
5545
|
+
</dl>
|
|
5546
|
+
|
|
5547
|
+
|
|
5548
|
+
</dd>
|
|
5549
|
+
</dl>
|
|
5550
|
+
</details>
|
|
5551
|
+
|
|
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>
|
|
5554
|
+
<dl>
|
|
5555
|
+
<dd>
|
|
5556
|
+
|
|
5557
|
+
#### 📝 Description
|
|
5558
|
+
|
|
5559
|
+
<dl>
|
|
5560
|
+
<dd>
|
|
5561
|
+
|
|
5562
|
+
<dl>
|
|
5563
|
+
<dd>
|
|
5564
|
+
|
|
5565
|
+
**CLI:**
|
|
5566
|
+
```bash
|
|
5567
|
+
agentmail lists list --direction <direction> --type <type>
|
|
5568
|
+
```
|
|
5569
|
+
</dd>
|
|
5570
|
+
</dl>
|
|
5571
|
+
</dd>
|
|
5572
|
+
</dl>
|
|
5573
|
+
|
|
5574
|
+
#### 🔌 Usage
|
|
5575
|
+
|
|
5576
|
+
<dl>
|
|
5577
|
+
<dd>
|
|
5578
|
+
|
|
5579
|
+
<dl>
|
|
5580
|
+
<dd>
|
|
5581
|
+
|
|
5582
|
+
```typescript
|
|
5583
|
+
await client.lists.list("send", "allow");
|
|
5584
|
+
|
|
5585
|
+
```
|
|
5586
|
+
</dd>
|
|
5587
|
+
</dl>
|
|
5588
|
+
</dd>
|
|
5589
|
+
</dl>
|
|
5590
|
+
|
|
5591
|
+
#### ⚙️ Parameters
|
|
5592
|
+
|
|
5593
|
+
<dl>
|
|
5594
|
+
<dd>
|
|
5595
|
+
|
|
5596
|
+
<dl>
|
|
5597
|
+
<dd>
|
|
5598
|
+
|
|
5599
|
+
**direction:** `AgentMail.Direction`
|
|
5600
|
+
|
|
5601
|
+
</dd>
|
|
5602
|
+
</dl>
|
|
5603
|
+
|
|
5604
|
+
<dl>
|
|
5605
|
+
<dd>
|
|
5606
|
+
|
|
5607
|
+
**type:** `AgentMail.ListType`
|
|
5608
|
+
|
|
5609
|
+
</dd>
|
|
5610
|
+
</dl>
|
|
5611
|
+
|
|
5612
|
+
<dl>
|
|
5613
|
+
<dd>
|
|
5614
|
+
|
|
5615
|
+
**request:** `AgentMail.ListListEntriesRequest`
|
|
5616
|
+
|
|
5617
|
+
</dd>
|
|
5618
|
+
</dl>
|
|
5619
|
+
|
|
5620
|
+
<dl>
|
|
5621
|
+
<dd>
|
|
5622
|
+
|
|
5623
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
5624
|
+
|
|
5625
|
+
</dd>
|
|
5626
|
+
</dl>
|
|
5627
|
+
</dd>
|
|
5628
|
+
</dl>
|
|
5629
|
+
|
|
5630
|
+
|
|
5631
|
+
</dd>
|
|
5632
|
+
</dl>
|
|
5633
|
+
</details>
|
|
5634
|
+
|
|
5635
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">get</a>(direction, type, entry) -> AgentMail.ListEntry</code></summary>
|
|
5636
|
+
<dl>
|
|
5637
|
+
<dd>
|
|
5638
|
+
|
|
5639
|
+
#### 📝 Description
|
|
5640
|
+
|
|
5641
|
+
<dl>
|
|
5642
|
+
<dd>
|
|
5643
|
+
|
|
5644
|
+
<dl>
|
|
5645
|
+
<dd>
|
|
5646
|
+
|
|
5647
|
+
**CLI:**
|
|
5648
|
+
```bash
|
|
5649
|
+
agentmail lists get --direction <direction> --type <type> --entry <entry>
|
|
5650
|
+
```
|
|
5651
|
+
</dd>
|
|
5652
|
+
</dl>
|
|
5653
|
+
</dd>
|
|
5654
|
+
</dl>
|
|
5655
|
+
|
|
5656
|
+
#### 🔌 Usage
|
|
5657
|
+
|
|
5658
|
+
<dl>
|
|
5659
|
+
<dd>
|
|
5660
|
+
|
|
5661
|
+
<dl>
|
|
5662
|
+
<dd>
|
|
5663
|
+
|
|
5664
|
+
```typescript
|
|
5665
|
+
await client.lists.get("send", "allow", "entry");
|
|
5666
|
+
|
|
5667
|
+
```
|
|
5668
|
+
</dd>
|
|
5669
|
+
</dl>
|
|
5670
|
+
</dd>
|
|
5671
|
+
</dl>
|
|
5672
|
+
|
|
5673
|
+
#### ⚙️ Parameters
|
|
5674
|
+
|
|
5675
|
+
<dl>
|
|
5676
|
+
<dd>
|
|
5677
|
+
|
|
5678
|
+
<dl>
|
|
5679
|
+
<dd>
|
|
5680
|
+
|
|
5681
|
+
**direction:** `AgentMail.Direction`
|
|
5682
|
+
|
|
5683
|
+
</dd>
|
|
5684
|
+
</dl>
|
|
5685
|
+
|
|
5686
|
+
<dl>
|
|
5687
|
+
<dd>
|
|
5688
|
+
|
|
5689
|
+
**type:** `AgentMail.ListType`
|
|
5690
|
+
|
|
5691
|
+
</dd>
|
|
5692
|
+
</dl>
|
|
5693
|
+
|
|
5694
|
+
<dl>
|
|
5695
|
+
<dd>
|
|
5696
|
+
|
|
5697
|
+
**entry:** `string` — Email address or domain.
|
|
5698
|
+
|
|
5699
|
+
</dd>
|
|
5700
|
+
</dl>
|
|
5701
|
+
|
|
5702
|
+
<dl>
|
|
5703
|
+
<dd>
|
|
5704
|
+
|
|
5705
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
5706
|
+
|
|
5707
|
+
</dd>
|
|
5708
|
+
</dl>
|
|
5709
|
+
</dd>
|
|
5710
|
+
</dl>
|
|
5711
|
+
|
|
5712
|
+
|
|
5713
|
+
</dd>
|
|
5714
|
+
</dl>
|
|
5715
|
+
</details>
|
|
5716
|
+
|
|
5717
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">create</a>(direction, type, { ...params }) -> AgentMail.ListEntry</code></summary>
|
|
5718
|
+
<dl>
|
|
5719
|
+
<dd>
|
|
5720
|
+
|
|
5721
|
+
#### 📝 Description
|
|
5722
|
+
|
|
5723
|
+
<dl>
|
|
5724
|
+
<dd>
|
|
5725
|
+
|
|
5726
|
+
<dl>
|
|
5727
|
+
<dd>
|
|
5728
|
+
|
|
5729
|
+
**CLI:**
|
|
5730
|
+
```bash
|
|
5731
|
+
agentmail lists create --direction <direction> --type <type> --entry user@example.com
|
|
5732
|
+
```
|
|
5733
|
+
</dd>
|
|
5734
|
+
</dl>
|
|
5735
|
+
</dd>
|
|
5736
|
+
</dl>
|
|
5737
|
+
|
|
5738
|
+
#### 🔌 Usage
|
|
5739
|
+
|
|
5740
|
+
<dl>
|
|
5741
|
+
<dd>
|
|
5742
|
+
|
|
5743
|
+
<dl>
|
|
5744
|
+
<dd>
|
|
5745
|
+
|
|
5746
|
+
```typescript
|
|
5747
|
+
await client.lists.create("send", "allow", {
|
|
5748
|
+
entry: "entry"
|
|
5749
|
+
});
|
|
5750
|
+
|
|
5751
|
+
```
|
|
5752
|
+
</dd>
|
|
5753
|
+
</dl>
|
|
5754
|
+
</dd>
|
|
5755
|
+
</dl>
|
|
5756
|
+
|
|
5757
|
+
#### ⚙️ Parameters
|
|
5758
|
+
|
|
5759
|
+
<dl>
|
|
5760
|
+
<dd>
|
|
5761
|
+
|
|
5762
|
+
<dl>
|
|
5763
|
+
<dd>
|
|
5764
|
+
|
|
5765
|
+
**direction:** `AgentMail.Direction`
|
|
5766
|
+
|
|
5767
|
+
</dd>
|
|
5768
|
+
</dl>
|
|
5769
|
+
|
|
5770
|
+
<dl>
|
|
5771
|
+
<dd>
|
|
5772
|
+
|
|
5773
|
+
**type:** `AgentMail.ListType`
|
|
5774
|
+
|
|
5775
|
+
</dd>
|
|
5776
|
+
</dl>
|
|
5777
|
+
|
|
5778
|
+
<dl>
|
|
5779
|
+
<dd>
|
|
5780
|
+
|
|
5781
|
+
**request:** `AgentMail.CreateListEntryRequest`
|
|
5782
|
+
|
|
5783
|
+
</dd>
|
|
5784
|
+
</dl>
|
|
5785
|
+
|
|
5786
|
+
<dl>
|
|
5787
|
+
<dd>
|
|
5788
|
+
|
|
5789
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
5790
|
+
|
|
5791
|
+
</dd>
|
|
5792
|
+
</dl>
|
|
5793
|
+
</dd>
|
|
5794
|
+
</dl>
|
|
5795
|
+
|
|
5796
|
+
|
|
5797
|
+
</dd>
|
|
5798
|
+
</dl>
|
|
5799
|
+
</details>
|
|
5800
|
+
|
|
5801
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">delete</a>(direction, type, entry) -> void</code></summary>
|
|
5802
|
+
<dl>
|
|
5803
|
+
<dd>
|
|
5804
|
+
|
|
5805
|
+
#### 📝 Description
|
|
5806
|
+
|
|
5807
|
+
<dl>
|
|
5808
|
+
<dd>
|
|
5809
|
+
|
|
5810
|
+
<dl>
|
|
5811
|
+
<dd>
|
|
5812
|
+
|
|
5813
|
+
**CLI:**
|
|
5814
|
+
```bash
|
|
5815
|
+
agentmail lists delete --direction <direction> --type <type> --entry <entry>
|
|
5816
|
+
```
|
|
5817
|
+
</dd>
|
|
5818
|
+
</dl>
|
|
5819
|
+
</dd>
|
|
5820
|
+
</dl>
|
|
5821
|
+
|
|
5822
|
+
#### 🔌 Usage
|
|
5823
|
+
|
|
5824
|
+
<dl>
|
|
5825
|
+
<dd>
|
|
5826
|
+
|
|
5827
|
+
<dl>
|
|
5828
|
+
<dd>
|
|
5829
|
+
|
|
5830
|
+
```typescript
|
|
5831
|
+
await client.lists.delete("send", "allow", "entry");
|
|
5832
|
+
|
|
5833
|
+
```
|
|
5834
|
+
</dd>
|
|
5835
|
+
</dl>
|
|
5836
|
+
</dd>
|
|
5837
|
+
</dl>
|
|
5838
|
+
|
|
5839
|
+
#### ⚙️ Parameters
|
|
5840
|
+
|
|
5841
|
+
<dl>
|
|
5842
|
+
<dd>
|
|
5843
|
+
|
|
5844
|
+
<dl>
|
|
5845
|
+
<dd>
|
|
5846
|
+
|
|
5847
|
+
**direction:** `AgentMail.Direction`
|
|
5848
|
+
|
|
5849
|
+
</dd>
|
|
5850
|
+
</dl>
|
|
5851
|
+
|
|
5852
|
+
<dl>
|
|
5853
|
+
<dd>
|
|
5854
|
+
|
|
5855
|
+
**type:** `AgentMail.ListType`
|
|
5856
|
+
|
|
5857
|
+
</dd>
|
|
5858
|
+
</dl>
|
|
5859
|
+
|
|
5860
|
+
<dl>
|
|
5861
|
+
<dd>
|
|
5862
|
+
|
|
5863
|
+
**entry:** `string` — Email address or domain.
|
|
5864
|
+
|
|
5865
|
+
</dd>
|
|
5866
|
+
</dl>
|
|
5867
|
+
|
|
5868
|
+
<dl>
|
|
5869
|
+
<dd>
|
|
5870
|
+
|
|
5871
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
5872
|
+
|
|
5873
|
+
</dd>
|
|
5874
|
+
</dl>
|
|
5875
|
+
</dd>
|
|
5876
|
+
</dl>
|
|
5877
|
+
|
|
5878
|
+
|
|
5879
|
+
</dd>
|
|
5880
|
+
</dl>
|
|
5881
|
+
</details>
|
|
5882
|
+
|
|
5883
|
+
## Metrics
|
|
5884
|
+
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryEvents</a>({ ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
5885
|
+
<dl>
|
|
5886
|
+
<dd>
|
|
5887
|
+
|
|
5888
|
+
#### 📝 Description
|
|
5889
|
+
|
|
5890
|
+
<dl>
|
|
5891
|
+
<dd>
|
|
5892
|
+
|
|
5893
|
+
<dl>
|
|
5894
|
+
<dd>
|
|
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
|
+
|
|
5902
|
+
**CLI:**
|
|
5903
|
+
```bash
|
|
5904
|
+
agentmail metrics list
|
|
5905
|
+
```
|
|
5906
|
+
</dd>
|
|
5907
|
+
</dl>
|
|
5908
|
+
</dd>
|
|
5909
|
+
</dl>
|
|
5910
|
+
|
|
5911
|
+
#### 🔌 Usage
|
|
5912
|
+
|
|
5913
|
+
<dl>
|
|
5914
|
+
<dd>
|
|
5915
|
+
|
|
5916
|
+
<dl>
|
|
5917
|
+
<dd>
|
|
5918
|
+
|
|
5919
|
+
```typescript
|
|
5920
|
+
await client.metrics.queryEvents();
|
|
5921
|
+
|
|
5922
|
+
```
|
|
5923
|
+
</dd>
|
|
5924
|
+
</dl>
|
|
5925
|
+
</dd>
|
|
5926
|
+
</dl>
|
|
5927
|
+
|
|
5928
|
+
#### ⚙️ Parameters
|
|
5929
|
+
|
|
5930
|
+
<dl>
|
|
5931
|
+
<dd>
|
|
5932
|
+
|
|
5933
|
+
<dl>
|
|
5934
|
+
<dd>
|
|
5935
|
+
|
|
5936
|
+
**request:** `AgentMail.QueryEventsRequest`
|
|
5937
|
+
|
|
5938
|
+
</dd>
|
|
5939
|
+
</dl>
|
|
5940
|
+
|
|
5941
|
+
<dl>
|
|
5942
|
+
<dd>
|
|
5943
|
+
|
|
5944
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
5945
|
+
|
|
5946
|
+
</dd>
|
|
5947
|
+
</dl>
|
|
5948
|
+
</dd>
|
|
5949
|
+
</dl>
|
|
5950
|
+
|
|
5951
|
+
|
|
5952
|
+
</dd>
|
|
5953
|
+
</dl>
|
|
5954
|
+
</details>
|
|
5955
|
+
|
|
5956
|
+
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryUsage</a>({ ...params }) -> AgentMail.QueryUsageResponse</code></summary>
|
|
5957
|
+
<dl>
|
|
5958
|
+
<dd>
|
|
5959
|
+
|
|
5960
|
+
#### 📝 Description
|
|
5961
|
+
|
|
5962
|
+
<dl>
|
|
5963
|
+
<dd>
|
|
5964
|
+
|
|
5965
|
+
<dl>
|
|
5966
|
+
<dd>
|
|
5967
|
+
|
|
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.
|
|
5973
|
+
</dd>
|
|
5974
|
+
</dl>
|
|
5975
|
+
</dd>
|
|
5976
|
+
</dl>
|
|
5977
|
+
|
|
5978
|
+
#### 🔌 Usage
|
|
5979
|
+
|
|
5980
|
+
<dl>
|
|
5981
|
+
<dd>
|
|
5982
|
+
|
|
5983
|
+
<dl>
|
|
5984
|
+
<dd>
|
|
5985
|
+
|
|
5986
|
+
```typescript
|
|
5987
|
+
await client.metrics.queryUsage();
|
|
5988
|
+
|
|
5989
|
+
```
|
|
5990
|
+
</dd>
|
|
5991
|
+
</dl>
|
|
5992
|
+
</dd>
|
|
5993
|
+
</dl>
|
|
5994
|
+
|
|
5995
|
+
#### ⚙️ Parameters
|
|
5996
|
+
|
|
5997
|
+
<dl>
|
|
5998
|
+
<dd>
|
|
5999
|
+
|
|
6000
|
+
<dl>
|
|
6001
|
+
<dd>
|
|
6002
|
+
|
|
6003
|
+
**request:** `AgentMail.QueryUsageRequest`
|
|
6004
|
+
|
|
6005
|
+
</dd>
|
|
6006
|
+
</dl>
|
|
6007
|
+
|
|
6008
|
+
<dl>
|
|
6009
|
+
<dd>
|
|
6010
|
+
|
|
6011
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
6012
|
+
|
|
6013
|
+
</dd>
|
|
6014
|
+
</dl>
|
|
6015
|
+
</dd>
|
|
6016
|
+
</dl>
|
|
6017
|
+
|
|
6018
|
+
|
|
6019
|
+
</dd>
|
|
6020
|
+
</dl>
|
|
6021
|
+
</details>
|
|
6022
|
+
|
|
6023
|
+
## Organizations
|
|
6024
|
+
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">get</a>() -> AgentMail.Organization</code></summary>
|
|
6025
|
+
<dl>
|
|
6026
|
+
<dd>
|
|
6027
|
+
|
|
6028
|
+
#### 📝 Description
|
|
6029
|
+
|
|
6030
|
+
<dl>
|
|
6031
|
+
<dd>
|
|
6032
|
+
|
|
6033
|
+
<dl>
|
|
6034
|
+
<dd>
|
|
6035
|
+
|
|
6036
|
+
Returns the organization for the authenticated API key (usage limits, counts, and billing metadata).
|
|
6037
|
+
|
|
6038
|
+
**CLI:**
|
|
6039
|
+
```bash
|
|
6040
|
+
agentmail organizations get
|
|
6041
|
+
```
|
|
6042
|
+
</dd>
|
|
6043
|
+
</dl>
|
|
6044
|
+
</dd>
|
|
6045
|
+
</dl>
|
|
6046
|
+
|
|
6047
|
+
#### 🔌 Usage
|
|
6048
|
+
|
|
6049
|
+
<dl>
|
|
6050
|
+
<dd>
|
|
6051
|
+
|
|
6052
|
+
<dl>
|
|
6053
|
+
<dd>
|
|
6054
|
+
|
|
6055
|
+
```typescript
|
|
6056
|
+
await client.organizations.get();
|
|
6057
|
+
|
|
6058
|
+
```
|
|
6059
|
+
</dd>
|
|
6060
|
+
</dl>
|
|
6061
|
+
</dd>
|
|
6062
|
+
</dl>
|
|
6063
|
+
|
|
6064
|
+
#### ⚙️ Parameters
|
|
6065
|
+
|
|
6066
|
+
<dl>
|
|
6067
|
+
<dd>
|
|
6068
|
+
|
|
6069
|
+
<dl>
|
|
6070
|
+
<dd>
|
|
6071
|
+
|
|
6072
|
+
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
6073
|
+
|
|
6074
|
+
</dd>
|
|
6075
|
+
</dl>
|
|
6076
|
+
</dd>
|
|
6077
|
+
</dl>
|
|
6078
|
+
|
|
6079
|
+
|
|
6080
|
+
</dd>
|
|
6081
|
+
</dl>
|
|
6082
|
+
</details>
|
|
6083
|
+
|
|
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>
|
|
6086
|
+
<dl>
|
|
6087
|
+
<dd>
|
|
6088
|
+
|
|
6089
|
+
#### 📝 Description
|
|
6090
|
+
|
|
6091
|
+
<dl>
|
|
6092
|
+
<dd>
|
|
6093
|
+
|
|
6094
|
+
<dl>
|
|
6095
|
+
<dd>
|
|
6096
|
+
|
|
6097
|
+
**CLI:**
|
|
6098
|
+
```bash
|
|
6099
|
+
agentmail pods:api-keys list --pod-id <pod_id>
|
|
6100
|
+
```
|
|
6101
|
+
</dd>
|
|
6102
|
+
</dl>
|
|
6103
|
+
</dd>
|
|
6104
|
+
</dl>
|
|
6105
|
+
|
|
6106
|
+
#### 🔌 Usage
|
|
6107
|
+
|
|
6108
|
+
<dl>
|
|
6109
|
+
<dd>
|
|
6110
|
+
|
|
6111
|
+
<dl>
|
|
6112
|
+
<dd>
|
|
6113
|
+
|
|
6114
|
+
```typescript
|
|
6115
|
+
await client.pods.apiKeys.list("pod_id");
|
|
6116
|
+
|
|
6117
|
+
```
|
|
6118
|
+
</dd>
|
|
6119
|
+
</dl>
|
|
6120
|
+
</dd>
|
|
6121
|
+
</dl>
|
|
6122
|
+
|
|
6123
|
+
#### ⚙️ Parameters
|
|
6124
|
+
|
|
6125
|
+
<dl>
|
|
6126
|
+
<dd>
|
|
6127
|
+
|
|
6128
|
+
<dl>
|
|
6129
|
+
<dd>
|
|
6130
|
+
|
|
6131
|
+
**pod_id:** `AgentMail.PodId`
|
|
6132
|
+
|
|
6133
|
+
</dd>
|
|
6134
|
+
</dl>
|
|
6135
|
+
|
|
6136
|
+
<dl>
|
|
6137
|
+
<dd>
|
|
6138
|
+
|
|
6139
|
+
**request:** `AgentMail.pods.ListApiKeysRequest`
|
|
6140
|
+
|
|
6141
|
+
</dd>
|
|
6142
|
+
</dl>
|
|
6143
|
+
|
|
6144
|
+
<dl>
|
|
6145
|
+
<dd>
|
|
6146
|
+
|
|
6147
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
6148
|
+
|
|
6149
|
+
</dd>
|
|
6150
|
+
</dl>
|
|
6151
|
+
</dd>
|
|
6152
|
+
</dl>
|
|
6153
|
+
|
|
6154
|
+
|
|
6155
|
+
</dd>
|
|
5311
6156
|
</dl>
|
|
5312
6157
|
</details>
|
|
5313
6158
|
|
|
5314
|
-
<details><summary><code>client.
|
|
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>
|
|
5315
6160
|
<dl>
|
|
5316
6161
|
<dd>
|
|
5317
6162
|
|
|
@@ -5323,11 +6168,10 @@ await client.metrics.queryEvents();
|
|
|
5323
6168
|
<dl>
|
|
5324
6169
|
<dd>
|
|
5325
6170
|
|
|
5326
|
-
|
|
5327
|
-
|
|
5328
|
-
|
|
5329
|
-
|
|
5330
|
-
`period` must not exceed 1000 buckets.
|
|
6171
|
+
**CLI:**
|
|
6172
|
+
```bash
|
|
6173
|
+
agentmail pods:api-keys create --pod-id <pod_id> --name "My Key"
|
|
6174
|
+
```
|
|
5331
6175
|
</dd>
|
|
5332
6176
|
</dl>
|
|
5333
6177
|
</dd>
|
|
@@ -5342,7 +6186,7 @@ bucket. Defaults to the last 24 hours; `start` must be within the last
|
|
|
5342
6186
|
<dd>
|
|
5343
6187
|
|
|
5344
6188
|
```typescript
|
|
5345
|
-
await client.
|
|
6189
|
+
await client.pods.apiKeys.create("pod_id", {});
|
|
5346
6190
|
|
|
5347
6191
|
```
|
|
5348
6192
|
</dd>
|
|
@@ -5358,7 +6202,7 @@ await client.metrics.queryUsage();
|
|
|
5358
6202
|
<dl>
|
|
5359
6203
|
<dd>
|
|
5360
6204
|
|
|
5361
|
-
**
|
|
6205
|
+
**pod_id:** `AgentMail.PodId`
|
|
5362
6206
|
|
|
5363
6207
|
</dd>
|
|
5364
6208
|
</dl>
|
|
@@ -5366,7 +6210,15 @@ await client.metrics.queryUsage();
|
|
|
5366
6210
|
<dl>
|
|
5367
6211
|
<dd>
|
|
5368
6212
|
|
|
5369
|
-
**
|
|
6213
|
+
**request:** `AgentMail.CreateApiKeyRequest`
|
|
6214
|
+
|
|
6215
|
+
</dd>
|
|
6216
|
+
</dl>
|
|
6217
|
+
|
|
6218
|
+
<dl>
|
|
6219
|
+
<dd>
|
|
6220
|
+
|
|
6221
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
5370
6222
|
|
|
5371
6223
|
</dd>
|
|
5372
6224
|
</dl>
|
|
@@ -5378,8 +6230,7 @@ await client.metrics.queryUsage();
|
|
|
5378
6230
|
</dl>
|
|
5379
6231
|
</details>
|
|
5380
6232
|
|
|
5381
|
-
|
|
5382
|
-
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">get</a>() -> AgentMail.Organization</code></summary>
|
|
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>
|
|
5383
6234
|
<dl>
|
|
5384
6235
|
<dd>
|
|
5385
6236
|
|
|
@@ -5391,11 +6242,84 @@ await client.metrics.queryUsage();
|
|
|
5391
6242
|
<dl>
|
|
5392
6243
|
<dd>
|
|
5393
6244
|
|
|
5394
|
-
|
|
6245
|
+
**CLI:**
|
|
6246
|
+
```bash
|
|
6247
|
+
agentmail pods:api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
|
|
6248
|
+
```
|
|
6249
|
+
</dd>
|
|
6250
|
+
</dl>
|
|
6251
|
+
</dd>
|
|
6252
|
+
</dl>
|
|
6253
|
+
|
|
6254
|
+
#### 🔌 Usage
|
|
6255
|
+
|
|
6256
|
+
<dl>
|
|
6257
|
+
<dd>
|
|
6258
|
+
|
|
6259
|
+
<dl>
|
|
6260
|
+
<dd>
|
|
6261
|
+
|
|
6262
|
+
```typescript
|
|
6263
|
+
await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
6264
|
+
|
|
6265
|
+
```
|
|
6266
|
+
</dd>
|
|
6267
|
+
</dl>
|
|
6268
|
+
</dd>
|
|
6269
|
+
</dl>
|
|
6270
|
+
|
|
6271
|
+
#### ⚙️ Parameters
|
|
6272
|
+
|
|
6273
|
+
<dl>
|
|
6274
|
+
<dd>
|
|
6275
|
+
|
|
6276
|
+
<dl>
|
|
6277
|
+
<dd>
|
|
6278
|
+
|
|
6279
|
+
**pod_id:** `AgentMail.PodId`
|
|
6280
|
+
|
|
6281
|
+
</dd>
|
|
6282
|
+
</dl>
|
|
6283
|
+
|
|
6284
|
+
<dl>
|
|
6285
|
+
<dd>
|
|
6286
|
+
|
|
6287
|
+
**api_key_id:** `AgentMail.ApiKeyId`
|
|
6288
|
+
|
|
6289
|
+
</dd>
|
|
6290
|
+
</dl>
|
|
6291
|
+
|
|
6292
|
+
<dl>
|
|
6293
|
+
<dd>
|
|
6294
|
+
|
|
6295
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
6296
|
+
|
|
6297
|
+
</dd>
|
|
6298
|
+
</dl>
|
|
6299
|
+
</dd>
|
|
6300
|
+
</dl>
|
|
6301
|
+
|
|
6302
|
+
|
|
6303
|
+
</dd>
|
|
6304
|
+
</dl>
|
|
6305
|
+
</details>
|
|
6306
|
+
|
|
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>
|
|
6309
|
+
<dl>
|
|
6310
|
+
<dd>
|
|
6311
|
+
|
|
6312
|
+
#### 📝 Description
|
|
6313
|
+
|
|
6314
|
+
<dl>
|
|
6315
|
+
<dd>
|
|
6316
|
+
|
|
6317
|
+
<dl>
|
|
6318
|
+
<dd>
|
|
5395
6319
|
|
|
5396
6320
|
**CLI:**
|
|
5397
6321
|
```bash
|
|
5398
|
-
agentmail
|
|
6322
|
+
agentmail pods:domains list --pod-id <pod_id>
|
|
5399
6323
|
```
|
|
5400
6324
|
</dd>
|
|
5401
6325
|
</dl>
|
|
@@ -5411,7 +6335,7 @@ agentmail organizations get
|
|
|
5411
6335
|
<dd>
|
|
5412
6336
|
|
|
5413
6337
|
```typescript
|
|
5414
|
-
await client.
|
|
6338
|
+
await client.pods.domains.list("pod_id");
|
|
5415
6339
|
|
|
5416
6340
|
```
|
|
5417
6341
|
</dd>
|
|
@@ -5427,7 +6351,23 @@ await client.organizations.get();
|
|
|
5427
6351
|
<dl>
|
|
5428
6352
|
<dd>
|
|
5429
6353
|
|
|
5430
|
-
**
|
|
6354
|
+
**pod_id:** `AgentMail.PodId`
|
|
6355
|
+
|
|
6356
|
+
</dd>
|
|
6357
|
+
</dl>
|
|
6358
|
+
|
|
6359
|
+
<dl>
|
|
6360
|
+
<dd>
|
|
6361
|
+
|
|
6362
|
+
**request:** `AgentMail.pods.ListDomainsRequest`
|
|
6363
|
+
|
|
6364
|
+
</dd>
|
|
6365
|
+
</dl>
|
|
6366
|
+
|
|
6367
|
+
<dl>
|
|
6368
|
+
<dd>
|
|
6369
|
+
|
|
6370
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
5431
6371
|
|
|
5432
6372
|
</dd>
|
|
5433
6373
|
</dl>
|
|
@@ -5439,8 +6379,7 @@ await client.organizations.get();
|
|
|
5439
6379
|
</dl>
|
|
5440
6380
|
</details>
|
|
5441
6381
|
|
|
5442
|
-
|
|
5443
|
-
<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>
|
|
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>
|
|
5444
6383
|
<dl>
|
|
5445
6384
|
<dd>
|
|
5446
6385
|
|
|
@@ -5454,7 +6393,7 @@ await client.organizations.get();
|
|
|
5454
6393
|
|
|
5455
6394
|
**CLI:**
|
|
5456
6395
|
```bash
|
|
5457
|
-
agentmail pods:
|
|
6396
|
+
agentmail pods:domains get --pod-id <pod_id> --domain-id <domain_id>
|
|
5458
6397
|
```
|
|
5459
6398
|
</dd>
|
|
5460
6399
|
</dl>
|
|
@@ -5470,7 +6409,7 @@ agentmail pods:api-keys list --pod-id <pod_id>
|
|
|
5470
6409
|
<dd>
|
|
5471
6410
|
|
|
5472
6411
|
```typescript
|
|
5473
|
-
await client.pods.
|
|
6412
|
+
await client.pods.domains.get("pod_id", "domain_id");
|
|
5474
6413
|
|
|
5475
6414
|
```
|
|
5476
6415
|
</dd>
|
|
@@ -5494,7 +6433,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
5494
6433
|
<dl>
|
|
5495
6434
|
<dd>
|
|
5496
6435
|
|
|
5497
|
-
**
|
|
6436
|
+
**domain_id:** `AgentMail.DomainId`
|
|
5498
6437
|
|
|
5499
6438
|
</dd>
|
|
5500
6439
|
</dl>
|
|
@@ -5502,7 +6441,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
5502
6441
|
<dl>
|
|
5503
6442
|
<dd>
|
|
5504
6443
|
|
|
5505
|
-
**requestOptions:** `
|
|
6444
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
5506
6445
|
|
|
5507
6446
|
</dd>
|
|
5508
6447
|
</dl>
|
|
@@ -5514,7 +6453,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
5514
6453
|
</dl>
|
|
5515
6454
|
</details>
|
|
5516
6455
|
|
|
5517
|
-
<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>
|
|
5518
6457
|
<dl>
|
|
5519
6458
|
<dd>
|
|
5520
6459
|
|
|
@@ -5528,7 +6467,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
5528
6467
|
|
|
5529
6468
|
**CLI:**
|
|
5530
6469
|
```bash
|
|
5531
|
-
agentmail pods:
|
|
6470
|
+
agentmail pods:domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
|
|
5532
6471
|
```
|
|
5533
6472
|
</dd>
|
|
5534
6473
|
</dl>
|
|
@@ -5544,7 +6483,7 @@ agentmail pods:api-keys create --pod-id <pod_id> --name "My Key"
|
|
|
5544
6483
|
<dd>
|
|
5545
6484
|
|
|
5546
6485
|
```typescript
|
|
5547
|
-
await client.pods.
|
|
6486
|
+
await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
5548
6487
|
|
|
5549
6488
|
```
|
|
5550
6489
|
</dd>
|
|
@@ -5568,7 +6507,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
5568
6507
|
<dl>
|
|
5569
6508
|
<dd>
|
|
5570
6509
|
|
|
5571
|
-
**
|
|
6510
|
+
**domain_id:** `AgentMail.DomainId`
|
|
5572
6511
|
|
|
5573
6512
|
</dd>
|
|
5574
6513
|
</dl>
|
|
@@ -5576,7 +6515,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
5576
6515
|
<dl>
|
|
5577
6516
|
<dd>
|
|
5578
6517
|
|
|
5579
|
-
**requestOptions:** `
|
|
6518
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
5580
6519
|
|
|
5581
6520
|
</dd>
|
|
5582
6521
|
</dl>
|
|
@@ -5588,7 +6527,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
5588
6527
|
</dl>
|
|
5589
6528
|
</details>
|
|
5590
6529
|
|
|
5591
|
-
<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>
|
|
5592
6531
|
<dl>
|
|
5593
6532
|
<dd>
|
|
5594
6533
|
|
|
@@ -5602,7 +6541,7 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
5602
6541
|
|
|
5603
6542
|
**CLI:**
|
|
5604
6543
|
```bash
|
|
5605
|
-
agentmail pods:
|
|
6544
|
+
agentmail pods:domains create --pod-id <pod_id> --domain example.com
|
|
5606
6545
|
```
|
|
5607
6546
|
</dd>
|
|
5608
6547
|
</dl>
|
|
@@ -5618,7 +6557,83 @@ agentmail pods:api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
|
|
|
5618
6557
|
<dd>
|
|
5619
6558
|
|
|
5620
6559
|
```typescript
|
|
5621
|
-
await client.pods.
|
|
6560
|
+
await client.pods.domains.create("pod_id", {
|
|
6561
|
+
domain: "domain"
|
|
6562
|
+
});
|
|
6563
|
+
|
|
6564
|
+
```
|
|
6565
|
+
</dd>
|
|
6566
|
+
</dl>
|
|
6567
|
+
</dd>
|
|
6568
|
+
</dl>
|
|
6569
|
+
|
|
6570
|
+
#### ⚙️ Parameters
|
|
6571
|
+
|
|
6572
|
+
<dl>
|
|
6573
|
+
<dd>
|
|
6574
|
+
|
|
6575
|
+
<dl>
|
|
6576
|
+
<dd>
|
|
6577
|
+
|
|
6578
|
+
**pod_id:** `AgentMail.PodId`
|
|
6579
|
+
|
|
6580
|
+
</dd>
|
|
6581
|
+
</dl>
|
|
6582
|
+
|
|
6583
|
+
<dl>
|
|
6584
|
+
<dd>
|
|
6585
|
+
|
|
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", {});
|
|
5622
6637
|
|
|
5623
6638
|
```
|
|
5624
6639
|
</dd>
|
|
@@ -5634,7 +6649,15 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
5634
6649
|
<dl>
|
|
5635
6650
|
<dd>
|
|
5636
6651
|
|
|
5637
|
-
**pod_id:** `AgentMail.PodId`
|
|
6652
|
+
**pod_id:** `AgentMail.PodId`
|
|
6653
|
+
|
|
6654
|
+
</dd>
|
|
6655
|
+
</dl>
|
|
6656
|
+
|
|
6657
|
+
<dl>
|
|
6658
|
+
<dd>
|
|
6659
|
+
|
|
6660
|
+
**domain_id:** `AgentMail.DomainId`
|
|
5638
6661
|
|
|
5639
6662
|
</dd>
|
|
5640
6663
|
</dl>
|
|
@@ -5642,7 +6665,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
5642
6665
|
<dl>
|
|
5643
6666
|
<dd>
|
|
5644
6667
|
|
|
5645
|
-
**
|
|
6668
|
+
**request:** `AgentMail.UpdateDomainRequest`
|
|
5646
6669
|
|
|
5647
6670
|
</dd>
|
|
5648
6671
|
</dl>
|
|
@@ -5650,7 +6673,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
5650
6673
|
<dl>
|
|
5651
6674
|
<dd>
|
|
5652
6675
|
|
|
5653
|
-
**requestOptions:** `
|
|
6676
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
5654
6677
|
|
|
5655
6678
|
</dd>
|
|
5656
6679
|
</dl>
|
|
@@ -5662,8 +6685,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
5662
6685
|
</dl>
|
|
5663
6686
|
</details>
|
|
5664
6687
|
|
|
5665
|
-
|
|
5666
|
-
<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>
|
|
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>
|
|
5667
6689
|
<dl>
|
|
5668
6690
|
<dd>
|
|
5669
6691
|
|
|
@@ -5677,7 +6699,7 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
5677
6699
|
|
|
5678
6700
|
**CLI:**
|
|
5679
6701
|
```bash
|
|
5680
|
-
agentmail pods:domains
|
|
6702
|
+
agentmail pods:domains delete --pod-id <pod_id> --domain-id <domain_id>
|
|
5681
6703
|
```
|
|
5682
6704
|
</dd>
|
|
5683
6705
|
</dl>
|
|
@@ -5693,7 +6715,7 @@ agentmail pods:domains list --pod-id <pod_id>
|
|
|
5693
6715
|
<dd>
|
|
5694
6716
|
|
|
5695
6717
|
```typescript
|
|
5696
|
-
await client.pods.domains.
|
|
6718
|
+
await client.pods.domains.delete("pod_id", "domain_id");
|
|
5697
6719
|
|
|
5698
6720
|
```
|
|
5699
6721
|
</dd>
|
|
@@ -5717,7 +6739,7 @@ await client.pods.domains.list("pod_id");
|
|
|
5717
6739
|
<dl>
|
|
5718
6740
|
<dd>
|
|
5719
6741
|
|
|
5720
|
-
**
|
|
6742
|
+
**domain_id:** `AgentMail.DomainId`
|
|
5721
6743
|
|
|
5722
6744
|
</dd>
|
|
5723
6745
|
</dl>
|
|
@@ -5737,7 +6759,7 @@ await client.pods.domains.list("pod_id");
|
|
|
5737
6759
|
</dl>
|
|
5738
6760
|
</details>
|
|
5739
6761
|
|
|
5740
|
-
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">
|
|
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>
|
|
5741
6763
|
<dl>
|
|
5742
6764
|
<dd>
|
|
5743
6765
|
|
|
@@ -5751,7 +6773,7 @@ await client.pods.domains.list("pod_id");
|
|
|
5751
6773
|
|
|
5752
6774
|
**CLI:**
|
|
5753
6775
|
```bash
|
|
5754
|
-
agentmail pods:domains
|
|
6776
|
+
agentmail pods:domains verify --pod-id <pod_id> --domain-id <domain_id>
|
|
5755
6777
|
```
|
|
5756
6778
|
</dd>
|
|
5757
6779
|
</dl>
|
|
@@ -5767,7 +6789,7 @@ agentmail pods:domains get --pod-id <pod_id> --domain-id <domain_id>
|
|
|
5767
6789
|
<dd>
|
|
5768
6790
|
|
|
5769
6791
|
```typescript
|
|
5770
|
-
await client.pods.domains.
|
|
6792
|
+
await client.pods.domains.verify("pod_id", "domain_id");
|
|
5771
6793
|
|
|
5772
6794
|
```
|
|
5773
6795
|
</dd>
|
|
@@ -5811,7 +6833,8 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
5811
6833
|
</dl>
|
|
5812
6834
|
</details>
|
|
5813
6835
|
|
|
5814
|
-
|
|
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>
|
|
5815
6838
|
<dl>
|
|
5816
6839
|
<dd>
|
|
5817
6840
|
|
|
@@ -5825,7 +6848,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
5825
6848
|
|
|
5826
6849
|
**CLI:**
|
|
5827
6850
|
```bash
|
|
5828
|
-
agentmail pods:
|
|
6851
|
+
agentmail pods:drafts list --pod-id <pod_id>
|
|
5829
6852
|
```
|
|
5830
6853
|
</dd>
|
|
5831
6854
|
</dl>
|
|
@@ -5841,7 +6864,7 @@ agentmail pods:domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
|
|
|
5841
6864
|
<dd>
|
|
5842
6865
|
|
|
5843
6866
|
```typescript
|
|
5844
|
-
await client.pods.
|
|
6867
|
+
await client.pods.drafts.list("pod_id");
|
|
5845
6868
|
|
|
5846
6869
|
```
|
|
5847
6870
|
</dd>
|
|
@@ -5865,7 +6888,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
5865
6888
|
<dl>
|
|
5866
6889
|
<dd>
|
|
5867
6890
|
|
|
5868
|
-
**
|
|
6891
|
+
**request:** `AgentMail.pods.ListDraftsRequest`
|
|
5869
6892
|
|
|
5870
6893
|
</dd>
|
|
5871
6894
|
</dl>
|
|
@@ -5873,7 +6896,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
5873
6896
|
<dl>
|
|
5874
6897
|
<dd>
|
|
5875
6898
|
|
|
5876
|
-
**requestOptions:** `
|
|
6899
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
5877
6900
|
|
|
5878
6901
|
</dd>
|
|
5879
6902
|
</dl>
|
|
@@ -5885,7 +6908,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
5885
6908
|
</dl>
|
|
5886
6909
|
</details>
|
|
5887
6910
|
|
|
5888
|
-
<details><summary><code>client.pods.
|
|
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>
|
|
5889
6912
|
<dl>
|
|
5890
6913
|
<dd>
|
|
5891
6914
|
|
|
@@ -5899,7 +6922,7 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
5899
6922
|
|
|
5900
6923
|
**CLI:**
|
|
5901
6924
|
```bash
|
|
5902
|
-
agentmail pods:
|
|
6925
|
+
agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id>
|
|
5903
6926
|
```
|
|
5904
6927
|
</dd>
|
|
5905
6928
|
</dl>
|
|
@@ -5915,9 +6938,7 @@ agentmail pods:domains create --pod-id <pod_id> --domain example.com
|
|
|
5915
6938
|
<dd>
|
|
5916
6939
|
|
|
5917
6940
|
```typescript
|
|
5918
|
-
await client.pods.
|
|
5919
|
-
domain: "domain"
|
|
5920
|
-
});
|
|
6941
|
+
await client.pods.drafts.get("pod_id", "draft_id");
|
|
5921
6942
|
|
|
5922
6943
|
```
|
|
5923
6944
|
</dd>
|
|
@@ -5941,7 +6962,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
5941
6962
|
<dl>
|
|
5942
6963
|
<dd>
|
|
5943
6964
|
|
|
5944
|
-
**
|
|
6965
|
+
**draft_id:** `AgentMail.DraftId`
|
|
5945
6966
|
|
|
5946
6967
|
</dd>
|
|
5947
6968
|
</dl>
|
|
@@ -5949,7 +6970,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
5949
6970
|
<dl>
|
|
5950
6971
|
<dd>
|
|
5951
6972
|
|
|
5952
|
-
**requestOptions:** `
|
|
6973
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
5953
6974
|
|
|
5954
6975
|
</dd>
|
|
5955
6976
|
</dl>
|
|
@@ -5961,7 +6982,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
5961
6982
|
</dl>
|
|
5962
6983
|
</details>
|
|
5963
6984
|
|
|
5964
|
-
<details><summary><code>client.pods.
|
|
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>
|
|
5965
6986
|
<dl>
|
|
5966
6987
|
<dd>
|
|
5967
6988
|
|
|
@@ -5975,7 +6996,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
5975
6996
|
|
|
5976
6997
|
**CLI:**
|
|
5977
6998
|
```bash
|
|
5978
|
-
agentmail pods:
|
|
6999
|
+
agentmail pods:drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --attachment-id <attachment_id>
|
|
5979
7000
|
```
|
|
5980
7001
|
</dd>
|
|
5981
7002
|
</dl>
|
|
@@ -5991,7 +7012,7 @@ agentmail pods:domains update --pod-id <pod_id> --domain-id <domain_id>
|
|
|
5991
7012
|
<dd>
|
|
5992
7013
|
|
|
5993
7014
|
```typescript
|
|
5994
|
-
await client.pods.
|
|
7015
|
+
await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
5995
7016
|
|
|
5996
7017
|
```
|
|
5997
7018
|
</dd>
|
|
@@ -6015,7 +7036,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
6015
7036
|
<dl>
|
|
6016
7037
|
<dd>
|
|
6017
7038
|
|
|
6018
|
-
**
|
|
7039
|
+
**draft_id:** `AgentMail.DraftId`
|
|
6019
7040
|
|
|
6020
7041
|
</dd>
|
|
6021
7042
|
</dl>
|
|
@@ -6023,7 +7044,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
6023
7044
|
<dl>
|
|
6024
7045
|
<dd>
|
|
6025
7046
|
|
|
6026
|
-
**
|
|
7047
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
6027
7048
|
|
|
6028
7049
|
</dd>
|
|
6029
7050
|
</dl>
|
|
@@ -6031,7 +7052,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
6031
7052
|
<dl>
|
|
6032
7053
|
<dd>
|
|
6033
7054
|
|
|
6034
|
-
**requestOptions:** `
|
|
7055
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
6035
7056
|
|
|
6036
7057
|
</dd>
|
|
6037
7058
|
</dl>
|
|
@@ -6043,7 +7064,8 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
6043
7064
|
</dl>
|
|
6044
7065
|
</details>
|
|
6045
7066
|
|
|
6046
|
-
|
|
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>
|
|
6047
7069
|
<dl>
|
|
6048
7070
|
<dd>
|
|
6049
7071
|
|
|
@@ -6057,7 +7079,7 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
6057
7079
|
|
|
6058
7080
|
**CLI:**
|
|
6059
7081
|
```bash
|
|
6060
|
-
agentmail pods:
|
|
7082
|
+
agentmail pods:inboxes list --pod-id <pod_id>
|
|
6061
7083
|
```
|
|
6062
7084
|
</dd>
|
|
6063
7085
|
</dl>
|
|
@@ -6073,7 +7095,7 @@ agentmail pods:domains delete --pod-id <pod_id> --domain-id <domain_id>
|
|
|
6073
7095
|
<dd>
|
|
6074
7096
|
|
|
6075
7097
|
```typescript
|
|
6076
|
-
await client.pods.
|
|
7098
|
+
await client.pods.inboxes.list("pod_id");
|
|
6077
7099
|
|
|
6078
7100
|
```
|
|
6079
7101
|
</dd>
|
|
@@ -6097,7 +7119,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
6097
7119
|
<dl>
|
|
6098
7120
|
<dd>
|
|
6099
7121
|
|
|
6100
|
-
**
|
|
7122
|
+
**request:** `AgentMail.pods.ListInboxesRequest`
|
|
6101
7123
|
|
|
6102
7124
|
</dd>
|
|
6103
7125
|
</dl>
|
|
@@ -6105,7 +7127,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
6105
7127
|
<dl>
|
|
6106
7128
|
<dd>
|
|
6107
7129
|
|
|
6108
|
-
**requestOptions:** `
|
|
7130
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
6109
7131
|
|
|
6110
7132
|
</dd>
|
|
6111
7133
|
</dl>
|
|
@@ -6117,7 +7139,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
6117
7139
|
</dl>
|
|
6118
7140
|
</details>
|
|
6119
7141
|
|
|
6120
|
-
<details><summary><code>client.pods.
|
|
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>
|
|
6121
7143
|
<dl>
|
|
6122
7144
|
<dd>
|
|
6123
7145
|
|
|
@@ -6131,7 +7153,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
6131
7153
|
|
|
6132
7154
|
**CLI:**
|
|
6133
7155
|
```bash
|
|
6134
|
-
agentmail pods:
|
|
7156
|
+
agentmail pods:inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
|
|
6135
7157
|
```
|
|
6136
7158
|
</dd>
|
|
6137
7159
|
</dl>
|
|
@@ -6147,7 +7169,7 @@ agentmail pods:domains verify --pod-id <pod_id> --domain-id <domain_id>
|
|
|
6147
7169
|
<dd>
|
|
6148
7170
|
|
|
6149
7171
|
```typescript
|
|
6150
|
-
await client.pods.
|
|
7172
|
+
await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
6151
7173
|
|
|
6152
7174
|
```
|
|
6153
7175
|
</dd>
|
|
@@ -6171,7 +7193,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
6171
7193
|
<dl>
|
|
6172
7194
|
<dd>
|
|
6173
7195
|
|
|
6174
|
-
**
|
|
7196
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
6175
7197
|
|
|
6176
7198
|
</dd>
|
|
6177
7199
|
</dl>
|
|
@@ -6179,7 +7201,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
6179
7201
|
<dl>
|
|
6180
7202
|
<dd>
|
|
6181
7203
|
|
|
6182
|
-
**requestOptions:** `
|
|
7204
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
6183
7205
|
|
|
6184
7206
|
</dd>
|
|
6185
7207
|
</dl>
|
|
@@ -6191,8 +7213,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
6191
7213
|
</dl>
|
|
6192
7214
|
</details>
|
|
6193
7215
|
|
|
6194
|
-
|
|
6195
|
-
<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>
|
|
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>
|
|
6196
7217
|
<dl>
|
|
6197
7218
|
<dd>
|
|
6198
7219
|
|
|
@@ -6206,7 +7227,7 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
6206
7227
|
|
|
6207
7228
|
**CLI:**
|
|
6208
7229
|
```bash
|
|
6209
|
-
agentmail pods:
|
|
7230
|
+
agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain example.com
|
|
6210
7231
|
```
|
|
6211
7232
|
</dd>
|
|
6212
7233
|
</dl>
|
|
@@ -6222,7 +7243,7 @@ agentmail pods:drafts list --pod-id <pod_id>
|
|
|
6222
7243
|
<dd>
|
|
6223
7244
|
|
|
6224
7245
|
```typescript
|
|
6225
|
-
await client.pods.
|
|
7246
|
+
await client.pods.inboxes.create("pod_id", {});
|
|
6226
7247
|
|
|
6227
7248
|
```
|
|
6228
7249
|
</dd>
|
|
@@ -6246,7 +7267,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
6246
7267
|
<dl>
|
|
6247
7268
|
<dd>
|
|
6248
7269
|
|
|
6249
|
-
**request:** `AgentMail.
|
|
7270
|
+
**request:** `AgentMail.CreateInboxRequest`
|
|
6250
7271
|
|
|
6251
7272
|
</dd>
|
|
6252
7273
|
</dl>
|
|
@@ -6254,7 +7275,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
6254
7275
|
<dl>
|
|
6255
7276
|
<dd>
|
|
6256
7277
|
|
|
6257
|
-
**requestOptions:** `
|
|
7278
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
6258
7279
|
|
|
6259
7280
|
</dd>
|
|
6260
7281
|
</dl>
|
|
@@ -6266,7 +7287,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
6266
7287
|
</dl>
|
|
6267
7288
|
</details>
|
|
6268
7289
|
|
|
6269
|
-
<details><summary><code>client.pods.
|
|
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>
|
|
6270
7291
|
<dl>
|
|
6271
7292
|
<dd>
|
|
6272
7293
|
|
|
@@ -6280,7 +7301,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
6280
7301
|
|
|
6281
7302
|
**CLI:**
|
|
6282
7303
|
```bash
|
|
6283
|
-
agentmail pods:
|
|
7304
|
+
agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
|
|
6284
7305
|
```
|
|
6285
7306
|
</dd>
|
|
6286
7307
|
</dl>
|
|
@@ -6296,7 +7317,7 @@ agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id>
|
|
|
6296
7317
|
<dd>
|
|
6297
7318
|
|
|
6298
7319
|
```typescript
|
|
6299
|
-
await client.pods.
|
|
7320
|
+
await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
6300
7321
|
|
|
6301
7322
|
```
|
|
6302
7323
|
</dd>
|
|
@@ -6320,7 +7341,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
6320
7341
|
<dl>
|
|
6321
7342
|
<dd>
|
|
6322
7343
|
|
|
6323
|
-
**
|
|
7344
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
6324
7345
|
|
|
6325
7346
|
</dd>
|
|
6326
7347
|
</dl>
|
|
@@ -6328,7 +7349,15 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
6328
7349
|
<dl>
|
|
6329
7350
|
<dd>
|
|
6330
7351
|
|
|
6331
|
-
**
|
|
7352
|
+
**request:** `AgentMail.UpdateInboxRequest`
|
|
7353
|
+
|
|
7354
|
+
</dd>
|
|
7355
|
+
</dl>
|
|
7356
|
+
|
|
7357
|
+
<dl>
|
|
7358
|
+
<dd>
|
|
7359
|
+
|
|
7360
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
6332
7361
|
|
|
6333
7362
|
</dd>
|
|
6334
7363
|
</dl>
|
|
@@ -6340,7 +7369,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
6340
7369
|
</dl>
|
|
6341
7370
|
</details>
|
|
6342
7371
|
|
|
6343
|
-
<details><summary><code>client.pods.
|
|
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>
|
|
6344
7373
|
<dl>
|
|
6345
7374
|
<dd>
|
|
6346
7375
|
|
|
@@ -6354,7 +7383,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
6354
7383
|
|
|
6355
7384
|
**CLI:**
|
|
6356
7385
|
```bash
|
|
6357
|
-
agentmail pods:
|
|
7386
|
+
agentmail pods:inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>
|
|
6358
7387
|
```
|
|
6359
7388
|
</dd>
|
|
6360
7389
|
</dl>
|
|
@@ -6370,7 +7399,7 @@ agentmail pods:drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --a
|
|
|
6370
7399
|
<dd>
|
|
6371
7400
|
|
|
6372
7401
|
```typescript
|
|
6373
|
-
await client.pods.
|
|
7402
|
+
await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
6374
7403
|
|
|
6375
7404
|
```
|
|
6376
7405
|
</dd>
|
|
@@ -6394,15 +7423,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
6394
7423
|
<dl>
|
|
6395
7424
|
<dd>
|
|
6396
7425
|
|
|
6397
|
-
**
|
|
6398
|
-
|
|
6399
|
-
</dd>
|
|
6400
|
-
</dl>
|
|
6401
|
-
|
|
6402
|
-
<dl>
|
|
6403
|
-
<dd>
|
|
6404
|
-
|
|
6405
|
-
**attachment_id:** `AgentMail.AttachmentId`
|
|
7426
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
6406
7427
|
|
|
6407
7428
|
</dd>
|
|
6408
7429
|
</dl>
|
|
@@ -6410,7 +7431,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
6410
7431
|
<dl>
|
|
6411
7432
|
<dd>
|
|
6412
7433
|
|
|
6413
|
-
**requestOptions:** `
|
|
7434
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
6414
7435
|
|
|
6415
7436
|
</dd>
|
|
6416
7437
|
</dl>
|
|
@@ -6422,8 +7443,8 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
6422
7443
|
</dl>
|
|
6423
7444
|
</details>
|
|
6424
7445
|
|
|
6425
|
-
## Pods
|
|
6426
|
-
<details><summary><code>client.pods.
|
|
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>
|
|
6427
7448
|
<dl>
|
|
6428
7449
|
<dd>
|
|
6429
7450
|
|
|
@@ -6437,7 +7458,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
6437
7458
|
|
|
6438
7459
|
**CLI:**
|
|
6439
7460
|
```bash
|
|
6440
|
-
agentmail pods:
|
|
7461
|
+
agentmail pods:lists list --pod-id <pod_id> --direction <direction> --type <type>
|
|
6441
7462
|
```
|
|
6442
7463
|
</dd>
|
|
6443
7464
|
</dl>
|
|
@@ -6453,7 +7474,7 @@ agentmail pods:inboxes list --pod-id <pod_id>
|
|
|
6453
7474
|
<dd>
|
|
6454
7475
|
|
|
6455
7476
|
```typescript
|
|
6456
|
-
await client.pods.
|
|
7477
|
+
await client.pods.lists.list("pod_id", "send", "allow");
|
|
6457
7478
|
|
|
6458
7479
|
```
|
|
6459
7480
|
</dd>
|
|
@@ -6477,7 +7498,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
6477
7498
|
<dl>
|
|
6478
7499
|
<dd>
|
|
6479
7500
|
|
|
6480
|
-
**
|
|
7501
|
+
**direction:** `AgentMail.Direction`
|
|
6481
7502
|
|
|
6482
7503
|
</dd>
|
|
6483
7504
|
</dl>
|
|
@@ -6485,7 +7506,23 @@ await client.pods.inboxes.list("pod_id");
|
|
|
6485
7506
|
<dl>
|
|
6486
7507
|
<dd>
|
|
6487
7508
|
|
|
6488
|
-
**
|
|
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`
|
|
6489
7526
|
|
|
6490
7527
|
</dd>
|
|
6491
7528
|
</dl>
|
|
@@ -6497,7 +7534,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
6497
7534
|
</dl>
|
|
6498
7535
|
</details>
|
|
6499
7536
|
|
|
6500
|
-
<details><summary><code>client.pods.
|
|
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>
|
|
6501
7538
|
<dl>
|
|
6502
7539
|
<dd>
|
|
6503
7540
|
|
|
@@ -6511,7 +7548,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
6511
7548
|
|
|
6512
7549
|
**CLI:**
|
|
6513
7550
|
```bash
|
|
6514
|
-
agentmail pods:
|
|
7551
|
+
agentmail pods:lists get --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
6515
7552
|
```
|
|
6516
7553
|
</dd>
|
|
6517
7554
|
</dl>
|
|
@@ -6527,7 +7564,7 @@ agentmail pods:inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
6527
7564
|
<dd>
|
|
6528
7565
|
|
|
6529
7566
|
```typescript
|
|
6530
|
-
await client.pods.
|
|
7567
|
+
await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
6531
7568
|
|
|
6532
7569
|
```
|
|
6533
7570
|
</dd>
|
|
@@ -6551,7 +7588,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
6551
7588
|
<dl>
|
|
6552
7589
|
<dd>
|
|
6553
7590
|
|
|
6554
|
-
**
|
|
7591
|
+
**direction:** `AgentMail.Direction`
|
|
6555
7592
|
|
|
6556
7593
|
</dd>
|
|
6557
7594
|
</dl>
|
|
@@ -6559,7 +7596,23 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
6559
7596
|
<dl>
|
|
6560
7597
|
<dd>
|
|
6561
7598
|
|
|
6562
|
-
**
|
|
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`
|
|
6563
7616
|
|
|
6564
7617
|
</dd>
|
|
6565
7618
|
</dl>
|
|
@@ -6571,7 +7624,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
6571
7624
|
</dl>
|
|
6572
7625
|
</details>
|
|
6573
7626
|
|
|
6574
|
-
<details><summary><code>client.pods.
|
|
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>
|
|
6575
7628
|
<dl>
|
|
6576
7629
|
<dd>
|
|
6577
7630
|
|
|
@@ -6585,7 +7638,7 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
6585
7638
|
|
|
6586
7639
|
**CLI:**
|
|
6587
7640
|
```bash
|
|
6588
|
-
agentmail pods:
|
|
7641
|
+
agentmail pods:lists create --pod-id <pod_id> --direction <direction> --type <type> --entry user@example.com
|
|
6589
7642
|
```
|
|
6590
7643
|
</dd>
|
|
6591
7644
|
</dl>
|
|
@@ -6601,7 +7654,9 @@ agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain exam
|
|
|
6601
7654
|
<dd>
|
|
6602
7655
|
|
|
6603
7656
|
```typescript
|
|
6604
|
-
await client.pods.
|
|
7657
|
+
await client.pods.lists.create("pod_id", "send", "allow", {
|
|
7658
|
+
entry: "entry"
|
|
7659
|
+
});
|
|
6605
7660
|
|
|
6606
7661
|
```
|
|
6607
7662
|
</dd>
|
|
@@ -6625,7 +7680,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
6625
7680
|
<dl>
|
|
6626
7681
|
<dd>
|
|
6627
7682
|
|
|
6628
|
-
**
|
|
7683
|
+
**direction:** `AgentMail.Direction`
|
|
6629
7684
|
|
|
6630
7685
|
</dd>
|
|
6631
7686
|
</dl>
|
|
@@ -6633,7 +7688,23 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
6633
7688
|
<dl>
|
|
6634
7689
|
<dd>
|
|
6635
7690
|
|
|
6636
|
-
**
|
|
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`
|
|
6637
7708
|
|
|
6638
7709
|
</dd>
|
|
6639
7710
|
</dl>
|
|
@@ -6645,7 +7716,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
6645
7716
|
</dl>
|
|
6646
7717
|
</details>
|
|
6647
7718
|
|
|
6648
|
-
<details><summary><code>client.pods.
|
|
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>
|
|
6649
7720
|
<dl>
|
|
6650
7721
|
<dd>
|
|
6651
7722
|
|
|
@@ -6659,7 +7730,7 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
6659
7730
|
|
|
6660
7731
|
**CLI:**
|
|
6661
7732
|
```bash
|
|
6662
|
-
agentmail pods:
|
|
7733
|
+
agentmail pods:lists delete --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
6663
7734
|
```
|
|
6664
7735
|
</dd>
|
|
6665
7736
|
</dl>
|
|
@@ -6675,7 +7746,7 @@ agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
6675
7746
|
<dd>
|
|
6676
7747
|
|
|
6677
7748
|
```typescript
|
|
6678
|
-
await client.pods.
|
|
7749
|
+
await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
6679
7750
|
|
|
6680
7751
|
```
|
|
6681
7752
|
</dd>
|
|
@@ -6699,7 +7770,7 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
6699
7770
|
<dl>
|
|
6700
7771
|
<dd>
|
|
6701
7772
|
|
|
6702
|
-
**
|
|
7773
|
+
**direction:** `AgentMail.Direction`
|
|
6703
7774
|
|
|
6704
7775
|
</dd>
|
|
6705
7776
|
</dl>
|
|
@@ -6707,7 +7778,7 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
6707
7778
|
<dl>
|
|
6708
7779
|
<dd>
|
|
6709
7780
|
|
|
6710
|
-
**
|
|
7781
|
+
**type:** `AgentMail.ListType`
|
|
6711
7782
|
|
|
6712
7783
|
</dd>
|
|
6713
7784
|
</dl>
|
|
@@ -6715,7 +7786,15 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
6715
7786
|
<dl>
|
|
6716
7787
|
<dd>
|
|
6717
7788
|
|
|
6718
|
-
**
|
|
7789
|
+
**entry:** `string` — Email address or domain.
|
|
7790
|
+
|
|
7791
|
+
</dd>
|
|
7792
|
+
</dl>
|
|
7793
|
+
|
|
7794
|
+
<dl>
|
|
7795
|
+
<dd>
|
|
7796
|
+
|
|
7797
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
6719
7798
|
|
|
6720
7799
|
</dd>
|
|
6721
7800
|
</dl>
|
|
@@ -6727,7 +7806,8 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
6727
7806
|
</dl>
|
|
6728
7807
|
</details>
|
|
6729
7808
|
|
|
6730
|
-
|
|
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>
|
|
6731
7811
|
<dl>
|
|
6732
7812
|
<dd>
|
|
6733
7813
|
|
|
@@ -6739,9 +7819,15 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {});
|
|
|
6739
7819
|
<dl>
|
|
6740
7820
|
<dd>
|
|
6741
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
|
+
|
|
6742
7828
|
**CLI:**
|
|
6743
7829
|
```bash
|
|
6744
|
-
agentmail pods:
|
|
7830
|
+
agentmail pods:metrics query --pod-id <pod_id>
|
|
6745
7831
|
```
|
|
6746
7832
|
</dd>
|
|
6747
7833
|
</dl>
|
|
@@ -6757,7 +7843,7 @@ agentmail pods:inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>
|
|
|
6757
7843
|
<dd>
|
|
6758
7844
|
|
|
6759
7845
|
```typescript
|
|
6760
|
-
await client.pods.
|
|
7846
|
+
await client.pods.metrics.queryEvents("pod_id");
|
|
6761
7847
|
|
|
6762
7848
|
```
|
|
6763
7849
|
</dd>
|
|
@@ -6781,7 +7867,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
6781
7867
|
<dl>
|
|
6782
7868
|
<dd>
|
|
6783
7869
|
|
|
6784
|
-
**
|
|
7870
|
+
**request:** `AgentMail.pods.QueryEventsRequest`
|
|
6785
7871
|
|
|
6786
7872
|
</dd>
|
|
6787
7873
|
</dl>
|
|
@@ -6789,7 +7875,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
6789
7875
|
<dl>
|
|
6790
7876
|
<dd>
|
|
6791
7877
|
|
|
6792
|
-
**requestOptions:** `
|
|
7878
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
6793
7879
|
|
|
6794
7880
|
</dd>
|
|
6795
7881
|
</dl>
|
|
@@ -6801,8 +7887,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
6801
7887
|
</dl>
|
|
6802
7888
|
</details>
|
|
6803
7889
|
|
|
6804
|
-
|
|
6805
|
-
<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>
|
|
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>
|
|
6806
7891
|
<dl>
|
|
6807
7892
|
<dd>
|
|
6808
7893
|
|
|
@@ -6814,10 +7899,13 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
6814
7899
|
<dl>
|
|
6815
7900
|
<dd>
|
|
6816
7901
|
|
|
6817
|
-
|
|
6818
|
-
|
|
6819
|
-
|
|
6820
|
-
|
|
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.
|
|
6821
7909
|
</dd>
|
|
6822
7910
|
</dl>
|
|
6823
7911
|
</dd>
|
|
@@ -6832,7 +7920,7 @@ agentmail pods:lists list --pod-id <pod_id> --direction <direction> --type <type
|
|
|
6832
7920
|
<dd>
|
|
6833
7921
|
|
|
6834
7922
|
```typescript
|
|
6835
|
-
await client.pods.
|
|
7923
|
+
await client.pods.metrics.queryUsage("pod_id");
|
|
6836
7924
|
|
|
6837
7925
|
```
|
|
6838
7926
|
</dd>
|
|
@@ -6856,23 +7944,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
6856
7944
|
<dl>
|
|
6857
7945
|
<dd>
|
|
6858
7946
|
|
|
6859
|
-
**
|
|
6860
|
-
|
|
6861
|
-
</dd>
|
|
6862
|
-
</dl>
|
|
6863
|
-
|
|
6864
|
-
<dl>
|
|
6865
|
-
<dd>
|
|
6866
|
-
|
|
6867
|
-
**type:** `AgentMail.ListType`
|
|
6868
|
-
|
|
6869
|
-
</dd>
|
|
6870
|
-
</dl>
|
|
6871
|
-
|
|
6872
|
-
<dl>
|
|
6873
|
-
<dd>
|
|
6874
|
-
|
|
6875
|
-
**request:** `AgentMail.pods.ListListEntriesRequest`
|
|
7947
|
+
**request:** `AgentMail.pods.QueryUsageRequest`
|
|
6876
7948
|
|
|
6877
7949
|
</dd>
|
|
6878
7950
|
</dl>
|
|
@@ -6880,7 +7952,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
6880
7952
|
<dl>
|
|
6881
7953
|
<dd>
|
|
6882
7954
|
|
|
6883
|
-
**requestOptions:** `
|
|
7955
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
6884
7956
|
|
|
6885
7957
|
</dd>
|
|
6886
7958
|
</dl>
|
|
@@ -6892,7 +7964,8 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
6892
7964
|
</dl>
|
|
6893
7965
|
</details>
|
|
6894
7966
|
|
|
6895
|
-
|
|
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>
|
|
6896
7969
|
<dl>
|
|
6897
7970
|
<dd>
|
|
6898
7971
|
|
|
@@ -6904,9 +7977,14 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
6904
7977
|
<dl>
|
|
6905
7978
|
<dd>
|
|
6906
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
|
+
|
|
6907
7985
|
**CLI:**
|
|
6908
7986
|
```bash
|
|
6909
|
-
agentmail pods:
|
|
7987
|
+
agentmail pods:threads list --pod-id <pod_id>
|
|
6910
7988
|
```
|
|
6911
7989
|
</dd>
|
|
6912
7990
|
</dl>
|
|
@@ -6922,7 +8000,7 @@ agentmail pods:lists get --pod-id <pod_id> --direction <direction> --type <type>
|
|
|
6922
8000
|
<dd>
|
|
6923
8001
|
|
|
6924
8002
|
```typescript
|
|
6925
|
-
await client.pods.
|
|
8003
|
+
await client.pods.threads.list("pod_id");
|
|
6926
8004
|
|
|
6927
8005
|
```
|
|
6928
8006
|
</dd>
|
|
@@ -6946,23 +8024,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
6946
8024
|
<dl>
|
|
6947
8025
|
<dd>
|
|
6948
8026
|
|
|
6949
|
-
**
|
|
6950
|
-
|
|
6951
|
-
</dd>
|
|
6952
|
-
</dl>
|
|
6953
|
-
|
|
6954
|
-
<dl>
|
|
6955
|
-
<dd>
|
|
6956
|
-
|
|
6957
|
-
**type:** `AgentMail.ListType`
|
|
6958
|
-
|
|
6959
|
-
</dd>
|
|
6960
|
-
</dl>
|
|
6961
|
-
|
|
6962
|
-
<dl>
|
|
6963
|
-
<dd>
|
|
6964
|
-
|
|
6965
|
-
**entry:** `string` — Email address or domain.
|
|
8027
|
+
**request:** `AgentMail.pods.ListThreadsRequest`
|
|
6966
8028
|
|
|
6967
8029
|
</dd>
|
|
6968
8030
|
</dl>
|
|
@@ -6970,7 +8032,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
6970
8032
|
<dl>
|
|
6971
8033
|
<dd>
|
|
6972
8034
|
|
|
6973
|
-
**requestOptions:** `
|
|
8035
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
6974
8036
|
|
|
6975
8037
|
</dd>
|
|
6976
8038
|
</dl>
|
|
@@ -6982,7 +8044,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
6982
8044
|
</dl>
|
|
6983
8045
|
</details>
|
|
6984
8046
|
|
|
6985
|
-
<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>
|
|
6986
8048
|
<dl>
|
|
6987
8049
|
<dd>
|
|
6988
8050
|
|
|
@@ -6994,10 +8056,10 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
6994
8056
|
<dl>
|
|
6995
8057
|
<dd>
|
|
6996
8058
|
|
|
6997
|
-
|
|
6998
|
-
|
|
6999
|
-
|
|
7000
|
-
|
|
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.
|
|
7001
8063
|
</dd>
|
|
7002
8064
|
</dl>
|
|
7003
8065
|
</dd>
|
|
@@ -7012,8 +8074,8 @@ agentmail pods:lists create --pod-id <pod_id> --direction <direction> --type <ty
|
|
|
7012
8074
|
<dd>
|
|
7013
8075
|
|
|
7014
8076
|
```typescript
|
|
7015
|
-
await client.pods.
|
|
7016
|
-
|
|
8077
|
+
await client.pods.threads.search("pod_id", {
|
|
8078
|
+
q: "q"
|
|
7017
8079
|
});
|
|
7018
8080
|
|
|
7019
8081
|
```
|
|
@@ -7038,23 +8100,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
7038
8100
|
<dl>
|
|
7039
8101
|
<dd>
|
|
7040
8102
|
|
|
7041
|
-
**
|
|
7042
|
-
|
|
7043
|
-
</dd>
|
|
7044
|
-
</dl>
|
|
7045
|
-
|
|
7046
|
-
<dl>
|
|
7047
|
-
<dd>
|
|
7048
|
-
|
|
7049
|
-
**type:** `AgentMail.ListType`
|
|
7050
|
-
|
|
7051
|
-
</dd>
|
|
7052
|
-
</dl>
|
|
7053
|
-
|
|
7054
|
-
<dl>
|
|
7055
|
-
<dd>
|
|
7056
|
-
|
|
7057
|
-
**request:** `AgentMail.CreateListEntryRequest`
|
|
8103
|
+
**request:** `AgentMail.pods.SearchThreadsRequest`
|
|
7058
8104
|
|
|
7059
8105
|
</dd>
|
|
7060
8106
|
</dl>
|
|
@@ -7062,7 +8108,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
7062
8108
|
<dl>
|
|
7063
8109
|
<dd>
|
|
7064
8110
|
|
|
7065
|
-
**requestOptions:** `
|
|
8111
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
7066
8112
|
|
|
7067
8113
|
</dd>
|
|
7068
8114
|
</dl>
|
|
@@ -7074,7 +8120,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
7074
8120
|
</dl>
|
|
7075
8121
|
</details>
|
|
7076
8122
|
|
|
7077
|
-
<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>
|
|
7078
8124
|
<dl>
|
|
7079
8125
|
<dd>
|
|
7080
8126
|
|
|
@@ -7088,7 +8134,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
7088
8134
|
|
|
7089
8135
|
**CLI:**
|
|
7090
8136
|
```bash
|
|
7091
|
-
agentmail pods:
|
|
8137
|
+
agentmail pods:threads get --pod-id <pod_id> --thread-id <thread_id>
|
|
7092
8138
|
```
|
|
7093
8139
|
</dd>
|
|
7094
8140
|
</dl>
|
|
@@ -7104,7 +8150,7 @@ agentmail pods:lists delete --pod-id <pod_id> --direction <direction> --type <ty
|
|
|
7104
8150
|
<dd>
|
|
7105
8151
|
|
|
7106
8152
|
```typescript
|
|
7107
|
-
await client.pods.
|
|
8153
|
+
await client.pods.threads.get("pod_id", "thread_id");
|
|
7108
8154
|
|
|
7109
8155
|
```
|
|
7110
8156
|
</dd>
|
|
@@ -7128,23 +8174,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
7128
8174
|
<dl>
|
|
7129
8175
|
<dd>
|
|
7130
8176
|
|
|
7131
|
-
**
|
|
7132
|
-
|
|
7133
|
-
</dd>
|
|
7134
|
-
</dl>
|
|
7135
|
-
|
|
7136
|
-
<dl>
|
|
7137
|
-
<dd>
|
|
7138
|
-
|
|
7139
|
-
**type:** `AgentMail.ListType`
|
|
7140
|
-
|
|
7141
|
-
</dd>
|
|
7142
|
-
</dl>
|
|
7143
|
-
|
|
7144
|
-
<dl>
|
|
7145
|
-
<dd>
|
|
7146
|
-
|
|
7147
|
-
**entry:** `string` — Email address or domain.
|
|
8177
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
7148
8178
|
|
|
7149
8179
|
</dd>
|
|
7150
8180
|
</dl>
|
|
@@ -7152,7 +8182,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
7152
8182
|
<dl>
|
|
7153
8183
|
<dd>
|
|
7154
8184
|
|
|
7155
|
-
**requestOptions:** `
|
|
8185
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
7156
8186
|
|
|
7157
8187
|
</dd>
|
|
7158
8188
|
</dl>
|
|
@@ -7164,8 +8194,7 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
7164
8194
|
</dl>
|
|
7165
8195
|
</details>
|
|
7166
8196
|
|
|
7167
|
-
|
|
7168
|
-
<details><summary><code>client.pods.metrics.<a href="/src/api/resources/pods/resources/metrics/client/Client.ts">queryEvents</a>(pod_id, { ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
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>
|
|
7169
8198
|
<dl>
|
|
7170
8199
|
<dd>
|
|
7171
8200
|
|
|
@@ -7177,15 +8206,9 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
7177
8206
|
<dl>
|
|
7178
8207
|
<dd>
|
|
7179
8208
|
|
|
7180
|
-
Counts of email events (sent, delivered, bounced, etc.) over time for
|
|
7181
|
-
the pod. Defaults to the last 24 hours; `start` must be within the last
|
|
7182
|
-
90 days, and a future `end` is clamped to now. Omit `period` for
|
|
7183
|
-
individual event counts, or set it to sum counts into buckets of that
|
|
7184
|
-
many seconds.
|
|
7185
|
-
|
|
7186
8209
|
**CLI:**
|
|
7187
8210
|
```bash
|
|
7188
|
-
agentmail pods:
|
|
8211
|
+
agentmail pods:threads get-attachment --pod-id <pod_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
7189
8212
|
```
|
|
7190
8213
|
</dd>
|
|
7191
8214
|
</dl>
|
|
@@ -7201,7 +8224,7 @@ agentmail pods:metrics query --pod-id <pod_id>
|
|
|
7201
8224
|
<dd>
|
|
7202
8225
|
|
|
7203
8226
|
```typescript
|
|
7204
|
-
await client.pods.
|
|
8227
|
+
await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
7205
8228
|
|
|
7206
8229
|
```
|
|
7207
8230
|
</dd>
|
|
@@ -7225,7 +8248,7 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
7225
8248
|
<dl>
|
|
7226
8249
|
<dd>
|
|
7227
8250
|
|
|
7228
|
-
**
|
|
8251
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
7229
8252
|
|
|
7230
8253
|
</dd>
|
|
7231
8254
|
</dl>
|
|
@@ -7233,7 +8256,15 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
7233
8256
|
<dl>
|
|
7234
8257
|
<dd>
|
|
7235
8258
|
|
|
7236
|
-
**
|
|
8259
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
8260
|
+
|
|
8261
|
+
</dd>
|
|
8262
|
+
</dl>
|
|
8263
|
+
|
|
8264
|
+
<dl>
|
|
8265
|
+
<dd>
|
|
8266
|
+
|
|
8267
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
7237
8268
|
|
|
7238
8269
|
</dd>
|
|
7239
8270
|
</dl>
|
|
@@ -7245,7 +8276,7 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
7245
8276
|
</dl>
|
|
7246
8277
|
</details>
|
|
7247
8278
|
|
|
7248
|
-
<details><summary><code>client.pods.
|
|
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>
|
|
7249
8280
|
<dl>
|
|
7250
8281
|
<dd>
|
|
7251
8282
|
|
|
@@ -7257,13 +8288,7 @@ await client.pods.metrics.queryEvents("pod_id");
|
|
|
7257
8288
|
<dl>
|
|
7258
8289
|
<dd>
|
|
7259
8290
|
|
|
7260
|
-
|
|
7261
|
-
the usage type at that timestamp, not the change within the bucket.
|
|
7262
|
-
Pod-scoped queries carry every usage type except `pod_count`; requested
|
|
7263
|
-
types that don't apply to the scope are ignored. Defaults to the last
|
|
7264
|
-
24 hours; `start` must be within the last 90 days, and a future `end`
|
|
7265
|
-
is clamped to now. The range divided by `period` must not exceed 1000
|
|
7266
|
-
buckets.
|
|
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.
|
|
7267
8292
|
</dd>
|
|
7268
8293
|
</dl>
|
|
7269
8294
|
</dd>
|
|
@@ -7278,7 +8303,7 @@ buckets.
|
|
|
7278
8303
|
<dd>
|
|
7279
8304
|
|
|
7280
8305
|
```typescript
|
|
7281
|
-
await client.pods.
|
|
8306
|
+
await client.pods.threads.update("pod_id", "thread_id", {});
|
|
7282
8307
|
|
|
7283
8308
|
```
|
|
7284
8309
|
</dd>
|
|
@@ -7302,7 +8327,7 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
7302
8327
|
<dl>
|
|
7303
8328
|
<dd>
|
|
7304
8329
|
|
|
7305
|
-
**
|
|
8330
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
7306
8331
|
|
|
7307
8332
|
</dd>
|
|
7308
8333
|
</dl>
|
|
@@ -7310,7 +8335,15 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
7310
8335
|
<dl>
|
|
7311
8336
|
<dd>
|
|
7312
8337
|
|
|
7313
|
-
**
|
|
8338
|
+
**request:** `AgentMail.UpdateThreadRequest`
|
|
8339
|
+
|
|
8340
|
+
</dd>
|
|
8341
|
+
</dl>
|
|
8342
|
+
|
|
8343
|
+
<dl>
|
|
8344
|
+
<dd>
|
|
8345
|
+
|
|
8346
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
7314
8347
|
|
|
7315
8348
|
</dd>
|
|
7316
8349
|
</dl>
|
|
@@ -7322,8 +8355,7 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
7322
8355
|
</dl>
|
|
7323
8356
|
</details>
|
|
7324
8357
|
|
|
7325
|
-
|
|
7326
|
-
<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>
|
|
7327
8359
|
<dl>
|
|
7328
8360
|
<dd>
|
|
7329
8361
|
|
|
@@ -7335,14 +8367,11 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
7335
8367
|
<dl>
|
|
7336
8368
|
<dd>
|
|
7337
8369
|
|
|
7338
|
-
|
|
7339
|
-
`recipients`, or `subject` to filter by substring. Filtered requests are
|
|
7340
|
-
served by search, which caps `limit` at 100. For relevance-ranked
|
|
7341
|
-
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.
|
|
7342
8371
|
|
|
7343
8372
|
**CLI:**
|
|
7344
8373
|
```bash
|
|
7345
|
-
agentmail pods:threads
|
|
8374
|
+
agentmail pods:threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
7346
8375
|
```
|
|
7347
8376
|
</dd>
|
|
7348
8377
|
</dl>
|
|
@@ -7358,7 +8387,7 @@ agentmail pods:threads list --pod-id <pod_id>
|
|
|
7358
8387
|
<dd>
|
|
7359
8388
|
|
|
7360
8389
|
```typescript
|
|
7361
|
-
await client.pods.threads.
|
|
8390
|
+
await client.pods.threads.delete("pod_id", "thread_id");
|
|
7362
8391
|
|
|
7363
8392
|
```
|
|
7364
8393
|
</dd>
|
|
@@ -7382,7 +8411,15 @@ await client.pods.threads.list("pod_id");
|
|
|
7382
8411
|
<dl>
|
|
7383
8412
|
<dd>
|
|
7384
8413
|
|
|
7385
|
-
**
|
|
8414
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
8415
|
+
|
|
8416
|
+
</dd>
|
|
8417
|
+
</dl>
|
|
8418
|
+
|
|
8419
|
+
<dl>
|
|
8420
|
+
<dd>
|
|
8421
|
+
|
|
8422
|
+
**request:** `AgentMail.pods.DeleteThreadRequest`
|
|
7386
8423
|
|
|
7387
8424
|
</dd>
|
|
7388
8425
|
</dl>
|
|
@@ -7402,7 +8439,8 @@ await client.pods.threads.list("pod_id");
|
|
|
7402
8439
|
</dl>
|
|
7403
8440
|
</details>
|
|
7404
8441
|
|
|
7405
|
-
|
|
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>
|
|
7406
8444
|
<dl>
|
|
7407
8445
|
<dd>
|
|
7408
8446
|
|
|
@@ -7414,10 +8452,10 @@ await client.pods.threads.list("pod_id");
|
|
|
7414
8452
|
<dl>
|
|
7415
8453
|
<dd>
|
|
7416
8454
|
|
|
7417
|
-
|
|
7418
|
-
|
|
7419
|
-
|
|
7420
|
-
|
|
8455
|
+
**CLI:**
|
|
8456
|
+
```bash
|
|
8457
|
+
agentmail pods:webhooks list --pod-id <pod_id>
|
|
8458
|
+
```
|
|
7421
8459
|
</dd>
|
|
7422
8460
|
</dl>
|
|
7423
8461
|
</dd>
|
|
@@ -7432,9 +8470,7 @@ unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
|
7432
8470
|
<dd>
|
|
7433
8471
|
|
|
7434
8472
|
```typescript
|
|
7435
|
-
await client.pods.
|
|
7436
|
-
q: "q"
|
|
7437
|
-
});
|
|
8473
|
+
await client.pods.webhooks.list("pod_id");
|
|
7438
8474
|
|
|
7439
8475
|
```
|
|
7440
8476
|
</dd>
|
|
@@ -7458,7 +8494,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
7458
8494
|
<dl>
|
|
7459
8495
|
<dd>
|
|
7460
8496
|
|
|
7461
|
-
**request:** `AgentMail.pods.
|
|
8497
|
+
**request:** `AgentMail.pods.PodListWebhooksRequest`
|
|
7462
8498
|
|
|
7463
8499
|
</dd>
|
|
7464
8500
|
</dl>
|
|
@@ -7466,7 +8502,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
7466
8502
|
<dl>
|
|
7467
8503
|
<dd>
|
|
7468
8504
|
|
|
7469
|
-
**requestOptions:** `
|
|
8505
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
7470
8506
|
|
|
7471
8507
|
</dd>
|
|
7472
8508
|
</dl>
|
|
@@ -7478,7 +8514,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
7478
8514
|
</dl>
|
|
7479
8515
|
</details>
|
|
7480
8516
|
|
|
7481
|
-
<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>
|
|
7482
8518
|
<dl>
|
|
7483
8519
|
<dd>
|
|
7484
8520
|
|
|
@@ -7492,7 +8528,7 @@ await client.pods.threads.search("pod_id", {
|
|
|
7492
8528
|
|
|
7493
8529
|
**CLI:**
|
|
7494
8530
|
```bash
|
|
7495
|
-
agentmail pods:
|
|
8531
|
+
agentmail pods:webhooks get --pod-id <pod_id> --webhook-id <webhook_id>
|
|
7496
8532
|
```
|
|
7497
8533
|
</dd>
|
|
7498
8534
|
</dl>
|
|
@@ -7508,7 +8544,7 @@ agentmail pods:threads get --pod-id <pod_id> --thread-id <thread_id>
|
|
|
7508
8544
|
<dd>
|
|
7509
8545
|
|
|
7510
8546
|
```typescript
|
|
7511
|
-
await client.pods.
|
|
8547
|
+
await client.pods.webhooks.get("pod_id", "webhook_id");
|
|
7512
8548
|
|
|
7513
8549
|
```
|
|
7514
8550
|
</dd>
|
|
@@ -7532,7 +8568,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
7532
8568
|
<dl>
|
|
7533
8569
|
<dd>
|
|
7534
8570
|
|
|
7535
|
-
**
|
|
8571
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
7536
8572
|
|
|
7537
8573
|
</dd>
|
|
7538
8574
|
</dl>
|
|
@@ -7540,7 +8576,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
7540
8576
|
<dl>
|
|
7541
8577
|
<dd>
|
|
7542
8578
|
|
|
7543
|
-
**requestOptions:** `
|
|
8579
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
7544
8580
|
|
|
7545
8581
|
</dd>
|
|
7546
8582
|
</dl>
|
|
@@ -7552,7 +8588,7 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
7552
8588
|
</dl>
|
|
7553
8589
|
</details>
|
|
7554
8590
|
|
|
7555
|
-
<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>
|
|
7556
8592
|
<dl>
|
|
7557
8593
|
<dd>
|
|
7558
8594
|
|
|
@@ -7564,9 +8600,11 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
7564
8600
|
<dl>
|
|
7565
8601
|
<dd>
|
|
7566
8602
|
|
|
8603
|
+
Create a webhook scoped to this pod.
|
|
8604
|
+
|
|
7567
8605
|
**CLI:**
|
|
7568
8606
|
```bash
|
|
7569
|
-
agentmail pods:
|
|
8607
|
+
agentmail pods:webhooks create --pod-id <pod_id> --url https://example.com/webhook --event-type message.received
|
|
7570
8608
|
```
|
|
7571
8609
|
</dd>
|
|
7572
8610
|
</dl>
|
|
@@ -7582,7 +8620,10 @@ agentmail pods:threads get-attachment --pod-id <pod_id> --thread-id <thread_id>
|
|
|
7582
8620
|
<dd>
|
|
7583
8621
|
|
|
7584
8622
|
```typescript
|
|
7585
|
-
await client.pods.
|
|
8623
|
+
await client.pods.webhooks.create("pod_id", {
|
|
8624
|
+
url: "url",
|
|
8625
|
+
eventTypes: ["message.received", "message.received"]
|
|
8626
|
+
});
|
|
7586
8627
|
|
|
7587
8628
|
```
|
|
7588
8629
|
</dd>
|
|
@@ -7606,15 +8647,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
7606
8647
|
<dl>
|
|
7607
8648
|
<dd>
|
|
7608
8649
|
|
|
7609
|
-
**
|
|
7610
|
-
|
|
7611
|
-
</dd>
|
|
7612
|
-
</dl>
|
|
7613
|
-
|
|
7614
|
-
<dl>
|
|
7615
|
-
<dd>
|
|
7616
|
-
|
|
7617
|
-
**attachment_id:** `AgentMail.AttachmentId`
|
|
8650
|
+
**request:** `AgentMail.CreatePodWebhookRequest`
|
|
7618
8651
|
|
|
7619
8652
|
</dd>
|
|
7620
8653
|
</dl>
|
|
@@ -7622,7 +8655,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
7622
8655
|
<dl>
|
|
7623
8656
|
<dd>
|
|
7624
8657
|
|
|
7625
|
-
**requestOptions:** `
|
|
8658
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
7626
8659
|
|
|
7627
8660
|
</dd>
|
|
7628
8661
|
</dl>
|
|
@@ -7634,7 +8667,7 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
7634
8667
|
</dl>
|
|
7635
8668
|
</details>
|
|
7636
8669
|
|
|
7637
|
-
<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>
|
|
7638
8671
|
<dl>
|
|
7639
8672
|
<dd>
|
|
7640
8673
|
|
|
@@ -7646,7 +8679,10 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
7646
8679
|
<dl>
|
|
7647
8680
|
<dd>
|
|
7648
8681
|
|
|
7649
|
-
|
|
8682
|
+
**CLI:**
|
|
8683
|
+
```bash
|
|
8684
|
+
agentmail pods:webhooks update --pod-id <pod_id> --webhook-id <webhook_id> --add-inbox-id <inbox_id>
|
|
8685
|
+
```
|
|
7650
8686
|
</dd>
|
|
7651
8687
|
</dl>
|
|
7652
8688
|
</dd>
|
|
@@ -7661,7 +8697,7 @@ Updates thread labels. Cannot add or remove system labels (sent, received, bounc
|
|
|
7661
8697
|
<dd>
|
|
7662
8698
|
|
|
7663
8699
|
```typescript
|
|
7664
|
-
await client.pods.
|
|
8700
|
+
await client.pods.webhooks.update("pod_id", "webhook_id", {});
|
|
7665
8701
|
|
|
7666
8702
|
```
|
|
7667
8703
|
</dd>
|
|
@@ -7685,7 +8721,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
7685
8721
|
<dl>
|
|
7686
8722
|
<dd>
|
|
7687
8723
|
|
|
7688
|
-
**
|
|
8724
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
7689
8725
|
|
|
7690
8726
|
</dd>
|
|
7691
8727
|
</dl>
|
|
@@ -7693,7 +8729,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
7693
8729
|
<dl>
|
|
7694
8730
|
<dd>
|
|
7695
8731
|
|
|
7696
|
-
**request:** `AgentMail.
|
|
8732
|
+
**request:** `AgentMail.UpdatePodWebhookRequest`
|
|
7697
8733
|
|
|
7698
8734
|
</dd>
|
|
7699
8735
|
</dl>
|
|
@@ -7701,7 +8737,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
7701
8737
|
<dl>
|
|
7702
8738
|
<dd>
|
|
7703
8739
|
|
|
7704
|
-
**requestOptions:** `
|
|
8740
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
7705
8741
|
|
|
7706
8742
|
</dd>
|
|
7707
8743
|
</dl>
|
|
@@ -7713,7 +8749,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
7713
8749
|
</dl>
|
|
7714
8750
|
</details>
|
|
7715
8751
|
|
|
7716
|
-
<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>
|
|
7717
8753
|
<dl>
|
|
7718
8754
|
<dd>
|
|
7719
8755
|
|
|
@@ -7725,11 +8761,9 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
7725
8761
|
<dl>
|
|
7726
8762
|
<dd>
|
|
7727
8763
|
|
|
7728
|
-
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.
|
|
7729
|
-
|
|
7730
8764
|
**CLI:**
|
|
7731
8765
|
```bash
|
|
7732
|
-
agentmail pods:
|
|
8766
|
+
agentmail pods:webhooks delete --pod-id <pod_id> --webhook-id <webhook_id>
|
|
7733
8767
|
```
|
|
7734
8768
|
</dd>
|
|
7735
8769
|
</dl>
|
|
@@ -7745,7 +8779,7 @@ agentmail pods:threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
|
7745
8779
|
<dd>
|
|
7746
8780
|
|
|
7747
8781
|
```typescript
|
|
7748
|
-
await client.pods.
|
|
8782
|
+
await client.pods.webhooks.delete("pod_id", "webhook_id");
|
|
7749
8783
|
|
|
7750
8784
|
```
|
|
7751
8785
|
</dd>
|
|
@@ -7769,15 +8803,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
7769
8803
|
<dl>
|
|
7770
8804
|
<dd>
|
|
7771
8805
|
|
|
7772
|
-
**
|
|
7773
|
-
|
|
7774
|
-
</dd>
|
|
7775
|
-
</dl>
|
|
7776
|
-
|
|
7777
|
-
<dl>
|
|
7778
|
-
<dd>
|
|
7779
|
-
|
|
7780
|
-
**request:** `AgentMail.pods.DeleteThreadRequest`
|
|
8806
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
7781
8807
|
|
|
7782
8808
|
</dd>
|
|
7783
8809
|
</dl>
|
|
@@ -7785,7 +8811,7 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
7785
8811
|
<dl>
|
|
7786
8812
|
<dd>
|
|
7787
8813
|
|
|
7788
|
-
**requestOptions:** `
|
|
8814
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
7789
8815
|
|
|
7790
8816
|
</dd>
|
|
7791
8817
|
</dl>
|