@getlatedev/node 0.2.1239 → 0.2.1241

package/src/generated/types.gen.ts

@@ -4666,6 +4666,169 @@ export type ConversionEvent = {
  */
 export type actionSource = 'web' | 'app' | 'offline' | 'crm' | 'phone_call' | 'system_generated';
 
+export type CreatedGoogleAdAccount = {
+    platform: 'google';
+    /**
+     * New Google Ads customer id for subsequent ads calls.
+     */
+    adAccountId: string;
+    /**
+     * Manager the account was created under.
+     */
+    managerCustomerId: string;
+    /**
+     * Whether the customer was added to the connection and discovery was scheduled. When false the account exists: reconnect Google Ads instead of creating it again.
+     */
+    connectionUpdated: boolean;
+    /**
+     * Recovery instructions if the account could not be attached to the connection.
+     */
+    warnings: Array<(string)>;
+    /**
+     * Always true. The account has no billing until it is set up in Google Ads.
+     */
+    paymentMethodRequired: boolean;
+    /**
+     * Billing setup instructions for the user.
+     */
+    nextSteps: string;
+    /**
+     * Always false on a 201.
+     */
+    validateOnly: boolean;
+};
+
+export type CreatedMetaAdAccount = {
+    /**
+     * New Meta ad account ID for subsequent ads calls.
+     */
+    adAccountId: string;
+    /**
+     * Owning business portfolio ID.
+     */
+    businessId: string;
+    /**
+     * Whether the connection scope and discovery schedule were updated.
+     */
+    connectionUpdated: boolean;
+    /**
+     * Always true as a delivery prerequisite. This is not a live funding-source check. Confirm payment or invoicing in Ads Manager.
+     */
+    paymentMethodRequired: boolean;
+    /**
+     * Open the created account in Ads Manager.
+     */
+    adsManagerUrl: string;
+    /**
+     * Payment setup instructions for the user.
+     */
+    nextSteps: string;
+    /**
+     * Recovery instructions if the account could not be attached to the connection.
+     */
+    warnings: Array<(string)>;
+};
+
+export type CreateGoogleAdAccountRequest = {
+    platform: 'google';
+    /**
+     * Zernio googleads SocialAccount ID whose Google user reaches the manager.
+     */
+    accountId: string;
+    /**
+     * Manager (MCC) customer id without dashes. The new account is created under it. List reachable managers with GET /v1/ads/accounts/hierarchy.
+     */
+    managerCustomerId: string;
+    /**
+     * Account name. Whitespace is trimmed.
+     */
+    name: string;
+    /**
+     * Uppercase ISO 4217 currency. Cannot be changed after creation.
+     */
+    currency: string;
+    /**
+     * IANA time zone name, for example Europe/Madrid. Cannot be changed after creation.
+     */
+    timeZone: string;
+    /**
+     * Ask Google to validate the request without creating the account.
+     */
+    validateOnly?: boolean;
+};
+
+export type CreateMetaAdAccountRequest = {
+    /**
+     * Optional. Omit it or send meta for a Meta ad account.
+     */
+    platform?: 'meta';
+    /**
+     * Zernio metaads SocialAccount ID.
+     */
+    accountId: string;
+    /**
+     * Business portfolio that will own the account.
+     */
+    businessId: string;
+    /**
+     * Ad account name. Whitespace is trimmed.
+     */
+    name: string;
+    /**
+     * Uppercase ISO 4217 currency supported by Meta.
+     */
+    currency: string;
+    /**
+     * Numeric Meta timezone ID from the linked timezone list. For example 1 is America/Los_Angeles.
+     */
+    timezoneId: number;
+    /**
+     * End advertiser business or page ID. NONE uses the owning business.
+     */
+    endAdvertiser?: string;
+    /**
+     * Media agency business or page ID. NONE for self-serve customers.
+     */
+    mediaAgency?: string;
+    /**
+     * Partner business or page ID. NONE for self-serve customers.
+     */
+    partner?: string;
+    /**
+     * Request Meta invoicing. Eligibility is determined by Meta.
+     */
+    invoice?: boolean;
+    /**
+     * Existing Meta invoice group ID.
+     */
+    invoiceGroupId?: string;
+    /**
+     * Addresses for Meta invoices.
+     */
+    invoicingEmails?: Array<(string)>;
+    /**
+     * Meta insertion-order invoicing option.
+     */
+    io?: boolean;
+    /**
+     * Purchase order number.
+     */
+    poNumber?: string;
+    /**
+     * Existing Meta funding reference. Does not add a payment method.
+     */
+    fundingId?: string;
+    /**
+     * Meta Business Manager creation flag.
+     */
+    adAccountCreatedFromBmFlag?: boolean;
+};
+
+/**
+ * Optional. Omit it or send meta for a Meta ad account.
+ */
+export type platform6 = 'meta';
+
 /**
  * In addition to the `required` list, the request must use
  * EXACTLY ONE of the two shapes:
@@ -7350,6 +7513,36 @@ export type GoogleTargetImpressionShare = {
 
 export type location = 'ANYWHERE_ON_PAGE' | 'TOP_OF_PAGE' | 'ABSOLUTE_TOP_OF_PAGE';
 
+export type HubSpotSettings = {
+    /**
+     * Zernio account ID of the HubSpot connection.
+     */
+    _id: string;
+    platform: 'hubspot';
+    /**
+     * HubSpot portal (hub) ID.
+     */
+    hubId: string;
+    /**
+     * HubSpot portal domain, when HubSpot reports one.
+     */
+    hubDomain: (string) | null;
+    /**
+     * OAuth scopes the portal granted.
+     */
+    scopes: Array<(string)>;
+    /**
+     * Whether Zernio creates or updates HubSpot contacts for inbox contacts.
+     */
+    syncContacts: boolean;
+    /**
+     * Whether Zernio logs inbox messages on HubSpot contact timelines.
+     */
+    logMessages: boolean;
+};
+
+export type platform7 = 'hubspot';
+
 export type ImessageAudienceContact = {
     conversationId?: string;
     accountId?: string;
@@ -7428,7 +7621,7 @@ export type ImessageSender = {
     isActive?: boolean;
 };
 
-export type platform6 = 'imessage';
+export type platform8 = 'imessage';
 
 /**
  * A provisioned iMessage sender order and its lifecycle. Activation is asynchronous: poll GET /v1/imessage/senders/{senderId} or subscribe to account.connected.
@@ -7581,7 +7774,7 @@ export type InboxWebhookConversationDetail = {
     contactId?: string;
 };
 
-export type platform7 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'rcs' | 'slack' | 'tiktok' | 'imessage';
+export type platform9 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'rcs' | 'slack' | 'tiktok' | 'imessage';
 
 /**
  * The message object included in inbox webhook payloads.
@@ -7700,7 +7893,7 @@ export type InboxWebhookMessage = {
     isRead: boolean;
 };
 
-export type platform8 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'sms';
+export type platform10 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'sms';
 
 export type direction2 = 'incoming' | 'outgoing';
 
@@ -7828,7 +8021,7 @@ export type InstagramAccountInsightsResponse = {
 /**
  * Platform that served this response.
  */
-export type platform9 = 'facebook' | 'instagram' | 'youtube' | 'linkedin' | 'tiktok';
+export type platform11 = 'facebook' | 'instagram' | 'youtube' | 'linkedin' | 'tiktok';
 
 export type metricType = 'time_series' | 'total_value';
 
@@ -10817,7 +11010,7 @@ export type ReviewWebhookReview = {
 /**
  * Platform the review originated on. Currently Google Business Profile only.
  */
-export type platform10 = 'googlebusiness';
+export type platform12 = 'googlebusiness';
 
 /**
  * A Meta Reach & Frequency prediction. Money values in whole units of the ad account currency.
@@ -10941,7 +11134,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';
+    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';
     profileId: (string | Profile);
     username?: string;
     displayName?: string;
@@ -11051,7 +11244,7 @@ export type SocialAccount = {
     };
 };
 
-export type platform11 = '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';
+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';
 
 /**
  * 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.
@@ -11131,7 +11324,7 @@ export type StorePixelInstall = {
 /**
  * The store platform.
  */
-export type platform12 = 'shopify' | 'wordpress';
+export type platform14 = 'shopify' | 'wordpress';
 
 /**
  * WordPress only.
@@ -11812,7 +12005,7 @@ export type TrackingTag = {
     autoTagging?: boolean;
 };
 
-export type platform13 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads' | 'pinterestads' | 'whopads';
+export type platform15 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads' | 'pinterestads' | 'whopads';
 
 /**
  * Platform-native flavor of the tag (Meta: `pixel`).
@@ -13728,7 +13921,7 @@ export type WebhookPayloadComment = {
 
 export type event14 = 'comment.received';
 
-export type platform14 = 'instagram' | 'facebook' | 'threads' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit' | 'tiktok';
+export type platform16 = 'instagram' | 'facebook' | 'threads' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit' | 'tiktok';
 
 export type WebhookPayloadCommerceOrder = {
     /**
@@ -14090,7 +14283,7 @@ export type WebhookPayloadLead = {
 
 export type event22 = 'lead.received';
 
-export type platform15 = 'facebook';
+export type platform17 = 'facebook';
 
 /**
  * Webhook payload for message received events
@@ -15107,7 +15300,7 @@ export type event27 = 'message.sent';
 /**
  * Every platform whose outgoing messages Zernio observes. sms is absent on purpose: its carrier receipts update delivery status and never raise message.sent.
  */
-export type platform16 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'slack' | 'tiktok' | 'imessage';
+export type platform18 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'slack' | 'tiktok' | 'imessage';
 
 /**
  * WhatsApp send origin. whatsapp_business_app when sent from the WhatsApp Business phone app on a Coexistence number; cloud_api when sent through Zernio (dashboard, API, or broadcasts); meta_business_agent when Meta Business Agent answered on the number. Absent on non-WhatsApp platforms. Says where WhatsApp saw the send come from, not which Zernio surface produced it: read sentVia for that.
@@ -15682,7 +15875,7 @@ export type WebhookPayloadWhatsAppAccountAlertReceived = {
 
 export type event38 = 'whatsapp.account.alert_received';
 
-export type platform17 = 'whatsapp';
+export type platform19 = 'whatsapp';
 
 /**
  * Webhook payload for the `whatsapp.account.name_status_updated` event.
@@ -20081,9 +20274,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, 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, social = every other platform.
          */
-        category?: 'social' | 'ads' | 'communication' | 'blogs';
+        category?: 'social' | 'ads' | 'communication' | 'blogs' | 'crm';
         /**
          * When true, leaves out accounts the dashboard does not show as connections: posting
          * accounts with `enabled: false` (ads accounts are always kept, whatever their `enabled`
@@ -20289,7 +20482,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';
+        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';
         /**
          * Filter by profile ID
          */
@@ -21870,6 +22063,87 @@ export type ConnectShopifyWithTokenError = (unknown | ErrorResponse | {
     };
 });
 
+export type GetHubSpotConnectUrlData = {
+    query: {
+        /**
+         * Your Zernio profile ID (get from /v1/profiles).
+         */
+        profileId: 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 GetHubSpotConnectUrlResponse = ({
+    /**
+     * HubSpot URL to open in the user agent.
+     */
+    authUrl: string;
+    /**
+     * Authenticated, expiring OAuth state handled by the callback.
+     */
+    state: string;
+});
+
+export type GetHubSpotConnectUrlError = (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 GetWordPressAuthUrlData = {
     query: {
         /**
@@ -26452,6 +26726,41 @@ export type SetRedditPostFlairResponse = ({
 
 export type SetRedditPostFlairError = (unknown | ErrorResponse);
 
+export type GetHubSpotSettingsData = {
+    path: {
+        accountId: string;
+    };
+};
+
+export type GetHubSpotSettingsResponse = ({
+    account?: HubSpotSettings;
+});
+
+export type GetHubSpotSettingsError = (ErrorResponse | unknown);
+
+export type UpdateHubSpotSettingsData = {
+    body: {
+        /**
+         * Create or update a HubSpot contact for each inbox contact.
+         */
+        syncContacts?: boolean;
+        /**
+         * Log inbound and outbound inbox messages on the contact's HubSpot timeline.
+         */
+        logMessages?: boolean;
+    };
+    path: {
+        accountId: string;
+    };
+};
+
+export type UpdateHubSpotSettingsResponse = ({
+    message?: string;
+    account?: HubSpotSettings;
+});
+
+export type UpdateHubSpotSettingsError = (ErrorResponse | unknown);
+
 export type GetSlackSettingsData = {
     path: {
         accountId: string;
@@ -47667,100 +47976,17 @@ export type GetAdAccountLiveEntitiesResponse = ({
 export type GetAdAccountLiveEntitiesError = (ErrorResponse | unknown);
 
 export type CreateAdAccountData = {
-    body: {
-        /**
-         * Zernio metaads SocialAccount ID.
-         */
-        accountId: string;
-        /**
-         * Business portfolio that will own the account.
-         */
-        businessId: string;
-        /**
-         * Ad account name. Whitespace is trimmed.
-         */
-        name: string;
-        /**
-         * Uppercase ISO 4217 currency supported by Meta.
-         */
-        currency: string;
-        /**
-         * Numeric Meta timezone ID from the linked timezone list. For example 1 is America/Los_Angeles.
-         */
-        timezoneId: number;
-        /**
-         * End advertiser business or page ID. NONE uses the owning business.
-         */
-        endAdvertiser?: string;
-        /**
-         * Media agency business or page ID. NONE for self-serve customers.
-         */
-        mediaAgency?: string;
-        /**
-         * Partner business or page ID. NONE for self-serve customers.
-         */
-        partner?: string;
-        /**
-         * Request Meta invoicing. Eligibility is determined by Meta.
-         */
-        invoice?: boolean;
-        /**
-         * Existing Meta invoice group ID.
-         */
-        invoiceGroupId?: string;
-        /**
-         * Addresses for Meta invoices.
-         */
-        invoicingEmails?: Array<(string)>;
-        /**
-         * Meta insertion-order invoicing option.
-         */
-        io?: boolean;
-        /**
-         * Purchase order number.
-         */
-        poNumber?: string;
-        /**
-         * Existing Meta funding reference. Does not add a payment method.
-         */
-        fundingId?: string;
-        /**
-         * Meta Business Manager creation flag.
-         */
-        adAccountCreatedFromBmFlag?: boolean;
-    };
+    body: (CreateMetaAdAccountRequest | CreateGoogleAdAccountRequest);
 };
 
 export type CreateAdAccountResponse = ({
+    platform: 'google';
+    managerCustomerId: string;
     /**
-     * New Meta ad account ID for subsequent ads calls.
-     */
-    adAccountId: string;
-    /**
-     * Owning business portfolio ID.
-     */
-    businessId: string;
-    /**
-     * Whether the connection scope and discovery schedule were updated.
-     */
-    connectionUpdated: boolean;
-    /**
-     * Always true as a delivery prerequisite. This is not a live funding-source check. Confirm payment or invoicing in Ads Manager.
-     */
-    paymentMethodRequired: boolean;
-    /**
-     * Open the created account in Ads Manager.
-     */
-    adsManagerUrl: string;
-    /**
-     * Payment setup instructions for the user.
+     * Always true on a 200.
      */
-    nextSteps: string;
-    /**
-     * Recovery instructions if the account could not be attached to the connection.
-     */
-    warnings: Array<(string)>;
-});
+    validateOnly: boolean;
+} | (CreatedMetaAdAccount | CreatedGoogleAdAccount));
 
 export type CreateAdAccountError = (ErrorResponse);