@messagebird/sdk 0.1.1 → 0.2.1

package/dist/index.js

@@ -1237,6 +1237,22 @@ var createEmailMessage = (options) => (options.client ?? client).post({
     ...options.headers
   }
 });
+var createEmailMessageBatch = (options) => (options.client ?? client).post({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/email/batches",
+  ...options,
+  headers: {
+    "Content-Type": "application/json",
+    ...options.headers
+  }
+});
 var getEmailMessage = (options) => (options.client ?? client).get({
   security: [
     { scheme: "bearer", type: "http" },
@@ -1307,7 +1323,6 @@ var EmailResource = class extends Resource {
    * channel defaults may be omitted (per-send value wins).
    *
    * @example Send a message
-   * // bird:snippet:start email.send
    * const msg = await bird.email.send({
    *   from: { email: "onboarding@messagebird.dev", name: "Bird" },
    *   to: ["delivered@messagebird.dev"],
@@ -1315,7 +1330,6 @@ var EmailResource = class extends Resource {
    *   html: "<p>My first Bird email.</p>",
    * });
    * console.log(msg.id, msg.status); // "em_…", "accepted"
-   * // bird:snippet:end email.send
    *
    * @example A richer send — cc/bcc, reply-to, tags, metadata, click-tracking off, and an idempotency key (safe to retry; the server dedupes)
    * await bird.email.send(
@@ -1334,12 +1348,11 @@ var EmailResource = class extends Resource {
    * );
    *
    * @example Branch on the typed error hierarchy
-   * // bird:snippet:start email.errors
    * import { BirdRateLimitError, BirdValidationError, BirdAPIError } from "@messagebird/sdk";
    *
    * try {
    *   await bird.email.send({
-   *     from: "onboarding@messagebird.dev",
+   *     from: { email: "onboarding@messagebird.dev", name: "Bird" },
    *     to: ["delivered@messagebird.dev"],
    *     subject: "Hello from Bird",
    *     html: "<p>My first Bird email.</p>",
@@ -1350,13 +1363,11 @@ var EmailResource = class extends Resource {
    *   else if (err instanceof BirdAPIError) console.error(err.code, err.requestId);
    *   else throw err;
    * }
-   * // bird:snippet:end email.errors
    *
    * @example Errors as values with `.safe()`
-   * // bird:snippet:start email.safe
    * const { data, error } = await bird.email
    *   .send({
-   *     from: "onboarding@messagebird.dev",
+   *     from: { email: "onboarding@messagebird.dev", name: "Bird" },
    *     to: ["delivered@messagebird.dev"],
    *     subject: "Hello from Bird",
    *     html: "<p>My first Bird email.</p>",
@@ -1364,7 +1375,6 @@ var EmailResource = class extends Resource {
    *   .safe();
    * if (error) console.error(error.message);
    * else console.log(data.id);
-   * // bird:snippet:end email.safe
    */
   send(params, options) {
     const body = { ...this.#defaults, ...params };
@@ -1374,22 +1384,61 @@ var EmailResource = class extends Resource {
       ({ signal, headers }) => createEmailMessage({ client: this.client, body, headers, signal })
     );
   }
+  /**
+   * Send a batch of up to 100 independent email messages in one request. The
+   * batch is validated as a unit — if any item fails validation (unverified
+   * sender, all recipients suppressed, field-level errors) the whole batch is
+   * rejected with a `BirdValidationError` and nothing is queued. Resolves with
+   * one accepted item per submitted message, in submission order, once the batch
+   * is accepted (the API's 202). Channel defaults are applied per item.
+   *
+   * @example Send a batch of messages
+   * const batch = await bird.email.sendBatch([
+   *   {
+   *     from: { email: "onboarding@messagebird.dev", name: "Bird" },
+   *     to: ["alice@example.com"],
+   *     subject: "Your receipt",
+   *     html: "<p>Thanks, Alice.</p>",
+   *   },
+   *   {
+   *     from: { email: "onboarding@messagebird.dev", name: "Bird" },
+   *     to: ["bob@example.com"],
+   *     subject: "Your receipt",
+   *     html: "<p>Thanks, Bob.</p>",
+   *   },
+   * ]);
+   * for (const item of batch.data) console.log(item.id, item.status);
+   */
+  sendBatch(params, options) {
+    const body = params.map((item) => ({
+      ...this.#defaults,
+      ...item
+    }));
+    return this.call(
+      "POST",
+      options,
+      ({ signal, headers }) => createEmailMessageBatch({ client: this.client, body, headers, signal })
+    );
+  }
   /**
    * Fetch a message with aggregate delivery status.
    *
    * @example
-   * // bird:snippet:start email.get
    * const msg = await bird.email.get("em_abc123");
    * msg.status; // "accepted" | "processed" | "delivered" | "bounced" | …
    * msg.delivered_count;
    * msg.bounced_count;
-   * // bird:snippet:end email.get
    */
   get(messageId, options) {
     return this.call(
       "GET",
       options,
-      ({ signal, headers }) => getEmailMessage({ client: this.client, path: { message_id: messageId }, headers, signal })
+      ({ signal, headers }) => getEmailMessage({
+        client: this.client,
+        path: { message_id: messageId },
+        headers,
+        signal
+      })
     );
   }
   /**
@@ -1397,14 +1446,10 @@ var EmailResource = class extends Resource {
    * walks every message across all pages.
    *
    * @example Iterate every message, or take one page
-   * // bird:snippet:start email.list.paginate
-   * // bird:snippet:start email.list.iterate
    * for await (const message of bird.email.list({ status: "bounced" })) {
    *   console.log(message.id);
    * }
-   * // bird:snippet:end email.list.iterate
    * const page = await bird.email.list({ limit: 50 }); // page.data, page.next_cursor
-   * // bird:snippet:end email.list.paginate
    */
   list(query, options) {
     return this.paginated(
@@ -1437,6 +1482,11 @@ var WebhooksResource = class {
    * types are returned as-is (handle them in a `default` case) so a newer server
    * event can't break an older SDK.
    *
+   * @example One call verifies the signature and returns the typed event
+   * // Pass the RAW request body; set the secret via new BirdClient({ webhooks: { secret } }).
+   * const event = bird.webhooks.unwrap(rawBody, headers);
+   * console.log(event.type); // discriminated union — narrow on event.type
+   *
    * @example Verify and dispatch — pass the raw request body, never the parsed JSON
    * // new BirdClient({ apiKey, webhooks: { secret } })
    * try {
@@ -1527,7 +1577,12 @@ var BirdClient = class {
     this.#headers = {
       ...opts.defaultHeaders,
       Authorization: `Bearer ${opts.apiKey}`,
-      "User-Agent": `bird-sdk-js/${"0.1.1"}`
+      "User-Agent": `bird-sdk-js/${"0.2.1"}`,
+      // X-Bird-* client-identity headers (ADR-0067): the API attributes the SDK
+      // surface from these, not the User-Agent. Edge-safe, so no os/arch/runtime
+      // (those need Node globals this SDK must not touch); surface + version only.
+      "X-Bird-Surface": "sdk-js",
+      "X-Bird-Version": "0.2.1"
     };
     this.#client = createClient(
       createConfig({
@@ -1603,6 +1658,33 @@ var BirdClient = class {
   }
 };
 
-export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, baseUrlForRegion, regionFromApiKey };
+// src/event-types.gen.ts
+var WebhookEventType = {
+  DomainFailed: "domain.failed",
+  DomainVerified: "domain.verified",
+  EmailAccepted: "email.accepted",
+  EmailBounced: "email.bounced",
+  EmailClicked: "email.clicked",
+  EmailComplained: "email.complained",
+  EmailDeferred: "email.deferred",
+  EmailDelivered: "email.delivered",
+  EmailListUnsubscribed: "email.list_unsubscribed",
+  EmailOpened: "email.opened",
+  EmailOutOfBandBounce: "email.out_of_band_bounce",
+  EmailProcessed: "email.processed",
+  EmailReceived: "email.received",
+  EmailRejected: "email.rejected",
+  EmailSuppressionCreated: "email_suppression.created",
+  EmailUnsubscribed: "email.unsubscribed",
+  SmsAccepted: "sms.accepted",
+  SmsDelivered: "sms.delivered",
+  SmsExpired: "sms.expired",
+  SmsFailed: "sms.failed",
+  SmsRejected: "sms.rejected",
+  SmsSent: "sms.sent",
+  SmsUndelivered: "sms.undelivered"
+};
+
+export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, WebhookEventType, baseUrlForRegion, regionFromApiKey };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map