@getlatedev/node 0.2.1333 → 0.2.1335

package/src/generated/types.gen.ts

@@ -516,6 +516,7 @@ export type Ad = {
          * Explicit E.164 WhatsApp number supplied when creating a Meta boost or messaging ad. Absent when omitted by the caller or on older records.
          */
         whatsappPhoneNumber?: string;
+        instagramVideoFallback?: InstagramVideoFallback;
         pinterestImageUrl?: string;
         pinterestTitle?: string;
         pinterestDescription?: string;
@@ -7459,6 +7460,91 @@ export type GoogleAdsUserInvitationApproval = {
     createdAt?: (string) | null;
 };
 
+/**
+ * Google Analytics Data API report, passed through as Google returns it. Every value in `rows` is a string; read `metricHeaders[].type` to parse metrics.
+ */
+export type GoogleAnalyticsReport = {
+    /**
+     * Zernio account ID of the Google Analytics connection.
+     */
+    accountId?: string;
+    /**
+     * Numeric GA4 property ID.
+     */
+    propertyId?: string;
+    dimensionHeaders?: Array<{
+        name?: string;
+    }>;
+    metricHeaders?: Array<{
+        name?: string;
+        /**
+         * Google metric type, e.g. TYPE_INTEGER, TYPE_FLOAT, TYPE_SECONDS, TYPE_CURRENCY.
+         */
+        type?: string;
+    }>;
+    rows?: Array<{
+        dimensionValues?: Array<{
+            value?: string;
+        }>;
+        metricValues?: Array<{
+            value?: string;
+        }>;
+    }>;
+    /**
+     * Total rows matching the request, across all pages.
+     */
+    rowCount?: number;
+    /**
+     * Google report metadata (currency, time zone, sampling and thresholding flags).
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Google quota left on this property after the request (tokens per day and per hour, concurrent requests). Cached responses carry the quota from when they were fetched.
+     */
+    propertyQuota?: {
+        [key: string]: unknown;
+    };
+};
+
+export type GoogleAnalyticsReportFields = {
+    /**
+     * Zernio account ID of the Google Analytics connection (platform `googleanalytics`).
+     */
+    accountId: string;
+    /**
+     * GA4 dimension API names, e.g. `date`, `sessionSource`, `pagePath`. List them with GET /v1/analytics/googleanalytics/metadata.
+     */
+    dimensions?: Array<(string)>;
+    /**
+     * GA4 metric API names, e.g. `sessions`, `activeUsers`, `keyEvents`, `totalRevenue`.
+     */
+    metrics: Array<(string)>;
+    /**
+     * A Google FilterExpression on dimensions, in Google's own shape.
+     */
+    dimensionFilter?: {
+        [key: string]: unknown;
+    };
+    /**
+     * A Google FilterExpression on metrics, in Google's own shape.
+     */
+    metricFilter?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Google OrderBy objects, e.g. `{ "metric": { "metricName": "sessions" }, "desc": true }`.
+     */
+    orderBys?: Array<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Rows to return. Defaults to Google's default (10000).
+     */
+    limit?: number;
+};
+
 /**
  * Link one asset to the asset group. Send exactly one of asset (an existing asset), text, imageUrl or youtubeVideoId (new content, created in the same request).
  */
@@ -9308,6 +9394,32 @@ export type InstagramTaggedMedia = {
     commentsCount: (number) | null;
 };
 
+/**
+ * Meta only. Present when Meta refused an existing Instagram video as the boosted ad (code 100, subcode 1815279: upload it to Facebook first) and Zernio created the ad another way. `instagram_video_reuploaded`: the video was copied into the ad account and the ad still references the original post. `instagram_video_rehosted_copy`: the video was uploaded as a new Facebook video in a new Page post, so the ad does not show the original post's likes and comments. Send `rehostOnInstagramVideoRejection: false` on the boost to get Meta's error instead.
+ */
+export type InstagramVideoFallback = {
+    kind: 'instagram_video_reuploaded' | 'instagram_video_rehosted_copy';
+    /**
+     * True when the ad still references the original Instagram post and keeps its engagement.
+     */
+    linkedToOriginalPost: boolean;
+    /**
+     * The Facebook-side ad video Zernio made. With instagram_video_reuploaded it is the copy in the ad account video library (possibly one made by an earlier boost of the same media, reused); the creative carries it as video_id unless Meta accepted the plain post reference once the copy existed, in which case the copy is kept for that reference. With instagram_video_rehosted_copy it is the new upload the creative uses (an unused copy made by this request is deleted).
+     */
+    videoId: string;
+    /**
+     * Meta's original refusal.
+     */
+    platformError: {
+        code?: number;
+        subcode?: number;
+        message: string;
+        fbtraceId?: string;
+    };
+};
+
+export type kind2 = 'instagram_video_reuploaded' | 'instagram_video_rehosted_copy';
+
 /**
  * A Google Search keyword: a bare string (BROAD match), or an object naming the match type.
  */
@@ -12195,7 +12307,7 @@ export type contentType3 = 'story' | 'saved_story' | 'spotlight';
 
 export type SocialAccount = {
     _id: string;
-    platform: 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'wix' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'sms' | 'phone' | 'rcs' | 'whopads' | 'hubspot' | 'webflow';
+    platform: 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'wix' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'sms' | 'phone' | 'rcs' | 'whopads' | 'hubspot' | 'webflow' | 'googleanalytics';
     profileId: (string | Profile);
     username?: string;
     displayName?: string;
@@ -12305,7 +12417,7 @@ export type SocialAccount = {
     };
 };
 
-export type platform13 = 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'wix' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'sms' | 'phone' | 'rcs' | 'whopads' | 'hubspot' | 'webflow';
+export type platform13 = 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'wix' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'sms' | 'phone' | 'rcs' | 'whopads' | 'hubspot' | 'webflow' | 'googleanalytics';
 
 /**
  * TikTok accounts only. The account type TikTok reported when the account was connected. `personal` accounts cannot use TikTok direct messages through the API (TikTok limits Business Messaging to Business Accounts): skip the inbox for them and tell the user to switch to a Business Account in the TikTok app, then reconnect. `business` is the prerequisite, not a guarantee; messaging also needs the messaging scopes granted and TikTok's regional availability. `unknown` on accounts connected before this was captured or whose grant left out the account-type scope.
@@ -13167,7 +13279,7 @@ export type platform14 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | '
 /**
  * Platform-native flavor of the tag (Meta: `pixel`).
  */
-export type kind2 = 'pixel' | 'tag' | 'insight_tag';
+export type kind3 = 'pixel' | 'tag' | 'insight_tag';
 
 /**
  * One health check the platform runs on a tracking tag.
@@ -20278,6 +20390,89 @@ export type GetPostTimelineError = ({
     code?: string;
 });
 
+export type RunGoogleAnalyticsReportData = {
+    body: (GoogleAnalyticsReportFields & {
+    /**
+     * Defaults to the last 28 days (`28daysAgo` to `yesterday`).
+     */
+    dateRanges?: Array<{
+        /**
+         * YYYY-MM-DD, today, yesterday or NdaysAgo.
+         */
+        startDate: string;
+        /**
+         * YYYY-MM-DD, today, yesterday or NdaysAgo.
+         */
+        endDate: string;
+        name?: string;
+    }>;
+    /**
+     * Row offset for paging through a report larger than `limit`.
+     */
+    offset?: number;
+    keepEmptyRows?: boolean;
+    /**
+     * ISO 4217 code for currency metrics. Defaults to the property currency.
+     */
+    currencyCode?: string;
+});
+};
+
+export type RunGoogleAnalyticsReportResponse = (GoogleAnalyticsReport);
+
+export type RunGoogleAnalyticsReportError = (ErrorResponse | unknown | {
+    error?: string;
+});
+
+export type RunGoogleAnalyticsRealtimeReportData = {
+    body: (GoogleAnalyticsReportFields & {
+    minuteRanges?: Array<{
+        startMinutesAgo?: number;
+        endMinutesAgo?: number;
+        name?: string;
+    }>;
+});
+};
+
+export type RunGoogleAnalyticsRealtimeReportResponse = (GoogleAnalyticsReport);
+
+export type RunGoogleAnalyticsRealtimeReportError = (ErrorResponse | unknown | {
+    error?: string;
+});
+
+export type GetGoogleAnalyticsMetadataData = {
+    query: {
+        /**
+         * Zernio account ID of the Google Analytics connection.
+         */
+        accountId: string;
+    };
+};
+
+export type GetGoogleAnalyticsMetadataResponse = ({
+    accountId?: string;
+    propertyId?: string;
+    dimensions?: Array<{
+        apiName?: string;
+        uiName?: string;
+        description?: string;
+        category?: string;
+        customDefinition?: boolean;
+    }>;
+    metrics?: Array<{
+        apiName?: string;
+        uiName?: string;
+        description?: string;
+        type?: string;
+        category?: string;
+        customDefinition?: boolean;
+    }>;
+});
+
+export type GetGoogleAnalyticsMetadataError = (ErrorResponse | unknown | {
+    error?: string;
+});
+
 export type GetGoogleBusinessPerformanceData = {
     query: {
         /**
@@ -21927,9 +22122,9 @@ export type DeleteProfileError = (unknown | ErrorResponse | {
 export type ListAccountsData = {
     query?: {
         /**
-         * Only accounts of this kind. ads = ad accounts (Meta, Google, LinkedIn, Pinterest, TikTok, X, OpenAI, Reddit), communication = WhatsApp, Telegram, Discord, Slack and iMessage, blogs = Shopify and WordPress, crm = HubSpot, social = every other platform.
+         * Only accounts of this kind. ads = ad accounts (Meta, Google, LinkedIn, Pinterest, TikTok, X, OpenAI, Reddit), communication = WhatsApp, Telegram, Discord, Slack and iMessage, blogs = Shopify and WordPress, crm = HubSpot, analytics = Google Analytics, social = every other platform.
          */
-        category?: 'social' | 'ads' | 'communication' | 'blogs' | 'crm';
+        category?: 'social' | 'ads' | 'communication' | 'blogs' | 'crm' | 'analytics';
         /**
          * Opaque cursor from a previous response's `pagination.nextCursor`; returns the next page of `limit` accounts (500 when limit is omitted). A cursor we cannot parse returns 400. Cannot be combined with page.
          */
@@ -22147,7 +22342,7 @@ export type GetAllAccountsHealthData = {
         /**
          * Filter by platform
          */
-        platform?: 'facebook' | 'instagram' | 'linkedin' | 'twitter' | 'tiktok' | 'youtube' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'wix' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'whopads' | 'hubspot' | 'webflow';
+        platform?: 'facebook' | 'instagram' | 'linkedin' | 'twitter' | 'tiktok' | 'youtube' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'wix' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'whopads' | 'hubspot' | 'webflow' | 'googleanalytics';
         /**
          * Filter by profile ID
          */
@@ -23761,6 +23956,91 @@ export type ConnectShopifyWithTokenError = (unknown | ErrorResponse | {
     };
 });
 
+export type GetGoogleAnalyticsConnectUrlData = {
+    query: {
+        /**
+         * Your Zernio profile ID (get from /v1/profiles).
+         */
+        profileId: string;
+        /**
+         * Zernio account ID of the Google Analytics account being reconnected. Picking a different property then fails instead of adding a second account.
+         */
+        reconnectAccountId?: string;
+        /**
+         * Custom redirect after connection. Must be an absolute http(s) URL or custom app scheme such as `myapp://callback`; relative and unsafe URLs return 400.
+         */
+        redirect_url?: string;
+    };
+};
+
+export type GetGoogleAnalyticsConnectUrlResponse = ({
+    /**
+     * Google URL to open in the user agent.
+     */
+    authUrl: string;
+    /**
+     * Authenticated, expiring OAuth state handled by the callback.
+     */
+    state: string;
+});
+
+export type GetGoogleAnalyticsConnectUrlError = (ErrorResponse | {
+    /**
+     * Human-readable error message suitable for end-user display.
+     */
+    error: string;
+    /**
+     * Machine-readable error code. Stable across versions.
+     */
+    code: 'PAYMENT_REQUIRED';
+    /**
+     * Discriminator for which gate fired.
+     */
+    reason: 'free_tier_exceeded' | 'twitter_passthrough' | 'enterprise_required' | 'card_verification_required';
+    /**
+     * Link to the relevant documentation page.
+     */
+    documentation_url?: string;
+    /**
+     * Deep-link to send the end-user to. For
+     * `free_tier_exceeded` and `twitter_passthrough` this opens
+     * the add-payment-method drawer on the Zernio billing page.
+     * For `enterprise_required` this is the Zernio enterprise
+     * contact page.
+     *
+     */
+    dashboard_url?: string;
+    /**
+     * Structured context for SDK clients that want to render their own UX. Keys vary by `reason`.
+     */
+    details?: {
+        /**
+         * How many accounts the free tier allows. Only set when reason=free_tier_exceeded.
+         */
+        free_tier_account_limit?: number;
+        /**
+         * How many accounts the team currently has connected. Set when reason=free_tier_exceeded or reason=enterprise_required.
+         */
+        current_account_count?: number;
+        /**
+         * Whether the team currently has a card on file in Stripe. Set when reason=free_tier_exceeded or reason=twitter_passthrough.
+         */
+        has_payment_method?: boolean;
+        /**
+         * One-time card verification charge in USD cents, credited to usage. Only set when reason=card_verification_required.
+         */
+        verification_amount_cents?: number;
+        /**
+         * The negotiated connected-account cap from the
+         * team's enterprise contract. Self-service teams
+         * have no cap and never receive this reason. Only
+         * set when reason=enterprise_required.
+         *
+         */
+        effective_account_limit?: number;
+    };
+} | unknown);
+
 export type GetHubSpotConnectUrlData = {
     query: {
         /**
@@ -51501,6 +51781,10 @@ export type BoostPostData = {
          * Meta only. Extra primary-text options Meta rotates on the boosted post (asset_feed_spec.bodies with DEGREES_OF_FREEDOM); the post keeps its own text as one of the options. Works for Facebook posts and Instagram media. Under a conversions or traffic goal Meta also wants a website URL on the options, taken from `linkUrl` (send it with a `callToAction`); engagement boosts need none.
          */
         bodies?: Array<(string)>;
+        /**
+         * Meta only (a 400 elsewhere). When Meta refuses an existing Instagram video as the ad (subcode 1815279), Zernio first copies the video into the ad account and retries on the original post, then falls back to a new Facebook video in a new Page post that does not show the original post's likes and comments; the response reports which in `instagramVideoFallback`. Messaging boosts never use the unlinked copy. `false` skips every fallback and returns Meta's error.
+         */
+        rehostOnInstagramVideoRejection?: boolean;
         /**
          * TikTok only (a 400 elsewhere). TikTok Smart Targeting on the ad group: `audience` is
          * TikTok's `smart_audience_enabled`, `interestsBehaviors` its `smart_interest_behavior_enabled`.
@@ -51564,6 +51848,11 @@ export type BoostPostData = {
 export type BoostPostResponse = ({
     ad?: Ad;
     message?: string;
+    instagramVideoFallback?: InstagramVideoFallback;
+    /**
+     * Present with instagramVideoFallback: one human-readable line saying how the Instagram video was boosted.
+     */
+    warnings?: Array<(string)>;
 });
 
 export type BoostPostError = (unknown | ErrorResponse);