@pidgeon-ai/sdk 1.21.0 → 1.23.0
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 +26 -0
- package/dist/index.cjs +11 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +235 -2
- package/dist/index.d.ts +235 -2
- package/dist/index.js +10 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,32 @@ 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.23.0 — rotating a key
|
|
11
|
+
|
|
12
|
+
`keysRotate` (`POST /api-keys/{id}/rotate`) gives a key a new secret and
|
|
13
|
+
keeps its id, so its scope, its ceiling, its expiry and every key it minted
|
|
14
|
+
are unchanged and keep working. The old secret stops at once, or after
|
|
15
|
+
`grace_period_seconds` (at most 86400). The answer carries the new `token`,
|
|
16
|
+
once. Every key gains `rotated_at` and `previous_token_expires_at`. Additive.
|
|
17
|
+
|
|
18
|
+
## 1.22.0 — typed data, and the declared sender
|
|
19
|
+
|
|
20
|
+
Every send — `messagesSend`, `messagesReply`, `messagesReplyAll`,
|
|
21
|
+
`messagesForward`, and `draftsCreate` and `draftsUpdate` for a draft sent or
|
|
22
|
+
scheduled later — takes an optional `data: { schema, body }`: `schema` is an
|
|
23
|
+
http or https URL naming what `body` is, and `body` is up to 64 KB of JSON.
|
|
24
|
+
It travels as its own part beside the text, which ordinary mail clients do
|
|
25
|
+
not show, and comes back as `data` on the message, on a Pidgeon recipient's
|
|
26
|
+
copy and on any received mail that carries one. It is never mixed into
|
|
27
|
+
`text`, and the Firewall does not read it as prose.
|
|
28
|
+
|
|
29
|
+
Every message has `sender: { address, kind, on_behalf_of }`. A message sent
|
|
30
|
+
from Pidgeon declares `kind` (`person`, `agent` or `service`, from the
|
|
31
|
+
address's type) and `on_behalf_of` (the workspace's name, which only an owner
|
|
32
|
+
can change). Mail that arrived as ordinary email declared neither, and
|
|
33
|
+
says `origin: "smtp"`; `authentication` is what is known about it.
|
|
34
|
+
`message.sent` carries `sender` too. Additive; nothing narrows.
|
|
35
|
+
|
|
10
36
|
## 1.21.0 — every send takes a key, and receipts
|
|
11
37
|
|
|
12
38
|
`Idempotency-Key` is a declared header on every operation that honours it,
|
package/dist/index.cjs
CHANGED
|
@@ -85,6 +85,7 @@ __export(index_exports, {
|
|
|
85
85
|
keysGet: () => keysGet,
|
|
86
86
|
keysList: () => keysList,
|
|
87
87
|
keysRevoke: () => keysRevoke,
|
|
88
|
+
keysRotate: () => keysRotate,
|
|
88
89
|
keysUpdate: () => keysUpdate,
|
|
89
90
|
labelsCreate: () => labelsCreate,
|
|
90
91
|
labelsDelete: () => labelsDelete,
|
|
@@ -1383,6 +1384,15 @@ var keysUpdate = (options) => (options.client ?? client).patch({
|
|
|
1383
1384
|
...options.headers
|
|
1384
1385
|
}
|
|
1385
1386
|
});
|
|
1387
|
+
var keysRotate = (options) => (options.client ?? client).post({
|
|
1388
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
1389
|
+
url: "/api-keys/{id}/rotate",
|
|
1390
|
+
...options,
|
|
1391
|
+
headers: {
|
|
1392
|
+
"Content-Type": "application/json",
|
|
1393
|
+
...options.headers
|
|
1394
|
+
}
|
|
1395
|
+
});
|
|
1386
1396
|
var appPasswordsList = (options) => (options.client ?? client).get({
|
|
1387
1397
|
security: [{ scheme: "bearer", type: "http" }],
|
|
1388
1398
|
url: "/app-passwords",
|
|
@@ -1870,6 +1880,7 @@ function sleep(ms, signal) {
|
|
|
1870
1880
|
keysGet,
|
|
1871
1881
|
keysList,
|
|
1872
1882
|
keysRevoke,
|
|
1883
|
+
keysRotate,
|
|
1873
1884
|
keysUpdate,
|
|
1874
1885
|
labelsCreate,
|
|
1875
1886
|
labelsDelete,
|