@zernio/node 0.2.547 → 0.2.549

package/dist/index.d.mts

@@ -1800,7 +1800,7 @@ type AdEngagementCounts = {
      */
     videoViews?: number;
     /**
-     * Attributed link clicks (`link_click`). This is the attribution-window count, which differs from the in-session `inline_link_clicks` reported by `GET /v1/ads/{adId}/analytics`.
+     * Attributed link clicks (`link_click`). This is the attribution-window count, which differs from the in-session count in the sibling `inlineLinkClicks` field.
      */
     linkClicks?: number;
 };
@@ -1925,6 +1925,36 @@ type AdMetrics = {
      * Return on ad spend — derived as `purchaseValue / spend`. 0 when `spend` is 0. Equivalent to Meta's `purchase_roas` under default attribution. At ad-set and campaign levels this is recomputed from summed purchaseValue + spend (NOT averaged across children) so it's mathematically correct at every rollup level.
      */
     roas?: number;
+    /**
+     * Derived `spend / actions[type]` for every action type with a non-zero count, in ad-account native currency. Same keys as `actions`. Rounded to 4 decimals because cheap actions cost well under a cent. Recomputed from summed spend + counts at every rollup level. Empty object when spend is 0 or no actions are reported.
+     */
+    costPerAction?: {
+        [key: string]: (number);
+    };
+    /**
+     * Clicks leading off Meta's surfaces to the advertiser's destination. Meta-only; other platforms report 0.
+     */
+    outboundClicks?: number;
+    /**
+     * Derived `outboundClicks / impressions * 100`, recomputed from sums at every rollup level.
+     */
+    outboundClicksCtr?: number;
+    /**
+     * In-session link clicks. Differs from the attributed `link_click` count in `actions`/`engagementBreakdown.linkClicks`, which uses the attribution window. Meta-only.
+     */
+    inlineLinkClicks?: number;
+    /**
+     * Derived `inlineLinkClicks / impressions * 100`, recomputed from sums at every rollup level.
+     */
+    inlineLinkClickCtr?: number;
+    /**
+     * People who clicked at least once. NOT additive: summed across days/children it overcounts people who clicked on multiple days or ads, so treat rollups as an upper bound (same caveat as `reach`). Meta-only.
+     */
+    uniqueClicks?: number;
+    /**
+     * Derived `uniqueClicks / impressions * 100` (NOT Meta's reach-based unique_ctr). Inherits the non-additivity caveat of `uniqueClicks`.
+     */
+    uniqueCtr?: number;
     /**
      * Number of times the video started playing, summed over the date range and across children at ad-set/campaign level. 0 for non-video ads. Sources: Meta `video_play_actions`, TikTok `video_play_actions`.
      */
@@ -8201,7 +8231,7 @@ type WebhookPayloadMessageSent = {
         sender: {
             id: string;
             /**
-             * Zernio CRM Contact id for this sender, when one exists.
+             * Always omitted on this event: the sender is the business, not a contact. Use conversation.contactId to join back to the CRM Contact.
              */
             contactId?: string;
             name?: string;
@@ -24288,6 +24318,9 @@ type ListContactsData = {
          * Filter by profile. Omit to list across all profiles. Matches the profile recorded on the contact itself, which is set when the contact is created and is independent of the profile its account currently belongs to. Filter by accountId to list a contact through its channel instead.
          */
         profileId?: string;
+        /**
+         * Case-insensitive substring match on the contact name, email and company. Phone numbers and other platform identifiers are not matched: they live on the contact channel, not on the contact. To reach a contact from an inbox webhook, use the conversation.contactId it already carries.
+         */
         search?: string;
         skip?: number;
         tag?: string;

package/dist/index.d.ts

@@ -1800,7 +1800,7 @@ type AdEngagementCounts = {
      */
     videoViews?: number;
     /**
-     * Attributed link clicks (`link_click`). This is the attribution-window count, which differs from the in-session `inline_link_clicks` reported by `GET /v1/ads/{adId}/analytics`.
+     * Attributed link clicks (`link_click`). This is the attribution-window count, which differs from the in-session count in the sibling `inlineLinkClicks` field.
      */
     linkClicks?: number;
 };
@@ -1925,6 +1925,36 @@ type AdMetrics = {
      * Return on ad spend — derived as `purchaseValue / spend`. 0 when `spend` is 0. Equivalent to Meta's `purchase_roas` under default attribution. At ad-set and campaign levels this is recomputed from summed purchaseValue + spend (NOT averaged across children) so it's mathematically correct at every rollup level.
      */
     roas?: number;
+    /**
+     * Derived `spend / actions[type]` for every action type with a non-zero count, in ad-account native currency. Same keys as `actions`. Rounded to 4 decimals because cheap actions cost well under a cent. Recomputed from summed spend + counts at every rollup level. Empty object when spend is 0 or no actions are reported.
+     */
+    costPerAction?: {
+        [key: string]: (number);
+    };
+    /**
+     * Clicks leading off Meta's surfaces to the advertiser's destination. Meta-only; other platforms report 0.
+     */
+    outboundClicks?: number;
+    /**
+     * Derived `outboundClicks / impressions * 100`, recomputed from sums at every rollup level.
+     */
+    outboundClicksCtr?: number;
+    /**
+     * In-session link clicks. Differs from the attributed `link_click` count in `actions`/`engagementBreakdown.linkClicks`, which uses the attribution window. Meta-only.
+     */
+    inlineLinkClicks?: number;
+    /**
+     * Derived `inlineLinkClicks / impressions * 100`, recomputed from sums at every rollup level.
+     */
+    inlineLinkClickCtr?: number;
+    /**
+     * People who clicked at least once. NOT additive: summed across days/children it overcounts people who clicked on multiple days or ads, so treat rollups as an upper bound (same caveat as `reach`). Meta-only.
+     */
+    uniqueClicks?: number;
+    /**
+     * Derived `uniqueClicks / impressions * 100` (NOT Meta's reach-based unique_ctr). Inherits the non-additivity caveat of `uniqueClicks`.
+     */
+    uniqueCtr?: number;
     /**
      * Number of times the video started playing, summed over the date range and across children at ad-set/campaign level. 0 for non-video ads. Sources: Meta `video_play_actions`, TikTok `video_play_actions`.
      */
@@ -8201,7 +8231,7 @@ type WebhookPayloadMessageSent = {
         sender: {
             id: string;
             /**
-             * Zernio CRM Contact id for this sender, when one exists.
+             * Always omitted on this event: the sender is the business, not a contact. Use conversation.contactId to join back to the CRM Contact.
              */
             contactId?: string;
             name?: string;
@@ -24288,6 +24318,9 @@ type ListContactsData = {
          * Filter by profile. Omit to list across all profiles. Matches the profile recorded on the contact itself, which is set when the contact is created and is independent of the profile its account currently belongs to. Filter by accountId to list a contact through its channel instead.
          */
         profileId?: string;
+        /**
+         * Case-insensitive substring match on the contact name, email and company. Phone numbers and other platform identifiers are not matched: they live on the contact channel, not on the contact. To reach a contact from an inbox webhook, use the conversation.contactId it already carries.
+         */
         search?: string;
         skip?: number;
         tag?: string;

package/dist/index.js

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.547",
+  version: "0.2.549",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/dist/index.mjs

@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.547",
+  version: "0.2.549",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/package.json

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

package/src/generated/sdk.gen.ts

@@ -6311,7 +6311,7 @@ export const listWhatsAppFlowResponses = <ThrowOnError extends boolean = false>(
 
 /**
  * List contacts
- * List and search contacts for a profile. Supports filtering by tags, platform, subscription status, and full-text search.
+ * List and search contacts for a profile. Supports filtering by tags, platform, subscription status, and text search on name, email and company.
  */
 export const listContacts = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<ListContactsData, ThrowOnError>) => {
     return (options?.client ?? client).get<ListContactsResponse, ListContactsError, ThrowOnError>({

package/src/generated/types.gen.ts

@@ -547,7 +547,7 @@ export type AdEngagementCounts = {
      */
     videoViews?: number;
     /**
-     * Attributed link clicks (`link_click`). This is the attribution-window count, which differs from the in-session `inline_link_clicks` reported by `GET /v1/ads/{adId}/analytics`.
+     * Attributed link clicks (`link_click`). This is the attribution-window count, which differs from the in-session count in the sibling `inlineLinkClicks` field.
      */
     linkClicks?: number;
 };
@@ -674,6 +674,36 @@ export type AdMetrics = {
      * Return on ad spend — derived as `purchaseValue / spend`. 0 when `spend` is 0. Equivalent to Meta's `purchase_roas` under default attribution. At ad-set and campaign levels this is recomputed from summed purchaseValue + spend (NOT averaged across children) so it's mathematically correct at every rollup level.
      */
     roas?: number;
+    /**
+     * Derived `spend / actions[type]` for every action type with a non-zero count, in ad-account native currency. Same keys as `actions`. Rounded to 4 decimals because cheap actions cost well under a cent. Recomputed from summed spend + counts at every rollup level. Empty object when spend is 0 or no actions are reported.
+     */
+    costPerAction?: {
+        [key: string]: (number);
+    };
+    /**
+     * Clicks leading off Meta's surfaces to the advertiser's destination. Meta-only; other platforms report 0.
+     */
+    outboundClicks?: number;
+    /**
+     * Derived `outboundClicks / impressions * 100`, recomputed from sums at every rollup level.
+     */
+    outboundClicksCtr?: number;
+    /**
+     * In-session link clicks. Differs from the attributed `link_click` count in `actions`/`engagementBreakdown.linkClicks`, which uses the attribution window. Meta-only.
+     */
+    inlineLinkClicks?: number;
+    /**
+     * Derived `inlineLinkClicks / impressions * 100`, recomputed from sums at every rollup level.
+     */
+    inlineLinkClickCtr?: number;
+    /**
+     * People who clicked at least once. NOT additive: summed across days/children it overcounts people who clicked on multiple days or ads, so treat rollups as an upper bound (same caveat as `reach`). Meta-only.
+     */
+    uniqueClicks?: number;
+    /**
+     * Derived `uniqueClicks / impressions * 100` (NOT Meta's reach-based unique_ctr). Inherits the non-additivity caveat of `uniqueClicks`.
+     */
+    uniqueCtr?: number;
     /**
      * Number of times the video started playing, summed over the date range and across children at ad-set/campaign level. 0 for non-video ads. Sources: Meta `video_play_actions`, TikTok `video_play_actions`.
      */
@@ -7196,7 +7226,7 @@ export type WebhookPayloadMessageSent = {
         sender: {
             id: string;
             /**
-             * Zernio CRM Contact id for this sender, when one exists.
+             * Always omitted on this event: the sender is the business, not a contact. Use conversation.contactId to join back to the CRM Contact.
              */
             contactId?: string;
             name?: string;
@@ -24479,6 +24509,9 @@ export type ListContactsData = {
          * Filter by profile. Omit to list across all profiles. Matches the profile recorded on the contact itself, which is set when the contact is created and is independent of the profile its account currently belongs to. Filter by accountId to list a contact through its channel instead.
          */
         profileId?: string;
+        /**
+         * Case-insensitive substring match on the contact name, email and company. Phone numbers and other platform identifiers are not matched: they live on the contact channel, not on the contact. To reach a contact from an inbox webhook, use the conversation.contactId it already carries.
+         */
         search?: string;
         skip?: number;
         tag?: string;