Skip to Content

Every release of the TypeScript SDK, newest first, and what it changed.

Every release of the TypeScript SDK, newest first.

Versions are semver for the methods: a method added is a minor version, a method renamed or removed a major one, a fix a patch. The API is still 0.x and may change a field without a deprecation cycle; the types follow it.

1.2.0

  • verifiedRecipients, a new namespace: add, list and remove an account's verified recipients, the outside addresses it may send to while it is not yet vetted, and getConfirmPage and confirmByToken, the public link their owner confirms one with.
  • accounts.getLimits: each of the account's limits, its threshold and how it is enforced.
  • accounts.getRequests: the account's API calls over time.
  • suppressions.list: your account's complaint entries, page by page.
  • accounts.listLimitIncidents pages, as the API now does: awaited, one page as before; with for await, every incident.
  • New options the API takes: ifNoneMatch on messages.getRaw, accountId on suppressions.get and suppressions.remove, submission on mta.checkRecipient, and memberOf on routes.list.
  • New fields in answers the SDK had: an account's verifiedRecipientsOnly; bytesIn and bytesOut in its and its domains' traffic; the address and domain creations in accounts.getSendUsage; an invitation's allDay; a suppression's accountId; and a limit incident's level and ledgerId.
  • A recipient refused because the account may send only to its verified recipients says so: source can be verified_recipients, and a scheduled send's results now carry source, list and pattern, as a send's do.

1.1.0

  • ownershipRecordOf(error), beside deliveryIdOf: the ownership record a domain not yet verified must publish, read from domains.create's 400 domain_not_verified as a typed DnsRecord, and null for any other error.

1.0.0

The first release. From here, a method's name is a promise (semver, above).

  • Every operation of the public REST API, 310 in 45 namespaces, as a typed method: new OpenEmail({ apiKey }), then openemail.<namespace>.<method>(...).
  • Listings: awaited, the first page; with for await, every item.
  • Safe retries: reads, and sends under one delivery id; any other write only when the API did nothing.
  • One error type, RequestError, with the API's code.
  • Webhooks: signatures verified, payloads typed.
  • Live channels that reconnect on their own, every frame typed.
  • No dependencies. Node 22.12 and later, Bun, Deno and Cloudflare Workers; live channels on Node and Bun.

On this page