agentmail 0.0.10 → 0.0.12

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 (3) hide show
  1. package/README.md +10 -10
  2. package/package.json +1 -1
  3. package/reference.md +55 -25
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
- # AgentMail TypeScript Library
1
+ # Agentmail TypeScript Library
2
2
 
3
3
  [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fagentmail-to%2Fagentmail-node)
4
4
  [![npm shield](https://img.shields.io/npm/v/agentmail)](https://www.npmjs.com/package/agentmail)
5
5
 
6
- The AgentMail TypeScript library provides convenient access to the AgentMail API from TypeScript.
6
+ The Agentmail TypeScript library provides convenient access to the Agentmail API from TypeScript.
7
7
 
8
8
  ## Installation
9
9
 
@@ -20,9 +20,9 @@ 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 { AgentMailApiClient } from "agentmail";
23
+ import { AgentMailClient } from "agentmail";
24
24
 
25
- const client = new AgentMailApiClient({ apiKey: "YOUR_API_KEY" });
25
+ const client = new AgentMailClient({ apiKey: "YOUR_API_KEY" });
26
26
  await client.inboxes.create({
27
27
  domain: "yourdomain.com",
28
28
  });
@@ -34,9 +34,9 @@ The SDK exports all request and response types as TypeScript interfaces. Simply
34
34
  following namespace:
35
35
 
36
36
  ```typescript
37
- import { AgentMailApi } from "agentmail";
37
+ import { AgentMail } from "agentmail";
38
38
 
39
- const request: AgentMailApi.ListInboxesRequest = {
39
+ const request: AgentMail.ListInboxesRequest = {
40
40
  ...
41
41
  };
42
42
  ```
@@ -47,12 +47,12 @@ When the API returns a non-success status code (4xx or 5xx response), a subclass
47
47
  will be thrown.
48
48
 
49
49
  ```typescript
50
- import { AgentMailApiError } from "agentmail";
50
+ import { AgentMailError } from "agentmail";
51
51
 
52
52
  try {
53
53
  await client.inboxes.create(...);
54
54
  } catch (err) {
55
- if (err instanceof AgentMailApiError) {
55
+ if (err instanceof AgentMailError) {
56
56
  console.log(err.statusCode);
57
57
  console.log(err.message);
58
58
  console.log(err.body);
@@ -134,9 +134,9 @@ The SDK provides a way for your to customize the underlying HTTP client / Fetch
134
134
  unsupported environment, this provides a way for you to break glass and ensure the SDK works.
135
135
 
136
136
  ```typescript
137
- import { AgentMailApiClient } from "agentmail";
137
+ import { AgentMailClient } from "agentmail";
138
138
 
139
- const client = new AgentMailApiClient({
139
+ const client = new AgentMailClient({
140
140
  ...
141
141
  fetcher: // provide your implementation here
142
142
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agentmail",
3
- "version": "0.0.10",
3
+ "version": "0.0.12",
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">list</a>({ ...params }) -> AgentMailApi.ListInboxesResponse</code></summary>
5
+ <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListInboxesResponse</code></summary>
6
6
  <dl>
7
7
  <dd>
8
8
 
@@ -31,7 +31,7 @@ await client.inboxes.list();
31
31
  <dl>
32
32
  <dd>
33
33
 
34
- **request:** `AgentMailApi.ListInboxesRequest`
34
+ **request:** `AgentMail.ListInboxesRequest`
35
35
 
36
36
  </dd>
37
37
  </dl>
@@ -50,7 +50,7 @@ await client.inboxes.list();
50
50
  </dl>
51
51
  </details>
52
52
 
53
- <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">get</a>(inboxId) -> AgentMailApi.Inbox</code></summary>
53
+ <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">get</a>(inboxId) -> AgentMail.Inbox</code></summary>
54
54
  <dl>
55
55
  <dd>
56
56
 
@@ -79,7 +79,7 @@ await client.inboxes.get("inbox_id");
79
79
  <dl>
80
80
  <dd>
81
81
 
82
- **inboxId:** `AgentMailApi.InboxId`
82
+ **inboxId:** `AgentMail.InboxId`
83
83
 
84
84
  </dd>
85
85
  </dl>
@@ -98,7 +98,7 @@ await client.inboxes.get("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">create</a>({ ...params }) -> AgentMailApi.Inbox</code></summary>
101
+ <details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">create</a>({ ...params }) -> AgentMail.Inbox</code></summary>
102
102
  <dl>
103
103
  <dd>
104
104
 
@@ -130,7 +130,7 @@ await client.inboxes.create({
130
130
  <dl>
131
131
  <dd>
132
132
 
133
- **request:** `AgentMailApi.CreateInboxRequest`
133
+ **request:** `AgentMail.CreateInboxRequest`
134
134
 
135
135
  </dd>
136
136
  </dl>
@@ -151,10 +151,25 @@ await client.inboxes.create({
151
151
 
152
152
  ## Messages
153
153
 
154
- <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">list</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 }) -> AgentMail.ListMessagesResponse</code></summary>
155
155
  <dl>
156
156
  <dd>
157
157
 
158
+ #### 📝 Description
159
+
160
+ <dl>
161
+ <dd>
162
+
163
+ <dl>
164
+ <dd>
165
+
166
+ List messages in inbox. If neither or both `received` and `sent` query parameters are set, all messages are returned.
167
+
168
+ </dd>
169
+ </dl>
170
+ </dd>
171
+ </dl>
172
+
158
173
  #### 🔌 Usage
159
174
 
160
175
  <dl>
@@ -180,7 +195,7 @@ await client.messages.list("inbox_id");
180
195
  <dl>
181
196
  <dd>
182
197
 
183
- **inboxId:** `AgentMailApi.InboxId`
198
+ **inboxId:** `AgentMail.InboxId`
184
199
 
185
200
  </dd>
186
201
  </dl>
@@ -188,7 +203,7 @@ await client.messages.list("inbox_id");
188
203
  <dl>
189
204
  <dd>
190
205
 
191
- **request:** `AgentMailApi.ListMessagesRequest`
206
+ **request:** `AgentMail.ListMessagesRequest`
192
207
 
193
208
  </dd>
194
209
  </dl>
@@ -207,7 +222,7 @@ await client.messages.list("inbox_id");
207
222
  </dl>
208
223
  </details>
209
224
 
210
- <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">get</a>(inboxId, messageId) -> AgentMailApi.Message</code></summary>
225
+ <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">get</a>(inboxId, messageId) -> AgentMail.Message</code></summary>
211
226
  <dl>
212
227
  <dd>
213
228
 
@@ -236,7 +251,7 @@ await client.messages.get("inbox_id", "message_id");
236
251
  <dl>
237
252
  <dd>
238
253
 
239
- **inboxId:** `AgentMailApi.InboxId`
254
+ **inboxId:** `AgentMail.InboxId`
240
255
 
241
256
  </dd>
242
257
  </dl>
@@ -244,7 +259,7 @@ await client.messages.get("inbox_id", "message_id");
244
259
  <dl>
245
260
  <dd>
246
261
 
247
- **messageId:** `AgentMailApi.MessageId`
262
+ **messageId:** `AgentMail.MessageId`
248
263
 
249
264
  </dd>
250
265
  </dl>
@@ -263,7 +278,7 @@ await client.messages.get("inbox_id", "message_id");
263
278
  </dl>
264
279
  </details>
265
280
 
266
- <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">send</a>(inboxId, { ...params }) -> AgentMailApi.SendMessageResponse</code></summary>
281
+ <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">send</a>(inboxId, { ...params }) -> AgentMail.SendMessageResponse</code></summary>
267
282
  <dl>
268
283
  <dd>
269
284
 
@@ -299,7 +314,7 @@ await client.messages.send("inbox_id", {
299
314
  <dl>
300
315
  <dd>
301
316
 
302
- **inboxId:** `AgentMailApi.InboxId`
317
+ **inboxId:** `AgentMail.InboxId`
303
318
 
304
319
  </dd>
305
320
  </dl>
@@ -307,7 +322,7 @@ await client.messages.send("inbox_id", {
307
322
  <dl>
308
323
  <dd>
309
324
 
310
- **request:** `AgentMailApi.SendMessageRequest`
325
+ **request:** `AgentMail.SendMessageRequest`
311
326
 
312
327
  </dd>
313
328
  </dl>
@@ -326,7 +341,7 @@ await client.messages.send("inbox_id", {
326
341
  </dl>
327
342
  </details>
328
343
 
329
- <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">reply</a>(inboxId, messageId, { ...params }) -> AgentMailApi.SendMessageResponse</code></summary>
344
+ <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">reply</a>(inboxId, messageId, { ...params }) -> AgentMail.SendMessageResponse</code></summary>
330
345
  <dl>
331
346
  <dd>
332
347
 
@@ -361,7 +376,7 @@ await client.messages.reply("inbox_id", "message_id", {
361
376
  <dl>
362
377
  <dd>
363
378
 
364
- **inboxId:** `AgentMailApi.InboxId`
379
+ **inboxId:** `AgentMail.InboxId`
365
380
 
366
381
  </dd>
367
382
  </dl>
@@ -369,7 +384,7 @@ await client.messages.reply("inbox_id", "message_id", {
369
384
  <dl>
370
385
  <dd>
371
386
 
372
- **messageId:** `AgentMailApi.MessageId`
387
+ **messageId:** `AgentMail.MessageId`
373
388
 
374
389
  </dd>
375
390
  </dl>
@@ -377,7 +392,7 @@ await client.messages.reply("inbox_id", "message_id", {
377
392
  <dl>
378
393
  <dd>
379
394
 
380
- **request:** `AgentMailApi.ReplyToMessageRequest`
395
+ **request:** `AgentMail.ReplyToMessageRequest`
381
396
 
382
397
  </dd>
383
398
  </dl>
@@ -398,10 +413,25 @@ await client.messages.reply("inbox_id", "message_id", {
398
413
 
399
414
  ## Threads
400
415
 
401
- <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMailApi.ListThreadsResponse</code></summary>
416
+ <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">list</a>(inboxId, { ...params }) -> AgentMail.ListThreadsResponse</code></summary>
402
417
  <dl>
403
418
  <dd>
404
419
 
420
+ #### 📝 Description
421
+
422
+ <dl>
423
+ <dd>
424
+
425
+ <dl>
426
+ <dd>
427
+
428
+ List threads in inbox. If neither or both `received` and `sent` query parameters are set, all threads are returned.
429
+
430
+ </dd>
431
+ </dl>
432
+ </dd>
433
+ </dl>
434
+
405
435
  #### 🔌 Usage
406
436
 
407
437
  <dl>
@@ -427,7 +457,7 @@ await client.threads.list("inbox_id");
427
457
  <dl>
428
458
  <dd>
429
459
 
430
- **inboxId:** `AgentMailApi.InboxId`
460
+ **inboxId:** `AgentMail.InboxId`
431
461
 
432
462
  </dd>
433
463
  </dl>
@@ -435,7 +465,7 @@ await client.threads.list("inbox_id");
435
465
  <dl>
436
466
  <dd>
437
467
 
438
- **request:** `AgentMailApi.ListThreadsRequest`
468
+ **request:** `AgentMail.ListThreadsRequest`
439
469
 
440
470
  </dd>
441
471
  </dl>
@@ -454,7 +484,7 @@ await client.threads.list("inbox_id");
454
484
  </dl>
455
485
  </details>
456
486
 
457
- <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">get</a>(inboxId, threadId) -> AgentMailApi.Thread</code></summary>
487
+ <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">get</a>(inboxId, threadId) -> AgentMail.Thread</code></summary>
458
488
  <dl>
459
489
  <dd>
460
490
 
@@ -483,7 +513,7 @@ await client.threads.get("inbox_id", "thread_id");
483
513
  <dl>
484
514
  <dd>
485
515
 
486
- **inboxId:** `AgentMailApi.InboxId`
516
+ **inboxId:** `AgentMail.InboxId`
487
517
 
488
518
  </dd>
489
519
  </dl>
@@ -491,7 +521,7 @@ await client.threads.get("inbox_id", "thread_id");
491
521
  <dl>
492
522
  <dd>
493
523
 
494
- **threadId:** `AgentMailApi.ThreadId`
524
+ **threadId:** `AgentMail.ThreadId`
495
525
 
496
526
  </dd>
497
527
  </dl>