@zinn-digital/sdk 0.1.1433 → 0.1.1434

package/dist/generated/schema.d.ts

@@ -18306,7 +18306,7 @@ export interface paths {
         };
         /**
          * The connected Google Ads account's whole structure as last read (za-262).
-         * @description Gated on `ads.view`. Read on Temporal when the account is connected, on Refresh and weekly by the daily audit — never Google in the request. `state` is `notRead` until the first read, `ok` with `import`, or `failed` with `error` (a failed read never shows old figures as current). `import` carries the account's campaigns (status, channel, daily budget in micros, shared budget, bid strategy and its target, Google's bidding-strategy status, ad groups, keywords by match type, ads, negatives, location targets), its conversion actions and totals. Read only: nothing is written to the account. A connection on another network is a `422` `refusal.adsconnect.platformNotSupported`. `history` (za-263) is the account's OWN history read back month by month to the retention edge (400 days) after the first read — `null` until it starts; its figures are the ad-group totals now stored.
+         * @description Gated on `ads.view`. Read on Temporal when the account is connected, on Refresh and weekly by the daily audit — never Google in the request. `state` is `notRead` until the first read, `ok` with `import`, or `failed` with `error` (a failed read never shows old figures as current). `import` carries the account's campaigns (status, channel, daily budget in micros, shared budget, bid strategy and its target, Google's bidding-strategy status, ad groups, keywords by match type, ads, negatives, location targets), its conversion actions and totals. Read only: nothing is written to the account. A connection on another network is a `422` `refusal.adsconnect.platformNotSupported`. `history` (za-263) is the account's OWN history read back month by month to the retention edge (400 days) after the first read — `null` until it starts; its figures are the ad-group totals now stored. `plan` (za-265) is the optimisation plan built from that history once it is read (and at most weekly after) — `null` until then: what WORKS (kept and protected from automatic pauses), the measured waste and the structural steps, every write a PENDING change in the approvals queue (`change_id`), never applied by itself.
          */
         get: operations["getAdsImportedAccount"];
         put?: never;
@@ -64655,6 +64655,76 @@ export interface components {
             /** Format: date */
             window_start: string | null;
         };
+        /** @description za-265: the imported account's plan from its own history. `state` is `ok`, `notEnoughHistory` or `noConversions` (no waste is judged on a thin or conversion-less history — `decided_by` carries the counts and the bars that decided it) or `paused` (the org is not in good standing). Money in integer micros; conversions in thousandths. */
+        AdsImportedPlan: {
+            /** Format: date-time */
+            built_at: string;
+            decided_by?: {
+                /** Format: int64 */
+                account_cpa_micros?: number;
+                /** Format: int64 */
+                clicks?: number;
+                /** Format: int64 */
+                conversions_milli?: number;
+                /** Format: int64 */
+                cost_micros?: number;
+                days_with_data?: number;
+                min_clicks?: number;
+                min_days?: number;
+            };
+            keep?: {
+                campaigns?: ({
+                    campaign_id?: string;
+                    name?: string;
+                } & components["schemas"]["AdsImportedPlanFigures"])[];
+                countries?: ({
+                    country?: string;
+                } & components["schemas"]["AdsImportedPlanFigures"])[];
+                keywords?: ({
+                    campaign?: string;
+                    keyword?: string;
+                    resource?: string;
+                } & components["schemas"]["AdsImportedPlanFigures"])[];
+            };
+            /** @enum {string} */
+            state: "ok" | "notEnoughHistory" | "noConversions" | "paused";
+            structural?: components["schemas"]["AdsImportedPlanItem"][];
+            waste?: components["schemas"]["AdsImportedPlanItem"][];
+        };
+        AdsImportedPlanFigures: {
+            /** Format: int64 */
+            clicks?: number;
+            /** Format: int64 */
+            conversions_milli?: number;
+            /** Format: int64 */
+            cost_micros?: number;
+        };
+        /** @description One plan item. `kind`: `searchNegative` (an EXACT negative for `term` on `campaigns`), `keywordPause` (`keyword`, `resource`), `countryExclude` (`country`, ISO 3166-1 alpha-2, with `expected_conversions` at the account's own rate), `bidForConversions` (`campaign_id`, `campaign`, `from`, `conversions_30d`, `need` — the bid-ladder rung), `sharedBudget` (`budget`, `campaigns` — a person's step) or `noConversionAction`. A write carries the pending change it queued (`change_id`, `change_status`). */
+        AdsImportedPlanItem: {
+            budget?: string;
+            campaign?: string;
+            campaign_id?: string;
+            campaigns?: string[];
+            /** Format: uuid */
+            change_id?: string;
+            change_status?: string;
+            /** Format: int64 */
+            clicks?: number;
+            conversions_30d?: number;
+            /** Format: int64 */
+            conversions_milli?: number;
+            /** Format: int64 */
+            cost_micros?: number;
+            country?: string;
+            expected_conversions?: number;
+            from?: string;
+            keyword?: string;
+            /** @enum {string} */
+            kind: "searchNegative" | "keywordPause" | "countryExclude" | "bidForConversions" | "sharedBudget" | "noConversionAction";
+            need?: number;
+            resource?: string;
+            term?: string;
+        };
         /** @description One reading of an account, or null before its first audit. `figures` depends on `kind` (docs/1006 §30): money is integer minor units (`*_minor`) or micros (`*_micros`) of the account's currency, never a float; missed clicks and conversions are estimates. */
         AdsInsightReading: {
             /** Format: date */
@@ -141112,6 +141182,7 @@ export interface operations {
                             error: string | null;
                             history: components["schemas"]["AdsImportedHistory"] | null;
                             import: components["schemas"]["AdsImportedAccount"] | null;
+                            plan: components["schemas"]["AdsImportedPlan"] | null;
                             /** Format: date-time */
                             read_at: string | null;
                             /** @enum {string} */

package/package.json

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