@zinn-digital/sdk 0.1.1424 → 0.1.1427

package/dist/generated/schema.d.ts

@@ -20602,6 +20602,59 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/ads/tracking-hub": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The tracking hub — every network tag, conversion id and server-side key status.
+         * @description Gated on `ads.view` (docs/1006 §104, za-126). One hub per organisation: the browser tag id of each network (Google Ads, GA4, Microsoft UET, Meta pixel, TikTok, LinkedIn Insight, X, Pinterest, Amazon), the conversion id per network and outcome kind, and WHICH server-side keys are set (never the key: it is kept only in Vault). `server_routes` says per network how server-side conversions travel: through a connected ad account, through a key in the hub, or not at all. Every site tag (za-128) serves the hub's ids where it leaves its own blank. An organisation with no hub yet answers `version: 0`.
+         */
+        get: operations["getAdsTrackingHub"];
+        /**
+         * Change the hub's tag ids and conversion ids.
+         * @description Gated on `ads.manage`; audit-logged (`ads.tracking_hub_updated`). `tags` and `conversions` each REPLACE the stored map when present (a blank id removes it). Each tag id is checked against its network's format; a wrong one is a `422` (`refusal.adsconnect.trackingHub.*`) naming the field, e.g. `tags.ga4`. The version goes up by one and the cached script of every site tag of the organisation is rewritten.
+         */
+        put: operations["updateAdsTrackingHub"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/ads/tracking-hub/keys/{kind}": {
+        parameters: {
+            query?: {
+                /** @description Required when you belong to more than one organisation. */
+                org_id?: string;
+            };
+            header?: never;
+            path: {
+                kind: "meta_capi" | "tiktok_events" | "ga4_mp" | "linkedin_capi" | "pinterest_capi";
+            };
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Store one server-side key (write-only; kept in Vault).
+         * @description Gated on `ads.manage`; audit-logged (`ads.tracking_hub_key_set`, the kind only). The key is written to Vault and never returned, logged or stored in the database; the hub keeps the time it was set and its last four characters. `503` when Vault could not be written (nothing is saved; retry).
+         */
+        put: operations["setAdsTrackingHubKey"];
+        post?: never;
+        /**
+         * Remove one server-side key from Vault and from the hub.
+         * @description Gated on `ads.manage`; audit-logged (`ads.tracking_hub_key_removed`). The record is removed only after Vault confirmed the delete. Removing a key that is not set is a `204`.
+         */
+        delete: operations["deleteAdsTrackingHubKey"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/ads/tracking/events": {
         parameters: {
             query?: never;
@@ -66662,6 +66715,16 @@ export interface components {
             org_id: string;
             /** @description Public (it is in the page source); never an API credential. */
             public_key: string;
+            /** @description za-126: the ids this site actually serves — its own, else the organisation's tracking hub's. */
+            served?: {
+                ga4_id?: string;
+                google_ads_id?: string;
+                google_labels?: {
+                    [key: string]: string;
+                };
+                meta_pixel_id?: string;
+                microsoft_uet_id?: string;
+            };
             site_host: string;
             /** Format: date-time */
             updated_at: string | null;
@@ -66969,6 +67032,59 @@ export interface components {
             rejected: number;
             waiting: number;
         };
+        /** @description One organisation's tracking hub (docs/1006 §104, za-126). */
+        AdsTrackingHub: {
+            /** @description Network -> outcome kind -> conversion id (a Google Ads label, a Meta custom conversion, a TikTok event …). */
+            conversions: {
+                [key: string]: {
+                    [key: string]: string;
+                };
+            };
+            kinds: string[];
+            networks: string[];
+            /** Format: uuid */
+            org_id: string;
+            server_keys: {
+                /** @description The key's last four characters (blank when not set). */
+                hint: string;
+                /** @enum {string} */
+                kind: "meta_capi" | "tiktok_events" | "ga4_mp" | "linkedin_capi" | "pinterest_capi";
+                network: string;
+                set: boolean;
+                /** Format: date-time */
+                set_at: string | null;
+            }[];
+            /** @description Network -> how its server-side conversions travel. */
+            server_routes: {
+                [key: string]: {
+                    connected_provider: string | null;
+                    key_kind: string | null;
+                    /** @enum {string} */
+                    route: "connected" | "key" | "none";
+                };
+            };
+            /** @description Network -> its browser tag id (google_ads, ga4, microsoft_uet, meta_pixel, tiktok_pixel, linkedin_insight, x_pixel, pinterest_tag, amazon_tag). */
+            tags: {
+                [key: string]: string;
+            };
+            /** Format: date-time */
+            updated_at: string | null;
+            /** @description 0 when no hub has been saved yet. */
+            version: number;
+        };
+        AdsTrackingHubUpdate: {
+            /** @description Network -> {outcome kind: conversion id}. A LinkedIn conversion id is numeric and an X event id is tw-PIXEL-EVENT (for example tw-o1abc-o1xyz); any other shape for those two is refused (badConversion), since the page could never fire it. */
+            conversions?: {
+                [key: string]: {
+                    [key: string]: string;
+                };
+            };
+            /** Format: uuid */
+            org_id?: string;
+            tags?: {
+                [key: string]: string;
+            };
+        };
         /** @description One ad account's tracking-truth settings (docs/1006 §21). */
         AdsTrackingSettings: {
             /** @description Network actions that stand for these outcomes; empty = every PRIMARY one. */
@@ -99250,6 +99366,10 @@ export interface components {
             runtime?: components["schemas"]["Runtime"];
             /** @description One of **your own** captured sites (`GET /v1/site-blueprints`) to build this one from. The new site is provisioned on that blueprint's stack and its archive is then restored onto it, so it comes up with the same content, plugins, theme and settings as the site it was captured from — and its stored web addresses are rewritten to this site's domain. ⛔ **Not the same field as `blueprint_id`**: that one names a stack recipe Zinn® publishes, this one names a template you made from a site you already built. Sending both is a `422`. When given, `source`, `stack_type` and `runtime` are all derived and must not be sent. A blueprint whose capture has not finished, or whose backup is no longer available, is a `422` at create time rather than a site that comes up empty an hour later. */
             site_blueprint_id?: components["schemas"]["Uuid"] | null;
+            /** @description The WordPress **Tagline** (`blogdescription`). Read for a WordPress stack only. Omitted or blank leaves WordPress's own tagline. */
+            site_tagline?: string;
+            /** @description The WordPress **Site Title** (V1 parity). Read for a WordPress stack only. Omitted or blank means the primary domain, as before. */
+            site_title?: string;
             source?: components["schemas"]["SiteSource"];
             stack_type?: components["schemas"]["StackType"];
             /** @description The subscription entitling this site. Must belong to the org that will own the site; anything else is a `422` (never a `404`, so it cannot be used to probe which subscription ids exist elsewhere). */
@@ -110527,8 +110647,13 @@ export interface components {
         };
         ZinnCampaignsChannelSettings: {
             bounce_pause_bps: number;
+            /** @description The margin row staff configured (basis points over vendor cost). */
             channel_margin_bps: number;
+            /** @description The credit floor margin (basis points) no channel price goes under. */
+            readonly channel_margin_floor_bps: number;
             complaint_pause_bps: number;
+            /** @description The margin a message is CHARGED at: channel_margin_bps raised to the 3x-net credit floor (CREDIT3X). */
+            readonly effective_channel_margin_bps: number;
             line_enabled: boolean;
             pause_min_sample: number;
             pilot_org_ids: string[];
@@ -145176,6 +145301,125 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    getAdsTrackingHub: {
+        parameters: {
+            query?: {
+                /** @description Required when you belong to more than one organisation. */
+                org_id?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The organisation's tracking hub. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsTrackingHub"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+        };
+    };
+    updateAdsTrackingHub: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AdsTrackingHubUpdate"];
+            };
+        };
+        responses: {
+            /** @description The hub after the change. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsTrackingHub"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+        };
+    };
+    setAdsTrackingHubKey: {
+        parameters: {
+            query?: {
+                /** @description Required when you belong to more than one organisation. */
+                org_id?: string;
+            };
+            header?: never;
+            path: {
+                kind: "meta_capi" | "tiktok_events" | "ga4_mp" | "linkedin_capi" | "pinterest_capi";
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    key: string;
+                };
+            };
+        };
+        responses: {
+            /** @description The hub after the change. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsTrackingHub"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            503: components["responses"]["ServiceUnavailable"];
+        };
+    };
+    deleteAdsTrackingHubKey: {
+        parameters: {
+            query?: {
+                /** @description Required when you belong to more than one organisation. */
+                org_id?: string;
+            };
+            header?: never;
+            path: {
+                kind: "meta_capi" | "tiktok_events" | "ga4_mp" | "linkedin_capi" | "pinterest_capi";
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Removed (or was not set). */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            503: components["responses"]["ServiceUnavailable"];
+        };
+    };
     listAdsTrackingEvents: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zinn-digital/sdk",
-  "version": "0.1.1424",
+  "version": "0.1.1427",
   "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>",