@zinn-digital/sdk 0.1.1404 → 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;
@@ -62270,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 */
@@ -63181,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: {
@@ -134995,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?: {

package/package.json

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