@zinn-digital/sdk 0.1.1395 → 0.1.1398

package/dist/generated/schema.d.ts

@@ -18740,6 +18740,78 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/ads/connections/{connection_id}/prospecting": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                connection_id: string;
+            };
+            cookie?: never;
+        };
+        /**
+         * The Prospecting template's choices - business types, starter negatives, budget (za-158).
+         * @description Gated on `ads.view`. On the caller's own connection. The intents (category, problem, paid-competitor alternative, brand), the match types every keyword starts on (EXACT and PHRASE), each business type with its starter negatives and whether it is paid by default, the Recommended daily budget (five whole units of the account currency, also the floor) and how many prospecting templates wait for approval (docs/1006 §93). Read from stored rows, never a network call in the request.
+         */
+        get: operations["getAdsProspecting"];
+        put?: never;
+        /**
+         * Start building a Prospecting campaign preview from intent groups (za-158).
+         * @description Gated on `ads.manage`. Validates the template and its gates from stored rows, then STARTS the preview workflow and answers 202 with its `preview_id`; the account read (collision replay), the ONE batched translation and the ONE batched AI-writer request run in that workflow, never in the request. Poll `getAdsProspectingPreview`. The same input the same day is the same preview (a running or built one is not started again). The preview is one new Search campaign: a `category` group, a `problem` group, one `<Rival> alternative` group per PAID competitor (a free host is skipped, `notPaidCompetitor`; all are skipped without the competitor switch and plan, `competitorsOff`) and a `brand` group, every keyword on EXACT and PHRASE. The business type's starter negatives, plus the free-seeker class when `paid` is true; every negative passes the collision replay over the account's keywords and searches and the template's own keywords, and one that would block any of them is `dropped` with its reasons. Each group's ad names its topic and must reach GOOD (`waiting`, `adBelowGood` otherwise); the whole request passes the ad-quality gate (`status: refused`, `refused`). Refusals: `prospectingInvalid` (with the field), `killed`, `notInGoodStanding`, `needsReconnect`, `prospectingUnavailable`.
+         */
+        post: operations["buildAdsProspecting"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/ads/connections/{connection_id}/prospecting/{preview_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                connection_id: string;
+                preview_id: string;
+            };
+            cookie?: never;
+        };
+        /**
+         * One Prospecting preview - building, ready with the plan, failed or expired (za-158).
+         * @description Gated on `ads.view`. On the caller's own connection. `building` while the workflow runs, `ready` with the plan, `failed` with the refusal (`error.code`, as for `buildAdsProspecting`), `expired` once the run is no longer kept or finished more than a day ago (its account read is stale: build it again).
+         */
+        get: operations["getAdsProspectingPreview"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/ads/connections/{connection_id}/prospecting/{preview_id}/propose": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                connection_id: string;
+                preview_id: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Queue a ready Prospecting preview as ONE approve-first change (za-158).
+         * @description Gated on `ads.manage`. Fast: nothing is rebuilt. The gates (kill switch, good standing, campaign changes on) and the ad-quality gate run again on the preview's stored request, then it is queued as ONE pending change (`listAdsChanges`; audit action `ads.prospecting_propose`); proposing the same preview twice is the same pending change, and once that change is approved or applied it is that change again (never a second campaign). Nothing is sent to Google here: the metered gate runs when a person approves it. Refusals: `prospectingInvalid` (field `preview_id`: not ready), `killed`, `notInGoodStanding`, `needsReconnect`, `prospectingUnavailable`.
+         */
+        post: operations["proposeAdsProspecting"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/ads/connections/{connection_id}/quality-score": {
         parameters: {
             query?: never;
@@ -64236,6 +64308,100 @@ export interface components {
             /** @description true = the provider reports its own fee (Paddle, Freemius); the estimate is not used. */
             readonly reports_fee?: boolean;
         };
+        AdsProspectingInfoEnvelope: {
+            data: {
+                business_type: string;
+                business_types: {
+                    paid_by_default: boolean;
+                    starter_negatives: string[];
+                    value: string;
+                }[];
+                currency: string;
+                intents: ("category" | "problem" | "alternative" | "brand")[];
+                matches: ("EXACT" | "PHRASE")[];
+                pending: number;
+                recommended_budget_minor: number;
+            };
+        };
+        AdsProspectingPlan: {
+            business_type: string;
+            campaign: {
+                country: string;
+                currency: string;
+                daily_budget_minor: number;
+                final_url: string;
+                language: string;
+                name: string;
+                recommended_budget_minor: number;
+            };
+            change_id: string | null;
+            free_seeker: boolean;
+            groups: {
+                descriptions?: string[];
+                headlines?: string[];
+                /** @enum {string} */
+                intent: "category" | "problem" | "alternative" | "brand";
+                keywords: {
+                    /** @enum {string} */
+                    match: "EXACT" | "PHRASE";
+                    text: string;
+                }[];
+                name: string;
+                reason: string;
+                rival?: string;
+                /** @enum {string} */
+                status: "ready" | "waiting" | "skipped";
+            }[];
+            negatives: {
+                /** @enum {string} */
+                class: "starter" | "free_seeker";
+                /** @enum {string} */
+                match: "EXACT" | "PHRASE";
+                reasons: string[];
+                /** @enum {string} */
+                status: "kept" | "dropped";
+                text: string;
+            }[];
+            paid: boolean;
+            refused: {
+                [key: string]: unknown;
+            } | null;
+            /** @enum {string} */
+            status: "preview" | "proposed" | "refused" | "nothingReady" | "rejectedBefore";
+        };
+        AdsProspectingPreviewEnvelope: {
+            data: {
+                error: {
+                    code: string;
+                    field: string;
+                } | null;
+                plan: components["schemas"]["AdsProspectingPlan"] | null;
+                preview_id: string;
+                /** @enum {string} */
+                status: "building" | "ready" | "failed" | "expired";
+            };
+        };
+        AdsProspectingRequest: {
+            brand: string;
+            brand_terms?: string[];
+            /** @enum {string} */
+            business_type?: "free_trial" | "freemium" | "lead_gen" | "ecommerce" | "local" | "b2b";
+            category: string[];
+            competitors?: string[];
+            /** @description ISO 3166-1 alpha-2. */
+            country: string;
+            /** @description Minor units of the account currency; null = Recommended (five whole units, also the floor). */
+            daily_budget_minor?: number | null;
+            descriptions?: string[];
+            /** Format: uri */
+            final_url: string;
+            headlines?: string[];
+            /** @default en */
+            language: string;
+            /** @description null = the business type's default (freemium is not paid). */
+            paid?: boolean | null;
+            problems?: string[];
+        };
         AdsQsDiagnosis: {
             ad_group: string;
             /** @description BELOW_AVERAGE, AVERAGE, ABOVE_AVERAGE or empty. */
@@ -139843,6 +140009,119 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    getAdsProspecting: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                connection_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The template's choices. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsProspectingInfoEnvelope"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    buildAdsProspecting: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                connection_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AdsProspectingRequest"];
+            };
+        };
+        responses: {
+            /** @description The preview is being built; poll it by `preview_id`. */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsProspectingPreviewEnvelope"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    getAdsProspectingPreview: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                connection_id: string;
+                preview_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The preview. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsProspectingPreviewEnvelope"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    proposeAdsProspecting: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                connection_id: string;
+                preview_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The plan with `status` `proposed` and its `change_id`, or `refused`. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsProspectingPreviewEnvelope"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
     getAdsQualityScore: {
         parameters: {
             query?: never;
@@ -160187,7 +160466,10 @@ export interface operations {
     };
     getDomainPremiumDns: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description The language the app is rendering in (a BCP 47 tag such as `ar` or `pt-PT`). A supported value is the language the offered extra's `name` and `description` are served in; an absent or unsupported one falls back to the caller's stored language preference. Never read from `Accept-Language`. */
+                locale?: string;
+            };
             header?: never;
             path: {
                 /** @description The domain's id. */

package/package.json

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