agentmail 0.4.15 → 0.4.16
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/agent/client/Client.d.ts +13 -1
- package/dist/cjs/api/resources/agent/client/Client.js +13 -1
- package/dist/cjs/api/resources/apiKeys/client/Client.d.ts +16 -3
- package/dist/cjs/api/resources/apiKeys/client/Client.js +16 -3
- package/dist/cjs/api/resources/apiKeys/types/CreateApiKeyRequest.d.ts +1 -1
- package/dist/cjs/api/resources/domains/client/Client.d.ts +35 -0
- package/dist/cjs/api/resources/domains/client/Client.js +35 -0
- package/dist/cjs/api/resources/domains/types/DomainItem.d.ts +0 -1
- package/dist/cjs/api/resources/drafts/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/drafts/client/Client.js +15 -0
- package/dist/cjs/api/resources/inboxes/client/Client.d.ts +25 -0
- package/dist/cjs/api/resources/inboxes/client/Client.js +25 -0
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.d.ts +16 -3
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.js +16 -3
- package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.d.ts +35 -0
- package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.js +35 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.js +20 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +45 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +45 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.d.ts +5 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.js +5 -0
- package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.js +20 -0
- package/dist/cjs/api/resources/lists/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/lists/client/Client.js +20 -0
- package/dist/cjs/api/resources/messages/types/UpdateMessageLabels.d.ts +4 -0
- package/dist/cjs/api/resources/messages/types/UpdateMessageLabels.js +3 -0
- package/dist/cjs/api/resources/messages/types/UpdateMessageRequest.d.ts +5 -4
- package/dist/cjs/api/resources/messages/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/types/index.js +1 -0
- package/dist/cjs/api/resources/metrics/client/Client.d.ts +5 -0
- package/dist/cjs/api/resources/metrics/client/Client.js +5 -0
- package/dist/cjs/api/resources/pods/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/pods/client/Client.js +20 -0
- package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.d.ts +16 -3
- package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.js +16 -3
- package/dist/cjs/api/resources/pods/resources/domains/client/Client.d.ts +35 -0
- package/dist/cjs/api/resources/pods/resources/domains/client/Client.js +35 -0
- package/dist/cjs/api/resources/pods/resources/drafts/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/pods/resources/drafts/client/Client.js +15 -0
- package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.d.ts +25 -0
- package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.js +25 -0
- package/dist/cjs/api/resources/pods/resources/lists/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/pods/resources/lists/client/Client.js +20 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/Client.d.ts +5 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/Client.js +5 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.js +20 -0
- package/dist/cjs/api/resources/threads/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/threads/client/Client.js +20 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +25 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +25 -0
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.ts +1 -1
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.js +1 -1
- package/dist/cjs/serialization/resources/domains/types/DomainItem.d.ts +0 -2
- package/dist/cjs/serialization/resources/domains/types/DomainItem.js +0 -2
- package/dist/cjs/serialization/resources/messages/types/UpdateMessageLabels.d.ts +7 -0
- package/dist/cjs/serialization/resources/messages/types/UpdateMessageLabels.js +42 -0
- package/dist/cjs/serialization/resources/messages/types/UpdateMessageRequest.d.ts +3 -2
- package/dist/cjs/serialization/resources/messages/types/UpdateMessageRequest.js +3 -2
- package/dist/cjs/serialization/resources/messages/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/messages/types/index.js +1 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/agent/client/Client.d.mts +13 -1
- package/dist/esm/api/resources/agent/client/Client.mjs +13 -1
- package/dist/esm/api/resources/apiKeys/client/Client.d.mts +16 -3
- package/dist/esm/api/resources/apiKeys/client/Client.mjs +16 -3
- package/dist/esm/api/resources/apiKeys/types/CreateApiKeyRequest.d.mts +1 -1
- package/dist/esm/api/resources/domains/client/Client.d.mts +35 -0
- package/dist/esm/api/resources/domains/client/Client.mjs +35 -0
- package/dist/esm/api/resources/domains/types/DomainItem.d.mts +0 -1
- package/dist/esm/api/resources/drafts/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/drafts/client/Client.mjs +15 -0
- package/dist/esm/api/resources/inboxes/client/Client.d.mts +25 -0
- package/dist/esm/api/resources/inboxes/client/Client.mjs +25 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.d.mts +16 -3
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.mjs +16 -3
- package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.d.mts +35 -0
- package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.mjs +35 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/Client.mjs +20 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +45 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +45 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.d.mts +5 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.mjs +5 -0
- package/dist/esm/api/resources/inboxes/resources/threads/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/inboxes/resources/threads/client/Client.mjs +20 -0
- package/dist/esm/api/resources/lists/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/lists/client/Client.mjs +20 -0
- package/dist/esm/api/resources/messages/types/UpdateMessageLabels.d.mts +4 -0
- package/dist/esm/api/resources/messages/types/UpdateMessageLabels.mjs +2 -0
- package/dist/esm/api/resources/messages/types/UpdateMessageRequest.d.mts +5 -4
- package/dist/esm/api/resources/messages/types/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/types/index.mjs +1 -0
- package/dist/esm/api/resources/metrics/client/Client.d.mts +5 -0
- package/dist/esm/api/resources/metrics/client/Client.mjs +5 -0
- package/dist/esm/api/resources/pods/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/pods/client/Client.mjs +20 -0
- package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.d.mts +16 -3
- package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.mjs +16 -3
- package/dist/esm/api/resources/pods/resources/domains/client/Client.d.mts +35 -0
- package/dist/esm/api/resources/pods/resources/domains/client/Client.mjs +35 -0
- package/dist/esm/api/resources/pods/resources/drafts/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/pods/resources/drafts/client/Client.mjs +15 -0
- package/dist/esm/api/resources/pods/resources/inboxes/client/Client.d.mts +25 -0
- package/dist/esm/api/resources/pods/resources/inboxes/client/Client.mjs +25 -0
- package/dist/esm/api/resources/pods/resources/lists/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/pods/resources/lists/client/Client.mjs +20 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/Client.d.mts +5 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/Client.mjs +5 -0
- package/dist/esm/api/resources/pods/resources/threads/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/pods/resources/threads/client/Client.mjs +20 -0
- package/dist/esm/api/resources/threads/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/threads/client/Client.mjs +20 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +25 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +25 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.mts +1 -1
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.mjs +1 -1
- package/dist/esm/serialization/resources/domains/types/DomainItem.d.mts +0 -2
- package/dist/esm/serialization/resources/domains/types/DomainItem.mjs +0 -2
- package/dist/esm/serialization/resources/messages/types/UpdateMessageLabels.d.mts +7 -0
- package/dist/esm/serialization/resources/messages/types/UpdateMessageLabels.mjs +6 -0
- package/dist/esm/serialization/resources/messages/types/UpdateMessageRequest.d.mts +3 -2
- package/dist/esm/serialization/resources/messages/types/UpdateMessageRequest.mjs +3 -2
- package/dist/esm/serialization/resources/messages/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/messages/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms-full.txt +2836 -568
- package/dist/llms.txt +3 -0
- package/package.json +1 -1
- package/reference.md +1532 -15
|
@@ -57,6 +57,11 @@ class ListsClient {
|
|
|
57
57
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
+
* **CLI:**
|
|
61
|
+
* ```bash
|
|
62
|
+
* agentmail pods:lists list --pod-id <pod_id> --direction <direction> --type <type>
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
60
65
|
* @param {AgentMail.pods.PodId} pod_id
|
|
61
66
|
* @param {AgentMail.Direction} direction
|
|
62
67
|
* @param {AgentMail.ListType} type
|
|
@@ -114,6 +119,11 @@ class ListsClient {
|
|
|
114
119
|
});
|
|
115
120
|
}
|
|
116
121
|
/**
|
|
122
|
+
* **CLI:**
|
|
123
|
+
* ```bash
|
|
124
|
+
* agentmail pods:lists retrieve --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
125
|
+
* ```
|
|
126
|
+
*
|
|
117
127
|
* @param {AgentMail.pods.PodId} pod_id
|
|
118
128
|
* @param {AgentMail.Direction} direction
|
|
119
129
|
* @param {AgentMail.ListType} type
|
|
@@ -179,6 +189,11 @@ class ListsClient {
|
|
|
179
189
|
});
|
|
180
190
|
}
|
|
181
191
|
/**
|
|
192
|
+
* **CLI:**
|
|
193
|
+
* ```bash
|
|
194
|
+
* agentmail pods:lists create --pod-id <pod_id> --direction <direction> --type <type> --entry user@example.com
|
|
195
|
+
* ```
|
|
196
|
+
*
|
|
182
197
|
* @param {AgentMail.pods.PodId} pod_id
|
|
183
198
|
* @param {AgentMail.Direction} direction
|
|
184
199
|
* @param {AgentMail.ListType} type
|
|
@@ -252,6 +267,11 @@ class ListsClient {
|
|
|
252
267
|
});
|
|
253
268
|
}
|
|
254
269
|
/**
|
|
270
|
+
* **CLI:**
|
|
271
|
+
* ```bash
|
|
272
|
+
* agentmail pods:lists delete --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
273
|
+
* ```
|
|
274
|
+
*
|
|
255
275
|
* @param {AgentMail.pods.PodId} pod_id
|
|
256
276
|
* @param {AgentMail.Direction} direction
|
|
257
277
|
* @param {AgentMail.ListType} type
|
|
@@ -11,6 +11,11 @@ export declare class MetricsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<MetricsClient.Options>;
|
|
12
12
|
constructor(options?: MetricsClient.Options);
|
|
13
13
|
/**
|
|
14
|
+
* **CLI:**
|
|
15
|
+
* ```bash
|
|
16
|
+
* agentmail pods:metrics query --pod-id <pod_id>
|
|
17
|
+
* ```
|
|
18
|
+
*
|
|
14
19
|
* @param {AgentMail.pods.PodId} pod_id
|
|
15
20
|
* @param {AgentMail.pods.QueryMetricsRequest} request
|
|
16
21
|
* @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -58,6 +58,11 @@ class MetricsClient {
|
|
|
58
58
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
|
+
* **CLI:**
|
|
62
|
+
* ```bash
|
|
63
|
+
* agentmail pods:metrics query --pod-id <pod_id>
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
61
66
|
* @param {AgentMail.pods.PodId} pod_id
|
|
62
67
|
* @param {AgentMail.pods.QueryMetricsRequest} request
|
|
63
68
|
* @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -11,6 +11,11 @@ export declare class ThreadsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ThreadsClient.Options>;
|
|
12
12
|
constructor(options?: ThreadsClient.Options);
|
|
13
13
|
/**
|
|
14
|
+
* **CLI:**
|
|
15
|
+
* ```bash
|
|
16
|
+
* agentmail pods:threads list --pod-id <pod_id>
|
|
17
|
+
* ```
|
|
18
|
+
*
|
|
14
19
|
* @param {AgentMail.pods.PodId} pod_id
|
|
15
20
|
* @param {AgentMail.pods.ListThreadsRequest} request
|
|
16
21
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -23,6 +28,11 @@ export declare class ThreadsClient {
|
|
|
23
28
|
list(pod_id: AgentMail.pods.PodId, request?: AgentMail.pods.ListThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListThreadsResponse>;
|
|
24
29
|
private __list;
|
|
25
30
|
/**
|
|
31
|
+
* **CLI:**
|
|
32
|
+
* ```bash
|
|
33
|
+
* agentmail pods:threads retrieve --pod-id <pod_id> --thread-id <thread_id>
|
|
34
|
+
* ```
|
|
35
|
+
*
|
|
26
36
|
* @param {AgentMail.pods.PodId} pod_id
|
|
27
37
|
* @param {AgentMail.ThreadId} thread_id
|
|
28
38
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -35,6 +45,11 @@ export declare class ThreadsClient {
|
|
|
35
45
|
get(pod_id: AgentMail.pods.PodId, thread_id: AgentMail.ThreadId, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Thread>;
|
|
36
46
|
private __get;
|
|
37
47
|
/**
|
|
48
|
+
* **CLI:**
|
|
49
|
+
* ```bash
|
|
50
|
+
* agentmail pods:threads get-attachment --pod-id <pod_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
38
53
|
* @param {AgentMail.pods.PodId} pod_id
|
|
39
54
|
* @param {AgentMail.ThreadId} thread_id
|
|
40
55
|
* @param {AgentMail.AttachmentId} attachment_id
|
|
@@ -67,6 +82,11 @@ export declare class ThreadsClient {
|
|
|
67
82
|
/**
|
|
68
83
|
* Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
|
|
69
84
|
*
|
|
85
|
+
* **CLI:**
|
|
86
|
+
* ```bash
|
|
87
|
+
* agentmail pods:threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
70
90
|
* @param {AgentMail.pods.PodId} pod_id
|
|
71
91
|
* @param {AgentMail.ThreadId} thread_id
|
|
72
92
|
* @param {AgentMail.pods.DeleteThreadRequest} request
|
|
@@ -58,6 +58,11 @@ class ThreadsClient {
|
|
|
58
58
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
|
+
* **CLI:**
|
|
62
|
+
* ```bash
|
|
63
|
+
* agentmail pods:threads list --pod-id <pod_id>
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
61
66
|
* @param {AgentMail.pods.PodId} pod_id
|
|
62
67
|
* @param {AgentMail.pods.ListThreadsRequest} request
|
|
63
68
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -142,6 +147,11 @@ class ThreadsClient {
|
|
|
142
147
|
});
|
|
143
148
|
}
|
|
144
149
|
/**
|
|
150
|
+
* **CLI:**
|
|
151
|
+
* ```bash
|
|
152
|
+
* agentmail pods:threads retrieve --pod-id <pod_id> --thread-id <thread_id>
|
|
153
|
+
* ```
|
|
154
|
+
*
|
|
145
155
|
* @param {AgentMail.pods.PodId} pod_id
|
|
146
156
|
* @param {AgentMail.ThreadId} thread_id
|
|
147
157
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -205,6 +215,11 @@ class ThreadsClient {
|
|
|
205
215
|
});
|
|
206
216
|
}
|
|
207
217
|
/**
|
|
218
|
+
* **CLI:**
|
|
219
|
+
* ```bash
|
|
220
|
+
* agentmail pods:threads get-attachment --pod-id <pod_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
221
|
+
* ```
|
|
222
|
+
*
|
|
208
223
|
* @param {AgentMail.pods.PodId} pod_id
|
|
209
224
|
* @param {AgentMail.ThreadId} thread_id
|
|
210
225
|
* @param {AgentMail.AttachmentId} attachment_id
|
|
@@ -361,6 +376,11 @@ class ThreadsClient {
|
|
|
361
376
|
/**
|
|
362
377
|
* Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
|
|
363
378
|
*
|
|
379
|
+
* **CLI:**
|
|
380
|
+
* ```bash
|
|
381
|
+
* agentmail pods:threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
382
|
+
* ```
|
|
383
|
+
*
|
|
364
384
|
* @param {AgentMail.pods.PodId} pod_id
|
|
365
385
|
* @param {AgentMail.ThreadId} thread_id
|
|
366
386
|
* @param {AgentMail.pods.DeleteThreadRequest} request
|
|
@@ -11,6 +11,11 @@ export declare class ThreadsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ThreadsClient.Options>;
|
|
12
12
|
constructor(options?: ThreadsClient.Options);
|
|
13
13
|
/**
|
|
14
|
+
* **CLI:**
|
|
15
|
+
* ```bash
|
|
16
|
+
* agentmail threads list
|
|
17
|
+
* ```
|
|
18
|
+
*
|
|
14
19
|
* @param {AgentMail.ListThreadsRequest} request
|
|
15
20
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
16
21
|
*
|
|
@@ -22,6 +27,11 @@ export declare class ThreadsClient {
|
|
|
22
27
|
list(request?: AgentMail.ListThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListThreadsResponse>;
|
|
23
28
|
private __list;
|
|
24
29
|
/**
|
|
30
|
+
* **CLI:**
|
|
31
|
+
* ```bash
|
|
32
|
+
* agentmail threads retrieve --thread-id <thread_id>
|
|
33
|
+
* ```
|
|
34
|
+
*
|
|
25
35
|
* @param {AgentMail.ThreadId} thread_id
|
|
26
36
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
27
37
|
*
|
|
@@ -33,6 +43,11 @@ export declare class ThreadsClient {
|
|
|
33
43
|
get(thread_id: AgentMail.ThreadId, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Thread>;
|
|
34
44
|
private __get;
|
|
35
45
|
/**
|
|
46
|
+
* **CLI:**
|
|
47
|
+
* ```bash
|
|
48
|
+
* agentmail threads retrieve-attachment --thread-id <thread_id> --attachment-id <attachment_id>
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
36
51
|
* @param {AgentMail.ThreadId} thread_id
|
|
37
52
|
* @param {AgentMail.AttachmentId} attachment_id
|
|
38
53
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -63,6 +78,11 @@ export declare class ThreadsClient {
|
|
|
63
78
|
/**
|
|
64
79
|
* Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
|
|
65
80
|
*
|
|
81
|
+
* **CLI:**
|
|
82
|
+
* ```bash
|
|
83
|
+
* agentmail threads delete --thread-id <thread_id>
|
|
84
|
+
* ```
|
|
85
|
+
*
|
|
66
86
|
* @param {AgentMail.ThreadId} thread_id
|
|
67
87
|
* @param {AgentMail.DeleteThreadRequest} request
|
|
68
88
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -58,6 +58,11 @@ class ThreadsClient {
|
|
|
58
58
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
|
+
* **CLI:**
|
|
62
|
+
* ```bash
|
|
63
|
+
* agentmail threads list
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
61
66
|
* @param {AgentMail.ListThreadsRequest} request
|
|
62
67
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
63
68
|
*
|
|
@@ -141,6 +146,11 @@ class ThreadsClient {
|
|
|
141
146
|
});
|
|
142
147
|
}
|
|
143
148
|
/**
|
|
149
|
+
* **CLI:**
|
|
150
|
+
* ```bash
|
|
151
|
+
* agentmail threads retrieve --thread-id <thread_id>
|
|
152
|
+
* ```
|
|
153
|
+
*
|
|
144
154
|
* @param {AgentMail.ThreadId} thread_id
|
|
145
155
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
146
156
|
*
|
|
@@ -203,6 +213,11 @@ class ThreadsClient {
|
|
|
203
213
|
});
|
|
204
214
|
}
|
|
205
215
|
/**
|
|
216
|
+
* **CLI:**
|
|
217
|
+
* ```bash
|
|
218
|
+
* agentmail threads retrieve-attachment --thread-id <thread_id> --attachment-id <attachment_id>
|
|
219
|
+
* ```
|
|
220
|
+
*
|
|
206
221
|
* @param {AgentMail.ThreadId} thread_id
|
|
207
222
|
* @param {AgentMail.AttachmentId} attachment_id
|
|
208
223
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -357,6 +372,11 @@ class ThreadsClient {
|
|
|
357
372
|
/**
|
|
358
373
|
* Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
|
|
359
374
|
*
|
|
375
|
+
* **CLI:**
|
|
376
|
+
* ```bash
|
|
377
|
+
* agentmail threads delete --thread-id <thread_id>
|
|
378
|
+
* ```
|
|
379
|
+
*
|
|
360
380
|
* @param {AgentMail.ThreadId} thread_id
|
|
361
381
|
* @param {AgentMail.DeleteThreadRequest} request
|
|
362
382
|
* @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -11,6 +11,11 @@ export declare class WebhooksClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<WebhooksClient.Options>;
|
|
12
12
|
constructor(options?: WebhooksClient.Options);
|
|
13
13
|
/**
|
|
14
|
+
* **CLI:**
|
|
15
|
+
* ```bash
|
|
16
|
+
* agentmail webhooks list
|
|
17
|
+
* ```
|
|
18
|
+
*
|
|
14
19
|
* @param {AgentMail.webhooks.ListWebhooksRequest} request
|
|
15
20
|
* @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
16
21
|
*
|
|
@@ -20,6 +25,11 @@ export declare class WebhooksClient {
|
|
|
20
25
|
list(request?: AgentMail.webhooks.ListWebhooksRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<AgentMail.webhooks.ListWebhooksResponse>;
|
|
21
26
|
private __list;
|
|
22
27
|
/**
|
|
28
|
+
* **CLI:**
|
|
29
|
+
* ```bash
|
|
30
|
+
* agentmail webhooks retrieve --webhook-id <webhook_id>
|
|
31
|
+
* ```
|
|
32
|
+
*
|
|
23
33
|
* @param {AgentMail.webhooks.WebhookId} webhook_id
|
|
24
34
|
* @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
25
35
|
*
|
|
@@ -31,6 +41,11 @@ export declare class WebhooksClient {
|
|
|
31
41
|
get(webhook_id: AgentMail.webhooks.WebhookId, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<AgentMail.webhooks.Webhook>;
|
|
32
42
|
private __get;
|
|
33
43
|
/**
|
|
44
|
+
* **CLI:**
|
|
45
|
+
* ```bash
|
|
46
|
+
* agentmail webhooks create --url https://example.com/webhook --event-type message.received
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
34
49
|
* @param {AgentMail.webhooks.CreateWebhookRequest} request
|
|
35
50
|
* @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
36
51
|
*
|
|
@@ -45,6 +60,11 @@ export declare class WebhooksClient {
|
|
|
45
60
|
create(request: AgentMail.webhooks.CreateWebhookRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<AgentMail.webhooks.Webhook>;
|
|
46
61
|
private __create;
|
|
47
62
|
/**
|
|
63
|
+
* **CLI:**
|
|
64
|
+
* ```bash
|
|
65
|
+
* agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
48
68
|
* @param {AgentMail.webhooks.WebhookId} webhook_id
|
|
49
69
|
* @param {AgentMail.webhooks.UpdateWebhookRequest} request
|
|
50
70
|
* @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -58,6 +78,11 @@ export declare class WebhooksClient {
|
|
|
58
78
|
update(webhook_id: AgentMail.webhooks.WebhookId, request: AgentMail.webhooks.UpdateWebhookRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<AgentMail.webhooks.Webhook>;
|
|
59
79
|
private __update;
|
|
60
80
|
/**
|
|
81
|
+
* **CLI:**
|
|
82
|
+
* ```bash
|
|
83
|
+
* agentmail webhooks delete --webhook-id <webhook_id>
|
|
84
|
+
* ```
|
|
85
|
+
*
|
|
61
86
|
* @param {AgentMail.webhooks.WebhookId} webhook_id
|
|
62
87
|
* @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
63
88
|
*
|
|
@@ -57,6 +57,11 @@ class WebhooksClient {
|
|
|
57
57
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
+
* **CLI:**
|
|
61
|
+
* ```bash
|
|
62
|
+
* agentmail webhooks list
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
60
65
|
* @param {AgentMail.webhooks.ListWebhooksRequest} request
|
|
61
66
|
* @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
62
67
|
*
|
|
@@ -112,6 +117,11 @@ class WebhooksClient {
|
|
|
112
117
|
});
|
|
113
118
|
}
|
|
114
119
|
/**
|
|
120
|
+
* **CLI:**
|
|
121
|
+
* ```bash
|
|
122
|
+
* agentmail webhooks retrieve --webhook-id <webhook_id>
|
|
123
|
+
* ```
|
|
124
|
+
*
|
|
115
125
|
* @param {AgentMail.webhooks.WebhookId} webhook_id
|
|
116
126
|
* @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
117
127
|
*
|
|
@@ -174,6 +184,11 @@ class WebhooksClient {
|
|
|
174
184
|
});
|
|
175
185
|
}
|
|
176
186
|
/**
|
|
187
|
+
* **CLI:**
|
|
188
|
+
* ```bash
|
|
189
|
+
* agentmail webhooks create --url https://example.com/webhook --event-type message.received
|
|
190
|
+
* ```
|
|
191
|
+
*
|
|
177
192
|
* @param {AgentMail.webhooks.CreateWebhookRequest} request
|
|
178
193
|
* @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
179
194
|
*
|
|
@@ -245,6 +260,11 @@ class WebhooksClient {
|
|
|
245
260
|
});
|
|
246
261
|
}
|
|
247
262
|
/**
|
|
263
|
+
* **CLI:**
|
|
264
|
+
* ```bash
|
|
265
|
+
* agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>
|
|
266
|
+
* ```
|
|
267
|
+
*
|
|
248
268
|
* @param {AgentMail.webhooks.WebhookId} webhook_id
|
|
249
269
|
* @param {AgentMail.webhooks.UpdateWebhookRequest} request
|
|
250
270
|
* @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -323,6 +343,11 @@ class WebhooksClient {
|
|
|
323
343
|
});
|
|
324
344
|
}
|
|
325
345
|
/**
|
|
346
|
+
* **CLI:**
|
|
347
|
+
* ```bash
|
|
348
|
+
* agentmail webhooks delete --webhook-id <webhook_id>
|
|
349
|
+
* ```
|
|
350
|
+
*
|
|
326
351
|
* @param {AgentMail.webhooks.WebhookId} webhook_id
|
|
327
352
|
* @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
328
353
|
*
|
|
@@ -6,7 +6,7 @@ import { Name } from "./Name.js";
|
|
|
6
6
|
export declare const CreateApiKeyRequest: core.serialization.ObjectSchema<serializers.CreateApiKeyRequest.Raw, AgentMail.CreateApiKeyRequest>;
|
|
7
7
|
export declare namespace CreateApiKeyRequest {
|
|
8
8
|
interface Raw {
|
|
9
|
-
name
|
|
9
|
+
name?: Name.Raw | null;
|
|
10
10
|
permissions?: ApiKeyPermissions.Raw | null;
|
|
11
11
|
}
|
|
12
12
|
}
|
|
@@ -39,6 +39,6 @@ const core = __importStar(require("../../../../core/index.js"));
|
|
|
39
39
|
const ApiKeyPermissions_js_1 = require("./ApiKeyPermissions.js");
|
|
40
40
|
const Name_js_1 = require("./Name.js");
|
|
41
41
|
exports.CreateApiKeyRequest = core.serialization.object({
|
|
42
|
-
name: Name_js_1.Name,
|
|
42
|
+
name: Name_js_1.Name.optional(),
|
|
43
43
|
permissions: ApiKeyPermissions_js_1.ApiKeyPermissions.optional(),
|
|
44
44
|
});
|
|
@@ -6,14 +6,12 @@ import { ClientId } from "./ClientId.js";
|
|
|
6
6
|
import { DomainId } from "./DomainId.js";
|
|
7
7
|
import { DomainName } from "./DomainName.js";
|
|
8
8
|
import { FeedbackEnabled } from "./FeedbackEnabled.js";
|
|
9
|
-
import { Status } from "./Status.js";
|
|
10
9
|
export declare const DomainItem: core.serialization.ObjectSchema<serializers.DomainItem.Raw, AgentMail.DomainItem>;
|
|
11
10
|
export declare namespace DomainItem {
|
|
12
11
|
interface Raw {
|
|
13
12
|
pod_id?: PodId.Raw | null;
|
|
14
13
|
domain_id: DomainId.Raw;
|
|
15
14
|
domain: DomainName.Raw;
|
|
16
|
-
status: Status.Raw;
|
|
17
15
|
feedback_enabled: FeedbackEnabled.Raw;
|
|
18
16
|
client_id?: ClientId.Raw | null;
|
|
19
17
|
updated_at: string;
|
|
@@ -41,12 +41,10 @@ const ClientId_js_1 = require("./ClientId.js");
|
|
|
41
41
|
const DomainId_js_1 = require("./DomainId.js");
|
|
42
42
|
const DomainName_js_1 = require("./DomainName.js");
|
|
43
43
|
const FeedbackEnabled_js_1 = require("./FeedbackEnabled.js");
|
|
44
|
-
const Status_js_1 = require("./Status.js");
|
|
45
44
|
exports.DomainItem = core.serialization.object({
|
|
46
45
|
podId: core.serialization.property("pod_id", PodId_js_1.PodId.optional()),
|
|
47
46
|
domainId: core.serialization.property("domain_id", DomainId_js_1.DomainId),
|
|
48
47
|
domain: DomainName_js_1.DomainName,
|
|
49
|
-
status: Status_js_1.Status,
|
|
50
48
|
feedbackEnabled: core.serialization.property("feedback_enabled", FeedbackEnabled_js_1.FeedbackEnabled),
|
|
51
49
|
clientId: core.serialization.property("client_id", ClientId_js_1.ClientId.optional()),
|
|
52
50
|
updatedAt: core.serialization.property("updated_at", core.serialization.date()),
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type * as AgentMail from "../../../../api/index.js";
|
|
2
|
+
import * as core from "../../../../core/index.js";
|
|
3
|
+
import type * as serializers from "../../../index.js";
|
|
4
|
+
export declare const UpdateMessageLabels: core.serialization.Schema<serializers.UpdateMessageLabels.Raw, AgentMail.UpdateMessageLabels>;
|
|
5
|
+
export declare namespace UpdateMessageLabels {
|
|
6
|
+
type Raw = string | string[];
|
|
7
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
|
+
exports.UpdateMessageLabels = void 0;
|
|
38
|
+
const core = __importStar(require("../../../../core/index.js"));
|
|
39
|
+
exports.UpdateMessageLabels = core.serialization.undiscriminatedUnion([
|
|
40
|
+
core.serialization.string(),
|
|
41
|
+
core.serialization.list(core.serialization.string()),
|
|
42
|
+
]);
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import type * as AgentMail from "../../../../api/index.js";
|
|
2
2
|
import * as core from "../../../../core/index.js";
|
|
3
3
|
import type * as serializers from "../../../index.js";
|
|
4
|
+
import { UpdateMessageLabels } from "./UpdateMessageLabels.js";
|
|
4
5
|
export declare const UpdateMessageRequest: core.serialization.ObjectSchema<serializers.UpdateMessageRequest.Raw, AgentMail.UpdateMessageRequest>;
|
|
5
6
|
export declare namespace UpdateMessageRequest {
|
|
6
7
|
interface Raw {
|
|
7
|
-
add_labels?:
|
|
8
|
-
remove_labels?:
|
|
8
|
+
add_labels?: UpdateMessageLabels.Raw | null;
|
|
9
|
+
remove_labels?: UpdateMessageLabels.Raw | null;
|
|
9
10
|
}
|
|
10
11
|
}
|
|
@@ -36,7 +36,8 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
36
36
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
37
|
exports.UpdateMessageRequest = void 0;
|
|
38
38
|
const core = __importStar(require("../../../../core/index.js"));
|
|
39
|
+
const UpdateMessageLabels_js_1 = require("./UpdateMessageLabels.js");
|
|
39
40
|
exports.UpdateMessageRequest = core.serialization.object({
|
|
40
|
-
addLabels: core.serialization.property("add_labels",
|
|
41
|
-
removeLabels: core.serialization.property("remove_labels",
|
|
41
|
+
addLabels: core.serialization.property("add_labels", UpdateMessageLabels_js_1.UpdateMessageLabels.optional()),
|
|
42
|
+
removeLabels: core.serialization.property("remove_labels", UpdateMessageLabels_js_1.UpdateMessageLabels.optional()),
|
|
42
43
|
});
|
|
@@ -33,5 +33,6 @@ export * from "./SendMessageReplyTo.js";
|
|
|
33
33
|
export * from "./SendMessageRequest.js";
|
|
34
34
|
export * from "./SendMessageResponse.js";
|
|
35
35
|
export * from "./SendMessageTo.js";
|
|
36
|
+
export * from "./UpdateMessageLabels.js";
|
|
36
37
|
export * from "./UpdateMessageRequest.js";
|
|
37
38
|
export * from "./UpdateMessageResponse.js";
|
|
@@ -49,5 +49,6 @@ __exportStar(require("./SendMessageReplyTo.js"), exports);
|
|
|
49
49
|
__exportStar(require("./SendMessageRequest.js"), exports);
|
|
50
50
|
__exportStar(require("./SendMessageResponse.js"), exports);
|
|
51
51
|
__exportStar(require("./SendMessageTo.js"), exports);
|
|
52
|
+
__exportStar(require("./UpdateMessageLabels.js"), exports);
|
|
52
53
|
__exportStar(require("./UpdateMessageRequest.js"), exports);
|
|
53
54
|
__exportStar(require("./UpdateMessageResponse.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.4.
|
|
1
|
+
export declare const SDK_VERSION = "0.4.16";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "agentmail",
|
|
9
|
-
"X-Fern-SDK-Version": "0.4.
|
|
10
|
-
"User-Agent": "agentmail/0.4.
|
|
9
|
+
"X-Fern-SDK-Version": "0.4.16",
|
|
10
|
+
"User-Agent": "agentmail/0.4.16",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -11,12 +11,19 @@ export declare class AgentClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<AgentClient.Options>;
|
|
12
12
|
constructor(options?: AgentClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Create a new agent organization with an inbox and API key.
|
|
14
|
+
* Create a new agent organization with an inbox and API key. This endpoint is for signing up for the first time. If you've already signed up, you're all set — just use your existing API key.
|
|
15
|
+
*
|
|
16
|
+
* A 6-digit OTP is sent to the human's email for verification.
|
|
15
17
|
*
|
|
16
18
|
* This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
|
|
17
19
|
*
|
|
18
20
|
* The returned API key has limited permissions until the organization is verified via the verify endpoint.
|
|
19
21
|
*
|
|
22
|
+
* **CLI:**
|
|
23
|
+
* ```bash
|
|
24
|
+
* agentmail agent sign-up --human-email user@example.com --username my-agent
|
|
25
|
+
* ```
|
|
26
|
+
*
|
|
20
27
|
* @param {AgentMail.AgentSignupRequest} request
|
|
21
28
|
* @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
22
29
|
*
|
|
@@ -37,6 +44,11 @@ export declare class AgentClient {
|
|
|
37
44
|
*
|
|
38
45
|
* The OTP expires after 24 hours and allows a maximum of 10 attempts.
|
|
39
46
|
*
|
|
47
|
+
* **CLI:**
|
|
48
|
+
* ```bash
|
|
49
|
+
* agentmail agent verify --otp-code 123456
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
40
52
|
* @param {AgentMail.AgentVerifyRequest} request
|
|
41
53
|
* @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
42
54
|
*
|
|
@@ -21,12 +21,19 @@ export class AgentClient {
|
|
|
21
21
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* Create a new agent organization with an inbox and API key.
|
|
24
|
+
* Create a new agent organization with an inbox and API key. This endpoint is for signing up for the first time. If you've already signed up, you're all set — just use your existing API key.
|
|
25
|
+
*
|
|
26
|
+
* A 6-digit OTP is sent to the human's email for verification.
|
|
25
27
|
*
|
|
26
28
|
* This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
|
|
27
29
|
*
|
|
28
30
|
* The returned API key has limited permissions until the organization is verified via the verify endpoint.
|
|
29
31
|
*
|
|
32
|
+
* **CLI:**
|
|
33
|
+
* ```bash
|
|
34
|
+
* agentmail agent sign-up --human-email user@example.com --username my-agent
|
|
35
|
+
* ```
|
|
36
|
+
*
|
|
30
37
|
* @param {AgentMail.AgentSignupRequest} request
|
|
31
38
|
* @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
32
39
|
*
|
|
@@ -103,6 +110,11 @@ export class AgentClient {
|
|
|
103
110
|
*
|
|
104
111
|
* The OTP expires after 24 hours and allows a maximum of 10 attempts.
|
|
105
112
|
*
|
|
113
|
+
* **CLI:**
|
|
114
|
+
* ```bash
|
|
115
|
+
* agentmail agent verify --otp-code 123456
|
|
116
|
+
* ```
|
|
117
|
+
*
|
|
106
118
|
* @param {AgentMail.AgentVerifyRequest} request
|
|
107
119
|
* @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
108
120
|
*
|
|
@@ -11,6 +11,11 @@ export declare class ApiKeysClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ApiKeysClient.Options>;
|
|
12
12
|
constructor(options?: ApiKeysClient.Options);
|
|
13
13
|
/**
|
|
14
|
+
* **CLI:**
|
|
15
|
+
* ```bash
|
|
16
|
+
* agentmail api-keys list
|
|
17
|
+
* ```
|
|
18
|
+
*
|
|
14
19
|
* @param {AgentMail.ListApiKeysRequest} request
|
|
15
20
|
* @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
16
21
|
*
|
|
@@ -20,19 +25,27 @@ export declare class ApiKeysClient {
|
|
|
20
25
|
list(request?: AgentMail.ListApiKeysRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListApiKeysResponse>;
|
|
21
26
|
private __list;
|
|
22
27
|
/**
|
|
28
|
+
* **CLI:**
|
|
29
|
+
* ```bash
|
|
30
|
+
* agentmail api-keys create --name "My Key"
|
|
31
|
+
* ```
|
|
32
|
+
*
|
|
23
33
|
* @param {AgentMail.CreateApiKeyRequest} request
|
|
24
34
|
* @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
25
35
|
*
|
|
26
36
|
* @throws {@link AgentMail.ValidationError}
|
|
27
37
|
*
|
|
28
38
|
* @example
|
|
29
|
-
* await client.apiKeys.create({
|
|
30
|
-
* name: "name"
|
|
31
|
-
* })
|
|
39
|
+
* await client.apiKeys.create({})
|
|
32
40
|
*/
|
|
33
41
|
create(request: AgentMail.CreateApiKeyRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<AgentMail.CreateApiKeyResponse>;
|
|
34
42
|
private __create;
|
|
35
43
|
/**
|
|
44
|
+
* **CLI:**
|
|
45
|
+
* ```bash
|
|
46
|
+
* agentmail api-keys delete --api-key-id <api_key_id>
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
36
49
|
* @param {AgentMail.ApiKeyId} api_key_id
|
|
37
50
|
* @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
38
51
|
*
|