@zinn-digital/sdk 0.1.1419 → 0.1.1420

package/dist/generated/schema.d.ts

@@ -20401,6 +20401,82 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/ads/site-tags": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Install on any site — the organisation's site tags with their install code.
+         * @description Gated on `ads.view` (docs/1006 §84, za-128). One row per non-WordPress site: the network tag ids (Google Ads `AW-…`, GA4 `G-…`, Microsoft UET, Meta pixel), the Google Ads conversion label per outcome kind and the consent default. `install` holds the universal snippet, the Shopify custom-pixel code and the GTM container path, all generated from the same row. `suggested_hosts` are sites already named as an ad account's tracking site that have no tag yet.
+         */
+        get: operations["listAdsSiteTags"];
+        put?: never;
+        /**
+         * Add a site and mint its public tag key.
+         * @description Gated on `ads.manage`; audit-logged (`ads.site_tag_created`). `site_host` may be pasted as a URL (it is reduced to the host). The `public_key` is in the customer's page source and is NOT a secret: it only selects public tag ids. A second tag for the same host in the organisation is a `409` (`refusal.adsconnect.siteTag.duplicateHost`); a value in the wrong format is a `422` (`refusal.adsconnect.siteTag.*`).
+         */
+        post: operations["createAdsSiteTag"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/ads/site-tags/{tag_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tag_id: string;
+            };
+            cookie?: never;
+        };
+        /**
+         * One site tag with its install code.
+         * @description Gated on `ads.view` (docs/1006 §84). Another organisation's tag is a `404`.
+         */
+        get: operations["getAdsSiteTag"];
+        /**
+         * Change a site tag (every install route follows within five minutes).
+         * @description Gated on `ads.manage`; audit-logged (`ads.site_tag_updated`). Only the fields sent change. `version` goes up by one and the cached script is dropped, so the snippet and the Shopify pixel serve the new settings within the edge lifetime (300 s). A GTM container already imported does not change: download and import it again.
+         */
+        put: operations["updateAdsSiteTag"];
+        post?: never;
+        /**
+         * Remove a site tag; its script answers 404 from then on.
+         * @description Gated on `ads.manage`; audit-logged (`ads.site_tag_deleted`).
+         */
+        delete: operations["deleteAdsSiteTag"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/ads/site-tags/{tag_id}/gtm-container": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tag_id: string;
+            };
+            cookie?: never;
+        };
+        /**
+         * The Google Tag Manager container to import, built from the same site tag.
+         * @description Gated on `ads.view` (docs/1006 §84). A GTM export (format 2) the customer imports in Admin → Import container (choose Merge): consent defaults on Consent Initialization, the Conversion Linker and Google tag, one Google Ads conversion tag per label (fired by the data-layer event `zinn_<kind>`), Microsoft UET and the Meta pixel (the Meta tags require `ad_storage` consent). The site pushes `{event: "zinn_purchase", zinn: {value_minor, currency, transaction_id}}`.
+         */
+        get: operations["getAdsSiteTagGtmContainer"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/ads/social": {
         parameters: {
             query?: never;
@@ -20505,6 +20581,52 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/ads/wordpress/sites": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The organisation's WordPress sites connected with the Zinn® Ads plugin.
+         * @description Gated on `ads.view` (docs/1006 §102). Connected sites and pairing codes that have not expired yet. Each site says whether Cloudflare fronts it (`cloudflare_detected`, measured by the plugin), its tag mode (`browser` or `zaraz`), whether to offer Zaraz mode, and in Zaraz mode the purchases sent through Zaraz against what the ad networks credited over the latest tracking-check window (`zaraz_health`). Cursor-paged newest first: follow `page.next_cursor` while `page.has_more` is true (there is no cap on the total).
+         */
+        get: operations["listAdsWordPressSites"];
+        put?: never;
+        /**
+         * Make a one-time code that connects a WordPress site with the Zinn® Ads plugin.
+         * @description Gated on `ads.manage`; audit action `ads.wordpress_pairing_created`. The `code` is shown ONCE (only its SHA-256 hash is stored) and is valid for 30 minutes. The customer pastes it into the plugin's settings page; the plugin redeems it at `claimAdsWordPressSite`.
+         */
+        post: operations["createAdsWordPressPairing"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/ads/wordpress/sites/{site_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                site_id: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Disconnect a WordPress site (its token stops working at once).
+         * @description Gated on `ads.manage`; audit action `ads.wordpress_site_disconnected`. Another organisation's site answers 404.
+         */
+        delete: operations["disconnectAdsWordPressSite"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/affiliate": {
         parameters: {
             query?: never;
@@ -40808,6 +40930,148 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/public/ads-tag/{public_key}.js": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                public_key: string;
+            };
+            cookie?: never;
+        };
+        /**
+         * The universal Zinn® Ads script for one site (public, cached).
+         * @description Public (docs/1006 §84, za-128): sites load it as `https://zinndigital.com/zat/{public_key}.js`, which the public site's edge caches and fills from here. Answered from the cache, never a database read per page view. Sets Google Consent Mode v2 defaults BEFORE any tag loads, then the configured Google, Microsoft and (only after ad consent) Meta tags, and defines `zinnAds.conversion(kind, {value_minor | amount, currency, id})`, `zinnAds.consent({...})` and `zinnAds.clickIds()`. No personal data. An unknown, removed or switched-off key is a `404` whose body is a JavaScript comment.
+         */
+        get: operations["getAdsSiteTagScript"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/ads-wordpress/claim": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * The Zinn® Ads plugin exchanges a one-time code for its site token.
+         * @description ⛔ **No authentication** — the one-time code is the whole authorisation (docs/1006 §102). Unknown, used and expired codes are one answer (422 `codeInvalid`). The `token` is returned ONCE; we keep only its SHA-256 hash. Re-connecting a host that is already connected retires its old token in the same step. Audit action `ads.wordpress_site_connected`.
+         */
+        post: operations["claimAdsWordPressSite"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/ads-wordpress/clicks": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * The plugin's click-fraud tag sends paid-click visits for scoring.
+         * @description Site token only. Up to 500 visits a batch, the facts an access log holds. Visits that carry a paid-click id (gclid, msclkid, fbclid, ttclid, li_fat_id, twclid, epik) and are older than the 10-minute dwell window are scored by the same click-fraud shield as sites hosted by Zinn® (docs/1006 §15), on the connected host whatever host a visit names. Each click is stored once, so a re-sent batch stores nothing new. Nothing is scored when the organisation switched the shield off.
+         */
+        post: operations["sendAdsWordPressClicks"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/ads-wordpress/heartbeat": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * The plugin reports in and reads its config.
+         * @description Site token only. Records the plugin and WordPress versions, whether Cloudflare fronts the site, the tag mode and, per UTC day, how many purchases the plugin sent through Zaraz (`zaraz_sent`, running totals; days in the future or older than 35 days are dropped). WPPAID: also each path's own per-day counts, so the dashboard measures the browser path and the server upload apart — `zaraz_delivered` (handed to Zaraz in the visitor's browser), `zaraz_declined` (withheld: no ad consent) and `orders_reported` (paid orders queued for the server upload). A counter not sent keeps what it had. The site calls us; nothing calls the site (§2.56).
+         */
+        post: operations["adsWordPressHeartbeat"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/ads-wordpress/outcomes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * The plugin sends the site's paid orders and free trials to the outcome pipeline.
+         * @description Site token only. The same outcome shape and store as the events API (`POST /v1/ads/connections/{connection_id}/outcomes`), for every connection of the site's organisation that is not disconnected, then pushed to the networks within minutes. Only `purchase` and `trial` (a 422 otherwise: a lead is the browser tag's). The reference is forced into the site's own namespace (`<ref_prefix>-<order number>`, the same transaction id the browser tag sends, so the network counts a sale once), the host is the connected site's whatever `outcome_url` says, and the source is `store`. Click ids and the e-mail are stored and forwarded only when an outcome's `consent` is `GRANTED` (the order page's own consent); otherwise they are dropped, whatever the request carries. Idempotent per order: a re-sent order stores nothing new. Audit action `ads.outcomes_received` when something was stored.
+         */
+        post: operations["sendAdsWordPressOutcomes"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/ads-wordpress/refunds": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * The plugin withdraws or restates orders cancelled, failed or refunded after they were reported.
+         * @description Site token only (WPPAID). An order the plugin reported (only once PAID) and that was then cancelled, failed or refunded in full is withdrawn exactly as the events API's retraction does: not uploaded yet, it never goes; uploaded, the network gets ONE retraction. Refunded in part (`refunded_minor` = refunded so far, with `currency`), the sale is restated to what was kept. The reference is forced into the site's own namespace, so a site can withdraw only its own orders. `not_found` counts references the pipeline does not have yet (the plugin tries again later). Idempotent. Audit action `ads.outcomes_retracted` when something changed.
+         */
+        post: operations["sendAdsWordPressRefunds"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/ads-wordpress/site": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * The plugin's Disconnect button revokes its own site token.
+         * @description Site token only; audit action `ads.wordpress_site_disconnected`.
+         */
+        delete: operations["disconnectAdsWordPressSelf"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/public/ads/call-numbers/{pool_key}": {
         parameters: {
             query?: {
@@ -66167,6 +66431,84 @@ export interface components {
             /** @description The address of the site in that language. */
             url?: string;
         };
+        AdsSiteTag: {
+            /** @enum {string} */
+            consent_default: "denied_eea" | "denied" | "granted";
+            enabled: boolean;
+            ga4_id: string;
+            google_ads_id: string;
+            google_labels: {
+                [key: string]: string;
+            };
+            /** Format: uuid */
+            id: string;
+            install: components["schemas"]["AdsSiteTagInstall"];
+            keep_click_ids: boolean;
+            meta_pixel_id: string;
+            microsoft_uet_id: string;
+            /** Format: uuid */
+            org_id: string;
+            /** @description Public (it is in the page source); never an API credential. */
+            public_key: string;
+            site_host: string;
+            /** Format: date-time */
+            updated_at: string | null;
+            version: number;
+            wait_for_update_ms: number;
+        };
+        AdsSiteTagCreate: components["schemas"]["AdsSiteTagSettings"] & {
+            /**
+             * Format: uuid
+             * @description Required when you manage more than one organisation.
+             */
+            org_id?: string;
+        };
+        AdsSiteTagInstall: {
+            conversion_example: string;
+            data_layer_example: string;
+            gtm_container_path: string;
+            /** Format: uri */
+            script_url: string;
+            /** @description Code for Shopify admin → Settings → Customer events → Add custom pixel. */
+            shopify_pixel: string;
+            /** @description The two lines to paste into every page's head. */
+            snippet_html: string;
+        };
+        AdsSiteTagList: {
+            items: components["schemas"]["AdsSiteTag"][];
+            suggested_hosts: string[];
+        };
+        /** @description The editable settings of a site tag (za-128, docs/1006 §84). */
+        AdsSiteTagSettings: {
+            /**
+             * @description Ad consent before the visitor's banner answers: denied in the EEA, UK and Switzerland (default), denied everywhere, or granted.
+             * @enum {string}
+             */
+            consent_default?: "denied_eea" | "denied" | "granted";
+            enabled?: boolean;
+            /** @description GA4 measurement id, G- plus letters/digits; empty for none. */
+            ga4_id?: string;
+            /**
+             * @description Google Ads tag id, AW- plus digits; empty for none.
+             * @example AW-123456789
+             */
+            google_ads_id?: string;
+            /** @description Google Ads conversion label per outcome kind (purchase, trial, lead, signup, activation, retained7, retained30, upgrade, free_listing). An empty label removes the kind. */
+            google_labels?: {
+                [key: string]: string;
+            };
+            /** @description Keep gclid, gbraid, wbraid, msclkid and fbclid in a first-party cookie for 90 days, only after ad consent. */
+            keep_click_ids?: boolean;
+            /** @description Meta pixel id (digits). Loaded only once ad consent is granted. */
+            meta_pixel_id?: string;
+            /** @description Microsoft Advertising UET tag id (digits). */
+            microsoft_uet_id?: string;
+            /** @example shop.example.com */
+            site_host?: string;
+            /** @description How long Google's tags wait for the banner's answer. */
+            wait_for_update_ms?: number;
+        };
+        AdsSiteTagUpdate: components["schemas"]["AdsSiteTagSettings"];
         AdsSocial: {
             accounts: {
                 /** Format: uuid */
@@ -66629,6 +66971,103 @@ export interface components {
             endpoints: components["schemas"]["AdsWebhookEndpoint"][];
             events: components["schemas"]["AdsWebhookEventName"][];
         };
+        /** @description What the Zinn® Ads plugin needs to run. Public ids only, never a credential. */
+        AdsWordPressConfig: {
+            cloudflare_detected: boolean;
+            heartbeat_seconds: number;
+            /** @enum {string} */
+            mode: "browser" | "zaraz";
+            offer_zaraz: boolean;
+            /** @description The site's order-reference prefix: an order's transaction id is `<ref_prefix>-<order number>` in the browser tag and the server-side upload alike. */
+            ref_prefix?: string;
+            shield: {
+                dwell_seconds: number;
+                enabled: boolean;
+                max_hits: number;
+                /**
+                 * @description Why the shield may not score this site's clicks now (a site we do not host needs the click-shield add-on; §2.46 good standing). While set, the plugin collects nothing and shows the add-on offer.
+                 * @enum {string|null}
+                 */
+                refusal: "clickShieldRequired" | "notInGoodStanding" | null;
+            };
+            site_host: string;
+            /** Format: uuid */
+            site_id: string;
+            /** @description The site's Zinn® Ads tag (the same `AdsSiteTag` "Install on any site" edits; claiming a host creates or links it). Browser mode loads `script_url` and hands each conversion to it. `null` when the tag was deleted or switched off there. */
+            tag?: {
+                public_key: string;
+                /** Format: uri */
+                script_url: string;
+                version: number;
+            } | null;
+        };
+        /** @description One delivery path of a Zaraz-mode site (WPPAID); `short` when more than 10% of at least 5 expected went missing. */
+        AdsWordPressPathHealth: {
+            delivered: number;
+            expected: number;
+            /** @enum {string} */
+            status: "ok" | "short" | "tooFew";
+        };
+        AdsWordPressSite: {
+            /** Format: date-time */
+            claimed_at?: string | null;
+            /**
+             * @description Why this site's paid clicks are not checked now: a site Zinn Digital® does not host needs the click-shield add-on (or a plan that carries it), and the account must be in good standing. The card shows the add-on offer or the billing link instead.
+             * @enum {string|null}
+             */
+            click_shield_refusal: "clickShieldRequired" | "notInGoodStanding" | null;
+            cloudflare_detected: boolean;
+            /** Format: date-time */
+            created_at?: string | null;
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            last_seen_at?: string | null;
+            /** @enum {string} */
+            mode: "browser" | "zaraz";
+            offer_zaraz: boolean;
+            /** Format: uuid */
+            org_id: string;
+            /** Format: date-time */
+            pairing_expires_at?: string | null;
+            plugin_version?: string;
+            site_host: string;
+            site_url?: string;
+            /** @enum {string} */
+            status: "pending" | "active";
+            /** @description Whether that tag loads (browser mode sends nothing without it). */
+            tag_enabled?: boolean;
+            /**
+             * Format: uuid
+             * @description The site's tag in "Install on any site" (`null` = none for this host).
+             */
+            tag_id?: string | null;
+            /** @description The token's last 4 characters. */
+            token_hint?: string;
+            wp_version?: string;
+            /** @description Zaraz-sent purchases vs network-credited, per SITE: compared only when the organisation's credit can be attributed to this site (it is the only connected WordPress site, enabled site tag and recorded sale host in the window); otherwise `cannotAttribute` with `credited` null — never a gap alarm, never a hidden loss. WPPAID: first, each path on its own over the last 7 complete UTC days (`paths`; null for a plugin build that reports no per-path counts) — the browser path (purchases handed to Zaraz vs Zaraz purchases on order pages, less those withheld for want of consent) and the server upload (orders it delivered vs paid orders queued). The ad network de-duplicates the two, so its credit alone hides a Zaraz loss; a short path makes the status `pathShort` and `short_path` names it. */
+            zaraz_health: {
+                credited?: number | null;
+                gap_pct?: number | null;
+                paths?: {
+                    browser: components["schemas"]["AdsWordPressPathHealth"];
+                    server: components["schemas"]["AdsWordPressPathHealth"];
+                    /** Format: date */
+                    window_end: string;
+                    /** Format: date */
+                    window_start: string;
+                } | null;
+                sent?: number | null;
+                /** @enum {string|null} */
+                short_path?: "browser" | "server" | "both" | null;
+                /** @enum {string} */
+                status: "notZaraz" | "noCheck" | "cannotAttribute" | "unreadable" | "tooFew" | "ok" | "gap" | "pathShort";
+                /** Format: date */
+                window_end?: string;
+                /** Format: date */
+                window_start?: string;
+            };
+        };
         /** @description One X Ads campaign and its budgets (za-43). Money is micros of `currency` (§2.8). */
         AdsXCampaign: {
             /** @description ISO 4217 code. */
@@ -144041,6 +144480,166 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    listAdsSiteTags: {
+        parameters: {
+            query?: {
+                /** @description Narrow to one of your organisations (default: all you can view). */
+                org_id?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The site tags (up to 200) and the hosts to suggest. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsSiteTagList"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+        };
+    };
+    createAdsSiteTag: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AdsSiteTagCreate"];
+            };
+        };
+        responses: {
+            /** @description The new site tag. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsSiteTag"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+            422: components["responses"]["UnprocessableEntity"];
+        };
+    };
+    getAdsSiteTag: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tag_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The site tag. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsSiteTag"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    updateAdsSiteTag: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tag_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AdsSiteTagUpdate"];
+            };
+        };
+        responses: {
+            /** @description The changed site tag. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsSiteTag"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+            422: components["responses"]["UnprocessableEntity"];
+        };
+    };
+    deleteAdsSiteTag: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tag_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Removed. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    getAdsSiteTagGtmContainer: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tag_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The container JSON (sent as an attachment). */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+        };
+    };
     getAdsSocial: {
         parameters: {
             query?: {
@@ -144207,6 +144806,97 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    listAdsWordPressSites: {
+        parameters: {
+            query?: {
+                /** @description Opaque cursor from a previous page's `page.next_cursor`. */
+                cursor?: components["parameters"]["Cursor"];
+                /** @description Maximum items to return (page size). */
+                limit?: components["parameters"]["Limit"];
+                org_id?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description One page of sites. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["AdsWordPressSite"][];
+                        page: components["schemas"]["PageMeta"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    createAdsWordPressPairing: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    /** Format: uuid */
+                    org_id?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description The pending site and its code. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsWordPressSite"] & {
+                        /** @example 7KQ2-M9XD-4RTB */
+                        code: string;
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    disconnectAdsWordPressSite: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                site_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Disconnected. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
     getAffiliateAccount: {
         parameters: {
             query?: {
@@ -177562,6 +178252,271 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    getAdsSiteTagScript: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                public_key: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The script. */
+            200: {
+                headers: {
+                    /** @description public, max-age=300, s-maxage=300, stale-while-revalidate=86400 */
+                    "Cache-Control"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/javascript": string;
+                };
+            };
+            /** @description No such site tag (a JavaScript comment). */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/javascript": string;
+                };
+            };
+        };
+    };
+    claimAdsWordPressSite: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description A CF-Ray header reached PHP. */
+                    cloudflare?: boolean;
+                    code: string;
+                    plugin_version?: string;
+                    /**
+                     * Format: uri
+                     * @description The site's home_url().
+                     */
+                    site_url: string;
+                    wp_version?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Connected. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        config: components["schemas"]["AdsWordPressConfig"];
+                        /** @description zwp_… — store it; it is never shown again. */
+                        token: string;
+                    };
+                };
+            };
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    sendAdsWordPressClicks: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    hits: {
+                        /** Format: date-time */
+                        at: string;
+                        ip: string;
+                        method?: string;
+                        path?: string;
+                        query?: string;
+                        status?: number;
+                        user_agent?: string;
+                    }[];
+                };
+            };
+        };
+        responses: {
+            /** @description What was scored. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        clicks: number;
+                        received: number;
+                        stored: number;
+                        suspected: number;
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    adsWordPressHeartbeat: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    cloudflare?: boolean;
+                    /** @enum {string} */
+                    mode?: "browser" | "zaraz";
+                    /** @description {"YYYY-MM-DD": paid orders queued for the server-side upload} */
+                    orders_reported?: {
+                        [key: string]: number;
+                    };
+                    plugin_version?: string;
+                    wp_version?: string;
+                    /** @description {"YYYY-MM-DD": of those, withheld because the visitor declined ad cookies} */
+                    zaraz_declined?: {
+                        [key: string]: number;
+                    };
+                    /** @description {"YYYY-MM-DD": of those, handed to Zaraz in the browser} */
+                    zaraz_delivered?: {
+                        [key: string]: number;
+                    };
+                    /** @description {"YYYY-MM-DD": purchases sent through Zaraz that day} */
+                    zaraz_sent?: {
+                        [key: string]: number;
+                    };
+                };
+            };
+        };
+        responses: {
+            /** @description The site's config. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsWordPressConfig"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    sendAdsWordPressOutcomes: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    outcomes: components["schemas"]["AdsOutcomeIn"][];
+                };
+            };
+        };
+        responses: {
+            /** @description Nothing new (every outcome was already stored). */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsOutcomesIngested"];
+                };
+            };
+            /** @description At least one outcome stored. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsOutcomesIngested"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    sendAdsWordPressRefunds: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    refunds: {
+                        /** @description Required with refunded_minor. */
+                        currency?: string;
+                        external_ref: string;
+                        /** @enum {string} */
+                        kind: "purchase" | "trial";
+                        /** @description Refunded so far, in minor units (refunded in part). Absent, or a total reaching the order's value in the same currency = withdrawn in full. */
+                        refunded_minor?: number;
+                    }[];
+                };
+            };
+        };
+        responses: {
+            /** @description What was done, summed over the organisation's ad accounts. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        already: number;
+                        not_found: number;
+                        restated: number;
+                        retracted: number;
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    disconnectAdsWordPressSelf: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Disconnected. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
     getAdsCallPoolNumber: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zinn-digital/sdk",
-  "version": "0.1.1419",
+  "version": "0.1.1420",
   "description": "Typed TypeScript client for the Zinn Digital Platform API, generated from its OpenAPI spec.",
   "license": "MIT",
   "author": "Neil Lock \u2014 CEO, Zinn Digital\u00ae Ltd <office@zinndigital.com>",