retransmit.dev 0.1.1 → 0.1.2

package/README.md

@@ -1,6 +1,12 @@
 # retransmit.dev
 
-Node.js SDK for the [Retransmit](https://retransmit.dev) email API. Zero dependencies, works on Node 18+ and edge runtimes with `fetch`.
+Node.js SDK for the [Retransmit](https://retransmit.dev) messaging API. Send email and SMS through one typed client; WhatsApp support is coming soon. Zero dependencies, works on Node 18+ and edge runtimes with `fetch`.
+
+| Channel | SDK namespace | Availability |
+| --- | --- | --- |
+| Email | `retransmit.emails` | Available |
+| SMS | `retransmit.sms` | Available |
+| WhatsApp | `retransmit.whatsapp` | Coming soon; not included in the current release |
 
 ## Install
 
@@ -10,7 +16,7 @@ npm install retransmit.dev
 pnpm add retransmit.dev
 ```
 
-## Usage
+## Create a client
 
 Grab an API key from your Retransmit dashboard, then:
 
@@ -19,7 +25,11 @@ import { Retransmit } from "retransmit.dev";
 
 const retransmit = new Retransmit("rt_xxxxxxxxxxxx");
 // or set RETRANSMIT_API_KEY and call `new Retransmit()`
+```
 
+## Email
+
+```ts
 const { data, error } = await retransmit.emails.send({
   from: "Acme <hello@yourdomain.com>",
   to: "user@example.com",
@@ -41,7 +51,33 @@ const { data } = await retransmit.emails.get("em_xxxxxxxxxxxx");
 console.log(data?.status); // "delivered"
 ```
 
-### Batches
+## SMS
+
+Use international E.164 phone numbers. A single request can contain up to 50
+recipients, all in the same country.
+
+```ts
+const { data, error } = await retransmit.sms.send({
+  from: "Acme",
+  to: "+237670000000",
+  text: "Your verification code is 482913",
+});
+
+if (error) {
+  console.error(error.code, error.message);
+} else {
+  console.log(data.id, data.country, data.segments);
+}
+```
+
+SMS messages are also asynchronous:
+
+```ts
+const { data } = await retransmit.sms.get("sms_xxxxxxxxxxxx");
+console.log(data?.status); // "sent" | "delivered" | "undelivered" | ...
+```
+
+## Email batches
 
 Send up to 10,000 emails in one request:
 
@@ -55,14 +91,21 @@ const { data: progress } = await retransmit.batch.get(batch!.id);
 console.log(progress?.processed, "/", progress?.total, progress?.counts);
 ```
 
+## WhatsApp
+
+WhatsApp is the next planned channel. The intended SDK namespace is
+`retransmit.whatsapp`, but it is deliberately not exported yet because the
+production endpoint and request types are still being finalized. This keeps
+the current SDK honest while reserving a consistent channel-based API shape.
+
 ## Error handling
 
 Methods never throw on API errors — they return `{ data, error }`:
 
 ```ts
-const { data, error } = await retransmit.emails.send(/* ... */);
+const { data, error } = await retransmit.sms.send(/* ... */);
 if (error) {
-  // error.code: "validation_error" | "domain_not_verified" | "unauthorized" | ...
+  // error.code: "validation_error" | "no_route" | "unauthorized" | ...
 }
 ```
 

package/package.json

@@ -1,17 +1,20 @@
 {
   "name": "retransmit.dev",
-  "version": "0.1.1",
-  "description": "Node.js SDK for the Retransmit email API",
+  "version": "0.1.2",
+  "description": "Node.js SDK for the Retransmit email and SMS APIs",
   "keywords": [
     "email",
+    "sms",
+    "messaging-api",
     "retransmit",
     "ses",
-    "transactional-email"
+    "transactional-email",
+    "transactional-sms"
   ],
   "homepage": "https://docs.retransmit.dev",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/jpainam/retransmit.git",
+    "url": "git+https://github.com/retransmit-dev/retransmit.git",
     "directory": "packages/sdk"
   },
   "license": "MIT",