@pidgeon-ai/sdk 1.31.0 → 1.31.1

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.
package/CHANGELOG.md CHANGED
@@ -7,6 +7,13 @@ the two would publish a release for every unrelated product deploy.
7
7
  Semver applies to **this package's own surface** — the exported names, the
8
8
  call shapes, the result shape — not to the API behind it.
9
9
 
10
+ ## 1.31.1 — inbox, address, folder
11
+
12
+ Descriptions only. Where the docs said "mailbox" they now say inbox (what an
13
+ agent or a person has), address (`name@domain`, which the API calls an
14
+ identity) or folder. Every name stays: `mailboxes.list`, `/v1/mailboxes`,
15
+ `identity_id`. No shape moves.
16
+
10
17
  ## 1.31.0 — `receive_policy`
11
18
 
12
19
  Every address carries `receive_policy`: `open` (anyone, the default) or
package/dist/index.d.cts CHANGED
@@ -331,7 +331,7 @@ type ClientOptions = {
331
331
  baseUrl: 'https://pidgeon.ai/api/v1' | (string & {});
332
332
  };
333
333
  /**
334
- * A mailbox, with the display name when one was given.
334
+ * An address, with the display name when one was given.
335
335
  */
336
336
  type Address = {
337
337
  email: string;
@@ -442,13 +442,13 @@ type Message = {
442
442
  id: string;
443
443
  thread_id: string;
444
444
  /**
445
- * The mailbox this message is in, as an id. What `POST /attachments` and the other endpoints that take a mailbox expect — `identity` below is the same address as text.
445
+ * The address this message is in, as an id. What `POST /attachments` and the other endpoints that take an `identity_id` expect — `identity` below is the same address as text.
446
446
  */
447
447
  identity_id: string | null;
448
448
  identity: string | null;
449
449
  direction: string;
450
450
  /**
451
- * A mailbox, with the display name when one was given.
451
+ * An address, with the display name when one was given.
452
452
  */
453
453
  from: {
454
454
  email: string;
@@ -662,13 +662,13 @@ type AwaitedMessage = {
662
662
  id: string;
663
663
  thread_id: string;
664
664
  /**
665
- * The mailbox this message is in, as an id. What `POST /attachments` and the other endpoints that take a mailbox expect — `identity` below is the same address as text.
665
+ * The address this message is in, as an id. What `POST /attachments` and the other endpoints that take an `identity_id` expect — `identity` below is the same address as text.
666
666
  */
667
667
  identity_id: string | null;
668
668
  identity: string | null;
669
669
  direction: string;
670
670
  /**
671
- * A mailbox, with the display name when one was given.
671
+ * An address, with the display name when one was given.
672
672
  */
673
673
  from: {
674
674
  email: string;
@@ -1180,7 +1180,7 @@ type EventResponse = {
1180
1180
  updated_at: string;
1181
1181
  };
1182
1182
  /**
1183
- * Which of the mailbox’s addresses answered.
1183
+ * Which of the inbox’s addresses answered.
1184
1184
  */
1185
1185
  attendee: string;
1186
1186
  status: string;
@@ -1192,7 +1192,7 @@ type EventResponse = {
1192
1192
  type InvitationResponse = {
1193
1193
  status: string;
1194
1194
  /**
1195
- * Which of the mailbox’s addresses answered.
1195
+ * Which of the inbox’s addresses answered.
1196
1196
  */
1197
1197
  attendee: string;
1198
1198
  /**
@@ -1816,7 +1816,7 @@ type SearchHit = {
1816
1816
  */
1817
1817
  folder: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash' | 'unauthenticated';
1818
1818
  /**
1819
- * The mailbox it was found in, as the address. `identity_id` is the same row.
1819
+ * The inbox it was found in, as the address. `identity_id` is the same row.
1820
1820
  */
1821
1821
  identity: string | null;
1822
1822
  };
package/dist/index.d.ts CHANGED
@@ -331,7 +331,7 @@ type ClientOptions = {
331
331
  baseUrl: 'https://pidgeon.ai/api/v1' | (string & {});
332
332
  };
333
333
  /**
334
- * A mailbox, with the display name when one was given.
334
+ * An address, with the display name when one was given.
335
335
  */
336
336
  type Address = {
337
337
  email: string;
@@ -442,13 +442,13 @@ type Message = {
442
442
  id: string;
443
443
  thread_id: string;
444
444
  /**
445
- * The mailbox this message is in, as an id. What `POST /attachments` and the other endpoints that take a mailbox expect — `identity` below is the same address as text.
445
+ * The address this message is in, as an id. What `POST /attachments` and the other endpoints that take an `identity_id` expect — `identity` below is the same address as text.
446
446
  */
447
447
  identity_id: string | null;
448
448
  identity: string | null;
449
449
  direction: string;
450
450
  /**
451
- * A mailbox, with the display name when one was given.
451
+ * An address, with the display name when one was given.
452
452
  */
453
453
  from: {
454
454
  email: string;
@@ -662,13 +662,13 @@ type AwaitedMessage = {
662
662
  id: string;
663
663
  thread_id: string;
664
664
  /**
665
- * The mailbox this message is in, as an id. What `POST /attachments` and the other endpoints that take a mailbox expect — `identity` below is the same address as text.
665
+ * The address this message is in, as an id. What `POST /attachments` and the other endpoints that take an `identity_id` expect — `identity` below is the same address as text.
666
666
  */
667
667
  identity_id: string | null;
668
668
  identity: string | null;
669
669
  direction: string;
670
670
  /**
671
- * A mailbox, with the display name when one was given.
671
+ * An address, with the display name when one was given.
672
672
  */
673
673
  from: {
674
674
  email: string;
@@ -1180,7 +1180,7 @@ type EventResponse = {
1180
1180
  updated_at: string;
1181
1181
  };
1182
1182
  /**
1183
- * Which of the mailbox’s addresses answered.
1183
+ * Which of the inbox’s addresses answered.
1184
1184
  */
1185
1185
  attendee: string;
1186
1186
  status: string;
@@ -1192,7 +1192,7 @@ type EventResponse = {
1192
1192
  type InvitationResponse = {
1193
1193
  status: string;
1194
1194
  /**
1195
- * Which of the mailbox’s addresses answered.
1195
+ * Which of the inbox’s addresses answered.
1196
1196
  */
1197
1197
  attendee: string;
1198
1198
  /**
@@ -1816,7 +1816,7 @@ type SearchHit = {
1816
1816
  */
1817
1817
  folder: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash' | 'unauthenticated';
1818
1818
  /**
1819
- * The mailbox it was found in, as the address. `identity_id` is the same row.
1819
+ * The inbox it was found in, as the address. `identity_id` is the same row.
1820
1820
  */
1821
1821
  identity: string | null;
1822
1822
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pidgeon-ai/sdk",
3
- "version": "1.31.0",
3
+ "version": "1.31.1",
4
4
  "description": "Email inboxes for AI agents — TypeScript SDK for Pidgeon: create addresses, send, receive and reply.",
5
5
  "keywords": [
6
6
  "email",