@zernio/node 0.2.964 → 0.2.965

package/dist/index.js

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.964",
+  version: "0.2.965",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/dist/index.mjs

@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.964",
+  version: "0.2.965",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zernio/node",
-  "version": "0.2.964",
+  "version": "0.2.965",
   "description": "The official Node.js library for the Zernio API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/generated/sdk.gen.ts

@@ -13425,7 +13425,7 @@ export const removeTrackingTagSharedAccount = <ThrowOnError extends boolean = fa
 };
 
 /**
- * Install on a Shopify store
+ * Install on a Shopify store or WordPress site
  * Puts the Meta pixel on a connected Shopify store's storefront and checkout through
  * Zernio's Shopify web pixel (a Shopify app pixel, no theme edits). The store then sends
  * PageView, ViewContent, AddToCart, Search, InitiateCheckout, AddPaymentInfo and Purchase
@@ -13443,6 +13443,25 @@ export const removeTrackingTagSharedAccount = <ThrowOnError extends boolean = fa
  * merchant to (the Shopify account id stays the same). Meta only (platform `metaads`);
  * other platforms return 405.
  *
+ * **WordPress** (`storeAccountId` is a connected WordPress.com or self-hosted site): Zernio
+ * adds a Custom HTML widget with the Meta pixel base code (fbevents.js, `init`, `PageView`)
+ * to a widget area of the active theme (a footer area when there is one, else the first
+ * active area; pass `sidebarId` to choose), then reads the widget back to confirm WordPress
+ * kept the `<script>` tag. The widget carries a Zernio marker, so the call is idempotent
+ * per pixel: repeating it updates or moves the same widget, and pixel code the site owner
+ * pasted by hand is never touched. Several pixels can run side by side (one widget each).
+ * When the site cannot run the pixel, nothing is left behind and the call answers 422
+ * `tracking_tag_install_blocked` with `details.reason`:
+ * - `insufficient_permissions`: the connected user lacks `edit_theme_options` (needs Administrator).
+ * - `scripts_stripped`: WordPress removed the script (the user lacks `unfiltered_html`, e.g. a multisite admin who is not a Super Admin, or `DISALLOW_UNFILTERED_HTML` is set).
+ * - `wordpress_com_plan`: a WordPress.com plan that strips scripts (plans without plugins).
+ * - `no_widget_areas`: the theme has no widget areas (block themes such as Twenty Twenty-Five).
+ * - `widgets_api_unavailable`: no widgets REST API (WordPress older than 5.8, or disabled).
+ * The `error` message names the manual alternative (Meta's official WordPress plugin).
+ * With `verifyHomepage` (default true) the homepage is fetched afterwards and
+ * `homepageCheck` says whether the pixel is visible; `not_found` can be a stale page cache,
+ * the widget read-back is authoritative.
+ *
  */
 export const installTrackingTagOnStore = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<InstallTrackingTagOnStoreData, ThrowOnError>) => {
     return (options?.client ?? client).post<InstallTrackingTagOnStoreResponse, InstallTrackingTagOnStoreError, ThrowOnError>({
@@ -13456,6 +13475,12 @@ export const installTrackingTagOnStore = <ThrowOnError extends boolean = false>(
  * Whether this pixel is the one the Shopify store fires. `installedTagId` names the pixel
  * the store currently fires, which can be a different tag. Meta only (platform `metaads`).
  *
+ * WordPress: whether the Zernio widget for this pixel is live (in an active widget area,
+ * script intact), plus a read-only `preflight` with the theme's widget areas and, when an
+ * install would be blocked, the `reason` POST would return. The preflight reads
+ * capabilities only, so `ready: true` is not a guarantee: `DISALLOW_UNFILTERED_HTML` or a
+ * multisite admin who is not a Super Admin still strips the script, which POST detects.
+ *
  */
 export const getTrackingTagStoreInstall = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTrackingTagStoreInstallData, ThrowOnError>) => {
     return (options?.client ?? client).get<GetTrackingTagStoreInstallResponse, GetTrackingTagStoreInstallError, ThrowOnError>({
@@ -13465,11 +13490,14 @@ export const getTrackingTagStoreInstall = <ThrowOnError extends boolean = false>
 };
 
 /**
- * Remove from a Shopify store
+ * Remove from a Shopify store or WordPress site
  * Removes the pixel from the store. Idempotent: nothing installed returns 200 with
  * `installed: false`. If the store fires a different pixel, nothing is removed and the
  * call answers 409 `invalid_resource_state`. Meta only (platform `metaads`).
  *
+ * WordPress: deletes every widget Zernio created for this pixel and reports how many in
+ * `removed` (0 when nothing was installed). Pixel code added by hand is left alone.
+ *
  */
 export const removeTrackingTagFromStore = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<RemoveTrackingTagFromStoreData, ThrowOnError>) => {
     return (options?.client ?? client).delete<RemoveTrackingTagFromStoreResponse, RemoveTrackingTagFromStoreError, ThrowOnError>({

package/src/generated/types.gen.ts

@@ -8740,26 +8740,50 @@ export type SocialAccount = {
 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';
 
 /**
- * A tracking tag's install on a connected store (Shopify web pixel).
+ * 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.
  */
 export type StorePixelInstall = {
     storeAccountId?: string;
-    platform?: 'shopify';
-    shopDomain?: string;
+    platform?: 'shopify' | 'wordpress';
     /**
-     * True when this tag is the pixel the store fires.
+     * 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.
      */
     installed?: boolean;
     /**
-     * The Meta pixel the store fires now (may be a different tag), or null.
+     * Shopify only.
+     */
+    shopDomain?: string;
+    /**
+     * Shopify only: the Meta pixel the store fires now (may be a different tag), or null.
      */
     installedTagId?: (string) | null;
     /**
-     * Shopify web pixel id, or null when nothing is installed.
+     * Shopify only: web pixel id, or null when nothing is installed.
      */
     webPixelId?: (string) | null;
+    /**
+     * WordPress only.
+     */
+    siteUrl?: string;
+    /**
+     * WordPress only.
+     */
+    method?: 'wordpress_widget';
+    /**
+     * WordPress only: widget id, e.g. `custom_html-3`.
+     */
+    widgetId?: (string) | null;
+    /**
+     * WordPress only: widget area holding the widget.
+     */
+    sidebarId?: (string) | null;
 };
 
+/**
+ * WordPress only.
+ */
+export type method = 'wordpress_widget';
+
 /**
  * Normalized, platform-agnostic ad-targeting spec. Every field is optional, an
  * empty object targets the platform's default broadest audience. Field names are
@@ -9315,6 +9339,11 @@ export type platform11 = 'metaads';
  */
 export type kind2 = 'pixel' | 'tag' | 'insight_tag';
 
+/**
+ * Why a pixel cannot be installed on a WordPress site.
+ */
+export type TrackingTagInstallBlockedReason = 'insufficient_permissions' | 'scripts_stripped' | 'wordpress_com_plan' | 'no_widget_areas' | 'widgets_api_unavailable';
+
 /**
  * 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.
  *
@@ -48609,9 +48638,17 @@ export type RemoveTrackingTagSharedAccountError = (unknown | {
 export type InstallTrackingTagOnStoreData = {
     body: {
         /**
-         * The connected Shopify account id (platform `shopify`).
+         * The connected Shopify (`shopify`) or WordPress (`wordpress`) account id.
          */
         storeAccountId: string;
+        /**
+         * WordPress only: widget area to use (see `install.preflight.sidebars` from GET). Defaults to a footer area.
+         */
+        sidebarId?: string;
+        /**
+         * WordPress only: fetch the homepage afterwards and report `homepageCheck`.
+         */
+        verifyHomepage?: boolean;
     };
     path: {
         accountId: string;
@@ -48626,15 +48663,36 @@ export type InstallTrackingTagOnStoreResponse = ({
     platform?: 'metaads';
     install?: (StorePixelInstall & {
     /**
-     * The pixel this install replaced on the store, if any.
+     * Shopify only: the pixel this install replaced on the store, if any.
      */
     replacedTagId?: (string) | null;
+    /**
+     * WordPress only: name of the widget area used.
+     */
+    sidebarName?: string;
+    /**
+     * WordPress only: false when an existing Zernio widget was updated.
+     */
+    created?: boolean;
+    /**
+     * WordPress only: whether the pixel appeared in the homepage HTML. `not_found` can be a stale page cache.
+     */
+    homepageCheck?: 'found' | 'not_found' | 'unreachable' | 'skipped';
 });
 });
 
 export type InstallTrackingTagOnStoreError = (ErrorResponse | {
     error?: string;
-} | unknown);
+} | unknown | {
+    /**
+     * What blocked the install and the manual alternative.
+     */
+    error?: string;
+    code?: 'tracking_tag_install_blocked';
+    details?: {
+        reason?: TrackingTagInstallBlockedReason;
+    };
+});
 
 export type GetTrackingTagStoreInstallData = {
     path: {
@@ -48646,7 +48704,7 @@ export type GetTrackingTagStoreInstallData = {
     };
     query: {
         /**
-         * The connected Shopify account id.
+         * The connected Shopify or WordPress account id.
          */
         storeAccountId: string;
     };
@@ -48654,7 +48712,28 @@ export type GetTrackingTagStoreInstallData = {
 
 export type GetTrackingTagStoreInstallResponse = ({
     platform?: 'metaads';
-    install?: StorePixelInstall;
+    install?: (StorePixelInstall & {
+    /**
+     * WordPress only.
+     */
+    preflight?: {
+        /**
+         * True when POST should be able to install.
+         */
+        ready?: boolean;
+        /**
+         * A TrackingTagInstallBlockedReason when an install would be blocked, else null.
+         */
+        reason?: (string) | null;
+        /**
+         * Active widget areas of the theme.
+         */
+        sidebars?: Array<{
+            id?: string;
+            name?: string;
+        }>;
+    };
+});
 });
 
 export type GetTrackingTagStoreInstallError = (ErrorResponse | {
@@ -48671,7 +48750,7 @@ export type RemoveTrackingTagFromStoreData = {
     };
     query: {
         /**
-         * The connected Shopify account id.
+         * The connected Shopify or WordPress account id.
          */
         storeAccountId: string;
     };
@@ -48679,7 +48758,12 @@ export type RemoveTrackingTagFromStoreData = {
 
 export type RemoveTrackingTagFromStoreResponse = ({
     platform?: 'metaads';
-    install?: StorePixelInstall;
+    install?: (StorePixelInstall & {
+    /**
+     * WordPress only: number of Zernio widgets deleted.
+     */
+    removed?: number;
+});
 });
 
 export type RemoveTrackingTagFromStoreError = (ErrorResponse | {