@zernio/node 0.2.272 → 0.2.274
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 +83 -3
- package/dist/index.d.ts +83 -3
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +83 -3
package/dist/index.d.mts
CHANGED
|
@@ -12495,6 +12495,26 @@ type ListInboxConversationsResponse = ({
|
|
|
12495
12495
|
*/
|
|
12496
12496
|
fetchedAt?: (string) | null;
|
|
12497
12497
|
} | null;
|
|
12498
|
+
/**
|
|
12499
|
+
* Ad-click attribution captured on the first inbound message of the
|
|
12500
|
+
* conversation. Only present when the conversation originated from a
|
|
12501
|
+
* click-to-message ad. Absent on organic conversations.
|
|
12502
|
+
*
|
|
12503
|
+
* Two sources populate this field:
|
|
12504
|
+
* - WhatsApp CTWA (Click-to-WhatsApp): `ctwa_clid`, `ctwa_source_id`,
|
|
12505
|
+
* `ctwa_source_url`, `ctwa_headline`, `ctwa_source_type`, `ctwa_captured_at`.
|
|
12506
|
+
* - Facebook Messenger CTM / Instagram CTD: `meta_ad_id`, `meta_ad_title`,
|
|
12507
|
+
* `meta_ad_source`, `meta_ad_type`, `meta_ad_ref`, `meta_ad_captured_at`,
|
|
12508
|
+
* `meta_ad_photo_url`, `meta_ad_video_url`, `meta_ad_post_id`,
|
|
12509
|
+
* `meta_ad_product_id`, `meta_ad_flow_id`.
|
|
12510
|
+
*
|
|
12511
|
+
* Note: `meta_ad_photo_url` and `meta_ad_video_url` are Facebook CDN URLs
|
|
12512
|
+
* that may expire. Use `meta_ad_id` for a permanent reference to the ad.
|
|
12513
|
+
*
|
|
12514
|
+
*/
|
|
12515
|
+
metadata?: {
|
|
12516
|
+
[key: string]: (string);
|
|
12517
|
+
} | null;
|
|
12498
12518
|
}>;
|
|
12499
12519
|
pagination?: {
|
|
12500
12520
|
hasMore?: boolean;
|
|
@@ -12652,6 +12672,27 @@ type GetInboxConversationResponse = ({
|
|
|
12652
12672
|
*/
|
|
12653
12673
|
fetchedAt?: (string) | null;
|
|
12654
12674
|
} | null;
|
|
12675
|
+
/**
|
|
12676
|
+
* Ad-click attribution captured on the first inbound message of the
|
|
12677
|
+
* conversation. Only present when the conversation originated from a
|
|
12678
|
+
* click-to-message ad. Absent on organic conversations.
|
|
12679
|
+
*
|
|
12680
|
+
* Two sources populate this field:
|
|
12681
|
+
* - WhatsApp CTWA (Click-to-WhatsApp): `ctwa_clid`, `ctwa_source_id`,
|
|
12682
|
+
* `ctwa_source_url`, `ctwa_headline`, `ctwa_source_type`, `ctwa_captured_at`.
|
|
12683
|
+
* - Facebook Messenger CTM / Instagram CTD: `meta_ad_id`, `meta_ad_title`,
|
|
12684
|
+
* `meta_ad_source`, `meta_ad_type`, `meta_ad_ref`, `meta_ad_captured_at`,
|
|
12685
|
+
* `meta_ad_photo_url`, `meta_ad_video_url`, `meta_ad_post_id`,
|
|
12686
|
+
* `meta_ad_product_id`, `meta_ad_flow_id`.
|
|
12687
|
+
*
|
|
12688
|
+
* Note: `meta_ad_photo_url` and `meta_ad_video_url` are Facebook CDN URLs
|
|
12689
|
+
* that may expire. Use `meta_ad_id` for a permanent reference to the ad
|
|
12690
|
+
* (e.g. to link to Meta Ads Manager).
|
|
12691
|
+
*
|
|
12692
|
+
*/
|
|
12693
|
+
metadata?: {
|
|
12694
|
+
[key: string]: (string);
|
|
12695
|
+
} | null;
|
|
12655
12696
|
};
|
|
12656
12697
|
});
|
|
12657
12698
|
type GetInboxConversationError = ({
|
|
@@ -20004,8 +20045,47 @@ type GetLeadFormData = {
|
|
|
20004
20045
|
};
|
|
20005
20046
|
type GetLeadFormResponse = ({
|
|
20006
20047
|
status?: string;
|
|
20048
|
+
/**
|
|
20049
|
+
* Full form config — sufficient to duplicate the form via POST /v1/ads/lead-forms.
|
|
20050
|
+
*/
|
|
20007
20051
|
form?: {
|
|
20008
|
-
|
|
20052
|
+
id?: string;
|
|
20053
|
+
name?: string;
|
|
20054
|
+
/**
|
|
20055
|
+
* ARCHIVED forms can't receive new leads.
|
|
20056
|
+
*/
|
|
20057
|
+
status?: 'ACTIVE' | 'ARCHIVED';
|
|
20058
|
+
locale?: string;
|
|
20059
|
+
created_time?: string;
|
|
20060
|
+
leads_count?: number;
|
|
20061
|
+
privacy_policy_url?: string;
|
|
20062
|
+
follow_up_action_url?: (string) | null;
|
|
20063
|
+
questions?: Array<{
|
|
20064
|
+
key?: string;
|
|
20065
|
+
label?: string;
|
|
20066
|
+
/**
|
|
20067
|
+
* EMAIL, PHONE, FULL_NAME, FIRST_NAME, LAST_NAME, CUSTOM, …
|
|
20068
|
+
*/
|
|
20069
|
+
type?: string;
|
|
20070
|
+
options?: Array<{
|
|
20071
|
+
key?: string;
|
|
20072
|
+
value?: string;
|
|
20073
|
+
}>;
|
|
20074
|
+
inline_context?: string;
|
|
20075
|
+
}>;
|
|
20076
|
+
thank_you_page?: {
|
|
20077
|
+
title?: string;
|
|
20078
|
+
body?: string;
|
|
20079
|
+
button_text?: string;
|
|
20080
|
+
button_type?: string;
|
|
20081
|
+
website_url?: string;
|
|
20082
|
+
} | null;
|
|
20083
|
+
/**
|
|
20084
|
+
* Intro card shown before the form questions (title, content, button label).
|
|
20085
|
+
*/
|
|
20086
|
+
context_card?: {
|
|
20087
|
+
[key: string]: unknown;
|
|
20088
|
+
} | null;
|
|
20009
20089
|
};
|
|
20010
20090
|
});
|
|
20011
20091
|
type GetLeadFormError = ({
|
|
@@ -20121,9 +20201,9 @@ type SearchAdTargetingData = {
|
|
|
20121
20201
|
*/
|
|
20122
20202
|
dimension?: 'geo' | 'interest' | 'behavior' | 'income';
|
|
20123
20203
|
/**
|
|
20124
|
-
* Only used when `dimension=geo`. The kind of location to resolve. Defaults to `city`.
|
|
20204
|
+
* Only used when `dimension=geo`. The kind of location to resolve. `place` resolves named points of interest (businesses, landmarks) by proximity. `neighborhood` resolves named neighbourhood areas. Defaults to `city`.
|
|
20125
20205
|
*/
|
|
20126
|
-
geoType?: 'country' | 'region' | 'city' | 'zip' | '
|
|
20206
|
+
geoType?: 'country' | 'region' | 'city' | 'subcity' | 'neighborhood' | 'place' | 'zip' | 'metro_area' | 'geo_market';
|
|
20127
20207
|
/**
|
|
20128
20208
|
* Maximum results to return.
|
|
20129
20209
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -12495,6 +12495,26 @@ type ListInboxConversationsResponse = ({
|
|
|
12495
12495
|
*/
|
|
12496
12496
|
fetchedAt?: (string) | null;
|
|
12497
12497
|
} | null;
|
|
12498
|
+
/**
|
|
12499
|
+
* Ad-click attribution captured on the first inbound message of the
|
|
12500
|
+
* conversation. Only present when the conversation originated from a
|
|
12501
|
+
* click-to-message ad. Absent on organic conversations.
|
|
12502
|
+
*
|
|
12503
|
+
* Two sources populate this field:
|
|
12504
|
+
* - WhatsApp CTWA (Click-to-WhatsApp): `ctwa_clid`, `ctwa_source_id`,
|
|
12505
|
+
* `ctwa_source_url`, `ctwa_headline`, `ctwa_source_type`, `ctwa_captured_at`.
|
|
12506
|
+
* - Facebook Messenger CTM / Instagram CTD: `meta_ad_id`, `meta_ad_title`,
|
|
12507
|
+
* `meta_ad_source`, `meta_ad_type`, `meta_ad_ref`, `meta_ad_captured_at`,
|
|
12508
|
+
* `meta_ad_photo_url`, `meta_ad_video_url`, `meta_ad_post_id`,
|
|
12509
|
+
* `meta_ad_product_id`, `meta_ad_flow_id`.
|
|
12510
|
+
*
|
|
12511
|
+
* Note: `meta_ad_photo_url` and `meta_ad_video_url` are Facebook CDN URLs
|
|
12512
|
+
* that may expire. Use `meta_ad_id` for a permanent reference to the ad.
|
|
12513
|
+
*
|
|
12514
|
+
*/
|
|
12515
|
+
metadata?: {
|
|
12516
|
+
[key: string]: (string);
|
|
12517
|
+
} | null;
|
|
12498
12518
|
}>;
|
|
12499
12519
|
pagination?: {
|
|
12500
12520
|
hasMore?: boolean;
|
|
@@ -12652,6 +12672,27 @@ type GetInboxConversationResponse = ({
|
|
|
12652
12672
|
*/
|
|
12653
12673
|
fetchedAt?: (string) | null;
|
|
12654
12674
|
} | null;
|
|
12675
|
+
/**
|
|
12676
|
+
* Ad-click attribution captured on the first inbound message of the
|
|
12677
|
+
* conversation. Only present when the conversation originated from a
|
|
12678
|
+
* click-to-message ad. Absent on organic conversations.
|
|
12679
|
+
*
|
|
12680
|
+
* Two sources populate this field:
|
|
12681
|
+
* - WhatsApp CTWA (Click-to-WhatsApp): `ctwa_clid`, `ctwa_source_id`,
|
|
12682
|
+
* `ctwa_source_url`, `ctwa_headline`, `ctwa_source_type`, `ctwa_captured_at`.
|
|
12683
|
+
* - Facebook Messenger CTM / Instagram CTD: `meta_ad_id`, `meta_ad_title`,
|
|
12684
|
+
* `meta_ad_source`, `meta_ad_type`, `meta_ad_ref`, `meta_ad_captured_at`,
|
|
12685
|
+
* `meta_ad_photo_url`, `meta_ad_video_url`, `meta_ad_post_id`,
|
|
12686
|
+
* `meta_ad_product_id`, `meta_ad_flow_id`.
|
|
12687
|
+
*
|
|
12688
|
+
* Note: `meta_ad_photo_url` and `meta_ad_video_url` are Facebook CDN URLs
|
|
12689
|
+
* that may expire. Use `meta_ad_id` for a permanent reference to the ad
|
|
12690
|
+
* (e.g. to link to Meta Ads Manager).
|
|
12691
|
+
*
|
|
12692
|
+
*/
|
|
12693
|
+
metadata?: {
|
|
12694
|
+
[key: string]: (string);
|
|
12695
|
+
} | null;
|
|
12655
12696
|
};
|
|
12656
12697
|
});
|
|
12657
12698
|
type GetInboxConversationError = ({
|
|
@@ -20004,8 +20045,47 @@ type GetLeadFormData = {
|
|
|
20004
20045
|
};
|
|
20005
20046
|
type GetLeadFormResponse = ({
|
|
20006
20047
|
status?: string;
|
|
20048
|
+
/**
|
|
20049
|
+
* Full form config — sufficient to duplicate the form via POST /v1/ads/lead-forms.
|
|
20050
|
+
*/
|
|
20007
20051
|
form?: {
|
|
20008
|
-
|
|
20052
|
+
id?: string;
|
|
20053
|
+
name?: string;
|
|
20054
|
+
/**
|
|
20055
|
+
* ARCHIVED forms can't receive new leads.
|
|
20056
|
+
*/
|
|
20057
|
+
status?: 'ACTIVE' | 'ARCHIVED';
|
|
20058
|
+
locale?: string;
|
|
20059
|
+
created_time?: string;
|
|
20060
|
+
leads_count?: number;
|
|
20061
|
+
privacy_policy_url?: string;
|
|
20062
|
+
follow_up_action_url?: (string) | null;
|
|
20063
|
+
questions?: Array<{
|
|
20064
|
+
key?: string;
|
|
20065
|
+
label?: string;
|
|
20066
|
+
/**
|
|
20067
|
+
* EMAIL, PHONE, FULL_NAME, FIRST_NAME, LAST_NAME, CUSTOM, …
|
|
20068
|
+
*/
|
|
20069
|
+
type?: string;
|
|
20070
|
+
options?: Array<{
|
|
20071
|
+
key?: string;
|
|
20072
|
+
value?: string;
|
|
20073
|
+
}>;
|
|
20074
|
+
inline_context?: string;
|
|
20075
|
+
}>;
|
|
20076
|
+
thank_you_page?: {
|
|
20077
|
+
title?: string;
|
|
20078
|
+
body?: string;
|
|
20079
|
+
button_text?: string;
|
|
20080
|
+
button_type?: string;
|
|
20081
|
+
website_url?: string;
|
|
20082
|
+
} | null;
|
|
20083
|
+
/**
|
|
20084
|
+
* Intro card shown before the form questions (title, content, button label).
|
|
20085
|
+
*/
|
|
20086
|
+
context_card?: {
|
|
20087
|
+
[key: string]: unknown;
|
|
20088
|
+
} | null;
|
|
20009
20089
|
};
|
|
20010
20090
|
});
|
|
20011
20091
|
type GetLeadFormError = ({
|
|
@@ -20121,9 +20201,9 @@ type SearchAdTargetingData = {
|
|
|
20121
20201
|
*/
|
|
20122
20202
|
dimension?: 'geo' | 'interest' | 'behavior' | 'income';
|
|
20123
20203
|
/**
|
|
20124
|
-
* Only used when `dimension=geo`. The kind of location to resolve. Defaults to `city`.
|
|
20204
|
+
* Only used when `dimension=geo`. The kind of location to resolve. `place` resolves named points of interest (businesses, landmarks) by proximity. `neighborhood` resolves named neighbourhood areas. Defaults to `city`.
|
|
20125
20205
|
*/
|
|
20126
|
-
geoType?: 'country' | 'region' | 'city' | 'zip' | '
|
|
20206
|
+
geoType?: 'country' | 'region' | 'city' | 'subcity' | 'neighborhood' | 'place' | 'zip' | 'metro_area' | 'geo_market';
|
|
20127
20207
|
/**
|
|
20128
20208
|
* Maximum results to return.
|
|
20129
20209
|
*/
|
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.274",
|
|
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.274",
|
|
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
|
@@ -12457,6 +12457,26 @@ export type ListInboxConversationsResponse = ({
|
|
|
12457
12457
|
*/
|
|
12458
12458
|
fetchedAt?: (string) | null;
|
|
12459
12459
|
} | null;
|
|
12460
|
+
/**
|
|
12461
|
+
* Ad-click attribution captured on the first inbound message of the
|
|
12462
|
+
* conversation. Only present when the conversation originated from a
|
|
12463
|
+
* click-to-message ad. Absent on organic conversations.
|
|
12464
|
+
*
|
|
12465
|
+
* Two sources populate this field:
|
|
12466
|
+
* - WhatsApp CTWA (Click-to-WhatsApp): `ctwa_clid`, `ctwa_source_id`,
|
|
12467
|
+
* `ctwa_source_url`, `ctwa_headline`, `ctwa_source_type`, `ctwa_captured_at`.
|
|
12468
|
+
* - Facebook Messenger CTM / Instagram CTD: `meta_ad_id`, `meta_ad_title`,
|
|
12469
|
+
* `meta_ad_source`, `meta_ad_type`, `meta_ad_ref`, `meta_ad_captured_at`,
|
|
12470
|
+
* `meta_ad_photo_url`, `meta_ad_video_url`, `meta_ad_post_id`,
|
|
12471
|
+
* `meta_ad_product_id`, `meta_ad_flow_id`.
|
|
12472
|
+
*
|
|
12473
|
+
* Note: `meta_ad_photo_url` and `meta_ad_video_url` are Facebook CDN URLs
|
|
12474
|
+
* that may expire. Use `meta_ad_id` for a permanent reference to the ad.
|
|
12475
|
+
*
|
|
12476
|
+
*/
|
|
12477
|
+
metadata?: {
|
|
12478
|
+
[key: string]: (string);
|
|
12479
|
+
} | null;
|
|
12460
12480
|
}>;
|
|
12461
12481
|
pagination?: {
|
|
12462
12482
|
hasMore?: boolean;
|
|
@@ -12620,6 +12640,27 @@ export type GetInboxConversationResponse = ({
|
|
|
12620
12640
|
*/
|
|
12621
12641
|
fetchedAt?: (string) | null;
|
|
12622
12642
|
} | null;
|
|
12643
|
+
/**
|
|
12644
|
+
* Ad-click attribution captured on the first inbound message of the
|
|
12645
|
+
* conversation. Only present when the conversation originated from a
|
|
12646
|
+
* click-to-message ad. Absent on organic conversations.
|
|
12647
|
+
*
|
|
12648
|
+
* Two sources populate this field:
|
|
12649
|
+
* - WhatsApp CTWA (Click-to-WhatsApp): `ctwa_clid`, `ctwa_source_id`,
|
|
12650
|
+
* `ctwa_source_url`, `ctwa_headline`, `ctwa_source_type`, `ctwa_captured_at`.
|
|
12651
|
+
* - Facebook Messenger CTM / Instagram CTD: `meta_ad_id`, `meta_ad_title`,
|
|
12652
|
+
* `meta_ad_source`, `meta_ad_type`, `meta_ad_ref`, `meta_ad_captured_at`,
|
|
12653
|
+
* `meta_ad_photo_url`, `meta_ad_video_url`, `meta_ad_post_id`,
|
|
12654
|
+
* `meta_ad_product_id`, `meta_ad_flow_id`.
|
|
12655
|
+
*
|
|
12656
|
+
* Note: `meta_ad_photo_url` and `meta_ad_video_url` are Facebook CDN URLs
|
|
12657
|
+
* that may expire. Use `meta_ad_id` for a permanent reference to the ad
|
|
12658
|
+
* (e.g. to link to Meta Ads Manager).
|
|
12659
|
+
*
|
|
12660
|
+
*/
|
|
12661
|
+
metadata?: {
|
|
12662
|
+
[key: string]: (string);
|
|
12663
|
+
} | null;
|
|
12623
12664
|
};
|
|
12624
12665
|
});
|
|
12625
12666
|
|
|
@@ -20519,8 +20560,47 @@ export type GetLeadFormData = {
|
|
|
20519
20560
|
|
|
20520
20561
|
export type GetLeadFormResponse = ({
|
|
20521
20562
|
status?: string;
|
|
20563
|
+
/**
|
|
20564
|
+
* Full form config — sufficient to duplicate the form via POST /v1/ads/lead-forms.
|
|
20565
|
+
*/
|
|
20522
20566
|
form?: {
|
|
20523
|
-
|
|
20567
|
+
id?: string;
|
|
20568
|
+
name?: string;
|
|
20569
|
+
/**
|
|
20570
|
+
* ARCHIVED forms can't receive new leads.
|
|
20571
|
+
*/
|
|
20572
|
+
status?: 'ACTIVE' | 'ARCHIVED';
|
|
20573
|
+
locale?: string;
|
|
20574
|
+
created_time?: string;
|
|
20575
|
+
leads_count?: number;
|
|
20576
|
+
privacy_policy_url?: string;
|
|
20577
|
+
follow_up_action_url?: (string) | null;
|
|
20578
|
+
questions?: Array<{
|
|
20579
|
+
key?: string;
|
|
20580
|
+
label?: string;
|
|
20581
|
+
/**
|
|
20582
|
+
* EMAIL, PHONE, FULL_NAME, FIRST_NAME, LAST_NAME, CUSTOM, …
|
|
20583
|
+
*/
|
|
20584
|
+
type?: string;
|
|
20585
|
+
options?: Array<{
|
|
20586
|
+
key?: string;
|
|
20587
|
+
value?: string;
|
|
20588
|
+
}>;
|
|
20589
|
+
inline_context?: string;
|
|
20590
|
+
}>;
|
|
20591
|
+
thank_you_page?: {
|
|
20592
|
+
title?: string;
|
|
20593
|
+
body?: string;
|
|
20594
|
+
button_text?: string;
|
|
20595
|
+
button_type?: string;
|
|
20596
|
+
website_url?: string;
|
|
20597
|
+
} | null;
|
|
20598
|
+
/**
|
|
20599
|
+
* Intro card shown before the form questions (title, content, button label).
|
|
20600
|
+
*/
|
|
20601
|
+
context_card?: {
|
|
20602
|
+
[key: string]: unknown;
|
|
20603
|
+
} | null;
|
|
20524
20604
|
};
|
|
20525
20605
|
});
|
|
20526
20606
|
|
|
@@ -20650,9 +20730,9 @@ export type SearchAdTargetingData = {
|
|
|
20650
20730
|
*/
|
|
20651
20731
|
dimension?: 'geo' | 'interest' | 'behavior' | 'income';
|
|
20652
20732
|
/**
|
|
20653
|
-
* Only used when `dimension=geo`. The kind of location to resolve. Defaults to `city`.
|
|
20733
|
+
* Only used when `dimension=geo`. The kind of location to resolve. `place` resolves named points of interest (businesses, landmarks) by proximity. `neighborhood` resolves named neighbourhood areas. Defaults to `city`.
|
|
20654
20734
|
*/
|
|
20655
|
-
geoType?: 'country' | 'region' | 'city' | 'zip' | '
|
|
20735
|
+
geoType?: 'country' | 'region' | 'city' | 'subcity' | 'neighborhood' | 'place' | 'zip' | 'metro_area' | 'geo_market';
|
|
20656
20736
|
/**
|
|
20657
20737
|
* Maximum results to return.
|
|
20658
20738
|
*/
|