agentmail 0.5.14 → 0.5.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.
Files changed (127) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/drafts/types/CreateDraftRequest.d.ts +17 -0
  3. package/dist/cjs/api/resources/drafts/types/UpdateDraftRequest.d.ts +22 -8
  4. package/dist/cjs/api/resources/drafts/types/index.d.ts +0 -3
  5. package/dist/cjs/api/resources/drafts/types/index.js +0 -3
  6. package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.d.ts +13 -0
  7. package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.js +37 -0
  8. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +0 -69
  9. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +0 -264
  10. package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.d.ts +2 -3
  11. package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.js +6 -11
  12. package/dist/cjs/api/resources/inboxes/resources/threads/client/requests/index.d.ts +0 -1
  13. package/dist/cjs/api/resources/pods/resources/threads/client/Client.d.ts +2 -3
  14. package/dist/cjs/api/resources/pods/resources/threads/client/Client.js +6 -11
  15. package/dist/cjs/api/resources/pods/resources/threads/client/requests/index.d.ts +0 -1
  16. package/dist/cjs/api/resources/threads/client/Client.d.ts +2 -3
  17. package/dist/cjs/api/resources/threads/client/Client.js +6 -11
  18. package/dist/cjs/api/resources/threads/client/requests/index.d.ts +0 -1
  19. package/dist/cjs/api/types/ErrorCode.d.ts +4 -0
  20. package/dist/cjs/api/types/ErrorDocs.d.ts +4 -0
  21. package/dist/cjs/api/types/ErrorFix.d.ts +4 -0
  22. package/dist/cjs/api/types/ErrorResponse.d.ts +3 -0
  23. package/dist/cjs/api/types/ValidationErrorResponse.d.ts +5 -1
  24. package/dist/cjs/api/types/index.d.ts +3 -0
  25. package/dist/cjs/api/types/index.js +3 -0
  26. package/dist/cjs/serialization/resources/drafts/types/CreateDraftRequest.d.ts +4 -0
  27. package/dist/cjs/serialization/resources/drafts/types/CreateDraftRequest.js +4 -0
  28. package/dist/cjs/serialization/resources/drafts/types/UpdateDraftRequest.d.ts +15 -8
  29. package/dist/cjs/serialization/resources/drafts/types/UpdateDraftRequest.js +15 -8
  30. package/dist/cjs/serialization/resources/drafts/types/index.d.ts +0 -3
  31. package/dist/cjs/serialization/resources/drafts/types/index.js +0 -3
  32. package/dist/cjs/serialization/types/ErrorCode.d.ts +7 -0
  33. package/dist/cjs/serialization/{resources/drafts/types/CreateDraftReplyAllRequest.js → types/ErrorCode.js} +3 -20
  34. package/dist/cjs/serialization/types/ErrorDocs.d.ts +7 -0
  35. package/dist/cjs/serialization/{resources/drafts/types/CreateDraftForwardRequest.js → types/ErrorDocs.js} +3 -26
  36. package/dist/cjs/serialization/types/ErrorFix.d.ts +7 -0
  37. package/dist/cjs/serialization/types/ErrorFix.js +39 -0
  38. package/dist/cjs/serialization/types/ErrorResponse.d.ts +6 -0
  39. package/dist/cjs/serialization/types/ErrorResponse.js +6 -0
  40. package/dist/cjs/serialization/types/ValidationErrorResponse.d.ts +8 -0
  41. package/dist/cjs/serialization/types/ValidationErrorResponse.js +8 -0
  42. package/dist/cjs/serialization/types/index.d.ts +3 -0
  43. package/dist/cjs/serialization/types/index.js +3 -0
  44. package/dist/cjs/version.d.ts +1 -1
  45. package/dist/cjs/version.js +1 -1
  46. package/dist/esm/BaseClient.mjs +2 -2
  47. package/dist/esm/api/resources/drafts/types/CreateDraftRequest.d.mts +17 -0
  48. package/dist/esm/api/resources/drafts/types/UpdateDraftRequest.d.mts +22 -8
  49. package/dist/esm/api/resources/drafts/types/index.d.mts +0 -3
  50. package/dist/esm/api/resources/drafts/types/index.mjs +0 -3
  51. package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.d.mts +13 -0
  52. package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.mjs +37 -0
  53. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +0 -69
  54. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +0 -264
  55. package/dist/esm/api/resources/inboxes/resources/threads/client/Client.d.mts +2 -3
  56. package/dist/esm/api/resources/inboxes/resources/threads/client/Client.mjs +6 -11
  57. package/dist/esm/api/resources/inboxes/resources/threads/client/requests/index.d.mts +0 -1
  58. package/dist/esm/api/resources/pods/resources/threads/client/Client.d.mts +2 -3
  59. package/dist/esm/api/resources/pods/resources/threads/client/Client.mjs +6 -11
  60. package/dist/esm/api/resources/pods/resources/threads/client/requests/index.d.mts +0 -1
  61. package/dist/esm/api/resources/threads/client/Client.d.mts +2 -3
  62. package/dist/esm/api/resources/threads/client/Client.mjs +6 -11
  63. package/dist/esm/api/resources/threads/client/requests/index.d.mts +0 -1
  64. package/dist/esm/api/types/ErrorCode.d.mts +4 -0
  65. package/dist/esm/api/types/ErrorDocs.d.mts +4 -0
  66. package/dist/esm/api/types/ErrorFix.d.mts +4 -0
  67. package/dist/esm/api/types/ErrorResponse.d.mts +3 -0
  68. package/dist/esm/api/types/ValidationErrorResponse.d.mts +5 -1
  69. package/dist/esm/api/types/index.d.mts +3 -0
  70. package/dist/esm/api/types/index.mjs +3 -0
  71. package/dist/esm/serialization/resources/drafts/types/CreateDraftRequest.d.mts +4 -0
  72. package/dist/esm/serialization/resources/drafts/types/CreateDraftRequest.mjs +4 -0
  73. package/dist/esm/serialization/resources/drafts/types/UpdateDraftRequest.d.mts +15 -8
  74. package/dist/esm/serialization/resources/drafts/types/UpdateDraftRequest.mjs +15 -8
  75. package/dist/esm/serialization/resources/drafts/types/index.d.mts +0 -3
  76. package/dist/esm/serialization/resources/drafts/types/index.mjs +0 -3
  77. package/dist/esm/serialization/types/ErrorCode.d.mts +7 -0
  78. package/dist/esm/serialization/types/ErrorCode.mjs +3 -0
  79. package/dist/esm/serialization/types/ErrorDocs.d.mts +7 -0
  80. package/dist/esm/serialization/types/ErrorDocs.mjs +3 -0
  81. package/dist/esm/serialization/types/ErrorFix.d.mts +7 -0
  82. package/dist/esm/serialization/types/ErrorFix.mjs +3 -0
  83. package/dist/esm/serialization/types/ErrorResponse.d.mts +6 -0
  84. package/dist/esm/serialization/types/ErrorResponse.mjs +6 -0
  85. package/dist/esm/serialization/types/ValidationErrorResponse.d.mts +8 -0
  86. package/dist/esm/serialization/types/ValidationErrorResponse.mjs +8 -0
  87. package/dist/esm/serialization/types/index.d.mts +3 -0
  88. package/dist/esm/serialization/types/index.mjs +3 -0
  89. package/dist/esm/version.d.mts +1 -1
  90. package/dist/esm/version.mjs +1 -1
  91. package/dist/llms.txt +2 -4
  92. package/package.json +1 -1
  93. package/reference.md +16 -288
  94. package/dist/cjs/api/resources/drafts/types/CreateDraftForwardRequest.d.ts +0 -21
  95. package/dist/cjs/api/resources/drafts/types/CreateDraftReplyAllRequest.d.ts +0 -17
  96. package/dist/cjs/api/resources/drafts/types/CreateDraftReplyRequest.d.ts +0 -22
  97. package/dist/cjs/api/resources/inboxes/resources/threads/client/requests/DeleteThreadRequest.d.ts +0 -8
  98. package/dist/cjs/api/resources/inboxes/resources/threads/client/requests/DeleteThreadRequest.js +0 -3
  99. package/dist/cjs/api/resources/pods/resources/threads/client/requests/DeleteThreadRequest.d.ts +0 -8
  100. package/dist/cjs/api/resources/pods/resources/threads/client/requests/DeleteThreadRequest.js +0 -3
  101. package/dist/cjs/api/resources/threads/client/requests/DeleteThreadRequest.d.ts +0 -8
  102. package/dist/cjs/api/resources/threads/client/requests/DeleteThreadRequest.js +0 -3
  103. package/dist/cjs/serialization/resources/drafts/types/CreateDraftForwardRequest.d.ts +0 -30
  104. package/dist/cjs/serialization/resources/drafts/types/CreateDraftReplyAllRequest.d.ts +0 -24
  105. package/dist/cjs/serialization/resources/drafts/types/CreateDraftReplyRequest.d.ts +0 -32
  106. package/dist/cjs/serialization/resources/drafts/types/CreateDraftReplyRequest.js +0 -64
  107. package/dist/esm/api/resources/drafts/types/CreateDraftForwardRequest.d.mts +0 -21
  108. package/dist/esm/api/resources/drafts/types/CreateDraftReplyAllRequest.d.mts +0 -17
  109. package/dist/esm/api/resources/drafts/types/CreateDraftReplyRequest.d.mts +0 -22
  110. package/dist/esm/api/resources/inboxes/resources/threads/client/requests/DeleteThreadRequest.d.mts +0 -8
  111. package/dist/esm/api/resources/inboxes/resources/threads/client/requests/DeleteThreadRequest.mjs +0 -2
  112. package/dist/esm/api/resources/pods/resources/threads/client/requests/DeleteThreadRequest.d.mts +0 -8
  113. package/dist/esm/api/resources/pods/resources/threads/client/requests/DeleteThreadRequest.mjs +0 -2
  114. package/dist/esm/api/resources/threads/client/requests/DeleteThreadRequest.d.mts +0 -8
  115. package/dist/esm/api/resources/threads/client/requests/DeleteThreadRequest.mjs +0 -2
  116. package/dist/esm/serialization/resources/drafts/types/CreateDraftForwardRequest.d.mts +0 -30
  117. package/dist/esm/serialization/resources/drafts/types/CreateDraftForwardRequest.mjs +0 -26
  118. package/dist/esm/serialization/resources/drafts/types/CreateDraftReplyAllRequest.d.mts +0 -24
  119. package/dist/esm/serialization/resources/drafts/types/CreateDraftReplyAllRequest.mjs +0 -20
  120. package/dist/esm/serialization/resources/drafts/types/CreateDraftReplyRequest.d.mts +0 -32
  121. package/dist/esm/serialization/resources/drafts/types/CreateDraftReplyRequest.mjs +0 -28
  122. /package/dist/cjs/api/{resources/drafts/types/CreateDraftForwardRequest.js → types/ErrorCode.js} +0 -0
  123. /package/dist/cjs/api/{resources/drafts/types/CreateDraftReplyAllRequest.js → types/ErrorDocs.js} +0 -0
  124. /package/dist/cjs/api/{resources/drafts/types/CreateDraftReplyRequest.js → types/ErrorFix.js} +0 -0
  125. /package/dist/esm/api/{resources/drafts/types/CreateDraftForwardRequest.mjs → types/ErrorCode.mjs} +0 -0
  126. /package/dist/esm/api/{resources/drafts/types/CreateDraftReplyAllRequest.mjs → types/ErrorDocs.mjs} +0 -0
  127. /package/dist/esm/api/{resources/drafts/types/CreateDraftReplyRequest.mjs → types/ErrorFix.mjs} +0 -0
package/reference.md CHANGED
@@ -2506,6 +2506,12 @@ await client.inboxes.drafts.getAttachment("inbox_id", "draft_id", "attachment_id
2506
2506
  <dl>
2507
2507
  <dd>
2508
2508
 
2509
+ Create a draft. Supply `in_reply_to` to create a reply draft (with
2510
+ `reply_all` to address the whole thread), whose recipients, subject, and
2511
+ threading are derived from the referenced message, or `forward_of` to
2512
+ create a forward draft, which derives the subject, threading, and
2513
+ forwarded content from the source but keeps recipients caller-supplied.
2514
+
2509
2515
  **CLI:**
2510
2516
  ```bash
2511
2517
  agentmail inboxes:drafts create --inbox-id <inbox_id> --to recipient@example.com --subject "Draft subject" --text "Draft body"
@@ -2580,6 +2586,10 @@ await client.inboxes.drafts.create("inbox_id", {});
2580
2586
  <dl>
2581
2587
  <dd>
2582
2588
 
2589
+ Edit fields on an existing draft. Passing `null` clears a field (or `[]`
2590
+ for a recipient field); `send_at: null` un-schedules a scheduled draft.
2591
+ A draft that is already being sent cannot be edited.
2592
+
2583
2593
  **CLI:**
2584
2594
  ```bash
2585
2595
  agentmail inboxes:drafts update --inbox-id <inbox_id> --draft-id <draft_id> --subject "Updated subject"
@@ -4270,264 +4280,6 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
4270
4280
  </dl>
4271
4281
 
4272
4282
 
4273
- </dd>
4274
- </dl>
4275
- </details>
4276
-
4277
- <details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">draftReply</a>(inbox_id, message_id, { ...params }) -> AgentMail.Draft</code></summary>
4278
- <dl>
4279
- <dd>
4280
-
4281
- #### 📝 Description
4282
-
4283
- <dl>
4284
- <dd>
4285
-
4286
- <dl>
4287
- <dd>
4288
-
4289
- Create a draft that replies to a message instead of sending it. The
4290
- recipients, subject, and threading are derived from the source message.
4291
- Send it later with `Send Draft`.
4292
-
4293
- **CLI:**
4294
- ```bash
4295
- agentmail inboxes:messages draft-reply --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
4296
- ```
4297
- </dd>
4298
- </dl>
4299
- </dd>
4300
- </dl>
4301
-
4302
- #### 🔌 Usage
4303
-
4304
- <dl>
4305
- <dd>
4306
-
4307
- <dl>
4308
- <dd>
4309
-
4310
- ```typescript
4311
- await client.inboxes.messages.draftReply("inbox_id", "message_id", {});
4312
-
4313
- ```
4314
- </dd>
4315
- </dl>
4316
- </dd>
4317
- </dl>
4318
-
4319
- #### ⚙️ Parameters
4320
-
4321
- <dl>
4322
- <dd>
4323
-
4324
- <dl>
4325
- <dd>
4326
-
4327
- **inbox_id:** `AgentMail.InboxId`
4328
-
4329
- </dd>
4330
- </dl>
4331
-
4332
- <dl>
4333
- <dd>
4334
-
4335
- **message_id:** `AgentMail.MessageId`
4336
-
4337
- </dd>
4338
- </dl>
4339
-
4340
- <dl>
4341
- <dd>
4342
-
4343
- **request:** `AgentMail.CreateDraftReplyRequest`
4344
-
4345
- </dd>
4346
- </dl>
4347
-
4348
- <dl>
4349
- <dd>
4350
-
4351
- **requestOptions:** `MessagesClient.RequestOptions`
4352
-
4353
- </dd>
4354
- </dl>
4355
- </dd>
4356
- </dl>
4357
-
4358
-
4359
- </dd>
4360
- </dl>
4361
- </details>
4362
-
4363
- <details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">draftReplyAll</a>(inbox_id, message_id, { ...params }) -> AgentMail.Draft</code></summary>
4364
- <dl>
4365
- <dd>
4366
-
4367
- #### 📝 Description
4368
-
4369
- <dl>
4370
- <dd>
4371
-
4372
- <dl>
4373
- <dd>
4374
-
4375
- Create a draft that replies to every recipient of a message instead of
4376
- sending it. Recipients, subject, and threading are derived from the
4377
- source message. Send it later with `Send Draft`.
4378
-
4379
- **CLI:**
4380
- ```bash
4381
- agentmail inboxes:messages draft-reply-all --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
4382
- ```
4383
- </dd>
4384
- </dl>
4385
- </dd>
4386
- </dl>
4387
-
4388
- #### 🔌 Usage
4389
-
4390
- <dl>
4391
- <dd>
4392
-
4393
- <dl>
4394
- <dd>
4395
-
4396
- ```typescript
4397
- await client.inboxes.messages.draftReplyAll("inbox_id", "message_id", {});
4398
-
4399
- ```
4400
- </dd>
4401
- </dl>
4402
- </dd>
4403
- </dl>
4404
-
4405
- #### ⚙️ Parameters
4406
-
4407
- <dl>
4408
- <dd>
4409
-
4410
- <dl>
4411
- <dd>
4412
-
4413
- **inbox_id:** `AgentMail.InboxId`
4414
-
4415
- </dd>
4416
- </dl>
4417
-
4418
- <dl>
4419
- <dd>
4420
-
4421
- **message_id:** `AgentMail.MessageId`
4422
-
4423
- </dd>
4424
- </dl>
4425
-
4426
- <dl>
4427
- <dd>
4428
-
4429
- **request:** `AgentMail.CreateDraftReplyAllRequest`
4430
-
4431
- </dd>
4432
- </dl>
4433
-
4434
- <dl>
4435
- <dd>
4436
-
4437
- **requestOptions:** `MessagesClient.RequestOptions`
4438
-
4439
- </dd>
4440
- </dl>
4441
- </dd>
4442
- </dl>
4443
-
4444
-
4445
- </dd>
4446
- </dl>
4447
- </details>
4448
-
4449
- <details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">draftForward</a>(inbox_id, message_id, { ...params }) -> AgentMail.Draft</code></summary>
4450
- <dl>
4451
- <dd>
4452
-
4453
- #### 📝 Description
4454
-
4455
- <dl>
4456
- <dd>
4457
-
4458
- <dl>
4459
- <dd>
4460
-
4461
- Create a draft that forwards a message instead of sending it. The subject
4462
- and threading are derived from the source message, whose body and
4463
- attachments are merged in at send time. Send it later with `Send Draft`.
4464
-
4465
- **CLI:**
4466
- ```bash
4467
- agentmail inboxes:messages draft-forward --inbox-id <inbox_id> --message-id <message_id> --to recipient@example.com
4468
- ```
4469
- </dd>
4470
- </dl>
4471
- </dd>
4472
- </dl>
4473
-
4474
- #### 🔌 Usage
4475
-
4476
- <dl>
4477
- <dd>
4478
-
4479
- <dl>
4480
- <dd>
4481
-
4482
- ```typescript
4483
- await client.inboxes.messages.draftForward("inbox_id", "message_id", {});
4484
-
4485
- ```
4486
- </dd>
4487
- </dl>
4488
- </dd>
4489
- </dl>
4490
-
4491
- #### ⚙️ Parameters
4492
-
4493
- <dl>
4494
- <dd>
4495
-
4496
- <dl>
4497
- <dd>
4498
-
4499
- **inbox_id:** `AgentMail.InboxId`
4500
-
4501
- </dd>
4502
- </dl>
4503
-
4504
- <dl>
4505
- <dd>
4506
-
4507
- **message_id:** `AgentMail.MessageId`
4508
-
4509
- </dd>
4510
- </dl>
4511
-
4512
- <dl>
4513
- <dd>
4514
-
4515
- **request:** `AgentMail.CreateDraftForwardRequest`
4516
-
4517
- </dd>
4518
- </dl>
4519
-
4520
- <dl>
4521
- <dd>
4522
-
4523
- **requestOptions:** `MessagesClient.RequestOptions`
4524
-
4525
- </dd>
4526
- </dl>
4527
- </dd>
4528
- </dl>
4529
-
4530
-
4531
4283
  </dd>
4532
4284
  </dl>
4533
4285
  </details>
@@ -5081,7 +4833,7 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
5081
4833
  </dl>
5082
4834
  </details>
5083
4835
 
5084
- <details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">delete</a>(inbox_id, thread_id, { ...params }) -> void</code></summary>
4836
+ <details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">delete</a>(inbox_id, thread_id) -> void</code></summary>
5085
4837
  <dl>
5086
4838
  <dd>
5087
4839
 
@@ -5093,7 +4845,7 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
5093
4845
  <dl>
5094
4846
  <dd>
5095
4847
 
5096
- 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.
4848
+ Permanently deletes a thread and all of its messages.
5097
4849
 
5098
4850
  **CLI:**
5099
4851
  ```bash
@@ -5145,14 +4897,6 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
5145
4897
  <dl>
5146
4898
  <dd>
5147
4899
 
5148
- **request:** `AgentMail.inboxes.DeleteThreadRequest`
5149
-
5150
- </dd>
5151
- </dl>
5152
-
5153
- <dl>
5154
- <dd>
5155
-
5156
4900
  **requestOptions:** `ThreadsClient.RequestOptions`
5157
4901
 
5158
4902
  </dd>
@@ -8355,7 +8099,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
8355
8099
  </dl>
8356
8100
  </details>
8357
8101
 
8358
- <details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">delete</a>(pod_id, thread_id, { ...params }) -> void</code></summary>
8102
+ <details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">delete</a>(pod_id, thread_id) -> void</code></summary>
8359
8103
  <dl>
8360
8104
  <dd>
8361
8105
 
@@ -8367,7 +8111,7 @@ await client.pods.threads.update("pod_id", "thread_id", {});
8367
8111
  <dl>
8368
8112
  <dd>
8369
8113
 
8370
- 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.
8114
+ Permanently deletes a thread and all of its messages.
8371
8115
 
8372
8116
  **CLI:**
8373
8117
  ```bash
@@ -8419,14 +8163,6 @@ await client.pods.threads.delete("pod_id", "thread_id");
8419
8163
  <dl>
8420
8164
  <dd>
8421
8165
 
8422
- **request:** `AgentMail.pods.DeleteThreadRequest`
8423
-
8424
- </dd>
8425
- </dl>
8426
-
8427
- <dl>
8428
- <dd>
8429
-
8430
8166
  **requestOptions:** `ThreadsClient.RequestOptions`
8431
8167
 
8432
8168
  </dd>
@@ -9176,7 +8912,7 @@ await client.threads.update("thread_id", {});
9176
8912
  </dl>
9177
8913
  </details>
9178
8914
 
9179
- <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">delete</a>(thread_id, { ...params }) -> void</code></summary>
8915
+ <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">delete</a>(thread_id) -> void</code></summary>
9180
8916
  <dl>
9181
8917
  <dd>
9182
8918
 
@@ -9188,7 +8924,7 @@ await client.threads.update("thread_id", {});
9188
8924
  <dl>
9189
8925
  <dd>
9190
8926
 
9191
- 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.
8927
+ Permanently deletes a thread and all of its messages.
9192
8928
 
9193
8929
  **CLI:**
9194
8930
  ```bash
@@ -9232,14 +8968,6 @@ await client.threads.delete("thread_id");
9232
8968
  <dl>
9233
8969
  <dd>
9234
8970
 
9235
- **request:** `AgentMail.DeleteThreadRequest`
9236
-
9237
- </dd>
9238
- </dl>
9239
-
9240
- <dl>
9241
- <dd>
9242
-
9243
8971
  **requestOptions:** `ThreadsClient.RequestOptions`
9244
8972
 
9245
8973
  </dd>
@@ -1,21 +0,0 @@
1
- import type * as AgentMail from "../../../index.js";
2
- /**
3
- * Body for creating a draft that forwards a message. The subject and
4
- * threading are derived from the source message, whose body and attachments
5
- * are merged in at send time. Recipients are optional, so a forward draft can
6
- * be saved without an address and addressed later.
7
- */
8
- export interface CreateDraftForwardRequest {
9
- labels?: AgentMail.DraftLabels;
10
- replyTo?: AgentMail.DraftReplyTo;
11
- to?: AgentMail.DraftTo;
12
- cc?: AgentMail.DraftCc;
13
- bcc?: AgentMail.DraftBcc;
14
- subject?: AgentMail.DraftSubject;
15
- text?: AgentMail.DraftText;
16
- html?: AgentMail.DraftHtml;
17
- /** Attachments to include in draft. */
18
- attachments?: AgentMail.SendAttachment[];
19
- sendAt?: AgentMail.DraftSendAt;
20
- clientId?: AgentMail.DraftClientId;
21
- }
@@ -1,17 +0,0 @@
1
- import type * as AgentMail from "../../../index.js";
2
- /**
3
- * Body for creating a draft that replies to the whole thread. Recipients,
4
- * `in_reply_to`, `references`, and the subject are always derived from the
5
- * source message, so `to`, `cc`, and `bcc` are not accepted.
6
- */
7
- export interface CreateDraftReplyAllRequest {
8
- labels?: AgentMail.DraftLabels;
9
- replyTo?: AgentMail.DraftReplyTo;
10
- subject?: AgentMail.DraftSubject;
11
- text?: AgentMail.DraftText;
12
- html?: AgentMail.DraftHtml;
13
- /** Attachments to include in draft. */
14
- attachments?: AgentMail.SendAttachment[];
15
- sendAt?: AgentMail.DraftSendAt;
16
- clientId?: AgentMail.DraftClientId;
17
- }
@@ -1,22 +0,0 @@
1
- import type * as AgentMail from "../../../index.js";
2
- /**
3
- * Body for creating a draft that replies to a message. `in_reply_to`,
4
- * `references`, and the subject are derived from the source message. Set
5
- * `reply_all` to address the whole thread (you cannot then also pass `to`,
6
- * `cc`, or `bcc`).
7
- */
8
- export interface CreateDraftReplyRequest {
9
- labels?: AgentMail.DraftLabels;
10
- replyTo?: AgentMail.DraftReplyTo;
11
- to?: AgentMail.DraftTo;
12
- cc?: AgentMail.DraftCc;
13
- bcc?: AgentMail.DraftBcc;
14
- replyAll?: AgentMail.DraftReplyAll;
15
- subject?: AgentMail.DraftSubject;
16
- text?: AgentMail.DraftText;
17
- html?: AgentMail.DraftHtml;
18
- /** Attachments to include in draft. */
19
- attachments?: AgentMail.SendAttachment[];
20
- sendAt?: AgentMail.DraftSendAt;
21
- clientId?: AgentMail.DraftClientId;
22
- }
@@ -1,8 +0,0 @@
1
- /**
2
- * @example
3
- * {}
4
- */
5
- export interface DeleteThreadRequest {
6
- /** If true, permanently delete the thread instead of moving to trash. */
7
- permanent?: boolean;
8
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,8 +0,0 @@
1
- /**
2
- * @example
3
- * {}
4
- */
5
- export interface DeleteThreadRequest {
6
- /** If true, permanently delete the thread instead of moving to trash. */
7
- permanent?: boolean;
8
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,8 +0,0 @@
1
- /**
2
- * @example
3
- * {}
4
- */
5
- export interface DeleteThreadRequest {
6
- /** If true, permanently delete the thread instead of moving to trash. */
7
- permanent?: boolean;
8
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,30 +0,0 @@
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
- import { SendAttachment } from "../../attachments/types/SendAttachment.js";
5
- import { DraftBcc } from "./DraftBcc.js";
6
- import { DraftCc } from "./DraftCc.js";
7
- import { DraftClientId } from "./DraftClientId.js";
8
- import { DraftHtml } from "./DraftHtml.js";
9
- import { DraftLabels } from "./DraftLabels.js";
10
- import { DraftReplyTo } from "./DraftReplyTo.js";
11
- import { DraftSendAt } from "./DraftSendAt.js";
12
- import { DraftSubject } from "./DraftSubject.js";
13
- import { DraftText } from "./DraftText.js";
14
- import { DraftTo } from "./DraftTo.js";
15
- export declare const CreateDraftForwardRequest: core.serialization.ObjectSchema<serializers.CreateDraftForwardRequest.Raw, AgentMail.CreateDraftForwardRequest>;
16
- export declare namespace CreateDraftForwardRequest {
17
- interface Raw {
18
- labels?: DraftLabels.Raw | null;
19
- reply_to?: DraftReplyTo.Raw | null;
20
- to?: DraftTo.Raw | null;
21
- cc?: DraftCc.Raw | null;
22
- bcc?: DraftBcc.Raw | null;
23
- subject?: DraftSubject.Raw | null;
24
- text?: DraftText.Raw | null;
25
- html?: DraftHtml.Raw | null;
26
- attachments?: SendAttachment.Raw[] | null;
27
- send_at?: DraftSendAt.Raw | null;
28
- client_id?: DraftClientId.Raw | null;
29
- }
30
- }
@@ -1,24 +0,0 @@
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
- import { SendAttachment } from "../../attachments/types/SendAttachment.js";
5
- import { DraftClientId } from "./DraftClientId.js";
6
- import { DraftHtml } from "./DraftHtml.js";
7
- import { DraftLabels } from "./DraftLabels.js";
8
- import { DraftReplyTo } from "./DraftReplyTo.js";
9
- import { DraftSendAt } from "./DraftSendAt.js";
10
- import { DraftSubject } from "./DraftSubject.js";
11
- import { DraftText } from "./DraftText.js";
12
- export declare const CreateDraftReplyAllRequest: core.serialization.ObjectSchema<serializers.CreateDraftReplyAllRequest.Raw, AgentMail.CreateDraftReplyAllRequest>;
13
- export declare namespace CreateDraftReplyAllRequest {
14
- interface Raw {
15
- labels?: DraftLabels.Raw | null;
16
- reply_to?: DraftReplyTo.Raw | null;
17
- subject?: DraftSubject.Raw | null;
18
- text?: DraftText.Raw | null;
19
- html?: DraftHtml.Raw | null;
20
- attachments?: SendAttachment.Raw[] | null;
21
- send_at?: DraftSendAt.Raw | null;
22
- client_id?: DraftClientId.Raw | null;
23
- }
24
- }
@@ -1,32 +0,0 @@
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
- import { SendAttachment } from "../../attachments/types/SendAttachment.js";
5
- import { DraftBcc } from "./DraftBcc.js";
6
- import { DraftCc } from "./DraftCc.js";
7
- import { DraftClientId } from "./DraftClientId.js";
8
- import { DraftHtml } from "./DraftHtml.js";
9
- import { DraftLabels } from "./DraftLabels.js";
10
- import { DraftReplyAll } from "./DraftReplyAll.js";
11
- import { DraftReplyTo } from "./DraftReplyTo.js";
12
- import { DraftSendAt } from "./DraftSendAt.js";
13
- import { DraftSubject } from "./DraftSubject.js";
14
- import { DraftText } from "./DraftText.js";
15
- import { DraftTo } from "./DraftTo.js";
16
- export declare const CreateDraftReplyRequest: core.serialization.ObjectSchema<serializers.CreateDraftReplyRequest.Raw, AgentMail.CreateDraftReplyRequest>;
17
- export declare namespace CreateDraftReplyRequest {
18
- interface Raw {
19
- labels?: DraftLabels.Raw | null;
20
- reply_to?: DraftReplyTo.Raw | null;
21
- to?: DraftTo.Raw | null;
22
- cc?: DraftCc.Raw | null;
23
- bcc?: DraftBcc.Raw | null;
24
- reply_all?: DraftReplyAll.Raw | null;
25
- subject?: DraftSubject.Raw | null;
26
- text?: DraftText.Raw | null;
27
- html?: DraftHtml.Raw | null;
28
- attachments?: SendAttachment.Raw[] | null;
29
- send_at?: DraftSendAt.Raw | null;
30
- client_id?: DraftClientId.Raw | null;
31
- }
32
- }
@@ -1,64 +0,0 @@
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.CreateDraftReplyRequest = void 0;
38
- const core = __importStar(require("../../../../core/index.js"));
39
- const SendAttachment_js_1 = require("../../attachments/types/SendAttachment.js");
40
- const DraftBcc_js_1 = require("./DraftBcc.js");
41
- const DraftCc_js_1 = require("./DraftCc.js");
42
- const DraftClientId_js_1 = require("./DraftClientId.js");
43
- const DraftHtml_js_1 = require("./DraftHtml.js");
44
- const DraftLabels_js_1 = require("./DraftLabels.js");
45
- const DraftReplyAll_js_1 = require("./DraftReplyAll.js");
46
- const DraftReplyTo_js_1 = require("./DraftReplyTo.js");
47
- const DraftSendAt_js_1 = require("./DraftSendAt.js");
48
- const DraftSubject_js_1 = require("./DraftSubject.js");
49
- const DraftText_js_1 = require("./DraftText.js");
50
- const DraftTo_js_1 = require("./DraftTo.js");
51
- exports.CreateDraftReplyRequest = core.serialization.object({
52
- labels: DraftLabels_js_1.DraftLabels.optional(),
53
- replyTo: core.serialization.property("reply_to", DraftReplyTo_js_1.DraftReplyTo.optional()),
54
- to: DraftTo_js_1.DraftTo.optional(),
55
- cc: DraftCc_js_1.DraftCc.optional(),
56
- bcc: DraftBcc_js_1.DraftBcc.optional(),
57
- replyAll: core.serialization.property("reply_all", DraftReplyAll_js_1.DraftReplyAll.optional()),
58
- subject: DraftSubject_js_1.DraftSubject.optional(),
59
- text: DraftText_js_1.DraftText.optional(),
60
- html: DraftHtml_js_1.DraftHtml.optional(),
61
- attachments: core.serialization.list(SendAttachment_js_1.SendAttachment).optional(),
62
- sendAt: core.serialization.property("send_at", DraftSendAt_js_1.DraftSendAt.optional()),
63
- clientId: core.serialization.property("client_id", DraftClientId_js_1.DraftClientId.optional()),
64
- });
@@ -1,21 +0,0 @@
1
- import type * as AgentMail from "../../../index.mjs";
2
- /**
3
- * Body for creating a draft that forwards a message. The subject and
4
- * threading are derived from the source message, whose body and attachments
5
- * are merged in at send time. Recipients are optional, so a forward draft can
6
- * be saved without an address and addressed later.
7
- */
8
- export interface CreateDraftForwardRequest {
9
- labels?: AgentMail.DraftLabels;
10
- replyTo?: AgentMail.DraftReplyTo;
11
- to?: AgentMail.DraftTo;
12
- cc?: AgentMail.DraftCc;
13
- bcc?: AgentMail.DraftBcc;
14
- subject?: AgentMail.DraftSubject;
15
- text?: AgentMail.DraftText;
16
- html?: AgentMail.DraftHtml;
17
- /** Attachments to include in draft. */
18
- attachments?: AgentMail.SendAttachment[];
19
- sendAt?: AgentMail.DraftSendAt;
20
- clientId?: AgentMail.DraftClientId;
21
- }
@@ -1,17 +0,0 @@
1
- import type * as AgentMail from "../../../index.mjs";
2
- /**
3
- * Body for creating a draft that replies to the whole thread. Recipients,
4
- * `in_reply_to`, `references`, and the subject are always derived from the
5
- * source message, so `to`, `cc`, and `bcc` are not accepted.
6
- */
7
- export interface CreateDraftReplyAllRequest {
8
- labels?: AgentMail.DraftLabels;
9
- replyTo?: AgentMail.DraftReplyTo;
10
- subject?: AgentMail.DraftSubject;
11
- text?: AgentMail.DraftText;
12
- html?: AgentMail.DraftHtml;
13
- /** Attachments to include in draft. */
14
- attachments?: AgentMail.SendAttachment[];
15
- sendAt?: AgentMail.DraftSendAt;
16
- clientId?: AgentMail.DraftClientId;
17
- }