@pidgeon-ai/sdk 1.8.0 → 1.11.0

package/CHANGELOG.md

@@ -9,6 +9,32 @@ call shapes, the result shape — not to the API behind it.
 
 ## Unreleased
 
+## 1.11.0 — a key for one pod
+
+`apiKeysCreate` takes `pod_id` in place of `identity_ids`: the key reaches
+every address in that pod, including ones added later, and may create,
+verify and remove that pod's domains — the key a platform hands one of its
+customers. Only a key over the whole account (or an owner, in the dashboard)
+can mint one. Every key now reports `pod_id`, null for keys that are not
+pod keys.
+
+## 1.10.0 — events over a WebSocket
+
+`GET /v1/events/socket` is the event log over a WebSocket, with the same
+filters and `after` cursor as the stream. The generated `eventsSocket` can
+only show you the contract — open it with a WebSocket client
+(`new WebSocket('wss://pidgeon.ai/api/v1/events/socket')`) and send
+`{"type":"auth","api_key":…}` first if you cannot set a header. The
+protocol is in the reference.
+
+## 1.9.0 — export over the API
+
+**`exportMail`** (`GET /v1/export`) streams every message the key can read as
+one `application/mbox` file — the export the dashboard has always offered,
+now for software. Pass `identity_id` for one address. Each message carries
+`X-Pidgeon-Mailbox`, so one file holding several addresses can be split
+again. Four an hour per workspace.
+
 ## 1.8.0 — wait for a message, and read the code out of it
 
 **`messagesAwait`** (`GET /v1/messages/await`) holds the request open until a

package/dist/index.cjs

@@ -62,7 +62,9 @@ __export(index_exports, {
   draftsUpdate: () => draftsUpdate,
   eventsGet: () => eventsGet,
   eventsList: () => eventsList,
+  eventsSocket: () => eventsSocket,
   eventsStream: () => eventsStream,
+  exportMail: () => exportMail,
   identitiesAccessCreate: () => identitiesAccessCreate,
   identitiesAccessDelete: () => identitiesAccessDelete,
   identitiesAccessGet: () => identitiesAccessGet,
@@ -1227,6 +1229,11 @@ var messagesRaw = (options) => (options.client ?? client).get({
   url: "/messages/{id}/raw",
   ...options
 });
+var exportMail = (options) => (options?.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/export",
+  ...options
+});
 var threadsList = (options) => (options?.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/threads",
@@ -1414,6 +1421,11 @@ var eventsList = (options) => (options?.client ?? client).get({
   url: "/events",
   ...options
 });
+var eventsSocket = (options) => (options?.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/events/socket",
+  ...options
+});
 var eventsStream = (options) => (options?.client ?? client).sse.get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/events/stream",
@@ -1829,7 +1841,9 @@ function sleep(ms, signal) {
   draftsUpdate,
   eventsGet,
   eventsList,
+  eventsSocket,
   eventsStream,
+  exportMail,
   identitiesAccessCreate,
   identitiesAccessDelete,
   identitiesAccessGet,