@zinn-digital/sdk 0.1.1420 → 0.1.1421

package/dist/generated/schema.d.ts

@@ -15687,6 +15687,49 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/admin/vendor-usage/moz": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The shared Moz API account's usage, expected figures and plan advice (staff).
+         * @description s1014 MOZ-V2. One Moz account (Growth Medium) serves V1, V2, ZinnHub and launch. An hourly workflow stores a free `quota.lookup` reading; this returns the newest (used / allotted), the daily burn for 14 days and its 7-day average, the projected month-end, each project's EXPECTED monthly rows (a planning figure, never a cap) with what it reported spending (V2's own spend is its call ledger; `used` null = that project has not reported), and an upgrade-or-overage advice computed from the stored plan prices. Requires staff + `platform.seo.manage`.
+         */
+        get: operations["getMozVendorUsage"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/admin/vendor-usage/moz/caps/{project}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @example v2 */
+                project: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Change one project's expected monthly Moz rows (staff).
+         * @description `monthly_rows` 0-5,000,000 and `alert_percent` 1-100. A planning figure only: nothing stops at it (owner, 2026-11-03: every eligible site is measured; the account-wide alerts are the control). Audit-logged with before and after. Requires staff + `platform.seo.manage`.
+         */
+        patch: operations["updateMozProjectCap"];
+        trace?: never;
+    };
     "/v1/admin/visibility": {
         parameters: {
             query?: never;
@@ -87185,6 +87228,65 @@ export interface components {
             step: string | null;
             to_release: string | null;
         };
+        MozProjectCap: {
+            /** @example 80 */
+            alert_percent: number;
+            /** @example V2 */
+            label: string;
+            /** @example 5000 */
+            monthly_rows: number;
+            /** @example v2 */
+            project: string;
+        };
+        /** @description The shared Moz account, as `getMozVendorUsage` reports it (s1014 MOZ-V2). */
+        MozVendorUsage: {
+            advice: {
+                /** @enum {string} */
+                action: "stay" | "upgrade" | "unknown";
+                break_even_rows?: number | null;
+                /** @example USD */
+                currency: string;
+                current_cost_minor?: number | null;
+                plan_key: string;
+                plan_name: string;
+                projected_cost_minor?: number | null;
+            };
+            /** @example 120000 */
+            allotted: number | null;
+            daily: {
+                /** Format: date */
+                day: string;
+                rows: number;
+            }[];
+            daily_burn_avg_7d?: number;
+            period_reset_at?: string | null;
+            plans: {
+                currency: string;
+                is_current: boolean;
+                key: string;
+                monthly_minor: number;
+                name: string;
+                overage_block_rows?: number;
+                overage_minor_per_block?: number | null;
+                rows_included: number;
+            }[];
+            projected_month_end: number | null;
+            projects: {
+                alert_percent: number;
+                label: string;
+                monthly_rows: number;
+                percent: number | null;
+                project: string;
+                used: number | null;
+            }[];
+            read_at: string | null;
+            read_error?: string;
+            read_ok: boolean;
+            spare_rows?: number | null;
+            today_rows?: number;
+            /** @example 4120 */
+            used: number | null;
+        };
         /** @description What one manual sync did. */
         MyXeroSyncRun: {
             connection?: components["schemas"]["XeroConnection"];
@@ -102546,6 +102648,11 @@ export interface components {
              * @example -1
              */
             citation_flow_delta?: number | null;
+            /**
+             * @description s1014 MOZ-V2 (owner 2026-11-03) — Domain Authority by Moz (https://moz.com/), 1-100, free on every LIVE site whatever the plan: first measured 3 days after the site's own domain first reached us, then every 30 days. Null = not measured yet or Moz had no answer — never 0. Any surface showing it credits "Domain Authority by Moz".
+             * @example 24
+             */
+            domain_authority?: number | null;
             /**
              * @description s1006 (owner D42) — Domain Rating by Ahrefs (https://ahrefs.com/), 0-100, on every site whatever the plan: first measured 3 days after the site is added, then monthly. Null = not measured yet or no answer — never 0. Any surface showing it must credit "Domain Rating by Ahrefs" (licence term).
              * @example 37
@@ -102580,6 +102687,13 @@ export interface components {
              * @enum {string}
              */
             index_state: "indexed" | "not_indexed" | "unknown" | "never_checked" | "not_entitled";
+            /** @description When the Moz reading was taken. */
+            moz_measured_at?: string | null;
+            /**
+             * @description Moz Page Authority of the site's homepage, 1-100, from the same reading.
+             * @example 31
+             */
+            page_authority?: number | null;
             /**
              * @description Distinct domains linking here. Null when not supplied; `0` is a measurement.
              * @example 118
@@ -102617,6 +102731,11 @@ export interface components {
              * @enum {string}
              */
             seo_state: "measured" | "not_in_index" | "never_fetched" | "not_entitled";
+            /**
+             * @description Moz Spam Score, 0-100 (percent of sites with similar features Moz found penalised), from the same reading. 0 is a real, good reading; null is unmeasured.
+             * @example 1
+             */
+            spam_score?: number | null;
             /**
              * @description Trust Flow, 0-100. **Null means the provider did not supply it**; `0` means it measured zero. Only present when `seo_state` is `measured`.
              * @example 24
@@ -135470,6 +135589,62 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    getMozVendorUsage: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The usage report. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MozVendorUsage"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+        };
+    };
+    updateMozProjectCap: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @example v2 */
+                project: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    alert_percent?: number;
+                    monthly_rows?: number;
+                };
+            };
+        };
+        responses: {
+            /** @description The expected figure, as stored. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MozProjectCap"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+        };
+    };
     getVisibilitySpend: {
         parameters: {
             query?: never;
@@ -187139,8 +187314,20 @@ export interface operations {
                 group?: string;
                 /** @description Maximum items to return (page size). */
                 limit?: components["parameters"]["Limit"];
+                /** @description Only sites whose newest Moz Domain Authority is at most this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
+                max_da?: number;
+                /** @description Only sites whose newest Moz homepage Page Authority is at most this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
+                max_pa?: number;
+                /** @description Only sites whose newest Moz Spam Score (percent) is at most this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
+                max_spam?: number;
+                /** @description Only sites whose newest Moz Domain Authority is at least this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
+                min_da?: number;
+                /** @description Only sites whose newest Moz homepage Page Authority is at least this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
+                min_pa?: number;
+                /** @description Only sites whose newest Moz Spam Score (percent) is at least this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
+                min_spam?: number;
                 /** @description Sort key, optionally `-`-prefixed for descending. Defaults to `-created` (newest first). Sorting is applied across the whole collection and the cursor carries the sort position, so paging a sorted list is exact. An unrecognised key is a 422, never a silent fall back to the default. */
-                ordering?: "domain" | "-domain" | "name" | "-name" | "status" | "-status" | "line" | "-line" | "stack" | "-stack" | "region" | "-region" | "plan" | "-plan" | "created" | "-created" | "authority" | "-authority" | "indexed" | "-indexed";
+                ordering?: "domain" | "-domain" | "name" | "-name" | "status" | "-status" | "line" | "-line" | "stack" | "-stack" | "region" | "-region" | "plan" | "-plan" | "created" | "-created" | "authority" | "-authority" | "indexed" | "-indexed" | "da" | "-da" | "pa" | "-pa" | "spam" | "-spam";
                 /** @description Restrict to one organization in scope (default — the whole subtree). */
                 org_id?: components["schemas"]["Uuid"];
                 /** @description Filter by product line code (e.g. `footprint_free`, `mainstream`). */
@@ -197373,6 +197560,18 @@ export interface operations {
             query?: {
                 /** @description Restrict to the sites in one site group. */
                 group?: string;
+                /** @description Only sites whose newest Moz Domain Authority is at most this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
+                max_da?: number;
+                /** @description Only sites whose newest Moz homepage Page Authority is at most this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
+                max_pa?: number;
+                /** @description Only sites whose newest Moz Spam Score (percent) is at most this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
+                max_spam?: number;
+                /** @description Only sites whose newest Moz Domain Authority is at least this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
+                min_da?: number;
+                /** @description Only sites whose newest Moz homepage Page Authority is at least this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
+                min_pa?: number;
+                /** @description Only sites whose newest Moz Spam Score (percent) is at least this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
+                min_spam?: number;
                 /** @description Restrict to one organization in the caller's scope. */
                 org_id?: components["schemas"]["Uuid"];
                 /** @description Filter by product line code. */

package/package.json

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