@zernio/node 0.2.74 → 0.2.76

package/dist/index.d.mts

@@ -857,6 +857,20 @@ type AdMetrics = {
      */
     cpm?: number;
     engagement?: number;
+    /**
+     * Count of conversion events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.) over the requested date range. 0 for non-conversion campaigns or when no events have fired. Meta-only at time of writing; other platforms return 0.
+     */
+    conversions?: number;
+    /**
+     * Derived spend / conversions in the same currency as spend. 0 when conversions is 0.
+     */
+    costPerConversion?: number;
+    /**
+     * Raw per-action-type counts from Meta's Insights actions[] array, summed over the date range. Keys are Meta action_type strings (e.g. link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped). Use this to extract any conversion event (purchases, leads, add_to_cart, etc.) without relying on the derived conversions field. Empty object when no actions are reported.
+     */
+    actions?: {
+        [key: string]: (number);
+    };
     /**
      * Present on individual ads only, not on campaign aggregations
      */
@@ -1674,10 +1688,48 @@ type InboxWebhookMessage = {
         };
     }>;
     sender: {
+        /**
+         * Sender's platform identifier. For WhatsApp this is the phone number
+         * (without leading `+`) when available, otherwise the `businessScopedUserId`.
+         * For other platforms, the platform's own user ID.
+         *
+         */
         id: string;
         name?: string;
         username?: string;
         picture?: string;
+        /**
+         * WhatsApp only. Sender's phone number in E.164 format (with leading `+`).
+         *
+         * **Nullable during the BSUID rollout (April 2026+).** WhatsApp users
+         * who adopt a username can message businesses without exposing a phone
+         * number — this field is omitted for them. Match by `businessScopedUserId`
+         * instead. See `docs/whatsapp-bsuid-migration.md`.
+         *
+         */
+        phoneNumber?: (string) | null;
+        /**
+         * WhatsApp only. Business-scoped user ID (BSUID) — Meta's canonical
+         * identifier for a WhatsApp user within your business. Present when
+         * Meta includes it in the inbound payload (rollout in progress since
+         * early April 2026). **Recommended primary identity anchor** going
+         * forward; fall back to `phoneNumber` only when this field is absent.
+         *
+         */
+        businessScopedUserId?: string;
+        /**
+         * WhatsApp only. Parent BSUID for businesses with linked business
+         * portfolios. Omitted for standalone portfolios.
+         *
+         */
+        parentBusinessScopedUserId?: string;
+        /**
+         * WhatsApp only. User's WhatsApp username (e.g. `@jane`). Not a
+         * stable identifier — users can change it. Useful for display, not
+         * recommended as an identity anchor.
+         *
+         */
+        whatsappUsername?: string;
         /**
          * Instagram profile data. Only present for Instagram conversations.
          */
@@ -3003,10 +3055,50 @@ type WebhookPayloadMessage = {
             };
         }>;
         sender: {
+            /**
+             * Sender's platform identifier. For WhatsApp this is the phone
+             * number (without leading `+`) when available, otherwise the
+             * `businessScopedUserId`.
+             *
+             */
             id: string;
             name?: string;
             username?: string;
             picture?: string;
+            /**
+             * WhatsApp only. Sender's phone number in E.164 format (with leading `+`).
+             *
+             * **Nullable during the BSUID rollout (April 2026+).** WhatsApp
+             * users who adopt a username can message businesses without
+             * exposing a phone number — this field is omitted for them.
+             * Match by `businessScopedUserId` instead. See
+             * `docs/whatsapp-bsuid-migration.md`.
+             *
+             */
+            phoneNumber?: (string) | null;
+            /**
+             * WhatsApp only. Business-scoped user ID (BSUID) — Meta's canonical
+             * identifier for a WhatsApp user within your business. Present
+             * when Meta includes it in the inbound payload (rollout in
+             * progress since early April 2026). **Recommended primary identity
+             * anchor** going forward; fall back to `phoneNumber` only when
+             * this field is absent.
+             *
+             */
+            businessScopedUserId?: string;
+            /**
+             * WhatsApp only. Parent BSUID for businesses with linked business
+             * portfolios. Omitted for standalone portfolios.
+             *
+             */
+            parentBusinessScopedUserId?: string;
+            /**
+             * WhatsApp only. User's WhatsApp username (e.g. `@jane`). Not a
+             * stable identifier — users can change it. Useful for display,
+             * not recommended as an identity anchor.
+             *
+             */
+            whatsappUsername?: string;
             /**
              * Instagram profile data for the sender. Only present for Instagram conversations.
              */

package/dist/index.d.ts

@@ -857,6 +857,20 @@ type AdMetrics = {
      */
     cpm?: number;
     engagement?: number;
+    /**
+     * Count of conversion events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.) over the requested date range. 0 for non-conversion campaigns or when no events have fired. Meta-only at time of writing; other platforms return 0.
+     */
+    conversions?: number;
+    /**
+     * Derived spend / conversions in the same currency as spend. 0 when conversions is 0.
+     */
+    costPerConversion?: number;
+    /**
+     * Raw per-action-type counts from Meta's Insights actions[] array, summed over the date range. Keys are Meta action_type strings (e.g. link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped). Use this to extract any conversion event (purchases, leads, add_to_cart, etc.) without relying on the derived conversions field. Empty object when no actions are reported.
+     */
+    actions?: {
+        [key: string]: (number);
+    };
     /**
      * Present on individual ads only, not on campaign aggregations
      */
@@ -1674,10 +1688,48 @@ type InboxWebhookMessage = {
         };
     }>;
     sender: {
+        /**
+         * Sender's platform identifier. For WhatsApp this is the phone number
+         * (without leading `+`) when available, otherwise the `businessScopedUserId`.
+         * For other platforms, the platform's own user ID.
+         *
+         */
         id: string;
         name?: string;
         username?: string;
         picture?: string;
+        /**
+         * WhatsApp only. Sender's phone number in E.164 format (with leading `+`).
+         *
+         * **Nullable during the BSUID rollout (April 2026+).** WhatsApp users
+         * who adopt a username can message businesses without exposing a phone
+         * number — this field is omitted for them. Match by `businessScopedUserId`
+         * instead. See `docs/whatsapp-bsuid-migration.md`.
+         *
+         */
+        phoneNumber?: (string) | null;
+        /**
+         * WhatsApp only. Business-scoped user ID (BSUID) — Meta's canonical
+         * identifier for a WhatsApp user within your business. Present when
+         * Meta includes it in the inbound payload (rollout in progress since
+         * early April 2026). **Recommended primary identity anchor** going
+         * forward; fall back to `phoneNumber` only when this field is absent.
+         *
+         */
+        businessScopedUserId?: string;
+        /**
+         * WhatsApp only. Parent BSUID for businesses with linked business
+         * portfolios. Omitted for standalone portfolios.
+         *
+         */
+        parentBusinessScopedUserId?: string;
+        /**
+         * WhatsApp only. User's WhatsApp username (e.g. `@jane`). Not a
+         * stable identifier — users can change it. Useful for display, not
+         * recommended as an identity anchor.
+         *
+         */
+        whatsappUsername?: string;
         /**
          * Instagram profile data. Only present for Instagram conversations.
          */
@@ -3003,10 +3055,50 @@ type WebhookPayloadMessage = {
             };
         }>;
         sender: {
+            /**
+             * Sender's platform identifier. For WhatsApp this is the phone
+             * number (without leading `+`) when available, otherwise the
+             * `businessScopedUserId`.
+             *
+             */
             id: string;
             name?: string;
             username?: string;
             picture?: string;
+            /**
+             * WhatsApp only. Sender's phone number in E.164 format (with leading `+`).
+             *
+             * **Nullable during the BSUID rollout (April 2026+).** WhatsApp
+             * users who adopt a username can message businesses without
+             * exposing a phone number — this field is omitted for them.
+             * Match by `businessScopedUserId` instead. See
+             * `docs/whatsapp-bsuid-migration.md`.
+             *
+             */
+            phoneNumber?: (string) | null;
+            /**
+             * WhatsApp only. Business-scoped user ID (BSUID) — Meta's canonical
+             * identifier for a WhatsApp user within your business. Present
+             * when Meta includes it in the inbound payload (rollout in
+             * progress since early April 2026). **Recommended primary identity
+             * anchor** going forward; fall back to `phoneNumber` only when
+             * this field is absent.
+             *
+             */
+            businessScopedUserId?: string;
+            /**
+             * WhatsApp only. Parent BSUID for businesses with linked business
+             * portfolios. Omitted for standalone portfolios.
+             *
+             */
+            parentBusinessScopedUserId?: string;
+            /**
+             * WhatsApp only. User's WhatsApp username (e.g. `@jane`). Not a
+             * stable identifier — users can change it. Useful for display,
+             * not recommended as an identity anchor.
+             *
+             */
+            whatsappUsername?: string;
             /**
              * Instagram profile data for the sender. Only present for Instagram conversations.
              */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zernio/node",
-  "version": "0.2.74",
+  "version": "0.2.76",
   "description": "The official Node.js library for the Zernio API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/generated/types.gen.ts

@@ -275,6 +275,20 @@ export type AdMetrics = {
      */
     cpm?: number;
     engagement?: number;
+    /**
+     * Count of conversion events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.) over the requested date range. 0 for non-conversion campaigns or when no events have fired. Meta-only at time of writing; other platforms return 0.
+     */
+    conversions?: number;
+    /**
+     * Derived spend / conversions in the same currency as spend. 0 when conversions is 0.
+     */
+    costPerConversion?: number;
+    /**
+     * Raw per-action-type counts from Meta's Insights actions[] array, summed over the date range. Keys are Meta action_type strings (e.g. link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped). Use this to extract any conversion event (purchases, leads, add_to_cart, etc.) without relying on the derived conversions field. Empty object when no actions are reported.
+     */
+    actions?: {
+        [key: string]: (number);
+    };
     /**
      * Present on individual ads only, not on campaign aggregations
      */
@@ -1128,10 +1142,48 @@ export type InboxWebhookMessage = {
         };
     }>;
     sender: {
+        /**
+         * Sender's platform identifier. For WhatsApp this is the phone number
+         * (without leading `+`) when available, otherwise the `businessScopedUserId`.
+         * For other platforms, the platform's own user ID.
+         *
+         */
         id: string;
         name?: string;
         username?: string;
         picture?: string;
+        /**
+         * WhatsApp only. Sender's phone number in E.164 format (with leading `+`).
+         *
+         * **Nullable during the BSUID rollout (April 2026+).** WhatsApp users
+         * who adopt a username can message businesses without exposing a phone
+         * number — this field is omitted for them. Match by `businessScopedUserId`
+         * instead. See `docs/whatsapp-bsuid-migration.md`.
+         *
+         */
+        phoneNumber?: (string) | null;
+        /**
+         * WhatsApp only. Business-scoped user ID (BSUID) — Meta's canonical
+         * identifier for a WhatsApp user within your business. Present when
+         * Meta includes it in the inbound payload (rollout in progress since
+         * early April 2026). **Recommended primary identity anchor** going
+         * forward; fall back to `phoneNumber` only when this field is absent.
+         *
+         */
+        businessScopedUserId?: string;
+        /**
+         * WhatsApp only. Parent BSUID for businesses with linked business
+         * portfolios. Omitted for standalone portfolios.
+         *
+         */
+        parentBusinessScopedUserId?: string;
+        /**
+         * WhatsApp only. User's WhatsApp username (e.g. `@jane`). Not a
+         * stable identifier — users can change it. Useful for display, not
+         * recommended as an identity anchor.
+         *
+         */
+        whatsappUsername?: string;
         /**
          * Instagram profile data. Only present for Instagram conversations.
          */
@@ -2546,10 +2598,50 @@ export type WebhookPayloadMessage = {
             };
         }>;
         sender: {
+            /**
+             * Sender's platform identifier. For WhatsApp this is the phone
+             * number (without leading `+`) when available, otherwise the
+             * `businessScopedUserId`.
+             *
+             */
             id: string;
             name?: string;
             username?: string;
             picture?: string;
+            /**
+             * WhatsApp only. Sender's phone number in E.164 format (with leading `+`).
+             *
+             * **Nullable during the BSUID rollout (April 2026+).** WhatsApp
+             * users who adopt a username can message businesses without
+             * exposing a phone number — this field is omitted for them.
+             * Match by `businessScopedUserId` instead. See
+             * `docs/whatsapp-bsuid-migration.md`.
+             *
+             */
+            phoneNumber?: (string) | null;
+            /**
+             * WhatsApp only. Business-scoped user ID (BSUID) — Meta's canonical
+             * identifier for a WhatsApp user within your business. Present
+             * when Meta includes it in the inbound payload (rollout in
+             * progress since early April 2026). **Recommended primary identity
+             * anchor** going forward; fall back to `phoneNumber` only when
+             * this field is absent.
+             *
+             */
+            businessScopedUserId?: string;
+            /**
+             * WhatsApp only. Parent BSUID for businesses with linked business
+             * portfolios. Omitted for standalone portfolios.
+             *
+             */
+            parentBusinessScopedUserId?: string;
+            /**
+             * WhatsApp only. User's WhatsApp username (e.g. `@jane`). Not a
+             * stable identifier — users can change it. Useful for display,
+             * not recommended as an identity anchor.
+             *
+             */
+            whatsappUsername?: string;
             /**
              * Instagram profile data for the sender. Only present for Instagram conversations.
              */