@openemail/sdk 0.0.1 → 0.0.3

package/README.md

@@ -44,7 +44,7 @@
 
 ## Intro to the Npm Package
 
-The official TypeScript client for the OpenEmail API. One method per endpoint, 103 in all, typed end to end, with zero dependencies. It runs on Node 20+, Bun, Deno and Cloudflare Workers, and ships as ESM and CommonJS.
+The official TypeScript client for the OpenEmail API. A method for every one of the 178 endpoints, 259 in all once the paging and upload helpers are counted, typed end to end, with zero dependencies. It runs on Node 20+, Bun, Deno and Cloudflare Workers, and ships as ESM and CommonJS.
 
 It carries a workspace API key, so it belongs on a server. The one exception is disposable inboxes, which need no key and work in a browser.
 
@@ -101,7 +101,7 @@ for await (const thread of openemail.threads.iterate({ folder: 'inbox', query: '
 }
 ```
 
-Every paginated resource has `list` for one page, `listAll` for every page as one array, and `iterate` to stream items and stop whenever you like.
+Every paginated resource has `list` for one page, `listAll` for every page at once and `iterate` to stream items and stop whenever you like. `listAll` resolves to one array, apart from `addresses.listAll`, which resolves to the whole address book.
 
 ### Errors
 ```typescript
@@ -176,8 +176,8 @@ export const openemail = new OpenEmail({
 
 `createOpenEmail(options)` is the same constructor with one difference: anything you leave out is read from the environment. The shipped `openemail` takes the same options through `init(options)`, called once at startup.
 
-`baseUrl` also comes from `OPENEMAIL_BASE_URL`, for a server you run yourself. Reads are retried on 408, 429 and 5xx with backoff, honouring `Retry-After` up to a minute. Writes that cannot safely repeat are not. Every method takes `{ signal, apiKey }` as its last argument, so one process can serve several workspaces with one client.
+`baseUrl` also comes from `OPENEMAIL_BASE_URL`, for a server you run yourself. Reads are retried on 408 and 5xx with backoff. A 429 is retried only when it carries a `Retry-After`, and any wait longer than a minute throws instead of sleeping. Writes that cannot safely repeat are not retried. Every method outside `tempMail` takes `{ signal, apiKey }` as its last argument, so one process can serve several workspaces with one client. The `tempMail` methods take `{ signal, inboxToken }` instead.
 
 When a newer version is on npm the client says so once on a TTY. `OPENEMAIL_DISABLE_UPDATE_NOTICE=1` or `{ disableUpdateNotice: true }` turns that off.
 
-Everything else, templates, rules, tracking, calendar, roles, members, settings and the full reference for all 103 methods, lives in the [documentation](https://openemail.uk/docs/sdk).
+Everything else, templates, rules, tracking, calendar, contacts, audiences, broadcasts (`openemail.broadcasts`, which sends one personalised message to everybody in an audience), roles, members, settings, mailbox imports (`openemail.imports`, which brings a Google Takeout archive or an mbox across) and provider imports (`openemail.providerImports`, which moves a Resend account over), plus the full reference for every method, lives in the [documentation](https://openemail.uk/docs/sdk). What changed in each release is in the [changelog](https://openemail.uk/docs/sdk/changelog).