agentmail 0.0.11 → 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 +8 -8
  2. package/package.json +1 -1
  3. package/reference.md +25 -25
package/README.md CHANGED
@@ -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.11",
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,7 +151,7 @@ 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
 
@@ -195,7 +195,7 @@ await client.messages.list("inbox_id");
195
195
  <dl>
196
196
  <dd>
197
197
 
198
- **inboxId:** `AgentmailApi.InboxId`
198
+ **inboxId:** `AgentMail.InboxId`
199
199
 
200
200
  </dd>
201
201
  </dl>
@@ -203,7 +203,7 @@ await client.messages.list("inbox_id");
203
203
  <dl>
204
204
  <dd>
205
205
 
206
- **request:** `AgentmailApi.ListMessagesRequest`
206
+ **request:** `AgentMail.ListMessagesRequest`
207
207
 
208
208
  </dd>
209
209
  </dl>
@@ -222,7 +222,7 @@ await client.messages.list("inbox_id");
222
222
  </dl>
223
223
  </details>
224
224
 
225
- <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>
226
226
  <dl>
227
227
  <dd>
228
228
 
@@ -251,7 +251,7 @@ await client.messages.get("inbox_id", "message_id");
251
251
  <dl>
252
252
  <dd>
253
253
 
254
- **inboxId:** `AgentmailApi.InboxId`
254
+ **inboxId:** `AgentMail.InboxId`
255
255
 
256
256
  </dd>
257
257
  </dl>
@@ -259,7 +259,7 @@ await client.messages.get("inbox_id", "message_id");
259
259
  <dl>
260
260
  <dd>
261
261
 
262
- **messageId:** `AgentmailApi.MessageId`
262
+ **messageId:** `AgentMail.MessageId`
263
263
 
264
264
  </dd>
265
265
  </dl>
@@ -278,7 +278,7 @@ await client.messages.get("inbox_id", "message_id");
278
278
  </dl>
279
279
  </details>
280
280
 
281
- <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>
282
282
  <dl>
283
283
  <dd>
284
284
 
@@ -314,7 +314,7 @@ await client.messages.send("inbox_id", {
314
314
  <dl>
315
315
  <dd>
316
316
 
317
- **inboxId:** `AgentmailApi.InboxId`
317
+ **inboxId:** `AgentMail.InboxId`
318
318
 
319
319
  </dd>
320
320
  </dl>
@@ -322,7 +322,7 @@ await client.messages.send("inbox_id", {
322
322
  <dl>
323
323
  <dd>
324
324
 
325
- **request:** `AgentmailApi.SendMessageRequest`
325
+ **request:** `AgentMail.SendMessageRequest`
326
326
 
327
327
  </dd>
328
328
  </dl>
@@ -341,7 +341,7 @@ await client.messages.send("inbox_id", {
341
341
  </dl>
342
342
  </details>
343
343
 
344
- <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>
345
345
  <dl>
346
346
  <dd>
347
347
 
@@ -376,7 +376,7 @@ await client.messages.reply("inbox_id", "message_id", {
376
376
  <dl>
377
377
  <dd>
378
378
 
379
- **inboxId:** `AgentmailApi.InboxId`
379
+ **inboxId:** `AgentMail.InboxId`
380
380
 
381
381
  </dd>
382
382
  </dl>
@@ -384,7 +384,7 @@ await client.messages.reply("inbox_id", "message_id", {
384
384
  <dl>
385
385
  <dd>
386
386
 
387
- **messageId:** `AgentmailApi.MessageId`
387
+ **messageId:** `AgentMail.MessageId`
388
388
 
389
389
  </dd>
390
390
  </dl>
@@ -392,7 +392,7 @@ await client.messages.reply("inbox_id", "message_id", {
392
392
  <dl>
393
393
  <dd>
394
394
 
395
- **request:** `AgentmailApi.ReplyToMessageRequest`
395
+ **request:** `AgentMail.ReplyToMessageRequest`
396
396
 
397
397
  </dd>
398
398
  </dl>
@@ -413,7 +413,7 @@ await client.messages.reply("inbox_id", "message_id", {
413
413
 
414
414
  ## Threads
415
415
 
416
- <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>
417
417
  <dl>
418
418
  <dd>
419
419
 
@@ -457,7 +457,7 @@ await client.threads.list("inbox_id");
457
457
  <dl>
458
458
  <dd>
459
459
 
460
- **inboxId:** `AgentmailApi.InboxId`
460
+ **inboxId:** `AgentMail.InboxId`
461
461
 
462
462
  </dd>
463
463
  </dl>
@@ -465,7 +465,7 @@ await client.threads.list("inbox_id");
465
465
  <dl>
466
466
  <dd>
467
467
 
468
- **request:** `AgentmailApi.ListThreadsRequest`
468
+ **request:** `AgentMail.ListThreadsRequest`
469
469
 
470
470
  </dd>
471
471
  </dl>
@@ -484,7 +484,7 @@ await client.threads.list("inbox_id");
484
484
  </dl>
485
485
  </details>
486
486
 
487
- <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>
488
488
  <dl>
489
489
  <dd>
490
490
 
@@ -513,7 +513,7 @@ await client.threads.get("inbox_id", "thread_id");
513
513
  <dl>
514
514
  <dd>
515
515
 
516
- **inboxId:** `AgentmailApi.InboxId`
516
+ **inboxId:** `AgentMail.InboxId`
517
517
 
518
518
  </dd>
519
519
  </dl>
@@ -521,7 +521,7 @@ await client.threads.get("inbox_id", "thread_id");
521
521
  <dl>
522
522
  <dd>
523
523
 
524
- **threadId:** `AgentmailApi.ThreadId`
524
+ **threadId:** `AgentMail.ThreadId`
525
525
 
526
526
  </dd>
527
527
  </dl>