@getlatedev/node 0.2.486 → 0.2.487

package/dist/index.d.mts

@@ -15558,7 +15558,7 @@ type ListInboxConversationsData = {
         /**
          * Filter by platform
          */
-        platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram';
+        platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram' | 'whatsapp';
         /**
          * Filter by profile ID
          */
@@ -15625,6 +15625,108 @@ type ListInboxConversationsResponse = ({
              */
             fetchedAt?: (string) | null;
         } | null;
+        /**
+         * Ad-click attribution for a conversation that started from a Meta ad.
+         * Absent when the conversation did not originate from an ad click.
+         *
+         * Captured from the referral Meta attaches to the first inbound message
+         * after the click, which is the only message that carries it. If the same
+         * person later clicks a different ad, the original values are kept, so the
+         * first ad wins. One exception on WhatsApp: when Meta omits `ctwa_clid`
+         * from that referral, a later Meta automatic event can supply it and
+         * refresh `ctwa_captured_at`, so treat `ctwa_captured_at` as the time
+         * Zernio stored the value, not the time of the click.
+         *
+         * Two families of keys, one per surface. They never appear together:
+         *
+         * - `ctwa_*` is WhatsApp Click-to-WhatsApp. The ad ID is
+         * `ctwa_source_id`. There is no `meta_ad_id` on WhatsApp.
+         * - `meta_ad_*` is Instagram Click-to-Direct and Facebook Messenger
+         * Click-to-Message. The ad ID is `meta_ad_id`. `ctwa_clid` never
+         * appears on these platforms.
+         *
+         * Every key is optional and only the keys Meta supplied are returned, so
+         * read defensively. Meta does not send a campaign or ad set ID, so none
+         * is exposed here. More keys may be added over time. Treat any key you
+         * do not recognise as an opaque string.
+         *
+         * Key names differ from the `message.received` webhook on purpose. The
+         * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
+         * while the stored conversation record uses the prefixed names below.
+         * Renaming either side would break existing integrations, so both
+         * spellings are kept.
+         *
+         */
+        metadata?: {
+            /**
+             * WhatsApp only. Meta's click identifier, the value to forward to the Meta Conversions API for Business Messaging. Meta omits it on some numbers, so a WhatsApp referral can arrive without it.
+             */
+            ctwa_clid?: string;
+            /**
+             * WhatsApp only. The Meta ad ID the user clicked. This is the WhatsApp equivalent of meta_ad_id.
+             */
+            ctwa_source_id?: string;
+            /**
+             * WhatsApp only. What the user clicked, as supplied by Meta (for example ad or post).
+             */
+            ctwa_source_type?: string;
+            /**
+             * WhatsApp only. Meta's URL for the ad that was clicked, normally an fb.me short link.
+             */
+            ctwa_source_url?: string;
+            /**
+             * WhatsApp only. Headline of the ad creative at click time.
+             */
+            ctwa_headline?: string;
+            /**
+             * WhatsApp only. When Zernio stored this referral. Always present when a WhatsApp referral was captured.
+             */
+            ctwa_captured_at?: string;
+            /**
+             * Instagram and Facebook only. The Meta ad ID the user clicked. Always present when an Instagram or Facebook referral was captured.
+             */
+            meta_ad_id?: string;
+            /**
+             * Instagram and Facebook only. Meta-supplied source identifier, for example ADS.
+             */
+            meta_ad_source?: string;
+            /**
+             * Instagram and Facebook only. Meta-supplied referral type, for example OPEN_THREAD.
+             */
+            meta_ad_type?: string;
+            /**
+             * Instagram and Facebook only. The ref parameter passed through from the ad creative.
+             */
+            meta_ad_ref?: string;
+            /**
+             * Instagram and Facebook only. Title of the ad creative at click time.
+             */
+            meta_ad_title?: string;
+            /**
+             * Instagram and Facebook only. Image of the ad creative at click time.
+             */
+            meta_ad_photo_url?: string;
+            /**
+             * Instagram and Facebook only. Video of the ad creative at click time.
+             */
+            meta_ad_video_url?: string;
+            /**
+             * Instagram and Facebook only. The organic post the ad promoted, when the ad was a boosted post.
+             */
+            meta_ad_post_id?: string;
+            /**
+             * Instagram and Facebook only. The catalogue product the user clicked, for product ads.
+             */
+            meta_ad_product_id?: string;
+            /**
+             * Instagram and Facebook only. The Meta flow the ad launched, for flow ads.
+             */
+            meta_ad_flow_id?: string;
+            /**
+             * Instagram and Facebook only. When Zernio stored this referral. Always present when an Instagram or Facebook referral was captured.
+             */
+            meta_ad_captured_at?: string;
+        } | null;
     }>;
     pagination?: {
         hasMore?: boolean;
@@ -15898,6 +16000,79 @@ type GetInboxConversationResponse = ({
              */
             fetchedAt?: (string) | null;
         } | null;
+        /**
+         * Ad-click attribution for a conversation that started from a Meta ad.
+         * Absent when the conversation did not originate from an ad click.
+         *
+         * Captured once, on the first inbound message after the click, and never
+         * overwritten. If the same person later clicks a different ad, the
+         * original values are kept. Meta only sends the referral on that first
+         * message.
+         *
+         * This operation currently returns only the `meta_ad_*` family, which
+         * covers Instagram Click-to-Direct and Facebook Messenger
+         * Click-to-Message. WhatsApp Click-to-WhatsApp attribution (the `ctwa_*`
+         * keys, where the ad ID is `ctwa_source_id`) is returned by
+         * `GET /v1/inbox/conversations` instead.
+         *
+         * Every key is optional and only the keys Meta supplied are returned, so
+         * read defensively. Meta does not send a campaign or ad set ID, so none is
+         * exposed here. More keys may be added over time. Treat any key you do not
+         * recognise as an opaque string.
+         *
+         * Key names differ from the `message.received` webhook on purpose. The
+         * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
+         * while the stored conversation record uses the prefixed names below.
+         * Renaming either side would break existing integrations, so both
+         * spellings are kept.
+         *
+         */
+        metadata?: {
+            /**
+             * The Meta ad ID the user clicked. Always present when a referral was captured.
+             */
+            meta_ad_id?: string;
+            /**
+             * Meta-supplied source identifier, for example ADS.
+             */
+            meta_ad_source?: string;
+            /**
+             * Meta-supplied referral type, for example OPEN_THREAD.
+             */
+            meta_ad_type?: string;
+            /**
+             * The ref parameter passed through from the ad creative.
+             */
+            meta_ad_ref?: string;
+            /**
+             * Title of the ad creative at click time.
+             */
+            meta_ad_title?: string;
+            /**
+             * Image of the ad creative at click time.
+             */
+            meta_ad_photo_url?: string;
+            /**
+             * Video of the ad creative at click time.
+             */
+            meta_ad_video_url?: string;
+            /**
+             * The organic post the ad promoted, when the ad was a boosted post.
+             */
+            meta_ad_post_id?: string;
+            /**
+             * The catalogue product the user clicked, for product ads.
+             */
+            meta_ad_product_id?: string;
+            /**
+             * The Meta flow the ad launched, for flow ads.
+             */
+            meta_ad_flow_id?: string;
+            /**
+             * When Zernio stored this referral. Always present when a referral was captured.
+             */
+            meta_ad_captured_at?: string;
+        } | null;
     };
 });
 type GetInboxConversationError = ({

package/dist/index.d.ts

@@ -15558,7 +15558,7 @@ type ListInboxConversationsData = {
         /**
          * Filter by platform
          */
-        platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram';
+        platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram' | 'whatsapp';
         /**
          * Filter by profile ID
          */
@@ -15625,6 +15625,108 @@ type ListInboxConversationsResponse = ({
              */
             fetchedAt?: (string) | null;
         } | null;
+        /**
+         * Ad-click attribution for a conversation that started from a Meta ad.
+         * Absent when the conversation did not originate from an ad click.
+         *
+         * Captured from the referral Meta attaches to the first inbound message
+         * after the click, which is the only message that carries it. If the same
+         * person later clicks a different ad, the original values are kept, so the
+         * first ad wins. One exception on WhatsApp: when Meta omits `ctwa_clid`
+         * from that referral, a later Meta automatic event can supply it and
+         * refresh `ctwa_captured_at`, so treat `ctwa_captured_at` as the time
+         * Zernio stored the value, not the time of the click.
+         *
+         * Two families of keys, one per surface. They never appear together:
+         *
+         * - `ctwa_*` is WhatsApp Click-to-WhatsApp. The ad ID is
+         * `ctwa_source_id`. There is no `meta_ad_id` on WhatsApp.
+         * - `meta_ad_*` is Instagram Click-to-Direct and Facebook Messenger
+         * Click-to-Message. The ad ID is `meta_ad_id`. `ctwa_clid` never
+         * appears on these platforms.
+         *
+         * Every key is optional and only the keys Meta supplied are returned, so
+         * read defensively. Meta does not send a campaign or ad set ID, so none
+         * is exposed here. More keys may be added over time. Treat any key you
+         * do not recognise as an opaque string.
+         *
+         * Key names differ from the `message.received` webhook on purpose. The
+         * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
+         * while the stored conversation record uses the prefixed names below.
+         * Renaming either side would break existing integrations, so both
+         * spellings are kept.
+         *
+         */
+        metadata?: {
+            /**
+             * WhatsApp only. Meta's click identifier, the value to forward to the Meta Conversions API for Business Messaging. Meta omits it on some numbers, so a WhatsApp referral can arrive without it.
+             */
+            ctwa_clid?: string;
+            /**
+             * WhatsApp only. The Meta ad ID the user clicked. This is the WhatsApp equivalent of meta_ad_id.
+             */
+            ctwa_source_id?: string;
+            /**
+             * WhatsApp only. What the user clicked, as supplied by Meta (for example ad or post).
+             */
+            ctwa_source_type?: string;
+            /**
+             * WhatsApp only. Meta's URL for the ad that was clicked, normally an fb.me short link.
+             */
+            ctwa_source_url?: string;
+            /**
+             * WhatsApp only. Headline of the ad creative at click time.
+             */
+            ctwa_headline?: string;
+            /**
+             * WhatsApp only. When Zernio stored this referral. Always present when a WhatsApp referral was captured.
+             */
+            ctwa_captured_at?: string;
+            /**
+             * Instagram and Facebook only. The Meta ad ID the user clicked. Always present when an Instagram or Facebook referral was captured.
+             */
+            meta_ad_id?: string;
+            /**
+             * Instagram and Facebook only. Meta-supplied source identifier, for example ADS.
+             */
+            meta_ad_source?: string;
+            /**
+             * Instagram and Facebook only. Meta-supplied referral type, for example OPEN_THREAD.
+             */
+            meta_ad_type?: string;
+            /**
+             * Instagram and Facebook only. The ref parameter passed through from the ad creative.
+             */
+            meta_ad_ref?: string;
+            /**
+             * Instagram and Facebook only. Title of the ad creative at click time.
+             */
+            meta_ad_title?: string;
+            /**
+             * Instagram and Facebook only. Image of the ad creative at click time.
+             */
+            meta_ad_photo_url?: string;
+            /**
+             * Instagram and Facebook only. Video of the ad creative at click time.
+             */
+            meta_ad_video_url?: string;
+            /**
+             * Instagram and Facebook only. The organic post the ad promoted, when the ad was a boosted post.
+             */
+            meta_ad_post_id?: string;
+            /**
+             * Instagram and Facebook only. The catalogue product the user clicked, for product ads.
+             */
+            meta_ad_product_id?: string;
+            /**
+             * Instagram and Facebook only. The Meta flow the ad launched, for flow ads.
+             */
+            meta_ad_flow_id?: string;
+            /**
+             * Instagram and Facebook only. When Zernio stored this referral. Always present when an Instagram or Facebook referral was captured.
+             */
+            meta_ad_captured_at?: string;
+        } | null;
     }>;
     pagination?: {
         hasMore?: boolean;
@@ -15898,6 +16000,79 @@ type GetInboxConversationResponse = ({
              */
             fetchedAt?: (string) | null;
         } | null;
+        /**
+         * Ad-click attribution for a conversation that started from a Meta ad.
+         * Absent when the conversation did not originate from an ad click.
+         *
+         * Captured once, on the first inbound message after the click, and never
+         * overwritten. If the same person later clicks a different ad, the
+         * original values are kept. Meta only sends the referral on that first
+         * message.
+         *
+         * This operation currently returns only the `meta_ad_*` family, which
+         * covers Instagram Click-to-Direct and Facebook Messenger
+         * Click-to-Message. WhatsApp Click-to-WhatsApp attribution (the `ctwa_*`
+         * keys, where the ad ID is `ctwa_source_id`) is returned by
+         * `GET /v1/inbox/conversations` instead.
+         *
+         * Every key is optional and only the keys Meta supplied are returned, so
+         * read defensively. Meta does not send a campaign or ad set ID, so none is
+         * exposed here. More keys may be added over time. Treat any key you do not
+         * recognise as an opaque string.
+         *
+         * Key names differ from the `message.received` webhook on purpose. The
+         * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
+         * while the stored conversation record uses the prefixed names below.
+         * Renaming either side would break existing integrations, so both
+         * spellings are kept.
+         *
+         */
+        metadata?: {
+            /**
+             * The Meta ad ID the user clicked. Always present when a referral was captured.
+             */
+            meta_ad_id?: string;
+            /**
+             * Meta-supplied source identifier, for example ADS.
+             */
+            meta_ad_source?: string;
+            /**
+             * Meta-supplied referral type, for example OPEN_THREAD.
+             */
+            meta_ad_type?: string;
+            /**
+             * The ref parameter passed through from the ad creative.
+             */
+            meta_ad_ref?: string;
+            /**
+             * Title of the ad creative at click time.
+             */
+            meta_ad_title?: string;
+            /**
+             * Image of the ad creative at click time.
+             */
+            meta_ad_photo_url?: string;
+            /**
+             * Video of the ad creative at click time.
+             */
+            meta_ad_video_url?: string;
+            /**
+             * The organic post the ad promoted, when the ad was a boosted post.
+             */
+            meta_ad_post_id?: string;
+            /**
+             * The catalogue product the user clicked, for product ads.
+             */
+            meta_ad_product_id?: string;
+            /**
+             * The Meta flow the ad launched, for flow ads.
+             */
+            meta_ad_flow_id?: string;
+            /**
+             * When Zernio stored this referral. Always present when a referral was captured.
+             */
+            meta_ad_captured_at?: string;
+        } | null;
     };
 });
 type GetInboxConversationError = ({

package/dist/index.js

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

package/src/generated/types.gen.ts

@@ -15215,7 +15215,7 @@ export type ListInboxConversationsData = {
         /**
          * Filter by platform
          */
-        platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram';
+        platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram' | 'whatsapp';
         /**
          * Filter by profile ID
          */
@@ -15283,6 +15283,108 @@ export type ListInboxConversationsResponse = ({
              */
             fetchedAt?: (string) | null;
         } | null;
+        /**
+         * Ad-click attribution for a conversation that started from a Meta ad.
+         * Absent when the conversation did not originate from an ad click.
+         *
+         * Captured from the referral Meta attaches to the first inbound message
+         * after the click, which is the only message that carries it. If the same
+         * person later clicks a different ad, the original values are kept, so the
+         * first ad wins. One exception on WhatsApp: when Meta omits `ctwa_clid`
+         * from that referral, a later Meta automatic event can supply it and
+         * refresh `ctwa_captured_at`, so treat `ctwa_captured_at` as the time
+         * Zernio stored the value, not the time of the click.
+         *
+         * Two families of keys, one per surface. They never appear together:
+         *
+         * - `ctwa_*` is WhatsApp Click-to-WhatsApp. The ad ID is
+         * `ctwa_source_id`. There is no `meta_ad_id` on WhatsApp.
+         * - `meta_ad_*` is Instagram Click-to-Direct and Facebook Messenger
+         * Click-to-Message. The ad ID is `meta_ad_id`. `ctwa_clid` never
+         * appears on these platforms.
+         *
+         * Every key is optional and only the keys Meta supplied are returned, so
+         * read defensively. Meta does not send a campaign or ad set ID, so none
+         * is exposed here. More keys may be added over time. Treat any key you
+         * do not recognise as an opaque string.
+         *
+         * Key names differ from the `message.received` webhook on purpose. The
+         * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
+         * while the stored conversation record uses the prefixed names below.
+         * Renaming either side would break existing integrations, so both
+         * spellings are kept.
+         *
+         */
+        metadata?: {
+            /**
+             * WhatsApp only. Meta's click identifier, the value to forward to the Meta Conversions API for Business Messaging. Meta omits it on some numbers, so a WhatsApp referral can arrive without it.
+             */
+            ctwa_clid?: string;
+            /**
+             * WhatsApp only. The Meta ad ID the user clicked. This is the WhatsApp equivalent of meta_ad_id.
+             */
+            ctwa_source_id?: string;
+            /**
+             * WhatsApp only. What the user clicked, as supplied by Meta (for example ad or post).
+             */
+            ctwa_source_type?: string;
+            /**
+             * WhatsApp only. Meta's URL for the ad that was clicked, normally an fb.me short link.
+             */
+            ctwa_source_url?: string;
+            /**
+             * WhatsApp only. Headline of the ad creative at click time.
+             */
+            ctwa_headline?: string;
+            /**
+             * WhatsApp only. When Zernio stored this referral. Always present when a WhatsApp referral was captured.
+             */
+            ctwa_captured_at?: string;
+            /**
+             * Instagram and Facebook only. The Meta ad ID the user clicked. Always present when an Instagram or Facebook referral was captured.
+             */
+            meta_ad_id?: string;
+            /**
+             * Instagram and Facebook only. Meta-supplied source identifier, for example ADS.
+             */
+            meta_ad_source?: string;
+            /**
+             * Instagram and Facebook only. Meta-supplied referral type, for example OPEN_THREAD.
+             */
+            meta_ad_type?: string;
+            /**
+             * Instagram and Facebook only. The ref parameter passed through from the ad creative.
+             */
+            meta_ad_ref?: string;
+            /**
+             * Instagram and Facebook only. Title of the ad creative at click time.
+             */
+            meta_ad_title?: string;
+            /**
+             * Instagram and Facebook only. Image of the ad creative at click time.
+             */
+            meta_ad_photo_url?: string;
+            /**
+             * Instagram and Facebook only. Video of the ad creative at click time.
+             */
+            meta_ad_video_url?: string;
+            /**
+             * Instagram and Facebook only. The organic post the ad promoted, when the ad was a boosted post.
+             */
+            meta_ad_post_id?: string;
+            /**
+             * Instagram and Facebook only. The catalogue product the user clicked, for product ads.
+             */
+            meta_ad_product_id?: string;
+            /**
+             * Instagram and Facebook only. The Meta flow the ad launched, for flow ads.
+             */
+            meta_ad_flow_id?: string;
+            /**
+             * Instagram and Facebook only. When Zernio stored this referral. Always present when an Instagram or Facebook referral was captured.
+             */
+            meta_ad_captured_at?: string;
+        } | null;
     }>;
     pagination?: {
         hasMore?: boolean;
@@ -15565,6 +15667,79 @@ export type GetInboxConversationResponse = ({
              */
             fetchedAt?: (string) | null;
         } | null;
+        /**
+         * Ad-click attribution for a conversation that started from a Meta ad.
+         * Absent when the conversation did not originate from an ad click.
+         *
+         * Captured once, on the first inbound message after the click, and never
+         * overwritten. If the same person later clicks a different ad, the
+         * original values are kept. Meta only sends the referral on that first
+         * message.
+         *
+         * This operation currently returns only the `meta_ad_*` family, which
+         * covers Instagram Click-to-Direct and Facebook Messenger
+         * Click-to-Message. WhatsApp Click-to-WhatsApp attribution (the `ctwa_*`
+         * keys, where the ad ID is `ctwa_source_id`) is returned by
+         * `GET /v1/inbox/conversations` instead.
+         *
+         * Every key is optional and only the keys Meta supplied are returned, so
+         * read defensively. Meta does not send a campaign or ad set ID, so none is
+         * exposed here. More keys may be added over time. Treat any key you do not
+         * recognise as an opaque string.
+         *
+         * Key names differ from the `message.received` webhook on purpose. The
+         * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
+         * while the stored conversation record uses the prefixed names below.
+         * Renaming either side would break existing integrations, so both
+         * spellings are kept.
+         *
+         */
+        metadata?: {
+            /**
+             * The Meta ad ID the user clicked. Always present when a referral was captured.
+             */
+            meta_ad_id?: string;
+            /**
+             * Meta-supplied source identifier, for example ADS.
+             */
+            meta_ad_source?: string;
+            /**
+             * Meta-supplied referral type, for example OPEN_THREAD.
+             */
+            meta_ad_type?: string;
+            /**
+             * The ref parameter passed through from the ad creative.
+             */
+            meta_ad_ref?: string;
+            /**
+             * Title of the ad creative at click time.
+             */
+            meta_ad_title?: string;
+            /**
+             * Image of the ad creative at click time.
+             */
+            meta_ad_photo_url?: string;
+            /**
+             * Video of the ad creative at click time.
+             */
+            meta_ad_video_url?: string;
+            /**
+             * The organic post the ad promoted, when the ad was a boosted post.
+             */
+            meta_ad_post_id?: string;
+            /**
+             * The catalogue product the user clicked, for product ads.
+             */
+            meta_ad_product_id?: string;
+            /**
+             * The Meta flow the ad launched, for flow ads.
+             */
+            meta_ad_flow_id?: string;
+            /**
+             * When Zernio stored this referral. Always present when a referral was captured.
+             */
+            meta_ad_captured_at?: string;
+        } | null;
     };
 });