@zinn-digital/sdk 0.1.1391 → 0.1.1394

package/dist/generated/schema.d.ts

@@ -16959,6 +16959,33 @@ export interface paths {
         patch: operations["updateAdsAudience"];
         trace?: never;
     };
+    "/v1/ads/connections/{connection_id}/audiences/{audience_id}/crm-feed": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                audience_id: string;
+                connection_id: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Fill a Customer Match list automatically from one of your CRM sources.
+         * @description za-95 (docs/1006 §72a). Gated on `ads.manage`; audit action `ads.audience_crm_feed_set` (counts and the attestation, never a person). Any change to the attestation re-stamps who and when; withdrawing either consent removes everyone at the next sync; changing the stages or the source re-reads the CRM from the start. Refusals: `audienceHasUploads` (the list holds uploaded people), `crmFeedBadSource`, `crmFeedBadStages`, `audienceDeleted`, `disconnected`.
+         */
+        put: operations["setAdsAudienceCrmFeed"];
+        post?: never;
+        /**
+         * Stop filling a list from the CRM; everyone it added is removed.
+         * @description za-95. Gated on `ads.manage`; audit action `ads.audience_crm_feed_removed`. The list stays and can take uploads again.
+         */
+        delete: operations["removeAdsAudienceCrmFeed"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/ads/connections/{connection_id}/audiences/{audience_id}/members": {
         parameters: {
             query?: never;
@@ -20050,6 +20077,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/ads/social": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The social-network autopilot on this org's X and Meta accounts.
+         * @description Gated on `ads.view`. Read from our own rows (no network call). Per X and Meta account: `levers` says what the autopilot judges there (`audiences` and `creatives` are judged by the scheduled audit; Meta `placements` by the placement guard and `budgets` by the cross-network budget, `elsewhere` with the screen in `where`; X offers no placement change on a running line item, `not_offered`). `review` is the latest audit: audiences (X line items, Meta ad sets) and creatives (X promoted Tweets, Meta ads) judged, the spend found wasted (`waste_micros`, micros of the account currency: spend with no conversion), what was proposed or applied and `findings` (at most 50). A creative is stopped only while its audience keeps another creative that is not waste. `needs_permission` means Meta has not granted Zinn® Ads `ads_management`: judged, nothing proposed. `pending` counts the pauses waiting for a person (docs/1006 §121, za-55).
+         */
+        get: operations["getAdsSocial"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/ads/tracking/events": {
         parameters: {
             query?: never;
@@ -61562,8 +61609,11 @@ export interface components {
             active: boolean;
             added_last?: number;
             at_network_list?: boolean;
-            /** @enum {string|null} */
-            blocked_by: "notGoogle" | "noConsent" | "noTerms" | "noDataManager" | "paused" | "disconnected" | "killed" | "notInGoodStanding" | "needsReconnect" | "deferred" | null;
+            /**
+             * @description Why nothing is sent now. `noSourceConsent` (za-95) = the list is filled from a CRM source whose Customer Match consents (BOTH ad_user_data and ad_personalization) are not attested; the remedy is to attest both for that source on the list. A list that may not add people (`noConsent` / `noSourceConsent`) still has its removals sent: withdrawing consent or unlinking the CRM takes everyone off at the network.
+             * @enum {string|null}
+             */
+            blocked_by: "notGoogle" | "noConsent" | "noSourceConsent" | "noTerms" | "noDataManager" | "paused" | "disconnected" | "killed" | "notInGoodStanding" | "needsReconnect" | "deferred" | null;
             consent: {
                 /** @enum {string} */
                 ad_personalization?: "GRANTED" | "DENIED" | "UNSPECIFIED";
@@ -61591,6 +61641,8 @@ export interface components {
             };
             /** Format: date-time */
             created_at: string;
+            /** @description za-95 — the CRM source filling this list automatically (null = an uploaded list). */
+            crm_feed?: components["schemas"]["AdsAudienceCrmFeed"] | null;
             description?: string;
             /** Format: uuid */
             id: string;
@@ -61610,6 +61662,38 @@ export interface components {
             name: string;
             removed_last?: number;
         };
+        /** @description za-95 (docs/1006 §72a): a Customer Match list filled from one of the customer's own CRM sources. People whose lead or deal is at one of `stages` join; a person who leaves those stages, or whose CRM consent field reads a refusal, is removed. The Customer Match attestation is this source's OWN (both consents, who and when) — never the CRM source's ad-measurement `consent_attested`. Until both are attested the CRM is not read for the list. Counts only, never a person. */
+        AdsAudienceCrmFeed: {
+            attest_ad_personalization: boolean;
+            attest_ad_user_data: boolean;
+            /** @description Both attested */
+            attested: boolean;
+            /** Format: date-time */
+            attested_at: string | null;
+            attested_by: string;
+            joined: number;
+            /** Format: date-time */
+            last_fed_at: string | null;
+            leads_read: number;
+            left: number;
+            /** @description Leads at a feed stage whose CRM consent field refused. */
+            not_consented: number;
+            /** Format: uuid */
+            source_id: string;
+            stages: string[];
+        };
+        AdsAudienceCrmFeedPut: {
+            /** @description The customer attests every person in these stages consented to personalised advertising. */
+            attest_ad_personalization: boolean;
+            /** @description The customer attests every person in these stages consented to their data being sent to Google for advertising. */
+            attest_ad_user_data: boolean;
+            /**
+             * Format: uuid
+             * @description A lead or deal source on this ad account (not a calls source).
+             */
+            source_id: string;
+            stages: string[];
+        };
         /** @description One audit of one ad account (za-39: the platform-neutral audit for Microsoft Advertising; the Google audit for Google). Counts only, never vendor text. */
         AdsAuditRun: {
             /** Format: date-time */
@@ -61720,8 +61804,11 @@ export interface components {
                  * @enum {string}
                  */
                 mode: "auto" | "approve" | "off";
-                /** @enum {string} */
-                step: "negatives" | "pauses" | "keywords" | "budgets" | "bids" | "assets" | "goals";
+                /**
+                 * @description za-72 `compare_page`: a competitor ad moved onto the customer's own comparison page for its rival, under the `ads` mode.
+                 * @enum {string}
+                 */
+                step: "negatives" | "pauses" | "keywords" | "budgets" | "bids" | "assets" | "compare_page" | "goals";
             }[];
         };
         /** @description The organisation's autopilot decisions (za-166, docs/1006 §77). */
@@ -62358,6 +62445,7 @@ export interface components {
         AdsCompetitorGroupsEnvelope: {
             data: {
                 enabled: boolean;
+                found_rivals?: components["schemas"]["AdsFoundRival"][];
                 last_run: components["schemas"]["AdsCompetitorGroupsRun"] | null;
                 /** @description Proposals waiting for approval. */
                 pending: number;
@@ -62381,6 +62469,10 @@ export interface components {
             max_keywords?: number | null;
             min_clicks?: number | null;
             min_impressions?: number | null;
+            /** @description za-73: add or dismiss competitors found on the account, by name (from `found_rivals`). An unknown name or value refuses the whole request (competitorGroupsInvalid, field `rivals`). */
+            rivals?: {
+                [key: string]: "added" | "dismissed";
+            };
         };
         AdsCompetitorGroupsRun: {
             /** @description za-71: builds and blocks the Automatic mode sent. */
@@ -62391,6 +62483,8 @@ export interface components {
             blocked?: number;
             /** @description Rival + language pairs that already have a group or a decided proposal. */
             covered: number;
+            /** @description za-73: found competitors waiting for a person to add or dismiss. */
+            found_rivals?: number;
             groups: components["schemas"]["AdsCompetitorGroup"][];
             proposed: number;
             /** @description Empty when it ran; else why not (competitorsOff, notInGoodStanding, ...). */
@@ -62674,6 +62768,8 @@ export interface components {
         };
         AdsCrmSyncResult: {
             failure: string;
+            /** @description za-95: people who joined or left a CRM-fed Customer Match list (CSV uploads). */
+            list_changes?: number;
             more: boolean;
             no_click_id: number;
             not_consented: number;
@@ -62826,6 +62922,22 @@ export interface components {
              */
             option: "move" | "increase";
         };
+        /** @description za-73: a competitor this account's own searches (or a brand bidder Auction Insights named) point at, that nobody added. Added, it joins the competitor list: its ad groups are proposed and no ad may name it. Dismissed, it is never suggested again. */
+        AdsFoundRival: {
+            clicks: number;
+            /** Format: date-time */
+            decided_at?: string | null;
+            /** @description Up to three comparison searches that named it. */
+            examples: string[];
+            /** Format: date-time */
+            first_seen_at?: string | null;
+            impressions: number;
+            name: string;
+            /** @enum {string} */
+            source: "search" | "brand_bidder";
+            /** @enum {string} */
+            status: "new" | "added" | "dismissed";
+        };
         /** @description One geo hold-out (za-202, docs/1006 §80). */
         AdsGeoHoldout: {
             baseline_days: number;
@@ -65146,6 +65258,44 @@ export interface components {
             /** @description The address of the site in that language. */
             url?: string;
         };
+        AdsSocial: {
+            accounts: {
+                /** Format: uuid */
+                connection_id: string;
+                currency: string;
+                label: string;
+                levers: {
+                    /** @enum {string} */
+                    lever: "audiences" | "placements" | "creatives" | "budgets";
+                    /** @enum {string} */
+                    state: "judged" | "elsewhere" | "not_offered";
+                    where: string;
+                }[];
+                pending: number;
+                /** @enum {string} */
+                platform: "x" | "meta";
+                review: {
+                    applied: number;
+                    /** Format: date-time */
+                    at: string;
+                    audiences: number;
+                    creatives: number;
+                    findings: {
+                        clicks: number;
+                        cost_micros: number;
+                        id: string;
+                        /** @enum {string} */
+                        lever: "audiences" | "creatives";
+                        name: string;
+                    }[];
+                    held: boolean;
+                    needs_permission: boolean;
+                    ok: boolean;
+                    proposed: number;
+                    waste_micros: number;
+                } | null;
+            }[];
+        };
         /** @description za-N2 out-of-stock pause settings of one connection. Each value is the customer's own; `recommended` holds our Recommended defaults and `bounds` the accepted range (minutes). */
         AdsStockPauseSettings: {
             bounds: {
@@ -136329,6 +136479,69 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    setAdsAudienceCrmFeed: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                audience_id: string;
+                connection_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AdsAudienceCrmFeedPut"];
+            };
+        };
+        responses: {
+            /** @description The list, with its feed. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsAudience"] & {
+                        sync_started: boolean;
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    removeAdsAudienceCrmFeed: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                audience_id: string;
+                connection_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Removed; the removals are sent at the next sync. */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsAudience"] & {
+                        sync_started: boolean;
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
     uploadAdsAudienceMembers: {
         parameters: {
             query?: never;
@@ -142214,6 +142427,32 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    getAdsSocial: {
+        parameters: {
+            query?: {
+                org_id?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The social accounts and their latest review. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdsSocial"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
     listAdsTrackingEvents: {
         parameters: {
             query?: {

package/package.json

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