@zernio/node 0.2.963 → 0.2.965
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 +116 -14
- package/dist/index.d.ts +116 -14
- 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 +52 -3
- package/src/generated/types.gen.ts +119 -13
|
@@ -8740,26 +8740,50 @@ export type SocialAccount = {
|
|
|
8740
8740
|
export type platform10 = 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'sms' | 'phone' | 'rcs';
|
|
8741
8741
|
|
|
8742
8742
|
/**
|
|
8743
|
-
* A tracking tag's install on a connected store
|
|
8743
|
+
* A tracking tag's install on a connected store: a Shopify web pixel, or a Custom HTML widget on a WordPress site. Fields marked Shopify or WordPress are present only for that platform.
|
|
8744
8744
|
*/
|
|
8745
8745
|
export type StorePixelInstall = {
|
|
8746
8746
|
storeAccountId?: string;
|
|
8747
|
-
platform?: 'shopify';
|
|
8748
|
-
shopDomain?: string;
|
|
8747
|
+
platform?: 'shopify' | 'wordpress';
|
|
8749
8748
|
/**
|
|
8750
|
-
*
|
|
8749
|
+
* Shopify: this tag is the pixel the store fires. WordPress: the Zernio widget for this tag is in an active widget area with its script intact.
|
|
8751
8750
|
*/
|
|
8752
8751
|
installed?: boolean;
|
|
8753
8752
|
/**
|
|
8754
|
-
*
|
|
8753
|
+
* Shopify only.
|
|
8754
|
+
*/
|
|
8755
|
+
shopDomain?: string;
|
|
8756
|
+
/**
|
|
8757
|
+
* Shopify only: the Meta pixel the store fires now (may be a different tag), or null.
|
|
8755
8758
|
*/
|
|
8756
8759
|
installedTagId?: (string) | null;
|
|
8757
8760
|
/**
|
|
8758
|
-
* Shopify web pixel id, or null when nothing is installed.
|
|
8761
|
+
* Shopify only: web pixel id, or null when nothing is installed.
|
|
8759
8762
|
*/
|
|
8760
8763
|
webPixelId?: (string) | null;
|
|
8764
|
+
/**
|
|
8765
|
+
* WordPress only.
|
|
8766
|
+
*/
|
|
8767
|
+
siteUrl?: string;
|
|
8768
|
+
/**
|
|
8769
|
+
* WordPress only.
|
|
8770
|
+
*/
|
|
8771
|
+
method?: 'wordpress_widget';
|
|
8772
|
+
/**
|
|
8773
|
+
* WordPress only: widget id, e.g. `custom_html-3`.
|
|
8774
|
+
*/
|
|
8775
|
+
widgetId?: (string) | null;
|
|
8776
|
+
/**
|
|
8777
|
+
* WordPress only: widget area holding the widget.
|
|
8778
|
+
*/
|
|
8779
|
+
sidebarId?: (string) | null;
|
|
8761
8780
|
};
|
|
8762
8781
|
|
|
8782
|
+
/**
|
|
8783
|
+
* WordPress only.
|
|
8784
|
+
*/
|
|
8785
|
+
export type method = 'wordpress_widget';
|
|
8786
|
+
|
|
8763
8787
|
/**
|
|
8764
8788
|
* Normalized, platform-agnostic ad-targeting spec. Every field is optional, an
|
|
8765
8789
|
* empty object targets the platform's default broadest audience. Field names are
|
|
@@ -9315,6 +9339,11 @@ export type platform11 = 'metaads';
|
|
|
9315
9339
|
*/
|
|
9316
9340
|
export type kind2 = 'pixel' | 'tag' | 'insight_tag';
|
|
9317
9341
|
|
|
9342
|
+
/**
|
|
9343
|
+
* Why a pixel cannot be installed on a WordPress site.
|
|
9344
|
+
*/
|
|
9345
|
+
export type TrackingTagInstallBlockedReason = 'insufficient_permissions' | 'scripts_stripped' | 'wordpress_com_plan' | 'no_widget_areas' | 'widgets_api_unavailable';
|
|
9346
|
+
|
|
9318
9347
|
/**
|
|
9319
9348
|
* X-specific post options. The article field creates a long-form X Article and is mutually exclusive with tweet media and tweet-only options. Geo-restriction applies at the media level: media is hidden outside the specified countries while tweet text remains visible.
|
|
9320
9349
|
*
|
|
@@ -28861,6 +28890,28 @@ export type DeleteBrandedCallingEnterpriseError = (ErrorResponse | {
|
|
|
28861
28890
|
error?: string;
|
|
28862
28891
|
} | unknown);
|
|
28863
28892
|
|
|
28893
|
+
export type ShareBrandedCallingIdentityFormData = {
|
|
28894
|
+
body?: {
|
|
28895
|
+
/**
|
|
28896
|
+
* A registered business the identity belongs to.
|
|
28897
|
+
*/
|
|
28898
|
+
enterpriseId?: string;
|
|
28899
|
+
/**
|
|
28900
|
+
* An identity in review to complete. Not with enterpriseId.
|
|
28901
|
+
*/
|
|
28902
|
+
identityId?: string;
|
|
28903
|
+
};
|
|
28904
|
+
};
|
|
28905
|
+
|
|
28906
|
+
export type ShareBrandedCallingIdentityFormResponse = ({
|
|
28907
|
+
url?: string;
|
|
28908
|
+
expiresAt?: string;
|
|
28909
|
+
});
|
|
28910
|
+
|
|
28911
|
+
export type ShareBrandedCallingIdentityFormError = (ErrorResponse | {
|
|
28912
|
+
error?: string;
|
|
28913
|
+
} | unknown);
|
|
28914
|
+
|
|
28864
28915
|
export type ListBrandedCallingCallReasonsResponse = ({
|
|
28865
28916
|
callReasons?: Array<(string)>;
|
|
28866
28917
|
});
|
|
@@ -48587,9 +48638,17 @@ export type RemoveTrackingTagSharedAccountError = (unknown | {
|
|
|
48587
48638
|
export type InstallTrackingTagOnStoreData = {
|
|
48588
48639
|
body: {
|
|
48589
48640
|
/**
|
|
48590
|
-
* The connected Shopify
|
|
48641
|
+
* The connected Shopify (`shopify`) or WordPress (`wordpress`) account id.
|
|
48591
48642
|
*/
|
|
48592
48643
|
storeAccountId: string;
|
|
48644
|
+
/**
|
|
48645
|
+
* WordPress only: widget area to use (see `install.preflight.sidebars` from GET). Defaults to a footer area.
|
|
48646
|
+
*/
|
|
48647
|
+
sidebarId?: string;
|
|
48648
|
+
/**
|
|
48649
|
+
* WordPress only: fetch the homepage afterwards and report `homepageCheck`.
|
|
48650
|
+
*/
|
|
48651
|
+
verifyHomepage?: boolean;
|
|
48593
48652
|
};
|
|
48594
48653
|
path: {
|
|
48595
48654
|
accountId: string;
|
|
@@ -48604,15 +48663,36 @@ export type InstallTrackingTagOnStoreResponse = ({
|
|
|
48604
48663
|
platform?: 'metaads';
|
|
48605
48664
|
install?: (StorePixelInstall & {
|
|
48606
48665
|
/**
|
|
48607
|
-
*
|
|
48666
|
+
* Shopify only: the pixel this install replaced on the store, if any.
|
|
48608
48667
|
*/
|
|
48609
48668
|
replacedTagId?: (string) | null;
|
|
48669
|
+
/**
|
|
48670
|
+
* WordPress only: name of the widget area used.
|
|
48671
|
+
*/
|
|
48672
|
+
sidebarName?: string;
|
|
48673
|
+
/**
|
|
48674
|
+
* WordPress only: false when an existing Zernio widget was updated.
|
|
48675
|
+
*/
|
|
48676
|
+
created?: boolean;
|
|
48677
|
+
/**
|
|
48678
|
+
* WordPress only: whether the pixel appeared in the homepage HTML. `not_found` can be a stale page cache.
|
|
48679
|
+
*/
|
|
48680
|
+
homepageCheck?: 'found' | 'not_found' | 'unreachable' | 'skipped';
|
|
48610
48681
|
});
|
|
48611
48682
|
});
|
|
48612
48683
|
|
|
48613
48684
|
export type InstallTrackingTagOnStoreError = (ErrorResponse | {
|
|
48614
48685
|
error?: string;
|
|
48615
|
-
} | unknown
|
|
48686
|
+
} | unknown | {
|
|
48687
|
+
/**
|
|
48688
|
+
* What blocked the install and the manual alternative.
|
|
48689
|
+
*/
|
|
48690
|
+
error?: string;
|
|
48691
|
+
code?: 'tracking_tag_install_blocked';
|
|
48692
|
+
details?: {
|
|
48693
|
+
reason?: TrackingTagInstallBlockedReason;
|
|
48694
|
+
};
|
|
48695
|
+
});
|
|
48616
48696
|
|
|
48617
48697
|
export type GetTrackingTagStoreInstallData = {
|
|
48618
48698
|
path: {
|
|
@@ -48624,7 +48704,7 @@ export type GetTrackingTagStoreInstallData = {
|
|
|
48624
48704
|
};
|
|
48625
48705
|
query: {
|
|
48626
48706
|
/**
|
|
48627
|
-
* The connected Shopify account id.
|
|
48707
|
+
* The connected Shopify or WordPress account id.
|
|
48628
48708
|
*/
|
|
48629
48709
|
storeAccountId: string;
|
|
48630
48710
|
};
|
|
@@ -48632,7 +48712,28 @@ export type GetTrackingTagStoreInstallData = {
|
|
|
48632
48712
|
|
|
48633
48713
|
export type GetTrackingTagStoreInstallResponse = ({
|
|
48634
48714
|
platform?: 'metaads';
|
|
48635
|
-
install?: StorePixelInstall
|
|
48715
|
+
install?: (StorePixelInstall & {
|
|
48716
|
+
/**
|
|
48717
|
+
* WordPress only.
|
|
48718
|
+
*/
|
|
48719
|
+
preflight?: {
|
|
48720
|
+
/**
|
|
48721
|
+
* True when POST should be able to install.
|
|
48722
|
+
*/
|
|
48723
|
+
ready?: boolean;
|
|
48724
|
+
/**
|
|
48725
|
+
* A TrackingTagInstallBlockedReason when an install would be blocked, else null.
|
|
48726
|
+
*/
|
|
48727
|
+
reason?: (string) | null;
|
|
48728
|
+
/**
|
|
48729
|
+
* Active widget areas of the theme.
|
|
48730
|
+
*/
|
|
48731
|
+
sidebars?: Array<{
|
|
48732
|
+
id?: string;
|
|
48733
|
+
name?: string;
|
|
48734
|
+
}>;
|
|
48735
|
+
};
|
|
48736
|
+
});
|
|
48636
48737
|
});
|
|
48637
48738
|
|
|
48638
48739
|
export type GetTrackingTagStoreInstallError = (ErrorResponse | {
|
|
@@ -48649,7 +48750,7 @@ export type RemoveTrackingTagFromStoreData = {
|
|
|
48649
48750
|
};
|
|
48650
48751
|
query: {
|
|
48651
48752
|
/**
|
|
48652
|
-
* The connected Shopify account id.
|
|
48753
|
+
* The connected Shopify or WordPress account id.
|
|
48653
48754
|
*/
|
|
48654
48755
|
storeAccountId: string;
|
|
48655
48756
|
};
|
|
@@ -48657,7 +48758,12 @@ export type RemoveTrackingTagFromStoreData = {
|
|
|
48657
48758
|
|
|
48658
48759
|
export type RemoveTrackingTagFromStoreResponse = ({
|
|
48659
48760
|
platform?: 'metaads';
|
|
48660
|
-
install?: StorePixelInstall
|
|
48761
|
+
install?: (StorePixelInstall & {
|
|
48762
|
+
/**
|
|
48763
|
+
* WordPress only: number of Zernio widgets deleted.
|
|
48764
|
+
*/
|
|
48765
|
+
removed?: number;
|
|
48766
|
+
});
|
|
48661
48767
|
});
|
|
48662
48768
|
|
|
48663
48769
|
export type RemoveTrackingTagFromStoreError = (ErrorResponse | {
|