agentmail 0.5.27 → 0.5.28
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/accounts/client/Client.d.ts +38 -1
- package/dist/cjs/api/resources/accounts/client/Client.js +111 -1
- package/dist/cjs/api/resources/accounts/types/Account.d.ts +4 -0
- package/dist/cjs/api/resources/accounts/types/AccountStatus.d.ts +8 -0
- package/dist/cjs/api/resources/accounts/types/AccountStatus.js +11 -0
- package/dist/cjs/api/resources/accounts/types/UpdateAccountRequest.d.ts +9 -0
- package/dist/cjs/api/resources/accounts/types/UpdateAccountRequest.js +3 -0
- package/dist/cjs/api/resources/accounts/types/UpdateAccountStatus.d.ts +10 -0
- package/dist/cjs/api/resources/accounts/types/UpdateAccountStatus.js +13 -0
- package/dist/cjs/api/resources/accounts/types/index.d.ts +3 -0
- package/dist/cjs/api/resources/accounts/types/index.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyPermissions.d.ts +5 -0
- package/dist/cjs/api/resources/inboxes/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/inboxes/client/Client.js +21 -16
- package/dist/cjs/api/resources/inboxes/resources/accounts/client/Client.d.ts +42 -0
- package/dist/cjs/api/resources/inboxes/resources/accounts/client/Client.js +197 -0
- package/dist/cjs/api/resources/inboxes/resources/accounts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/accounts/client/index.js +17 -0
- package/dist/cjs/api/resources/inboxes/resources/accounts/client/requests/ListAccountsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/inboxes/resources/accounts/client/requests/ListAccountsRequest.js +3 -0
- package/dist/cjs/api/resources/inboxes/resources/accounts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/accounts/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/inboxes/resources/accounts/exports.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/resources/accounts/exports.js +21 -0
- package/dist/cjs/api/resources/inboxes/resources/accounts/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/accounts/index.js +17 -0
- package/dist/cjs/api/resources/inboxes/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/resources/index.js +3 -1
- package/dist/cjs/api/resources/pods/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/pods/client/Client.js +21 -16
- package/dist/cjs/api/resources/pods/resources/accounts/client/Client.d.ts +42 -0
- package/dist/cjs/api/resources/pods/resources/accounts/client/Client.js +197 -0
- package/dist/cjs/api/resources/pods/resources/accounts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/accounts/client/index.js +17 -0
- package/dist/cjs/api/resources/pods/resources/accounts/client/requests/ListAccountsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/pods/resources/accounts/client/requests/ListAccountsRequest.js +3 -0
- package/dist/cjs/api/resources/pods/resources/accounts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/accounts/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/pods/resources/accounts/exports.d.ts +2 -0
- package/dist/cjs/api/resources/pods/resources/accounts/exports.js +21 -0
- package/dist/cjs/api/resources/pods/resources/accounts/index.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/accounts/index.js +17 -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/webhooks/types/CreateWebhookRequest.d.ts +4 -0
- package/dist/cjs/api/resources/webhooks/types/UpdatePodWebhookRequest.d.ts +5 -1
- package/dist/cjs/serialization/resources/accounts/types/Account.d.ts +3 -0
- package/dist/cjs/serialization/resources/accounts/types/Account.js +3 -0
- package/dist/cjs/serialization/resources/accounts/types/AccountStatus.d.ts +7 -0
- package/dist/cjs/serialization/resources/accounts/types/AccountStatus.js +39 -0
- package/dist/cjs/serialization/resources/accounts/types/UpdateAccountRequest.d.ts +10 -0
- package/dist/cjs/serialization/resources/accounts/types/UpdateAccountRequest.js +42 -0
- package/dist/cjs/serialization/resources/accounts/types/UpdateAccountStatus.d.ts +7 -0
- package/dist/cjs/serialization/resources/accounts/types/UpdateAccountStatus.js +39 -0
- package/dist/cjs/serialization/resources/accounts/types/index.d.ts +3 -0
- package/dist/cjs/serialization/resources/accounts/types/index.js +3 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyPermissions.d.ts +1 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyPermissions.js +1 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/accounts/client/Client.d.mts +38 -1
- package/dist/esm/api/resources/accounts/client/Client.mjs +111 -1
- package/dist/esm/api/resources/accounts/types/Account.d.mts +4 -0
- package/dist/esm/api/resources/accounts/types/AccountStatus.d.mts +8 -0
- package/dist/esm/api/resources/accounts/types/AccountStatus.mjs +8 -0
- package/dist/esm/api/resources/accounts/types/UpdateAccountRequest.d.mts +9 -0
- package/dist/esm/api/resources/accounts/types/UpdateAccountRequest.mjs +2 -0
- package/dist/esm/api/resources/accounts/types/UpdateAccountStatus.d.mts +10 -0
- package/dist/esm/api/resources/accounts/types/UpdateAccountStatus.mjs +10 -0
- package/dist/esm/api/resources/accounts/types/index.d.mts +3 -0
- package/dist/esm/api/resources/accounts/types/index.mjs +3 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeyPermissions.d.mts +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/accounts/client/Client.d.mts +42 -0
- package/dist/esm/api/resources/inboxes/resources/accounts/client/Client.mjs +160 -0
- package/dist/esm/api/resources/inboxes/resources/accounts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/accounts/client/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/accounts/client/requests/ListAccountsRequest.d.mts +10 -0
- package/dist/esm/api/resources/inboxes/resources/accounts/client/requests/ListAccountsRequest.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/accounts/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/accounts/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/accounts/exports.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/resources/accounts/exports.mjs +3 -0
- package/dist/esm/api/resources/inboxes/resources/accounts/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/accounts/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/resources/index.mjs +2 -0
- package/dist/esm/api/resources/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/accounts/client/Client.d.mts +42 -0
- package/dist/esm/api/resources/pods/resources/accounts/client/Client.mjs +160 -0
- package/dist/esm/api/resources/pods/resources/accounts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/accounts/client/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/accounts/client/requests/ListAccountsRequest.d.mts +10 -0
- package/dist/esm/api/resources/pods/resources/accounts/client/requests/ListAccountsRequest.mjs +2 -0
- package/dist/esm/api/resources/pods/resources/accounts/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/accounts/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/accounts/exports.d.mts +2 -0
- package/dist/esm/api/resources/pods/resources/accounts/exports.mjs +3 -0
- package/dist/esm/api/resources/pods/resources/accounts/index.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/accounts/index.mjs +1 -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/webhooks/types/CreateWebhookRequest.d.mts +4 -0
- package/dist/esm/api/resources/webhooks/types/UpdatePodWebhookRequest.d.mts +5 -1
- package/dist/esm/serialization/resources/accounts/types/Account.d.mts +3 -0
- package/dist/esm/serialization/resources/accounts/types/Account.mjs +3 -0
- package/dist/esm/serialization/resources/accounts/types/AccountStatus.d.mts +7 -0
- package/dist/esm/serialization/resources/accounts/types/AccountStatus.mjs +3 -0
- package/dist/esm/serialization/resources/accounts/types/UpdateAccountRequest.d.mts +10 -0
- package/dist/esm/serialization/resources/accounts/types/UpdateAccountRequest.mjs +6 -0
- package/dist/esm/serialization/resources/accounts/types/UpdateAccountStatus.d.mts +7 -0
- package/dist/esm/serialization/resources/accounts/types/UpdateAccountStatus.mjs +3 -0
- package/dist/esm/serialization/resources/accounts/types/index.d.mts +3 -0
- package/dist/esm/serialization/resources/accounts/types/index.mjs +3 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyPermissions.d.mts +1 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyPermissions.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms.txt +8 -2
- package/package.json +23 -1
- package/reference.md +393 -1
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
export * from "./Account.mjs";
|
|
2
2
|
export * from "./AccountId.mjs";
|
|
3
|
+
export * from "./AccountStatus.mjs";
|
|
3
4
|
export * from "./ListAccountsResponse.mjs";
|
|
4
5
|
export * from "./ProviderId.mjs";
|
|
6
|
+
export * from "./UpdateAccountRequest.mjs";
|
|
7
|
+
export * from "./UpdateAccountStatus.mjs";
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
export * from "./Account.mjs";
|
|
2
2
|
export * from "./AccountId.mjs";
|
|
3
|
+
export * from "./AccountStatus.mjs";
|
|
3
4
|
export * from "./ListAccountsResponse.mjs";
|
|
4
5
|
export * from "./ProviderId.mjs";
|
|
6
|
+
export * from "./UpdateAccountRequest.mjs";
|
|
7
|
+
export * from "./UpdateAccountStatus.mjs";
|
|
@@ -39,6 +39,7 @@ export declare namespace ApiKeyPermissions {
|
|
|
39
39
|
api_key_delete?: boolean | null;
|
|
40
40
|
provider_connect?: boolean | null;
|
|
41
41
|
provider_share_owner?: boolean | null;
|
|
42
|
+
account_update?: boolean | null;
|
|
42
43
|
pod_read?: boolean | null;
|
|
43
44
|
pod_create?: boolean | null;
|
|
44
45
|
pod_delete?: boolean | null;
|
|
@@ -36,6 +36,7 @@ export const ApiKeyPermissions = core.serialization.object({
|
|
|
36
36
|
apiKeyDelete: core.serialization.property("api_key_delete", core.serialization.boolean().optional()),
|
|
37
37
|
providerConnect: core.serialization.property("provider_connect", core.serialization.boolean().optional()),
|
|
38
38
|
providerShareOwner: core.serialization.property("provider_share_owner", core.serialization.boolean().optional()),
|
|
39
|
+
accountUpdate: core.serialization.property("account_update", core.serialization.boolean().optional()),
|
|
39
40
|
podRead: core.serialization.property("pod_read", core.serialization.boolean().optional()),
|
|
40
41
|
podCreate: core.serialization.property("pod_create", core.serialization.boolean().optional()),
|
|
41
42
|
podDelete: core.serialization.property("pod_delete", core.serialization.boolean().optional()),
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.5.
|
|
1
|
+
export declare const SDK_VERSION = "0.5.28";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "0.5.
|
|
1
|
+
export const SDK_VERSION = "0.5.28";
|
package/dist/llms.txt
CHANGED
|
@@ -31,6 +31,7 @@
|
|
|
31
31
|
- [OpenClaw](https://docs.agentmail.to/integrations/openclaw.md): Install AgentMail as an official OpenClaw plugin with one command. Your agent gets its own inbox plus an allowlisted email channel it can be reached at.
|
|
32
32
|
- [Grok Bot](https://docs.agentmail.to/integrations/grokbot.md): AgentMail's Grok Bot, Grok Build, and Grok API integration
|
|
33
33
|
- [Replit](https://docs.agentmail.to/integrations/replit.md): AgentMail's Replit integration
|
|
34
|
+
- [Vercel](https://docs.agentmail.to/integrations/vercel.md): Provision AgentMail from the Vercel Marketplace and authenticate your Vercel functions with OIDC resource tokens or the provisioned API key
|
|
34
35
|
- [x402](https://docs.agentmail.to/integrations/x402.md): AgentMail's x402 integration for HTTP-native payments
|
|
35
36
|
- [MPP](https://docs.agentmail.to/integrations/mpp.md): AgentMail's MPP integration for machine-to-machine payments via Stripe
|
|
36
37
|
- [Integrate LiveKit Agents](https://docs.agentmail.to/integrate-livekit-agents.md): A step-by-step guide to integrate with the LiveKit Agents SDK.
|
|
@@ -62,7 +63,7 @@
|
|
|
62
63
|
- [Join the AgentMail Community](https://docs.agentmail.to/community.md): Connect with the AgentMail team and developers, share what you're building, and get support.
|
|
63
64
|
- [Support](https://docs.agentmail.to/support.md): Get help with AgentMail through our support channels.
|
|
64
65
|
- [Understanding Email Authentication (SPF, DKIM, DMARC)](https://docs.agentmail.to/email-protocols.md): Learn why we ask for DNS records and what SPF, DKIM, and DMARC are.
|
|
65
|
-
- [SOC 2 Compliance](https://docs.agentmail.to/documentation/resources/security-privacy/soc-2-compliance.md): AgentMail's SOC 2 Type
|
|
66
|
+
- [SOC 2 Compliance](https://docs.agentmail.to/documentation/resources/security-privacy/soc-2-compliance.md): AgentMail's completed 2025 SOC 2 Type II audit and 2026 annual audit underway with A-LIGN.
|
|
66
67
|
- [Spam & Virus Detection](https://docs.agentmail.to/spam-virus-detection.md): How AgentMail automatically scans incoming emails for spam and viruses.
|
|
67
68
|
- [API Welcome](https://docs.agentmail.to/api-reference.md): Quick overview of the AgentMail SDK
|
|
68
69
|
- [Knowledge Base](https://docs.agentmail.to/knowledge-base.md): A collection of answers to frequently asked questions.
|
|
@@ -82,7 +83,7 @@
|
|
|
82
83
|
- [Warming Up](https://docs.agentmail.to/knowledge-base/domain-warming.md): Gradually build sending reputation on a new domain or inbox.
|
|
83
84
|
- [How do I avoid MX record conflicts?](https://docs.agentmail.to/knowledge-base/mx-record-conflicts.md): Add AgentMail DNS records without breaking existing email.
|
|
84
85
|
- [What does a 403 error mean?](https://docs.agentmail.to/knowledge-base/api-403-error.md): Common causes of API 403 Forbidden errors and how to fix them.
|
|
85
|
-
- [What are the rate limits?](https://docs.agentmail.to/knowledge-base/rate-limits.md): Understand AgentMail's rate limits and how to work within them.
|
|
86
|
+
- [What are the rate limits?](https://docs.agentmail.to/knowledge-base/rate-limits.md): Understand AgentMail's sending limits and API rate limits, and how to work within them.
|
|
86
87
|
- [How do I prevent duplicate sends?](https://docs.agentmail.to/knowledge-base/preventing-duplicate-sends.md): Use idempotency to avoid sending the same email twice.
|
|
87
88
|
- [Why is my domain not verifying?](https://docs.agentmail.to/knowledge-base/domain-not-verifying.md): What to do when your domain verification is stuck.
|
|
88
89
|
- [Why are my emails bouncing?](https://docs.agentmail.to/knowledge-base/emails-bouncing.md): Diagnose and resolve email bounce issues.
|
|
@@ -149,6 +150,8 @@
|
|
|
149
150
|
- API Reference > Inboxes > API Keys [Create API Key](https://docs.agentmail.to/api-reference/inboxes/api-keys/create.md)
|
|
150
151
|
- API Reference > Inboxes > API Keys [Update API Key](https://docs.agentmail.to/api-reference/inboxes/api-keys/update.md)
|
|
151
152
|
- API Reference > Inboxes > API Keys [Delete API Key](https://docs.agentmail.to/api-reference/inboxes/api-keys/delete.md)
|
|
153
|
+
- API Reference > Inboxes > Accounts [List Accounts](https://docs.agentmail.to/api-reference/inboxes/accounts/list.md)
|
|
154
|
+
- API Reference > Inboxes > Accounts [Get Account](https://docs.agentmail.to/api-reference/inboxes/accounts/get.md)
|
|
152
155
|
- API Reference > Threads [List Threads](https://docs.agentmail.to/api-reference/threads/list.md)
|
|
153
156
|
- API Reference > Threads [Search Threads](https://docs.agentmail.to/api-reference/threads/search.md)
|
|
154
157
|
- API Reference > Threads [Get Thread](https://docs.agentmail.to/api-reference/threads/get.md)
|
|
@@ -200,6 +203,7 @@
|
|
|
200
203
|
- API Reference > Providers [Connect Provider](https://docs.agentmail.to/api-reference/providers/connect.md)
|
|
201
204
|
- API Reference > Accounts [List Accounts](https://docs.agentmail.to/api-reference/accounts/list.md)
|
|
202
205
|
- API Reference > Accounts [Get Account](https://docs.agentmail.to/api-reference/accounts/get.md)
|
|
206
|
+
- API Reference > Accounts [Update Account](https://docs.agentmail.to/api-reference/accounts/update.md)
|
|
203
207
|
- API Reference > Pods [List Pods](https://docs.agentmail.to/api-reference/pods/list.md)
|
|
204
208
|
- API Reference > Pods [Get Pod](https://docs.agentmail.to/api-reference/pods/get.md)
|
|
205
209
|
- API Reference > Pods [Create Pod](https://docs.agentmail.to/api-reference/pods/create.md)
|
|
@@ -243,6 +247,8 @@
|
|
|
243
247
|
- API Reference > Pods > API Keys [Create API Key](https://docs.agentmail.to/api-reference/pods/api-keys/create.md)
|
|
244
248
|
- API Reference > Pods > API Keys [Update API Key](https://docs.agentmail.to/api-reference/pods/api-keys/update.md)
|
|
245
249
|
- API Reference > Pods > API Keys [Delete API Key](https://docs.agentmail.to/api-reference/pods/api-keys/delete.md)
|
|
250
|
+
- API Reference > Pods > Accounts [List Accounts](https://docs.agentmail.to/api-reference/pods/accounts/list.md)
|
|
251
|
+
- API Reference > Pods > Accounts [Get Account](https://docs.agentmail.to/api-reference/pods/accounts/get.md)
|
|
246
252
|
- API Reference > Organizations [Get Organization](https://docs.agentmail.to/api-reference/organizations/get.md)
|
|
247
253
|
- API Reference > Auth [Who Am I](https://docs.agentmail.to/api-reference/auth/me.md)
|
|
248
254
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agentmail",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.28",
|
|
4
4
|
"private": false,
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -133,6 +133,17 @@
|
|
|
133
133
|
},
|
|
134
134
|
"default": "./dist/cjs/api/resources/drafts/exports.js"
|
|
135
135
|
},
|
|
136
|
+
"./inboxes/accounts": {
|
|
137
|
+
"import": {
|
|
138
|
+
"types": "./dist/esm/api/resources/inboxes/resources/accounts/exports.d.mts",
|
|
139
|
+
"default": "./dist/esm/api/resources/inboxes/resources/accounts/exports.mjs"
|
|
140
|
+
},
|
|
141
|
+
"require": {
|
|
142
|
+
"types": "./dist/cjs/api/resources/inboxes/resources/accounts/exports.d.ts",
|
|
143
|
+
"default": "./dist/cjs/api/resources/inboxes/resources/accounts/exports.js"
|
|
144
|
+
},
|
|
145
|
+
"default": "./dist/cjs/api/resources/inboxes/resources/accounts/exports.js"
|
|
146
|
+
},
|
|
136
147
|
"./inboxes/apiKeys": {
|
|
137
148
|
"import": {
|
|
138
149
|
"types": "./dist/esm/api/resources/inboxes/resources/apiKeys/exports.d.mts",
|
|
@@ -254,6 +265,17 @@
|
|
|
254
265
|
},
|
|
255
266
|
"default": "./dist/cjs/api/resources/organizations/exports.js"
|
|
256
267
|
},
|
|
268
|
+
"./pods/accounts": {
|
|
269
|
+
"import": {
|
|
270
|
+
"types": "./dist/esm/api/resources/pods/resources/accounts/exports.d.mts",
|
|
271
|
+
"default": "./dist/esm/api/resources/pods/resources/accounts/exports.mjs"
|
|
272
|
+
},
|
|
273
|
+
"require": {
|
|
274
|
+
"types": "./dist/cjs/api/resources/pods/resources/accounts/exports.d.ts",
|
|
275
|
+
"default": "./dist/cjs/api/resources/pods/resources/accounts/exports.js"
|
|
276
|
+
},
|
|
277
|
+
"default": "./dist/cjs/api/resources/pods/resources/accounts/exports.js"
|
|
278
|
+
},
|
|
257
279
|
"./pods/apiKeys": {
|
|
258
280
|
"import": {
|
|
259
281
|
"types": "./dist/esm/api/resources/pods/resources/apiKeys/exports.d.mts",
|
package/reference.md
CHANGED
|
@@ -1243,7 +1243,9 @@ await client.webhooks.delete("webhook_id");
|
|
|
1243
1243
|
<dl>
|
|
1244
1244
|
<dd>
|
|
1245
1245
|
|
|
1246
|
-
Lists accounts across all providers
|
|
1246
|
+
Lists accounts across all providers, scoped to the API key: an
|
|
1247
|
+
organization key sees every account, a pod key its pod's, an inbox key
|
|
1248
|
+
its inbox's. Requires `inbox_read`.
|
|
1247
1249
|
</dd>
|
|
1248
1250
|
</dl>
|
|
1249
1251
|
</dd>
|
|
@@ -1298,6 +1300,21 @@ await client.accounts.list();
|
|
|
1298
1300
|
<dl>
|
|
1299
1301
|
<dd>
|
|
1300
1302
|
|
|
1303
|
+
#### 📝 Description
|
|
1304
|
+
|
|
1305
|
+
<dl>
|
|
1306
|
+
<dd>
|
|
1307
|
+
|
|
1308
|
+
<dl>
|
|
1309
|
+
<dd>
|
|
1310
|
+
|
|
1311
|
+
Returns one account by ID. An account outside the key's scope is a 404.
|
|
1312
|
+
Requires `inbox_read`.
|
|
1313
|
+
</dd>
|
|
1314
|
+
</dl>
|
|
1315
|
+
</dd>
|
|
1316
|
+
</dl>
|
|
1317
|
+
|
|
1301
1318
|
#### 🔌 Usage
|
|
1302
1319
|
|
|
1303
1320
|
<dl>
|
|
@@ -1339,6 +1356,93 @@ await client.accounts.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
|
1339
1356
|
</dl>
|
|
1340
1357
|
|
|
1341
1358
|
|
|
1359
|
+
</dd>
|
|
1360
|
+
</dl>
|
|
1361
|
+
</details>
|
|
1362
|
+
|
|
1363
|
+
<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">update</a>(account_id, { ...params }) -> AgentMail.Account</code></summary>
|
|
1364
|
+
<dl>
|
|
1365
|
+
<dd>
|
|
1366
|
+
|
|
1367
|
+
#### 📝 Description
|
|
1368
|
+
|
|
1369
|
+
<dl>
|
|
1370
|
+
<dd>
|
|
1371
|
+
|
|
1372
|
+
<dl>
|
|
1373
|
+
<dd>
|
|
1374
|
+
|
|
1375
|
+
Updates one account. Set `status` to `disabled` to stop the inbox from
|
|
1376
|
+
signing in at the provider again, or to `enabled` to re-enable it.
|
|
1377
|
+
Idempotent: disabling an already disabled account keeps its original
|
|
1378
|
+
`disabled_at`, and enabling an enabled account is a no-op.
|
|
1379
|
+
|
|
1380
|
+
Find the `account_id` with List Accounts. An account exists only after an
|
|
1381
|
+
inbox's first sign-in at a provider, so it cannot be disabled in advance.
|
|
1382
|
+
A disable applies to that inbox at that provider whichever sign-in key is
|
|
1383
|
+
used: the provider's next authorization ends in `access_denied`, and a code
|
|
1384
|
+
issued earlier is refused with `invalid_grant`. Access tokens already
|
|
1385
|
+
issued stay valid until they expire, and the provider's own session is
|
|
1386
|
+
unaffected.
|
|
1387
|
+
|
|
1388
|
+
Requires `account_update`, which sign-in keys (`type: public_key`) cannot
|
|
1389
|
+
hold, so call this with a bearer API key. An account outside the key's
|
|
1390
|
+
scope is a 404. A 409 means the account changed during the write; read it
|
|
1391
|
+
again and retry.
|
|
1392
|
+
</dd>
|
|
1393
|
+
</dl>
|
|
1394
|
+
</dd>
|
|
1395
|
+
</dl>
|
|
1396
|
+
|
|
1397
|
+
#### 🔌 Usage
|
|
1398
|
+
|
|
1399
|
+
<dl>
|
|
1400
|
+
<dd>
|
|
1401
|
+
|
|
1402
|
+
<dl>
|
|
1403
|
+
<dd>
|
|
1404
|
+
|
|
1405
|
+
```typescript
|
|
1406
|
+
await client.accounts.update("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", {});
|
|
1407
|
+
|
|
1408
|
+
```
|
|
1409
|
+
</dd>
|
|
1410
|
+
</dl>
|
|
1411
|
+
</dd>
|
|
1412
|
+
</dl>
|
|
1413
|
+
|
|
1414
|
+
#### ⚙️ Parameters
|
|
1415
|
+
|
|
1416
|
+
<dl>
|
|
1417
|
+
<dd>
|
|
1418
|
+
|
|
1419
|
+
<dl>
|
|
1420
|
+
<dd>
|
|
1421
|
+
|
|
1422
|
+
**account_id:** `AgentMail.AccountId`
|
|
1423
|
+
|
|
1424
|
+
</dd>
|
|
1425
|
+
</dl>
|
|
1426
|
+
|
|
1427
|
+
<dl>
|
|
1428
|
+
<dd>
|
|
1429
|
+
|
|
1430
|
+
**request:** `AgentMail.UpdateAccountRequest`
|
|
1431
|
+
|
|
1432
|
+
</dd>
|
|
1433
|
+
</dl>
|
|
1434
|
+
|
|
1435
|
+
<dl>
|
|
1436
|
+
<dd>
|
|
1437
|
+
|
|
1438
|
+
**requestOptions:** `AccountsClient.RequestOptions`
|
|
1439
|
+
|
|
1440
|
+
</dd>
|
|
1441
|
+
</dl>
|
|
1442
|
+
</dd>
|
|
1443
|
+
</dl>
|
|
1444
|
+
|
|
1445
|
+
|
|
1342
1446
|
</dd>
|
|
1343
1447
|
</dl>
|
|
1344
1448
|
</details>
|
|
@@ -2641,6 +2745,150 @@ await client.drafts.getAttachment("draft_id", "attachment_id");
|
|
|
2641
2745
|
</dl>
|
|
2642
2746
|
|
|
2643
2747
|
|
|
2748
|
+
</dd>
|
|
2749
|
+
</dl>
|
|
2750
|
+
</details>
|
|
2751
|
+
|
|
2752
|
+
## Inboxes Accounts
|
|
2753
|
+
<details><summary><code>client.inboxes.accounts.<a href="/src/api/resources/inboxes/resources/accounts/client/Client.ts">list</a>(inbox_id, { ...params }) -> AgentMail.ListAccountsResponse</code></summary>
|
|
2754
|
+
<dl>
|
|
2755
|
+
<dd>
|
|
2756
|
+
|
|
2757
|
+
#### 📝 Description
|
|
2758
|
+
|
|
2759
|
+
<dl>
|
|
2760
|
+
<dd>
|
|
2761
|
+
|
|
2762
|
+
<dl>
|
|
2763
|
+
<dd>
|
|
2764
|
+
|
|
2765
|
+
Lists accounts held by the inbox, across all providers. Requires `inbox_read`.
|
|
2766
|
+
</dd>
|
|
2767
|
+
</dl>
|
|
2768
|
+
</dd>
|
|
2769
|
+
</dl>
|
|
2770
|
+
|
|
2771
|
+
#### 🔌 Usage
|
|
2772
|
+
|
|
2773
|
+
<dl>
|
|
2774
|
+
<dd>
|
|
2775
|
+
|
|
2776
|
+
<dl>
|
|
2777
|
+
<dd>
|
|
2778
|
+
|
|
2779
|
+
```typescript
|
|
2780
|
+
await client.inboxes.accounts.list("inbox_id");
|
|
2781
|
+
|
|
2782
|
+
```
|
|
2783
|
+
</dd>
|
|
2784
|
+
</dl>
|
|
2785
|
+
</dd>
|
|
2786
|
+
</dl>
|
|
2787
|
+
|
|
2788
|
+
#### ⚙️ Parameters
|
|
2789
|
+
|
|
2790
|
+
<dl>
|
|
2791
|
+
<dd>
|
|
2792
|
+
|
|
2793
|
+
<dl>
|
|
2794
|
+
<dd>
|
|
2795
|
+
|
|
2796
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
2797
|
+
|
|
2798
|
+
</dd>
|
|
2799
|
+
</dl>
|
|
2800
|
+
|
|
2801
|
+
<dl>
|
|
2802
|
+
<dd>
|
|
2803
|
+
|
|
2804
|
+
**request:** `AgentMail.inboxes.ListAccountsRequest`
|
|
2805
|
+
|
|
2806
|
+
</dd>
|
|
2807
|
+
</dl>
|
|
2808
|
+
|
|
2809
|
+
<dl>
|
|
2810
|
+
<dd>
|
|
2811
|
+
|
|
2812
|
+
**requestOptions:** `AccountsClient.RequestOptions`
|
|
2813
|
+
|
|
2814
|
+
</dd>
|
|
2815
|
+
</dl>
|
|
2816
|
+
</dd>
|
|
2817
|
+
</dl>
|
|
2818
|
+
|
|
2819
|
+
|
|
2820
|
+
</dd>
|
|
2821
|
+
</dl>
|
|
2822
|
+
</details>
|
|
2823
|
+
|
|
2824
|
+
<details><summary><code>client.inboxes.accounts.<a href="/src/api/resources/inboxes/resources/accounts/client/Client.ts">get</a>(inbox_id, account_id) -> AgentMail.Account</code></summary>
|
|
2825
|
+
<dl>
|
|
2826
|
+
<dd>
|
|
2827
|
+
|
|
2828
|
+
#### 📝 Description
|
|
2829
|
+
|
|
2830
|
+
<dl>
|
|
2831
|
+
<dd>
|
|
2832
|
+
|
|
2833
|
+
<dl>
|
|
2834
|
+
<dd>
|
|
2835
|
+
|
|
2836
|
+
Returns one account held by the inbox. An account elsewhere is a 404. Requires
|
|
2837
|
+
`inbox_read`.
|
|
2838
|
+
</dd>
|
|
2839
|
+
</dl>
|
|
2840
|
+
</dd>
|
|
2841
|
+
</dl>
|
|
2842
|
+
|
|
2843
|
+
#### 🔌 Usage
|
|
2844
|
+
|
|
2845
|
+
<dl>
|
|
2846
|
+
<dd>
|
|
2847
|
+
|
|
2848
|
+
<dl>
|
|
2849
|
+
<dd>
|
|
2850
|
+
|
|
2851
|
+
```typescript
|
|
2852
|
+
await client.inboxes.accounts.get("inbox_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
2853
|
+
|
|
2854
|
+
```
|
|
2855
|
+
</dd>
|
|
2856
|
+
</dl>
|
|
2857
|
+
</dd>
|
|
2858
|
+
</dl>
|
|
2859
|
+
|
|
2860
|
+
#### ⚙️ Parameters
|
|
2861
|
+
|
|
2862
|
+
<dl>
|
|
2863
|
+
<dd>
|
|
2864
|
+
|
|
2865
|
+
<dl>
|
|
2866
|
+
<dd>
|
|
2867
|
+
|
|
2868
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
2869
|
+
|
|
2870
|
+
</dd>
|
|
2871
|
+
</dl>
|
|
2872
|
+
|
|
2873
|
+
<dl>
|
|
2874
|
+
<dd>
|
|
2875
|
+
|
|
2876
|
+
**account_id:** `AgentMail.AccountId`
|
|
2877
|
+
|
|
2878
|
+
</dd>
|
|
2879
|
+
</dl>
|
|
2880
|
+
|
|
2881
|
+
<dl>
|
|
2882
|
+
<dd>
|
|
2883
|
+
|
|
2884
|
+
**requestOptions:** `AccountsClient.RequestOptions`
|
|
2885
|
+
|
|
2886
|
+
</dd>
|
|
2887
|
+
</dl>
|
|
2888
|
+
</dd>
|
|
2889
|
+
</dl>
|
|
2890
|
+
|
|
2891
|
+
|
|
2644
2892
|
</dd>
|
|
2645
2893
|
</dl>
|
|
2646
2894
|
</details>
|
|
@@ -6668,6 +6916,150 @@ await client.organizations.get();
|
|
|
6668
6916
|
</dl>
|
|
6669
6917
|
|
|
6670
6918
|
|
|
6919
|
+
</dd>
|
|
6920
|
+
</dl>
|
|
6921
|
+
</details>
|
|
6922
|
+
|
|
6923
|
+
## Pods Accounts
|
|
6924
|
+
<details><summary><code>client.pods.accounts.<a href="/src/api/resources/pods/resources/accounts/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListAccountsResponse</code></summary>
|
|
6925
|
+
<dl>
|
|
6926
|
+
<dd>
|
|
6927
|
+
|
|
6928
|
+
#### 📝 Description
|
|
6929
|
+
|
|
6930
|
+
<dl>
|
|
6931
|
+
<dd>
|
|
6932
|
+
|
|
6933
|
+
<dl>
|
|
6934
|
+
<dd>
|
|
6935
|
+
|
|
6936
|
+
Lists accounts held by inboxes in the pod, across all providers. Requires `inbox_read`.
|
|
6937
|
+
</dd>
|
|
6938
|
+
</dl>
|
|
6939
|
+
</dd>
|
|
6940
|
+
</dl>
|
|
6941
|
+
|
|
6942
|
+
#### 🔌 Usage
|
|
6943
|
+
|
|
6944
|
+
<dl>
|
|
6945
|
+
<dd>
|
|
6946
|
+
|
|
6947
|
+
<dl>
|
|
6948
|
+
<dd>
|
|
6949
|
+
|
|
6950
|
+
```typescript
|
|
6951
|
+
await client.pods.accounts.list("pod_id");
|
|
6952
|
+
|
|
6953
|
+
```
|
|
6954
|
+
</dd>
|
|
6955
|
+
</dl>
|
|
6956
|
+
</dd>
|
|
6957
|
+
</dl>
|
|
6958
|
+
|
|
6959
|
+
#### ⚙️ Parameters
|
|
6960
|
+
|
|
6961
|
+
<dl>
|
|
6962
|
+
<dd>
|
|
6963
|
+
|
|
6964
|
+
<dl>
|
|
6965
|
+
<dd>
|
|
6966
|
+
|
|
6967
|
+
**pod_id:** `AgentMail.PodId`
|
|
6968
|
+
|
|
6969
|
+
</dd>
|
|
6970
|
+
</dl>
|
|
6971
|
+
|
|
6972
|
+
<dl>
|
|
6973
|
+
<dd>
|
|
6974
|
+
|
|
6975
|
+
**request:** `AgentMail.pods.ListAccountsRequest`
|
|
6976
|
+
|
|
6977
|
+
</dd>
|
|
6978
|
+
</dl>
|
|
6979
|
+
|
|
6980
|
+
<dl>
|
|
6981
|
+
<dd>
|
|
6982
|
+
|
|
6983
|
+
**requestOptions:** `AccountsClient.RequestOptions`
|
|
6984
|
+
|
|
6985
|
+
</dd>
|
|
6986
|
+
</dl>
|
|
6987
|
+
</dd>
|
|
6988
|
+
</dl>
|
|
6989
|
+
|
|
6990
|
+
|
|
6991
|
+
</dd>
|
|
6992
|
+
</dl>
|
|
6993
|
+
</details>
|
|
6994
|
+
|
|
6995
|
+
<details><summary><code>client.pods.accounts.<a href="/src/api/resources/pods/resources/accounts/client/Client.ts">get</a>(pod_id, account_id) -> AgentMail.Account</code></summary>
|
|
6996
|
+
<dl>
|
|
6997
|
+
<dd>
|
|
6998
|
+
|
|
6999
|
+
#### 📝 Description
|
|
7000
|
+
|
|
7001
|
+
<dl>
|
|
7002
|
+
<dd>
|
|
7003
|
+
|
|
7004
|
+
<dl>
|
|
7005
|
+
<dd>
|
|
7006
|
+
|
|
7007
|
+
Returns one account held by inboxes in the pod. An account elsewhere is a 404. Requires
|
|
7008
|
+
`inbox_read`.
|
|
7009
|
+
</dd>
|
|
7010
|
+
</dl>
|
|
7011
|
+
</dd>
|
|
7012
|
+
</dl>
|
|
7013
|
+
|
|
7014
|
+
#### 🔌 Usage
|
|
7015
|
+
|
|
7016
|
+
<dl>
|
|
7017
|
+
<dd>
|
|
7018
|
+
|
|
7019
|
+
<dl>
|
|
7020
|
+
<dd>
|
|
7021
|
+
|
|
7022
|
+
```typescript
|
|
7023
|
+
await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
7024
|
+
|
|
7025
|
+
```
|
|
7026
|
+
</dd>
|
|
7027
|
+
</dl>
|
|
7028
|
+
</dd>
|
|
7029
|
+
</dl>
|
|
7030
|
+
|
|
7031
|
+
#### ⚙️ Parameters
|
|
7032
|
+
|
|
7033
|
+
<dl>
|
|
7034
|
+
<dd>
|
|
7035
|
+
|
|
7036
|
+
<dl>
|
|
7037
|
+
<dd>
|
|
7038
|
+
|
|
7039
|
+
**pod_id:** `AgentMail.PodId`
|
|
7040
|
+
|
|
7041
|
+
</dd>
|
|
7042
|
+
</dl>
|
|
7043
|
+
|
|
7044
|
+
<dl>
|
|
7045
|
+
<dd>
|
|
7046
|
+
|
|
7047
|
+
**account_id:** `AgentMail.AccountId`
|
|
7048
|
+
|
|
7049
|
+
</dd>
|
|
7050
|
+
</dl>
|
|
7051
|
+
|
|
7052
|
+
<dl>
|
|
7053
|
+
<dd>
|
|
7054
|
+
|
|
7055
|
+
**requestOptions:** `AccountsClient.RequestOptions`
|
|
7056
|
+
|
|
7057
|
+
</dd>
|
|
7058
|
+
</dl>
|
|
7059
|
+
</dd>
|
|
7060
|
+
</dl>
|
|
7061
|
+
|
|
7062
|
+
|
|
6671
7063
|
</dd>
|
|
6672
7064
|
</dl>
|
|
6673
7065
|
</details>
|