@zinn-digital/sdk 0.1.1402 → 0.1.1405

package/dist/generated/schema.d.ts

@@ -15972,6 +15972,54 @@ export interface paths {
         patch: operations["updateAdsAutopilotDecisions"];
         trace?: never;
     };
+    "/v1/ads/brief": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The one brief across every ad network, and the split it drives.
+         * @description Gated on `ads.view`. Read from our own rows (no network call): the objective (`leads` or `revenue`), the monthly budget, the optional target and the test share, and per network its current and proposed monthly ceiling and `why` (`bestReturn`, `offTarget`, `testShare`, `held`, `unreadable`, `otherCurrency`, `noReturn`), plus the versions saved in the last 30 days. The split is the cross-network budget's proposal (docs/1006 §113, §67), measured daily by a Temporal workflow and applied with `applyAdsCrossBudget`.
+         */
+        get: operations["getAdsBrief"];
+        /**
+         * State the objective and the budget once, for every network.
+         * @description Gated on `ads.manage`; audit action `ads.brief_set`. Sets the cross-network monthly ceiling to `budget_minor` and ranks the split by `objective`; the brief it replaces is kept 30 days for `undoAdsBrief`. Measured again now by a Temporal workflow, never in the request; nothing is applied (approve-first unless `mode: auto`). Refusals `refusal.adsconnect.briefBadObjective`, `briefBadBudget`, `briefBadCurrency`, `briefBadTarget`, `briefBadTestShare`, `briefBadMode`.
+         */
+        put: operations["setAdsBrief"];
+        post?: never;
+        /**
+         * Remove the brief (the budget stays, split by conversions per spend).
+         * @description Gated on `ads.manage`; audit action `ads.brief_clear`. Kept as a version, so it can be undone within 30 days.
+         */
+        delete: operations["clearAdsBrief"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/ads/brief/undo": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Put back the brief the last save replaced.
+         * @description Gated on `ads.manage`; audit action `ads.brief_undo`. Refused with `refusal.adsconnect.briefNothingToUndo` when no version from the last 30 days is left.
+         */
+        post: operations["undoAdsBrief"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/ads/builds": {
         parameters: {
             query?: never;
@@ -20141,6 +20189,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/ads/shield/claims/{claim_id}/outcome": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Record Google's answer to a sent pack (credit received or none).
+         * @description Gated on `ads.manage`; audit action `ads.shield_claim_outcome` (za-22, za-N8). For a pack marked sent, a person records the credit Google gave (integer minor units, §2.8) or that Google gave none: card-paying accounts have no invoices to read, so Google's reply is the only answer. Zinn® never moves money here; this is a record of a credit Google gave the ad account. 409 when the pack is not sent yet, or when its answer was read from the account's invoices (those are never overwritten). A person-recorded answer can be corrected; the write is conditional, so an invoice answer landing while the request runs is a 409, never overwritten.
+         */
+        post: operations["recordAdsShieldClaimOutcome"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/ads/shield/claims/{claim_id}/sent": {
         parameters: {
             query?: never;
@@ -29908,6 +29976,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/databases/my-address": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The address this request came from, to suggest for a database allow-list.
+         * @description Gated on `databases.view`. A database hostname publishes both an A and an AAAA record, so a client that prefers IPv6 connects from its IPv6 address and is refused if only its IPv4 address is listed. The dashboard offers this address (and the one its own origin sees, which may be the other family) so the customer can add both. Read from the forwarding header our own ingress writes, never from a value the caller supplies; `address` is null when it cannot be resolved.
+         */
+        get: operations["getManagedDatabaseClientAddress"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/domain-alerts": {
         parameters: {
             query?: never;
@@ -62230,6 +62318,64 @@ export interface components {
             /** @description Our absolute-top share on the brand keywords below this (with rank loss) means someone is placed above us. */
             top_floor_pct: number;
         };
+        AdsBrief: {
+            /** @enum {string} */
+            blocked: "" | "noReturnYet";
+            brief: {
+                /** @description Integer minor units (§2.8). */
+                budget_minor: number | null;
+                currency: string;
+                /** @enum {string} */
+                mode: "suggest" | "auto";
+                /** @enum {string} */
+                objective: "leads" | "revenue";
+                target: number | null;
+                test_share_pct: number;
+            } | null;
+            can_undo_brief: boolean;
+            keep_days: number;
+            last_apply: {
+                at: string | null;
+                by: string | null;
+                can_undo: boolean;
+                moves: components["schemas"]["AdsCrossBudgetMove"][];
+                undone_at: string | null;
+            } | null;
+            /** Format: date-time */
+            measured_at: string | null;
+            moves: components["schemas"]["AdsCrossBudgetMove"][];
+            /** Format: uuid */
+            org_id: string;
+            split: {
+                /** Format: uuid */
+                connection_id: string;
+                conversions_milli: number;
+                cost_minor: number;
+                current_minor: number | null;
+                label: string;
+                platform: string;
+                proposed_minor: number | null;
+                value_minor: number;
+                why: components["schemas"]["AdsBriefWhy"];
+            }[];
+            test_share_max: number;
+            test_share_min: number;
+            test_share_recommended: number;
+            versions: {
+                /** Format: date-time */
+                at: string;
+                brief: {
+                    [key: string]: unknown;
+                };
+                by: string;
+                /** Format: uuid */
+                id: string;
+                /** Format: date-time */
+                undone_at: string | null;
+            }[];
+        };
+        /** @enum {string} */
+        AdsBriefWhy: "bestReturn" | "offTarget" | "testShare" | "held" | "unreadable" | "otherCurrency" | "noReturn";
         /** @description The customer's own budget for one campaign (za-84, docs/1006 §84). */
         AdsBudgetDecision: {
             /** Format: int64 */
@@ -63141,6 +63287,10 @@ export interface components {
                 targets: {
                     [key: string]: number;
                 };
+                /** @description za-208 — per connection id, why it gets what it gets (absent on a proposal made before the brief existed). */
+                why?: {
+                    [key: string]: components["schemas"]["AdsBriefWhy"];
+                };
             };
         };
         AdsCrossBudgetMove: {
@@ -65420,9 +65570,9 @@ export interface components {
             connection_id: string;
             /** Format: date-time */
             credit_checked_at: string | null;
-            /** @description `no_monthly_invoicing` when the account has no invoices to read. */
+            /** @description `no_monthly_invoicing` when the account has no invoices to read (record Google's answer by hand); `no_credit_on_invoices` when the three invoices after the month closed with no credit (declined); `recorded_by_person` when a person recorded it. */
             credit_note: string;
-            /** @description The invalid-activity credit for the month read from the account's invoices (null = none seen yet). */
+            /** @description Google's invalid-activity credit for the month, integer minor units of `currency`: read from the account's invoices, or recorded by a person from Google's answer (`credit_note` = `recorded_by_person`). `0` once declined; null = no answer yet. */
             credited_minor: number | null;
             currency: string;
             estimated_cost_minor: number;
@@ -82690,6 +82840,12 @@ export interface components {
              */
             sizes: components["schemas"]["ManagedDatabaseSize"][];
         };
+        ManagedDatabaseClientAddress: {
+            /** @description The caller's public IP address, or null when it cannot be resolved. */
+            address: string | null;
+            /** @enum {string|null} */
+            family: "ipv4" | "ipv6" | null;
+        };
         ManagedDatabaseCreate: {
             /**
              * @description Optional. Omitted uses PostgreSQL. ⛔ Must match the engine the `size` code belongs to — a MySQL request carrying a `db_pg_*` size is refused, because it would run one engine and bill the other.
@@ -134949,6 +135105,136 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    getAdsBrief: {
+        parameters: {
+            query?: {
+                org_id?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The brief and the split it drives. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsBrief"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    setAdsBrief: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description The monthly budget, integer minor units of `currency` (§2.8). */
+                    budget_minor: number;
+                    /** @description ISO 4217 */
+                    currency: string;
+                    /** @enum {string} */
+                    mode?: "suggest" | "auto";
+                    /** @enum {string} */
+                    objective: "leads" | "revenue";
+                    /** Format: uuid */
+                    org_id?: string;
+                    /** @description `leads` — a cost per conversion in minor units; `revenue` — a ROAS in %. */
+                    target?: number | null;
+                    /** @description The share the networks with no measured return test with (recommended 10). */
+                    test_share_pct?: number;
+                };
+            };
+        };
+        responses: {
+            /** @description The brief and the split it drives. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsBrief"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    clearAdsBrief: {
+        parameters: {
+            query?: {
+                org_id?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The brief and the split it drives. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsBrief"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    undoAdsBrief: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    /** Format: uuid */
+                    org_id?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description The brief and the split it drives. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsBrief"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
     listAdsBuilds: {
         parameters: {
             query?: {
@@ -142981,6 +143267,47 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    recordAdsShieldClaimOutcome: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                claim_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description Required when `outcome` is `credited`; minor units of the pack's currency. */
+                    credited_minor?: number | null;
+                    /** @description Only used when neither the pack nor its ad account has a currency yet; 422 when it differs from the pack's (Google credits in the account's currency). */
+                    currency?: string;
+                    /** Format: uuid */
+                    org_id?: string;
+                    /** @enum {string} */
+                    outcome: "credited" | "declined";
+                };
+            };
+        };
+        responses: {
+            /** @description The pack. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsShieldClaim"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
     markAdsShieldClaimSent: {
         parameters: {
             query?: never;
@@ -159268,6 +159595,28 @@ export interface operations {
             403: components["responses"]["Forbidden"];
         };
     };
+    getManagedDatabaseClientAddress: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The caller's public address, or null. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ManagedDatabaseClientAddress"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+        };
+    };
     getDomainAlerts: {
         parameters: {
             query?: never;

package/package.json

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