shipmail 0.1.0 → 0.1.19

package/README.md

@@ -1,6 +1,6 @@
 # ShipMail TypeScript SDK
 
-Official TypeScript SDK for the [ShipMail](https://shipmail.to) API. Zero runtime dependencies.
+Official TypeScript SDK for the [ShipMail](https://shipmail.to) API. Zero runtime dependencies. Works with Node.js 18+, Bun, and Deno.
 
 ## Installation
 
@@ -38,9 +38,9 @@ import { ShipMailClient } from "shipmail";
 
 const client = new ShipMailClient({
   apiKey: "sm_live_...",
-  baseUrl: "https://api.shipmail.to/v1", // default
-  maxRetries: 2,                          // default, retries on 5xx and 429
-  timeout: 30_000,                        // default, in milliseconds
+  baseUrl: "https://shipmail.to/api/v1", // default
+  maxRetries: 2, // default, retries on 5xx and 429
+  timeout: 30_000, // default, in milliseconds
 });
 ```
 
@@ -69,10 +69,6 @@ const mailboxes = await client.mailboxes.list({ domain_id: "dom_..." });
 const mailbox = await client.mailboxes.get("mbx_...");
 const updated = await client.mailboxes.update("mbx_...", { display_name: "New Name" });
 await client.mailboxes.delete("mbx_...");
-
-// Avatar
-const avatar = await client.mailboxes.uploadAvatar("mbx_...", imageBuffer, "image/png");
-await client.mailboxes.deleteAvatar("mbx_...");
 ```
 
 ### Messages
@@ -133,8 +129,8 @@ List methods return a paginated response with cursor-based pagination:
 
 ```typescript
 const page = await client.domains.list({ limit: 10 });
-console.log(page.data);           // Domain[]
-console.log(page.pagination);     // { next_cursor, has_more }
+console.log(page.data); // Domain[]
+console.log(page.pagination); // { next_cursor, has_more }
 
 // Fetch next page
 if (page.pagination.has_more) {
@@ -161,7 +157,7 @@ Verify incoming webhook signatures without instantiating a client:
 import { verifyWebhook, WebhookVerificationError } from "shipmail";
 
 try {
-  const event = verifyWebhook(rawBody, request.headers, webhookSecret);
+  const event = await verifyWebhook(rawBody, request.headers, webhookSecret);
   console.log(event.event_type); // e.g., "message.received"
   console.log(event.data);
 } catch (err) {
@@ -192,15 +188,15 @@ try {
   await client.domains.create({ name: "" });
 } catch (err) {
   if (err instanceof ValidationError) {
-    console.log(err.message);  // Error message
-    console.log(err.details);  // Field-level validation errors
+    console.log(err.message); // Error message
+    console.log(err.details); // Field-level validation errors
   }
   if (err instanceof RateLimitError) {
     console.log(err.retryAfter); // Seconds to wait
   }
   if (err instanceof ShipMailError) {
-    console.log(err.status);    // HTTP status code
-    console.log(err.type);      // Error type string
+    console.log(err.status); // HTTP status code
+    console.log(err.type); // Error type string
     console.log(err.requestId); // Request ID for support
     console.log(err.retryable); // Whether the request can be retried
   }