agentmail 0.0.43 → 0.0.44
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/Client.d.ts +4 -4
- package/Client.js +11 -11
- package/api/resources/domains/client/Client.d.ts +1 -1
- package/api/resources/domains/client/Client.js +8 -8
- package/api/resources/drafts/client/Client.d.ts +1 -1
- package/api/resources/drafts/client/Client.js +4 -4
- package/api/resources/inboxes/client/Client.d.ts +1 -1
- package/api/resources/inboxes/client/Client.js +6 -6
- package/api/resources/inboxes/resources/drafts/client/Client.d.ts +1 -1
- package/api/resources/inboxes/resources/drafts/client/Client.js +8 -8
- package/api/resources/inboxes/resources/messages/client/Client.d.ts +1 -1
- package/api/resources/inboxes/resources/messages/client/Client.js +12 -12
- package/api/resources/inboxes/resources/threads/client/Client.d.ts +1 -1
- package/api/resources/inboxes/resources/threads/client/Client.js +6 -6
- package/api/resources/index.d.ts +3 -3
- package/api/resources/index.js +4 -4
- package/api/resources/threads/client/Client.d.ts +1 -1
- package/api/resources/threads/client/Client.js +6 -6
- package/api/resources/webhooks/client/Client.d.ts +9 -9
- package/api/resources/webhooks/client/Client.js +16 -16
- package/api/resources/webhooks/index.d.ts +1 -0
- package/api/resources/webhooks/index.js +1 -0
- package/api/resources/webhooks/resources/events/index.d.ts +1 -0
- package/api/resources/webhooks/resources/events/index.js +17 -0
- package/api/resources/webhooks/resources/events/types/MessageReceivedPayload.d.ts +9 -0
- package/api/resources/webhooks/resources/events/types/index.d.ts +5 -0
- package/api/resources/webhooks/resources/events/types/index.js +21 -0
- package/api/resources/webhooks/resources/index.d.ts +2 -0
- package/api/resources/webhooks/resources/index.js +41 -0
- package/api/resources/webhooks/types/CreateWebhookRequest.d.ts +4 -4
- package/api/resources/webhooks/types/EventTypes.d.ts +1 -1
- package/api/resources/webhooks/types/ListWebhooksResponse.d.ts +1 -1
- package/api/resources/webhooks/types/Webhook.d.ts +5 -5
- package/api/resources/webhooks/types/index.d.ts +0 -5
- package/api/resources/webhooks/types/index.js +0 -5
- package/api/resources/websockets/index.d.ts +1 -0
- package/api/resources/websockets/index.js +17 -0
- package/{dist/api/resources/webhooks/types/MessageReceivedPayload.d.ts → api/resources/websockets/types/MessageReceived.d.ts} +3 -2
- package/api/resources/websockets/types/Subscribe.d.ts +8 -0
- package/api/resources/websockets/types/Subscribed.d.ts +8 -0
- package/api/resources/websockets/types/index.d.ts +4 -0
- package/api/resources/websockets/types/index.js +20 -0
- package/dist/Client.d.ts +4 -4
- package/dist/Client.js +11 -11
- package/dist/api/resources/domains/client/Client.d.ts +1 -1
- package/dist/api/resources/domains/client/Client.js +8 -8
- package/dist/api/resources/drafts/client/Client.d.ts +1 -1
- package/dist/api/resources/drafts/client/Client.js +4 -4
- package/dist/api/resources/inboxes/client/Client.d.ts +1 -1
- package/dist/api/resources/inboxes/client/Client.js +6 -6
- package/dist/api/resources/inboxes/resources/drafts/client/Client.d.ts +1 -1
- package/dist/api/resources/inboxes/resources/drafts/client/Client.js +8 -8
- package/dist/api/resources/inboxes/resources/messages/client/Client.d.ts +1 -1
- package/dist/api/resources/inboxes/resources/messages/client/Client.js +12 -12
- package/dist/api/resources/inboxes/resources/threads/client/Client.d.ts +1 -1
- package/dist/api/resources/inboxes/resources/threads/client/Client.js +6 -6
- package/dist/api/resources/index.d.ts +3 -3
- package/dist/api/resources/index.js +4 -4
- package/dist/api/resources/threads/client/Client.d.ts +1 -1
- package/dist/api/resources/threads/client/Client.js +6 -6
- package/dist/api/resources/webhooks/client/Client.d.ts +9 -9
- package/dist/api/resources/webhooks/client/Client.js +16 -16
- package/dist/api/resources/webhooks/index.d.ts +1 -0
- package/dist/api/resources/webhooks/index.js +1 -0
- package/dist/api/resources/webhooks/resources/events/index.d.ts +1 -0
- package/dist/api/resources/webhooks/resources/events/index.js +17 -0
- package/dist/api/resources/webhooks/resources/events/types/EventId.d.ts +7 -0
- package/dist/api/resources/webhooks/resources/events/types/MessageReceivedPayload.d.ts +9 -0
- package/dist/api/resources/webhooks/resources/events/types/MessageReceivedPayload.js +5 -0
- package/dist/api/resources/webhooks/resources/events/types/SvixId.js +5 -0
- package/dist/api/resources/webhooks/resources/events/types/SvixSignature.js +5 -0
- package/dist/api/resources/webhooks/resources/events/types/SvixTimestamp.js +5 -0
- package/dist/api/resources/webhooks/resources/events/types/index.d.ts +5 -0
- package/dist/api/resources/webhooks/resources/events/types/index.js +21 -0
- package/dist/api/resources/webhooks/resources/index.d.ts +2 -0
- package/dist/api/resources/webhooks/resources/index.js +41 -0
- package/dist/api/resources/webhooks/types/CreateWebhookRequest.d.ts +4 -4
- package/dist/api/resources/webhooks/types/EventTypes.d.ts +1 -1
- package/dist/api/resources/webhooks/types/ListWebhooksResponse.d.ts +1 -1
- package/dist/api/resources/webhooks/types/Webhook.d.ts +5 -5
- package/dist/api/resources/webhooks/types/index.d.ts +0 -5
- package/dist/api/resources/webhooks/types/index.js +0 -5
- package/dist/api/resources/websockets/index.d.ts +1 -0
- package/dist/api/resources/websockets/index.js +17 -0
- package/dist/api/resources/websockets/types/EventId.d.ts +7 -0
- package/dist/api/resources/websockets/types/EventId.js +5 -0
- package/{api/resources/webhooks/types/MessageReceivedPayload.d.ts → dist/api/resources/websockets/types/MessageReceived.d.ts} +3 -2
- package/dist/api/resources/websockets/types/MessageReceived.js +5 -0
- package/dist/api/resources/websockets/types/Subscribe.d.ts +8 -0
- package/dist/api/resources/websockets/types/Subscribe.js +5 -0
- package/dist/api/resources/websockets/types/Subscribed.d.ts +8 -0
- package/dist/api/resources/websockets/types/Subscribed.js +5 -0
- package/dist/api/resources/websockets/types/index.d.ts +4 -0
- package/dist/api/resources/websockets/types/index.js +20 -0
- package/dist/environments.d.ts +12 -2
- package/dist/environments.js +8 -2
- package/dist/index.d.ts +1 -1
- package/dist/serialization/resources/index.d.ts +3 -2
- package/dist/serialization/resources/index.js +4 -3
- package/dist/serialization/resources/webhooks/index.d.ts +1 -0
- package/dist/serialization/resources/webhooks/index.js +1 -0
- package/dist/serialization/resources/webhooks/resources/events/index.d.ts +1 -0
- package/dist/serialization/resources/webhooks/resources/events/index.js +17 -0
- package/dist/serialization/resources/webhooks/resources/events/types/EventId.d.ts +10 -0
- package/dist/serialization/resources/webhooks/resources/events/types/EventId.js +41 -0
- package/dist/serialization/resources/webhooks/resources/events/types/MessageReceivedPayload.d.ts +17 -0
- package/{serialization/resources/webhooks → dist/serialization/resources/webhooks/resources/events}/types/MessageReceivedPayload.js +3 -3
- package/dist/serialization/resources/webhooks/resources/events/types/SvixId.d.ts +10 -0
- package/dist/serialization/resources/webhooks/{types → resources/events/types}/SvixId.js +1 -1
- package/dist/serialization/resources/webhooks/resources/events/types/SvixSignature.d.ts +10 -0
- package/{serialization/resources/webhooks → dist/serialization/resources/webhooks/resources/events}/types/SvixSignature.js +1 -1
- package/dist/serialization/resources/webhooks/resources/events/types/SvixTimestamp.d.ts +10 -0
- package/{serialization/resources/webhooks → dist/serialization/resources/webhooks/resources/events}/types/SvixTimestamp.js +1 -1
- package/dist/serialization/resources/webhooks/resources/events/types/index.d.ts +5 -0
- package/dist/serialization/resources/webhooks/resources/events/types/index.js +21 -0
- package/dist/serialization/resources/webhooks/resources/index.d.ts +2 -0
- package/dist/serialization/resources/webhooks/resources/index.js +41 -0
- package/dist/serialization/resources/webhooks/types/ClientId.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/CreateWebhookRequest.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/EventType.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/EventTypes.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/InboxIds.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/ListWebhooksResponse.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/Url.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/Webhook.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/WebhookId.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/index.d.ts +0 -5
- package/dist/serialization/resources/webhooks/types/index.js +0 -5
- package/dist/serialization/resources/websockets/index.d.ts +1 -0
- package/dist/serialization/resources/websockets/index.js +17 -0
- package/{serialization/resources/webhooks/types/MessageReceivedPayload.d.ts → dist/serialization/resources/websockets/types/MessageReceived.d.ts} +4 -4
- package/dist/serialization/resources/websockets/types/MessageReceived.js +48 -0
- package/dist/serialization/resources/websockets/types/Subscribe.d.ts +13 -0
- package/dist/serialization/resources/websockets/types/Subscribe.js +44 -0
- package/dist/serialization/resources/websockets/types/Subscribed.d.ts +13 -0
- package/dist/serialization/resources/websockets/types/Subscribed.js +44 -0
- package/dist/serialization/resources/websockets/types/index.d.ts +4 -0
- package/dist/serialization/resources/websockets/types/index.js +20 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/environments.d.ts +12 -2
- package/environments.js +8 -2
- package/index.d.ts +1 -1
- package/package.json +1 -1
- package/reference.md +177 -177
- package/serialization/resources/index.d.ts +3 -2
- package/serialization/resources/index.js +4 -3
- package/serialization/resources/webhooks/index.d.ts +1 -0
- package/serialization/resources/webhooks/index.js +1 -0
- package/serialization/resources/webhooks/resources/events/index.d.ts +1 -0
- package/serialization/resources/webhooks/resources/events/index.js +17 -0
- package/serialization/resources/webhooks/resources/events/types/EventId.d.ts +10 -0
- package/serialization/resources/webhooks/resources/events/types/EventId.js +41 -0
- package/serialization/resources/webhooks/resources/events/types/MessageReceivedPayload.d.ts +17 -0
- package/{dist/serialization/resources/webhooks → serialization/resources/webhooks/resources/events}/types/MessageReceivedPayload.js +3 -3
- package/serialization/resources/webhooks/resources/events/types/SvixId.d.ts +10 -0
- package/serialization/resources/webhooks/{types → resources/events/types}/SvixId.js +1 -1
- package/serialization/resources/webhooks/resources/events/types/SvixSignature.d.ts +10 -0
- package/{dist/serialization/resources/webhooks → serialization/resources/webhooks/resources/events}/types/SvixSignature.js +1 -1
- package/serialization/resources/webhooks/resources/events/types/SvixTimestamp.d.ts +10 -0
- package/{dist/serialization/resources/webhooks → serialization/resources/webhooks/resources/events}/types/SvixTimestamp.js +1 -1
- package/serialization/resources/webhooks/resources/events/types/index.d.ts +5 -0
- package/serialization/resources/webhooks/resources/events/types/index.js +21 -0
- package/serialization/resources/webhooks/resources/index.d.ts +2 -0
- package/serialization/resources/webhooks/resources/index.js +41 -0
- package/serialization/resources/webhooks/types/ClientId.d.ts +1 -1
- package/serialization/resources/webhooks/types/CreateWebhookRequest.d.ts +1 -1
- package/serialization/resources/webhooks/types/EventType.d.ts +1 -1
- package/serialization/resources/webhooks/types/EventTypes.d.ts +1 -1
- package/serialization/resources/webhooks/types/InboxIds.d.ts +1 -1
- package/serialization/resources/webhooks/types/ListWebhooksResponse.d.ts +1 -1
- package/serialization/resources/webhooks/types/Url.d.ts +1 -1
- package/serialization/resources/webhooks/types/Webhook.d.ts +1 -1
- package/serialization/resources/webhooks/types/WebhookId.d.ts +1 -1
- package/serialization/resources/webhooks/types/index.d.ts +0 -5
- package/serialization/resources/webhooks/types/index.js +0 -5
- package/serialization/resources/websockets/index.d.ts +1 -0
- package/serialization/resources/websockets/index.js +17 -0
- package/{dist/serialization/resources/webhooks/types/MessageReceivedPayload.d.ts → serialization/resources/websockets/types/MessageReceived.d.ts} +4 -4
- package/serialization/resources/websockets/types/MessageReceived.js +48 -0
- package/serialization/resources/websockets/types/Subscribe.d.ts +13 -0
- package/serialization/resources/websockets/types/Subscribe.js +44 -0
- package/serialization/resources/websockets/types/Subscribed.d.ts +13 -0
- package/serialization/resources/websockets/types/Subscribed.js +44 -0
- package/serialization/resources/websockets/types/index.d.ts +4 -0
- package/serialization/resources/websockets/types/index.js +20 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/dist/serialization/resources/webhooks/types/SvixId.d.ts +0 -10
- package/dist/serialization/resources/webhooks/types/SvixSignature.d.ts +0 -10
- package/dist/serialization/resources/webhooks/types/SvixTimestamp.d.ts +0 -10
- package/serialization/resources/webhooks/types/SvixId.d.ts +0 -10
- package/serialization/resources/webhooks/types/SvixSignature.d.ts +0 -10
- package/serialization/resources/webhooks/types/SvixTimestamp.d.ts +0 -10
- /package/api/resources/webhooks/{types → resources/events/types}/EventId.d.ts +0 -0
- /package/api/resources/webhooks/{types → resources/events/types}/EventId.js +0 -0
- /package/api/resources/webhooks/{types → resources/events/types}/MessageReceivedPayload.js +0 -0
- /package/api/resources/webhooks/{types → resources/events/types}/SvixId.d.ts +0 -0
- /package/api/resources/webhooks/{types → resources/events/types}/SvixId.js +0 -0
- /package/api/resources/webhooks/{types → resources/events/types}/SvixSignature.d.ts +0 -0
- /package/api/resources/webhooks/{types → resources/events/types}/SvixSignature.js +0 -0
- /package/api/resources/webhooks/{types → resources/events/types}/SvixTimestamp.d.ts +0 -0
- /package/api/resources/webhooks/{types → resources/events/types}/SvixTimestamp.js +0 -0
- /package/{dist/api/resources/webhooks → api/resources/websockets}/types/EventId.d.ts +0 -0
- /package/{dist/api/resources/webhooks → api/resources/websockets}/types/EventId.js +0 -0
- /package/{dist/api/resources/webhooks/types/MessageReceivedPayload.js → api/resources/websockets/types/MessageReceived.js} +0 -0
- /package/{dist/api/resources/webhooks/types/SvixId.js → api/resources/websockets/types/Subscribe.js} +0 -0
- /package/{dist/api/resources/webhooks/types/SvixSignature.js → api/resources/websockets/types/Subscribed.js} +0 -0
- /package/dist/api/resources/webhooks/{types/SvixTimestamp.js → resources/events/types/EventId.js} +0 -0
- /package/dist/api/resources/webhooks/{types → resources/events/types}/SvixId.d.ts +0 -0
- /package/dist/api/resources/webhooks/{types → resources/events/types}/SvixSignature.d.ts +0 -0
- /package/dist/api/resources/webhooks/{types → resources/events/types}/SvixTimestamp.d.ts +0 -0
- /package/dist/serialization/resources/{webhooks → websockets}/types/EventId.d.ts +0 -0
- /package/dist/serialization/resources/{webhooks → websockets}/types/EventId.js +0 -0
- /package/serialization/resources/{webhooks → websockets}/types/EventId.d.ts +0 -0
- /package/serialization/resources/{webhooks → websockets}/types/EventId.js +0 -0
package/reference.md
CHANGED
|
@@ -151,9 +151,9 @@ await client.inboxes.create({
|
|
|
151
151
|
</dl>
|
|
152
152
|
</details>
|
|
153
153
|
|
|
154
|
-
##
|
|
154
|
+
## Webhooks
|
|
155
155
|
|
|
156
|
-
<details><summary><code>client.
|
|
156
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListWebhooksResponse</code></summary>
|
|
157
157
|
<dl>
|
|
158
158
|
<dd>
|
|
159
159
|
|
|
@@ -166,7 +166,7 @@ await client.inboxes.create({
|
|
|
166
166
|
<dd>
|
|
167
167
|
|
|
168
168
|
```typescript
|
|
169
|
-
await client.
|
|
169
|
+
await client.webhooks.list();
|
|
170
170
|
```
|
|
171
171
|
|
|
172
172
|
</dd>
|
|
@@ -182,7 +182,7 @@ await client.domains.list();
|
|
|
182
182
|
<dl>
|
|
183
183
|
<dd>
|
|
184
184
|
|
|
185
|
-
**request:** `AgentMail.
|
|
185
|
+
**request:** `AgentMail.webhooks.ListWebhooksRequest`
|
|
186
186
|
|
|
187
187
|
</dd>
|
|
188
188
|
</dl>
|
|
@@ -190,7 +190,7 @@ await client.domains.list();
|
|
|
190
190
|
<dl>
|
|
191
191
|
<dd>
|
|
192
192
|
|
|
193
|
-
**requestOptions:** `
|
|
193
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
194
194
|
|
|
195
195
|
</dd>
|
|
196
196
|
</dl>
|
|
@@ -201,7 +201,7 @@ await client.domains.list();
|
|
|
201
201
|
</dl>
|
|
202
202
|
</details>
|
|
203
203
|
|
|
204
|
-
<details><summary><code>client.
|
|
204
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">get</a>(webhookId) -> AgentMail.Webhook</code></summary>
|
|
205
205
|
<dl>
|
|
206
206
|
<dd>
|
|
207
207
|
|
|
@@ -214,7 +214,7 @@ await client.domains.list();
|
|
|
214
214
|
<dd>
|
|
215
215
|
|
|
216
216
|
```typescript
|
|
217
|
-
await client.
|
|
217
|
+
await client.webhooks.get("webhook_id");
|
|
218
218
|
```
|
|
219
219
|
|
|
220
220
|
</dd>
|
|
@@ -230,7 +230,7 @@ await client.domains.get(" your-domain.com");
|
|
|
230
230
|
<dl>
|
|
231
231
|
<dd>
|
|
232
232
|
|
|
233
|
-
**
|
|
233
|
+
**webhookId:** `AgentMail.WebhookId`
|
|
234
234
|
|
|
235
235
|
</dd>
|
|
236
236
|
</dl>
|
|
@@ -238,7 +238,7 @@ await client.domains.get(" your-domain.com");
|
|
|
238
238
|
<dl>
|
|
239
239
|
<dd>
|
|
240
240
|
|
|
241
|
-
**requestOptions:** `
|
|
241
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
242
242
|
|
|
243
243
|
</dd>
|
|
244
244
|
</dl>
|
|
@@ -249,7 +249,7 @@ await client.domains.get(" your-domain.com");
|
|
|
249
249
|
</dl>
|
|
250
250
|
</details>
|
|
251
251
|
|
|
252
|
-
<details><summary><code>client.
|
|
252
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">create</a>({ ...params }) -> AgentMail.Webhook</code></summary>
|
|
253
253
|
<dl>
|
|
254
254
|
<dd>
|
|
255
255
|
|
|
@@ -262,8 +262,11 @@ await client.domains.get(" your-domain.com");
|
|
|
262
262
|
<dd>
|
|
263
263
|
|
|
264
264
|
```typescript
|
|
265
|
-
await client.
|
|
266
|
-
|
|
265
|
+
await client.webhooks.create({
|
|
266
|
+
url: "url",
|
|
267
|
+
eventTypes: ["message.received", "message.received"],
|
|
268
|
+
inboxIds: undefined,
|
|
269
|
+
clientId: undefined,
|
|
267
270
|
});
|
|
268
271
|
```
|
|
269
272
|
|
|
@@ -280,7 +283,7 @@ await client.domains.create({
|
|
|
280
283
|
<dl>
|
|
281
284
|
<dd>
|
|
282
285
|
|
|
283
|
-
**request:** `AgentMail.
|
|
286
|
+
**request:** `AgentMail.CreateWebhookRequest`
|
|
284
287
|
|
|
285
288
|
</dd>
|
|
286
289
|
</dl>
|
|
@@ -288,7 +291,7 @@ await client.domains.create({
|
|
|
288
291
|
<dl>
|
|
289
292
|
<dd>
|
|
290
293
|
|
|
291
|
-
**requestOptions:** `
|
|
294
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
292
295
|
|
|
293
296
|
</dd>
|
|
294
297
|
</dl>
|
|
@@ -299,7 +302,7 @@ await client.domains.create({
|
|
|
299
302
|
</dl>
|
|
300
303
|
</details>
|
|
301
304
|
|
|
302
|
-
<details><summary><code>client.
|
|
305
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">delete</a>(webhookId) -> void</code></summary>
|
|
303
306
|
<dl>
|
|
304
307
|
<dd>
|
|
305
308
|
|
|
@@ -312,7 +315,7 @@ await client.domains.create({
|
|
|
312
315
|
<dd>
|
|
313
316
|
|
|
314
317
|
```typescript
|
|
315
|
-
await client.
|
|
318
|
+
await client.webhooks.delete("webhook_id");
|
|
316
319
|
```
|
|
317
320
|
|
|
318
321
|
</dd>
|
|
@@ -328,7 +331,7 @@ await client.domains.delete("dom_12345");
|
|
|
328
331
|
<dl>
|
|
329
332
|
<dd>
|
|
330
333
|
|
|
331
|
-
**
|
|
334
|
+
**webhookId:** `AgentMail.WebhookId`
|
|
332
335
|
|
|
333
336
|
</dd>
|
|
334
337
|
</dl>
|
|
@@ -336,7 +339,7 @@ await client.domains.delete("dom_12345");
|
|
|
336
339
|
<dl>
|
|
337
340
|
<dd>
|
|
338
341
|
|
|
339
|
-
**requestOptions:** `
|
|
342
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
340
343
|
|
|
341
344
|
</dd>
|
|
342
345
|
</dl>
|
|
@@ -347,9 +350,9 @@ await client.domains.delete("dom_12345");
|
|
|
347
350
|
</dl>
|
|
348
351
|
</details>
|
|
349
352
|
|
|
350
|
-
##
|
|
353
|
+
## Domains
|
|
351
354
|
|
|
352
|
-
<details><summary><code>client.
|
|
355
|
+
<details><summary><code>client.domains.<a href="/src/api/resources/domains/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListDomainsResponse</code></summary>
|
|
353
356
|
<dl>
|
|
354
357
|
<dd>
|
|
355
358
|
|
|
@@ -362,7 +365,7 @@ await client.domains.delete("dom_12345");
|
|
|
362
365
|
<dd>
|
|
363
366
|
|
|
364
367
|
```typescript
|
|
365
|
-
await client.
|
|
368
|
+
await client.domains.list();
|
|
366
369
|
```
|
|
367
370
|
|
|
368
371
|
</dd>
|
|
@@ -378,7 +381,7 @@ await client.drafts.list();
|
|
|
378
381
|
<dl>
|
|
379
382
|
<dd>
|
|
380
383
|
|
|
381
|
-
**request:** `AgentMail.
|
|
384
|
+
**request:** `AgentMail.ListDomainsRequest`
|
|
382
385
|
|
|
383
386
|
</dd>
|
|
384
387
|
</dl>
|
|
@@ -386,7 +389,7 @@ await client.drafts.list();
|
|
|
386
389
|
<dl>
|
|
387
390
|
<dd>
|
|
388
391
|
|
|
389
|
-
**requestOptions:** `
|
|
392
|
+
**requestOptions:** `Domains.RequestOptions`
|
|
390
393
|
|
|
391
394
|
</dd>
|
|
392
395
|
</dl>
|
|
@@ -397,7 +400,7 @@ await client.drafts.list();
|
|
|
397
400
|
</dl>
|
|
398
401
|
</details>
|
|
399
402
|
|
|
400
|
-
<details><summary><code>client.
|
|
403
|
+
<details><summary><code>client.domains.<a href="/src/api/resources/domains/client/Client.ts">get</a>(domain) -> AgentMail.Domain</code></summary>
|
|
401
404
|
<dl>
|
|
402
405
|
<dd>
|
|
403
406
|
|
|
@@ -410,7 +413,7 @@ await client.drafts.list();
|
|
|
410
413
|
<dd>
|
|
411
414
|
|
|
412
415
|
```typescript
|
|
413
|
-
await client.
|
|
416
|
+
await client.domains.get(" your-domain.com");
|
|
414
417
|
```
|
|
415
418
|
|
|
416
419
|
</dd>
|
|
@@ -426,7 +429,7 @@ await client.drafts.get("draft_id");
|
|
|
426
429
|
<dl>
|
|
427
430
|
<dd>
|
|
428
431
|
|
|
429
|
-
**
|
|
432
|
+
**domain:** `AgentMail.DomainId`
|
|
430
433
|
|
|
431
434
|
</dd>
|
|
432
435
|
</dl>
|
|
@@ -434,7 +437,7 @@ await client.drafts.get("draft_id");
|
|
|
434
437
|
<dl>
|
|
435
438
|
<dd>
|
|
436
439
|
|
|
437
|
-
**requestOptions:** `
|
|
440
|
+
**requestOptions:** `Domains.RequestOptions`
|
|
438
441
|
|
|
439
442
|
</dd>
|
|
440
443
|
</dl>
|
|
@@ -445,9 +448,7 @@ await client.drafts.get("draft_id");
|
|
|
445
448
|
</dl>
|
|
446
449
|
</details>
|
|
447
450
|
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMail.ListDraftsResponse</code></summary>
|
|
451
|
+
<details><summary><code>client.domains.<a href="/src/api/resources/domains/client/Client.ts">create</a>({ ...params }) -> AgentMail.CreateDomainResponse</code></summary>
|
|
451
452
|
<dl>
|
|
452
453
|
<dd>
|
|
453
454
|
|
|
@@ -460,7 +461,9 @@ await client.drafts.get("draft_id");
|
|
|
460
461
|
<dd>
|
|
461
462
|
|
|
462
463
|
```typescript
|
|
463
|
-
await client.
|
|
464
|
+
await client.domains.create({
|
|
465
|
+
domain: "your-domain.com",
|
|
466
|
+
});
|
|
464
467
|
```
|
|
465
468
|
|
|
466
469
|
</dd>
|
|
@@ -476,15 +479,7 @@ await client.inboxes.drafts.list("inbox_id");
|
|
|
476
479
|
<dl>
|
|
477
480
|
<dd>
|
|
478
481
|
|
|
479
|
-
**
|
|
480
|
-
|
|
481
|
-
</dd>
|
|
482
|
-
</dl>
|
|
483
|
-
|
|
484
|
-
<dl>
|
|
485
|
-
<dd>
|
|
486
|
-
|
|
487
|
-
**request:** `AgentMail.inboxes.ListDraftsRequest`
|
|
482
|
+
**request:** `AgentMail.CreateDomainRequest`
|
|
488
483
|
|
|
489
484
|
</dd>
|
|
490
485
|
</dl>
|
|
@@ -492,7 +487,7 @@ await client.inboxes.drafts.list("inbox_id");
|
|
|
492
487
|
<dl>
|
|
493
488
|
<dd>
|
|
494
489
|
|
|
495
|
-
**requestOptions:** `
|
|
490
|
+
**requestOptions:** `Domains.RequestOptions`
|
|
496
491
|
|
|
497
492
|
</dd>
|
|
498
493
|
</dl>
|
|
@@ -503,7 +498,7 @@ await client.inboxes.drafts.list("inbox_id");
|
|
|
503
498
|
</dl>
|
|
504
499
|
</details>
|
|
505
500
|
|
|
506
|
-
<details><summary><code>client.
|
|
501
|
+
<details><summary><code>client.domains.<a href="/src/api/resources/domains/client/Client.ts">delete</a>(domain) -> void</code></summary>
|
|
507
502
|
<dl>
|
|
508
503
|
<dd>
|
|
509
504
|
|
|
@@ -516,7 +511,7 @@ await client.inboxes.drafts.list("inbox_id");
|
|
|
516
511
|
<dd>
|
|
517
512
|
|
|
518
513
|
```typescript
|
|
519
|
-
await client.
|
|
514
|
+
await client.domains.delete("dom_12345");
|
|
520
515
|
```
|
|
521
516
|
|
|
522
517
|
</dd>
|
|
@@ -532,15 +527,7 @@ await client.inboxes.drafts.get("inbox_id", "draft_id");
|
|
|
532
527
|
<dl>
|
|
533
528
|
<dd>
|
|
534
529
|
|
|
535
|
-
**
|
|
536
|
-
|
|
537
|
-
</dd>
|
|
538
|
-
</dl>
|
|
539
|
-
|
|
540
|
-
<dl>
|
|
541
|
-
<dd>
|
|
542
|
-
|
|
543
|
-
**draftId:** `AgentMail.DraftId`
|
|
530
|
+
**domain:** `AgentMail.DomainId`
|
|
544
531
|
|
|
545
532
|
</dd>
|
|
546
533
|
</dl>
|
|
@@ -548,7 +535,7 @@ await client.inboxes.drafts.get("inbox_id", "draft_id");
|
|
|
548
535
|
<dl>
|
|
549
536
|
<dd>
|
|
550
537
|
|
|
551
|
-
**requestOptions:** `
|
|
538
|
+
**requestOptions:** `Domains.RequestOptions`
|
|
552
539
|
|
|
553
540
|
</dd>
|
|
554
541
|
</dl>
|
|
@@ -559,7 +546,9 @@ await client.inboxes.drafts.get("inbox_id", "draft_id");
|
|
|
559
546
|
</dl>
|
|
560
547
|
</details>
|
|
561
548
|
|
|
562
|
-
|
|
549
|
+
## Drafts
|
|
550
|
+
|
|
551
|
+
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListDraftsResponse</code></summary>
|
|
563
552
|
<dl>
|
|
564
553
|
<dd>
|
|
565
554
|
|
|
@@ -572,16 +561,7 @@ await client.inboxes.drafts.get("inbox_id", "draft_id");
|
|
|
572
561
|
<dd>
|
|
573
562
|
|
|
574
563
|
```typescript
|
|
575
|
-
await client.
|
|
576
|
-
labels: undefined,
|
|
577
|
-
replyTo: undefined,
|
|
578
|
-
to: undefined,
|
|
579
|
-
cc: undefined,
|
|
580
|
-
bcc: undefined,
|
|
581
|
-
subject: undefined,
|
|
582
|
-
text: undefined,
|
|
583
|
-
html: undefined,
|
|
584
|
-
});
|
|
564
|
+
await client.drafts.list();
|
|
585
565
|
```
|
|
586
566
|
|
|
587
567
|
</dd>
|
|
@@ -597,15 +577,7 @@ await client.inboxes.drafts.create("inbox_id", {
|
|
|
597
577
|
<dl>
|
|
598
578
|
<dd>
|
|
599
579
|
|
|
600
|
-
**
|
|
601
|
-
|
|
602
|
-
</dd>
|
|
603
|
-
</dl>
|
|
604
|
-
|
|
605
|
-
<dl>
|
|
606
|
-
<dd>
|
|
607
|
-
|
|
608
|
-
**request:** `AgentMail.CreateDraftRequest`
|
|
580
|
+
**request:** `AgentMail.ListDraftsRequest`
|
|
609
581
|
|
|
610
582
|
</dd>
|
|
611
583
|
</dl>
|
|
@@ -624,7 +596,7 @@ await client.inboxes.drafts.create("inbox_id", {
|
|
|
624
596
|
</dl>
|
|
625
597
|
</details>
|
|
626
598
|
|
|
627
|
-
<details><summary><code>client.
|
|
599
|
+
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">get</a>(draftId) -> AgentMail.Draft</code></summary>
|
|
628
600
|
<dl>
|
|
629
601
|
<dd>
|
|
630
602
|
|
|
@@ -637,10 +609,7 @@ await client.inboxes.drafts.create("inbox_id", {
|
|
|
637
609
|
<dd>
|
|
638
610
|
|
|
639
611
|
```typescript
|
|
640
|
-
await client.
|
|
641
|
-
addLabels: undefined,
|
|
642
|
-
removeLabels: undefined,
|
|
643
|
-
});
|
|
612
|
+
await client.drafts.get("draft_id");
|
|
644
613
|
```
|
|
645
614
|
|
|
646
615
|
</dd>
|
|
@@ -656,14 +625,6 @@ await client.inboxes.drafts.send("inbox_id", "draft_id", {
|
|
|
656
625
|
<dl>
|
|
657
626
|
<dd>
|
|
658
627
|
|
|
659
|
-
**inboxId:** `AgentMail.InboxId`
|
|
660
|
-
|
|
661
|
-
</dd>
|
|
662
|
-
</dl>
|
|
663
|
-
|
|
664
|
-
<dl>
|
|
665
|
-
<dd>
|
|
666
|
-
|
|
667
628
|
**draftId:** `AgentMail.DraftId`
|
|
668
629
|
|
|
669
630
|
</dd>
|
|
@@ -672,14 +633,6 @@ await client.inboxes.drafts.send("inbox_id", "draft_id", {
|
|
|
672
633
|
<dl>
|
|
673
634
|
<dd>
|
|
674
635
|
|
|
675
|
-
**request:** `AgentMail.UpdateMessageRequest`
|
|
676
|
-
|
|
677
|
-
</dd>
|
|
678
|
-
</dl>
|
|
679
|
-
|
|
680
|
-
<dl>
|
|
681
|
-
<dd>
|
|
682
|
-
|
|
683
636
|
**requestOptions:** `Drafts.RequestOptions`
|
|
684
637
|
|
|
685
638
|
</dd>
|
|
@@ -691,9 +644,9 @@ await client.inboxes.drafts.send("inbox_id", "draft_id", {
|
|
|
691
644
|
</dl>
|
|
692
645
|
</details>
|
|
693
646
|
|
|
694
|
-
## Inboxes
|
|
647
|
+
## Inboxes Drafts
|
|
695
648
|
|
|
696
|
-
<details><summary><code>client.inboxes.
|
|
649
|
+
<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMail.ListDraftsResponse</code></summary>
|
|
697
650
|
<dl>
|
|
698
651
|
<dd>
|
|
699
652
|
|
|
@@ -706,7 +659,7 @@ await client.inboxes.drafts.send("inbox_id", "draft_id", {
|
|
|
706
659
|
<dd>
|
|
707
660
|
|
|
708
661
|
```typescript
|
|
709
|
-
await client.inboxes.
|
|
662
|
+
await client.inboxes.drafts.list("inbox_id");
|
|
710
663
|
```
|
|
711
664
|
|
|
712
665
|
</dd>
|
|
@@ -730,7 +683,7 @@ await client.inboxes.messages.list("inbox_id");
|
|
|
730
683
|
<dl>
|
|
731
684
|
<dd>
|
|
732
685
|
|
|
733
|
-
**request:** `AgentMail.inboxes.
|
|
686
|
+
**request:** `AgentMail.inboxes.ListDraftsRequest`
|
|
734
687
|
|
|
735
688
|
</dd>
|
|
736
689
|
</dl>
|
|
@@ -738,7 +691,7 @@ await client.inboxes.messages.list("inbox_id");
|
|
|
738
691
|
<dl>
|
|
739
692
|
<dd>
|
|
740
693
|
|
|
741
|
-
**requestOptions:** `
|
|
694
|
+
**requestOptions:** `Drafts.RequestOptions`
|
|
742
695
|
|
|
743
696
|
</dd>
|
|
744
697
|
</dl>
|
|
@@ -749,7 +702,7 @@ await client.inboxes.messages.list("inbox_id");
|
|
|
749
702
|
</dl>
|
|
750
703
|
</details>
|
|
751
704
|
|
|
752
|
-
<details><summary><code>client.inboxes.
|
|
705
|
+
<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">get</a>(inboxId, draftId) -> AgentMail.Draft</code></summary>
|
|
753
706
|
<dl>
|
|
754
707
|
<dd>
|
|
755
708
|
|
|
@@ -762,7 +715,7 @@ await client.inboxes.messages.list("inbox_id");
|
|
|
762
715
|
<dd>
|
|
763
716
|
|
|
764
717
|
```typescript
|
|
765
|
-
await client.inboxes.
|
|
718
|
+
await client.inboxes.drafts.get("inbox_id", "draft_id");
|
|
766
719
|
```
|
|
767
720
|
|
|
768
721
|
</dd>
|
|
@@ -786,7 +739,7 @@ await client.inboxes.messages.get("inbox_id", "message_id");
|
|
|
786
739
|
<dl>
|
|
787
740
|
<dd>
|
|
788
741
|
|
|
789
|
-
**
|
|
742
|
+
**draftId:** `AgentMail.DraftId`
|
|
790
743
|
|
|
791
744
|
</dd>
|
|
792
745
|
</dl>
|
|
@@ -794,7 +747,7 @@ await client.inboxes.messages.get("inbox_id", "message_id");
|
|
|
794
747
|
<dl>
|
|
795
748
|
<dd>
|
|
796
749
|
|
|
797
|
-
**requestOptions:** `
|
|
750
|
+
**requestOptions:** `Drafts.RequestOptions`
|
|
798
751
|
|
|
799
752
|
</dd>
|
|
800
753
|
</dl>
|
|
@@ -805,7 +758,7 @@ await client.inboxes.messages.get("inbox_id", "message_id");
|
|
|
805
758
|
</dl>
|
|
806
759
|
</details>
|
|
807
760
|
|
|
808
|
-
<details><summary><code>client.inboxes.
|
|
761
|
+
<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">create</a>(inboxId, { ...params }) -> AgentMail.Draft</code></summary>
|
|
809
762
|
<dl>
|
|
810
763
|
<dd>
|
|
811
764
|
|
|
@@ -818,7 +771,7 @@ await client.inboxes.messages.get("inbox_id", "message_id");
|
|
|
818
771
|
<dd>
|
|
819
772
|
|
|
820
773
|
```typescript
|
|
821
|
-
await client.inboxes.
|
|
774
|
+
await client.inboxes.drafts.create("inbox_id", {
|
|
822
775
|
labels: undefined,
|
|
823
776
|
replyTo: undefined,
|
|
824
777
|
to: undefined,
|
|
@@ -827,7 +780,6 @@ await client.inboxes.messages.send("inbox_id", {
|
|
|
827
780
|
subject: undefined,
|
|
828
781
|
text: undefined,
|
|
829
782
|
html: undefined,
|
|
830
|
-
attachments: undefined,
|
|
831
783
|
});
|
|
832
784
|
```
|
|
833
785
|
|
|
@@ -852,7 +804,7 @@ await client.inboxes.messages.send("inbox_id", {
|
|
|
852
804
|
<dl>
|
|
853
805
|
<dd>
|
|
854
806
|
|
|
855
|
-
**request:** `AgentMail.
|
|
807
|
+
**request:** `AgentMail.CreateDraftRequest`
|
|
856
808
|
|
|
857
809
|
</dd>
|
|
858
810
|
</dl>
|
|
@@ -860,7 +812,7 @@ await client.inboxes.messages.send("inbox_id", {
|
|
|
860
812
|
<dl>
|
|
861
813
|
<dd>
|
|
862
814
|
|
|
863
|
-
**requestOptions:** `
|
|
815
|
+
**requestOptions:** `Drafts.RequestOptions`
|
|
864
816
|
|
|
865
817
|
</dd>
|
|
866
818
|
</dl>
|
|
@@ -871,7 +823,7 @@ await client.inboxes.messages.send("inbox_id", {
|
|
|
871
823
|
</dl>
|
|
872
824
|
</details>
|
|
873
825
|
|
|
874
|
-
<details><summary><code>client.inboxes.
|
|
826
|
+
<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">send</a>(inboxId, draftId, { ...params }) -> AgentMail.SendMessageResponse</code></summary>
|
|
875
827
|
<dl>
|
|
876
828
|
<dd>
|
|
877
829
|
|
|
@@ -884,15 +836,9 @@ await client.inboxes.messages.send("inbox_id", {
|
|
|
884
836
|
<dd>
|
|
885
837
|
|
|
886
838
|
```typescript
|
|
887
|
-
await client.inboxes.
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
to: undefined,
|
|
891
|
-
cc: undefined,
|
|
892
|
-
bcc: undefined,
|
|
893
|
-
text: undefined,
|
|
894
|
-
html: undefined,
|
|
895
|
-
attachments: undefined,
|
|
839
|
+
await client.inboxes.drafts.send("inbox_id", "draft_id", {
|
|
840
|
+
addLabels: undefined,
|
|
841
|
+
removeLabels: undefined,
|
|
896
842
|
});
|
|
897
843
|
```
|
|
898
844
|
|
|
@@ -917,7 +863,7 @@ await client.inboxes.messages.reply("inbox_id", "message_id", {
|
|
|
917
863
|
<dl>
|
|
918
864
|
<dd>
|
|
919
865
|
|
|
920
|
-
**
|
|
866
|
+
**draftId:** `AgentMail.DraftId`
|
|
921
867
|
|
|
922
868
|
</dd>
|
|
923
869
|
</dl>
|
|
@@ -925,7 +871,7 @@ await client.inboxes.messages.reply("inbox_id", "message_id", {
|
|
|
925
871
|
<dl>
|
|
926
872
|
<dd>
|
|
927
873
|
|
|
928
|
-
**request:** `AgentMail.
|
|
874
|
+
**request:** `AgentMail.UpdateMessageRequest`
|
|
929
875
|
|
|
930
876
|
</dd>
|
|
931
877
|
</dl>
|
|
@@ -933,7 +879,7 @@ await client.inboxes.messages.reply("inbox_id", "message_id", {
|
|
|
933
879
|
<dl>
|
|
934
880
|
<dd>
|
|
935
881
|
|
|
936
|
-
**requestOptions:** `
|
|
882
|
+
**requestOptions:** `Drafts.RequestOptions`
|
|
937
883
|
|
|
938
884
|
</dd>
|
|
939
885
|
</dl>
|
|
@@ -944,7 +890,9 @@ await client.inboxes.messages.reply("inbox_id", "message_id", {
|
|
|
944
890
|
</dl>
|
|
945
891
|
</details>
|
|
946
892
|
|
|
947
|
-
|
|
893
|
+
## Inboxes Messages
|
|
894
|
+
|
|
895
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMail.ListMessagesResponse</code></summary>
|
|
948
896
|
<dl>
|
|
949
897
|
<dd>
|
|
950
898
|
|
|
@@ -957,10 +905,7 @@ await client.inboxes.messages.reply("inbox_id", "message_id", {
|
|
|
957
905
|
<dd>
|
|
958
906
|
|
|
959
907
|
```typescript
|
|
960
|
-
await client.inboxes.messages.
|
|
961
|
-
addLabels: undefined,
|
|
962
|
-
removeLabels: undefined,
|
|
963
|
-
});
|
|
908
|
+
await client.inboxes.messages.list("inbox_id");
|
|
964
909
|
```
|
|
965
910
|
|
|
966
911
|
</dd>
|
|
@@ -984,15 +929,7 @@ await client.inboxes.messages.update("inbox_id", "message_id", {
|
|
|
984
929
|
<dl>
|
|
985
930
|
<dd>
|
|
986
931
|
|
|
987
|
-
**
|
|
988
|
-
|
|
989
|
-
</dd>
|
|
990
|
-
</dl>
|
|
991
|
-
|
|
992
|
-
<dl>
|
|
993
|
-
<dd>
|
|
994
|
-
|
|
995
|
-
**request:** `AgentMail.UpdateMessageRequest`
|
|
932
|
+
**request:** `AgentMail.inboxes.ListMessagesRequest`
|
|
996
933
|
|
|
997
934
|
</dd>
|
|
998
935
|
</dl>
|
|
@@ -1011,9 +948,7 @@ await client.inboxes.messages.update("inbox_id", "message_id", {
|
|
|
1011
948
|
</dl>
|
|
1012
949
|
</details>
|
|
1013
950
|
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
951
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">get</a>(inboxId, messageId) -> AgentMail.Message</code></summary>
|
|
1017
952
|
<dl>
|
|
1018
953
|
<dd>
|
|
1019
954
|
|
|
@@ -1026,7 +961,7 @@ await client.inboxes.messages.update("inbox_id", "message_id", {
|
|
|
1026
961
|
<dd>
|
|
1027
962
|
|
|
1028
963
|
```typescript
|
|
1029
|
-
await client.inboxes.
|
|
964
|
+
await client.inboxes.messages.get("inbox_id", "message_id");
|
|
1030
965
|
```
|
|
1031
966
|
|
|
1032
967
|
</dd>
|
|
@@ -1050,7 +985,7 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
1050
985
|
<dl>
|
|
1051
986
|
<dd>
|
|
1052
987
|
|
|
1053
|
-
**
|
|
988
|
+
**messageId:** `AgentMail.MessageId`
|
|
1054
989
|
|
|
1055
990
|
</dd>
|
|
1056
991
|
</dl>
|
|
@@ -1058,7 +993,7 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
1058
993
|
<dl>
|
|
1059
994
|
<dd>
|
|
1060
995
|
|
|
1061
|
-
**requestOptions:** `
|
|
996
|
+
**requestOptions:** `Messages.RequestOptions`
|
|
1062
997
|
|
|
1063
998
|
</dd>
|
|
1064
999
|
</dl>
|
|
@@ -1069,7 +1004,7 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
1069
1004
|
</dl>
|
|
1070
1005
|
</details>
|
|
1071
1006
|
|
|
1072
|
-
<details><summary><code>client.inboxes.
|
|
1007
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">send</a>(inboxId, { ...params }) -> AgentMail.SendMessageResponse</code></summary>
|
|
1073
1008
|
<dl>
|
|
1074
1009
|
<dd>
|
|
1075
1010
|
|
|
@@ -1082,7 +1017,17 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
1082
1017
|
<dd>
|
|
1083
1018
|
|
|
1084
1019
|
```typescript
|
|
1085
|
-
await client.inboxes.
|
|
1020
|
+
await client.inboxes.messages.send("inbox_id", {
|
|
1021
|
+
labels: undefined,
|
|
1022
|
+
replyTo: undefined,
|
|
1023
|
+
to: undefined,
|
|
1024
|
+
cc: undefined,
|
|
1025
|
+
bcc: undefined,
|
|
1026
|
+
subject: undefined,
|
|
1027
|
+
text: undefined,
|
|
1028
|
+
html: undefined,
|
|
1029
|
+
attachments: undefined,
|
|
1030
|
+
});
|
|
1086
1031
|
```
|
|
1087
1032
|
|
|
1088
1033
|
</dd>
|
|
@@ -1106,7 +1051,7 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
1106
1051
|
<dl>
|
|
1107
1052
|
<dd>
|
|
1108
1053
|
|
|
1109
|
-
**
|
|
1054
|
+
**request:** `AgentMail.SendMessageRequest`
|
|
1110
1055
|
|
|
1111
1056
|
</dd>
|
|
1112
1057
|
</dl>
|
|
@@ -1114,7 +1059,7 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
1114
1059
|
<dl>
|
|
1115
1060
|
<dd>
|
|
1116
1061
|
|
|
1117
|
-
**requestOptions:** `
|
|
1062
|
+
**requestOptions:** `Messages.RequestOptions`
|
|
1118
1063
|
|
|
1119
1064
|
</dd>
|
|
1120
1065
|
</dl>
|
|
@@ -1125,9 +1070,7 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
1125
1070
|
</dl>
|
|
1126
1071
|
</details>
|
|
1127
1072
|
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
1073
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">reply</a>(inboxId, messageId, { ...params }) -> AgentMail.SendMessageResponse</code></summary>
|
|
1131
1074
|
<dl>
|
|
1132
1075
|
<dd>
|
|
1133
1076
|
|
|
@@ -1140,7 +1083,16 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
1140
1083
|
<dd>
|
|
1141
1084
|
|
|
1142
1085
|
```typescript
|
|
1143
|
-
await client.
|
|
1086
|
+
await client.inboxes.messages.reply("inbox_id", "message_id", {
|
|
1087
|
+
labels: undefined,
|
|
1088
|
+
replyTo: undefined,
|
|
1089
|
+
to: undefined,
|
|
1090
|
+
cc: undefined,
|
|
1091
|
+
bcc: undefined,
|
|
1092
|
+
text: undefined,
|
|
1093
|
+
html: undefined,
|
|
1094
|
+
attachments: undefined,
|
|
1095
|
+
});
|
|
1144
1096
|
```
|
|
1145
1097
|
|
|
1146
1098
|
</dd>
|
|
@@ -1156,7 +1108,7 @@ await client.threads.list();
|
|
|
1156
1108
|
<dl>
|
|
1157
1109
|
<dd>
|
|
1158
1110
|
|
|
1159
|
-
**
|
|
1111
|
+
**inboxId:** `AgentMail.InboxId`
|
|
1160
1112
|
|
|
1161
1113
|
</dd>
|
|
1162
1114
|
</dl>
|
|
@@ -1164,7 +1116,23 @@ await client.threads.list();
|
|
|
1164
1116
|
<dl>
|
|
1165
1117
|
<dd>
|
|
1166
1118
|
|
|
1167
|
-
**
|
|
1119
|
+
**messageId:** `AgentMail.MessageId`
|
|
1120
|
+
|
|
1121
|
+
</dd>
|
|
1122
|
+
</dl>
|
|
1123
|
+
|
|
1124
|
+
<dl>
|
|
1125
|
+
<dd>
|
|
1126
|
+
|
|
1127
|
+
**request:** `AgentMail.ReplyToMessageRequest`
|
|
1128
|
+
|
|
1129
|
+
</dd>
|
|
1130
|
+
</dl>
|
|
1131
|
+
|
|
1132
|
+
<dl>
|
|
1133
|
+
<dd>
|
|
1134
|
+
|
|
1135
|
+
**requestOptions:** `Messages.RequestOptions`
|
|
1168
1136
|
|
|
1169
1137
|
</dd>
|
|
1170
1138
|
</dl>
|
|
@@ -1175,7 +1143,7 @@ await client.threads.list();
|
|
|
1175
1143
|
</dl>
|
|
1176
1144
|
</details>
|
|
1177
1145
|
|
|
1178
|
-
<details><summary><code>client.
|
|
1146
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">update</a>(inboxId, messageId, { ...params }) -> AgentMail.Message</code></summary>
|
|
1179
1147
|
<dl>
|
|
1180
1148
|
<dd>
|
|
1181
1149
|
|
|
@@ -1188,7 +1156,10 @@ await client.threads.list();
|
|
|
1188
1156
|
<dd>
|
|
1189
1157
|
|
|
1190
1158
|
```typescript
|
|
1191
|
-
await client.
|
|
1159
|
+
await client.inboxes.messages.update("inbox_id", "message_id", {
|
|
1160
|
+
addLabels: undefined,
|
|
1161
|
+
removeLabels: undefined,
|
|
1162
|
+
});
|
|
1192
1163
|
```
|
|
1193
1164
|
|
|
1194
1165
|
</dd>
|
|
@@ -1204,7 +1175,7 @@ await client.threads.get("thread_id");
|
|
|
1204
1175
|
<dl>
|
|
1205
1176
|
<dd>
|
|
1206
1177
|
|
|
1207
|
-
**
|
|
1178
|
+
**inboxId:** `AgentMail.InboxId`
|
|
1208
1179
|
|
|
1209
1180
|
</dd>
|
|
1210
1181
|
</dl>
|
|
@@ -1212,7 +1183,23 @@ await client.threads.get("thread_id");
|
|
|
1212
1183
|
<dl>
|
|
1213
1184
|
<dd>
|
|
1214
1185
|
|
|
1215
|
-
**
|
|
1186
|
+
**messageId:** `AgentMail.MessageId`
|
|
1187
|
+
|
|
1188
|
+
</dd>
|
|
1189
|
+
</dl>
|
|
1190
|
+
|
|
1191
|
+
<dl>
|
|
1192
|
+
<dd>
|
|
1193
|
+
|
|
1194
|
+
**request:** `AgentMail.UpdateMessageRequest`
|
|
1195
|
+
|
|
1196
|
+
</dd>
|
|
1197
|
+
</dl>
|
|
1198
|
+
|
|
1199
|
+
<dl>
|
|
1200
|
+
<dd>
|
|
1201
|
+
|
|
1202
|
+
**requestOptions:** `Messages.RequestOptions`
|
|
1216
1203
|
|
|
1217
1204
|
</dd>
|
|
1218
1205
|
</dl>
|
|
@@ -1223,9 +1210,9 @@ await client.threads.get("thread_id");
|
|
|
1223
1210
|
</dl>
|
|
1224
1211
|
</details>
|
|
1225
1212
|
|
|
1226
|
-
##
|
|
1213
|
+
## Inboxes Threads
|
|
1227
1214
|
|
|
1228
|
-
<details><summary><code>client.
|
|
1215
|
+
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
1229
1216
|
<dl>
|
|
1230
1217
|
<dd>
|
|
1231
1218
|
|
|
@@ -1238,7 +1225,7 @@ await client.threads.get("thread_id");
|
|
|
1238
1225
|
<dd>
|
|
1239
1226
|
|
|
1240
1227
|
```typescript
|
|
1241
|
-
await client.
|
|
1228
|
+
await client.inboxes.threads.list("inbox_id");
|
|
1242
1229
|
```
|
|
1243
1230
|
|
|
1244
1231
|
</dd>
|
|
@@ -1254,7 +1241,7 @@ await client.webhooks.list();
|
|
|
1254
1241
|
<dl>
|
|
1255
1242
|
<dd>
|
|
1256
1243
|
|
|
1257
|
-
**
|
|
1244
|
+
**inboxId:** `AgentMail.InboxId`
|
|
1258
1245
|
|
|
1259
1246
|
</dd>
|
|
1260
1247
|
</dl>
|
|
@@ -1262,7 +1249,15 @@ await client.webhooks.list();
|
|
|
1262
1249
|
<dl>
|
|
1263
1250
|
<dd>
|
|
1264
1251
|
|
|
1265
|
-
**
|
|
1252
|
+
**request:** `AgentMail.inboxes.ListThreadsRequest`
|
|
1253
|
+
|
|
1254
|
+
</dd>
|
|
1255
|
+
</dl>
|
|
1256
|
+
|
|
1257
|
+
<dl>
|
|
1258
|
+
<dd>
|
|
1259
|
+
|
|
1260
|
+
**requestOptions:** `Threads.RequestOptions`
|
|
1266
1261
|
|
|
1267
1262
|
</dd>
|
|
1268
1263
|
</dl>
|
|
@@ -1273,7 +1268,7 @@ await client.webhooks.list();
|
|
|
1273
1268
|
</dl>
|
|
1274
1269
|
</details>
|
|
1275
1270
|
|
|
1276
|
-
<details><summary><code>client.
|
|
1271
|
+
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">get</a>(inboxId, threadId) -> AgentMail.Thread</code></summary>
|
|
1277
1272
|
<dl>
|
|
1278
1273
|
<dd>
|
|
1279
1274
|
|
|
@@ -1286,7 +1281,7 @@ await client.webhooks.list();
|
|
|
1286
1281
|
<dd>
|
|
1287
1282
|
|
|
1288
1283
|
```typescript
|
|
1289
|
-
await client.
|
|
1284
|
+
await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
1290
1285
|
```
|
|
1291
1286
|
|
|
1292
1287
|
</dd>
|
|
@@ -1302,7 +1297,7 @@ await client.webhooks.get("webhook_id");
|
|
|
1302
1297
|
<dl>
|
|
1303
1298
|
<dd>
|
|
1304
1299
|
|
|
1305
|
-
**
|
|
1300
|
+
**inboxId:** `AgentMail.InboxId`
|
|
1306
1301
|
|
|
1307
1302
|
</dd>
|
|
1308
1303
|
</dl>
|
|
@@ -1310,7 +1305,15 @@ await client.webhooks.get("webhook_id");
|
|
|
1310
1305
|
<dl>
|
|
1311
1306
|
<dd>
|
|
1312
1307
|
|
|
1313
|
-
**
|
|
1308
|
+
**threadId:** `AgentMail.ThreadId`
|
|
1309
|
+
|
|
1310
|
+
</dd>
|
|
1311
|
+
</dl>
|
|
1312
|
+
|
|
1313
|
+
<dl>
|
|
1314
|
+
<dd>
|
|
1315
|
+
|
|
1316
|
+
**requestOptions:** `Threads.RequestOptions`
|
|
1314
1317
|
|
|
1315
1318
|
</dd>
|
|
1316
1319
|
</dl>
|
|
@@ -1321,7 +1324,9 @@ await client.webhooks.get("webhook_id");
|
|
|
1321
1324
|
</dl>
|
|
1322
1325
|
</details>
|
|
1323
1326
|
|
|
1324
|
-
|
|
1327
|
+
## Threads
|
|
1328
|
+
|
|
1329
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListThreadsResponse</code></summary>
|
|
1325
1330
|
<dl>
|
|
1326
1331
|
<dd>
|
|
1327
1332
|
|
|
@@ -1334,12 +1339,7 @@ await client.webhooks.get("webhook_id");
|
|
|
1334
1339
|
<dd>
|
|
1335
1340
|
|
|
1336
1341
|
```typescript
|
|
1337
|
-
await client.
|
|
1338
|
-
url: "url",
|
|
1339
|
-
eventTypes: ["message.received", "message.received"],
|
|
1340
|
-
inboxIds: undefined,
|
|
1341
|
-
clientId: undefined,
|
|
1342
|
-
});
|
|
1342
|
+
await client.threads.list();
|
|
1343
1343
|
```
|
|
1344
1344
|
|
|
1345
1345
|
</dd>
|
|
@@ -1355,7 +1355,7 @@ await client.webhooks.create({
|
|
|
1355
1355
|
<dl>
|
|
1356
1356
|
<dd>
|
|
1357
1357
|
|
|
1358
|
-
**request:** `AgentMail.
|
|
1358
|
+
**request:** `AgentMail.ListThreadsRequest`
|
|
1359
1359
|
|
|
1360
1360
|
</dd>
|
|
1361
1361
|
</dl>
|
|
@@ -1363,7 +1363,7 @@ await client.webhooks.create({
|
|
|
1363
1363
|
<dl>
|
|
1364
1364
|
<dd>
|
|
1365
1365
|
|
|
1366
|
-
**requestOptions:** `
|
|
1366
|
+
**requestOptions:** `Threads.RequestOptions`
|
|
1367
1367
|
|
|
1368
1368
|
</dd>
|
|
1369
1369
|
</dl>
|
|
@@ -1374,7 +1374,7 @@ await client.webhooks.create({
|
|
|
1374
1374
|
</dl>
|
|
1375
1375
|
</details>
|
|
1376
1376
|
|
|
1377
|
-
<details><summary><code>client.
|
|
1377
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">get</a>(threadId) -> AgentMail.Thread</code></summary>
|
|
1378
1378
|
<dl>
|
|
1379
1379
|
<dd>
|
|
1380
1380
|
|
|
@@ -1387,7 +1387,7 @@ await client.webhooks.create({
|
|
|
1387
1387
|
<dd>
|
|
1388
1388
|
|
|
1389
1389
|
```typescript
|
|
1390
|
-
await client.
|
|
1390
|
+
await client.threads.get("thread_id");
|
|
1391
1391
|
```
|
|
1392
1392
|
|
|
1393
1393
|
</dd>
|
|
@@ -1403,7 +1403,7 @@ await client.webhooks.delete("webhook_id");
|
|
|
1403
1403
|
<dl>
|
|
1404
1404
|
<dd>
|
|
1405
1405
|
|
|
1406
|
-
**
|
|
1406
|
+
**threadId:** `AgentMail.ThreadId`
|
|
1407
1407
|
|
|
1408
1408
|
</dd>
|
|
1409
1409
|
</dl>
|
|
@@ -1411,7 +1411,7 @@ await client.webhooks.delete("webhook_id");
|
|
|
1411
1411
|
<dl>
|
|
1412
1412
|
<dd>
|
|
1413
1413
|
|
|
1414
|
-
**requestOptions:** `
|
|
1414
|
+
**requestOptions:** `Threads.RequestOptions`
|
|
1415
1415
|
|
|
1416
1416
|
</dd>
|
|
1417
1417
|
</dl>
|