agentmail 0.4.10 → 0.4.11
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/types/ApiKey.d.ts +1 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyPermissions.d.ts +75 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyPermissions.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/CreateApiKeyRequest.d.ts +1 -0
- package/dist/cjs/api/resources/apiKeys/types/CreateApiKeyResponse.d.ts +1 -0
- package/dist/cjs/api/resources/apiKeys/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/apiKeys/types/index.js +1 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKey.d.ts +2 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKey.js +2 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyPermissions.d.ts +43 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyPermissions.js +75 -0
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.js +2 -0
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyResponse.d.ts +2 -0
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyResponse.js +2 -0
- package/dist/cjs/serialization/resources/apiKeys/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/apiKeys/types/index.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/apiKeys/types/ApiKey.d.mts +1 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeyPermissions.d.mts +75 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeyPermissions.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/CreateApiKeyRequest.d.mts +1 -0
- package/dist/esm/api/resources/apiKeys/types/CreateApiKeyResponse.d.mts +1 -0
- package/dist/esm/api/resources/apiKeys/types/index.d.mts +1 -0
- package/dist/esm/api/resources/apiKeys/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKey.d.mts +2 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKey.mjs +2 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyPermissions.d.mts +43 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyPermissions.mjs +39 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.mjs +2 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyResponse.d.mts +2 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyResponse.mjs +2 -0
- package/dist/esm/serialization/resources/apiKeys/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/apiKeys/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms-full.txt +252 -67
- package/package.json +1 -1
package/dist/llms-full.txt
CHANGED
|
@@ -3983,6 +3983,15 @@ description: AgentMail's MPP integration for machine-to-machine payments via Str
|
|
|
3983
3983
|
|
|
3984
3984
|
[MPP (Machine Payments Protocol)](https://mpp.dev) is Stripe's open protocol that enables machine-to-machine payments. By integrating MPP with AgentMail, your agents can pay for API usage directly without managing API keys or subscriptions.
|
|
3985
3985
|
|
|
3986
|
+
### Base URLs
|
|
3987
|
+
|
|
3988
|
+
To authenticate with MPP instead of an API key, you must use the MPP-specific base URLs below. These replace the default AgentMail base URLs and route requests through the MPP payment layer.
|
|
3989
|
+
|
|
3990
|
+
| Protocol | URL |
|
|
3991
|
+
| --------- | ---------------------- |
|
|
3992
|
+
| HTTP | `mpp.api.agentmail.to` |
|
|
3993
|
+
| WebSocket | `mpp.ws.agentmail.to` |
|
|
3994
|
+
|
|
3986
3995
|
### Prerequisites
|
|
3987
3996
|
|
|
3988
3997
|
* A crypto wallet with funds (EVM-compatible wallet)
|
|
@@ -11272,6 +11281,10 @@ components:
|
|
|
11272
11281
|
type: string
|
|
11273
11282
|
description: The ID of the inbox.
|
|
11274
11283
|
title: InboxId
|
|
11284
|
+
type_inboxes:Email:
|
|
11285
|
+
type: string
|
|
11286
|
+
description: Email address of the inbox.
|
|
11287
|
+
title: Email
|
|
11275
11288
|
type_inboxes:DisplayName:
|
|
11276
11289
|
type: string
|
|
11277
11290
|
description: 'Display name: `Display Name <username@domain.com>`.'
|
|
@@ -11287,6 +11300,8 @@ components:
|
|
|
11287
11300
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
11288
11301
|
inbox_id:
|
|
11289
11302
|
$ref: '#/components/schemas/type_inboxes:InboxId'
|
|
11303
|
+
email:
|
|
11304
|
+
$ref: '#/components/schemas/type_inboxes:Email'
|
|
11290
11305
|
display_name:
|
|
11291
11306
|
$ref: '#/components/schemas/type_inboxes:DisplayName'
|
|
11292
11307
|
client_id:
|
|
@@ -11302,6 +11317,7 @@ components:
|
|
|
11302
11317
|
required:
|
|
11303
11318
|
- pod_id
|
|
11304
11319
|
- inbox_id
|
|
11320
|
+
- email
|
|
11305
11321
|
- updated_at
|
|
11306
11322
|
- created_at
|
|
11307
11323
|
title: Inbox
|
|
@@ -11517,6 +11533,10 @@ components:
|
|
|
11517
11533
|
type: string
|
|
11518
11534
|
description: ID of pod.
|
|
11519
11535
|
title: PodId
|
|
11536
|
+
type_inboxes:Email:
|
|
11537
|
+
type: string
|
|
11538
|
+
description: Email address of the inbox.
|
|
11539
|
+
title: Email
|
|
11520
11540
|
type_inboxes:DisplayName:
|
|
11521
11541
|
type: string
|
|
11522
11542
|
description: 'Display name: `Display Name <username@domain.com>`.'
|
|
@@ -11532,6 +11552,8 @@ components:
|
|
|
11532
11552
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
11533
11553
|
inbox_id:
|
|
11534
11554
|
$ref: '#/components/schemas/type_inboxes:InboxId'
|
|
11555
|
+
email:
|
|
11556
|
+
$ref: '#/components/schemas/type_inboxes:Email'
|
|
11535
11557
|
display_name:
|
|
11536
11558
|
$ref: '#/components/schemas/type_inboxes:DisplayName'
|
|
11537
11559
|
client_id:
|
|
@@ -11547,6 +11569,7 @@ components:
|
|
|
11547
11569
|
required:
|
|
11548
11570
|
- pod_id
|
|
11549
11571
|
- inbox_id
|
|
11572
|
+
- email
|
|
11550
11573
|
- updated_at
|
|
11551
11574
|
- created_at
|
|
11552
11575
|
title: Inbox
|
|
@@ -11790,6 +11813,10 @@ components:
|
|
|
11790
11813
|
type: string
|
|
11791
11814
|
description: The ID of the inbox.
|
|
11792
11815
|
title: InboxId
|
|
11816
|
+
type_inboxes:Email:
|
|
11817
|
+
type: string
|
|
11818
|
+
description: Email address of the inbox.
|
|
11819
|
+
title: Email
|
|
11793
11820
|
type_inboxes:Inbox:
|
|
11794
11821
|
type: object
|
|
11795
11822
|
properties:
|
|
@@ -11797,6 +11824,8 @@ components:
|
|
|
11797
11824
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
11798
11825
|
inbox_id:
|
|
11799
11826
|
$ref: '#/components/schemas/type_inboxes:InboxId'
|
|
11827
|
+
email:
|
|
11828
|
+
$ref: '#/components/schemas/type_inboxes:Email'
|
|
11800
11829
|
display_name:
|
|
11801
11830
|
$ref: '#/components/schemas/type_inboxes:DisplayName'
|
|
11802
11831
|
client_id:
|
|
@@ -11812,6 +11841,7 @@ components:
|
|
|
11812
11841
|
required:
|
|
11813
11842
|
- pod_id
|
|
11814
11843
|
- inbox_id
|
|
11844
|
+
- email
|
|
11815
11845
|
- updated_at
|
|
11816
11846
|
- created_at
|
|
11817
11847
|
title: Inbox
|
|
@@ -12050,6 +12080,10 @@ components:
|
|
|
12050
12080
|
type: string
|
|
12051
12081
|
description: ID of pod.
|
|
12052
12082
|
title: PodId
|
|
12083
|
+
type_inboxes:Email:
|
|
12084
|
+
type: string
|
|
12085
|
+
description: Email address of the inbox.
|
|
12086
|
+
title: Email
|
|
12053
12087
|
type_inboxes:ClientId:
|
|
12054
12088
|
type: string
|
|
12055
12089
|
description: Client ID of inbox.
|
|
@@ -12061,6 +12095,8 @@ components:
|
|
|
12061
12095
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
12062
12096
|
inbox_id:
|
|
12063
12097
|
$ref: '#/components/schemas/type_inboxes:InboxId'
|
|
12098
|
+
email:
|
|
12099
|
+
$ref: '#/components/schemas/type_inboxes:Email'
|
|
12064
12100
|
display_name:
|
|
12065
12101
|
$ref: '#/components/schemas/type_inboxes:DisplayName'
|
|
12066
12102
|
client_id:
|
|
@@ -12076,6 +12112,7 @@ components:
|
|
|
12076
12112
|
required:
|
|
12077
12113
|
- pod_id
|
|
12078
12114
|
- inbox_id
|
|
12115
|
+
- email
|
|
12079
12116
|
- updated_at
|
|
12080
12117
|
- created_at
|
|
12081
12118
|
title: Inbox
|
|
@@ -22182,7 +22219,7 @@ dataTask.resume()
|
|
|
22182
22219
|
|
|
22183
22220
|
# Delete API Key
|
|
22184
22221
|
|
|
22185
|
-
DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/api-keys/{
|
|
22222
|
+
DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/api-keys/{api_key_id}
|
|
22186
22223
|
|
|
22187
22224
|
Reference: https://docs.agentmail.to/api-reference/inboxes/api-keys/delete
|
|
22188
22225
|
|
|
@@ -22194,7 +22231,7 @@ info:
|
|
|
22194
22231
|
title: api
|
|
22195
22232
|
version: 1.0.0
|
|
22196
22233
|
paths:
|
|
22197
|
-
/v0/inboxes/{inbox_id}/api-keys/{
|
|
22234
|
+
/v0/inboxes/{inbox_id}/api-keys/{api_key_id}:
|
|
22198
22235
|
delete:
|
|
22199
22236
|
operationId: delete
|
|
22200
22237
|
summary: Delete API Key
|
|
@@ -22206,7 +22243,7 @@ paths:
|
|
|
22206
22243
|
required: true
|
|
22207
22244
|
schema:
|
|
22208
22245
|
$ref: '#/components/schemas/type_inboxes:InboxId'
|
|
22209
|
-
- name:
|
|
22246
|
+
- name: api_key_id
|
|
22210
22247
|
in: path
|
|
22211
22248
|
required: true
|
|
22212
22249
|
schema:
|
|
@@ -22276,7 +22313,7 @@ async function main() {
|
|
|
22276
22313
|
const client = new AgentMailClient({
|
|
22277
22314
|
apiKey: "YOUR_TOKEN_HERE",
|
|
22278
22315
|
});
|
|
22279
|
-
await client.inboxes.apiKeys.delete("inbox_id", "
|
|
22316
|
+
await client.inboxes.apiKeys.delete("inbox_id", "api_key_id");
|
|
22280
22317
|
}
|
|
22281
22318
|
main();
|
|
22282
22319
|
|
|
@@ -22291,7 +22328,7 @@ client = AgentMail(
|
|
|
22291
22328
|
|
|
22292
22329
|
client.inboxes.api_keys.delete(
|
|
22293
22330
|
inbox_id="inbox_id",
|
|
22294
|
-
|
|
22331
|
+
api_key_id="api_key_id",
|
|
22295
22332
|
)
|
|
22296
22333
|
|
|
22297
22334
|
```
|
|
@@ -22307,7 +22344,7 @@ import (
|
|
|
22307
22344
|
|
|
22308
22345
|
func main() {
|
|
22309
22346
|
|
|
22310
|
-
url := "https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/
|
|
22347
|
+
url := "https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/api_key_id"
|
|
22311
22348
|
|
|
22312
22349
|
req, _ := http.NewRequest("DELETE", url, nil)
|
|
22313
22350
|
|
|
@@ -22328,7 +22365,7 @@ func main() {
|
|
|
22328
22365
|
require 'uri'
|
|
22329
22366
|
require 'net/http'
|
|
22330
22367
|
|
|
22331
|
-
url = URI("https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/
|
|
22368
|
+
url = URI("https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/api_key_id")
|
|
22332
22369
|
|
|
22333
22370
|
http = Net::HTTP.new(url.host, url.port)
|
|
22334
22371
|
http.use_ssl = true
|
|
@@ -22344,7 +22381,7 @@ puts response.read_body
|
|
|
22344
22381
|
import com.mashape.unirest.http.HttpResponse;
|
|
22345
22382
|
import com.mashape.unirest.http.Unirest;
|
|
22346
22383
|
|
|
22347
|
-
HttpResponse<String> response = Unirest.delete("https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/
|
|
22384
|
+
HttpResponse<String> response = Unirest.delete("https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/api_key_id")
|
|
22348
22385
|
.header("Authorization", "Bearer <api_key>")
|
|
22349
22386
|
.asString();
|
|
22350
22387
|
```
|
|
@@ -22355,7 +22392,7 @@ require_once('vendor/autoload.php');
|
|
|
22355
22392
|
|
|
22356
22393
|
$client = new \GuzzleHttp\Client();
|
|
22357
22394
|
|
|
22358
|
-
$response = $client->request('DELETE', 'https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/
|
|
22395
|
+
$response = $client->request('DELETE', 'https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/api_key_id', [
|
|
22359
22396
|
'headers' => [
|
|
22360
22397
|
'Authorization' => 'Bearer <api_key>',
|
|
22361
22398
|
],
|
|
@@ -22367,7 +22404,7 @@ echo $response->getBody();
|
|
|
22367
22404
|
```csharp
|
|
22368
22405
|
using RestSharp;
|
|
22369
22406
|
|
|
22370
|
-
var client = new RestClient("https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/
|
|
22407
|
+
var client = new RestClient("https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/api_key_id");
|
|
22371
22408
|
var request = new RestRequest(Method.DELETE);
|
|
22372
22409
|
request.AddHeader("Authorization", "Bearer <api_key>");
|
|
22373
22410
|
IRestResponse response = client.Execute(request);
|
|
@@ -22378,7 +22415,7 @@ import Foundation
|
|
|
22378
22415
|
|
|
22379
22416
|
let headers = ["Authorization": "Bearer <api_key>"]
|
|
22380
22417
|
|
|
22381
|
-
let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/
|
|
22418
|
+
let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentmail.to/v0/inboxes/inbox_id/api-keys/api_key_id")! as URL,
|
|
22382
22419
|
cachePolicy: .useProtocolCachePolicy,
|
|
22383
22420
|
timeoutInterval: 10.0)
|
|
22384
22421
|
request.httpMethod = "DELETE"
|
|
@@ -27658,8 +27695,12 @@ components:
|
|
|
27658
27695
|
title: PodId
|
|
27659
27696
|
type_domains:DomainId:
|
|
27660
27697
|
type: string
|
|
27661
|
-
description: The
|
|
27698
|
+
description: The ID of the domain.
|
|
27662
27699
|
title: DomainId
|
|
27700
|
+
type_domains:DomainName:
|
|
27701
|
+
type: string
|
|
27702
|
+
description: The name of the domain (e.g., `example.com`).
|
|
27703
|
+
title: DomainName
|
|
27663
27704
|
type_domains:VerificationStatus:
|
|
27664
27705
|
type: string
|
|
27665
27706
|
enum:
|
|
@@ -27670,6 +27711,10 @@ components:
|
|
|
27670
27711
|
- VERIFYING
|
|
27671
27712
|
- VERIFIED
|
|
27672
27713
|
title: VerificationStatus
|
|
27714
|
+
type_domains:Status:
|
|
27715
|
+
$ref: '#/components/schemas/type_domains:VerificationStatus'
|
|
27716
|
+
description: The verification status of the domain.
|
|
27717
|
+
title: Status
|
|
27673
27718
|
type_domains:FeedbackEnabled:
|
|
27674
27719
|
type: boolean
|
|
27675
27720
|
description: Bounce and complaint notifications are sent to your inboxes.
|
|
@@ -27723,9 +27768,10 @@ components:
|
|
|
27723
27768
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
27724
27769
|
domain_id:
|
|
27725
27770
|
$ref: '#/components/schemas/type_domains:DomainId'
|
|
27771
|
+
domain:
|
|
27772
|
+
$ref: '#/components/schemas/type_domains:DomainName'
|
|
27726
27773
|
status:
|
|
27727
|
-
$ref: '#/components/schemas/type_domains:
|
|
27728
|
-
description: The verification status of the domain.
|
|
27774
|
+
$ref: '#/components/schemas/type_domains:Status'
|
|
27729
27775
|
feedback_enabled:
|
|
27730
27776
|
$ref: '#/components/schemas/type_domains:FeedbackEnabled'
|
|
27731
27777
|
records:
|
|
@@ -27745,6 +27791,7 @@ components:
|
|
|
27745
27791
|
description: Time at which the domain was created.
|
|
27746
27792
|
required:
|
|
27747
27793
|
- domain_id
|
|
27794
|
+
- domain
|
|
27748
27795
|
- status
|
|
27749
27796
|
- feedback_enabled
|
|
27750
27797
|
- records
|
|
@@ -28551,8 +28598,12 @@ components:
|
|
|
28551
28598
|
title: PodId
|
|
28552
28599
|
type_domains:DomainId:
|
|
28553
28600
|
type: string
|
|
28554
|
-
description: The
|
|
28601
|
+
description: The ID of the domain.
|
|
28555
28602
|
title: DomainId
|
|
28603
|
+
type_domains:DomainName:
|
|
28604
|
+
type: string
|
|
28605
|
+
description: The name of the domain (e.g., `example.com`).
|
|
28606
|
+
title: DomainName
|
|
28556
28607
|
type_domains:VerificationStatus:
|
|
28557
28608
|
type: string
|
|
28558
28609
|
enum:
|
|
@@ -28563,6 +28614,10 @@ components:
|
|
|
28563
28614
|
- VERIFYING
|
|
28564
28615
|
- VERIFIED
|
|
28565
28616
|
title: VerificationStatus
|
|
28617
|
+
type_domains:Status:
|
|
28618
|
+
$ref: '#/components/schemas/type_domains:VerificationStatus'
|
|
28619
|
+
description: The verification status of the domain.
|
|
28620
|
+
title: Status
|
|
28566
28621
|
type_domains:FeedbackEnabled:
|
|
28567
28622
|
type: boolean
|
|
28568
28623
|
description: Bounce and complaint notifications are sent to your inboxes.
|
|
@@ -28616,9 +28671,10 @@ components:
|
|
|
28616
28671
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
28617
28672
|
domain_id:
|
|
28618
28673
|
$ref: '#/components/schemas/type_domains:DomainId'
|
|
28674
|
+
domain:
|
|
28675
|
+
$ref: '#/components/schemas/type_domains:DomainName'
|
|
28619
28676
|
status:
|
|
28620
|
-
$ref: '#/components/schemas/type_domains:
|
|
28621
|
-
description: The verification status of the domain.
|
|
28677
|
+
$ref: '#/components/schemas/type_domains:Status'
|
|
28622
28678
|
feedback_enabled:
|
|
28623
28679
|
$ref: '#/components/schemas/type_domains:FeedbackEnabled'
|
|
28624
28680
|
records:
|
|
@@ -28638,6 +28694,7 @@ components:
|
|
|
28638
28694
|
description: Time at which the domain was created.
|
|
28639
28695
|
required:
|
|
28640
28696
|
- domain_id
|
|
28697
|
+
- domain
|
|
28641
28698
|
- status
|
|
28642
28699
|
- feedback_enabled
|
|
28643
28700
|
- records
|
|
@@ -28786,8 +28843,26 @@ components:
|
|
|
28786
28843
|
title: PodId
|
|
28787
28844
|
type_domains:DomainId:
|
|
28788
28845
|
type: string
|
|
28789
|
-
description: The
|
|
28846
|
+
description: The ID of the domain.
|
|
28790
28847
|
title: DomainId
|
|
28848
|
+
type_domains:DomainName:
|
|
28849
|
+
type: string
|
|
28850
|
+
description: The name of the domain (e.g., `example.com`).
|
|
28851
|
+
title: DomainName
|
|
28852
|
+
type_domains:VerificationStatus:
|
|
28853
|
+
type: string
|
|
28854
|
+
enum:
|
|
28855
|
+
- NOT_STARTED
|
|
28856
|
+
- PENDING
|
|
28857
|
+
- INVALID
|
|
28858
|
+
- FAILED
|
|
28859
|
+
- VERIFYING
|
|
28860
|
+
- VERIFIED
|
|
28861
|
+
title: VerificationStatus
|
|
28862
|
+
type_domains:Status:
|
|
28863
|
+
$ref: '#/components/schemas/type_domains:VerificationStatus'
|
|
28864
|
+
description: The verification status of the domain.
|
|
28865
|
+
title: Status
|
|
28791
28866
|
type_domains:FeedbackEnabled:
|
|
28792
28867
|
type: boolean
|
|
28793
28868
|
description: Bounce and complaint notifications are sent to your inboxes.
|
|
@@ -28803,6 +28878,10 @@ components:
|
|
|
28803
28878
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
28804
28879
|
domain_id:
|
|
28805
28880
|
$ref: '#/components/schemas/type_domains:DomainId'
|
|
28881
|
+
domain:
|
|
28882
|
+
$ref: '#/components/schemas/type_domains:DomainName'
|
|
28883
|
+
status:
|
|
28884
|
+
$ref: '#/components/schemas/type_domains:Status'
|
|
28806
28885
|
feedback_enabled:
|
|
28807
28886
|
$ref: '#/components/schemas/type_domains:FeedbackEnabled'
|
|
28808
28887
|
client_id:
|
|
@@ -28817,6 +28896,8 @@ components:
|
|
|
28817
28896
|
description: Time at which the domain was created.
|
|
28818
28897
|
required:
|
|
28819
28898
|
- domain_id
|
|
28899
|
+
- domain
|
|
28900
|
+
- status
|
|
28820
28901
|
- feedback_enabled
|
|
28821
28902
|
- updated_at
|
|
28822
28903
|
- created_at
|
|
@@ -29027,12 +29108,16 @@ components:
|
|
|
29027
29108
|
schemas:
|
|
29028
29109
|
type_domains:DomainId:
|
|
29029
29110
|
type: string
|
|
29030
|
-
description: The
|
|
29111
|
+
description: The ID of the domain.
|
|
29031
29112
|
title: DomainId
|
|
29032
29113
|
type_pods:PodId:
|
|
29033
29114
|
type: string
|
|
29034
29115
|
description: ID of pod.
|
|
29035
29116
|
title: PodId
|
|
29117
|
+
type_domains:DomainName:
|
|
29118
|
+
type: string
|
|
29119
|
+
description: The name of the domain (e.g., `example.com`).
|
|
29120
|
+
title: DomainName
|
|
29036
29121
|
type_domains:VerificationStatus:
|
|
29037
29122
|
type: string
|
|
29038
29123
|
enum:
|
|
@@ -29043,6 +29128,10 @@ components:
|
|
|
29043
29128
|
- VERIFYING
|
|
29044
29129
|
- VERIFIED
|
|
29045
29130
|
title: VerificationStatus
|
|
29131
|
+
type_domains:Status:
|
|
29132
|
+
$ref: '#/components/schemas/type_domains:VerificationStatus'
|
|
29133
|
+
description: The verification status of the domain.
|
|
29134
|
+
title: Status
|
|
29046
29135
|
type_domains:FeedbackEnabled:
|
|
29047
29136
|
type: boolean
|
|
29048
29137
|
description: Bounce and complaint notifications are sent to your inboxes.
|
|
@@ -29096,9 +29185,10 @@ components:
|
|
|
29096
29185
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
29097
29186
|
domain_id:
|
|
29098
29187
|
$ref: '#/components/schemas/type_domains:DomainId'
|
|
29188
|
+
domain:
|
|
29189
|
+
$ref: '#/components/schemas/type_domains:DomainName'
|
|
29099
29190
|
status:
|
|
29100
|
-
$ref: '#/components/schemas/type_domains:
|
|
29101
|
-
description: The verification status of the domain.
|
|
29191
|
+
$ref: '#/components/schemas/type_domains:Status'
|
|
29102
29192
|
feedback_enabled:
|
|
29103
29193
|
$ref: '#/components/schemas/type_domains:FeedbackEnabled'
|
|
29104
29194
|
records:
|
|
@@ -29118,6 +29208,7 @@ components:
|
|
|
29118
29208
|
description: Time at which the domain was created.
|
|
29119
29209
|
required:
|
|
29120
29210
|
- domain_id
|
|
29211
|
+
- domain
|
|
29121
29212
|
- status
|
|
29122
29213
|
- feedback_enabled
|
|
29123
29214
|
- records
|
|
@@ -29334,7 +29425,7 @@ components:
|
|
|
29334
29425
|
schemas:
|
|
29335
29426
|
type_domains:DomainId:
|
|
29336
29427
|
type: string
|
|
29337
|
-
description: The
|
|
29428
|
+
description: The ID of the domain.
|
|
29338
29429
|
title: DomainId
|
|
29339
29430
|
type_:ErrorName:
|
|
29340
29431
|
type: string
|
|
@@ -29546,7 +29637,7 @@ components:
|
|
|
29546
29637
|
schemas:
|
|
29547
29638
|
type_domains:DomainName:
|
|
29548
29639
|
type: string
|
|
29549
|
-
description: The name of the domain
|
|
29640
|
+
description: The name of the domain (e.g., `example.com`).
|
|
29550
29641
|
title: DomainName
|
|
29551
29642
|
type_domains:FeedbackEnabled:
|
|
29552
29643
|
type: boolean
|
|
@@ -29569,7 +29660,7 @@ components:
|
|
|
29569
29660
|
title: PodId
|
|
29570
29661
|
type_domains:DomainId:
|
|
29571
29662
|
type: string
|
|
29572
|
-
description: The
|
|
29663
|
+
description: The ID of the domain.
|
|
29573
29664
|
title: DomainId
|
|
29574
29665
|
type_domains:VerificationStatus:
|
|
29575
29666
|
type: string
|
|
@@ -29581,6 +29672,10 @@ components:
|
|
|
29581
29672
|
- VERIFYING
|
|
29582
29673
|
- VERIFIED
|
|
29583
29674
|
title: VerificationStatus
|
|
29675
|
+
type_domains:Status:
|
|
29676
|
+
$ref: '#/components/schemas/type_domains:VerificationStatus'
|
|
29677
|
+
description: The verification status of the domain.
|
|
29678
|
+
title: Status
|
|
29584
29679
|
type_domains:RecordType:
|
|
29585
29680
|
type: string
|
|
29586
29681
|
enum:
|
|
@@ -29630,9 +29725,10 @@ components:
|
|
|
29630
29725
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
29631
29726
|
domain_id:
|
|
29632
29727
|
$ref: '#/components/schemas/type_domains:DomainId'
|
|
29728
|
+
domain:
|
|
29729
|
+
$ref: '#/components/schemas/type_domains:DomainName'
|
|
29633
29730
|
status:
|
|
29634
|
-
$ref: '#/components/schemas/type_domains:
|
|
29635
|
-
description: The verification status of the domain.
|
|
29731
|
+
$ref: '#/components/schemas/type_domains:Status'
|
|
29636
29732
|
feedback_enabled:
|
|
29637
29733
|
$ref: '#/components/schemas/type_domains:FeedbackEnabled'
|
|
29638
29734
|
records:
|
|
@@ -29652,6 +29748,7 @@ components:
|
|
|
29652
29748
|
description: Time at which the domain was created.
|
|
29653
29749
|
required:
|
|
29654
29750
|
- domain_id
|
|
29751
|
+
- domain
|
|
29655
29752
|
- status
|
|
29656
29753
|
- feedback_enabled
|
|
29657
29754
|
- records
|
|
@@ -29898,7 +29995,7 @@ components:
|
|
|
29898
29995
|
schemas:
|
|
29899
29996
|
type_domains:DomainId:
|
|
29900
29997
|
type: string
|
|
29901
|
-
description: The
|
|
29998
|
+
description: The ID of the domain.
|
|
29902
29999
|
title: DomainId
|
|
29903
30000
|
type_domains:FeedbackEnabled:
|
|
29904
30001
|
type: boolean
|
|
@@ -29914,6 +30011,10 @@ components:
|
|
|
29914
30011
|
type: string
|
|
29915
30012
|
description: ID of pod.
|
|
29916
30013
|
title: PodId
|
|
30014
|
+
type_domains:DomainName:
|
|
30015
|
+
type: string
|
|
30016
|
+
description: The name of the domain (e.g., `example.com`).
|
|
30017
|
+
title: DomainName
|
|
29917
30018
|
type_domains:VerificationStatus:
|
|
29918
30019
|
type: string
|
|
29919
30020
|
enum:
|
|
@@ -29924,6 +30025,10 @@ components:
|
|
|
29924
30025
|
- VERIFYING
|
|
29925
30026
|
- VERIFIED
|
|
29926
30027
|
title: VerificationStatus
|
|
30028
|
+
type_domains:Status:
|
|
30029
|
+
$ref: '#/components/schemas/type_domains:VerificationStatus'
|
|
30030
|
+
description: The verification status of the domain.
|
|
30031
|
+
title: Status
|
|
29927
30032
|
type_domains:RecordType:
|
|
29928
30033
|
type: string
|
|
29929
30034
|
enum:
|
|
@@ -29973,9 +30078,10 @@ components:
|
|
|
29973
30078
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
29974
30079
|
domain_id:
|
|
29975
30080
|
$ref: '#/components/schemas/type_domains:DomainId'
|
|
30081
|
+
domain:
|
|
30082
|
+
$ref: '#/components/schemas/type_domains:DomainName'
|
|
29976
30083
|
status:
|
|
29977
|
-
$ref: '#/components/schemas/type_domains:
|
|
29978
|
-
description: The verification status of the domain.
|
|
30084
|
+
$ref: '#/components/schemas/type_domains:Status'
|
|
29979
30085
|
feedback_enabled:
|
|
29980
30086
|
$ref: '#/components/schemas/type_domains:FeedbackEnabled'
|
|
29981
30087
|
records:
|
|
@@ -29995,6 +30101,7 @@ components:
|
|
|
29995
30101
|
description: Time at which the domain was created.
|
|
29996
30102
|
required:
|
|
29997
30103
|
- domain_id
|
|
30104
|
+
- domain
|
|
29998
30105
|
- status
|
|
29999
30106
|
- feedback_enabled
|
|
30000
30107
|
- records
|
|
@@ -30225,7 +30332,7 @@ components:
|
|
|
30225
30332
|
schemas:
|
|
30226
30333
|
type_domains:DomainId:
|
|
30227
30334
|
type: string
|
|
30228
|
-
description: The
|
|
30335
|
+
description: The ID of the domain.
|
|
30229
30336
|
title: DomainId
|
|
30230
30337
|
type_:ErrorName:
|
|
30231
30338
|
type: string
|
|
@@ -30432,7 +30539,7 @@ components:
|
|
|
30432
30539
|
schemas:
|
|
30433
30540
|
type_domains:DomainId:
|
|
30434
30541
|
type: string
|
|
30435
|
-
description: The
|
|
30542
|
+
description: The ID of the domain.
|
|
30436
30543
|
title: DomainId
|
|
30437
30544
|
type_:ErrorName:
|
|
30438
30545
|
type: string
|
|
@@ -32523,7 +32630,7 @@ dataTask.resume()
|
|
|
32523
32630
|
|
|
32524
32631
|
# Delete API Key
|
|
32525
32632
|
|
|
32526
|
-
DELETE https://api.agentmail.to/v0/api-keys/{
|
|
32633
|
+
DELETE https://api.agentmail.to/v0/api-keys/{api_key_id}
|
|
32527
32634
|
|
|
32528
32635
|
Reference: https://docs.agentmail.to/api-reference/api-keys/delete
|
|
32529
32636
|
|
|
@@ -32535,14 +32642,14 @@ info:
|
|
|
32535
32642
|
title: api
|
|
32536
32643
|
version: 1.0.0
|
|
32537
32644
|
paths:
|
|
32538
|
-
/v0/api-keys/{
|
|
32645
|
+
/v0/api-keys/{api_key_id}:
|
|
32539
32646
|
delete:
|
|
32540
32647
|
operationId: delete
|
|
32541
32648
|
summary: Delete API Key
|
|
32542
32649
|
tags:
|
|
32543
32650
|
- subpackage_api-keys
|
|
32544
32651
|
parameters:
|
|
32545
|
-
- name:
|
|
32652
|
+
- name: api_key_id
|
|
32546
32653
|
in: path
|
|
32547
32654
|
required: true
|
|
32548
32655
|
schema:
|
|
@@ -32608,7 +32715,7 @@ async function main() {
|
|
|
32608
32715
|
const client = new AgentMailClient({
|
|
32609
32716
|
apiKey: "YOUR_TOKEN_HERE",
|
|
32610
32717
|
});
|
|
32611
|
-
await client.apiKeys.delete("
|
|
32718
|
+
await client.apiKeys.delete("api_key_id");
|
|
32612
32719
|
}
|
|
32613
32720
|
main();
|
|
32614
32721
|
|
|
@@ -32622,7 +32729,7 @@ client = AgentMail(
|
|
|
32622
32729
|
)
|
|
32623
32730
|
|
|
32624
32731
|
client.api_keys.delete(
|
|
32625
|
-
|
|
32732
|
+
api_key_id="api_key_id",
|
|
32626
32733
|
)
|
|
32627
32734
|
|
|
32628
32735
|
```
|
|
@@ -32638,7 +32745,7 @@ import (
|
|
|
32638
32745
|
|
|
32639
32746
|
func main() {
|
|
32640
32747
|
|
|
32641
|
-
url := "https://api.agentmail.to/v0/api-keys/
|
|
32748
|
+
url := "https://api.agentmail.to/v0/api-keys/api_key_id"
|
|
32642
32749
|
|
|
32643
32750
|
req, _ := http.NewRequest("DELETE", url, nil)
|
|
32644
32751
|
|
|
@@ -32659,7 +32766,7 @@ func main() {
|
|
|
32659
32766
|
require 'uri'
|
|
32660
32767
|
require 'net/http'
|
|
32661
32768
|
|
|
32662
|
-
url = URI("https://api.agentmail.to/v0/api-keys/
|
|
32769
|
+
url = URI("https://api.agentmail.to/v0/api-keys/api_key_id")
|
|
32663
32770
|
|
|
32664
32771
|
http = Net::HTTP.new(url.host, url.port)
|
|
32665
32772
|
http.use_ssl = true
|
|
@@ -32675,7 +32782,7 @@ puts response.read_body
|
|
|
32675
32782
|
import com.mashape.unirest.http.HttpResponse;
|
|
32676
32783
|
import com.mashape.unirest.http.Unirest;
|
|
32677
32784
|
|
|
32678
|
-
HttpResponse<String> response = Unirest.delete("https://api.agentmail.to/v0/api-keys/
|
|
32785
|
+
HttpResponse<String> response = Unirest.delete("https://api.agentmail.to/v0/api-keys/api_key_id")
|
|
32679
32786
|
.header("Authorization", "Bearer <api_key>")
|
|
32680
32787
|
.asString();
|
|
32681
32788
|
```
|
|
@@ -32686,7 +32793,7 @@ require_once('vendor/autoload.php');
|
|
|
32686
32793
|
|
|
32687
32794
|
$client = new \GuzzleHttp\Client();
|
|
32688
32795
|
|
|
32689
|
-
$response = $client->request('DELETE', 'https://api.agentmail.to/v0/api-keys/
|
|
32796
|
+
$response = $client->request('DELETE', 'https://api.agentmail.to/v0/api-keys/api_key_id', [
|
|
32690
32797
|
'headers' => [
|
|
32691
32798
|
'Authorization' => 'Bearer <api_key>',
|
|
32692
32799
|
],
|
|
@@ -32698,7 +32805,7 @@ echo $response->getBody();
|
|
|
32698
32805
|
```csharp
|
|
32699
32806
|
using RestSharp;
|
|
32700
32807
|
|
|
32701
|
-
var client = new RestClient("https://api.agentmail.to/v0/api-keys/
|
|
32808
|
+
var client = new RestClient("https://api.agentmail.to/v0/api-keys/api_key_id");
|
|
32702
32809
|
var request = new RestRequest(Method.DELETE);
|
|
32703
32810
|
request.AddHeader("Authorization", "Bearer <api_key>");
|
|
32704
32811
|
IRestResponse response = client.Execute(request);
|
|
@@ -32709,7 +32816,7 @@ import Foundation
|
|
|
32709
32816
|
|
|
32710
32817
|
let headers = ["Authorization": "Bearer <api_key>"]
|
|
32711
32818
|
|
|
32712
|
-
let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentmail.to/v0/api-keys/
|
|
32819
|
+
let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentmail.to/v0/api-keys/api_key_id")! as URL,
|
|
32713
32820
|
cachePolicy: .useProtocolCachePolicy,
|
|
32714
32821
|
timeoutInterval: 10.0)
|
|
32715
32822
|
request.httpMethod = "DELETE"
|
|
@@ -33791,6 +33898,10 @@ components:
|
|
|
33791
33898
|
type: string
|
|
33792
33899
|
description: The ID of the inbox.
|
|
33793
33900
|
title: InboxId
|
|
33901
|
+
type_inboxes:Email:
|
|
33902
|
+
type: string
|
|
33903
|
+
description: Email address of the inbox.
|
|
33904
|
+
title: Email
|
|
33794
33905
|
type_inboxes:DisplayName:
|
|
33795
33906
|
type: string
|
|
33796
33907
|
description: 'Display name: `Display Name <username@domain.com>`.'
|
|
@@ -33806,6 +33917,8 @@ components:
|
|
|
33806
33917
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
33807
33918
|
inbox_id:
|
|
33808
33919
|
$ref: '#/components/schemas/type_inboxes:InboxId'
|
|
33920
|
+
email:
|
|
33921
|
+
$ref: '#/components/schemas/type_inboxes:Email'
|
|
33809
33922
|
display_name:
|
|
33810
33923
|
$ref: '#/components/schemas/type_inboxes:DisplayName'
|
|
33811
33924
|
client_id:
|
|
@@ -33821,6 +33934,7 @@ components:
|
|
|
33821
33934
|
required:
|
|
33822
33935
|
- pod_id
|
|
33823
33936
|
- inbox_id
|
|
33937
|
+
- email
|
|
33824
33938
|
- updated_at
|
|
33825
33939
|
- created_at
|
|
33826
33940
|
title: Inbox
|
|
@@ -34062,6 +34176,10 @@ components:
|
|
|
34062
34176
|
type: string
|
|
34063
34177
|
description: The ID of the inbox.
|
|
34064
34178
|
title: InboxId
|
|
34179
|
+
type_inboxes:Email:
|
|
34180
|
+
type: string
|
|
34181
|
+
description: Email address of the inbox.
|
|
34182
|
+
title: Email
|
|
34065
34183
|
type_inboxes:DisplayName:
|
|
34066
34184
|
type: string
|
|
34067
34185
|
description: 'Display name: `Display Name <username@domain.com>`.'
|
|
@@ -34077,6 +34195,8 @@ components:
|
|
|
34077
34195
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
34078
34196
|
inbox_id:
|
|
34079
34197
|
$ref: '#/components/schemas/type_inboxes:InboxId'
|
|
34198
|
+
email:
|
|
34199
|
+
$ref: '#/components/schemas/type_inboxes:Email'
|
|
34080
34200
|
display_name:
|
|
34081
34201
|
$ref: '#/components/schemas/type_inboxes:DisplayName'
|
|
34082
34202
|
client_id:
|
|
@@ -34092,6 +34212,7 @@ components:
|
|
|
34092
34212
|
required:
|
|
34093
34213
|
- pod_id
|
|
34094
34214
|
- inbox_id
|
|
34215
|
+
- email
|
|
34095
34216
|
- updated_at
|
|
34096
34217
|
- created_at
|
|
34097
34218
|
title: Inbox
|
|
@@ -34341,6 +34462,10 @@ components:
|
|
|
34341
34462
|
type: string
|
|
34342
34463
|
description: The ID of the inbox.
|
|
34343
34464
|
title: InboxId
|
|
34465
|
+
type_inboxes:Email:
|
|
34466
|
+
type: string
|
|
34467
|
+
description: Email address of the inbox.
|
|
34468
|
+
title: Email
|
|
34344
34469
|
type_inboxes:Inbox:
|
|
34345
34470
|
type: object
|
|
34346
34471
|
properties:
|
|
@@ -34348,6 +34473,8 @@ components:
|
|
|
34348
34473
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
34349
34474
|
inbox_id:
|
|
34350
34475
|
$ref: '#/components/schemas/type_inboxes:InboxId'
|
|
34476
|
+
email:
|
|
34477
|
+
$ref: '#/components/schemas/type_inboxes:Email'
|
|
34351
34478
|
display_name:
|
|
34352
34479
|
$ref: '#/components/schemas/type_inboxes:DisplayName'
|
|
34353
34480
|
client_id:
|
|
@@ -34363,6 +34490,7 @@ components:
|
|
|
34363
34490
|
required:
|
|
34364
34491
|
- pod_id
|
|
34365
34492
|
- inbox_id
|
|
34493
|
+
- email
|
|
34366
34494
|
- updated_at
|
|
34367
34495
|
- created_at
|
|
34368
34496
|
title: Inbox
|
|
@@ -34619,6 +34747,10 @@ components:
|
|
|
34619
34747
|
required:
|
|
34620
34748
|
- display_name
|
|
34621
34749
|
title: UpdateInboxRequest
|
|
34750
|
+
type_inboxes:Email:
|
|
34751
|
+
type: string
|
|
34752
|
+
description: Email address of the inbox.
|
|
34753
|
+
title: Email
|
|
34622
34754
|
type_inboxes:ClientId:
|
|
34623
34755
|
type: string
|
|
34624
34756
|
description: Client ID of inbox.
|
|
@@ -34630,6 +34762,8 @@ components:
|
|
|
34630
34762
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
34631
34763
|
inbox_id:
|
|
34632
34764
|
$ref: '#/components/schemas/type_inboxes:InboxId'
|
|
34765
|
+
email:
|
|
34766
|
+
$ref: '#/components/schemas/type_inboxes:Email'
|
|
34633
34767
|
display_name:
|
|
34634
34768
|
$ref: '#/components/schemas/type_inboxes:DisplayName'
|
|
34635
34769
|
client_id:
|
|
@@ -34645,6 +34779,7 @@ components:
|
|
|
34645
34779
|
required:
|
|
34646
34780
|
- pod_id
|
|
34647
34781
|
- inbox_id
|
|
34782
|
+
- email
|
|
34648
34783
|
- updated_at
|
|
34649
34784
|
- created_at
|
|
34650
34785
|
title: Inbox
|
|
@@ -37839,8 +37974,26 @@ components:
|
|
|
37839
37974
|
title: Count
|
|
37840
37975
|
type_domains:DomainId:
|
|
37841
37976
|
type: string
|
|
37842
|
-
description: The
|
|
37977
|
+
description: The ID of the domain.
|
|
37843
37978
|
title: DomainId
|
|
37979
|
+
type_domains:DomainName:
|
|
37980
|
+
type: string
|
|
37981
|
+
description: The name of the domain (e.g., `example.com`).
|
|
37982
|
+
title: DomainName
|
|
37983
|
+
type_domains:VerificationStatus:
|
|
37984
|
+
type: string
|
|
37985
|
+
enum:
|
|
37986
|
+
- NOT_STARTED
|
|
37987
|
+
- PENDING
|
|
37988
|
+
- INVALID
|
|
37989
|
+
- FAILED
|
|
37990
|
+
- VERIFYING
|
|
37991
|
+
- VERIFIED
|
|
37992
|
+
title: VerificationStatus
|
|
37993
|
+
type_domains:Status:
|
|
37994
|
+
$ref: '#/components/schemas/type_domains:VerificationStatus'
|
|
37995
|
+
description: The verification status of the domain.
|
|
37996
|
+
title: Status
|
|
37844
37997
|
type_domains:FeedbackEnabled:
|
|
37845
37998
|
type: boolean
|
|
37846
37999
|
description: Bounce and complaint notifications are sent to your inboxes.
|
|
@@ -37856,6 +38009,10 @@ components:
|
|
|
37856
38009
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
37857
38010
|
domain_id:
|
|
37858
38011
|
$ref: '#/components/schemas/type_domains:DomainId'
|
|
38012
|
+
domain:
|
|
38013
|
+
$ref: '#/components/schemas/type_domains:DomainName'
|
|
38014
|
+
status:
|
|
38015
|
+
$ref: '#/components/schemas/type_domains:Status'
|
|
37859
38016
|
feedback_enabled:
|
|
37860
38017
|
$ref: '#/components/schemas/type_domains:FeedbackEnabled'
|
|
37861
38018
|
client_id:
|
|
@@ -37870,6 +38027,8 @@ components:
|
|
|
37870
38027
|
description: Time at which the domain was created.
|
|
37871
38028
|
required:
|
|
37872
38029
|
- domain_id
|
|
38030
|
+
- domain
|
|
38031
|
+
- status
|
|
37873
38032
|
- feedback_enabled
|
|
37874
38033
|
- updated_at
|
|
37875
38034
|
- created_at
|
|
@@ -38110,8 +38269,12 @@ components:
|
|
|
38110
38269
|
title: PodId
|
|
38111
38270
|
type_domains:DomainId:
|
|
38112
38271
|
type: string
|
|
38113
|
-
description: The
|
|
38272
|
+
description: The ID of the domain.
|
|
38114
38273
|
title: DomainId
|
|
38274
|
+
type_domains:DomainName:
|
|
38275
|
+
type: string
|
|
38276
|
+
description: The name of the domain (e.g., `example.com`).
|
|
38277
|
+
title: DomainName
|
|
38115
38278
|
type_domains:VerificationStatus:
|
|
38116
38279
|
type: string
|
|
38117
38280
|
enum:
|
|
@@ -38122,6 +38285,10 @@ components:
|
|
|
38122
38285
|
- VERIFYING
|
|
38123
38286
|
- VERIFIED
|
|
38124
38287
|
title: VerificationStatus
|
|
38288
|
+
type_domains:Status:
|
|
38289
|
+
$ref: '#/components/schemas/type_domains:VerificationStatus'
|
|
38290
|
+
description: The verification status of the domain.
|
|
38291
|
+
title: Status
|
|
38125
38292
|
type_domains:FeedbackEnabled:
|
|
38126
38293
|
type: boolean
|
|
38127
38294
|
description: Bounce and complaint notifications are sent to your inboxes.
|
|
@@ -38175,9 +38342,10 @@ components:
|
|
|
38175
38342
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
38176
38343
|
domain_id:
|
|
38177
38344
|
$ref: '#/components/schemas/type_domains:DomainId'
|
|
38345
|
+
domain:
|
|
38346
|
+
$ref: '#/components/schemas/type_domains:DomainName'
|
|
38178
38347
|
status:
|
|
38179
|
-
$ref: '#/components/schemas/type_domains:
|
|
38180
|
-
description: The verification status of the domain.
|
|
38348
|
+
$ref: '#/components/schemas/type_domains:Status'
|
|
38181
38349
|
feedback_enabled:
|
|
38182
38350
|
$ref: '#/components/schemas/type_domains:FeedbackEnabled'
|
|
38183
38351
|
records:
|
|
@@ -38197,6 +38365,7 @@ components:
|
|
|
38197
38365
|
description: Time at which the domain was created.
|
|
38198
38366
|
required:
|
|
38199
38367
|
- domain_id
|
|
38368
|
+
- domain
|
|
38200
38369
|
- status
|
|
38201
38370
|
- feedback_enabled
|
|
38202
38371
|
- records
|
|
@@ -38423,7 +38592,7 @@ components:
|
|
|
38423
38592
|
title: PodId
|
|
38424
38593
|
type_domains:DomainId:
|
|
38425
38594
|
type: string
|
|
38426
|
-
description: The
|
|
38595
|
+
description: The ID of the domain.
|
|
38427
38596
|
title: DomainId
|
|
38428
38597
|
type_:ErrorName:
|
|
38429
38598
|
type: string
|
|
@@ -38645,7 +38814,7 @@ components:
|
|
|
38645
38814
|
title: PodId
|
|
38646
38815
|
type_domains:DomainName:
|
|
38647
38816
|
type: string
|
|
38648
|
-
description: The name of the domain
|
|
38817
|
+
description: The name of the domain (e.g., `example.com`).
|
|
38649
38818
|
title: DomainName
|
|
38650
38819
|
type_domains:FeedbackEnabled:
|
|
38651
38820
|
type: boolean
|
|
@@ -38664,7 +38833,7 @@ components:
|
|
|
38664
38833
|
title: CreateDomainRequest
|
|
38665
38834
|
type_domains:DomainId:
|
|
38666
38835
|
type: string
|
|
38667
|
-
description: The
|
|
38836
|
+
description: The ID of the domain.
|
|
38668
38837
|
title: DomainId
|
|
38669
38838
|
type_domains:VerificationStatus:
|
|
38670
38839
|
type: string
|
|
@@ -38676,6 +38845,10 @@ components:
|
|
|
38676
38845
|
- VERIFYING
|
|
38677
38846
|
- VERIFIED
|
|
38678
38847
|
title: VerificationStatus
|
|
38848
|
+
type_domains:Status:
|
|
38849
|
+
$ref: '#/components/schemas/type_domains:VerificationStatus'
|
|
38850
|
+
description: The verification status of the domain.
|
|
38851
|
+
title: Status
|
|
38679
38852
|
type_domains:RecordType:
|
|
38680
38853
|
type: string
|
|
38681
38854
|
enum:
|
|
@@ -38725,9 +38898,10 @@ components:
|
|
|
38725
38898
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
38726
38899
|
domain_id:
|
|
38727
38900
|
$ref: '#/components/schemas/type_domains:DomainId'
|
|
38901
|
+
domain:
|
|
38902
|
+
$ref: '#/components/schemas/type_domains:DomainName'
|
|
38728
38903
|
status:
|
|
38729
|
-
$ref: '#/components/schemas/type_domains:
|
|
38730
|
-
description: The verification status of the domain.
|
|
38904
|
+
$ref: '#/components/schemas/type_domains:Status'
|
|
38731
38905
|
feedback_enabled:
|
|
38732
38906
|
$ref: '#/components/schemas/type_domains:FeedbackEnabled'
|
|
38733
38907
|
records:
|
|
@@ -38747,6 +38921,7 @@ components:
|
|
|
38747
38921
|
description: Time at which the domain was created.
|
|
38748
38922
|
required:
|
|
38749
38923
|
- domain_id
|
|
38924
|
+
- domain
|
|
38750
38925
|
- status
|
|
38751
38926
|
- feedback_enabled
|
|
38752
38927
|
- records
|
|
@@ -39003,7 +39178,7 @@ components:
|
|
|
39003
39178
|
title: PodId
|
|
39004
39179
|
type_domains:DomainId:
|
|
39005
39180
|
type: string
|
|
39006
|
-
description: The
|
|
39181
|
+
description: The ID of the domain.
|
|
39007
39182
|
title: DomainId
|
|
39008
39183
|
type_domains:FeedbackEnabled:
|
|
39009
39184
|
type: boolean
|
|
@@ -39015,6 +39190,10 @@ components:
|
|
|
39015
39190
|
feedback_enabled:
|
|
39016
39191
|
$ref: '#/components/schemas/type_domains:FeedbackEnabled'
|
|
39017
39192
|
title: UpdateDomainRequest
|
|
39193
|
+
type_domains:DomainName:
|
|
39194
|
+
type: string
|
|
39195
|
+
description: The name of the domain (e.g., `example.com`).
|
|
39196
|
+
title: DomainName
|
|
39018
39197
|
type_domains:VerificationStatus:
|
|
39019
39198
|
type: string
|
|
39020
39199
|
enum:
|
|
@@ -39025,6 +39204,10 @@ components:
|
|
|
39025
39204
|
- VERIFYING
|
|
39026
39205
|
- VERIFIED
|
|
39027
39206
|
title: VerificationStatus
|
|
39207
|
+
type_domains:Status:
|
|
39208
|
+
$ref: '#/components/schemas/type_domains:VerificationStatus'
|
|
39209
|
+
description: The verification status of the domain.
|
|
39210
|
+
title: Status
|
|
39028
39211
|
type_domains:RecordType:
|
|
39029
39212
|
type: string
|
|
39030
39213
|
enum:
|
|
@@ -39074,9 +39257,10 @@ components:
|
|
|
39074
39257
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
39075
39258
|
domain_id:
|
|
39076
39259
|
$ref: '#/components/schemas/type_domains:DomainId'
|
|
39260
|
+
domain:
|
|
39261
|
+
$ref: '#/components/schemas/type_domains:DomainName'
|
|
39077
39262
|
status:
|
|
39078
|
-
$ref: '#/components/schemas/type_domains:
|
|
39079
|
-
description: The verification status of the domain.
|
|
39263
|
+
$ref: '#/components/schemas/type_domains:Status'
|
|
39080
39264
|
feedback_enabled:
|
|
39081
39265
|
$ref: '#/components/schemas/type_domains:FeedbackEnabled'
|
|
39082
39266
|
records:
|
|
@@ -39096,6 +39280,7 @@ components:
|
|
|
39096
39280
|
description: Time at which the domain was created.
|
|
39097
39281
|
required:
|
|
39098
39282
|
- domain_id
|
|
39283
|
+
- domain
|
|
39099
39284
|
- status
|
|
39100
39285
|
- feedback_enabled
|
|
39101
39286
|
- records
|
|
@@ -39336,7 +39521,7 @@ components:
|
|
|
39336
39521
|
title: PodId
|
|
39337
39522
|
type_domains:DomainId:
|
|
39338
39523
|
type: string
|
|
39339
|
-
description: The
|
|
39524
|
+
description: The ID of the domain.
|
|
39340
39525
|
title: DomainId
|
|
39341
39526
|
type_:ErrorName:
|
|
39342
39527
|
type: string
|
|
@@ -39553,7 +39738,7 @@ components:
|
|
|
39553
39738
|
title: PodId
|
|
39554
39739
|
type_domains:DomainId:
|
|
39555
39740
|
type: string
|
|
39556
|
-
description: The
|
|
39741
|
+
description: The ID of the domain.
|
|
39557
39742
|
title: DomainId
|
|
39558
39743
|
type_:ErrorName:
|
|
39559
39744
|
type: string
|
|
@@ -41775,7 +41960,7 @@ dataTask.resume()
|
|
|
41775
41960
|
|
|
41776
41961
|
# Delete API Key
|
|
41777
41962
|
|
|
41778
|
-
DELETE https://api.agentmail.to/v0/pods/{pod_id}/api-keys/{
|
|
41963
|
+
DELETE https://api.agentmail.to/v0/pods/{pod_id}/api-keys/{api_key_id}
|
|
41779
41964
|
|
|
41780
41965
|
Reference: https://docs.agentmail.to/api-reference/pods/api-keys/delete
|
|
41781
41966
|
|
|
@@ -41787,7 +41972,7 @@ info:
|
|
|
41787
41972
|
title: api
|
|
41788
41973
|
version: 1.0.0
|
|
41789
41974
|
paths:
|
|
41790
|
-
/v0/pods/{pod_id}/api-keys/{
|
|
41975
|
+
/v0/pods/{pod_id}/api-keys/{api_key_id}:
|
|
41791
41976
|
delete:
|
|
41792
41977
|
operationId: delete
|
|
41793
41978
|
summary: Delete API Key
|
|
@@ -41799,7 +41984,7 @@ paths:
|
|
|
41799
41984
|
required: true
|
|
41800
41985
|
schema:
|
|
41801
41986
|
$ref: '#/components/schemas/type_pods:PodId'
|
|
41802
|
-
- name:
|
|
41987
|
+
- name: api_key_id
|
|
41803
41988
|
in: path
|
|
41804
41989
|
required: true
|
|
41805
41990
|
schema:
|
|
@@ -41869,7 +42054,7 @@ async function main() {
|
|
|
41869
42054
|
const client = new AgentMailClient({
|
|
41870
42055
|
apiKey: "YOUR_TOKEN_HERE",
|
|
41871
42056
|
});
|
|
41872
|
-
await client.pods.apiKeys.delete("pod_id", "
|
|
42057
|
+
await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
41873
42058
|
}
|
|
41874
42059
|
main();
|
|
41875
42060
|
|
|
@@ -41884,7 +42069,7 @@ client = AgentMail(
|
|
|
41884
42069
|
|
|
41885
42070
|
client.pods.api_keys.delete(
|
|
41886
42071
|
pod_id="pod_id",
|
|
41887
|
-
|
|
42072
|
+
api_key_id="api_key_id",
|
|
41888
42073
|
)
|
|
41889
42074
|
|
|
41890
42075
|
```
|
|
@@ -41900,7 +42085,7 @@ import (
|
|
|
41900
42085
|
|
|
41901
42086
|
func main() {
|
|
41902
42087
|
|
|
41903
|
-
url := "https://api.agentmail.to/v0/pods/pod_id/api-keys/
|
|
42088
|
+
url := "https://api.agentmail.to/v0/pods/pod_id/api-keys/api_key_id"
|
|
41904
42089
|
|
|
41905
42090
|
req, _ := http.NewRequest("DELETE", url, nil)
|
|
41906
42091
|
|
|
@@ -41921,7 +42106,7 @@ func main() {
|
|
|
41921
42106
|
require 'uri'
|
|
41922
42107
|
require 'net/http'
|
|
41923
42108
|
|
|
41924
|
-
url = URI("https://api.agentmail.to/v0/pods/pod_id/api-keys/
|
|
42109
|
+
url = URI("https://api.agentmail.to/v0/pods/pod_id/api-keys/api_key_id")
|
|
41925
42110
|
|
|
41926
42111
|
http = Net::HTTP.new(url.host, url.port)
|
|
41927
42112
|
http.use_ssl = true
|
|
@@ -41937,7 +42122,7 @@ puts response.read_body
|
|
|
41937
42122
|
import com.mashape.unirest.http.HttpResponse;
|
|
41938
42123
|
import com.mashape.unirest.http.Unirest;
|
|
41939
42124
|
|
|
41940
|
-
HttpResponse<String> response = Unirest.delete("https://api.agentmail.to/v0/pods/pod_id/api-keys/
|
|
42125
|
+
HttpResponse<String> response = Unirest.delete("https://api.agentmail.to/v0/pods/pod_id/api-keys/api_key_id")
|
|
41941
42126
|
.header("Authorization", "Bearer <api_key>")
|
|
41942
42127
|
.asString();
|
|
41943
42128
|
```
|
|
@@ -41948,7 +42133,7 @@ require_once('vendor/autoload.php');
|
|
|
41948
42133
|
|
|
41949
42134
|
$client = new \GuzzleHttp\Client();
|
|
41950
42135
|
|
|
41951
|
-
$response = $client->request('DELETE', 'https://api.agentmail.to/v0/pods/pod_id/api-keys/
|
|
42136
|
+
$response = $client->request('DELETE', 'https://api.agentmail.to/v0/pods/pod_id/api-keys/api_key_id', [
|
|
41952
42137
|
'headers' => [
|
|
41953
42138
|
'Authorization' => 'Bearer <api_key>',
|
|
41954
42139
|
],
|
|
@@ -41960,7 +42145,7 @@ echo $response->getBody();
|
|
|
41960
42145
|
```csharp
|
|
41961
42146
|
using RestSharp;
|
|
41962
42147
|
|
|
41963
|
-
var client = new RestClient("https://api.agentmail.to/v0/pods/pod_id/api-keys/
|
|
42148
|
+
var client = new RestClient("https://api.agentmail.to/v0/pods/pod_id/api-keys/api_key_id");
|
|
41964
42149
|
var request = new RestRequest(Method.DELETE);
|
|
41965
42150
|
request.AddHeader("Authorization", "Bearer <api_key>");
|
|
41966
42151
|
IRestResponse response = client.Execute(request);
|
|
@@ -41971,7 +42156,7 @@ import Foundation
|
|
|
41971
42156
|
|
|
41972
42157
|
let headers = ["Authorization": "Bearer <api_key>"]
|
|
41973
42158
|
|
|
41974
|
-
let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentmail.to/v0/pods/pod_id/api-keys/
|
|
42159
|
+
let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentmail.to/v0/pods/pod_id/api-keys/api_key_id")! as URL,
|
|
41975
42160
|
cachePolicy: .useProtocolCachePolicy,
|
|
41976
42161
|
timeoutInterval: 10.0)
|
|
41977
42162
|
request.httpMethod = "DELETE"
|