@getlatedev/node 0.2.1349 → 0.2.1351

package/src/generated/types.gen.ts

@@ -659,6 +659,37 @@ export type AdAnalyticsResponse = {
     };
 };
 
+/**
+ * What the create filled in for fields the request left out. Empty when every field was sent. A passing validateOnly returns it too, so a dry run previews these values before anything is created.
+ */
+export type AdAppliedDefaults = {
+    /**
+     * Sent when `name` was omitted: `Ad <YYYY-MM-DD HH:MM:SS>` in UTC.
+     */
+    name?: string;
+    /**
+     * Sent when `goal` was omitted. `lead_generation` with a `leadGenFormId`; `app_promotion` when `promotedObject` names an app; `conversions` with `promotedObject.pixelId` and `customEventType`; `traffic` when the ad has a link (`linkUrl`, a carousel card, `creatives[].linkUrl`, `dynamicCreative.linkUrls` or a LinkedIn carousel card); otherwise `engagement`. Each only when the platform offers it, falling back to `engagement`, then `awareness`, then the platform's first goal. Never inferred with `existingCampaignId`, `smartPlus` or the LinkedIn spotlight, follower and jobs formats: those still return 400 without `goal`.
+     */
+    goal?: string;
+    /**
+     * Sent when `budgetAmount` came without `budgetType`.
+     */
+    budgetType?: 'daily';
+    /**
+     * Sent when a lifetime budget had no `endDate`: 7 days after the start. A start with an offset (or no start) gets a UTC instant; an offset-less start gets an offset-less end, read in the ad account timezone like the start; a date-only start gets the date 6 days later, which runs to 23:59:59. A daily budget never gets one and runs until paused.
+     */
+    endDate?: string;
+    /**
+     * Sent when the request sent no countries and the ad gets the long-standing United States default. Not sent on attach, Google Performance Max or Demand Gen, or a Google ad group joining `existingCampaignId`, which keep their own geo.
+     */
+    countries?: Array<(string)>;
+};
+
+/**
+ * Sent when `budgetAmount` came without `budgetType`.
+ */
+export type budgetType = 'daily';
+
 /**
  * Budget amount in the ad account's native currency (see the campaign's `currency` field for the code).
  */
@@ -1707,6 +1738,50 @@ export type AdRuleSchedule = {
  */
 export type everyMinutes = 60 | 180 | 360 | 720 | 1440;
 
+export type AdsAlert = {
+    /**
+     * Stable for the same problem on the same entity. Pass it to POST /v1/ads/alerts/{alertId}/dismiss.
+     */
+    id?: string;
+    kind?: 'ad_rejected' | 'delivery_issue' | 'payment' | 'budget_limited' | 'spend_no_results';
+    severity?: 'error' | 'warning' | 'info';
+    title?: string;
+    /**
+     * What happened, in plain words. For a rejection or delivery issue, the platform's own reason when it gave one.
+     */
+    message?: string;
+    platform?: string;
+    platformAdAccountId?: string;
+    entity?: {
+        level?: 'ad_account' | 'campaign' | 'ad_set' | 'ad';
+        /**
+         * The platform id of the entity.
+         */
+        id?: string;
+        name?: (string) | null;
+    };
+    /**
+     * The Zernio ad id when the entity is an ad, for GET /v1/ads/{adId}.
+     */
+    adId?: string;
+    currency?: (string) | null;
+    detectedAt?: string;
+    /**
+     * Where to fix it on the platform, when there is such a place.
+     */
+    fix?: {
+        label?: string;
+        url?: string;
+    };
+    dismissed?: boolean;
+};
+
+export type kind = 'ad_rejected' | 'delivery_issue' | 'payment' | 'budget_limited' | 'spend_no_results';
+
+export type severity = 'error' | 'warning' | 'info';
+
+export type level = 'ad_account' | 'campaign' | 'ad_set' | 'ad';
+
 /**
  * One ad schedule window as Google stores it. Half-open: it is exclusive of the end minute, so 09:00-12:00 and 12:00-17:00 are adjacent, not overlapping.
  */
@@ -1752,6 +1827,19 @@ export type AdsTimelineResponse = {
      * Meta only. Present and true while historical data is being backfilled.
      */
     backfillPending?: boolean;
+    /**
+     * Only with `compare=previous`. The daily rows of `previousRange`, in the same shape as `rows`.
+     */
+    previousRows?: Array<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Only with `compare=previous`. The period of the same length that ends the day before `fromDate`.
+     */
+    previousRange?: {
+        fromDate?: string;
+        toDate?: string;
+    };
     rows?: Array<{
         date?: string;
         /**
@@ -1892,6 +1980,10 @@ export type AdTreeAdSet = {
         pacing?: string;
     } | null;
     metrics?: AdMetrics;
+    /**
+     * Only with `compare=previous`. The same metrics over `previousRange`.
+     */
+    previousMetrics?: (AdMetrics);
     /**
      * What the delivery system optimizes for. Meta ad set optimization goal (e.g. OFFSITE_CONVERSIONS, VALUE, LEAD_GENERATION), or on LinkedIn the campaign's effective optimizationTargetType (NONE means manual bidding). See the `optimizationGoal` field on `Ad` for the full value spaces.
      */
@@ -2001,6 +2093,10 @@ export type AdTreeCampaign = {
      */
     currency?: (string) | null;
     metrics?: AdMetrics;
+    /**
+     * Only with `compare=previous`. The same metrics over `previousRange`.
+     */
+    previousMetrics?: (AdMetrics);
     platformAdAccountId?: string;
     /**
      * Human-readable advertiser/account name from the platform. Refreshed on every sync.
@@ -2057,6 +2153,17 @@ export type AdTreeCampaign = {
 export type AdTreeResponse = {
     campaigns?: Array<AdTreeCampaign>;
     pagination?: Pagination;
+    /**
+     * When the most recently synced ad on this page was last read from the platform. Null before the first sync.
+     */
+    syncedAt?: (string) | null;
+    /**
+     * Only with `compare=previous`. The range `previousMetrics` covers.
+     */
+    previousRange?: {
+        fromDate?: string;
+        toDate?: string;
+    };
     /**
      * Meta only. Present and true while historical data is being backfilled.
      */
@@ -6106,7 +6213,7 @@ export type CtwaAdRequestBody = {
 /**
  * Required unless `adSetId` is set or `existingCampaignId` names a campaign with a campaign budget. `lifetime` requires `endDate`.
  */
-export type budgetType = 'daily' | 'lifetime';
+export type budgetType2 = 'daily' | 'lifetime';
 
 /**
  * Restrict the audience by gender (Meta `genders`). Omit or send all for everyone; all is ignored in adSetId attach mode. Stored on the ad and read back in `targeting.gender`.
@@ -8050,7 +8157,7 @@ export type GoogleListingGroupDimension = {
     };
 };
 
-export type level = 'LEVEL1' | 'LEVEL2' | 'LEVEL3' | 'LEVEL4' | 'LEVEL5';
+export type level2 = 'LEVEL1' | 'LEVEL2' | 'LEVEL3' | 'LEVEL4' | 'LEVEL5';
 
 export type condition = 'NEW' | 'REFURBISHED' | 'USED';
 
@@ -8536,7 +8643,7 @@ export type ImessageSenderLifecycle = {
     createdAt?: string;
 };
 
-export type kind = 'phone' | 'email';
+export type kind2 = 'phone' | 'email';
 
 export type region = 'US' | 'GB';
 
@@ -9463,7 +9570,7 @@ export type InstagramVideoFallback = {
     };
 };
 
-export type kind2 = 'instagram_video_reuploaded' | 'instagram_video_rehosted_copy';
+export type kind3 = 'instagram_video_reuploaded' | 'instagram_video_rehosted_copy';
 
 /**
  * A Google Search keyword: a bare string (BROAD match), or an object naming the match type.
@@ -13354,7 +13461,7 @@ export type platform14 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | '
 /**
  * Platform-native flavor of the tag (Meta: `pixel`).
  */
-export type kind3 = 'pixel' | 'tag' | 'insight_tag';
+export type kind4 = 'pixel' | 'tag' | 'insight_tag';
 
 /**
  * One health check the platform runs on a tracking tag.
@@ -14715,7 +14822,7 @@ export type event7 = 'ad.delivery_issue';
 /**
  * Always `AD`.
  */
-export type level2 = 'AD';
+export type level3 = 'AD';
 
 /**
  * Webhook payload for the `ad.review.approved` and `ad.review.rejected` events.
@@ -14923,7 +15030,7 @@ export type event9 = 'ad_rule.triggered';
 /**
  * Whether the rule evaluates campaigns or ad sets.
  */
-export type level3 = 'campaign' | 'adset';
+export type level4 = 'campaign' | 'adset';
 
 /**
  * Webhook payload for the `ad.status_changed` event. Currently emitted
@@ -15055,7 +15162,7 @@ export type event10 = 'ad.status_changed';
 /**
  * Hierarchy level the status applies to. Mirrors Meta's `level`. Creative-level events are not forwarded.
  */
-export type level4 = 'CAMPAIGN' | 'AD_SET' | 'AD';
+export type level5 = 'CAMPAIGN' | 'AD_SET' | 'AD';
 
 /**
  * Webhook payload for the `ad.video.processed` event. Fires once per
@@ -15494,7 +15601,7 @@ export type event18 = 'campaign.budget.depleted';
 /**
  * Always `CAMPAIGN`.
  */
-export type level5 = 'CAMPAIGN';
+export type level6 = 'CAMPAIGN';
 
 /**
  * Webhook payload for comment received events (Instagram, Facebook, Threads, YouTube, LinkedIn, Bluesky, Reddit, TikTok). X/Twitter does NOT fire this event. TikTok events carry only the author id: the comment.update webhook has no username, picture or owner flag.
@@ -46429,6 +46536,10 @@ export type GetAdTreeData = {
          * Restrict the tree to one or more campaigns by platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Comma-separate up to 100 ids (`?campaignId=123,456`). Filters the campaign set itself, so it works regardless of account size and pagination. Pass this when you already hold campaign ids (for example from an `ad.status_changed` webhook) instead of paging the whole tree.
          */
         campaignId?: string;
+        /**
+         * Set to `previous` to also read the period of the same length that ends the day before `fromDate`. Every campaign, ad set and ad gains `previousMetrics` (same fields as `metrics`) and the response gains `previousRange`, so a table can show the change against the previous period in one call.
+         */
+        compare?: 'previous';
         /**
          * Which tree levels get the `daily[]` series when `timeIncrement=1`. `campaign` (default) attaches it on campaign nodes only: the common per-campaign-trend case, and the smallest payload. `adset` adds it on ad sets too; `ad` adds it on every ad in `ads[]` as well (heaviest: a long range × up to 100 ads per ad set). Scope with `campaignId` to keep `ad`-level responses small. Ignored when `timeIncrement` is unset.
          */
@@ -46512,6 +46623,10 @@ export type GetAdsTimelineData = {
          * Optional platform-native ad account ID (e.g. Meta `act_…`, TikTok advertiser ID). Use when the connection wraps multiple platform ad accounts and the chart should show one only. Note: rows ingested before 2026-05-13 don't carry this column; the recurring 7-day re-sync repopulates them naturally.
          */
         adAccountId?: string;
+        /**
+         * Set to `previous` to also return `previousRows` for the period of the same length that ends the day before `fromDate`, with that period as `previousRange`. Needs a `fromDate` (sent or defaulted); `toDate` alone answers 400.
+         */
+        compare?: 'previous';
         /**
          * Inclusive start of metrics range (YYYY-MM-DD). Defaults to 90 days ago.
          */
@@ -48270,6 +48385,50 @@ export type ListAdsBusinessCentersResponse = ({
 
 export type ListAdsBusinessCentersError = (ErrorResponse | unknown);
 
+export type ListAdsAlertsData = {
+    query?: {
+        /**
+         * Only alerts of this ads connection (sibling-expanded like /v1/ads/tree). Omit for every ad account the API key can reach.
+         */
+        accountId?: string;
+        /**
+         * Also return dismissed alerts, with `dismissed: true`.
+         */
+        includeDismissed?: boolean;
+    };
+};
+
+export type ListAdsAlertsResponse = ({
+    alerts?: Array<AdsAlert>;
+    /**
+     * Open (not dismissed) alerts per severity.
+     */
+    counts?: {
+        error?: number;
+        warning?: number;
+        info?: number;
+    };
+});
+
+export type ListAdsAlertsError = (ErrorResponse | unknown);
+
+export type DismissAdsAlertData = {
+    path: {
+        /**
+         * The `id` of an alert from GET /v1/ads/alerts.
+         */
+        alertId: string;
+    };
+};
+
+export type DismissAdsAlertResponse = ({
+    id?: string;
+    dismissed?: boolean;
+    dismissedUntil?: string;
+});
+
+export type DismissAdsAlertError = (ErrorResponse | unknown);
+
 export type GetAdsActivityLogData = {
     query: {
         /**
@@ -52281,7 +52440,10 @@ export type CreateStandaloneAdData = {
     body: {
         accountId: string;
         adAccountId: string;
-        name: string;
+        /**
+         * Omitted, the ad is named `Ad <YYYY-MM-DD HH:MM:SS>` (UTC) and the response reports it in `appliedDefaults.name`.
+         */
+        name?: string;
         /**
          * Meta, Reddit and Google. Exact campaign name. Overrides the default `<name> - Campaign`. Ignored when the request joins an existing campaign or ad set. Google: no line breaks and at most 255 characters, checked before calling Google; names are unique in the Google Ads account, and on Search and Display a taken name is a 400 naming this field.
          */
@@ -52296,7 +52458,7 @@ export type CreateStandaloneAdData = {
         adName?: string;
         tracking?: AdTracking;
         /**
-         * Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
+         * Available goals vary by platform. Omitted, it is inferred from the ad (see `appliedDefaults.goal` in the response); the attach shape inherits it from the ad set.
          *
          * **Meta**
          * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion, or `customEventType: OTHER` + `customEventStr` to optimise against a pixel custom event.
@@ -52393,7 +52555,7 @@ export type CreateStandaloneAdData = {
          */
         budgetAmount?: number;
         /**
-         * Required on legacy, multi-creative and Performance Max shapes. Inherited on attach. OpenAI Ads accepts both as the campaign's single spend cap. A lifetime cap can later switch to daily with PUT /v1/ads/campaigns/{campaignId}, but OpenAI never switches a daily cap back to lifetime (422). Automatic bidding (Maximize Results) needs a daily budget. Reddit Ads: the ad group's daily or lifetime spend goal; lifetime needs `endDate`.
+         * Defaults to daily when `budgetAmount` is sent without it (reported in `appliedDefaults.budgetType`). Inherited on attach. OpenAI Ads accepts both as the campaign's single spend cap. A lifetime cap can later switch to daily with PUT /v1/ads/campaigns/{campaignId}, but OpenAI never switches a daily cap back to lifetime (422). Automatic bidding (Maximize Results) needs a daily budget. Reddit Ads: the ad group's daily or lifetime spend goal.
          */
         budgetType?: 'daily' | 'lifetime';
         /**
@@ -52920,7 +53082,7 @@ export type CreateStandaloneAdData = {
             [key: string]: (string | number);
         };
         /**
-         * Required for lifetime budgets. Read like `startDate` (account timezone on Meta, TikTok, X, Pinterest, OpenAI and Reddit; whole account-local days on Google; UTC on LinkedIn), and a date-only end runs to 23:59:59 local.
+         * Omitted on a lifetime budget, the ad ends 7 days after it starts (reported in `appliedDefaults.endDate`); a daily budget without one runs until paused. Read like `startDate` (account timezone on Meta, TikTok, X, Pinterest, OpenAI and Reddit; whole account-local days on Google; UTC on LinkedIn), and a date-only end runs to 23:59:59 local.
          */
         endDate?: string;
         /**
@@ -53448,7 +53610,7 @@ export type CreateStandaloneAdData = {
          * Targeting works like on any TikTok ad (defaults to `countries: ["US"]` when
          * omitted); TikTok automates delivery within it.
          * The budget lives on the Smart+ campaign (Campaign Budget Optimization); a `lifetime`
-         * budget additionally requires `endDate`. Cannot be combined with `adSetId`.
+         * budget without `endDate` ends 7 days after it starts. Smart+ needs `goal` sent, it is never inferred. Cannot be combined with `adSetId`.
          *
          */
         smartPlus?: boolean;
@@ -53483,6 +53645,7 @@ export type CreateStandaloneAdResponse = ({
      * Always true in a validate-only response.
      */
     validateOnly?: boolean;
+    appliedDefaults?: AdAppliedDefaults;
     results?: Array<{
         node?: 'campaign' | 'adSet' | 'creative' | 'ad' | 'performanceMaxCampaign';
         status?: 'validated' | 'skipped' | 'unverified';
@@ -53494,11 +53657,13 @@ export type CreateStandaloneAdResponse = ({
     message?: string;
 } | ({
     ad?: Ad;
+    appliedDefaults?: AdAppliedDefaults;
     message?: string;
 } | {
     ads?: Array<Ad>;
     platformCampaignId?: string;
     platformAdSetId?: string;
+    appliedDefaults?: AdAppliedDefaults;
     message?: string;
 }));