agentmail 0.5.15 → 0.5.17
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/apiKeys/client/Client.d.ts +94 -0
- package/dist/cjs/api/resources/apiKeys/client/Client.js +372 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/ListPublicKeysRequest.d.ts +10 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/RevokeAllAgentIdSignInKeysRequest.d.ts +10 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyPermissions.d.ts +2 -0
- package/dist/cjs/api/resources/apiKeys/types/CreatePublicKeyRequest.d.ts +21 -0
- package/dist/cjs/api/resources/apiKeys/types/InboxPublicKeyScope.d.ts +7 -0
- package/dist/cjs/api/resources/apiKeys/types/InboxPublicKeyScope.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/ListPublicKeysResponse.d.ts +7 -0
- package/dist/cjs/api/resources/apiKeys/types/ListPublicKeysResponse.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/OrganizationPublicKeyScope.d.ts +4 -0
- package/dist/cjs/api/resources/apiKeys/types/OrganizationPublicKeyScope.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/PodPublicKeyScope.d.ts +7 -0
- package/dist/cjs/api/resources/apiKeys/types/PodPublicKeyScope.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicJwk.d.ts +13 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicJwk.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicJwkCoordinate.d.ts +4 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicJwkCoordinate.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyCredential.d.ts +22 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyCredential.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyMaterial.d.ts +9 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyMaterial.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyScope.d.ts +16 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyScope.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.d.ts +8 -0
- package/dist/cjs/api/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/UpdatePublicKeyNameRequest.d.ts +7 -0
- package/dist/cjs/api/resources/apiKeys/types/UpdatePublicKeyNameRequest.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/index.d.ts +12 -0
- package/dist/cjs/api/resources/apiKeys/types/index.js +12 -0
- package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.d.ts +2 -3
- package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.js +6 -11
- package/dist/cjs/api/resources/inboxes/resources/threads/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.d.ts +2 -3
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.js +6 -11
- package/dist/cjs/api/resources/pods/resources/threads/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/threads/client/Client.d.ts +2 -3
- package/dist/cjs/api/resources/threads/client/Client.js +6 -11
- package/dist/cjs/api/resources/threads/client/requests/index.d.ts +0 -1
- 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/serialization/resources/apiKeys/types/CreatePublicKeyRequest.d.ts +14 -0
- package/dist/cjs/serialization/resources/apiKeys/types/CreatePublicKeyRequest.js +46 -0
- package/dist/cjs/serialization/resources/apiKeys/types/InboxPublicKeyScope.d.ts +9 -0
- package/dist/cjs/serialization/resources/apiKeys/types/InboxPublicKeyScope.js +41 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ListPublicKeysResponse.d.ts +14 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ListPublicKeysResponse.js +46 -0
- package/dist/cjs/serialization/resources/apiKeys/types/OrganizationPublicKeyScope.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/OrganizationPublicKeyScope.js +39 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PodPublicKeyScope.d.ts +9 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PodPublicKeyScope.js +41 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicJwk.d.ts +13 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicJwk.js +45 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicJwkCoordinate.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicJwkCoordinate.js +39 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyCredential.d.ts +20 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyCredential.js +52 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyMaterial.d.ts +11 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyMaterial.js +43 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyScope.d.ts +19 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyScope.js +51 -0
- package/dist/cjs/serialization/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.d.ts +11 -0
- package/dist/cjs/serialization/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.js +43 -0
- package/dist/cjs/serialization/resources/apiKeys/types/UpdatePublicKeyNameRequest.d.ts +9 -0
- package/dist/cjs/serialization/resources/apiKeys/types/UpdatePublicKeyNameRequest.js +41 -0
- package/dist/cjs/serialization/resources/apiKeys/types/index.d.ts +12 -0
- package/dist/cjs/serialization/resources/apiKeys/types/index.js +12 -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/apiKeys/client/Client.d.mts +94 -0
- package/dist/esm/api/resources/apiKeys/client/Client.mjs +373 -1
- package/dist/esm/api/resources/apiKeys/client/requests/ListPublicKeysRequest.d.mts +10 -0
- package/dist/esm/api/resources/apiKeys/client/requests/RevokeAllAgentIdSignInKeysRequest.d.mts +10 -0
- package/dist/esm/api/resources/apiKeys/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeyPermissions.d.mts +2 -0
- package/dist/esm/api/resources/apiKeys/types/CreatePublicKeyRequest.d.mts +21 -0
- package/dist/esm/api/resources/apiKeys/types/InboxPublicKeyScope.d.mts +7 -0
- package/dist/esm/api/resources/apiKeys/types/InboxPublicKeyScope.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/ListPublicKeysResponse.d.mts +7 -0
- package/dist/esm/api/resources/apiKeys/types/ListPublicKeysResponse.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/OrganizationPublicKeyScope.d.mts +4 -0
- package/dist/esm/api/resources/apiKeys/types/OrganizationPublicKeyScope.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/PodPublicKeyScope.d.mts +7 -0
- package/dist/esm/api/resources/apiKeys/types/PodPublicKeyScope.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/PublicJwk.d.mts +13 -0
- package/dist/esm/api/resources/apiKeys/types/PublicJwk.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/PublicJwkCoordinate.d.mts +4 -0
- package/dist/esm/api/resources/apiKeys/types/PublicJwkCoordinate.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/PublicKeyCredential.d.mts +22 -0
- package/dist/esm/api/resources/apiKeys/types/PublicKeyCredential.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/PublicKeyMaterial.d.mts +9 -0
- package/dist/esm/api/resources/apiKeys/types/PublicKeyMaterial.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/PublicKeyScope.d.mts +16 -0
- package/dist/esm/api/resources/apiKeys/types/PublicKeyScope.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.d.mts +8 -0
- package/dist/esm/api/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/UpdatePublicKeyNameRequest.d.mts +7 -0
- package/dist/esm/api/resources/apiKeys/types/UpdatePublicKeyNameRequest.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/index.d.mts +12 -0
- package/dist/esm/api/resources/apiKeys/types/index.mjs +12 -0
- package/dist/esm/api/resources/inboxes/resources/threads/client/Client.d.mts +2 -3
- package/dist/esm/api/resources/inboxes/resources/threads/client/Client.mjs +6 -11
- package/dist/esm/api/resources/inboxes/resources/threads/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/pods/resources/threads/client/Client.d.mts +2 -3
- package/dist/esm/api/resources/pods/resources/threads/client/Client.mjs +6 -11
- package/dist/esm/api/resources/pods/resources/threads/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/threads/client/Client.d.mts +2 -3
- package/dist/esm/api/resources/threads/client/Client.mjs +6 -11
- package/dist/esm/api/resources/threads/client/requests/index.d.mts +0 -1
- 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/serialization/resources/apiKeys/types/CreatePublicKeyRequest.d.mts +14 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreatePublicKeyRequest.mjs +10 -0
- package/dist/esm/serialization/resources/apiKeys/types/InboxPublicKeyScope.d.mts +9 -0
- package/dist/esm/serialization/resources/apiKeys/types/InboxPublicKeyScope.mjs +5 -0
- package/dist/esm/serialization/resources/apiKeys/types/ListPublicKeysResponse.d.mts +14 -0
- package/dist/esm/serialization/resources/apiKeys/types/ListPublicKeysResponse.mjs +10 -0
- package/dist/esm/serialization/resources/apiKeys/types/OrganizationPublicKeyScope.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/OrganizationPublicKeyScope.mjs +3 -0
- package/dist/esm/serialization/resources/apiKeys/types/PodPublicKeyScope.d.mts +9 -0
- package/dist/esm/serialization/resources/apiKeys/types/PodPublicKeyScope.mjs +5 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicJwk.d.mts +13 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicJwk.mjs +9 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicJwkCoordinate.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicJwkCoordinate.mjs +3 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyCredential.d.mts +20 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyCredential.mjs +16 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyMaterial.d.mts +11 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyMaterial.mjs +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyScope.d.mts +19 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyScope.mjs +15 -0
- package/dist/esm/serialization/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.d.mts +11 -0
- package/dist/esm/serialization/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.mjs +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/UpdatePublicKeyNameRequest.d.mts +9 -0
- package/dist/esm/serialization/resources/apiKeys/types/UpdatePublicKeyNameRequest.mjs +5 -0
- package/dist/esm/serialization/resources/apiKeys/types/index.d.mts +12 -0
- package/dist/esm/serialization/resources/apiKeys/types/index.mjs +12 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms.txt +2 -4
- package/package.json +1 -1
- package/reference.md +356 -30
- package/dist/cjs/api/resources/inboxes/resources/threads/client/requests/DeleteThreadRequest.d.ts +0 -8
- package/dist/cjs/api/resources/pods/resources/threads/client/requests/DeleteThreadRequest.d.ts +0 -8
- package/dist/cjs/api/resources/threads/client/requests/DeleteThreadRequest.d.ts +0 -8
- package/dist/esm/api/resources/inboxes/resources/threads/client/requests/DeleteThreadRequest.d.mts +0 -8
- package/dist/esm/api/resources/pods/resources/threads/client/requests/DeleteThreadRequest.d.mts +0 -8
- package/dist/esm/api/resources/threads/client/requests/DeleteThreadRequest.d.mts +0 -8
- /package/dist/cjs/api/resources/{inboxes/resources/threads/client/requests/DeleteThreadRequest.js → apiKeys/client/requests/ListPublicKeysRequest.js} +0 -0
- /package/dist/cjs/api/resources/{pods/resources/threads/client/requests/DeleteThreadRequest.js → apiKeys/client/requests/RevokeAllAgentIdSignInKeysRequest.js} +0 -0
- /package/dist/cjs/api/resources/{threads/client/requests/DeleteThreadRequest.js → apiKeys/types/CreatePublicKeyRequest.js} +0 -0
- /package/dist/esm/api/resources/{inboxes/resources/threads/client/requests/DeleteThreadRequest.mjs → apiKeys/client/requests/ListPublicKeysRequest.mjs} +0 -0
- /package/dist/esm/api/resources/{pods/resources/threads/client/requests/DeleteThreadRequest.mjs → apiKeys/client/requests/RevokeAllAgentIdSignInKeysRequest.mjs} +0 -0
- /package/dist/esm/api/resources/{threads/client/requests/DeleteThreadRequest.mjs → apiKeys/types/CreatePublicKeyRequest.mjs} +0 -0
package/dist/llms.txt
CHANGED
|
@@ -46,13 +46,14 @@
|
|
|
46
46
|
- [WebSockets](https://docs.agentmail.to/websockets.md): Learn how to use WebSockets for instant email notifications without webhooks or polling.
|
|
47
47
|
- [WebSockets Quickstart](https://docs.agentmail.to/websockets/quickstart.md): Get started with real-time email event streaming
|
|
48
48
|
- [Email Deliverability](https://docs.agentmail.to/email-deliverability.md): Learn the strategies and best practices for maximizing your email deliverability with AgentMail.
|
|
49
|
-
- [Idempotent Requests](https://docs.agentmail.to/idempotency.md): A guide to
|
|
49
|
+
- [Idempotent Requests](https://docs.agentmail.to/idempotency.md): A guide to preventing duplicate resources with client_id and preventing duplicate email sends with the Idempotency-Key header.
|
|
50
50
|
- [Example: Event-Driven Agent](https://docs.agentmail.to/webhook-agent.md): A step-by-step guide to building a sophisticated agent that performs proactive outreach and uses webhooks for inbound message processing.
|
|
51
51
|
- [Auto-Reply Email Agent](https://docs.agentmail.to/documentation/examples/auto-reply-agent.md): Build a simple agent that automatically responds to incoming emails with personalized messages
|
|
52
52
|
- [Smart Email Labeling Agent](https://docs.agentmail.to/documentation/examples/smart-labeling-agent.md): Build an AI-powered agent that automatically classifies and labels incoming emails across multiple dimensions
|
|
53
53
|
- [Sales Agent with WebSocket](https://docs.agentmail.to/sales-agent-websocket.md): A step-by-step guide to building an AI-powered sales agent that uses WebSocket for real-time email processing without polling or webhooks.
|
|
54
54
|
- [Live AgentMail Examples](https://docs.agentmail.to/documentation/examples/live-agent-mail-examples.md)
|
|
55
55
|
- [Frequently Asked Questions (FAQ)](https://docs.agentmail.to/faq.md): Find answers to common questions about AgentMail, from core concepts to best practices and security.
|
|
56
|
+
- [Error Reference](https://docs.agentmail.to/errors.md): Every AgentMail API error code, what it means, and how to fix it.
|
|
56
57
|
- [Email Reply Extraction with Talon](https://docs.agentmail.to/talon-reply-extraction.md): Learn how to use Talon to extract new content from email replies, removing quoted text with 93.8% accuracy.
|
|
57
58
|
- [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.
|
|
58
59
|
- [Support](https://docs.agentmail.to/support.md): Get help with AgentMail through our support channels.
|
|
@@ -116,9 +117,6 @@
|
|
|
116
117
|
- API Reference > Inboxes > Messages [Reply To Message](https://docs.agentmail.to/api-reference/inboxes/messages/reply.md)
|
|
117
118
|
- API Reference > Inboxes > Messages [Reply All Message](https://docs.agentmail.to/api-reference/inboxes/messages/reply-all.md)
|
|
118
119
|
- API Reference > Inboxes > Messages [Forward Message](https://docs.agentmail.to/api-reference/inboxes/messages/forward.md)
|
|
119
|
-
- API Reference > Inboxes > Messages [Create Draft Reply](https://docs.agentmail.to/api-reference/inboxes/messages/draft-reply.md)
|
|
120
|
-
- API Reference > Inboxes > Messages [Create Draft Reply All](https://docs.agentmail.to/api-reference/inboxes/messages/draft-reply-all.md)
|
|
121
|
-
- API Reference > Inboxes > Messages [Create Draft Forward](https://docs.agentmail.to/api-reference/inboxes/messages/draft-forward.md)
|
|
122
120
|
- API Reference > Inboxes > Drafts [List Drafts](https://docs.agentmail.to/api-reference/inboxes/drafts/list.md)
|
|
123
121
|
- API Reference > Inboxes > Drafts [Get Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/get.md)
|
|
124
122
|
- API Reference > Inboxes > Drafts [Get Attachment](https://docs.agentmail.to/api-reference/inboxes/drafts/get-attachment.md)
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1295,6 +1295,356 @@ await client.apiKeys.delete("api_key_id");
|
|
|
1295
1295
|
</dl>
|
|
1296
1296
|
|
|
1297
1297
|
|
|
1298
|
+
</dd>
|
|
1299
|
+
</dl>
|
|
1300
|
+
</details>
|
|
1301
|
+
|
|
1302
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">listPublicKeys</a>({ ...params }) -> AgentMail.ListPublicKeysResponse</code></summary>
|
|
1303
|
+
<dl>
|
|
1304
|
+
<dd>
|
|
1305
|
+
|
|
1306
|
+
#### 📝 Description
|
|
1307
|
+
|
|
1308
|
+
<dl>
|
|
1309
|
+
<dd>
|
|
1310
|
+
|
|
1311
|
+
<dl>
|
|
1312
|
+
<dd>
|
|
1313
|
+
|
|
1314
|
+
List only public-key credentials visible to the bearer caller's scope.
|
|
1315
|
+
Bearer credentials are never returned, even though both credential types
|
|
1316
|
+
share storage and pagination indexes. Requires `api_key_read`.
|
|
1317
|
+
</dd>
|
|
1318
|
+
</dl>
|
|
1319
|
+
</dd>
|
|
1320
|
+
</dl>
|
|
1321
|
+
|
|
1322
|
+
#### 🔌 Usage
|
|
1323
|
+
|
|
1324
|
+
<dl>
|
|
1325
|
+
<dd>
|
|
1326
|
+
|
|
1327
|
+
<dl>
|
|
1328
|
+
<dd>
|
|
1329
|
+
|
|
1330
|
+
```typescript
|
|
1331
|
+
await client.apiKeys.listPublicKeys();
|
|
1332
|
+
|
|
1333
|
+
```
|
|
1334
|
+
</dd>
|
|
1335
|
+
</dl>
|
|
1336
|
+
</dd>
|
|
1337
|
+
</dl>
|
|
1338
|
+
|
|
1339
|
+
#### ⚙️ Parameters
|
|
1340
|
+
|
|
1341
|
+
<dl>
|
|
1342
|
+
<dd>
|
|
1343
|
+
|
|
1344
|
+
<dl>
|
|
1345
|
+
<dd>
|
|
1346
|
+
|
|
1347
|
+
**request:** `AgentMail.ListPublicKeysRequest`
|
|
1348
|
+
|
|
1349
|
+
</dd>
|
|
1350
|
+
</dl>
|
|
1351
|
+
|
|
1352
|
+
<dl>
|
|
1353
|
+
<dd>
|
|
1354
|
+
|
|
1355
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1356
|
+
|
|
1357
|
+
</dd>
|
|
1358
|
+
</dl>
|
|
1359
|
+
</dd>
|
|
1360
|
+
</dl>
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
</dd>
|
|
1364
|
+
</dl>
|
|
1365
|
+
</details>
|
|
1366
|
+
|
|
1367
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">createPublicKey</a>({ ...params }) -> AgentMail.PublicKeyCredential</code></summary>
|
|
1368
|
+
<dl>
|
|
1369
|
+
<dd>
|
|
1370
|
+
|
|
1371
|
+
#### 📝 Description
|
|
1372
|
+
|
|
1373
|
+
<dl>
|
|
1374
|
+
<dd>
|
|
1375
|
+
|
|
1376
|
+
<dl>
|
|
1377
|
+
<dd>
|
|
1378
|
+
|
|
1379
|
+
Register a public P-256 JWK using an existing AgentMail bearer API key
|
|
1380
|
+
with `api_key_create`. Re-registering the same JWK creates a new
|
|
1381
|
+
credential ID; it does not replace or recover an earlier credential.
|
|
1382
|
+
The private key must never be sent to AgentMail.
|
|
1383
|
+
</dd>
|
|
1384
|
+
</dl>
|
|
1385
|
+
</dd>
|
|
1386
|
+
</dl>
|
|
1387
|
+
|
|
1388
|
+
#### 🔌 Usage
|
|
1389
|
+
|
|
1390
|
+
<dl>
|
|
1391
|
+
<dd>
|
|
1392
|
+
|
|
1393
|
+
<dl>
|
|
1394
|
+
<dd>
|
|
1395
|
+
|
|
1396
|
+
```typescript
|
|
1397
|
+
await client.apiKeys.createPublicKey({
|
|
1398
|
+
publicKey: {
|
|
1399
|
+
kty: "EC",
|
|
1400
|
+
crv: "P-256",
|
|
1401
|
+
x: "blackcurrant...............................",
|
|
1402
|
+
y: "blackcurrant..............................."
|
|
1403
|
+
}
|
|
1404
|
+
});
|
|
1405
|
+
|
|
1406
|
+
```
|
|
1407
|
+
</dd>
|
|
1408
|
+
</dl>
|
|
1409
|
+
</dd>
|
|
1410
|
+
</dl>
|
|
1411
|
+
|
|
1412
|
+
#### ⚙️ Parameters
|
|
1413
|
+
|
|
1414
|
+
<dl>
|
|
1415
|
+
<dd>
|
|
1416
|
+
|
|
1417
|
+
<dl>
|
|
1418
|
+
<dd>
|
|
1419
|
+
|
|
1420
|
+
**request:** `AgentMail.CreatePublicKeyRequest`
|
|
1421
|
+
|
|
1422
|
+
</dd>
|
|
1423
|
+
</dl>
|
|
1424
|
+
|
|
1425
|
+
<dl>
|
|
1426
|
+
<dd>
|
|
1427
|
+
|
|
1428
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1429
|
+
|
|
1430
|
+
</dd>
|
|
1431
|
+
</dl>
|
|
1432
|
+
</dd>
|
|
1433
|
+
</dl>
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
</dd>
|
|
1437
|
+
</dl>
|
|
1438
|
+
</details>
|
|
1439
|
+
|
|
1440
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">updatePublicKeyName</a>(api_key_id, { ...params }) -> AgentMail.PublicKeyCredential</code></summary>
|
|
1441
|
+
<dl>
|
|
1442
|
+
<dd>
|
|
1443
|
+
|
|
1444
|
+
#### 📝 Description
|
|
1445
|
+
|
|
1446
|
+
<dl>
|
|
1447
|
+
<dd>
|
|
1448
|
+
|
|
1449
|
+
<dl>
|
|
1450
|
+
<dd>
|
|
1451
|
+
|
|
1452
|
+
Rename the credential. All security-relevant fields are immutable.
|
|
1453
|
+
Requires `api_key_update`.
|
|
1454
|
+
</dd>
|
|
1455
|
+
</dl>
|
|
1456
|
+
</dd>
|
|
1457
|
+
</dl>
|
|
1458
|
+
|
|
1459
|
+
#### 🔌 Usage
|
|
1460
|
+
|
|
1461
|
+
<dl>
|
|
1462
|
+
<dd>
|
|
1463
|
+
|
|
1464
|
+
<dl>
|
|
1465
|
+
<dd>
|
|
1466
|
+
|
|
1467
|
+
```typescript
|
|
1468
|
+
await client.apiKeys.updatePublicKeyName("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", {
|
|
1469
|
+
name: "x"
|
|
1470
|
+
});
|
|
1471
|
+
|
|
1472
|
+
```
|
|
1473
|
+
</dd>
|
|
1474
|
+
</dl>
|
|
1475
|
+
</dd>
|
|
1476
|
+
</dl>
|
|
1477
|
+
|
|
1478
|
+
#### ⚙️ Parameters
|
|
1479
|
+
|
|
1480
|
+
<dl>
|
|
1481
|
+
<dd>
|
|
1482
|
+
|
|
1483
|
+
<dl>
|
|
1484
|
+
<dd>
|
|
1485
|
+
|
|
1486
|
+
**api_key_id:** `string` — Public-key credential ID returned by registration.
|
|
1487
|
+
|
|
1488
|
+
</dd>
|
|
1489
|
+
</dl>
|
|
1490
|
+
|
|
1491
|
+
<dl>
|
|
1492
|
+
<dd>
|
|
1493
|
+
|
|
1494
|
+
**request:** `AgentMail.UpdatePublicKeyNameRequest`
|
|
1495
|
+
|
|
1496
|
+
</dd>
|
|
1497
|
+
</dl>
|
|
1498
|
+
|
|
1499
|
+
<dl>
|
|
1500
|
+
<dd>
|
|
1501
|
+
|
|
1502
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1503
|
+
|
|
1504
|
+
</dd>
|
|
1505
|
+
</dl>
|
|
1506
|
+
</dd>
|
|
1507
|
+
</dl>
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
</dd>
|
|
1511
|
+
</dl>
|
|
1512
|
+
</details>
|
|
1513
|
+
|
|
1514
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">revokePublicKey</a>(api_key_id) -> void</code></summary>
|
|
1515
|
+
<dl>
|
|
1516
|
+
<dd>
|
|
1517
|
+
|
|
1518
|
+
#### 📝 Description
|
|
1519
|
+
|
|
1520
|
+
<dl>
|
|
1521
|
+
<dd>
|
|
1522
|
+
|
|
1523
|
+
<dl>
|
|
1524
|
+
<dd>
|
|
1525
|
+
|
|
1526
|
+
Permanently revoke one public-key credential. This hard-deletes the
|
|
1527
|
+
credential; repeating the request returns not found. Requires
|
|
1528
|
+
`api_key_delete`.
|
|
1529
|
+
</dd>
|
|
1530
|
+
</dl>
|
|
1531
|
+
</dd>
|
|
1532
|
+
</dl>
|
|
1533
|
+
|
|
1534
|
+
#### 🔌 Usage
|
|
1535
|
+
|
|
1536
|
+
<dl>
|
|
1537
|
+
<dd>
|
|
1538
|
+
|
|
1539
|
+
<dl>
|
|
1540
|
+
<dd>
|
|
1541
|
+
|
|
1542
|
+
```typescript
|
|
1543
|
+
await client.apiKeys.revokePublicKey("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
1544
|
+
|
|
1545
|
+
```
|
|
1546
|
+
</dd>
|
|
1547
|
+
</dl>
|
|
1548
|
+
</dd>
|
|
1549
|
+
</dl>
|
|
1550
|
+
|
|
1551
|
+
#### ⚙️ Parameters
|
|
1552
|
+
|
|
1553
|
+
<dl>
|
|
1554
|
+
<dd>
|
|
1555
|
+
|
|
1556
|
+
<dl>
|
|
1557
|
+
<dd>
|
|
1558
|
+
|
|
1559
|
+
**api_key_id:** `string` — Public-key credential ID returned by registration.
|
|
1560
|
+
|
|
1561
|
+
</dd>
|
|
1562
|
+
</dl>
|
|
1563
|
+
|
|
1564
|
+
<dl>
|
|
1565
|
+
<dd>
|
|
1566
|
+
|
|
1567
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1568
|
+
|
|
1569
|
+
</dd>
|
|
1570
|
+
</dl>
|
|
1571
|
+
</dd>
|
|
1572
|
+
</dl>
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
</dd>
|
|
1576
|
+
</dl>
|
|
1577
|
+
</details>
|
|
1578
|
+
|
|
1579
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">revokeAllAgentIdSignInKeys</a>({ ...params }) -> AgentMail.RevokeAllAgentIdSignInKeysResponse</code></summary>
|
|
1580
|
+
<dl>
|
|
1581
|
+
<dd>
|
|
1582
|
+
|
|
1583
|
+
#### 📝 Description
|
|
1584
|
+
|
|
1585
|
+
<dl>
|
|
1586
|
+
<dd>
|
|
1587
|
+
|
|
1588
|
+
<dl>
|
|
1589
|
+
<dd>
|
|
1590
|
+
|
|
1591
|
+
Invalidate every current public-key credential in the caller's
|
|
1592
|
+
organization by advancing its AgentID key generation. The caller must be
|
|
1593
|
+
organization-scoped and either have `api_key_delete` or, for a verified
|
|
1594
|
+
self-serve agent organization, use an unrestricted unmanaged bearer
|
|
1595
|
+
credential. No request body is accepted.
|
|
1596
|
+
|
|
1597
|
+
`Idempotency-Key` is required and must be a UUID. Reusing the same UUID
|
|
1598
|
+
returns the original permanent receipt without advancing the generation
|
|
1599
|
+
again. A new UUID performs a new generation advance.
|
|
1600
|
+
</dd>
|
|
1601
|
+
</dl>
|
|
1602
|
+
</dd>
|
|
1603
|
+
</dl>
|
|
1604
|
+
|
|
1605
|
+
#### 🔌 Usage
|
|
1606
|
+
|
|
1607
|
+
<dl>
|
|
1608
|
+
<dd>
|
|
1609
|
+
|
|
1610
|
+
<dl>
|
|
1611
|
+
<dd>
|
|
1612
|
+
|
|
1613
|
+
```typescript
|
|
1614
|
+
await client.apiKeys.revokeAllAgentIdSignInKeys({
|
|
1615
|
+
idempotencyKey: "Idempotency-Key"
|
|
1616
|
+
});
|
|
1617
|
+
|
|
1618
|
+
```
|
|
1619
|
+
</dd>
|
|
1620
|
+
</dl>
|
|
1621
|
+
</dd>
|
|
1622
|
+
</dl>
|
|
1623
|
+
|
|
1624
|
+
#### ⚙️ Parameters
|
|
1625
|
+
|
|
1626
|
+
<dl>
|
|
1627
|
+
<dd>
|
|
1628
|
+
|
|
1629
|
+
<dl>
|
|
1630
|
+
<dd>
|
|
1631
|
+
|
|
1632
|
+
**request:** `AgentMail.RevokeAllAgentIdSignInKeysRequest`
|
|
1633
|
+
|
|
1634
|
+
</dd>
|
|
1635
|
+
</dl>
|
|
1636
|
+
|
|
1637
|
+
<dl>
|
|
1638
|
+
<dd>
|
|
1639
|
+
|
|
1640
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1641
|
+
|
|
1642
|
+
</dd>
|
|
1643
|
+
</dl>
|
|
1644
|
+
</dd>
|
|
1645
|
+
</dl>
|
|
1646
|
+
|
|
1647
|
+
|
|
1298
1648
|
</dd>
|
|
1299
1649
|
</dl>
|
|
1300
1650
|
</details>
|
|
@@ -4833,7 +5183,7 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
|
4833
5183
|
</dl>
|
|
4834
5184
|
</details>
|
|
4835
5185
|
|
|
4836
|
-
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">delete</a>(inbox_id, thread_id
|
|
5186
|
+
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">delete</a>(inbox_id, thread_id) -> void</code></summary>
|
|
4837
5187
|
<dl>
|
|
4838
5188
|
<dd>
|
|
4839
5189
|
|
|
@@ -4845,7 +5195,7 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
|
4845
5195
|
<dl>
|
|
4846
5196
|
<dd>
|
|
4847
5197
|
|
|
4848
|
-
|
|
5198
|
+
Permanently deletes a thread and all of its messages.
|
|
4849
5199
|
|
|
4850
5200
|
**CLI:**
|
|
4851
5201
|
```bash
|
|
@@ -4897,14 +5247,6 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
|
4897
5247
|
<dl>
|
|
4898
5248
|
<dd>
|
|
4899
5249
|
|
|
4900
|
-
**request:** `AgentMail.inboxes.DeleteThreadRequest`
|
|
4901
|
-
|
|
4902
|
-
</dd>
|
|
4903
|
-
</dl>
|
|
4904
|
-
|
|
4905
|
-
<dl>
|
|
4906
|
-
<dd>
|
|
4907
|
-
|
|
4908
5250
|
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
4909
5251
|
|
|
4910
5252
|
</dd>
|
|
@@ -8107,7 +8449,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
8107
8449
|
</dl>
|
|
8108
8450
|
</details>
|
|
8109
8451
|
|
|
8110
|
-
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">delete</a>(pod_id, thread_id
|
|
8452
|
+
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">delete</a>(pod_id, thread_id) -> void</code></summary>
|
|
8111
8453
|
<dl>
|
|
8112
8454
|
<dd>
|
|
8113
8455
|
|
|
@@ -8119,7 +8461,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
8119
8461
|
<dl>
|
|
8120
8462
|
<dd>
|
|
8121
8463
|
|
|
8122
|
-
|
|
8464
|
+
Permanently deletes a thread and all of its messages.
|
|
8123
8465
|
|
|
8124
8466
|
**CLI:**
|
|
8125
8467
|
```bash
|
|
@@ -8171,14 +8513,6 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
8171
8513
|
<dl>
|
|
8172
8514
|
<dd>
|
|
8173
8515
|
|
|
8174
|
-
**request:** `AgentMail.pods.DeleteThreadRequest`
|
|
8175
|
-
|
|
8176
|
-
</dd>
|
|
8177
|
-
</dl>
|
|
8178
|
-
|
|
8179
|
-
<dl>
|
|
8180
|
-
<dd>
|
|
8181
|
-
|
|
8182
8516
|
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
8183
8517
|
|
|
8184
8518
|
</dd>
|
|
@@ -8928,7 +9262,7 @@ await client.threads.update("thread_id", {});
|
|
|
8928
9262
|
</dl>
|
|
8929
9263
|
</details>
|
|
8930
9264
|
|
|
8931
|
-
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">delete</a>(thread_id
|
|
9265
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">delete</a>(thread_id) -> void</code></summary>
|
|
8932
9266
|
<dl>
|
|
8933
9267
|
<dd>
|
|
8934
9268
|
|
|
@@ -8940,7 +9274,7 @@ await client.threads.update("thread_id", {});
|
|
|
8940
9274
|
<dl>
|
|
8941
9275
|
<dd>
|
|
8942
9276
|
|
|
8943
|
-
|
|
9277
|
+
Permanently deletes a thread and all of its messages.
|
|
8944
9278
|
|
|
8945
9279
|
**CLI:**
|
|
8946
9280
|
```bash
|
|
@@ -8984,14 +9318,6 @@ await client.threads.delete("thread_id");
|
|
|
8984
9318
|
<dl>
|
|
8985
9319
|
<dd>
|
|
8986
9320
|
|
|
8987
|
-
**request:** `AgentMail.DeleteThreadRequest`
|
|
8988
|
-
|
|
8989
|
-
</dd>
|
|
8990
|
-
</dl>
|
|
8991
|
-
|
|
8992
|
-
<dl>
|
|
8993
|
-
<dd>
|
|
8994
|
-
|
|
8995
9321
|
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
8996
9322
|
|
|
8997
9323
|
</dd>
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|