@zernio/node 0.2.510 → 0.2.512
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 +27 -4
- package/dist/index.d.ts +27 -4
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +27 -4
package/dist/index.d.mts
CHANGED
|
@@ -7341,9 +7341,17 @@ type WebhookPayloadMessage = {
|
|
|
7341
7341
|
conversation: InboxWebhookConversation;
|
|
7342
7342
|
account: InboxWebhookAccount;
|
|
7343
7343
|
/**
|
|
7344
|
-
*
|
|
7344
|
+
* Platform-specific message context (present when the message is a quick reply tap, postback button tap, inline keyboard callback, or a quote-reply to an earlier message)
|
|
7345
7345
|
*/
|
|
7346
7346
|
metadata?: {
|
|
7347
|
+
/**
|
|
7348
|
+
* platformMessageId of the message this one is a quote-reply to.
|
|
7349
|
+
* WhatsApp (`context.id`), Instagram and Facebook Messenger
|
|
7350
|
+
* (`reply_to.mid`). On `message.sent` echoes (operator replied
|
|
7351
|
+
* from the native app) this is the only metadata field populated.
|
|
7352
|
+
*
|
|
7353
|
+
*/
|
|
7354
|
+
quotedMessageId?: string;
|
|
7347
7355
|
/**
|
|
7348
7356
|
* Payload from a quick reply tap (Facebook/Instagram Messenger).
|
|
7349
7357
|
*/
|
|
@@ -17069,7 +17077,7 @@ type SendInboxMessageData = {
|
|
|
17069
17077
|
*/
|
|
17070
17078
|
messageTag?: 'CONFIRMED_EVENT_UPDATE' | 'POST_PURCHASE_UPDATE' | 'ACCOUNT_UPDATE' | 'HUMAN_AGENT';
|
|
17071
17079
|
/**
|
|
17072
|
-
* Platform message ID to quote-reply to. For WhatsApp, pass the wamid (available in message.platformMessageId from webhooks).
|
|
17080
|
+
* Platform message ID to quote-reply to. For WhatsApp, pass the wamid; for Telegram, the Telegram message ID; for Instagram, the Meta mid (all available in message.platformMessageId from webhooks or the list-messages endpoint). On Slack it threads the reply (thread_ts) instead of quoting. Silently ignored on platforms without reply support, including Facebook Messenger (Meta's Messenger Send API has no reply_to).
|
|
17073
17081
|
*/
|
|
17074
17082
|
replyTo?: string;
|
|
17075
17083
|
/**
|
|
@@ -25829,6 +25837,10 @@ type UpdateAdSetData = {
|
|
|
25829
25837
|
promotedObject?: {
|
|
25830
25838
|
pixelId?: string;
|
|
25831
25839
|
customEventType?: string;
|
|
25840
|
+
/**
|
|
25841
|
+
* Pixel custom-event name (custom_event_str); requires customEventType OTHER. Same pairing rules as /v1/ads/create.
|
|
25842
|
+
*/
|
|
25843
|
+
customEventStr?: string;
|
|
25832
25844
|
pageId?: string;
|
|
25833
25845
|
applicationId?: string;
|
|
25834
25846
|
objectStoreUrl?: string;
|
|
@@ -27931,7 +27943,7 @@ type CreateStandaloneAdData = {
|
|
|
27931
27943
|
* Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
|
|
27932
27944
|
*
|
|
27933
27945
|
* **Meta**
|
|
27934
|
-
* - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion
|
|
27946
|
+
* - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion, or `customEventType: OTHER` + `customEventStr` to optimise against a pixel custom event.
|
|
27935
27947
|
* - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT (or `promotedObject.customConversionId` to optimise against a Custom Conversion instead). Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
|
|
27936
27948
|
* - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
|
|
27937
27949
|
* - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
|
|
@@ -28731,7 +28743,7 @@ type CreateStandaloneAdData = {
|
|
|
28731
28743
|
* Required for goals whose ad-set optimization_goal points at a specific
|
|
28732
28744
|
* event/page/app (without it Meta rejects the ad-set create with
|
|
28733
28745
|
* `error_subcode: 1815430` "Please select a promoted object for your ad set"):
|
|
28734
|
-
* - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition)
|
|
28746
|
+
* - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition). For a pixel CUSTOM event (one you named yourself in CAPI/Events Manager), send `customEventType: OTHER` + `customEventStr` with the event name.
|
|
28735
28747
|
* - `goal: app_promotion` (APP_INSTALLS): requires `applicationId` + `objectStoreUrl`
|
|
28736
28748
|
* - `goal: lead_generation` (LEAD_GENERATION): `pageId` is auto-filled from the connected Page when omitted
|
|
28737
28749
|
*
|
|
@@ -28780,6 +28792,17 @@ type CreateStandaloneAdData = {
|
|
|
28780
28792
|
*
|
|
28781
28793
|
*/
|
|
28782
28794
|
customEventType?: string;
|
|
28795
|
+
/**
|
|
28796
|
+
* Meta only. Pixel custom-event name to optimise against (Meta's
|
|
28797
|
+
* `custom_event_str`), exactly as it appears in Events Manager and in your
|
|
28798
|
+
* CAPI payloads (case-sensitive, not uppercased). Requires
|
|
28799
|
+
* `customEventType: OTHER`, and `OTHER` requires this field (400 either way).
|
|
28800
|
+
* The same as picking a custom event in Ads Manager's conversion-event
|
|
28801
|
+
* dropdown. For rule-based Custom Conversions use `customConversionId`
|
|
28802
|
+
* instead.
|
|
28803
|
+
*
|
|
28804
|
+
*/
|
|
28805
|
+
customEventStr?: string;
|
|
28783
28806
|
/**
|
|
28784
28807
|
* Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
|
|
28785
28808
|
* connected Page when omitted.
|
package/dist/index.d.ts
CHANGED
|
@@ -7341,9 +7341,17 @@ type WebhookPayloadMessage = {
|
|
|
7341
7341
|
conversation: InboxWebhookConversation;
|
|
7342
7342
|
account: InboxWebhookAccount;
|
|
7343
7343
|
/**
|
|
7344
|
-
*
|
|
7344
|
+
* Platform-specific message context (present when the message is a quick reply tap, postback button tap, inline keyboard callback, or a quote-reply to an earlier message)
|
|
7345
7345
|
*/
|
|
7346
7346
|
metadata?: {
|
|
7347
|
+
/**
|
|
7348
|
+
* platformMessageId of the message this one is a quote-reply to.
|
|
7349
|
+
* WhatsApp (`context.id`), Instagram and Facebook Messenger
|
|
7350
|
+
* (`reply_to.mid`). On `message.sent` echoes (operator replied
|
|
7351
|
+
* from the native app) this is the only metadata field populated.
|
|
7352
|
+
*
|
|
7353
|
+
*/
|
|
7354
|
+
quotedMessageId?: string;
|
|
7347
7355
|
/**
|
|
7348
7356
|
* Payload from a quick reply tap (Facebook/Instagram Messenger).
|
|
7349
7357
|
*/
|
|
@@ -17069,7 +17077,7 @@ type SendInboxMessageData = {
|
|
|
17069
17077
|
*/
|
|
17070
17078
|
messageTag?: 'CONFIRMED_EVENT_UPDATE' | 'POST_PURCHASE_UPDATE' | 'ACCOUNT_UPDATE' | 'HUMAN_AGENT';
|
|
17071
17079
|
/**
|
|
17072
|
-
* Platform message ID to quote-reply to. For WhatsApp, pass the wamid (available in message.platformMessageId from webhooks).
|
|
17080
|
+
* Platform message ID to quote-reply to. For WhatsApp, pass the wamid; for Telegram, the Telegram message ID; for Instagram, the Meta mid (all available in message.platformMessageId from webhooks or the list-messages endpoint). On Slack it threads the reply (thread_ts) instead of quoting. Silently ignored on platforms without reply support, including Facebook Messenger (Meta's Messenger Send API has no reply_to).
|
|
17073
17081
|
*/
|
|
17074
17082
|
replyTo?: string;
|
|
17075
17083
|
/**
|
|
@@ -25829,6 +25837,10 @@ type UpdateAdSetData = {
|
|
|
25829
25837
|
promotedObject?: {
|
|
25830
25838
|
pixelId?: string;
|
|
25831
25839
|
customEventType?: string;
|
|
25840
|
+
/**
|
|
25841
|
+
* Pixel custom-event name (custom_event_str); requires customEventType OTHER. Same pairing rules as /v1/ads/create.
|
|
25842
|
+
*/
|
|
25843
|
+
customEventStr?: string;
|
|
25832
25844
|
pageId?: string;
|
|
25833
25845
|
applicationId?: string;
|
|
25834
25846
|
objectStoreUrl?: string;
|
|
@@ -27931,7 +27943,7 @@ type CreateStandaloneAdData = {
|
|
|
27931
27943
|
* Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
|
|
27932
27944
|
*
|
|
27933
27945
|
* **Meta**
|
|
27934
|
-
* - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion
|
|
27946
|
+
* - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion, or `customEventType: OTHER` + `customEventStr` to optimise against a pixel custom event.
|
|
27935
27947
|
* - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT (or `promotedObject.customConversionId` to optimise against a Custom Conversion instead). Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
|
|
27936
27948
|
* - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
|
|
27937
27949
|
* - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
|
|
@@ -28731,7 +28743,7 @@ type CreateStandaloneAdData = {
|
|
|
28731
28743
|
* Required for goals whose ad-set optimization_goal points at a specific
|
|
28732
28744
|
* event/page/app (without it Meta rejects the ad-set create with
|
|
28733
28745
|
* `error_subcode: 1815430` "Please select a promoted object for your ad set"):
|
|
28734
|
-
* - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition)
|
|
28746
|
+
* - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition). For a pixel CUSTOM event (one you named yourself in CAPI/Events Manager), send `customEventType: OTHER` + `customEventStr` with the event name.
|
|
28735
28747
|
* - `goal: app_promotion` (APP_INSTALLS): requires `applicationId` + `objectStoreUrl`
|
|
28736
28748
|
* - `goal: lead_generation` (LEAD_GENERATION): `pageId` is auto-filled from the connected Page when omitted
|
|
28737
28749
|
*
|
|
@@ -28780,6 +28792,17 @@ type CreateStandaloneAdData = {
|
|
|
28780
28792
|
*
|
|
28781
28793
|
*/
|
|
28782
28794
|
customEventType?: string;
|
|
28795
|
+
/**
|
|
28796
|
+
* Meta only. Pixel custom-event name to optimise against (Meta's
|
|
28797
|
+
* `custom_event_str`), exactly as it appears in Events Manager and in your
|
|
28798
|
+
* CAPI payloads (case-sensitive, not uppercased). Requires
|
|
28799
|
+
* `customEventType: OTHER`, and `OTHER` requires this field (400 either way).
|
|
28800
|
+
* The same as picking a custom event in Ads Manager's conversion-event
|
|
28801
|
+
* dropdown. For rule-based Custom Conversions use `customConversionId`
|
|
28802
|
+
* instead.
|
|
28803
|
+
*
|
|
28804
|
+
*/
|
|
28805
|
+
customEventStr?: string;
|
|
28783
28806
|
/**
|
|
28784
28807
|
* Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
|
|
28785
28808
|
* connected Page when omitted.
|
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: "@zernio/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.512",
|
|
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: "@zernio/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.512",
|
|
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
|
@@ -6367,9 +6367,17 @@ export type WebhookPayloadMessage = {
|
|
|
6367
6367
|
conversation: InboxWebhookConversation;
|
|
6368
6368
|
account: InboxWebhookAccount;
|
|
6369
6369
|
/**
|
|
6370
|
-
*
|
|
6370
|
+
* Platform-specific message context (present when the message is a quick reply tap, postback button tap, inline keyboard callback, or a quote-reply to an earlier message)
|
|
6371
6371
|
*/
|
|
6372
6372
|
metadata?: {
|
|
6373
|
+
/**
|
|
6374
|
+
* platformMessageId of the message this one is a quote-reply to.
|
|
6375
|
+
* WhatsApp (`context.id`), Instagram and Facebook Messenger
|
|
6376
|
+
* (`reply_to.mid`). On `message.sent` echoes (operator replied
|
|
6377
|
+
* from the native app) this is the only metadata field populated.
|
|
6378
|
+
*
|
|
6379
|
+
*/
|
|
6380
|
+
quotedMessageId?: string;
|
|
6373
6381
|
/**
|
|
6374
6382
|
* Payload from a quick reply tap (Facebook/Instagram Messenger).
|
|
6375
6383
|
*/
|
|
@@ -16734,7 +16742,7 @@ export type SendInboxMessageData = {
|
|
|
16734
16742
|
*/
|
|
16735
16743
|
messageTag?: 'CONFIRMED_EVENT_UPDATE' | 'POST_PURCHASE_UPDATE' | 'ACCOUNT_UPDATE' | 'HUMAN_AGENT';
|
|
16736
16744
|
/**
|
|
16737
|
-
* Platform message ID to quote-reply to. For WhatsApp, pass the wamid (available in message.platformMessageId from webhooks).
|
|
16745
|
+
* Platform message ID to quote-reply to. For WhatsApp, pass the wamid; for Telegram, the Telegram message ID; for Instagram, the Meta mid (all available in message.platformMessageId from webhooks or the list-messages endpoint). On Slack it threads the reply (thread_ts) instead of quoting. Silently ignored on platforms without reply support, including Facebook Messenger (Meta's Messenger Send API has no reply_to).
|
|
16738
16746
|
*/
|
|
16739
16747
|
replyTo?: string;
|
|
16740
16748
|
/**
|
|
@@ -26229,6 +26237,10 @@ export type UpdateAdSetData = {
|
|
|
26229
26237
|
promotedObject?: {
|
|
26230
26238
|
pixelId?: string;
|
|
26231
26239
|
customEventType?: string;
|
|
26240
|
+
/**
|
|
26241
|
+
* Pixel custom-event name (custom_event_str); requires customEventType OTHER. Same pairing rules as /v1/ads/create.
|
|
26242
|
+
*/
|
|
26243
|
+
customEventStr?: string;
|
|
26232
26244
|
pageId?: string;
|
|
26233
26245
|
applicationId?: string;
|
|
26234
26246
|
objectStoreUrl?: string;
|
|
@@ -28469,7 +28481,7 @@ export type CreateStandaloneAdData = {
|
|
|
28469
28481
|
* Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
|
|
28470
28482
|
*
|
|
28471
28483
|
* **Meta**
|
|
28472
|
-
* - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion
|
|
28484
|
+
* - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion, or `customEventType: OTHER` + `customEventStr` to optimise against a pixel custom event.
|
|
28473
28485
|
* - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT (or `promotedObject.customConversionId` to optimise against a Custom Conversion instead). Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
|
|
28474
28486
|
* - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
|
|
28475
28487
|
* - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
|
|
@@ -29269,7 +29281,7 @@ export type CreateStandaloneAdData = {
|
|
|
29269
29281
|
* Required for goals whose ad-set optimization_goal points at a specific
|
|
29270
29282
|
* event/page/app (without it Meta rejects the ad-set create with
|
|
29271
29283
|
* `error_subcode: 1815430` "Please select a promoted object for your ad set"):
|
|
29272
|
-
* - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition)
|
|
29284
|
+
* - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition). For a pixel CUSTOM event (one you named yourself in CAPI/Events Manager), send `customEventType: OTHER` + `customEventStr` with the event name.
|
|
29273
29285
|
* - `goal: app_promotion` (APP_INSTALLS): requires `applicationId` + `objectStoreUrl`
|
|
29274
29286
|
* - `goal: lead_generation` (LEAD_GENERATION): `pageId` is auto-filled from the connected Page when omitted
|
|
29275
29287
|
*
|
|
@@ -29318,6 +29330,17 @@ export type CreateStandaloneAdData = {
|
|
|
29318
29330
|
*
|
|
29319
29331
|
*/
|
|
29320
29332
|
customEventType?: string;
|
|
29333
|
+
/**
|
|
29334
|
+
* Meta only. Pixel custom-event name to optimise against (Meta's
|
|
29335
|
+
* `custom_event_str`), exactly as it appears in Events Manager and in your
|
|
29336
|
+
* CAPI payloads (case-sensitive, not uppercased). Requires
|
|
29337
|
+
* `customEventType: OTHER`, and `OTHER` requires this field (400 either way).
|
|
29338
|
+
* The same as picking a custom event in Ads Manager's conversion-event
|
|
29339
|
+
* dropdown. For rule-based Custom Conversions use `customConversionId`
|
|
29340
|
+
* instead.
|
|
29341
|
+
*
|
|
29342
|
+
*/
|
|
29343
|
+
customEventStr?: string;
|
|
29321
29344
|
/**
|
|
29322
29345
|
* Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
|
|
29323
29346
|
* connected Page when omitted.
|