@zernio/node 0.2.548 → 0.2.550

package/dist/index.js

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.548",
+  version: "0.2.550",
   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.548",
+  version: "0.2.550",
   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.548",
+  "version": "0.2.550",
   "description": "The official Node.js library for the Zernio API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/generated/types.gen.ts

@@ -375,6 +375,34 @@ export type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lea
 
 export type type = 'daily' | 'lifetime';
 
+export type AdAnalyticsResponse = {
+    /**
+     * Present and true while historical data is being backfilled.
+     */
+    backfillPending?: boolean;
+    ad?: {
+        id?: string;
+        name?: string;
+        platform?: string;
+        status?: string;
+        /**
+         * ISO 4217 code of the ad account that owns this ad (e.g. USD, THB, INR). All money values in `summary` and `daily` are in this currency. Null only on legacy ads synced before currency was persisted.
+         */
+        currency?: (string) | null;
+    };
+    analytics?: {
+        summary?: AdMetrics;
+        daily?: Array<(AdMetrics & {
+    date?: string;
+})>;
+        breakdowns?: {
+            [key: string]: Array<{
+                [key: string]: unknown;
+            }>;
+        };
+    };
+};
+
 /**
  * Budget amount in the ad account's native currency (see the campaign's `currency` field for the code).
  */
@@ -547,7 +575,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 +702,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`.
      */
@@ -727,8 +785,75 @@ export type AdMetrics = {
  */
 export type AdReviewStatus = 'in_review' | 'approved' | 'rejected' | 'with_issues';
 
+export type AdsListResponse = {
+    ads?: Array<Ad>;
+    pagination?: Pagination;
+    /**
+     * Present and true while historical data is being backfilled.
+     */
+    backfillPending?: boolean;
+};
+
 export type AdStatus = 'active' | 'paused' | 'pending_review' | 'rejected' | 'completed' | 'cancelled' | 'error';
 
+export type AdsTimelineResponse = {
+    /**
+     * Present and true while historical data is being backfilled.
+     */
+    backfillPending?: boolean;
+    rows?: Array<{
+        date?: string;
+        /**
+         * Native currency units (matches /ads/tree convention).
+         */
+        spend?: number;
+        impressions?: number;
+        /**
+         * Reach summed across the account's ads for this single day. A person seen by two ads the same day counts twice, and reach is de-duplicated per day only: do NOT sum it across days (people reached on multiple days would be double-counted).
+         */
+        reach?: number;
+        clicks?: number;
+        engagement?: number;
+        /**
+         * Click-through rate as a percentage (0–100).
+         */
+        ctr?: number;
+        /**
+         * Cost per click in native currency.
+         */
+        cpc?: number;
+        /**
+         * Cost per 1000 impressions in native currency.
+         */
+        cpm?: number;
+        /**
+         * Sum of conversion events over the range. Fractional values are normal (attribution splitting + Google modeled conversions). Meta: events matching the campaign optimization goal. Google: tracked conversions. X / LinkedIn: reported website/lead conversions (added 2026-07).
+         */
+        conversions?: number;
+        costPerConversion?: number;
+        /**
+         * Per-action-type counts merged across all ads on this day. Keys are platform-native action types.
+         */
+        actions?: {
+            [key: string]: (number);
+        };
+        /**
+         * Monetary mirror of `actions` in native currency.
+         */
+        actionValues?: {
+            [key: string]: (number);
+        };
+        /**
+         * Sum of purchase-type action values on this day, native currency.
+         */
+        purchaseValue?: number;
+        /**
+         * Derived purchaseValue / spend.
+         */
+        roas?: number;
+    }>;
+};
+
 /**
  * Ad set (or ad group/line item depending on platform) with rolled-up metrics and child ads
  */
@@ -906,6 +1031,15 @@ export type AdTreeCampaign = {
     daily?: Array<AdDailyMetrics>;
 };
 
+export type AdTreeResponse = {
+    campaigns?: Array<AdTreeCampaign>;
+    pagination?: Pagination;
+    /**
+     * Present and true while historical data is being backfilled.
+     */
+    backfillPending?: boolean;
+};
+
 export type AnalyticsListResponse = {
     overview?: AnalyticsOverview;
     posts?: Array<{
@@ -1391,6 +1525,37 @@ export type transcriptionLanguage = 'auto' | 'en' | 'es';
 
 export type endReason = 'hangup' | 'no_answer' | 'rejected' | 'error';
 
+export type CampaignAnalyticsResponse = {
+    /**
+     * Present and true while historical data is being backfilled.
+     */
+    backfillPending?: boolean;
+    campaign?: {
+        id?: string;
+        name?: (string) | null;
+        platform?: string;
+        /**
+         * Effective campaign status (ACTIVE when any child ad is active).
+         */
+        status?: (string) | null;
+        /**
+         * ISO 4217 code of the ad account (e.g. USD, THB). All money values in `summary` and `daily` are in this currency.
+         */
+        currency?: (string) | null;
+    };
+    analytics?: {
+        summary?: AdMetrics;
+        daily?: Array<(AdMetrics & {
+    date?: string;
+})>;
+        breakdowns?: {
+            [key: string]: Array<{
+                [key: string]: unknown;
+            }>;
+        };
+    };
+};
+
 /**
  * Who a comment automation answers. Instagram only - Meta exposes the follow
  * relationship on no other platform, and only for people who have MESSAGED the
@@ -26668,14 +26833,9 @@ export type ListAdsData = {
     };
 };
 
-export type ListAdsResponse = ({
-    ads?: Array<Ad>;
-    /**
-     * Present and true only on `202` responses: part of the requested date range is still being backfilled from the platform in the background. Retry the same request shortly; it returns 200 once the range is fully ingested.
-     */
-    backfillPending?: boolean;
-    pagination?: Pagination;
-} | unknown);
+export type ListAdsResponse = (AdsListResponse | (AdsListResponse & {
+    backfillPending: true;
+}));
 
 export type ListAdsError = (ErrorResponse | {
     error?: string;
@@ -27509,14 +27669,9 @@ export type GetAdTreeData = {
     };
 };
 
-export type GetAdTreeResponse = ({
-    campaigns?: Array<AdTreeCampaign>;
-    /**
-     * Present and true only on `202` responses: part of the requested date range is still being backfilled from the platform in the background. Retry the same request shortly; it returns 200 once the range is fully ingested.
-     */
-    backfillPending?: boolean;
-    pagination?: Pagination;
-} | unknown);
+export type GetAdTreeResponse = (AdTreeResponse | (AdTreeResponse & {
+    backfillPending: true;
+}));
 
 export type GetAdTreeError = ({
     error?: string;
@@ -27547,63 +27702,9 @@ export type GetAdsTimelineData = {
     };
 };
 
-export type GetAdsTimelineResponse = ({
-    rows?: Array<{
-        date?: string;
-        /**
-         * Native currency units (matches /ads/tree convention).
-         */
-        spend?: number;
-        impressions?: number;
-        /**
-         * Reach summed across the account's ads for this single day. A person seen by two ads the same day counts twice, and reach is de-duplicated per day only: do NOT sum it across days (people reached on multiple days would be double-counted).
-         */
-        reach?: number;
-        clicks?: number;
-        engagement?: number;
-        /**
-         * Click-through rate as a percentage (0–100).
-         */
-        ctr?: number;
-        /**
-         * Cost per click in native currency.
-         */
-        cpc?: number;
-        /**
-         * Cost per 1000 impressions in native currency.
-         */
-        cpm?: number;
-        /**
-         * Sum of conversion events over the range. Fractional values are normal (attribution splitting + Google modeled conversions). Meta: events matching the campaign optimization goal. Google: tracked conversions. X / LinkedIn: reported website/lead conversions (added 2026-07).
-         */
-        conversions?: number;
-        costPerConversion?: number;
-        /**
-         * Per-action-type counts merged across all ads on this day. Keys are platform-native action types.
-         */
-        actions?: {
-            [key: string]: (number);
-        };
-        /**
-         * Monetary mirror of `actions` in native currency.
-         */
-        actionValues?: {
-            [key: string]: (number);
-        };
-        /**
-         * Sum of purchase-type action values on this day, native currency.
-         */
-        purchaseValue?: number;
-        /**
-         * Derived purchaseValue / spend.
-         */
-        roas?: number;
-    }>;
-    /**
-     * Present and true only on `202` responses: part of the requested date range is still being backfilled from the platform in the background. Retry the same request shortly; it returns 200 once the range is fully ingested.
-     */
-    backfillPending?: boolean;
-} | unknown);
+export type GetAdsTimelineResponse = (AdsTimelineResponse | (AdsTimelineResponse & {
+    backfillPending: true;
+}));
 
 export type GetAdsTimelineError = (ErrorResponse | {
     error?: string;
@@ -27797,36 +27898,9 @@ export type GetCampaignAnalyticsData = {
     };
 };
 
-export type GetCampaignAnalyticsResponse = ({
-    campaign?: {
-        id?: string;
-        name?: (string) | null;
-        platform?: string;
-        /**
-         * Effective campaign status (ACTIVE when any child ad is active).
-         */
-        status?: (string) | null;
-        /**
-         * ISO 4217 code of the ad account (e.g. USD, THB). All money values in `summary` and `daily` are in this currency.
-         */
-        currency?: (string) | null;
-    };
-    /**
-     * Present and true only on `202` responses: part of the requested date range is still being backfilled from the platform in the background. Retry the same request shortly; it returns 200 once the range is fully ingested.
-     */
-    backfillPending?: boolean;
-    analytics?: {
-        summary?: AdMetrics;
-        daily?: Array<(AdMetrics & {
-    date?: string;
-})>;
-        breakdowns?: {
-            [key: string]: Array<{
-                [key: string]: unknown;
-            }>;
-        };
-    };
-} | unknown);
+export type GetCampaignAnalyticsResponse = (CampaignAnalyticsResponse | (CampaignAnalyticsResponse & {
+    backfillPending: true;
+}));
 
 export type GetCampaignAnalyticsError = (ErrorResponse | {
     error?: string;
@@ -28250,34 +28324,9 @@ export type GetAdAnalyticsData = {
     };
 };
 
-export type GetAdAnalyticsResponse = ({
-    ad?: {
-        id?: string;
-        name?: string;
-        platform?: string;
-        trigger?: 'comment' | 'story_reply';
-        status?: string;
-        /**
-         * ISO 4217 code of the ad account that owns this ad (e.g. USD, THB, INR). All money values in `summary` and `daily` are in this currency. Null only on legacy ads synced before currency was persisted.
-         */
-        currency?: (string) | null;
-    };
-    /**
-     * Present and true only on `202` responses: part of the requested date range is still being backfilled from the platform in the background. Retry the same request shortly; it returns 200 once the range is fully ingested.
-     */
-    backfillPending?: boolean;
-    analytics?: {
-        summary?: AdMetrics;
-        daily?: Array<(AdMetrics & {
-    date?: string;
-})>;
-        breakdowns?: {
-            [key: string]: Array<{
-                [key: string]: unknown;
-            }>;
-        };
-    };
-} | unknown);
+export type GetAdAnalyticsResponse = (AdAnalyticsResponse | (AdAnalyticsResponse & {
+    backfillPending: true;
+}));
 
 export type GetAdAnalyticsError = (ErrorResponse | {
     error?: string;