@getlatedev/node 0.2.486 → 0.2.488

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
@@ -10392,6 +10392,9 @@ type UpdatePostData = {
10392
10392
  * Optional per-platform scheduled time override.
10393
10393
  */
10394
10394
  scheduledFor?: string;
10395
+ /**
10396
+ * A <platform>Settings namespace (e.g. facebookSettings, tiktokSettings) omitted from the request is preserved from the stored post. Sending the key replaces the whole namespace; it is not deep-merged.
10397
+ */
10395
10398
  platformSpecificData?: {
10396
10399
  [key: string]: unknown;
10397
10400
  };
@@ -15558,7 +15561,7 @@ type ListInboxConversationsData = {
15558
15561
  /**
15559
15562
  * Filter by platform
15560
15563
  */
15561
- platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram';
15564
+ platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram' | 'whatsapp';
15562
15565
  /**
15563
15566
  * Filter by profile ID
15564
15567
  */
@@ -15625,6 +15628,108 @@ type ListInboxConversationsResponse = ({
15625
15628
  */
15626
15629
  fetchedAt?: (string) | null;
15627
15630
  } | null;
15631
+ /**
15632
+ * Ad-click attribution for a conversation that started from a Meta ad.
15633
+ * Absent when the conversation did not originate from an ad click.
15634
+ *
15635
+ * Captured from the referral Meta attaches to the first inbound message
15636
+ * after the click, which is the only message that carries it. If the same
15637
+ * person later clicks a different ad, the original values are kept, so the
15638
+ * first ad wins. One exception on WhatsApp: when Meta omits `ctwa_clid`
15639
+ * from that referral, a later Meta automatic event can supply it and
15640
+ * refresh `ctwa_captured_at`, so treat `ctwa_captured_at` as the time
15641
+ * Zernio stored the value, not the time of the click.
15642
+ *
15643
+ * Two families of keys, one per surface. They never appear together:
15644
+ *
15645
+ * - `ctwa_*` is WhatsApp Click-to-WhatsApp. The ad ID is
15646
+ * `ctwa_source_id`. There is no `meta_ad_id` on WhatsApp.
15647
+ * - `meta_ad_*` is Instagram Click-to-Direct and Facebook Messenger
15648
+ * Click-to-Message. The ad ID is `meta_ad_id`. `ctwa_clid` never
15649
+ * appears on these platforms.
15650
+ *
15651
+ * Every key is optional and only the keys Meta supplied are returned, so
15652
+ * read defensively. Meta does not send a campaign or ad set ID, so none
15653
+ * is exposed here. More keys may be added over time. Treat any key you
15654
+ * do not recognise as an opaque string.
15655
+ *
15656
+ * Key names differ from the `message.received` webhook on purpose. The
15657
+ * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
15658
+ * while the stored conversation record uses the prefixed names below.
15659
+ * Renaming either side would break existing integrations, so both
15660
+ * spellings are kept.
15661
+ *
15662
+ */
15663
+ metadata?: {
15664
+ /**
15665
+ * 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.
15666
+ */
15667
+ ctwa_clid?: string;
15668
+ /**
15669
+ * WhatsApp only. The Meta ad ID the user clicked. This is the WhatsApp equivalent of meta_ad_id.
15670
+ */
15671
+ ctwa_source_id?: string;
15672
+ /**
15673
+ * WhatsApp only. What the user clicked, as supplied by Meta (for example ad or post).
15674
+ */
15675
+ ctwa_source_type?: string;
15676
+ /**
15677
+ * WhatsApp only. Meta's URL for the ad that was clicked, normally an fb.me short link.
15678
+ */
15679
+ ctwa_source_url?: string;
15680
+ /**
15681
+ * WhatsApp only. Headline of the ad creative at click time.
15682
+ */
15683
+ ctwa_headline?: string;
15684
+ /**
15685
+ * WhatsApp only. When Zernio stored this referral. Always present when a WhatsApp referral was captured.
15686
+ */
15687
+ ctwa_captured_at?: string;
15688
+ /**
15689
+ * Instagram and Facebook only. The Meta ad ID the user clicked. Always present when an Instagram or Facebook referral was captured.
15690
+ */
15691
+ meta_ad_id?: string;
15692
+ /**
15693
+ * Instagram and Facebook only. Meta-supplied source identifier, for example ADS.
15694
+ */
15695
+ meta_ad_source?: string;
15696
+ /**
15697
+ * Instagram and Facebook only. Meta-supplied referral type, for example OPEN_THREAD.
15698
+ */
15699
+ meta_ad_type?: string;
15700
+ /**
15701
+ * Instagram and Facebook only. The ref parameter passed through from the ad creative.
15702
+ */
15703
+ meta_ad_ref?: string;
15704
+ /**
15705
+ * Instagram and Facebook only. Title of the ad creative at click time.
15706
+ */
15707
+ meta_ad_title?: string;
15708
+ /**
15709
+ * Instagram and Facebook only. Image of the ad creative at click time.
15710
+ */
15711
+ meta_ad_photo_url?: string;
15712
+ /**
15713
+ * Instagram and Facebook only. Video of the ad creative at click time.
15714
+ */
15715
+ meta_ad_video_url?: string;
15716
+ /**
15717
+ * Instagram and Facebook only. The organic post the ad promoted, when the ad was a boosted post.
15718
+ */
15719
+ meta_ad_post_id?: string;
15720
+ /**
15721
+ * Instagram and Facebook only. The catalogue product the user clicked, for product ads.
15722
+ */
15723
+ meta_ad_product_id?: string;
15724
+ /**
15725
+ * Instagram and Facebook only. The Meta flow the ad launched, for flow ads.
15726
+ */
15727
+ meta_ad_flow_id?: string;
15728
+ /**
15729
+ * Instagram and Facebook only. When Zernio stored this referral. Always present when an Instagram or Facebook referral was captured.
15730
+ */
15731
+ meta_ad_captured_at?: string;
15732
+ } | null;
15628
15733
  }>;
15629
15734
  pagination?: {
15630
15735
  hasMore?: boolean;
@@ -15898,6 +16003,79 @@ type GetInboxConversationResponse = ({
15898
16003
  */
15899
16004
  fetchedAt?: (string) | null;
15900
16005
  } | null;
16006
+ /**
16007
+ * Ad-click attribution for a conversation that started from a Meta ad.
16008
+ * Absent when the conversation did not originate from an ad click.
16009
+ *
16010
+ * Captured once, on the first inbound message after the click, and never
16011
+ * overwritten. If the same person later clicks a different ad, the
16012
+ * original values are kept. Meta only sends the referral on that first
16013
+ * message.
16014
+ *
16015
+ * This operation currently returns only the `meta_ad_*` family, which
16016
+ * covers Instagram Click-to-Direct and Facebook Messenger
16017
+ * Click-to-Message. WhatsApp Click-to-WhatsApp attribution (the `ctwa_*`
16018
+ * keys, where the ad ID is `ctwa_source_id`) is returned by
16019
+ * `GET /v1/inbox/conversations` instead.
16020
+ *
16021
+ * Every key is optional and only the keys Meta supplied are returned, so
16022
+ * read defensively. Meta does not send a campaign or ad set ID, so none is
16023
+ * exposed here. More keys may be added over time. Treat any key you do not
16024
+ * recognise as an opaque string.
16025
+ *
16026
+ * Key names differ from the `message.received` webhook on purpose. The
16027
+ * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
16028
+ * while the stored conversation record uses the prefixed names below.
16029
+ * Renaming either side would break existing integrations, so both
16030
+ * spellings are kept.
16031
+ *
16032
+ */
16033
+ metadata?: {
16034
+ /**
16035
+ * The Meta ad ID the user clicked. Always present when a referral was captured.
16036
+ */
16037
+ meta_ad_id?: string;
16038
+ /**
16039
+ * Meta-supplied source identifier, for example ADS.
16040
+ */
16041
+ meta_ad_source?: string;
16042
+ /**
16043
+ * Meta-supplied referral type, for example OPEN_THREAD.
16044
+ */
16045
+ meta_ad_type?: string;
16046
+ /**
16047
+ * The ref parameter passed through from the ad creative.
16048
+ */
16049
+ meta_ad_ref?: string;
16050
+ /**
16051
+ * Title of the ad creative at click time.
16052
+ */
16053
+ meta_ad_title?: string;
16054
+ /**
16055
+ * Image of the ad creative at click time.
16056
+ */
16057
+ meta_ad_photo_url?: string;
16058
+ /**
16059
+ * Video of the ad creative at click time.
16060
+ */
16061
+ meta_ad_video_url?: string;
16062
+ /**
16063
+ * The organic post the ad promoted, when the ad was a boosted post.
16064
+ */
16065
+ meta_ad_post_id?: string;
16066
+ /**
16067
+ * The catalogue product the user clicked, for product ads.
16068
+ */
16069
+ meta_ad_product_id?: string;
16070
+ /**
16071
+ * The Meta flow the ad launched, for flow ads.
16072
+ */
16073
+ meta_ad_flow_id?: string;
16074
+ /**
16075
+ * When Zernio stored this referral. Always present when a referral was captured.
16076
+ */
16077
+ meta_ad_captured_at?: string;
16078
+ } | null;
15901
16079
  };
15902
16080
  });
15903
16081
  type GetInboxConversationError = ({
package/dist/index.d.ts CHANGED
@@ -10392,6 +10392,9 @@ type UpdatePostData = {
10392
10392
  * Optional per-platform scheduled time override.
10393
10393
  */
10394
10394
  scheduledFor?: string;
10395
+ /**
10396
+ * A <platform>Settings namespace (e.g. facebookSettings, tiktokSettings) omitted from the request is preserved from the stored post. Sending the key replaces the whole namespace; it is not deep-merged.
10397
+ */
10395
10398
  platformSpecificData?: {
10396
10399
  [key: string]: unknown;
10397
10400
  };
@@ -15558,7 +15561,7 @@ type ListInboxConversationsData = {
15558
15561
  /**
15559
15562
  * Filter by platform
15560
15563
  */
15561
- platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram';
15564
+ platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram' | 'whatsapp';
15562
15565
  /**
15563
15566
  * Filter by profile ID
15564
15567
  */
@@ -15625,6 +15628,108 @@ type ListInboxConversationsResponse = ({
15625
15628
  */
15626
15629
  fetchedAt?: (string) | null;
15627
15630
  } | null;
15631
+ /**
15632
+ * Ad-click attribution for a conversation that started from a Meta ad.
15633
+ * Absent when the conversation did not originate from an ad click.
15634
+ *
15635
+ * Captured from the referral Meta attaches to the first inbound message
15636
+ * after the click, which is the only message that carries it. If the same
15637
+ * person later clicks a different ad, the original values are kept, so the
15638
+ * first ad wins. One exception on WhatsApp: when Meta omits `ctwa_clid`
15639
+ * from that referral, a later Meta automatic event can supply it and
15640
+ * refresh `ctwa_captured_at`, so treat `ctwa_captured_at` as the time
15641
+ * Zernio stored the value, not the time of the click.
15642
+ *
15643
+ * Two families of keys, one per surface. They never appear together:
15644
+ *
15645
+ * - `ctwa_*` is WhatsApp Click-to-WhatsApp. The ad ID is
15646
+ * `ctwa_source_id`. There is no `meta_ad_id` on WhatsApp.
15647
+ * - `meta_ad_*` is Instagram Click-to-Direct and Facebook Messenger
15648
+ * Click-to-Message. The ad ID is `meta_ad_id`. `ctwa_clid` never
15649
+ * appears on these platforms.
15650
+ *
15651
+ * Every key is optional and only the keys Meta supplied are returned, so
15652
+ * read defensively. Meta does not send a campaign or ad set ID, so none
15653
+ * is exposed here. More keys may be added over time. Treat any key you
15654
+ * do not recognise as an opaque string.
15655
+ *
15656
+ * Key names differ from the `message.received` webhook on purpose. The
15657
+ * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
15658
+ * while the stored conversation record uses the prefixed names below.
15659
+ * Renaming either side would break existing integrations, so both
15660
+ * spellings are kept.
15661
+ *
15662
+ */
15663
+ metadata?: {
15664
+ /**
15665
+ * 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.
15666
+ */
15667
+ ctwa_clid?: string;
15668
+ /**
15669
+ * WhatsApp only. The Meta ad ID the user clicked. This is the WhatsApp equivalent of meta_ad_id.
15670
+ */
15671
+ ctwa_source_id?: string;
15672
+ /**
15673
+ * WhatsApp only. What the user clicked, as supplied by Meta (for example ad or post).
15674
+ */
15675
+ ctwa_source_type?: string;
15676
+ /**
15677
+ * WhatsApp only. Meta's URL for the ad that was clicked, normally an fb.me short link.
15678
+ */
15679
+ ctwa_source_url?: string;
15680
+ /**
15681
+ * WhatsApp only. Headline of the ad creative at click time.
15682
+ */
15683
+ ctwa_headline?: string;
15684
+ /**
15685
+ * WhatsApp only. When Zernio stored this referral. Always present when a WhatsApp referral was captured.
15686
+ */
15687
+ ctwa_captured_at?: string;
15688
+ /**
15689
+ * Instagram and Facebook only. The Meta ad ID the user clicked. Always present when an Instagram or Facebook referral was captured.
15690
+ */
15691
+ meta_ad_id?: string;
15692
+ /**
15693
+ * Instagram and Facebook only. Meta-supplied source identifier, for example ADS.
15694
+ */
15695
+ meta_ad_source?: string;
15696
+ /**
15697
+ * Instagram and Facebook only. Meta-supplied referral type, for example OPEN_THREAD.
15698
+ */
15699
+ meta_ad_type?: string;
15700
+ /**
15701
+ * Instagram and Facebook only. The ref parameter passed through from the ad creative.
15702
+ */
15703
+ meta_ad_ref?: string;
15704
+ /**
15705
+ * Instagram and Facebook only. Title of the ad creative at click time.
15706
+ */
15707
+ meta_ad_title?: string;
15708
+ /**
15709
+ * Instagram and Facebook only. Image of the ad creative at click time.
15710
+ */
15711
+ meta_ad_photo_url?: string;
15712
+ /**
15713
+ * Instagram and Facebook only. Video of the ad creative at click time.
15714
+ */
15715
+ meta_ad_video_url?: string;
15716
+ /**
15717
+ * Instagram and Facebook only. The organic post the ad promoted, when the ad was a boosted post.
15718
+ */
15719
+ meta_ad_post_id?: string;
15720
+ /**
15721
+ * Instagram and Facebook only. The catalogue product the user clicked, for product ads.
15722
+ */
15723
+ meta_ad_product_id?: string;
15724
+ /**
15725
+ * Instagram and Facebook only. The Meta flow the ad launched, for flow ads.
15726
+ */
15727
+ meta_ad_flow_id?: string;
15728
+ /**
15729
+ * Instagram and Facebook only. When Zernio stored this referral. Always present when an Instagram or Facebook referral was captured.
15730
+ */
15731
+ meta_ad_captured_at?: string;
15732
+ } | null;
15628
15733
  }>;
15629
15734
  pagination?: {
15630
15735
  hasMore?: boolean;
@@ -15898,6 +16003,79 @@ type GetInboxConversationResponse = ({
15898
16003
  */
15899
16004
  fetchedAt?: (string) | null;
15900
16005
  } | null;
16006
+ /**
16007
+ * Ad-click attribution for a conversation that started from a Meta ad.
16008
+ * Absent when the conversation did not originate from an ad click.
16009
+ *
16010
+ * Captured once, on the first inbound message after the click, and never
16011
+ * overwritten. If the same person later clicks a different ad, the
16012
+ * original values are kept. Meta only sends the referral on that first
16013
+ * message.
16014
+ *
16015
+ * This operation currently returns only the `meta_ad_*` family, which
16016
+ * covers Instagram Click-to-Direct and Facebook Messenger
16017
+ * Click-to-Message. WhatsApp Click-to-WhatsApp attribution (the `ctwa_*`
16018
+ * keys, where the ad ID is `ctwa_source_id`) is returned by
16019
+ * `GET /v1/inbox/conversations` instead.
16020
+ *
16021
+ * Every key is optional and only the keys Meta supplied are returned, so
16022
+ * read defensively. Meta does not send a campaign or ad set ID, so none is
16023
+ * exposed here. More keys may be added over time. Treat any key you do not
16024
+ * recognise as an opaque string.
16025
+ *
16026
+ * Key names differ from the `message.received` webhook on purpose. The
16027
+ * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
16028
+ * while the stored conversation record uses the prefixed names below.
16029
+ * Renaming either side would break existing integrations, so both
16030
+ * spellings are kept.
16031
+ *
16032
+ */
16033
+ metadata?: {
16034
+ /**
16035
+ * The Meta ad ID the user clicked. Always present when a referral was captured.
16036
+ */
16037
+ meta_ad_id?: string;
16038
+ /**
16039
+ * Meta-supplied source identifier, for example ADS.
16040
+ */
16041
+ meta_ad_source?: string;
16042
+ /**
16043
+ * Meta-supplied referral type, for example OPEN_THREAD.
16044
+ */
16045
+ meta_ad_type?: string;
16046
+ /**
16047
+ * The ref parameter passed through from the ad creative.
16048
+ */
16049
+ meta_ad_ref?: string;
16050
+ /**
16051
+ * Title of the ad creative at click time.
16052
+ */
16053
+ meta_ad_title?: string;
16054
+ /**
16055
+ * Image of the ad creative at click time.
16056
+ */
16057
+ meta_ad_photo_url?: string;
16058
+ /**
16059
+ * Video of the ad creative at click time.
16060
+ */
16061
+ meta_ad_video_url?: string;
16062
+ /**
16063
+ * The organic post the ad promoted, when the ad was a boosted post.
16064
+ */
16065
+ meta_ad_post_id?: string;
16066
+ /**
16067
+ * The catalogue product the user clicked, for product ads.
16068
+ */
16069
+ meta_ad_product_id?: string;
16070
+ /**
16071
+ * The Meta flow the ad launched, for flow ads.
16072
+ */
16073
+ meta_ad_flow_id?: string;
16074
+ /**
16075
+ * When Zernio stored this referral. Always present when a referral was captured.
16076
+ */
16077
+ meta_ad_captured_at?: string;
16078
+ } | null;
15901
16079
  };
15902
16080
  });
15903
16081
  type GetInboxConversationError = ({
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.486",
39
+ version: "0.2.488",
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.486",
8
+ version: "0.2.488",
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.486",
3
+ "version": "0.2.488",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -9630,6 +9630,9 @@ export type UpdatePostData = {
9630
9630
  * Optional per-platform scheduled time override.
9631
9631
  */
9632
9632
  scheduledFor?: string;
9633
+ /**
9634
+ * A <platform>Settings namespace (e.g. facebookSettings, tiktokSettings) omitted from the request is preserved from the stored post. Sending the key replaces the whole namespace; it is not deep-merged.
9635
+ */
9633
9636
  platformSpecificData?: {
9634
9637
  [key: string]: unknown;
9635
9638
  };
@@ -15215,7 +15218,7 @@ export type ListInboxConversationsData = {
15215
15218
  /**
15216
15219
  * Filter by platform
15217
15220
  */
15218
- platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram';
15221
+ platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram' | 'whatsapp';
15219
15222
  /**
15220
15223
  * Filter by profile ID
15221
15224
  */
@@ -15283,6 +15286,108 @@ export type ListInboxConversationsResponse = ({
15283
15286
  */
15284
15287
  fetchedAt?: (string) | null;
15285
15288
  } | null;
15289
+ /**
15290
+ * Ad-click attribution for a conversation that started from a Meta ad.
15291
+ * Absent when the conversation did not originate from an ad click.
15292
+ *
15293
+ * Captured from the referral Meta attaches to the first inbound message
15294
+ * after the click, which is the only message that carries it. If the same
15295
+ * person later clicks a different ad, the original values are kept, so the
15296
+ * first ad wins. One exception on WhatsApp: when Meta omits `ctwa_clid`
15297
+ * from that referral, a later Meta automatic event can supply it and
15298
+ * refresh `ctwa_captured_at`, so treat `ctwa_captured_at` as the time
15299
+ * Zernio stored the value, not the time of the click.
15300
+ *
15301
+ * Two families of keys, one per surface. They never appear together:
15302
+ *
15303
+ * - `ctwa_*` is WhatsApp Click-to-WhatsApp. The ad ID is
15304
+ * `ctwa_source_id`. There is no `meta_ad_id` on WhatsApp.
15305
+ * - `meta_ad_*` is Instagram Click-to-Direct and Facebook Messenger
15306
+ * Click-to-Message. The ad ID is `meta_ad_id`. `ctwa_clid` never
15307
+ * appears on these platforms.
15308
+ *
15309
+ * Every key is optional and only the keys Meta supplied are returned, so
15310
+ * read defensively. Meta does not send a campaign or ad set ID, so none
15311
+ * is exposed here. More keys may be added over time. Treat any key you
15312
+ * do not recognise as an opaque string.
15313
+ *
15314
+ * Key names differ from the `message.received` webhook on purpose. The
15315
+ * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
15316
+ * while the stored conversation record uses the prefixed names below.
15317
+ * Renaming either side would break existing integrations, so both
15318
+ * spellings are kept.
15319
+ *
15320
+ */
15321
+ metadata?: {
15322
+ /**
15323
+ * 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.
15324
+ */
15325
+ ctwa_clid?: string;
15326
+ /**
15327
+ * WhatsApp only. The Meta ad ID the user clicked. This is the WhatsApp equivalent of meta_ad_id.
15328
+ */
15329
+ ctwa_source_id?: string;
15330
+ /**
15331
+ * WhatsApp only. What the user clicked, as supplied by Meta (for example ad or post).
15332
+ */
15333
+ ctwa_source_type?: string;
15334
+ /**
15335
+ * WhatsApp only. Meta's URL for the ad that was clicked, normally an fb.me short link.
15336
+ */
15337
+ ctwa_source_url?: string;
15338
+ /**
15339
+ * WhatsApp only. Headline of the ad creative at click time.
15340
+ */
15341
+ ctwa_headline?: string;
15342
+ /**
15343
+ * WhatsApp only. When Zernio stored this referral. Always present when a WhatsApp referral was captured.
15344
+ */
15345
+ ctwa_captured_at?: string;
15346
+ /**
15347
+ * Instagram and Facebook only. The Meta ad ID the user clicked. Always present when an Instagram or Facebook referral was captured.
15348
+ */
15349
+ meta_ad_id?: string;
15350
+ /**
15351
+ * Instagram and Facebook only. Meta-supplied source identifier, for example ADS.
15352
+ */
15353
+ meta_ad_source?: string;
15354
+ /**
15355
+ * Instagram and Facebook only. Meta-supplied referral type, for example OPEN_THREAD.
15356
+ */
15357
+ meta_ad_type?: string;
15358
+ /**
15359
+ * Instagram and Facebook only. The ref parameter passed through from the ad creative.
15360
+ */
15361
+ meta_ad_ref?: string;
15362
+ /**
15363
+ * Instagram and Facebook only. Title of the ad creative at click time.
15364
+ */
15365
+ meta_ad_title?: string;
15366
+ /**
15367
+ * Instagram and Facebook only. Image of the ad creative at click time.
15368
+ */
15369
+ meta_ad_photo_url?: string;
15370
+ /**
15371
+ * Instagram and Facebook only. Video of the ad creative at click time.
15372
+ */
15373
+ meta_ad_video_url?: string;
15374
+ /**
15375
+ * Instagram and Facebook only. The organic post the ad promoted, when the ad was a boosted post.
15376
+ */
15377
+ meta_ad_post_id?: string;
15378
+ /**
15379
+ * Instagram and Facebook only. The catalogue product the user clicked, for product ads.
15380
+ */
15381
+ meta_ad_product_id?: string;
15382
+ /**
15383
+ * Instagram and Facebook only. The Meta flow the ad launched, for flow ads.
15384
+ */
15385
+ meta_ad_flow_id?: string;
15386
+ /**
15387
+ * Instagram and Facebook only. When Zernio stored this referral. Always present when an Instagram or Facebook referral was captured.
15388
+ */
15389
+ meta_ad_captured_at?: string;
15390
+ } | null;
15286
15391
  }>;
15287
15392
  pagination?: {
15288
15393
  hasMore?: boolean;
@@ -15565,6 +15670,79 @@ export type GetInboxConversationResponse = ({
15565
15670
  */
15566
15671
  fetchedAt?: (string) | null;
15567
15672
  } | null;
15673
+ /**
15674
+ * Ad-click attribution for a conversation that started from a Meta ad.
15675
+ * Absent when the conversation did not originate from an ad click.
15676
+ *
15677
+ * Captured once, on the first inbound message after the click, and never
15678
+ * overwritten. If the same person later clicks a different ad, the
15679
+ * original values are kept. Meta only sends the referral on that first
15680
+ * message.
15681
+ *
15682
+ * This operation currently returns only the `meta_ad_*` family, which
15683
+ * covers Instagram Click-to-Direct and Facebook Messenger
15684
+ * Click-to-Message. WhatsApp Click-to-WhatsApp attribution (the `ctwa_*`
15685
+ * keys, where the ad ID is `ctwa_source_id`) is returned by
15686
+ * `GET /v1/inbox/conversations` instead.
15687
+ *
15688
+ * Every key is optional and only the keys Meta supplied are returned, so
15689
+ * read defensively. Meta does not send a campaign or ad set ID, so none is
15690
+ * exposed here. More keys may be added over time. Treat any key you do not
15691
+ * recognise as an opaque string.
15692
+ *
15693
+ * Key names differ from the `message.received` webhook on purpose. The
15694
+ * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
15695
+ * while the stored conversation record uses the prefixed names below.
15696
+ * Renaming either side would break existing integrations, so both
15697
+ * spellings are kept.
15698
+ *
15699
+ */
15700
+ metadata?: {
15701
+ /**
15702
+ * The Meta ad ID the user clicked. Always present when a referral was captured.
15703
+ */
15704
+ meta_ad_id?: string;
15705
+ /**
15706
+ * Meta-supplied source identifier, for example ADS.
15707
+ */
15708
+ meta_ad_source?: string;
15709
+ /**
15710
+ * Meta-supplied referral type, for example OPEN_THREAD.
15711
+ */
15712
+ meta_ad_type?: string;
15713
+ /**
15714
+ * The ref parameter passed through from the ad creative.
15715
+ */
15716
+ meta_ad_ref?: string;
15717
+ /**
15718
+ * Title of the ad creative at click time.
15719
+ */
15720
+ meta_ad_title?: string;
15721
+ /**
15722
+ * Image of the ad creative at click time.
15723
+ */
15724
+ meta_ad_photo_url?: string;
15725
+ /**
15726
+ * Video of the ad creative at click time.
15727
+ */
15728
+ meta_ad_video_url?: string;
15729
+ /**
15730
+ * The organic post the ad promoted, when the ad was a boosted post.
15731
+ */
15732
+ meta_ad_post_id?: string;
15733
+ /**
15734
+ * The catalogue product the user clicked, for product ads.
15735
+ */
15736
+ meta_ad_product_id?: string;
15737
+ /**
15738
+ * The Meta flow the ad launched, for flow ads.
15739
+ */
15740
+ meta_ad_flow_id?: string;
15741
+ /**
15742
+ * When Zernio stored this referral. Always present when a referral was captured.
15743
+ */
15744
+ meta_ad_captured_at?: string;
15745
+ } | null;
15568
15746
  };
15569
15747
  });
15570
15748