agentmail 0.4.15 → 0.4.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/agent/client/Client.d.ts +13 -1
  3. package/dist/cjs/api/resources/agent/client/Client.js +13 -1
  4. package/dist/cjs/api/resources/apiKeys/client/Client.d.ts +16 -3
  5. package/dist/cjs/api/resources/apiKeys/client/Client.js +16 -3
  6. package/dist/cjs/api/resources/apiKeys/types/CreateApiKeyRequest.d.ts +1 -1
  7. package/dist/cjs/api/resources/domains/client/Client.d.ts +35 -0
  8. package/dist/cjs/api/resources/domains/client/Client.js +35 -0
  9. package/dist/cjs/api/resources/domains/types/DomainItem.d.ts +0 -1
  10. package/dist/cjs/api/resources/drafts/client/Client.d.ts +15 -0
  11. package/dist/cjs/api/resources/drafts/client/Client.js +15 -0
  12. package/dist/cjs/api/resources/inboxes/client/Client.d.ts +25 -0
  13. package/dist/cjs/api/resources/inboxes/client/Client.js +25 -0
  14. package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.d.ts +16 -3
  15. package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.js +16 -3
  16. package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.d.ts +35 -0
  17. package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.js +35 -0
  18. package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.d.ts +20 -0
  19. package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.js +20 -0
  20. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +64 -0
  21. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +106 -0
  22. package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.d.ts +5 -0
  23. package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.js +5 -0
  24. package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.d.ts +20 -0
  25. package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.js +20 -0
  26. package/dist/cjs/api/resources/lists/client/Client.d.ts +20 -0
  27. package/dist/cjs/api/resources/lists/client/Client.js +20 -0
  28. package/dist/cjs/api/resources/messages/types/UpdateMessageLabels.d.ts +4 -0
  29. package/dist/cjs/api/resources/messages/types/UpdateMessageLabels.js +3 -0
  30. package/dist/cjs/api/resources/messages/types/UpdateMessageRequest.d.ts +5 -4
  31. package/dist/cjs/api/resources/messages/types/index.d.ts +1 -0
  32. package/dist/cjs/api/resources/messages/types/index.js +1 -0
  33. package/dist/cjs/api/resources/metrics/client/Client.d.ts +5 -0
  34. package/dist/cjs/api/resources/metrics/client/Client.js +5 -0
  35. package/dist/cjs/api/resources/pods/client/Client.d.ts +20 -0
  36. package/dist/cjs/api/resources/pods/client/Client.js +20 -0
  37. package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.d.ts +16 -3
  38. package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.js +16 -3
  39. package/dist/cjs/api/resources/pods/resources/domains/client/Client.d.ts +35 -0
  40. package/dist/cjs/api/resources/pods/resources/domains/client/Client.js +35 -0
  41. package/dist/cjs/api/resources/pods/resources/drafts/client/Client.d.ts +15 -0
  42. package/dist/cjs/api/resources/pods/resources/drafts/client/Client.js +15 -0
  43. package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.d.ts +25 -0
  44. package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.js +25 -0
  45. package/dist/cjs/api/resources/pods/resources/lists/client/Client.d.ts +20 -0
  46. package/dist/cjs/api/resources/pods/resources/lists/client/Client.js +20 -0
  47. package/dist/cjs/api/resources/pods/resources/metrics/client/Client.d.ts +5 -0
  48. package/dist/cjs/api/resources/pods/resources/metrics/client/Client.js +5 -0
  49. package/dist/cjs/api/resources/pods/resources/threads/client/Client.d.ts +20 -0
  50. package/dist/cjs/api/resources/pods/resources/threads/client/Client.js +20 -0
  51. package/dist/cjs/api/resources/threads/client/Client.d.ts +20 -0
  52. package/dist/cjs/api/resources/threads/client/Client.js +20 -0
  53. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +25 -0
  54. package/dist/cjs/api/resources/webhooks/client/Client.js +25 -0
  55. package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.ts +1 -1
  56. package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.js +1 -1
  57. package/dist/cjs/serialization/resources/domains/types/DomainItem.d.ts +0 -2
  58. package/dist/cjs/serialization/resources/domains/types/DomainItem.js +0 -2
  59. package/dist/cjs/serialization/resources/messages/types/UpdateMessageLabels.d.ts +7 -0
  60. package/dist/cjs/serialization/resources/messages/types/UpdateMessageLabels.js +42 -0
  61. package/dist/cjs/serialization/resources/messages/types/UpdateMessageRequest.d.ts +3 -2
  62. package/dist/cjs/serialization/resources/messages/types/UpdateMessageRequest.js +3 -2
  63. package/dist/cjs/serialization/resources/messages/types/index.d.ts +1 -0
  64. package/dist/cjs/serialization/resources/messages/types/index.js +1 -0
  65. package/dist/cjs/version.d.ts +1 -1
  66. package/dist/cjs/version.js +1 -1
  67. package/dist/esm/BaseClient.mjs +2 -2
  68. package/dist/esm/api/resources/agent/client/Client.d.mts +13 -1
  69. package/dist/esm/api/resources/agent/client/Client.mjs +13 -1
  70. package/dist/esm/api/resources/apiKeys/client/Client.d.mts +16 -3
  71. package/dist/esm/api/resources/apiKeys/client/Client.mjs +16 -3
  72. package/dist/esm/api/resources/apiKeys/types/CreateApiKeyRequest.d.mts +1 -1
  73. package/dist/esm/api/resources/domains/client/Client.d.mts +35 -0
  74. package/dist/esm/api/resources/domains/client/Client.mjs +35 -0
  75. package/dist/esm/api/resources/domains/types/DomainItem.d.mts +0 -1
  76. package/dist/esm/api/resources/drafts/client/Client.d.mts +15 -0
  77. package/dist/esm/api/resources/drafts/client/Client.mjs +15 -0
  78. package/dist/esm/api/resources/inboxes/client/Client.d.mts +25 -0
  79. package/dist/esm/api/resources/inboxes/client/Client.mjs +25 -0
  80. package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.d.mts +16 -3
  81. package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.mjs +16 -3
  82. package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.d.mts +35 -0
  83. package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.mjs +35 -0
  84. package/dist/esm/api/resources/inboxes/resources/lists/client/Client.d.mts +20 -0
  85. package/dist/esm/api/resources/inboxes/resources/lists/client/Client.mjs +20 -0
  86. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +64 -0
  87. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +106 -0
  88. package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.d.mts +5 -0
  89. package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.mjs +5 -0
  90. package/dist/esm/api/resources/inboxes/resources/threads/client/Client.d.mts +20 -0
  91. package/dist/esm/api/resources/inboxes/resources/threads/client/Client.mjs +20 -0
  92. package/dist/esm/api/resources/lists/client/Client.d.mts +20 -0
  93. package/dist/esm/api/resources/lists/client/Client.mjs +20 -0
  94. package/dist/esm/api/resources/messages/types/UpdateMessageLabels.d.mts +4 -0
  95. package/dist/esm/api/resources/messages/types/UpdateMessageLabels.mjs +2 -0
  96. package/dist/esm/api/resources/messages/types/UpdateMessageRequest.d.mts +5 -4
  97. package/dist/esm/api/resources/messages/types/index.d.mts +1 -0
  98. package/dist/esm/api/resources/messages/types/index.mjs +1 -0
  99. package/dist/esm/api/resources/metrics/client/Client.d.mts +5 -0
  100. package/dist/esm/api/resources/metrics/client/Client.mjs +5 -0
  101. package/dist/esm/api/resources/pods/client/Client.d.mts +20 -0
  102. package/dist/esm/api/resources/pods/client/Client.mjs +20 -0
  103. package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.d.mts +16 -3
  104. package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.mjs +16 -3
  105. package/dist/esm/api/resources/pods/resources/domains/client/Client.d.mts +35 -0
  106. package/dist/esm/api/resources/pods/resources/domains/client/Client.mjs +35 -0
  107. package/dist/esm/api/resources/pods/resources/drafts/client/Client.d.mts +15 -0
  108. package/dist/esm/api/resources/pods/resources/drafts/client/Client.mjs +15 -0
  109. package/dist/esm/api/resources/pods/resources/inboxes/client/Client.d.mts +25 -0
  110. package/dist/esm/api/resources/pods/resources/inboxes/client/Client.mjs +25 -0
  111. package/dist/esm/api/resources/pods/resources/lists/client/Client.d.mts +20 -0
  112. package/dist/esm/api/resources/pods/resources/lists/client/Client.mjs +20 -0
  113. package/dist/esm/api/resources/pods/resources/metrics/client/Client.d.mts +5 -0
  114. package/dist/esm/api/resources/pods/resources/metrics/client/Client.mjs +5 -0
  115. package/dist/esm/api/resources/pods/resources/threads/client/Client.d.mts +20 -0
  116. package/dist/esm/api/resources/pods/resources/threads/client/Client.mjs +20 -0
  117. package/dist/esm/api/resources/threads/client/Client.d.mts +20 -0
  118. package/dist/esm/api/resources/threads/client/Client.mjs +20 -0
  119. package/dist/esm/api/resources/webhooks/client/Client.d.mts +25 -0
  120. package/dist/esm/api/resources/webhooks/client/Client.mjs +25 -0
  121. package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.mts +1 -1
  122. package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.mjs +1 -1
  123. package/dist/esm/serialization/resources/domains/types/DomainItem.d.mts +0 -2
  124. package/dist/esm/serialization/resources/domains/types/DomainItem.mjs +0 -2
  125. package/dist/esm/serialization/resources/messages/types/UpdateMessageLabels.d.mts +7 -0
  126. package/dist/esm/serialization/resources/messages/types/UpdateMessageLabels.mjs +6 -0
  127. package/dist/esm/serialization/resources/messages/types/UpdateMessageRequest.d.mts +3 -2
  128. package/dist/esm/serialization/resources/messages/types/UpdateMessageRequest.mjs +3 -2
  129. package/dist/esm/serialization/resources/messages/types/index.d.mts +1 -0
  130. package/dist/esm/serialization/resources/messages/types/index.mjs +1 -0
  131. package/dist/esm/version.d.mts +1 -1
  132. package/dist/esm/version.mjs +1 -1
  133. package/dist/llms-full.txt +2836 -568
  134. package/dist/llms.txt +3 -0
  135. package/package.json +1 -1
  136. package/reference.md +1620 -27
@@ -11,6 +11,11 @@ export declare class DraftsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<DraftsClient.Options>;
12
12
  constructor(options?: DraftsClient.Options);
13
13
  /**
14
+ * **CLI:**
15
+ * ```bash
16
+ * agentmail inboxes:drafts list --inbox-id <inbox_id>
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.inboxes.InboxId} inbox_id
15
20
  * @param {AgentMail.inboxes.ListDraftsRequest} request
16
21
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -23,6 +28,11 @@ export declare class DraftsClient {
23
28
  list(inbox_id: AgentMail.inboxes.InboxId, request?: AgentMail.inboxes.ListDraftsRequest, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListDraftsResponse>;
24
29
  private __list;
25
30
  /**
31
+ * **CLI:**
32
+ * ```bash
33
+ * agentmail inboxes:drafts retrieve --inbox-id <inbox_id> --draft-id <draft_id>
34
+ * ```
35
+ *
26
36
  * @param {AgentMail.inboxes.InboxId} inbox_id
27
37
  * @param {AgentMail.DraftId} draft_id
28
38
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -35,6 +45,11 @@ export declare class DraftsClient {
35
45
  get(inbox_id: AgentMail.inboxes.InboxId, draft_id: AgentMail.DraftId, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Draft>;
36
46
  private __get;
37
47
  /**
48
+ * **CLI:**
49
+ * ```bash
50
+ * agentmail inboxes:drafts get-attachment --inbox-id <inbox_id> --draft-id <draft_id> --attachment-id <attachment_id>
51
+ * ```
52
+ *
38
53
  * @param {AgentMail.inboxes.InboxId} inbox_id
39
54
  * @param {AgentMail.DraftId} draft_id
40
55
  * @param {AgentMail.AttachmentId} attachment_id
@@ -48,6 +63,11 @@ export declare class DraftsClient {
48
63
  getAttachment(inbox_id: AgentMail.inboxes.InboxId, draft_id: AgentMail.DraftId, attachment_id: AgentMail.AttachmentId, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.AttachmentResponse>;
49
64
  private __getAttachment;
50
65
  /**
66
+ * **CLI:**
67
+ * ```bash
68
+ * agentmail inboxes:drafts create --inbox-id <inbox_id> --to recipient@example.com --subject "Draft subject" --text "Draft body"
69
+ * ```
70
+ *
51
71
  * @param {AgentMail.inboxes.InboxId} inbox_id
52
72
  * @param {AgentMail.CreateDraftRequest} request
53
73
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -60,6 +80,11 @@ export declare class DraftsClient {
60
80
  create(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.CreateDraftRequest, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Draft>;
61
81
  private __create;
62
82
  /**
83
+ * **CLI:**
84
+ * ```bash
85
+ * agentmail inboxes:drafts update --inbox-id <inbox_id> --draft-id <draft_id> --subject "Updated subject"
86
+ * ```
87
+ *
63
88
  * @param {AgentMail.inboxes.InboxId} inbox_id
64
89
  * @param {AgentMail.DraftId} draft_id
65
90
  * @param {AgentMail.UpdateDraftRequest} request
@@ -73,6 +98,11 @@ export declare class DraftsClient {
73
98
  update(inbox_id: AgentMail.inboxes.InboxId, draft_id: AgentMail.DraftId, request: AgentMail.UpdateDraftRequest, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Draft>;
74
99
  private __update;
75
100
  /**
101
+ * **CLI:**
102
+ * ```bash
103
+ * agentmail inboxes:drafts delete --inbox-id <inbox_id> --draft-id <draft_id>
104
+ * ```
105
+ *
76
106
  * @param {AgentMail.inboxes.InboxId} inbox_id
77
107
  * @param {AgentMail.DraftId} draft_id
78
108
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -85,6 +115,11 @@ export declare class DraftsClient {
85
115
  delete(inbox_id: AgentMail.inboxes.InboxId, draft_id: AgentMail.DraftId, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<void>;
86
116
  private __delete;
87
117
  /**
118
+ * **CLI:**
119
+ * ```bash
120
+ * agentmail inboxes:drafts send --inbox-id <inbox_id> --draft-id <draft_id>
121
+ * ```
122
+ *
88
123
  * @param {AgentMail.inboxes.InboxId} inbox_id
89
124
  * @param {AgentMail.DraftId} draft_id
90
125
  * @param {AgentMail.UpdateMessageRequest} request
@@ -58,6 +58,11 @@ class DraftsClient {
58
58
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
59
59
  }
60
60
  /**
61
+ * **CLI:**
62
+ * ```bash
63
+ * agentmail inboxes:drafts list --inbox-id <inbox_id>
64
+ * ```
65
+ *
61
66
  * @param {AgentMail.inboxes.InboxId} inbox_id
62
67
  * @param {AgentMail.inboxes.ListDraftsRequest} request
63
68
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -139,6 +144,11 @@ class DraftsClient {
139
144
  });
140
145
  }
141
146
  /**
147
+ * **CLI:**
148
+ * ```bash
149
+ * agentmail inboxes:drafts retrieve --inbox-id <inbox_id> --draft-id <draft_id>
150
+ * ```
151
+ *
142
152
  * @param {AgentMail.inboxes.InboxId} inbox_id
143
153
  * @param {AgentMail.DraftId} draft_id
144
154
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -202,6 +212,11 @@ class DraftsClient {
202
212
  });
203
213
  }
204
214
  /**
215
+ * **CLI:**
216
+ * ```bash
217
+ * agentmail inboxes:drafts get-attachment --inbox-id <inbox_id> --draft-id <draft_id> --attachment-id <attachment_id>
218
+ * ```
219
+ *
205
220
  * @param {AgentMail.inboxes.InboxId} inbox_id
206
221
  * @param {AgentMail.DraftId} draft_id
207
222
  * @param {AgentMail.AttachmentId} attachment_id
@@ -266,6 +281,11 @@ class DraftsClient {
266
281
  });
267
282
  }
268
283
  /**
284
+ * **CLI:**
285
+ * ```bash
286
+ * agentmail inboxes:drafts create --inbox-id <inbox_id> --to recipient@example.com --subject "Draft subject" --text "Draft body"
287
+ * ```
288
+ *
269
289
  * @param {AgentMail.inboxes.InboxId} inbox_id
270
290
  * @param {AgentMail.CreateDraftRequest} request
271
291
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -335,6 +355,11 @@ class DraftsClient {
335
355
  });
336
356
  }
337
357
  /**
358
+ * **CLI:**
359
+ * ```bash
360
+ * agentmail inboxes:drafts update --inbox-id <inbox_id> --draft-id <draft_id> --subject "Updated subject"
361
+ * ```
362
+ *
338
363
  * @param {AgentMail.inboxes.InboxId} inbox_id
339
364
  * @param {AgentMail.DraftId} draft_id
340
365
  * @param {AgentMail.UpdateDraftRequest} request
@@ -405,6 +430,11 @@ class DraftsClient {
405
430
  });
406
431
  }
407
432
  /**
433
+ * **CLI:**
434
+ * ```bash
435
+ * agentmail inboxes:drafts delete --inbox-id <inbox_id> --draft-id <draft_id>
436
+ * ```
437
+ *
408
438
  * @param {AgentMail.inboxes.InboxId} inbox_id
409
439
  * @param {AgentMail.DraftId} draft_id
410
440
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -459,6 +489,11 @@ class DraftsClient {
459
489
  });
460
490
  }
461
491
  /**
492
+ * **CLI:**
493
+ * ```bash
494
+ * agentmail inboxes:drafts send --inbox-id <inbox_id> --draft-id <draft_id>
495
+ * ```
496
+ *
462
497
  * @param {AgentMail.inboxes.InboxId} inbox_id
463
498
  * @param {AgentMail.DraftId} draft_id
464
499
  * @param {AgentMail.UpdateMessageRequest} request
@@ -11,6 +11,11 @@ export declare class ListsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ListsClient.Options>;
12
12
  constructor(options?: ListsClient.Options);
13
13
  /**
14
+ * **CLI:**
15
+ * ```bash
16
+ * agentmail inboxes:lists list --inbox-id <inbox_id> --direction <direction> --type <type>
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.inboxes.InboxId} inbox_id
15
20
  * @param {AgentMail.Direction} direction
16
21
  * @param {AgentMail.ListType} type
@@ -23,6 +28,11 @@ export declare class ListsClient {
23
28
  list(inbox_id: AgentMail.inboxes.InboxId, direction: AgentMail.Direction, type: AgentMail.ListType, request?: AgentMail.inboxes.InboxListListEntriesRequest, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.PodListListEntriesResponse>;
24
29
  private __list;
25
30
  /**
31
+ * **CLI:**
32
+ * ```bash
33
+ * agentmail inboxes:lists retrieve --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
34
+ * ```
35
+ *
26
36
  * @param {AgentMail.inboxes.InboxId} inbox_id
27
37
  * @param {AgentMail.Direction} direction
28
38
  * @param {AgentMail.ListType} type
@@ -37,6 +47,11 @@ export declare class ListsClient {
37
47
  get(inbox_id: AgentMail.inboxes.InboxId, direction: AgentMail.Direction, type: AgentMail.ListType, entry: string, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.PodListEntry>;
38
48
  private __get;
39
49
  /**
50
+ * **CLI:**
51
+ * ```bash
52
+ * agentmail inboxes:lists create --inbox-id <inbox_id> --direction <direction> --type <type> --entry user@example.com
53
+ * ```
54
+ *
40
55
  * @param {AgentMail.inboxes.InboxId} inbox_id
41
56
  * @param {AgentMail.Direction} direction
42
57
  * @param {AgentMail.ListType} type
@@ -53,6 +68,11 @@ export declare class ListsClient {
53
68
  create(inbox_id: AgentMail.inboxes.InboxId, direction: AgentMail.Direction, type: AgentMail.ListType, request: AgentMail.CreateListEntryRequest, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.PodListEntry>;
54
69
  private __create;
55
70
  /**
71
+ * **CLI:**
72
+ * ```bash
73
+ * agentmail inboxes:lists delete --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
74
+ * ```
75
+ *
56
76
  * @param {AgentMail.inboxes.InboxId} inbox_id
57
77
  * @param {AgentMail.Direction} direction
58
78
  * @param {AgentMail.ListType} type
@@ -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 inboxes:lists list --inbox-id <inbox_id> --direction <direction> --type <type>
63
+ * ```
64
+ *
60
65
  * @param {AgentMail.inboxes.InboxId} inbox_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 inboxes:lists retrieve --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
125
+ * ```
126
+ *
117
127
  * @param {AgentMail.inboxes.InboxId} inbox_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 inboxes:lists create --inbox-id <inbox_id> --direction <direction> --type <type> --entry user@example.com
195
+ * ```
196
+ *
182
197
  * @param {AgentMail.inboxes.InboxId} inbox_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 inboxes:lists delete --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
273
+ * ```
274
+ *
255
275
  * @param {AgentMail.inboxes.InboxId} inbox_id
256
276
  * @param {AgentMail.Direction} direction
257
277
  * @param {AgentMail.ListType} type
@@ -11,6 +11,11 @@ export declare class MessagesClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<MessagesClient.Options>;
12
12
  constructor(options?: MessagesClient.Options);
13
13
  /**
14
+ * **CLI:**
15
+ * ```bash
16
+ * agentmail inboxes:messages list --inbox-id <inbox_id>
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.inboxes.InboxId} inbox_id
15
20
  * @param {AgentMail.inboxes.ListMessagesRequest} request
16
21
  * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -23,6 +28,11 @@ export declare class MessagesClient {
23
28
  list(inbox_id: AgentMail.inboxes.InboxId, request?: AgentMail.inboxes.ListMessagesRequest, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListMessagesResponse>;
24
29
  private __list;
25
30
  /**
31
+ * **CLI:**
32
+ * ```bash
33
+ * agentmail inboxes:messages retrieve --inbox-id <inbox_id> --message-id <message_id>
34
+ * ```
35
+ *
26
36
  * @param {AgentMail.inboxes.InboxId} inbox_id
27
37
  * @param {AgentMail.MessageId} message_id
28
38
  * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -35,6 +45,11 @@ export declare class MessagesClient {
35
45
  get(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.Message>;
36
46
  private __get;
37
47
  /**
48
+ * **CLI:**
49
+ * ```bash
50
+ * agentmail inboxes:messages get-attachment --inbox-id <inbox_id> --message-id <message_id> --attachment-id <attachment_id>
51
+ * ```
52
+ *
38
53
  * @param {AgentMail.inboxes.InboxId} inbox_id
39
54
  * @param {AgentMail.MessageId} message_id
40
55
  * @param {AgentMail.AttachmentId} attachment_id
@@ -48,6 +63,11 @@ export declare class MessagesClient {
48
63
  getAttachment(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, attachment_id: AgentMail.AttachmentId, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.AttachmentResponse>;
49
64
  private __getAttachment;
50
65
  /**
66
+ * **CLI:**
67
+ * ```bash
68
+ * agentmail inboxes:messages get-raw --inbox-id <inbox_id> --message-id <message_id>
69
+ * ```
70
+ *
51
71
  * @param {AgentMail.inboxes.InboxId} inbox_id
52
72
  * @param {AgentMail.MessageId} message_id
53
73
  * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -60,6 +80,11 @@ export declare class MessagesClient {
60
80
  getRaw(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.RawMessageResponse>;
61
81
  private __getRaw;
62
82
  /**
83
+ * **CLI:**
84
+ * ```bash
85
+ * agentmail inboxes:messages update --inbox-id <inbox_id> --message-id <message_id> --add-label read --remove-label unread
86
+ * ```
87
+ *
63
88
  * @param {AgentMail.inboxes.InboxId} inbox_id
64
89
  * @param {AgentMail.MessageId} message_id
65
90
  * @param {AgentMail.UpdateMessageRequest} request
@@ -74,6 +99,30 @@ export declare class MessagesClient {
74
99
  update(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, request: AgentMail.UpdateMessageRequest, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.UpdateMessageResponse>;
75
100
  private __update;
76
101
  /**
102
+ * Permanently deletes a message.
103
+ *
104
+ * **CLI:**
105
+ * ```bash
106
+ * agentmail inboxes:messages delete --inbox-id <inbox_id> --message-id <message_id>
107
+ * ```
108
+ *
109
+ * @param {AgentMail.inboxes.InboxId} inbox_id
110
+ * @param {AgentMail.MessageId} message_id
111
+ * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
112
+ *
113
+ * @throws {@link AgentMail.NotFoundError}
114
+ *
115
+ * @example
116
+ * await client.inboxes.messages.delete("inbox_id", "message_id")
117
+ */
118
+ delete(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<void>;
119
+ private __delete;
120
+ /**
121
+ * **CLI:**
122
+ * ```bash
123
+ * agentmail inboxes:messages send --inbox-id <inbox_id> --to recipient@example.com --subject "Hello" --text "Body"
124
+ * ```
125
+ *
77
126
  * @param {AgentMail.inboxes.InboxId} inbox_id
78
127
  * @param {AgentMail.SendMessageRequest} request
79
128
  * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -88,6 +137,11 @@ export declare class MessagesClient {
88
137
  send(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.SendMessageRequest, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.SendMessageResponse>;
89
138
  private __send;
90
139
  /**
140
+ * **CLI:**
141
+ * ```bash
142
+ * agentmail inboxes:messages reply --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
143
+ * ```
144
+ *
91
145
  * @param {AgentMail.inboxes.InboxId} inbox_id
92
146
  * @param {AgentMail.MessageId} message_id
93
147
  * @param {AgentMail.ReplyToMessageRequest} request
@@ -103,6 +157,11 @@ export declare class MessagesClient {
103
157
  reply(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, request: AgentMail.ReplyToMessageRequest, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.SendMessageResponse>;
104
158
  private __reply;
105
159
  /**
160
+ * **CLI:**
161
+ * ```bash
162
+ * agentmail inboxes:messages reply-all --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
163
+ * ```
164
+ *
106
165
  * @param {AgentMail.inboxes.InboxId} inbox_id
107
166
  * @param {AgentMail.MessageId} message_id
108
167
  * @param {AgentMail.ReplyAllMessageRequest} request
@@ -118,6 +177,11 @@ export declare class MessagesClient {
118
177
  replyAll(inbox_id: AgentMail.inboxes.InboxId, message_id: AgentMail.MessageId, request: AgentMail.ReplyAllMessageRequest, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<AgentMail.SendMessageResponse>;
119
178
  private __replyAll;
120
179
  /**
180
+ * **CLI:**
181
+ * ```bash
182
+ * agentmail inboxes:messages forward --inbox-id <inbox_id> --message-id <message_id> --to recipient@example.com
183
+ * ```
184
+ *
121
185
  * @param {AgentMail.inboxes.InboxId} inbox_id
122
186
  * @param {AgentMail.MessageId} message_id
123
187
  * @param {AgentMail.SendMessageRequest} request
@@ -58,6 +58,11 @@ class MessagesClient {
58
58
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
59
59
  }
60
60
  /**
61
+ * **CLI:**
62
+ * ```bash
63
+ * agentmail inboxes:messages list --inbox-id <inbox_id>
64
+ * ```
65
+ *
61
66
  * @param {AgentMail.inboxes.InboxId} inbox_id
62
67
  * @param {AgentMail.inboxes.ListMessagesRequest} request
63
68
  * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -142,6 +147,11 @@ class MessagesClient {
142
147
  });
143
148
  }
144
149
  /**
150
+ * **CLI:**
151
+ * ```bash
152
+ * agentmail inboxes:messages retrieve --inbox-id <inbox_id> --message-id <message_id>
153
+ * ```
154
+ *
145
155
  * @param {AgentMail.inboxes.InboxId} inbox_id
146
156
  * @param {AgentMail.MessageId} message_id
147
157
  * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -205,6 +215,11 @@ class MessagesClient {
205
215
  });
206
216
  }
207
217
  /**
218
+ * **CLI:**
219
+ * ```bash
220
+ * agentmail inboxes:messages get-attachment --inbox-id <inbox_id> --message-id <message_id> --attachment-id <attachment_id>
221
+ * ```
222
+ *
208
223
  * @param {AgentMail.inboxes.InboxId} inbox_id
209
224
  * @param {AgentMail.MessageId} message_id
210
225
  * @param {AgentMail.AttachmentId} attachment_id
@@ -269,6 +284,11 @@ class MessagesClient {
269
284
  });
270
285
  }
271
286
  /**
287
+ * **CLI:**
288
+ * ```bash
289
+ * agentmail inboxes:messages get-raw --inbox-id <inbox_id> --message-id <message_id>
290
+ * ```
291
+ *
272
292
  * @param {AgentMail.inboxes.InboxId} inbox_id
273
293
  * @param {AgentMail.MessageId} message_id
274
294
  * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -332,6 +352,11 @@ class MessagesClient {
332
352
  });
333
353
  }
334
354
  /**
355
+ * **CLI:**
356
+ * ```bash
357
+ * agentmail inboxes:messages update --inbox-id <inbox_id> --message-id <message_id> --add-label read --remove-label unread
358
+ * ```
359
+ *
335
360
  * @param {AgentMail.inboxes.InboxId} inbox_id
336
361
  * @param {AgentMail.MessageId} message_id
337
362
  * @param {AgentMail.UpdateMessageRequest} request
@@ -411,6 +436,72 @@ class MessagesClient {
411
436
  });
412
437
  }
413
438
  /**
439
+ * Permanently deletes a message.
440
+ *
441
+ * **CLI:**
442
+ * ```bash
443
+ * agentmail inboxes:messages delete --inbox-id <inbox_id> --message-id <message_id>
444
+ * ```
445
+ *
446
+ * @param {AgentMail.inboxes.InboxId} inbox_id
447
+ * @param {AgentMail.MessageId} message_id
448
+ * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
449
+ *
450
+ * @throws {@link AgentMail.NotFoundError}
451
+ *
452
+ * @example
453
+ * await client.inboxes.messages.delete("inbox_id", "message_id")
454
+ */
455
+ delete(inbox_id, message_id, requestOptions) {
456
+ return core.HttpResponsePromise.fromPromise(this.__delete(inbox_id, message_id, requestOptions));
457
+ }
458
+ __delete(inbox_id, message_id, requestOptions) {
459
+ return __awaiter(this, void 0, void 0, function* () {
460
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
461
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
462
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
463
+ const _response = yield core.fetcher({
464
+ url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.AgentMailEnvironment.Prod)
465
+ .http, `/v0/inboxes/${core.url.encodePathParam(serializers.inboxes.InboxId.jsonOrThrow(inbox_id, { omitUndefined: true }))}/messages/${core.url.encodePathParam(serializers.MessageId.jsonOrThrow(message_id, { omitUndefined: true }))}`),
466
+ method: "DELETE",
467
+ headers: _headers,
468
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
469
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
470
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
471
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
472
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
473
+ logging: this._options.logging,
474
+ });
475
+ if (_response.ok) {
476
+ return { data: undefined, rawResponse: _response.rawResponse };
477
+ }
478
+ if (_response.error.reason === "status-code") {
479
+ switch (_response.error.statusCode) {
480
+ case 404:
481
+ throw new AgentMail.NotFoundError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
482
+ unrecognizedObjectKeys: "passthrough",
483
+ allowUnrecognizedUnionMembers: true,
484
+ allowUnrecognizedEnumValues: true,
485
+ skipValidation: true,
486
+ breadcrumbsPrefix: ["response"],
487
+ }), _response.rawResponse);
488
+ default:
489
+ throw new errors.AgentMailError({
490
+ statusCode: _response.error.statusCode,
491
+ body: _response.error.body,
492
+ rawResponse: _response.rawResponse,
493
+ });
494
+ }
495
+ }
496
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/v0/inboxes/{inbox_id}/messages/{message_id}");
497
+ });
498
+ }
499
+ /**
500
+ * **CLI:**
501
+ * ```bash
502
+ * agentmail inboxes:messages send --inbox-id <inbox_id> --to recipient@example.com --subject "Hello" --text "Body"
503
+ * ```
504
+ *
414
505
  * @param {AgentMail.inboxes.InboxId} inbox_id
415
506
  * @param {AgentMail.SendMessageRequest} request
416
507
  * @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -498,6 +589,11 @@ class MessagesClient {
498
589
  });
499
590
  }
500
591
  /**
592
+ * **CLI:**
593
+ * ```bash
594
+ * agentmail inboxes:messages reply --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
595
+ * ```
596
+ *
501
597
  * @param {AgentMail.inboxes.InboxId} inbox_id
502
598
  * @param {AgentMail.MessageId} message_id
503
599
  * @param {AgentMail.ReplyToMessageRequest} request
@@ -586,6 +682,11 @@ class MessagesClient {
586
682
  });
587
683
  }
588
684
  /**
685
+ * **CLI:**
686
+ * ```bash
687
+ * agentmail inboxes:messages reply-all --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
688
+ * ```
689
+ *
589
690
  * @param {AgentMail.inboxes.InboxId} inbox_id
590
691
  * @param {AgentMail.MessageId} message_id
591
692
  * @param {AgentMail.ReplyAllMessageRequest} request
@@ -674,6 +775,11 @@ class MessagesClient {
674
775
  });
675
776
  }
676
777
  /**
778
+ * **CLI:**
779
+ * ```bash
780
+ * agentmail inboxes:messages forward --inbox-id <inbox_id> --message-id <message_id> --to recipient@example.com
781
+ * ```
782
+ *
677
783
  * @param {AgentMail.inboxes.InboxId} inbox_id
678
784
  * @param {AgentMail.MessageId} message_id
679
785
  * @param {AgentMail.SendMessageRequest} request
@@ -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 inboxes:metrics query --inbox-id <inbox_id>
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.inboxes.InboxId} inbox_id
15
20
  * @param {AgentMail.inboxes.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 inboxes:metrics query --inbox-id <inbox_id>
64
+ * ```
65
+ *
61
66
  * @param {AgentMail.inboxes.InboxId} inbox_id
62
67
  * @param {AgentMail.inboxes.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 inboxes:threads list --inbox-id <inbox_id>
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.inboxes.InboxId} inbox_id
15
20
  * @param {AgentMail.inboxes.ListThreadsRequest} request
16
21
  * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -23,6 +28,11 @@ export declare class ThreadsClient {
23
28
  list(inbox_id: AgentMail.inboxes.InboxId, request?: AgentMail.inboxes.ListThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListThreadsResponse>;
24
29
  private __list;
25
30
  /**
31
+ * **CLI:**
32
+ * ```bash
33
+ * agentmail inboxes:threads retrieve --inbox-id <inbox_id> --thread-id <thread_id>
34
+ * ```
35
+ *
26
36
  * @param {AgentMail.inboxes.InboxId} inbox_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(inbox_id: AgentMail.inboxes.InboxId, thread_id: AgentMail.ThreadId, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Thread>;
36
46
  private __get;
37
47
  /**
48
+ * **CLI:**
49
+ * ```bash
50
+ * agentmail inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thread_id> --attachment-id <attachment_id>
51
+ * ```
52
+ *
38
53
  * @param {AgentMail.inboxes.InboxId} inbox_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 inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>
88
+ * ```
89
+ *
70
90
  * @param {AgentMail.inboxes.InboxId} inbox_id
71
91
  * @param {AgentMail.ThreadId} thread_id
72
92
  * @param {AgentMail.inboxes.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 inboxes:threads list --inbox-id <inbox_id>
64
+ * ```
65
+ *
61
66
  * @param {AgentMail.inboxes.InboxId} inbox_id
62
67
  * @param {AgentMail.inboxes.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 inboxes:threads retrieve --inbox-id <inbox_id> --thread-id <thread_id>
153
+ * ```
154
+ *
145
155
  * @param {AgentMail.inboxes.InboxId} inbox_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 inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thread_id> --attachment-id <attachment_id>
221
+ * ```
222
+ *
208
223
  * @param {AgentMail.inboxes.InboxId} inbox_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 inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>
382
+ * ```
383
+ *
364
384
  * @param {AgentMail.inboxes.InboxId} inbox_id
365
385
  * @param {AgentMail.ThreadId} thread_id
366
386
  * @param {AgentMail.inboxes.DeleteThreadRequest} request