@messagebird/sdk 0.12.0 → 0.12.2

package/dist/index.d.mts

@@ -585,6 +585,228 @@ type EventVoiceCallAnswered = {
   timestamp: string;
   data: EventVoiceCallAnsweredData;
 };
+/**
+ * Payload of the verify.verification.verified event.
+ */
+type EventVerifyVerificationVerifiedData = EventVerifyBase & {
+  /**
+   * The verification's state, always `verified`. Open enum for forward compatibility.
+   */
+  status: string;
+  /**
+   * The channel whose passcode the recipient confirmed, the channel that converted. Null when the verification was resolved without attributing a channel.
+   */
+  channel: VerificationChannel | null;
+  /**
+   * Time the verification was verified.
+   */
+  verified_at: string;
+};
+/**
+ * The channel a passcode is delivered over. Open enum — new channels may be added over time, so treat any unrecognized value as a future channel rather than an error.
+ */
+type VerificationChannel = string;
+/**
+ * The recipient to verify. Provide an `email_address`, 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.
+ *
+ */
+type VerificationTo = {
+  /**
+   * The recipient's email address. Case does not matter; the address is lowercased before use.
+   */
+  email_address?: string;
+  /**
+   * The recipient's phone number in E.164 format, with the leading `+` and country code (for example `+15551234567`). A number in any other format is rejected as an invalid recipient (`422`).
+   */
+  phone_number?: string;
+};
+type VerificationId = string;
+/**
+ * Identity fields shared by every Verify lifecycle event payload.
+ */
+type EventVerifyBase = {
+  /**
+   * ID of the verification session.
+   */
+  verification_id: VerificationId;
+  /**
+   * ID of the workspace.
+   */
+  workspace_id: WorkspaceId;
+  /**
+   * The recipient identity of the verification session (email address, phone number, or both), echoed on every event so you can correlate without an extra lookup. An individual attempt reports the single address it was dispatched to in its own `address` field.
+   */
+  to: VerificationTo;
+  /**
+   * The metadata object provided when the verification was created, echoed on every event for the session so you can correlate events with your own records. Null when the verification carried no metadata.
+   *
+   */
+  metadata: {
+    [key: string]: unknown;
+  } | null;
+};
+/**
+ * The verification was successfully resolved: the recipient confirmed the correct code.
+ */
+type EventVerifyVerificationVerified = {
+  /**
+   * Event type.
+   */
+  type: "verify.verification.verified";
+  /**
+   * Time the verification was verified.
+   */
+  timestamp: string;
+  data: EventVerifyVerificationVerifiedData;
+};
+/**
+ * Payload of the verify.verification.created event.
+ */
+type EventVerifyVerificationCreatedData = EventVerifyBase & {
+  /**
+   * The first channel of the verification's resolved channel plan.
+   */
+  channel: VerificationChannel;
+  /**
+   * The verification's state at creation, always `pending`. Open enum for forward compatibility.
+   */
+  status: string;
+  /**
+   * Time the verification session was created.
+   */
+  created_at: string;
+};
+/**
+ * A verification session was created and its first one-time passcode is being sent.
+ */
+type EventVerifyVerificationCreated = {
+  /**
+   * Event type.
+   */
+  type: "verify.verification.created";
+  /**
+   * Time the verification session was created.
+   */
+  timestamp: string;
+  data: EventVerifyVerificationCreatedData;
+};
+/**
+ * Why a passcode send did not deliver. Open enum — new reasons may be added over time, so treat any unrecognized value as a future reason rather than an error. v1 emits `carrier_rejected` (SMS), `hard_bounce` (email), `undelivered` (a generic terminal delivery failure), and `channel_unavailable` (the channel could not be used and the verification failed over).
+ */
+type VerificationAttemptFailureReason = string;
+/**
+ * Payload of the verify.attempt.undelivered event.
+ */
+type EventVerifyAttemptUndeliveredData = EventVerifyBase & {
+  /**
+   * The channel this attempt was sent on.
+   */
+  channel: VerificationChannel;
+  /**
+   * The single address this attempt was dispatched to, an E.164 phone number or an email address.
+   */
+  address: string;
+  /**
+   * Why the attempt failed to reach the recipient.
+   */
+  reason: VerificationAttemptFailureReason;
+  /**
+   * Diagnostic text describing the failure, for display only. Null when none was reported.
+   */
+  error: string | null;
+  /**
+   * Time the failure was recorded.
+   */
+  failed_at: string;
+};
+/**
+ * A one-time passcode failed to deliver to the recipient.
+ */
+type EventVerifyAttemptUndelivered = {
+  /**
+   * Event type.
+   */
+  type: "verify.attempt.undelivered";
+  /**
+   * Time the failure was recorded.
+   */
+  timestamp: string;
+  data: EventVerifyAttemptUndeliveredData;
+};
+/**
+ * Payload of the verify.attempt.sent event.
+ */
+type EventVerifyAttemptSentData = EventVerifyBase & {
+  /**
+   * The channel this attempt was sent on.
+   */
+  channel: VerificationChannel;
+  /**
+   * The single address this attempt was dispatched to, an E.164 phone number or an email address.
+   */
+  address: string;
+  /**
+   * The sender the passcode was sent from: a phone number, alphanumeric sender ID, short code, or email address. Null when the channel exposes no sender.
+   */
+  from: string | null;
+  /**
+   * Time the passcode was dispatched.
+   */
+  sent_at: string;
+};
+/**
+ * A one-time passcode was dispatched to the recipient on a channel.
+ */
+type EventVerifyAttemptSent = {
+  /**
+   * Event type.
+   */
+  type: "verify.attempt.sent";
+  /**
+   * Time the passcode was dispatched.
+   */
+  timestamp: string;
+  data: EventVerifyAttemptSentData;
+};
+/**
+ * Payload of the verify.attempt.delivered event.
+ */
+type EventVerifyAttemptDeliveredData = EventVerifyBase & {
+  /**
+   * The channel this attempt was sent on.
+   */
+  channel: VerificationChannel;
+  /**
+   * The single address this attempt was dispatched to, an E.164 phone number or an email address.
+   */
+  address: string;
+  /**
+   * Carrier that delivered the message, when the carrier network reports it. Always null for email and WhatsApp.
+   */
+  carrier: string | null;
+  /**
+   * Mobile country code and mobile network code of the delivering carrier, when reported. Always null for email and WhatsApp.
+   */
+  mcc_mnc: string | null;
+  /**
+   * Time delivery was confirmed.
+   */
+  delivered_at: string;
+};
+/**
+ * The channel confirmed delivery of a one-time passcode to the recipient.
+ */
+type EventVerifyAttemptDelivered = {
+  /**
+   * Event type.
+   */
+  type: "verify.attempt.delivered";
+  /**
+   * Time delivery was confirmed.
+   */
+  timestamp: string;
+  data: EventVerifyAttemptDeliveredData;
+};
 /**
  * Payload of the sms.undelivered event.
  */
@@ -1818,6 +2040,16 @@ type WebhookEvent = ({
 } & EventSmsTfnVerificationSubmitted) | ({
   type: "sms.undelivered";
 } & EventSmsUndelivered) | ({
+  type: "verify.attempt.delivered";
+} & EventVerifyAttemptDelivered) | ({
+  type: "verify.attempt.sent";
+} & EventVerifyAttemptSent) | ({
+  type: "verify.attempt.undelivered";
+} & EventVerifyAttemptUndelivered) | ({
+  type: "verify.verification.created";
+} & EventVerifyVerificationCreated) | ({
+  type: "verify.verification.verified";
+} & EventVerifyVerificationVerified) | ({
   type: "voice_call.answered";
 } & EventVoiceCallAnswered) | ({
   type: "voice_call.ended";
@@ -2623,6 +2855,10 @@ type MailboxStatsSummary = {
    */
   readonly received: number;
 };
+/**
+ * The bucket grain of the series, either `day` or `hour`.
+ */
+type StatsGrain = "day" | "hour";
 /**
  * The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
  *
@@ -2636,10 +2872,7 @@ type EmailStatsSeriesPeriod = {
    * Inclusive end of the window. A calendar day (YYYY-MM-DD, in the requested `timezone`) on the day grain; on the hour grain, an RFC 3339 UTC instant marking the start of the last hour bucket, which falls on a local hour boundary when `timezone` is set.
    */
   readonly to: string;
-  /**
-   * The bucket grain of the series, either `day` or `hour`.
-   */
-  readonly grain: string;
+  readonly grain: StatsGrain;
   /**
    * The instant the statistics in this response are current to: events recorded up to roughly this time are reflected, while more recent events may not be yet. Statistics are served from a rolling aggregation that refreshes every few seconds, so a response is near-real-time but not live; use this field to label data freshness rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.
    *
@@ -4181,28 +4414,13 @@ type VerificationCheckResult = {
    */
   readonly attempts_remaining?: number | null;
 };
-/**
- * The channel a passcode is delivered over. Open enum — new channels may be added over time, so treat any unrecognized value as a future channel rather than an error.
- */
-type VerificationChannel = string;
 type VerificationChannelEntry = {
   channel: VerificationChannel;
 };
 /**
- * The recipient to verify. Provide an `email_address`, 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.
- *
+ * 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.
  */
-type VerificationTo = {
-  /**
-   * The recipient's email address. Case does not matter; the address is lowercased before use.
-   */
-  email_address?: string;
-  /**
-   * The recipient's phone number in E.164 format, with the leading `+` and country code (for example `+15551234567`). A number in any other format is rejected as an invalid recipient (`422`).
-   */
-  phone_number?: string;
-};
-type VerificationId = string;
+type VerificationTerminalReason = string;
 type Verification = {
   readonly id: VerificationId;
   /**
@@ -4210,9 +4428,9 @@ type Verification = {
    */
   readonly status: "pending" | "verified" | "failed" | "expired" | "canceled" | "blocked";
   /**
-   * Why the verification reached its final state: `attempts_exhausted` (too many incorrect passcodes) or `ttl_elapsed` (the time window elapsed before a correct passcode). Null while `pending` and once `verified`. Open enum; treat any unrecognized value as a future reason.
+   * Why the verification reached its final state, or null while `pending` and once `verified`. See the enum for the values it can take.
    */
-  readonly reason?: string | null;
+  readonly reason?: VerificationTerminalReason | null;
   readonly to: VerificationTo;
   /**
    * The channels this verification uses to deliver the passcode, in attempt order: the first entry is tried first and later entries are fallbacks. An email recipient is verified over email; a phone recipient is verified over SMS.
@@ -7277,61 +7495,66 @@ declare class DomainsResource extends Resource {
   verify(domainId: string, options?: RequestOptions): APIPromise<Domain>;
 }
 //#endregion
-//#region src/resources/contactProperties.d.ts
-/** Body for `bird.contactProperties.create`. */
-type ContactPropertyCreateParams = ContactPropertyCreateRequest;
-/** Body for `bird.contactProperties.update` — a partial patch. */
-type ContactPropertyUpdateParams = ContactPropertyUpdateRequest;
-/** Filters and cursor params for `bird.contactProperties.list`. */
+//#region src/resources/contactProperties.gen.d.ts
 type ContactPropertyListQuery = NonNullable<ListContactPropertiesData["query"]>;
-declare class ContactPropertiesResource extends Resource {
+declare class ContactPropertiesResourceBase extends Resource {
   /**
-   * Define a contact property. The `key` must be unique in the workspace and is
-   * how contacts reference the field in their `data`.
+   * List the workspace's contact properties as a cursor page, newest first. Archived properties are included, marked by their archived flag.
    *
-   * @example
-   * const prop = await bird.contactProperties.create({ key: "plan", type: "string" });
-   * console.log(prop.id); // "cp_…"
-   */
-  create(params: ContactPropertyCreateParams, options?: RequestOptions): APIPromise<ContactProperty>;
-  /**
-   * List the workspace's contact properties. `await` resolves the first page;
-   * `for await` walks every property across pages.
-   *
-   * @example
+   * @example Iterate every contact property, or take one page
    * for await (const prop of bird.contactProperties.list()) {
    *   console.log(prop.key, prop.type);
    * }
+   * const page = await bird.contactProperties.list({ limit: 50 }); // page.data, page.next_cursor
    */
   list(query?: ContactPropertyListQuery, options?: RequestOptions): PaginatedPromise<ContactProperty>;
   /**
-   * Fetch a single contact property by id.
+   * Get a single contact property by ID: key, type, fallback value, and archived state.
    *
-   * @example
+   * @example Fetch a contact property by id
    * const prop = await bird.contactProperties.get("cp_01krdgeqcxet5s7t44vh8rt9mg");
+   * console.log(prop.key, prop.type);
    */
   get(propertyId: string, options?: RequestOptions): APIPromise<ContactProperty>;
   /**
-   * Update a contact property. Only the fields you send change.
+   * Archive a contact property: the key is rejected in new contact writes and stops rendering in templates, while stored values remain readable. The key stays reserved and counts toward the 200-property limit; reverse with `contact_properties.unarchive`.
    *
-   * @example
-   * await bird.contactProperties.update("cp_01krdgeqcxet5s7t44vh8rt9mg", { fallback_value: "free" });
+   * @example Archive a property, retiring the field without deleting its data
+   * const prop = await bird.contactProperties.archive("cp_01krdgeqcxet5s7t44vh8rt9mg");
+   * console.log(prop.key, prop.archived);
    */
-  update(propertyId: string, params: ContactPropertyUpdateParams, options?: RequestOptions): APIPromise<ContactProperty>;
+  archive(propertyId: string, options?: RequestOptions): APIPromise<ContactProperty>;
+  /**
+   * Reactivate an archived contact property so its key is accepted in contact writes and renders in templates again. Fails with a conflict if the property is not archived.
+   *
+   * @example Restore an archived property
+   * await bird.contactProperties.unarchive("cp_01krdgeqcxet5s7t44vh8rt9mg");
+   */
+  unarchive(propertyId: string, options?: RequestOptions): APIPromise<ContactProperty>;
+}
+//#endregion
+//#region src/resources/contactProperties.d.ts
+/** Body for `bird.contactProperties.create`. */
+type ContactPropertyCreateParams = ContactPropertyCreateRequest;
+/** Body for `bird.contactProperties.update` — a partial patch. */
+type ContactPropertyUpdateParams = ContactPropertyUpdateRequest;
+declare class ContactPropertiesResource extends ContactPropertiesResourceBase {
   /**
-   * Archive a contact property, retiring the field without deleting its data.
+   * Define a contact property. The `key` must be unique in the workspace and is
+   * how contacts reference the field in their `data`.
    *
    * @example
-   * await bird.contactProperties.archive("cp_01krdgeqcxet5s7t44vh8rt9mg");
+   * const prop = await bird.contactProperties.create({ key: "plan", type: "string" });
+   * console.log(prop.id); // "cp_…"
    */
-  archive(propertyId: string, options?: RequestOptions): APIPromise<ContactProperty>;
+  create(params: ContactPropertyCreateParams, options?: RequestOptions): APIPromise<ContactProperty>;
   /**
-   * Restore an archived contact property.
+   * Update a contact property. Only the fields you send change.
    *
    * @example
-   * await bird.contactProperties.unarchive("cp_01krdgeqcxet5s7t44vh8rt9mg");
+   * await bird.contactProperties.update("cp_01krdgeqcxet5s7t44vh8rt9mg", { fallback_value: "free" });
    */
-  unarchive(propertyId: string, options?: RequestOptions): APIPromise<ContactProperty>;
+  update(propertyId: string, params: ContactPropertyUpdateParams, options?: RequestOptions): APIPromise<ContactProperty>;
 }
 //#endregion
 //#region src/resources/contacts.gen.d.ts
@@ -8053,6 +8276,11 @@ declare const WebhookEventType: {
   readonly SmsTfnVerificationRejected: "sms.tfn_verification.rejected";
   readonly SmsTfnVerificationSubmitted: "sms.tfn_verification.submitted";
   readonly SmsUndelivered: "sms.undelivered";
+  readonly VerifyAttemptDelivered: "verify.attempt.delivered";
+  readonly VerifyAttemptSent: "verify.attempt.sent";
+  readonly VerifyAttemptUndelivered: "verify.attempt.undelivered";
+  readonly VerifyVerificationCreated: "verify.verification.created";
+  readonly VerifyVerificationVerified: "verify.verification.verified";
   readonly VoiceCallAnswered: "voice_call.answered";
   readonly VoiceCallEnded: "voice_call.ended";
   readonly VoiceCallInitiated: "voice_call.initiated";

package/dist/index.mjs

@@ -3717,32 +3717,16 @@ var DomainsResource = class extends Resource {
 	}
 };
 //#endregion
-//#region src/resources/contactProperties.ts
-var ContactPropertiesResource = class extends Resource {
-	/**
-	* Define a contact property. The `key` must be unique in the workspace and is
-	* how contacts reference the field in their `data`.
-	*
-	* @example
-	* const prop = await bird.contactProperties.create({ key: "plan", type: "string" });
-	* console.log(prop.id); // "cp_…"
-	*/
-	create(params, options) {
-		return this.call("POST", options, ({ signal, headers }) => createContactProperty({
-			client: this.client,
-			body: params,
-			headers,
-			signal
-		}));
-	}
+//#region src/resources/contactProperties.gen.ts
+var ContactPropertiesResourceBase = class extends Resource {
 	/**
-	* List the workspace's contact properties. `await` resolves the first page;
-	* `for await` walks every property across pages.
+	* List the workspace's contact properties as a cursor page, newest first. Archived properties are included, marked by their archived flag.
 	*
-	* @example
+	* @example Iterate every contact property, or take one page
 	* for await (const prop of bird.contactProperties.list()) {
 	*   console.log(prop.key, prop.type);
 	* }
+	* const page = await bird.contactProperties.list({ limit: 50 }); // page.data, page.next_cursor
 	*/
 	list(query, options) {
 		return this.paginated("GET", options, ({ signal, headers }, cursor) => listContactProperties({
@@ -3756,10 +3740,11 @@ var ContactPropertiesResource = class extends Resource {
 		}));
 	}
 	/**
-	* Fetch a single contact property by id.
+	* Get a single contact property by ID: key, type, fallback value, and archived state.
 	*
-	* @example
+	* @example Fetch a contact property by id
 	* const prop = await bird.contactProperties.get("cp_01krdgeqcxet5s7t44vh8rt9mg");
+	* console.log(prop.key, prop.type);
 	*/
 	get(propertyId, options) {
 		return this.call("GET", options, ({ signal, headers }) => getContactProperty({
@@ -3770,44 +3755,65 @@ var ContactPropertiesResource = class extends Resource {
 		}));
 	}
 	/**
-	* Update a contact property. Only the fields you send change.
+	* Archive a contact property: the key is rejected in new contact writes and stops rendering in templates, while stored values remain readable. The key stays reserved and counts toward the 200-property limit; reverse with `contact_properties.unarchive`.
 	*
-	* @example
-	* await bird.contactProperties.update("cp_01krdgeqcxet5s7t44vh8rt9mg", { fallback_value: "free" });
+	* @example Archive a property, retiring the field without deleting its data
+	* const prop = await bird.contactProperties.archive("cp_01krdgeqcxet5s7t44vh8rt9mg");
+	* console.log(prop.key, prop.archived);
 	*/
-	update(propertyId, params, options) {
-		return this.call("PATCH", options, ({ signal, headers }) => updateContactProperty({
+	archive(propertyId, options) {
+		return this.call("POST", options, ({ signal, headers }) => archiveContactProperty({
 			client: this.client,
 			path: { property_id: propertyId },
-			body: params,
 			headers,
 			signal
 		}));
 	}
 	/**
-	* Archive a contact property, retiring the field without deleting its data.
+	* Reactivate an archived contact property so its key is accepted in contact writes and renders in templates again. Fails with a conflict if the property is not archived.
 	*
-	* @example
-	* await bird.contactProperties.archive("cp_01krdgeqcxet5s7t44vh8rt9mg");
+	* @example Restore an archived property
+	* await bird.contactProperties.unarchive("cp_01krdgeqcxet5s7t44vh8rt9mg");
 	*/
-	archive(propertyId, options) {
-		return this.call("POST", options, ({ signal, headers }) => archiveContactProperty({
+	unarchive(propertyId, options) {
+		return this.call("POST", options, ({ signal, headers }) => unarchiveContactProperty({
 			client: this.client,
 			path: { property_id: propertyId },
 			headers,
 			signal
 		}));
 	}
+};
+//#endregion
+//#region src/resources/contactProperties.ts
+var ContactPropertiesResource = class extends ContactPropertiesResourceBase {
 	/**
-	* Restore an archived contact property.
+	* Define a contact property. The `key` must be unique in the workspace and is
+	* how contacts reference the field in their `data`.
 	*
 	* @example
-	* await bird.contactProperties.unarchive("cp_01krdgeqcxet5s7t44vh8rt9mg");
+	* const prop = await bird.contactProperties.create({ key: "plan", type: "string" });
+	* console.log(prop.id); // "cp_…"
 	*/
-	unarchive(propertyId, options) {
-		return this.call("POST", options, ({ signal, headers }) => unarchiveContactProperty({
+	create(params, options) {
+		return this.call("POST", options, ({ signal, headers }) => createContactProperty({
+			client: this.client,
+			body: params,
+			headers,
+			signal
+		}));
+	}
+	/**
+	* Update a contact property. Only the fields you send change.
+	*
+	* @example
+	* await bird.contactProperties.update("cp_01krdgeqcxet5s7t44vh8rt9mg", { fallback_value: "free" });
+	*/
+	update(propertyId, params, options) {
+		return this.call("PATCH", options, ({ signal, headers }) => updateContactProperty({
 			client: this.client,
 			path: { property_id: propertyId },
+			body: params,
 			headers,
 			signal
 		}));
@@ -4743,9 +4749,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.12.0`,
+			"User-Agent": `bird-sdk-js/0.12.2`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.12.0"
+			"Bird-Version": "0.12.2"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -4872,6 +4878,11 @@ const WebhookEventType = {
 	SmsTfnVerificationRejected: "sms.tfn_verification.rejected",
 	SmsTfnVerificationSubmitted: "sms.tfn_verification.submitted",
 	SmsUndelivered: "sms.undelivered",
+	VerifyAttemptDelivered: "verify.attempt.delivered",
+	VerifyAttemptSent: "verify.attempt.sent",
+	VerifyAttemptUndelivered: "verify.attempt.undelivered",
+	VerifyVerificationCreated: "verify.verification.created",
+	VerifyVerificationVerified: "verify.verification.verified",
 	VoiceCallAnswered: "voice_call.answered",
 	VoiceCallEnded: "voice_call.ended",
 	VoiceCallInitiated: "voice_call.initiated",