@zinn-digital/sdk 0.1.1347 → 0.1.1352

package/dist/generated/schema.d.ts

@@ -47446,6 +47446,33 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/sites/{siteId}/database/query": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Site ID (UUIDv7). */
+                siteId: components["parameters"]["SiteId"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Run one guarded SQL statement against the site's WordPress database.
+         * @description One statement, checked before anything reaches the site: a verb allow-list (reads `SELECT`, `SHOW`, `DESCRIBE`, `EXPLAIN`, `WITH`; writes `INSERT`, `UPDATE`, `DELETE`, `REPLACE` only with `allow_write`), no comments, no `INTO OUTFILE`/`LOAD_FILE`, no deliberate delays, and a `WHERE` clause on every `UPDATE`/`DELETE`. Schema changes and privileges are never run. Anything else answers `422` naming the rule.
+         *
+         *     ⛔ Reads run inside `START TRANSACTION READ ONLY`, so the database itself refuses a write the check missed. A write runs in a transaction that is **rolled back** when it touches more rows than the limit, and always when `dry_run` is set — that is the preview: it answers how many rows the write *would* change.
+         *
+         *     ⛔ `200` with `ok: false` when MySQL refuses the statement (its own diagnosis). The audit row records the verb and row counts — never the statement or its result. Requires `sites.view` and `sites.panel_access`. Fleet WordPress sites only.
+         */
+        post: operations["runSiteDatabaseQuery"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/sites/{siteId}/databases": {
         parameters: {
             query?: never;
@@ -47917,6 +47944,56 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/sites/{siteId}/files": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Site ID (UUIDv7). */
+                siteId: components["parameters"]["SiteId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * List one folder of the site, inside its WordPress root.
+         * @description The file editor's folder view. `path` is relative to the WordPress root (empty is the root). ⛔ `..`, absolute paths and links pointing outside the root are refused; `wp-config.php`, `.user.ini`, `php.ini` and the editor's backup folder are never listed or opened. Requires `sites.view` and `sites.panel_access`. Fleet only.
+         */
+        get: operations["listSiteFiles"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/sites/{siteId}/files/content": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Site ID (UUIDv7). */
+                siteId: components["parameters"]["SiteId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Read one text file of the site.
+         * @description Up to 1 MB of UTF-8 text, with its `sha256` — pass that back as `expected_sha256` when writing to refuse a write over a file that changed since. Same path rules as `listSiteFiles`. Requires `sites.view` and `sites.panel_access`. Fleet only.
+         */
+        get: operations["getSiteFileContent"];
+        /**
+         * Replace or create one text file of the site.
+         * @description The current file is copied to `.zinn-file-backups/` (denied to the web) first, then the new content is written atomically (temporary file + rename). With `expected_sha256` the write is refused when the file changed since it was read. The audit row records the path, size and hashes — never the content. Requires `sites.view` and `sites.panel_access`. Fleet only.
+         */
+        put: operations["putSiteFileContent"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/sites/{siteId}/firewall": {
         parameters: {
             query?: never;
@@ -56263,6 +56340,8 @@ export interface components {
             updated_at: string;
         };
         AdminBoardActivity: {
+            /** @description The member of staff behind an act done from an impersonated session (`user:<staff id>`, the audit log's ref); null for an ordinary act. Staff-only: customer payloads read `support` instead (VERIFY-ACTORS6). */
+            acting_ref?: string | null;
             actor_id: components["schemas"]["Uuid"] | null;
             actor_is_client: boolean;
             /**
@@ -61178,10 +61257,22 @@ export interface components {
                 basis?: string;
                 /** Format: date-time */
                 recorded_at?: string | null;
+                /** @description Who last recorded the consent, by name (else e-mail) — set ONLY when `recorded_by_kind` is `person` (a current member of this org); empty otherwise. Never a raw `user:<id>` (VERIFY-ADSACTOR). */
                 recorded_by?: string;
+                /**
+                 * @description Who recorded the consent, as a kind the screen translates — the same kinds as `AdsBudgetDecision.decided_by_kind` (`support` = our staff, including while impersonating). `null` when nobody has.
+                 * @enum {string|null}
+                 */
+                recorded_by_kind?: "person" | "support" | "agency" | "former_member" | "assistant" | "automatic" | "integration" | "other" | null;
                 /** Format: date-time */
                 terms_accepted_at?: string | null;
+                /** @description Who accepted the Customer Match terms — the same rule as `recorded_by`. */
                 terms_accepted_by?: string;
+                /**
+                 * @description Who accepted the terms, as a kind (as `recorded_by_kind`); `null` when nobody has.
+                 * @enum {string|null}
+                 */
+                terms_accepted_by_kind?: "person" | "support" | "agency" | "former_member" | "assistant" | "automatic" | "integration" | "other" | null;
             };
             /** Format: date-time */
             created_at: string;
@@ -61489,7 +61580,7 @@ export interface components {
             /** @description The person who decided, by name (else e-mail) — set ONLY when `decided_by_kind` is `person`, i.e. a current member of this org; empty for every other kind. Never a raw `user:<id>` or `mcp:<id>`: the audit trail keeps the stored actor. */
             decided_by: string;
             /**
-             * @description Who decided, as a kind the screen translates: `person` (a current member, named in `decided_by`), `support` (our staff), `agency` (a member of the parent org), `former_member` (removed, deleted or not of this org), `assistant` (the AI assistant over MCP), `automatic` (the autopilot), `integration` (an API key), `other`.
+             * @description Who decided, as a kind the screen translates: `person` (a current member, named in `decided_by`), `support` (our staff — including a decision made while our staff were signed in to this account on the customer's behalf (impersonation): it is recorded as the staff member, never the customer), `agency` (a member of the parent org), `former_member` (removed, deleted or not of this org), `assistant` (the AI assistant over MCP), `automatic` (the autopilot), `integration` (an API key, stored as `apikey:<id>`), `other`.
              * @enum {string}
              */
             decided_by_kind: "person" | "support" | "agency" | "former_member" | "assistant" | "automatic" | "integration" | "other";
@@ -61822,6 +61913,7 @@ export interface components {
             connection_id: string;
             /** Format: date-time */
             decided_at: string | null;
+            /** @description Who approved or declined it: who stored it (`user:<id>`, `autopilot`, `mcp:<id>`, `apikey:<id>`, …) — except a member of our staff, who reads `support` and never their id (VERIFY-ADSACTOR: an impersonated write is recorded as the staff member). */
             decided_by: string;
             /** @description Why the change was not sent, its CODE leading (`ceiling`, `killed`, `paused`, `disconnected`, `standing: …`, `needsReconnect`, `adBelowGood`, `xWritesOff`, za-70 `collides` — the collision simulator found what `summary.collision` names — or `collisionUnread` — the account could not be read for the replay — and za-10 `convertingSearch: …` — a negative keyword that would block a search with a conversion in the last 30 days, refused at the send even when a person approved it; SERVEWATCH `strategyStarves` — a bid-strategy switch whose ceiling or bids cannot win most of the campaign's searches against Google's own top-of-page estimates, refused whoever asked, its figures in `summary.serving_check`; UNDOSTRAT, on an APPLIED change whose Undo puts a bid strategy back: `killed` · `paused` · `standing` · `strategyStarves` followed by `: undo refused` — the restore passes the kill switch, good standing and the same simulation — and `undoReadBackDiffers: <campaigns>`, the strategy Google read back after the Undo is not `summary.bidding_before`, so the change stays applied and its Undo can be sent again); otherwise the network's own sentence. Empty when nothing went wrong. */
             error: string;
@@ -61831,6 +61923,7 @@ export interface components {
             org_id: string;
             /** Format: date-time */
             proposed_at: string;
+            /** @description Who proposed the change: who stored it (`user:<id>`, `autopilot`, `mcp:<id>`, `apikey:<id>`, …) — except a member of our staff, who reads `support` and never their id (VERIFY-ADSACTOR: an impersonated write is recorded as the staff member). */
             proposed_by: string;
             status: components["schemas"]["AdsChangeStatus"];
             /** @description What the change does, for the card. SERVEWATCH adds `serving_check` (a bid-strategy switch simulated before the send: `verdict` ok · unknown · starves, `strategy`, `reason`, `ceiling_micros`, `need_micros`, `reach_pct` of the searches the ceiling can win, `raise_to_micros`, `fix`), `restores_served` (a serving-watch revert of the change that stopped a campaign) and `converting_removal` (a removal of campaigns that produced `share_pct`% of the account's results in 30 days: `campaigns`, `share_pct`, `conversions` — an automatic one waits for a person). UNDOSTRAT adds `bidding_before` on a change that alters a campaign's bidding: one entry per campaign (`resource`, `type` the bidding strategy type, `portfolio` a portfolio strategy's resource or `settings` the strategy's own values — `location`, `locationFractionMicros`, `cpcBidCeilingMicros`, `cpcBidFloorMicros`, `targetCpaMicros`, `targetRoas`, `enhancedCpcEnabled`), read before the send. Its Undo restores exactly that, and is marked undone only when Google reads it back. */
@@ -63861,7 +63954,13 @@ export interface components {
             created_by: string;
             /** Format: date-time */
             decided_at: string | null;
+            /** @description Who decided, by name (else e-mail) — set ONLY when `decided_by_kind` is `person`, a current member of this org; empty otherwise. Never the stored `user:<id>` (ADSACTOR r2): the audit trail keeps it. */
             decided_by: string;
+            /**
+             * @description Who decided, as a kind the screen translates — the same rule as a budget decision's `decided_by_kind` (`automatic` also covers a review settled by the autopilot's own test). `null` while nothing is decided.
+             * @enum {string|null}
+             */
+            decided_by_kind: "person" | "support" | "agency" | "former_member" | "assistant" | "automatic" | "integration" | "other" | null;
             /** @enum {string} */
             decision: "" | "keep" | "pause" | "revert" | "extend";
             /** Format: date */
@@ -65375,8 +65474,9 @@ export interface components {
         /** @description One person, resolved to something a human recognises. ⛔ Every `*_by` field on the AGENCY's side of this API carries one of these rather than a bare id — the People drawer rendered a raw UUID at a colleague's name until 2026-09-01, and an object with no id-shaped field to reach for is what stops that recurring. */
         AgencyBoardActor: {
             email?: string;
-            id: components["schemas"]["Uuid"];
-            /** @description Display name, falling back to the email address when the account has never set one. Never blank. */
+            /** @description Null when a member of staff did this from an impersonated session — `name` is then `support` and no person is named (VERIFY-ACTORS6). */
+            id: components["schemas"]["Uuid"] | null;
+            /** @description Display name, falling back to the email address when the account has never set one. Never blank. `support` for an act a member of staff did while impersonating. */
             name: string;
         };
         /**
@@ -96780,6 +96880,24 @@ export interface components {
              */
             web_ide_sso_url: string | null;
         };
+        /** @description One guarded statement's outcome. */
+        SiteDatabaseQueryResult: {
+            /** @description Rows a write changed (or would change). */
+            affected?: number;
+            columns?: string[];
+            /** @description True when a write was rolled back as a preview. */
+            dry_run?: boolean;
+            /** @description MySQL's own refusal, when `ok` is false. */
+            error?: string;
+            ok: boolean;
+            rows?: {
+                [key: string]: unknown;
+            }[];
+            total_rows?: number;
+            /** @example SELECT */
+            verb: string;
+            write: boolean;
+        };
         /**
          * @description The deletion lifecycle of one site, as the customer's danger zone renders it.
          *
@@ -97268,6 +97386,21 @@ export interface components {
          * @enum {string}
          */
         SiteFailedStep: "begin" | "placement" | "account" | "blueprint" | "cdn" | "dns" | "verify" | "activate";
+        /** @description A folder listing, a file read or a file write. */
+        SiteFileResult: {
+            /** @description Where the previous file was copied */
+            backup?: string;
+            bytes?: number;
+            content?: string;
+            entries?: {
+                [key: string]: unknown;
+            }[];
+            error?: string;
+            ok: boolean;
+            path?: string;
+            sha256?: string;
+            truncated?: boolean;
+        };
         SiteFirewall: {
             /** @description Only trusted addresses may reach the login page and wp-admin. */
             admin_trusted_only: boolean;
@@ -185880,6 +186013,60 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    runSiteDatabaseQuery: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Site ID (UUIDv7). */
+                siteId: components["parameters"]["SiteId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * @description Permit `INSERT`/`UPDATE`/`DELETE`/`REPLACE`.
+                     * @default false
+                     */
+                    allow_write?: boolean;
+                    /**
+                     * @description Run a write and roll it back, answering the rows it would change.
+                     * @default false
+                     */
+                    dry_run?: boolean;
+                    /**
+                     * @description Rows returned for a read.
+                     * @default 100
+                     */
+                    max_rows?: number;
+                    /**
+                     * @description One SQL statement. A trailing `;` is allowed.
+                     * @example SELECT option_name FROM wp_options WHERE autoload = 'yes' LIMIT 10
+                     */
+                    sql: string;
+                };
+            };
+        };
+        responses: {
+            /** @description The result, or MySQL's refusal with `ok` false. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SiteDatabaseQueryResult"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+            503: components["responses"]["ProviderNotConfigured"];
+        };
+    };
     listSiteDatabases: {
         parameters: {
             query?: never;
@@ -186649,6 +186836,106 @@ export interface operations {
             422: components["responses"]["UnprocessableEntity"];
         };
     };
+    listSiteFiles: {
+        parameters: {
+            query?: {
+                /** @description The folder, relative to the WordPress root. */
+                path?: string;
+            };
+            header?: never;
+            path: {
+                /** @description Site ID (UUIDv7). */
+                siteId: components["parameters"]["SiteId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The folder's entries, or `ok` false with the reason. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SiteFileResult"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            503: components["responses"]["ProviderNotConfigured"];
+        };
+    };
+    getSiteFileContent: {
+        parameters: {
+            query: {
+                /** @description The file, relative to the WordPress root. */
+                path: string;
+            };
+            header?: never;
+            path: {
+                /** @description Site ID (UUIDv7). */
+                siteId: components["parameters"]["SiteId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The file, or `ok` false with the reason. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SiteFileResult"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            503: components["responses"]["ProviderNotConfigured"];
+        };
+    };
+    putSiteFileContent: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Site ID (UUIDv7). */
+                siteId: components["parameters"]["SiteId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description The whole new content, UTF-8. */
+                    content: string;
+                    /** @description The `sha256` the file had when read. */
+                    expected_sha256?: string;
+                    path: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Written (with the backup's path), or `ok` false with the reason. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SiteFileResult"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            503: components["responses"]["ProviderNotConfigured"];
+        };
+    };
     getSiteFirewall: {
         parameters: {
             query?: never;
@@ -191137,6 +191424,11 @@ export interface operations {
         requestBody: {
             content: {
                 "application/json": {
+                    /**
+                     * @description Permit the write tier (plugin/theme install and update by WordPress.org slug, activate/deactivate, option update, cache flush, rewrite flush, search-replace…). `eval`, `db query`, `config`, credential commands, `--user_pass` and `--zip` are refused at every tier.
+                     * @default false
+                     */
+                    allow_write?: boolean;
                     /**
                      * @description The WP-CLI command, with or without a leading `wp`.
                      * @example plugin list --format=json

package/package.json

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