agentmail 0.4.2 → 0.4.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/domains/client/Client.d.ts +12 -0
- package/dist/cjs/api/resources/domains/client/Client.js +69 -0
- package/dist/cjs/api/resources/domains/types/UpdateDomainRequest.d.ts +4 -0
- package/dist/cjs/api/resources/domains/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/domains/types/index.js +1 -0
- package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.d.ts +9 -9
- package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.js +50 -50
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +22 -15
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +71 -56
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.d.ts +4 -8
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.js +17 -28
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/QueryMetricsRequest.d.ts +13 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/lists/client/Client.d.ts +15 -15
- package/dist/cjs/api/resources/lists/client/Client.js +67 -67
- package/dist/cjs/api/resources/messages/types/RawMessageResponse.d.ts +14 -0
- package/dist/cjs/api/resources/messages/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/types/index.js +1 -0
- package/dist/cjs/api/resources/metrics/client/Client.d.ts +5 -8
- package/dist/cjs/api/resources/metrics/client/Client.js +20 -22
- package/dist/cjs/api/resources/metrics/client/requests/QueryMetricsRequest.d.ts +13 -0
- package/dist/cjs/api/resources/metrics/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/metrics/types/Descending.d.ts +4 -0
- package/dist/cjs/api/resources/metrics/types/End.d.ts +4 -0
- package/dist/cjs/api/resources/metrics/types/MetricBucket.d.ts +6 -0
- package/dist/cjs/api/resources/metrics/types/MetricEventTypes.d.ts +1 -1
- package/dist/cjs/api/resources/metrics/types/MetricLimit.d.ts +4 -0
- package/dist/cjs/api/resources/metrics/types/MetricLimit.js +3 -0
- package/dist/cjs/api/resources/metrics/types/Period.d.ts +4 -0
- package/dist/cjs/api/resources/metrics/types/Period.js +3 -0
- package/dist/cjs/api/resources/metrics/types/QueryMetricsResponse.d.ts +5 -0
- package/dist/cjs/api/resources/metrics/types/QueryMetricsResponse.js +3 -0
- package/dist/cjs/api/resources/metrics/types/Start.d.ts +4 -0
- package/dist/cjs/api/resources/metrics/types/Start.js +3 -0
- package/dist/cjs/api/resources/metrics/types/index.d.ts +7 -5
- package/dist/cjs/api/resources/metrics/types/index.js +7 -5
- package/dist/cjs/api/resources/pods/client/Client.d.ts +7 -4
- package/dist/cjs/api/resources/pods/client/Client.js +13 -8
- package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.js +42 -42
- package/dist/cjs/api/resources/pods/resources/domains/client/Client.d.ts +33 -3
- package/dist/cjs/api/resources/pods/resources/domains/client/Client.js +178 -6
- package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.js +72 -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/lists/client/Client.d.ts +16 -16
- package/dist/cjs/api/resources/pods/resources/lists/client/Client.js +67 -67
- package/dist/cjs/api/resources/pods/resources/metrics/client/Client.d.ts +25 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/Client.js +142 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/index.js +17 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/QueryMetricsRequest.d.ts +13 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/QueryMetricsRequest.js +3 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/pods/resources/metrics/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/metrics/index.js +17 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.js +61 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/requests/DeleteThreadRequest.d.ts +8 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/requests/DeleteThreadRequest.js +3 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/threads/client/Client.d.ts +14 -0
- package/dist/cjs/api/resources/threads/client/Client.js +60 -0
- package/dist/cjs/api/resources/threads/client/requests/DeleteThreadRequest.d.ts +8 -0
- package/dist/cjs/api/resources/threads/client/requests/DeleteThreadRequest.js +3 -0
- package/dist/cjs/api/resources/threads/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/webhooks/client/Client.js +31 -31
- package/dist/cjs/serialization/resources/domains/types/UpdateDomainRequest.d.ts +10 -0
- package/dist/cjs/serialization/resources/domains/types/UpdateDomainRequest.js +42 -0
- package/dist/cjs/serialization/resources/domains/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/domains/types/index.js +1 -0
- package/dist/cjs/serialization/resources/messages/types/RawMessageResponse.d.ts +14 -0
- package/dist/cjs/serialization/resources/messages/types/RawMessageResponse.js +46 -0
- package/dist/cjs/serialization/resources/messages/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/messages/types/index.js +1 -0
- package/dist/cjs/serialization/resources/metrics/types/Descending.d.ts +7 -0
- package/dist/cjs/serialization/resources/metrics/types/{MetricTimestamp.js → Descending.js} +2 -2
- package/dist/cjs/serialization/resources/metrics/types/{MetricTimestamp.d.ts → End.d.ts} +2 -2
- package/dist/cjs/serialization/resources/metrics/types/{MetricEndTimestamp.js → End.js} +2 -2
- package/dist/cjs/serialization/resources/metrics/types/MetricBucket.d.ts +10 -0
- package/dist/cjs/serialization/resources/metrics/types/{ListMetricsResponse.js → MetricBucket.js} +4 -4
- package/dist/cjs/serialization/resources/metrics/types/MetricLimit.d.ts +7 -0
- package/dist/cjs/serialization/resources/metrics/types/{MetricStartTimestamp.js → MetricLimit.js} +2 -2
- package/dist/cjs/serialization/resources/metrics/types/{MetricEndTimestamp.d.ts → Period.d.ts} +2 -2
- package/dist/cjs/serialization/resources/metrics/types/Period.js +39 -0
- package/dist/cjs/serialization/resources/metrics/types/QueryMetricsResponse.d.ts +9 -0
- package/dist/cjs/serialization/resources/metrics/types/QueryMetricsResponse.js +41 -0
- package/dist/cjs/serialization/resources/metrics/types/{MetricStartTimestamp.d.ts → Start.d.ts} +2 -2
- package/dist/cjs/serialization/resources/metrics/types/Start.js +39 -0
- package/dist/cjs/serialization/resources/metrics/types/index.d.ts +7 -5
- package/dist/cjs/serialization/resources/metrics/types/index.js +7 -5
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/domains/client/Client.d.mts +12 -0
- package/dist/esm/api/resources/domains/client/Client.mjs +69 -0
- package/dist/esm/api/resources/domains/types/UpdateDomainRequest.d.mts +4 -0
- package/dist/esm/api/resources/domains/types/index.d.mts +1 -0
- package/dist/esm/api/resources/domains/types/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.d.mts +9 -9
- package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.mjs +50 -50
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +22 -15
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +71 -56
- package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.d.mts +4 -8
- package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.mjs +17 -28
- package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/QueryMetricsRequest.d.mts +13 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/lists/client/Client.d.mts +15 -15
- package/dist/esm/api/resources/lists/client/Client.mjs +67 -67
- package/dist/esm/api/resources/messages/types/RawMessageResponse.d.mts +14 -0
- package/dist/esm/api/resources/messages/types/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/types/index.mjs +1 -0
- package/dist/esm/api/resources/metrics/client/Client.d.mts +5 -8
- package/dist/esm/api/resources/metrics/client/Client.mjs +20 -22
- package/dist/esm/api/resources/metrics/client/requests/QueryMetricsRequest.d.mts +13 -0
- package/dist/esm/api/resources/metrics/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/metrics/types/Descending.d.mts +4 -0
- package/dist/esm/api/resources/metrics/types/End.d.mts +4 -0
- package/dist/esm/api/resources/metrics/types/MetricBucket.d.mts +6 -0
- package/dist/esm/api/resources/metrics/types/MetricEventTypes.d.mts +1 -1
- package/dist/esm/api/resources/metrics/types/MetricLimit.d.mts +4 -0
- package/dist/esm/api/resources/metrics/types/MetricLimit.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/Period.d.mts +4 -0
- package/dist/esm/api/resources/metrics/types/Period.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/QueryMetricsResponse.d.mts +5 -0
- package/dist/esm/api/resources/metrics/types/QueryMetricsResponse.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/Start.d.mts +4 -0
- package/dist/esm/api/resources/metrics/types/Start.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/index.d.mts +7 -5
- package/dist/esm/api/resources/metrics/types/index.mjs +7 -5
- package/dist/esm/api/resources/pods/client/Client.d.mts +7 -4
- package/dist/esm/api/resources/pods/client/Client.mjs +11 -6
- package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.mjs +42 -42
- package/dist/esm/api/resources/pods/resources/domains/client/Client.d.mts +33 -3
- package/dist/esm/api/resources/pods/resources/domains/client/Client.mjs +178 -6
- package/dist/esm/api/resources/pods/resources/inboxes/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/pods/resources/inboxes/client/Client.mjs +72 -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/lists/client/Client.d.mts +16 -16
- package/dist/esm/api/resources/pods/resources/lists/client/Client.mjs +67 -67
- package/dist/esm/api/resources/pods/resources/metrics/client/Client.d.mts +25 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/Client.mjs +105 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/requests/QueryMetricsRequest.d.mts +13 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/requests/QueryMetricsRequest.mjs +2 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/metrics/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/metrics/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/threads/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/pods/resources/threads/client/Client.mjs +61 -0
- package/dist/esm/api/resources/pods/resources/threads/client/requests/DeleteThreadRequest.d.mts +8 -0
- package/dist/esm/api/resources/pods/resources/threads/client/requests/DeleteThreadRequest.mjs +2 -0
- package/dist/esm/api/resources/pods/resources/threads/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/threads/client/Client.d.mts +14 -0
- package/dist/esm/api/resources/threads/client/Client.mjs +60 -0
- package/dist/esm/api/resources/threads/client/requests/DeleteThreadRequest.d.mts +8 -0
- package/dist/esm/api/resources/threads/client/requests/DeleteThreadRequest.mjs +2 -0
- package/dist/esm/api/resources/threads/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/webhooks/client/Client.mjs +31 -31
- package/dist/esm/serialization/resources/domains/types/UpdateDomainRequest.d.mts +10 -0
- package/dist/esm/serialization/resources/domains/types/UpdateDomainRequest.mjs +6 -0
- package/dist/esm/serialization/resources/domains/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/domains/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/messages/types/RawMessageResponse.d.mts +14 -0
- package/dist/esm/serialization/resources/messages/types/RawMessageResponse.mjs +10 -0
- package/dist/esm/serialization/resources/messages/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/messages/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/metrics/types/Descending.d.mts +7 -0
- package/dist/esm/serialization/resources/metrics/types/{MetricTimestamp.mjs → Descending.mjs} +1 -1
- package/dist/esm/serialization/resources/metrics/types/{MetricTimestamp.d.mts → End.d.mts} +2 -2
- package/dist/esm/serialization/resources/metrics/types/{MetricEndTimestamp.mjs → End.mjs} +1 -1
- package/dist/esm/serialization/resources/metrics/types/MetricBucket.d.mts +10 -0
- package/dist/esm/serialization/resources/metrics/types/MetricBucket.mjs +6 -0
- package/dist/esm/serialization/resources/metrics/types/MetricLimit.d.mts +7 -0
- package/dist/esm/serialization/resources/metrics/types/{MetricStartTimestamp.mjs → MetricLimit.mjs} +1 -1
- package/dist/esm/serialization/resources/metrics/types/{MetricEndTimestamp.d.mts → Period.d.mts} +2 -2
- package/dist/esm/serialization/resources/metrics/types/Period.mjs +3 -0
- package/dist/esm/serialization/resources/metrics/types/QueryMetricsResponse.d.mts +9 -0
- package/dist/esm/serialization/resources/metrics/types/QueryMetricsResponse.mjs +5 -0
- package/dist/esm/serialization/resources/metrics/types/{MetricStartTimestamp.d.mts → Start.d.mts} +2 -2
- package/dist/esm/serialization/resources/metrics/types/Start.mjs +3 -0
- package/dist/esm/serialization/resources/metrics/types/index.d.mts +7 -5
- package/dist/esm/serialization/resources/metrics/types/index.mjs +7 -5
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms-full.txt +16825 -11774
- package/dist/llms.txt +94 -25
- package/package.json +1 -1
- package/reference.md +634 -129
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/ListInboxMetricsRequest.d.ts +0 -13
- package/dist/cjs/api/resources/metrics/client/requests/ListMetricsRequest.d.ts +0 -13
- package/dist/cjs/api/resources/metrics/types/ListMetricsResponse.d.ts +0 -5
- package/dist/cjs/api/resources/metrics/types/MessageMetrics.d.ts +0 -17
- package/dist/cjs/api/resources/metrics/types/MetricEndTimestamp.d.ts +0 -4
- package/dist/cjs/api/resources/metrics/types/MetricStartTimestamp.d.ts +0 -4
- package/dist/cjs/api/resources/metrics/types/MetricTimestamp.d.ts +0 -4
- package/dist/cjs/serialization/resources/metrics/types/ListMetricsResponse.d.ts +0 -10
- package/dist/cjs/serialization/resources/metrics/types/MessageMetrics.d.ts +0 -16
- package/dist/cjs/serialization/resources/metrics/types/MessageMetrics.js +0 -48
- package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/ListInboxMetricsRequest.d.mts +0 -13
- package/dist/esm/api/resources/metrics/client/requests/ListMetricsRequest.d.mts +0 -13
- package/dist/esm/api/resources/metrics/types/ListMetricsResponse.d.mts +0 -5
- package/dist/esm/api/resources/metrics/types/MessageMetrics.d.mts +0 -17
- package/dist/esm/api/resources/metrics/types/MetricEndTimestamp.d.mts +0 -4
- package/dist/esm/api/resources/metrics/types/MetricStartTimestamp.d.mts +0 -4
- package/dist/esm/api/resources/metrics/types/MetricTimestamp.d.mts +0 -4
- package/dist/esm/serialization/resources/metrics/types/ListMetricsResponse.d.mts +0 -10
- package/dist/esm/serialization/resources/metrics/types/ListMetricsResponse.mjs +0 -6
- package/dist/esm/serialization/resources/metrics/types/MessageMetrics.d.mts +0 -16
- package/dist/esm/serialization/resources/metrics/types/MessageMetrics.mjs +0 -12
- /package/dist/cjs/api/resources/{inboxes/resources/metrics/client/requests/ListInboxMetricsRequest.js → domains/types/UpdateDomainRequest.js} +0 -0
- /package/dist/cjs/api/resources/{metrics/client/requests/ListMetricsRequest.js → inboxes/resources/metrics/client/requests/QueryMetricsRequest.js} +0 -0
- /package/dist/cjs/api/resources/{metrics/types/ListMetricsResponse.js → messages/types/RawMessageResponse.js} +0 -0
- /package/dist/cjs/api/resources/metrics/{types/MessageMetrics.js → client/requests/QueryMetricsRequest.js} +0 -0
- /package/dist/cjs/api/resources/metrics/types/{MetricEndTimestamp.js → Descending.js} +0 -0
- /package/dist/cjs/api/resources/metrics/types/{MetricStartTimestamp.js → End.js} +0 -0
- /package/dist/cjs/api/resources/metrics/types/{MetricTimestamp.js → MetricBucket.js} +0 -0
- /package/dist/esm/api/resources/{inboxes/resources/metrics/client/requests/ListInboxMetricsRequest.mjs → domains/types/UpdateDomainRequest.mjs} +0 -0
- /package/dist/esm/api/resources/{metrics/client/requests/ListMetricsRequest.mjs → inboxes/resources/metrics/client/requests/QueryMetricsRequest.mjs} +0 -0
- /package/dist/esm/api/resources/{metrics/types/ListMetricsResponse.mjs → messages/types/RawMessageResponse.mjs} +0 -0
- /package/dist/esm/api/resources/metrics/{types/MessageMetrics.mjs → client/requests/QueryMetricsRequest.mjs} +0 -0
- /package/dist/esm/api/resources/metrics/types/{MetricEndTimestamp.mjs → Descending.mjs} +0 -0
- /package/dist/esm/api/resources/metrics/types/{MetricStartTimestamp.mjs → End.mjs} +0 -0
- /package/dist/esm/api/resources/metrics/types/{MetricTimestamp.mjs → MetricBucket.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -551,7 +551,7 @@ await client.webhooks.get("webhook_id");
|
|
|
551
551
|
</dl>
|
|
552
552
|
</details>
|
|
553
553
|
|
|
554
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">
|
|
554
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">create</a>({ ...params }) -> AgentMail.Webhook</code></summary>
|
|
555
555
|
<dl>
|
|
556
556
|
<dd>
|
|
557
557
|
|
|
@@ -564,7 +564,10 @@ await client.webhooks.get("webhook_id");
|
|
|
564
564
|
<dd>
|
|
565
565
|
|
|
566
566
|
```typescript
|
|
567
|
-
await client.webhooks.
|
|
567
|
+
await client.webhooks.create({
|
|
568
|
+
url: "url",
|
|
569
|
+
eventTypes: ["message.received", "message.received"]
|
|
570
|
+
});
|
|
568
571
|
|
|
569
572
|
```
|
|
570
573
|
</dd>
|
|
@@ -580,15 +583,7 @@ await client.webhooks.update("webhook_id", {});
|
|
|
580
583
|
<dl>
|
|
581
584
|
<dd>
|
|
582
585
|
|
|
583
|
-
**
|
|
584
|
-
|
|
585
|
-
</dd>
|
|
586
|
-
</dl>
|
|
587
|
-
|
|
588
|
-
<dl>
|
|
589
|
-
<dd>
|
|
590
|
-
|
|
591
|
-
**request:** `AgentMail.UpdateWebhookRequest`
|
|
586
|
+
**request:** `AgentMail.CreateWebhookRequest`
|
|
592
587
|
|
|
593
588
|
</dd>
|
|
594
589
|
</dl>
|
|
@@ -608,7 +603,7 @@ await client.webhooks.update("webhook_id", {});
|
|
|
608
603
|
</dl>
|
|
609
604
|
</details>
|
|
610
605
|
|
|
611
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">
|
|
606
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">update</a>(webhook_id, { ...params }) -> AgentMail.Webhook</code></summary>
|
|
612
607
|
<dl>
|
|
613
608
|
<dd>
|
|
614
609
|
|
|
@@ -621,10 +616,7 @@ await client.webhooks.update("webhook_id", {});
|
|
|
621
616
|
<dd>
|
|
622
617
|
|
|
623
618
|
```typescript
|
|
624
|
-
await client.webhooks.
|
|
625
|
-
url: "url",
|
|
626
|
-
eventTypes: ["message.received", "message.received"]
|
|
627
|
-
});
|
|
619
|
+
await client.webhooks.update("webhook_id", {});
|
|
628
620
|
|
|
629
621
|
```
|
|
630
622
|
</dd>
|
|
@@ -640,7 +632,15 @@ await client.webhooks.create({
|
|
|
640
632
|
<dl>
|
|
641
633
|
<dd>
|
|
642
634
|
|
|
643
|
-
**
|
|
635
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
636
|
+
|
|
637
|
+
</dd>
|
|
638
|
+
</dl>
|
|
639
|
+
|
|
640
|
+
<dl>
|
|
641
|
+
<dd>
|
|
642
|
+
|
|
643
|
+
**request:** `AgentMail.UpdateWebhookRequest`
|
|
644
644
|
|
|
645
645
|
</dd>
|
|
646
646
|
</dl>
|
|
@@ -1055,6 +1055,63 @@ await client.domains.create({
|
|
|
1055
1055
|
</dl>
|
|
1056
1056
|
|
|
1057
1057
|
|
|
1058
|
+
</dd>
|
|
1059
|
+
</dl>
|
|
1060
|
+
</details>
|
|
1061
|
+
|
|
1062
|
+
<details><summary><code>client.domains.<a href="/src/api/resources/domains/client/Client.ts">update</a>(domain_id, { ...params }) -> AgentMail.Domain</code></summary>
|
|
1063
|
+
<dl>
|
|
1064
|
+
<dd>
|
|
1065
|
+
|
|
1066
|
+
#### 🔌 Usage
|
|
1067
|
+
|
|
1068
|
+
<dl>
|
|
1069
|
+
<dd>
|
|
1070
|
+
|
|
1071
|
+
<dl>
|
|
1072
|
+
<dd>
|
|
1073
|
+
|
|
1074
|
+
```typescript
|
|
1075
|
+
await client.domains.update("domain_id", {});
|
|
1076
|
+
|
|
1077
|
+
```
|
|
1078
|
+
</dd>
|
|
1079
|
+
</dl>
|
|
1080
|
+
</dd>
|
|
1081
|
+
</dl>
|
|
1082
|
+
|
|
1083
|
+
#### ⚙️ Parameters
|
|
1084
|
+
|
|
1085
|
+
<dl>
|
|
1086
|
+
<dd>
|
|
1087
|
+
|
|
1088
|
+
<dl>
|
|
1089
|
+
<dd>
|
|
1090
|
+
|
|
1091
|
+
**domain_id:** `AgentMail.DomainId`
|
|
1092
|
+
|
|
1093
|
+
</dd>
|
|
1094
|
+
</dl>
|
|
1095
|
+
|
|
1096
|
+
<dl>
|
|
1097
|
+
<dd>
|
|
1098
|
+
|
|
1099
|
+
**request:** `AgentMail.UpdateDomainRequest`
|
|
1100
|
+
|
|
1101
|
+
</dd>
|
|
1102
|
+
</dl>
|
|
1103
|
+
|
|
1104
|
+
<dl>
|
|
1105
|
+
<dd>
|
|
1106
|
+
|
|
1107
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
1108
|
+
|
|
1109
|
+
</dd>
|
|
1110
|
+
</dl>
|
|
1111
|
+
</dd>
|
|
1112
|
+
</dl>
|
|
1113
|
+
|
|
1114
|
+
|
|
1058
1115
|
</dd>
|
|
1059
1116
|
</dl>
|
|
1060
1117
|
</details>
|
|
@@ -1615,7 +1672,7 @@ await client.inboxes.drafts.update("inbox_id", "draft_id", {});
|
|
|
1615
1672
|
</dl>
|
|
1616
1673
|
</details>
|
|
1617
1674
|
|
|
1618
|
-
<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">
|
|
1675
|
+
<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">delete</a>(inbox_id, draft_id) -> void</code></summary>
|
|
1619
1676
|
<dl>
|
|
1620
1677
|
<dd>
|
|
1621
1678
|
|
|
@@ -1628,7 +1685,7 @@ await client.inboxes.drafts.update("inbox_id", "draft_id", {});
|
|
|
1628
1685
|
<dd>
|
|
1629
1686
|
|
|
1630
1687
|
```typescript
|
|
1631
|
-
await client.inboxes.drafts.
|
|
1688
|
+
await client.inboxes.drafts.delete("inbox_id", "draft_id");
|
|
1632
1689
|
|
|
1633
1690
|
```
|
|
1634
1691
|
</dd>
|
|
@@ -1660,14 +1717,6 @@ await client.inboxes.drafts.send("inbox_id", "draft_id", {});
|
|
|
1660
1717
|
<dl>
|
|
1661
1718
|
<dd>
|
|
1662
1719
|
|
|
1663
|
-
**request:** `AgentMail.UpdateMessageRequest`
|
|
1664
|
-
|
|
1665
|
-
</dd>
|
|
1666
|
-
</dl>
|
|
1667
|
-
|
|
1668
|
-
<dl>
|
|
1669
|
-
<dd>
|
|
1670
|
-
|
|
1671
1720
|
**requestOptions:** `DraftsClient.RequestOptions`
|
|
1672
1721
|
|
|
1673
1722
|
</dd>
|
|
@@ -1680,7 +1729,7 @@ await client.inboxes.drafts.send("inbox_id", "draft_id", {});
|
|
|
1680
1729
|
</dl>
|
|
1681
1730
|
</details>
|
|
1682
1731
|
|
|
1683
|
-
<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">
|
|
1732
|
+
<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">send</a>(inbox_id, draft_id, { ...params }) -> AgentMail.SendMessageResponse</code></summary>
|
|
1684
1733
|
<dl>
|
|
1685
1734
|
<dd>
|
|
1686
1735
|
|
|
@@ -1693,7 +1742,7 @@ await client.inboxes.drafts.send("inbox_id", "draft_id", {});
|
|
|
1693
1742
|
<dd>
|
|
1694
1743
|
|
|
1695
1744
|
```typescript
|
|
1696
|
-
await client.inboxes.drafts.
|
|
1745
|
+
await client.inboxes.drafts.send("inbox_id", "draft_id", {});
|
|
1697
1746
|
|
|
1698
1747
|
```
|
|
1699
1748
|
</dd>
|
|
@@ -1725,6 +1774,14 @@ await client.inboxes.drafts.delete("inbox_id", "draft_id");
|
|
|
1725
1774
|
<dl>
|
|
1726
1775
|
<dd>
|
|
1727
1776
|
|
|
1777
|
+
**request:** `AgentMail.UpdateMessageRequest`
|
|
1778
|
+
|
|
1779
|
+
</dd>
|
|
1780
|
+
</dl>
|
|
1781
|
+
|
|
1782
|
+
<dl>
|
|
1783
|
+
<dd>
|
|
1784
|
+
|
|
1728
1785
|
**requestOptions:** `DraftsClient.RequestOptions`
|
|
1729
1786
|
|
|
1730
1787
|
</dd>
|
|
@@ -1917,7 +1974,7 @@ await client.inboxes.messages.getAttachment("inbox_id", "message_id", "attachmen
|
|
|
1917
1974
|
</dl>
|
|
1918
1975
|
</details>
|
|
1919
1976
|
|
|
1920
|
-
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">getRaw</a>(inbox_id, message_id) ->
|
|
1977
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">getRaw</a>(inbox_id, message_id) -> AgentMail.RawMessageResponse</code></summary>
|
|
1921
1978
|
<dl>
|
|
1922
1979
|
<dd>
|
|
1923
1980
|
|
|
@@ -1974,7 +2031,7 @@ await client.inboxes.messages.getRaw("inbox_id", "message_id");
|
|
|
1974
2031
|
</dl>
|
|
1975
2032
|
</details>
|
|
1976
2033
|
|
|
1977
|
-
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">
|
|
2034
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">update</a>(inbox_id, message_id, { ...params }) -> AgentMail.Message</code></summary>
|
|
1978
2035
|
<dl>
|
|
1979
2036
|
<dd>
|
|
1980
2037
|
|
|
@@ -1987,7 +2044,7 @@ await client.inboxes.messages.getRaw("inbox_id", "message_id");
|
|
|
1987
2044
|
<dd>
|
|
1988
2045
|
|
|
1989
2046
|
```typescript
|
|
1990
|
-
await client.inboxes.messages.
|
|
2047
|
+
await client.inboxes.messages.update("inbox_id", "message_id", {});
|
|
1991
2048
|
|
|
1992
2049
|
```
|
|
1993
2050
|
</dd>
|
|
@@ -2011,7 +2068,15 @@ await client.inboxes.messages.send("inbox_id", {});
|
|
|
2011
2068
|
<dl>
|
|
2012
2069
|
<dd>
|
|
2013
2070
|
|
|
2014
|
-
**
|
|
2071
|
+
**message_id:** `AgentMail.MessageId`
|
|
2072
|
+
|
|
2073
|
+
</dd>
|
|
2074
|
+
</dl>
|
|
2075
|
+
|
|
2076
|
+
<dl>
|
|
2077
|
+
<dd>
|
|
2078
|
+
|
|
2079
|
+
**request:** `AgentMail.UpdateMessageRequest`
|
|
2015
2080
|
|
|
2016
2081
|
</dd>
|
|
2017
2082
|
</dl>
|
|
@@ -2031,7 +2096,7 @@ await client.inboxes.messages.send("inbox_id", {});
|
|
|
2031
2096
|
</dl>
|
|
2032
2097
|
</details>
|
|
2033
2098
|
|
|
2034
|
-
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">
|
|
2099
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">send</a>(inbox_id, { ...params }) -> AgentMail.SendMessageResponse</code></summary>
|
|
2035
2100
|
<dl>
|
|
2036
2101
|
<dd>
|
|
2037
2102
|
|
|
@@ -2044,7 +2109,7 @@ await client.inboxes.messages.send("inbox_id", {});
|
|
|
2044
2109
|
<dd>
|
|
2045
2110
|
|
|
2046
2111
|
```typescript
|
|
2047
|
-
await client.inboxes.messages.
|
|
2112
|
+
await client.inboxes.messages.send("inbox_id", {});
|
|
2048
2113
|
|
|
2049
2114
|
```
|
|
2050
2115
|
</dd>
|
|
@@ -2068,15 +2133,7 @@ await client.inboxes.messages.reply("inbox_id", "message_id", {});
|
|
|
2068
2133
|
<dl>
|
|
2069
2134
|
<dd>
|
|
2070
2135
|
|
|
2071
|
-
**
|
|
2072
|
-
|
|
2073
|
-
</dd>
|
|
2074
|
-
</dl>
|
|
2075
|
-
|
|
2076
|
-
<dl>
|
|
2077
|
-
<dd>
|
|
2078
|
-
|
|
2079
|
-
**request:** `AgentMail.ReplyToMessageRequest`
|
|
2136
|
+
**request:** `AgentMail.SendMessageRequest`
|
|
2080
2137
|
|
|
2081
2138
|
</dd>
|
|
2082
2139
|
</dl>
|
|
@@ -2096,7 +2153,7 @@ await client.inboxes.messages.reply("inbox_id", "message_id", {});
|
|
|
2096
2153
|
</dl>
|
|
2097
2154
|
</details>
|
|
2098
2155
|
|
|
2099
|
-
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">
|
|
2156
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">reply</a>(inbox_id, message_id, { ...params }) -> AgentMail.SendMessageResponse</code></summary>
|
|
2100
2157
|
<dl>
|
|
2101
2158
|
<dd>
|
|
2102
2159
|
|
|
@@ -2109,7 +2166,7 @@ await client.inboxes.messages.reply("inbox_id", "message_id", {});
|
|
|
2109
2166
|
<dd>
|
|
2110
2167
|
|
|
2111
2168
|
```typescript
|
|
2112
|
-
await client.inboxes.messages.
|
|
2169
|
+
await client.inboxes.messages.reply("inbox_id", "message_id", {});
|
|
2113
2170
|
|
|
2114
2171
|
```
|
|
2115
2172
|
</dd>
|
|
@@ -2141,7 +2198,7 @@ await client.inboxes.messages.replyAll("inbox_id", "message_id", {});
|
|
|
2141
2198
|
<dl>
|
|
2142
2199
|
<dd>
|
|
2143
2200
|
|
|
2144
|
-
**request:** `AgentMail.
|
|
2201
|
+
**request:** `AgentMail.ReplyToMessageRequest`
|
|
2145
2202
|
|
|
2146
2203
|
</dd>
|
|
2147
2204
|
</dl>
|
|
@@ -2161,7 +2218,7 @@ await client.inboxes.messages.replyAll("inbox_id", "message_id", {});
|
|
|
2161
2218
|
</dl>
|
|
2162
2219
|
</details>
|
|
2163
2220
|
|
|
2164
|
-
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">
|
|
2221
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">replyAll</a>(inbox_id, message_id, { ...params }) -> AgentMail.SendMessageResponse</code></summary>
|
|
2165
2222
|
<dl>
|
|
2166
2223
|
<dd>
|
|
2167
2224
|
|
|
@@ -2174,7 +2231,7 @@ await client.inboxes.messages.replyAll("inbox_id", "message_id", {});
|
|
|
2174
2231
|
<dd>
|
|
2175
2232
|
|
|
2176
2233
|
```typescript
|
|
2177
|
-
await client.inboxes.messages.
|
|
2234
|
+
await client.inboxes.messages.replyAll("inbox_id", "message_id", {});
|
|
2178
2235
|
|
|
2179
2236
|
```
|
|
2180
2237
|
</dd>
|
|
@@ -2206,7 +2263,7 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
|
|
|
2206
2263
|
<dl>
|
|
2207
2264
|
<dd>
|
|
2208
2265
|
|
|
2209
|
-
**request:** `AgentMail.
|
|
2266
|
+
**request:** `AgentMail.ReplyAllMessageRequest`
|
|
2210
2267
|
|
|
2211
2268
|
</dd>
|
|
2212
2269
|
</dl>
|
|
@@ -2226,7 +2283,7 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
|
|
|
2226
2283
|
</dl>
|
|
2227
2284
|
</details>
|
|
2228
2285
|
|
|
2229
|
-
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">
|
|
2286
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">forward</a>(inbox_id, message_id, { ...params }) -> AgentMail.SendMessageResponse</code></summary>
|
|
2230
2287
|
<dl>
|
|
2231
2288
|
<dd>
|
|
2232
2289
|
|
|
@@ -2239,7 +2296,7 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
|
|
|
2239
2296
|
<dd>
|
|
2240
2297
|
|
|
2241
2298
|
```typescript
|
|
2242
|
-
await client.inboxes.messages.
|
|
2299
|
+
await client.inboxes.messages.forward("inbox_id", "message_id", {});
|
|
2243
2300
|
|
|
2244
2301
|
```
|
|
2245
2302
|
</dd>
|
|
@@ -2271,7 +2328,7 @@ await client.inboxes.messages.update("inbox_id", "message_id", {});
|
|
|
2271
2328
|
<dl>
|
|
2272
2329
|
<dd>
|
|
2273
2330
|
|
|
2274
|
-
**request:** `AgentMail.
|
|
2331
|
+
**request:** `AgentMail.SendMessageRequest`
|
|
2275
2332
|
|
|
2276
2333
|
</dd>
|
|
2277
2334
|
</dl>
|
|
@@ -2292,7 +2349,7 @@ await client.inboxes.messages.update("inbox_id", "message_id", {});
|
|
|
2292
2349
|
</details>
|
|
2293
2350
|
|
|
2294
2351
|
## Inboxes Metrics
|
|
2295
|
-
<details><summary><code>client.inboxes.metrics.<a href="/src/api/resources/inboxes/resources/metrics/client/Client.ts">
|
|
2352
|
+
<details><summary><code>client.inboxes.metrics.<a href="/src/api/resources/inboxes/resources/metrics/client/Client.ts">query</a>(inbox_id, { ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
2296
2353
|
<dl>
|
|
2297
2354
|
<dd>
|
|
2298
2355
|
|
|
@@ -2305,10 +2362,7 @@ await client.inboxes.messages.update("inbox_id", "message_id", {});
|
|
|
2305
2362
|
<dd>
|
|
2306
2363
|
|
|
2307
2364
|
```typescript
|
|
2308
|
-
await client.inboxes.metrics.
|
|
2309
|
-
startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
|
|
2310
|
-
endTimestamp: new Date("2024-01-15T09:30:00.000Z")
|
|
2311
|
-
});
|
|
2365
|
+
await client.inboxes.metrics.query("inbox_id");
|
|
2312
2366
|
|
|
2313
2367
|
```
|
|
2314
2368
|
</dd>
|
|
@@ -2332,7 +2386,7 @@ await client.inboxes.metrics.get("inbox_id", {
|
|
|
2332
2386
|
<dl>
|
|
2333
2387
|
<dd>
|
|
2334
2388
|
|
|
2335
|
-
**request:** `AgentMail.inboxes.
|
|
2389
|
+
**request:** `AgentMail.inboxes.QueryMetricsRequest`
|
|
2336
2390
|
|
|
2337
2391
|
</dd>
|
|
2338
2392
|
</dl>
|
|
@@ -2612,7 +2666,7 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
|
2612
2666
|
</details>
|
|
2613
2667
|
|
|
2614
2668
|
## Lists
|
|
2615
|
-
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">
|
|
2669
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">list</a>(direction, type, { ...params }) -> AgentMail.ListListEntriesResponse</code></summary>
|
|
2616
2670
|
<dl>
|
|
2617
2671
|
<dd>
|
|
2618
2672
|
|
|
@@ -2625,9 +2679,7 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
|
2625
2679
|
<dd>
|
|
2626
2680
|
|
|
2627
2681
|
```typescript
|
|
2628
|
-
await client.lists.
|
|
2629
|
-
entry: "entry"
|
|
2630
|
-
});
|
|
2682
|
+
await client.lists.list("send", "allow");
|
|
2631
2683
|
|
|
2632
2684
|
```
|
|
2633
2685
|
</dd>
|
|
@@ -2659,7 +2711,7 @@ await client.lists.create("send", "allow", {
|
|
|
2659
2711
|
<dl>
|
|
2660
2712
|
<dd>
|
|
2661
2713
|
|
|
2662
|
-
**request:** `AgentMail.
|
|
2714
|
+
**request:** `AgentMail.ListListEntriesRequest`
|
|
2663
2715
|
|
|
2664
2716
|
</dd>
|
|
2665
2717
|
</dl>
|
|
@@ -2679,7 +2731,7 @@ await client.lists.create("send", "allow", {
|
|
|
2679
2731
|
</dl>
|
|
2680
2732
|
</details>
|
|
2681
2733
|
|
|
2682
|
-
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">
|
|
2734
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">get</a>(direction, type, entry) -> AgentMail.ListEntry</code></summary>
|
|
2683
2735
|
<dl>
|
|
2684
2736
|
<dd>
|
|
2685
2737
|
|
|
@@ -2692,7 +2744,7 @@ await client.lists.create("send", "allow", {
|
|
|
2692
2744
|
<dd>
|
|
2693
2745
|
|
|
2694
2746
|
```typescript
|
|
2695
|
-
await client.lists.
|
|
2747
|
+
await client.lists.get("send", "allow", "entry");
|
|
2696
2748
|
|
|
2697
2749
|
```
|
|
2698
2750
|
</dd>
|
|
@@ -2724,7 +2776,7 @@ await client.lists.list("send", "allow");
|
|
|
2724
2776
|
<dl>
|
|
2725
2777
|
<dd>
|
|
2726
2778
|
|
|
2727
|
-
**
|
|
2779
|
+
**entry:** `string` — Email address or domain.
|
|
2728
2780
|
|
|
2729
2781
|
</dd>
|
|
2730
2782
|
</dl>
|
|
@@ -2744,7 +2796,7 @@ await client.lists.list("send", "allow");
|
|
|
2744
2796
|
</dl>
|
|
2745
2797
|
</details>
|
|
2746
2798
|
|
|
2747
|
-
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">
|
|
2799
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">create</a>(direction, type, { ...params }) -> AgentMail.ListEntry</code></summary>
|
|
2748
2800
|
<dl>
|
|
2749
2801
|
<dd>
|
|
2750
2802
|
|
|
@@ -2757,7 +2809,9 @@ await client.lists.list("send", "allow");
|
|
|
2757
2809
|
<dd>
|
|
2758
2810
|
|
|
2759
2811
|
```typescript
|
|
2760
|
-
await client.lists.
|
|
2812
|
+
await client.lists.create("send", "allow", {
|
|
2813
|
+
entry: "entry"
|
|
2814
|
+
});
|
|
2761
2815
|
|
|
2762
2816
|
```
|
|
2763
2817
|
</dd>
|
|
@@ -2789,7 +2843,7 @@ await client.lists.get("send", "allow", "entry");
|
|
|
2789
2843
|
<dl>
|
|
2790
2844
|
<dd>
|
|
2791
2845
|
|
|
2792
|
-
**
|
|
2846
|
+
**request:** `AgentMail.CreateListEntryRequest`
|
|
2793
2847
|
|
|
2794
2848
|
</dd>
|
|
2795
2849
|
</dl>
|
|
@@ -2875,7 +2929,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
2875
2929
|
</details>
|
|
2876
2930
|
|
|
2877
2931
|
## Metrics
|
|
2878
|
-
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">
|
|
2932
|
+
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">query</a>({ ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
2879
2933
|
<dl>
|
|
2880
2934
|
<dd>
|
|
2881
2935
|
|
|
@@ -2888,10 +2942,7 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
2888
2942
|
<dd>
|
|
2889
2943
|
|
|
2890
2944
|
```typescript
|
|
2891
|
-
await client.metrics.
|
|
2892
|
-
startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
|
|
2893
|
-
endTimestamp: new Date("2024-01-15T09:30:00.000Z")
|
|
2894
|
-
});
|
|
2945
|
+
await client.metrics.query();
|
|
2895
2946
|
|
|
2896
2947
|
```
|
|
2897
2948
|
</dd>
|
|
@@ -2907,7 +2958,7 @@ await client.metrics.list({
|
|
|
2907
2958
|
<dl>
|
|
2908
2959
|
<dd>
|
|
2909
2960
|
|
|
2910
|
-
**request:** `AgentMail.
|
|
2961
|
+
**request:** `AgentMail.QueryMetricsRequest`
|
|
2911
2962
|
|
|
2912
2963
|
</dd>
|
|
2913
2964
|
</dl>
|
|
@@ -2984,7 +3035,7 @@ await client.organizations.get();
|
|
|
2984
3035
|
</details>
|
|
2985
3036
|
|
|
2986
3037
|
## Pods ApiKeys
|
|
2987
|
-
<details><summary><code>client.pods.apiKeys.<a href="/src/api/resources/pods/resources/apiKeys/client/Client.ts">
|
|
3038
|
+
<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>
|
|
2988
3039
|
<dl>
|
|
2989
3040
|
<dd>
|
|
2990
3041
|
|
|
@@ -2997,9 +3048,7 @@ await client.organizations.get();
|
|
|
2997
3048
|
<dd>
|
|
2998
3049
|
|
|
2999
3050
|
```typescript
|
|
3000
|
-
await client.pods.apiKeys.
|
|
3001
|
-
name: "name"
|
|
3002
|
-
});
|
|
3051
|
+
await client.pods.apiKeys.list("pod_id");
|
|
3003
3052
|
|
|
3004
3053
|
```
|
|
3005
3054
|
</dd>
|
|
@@ -3023,7 +3072,7 @@ await client.pods.apiKeys.create("pod_id", {
|
|
|
3023
3072
|
<dl>
|
|
3024
3073
|
<dd>
|
|
3025
3074
|
|
|
3026
|
-
**request:** `AgentMail.
|
|
3075
|
+
**request:** `AgentMail.pods.ListApiKeysRequest`
|
|
3027
3076
|
|
|
3028
3077
|
</dd>
|
|
3029
3078
|
</dl>
|
|
@@ -3043,7 +3092,7 @@ await client.pods.apiKeys.create("pod_id", {
|
|
|
3043
3092
|
</dl>
|
|
3044
3093
|
</details>
|
|
3045
3094
|
|
|
3046
|
-
<details><summary><code>client.pods.apiKeys.<a href="/src/api/resources/pods/resources/apiKeys/client/Client.ts">
|
|
3095
|
+
<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>
|
|
3047
3096
|
<dl>
|
|
3048
3097
|
<dd>
|
|
3049
3098
|
|
|
@@ -3056,7 +3105,9 @@ await client.pods.apiKeys.create("pod_id", {
|
|
|
3056
3105
|
<dd>
|
|
3057
3106
|
|
|
3058
3107
|
```typescript
|
|
3059
|
-
await client.pods.apiKeys.
|
|
3108
|
+
await client.pods.apiKeys.create("pod_id", {
|
|
3109
|
+
name: "name"
|
|
3110
|
+
});
|
|
3060
3111
|
|
|
3061
3112
|
```
|
|
3062
3113
|
</dd>
|
|
@@ -3080,7 +3131,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
3080
3131
|
<dl>
|
|
3081
3132
|
<dd>
|
|
3082
3133
|
|
|
3083
|
-
**request:** `AgentMail.
|
|
3134
|
+
**request:** `AgentMail.CreateApiKeyRequest`
|
|
3084
3135
|
|
|
3085
3136
|
</dd>
|
|
3086
3137
|
</dl>
|
|
@@ -3215,7 +3266,7 @@ await client.pods.domains.list("pod_id");
|
|
|
3215
3266
|
</dl>
|
|
3216
3267
|
</details>
|
|
3217
3268
|
|
|
3218
|
-
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">
|
|
3269
|
+
<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>
|
|
3219
3270
|
<dl>
|
|
3220
3271
|
<dd>
|
|
3221
3272
|
|
|
@@ -3228,10 +3279,7 @@ await client.pods.domains.list("pod_id");
|
|
|
3228
3279
|
<dd>
|
|
3229
3280
|
|
|
3230
3281
|
```typescript
|
|
3231
|
-
await client.pods.domains.
|
|
3232
|
-
domain: "domain",
|
|
3233
|
-
feedbackEnabled: true
|
|
3234
|
-
});
|
|
3282
|
+
await client.pods.domains.get("pod_id", "domain_id");
|
|
3235
3283
|
|
|
3236
3284
|
```
|
|
3237
3285
|
</dd>
|
|
@@ -3255,7 +3303,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
3255
3303
|
<dl>
|
|
3256
3304
|
<dd>
|
|
3257
3305
|
|
|
3258
|
-
**
|
|
3306
|
+
**domain_id:** `AgentMail.DomainId`
|
|
3259
3307
|
|
|
3260
3308
|
</dd>
|
|
3261
3309
|
</dl>
|
|
@@ -3275,7 +3323,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
3275
3323
|
</dl>
|
|
3276
3324
|
</details>
|
|
3277
3325
|
|
|
3278
|
-
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">
|
|
3326
|
+
<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>
|
|
3279
3327
|
<dl>
|
|
3280
3328
|
<dd>
|
|
3281
3329
|
|
|
@@ -3288,7 +3336,7 @@ await client.pods.domains.create("pod_id", {
|
|
|
3288
3336
|
<dd>
|
|
3289
3337
|
|
|
3290
3338
|
```typescript
|
|
3291
|
-
await client.pods.domains.
|
|
3339
|
+
await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
3292
3340
|
|
|
3293
3341
|
```
|
|
3294
3342
|
</dd>
|
|
@@ -3332,7 +3380,7 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
3332
3380
|
</dl>
|
|
3333
3381
|
</details>
|
|
3334
3382
|
|
|
3335
|
-
<details><summary><code>client.pods.domains.<a href="/src/api/resources/pods/resources/domains/client/Client.ts">
|
|
3383
|
+
<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>
|
|
3336
3384
|
<dl>
|
|
3337
3385
|
<dd>
|
|
3338
3386
|
|
|
@@ -3345,7 +3393,10 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
3345
3393
|
<dd>
|
|
3346
3394
|
|
|
3347
3395
|
```typescript
|
|
3348
|
-
await client.pods.domains.
|
|
3396
|
+
await client.pods.domains.create("pod_id", {
|
|
3397
|
+
domain: "domain",
|
|
3398
|
+
feedbackEnabled: true
|
|
3399
|
+
});
|
|
3349
3400
|
|
|
3350
3401
|
```
|
|
3351
3402
|
</dd>
|
|
@@ -3369,7 +3420,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
3369
3420
|
<dl>
|
|
3370
3421
|
<dd>
|
|
3371
3422
|
|
|
3372
|
-
**
|
|
3423
|
+
**request:** `AgentMail.CreateDomainRequest`
|
|
3373
3424
|
|
|
3374
3425
|
</dd>
|
|
3375
3426
|
</dl>
|
|
@@ -3389,8 +3440,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
3389
3440
|
</dl>
|
|
3390
3441
|
</details>
|
|
3391
3442
|
|
|
3392
|
-
|
|
3393
|
-
<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>
|
|
3443
|
+
<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>
|
|
3394
3444
|
<dl>
|
|
3395
3445
|
<dd>
|
|
3396
3446
|
|
|
@@ -3403,7 +3453,7 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
3403
3453
|
<dd>
|
|
3404
3454
|
|
|
3405
3455
|
```typescript
|
|
3406
|
-
await client.pods.
|
|
3456
|
+
await client.pods.domains.update("pod_id", "domain_id", {});
|
|
3407
3457
|
|
|
3408
3458
|
```
|
|
3409
3459
|
</dd>
|
|
@@ -3427,7 +3477,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
3427
3477
|
<dl>
|
|
3428
3478
|
<dd>
|
|
3429
3479
|
|
|
3430
|
-
**
|
|
3480
|
+
**domain_id:** `AgentMail.DomainId`
|
|
3431
3481
|
|
|
3432
3482
|
</dd>
|
|
3433
3483
|
</dl>
|
|
@@ -3435,7 +3485,15 @@ await client.pods.drafts.list("pod_id");
|
|
|
3435
3485
|
<dl>
|
|
3436
3486
|
<dd>
|
|
3437
3487
|
|
|
3438
|
-
**
|
|
3488
|
+
**request:** `AgentMail.UpdateDomainRequest`
|
|
3489
|
+
|
|
3490
|
+
</dd>
|
|
3491
|
+
</dl>
|
|
3492
|
+
|
|
3493
|
+
<dl>
|
|
3494
|
+
<dd>
|
|
3495
|
+
|
|
3496
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
3439
3497
|
|
|
3440
3498
|
</dd>
|
|
3441
3499
|
</dl>
|
|
@@ -3447,7 +3505,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
3447
3505
|
</dl>
|
|
3448
3506
|
</details>
|
|
3449
3507
|
|
|
3450
|
-
<details><summary><code>client.pods.
|
|
3508
|
+
<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>
|
|
3451
3509
|
<dl>
|
|
3452
3510
|
<dd>
|
|
3453
3511
|
|
|
@@ -3460,7 +3518,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
3460
3518
|
<dd>
|
|
3461
3519
|
|
|
3462
3520
|
```typescript
|
|
3463
|
-
await client.pods.
|
|
3521
|
+
await client.pods.domains.delete("pod_id", "domain_id");
|
|
3464
3522
|
|
|
3465
3523
|
```
|
|
3466
3524
|
</dd>
|
|
@@ -3484,7 +3542,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
3484
3542
|
<dl>
|
|
3485
3543
|
<dd>
|
|
3486
3544
|
|
|
3487
|
-
**
|
|
3545
|
+
**domain_id:** `AgentMail.DomainId`
|
|
3488
3546
|
|
|
3489
3547
|
</dd>
|
|
3490
3548
|
</dl>
|
|
@@ -3492,7 +3550,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
3492
3550
|
<dl>
|
|
3493
3551
|
<dd>
|
|
3494
3552
|
|
|
3495
|
-
**requestOptions:** `
|
|
3553
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
3496
3554
|
|
|
3497
3555
|
</dd>
|
|
3498
3556
|
</dl>
|
|
@@ -3504,7 +3562,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
3504
3562
|
</dl>
|
|
3505
3563
|
</details>
|
|
3506
3564
|
|
|
3507
|
-
<details><summary><code>client.pods.
|
|
3565
|
+
<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>
|
|
3508
3566
|
<dl>
|
|
3509
3567
|
<dd>
|
|
3510
3568
|
|
|
@@ -3517,7 +3575,7 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
3517
3575
|
<dd>
|
|
3518
3576
|
|
|
3519
3577
|
```typescript
|
|
3520
|
-
await client.pods.
|
|
3578
|
+
await client.pods.domains.verify("pod_id", "domain_id");
|
|
3521
3579
|
|
|
3522
3580
|
```
|
|
3523
3581
|
</dd>
|
|
@@ -3541,15 +3599,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
3541
3599
|
<dl>
|
|
3542
3600
|
<dd>
|
|
3543
3601
|
|
|
3544
|
-
**
|
|
3545
|
-
|
|
3546
|
-
</dd>
|
|
3547
|
-
</dl>
|
|
3548
|
-
|
|
3549
|
-
<dl>
|
|
3550
|
-
<dd>
|
|
3551
|
-
|
|
3552
|
-
**attachment_id:** `AgentMail.AttachmentId`
|
|
3602
|
+
**domain_id:** `AgentMail.DomainId`
|
|
3553
3603
|
|
|
3554
3604
|
</dd>
|
|
3555
3605
|
</dl>
|
|
@@ -3557,7 +3607,7 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
3557
3607
|
<dl>
|
|
3558
3608
|
<dd>
|
|
3559
3609
|
|
|
3560
|
-
**requestOptions:** `
|
|
3610
|
+
**requestOptions:** `DomainsClient.RequestOptions`
|
|
3561
3611
|
|
|
3562
3612
|
</dd>
|
|
3563
3613
|
</dl>
|
|
@@ -3569,8 +3619,188 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
3569
3619
|
</dl>
|
|
3570
3620
|
</details>
|
|
3571
3621
|
|
|
3572
|
-
## Pods
|
|
3573
|
-
<details><summary><code>client.pods.
|
|
3622
|
+
## Pods Drafts
|
|
3623
|
+
<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>
|
|
3624
|
+
<dl>
|
|
3625
|
+
<dd>
|
|
3626
|
+
|
|
3627
|
+
#### 🔌 Usage
|
|
3628
|
+
|
|
3629
|
+
<dl>
|
|
3630
|
+
<dd>
|
|
3631
|
+
|
|
3632
|
+
<dl>
|
|
3633
|
+
<dd>
|
|
3634
|
+
|
|
3635
|
+
```typescript
|
|
3636
|
+
await client.pods.drafts.list("pod_id");
|
|
3637
|
+
|
|
3638
|
+
```
|
|
3639
|
+
</dd>
|
|
3640
|
+
</dl>
|
|
3641
|
+
</dd>
|
|
3642
|
+
</dl>
|
|
3643
|
+
|
|
3644
|
+
#### ⚙️ Parameters
|
|
3645
|
+
|
|
3646
|
+
<dl>
|
|
3647
|
+
<dd>
|
|
3648
|
+
|
|
3649
|
+
<dl>
|
|
3650
|
+
<dd>
|
|
3651
|
+
|
|
3652
|
+
**pod_id:** `AgentMail.PodId`
|
|
3653
|
+
|
|
3654
|
+
</dd>
|
|
3655
|
+
</dl>
|
|
3656
|
+
|
|
3657
|
+
<dl>
|
|
3658
|
+
<dd>
|
|
3659
|
+
|
|
3660
|
+
**request:** `AgentMail.pods.ListDraftsRequest`
|
|
3661
|
+
|
|
3662
|
+
</dd>
|
|
3663
|
+
</dl>
|
|
3664
|
+
|
|
3665
|
+
<dl>
|
|
3666
|
+
<dd>
|
|
3667
|
+
|
|
3668
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
3669
|
+
|
|
3670
|
+
</dd>
|
|
3671
|
+
</dl>
|
|
3672
|
+
</dd>
|
|
3673
|
+
</dl>
|
|
3674
|
+
|
|
3675
|
+
|
|
3676
|
+
</dd>
|
|
3677
|
+
</dl>
|
|
3678
|
+
</details>
|
|
3679
|
+
|
|
3680
|
+
<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>
|
|
3681
|
+
<dl>
|
|
3682
|
+
<dd>
|
|
3683
|
+
|
|
3684
|
+
#### 🔌 Usage
|
|
3685
|
+
|
|
3686
|
+
<dl>
|
|
3687
|
+
<dd>
|
|
3688
|
+
|
|
3689
|
+
<dl>
|
|
3690
|
+
<dd>
|
|
3691
|
+
|
|
3692
|
+
```typescript
|
|
3693
|
+
await client.pods.drafts.get("pod_id", "draft_id");
|
|
3694
|
+
|
|
3695
|
+
```
|
|
3696
|
+
</dd>
|
|
3697
|
+
</dl>
|
|
3698
|
+
</dd>
|
|
3699
|
+
</dl>
|
|
3700
|
+
|
|
3701
|
+
#### ⚙️ Parameters
|
|
3702
|
+
|
|
3703
|
+
<dl>
|
|
3704
|
+
<dd>
|
|
3705
|
+
|
|
3706
|
+
<dl>
|
|
3707
|
+
<dd>
|
|
3708
|
+
|
|
3709
|
+
**pod_id:** `AgentMail.PodId`
|
|
3710
|
+
|
|
3711
|
+
</dd>
|
|
3712
|
+
</dl>
|
|
3713
|
+
|
|
3714
|
+
<dl>
|
|
3715
|
+
<dd>
|
|
3716
|
+
|
|
3717
|
+
**draft_id:** `AgentMail.DraftId`
|
|
3718
|
+
|
|
3719
|
+
</dd>
|
|
3720
|
+
</dl>
|
|
3721
|
+
|
|
3722
|
+
<dl>
|
|
3723
|
+
<dd>
|
|
3724
|
+
|
|
3725
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
3726
|
+
|
|
3727
|
+
</dd>
|
|
3728
|
+
</dl>
|
|
3729
|
+
</dd>
|
|
3730
|
+
</dl>
|
|
3731
|
+
|
|
3732
|
+
|
|
3733
|
+
</dd>
|
|
3734
|
+
</dl>
|
|
3735
|
+
</details>
|
|
3736
|
+
|
|
3737
|
+
<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>
|
|
3738
|
+
<dl>
|
|
3739
|
+
<dd>
|
|
3740
|
+
|
|
3741
|
+
#### 🔌 Usage
|
|
3742
|
+
|
|
3743
|
+
<dl>
|
|
3744
|
+
<dd>
|
|
3745
|
+
|
|
3746
|
+
<dl>
|
|
3747
|
+
<dd>
|
|
3748
|
+
|
|
3749
|
+
```typescript
|
|
3750
|
+
await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
3751
|
+
|
|
3752
|
+
```
|
|
3753
|
+
</dd>
|
|
3754
|
+
</dl>
|
|
3755
|
+
</dd>
|
|
3756
|
+
</dl>
|
|
3757
|
+
|
|
3758
|
+
#### ⚙️ Parameters
|
|
3759
|
+
|
|
3760
|
+
<dl>
|
|
3761
|
+
<dd>
|
|
3762
|
+
|
|
3763
|
+
<dl>
|
|
3764
|
+
<dd>
|
|
3765
|
+
|
|
3766
|
+
**pod_id:** `AgentMail.PodId`
|
|
3767
|
+
|
|
3768
|
+
</dd>
|
|
3769
|
+
</dl>
|
|
3770
|
+
|
|
3771
|
+
<dl>
|
|
3772
|
+
<dd>
|
|
3773
|
+
|
|
3774
|
+
**draft_id:** `AgentMail.DraftId`
|
|
3775
|
+
|
|
3776
|
+
</dd>
|
|
3777
|
+
</dl>
|
|
3778
|
+
|
|
3779
|
+
<dl>
|
|
3780
|
+
<dd>
|
|
3781
|
+
|
|
3782
|
+
**attachment_id:** `AgentMail.AttachmentId`
|
|
3783
|
+
|
|
3784
|
+
</dd>
|
|
3785
|
+
</dl>
|
|
3786
|
+
|
|
3787
|
+
<dl>
|
|
3788
|
+
<dd>
|
|
3789
|
+
|
|
3790
|
+
**requestOptions:** `DraftsClient.RequestOptions`
|
|
3791
|
+
|
|
3792
|
+
</dd>
|
|
3793
|
+
</dl>
|
|
3794
|
+
</dd>
|
|
3795
|
+
</dl>
|
|
3796
|
+
|
|
3797
|
+
|
|
3798
|
+
</dd>
|
|
3799
|
+
</dl>
|
|
3800
|
+
</details>
|
|
3801
|
+
|
|
3802
|
+
## Pods Inboxes
|
|
3803
|
+
<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>
|
|
3574
3804
|
<dl>
|
|
3575
3805
|
<dd>
|
|
3576
3806
|
|
|
@@ -3737,6 +3967,73 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
3737
3967
|
</dl>
|
|
3738
3968
|
|
|
3739
3969
|
|
|
3970
|
+
</dd>
|
|
3971
|
+
</dl>
|
|
3972
|
+
</details>
|
|
3973
|
+
|
|
3974
|
+
<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>
|
|
3975
|
+
<dl>
|
|
3976
|
+
<dd>
|
|
3977
|
+
|
|
3978
|
+
#### 🔌 Usage
|
|
3979
|
+
|
|
3980
|
+
<dl>
|
|
3981
|
+
<dd>
|
|
3982
|
+
|
|
3983
|
+
<dl>
|
|
3984
|
+
<dd>
|
|
3985
|
+
|
|
3986
|
+
```typescript
|
|
3987
|
+
await client.pods.inboxes.update("pod_id", "inbox_id", {
|
|
3988
|
+
displayName: "display_name"
|
|
3989
|
+
});
|
|
3990
|
+
|
|
3991
|
+
```
|
|
3992
|
+
</dd>
|
|
3993
|
+
</dl>
|
|
3994
|
+
</dd>
|
|
3995
|
+
</dl>
|
|
3996
|
+
|
|
3997
|
+
#### ⚙️ Parameters
|
|
3998
|
+
|
|
3999
|
+
<dl>
|
|
4000
|
+
<dd>
|
|
4001
|
+
|
|
4002
|
+
<dl>
|
|
4003
|
+
<dd>
|
|
4004
|
+
|
|
4005
|
+
**pod_id:** `AgentMail.PodId`
|
|
4006
|
+
|
|
4007
|
+
</dd>
|
|
4008
|
+
</dl>
|
|
4009
|
+
|
|
4010
|
+
<dl>
|
|
4011
|
+
<dd>
|
|
4012
|
+
|
|
4013
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
4014
|
+
|
|
4015
|
+
</dd>
|
|
4016
|
+
</dl>
|
|
4017
|
+
|
|
4018
|
+
<dl>
|
|
4019
|
+
<dd>
|
|
4020
|
+
|
|
4021
|
+
**request:** `AgentMail.UpdateInboxRequest`
|
|
4022
|
+
|
|
4023
|
+
</dd>
|
|
4024
|
+
</dl>
|
|
4025
|
+
|
|
4026
|
+
<dl>
|
|
4027
|
+
<dd>
|
|
4028
|
+
|
|
4029
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
4030
|
+
|
|
4031
|
+
</dd>
|
|
4032
|
+
</dl>
|
|
4033
|
+
</dd>
|
|
4034
|
+
</dl>
|
|
4035
|
+
|
|
4036
|
+
|
|
3740
4037
|
</dd>
|
|
3741
4038
|
</dl>
|
|
3742
4039
|
</details>
|
|
@@ -3799,7 +4096,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
3799
4096
|
</details>
|
|
3800
4097
|
|
|
3801
4098
|
## Pods Lists
|
|
3802
|
-
<details><summary><code>client.pods.lists.<a href="/src/api/resources/pods/resources/lists/client/Client.ts">
|
|
4099
|
+
<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>
|
|
3803
4100
|
<dl>
|
|
3804
4101
|
<dd>
|
|
3805
4102
|
|
|
@@ -3812,9 +4109,7 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
3812
4109
|
<dd>
|
|
3813
4110
|
|
|
3814
4111
|
```typescript
|
|
3815
|
-
await client.pods.lists.
|
|
3816
|
-
entry: "entry"
|
|
3817
|
-
});
|
|
4112
|
+
await client.pods.lists.list("pod_id", "send", "allow");
|
|
3818
4113
|
|
|
3819
4114
|
```
|
|
3820
4115
|
</dd>
|
|
@@ -3854,7 +4149,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
3854
4149
|
<dl>
|
|
3855
4150
|
<dd>
|
|
3856
4151
|
|
|
3857
|
-
**request:** `AgentMail.
|
|
4152
|
+
**request:** `AgentMail.pods.ListListEntriesRequest`
|
|
3858
4153
|
|
|
3859
4154
|
</dd>
|
|
3860
4155
|
</dl>
|
|
@@ -3874,7 +4169,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
3874
4169
|
</dl>
|
|
3875
4170
|
</details>
|
|
3876
4171
|
|
|
3877
|
-
<details><summary><code>client.pods.lists.<a href="/src/api/resources/pods/resources/lists/client/Client.ts">
|
|
4172
|
+
<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>
|
|
3878
4173
|
<dl>
|
|
3879
4174
|
<dd>
|
|
3880
4175
|
|
|
@@ -3887,7 +4182,7 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
3887
4182
|
<dd>
|
|
3888
4183
|
|
|
3889
4184
|
```typescript
|
|
3890
|
-
await client.pods.lists.
|
|
4185
|
+
await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
3891
4186
|
|
|
3892
4187
|
```
|
|
3893
4188
|
</dd>
|
|
@@ -3927,7 +4222,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
3927
4222
|
<dl>
|
|
3928
4223
|
<dd>
|
|
3929
4224
|
|
|
3930
|
-
**
|
|
4225
|
+
**entry:** `string` — Email address or domain.
|
|
3931
4226
|
|
|
3932
4227
|
</dd>
|
|
3933
4228
|
</dl>
|
|
@@ -3947,7 +4242,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
3947
4242
|
</dl>
|
|
3948
4243
|
</details>
|
|
3949
4244
|
|
|
3950
|
-
<details><summary><code>client.pods.lists.<a href="/src/api/resources/pods/resources/lists/client/Client.ts">
|
|
4245
|
+
<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>
|
|
3951
4246
|
<dl>
|
|
3952
4247
|
<dd>
|
|
3953
4248
|
|
|
@@ -3960,7 +4255,9 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
3960
4255
|
<dd>
|
|
3961
4256
|
|
|
3962
4257
|
```typescript
|
|
3963
|
-
await client.pods.lists.
|
|
4258
|
+
await client.pods.lists.create("pod_id", "send", "allow", {
|
|
4259
|
+
entry: "entry"
|
|
4260
|
+
});
|
|
3964
4261
|
|
|
3965
4262
|
```
|
|
3966
4263
|
</dd>
|
|
@@ -4000,7 +4297,7 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
4000
4297
|
<dl>
|
|
4001
4298
|
<dd>
|
|
4002
4299
|
|
|
4003
|
-
**
|
|
4300
|
+
**request:** `AgentMail.CreateListEntryRequest`
|
|
4004
4301
|
|
|
4005
4302
|
</dd>
|
|
4006
4303
|
</dl>
|
|
@@ -4089,6 +4386,64 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
4089
4386
|
</dl>
|
|
4090
4387
|
|
|
4091
4388
|
|
|
4389
|
+
</dd>
|
|
4390
|
+
</dl>
|
|
4391
|
+
</details>
|
|
4392
|
+
|
|
4393
|
+
## Pods Metrics
|
|
4394
|
+
<details><summary><code>client.pods.metrics.<a href="/src/api/resources/pods/resources/metrics/client/Client.ts">query</a>(pod_id, { ...params }) -> AgentMail.QueryMetricsResponse</code></summary>
|
|
4395
|
+
<dl>
|
|
4396
|
+
<dd>
|
|
4397
|
+
|
|
4398
|
+
#### 🔌 Usage
|
|
4399
|
+
|
|
4400
|
+
<dl>
|
|
4401
|
+
<dd>
|
|
4402
|
+
|
|
4403
|
+
<dl>
|
|
4404
|
+
<dd>
|
|
4405
|
+
|
|
4406
|
+
```typescript
|
|
4407
|
+
await client.pods.metrics.query("pod_id");
|
|
4408
|
+
|
|
4409
|
+
```
|
|
4410
|
+
</dd>
|
|
4411
|
+
</dl>
|
|
4412
|
+
</dd>
|
|
4413
|
+
</dl>
|
|
4414
|
+
|
|
4415
|
+
#### ⚙️ Parameters
|
|
4416
|
+
|
|
4417
|
+
<dl>
|
|
4418
|
+
<dd>
|
|
4419
|
+
|
|
4420
|
+
<dl>
|
|
4421
|
+
<dd>
|
|
4422
|
+
|
|
4423
|
+
**pod_id:** `AgentMail.PodId`
|
|
4424
|
+
|
|
4425
|
+
</dd>
|
|
4426
|
+
</dl>
|
|
4427
|
+
|
|
4428
|
+
<dl>
|
|
4429
|
+
<dd>
|
|
4430
|
+
|
|
4431
|
+
**request:** `AgentMail.pods.QueryMetricsRequest`
|
|
4432
|
+
|
|
4433
|
+
</dd>
|
|
4434
|
+
</dl>
|
|
4435
|
+
|
|
4436
|
+
<dl>
|
|
4437
|
+
<dd>
|
|
4438
|
+
|
|
4439
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
4440
|
+
|
|
4441
|
+
</dd>
|
|
4442
|
+
</dl>
|
|
4443
|
+
</dd>
|
|
4444
|
+
</dl>
|
|
4445
|
+
|
|
4446
|
+
|
|
4092
4447
|
</dd>
|
|
4093
4448
|
</dl>
|
|
4094
4449
|
</details>
|
|
@@ -4269,6 +4624,85 @@ await client.pods.threads.getAttachment("pod_id", "thread_id", "attachment_id");
|
|
|
4269
4624
|
</dl>
|
|
4270
4625
|
|
|
4271
4626
|
|
|
4627
|
+
</dd>
|
|
4628
|
+
</dl>
|
|
4629
|
+
</details>
|
|
4630
|
+
|
|
4631
|
+
<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>
|
|
4632
|
+
<dl>
|
|
4633
|
+
<dd>
|
|
4634
|
+
|
|
4635
|
+
#### 📝 Description
|
|
4636
|
+
|
|
4637
|
+
<dl>
|
|
4638
|
+
<dd>
|
|
4639
|
+
|
|
4640
|
+
<dl>
|
|
4641
|
+
<dd>
|
|
4642
|
+
|
|
4643
|
+
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.
|
|
4644
|
+
</dd>
|
|
4645
|
+
</dl>
|
|
4646
|
+
</dd>
|
|
4647
|
+
</dl>
|
|
4648
|
+
|
|
4649
|
+
#### 🔌 Usage
|
|
4650
|
+
|
|
4651
|
+
<dl>
|
|
4652
|
+
<dd>
|
|
4653
|
+
|
|
4654
|
+
<dl>
|
|
4655
|
+
<dd>
|
|
4656
|
+
|
|
4657
|
+
```typescript
|
|
4658
|
+
await client.pods.threads.delete("pod_id", "thread_id");
|
|
4659
|
+
|
|
4660
|
+
```
|
|
4661
|
+
</dd>
|
|
4662
|
+
</dl>
|
|
4663
|
+
</dd>
|
|
4664
|
+
</dl>
|
|
4665
|
+
|
|
4666
|
+
#### ⚙️ Parameters
|
|
4667
|
+
|
|
4668
|
+
<dl>
|
|
4669
|
+
<dd>
|
|
4670
|
+
|
|
4671
|
+
<dl>
|
|
4672
|
+
<dd>
|
|
4673
|
+
|
|
4674
|
+
**pod_id:** `AgentMail.PodId`
|
|
4675
|
+
|
|
4676
|
+
</dd>
|
|
4677
|
+
</dl>
|
|
4678
|
+
|
|
4679
|
+
<dl>
|
|
4680
|
+
<dd>
|
|
4681
|
+
|
|
4682
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
4683
|
+
|
|
4684
|
+
</dd>
|
|
4685
|
+
</dl>
|
|
4686
|
+
|
|
4687
|
+
<dl>
|
|
4688
|
+
<dd>
|
|
4689
|
+
|
|
4690
|
+
**request:** `AgentMail.pods.DeleteThreadRequest`
|
|
4691
|
+
|
|
4692
|
+
</dd>
|
|
4693
|
+
</dl>
|
|
4694
|
+
|
|
4695
|
+
<dl>
|
|
4696
|
+
<dd>
|
|
4697
|
+
|
|
4698
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
4699
|
+
|
|
4700
|
+
</dd>
|
|
4701
|
+
</dl>
|
|
4702
|
+
</dd>
|
|
4703
|
+
</dl>
|
|
4704
|
+
|
|
4705
|
+
|
|
4272
4706
|
</dd>
|
|
4273
4707
|
</dl>
|
|
4274
4708
|
</details>
|
|
@@ -4425,6 +4859,77 @@ await client.threads.getAttachment("thread_id", "attachment_id");
|
|
|
4425
4859
|
</dl>
|
|
4426
4860
|
|
|
4427
4861
|
|
|
4862
|
+
</dd>
|
|
4863
|
+
</dl>
|
|
4864
|
+
</details>
|
|
4865
|
+
|
|
4866
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">delete</a>(thread_id, { ...params }) -> void</code></summary>
|
|
4867
|
+
<dl>
|
|
4868
|
+
<dd>
|
|
4869
|
+
|
|
4870
|
+
#### 📝 Description
|
|
4871
|
+
|
|
4872
|
+
<dl>
|
|
4873
|
+
<dd>
|
|
4874
|
+
|
|
4875
|
+
<dl>
|
|
4876
|
+
<dd>
|
|
4877
|
+
|
|
4878
|
+
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.
|
|
4879
|
+
</dd>
|
|
4880
|
+
</dl>
|
|
4881
|
+
</dd>
|
|
4882
|
+
</dl>
|
|
4883
|
+
|
|
4884
|
+
#### 🔌 Usage
|
|
4885
|
+
|
|
4886
|
+
<dl>
|
|
4887
|
+
<dd>
|
|
4888
|
+
|
|
4889
|
+
<dl>
|
|
4890
|
+
<dd>
|
|
4891
|
+
|
|
4892
|
+
```typescript
|
|
4893
|
+
await client.threads.delete("thread_id");
|
|
4894
|
+
|
|
4895
|
+
```
|
|
4896
|
+
</dd>
|
|
4897
|
+
</dl>
|
|
4898
|
+
</dd>
|
|
4899
|
+
</dl>
|
|
4900
|
+
|
|
4901
|
+
#### ⚙️ Parameters
|
|
4902
|
+
|
|
4903
|
+
<dl>
|
|
4904
|
+
<dd>
|
|
4905
|
+
|
|
4906
|
+
<dl>
|
|
4907
|
+
<dd>
|
|
4908
|
+
|
|
4909
|
+
**thread_id:** `AgentMail.ThreadId`
|
|
4910
|
+
|
|
4911
|
+
</dd>
|
|
4912
|
+
</dl>
|
|
4913
|
+
|
|
4914
|
+
<dl>
|
|
4915
|
+
<dd>
|
|
4916
|
+
|
|
4917
|
+
**request:** `AgentMail.DeleteThreadRequest`
|
|
4918
|
+
|
|
4919
|
+
</dd>
|
|
4920
|
+
</dl>
|
|
4921
|
+
|
|
4922
|
+
<dl>
|
|
4923
|
+
<dd>
|
|
4924
|
+
|
|
4925
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
4926
|
+
|
|
4927
|
+
</dd>
|
|
4928
|
+
</dl>
|
|
4929
|
+
</dd>
|
|
4930
|
+
</dl>
|
|
4931
|
+
|
|
4932
|
+
|
|
4428
4933
|
</dd>
|
|
4429
4934
|
</dl>
|
|
4430
4935
|
</details>
|