@messagebird/sdk 0.37.3 → 0.38.1

package/dist/index.d.mts

@@ -352,6 +352,12 @@ type WebhookEvent = ({
 } & EventEmailMailboxThreadCreated) | ({
   type: "email_suppression.created";
 } & EventEmailSuppressionCreated) | ({
+  type: "preference.deleted";
+} & EventPreferenceDeleted) | ({
+  type: "preference.granted";
+} & EventPreferenceGranted) | ({
+  type: "preference.revoked";
+} & EventPreferenceRevoked) | ({
   type: "sms.accepted";
 } & EventSmsAccepted) | ({
   type: "sms.delivered";
@@ -401,7 +407,9 @@ type WebhookEvent = ({
   type: "whatsapp.rejected";
 } & EventWhatsAppRejected) | ({
   type: "whatsapp.sent";
-} & EventWhatsAppSent);
+} & EventWhatsAppSent) | ({
+  type: "whatsapp_suppression.created";
+} & EventWhatsAppSuppressionCreated);
 type NextAction$1 = {
   /**
    * What you do about this step.
@@ -1288,6 +1296,111 @@ type Audience = {
    */
   type: "static";
 } & Timestamps;
+type PreferenceId = string;
+/**
+ * The channel a preference statement applies to. A preference addresses one channel: the handle that identifies the person differs per channel, so opting out of one channel says nothing about the others. New channels can be added over time, so a value outside this list can be returned.
+ */
+type PreferenceChannel$1 = "email" | "sms" | "whatsapp" | (string & {});
+/**
+ * What the statement says: `granted` records consent to receive messages, `revoked` records an opt-out. There is no third state: a person who never stated anything simply has no preference on record.
+ */
+type PreferenceStatus = "granted" | "revoked";
+/**
+ * How much traffic the statement covers. `non_transactional` covers marketing and other non-essential messages while transactional messages such as receipts and verification codes keep flowing; `all` covers every message including transactional ones.
+ */
+type PreferenceCoverage = "all" | "non_transactional";
+/**
+ * How the statement was made. Statements the person made themselves (`unsubscribe_link`, `unsubscribe_event`, `keyword`, `preference_page`) carry more weight than ones asserted on their behalf (`api_key`, `user`, `import`): a person's own opt-out cannot be overridden or deleted through this API. New origins can be added over time, so a value outside this list can be returned.
+ */
+type PreferenceOrigin$1 = "unsubscribe_link" | "unsubscribe_event" | "keyword" | "preference_page" | "api_key" | "user" | "import" | (string & {});
+/**
+ * One person's current stated preference for one channel: whether they have consented to or opted out of receiving messages at a handle, and how much traffic the statement covers. A key holds one current statement (a newer statement replaces it, an older one is refused), and the full history behind the current state is kept internally. `sender_scope` and `topic_id` are part of the key: a preference with both null applies channel-wide.
+ *
+ */
+type Preference = {
+  readonly id: PreferenceId;
+  readonly channel: PreferenceChannel$1;
+  /**
+   * Who the statement is about: an email address on the email channel, a phone number in E.164 format on SMS and WhatsApp.
+   */
+  readonly handle: string;
+  /**
+   * The sender the statement is limited to, or null when it covers the whole channel. On SMS this is the originator the person replied to; on WhatsApp it identifies the business account that messaged them. Email preferences are always channel-wide, so it is always null there.
+   */
+  readonly sender_scope: string | null;
+  /**
+   * The topic the statement is limited to, or null when it covers every topic. Part of the key that identifies a statement, alongside `sender_scope`.
+   */
+  readonly topic_id: string | null;
+  readonly status: PreferenceStatus;
+  readonly coverage: PreferenceCoverage;
+  /**
+   * When the statement was made, as reported by whoever made it. This is what orders one key's statements: a write dated before this moment is refused rather than applied.
+   */
+  readonly effective_at: string;
+  readonly origin: PreferenceOrigin$1;
+  /**
+   * Free-form note on where the statement came from, as supplied when it was recorded: a form name, an import batch, a campaign. Null when none was given.
+   */
+  readonly source?: string | null;
+  /**
+   * When the person consented, as evidenced by whoever asserted the grant. Null on statements that carry no consent evidence, including every opt-out.
+   */
+  readonly consented_at?: string | null;
+  /**
+   * The contact whose handle matched when the statement was recorded. Null when no contact matched at that moment; it is not updated when contacts change later.
+   */
+  readonly contact_id?: ContactId | null;
+} & Timestamps;
+type PreferenceStatement = {
+  channel: PreferenceChannel$1;
+  status: PreferenceStatus;
+  /**
+   * How much traffic the statement covers. Defaults to `non_transactional`, which keeps transactional messages such as receipts and verification codes flowing.
+   */
+  coverage?: PreferenceCoverage;
+  /**
+   * Limit the statement to one sender instead of the whole channel. On SMS this is the originator; on WhatsApp it identifies the business account. Not supported on email, where preferences are always channel-wide.
+   */
+  sender_scope?: string;
+  /**
+   * Free-form note on where the statement came from: a form name, an import batch, a campaign. Stored verbatim and returned on the preference.
+   */
+  source?: string;
+  /**
+   * When the person consented, on a `granted` statement. Required evidence when granting over a stored opt-out: the grant applies only if this is later than the opt-out it reverses. May not be in the future.
+   */
+  consented_at?: string;
+};
+/**
+ * Records one preference statement for a handle. Writing is an upsert by key (channel, handle, sender scope, and topic), and statements are causally ordered: a statement dated older than the key's current one is refused and returned with `applied: false` rather than applied out of order.
+ *
+ */
+type PreferenceCreate = {
+  /**
+   * Who the statement is about: an email address on the email channel, a phone number in E.164 format on SMS and WhatsApp.
+   */
+  handle: string;
+} & PreferenceStatement;
+type PreferenceTransitionId = string;
+/**
+ * The outcome of one preference write or delete. `applied: true` means the request took effect: either it changed the record, or an identical statement already had. `applied: false` means it was refused as older than the key's current statement; `preference` then carries the statement that survived, and `transition_id` identifies the refusal on the key's record.
+ *
+ */
+type PreferenceWriteResult = {
+  /**
+   * Whether the request took effect. False only when it was refused as out of order; the surviving, newer statement is returned in `preference`.
+   */
+  readonly applied: boolean;
+  /**
+   * Identifies this write on the key's record, for applied and refused requests alike. Null when the write was a repeat of the current statement and recorded nothing new.
+   */
+  readonly transition_id: PreferenceTransitionId | null;
+  /**
+   * The key's surviving statement. Null after an applied delete, when the key is back to having no record.
+   */
+  readonly preference: Preference | null;
+};
 type ContactPropertyId = string;
 /**
  * The value type every contact must use for a property. Cannot be changed after creation.
@@ -4004,37 +4117,37 @@ type WhatsAppMessageSendRequest = {
    */
   template?: WhatsAppTemplateSend;
   /**
-   * Free-form text to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. We do not track the window, so a send outside one is accepted and then fails, with `service_window_expired` on the message's `last_error`.
+   * Free-form text to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. A send into a closed window is refused with a `422` `WhatsAppServiceWindowClosed` before anything is created or charged; one whose window closes between accept and dispatch fails asynchronously, with `service_window_expired` on the message's `last_error`.
    *
    */
   text?: WhatsAppTextSend;
   /**
-   * A free-form image to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. We do not track the window, so a send outside one is accepted and then fails, with `service_window_expired` on the message's `last_error`.
+   * A free-form image to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. A send into a closed window is refused with a `422` `WhatsAppServiceWindowClosed` before anything is created or charged; one whose window closes between accept and dispatch fails asynchronously, with `service_window_expired` on the message's `last_error`.
    *
    */
   image?: WhatsAppImageSend;
   /**
-   * A free-form video to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. We do not track the window, so a send outside one is accepted and then fails, with `service_window_expired` on the message's `last_error`.
+   * A free-form video to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. A send into a closed window is refused with a `422` `WhatsAppServiceWindowClosed` before anything is created or charged; one whose window closes between accept and dispatch fails asynchronously, with `service_window_expired` on the message's `last_error`.
    *
    */
   video?: WhatsAppVideoSend;
   /**
-   * Free-form audio to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. We do not track the window, so a send outside one is accepted and then fails, with `service_window_expired` on the message's `last_error`.
+   * Free-form audio to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. A send into a closed window is refused with a `422` `WhatsAppServiceWindowClosed` before anything is created or charged; one whose window closes between accept and dispatch fails asynchronously, with `service_window_expired` on the message's `last_error`.
    *
    */
   audio?: WhatsAppAudioSend;
   /**
-   * A free-form sticker to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. We do not track the window, so a send outside one is accepted and then fails, with `service_window_expired` on the message's `last_error`.
+   * A free-form sticker to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. A send into a closed window is refused with a `422` `WhatsAppServiceWindowClosed` before anything is created or charged; one whose window closes between accept and dispatch fails asynchronously, with `service_window_expired` on the message's `last_error`.
    *
    */
   sticker?: WhatsAppStickerSend;
   /**
-   * A free-form document to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. We do not track the window, so a send outside one is accepted and then fails, with `service_window_expired` on the message's `last_error`.
+   * A free-form document to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. A send into a closed window is refused with a `422` `WhatsAppServiceWindowClosed` before anything is created or charged; one whose window closes between accept and dispatch fails asynchronously, with `service_window_expired` on the message's `last_error`.
    *
    */
   document?: WhatsAppDocumentSend;
   /**
-   * A free-form location to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. We do not track the window, so a send outside one is accepted and then fails, with `service_window_expired` on the message's `last_error`.
+   * A free-form location to send instead of a template. Deliverable only inside an open 24-hour customer service window, which the contact opens by messaging or calling you and resets each time they do it again. A send into a closed window is refused with a `422` `WhatsAppServiceWindowClosed` before anything is created or charged; one whose window closes between accept and dispatch fails asynchronously, with `service_window_expired` on the message's `last_error`.
    *
    */
   location?: WhatsAppLocationSend;
@@ -4089,6 +4202,7 @@ type WhatsAppEventList = {
   data: Array<WhatsAppEvent>;
 };
 type NumbersDedicatedAllocationId = string;
+type WhatsAppSuppressionId = string;
 /**
  * The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
  *
@@ -7115,6 +7229,94 @@ type EventEmailSuppressionCreated = {
   timestamp: string;
   data: EventEmailSuppressionCreatedData;
 };
+/**
+ * Always `preference.deleted` for this event.
+ */
+type PreferenceDeletedEventType = "preference.deleted";
+/**
+ * Identity fields shared by every preference lifecycle event: the key plus the ledger entry the write appended. `effective_at` is not repeated here: it is the envelope `timestamp`.
+ */
+type EventPreferenceBase = {
+  /**
+   * The preference key this write applied to.
+   */
+  preference_id: PreferenceId;
+  /**
+   * The ledger entry this write appended.
+   */
+  transition_id: PreferenceTransitionId;
+  channel: PreferenceChannel$1;
+  /**
+   * Who the statement is about: an email address on the email channel, a phone number in E.164 format on SMS and WhatsApp.
+   */
+  handle: string;
+  /**
+   * The sender the statement is limited to, or null when it covers the whole channel. Present-with-null on every payload of this type: it is part of the key alongside `topic_id`, and pinning its presence keeps a subscriber from ever learning `(handle, channel)` as the unique key.
+   */
+  sender_scope: string | null;
+  /**
+   * The topic the statement is limited to, or null when it covers every topic. Reserved: always null in v1. Present-with-null for the same reason as `sender_scope`.
+   */
+  topic_id: string | null;
+  coverage: PreferenceCoverage;
+  /**
+   * The contact whose handle matched when the statement was recorded. Null when no contact matched at that moment.
+   */
+  contact_id: ContactId | null;
+};
+/**
+ * Payload of the preference.deleted event.
+ */
+type EventPreferenceDeletedData = EventPreferenceBase;
+/**
+ * A stated preference was deleted, superseding it in the ledger without erasing its history.
+ */
+type EventPreferenceDeleted = {
+  type: PreferenceDeletedEventType;
+  /**
+   * When the delete took effect (`effective_at`), not when it was recorded.
+   */
+  timestamp: string;
+  data: EventPreferenceDeletedData;
+};
+/**
+ * Always `preference.granted` for this event.
+ */
+type PreferenceGrantedEventType = "preference.granted";
+/**
+ * Payload of the preference.granted event.
+ */
+type EventPreferenceGrantedData = EventPreferenceBase;
+/**
+ * A stated preference was granted (a person consented, or a customer wrote a grant) and became the key's live statement.
+ */
+type EventPreferenceGranted = {
+  type: PreferenceGrantedEventType;
+  /**
+   * When the statement took effect (`effective_at`), not when it was recorded.
+   */
+  timestamp: string;
+  data: EventPreferenceGrantedData;
+};
+/**
+ * Always `preference.revoked` for this event.
+ */
+type PreferenceRevokedEventType = "preference.revoked";
+/**
+ * Payload of the preference.revoked event.
+ */
+type EventPreferenceRevokedData = EventPreferenceBase;
+/**
+ * A stated preference was revoked (a person opted out, or a customer wrote a revoke) and became the key's live statement.
+ */
+type EventPreferenceRevoked = {
+  type: PreferenceRevokedEventType;
+  /**
+   * When the statement took effect (`effective_at`), not when it was recorded.
+   */
+  timestamp: string;
+  data: EventPreferenceRevokedData;
+};
 /**
  * Identity fields shared by every SMS lifecycle event payload.
  */
@@ -7982,6 +8184,46 @@ type EventWhatsAppSent = {
   timestamp: string;
   data: EventWhatsAppSentData;
 };
+/**
+ * Always `whatsapp_suppression.created` for this event.
+ */
+type WhatsAppSuppressionCreatedEventType = "whatsapp_suppression.created";
+/**
+ * Payload of the whatsapp_suppression.created event.
+ */
+type EventWhatsAppSuppressionCreatedData = {
+  /**
+   * The suppression episode that was opened.
+   */
+  suppression_id: WhatsAppSuppressionId;
+  /**
+   * The suppressed WhatsApp address. For a phone number this is canonical E.164 with a leading plus sign, such as `+5511977670804`.
+   */
+  address: string;
+  /**
+   * The WhatsApp Business Account the suppression is limited to, identified by its WhatsApp-issued account ID, or null when it covers the whole workspace.
+   */
+  waba: string | null;
+  /**
+   * Why the address is suppressed. `manual` means it was added directly rather than created automatically from a delivery outcome. This list grows over time, so treat an unknown value as informational rather than rejecting the record.
+   */
+  reason: string;
+  /**
+   * The workspace the suppression belongs to.
+   */
+  workspace_id: WorkspaceId;
+};
+/**
+ * An address was added to the workspace's WhatsApp suppression ledger.
+ */
+type EventWhatsAppSuppressionCreated = {
+  type: WhatsAppSuppressionCreatedEventType;
+  /**
+   * When the episode's opening statement took effect (`effective_at`).
+   */
+  timestamp: string;
+  data: EventWhatsAppSuppressionCreatedData;
+};
 /**
  * Physical type of a phone number. New number types may be added over time, so treat unrecognized values as supported types rather than errors.
  */
@@ -8602,6 +8844,58 @@ type UpdateContactData = {
   query?: never;
   url: "/v1/contacts/{contact_id}";
 };
+type ListContactPreferencesData = {
+  body?: never;
+  path: {
+    /**
+     * ID of the contact.
+     */
+    contact_id: ContactId;
+  };
+  query?: {
+    /**
+     * Maximum number of items to return per page.
+     */
+    limit?: number;
+    /**
+     * Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.
+     */
+    starting_after?: string;
+    /**
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
+     */
+    ending_before?: string;
+  };
+  url: "/v1/contacts/{contact_id}/preferences";
+};
+type ListPreferencesData = {
+  body?: never;
+  path?: never;
+  query?: {
+    /**
+     * Return only preferences on this channel.
+     */
+    channel?: PreferenceChannel$1;
+    /**
+     * Return only preferences for this exact handle: an email address or an E.164 phone number. Requires `channel`, since a handle only means something on its channel.
+     *
+     */
+    handle?: string;
+    /**
+     * Maximum number of items to return per page.
+     */
+    limit?: number;
+    /**
+     * Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.
+     */
+    starting_after?: string;
+    /**
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
+     */
+    ending_before?: string;
+  };
+  url: "/v1/preferences";
+};
 type ListContactPropertiesData = {
   body?: never;
   path?: never;
@@ -12268,7 +12562,7 @@ type ContactListQuery = NonNullable<ListContactsData["query"]>;
 type ContactCreateParams = NonNullable<CreateContactData["body"]>;
 type ContactUpdateParams = NonNullable<UpdateContactData["body"]>;
 type ContactBatchParams = NonNullable<CreateContactBatchData["body"]>;
-declare class ContactsResource extends Resource {
+declare class ContactsResourceBase extends Resource {
   /**
    * List the workspace's contacts as a cursor page, newest first. Look one up by exact email, phone_number, or external_id, repeating phone_number to resolve up to 50 numbers in one call (raise limit to match), or search by email, name, or phone substring. Pass include_total for a total count.
    *
@@ -12329,6 +12623,104 @@ declare class ContactsResource extends Resource {
   batch(params: ContactBatchParams, options?: RequestOptions): APIPromise<ContactUpsertResult>;
 }
 //#endregion
+//#region src/resources/contactsPreferences.gen.d.ts
+type ContactsPreferencesListQuery = NonNullable<ListContactPreferencesData["query"]>;
+declare class ContactsPreferencesResource extends Resource {
+  /**
+   * List the recorded messaging preferences for a contact's own handles (their email address and phone number) across every channel, as a cursor page.
+   *
+   * @example List a contact's own preferences
+   * for await (const preference of bird.contacts.preferences.list(
+   *   "con_01krdgeqcxet5s7t44vh8rt9mg",
+   * )) {
+   *   console.log(preference.channel, preference.status);
+   * }
+   */
+  list(contactId: string, query?: ContactsPreferencesListQuery, options?: RequestOptions): PaginatedPromise<Preference>;
+}
+//#endregion
+//#region src/resources/contacts.d.ts
+declare class ContactsResource extends ContactsResourceBase {
+  /** A contact's own preferences across every channel — `bird.contacts.preferences.list(contactId)`. */
+  readonly preferences: ContactsPreferencesResource;
+  constructor(core: ConstructorParameters<typeof Resource>[0], client: ConstructorParameters<typeof Resource>[1]);
+}
+//#endregion
+//#region src/resources/preferences.gen.d.ts
+type PreferencesListQuery = NonNullable<ListPreferencesData["query"]>;
+declare class PreferencesResourceBase extends Resource {
+  /**
+   * List the workspace's stated messaging preferences (consent grants and opt-outs) as a cursor page. Filter by channel, and by handle within a channel, to look up one person before messaging them.
+   *
+   * @example List stated preferences for a channel
+   * for await (const preference of bird.preferences.list({ channel: "sms" })) {
+   *   console.log(preference.handle, preference.status);
+   * }
+   */
+  list(query?: PreferencesListQuery, options?: RequestOptions): PaginatedPromise<Preference>;
+  /**
+   * Read one recorded preference by ID: the channel and handle it is about, whether it grants or revokes, how much traffic it covers, and where the statement came from.
+   *
+   * @example Read one preference
+   * const preference = await bird.preferences.get(
+   *   "prf_01krdgeqcxet5s7t44vh8rt9mg",
+   * );
+   * console.log(preference.status, preference.coverage);
+   */
+  get(preferenceId: string, options?: RequestOptions): APIPromise<Preference>;
+}
+//#endregion
+//#region src/resources/preferences.d.ts
+/**
+ * Body for `bird.preferences.create` — one statement for a handle on one
+ * channel. Wire data is snake_case verbatim; `consented_at` is the one
+ * relaxation, accepting a `Date` (serialized with `toISOString()`) alongside
+ * the wire's RFC 3339 string.
+ */
+type PreferenceCreateParams = Omit<PreferenceCreate, "consented_at"> & {
+  /**
+   * When the person consented, on a `granted` statement. Required evidence
+   * when granting over a stored opt-out: the grant applies only if this is
+   * later than the opt-out it reverses. May not be in the future.
+   */
+  consented_at?: Date | string;
+};
+declare class PreferencesResource extends PreferencesResourceBase {
+  /**
+   * Record one preference statement — a grant or an opt-out — for a handle on
+   * one channel. Writing is an upsert by key (channel, handle, and optional
+   * sender scope): statements are causally ordered, so one dated older than
+   * the key's current statement is refused and returned with `applied:
+   * false` rather than applied out of order. A `201` (the key had no record)
+   * and a `200` (the key already had one) return the same shape either way.
+   *
+   * @example Record a stated opt-out
+   * const result = await bird.preferences.create({
+   *   channel: "sms",
+   *   handle: "+15550001234",
+   *   status: "revoked",
+   * });
+   * console.log(result.applied, result.preference?.id);
+   */
+  create(params: PreferenceCreateParams, options?: RequestOptions): APIPromise<PreferenceWriteResult>;
+  /**
+   * Delete a preference, returning its key to having no record. Never void:
+   * the delete is ordered like any statement, so a `200` with `applied:
+   * false` means a newer statement survived and is returned in `preference`
+   * rather than deleted. A statement the person made themselves — an
+   * unsubscribe link, a stop keyword — cannot be deleted this way; record a
+   * `granted` statement with `consented_at` evidence to restore messaging
+   * instead.
+   *
+   * @example Delete a preference
+   * const result = await bird.preferences.delete("prf_01krdgeqcxet5s7t44vh8rt9mg");
+   * if (!result.applied) {
+   *   console.log("refused — a newer statement survived:", result.preference?.status);
+   * }
+   */
+  delete(preferenceId: string, options?: RequestOptions): APIPromise<PreferenceWriteResult>;
+}
+//#endregion
 //#region src/resources/sms.gen.d.ts
 type SmsListQuery = NonNullable<ListSmsMessagesData["query"]>;
 type SmsListEventsQuery = NonNullable<ListSmsMessageEventsData["query"]>;
@@ -13276,6 +13668,8 @@ declare class BirdClient<const O extends BirdClientOptions = BirdClientOptions>
   readonly verify: VerifyResource;
   /** Contacts: `bird.contacts.create(...)`, `.list(...)`, `.get(...)`, `.batch(...)`, … */
   readonly contacts: ContactsResource;
+  /** Preferences: `bird.preferences.list(...)`, `.get(...)`, `.create(...)`, `.delete(...)`. */
+  readonly preferences: PreferencesResource;
   /** Audiences: `bird.audiences.create(...)`, `.list(...)`, `.addContacts(...)`, … */
   readonly audiences: AudiencesResource;
   /** Contact properties: `bird.contactProperties.create(...)`, `.list(...)`, `.archive(...)`, … */
@@ -13343,6 +13737,9 @@ declare const WebhookEventType: {
   readonly EmailScheduled: "email.scheduled";
   readonly EmailSuppressionCreated: "email_suppression.created";
   readonly EmailUnsubscribed: "email.unsubscribed";
+  readonly PreferenceDeleted: "preference.deleted";
+  readonly PreferenceGranted: "preference.granted";
+  readonly PreferenceRevoked: "preference.revoked";
   readonly SmsAccepted: "sms.accepted";
   readonly SmsDelivered: "sms.delivered";
   readonly SmsExpired: "sms.expired";
@@ -13368,6 +13765,7 @@ declare const WebhookEventType: {
   readonly WhatsappReceived: "whatsapp.received";
   readonly WhatsappRejected: "whatsapp.rejected";
   readonly WhatsappSent: "whatsapp.sent";
+  readonly WhatsappSuppressionCreated: "whatsapp_suppression.created";
 };
 /** A known webhook event type value. */
 type WebhookEventTypeValue = (typeof WebhookEventType)[keyof typeof WebhookEventType];
@@ -13497,6 +13895,34 @@ declare const NumbersOrderStatus: {
 };
 /** A known NumbersOrderStatus value. */
 type NumbersOrderStatusValue = (typeof NumbersOrderStatus)[keyof typeof NumbersOrderStatus];
+/**
+ * Values of PreferenceChannel known at this SDK version. The wire value is an open
+ * string: a value added by a newer server deserializes unchanged, so switch on
+ * these with a `default` branch rather than treating the set as closed.
+ */
+declare const PreferenceChannel: {
+  readonly Email: "email";
+  readonly Sms: "sms";
+  readonly Whatsapp: "whatsapp";
+};
+/** A known PreferenceChannel value. */
+type PreferenceChannelValue = (typeof PreferenceChannel)[keyof typeof PreferenceChannel];
+/**
+ * Values of PreferenceOrigin known at this SDK version. The wire value is an open
+ * string: a value added by a newer server deserializes unchanged, so switch on
+ * these with a `default` branch rather than treating the set as closed.
+ */
+declare const PreferenceOrigin: {
+  readonly ApiKey: "api_key";
+  readonly Import: "import";
+  readonly Keyword: "keyword";
+  readonly PreferencePage: "preference_page";
+  readonly UnsubscribeEvent: "unsubscribe_event";
+  readonly UnsubscribeLink: "unsubscribe_link";
+  readonly User: "user";
+};
+/** A known PreferenceOrigin value. */
+type PreferenceOriginValue = (typeof PreferenceOrigin)[keyof typeof PreferenceOrigin];
 /**
  * Values of SMSErrorCode known at this SDK version. The wire value is an open
  * string: a value added by a newer server deserializes unchanged, so switch on
@@ -13710,5 +14136,5 @@ declare const WhatsAppTemplateParameterType: {
 /** A known WhatsAppTemplateParameterType value. */
 type WhatsAppTemplateParameterTypeValue = (typeof WhatsAppTemplateParameterType)[keyof typeof WhatsAppTemplateParameterType];
 //#endregion
-export { type APIPromise, type Audience, type AudienceAddContactsParams, type AudienceCreateParams, type AudienceListContactsQuery, type AudienceListQuery, type AudienceMember, type AudienceRemoveContactsParams, type AudienceUpdateParams, BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, type BirdClientOptions, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, type BirdRequest, type BirdResponse, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, type BirdWebhookEvent, BirdWebhookVerificationError, type ChannelAuthorization, type Contact, type ContactBatchParams, type ContactCreateParams, type ContactListQuery, type ContactProperty, type ContactPropertyCreateParams, type ContactPropertyListQuery, type ContactPropertyUpdateParams, type ContactUpdateParams, type ContactUpsertResult, type CursorPage, type DnsRecord, type Domain, type DomainCapabilities, type DomainCreateParams, type DomainDkim, type DomainListQuery, type DomainUpdateParams, type EmailChannelDefaults, EmailEventType, type EmailEventTypeValue, type EmailListQuery, type EmailLookup, EmailLookupFlag, type EmailLookupFlagValue, EmailLookupReason, type EmailLookupReasonValue, EmailLookupResult, type EmailLookupResultValue, type EmailMailboxLabelList, type EmailMailboxesCreateParams, type EmailMailboxesListQuery, type EmailMailboxesMessagesCreateParams, type EmailMailboxesReceiveRulesCreateParams, type EmailMailboxesReceiveRulesListQuery, type EmailMailboxesStatsQuery, type EmailMailboxesUpdateParams, type EmailMailboxesUpdateQuery, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type EmailStatsByBounceCodeQuery, type EmailStatsByBounceCodeResponse, type EmailStatsByBroadcastQuery, type EmailStatsByBroadcastResponse, type EmailStatsByCategoryQuery, type EmailStatsByCategoryResponse, type EmailStatsByClientQuery, type EmailStatsByClientResponse, type EmailStatsByComplaintTypeQuery, type EmailStatsByComplaintTypeResponse, type EmailStatsByLocationQuery, type EmailStatsByLocationResponse, type EmailStatsByMailboxProviderQuery, type EmailStatsByMailboxProviderRegionQuery, type EmailStatsByMailboxProviderRegionResponse, type EmailStatsByMailboxProviderResponse, type EmailStatsByRecipientDomainQuery, type EmailStatsByRecipientDomainResponse, type EmailStatsBySendingDomainQuery, type EmailStatsBySendingDomainResponse, type EmailStatsBySendingIpQuery, type EmailStatsBySendingIpResponse, type EmailStatsByTagQuery, type EmailStatsByTemplateQuery, type EmailStatsByTemplateResponse, type EmailStatsDailyQuery, type EmailStatsHourlyQuery, type EmailStatsResponse, type EmailStatsSummary, type EmailStatsSummaryQuery, type EmailStatsTagsResponse, type EmailThread, type EmailThreadMessage, type EmailThreadMessageAttachmentList, type EmailThreadMessageBody, type EmailThreadsDeleteQuery, type EmailThreadsListQuery, type EmailThreadsMessagesListQuery, type EmailThreadsMessagesReplyParams, type EmailThreadsUpdateParams, type ErrorDetail, type LookupEmailParams, LookupFlag, type LookupFlagValue, type LookupPhoneNumberParams, LookupPropertyStatus, type LookupPropertyStatusValue, type Mailbox, type MailboxStatsResponse, type NextAction, NumberCapability, type NumberCapabilityValue, NumberType, type NumberTypeValue, NumbersOrderStatus, type NumbersOrderStatusValue, type PaginatedPromise, type PhoneNumberLookup, type RealtimeBatchPublishResult, type RealtimeChannelGetQuery, type RealtimeChannelInclude, type RealtimeChannelInfo, type RealtimeChannelListItem, type RealtimeChannelListQuery, type RealtimeChannelMember, type RealtimeChannelMembers, type RealtimeChannelsList, type RealtimeOptions, type RealtimePublishBatchParams, type RealtimePublishParams, type RealtimePublishResult, type ReceiveRule, type RequestOptions, SMSErrorCode, type SMSErrorCodeValue, SMSKeywordOperation, type SMSKeywordOperationValue, SMSSuppressionCoverage, type SMSSuppressionCoverageValue, SMSSuppressionEndReason, type SMSSuppressionEndReasonValue, SMSSuppressionOrigin, type SMSSuppressionOriginValue, SMSSuppressionReason, type SMSSuppressionReasonValue, type SafeResult, type SmsEventList, type SmsInboundStatsByCountryResponse, type SmsInboundStatsByNumberResponse, type SmsInboundStatsByOperatorResponse, type SmsInboundStatsResponse, type SmsInboundStatsSummaryResponse, type SmsKeywordRule, type SmsKeywordRuleList, type SmsKeywordRulesCreateParams, type SmsKeywordRulesListQuery, type SmsKeywordRulesUpdateParams, type SmsListEventsQuery, type SmsListQuery, type SmsMessage, type SmsSendBatchParams, type SmsSendBatchResult, type SmsSendParams, type SmsStatsByCarrierQuery, type SmsStatsByCarrierResponse, type SmsStatsByCategoryQuery, type SmsStatsByCategoryResponse, type SmsStatsByCountryQuery, type SmsStatsByCountryResponse, type SmsStatsByErrorCodeQuery, type SmsStatsByErrorCodeResponse, type SmsStatsByOriginatorQuery, type SmsStatsByOriginatorResponse, type SmsStatsByStatusQuery, type SmsStatsByStatusResponse, type SmsStatsDailyQuery, type SmsStatsHourlyQuery, type SmsStatsInboundByCountryQuery, type SmsStatsInboundByNumberQuery, type SmsStatsInboundByOperatorQuery, type SmsStatsInboundDailyQuery, type SmsStatsInboundHourlyQuery, type SmsStatsInboundSummaryQuery, type SmsStatsResponse, type SmsStatsSummary, type SmsStatsSummaryQuery, type SmsSuppression, type SmsSuppressionsAddParams, type SmsSuppressionsListQuery, type SmsTemplate, type SmsTemplateList, type SmsTemplateListQuery, TemplateLanguageStatus, type TemplateLanguageStatusValue, TemplateStatus, type TemplateStatusValue, type Verification, VerificationAttemptFailureReason, type VerificationAttemptFailureReasonValue, VerificationChannel, type VerificationChannelValue, type VerificationCheckResult, VerificationTerminalReason, type VerificationTerminalReasonValue, type VerifyVerificationsCheckParams, type VerifyVerificationsCreateParams, type VerifyVerificationsNextChannelParams, WebhookEventType, type WebhookEventTypeValue, type WebhookHeaders, type WebhookOptions, WhatsAppErrorCode, type WhatsAppErrorCodeValue, type WhatsAppEventList, WhatsAppEventType, type WhatsAppEventTypeValue, type WhatsAppMessage, WhatsAppTemplateCategory, type WhatsAppTemplateCategoryValue, WhatsAppTemplateParameterType, type WhatsAppTemplateParameterTypeValue, type WhatsappListEventsQuery, type WhatsappListQuery, type WhatsappSendParams, baseUrlForRegion, regionFromApiKey };
+export { type APIPromise, type Audience, type AudienceAddContactsParams, type AudienceCreateParams, type AudienceListContactsQuery, type AudienceListQuery, type AudienceMember, type AudienceRemoveContactsParams, type AudienceUpdateParams, BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, type BirdClientOptions, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, type BirdRequest, type BirdResponse, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, type BirdWebhookEvent, BirdWebhookVerificationError, type ChannelAuthorization, type Contact, type ContactBatchParams, type ContactCreateParams, type ContactListQuery, type ContactProperty, type ContactPropertyCreateParams, type ContactPropertyListQuery, type ContactPropertyUpdateParams, type ContactUpdateParams, type ContactUpsertResult, type ContactsPreferencesListQuery, type CursorPage, type DnsRecord, type Domain, type DomainCapabilities, type DomainCreateParams, type DomainDkim, type DomainListQuery, type DomainUpdateParams, type EmailChannelDefaults, EmailEventType, type EmailEventTypeValue, type EmailListQuery, type EmailLookup, EmailLookupFlag, type EmailLookupFlagValue, EmailLookupReason, type EmailLookupReasonValue, EmailLookupResult, type EmailLookupResultValue, type EmailMailboxLabelList, type EmailMailboxesCreateParams, type EmailMailboxesListQuery, type EmailMailboxesMessagesCreateParams, type EmailMailboxesReceiveRulesCreateParams, type EmailMailboxesReceiveRulesListQuery, type EmailMailboxesStatsQuery, type EmailMailboxesUpdateParams, type EmailMailboxesUpdateQuery, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type EmailStatsByBounceCodeQuery, type EmailStatsByBounceCodeResponse, type EmailStatsByBroadcastQuery, type EmailStatsByBroadcastResponse, type EmailStatsByCategoryQuery, type EmailStatsByCategoryResponse, type EmailStatsByClientQuery, type EmailStatsByClientResponse, type EmailStatsByComplaintTypeQuery, type EmailStatsByComplaintTypeResponse, type EmailStatsByLocationQuery, type EmailStatsByLocationResponse, type EmailStatsByMailboxProviderQuery, type EmailStatsByMailboxProviderRegionQuery, type EmailStatsByMailboxProviderRegionResponse, type EmailStatsByMailboxProviderResponse, type EmailStatsByRecipientDomainQuery, type EmailStatsByRecipientDomainResponse, type EmailStatsBySendingDomainQuery, type EmailStatsBySendingDomainResponse, type EmailStatsBySendingIpQuery, type EmailStatsBySendingIpResponse, type EmailStatsByTagQuery, type EmailStatsByTemplateQuery, type EmailStatsByTemplateResponse, type EmailStatsDailyQuery, type EmailStatsHourlyQuery, type EmailStatsResponse, type EmailStatsSummary, type EmailStatsSummaryQuery, type EmailStatsTagsResponse, type EmailThread, type EmailThreadMessage, type EmailThreadMessageAttachmentList, type EmailThreadMessageBody, type EmailThreadsDeleteQuery, type EmailThreadsListQuery, type EmailThreadsMessagesListQuery, type EmailThreadsMessagesReplyParams, type EmailThreadsUpdateParams, type ErrorDetail, type LookupEmailParams, LookupFlag, type LookupFlagValue, type LookupPhoneNumberParams, LookupPropertyStatus, type LookupPropertyStatusValue, type Mailbox, type MailboxStatsResponse, type NextAction, NumberCapability, type NumberCapabilityValue, NumberType, type NumberTypeValue, NumbersOrderStatus, type NumbersOrderStatusValue, type PaginatedPromise, type PhoneNumberLookup, type Preference, PreferenceChannel, type PreferenceChannelValue, type PreferenceCoverage, type PreferenceCreateParams, PreferenceOrigin, type PreferenceOriginValue, type PreferenceStatus, type PreferenceWriteResult, type PreferencesListQuery, type RealtimeBatchPublishResult, type RealtimeChannelGetQuery, type RealtimeChannelInclude, type RealtimeChannelInfo, type RealtimeChannelListItem, type RealtimeChannelListQuery, type RealtimeChannelMember, type RealtimeChannelMembers, type RealtimeChannelsList, type RealtimeOptions, type RealtimePublishBatchParams, type RealtimePublishParams, type RealtimePublishResult, type ReceiveRule, type RequestOptions, SMSErrorCode, type SMSErrorCodeValue, SMSKeywordOperation, type SMSKeywordOperationValue, SMSSuppressionCoverage, type SMSSuppressionCoverageValue, SMSSuppressionEndReason, type SMSSuppressionEndReasonValue, SMSSuppressionOrigin, type SMSSuppressionOriginValue, SMSSuppressionReason, type SMSSuppressionReasonValue, type SafeResult, type SmsEventList, type SmsInboundStatsByCountryResponse, type SmsInboundStatsByNumberResponse, type SmsInboundStatsByOperatorResponse, type SmsInboundStatsResponse, type SmsInboundStatsSummaryResponse, type SmsKeywordRule, type SmsKeywordRuleList, type SmsKeywordRulesCreateParams, type SmsKeywordRulesListQuery, type SmsKeywordRulesUpdateParams, type SmsListEventsQuery, type SmsListQuery, type SmsMessage, type SmsSendBatchParams, type SmsSendBatchResult, type SmsSendParams, type SmsStatsByCarrierQuery, type SmsStatsByCarrierResponse, type SmsStatsByCategoryQuery, type SmsStatsByCategoryResponse, type SmsStatsByCountryQuery, type SmsStatsByCountryResponse, type SmsStatsByErrorCodeQuery, type SmsStatsByErrorCodeResponse, type SmsStatsByOriginatorQuery, type SmsStatsByOriginatorResponse, type SmsStatsByStatusQuery, type SmsStatsByStatusResponse, type SmsStatsDailyQuery, type SmsStatsHourlyQuery, type SmsStatsInboundByCountryQuery, type SmsStatsInboundByNumberQuery, type SmsStatsInboundByOperatorQuery, type SmsStatsInboundDailyQuery, type SmsStatsInboundHourlyQuery, type SmsStatsInboundSummaryQuery, type SmsStatsResponse, type SmsStatsSummary, type SmsStatsSummaryQuery, type SmsSuppression, type SmsSuppressionsAddParams, type SmsSuppressionsListQuery, type SmsTemplate, type SmsTemplateList, type SmsTemplateListQuery, TemplateLanguageStatus, type TemplateLanguageStatusValue, TemplateStatus, type TemplateStatusValue, type Verification, VerificationAttemptFailureReason, type VerificationAttemptFailureReasonValue, VerificationChannel, type VerificationChannelValue, type VerificationCheckResult, VerificationTerminalReason, type VerificationTerminalReasonValue, type VerifyVerificationsCheckParams, type VerifyVerificationsCreateParams, type VerifyVerificationsNextChannelParams, WebhookEventType, type WebhookEventTypeValue, type WebhookHeaders, type WebhookOptions, WhatsAppErrorCode, type WhatsAppErrorCodeValue, type WhatsAppEventList, WhatsAppEventType, type WhatsAppEventTypeValue, type WhatsAppMessage, WhatsAppTemplateCategory, type WhatsAppTemplateCategoryValue, WhatsAppTemplateParameterType, type WhatsAppTemplateParameterTypeValue, type WhatsappListEventsQuery, type WhatsappListQuery, type WhatsappSendParams, baseUrlForRegion, regionFromApiKey };
 //# sourceMappingURL=index.d.mts.map