agentmail 0.0.9 → 0.0.10

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 (4) hide show
  1. package/README.md +8 -8
  2. package/package.json +1 -1
  3. package/reference.md +18 -223
  4. package/.env +0 -1
package/README.md CHANGED
@@ -20,10 +20,10 @@ A full reference for this library is available [here](./reference.md).
20
20
  Instantiate and use the client with the following:
21
21
 
22
22
  ```typescript
23
- import { AgentMailApiEnvironment, AgentMailApiClient } from "agentmail";
23
+ import { AgentMailApiClient } from "agentmail";
24
24
 
25
- const client = new AgentMailApiClient({ environment: AgentMailApiEnvironment.Production, apiKey: "YOUR_API_KEY" });
26
- await client.inboxes.createInbox({
25
+ const client = new AgentMailApiClient({ apiKey: "YOUR_API_KEY" });
26
+ await client.inboxes.create({
27
27
  domain: "yourdomain.com",
28
28
  });
29
29
  ```
@@ -50,7 +50,7 @@ will be thrown.
50
50
  import { AgentMailApiError } from "agentmail";
51
51
 
52
52
  try {
53
- await client.inboxes.createInbox(...);
53
+ await client.inboxes.create(...);
54
54
  } catch (err) {
55
55
  if (err instanceof AgentMailApiError) {
56
56
  console.log(err.statusCode);
@@ -67,7 +67,7 @@ try {
67
67
  If you would like to send additional headers as part of the request, use the `headers` request option.
68
68
 
69
69
  ```typescript
70
- const response = await client.inboxes.createInbox(..., {
70
+ const response = await client.inboxes.create(..., {
71
71
  headers: {
72
72
  'X-Custom-Header': 'custom value'
73
73
  }
@@ -89,7 +89,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
89
89
  Use the `maxRetries` request option to configure this behavior.
90
90
 
91
91
  ```typescript
92
- const response = await client.inboxes.createInbox(..., {
92
+ const response = await client.inboxes.create(..., {
93
93
  maxRetries: 0 // override maxRetries at the request level
94
94
  });
95
95
  ```
@@ -99,7 +99,7 @@ const response = await client.inboxes.createInbox(..., {
99
99
  The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
100
100
 
101
101
  ```typescript
102
- const response = await client.inboxes.createInbox(..., {
102
+ const response = await client.inboxes.create(..., {
103
103
  timeoutInSeconds: 30 // override timeout to 30s
104
104
  });
105
105
  ```
@@ -110,7 +110,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
110
110
 
111
111
  ```typescript
112
112
  const controller = new AbortController();
113
- const response = await client.inboxes.createInbox(..., {
113
+ const response = await client.inboxes.create(..., {
114
114
  abortSignal: controller.signal
115
115
  });
116
116
  controller.abort(); // aborts the request
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agentmail",
3
- "version": "0.0.9",
3
+ "version": "0.0.10",
4
4
  "private": false,
5
5
  "repository": "https://github.com/agentmail-to/agentmail-node",
6
6
  "main": "./index.js",
package/reference.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  ## Inboxes
4
4
 
5
- <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">listInboxes</a>({ ...params }) -> AgentMailApi.ListInboxesResponse</code></summary>
5
+ <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">list</a>({ ...params }) -> AgentMailApi.ListInboxesResponse</code></summary>
6
6
  <dl>
7
7
  <dd>
8
8
 
@@ -15,7 +15,7 @@
15
15
  <dd>
16
16
 
17
17
  ```typescript
18
- await client.inboxes.listInboxes();
18
+ await client.inboxes.list();
19
19
  ```
20
20
 
21
21
  </dd>
@@ -50,7 +50,7 @@ await client.inboxes.listInboxes();
50
50
  </dl>
51
51
  </details>
52
52
 
53
- <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">getInbox</a>(inboxId) -> AgentMailApi.Inbox</code></summary>
53
+ <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">get</a>(inboxId) -> AgentMailApi.Inbox</code></summary>
54
54
  <dl>
55
55
  <dd>
56
56
 
@@ -63,7 +63,7 @@ await client.inboxes.listInboxes();
63
63
  <dd>
64
64
 
65
65
  ```typescript
66
- await client.inboxes.getInbox("inbox_id");
66
+ await client.inboxes.get("inbox_id");
67
67
  ```
68
68
 
69
69
  </dd>
@@ -98,7 +98,7 @@ await client.inboxes.getInbox("inbox_id");
98
98
  </dl>
99
99
  </details>
100
100
 
101
- <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">createInbox</a>({ ...params }) -> AgentMailApi.Inbox</code></summary>
101
+ <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">create</a>({ ...params }) -> AgentMailApi.Inbox</code></summary>
102
102
  <dl>
103
103
  <dd>
104
104
 
@@ -111,7 +111,7 @@ await client.inboxes.getInbox("inbox_id");
111
111
  <dd>
112
112
 
113
113
  ```typescript
114
- await client.inboxes.createInbox({
114
+ await client.inboxes.create({
115
115
  username: "yourinbox",
116
116
  displayName: "Your Inbox",
117
117
  });
@@ -149,72 +149,9 @@ await client.inboxes.createInbox({
149
149
  </dl>
150
150
  </details>
151
151
 
152
- <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">deleteInbox</a>(inboxId) -> void</code></summary>
153
- <dl>
154
- <dd>
155
-
156
- #### 📝 Description
157
-
158
- <dl>
159
- <dd>
160
-
161
- <dl>
162
- <dd>
163
-
164
- Delete inbox and all of its threads, messages, and attachments.
165
-
166
- </dd>
167
- </dl>
168
- </dd>
169
- </dl>
170
-
171
- #### 🔌 Usage
172
-
173
- <dl>
174
- <dd>
175
-
176
- <dl>
177
- <dd>
178
-
179
- ```typescript
180
- await client.inboxes.deleteInbox("yourinbox@agentmail.to");
181
- ```
182
-
183
- </dd>
184
- </dl>
185
- </dd>
186
- </dl>
187
-
188
- #### ⚙️ Parameters
189
-
190
- <dl>
191
- <dd>
192
-
193
- <dl>
194
- <dd>
195
-
196
- **inboxId:** `AgentMailApi.InboxId`
197
-
198
- </dd>
199
- </dl>
200
-
201
- <dl>
202
- <dd>
203
-
204
- **requestOptions:** `Inboxes.RequestOptions`
205
-
206
- </dd>
207
- </dl>
208
- </dd>
209
- </dl>
210
-
211
- </dd>
212
- </dl>
213
- </details>
214
-
215
152
  ## Messages
216
153
 
217
- <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">listMessages</a>(inboxId, { ...params }) -> AgentMailApi.ListMessagesResponse</code></summary>
154
+ <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMailApi.ListMessagesResponse</code></summary>
218
155
  <dl>
219
156
  <dd>
220
157
 
@@ -227,7 +164,7 @@ await client.inboxes.deleteInbox("yourinbox@agentmail.to");
227
164
  <dd>
228
165
 
229
166
  ```typescript
230
- await client.messages.listMessages("inbox_id");
167
+ await client.messages.list("inbox_id");
231
168
  ```
232
169
 
233
170
  </dd>
@@ -270,7 +207,7 @@ await client.messages.listMessages("inbox_id");
270
207
  </dl>
271
208
  </details>
272
209
 
273
- <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">getMessage</a>(inboxId, messageId) -> AgentMailApi.Message</code></summary>
210
+ <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">get</a>(inboxId, messageId) -> AgentMailApi.Message</code></summary>
274
211
  <dl>
275
212
  <dd>
276
213
 
@@ -283,7 +220,7 @@ await client.messages.listMessages("inbox_id");
283
220
  <dd>
284
221
 
285
222
  ```typescript
286
- await client.messages.getMessage("inbox_id", "message_id");
223
+ await client.messages.get("inbox_id", "message_id");
287
224
  ```
288
225
 
289
226
  </dd>
@@ -326,25 +263,10 @@ await client.messages.getMessage("inbox_id", "message_id");
326
263
  </dl>
327
264
  </details>
328
265
 
329
- <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">deleteMessage</a>(inboxId, messageId) -> void</code></summary>
330
- <dl>
331
- <dd>
332
-
333
- #### 📝 Description
334
-
335
- <dl>
336
- <dd>
337
-
266
+ <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">send</a>(inboxId, { ...params }) -> AgentMailApi.SendMessageResponse</code></summary>
338
267
  <dl>
339
268
  <dd>
340
269
 
341
- Delete message and its attachments.
342
-
343
- </dd>
344
- </dl>
345
- </dd>
346
- </dl>
347
-
348
270
  #### 🔌 Usage
349
271
 
350
272
  <dl>
@@ -354,63 +276,7 @@ Delete message and its attachments.
354
276
  <dd>
355
277
 
356
278
  ```typescript
357
- await client.messages.deleteMessage("inbox_id", "message_id");
358
- ```
359
-
360
- </dd>
361
- </dl>
362
- </dd>
363
- </dl>
364
-
365
- #### ⚙️ Parameters
366
-
367
- <dl>
368
- <dd>
369
-
370
- <dl>
371
- <dd>
372
-
373
- **inboxId:** `AgentMailApi.InboxId`
374
-
375
- </dd>
376
- </dl>
377
-
378
- <dl>
379
- <dd>
380
-
381
- **messageId:** `AgentMailApi.MessageId`
382
-
383
- </dd>
384
- </dl>
385
-
386
- <dl>
387
- <dd>
388
-
389
- **requestOptions:** `Messages.RequestOptions`
390
-
391
- </dd>
392
- </dl>
393
- </dd>
394
- </dl>
395
-
396
- </dd>
397
- </dl>
398
- </details>
399
-
400
- <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">sendMessage</a>(inboxId, { ...params }) -> AgentMailApi.SendMessageResponse</code></summary>
401
- <dl>
402
- <dd>
403
-
404
- #### 🔌 Usage
405
-
406
- <dl>
407
- <dd>
408
-
409
- <dl>
410
- <dd>
411
-
412
- ```typescript
413
- await client.messages.sendMessage("inbox_id", {
279
+ await client.messages.send("inbox_id", {
414
280
  to: "to",
415
281
  cc: undefined,
416
282
  bcc: undefined,
@@ -460,7 +326,7 @@ await client.messages.sendMessage("inbox_id", {
460
326
  </dl>
461
327
  </details>
462
328
 
463
- <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">replyToMessage</a>(inboxId, messageId, { ...params }) -> AgentMailApi.SendMessageResponse</code></summary>
329
+ <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">reply</a>(inboxId, messageId, { ...params }) -> AgentMailApi.SendMessageResponse</code></summary>
464
330
  <dl>
465
331
  <dd>
466
332
 
@@ -473,7 +339,7 @@ await client.messages.sendMessage("inbox_id", {
473
339
  <dd>
474
340
 
475
341
  ```typescript
476
- await client.messages.replyToMessage("inbox_id", "message_id", {
342
+ await client.messages.reply("inbox_id", "message_id", {
477
343
  to: undefined,
478
344
  cc: undefined,
479
345
  bcc: undefined,
@@ -532,7 +398,7 @@ await client.messages.replyToMessage("inbox_id", "message_id", {
532
398
 
533
399
  ## Threads
534
400
 
535
- <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">listThreads</a>(inboxId, { ...params }) -> AgentMailApi.ListThreadsResponse</code></summary>
401
+ <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMailApi.ListThreadsResponse</code></summary>
536
402
  <dl>
537
403
  <dd>
538
404
 
@@ -545,7 +411,7 @@ await client.messages.replyToMessage("inbox_id", "message_id", {
545
411
  <dd>
546
412
 
547
413
  ```typescript
548
- await client.threads.listThreads("inbox_id");
414
+ await client.threads.list("inbox_id");
549
415
  ```
550
416
 
551
417
  </dd>
@@ -588,81 +454,10 @@ await client.threads.listThreads("inbox_id");
588
454
  </dl>
589
455
  </details>
590
456
 
591
- <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">getThread</a>(inboxId, threadId) -> AgentMailApi.Thread</code></summary>
592
- <dl>
593
- <dd>
594
-
595
- #### 🔌 Usage
596
-
597
- <dl>
598
- <dd>
599
-
600
- <dl>
601
- <dd>
602
-
603
- ```typescript
604
- await client.threads.getThread("inbox_id", "thread_id");
605
- ```
606
-
607
- </dd>
608
- </dl>
609
- </dd>
610
- </dl>
611
-
612
- #### ⚙️ Parameters
613
-
614
- <dl>
615
- <dd>
616
-
617
- <dl>
618
- <dd>
619
-
620
- **inboxId:** `AgentMailApi.InboxId`
621
-
622
- </dd>
623
- </dl>
624
-
625
- <dl>
626
- <dd>
627
-
628
- **threadId:** `AgentMailApi.ThreadId`
629
-
630
- </dd>
631
- </dl>
632
-
633
- <dl>
634
- <dd>
635
-
636
- **requestOptions:** `Threads.RequestOptions`
637
-
638
- </dd>
639
- </dl>
640
- </dd>
641
- </dl>
642
-
643
- </dd>
644
- </dl>
645
- </details>
646
-
647
- <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">deleteThread</a>(inboxId, threadId) -> void</code></summary>
648
- <dl>
649
- <dd>
650
-
651
- #### 📝 Description
652
-
653
- <dl>
654
- <dd>
655
-
457
+ <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">get</a>(inboxId, threadId) -> AgentMailApi.Thread</code></summary>
656
458
  <dl>
657
459
  <dd>
658
460
 
659
- Delete thread and all of its messages and attachments.
660
-
661
- </dd>
662
- </dl>
663
- </dd>
664
- </dl>
665
-
666
461
  #### 🔌 Usage
667
462
 
668
463
  <dl>
@@ -672,7 +467,7 @@ Delete thread and all of its messages and attachments.
672
467
  <dd>
673
468
 
674
469
  ```typescript
675
- await client.threads.deleteThread("inbox_id", "thread_id");
470
+ await client.threads.get("inbox_id", "thread_id");
676
471
  ```
677
472
 
678
473
  </dd>
package/.env DELETED
@@ -1 +0,0 @@
1
- OPENAI_API_KEY=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