@messagebird/sdk 0.32.0 → 0.33.1

package/dist/index.d.mts

@@ -376,6 +376,8 @@ type WebhookEvent = ({
 } & EventVerifyAttemptUndelivered) | ({
   type: "verify.verification.created";
 } & EventVerifyVerificationCreated) | ({
+  type: "verify.verification.failed";
+} & EventVerifyVerificationFailed) | ({
   type: "verify.verification.verified";
 } & EventVerifyVerificationVerified) | ({
   type: "voice_call.answered";
@@ -3288,9 +3290,9 @@ type EmailLookup = {
 };
 type VerificationId = string;
 /**
- * Why a verification session reached its final state without succeeding: `attempts_exhausted` (too many incorrect passcodes) or `ttl_elapsed` (the time window elapsed before a correct passcode). Open enum: new reasons may be added over time, so treat any unrecognized value as a future reason rather than an error.
+ * Why a verification session reached its final state without succeeding: `attempts_exhausted` (too many incorrect passcodes), `ttl_elapsed` (the time window elapsed before a correct passcode), or `undeliverable` (no planned channel could deliver a passcode, so the recipient never had one to submit). Open enum: new reasons may be added over time, so treat any unrecognized value as a future reason rather than an error.
  */
-type VerificationTerminalReason$1 = "attempts_exhausted" | "ttl_elapsed" | (string & {});
+type VerificationTerminalReason$1 = "attempts_exhausted" | "ttl_elapsed" | "undeliverable" | (string & {});
 /**
  * The recipient to verify. Provide an `email`, a `phone_number`, or both; at least one is required. The addresses also identify the verification: a check must supply exactly the set used on the create call, so a verification created with both addresses is not found by either one alone.
  *
@@ -3325,11 +3327,14 @@ type VerificationChannelEntry = {
  * verification moved to the next channel.
  * - `delivery_timeout`: No delivery confirmation arrived before the channel's
  * timeout, so the verification moved to the next channel.
+ * - `not_billable`: The send could not be charged, so it was never handed to the
+ * channel. Usually the workspace balance is too low to cover it. Topping up
+ * the balance is what clears this.
  *
  * New reasons may be added over time. Treat unrecognized values as reasons added
  * later rather than errors.
  */
-type VerificationAttemptFailureReason$1 = "carrier_rejected" | "hard_bounce" | "soft_bounce" | "undelivered" | "channel_unavailable" | "channel_disabled" | "delivery_timeout" | (string & {});
+type VerificationAttemptFailureReason$1 = "carrier_rejected" | "hard_bounce" | "soft_bounce" | "undelivered" | "channel_unavailable" | "channel_disabled" | "delivery_timeout" | "not_billable" | (string & {});
 /**
  * Meta's content classification for a template.
  *
@@ -3349,7 +3354,9 @@ type Verification = {
    *
    * - `pending`: Awaiting a correct passcode.
    * - `verified`: A correct passcode was submitted.
-   * - `failed`: Too many incorrect attempts were submitted.
+   * - `failed`: The verification cannot be completed. Either too many
+   * incorrect passcodes were submitted, or no planned channel could
+   * deliver one. Read `reason` to tell those apart.
    * - `expired`: The validity window elapsed before a correct passcode.
    * - `canceled`: The verification was canceled before completion.
    * - `blocked`: A fraud or abuse control stopped the verification.
@@ -5510,6 +5517,21 @@ type DomainUpdate = {
   inbound?: DomainInboundConfig;
 };
 type SuppressionId = string;
+type Actor = {
+  /**
+   * Actor identifier.
+   */
+  id: string;
+  /**
+   * Who or what performed the action: `user` for a member's own session, `oauth_token` for a token issued to a caller on a member's behalf, `api_key` for a workspace API key, `system` for our own automation, `sso` for an organization's SSO connection, and `service_account` for a workspace's connected Integration acting with no member behind it. Open enum: new actor types may be added over time, so treat any unrecognized value as a future type rather than an error.
+   */
+  type: string;
+  /**
+   * The label the actor is shown under: typically a member's name or email address, or the API key's name. Null when it could not be resolved.
+   *
+   */
+  readonly display_name?: string | null;
+};
 type InboundAddressId = string;
 type InboundEmailMessageId = string;
 type MailboxId = string;
@@ -7498,6 +7520,46 @@ type EventVerifyVerificationCreated = {
   timestamp: string;
   data: EventVerifyVerificationCreatedData;
 };
+/**
+ * Always `verify.verification.failed` for this event.
+ */
+type VerifyVerificationFailedEventType = "verify.verification.failed";
+/**
+ * Payload of the verify.verification.failed event.
+ */
+type EventVerifyVerificationFailedData = EventVerifyBase & {
+  /**
+   * The verification's state, always `failed`. Open enum for forward compatibility.
+   */
+  status: string;
+  /**
+   * Why the verification ended. Always `undeliverable` on this event: no planned channel delivered a passcode.
+   */
+  reason: VerificationTerminalReason$1;
+  /**
+   * The last channel the verification tried, the one whose failure left it with nowhere else to go. Null when no channel was attributed.
+   */
+  channel: VerificationChannel$1 | null;
+  /**
+   * Why that last send did not deliver. This is the actionable half of the event: `not_billable` means the workspace balance could not cover the send, while the delivery reasons point at the recipient or the channel.
+   */
+  last_attempt_reason: VerificationAttemptFailureReason$1;
+  /**
+   * Time the verification was resolved.
+   */
+  failed_at: string;
+};
+/**
+ * The verification ended without the recipient receiving a passcode: every planned channel reported that its send would not arrive.
+ */
+type EventVerifyVerificationFailed = {
+  type: VerifyVerificationFailedEventType;
+  /**
+   * Time the verification was resolved.
+   */
+  timestamp: string;
+  data: EventVerifyVerificationFailedData;
+};
 /**
  * Payload of the verify.verification.verified event.
  */
@@ -7863,21 +7925,6 @@ type EventWhatsAppSent = {
   timestamp: string;
   data: EventWhatsAppSentData;
 };
-type AuditLogActor = {
-  /**
-   * ID of the user, API key, integration, or system process that performed the action.
-   */
-  id: string;
-  /**
-   * Type of actor, such as `user`, `api_key`, `service_account`, or `system`.
-   */
-  type: string;
-  /**
-   * Display name of the actor. This is the user's email address for a `user` actor, or the name of the API key or integration that acted. Absent when it could not be resolved.
-   *
-   */
-  readonly display_name?: string | null;
-};
 /**
  * Physical type of a phone number. New number types may be added over time, so treat unrecognized values as supported types rather than errors.
  */
@@ -8134,7 +8181,7 @@ type VoiceCall = {
   /**
    * Who placed the call: the API key whose credentials it used, the integration acting for the workspace, or the user who placed it from a browser or the CLI. Absent when the call was admitted only by its source IP address, or when no actor was recorded.
    */
-  readonly actor?: AuditLogActor;
+  readonly actor?: Actor;
   /**
    * Identifier of the SIP trunk that originated this call. `null` when no trunk is associated.
    */
@@ -13229,6 +13276,7 @@ declare const WebhookEventType: {
   readonly VerifyAttemptSent: "verify.attempt.sent";
   readonly VerifyAttemptUndelivered: "verify.attempt.undelivered";
   readonly VerifyVerificationCreated: "verify.verification.created";
+  readonly VerifyVerificationFailed: "verify.verification.failed";
   readonly VerifyVerificationVerified: "verify.verification.verified";
   readonly VoiceCallAnswered: "voice_call.answered";
   readonly VoiceCallEnded: "voice_call.ended";
@@ -13488,6 +13536,7 @@ declare const VerificationAttemptFailureReason: {
   readonly ChannelUnavailable: "channel_unavailable";
   readonly DeliveryTimeout: "delivery_timeout";
   readonly HardBounce: "hard_bounce";
+  readonly NotBillable: "not_billable";
   readonly SoftBounce: "soft_bounce";
   readonly Undelivered: "undelivered";
 };
@@ -13514,6 +13563,7 @@ type VerificationChannelValue = (typeof VerificationChannel)[keyof typeof Verifi
 declare const VerificationTerminalReason: {
   readonly AttemptsExhausted: "attempts_exhausted";
   readonly TtlElapsed: "ttl_elapsed";
+  readonly Undeliverable: "undeliverable";
 };
 /** A known VerificationTerminalReason value. */
 type VerificationTerminalReasonValue = (typeof VerificationTerminalReason)[keyof typeof VerificationTerminalReason];

package/dist/index.mjs

@@ -7128,9 +7128,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.32.0`,
+			"User-Agent": `bird-sdk-js/0.33.1`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.32.0"
+			"Bird-Version": "0.33.1"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -7266,6 +7266,7 @@ const WebhookEventType = {
 	VerifyAttemptSent: "verify.attempt.sent",
 	VerifyAttemptUndelivered: "verify.attempt.undelivered",
 	VerifyVerificationCreated: "verify.verification.created",
+	VerifyVerificationFailed: "verify.verification.failed",
 	VerifyVerificationVerified: "verify.verification.verified",
 	VoiceCallAnswered: "voice_call.answered",
 	VoiceCallEnded: "voice_call.ended",
@@ -7487,6 +7488,7 @@ const VerificationAttemptFailureReason = {
 	ChannelUnavailable: "channel_unavailable",
 	DeliveryTimeout: "delivery_timeout",
 	HardBounce: "hard_bounce",
+	NotBillable: "not_billable",
 	SoftBounce: "soft_bounce",
 	Undelivered: "undelivered"
 };
@@ -7508,7 +7510,8 @@ const VerificationChannel = {
 */
 const VerificationTerminalReason = {
 	AttemptsExhausted: "attempts_exhausted",
-	TtlElapsed: "ttl_elapsed"
+	TtlElapsed: "ttl_elapsed",
+	Undeliverable: "undeliverable"
 };
 /**
 * Values of WhatsAppErrorCode known at this SDK version. The wire value is an open