@pidgeon-ai/sdk 0.1.0 → 1.0.0

package/CHANGELOG.md

@@ -9,6 +9,57 @@ method signatures, the error shape — not to the API behind it.
 
 ## Unreleased
 
+## 0.2.0 — the mailbox, and the credentials to reach it
+
+A minor rather than a patch, because one signature changed. In `0.x` semver
+that is what a minor is for, and the alternative — leaving the old shape
+beside the new one — would have shipped two ways to search that disagree
+about what the second argument is.
+
+**Breaking**
+
+- `messages.search(identityId, q, options)` is now
+  `messages.search(identityId, options)`, with `q` inside the options beside
+  six filters. Search takes more than words now, and a positional query in
+  front of an options bag would have been the only parameter in the client
+  that works that way.
+- `messages.update` no longer accepts `is_read` from an API key — the field
+  is still in the type, is still readable, and the API refuses to set it.
+  Read state belongs to a person and a key is not one; it used to return
+  `200` and change nothing, which is worse. Archive the conversation, or
+  track what you have seen with `mailboxes.changes`.
+
+**New resources**
+
+- `mailboxes` — `list`, `list_folder`, `changes`, `empty_trash`. The folders
+  with their counts, one folder by keyset cursor, what changed since a marker,
+  and emptying the trash.
+- `routing` — `list`, `create`, `update`, `delete`. Per-customer addresses,
+  delivered into an inbox you already have or into a webhook with no inbox
+  at all.
+- `keys` — `list`, `create`, `revoke`. A key can mint a narrower key, and
+  revoking one revokes everything it minted.
+- `appPasswords` — `list`, `create`, `revoke`. Working IMAP and SMTP
+  credentials for one address, which is how you hand a customer a mailbox
+  they can open in a mail client.
+- `workspace.get` — which account this key is for, and the plan that sets its
+  limits.
+
+**New on what was already there**
+
+- `domains` gained `create`, `get`, `verify` and `delete`. `create` returns
+  the records to publish alongside the domain, because showing them to your
+  own customer is the one thing every caller does next.
+- `webhooks` gained `update` (enable and disable), `deliveries` and `replay`.
+- `attachments.upload`, and `html` and `attachment_ids` on `messages.send`.
+- `messages.act`, `messages.undo`, `threads.update`.
+
+**New types** — `ApiKey`, `AppPassword`, `Delivery`, `DnsRecord`, `Mailbox`,
+`MailboxChange`, `Member`, `MessageActionName`, `MessageListItem`,
+`UploadedAttachment`, `Workspace`. `RoutingRule` gained `domain_id` and
+`destination_id`, and its `match_type` documentation said `exact`, which was
+never a value the API emits.
+
 ## 0.1.0
 
 First release.