@getlatedev/node 0.2.1134 → 0.2.1136

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -2750,10 +2750,12 @@ type AdEngagementCounts = {
2750
2750
  * priority order backs `conversions`, so a purchase-optimised campaign
2751
2751
  * reports the identical number in `conversions` and `funnel.purchases`.
2752
2752
  *
2753
- * Every field is 0 when that step never fired. Populated for Meta ads;
2754
- * other platforms report a different action taxonomy and generally leave
2755
- * these at 0 (read `actions` for those). At ad-set and campaign level each
2756
- * step is summed from its per-ad values.
2753
+ * Every field is 0 when that step never fired. Populated for Meta ads and,
2754
+ * from 2026-10-08, TikTok (contentViews, cartAdds, checkoutsInitiated,
2755
+ * purchases = app purchases, else website complete payments, leads; the
2756
+ * other steps stay 0). Other platforms report a different action taxonomy
2757
+ * and generally leave these at 0 (read `actions` for those). At ad-set and
2758
+ * campaign level each step is summed from its per-ad values.
2757
2759
  *
2758
2760
  */
2759
2761
  type AdFunnelCounts = {
@@ -2948,19 +2950,19 @@ type AdMetrics = {
2948
2950
  */
2949
2951
  costPerConversion?: number;
2950
2952
  /**
2951
- * Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...), covering both engagement and conversion events. TikTok: pixel conversions (purchase, add_to_cart, initiate_checkout, view_content, complete_payment, lead) plus the paid-engagement family (follow, post_reaction for paid likes, comment, share). Follow is how FOLLOWERS-goal campaigns report their result. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen) plus `video_view`, which carries LinkedIn's `videoViews` under the same key every other platform uses, so it feeds `engagementBreakdown.videoViews` too; it is an engagement, NOT a conversion, and is excluded from `conversions`. Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
2953
+ * Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...), covering both engagement and conversion events. TikTok: conversion events plus the paid-engagement family (follow, post_reaction for paid likes, comment, share). Website (pixel) events: complete_payment (TikTok's website purchase, the event a SHOPPING-optimised campaign counts in `conversions`), initiate_checkout, add_to_cart, view_content, lead (website form submissions plus TikTok instant-form leads). App events: purchase, view_content (added to the website count). Follow is how FOLLOWERS-goal campaigns report their result. TikTok history note: website add_to_cart, initiate_checkout, complete_payment and lead counts were missing before 2026-10-08 (TikTok rejected the metric names we requested), and each sync re-fetches only the last 7 days, so older days keep them absent until the ad is re-synced from scratch. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen) plus `video_view`, which carries LinkedIn's `videoViews` under the same key every other platform uses, so it feeds `engagementBreakdown.videoViews` too; it is an engagement, NOT a conversion, and is excluded from `conversions`. Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
2952
2954
  */
2953
2955
  actions?: {
2954
2956
  [key: string]: (number);
2955
2957
  };
2956
2958
  /**
2957
- * Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying: values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta-only; other platforms return {}.
2959
+ * Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying: values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta and TikTok; other platforms return {}. TikTok: the value TikTok attributes to each key of `actions` (purchase and view_content from app events, complete_payment, initiate_checkout, add_to_cart, view_content and lead from the website pixel), present only when the advertiser sends a value with the event. initiate_checkout and add_to_cart values are basket values, not revenue; revenue is complete_payment (website) and purchase (app). Same history note as `actions`.
2958
2960
  */
2959
2961
  actionValues?: {
2960
2962
  [key: string]: (number);
2961
2963
  };
2962
2964
  /**
2963
- * Convenience sum of purchase-type action values, picked from `actionValues` for the ad set promoted_object event (custom conversion, custom_event_type, else PURCHASE). It matches `conversions` for conversion-optimized ad sets; when the optimization goal reports a different result (LINK_CLICKS, LANDING_PAGE_VIEWS, ...) it stays on the promoted event so ROAS keeps its purchase basis. In ad-account native currency. 0 when the campaign has no purchase event configured. Meta-only.
2965
+ * Convenience sum of purchase-type action values, picked from `actionValues` for the ad set promoted_object event (custom conversion, custom_event_type, else PURCHASE). It matches `conversions` for conversion-optimized ad sets; when the optimization goal reports a different result (LINK_CLICKS, LANDING_PAGE_VIEWS, ...) it stays on the promoted event so ROAS keeps its purchase basis. In ad-account native currency. 0 when the campaign has no purchase event configured. TikTok: app purchase value plus website complete-payment value (from 2026-10-08; older days carry the app value only). Other platforms report 0.
2964
2966
  */
2965
2967
  purchaseValue?: number;
2966
2968
  /**
@@ -28985,7 +28987,7 @@ type SendInboxMessageError = ({
28985
28987
  */
28986
28988
  type?: string;
28987
28989
  };
28988
- } | ErrorResponse | unknown | (ErrorResponse | WhatsAppTemplateLookupError) | WhatsAppTemplateLookupError);
28990
+ } | ErrorResponse | (ErrorResponse | WhatsAppTemplateLookupError) | unknown | WhatsAppTemplateLookupError);
28989
28991
  type GetWhatsAppMediaData = {
28990
28992
  path: {
28991
28993
  /**
package/dist/index.d.ts CHANGED
@@ -2750,10 +2750,12 @@ type AdEngagementCounts = {
2750
2750
  * priority order backs `conversions`, so a purchase-optimised campaign
2751
2751
  * reports the identical number in `conversions` and `funnel.purchases`.
2752
2752
  *
2753
- * Every field is 0 when that step never fired. Populated for Meta ads;
2754
- * other platforms report a different action taxonomy and generally leave
2755
- * these at 0 (read `actions` for those). At ad-set and campaign level each
2756
- * step is summed from its per-ad values.
2753
+ * Every field is 0 when that step never fired. Populated for Meta ads and,
2754
+ * from 2026-10-08, TikTok (contentViews, cartAdds, checkoutsInitiated,
2755
+ * purchases = app purchases, else website complete payments, leads; the
2756
+ * other steps stay 0). Other platforms report a different action taxonomy
2757
+ * and generally leave these at 0 (read `actions` for those). At ad-set and
2758
+ * campaign level each step is summed from its per-ad values.
2757
2759
  *
2758
2760
  */
2759
2761
  type AdFunnelCounts = {
@@ -2948,19 +2950,19 @@ type AdMetrics = {
2948
2950
  */
2949
2951
  costPerConversion?: number;
2950
2952
  /**
2951
- * Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...), covering both engagement and conversion events. TikTok: pixel conversions (purchase, add_to_cart, initiate_checkout, view_content, complete_payment, lead) plus the paid-engagement family (follow, post_reaction for paid likes, comment, share). Follow is how FOLLOWERS-goal campaigns report their result. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen) plus `video_view`, which carries LinkedIn's `videoViews` under the same key every other platform uses, so it feeds `engagementBreakdown.videoViews` too; it is an engagement, NOT a conversion, and is excluded from `conversions`. Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
2953
+ * Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...), covering both engagement and conversion events. TikTok: conversion events plus the paid-engagement family (follow, post_reaction for paid likes, comment, share). Website (pixel) events: complete_payment (TikTok's website purchase, the event a SHOPPING-optimised campaign counts in `conversions`), initiate_checkout, add_to_cart, view_content, lead (website form submissions plus TikTok instant-form leads). App events: purchase, view_content (added to the website count). Follow is how FOLLOWERS-goal campaigns report their result. TikTok history note: website add_to_cart, initiate_checkout, complete_payment and lead counts were missing before 2026-10-08 (TikTok rejected the metric names we requested), and each sync re-fetches only the last 7 days, so older days keep them absent until the ad is re-synced from scratch. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen) plus `video_view`, which carries LinkedIn's `videoViews` under the same key every other platform uses, so it feeds `engagementBreakdown.videoViews` too; it is an engagement, NOT a conversion, and is excluded from `conversions`. Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
2952
2954
  */
2953
2955
  actions?: {
2954
2956
  [key: string]: (number);
2955
2957
  };
2956
2958
  /**
2957
- * Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying: values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta-only; other platforms return {}.
2959
+ * Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying: values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta and TikTok; other platforms return {}. TikTok: the value TikTok attributes to each key of `actions` (purchase and view_content from app events, complete_payment, initiate_checkout, add_to_cart, view_content and lead from the website pixel), present only when the advertiser sends a value with the event. initiate_checkout and add_to_cart values are basket values, not revenue; revenue is complete_payment (website) and purchase (app). Same history note as `actions`.
2958
2960
  */
2959
2961
  actionValues?: {
2960
2962
  [key: string]: (number);
2961
2963
  };
2962
2964
  /**
2963
- * Convenience sum of purchase-type action values, picked from `actionValues` for the ad set promoted_object event (custom conversion, custom_event_type, else PURCHASE). It matches `conversions` for conversion-optimized ad sets; when the optimization goal reports a different result (LINK_CLICKS, LANDING_PAGE_VIEWS, ...) it stays on the promoted event so ROAS keeps its purchase basis. In ad-account native currency. 0 when the campaign has no purchase event configured. Meta-only.
2965
+ * Convenience sum of purchase-type action values, picked from `actionValues` for the ad set promoted_object event (custom conversion, custom_event_type, else PURCHASE). It matches `conversions` for conversion-optimized ad sets; when the optimization goal reports a different result (LINK_CLICKS, LANDING_PAGE_VIEWS, ...) it stays on the promoted event so ROAS keeps its purchase basis. In ad-account native currency. 0 when the campaign has no purchase event configured. TikTok: app purchase value plus website complete-payment value (from 2026-10-08; older days carry the app value only). Other platforms report 0.
2964
2966
  */
2965
2967
  purchaseValue?: number;
2966
2968
  /**
@@ -28985,7 +28987,7 @@ type SendInboxMessageError = ({
28985
28987
  */
28986
28988
  type?: string;
28987
28989
  };
28988
- } | ErrorResponse | unknown | (ErrorResponse | WhatsAppTemplateLookupError) | WhatsAppTemplateLookupError);
28990
+ } | ErrorResponse | (ErrorResponse | WhatsAppTemplateLookupError) | unknown | WhatsAppTemplateLookupError);
28989
28991
  type GetWhatsAppMediaData = {
28990
28992
  path: {
28991
28993
  /**
package/dist/index.js CHANGED
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
36
36
  // package.json
37
37
  var package_default = {
38
38
  name: "@getlatedev/node",
39
- version: "0.2.1134",
39
+ version: "0.2.1136",
40
40
  description: "The official Node.js library for the Zernio API",
41
41
  main: "dist/index.js",
42
42
  module: "dist/index.mjs",
package/dist/index.mjs CHANGED
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
5
5
  // package.json
6
6
  var package_default = {
7
7
  name: "@getlatedev/node",
8
- version: "0.2.1134",
8
+ version: "0.2.1136",
9
9
  description: "The official Node.js library for the Zernio API",
10
10
  main: "dist/index.js",
11
11
  module: "dist/index.mjs",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getlatedev/node",
3
- "version": "0.2.1134",
3
+ "version": "0.2.1136",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -771,10 +771,12 @@ export type AdEngagementCounts = {
771
771
  * priority order backs `conversions`, so a purchase-optimised campaign
772
772
  * reports the identical number in `conversions` and `funnel.purchases`.
773
773
  *
774
- * Every field is 0 when that step never fired. Populated for Meta ads;
775
- * other platforms report a different action taxonomy and generally leave
776
- * these at 0 (read `actions` for those). At ad-set and campaign level each
777
- * step is summed from its per-ad values.
774
+ * Every field is 0 when that step never fired. Populated for Meta ads and,
775
+ * from 2026-10-08, TikTok (contentViews, cartAdds, checkoutsInitiated,
776
+ * purchases = app purchases, else website complete payments, leads; the
777
+ * other steps stay 0). Other platforms report a different action taxonomy
778
+ * and generally leave these at 0 (read `actions` for those). At ad-set and
779
+ * campaign level each step is summed from its per-ad values.
778
780
  *
779
781
  */
780
782
  export type AdFunnelCounts = {
@@ -977,19 +979,19 @@ export type AdMetrics = {
977
979
  */
978
980
  costPerConversion?: number;
979
981
  /**
980
- * Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...), covering both engagement and conversion events. TikTok: pixel conversions (purchase, add_to_cart, initiate_checkout, view_content, complete_payment, lead) plus the paid-engagement family (follow, post_reaction for paid likes, comment, share). Follow is how FOLLOWERS-goal campaigns report their result. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen) plus `video_view`, which carries LinkedIn's `videoViews` under the same key every other platform uses, so it feeds `engagementBreakdown.videoViews` too; it is an engagement, NOT a conversion, and is excluded from `conversions`. Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
982
+ * Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...), covering both engagement and conversion events. TikTok: conversion events plus the paid-engagement family (follow, post_reaction for paid likes, comment, share). Website (pixel) events: complete_payment (TikTok's website purchase, the event a SHOPPING-optimised campaign counts in `conversions`), initiate_checkout, add_to_cart, view_content, lead (website form submissions plus TikTok instant-form leads). App events: purchase, view_content (added to the website count). Follow is how FOLLOWERS-goal campaigns report their result. TikTok history note: website add_to_cart, initiate_checkout, complete_payment and lead counts were missing before 2026-10-08 (TikTok rejected the metric names we requested), and each sync re-fetches only the last 7 days, so older days keep them absent until the ad is re-synced from scratch. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen) plus `video_view`, which carries LinkedIn's `videoViews` under the same key every other platform uses, so it feeds `engagementBreakdown.videoViews` too; it is an engagement, NOT a conversion, and is excluded from `conversions`. Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
981
983
  */
982
984
  actions?: {
983
985
  [key: string]: (number);
984
986
  };
985
987
  /**
986
- * Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying: values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta-only; other platforms return {}.
988
+ * Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying: values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta and TikTok; other platforms return {}. TikTok: the value TikTok attributes to each key of `actions` (purchase and view_content from app events, complete_payment, initiate_checkout, add_to_cart, view_content and lead from the website pixel), present only when the advertiser sends a value with the event. initiate_checkout and add_to_cart values are basket values, not revenue; revenue is complete_payment (website) and purchase (app). Same history note as `actions`.
987
989
  */
988
990
  actionValues?: {
989
991
  [key: string]: (number);
990
992
  };
991
993
  /**
992
- * Convenience sum of purchase-type action values, picked from `actionValues` for the ad set promoted_object event (custom conversion, custom_event_type, else PURCHASE). It matches `conversions` for conversion-optimized ad sets; when the optimization goal reports a different result (LINK_CLICKS, LANDING_PAGE_VIEWS, ...) it stays on the promoted event so ROAS keeps its purchase basis. In ad-account native currency. 0 when the campaign has no purchase event configured. Meta-only.
994
+ * Convenience sum of purchase-type action values, picked from `actionValues` for the ad set promoted_object event (custom conversion, custom_event_type, else PURCHASE). It matches `conversions` for conversion-optimized ad sets; when the optimization goal reports a different result (LINK_CLICKS, LANDING_PAGE_VIEWS, ...) it stays on the promoted event so ROAS keeps its purchase basis. In ad-account native currency. 0 when the campaign has no purchase event configured. TikTok: app purchase value plus website complete-payment value (from 2026-10-08; older days carry the app value only). Other platforms report 0.
993
995
  */
994
996
  purchaseValue?: number;
995
997
  /**
@@ -28373,7 +28375,7 @@ export type SendInboxMessageError = ({
28373
28375
  */
28374
28376
  type?: string;
28375
28377
  };
28376
- } | ErrorResponse | unknown | (ErrorResponse | WhatsAppTemplateLookupError) | WhatsAppTemplateLookupError);
28378
+ } | ErrorResponse | (ErrorResponse | WhatsAppTemplateLookupError) | unknown | WhatsAppTemplateLookupError);
28377
28379
 
28378
28380
  export type GetWhatsAppMediaData = {
28379
28381
  path: {