@zinn-digital/sdk 0.1.1351 → 0.1.1353

package/dist/generated/schema.d.ts

@@ -17280,7 +17280,7 @@ export interface paths {
         put?: never;
         /**
          * Buy one tracking number that forwards to the customer's own number (za-160).
-         * @description Gated on `ads.manage`; audit action `ads.call_number_ordered` (no phone number in its metadata). The price is the voice vendor's own answer for that number, re-read now, times the platform margin; the first month is taken from the org's prepaid Zinn® credit BEFORE the order and returned if the vendor refuses it. Refused (422) when call tracking is not open (`callNotOpen`), the CRM source `telnyx` is not set up (`callNoSource`), the forward-to number is not a United States number (`callForwardToNotOffered`), the account holds its cap (`callTooMany`), the account is not in good standing (`callAccountOnHold`), the credit is short (`callNoCredit`), the number was taken (`callNumberGone`) or its price is no longer the `first_month_usd_micros` the customer was shown (`callPriceChanged`, nothing charged). A vendor that does not answer the order leaves the number `ordering`: it is found by its reference, or refunded, within the next sweep.
+         * @description Gated on `ads.manage`; audit action `ads.call_number_ordered` (no phone number in its metadata). The price is the voice vendor's own answer for that number, re-read now, times the platform margin; the first charge (the vendor's upfront fee plus the first month, both taken by the vendor at purchase) is taken from the org's prepaid Zinn® credit BEFORE the order and returned if the vendor refuses it. Refused (422) when call tracking is not open (`callNotOpen`), the CRM source `telnyx` is not set up (`callNoSource`), the forward-to number is not a United States number or is one of our own tracking numbers (a call loop, `callForwardToNotOffered`), the account holds its cap (`callTooMany`), the account is not in good standing (`callAccountOnHold`), the credit is short (`callNoCredit`), the number was taken (`callNumberGone`) or its price is no longer the `first_month_usd_micros` the customer was shown (`callPriceChanged`, nothing charged). An order the vendor has not finished yet leaves the number `ordering` and starts the account's number sweep at once (retried until it completes); a vendor that does not answer the order leaves it `ordering` too: it is found by its reference, or refunded.
          */
         post: operations["orderAdsCallNumber"];
         delete?: never;
@@ -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;
@@ -61724,7 +61801,10 @@ export interface components {
             source_id: string | null;
         };
         AdsCallNumberOffer: {
-            /** Format: int64 */
+            /**
+             * Format: int64
+             * @description What buying it costs now — the vendor's upfront fee plus the first month, with the margin.
+             */
             first_month_usd_micros: number;
             locality: string;
             /** Format: int64 */
@@ -96803,6 +96883,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.
          *
@@ -97291,6 +97389,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;
@@ -185903,6 +186016,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;
@@ -186672,6 +186839,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;
@@ -191160,6 +191427,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.1351",
+  "version": "0.1.1353",
   "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>",