@zernio/node 0.2.124 → 0.2.126

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
@@ -3882,11 +3882,17 @@ type WebhookPayloadMessage = {
3882
3882
  */
3883
3883
  isStoryMention?: boolean;
3884
3884
  /**
3885
- * WhatsApp only. Click-to-WhatsApp (CTWA) ad attribution. Present
3886
- * only on the FIRST inbound message after a user reaches the
3887
- * business via a CTWA ad. Forwarded verbatim from Meta's referral
3888
- * envelope so it can be replayed to the Conversions API for
3889
- * Business Messaging. Attribution window is 7 days from click.
3885
+ * Ad-click attribution forwarded verbatim from Meta. Populated only on
3886
+ * the FIRST inbound message after the click; absent on subsequent
3887
+ * messages of the same conversation.
3888
+ *
3889
+ * The populated subset identifies the source platform:
3890
+ * - `ctwa_clid` and `source_*` fields: WhatsApp CTWA
3891
+ * (Click-to-WhatsApp). Attribution window is 7 days from click.
3892
+ * Forward to Meta Conversions API for Business Messaging replay.
3893
+ * - `ad_id` and `ads_context_data`: Facebook Messenger CTM
3894
+ * (Click-to-Message) or Instagram CTD (Click-to-Direct). Use
3895
+ * `ad_id` to attribute the conversation to a specific ad.
3890
3896
  *
3891
3897
  */
3892
3898
  referral?: {
@@ -3903,7 +3909,44 @@ type WebhookPayloadMessage = {
3903
3909
  image_url?: string;
3904
3910
  video_url?: string;
3905
3911
  thumbnail_url?: string;
3906
- };
3912
+ /**
3913
+ * Facebook Messenger CTM / Instagram CTD only. The Meta ad ID the
3914
+ * user clicked to start the conversation.
3915
+ *
3916
+ */
3917
+ ad_id?: string;
3918
+ /**
3919
+ * Optional `ref` parameter passed through from the Meta ad
3920
+ * creative. Facebook Messenger CTM / Instagram CTD only.
3921
+ *
3922
+ */
3923
+ ref?: string;
3924
+ /**
3925
+ * Meta-supplied source identifier (e.g. `ADS`). Facebook Messenger
3926
+ * CTM / Instagram CTD only.
3927
+ *
3928
+ */
3929
+ source?: string;
3930
+ /**
3931
+ * Meta-supplied referral type (e.g. `OPEN_THREAD`). Facebook
3932
+ * Messenger CTM / Instagram CTD only.
3933
+ *
3934
+ */
3935
+ type?: string;
3936
+ /**
3937
+ * Snapshot of the ad's public context at click time. Facebook
3938
+ * Messenger CTM / Instagram CTD only.
3939
+ *
3940
+ */
3941
+ ads_context_data?: {
3942
+ ad_title?: string;
3943
+ photo_url?: string;
3944
+ video_url?: string;
3945
+ post_id?: string;
3946
+ product_id?: string;
3947
+ flow_id?: string;
3948
+ };
3949
+ } | null;
3907
3950
  } | null;
3908
3951
  timestamp: string;
3909
3952
  };
package/dist/index.d.ts CHANGED
@@ -3882,11 +3882,17 @@ type WebhookPayloadMessage = {
3882
3882
  */
3883
3883
  isStoryMention?: boolean;
3884
3884
  /**
3885
- * WhatsApp only. Click-to-WhatsApp (CTWA) ad attribution. Present
3886
- * only on the FIRST inbound message after a user reaches the
3887
- * business via a CTWA ad. Forwarded verbatim from Meta's referral
3888
- * envelope so it can be replayed to the Conversions API for
3889
- * Business Messaging. Attribution window is 7 days from click.
3885
+ * Ad-click attribution forwarded verbatim from Meta. Populated only on
3886
+ * the FIRST inbound message after the click; absent on subsequent
3887
+ * messages of the same conversation.
3888
+ *
3889
+ * The populated subset identifies the source platform:
3890
+ * - `ctwa_clid` and `source_*` fields: WhatsApp CTWA
3891
+ * (Click-to-WhatsApp). Attribution window is 7 days from click.
3892
+ * Forward to Meta Conversions API for Business Messaging replay.
3893
+ * - `ad_id` and `ads_context_data`: Facebook Messenger CTM
3894
+ * (Click-to-Message) or Instagram CTD (Click-to-Direct). Use
3895
+ * `ad_id` to attribute the conversation to a specific ad.
3890
3896
  *
3891
3897
  */
3892
3898
  referral?: {
@@ -3903,7 +3909,44 @@ type WebhookPayloadMessage = {
3903
3909
  image_url?: string;
3904
3910
  video_url?: string;
3905
3911
  thumbnail_url?: string;
3906
- };
3912
+ /**
3913
+ * Facebook Messenger CTM / Instagram CTD only. The Meta ad ID the
3914
+ * user clicked to start the conversation.
3915
+ *
3916
+ */
3917
+ ad_id?: string;
3918
+ /**
3919
+ * Optional `ref` parameter passed through from the Meta ad
3920
+ * creative. Facebook Messenger CTM / Instagram CTD only.
3921
+ *
3922
+ */
3923
+ ref?: string;
3924
+ /**
3925
+ * Meta-supplied source identifier (e.g. `ADS`). Facebook Messenger
3926
+ * CTM / Instagram CTD only.
3927
+ *
3928
+ */
3929
+ source?: string;
3930
+ /**
3931
+ * Meta-supplied referral type (e.g. `OPEN_THREAD`). Facebook
3932
+ * Messenger CTM / Instagram CTD only.
3933
+ *
3934
+ */
3935
+ type?: string;
3936
+ /**
3937
+ * Snapshot of the ad's public context at click time. Facebook
3938
+ * Messenger CTM / Instagram CTD only.
3939
+ *
3940
+ */
3941
+ ads_context_data?: {
3942
+ ad_title?: string;
3943
+ photo_url?: string;
3944
+ video_url?: string;
3945
+ post_id?: string;
3946
+ product_id?: string;
3947
+ flow_id?: string;
3948
+ };
3949
+ } | null;
3907
3950
  } | null;
3908
3951
  timestamp: string;
3909
3952
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zernio/node",
3
- "version": "0.2.124",
3
+ "version": "0.2.126",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -1908,6 +1908,7 @@ export const deleteInboxMessage = <ThrowOnError extends boolean = false>(options
1908
1908
  * Show a typing indicator in a conversation. Platform support:
1909
1909
  * - Facebook Messenger: Shows "Page is typing..." for 20 seconds
1910
1910
  * - Telegram: Shows "Bot is typing..." for 5 seconds
1911
+ * - WhatsApp: Shows "typing..." for up to 25 seconds. Requires a recent inbound message in the conversation (Meta references the inbound message id) and also marks that message as read as a side-effect.
1911
1912
  * - All others: Returns 200 but no-op (platform doesn't support it)
1912
1913
  *
1913
1914
  * Typing indicators are best-effort. The endpoint always returns 200 even if the platform call fails.
@@ -3412,11 +3412,17 @@ export type WebhookPayloadMessage = {
3412
3412
  */
3413
3413
  isStoryMention?: boolean;
3414
3414
  /**
3415
- * WhatsApp only. Click-to-WhatsApp (CTWA) ad attribution. Present
3416
- * only on the FIRST inbound message after a user reaches the
3417
- * business via a CTWA ad. Forwarded verbatim from Meta's referral
3418
- * envelope so it can be replayed to the Conversions API for
3419
- * Business Messaging. Attribution window is 7 days from click.
3415
+ * Ad-click attribution forwarded verbatim from Meta. Populated only on
3416
+ * the FIRST inbound message after the click; absent on subsequent
3417
+ * messages of the same conversation.
3418
+ *
3419
+ * The populated subset identifies the source platform:
3420
+ * - `ctwa_clid` and `source_*` fields: WhatsApp CTWA
3421
+ * (Click-to-WhatsApp). Attribution window is 7 days from click.
3422
+ * Forward to Meta Conversions API for Business Messaging replay.
3423
+ * - `ad_id` and `ads_context_data`: Facebook Messenger CTM
3424
+ * (Click-to-Message) or Instagram CTD (Click-to-Direct). Use
3425
+ * `ad_id` to attribute the conversation to a specific ad.
3420
3426
  *
3421
3427
  */
3422
3428
  referral?: {
@@ -3433,7 +3439,44 @@ export type WebhookPayloadMessage = {
3433
3439
  image_url?: string;
3434
3440
  video_url?: string;
3435
3441
  thumbnail_url?: string;
3436
- };
3442
+ /**
3443
+ * Facebook Messenger CTM / Instagram CTD only. The Meta ad ID the
3444
+ * user clicked to start the conversation.
3445
+ *
3446
+ */
3447
+ ad_id?: string;
3448
+ /**
3449
+ * Optional `ref` parameter passed through from the Meta ad
3450
+ * creative. Facebook Messenger CTM / Instagram CTD only.
3451
+ *
3452
+ */
3453
+ ref?: string;
3454
+ /**
3455
+ * Meta-supplied source identifier (e.g. `ADS`). Facebook Messenger
3456
+ * CTM / Instagram CTD only.
3457
+ *
3458
+ */
3459
+ source?: string;
3460
+ /**
3461
+ * Meta-supplied referral type (e.g. `OPEN_THREAD`). Facebook
3462
+ * Messenger CTM / Instagram CTD only.
3463
+ *
3464
+ */
3465
+ type?: string;
3466
+ /**
3467
+ * Snapshot of the ad's public context at click time. Facebook
3468
+ * Messenger CTM / Instagram CTD only.
3469
+ *
3470
+ */
3471
+ ads_context_data?: {
3472
+ ad_title?: string;
3473
+ photo_url?: string;
3474
+ video_url?: string;
3475
+ post_id?: string;
3476
+ product_id?: string;
3477
+ flow_id?: string;
3478
+ };
3479
+ } | null;
3437
3480
  } | null;
3438
3481
  timestamp: string;
3439
3482
  };