@getlatedev/node 0.2.1264 → 0.2.1266
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/README.md +4 -2
- package/dist/index.d.mts +253 -99
- package/dist/index.d.ts +253 -99
- package/dist/index.js +17 -1
- package/dist/index.mjs +17 -1
- package/package.json +1 -1
- package/src/client.ts +6 -0
- package/src/generated/sdk.gen.ts +50 -7
- package/src/generated/types.gen.ts +256 -99
|
@@ -1061,6 +1061,63 @@ export type adRelevance = 'BELOW_AVERAGE' | 'AVERAGE' | 'ABOVE_AVERAGE';
|
|
|
1061
1061
|
*/
|
|
1062
1062
|
export type landingPageExperience = 'BELOW_AVERAGE' | 'AVERAGE' | 'ABOVE_AVERAGE';
|
|
1063
1063
|
|
|
1064
|
+
export type AdLead = {
|
|
1065
|
+
/**
|
|
1066
|
+
* Zernio lead id.
|
|
1067
|
+
*/
|
|
1068
|
+
id?: string;
|
|
1069
|
+
/**
|
|
1070
|
+
* Meta lead id. On LinkedIn, the leadFormResponse id.
|
|
1071
|
+
*/
|
|
1072
|
+
leadgenId?: string;
|
|
1073
|
+
formId?: string;
|
|
1074
|
+
formName?: (string) | null;
|
|
1075
|
+
accountId?: string;
|
|
1076
|
+
adId?: (string) | null;
|
|
1077
|
+
adsetId?: (string) | null;
|
|
1078
|
+
/**
|
|
1079
|
+
* On LinkedIn, this is the LinkedIn Campaign id, which corresponds to platformAdSetId on GET /v1/ads (LinkedIn's Campaign Group is Zernio's campaign).
|
|
1080
|
+
*/
|
|
1081
|
+
campaignId?: (string) | null;
|
|
1082
|
+
isOrganic?: boolean;
|
|
1083
|
+
/**
|
|
1084
|
+
* ISO 8601.
|
|
1085
|
+
*/
|
|
1086
|
+
createdTime?: (string) | null;
|
|
1087
|
+
/**
|
|
1088
|
+
* Question key → answer. On LinkedIn, the key is the lowercased predefinedField, else the question name, else the numeric questionId; multiple-choice values are option labels (unlike Meta, which returns the option key).
|
|
1089
|
+
*/
|
|
1090
|
+
fields?: {
|
|
1091
|
+
[key: string]: (string);
|
|
1092
|
+
};
|
|
1093
|
+
/**
|
|
1094
|
+
* Raw Meta field_data.
|
|
1095
|
+
*/
|
|
1096
|
+
fieldData?: Array<{
|
|
1097
|
+
[key: string]: unknown;
|
|
1098
|
+
}>;
|
|
1099
|
+
/**
|
|
1100
|
+
* Meta leads only. `contacted` is set when the first WhatsApp message of a lead_received workflow is delivered, `unreachable` when it fails or the phone number is not valid.
|
|
1101
|
+
*/
|
|
1102
|
+
status?: 'new' | 'contacted' | 'unreachable' | 'qualified' | 'converted' | 'disqualified';
|
|
1103
|
+
statusChangedAt?: (string) | null;
|
|
1104
|
+
value?: (number) | null;
|
|
1105
|
+
currency?: (string) | null;
|
|
1106
|
+
/**
|
|
1107
|
+
* The contact a lead_received workflow created or matched for this lead.
|
|
1108
|
+
*/
|
|
1109
|
+
contactId?: (string) | null;
|
|
1110
|
+
/**
|
|
1111
|
+
* When the first WhatsApp message to the lead was delivered.
|
|
1112
|
+
*/
|
|
1113
|
+
firstContactedAt?: (string) | null;
|
|
1114
|
+
};
|
|
1115
|
+
|
|
1116
|
+
/**
|
|
1117
|
+
* Meta leads only. `contacted` is set when the first WhatsApp message of a lead_received workflow is delivered, `unreachable` when it fails or the phone number is not valid.
|
|
1118
|
+
*/
|
|
1119
|
+
export type status2 = 'new' | 'contacted' | 'unreachable' | 'qualified' | 'converted' | 'disqualified';
|
|
1120
|
+
|
|
1064
1121
|
export type AdMetrics = {
|
|
1065
1122
|
spend?: number;
|
|
1066
1123
|
impressions?: number;
|
|
@@ -2101,7 +2158,7 @@ export type AnalyticsSinglePostResponse = {
|
|
|
2101
2158
|
/**
|
|
2102
2159
|
* Overall post status. "partial" when some platforms published and others failed. While any platform is still pending or processing, the post's own status is returned instead (usually scheduled or publishing), even if another platform already published. A post with no published or failed platform (for example every platform cancelled) returns its own status with syncStatus unavailable and no platformAnalytics.
|
|
2103
2160
|
*/
|
|
2104
|
-
export type
|
|
2161
|
+
export type status3 = 'published' | 'failed' | 'partial' | 'scheduled' | 'publishing' | 'draft' | 'cancelled';
|
|
2105
2162
|
|
|
2106
2163
|
/**
|
|
2107
2164
|
* Overall sync state across all platforms
|
|
@@ -2405,7 +2462,7 @@ export type BlogArticle = {
|
|
|
2405
2462
|
/**
|
|
2406
2463
|
* WordPress and Wix. Post status (`future` = scheduled, `pending` = in review on Wix); omitted for Shopify.
|
|
2407
2464
|
*/
|
|
2408
|
-
export type
|
|
2465
|
+
export type status4 = 'publish' | 'future' | 'draft' | 'pending' | 'private';
|
|
2409
2466
|
|
|
2410
2467
|
/**
|
|
2411
2468
|
* Bluesky post settings. Supports text posts with up to 4 images or a single video. threadItems creates a reply chain (Bluesky thread). Images exceeding 1MB are automatically compressed. Alt text supported via mediaItem properties. Use langs to tag post language for feed-generator filtering.
|
|
@@ -2553,7 +2610,7 @@ export type BrandedCallingIdentity = {
|
|
|
2553
2610
|
/**
|
|
2554
2611
|
* requested = in Zernio review; changes_requested = answer the review (PATCH); pending_email_verification = confirm the code emailed to the authorizer; in_review = with the carrier vetting team; verified = attach numbers; rejected = fix and PATCH to resubmit; suspended = an infringement claim is open; expired = the yearly verification lapsed; permanently_rejected = terminal.
|
|
2555
2612
|
*/
|
|
2556
|
-
export type
|
|
2613
|
+
export type status5 = 'requested' | 'changes_requested' | 'rejected' | 'pending_email_verification' | 'in_review' | 'verified' | 'suspended' | 'expired' | 'permanently_rejected';
|
|
2557
2614
|
|
|
2558
2615
|
export type BrandedCallingIdentityNumber = {
|
|
2559
2616
|
phoneNumberId?: string;
|
|
@@ -2575,7 +2632,7 @@ export type BrandedCallingIdentityNumber = {
|
|
|
2575
2632
|
/**
|
|
2576
2633
|
* verified = the identity shows on calls from this number. permanently_rejected cannot be attached again anywhere.
|
|
2577
2634
|
*/
|
|
2578
|
-
export type
|
|
2635
|
+
export type status6 = 'submitted' | 'in_review' | 'verified' | 'unsuccessful' | 'suspended' | 'expired' | 'permanently_rejected';
|
|
2579
2636
|
|
|
2580
2637
|
/**
|
|
2581
2638
|
* A person the carrier vetting team phones to confirm the business. Business references are senior contacts at a vendor, partner or client; the financial reference is a CPA or a bank contact. Calls are placed in the reference's local 8am-9pm window.
|
|
@@ -2807,7 +2864,7 @@ export type BusinessAgentEventStatus = {
|
|
|
2807
2864
|
updated_at: string;
|
|
2808
2865
|
};
|
|
2809
2866
|
|
|
2810
|
-
export type
|
|
2867
|
+
export type status7 = 'request_received' | 'processing' | 'sent' | 'failed' | 'skipped' | 'success';
|
|
2811
2868
|
|
|
2812
2869
|
export type BusinessAgentFaq = BusinessAgentFaqInput & {
|
|
2813
2870
|
id: string;
|
|
@@ -2904,7 +2961,7 @@ export type BusinessAgentSkill = BusinessAgentSkillInput & {
|
|
|
2904
2961
|
/**
|
|
2905
2962
|
* pending_review right after a write; blocked means Meta content review rejected it and the agent never applies it.
|
|
2906
2963
|
*/
|
|
2907
|
-
export type
|
|
2964
|
+
export type status8 = 'active' | 'pending_review' | 'blocked';
|
|
2908
2965
|
|
|
2909
2966
|
export type BusinessAgentSkillInput = {
|
|
2910
2967
|
/**
|
|
@@ -3006,7 +3063,7 @@ export type BusinessAgentUiSkillInput = {
|
|
|
3006
3063
|
|
|
3007
3064
|
export type component_type = 'carousel_quick_reply' | 'carousel_url' | 'cta_url' | 'flow' | 'image' | 'interactive_list' | 'interactive_reply_buttons' | 'location' | 'location_request';
|
|
3008
3065
|
|
|
3009
|
-
export type
|
|
3066
|
+
export type status9 = 'enabled' | 'disabled';
|
|
3010
3067
|
|
|
3011
3068
|
export type BusinessAgentWebsite = BusinessAgentWebsiteInput & {
|
|
3012
3069
|
id: string;
|
|
@@ -3197,7 +3254,7 @@ export type channel = 'whatsapp' | 'pstn';
|
|
|
3197
3254
|
|
|
3198
3255
|
export type direction = 'inbound' | 'outbound';
|
|
3199
3256
|
|
|
3200
|
-
export type
|
|
3257
|
+
export type status10 = 'ringing' | 'answered' | 'ended' | 'failed';
|
|
3201
3258
|
|
|
3202
3259
|
/**
|
|
3203
3260
|
* Caller ID presented on the forwarded leg.
|
|
@@ -3575,7 +3632,7 @@ export type source = 'comment' | 'live_comment' | 'story_reply' | 'story_mention
|
|
|
3575
3632
|
/**
|
|
3576
3633
|
* DM outcome. 'pending' = the automation has a dmDelaySeconds and the response is queued but not sent yet. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap. 'skipped' also covers repeatPolicy, cooldown and dedupeSameTextHours suppressions, with the reason in error.
|
|
3577
3634
|
*/
|
|
3578
|
-
export type
|
|
3635
|
+
export type status11 = 'pending' | 'sent' | 'failed' | 'skipped' | 'gated';
|
|
3579
3636
|
|
|
3580
3637
|
/**
|
|
3581
3638
|
* How the audience rule resolved. Null on automations without one.
|
|
@@ -3869,7 +3926,7 @@ export type method = 'code' | 'automatic';
|
|
|
3869
3926
|
|
|
3870
3927
|
export type type5 = 'percentage' | 'fixed_amount' | 'free_shipping' | 'buy_x_get_y' | 'app';
|
|
3871
3928
|
|
|
3872
|
-
export type
|
|
3929
|
+
export type status12 = 'active' | 'scheduled' | 'expired';
|
|
3873
3930
|
|
|
3874
3931
|
export type CommerceImage = {
|
|
3875
3932
|
/**
|
|
@@ -3924,7 +3981,7 @@ export type CommerceMarket = {
|
|
|
3924
3981
|
type?: string;
|
|
3925
3982
|
};
|
|
3926
3983
|
|
|
3927
|
-
export type
|
|
3984
|
+
export type status13 = 'active' | 'draft';
|
|
3928
3985
|
|
|
3929
3986
|
export type CommerceMenu = {
|
|
3930
3987
|
id?: string;
|
|
@@ -4480,7 +4537,7 @@ export type ConversionDestination = {
|
|
|
4480
4537
|
* For LinkedIn, `inactive` means the rule is soft-deleted (`enabled: false`).
|
|
4481
4538
|
*
|
|
4482
4539
|
*/
|
|
4483
|
-
export type
|
|
4540
|
+
export type status14 = 'active' | 'inactive';
|
|
4484
4541
|
|
|
4485
4542
|
/**
|
|
4486
4543
|
* A single conversion event to relay to the ad platform. All PII fields
|
|
@@ -5609,7 +5666,7 @@ export type objective = 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS'
|
|
|
5609
5666
|
* `adSetId`, the new ads themselves.
|
|
5610
5667
|
*
|
|
5611
5668
|
*/
|
|
5612
|
-
export type
|
|
5669
|
+
export type status15 = 'ACTIVE' | 'PAUSED';
|
|
5613
5670
|
|
|
5614
5671
|
/**
|
|
5615
5672
|
* Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
|
|
@@ -6001,7 +6058,7 @@ export type privacy_level = 2;
|
|
|
6001
6058
|
/**
|
|
6002
6059
|
* 1=SCHEDULED, 2=ACTIVE, 3=COMPLETED, 4=CANCELED
|
|
6003
6060
|
*/
|
|
6004
|
-
export type
|
|
6061
|
+
export type status16 = 1 | 2 | 3 | 4;
|
|
6005
6062
|
|
|
6006
6063
|
/**
|
|
6007
6064
|
* 1=STAGE_INSTANCE, 2=VOICE, 3=EXTERNAL
|
|
@@ -6544,7 +6601,7 @@ export type FeedbackReceipt = {
|
|
|
6544
6601
|
duplicate?: boolean;
|
|
6545
6602
|
};
|
|
6546
6603
|
|
|
6547
|
-
export type
|
|
6604
|
+
export type status17 = 'received';
|
|
6548
6605
|
|
|
6549
6606
|
export type FollowerStatsResponse = {
|
|
6550
6607
|
accounts?: Array<AccountWithFollowerStats>;
|
|
@@ -6669,7 +6726,7 @@ export type GoogleAdLabel = {
|
|
|
6669
6726
|
description?: (string) | null;
|
|
6670
6727
|
};
|
|
6671
6728
|
|
|
6672
|
-
export type
|
|
6729
|
+
export type status18 = 'ENABLED' | 'REMOVED' | 'UNKNOWN';
|
|
6673
6730
|
|
|
6674
6731
|
/**
|
|
6675
6732
|
* At least one id across the four target lists. Up to 1000 ids per list.
|
|
@@ -6772,7 +6829,7 @@ export type GoogleAdsManagerLink = {
|
|
|
6772
6829
|
/**
|
|
6773
6830
|
* Status the link has after this call.
|
|
6774
6831
|
*/
|
|
6775
|
-
export type
|
|
6832
|
+
export type status19 = 'PENDING' | 'ACTIVE' | 'REFUSED' | 'CANCELED' | 'INACTIVE';
|
|
6776
6833
|
|
|
6777
6834
|
export type GoogleAdsUserAccessInvitation = {
|
|
6778
6835
|
invitationId?: string;
|
|
@@ -6787,7 +6844,7 @@ export type GoogleAdsUserAccessInvitation = {
|
|
|
6787
6844
|
|
|
6788
6845
|
export type accessRole = 'ADMIN' | 'STANDARD' | 'READ_ONLY' | 'EMAIL_ONLY' | 'UNKNOWN';
|
|
6789
6846
|
|
|
6790
|
-
export type
|
|
6847
|
+
export type status20 = 'PENDING' | 'DECLINED' | 'EXPIRED' | 'UNKNOWN';
|
|
6791
6848
|
|
|
6792
6849
|
export type GoogleAdsUserAccessInvitationResult = {
|
|
6793
6850
|
customerId?: string;
|
|
@@ -6811,7 +6868,7 @@ export type GoogleAdsUserAccessInvitationResult = {
|
|
|
6811
6868
|
/**
|
|
6812
6869
|
* PENDING once the email is sent; PENDING_APPROVAL while Google waits for a second admin's multi-party approval.
|
|
6813
6870
|
*/
|
|
6814
|
-
export type
|
|
6871
|
+
export type status21 = 'PENDING' | 'PENDING_APPROVAL';
|
|
6815
6872
|
|
|
6816
6873
|
export type GoogleAdsUserInvitationApproval = {
|
|
6817
6874
|
/**
|
|
@@ -7576,7 +7633,7 @@ export type GoogleRecommendationResult = {
|
|
|
7576
7633
|
error?: string;
|
|
7577
7634
|
};
|
|
7578
7635
|
|
|
7579
|
-
export type
|
|
7636
|
+
export type status22 = 'applied' | 'dismissed' | 'failed';
|
|
7580
7637
|
|
|
7581
7638
|
export type GoogleRsaDescription = {
|
|
7582
7639
|
text: string;
|
|
@@ -7711,7 +7768,7 @@ export type ImessageSandboxContact = {
|
|
|
7711
7768
|
createdAt?: string;
|
|
7712
7769
|
};
|
|
7713
7770
|
|
|
7714
|
-
export type
|
|
7771
|
+
export type status23 = 'pending' | 'active';
|
|
7715
7772
|
|
|
7716
7773
|
/**
|
|
7717
7774
|
* An iMessage sender registered as an account on a profile.
|
|
@@ -7786,7 +7843,7 @@ export type region = 'US' | 'GB';
|
|
|
7786
7843
|
/**
|
|
7787
7844
|
* `awaiting_payment`: the first-month charge is still being confirmed by the card; the number is ordered automatically once it is paid (usually under 5 minutes), or the order fails with `failureReason` when the card declines or nothing confirms within 30 minutes.
|
|
7788
7845
|
*/
|
|
7789
|
-
export type
|
|
7846
|
+
export type status24 = 'ordering' | 'awaiting_payment' | 'activating' | 'active' | 'suspended' | 'canceled' | 'failed';
|
|
7790
7847
|
|
|
7791
7848
|
/**
|
|
7792
7849
|
* Attachment snapshot inside an edit-history entry.
|
|
@@ -7858,7 +7915,7 @@ export type InboxWebhookConversation = {
|
|
|
7858
7915
|
contactId?: string;
|
|
7859
7916
|
};
|
|
7860
7917
|
|
|
7861
|
-
export type
|
|
7918
|
+
export type status25 = 'active' | 'archived';
|
|
7862
7919
|
|
|
7863
7920
|
/**
|
|
7864
7921
|
* The conversation object included in conversation lifecycle webhook payloads (conversation.started, conversation.control_changed).
|
|
@@ -9824,7 +9881,7 @@ export type OwnedPhoneNumber = {
|
|
|
9824
9881
|
}>;
|
|
9825
9882
|
};
|
|
9826
9883
|
|
|
9827
|
-
export type
|
|
9884
|
+
export type status26 = 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
9828
9885
|
|
|
9829
9886
|
export type metaVerificationStatus = 'pending' | 'code_requested' | 'verified' | 'expired';
|
|
9830
9887
|
|
|
@@ -9962,7 +10019,7 @@ export type PlatformAnalytics = {
|
|
|
9962
10019
|
isOwner?: (boolean) | null;
|
|
9963
10020
|
};
|
|
9964
10021
|
|
|
9965
|
-
export type
|
|
10022
|
+
export type status27 = 'published' | 'failed';
|
|
9966
10023
|
|
|
9967
10024
|
/**
|
|
9968
10025
|
* Sync state of analytics for this platform
|
|
@@ -10397,7 +10454,7 @@ export type Product = {
|
|
|
10397
10454
|
publishedAt?: (string) | null;
|
|
10398
10455
|
};
|
|
10399
10456
|
|
|
10400
|
-
export type
|
|
10457
|
+
export type status28 = 'active' | 'draft' | 'archived';
|
|
10401
10458
|
|
|
10402
10459
|
export type ProductImage = {
|
|
10403
10460
|
url?: string;
|
|
@@ -10616,7 +10673,7 @@ export type RcsAgent = {
|
|
|
10616
10673
|
createdAt?: string;
|
|
10617
10674
|
};
|
|
10618
10675
|
|
|
10619
|
-
export type
|
|
10676
|
+
export type status29 = 'requested' | 'changes_requested' | 'brand_vetting' | 'agent_review' | 'testing' | 'launch_review' | 'launching' | 'live' | 'rejected' | 'deactivated';
|
|
10620
10677
|
|
|
10621
10678
|
export type useCase = 'MULTI_USE' | 'PROMOTIONAL' | 'TRANSACTIONAL' | 'OTP';
|
|
10622
10679
|
|
|
@@ -10668,7 +10725,7 @@ export type RcsBrand = RcsBrandInput & {
|
|
|
10668
10725
|
/**
|
|
10669
10726
|
* draft = not filed yet (still editable).
|
|
10670
10727
|
*/
|
|
10671
|
-
export type
|
|
10728
|
+
export type status30 = 'draft' | 'vetting' | 'verified' | 'rejected';
|
|
10672
10729
|
|
|
10673
10730
|
export type RcsBrandInput = {
|
|
10674
10731
|
displayName: string;
|
|
@@ -10755,7 +10812,7 @@ export type RcsCarrierApproval = {
|
|
|
10755
10812
|
|
|
10756
10813
|
export type scope2 = 'carrier' | 'hub' | 'bot';
|
|
10757
10814
|
|
|
10758
|
-
export type
|
|
10815
|
+
export type status31 = 'PENDING' | 'SUBMITTED' | 'APPROVED' | 'REJECTED';
|
|
10759
10816
|
|
|
10760
10817
|
/**
|
|
10761
10818
|
* Message content. `suggestions` (max 11) render as chips under the message.
|
|
@@ -11453,14 +11510,14 @@ export type platform13 = 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'link
|
|
|
11453
11510
|
export type tiktokAccountType = 'business' | 'personal' | 'unknown';
|
|
11454
11511
|
|
|
11455
11512
|
/**
|
|
11456
|
-
* A tracking tag's install on a connected store: a Shopify web pixel, a Custom HTML widget on a WordPress site,
|
|
11513
|
+
* A tracking tag's install on a connected store: a Shopify web pixel, a Custom HTML widget on a WordPress site, the Zernio embedded script on a Wix site, or the Zernio custom code script on a Webflow site. Fields marked with a platform are present only for it.
|
|
11457
11514
|
*/
|
|
11458
11515
|
export type StorePixelInstall = {
|
|
11459
11516
|
storeAccountId?: string;
|
|
11460
11517
|
/**
|
|
11461
11518
|
* The store platform.
|
|
11462
11519
|
*/
|
|
11463
|
-
platform?: 'shopify' | 'wordpress' | 'wix';
|
|
11520
|
+
platform?: 'shopify' | 'wordpress' | 'wix' | 'webflow';
|
|
11464
11521
|
/**
|
|
11465
11522
|
* Platform of the tag this install is about (e.g. `metaads`).
|
|
11466
11523
|
*/
|
|
@@ -11470,7 +11527,7 @@ export type StorePixelInstall = {
|
|
|
11470
11527
|
*/
|
|
11471
11528
|
siteTagId?: string;
|
|
11472
11529
|
/**
|
|
11473
|
-
* Shopify and
|
|
11530
|
+
* Shopify, Wix and Webflow: this tag is the one the store fires for its platform. WordPress: the Zernio widget for this tag is in an active widget area with its script intact.
|
|
11474
11531
|
*/
|
|
11475
11532
|
installed?: boolean;
|
|
11476
11533
|
/**
|
|
@@ -11478,11 +11535,11 @@ export type StorePixelInstall = {
|
|
|
11478
11535
|
*/
|
|
11479
11536
|
shopDomain?: string;
|
|
11480
11537
|
/**
|
|
11481
|
-
* Shopify and
|
|
11538
|
+
* Shopify, Wix and Webflow only: the tag of the same platform the store fires now (may be a different tag), or null.
|
|
11482
11539
|
*/
|
|
11483
11540
|
installedTagId?: (string) | null;
|
|
11484
11541
|
/**
|
|
11485
|
-
* GET only on WordPress, always on Shopify and
|
|
11542
|
+
* GET only on WordPress, always on Shopify, Wix and Webflow: every Zernio tag on the store, all platforms.
|
|
11486
11543
|
*/
|
|
11487
11544
|
tags?: Array<{
|
|
11488
11545
|
platform?: string;
|
|
@@ -11505,9 +11562,13 @@ export type StorePixelInstall = {
|
|
|
11505
11562
|
*/
|
|
11506
11563
|
webPixelId?: (string) | null;
|
|
11507
11564
|
/**
|
|
11508
|
-
* WordPress and
|
|
11565
|
+
* WordPress, Wix and Webflow only. Null on a Wix site that was never published.
|
|
11509
11566
|
*/
|
|
11510
11567
|
siteUrl?: (string) | null;
|
|
11568
|
+
/**
|
|
11569
|
+
* Webflow only, always true: the change reaches the live site on its next publish.
|
|
11570
|
+
*/
|
|
11571
|
+
publishRequired?: boolean;
|
|
11511
11572
|
/**
|
|
11512
11573
|
* WordPress only.
|
|
11513
11574
|
*/
|
|
@@ -11522,11 +11583,6 @@ export type StorePixelInstall = {
|
|
|
11522
11583
|
sidebarId?: (string) | null;
|
|
11523
11584
|
};
|
|
11524
11585
|
|
|
11525
|
-
/**
|
|
11526
|
-
* The store platform.
|
|
11527
|
-
*/
|
|
11528
|
-
export type platform14 = 'shopify' | 'wordpress' | 'wix';
|
|
11529
|
-
|
|
11530
11586
|
/**
|
|
11531
11587
|
* WordPress only.
|
|
11532
11588
|
*/
|
|
@@ -11588,7 +11644,7 @@ export type SupportRun = {
|
|
|
11588
11644
|
/**
|
|
11589
11645
|
* queued and running are in progress. needs_human means the assistant handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
|
|
11590
11646
|
*/
|
|
11591
|
-
export type
|
|
11647
|
+
export type status32 = 'queued' | 'running' | 'completed' | 'needs_human' | 'failed';
|
|
11592
11648
|
|
|
11593
11649
|
/**
|
|
11594
11650
|
* Why the run stopped. Null while it is in progress.
|
|
@@ -12238,7 +12294,7 @@ export type TrackingTag = {
|
|
|
12238
12294
|
autoTagging?: boolean;
|
|
12239
12295
|
};
|
|
12240
12296
|
|
|
12241
|
-
export type
|
|
12297
|
+
export type platform14 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads' | 'pinterestads' | 'whopads';
|
|
12242
12298
|
|
|
12243
12299
|
/**
|
|
12244
12300
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
@@ -12490,7 +12546,7 @@ export type UploadTokenResponse = {
|
|
|
12490
12546
|
status?: 'pending' | 'completed' | 'expired';
|
|
12491
12547
|
};
|
|
12492
12548
|
|
|
12493
|
-
export type
|
|
12549
|
+
export type status33 = 'pending' | 'completed' | 'expired';
|
|
12494
12550
|
|
|
12495
12551
|
export type UploadTokenStatusResponse = {
|
|
12496
12552
|
token?: string;
|
|
@@ -12997,7 +13053,7 @@ export type Verification = {
|
|
|
12997
13053
|
resend?: boolean;
|
|
12998
13054
|
};
|
|
12999
13055
|
|
|
13000
|
-
export type
|
|
13056
|
+
export type status34 = 'pending' | 'approved' | 'expired' | 'max_attempts_reached' | 'canceled' | 'delivery_failed';
|
|
13001
13057
|
|
|
13002
13058
|
export type channel5 = 'sms' | 'whatsapp';
|
|
13003
13059
|
|
|
@@ -13155,7 +13211,7 @@ export type WebhookLog = {
|
|
|
13155
13211
|
/**
|
|
13156
13212
|
* Delivery outcome
|
|
13157
13213
|
*/
|
|
13158
|
-
export type
|
|
13214
|
+
export type status35 = 'success' | 'failed';
|
|
13159
13215
|
|
|
13160
13216
|
/**
|
|
13161
13217
|
* Webhook payload for `account.ads.initial_sync_completed` events.
|
|
@@ -13272,7 +13328,7 @@ export type event = 'account.ads.initial_sync_completed';
|
|
|
13272
13328
|
/**
|
|
13273
13329
|
* Overall outcome of the initial sync.
|
|
13274
13330
|
*/
|
|
13275
|
-
export type
|
|
13331
|
+
export type status36 = 'success' | 'failure';
|
|
13276
13332
|
|
|
13277
13333
|
/**
|
|
13278
13334
|
* Stable category for UX branching. New values may be added; existing ones are
|
|
@@ -13663,7 +13719,7 @@ export type event7 = 'ad.video.processed';
|
|
|
13663
13719
|
/**
|
|
13664
13720
|
* `ready`: usable as `video.id` on the create endpoints. `error`: Meta could not process it; upload again.
|
|
13665
13721
|
*/
|
|
13666
|
-
export type
|
|
13722
|
+
export type status37 = 'ready' | 'error';
|
|
13667
13723
|
|
|
13668
13724
|
/**
|
|
13669
13725
|
* Webhook payload for `analytics.synced`. Fired once per connected account each
|
|
@@ -14154,7 +14210,7 @@ export type WebhookPayloadComment = {
|
|
|
14154
14210
|
|
|
14155
14211
|
export type event14 = 'comment.received';
|
|
14156
14212
|
|
|
14157
|
-
export type
|
|
14213
|
+
export type platform15 = 'instagram' | 'facebook' | 'threads' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit' | 'tiktok';
|
|
14158
14214
|
|
|
14159
14215
|
export type WebhookPayloadCommerceOrder = {
|
|
14160
14216
|
/**
|
|
@@ -14516,7 +14572,7 @@ export type WebhookPayloadLead = {
|
|
|
14516
14572
|
|
|
14517
14573
|
export type event22 = 'lead.received';
|
|
14518
14574
|
|
|
14519
|
-
export type
|
|
14575
|
+
export type platform16 = 'facebook';
|
|
14520
14576
|
|
|
14521
14577
|
/**
|
|
14522
14578
|
* Webhook payload for message received events
|
|
@@ -15533,7 +15589,7 @@ export type event27 = 'message.sent';
|
|
|
15533
15589
|
/**
|
|
15534
15590
|
* Every platform whose outgoing messages Zernio observes. sms is absent on purpose: its carrier receipts update delivery status and never raise message.sent.
|
|
15535
15591
|
*/
|
|
15536
|
-
export type
|
|
15592
|
+
export type platform17 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'slack' | 'tiktok' | 'imessage';
|
|
15537
15593
|
|
|
15538
15594
|
/**
|
|
15539
15595
|
* WhatsApp send origin. whatsapp_business_app when sent from the WhatsApp Business phone app on a Coexistence number; cloud_api when sent through Zernio (dashboard, API, or broadcasts); meta_business_agent when Meta Business Agent answered on the number. Absent on non-WhatsApp platforms. Says where WhatsApp saw the send come from, not which Zernio surface produced it: read sentVia for that.
|
|
@@ -15770,7 +15826,7 @@ export type event30 = 'post.platform.published' | 'post.platform.failed' | 'post
|
|
|
15770
15826
|
/**
|
|
15771
15827
|
* Terminal status this event fires on. Matches the event suffix.
|
|
15772
15828
|
*/
|
|
15773
|
-
export type
|
|
15829
|
+
export type status38 = 'published' | 'failed' | 'deleted';
|
|
15774
15830
|
|
|
15775
15831
|
/**
|
|
15776
15832
|
* Webhook payload for reaction received events (WhatsApp, Telegram, Slack, Instagram, Facebook Messenger, TikTok)
|
|
@@ -16108,7 +16164,7 @@ export type WebhookPayloadWhatsAppAccountAlertReceived = {
|
|
|
16108
16164
|
|
|
16109
16165
|
export type event38 = 'whatsapp.account.alert_received';
|
|
16110
16166
|
|
|
16111
|
-
export type
|
|
16167
|
+
export type platform18 = 'whatsapp';
|
|
16112
16168
|
|
|
16113
16169
|
/**
|
|
16114
16170
|
* Webhook payload for the `whatsapp.account.name_status_updated` event.
|
|
@@ -16167,7 +16223,7 @@ export type event39 = 'whatsapp.account.name_status_updated';
|
|
|
16167
16223
|
/**
|
|
16168
16224
|
* Normalized from Meta's `decision` (REJECTED -> DECLINED, DEFERRED -> PENDING_REVIEW; the review is still open on DEFERRED, not a rejection).
|
|
16169
16225
|
*/
|
|
16170
|
-
export type
|
|
16226
|
+
export type status39 = 'APPROVED' | 'DECLINED' | 'PENDING_REVIEW';
|
|
16171
16227
|
|
|
16172
16228
|
/**
|
|
16173
16229
|
* Webhook payload for `whatsapp.account.quality_updated`. Fired when a connected
|
|
@@ -16301,7 +16357,7 @@ export type event41 = 'whatsapp.account.status_updated';
|
|
|
16301
16357
|
/**
|
|
16302
16358
|
* `active` only on a reinstatement (DISABLED_UPDATE with ban state REINSTATE).
|
|
16303
16359
|
*/
|
|
16304
|
-
export type
|
|
16360
|
+
export type status40 = 'restricted' | 'active';
|
|
16305
16361
|
|
|
16306
16362
|
/**
|
|
16307
16363
|
* Webhook payload for the `whatsapp.contact.identity_changed` event. Fired when
|
|
@@ -16517,7 +16573,7 @@ export type event44 = 'whatsapp.template.status_updated';
|
|
|
16517
16573
|
* request before the template is actually removed.
|
|
16518
16574
|
*
|
|
16519
16575
|
*/
|
|
16520
|
-
export type
|
|
16576
|
+
export type status41 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
|
|
16521
16577
|
|
|
16522
16578
|
export type WebhookPayloadWorkflowRun = {
|
|
16523
16579
|
/**
|
|
@@ -16581,7 +16637,7 @@ export type event45 = 'workflow.run.started' | 'workflow.run.completed' | 'workf
|
|
|
16581
16637
|
/**
|
|
16582
16638
|
* running on workflow.run.started; completed or exited (ended on purpose before the last node, e.g. a handoff) on workflow.run.completed; failed on workflow.run.failed.
|
|
16583
16639
|
*/
|
|
16584
|
-
export type
|
|
16640
|
+
export type status42 = 'running' | 'waiting' | 'completed' | 'exited' | 'failed';
|
|
16585
16641
|
|
|
16586
16642
|
/**
|
|
16587
16643
|
* The profiles this event belongs to, each with the externalId you set on it (null when none is set). Present on every event tied to a profile and absent on events that belong to none. Events spanning several profiles (a post published to accounts of different profiles) list each once. Use it to route the event to your tenant without storing Zernio profile ids.
|
|
@@ -16979,7 +17035,7 @@ export type WorkflowExecutionEvent = {
|
|
|
16979
17035
|
|
|
16980
17036
|
export type action2 = 'execution_started' | 'execution_completed' | 'execution_exited' | 'execution_paused' | 'execution_resumed' | 'node_started' | 'node_completed' | 'node_failed' | 'node_skipped';
|
|
16981
17037
|
|
|
16982
|
-
export type
|
|
17038
|
+
export type status43 = 'success' | 'failed' | 'pending';
|
|
16983
17039
|
|
|
16984
17040
|
/**
|
|
16985
17041
|
* A node in a workflow graph. `config` shape depends on `type`.
|
|
@@ -17001,9 +17057,9 @@ export type WorkflowNode = {
|
|
|
17001
17057
|
/**
|
|
17002
17058
|
* Type-specific settings. All string fields support `{{variable}}` interpolation against the run's variable bag (resolved at execution time).
|
|
17003
17059
|
*
|
|
17004
|
-
* **trigger**: `{ triggerType: inbound_message|api_call|whatsapp_event|referral|story_mention|comment|reaction, keywords:[string], matchType: any|contains|exact|regex, onlyFirstMessage:boolean, eventType: message_sent|message_delivered|message_read|message_failed|reaction, referral:{ ref, matchType: exact|prefix|any }, reaction:{ emojis:[string] }, comment:{ keywords:[string], matchType: any|contains|exact|regex, platformPostId }, cooldownHours:int (1-720) }`. Default `triggerType` is `inbound_message` for legacy nodes. A workflow starts only on events of its own trigger type: `inbound_message` on a message, `referral` on an ig.me / m.me / click-to-message ad referral (standalone, or the first message carrying one; the two are deduplicated per conversation within 60 seconds), `story_mention` on an Instagram story mention, `reaction` on a reaction (Instagram, Facebook, WhatsApp, Telegram groups), `comment` on an Instagram or Facebook comment (the run starts with no conversation and its first `send_message`, which must be text (with optional buttons or quick replies) or cards and must follow the trigger directly (checked on save; on some Instagram accounts Meta refuses buttons and cards to commenters who do not follow the account), is sent as a private reply to the comment; the run then continues in the conversation that reply opens; when an active comment automation's keywords match the comment, the automation answers and the workflow does not start), `whatsapp_event` on a WhatsApp status of a message we sent (filtered by `eventType`), `api_call` only via `POST /v1/workflows/{workflowId}/trigger`. `referral.matchType` defaults to `any`. `cooldownHours` (inbound_message, referral, story_mention, reaction and
|
|
17060
|
+
* **trigger**: `{ triggerType: inbound_message|api_call|whatsapp_event|referral|story_mention|comment|reaction|lead_received, keywords:[string], matchType: any|contains|exact|regex, onlyFirstMessage:boolean, eventType: message_sent|message_delivered|message_read|message_failed|reaction, referral:{ ref, matchType: exact|prefix|any }, reaction:{ emojis:[string] }, comment:{ keywords:[string], matchType: any|contains|exact|regex, platformPostId }, leadReceived:{ formIds:[string], pageAccountIds:[string], consentCheckboxKey, defaultCountry, allowCrossProfile:boolean }, cooldownHours:int (1-720) }`. Default `triggerType` is `inbound_message` for legacy nodes. A workflow starts only on events of its own trigger type: `inbound_message` on a message, `referral` on an ig.me / m.me / click-to-message ad referral (standalone, or the first message carrying one; the two are deduplicated per conversation within 60 seconds), `story_mention` on an Instagram story mention, `reaction` on a reaction (Instagram, Facebook, WhatsApp, Telegram groups), `comment` on an Instagram or Facebook comment (the run starts with no conversation and its first `send_message`, which must be text (with optional buttons or quick replies) or cards and must follow the trigger directly (checked on save; on some Instagram accounts Meta refuses buttons and cards to commenters who do not follow the account), is sent as a private reply to the comment; the run then continues in the conversation that reply opens; when an active comment automation's keywords match the comment, the automation answers and the workflow does not start), `whatsapp_event` on a WhatsApp status of a message we sent (filtered by `eventType`), `api_call` only via `POST /v1/workflows/{workflowId}/trigger`, and `lead_received` (WhatsApp workflows only) when a Meta lead ad form is submitted. A `lead_received` trigger needs `leadReceived.consentCheckboxKey` and at least one of `formIds` or `pageAccountIds`; a form scope wins over a Page scope, then the earliest activated workflow. It starts only for leads submitted in the last hour and after the workflow was activated, whose consent checkbox (the form's custom disclaimer, see `POST /v1/ads/lead-forms`) is ticked, and whose phone number parses to a valid international number (`defaultCountry`, ISO 3166 alpha-2, defaults to the country of the workflow's WhatsApp number); otherwise the lead is marked `unreachable`. The Page and the WhatsApp number must be in the same profile unless `allowCrossProfile` is true. Every send or call reached first from the trigger must be a WhatsApp template (checked on save). `referral.matchType` defaults to `any`. `cooldownHours` (inbound_message, referral, story_mention, reaction, whatsapp_event and lead_received, where it defaults to 24) stops the same contact from starting the workflow again inside the window. A `whatsapp_event` workflow never starts on the status of a message a workflow, sequence or comment automation sent. A redelivered platform event never starts the same workflow twice.
|
|
17005
17061
|
*
|
|
17006
|
-
* **Variables** available from the start of every run (absent values are `''`): `lastMessage`, `inboundText`, `triggerText`, `conversationId`, `contact.name`, `contact.phone`, `contact.handle`, `contact.tags` (array), `contact.fields` (the contact's custom fields object), `contact.lastInteractionAt` (ISO date), `contact.lastInteractionHoursAgo` (number), `contact.isFollower` (Instagram, from the stored profile: true, false or `''` when unknown), `referral.ref`, `referral.source`, `referral.type`, `referral.adId`, `postback.payload`, `postback.title`, `quickReply.payload`, `quickReply.title`, `story.id`, `story.url`, `comment.id`, `comment.text`, `comment.platformPostId`, `reaction.emoji`, `reaction.action` (added|removed). `api_call` runs also get the request's `variables`, merged over these. An array or object interpolated into text renders as JSON.
|
|
17062
|
+
* **Variables** available from the start of every run (absent values are `''`): `lastMessage`, `inboundText`, `triggerText`, `conversationId`, `contact.name`, `contact.phone`, `contact.handle`, `contact.tags` (array), `contact.fields` (the contact's custom fields object), `contact.lastInteractionAt` (ISO date), `contact.lastInteractionHoursAgo` (number), `contact.isFollower` (Instagram, from the stored profile: true, false or `''` when unknown), `referral.ref`, `referral.source`, `referral.type`, `referral.adId`, `postback.payload`, `postback.title`, `quickReply.payload`, `quickReply.title`, `story.id`, `story.url`, `comment.id`, `comment.text`, `comment.platformPostId`, `reaction.emoji`, `reaction.action` (added|removed). `api_call` runs also get the request's `variables`, merged over these. `lead_received` runs also get `lead.id`, `lead.leadgenId`, `lead.formId`, `lead.formName`, `lead.adId`, `lead.adsetId`, `lead.campaignId` and every form answer by its key (`lead.full_name`, `lead.email`, `lead.phone_number`). Template `variableMapping` entries with `field: custom` interpolate `{{...}}` in `customValue`. An array or object interpolated into text renders as JSON.
|
|
17007
17063
|
*
|
|
17008
17064
|
* **send_message**: `{ messageType: text|template|media|interactive|cards, text, template, media:{mediaType:image|video|audio|document, url,caption}, interactive, buttons, quickReplies, messageTag }`. `template` is `{name,language,variableMapping}` for `messageType: template` and `{ type: generic, elements:[{ title, subtitle, imageUrl, buttons }] }` (1 to 10 cards) for `messageType: cards`. `template` and `interactive` are WhatsApp-only. `interactive.type` is inferred from the payload shape when omitted; payloads with neither `type` nor an inferable shape are rejected.
|
|
17009
17065
|
* Facebook and Instagram only (rejected with a 400 on other platforms; WhatsApp keeps `interactive`): `cards`, plus `buttons` on `text` (cards carry their own buttons) and `quickReplies` / `messageTag` on `text`, `media` and `cards`. `media` takes no `buttons` (a 400 at save). `buttons:[{ type: url|postback|phone, title, url, payload, phone, workflowId }]` (1 to 3, text only and the text then 640 characters at most, sent as Meta's button_template, `phone` Facebook-only, not inside cards), `quickReplies:[{ title, payload, imageUrl, workflowId }]` (1 to 13, not combined with `buttons`) and `messageTag: HUMAN_AGENT|CONFIRMED_EVENT_UPDATE|POST_PURCHASE_UPDATE|ACCOUNT_UPDATE` (Instagram accepts only `HUMAN_AGENT`). Titles are capped at 20 characters (80 for card titles and subtitles). A postback button or quick reply with no `payload` gets `zernio:workflow:<this workflow id>`, so a tap answers this workflow's pending `wait_for_reply` or restarts it; with `workflowId` (a 24-hex workflow id, not combined with `payload`) the tap starts that workflow instead.
|
|
@@ -22542,6 +22598,87 @@ export type GetWixConnectUrlError = (unknown | ErrorResponse | {
|
|
|
22542
22598
|
};
|
|
22543
22599
|
});
|
|
22544
22600
|
|
|
22601
|
+
export type GetWebflowConnectUrlData = {
|
|
22602
|
+
query: {
|
|
22603
|
+
/**
|
|
22604
|
+
* Your Zernio profile ID (get from /v1/profiles).
|
|
22605
|
+
*/
|
|
22606
|
+
profileId: string;
|
|
22607
|
+
/**
|
|
22608
|
+
* Custom redirect after connection. Must be an absolute http(s) URL or custom app scheme such as `myapp://callback`; relative and unsafe URLs return 400.
|
|
22609
|
+
*/
|
|
22610
|
+
redirect_url?: string;
|
|
22611
|
+
};
|
|
22612
|
+
};
|
|
22613
|
+
|
|
22614
|
+
export type GetWebflowConnectUrlResponse = ({
|
|
22615
|
+
/**
|
|
22616
|
+
* Webflow consent URL to open in the user agent.
|
|
22617
|
+
*/
|
|
22618
|
+
authUrl: string;
|
|
22619
|
+
/**
|
|
22620
|
+
* Authenticated, expiring state handled by the callback.
|
|
22621
|
+
*/
|
|
22622
|
+
state: string;
|
|
22623
|
+
});
|
|
22624
|
+
|
|
22625
|
+
export type GetWebflowConnectUrlError = (unknown | ErrorResponse | {
|
|
22626
|
+
/**
|
|
22627
|
+
* Human-readable error message suitable for end-user display.
|
|
22628
|
+
*/
|
|
22629
|
+
error: string;
|
|
22630
|
+
/**
|
|
22631
|
+
* Machine-readable error code. Stable across versions.
|
|
22632
|
+
*/
|
|
22633
|
+
code: 'PAYMENT_REQUIRED';
|
|
22634
|
+
/**
|
|
22635
|
+
* Discriminator for which gate fired.
|
|
22636
|
+
*/
|
|
22637
|
+
reason: 'free_tier_exceeded' | 'twitter_passthrough' | 'enterprise_required' | 'card_verification_required';
|
|
22638
|
+
/**
|
|
22639
|
+
* Link to the relevant documentation page.
|
|
22640
|
+
*/
|
|
22641
|
+
documentation_url?: string;
|
|
22642
|
+
/**
|
|
22643
|
+
* Deep-link to send the end-user to. For
|
|
22644
|
+
* `free_tier_exceeded` and `twitter_passthrough` this opens
|
|
22645
|
+
* the add-payment-method drawer on the Zernio billing page.
|
|
22646
|
+
* For `enterprise_required` this is the Zernio enterprise
|
|
22647
|
+
* contact page.
|
|
22648
|
+
*
|
|
22649
|
+
*/
|
|
22650
|
+
dashboard_url?: string;
|
|
22651
|
+
/**
|
|
22652
|
+
* Structured context for SDK clients that want to render their own UX. Keys vary by `reason`.
|
|
22653
|
+
*/
|
|
22654
|
+
details?: {
|
|
22655
|
+
/**
|
|
22656
|
+
* How many accounts the free tier allows. Only set when reason=free_tier_exceeded.
|
|
22657
|
+
*/
|
|
22658
|
+
free_tier_account_limit?: number;
|
|
22659
|
+
/**
|
|
22660
|
+
* How many accounts the team currently has connected. Set when reason=free_tier_exceeded or reason=enterprise_required.
|
|
22661
|
+
*/
|
|
22662
|
+
current_account_count?: number;
|
|
22663
|
+
/**
|
|
22664
|
+
* Whether the team currently has a card on file in Stripe. Set when reason=free_tier_exceeded or reason=twitter_passthrough.
|
|
22665
|
+
*/
|
|
22666
|
+
has_payment_method?: boolean;
|
|
22667
|
+
/**
|
|
22668
|
+
* One-time card verification charge in USD cents, credited to usage. Only set when reason=card_verification_required.
|
|
22669
|
+
*/
|
|
22670
|
+
verification_amount_cents?: number;
|
|
22671
|
+
/**
|
|
22672
|
+
* The negotiated connected-account cap from the
|
|
22673
|
+
* team's enterprise contract. Self-service teams
|
|
22674
|
+
* have no cap and never receive this reason. Only
|
|
22675
|
+
* set when reason=enterprise_required.
|
|
22676
|
+
*
|
|
22677
|
+
*/
|
|
22678
|
+
effective_account_limit?: number;
|
|
22679
|
+
};
|
|
22680
|
+
});
|
|
22681
|
+
|
|
22545
22682
|
export type ConnectWebflowWithSiteTokenData = {
|
|
22546
22683
|
body: {
|
|
22547
22684
|
/**
|
|
@@ -51058,42 +51195,7 @@ export type ListLeadsData = {
|
|
|
51058
51195
|
|
|
51059
51196
|
export type ListLeadsResponse = ({
|
|
51060
51197
|
status?: string;
|
|
51061
|
-
leads?: Array<
|
|
51062
|
-
/**
|
|
51063
|
-
* Zernio lead id.
|
|
51064
|
-
*/
|
|
51065
|
-
id?: string;
|
|
51066
|
-
/**
|
|
51067
|
-
* Meta lead id. On LinkedIn, the leadFormResponse id.
|
|
51068
|
-
*/
|
|
51069
|
-
leadgenId?: string;
|
|
51070
|
-
formId?: string;
|
|
51071
|
-
formName?: (string) | null;
|
|
51072
|
-
accountId?: string;
|
|
51073
|
-
adId?: (string) | null;
|
|
51074
|
-
adsetId?: (string) | null;
|
|
51075
|
-
/**
|
|
51076
|
-
* On LinkedIn, this is the LinkedIn Campaign id, which corresponds to platformAdSetId on GET /v1/ads (LinkedIn's Campaign Group is Zernio's campaign).
|
|
51077
|
-
*/
|
|
51078
|
-
campaignId?: (string) | null;
|
|
51079
|
-
isOrganic?: boolean;
|
|
51080
|
-
/**
|
|
51081
|
-
* ISO 8601.
|
|
51082
|
-
*/
|
|
51083
|
-
createdTime?: (string) | null;
|
|
51084
|
-
/**
|
|
51085
|
-
* Question key → answer. On LinkedIn, the key is the lowercased predefinedField, else the question name, else the numeric questionId; multiple-choice values are option labels (unlike Meta, which returns the option key).
|
|
51086
|
-
*/
|
|
51087
|
-
fields?: {
|
|
51088
|
-
[key: string]: (string);
|
|
51089
|
-
};
|
|
51090
|
-
/**
|
|
51091
|
-
* Raw Meta field_data.
|
|
51092
|
-
*/
|
|
51093
|
-
fieldData?: Array<{
|
|
51094
|
-
[key: string]: unknown;
|
|
51095
|
-
}>;
|
|
51096
|
-
}>;
|
|
51198
|
+
leads?: Array<AdLead>;
|
|
51097
51199
|
pagination?: {
|
|
51098
51200
|
hasMore?: boolean;
|
|
51099
51201
|
cursor?: (string) | null;
|
|
@@ -51109,6 +51211,37 @@ export type ListLeadsResponse = ({
|
|
|
51109
51211
|
|
|
51110
51212
|
export type ListLeadsError = (ErrorResponse | unknown);
|
|
51111
51213
|
|
|
51214
|
+
export type UpdateLeadData = {
|
|
51215
|
+
body: {
|
|
51216
|
+
status: 'new' | 'contacted' | 'unreachable' | 'qualified' | 'converted' | 'disqualified';
|
|
51217
|
+
/**
|
|
51218
|
+
* Deal value; requires currency.
|
|
51219
|
+
*/
|
|
51220
|
+
value?: number;
|
|
51221
|
+
/**
|
|
51222
|
+
* ISO 4217 code.
|
|
51223
|
+
*/
|
|
51224
|
+
currency?: string;
|
|
51225
|
+
/**
|
|
51226
|
+
* Required when `{id}` is a Meta leadgenId: the facebook or metaads account that received the lead.
|
|
51227
|
+
*/
|
|
51228
|
+
accountId?: string;
|
|
51229
|
+
};
|
|
51230
|
+
path: {
|
|
51231
|
+
/**
|
|
51232
|
+
* Zernio lead id, or the Meta leadgenId (then accountId is required).
|
|
51233
|
+
*/
|
|
51234
|
+
id: string;
|
|
51235
|
+
};
|
|
51236
|
+
};
|
|
51237
|
+
|
|
51238
|
+
export type UpdateLeadResponse = ({
|
|
51239
|
+
status?: string;
|
|
51240
|
+
lead?: AdLead;
|
|
51241
|
+
});
|
|
51242
|
+
|
|
51243
|
+
export type UpdateLeadError = (ErrorResponse | unknown);
|
|
51244
|
+
|
|
51112
51245
|
export type ListLeadFormsData = {
|
|
51113
51246
|
query: {
|
|
51114
51247
|
/**
|
|
@@ -51265,6 +51398,19 @@ export type CreateLeadFormData = {
|
|
|
51265
51398
|
*/
|
|
51266
51399
|
coverPhoto?: string;
|
|
51267
51400
|
};
|
|
51401
|
+
/**
|
|
51402
|
+
* Consent section with checkboxes (Meta custom_disclaimer). Each lead's answers come back on the lead, and a lead_received workflow only messages leads that ticked its consentCheckboxKey.
|
|
51403
|
+
*/
|
|
51404
|
+
customDisclaimer?: {
|
|
51405
|
+
title: string;
|
|
51406
|
+
body: string;
|
|
51407
|
+
checkboxes: Array<{
|
|
51408
|
+
key: string;
|
|
51409
|
+
text: string;
|
|
51410
|
+
isRequired?: boolean;
|
|
51411
|
+
isCheckedByDefault?: boolean;
|
|
51412
|
+
}>;
|
|
51413
|
+
};
|
|
51268
51414
|
} | {
|
|
51269
51415
|
/**
|
|
51270
51416
|
* LinkedIn ad account id (resolves the owning organization).
|
|
@@ -51392,7 +51538,18 @@ export type ListFormLeadsData = {
|
|
|
51392
51538
|
export type ListFormLeadsResponse = ({
|
|
51393
51539
|
status?: string;
|
|
51394
51540
|
leads?: Array<{
|
|
51541
|
+
/**
|
|
51542
|
+
* Meta leadgenId.
|
|
51543
|
+
*/
|
|
51395
51544
|
id?: string;
|
|
51545
|
+
/**
|
|
51546
|
+
* Zernio lead id, for PATCH /v1/ads/leads/{id}. Only on persisted leads.
|
|
51547
|
+
*/
|
|
51548
|
+
leadId?: string;
|
|
51549
|
+
/**
|
|
51550
|
+
* Lead status (see PATCH /v1/ads/leads/{id}). Only on persisted leads.
|
|
51551
|
+
*/
|
|
51552
|
+
status?: string;
|
|
51396
51553
|
createdTime?: (string) | null;
|
|
51397
51554
|
adId?: (string) | null;
|
|
51398
51555
|
formId?: string;
|
|
@@ -55559,7 +55716,7 @@ export type RemoveTrackingTagSharedAccountError = (unknown | ErrorResponse);
|
|
|
55559
55716
|
export type InstallTrackingTagOnStoreData = {
|
|
55560
55717
|
body: {
|
|
55561
55718
|
/**
|
|
55562
|
-
* The connected Shopify (`shopify`), WordPress (`wordpress`)
|
|
55719
|
+
* The connected Shopify (`shopify`), WordPress (`wordpress`), Wix (`wix`) or Webflow (`webflow`) account id.
|
|
55563
55720
|
*/
|
|
55564
55721
|
storeAccountId: string;
|
|
55565
55722
|
/**
|
|
@@ -55588,7 +55745,7 @@ export type InstallTrackingTagOnStoreResponse = ({
|
|
|
55588
55745
|
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads' | 'pinterestads' | 'whopads';
|
|
55589
55746
|
install?: (StorePixelInstall & {
|
|
55590
55747
|
/**
|
|
55591
|
-
* Shopify and
|
|
55748
|
+
* Shopify, Wix and Webflow only: the pixel this install replaced on the store, if any.
|
|
55592
55749
|
*/
|
|
55593
55750
|
replacedTagId?: (string) | null;
|
|
55594
55751
|
/**
|
|
@@ -55631,7 +55788,7 @@ export type GetTrackingTagStoreInstallData = {
|
|
|
55631
55788
|
*/
|
|
55632
55789
|
adAccountId?: string;
|
|
55633
55790
|
/**
|
|
55634
|
-
* The connected Shopify, WordPress or
|
|
55791
|
+
* The connected Shopify, WordPress, Wix or Webflow account id.
|
|
55635
55792
|
*/
|
|
55636
55793
|
storeAccountId: string;
|
|
55637
55794
|
};
|
|
@@ -55679,7 +55836,7 @@ export type RemoveTrackingTagFromStoreData = {
|
|
|
55679
55836
|
*/
|
|
55680
55837
|
adAccountId?: string;
|
|
55681
55838
|
/**
|
|
55682
|
-
* The connected Shopify, WordPress or
|
|
55839
|
+
* The connected Shopify, WordPress, Wix or Webflow account id.
|
|
55683
55840
|
*/
|
|
55684
55841
|
storeAccountId: string;
|
|
55685
55842
|
};
|