@zinn-digital/sdk 0.1.1412 → 0.1.1414

package/dist/generated/schema.d.ts

@@ -18150,6 +18150,50 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/ads/connections/{connection_id}/imported": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                connection_id: string;
+            };
+            cookie?: never;
+        };
+        /**
+         * 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.
+         */
+        get: operations["getAdsImportedAccount"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/ads/connections/{connection_id}/imported/refresh": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                connection_id: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Read the connected Google Ads account's structure again now (za-262).
+         * @description Gated on `ads.manage`. Starts one read on Temporal (one per connection per minute) and answers 202; 503 when the workflow could not be started. A disconnected connection is a `422` `refusal.adsconnect.disconnected`.
+         */
+        post: operations["refreshAdsImportedAccount"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/ads/connections/{connection_id}/insights": {
         parameters: {
             query?: never;
@@ -63802,6 +63846,89 @@ export interface components {
         AdsHistoryThresholdsInput: components["schemas"]["AdsHistoryThresholds"] & {
             reset?: boolean;
         };
+        /** @description za-262: a connected Google Ads account's structure as read (read only). Money is integer micros of `currency`, never a float; a shared budget is counted once in `enabled_daily_budget_micros`. */
+        AdsImportedAccount: {
+            account_name: string;
+            campaigns: {
+                ad_group_negatives: number;
+                ad_groups: number;
+                ads: number;
+                ads_enabled: number;
+                bid_strategy: string;
+                bid_strategy_status: string;
+                /** @description The budget's resource name (a shared budget is counted once by it). */
+                budget_id: string;
+                budget_shared: boolean;
+                budget_shared_by: number;
+                campaign_negatives: number;
+                channel: string;
+                /** Format: int64 */
+                daily_budget_micros: number;
+                id: string;
+                keywords: number;
+                keywords_by_match: {
+                    [key: string]: number;
+                };
+                learning: boolean;
+                location_exclusions: number;
+                location_targets: number;
+                name: string;
+                portfolio: boolean;
+                status: string;
+                /** Format: int64 */
+                target_cpa_micros: number | null;
+                target_roas_pct: number | null;
+            }[];
+            conversion_actions: {
+                category: string;
+                counting: string;
+                id: string;
+                name: string;
+                primary: boolean;
+                status: string;
+            }[];
+            currency: string;
+            optimization_score_pct: number | null;
+            /** Format: date-time */
+            read_at: string;
+            totals: {
+                ad_groups: number;
+                ads: number;
+                campaigns: number;
+                campaigns_enabled: number;
+                conversion_actions: number;
+                /** Format: int64 */
+                enabled_daily_budget_micros: number;
+                keywords: number;
+                learning: number;
+                negatives: number;
+                primary_conversion_actions: number;
+                shared_budgets: number;
+            };
+        };
+        /** @description za-263: the connected account's own history read back on Temporal (month by month, resumable, deferred to Google's reset when the day's op budget is spent). Money in integer micros; conversions in thousandths. */
+        AdsImportedHistory: {
+            /** Format: int64 */
+            clicks: number;
+            /** Format: int64 */
+            conversions_milli: number;
+            /** Format: int64 */
+            cost_micros: number;
+            days_with_data: number;
+            error: string | null;
+            /** Format: date */
+            first_day: string | null;
+            months_read: number;
+            months_total: number;
+            /** @enum {string} */
+            state: "reading" | "done" | "paused";
+            /** Format: int64 */
+            value_micros: number;
+            /** Format: date */
+            window_end: string | null;
+            /** Format: date */
+            window_start: string | null;
+        };
         /** @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 */
@@ -108043,6 +108170,8 @@ export interface components {
              * @description The product-specific payload — the engine answers and mention rate for `ai_visibility`, the per-platform ratings for `reputation`, the crawl totals for `onpage`. For `onpage`, `crawl_truncated` says whether the crawl stopped at its page budget: "no issues found" after crawling 100 of 40,000 pages is not a clean site.
              *
              *     For `rank`, every run carries its **complete** `keywords` array — each phrase, its position, and both AI-citation readings — so a client can chart the history from the audit list without a second call. Each row also carries `ai_overview_change` and `ai_mode_change`: `"lost"`, `"gained"`, or `null`. ⛔ `null` is *"no comparison could be made"* — the surface was absent from one of the two runs, or the citation could not be read — and is **not** "unchanged". The run totals `ai_overview_citations_lost` / `_gained` and `ai_mode_citations_lost` / `_gained` count those transitions in both directions, per surface. A transition is what raises `visibility.ai_citation.lost` / `.gained` and is the only thing that notifies a customer; the `rank_ai_overview_missing` / `rank_ai_mode_missing` findings are the corresponding **states**, true on every run until they change.
+             *
+             *     For `ai_visibility`, each `answers[]` row says whether the target was **found** as well as **cited**: `found` is `true` when the target's site was among the pages the engine's web search returned (`found_url` is that page, `found_count` how many pages the search returned), `false` when the engine searched and the site was absent, and `null` when the engine did not search, which means unknown, not "not found". `found: true` with `linked: false` is *found but not cited*; `competitors` are the domains cited instead. Each `cited_<engine>` finding's detail counts `found_not_cited`.
              */
             summary?: {
                 [key: string]: unknown;
@@ -139440,6 +139569,89 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    getAdsImportedAccount: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                connection_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The stored reading. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            connection_id: string;
+                            error: string | null;
+                            history: components["schemas"]["AdsImportedHistory"] | null;
+                            import: components["schemas"]["AdsImportedAccount"] | null;
+                            /** Format: date-time */
+                            read_at: string | null;
+                            /** @enum {string} */
+                            state: "notRead" | "ok" | "failed";
+                        };
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    refreshAdsImportedAccount: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                connection_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Started. */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: uuid */
+                        connection_id: string;
+                        started: boolean;
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+            /** @description The read could not be started (Temporal unreachable); try again. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: uuid */
+                        connection_id: string;
+                        started: boolean;
+                    };
+                };
+            };
+        };
+    };
     getAdsInsights: {
         parameters: {
             query?: never;

package/package.json

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