@getlatedev/node 0.2.1265 → 0.2.1267
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 +3 -2
- package/dist/index.d.mts +108 -21
- package/dist/index.d.ts +108 -21
- package/dist/index.js +8 -1
- package/dist/index.mjs +8 -1
- package/package.json +1 -1
- package/src/client.ts +2 -0
- package/src/generated/sdk.gen.ts +36 -7
- package/src/generated/types.gen.ts +109 -21
|
@@ -2188,7 +2188,15 @@ export type ApiChangelogEntry = {
|
|
|
2188
2188
|
*/
|
|
2189
2189
|
platforms: Array<(string)>;
|
|
2190
2190
|
/**
|
|
2191
|
-
* The
|
|
2191
|
+
* The change in a few words, for example `Delete inbox conversations`. Null on older entries.
|
|
2192
|
+
*/
|
|
2193
|
+
title: (string) | null;
|
|
2194
|
+
/**
|
|
2195
|
+
* One or two plain sentences on what changed and why it matters. Null when `title` is.
|
|
2196
|
+
*/
|
|
2197
|
+
summary: (string) | null;
|
|
2198
|
+
/**
|
|
2199
|
+
* The details in Markdown: endpoints, fields and how to use them.
|
|
2192
2200
|
*/
|
|
2193
2201
|
message: string;
|
|
2194
2202
|
publishedAt: string;
|
|
@@ -11510,14 +11518,14 @@ export type platform13 = 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'link
|
|
|
11510
11518
|
export type tiktokAccountType = 'business' | 'personal' | 'unknown';
|
|
11511
11519
|
|
|
11512
11520
|
/**
|
|
11513
|
-
* A tracking tag's install on a connected store: a Shopify web pixel, a Custom HTML widget on a WordPress site,
|
|
11521
|
+
* 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.
|
|
11514
11522
|
*/
|
|
11515
11523
|
export type StorePixelInstall = {
|
|
11516
11524
|
storeAccountId?: string;
|
|
11517
11525
|
/**
|
|
11518
11526
|
* The store platform.
|
|
11519
11527
|
*/
|
|
11520
|
-
platform?: 'shopify' | 'wordpress' | 'wix';
|
|
11528
|
+
platform?: 'shopify' | 'wordpress' | 'wix' | 'webflow';
|
|
11521
11529
|
/**
|
|
11522
11530
|
* Platform of the tag this install is about (e.g. `metaads`).
|
|
11523
11531
|
*/
|
|
@@ -11527,7 +11535,7 @@ export type StorePixelInstall = {
|
|
|
11527
11535
|
*/
|
|
11528
11536
|
siteTagId?: string;
|
|
11529
11537
|
/**
|
|
11530
|
-
* Shopify and
|
|
11538
|
+
* 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.
|
|
11531
11539
|
*/
|
|
11532
11540
|
installed?: boolean;
|
|
11533
11541
|
/**
|
|
@@ -11535,11 +11543,11 @@ export type StorePixelInstall = {
|
|
|
11535
11543
|
*/
|
|
11536
11544
|
shopDomain?: string;
|
|
11537
11545
|
/**
|
|
11538
|
-
* Shopify and
|
|
11546
|
+
* Shopify, Wix and Webflow only: the tag of the same platform the store fires now (may be a different tag), or null.
|
|
11539
11547
|
*/
|
|
11540
11548
|
installedTagId?: (string) | null;
|
|
11541
11549
|
/**
|
|
11542
|
-
* GET only on WordPress, always on Shopify and
|
|
11550
|
+
* GET only on WordPress, always on Shopify, Wix and Webflow: every Zernio tag on the store, all platforms.
|
|
11543
11551
|
*/
|
|
11544
11552
|
tags?: Array<{
|
|
11545
11553
|
platform?: string;
|
|
@@ -11562,9 +11570,13 @@ export type StorePixelInstall = {
|
|
|
11562
11570
|
*/
|
|
11563
11571
|
webPixelId?: (string) | null;
|
|
11564
11572
|
/**
|
|
11565
|
-
* WordPress and
|
|
11573
|
+
* WordPress, Wix and Webflow only. Null on a Wix site that was never published.
|
|
11566
11574
|
*/
|
|
11567
11575
|
siteUrl?: (string) | null;
|
|
11576
|
+
/**
|
|
11577
|
+
* Webflow only, always true: the change reaches the live site on its next publish.
|
|
11578
|
+
*/
|
|
11579
|
+
publishRequired?: boolean;
|
|
11568
11580
|
/**
|
|
11569
11581
|
* WordPress only.
|
|
11570
11582
|
*/
|
|
@@ -11579,11 +11591,6 @@ export type StorePixelInstall = {
|
|
|
11579
11591
|
sidebarId?: (string) | null;
|
|
11580
11592
|
};
|
|
11581
11593
|
|
|
11582
|
-
/**
|
|
11583
|
-
* The store platform.
|
|
11584
|
-
*/
|
|
11585
|
-
export type platform14 = 'shopify' | 'wordpress' | 'wix';
|
|
11586
|
-
|
|
11587
11594
|
/**
|
|
11588
11595
|
* WordPress only.
|
|
11589
11596
|
*/
|
|
@@ -12295,7 +12302,7 @@ export type TrackingTag = {
|
|
|
12295
12302
|
autoTagging?: boolean;
|
|
12296
12303
|
};
|
|
12297
12304
|
|
|
12298
|
-
export type
|
|
12305
|
+
export type platform14 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads' | 'pinterestads' | 'whopads';
|
|
12299
12306
|
|
|
12300
12307
|
/**
|
|
12301
12308
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
@@ -14211,7 +14218,7 @@ export type WebhookPayloadComment = {
|
|
|
14211
14218
|
|
|
14212
14219
|
export type event14 = 'comment.received';
|
|
14213
14220
|
|
|
14214
|
-
export type
|
|
14221
|
+
export type platform15 = 'instagram' | 'facebook' | 'threads' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit' | 'tiktok';
|
|
14215
14222
|
|
|
14216
14223
|
export type WebhookPayloadCommerceOrder = {
|
|
14217
14224
|
/**
|
|
@@ -14573,7 +14580,7 @@ export type WebhookPayloadLead = {
|
|
|
14573
14580
|
|
|
14574
14581
|
export type event22 = 'lead.received';
|
|
14575
14582
|
|
|
14576
|
-
export type
|
|
14583
|
+
export type platform16 = 'facebook';
|
|
14577
14584
|
|
|
14578
14585
|
/**
|
|
14579
14586
|
* Webhook payload for message received events
|
|
@@ -15590,7 +15597,7 @@ export type event27 = 'message.sent';
|
|
|
15590
15597
|
/**
|
|
15591
15598
|
* Every platform whose outgoing messages Zernio observes. sms is absent on purpose: its carrier receipts update delivery status and never raise message.sent.
|
|
15592
15599
|
*/
|
|
15593
|
-
export type
|
|
15600
|
+
export type platform17 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'slack' | 'tiktok' | 'imessage';
|
|
15594
15601
|
|
|
15595
15602
|
/**
|
|
15596
15603
|
* 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.
|
|
@@ -16165,7 +16172,7 @@ export type WebhookPayloadWhatsAppAccountAlertReceived = {
|
|
|
16165
16172
|
|
|
16166
16173
|
export type event38 = 'whatsapp.account.alert_received';
|
|
16167
16174
|
|
|
16168
|
-
export type
|
|
16175
|
+
export type platform18 = 'whatsapp';
|
|
16169
16176
|
|
|
16170
16177
|
/**
|
|
16171
16178
|
* Webhook payload for the `whatsapp.account.name_status_updated` event.
|
|
@@ -22599,6 +22606,87 @@ export type GetWixConnectUrlError = (unknown | ErrorResponse | {
|
|
|
22599
22606
|
};
|
|
22600
22607
|
});
|
|
22601
22608
|
|
|
22609
|
+
export type GetWebflowConnectUrlData = {
|
|
22610
|
+
query: {
|
|
22611
|
+
/**
|
|
22612
|
+
* Your Zernio profile ID (get from /v1/profiles).
|
|
22613
|
+
*/
|
|
22614
|
+
profileId: string;
|
|
22615
|
+
/**
|
|
22616
|
+
* 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.
|
|
22617
|
+
*/
|
|
22618
|
+
redirect_url?: string;
|
|
22619
|
+
};
|
|
22620
|
+
};
|
|
22621
|
+
|
|
22622
|
+
export type GetWebflowConnectUrlResponse = ({
|
|
22623
|
+
/**
|
|
22624
|
+
* Webflow consent URL to open in the user agent.
|
|
22625
|
+
*/
|
|
22626
|
+
authUrl: string;
|
|
22627
|
+
/**
|
|
22628
|
+
* Authenticated, expiring state handled by the callback.
|
|
22629
|
+
*/
|
|
22630
|
+
state: string;
|
|
22631
|
+
});
|
|
22632
|
+
|
|
22633
|
+
export type GetWebflowConnectUrlError = (unknown | ErrorResponse | {
|
|
22634
|
+
/**
|
|
22635
|
+
* Human-readable error message suitable for end-user display.
|
|
22636
|
+
*/
|
|
22637
|
+
error: string;
|
|
22638
|
+
/**
|
|
22639
|
+
* Machine-readable error code. Stable across versions.
|
|
22640
|
+
*/
|
|
22641
|
+
code: 'PAYMENT_REQUIRED';
|
|
22642
|
+
/**
|
|
22643
|
+
* Discriminator for which gate fired.
|
|
22644
|
+
*/
|
|
22645
|
+
reason: 'free_tier_exceeded' | 'twitter_passthrough' | 'enterprise_required' | 'card_verification_required';
|
|
22646
|
+
/**
|
|
22647
|
+
* Link to the relevant documentation page.
|
|
22648
|
+
*/
|
|
22649
|
+
documentation_url?: string;
|
|
22650
|
+
/**
|
|
22651
|
+
* Deep-link to send the end-user to. For
|
|
22652
|
+
* `free_tier_exceeded` and `twitter_passthrough` this opens
|
|
22653
|
+
* the add-payment-method drawer on the Zernio billing page.
|
|
22654
|
+
* For `enterprise_required` this is the Zernio enterprise
|
|
22655
|
+
* contact page.
|
|
22656
|
+
*
|
|
22657
|
+
*/
|
|
22658
|
+
dashboard_url?: string;
|
|
22659
|
+
/**
|
|
22660
|
+
* Structured context for SDK clients that want to render their own UX. Keys vary by `reason`.
|
|
22661
|
+
*/
|
|
22662
|
+
details?: {
|
|
22663
|
+
/**
|
|
22664
|
+
* How many accounts the free tier allows. Only set when reason=free_tier_exceeded.
|
|
22665
|
+
*/
|
|
22666
|
+
free_tier_account_limit?: number;
|
|
22667
|
+
/**
|
|
22668
|
+
* How many accounts the team currently has connected. Set when reason=free_tier_exceeded or reason=enterprise_required.
|
|
22669
|
+
*/
|
|
22670
|
+
current_account_count?: number;
|
|
22671
|
+
/**
|
|
22672
|
+
* Whether the team currently has a card on file in Stripe. Set when reason=free_tier_exceeded or reason=twitter_passthrough.
|
|
22673
|
+
*/
|
|
22674
|
+
has_payment_method?: boolean;
|
|
22675
|
+
/**
|
|
22676
|
+
* One-time card verification charge in USD cents, credited to usage. Only set when reason=card_verification_required.
|
|
22677
|
+
*/
|
|
22678
|
+
verification_amount_cents?: number;
|
|
22679
|
+
/**
|
|
22680
|
+
* The negotiated connected-account cap from the
|
|
22681
|
+
* team's enterprise contract. Self-service teams
|
|
22682
|
+
* have no cap and never receive this reason. Only
|
|
22683
|
+
* set when reason=enterprise_required.
|
|
22684
|
+
*
|
|
22685
|
+
*/
|
|
22686
|
+
effective_account_limit?: number;
|
|
22687
|
+
};
|
|
22688
|
+
});
|
|
22689
|
+
|
|
22602
22690
|
export type ConnectWebflowWithSiteTokenData = {
|
|
22603
22691
|
body: {
|
|
22604
22692
|
/**
|
|
@@ -55636,7 +55724,7 @@ export type RemoveTrackingTagSharedAccountError = (unknown | ErrorResponse);
|
|
|
55636
55724
|
export type InstallTrackingTagOnStoreData = {
|
|
55637
55725
|
body: {
|
|
55638
55726
|
/**
|
|
55639
|
-
* The connected Shopify (`shopify`), WordPress (`wordpress`)
|
|
55727
|
+
* The connected Shopify (`shopify`), WordPress (`wordpress`), Wix (`wix`) or Webflow (`webflow`) account id.
|
|
55640
55728
|
*/
|
|
55641
55729
|
storeAccountId: string;
|
|
55642
55730
|
/**
|
|
@@ -55665,7 +55753,7 @@ export type InstallTrackingTagOnStoreResponse = ({
|
|
|
55665
55753
|
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads' | 'pinterestads' | 'whopads';
|
|
55666
55754
|
install?: (StorePixelInstall & {
|
|
55667
55755
|
/**
|
|
55668
|
-
* Shopify and
|
|
55756
|
+
* Shopify, Wix and Webflow only: the pixel this install replaced on the store, if any.
|
|
55669
55757
|
*/
|
|
55670
55758
|
replacedTagId?: (string) | null;
|
|
55671
55759
|
/**
|
|
@@ -55708,7 +55796,7 @@ export type GetTrackingTagStoreInstallData = {
|
|
|
55708
55796
|
*/
|
|
55709
55797
|
adAccountId?: string;
|
|
55710
55798
|
/**
|
|
55711
|
-
* The connected Shopify, WordPress or
|
|
55799
|
+
* The connected Shopify, WordPress, Wix or Webflow account id.
|
|
55712
55800
|
*/
|
|
55713
55801
|
storeAccountId: string;
|
|
55714
55802
|
};
|
|
@@ -55756,7 +55844,7 @@ export type RemoveTrackingTagFromStoreData = {
|
|
|
55756
55844
|
*/
|
|
55757
55845
|
adAccountId?: string;
|
|
55758
55846
|
/**
|
|
55759
|
-
* The connected Shopify, WordPress or
|
|
55847
|
+
* The connected Shopify, WordPress, Wix or Webflow account id.
|
|
55760
55848
|
*/
|
|
55761
55849
|
storeAccountId: string;
|
|
55762
55850
|
};
|