@getlatedev/node 0.2.275 → 0.2.276
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 +84 -2
- package/dist/index.d.ts +84 -2
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +84 -2
package/dist/index.d.mts
CHANGED
|
@@ -19485,6 +19485,36 @@ type CreateStandaloneAdData = {
|
|
|
19485
19485
|
name?: string;
|
|
19486
19486
|
address?: string;
|
|
19487
19487
|
}>;
|
|
19488
|
+
/**
|
|
19489
|
+
* Named points of interest (businesses, landmarks). Meta only. `key` from /v1/ads/targeting/search?dimension=geo&geoType=place. Maps to geo_locations.places.
|
|
19490
|
+
*/
|
|
19491
|
+
places?: Array<{
|
|
19492
|
+
key: string;
|
|
19493
|
+
}>;
|
|
19494
|
+
/**
|
|
19495
|
+
* Named neighbourhood areas. Meta only. `key` from /v1/ads/targeting/search?dimension=geo&geoType=neighborhood. Maps to geo_locations.neighborhoods.
|
|
19496
|
+
*/
|
|
19497
|
+
neighborhoods?: Array<{
|
|
19498
|
+
key: string;
|
|
19499
|
+
}>;
|
|
19500
|
+
/**
|
|
19501
|
+
* Geo exclusions. Meta only. Maps to excluded_geo_locations. Supports countries, regions, cities, and zips.
|
|
19502
|
+
*/
|
|
19503
|
+
excludedLocations?: {
|
|
19504
|
+
/**
|
|
19505
|
+
* ISO-3166 alpha-2 country codes to exclude.
|
|
19506
|
+
*/
|
|
19507
|
+
countries?: Array<(string)>;
|
|
19508
|
+
regions?: Array<{
|
|
19509
|
+
key: string;
|
|
19510
|
+
}>;
|
|
19511
|
+
cities?: Array<{
|
|
19512
|
+
key: string;
|
|
19513
|
+
}>;
|
|
19514
|
+
zips?: Array<{
|
|
19515
|
+
key: string;
|
|
19516
|
+
}>;
|
|
19517
|
+
};
|
|
19488
19518
|
/**
|
|
19489
19519
|
* Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta and TikTok. Each must include id.
|
|
19490
19520
|
*/
|
|
@@ -20022,7 +20052,51 @@ type CreateLeadFormData = {
|
|
|
20022
20052
|
thankYouButtonText?: string;
|
|
20023
20053
|
thankYouButtonType?: string;
|
|
20024
20054
|
thankYouWebsiteUrl?: string;
|
|
20055
|
+
/**
|
|
20056
|
+
* Legacy form type toggle. Prefer formType instead. false = More Volume, true = Higher Intent.
|
|
20057
|
+
*/
|
|
20025
20058
|
isOptimizedForQuality?: boolean;
|
|
20059
|
+
/**
|
|
20060
|
+
* Form type. MORE_VOLUME = optimized for lead quantity (default). HIGHER_INTENT = adds a review/confirmation step before submit. RICH_CREATIVE = includes context card and custom headline to educate users before they submit. Supersedes isOptimizedForQuality.
|
|
20061
|
+
*/
|
|
20062
|
+
formType?: 'MORE_VOLUME' | 'HIGHER_INTENT' | 'RICH_CREATIVE';
|
|
20063
|
+
/**
|
|
20064
|
+
* Sharing setting. true = Restricted (only people targeted by the ad can open the form link). false = Open (shareable link, default).
|
|
20065
|
+
*/
|
|
20066
|
+
blockDisplayForNonTargetedViewer?: boolean;
|
|
20067
|
+
/**
|
|
20068
|
+
* Flexible form delivery. true = the form can surface organically on the Page (not just as a paid ad). Defaults to false.
|
|
20069
|
+
*/
|
|
20070
|
+
allowOrganicLeadGen?: boolean;
|
|
20071
|
+
/**
|
|
20072
|
+
* Custom subheadline shown above the form fields on the questions page (the contact-information section description). Defaults to Meta's generic copy when omitted.
|
|
20073
|
+
*/
|
|
20074
|
+
questionPageCustomHeadline?: string;
|
|
20075
|
+
/**
|
|
20076
|
+
* Intro card shown before the questions page. Omit to skip the intro screen.
|
|
20077
|
+
*/
|
|
20078
|
+
contextCard?: {
|
|
20079
|
+
/**
|
|
20080
|
+
* Headline / title of the intro card.
|
|
20081
|
+
*/
|
|
20082
|
+
title?: string;
|
|
20083
|
+
/**
|
|
20084
|
+
* Body text lines shown on the intro card.
|
|
20085
|
+
*/
|
|
20086
|
+
content?: Array<(string)>;
|
|
20087
|
+
/**
|
|
20088
|
+
* Visual layout of the intro card.
|
|
20089
|
+
*/
|
|
20090
|
+
style?: 'LIST_STYLE' | 'PARAGRAPH_STYLE';
|
|
20091
|
+
/**
|
|
20092
|
+
* CTA button label on the intro card.
|
|
20093
|
+
*/
|
|
20094
|
+
buttonText?: string;
|
|
20095
|
+
/**
|
|
20096
|
+
* Image hash of the cover photo (obtain from the Meta Ad Images API). Omit to show no image.
|
|
20097
|
+
*/
|
|
20098
|
+
coverPhoto?: string;
|
|
20099
|
+
};
|
|
20026
20100
|
};
|
|
20027
20101
|
};
|
|
20028
20102
|
type CreateLeadFormResponse = ({
|
|
@@ -20201,9 +20275,9 @@ type SearchAdTargetingData = {
|
|
|
20201
20275
|
*/
|
|
20202
20276
|
dimension?: 'geo' | 'interest' | 'behavior' | 'income';
|
|
20203
20277
|
/**
|
|
20204
|
-
* Only used when `dimension=geo`. The kind of location to resolve. `place` resolves named points of interest (businesses, landmarks)
|
|
20278
|
+
* Only used when `dimension=geo`. The kind of location to resolve. `place` resolves named points of interest (businesses, landmarks). `neighborhood` resolves named neighbourhood areas. Use `all` to search every geo type in a single relevance-ranked call — mirrors Meta's own unified search box. Defaults to `city`.
|
|
20205
20279
|
*/
|
|
20206
|
-
geoType?: 'country' | 'region' | 'city' | 'subcity' | 'neighborhood' | 'place' | 'zip' | 'metro_area' | 'geo_market';
|
|
20280
|
+
geoType?: 'all' | 'country' | 'region' | 'city' | 'subcity' | 'neighborhood' | 'place' | 'zip' | 'metro_area' | 'geo_market';
|
|
20207
20281
|
/**
|
|
20208
20282
|
* Maximum results to return.
|
|
20209
20283
|
*/
|
|
@@ -20236,6 +20310,14 @@ type SearchAdTargetingResponse = ({
|
|
|
20236
20310
|
* Optional estimated reachable users for this option, when the platform returns it.
|
|
20237
20311
|
*/
|
|
20238
20312
|
audienceSize?: (number) | null;
|
|
20313
|
+
/**
|
|
20314
|
+
* Centre latitude of the location. Populated on Meta geo results (city, neighborhood, place, etc.). Useful for map views.
|
|
20315
|
+
*/
|
|
20316
|
+
latitude?: (number) | null;
|
|
20317
|
+
/**
|
|
20318
|
+
* Centre longitude of the location.
|
|
20319
|
+
*/
|
|
20320
|
+
longitude?: (number) | null;
|
|
20239
20321
|
}>;
|
|
20240
20322
|
});
|
|
20241
20323
|
type SearchAdTargetingError = (unknown | {
|
package/dist/index.d.ts
CHANGED
|
@@ -19485,6 +19485,36 @@ type CreateStandaloneAdData = {
|
|
|
19485
19485
|
name?: string;
|
|
19486
19486
|
address?: string;
|
|
19487
19487
|
}>;
|
|
19488
|
+
/**
|
|
19489
|
+
* Named points of interest (businesses, landmarks). Meta only. `key` from /v1/ads/targeting/search?dimension=geo&geoType=place. Maps to geo_locations.places.
|
|
19490
|
+
*/
|
|
19491
|
+
places?: Array<{
|
|
19492
|
+
key: string;
|
|
19493
|
+
}>;
|
|
19494
|
+
/**
|
|
19495
|
+
* Named neighbourhood areas. Meta only. `key` from /v1/ads/targeting/search?dimension=geo&geoType=neighborhood. Maps to geo_locations.neighborhoods.
|
|
19496
|
+
*/
|
|
19497
|
+
neighborhoods?: Array<{
|
|
19498
|
+
key: string;
|
|
19499
|
+
}>;
|
|
19500
|
+
/**
|
|
19501
|
+
* Geo exclusions. Meta only. Maps to excluded_geo_locations. Supports countries, regions, cities, and zips.
|
|
19502
|
+
*/
|
|
19503
|
+
excludedLocations?: {
|
|
19504
|
+
/**
|
|
19505
|
+
* ISO-3166 alpha-2 country codes to exclude.
|
|
19506
|
+
*/
|
|
19507
|
+
countries?: Array<(string)>;
|
|
19508
|
+
regions?: Array<{
|
|
19509
|
+
key: string;
|
|
19510
|
+
}>;
|
|
19511
|
+
cities?: Array<{
|
|
19512
|
+
key: string;
|
|
19513
|
+
}>;
|
|
19514
|
+
zips?: Array<{
|
|
19515
|
+
key: string;
|
|
19516
|
+
}>;
|
|
19517
|
+
};
|
|
19488
19518
|
/**
|
|
19489
19519
|
* Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta and TikTok. Each must include id.
|
|
19490
19520
|
*/
|
|
@@ -20022,7 +20052,51 @@ type CreateLeadFormData = {
|
|
|
20022
20052
|
thankYouButtonText?: string;
|
|
20023
20053
|
thankYouButtonType?: string;
|
|
20024
20054
|
thankYouWebsiteUrl?: string;
|
|
20055
|
+
/**
|
|
20056
|
+
* Legacy form type toggle. Prefer formType instead. false = More Volume, true = Higher Intent.
|
|
20057
|
+
*/
|
|
20025
20058
|
isOptimizedForQuality?: boolean;
|
|
20059
|
+
/**
|
|
20060
|
+
* Form type. MORE_VOLUME = optimized for lead quantity (default). HIGHER_INTENT = adds a review/confirmation step before submit. RICH_CREATIVE = includes context card and custom headline to educate users before they submit. Supersedes isOptimizedForQuality.
|
|
20061
|
+
*/
|
|
20062
|
+
formType?: 'MORE_VOLUME' | 'HIGHER_INTENT' | 'RICH_CREATIVE';
|
|
20063
|
+
/**
|
|
20064
|
+
* Sharing setting. true = Restricted (only people targeted by the ad can open the form link). false = Open (shareable link, default).
|
|
20065
|
+
*/
|
|
20066
|
+
blockDisplayForNonTargetedViewer?: boolean;
|
|
20067
|
+
/**
|
|
20068
|
+
* Flexible form delivery. true = the form can surface organically on the Page (not just as a paid ad). Defaults to false.
|
|
20069
|
+
*/
|
|
20070
|
+
allowOrganicLeadGen?: boolean;
|
|
20071
|
+
/**
|
|
20072
|
+
* Custom subheadline shown above the form fields on the questions page (the contact-information section description). Defaults to Meta's generic copy when omitted.
|
|
20073
|
+
*/
|
|
20074
|
+
questionPageCustomHeadline?: string;
|
|
20075
|
+
/**
|
|
20076
|
+
* Intro card shown before the questions page. Omit to skip the intro screen.
|
|
20077
|
+
*/
|
|
20078
|
+
contextCard?: {
|
|
20079
|
+
/**
|
|
20080
|
+
* Headline / title of the intro card.
|
|
20081
|
+
*/
|
|
20082
|
+
title?: string;
|
|
20083
|
+
/**
|
|
20084
|
+
* Body text lines shown on the intro card.
|
|
20085
|
+
*/
|
|
20086
|
+
content?: Array<(string)>;
|
|
20087
|
+
/**
|
|
20088
|
+
* Visual layout of the intro card.
|
|
20089
|
+
*/
|
|
20090
|
+
style?: 'LIST_STYLE' | 'PARAGRAPH_STYLE';
|
|
20091
|
+
/**
|
|
20092
|
+
* CTA button label on the intro card.
|
|
20093
|
+
*/
|
|
20094
|
+
buttonText?: string;
|
|
20095
|
+
/**
|
|
20096
|
+
* Image hash of the cover photo (obtain from the Meta Ad Images API). Omit to show no image.
|
|
20097
|
+
*/
|
|
20098
|
+
coverPhoto?: string;
|
|
20099
|
+
};
|
|
20026
20100
|
};
|
|
20027
20101
|
};
|
|
20028
20102
|
type CreateLeadFormResponse = ({
|
|
@@ -20201,9 +20275,9 @@ type SearchAdTargetingData = {
|
|
|
20201
20275
|
*/
|
|
20202
20276
|
dimension?: 'geo' | 'interest' | 'behavior' | 'income';
|
|
20203
20277
|
/**
|
|
20204
|
-
* Only used when `dimension=geo`. The kind of location to resolve. `place` resolves named points of interest (businesses, landmarks)
|
|
20278
|
+
* Only used when `dimension=geo`. The kind of location to resolve. `place` resolves named points of interest (businesses, landmarks). `neighborhood` resolves named neighbourhood areas. Use `all` to search every geo type in a single relevance-ranked call — mirrors Meta's own unified search box. Defaults to `city`.
|
|
20205
20279
|
*/
|
|
20206
|
-
geoType?: 'country' | 'region' | 'city' | 'subcity' | 'neighborhood' | 'place' | 'zip' | 'metro_area' | 'geo_market';
|
|
20280
|
+
geoType?: 'all' | 'country' | 'region' | 'city' | 'subcity' | 'neighborhood' | 'place' | 'zip' | 'metro_area' | 'geo_market';
|
|
20207
20281
|
/**
|
|
20208
20282
|
* Maximum results to return.
|
|
20209
20283
|
*/
|
|
@@ -20236,6 +20310,14 @@ type SearchAdTargetingResponse = ({
|
|
|
20236
20310
|
* Optional estimated reachable users for this option, when the platform returns it.
|
|
20237
20311
|
*/
|
|
20238
20312
|
audienceSize?: (number) | null;
|
|
20313
|
+
/**
|
|
20314
|
+
* Centre latitude of the location. Populated on Meta geo results (city, neighborhood, place, etc.). Useful for map views.
|
|
20315
|
+
*/
|
|
20316
|
+
latitude?: (number) | null;
|
|
20317
|
+
/**
|
|
20318
|
+
* Centre longitude of the location.
|
|
20319
|
+
*/
|
|
20320
|
+
longitude?: (number) | null;
|
|
20239
20321
|
}>;
|
|
20240
20322
|
});
|
|
20241
20323
|
type SearchAdTargetingError = (unknown | {
|
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.
|
|
39
|
+
version: "0.2.276",
|
|
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.
|
|
8
|
+
version: "0.2.276",
|
|
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
|
@@ -19987,6 +19987,36 @@ export type CreateStandaloneAdData = {
|
|
|
19987
19987
|
name?: string;
|
|
19988
19988
|
address?: string;
|
|
19989
19989
|
}>;
|
|
19990
|
+
/**
|
|
19991
|
+
* Named points of interest (businesses, landmarks). Meta only. `key` from /v1/ads/targeting/search?dimension=geo&geoType=place. Maps to geo_locations.places.
|
|
19992
|
+
*/
|
|
19993
|
+
places?: Array<{
|
|
19994
|
+
key: string;
|
|
19995
|
+
}>;
|
|
19996
|
+
/**
|
|
19997
|
+
* Named neighbourhood areas. Meta only. `key` from /v1/ads/targeting/search?dimension=geo&geoType=neighborhood. Maps to geo_locations.neighborhoods.
|
|
19998
|
+
*/
|
|
19999
|
+
neighborhoods?: Array<{
|
|
20000
|
+
key: string;
|
|
20001
|
+
}>;
|
|
20002
|
+
/**
|
|
20003
|
+
* Geo exclusions. Meta only. Maps to excluded_geo_locations. Supports countries, regions, cities, and zips.
|
|
20004
|
+
*/
|
|
20005
|
+
excludedLocations?: {
|
|
20006
|
+
/**
|
|
20007
|
+
* ISO-3166 alpha-2 country codes to exclude.
|
|
20008
|
+
*/
|
|
20009
|
+
countries?: Array<(string)>;
|
|
20010
|
+
regions?: Array<{
|
|
20011
|
+
key: string;
|
|
20012
|
+
}>;
|
|
20013
|
+
cities?: Array<{
|
|
20014
|
+
key: string;
|
|
20015
|
+
}>;
|
|
20016
|
+
zips?: Array<{
|
|
20017
|
+
key: string;
|
|
20018
|
+
}>;
|
|
20019
|
+
};
|
|
19990
20020
|
/**
|
|
19991
20021
|
* Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta and TikTok. Each must include id.
|
|
19992
20022
|
*/
|
|
@@ -20533,7 +20563,51 @@ export type CreateLeadFormData = {
|
|
|
20533
20563
|
thankYouButtonText?: string;
|
|
20534
20564
|
thankYouButtonType?: string;
|
|
20535
20565
|
thankYouWebsiteUrl?: string;
|
|
20566
|
+
/**
|
|
20567
|
+
* Legacy form type toggle. Prefer formType instead. false = More Volume, true = Higher Intent.
|
|
20568
|
+
*/
|
|
20536
20569
|
isOptimizedForQuality?: boolean;
|
|
20570
|
+
/**
|
|
20571
|
+
* Form type. MORE_VOLUME = optimized for lead quantity (default). HIGHER_INTENT = adds a review/confirmation step before submit. RICH_CREATIVE = includes context card and custom headline to educate users before they submit. Supersedes isOptimizedForQuality.
|
|
20572
|
+
*/
|
|
20573
|
+
formType?: 'MORE_VOLUME' | 'HIGHER_INTENT' | 'RICH_CREATIVE';
|
|
20574
|
+
/**
|
|
20575
|
+
* Sharing setting. true = Restricted (only people targeted by the ad can open the form link). false = Open (shareable link, default).
|
|
20576
|
+
*/
|
|
20577
|
+
blockDisplayForNonTargetedViewer?: boolean;
|
|
20578
|
+
/**
|
|
20579
|
+
* Flexible form delivery. true = the form can surface organically on the Page (not just as a paid ad). Defaults to false.
|
|
20580
|
+
*/
|
|
20581
|
+
allowOrganicLeadGen?: boolean;
|
|
20582
|
+
/**
|
|
20583
|
+
* Custom subheadline shown above the form fields on the questions page (the contact-information section description). Defaults to Meta's generic copy when omitted.
|
|
20584
|
+
*/
|
|
20585
|
+
questionPageCustomHeadline?: string;
|
|
20586
|
+
/**
|
|
20587
|
+
* Intro card shown before the questions page. Omit to skip the intro screen.
|
|
20588
|
+
*/
|
|
20589
|
+
contextCard?: {
|
|
20590
|
+
/**
|
|
20591
|
+
* Headline / title of the intro card.
|
|
20592
|
+
*/
|
|
20593
|
+
title?: string;
|
|
20594
|
+
/**
|
|
20595
|
+
* Body text lines shown on the intro card.
|
|
20596
|
+
*/
|
|
20597
|
+
content?: Array<(string)>;
|
|
20598
|
+
/**
|
|
20599
|
+
* Visual layout of the intro card.
|
|
20600
|
+
*/
|
|
20601
|
+
style?: 'LIST_STYLE' | 'PARAGRAPH_STYLE';
|
|
20602
|
+
/**
|
|
20603
|
+
* CTA button label on the intro card.
|
|
20604
|
+
*/
|
|
20605
|
+
buttonText?: string;
|
|
20606
|
+
/**
|
|
20607
|
+
* Image hash of the cover photo (obtain from the Meta Ad Images API). Omit to show no image.
|
|
20608
|
+
*/
|
|
20609
|
+
coverPhoto?: string;
|
|
20610
|
+
};
|
|
20537
20611
|
};
|
|
20538
20612
|
};
|
|
20539
20613
|
|
|
@@ -20730,9 +20804,9 @@ export type SearchAdTargetingData = {
|
|
|
20730
20804
|
*/
|
|
20731
20805
|
dimension?: 'geo' | 'interest' | 'behavior' | 'income';
|
|
20732
20806
|
/**
|
|
20733
|
-
* Only used when `dimension=geo`. The kind of location to resolve. `place` resolves named points of interest (businesses, landmarks)
|
|
20807
|
+
* Only used when `dimension=geo`. The kind of location to resolve. `place` resolves named points of interest (businesses, landmarks). `neighborhood` resolves named neighbourhood areas. Use `all` to search every geo type in a single relevance-ranked call — mirrors Meta's own unified search box. Defaults to `city`.
|
|
20734
20808
|
*/
|
|
20735
|
-
geoType?: 'country' | 'region' | 'city' | 'subcity' | 'neighborhood' | 'place' | 'zip' | 'metro_area' | 'geo_market';
|
|
20809
|
+
geoType?: 'all' | 'country' | 'region' | 'city' | 'subcity' | 'neighborhood' | 'place' | 'zip' | 'metro_area' | 'geo_market';
|
|
20736
20810
|
/**
|
|
20737
20811
|
* Maximum results to return.
|
|
20738
20812
|
*/
|
|
@@ -20766,6 +20840,14 @@ export type SearchAdTargetingResponse = ({
|
|
|
20766
20840
|
* Optional estimated reachable users for this option, when the platform returns it.
|
|
20767
20841
|
*/
|
|
20768
20842
|
audienceSize?: (number) | null;
|
|
20843
|
+
/**
|
|
20844
|
+
* Centre latitude of the location. Populated on Meta geo results (city, neighborhood, place, etc.). Useful for map views.
|
|
20845
|
+
*/
|
|
20846
|
+
latitude?: (number) | null;
|
|
20847
|
+
/**
|
|
20848
|
+
* Centre longitude of the location.
|
|
20849
|
+
*/
|
|
20850
|
+
longitude?: (number) | null;
|
|
20769
20851
|
}>;
|
|
20770
20852
|
});
|
|
20771
20853
|
|