@messagebird/sdk 0.34.0 → 0.36.0

package/dist/index.d.mts

@@ -368,6 +368,8 @@ type WebhookEvent = ({
 } & EventSmsSent) | ({
   type: "sms.undelivered";
 } & EventSmsUndelivered) | ({
+  type: "sms_suppression.created";
+} & EventSmsSuppressionCreated) | ({
   type: "verify.attempt.delivered";
 } & EventVerifyAttemptDelivered) | ({
   type: "verify.attempt.sent";
@@ -2105,10 +2107,25 @@ type SmsSuppressionCreate = {
   originator: string;
 };
 /**
- * Action taken when an inbound message matches the rule. `stop` unsubscribes the sender, `start` resubscribes them, `help` sends your support information, and `custom` sends the reply you configured. Built-in compliance rules fix the operation for `stop`, `start`, and `help`. This is an open enum. Accept unrecognized values.
+ * What Bird does when an inbound message matches the rule.
+ *
+ * - `stop` unsubscribes the sender from further messages.
+ * - `start` resubscribes them.
+ * - `help` replies with your support information.
+ * - `info` replies with your program information. It behaves exactly as `help` does and is
+ * separate so a country whose INFO answer must differ from its HELP answer can carry both.
+ * Where Bird ships no `info` rule for a country, INFO is one of that country's `help`
+ * keywords and answers with the `help` reply.
+ * - `confirm` marks a double opt-in reply. It sends nothing today, so answer it from your own
+ * handler.
+ * - `custom` replies with the text you configured and has no other effect.
+ *
+ * Bird's built-in rules fix the operation for `stop`, `start` and `help`; you can change their
+ * reply but not what they do. The same holds for `info` in any country where Bird ships an
+ * `info` rule. This is an open enum. Accept unrecognized values.
  *
  */
-type SmsKeywordOperation = "stop" | "start" | "help" | "custom" | (string & {});
+type SmsKeywordOperation = "stop" | "start" | "help" | "info" | "confirm" | "custom" | (string & {});
 /**
  * Whether the rule is one of Bird's defaults (`system`) or one your workspace created (`workspace`). A `workspace` rule takes precedence over Bird's default for the same country, so it is how you replace a reply without losing the keywords Bird ships.
  *
@@ -7353,6 +7370,43 @@ type EventSmsUndelivered = {
   timestamp: string;
   data: EventSmsUndeliveredData;
 };
+/**
+ * Always `sms_suppression.created` for this event.
+ */
+type SmsSuppressionCreatedEventType = "sms_suppression.created";
+/**
+ * Payload of the sms_suppression.created event.
+ */
+type EventSmsSuppressionCreatedData = {
+  /**
+   * The suppression episode that was opened.
+   */
+  suppression_id: SmsSuppressionId;
+  /**
+   * The subscriber, in E.164 format.
+   */
+  destination: string;
+  /**
+   * The sender this stops. An SMS suppression is the exact (sender, recipient) pair, so your other senders still reach this subscriber.
+   */
+  originator: string;
+  reason: SmsSuppressionReason;
+  /**
+   * The workspace the suppression belongs to.
+   */
+  workspace_id: WorkspaceId;
+};
+/**
+ * A destination was added to the workspace's SMS suppression ledger: a subscriber's STOP, a carrier opt-out, or a manual add.
+ */
+type EventSmsSuppressionCreated = {
+  type: SmsSuppressionCreatedEventType;
+  /**
+   * When the episode's opening statement took effect (`effective_at`).
+   */
+  timestamp: string;
+  data: EventSmsSuppressionCreatedData;
+};
 /**
  * Identity fields shared by every Verify lifecycle event payload.
  */
@@ -13285,6 +13339,7 @@ declare const WebhookEventType: {
   readonly SmsReceived: "sms.received";
   readonly SmsRejected: "sms.rejected";
   readonly SmsSent: "sms.sent";
+  readonly SmsSuppressionCreated: "sms_suppression.created";
   readonly SmsUndelivered: "sms.undelivered";
   readonly VerifyAttemptDelivered: "verify.attempt.delivered";
   readonly VerifyAttemptSent: "verify.attempt.sent";
@@ -13457,8 +13512,10 @@ type SMSErrorCodeValue = (typeof SMSErrorCode)[keyof typeof SMSErrorCode];
  * these with a `default` branch rather than treating the set as closed.
  */
 declare const SMSKeywordOperation: {
+  readonly Confirm: "confirm";
   readonly Custom: "custom";
   readonly Help: "help";
+  readonly Info: "info";
   readonly Start: "start";
   readonly Stop: "stop";
 };

package/dist/index.mjs

@@ -7132,9 +7132,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.34.0`,
+			"User-Agent": `bird-sdk-js/0.36.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.34.0"
+			"Bird-Version": "0.36.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -7265,6 +7265,7 @@ const WebhookEventType = {
 	SmsReceived: "sms.received",
 	SmsRejected: "sms.rejected",
 	SmsSent: "sms.sent",
+	SmsSuppressionCreated: "sms_suppression.created",
 	SmsUndelivered: "sms.undelivered",
 	VerifyAttemptDelivered: "verify.attempt.delivered",
 	VerifyAttemptSent: "verify.attempt.sent",
@@ -7413,8 +7414,10 @@ const SMSErrorCode = {
 * these with a `default` branch rather than treating the set as closed.
 */
 const SMSKeywordOperation = {
+	Confirm: "confirm",
 	Custom: "custom",
 	Help: "help",
+	Info: "info",
 	Start: "start",
 	Stop: "stop"
 };