@zinn-digital/sdk 0.1.1434 → 0.1.1436

package/dist/generated/schema.d.ts

@@ -25625,6 +25625,66 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/bulk-site-imports": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Add many sites — one per valid row of a file.
+         * @description Re-checks the file exactly as the preview does and enrols every VALID row as an item of a `site_create` bulk job; invalid rows are left out (the preview named them). Each row is then created through the same path as `POST /v1/sites`, so the site-slot quota, plan allowances and hostname rules apply per row. Refused with a `422` before anything is written when no row is valid or the file cannot be read; rows past the plan's room are flagged by the check and not enrolled. One durable job with bounded concurrency and no row cap: the bound is the quota. Follow progress with `GET /v1/bulk-jobs/{bulkJobId}`. Requires `sites.create`.
+         */
+        post: operations["createBulkSiteImport"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/bulk-site-imports/preview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Check every row of a site file before anything is created.
+         * @description Parses the rows (CSV; comma, semicolon or tab; a header row naming the columns, or no header and the columns in the template's order, so a pasted list of domains works) over the batch `defaults`, and answers per row what is wrong with it, by column: field validation by the one-site create path's own rules, an unknown site type, an unknown CDN, an own CDN account that is not connected (or not acknowledged on a platform-managed line), duplicates inside the file, a domain that is already one of the account's sites, and rows past the plan's remaining site slots. Nothing is written. A file that cannot be read at all comes back as `file_error` with a `200`, so the screen can say why. ⛔ `POST` for a read: a file does not fit in a query string. Requires `sites.create`.
+         */
+        post: operations["previewBulkSiteImport"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/bulk-site-imports/template": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The columns, allowed values and example file for Add many sites.
+         * @description s1014 BULKUPLOAD. The single source of the upload format: the deploy form's "Many sites" mode renders its "Download example CSV" button and its instructions table from this, so the example file is by construction one the importer accepts. Requires `sites.create`.
+         */
+        get: operations["getBulkSiteImportTemplate"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/campaigns": {
         parameters: {
             query?: never;
@@ -41172,6 +41232,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/public/ads-tag/{public_key}/signals": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                public_key: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * The universal tag's click-shield beacon (public, rate-limited, per-site key).
+         * @description Public (SHIELDTAG, docs/1006.d/features/za-316-shieldtag.md): the universal script sends it with `navigator.sendBeacon` as `text/plain` JSON (no CORS preflight), so the click-fraud shield works on ANY website, not only sites Zinn® hosts. `k` is `landing` (a paid-click visit; `q` holds ONLY the recognised click ids — gclid, msclkid, fbclid, ttclid, li_fat_id, twclid, epik), `engaged` (the visitor scrolled, tapped or typed), `page` (a later page view, only after ad consent) or `conversion` (`zinnAds.conversion` ran). The visitor address and user agent are the REQUEST's (our ingress's trusted client address), never the body's; the host is the tag's own site; the time is the engine's. The `Origin` must be the tag's site or a subdomain of it. A follow-up is kept only when the same address landed from a paid click inside the 10-minute dwell window. Landings are scored by the same shield as hosted sites every 5 minutes once the dwell window closed (same weights, verdicts, IP exclusions and claim packs), only while the organisation has the shield and is in good standing; a site already scored as a hosted site or by the Zinn® Ads WordPress plugin is not scored twice. Beacons are deleted after 3 days. Always `204` for a well-formed beacon, stored or not (no oracle).
+         */
+        post: operations["sendAdsSiteTagSignal"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/public/ads-wordpress/claim": {
         parameters: {
             query?: never;
@@ -66968,6 +67050,13 @@ export interface components {
                 meta_pixel_id?: string;
                 microsoft_uet_id?: string;
             };
+            /** @description What the click shield has seen through this tag (SHIELDTAG, docs/1006.d/features/za-316-shieldtag.md): when the last paid-click landing beacon arrived and the clicks scored from it in 30 days. Set on the list and the single read; the tag protects a site we do not host as soon as it is installed and the organisation has the shield. */
+            shield?: {
+                clicks_30d: number;
+                /** Format: date-time */
+                last_landing_at: string | null;
+                suspected_30d: number;
+            };
             site_host: string;
             /** Format: date-time */
             updated_at: string | null;
@@ -72174,7 +72263,7 @@ export interface components {
          * @example unsupported_platform
          * @enum {string}
          */
-        BulkErrorCode: "not_wordpress" | "not_serving" | "unsupported_platform" | "capability_denied" | "not_installed" | "unknown_blueprint" | "site_missing" | "driver_unresolved" | "vendor_refused" | "install_failed" | "not_in_good_standing" | "already_deleted" | "not_php" | "no_cdn" | "needs_addon" | "refused" | "file_missing" | "file_not_regular" | "unknown";
+        BulkErrorCode: "not_wordpress" | "not_serving" | "unsupported_platform" | "capability_denied" | "not_installed" | "unknown_blueprint" | "site_missing" | "driver_unresolved" | "vendor_refused" | "install_failed" | "not_in_good_standing" | "already_deleted" | "not_php" | "no_cdn" | "needs_addon" | "refused" | "file_missing" | "file_not_regular" | "domain_taken" | "domain_probe_budget" | "create_refused" | "invalid_row" | "unknown";
         /** @description One plugin, and how far it reaches across the sites that were read. */
         BulkInstalledPlugin: {
             /** @description How many have it switched on. Carried separately rather than derived: *"active on 3 of the 9 that have it"* is the sentence somebody about to press **Deactivate** needs, and it cannot be recovered from one number. */
@@ -72293,8 +72382,12 @@ export interface components {
             error_code: components["schemas"]["BulkErrorCode"] | null;
             /** @description For a `find_file` or `delete_file` item that succeeded: the file's size and last modified time. `null` for every other item, and for a file item written before these facts were recorded. */
             file: components["schemas"]["BulkJobItemFile"] | null;
+            /** @description `site_create` only: the one-site create path's own keyed refusal for a refused row (domain taken, no site slot, product line not allowed), rendered by the client in the reader's language. `null` otherwise. The row's create payload is never echoed. */
+            refusal?: components["schemas"]["Refusal"] | null;
             /** @description Whether `retry-failed` would reopen this item: every `failed` item, and every `skipped` item whose code is not a final answer. A search that found no such file (`file_missing`, `file_not_regular`) has answered and is not retried. Count these to label a retry control; do not re-derive the rule from `status`. */
             retryable: boolean;
+            /** @description `site_create` (Add many sites) only: the row's line in the uploaded file, the header being line 1, so the report says "line 14" in the customer's own terms. `null` for every other operation. Until the row's site exists, `site_id` is a placeholder. */
+            row?: number | null;
             /** Format: date-time */
             settled_at: string | null;
             /** @description Carried on the row rather than joined, so the report survives the site being deleted mid-job — which, on a long run, is not hypothetical. */
@@ -72516,7 +72609,7 @@ export interface components {
          * @example plugin_install
          * @enum {string}
          */
-        BulkOperation: "stack_apply" | "blueprint_apply" | "application_install" | "plugin_install" | "plugin_activate" | "plugin_deactivate" | "plugin_remove" | "plugin_update" | "theme_install" | "core_update" | "wp_search_replace" | "featured_image_backfill" | "wp_auto_updates" | "site_delete" | "php_version" | "force_https" | "canonical_www" | "country_lock" | "cdn_purge" | "malware_scan" | "malware_clean" | "find_file" | "delete_file";
+        BulkOperation: "stack_apply" | "blueprint_apply" | "application_install" | "plugin_install" | "plugin_activate" | "plugin_deactivate" | "plugin_remove" | "plugin_update" | "theme_install" | "core_update" | "wp_search_replace" | "featured_image_backfill" | "wp_auto_updates" | "site_delete" | "php_version" | "force_https" | "canonical_www" | "country_lock" | "cdn_purge" | "malware_scan" | "malware_clean" | "find_file" | "delete_file" | "site_create";
         /** @description The outcome of restoring every restorable site for one org. */
         BulkRestoreResult: {
             /** @description Each site that could not be restored, with the reason code. */
@@ -72539,6 +72632,93 @@ export interface components {
          * @enum {string}
          */
         BulkSelector: "sites" | "product_line" | "org" | "group" | "filter";
+        /** @description "Settings for all sites": any of these `SiteCreate` fields, applied to every row that leaves the matching column blank. A row naming its own `site_type` drops the batch's stack-specific choices (blueprint, application, PHP, theme, plugins). `footprint_acknowledged` is the shared-footprint warning accepted for own-CDN rows on a platform-managed line. Any other key is ignored. */
+        BulkSiteImportDefaults: {
+            application?: string;
+            /** @enum {string} */
+            canonical_host?: "apex" | "www";
+            cdn_account_id?: string;
+            cdn_tier?: string;
+            cdn_vendor?: string;
+            create_mailbox?: boolean;
+            deploy_target?: string;
+            dns_vendor?: string;
+            footprint_acknowledged?: boolean;
+            force_https?: boolean;
+            php_version?: string;
+            plugins?: string[];
+            random_theme?: boolean;
+            region?: string;
+            site_blueprint_id?: components["schemas"]["Uuid"];
+            source?: string;
+            stack_type?: string;
+            subscription_id?: components["schemas"]["Uuid"];
+            theme?: string;
+            use_own_dns?: boolean;
+        } & {
+            [key: string]: unknown;
+        };
+        BulkSiteImportPreview: {
+            /** @enum {string|null} */
+            file_error: "file_empty" | "file_too_large" | "no_rows" | null;
+            invalid: number;
+            quota: {
+                enough: boolean;
+                product_line: string;
+                /** @description `null` = unlimited. */
+                remaining: number | null;
+                rows: number;
+            }[];
+            rows: {
+                /** @description The row's CDN vendor, `own` for the customer's own account, or empty for the line default. */
+                cdn: string;
+                domain: string;
+                errors: components["schemas"]["BulkSiteImportRowError"][];
+                name: string;
+                product_line: string;
+                row: number;
+                site_type: string;
+                title?: string;
+            }[];
+            total: number;
+            valid: number;
+        };
+        BulkSiteImportRequest: {
+            /** @description The rows' text. Comma, semicolon or tab separated; the first line is the header when it names a `domain` column, otherwise every line is a row in the template's order. */
+            csv: string;
+            defaults?: components["schemas"]["BulkSiteImportDefaults"];
+            note?: string;
+            /** @description The account the sites belong to. Optional when you reach exactly one. */
+            org_id?: components["schemas"]["Uuid"] | null;
+            /** @description The product line every row is created on (the deploy form's line). */
+            product_line?: string;
+        };
+        BulkSiteImportRowError: {
+            /** @enum {string} */
+            code: "domain_missing" | "domain_invalid" | "domain_duplicate" | "domain_exists" | "site_type_missing" | "unknown_site_type" | "unknown_cdn" | "cdn_account_missing" | "cdn_account_not_connected" | "cdn_needs_acknowledgement" | "title_needs_wordpress" | "invalid_value" | "over_plan_limit";
+            column: string;
+        };
+        BulkSiteImportTemplate: {
+            /** @description The `cdn` value meaning "my own connected CDN account" (named in `cdn_account`). */
+            cdn_own_value?: string;
+            columns: {
+                allowed: string[];
+                example: string;
+                name: string;
+                required: boolean;
+            }[];
+            example_csv: string;
+            max_file_bytes: number;
+        };
+        BulkSiteImportUpload: {
+            /** @description `BulkSiteImportDefaults` as a JSON string. */
+            defaults?: string;
+            /** Format: binary */
+            file: string;
+            note?: string;
+            org_id?: components["schemas"]["Uuid"];
+            product_line?: string;
+        };
         BulkVendorOperationRequest: {
             /**
              * @description Which platform operation to run. ⛔ A closed set, not a passthrough — a client cannot name an upstream path. `block_country` and `delete` are deliberately absent and answer `422` with the reason if asked for.
@@ -99630,6 +99810,8 @@ export interface components {
              * @example bunny_dns
              */
             dns_vendor?: string;
+            /** @description Omitted means `false`. The customer accepted the shared-footprint warning for their own CDN account on a platform-managed line (Footprint-Free). With it, `cdn_tier: byo` plus a named `cdn_account_id` is accepted at create on that line; without it, refused (`422`). */
+            footprint_acknowledged?: boolean;
             /** @description Redirect http to https at the edge. **Omitted means `true`** — the insecure choice has to be asked for and is never reached by leaving the field out. */
             force_https?: boolean;
             /** @example Acme Marketing Site */
@@ -154239,6 +154421,86 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    createBulkSiteImport: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["BulkSiteImportRequest"];
+                "multipart/form-data": components["schemas"]["BulkSiteImportUpload"];
+            };
+        };
+        responses: {
+            /** @description The job was created and is running. */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BulkJob"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            409: components["responses"]["Conflict"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    previewBulkSiteImport: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["BulkSiteImportRequest"];
+                "multipart/form-data": components["schemas"]["BulkSiteImportUpload"];
+            };
+        };
+        responses: {
+            /** @description Every row and what is wrong with it. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BulkSiteImportPreview"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            422: components["responses"]["UnprocessableEntity"];
+        };
+    };
+    getBulkSiteImportTemplate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The upload format. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BulkSiteImportTemplate"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+        };
+    };
     listCampaigns: {
         parameters: {
             query?: {
@@ -179449,6 +179711,40 @@ export interface operations {
             };
         };
     };
+    sendAdsSiteTagSignal: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                public_key: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        responses: {
+            /** @description Received (stored, or ignored on purpose). */
+            204: {
+                headers: {
+                    /** @description * */
+                    "Access-Control-Allow-Origin"?: string;
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not a beacon (bad JSON, unknown kind, a landing without a click id, too large). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
     claimAdsWordPressSite: {
         parameters: {
             query?: never;

package/package.json

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