shipmail 0.4.12 → 0.4.13

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 ShipMail
+Copyright (c) 2025 Shipmail
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -53,9 +53,9 @@ pnpm add shipmail
 ## Quick start
 
 ```ts
-import { ShipMailClient } from "shipmail";
+import { ShipmailClient } from "shipmail";
 
-const shipmail = new ShipMailClient({ apiKey: process.env.SHIPMAIL_API_KEY! });
+const shipmail = new ShipmailClient({ apiKey: process.env.SHIPMAIL_API_KEY! });
 
 const message = await shipmail.messages.send({
   mailbox_id: "mbx_...",
@@ -76,13 +76,13 @@ The SDK does not auto-read environment variables. Pass the key explicitly.
 You can also pass a key string directly:
 
 ```ts
-const shipmail = new ShipMailClient("sm_live_...");
+const shipmail = new ShipmailClient("sm_live_...");
 ```
 
 ## Configuration
 
 ```ts
-const shipmail = new ShipMailClient({
+const shipmail = new ShipmailClient({
   apiKey: process.env.SHIPMAIL_API_KEY!,
   baseUrl: "https://shipmail.to/api/v1",
   maxRetries: 2,
@@ -271,7 +271,7 @@ await shipmail.scheduledMessages.cancel(scheduled.id);
 Staged IDs expire after 24 hours and are bound to the API key, organization, mailbox, and file
 metadata that created them.
 
-For browser-hosted components that must keep the ShipMail API key off the page, prepare a
+For browser-hosted components that must keep the Shipmail API key off the page, prepare a
 five-minute, single-use upload URL:
 
 ```ts
@@ -299,7 +299,7 @@ request. The returned upload URL is a secret and cannot be replayed after a succ
 Create a test API key (`sm_test_...`) to simulate email without contacting real recipients. Test messages, threads, Assistant automations, webhooks, quota, suppressions, and reputation are isolated from live mode.
 
 ```ts
-const testClient = new ShipMailClient("sm_test_...");
+const testClient = new ShipmailClient("sm_test_...");
 
 await testClient.messages.send({
   mailbox_id: "mbx_...",
@@ -506,7 +506,7 @@ const child = await shipmail.partner.createOrganization(
   { idempotencyKey: "operator-123" },
 );
 
-const delegated = new ShipMailClient({
+const delegated = new ShipmailClient({
   apiKey: process.env.SHIPMAIL_API_KEY!,
   organizationId: child.organization_id,
 });
@@ -668,7 +668,7 @@ await shipmail.messages.send(params, { signal: controller.signal });
 Inject a custom fetch implementation for proxies, observability, or testing:
 
 ```ts
-const shipmail = new ShipMailClient({
+const shipmail = new ShipmailClient({
   apiKey: process.env.SHIPMAIL_API_KEY!,
   fetch: async (url, init) => {
     const start = Date.now();
@@ -683,11 +683,11 @@ The custom fetch receives the same arguments as the global `fetch` and must retu
 
 ## Errors
 
-The SDK throws typed errors that map to HTTP responses. All inherit from `ShipMailError`:
+The SDK throws typed errors that map to HTTP responses. All inherit from `ShipmailError`:
 
 ```ts
 import {
-  ShipMailError,
+  ShipmailError,
   AuthenticationError,
   AuthorizationError,
   ValidationError,
@@ -709,7 +709,7 @@ try {
   if (err instanceof RateLimitError) {
     err.retryAfter; // seconds
   }
-  if (err instanceof ShipMailError) {
+  if (err instanceof ShipmailError) {
     err.status; // HTTP status
     err.type; // error type string
     err.requestId; // include this when contacting support
@@ -736,7 +736,7 @@ try {
 The SDK retries on `5xx`, `429`, and connection errors with exponential backoff and jitter. `Retry-After` is honored when present. Default is 2 retries (3 total attempts).
 
 ```ts
-new ShipMailClient({ apiKey, maxRetries: 0 }); // disable retries
+new ShipmailClient({ apiKey, maxRetries: 0 }); // disable retries
 ```
 
 Retries respect any `AbortSignal` you pass via `MethodOptions.signal`.
@@ -750,7 +750,7 @@ The package ships ESM and CommonJS via `exports`, with `"sideEffects": false` fo
 Mock by injecting a custom `fetch` at construction time:
 
 ```ts
-const shipmail = new ShipMailClient({
+const shipmail = new ShipmailClient({
   apiKey: "sm_live_test",
   fetch: async () =>
     new Response(JSON.stringify({ id: "msg_123", status: "queued" }), {

package/dist/index.cjs

@@ -85,29 +85,29 @@ function apiKeyScopesGrant(grantedScopes, requiredScope) {
 }
 
 // src/errors.ts
-var ShipMailError = class extends Error {
+var ShipmailError = class extends Error {
   constructor(message, options) {
     super(message);
-    this.name = "ShipMailError";
+    this.name = "ShipmailError";
     this.status = options?.status;
     this.type = options?.type;
     this.requestId = options?.requestId;
     this.retryable = options?.retryable ?? false;
   }
 };
-var AuthenticationError = class extends ShipMailError {
+var AuthenticationError = class extends ShipmailError {
   constructor(message, requestId) {
     super(message, { status: 401, type: "authentication_error", requestId, retryable: false });
     this.name = "AuthenticationError";
   }
 };
-var AuthorizationError = class extends ShipMailError {
+var AuthorizationError = class extends ShipmailError {
   constructor(message, requestId) {
     super(message, { status: 403, type: "authorization_error", requestId, retryable: false });
     this.name = "AuthorizationError";
   }
 };
-var ValidationError = class extends ShipMailError {
+var ValidationError = class extends ShipmailError {
   constructor(message, options) {
     super(message, {
       status: 422,
@@ -119,19 +119,19 @@ var ValidationError = class extends ShipMailError {
     this.details = options?.details;
   }
 };
-var QuotaExceededError = class extends ShipMailError {
+var QuotaExceededError = class extends ShipmailError {
   constructor(message, requestId) {
     super(message, { status: 403, type: "quota_exceeded", requestId, retryable: false });
     this.name = "QuotaExceededError";
   }
 };
-var NotFoundError = class extends ShipMailError {
+var NotFoundError = class extends ShipmailError {
   constructor(message, requestId) {
     super(message, { status: 404, type: "not_found", requestId, retryable: false });
     this.name = "NotFoundError";
   }
 };
-var RateLimitError = class extends ShipMailError {
+var RateLimitError = class extends ShipmailError {
   constructor(message, options) {
     super(message, {
       status: 429,
@@ -143,25 +143,25 @@ var RateLimitError = class extends ShipMailError {
     this.retryAfter = options?.retryAfter;
   }
 };
-var ConflictError = class extends ShipMailError {
+var ConflictError = class extends ShipmailError {
   constructor(message, requestId) {
     super(message, { status: 409, type: "conflict", requestId, retryable: false });
     this.name = "ConflictError";
   }
 };
-var InternalServerError = class extends ShipMailError {
+var InternalServerError = class extends ShipmailError {
   constructor(message, requestId) {
     super(message, { status: 500, type: "internal_error", requestId, retryable: true });
     this.name = "InternalServerError";
   }
 };
-var ConnectionError = class extends ShipMailError {
+var ConnectionError = class extends ShipmailError {
   constructor(message) {
     super(message, { retryable: true });
     this.name = "ConnectionError";
   }
 };
-var WebhookVerificationError = class extends ShipMailError {
+var WebhookVerificationError = class extends ShipmailError {
   constructor(message) {
     super(message, { retryable: false });
     this.name = "WebhookVerificationError";
@@ -188,7 +188,7 @@ function mapErrorFromResponse(status, body, requestId) {
     case "internal_error":
       return new InternalServerError(error.message, rid);
     default:
-      return new ShipMailError(error.message, {
+      return new ShipmailError(error.message, {
         status,
         type: error.type,
         requestId: rid,
@@ -1568,7 +1568,7 @@ var Webhooks = class extends ApiResource {
 };
 
 // src/version.ts
-var VERSION = "0.4.12";
+var VERSION = "0.4.13";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -1598,9 +1598,9 @@ function rawBodyToBlobPart(rawBody) {
   new Uint8Array(buffer).set(rawBody);
   return buffer;
 }
-var ShipMailClient = class {
+var ShipmailClient = class {
   /**
-   * Create a new ShipMail client.
+   * Create a new Shipmail client.
    * @param config - API key string or full configuration object.
    */
   constructor(config) {
@@ -1674,7 +1674,7 @@ var ShipMailClient = class {
         }
         const targetOrganizationId = methodOpts?.organizationId ?? this.organizationId;
         if (targetOrganizationId) {
-          headers["X-ShipMail-Organization-Id"] = targetOrganizationId;
+          headers["X-Shipmail-Organization-Id"] = targetOrganizationId;
         }
         let body = null;
         if (options.rawBody !== void 0) {
@@ -1708,7 +1708,7 @@ var ShipMailClient = class {
       if (isApiErrorBody(errorBody)) {
         lastError = mapErrorFromResponse(response.status, errorBody);
       } else {
-        lastError = new ShipMailError(`Request failed with status ${response.status}`, {
+        lastError = new ShipmailError(`Request failed with status ${response.status}`, {
           status: response.status,
           retryable: isRetryableStatus(response.status)
         });
@@ -1717,7 +1717,7 @@ var ShipMailClient = class {
         throw lastError;
       }
     }
-    throw lastError ?? new ShipMailError("Request failed after retries");
+    throw lastError ?? new ShipmailError("Request failed after retries");
   }
   buildUrl(path2, query) {
     const url = new URL(`${this.baseUrl}${path2}`);
@@ -1792,14 +1792,14 @@ async function verifyWebhook(body, headers, secret, options) {
   const signature = getHeader(headers, "x-shipmail-signature");
   const timestampStr = getHeader(headers, "x-shipmail-timestamp");
   if (!signature) {
-    throw new WebhookVerificationError("Missing X-ShipMail-Signature header");
+    throw new WebhookVerificationError("Missing X-Shipmail-Signature header");
   }
   if (!timestampStr) {
-    throw new WebhookVerificationError("Missing X-ShipMail-Timestamp header");
+    throw new WebhookVerificationError("Missing X-Shipmail-Timestamp header");
   }
   const timestamp = parseInt(timestampStr, 10);
   if (isNaN(timestamp)) {
-    throw new WebhookVerificationError("Invalid X-ShipMail-Timestamp header");
+    throw new WebhookVerificationError("Invalid X-Shipmail-Timestamp header");
   }
   const tolerance = options?.toleranceInSeconds ?? DEFAULT_TOLERANCE_SECONDS;
   const now = Math.floor(Date.now() / 1e3);
@@ -1837,15 +1837,15 @@ exports.NotFoundError = NotFoundError;
 exports.Page = Page;
 exports.QuotaExceededError = QuotaExceededError;
 exports.RateLimitError = RateLimitError;
-exports.ShipMailClient = ShipMailClient;
-exports.ShipMailError = ShipMailError;
+exports.ShipmailClient = ShipmailClient;
+exports.ShipmailError = ShipmailError;
 exports.ValidationError = ValidationError;
 exports.WEBHOOK_DELIVERY_EVENT_TYPES = WEBHOOK_DELIVERY_EVENT_TYPES;
 exports.WEBHOOK_DELIVERY_STATUSES = WEBHOOK_DELIVERY_STATUSES;
 exports.WEBHOOK_EVENT_TYPES = WEBHOOK_EVENT_TYPES;
 exports.WebhookVerificationError = WebhookVerificationError;
 exports.apiKeyScopesGrant = apiKeyScopesGrant;
-exports.default = ShipMailClient;
+exports.default = ShipmailClient;
 exports.isApiKeyScope = isApiKeyScope;
 exports.verifyWebhook = verifyWebhook;
 //# sourceMappingURL=index.cjs.map