@messagebird/sdk 0.2.1 → 0.3.0

package/dist/index.js

@@ -468,11 +468,8 @@ var checkForExistence = (options, name) => {
   }
   return false;
 };
-var setAuthParams = async ({
-  security,
-  ...options
-}) => {
-  for (const auth of security) {
+async function setAuthParams(options) {
+  for (const auth of options.security ?? []) {
     if (checkForExistence(options, auth.name)) {
       continue;
     }
@@ -497,7 +494,7 @@ var setAuthParams = async ({
         break;
     }
   }
-};
+}
 var buildUrl = (options) => getUrl({
   baseUrl: options.baseUrl,
   path: options.path,
@@ -623,10 +620,7 @@ var createClient = (config = {}) => {
       serializedBody: void 0
     };
     if (opts.security) {
-      await setAuthParams({
-        ...opts,
-        security: opts.security
-      });
+      await setAuthParams(opts);
     }
     if (opts.requestValidator) {
       await opts.requestValidator(opts);
@@ -859,6 +853,8 @@ var BirdAPIError = class extends BirdError {
   requestId;
   param;
   vendorCode;
+  remediation;
+  next;
   constructor(fields) {
     super(fields.message);
     this.name = "BirdAPIError";
@@ -870,6 +866,8 @@ var BirdAPIError = class extends BirdError {
     this.requestId = fields.requestId;
     this.param = fields.param;
     this.vendorCode = fields.vendorCode;
+    this.remediation = fields.remediation;
+    this.next = fields.next;
     Object.setPrototypeOf(this, new.target.prototype);
   }
 };
@@ -1027,7 +1025,10 @@ function mapResponseToError(status, body, headers) {
     docUrl: b.doc_url ?? "",
     requestId: b.request_id ?? headers?.get("X-Request-Id") ?? "",
     param: b.param,
-    vendorCode: b.vendor_code
+    vendorCode: b.vendor_code,
+    remediation: b.remediation,
+    next: b.next ?? []
+    // normalize a null/absent wire `next` to [] so callers can always iterate
   };
   switch (fields.type) {
     case "auth_error":
@@ -1265,6 +1266,190 @@ var getEmailMessage = (options) => (options.client ?? client).get({
   url: "/v1/email/messages/{message_id}",
   ...options
 });
+var listSmsMessages = (options) => (options?.client ?? client).get({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/sms/messages",
+  ...options
+});
+var createSmsMessage = (options) => (options.client ?? client).post({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/sms/messages",
+  ...options,
+  headers: {
+    "Content-Type": "application/json",
+    ...options.headers
+  }
+});
+var createSmsMessageBatch = (options) => (options.client ?? client).post({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/sms/batches",
+  ...options,
+  headers: {
+    "Content-Type": "application/json",
+    ...options.headers
+  }
+});
+var getSmsMessage = (options) => (options.client ?? client).get({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/sms/messages/{message_id}",
+  ...options
+});
+var listSmsTemplates = (options) => (options?.client ?? client).get({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/sms/templates",
+  ...options
+});
+var getSmsTemplate = (options) => (options.client ?? client).get({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/sms/templates/{template_ref}",
+  ...options
+});
+var listEmailTemplates = (options) => (options?.client ?? client).get({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/email/templates",
+  ...options
+});
+var createEmailTemplate = (options) => (options.client ?? client).post({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/email/templates",
+  ...options,
+  headers: {
+    "Content-Type": "application/json",
+    ...options.headers
+  }
+});
+var deleteEmailTemplate = (options) => (options.client ?? client).delete({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/email/templates/{template_id}",
+  ...options
+});
+var getEmailTemplate = (options) => (options.client ?? client).get({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/email/templates/{template_id}",
+  ...options
+});
+var updateEmailTemplate = (options) => (options.client ?? client).patch({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/email/templates/{template_id}",
+  ...options,
+  headers: {
+    "Content-Type": "application/json",
+    ...options.headers
+  }
+});
+var listEmailTemplateVersions = (options) => (options.client ?? client).get({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/email/templates/{template_id}/versions",
+  ...options
+});
+var getEmailTemplateVersion = (options) => (options.client ?? client).get({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/email/templates/{template_id}/versions/{version_id}",
+  ...options
+});
+var publishEmailTemplate = (options) => (options.client ?? client).post({
+  security: [
+    { scheme: "bearer", type: "http" },
+    {
+      in: "cookie",
+      name: "bird_session",
+      type: "apiKey"
+    }
+  ],
+  url: "/v1/email/templates/{template_id}/publish",
+  ...options
+});
 
 // src/resources/base.ts
 var Resource = class {
@@ -1464,6 +1649,331 @@ var EmailResource = class extends Resource {
     );
   }
 };
+
+// src/resources/emailTemplates.ts
+var EmailTemplatesResource = class extends Resource {
+  /**
+   * Create a template and its initial editable draft. Pick the authoring format
+   * with `source` (`liquid`, `handlebars`, or `html`); the name must be unique
+   * in the workspace or the call throws a `BirdConflictError`.
+   *
+   * @example Create a template
+   * const tpl = await bird.emailTemplates.create({
+   *   name: "Welcome",
+   *   category: "transactional",
+   *   source: "handlebars",
+   *   subject: "Welcome, {{ first_name }}!",
+   *   html: "<h1>Hi {{ first_name }}</h1>",
+   * });
+   * console.log(tpl.id, tpl.revision); // "emt_…", 0
+   */
+  create(params, options) {
+    return this.call(
+      "POST",
+      options,
+      ({ signal, headers }) => createEmailTemplate({
+        client: this.client,
+        body: params,
+        headers,
+        signal
+      })
+    );
+  }
+  /**
+   * List the workspace's templates, newest first. `await` resolves the first
+   * page; `for await` walks every template across all pages. Filter by
+   * `category`, `source`, or a case-insensitive `name` prefix.
+   *
+   * @example Iterate every template, or take one page
+   * for await (const tpl of bird.emailTemplates.list({ category: "transactional" })) {
+   *   console.log(tpl.id, tpl.name);
+   * }
+   * const page = await bird.emailTemplates.list({ limit: 50 }); // page.data, page.next_cursor
+   */
+  list(query, options) {
+    return this.paginated(
+      "GET",
+      options,
+      ({ signal, headers }, cursor) => listEmailTemplates({
+        client: this.client,
+        query: { ...query, starting_after: cursor ?? query?.starting_after },
+        headers,
+        signal
+      })
+    );
+  }
+  /**
+   * Fetch a template with its current draft content (subject, HTML, text), the
+   * draft `revision`, and its draft/published version ids.
+   *
+   * @example
+   * const tpl = await bird.emailTemplates.get("emt_abc123");
+   * tpl.subject;
+   * tpl.published_version_id; // null until first publish
+   */
+  get(templateId, options) {
+    return this.call(
+      "GET",
+      options,
+      ({ signal, headers }) => getEmailTemplate({
+        client: this.client,
+        path: { template_id: templateId },
+        headers,
+        signal
+      })
+    );
+  }
+  /**
+   * Update a template's metadata and draft content. Only the fields you send
+   * change. Pass the draft `revision` you last read; if another edit landed
+   * first the call throws a `BirdConflictError` — reload and retry.
+   *
+   * @example Edit the draft, guarded by the revision you read
+   * const tpl = await bird.emailTemplates.get("emt_abc123");
+   * const updated = await bird.emailTemplates.update("emt_abc123", {
+   *   revision: tpl.revision,
+   *   subject: "Welcome aboard, {{ first_name }}!",
+   * });
+   */
+  update(templateId, params, options) {
+    return this.call(
+      "PATCH",
+      options,
+      ({ signal, headers }) => updateEmailTemplate({
+        client: this.client,
+        path: { template_id: templateId },
+        body: params,
+        headers,
+        signal
+      })
+    );
+  }
+  /**
+   * Delete a template and all its versions. The name becomes available for
+   * reuse in the workspace.
+   *
+   * @example
+   * await bird.emailTemplates.delete("emt_abc123");
+   */
+  delete(templateId, options) {
+    return this.call(
+      "DELETE",
+      options,
+      ({ signal, headers }) => deleteEmailTemplate({
+        client: this.client,
+        path: { template_id: templateId },
+        headers,
+        signal
+      })
+    );
+  }
+  /**
+   * Publish the current draft as a new immutable, numbered version and make it
+   * the live version used by sends. The draft stays editable. The draft must
+   * have a subject and a body, or the call throws.
+   *
+   * @example Publish, then send by template
+   * const version = await bird.emailTemplates.publish("emt_abc123");
+   * console.log(version.version_number); // 1, 2, 3…
+   * await bird.email.send({
+   *   from: "hello@acme.com",
+   *   to: ["alice@example.com"],
+   *   template: { id: "emt_abc123", parameters: { first_name: "Alice" } },
+   * });
+   */
+  publish(templateId, options) {
+    return this.call(
+      "POST",
+      options,
+      ({ signal, headers }) => publishEmailTemplate({
+        client: this.client,
+        path: { template_id: templateId },
+        headers,
+        signal
+      })
+    );
+  }
+  /**
+   * List every version of a template — the current draft plus all published
+   * versions — newest first. Returns the full set in one response (`.data`);
+   * this list is not paginated.
+   *
+   * @example
+   * const { data } = await bird.emailTemplates.listVersions("emt_abc123");
+   * for (const v of data) console.log(v.version_number, v.status);
+   */
+  listVersions(templateId, options) {
+    return this.call(
+      "GET",
+      options,
+      ({ signal, headers }) => listEmailTemplateVersions({
+        client: this.client,
+        path: { template_id: templateId },
+        headers,
+        signal
+      })
+    );
+  }
+  /**
+   * Fetch a single version of a template.
+   *
+   * @example
+   * const version = await bird.emailTemplates.getVersion("emt_abc123", "emv_def456");
+   * version.status; // "draft" | "published"
+   */
+  getVersion(templateId, versionId, options) {
+    return this.call(
+      "GET",
+      options,
+      ({ signal, headers }) => getEmailTemplateVersion({
+        client: this.client,
+        path: { template_id: templateId, version_id: versionId },
+        headers,
+        signal
+      })
+    );
+  }
+};
+
+// src/resources/sms.ts
+var SmsResource = class extends Resource {
+  /**
+   * Send one SMS to a single recipient. Supply either `text` (with a `category`)
+   * or a stored `template` (by `id` or `alias`, with its `parameters`). The
+   * result is `accepted`, not yet delivered — read it back with `get` to confirm.
+   *
+   * @example Send free text
+   * const msg = await bird.sms.send({
+   *   to: "+15551234567",
+   *   text: "Your verification code is 123456.",
+   *   category: "authentication",
+   * });
+   * console.log(msg.id, msg.status);
+   *
+   * @example Send by template
+   * await bird.sms.send({
+   *   to: "+15551234567",
+   *   template: { alias: "bird_otp_verification", parameters: { code: "123456" } },
+   * });
+   */
+  send(params, options) {
+    return this.call(
+      "POST",
+      options,
+      ({ signal, headers }) => createSmsMessage({ client: this.client, body: params, headers, signal })
+    );
+  }
+  /**
+   * Send up to 100 independent SMS messages in one call. Each item is a full send
+   * (free text or template); all items are validated before any are queued.
+   *
+   * @example
+   * const result = await bird.sms.sendBatch([
+   *   { to: "+15551111111", text: "Hi Alice!", category: "marketing" },
+   *   { to: "+15552222222", text: "Hi Bob!", category: "marketing" },
+   * ]);
+   */
+  sendBatch(params, options) {
+    return this.call(
+      "POST",
+      options,
+      ({ signal, headers }) => createSmsMessageBatch({
+        client: this.client,
+        body: params,
+        headers,
+        signal
+      })
+    );
+  }
+  /**
+   * Fetch a single SMS message: its current delivery status, segment breakdown,
+   * cost, and failure detail if it failed.
+   *
+   * @example
+   * const msg = await bird.sms.get("sms_abc123");
+   * msg.status; // "accepted" | "delivered" | …
+   */
+  get(messageId, options) {
+    return this.call(
+      "GET",
+      options,
+      ({ signal, headers }) => getSmsMessage({
+        client: this.client,
+        path: { message_id: messageId },
+        headers,
+        signal
+      })
+    );
+  }
+  /**
+   * List SMS messages, newest first. `await` resolves the first page; `for await`
+   * walks every message across all pages. Filter by direction, status, category,
+   * recipient, sender, or tag.
+   *
+   * @example
+   * for await (const msg of bird.sms.list({ direction: "outbound" })) {
+   *   console.log(msg.id, msg.status);
+   * }
+   */
+  list(query, options) {
+    return this.paginated(
+      "GET",
+      options,
+      ({ signal, headers }, cursor) => listSmsMessages({
+        client: this.client,
+        query: { ...query, starting_after: cursor ?? query?.starting_after },
+        headers,
+        signal
+      })
+    );
+  }
+};
+
+// src/resources/smsTemplates.ts
+var SmsTemplatesResource = class extends Resource {
+  /**
+   * List the SMS templates available to the workspace — Bird's built-in
+   * templates plus any the workspace authored. The catalogue is small and
+   * returned in full (`.data`); this list is not paginated. Filter by `scope`,
+   * `category`, or `locale` (a BCP-47 language tag).
+   *
+   * @example List the built-in templates
+   * const { data } = await bird.smsTemplates.list({ scope: "system" });
+   * for (const tpl of data) console.log(tpl.id, tpl.name);
+   */
+  list(query, options) {
+    return this.call(
+      "GET",
+      options,
+      ({ signal, headers }) => listSmsTemplates({
+        client: this.client,
+        query,
+        headers,
+        signal
+      })
+    );
+  }
+  /**
+   * Fetch a single SMS template by its alias or id, including its body and the
+   * variables it expects.
+   *
+   * @example
+   * const tpl = await bird.smsTemplates.get("bird_otp_verification");
+   * console.log(tpl.body, tpl.variables);
+   */
+  get(templateRef, options) {
+    return this.call(
+      "GET",
+      options,
+      ({ signal, headers }) => getSmsTemplate({
+        client: this.client,
+        path: { template_ref: templateRef },
+        headers,
+        signal
+      })
+    );
+  }
+};
 var WebhooksResource = class {
   #secret;
   constructor(config) {
@@ -1568,6 +2078,12 @@ var BirdClient = class {
   #headers;
   /** The email channel — `bird.email.send(...)`, `.get(...)`, `.list(...)`. */
   email;
+  /** Email templates — `bird.emailTemplates.create(...)`, `.list(...)`, `.publish(...)`, … */
+  emailTemplates;
+  /** The SMS channel — `bird.sms.send(...)`, `.get(...)`, `.list(...)`. */
+  sms;
+  /** SMS templates — `bird.smsTemplates.list(...)`, `.get(...)`. */
+  smsTemplates;
   /** Webhooks — `bird.webhooks.unwrap(payload, headers)` verifies an inbound delivery. */
   webhooks;
   constructor(options) {
@@ -1577,12 +2093,12 @@ var BirdClient = class {
     this.#headers = {
       ...opts.defaultHeaders,
       Authorization: `Bearer ${opts.apiKey}`,
-      "User-Agent": `bird-sdk-js/${"0.2.1"}`,
-      // X-Bird-* client-identity headers (ADR-0067): the API attributes the SDK
+      "User-Agent": `bird-sdk-js/${"0.3.0"}`,
+      // Bird-* client-identity headers (ADR-0074): 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"
+      "Bird-Surface": "sdk-js",
+      "Bird-Version": "0.3.0"
     };
     this.#client = createClient(
       createConfig({
@@ -1600,6 +2116,9 @@ var BirdClient = class {
       this.#client,
       opts.email
     );
+    this.emailTemplates = new EmailTemplatesResource(this.core, this.#client);
+    this.sms = new SmsResource(this.core, this.#client);
+    this.smsTemplates = new SmsTemplatesResource(this.core, this.#client);
     this.webhooks = new WebhooksResource(opts.webhooks);
   }
   /**
@@ -1664,6 +2183,7 @@ var WebhookEventType = {
   DomainVerified: "domain.verified",
   EmailAccepted: "email.accepted",
   EmailBounced: "email.bounced",
+  EmailCanceled: "email.canceled",
   EmailClicked: "email.clicked",
   EmailComplained: "email.complained",
   EmailDeferred: "email.deferred",
@@ -1674,6 +2194,7 @@ var WebhookEventType = {
   EmailProcessed: "email.processed",
   EmailReceived: "email.received",
   EmailRejected: "email.rejected",
+  EmailScheduled: "email.scheduled",
   EmailSuppressionCreated: "email_suppression.created",
   EmailUnsubscribed: "email.unsubscribed",
   SmsAccepted: "sms.accepted",