import * as _hey_api_client_fetch from '@hey-api/client-fetch';

interface ClientOptions {
    /**
     * API key for authentication. Defaults to process.env['ZERNIO_API_KEY'] (falls back to LATE_API_KEY).
     */
    apiKey?: string | undefined;
    /**
     * Override the default base URL for the API.
     * @default "https://zernio.com/api"
     */
    baseURL?: string | null | undefined;
    /**
     * The maximum amount of time (in milliseconds) that the client should wait for a response.
     * @default 60000
     */
    timeout?: number;
    /**
     * Default headers to include with every request.
     */
    defaultHeaders?: Record<string, string>;
}
/**
 * API Client for the Zernio API.
 *
 * @example
 * ```typescript
 * import Zernio from '@zernio/node';
 *
 * const zernio = new Zernio({
 *   apiKey: process.env['ZERNIO_API_KEY'], // This is the default and can be omitted
 * });
 *
 * async function main() {
 *   const post = await zernio.posts.create({
 *     body: {
 *       content: 'Hello from the Zernio SDK!',
 *       platforms: [{ platform: 'twitter', accountId: 'acc_123' }],
 *       publishNow: true,
 *     },
 *   });
 *   console.log(post.data);
 * }
 *
 * main();
 * ```
 */
declare class Zernio {
    private _options;
    /**
     * HTTP client owned by this instance. Every namespace method below is bound
     * to it, so two Zernio instances in the same process never see each other's
     * credentials.
     */
    private _client;
    /**
     * Wrapper around `_client` that `_bind` injects into operations. Identical
     * to `_client` except that its HTTP methods strip the `client` selector from
     * request options before dispatch (see `_stripClientSelector`).
     */
    private _dispatchClient;
    /**
     * API key used for authentication.
     */
    apiKey: string;
    /**
     * Base URL for API requests.
     */
    baseURL: string;
    /**
     * Routes a generated operation through this instance's client, preserving the
     * operation's own signature. Reads `_client` when the method is called, not
     * when it is bound, because class fields initialize before the constructor
     * body runs.
     */
    private _bind;
    /**
     * TODO: remove once hey-api ships a fix for
     * https://github.com/hey-api/hey-api/issues/4177 and we can upgrade.
     *
     * `_bind` injects the per-instance client into each operation's options
     * under the `client` key, and the generated operations forward that whole
     * options object to @hey-api/client-fetch, which spreads it into the fetch
     * `RequestInit`. Node's undici ignores unknown init fields, but Deno defines
     * its own `client` init option (a `Deno.HttpClient`) and validates it, so
     * `new Request(...)` throws and every SDK call fails on Deno, Deno Deploy,
     * and Supabase Edge Functions. The selector has already done its job by the
     * time an HTTP method runs, so this wrapper strips it before hey-api builds
     * the request. The real client is left untouched — config and interceptors
     * still live on it, and the wrapper delegates everything else to it.
     */
    private static _stripClientSelector;
    /**
     * validate API
     */
    validate: {
        validatePostLength: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ValidatePostLengthData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ValidatePostLengthResponse, ValidatePostLengthError, ThrowOnError>;
        validatePost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ValidatePostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ValidatePostResponse, ValidatePostError, ThrowOnError>;
        validateMedia: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ValidateMediaData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ValidateMediaResponse, ValidateMediaError, ThrowOnError>;
        validateSubreddit: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ValidateSubredditData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ValidateSubredditResponse, ValidateSubredditError, ThrowOnError>;
    };
    /**
     * Analytics API - Get performance metrics
     */
    analytics: {
        getAnalytics: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetAnalyticsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAnalyticsResponse, GetAnalyticsError, ThrowOnError>;
        getYouTubeChannelInsights: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetYouTubeChannelInsightsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InstagramAccountInsightsResponse, unknown, ThrowOnError>;
        getLinkedInOrgAggregateAnalytics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInOrgAggregateAnalyticsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InstagramAccountInsightsResponse, unknown, ThrowOnError>;
        getTikTokAccountInsights: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetTikTokAccountInsightsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InstagramAccountInsightsResponse, unknown, ThrowOnError>;
        getYouTubeDailyViews: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetYouTubeDailyViewsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<YouTubeDailyViewsResponse, GetYouTubeDailyViewsError, ThrowOnError>;
        getYouTubeVideoRetention: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetYouTubeVideoRetentionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<YouTubeVideoRetentionResponse, GetYouTubeVideoRetentionError, ThrowOnError>;
        getFacebookPageInsights: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetFacebookPageInsightsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InstagramAccountInsightsResponse, unknown, ThrowOnError>;
        getFacebookPostEarnings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetFacebookPostEarningsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<FacebookPostEarningsResponse, unknown, ThrowOnError>;
        getInstagramAccountInsights: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInstagramAccountInsightsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InstagramAccountInsightsResponse, GetInstagramAccountInsightsError, ThrowOnError>;
        getInstagramFollowerHistory: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInstagramFollowerHistoryData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InstagramAccountInsightsResponse, unknown, ThrowOnError>;
        getInstagramDemographics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInstagramDemographicsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InstagramDemographicsResponse, GetInstagramDemographicsError, ThrowOnError>;
        getYouTubeDemographics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetYouTubeDemographicsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<YouTubeDemographicsResponse, GetYouTubeDemographicsError, ThrowOnError>;
        getDailyMetrics: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetDailyMetricsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetDailyMetricsResponse, GetDailyMetricsError, ThrowOnError>;
        getBestTimeToPost: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetBestTimeToPostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetBestTimeToPostResponse, GetBestTimeToPostError, ThrowOnError>;
        getContentDecay: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetContentDecayData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetContentDecayResponse, unknown, ThrowOnError>;
        getPostingFrequency: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetPostingFrequencyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPostingFrequencyResponse, GetPostingFrequencyError, ThrowOnError>;
        getPostTimeline: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPostTimelineData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPostTimelineResponse, GetPostTimelineError, ThrowOnError>;
        getGoogleBusinessPerformance: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetGoogleBusinessPerformanceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetGoogleBusinessPerformanceResponse, GetGoogleBusinessPerformanceError, ThrowOnError>;
        getGoogleBusinessSearchKeywords: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetGoogleBusinessSearchKeywordsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetGoogleBusinessSearchKeywordsResponse, GetGoogleBusinessSearchKeywordsError, ThrowOnError>;
        syncExternalPosts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SyncExternalPostsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SyncExternalPostsResponse, ErrorResponse, ThrowOnError>;
        getLinkedInAggregateAnalytics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInAggregateAnalyticsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInAggregateAnalyticsResponse, unknown, ThrowOnError>;
        getLinkedInPostAnalytics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInPostAnalyticsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInPostAnalyticsResponse, unknown, ThrowOnError>;
        getLinkedInPostReactions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInPostReactionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInPostReactionsResponse, unknown, ThrowOnError>;
        getFacebookPostReactions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetFacebookPostReactionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetFacebookPostReactionsResponse, unknown, ThrowOnError>;
    };
    /**
     * inboxanalytics API
     */
    inboxanalytics: {
        getInboxVolume: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInboxVolumeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInboxVolumeResponse, GetInboxVolumeError, ThrowOnError>;
        getInboxHeatmap: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInboxHeatmapData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInboxHeatmapResponse, GetInboxHeatmapError, ThrowOnError>;
        getInboxSourceBreakdown: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInboxSourceBreakdownData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInboxSourceBreakdownResponse, GetInboxSourceBreakdownError, ThrowOnError>;
        getInboxResponseTime: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInboxResponseTimeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInboxResponseTimeResponse, GetInboxResponseTimeError, ThrowOnError>;
        getInboxTopAccounts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInboxTopAccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInboxTopAccountsResponse, GetInboxTopAccountsError, ThrowOnError>;
        listInboxConversationAnalytics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListInboxConversationAnalyticsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListInboxConversationAnalyticsResponse, ListInboxConversationAnalyticsError, ThrowOnError>;
        getInboxConversationAnalytics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInboxConversationAnalyticsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInboxConversationAnalyticsResponse, GetInboxConversationAnalyticsError, ThrowOnError>;
    };
    /**
     * Account Groups API - Organize accounts into groups
     */
    accountGroups: {
        listAccountGroups: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAccountGroupsResponse, ListAccountGroupsError, ThrowOnError>;
        createAccountGroup: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateAccountGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAccountGroupResponse, unknown, ThrowOnError>;
        updateAccountGroup: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAccountGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAccountGroupResponse, unknown, ThrowOnError>;
        deleteAccountGroup: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAccountGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAccountGroupResponse, unknown, ThrowOnError>;
    };
    /**
     * Media API - Upload and manage media files
     */
    media: {
        getMediaPresignedUrl: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetMediaPresignedUrlData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetMediaPresignedUrlResponse, GetMediaPresignedUrlError, ThrowOnError>;
    };
    /**
     * Reddit API - Search and feed
     */
    reddit: {
        searchReddit: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SearchRedditData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchRedditResponse, SearchRedditError, ThrowOnError>;
        getRedditFeed: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetRedditFeedData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetRedditFeedResponse, GetRedditFeedError, ThrowOnError>;
    };
    /**
     * Usage API - Get usage statistics
     */
    usage: {
        getBilling: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BillingSnapshot, GetBillingError, ThrowOnError>;
        getXApiPricing: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<XApiPricing, GetXApiPricingError, ThrowOnError>;
        getUsage: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetUsageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetUsageResponse, unknown, ThrowOnError>;
        getUsageStats: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetUsageStatsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UsageStats, unknown, ThrowOnError>;
        getCallsUsage: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetCallsUsageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetCallsUsageResponse, unknown, ThrowOnError>;
        getSmsUsage: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetSmsUsageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSmsUsageResponse, unknown, ThrowOnError>;
    };
    /**
     * Posts API - Create, schedule, and manage social media posts
     */
    posts: {
        listPosts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListPostsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PostsListResponse, ListPostsError, ThrowOnError>;
        createPost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreatePostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PostCreateResponse, CreatePostError, ThrowOnError>;
        getPost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PostGetResponse, GetPostError, ThrowOnError>;
        updatePost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdatePostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, UpdatePostError, ThrowOnError>;
        deletePost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeletePostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PostDeleteResponse, DeletePostError, ThrowOnError>;
        bulkUploadPosts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BulkUploadPostsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BulkUploadResult, BulkUploadPostsError, ThrowOnError>;
        retryPost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RetryPostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, RetryPostError, ThrowOnError>;
        unpublishPost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnpublishPostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UnpublishPostResponse, unknown, ThrowOnError>;
        editPost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EditPostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EditPostResponse, unknown, ThrowOnError>;
        updatePostMetadata: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdatePostMetadataData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdatePostMetadataResponse, unknown, ThrowOnError>;
    };
    /**
     * Users API - User management
     */
    users: {
        listUsers: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListUsersResponse, ListUsersError, ThrowOnError>;
        getUser: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetUserData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetUserResponse, unknown, ThrowOnError>;
    };
    /**
     * Profiles API - Manage workspace profiles
     */
    profiles: {
        listProfiles: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListProfilesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfilesListResponse, ListProfilesError, ThrowOnError>;
        createProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileCreateResponse, unknown, ThrowOnError>;
        getProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileGetResponse, GetProfileError, ThrowOnError>;
        updateProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileUpdateResponse, unknown, ThrowOnError>;
        deleteProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileDeleteResponse, unknown, ThrowOnError>;
    };
    /**
     * Accounts API - Manage connected social media accounts
     */
    accounts: {
        listAccounts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListAccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AccountsListResponse, ListAccountsError, ThrowOnError>;
        getFollowerStats: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetFollowerStatsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<FollowerStatsResponse, GetFollowerStatsError, ThrowOnError>;
        updateAccount: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAccountData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAccountResponse, unknown, ThrowOnError>;
        moveAccountToProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<MoveAccountToProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<MoveAccountToProfileResponse, unknown, ThrowOnError>;
        deleteAccount: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAccountData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAccountResponse, DeleteAccountError, ThrowOnError>;
        getAllAccountsHealth: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetAllAccountsHealthData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAllAccountsHealthResponse, GetAllAccountsHealthError, ThrowOnError>;
        getAccountHealth: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAccountHealthData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAccountHealthResponse, GetAccountHealthError, ThrowOnError>;
        getInstagramFollowStatus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInstagramFollowStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInstagramFollowStatusResponse, GetInstagramFollowStatusError, ThrowOnError>;
        getTikTokCreatorInfo: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetTikTokCreatorInfoData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetTikTokCreatorInfoResponse, GetTikTokCreatorInfoError, ThrowOnError>;
        getGoogleBusinessReviews: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetGoogleBusinessReviewsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetGoogleBusinessReviewsResponse, GetGoogleBusinessReviewsError, ThrowOnError>;
        batchGetGoogleBusinessReviews: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BatchGetGoogleBusinessReviewsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BatchGetGoogleBusinessReviewsResponse, ErrorResponse, ThrowOnError>;
        replyToGoogleBusinessReview: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReplyToGoogleBusinessReviewData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReplyToGoogleBusinessReviewResponse, ReplyToGoogleBusinessReviewError, ThrowOnError>;
        deleteGoogleBusinessReviewReply: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteGoogleBusinessReviewReplyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteGoogleBusinessReviewReplyResponse, DeleteGoogleBusinessReviewReplyError, ThrowOnError>;
        getLinkedInMentions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInMentionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInMentionsResponse, GetLinkedInMentionsError, ThrowOnError>;
        getSlackSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSlackSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSlackSettingsResponse, unknown, ThrowOnError>;
        updateSlackSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateSlackSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        getBlueskySettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetBlueskySettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetBlueskySettingsResponse, unknown, ThrowOnError>;
        updateBlueskySettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateBlueskySettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
    };
    /**
     * whatsapp API
     */
    whatsapp: {
        registerWhatsAppNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RegisterWhatsAppNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RegisterWhatsAppNumberResponse, unknown, ThrowOnError>;
        getWhatsAppMedia: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppMediaData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppMediaResponse, unknown, ThrowOnError>;
        getWhatsAppTemplates: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppTemplatesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppTemplatesResponse, unknown, ThrowOnError>;
        createWhatsAppTemplate: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateWhatsAppTemplateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateWhatsAppTemplateResponse, unknown, ThrowOnError>;
        getWhatsAppTemplate: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppTemplateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppTemplateResponse, unknown, ThrowOnError>;
        updateWhatsAppTemplate: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateWhatsAppTemplateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateWhatsAppTemplateResponse, unknown, ThrowOnError>;
        deleteWhatsAppTemplate: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteWhatsAppTemplateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteWhatsAppTemplateResponse, unknown, ThrowOnError>;
        getWhatsAppBusinessProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppBusinessProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppBusinessProfileResponse, unknown, ThrowOnError>;
        updateWhatsAppBusinessProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateWhatsAppBusinessProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateWhatsAppBusinessProfileResponse, unknown, ThrowOnError>;
        uploadWhatsAppProfilePhoto: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadWhatsAppProfilePhotoData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadWhatsAppProfilePhotoResponse, unknown, ThrowOnError>;
        getWhatsAppDisplayName: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppDisplayNameData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppDisplayNameResponse, unknown, ThrowOnError>;
        updateWhatsAppDisplayName: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateWhatsAppDisplayNameData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateWhatsAppDisplayNameResponse, unknown, ThrowOnError>;
        getWhatsappBusinessUsername: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsappBusinessUsernameData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsappBusinessUsernameResponse, unknown, ThrowOnError>;
        setWhatsappBusinessUsername: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SetWhatsappBusinessUsernameData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SetWhatsappBusinessUsernameResponse, unknown, ThrowOnError>;
        deleteWhatsappBusinessUsername: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteWhatsappBusinessUsernameData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteWhatsappBusinessUsernameResponse, unknown, ThrowOnError>;
        getWhatsappBusinessUsernameSuggestions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsappBusinessUsernameSuggestionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsappBusinessUsernameSuggestionsResponse, unknown, ThrowOnError>;
        getWhatsAppBlockStatus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppBlockStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppBlockStatusResponse, unknown, ThrowOnError>;
        getWhatsAppBlockedUsers: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppBlockedUsersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppBlockedUsersResponse, unknown, ThrowOnError>;
        blockWhatsAppUsers: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BlockWhatsAppUsersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BlockWhatsAppUsersResponse, unknown, ThrowOnError>;
        unblockWhatsAppUsers: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnblockWhatsAppUsersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UnblockWhatsAppUsersResponse, unknown, ThrowOnError>;
        listWhatsAppAccountEvents: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWhatsAppAccountEventsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppAccountEventsResponse, unknown, ThrowOnError>;
        getWhatsAppDataset: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppDatasetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppDatasetResponse, unknown, ThrowOnError>;
        createWhatsAppDataset: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateWhatsAppDatasetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateWhatsAppDatasetResponse, unknown, ThrowOnError>;
        listWhatsAppGroupChats: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWhatsAppGroupChatsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppGroupChatsResponse, ListWhatsAppGroupChatsError, ThrowOnError>;
        createWhatsAppGroupChat: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateWhatsAppGroupChatData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateWhatsAppGroupChatResponse, CreateWhatsAppGroupChatError, ThrowOnError>;
        getWhatsAppGroupChat: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppGroupChatData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppGroupChatResponse, GetWhatsAppGroupChatError, ThrowOnError>;
        updateWhatsAppGroupChat: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateWhatsAppGroupChatData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateWhatsAppGroupChatResponse, UpdateWhatsAppGroupChatError, ThrowOnError>;
        deleteWhatsAppGroupChat: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteWhatsAppGroupChatData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteWhatsAppGroupChatResponse, DeleteWhatsAppGroupChatError, ThrowOnError>;
        addWhatsAppGroupParticipants: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddWhatsAppGroupParticipantsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddWhatsAppGroupParticipantsResponse, AddWhatsAppGroupParticipantsError, ThrowOnError>;
        removeWhatsAppGroupParticipants: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemoveWhatsAppGroupParticipantsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RemoveWhatsAppGroupParticipantsResponse, RemoveWhatsAppGroupParticipantsError, ThrowOnError>;
        createWhatsAppGroupInviteLink: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateWhatsAppGroupInviteLinkData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateWhatsAppGroupInviteLinkResponse, CreateWhatsAppGroupInviteLinkError, ThrowOnError>;
        listWhatsAppGroupJoinRequests: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWhatsAppGroupJoinRequestsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppGroupJoinRequestsResponse, ListWhatsAppGroupJoinRequestsError, ThrowOnError>;
        approveWhatsAppGroupJoinRequests: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ApproveWhatsAppGroupJoinRequestsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ApproveWhatsAppGroupJoinRequestsResponse, ApproveWhatsAppGroupJoinRequestsError, ThrowOnError>;
        rejectWhatsAppGroupJoinRequests: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RejectWhatsAppGroupJoinRequestsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RejectWhatsAppGroupJoinRequestsResponse, RejectWhatsAppGroupJoinRequestsError, ThrowOnError>;
        listWhatsAppConversions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWhatsAppConversionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppConversionsResponse, unknown, ThrowOnError>;
        sendWhatsAppConversion: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendWhatsAppConversionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendWhatsAppConversionResponse, unknown, ThrowOnError>;
    };
    /**
     * API Keys API - Manage API keys
     */
    apiKeys: {
        verifyCredential: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<VerifyCredentialResponse, VerifyCredentialError, ThrowOnError>;
        listApiKeys: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListApiKeysResponse, ListApiKeysError, ThrowOnError>;
        createApiKey: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateApiKeyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateApiKeyResponse, unknown, ThrowOnError>;
        deleteApiKey: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteApiKeyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteApiKeyResponse, DeleteApiKeyError, ThrowOnError>;
    };
    /**
     * connectedapps API
     */
    connectedapps: {
        listConnectedApps: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListConnectedAppsResponse, ListConnectedAppsError, ThrowOnError>;
        revokeConnectedApp: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RevokeConnectedAppData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RevokeConnectedAppResponse, RevokeConnectedAppError, ThrowOnError>;
    };
    /**
     * Invites API - Team invitations
     */
    invites: {
        createInviteToken: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateInviteTokenData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateInviteTokenResponse, unknown, ThrowOnError>;
    };
    /**
     * Connect API - OAuth connection flows
     */
    connect: {
        getConnectUrl: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetConnectUrlData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetConnectUrlResponse, unknown, ThrowOnError>;
        handleOAuthCallback: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<HandleOAuthCallbackData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        connectAds: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ConnectAdsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ConnectAdsResponse, unknown, ThrowOnError>;
        getShopifyConnectUrl: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetShopifyConnectUrlData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetShopifyConnectUrlResponse, unknown, ThrowOnError>;
        connectShopifyWithToken: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ConnectShopifyWithTokenData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ConnectShopifyWithTokenResponse, unknown, ThrowOnError>;
        configureTikTokAdsBrandIdentity: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ConfigureTikTokAdsBrandIdentityData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ConfigureTikTokAdsBrandIdentityResponse, unknown, ThrowOnError>;
        listInstagramPages: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListInstagramPagesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListInstagramPagesResponse, unknown, ThrowOnError>;
        selectInstagramAccount: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SelectInstagramAccountData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SelectInstagramAccountResponse, unknown, ThrowOnError>;
        getPendingOAuthData: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPendingOAuthDataData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPendingOAuthDataResponse, ErrorResponse, ThrowOnError>;
        connectOpenAIAdsCredentials: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ConnectOpenAiAdsCredentialsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ConnectOpenAiAdsCredentialsResponse, unknown, ThrowOnError>;
        connectWhatsAppCredentials: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ConnectWhatsAppCredentialsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ConnectWhatsAppCredentialsResponse, unknown, ThrowOnError>;
        listWhatsAppPhoneNumbers: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWhatsAppPhoneNumbersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppPhoneNumbersResponse, ListWhatsAppPhoneNumbersError, ThrowOnError>;
        completeWhatsAppPhoneSelection: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CompleteWhatsAppPhoneSelectionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CompleteWhatsAppPhoneSelectionResponse, unknown, ThrowOnError>;
        getFacebookPages: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetFacebookPagesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetFacebookPagesResponse, unknown, ThrowOnError>;
        updateFacebookPage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateFacebookPageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateFacebookPageResponse, unknown, ThrowOnError>;
        getLinkedInOrganizations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInOrganizationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInOrganizationsResponse, unknown, ThrowOnError>;
        updateLinkedInOrganization: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateLinkedInOrganizationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateLinkedInOrganizationResponse, unknown, ThrowOnError>;
        getPinterestBoards: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPinterestBoardsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPinterestBoardsResponse, unknown, ThrowOnError>;
        updatePinterestBoards: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdatePinterestBoardsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdatePinterestBoardsResponse, unknown, ThrowOnError>;
        createPinterestBoard: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreatePinterestBoardData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreatePinterestBoardResponse, unknown, ThrowOnError>;
        getYoutubePlaylists: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetYoutubePlaylistsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetYoutubePlaylistsResponse, unknown, ThrowOnError>;
        updateYoutubeDefaultPlaylist: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateYoutubeDefaultPlaylistData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateYoutubeDefaultPlaylistResponse, unknown, ThrowOnError>;
        getGmbLocations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetGmbLocationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetGmbLocationsResponse, unknown, ThrowOnError>;
        updateGmbLocation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateGmbLocationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateGmbLocationResponse, unknown, ThrowOnError>;
        assignGoogleBusinessLocation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AssignGoogleBusinessLocationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AssignGoogleBusinessLocationResponse, unknown, ThrowOnError>;
        getRedditSubreddits: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetRedditSubredditsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetRedditSubredditsResponse, unknown, ThrowOnError>;
        updateRedditSubreddits: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateRedditSubredditsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateRedditSubredditsResponse, unknown, ThrowOnError>;
        getSubredditRules: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSubredditRulesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSubredditRulesResponse, unknown, ThrowOnError>;
        voteRedditThing: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<VoteRedditThingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<VoteRedditThingResponse, unknown, ThrowOnError>;
        getRedditFlairs: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetRedditFlairsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetRedditFlairsResponse, unknown, ThrowOnError>;
        setRedditPostFlair: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SetRedditPostFlairData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SetRedditPostFlairResponse, unknown, ThrowOnError>;
        facebook: {
            listFacebookPages: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListFacebookPagesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListFacebookPagesResponse, unknown, ThrowOnError>;
            selectFacebookPage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SelectFacebookPageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SelectFacebookPageResponse, unknown, ThrowOnError>;
        };
        googleBusiness: {
            listGoogleBusinessLocations: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListGoogleBusinessLocationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListGoogleBusinessLocationsResponse, unknown, ThrowOnError>;
            selectGoogleBusinessLocation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SelectGoogleBusinessLocationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SelectGoogleBusinessLocationResponse, unknown, ThrowOnError>;
        };
        linkedin: {
            listLinkedInOrganizations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListLinkedInOrganizationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListLinkedInOrganizationsResponse, unknown, ThrowOnError>;
            selectLinkedInOrganization: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SelectLinkedInOrganizationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SelectLinkedInOrganizationResponse, unknown, ThrowOnError>;
        };
        pinterest: {
            listPinterestBoardsForSelection: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListPinterestBoardsForSelectionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListPinterestBoardsForSelectionResponse, unknown, ThrowOnError>;
            selectPinterestBoard: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SelectPinterestBoardData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SelectPinterestBoardResponse, unknown, ThrowOnError>;
        };
        snapchat: {
            listSnapchatProfiles: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListSnapchatProfilesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSnapchatProfilesResponse, unknown, ThrowOnError>;
            selectSnapchatProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SelectSnapchatProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SelectSnapchatProfileResponse, unknown, ThrowOnError>;
        };
        bluesky: {
            connectBlueskyCredentials: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ConnectBlueskyCredentialsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ConnectBlueskyCredentialsResponse, unknown, ThrowOnError>;
        };
        telegram: {
            getTelegramConnectStatus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetTelegramConnectStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetTelegramConnectStatusResponse, unknown, ThrowOnError>;
            initiateTelegramConnect: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<InitiateTelegramConnectData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InitiateTelegramConnectResponse, unknown, ThrowOnError>;
            completeTelegramConnect: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CompleteTelegramConnectData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CompleteTelegramConnectResponse, unknown, ThrowOnError>;
        };
    };
    /**
     * gmbverifications API
     */
    gmbverifications: {
        getGoogleBusinessVerifications: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetGoogleBusinessVerificationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetGoogleBusinessVerificationsResponse, GetGoogleBusinessVerificationsError, ThrowOnError>;
        startGoogleBusinessVerification: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<StartGoogleBusinessVerificationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<StartGoogleBusinessVerificationResponse, StartGoogleBusinessVerificationError, ThrowOnError>;
        fetchGoogleBusinessVerificationOptions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<FetchGoogleBusinessVerificationOptionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<FetchGoogleBusinessVerificationOptionsResponse, FetchGoogleBusinessVerificationOptionsError, ThrowOnError>;
        completeGoogleBusinessVerification: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CompleteGoogleBusinessVerificationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CompleteGoogleBusinessVerificationResponse, CompleteGoogleBusinessVerificationError, ThrowOnError>;
    };
    /**
     * gmbfoodmenus API
     */
    gmbfoodmenus: {
        getGoogleBusinessFoodMenus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetGoogleBusinessFoodMenusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetGoogleBusinessFoodMenusResponse, GetGoogleBusinessFoodMenusError, ThrowOnError>;
        updateGoogleBusinessFoodMenus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateGoogleBusinessFoodMenusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateGoogleBusinessFoodMenusResponse, UpdateGoogleBusinessFoodMenusError, ThrowOnError>;
    };
    /**
     * gmblocationdetails API
     */
    gmblocationdetails: {
        getGoogleBusinessLocationDetails: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetGoogleBusinessLocationDetailsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetGoogleBusinessLocationDetailsResponse, GetGoogleBusinessLocationDetailsError, ThrowOnError>;
        updateGoogleBusinessLocationDetails: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateGoogleBusinessLocationDetailsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateGoogleBusinessLocationDetailsResponse, UpdateGoogleBusinessLocationDetailsError, ThrowOnError>;
    };
    /**
     * gmbmedia API
     */
    gmbmedia: {
        listGoogleBusinessMedia: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListGoogleBusinessMediaData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListGoogleBusinessMediaResponse, ErrorResponse, ThrowOnError>;
        createGoogleBusinessMedia: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateGoogleBusinessMediaData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateGoogleBusinessMediaResponse, ErrorResponse, ThrowOnError>;
        deleteGoogleBusinessMedia: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteGoogleBusinessMediaData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteGoogleBusinessMediaResponse, ErrorResponse, ThrowOnError>;
    };
    /**
     * gmbattributes API
     */
    gmbattributes: {
        getGmbAttributeMetadata: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetGmbAttributeMetadataData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetGmbAttributeMetadataResponse, ErrorResponse, ThrowOnError>;
        getGoogleBusinessAttributes: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetGoogleBusinessAttributesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetGoogleBusinessAttributesResponse, ErrorResponse, ThrowOnError>;
        updateGoogleBusinessAttributes: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateGoogleBusinessAttributesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateGoogleBusinessAttributesResponse, ErrorResponse, ThrowOnError>;
    };
    /**
     * gmbplaceactions API
     */
    gmbplaceactions: {
        listGoogleBusinessPlaceActions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListGoogleBusinessPlaceActionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListGoogleBusinessPlaceActionsResponse, ErrorResponse, ThrowOnError>;
        createGoogleBusinessPlaceAction: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateGoogleBusinessPlaceActionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateGoogleBusinessPlaceActionResponse, ErrorResponse, ThrowOnError>;
        deleteGoogleBusinessPlaceAction: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteGoogleBusinessPlaceActionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteGoogleBusinessPlaceActionResponse, ErrorResponse, ThrowOnError>;
        updateGoogleBusinessPlaceAction: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateGoogleBusinessPlaceActionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateGoogleBusinessPlaceActionResponse, ErrorResponse, ThrowOnError>;
    };
    /**
     * gmbservices API
     */
    gmbservices: {
        getGoogleBusinessServices: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetGoogleBusinessServicesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetGoogleBusinessServicesResponse, ErrorResponse, ThrowOnError>;
        updateGoogleBusinessServices: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateGoogleBusinessServicesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateGoogleBusinessServicesResponse, ErrorResponse, ThrowOnError>;
    };
    /**
     * instagram API
     */
    instagram: {
        listInstagramStories: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListInstagramStoriesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListInstagramStoriesResponse, unknown, ThrowOnError>;
        getInstagramPublishingLimit: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInstagramPublishingLimitData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInstagramPublishingLimitResponse, unknown, ThrowOnError>;
        searchInstagramAudio: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SearchInstagramAudioData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchInstagramAudioResponse, unknown, ThrowOnError>;
        getInstagramAudio: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInstagramAudioData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInstagramAudioResponse, unknown, ThrowOnError>;
        getInstagramStoryInsights: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInstagramStoryInsightsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInstagramStoryInsightsResponse, unknown, ThrowOnError>;
    };
    /**
     * discord API
     */
    discord: {
        getDiscordSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetDiscordSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetDiscordSettingsResponse, unknown, ThrowOnError>;
        updateDiscordSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateDiscordSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateDiscordSettingsResponse, unknown, ThrowOnError>;
        getDiscordChannels: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetDiscordChannelsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetDiscordChannelsResponse, unknown, ThrowOnError>;
        sendDiscordDirectMessage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendDiscordDirectMessageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendDiscordDirectMessageResponse, unknown, ThrowOnError>;
        listDiscordGuildRoles: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListDiscordGuildRolesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListDiscordGuildRolesResponse, unknown, ThrowOnError>;
        createDiscordGuildRole: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateDiscordGuildRoleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateDiscordGuildRoleResponse, unknown, ThrowOnError>;
        editDiscordGuildRole: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EditDiscordGuildRoleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EditDiscordGuildRoleResponse, unknown, ThrowOnError>;
        deleteDiscordGuildRole: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteDiscordGuildRoleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteDiscordGuildRoleResponse, unknown, ThrowOnError>;
        listDiscordGuildMembers: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListDiscordGuildMembersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListDiscordGuildMembersResponse, unknown, ThrowOnError>;
        searchDiscordGuildMembers: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SearchDiscordGuildMembersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchDiscordGuildMembersResponse, unknown, ThrowOnError>;
        getDiscordGuildMember: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetDiscordGuildMemberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetDiscordGuildMemberResponse, unknown, ThrowOnError>;
        addDiscordMemberRole: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddDiscordMemberRoleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddDiscordMemberRoleResponse, unknown, ThrowOnError>;
        removeDiscordMemberRole: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemoveDiscordMemberRoleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RemoveDiscordMemberRoleResponse, unknown, ThrowOnError>;
        deleteDiscordMessage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteDiscordMessageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteDiscordMessageResponse, unknown, ThrowOnError>;
        crosspostDiscordMessage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CrosspostDiscordMessageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CrosspostDiscordMessageResponse, unknown, ThrowOnError>;
        createDiscordThread: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateDiscordThreadData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateDiscordThreadResponse, unknown, ThrowOnError>;
        listDiscordPinnedMessages: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListDiscordPinnedMessagesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListDiscordPinnedMessagesResponse, unknown, ThrowOnError>;
        pinDiscordMessage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PinDiscordMessageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PinDiscordMessageResponse, unknown, ThrowOnError>;
        unpinDiscordMessage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnpinDiscordMessageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UnpinDiscordMessageResponse, unknown, ThrowOnError>;
        listDiscordScheduledEvents: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListDiscordScheduledEventsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListDiscordScheduledEventsResponse, unknown, ThrowOnError>;
        createDiscordScheduledEvent: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateDiscordScheduledEventData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateDiscordScheduledEventResponse, unknown, ThrowOnError>;
        getDiscordScheduledEvent: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetDiscordScheduledEventData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetDiscordScheduledEventResponse, unknown, ThrowOnError>;
        updateDiscordScheduledEvent: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateDiscordScheduledEventData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateDiscordScheduledEventResponse, unknown, ThrowOnError>;
        deleteDiscordScheduledEvent: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteDiscordScheduledEventData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteDiscordScheduledEventResponse, unknown, ThrowOnError>;
    };
    /**
     * slack API
     */
    slack: {
        listSlackMembers: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListSlackMembersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSlackMembersResponse, unknown, ThrowOnError>;
    };
    /**
     * Queue API - Manage posting queue
     */
    queue: {
        listQueueSlots: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListQueueSlotsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListQueueSlotsResponse, unknown, ThrowOnError>;
        createQueueSlot: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateQueueSlotData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateQueueSlotResponse, unknown, ThrowOnError>;
        updateQueueSlot: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateQueueSlotData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<QueueUpdateResponse, unknown, ThrowOnError>;
        deleteQueueSlot: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteQueueSlotData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<QueueDeleteResponse, unknown, ThrowOnError>;
        previewQueue: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PreviewQueueData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<QueuePreviewResponse, unknown, ThrowOnError>;
        getNextQueueSlot: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetNextQueueSlotData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<QueueNextSlotResponse, unknown, ThrowOnError>;
    };
    /**
     * Webhooks API - Configure event webhooks
     */
    webhooks: {
        getWebhookSettings: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWebhookSettingsResponse, GetWebhookSettingsError, ThrowOnError>;
        createWebhookSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateWebhookSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateWebhookSettingsResponse, unknown, ThrowOnError>;
        updateWebhookSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateWebhookSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateWebhookSettingsResponse, unknown, ThrowOnError>;
        deleteWebhookSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteWebhookSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteWebhookSettingsResponse, unknown, ThrowOnError>;
        getWebhookLogs: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetWebhookLogsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWebhookLogsResponse, unknown, ThrowOnError>;
        testWebhook: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<TestWebhookData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TestWebhookResponse, unknown, ThrowOnError>;
    };
    /**
     * Logs API - Publishing logs
     */
    logs: {
        listLogs: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListLogsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListLogsResponse, ListLogsError, ThrowOnError>;
    };
    /**
     * messages API
     */
    messages: {
        listInboxConversations: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListInboxConversationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListInboxConversationsResponse, unknown, ThrowOnError>;
        createInboxConversation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateInboxConversationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateInboxConversationResponse, unknown, ThrowOnError>;
        searchInboxConversations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SearchInboxConversationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchInboxConversationsResponse, unknown, ThrowOnError>;
        getInboxConversation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInboxConversationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInboxConversationResponse, unknown, ThrowOnError>;
        updateInboxConversation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateInboxConversationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateInboxConversationResponse, unknown, ThrowOnError>;
        getInboxConversationMessages: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInboxConversationMessagesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInboxConversationMessagesResponse, unknown, ThrowOnError>;
        sendInboxMessage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendInboxMessageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendInboxMessageResponse, unknown, ThrowOnError>;
        editInboxMessage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EditInboxMessageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EditInboxMessageResponse, unknown, ThrowOnError>;
        deleteInboxMessage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteInboxMessageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteInboxMessageResponse, unknown, ThrowOnError>;
        sendTypingIndicator: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendTypingIndicatorData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendTypingIndicatorResponse, unknown, ThrowOnError>;
        markConversationRead: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<MarkConversationReadData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<MarkConversationReadResponse, unknown, ThrowOnError>;
        addMessageReaction: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddMessageReactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddMessageReactionResponse, unknown, ThrowOnError>;
        removeMessageReaction: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemoveMessageReactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RemoveMessageReactionResponse, unknown, ThrowOnError>;
        uploadMediaDirect: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadMediaDirectData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadMediaDirectResponse, unknown, ThrowOnError>;
        getMessageAttachment: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetMessageAttachmentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetMessageAttachmentResponse, unknown, ThrowOnError>;
    };
    /**
     * accountsettings API
     */
    accountsettings: {
        getMessengerMenu: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetMessengerMenuData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetMessengerMenuResponse, unknown, ThrowOnError>;
        setMessengerMenu: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SetMessengerMenuData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        deleteMessengerMenu: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteMessengerMenuData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteMessengerMenuError, ThrowOnError>;
        getInstagramIceBreakers: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInstagramIceBreakersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInstagramIceBreakersResponse, unknown, ThrowOnError>;
        setInstagramIceBreakers: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SetInstagramIceBreakersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        deleteInstagramIceBreakers: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteInstagramIceBreakersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteInstagramIceBreakersError, ThrowOnError>;
        getTelegramCommands: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetTelegramCommandsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetTelegramCommandsResponse, unknown, ThrowOnError>;
        setTelegramCommands: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SetTelegramCommandsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        deleteTelegramCommands: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteTelegramCommandsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteTelegramCommandsError, ThrowOnError>;
    };
    /**
     * comments API
     */
    comments: {
        listInboxComments: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListInboxCommentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListInboxCommentsResponse, unknown, ThrowOnError>;
        getInboxPostComments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetInboxPostCommentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetInboxPostCommentsResponse, unknown, ThrowOnError>;
        replyToInboxPost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReplyToInboxPostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReplyToInboxPostResponse, unknown, ThrowOnError>;
        deleteInboxComment: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteInboxCommentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteInboxCommentResponse, unknown, ThrowOnError>;
        editInboxComment: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EditInboxCommentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EditInboxCommentResponse, unknown, ThrowOnError>;
        setCommentModeration: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SetCommentModerationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SetCommentModerationResponse, unknown, ThrowOnError>;
        hideInboxComment: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<HideInboxCommentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<HideInboxCommentResponse, unknown, ThrowOnError>;
        unhideInboxComment: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnhideInboxCommentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UnhideInboxCommentResponse, unknown, ThrowOnError>;
        likeInboxComment: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<LikeInboxCommentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<LikeInboxCommentResponse, unknown, ThrowOnError>;
        unlikeInboxComment: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnlikeInboxCommentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UnlikeInboxCommentResponse, unknown, ThrowOnError>;
        likePost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<LikePostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<LikePostResponse, unknown, ThrowOnError>;
        unlikePost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnlikePostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UnlikePostResponse, unknown, ThrowOnError>;
        sendPrivateReplyToComment: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendPrivateReplyToCommentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendPrivateReplyToCommentResponse, unknown, ThrowOnError>;
    };
    /**
     * twitterengagement API
     */
    twitterengagement: {
        retweetPost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RetweetPostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RetweetPostResponse, unknown, ThrowOnError>;
        undoRetweet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UndoRetweetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UndoRetweetResponse, unknown, ThrowOnError>;
        bookmarkPost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BookmarkPostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BookmarkPostResponse, unknown, ThrowOnError>;
        removeBookmark: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemoveBookmarkData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RemoveBookmarkResponse, unknown, ThrowOnError>;
        followUser: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<FollowUserData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<FollowUserResponse, unknown, ThrowOnError>;
        unfollowUser: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnfollowUserData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UnfollowUserResponse, unknown, ThrowOnError>;
        searchTweets: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SearchTweetsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchTweetsResponse, unknown, ThrowOnError>;
        getTweet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetTweetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetTweetResponse, unknown, ThrowOnError>;
    };
    /**
     * mentions API
     */
    mentions: {
        listInboxMentions: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListInboxMentionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListInboxMentionsResponse, unknown, ThrowOnError>;
        replyToMention: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReplyToMentionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReplyToMentionResponse, unknown, ThrowOnError>;
    };
    /**
     * reviews API
     */
    reviews: {
        listInboxReviews: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListInboxReviewsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListInboxReviewsResponse, unknown, ThrowOnError>;
        replyToInboxReview: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReplyToInboxReviewData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReplyToInboxReviewResponse, unknown, ThrowOnError>;
        deleteInboxReviewReply: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteInboxReviewReplyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteInboxReviewReplyResponse, unknown, ThrowOnError>;
    };
    /**
     * whatsappcalling API
     */
    whatsappcalling: {
        getWhatsAppCallingConfig: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallingConfigData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallingConfigResponse, unknown, ThrowOnError>;
        enableWhatsAppCallingLegacy: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnableWhatsAppCallingLegacyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnableWhatsAppCallingLegacyResponse, unknown, ThrowOnError>;
        updateWhatsAppCallingLegacy: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateWhatsAppCallingLegacyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        disableWhatsAppCallingLegacy: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DisableWhatsAppCallingLegacyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        getWhatsAppCallPermissions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallPermissionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallPermissionsResponse, unknown, ThrowOnError>;
        initiateWhatsAppCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<InitiateWhatsAppCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InitiateWhatsAppCallResponse, unknown, ThrowOnError>;
        listWhatsAppCalls: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWhatsAppCallsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppCallsResponse, ListWhatsAppCallsError, ThrowOnError>;
        getWhatsAppCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallResponse, unknown, ThrowOnError>;
        getWhatsAppCallRecording: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallRecordingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallRecordingResponse, unknown, ThrowOnError>;
        getWhatsAppCallEstimate: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallEstimateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallEstimateResponse, GetWhatsAppCallEstimateError, ThrowOnError>;
        getWhatsAppCalling: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallingResponse, unknown, ThrowOnError>;
        enableWhatsAppCalling: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnableWhatsAppCallingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnableWhatsAppCallingResponse, unknown, ThrowOnError>;
        updateWhatsAppCalling: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateWhatsAppCallingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        disableWhatsAppCalling: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DisableWhatsAppCallingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        startWhatsAppCallerIdVerification: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<StartWhatsAppCallerIdVerificationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<StartWhatsAppCallerIdVerificationResponse, unknown, ThrowOnError>;
        verifyWhatsAppCallerId: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<VerifyWhatsAppCallerIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<VerifyWhatsAppCallerIdResponse, unknown, ThrowOnError>;
    };
    /**
     * calls API
     */
    calls: {
        listCalls: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListCallsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCallsResponse, unknown, ThrowOnError>;
        getCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetCallResponse, unknown, ThrowOnError>;
        getCallRecording: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetCallRecordingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetCallRecordingResponse, unknown, ThrowOnError>;
    };
    /**
     * voice API
     */
    voice: {
        createVoiceCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateVoiceCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateVoiceCallResponse, unknown, ThrowOnError>;
        listVoiceCalls: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListVoiceCallsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListVoiceCallsResponse, ListVoiceCallsError, ThrowOnError>;
        getVoiceCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetVoiceCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetVoiceCallResponse, unknown, ThrowOnError>;
        endVoiceCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EndVoiceCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EndVoiceCallResponse, unknown, ThrowOnError>;
        getVoiceCallRecording: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetVoiceCallRecordingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetVoiceCallRecordingResponse, unknown, ThrowOnError>;
        transferVoiceCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<TransferVoiceCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TransferVoiceCallResponse, unknown, ThrowOnError>;
        getVoiceCallEstimate: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetVoiceCallEstimateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetVoiceCallEstimateResponse, GetVoiceCallEstimateError, ThrowOnError>;
        createVoiceWebSession: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateVoiceWebSessionResponse, unknown, ThrowOnError>;
        dialVoiceWebCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DialVoiceWebCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DialVoiceWebCallResponse, unknown, ThrowOnError>;
        enableVoiceOnNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnableVoiceOnNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnableVoiceOnNumberResponse, unknown, ThrowOnError>;
        disableVoiceOnNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DisableVoiceOnNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DisableVoiceOnNumberResponse, unknown, ThrowOnError>;
    };
    /**
     * sms API
     */
    sms: {
        sendSms: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendSmsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendSmsResponse, unknown, ThrowOnError>;
        lookupSmsNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<LookupSmsNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<LookupSmsNumberResponse, unknown, ThrowOnError>;
        listSmsOptOuts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListSmsOptOutsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSmsOptOutsResponse, ListSmsOptOutsError, ThrowOnError>;
        createSmsSenderId: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateSmsSenderIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateSmsSenderIdResponse, unknown, ThrowOnError>;
        listSmsSenderIds: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSmsSenderIdsResponse, ListSmsSenderIdsError, ThrowOnError>;
        requestSmsSenderIdLimitIncrease: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RequestSmsSenderIdLimitIncreaseData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RequestSmsSenderIdLimitIncreaseResponse, unknown, ThrowOnError>;
        deleteSmsSenderId: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteSmsSenderIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteSmsSenderIdResponse, unknown, ThrowOnError>;
        startSmsRegistration: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<StartSmsRegistrationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<StartSmsRegistrationResponse, unknown, ThrowOnError>;
        listSmsRegistrations: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListSmsRegistrationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSmsRegistrationsResponse, ListSmsRegistrationsError, ThrowOnError>;
        preflightSmsRegistration: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PreflightSmsRegistrationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PreflightSmsRegistrationResponse, PreflightSmsRegistrationError, ThrowOnError>;
        deactivateSmsRegistration: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeactivateSmsRegistrationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeactivateSmsRegistrationResponse, unknown, ThrowOnError>;
        getSmsRegistration: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSmsRegistrationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSmsRegistrationResponse, unknown, ThrowOnError>;
        verifySmsRegistrationOtp: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<VerifySmsRegistrationOtpData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<VerifySmsRegistrationOtpResponse, unknown, ThrowOnError>;
        resendSmsRegistrationOtp: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ResendSmsRegistrationOtpData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResendSmsRegistrationOtpResponse, unknown, ThrowOnError>;
        appealSmsRegistration: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AppealSmsRegistrationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AppealSmsRegistrationResponse, unknown, ThrowOnError>;
        respondToSmsRegistrationReview: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RespondToSmsRegistrationReviewData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RespondToSmsRegistrationReviewResponse, unknown, ThrowOnError>;
        uploadSmsOptInProofFile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadSmsOptInProofFileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadSmsOptInProofFileResponse, unknown, ThrowOnError>;
        uploadSmsOptInProof: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadSmsOptInProofData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadSmsOptInProofResponse, unknown, ThrowOnError>;
        shareSmsRegistration: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ShareSmsRegistrationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ShareSmsRegistrationResponse, unknown, ThrowOnError>;
        enableSmsOnNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnableSmsOnNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnableSmsOnNumberResponse, unknown, ThrowOnError>;
        disableSmsOnNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DisableSmsOnNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DisableSmsOnNumberResponse, unknown, ThrowOnError>;
        reuseSmsRegistrationForNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReuseSmsRegistrationForNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReuseSmsRegistrationForNumberResponse, unknown, ThrowOnError>;
    };
    /**
     * whatsapptemplates API
     */
    whatsapptemplates: {
        getWhatsAppLibraryTemplate: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppLibraryTemplateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppLibraryTemplateResponse, unknown, ThrowOnError>;
    };
    /**
     * whatsappphonenumbers API
     */
    whatsappphonenumbers: {
        getWhatsAppNumberInfo: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppNumberInfoData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppNumberInfoResponse, unknown, ThrowOnError>;
        getWhatsAppPhoneNumbers: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppPhoneNumbersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppPhoneNumbersResponse, GetWhatsAppPhoneNumbersError, ThrowOnError>;
        purchaseWhatsAppPhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PurchaseWhatsAppPhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PurchaseWhatsAppPhoneNumberResponse, unknown, ThrowOnError>;
        listWhatsAppNumberCountries: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppNumberCountriesResponse, ListWhatsAppNumberCountriesError, ThrowOnError>;
        searchAvailableWhatsAppNumbers: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<SearchAvailableWhatsAppNumbersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchAvailableWhatsAppNumbersResponse, unknown, ThrowOnError>;
        checkWhatsAppNumberAvailability: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CheckWhatsAppNumberAvailabilityData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CheckWhatsAppNumberAvailabilityResponse, unknown, ThrowOnError>;
        getWhatsAppNumberKycForm: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppNumberKycFormData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppNumberKycFormResponse, unknown, ThrowOnError>;
        submitWhatsAppNumberKyc: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SubmitWhatsAppNumberKycData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SubmitWhatsAppNumberKycResponse, unknown, ThrowOnError>;
        uploadWhatsAppNumberKycDocument: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadWhatsAppNumberKycDocumentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadWhatsAppNumberKycDocumentResponse, unknown, ThrowOnError>;
        validateWhatsAppNumberKycAddress: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ValidateWhatsAppNumberKycAddressData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ValidateWhatsAppNumberKycAddressResponse, ValidateWhatsAppNumberKycAddressError, ThrowOnError>;
        createWhatsAppNumberKycLink: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateWhatsAppNumberKycLinkData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateWhatsAppNumberKycLinkResponse, unknown, ThrowOnError>;
        moveWhatsAppNumberToProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<MoveWhatsAppNumberToProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<MoveWhatsAppNumberToProfileResponse, unknown, ThrowOnError>;
        getWhatsAppNumberRemediation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppNumberRemediationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppNumberRemediationResponse, unknown, ThrowOnError>;
        remediateWhatsAppNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemediateWhatsAppNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RemediateWhatsAppNumberResponse, unknown, ThrowOnError>;
        getWhatsAppPhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppPhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppPhoneNumberResponse, GetWhatsAppPhoneNumberError, ThrowOnError>;
        releaseWhatsAppPhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReleaseWhatsAppPhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleaseWhatsAppPhoneNumberResponse, unknown, ThrowOnError>;
    };
    /**
     * phonenumbers API
     */
    phonenumbers: {
        listPhoneNumbers: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListPhoneNumbersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListPhoneNumbersResponse, ListPhoneNumbersError, ThrowOnError>;
        getPhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPhoneNumberResponse, GetPhoneNumberError, ThrowOnError>;
        releasePhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReleasePhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleasePhoneNumberResponse, unknown, ThrowOnError>;
        purchasePhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PurchasePhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PurchasePhoneNumberResponse, unknown, ThrowOnError>;
        listPhoneNumberCountries: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListPhoneNumberCountriesResponse, ListPhoneNumberCountriesError, ThrowOnError>;
        searchAvailablePhoneNumbers: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<SearchAvailablePhoneNumbersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchAvailablePhoneNumbersResponse, unknown, ThrowOnError>;
        checkPhoneNumberAvailability: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CheckPhoneNumberAvailabilityData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CheckPhoneNumberAvailabilityResponse, unknown, ThrowOnError>;
        getPhoneNumberKycForm: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPhoneNumberKycFormData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPhoneNumberKycFormResponse, unknown, ThrowOnError>;
        submitPhoneNumberKyc: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SubmitPhoneNumberKycData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SubmitPhoneNumberKycResponse, unknown, ThrowOnError>;
        viewPhoneNumberKycDocument: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ViewPhoneNumberKycDocumentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ViewPhoneNumberKycDocumentResponse, unknown, ThrowOnError>;
        uploadPhoneNumberKycDocument: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadPhoneNumberKycDocumentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadPhoneNumberKycDocumentResponse, unknown, ThrowOnError>;
        validatePhoneNumberKycAddress: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ValidatePhoneNumberKycAddressData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ValidatePhoneNumberKycAddressResponse, ValidatePhoneNumberKycAddressError, ThrowOnError>;
        createPhoneNumberKycLink: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreatePhoneNumberKycLinkData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreatePhoneNumberKycLinkResponse, unknown, ThrowOnError>;
        createPhoneNumberPortIn: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreatePhoneNumberPortInData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreatePhoneNumberPortInResponse, unknown, ThrowOnError>;
        listPhoneNumberPortIns: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListPhoneNumberPortInsResponse, ListPhoneNumberPortInsError, ThrowOnError>;
        checkPhoneNumberPortability: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CheckPhoneNumberPortabilityData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CheckPhoneNumberPortabilityResponse, CheckPhoneNumberPortabilityError, ThrowOnError>;
        uploadPhoneNumberPortInDocument: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadPhoneNumberPortInDocumentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadPhoneNumberPortInDocumentResponse, unknown, ThrowOnError>;
        getPhoneNumberPortInRequirements: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPhoneNumberPortInRequirementsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPhoneNumberPortInRequirementsResponse, unknown, ThrowOnError>;
        getPhoneNumberPortInOrderRequirements: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPhoneNumberPortInOrderRequirementsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPhoneNumberPortInOrderRequirementsResponse, unknown, ThrowOnError>;
        cancelPhoneNumberPortIn: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CancelPhoneNumberPortInData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CancelPhoneNumberPortInResponse, unknown, ThrowOnError>;
        reviewPhoneNumberKycPacket: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReviewPhoneNumberKycPacketData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReviewPhoneNumberKycPacketResponse, ReviewPhoneNumberKycPacketError, ThrowOnError>;
        getPhoneNumberRemediation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPhoneNumberRemediationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPhoneNumberRemediationResponse, unknown, ThrowOnError>;
        remediatePhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemediatePhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RemediatePhoneNumberResponse, unknown, ThrowOnError>;
        replyToPhoneNumberReviewer: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReplyToPhoneNumberReviewerData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReplyToPhoneNumberReviewerResponse, unknown, ThrowOnError>;
        respondToPhoneNumberReviewer: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RespondToPhoneNumberReviewerData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RespondToPhoneNumberReviewerResponse, unknown, ThrowOnError>;
    };
    /**
     * whatsappsandbox API
     */
    whatsappsandbox: {
        listWhatsAppSandboxSessions: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppSandboxSessionsResponse, unknown, ThrowOnError>;
        createWhatsAppSandboxSession: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateWhatsAppSandboxSessionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateWhatsAppSandboxSessionResponse, unknown, ThrowOnError>;
        deleteWhatsAppSandboxSession: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteWhatsAppSandboxSessionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteWhatsAppSandboxSessionResponse, unknown, ThrowOnError>;
    };
    /**
     * whatsappflows API
     */
    whatsappflows: {
        listWhatsAppFlows: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWhatsAppFlowsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppFlowsResponse, unknown, ThrowOnError>;
        createWhatsAppFlow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateWhatsAppFlowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateWhatsAppFlowResponse, unknown, ThrowOnError>;
        getWhatsAppFlow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppFlowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppFlowResponse, unknown, ThrowOnError>;
        updateWhatsAppFlow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateWhatsAppFlowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateWhatsAppFlowResponse, unknown, ThrowOnError>;
        deleteWhatsAppFlow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteWhatsAppFlowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteWhatsAppFlowResponse, unknown, ThrowOnError>;
        getWhatsAppFlowJson: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppFlowJsonData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppFlowJsonResponse, unknown, ThrowOnError>;
        uploadWhatsAppFlowJson: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadWhatsAppFlowJsonData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadWhatsAppFlowJsonResponse, unknown, ThrowOnError>;
        getWhatsAppFlowPreview: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppFlowPreviewData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppFlowPreviewResponse, unknown, ThrowOnError>;
        listWhatsAppFlowVersions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWhatsAppFlowVersionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppFlowVersionsResponse, unknown, ThrowOnError>;
        publishWhatsAppFlow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PublishWhatsAppFlowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PublishWhatsAppFlowResponse, unknown, ThrowOnError>;
        deprecateWhatsAppFlow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeprecateWhatsAppFlowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeprecateWhatsAppFlowResponse, unknown, ThrowOnError>;
        sendWhatsAppFlowMessage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendWhatsAppFlowMessageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendWhatsAppFlowMessageResponse, unknown, ThrowOnError>;
        listWhatsAppFlowResponses: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWhatsAppFlowResponsesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppFlowResponsesResponse, unknown, ThrowOnError>;
    };
    /**
     * contacts API
     */
    contacts: {
        listContacts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListContactsResponse, unknown, ThrowOnError>;
        createContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateContactResponse, unknown, ThrowOnError>;
        getContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetContactResponse, unknown, ThrowOnError>;
        updateContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateContactResponse, unknown, ThrowOnError>;
        deleteContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        getContactChannels: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetContactChannelsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetContactChannelsResponse, unknown, ThrowOnError>;
        bulkCreateContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BulkCreateContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BulkCreateContactsResponse, unknown, ThrowOnError>;
    };
    /**
     * customfields API
     */
    customfields: {
        setContactFieldValue: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SetContactFieldValueData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, SetContactFieldValueError, ThrowOnError>;
        clearContactFieldValue: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ClearContactFieldValueData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, ClearContactFieldValueError, ThrowOnError>;
        listCustomFields: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListCustomFieldsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCustomFieldsResponse, unknown, ThrowOnError>;
        createCustomField: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateCustomFieldData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateCustomFieldResponse, unknown, ThrowOnError>;
        updateCustomField: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateCustomFieldData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateCustomFieldResponse, unknown, ThrowOnError>;
        deleteCustomField: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteCustomFieldData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
    };
    /**
     * broadcasts API
     */
    broadcasts: {
        listBroadcasts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastsResponse, unknown, ThrowOnError>;
        createBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateBroadcastResponse, unknown, ThrowOnError>;
        getBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetBroadcastResponse, GetBroadcastError, ThrowOnError>;
        updateBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateBroadcastResponse, UpdateBroadcastError, ThrowOnError>;
        deleteBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteBroadcastError, ThrowOnError>;
        sendBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendBroadcastResponse, unknown, ThrowOnError>;
        scheduleBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ScheduleBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ScheduleBroadcastResponse, unknown, ThrowOnError>;
        cancelBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CancelBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CancelBroadcastResponse, unknown, ThrowOnError>;
        listBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastRecipientsResponse, unknown, ThrowOnError>;
        addBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddBroadcastRecipientsResponse, unknown, ThrowOnError>;
    };
    /**
     * workflows API
     */
    workflows: {
        listWorkflows: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListWorkflowsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWorkflowsResponse, ListWorkflowsError, ThrowOnError>;
        createWorkflow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateWorkflowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateWorkflowResponse, unknown, ThrowOnError>;
        getWorkflow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWorkflowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWorkflowResponse, GetWorkflowError, ThrowOnError>;
        updateWorkflow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateWorkflowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateWorkflowResponse, unknown, ThrowOnError>;
        deleteWorkflow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteWorkflowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteWorkflowError, ThrowOnError>;
        activateWorkflow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ActivateWorkflowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ActivateWorkflowResponse, unknown, ThrowOnError>;
        pauseWorkflow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PauseWorkflowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PauseWorkflowResponse, PauseWorkflowError, ThrowOnError>;
        listWorkflowExecutions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWorkflowExecutionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWorkflowExecutionsResponse, unknown, ThrowOnError>;
        triggerWorkflow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<TriggerWorkflowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TriggerWorkflowResponse, unknown, ThrowOnError>;
        listWorkflowExecutionEvents: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWorkflowExecutionEventsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWorkflowExecutionEventsResponse, ListWorkflowExecutionEventsError, ThrowOnError>;
        duplicateWorkflow: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DuplicateWorkflowData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DuplicateWorkflowResponse, DuplicateWorkflowError, ThrowOnError>;
        listWorkflowVersions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWorkflowVersionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWorkflowVersionsResponse, ListWorkflowVersionsError, ThrowOnError>;
        getWorkflowVersion: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWorkflowVersionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWorkflowVersionResponse, GetWorkflowVersionError, ThrowOnError>;
        restoreWorkflowVersion: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RestoreWorkflowVersionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RestoreWorkflowVersionResponse, unknown, ThrowOnError>;
    };
    /**
     * sequences API
     */
    sequences: {
        listSequences: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListSequencesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequencesResponse, unknown, ThrowOnError>;
        createSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateSequenceResponse, unknown, ThrowOnError>;
        getSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSequenceResponse, unknown, ThrowOnError>;
        updateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateSequenceResponse, unknown, ThrowOnError>;
        deleteSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        activateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ActivateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ActivateSequenceResponse, unknown, ThrowOnError>;
        pauseSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PauseSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PauseSequenceResponse, unknown, ThrowOnError>;
        enrollContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnrollContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnrollContactsResponse, unknown, ThrowOnError>;
        unenrollContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnenrollContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        listSequenceEnrollments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListSequenceEnrollmentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequenceEnrollmentsResponse, unknown, ThrowOnError>;
    };
    /**
     * commentautomations API
     */
    commentautomations: {
        listCommentAutomations: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListCommentAutomationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCommentAutomationsResponse, unknown, ThrowOnError>;
        createCommentAutomation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateCommentAutomationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateCommentAutomationResponse, unknown, ThrowOnError>;
        getCommentAutomation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetCommentAutomationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetCommentAutomationResponse, GetCommentAutomationError, ThrowOnError>;
        updateCommentAutomation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateCommentAutomationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateCommentAutomationResponse, UpdateCommentAutomationError, ThrowOnError>;
        deleteCommentAutomation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteCommentAutomationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteCommentAutomationError, ThrowOnError>;
        listCommentAutomationLogs: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListCommentAutomationLogsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCommentAutomationLogsResponse, ListCommentAutomationLogsError, ThrowOnError>;
    };
    /**
     * adcampaigns API
     */
    adcampaigns: {
        listAds: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListAdsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdsResponse, unknown, ThrowOnError>;
        listAdKeywords: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListAdKeywordsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdKeywordsResponse, unknown, ThrowOnError>;
        listAdCampaigns: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListAdCampaignsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdCampaignsResponse, unknown, ThrowOnError>;
        createAdCampaign: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateAdCampaignData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAdCampaignResponse, unknown, ThrowOnError>;
        updateAdCampaignStatus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdCampaignStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdCampaignStatusResponse, unknown, ThrowOnError>;
        updateAdCampaign: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdCampaignData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdCampaignResponse, unknown, ThrowOnError>;
        deleteAdCampaign: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAdCampaignData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAdCampaignResponse, unknown, ThrowOnError>;
        bulkUpdateAdCampaignStatus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BulkUpdateAdCampaignStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BulkUpdateAdCampaignStatusResponse, unknown, ThrowOnError>;
        duplicateAdCampaign: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DuplicateAdCampaignData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DuplicateAdCampaignResponse, unknown, ThrowOnError>;
        duplicateAdSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DuplicateAdSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DuplicateAdSetResponse, unknown, ThrowOnError>;
        duplicateAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DuplicateAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DuplicateAdResponse, unknown, ThrowOnError>;
        getAdSetDetails: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdSetDetailsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdSetDetailsResponse, unknown, ThrowOnError>;
        updateAdSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdSetResponse, unknown, ThrowOnError>;
        updateAdSetStatus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdSetStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdSetStatusResponse, unknown, ThrowOnError>;
        getAdTree: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetAdTreeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdTreeResponse, unknown, ThrowOnError>;
        getAdsTimeline: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdsTimelineData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdsTimelineResponse, unknown, ThrowOnError>;
        getAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdResponse, GetAdError, ThrowOnError>;
        updateAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdResponse, unknown, ThrowOnError>;
        deleteAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAdResponse, DeleteAdError, ThrowOnError>;
        updateAdStatus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdStatusResponse, unknown, ThrowOnError>;
        boostPost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BoostPostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BoostPostResponse, unknown, ThrowOnError>;
        createStandaloneAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateStandaloneAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateStandaloneAdResponse, unknown, ThrowOnError>;
    };
    /**
     * adinsights API
     */
    adinsights: {
        getAdsSearchTerms: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdsSearchTermsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdsSearchTermsResponse, unknown, ThrowOnError>;
        listLocalServicesLeads: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListLocalServicesLeadsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListLocalServicesLeadsResponse, unknown, ThrowOnError>;
        listLocalServicesLeadConversations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListLocalServicesLeadConversationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListLocalServicesLeadConversationsResponse, unknown, ThrowOnError>;
        getCampaignAnalytics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetCampaignAnalyticsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetCampaignAnalyticsResponse, unknown, ThrowOnError>;
        generateKeywordIdeas: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GenerateKeywordIdeasData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GenerateKeywordIdeasResponse, unknown, ThrowOnError>;
        generateKeywordHistoricalMetrics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GenerateKeywordHistoricalMetricsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GenerateKeywordHistoricalMetricsResponse, unknown, ThrowOnError>;
        queryAdInsights: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<QueryAdInsightsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<QueryAdInsightsResponse, unknown, ThrowOnError>;
        createAdInsightsReport: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateAdInsightsReportData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAdInsightsReportResponse, unknown, ThrowOnError>;
        getAdInsightsReport: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdInsightsReportData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdInsightsReportResponse, unknown, ThrowOnError>;
        getAdAnalytics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdAnalyticsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdAnalyticsResponse, unknown, ThrowOnError>;
    };
    /**
     * adcreatives API
     */
    adcreatives: {
        generateAdPreviews: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GenerateAdPreviewsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GenerateAdPreviewsResponse, unknown, ThrowOnError>;
        getAdPreviews: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdPreviewsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdPreviewsResponse, unknown, ThrowOnError>;
        listAdCreatives: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdCreativesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdCreativesResponse, unknown, ThrowOnError>;
        createAdCreative: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateAdCreativeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAdCreativeResponse, unknown, ThrowOnError>;
        getAdCreative: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdCreativeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdCreativeResponse, unknown, ThrowOnError>;
        updateAdCreative: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdCreativeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdCreativeResponse, unknown, ThrowOnError>;
        deleteAdCreative: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAdCreativeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAdCreativeResponse, unknown, ThrowOnError>;
        uploadAdImage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadAdImageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadAdImageResponse, unknown, ThrowOnError>;
        listAdImages: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdImagesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdImagesResponse, unknown, ThrowOnError>;
        listAdVideos: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdVideosData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdVideosResponse, unknown, ThrowOnError>;
        listAdCatalogs: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdCatalogsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdCatalogsResponse, unknown, ThrowOnError>;
        listAdCatalogProductSets: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdCatalogProductSetsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdCatalogProductSetsResponse, unknown, ThrowOnError>;
    };
    /**
     * trackingtags API
     */
    trackingtags: {
        getAdTrackingTags: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdTrackingTagsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdTrackingTagsResponse, unknown, ThrowOnError>;
        updateAdTrackingTags: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdTrackingTagsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        listTrackingTags: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListTrackingTagsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListTrackingTagsResponse, unknown, ThrowOnError>;
        createTrackingTag: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateTrackingTagData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateTrackingTagResponse, unknown, ThrowOnError>;
        getTrackingTag: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetTrackingTagData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetTrackingTagResponse, unknown, ThrowOnError>;
        updateTrackingTag: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateTrackingTagData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateTrackingTagResponse, unknown, ThrowOnError>;
        listTrackingTagSharedAccounts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListTrackingTagSharedAccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListTrackingTagSharedAccountsResponse, unknown, ThrowOnError>;
        addTrackingTagSharedAccount: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddTrackingTagSharedAccountData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddTrackingTagSharedAccountResponse, unknown, ThrowOnError>;
        removeTrackingTagSharedAccount: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemoveTrackingTagSharedAccountData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
        getTrackingTagStats: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetTrackingTagStatsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetTrackingTagStatsResponse, unknown, ThrowOnError>;
    };
    /**
     * adaccounts API
     */
    adaccounts: {
        getAdComments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdCommentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdCommentsResponse, unknown, ThrowOnError>;
        listAdsBusinessCenters: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdsBusinessCentersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdsBusinessCentersResponse, unknown, ThrowOnError>;
        getAdsActivityLog: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdsActivityLogData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdsActivityLogResponse, unknown, ThrowOnError>;
        listAdStudies: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdStudiesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdStudiesResponse, unknown, ThrowOnError>;
        listMetaBusinesses: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListMetaBusinessesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListMetaBusinessesResponse, unknown, ThrowOnError>;
        listAdLabels: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdLabelsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdLabelsResponse, unknown, ThrowOnError>;
        listHighDemandPeriods: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListHighDemandPeriodsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListHighDemandPeriodsResponse, unknown, ThrowOnError>;
        createHighDemandPeriod: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateHighDemandPeriodData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateHighDemandPeriodResponse, unknown, ThrowOnError>;
        listValueRuleSets: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListValueRuleSetsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListValueRuleSetsResponse, unknown, ThrowOnError>;
        createValueRuleSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateValueRuleSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateValueRuleSetResponse, unknown, ThrowOnError>;
        getValueRuleSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetValueRuleSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetValueRuleSetResponse, unknown, ThrowOnError>;
        updateValueRuleSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateValueRuleSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateValueRuleSetResponse, unknown, ThrowOnError>;
        deleteValueRuleSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteValueRuleSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteValueRuleSetResponse, unknown, ThrowOnError>;
        getAdAccountFinance: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdAccountFinanceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdAccountFinanceResponse, unknown, ThrowOnError>;
        listAdAccounts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdAccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdAccountsResponse, unknown, ThrowOnError>;
        updateAdAccount: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdAccountData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdAccountResponse, unknown, ThrowOnError>;
        getDsaDefaults: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetDsaDefaultsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetDsaDefaultsResponse, unknown, ThrowOnError>;
        getDsaRecommendations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetDsaRecommendationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetDsaRecommendationsResponse, unknown, ThrowOnError>;
        listCustomConversions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListCustomConversionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCustomConversionsResponse, unknown, ThrowOnError>;
        createCustomConversion: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateCustomConversionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CustomConversionResult, unknown, ThrowOnError>;
    };
    /**
     * reachandfrequency API
     */
    reachandfrequency: {
        createRfPrediction: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateRfPredictionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateRfPredictionResponse, unknown, ThrowOnError>;
        getRfPrediction: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetRfPredictionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetRfPredictionResponse, unknown, ThrowOnError>;
        cancelRfReservation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CancelRfReservationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        reserveRfPrediction: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReserveRfPredictionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReserveRfPredictionResponse, unknown, ThrowOnError>;
    };
    /**
     * leadgen API
     */
    leadgen: {
        listLeads: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListLeadsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListLeadsResponse, unknown, ThrowOnError>;
        listLeadForms: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListLeadFormsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListLeadFormsResponse, unknown, ThrowOnError>;
        createLeadForm: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateLeadFormData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateLeadFormResponse, unknown, ThrowOnError>;
        getLeadForm: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLeadFormData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLeadFormResponse, GetLeadFormError, ThrowOnError>;
        archiveLeadForm: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ArchiveLeadFormData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ArchiveLeadFormResponse, ArchiveLeadFormError, ThrowOnError>;
        listFormLeads: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListFormLeadsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListFormLeadsResponse, ListFormLeadsError, ThrowOnError>;
        createTestLead: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateTestLeadData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateTestLeadResponse, CreateTestLeadError, ThrowOnError>;
    };
    /**
     * adtargeting API
     */
    adtargeting: {
        searchAdInterests: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SearchAdInterestsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchAdInterestsResponse, unknown, ThrowOnError>;
        searchAdTargeting: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SearchAdTargetingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchAdTargetingResponse, unknown, ThrowOnError>;
        estimateAdReach: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EstimateAdReachData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EstimateAdReachResponse, unknown, ThrowOnError>;
        getLinkedInBidPricing: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInBidPricingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInBidPricingResponse, unknown, ThrowOnError>;
        getLinkedInSupplyForecast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInSupplyForecastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInSupplyForecastResponse, unknown, ThrowOnError>;
    };
    /**
     * adaudiences API
     */
    adaudiences: {
        listAdAudiences: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdAudiencesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdAudiencesResponse, unknown, ThrowOnError>;
        createAdAudience: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateAdAudienceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAdAudienceResponse, unknown, ThrowOnError>;
        getAdAudience: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdAudienceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdAudienceResponse, unknown, ThrowOnError>;
        updateAdAudience: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdAudienceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdAudienceResponse, unknown, ThrowOnError>;
        deleteAdAudience: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAdAudienceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAdAudienceResponse, unknown, ThrowOnError>;
        addUsersToAdAudience: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddUsersToAdAudienceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddUsersToAdAudienceResponse, unknown, ThrowOnError>;
        replaceAdAudienceCompanies: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReplaceAdAudienceCompaniesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReplaceAdAudienceCompaniesResponse, unknown, ThrowOnError>;
    };
    /**
     * conversions API
     */
    conversions: {
        getConversionsQuality: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetConversionsQualityData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetConversionsQualityResponse, unknown, ThrowOnError>;
        sendConversions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendConversionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendConversionsResponse, unknown, ThrowOnError>;
        adjustConversions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AdjustConversionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AdjustConversionsResponse, unknown, ThrowOnError>;
        listConversionDestinations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListConversionDestinationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListConversionDestinationsResponse, unknown, ThrowOnError>;
        createConversionDestination: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateConversionDestinationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateConversionDestinationResponse, unknown, ThrowOnError>;
        getConversionDestination: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetConversionDestinationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetConversionDestinationResponse, unknown, ThrowOnError>;
        updateConversionDestination: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateConversionDestinationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateConversionDestinationResponse, unknown, ThrowOnError>;
        deleteConversionDestination: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteConversionDestinationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
        listConversionAssociations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListConversionAssociationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListConversionAssociationsResponse, unknown, ThrowOnError>;
        addConversionAssociations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddConversionAssociationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddConversionAssociationsResponse, unknown, ThrowOnError>;
        removeConversionAssociations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemoveConversionAssociationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RemoveConversionAssociationsResponse, unknown, ThrowOnError>;
        getConversionMetrics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetConversionMetricsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetConversionMetricsResponse, unknown, ThrowOnError>;
    };
    /**
     * messagingads API
     */
    messagingads: {
        createMessagingAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateMessagingAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        createCallAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateCallAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        createCtwaAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateCtwaAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateCtwaAdResponse, unknown, ThrowOnError>;
    };
    /**
     * blogs API
     */
    blogs: {
        listBlogs: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBlogsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBlogsResponse, unknown, ThrowOnError>;
        createBlog: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateBlogData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateBlogResponse, unknown, ThrowOnError>;
        getBlog: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetBlogData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetBlogResponse, unknown, ThrowOnError>;
        updateBlog: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateBlogData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateBlogResponse, unknown, ThrowOnError>;
        deleteBlog: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteBlogData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
        listBlogArticles: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBlogArticlesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBlogArticlesResponse, unknown, ThrowOnError>;
        createBlogArticle: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateBlogArticleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateBlogArticleResponse, unknown, ThrowOnError>;
        getBlogArticle: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetBlogArticleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetBlogArticleResponse, unknown, ThrowOnError>;
        updateBlogArticle: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateBlogArticleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateBlogArticleResponse, unknown, ThrowOnError>;
        deleteBlogArticle: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteBlogArticleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
    };
    /**
     * verify API
     */
    verify: {
        createVerification: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateVerificationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<Verification, unknown, ThrowOnError>;
        getVerification: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetVerificationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<Verification, unknown, ThrowOnError>;
        checkVerification: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CheckVerificationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CheckVerificationResponse, unknown, ThrowOnError>;
    };
    /**
     * @deprecated The `ads` namespace has been split. Use one of these instead:
     * zernio.adcampaigns, zernio.adaccounts, zernio.adcreatives, zernio.adaudiences, zernio.adtargeting, zernio.adinsights, zernio.conversions, zernio.messagingads, zernio.reachandfrequency, zernio.leadgen, zernio.trackingtags.
     * This backward-compatibility alias will be removed in a future major version.
     */
    ads: {
        /** @deprecated Use `zernio.adcampaigns.listAds` instead. */
        listAds: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListAdsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.listAdKeywords` instead. */
        listAdKeywords: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListAdKeywordsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdKeywordsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.listAdCampaigns` instead. */
        listAdCampaigns: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListAdCampaignsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdCampaignsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.createAdCampaign` instead. */
        createAdCampaign: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateAdCampaignData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAdCampaignResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.updateAdCampaignStatus` instead. */
        updateAdCampaignStatus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdCampaignStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdCampaignStatusResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.updateAdCampaign` instead. */
        updateAdCampaign: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdCampaignData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdCampaignResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.deleteAdCampaign` instead. */
        deleteAdCampaign: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAdCampaignData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAdCampaignResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.bulkUpdateAdCampaignStatus` instead. */
        bulkUpdateAdCampaignStatus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BulkUpdateAdCampaignStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BulkUpdateAdCampaignStatusResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.duplicateAdCampaign` instead. */
        duplicateAdCampaign: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DuplicateAdCampaignData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DuplicateAdCampaignResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.duplicateAdSet` instead. */
        duplicateAdSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DuplicateAdSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DuplicateAdSetResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.duplicateAd` instead. */
        duplicateAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DuplicateAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DuplicateAdResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.getAdSetDetails` instead. */
        getAdSetDetails: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdSetDetailsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdSetDetailsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.updateAdSet` instead. */
        updateAdSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdSetResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.updateAdSetStatus` instead. */
        updateAdSetStatus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdSetStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdSetStatusResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.getAdTree` instead. */
        getAdTree: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetAdTreeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdTreeResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.getAdsTimeline` instead. */
        getAdsTimeline: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdsTimelineData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdsTimelineResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.getAd` instead. */
        getAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdResponse, GetAdError, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.updateAd` instead. */
        updateAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.deleteAd` instead. */
        deleteAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAdResponse, DeleteAdError, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.updateAdStatus` instead. */
        updateAdStatus: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdStatusResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.boostPost` instead. */
        boostPost: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BoostPostData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BoostPostResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcampaigns.createStandaloneAd` instead. */
        createStandaloneAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateStandaloneAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateStandaloneAdResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.getAdComments` instead. */
        getAdComments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdCommentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdCommentsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.listAdsBusinessCenters` instead. */
        listAdsBusinessCenters: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdsBusinessCentersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdsBusinessCentersResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.getAdsActivityLog` instead. */
        getAdsActivityLog: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdsActivityLogData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdsActivityLogResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.listAdStudies` instead. */
        listAdStudies: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdStudiesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdStudiesResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.listMetaBusinesses` instead. */
        listMetaBusinesses: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListMetaBusinessesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListMetaBusinessesResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.listAdLabels` instead. */
        listAdLabels: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdLabelsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdLabelsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.listHighDemandPeriods` instead. */
        listHighDemandPeriods: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListHighDemandPeriodsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListHighDemandPeriodsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.createHighDemandPeriod` instead. */
        createHighDemandPeriod: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateHighDemandPeriodData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateHighDemandPeriodResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.listValueRuleSets` instead. */
        listValueRuleSets: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListValueRuleSetsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListValueRuleSetsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.createValueRuleSet` instead. */
        createValueRuleSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateValueRuleSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateValueRuleSetResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.getValueRuleSet` instead. */
        getValueRuleSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetValueRuleSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetValueRuleSetResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.updateValueRuleSet` instead. */
        updateValueRuleSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateValueRuleSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateValueRuleSetResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.deleteValueRuleSet` instead. */
        deleteValueRuleSet: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteValueRuleSetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteValueRuleSetResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.getAdAccountFinance` instead. */
        getAdAccountFinance: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdAccountFinanceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdAccountFinanceResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.listAdAccounts` instead. */
        listAdAccounts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdAccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdAccountsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.updateAdAccount` instead. */
        updateAdAccount: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdAccountData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdAccountResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.getDsaDefaults` instead. */
        getDsaDefaults: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetDsaDefaultsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetDsaDefaultsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.getDsaRecommendations` instead. */
        getDsaRecommendations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetDsaRecommendationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetDsaRecommendationsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.listCustomConversions` instead. */
        listCustomConversions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListCustomConversionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCustomConversionsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaccounts.createCustomConversion` instead. */
        createCustomConversion: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateCustomConversionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CustomConversionResult, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.generateAdPreviews` instead. */
        generateAdPreviews: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GenerateAdPreviewsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GenerateAdPreviewsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.getAdPreviews` instead. */
        getAdPreviews: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdPreviewsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdPreviewsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.listAdCreatives` instead. */
        listAdCreatives: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdCreativesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdCreativesResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.createAdCreative` instead. */
        createAdCreative: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateAdCreativeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAdCreativeResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.getAdCreative` instead. */
        getAdCreative: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdCreativeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdCreativeResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.updateAdCreative` instead. */
        updateAdCreative: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdCreativeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdCreativeResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.deleteAdCreative` instead. */
        deleteAdCreative: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAdCreativeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAdCreativeResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.uploadAdImage` instead. */
        uploadAdImage: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadAdImageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadAdImageResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.listAdImages` instead. */
        listAdImages: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdImagesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdImagesResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.listAdVideos` instead. */
        listAdVideos: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdVideosData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdVideosResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.listAdCatalogs` instead. */
        listAdCatalogs: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdCatalogsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdCatalogsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adcreatives.listAdCatalogProductSets` instead. */
        listAdCatalogProductSets: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdCatalogProductSetsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdCatalogProductSetsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaudiences.listAdAudiences` instead. */
        listAdAudiences: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListAdAudiencesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAdAudiencesResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaudiences.createAdAudience` instead. */
        createAdAudience: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateAdAudienceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAdAudienceResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaudiences.getAdAudience` instead. */
        getAdAudience: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdAudienceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdAudienceResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaudiences.updateAdAudience` instead. */
        updateAdAudience: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdAudienceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAdAudienceResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaudiences.deleteAdAudience` instead. */
        deleteAdAudience: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAdAudienceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAdAudienceResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaudiences.addUsersToAdAudience` instead. */
        addUsersToAdAudience: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddUsersToAdAudienceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddUsersToAdAudienceResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adaudiences.replaceAdAudienceCompanies` instead. */
        replaceAdAudienceCompanies: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReplaceAdAudienceCompaniesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReplaceAdAudienceCompaniesResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adtargeting.searchAdInterests` instead. */
        searchAdInterests: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SearchAdInterestsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchAdInterestsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adtargeting.searchAdTargeting` instead. */
        searchAdTargeting: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SearchAdTargetingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchAdTargetingResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adtargeting.estimateAdReach` instead. */
        estimateAdReach: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EstimateAdReachData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EstimateAdReachResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adtargeting.getLinkedInBidPricing` instead. */
        getLinkedInBidPricing: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInBidPricingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInBidPricingResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adtargeting.getLinkedInSupplyForecast` instead. */
        getLinkedInSupplyForecast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInSupplyForecastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInSupplyForecastResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adinsights.getAdsSearchTerms` instead. */
        getAdsSearchTerms: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdsSearchTermsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdsSearchTermsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adinsights.listLocalServicesLeads` instead. */
        listLocalServicesLeads: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListLocalServicesLeadsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListLocalServicesLeadsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adinsights.listLocalServicesLeadConversations` instead. */
        listLocalServicesLeadConversations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListLocalServicesLeadConversationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListLocalServicesLeadConversationsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adinsights.getCampaignAnalytics` instead. */
        getCampaignAnalytics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetCampaignAnalyticsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetCampaignAnalyticsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adinsights.generateKeywordIdeas` instead. */
        generateKeywordIdeas: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GenerateKeywordIdeasData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GenerateKeywordIdeasResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adinsights.generateKeywordHistoricalMetrics` instead. */
        generateKeywordHistoricalMetrics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GenerateKeywordHistoricalMetricsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GenerateKeywordHistoricalMetricsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adinsights.queryAdInsights` instead. */
        queryAdInsights: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<QueryAdInsightsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<QueryAdInsightsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adinsights.createAdInsightsReport` instead. */
        createAdInsightsReport: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateAdInsightsReportData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAdInsightsReportResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adinsights.getAdInsightsReport` instead. */
        getAdInsightsReport: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdInsightsReportData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdInsightsReportResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.adinsights.getAdAnalytics` instead. */
        getAdAnalytics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdAnalyticsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdAnalyticsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.getConversionsQuality` instead. */
        getConversionsQuality: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetConversionsQualityData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetConversionsQualityResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.sendConversions` instead. */
        sendConversions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendConversionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendConversionsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.adjustConversions` instead. */
        adjustConversions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AdjustConversionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AdjustConversionsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.listConversionDestinations` instead. */
        listConversionDestinations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListConversionDestinationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListConversionDestinationsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.createConversionDestination` instead. */
        createConversionDestination: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateConversionDestinationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateConversionDestinationResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.getConversionDestination` instead. */
        getConversionDestination: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetConversionDestinationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetConversionDestinationResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.updateConversionDestination` instead. */
        updateConversionDestination: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateConversionDestinationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateConversionDestinationResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.deleteConversionDestination` instead. */
        deleteConversionDestination: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteConversionDestinationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.listConversionAssociations` instead. */
        listConversionAssociations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListConversionAssociationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListConversionAssociationsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.addConversionAssociations` instead. */
        addConversionAssociations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddConversionAssociationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddConversionAssociationsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.removeConversionAssociations` instead. */
        removeConversionAssociations: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemoveConversionAssociationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RemoveConversionAssociationsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.conversions.getConversionMetrics` instead. */
        getConversionMetrics: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetConversionMetricsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetConversionMetricsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.messagingads.createMessagingAd` instead. */
        createMessagingAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateMessagingAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.messagingads.createCallAd` instead. */
        createCallAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateCallAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.messagingads.createCtwaAd` instead. */
        createCtwaAd: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateCtwaAdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateCtwaAdResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.reachandfrequency.createRfPrediction` instead. */
        createRfPrediction: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateRfPredictionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateRfPredictionResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.reachandfrequency.getRfPrediction` instead. */
        getRfPrediction: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetRfPredictionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetRfPredictionResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.reachandfrequency.cancelRfReservation` instead. */
        cancelRfReservation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CancelRfReservationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.reachandfrequency.reserveRfPrediction` instead. */
        reserveRfPrediction: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReserveRfPredictionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReserveRfPredictionResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.leadgen.listLeads` instead. */
        listLeads: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListLeadsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListLeadsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.leadgen.listLeadForms` instead. */
        listLeadForms: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListLeadFormsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListLeadFormsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.leadgen.createLeadForm` instead. */
        createLeadForm: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateLeadFormData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateLeadFormResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.leadgen.getLeadForm` instead. */
        getLeadForm: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLeadFormData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLeadFormResponse, GetLeadFormError, ThrowOnError>;
        /** @deprecated Use `zernio.leadgen.archiveLeadForm` instead. */
        archiveLeadForm: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ArchiveLeadFormData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ArchiveLeadFormResponse, ArchiveLeadFormError, ThrowOnError>;
        /** @deprecated Use `zernio.leadgen.listFormLeads` instead. */
        listFormLeads: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListFormLeadsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListFormLeadsResponse, ListFormLeadsError, ThrowOnError>;
        /** @deprecated Use `zernio.leadgen.createTestLead` instead. */
        createTestLead: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateTestLeadData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateTestLeadResponse, CreateTestLeadError, ThrowOnError>;
        /** @deprecated Use `zernio.trackingtags.getAdTrackingTags` instead. */
        getAdTrackingTags: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetAdTrackingTagsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetAdTrackingTagsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.trackingtags.updateAdTrackingTags` instead. */
        updateAdTrackingTags: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAdTrackingTagsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.trackingtags.listTrackingTags` instead. */
        listTrackingTags: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListTrackingTagsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListTrackingTagsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.trackingtags.createTrackingTag` instead. */
        createTrackingTag: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateTrackingTagData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateTrackingTagResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.trackingtags.getTrackingTag` instead. */
        getTrackingTag: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetTrackingTagData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetTrackingTagResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.trackingtags.updateTrackingTag` instead. */
        updateTrackingTag: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateTrackingTagData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateTrackingTagResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.trackingtags.listTrackingTagSharedAccounts` instead. */
        listTrackingTagSharedAccounts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListTrackingTagSharedAccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListTrackingTagSharedAccountsResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.trackingtags.addTrackingTagSharedAccount` instead. */
        addTrackingTagSharedAccount: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddTrackingTagSharedAccountData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddTrackingTagSharedAccountResponse, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.trackingtags.removeTrackingTagSharedAccount` instead. */
        removeTrackingTagSharedAccount: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemoveTrackingTagSharedAccountData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
        /** @deprecated Use `zernio.trackingtags.getTrackingTagStats` instead. */
        getTrackingTagStats: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetTrackingTagStatsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetTrackingTagStatsResponse, unknown, ThrowOnError>;
    };
    /**
     * Create a new Zernio API client.
     *
     * @param options - Configuration options for the client
     */
    constructor(options?: ClientOptions);
}
/** @deprecated Use Zernio instead */
declare const Late: typeof Zernio;

/**
 * Base error class for Zernio API errors
 */
declare class ZernioApiError extends Error {
    readonly statusCode: number;
    readonly code?: string;
    readonly details?: Record<string, unknown>;
    constructor(message: string, statusCode: number, code?: string, details?: Record<string, unknown>);
    /**
     * Check if this is a rate limit error
     */
    isRateLimited(): boolean;
    /**
     * Check if this is an authentication error
     */
    isAuthError(): boolean;
    /**
     * Check if this is a permission/access error
     */
    isForbidden(): boolean;
    /**
     * Check if this is a not found error
     */
    isNotFound(): boolean;
    /**
     * Check if this is a validation error
     */
    isValidationError(): boolean;
    /**
     * Check if this is a payment required error
     */
    isPaymentRequired(): boolean;
}
/** @deprecated Use ZernioApiError instead */
declare const LateApiError: typeof ZernioApiError;
/**
 * Rate limit error with additional rate limit info
 */
declare class RateLimitError extends ZernioApiError {
    readonly limit?: number;
    readonly remaining?: number;
    readonly resetAt?: Date;
    constructor(message: string, limit?: number, remaining?: number, resetAt?: Date);
    /**
     * Get seconds until rate limit resets
     */
    getSecondsUntilReset(): number | undefined;
}
/**
 * Validation error with field-specific details
 */
declare class ValidationError extends ZernioApiError {
    readonly fields?: Record<string, string[]>;
    constructor(message: string, fields?: Record<string, string[]>);
}
/**
 * Parse an error response from the API
 */
declare function parseApiError(response: Response, body?: {
    error?: string;
    message?: string;
    code?: string;
    details?: Record<string, unknown>;
}): ZernioApiError;

type AccountsListResponse = {
    accounts: Array<SocialAccount>;
    /**
     * Whether user has analytics add-on access
     */
    hasAnalyticsAccess: boolean;
    /**
     * Only present when page/limit params are provided
     */
    pagination?: Pagination;
};
type AccountWithFollowerStats = SocialAccount & {
    /**
     * Current follower count
     */
    currentFollowers?: number;
    lastUpdated?: string;
    /**
     * Follower change over period
     */
    growth?: number;
    /**
     * Percentage growth
     */
    growthPercentage?: number;
    /**
     * Number of historical snapshots
     */
    dataPoints?: number;
    /**
     * Platform-specific account stats from the latest daily snapshot.
     * Fields vary by platform. Only present if metadata has been captured.
     *
     */
    accountStats?: {
        /**
         * Number of accounts being followed
         */
        followingCount?: number;
        /**
         * Total media posts (Instagram)
         */
        mediaCount?: number;
        /**
         * Total videos (YouTube, TikTok)
         */
        videoCount?: number;
        /**
         * Total tweets (X/Twitter)
         */
        tweetCount?: number;
        /**
         * Total posts (Bluesky)
         */
        postsCount?: number;
        /**
         * Total pins (Pinterest)
         */
        pinCount?: number;
        /**
         * Total channel views (YouTube)
         */
        totalViews?: number;
        /**
         * Total likes received (TikTok)
         */
        likesCount?: number;
        /**
         * Monthly profile views (Pinterest)
         */
        monthlyViews?: number;
        /**
         * Lists the user appears on (X/Twitter)
         */
        listedCount?: number;
        /**
         * Total boards (Pinterest)
         */
        boardCount?: number;
    };
};
type Ad = {
    _id?: string;
    name?: string;
    platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
    /**
     * Delivery status. Derived from the platform `effective_status`, so it inherits ancestor pauses (an ACTIVE ad under a PAUSED campaign reads `paused`). For the ad's own on/off toggle use `configuredStatus`; for the review state use `reviewStatus`.
     */
    status?: (AdStatus);
    /**
     * The ad's own on/off toggle as configured on the platform (Meta `configured_status`: ACTIVE / PAUSED), unaffected by ancestor (ad set / campaign) pauses. Distinct from `status`, which is the ancestor-cascaded delivery status. Only present for Meta ads synced after this field was added.
     */
    configuredStatus?: (string) | null;
    /**
     * Platform review state of this ad, independent of delivery `status` / `configuredStatus`. Absent when the platform reports no review signal.
     */
    reviewStatus?: (AdReviewStatus);
    adType?: 'boost' | 'standalone';
    /**
     * Creative format, classified from the media the creative carries. `null` when the creative carries no media to classify — an unsynced creative and a genuine text-only ad are indistinguishable, so neither is guessed at. Returned by `GET /v1/ads`, `GET /v1/ads/{adId}` and the ad nodes of `GET /v1/ads/tree`.
     */
    creativeType?: ('carousel' | 'video' | 'document' | 'image') | null;
    /**
     * Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
     */
    goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
    /**
     * True for ads synced from platform ad managers
     */
    isExternal?: boolean;
    budget?: {
        amount?: number;
        type?: 'daily' | 'lifetime';
    } | null;
    metrics?: (AdMetrics | null);
    platformAdId?: string;
    platformAdAccountId?: string;
    platformCampaignId?: string;
    platformAdSetId?: string;
    campaignName?: string;
    adSetName?: string;
    /**
     * Raw Meta campaign objective (e.g. OUTCOME_SALES, OUTCOME_LEADS, OUTCOME_TRAFFIC). Only present for Meta ads.
     */
    platformObjective?: (string) | null;
    /**
     * What the delivery system optimizes for, at ad-set level. The value space depends on `platform`:
     *
     * - Meta: ad set `optimization_goal` (e.g. OFFSITE_CONVERSIONS, VALUE, LEAD_GENERATION, LINK_CLICKS).
     * - LinkedIn: the campaign's EFFECTIVE `optimizationTargetType`, refreshed from LinkedIn on every
     * sync rather than echoing what was passed on create. `NONE` means manual bidding, and it is a
     * real value, not missing data. Auto-bid values are MAX_IMPRESSION / MAX_CLICK / MAX_CONVERSION /
     * MAX_VIDEO_VIEW / MAX_LEAD / MAX_REACH; target-cost values are TARGET_COST_PER_CLICK /
     * TARGET_COST_PER_IMPRESSION / TARGET_COST_PER_VIDEO_VIEW; cost-cap values are the
     * CAP_COST_AND_MAXIMIZE_* family.
     *
     */
    optimizationGoal?: (string) | null;
    /**
     * LinkedIn only. The campaign's EFFECTIVE cost model (billing event) as applied by LinkedIn,
     * refreshed on every sync rather than echoing what was passed on create. One of `CPM` (cost per
     * thousand impressions), `CPC` (cost per click) or `CPV` (cost per video view). On LinkedIn this is
     * the axis that pairs with `bidAmount`; there is no `bidStrategy`. For campaign type
     * SPONSORED_INMAILS, `CPM` bills as cost-per-send x 1000. `null` for non-LinkedIn ads.
     *
     */
    costType?: (string) | null;
    /**
     * LinkedIn only. Why the parent campaign is (or is not) delivering, verbatim from LinkedIn.
     * A campaign can report `status: ACTIVE` and still serve nothing; this array is what says so.
     *
     * - `[]` means no serving data: a non-LinkedIn ad, or a LinkedIn ad not yet re-synced.
     * - `["RUNNABLE"]` means the campaign is eligible to serve.
     * - Anything else is a hold. Known values include ACCOUNT_SERVING_HOLD, ACCOUNT_TOTAL_BUDGET_HOLD,
     * ACCOUNT_END_DATE_HOLD, CAMPAIGN_START_DATE_HOLD, CAMPAIGN_END_DATE_HOLD,
     * CAMPAIGN_TOTAL_BUDGET_HOLD, CAMPAIGN_AUDIENCE_COUNT_HOLD, CAMPAIGN_GROUP_START_DATE_HOLD,
     * CAMPAIGN_GROUP_END_DATE_HOLD, CAMPAIGN_GROUP_TOTAL_BUDGET_HOLD, CAMPAIGN_GROUP_STATUS_HOLD and
     * STOPPED. The list is open on purpose, so treat unrecognized values as holds rather than errors.
     *
     * The end-date and total-budget holds are terminal and surface as `status: completed`; the rest
     * surface as `status: paused`. Note that a hold is not the only cause of zero delivery: with
     * manual, target-cost or cost-cap bidding, a `bidAmount` of 0 stops delivery while
     * `servingStatuses` still reads `["RUNNABLE"]`. Check `costType` / `bidAmount` /
     * `optimizationGoal` as well.
     *
     */
    servingStatuses?: Array<(string)>;
    /**
     * Human-readable advertiser/account name (Meta `AdAccount.name`, TikTok
     * `advertiser_name`, LinkedIn / X / Pinterest equivalents). Refreshed every
     * sync so platform-side renames propagate within one cycle. `null` when the
     * platform doesn't return a name or the sync hasn't run yet.
     *
     */
    platformAdAccountName?: (string) | null;
    /**
     * Platform-reported creation timestamp (Meta `created_time`, TikTok `create_time`).
     * Distinct from `createdAt` which reflects when Zernio first synced the doc — for
     * sort/filter by "when the ad was actually created on the platform", read this field.
     * `null` for legacy ads synced before this field was added; aggregations fall back
     * to `createdAt` in that case.
     *
     */
    platformCreatedAt?: (string) | null;
    /**
     * Ad-set bid strategy (overrides campaign level on Meta). Populated for Meta and
     * TikTok. TikTok's native `bid_type` is normalized to the cross-platform Meta enum:
     * `BID_TYPE_NO_BID` -> `LOWEST_COST_WITHOUT_CAP`, `BID_TYPE_CUSTOM` ->
     * `LOWEST_COST_WITH_BID_CAP`, deep_bid_type=MIN_ROAS or roas_bid>0 ->
     * `LOWEST_COST_WITH_MIN_ROAS`, `BID_TYPE_MAX_CONVERSION` -> `LOWEST_COST_WITHOUT_CAP`.
     *
     */
    bidStrategy?: (BidStrategy | null);
    /**
     * Bid amount in WHOLE currency units of the ad account (USD: 5 = $5.00; JPY: 100 = ¥100).
     *
     * - Meta source: `bid_amount` on the ad set (smallest-denomination int, decoded here). Populated
     * when bidStrategy is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`; `null` for auto-bid
     * (`LOWEST_COST_WITHOUT_CAP`).
     * - TikTok source: priority order `bid_price` -> `conversion_bid_price` -> `deep_cpa_bid`
     * (whichever is set on the ad group). TikTok stores all three in whole currency units.
     * - LinkedIn source: the campaign's EFFECTIVE `unitCost`, refreshed on every sync rather than
     * echoing what was passed on create. Its meaning depends on the bidding mode implied by
     * `optimizationGoal`: bid amount (manual), target cost, or cost cap. It pairs with `costType`,
     * NOT with `bidStrategy`, which LinkedIn does not have. A value of `0` is a real, delivery-
     * stopping configuration and not "unset", so do not gate this field on `bidStrategy` for
     * LinkedIn ads.
     *
     * Source: facebook-business-sdk-codegen api_specs/specs/AdSet.json (`bid_amount`).
     *
     */
    bidAmount?: (number) | null;
    /**
     * Minimum ROAS as a decimal multiplier (2.0 = 2.0x ROAS). Populated when bidStrategy
     * is `LOWEST_COST_WITH_MIN_ROAS`.
     *
     * - Meta source: decoded from `bid_constraints.roas_average_floor` (Meta stores as
     * fixed-point int × 10000; we return the decimal).
     * - TikTok source: `roas_bid` on the ad group (already a decimal).
     *
     * Source: facebook-business-sdk-codegen api_specs/specs/AdCampaignBidConstraint.json.
     *
     */
    roasAverageFloor?: (number) | null;
    /**
     * Meta promoted object containing conversion event details. Structure varies by objective. Only present for Meta ads.
     */
    promotedObject?: {
        /**
         * Conversion event type (e.g. PURCHASE, LEAD, COMPLETE_REGISTRATION, ADD_TO_CART)
         */
        custom_event_type?: string;
        /**
         * Meta pixel ID
         */
        pixel_id?: string;
        /**
         * Facebook page ID
         */
        page_id?: string;
        /**
         * Facebook app ID
         */
        application_id?: string;
        /**
         * Product catalog set ID
         */
        product_set_id?: string;
    } | null;
    /**
     * Platform-specific creative data. Fields vary by platform.
     */
    creative?: {
        /**
         * Primary thumbnail/image URL
         */
        thumbnailUrl?: (string) | null;
        /**
         * Alternative image URL
         */
        imageUrl?: string;
        /**
         * Meta video ID for VIDEO-type ads. Null for non-video ads. Callers that need an embeddable MP4 can call GET /{videoId}?fields=source with the page access token.
         */
        videoId?: (string) | null;
        /**
         * Public Facebook watch URL for VIDEO-type ads (https://www.facebook.com/watch/?v={videoId}). Null for non-video ads.
         */
        videoUrl?: (string) | null;
        /**
         * Meta ad creative id backing this ad. Reusable via existingCreativeId on POST /v1/ads/create.
         */
        creativeId?: (string) | null;
        /**
         * Meta creative object_type (e.g. SHARE, VIDEO, PRIVACY_CHECK_FAIL, POST_DELETED). Use this to render state-aware previews — when Meta moderation strips image/video fields, only thumbnailUrl at 64x64 is available.
         */
        objectType?: string;
        /**
         * Meta creative `object_story_id` (the SHARE reference). Frequently absent — Meta omits it for SHARE creatives. Use effectiveObjectStoryId instead.
         */
        objectStoryId?: (string) | null;
        /**
         * Meta `effective_object_story_id` — `{pageId}_{postId}` of the Facebook post the ad's engagement (comments) lives on. Pass to GET /v1/ads?effectiveObjectStoryId= to map a Business-Manager-visible post back to this ad; GET /v1/ads/{adId}/comments resolves comments against it.
         */
        effectiveObjectStoryId?: (string) | null;
        /**
         * Facebook Page backing the creative (Meta only). What the `pageId` filter on /v1/ads, /v1/ads/campaigns and /v1/ads/tree matches against. Absent for non-Meta ads and rare Meta creatives with no page signal.
         */
        pageId?: (string) | null;
        /**
         * Meta `effective_instagram_media_id` — the Instagram media ID of the boosted post the ad's engagement lives on. Pass to GET /v1/ads?effectiveInstagramMediaId= to map a Business-Manager-visible IG post back to this ad.
         */
        effectiveInstagramMediaId?: (string) | null;
        /**
         * Meta `instagram_user_id` — the Instagram-scoped business ID that owns the boosted media.
         */
        instagramUserId?: (string) | null;
        /**
         * Meta `instagram_permalink_url` — public Instagram post URL of the boosted media.
         */
        instagramPermalinkUrl?: (string) | null;
        /**
         * All media URLs for this ad (carousel images, multiple assets). Populated for Meta (carousel child_attachments), Google Ads (responsive display marketing_images), and LinkedIn (multi-image posts).
         */
        mediaUrls?: Array<(string)>;
        /**
         * LinkedIn only. Whether LinkedIn is currently serving this specific creative. Complements the ad-level `servingStatuses`, which describes the parent campaign.
         */
        isServing?: (boolean) | null;
        /**
         * LinkedIn only. Why this specific creative is not being served. Empty when it is serving.
         * A superset of the ad-level `servingStatuses`: it repeats the inherited campaign, campaign
         * group and account holds AND adds creative-only causes such as UNDER_REVIEW, REJECTED,
         * PROCESSING, PROCESSING_FAILED, FORM_HOLD (lead-gen-form creatives),
         * REFERRED_CONTENT_QUALITY_HOLD, JOB_POSTING_ON_HOLD and JOB_POSTING_INVALID (job ads).
         * Some values are format-specific and will never appear on other ad formats. The list is
         * open, so treat unrecognized values as holds rather than errors.
         *
         */
        servingHoldReasons?: Array<(string)>;
        /**
         * Ad copy/text
         */
        body?: string;
        /**
         * Google Ads headline
         */
        googleHeadline?: string;
        /**
         * Google Ads description
         */
        googleDescription?: string;
        /**
         * Destination URL
         */
        linkUrl?: string;
        pinterestImageUrl?: string;
        pinterestTitle?: string;
        pinterestDescription?: string;
    } | null;
    /**
     * The ad set's targeting (age, gender, geo, interests, placements, audience inclusions/exclusions).
     * For ads created through Zernio this is the spec you supplied. For external ads (synced from
     * Meta Ads Manager, `isExternal: true`) targeting lives at the ad set and isn't stored at ingest,
     * so on the first `GET /v1/ads/{adId}` Zernio resolves it live from Meta and caches it on the ad;
     * the value is then Meta's raw `targeting` shape (snake_case, e.g. `geo_locations`, `age_min`),
     * the same object Ads Manager shows. May be absent if the ad set exposes no targeting or the lookup fails.
     *
     */
    targeting?: {
        [key: string]: unknown;
    };
    schedule?: {
        startDate?: string;
        endDate?: string;
    } | null;
    rejectionReason?: string;
    createdAt?: string;
    updatedAt?: string;
};
type platform = 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
type adType = 'boost' | 'standalone';
/**
 * Creative format, classified from the media the creative carries. `null` when the creative carries no media to classify — an unsynced creative and a genuine text-only ad are indistinguishable, so neither is guessed at. Returned by `GET /v1/ads`, `GET /v1/ads/{adId}` and the ad nodes of `GET /v1/ads/tree`.
 */
type creativeType = 'carousel' | 'video' | 'document' | 'image';
/**
 * Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
 */
type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
type type = 'daily' | 'lifetime';
type AdAnalyticsResponse = {
    /**
     * Present and true while historical data is being backfilled.
     */
    backfillPending?: boolean;
    ad?: {
        id?: string;
        name?: string;
        platform?: string;
        status?: string;
        /**
         * ISO 4217 code of the ad account that owns this ad (e.g. USD, THB, INR). All money values in `summary` and `daily` are in this currency. Null only on legacy ads synced before currency was persisted.
         */
        currency?: (string) | null;
    };
    analytics?: {
        summary?: AdMetrics;
        daily?: Array<(AdMetrics & {
            date?: string;
        })>;
        breakdowns?: {
            [key: string]: Array<{
                [key: string]: unknown;
            }>;
        };
    };
};
/**
 * Budget amount in the ad account's native currency (see the campaign's `currency` field for the code).
 */
type AdBudget = {
    amount: number;
    type: 'daily' | 'lifetime';
};
type AdCampaign = {
    platformCampaignId?: string;
    platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
    campaignName?: string;
    /**
     * Delivery status derived from child ad statuses. Distinct from `reviewStatus`.
     */
    status?: (AdStatus);
    /**
     * Platform-side review state of the campaign. See AdTreeCampaign.reviewStatus for the full description.
     */
    reviewStatus?: (AdReviewStatus | null);
    /**
     * Raw platform-level campaign status (Meta `effective_status`).
     */
    platformCampaignStatus?: (string) | null;
    /**
     * Platform-reported campaign issues (Meta `issues_info[]`).
     */
    campaignIssuesInfo?: Array<{
        [key: string]: unknown;
    }> | null;
    adCount?: number;
    /**
     * Effective budget (back-compat). Use `budgetLevel` to disambiguate CBO vs ABO.
     */
    budget?: {
        amount?: number;
        type?: 'daily' | 'lifetime';
    } | null;
    /**
     * Campaign-level budget (CBO). Null for ABO campaigns.
     */
    campaignBudget?: {
        amount?: number;
        type?: 'daily' | 'lifetime';
    } | null;
    /**
     * Canonical CBO/ABO indicator. See AdTreeCampaign.budgetLevel.
     */
    budgetLevel?: ('campaign' | 'adset') | null;
    /**
     * Meta-only. Mirrors Campaign.is_budget_schedule_enabled.
     */
    isBudgetScheduleEnabled?: boolean;
    /**
     * ISO 4217 currency code for all budget amounts. Budgets are NOT normalized to USD.
     */
    currency?: (string) | null;
    metrics?: AdMetrics;
    platformAdAccountId?: string;
    /**
     * Human-readable advertiser/account name from the platform. Refreshed on every sync.
     */
    platformAdAccountName?: (string) | null;
    accountId?: string;
    profileId?: string;
    /**
     * Google-only. Raw campaign.advertising_channel_type. See AdTreeCampaign.advertisingChannelType.
     */
    advertisingChannelType?: (string) | null;
    /**
     * Raw Meta campaign objective (e.g. OUTCOME_SALES, OUTCOME_LEADS, OUTCOME_TRAFFIC)
     */
    platformObjective?: (string) | null;
    /**
     * Optimization goal shared across ad sets, or comma-separated values when ad sets differ. Meta: e.g. OFFSITE_CONVERSIONS, VALUE, LEAD_GENERATION. LinkedIn: the campaign optimizationTargetType (e.g. MAX_CLICK, MAX_IMPRESSION, NONE); `NONE` with a manual costType is a campaign LinkedIn will not deliver.
     */
    optimizationGoal?: (string) | null;
    /**
     * Campaign-level bid strategy. Ad sets inherit this unless they override.
     */
    bidStrategy?: (BidStrategy | null);
    /**
     * Representative bid from the top-spending ad set (whole currency units). Meta: populated when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. LinkedIn: the campaign unitCost, ungated, where 0 is a real delivery-stopping value.
     */
    bidAmount?: (number) | null;
    /**
     * Representative ROAS floor from the top-spending ad set. Decimal multiplier (2.0 = 2.0x).
     */
    roasAverageFloor?: (number) | null;
    /**
     * Meta promoted object at campaign level (conversion event details)
     */
    promotedObject?: {
        custom_event_type?: string;
        pixel_id?: string;
        page_id?: string;
    } | null;
    earliestAd?: string;
    latestAd?: string;
};
/**
 * Canonical CBO/ABO indicator. See AdTreeCampaign.budgetLevel.
 */
type budgetLevel = 'campaign' | 'adset';
/**
 * One day of metrics. Same fields as `AdMetrics` plus the `date` they
 * apply to. Returned inside a node's `daily[]` when `GET /v1/ads/tree` is
 * called with `timeIncrement=1`. Rate metrics (ctr/cpc/cpm/costPerConversion/
 * roas/videoAvgTimeWatchedActions) are recomputed per day from that day's
 * sums, so summing the additive fields across a node's `daily[]` reproduces
 * its aggregated `metrics` total. `reach` is the exception: on Meta and
 * TikTok the aggregated total is de-duplicated across the range, so daily
 * reach does not sum to it. Do NOT sum or plain-average
 * `videoAvgTimeWatchedActions` across days: the range value is the
 * play-weighted average of the daily values.
 *
 */
type AdDailyMetrics = AdMetrics & {
    /**
     * Calendar day (YYYY-MM-DD) these metrics apply to.
     */
    date?: string;
};
/**
 * The single `engagement` total split into the interactions behind it.
 *
 * Note that `engagement` is not the sum of these: Meta's own
 * `post_engagement` and `page_engagement` totals already contain the
 * individual interactions, and all of them are counted into `engagement`.
 * Use these fields when you need a specific interaction, and `engagement`
 * only as the coarse total it has always been.
 *
 * Populated for Meta and, since 2026-08, TikTok (`reactions` = paid
 * likes, `comments`, `shares`; TikTok's `follow` count lives in
 * `actions.follow`, not here). Other platforms leave these at 0.
 * TikTok history note: paused TikTok ads are not re-synced, so
 * campaigns that ended before the rollout keep 0s here.
 *
 */
type AdEngagementCounts = {
    /**
     * Meta's own post-engagement total (`post_engagement`). Meta-only.
     */
    postEngagement?: number;
    /**
     * Meta's own page-engagement total (`page_engagement`). Meta-only.
     */
    pageEngagement?: number;
    /**
     * Reactions on the ad's post (`post_reaction`). For TikTok these are its paid likes.
     */
    reactions?: number;
    /**
     * Comments on the ad's post.
     */
    comments?: number;
    /**
     * Shares of the ad's post. Meta reports these under the action type literally named `post`; TikTok under `share`.
     */
    shares?: number;
    /**
     * Saves of the ad's post (`onsite_conversion.post_save`).
     */
    saves?: number;
    /**
     * New Page likes attributed to the ad (`like`).
     */
    pageLikes?: number;
    /**
     * 3-second video views (`video_view`). For completion-based counts use `videoThruplayWatchedActions`.
     */
    videoViews?: number;
    /**
     * Attributed link clicks (`link_click`). This is the attribution-window count, which differs from the in-session count in the sibling `inlineLinkClicks` field.
     */
    linkClicks?: number;
};
/**
 * Named conversion-funnel steps, resolved from the same data as `actions`
 * so you never have to parse action-type strings yourself.
 *
 * Meta reports one event under several action types at once
 * (`offsite_conversion.fb_pixel_purchase`, `omni_purchase`, `purchase`, …).
 * Each field below takes the FIRST family member present rather than
 * summing them, which is what makes these counts safe to add up — summing
 * the raw `actions` keys yourself double or triple counts. The same
 * priority order backs `conversions`, so a purchase-optimised campaign
 * reports the identical number in `conversions` and `funnel.purchases`.
 *
 * Every field is 0 when that step never fired. Populated for Meta ads;
 * other platforms report a different action taxonomy and generally leave
 * these at 0 (read `actions` for those). At ad-set and campaign level each
 * step is summed from its per-ad values.
 *
 */
type AdFunnelCounts = {
    /**
     * Landing page views — the visitor actually loaded the destination, unlike a link click. Meta `landing_page_view`.
     */
    landingPageViews?: number;
    /**
     * Content views (Meta `ViewContent` pixel event).
     */
    contentViews?: number;
    /**
     * On-site searches (Meta `Search` pixel event).
     */
    searches?: number;
    /**
     * Adds to wishlist (Meta `AddToWishlist` pixel event).
     */
    wishlistAdds?: number;
    /**
     * Adds to cart (Meta `AddToCart` pixel event).
     */
    cartAdds?: number;
    /**
     * Checkouts started (Meta `InitiateCheckout` pixel event).
     */
    checkoutsInitiated?: number;
    /**
     * Payment details added at checkout (Meta `AddPaymentInfo` pixel event).
     */
    paymentInfoAdds?: number;
    /**
     * Purchases (Meta `Purchase` pixel event). Pair with `purchaseValue` for revenue.
     */
    purchases?: number;
    /**
     * Leads, from either the website pixel or an instant form — whichever the ad uses.
     */
    leads?: number;
    /**
     * Completed registrations (Meta `CompleteRegistration` pixel event).
     */
    registrationsCompleted?: number;
    /**
     * Mobile app installs attributed to the ad.
     */
    appInstalls?: number;
    /**
     * Messaging conversations started within 7 days — the headline metric for click-to-WhatsApp and click-to-Messenger ads.
     */
    messagingConversationsStarted?: number;
    /**
     * Messaging threads where the person sent a first reply.
     */
    messagingFirstReplies?: number;
};
type AdMetrics = {
    spend?: number;
    impressions?: number;
    /**
     * Unique people reached in the requested date range. Meta (facebook/instagram) and TikTok: the platform's own de-duplicated reach for the exact range, fetched live and cached up to ~1 hour (may lag recent delivery; on a transient platform error the value temporarily falls back to a sum of per-day reach, which overcounts people reached on multiple days or by multiple child ads). Because it is de-duplicated, reach is NOT additive on these platforms: neither daily values nor child nodes sum to the range total. Google, LinkedIn, X, Pinterest and OpenAI report 0 (reach not synced). Frequency (impressions / reach) is only meaningful for Meta and TikTok.
     */
    reach?: number;
    clicks?: number;
    /**
     * Click-through rate (%)
     */
    ctr?: number;
    /**
     * Cost per click
     */
    cpc?: number;
    /**
     * Cost per 1000 impressions
     */
    cpm?: number;
    engagement?: number;
    /**
     * Count of conversion events over the requested date range. FRACTIONAL: attribution splits one conversion across touchpoints and Google additionally reports modeled conversions, so values like 0.347 are normal. Meta: events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.). Google: the account's tracked conversions. X and LinkedIn: their reported website/lead conversions (added 2026-07). 0 for non-conversion campaigns or when no events have fired.
     */
    conversions?: number;
    /**
     * Derived spend / conversions in the same currency as spend. 0 when conversions is 0.
     */
    costPerConversion?: number;
    /**
     * Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. TikTok: pixel conversions (purchase, add_to_cart, initiate_checkout, view_content, complete_payment, lead) plus the paid-engagement family (follow, post_reaction for paid likes, comment, share) — follow is how FOLLOWERS-goal campaigns report their result. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
     */
    actions?: {
        [key: string]: (number);
    };
    /**
     * Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying — values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta-only; other platforms return {}.
     */
    actionValues?: {
        [key: string]: (number);
    };
    /**
     * Convenience sum of purchase-type action values — picked from `actionValues` via the same priority list as `conversions` so both fields describe the same events. In ad-account native currency. 0 when the campaign has no purchase event configured. Meta-only.
     */
    purchaseValue?: number;
    /**
     * Return on ad spend — derived as `purchaseValue / spend`. 0 when `spend` is 0. Equivalent to Meta's `purchase_roas` under default attribution. At ad-set and campaign levels this is recomputed from summed purchaseValue + spend (NOT averaged across children) so it's mathematically correct at every rollup level.
     */
    roas?: number;
    /**
     * Derived `spend / actions[type]` for every action type with a non-zero count, in ad-account native currency. Same keys as `actions`. Rounded to 4 decimals because cheap actions cost well under a cent. Recomputed from summed spend + counts at every rollup level. Empty object when spend is 0 or no actions are reported.
     */
    costPerAction?: {
        [key: string]: (number);
    };
    /**
     * Clicks leading off Meta's surfaces to the advertiser's destination. Meta-only; other platforms report 0.
     */
    outboundClicks?: number;
    /**
     * Derived `outboundClicks / impressions * 100`, recomputed from sums at every rollup level.
     */
    outboundClicksCtr?: number;
    /**
     * In-session link clicks. Differs from the attributed `link_click` count in `actions`/`engagementBreakdown.linkClicks`, which uses the attribution window. Meta-only.
     */
    inlineLinkClicks?: number;
    /**
     * Derived `inlineLinkClicks / impressions * 100`, recomputed from sums at every rollup level.
     */
    inlineLinkClickCtr?: number;
    /**
     * People who clicked at least once. NOT additive: summed across days/children it overcounts people who clicked on multiple days or ads, so treat rollups as an upper bound (same caveat as `reach`). Meta-only.
     */
    uniqueClicks?: number;
    /**
     * Derived `uniqueClicks / impressions * 100` (NOT Meta's reach-based unique_ctr). Inherits the non-additivity caveat of `uniqueClicks`.
     */
    uniqueCtr?: number;
    /**
     * Number of times the video started playing, summed over the date range and across children at ad-set/campaign level. 0 for non-video ads. Sources: Meta `video_play_actions`, TikTok `video_play_actions`.
     */
    videoPlayActions?: number;
    /**
     * Views of at least 30 seconds (or to the end, for shorter videos). Sources: Meta `video_30_sec_watched_actions` (Meta only).
     */
    video30SecWatchedActions?: number;
    /**
     * ThruPlays (watched to completion, or at least 15 seconds). Sources: Meta `video_thruplay_watched_actions` (Meta only).
     */
    videoThruplayWatchedActions?: number;
    /**
     * Views reaching 25% of the video's length. With the other percentile fields, powers hook/hold/drop-off analysis (e.g. hook rate = videoP25WatchedActions / videoPlayActions). Sources: Meta `video_p25_watched_actions`, TikTok `video_views_p25`.
     */
    videoP25WatchedActions?: number;
    /**
     * Views reaching 50% of the video's length. Sources: Meta `video_p50_watched_actions`, TikTok `video_views_p50`.
     */
    videoP50WatchedActions?: number;
    /**
     * Views reaching 75% of the video's length. Sources: Meta `video_p75_watched_actions`, TikTok `video_views_p75`.
     */
    videoP75WatchedActions?: number;
    /**
     * Views reaching 95% of the video's length. Sources: Meta `video_p95_watched_actions` (Meta only).
     */
    videoP95WatchedActions?: number;
    /**
     * Views reaching 100% of the video's length. Sources: Meta `video_p100_watched_actions`, TikTok `video_views_p100`.
     */
    videoP100WatchedActions?: number;
    /**
     * Average seconds watched per play. Aggregated over date ranges and across children as a play-weighted average (total watch time / total plays), never a plain average of averages. Sources: Meta `video_avg_time_watched_actions`, TikTok `average_video_play`.
     */
    videoAvgTimeWatchedActions?: number;
    /**
     * Derived `spend / videoThruplayWatchedActions`, in ad-account native currency. Rounded to 4 decimals rather than the usual 2 because a ThruPlay routinely costs well under a cent. 0 when the ad has no ThruPlays (ThruPlay is Meta-only).
     */
    costPerThruplay?: number;
    funnel?: AdFunnelCounts;
    engagementBreakdown?: AdEngagementCounts;
    /**
     * Present on individual ads only, not on campaign aggregations
     */
    lastSyncedAt?: string;
};
/**
 * Platform-side review state, independent of the delivery `status` and the `configuredStatus` on/off toggle. `in_review` means the platform is still reviewing. Absent when the platform reports no review signal (e.g. a paused ad whose review state is masked behind the pause).
 */
type AdReviewStatus = 'in_review' | 'approved' | 'rejected' | 'with_issues';
type AdsListResponse = {
    ads?: Array<Ad>;
    pagination?: Pagination;
    /**
     * Present and true while historical data is being backfilled.
     */
    backfillPending?: boolean;
};
type AdStatus = 'active' | 'paused' | 'pending_review' | 'rejected' | 'completed' | 'cancelled' | 'error';
type AdsTimelineResponse = {
    /**
     * Present and true while historical data is being backfilled.
     */
    backfillPending?: boolean;
    rows?: Array<{
        date?: string;
        /**
         * Native currency units (matches /ads/tree convention).
         */
        spend?: number;
        impressions?: number;
        /**
         * Reach summed across the account's ads for this single day. A person seen by two ads the same day counts twice, and reach is de-duplicated per day only: do NOT sum it across days (people reached on multiple days would be double-counted).
         */
        reach?: number;
        clicks?: number;
        engagement?: number;
        /**
         * Click-through rate as a percentage (0–100).
         */
        ctr?: number;
        /**
         * Cost per click in native currency.
         */
        cpc?: number;
        /**
         * Cost per 1000 impressions in native currency.
         */
        cpm?: number;
        /**
         * Sum of conversion events over the range. Fractional values are normal (attribution splitting + Google modeled conversions). Meta: events matching the campaign optimization goal. Google: tracked conversions. X / LinkedIn: reported website/lead conversions (added 2026-07).
         */
        conversions?: number;
        costPerConversion?: number;
        /**
         * Per-action-type counts merged across all ads on this day. Keys are platform-native action types.
         */
        actions?: {
            [key: string]: (number);
        };
        /**
         * Monetary mirror of `actions` in native currency.
         */
        actionValues?: {
            [key: string]: (number);
        };
        /**
         * Sum of purchase-type action values on this day, native currency.
         */
        purchaseValue?: number;
        /**
         * Derived purchaseValue / spend.
         */
        roas?: number;
    }>;
};
/**
 * Ad set (or ad group/line item depending on platform) with rolled-up metrics and child ads
 */
type AdTreeAdSet = {
    platformAdSetId?: string;
    adSetName?: string;
    /**
     * Derived from child ad statuses
     */
    status?: (AdStatus);
    adCount?: number;
    /**
     * Effective budget at this level (back-compat). For CBO campaigns this mirrors the parent campaign's budget; for ABO this is the ad-set-specific budget. Use `adSetBudget` / parent `campaignBudget` + `budgetLevel` to disambiguate.
     */
    budget?: {
        amount?: number;
        type?: 'daily' | 'lifetime';
    } | null;
    /**
     * Ad-set-level budget (ABO). Null for CBO campaigns where the budget is set on the campaign.
     */
    adSetBudget?: {
        amount?: number;
        type?: 'daily' | 'lifetime';
    } | null;
    metrics?: 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.
     */
    optimizationGoal?: (string) | null;
    /**
     * Bid strategy for this ad set (overrides campaign level when set). Meta and TikTok only; LinkedIn uses `costType` instead.
     */
    bidStrategy?: (BidStrategy | null);
    /**
     * Bid amount in whole currency units. On Meta/TikTok populated when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP; on LinkedIn it is the campaign's effective unitCost and pairs with `costType`, where 0 is a real, delivery-stopping value.
     */
    bidAmount?: (number) | null;
    /**
     * Minimum ROAS as a decimal multiplier (2.0 = 2.0x). Populated when bidStrategy is LOWEST_COST_WITH_MIN_ROAS.
     */
    roasAverageFloor?: (number) | null;
    /**
     * LinkedIn only. Effective cost model (billing event) of the LinkedIn campaign backing this ad set: CPM, CPC or CPV. Null for non-LinkedIn ad sets.
     */
    costType?: (string) | null;
    /**
     * LinkedIn only. Why the LinkedIn campaign backing this ad set is (or is not) delivering. A LinkedIn Campaign maps to this ad-set node, so this is the level where LinkedIn's holds actually apply. Empty means no serving data, ["RUNNABLE"] means eligible to serve, anything else is a hold. See the `servingStatuses` field on `Ad` for the known values.
     */
    servingStatuses?: Array<(string)>;
    /**
     * Meta promoted object for this ad set (conversion event details)
     */
    promotedObject?: {
        custom_event_type?: string;
        pixel_id?: string;
        page_id?: string;
    } | null;
    /**
     * Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation: `_id`, `name`, `platform`, `status`, `configuredStatus`, `reviewStatus`, `budget`, `metrics`, `creative`, `goal` and the `platform*` ids are always included; `targeting` and `schedule` may be absent. `configuredStatus` (the ad's own on/off toggle) and `reviewStatus` (the platform's review verdict) are part of this contract, not incidental: a rejected ad is only distinguishable from a healthy one through `reviewStatus`. When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
     */
    ads?: Array<Ad>;
    /**
     * Per-day metric series for this ad set. Present only when `GET /v1/ads/tree` is called with `timeIncrement=1` and `dailyLevel` is `adset` or `ad`.
     */
    daily?: Array<AdDailyMetrics>;
};
/**
 * Campaign with nested ad sets and rolled-up metrics
 */
type AdTreeCampaign = {
    platformCampaignId?: string;
    platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
    campaignName?: string;
    /**
     * Delivery status derived from child ad statuses. Distinct from `reviewStatus`, which reflects the platform-side review state.
     */
    status?: (AdStatus);
    /**
     * Platform-side review state of the campaign. Independent of the
     * children-derived delivery `status`: a campaign can have ads
     * already active (status=active) while the campaign itself is
     * still being reviewed by the platform (reviewStatus=in_review).
     * For Meta, derived from `effective_status` + `issues_info` on
     * the Campaign, plus ad-level PENDING_REVIEW rollup.
     *
     */
    reviewStatus?: (AdReviewStatus | null);
    /**
     * Raw platform-level campaign status (Meta `effective_status`: ACTIVE, PAUSED, DELETED, ARCHIVED, IN_PROCESS, WITH_ISSUES). Distinct from per-ad `platformStatus`.
     */
    platformCampaignStatus?: (string) | null;
    /**
     * Platform-reported campaign issues (Meta `issues_info[]`). Populated only when the platform has delivery issues to report; contains the specific error codes and messages.
     */
    campaignIssuesInfo?: Array<{
        [key: string]: unknown;
    }> | null;
    /**
     * Total ads across all ad sets
     */
    adCount?: number;
    adSetCount?: number;
    /**
     * Effective budget (back-compat). For CBO this mirrors `campaignBudget`, for ABO this mirrors the child ad-set budget. Use `budgetLevel` to disambiguate.
     */
    budget?: {
        amount?: number;
        type?: 'daily' | 'lifetime';
    } | null;
    /**
     * Campaign-level budget (Campaign Budget Optimization / CBO). Populated only when the platform set the budget at the campaign level. For ABO campaigns this is null and the budget lives on the child ad set.
     */
    campaignBudget?: {
        amount?: number;
        type?: 'daily' | 'lifetime';
    } | null;
    /**
     * Canonical CBO/ABO indicator. `campaign` = CBO (Advantage Campaign Budget, budget lives on the campaign). `adset` = ABO (budget lives on each ad set). Route budget updates to the matching Meta entity.
     */
    budgetLevel?: ('campaign' | 'adset') | null;
    /**
     * Meta-only. Mirrors Campaign.is_budget_schedule_enabled — true when the campaign uses budget scheduling (time-based budget changes). Independent of CBO/ABO.
     */
    isBudgetScheduleEnabled?: boolean;
    /**
     * ISO 4217 currency code (e.g. USD, EUR, CLP, JPY) for all budget amounts in this campaign node. Budgets are NOT normalized to USD.
     */
    currency?: (string) | null;
    metrics?: AdMetrics;
    platformAdAccountId?: string;
    /**
     * Human-readable advertiser/account name from the platform. Refreshed on every sync.
     */
    platformAdAccountName?: (string) | null;
    accountId?: string;
    profileId?: string;
    /**
     * Google-only. Raw campaign.advertising_channel_type (SEARCH, PERFORMANCE_MAX, LOCAL_SERVICES, VIDEO, DEMAND_GEN, DISPLAY, SHOPPING, ...). Serving surface, distinct from platformObjective (advertiser intent). Null/absent for non-Google platforms.
     */
    advertisingChannelType?: (string) | null;
    /**
     * Raw Meta campaign objective (e.g. OUTCOME_SALES, OUTCOME_LEADS, OUTCOME_TRAFFIC)
     */
    platformObjective?: (string) | null;
    /**
     * Optimization goal shared across ad sets, or comma-separated values when ad sets differ. Meta: e.g. OFFSITE_CONVERSIONS, VALUE, LEAD_GENERATION. LinkedIn: the campaign optimizationTargetType (e.g. MAX_CLICK, MAX_IMPRESSION, NONE); `NONE` with a manual costType is a campaign LinkedIn will not deliver.
     */
    optimizationGoal?: (string) | null;
    /**
     * Campaign-level bid strategy. Ad sets inherit this unless they override.
     */
    bidStrategy?: (BidStrategy | null);
    /**
     * Representative bid for the campaign, bubbled up from the top-spending ad set (whole currency units). Meta: populated when the ad-set bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. LinkedIn: the campaign unitCost, which has no bidStrategy gate and where 0 is a real, delivery-stopping value rather than unset.
     */
    bidAmount?: (number) | null;
    /**
     * Representative ROAS floor for the campaign — bubbled up from the top-spending ad set. Decimal multiplier (2.0 = 2.0x).
     */
    roasAverageFloor?: (number) | null;
    /**
     * Meta promoted object at campaign level (conversion event details)
     */
    promotedObject?: {
        custom_event_type?: string;
        pixel_id?: string;
        page_id?: string;
    } | null;
    adSets?: Array<AdTreeAdSet>;
    /**
     * Per-day metric series for this campaign. Present only when `GET /v1/ads/tree` is called with `timeIncrement=1` (any `dailyLevel`). This is the per-campaign daily trend — summing its additive fields reproduces the campaign `metrics` total, except `reach`: on Meta the range total is de-duplicated, so daily reach does not sum to it.
     */
    daily?: Array<AdDailyMetrics>;
};
type AdTreeResponse = {
    campaigns?: Array<AdTreeCampaign>;
    pagination?: Pagination;
    /**
     * Present and true while historical data is being backfilled.
     */
    backfillPending?: boolean;
};
type AnalyticsListResponse = {
    overview?: AnalyticsOverview;
    posts?: Array<{
        _id?: string;
        /**
         * Original Zernio post ID if scheduled via Zernio
         */
        latePostId?: (string) | null;
        content?: string;
        scheduledFor?: string;
        publishedAt?: string;
        status?: string;
        analytics?: PostAnalytics;
        platforms?: Array<PlatformAnalytics>;
        platform?: string;
        platformPostUrl?: string;
        isExternal?: boolean;
        profileId?: (string) | null;
        thumbnailUrl?: string;
        mediaType?: 'image' | 'video' | 'gif' | 'document' | 'carousel' | 'text';
        /**
         * All media items for this post. Carousel posts contain one entry per slide.
         */
        mediaItems?: Array<{
            type?: 'image' | 'video';
            /**
             * Direct URL to the media
             */
            url?: string;
            /**
             * Thumbnail URL (same as url for images)
             */
            thumbnail?: string;
            /**
             * Accessibility alt text set on the media, when present.
             */
            altText?: string;
        }>;
        /**
         * Instagram only: the platform media product type (e.g. FEED, REELS, STORY, AD). Absent when the platform did not report it.
         */
        mediaProductType?: string;
        /**
         * Instagram only: whether Instagram labeled the media as AI-generated. Absent when the platform did not report it.
         */
        isAiGenerated?: boolean;
        /**
         * Instagram reels only: whether the reel is also shared to the main feed. Absent when the platform did not report it.
         */
        isSharedToFeed?: boolean;
        /**
         * Instagram only: audio type of the media (MUSIC or ORIGINAL_SOUND). Absent when the platform did not report it.
         */
        mediaAudioType?: string;
    }>;
    pagination?: Pagination;
    /**
     * Connected social accounts (followerCount and followersLastUpdated only included if user has analytics add-on)
     */
    accounts?: Array<SocialAccount>;
    /**
     * Whether user has analytics add-on access
     */
    hasAnalyticsAccess?: boolean;
};
type AnalyticsOverview = {
    totalPosts?: number;
    publishedPosts?: number;
    scheduledPosts?: number;
    lastSync?: (string) | null;
    dataStaleness?: {
        /**
         * Number of accounts with stale analytics data
         */
        staleAccountCount?: number;
        /**
         * Whether a background sync was triggered for stale accounts
         */
        syncTriggered?: boolean;
    };
};
type AnalyticsSinglePostResponse = {
    postId?: string;
    /**
     * Original Zernio post ID if scheduled via Zernio
     */
    latePostId?: (string) | null;
    /**
     * Overall post status. "partial" when some platforms published and others failed.
     */
    status?: 'published' | 'failed' | 'partial';
    content?: string;
    scheduledFor?: string;
    publishedAt?: (string) | null;
    analytics?: PostAnalytics;
    platformAnalytics?: Array<PlatformAnalytics>;
    platform?: string;
    platformPostUrl?: (string) | null;
    isExternal?: boolean;
    /**
     * Overall sync state across all platforms
     */
    syncStatus?: 'synced' | 'pending' | 'partial' | 'unavailable';
    /**
     * Human-readable status message for pending, partial, or failed states
     */
    message?: (string) | null;
    thumbnailUrl?: (string) | null;
    mediaType?: ('image' | 'video' | 'carousel' | 'text') | null;
    /**
     * All media items for this post. Carousel posts contain one entry per slide.
     */
    mediaItems?: Array<{
        type?: 'image' | 'video';
        /**
         * 'Direct URL to the media file. Null when the platform withholds it: check mediaStatus before downloading. Instagram omits the video file for Reels it flags as containing copyrighted material (its docs name audio as the usual cause), so type stays "video" while the file is permanently unreachable.'
         */
        url?: (string) | null;
        /**
         * Thumbnail URL (same as url for images). Still present when url is null.
         */
        thumbnail?: (string) | null;
        /**
         * Accessibility alt text set on the media, when present.
         */
        altText?: string;
        /**
         * unavailable means the media file could not be retrieved (url is null or, for LinkedIn videos, a cover image standing in for the file). available or absent means the file is available at url (older synced items omit the field).
         */
        mediaStatus?: 'available' | 'unavailable';
        /**
         * Why the file is missing. platform_withheld means the platform declined to return it and retrying will not help.
         */
        unavailableReason?: 'platform_withheld';
    }>;
    /**
     * Instagram only: the platform media product type (e.g. FEED, REELS, STORY, AD). Absent when the platform did not report it.
     */
    mediaProductType?: string;
    /**
     * Instagram only: whether Instagram labeled the media as AI-generated. Absent when the platform did not report it.
     */
    isAiGenerated?: boolean;
    /**
     * Instagram reels only: whether the reel is also shared to the main feed. Absent when the platform did not report it.
     */
    isSharedToFeed?: boolean;
    /**
     * Instagram only: audio type of the media (MUSIC or ORIGINAL_SOUND). Absent when the platform did not report it.
     */
    mediaAudioType?: string;
};
/**
 * Overall post status. "partial" when some platforms published and others failed.
 */
type status = 'published' | 'failed' | 'partial';
/**
 * Overall sync state across all platforms
 */
type syncStatus = 'synced' | 'pending' | 'partial' | 'unavailable';
type mediaType = 'image' | 'video' | 'carousel' | 'text';
type ApiKey = {
    id?: string;
    name?: string;
    keyPreview?: string;
    expiresAt?: string;
    createdAt?: string;
    /**
     * Returned only once, on creation
     */
    key?: string;
    /**
     * 'full' grants access to all profiles, 'profiles' restricts to specific profiles
     */
    scope?: 'full' | 'profiles';
    /**
     * Profiles this key can access (populated with name and color). Only present when scope is 'profiles'.
     */
    profileIds?: Array<{
        _id?: string;
        name?: string;
        color?: string;
    }>;
    /**
     * 'read-write' allows all operations, 'read' restricts to GET requests only
     */
    permission?: 'read-write' | 'read';
    /**
     * Resource groups this key can NOT access (opt-out denylist). Absent or empty means legacy full access. A key with any group disabled is a restricted key (zrk_ prefix) and can never manage API keys, invites, or member identity. Each operation's group is published as x-resource-group. With 'messages' disabled, the key cannot read or send private messages through any API surface, and it cannot create or edit a webhook subscription broader than itself: it cannot subscribe to, test-fire, redeliver, or read delivery logs for message events. Subscriptions created earlier, from the dashboard, or with a full-access key keep delivering whatever their own `disabledResourceGroups` allows, so restricting an existing integration end to end means restricting the subscription too. OAuth connector tokens (AI assistants and MCP clients) resolve against the same registry, but their groups are not settable yet: treat an authorized connector as full access.
     */
    disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
};
/**
 * 'full' grants access to all profiles, 'profiles' restricts to specific profiles
 */
type scope = 'full' | 'profiles';
/**
 * 'read-write' allows all operations, 'read' restricts to GET requests only
 */
type permission = 'read-write' | 'read';
/**
 * Meta bid strategy. Same enum applies at campaign and ad-set level; ad-set value (when set)
 * overrides campaign-level. Cross-field rules:
 * - `LOWEST_COST_WITHOUT_CAP` (default): auto-bid, forbids `bidAmount` and `roasAverageFloor`.
 * - `LOWEST_COST_WITH_BID_CAP` / `COST_CAP`: require `bidAmount` (whole currency units).
 * - `LOWEST_COST_WITH_MIN_ROAS`: requires `roasAverageFloor` (decimal multiplier, 2.0 = 2.0x).
 * Source: facebook-business-sdk-codegen api_specs/specs/enum_types.json (`AdSet_bid_strategy`,
 * `Campaign_bid_strategy`).
 *
 */
type BidStrategy = 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP' | 'LOWEST_COST_WITH_MIN_ROAS';
/**
 * Account billing state — plan, cycle, balance, spend caps, and payment /
 * access status. Returned by `GET /v1/billing`.
 *
 */
type BillingSnapshot = {
    billingSystem?: 'metronome' | 'stripe' | 'shopify';
    plan?: {
        name?: string;
        isUsageBased?: boolean;
        /**
         * True when the key belongs to an account with an active paid billing relationship (Stripe subscription, Metronome enrollment, or Shopify-managed billing).
         */
        isPaid?: boolean;
    };
    /**
     * myshopify.com domain owning the subscription; present only when billingSystem is shopify.
     */
    shopifyShopDomain?: (string) | null;
    /**
     * Current billing cycle. `start`/`end` are resolved for usage-based accounts only.
     */
    period?: {
        start?: (string) | null;
        end?: (string) | null;
        /**
         * Day-of-month the cycle resets.
         */
        anchorDay?: number;
    };
    /**
     * Accrued spend + remaining credits this cycle. `null` for fixed-subscription (Stripe) plans.
     */
    balance?: {
        accruedThisPeriodCents?: number;
        creditsRemainingCents?: number;
    } | null;
    caps?: {
        xSpendUsedCents?: number;
        /**
         * Monthly X-API spend cap; null = unlimited.
         */
        xSpendLimitCents?: (number) | null;
    };
    status?: {
        hasAccess?: boolean;
        suspended?: boolean;
        suspendedAt?: (string) | null;
        suspensionReason?: (string) | null;
        /**
         * Hosted invoice URL for dunning (Stripe).
         */
        openInvoiceUrl?: (string) | null;
        declineReason?: (string) | null;
        autoUpgradeEnabled?: boolean;
    };
    /**
     * Deprecated plan entitlements (Stripe only); absent for usage-based accounts.
     */
    legacy?: {
        limits?: {
            uploads?: number;
            profiles?: number;
        };
    };
};
type billingSystem = 'metronome' | 'stripe' | 'shopify';
/**
 * A blog container on the connected platform. All content lives on the platform; Zernio proxies it and stores nothing.
 */
type Blog = {
    /**
     * Platform-native blog id (numeric string for Shopify).
     */
    id?: string;
    platform?: 'shopify';
    title?: string;
    /**
     * URL slug of the blog.
     */
    handle?: string;
};
type platform2 = 'shopify';
/**
 * An article inside a blog on the connected platform.
 */
type BlogArticle = {
    /**
     * Platform-native article id (numeric string for Shopify).
     */
    id?: string;
    /**
     * Platform-native id of the blog the article belongs to.
     */
    blogId?: string;
    platform?: 'shopify';
    title?: string;
    /**
     * Article body as HTML.
     */
    bodyHtml?: (string) | null;
    /**
     * URL slug of the article.
     */
    handle?: string;
    tags?: Array<(string)>;
    /**
     * Display name of the article author.
     */
    author?: (string) | null;
    /**
     * Short summary shown in blog listings.
     */
    excerpt?: (string) | null;
    /**
     * Featured image.
     */
    image?: {
        url?: string;
        altText?: (string) | null;
    } | null;
    /**
     * False while the article is a draft or its publish date is still in the future.
     */
    isPublished?: boolean;
    /**
     * When the article was (or is scheduled to be) published; null for drafts.
     */
    publishedAt?: (string) | null;
    createdAt?: (string) | null;
    updatedAt?: (string) | null;
};
/**
 * Bluesky post settings. Supports text posts with up to 4 images or a single video. threadItems creates a reply chain (Bluesky thread). Images exceeding 1MB are automatically compressed. Alt text supported via mediaItem properties. Use langs to tag post language for feed-generator filtering.
 *
 */
type BlueskyPlatformData = {
    /**
     * Language(s) of the post text as 1-3 BCP-47 codes (e.g. "pt", "en-US"), written to the post record's langs field. Bluesky feed generators filter on this field, so posts without it never appear in language-scoped feeds. Can only be set at creation (Bluesky has no post editing). When threadItems is used, every item in the thread carries the same langs. When omitted, the account's default (set via PATCH /v1/accounts/{accountId}/bluesky-settings) applies; with no default either, the field is absent from the record.
     *
     */
    langs?: Array<(string)>;
    /**
     * Complete sequence of posts in a Bluesky thread. The first item becomes the root post, subsequent items are chained as replies. When threadItems is provided, the top-level content field is used only for display and search purposes, it is NOT published. You must include your first post as threadItems[0].
     *
     */
    threadItems?: Array<{
        content?: string;
        mediaItems?: Array<MediaItem>;
    }>;
};
/**
 * Result of a CSV bulk upload. The same shape is returned for `200` (all rows
 * succeeded or all failed) and `207` (mixed). Per-row outcomes live in `results`;
 * the row's success is `ok`, and failures carry machine-readable codes in `errors`.
 *
 */
type BulkUploadResult = {
    /**
     * Number of data rows processed from the CSV
     */
    total?: number;
    /**
     * Count of rows that succeeded (results[].ok === true)
     */
    valid?: number;
    /**
     * Count of rows that failed (total - valid)
     */
    invalid?: number;
    /**
     * One entry per CSV data row, in row order.
     */
    results?: Array<{
        /**
         * 1-based index of the CSV data row (header excluded)
         */
        rowIndex?: number;
        /**
         * Whether the row was created successfully
         */
        ok?: boolean;
        /**
         * ID of the created post. Present only when `ok` is true and not a dry run.
         */
        createdPostId?: string;
        /**
         * Machine-readable failure codes for this row. Present only when `ok` is false.
         * Examples: `unknown_profile:<id>`, `no_account_for_platform:<platform>`,
         * `schedule_time_missing`, `rate_limited:<platform>:@<username>:<remaining>`.
         *
         */
        errors?: Array<(string)>;
    }>;
    /**
     * Top-level advisory warnings (e.g. `rows_exceed_advisory_limit:500`). Empty when none.
     */
    warnings?: Array<(string)>;
    /**
     * Present only when one or more rows targeted an account currently in cooldown.
     * Lets callers map `rate_limited:*` row errors back to structured metadata without
     * parsing the error strings.
     *
     */
    rateLimitedAccounts?: Array<{
        accountId?: string;
        platform?: string;
        username?: string;
        rateLimitedUntil?: string;
    }>;
};
/**
 * TikTok Business Center entity. Returned by `GET /v1/ads/business-centers`. BCs are
 * TikTok's agency container — one BC owns N advertisers (ad accounts). Most solo
 * advertisers don't have one; the agency token uses BCs to roll up multi-client access.
 *
 */
type BusinessCenter = {
    /**
     * Business Center ID
     */
    bcId?: string;
    /**
     * Display name set by the BC owner
     */
    name?: string;
    /**
     * Number of advertisers reachable under this BC for the calling token.
     * `null` when the BC asset walk returned empty or failed (typical for
     * agency apps without full BC asset read scope) — distinct from `0`,
     * which would imply the BC genuinely has no advertisers.
     *
     */
    advertiserCount?: (number) | null;
};
/**
 * One call on a number you own, either channel. `channel` tells you which
 * lane it took: `whatsapp` (WhatsApp Business Calling) or `pstn` (a regular
 * phone call). List endpoints omit `transcript`; use `lastTranscriptSnippet`
 * for a preview and the detail endpoint for the full transcript.
 *
 */
type CallRecord = {
    _id?: string;
    /**
     * Owning social account. The unified /v1/calls/{id} detail + recording endpoints work for any channel; the channel-specific endpoints remain for account-scoped access.
     */
    accountId?: string;
    /**
     * Inbox conversation with the counterparty, when one exists.
     */
    conversationId?: (string) | null;
    /**
     * CRM Contact for the counterparty, when resolved.
     */
    contactId?: (string) | null;
    channel?: 'whatsapp' | 'pstn';
    direction?: 'inbound' | 'outbound';
    /**
     * Caller number (E.164).
     */
    from?: string;
    /**
     * Callee number (E.164).
     */
    to?: string;
    /**
     * Destination the call was routed to (tel:/sip:/wss:), snapshotted at routing time.
     */
    forwardTo?: (string) | null;
    /**
     * Outbound PSTN only. Message spoken to the callee on answer, before the bridge.
     */
    greeting?: (string) | null;
    status?: 'ringing' | 'answered' | 'ended' | 'failed';
    /**
     * True when an inbound call went to voicemail.
     */
    isVoicemail?: boolean;
    /**
     * Outbound answering-machine detection was requested for this call.
     */
    amd?: boolean;
    /**
     * With `amd`, whether a machine (vs a human) answered.
     */
    answeredMachine?: (boolean) | null;
    /**
     * Caller ID presented on the forwarded leg.
     */
    forwardCallerId?: 'business' | 'caller';
    /**
     * Effective flag for THIS call (number default + per-call override, resolved at create time).
     */
    recordingEnabled?: boolean;
    transcriptionEnabled?: boolean;
    transcriptionLanguage?: 'auto' | 'en' | 'es';
    startedAt?: string;
    answeredAt?: (string) | null;
    endedAt?: (string) | null;
    /**
     * When the call was blind-transferred (POST /v1/voice/calls/{id}/transfer).
     */
    transferredAt?: (string) | null;
    durationSeconds?: number;
    endReason?: 'hangup' | 'no_answer' | 'rejected' | 'error';
    /**
     * Raw carrier hangup cause behind endReason (e.g. normal_clearing, not_found, time_limit) — the actual motive when endReason is a coarse bucket.
     */
    hangupCause?: (string) | null;
    /**
     * SIP response code that ended the call, when SIP-signalled (e.g. '403', '488'). The real failure reason for SIP legs.
     */
    sipHangupCause?: (string) | null;
    /**
     * Per-call failure log (dial failed, bridge failed, recording error).
     */
    callErrors?: Array<{
        code?: number;
        message?: string;
    }>;
    /**
     * May be expired. Resolve a fresh playable URL via GET /v1/calls/{id}/recording (any channel).
     */
    recordingUrl?: (string) | null;
    /**
     * Most recent transcript segment, for list previews.
     */
    lastTranscriptSnippet?: (string) | null;
    /**
     * Full transcript segments (detail endpoint only; omitted from lists).
     */
    transcript?: Array<{
        text?: string;
        confidence?: number;
        at?: string;
    }>;
    billing?: {
        metaMinutes?: number;
        telnyxSeconds?: number;
        transcriptionSeconds?: number;
        transcriptionCostUSD?: number;
        /**
         * WhatsApp channel only. Meta per-minute charge, billed by Meta directly to your WABA. Display only; not billed by Zernio.
         */
        metaCostUSD?: number;
        telnyxCostUSD?: number;
        recordingCostUSD?: number;
        /**
         * Amount Zernio bills you = telephony leg + recording + transcription (excludes any Meta portion).
         */
        billableCostUSD?: number;
        /**
         * Full cost incl. any Meta portion you pay directly. Display only.
         */
        totalCostUSD?: number;
        currency?: string;
    };
    createdAt?: string;
    updatedAt?: string;
};
type channel = 'whatsapp' | 'pstn';
type direction = 'inbound' | 'outbound';
type status2 = 'ringing' | 'answered' | 'ended' | 'failed';
/**
 * Caller ID presented on the forwarded leg.
 */
type forwardCallerId = 'business' | 'caller';
type transcriptionLanguage = 'auto' | 'en' | 'es';
type endReason = 'hangup' | 'no_answer' | 'rejected' | 'error';
type CampaignAnalyticsResponse = {
    /**
     * Present and true while historical data is being backfilled.
     */
    backfillPending?: boolean;
    campaign?: {
        id?: string;
        name?: (string) | null;
        platform?: string;
        /**
         * Effective campaign status (ACTIVE when any child ad is active).
         */
        status?: (string) | null;
        /**
         * ISO 4217 code of the ad account (e.g. USD, THB). All money values in `summary` and `daily` are in this currency.
         */
        currency?: (string) | null;
    };
    analytics?: {
        summary?: AdMetrics;
        daily?: Array<(AdMetrics & {
            date?: string;
        })>;
        breakdowns?: {
            [key: string]: Array<{
                [key: string]: unknown;
            }>;
        };
    };
};
/**
 * Who a comment automation answers. Instagram only - Meta exposes the follow
 * relationship on no other platform, and only for people who have MESSAGED the
 * account (a comment grants no consent). `whenUnknown` is therefore the important
 * setting: it decides what happens for a first-time commenter.
 *
 */
type CommentAutomationAudience = {
    followerStatus?: 'any' | 'follower' | 'non_follower';
    /**
     * Skip commenters with fewer followers than this. Omit for no size rule.
     */
    minFollowerCount?: number;
    /**
     * What to do when Instagram will not reveal the follow relationship.
     * * `send` (default) - deliver the DM anyway (fails open).
     * * `skip` - stay silent.
     * * `verify` - send `followGate.message` with a confirm button. Tapping it is a
     * message, which grants consent, so the re-check on the tap resolves and the
     * real DM (or `followGate.notFollowingMessage`) follows automatically.
     *
     */
    whenUnknown?: 'send' | 'skip' | 'verify';
};
type followerStatus = 'any' | 'follower' | 'non_follower';
/**
 * What to do when Instagram will not reveal the follow relationship.
 * * `send` (default) - deliver the DM anyway (fails open).
 * * `skip` - stay silent.
 * * `verify` - send `followGate.message` with a confirm button. Tapping it is a
 * message, which grants consent, so the re-check on the tap resolves and the
 * real DM (or `followGate.notFollowingMessage`) follows automatically.
 *
 */
type whenUnknown = 'send' | 'skip' | 'verify';
/**
 * Copy for the follow gate. Sensible defaults are used for any field left empty.
 */
type CommentAutomationFollowGate = {
    /**
     * Confirmation DM sent when whenUnknown=verify.
     */
    message?: string;
    /**
     * Confirm button label. Defaults to "I'm following".
     */
    buttonLabel?: string;
    /**
     * Sent to a commenter we know does not follow (followerStatus=follower). Omit to stay silent on a keyword comment; a confirm tap always gets an answer.
     */
    notFollowingMessage?: string;
};
/**
 * A Meta generic template (product card) sent as the automation's first DM.
 * It REPLACES the plain `dmMessage` bubble: a Meta message carries one body
 * shape, and a comment gets exactly one private reply, so the card and the
 * text cannot both be delivered. Put your selling copy in `subtitle`.
 * Mutually exclusive with `buttons` (sending both is a 400). Works on both
 * the `comment` and `story_reply` triggers.
 * Up to 10 elements, rendered as a horizontally swipeable carousel.
 * Rendering confirmed on the Instagram and Messenger mobile apps.
 *
 */
type CommentAutomationTemplate = {
    type: 'generic';
    elements: Array<CommentAutomationTemplateElement>;
};
type type2 = 'generic';
type CommentAutomationTemplateElement = {
    /**
     * Card headline (80 chars max). Also used as the Inbox preview for the sent DM.
     */
    title: string;
    /**
     * Card description, e.g. the price or a short pitch (80 chars max).
     */
    subtitle?: string;
    /**
     * Publicly reachable http(s) image rendered large above the card.
     */
    imageUrl?: string;
    /**
     * Up to 3 card buttons. A generic template has NO phone button, on either platform. `url` buttons are click-tracked when linkTracking is on.
     */
    buttons?: Array<{
        type: 'url' | 'postback';
        title: string;
        /**
         * Target URL (required when type is url)
         */
        url?: string;
        /**
         * Postback payload delivered via the messaging_postbacks webhook (required when type is postback)
         */
        payload?: string;
    }>;
};
/**
 * An OAuth client (AI assistant / MCP connector) authorized by the user and still
 * holding at least one live token.
 *
 */
type ConnectedApp = {
    clientId?: string;
    /**
     * Name the client declared at registration. Registration is open, so this is self-declared and not verified.
     */
    clientName?: string;
    /**
     * Host of the client's registered redirect URI (non-http schemes are shown as scheme//host). The destination an impostor cannot fake.
     */
    redirectHost?: (string) | null;
    /**
     * Scopes granted on the most recent token.
     */
    scopes?: Array<(string)>;
    authorizedAt?: (string) | null;
    /**
     * Last time any of the client's live tokens authenticated a request.
     */
    lastUsedAt?: (string) | null;
    /**
     * Live tokens held by the client (an active session is typically one access plus one refresh token).
     */
    tokenCount?: number;
};
/**
 * A discoverable conversion destination on an ad platform — a Meta pixel,
 * Google conversion action, or LinkedIn conversion rule. Returned by
 * `listConversionDestinations`, `getConversionDestination`,
 * `createConversionDestination`, and `updateConversionDestination`.
 *
 */
type ConversionDestination = {
    /**
     * Platform-native identifier. Pass back as `destinationId` on event
     * send and as the path segment on CRUD endpoints.
     *
     */
    id: string;
    name: string;
    /**
     * Present when the platform locks the event type/category to the
     * destination (Google conversion actions, LinkedIn conversion rules).
     * Absent for Meta pixels (which accept any event name per request).
     *
     */
    type?: string;
    /**
     * For LinkedIn, `inactive` means the rule is soft-deleted (`enabled: false`).
     *
     */
    status?: 'active' | 'inactive';
    /**
     * Set by adapters whose destinations are scoped to a specific ad
     * account (LinkedIn). Pass back on subsequent CRUD calls to
     * identify the parent ad account.
     *
     */
    adAccountId?: string;
};
/**
 * For LinkedIn, `inactive` means the rule is soft-deleted (`enabled: false`).
 *
 */
type status3 = 'active' | 'inactive';
/**
 * A single conversion event to relay to the ad platform. All PII fields
 * (email, phone, names) are hashed with SHA-256 server-side using each
 * platform's normalization rules before they leave Zernio. Callers send
 * plaintext.
 *
 */
type ConversionEvent = {
    /**
     * Standard event name (Purchase, Lead, CompleteRegistration, AddToCart,
     * InitiateCheckout, AddPaymentInfo, Subscribe, StartTrial, ViewContent,
     * Search, Contact, SubmitApplication, Schedule) or a custom string
     * (only supported on platforms that accept custom events — Meta and
     * OpenAI Ads).
     *
     * Per-platform behavior:
     * - Meta: free-form; standard names match Meta's built-ins.
     * - Google: ignored — the conversion action's category determines the type.
     * - LinkedIn: ignored — the conversion rule's `type` is locked to the destination.
     * - OpenAI Ads: a fixed subset of standard names (Purchase, Lead, AddToCart, ViewContent, InitiateCheckout, CompleteRegistration, Subscribe, StartTrial, Schedule) maps 1:1 onto OpenAI's own event-type enum; anything else is sent as a custom event with the name preserved.
     *
     */
    eventName: string;
    /**
     * When the conversion happened, in unix seconds.
     */
    eventTime: number;
    /**
     * Unique dedup key. The same eventId must be used on pixel + CAPI
     * to prevent double-counting. Mapped to event_id on Meta,
     * transactionId on Google, eventId on LinkedIn (LinkedIn deduplicates
     * against Insight Tag events with the same eventId; the Insight Tag
     * event wins when both arrive).
     *
     */
    eventId: string;
    /**
     * Conversion value in the specified currency.
     */
    value?: number;
    /**
     * ISO 4217 currency code.
     */
    currency?: string;
    /**
     * User identity fields. More signals mean higher match rates.
     */
    user: {
        /**
         * Plaintext email. Hashed server-side.
         */
        email?: string;
        /**
         * Phone number, ideally E.164. Hashed server-side.
         */
        phone?: string;
        /**
         * Plaintext first name. Hashed server-side.
         */
        firstName?: string;
        /**
         * Plaintext last name. Hashed server-side.
         */
        lastName?: string;
        /**
         * Stable customer identifier (e.g. CRM user ID). Hashed
         * server-side for Meta and Google. Sent as plaintext to LinkedIn
         * (LinkedIn's Conversions API spec requires the raw value).
         * Maximum effective list size on LinkedIn is 1.
         *
         */
        externalId?: string;
        /**
         * Client IP address. Sent plaintext.
         */
        ipAddress?: string;
        /**
         * Client user-agent string. Sent plaintext.
         */
        userAgent?: string;
        /**
         * ISO 3166-1 alpha-2 country code, e.g. 'us'.
         */
        country?: string;
        /**
         * Meta advanced matching (ct). Plaintext city; normalized + SHA-256 hashed server-side. Meta only.
         */
        city?: string;
        /**
         * Meta advanced matching (st). 2-letter ANSI for US; hashed server-side. Meta only.
         */
        state?: string;
        /**
         * Meta advanced matching (zp). US uses first 5 digits; hashed server-side. Meta only.
         */
        zip?: string;
        /**
         * Meta advanced matching (db). YYYYMMDD; hashed server-side. Meta only.
         */
        dob?: string;
        /**
         * Meta advanced matching (ge). 'f' or 'm'; hashed server-side. Meta only.
         */
        gender?: string;
        /**
         * Meta lead ID from a Lead Ad submission, as a string. Required
         * for Conversion Leads CRM events: send it with
         * `actionSource: 'crm'` and
         * `platformData: { event_source: 'crm', lead_event_source: '<CRM name>' }`.
         * Forwarded unhashed to Meta's `user_data.lead_id`. Meta only.
         *
         */
        leadId?: string;
        /**
         * Platform click identifiers captured from the originating ad click.
         */
        clickIds?: {
            /**
             * Meta click ID (from fbclid URL param).
             */
            fbc?: string;
            /**
             * Meta browser ID (_fbp cookie).
             */
            fbp?: string;
            /**
             * Google click ID (from gclid URL param).
             */
            gclid?: string;
            /**
             * Google iOS 14.5+ app attribution ID.
             */
            gbraid?: string;
            /**
             * Google iOS 14.5+ web-to-app attribution ID.
             */
            wbraid?: string;
            /**
             * LinkedIn first-party ad tracking click ID. Captured by
             * parsing `li_fat_id` from landing-page URLs after the
             * advertiser enables enhanced conversion tracking on the
             * LinkedIn Insight Tag. Sent to LinkedIn as the
             * LINKEDIN_FIRST_PARTY_ADS_TRACKING_UUID userId. Opaque
             * token, not hashed.
             *
             */
            li_fat_id?: string;
        };
    };
    /**
     * Item-level detail for ecommerce events.
     */
    items?: Array<{
        id?: string;
        name?: string;
        price?: number;
        quantity?: number;
        category?: string;
    }>;
    /**
     * URL where the conversion originated (used by Meta).
     */
    sourceUrl?: string;
    /**
     * Where the conversion happened. Used by Meta. Google also requires an event source internally; omitting this field sends OTHER to Google. Send an explicit value for accurate origin reporting.
     */
    actionSource?: 'web' | 'app' | 'offline' | 'crm' | 'phone_call' | 'system_generated';
    /**
     * Escape hatch for platform-specific fields we haven't normalized.
     * On Meta, keys are shallow-merged into `custom_data` only: fields
     * Zernio already builds (`value`, `currency`, `contents`,
     * `num_items`) always win on collision, and `user_data` (hashed
     * match keys) is never touched. Use first-class fields (e.g.
     * `user.leadId`) for anything that must reach `user_data`.
     *
     */
    platformData?: {
        [key: string]: unknown;
    };
};
/**
 * Where the conversion happened. Used by Meta. Google also requires an event source internally; omitting this field sends OTHER to Google. Send an explicit value for accurate origin reporting.
 */
type actionSource = 'web' | 'app' | 'offline' | 'crm' | 'phone_call' | 'system_generated';
/**
 * In addition to the `required` list, the request must use
 * EXACTLY ONE of the two shapes:
 *
 * - Single-creative: `headline`, `body`, and one of
 * `imageUrl` / `video` (mutually exclusive).
 * - Multi-creative: a non-empty `creatives[]` array. Top-level
 * `headline` / `body` / `imageUrl` / `video` must NOT be set
 * on this shape.
 *
 * The route enforces this at the Zod boundary; OpenAPI's
 * `required` cannot express the OR cleanly.
 *
 */
type CtwaAdRequestBody = {
    /**
     * Facebook or Instagram SocialAccount ID.
     */
    accountId: string;
    /**
     * Meta ad account ID, e.g. `act_123456789`.
     */
    adAccountId: string;
    /**
     * Ad display name. Used to derive campaign / ad set names.
     * On the multi-creative shape, each ad's Meta name gets a
     * " #N" suffix (1-indexed) so Ads Manager shows them as a
     * numbered batch.
     *
     */
    name: string;
    /**
     * Single-creative shape only. Mutually exclusive with
     * `creatives[]`.
     *
     */
    headline?: string;
    /**
     * Primary text shown above the image / video. Single-creative
     * shape only. Mutually exclusive with `creatives[]`.
     *
     */
    body?: string;
    /**
     * Image asset for single-creative shape. Mutually exclusive
     * with `video` and with `creatives[]`. Required on the
     * single-creative shape if `video` is not supplied.
     *
     */
    imageUrl?: string;
    /**
     * Video creative for single-creative shape. Mutually
     * exclusive with `imageUrl` and with `creatives[]`. Required
     * on the single-creative shape if `imageUrl` is not supplied.
     *
     */
    video?: {
        url: string;
        /**
         * Required by Meta for every video creative. Used as the
         * ad thumbnail.
         *
         */
        thumbnailUrl: string;
    };
    /**
     * Multi-creative shape: N CTWA ads under one campaign + one
     * ad set, sharing budget and targeting. Mutually exclusive
     * with the top-level single-creative fields (`headline` /
     * `body` / `imageUrl` / `video`). Each entry must supply its
     * own headline, body, and exactly one of `imageUrl` /
     * `video`.
     *
     */
    creatives?: Array<{
        headline: string;
        /**
         * Primary text shown above the image / video.
         */
        body: string;
        /**
         * Image asset. Mutually exclusive with this entry's
         * `video`. Required if `video` is not supplied.
         *
         */
        imageUrl?: string;
        /**
         * Video creative. Mutually exclusive with this entry's
         * `imageUrl`. Required if `imageUrl` is not supplied.
         *
         */
        video?: {
            url: string;
            /**
             * Required by Meta for every video creative. Used
             * as the ad thumbnail.
             *
             */
            thumbnailUrl: string;
        };
    }>;
    /**
     * Attach the creatives to this EXISTING messaging ad set instead of
     * building a campaign, so the ad set keeps its learning phase. It then
     * owns budget, targeting and schedule, so `budgetAmount`, `budgetType`,
     * `endDate`, `objective`, `countries`, `interests` and `audienceId` are
     * rejected with a 400 alongside it. Its `destination_type` must match
     * the ad's destination.
     *
     */
    adSetId?: string;
    /**
     * Budget amount in the ad account's currency major units
     * (e.g. dollars for USD, not cents). Must be > 0.
     * Required unless `adSetId` is set, where the ad set owns it.
     *
     */
    budgetAmount?: number;
    /**
     * Required unless `adSetId` is set.
     */
    budgetType?: 'daily' | 'lifetime';
    /**
     * ISO 4217 currency code matching the ad account's currency
     * (e.g. `USD`). Optional: Zernio resolves it from the ad account
     * when omitted. The value selects the minor-unit exponent Zernio
     * converts budget/bid amounts by before calling Meta (most
     * currencies are cents; zero-decimal currencies like JPY/KRW are
     * sent as-is).
     *
     */
    currency?: string;
    /**
     * ISO 8601 datetime. Required when `budgetType` is `lifetime`.
     *
     */
    endDate?: string;
    /**
     * ISO 3166-1 alpha-2 country codes. Defaults to `["US"]` only
     * when no other geo (`cities`, `regions`, `zips`, `metros`,
     * `customLocations`) is supplied.
     *
     */
    countries?: Array<(string)>;
    /**
     * City-level geo targeting for local CTWA campaigns. Each entry maps to Meta's
     * TargetingGeoLocationCity. `key` is Meta's city ID. `radius`
     * and `distance_unit` are coupled: set both or neither.
     * Meta enforces a minimum city radius (~17 km / 10 mi);
     * smaller values resolve to a 0-size audience and the ad
     * fails at launch. For a tighter catchment use customLocations
     * (lat/lng).
     *
     */
    cities?: Array<{
        key: string;
        radius?: number;
        distance_unit?: 'mile' | 'kilometer';
    }>;
    /**
     * Region / state-level geo targeting. `key` is Meta's region
     * ID (lookupable via GET /v1/ads/targeting/search?type=region).
     *
     */
    regions?: Array<{
        key: string;
    }>;
    /**
     * ZIP / postal-code geo targeting. `key` is the platform's
     * postal id resolved via /v1/ads/targeting/search.
     *
     */
    zips?: Array<{
        key: string;
        name?: string;
    }>;
    /**
     * DMA / metro-area geo targeting. `key` is Meta's metro id
     * (e.g. `DMA:807`).
     *
     */
    metros?: Array<{
        key: string;
        name?: string;
    }>;
    /**
     * Point-radius geo (Meta `geo_locations.custom_locations`).
     * Use for targeting a radius around a specific lat/long when
     * no Meta city/region key fits. `distanceUnit` is required.
     *
     */
    customLocations?: Array<{
        latitude: number;
        longitude: number;
        radius: number;
        distanceUnit: 'mile' | 'kilometer';
        name?: string;
        address?: string;
    }>;
    ageMin?: number;
    ageMax?: number;
    interests?: Array<{
        id: string;
        name?: string;
    }>;
    /**
     * Custom audience ID to target.
     */
    audienceId?: string;
    /**
     * Manual ad placements on the shared ad set. Omit
     * for automatic placements. When set, restricts delivery to the chosen surfaces,
     * mapped onto the ad set's `targeting.{publisher_platforms, facebook_positions, instagram_positions,
     * messenger_positions, audience_network_positions, threads_positions,
     * whatsapp_positions, device_platforms}`. Enum membership is validated here; Meta
     * additionally enforces co-selection rules and restricts which
     * placements are eligible for click-to-WhatsApp ads, returning an actionable
     * error which we surface.
     *
     */
    placements?: {
        /**
         * Top-level platforms to deliver on. A position field below is only honoured when its parent platform is included here.
         */
        publisherPlatforms?: Array<('facebook' | 'instagram' | 'threads' | 'messenger' | 'audience_network' | 'whatsapp')>;
        facebookPositions?: Array<('feed' | 'right_hand_column' | 'marketplace' | 'video_feeds' | 'story' | 'search' | 'instream_video' | 'facebook_reels' | 'facebook_reels_overlay' | 'profile_feed' | 'notification')>;
        instagramPositions?: Array<('stream' | 'story' | 'explore' | 'explore_home' | 'reels' | 'profile_feed' | 'ig_search' | 'profile_reels')>;
        messengerPositions?: Array<('messenger_home' | 'sponsored_messages' | 'story')>;
        audienceNetworkPositions?: Array<('classic' | 'rewarded_video')>;
        threadsPositions?: Array<('threads_stream')>;
        whatsappPositions?: Array<('status')>;
        /**
         * Restrict by device. Omit to deliver on both mobile and desktop.
         */
        devicePlatforms?: Array<('mobile' | 'desktop')>;
    };
    /**
     * Meta's Advantage+ audience expansion. `0` (default) keeps
     * targeting strict; `1` lets Meta expand beyond the supplied
     * targeting when its delivery system finds better matches.
     * Always sent on CREATE (Meta requires it).
     *
     */
    advantageAudience?: 0 | 1;
    /**
     * Defaults to `OUTCOME_ENGAGEMENT`. `OUTCOME_SALES` and `OUTCOME_LEADS` require
     * additional account configuration (Dataset linked to the WABA
     * for sales) and may be rejected by Meta if missing.
     *
     */
    objective?: 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS';
    /**
     * Meta bid strategy applied to the shared ad set. Defaults to
     * `LOWEST_COST_WITHOUT_CAP` (auto-bid) when omitted.
     * `LOWEST_COST_WITH_BID_CAP` and `COST_CAP` require
     * `bidAmount`. `LOWEST_COST_WITH_MIN_ROAS` requires
     * `roasAverageFloor`. CTWA's `optimization_goal` is fixed to
     * `CONVERSATIONS`, but the bid strategy is independent.
     *
     */
    bidStrategy?: 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP' | 'LOWEST_COST_WITH_MIN_ROAS';
    /**
     * Whole currency units (e.g. `5` = $5.00 on a USD account).
     * Required when `bidStrategy` is `LOWEST_COST_WITH_BID_CAP`
     * or `COST_CAP`; rejected otherwise.
     *
     */
    bidAmount?: number;
    /**
     * Decimal ROAS multiplier (e.g. `2.0` = 2.0× ROAS floor).
     * Required when `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`;
     * rejected otherwise. Meta enforces its own upper bound
     * server-side.
     *
     */
    roasAverageFloor?: number;
    /**
     * Legal entity that benefits from the ad. Required when targeting EU users
     * (EU DSA, Article 26). Optional if the ad account has a default beneficiary:
     * set it once via `PATCH /v1/ads/accounts` or in Meta Ads Manager, and Meta
     * fills it in whenever the field is omitted.
     *
     */
    dsaBeneficiary?: string;
    /**
     * Legal entity that pays for the ad. Can differ from `dsaBeneficiary`
     * (for example, an agency paying for a client's ads). Same rules as
     * `dsaBeneficiary`: required for EU targeting unless the ad account has
     * a default payor.
     *
     */
    dsaPayor?: string;
};
/**
 * Required unless `adSetId` is set.
 */
type budgetType = 'daily' | 'lifetime';
/**
 * Meta's Advantage+ audience expansion. `0` (default) keeps
 * targeting strict; `1` lets Meta expand beyond the supplied
 * targeting when its delivery system finds better matches.
 * Always sent on CREATE (Meta requires it).
 *
 */
type advantageAudience = 0 | 1;
/**
 * Defaults to `OUTCOME_ENGAGEMENT`. `OUTCOME_SALES` and `OUTCOME_LEADS` require
 * additional account configuration (Dataset linked to the WABA
 * for sales) and may be rejected by Meta if missing.
 *
 */
type objective = 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS';
/**
 * Meta bid strategy applied to the shared ad set. Defaults to
 * `LOWEST_COST_WITHOUT_CAP` (auto-bid) when omitted.
 * `LOWEST_COST_WITH_BID_CAP` and `COST_CAP` require
 * `bidAmount`. `LOWEST_COST_WITH_MIN_ROAS` requires
 * `roasAverageFloor`. CTWA's `optimization_goal` is fixed to
 * `CONVERSATIONS`, but the bid strategy is independent.
 *
 */
type bidStrategy = 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP' | 'LOWEST_COST_WITH_MIN_ROAS';
/**
 * Response returned by `POST /v1/ads/ctwa` when the request used the
 * multi-creative shape (`creatives[]`). N persisted Ad documents share
 * the returned `platformCampaignId` and `platformAdSetId`. `adType` is
 * the union discriminator.
 *
 */
type CtwaMultiResponse = {
    adType: 'multi';
    /**
     * The persisted Ad documents (one per creative), all sharing the same
     * `platformCampaignId` and `platformAdSetId`.
     *
     */
    ads: Array<{
        [key: string]: unknown;
    }>;
    platformCampaignId: string;
    platformAdSetId: string;
    message: string;
};
type adType2 = 'multi';
/**
 * Response returned by `POST /v1/ads/ctwa` when the request used the
 * single-creative shape (top-level headline / body / imageUrl|video).
 * `adType` is the union discriminator.
 *
 */
type CtwaSingleResponse = {
    adType: 'single';
    /**
     * The persisted Ad document.
     */
    ad: {
        [key: string]: unknown;
    };
    message: string;
};
type adType3 = 'single';
type CustomConversion = {
    id?: string;
    name?: (string) | null;
    /**
     * Meta's rule, parsed back from the string Meta stores.
     */
    rule?: {
        [key: string]: unknown;
    } | null;
    customEventType?: (string) | null;
    /**
     * Meta's event_source_id — the pixel the rule reads from.
     */
    pixelId?: (string) | null;
    isArchived?: boolean;
};
type CustomConversionResult = {
    adAccountId?: string;
    /**
     * Drops straight into promotedObject.customConversionId on POST /v1/ads/create.
     */
    customConversionId?: string;
    /**
     * True when an existing conversion matched name + pixelId; the response is then a 200.
     */
    reused?: boolean;
    customConversion?: CustomConversion;
};
/**
 * A Discord guild member, returned verbatim from Discord's API.
 */
type DiscordGuildMember = {
    user?: {
        /**
         * User snowflake
         */
        id?: string;
        username?: string;
        discriminator?: string;
        avatar?: (string) | null;
        /**
         * User's display name (post-2023 Discord rebrand)
         */
        global_name?: (string) | null;
    };
    /**
     * Guild-specific nickname
     */
    nick?: (string) | null;
    /**
     * Snowflake IDs of roles assigned to this member
     */
    roles?: Array<(string)>;
    joined_at?: string;
    /**
     * When the user started boosting the server
     */
    premium_since?: (string) | null;
};
/**
 * Discord message settings. Supports plain text (2,000 chars), rich embeds (up to 10), native polls, forum posts, threads, and announcement crossposts. Media attachments support images (JPEG, PNG, GIF, WebP), videos (MP4), and documents (up to 10 files, 25 MB each). Webhook identity (username + avatar) can be customized per-account via PATCH /v1/connect/discord or per-post via webhookUsername/webhookAvatarUrl.
 *
 */
type DiscordPlatformData = {
    /**
     * Target channel snowflake ID. Determines which channel in the connected server receives the message.
     */
    channelId: string;
    /**
     * Up to 10 Discord embed objects (combined max 6,000 characters across all embeds). Sent alongside or instead of plain-text content.
     */
    embeds?: Array<{
        /**
         * Embed title (max 256 chars)
         */
        title?: string;
        /**
         * Embed body text (max 4,096 chars)
         */
        description?: string;
        /**
         * URL the title links to
         */
        url?: string;
        /**
         * Embed accent color as decimal integer (e.g. 5814783 for blue). Convert hex to decimal.
         */
        color?: number;
        image?: {
            url?: string;
        };
        thumbnail?: {
            url?: string;
        };
        footer?: {
            /**
             * Footer text (max 2,048 chars)
             */
            text?: string;
            icon_url?: string;
        };
        author?: {
            /**
             * Author name (max 256 chars)
             */
            name?: string;
            url?: string;
            icon_url?: string;
        };
        /**
         * Up to 25 fields per embed
         */
        fields?: Array<{
            /**
             * Field name (max 256 chars)
             */
            name: string;
            /**
             * Field value (max 1,024 chars)
             */
            value: string;
            /**
             * Display fields side-by-side
             */
            inline?: boolean;
        }>;
    }>;
    /**
     * Native Discord poll. Cannot be combined with media attachments in the same message.
     */
    poll?: {
        question?: {
            /**
             * Poll question (max 300 chars)
             */
            text: string;
        };
        /**
         * 1-10 answer options
         */
        answers?: Array<{
            poll_media?: {
                /**
                 * Answer text
                 */
                text?: string;
            };
        }>;
        /**
         * Poll duration in hours (1-768). Default 24.
         */
        duration?: number;
        /**
         * Allow users to select multiple answers. Default false.
         */
        allow_multiselect?: boolean;
    };
    /**
     * Auto-crosspost to every server following this announcement channel (type 5). No-op for regular text channels.
     */
    crosspost?: boolean;
    /**
     * Thread title for forum channel posts (type 15). Required when posting to a forum channel.
     */
    forumThreadName?: string;
    /**
     * Tag snowflake IDs to apply to forum posts. Max 5 tags.
     */
    forumAppliedTags?: Array<(string)>;
    /**
     * Create a follow-up thread under the published message.
     */
    threadFromMessage?: {
        /**
         * Thread name (1-100 chars)
         */
        name?: string;
        /**
         * Auto-archive after inactivity (minutes)
         */
        autoArchiveDuration?: 60 | 1440 | 4320 | 10080;
        /**
         * Slow-mode duration in seconds (0-21600)
         */
        rateLimitPerUser?: number;
    };
    /**
     * Send as text-to-speech message. Discord reads the message aloud in the channel.
     */
    tts?: boolean;
    /**
     * Override the webhook display name for this post only (1-80 chars). Falls back to the account-level default set via PATCH /v1/connect/discord.
     */
    webhookUsername?: string;
    /**
     * Override the webhook avatar URL for this post only. Falls back to the account-level default.
     */
    webhookAvatarUrl?: string;
};
/**
 * Auto-archive after inactivity (minutes)
 */
type autoArchiveDuration = 60 | 1440 | 4320 | 10080;
/**
 * A Discord guild role, returned verbatim from Discord's API.
 */
type DiscordRole = {
    /**
     * Role snowflake ID
     */
    id?: string;
    name?: string;
    /**
     * Decimal color (0 = no color). Convert to hex via .toString(16).
     */
    color?: number;
    /**
     * Position in role hierarchy (higher = more authority)
     */
    position?: number;
    /**
     * Permissions bitfield as a stringified integer
     */
    permissions?: string;
    /**
     * True for integration-managed roles (bot roles)
     */
    managed?: boolean;
    mentionable?: boolean;
    /**
     * True if role is displayed separately in member list
     */
    hoist?: boolean;
};
/**
 * Discord guild scheduled event. Returned by /v1/discord/guilds/{guildId}/events endpoints.
 * Fields below are the subset Zernio consumes — Discord may return more (e.g. creator,
 * image hash) which we pass through verbatim.
 *
 */
type DiscordScheduledEvent = {
    /**
     * Event snowflake ID
     */
    id?: string;
    guild_id?: string;
    /**
     * Voice/stage channel ID; null for external events.
     */
    channel_id?: (string) | null;
    creator_id?: (string) | null;
    name?: string;
    description?: (string) | null;
    scheduled_start_time?: string;
    /**
     * Required for external events; optional for voice/stage.
     */
    scheduled_end_time?: (string) | null;
    /**
     * Always 2 (GUILD_ONLY) — Discord deprecated PUBLIC events.
     */
    privacy_level?: 2;
    /**
     * 1=SCHEDULED, 2=ACTIVE, 3=COMPLETED, 4=CANCELED
     */
    status?: 1 | 2 | 3 | 4;
    /**
     * 1=STAGE_INSTANCE, 2=VOICE, 3=EXTERNAL
     */
    entity_type?: 1 | 2 | 3;
    entity_id?: (string) | null;
    entity_metadata?: {
        /**
         * External event location string.
         */
        location?: string;
    } | null;
    /**
     * Number of members who RSVP'd. Only present when withUserCount=true on list.
     */
    user_count?: number;
    /**
     * Cover image hash; build URL via cdn.discordapp.com.
     */
    image?: (string) | null;
};
/**
 * Always 2 (GUILD_ONLY) — Discord deprecated PUBLIC events.
 */
type privacy_level = 2;
/**
 * 1=SCHEDULED, 2=ACTIVE, 3=COMPLETED, 4=CANCELED
 */
type status4 = 1 | 2 | 3 | 4;
/**
 * 1=STAGE_INSTANCE, 2=VOICE, 3=EXTERNAL
 */
type entity_type = 1 | 2 | 3;
/**
 * A single inline button rendered inside an auto-DM via Meta's button_template.
 * Up to 3 buttons per automation. `url` and `postback` work on Instagram and
 * Facebook; `phone` is Facebook-only. When buttons are set, `dmMessage` becomes
 * the button_template text and must be 640 characters or less.
 *
 */
type DmButton = {
    type: 'url' | 'postback' | 'phone';
    /**
     * Button label (20 chars max)
     */
    title: string;
    /**
     * Target URL (required when type is url)
     */
    url?: string;
    /**
     * Postback payload delivered via the messaging_postbacks webhook (required when type is postback)
     */
    payload?: string;
    /**
     * Phone number, e.g. +14155551234 (required when type is phone; Facebook only)
     */
    phone?: string;
};
type type3 = 'url' | 'postback' | 'phone';
/**
 * Canonical error envelope. `error` is the human-readable message; `type`,
 * `code`, `param`, `platform`, and `platformError` are top-level siblings
 * for programmatic handling. For upstream platform failures (`type:
 * platform_error`), `platformError` carries the provider's raw payload
 * verbatim (for Meta: `error_subcode`, `error_user_title`, `error_user_msg`).
 *
 */
type ErrorResponse = {
    /**
     * Human-readable error message.
     */
    error?: string;
    /**
     * Error class for programmatic handling.
     */
    type?: 'invalid_request_error' | 'authentication_error' | 'permission_error' | 'not_found' | 'rate_limit_error' | 'platform_error' | 'api_error';
    /**
     * Stable machine-readable error code.
     */
    code?: string;
    /**
     * The request field that caused the error, when applicable.
     */
    param?: string;
    /**
     * Upstream platform (e.g. meta, google, tiktok) — present when type is platform_error.
     */
    platform?: string;
    /**
     * Raw error payload from the upstream platform, passed through verbatim so
     * integrators can read provider-specific codes. For Meta this includes
     * error_subcode, error_user_title, and error_user_msg.
     *
     */
    platformError?: {
        [key: string]: unknown;
    };
    /**
     * Additional structured context (e.g. field-level validation errors).
     */
    details?: {
        [key: string]: unknown;
    };
};
/**
 * Error class for programmatic handling.
 */
type type4 = 'invalid_request_error' | 'authentication_error' | 'permission_error' | 'not_found' | 'rate_limit_error' | 'platform_error' | 'api_error';
/**
 * A media item on a native (external/synced) post, as carried by post.external.* webhook payloads. Distinct from the richer MediaItem used for Zernio-authored posts: external items are always already-published and limited to image or video. Kept as a separate schema so the generated SDK model does not collide with MediaItem.
 *
 */
type ExternalPostMediaItem = {
    type: 'image' | 'video';
    /**
     * 'Direct URL to the media file. Null when the platform withholds it: check mediaStatus before downloading. Instagram omits the video file for Reels it flags as containing copyrighted material (its docs name audio as the usual cause), so type stays "video" while the file is permanently unreachable. For LinkedIn videos where the platform returns no file, url falls back to the cover image and the item carries mediaStatus: unavailable.'
     */
    url: (string) | null;
    /**
     * Cover image. Still present when url is null.
     */
    thumbnail?: string;
    /**
     * unavailable means the media file could not be retrieved (url is null or, for LinkedIn videos, a cover image standing in for the file). available or absent means the file is available at url (older synced items omit the field).
     */
    mediaStatus?: 'available' | 'unavailable';
    /**
     * Why the file is missing. platform_withheld means the platform declined to return it and retrying will not help.
     */
    unavailableReason?: 'platform_withheld';
};
type type5 = 'image' | 'video';
/**
 * unavailable means the media file could not be retrieved (url is null or, for LinkedIn videos, a cover image standing in for the file). available or absent means the file is available at url (older synced items omit the field).
 */
type mediaStatus = 'available' | 'unavailable';
/**
 * Why the file is missing. platform_withheld means the platform declined to return it and retrying will not help.
 */
type unavailableReason = 'platform_withheld';
/**
 * A post synced from a platform (published directly on the platform, not
 * through Zernio). Returned by GET /v1/posts?source=external and
 * POST /v1/posts/sync-external. Analytics are exposed separately via
 * GET /v1/analytics?source=external.
 *
 */
type ExternalPostSummary = {
    /**
     * Platform the post belongs to (e.g. instagram, youtube, tiktok)
     */
    platform?: string;
    /**
     * The platform's own post/media/video id
     */
    platformPostId?: string;
    /**
     * Canonical URL (permalink) of the post on the platform
     */
    platformPostUrl?: string;
    /**
     * Post caption / text
     */
    content?: string;
    /**
     * When the post was published on the platform
     */
    publishedAt?: string;
    /**
     * Media type (e.g. image, video, carousel)
     */
    mediaType?: string;
    /**
     * Thumbnail URL
     */
    thumbnailUrl?: string;
    /**
     * Per-item media (for carousels / multi-media posts)
     */
    mediaItems?: Array<{
        [key: string]: unknown;
    }>;
    /**
     * Instagram only: the platform media product type (e.g. FEED, REELS, STORY, AD). Absent when the platform did not report it.
     */
    mediaProductType?: string;
    /**
     * Instagram only: whether Instagram labeled the media as AI-generated. Absent when the platform did not report it.
     */
    isAiGenerated?: boolean;
    /**
     * Instagram reels only: whether the reel is also shared to the main feed. Absent when the platform did not report it.
     */
    isSharedToFeed?: boolean;
    /**
     * Instagram only: audio type of the media (MUSIC or ORIGINAL_SOUND). Absent when the platform did not report it.
     */
    mediaAudioType?: string;
    /**
     * Engagement + insights for the post. `likes` and `comments` are
     * available immediately after an on-demand sync (they come from the
     * platform listing). `reach`, `impressions`, `views` depend on the
     * platform's insights, which carry their own delay (e.g. ~24h on
     * Instagram) and read 0 until the platform makes them available.
     *
     */
    analytics?: {
        likes?: number;
        comments?: number;
        shares?: number;
        saves?: number;
        sends?: number;
        clicks?: number;
        views?: number;
        reach?: number;
        impressions?: number;
        /**
         * Percentage, rounded to 2 decimals. Same definition as PostAnalytics.engagementRate: (likes + comments + shares + saves) / (impressions or reach or views) * 100, where the denominator is the first of the three that is non-zero. Clicks and follows are never counted.
         */
        engagementRate?: number;
        /**
         * When these metrics were last refreshed
         */
        lastUpdated?: string;
    };
};
/**
 * Native (external) post data shared by all post.external.* payloads.
 */
type ExternalPostWebhookPost = {
    /**
     * Platform-native post ID (NOT a Zernio post ID).
     */
    id: string;
    /**
     * Platform the post lives on (e.g. "googlebusiness").
     */
    platform: string;
    /**
     * Zernio social account ID the post belongs to.
     */
    accountId: string;
    /**
     * Direct URL to the post on the platform, when available.
     */
    url: (string) | null;
    /**
     * Post text. May be empty.
     */
    content: string;
    /**
     * One of image, video, gif, document, text, carousel.
     */
    mediaType: string;
    mediaItems: Array<ExternalPostMediaItem>;
    thumbnailUrl: (string) | null;
    publishedAt: string;
    /**
     * Instagram only: the platform media product type (e.g. FEED, REELS, STORY, AD). Absent when the platform did not report it.
     */
    mediaProductType?: string;
    /**
     * Instagram only: whether Instagram labeled the media as AI-generated. Absent when the platform did not report it.
     */
    isAiGenerated?: boolean;
    /**
     * Instagram reels only: whether the reel is also shared to the main feed. Absent when the platform did not report it.
     */
    isSharedToFeed?: boolean;
    /**
     * Instagram only: audio type of the media (MUSIC or ORIGINAL_SOUND). Absent when the platform did not report it.
     */
    mediaAudioType?: string;
    /**
     * Always "external" — distinguishes these from Zernio-originated post.* events.
     */
    source: 'external';
    /**
     * Detection time of deletion. Present on post.external.deleted; null/absent otherwise.
     */
    deletedAt?: (string) | null;
};
/**
 * Always "external" — distinguishes these from Zernio-originated post.* events.
 */
type source = 'external';
/**
 * Feed posts support up to 10 images (no mixed video+image). Stories require single media (24h, no captions). Reels require single vertical video (9:16, 3-60s). Geo-restriction is a hard visibility restriction: users outside the specified countries cannot see the post. Not supported for stories. Draft, carousel, and colored-background text options live under facebookSettings, see FacebookSettings.
 *
 */
type FacebookPlatformData = {
    /**
     * Set to 'story' for Page Stories (24h ephemeral) or 'reel' for Reels (short vertical video). Defaults to feed post if omitted.
     */
    contentType?: 'story' | 'reel';
    /**
     * Reel title (only for contentType=reel). Separate from the caption/content field.
     */
    title?: string;
    /**
     * Optional first comment to post immediately after publishing (feed posts and reels, not stories). Skipped when facebookSettings.draft is true.
     */
    firstComment?: string;
    /**
     * Target Facebook Page ID for multi-page posting. If omitted, uses the default page. Use GET /v1/accounts/{id}/facebook-page to list pages.
     */
    pageId?: string;
    geoRestriction?: GeoRestriction;
    facebookSettings?: FacebookSettings;
};
/**
 * Set to 'story' for Page Stories (24h ephemeral) or 'reel' for Reels (short vertical video). Defaults to feed post if omitted.
 */
type contentType = 'story' | 'reel';
/**
 * Lifetime monetization earnings for one Facebook post. Same "unit" / "currency" contract and
 * same unavailable-vs-zero contract as the Page-level response; there is no date range, no
 * metricType, and no daily "values", because the single lifetime bucket IS the total.
 *
 */
type FacebookPostEarningsResponse = {
    success?: boolean;
    accountId?: string;
    /**
     * The platform post ID that was queried, echoed back.
     */
    postId?: string;
    platform?: string;
    /**
     * Always "lifetime": the total is cumulative since publication and must not be summed
     * across dates or across posts.
     *
     */
    period?: 'lifetime';
    /**
     * One entry per served metric. A metric reported here with "total": 0 genuinely earned
     * nothing (or its Page is not enrolled, which Meta reports identically).
     *
     */
    metrics?: {
        [key: string]: {
            /**
             * Lifetime earnings in "unit", exactly as Meta returned them. Never rescaled.
             */
            total?: number;
            /**
             * "micro_amount": Meta returned an object shape carrying a micro amount, and "total" is
             * that integer, unconverted. Zernio does not publish a divisor because Meta does not
             * document one; divide by the scale you have verified against the Page's own Meta
             * Business Suite export. This is always content_monetization_earnings.
             *
             * "unspecified": Meta returned a bare number with no unit metadata, passed through as-is;
             * Meta does not state whether it is major or minor currency units. This is always
             * monetization_approximate_earnings.
             *
             */
            unit?: 'micro_amount' | 'unspecified';
            /**
             * ISO 4217 currency, or null when Meta omitted it. Always null on
             * monetization_approximate_earnings; always present on content_monetization_earnings.
             *
             */
            currency?: (string) | null;
        };
    };
    /**
     * Requested metrics Meta could not serve. Present only when at least one metric is
     * unavailable, and absent otherwise. Each listed metric is OMITTED from "metrics" rather than
     * reported as 0. The request itself still succeeds with HTTP 200.
     *
     */
    unavailableMetrics?: Array<{
        /**
         * The requested metric name.
         */
        metric?: string;
        /**
         * "not_enrolled": the account is not enrolled in the program behind this metric.
         * "permission_missing": the connected user lacks access to this metric.
         * "unsupported_metric": Meta does not accept this metric name on the API version Zernio uses.
         * "no_data": Meta returned no bucket for this metric.
         * "unreadable_value": Meta returned a value shape Zernio cannot read, so no total is reported.
         * "mixed_currency": readable values disagree on currency or unit.
         * "upstream_error": any other platform failure.
         *
         * "no_data" is the common case in practice; the others are defensive.
         *
         */
        reason?: 'not_enrolled' | 'permission_missing' | 'unsupported_metric' | 'no_data' | 'unreadable_value' | 'mixed_currency' | 'upstream_error';
        /**
         * Platform-provided explanation when available (access tokens redacted), otherwise Zernio copy.
         */
        message?: string;
    }>;
    dataDelay?: string;
};
/**
 * Always "lifetime": the total is cumulative since publication and must not be summed
 * across dates or across posts.
 *
 */
type period = 'lifetime';
/**
 * Facebook options that must be nested under platformSpecificData.facebookSettings, or sent at the request root as facebookSettings. The remaining Facebook options sit directly on platformSpecificData, see FacebookPlatformData.
 *
 */
type FacebookSettings = {
    /**
     * When true, creates the post as a draft in Facebook Publishing Tools instead of publishing immediately. Supported for feed posts (text, link, image, video) and reels. Not supported for stories. Drafts expire after ~30 days.
     */
    draft?: boolean;
    /**
     * Renders the post as a multi-link carousel (organic Page post). When set, mediaItems must be provided with the same length and all items must be images (no videos). Each cards[i] adds the click-through link and headline for the image at mediaItems[i]. Mutually exclusive with contentType=story|reel. Facebook display truncates name at ~35 chars and description at ~30 chars; longer strings are accepted but get truncated on render.
     *
     */
    carouselCards?: Array<{
        /**
         * Per-card click destination (required).
         */
        link: string;
        /**
         * Per-card headline (optional, ~35-char display).
         */
        name?: string;
        /**
         * Per-card subhead (optional, ~30-char display).
         */
        description?: string;
    }>;
    /**
     * Optional top-level "See more" destination shown on the carousel end card. Defaults to the first card's link when omitted. Only used together with carouselCards.
     *
     */
    carouselLink?: string;
    /**
     * Facebook-defined preset ID that renders the post as large text on a colored background (Graph `text_format_preset_id`). Supply the raw numeric ID from Meta; we do not publish a catalog of presets and Facebook may change the available set. Pages only (ignored on personal profiles and groups) and text-only feed posts only: the request is rejected with 400 when mediaItems or carouselCards are present, when contentType is story or reel, or when content is empty. An attachment makes Facebook drop the background silently, so those are rejected up front. Length is NOT rejected: Facebook's composer stops offering a background at around 130 characters, but Meta documents no API limit, so longer content publishes and returns a warning instead. A URL detected in the content is NOT attached as a link preview while a preset is set, because a link attachment also makes Facebook drop the background.
     *
     */
    textFormatPresetId?: string;
};
type FollowerStatsResponse = {
    accounts?: Array<AccountWithFollowerStats>;
    stats?: {
        [key: string]: Array<{
            date?: string;
            followers?: number;
        }>;
    };
    dateRange?: {
        from?: string;
        to?: string;
    };
    granularity?: string;
};
type FoodMenu = {
    labels: Array<FoodMenuLabel>;
    sections?: Array<FoodMenuSection>;
    /**
     * Cuisine types (e.g. AMERICAN, ITALIAN, JAPANESE)
     */
    cuisines?: Array<(string)>;
    /**
     * URL of the original menu source
     */
    sourceUrl?: string;
};
type FoodMenuItem = {
    labels: Array<FoodMenuLabel>;
    attributes?: FoodMenuItemAttributes;
    /**
     * Item variants/options (e.g. sizes, preparations)
     */
    options?: Array<{
        labels: Array<FoodMenuLabel>;
        attributes: FoodMenuItemAttributes;
    }>;
};
type FoodMenuItemAttributes = {
    price?: Money;
    /**
     * Spiciness level (e.g. MILD, MEDIUM, HOT)
     */
    spiciness?: 'SPICINESS_UNSPECIFIED' | 'MILD' | 'MEDIUM' | 'HOT';
    /**
     * Allergens (e.g. DAIRY, GLUTEN, SHELLFISH)
     */
    allergen?: Array<(string)>;
    /**
     * Dietary labels (e.g. VEGETARIAN, VEGAN, GLUTEN_FREE)
     */
    dietaryRestriction?: Array<(string)>;
    /**
     * Number of people the item serves
     */
    servesNumPeople?: number;
    /**
     * Preparation methods (e.g. GRILLED, FRIED)
     */
    preparationMethods?: Array<(string)>;
    /**
     * Media references for item photos
     */
    mediaKeys?: Array<(string)>;
};
/**
 * Spiciness level (e.g. MILD, MEDIUM, HOT)
 */
type spiciness = 'SPICINESS_UNSPECIFIED' | 'MILD' | 'MEDIUM' | 'HOT';
type FoodMenuLabel = {
    /**
     * Display name of the item/section/menu
     */
    displayName: string;
    /**
     * Optional description
     */
    description?: string;
    /**
     * BCP-47 language code (e.g. en, es)
     */
    languageCode?: string;
};
type FoodMenuSection = {
    labels: Array<FoodMenuLabel>;
    items?: Array<FoodMenuItem>;
};
/**
 * Country-level geo-restriction (allowlist). When set, the post is only visible to users in the specified countries. Supported on Facebook (feed posts, videos, reels), X/Twitter (media-level restriction), and LinkedIn (organization pages only, min 300 targeted followers). Ignored on unsupported platforms. Stories (Facebook, Instagram) do not support geo-restriction.
 *
 */
type GeoRestriction = {
    /**
     * ISO 3166-1 alpha-2 country codes (uppercase). Only users in these countries can see the post. Maximum 25 countries per post. Example: ["US", "CA", "GB", "ES"].
     *
     */
    countries: Array<(string)>;
};
/**
 * Text and single image only (no videos). Supports STANDARD, EVENT, OFFER, and ALERT post types. Posts appear on GBP, Google Search, and Maps. Use locationId for multi-location posting. Schedule dates accept both ISO 8601 strings (e.g. '2026-04-15T09:00:00Z') and Google's native {year, month, day} objects.
 */
type GoogleBusinessPlatformData = {
    /**
     * Target GBP location ID (e.g. "locations/123456789"). If omitted, uses the default location. Use GET /v1/accounts/{id}/gmb-locations to list locations.
     */
    locationId?: string;
    /**
     * BCP 47 language code (e.g. "en", "de", "es"). Auto-detected if omitted. Set explicitly for short or mixed-language posts.
     */
    languageCode?: string;
    /**
     * Post type. STANDARD is a regular update. EVENT requires the event object. OFFER requires the offer object. Defaults to STANDARD if omitted.
     */
    topicType?: 'STANDARD' | 'EVENT' | 'OFFER';
    /**
     * Optional call-to-action button displayed on the post
     */
    callToAction?: {
        /**
         * Button action type: LEARN_MORE, BOOK, ORDER, SHOP, SIGN_UP, CALL
         */
        type: 'LEARN_MORE' | 'BOOK' | 'ORDER' | 'SHOP' | 'SIGN_UP' | 'CALL';
        /**
         * Destination URL for the CTA button (required when callToAction is provided)
         */
        url: string;
    };
    /**
     * Event details. Required when topicType is EVENT. Google returns 400 if omitted for EVENT posts.
     */
    event?: {
        /**
         * Event name (displayed as the event heading on Google Search and Maps)
         */
        title: string;
        /**
         * Event date/time range. Uses Google's date format (NOT ISO 8601).
         */
        schedule: {
            /**
             * Event start date as { year, month, day }
             */
            startDate: {
                year: number;
                month: number;
                day: number;
            };
            /**
             * Optional start time as { hours, minutes } in 24h format
             */
            startTime?: {
                hours?: number;
                minutes?: number;
            };
            /**
             * Event end date as { year, month, day }
             */
            endDate: {
                year: number;
                month: number;
                day: number;
            };
            /**
             * Optional end time as { hours, minutes } in 24h format
             */
            endTime?: {
                hours?: number;
                minutes?: number;
            };
        };
    };
    /**
     * Offer details. Required when topicType is OFFER. All fields are optional per Google's API, but at least one is recommended.
     */
    offer?: {
        /**
         * URL where the offer can be redeemed online
         */
        redeemOnlineUrl?: string;
        /**
         * Terms and conditions for the offer
         */
        termsConditions?: string;
        /**
         * Coupon code for the offer
         */
        couponCode?: string;
    };
};
/**
 * Post type. STANDARD is a regular update. EVENT requires the event object. OFFER requires the offer object. Defaults to STANDARD if omitted.
 */
type topicType = 'STANDARD' | 'EVENT' | 'OFFER';
/**
 * Button action type: LEARN_MORE, BOOK, ORDER, SHOP, SIGN_UP, CALL
 */
type type6 = 'LEARN_MORE' | 'BOOK' | 'ORDER' | 'SHOP' | 'SIGN_UP' | 'CALL';
/**
 * Attachment snapshot inside an edit-history entry.
 */
type InboxMessageEditAttachment = {
    type?: string;
    url?: string;
    payload?: {
        [key: string]: unknown;
    };
};
/**
 * One prior version of an edited message.
 */
type InboxMessageEditHistoryEntry = {
    text: (string) | null;
    attachments: Array<InboxMessageEditAttachment>;
    editedAt: string;
};
/**
 * The account context included in inbox webhook payloads.
 */
type InboxWebhookAccount = {
    /**
     * Social account ID
     */
    id: string;
    /**
     * Social account ID (same value as id). Canonical field so consumers can filter every webhook event on one field (e.g. route staging vs production by account). id is kept for backward compatibility.
     */
    accountId?: string;
    /**
     * Zernio profile (workspace) ID this account belongs to. Use it to route or filter inbox webhooks by workspace. This is the profile ID only, not its name (resolve the name via the API with this ID). Optional; omitted on the shared WhatsApp sandbox account and when the account has no resolvable profile.
     */
    profileId?: string;
    platform: string;
    username: string;
    displayName?: string;
};
/**
 * The conversation context included in inbox webhook payloads.
 */
type InboxWebhookConversation = {
    id: string;
    platformConversationId: string;
    participantId?: string;
    participantName?: string;
    participantUsername?: string;
    participantPicture?: string;
    status: 'active' | 'archived';
    /**
     * Zernio CRM Contact ID for the participant, when one exists. Resolved by
     * joining `participantId` to the ContactChannel collection. Best-effort:
     * omitted when no channel matches or `participantId` is absent. Lets
     * integrators join any inbox webhook back to the CRM Contact without
     * needing to look at the sender — which matters for outgoing and
     * delivery-status events whose sender is the business.
     *
     */
    contactId?: string;
};
type status5 = 'active' | 'archived';
/**
 * The message object included in inbox webhook payloads.
 */
type InboxWebhookMessage = {
    /**
     * Internal message ID
     */
    id: string;
    /**
     * Internal conversation ID
     */
    conversationId: string;
    platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'sms';
    /**
     * Platform's message ID
     */
    platformMessageId: string;
    direction: 'incoming' | 'outgoing';
    /**
     * Message text content (retained on deleted messages for API consumers; Zernio dashboard UI hides this)
     */
    text: (string) | null;
    attachments: Array<{
        /**
         * Attachment type (image, video, file, sticker, audio)
         */
        type: string;
        /**
         * Where to fetch the attachment. The contract depends on direction and
         * platform: inbound WhatsApp media points at the authenticated
         * `GET /v1/whatsapp/media/{mediaId}` and requires
         * `Authorization: Bearer <your API key>`, while outgoing media carries the
         * URL originally supplied and Instagram / Facebook / Telegram carry direct
         * platform CDN links that need no authentication.
         *
         */
        url: string;
        /**
         * Additional attachment metadata
         */
        payload?: {
            [key: string]: unknown;
        };
    }>;
    sender: {
        /**
         * Sender's platform identifier. For WhatsApp this is the phone number
         * (without leading `+`) when available, otherwise the `businessScopedUserId`.
         * For other platforms, the platform's own user ID.
         *
         */
        id: string;
        /**
         * Zernio CRM Contact id for this sender, when one exists (joined via
         * the ContactChannel mapping). Lets integrators link a message straight
         * to a Contact without a follow-up Contacts API call. Omitted when the
         * sender isn't a tracked contact (e.g. outgoing messages where the
         * sender is the business, or first-touch messages before the contact
         * is created).
         *
         */
        contactId?: string;
        name?: string;
        username?: string;
        picture?: string;
        /**
         * WhatsApp only. Sender's phone number in E.164 format (with leading `+`).
         *
         * **Nullable during the BSUID rollout (April 2026+).** WhatsApp users
         * who adopt a username can message businesses without exposing a phone
         * number — this field is omitted for them. Match by `businessScopedUserId`
         * instead. See `docs/whatsapp-bsuid-migration.md`.
         *
         */
        phoneNumber?: (string) | null;
        /**
         * WhatsApp only. Business-scoped user ID (BSUID) — Meta's canonical
         * identifier for a WhatsApp user within your business. Present when
         * Meta includes it in the inbound payload (rollout in progress since
         * early April 2026). **Recommended primary identity anchor** going
         * forward; fall back to `phoneNumber` only when this field is absent.
         *
         */
        businessScopedUserId?: string;
        /**
         * WhatsApp only. Parent BSUID for businesses with linked business
         * portfolios. Omitted for standalone portfolios.
         *
         */
        parentBusinessScopedUserId?: string;
        /**
         * WhatsApp only. User's WhatsApp username (e.g. `@jane`). Not a
         * stable identifier — users can change it. Useful for display, not
         * recommended as an identity anchor.
         *
         */
        whatsappUsername?: string;
        /**
         * Instagram profile data. Only present for Instagram conversations.
         */
        instagramProfile?: {
            isFollower?: (boolean) | null;
            isFollowing?: (boolean) | null;
            followerCount?: (number) | null;
            isVerified?: (boolean) | null;
        };
    };
    sentAt: string;
    isRead: boolean;
};
type platform3 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'sms';
type direction2 = 'incoming' | 'outgoing';
/**
 * Shared account-insights response envelope used by every platform-level
 * analytics endpoint (/v1/analytics/{facebook|instagram|youtube|linkedin|tiktok}*).
 * The name is historical - the shape was first shipped for Instagram and every
 * new platform endpoint reuses it for response-shape consistency. The platform
 * field echoes back which platform served the response.
 *
 */
type InstagramAccountInsightsResponse = {
    success?: boolean;
    /**
     * The Zernio SocialAccount ID
     */
    accountId?: string;
    /**
     * Platform that served this response.
     */
    platform?: 'facebook' | 'instagram' | 'youtube' | 'linkedin' | 'tiktok';
    dateRange?: {
        since?: string;
        until?: string;
    };
    metricType?: 'time_series' | 'total_value';
    /**
     * Breakdown dimension used (only present when breakdown was requested)
     */
    breakdown?: string;
    /**
     * Object keyed by metric name. For time_series: each metric has "total" (number) and "values" (array of {date, value}).
     * For total_value: each metric has "total" (number) and optionally "breakdowns" (array of {dimension, value}).
     *
     * Monetary metrics additionally carry "unit" and "currency". Zernio never rescales money:
     * "total" and every "values[].value" are the platform's raw numbers in the stated unit.
     * Monetary metrics also keep "values" on metricType=total_value, because their "total" is the
     * sum of the daily buckets the platform returned over the range: keep the series so you can
     * reconcile that sum against the platform's own reporting before invoicing on it.
     * A metric that could not be served is absent from this object and listed in
     * "unavailableMetrics" instead, so an unavailable metric is never reported as a zero.
     *
     */
    metrics?: {
        [key: string]: {
            /**
             * Sum or aggregate value for the metric
             */
            total?: number;
            /**
             * Daily values (for time_series, and always on monetary metrics)
             */
            values?: Array<{
                date?: string;
                value?: number;
            }>;
            /**
             * Breakdown values (only for total_value with breakdown)
             */
            breakdowns?: Array<{
                dimension?: string;
                value?: number;
            }>;
            /**
             * Present on monetary metrics only. The scale of "total" and of every "values[].value",
             * exactly as the platform returned them.
             *
             * "micro_amount": the platform returned an object shape carrying a micro amount, and the
             * values are that integer, summed, unconverted. Zernio does not publish a divisor because
             * Meta does not document one; divide by the scale you have verified against the Page's own
             * Meta Business Suite export. On Facebook Page insights this is always
             * content_monetization_earnings.
             *
             * "unspecified": the platform returned a bare number with no unit metadata. It is passed
             * through as-is; the platform does not state whether it is major or minor currency units.
             * On Facebook Page insights this is always monetization_approximate_earnings.
             *
             */
            unit?: 'micro_amount' | 'unspecified';
            /**
             * ISO 4217 currency of a monetary metric, or null when the platform omitted it.
             * Always null on monetization_approximate_earnings, which Meta returns as a bare number
             * with no currency; always present on content_monetization_earnings.
             *
             */
            currency?: (string) | null;
        };
    };
    /**
     * Requested metrics that could not be served. Present only when at least one metric is
     * unavailable, and absent otherwise. Each listed metric is OMITTED from "metrics" rather than
     * reported as 0, which is how an unavailable metric is distinguished from a genuine zero.
     * The request itself still succeeds with HTTP 200.
     *
     */
    unavailableMetrics?: Array<{
        /**
         * The requested metric name.
         */
        metric?: string;
        /**
         * "not_enrolled": the account is not enrolled in the program behind this metric.
         * "permission_missing": the connected user lacks access to this metric.
         * "unsupported_metric": the platform does not accept this metric name on the API version Zernio uses.
         * "no_data": the platform returned no bucket for this metric over the requested range.
         * "unreadable_value": the platform returned a value shape Zernio cannot read, so no total is reported.
         * "mixed_currency": readable values disagree on currency or unit within the range.
         * "upstream_error": any other platform failure.
         *
         * "no_data" is the common case in practice. The others are defensive: "not_enrolled" and
         * "unsupported_metric" in particular have not been observed on live Facebook traffic, since
         * a non-enrolled Page returns zeros rather than an error and metric names are validated
         * before any platform call.
         *
         */
        reason?: 'not_enrolled' | 'permission_missing' | 'unsupported_metric' | 'no_data' | 'unreadable_value' | 'mixed_currency' | 'upstream_error';
        /**
         * Platform-provided explanation when available (access tokens redacted), otherwise Zernio copy.
         */
        message?: string;
    }>;
    dataDelay?: string;
};
/**
 * Platform that served this response.
 */
type platform4 = 'facebook' | 'instagram' | 'youtube' | 'linkedin' | 'tiktok';
type metricType = 'time_series' | 'total_value';
/**
 * One asset from the Instagram audio catalog. Licensed music carries artist/artwork fields; original sounds carry creator fields instead, so most fields are nullable.
 */
type InstagramAudioAsset = {
    /**
     * Audio asset ID. Pass it as platformSpecificData.audioConfiguration.audioId when creating a Reel.
     */
    audioId?: string;
    /**
     * Track or sound title.
     */
    title?: (string) | null;
    /**
     * Catalog type of the asset.
     */
    audioType?: ('music' | 'original_sound') | null;
    /**
     * Asset duration in milliseconds.
     */
    durationInMs?: (number) | null;
    /**
     * Artist name (licensed music only).
     */
    displayArtist?: (string) | null;
    /**
     * Cover artwork thumbnail (licensed music only).
     */
    coverArtworkThumbnailUrl?: (string) | null;
    /**
     * Temporary preview URL. Meta expires it after roughly 1.5 days; re-fetch the asset to refresh it.
     */
    downloadUrl?: (string) | null;
    /**
     * Creator username (original sounds only).
     */
    igUsername?: (string) | null;
    /**
     * Creator profile picture (original sounds only).
     */
    profilePictureUrl?: (string) | null;
    /**
     * Whether the asset is eligible for ads use.
     */
    isAdsEligible?: (boolean) | null;
    /**
     * Instagram web link to preview the audio.
     */
    onPlatformAudioPreviewLink?: (string) | null;
};
/**
 * Catalog type of the asset.
 */
type audioType = 'music' | 'original_sound';
type InstagramDemographicsResponse = {
    success?: boolean;
    /**
     * The Zernio SocialAccount ID
     */
    accountId?: string;
    platform?: string;
    metric?: 'follower_demographics' | 'engaged_audience_demographics';
    /**
     * The timeframe used for demographic data
     */
    timeframe?: 'this_week' | 'this_month';
    /**
     * Object keyed by breakdown dimension (age, city, country, gender)
     */
    demographics?: {
        [key: string]: Array<{
            /**
             * The dimension value (e.g., "25-34", "US", "M")
             */
            dimension?: string;
            /**
             * Count of accounts in this dimension
             */
            value?: number;
        }>;
    };
    note?: string;
};
type metric = 'follower_demographics' | 'engaged_audience_demographics';
/**
 * The timeframe used for demographic data
 */
type timeframe = 'this_week' | 'this_month';
/**
 * Feed aspect ratio 0.8-1.91, carousels up to 10 items, stories require media (no captions). User tag coordinates 0.0-1.0 from top-left. Images over 8 MB and videos over platform limits are auto-compressed.
 */
type InstagramPlatformData = {
    /**
     * Set to 'story' to publish as a Story. Default posts become Reels or feed depending on media.
     */
    contentType?: 'story';
    /**
     * For Reels only. When true (default), the Reel appears on both the Reels tab and your main profile feed. Set to false to post to the Reels tab only.
     */
    shareToFeed?: boolean;
    /**
     * Up to 3 Instagram usernames to invite as collaborators (feed/Reels only)
     */
    collaborators?: Array<(string)>;
    /**
     * Optional first comment to add after the post is created (not applied to Stories)
     */
    firstComment?: string;
    /**
     * Trial Reels configuration. Trial reels are shared to non-followers first and can later be graduated to regular reels manually or automatically based on performance. Only applies to Reels.
     */
    trialParams?: {
        /**
         * MANUAL (graduate from Instagram app) or SS_PERFORMANCE (auto-graduate if performs well with non-followers)
         */
        graduationStrategy?: 'MANUAL' | 'SS_PERFORMANCE';
    };
    /**
     * Tag Instagram users by username. The tag shape depends on the media: photos require x/y coordinates, Reels and videos take username only (coordinates are ignored), stories accept optional coordinates. For carousels, use mediaIndex to target specific slides (defaults to 0); video slides take username-only tags. Photo tags without valid coordinates are skipped.
     */
    userTags?: Array<{
        /**
         * Instagram username (@ symbol is optional and will be removed automatically)
         */
        username: string;
        /**
         * X coordinate position from left edge (0.0 = left, 0.5 = center, 1.0 = right). Required for photos, ignored for Reels/videos, optional for stories.
         */
        x?: number;
        /**
         * Y coordinate position from top edge (0.0 = top, 0.5 = center, 1.0 = bottom). Required for photos, ignored for Reels/videos, optional for stories.
         */
        y?: number;
        /**
         * Zero-based index of the carousel item to tag. Defaults to 0. Tags on out-of-range indices are ignored.
         */
        mediaIndex?: number;
    }>;
    /**
     * Custom name for original audio in Reels. Replaces the default "Original Audio" label. Can only be set once. Unrelated to audioConfiguration, which attaches a catalog track.
     */
    audioName?: string;
    /**
     * Attach a licensed music track or original sound from the Instagram audio catalog to a Reel. Reels only (single video post, not a story or image). Requires an Instagram account connected via Facebook Login; classic Instagram Login accounts get a 400 (instagram_audio_requires_facebook_login). Get audio IDs from GET /v1/accounts/{accountId}/instagram/audio. If the track becomes unavailable by publish time (removed, region-blocked, licensing change), the post fails with a user-error; it is not published without the audio.
     */
    audioConfiguration?: {
        /**
         * Audio asset ID from the audio search endpoint.
         */
        audioId: string;
        /**
         * Volume of the attached audio track, 0-100. Defaults to 100.
         */
        audioVolume?: number;
        /**
         * Volume of the video's own sound, 0-100. Defaults to 100. Set 0 to mute the original video audio.
         */
        videoVolume?: number;
    };
    /**
     * Millisecond offset from video start for the Reel cover frame. Ignored when instagramThumbnail or reelCover is provided. Defaults to 0.
     */
    thumbOffset?: number;
    /**
     * Custom cover image URL for Instagram Reels (JPG or PNG, publicly accessible). Overrides thumbOffset when provided. Also accepted as reelCover (alias).
     */
    instagramThumbnail?: string;
    /**
     * Alias for instagramThumbnail. If both are provided, instagramThumbnail takes priority.
     */
    reelCover?: string;
    /**
     * When true, the post is labeled by Instagram as containing AI-generated media. Per Meta, this self-disclosure label is for AI-generated media, not AI-written captions. Applies to feed posts, Reels, Stories, and carousels.
     */
    isAiGenerated?: boolean;
};
/**
 * Set to 'story' to publish as a Story. Default posts become Reels or feed depending on media.
 */
type contentType2 = 'story';
/**
 * MANUAL (graduate from Instagram app) or SS_PERFORMANCE (auto-graduate if performs well with non-followers)
 */
type graduationStrategy = 'MANUAL' | 'SS_PERFORMANCE';
/**
 * LinkedIn-specific options for POST /v1/ads/boost and POST /v1/ads/create: campaign bidding and delivery controls, plus the LinkedIn-only creative formats on /v1/ads/create. Unknown keys are rejected.
 *
 */
type LinkedInAdsPlatformData = {
    /**
     * Campaign cost model (billing event). Defaults to `CPM`. Required when
     * `unitCost` is set so the manual bid applies to an explicit cost model.
     *
     */
    costType?: 'CPM' | 'CPC' | 'CPV';
    /**
     * Manual bid in WHOLE account-currency units (e.g. 2.5 = $2.50). Requires
     * `costType`. Omit for LinkedIn's automated (max delivery) bidding.
     * LinkedIn enforces its own per-audience min/max bid bounds.
     *
     */
    unitCost?: number;
    /**
     * Campaign `optimizationTargetType` (e.g. `MAX_CLICK`, `TARGET_COST_PER_CLICK`,
     * `MAX_IMPRESSION`). Forwarded verbatim, LinkedIn validates compatibility with
     * the objective and `costType`. Omit for the objective-derived default:
     * `awareness` gets `MAX_IMPRESSION`, `video_views` gets `MAX_VIDEO_VIEW`, and
     * every other goal gets `MAX_CLICK`. `lead_generation` and `conversions` also
     * get `MAX_CLICK`, because `MAX_LEAD` and `MAX_CONVERSION` need a lead gen form
     * or a conversion rule that neither creation flow attaches. The default applies
     * only to `SPONSORED_UPDATES` campaigns (every boost, and the image, video and
     * carousel standalone ads), never to the `TEXT_AD`, `DYNAMIC` and
     * `SPONSORED_INMAILS` campaigns the other creative formats produce. It is also
     * skipped when `unitCost` or a non-`CPM` `costType` is set, since those select
     * manual bidding and the bid is then yours to choose.
     *
     */
    optimizationTargetType?: string;
    /**
     * How LinkedIn rotates creatives within the campaign. Defaults to `OPTIMIZED`.
     */
    creativeSelection?: 'OPTIMIZED' | 'ROUND_ROBIN';
    /**
     * Enable LinkedIn audience expansion. Defaults to false.
     */
    audienceExpansionEnabled?: boolean;
    /**
     * Deliver on the LinkedIn Audience Network. Defaults to false.
     */
    offsiteDeliveryEnabled?: boolean;
    /**
     * Restrict delivery to Connected TV inventory.
     */
    connectedTelevisionOnly?: boolean;
    /**
     * POST /v1/ads/create only. Carousel ad with 2-10 image cards.
     * Mutually exclusive with the other creative sources.
     *
     */
    carousel?: {
        cards: Array<{
            imageUrl: string;
            /**
             * Card title. Falls back to the ad-level headline.
             */
            headline?: string;
            /**
             * Per-card click destination. LinkedIn requires one on every
             * card; the ad-level `linkUrl` backfills cards that omit it.
             *
             */
            landingUrl?: string;
        }>;
    };
    /**
     * POST /v1/ads/create only. Document ad rendered as an in-feed viewer.
     * PDF, PPT or DOC up to 100MB. Mutually exclusive with the other
     * creative sources.
     *
     */
    document?: {
        url: string;
        /**
         * Document title.
         */
        title: string;
    };
    /**
     * POST /v1/ads/create only. Dynamic Spotlight Ad personalized with the
     * viewer's profile photo. Supported goals: traffic, awareness. logoUrl
     * and organizationName default to the Company Page's; set them
     * explicitly if LinkedIn rejects the create with a 404. Mutually
     * exclusive with the other creative sources.
     *
     */
    spotlight?: {
        headline: string;
        /**
         * Mutually exclusive with backgroundImageUrl.
         */
        description?: string;
        /**
         * Button label text.
         */
        callToAction: string;
        landingUrl: string;
        logoUrl?: string;
        organizationName?: string;
        /**
         * Defaults to true.
         */
        showMemberProfilePhoto?: boolean;
        /**
         * Custom background. Replaces the description and the profile photo.
         */
        backgroundImageUrl?: string;
    };
    /**
     * POST /v1/ads/create only. Dynamic Follower Ad promoting the Company
     * Page. Supported goals: engagement, awareness. headline and
     * description take exactly one of preApproved or custom. Mutually
     * exclusive with the other creative sources.
     *
     */
    follower?: {
        headline: {
            /**
             * LinkedIn preset id, not reviewed. Example GROW_YOUR_BUSINESS_INSIGHTS.
             */
            preApproved?: string;
            /**
             * Free text, reviewed by LinkedIn.
             */
            custom?: string;
        };
        description: {
            /**
             * LinkedIn preset id, not reviewed. Example GET_LATEST_JOBS_AND_INDUSTRY_NEWS.
             */
            preApproved?: string;
            /**
             * Free text, reviewed by LinkedIn.
             */
            custom?: string;
        };
        callToAction: 'VISIT_ORGANIZATION_COMPANY_PAGE' | 'VISIT_ORGANIZATION_LIFE_PAGE' | 'VISIT_ORGANIZATION_JOBS_PAGE' | 'VISIT_ORGANIZATION_CAREERS_PAGE';
        logoUrl?: string;
        organizationName?: string;
        /**
         * Defaults to true.
         */
        showMemberProfilePhoto?: boolean;
    };
    /**
     * POST /v1/ads/create only. Dynamic Jobs Ad promoting your open roles,
     * personalized with the viewer's profile photo. Requires goal
     * job_applicants and a Company Page with active job postings.
     * headline and buttonLabel take exactly one of
     * preApproved or custom. logoUrl and organizationName default to the
     * Company Page's. Mutually exclusive with the other creative sources.
     *
     */
    jobs?: {
        headline: {
            /**
             * LinkedIn preset id, not reviewed. Example MEMBER_READY_FOR_YOUR_DREAM_JOB.
             */
            preApproved?: string;
            /**
             * Free text, reviewed by LinkedIn.
             */
            custom?: string;
        };
        buttonLabel: {
            /**
             * LinkedIn preset id, not reviewed. One of SEE_MORE_JOBS, VIEW_MORE, CAREERS_AT_COMPANY.
             */
            preApproved?: string;
            /**
             * Free text, reviewed by LinkedIn.
             */
            custom?: string;
        };
        logoUrl?: string;
        organizationName?: string;
        /**
         * Defaults to true.
         */
        showMemberProfilePhoto?: boolean;
    };
    /**
     * POST /v1/ads/create only. Classic right-rail Text Ad. The copy lives
     * here; ad-level body and headline are not used. Mutually exclusive
     * with the other creative sources.
     *
     */
    textAd?: {
        headline: string;
        description: string;
        landingUrl: string;
        /**
         * Optional 100x100 image.
         */
        imageUrl?: string;
    };
    /**
     * POST /v1/ads/create only. Conversation Ad: a choose-your-path message
     * tree delivered to the member's LinkedIn inbox. Messages are flat
     * nodes wired by local ids; each button either opens a url or leads to
     * nextMessageId. Cycles, unknown ids and a missing firstMessageId
     * return a 400. LinkedIn does not deliver message ads to EU members.
     * Mutually exclusive with the other creative sources.
     *
     */
    conversation?: {
        /**
         * InMail subject shown in the inbox.
         */
        subject: string;
        /**
         * Person or organization URN. Defaults to the authoring Company
         * Page. The sender must be approved for the ad account first
         * (Campaign Manager > Manage message ad senders) or LinkedIn
         * rejects the create with SINMAIL_SENDER_NOT_APPROVED.
         *
         */
        sender?: string;
        /**
         * Optional intro body (HTML allowed).
         */
        body?: string;
        /**
         * Terms shown at the bottom of the message.
         */
        footer?: string;
        /**
         * Conversation headline. Defaults to the first message's first line.
         */
        headline?: string;
        firstMessageId: string;
        messages: Array<{
            id: string;
            text: string;
            buttons?: Array<{
                text: string;
                /**
                 * Continues the conversation at this message. Exactly one of nextMessageId or url.
                 */
                nextMessageId?: string;
                /**
                 * Opens this landing page. Exactly one of nextMessageId or url.
                 */
                url?: string;
            }>;
        }>;
    };
    /**
     * POST /v1/ads/create only. Promotes an existing LinkedIn Event; no
     * headline needed. Mutually exclusive with the other creative sources.
     *
     */
    event?: {
        /**
         * LinkedIn Event URN, urn:li:event:N.
         */
        urn: string;
    };
    /**
     * POST /v1/ads/create only. Sponsors an existing LinkedIn post
     * (a share or ugcPost authored by your organization's Company
     * Page) as the creative, keeping its commentary, author and
     * engagement. Unlike boostPost, which provisions its own
     * CampaignGroup + Campaign around the post, this variant
     * attaches the reference under the campaign /v1/ads/create
     * builds — same shape as every other format, so the caller can
     * pick bidding / targeting / schedule freely. No headline, body,
     * imageUrl or organization are needed; the referenced post
     * carries its own commentary and author. Mutually exclusive
     * with the other creative sources. Posts from personal profiles
     * (Thought Leader Ads) are NOT supported (see postUrn).
     *
     */
    thoughtLeader?: {
        /**
         * LinkedIn share or ugcPost URN, urn:li:share:N or urn:li:ugcPost:N. Get it via "Copy link to post" on the target LinkedIn post (the URL contains -share- for a share or -ugcPost- for a ugcPost, then the numeric id). The post must be authored by an organization (Company Page). Member (personal profile) posts, i.e. Thought Leader Ads proper, are rejected by LinkedIn's public Marketing API regardless of sponsorship approval and of post type (a LinkedIn limitation; their Campaign Manager creates those through a private API). Referencing a member post returns a 422 with a clear error.
         *
         */
        postUrn: string;
    };
};
/**
 * Campaign cost model (billing event). Defaults to `CPM`. Required when
 * `unitCost` is set so the manual bid applies to an explicit cost model.
 *
 */
type costType = 'CPM' | 'CPC' | 'CPV';
/**
 * How LinkedIn rotates creatives within the campaign. Defaults to `OPTIMIZED`.
 */
type creativeSelection = 'OPTIMIZED' | 'ROUND_ROBIN';
type callToAction = 'VISIT_ORGANIZATION_COMPANY_PAGE' | 'VISIT_ORGANIZATION_LIFE_PAGE' | 'VISIT_ORGANIZATION_JOBS_PAGE' | 'VISIT_ORGANIZATION_CAREERS_PAGE';
/**
 * Response for DAILY aggregation (time series breakdown)
 */
type LinkedInAggregateAnalyticsDailyResponse = {
    accountId?: string;
    platform?: string;
    accountType?: string;
    username?: string;
    aggregation?: 'DAILY';
    dateRange?: {
        startDate?: string;
        endDate?: string;
    } | null;
    /**
     * Daily breakdown of each metric as date/count pairs. Reach not available with DAILY aggregation.
     */
    analytics?: {
        impressions?: Array<{
            date?: string;
            count?: number;
        }>;
        reactions?: Array<{
            date?: string;
            count?: number;
        }>;
        comments?: Array<{
            date?: string;
            count?: number;
        }>;
        shares?: Array<{
            date?: string;
            count?: number;
        }>;
        /**
         * Daily saves (personal accounts only)
         */
        saves?: Array<{
            date?: string;
            count?: number;
        }>;
        /**
         * Daily sends via LinkedIn messaging (personal accounts only)
         */
        sends?: Array<{
            date?: string;
            count?: number;
        }>;
    };
    /**
     * Metrics that were skipped due to API limitations
     */
    skippedMetrics?: Array<(string)>;
    note?: string;
    lastUpdated?: string;
};
type aggregation = 'DAILY';
/**
 * Response for TOTAL aggregation (lifetime totals)
 */
type LinkedInAggregateAnalyticsTotalResponse = {
    accountId?: string;
    platform?: string;
    accountType?: string;
    username?: string;
    aggregation?: 'TOTAL';
    dateRange?: {
        startDate?: string;
        endDate?: string;
    } | null;
    analytics?: {
        /**
         * Total impressions across all posts
         */
        impressions?: number;
        /**
         * Unique members reached across all posts
         */
        reach?: number;
        /**
         * Total reactions across all posts
         */
        reactions?: number;
        /**
         * Total comments across all posts
         */
        comments?: number;
        /**
         * Total reshares across all posts
         */
        shares?: number;
        /**
         * Total times posts were saved (personal accounts only)
         */
        saves?: number;
        /**
         * Total times posts were sent via LinkedIn messaging (personal accounts only)
         */
        sends?: number;
        /**
         * Overall engagement rate, as a percentage rounded to 2 decimals: (reactions + comments + shares + saves + sends) / impressions * 100. Clicks are not counted, and there is no fallback denominator, so this is 0 whenever impressions is 0. This is NOT the same formula as PostAnalytics.engagementRate on GET /v1/analytics.
         */
        engagementRate?: number;
    };
    note?: string;
    lastUpdated?: string;
};
type aggregation2 = 'TOTAL';
/**
 * Up to 20 images, no multi-video. Single PDF supported (max 100MB). Link previews auto-generated when no media attached. Use organizationUrn for multi-org posting. Geo-restriction only works for organization pages (not personal profiles) and requires the targeted audience to exceed 300 followers. Polls are supported via the poll object: 2-4 options, cannot be combined with media or reshareUrl, cannot be edited after publishing, and API-created polls are non-sponsored only.
 *
 */
type LinkedInPlatformData = {
    /**
     * Title displayed on LinkedIn document (PDF/carousel) posts. Required by LinkedIn for document posts. If omitted, falls back to the media item title, then the filename.
     */
    documentTitle?: string;
    /**
     * Target LinkedIn Organization URN (e.g. "urn:li:organization:123456789"). If omitted, uses the default org. Use GET /v1/accounts/{id}/linkedin-organizations to list orgs.
     */
    organizationUrn?: string;
    /**
     * Optional first comment to add after the post is created
     */
    firstComment?: string;
    /**
     * Set to true to disable automatic link previews for URLs in the post content (default is false)
     */
    disableLinkPreview?: boolean;
    /**
     * LinkedIn post link to repost (use the post's "Copy link to post" action), or a urn:li:share / urn:li:ugcPost / urn:li:groupPost URN. With content, the published post is a quote-reshare: your text is the commentary and the original is embedded underneath (LinkedIn's "repost with your thoughts"). Leave content empty (and omit customContent) to publish a plain repost with no text, LinkedIn's one-click "Repost". Mutually exclusive with media. Works on personal profiles and organization pages.
     */
    reshareUrl?: string;
    geoRestriction?: GeoRestriction;
    /**
     * Create a LinkedIn poll with this post. Cannot be combined with media or reshareUrl. Polls cannot be edited after publishing on LinkedIn, and API-created polls are non-sponsored only (they cannot be promoted as ads).
     */
    poll?: {
        /**
         * Poll question (max 140 characters)
         */
        question: string;
        /**
         * Poll options (2-4 choices, max 30 characters each)
         */
        options: Array<(string)>;
        /**
         * How long the poll accepts votes. Defaults to SEVEN_DAYS.
         */
        duration?: 'ONE_DAY' | 'THREE_DAYS' | 'SEVEN_DAYS' | 'FOURTEEN_DAYS';
    };
};
/**
 * How long the poll accepts votes. Defaults to SEVEN_DAYS.
 */
type duration = 'ONE_DAY' | 'THREE_DAYS' | 'SEVEN_DAYS' | 'FOURTEEN_DAYS';
/**
 * Media referenced in posts. URLs must be publicly reachable over HTTPS. Use POST /v1/media/presign for uploads up to 5GB. Zernio auto-compresses images and videos that exceed platform limits (videos over 200 MB may not be compressed).
 */
type MediaItem = {
    type?: 'image' | 'video' | 'gif' | 'document';
    url?: string;
    /**
     * Optional title for the media item. Used as the document title for LinkedIn PDF/carousel posts. If omitted, falls back to the post title, then the filename.
     */
    title?: string;
    /**
     * Accessibility alternative text for an image, applied on every platform that supports it: Instagram (feed images only, not Reels/Stories), Facebook, Threads, X/Twitter (max 1000 chars), LinkedIn, Bluesky, and Pinterest (max 500 chars). Ignored on platforms without alt-text support (TikTok, YouTube, Snapchat, Telegram, Reddit, Google Business, WhatsApp) and on video items where the platform does not accept it. Set once per image; the same value is sent to each selected platform.
     */
    altText?: string;
    filename?: string;
    /**
     * Optional file size in bytes
     */
    size?: number;
    /**
     * Optional MIME type (e.g. image/jpeg, video/mp4)
     */
    mimeType?: string;
    /**
     * Optional custom thumbnail/cover image URL for videos. Supported for Facebook video posts, Facebook Reels, regular video uploads, and LinkedIn video posts. Max 10MB, JPG/PNG recommended.
     */
    thumbnail?: string;
    /**
     * Custom cover image URL for Instagram Reels. Can also be set via platformSpecificData.instagramThumbnail or platformSpecificData.reelCover. Resolution order: this field > platformSpecificData.instagramThumbnail > platformSpecificData.reelCover > platformSpecificData.thumbnailUrl (legacy).
     */
    instagramThumbnail?: string;
    /**
     * Internal flag indicating the image was resized for TikTok
     */
    tiktokProcessed?: boolean;
};
type type7 = 'image' | 'video' | 'gif' | 'document';
type MediaUploadResponse = {
    files?: Array<UploadedFile>;
};
/**
 * Meta (facebook/instagram) options for platformSpecificData on POST /v1/ads/boost and /v1/ads/create. Unknown keys are rejected, not dropped.
 */
type MetaAdsPlatformData = {
    bidStrategy?: BidStrategy;
    /**
     * Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. May also be sent alone, WITHOUT bidStrategy, to set the cap on an ad set joining a COST_CAP / LOWEST_COST_WITH_BID_CAP campaign (the strategy is inherited from the campaign). On POST /v1/ads/create that shape requires existingCampaignId and is a 400 otherwise; on POST /v1/ads/boost it is promoted to LOWEST_COST_WITH_BID_CAP.
     */
    bidAmount?: number;
    /**
     * Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS; sending it without bidStrategy is a 400.
     */
    roasAverageFloor?: number;
};
type Money = {
    /**
     * ISO 4217 currency code (e.g. USD, EUR)
     */
    currencyCode: string;
    /**
     * Whole units of the amount
     */
    units: string;
    /**
     * Nano units (10^-9) of the amount
     */
    nanos?: number;
};
type MoneyAmount = {
    /**
     * Amount as a decimal string, e.g. "88.59".
     */
    amount: string;
    /**
     * ISO 4217 currency code, e.g. "USD".
     */
    currencyCode: string;
};
type Pagination = {
    page?: number;
    limit?: number;
    total?: number;
    pages?: number;
};
/**
 * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
 */
type ParameterIdempotencyKeyHeader = string;
/**
 * Page number (1-based)
 */
type ParameterPageParam = number;
type PinterestPlatformData = {
    /**
     * Pin title. Defaults to first line of content or "Pin". Must be ≤ 100 characters.
     */
    title?: string;
    /**
     * Target Pinterest board ID. If omitted, the first available board is used.
     */
    boardId?: string;
    /**
     * Destination link (pin URL)
     */
    link?: string;
    /**
     * Optional cover image for video pins
     */
    coverImageUrl?: string;
    /**
     * Optional key frame time in seconds for derived video cover
     */
    coverImageKeyFrameTime?: number;
};
type PlatformAnalytics = {
    platform?: string;
    status?: 'published' | 'failed';
    /**
     * The native post ID on the platform (e.g. Instagram media ID, tweet ID)
     */
    platformPostId?: (string) | null;
    accountId?: string;
    accountUsername?: (string) | null;
    analytics?: (PostAnalytics | null);
    /**
     * Sync state of analytics for this platform
     */
    syncStatus?: 'synced' | 'pending' | 'unavailable';
    platformPostUrl?: (string) | null;
    /**
     * Error details when status is failed
     */
    errorMessage?: (string) | null;
};
type status6 = 'published' | 'failed';
/**
 * Sync state of analytics for this platform
 */
type syncStatus2 = 'synced' | 'pending' | 'unavailable';
type PlatformTarget = {
    /**
     * Supported values: twitter, threads, instagram, youtube, facebook, linkedin, pinterest, reddit, tiktok, bluesky, googlebusiness, telegram
     */
    platform?: string;
    accountId?: (string | SocialAccount);
    /**
     * Platform-specific text override. When set, this content is used instead of the top-level post content for this platform. Useful for tailoring captions per platform (e.g. keeping tweets under 280 characters).
     */
    customContent?: string;
    customMedia?: Array<MediaItem>;
    /**
     * Optional per-platform scheduled time override (uses post.scheduledFor when omitted)
     */
    scheduledFor?: string;
    /**
     * Platform-specific overrides and options.
     */
    platformSpecificData?: (TwitterPlatformData | ThreadsPlatformData | FacebookPlatformData | InstagramPlatformData | LinkedInPlatformData | PinterestPlatformData | YouTubePlatformData | GoogleBusinessPlatformData | TikTokPlatformData | TelegramPlatformData | SnapchatPlatformData | RedditPlatformData | BlueskyPlatformData | DiscordPlatformData | SlackPlatformData);
    /**
     * Platform-specific status: pending, publishing, published, failed
     */
    status?: string;
    /**
     * The native post ID on the platform (populated after successful publish)
     */
    platformPostId?: string;
    /**
     * Public URL of the published post. Included in the response for immediate posts; for scheduled posts, fetch via GET /v1/posts/{postId} after publish time. Empty when the platform confirmed the publish without returning an id a permalink can be built from (TikTok returns a publish id for some uploads); the TikTok reconcile cron backfills it later.
     */
    platformPostUrl?: (string) | null;
    /**
     * Timestamp when the post was published to this platform
     */
    publishedAt?: string;
    /**
     * Set when a post that was successfully published later disappears from the platform (deleted on-platform or taken down by the platform). status stays "published" (it reflects the publish outcome); poll this field to detect post-publish removals. Absent while the post is live, and cleared if the post reappears. Detection runs with the analytics sync, so expect up to a few hours of lag.
     */
    removedFromPlatformAt?: (string) | null;
    /**
     * Present and true only when this Instagram reel was launched as a Trial through Zernio (created with platformSpecificData.trialParams). Use it to segment trial reels in analytics. Note: Instagram's Graph API exposes no readable trial field, so this reflects creation-time intent only. It indicates the reel STARTED as a trial, not whether or when it graduated.
     */
    isTrialReel?: boolean;
    /**
     * Graduation strategy the trial reel was launched with. Present only when isTrialReel is true.
     */
    trialGraduationStrategy?: 'MANUAL' | 'SS_PERFORMANCE';
    /**
     * Human-readable error message when status is failed. Contains platform-specific error details explaining why the publish failed.
     */
    errorMessage?: string;
    /**
     * Error category for programmatic handling: auth_expired (token expired/revoked), user_content (wrong format/too long), user_abuse (rate limits/spam), account_issue (config problems), platform_rejected (policy violation), platform_error (5xx/maintenance), platform_rate_limit (platform throttling, retried automatically), quota_exhausted (shared daily API quota empty, resumes at the platform's reset), system_error (Zernio infra), unknown
     */
    errorCategory?: 'auth_expired' | 'user_content' | 'user_abuse' | 'account_issue' | 'platform_rejected' | 'platform_error' | 'platform_rate_limit' | 'quota_exhausted' | 'system_error' | 'unknown';
    /**
     * Who caused the error: user (fix content/reconnect), platform (outage/API change), system (Zernio issue, rare)
     */
    errorSource?: 'user' | 'platform' | 'system';
};
/**
 * Graduation strategy the trial reel was launched with. Present only when isTrialReel is true.
 */
type trialGraduationStrategy = 'MANUAL' | 'SS_PERFORMANCE';
/**
 * Error category for programmatic handling: auth_expired (token expired/revoked), user_content (wrong format/too long), user_abuse (rate limits/spam), account_issue (config problems), platform_rejected (policy violation), platform_error (5xx/maintenance), platform_rate_limit (platform throttling, retried automatically), quota_exhausted (shared daily API quota empty, resumes at the platform's reset), system_error (Zernio infra), unknown
 */
type errorCategory = 'auth_expired' | 'user_content' | 'user_abuse' | 'account_issue' | 'platform_rejected' | 'platform_error' | 'platform_rate_limit' | 'quota_exhausted' | 'system_error' | 'unknown';
/**
 * Who caused the error: user (fix content/reconnect), platform (outage/API change), system (Zernio issue, rare)
 */
type errorSource = 'user' | 'platform' | 'system';
type Post = {
    _id?: string;
    userId?: (string | User);
    /**
     * YouTube: title must be ≤ 100 characters.
     *
     */
    title?: string;
    content?: string;
    mediaItems?: Array<MediaItem>;
    platforms?: Array<PlatformTarget>;
    scheduledFor?: string;
    timezone?: string;
    status?: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'partial';
    /**
     * YouTube constraints: each tag max 100 chars, combined max 500 chars, duplicates removed.
     */
    tags?: Array<(string)>;
    hashtags?: Array<(string)>;
    /**
     * Stored for reference only. This field does NOT automatically create @mentions when publishing. For LinkedIn @mentions, use the /v1/accounts/{accountId}/linkedin-mentions endpoint to resolve profile URLs to URNs, then embed the returned mentionFormat directly in the post content field.
     */
    mentions?: Array<(string)>;
    visibility?: 'public' | 'private' | 'unlisted';
    metadata?: {
        [key: string]: unknown;
    };
    recycling?: RecyclingState;
    /**
     * ID of the original post if this post was created via recycling
     */
    recycledFromPostId?: string;
    /**
     * Profile ID if the post was scheduled via the queue
     */
    queuedFromProfile?: string;
    /**
     * Queue ID if the post was scheduled via a specific queue
     */
    queueId?: string;
    createdAt?: string;
    updatedAt?: string;
};
type status7 = 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'partial';
type visibility = 'public' | 'private' | 'unlisted';
type PostAnalytics = {
    impressions?: number;
    reach?: number;
    likes?: number;
    comments?: number;
    shares?: number;
    /**
     * Number of saves/bookmarks (Instagram, Pinterest, X/Twitter)
     */
    saves?: number;
    clicks?: number;
    views?: number;
    /**
     * Instagram feed posts and stories only: organic accounts that started following from this post. 0 for reels and other platforms.
     */
    follows?: number;
    /**
     * Instagram Reels only: average watch time per play, in milliseconds. 0 for non-Reels media and other platforms.
     */
    igReelsAvgWatchTime?: number;
    /**
     * Instagram Reels only: total watch time including replays, in milliseconds. 0 for non-Reels media and other platforms.
     */
    igReelsVideoViewTotalTime?: number;
    /**
     * Video length in seconds. Currently Instagram Reels only; combine with igReelsAvgWatchTime (ms) to estimate retention. Null when unknown (other platforms, non-video media, or when Instagram does not expose the media URL, e.g. reels with copyrighted audio).
     */
    videoDurationSeconds?: (number) | null;
    /**
     * Percentage, rounded to 2 decimals: (likes + comments + shares + saves) / (impressions or reach or views) * 100. Clicks and follows are never counted. The denominator is the FIRST of impressions, reach, views that is non-zero, so it is not the same basis on every post: a post with impressions divides by impressions, one without falls back to reach, then to views. If you need a single consistent basis (e.g. interactions / reach), compute it from the raw fields above. The engagementRate on the LinkedIn account endpoints is a different formula.
     */
    engagementRate?: number;
    lastUpdated?: string;
};
type PostCreateResponse = {
    message?: string;
    post?: Post;
};
type PostDeleteResponse = {
    message?: string;
};
type PostGetResponse = {
    post?: Post;
};
type PostRetryResponse = {
    message?: string;
    post?: Post;
};
type PostsListResponse = {
    posts?: Array<Post>;
    pagination?: Pagination;
};
type PostUpdateResponse = {
    message?: string;
    post?: Post;
    warnings?: Array<(string)>;
};
type Profile = {
    _id?: string;
    userId?: string;
    name?: string;
    description?: string;
    color?: string;
    isDefault?: boolean;
    /**
     * Only present when includeOverLimit=true. Indicates if this profile exceeds the plan limit.
     */
    isOverLimit?: boolean;
    createdAt?: string;
};
type ProfileCreateResponse = {
    message?: string;
    profile?: Profile;
};
type ProfileDeleteResponse = {
    message?: string;
};
type ProfileGetResponse = {
    profile?: Profile;
};
type ProfilesListResponse = {
    profiles?: Array<Profile>;
    /**
     * Total matching profiles across all pages. Present only when limit or skip was passed.
     */
    total?: number;
    /**
     * Offset applied. Present only when limit or skip was passed.
     */
    skip?: number;
    /**
     * Echo of the limit query param. Present only when it was passed.
     */
    limit?: number;
};
type ProfileUpdateResponse = {
    message?: string;
    profile?: Profile;
};
type QueueDeleteResponse = {
    success?: boolean;
    deleted?: boolean;
    deletedCount?: number;
    message?: string;
};
type QueueNextSlotResponse = {
    profileId?: string;
    nextSlot?: string;
    timezone?: string;
    /**
     * Queue ID this slot belongs to
     */
    queueId?: string;
    /**
     * Queue name
     */
    queueName?: string;
};
type QueuePreviewResponse = {
    profileId?: string;
    queueId?: string;
    queueName?: string;
    count?: number;
    slots?: Array<(string)>;
};
type QueueSchedule = {
    /**
     * Unique queue identifier
     */
    _id?: string;
    /**
     * Profile ID this queue belongs to
     */
    profileId?: string;
    /**
     * Queue name (e.g., "Morning Posts", "Evening Content")
     */
    name?: string;
    /**
     * IANA timezone (e.g., America/New_York)
     */
    timezone?: string;
    slots?: Array<QueueSlot>;
    /**
     * Whether the queue is active
     */
    active?: boolean;
    /**
     * Whether this is the default queue for the profile (used when no queueId specified)
     */
    isDefault?: boolean;
    createdAt?: string;
    updatedAt?: string;
};
type QueueSlot = {
    /**
     * Day of week (0=Sunday, 6=Saturday)
     */
    dayOfWeek?: number;
    /**
     * Time in HH:mm format (24-hour)
     */
    time?: string;
};
/**
 * Single queue response (default behavior)
 */
type QueueSlotsResponse = {
    exists?: boolean;
    schedule?: QueueSchedule;
    nextSlots?: Array<(string)>;
};
type QueueUpdateResponse = {
    success?: boolean;
    schedule?: QueueSchedule;
    nextSlots?: Array<(string)>;
    reshuffledCount?: number;
    skippedDailyLimit?: number;
    isNewQueue?: boolean;
};
/**
 * Configure automatic post recycling (reposting at regular intervals).
 * After the post is published, the system creates new scheduled copies at the
 * specified interval until expiration conditions are met. Supports weekly or
 * monthly intervals. Maximum 10 active recycling posts per account.
 * YouTube and TikTok platforms are excluded from recycling.
 * Content variations are recommended for Twitter and Pinterest to avoid duplicate flags.
 *
 */
type RecyclingConfig = {
    /**
     * Set to false to disable recycling on this post
     */
    enabled?: boolean;
    /**
     * Number of interval units between each repost. Required when enabling recycling.
     */
    gap?: number;
    /**
     * Interval unit for the gap. Defaults to 'month'.
     */
    gapFreq?: 'week' | 'month';
    /**
     * When to start the recycling cycle. Defaults to the post's scheduledFor date.
     */
    startDate?: string;
    /**
     * Stop recycling after this many copies have been created. Send null on update to clear this limit.
     */
    expireCount?: (number) | null;
    /**
     * Stop recycling after this date, regardless of count. Send null on update to clear this limit.
     */
    expireDate?: (string) | null;
    /**
     * Array of content variations for recycled copies. On each recycle, the next
     * variation is used in round-robin order. Recommended for Twitter and Pinterest
     * to avoid duplicate content flags. If omitted, the original post content is
     * used for all recycled copies. Send an empty array [] to clear existing
     * variations. Must have 2+ entries when setting variations. Platform-level
     * customContent still overrides the base content per platform.
     *
     */
    contentVariations?: Array<(string)>;
};
/**
 * Interval unit for the gap. Defaults to 'month'.
 */
type gapFreq = 'week' | 'month';
/**
 * Current recycling configuration and state on a post
 */
type RecyclingState = {
    /**
     * Whether recycling is currently active
     */
    enabled?: boolean;
    /**
     * Number of interval units between reposts
     */
    gap?: number;
    /**
     * Interval unit (week or month)
     */
    gapFreq?: 'week' | 'month';
    startDate?: string;
    expireCount?: number;
    expireDate?: string;
    /**
     * Content variations for recycled copies (if configured)
     */
    contentVariations?: Array<(string)>;
    /**
     * Current position in the content variations rotation (read-only)
     */
    contentVariationIndex?: number;
    /**
     * How many recycled copies have been created so far (read-only)
     */
    recycleCount?: number;
    /**
     * When the next recycled copy will be created (read-only)
     */
    nextRecycleAt?: string;
    /**
     * When the last recycled copy was created (read-only)
     */
    lastRecycledAt?: string;
};
/**
 * Posts are either link (with URL/media), native video (via nativeVideo), or self (text-only). Use forceSelf to override. Subreddit defaults to the account's configured one. Some subreddits require a flair.
 */
type RedditPlatformData = {
    /**
     * Target subreddit name (without "r/" prefix). Overrides the default. Use GET /v1/accounts/{id}/reddit-subreddits to list options.
     */
    subreddit?: string;
    /**
     * Post title. Defaults to the first line of content, truncated to 300 characters.
     */
    title?: string;
    /**
     * URL for link posts. If provided (and forceSelf is not true), creates a link post instead of a text post.
     */
    url?: string;
    /**
     * When true, creates a text/self post even when a URL or media is provided.
     */
    forceSelf?: boolean;
    /**
     * Flair ID for the post. Required by some subreddits. Use GET /v1/accounts/{id}/reddit-flairs?subreddit=name to list flairs.
     */
    flairId?: string;
    /**
     * Custom flair text, for subreddits that allow free-text flair. Ignored when flairId is provided (flairId wins).
     */
    flairText?: string;
    /**
     * Mark the post as NSFW (Not Safe For Work / over 18).
     */
    nsfw?: boolean;
    /**
     * Mark the post as a spoiler. The subreddit must have spoiler tagging enabled for this to take effect.
     */
    spoiler?: boolean;
    /**
     * Whether to receive inbox replies for comments on this post. Set to false to opt out.
     */
    sendreplies?: boolean;
    /**
     * Controls Reddit's native video upload flow. When true (default for video mediaItems), the video is uploaded to Reddit's CDN and submitted with kind=video so it renders as an embedded Reddit video player. Reddit transcodes server-side (1080p/30fps cap). Set to false to fall back to a legacy link post. If the subreddit blocks video posts, the upload falls back to a link post automatically.
     *
     */
    nativeVideo?: boolean;
    /**
     * When true (and nativeVideo is active), submits the video as a silent videogif (kind=videogif). Use for short looping clips without audio.
     */
    videogif?: boolean;
    /**
     * Optional poster/thumbnail image URL for native video posts. If omitted, the first frame of the video is extracted and used automatically.
     */
    videoPosterUrl?: string;
};
/**
 * A normalized Reddit post returned by the feed and search endpoints
 */
type RedditPost = {
    /**
     * Reddit post ID (without type prefix)
     */
    id?: string;
    /**
     * Reddit fullname (e.g. t3_abc123)
     */
    fullname?: string;
    title?: string;
    author?: string;
    subreddit?: string;
    /**
     * Post URL (may be a gallery URL, external link, or self-post URL)
     */
    url?: string;
    /**
     * Full permalink to the Reddit post
     */
    permalink?: string;
    /**
     * Self-post body text (empty string for link posts)
     */
    selftext?: string;
    /**
     * Unix timestamp of post creation
     */
    createdUtc?: number;
    score?: number;
    numComments?: number;
    /**
     * Whether the post is marked NSFW
     */
    over18?: boolean;
    stickied?: boolean;
    /**
     * Link flair text if set
     */
    flairText?: (string) | null;
    /**
     * Whether the post is a gallery with multiple images
     */
    isGallery?: boolean;
    /**
     * Individual image URLs for gallery posts (only present when isGallery is true)
     */
    galleryImages?: Array<(string)>;
};
/**
 * Review data shared by review.new and review.updated payloads.
 */
type ReviewWebhookReview = {
    /**
     * Platform review ID (e.g. "accounts/123/locations/456/reviews/789" for Google Business).
     */
    id: string;
    /**
     * Platform the review originated on. Currently Google Business Profile only.
     */
    platform: 'googlebusiness';
    /**
     * Star rating the reviewer gave.
     */
    rating: number;
    /**
     * Review text content. May be empty if the reviewer left only a rating.
     */
    text: string;
    reviewer: {
        /**
         * Platform reviewer ID. Null when the platform does not expose it (common on Google Business anonymous reviews).
         */
        id: (string) | null;
        name: string;
        profileImage: (string) | null;
    };
    createdAt: string;
    /**
     * Whether the connected account has replied to this review.
     */
    hasReply: boolean;
    /**
     * Present when hasReply is true.
     */
    reply?: {
        text: string;
        createdAt: string;
    };
};
/**
 * Platform the review originated on. Currently Google Business Profile only.
 */
type platform5 = 'googlebusiness';
/**
 * A Meta Reach & Frequency prediction. Money values in whole units of the ad account currency.
 */
type RfPrediction = {
    predictionId?: string;
    /**
     * ready | pending | failed:<meta code>
     */
    status?: string;
    /**
     * Quoted (or provided) lifetime budget for the window.
     */
    budget?: (number) | null;
    /**
     * Predicted (or requested) unique reach.
     */
    reach?: (number) | null;
    impressions?: (number) | null;
    /**
     * Meta's allowed lower bound for this spec.
     */
    minBudget?: (number) | null;
    maxBudget?: (number) | null;
    minReach?: (number) | null;
    maxReach?: (number) | null;
    frequencyCap?: (number) | null;
    /**
     * Unix seconds; the reserved window the R&F ad set will run on.
     */
    startTime?: (number) | null;
    stopTime?: (number) | null;
    /**
     * When the reservation's locked price expires (set after reserving).
     */
    expiresAt?: (string) | null;
};
/**
 * An ad account a tracking tag is shared with (Meta `shared_accounts` edge).
 */
type SharedAdAccount = {
    /**
     * Ad account id, in `act_<digits>` form.
     */
    id: string;
    name?: string;
    /**
     * Business Manager id that owns the ad account, when reported.
     */
    businessId?: string;
};
/**
 * Slack message settings. Posts mrkdwn text (up to 40,000 chars; Slack truncates beyond that) to the channel fixed by the connected account, with up to 10 media files per post uploaded via Slack's file API (the text becomes the caption). The target channel is chosen at connect time — one connected account per channel — so channelId is NOT accepted here (a 400 is returned); connect the desired channel via /v1/connect/slack and target its accountId. Messages over 4,000 characters cannot be edited later (Slack's edit limit is stricter than its post limit).
 *
 */
type SlackPlatformData = {
    /**
     * Parent message ts to post this message as a thread reply (e.g. "1503435956.000247").
     */
    threadTs?: string;
    /**
     * Expand links in the message into preview cards. Default true.
     */
    unfurlLinks?: boolean;
    /**
     * Expand media links into inline previews. Default true.
     */
    unfurlMedia?: boolean;
    /**
     * Override the bot display name for this message only (requires no setup; shown with an APP badge). Does not change the app identity in the sidebar.
     */
    username?: string;
    /**
     * Override the bot avatar image URL for this message only.
     */
    iconUrl?: string;
};
/**
 * Requires a Public Profile. Single media item only. Content types: story (ephemeral 24h), saved_story (permanent, title max 45 chars), spotlight (video, max 160 chars).
 */
type SnapchatPlatformData = {
    /**
     * Content type: story (ephemeral 24h, default), saved_story (permanent on Public Profile), spotlight (video feed)
     */
    contentType?: 'story' | 'saved_story' | 'spotlight';
};
/**
 * Content type: story (ephemeral 24h, default), saved_story (permanent on Public Profile), spotlight (video feed)
 */
type contentType3 = 'story' | 'saved_story' | 'spotlight';
type SocialAccount = {
    _id: string;
    platform: 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'sms' | 'phone' | 'rcs';
    profileId: (string | Profile);
    username?: string;
    displayName?: string;
    /**
     * URL to the account's profile picture on the platform. May be null if the platform does not provide one.
     */
    profilePicture?: (string) | null;
    /**
     * Full profile URL for the connected account on its platform.
     */
    profileUrl?: string;
    isActive: boolean;
    /**
     * The platform definitively reported the stored OAuth token as dead.
     * While true, GET /v1/connect/{platform}/ads returns a
     * fresh authUrl (implicit force=true) instead of alreadyConnected,
     * so re-running the connect flow recovers the account. Cleared
     * automatically when the account is re-authorized.
     *
     */
    needsReconnection?: boolean;
    /**
     * Follower count (only included if user has analytics add-on)
     */
    followersCount?: number;
    /**
     * Last time follower count was updated (only included if user has analytics add-on)
     */
    followersLastUpdated?: string;
    /**
     * Reference to the parent posting SocialAccount. Set for ads accounts that share
     * or derive from a posting account's OAuth token. null for standalone ads (Google Ads)
     * and all posting accounts.
     *
     */
    parentAccountId?: (string) | null;
    /**
     * Whether the user explicitly activated this account. false means the account was
     * created as a side effect (e.g., posting account auto-created when user connected
     * ads first). Posting UI and scheduler ignore accounts with enabled: false.
     *
     */
    enabled?: boolean;
    /**
     * Platform-specific metadata. Fields vary by platform. For WhatsApp accounts, includes:
     * - qualityRating: Phone number quality rating from Meta (GREEN, YELLOW, RED, or UNKNOWN)
     * - nameStatus: Display name review status (APPROVED, PENDING_REVIEW, DECLINED, or NONE). A declined or pending display name does not by itself block sending; sendability is reported separately via health_status (can_send_message).
     * - messagingLimitTier: Maximum unique business-initiated conversations per 24h rolling window (TIER_250, TIER_1K, TIER_10K, TIER_100K, or TIER_UNLIMITED). Scales automatically as quality rating improves.
     * - verifiedName: Meta-verified business display name
     * - displayPhoneNumber: Formatted phone number (e.g., "+1 555-123-4567")
     * - wabaId: WhatsApp Business Account ID
     * - phoneNumberId: Meta phone number ID
     *
     * For LinkedIn accounts, profileData carries the profile details refreshed on each daily snapshot:
     * - profileData.bio: The member's headline for personal accounts, or the organization description for organization accounts. null when the member has not set one.
     * - profileData.extraData.vanityName: The member's profile slug, i.e. the /in/{vanityName} segment of profileUrl. Personal accounts only; an organization's own slug is in metadata.organizationInfo.vanityName.
     *
     */
    metadata?: {
        [key: string]: unknown;
    };
};
type platform6 = 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'sms' | 'phone' | 'rcs';
/**
 * Normalized, platform-agnostic ad-targeting spec. Every field is optional, an
 * empty object targets the platform's default broadest audience. Field names are
 * camelCase and identical across `POST /v1/ads/create` (the `targeting` object),
 * `POST /v1/ads/targeting/reach-estimate`, and `saved_targeting` audiences, so a
 * spec resolved once can be reused verbatim.
 *
 * Entity ids (`regions[].key`, `cities[].key`, `zips[].key`, `metros[].key`,
 * `interests[].id`, `behaviors[].id`) are the platform's opaque identifiers
 * resolved via `GET /v1/ads/targeting/search`. A spec is therefore meaningful only
 * for the platform it was built against, except the portable fields (`countries`,
 * `ageMin`/`ageMax`, `gender`, `incomeTier`, `languages`) which carry across
 * platforms. Fields a platform cannot honour are rejected at create time with
 * `INVALID_FIELD_VALUE` naming the offending field (not silently dropped).
 *
 */
type TargetingSpec = {
    /**
     * ISO 3166-1 alpha-2 country codes (e.g. ['US']).
     */
    countries?: Array<(string)>;
    /**
     * Region/state targeting. `key` is the platform location ID from /v1/ads/targeting/search?dimension=geo&geoType=region.
     */
    regions?: Array<{
        key: string;
        name?: string;
    }>;
    /**
     * City targeting. Optional `radius` + `distanceUnit` extend beyond the city limits; both must be set together or both omitted. `radius` is only honoured on platforms whose capability map allows city radius (Meta).
     */
    cities?: Array<{
        key: string;
        name?: string;
        /**
         * Radius around the city. Requires distanceUnit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng), which allows a smaller radius.
         */
        radius?: number;
        /**
         * Required if radius is set.
         */
        distanceUnit?: 'mile' | 'kilometer';
    }>;
    /**
     * Postal/ZIP targeting. `key` is the platform's postal location ID (e.g. Meta `US:94304`). Supported on Meta, Google, TikTok, Pinterest, X.
     */
    zips?: Array<{
        key: string;
        name?: string;
    }>;
    /**
     * DMA / metro-area targeting. `key` is the platform's metro ID (e.g. Meta `DMA:807`).
     */
    metros?: Array<{
        key: string;
        name?: string;
    }>;
    /**
     * Point-radius (lat/lng) targeting (Meta custom_locations / Google proximity). Honoured only where the capability map allows radius (Meta).
     */
    customLocations?: Array<{
        latitude: number;
        longitude: number;
        /**
         * Positive radius around the point.
         */
        radius: number;
        distanceUnit: 'mile' | 'kilometer';
        name?: string;
        /**
         * Optional label, sent to Meta as `address_string`. latitude/longitude take precedence for the pin location.
         */
        address?: string;
    }>;
    /**
     * Geo to exclude from the audience. Mirrors the inclusion geo shape: excluded cities can carry a radius catchment and excluded custom (lat/lng) pins are supported, both on Meta (excluded_geo_locations).
     */
    excludedLocations?: {
        countries?: Array<(string)>;
        regions?: Array<{
            key: string;
            name?: string;
        }>;
        /**
         * Cities to exclude. Optional `radius` + `distanceUnit` exclude a catchment around the city (both must be set together or both omitted); Meta honours the radius on excluded cities.
         */
        cities?: Array<{
            key: string;
            /**
             * Radius around the excluded city. Requires distanceUnit.
             */
            radius?: number;
            /**
             * Required if radius is set.
             */
            distanceUnit?: 'mile' | 'kilometer';
        }>;
        zips?: Array<{
            key: string;
            name?: string;
        }>;
        /**
         * Named points of interest to exclude. `key` from /v1/ads/targeting/search.
         */
        places?: Array<{
            key: string;
        }>;
        /**
         * Named neighbourhood areas to exclude. `key` from /v1/ads/targeting/search.
         */
        neighborhoods?: Array<{
            key: string;
        }>;
        /**
         * Point-radius (lat/lng) pins to exclude (Meta excluded_geo_locations.custom_locations). Mirrors the inclusion customLocations shape.
         */
        customLocations?: Array<{
            latitude: number;
            longitude: number;
            /**
             * Positive radius around the point.
             */
            radius: number;
            distanceUnit: 'mile' | 'kilometer';
            name?: string;
            /**
             * Optional label, sent to Meta as `address_string`. latitude/longitude take precedence for the pin location.
             */
            address?: string;
        }>;
    };
    ageMin?: number;
    ageMax?: number;
    /**
     * Restrict by gender. 'all' (default) targets everyone. Applied on Meta, TikTok and Pinterest. Ignored on Google, LinkedIn and X.
     */
    gender?: 'all' | 'male' | 'female';
    /**
     * Normalized household-income tier (ZIP/percentile based). Meta and TikTok
     * express all four. Google maps only `top_10` (its INCOME_RANGE_90_UP); other
     * tiers on Google, and any income tier on LinkedIn / X / Pinterest, are rejected.
     * On Meta, income/zip targeting requires the relevant `specialAdCategories` to be
     * unset (housing/employment/credit ads cannot use it).
     *
     */
    incomeTier?: 'top_5' | 'top_10' | 'top_10_25' | 'top_25_50';
    /**
     * Language codes restricting the audience by language. On Meta, ISO 639-1 codes (e.g. ['en']); a bare code targets all regional variants ("en" = all English), or use a region-qualified code ("en_GB", "pt_BR") for a specific one. Unknown codes are rejected.
     */
    languages?: Array<(string)>;
    /**
     * Interest entities from /v1/ads/targeting/search?dimension=interest. Each carries the platform's opaque id.
     */
    interests?: Array<{
        id: string;
        name?: string;
    }>;
    /**
     * Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta and TikTok.
     */
    behaviors?: Array<{
        id: string;
        name?: string;
    }>;
    /**
     * LinkedIn B2B only. Industry URN id fragments.
     */
    industries?: Array<(string)>;
    /**
     * LinkedIn B2B only.
     */
    companySizes?: Array<(string)>;
    /**
     * LinkedIn B2B only.
     */
    seniorities?: Array<(string)>;
    /**
     * LinkedIn B2B only.
     */
    jobFunctions?: Array<(string)>;
    /**
     * Platform audience IDs to include.
     */
    audienceInclude?: Array<(string)>;
    /**
     * Platform audience IDs to exclude.
     */
    audienceExclude?: Array<(string)>;
};
/**
 * Restrict by gender. 'all' (default) targets everyone. Applied on Meta, TikTok and Pinterest. Ignored on Google, LinkedIn and X.
 */
type gender = 'all' | 'male' | 'female';
/**
 * Normalized household-income tier (ZIP/percentile based). Meta and TikTok
 * express all four. Google maps only `top_10` (its INCOME_RANGE_90_UP); other
 * tiers on Google, and any income tier on LinkedIn / X / Pinterest, are rejected.
 * On Meta, income/zip targeting requires the relevant `specialAdCategories` to be
 * unset (housing/employment/credit ads cannot use it).
 *
 */
type incomeTier = 'top_5' | 'top_10' | 'top_10_25' | 'top_25_50';
/**
 * Text, images (up to 10), videos (up to 10), and mixed media albums. Captions up to 1024 chars for media, 4096 for text-only.
 */
type TelegramPlatformData = {
    /**
     * Text formatting mode for the message (default is HTML)
     */
    parseMode?: 'HTML' | 'Markdown' | 'MarkdownV2';
    /**
     * Disable link preview generation for URLs in the message
     */
    disableWebPagePreview?: boolean;
    /**
     * Send the message silently (users will receive notification without sound)
     */
    disableNotification?: boolean;
    /**
     * Protect message content from forwarding and saving
     */
    protectContent?: boolean;
};
/**
 * Text formatting mode for the message (default is HTML)
 */
type parseMode = 'HTML' | 'Markdown' | 'MarkdownV2';
/**
 * Up to 10 images per carousel (no videos). Videos must be H.264/AAC MP4, max 5 min. Images JPEG/PNG, max 8 MB. Use threadItems for reply chains.
 */
type ThreadsPlatformData = {
    /**
     * Topic tag for post categorization and discoverability on Threads. Must be 1-50 characters, cannot contain periods (.) or ampersands (&). Overrides auto-extraction from content hashtags when provided.
     */
    topic_tag?: string;
    /**
     * Complete sequence of posts in a Threads thread. The first item becomes the root post, subsequent items are chained as replies. When threadItems is provided, the top-level content field is used only for display and search purposes, it is NOT published. You must include your first post as threadItems[0].
     *
     */
    threadItems?: Array<{
        content?: string;
        mediaItems?: Array<MediaItem>;
    }>;
};
/**
 * Photo carousels up to 35 images. Video titles up to 2200 chars, photo titles truncated to 90 chars.
 * privacyLevel must match creator_info options. Both camelCase and snake_case accepted.
 *
 * Creator Inbox (draft mode): Set draft: true to send content to the TikTok Creator Inbox
 * instead of publishing immediately. The creator receives an inbox notification and completes
 * the post using TikTok's editing flow. This maps to TikTok's post_mode: "MEDIA_UPLOAD" internally.
 *
 * Important: The field publish_type is NOT supported. Use draft: true for Creator Inbox flow.
 *
 * Photo drafts use the /v2/post/publish/content/init/ endpoint with post_mode: "MEDIA_UPLOAD".
 * Video drafts use the dedicated /v2/post/publish/inbox/video/init/ endpoint.
 *
 * When draft: true, the video.upload scope is required. When draft is false or omitted
 * (direct post), the video.publish scope is required. For Creator Inbox, TikTok app version
 * must be 31.8 or higher.
 *
 */
type TikTokPlatformData = {
    /**
     * When true, sends the post to the TikTok Creator Inbox as a draft instead of publishing
     * immediately. The creator receives an inbox notification to complete posting via TikTok's
     * editing flow. Maps to TikTok API post_mode: "MEDIA_UPLOAD" (photos) or the dedicated
     * inbox endpoint (videos). When false or omitted, publishes directly via post_mode: "DIRECT_POST".
     * Note: publish_type is not a supported field. Use this field instead.
     *
     */
    draft?: boolean;
    /**
     * One of the values returned by the TikTok creator info API for the account
     */
    privacyLevel?: string;
    /**
     * Allow comments on the post
     */
    allowComment?: boolean;
    /**
     * Allow duets (required for video posts)
     */
    allowDuet?: boolean;
    /**
     * Allow stitches (required for video posts)
     */
    allowStitch?: boolean;
    /**
     * Type of commercial content disclosure. Sufficient on its own: "brand_organic"
     * ("Your Brand") implies isBrandOrganicPost and "brand_content" ("Branded Content",
     * paid partnership) implies brandPartnerPromote, so you don't need to send the
     * boolean flags separately. Branded content cannot be posted with privacyLevel
     * SELF_ONLY.
     *
     */
    commercialContentType?: 'none' | 'brand_organic' | 'brand_content';
    /**
     * Whether the post promotes a brand partner (branded content / paid partnership).
     * Only needed to disclose BOTH types at once (set it alongside
     * commercialContentType "brand_organic"), or to override the value implied by
     * commercialContentType.
     *
     */
    brandPartnerPromote?: boolean;
    /**
     * Whether the post promotes the creator's own brand (brand organic). Only needed
     * to disclose BOTH types at once (set it alongside commercialContentType
     * "brand_content"), or to override the value implied by commercialContentType.
     *
     */
    isBrandOrganicPost?: boolean;
    /**
     * User has confirmed they previewed the content
     */
    contentPreviewConfirmed?: boolean;
    /**
     * User has given express consent for posting
     */
    expressConsentGiven?: boolean;
    /**
     * Optional override. Defaults based on provided media items.
     */
    mediaType?: 'video' | 'photo';
    /**
     * Optional for video posts. Timestamp in milliseconds to select which frame to use as thumbnail (defaults to 1000ms/1 second). Ignored when videoCoverImageUrl is provided.
     */
    videoCoverTimestampMs?: number;
    /**
     * Optional for video posts. URL of a custom thumbnail image (JPG, PNG, or WebP, max 20MB). The image is stitched as a single frame at the start of the video and used as the cover. Overrides videoCoverTimestampMs when provided.
     */
    videoCoverImageUrl?: string;
    /**
     * Optional for photo carousels. Index of image to use as cover, 0-based (defaults to 0/first image).
     */
    photoCoverIndex?: number;
    /**
     * When true, TikTok may add recommended music (photos only)
     */
    autoAddMusic?: boolean;
    /**
     * Set true to disclose AI-generated content
     */
    videoMadeWithAi?: boolean;
    /**
     * Optional long-form description for photo posts (max 4000 chars). Recommended when content exceeds 90 chars, as photo titles are auto-truncated.
     */
    description?: string;
};
/**
 * Type of commercial content disclosure. Sufficient on its own: "brand_organic"
 * ("Your Brand") implies isBrandOrganicPost and "brand_content" ("Branded Content",
 * paid partnership) implies brandPartnerPromote, so you don't need to send the
 * boolean flags separately. Branded content cannot be posted with privacyLevel
 * SELF_ONLY.
 *
 */
type commercialContentType = 'none' | 'brand_organic' | 'brand_content';
/**
 * Optional override. Defaults based on provided media items.
 */
type mediaType2 = 'video' | 'photo';
/**
 * A platform measurement tag — the thing you create, install on a
 * website, send events to, and target ads against. On Meta this is a
 * Pixel (`kind: pixel`). The shape is platform-neutral so other platforms
 * (Pinterest Tag, LinkedIn Insight Tag, etc.) can be added without
 * changing the contract; platform-specific fields are simply absent where
 * a platform has no equivalent. Returned by `listTrackingTags`,
 * `createTrackingTag`, `getTrackingTag`, and `updateTrackingTag`.
 *
 */
type TrackingTag = {
    /**
     * Platform-native tag id. Meta: numeric pixel id, as a string.
     */
    id: string;
    name: string;
    platform: 'metaads';
    /**
     * Platform-native flavor of the tag (Meta: `pixel`).
     */
    kind: 'pixel' | 'tag' | 'insight_tag';
    /**
     * `inactive` when the platform reports the tag as broken/unavailable.
     */
    status: 'active' | 'inactive';
    /**
     * The base-code `<script>` snippet to install on the site. Meta only;
     * populated by `getTrackingTag`, omitted from the list view.
     *
     */
    code?: string;
    /**
     * Unix seconds of the last event the tag received, or `null` if it
     * never fired. The practical "is it installed and working" signal.
     *
     */
    lastFiredTime?: (number) | null;
    /**
     * Whether the tag is in a broken/unavailable state (Meta `is_unavailable`).
     */
    isUnavailable?: boolean;
    /**
     * Convenience flag derived from `lastFiredTime` — has the tag ever fired.
     */
    installed?: boolean;
    /**
     * Unix seconds the tag was created.
     */
    creationTime?: number;
    /**
     * Business Manager id that owns the tag, or `null` when the tag lives
     * on a personal (non-BM) ad account — such tags can't be shared with
     * other ad accounts.
     *
     */
    ownerBusinessId?: (string) | null;
    /**
     * Ad account id (`act_...`) that owns the tag, when reported.
     */
    ownerAdAccountId?: string;
};
type platform7 = 'metaads';
/**
 * Platform-native flavor of the tag (Meta: `pixel`).
 */
type kind = 'pixel' | 'tag' | 'insight_tag';
/**
 * X-specific post options. The article field creates a long-form X Article and is mutually exclusive with tweet media and tweet-only options. Geo-restriction applies at the media level: media is hidden outside the specified countries while tweet text remains visible.
 *
 */
type TwitterPlatformData = {
    article?: XArticle;
    /**
     * ID of an existing tweet to reply to. The published tweet will appear as a reply in that tweet's thread. For threads, only the first tweet replies to the target; subsequent tweets chain normally. X only permits replying to your own posts or posts you are mentioned in; replying to an arbitrary other account's post is rejected by X.
     */
    replyToTweetId?: string;
    /**
     * ID (or full status URL) of an existing tweet to quote-repost. The published tweet becomes a quote tweet of the target. Mutually exclusive with media and poll. X only permits quoting your own posts or posts you are mentioned in / part of the conversation thread of; quoting an arbitrary other account's post is rejected by X. Billed at the standard create rate ($0.015), unlike pasting a tweet URL into the text which is billed at the URL rate ($0.20). For threads, applies to the first tweet only.
     */
    quoteTweetId?: string;
    /**
     * Controls who can reply to the tweet. "following" allows only people you follow, "mentionedUsers" allows only mentioned users, "subscribers" allows only subscribers, "verified" allows only verified users. Omit for default (everyone can reply). For threads, applies to the first tweet only. Cannot be combined with replyToTweetId.
     */
    replySettings?: 'following' | 'mentionedUsers' | 'subscribers' | 'verified';
    /**
     * Complete sequence of tweets in a thread. The first item becomes the root tweet, subsequent items are chained as replies. When threadItems is provided, the top-level content field is used only for display and search purposes, it is NOT published. You must include your first tweet as threadItems[0].
     *
     */
    threadItems?: Array<{
        content?: string;
        mediaItems?: Array<MediaItem>;
    }>;
    /**
     * Create a poll with this tweet. Mutually exclusive with media attachments and threads.
     */
    poll?: {
        /**
         * Poll options (2-4 choices, max 25 characters each)
         */
        options: Array<(string)>;
        /**
         * Poll duration in minutes (5 min to 7 days)
         */
        duration_minutes: number;
    };
    /**
     * Enable long video uploads (over 140 seconds) using amplify_video media category. Requires the connected X account to have an active X Premium subscription. When true, videos are uploaded with the amplify_video category which supports longer durations (up to 10 minutes via API). When false or omitted, the standard tweet_video category is used (140 second limit). Note that not all Premium accounts have API long-video access, as X may require separate allowlisting.
     */
    longVideo?: boolean;
    geoRestriction?: GeoRestriction;
    /**
     * When true, the post is labeled by X as a paid partnership / paid promotion. For threads, applies to the root tweet only. Field availability may depend on your X API access tier.
     */
    paidPartnership?: boolean;
    /**
     * When true, the post is labeled by X as containing AI-generated media. Per X, this label is for AI-generated media, not AI-written text. For threads, applies to the root tweet only.
     */
    madeWithAi?: boolean;
    /**
     * Marks attached media with a sensitive-content warning. Applied to every media item in the post (requires media; ignored for text-only tweets). At least one flag must be true for the warning to be sent.
     */
    sensitiveMedia?: {
        /**
         * Content contains adult material.
         */
        adultContent?: boolean;
        /**
         * Content depicts graphic violence.
         */
        graphicViolence?: boolean;
        /**
         * Content has other sensitive characteristics.
         */
        other?: boolean;
    };
};
/**
 * Controls who can reply to the tweet. "following" allows only people you follow, "mentionedUsers" allows only mentioned users, "subscribers" allows only subscribers, "verified" allows only verified users. Omit for default (everyone can reply). For threads, applies to the first tweet only. Cannot be combined with replyToTweetId.
 */
type replySettings = 'following' | 'mentionedUsers' | 'subscribers' | 'verified';
type UploadedFile = {
    type?: 'image' | 'video' | 'document';
    url?: string;
    filename?: string;
    size?: number;
    mimeType?: string;
};
type type8 = 'image' | 'video' | 'document';
type UploadTokenResponse = {
    token?: string;
    uploadUrl?: string;
    expiresAt?: string;
    status?: 'pending' | 'completed' | 'expired';
};
type status8 = 'pending' | 'completed' | 'expired';
type UploadTokenStatusResponse = {
    token?: string;
    status?: 'pending' | 'completed' | 'expired';
    files?: Array<UploadedFile>;
    createdAt?: string;
    expiresAt?: string;
    completedAt?: string;
};
/**
 * Billed spend by product family over a window, from Metronome's invoice
 * breakdown (the CHARGE view). Returned by `GET /v1/usage`.
 *
 */
type UsageMetering = {
    /**
     * False for legacy Stripe accounts (no Metronome invoice to split); `days` and `totals` are then empty/zero.
     */
    supported?: boolean;
    granularity?: 'day' | 'month' | 'total';
    /**
     * One row per bucket. Empty when `granularity=total`. `date` is a UTC date (month buckets use the 1st).
     */
    days?: Array<{
        date?: string;
        accounts?: number;
        numbers?: number;
        calls?: number;
        sms?: number;
        /**
         * 10DLC registration (brand + campaign) fees.
         */
        dlc?: number;
        xApi?: number;
        /**
         * Applied credits/discounts (negative).
         */
        credits?: number;
        other?: number;
    }>;
    /**
     * Sum of each product over the whole window (USD), plus `total`. Unaffected by `granularity`.
     */
    totals?: {
        accounts?: number;
        numbers?: number;
        calls?: number;
        sms?: number;
        dlc?: number;
        xApi?: number;
        credits?: number;
        other?: number;
        total?: number;
    };
    /**
     * Per-invoice-line-item rows (largest spend first) for a detailed breakdown.
     */
    lineItems?: Array<{
        name?: string;
        product?: 'accounts' | 'numbers' | 'calls' | 'sms' | 'dlc' | 'xApi' | 'credits' | 'other';
        totalUsd?: number;
        quantity?: number;
    }>;
    /**
     * Peak counts over the window (Metronome COUNT metrics + live active-number count).
     */
    peaks?: {
        accounts?: number;
        numbers?: number;
    };
    /**
     * Billable call volumes over the window.
     */
    callUsage?: {
        whatsapp?: {
            count?: number;
            minutes?: number;
        };
        pstn?: {
            count?: number;
            minutes?: number;
        };
    };
    period?: {
        start?: string;
        end?: string;
        /**
         * `cycle` = a real billing period resolved; `window` = trailing/custom window (or cycle fallback).
         */
        source?: 'cycle' | 'window';
    };
    /**
     * Estimated tax on the window's net `totals.total`, computed with
     * Stripe Tax against the billing address (the same engine the real
     * invoice uses; invoices apply exclusive tax, so the card is charged
     * total + tax). Null when the account has no billing address on
     * file, the total is zero or negative, or the estimate failed.
     *
     */
    tax?: {
        /**
         * Estimated tax in USD, added on top of `totals.total`.
         */
        taxUsd?: number;
        /**
         * Combined rate percentage, e.g. 21.
         */
        ratePercent?: (number) | null;
        /**
         * Human jurisdiction label, e.g. "ES VAT" or "WA sales tax".
         */
        jurisdictionLabel?: (string) | null;
        /**
         * True for EU/UK B2B reverse charge (0 tax added by design).
         */
        reverseCharge?: boolean;
    } | null;
};
type granularity = 'day' | 'month' | 'total';
/**
 * `cycle` = a real billing period resolved; `window` = trailing/custom window (or cycle fallback).
 */
type source2 = 'cycle' | 'window';
/**
 * Plan and usage stats. The response shape depends on `billingSystem`:
 * * Stripe users (default): per-period counters like `usage.uploads` and
 * `usage.profiles` are returned, scoped by the plan's `limits`.
 * * Metronome users (usage-based): `limits` are unlimited (-1). The
 * `usage` block carries connected-account and per-X-operation counts,
 * and the `spend` block carries current-period costs plus the X cap.
 *
 */
type UsageStats = {
    /**
     * Which billing system the account is on. Shape of `usage`/`spend` differs.
     */
    billingSystem?: 'stripe' | 'metronome';
    planName?: string;
    billingPeriod?: 'monthly' | 'yearly';
    signupDate?: string;
    /**
     * Day of month (1-31) when the billing cycle resets
     */
    billingAnchorDay?: number;
    /**
     * True if the account is in good standing. False for past-due/unpaid/paused subscriptions.
     */
    hasAccess?: boolean;
    /**
     * Stripe customer ID, when present.
     */
    customerId?: (string) | null;
    /**
     * True if this is a team member; limits/usage reflect the account owner.
     */
    isInvitedUser?: boolean;
    /**
     * Stripe-only. Always false for Metronome users.
     */
    autoUpgradeEnabled?: boolean;
    /**
     * Plan limits. For Metronome users both fields are `-1` (unlimited).
     */
    limits?: {
        uploads?: number;
        profiles?: number;
    };
    /**
     * Per-period usage counts. Fields present depend on `billingSystem`:
     * Stripe returns `uploads` / `profiles` / `lastReset`;
     * Metronome returns `connectedAccounts` / `xApiCalls` / `xApiCallsByOperation`.
     *
     */
    usage?: {
        /**
         * Stripe users only. Uploads consumed in the current period.
         */
        uploads?: number;
        /**
         * Stripe users only. Profiles currently owned.
         */
        profiles?: number;
        /**
         * Stripe users only.
         */
        lastReset?: string;
        /**
         * Metronome users only. Accounts currently connected across the team.
         */
        connectedAccounts?: number;
        /**
         * **Deprecated.** Legacy 3-tier aggregate. Operations outside the
         * three historical prices ($0.005/$0.010/$0.015) — notably the
         * $0.200 "Posts with URL" tier added April 2026 — are silently
         * excluded from this shape. Use `xApiCallsByOperation` instead;
         * it captures every tier and is the source of truth for
         * per-operation call counts.
         *
         * @deprecated
         */
        xApiCalls?: {
            /**
             * Calls at $0.005 per call (reads, lists, bookmarks, content manage, etc.)
             */
            x_api_005?: number;
            /**
             * Calls at $0.010 per call (user reads, DM reads, follow reads, trends, list create, privacy update)
             */
            x_api_010?: number;
            /**
             * Calls at $0.015 per call (posts/replies, DM sends, user interactions)
             */
            x_api_015?: number;
        };
        /**
         * Metronome users only. Per-operation X API call counts keyed by
         * operation (e.g. `posts_read`, `content_create`,
         * `content_create_with_url`). Resolve each key to price and metadata
         * via `GET /v1/billing/x-pricing`. This is the canonical source —
         * covers every price tier including the $0.200 URL tier that
         * `xApiCalls` excludes.
         *
         */
        xApiCallsByOperation?: {
            [key: string]: (number);
        };
    };
    /**
     * Metronome users only. Current-period spend summary.
     */
    spend?: {
        /**
         * Total current-period spend in cents (all products combined).
         */
        currentPeriodCents?: number;
        /**
         * Free-tier credit remaining in cents. Applied before any charge.
         */
        creditsRemainingCents?: number;
        /**
         * Current-period X/Twitter API spend in cents, summed from
         * `xApiCallsByOperation` × per-operation prices. Tier-agnostic
         * (covers every price including the $0.200 URL tier). Rounded
         * up for conservative enforcement against `xSpendLimitCents`.
         *
         */
        xSpendCents?: number;
        /**
         * Monthly X spend cap set by the account owner, or null if no cap.
         * When current X spend hits this cap, analytics and inbox sync are
         * auto-paused for X accounts. Publishing is never blocked by this cap.
         *
         */
        xSpendLimitCents?: (number) | null;
    };
};
/**
 * Which billing system the account is on. Shape of `usage`/`spend` differs.
 */
type billingSystem2 = 'stripe' | 'metronome';
type billingPeriod = 'monthly' | 'yearly';
type User = {
    _id?: string;
    email?: string;
    name?: string;
    role?: string;
    createdAt?: string;
};
type UserGetResponse = {
    user?: User;
};
type UsersListResponse = {
    users?: Array<User>;
};
/**
 * One bid-adjustment rule. Rules are evaluated in ARRAY ORDER and only the first matching
 * rule adjusts the bid for an overlapping audience, so the order is semantic.
 *
 */
type ValueRule = {
    /**
     * Platform rule id. Echo it on `PUT` to KEEP this rule, omit it to CREATE a new one.
     * A rule left out of the array entirely is DELETED.
     *
     */
    id?: string;
    name: string;
    /**
     * Direction of the adjustment. There is no signed value field.
     */
    adjustSign: 'INCREASE' | 'DECREASE';
    /**
     * Unsigned percentage magnitude. `INCREASE` accepts 1-1000, `DECREASE` accepts 1-90.
     * 0 is out of range on both.
     *
     */
    adjustValue: number;
    /**
     * Meta returns `ACTIVE` here but documents no enum for the field. Treat it as a
     * passthrough: echo whatever the `GET` returned, and do not synthesize values.
     *
     */
    status?: string;
    /**
     * All criteria on a rule must match for the rule to fire.
     */
    criteria: Array<ValueRuleCriterion>;
};
/**
 * Direction of the adjustment. There is no signed value field.
 */
type adjustSign = 'INCREASE' | 'DECREASE';
/**
 * One matching condition inside a value rule. `criteriaValues` and `criteriaValueTypes`
 * are POSITIONALLY paired: same length, same order.
 *
 */
type ValueRuleCriterion = {
    /**
     * Platform criterion id. Echo it on `PUT` to KEEP this criterion, omit it to CREATE a
     * new one. A criterion left out of the array entirely is DELETED.
     *
     */
    id?: string;
    /**
     * The dimension being matched. `OMNI_CHANNEL` (conversion location: APP, INSTANT_FORM,
     * PHONE_CALL, WEBSITE) is accepted even though Meta's own enum table omits it.
     *
     */
    criteriaType: 'AGE' | 'GENDER' | 'OS_TYPE' | 'DEVICE_PLATFORM' | 'LOCATION' | 'PLACEMENT' | 'OMNI_CHANNEL' | 'AUDIENCE_LABEL';
    /**
     * Required on every criterion. `CONTAINS` is currently the only value Meta supports.
     */
    operator: 'CONTAINS';
    /**
     * The values to match. `AGE` takes ranges such as `18-24`, `18+` or a custom `18-26`;
     * a range whose upper bound is 65 is NOT allowed (use `18+` instead of `18-65`).
     * `LOCATION` takes Targeting-Search keys: a two-letter country code for
     * `LOCATION_COUNTRY`, a numeric key for region / city / comScore market.
     * `AUDIENCE_LABEL` takes labels such as `HIGH_VALUE`, which are applied to a Custom
     * Audience in Ads Manager: there is no API to provision them, so they are passed
     * through unvalidated.
     *
     */
    criteriaValues: Array<(string)>;
    /**
     * One entry per `criteriaValues` entry, in the same order. The literal `"NONE"` for
     * every criteriaType except `LOCATION`, which uses `LOCATION_COUNTRY`,
     * `LOCATION_REGION`, `LOCATION_CITY` or `LOCATION_COMSCORE_MARKET` and MAY mix them
     * within one criterion. `LOCATION_DMA` was replaced by `LOCATION_COMSCORE_MARKET` on
     * 2026-06-22 and is rejected by this API.
     *
     */
    criteriaValueTypes: Array<(string)>;
};
/**
 * The dimension being matched. `OMNI_CHANNEL` (conversion location: APP, INSTANT_FORM,
 * PHONE_CALL, WEBSITE) is accepted even though Meta's own enum table omits it.
 *
 */
type criteriaType = 'AGE' | 'GENDER' | 'OS_TYPE' | 'DEVICE_PLATFORM' | 'LOCATION' | 'PLACEMENT' | 'OMNI_CHANNEL' | 'AUDIENCE_LABEL';
/**
 * Required on every criterion. `CONTAINS` is currently the only value Meta supports.
 */
type operator = 'CONTAINS';
/**
 * A named set of bid-adjustment rules on an ad account. Attach it to an ad set with
 * `valueRuleSetId`. Limits: 6 sets per ad account, 10 rules per set, 4 criteria per rule.
 *
 */
type ValueRuleSet = {
    /**
     * Platform value rule set id.
     */
    id: string;
    name: string;
    /**
     * Evaluated in order; the first matching rule wins.
     */
    rules: Array<ValueRule>;
};
/**
 * A managed OTP verification. The code itself is never returned or stored (hash only).
 */
type Verification = {
    id?: string;
    status?: 'pending' | 'approved' | 'expired' | 'max_attempts_reached' | 'canceled' | 'delivery_failed';
    channel?: 'sms';
    to?: string;
    expiresAt?: string;
    attempts?: number;
    maxAttempts?: number;
    /**
     * Accepted deliveries (initial send + resends); each bills one verification fee.
     */
    sendCount?: number;
    lastSentAt?: (string) | null;
    createdAt?: string;
    /**
     * Present on create responses: true when an active verification was resent instead of created.
     */
    resend?: boolean;
};
type status9 = 'pending' | 'approved' | 'expired' | 'max_attempts_reached' | 'canceled' | 'delivery_failed';
type channel2 = 'sms';
/**
 * Individual webhook configuration for receiving real-time notifications
 */
type Webhook = {
    /**
     * Unique webhook identifier
     */
    _id?: string;
    /**
     * Webhook name (for identification)
     */
    name?: string;
    /**
     * Webhook endpoint URL
     */
    url?: string;
    /**
     * Secret key for HMAC-SHA256 signature verification.
     */
    secret?: string;
    /**
     * Events subscribed to
     */
    events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'verification.approved' | 'verification.failed')>;
    /**
     * Whether webhook delivery is enabled
     */
    isActive?: boolean;
    /**
     * Timestamp of last successful webhook delivery
     */
    lastFiredAt?: string;
    /**
     * Consecutive delivery failures (resets on success, webhook disabled at 10)
     */
    failureCount?: number;
    /**
     * Custom headers included in webhook requests
     */
    customHeaders?: {
        [key: string]: (string);
    };
    /**
     * Resource groups this subscription does not receive (opt-out denylist, same vocabulary and same semantics as the field on API keys). Absent or empty means the subscription receives every event listed in `events`, which is how every subscription created before this field existed behaves. An event whose group is listed here is dropped before delivery even when it is still present in `events`, and the same check runs on every replay path (test fire, redelivery, dead-letter requeue). Editing the denylist applies to every event emitted afterwards; events already queued when the edit landed can still be delivered for up to five minutes after they were enqueued.
     */
    disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
};
/**
 * A single webhook delivery attempt recorded by Zernio (30-day retention).
 */
type WebhookLog = {
    /**
     * ID of the account owner the webhook belongs to
     */
    userId?: string;
    /**
     * ID of the webhook configuration that produced this delivery
     */
    webhookId?: string;
    /**
     * Name of the webhook configuration at delivery time
     */
    webhookName?: string;
    /**
     * Stable webhook event ID (correlates to the delivered payload)
     */
    eventId?: string;
    /**
     * Event type that triggered the delivery (e.g. post.published)
     */
    event?: string;
    /**
     * Destination URL the webhook was delivered to
     */
    url?: string;
    /**
     * Delivery outcome
     */
    status?: 'success' | 'failed';
    /**
     * HTTP status code returned by the destination endpoint
     */
    statusCode?: number;
    /**
     * The JSON payload sent to the destination endpoint
     */
    requestPayload?: {
        [key: string]: unknown;
    };
    /**
     * Response body returned by the destination endpoint
     */
    responseBody?: string;
    /**
     * Error message when delivery failed
     */
    errorMessage?: string;
    /**
     * Delivery attempt number (increments on retries)
     */
    attemptNumber?: number;
    /**
     * Time taken by the destination endpoint to respond, in milliseconds
     */
    responseTime?: number;
    /**
     * Timestamp the delivery was attempted
     */
    createdAt?: string;
};
/**
 * Delivery outcome
 */
type status10 = 'success' | 'failed';
/**
 * Webhook payload for `account.ads.initial_sync_completed` events.
 * Fired once per ads-enabled account when the initial discovery + 90-day
 * ad backfill finishes (whether it succeeded fully, partially, or failed).
 *
 */
type WebhookPayloadAccountAdsInitialSyncCompleted = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'account.ads.initial_sync_completed';
    account: {
        /**
         * The account's unique identifier (same as used in /v1/accounts/{accountId})
         */
        accountId: string;
        /**
         * The profile's unique identifier this account belongs to
         */
        profileId: string;
        platform: string;
        username: string;
        displayName?: string;
        /**
         * The platform-side account/ad-account ID (e.g. Meta ad account ID).
         */
        platformUserId?: string;
        /**
         * URL of the account's profile picture, when available.
         */
        profilePicture?: string;
        /**
         * When the consumer scoped the connect call to a single ad account, this echoes
         * that ID back so the webhook can be correlated to the originating connect
         * request without consulting the consumer's DB. Meta uses the `act_*` shape.
         *
         */
        platformAdAccountId?: string;
        /**
         * Every ad-account ID that the connected token could see at discovery time.
         * Useful for "we synced ads from these accounts" UX without a follow-up API call.
         * Empty array when the token had no ad-account visibility.
         *
         */
        platformAdAccountIds?: Array<(string)>;
    };
    /**
     * Summary of the initial ads sync backfill results.
     */
    sync: {
        /**
         * Overall outcome of the initial sync.
         */
        status: 'success' | 'failure';
        /**
         * Total number of ads discovered for backfill.
         */
        totalAds: number;
        /**
         * Number of ads successfully synced.
         */
        synced: number;
        /**
         * Number of ads that failed to sync.
         */
        failed: number;
        /**
         * Free-form error message from the platform (typically Meta's Marketing API).
         * Truncated to ~2KB. Present when `status` is `failure` (and sometimes on `success`
         * when discovery saw zero ad accounts). For UX branching prefer `errorCategory`;
         * this field is for human display and debugging.
         *
         */
        error?: string;
        /**
         * Platform-native error code if parsed (e.g. Meta `190`, `10`, `200`).
         */
        errorCode?: string;
        /**
         * Platform-native error subcode if parsed.
         */
        errorSubcode?: string;
        /**
         * Stable category for UX branching. New values may be added; existing ones are
         * stable. Mapping:
         * - `token_invalid`: access token is expired or revoked. Reconnect.
         * - `permission_denied`: token lacks required scope, or the user has no role
         * on the Business Manager that owns the ad account. Reconnect with full
         * permissions, or have an admin grant access.
         * - `no_ad_accounts`: token is valid but sees zero ad accounts. The user
         * needs to connect a Business Manager that owns ad accounts.
         * - `rate_limited`: platform throttled us. Sync will retry automatically.
         * - `discovery_failed`: any other platform-side failure. Inspect `error`.
         * - `unknown`: classifier could not categorize the failure.
         *
         */
        errorCategory?: 'token_invalid' | 'permission_denied' | 'no_ad_accounts' | 'rate_limited' | 'discovery_failed' | 'unknown';
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event = 'account.ads.initial_sync_completed';
/**
 * Overall outcome of the initial sync.
 */
type status11 = 'success' | 'failure';
/**
 * Stable category for UX branching. New values may be added; existing ones are
 * stable. Mapping:
 * - `token_invalid`: access token is expired or revoked. Reconnect.
 * - `permission_denied`: token lacks required scope, or the user has no role
 * on the Business Manager that owns the ad account. Reconnect with full
 * permissions, or have an admin grant access.
 * - `no_ad_accounts`: token is valid but sees zero ad accounts. The user
 * needs to connect a Business Manager that owns ad accounts.
 * - `rate_limited`: platform throttled us. Sync will retry automatically.
 * - `discovery_failed`: any other platform-side failure. Inspect `error`.
 * - `unknown`: classifier could not categorize the failure.
 *
 */
type errorCategory2 = 'token_invalid' | 'permission_denied' | 'no_ad_accounts' | 'rate_limited' | 'discovery_failed' | 'unknown';
/**
 * Webhook payload for account connected events
 */
type WebhookPayloadAccountConnected = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'account.connected';
    account: {
        /**
         * The account's unique identifier (same as used in /v1/accounts/{accountId})
         */
        accountId: string;
        /**
         * The profile's unique identifier this account belongs to
         */
        profileId: string;
        platform: string;
        username: string;
        displayName?: string;
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event2 = 'account.connected';
/**
 * Webhook payload for account disconnected events
 */
type WebhookPayloadAccountDisconnected = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'account.disconnected';
    account: {
        /**
         * The account's unique identifier (same as used in /v1/accounts/{accountId})
         */
        accountId: string;
        /**
         * The profile's unique identifier this account belongs to
         */
        profileId: string;
        platform: string;
        username: string;
        displayName?: string;
        /**
         * Whether the disconnection was intentional (user action) or unintentional (token expired/revoked)
         */
        disconnectionType: 'intentional' | 'unintentional';
        /**
         * Human-readable reason for the disconnection
         */
        reason: string;
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event3 = 'account.disconnected';
/**
 * Whether the disconnection was intentional (user action) or unintentional (token expired/revoked)
 */
type disconnectionType = 'intentional' | 'unintentional';
/**
 * Webhook payload for the `ad.status_changed` event. Currently emitted
 * only for Meta (`metaads`).
 *
 * Sourced from two Meta `ad_account` webhook fields:
 * - `in_process_ad_objects` - the ad object finished processing and
 * exited `IN_PROCESS`. `status.raw` carries Meta's `status_name`.
 * - `with_issues_ad_objects` - the ad object entered `WITH_ISSUES`.
 * `status.raw` is `WITH_ISSUES` and the `error` block is populated
 * from Meta's `error_code` / `error_summary` / `error_message`.
 *
 */
type WebhookPayloadAdStatusChanged = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'ad.status_changed';
    /**
     * The connected ad-platform account that owns the ad object.
     */
    account: {
        /**
         * Internal Zernio account ID (same as used in /v1/accounts/{accountId}).
         */
        accountId: string;
        /**
         * Internal Zernio profile ID this account belongs to.
         */
        profileId: string;
        /**
         * Ad platform identifier. Currently always `metaads`.
         */
        platform: string;
        /**
         * Display username of the connected ad-platform account.
         */
        username: string;
        /**
         * Human-readable display name of the account, when available.
         */
        displayName?: string;
    };
    /**
     * The ad-platform object the status change applies to.
     */
    adObject: {
        /**
         * Hierarchy level the status applies to. Mirrors Meta's `level`. Creative-level events are not forwarded.
         */
        level: 'CAMPAIGN' | 'AD_SET' | 'AD';
        /**
         * Platform-native ID of the campaign / ad set / ad. For Meta this is
         * the bare numeric ID (e.g. `120244894077860689`).
         *
         */
        platformId: string;
        /**
         * Platform-native ad-account ID. For Meta this uses the `act_<id>`
         * shape.
         *
         */
        platformAdAccountId: string;
    };
    /**
     * Status info. Branch on `status.raw` to handle each transition.
     */
    status: {
        /**
         * Platform-native status string, forwarded verbatim. For Meta
         * this is `status_name` from `in_process_ad_objects` (e.g.
         * `ACTIVE`, `PAUSED`, `PENDING_REVIEW`, `ARCHIVED`, `DELETED`,
         * `DISAPPROVED`), or `WITH_ISSUES` when sourced from
         * `with_issues_ad_objects`. Not constrained by an `enum` — Meta
         * may add new values.
         *
         */
        raw: string;
    };
    /**
     * Optional. Present on most `WITH_ISSUES` events, carrying the
     * platform's error diagnostics. May be absent on some `WITH_ISSUES`
     * events (Meta does not always include diagnostics). Always absent
     * for any other `status.raw` value. Always null-check before reading.
     *
     */
    error?: {
        /**
         * Platform-native error code, forwarded verbatim. For Meta this
         * is `error_code` as a string. Use as the stable discriminator —
         * `summary` and `message` are localized.
         *
         */
        code: string;
        /**
         * Short human-readable summary (Meta `error_summary`). Localized
         * to the ad-account owner's Meta locale — display only, do not
         * match on it.
         *
         */
        summary?: string;
        /**
         * Full human-readable error message (Meta `error_message`).
         * Localized — display only.
         *
         */
        message?: string;
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event4 = 'ad.status_changed';
/**
 * Hierarchy level the status applies to. Mirrors Meta's `level`. Creative-level events are not forwarded.
 */
type level = 'CAMPAIGN' | 'AD_SET' | 'AD';
/**
 * Webhook payload for the `call.ended` event. Fires on call hangup
 * with the duration and a zero-markup billing breakdown.
 *
 */
type WebhookPayloadCallEnded = {
    id: string;
    event: 'call.ended';
    call: {
        id?: string;
        metaCallId?: (string) | null;
        accountId?: string;
        phoneNumberId?: string;
        direction?: 'inbound' | 'outbound';
        from?: string;
        to?: string;
        startedAt?: string;
        endedAt?: string;
        durationSeconds?: number;
        endReason?: 'hangup' | 'no_answer' | 'rejected' | 'error';
        /**
         * Raw carrier hangup cause behind endReason (e.g. normal_clearing, call_rejected, not_found). Null when the carrier reported none.
         */
        hangupCause?: (string) | null;
        /**
         * SIP response code that ended the call when SIP-signalled (e.g. '403', '486', '603'). endReason collapses all three to 'rejected', so this is what separates a refused destination from a busy line. Null on non-SIP legs.
         */
        sipHangupCause?: (string) | null;
        recordingUrl?: string;
        recordingExpiresAt?: string;
        billing?: {
            /**
             * Meta per-minute charge. Billed by Meta DIRECTLY to your WhatsApp Business Account payment method (your separate Meta invoice). Zernio does NOT charge this. Display only.
             */
            metaCostUSD?: number;
            telnyxCostUSD?: number;
            recordingCostUSD?: number;
            /**
             * The amount Zernio bills you = Telnyx leg + recording. Excludes Meta (billed by Meta directly).
             */
            billableCostUSD?: number;
            /**
             * Full economic cost incl. the Meta portion you pay directly (Meta + Telnyx + recording). Display only, not the Zernio-billed amount.
             */
            totalCostUSD?: number;
        };
    };
    account: InboxWebhookAccount;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event5 = 'call.ended';
/**
 * Webhook payload for the `call.failed` event. Fired when a call
 * setup or in-progress call fails.
 *
 */
type WebhookPayloadCallFailed = {
    id: string;
    event: 'call.failed';
    call: {
        id?: string;
        metaCallId?: (string) | null;
        accountId?: string;
        phoneNumberId?: string;
        direction?: 'inbound' | 'outbound';
        from?: string;
        to?: string;
        failedAt?: string;
        error?: {
            code?: number;
            message?: string;
        };
    };
    account: InboxWebhookAccount;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event6 = 'call.failed';
/**
 * Webhook payload for the `call.permission_request` event. Fires
 * when a consumer accepts or rejects an interactive
 * `call_permission_request` message.
 *
 */
type WebhookPayloadCallPermissionRequest = {
    id: string;
    event: 'call.permission_request';
    permission: {
        /**
         * Consumer wa_id who replied
         */
        from?: string;
        response?: 'accept' | 'reject';
        isPermanent?: boolean;
        /**
         * Present only when temporary
         */
        expirationTimestamp?: string;
        /**
         * Meta's response source, typically `user_action`
         */
        responseSource?: string;
    };
    account: InboxWebhookAccount;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event7 = 'call.permission_request';
type response = 'accept' | 'reject';
/**
 * Webhook payload for the `call.received` event. Fires for both
 * inbound (UIC) and outbound (BIC) calls; branch on
 * `call.direction` to tell them apart.
 *
 */
type WebhookPayloadCallReceived = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'call.received';
    call: {
        /**
         * Internal Zernio Call doc id
         */
        id?: string;
        /**
         * Meta wacid.* call id when known
         */
        metaCallId?: (string) | null;
        accountId?: string;
        /**
         * Meta phone_number_id
         */
        phoneNumberId?: string;
        direction?: 'inbound' | 'outbound';
        /**
         * Consumer wa_id / E.164
         */
        from?: string;
        /**
         * Business number (E.164)
         */
        to?: string;
        /**
         * Destination snapshot at routing time
         */
        forwardTo?: string;
        contactId?: string;
        conversationId?: string;
        startedAt?: string;
    };
    account: InboxWebhookAccount;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event8 = 'call.received';
/**
 * Webhook payload for comment received events (Instagram, Facebook, Twitter/X, YouTube, LinkedIn, Bluesky, Reddit)
 */
type WebhookPayloadComment = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'comment.received';
    comment: {
        /**
         * Platform comment ID
         */
        id: string;
        /**
         * Internal post ID (null for posts not published through Zernio)
         */
        postId: (string) | null;
        /**
         * Platform's post ID
         */
        platformPostId: string;
        platform: 'instagram' | 'facebook' | 'twitter' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit';
        /**
         * Comment text content
         */
        text: string;
        author: {
            /**
             * Author's platform ID
             */
            id: string;
            username?: string;
            name?: string;
            picture?: (string) | null;
            /**
             * True when this comment was authored by the connected account itself (Meta re-delivers the account's own replies as comments events). Populated on the Instagram and Facebook realtime webhooks only; absent means not evaluated, never "not the account".
             */
            isOwnAccount?: boolean;
            /**
             * Instagram only, best-effort. Present ONLY for commenters who have
             * messaged the account before: Meta gates the follow relationship behind
             * messaging consent, and commenting does not grant it. Absent otherwise -
             * treat a missing object as "unknown", never as "not a follower". To check
             * on demand, call GET /v1/accounts/{accountId}/follow-status/{userId}.
             *
             */
            instagramProfile?: {
                /**
                 * The commenter follows this account.
                 */
                isFollower?: (boolean) | null;
                /**
                 * This account follows the commenter.
                 */
                isFollowing?: (boolean) | null;
                followerCount?: (number) | null;
                isVerified?: (boolean) | null;
            };
        };
        createdAt: string;
        /**
         * Whether this is a reply to another comment
         */
        isReply: boolean;
        /**
         * Parent comment ID if this is a reply
         */
        parentCommentId: (string) | null;
        /**
         * Ad context. Present only when the comment was made on paid content.
         * Instagram: populated from the webhook payload's value.media.ad_id and value.media.ad_title.
         * Facebook: populated via a Graph API lookup of the parent post's promotion_status.
         * Absent for comments on organic posts that are not currently promoted.
         *
         */
        ad?: {
            /**
             * Meta ad ID (Instagram only).
             */
            id?: string;
            /**
             * Ad creative title (Instagram only).
             */
            title?: string;
            /**
             * Facebook promotion status returned by Graph API. Common values:
             * "active" (organic post currently boosted), "ineligible" (dark
             * post or ad creative, not promotable because it already is an ad).
             *
             */
            promotionStatus?: string;
        };
        /**
         * Facebook only. Present on graphic-only comments (sticker, GIF, photo) that
         * carry no text. URLs are ephemeral and may expire for Meta platforms (oe= expiry),
         * so fetch promptly. Instagram comments do not support attachments.
         *
         */
        attachment?: {
            /**
             * Attachment type: sticker, animated_image_share, or photo.
             */
            type: string;
            /**
             * Rendered image/preview URL (from attachment.media.image.src).
             */
            imageUrl?: string;
            /**
             * Source URL (from attachment.url). For GIFs this is an l.facebook.com redirect.
             */
            url?: string;
        };
    };
    post: {
        /**
         * Internal post ID (null for posts not published through Zernio)
         */
        id: (string) | null;
        /**
         * Platform's post ID
         */
        platformPostId: string;
        /**
         * Post text, from our synced copy — no platform call is made on the comment path, so null when the post was never synced.
         */
        content: (string) | null;
        /**
         * Post thumbnail or first media item URL. Platform CDN URLs expire, fetch promptly.
         */
        imageUrl: (string) | null;
        /**
         * Public URL of the post. Null for posts published through Zernio that were never re-synced.
         */
        permalink: (string) | null;
    };
    account: {
        /**
         * Social account ID
         */
        id: string;
        /**
         * Social account ID (same as id); canonical field for account filtering.
         */
        accountId?: string;
        platform: string;
        username: string;
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event9 = 'comment.received';
type platform8 = 'instagram' | 'facebook' | 'twitter' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit';
/**
 * Fired once when a new conversation begins, in either direction. A conversation
 * starts the first time an account and a contact exchange a message on any DM
 * platform (Instagram, Messenger/Facebook, Telegram, WhatsApp, Twitter, Reddit,
 * Bluesky, SMS). Platform-agnostic — one subscription covers every DM platform.
 *
 */
type WebhookPayloadConversationStarted = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'conversation.started';
    conversation: {
        /**
         * Internal conversation ID
         */
        id: string;
        platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'slack';
        platformConversationId: string;
        /**
         * Contact's platform identifier (IGSID, PSID, wa_id, etc.)
         */
        participantId?: string;
        participantName: string;
        /**
         * Contact's handle when the platform exposes one
         */
        participantUsername?: string;
        participantPicture?: string;
        status: 'active' | 'archived';
        /**
         * Zernio CRM Contact ID for the participant, when one exists. Resolved by
         * joining `participantId` to the ContactChannel collection (same join
         * used by message.*, reaction.received, and call.* webhooks). Best-effort:
         * omitted when no channel matches or `participantId` is absent. Lets
         * integrators seed the CRM straight from `conversation.started` without
         * waiting for the first `message.*` event.
         *
         */
        contactId?: string;
    };
    account: InboxWebhookAccount;
    /**
     * When the conversation document was created.
     */
    startedAt: string;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event10 = 'conversation.started';
type platform9 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'slack';
/**
 * Webhook payload for post.external.created / post.external.updated /
 * post.external.deleted. Fired by Zernio's background sync when it detects a
 * natively-authored post (e.g. a Google Business Profile localPost created in
 * the Google UI), NOT a post published through Zernio. Poll-driven (~hourly),
 * not real-time. On post.external.deleted, post.deletedAt is populated.
 *
 */
type WebhookPayloadExternalPost = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'post.external.created' | 'post.external.updated' | 'post.external.deleted';
    post: ExternalPostWebhookPost;
    account: {
        id: string;
        /**
         * Social account ID (same as id); canonical field for account filtering.
         */
        accountId?: string;
        platform: string;
        username: string;
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event11 = 'post.external.created' | 'post.external.updated' | 'post.external.deleted';
/**
 * Webhook payload for lead.received events (Meta Lead Gen / Instant Forms).
 */
type WebhookPayloadLead = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'lead.received';
    lead: {
        /**
         * Zernio lead ID (AdLead document ID)
         */
        id: string;
        /**
         * Meta lead ID (the platform's leadgen_id)
         */
        leadgenId: string;
        /**
         * Lead Gen form ID the lead was submitted against
         */
        formId: string;
        /**
         * Human-readable form name (best-effort; may be null)
         */
        formName?: (string) | null;
        /**
         * Meta ad ID that drove the lead (null for organic/test leads)
         */
        adId?: (string) | null;
        adsetId?: (string) | null;
        campaignId?: (string) | null;
        /**
         * Flattened question key -> answer map. For multiple-choice questions the value is the option key (e.g. "k1"), not the display label.
         *
         */
        fields: {
            [key: string]: (string);
        };
        /**
         * True when the lead came from an organic post rather than a paid ad
         */
        isOrganic: boolean;
        /**
         * Meta's lead creation time (ISO 8601)
         */
        createdAt: string;
    };
    account: {
        /**
         * Social account ID (the facebook account owning the Page)
         */
        id: string;
        /**
         * Social account ID (same as id); canonical field for account filtering.
         */
        accountId?: string;
        platform: 'facebook';
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event12 = 'lead.received';
type platform10 = 'facebook';
/**
 * Webhook payload for message received events
 */
type WebhookPayloadMessage = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'message.received';
    message: {
        /**
         * Internal message ID
         */
        id: string;
        /**
         * Internal conversation ID
         */
        conversationId: string;
        platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'sms';
        /**
         * Platform's message ID
         */
        platformMessageId: string;
        direction: 'incoming' | 'outgoing';
        /**
         * Message text content
         */
        text: (string) | null;
        attachments: Array<{
            /**
             * Attachment type (image, video, file, sticker, audio)
             */
            type: string;
            /**
             * Where to fetch the attachment. **The contract differs by platform.**
             *
             * - **WhatsApp**: points at `GET /v1/whatsapp/media/{mediaId}`, an
             * authenticated Zernio endpoint. You MUST send
             * `Authorization: Bearer <your API key>`; fetching it without that
             * header returns `401`. Download and store the bytes when this
             * webhook arrives: Meta drops inbound media after a limited
             * retention window, after which the endpoint answers `400`
             * permanently and the media is unrecoverable.
             * - **Instagram / Facebook / Telegram**: a direct platform CDN link
             * that needs no authentication and expires on the platform's own
             * schedule.
             *
             */
            url: string;
            /**
             * Additional attachment metadata
             */
            payload?: {
                [key: string]: unknown;
            };
        }>;
        sender: {
            /**
             * Sender's platform identifier. For WhatsApp this is the phone
             * number (without leading `+`) when available, otherwise the
             * `businessScopedUserId`.
             *
             */
            id: string;
            /**
             * Zernio CRM Contact id for this sender, when one exists (omitted for outgoing/business sender).
             */
            contactId?: string;
            name?: string;
            username?: string;
            picture?: string;
            /**
             * WhatsApp only. Sender's phone number in E.164 format (with leading `+`).
             *
             * **Nullable during the BSUID rollout (April 2026+).** WhatsApp
             * users who adopt a username can message businesses without
             * exposing a phone number — this field is omitted for them.
             * Match by `businessScopedUserId` instead. See
             * `docs/whatsapp-bsuid-migration.md`.
             *
             */
            phoneNumber?: (string) | null;
            /**
             * WhatsApp only. Business-scoped user ID (BSUID) — Meta's canonical
             * identifier for a WhatsApp user within your business. Present
             * when Meta includes it in the inbound payload (rollout in
             * progress since early April 2026). **Recommended primary identity
             * anchor** going forward; fall back to `phoneNumber` only when
             * this field is absent.
             *
             */
            businessScopedUserId?: string;
            /**
             * WhatsApp only. Parent BSUID for businesses with linked business
             * portfolios. Omitted for standalone portfolios.
             *
             */
            parentBusinessScopedUserId?: string;
            /**
             * WhatsApp only. User's WhatsApp username (e.g. `@jane`). Not a
             * stable identifier — users can change it. Useful for display,
             * not recommended as an identity anchor.
             *
             */
            whatsappUsername?: string;
            /**
             * Instagram profile data for the sender. Only present for Instagram conversations.
             */
            instagramProfile?: {
                /**
                 * Whether the sender follows your Instagram business account
                 */
                isFollower?: (boolean) | null;
                /**
                 * Whether your Instagram business account follows the sender
                 */
                isFollowing?: (boolean) | null;
                /**
                 * The sender's follower count on Instagram
                 */
                followerCount?: (number) | null;
                /**
                 * Whether the sender is a verified Instagram user
                 */
                isVerified?: (boolean) | null;
            };
        };
        sentAt: string;
        isRead: boolean;
    };
    conversation: InboxWebhookConversation;
    account: InboxWebhookAccount;
    /**
     * Platform-specific message context (present when the message is a quick reply tap, postback button tap, inline keyboard callback, or a quote-reply to an earlier message)
     */
    metadata?: {
        /**
         * platformMessageId of the message this one is a quote-reply to.
         * WhatsApp (`context.id`), Instagram and Facebook Messenger
         * (`reply_to.mid`). On `message.sent` echoes (operator replied
         * from the native app) this is the only metadata field populated.
         *
         */
        quotedMessageId?: string;
        /**
         * Payload from a quick reply tap (Facebook/Instagram Messenger).
         */
        quickReplyPayload?: string;
        /**
         * Payload from a postback button tap (Facebook/Instagram Messenger).
         */
        postbackPayload?: string;
        /**
         * Title of the tapped postback button (Facebook/Instagram Messenger).
         */
        postbackTitle?: string;
        /**
         * Callback data from an inline keyboard button tap (Telegram).
         */
        callbackData?: string;
        /**
         * WhatsApp only. Which kind of interactive reply the user sent:
         * `button_reply` (tap on an interactive button), `list_reply` (tap on a
         * list row), or `nfm_reply` (a WhatsApp Flow submission).
         *
         */
        interactiveType?: 'button_reply' | 'list_reply' | 'nfm_reply';
        /**
         * WhatsApp only. The `id` of the tapped button or list row, matching the
         * `id` you supplied when the message was sent. Not set for Flow responses.
         *
         */
        interactiveId?: string;
        /**
         * WhatsApp only. Payload attached to a tapped template button. Template
         * buttons emit a plain `button` webhook (not an interactive reply), so
         * `interactiveType` is empty while this field is populated.
         *
         */
        buttonPayload?: string;
        /**
         * WhatsApp only. Raw `nfm_reply.response_json` string returned by a
         * Flow submission. Useful if you need the exact wire payload; for
         * typed access use `flowResponseData` instead.
         *
         */
        flowResponseJson?: string;
        /**
         * WhatsApp only. Parsed Flow response JSON. Populated when
         * `flowResponseJson` is valid JSON; otherwise omitted. Keys and
         * value types depend on the specific Flow that was submitted.
         *
         */
        flowResponseData?: {
            [key: string]: unknown;
        };
        /**
         * WhatsApp only. Cart submitted by the user from a commerce message
         * (catalog, product, or product-list message). Meta's `order` object
         * forwarded verbatim.
         *
         */
        order?: {
            /**
             * Meta catalog the ordered products belong to.
             */
            catalog_id?: string;
            /**
             * Optional free-text note the user attached to the cart.
             */
            text?: string;
            product_items?: Array<{
                /**
                 * Retailer ID (SKU) of the ordered product.
                 */
                product_retailer_id?: string;
                /**
                 * Quantity ordered for this line item.
                 */
                quantity?: number;
                /**
                 * Unit price of the item.
                 */
                item_price?: number;
                /**
                 * ISO 4217 currency code (e.g. USD).
                 */
                currency?: string;
            }>;
        };
        /**
         * WhatsApp only. The product the user is asking about. Set when an
         * inbound text carries Meta's `context.referred_product` (the user
         * tapped "Message business" on a product). Forwarded verbatim.
         *
         */
        referredProduct?: {
            /**
             * Meta catalog the product belongs to.
             */
            catalog_id?: string;
            /**
             * Retailer ID (SKU) of the product being asked about.
             */
            product_retailer_id?: string;
        };
        /**
         * WhatsApp only. Contact cards the user shared, forwarded verbatim
         * from Meta. Read `contactsOrigin` before treating any number here
         * as the sender's own.
         *
         */
        contacts?: Array<{
            [key: string]: unknown;
        }>;
        /**
         * WhatsApp only. How the contact card was shared.
         * `contact_request` means the user tapped a `request_contact_info`
         * button, so the number is their own and consented. `other` means
         * they picked a card from their address book: it may be anyone's,
         * and must NOT be stored as the sender's identity. Omitted when
         * Meta sends no origin.
         *
         */
        contactsOrigin?: 'contact_request' | 'other';
        /**
         * Instagram only. Populated when an IG user replies to one of the
         * account's stories (Meta `messaging_story_replies`). Mutually
         * exclusive in practice with `isStoryMention`.
         *
         */
        storyReply?: {
            /**
             * The Instagram story ID the user replied to.
             */
            storyId: string;
            /**
             * Meta CDN URL for the story media. Expires approximately
             * 24 hours after the story posted; consumers must fetch
             * promptly or treat 404s as expected.
             *
             */
            storyUrl?: string;
        };
        /**
         * Instagram only. True when the message was generated by an IG
         * user mentioning the account in their own story (`story_mention`
         * attachment type). Mutually exclusive in practice with `storyReply`.
         *
         */
        isStoryMention?: boolean;
        /**
         * Click attribution forwarded verbatim from Meta. Populated only on
         * the FIRST inbound message after the click; absent on subsequent
         * messages of the same conversation. On Instagram and Messenger a
         * RETURNING click also attaches it to the first message that
         * follows, so read it on every `message.received` for per-click
         * attribution; a click that opens an existing thread WITHOUT a
         * message arrives as the separate `referral.received` event.
         *
         * The populated subset identifies the source:
         * - `ctwa_clid` and `source_*` fields: WhatsApp CTWA
         * (Click-to-WhatsApp). Attribution window is 7 days from click.
         * Forward to Meta Conversions API for Business Messaging replay.
         * - `ad_id` and `ads_context_data`: Facebook Messenger CTM
         * (Click-to-Message) or Instagram CTD (Click-to-Direct). Use
         * `ad_id` to attribute the conversation to a specific ad.
         * - `ref` without `ad_id`: an ig.me / m.me link carrying a
         * `?ref=` parameter (`source` is `SHORTLINK`, `SHORTLINKS` or
         * `IGME-SOURCE-LINK` depending on surface - treat it as
         * opaque). Instagram delivers ig.me refs on new threads only
         * when the account has at least one Ice Breaker configured
         * (`PUT /v1/accounts/{accountId}/instagram-ice-breakers`).
         *
         */
        referral?: {
            /**
             * Meta's GCLID-equivalent click identifier.
             */
            ctwa_clid?: string;
            source_id?: string;
            source_type?: string;
            source_url?: string;
            headline?: string;
            body?: string;
            media_type?: string;
            image_url?: string;
            video_url?: string;
            thumbnail_url?: string;
            /**
             * Facebook Messenger CTM / Instagram CTD only. The Meta ad ID the
             * user clicked to start the conversation.
             *
             */
            ad_id?: string;
            /**
             * The `ref` parameter passed through from the Meta ad creative
             * or from an ig.me / m.me link. Instagram / Facebook Messenger
             * only.
             *
             */
            ref?: string;
            /**
             * Meta-supplied source identifier (`ADS` for ad clicks;
             * `SHORTLINK`, `SHORTLINKS` or `IGME-SOURCE-LINK` for ref
             * links). Instagram / Facebook Messenger only.
             *
             */
            source?: string;
            /**
             * Meta-supplied referral type (e.g. `OPEN_THREAD`). Instagram /
             * Facebook Messenger only.
             *
             */
            type?: string;
            /**
             * URI of the originating site, when Meta supplies one (m.me
             * links opened from the web). Facebook Messenger only.
             *
             */
            referer_uri?: string;
            /**
             * Snapshot of the ad's public context at click time. Facebook
             * Messenger CTM / Instagram CTD only.
             *
             */
            ads_context_data?: {
                ad_title?: string;
                photo_url?: string;
                video_url?: string;
                post_id?: string;
                product_id?: string;
                flow_id?: string;
            };
        } | null;
        /**
         * WhatsApp only. Meta's own reason this message has no
         * renderable body. Present when Meta attached an error to the
         * inbound payload; in practice the `unsupported`, `errors` and
         * `unknown` types (code 131051: message type currently not
         * supported). `text` on those messages is the fixed
         * `[Unsupported message]` placeholder.
         *
         */
        unsupported?: {
            /**
             * Meta's numeric error code (e.g. 131051).
             */
            code?: number;
            /**
             * Meta's short error title.
             */
            title?: string;
            /**
             * Meta's human-readable error detail string.
             */
            details?: string;
        };
        /**
         * Instagram / Facebook Messenger only. Set when the message
         * carries nothing an integrator can render (a `template`
         * attachment with no text and no parseable content, or Meta's
         * own `is_unsupported` flag). Sibling of `unsupported` above
         * (WhatsApp only, carries Meta's error code/title/details): this
         * field has no error envelope, just the boolean. Absence means
         * "not flagged", never "checked and renderable".
         *
         */
        noRenderableContent?: boolean;
    } | null;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event13 = 'message.received';
/**
 * WhatsApp only. Which kind of interactive reply the user sent:
 * `button_reply` (tap on an interactive button), `list_reply` (tap on a
 * list row), or `nfm_reply` (a WhatsApp Flow submission).
 *
 */
type interactiveType = 'button_reply' | 'list_reply' | 'nfm_reply';
/**
 * WhatsApp only. How the contact card was shared.
 * `contact_request` means the user tapped a `request_contact_info`
 * button, so the number is their own and consented. `other` means
 * they picked a card from their address book: it may be anyone's,
 * and must NOT be stored as the sender's identity. Omitted when
 * Meta sends no origin.
 *
 */
type contactsOrigin = 'contact_request' | 'other';
/**
 * Webhook payload for message.deleted events. Fires when the sender
 * deletes (unsends) a message. Supported platforms: Instagram (incoming
 * unsend) and WhatsApp (when the business deletes an outgoing message
 * via the Cloud API).
 *
 * The message.text and message.attachments fields retain the content
 * that existed before the delete. The Zernio dashboard UI does not show
 * this content, but authorized API consumers may access it for
 * moderation, compliance, or archival use cases.
 *
 */
type WebhookPayloadMessageDeleted = {
    id: string;
    event: 'message.deleted';
    message: InboxWebhookMessage;
    deletedAt: string;
    conversation: InboxWebhookConversation;
    account: InboxWebhookAccount;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event14 = 'message.deleted';
/**
 * Shared payload for message.delivered, message.read, and
 * message.failed events. Fires when the platform reports a new
 * delivery state for an outgoing message.
 *
 * Platform support:
 * * message.delivered: WhatsApp, Facebook Messenger, SMS.
 * * message.read: WhatsApp, Facebook Messenger, Instagram. Not SMS
 * (carriers report delivery, never read).
 * * message.failed: WhatsApp and SMS (other platforms don't expose
 * per-message failure via webhook). On SMS, `error.code` is the
 * carrier's numeric code and `error.message` its reason.
 *
 */
type WebhookPayloadMessageDeliveryStatus = {
    id: string;
    event: 'message.delivered' | 'message.read' | 'message.failed';
    message: InboxWebhookMessage;
    /**
     * When the platform reported this status.
     */
    statusAt: string;
    /**
     * Populated only on message.failed.
     */
    error?: {
        code?: number;
        title?: string;
        message?: string;
        /**
         * Plain-language translation of `code` (e.g. for 131026, that the
         * recipient has likely opted out of marketing messages while utility
         * templates are unaffected). Null for unmapped codes; fall back to
         * title/message.
         *
         */
        explanation?: (string) | null;
    } | null;
    conversation: InboxWebhookConversation;
    account: InboxWebhookAccount;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event15 = 'message.delivered' | 'message.read' | 'message.failed';
/**
 * Webhook payload for message.edited events. Fires when the sender
 * edits a previously-sent message. Supported platforms: Instagram,
 * Facebook Messenger, Telegram. The message object reflects the
 * LATEST state; editHistory contains every prior version in order
 * (oldest first), so the last entry is the version immediately before
 * the current content.
 *
 */
type WebhookPayloadMessageEdited = {
    id: string;
    event: 'message.edited';
    message: InboxWebhookMessage;
    /**
     * Prior versions of the message, oldest first.
     */
    editHistory: Array<InboxMessageEditHistoryEntry>;
    /**
     * Total number of edits applied to this message.
     */
    editCount: number;
    /**
     * When the most recent edit happened.
     */
    editedAt: string;
    conversation: InboxWebhookConversation;
    account: InboxWebhookAccount;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event16 = 'message.edited';
/**
 * Webhook payload for message sent events (fired when a message is sent via the API, or from the WhatsApp Business app on Coexistence numbers)
 */
type WebhookPayloadMessageSent = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'message.sent';
    message: {
        /**
         * Internal message ID
         */
        id: string;
        /**
         * Internal conversation ID
         */
        conversationId: string;
        platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp';
        /**
         * Platform's message ID
         */
        platformMessageId: string;
        direction: 'incoming' | 'outgoing';
        /**
         * Message text content
         */
        text: (string) | null;
        attachments: Array<{
            /**
             * Attachment type (image, video, file, sticker, audio)
             */
            type: string;
            /**
             * Where to fetch the attachment. For outgoing messages this is the
             * media URL as sent, so for WhatsApp it is the URL you supplied when
             * publishing (WhatsApp sends media by link), not a Zernio endpoint,
             * and it needs no Zernio credentials. Contrast the inbound direction:
             * `message.received` attachment URLs on WhatsApp point at the
             * authenticated `GET /v1/whatsapp/media/{mediaId}`.
             *
             */
            url: string;
            /**
             * Additional attachment metadata
             */
            payload?: {
                [key: string]: unknown;
            };
        }>;
        sender: {
            id: string;
            /**
             * Always omitted on this event: the sender is the business, not a contact. Use conversation.contactId to join back to the CRM Contact.
             */
            contactId?: string;
            name?: string;
            username?: string;
            picture?: string;
        };
        sentAt: string;
        isRead: boolean;
        /**
         * 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). Absent on non-WhatsApp platforms. This is not the inbox metadata.source lineage field.
         */
        source?: 'whatsapp_business_app' | 'cloud_api';
    };
    conversation: InboxWebhookConversation;
    account: InboxWebhookAccount;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event17 = 'message.sent';
type platform11 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp';
/**
 * 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). Absent on non-WhatsApp platforms. This is not the inbox metadata.source lineage field.
 */
type source3 = 'whatsapp_business_app' | 'cloud_api';
/**
 * Webhook payload for post events
 */
type WebhookPayloadPost = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
    post: {
        id: string;
        content: string;
        status: string;
        scheduledFor: string;
        publishedAt?: string;
        platforms: Array<{
            platform: string;
            status: string;
            /**
             * SocialAccount id this platform target published through. Use it to route events by connected account (e.g. separate staging vs production endpoints). A post can span multiple accounts.
             */
            accountId?: string;
            platformPostId?: string;
            publishedUrl?: string;
            error?: string;
        }>;
        /**
         * The free-form `metadata` object supplied when the post was created, echoed back so you can map events onto your own records. Omitted when the post was created without it.
         */
        metadata?: {
            [key: string]: unknown;
        };
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event18 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
/**
 * Webhook payload for the per-platform terminal events
 * `post.platform.published` and `post.platform.failed`, for
 * `post.platform.deleted` (same shape, fired when Zernio's background
 * sync detects that a platform target published through Zernio was
 * later deleted on the platform; poll-driven ~hourly, not real-time),
 * and for `post.tiktok.url_resolved` (same shape, fired when a
 * published TikTok post's public URL is backfilled). Terminal events
 * fire once per platform target inside a post as that platform
 * reaches a terminal state (published or permanent failure). The
 * `post` envelope mirrors the shape of `WebhookPayloadPost` so
 * consumers can reuse rendering logic; the `platform` block
 * identifies which specific platform transitioned; the `account`
 * block identifies the connected social account behind that
 * platform-write.
 *
 */
type WebhookPayloadPostPlatform = {
    /**
     * Stable webhook event ID.
     */
    id: string;
    event: 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved';
    post: {
        id: string;
        content: string;
        /**
         * Post-level status AT FIRE TIME. May still be `publishing`
         * if other platforms haven't terminated; check this field
         * rather than assuming.
         *
         */
        status: string;
        scheduledFor: string;
        publishedAt?: string;
        platforms: Array<{
            platform: string;
            status: string;
            /**
             * SocialAccount id this platform target published through. On post.platform.* events see also the top-level `account` block.
             */
            accountId?: string;
            platformPostId?: string;
            publishedUrl?: string;
            error?: string;
        }>;
        /**
         * The free-form `metadata` object supplied when the post was created, echoed back so you can map events onto your own records. Omitted when the post was created without it.
         */
        metadata?: {
            [key: string]: unknown;
        };
    };
    /**
     * The specific platform that just transitioned to a terminal state.
     */
    platform: {
        /**
         * Platform name (e.g. `twitter`, `tiktok`, `instagram`).
         */
        name: string;
        /**
         * Terminal status this event fires on. Matches the event suffix.
         */
        status: 'published' | 'failed' | 'deleted';
        /**
         * Platform-native post id. Present on `published` and `deleted`, absent on `failed`.
         */
        platformPostId?: string;
        /**
         * Public URL to the platform-side post. Present on `published` (when the platform exposes one and it is not a draft) and on `deleted` (when one was recorded at publish time).
         */
        publishedUrl?: string;
        /**
         * Error message from the platform. Present on `failed` only.
         */
        error?: string;
        /**
         * When the platform-side deletion was detected by Zernio sync (ISO 8601). Present only on `post.platform.deleted`.
         */
        deletedAt?: string;
    };
    /**
     * The connected social account the platform-write went through.
     */
    account: {
        accountId: string;
        platform: string;
        username: string;
        displayName?: string;
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event19 = 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved';
/**
 * Terminal status this event fires on. Matches the event suffix.
 */
type status12 = 'published' | 'failed' | 'deleted';
/**
 * Webhook payload for reaction received events (WhatsApp, Telegram, Slack, Instagram, Facebook Messenger)
 */
type WebhookPayloadReaction = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'reaction.received';
    reaction: {
        /**
         * The emoji reacted with. May be an empty string when `action` is
         * `removed` on WhatsApp (Meta does not report which emoji was removed).
         *
         */
        emoji: string;
        action: 'added' | 'removed';
        /**
         * Internal Zernio message ID of the reacted-to message, when resolvable from the platform ID.
         */
        messageId?: string;
        /**
         * Platform-native ID of the reacted-to message (e.g. WhatsApp wamid).
         */
        platformMessageId: string;
        /**
         * Whoever added or removed the reaction. Usually the participant, but on WhatsApp, Slack, Instagram and Facebook Messenger it is the business own platform id when the business reacted from the native app or via the reactions API: compare it with conversation.participantId.
         */
        sender: {
            id: string;
            /**
             * Zernio CRM Contact id for this sender, when one exists.
             */
            contactId?: string;
            name?: string;
            username?: string;
            picture?: string;
            /**
             * WhatsApp only. Sender's phone number in E.164 format (with leading `+`), when available.
             */
            phoneNumber?: (string) | null;
        };
        reactedAt: string;
    };
    conversation: InboxWebhookConversation;
    account: InboxWebhookAccount;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event20 = 'reaction.received';
type action = 'added' | 'removed';
/**
 * Webhook payload for referral received events (Instagram, Facebook Messenger)
 */
type WebhookPayloadReferral = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'referral.received';
    /**
     * Meta's referral object, forwarded verbatim. Same shape as
     * `metadata.referral` on `message.received`: `ref` + `source` for
     * ig.me / m.me links, `ad_id` + `ads_context_data` for returning
     * Messenger ad clicks.
     *
     */
    referral: {
        /**
         * The `ref` parameter of the clicked ig.me / m.me link or ad.
         */
        ref?: string;
        /**
         * Meta-supplied source (`SHORTLINK`, `SHORTLINKS`, `IGME-SOURCE-LINK`, `ADS` - treat as opaque).
         */
        source?: string;
        /**
         * Meta-supplied referral type (e.g. `OPEN_THREAD`).
         */
        type?: string;
        /**
         * URI of the originating site, when Meta supplies one. Facebook Messenger only.
         */
        referer_uri?: string;
        /**
         * The Meta ad ID, on returning ad clicks. Facebook Messenger only.
         */
        ad_id?: string;
        /**
         * Snapshot of the ad's public context at click time.
         */
        ads_context_data?: {
            ad_title?: string;
            photo_url?: string;
            video_url?: string;
            post_id?: string;
            product_id?: string;
            flow_id?: string;
        };
    };
    /**
     * Who clicked - the conversation participant.
     */
    sender: {
        /**
         * Platform-scoped user ID (IGSID / PSID).
         */
        id: string;
        /**
         * Zernio CRM Contact id for this sender, when one exists.
         */
        contactId?: string;
    };
    conversation: InboxWebhookConversation;
    account: InboxWebhookAccount;
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event21 = 'referral.received';
/**
 * Webhook payload for the review.new event (new review posted on a connected account).
 */
type WebhookPayloadReviewNew = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'review.new';
    review: ReviewWebhookReview;
    account: {
        id: string;
        /**
         * Social account ID (same as id); canonical field for account filtering.
         */
        accountId?: string;
        platform: string;
        username: string;
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event22 = 'review.new';
/**
 * Webhook payload for the review.updated event. Fired when the reviewer edits
 * their text or rating, or when a reply is added (via the API or directly on the
 * platform). Same shape as review.new. When a reply is present, review.hasReply
 * is true and review.reply is populated.
 *
 */
type WebhookPayloadReviewUpdated = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'review.updated';
    review: ReviewWebhookReview;
    account: {
        id: string;
        /**
         * Social account ID (same as id); canonical field for account filtering.
         */
        accountId?: string;
        platform: string;
        username: string;
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event23 = 'review.updated';
/**
 * Webhook payload for test deliveries
 */
type WebhookPayloadTest = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'webhook.test';
    /**
     * Human-readable test message
     */
    message: string;
    /**
     * UTC time at which Zernio generated this test event (set once when the payload is built). Test fires are sent synchronously as a single attempt; a later redelivery of this event keeps the original value.
     */
    timestamp: string;
};
type event24 = 'webhook.test';
/**
 * Webhook payload for the `whatsapp.template.category_updated` event.
 * Fired when Meta reclassifies a template's category attached to a
 * connected WABA. Maps Meta's `template_category_update` field onto
 * our event envelope.
 *
 */
type WebhookPayloadWhatsAppTemplateCategoryUpdated = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'whatsapp.template.category_updated';
    account: {
        accountId: string;
        profileId: string;
        platform: 'whatsapp';
        username: string;
        displayName?: string;
    };
    template: {
        /**
         * Meta's `message_template_id`, returned as a string.
         */
        templateId: string;
        /**
         * Meta's `message_template_name`.
         */
        name: string;
        /**
         * Meta's `message_template_language` (e.g. `en_US`).
         */
        language: string;
        /**
         * `scheduled` is Meta's 24h advance notice of an upcoming
         * reclassification; `applied` is the change taking effect.
         *
         */
        changeType: 'scheduled' | 'applied';
        /**
         * The category right now, regardless of changeType.
         */
        category: 'UTILITY' | 'MARKETING' | 'AUTHENTICATION';
        /**
         * Present only when changeType is `applied`. The category before this change.
         */
        previousCategory?: 'UTILITY' | 'MARKETING' | 'AUTHENTICATION';
        /**
         * Present only when changeType is `scheduled`. The category that will take effect at `effectiveAt`.
         */
        scheduledCategory?: 'UTILITY' | 'MARKETING' | 'AUTHENTICATION';
        /**
         * Present only when changeType is `scheduled`. ISO-8601 timestamp when the scheduled category takes effect.
         */
        effectiveAt?: string;
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event25 = 'whatsapp.template.category_updated';
type platform12 = 'whatsapp';
/**
 * `scheduled` is Meta's 24h advance notice of an upcoming
 * reclassification; `applied` is the change taking effect.
 *
 */
type changeType = 'scheduled' | 'applied';
/**
 * The category right now, regardless of changeType.
 */
type category = 'UTILITY' | 'MARKETING' | 'AUTHENTICATION';
/**
 * Present only when changeType is `applied`. The category before this change.
 */
type previousCategory = 'UTILITY' | 'MARKETING' | 'AUTHENTICATION';
/**
 * Present only when changeType is `scheduled`. The category that will take effect at `effectiveAt`.
 */
type scheduledCategory = 'UTILITY' | 'MARKETING' | 'AUTHENTICATION';
/**
 * Webhook payload for the `whatsapp.template.status_updated` event.
 * Fired when Meta completes (re)review of a template attached to a
 * connected WABA. Maps Meta's `message_template_status_update` field
 * onto our event envelope.
 *
 */
type WebhookPayloadWhatsAppTemplateStatusUpdated = {
    /**
     * Stable webhook event ID
     */
    id: string;
    event: 'whatsapp.template.status_updated';
    account: {
        accountId: string;
        profileId: string;
        platform: 'whatsapp';
        username: string;
        displayName?: string;
    };
    template: {
        /**
         * Meta's `message_template_id`, returned as a string.
         */
        templateId: string;
        /**
         * Meta's `message_template_name`.
         */
        name: string;
        /**
         * Meta's `message_template_language` (e.g. `en_US`).
         */
        language: string;
        /**
         * New status. Forwarded verbatim from Meta's `event` field.
         * `PENDING_DELETION` is the 24h-grace state after a delete
         * request before the template is actually removed.
         *
         */
        status: 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
        /**
         * Meta's free-form reason for the transition. `"NONE"` on
         * approval; an explanation string on rejection.
         *
         */
        reason: string;
    };
    /**
     * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
     */
    timestamp: string;
};
type event26 = 'whatsapp.template.status_updated';
/**
 * New status. Forwarded verbatim from Meta's `event` field.
 * `PENDING_DELETION` is the 24h-grace state after a delete
 * request before the template is actually removed.
 *
 */
type status13 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
type WhatsAppBodyComponent = {
    type: 'body';
    /**
     * Body text with optional {{n}} variables
     */
    text: string;
    /**
     * Add security recommendation text (authentication templates only)
     */
    add_security_recommendation?: boolean;
    example?: {
        /**
         * Sample values for body variables (array of arrays)
         */
        body_text?: Array<Array<(string)>>;
        /**
         * Sample values for NAMED body variables (templates using {{customer_name}}-style tokens with parameter_format: NAMED).
         */
        body_text_named_params?: Array<WhatsAppNamedParamExample>;
    };
};
type WhatsAppButtonsComponent = {
    type: 'buttons';
    buttons: Array<WhatsAppTemplateButton>;
};
type WhatsAppCarouselCardComponent = WhatsAppHeaderComponent | WhatsAppBodyComponent | WhatsAppButtonsComponent;
type WhatsAppCarouselComponent = {
    type: 'carousel';
    /**
     * 2-10 cards. Meta requires all cards to share the same component structure; a mismatch surfaces as a rejected_reason. MARKETING category only.
     */
    cards: Array<{
        /**
         * Per-card components. Each card carries its own media header + optional body + up to 2 buttons. Footer and nested carousel are not allowed inside cards.
         */
        components: Array<WhatsAppCarouselCardComponent>;
    }>;
};
type WhatsAppFooterComponent = {
    type: 'footer';
    /**
     * Static footer text
     */
    text?: string;
    /**
     * OTP code expiry in minutes (authentication templates only)
     */
    code_expiration_minutes?: number;
};
type WhatsAppHeaderComponent = {
    type: 'header';
    format: 'text' | 'image' | 'video' | 'gif' | 'document' | 'location';
    /**
     * Header text (may include {{1}} variable). Used when format is TEXT.
     */
    text?: string;
    example?: {
        /**
         * Sample values for header text variables
         */
        header_text?: Array<(string)>;
        /**
         * Sample values for NAMED header variables (templates using {{customer_name}}-style tokens with parameter_format: NAMED).
         */
        header_text_named_params?: Array<WhatsAppNamedParamExample>;
        /**
         * When the header format is a media type (image, video, gif, document), provide a public URL here. Zernio will download and upload it to WhatsApp on your behalf, replacing it with the internal file handle before creating the template.
         */
        header_handle?: [
            string
        ];
    };
};
type format = 'text' | 'image' | 'video' | 'gif' | 'document' | 'location';
type WhatsAppLimitedTimeOfferComponent = {
    type: 'limited_time_offer';
    limited_time_offer: {
        /**
         * Short offer label (<=16 chars). MARKETING only.
         */
        text: string;
        /**
         * Toggles the countdown timer. The actual coupon code + expiry are bound at SEND time, not here.
         */
        has_expiration?: boolean;
    };
};
type WhatsAppNamedParamExample = {
    /**
     * Variable name as it appears in the text, without braces (e.g. customer_name for {{customer_name}}).
     */
    param_name: string;
    /**
     * Sample value for this variable.
     */
    example: string;
};
/**
 * A per-user activation session against the shared WhatsApp sandbox number.
 * Transitions `pending → active` when the inbound webhook receives a reply
 * from the matching phone (the reply itself proves ownership).
 *
 */
type WhatsAppSandboxSession = {
    /**
     * Session id. Use this to revoke via DELETE.
     */
    id: string;
    /**
     * Digits-only E.164 form (no +, spaces, or dashes).
     */
    phoneE164: string;
    /**
     * `pending` until the phone replies to the activation template, then
     * `active`. Expired sessions are pruned by TTL and never appear in
     * list responses.
     *
     */
    status: 'pending' | 'active';
    /**
     * UTC timestamp at which the session becomes invalid. Pending sessions
     * get a 24h window; activated sessions get 7 days.
     *
     */
    expiresAt: string;
    /**
     * When the session transitioned `pending → active`, or null.
     */
    activatedAt?: (string) | null;
    createdAt?: (string) | null;
};
/**
 * `pending` until the phone replies to the activation template, then
 * `active`. Expired sessions are pruned by TTL and never appear in
 * list responses.
 *
 */
type status14 = 'pending' | 'active';
type WhatsAppTemplateButton = {
    type: 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
    /**
     * Visible button label. Required for all types except copy_code (whose label is fixed by WhatsApp) and otp (omit it and WhatsApp supplies its own label, localized to the template language; an English label on a non-English template is rejected).
     */
    text?: string;
    /**
     * Required when type is URL
     */
    url?: string;
    /**
     * Example value(s). Accepts either a string or an array of strings. For URL buttons, an array of URL-suffix samples; for copy_code (marketing) buttons, the coupon code as a single string. Left untyped (string | string[]) on purpose: a typed oneOf of string-vs-array breaks several SDK code generators.
     */
    example?: unknown;
    /**
     * Required when type is phone_number
     */
    phone_number?: string;
    /**
     * Required when type is otp
     */
    otp_type?: 'copy_code' | 'one_tap' | 'zero_tap';
    autofill_text?: string;
    package_name?: string;
    signature_hash?: string;
    flow_id?: string;
    flow_name?: string;
    flow_json?: string;
    flow_action?: string;
    navigate_screen?: string;
};
type type9 = 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
/**
 * Required when type is otp
 */
type otp_type = 'copy_code' | 'one_tap' | 'zero_tap';
type WhatsAppTemplateComponent = WhatsAppHeaderComponent | WhatsAppBodyComponent | WhatsAppFooterComponent | WhatsAppButtonsComponent | WhatsAppCarouselComponent | WhatsAppLimitedTimeOfferComponent;
/**
 * A directed edge between two nodes.
 */
type WorkflowEdge = {
    id: string;
    /**
     * Source node id
     */
    source: string;
    /**
     * Target node id
     */
    target: string;
    /**
     * Selects a branch output of a multi-output node. Null (or omitted) = the node's single/default output. Known handles per node type:
     *
     * - **condition** — a rule's `id`, or `'default'` (no rule matched)
     * - **wait_for_reply** — `'reply'` (contact replied) | `'timeout'` (no reply in window)
     * - **webhook** — `'success'` (2xx) | `'error'` (non-2xx / fetch failed)
     * - **ai** — `'success'` (text/JSON response) | `'tool:<toolName>'` (model invoked
     * that tool) | `'error'` (upstream failure / non-JSON in JSON mode)
     * - **start_call** — `'success'` | `'permission_required'` | `'failed'`
     * - **a_b_split** — `'a'` | `'b'`
     * - **enroll_sequence** — `'success'` | `'error'`
     *
     */
    sourceHandle?: (string) | null;
};
/**
 * One entry in a workflow execution's timeline. Emitted by the executor on every node visit and lifecycle transition, surfaced by `GET /v1/workflows/{workflowId}/executions/ {executionId}/events` for run inspection in the Runs UI.
 *
 */
type WorkflowExecutionEvent = {
    action?: 'execution_started' | 'execution_completed' | 'execution_exited' | 'execution_paused' | 'execution_resumed' | 'node_started' | 'node_completed' | 'node_failed' | 'node_skipped';
    status?: ('success' | 'failed' | 'pending') | null;
    /**
     * Present on `node_*` events
     */
    nodeId?: (string) | null;
    /**
     * Present on `node_*` events
     */
    nodeType?: (string) | null;
    /**
     * The edge handle the executor followed out of this node (see `WorkflowEdge.sourceHandle`)
     */
    sourceHandle?: (string) | null;
    /**
     * Node run time; present on `node_completed` and `node_failed`
     */
    durationMs?: (number) | null;
    /**
     * Failure detail; present on `node_failed` and `execution_exited`
     */
    errorMessage?: (string) | null;
    /**
     * Per-node-type payload. Shape varies — see WorkflowNode `type`. Examples:
     * `send_message` → `{ messageType, text, recipient }`,
     * `webhook` → `{ url, method, statusCode, responseTimeMs, responsePreview }`,
     * `ai` → `{ model, provider, inputTokens, outputTokens, responsePreview }`,
     * `condition` → `{ matchedHandle, rulesEvaluated }`,
     * `a_b_split` → `{ percentage, chosen }`.
     *
     */
    meta?: {
        [key: string]: unknown;
    } | null;
    /**
     * Event timestamp (UTC)
     */
    at?: string;
};
type action2 = 'execution_started' | 'execution_completed' | 'execution_exited' | 'execution_paused' | 'execution_resumed' | 'node_started' | 'node_completed' | 'node_failed' | 'node_skipped';
type status15 = 'success' | 'failed' | 'pending';
/**
 * A node in a workflow graph. `config` shape depends on `type`.
 */
type WorkflowNode = {
    /**
     * Stable node id referenced by edges
     */
    id: string;
    /**
     * Node kind. The 16 supported types break into four groups:
     * messaging (send_message),
     * control flow (trigger, condition, delay, wait_for_reply, a_b_split, end),
     * data ops (set_variable, set_field, add_tag, remove_tag, enroll_sequence),
     * integrations (webhook, ai, handoff, start_call).
     *
     */
    type: 'trigger' | 'send_message' | 'wait_for_reply' | 'condition' | 'set_variable' | 'delay' | 'webhook' | 'ai' | 'handoff' | 'start_call' | 'a_b_split' | 'set_field' | 'enroll_sequence' | 'add_tag' | 'remove_tag' | 'end';
    /**
     * Type-specific settings. All string fields support `{{variable}}` interpolation against the run's variable bag (resolved at execution time).
     *
     * **trigger**: `{ triggerType: inbound_message|api_call|whatsapp_event, keywords:[string], matchType: any|contains|exact|regex, onlyFirstMessage:boolean, eventType: message_sent|message_delivered|message_read|message_failed|reaction }`. Default `triggerType` is `inbound_message` for legacy nodes. `eventType` is only honored when `triggerType` is `whatsapp_event` (WhatsApp-only).
     *
     * **send_message**: `{ messageType: text|template|media|interactive, text, template:{name,language,variableMapping}, media:{mediaType:image|video|audio|document, url,caption}, interactive }`. `template` and `interactive` are WhatsApp-only. `interactive.type` is inferred from the payload shape when omitted; payloads with neither `type` nor an inferable shape are rejected.
     *
     * **wait_for_reply**: `{ timeoutMinutes:int (max 43200), saveAs:string }`. Resume via the `'reply'` edge on inbound, or `'timeout'` edge after `timeoutMinutes` of silence.
     *
     * **condition**: `{ rules:[{ id, variable, operator: equals|not_equals|contains|not_contains|starts_with|ends_with|exists|not_exists|matches, value }] }`. First matching rule takes its `id` as the sourceHandle; otherwise `'default'`.
     *
     * **set_variable**: `{ assignments:[{ name, value }] }`. Run-scoped (lives only for this execution; use `set_field` for persistent values).
     *
     * **delay**: `{ delayMinutes:int (max 43200) }`. Suspends the run, resumes via timer.
     *
     * **webhook**: `{ url, method: GET|POST|PUT|PATCH|DELETE, headers, bodyTemplate, saveAs }`. SSRF-guarded (private/loopback/metadata IPs rejected). Response saved as `{ status, ok, body }` to `vars[saveAs]`. Edge: `'success'` on 2xx, `'error'` otherwise.
     *
     * **ai**: `{ provider: anthropic|openai|google|mistral|groq|openrouter, model, preset: smart|tools|cheap, systemPrompt, userPromptTemplate, saveAs, temperature, maxTokens, outputType: text|json, tools:[{ name, description, parameters }] }`. Set `provider` + `model` for BYOK (uses your stored API key); omit `provider` for the legacy Telnyx path. Edges: `'success'`, `'tool:<name>'` (model picked a tool), `'error'`.
     *
     * **handoff**: `{ note, assignTo }`. Terminates the run as `exited`, flags the conversation for a human operator.
     *
     * **start_call**: `{ to, forwardTo, requirePermissionFirst, recordingEnabled, saveAs }`. WhatsApp-only. `forwardTo` can be `tel:+E164`, `sip:user@host`, or `wss://…` (AI voice agent). Edges: `'success'`, `'permission_required'`, `'failed'`.
     *
     * **a_b_split**: `{ percentage: number 0-100 (default 50) }`. Random branch picker. Edges: `'a'` (with probability `percentage/100`), `'b'`.
     *
     * **set_field**: `{ field, value }`. Persistent custom field on the Contact (vs `set_variable` which is run-scoped). Field name is sanitized to `[A-Za-z0-9_]`. No-op on `api_call` runs (no contact).
     *
     * **enroll_sequence**: `{ sequenceId, saveAs }`. Enrolls the run's contact into a Sequence. Edges: `'success'`, `'error'`.
     *
     * **add_tag** / **remove_tag**: `{ tag }`. Push or pull a tag on the Contact. No-op on `api_call` runs.
     *
     * **end**: no config. Terminates the run as `completed`.
     *
     */
    config?: {
        [key: string]: unknown;
    };
    /**
     * Canvas coordinates (ignored by the executor; used by the visual builder).
     */
    position?: {
        x?: number;
        y?: number;
    };
    /**
     * Optional display name shown on the builder canvas and inspector, falling back to the node type when absent. The nodes array is replaced wholesale on update, so it must be resent to be kept.
     */
    label?: string;
};
/**
 * Node kind. The 16 supported types break into four groups:
 * messaging (send_message),
 * control flow (trigger, condition, delay, wait_for_reply, a_b_split, end),
 * data ops (set_variable, set_field, add_tag, remove_tag, enroll_sequence),
 * integrations (webhook, ai, handoff, start_call).
 *
 */
type type10 = 'trigger' | 'send_message' | 'wait_for_reply' | 'condition' | 'set_variable' | 'delay' | 'webhook' | 'ai' | 'handoff' | 'start_call' | 'a_b_split' | 'set_field' | 'enroll_sequence' | 'add_tag' | 'remove_tag' | 'end';
/**
 * A single X API operation with its per-call price and the Zernio platform methods that trigger it.
 */
type XApiOperation = {
    /**
     * Internal operation key. Matches keys in `xApiCallsByOperation`.
     */
    operation?: string;
    /**
     * Metronome `event_type` emitted when this operation runs.
     */
    eventType?: string;
    /**
     * Human-readable label shown on Metronome invoices.
     */
    displayName?: string;
    pricePerCallUsd?: number;
    /**
     * Per-call price in cents. Fractional values are intentional.
     */
    pricePerCallCents?: number;
    /**
     * Tier key derived from `pricePerCallUsd` (e.g. `x_api_005` for
     * $0.005, `x_api_200` for $0.200). Useful for grouping operations
     * by price in dashboards.
     *
     */
    tier?: string;
    /**
     * Zernio platform methods that emit this operation, with their metering rule.
     */
    triggeredBy?: Array<{
        /**
         * Zernio platform method name.
         */
        method?: string;
        /**
         * When the method actually bills the user:
         * * `always` — every call is metered
         * * `analytics_optin` — only when the X account has analytics enabled
         * * `inbox_optin` — only when the X account has inbox sync enabled
         * * `absorbed` — Zernio eats the cost, never billed
         *
         */
        metering?: 'always' | 'analytics_optin' | 'inbox_optin' | 'absorbed';
    }>;
};
/**
 * Canonical X/Twitter API pricing table. Zernio passes X API costs through
 * at exact rates with zero markup, so every call you make has a known per-unit
 * price. Use this payload alongside `/v1/usage-stats` (which returns
 * per-operation call counts via `xApiCallsByOperation`) to compute exact
 * cost attribution by X action.
 *
 */
type XApiPricing = {
    currency?: string;
    /**
     * Always 0% — Zernio does not mark up X API rates.
     */
    markup?: string;
    source?: string;
    /**
     * Date the prices were last verified against X's published rates.
     */
    lastVerified?: string;
    /**
     * Rollup of operations grouped by their per-call price.
     */
    tiers?: Array<{
        /**
         * Tier key derived from price (e.g. `x_api_005` for $0.005,
         * `x_api_200` for $0.200). The first three keys map to the
         * legacy `xApiCalls` aggregate; new tiers (e.g. `x_api_200`
         * for the URL tier added April 2026) are surfaced here but
         * not in the legacy shape.
         *
         */
        tier?: string;
        pricePerCallUsd?: number;
        operationCount?: number;
    }>;
    /**
     * Flat list of every X operation Zernio can perform, with its rate.
     */
    operations?: Array<XApiOperation>;
};
/**
 * Long-form X Article payload. X Articles require an eligible X Premium+ account.
 * Articles are mutually exclusive with top-level/custom tweet media and with threadItems,
 * poll, quoteTweetId, replyToTweetId, inReplyToTweetId, replySettings, sensitiveMedia,
 * paidPartnership, and madeWithAi. Publishing normally performs two billable X API
 * requests at $0.010 each (draft + publish, $0.020 total); mode `draft` performs only
 * the $0.010 draft request. `articleDraftId` is an internal recovery checkpoint and
 * must not be supplied by API clients.
 *
 */
type XArticle = {
    title: string;
    content_state: XArticleContentState;
    /**
     * Publish creates an X Article draft and then publishes it. Draft stops after draft creation and returns the X draft ID without a public URL.
     */
    mode?: 'publish' | 'draft';
    cover?: {
        /**
         * Public JPG, JPEG, PNG, or WebP URL. GIF, MP4, AVIF, extensionless URLs, and caller-supplied native media IDs are rejected.
         */
        url: string;
        altText?: string;
    };
};
/**
 * Publish creates an X Article draft and then publishes it. Draft stops after draft creation and returns the X draft ID without a public URL.
 */
type mode = 'publish' | 'draft';
type XArticleBlock = {
    type: 'unstyled' | 'header-one' | 'header-two' | 'header-three' | 'unordered-list-item' | 'ordered-list-item' | 'blockquote' | 'atomic';
    text: string;
    key?: string;
    data?: {
        cashtags?: Array<XArticleTextRange>;
        hashtags?: Array<XArticleTextRange>;
        mentions?: Array<XArticleTextRange>;
        urls?: Array<XArticleTextRange>;
    };
    inline_style_ranges?: Array<XArticleInlineStyleRange>;
    entity_ranges?: Array<XArticleEntityRange>;
};
type type11 = 'unstyled' | 'header-one' | 'header-two' | 'header-three' | 'unordered-list-item' | 'ordered-list-item' | 'blockquote' | 'atomic';
/**
 * X's snake_case content-state shape. Standard DraftJS camelCase fields such as entityMap, inlineStyleRanges, and entityRanges are rejected.
 */
type XArticleContentState = {
    blocks: Array<XArticleBlock>;
    entities: Array<XArticleEntity>;
};
/**
 * Entity keys must be unique decimal strings matching their zero-based array index (`"0"`, `"1"`, ...).
 */
type XArticleEntity = {
    key: string;
    value: {
        type: "post";
        mutability: 'immutable' | 'mutable' | 'segmented';
        data: {
            post_id: string;
        };
    };
} | {
    key: string;
    value: {
        type: "link";
        mutability: 'immutable' | 'mutable' | 'segmented';
        data: {
            url: string;
        };
    };
} | {
    key: string;
    value: {
        type: "image";
        mutability: 'immutable' | 'mutable' | 'segmented';
        data: {
            /**
             * Public image, GIF, or MP4 URL. Zernio uploads it to X and replaces it with native media metadata. Caller-supplied media IDs are rejected.
             */
            url: string;
            caption?: string;
            /**
             * Supported for image and GIF URLs; rejected for MP4 media.
             */
            altText?: string;
        };
    };
} | {
    key: string;
    value: {
        type: "emoji";
        mutability: 'immutable' | 'mutable' | 'segmented';
        data: {
            entity_key: string;
        };
    };
} | {
    key: string;
    value: {
        type: "markdown";
        mutability: 'immutable' | 'mutable' | 'segmented';
        data: {
            markdown: string;
        };
    };
} | {
    key: string;
    value: {
        type: 'divider' | 'latex';
        mutability: 'immutable' | 'mutable' | 'segmented';
        data: {
            [key: string]: unknown;
        };
    };
};
type mutability = 'immutable' | 'mutable' | 'segmented';
type type12 = 'divider' | 'latex';
/**
 * The referenced entity must exist, and offset plus length must not exceed the containing block's text length.
 */
type XArticleEntityRange = {
    /**
     * Zero-based index into content_state.entities.
     */
    key: number;
    offset: number;
    length: number;
};
/**
 * The offset plus length must not exceed the containing block's text length.
 */
type XArticleInlineStyleRange = {
    offset: number;
    length: number;
    style: 'bold' | 'italic' | 'strikethrough';
};
type style = 'bold' | 'italic' | 'strikethrough';
type XArticleTextRange = {
    /**
     * Inclusive start index in the block text.
     */
    from_index: number;
    /**
     * Exclusive end index in the block text. Must be greater than or equal to from_index and no greater than the block text length.
     */
    to_index: number;
    /**
     * Text represented by this metadata range.
     */
    text: string;
};
type YouTubeDailyViewsResponse = {
    success?: boolean;
    /**
     * The YouTube video ID
     */
    videoId?: string;
    /**
     * Video length in seconds (from YouTube contentDetails.duration)
     */
    durationSeconds?: (number) | null;
    dateRange?: {
        startDate?: string;
        endDate?: string;
    };
    /**
     * Present only when the range reaches into YouTube's ~3-day processing window: the first date whose numbers are provisional and may still be revised by YouTube.
     */
    provisionalSince?: string;
    /**
     * Sum of views across all days in the range
     */
    totalViews?: number;
    dailyViews?: Array<{
        date?: string;
        views?: number;
        estimatedMinutesWatched?: number;
        /**
         * Average view duration in seconds
         */
        averageViewDuration?: number;
        /**
         * Average percentage of the video watched per view. Can exceed 100 on Shorts (looping rewatches), so do not clamp it client-side.
         */
        averageViewPercentage?: number;
        subscribersGained?: number;
        subscribersLost?: number;
        likes?: number;
        comments?: number;
        shares?: number;
    }>;
    /**
     * When the data was last synced from YouTube
     */
    lastSyncedAt?: (string) | null;
    scopeStatus?: {
        hasAnalyticsScope?: boolean;
    };
};
type YouTubeDemographicsResponse = {
    success?: boolean;
    /**
     * The Zernio SocialAccount ID
     */
    accountId?: string;
    platform?: string;
    /**
     * Present only when demographics are scoped to a single video
     */
    videoId?: string;
    /**
     * Video title (video mode only)
     */
    title?: (string) | null;
    /**
     * Video publish date (video mode only)
     */
    publishedAt?: (string) | null;
    /**
     * Object keyed by breakdown dimension (age, gender, country)
     */
    demographics?: {
        [key: string]: Array<{
            /**
             * The dimension value (e.g., "25-34", "US", "male")
             */
            dimension?: string;
            /**
             * Viewer percentage (age/gender) or view count (country)
             */
            value?: number;
        }>;
    };
    dateRange?: {
        startDate?: string;
        endDate?: string;
    };
    /**
     * Present only when the range reaches into YouTube's ~3-day processing window: the first date whose numbers are provisional and may still be revised by YouTube.
     */
    provisionalSince?: string;
    note?: string;
};
/**
 * Videos under 3 min auto-detected as Shorts. Custom thumbnails for regular videos only. Scheduled videos are uploaded immediately with the specified visibility.
 */
type YouTubePlatformData = {
    /**
     * Video title. Defaults to first line of content or "Untitled Video". Must be ≤ 100 characters.
     */
    title?: string;
    /**
     * Video visibility: public (default, anyone can watch), unlisted (link only), private (invite only)
     */
    visibility?: 'public' | 'private' | 'unlisted';
    /**
     * COPPA compliance flag. Set true for child-directed content (restricts comments, notifications, ad targeting). Defaults to false. YouTube may block views if not explicitly set.
     */
    madeForKids?: boolean;
    /**
     * Optional first comment to post immediately after video upload. Up to 10,000 characters (YouTube's comment limit).
     */
    firstComment?: string;
    /**
     * AI-generated content disclosure. Set true if the video contains synthetic content that could be mistaken for real. YouTube may add a label.
     */
    containsSyntheticMedia?: boolean;
    /**
     * YouTube video category ID. Defaults to 22 (People & Blogs). Common: 1 (Film), 2 (Autos), 10 (Music), 15 (Pets), 17 (Sports), 20 (Gaming), 23 (Comedy), 24 (Entertainment), 25 (News), 26 (Howto), 27 (Education), 28 (Science & Tech).
     */
    categoryId?: string;
    /**
     * Optional YouTube playlist ID to add the video to after upload (e.g. 'PLxxxxxxxxxxxxx'). Use GET /v1/accounts/{id}/youtube-playlists to list available playlists. Works for both immediate and scheduled uploads. Quota cost: 50 YouTube API units per call.
     */
    playlistId?: string;
};
type YouTubeScopeMissingResponse = {
    success?: boolean;
    error?: string;
    code?: string;
    scopeStatus?: {
        hasAnalyticsScope?: boolean;
        requiresReauthorization?: boolean;
        /**
         * URL to redirect user for reauthorization
         */
        reauthorizeUrl?: string;
    };
};
type YouTubeVideoRetentionResponse = {
    success?: boolean;
    /**
     * The Zernio account ID for the YouTube account
     */
    accountId?: string;
    /**
     * The YouTube video ID
     */
    videoId?: string;
    /**
     * Video title
     */
    title?: (string) | null;
    /**
     * When the video was published on YouTube
     */
    publishedAt?: (string) | null;
    /**
     * Video length in seconds (from YouTube contentDetails.duration)
     */
    durationSeconds?: (number) | null;
    dateRange?: {
        startDate?: string;
        endDate?: string;
    };
    /**
     * Present only when the range reaches into YouTube's ~3-day processing window: the first date whose numbers are provisional and may still be revised by YouTube.
     */
    provisionalSince?: string;
    /**
     * Up to 100 points covering the video timeline, aggregated over the date range. Can be empty when YouTube has no retention data for the video in the given range.
     */
    retentionCurve?: Array<{
        /**
         * Position in the video as a ratio (0.01-1.0, exclusive end of each interval)
         */
        elapsedVideoTimeRatio?: number;
        /**
         * Absolute share of viewers watching at this point. Can exceed 1 (rewinds/looping, common on Shorts).
         */
        audienceWatchRatio?: number;
        /**
         * Retention vs videos of similar length (0 = worst, 0.5 = median, 1 = best)
         */
        relativeRetentionPerformance?: number;
        /**
         * Viewers who started watching in this segment. 0 when YouTube has no segment-level data for the video.
         */
        startedWatching?: number;
        /**
         * Viewers who stopped watching in this segment. 0 when YouTube has no segment-level data for the video.
         */
        stoppedWatching?: number;
        /**
         * Total views of this segment, including rewatches
         */
        totalSegmentImpressions?: number;
    }>;
    /**
     * Present only when the curve is empty, explaining why
     */
    note?: string;
    scopeStatus?: {
        hasAnalyticsScope?: boolean;
    };
};
type ValidatePostLengthData = {
    body: {
        /**
         * The post text to check
         */
        text: string;
    };
};
type ValidatePostLengthResponse = ({
    text?: string;
    platforms?: {
        [key: string]: {
            /**
             * Character count for this platform
             */
            count?: number;
            /**
             * Maximum allowed characters
             */
            limit?: number;
            /**
             * Whether the text is within the limit
             */
            valid?: boolean;
        };
    };
});
type ValidatePostLengthError = ({
    error?: string;
});
type ValidatePostData = {
    body: {
        /**
         * Post text content
         */
        content?: string;
        /**
         * Target platforms (same format as POST /v1/posts)
         */
        platforms: Array<{
            platform: 'twitter' | 'instagram' | 'tiktok' | 'youtube' | 'facebook' | 'linkedin' | 'bluesky' | 'threads' | 'reddit' | 'pinterest' | 'telegram' | 'snapchat' | 'googlebusiness' | 'discord' | 'slack';
            /**
             * Account to validate against. For twitter, resolves X Premium status to apply the 25000 character limit instead of 280.
             */
            accountId?: string;
            customContent?: string;
            platformSpecificData?: {
                [key: string]: unknown;
            };
            customMedia?: Array<MediaItem>;
        }>;
        /**
         * Root media items shared across platforms
         */
        mediaItems?: Array<MediaItem>;
    };
};
type ValidatePostResponse = (({
    valid?: boolean;
    message?: string;
    warnings?: Array<{
        platform?: string;
        warning?: string;
    }>;
} | {
    valid?: boolean;
    errors?: Array<{
        platform?: string;
        error?: string;
    }>;
    warnings?: Array<{
        platform?: string;
        warning?: string;
    }>;
}));
type ValidatePostError = ({
    error?: string;
});
type ValidateMediaData = {
    body: {
        /**
         * Public media URL to validate
         */
        url: string;
    };
};
type ValidateMediaResponse = ({
    valid?: boolean;
    url?: string;
    /**
     * Error message if valid is false
     */
    error?: string;
    contentType?: string;
    /**
     * File size in bytes
     */
    size?: (number) | null;
    sizeFormatted?: string;
    type?: 'image' | 'video' | 'unknown';
    /**
     * Per-platform size limit comparison (only present when size and type are known)
     */
    platformLimits?: {
        [key: string]: {
            /**
             * Platform size limit in bytes
             */
            limit?: number;
            limitFormatted?: string;
            withinLimit?: boolean;
        };
    };
});
type ValidateMediaError = ({
    error?: string;
});
type ValidateSubredditData = {
    query: {
        /**
         * Reddit social account ID for authenticated lookup (recommended for reliable results)
         */
        accountId?: string;
        /**
         * Subreddit name (with or without "r/" prefix)
         */
        name: string;
    };
};
type ValidateSubredditResponse = (({
    exists?: boolean;
    subreddit?: {
        name?: string;
        title?: string;
        description?: string;
        subscribers?: number;
        isNSFW?: boolean;
        type?: 'public' | 'private' | 'restricted';
        allowImages?: boolean;
        allowVideos?: boolean;
    };
} | {
    exists?: boolean;
    error?: string;
}));
type ValidateSubredditError = ({
    error?: string;
});
type GetAnalyticsData = {
    query?: {
        /**
         * Filter by social account ID
         */
        accountId?: string;
        /**
         * Inclusive lower bound (YYYY-MM-DD). Defaults to 90 days ago if omitted. Max range is 366 days.
         */
        fromDate?: string;
        /**
         * Page size (default 50)
         */
        limit?: number;
        /**
         * Sort order
         */
        order?: 'asc' | 'desc';
        /**
         * Page number (default 1)
         */
        page?: number;
        /**
         * Filter by platform (default "all")
         */
        platform?: string;
        /**
         * Returns analytics for a single post. Accepts both Zernio Post IDs and External Post IDs. Zernio IDs are auto-resolved to External Post analytics.
         */
        postId?: string;
        /**
         * Filter by profile ID (default "all")
         */
        profileId?: string;
        /**
         * Sort by date, engagement, or a specific metric
         */
        sortBy?: 'date' | 'engagement' | 'impressions' | 'reach' | 'likes' | 'comments' | 'shares' | 'saves' | 'clicks' | 'views' | 'follows';
        /**
         * Filter by post source: late (posted via Zernio API), external (synced from platform), all (default)
         */
        source?: 'all' | 'late' | 'external';
        /**
         * Inclusive upper bound (YYYY-MM-DD). Defaults to today if omitted.
         */
        toDate?: string;
    };
};
type GetAnalyticsResponse = ((AnalyticsSinglePostResponse | AnalyticsListResponse) | AnalyticsSinglePostResponse);
type GetAnalyticsError = ({
    error?: string;
    /**
     * Detailed validation errors
     */
    details?: {
        [key: string]: unknown;
    };
} | {
    error?: string;
} | {
    error?: string;
    code?: string;
} | AnalyticsSinglePostResponse | ErrorResponse);
type GetYouTubeChannelInsightsData = {
    query: {
        /**
         * The Zernio SocialAccount ID for the YouTube account.
         */
        accountId: string;
        /**
         * Comma-separated list. Defaults to "views,estimatedMinutesWatched,subscribersGained,subscribersLost".
         *
         * Live YouTube Analytics v2 metrics:
         * - views
         * - estimatedMinutesWatched
         * - averageViewDuration          (ratio - weighted mean computed across days)
         * - subscribersGained
         * - subscribersLost
         *
         * Zernio-synthesized from daily follower snapshots (cross-platform parity):
         * - followers_gained
         * - followers_lost
         *
         */
        metrics?: string;
        /**
         * "total_value" (default) returns aggregated totals.
         * "time_series" returns per-day values in the "values" array.
         *
         */
        metricType?: 'time_series' | 'total_value';
        /**
         * Start date (YYYY-MM-DD). Defaults to 30 days ago.
         */
        since?: string;
        /**
         * End date (YYYY-MM-DD). Defaults to today. YouTube Analytics has a 2-3 day delay,
         * so the fetch is internally clamped to 3 days ago; any requested range extending
         * beyond that returns zero values for the tail days. The response's dateRange.until
         * field reflects your requested value.
         *
         */
        until?: string;
    };
};
type GetYouTubeChannelInsightsResponse = (InstagramAccountInsightsResponse);
type GetYouTubeChannelInsightsError = (unknown | {
    error?: string;
} | YouTubeScopeMissingResponse);
type GetLinkedInOrgAggregateAnalyticsData = {
    query: {
        /**
         * The Zernio SocialAccount ID for the LinkedIn organization account.
         */
        accountId: string;
        /**
         * Comma-separated list. Defaults to
         * "impressions,clicks,engagement_rate,organic_followers_gained,followers_gained,followers_lost".
         *
         * Share statistics (support both total_value and time_series):
         * - impressions
         * - unique_impressions
         * - clicks
         * - likes
         * - comments
         * - shares
         * - engagement_rate       (0..1, LinkedIn-computed)
         *
         * Follower-gain statistics (support total_value and time_series):
         * - organic_followers_gained   (per-day organic gains for time_series; sum of organic gains over the range for total_value)
         * - paid_followers_gained      (per-day paid gains for time_series; sum of paid gains over the range for total_value)
         *
         * Page-view statistics (total_value ONLY - LinkedIn platform limit):
         * - page_views_total
         * - page_views_overview
         * - page_views_careers
         * - page_views_jobs
         * - page_views_life
         *
         * Zernio-synthesized from daily follower snapshots:
         * - followers_gained
         * - followers_lost
         *
         */
        metrics?: string;
        metricType?: 'time_series' | 'total_value';
        /**
         * Start date (YYYY-MM-DD). Defaults to 30 days ago.
         */
        since?: string;
        /**
         * End date (YYYY-MM-DD). Defaults to today.
         */
        until?: string;
    };
};
type GetLinkedInOrgAggregateAnalyticsResponse = (InstagramAccountInsightsResponse);
type GetLinkedInOrgAggregateAnalyticsError = (unknown | {
    error?: string;
});
type GetTikTokAccountInsightsData = {
    query: {
        /**
         * The Zernio SocialAccount ID for the TikTok account.
         */
        accountId: string;
        /**
         * Comma-separated list. Defaults to
         * "follower_count,likes_count,video_count,followers_gained,followers_lost".
         *
         * Live from /v2/user/info/ (requires user.info.stats scope):
         * - follower_count  (cumulative; time series joined from AccountStats)
         * - following_count (cumulative; time series joined from AccountStats.metadata)
         * - likes_count     (cumulative; time series joined from AccountStats.metadata)
         * - video_count     (cumulative; time series joined from AccountStats.metadata)
         *
         * Zernio-synthesized:
         * - followers_gained  (sum of positive daily follower deltas)
         * - followers_lost    (sum of absolute negative daily deltas)
         *
         */
        metrics?: string;
        /**
         * "total_value" returns the latest cumulative counter value.
         * "time_series" returns daily values joined from AccountStats snapshots.
         *
         */
        metricType?: 'time_series' | 'total_value';
        /**
         * Start date (YYYY-MM-DD). Defaults to 30 days ago.
         */
        since?: string;
        /**
         * End date (YYYY-MM-DD). Defaults to today.
         */
        until?: string;
    };
};
type GetTikTokAccountInsightsResponse = (InstagramAccountInsightsResponse);
type GetTikTokAccountInsightsError = (unknown | {
    error?: string;
});
type GetYouTubeDailyViewsData = {
    query: {
        /**
         * The Zernio account ID for the YouTube account
         */
        accountId: string;
        /**
         * End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
         * (YouTube finalizes analytics with a ~3-day delay). An explicit endDate is honored
         * up to today: days inside the delay window are provisional and may still be revised
         * by YouTube (see provisionalSince in the response), and days YouTube has not
         * processed yet are omitted from dailyViews.
         *
         */
        endDate?: string;
        /**
         * Start date (YYYY-MM-DD). Defaults to 30 days ago.
         */
        startDate?: string;
        /**
         * The YouTube video ID (e.g., "dQw4w9WgXcQ")
         */
        videoId: string;
    };
};
type GetYouTubeDailyViewsResponse = (YouTubeDailyViewsResponse);
type GetYouTubeDailyViewsError = ({
    error?: string;
} | {
    error?: string;
    code?: string;
} | YouTubeScopeMissingResponse | {
    success?: boolean;
    error?: string;
});
type GetYouTubeVideoRetentionData = {
    query: {
        /**
         * The Zernio account ID for the YouTube account
         */
        accountId: string;
        /**
         * End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
         * (YouTube finalizes analytics with a ~3-day delay). An explicit endDate is honored
         * up to today: days inside the delay window are provisional and may still be revised
         * by YouTube (see provisionalSince in the response).
         *
         */
        endDate?: string;
        /**
         * Start date (YYYY-MM-DD). Defaults to the video's publish date (lifetime curve).
         */
        startDate?: string;
        /**
         * The YouTube video ID (e.g., "dQw4w9WgXcQ")
         */
        videoId: string;
    };
};
type GetYouTubeVideoRetentionResponse = (YouTubeVideoRetentionResponse);
type GetYouTubeVideoRetentionError = ({
    error?: string;
} | {
    error?: string;
    code?: string;
} | {
    error?: string;
    type?: string;
    code?: string;
    param?: string;
} | YouTubeScopeMissingResponse | {
    success?: boolean;
    error?: string;
});
type GetFacebookPageInsightsData = {
    query: {
        /**
         * The Zernio SocialAccount ID for the connected Facebook Page.
         */
        accountId: string;
        /**
         * Comma-separated list of metrics. Defaults to
         * "page_media_view,page_post_engagements,page_follows,followers_gained,followers_lost".
         *
         * Live Meta metrics (current names, post-Nov-2025):
         * - page_media_view       (replaces deprecated page_impressions)
         * - page_views_total
         * - page_post_engagements
         * - page_video_views
         * - page_video_view_time
         * - page_follows          (replaces deprecated page_fans)
         *
         * Zernio-synthesized from daily follower snapshots (filling the Nov-2025 gap
         * left by the page_fan_adds / page_fan_removes deprecation):
         * - followers_gained
         * - followers_lost
         *
         * Monetization (opt-in, not in the defaults):
         * - content_monetization_earnings
         * - monetization_approximate_earnings
         *
         * Each monetization metric is fetched with its own separate Graph call, so requesting both
         * adds two calls. Values are approximate and Meta restates them after the fact.
         *
         * content_monetization_earnings returns an object per day and always carries unit
         * "micro_amount" plus an ISO 4217 "currency". monetization_approximate_earnings returns a bare
         * number per day, so its unit is always "unspecified" and its "currency" is always null. The two
         * are on different scales and are not comparable to each other. Both keep their daily "values"
         * on every metricType and are never rescaled by Zernio.
         *
         * Earnings here are Page-level daily buckets and "total" is their sum. Meta does not
         * document whether a bucket carries that day's earnings or a running total, and every
         * Page measured so far earned exactly 0, so reconcile "total" against the Page's own Meta
         * export before relying on it; the daily "values" are always returned for that purpose.
         * Per-post lifetime earnings are served by GET /v1/analytics/facebook/post-earnings.
         *
         * A Page that is not enrolled in monetization, or that earned nothing, returns normal daily
         * buckets of 0 in "metrics": Meta does not distinguish the two, so a 0 total here does NOT mean
         * the Page is enrolled. "unavailableMetrics" covers the narrower case where Meta returned no
         * bucket for the metric at all ("no_data") or rejected the request outright, and the metric is
         * then omitted from "metrics" rather than reported as 0.
         *
         */
        metrics?: string;
        /**
         * "total_value" (default) returns aggregated totals only.
         * "time_series" returns daily values in the "values" array.
         *
         */
        metricType?: 'time_series' | 'total_value';
        /**
         * Start date (YYYY-MM-DD). Defaults to 30 days ago.
         */
        since?: string;
        /**
         * End date (YYYY-MM-DD). Defaults to today.
         */
        until?: string;
    };
};
type GetFacebookPageInsightsResponse = (InstagramAccountInsightsResponse);
type GetFacebookPageInsightsError = (unknown | {
    error?: string;
});
type GetFacebookPostEarningsData = {
    query: {
        /**
         * The Zernio SocialAccount ID for the connected Facebook Page.
         */
        accountId: string;
        /**
         * Comma-separated list of monetization metrics. Defaults to both:
         * - content_monetization_earnings
         * - monetization_approximate_earnings
         *
         * content_monetization_earnings always carries unit "micro_amount" plus an ISO 4217
         * "currency". monetization_approximate_earnings is always a bare number, so its unit is
         * "unspecified" and its "currency" is null. The two are on different scales and are not
         * comparable to each other. Any other metric name is rejected with 400.
         *
         */
        metrics?: string;
        /**
         * The platform post ID, exactly as returned in platformAnalytics[].platformPostId by
         * /v1/analytics: "{pageId}_{postId}", or the bare video ID for Reels.
         *
         */
        postId: string;
    };
};
type GetFacebookPostEarningsResponse = (FacebookPostEarningsResponse);
type GetFacebookPostEarningsError = (unknown | {
    error?: string;
});
type GetInstagramAccountInsightsData = {
    query: {
        /**
         * The Zernio SocialAccount ID for the Instagram account
         */
        accountId: string;
        /**
         * Breakdown dimension (only valid with metricType=total_value).
         * Valid values depend on the metric: media_product_type, follow_type, follower_type, contact_button_type.
         *
         */
        breakdown?: string;
        /**
         * Comma-separated list of metrics. Defaults to "reach,views,accounts_engaged,total_interactions".
         * Valid metrics: reach, views, accounts_engaged, total_interactions, comments, likes, saves, shares,
         * replies, reposts, follows_and_unfollows, profile_links_taps.
         * Note: only "reach" supports metricType=time_series. All other metrics (including
         * follows_and_unfollows) are total_value only. This is an Instagram Graph API limitation,
         * not a Zernio limitation - the IG API does not return time-series data for these metrics.
         * For a daily running follower count, use /v1/analytics/instagram/follower-history instead.
         *
         */
        metrics?: string;
        /**
         * "total_value" (default) returns aggregated totals and supports breakdowns.
         * "time_series" returns daily values but only works with the "reach" metric.
         *
         */
        metricType?: 'time_series' | 'total_value';
        /**
         * Start date (YYYY-MM-DD). Defaults to 30 days ago.
         */
        since?: string;
        /**
         * End date (YYYY-MM-DD). Defaults to today.
         */
        until?: string;
    };
};
type GetInstagramAccountInsightsResponse = (InstagramAccountInsightsResponse);
type GetInstagramAccountInsightsError = ({
    error?: string;
} | {
    error?: string;
    code?: string;
});
type GetInstagramFollowerHistoryData = {
    query: {
        /**
         * The Zernio SocialAccount ID for the Instagram account.
         */
        accountId: string;
        /**
         * Comma-separated list. Defaults to "follower_count,followers_gained,followers_lost".
         * - follower_count   : per-day raw follower count
         * - followers_gained : sum of positive daily deltas
         * - followers_lost   : sum of absolute negative daily deltas
         *
         */
        metrics?: string;
        /**
         * "total_value" returns aggregated totals (latest for follower_count, sum for gained/lost).
         * "time_series" returns per-day values in the "values" array.
         *
         */
        metricType?: 'time_series' | 'total_value';
        /**
         * Start date (YYYY-MM-DD). Defaults to 30 days ago.
         */
        since?: string;
        /**
         * End date (YYYY-MM-DD). Defaults to today.
         */
        until?: string;
    };
};
type GetInstagramFollowerHistoryResponse = (InstagramAccountInsightsResponse);
type GetInstagramFollowerHistoryError = (unknown | {
    error?: string;
});
type GetInstagramDemographicsData = {
    query: {
        /**
         * The Zernio SocialAccount ID for the Instagram account
         */
        accountId: string;
        /**
         * Comma-separated list of demographic dimensions: age, city, country, gender.
         * Defaults to all four if omitted.
         *
         */
        breakdown?: string;
        /**
         * "follower_demographics" for follower audience data, or "engaged_audience_demographics" for engaged viewers.
         *
         */
        metric?: 'follower_demographics' | 'engaged_audience_demographics';
        /**
         * Time period for demographic data. Defaults to "this_month".
         *
         */
        timeframe?: 'this_week' | 'this_month';
    };
};
type GetInstagramDemographicsResponse = (InstagramDemographicsResponse);
type GetInstagramDemographicsError = ({
    error?: string;
} | {
    error?: string;
    code?: string;
});
type GetYouTubeDemographicsData = {
    query: {
        /**
         * The Zernio SocialAccount ID for the YouTube account
         */
        accountId: string;
        /**
         * Comma-separated list of demographic dimensions: age, gender, country.
         * Defaults to all three if omitted.
         *
         */
        breakdown?: string;
        /**
         * End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
         * (YouTube finalizes analytics with a ~3-day delay). An explicit endDate is honored
         * up to today: days inside the delay window are provisional and may still be revised
         * by YouTube (see provisionalSince in the response).
         *
         */
        endDate?: string;
        /**
         * Start date in YYYY-MM-DD format. Defaults to 90 days ago, or to the video's
         * publish date (lifetime) when videoId is provided.
         *
         */
        startDate?: string;
        /**
         * YouTube video ID. When provided, demographics are scoped to this single video
         * (must belong to the connected channel; otherwise 404 video_not_found).
         *
         */
        videoId?: string;
    };
};
type GetYouTubeDemographicsResponse = (YouTubeDemographicsResponse);
type GetYouTubeDemographicsError = ({
    error?: string;
} | {
    error?: string;
    code?: string;
} | {
    success?: boolean;
    error?: string;
    code?: string;
    scopeStatus?: {
        hasAnalyticsScope?: boolean;
        requiresReauthorization?: boolean;
        reauthorizeUrl?: string;
    };
});
type GetDailyMetricsData = {
    query?: {
        /**
         * Filter by social account ID
         */
        accountId?: string;
        /**
         * How each post's engagement is attributed to a day.
         * "publish" (default) sums each post's lifetime total on its publish date.
         * "received" buckets the per-day increase in engagement by the day it actually arrived (engagement-over-time), so engagement on older posts appears on the day it was gained rather than the post's publish date.
         *
         */
        attribution?: 'publish' | 'received';
        /**
         * Inclusive start date (ISO 8601). Defaults to 180 days ago.
         */
        fromDate?: string;
        /**
         * Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
         */
        platform?: string;
        /**
         * Filter by profile ID. Omit for all profiles.
         */
        profileId?: string;
        /**
         * Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms.
         */
        source?: 'all' | 'late' | 'external';
        /**
         * Inclusive end date (ISO 8601). Defaults to now.
         */
        toDate?: string;
    };
};
type GetDailyMetricsResponse = ({
    dailyData?: Array<{
        date?: string;
        postCount?: number;
        platforms?: {
            [key: string]: (number);
        };
        metrics?: {
            impressions?: number;
            reach?: number;
            likes?: number;
            comments?: number;
            shares?: number;
            saves?: number;
            clicks?: number;
            views?: number;
        };
    }>;
    platformBreakdown?: Array<{
        platform?: string;
        postCount?: number;
        impressions?: number;
        reach?: number;
        likes?: number;
        comments?: number;
        shares?: number;
        saves?: number;
        clicks?: number;
        views?: number;
    }>;
});
type GetDailyMetricsError = ({
    error?: string;
} | {
    error?: string;
    code?: string;
});
type GetBestTimeToPostData = {
    query?: {
        /**
         * Filter by social account ID. Omit for all accounts.
         */
        accountId?: string;
        /**
         * Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
         */
        platform?: string;
        /**
         * Filter by profile ID. Omit for all profiles.
         */
        profileId?: string;
        /**
         * Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms.
         */
        source?: 'all' | 'late' | 'external';
    };
};
type GetBestTimeToPostResponse = ({
    slots?: Array<{
        /**
         * 0=Monday, 6=Sunday
         */
        day_of_week?: number;
        /**
         * Hour in UTC (0-23)
         */
        hour?: number;
        /**
         * Average engagement (likes + comments + shares + saves)
         */
        avg_engagement?: number;
        /**
         * Number of posts in this slot
         */
        post_count?: number;
    }>;
});
type GetBestTimeToPostError = ({
    error?: string;
} | {
    error?: string;
    requiresAddon?: boolean;
});
type GetContentDecayData = {
    query?: {
        /**
         * Filter by social account ID. Omit for all accounts.
         */
        accountId?: string;
        /**
         * Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
         */
        platform?: string;
        /**
         * Filter by profile ID. Omit for all profiles.
         */
        profileId?: string;
        /**
         * Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms.
         */
        source?: 'all' | 'late' | 'external';
    };
};
type GetContentDecayResponse = ({
    buckets?: Array<{
        /**
         * Sort order (0 = earliest, 6 = latest)
         */
        bucket_order?: number;
        /**
         * Human-readable label
         */
        bucket_label?: string;
        /**
         * Average % of final engagement reached (0-100)
         */
        avg_pct_of_final?: number;
        /**
         * Number of posts with data in this bucket
         */
        post_count?: number;
    }>;
});
type GetContentDecayError = (unknown | {
    error?: string;
} | {
    error?: string;
    requiresAddon?: boolean;
});
type GetPostingFrequencyData = {
    query?: {
        /**
         * Filter by social account ID. Omit for all accounts.
         */
        accountId?: string;
        /**
         * Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
         */
        platform?: string;
        /**
         * Filter by profile ID. Omit for all profiles.
         */
        profileId?: string;
        /**
         * Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms.
         */
        source?: 'all' | 'late' | 'external';
    };
};
type GetPostingFrequencyResponse = ({
    frequency?: Array<{
        platform?: string;
        /**
         * Number of posts published that week
         */
        posts_per_week?: number;
        /**
         * Average engagement rate as percentage (0-100)
         */
        avg_engagement_rate?: number;
        /**
         * Average raw engagement (likes+comments+shares+saves)
         */
        avg_engagement?: number;
        /**
         * Number of calendar weeks observed at this frequency
         */
        weeks_count?: number;
    }>;
});
type GetPostingFrequencyError = ({
    error?: string;
} | {
    error?: string;
    requiresAddon?: boolean;
});
type GetPostTimelineData = {
    query: {
        /**
         * Start of date range (ISO 8601). Defaults to 90 days ago.
         */
        fromDate?: string;
        /**
         * The post to fetch timeline for. Accepts an ExternalPost ID, a platformPostId, or a Zernio Post ID.
         *
         */
        postId: string;
        /**
         * End of date range (ISO 8601). Defaults to now.
         */
        toDate?: string;
    };
};
type GetPostTimelineResponse = ({
    /**
     * The postId that was requested
     */
    postId?: string;
    timeline?: Array<{
        /**
         * Date in YYYY-MM-DD format
         */
        date?: string;
        /**
         * Platform name (e.g. instagram, tiktok)
         */
        platform?: string;
        /**
         * Platform-specific post ID
         */
        platformPostId?: string;
        /**
         * Total impressions on this date
         */
        impressions?: number;
        /**
         * Total reach on this date
         */
        reach?: number;
        /**
         * Total likes on this date
         */
        likes?: number;
        /**
         * Total comments on this date
         */
        comments?: number;
        /**
         * Total shares on this date
         */
        shares?: number;
        /**
         * Total saves on this date
         */
        saves?: number;
        /**
         * Total clicks on this date
         */
        clicks?: number;
        /**
         * Total views on this date
         */
        views?: number;
    }>;
});
type GetPostTimelineError = ({
    error?: string;
} | {
    error?: string;
    code?: string;
});
type GetGoogleBusinessPerformanceData = {
    query: {
        /**
         * The Zernio SocialAccount ID for the Google Business Profile account.
         */
        accountId: string;
        /**
         * End date (YYYY-MM-DD). Defaults to today.
         */
        endDate?: string;
        /**
         * Comma-separated metric names. Defaults to all available metrics.
         * Valid values: BUSINESS_IMPRESSIONS_DESKTOP_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH,
         * BUSINESS_IMPRESSIONS_MOBILE_MAPS, BUSINESS_IMPRESSIONS_MOBILE_SEARCH,
         * BUSINESS_CONVERSATIONS, BUSINESS_DIRECTION_REQUESTS, CALL_CLICKS, WEBSITE_CLICKS,
         * BUSINESS_BOOKINGS, BUSINESS_FOOD_ORDERS, BUSINESS_FOOD_MENU_CLICKS
         *
         */
        metrics?: string;
        /**
         * Start date (YYYY-MM-DD). Defaults to 30 days ago. Max 18 months back.
         */
        startDate?: string;
    };
};
type GetGoogleBusinessPerformanceResponse = ({
    success?: boolean;
    accountId?: string;
    platform?: string;
    dateRange?: {
        startDate?: string;
        endDate?: string;
    };
    /**
     * Each key is a metric name containing total and daily values.
     */
    metrics?: {
        [key: string]: {
            /**
             * Sum of all daily values in the range
             */
            total?: number;
            values?: Array<{
                date?: string;
                value?: number;
            }>;
        };
    };
    dataDelay?: string;
});
type GetGoogleBusinessPerformanceError = ({
    error?: string;
    validMetrics?: Array<(string)>;
} | {
    error?: string;
} | {
    error?: string;
    code?: string;
});
type GetGoogleBusinessSearchKeywordsData = {
    query: {
        /**
         * The Zernio SocialAccount ID for the Google Business Profile account.
         */
        accountId: string;
        /**
         * End month (YYYY-MM). Defaults to current month.
         */
        endMonth?: string;
        /**
         * Start month (YYYY-MM). Defaults to 3 months ago.
         */
        startMonth?: string;
    };
};
type GetGoogleBusinessSearchKeywordsResponse = ({
    success?: boolean;
    accountId?: string;
    platform?: string;
    monthRange?: {
        startMonth?: string;
        endMonth?: string;
    };
    keywords?: Array<{
        keyword?: string;
        impressions?: number;
    }>;
    note?: string;
});
type GetGoogleBusinessSearchKeywordsError = ({
    error?: string;
} | {
    error?: string;
    code?: string;
});
type GetInboxVolumeData = {
    query: {
        accountId?: string;
        /**
         * Inclusive lower bound (YYYY-MM-DD). Required.
         */
        fromDate: string;
        /**
         * Filter by single platform (facebook, instagram, twitter, etc.).
         */
        platform?: string;
        profileId?: string;
        /**
         * Filter by metadata.source lineage (human, workflow, sequence, broadcast, comment_automation, api, contact, platform).
         */
        source?: string;
        /**
         * Inclusive upper bound (YYYY-MM-DD). Defaults to today.
         */
        toDate?: string;
    };
};
type GetInboxVolumeResponse = ({
    success?: boolean;
    from?: string;
    to?: (string) | null;
    summary?: {
        received?: number;
        sent?: number;
        read?: number;
        failed?: number;
        uniqueConversations?: number;
    };
    timeseries?: Array<{
        date?: string;
        sent?: number;
        received?: number;
        read?: number;
        failed?: number;
    }>;
    byPlatform?: Array<{
        platform?: string;
        sent?: number;
        received?: number;
        read?: number;
        failed?: number;
    }>;
});
type GetInboxVolumeError = ({
    error?: string;
    details?: {
        [key: string]: unknown;
    };
} | {
    error?: string;
} | ErrorResponse);
type GetInboxHeatmapData = {
    query: {
        accountId?: string;
        /**
         * Narrow to a single event type. "all" or omitted means no filter.
         */
        action?: 'message.received' | 'message.sent' | 'message.read' | 'all';
        fromDate: string;
        platform?: string;
        profileId?: string;
        source?: string;
        toDate?: string;
    };
};
type GetInboxHeatmapResponse = ({
    success?: boolean;
    from?: string;
    to?: (string) | null;
    buckets?: Array<{
        /**
         * 1 = Monday, 7 = Sunday
         */
        dow?: number;
        hour?: number;
        received?: number;
        sent?: number;
        read?: number;
    }>;
});
type GetInboxHeatmapError = ({
    error?: string;
    details?: {
        [key: string]: unknown;
    };
} | {
    error?: string;
} | ErrorResponse);
type GetInboxSourceBreakdownData = {
    query: {
        accountId?: string;
        fromDate: string;
        platform?: string;
        profileId?: string;
        toDate?: string;
    };
};
type GetInboxSourceBreakdownResponse = ({
    success?: boolean;
    from?: string;
    to?: (string) | null;
    sources?: Array<{
        source?: string;
        received?: number;
        sent?: number;
        read?: number;
        byPlatform?: Array<{
            platform?: string;
            received?: number;
            sent?: number;
            read?: number;
        }>;
    }>;
});
type GetInboxSourceBreakdownError = ({
    error?: string;
    details?: {
        [key: string]: unknown;
    };
} | {
    error?: string;
} | ErrorResponse);
type GetInboxResponseTimeData = {
    query: {
        accountId?: string;
        fromDate: string;
        platform?: string;
        profileId?: string;
        toDate?: string;
    };
};
type GetInboxResponseTimeResponse = ({
    success?: boolean;
    from?: string;
    to?: (string) | null;
    summary?: {
        sampleSize?: number;
        medianSeconds?: number;
        p90Seconds?: number;
        p99Seconds?: number;
        meanSeconds?: number;
        fastestSeconds?: number;
        slowestSeconds?: number;
    };
    histogram?: Array<{
        /**
         * Human label (0-1m, 1-5m, 5-15m, 15-60m, 1-4h, 4-24h, 1d+)
         */
        bucket?: string;
        lowerSeconds?: number;
        /**
         * null on the open-ended last bucket
         */
        upperSeconds?: (number) | null;
        count?: number;
    }>;
});
type GetInboxResponseTimeError = ({
    error?: string;
    details?: {
        [key: string]: unknown;
    };
} | {
    error?: string;
} | ErrorResponse);
type GetInboxTopAccountsData = {
    query: {
        fromDate: string;
        /**
         * Cap on returned rows. Lower than the posting listing's 100 because each row triggers a SocialAccount Mongo lookup.
         */
        limit?: number;
        platform?: string;
        profileId?: string;
        source?: string;
        toDate?: string;
    };
};
type GetInboxTopAccountsResponse = ({
    success?: boolean;
    from?: string;
    to?: (string) | null;
    accounts?: Array<{
        accountId?: string;
        platform?: string;
        /**
         * (disconnected) when the SocialAccount no longer exists
         */
        displayName?: string;
        username?: string;
        received?: number;
        sent?: number;
        total?: number;
        conversations?: number;
        medianResponseSeconds?: number;
        /**
         * Distinguishes 'instant replies' from 'no replies at all' so a zero medianResponseSeconds with repliedCount=0 renders as '—' instead of '0s'
         */
        repliedCount?: number;
    }>;
});
type GetInboxTopAccountsError = ({
    error?: string;
    details?: {
        [key: string]: unknown;
    };
} | {
    error?: string;
} | ErrorResponse);
type ListInboxConversationAnalyticsData = {
    query: {
        accountId?: string;
        fromDate: string;
        limit?: number;
        order?: 'asc' | 'desc';
        page?: number;
        platform?: string;
        profileId?: string;
        sortBy?: 'lastMessageAt' | 'firstMessageAt' | 'totalMessages' | 'received' | 'sent' | 'read' | 'failed';
        source?: string;
        toDate?: string;
    };
};
type ListInboxConversationAnalyticsResponse = ({
    success?: boolean;
    from?: string;
    to?: (string) | null;
    items?: Array<{
        /**
         * The platformConversationId (the same identity used by metadata.conversationId)
         */
        conversationId?: string;
        /**
         * The Conversation document _id, when a matching doc exists
         */
        mongoId?: (string) | null;
        accountId?: string;
        platform?: string;
        participantName?: (string) | null;
        participantUsername?: (string) | null;
        participantPicture?: (string) | null;
        /**
         * Cached preview from the Conversation doc
         */
        lastMessage?: (string) | null;
        totalMessages?: number;
        received?: number;
        sent?: number;
        read?: number;
        failed?: number;
        firstMessageAt?: string;
        lastMessageAt?: string;
    }>;
    pagination?: {
        page?: number;
        limit?: number;
        total?: number;
        totalPages?: number;
        hasMore?: boolean;
    };
});
type ListInboxConversationAnalyticsError = ({
    error?: string;
    details?: {
        [key: string]: unknown;
    };
} | {
    error?: string;
} | ErrorResponse);
type GetInboxConversationAnalyticsData = {
    path: {
        /**
         * Mongo _id or platformConversationId.
         */
        conversationId: string;
    };
    query: {
        fromDate: string;
        toDate?: string;
    };
};
type GetInboxConversationAnalyticsResponse = ({
    success?: boolean;
    /**
     * The platformConversationId
     */
    conversationId?: string;
    mongoId?: string;
    platform?: (string) | null;
    from?: string;
    to?: (string) | null;
    summary?: {
        received?: number;
        sent?: number;
        read?: number;
        failed?: number;
        totalMessages?: number;
        firstMessageAt?: (string) | null;
        lastMessageAt?: (string) | null;
    };
    timeseries?: Array<{
        date?: string;
        sent?: number;
        received?: number;
        read?: number;
        failed?: number;
    }>;
    bySource?: Array<{
        /**
         * (unspecified) for legacy rows with no metadata.source
         */
        source?: string;
        count?: number;
    }>;
});
type GetInboxConversationAnalyticsError = ({
    error?: string;
    details?: {
        [key: string]: unknown;
    };
} | {
    error?: string;
} | {
    error?: string;
    code?: string;
} | ErrorResponse);
type ListAccountGroupsResponse = ({
    groups?: Array<{
        _id?: string;
        name?: string;
        accountIds?: Array<(string)>;
        createdBy?: string;
        /**
         * Legacy field. Present only on groups created before
         * cross-profile groups were supported. New groups omit it.
         *
         */
        profileId?: string;
    }>;
});
type ListAccountGroupsError = ({
    error?: string;
});
type CreateAccountGroupData = {
    body: {
        name: string;
        accountIds: Array<(string)>;
        /**
         * Deprecated. Accepted for backward compatibility but ignored.
         * Groups are no longer scoped to a single profile.
         *
         * @deprecated
         */
        profileId?: string;
    };
};
type CreateAccountGroupResponse = ({
    message?: string;
    group?: {
        _id?: string;
        name?: string;
        accountIds?: Array<(string)>;
    };
});
type CreateAccountGroupError = (unknown | {
    error?: string;
});
type UpdateAccountGroupData = {
    body: {
        name?: string;
        accountIds?: Array<(string)>;
    };
    path: {
        groupId: string;
    };
};
type UpdateAccountGroupResponse = ({
    message?: string;
    group?: {
        [key: string]: unknown;
    };
});
type UpdateAccountGroupError = (unknown | {
    error?: string;
});
type DeleteAccountGroupData = {
    path: {
        groupId: string;
    };
};
type DeleteAccountGroupResponse = ({
    message?: string;
});
type DeleteAccountGroupError = (unknown | {
    error?: string;
});
type GetMediaPresignedUrlData = {
    body: {
        /**
         * Name of the file to upload
         */
        filename: string;
        /**
         * MIME type of the file
         */
        contentType: 'image/jpeg' | 'image/jpg' | 'image/png' | 'image/webp' | 'image/gif' | 'video/mp4' | 'video/mpeg' | 'video/quicktime' | 'video/avi' | 'video/x-msvideo' | 'video/webm' | 'video/x-m4v' | 'application/pdf' | 'audio/mpeg' | 'audio/mp4' | 'audio/aac' | 'audio/ogg' | 'audio/wav' | 'audio/webm' | 'audio/x-m4a';
        /**
         * Optional file size in bytes for pre-validation (max 5GB)
         */
        size?: number;
    };
};
type GetMediaPresignedUrlResponse = ({
    /**
     * Presigned URL to PUT your file to (expires in 1 hour)
     */
    uploadUrl?: string;
    /**
     * Public URL where the file will be accessible after upload
     */
    publicUrl?: string;
    /**
     * Storage key/path of the file
     */
    key?: string;
    /**
     * Seconds until the presigned uploadUrl expires (always 3600)
     */
    expiresIn?: number;
});
type GetMediaPresignedUrlError = (ErrorResponse | {
    error?: string;
});
type SearchRedditData = {
    query: {
        accountId: string;
        after?: string;
        limit?: number;
        q: string;
        restrict_sr?: '0' | '1';
        sort?: 'relevance' | 'hot' | 'top' | 'new' | 'comments';
        subreddit?: string;
    };
};
type SearchRedditResponse = ({
    items?: Array<RedditPost>;
    after?: (string) | null;
    before?: (string) | null;
});
type SearchRedditError = (ErrorResponse | {
    error?: string;
});
type GetRedditFeedData = {
    query: {
        accountId: string;
        after?: string;
        limit?: number;
        sort?: 'hot' | 'new' | 'top' | 'rising';
        subreddit?: string;
        t?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'all';
    };
};
type GetRedditFeedResponse = ({
    items?: Array<RedditPost>;
    after?: (string) | null;
    before?: (string) | null;
});
type GetRedditFeedError = (ErrorResponse | {
    error?: string;
});
type GetBillingResponse = (BillingSnapshot);
type GetBillingError = ({
    error?: string;
});
type GetXApiPricingResponse = (XApiPricing);
type GetXApiPricingError = ({
    error?: string;
});
type GetUsageData = {
    query?: {
        /**
         * Inclusive start (UTC date). Required when `range=custom`.
         */
        from?: string;
        /**
         * Bucketing of the `days` series: `day` (one row per UTC day),
         * `month` (one row per calendar month, dated to the 1st), or `total`
         * (no series — read `totals`). Does not affect `totals`.
         *
         */
        granularity?: 'day' | 'month' | 'total';
        /**
         * Window to report. `cycle` / `prev-cycle` resolve to the customer's
         * real billing-period bounds (falling back to a trailing 30 days when
         * no invoice exists yet); `7d`…`12mo` are trailing windows; `custom`
         * uses `from` / `to`.
         *
         */
        range?: 'cycle' | 'prev-cycle' | '7d' | '14d' | '30d' | '3mo' | '12mo' | 'custom';
        /**
         * Snapshot mode only. For Stripe subscription users, `true` forces a
         * subscription reconciliation pass even when cached plan data looks
         * complete.
         *
         */
        reconcile?: boolean;
        /**
         * Inclusive end (UTC date). Required when `range=custom`. Max span 366 days.
         */
        to?: string;
    };
};
type GetUsageResponse = ((UsageStats | UsageMetering));
type GetUsageError = (unknown | {
    error?: string;
});
type GetUsageStatsData = {
    query?: {
        /**
         * For Stripe subscription users, `true` forces a subscription
         * reconciliation pass even when cached plan data looks complete.
         * Omit the parameter, or pass `false`, to use the default
         * first-time-only reconciliation behavior. Invalid boolean values are
         * rejected.
         *
         */
        reconcile?: boolean;
    };
};
type GetUsageStatsResponse = (UsageStats);
type GetUsageStatsError = (unknown | {
    error?: string;
});
type GetCallsUsageData = {
    query?: {
        channel?: 'whatsapp' | 'pstn';
        groupBy?: 'day' | 'number' | 'channel';
        /**
         * Scope to calls involving this number (typically one of YOUR numbers). E.164, leading + optional.
         */
        number?: string;
        /**
         * Start of the window (inclusive). Default 30 days before `until`.
         */
        since?: string;
        /**
         * End of the window (exclusive). Default now.
         */
        until?: string;
    };
};
type GetCallsUsageResponse = ({
    since?: string;
    until?: string;
    groupBy?: ('day' | 'number' | 'channel') | null;
    totals?: {
        calls?: number;
        answered?: number;
        minutes?: number;
        /**
         * What Zernio bills for these calls.
         */
        billableUSD?: number;
        /**
         * WhatsApp only: Meta's per-minute charge, billed by Meta directly to your WABA. Display only.
         */
        metaUSD?: number;
    };
    /**
     * Present (possibly empty) when `groupBy` is set.
     */
    groups?: Array<{
        /**
         * The group key: a `YYYY-MM-DD` UTC day, one of your numbers, or a channel.
         */
        key?: string;
        calls?: number;
        answered?: number;
        minutes?: number;
        billableUSD?: number;
        metaUSD?: number;
    }>;
});
type GetCallsUsageError = (unknown | {
    error?: string;
});
type GetSmsUsageData = {
    query?: {
        groupBy?: 'day' | 'number';
        /**
         * Scope to one of YOUR SMS-enabled numbers (E.164, leading + optional).
         */
        number?: string;
        /**
         * Start of the window (inclusive). Default 30 days before `until`.
         */
        since?: string;
        /**
         * End of the window (exclusive). Default now.
         */
        until?: string;
    };
};
type GetSmsUsageResponse = ({
    since?: string;
    until?: string;
    groupBy?: ('day' | 'number') | null;
    totals?: {
        sent?: number;
        received?: number;
        total?: number;
    };
    /**
     * Present (possibly empty) when `groupBy` is set.
     */
    groups?: Array<{
        /**
         * A `YYYY-MM-DD` UTC day or one of your numbers.
         */
        key?: string;
        sent?: number;
        received?: number;
        total?: number;
    }>;
});
type GetSmsUsageError = (unknown | {
    error?: string;
});
type ListPostsData = {
    query?: {
        /**
         * Filter posts to those published via a specific social account (24-char hex ObjectId).
         */
        accountId?: string;
        /**
         * Filter posts to those created by a specific team user (24-char hex ObjectId).
         */
        createdBy?: string;
        /**
         * Zero-padded YYYY-MM-DD, or a full ISO 8601 datetime. An empty value means no date filter; any other malformed value returns 400.
         */
        dateFrom?: string;
        /**
         * Zero-padded YYYY-MM-DD, or a full ISO 8601 datetime. An empty value means no date filter; any other malformed value returns 400.
         */
        dateTo?: string;
        includeHidden?: boolean;
        /**
         * Page size. Values above the maximum return 400 rather than being clamped.
         */
        limit?: number;
        /**
         * Page number (1-based)
         */
        page?: number;
        platform?: string;
        /**
         * Filter posts to a specific profile (24-char hex ObjectId). Omit it, or send `all` or an empty value, to list posts across every profile.
         */
        profileId?: string;
        /**
         * Search posts by text content.
         */
        search?: string;
        /**
         * Sort order for results.
         */
        sortBy?: 'scheduled-desc' | 'scheduled-asc' | 'created-desc' | 'created-asc' | 'status' | 'platform';
        /**
         * Which collection to read. `zernio` (default) returns posts authored through Zernio. `external` returns posts synced from the platform (existing/historical posts that were published outside Zernio). Combine with `accountId` and paginate via `page`/`limit` to walk the full synced history (we keep up to the last ~12 months per account).
         */
        source?: 'zernio' | 'external';
        status?: 'draft' | 'scheduled' | 'published' | 'failed';
    };
};
type ListPostsResponse = (PostsListResponse);
type ListPostsError = (ErrorResponse | {
    error?: string;
});
type CreatePostData = {
    body: {
        title?: string;
        /**
         * Post caption/text. Optional when media is attached, all platforms have customContent, every platform entry is an X Article (platformSpecificData.article), or every platform entry is a LinkedIn plain repost (platformSpecificData.reshareUrl with no text). Required for other text-only posts.
         */
        content?: string;
        mediaItems?: Array<MediaItem>;
        /**
         * Target platforms and accounts for this post. Required for non-draft posts (returns 400 if empty). Drafts can omit platforms.
         */
        platforms?: Array<{
            platform: string;
            accountId: string;
            /**
             * Platform-specific text override. When set, this content is used instead of the top-level post content for this platform. Useful for tailoring captions per platform (e.g. keeping tweets under 280 characters).
             */
            customContent?: string;
            customMedia?: Array<MediaItem>;
            /**
             * Optional per-platform scheduled time override. When omitted, the top-level scheduledFor is used.
             */
            scheduledFor?: string;
            platformSpecificData?: (TwitterPlatformData | ThreadsPlatformData | FacebookPlatformData | InstagramPlatformData | LinkedInPlatformData | PinterestPlatformData | YouTubePlatformData | GoogleBusinessPlatformData | TikTokPlatformData | TelegramPlatformData | SnapchatPlatformData | RedditPlatformData | BlueskyPlatformData | DiscordPlatformData | SlackPlatformData);
        }>;
        scheduledFor?: string;
        publishNow?: boolean;
        /**
         * When true, saves the post as a draft. When none of scheduledFor, publishNow, or queuedFromProfile are provided, the post defaults to draft automatically.
         */
        isDraft?: boolean;
        timezone?: string;
        /**
         * Tags/keywords. YouTube constraints: each tag max 100 chars, combined max 500 chars, duplicates auto-removed.
         */
        tags?: Array<(string)>;
        hashtags?: Array<(string)>;
        /**
         * Stored for reference only. This field does NOT automatically create @mentions when publishing. For LinkedIn @mentions, use the /v1/accounts/{accountId}/linkedin-mentions endpoint to resolve profile URLs to URNs, then embed the returned mentionFormat directly in the post content field.
         */
        mentions?: Array<(string)>;
        crosspostingEnabled?: boolean;
        metadata?: {
            [key: string]: unknown;
        };
        /**
         * Root-level TikTok settings applied to the TikTok platforms sent in the same request. Merged into each platform's platformSpecificData, with platform-specific settings taking precedence.
         */
        tiktokSettings?: TikTokPlatformData;
        /**
         * Root-level Facebook settings applied to the Facebook platforms sent in the same request. Merged into each platform's platformSpecificData.facebookSettings, with platform-specific settings taking precedence.
         */
        facebookSettings?: FacebookSettings;
        recycling?: RecyclingConfig;
        /**
         * Profile ID to schedule via queue. When provided without scheduledFor, the post is auto-assigned to the next available slot. Do not call /v1/queue/next-slot and use that time in scheduledFor, as that bypasses queue locking.
         */
        queuedFromProfile?: string;
        /**
         * Specific queue ID to use when scheduling via queue.
         * Only used when queuedFromProfile is also provided.
         * If omitted, uses the profile's default queue.
         *
         */
        queueId?: string;
    };
    headers?: {
        /**
         * Optional client-generated request identifier for safe retry (idempotency). When two requests carry the same value, the second is treated as a retry of the first and returns the original post (HTTP 200) instead of creating a duplicate. Window is ~5 minutes from the first request. Generate a UUID per logical call. SDKs do this automatically; HTTP clients should set it themselves or omit it. See the operation description for the full idempotency contract.
         *
         */
        'x-request-id'?: string;
    };
};
type CreatePostResponse = (PostCreateResponse);
type CreatePostError = ({
    error?: string;
} | {
    error?: string;
    /**
     * Stable machine-readable cause. Absent for ownership failures.
     */
    code?: 'ACCOUNT_DISCONNECTED' | 'PROFILE_OVER_LIMIT';
} | {
    error?: string;
    details?: {
        accountId?: string;
        platform?: string;
        existingPostId?: string;
    };
} | {
    error?: string;
    /**
     * Additional context about the rate limit
     */
    details?: {
        [key: string]: unknown;
    };
});
type SyncExternalPostsData = {
    body: {
        /**
         * SocialAccount ID whose posts to sync. Must be connected to Zernio.
         */
        accountId: string;
        /**
         * The post URL to locate. Optional. Provide `url` or `postId` to return a specific post; omit both to just refresh and return the account's recent posts.
         */
        url?: string;
        /**
         * The platform post/media/video id to locate, as an alternative to `url`. Optional.
         */
        postId?: string;
    };
};
type SyncExternalPostsResponse = ({
    synced?: {
        /**
         * Posts returned by the platform listing during the on-demand sync
         */
        postsFound?: number;
        /**
         * Posts inserted or updated in Zernio
         */
        postsSynced?: number;
        /**
         * True when no live fetch ran: the post was already stored, or the account was synced within the debounce window
         */
        skipped?: boolean;
    };
    /**
     * Present only when a locator (`url`/`postId`) was provided — whether the post was found.
     */
    found?: boolean;
    /**
     * The matched external post, or null when not found. Present only when a locator was provided.
     */
    post?: (ExternalPostSummary | null);
    /**
     * The account's recent external posts. Present only when no locator was provided.
     */
    posts?: Array<ExternalPostSummary>;
});
type SyncExternalPostsError = (ErrorResponse);
type GetPostData = {
    path: {
        postId: string;
    };
};
type GetPostResponse = (PostGetResponse);
type GetPostError = (ErrorResponse | {
    error?: string;
});
type UpdatePostData = {
    body: {
        title?: string;
        content?: string;
        mediaItems?: Array<MediaItem>;
        /**
         * Target platforms and accounts for this post. Each item must include platform and accountId.
         */
        platforms?: Array<{
            platform: string;
            accountId: string;
            /**
             * Platform-specific text override.
             */
            customContent?: string;
            customMedia?: Array<MediaItem>;
            /**
             * Optional per-platform scheduled time override.
             */
            scheduledFor?: string;
            /**
             * A <platform>Settings namespace (e.g. facebookSettings, tiktokSettings) omitted from the request is preserved from the stored post. Sending the key replaces the whole namespace; it is not deep-merged.
             */
            platformSpecificData?: {
                [key: string]: unknown;
            };
        }>;
        scheduledFor?: string;
        publishNow?: boolean;
        /**
         * When omitted, the post keeps its current draft status. Send `false` to promote a draft to scheduled (combined with `scheduledFor`, `publishNow`, or a queue).
         */
        isDraft?: boolean;
        timezone?: string;
        visibility?: 'public' | 'private' | 'unlisted';
        tags?: Array<(string)>;
        hashtags?: Array<(string)>;
        mentions?: Array<(string)>;
        crosspostingEnabled?: boolean;
        metadata?: {
            [key: string]: unknown;
        };
        /**
         * Profile ID to schedule via queue.
         */
        queuedFromProfile?: string;
        /**
         * Specific queue ID to use when scheduling via queue.
         */
        queueId?: string;
        /**
         * Root-level TikTok settings applied to the TikTok platforms sent in the same request. Merged into each platform's platformSpecificData, with platform-specific settings taking precedence. Returns 400 if sent without a platforms array.
         */
        tiktokSettings?: TikTokPlatformData;
        /**
         * Root-level Facebook settings applied to the Facebook platforms sent in the same request. Merged into each platform's platformSpecificData.facebookSettings, with platform-specific settings taking precedence. Returns 400 if sent without a platforms array.
         */
        facebookSettings?: FacebookSettings;
        recycling?: RecyclingConfig;
        [key: string]: unknown | string | MediaItem | boolean | TikTokPlatformData | FacebookSettings | RecyclingConfig;
    };
    path: {
        postId: string;
    };
};
type UpdatePostResponse = (PostUpdateResponse | unknown);
type UpdatePostError = (ErrorResponse | {
    error?: string;
});
type DeletePostData = {
    path: {
        postId: string;
    };
};
type DeletePostResponse = (PostDeleteResponse);
type DeletePostError = (ErrorResponse | {
    error?: string;
});
type BulkUploadPostsData = {
    body: {
        file?: (Blob | File);
    };
    query?: {
        dryRun?: boolean;
    };
};
type BulkUploadPostsResponse = (BulkUploadResult);
type BulkUploadPostsError = (ErrorResponse | {
    error?: string;
} | {
    error?: string;
    details?: {
        [key: string]: unknown;
    };
});
type RetryPostData = {
    path: {
        postId: string;
    };
};
type RetryPostResponse = (PostRetryResponse | unknown);
type RetryPostError = (ErrorResponse | {
    error?: string;
} | {
    error?: string;
    details?: {
        [key: string]: unknown;
    };
});
type UnpublishPostData = {
    body: {
        /**
         * The platform to delete the post from
         */
        platform: 'threads' | 'facebook' | 'twitter' | 'linkedin' | 'youtube' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram';
    };
    path: {
        postId: string;
    };
};
type UnpublishPostResponse = ({
    success?: boolean;
    message?: string;
});
type UnpublishPostError = (ErrorResponse | {
    error?: string;
} | unknown);
type EditPostData = {
    body: {
        /**
         * The platform to edit the post on.
         */
        platform: 'twitter' | 'discord' | 'facebook' | 'reddit' | 'linkedin' | 'telegram' | 'pinterest' | 'googlebusiness' | 'youtube' | 'slack';
        /**
         * The new post text content
         */
        content: string;
        /**
         * Which account's copy of the post to edit when the post was published to several accounts on the same platform; defaults to the first.
         *
         */
        accountId?: string;
    };
    path: {
        postId: string;
    };
};
type EditPostResponse = ({
    success?: boolean;
    /**
     * The platform post ID after the edit. X assigns a new ID; every other platform returns the original ID unchanged.
     *
     */
    id?: string;
    /**
     * URL of the edited post
     */
    url?: string;
    message?: string;
});
type EditPostError = (unknown | {
    error?: string;
});
type UpdatePostMetadataData = {
    body: {
        /**
         * The platform to update metadata on
         */
        platform: 'youtube';
        /**
         * YouTube video ID (required for direct mode, ignored for post-based mode)
         */
        videoId?: string;
        /**
         * Zernio social account ID (required for direct mode, ignored for post-based mode)
         */
        accountId?: string;
        /**
         * New video title (max 100 characters for YouTube)
         */
        title?: string;
        /**
         * New video description
         */
        description?: string;
        /**
         * Array of keyword tags (max 500 characters combined for YouTube)
         */
        tags?: Array<(string)>;
        /**
         * YouTube video category ID
         */
        categoryId?: string;
        /**
         * Video privacy setting
         */
        privacyStatus?: 'public' | 'private' | 'unlisted';
        /**
         * Public URL of a custom thumbnail image (JPEG, PNG, or GIF, max 2 MB, recommended 1280x720). Works on any video you own, including existing videos not published through Zernio. The channel must be verified (phone verification) to set custom thumbnails.
         */
        thumbnailUrl?: string;
        /**
         * COPPA compliance flag. Set true for child-directed content (restricts comments, notifications, ad targeting).
         */
        madeForKids?: boolean;
        /**
         * AI-generated content disclosure. Set true if the video contains synthetic content that could be mistaken for real. YouTube may add a label.
         */
        containsSyntheticMedia?: boolean;
        /**
         * YouTube playlist ID to add the video to (e.g. 'PLxxxxxxxxxxxxx'). Use GET /v1/accounts/{id}/youtube-playlists to list available playlists. Only playlists owned by the channel are supported.
         */
        playlistId?: string;
    };
    path: {
        /**
         * Zernio post ID, or "_" when using direct video ID mode
         */
        postId: string;
    };
};
type UpdatePostMetadataResponse = ({
    success?: boolean;
    message?: string;
    /**
     * Only present in direct video ID mode
     */
    videoId?: string;
    updatedFields?: Array<(string)>;
});
type UpdatePostMetadataError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListUsersResponse = ({
    currentUserId?: string;
    users?: Array<{
        _id?: string;
        name?: string;
        email?: string;
        role?: string;
        isRoot?: boolean;
        profileAccess?: Array<(string)>;
        createdAt?: string;
    }>;
});
type ListUsersError = ({
    error?: string;
});
type GetUserData = {
    path: {
        userId: string;
    };
};
type GetUserResponse = ({
    user?: {
        _id?: string;
        name?: string;
        email?: string;
        role?: string;
        isRoot?: boolean;
        profileAccess?: Array<(string)>;
    };
});
type GetUserError = ({
    error?: string;
} | unknown);
type ListProfilesData = {
    query?: {
        /**
         * When true, includes over-limit profiles (marked with isOverLimit: true).
         */
        includeOverLimit?: boolean;
        /**
         * Page size. When limit or skip is present, the response includes total and skip (and echoes limit).
         */
        limit?: number;
        /**
         * Exact-match filter on the profile name. Useful to recover a profile id after an ambiguous create (timeout followed by a 409 on retry).
         */
        name?: string;
        /**
         * Number of profiles to skip, applied after sorting and filtering.
         */
        skip?: number;
    };
};
type ListProfilesResponse = (ProfilesListResponse);
type ListProfilesError = (ErrorResponse | {
    error?: string;
});
type CreateProfileData = {
    body: {
        name: string;
        description?: string;
        color?: string;
    };
    headers?: {
        /**
         * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
         */
        'Idempotency-Key'?: string;
    };
};
type CreateProfileResponse = (ProfileCreateResponse);
type CreateProfileError = (unknown | {
    error?: string;
} | {
    /**
     * 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';
    /**
     * 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 is
     * the Zernio billing tab. 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;
        /**
         * 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;
    };
});
type GetProfileData = {
    path: {
        profileId: string;
    };
};
type GetProfileResponse = (ProfileGetResponse);
type GetProfileError = ({
    error?: string;
});
type UpdateProfileData = {
    body: {
        name?: string;
        description?: string;
        color?: string;
        isDefault?: boolean;
    };
    path: {
        profileId: string;
    };
};
type UpdateProfileResponse = (ProfileUpdateResponse);
type UpdateProfileError = (unknown | {
    error?: string;
});
type DeleteProfileData = {
    path: {
        profileId: string;
    };
};
type DeleteProfileResponse = (ProfileDeleteResponse);
type DeleteProfileError = (unknown | {
    error?: string;
});
type ListAccountsData = {
    query?: {
        /**
         * When true, includes accounts from over-limit profiles.
         */
        includeOverLimit?: boolean;
        /**
         * Page size. Must be provided together with page; sending only one of the two returns 400.
         *
         */
        limit?: number;
        /**
         * Page number (1-based). Must be provided together with limit to enable server-side pagination; sending only one of the two returns 400. Omit both for all accounts.
         *
         */
        page?: number;
        /**
         * Filter accounts by platform (e.g. "instagram", "twitter").
         */
        platform?: string;
        /**
         * Filter accounts by profile ID. Must be a valid ObjectId.
         */
        profileId?: string;
        /**
         * Filter accounts by connection status. `connected` returns healthy accounts; `disconnected` returns accounts that need reconnection (per the same reconnection check surfaced in the dashboard). Omit to return accounts in any status. When combined with page/limit, pagination totals reflect the filtered result set.
         *
         */
        status?: 'connected' | 'disconnected';
    };
};
type ListAccountsResponse = (AccountsListResponse);
type ListAccountsError = (ErrorResponse | {
    error?: string;
});
type GetFollowerStatsData = {
    query?: {
        /**
         * Comma-separated list of account IDs (optional, defaults to all user's accounts)
         */
        accountIds?: string;
        /**
         * Start date in YYYY-MM-DD format (defaults to 30 days ago)
         */
        fromDate?: string;
        /**
         * Data aggregation level
         */
        granularity?: 'daily' | 'weekly' | 'monthly';
        /**
         * Filter by profile ID
         */
        profileId?: string;
        /**
         * End date in YYYY-MM-DD format (defaults to today)
         */
        toDate?: string;
    };
};
type GetFollowerStatsResponse = (FollowerStatsResponse);
type GetFollowerStatsError = ({
    error?: string;
} | {
    error?: string;
    message?: string;
    requiresAddon?: boolean;
});
type UpdateAccountData = {
    body: {
        username?: string;
        displayName?: string;
        /**
         * X/Twitter only. Per-account opt-in toggles for background API
         * operations that incur X API pass-through costs. Each call is
         * billed via Metronome at the X tier rate. Either field can be
         * sent independently; omitted fields are unchanged.
         *
         */
        xCapabilities?: {
            /**
             * Enable periodic analytics reads (impressions, likes, etc.)
             * for this X account. Each X API call is metered as
             * `posts_read` and billed pass-through (~$0.005/call at the
             * time of writing — actual rate depends on X's pricing tier).
             *
             */
            analytics?: boolean;
            /**
             * Enable DM polling and inbox sync for this X account. DM
             * reads are metered as `dm_event_read` (~$0.010/call) and
             * DM sends as `dm_interaction_create` (~$0.015/call), both
             * billed pass-through. DM sends fire only on user-initiated
             * actions; reads/polling fire only when this flag is true.
             *
             */
            inbox?: boolean;
        };
    };
    path: {
        accountId: string;
    };
};
type UpdateAccountResponse = ({
    message?: string;
    username?: string;
    displayName?: string;
    /**
     * Echo of the resulting `xCapabilities` state, returned only
     * when the request body included an `xCapabilities` object.
     *
     */
    xCapabilities?: {
        analytics?: boolean;
        inbox?: boolean;
    };
});
type UpdateAccountError = (unknown | {
    error?: string;
});
type MoveAccountToProfileData = {
    body: {
        /**
         * Target profile ID (must be a valid ObjectId and owned by the same user as the account).
         */
        profileId: string;
    };
    path: {
        accountId: string;
    };
};
type MoveAccountToProfileResponse = ({
    message?: string;
    profileId?: string;
});
type MoveAccountToProfileError = (unknown | {
    error?: string;
});
type DeleteAccountData = {
    path: {
        accountId: string;
    };
};
type DeleteAccountResponse = ({
    message?: string;
});
type DeleteAccountError = ({
    error?: string;
});
type GetAllAccountsHealthData = {
    query?: {
        /**
         * Filter by platform
         */
        platform?: 'facebook' | 'instagram' | 'linkedin' | 'twitter' | 'tiktok' | 'youtube' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp';
        /**
         * Filter by profile ID
         */
        profileId?: string;
        /**
         * Filter by health status
         */
        status?: 'healthy' | 'warning' | 'error';
    };
};
type GetAllAccountsHealthResponse = ({
    summary?: {
        /**
         * Total number of accounts
         */
        total?: number;
        /**
         * Number of healthy accounts
         */
        healthy?: number;
        /**
         * Number of accounts with warnings
         */
        warning?: number;
        /**
         * Number of accounts with errors
         */
        error?: number;
        /**
         * Number of accounts needing reconnection
         */
        needsReconnect?: number;
    };
    accounts?: Array<{
        accountId?: string;
        platform?: string;
        username?: string;
        displayName?: string;
        profileId?: string;
        status?: 'healthy' | 'warning' | 'error';
        canPost?: boolean;
        canFetchAnalytics?: boolean;
        tokenValid?: boolean;
        tokenExpiresAt?: string;
        needsReconnect?: boolean;
        issues?: Array<(string)>;
    }>;
});
type GetAllAccountsHealthError = (ErrorResponse | {
    error?: string;
});
type RegisterWhatsAppNumberData = {
    body?: {
        /**
         * The 6-digit two-step verification PIN set on the number. Omit it only if the number has no PIN of its own.
         */
        pin?: string;
    };
    path: {
        /**
         * The WhatsApp account ID
         */
        accountId: string;
    };
};
type RegisterWhatsAppNumberResponse = ({
    registered?: boolean;
    accountId?: string;
    phoneNumberId?: string;
});
type RegisterWhatsAppNumberError = (ErrorResponse | unknown);
type GetAccountHealthData = {
    path: {
        /**
         * The account ID to check
         */
        accountId: string;
    };
};
type GetAccountHealthResponse = ({
    accountId?: string;
    platform?: string;
    username?: string;
    displayName?: string;
    /**
     * Overall health status
     */
    status?: 'healthy' | 'warning' | 'error';
    tokenStatus?: {
        /**
         * Whether the token is valid
         */
        valid?: boolean;
        expiresAt?: string;
        /**
         * Human-readable time until expiry
         */
        expiresIn?: string;
        /**
         * Whether token expires within 24 hours
         */
        needsRefresh?: boolean;
    };
    permissions?: {
        posting?: Array<{
            scope?: string;
            granted?: boolean;
            required?: boolean;
        }>;
        analytics?: Array<{
            scope?: string;
            granted?: boolean;
            required?: boolean;
        }>;
        optional?: Array<{
            scope?: string;
            granted?: boolean;
            required?: boolean;
        }>;
        canPost?: boolean;
        canFetchAnalytics?: boolean;
        missingRequired?: Array<(string)>;
    };
    /**
     * List of issues found
     */
    issues?: Array<(string)>;
    /**
     * Actionable recommendations to fix issues
     */
    recommendations?: Array<(string)>;
    /**
     * WhatsApp accounts only. Live probe of the Meta link behind the channel, performed at request time (the same read as GET /v1/whatsapp/number-info).
     */
    platformConnection?: {
        /**
         * `connected` = Meta served the channel object. `disconnected` = Meta refused to serve it (Graph error 100, subcode 33), which is how a phone-side coexistence disconnect surfaces. `unknown` = the live read failed for another reason (timeout, transient Meta error), not evidence either way.
         */
        status?: 'connected' | 'disconnected' | 'unknown';
        /**
         * When this live probe ran (always the current request; never cached)
         */
        checkedAt?: string;
        /**
         * Meta's own `status` field from the phone-number node (for example CONNECTED), when the object was readable
         */
        phoneStatus?: (string) | null;
        /**
         * Set only when status is `disconnected`
         */
        metaError?: {
            /**
             * Meta Graph error code (100)
             */
            code?: number;
            /**
             * Meta Graph error subcode (33)
             */
            subcode?: number;
            message?: string;
        } | null;
    };
});
type GetAccountHealthError = (ErrorResponse | {
    error?: string;
});
type GetInstagramFollowStatusData = {
    path: {
        /**
         * Instagram account ID
         */
        accountId: string;
        /**
         * Instagram-scoped user id (IGSID) from a webhook payload
         */
        userId: string;
    };
    query?: {
        /**
         * Bypass the cache and re-query Meta
         */
        refresh?: boolean;
    };
};
type GetInstagramFollowStatusResponse = ({
    userId: string;
    accountId: string;
    /**
     * The user follows this account. Null = unknown, never "no".
     */
    isFollower: (boolean) | null;
    /**
     * This account follows the user.
     */
    isFollowedByAccount?: (boolean) | null;
    followerCount?: (number) | null;
    isVerified?: (boolean) | null;
    username?: (string) | null;
    name?: (string) | null;
    /**
     * Why the follow relationship could not be resolved. Null when it was.
     */
    unavailableReason?: ('consent_required' | 'dm_access_disabled' | 'not_messageable' | 'error') | null;
});
type GetInstagramFollowStatusError = (ErrorResponse | {
    error?: string;
});
type GetTikTokCreatorInfoData = {
    path: {
        /**
         * The TikTok account ID
         */
        accountId: string;
    };
    query?: {
        /**
         * The media type to get creator info for (affects available interaction settings)
         */
        mediaType?: 'video' | 'photo';
    };
};
type GetTikTokCreatorInfoResponse = ({
    creator?: {
        /**
         * Creator display name
         */
        nickname?: string;
        /**
         * Creator avatar URL
         */
        avatarUrl?: string;
        /**
         * Whether the creator is verified
         */
        isVerified?: boolean;
        /**
         * Whether the creator can publish more posts right now
         */
        canPostMore?: boolean;
    };
    /**
     * Available privacy level options for this creator
     */
    privacyLevels?: Array<{
        /**
         * Privacy level value to use when creating posts (e.g. PUBLIC_TO_EVERYONE, MUTUAL_FOLLOW_FRIENDS, FOLLOWER_OF_CREATOR, SELF_ONLY)
         */
        value?: string;
        /**
         * Human-readable label
         */
        label?: string;
    }>;
    postingLimits?: {
        /**
         * Maximum video duration in seconds
         */
        maxVideoDurationSec?: number;
        /**
         * Available interaction toggles (comment, duet, stitch) and their defaults
         */
        interactionSettings?: {
            [key: string]: unknown;
        };
    };
    /**
     * Available commercial content disclosure options
     */
    commercialContentTypes?: Array<{
        value?: string;
        label?: string;
        requires?: Array<(string)>;
    }>;
});
type GetTikTokCreatorInfoError = ({
    error?: string;
});
type VerifyCredentialResponse = ({
    valid?: boolean;
    userId?: string;
    authType?: 'api_key' | 'oauth' | 'session';
    /**
     * Granted OAuth scopes, space-separated. Null for API keys.
     */
    scope?: (string) | null;
});
type VerifyCredentialError = ({
    error?: string;
});
type ListApiKeysResponse = ({
    apiKeys?: Array<ApiKey>;
});
type ListApiKeysError = ({
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
});
type CreateApiKeyData = {
    body: {
        name: string;
        /**
         * Days until expiry
         */
        expiresIn?: number;
        /**
         * 'full' grants access to all profiles (default), 'profiles' restricts to specific profiles
         */
        scope?: 'full' | 'profiles';
        /**
         * Profile IDs this key can access. Required when scope is 'profiles'.
         */
        profileIds?: Array<(string)>;
        /**
         * 'read-write' allows all operations (default), 'read' restricts to GET requests only
         */
        permission?: 'read-write' | 'read';
        /**
         * Resource groups to DISABLE on this key (opt-out denylist). Omit for a legacy full-access key. A key with any group disabled mints with the zrk_ prefix, gets 403 with code=insufficient_permissions and required_group on operations in disabled groups (each operation's group is published as x-resource-group), and can never manage API keys, invites, or member identity. With 'messages' disabled, the key cannot read or send private messages through any API surface and cannot create or edit a webhook subscription broader than itself. Subscriptions that already exist are governed by their own `disabledResourceGroups`, not by this key's. OAuth connector tokens resolve against the same registry, but their groups are not settable yet.
         */
        disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
    };
};
type CreateApiKeyResponse = ({
    message?: string;
    apiKey?: ApiKey;
});
type CreateApiKeyError = (unknown | {
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
});
type DeleteApiKeyData = {
    path: {
        keyId: string;
    };
};
type DeleteApiKeyResponse = ({
    message?: string;
});
type DeleteApiKeyError = ({
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
});
type ListConnectedAppsResponse = ({
    connectedApps?: Array<ConnectedApp>;
});
type ListConnectedAppsError = ({
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
});
type RevokeConnectedAppData = {
    path: {
        /**
         * OAuth client id, as returned by GET /v1/me/connected-apps.
         */
        clientId: string;
    };
};
type RevokeConnectedAppResponse = ({
    revoked?: boolean;
    clientId?: string;
    /**
     * Access and refresh tokens revoked by this call.
     */
    revokedTokens?: number;
    /**
     * Pending authorization codes invalidated by this call.
     */
    invalidatedCodes?: number;
});
type RevokeConnectedAppError = (ErrorResponse | {
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
});
type CreateInviteTokenData = {
    body: {
        /**
         * 'all' grants access to all profiles, 'profiles' restricts to specific profiles
         */
        scope: 'all' | 'profiles';
        /**
         * Required if scope is 'profiles'. Array of profile IDs to grant access to.
         */
        profileIds?: Array<(string)>;
        /**
         * Org role granted to the invitee. Defaults to 'member'. 'admin' can manage the team (invite/remove members, change roles and access) and billing, but not ownership transfer or account deletion. 'billing_admin' (displayed as Billing Manager) manages billing only. 'viewer' creates a read-only member who can view everything in their profile scope but cannot perform any content mutation (publish, edit, delete, connect accounts).
         */
        role?: 'admin' | 'member' | 'billing_admin' | 'viewer';
        /**
         * Deprecated. Use role 'viewer' instead. When true, the invite is created with role 'viewer'. Cannot be combined with role 'billing_admin' or 'admin'.
         * @deprecated
         */
        readOnly?: boolean;
    };
};
type CreateInviteTokenResponse = ({
    token?: string;
    scope?: string;
    invitedProfileIds?: Array<(string)>;
    expiresAt?: string;
    inviteUrl?: string;
});
type CreateInviteTokenError = (unknown | {
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
});
type GetConnectUrlData = {
    path: {
        /**
         * Social media platform to connect
         */
        platform: 'facebook' | 'instagram' | 'linkedin' | 'twitter' | 'tiktok' | 'youtube' | 'threads' | 'reddit' | 'pinterest' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp';
    };
    query: {
        /**
         * When true, the user is redirected to your redirect_url with raw OAuth data (code, state) instead of Zernio's default account selection UI. Use this to build a custom connect experience.
         */
        headless?: boolean;
        /**
         * Instagram only. Which of the two Instagram connection methods to use. Ignored for every other platform.
         *
         * `instagram_login` (the default, and what you get if you omit this): the Instagram Login dialog. The user authorizes their Instagram professional account directly, no Facebook Page required.
         *
         * `facebook_login`: the Facebook Login dialog, i.e. "Instagram API with Facebook Login". The user authorizes a Facebook Page that has a linked Instagram professional account, and every API call for that account then runs through the Page. Use this when the customer manages Instagram through a Page and expects the Facebook consent screen. Because the user has to pick which Page to connect, the callback continues at the account-selection step, `/v1/connect/instagram/select-account`.
         *
         * `facebook_login` supports `headless=true` like the other selection platforms: the callback redirects to your `redirect_url` with `profileId`, `tempToken`, `platform=instagram`, `step=select_account` and `connect_token`, which you pass into the select-account endpoints to finish. The default `instagram_login` has no selection step, so it connects the account directly.
         *
         */
        loginMethod?: 'instagram_login' | 'facebook_login';
        /**
         * WhatsApp only. Ignored for every other platform. Controls which screen Meta's Embedded Signup popup shows.
         *
         * If omitted, the connection defaults to coexistence (same as `business_app` below), preserving existing behavior for numbers already on the WhatsApp Business app.
         *
         * `api`: standard Embedded Signup, showing Meta's WABA/number picker. Use this to connect a phone number already on Cloud API elsewhere.
         *
         * `business_app`: coexistence, i.e. 'Connect existing WhatsApp Business app' (a number shared between Cloud API and the consumer WhatsApp Business app).
         *
         */
        onboarding?: 'api' | 'business_app';
        /**
         * Your Zernio profile ID (get from /v1/profiles). For WhatsApp, a Zernio-provisioned number can only be connected on the profile it was provisioned to; connecting from any other profile is rejected with a 409.
         */
        profileId: string;
        /**
         * Your custom redirect URL after connection completes. Accepts an http(s) URL, a custom app scheme for mobile deeplinks (e.g. myapp://callback), or a relative path. Result params are appended with the URL API, so an existing query string is preserved. Standard mode appends connected={platform}&profileId=X&accountId=Y&username=Z. Headless mode appends OAuth data params for platforms requiring selection (e.g. LinkedIn orgs, Facebook pages). If no selection is needed, the account is created directly and the redirect includes accountId.
         */
        redirect_url?: string;
    };
};
type GetConnectUrlResponse = ({
    /**
     * URL to redirect your user to for OAuth authorization
     */
    authUrl?: string;
    /**
     * State parameter for security (handled automatically)
     */
    state?: string;
});
type GetConnectUrlError = (unknown | {
    error?: string;
} | {
    /**
     * 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';
    /**
     * 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 is
     * the Zernio billing tab. 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;
        /**
         * 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;
    };
});
type HandleOAuthCallbackData = {
    body: {
        code: string;
        state: string;
        profileId: string;
    };
    path: {
        platform: string;
    };
};
type HandleOAuthCallbackResponse = (unknown);
type HandleOAuthCallbackError = (unknown | {
    error?: string;
});
type ConnectAdsData = {
    path: {
        /**
         * Platform to connect ads for. Only platforms with ads support are accepted.
         */
        platform: 'facebook' | 'instagram' | 'linkedin' | 'tiktok' | 'twitter' | 'pinterest' | 'googleads';
    };
    query: {
        /**
         * Existing SocialAccount ID. Required for `twitter` (X Ads). Optional for `tiktok` —
         * omit to enter ads-only mode (no TikTok posting account linked; ad creation uses
         * a Brand Identity instead of a TT_USER). Ignored for same-token (`facebook`,
         * `instagram`, `linkedin`, `pinterest`) and standalone (`googleads`) platforms.
         *
         */
        accountId?: string;
        /**
         * Scope ad sync to a single platform ad account. Without this param,
         * sync covers every ad account the connected token can see. Supported
         * on `facebook`/`instagram` (Meta, `act_<digits>`), `linkedin` (bare
         * numeric sponsored-account id), `googleads` (bare customer id digits)
         * and `twitter` (X Ads, base36 account id). `tiktok` scopes advertisers
         * at OAuth and `pinterest` has no ads discovery, so both ignore it.
         * Meta ids are additionally validated against the connected token;
         * unreachable IDs return 400. Setting a scope also removes already
         * synced ads from de-scoped ad accounts. For multiple accounts use
         * `adAccountIds` instead.
         *
         */
        adAccountId?: string;
        /**
         * Scope ad sync to multiple platform ad accounts (same platform
         * support and id shapes as `adAccountId`). Repeat the param
         * (`?adAccountIds=act_1&adAccountIds=act_2`) or comma-separate
         * (`?adAccountIds=act_1,act_2`). Persisted server-side; latest call
         * wins, and de-scoped ad accounts have their synced ads removed.
         * Omitting both `adAccountId` and `adAccountIds` keeps any previously
         * persisted scope unchanged.
         *
         */
        adAccountIds?: Array<(string)>;
        /**
         * Force a fresh OAuth even when an account already exists. Normally the
         * endpoint returns `alreadyConnected: true` whenever a connected account
         * is found, keying off its active state rather than token liveness.
         * Set `force=true` to bypass that and always receivean `authUrl`.
         * Completing the returned OAuth refreshes the stored token
         * on the existing posting and ads accounts in place.
         *
         */
        force?: boolean;
        /**
         * Enable headless mode (same-token platforms only)
         */
        headless?: boolean;
        /**
         * Your Zernio profile ID
         */
        profileId: string;
        /**
         * Custom redirect URL after OAuth completes (same-token platforms only). Accepts an http(s) URL, a custom app scheme for mobile deeplinks (e.g. myapp://callback), or a relative path.
         */
        redirect_url?: string;
    };
};
type ConnectAdsResponse = (({
    alreadyConnected?: boolean;
    accountId?: string;
    platform?: string;
    username?: string;
    displayName?: string;
    /**
     * Echo of the persisted ad-account scope when the caller passed
     * `adAccountId` / `adAccountIds`. Omitted when no scope is set.
     *
     */
    scopedAdAccountIds?: Array<(string)>;
} | {
    authUrl?: string;
    state?: string;
}));
type ConnectAdsError = (unknown | {
    error?: string;
});
type GetShopifyConnectUrlData = {
    query: {
        /**
         * Your Zernio profile ID (get from /v1/profiles).
         */
        profileId: string;
        /**
         * Your custom redirect URL after connection completes. Accepts an http(s) URL, a custom app scheme for mobile deeplinks (e.g. myapp://callback), or a relative path. On failure an `error` query param is appended.
         */
        redirect_url?: string;
        /**
         * The myshopify.com store domain to connect, e.g. `your-store.myshopify.com` (the bare `your-store` prefix is accepted too).
         */
        shop: string;
    };
};
type GetShopifyConnectUrlResponse = ({
    /**
     * URL to redirect your user to for OAuth authorization
     */
    authUrl?: string;
    /**
     * State parameter for security (handled automatically)
     */
    state?: string;
});
type GetShopifyConnectUrlError = (unknown | {
    error?: string;
} | {
    /**
     * 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';
    /**
     * 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 is
     * the Zernio billing tab. 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;
        /**
         * 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;
    };
});
type ConnectShopifyWithTokenData = {
    body: {
        /**
         * Your Zernio profile ID (get from /v1/profiles).
         */
        profileId: string;
        /**
         * The myshopify.com store domain, e.g. `your-store.myshopify.com` (the bare `your-store` prefix is accepted too).
         */
        shop: string;
        /**
         * Admin API access token of the merchant-created custom app (starts with `shpat_`).
         */
        accessToken: string;
    };
};
type ConnectShopifyWithTokenResponse = ({
    account?: {
        _id?: string;
        platform?: 'shopify';
        /**
         * The myshopify.com domain of the connected store.
         */
        username?: string;
        displayName?: string;
        profileId?: string;
    };
});
type ConnectShopifyWithTokenError = (unknown | {
    error?: string;
} | {
    /**
     * 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';
    /**
     * 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 is
     * the Zernio billing tab. 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;
        /**
         * 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;
    };
});
type ConfigureTikTokAdsBrandIdentityData = {
    body: {
        /**
         * SocialAccount ID of the `tiktokads` account.
         */
        accountId: string;
        /**
         * Brand name shown above the ad on TikTok.
         */
        displayName: string;
        /**
         * Public URL of a square brand image (≥98×98 px, JPG/PNG, max 5 MB). Used as the brand avatar on the ad.
         */
        imageUrl: string;
    };
};
type ConfigureTikTokAdsBrandIdentityResponse = ({
    success?: boolean;
    /**
     * The TikTok-assigned identity_id, cached on the account.
     */
    identityId?: string;
    displayName?: string;
});
type ConfigureTikTokAdsBrandIdentityError = (unknown | {
    error?: string;
});
type ListFacebookPagesData = {
    query: {
        /**
         * Profile ID from your connection flow
         */
        profileId: string;
        /**
         * Temporary Facebook access token from the OAuth callback redirect
         */
        tempToken: string;
    };
};
type ListFacebookPagesResponse = ({
    pages?: Array<{
        /**
         * Facebook Page ID
         */
        id?: string;
        /**
         * Page name
         */
        name?: string;
        /**
         * Page username/handle (may be null)
         */
        username?: string;
        /**
         * Page-specific access token
         */
        access_token?: string;
        /**
         * Page category
         */
        category?: string;
        /**
         * User permissions for this page
         */
        tasks?: Array<(string)>;
    }>;
});
type ListFacebookPagesError = (unknown | {
    error?: string;
});
type SelectFacebookPageData = {
    body: {
        /**
         * Profile ID from your connection flow
         */
        profileId: string;
        /**
         * The Facebook Page ID selected by the user
         */
        pageId: string;
        /**
         * Temporary Facebook access token from OAuth
         */
        tempToken: string;
        /**
         * Decoded user profile object from the OAuth callback
         */
        userProfile: {
            id?: string;
            name?: string;
            profilePicture?: string;
        };
        /**
         * Optional custom redirect URL to return to after selection
         */
        redirect_url?: string;
    };
};
type SelectFacebookPageResponse = ({
    message?: string;
    /**
     * Redirect URL if custom redirect_url was provided
     */
    redirect_url?: string;
    account?: {
        /**
         * ID of the created SocialAccount
         */
        accountId?: string;
        platform?: 'facebook';
        username?: string;
        displayName?: string;
        profilePicture?: string;
        isActive?: boolean;
        selectedPageName?: string;
    };
});
type SelectFacebookPageError = (unknown | {
    error?: string;
} | {
    error?: string;
    code?: 'RECONNECT_ACCOUNT_MISMATCH';
});
type ListInstagramPagesData = {
    query: {
        /**
         * Profile ID from your connection flow
         */
        profileId: string;
        /**
         * Long-lived Facebook user access token from the OAuth callback redirect
         */
        tempToken: string;
    };
};
type ListInstagramPagesResponse = ({
    pages?: Array<{
        /**
         * Facebook Page ID
         */
        id?: string;
        /**
         * Page name
         */
        name?: string;
        /**
         * Page-specific access token
         */
        access_token?: string;
        /**
         * The Instagram professional account linked to this Page
         */
        instagram_business_account?: {
            /**
             * Instagram Business Account ID
             */
            id?: string;
            username?: string;
            profile_picture_url?: string;
        };
    }>;
});
type ListInstagramPagesError = (unknown | {
    error?: string;
});
type SelectInstagramAccountData = {
    body: {
        /**
         * Profile ID from your connection flow
         */
        profileId: string;
        /**
         * The Facebook Page ID selected by the user, from GET /v1/connect/instagram/select-account
         */
        pageId: string;
        /**
         * Long-lived Facebook user access token from the OAuth callback redirect
         */
        tempToken: string;
        /**
         * Optional custom redirect URL to return to after selection
         */
        redirect_url?: string;
    };
};
type SelectInstagramAccountResponse = ({
    message?: string;
    /**
     * Redirect URL if a custom redirect_url was provided
     */
    redirect_url?: string;
    account?: {
        /**
         * ID of the created SocialAccount
         */
        accountId?: string;
        platform?: 'instagram';
        username?: string;
        /**
         * Name of the Facebook Page backing this account
         */
        displayName?: string;
        profilePicture?: string;
        isActive?: boolean;
        loginMethod?: 'facebook_login';
    };
});
type SelectInstagramAccountError = (unknown | {
    error?: string;
} | {
    /**
     * 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';
    /**
     * 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 is
     * the Zernio billing tab. 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;
        /**
         * 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;
    };
});
type ListGoogleBusinessLocationsData = {
    query?: {
        /**
         * Raw Google Business Information API filter expression (advanced; takes precedence over search). Supports fields such as title, storeCode, storefront_address.postal_code, labels and categories, e.g. storeCode="LH279411". See Google's "Work with location data" guide.
         *
         */
        filter?: string;
        /**
         * Token from the OAuth callback redirect. Preferred over tempToken because it preserves server-side token storage. One of pendingDataToken or tempToken is required.
         */
        pendingDataToken?: string;
        /**
         * Profile ID from your connection flow. Required for auth validation when provided.
         */
        profileId?: string;
        /**
         * Free-text search on the business name, applied server-side by Google. Use this for accounts that own many locations (the response is bounded, see hasMore) so the user can find a specific location without loading the full list.
         *
         */
        search?: string;
        /**
         * Legacy. Direct Google access token. Use pendingDataToken instead when available.
         */
        tempToken?: string;
    };
};
type ListGoogleBusinessLocationsResponse = ({
    locations?: Array<{
        /**
         * Location ID
         */
        id?: string;
        /**
         * Business name
         */
        name?: string;
        /**
         * Google Business Account ID
         */
        accountId?: string;
        /**
         * Account name
         */
        accountName?: string;
        /**
         * Business address
         */
        address?: string;
        /**
         * Business category
         */
        category?: string;
        /**
         * Store code set on the location in Google Business Profile (if any)
         */
        storeCode?: string;
    }>;
    /**
     * True when more locations exist than were returned (the list is bounded). Prompt the user to narrow the result set with search.
     *
     */
    hasMore?: boolean;
});
type ListGoogleBusinessLocationsError = (unknown | {
    error?: string;
});
type SelectGoogleBusinessLocationData = {
    body: {
        /**
         * Profile ID from your connection flow
         */
        profileId: string;
        /**
         * The Google Business location ID selected by the user
         */
        locationId: string;
        /**
         * Optional but recommended. The Google Business Account resource name ("accounts/123") that owns the selected location (returned per-location by GET /v1/connect/googlebusiness/locations). When provided, the location is resolved directly instead of by enumerating the account, which is required for accounts that own many locations. Omit only for small accounts.
         *
         */
        accountId?: string;
        /**
         * Token from the OAuth callback redirect (pendingDataToken query param). Tokens and profile data are retrieved server-side from this token.
         */
        pendingDataToken: string;
        /**
         * Optional custom redirect URL to return to after selection
         */
        redirect_url?: string;
    };
};
type SelectGoogleBusinessLocationResponse = ({
    message?: string;
    /**
     * Redirect URL if custom redirect_url was provided
     */
    redirect_url?: string;
    account?: {
        /**
         * ID of the created SocialAccount
         */
        accountId?: string;
        platform?: 'googlebusiness';
        username?: string;
        displayName?: string;
        isActive?: boolean;
        /**
         * Human-readable location display name, NOT a resource name. Do not use it to build API paths.
         */
        selectedLocationName?: string;
        /**
         * Bare GBP location id. Combine with the GBP account id as accounts/{gbpAccountId}/locations/{selectedLocationId} to form the location resource names that gmb-reviews/batch expects in locationNames.
         */
        selectedLocationId?: string;
    };
});
type SelectGoogleBusinessLocationError = (unknown | {
    error?: string;
});
type GetGoogleBusinessReviewsData = {
    path: {
        /**
         * The Zernio account ID (from /v1/accounts)
         */
        accountId: string;
    };
    query?: {
        /**
         * Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
        /**
         * Number of reviews to fetch per page (max 50)
         */
        pageSize?: number;
        /**
         * Pagination token from previous response
         */
        pageToken?: string;
    };
};
type GetGoogleBusinessReviewsResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    reviews?: Array<{
        /**
         * Review ID
         */
        id?: string;
        /**
         * Full resource name
         */
        name?: string;
        reviewer?: {
            displayName?: string;
            profilePhotoUrl?: (string) | null;
            isAnonymous?: boolean;
        };
        /**
         * Numeric star rating
         */
        rating?: number;
        /**
         * Google's string rating
         */
        starRating?: 'ONE' | 'TWO' | 'THREE' | 'FOUR' | 'FIVE';
        /**
         * Review text
         */
        comment?: string;
        createTime?: string;
        updateTime?: string;
        reviewReply?: {
            /**
             * Business owner reply
             */
            comment?: string;
            updateTime?: string;
        } | null;
        /**
         * Number of photos attached to the review (photos only, videos are not counted)
         */
        photoCount?: number;
        /**
         * Photos attached to the review by the reviewer
         */
        photos?: Array<{
            url?: string;
        }>;
    }>;
    /**
     * Overall average rating
     */
    averageRating?: number;
    /**
     * Total number of reviews
     */
    totalReviewCount?: number;
    /**
     * Token for next page
     */
    nextPageToken?: (string) | null;
});
type GetGoogleBusinessReviewsError = (ErrorResponse | {
    error?: string;
});
type GetGoogleBusinessVerificationsData = {
    path: {
        /**
         * The Zernio account ID (from /v1/accounts)
         */
        accountId: string;
    };
    query?: {
        /**
         * Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
    };
};
type GetGoogleBusinessVerificationsResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    /**
     * Raw Voice of Merchant state from Google.
     */
    voiceOfMerchantState?: {
        /**
         * True when the listing is verified and published (eligible to surface reviews, edits, etc.).
         */
        hasVoiceOfMerchant?: boolean;
        /**
         * True when the authenticated user has owner/manager authority over the listing.
         */
        hasBusinessAuthority?: boolean;
        /**
         * Present when verification is the path to Voice of Merchant.
         */
        verify?: {
            /**
             * True when a verification is already in progress.
             */
            hasPendingVerification?: boolean;
        };
    };
    /**
     * Verification history, newest first. Empty when none exist.
     */
    verifications?: Array<{
        /**
         * Resource name, e.g. "locations/123/verifications/0T1776879124712". The last segment is the verificationId.
         */
        name?: string;
        /**
         * Method used (omitted on some entries).
         */
        method?: 'ADDRESS' | 'EMAIL' | 'PHONE_CALL' | 'SMS' | 'AUTO' | 'VETTED_PARTNER';
        state?: 'PENDING' | 'COMPLETED' | 'FAILED';
        createTime?: string;
    }>;
});
type GetGoogleBusinessVerificationsError = (ErrorResponse | {
    error?: string;
});
type StartGoogleBusinessVerificationData = {
    body: {
        /**
         * The verification method. Selects which method-specific field below is required.
         */
        method: 'ADDRESS' | 'EMAIL' | 'PHONE_CALL' | 'SMS' | 'AUTO' | 'VETTED_PARTNER';
        languageCode?: string;
        /**
         * For PHONE_CALL / SMS.
         */
        phoneNumber?: string;
        /**
         * For EMAIL.
         */
        emailAddress?: string;
        /**
         * For ADDRESS (postcard) verification.
         */
        mailerContact?: {
            [key: string]: unknown;
        };
        /**
         * ServiceBusinessContext (e.g. service address). Required for service-area businesses.
         */
        context?: {
            [key: string]: unknown;
        };
    };
    path: {
        /**
         * The Zernio account ID (from /v1/accounts)
         */
        accountId: string;
    };
    query?: {
        /**
         * Override which location to target. If omitted, uses the account's selected location.
         */
        locationId?: string;
    };
};
type StartGoogleBusinessVerificationResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    verification?: {
        name?: string;
        method?: 'ADDRESS' | 'EMAIL' | 'PHONE_CALL' | 'SMS' | 'AUTO' | 'VETTED_PARTNER';
        state?: 'PENDING' | 'COMPLETED' | 'FAILED';
        createTime?: string;
    };
});
type StartGoogleBusinessVerificationError = (ErrorResponse | {
    error?: string;
});
type FetchGoogleBusinessVerificationOptionsData = {
    body: {
        languageCode: string;
        /**
         * ServiceBusinessContext. Required for service-area businesses (must include the service address).
         */
        context?: {
            [key: string]: unknown;
        };
    };
    path: {
        /**
         * The Zernio account ID (from /v1/accounts)
         */
        accountId: string;
    };
    query?: {
        /**
         * Override which location to query. If omitted, uses the account's selected location.
         */
        locationId?: string;
    };
};
type FetchGoogleBusinessVerificationOptionsResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    options?: Array<{
        verificationMethod?: 'ADDRESS' | 'EMAIL' | 'PHONE_CALL' | 'SMS' | 'AUTO' | 'VETTED_PARTNER';
        /**
         * Present for PHONE_CALL / SMS.
         */
        phoneNumber?: string;
    }>;
});
type FetchGoogleBusinessVerificationOptionsError = (ErrorResponse | {
    error?: string;
});
type CompleteGoogleBusinessVerificationData = {
    body: {
        /**
         * The code Google sent to the business.
         */
        pin: string;
    };
    path: {
        /**
         * The Zernio account ID (from /v1/accounts)
         */
        accountId: string;
        /**
         * The last segment of a verification `name` from GET /gmb-verifications.
         */
        verificationId: string;
    };
    query?: {
        /**
         * Override which location to target. If omitted, uses the account's selected location.
         */
        locationId?: string;
    };
};
type CompleteGoogleBusinessVerificationResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    verification?: {
        name?: string;
        method?: 'ADDRESS' | 'EMAIL' | 'PHONE_CALL' | 'SMS' | 'AUTO' | 'VETTED_PARTNER';
        state?: 'PENDING' | 'COMPLETED' | 'FAILED';
        createTime?: string;
    };
});
type CompleteGoogleBusinessVerificationError = (ErrorResponse | {
    error?: string;
});
type GetGoogleBusinessFoodMenusData = {
    path: {
        /**
         * The Zernio account ID (from /v1/accounts)
         */
        accountId: string;
    };
    query?: {
        /**
         * Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
    };
};
type GetGoogleBusinessFoodMenusResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    /**
     * Resource name of the food menus
     */
    name?: string;
    menus?: Array<FoodMenu>;
});
type GetGoogleBusinessFoodMenusError = (ErrorResponse | {
    error?: string;
});
type UpdateGoogleBusinessFoodMenusData = {
    body: {
        /**
         * Array of food menus to set
         */
        menus: Array<FoodMenu>;
        /**
         * Field mask for partial updates (e.g. "menus")
         */
        updateMask?: string;
    };
    path: {
        /**
         * The Zernio account ID (from /v1/accounts)
         */
        accountId: string;
    };
    query?: {
        /**
         * Override which location to target. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
    };
};
type UpdateGoogleBusinessFoodMenusResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    name?: string;
    menus?: Array<FoodMenu>;
});
type UpdateGoogleBusinessFoodMenusError = (ErrorResponse | {
    error?: string;
});
type GetGoogleBusinessLocationDetailsData = {
    path: {
        /**
         * The Zernio account ID (from /v1/accounts)
         */
        accountId: string;
    };
    query?: {
        /**
         * Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
        /**
         * Comma-separated fields to return. Available: name, title, phoneNumbers, categories, storefrontAddress, websiteUri, regularHours, specialHours, serviceArea, serviceItems, profile, openInfo, metadata, moreHours.
         * `title` and `metadata` are always included in the response so the `location` summary block can be populated, even if you omit them here.
         * Note: `location` is a derived response field, not a Google readMask value, passing it returns 400.
         *
         */
        readMask?: string;
    };
};
type GetGoogleBusinessLocationDetailsResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    /**
     * Compact public-facing summary derived from Google's `metadata`. Useful
     * for surfacing the "leave a review" URL (e.g. behind a QR code) without
     * parsing the raw block. Always populated regardless of readMask.
     * For unverified or new locations Google omits placeId/reviewUrl/mapsUri,
     * so those return as null and `isVerified` is false.
     *
     */
    location?: {
        /**
         * Business name as set in GBP
         */
        name?: (string) | null;
        /**
         * Google Maps Place ID for this location
         */
        placeId?: (string) | null;
        /**
         * Public "write a review" URL Google generates for this place
         */
        reviewUrl?: (string) | null;
        /**
         * Public Google Maps URL for this location
         */
        mapsUri?: (string) | null;
        /**
         * True when the location has Voice of Merchant (verified + live on Google)
         */
        isVerified?: boolean;
    } | null;
    /**
     * Business name
     */
    title?: string;
    regularHours?: {
        periods?: Array<{
            openDay?: 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
            /**
             * Opening time in HH:MM format
             */
            openTime?: string;
            closeDay?: string;
            closeTime?: string;
        }>;
    };
    specialHours?: {
        specialHourPeriods?: Array<{
            startDate?: {
                year?: number;
                month?: number;
                day?: number;
            };
            endDate?: {
                year?: number;
                month?: number;
                day?: number;
            };
            openTime?: string;
            closeTime?: string;
            closed?: boolean;
        }>;
    };
    profile?: {
        /**
         * Business description
         */
        description?: string;
    };
    websiteUri?: string;
    phoneNumbers?: {
        primaryPhone?: string;
        additionalPhones?: Array<(string)>;
    };
    /**
     * Business categories (returned when readMask includes 'categories')
     */
    categories?: {
        primaryCategory?: {
            /**
             * Category resource name
             */
            name?: string;
            /**
             * Human-readable category name
             */
            displayName?: string;
        };
        additionalCategories?: Array<{
            name?: string;
            displayName?: string;
        }>;
    };
    /**
     * Services offered (returned when readMask includes 'serviceItems')
     */
    serviceItems?: Array<{
        structuredServiceItem?: {
            serviceTypeId?: string;
            description?: string;
        };
        freeFormServiceItem?: {
            category?: string;
            label?: {
                displayName?: string;
                languageCode?: string;
            };
        };
        price?: {
            currencyCode?: string;
            units?: string;
            nanos?: number;
        };
    }>;
});
type GetGoogleBusinessLocationDetailsError = (ErrorResponse | {
    error?: string;
});
type UpdateGoogleBusinessLocationDetailsData = {
    body: {
        /**
         * Required. Comma-separated fields to update (e.g. 'regularHours', 'specialHours', 'profile.description', 'categories', 'serviceItems'). Any valid Google Business Information API updateMask field is supported.
         */
        updateMask: string;
        regularHours?: {
            periods?: Array<{
                openDay?: string;
                openTime?: string;
                closeDay?: string;
                closeTime?: string;
            }>;
        };
        specialHours?: {
            specialHourPeriods?: Array<{
                startDate?: {
                    year?: number;
                    month?: number;
                    day?: number;
                };
                endDate?: {
                    year?: number;
                    month?: number;
                    day?: number;
                };
                openTime?: string;
                closeTime?: string;
                closed?: boolean;
            }>;
        };
        profile?: {
            description?: string;
        };
        websiteUri?: string;
        phoneNumbers?: {
            primaryPhone?: string;
            additionalPhones?: Array<(string)>;
        };
        /**
         * Primary and additional business categories. Use updateMask='categories' to update.
         */
        categories?: {
            primaryCategory?: {
                /**
                 * Category resource name (e.g. 'categories/gcid:laundromat'). Use Google's Categories API to look up valid IDs.
                 */
                name?: string;
            };
            additionalCategories?: Array<{
                /**
                 * Category resource name (e.g. 'categories/gcid:dry_cleaner')
                 */
                name?: string;
            }>;
        };
        /**
         * Services offered by the business. Use updateMask='serviceItems' to update.
         */
        serviceItems?: Array<{
            /**
             * A predefined service from Google's service type catalog
             */
            structuredServiceItem?: {
                /**
                 * Service type ID from Google's catalog (e.g. 'job_type_id:plumbing_drain_repair')
                 */
                serviceTypeId?: string;
                /**
                 * Optional description of the service
                 */
                description?: string;
            };
            /**
             * A custom service not in Google's catalog
             */
            freeFormServiceItem?: {
                /**
                 * Category resource name this service belongs to (e.g. 'categories/gcid:laundromat')
                 */
                category?: string;
                label?: {
                    /**
                     * Service name as displayed to users
                     */
                    displayName?: string;
                    /**
                     * Language code (e.g. 'en')
                     */
                    languageCode?: string;
                };
            };
            /**
             * Optional price for the service
             */
            price?: {
                /**
                 * ISO 4217 currency code (e.g. 'USD')
                 */
                currencyCode?: string;
                /**
                 * Whole units of the amount
                 */
                units?: string;
                /**
                 * Nano units (10^-9) of the amount
                 */
                nanos?: number;
            };
        }>;
    };
    path: {
        /**
         * The Zernio account ID (from /v1/accounts)
         */
        accountId: string;
    };
    query?: {
        /**
         * Override which location to target. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
    };
};
type UpdateGoogleBusinessLocationDetailsResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
});
type UpdateGoogleBusinessLocationDetailsError = (ErrorResponse | {
    error?: string;
});
type ListGoogleBusinessMediaData = {
    path: {
        accountId: string;
    };
    query?: {
        /**
         * Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
        /**
         * Number of items to return (max 100)
         */
        pageSize?: number;
        /**
         * Pagination token from previous response
         */
        pageToken?: string;
    };
};
type ListGoogleBusinessMediaResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    mediaItems?: Array<{
        /**
         * Resource name
         */
        name?: string;
        mediaFormat?: 'PHOTO' | 'VIDEO';
        sourceUrl?: string;
        /**
         * Google-hosted URL
         */
        googleUrl?: string;
        thumbnailUrl?: string;
        description?: string;
        createTime?: string;
        locationAssociation?: {
            category?: string;
        };
    }>;
    nextPageToken?: string;
    totalMediaItemsCount?: number;
});
type ListGoogleBusinessMediaError = (ErrorResponse);
type CreateGoogleBusinessMediaData = {
    body: {
        /**
         * Publicly accessible image URL
         */
        sourceUrl: string;
        mediaFormat?: 'PHOTO' | 'VIDEO';
        /**
         * Photo description
         */
        description?: string;
        /**
         * Where the photo appears on the listing
         */
        category?: 'CATEGORY_UNSPECIFIED' | 'COVER' | 'PROFILE' | 'LOGO' | 'EXTERIOR' | 'INTERIOR' | 'PRODUCT' | 'FOOD_AND_DRINK' | 'MENU' | 'COMMON_AREA' | 'ROOMS' | 'TEAMS' | 'AT_WORK' | 'ADDITIONAL';
    };
    path: {
        accountId: string;
    };
    query?: {
        /**
         * Override which location to target. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
    };
};
type CreateGoogleBusinessMediaResponse = ({
    success?: boolean;
    name?: string;
    mediaFormat?: string;
    googleUrl?: string;
});
type CreateGoogleBusinessMediaError = (ErrorResponse);
type DeleteGoogleBusinessMediaData = {
    path: {
        accountId: string;
    };
    query: {
        /**
         * Override which location to target. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
        /**
         * The media item ID to delete
         */
        mediaId: string;
    };
};
type DeleteGoogleBusinessMediaResponse = ({
    success?: boolean;
    deleted?: boolean;
    mediaId?: string;
});
type DeleteGoogleBusinessMediaError = (ErrorResponse);
type GetGmbAttributeMetadataData = {
    path: {
        accountId: string;
    };
    query?: {
        /**
         * Category resource name, must start with "categories/" (e.g. "categories/gcid:plumber"). Required together with regionCode. Mutually exclusive with locationId.
         *
         */
        categoryName?: string;
        /**
         * BCP-47 language code for display names (e.g. "en", "es"). Optional when categoryName is provided. Omitted from the Google call when not supplied.
         *
         */
        languageCode?: string;
        /**
         * GBP location ID (e.g. "6257659026299438786"). If omitted, uses the account's stored selectedLocationId. Mutually exclusive with categoryName.
         *
         */
        locationId?: string;
        /**
         * Maximum number of attribute metadata items to return. Google defaults to 200.
         */
        pageSize?: number;
        /**
         * Pagination token from a previous response's nextPageToken field.
         */
        pageToken?: string;
        /**
         * BCP-47 region code (e.g. "US", "ES"). Required when categoryName is provided.
         *
         */
        regionCode?: string;
    };
};
type GetGmbAttributeMetadataResponse = ({
    success?: boolean;
    accountId?: string;
    /**
     * Only present in location mode.
     */
    locationId?: string;
    attributeMetadata?: Array<{
        /**
         * Resource name of the attribute (e.g. "attributes/has_delivery").
         */
        parent?: string;
        /**
         * Value type (e.g. BOOL, ENUM, URL, REPEATED_ENUM).
         */
        valueType?: string;
        /**
         * Localized human-readable attribute name.
         */
        displayName?: string;
        /**
         * Display name of the attribute group.
         */
        groupDisplayName?: string;
        /**
         * True if multiple values can be set simultaneously.
         */
        repeatable?: boolean;
        /**
         * True if this attribute should no longer be used.
         */
        deprecated?: boolean;
        /**
         * Possible enum values (for ENUM / REPEATED_ENUM types).
         */
        valueMetadata?: Array<{
            value?: string;
            displayName?: string;
        }>;
    }>;
    /**
     * Present when additional pages of results are available.
     */
    nextPageToken?: string;
});
type GetGmbAttributeMetadataError = (ErrorResponse);
type GetGoogleBusinessAttributesData = {
    path: {
        accountId: string;
    };
    query?: {
        /**
         * Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
    };
};
type GetGoogleBusinessAttributesResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    attributes?: Array<{
        /**
         * Attribute identifier (e.g. has_delivery)
         */
        name?: string;
        /**
         * Value type (BOOL, ENUM, URL, REPEATED_ENUM)
         */
        valueType?: string;
        values?: Array<unknown>;
        repeatedEnumValue?: {
            setValues?: Array<(string)>;
            unsetValues?: Array<(string)>;
        };
    }>;
});
type GetGoogleBusinessAttributesError = (ErrorResponse);
type UpdateGoogleBusinessAttributesData = {
    body: {
        attributes: Array<{
            name: string;
            valueType?: 'ATTRIBUTE_VALUE_TYPE_UNSPECIFIED' | 'BOOL' | 'ENUM' | 'URL' | 'REPEATED_ENUM';
            values?: Array<unknown>;
            repeatedEnumValue?: {
                setValues?: Array<(string)>;
                unsetValues?: Array<(string)>;
            };
            uriValues?: Array<{
                uri: string;
            }>;
        }>;
        /**
         * Comma-separated attribute names to update (e.g. 'has_delivery,has_takeout')
         */
        attributeMask: string;
    };
    path: {
        accountId: string;
    };
    query?: {
        /**
         * Override which location to target. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
    };
};
type UpdateGoogleBusinessAttributesResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    attributes?: Array<{
        [key: string]: unknown;
    }>;
});
type UpdateGoogleBusinessAttributesError = (ErrorResponse);
type ListGoogleBusinessPlaceActionsData = {
    path: {
        accountId: string;
    };
    query?: {
        /**
         * Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
        pageSize?: number;
        pageToken?: string;
    };
};
type ListGoogleBusinessPlaceActionsResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    placeActionLinks?: Array<{
        /**
         * Resource name
         */
        name?: string;
        /**
         * Action URL
         */
        uri?: string;
        placeActionType?: string;
        createTime?: string;
        updateTime?: string;
    }>;
    nextPageToken?: string;
});
type ListGoogleBusinessPlaceActionsError = (ErrorResponse);
type CreateGoogleBusinessPlaceActionData = {
    body: {
        /**
         * The action URL
         */
        uri: string;
        /**
         * Type of action
         */
        placeActionType: 'APPOINTMENT' | 'ONLINE_APPOINTMENT' | 'DINING_RESERVATION' | 'FOOD_ORDERING' | 'FOOD_DELIVERY' | 'FOOD_TAKEOUT' | 'SHOP_ONLINE';
    };
    path: {
        accountId: string;
    };
    query?: {
        /**
         * Override which location to target. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
    };
};
type CreateGoogleBusinessPlaceActionResponse = ({
    success?: boolean;
    /**
     * Resource name of the created link
     */
    name?: string;
    uri?: string;
    placeActionType?: string;
});
type CreateGoogleBusinessPlaceActionError = (ErrorResponse);
type DeleteGoogleBusinessPlaceActionData = {
    path: {
        accountId: string;
    };
    query: {
        /**
         * Override which location to target. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
         */
        locationId?: string;
        /**
         * The resource name of the place action link (e.g. locations/123/placeActionLinks/456)
         */
        name: string;
    };
};
type DeleteGoogleBusinessPlaceActionResponse = ({
    success?: boolean;
    deleted?: boolean;
    name?: string;
});
type DeleteGoogleBusinessPlaceActionError = (ErrorResponse);
type UpdateGoogleBusinessPlaceActionData = {
    body: {
        /**
         * Resource name of the place action link (e.g. locations/123/placeActionLinks/456)
         */
        name: string;
        /**
         * New action URL. At least one of uri or placeActionType is required (enforced server-side; not modeled as anyOf because required-only anyOf branches break SDK generators).
         */
        uri?: string;
        /**
         * New action type
         */
        placeActionType?: 'APPOINTMENT' | 'ONLINE_APPOINTMENT' | 'DINING_RESERVATION' | 'FOOD_ORDERING' | 'FOOD_DELIVERY' | 'FOOD_TAKEOUT' | 'SHOP_ONLINE';
    };
    path: {
        accountId: string;
    };
    query?: {
        /**
         * Override which location to target. If omitted, uses the account's selected location.
         */
        locationId?: string;
    };
};
type UpdateGoogleBusinessPlaceActionResponse = ({
    success?: boolean;
    name?: string;
    uri?: string;
    placeActionType?: string;
});
type UpdateGoogleBusinessPlaceActionError = (ErrorResponse);
type GetGoogleBusinessServicesData = {
    path: {
        accountId: string;
    };
    query?: {
        /**
         * Override which location to query. If omitted, uses the account's selected location.
         */
        locationId?: string;
    };
};
type GetGoogleBusinessServicesResponse = ({
    success?: boolean;
    accountId?: string;
    locationId?: string;
    services?: Array<{
        structuredServiceItem?: {
            serviceTypeId?: string;
            description?: string;
        };
        freeFormServiceItem?: {
            category?: string;
            label?: {
                displayName?: string;
                description?: string;
            };
        };
        price?: {
            currencyCode?: string;
            units?: string;
            nanos?: number;
        };
    }>;
});
type GetGoogleBusinessServicesError = (ErrorResponse);
type UpdateGoogleBusinessServicesData = {
    body: {
        serviceItems: Array<{
            /**
             * Exactly one of structuredServiceItem or freeFormServiceItem is required per item (enforced server-side; not modeled as oneOf because required-only oneOf branches break SDK generators).
             */
            structuredServiceItem?: {
                serviceTypeId: string;
                description?: string;
            };
            freeFormServiceItem?: {
                category: string;
                label: {
                    displayName: string;
                    description?: string;
                    languageCode?: string;
                };
            };
            price?: {
                currencyCode?: string;
                units?: string;
                nanos?: number;
            };
        }>;
    };
    path: {
        accountId: string;
    };
    query?: {
        /**
         * Override which location to target. If omitted, uses the account's selected location.
         */
        locationId?: string;
    };
};
type UpdateGoogleBusinessServicesResponse = ({
    success?: boolean;
    services?: Array<{
        [key: string]: unknown;
    }>;
});
type UpdateGoogleBusinessServicesError = (ErrorResponse);
type BatchGetGoogleBusinessReviewsData = {
    body: {
        /**
         * Array of full location resource names (e.g. ['accounts/123/locations/456']). Max 50 per request (Google's batchGetReviews cap); chunk larger sets into multiple requests.
         */
        locationNames: Array<(string)>;
        /**
         * Number of reviews per page (max 50)
         */
        pageSize?: number;
        /**
         * Pagination token from previous response
         */
        pageToken?: string;
        /**
         * Sort order requested from Google. Defaults to 'updateTime desc' (newest first), which allows early-stopping pagination once results cross your date window.
         */
        orderBy?: 'updateTime desc' | 'rating' | 'rating desc';
    };
    path: {
        accountId: string;
    };
};
type BatchGetGoogleBusinessReviewsResponse = ({
    success?: boolean;
    accountId?: string;
    locationReviews?: Array<{
        /**
         * LOCATION resource name the review belongs to (accounts/{accountId}/locations/{locationId}) - NOT the review resource name. Use it to attribute the review to a location; the review identity is review.reviewId (full review resource name at review.name).
         */
        name?: string;
        /**
         * The review object: reviewId (the review's identity), name (full review resource name, accounts*locations*reviews*), starRating, comment, reviewer, createTime, updateTime, reviewReply, and reviewMediaItems (review photos/videos; photo items carry thumbnailUrl, video items carry videoUrl)
         */
        review?: {
            [key: string]: unknown;
        };
    }>;
    nextPageToken?: string;
});
type BatchGetGoogleBusinessReviewsError = (ErrorResponse);
type ReplyToGoogleBusinessReviewData = {
    body: {
        /**
         * The reply text to post on the review. Must be non-empty.
         */
        comment: string;
    };
    path: {
        /**
         * The Zernio account ID (from /v1/accounts)
         */
        accountId: string;
        /**
         * The review ID portion (e.g. "AIe9_BGx1234567890"), not the full resource name
         */
        reviewId: string;
    };
};
type ReplyToGoogleBusinessReviewResponse = ({
    success?: boolean;
    reviewId?: string;
    platform?: string;
});
type ReplyToGoogleBusinessReviewError = (ErrorResponse | {
    error?: string;
});
type DeleteGoogleBusinessReviewReplyData = {
    path: {
        /**
         * The Zernio account ID (from /v1/accounts)
         */
        accountId: string;
        /**
         * The review ID portion (e.g. "AIe9_BGx1234567890"), not the full resource name
         */
        reviewId: string;
    };
};
type DeleteGoogleBusinessReviewReplyResponse = ({
    success?: boolean;
    message?: string;
    platform?: string;
});
type DeleteGoogleBusinessReviewReplyError = (ErrorResponse | {
    error?: string;
});
type GetPendingOAuthDataData = {
    query: {
        /**
         * The pending data token from the OAuth redirect URL (pendingDataToken parameter)
         */
        token: string;
    };
};
type GetPendingOAuthDataResponse = ({
    /**
     * The platform (e.g., "linkedin")
     */
    platform?: string;
    /**
     * The Zernio profile ID
     */
    profileId?: string;
    /**
     * Temporary access token for the platform
     */
    tempToken?: string;
    /**
     * Refresh token (if available)
     */
    refreshToken?: string;
    /**
     * Token expiry in seconds
     */
    expiresIn?: number;
    /**
     * User profile data (id, username, displayName, profilePicture)
     */
    userProfile?: {
        [key: string]: unknown;
    };
    /**
     * Type of selection data
     */
    selectionType?: 'organizations' | 'pages' | 'boards' | 'locations' | 'profiles';
    /**
     * LinkedIn organizations (when selectionType is "organizations")
     */
    organizations?: Array<{
        id?: string;
        urn?: string;
        name?: string;
        vanityName?: string;
    }>;
});
type GetPendingOAuthDataError = (ErrorResponse);
type ListLinkedInOrganizationsData = {
    query: {
        /**
         * Comma-separated list of organization IDs to fetch details for (max 100)
         */
        orgIds: string;
        /**
         * The temporary LinkedIn access token from the OAuth redirect
         */
        tempToken: string;
    };
};
type ListLinkedInOrganizationsResponse = ({
    organizations?: Array<{
        /**
         * Organization ID
         */
        id?: string;
        /**
         * Logo URL (may be absent if no logo)
         */
        logoUrl?: string;
        /**
         * Organization's vanity name/slug
         */
        vanityName?: string;
        /**
         * Organization's website URL
         */
        website?: string;
        /**
         * Organization's primary industry
         */
        industry?: string;
        /**
         * Organization's description
         */
        description?: string;
    }>;
});
type ListLinkedInOrganizationsError = ({
    error?: string;
} | unknown);
type SelectLinkedInOrganizationData = {
    body: {
        profileId: string;
        tempToken: string;
        userProfile: {
            [key: string]: unknown;
        };
        accountType: 'personal' | 'organization';
        selectedOrganization?: {
            id: string;
            urn: string;
            name: string;
            logoUrl?: string;
            vanityName?: string;
        };
        redirect_url?: string;
    };
};
type SelectLinkedInOrganizationResponse = ({
    message?: string;
    /**
     * The redirect URL with connection params appended (only if redirect_url was provided in request)
     */
    redirect_url?: string;
    account?: {
        /**
         * ID of the created SocialAccount
         */
        accountId?: string;
        platform?: 'linkedin';
        username?: string;
        displayName?: string;
        profilePicture?: string;
        isActive?: boolean;
        accountType?: 'personal' | 'organization';
    };
    bulkRefresh?: {
        updatedCount?: number;
        errors?: number;
    };
});
type SelectLinkedInOrganizationError = (unknown | {
    error?: string;
});
type ListPinterestBoardsForSelectionData = {
    headers: {
        /**
         * Short-lived connect token from the OAuth redirect
         */
        'X-Connect-Token': string;
    };
    query: {
        /**
         * Your Zernio profile ID
         */
        profileId: string;
        /**
         * Temporary Pinterest access token from the OAuth callback redirect
         */
        tempToken: string;
    };
};
type ListPinterestBoardsForSelectionResponse = ({
    boards?: Array<{
        /**
         * Pinterest Board ID
         */
        id?: string;
        /**
         * Board name
         */
        name?: string;
        /**
         * Board description
         */
        description?: string;
        /**
         * Board privacy setting
         */
        privacy?: string;
    }>;
});
type ListPinterestBoardsForSelectionError = (unknown | {
    error?: string;
});
type SelectPinterestBoardData = {
    body: {
        /**
         * Your Zernio profile ID
         */
        profileId: string;
        /**
         * The Pinterest Board ID selected by the user
         */
        boardId: string;
        /**
         * The board name (for display purposes)
         */
        boardName?: string;
        /**
         * Temporary Pinterest access token from OAuth
         */
        tempToken: string;
        /**
         * User profile data from OAuth redirect
         */
        userProfile?: {
            [key: string]: unknown;
        };
        /**
         * Pinterest refresh token (if available)
         */
        refreshToken?: string;
        /**
         * Token expiration time in seconds
         */
        expiresIn?: number;
        /**
         * Custom redirect URL after connection completes
         */
        redirect_url?: string;
    };
};
type SelectPinterestBoardResponse = ({
    message?: string;
    /**
     * Redirect URL with connection params (if provided)
     */
    redirect_url?: string;
    account?: {
        /**
         * ID of the created SocialAccount
         */
        accountId?: string;
        platform?: 'pinterest';
        username?: string;
        displayName?: string;
        profilePicture?: string;
        isActive?: boolean;
        defaultBoardName?: string;
    };
});
type SelectPinterestBoardError = (unknown | {
    error?: string;
});
type ListSnapchatProfilesData = {
    headers: {
        /**
         * Short-lived connect token from the OAuth redirect
         */
        'X-Connect-Token': string;
    };
    query: {
        /**
         * Your Zernio profile ID
         */
        profileId: string;
        /**
         * Temporary Snapchat access token from the OAuth callback redirect
         */
        tempToken: string;
    };
};
type ListSnapchatProfilesResponse = ({
    publicProfiles?: Array<{
        /**
         * Snapchat Public Profile ID
         */
        id?: string;
        /**
         * Public profile display name
         */
        display_name?: string;
        /**
         * Public profile username/handle
         */
        username?: string;
        /**
         * Profile image URL
         */
        profile_image_url?: string;
        /**
         * Number of subscribers
         */
        subscriber_count?: number;
    }>;
});
type ListSnapchatProfilesError = (unknown | {
    error?: string;
});
type SelectSnapchatProfileData = {
    body: {
        /**
         * Your Zernio profile ID
         */
        profileId: string;
        /**
         * The selected Snapchat Public Profile
         */
        selectedPublicProfile: {
            /**
             * Snapchat Public Profile ID
             */
            id: string;
            /**
             * Display name of the public profile
             */
            display_name: string;
            /**
             * Username/handle
             */
            username?: string;
            /**
             * Profile image URL
             */
            profile_image_url?: string;
            /**
             * Number of subscribers
             */
            subscriber_count?: number;
        };
        /**
         * Temporary Snapchat access token from OAuth
         */
        tempToken: string;
        /**
         * User profile data from OAuth redirect
         */
        userProfile: {
            [key: string]: unknown;
        };
        /**
         * Snapchat refresh token (if available)
         */
        refreshToken?: string;
        /**
         * Token expiration time in seconds
         */
        expiresIn?: number;
        /**
         * Custom redirect URL after connection completes
         */
        redirect_url?: string;
    };
    headers?: {
        /**
         * Short-lived connect token from the OAuth redirect (for API users)
         */
        'X-Connect-Token'?: string;
    };
};
type SelectSnapchatProfileResponse = ({
    message?: string;
    /**
     * Redirect URL with connection params (if provided in request)
     */
    redirect_url?: string;
    account?: {
        /**
         * ID of the created SocialAccount
         */
        accountId?: string;
        platform?: 'snapchat';
        username?: string;
        displayName?: string;
        profilePicture?: string;
        isActive?: boolean;
        publicProfileName?: string;
    };
});
type SelectSnapchatProfileError = (unknown | {
    error?: string;
});
type ConnectBlueskyCredentialsData = {
    body: {
        /**
         * Your Bluesky handle (e.g. user.bsky.social) or email address
         */
        identifier: string;
        /**
         * App password generated from Bluesky Settings > App Passwords
         */
        appPassword: string;
        /**
         * Required state formatted as {userId}-{profileId}. Get userId from GET /v1/users and profileId from GET /v1/profiles.
         */
        state: string;
        /**
         * Optional URL to redirect to after successful connection
         */
        redirectUri?: string;
    };
};
type ConnectBlueskyCredentialsResponse = ({
    message?: string;
    account?: SocialAccount;
});
type ConnectBlueskyCredentialsError = (unknown | {
    error?: string;
});
type ConnectOpenAiAdsCredentialsData = {
    body: {
        /**
         * API key from ChatGPT Ads Manager (Settings). Grants full read/write access on OpenAI's side; Zernio only ever reads with it.
         */
        apiKey: string;
        /**
         * Your Zernio profile ID
         */
        profileId: string;
        /**
         * Optional state passthrough for the connect flow.
         */
        state?: string;
        /**
         * Optional URL to redirect to after successful connection
         */
        redirectUri?: string;
    };
};
type ConnectOpenAiAdsCredentialsResponse = ({
    accountId?: string;
    adAccountName?: string;
    redirectUrl?: string;
});
type ConnectOpenAiAdsCredentialsError = (ErrorResponse | unknown);
type ConnectWhatsAppCredentialsData = {
    body: {
        /**
         * Your Zernio profile ID
         */
        profileId: string;
        /**
         * Permanent System User access token from Meta Business Suite
         */
        accessToken: string;
        /**
         * WhatsApp Business Account ID from Meta
         */
        wabaId: string;
        /**
         * Phone Number ID from Meta WhatsApp Manager
         */
        phoneNumberId: string;
        /**
         * The 6-digit two-step verification PIN set on the number. Required if you enabled two-step verification for it, otherwise Meta rejects the Cloud API registration with error 133005 and the number cannot send messages.
         */
        pin?: string;
    };
};
type ConnectWhatsAppCredentialsResponse = ({
    message?: string;
    /**
     * Present when the account was created but Meta rejected the Cloud API registration. The number cannot send messages until this is resolved.
     */
    registrationWarning?: string;
    account?: {
        accountId?: string;
        platform?: 'whatsapp';
        /**
         * Display phone number
         */
        username?: string;
        /**
         * Meta-verified business name
         */
        displayName?: string;
        isActive?: boolean;
        /**
         * The connected phone number
         */
        selectedPhoneNumber?: string;
    };
});
type ConnectWhatsAppCredentialsError = (unknown);
type ListWhatsAppPhoneNumbersData = {
    headers?: {
        /**
         * Alternative auth for API users' end customers (used when the bearer token is scoped to a different user)
         */
        'X-Connect-Token'?: string;
    };
    query: {
        /**
         * The Zernio profile ID from the headless redirect
         */
        profileId: string;
        /**
         * The temporary access token from the headless redirect
         */
        tempToken: string;
    };
};
type ListWhatsAppPhoneNumbersResponse = ({
    phoneNumbers?: Array<{
        /**
         * Phone Number ID (Meta)
         */
        id?: string;
        /**
         * E.164-formatted display number
         */
        display_phone_number?: string;
        /**
         * Meta-verified business name
         */
        verified_name?: string;
        /**
         * GREEN, YELLOW, RED, or UNKNOWN
         */
        quality_rating?: string;
        /**
         * APPROVED, PENDING_REVIEW, DECLINED, or NONE
         */
        name_status?: string;
        /**
         * TIER_250, TIER_1K, TIER_10K, TIER_100K, or TIER_UNLIMITED
         */
        messaging_limit_tier?: string;
        /**
         * WhatsApp Business Account ID (Zernio enrichment)
         */
        wabaId?: string;
        /**
         * WABA display name (Zernio enrichment)
         */
        wabaName?: string;
    }>;
});
type ListWhatsAppPhoneNumbersError = (ErrorResponse | {
    error?: string;
});
type CompleteWhatsAppPhoneSelectionData = {
    body: {
        /**
         * The Zernio profile ID
         */
        profileId: string;
        /**
         * The selected phone number ID (from listWhatsAppPhoneNumbers)
         */
        phoneNumberId: string;
        /**
         * The WABA ID containing the selected phone
         */
        wabaId: string;
        /**
         * The temporary access token from the headless redirect
         */
        tempToken: string;
        /**
         * Optional user profile data (passthrough)
         */
        userProfile?: {
            [key: string]: unknown;
        };
        /**
         * Optional URL to receive the post-connection redirect target
         */
        redirect_url?: string;
    };
    headers?: {
        /**
         * Alternative auth for API users' end customers
         */
        'X-Connect-Token'?: string;
    };
};
type CompleteWhatsAppPhoneSelectionResponse = ({
    message?: string;
    /**
     * Present only if redirect_url was provided in the request
     */
    redirect_url?: string;
    account?: {
        accountId?: string;
        platform?: 'whatsapp';
        /**
         * Display phone number
         */
        username?: string;
        /**
         * Meta-verified business name
         */
        displayName?: string;
        isActive?: boolean;
        selectedPhoneNumber?: string;
    };
});
type CompleteWhatsAppPhoneSelectionError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetTelegramConnectStatusData = {
    query: {
        /**
         * The profile ID to connect the Telegram account to
         */
        profileId: string;
    };
};
type GetTelegramConnectStatusResponse = ({
    /**
     * The access code to send to the Telegram bot
     */
    code?: string;
    /**
     * When the code expires
     */
    expiresAt?: string;
    /**
     * Seconds until expiration
     */
    expiresIn?: number;
    /**
     * The Telegram bot username to message
     */
    botUsername?: string;
    /**
     * Step-by-step connection instructions
     */
    instructions?: Array<(string)>;
});
type GetTelegramConnectStatusError = (unknown | {
    error?: string;
});
type InitiateTelegramConnectData = {
    body: {
        /**
         * The Telegram chat ID. Numeric ID (e.g. "-1001234567890") or username with @ prefix (e.g. "@mychannel").
         */
        chatId: string;
        /**
         * The profile ID to connect the account to
         */
        profileId: string;
    };
};
type InitiateTelegramConnectResponse = ({
    message?: string;
    account?: {
        _id?: string;
        platform?: 'telegram';
        username?: string;
        displayName?: string;
        isActive?: boolean;
        chatType?: 'channel' | 'group' | 'supergroup' | 'private';
    };
});
type InitiateTelegramConnectError = (unknown | {
    error?: string;
});
type CompleteTelegramConnectData = {
    query: {
        /**
         * The access code to check status for
         */
        code: string;
    };
};
type CompleteTelegramConnectResponse = (({
    status?: 'pending';
    expiresAt?: string;
    /**
     * Seconds until expiration
     */
    expiresIn?: number;
} | {
    status?: 'connected';
    chatId?: string;
    chatTitle?: string;
    chatType?: 'channel' | 'group' | 'supergroup';
    account?: {
        _id?: string;
        platform?: string;
        username?: string;
        displayName?: string;
    };
} | {
    status?: 'expired';
    message?: string;
}));
type CompleteTelegramConnectError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetFacebookPagesData = {
    path: {
        accountId: string;
    };
    query?: {
        /**
         * When true, bypasses the page cache and fetches fresh pages from Meta. Rate-limited server-side to 1 refresh per 60s. Pages no longer accessible to the connected account will be removed from the list on refresh.
         *
         */
        refresh?: boolean;
    };
};
type GetFacebookPagesResponse = ({
    pages?: Array<{
        id?: string;
        name?: string;
        username?: string;
        category?: string;
        fan_count?: number;
    }>;
    selectedPageId?: string;
    cached?: boolean;
});
type GetFacebookPagesError = ({
    error?: string;
} | unknown);
type UpdateFacebookPageData = {
    body: {
        selectedPageId: string;
    };
    path: {
        accountId: string;
    };
};
type UpdateFacebookPageResponse = ({
    message?: string;
    selectedPage?: {
        id?: string;
        name?: string;
    };
});
type UpdateFacebookPageError = (unknown | {
    error?: string;
});
type GetLinkedInOrganizationsData = {
    path: {
        accountId: string;
    };
};
type GetLinkedInOrganizationsResponse = ({
    organizations?: Array<{
        id?: string;
        name?: string;
        vanityName?: string;
        localizedName?: string;
    }>;
});
type GetLinkedInOrganizationsError = ({
    error?: string;
} | unknown);
type GetLinkedInAggregateAnalyticsData = {
    path: {
        /**
         * The ID of the LinkedIn personal account
         */
        accountId: string;
    };
    query?: {
        /**
         * TOTAL (default, lifetime totals) or DAILY (time series). MEMBERS_REACHED not available with DAILY.
         */
        aggregation?: 'TOTAL' | 'DAILY';
        /**
         * End date (YYYY-MM-DD, exclusive). Defaults to today if omitted.
         */
        endDate?: string;
        /**
         * Comma-separated metrics: IMPRESSION, MEMBERS_REACHED, REACTION, COMMENT, RESHARE, POST_SAVE, POST_SEND. Omit for all.
         */
        metrics?: string;
        /**
         * Start date (YYYY-MM-DD). If omitted, returns lifetime analytics.
         */
        startDate?: string;
    };
};
type GetLinkedInAggregateAnalyticsResponse = ((LinkedInAggregateAnalyticsTotalResponse | LinkedInAggregateAnalyticsDailyResponse));
type GetLinkedInAggregateAnalyticsError = ({
    error?: string;
    code?: string;
    validOptions?: Array<(string)>;
} | {
    error?: string;
} | {
    error?: string;
    code?: string;
} | {
    error?: string;
    code?: string;
    requiredScope?: string;
    action?: string;
} | unknown);
type GetLinkedInPostAnalyticsData = {
    path: {
        /**
         * The ID of the LinkedIn account
         */
        accountId: string;
    };
    query: {
        /**
         * The LinkedIn post URN
         */
        urn: string;
    };
};
type GetLinkedInPostAnalyticsResponse = ({
    accountId?: string;
    platform?: string;
    accountType?: 'personal' | 'organization';
    username?: string;
    postUrn?: string;
    analytics?: {
        /**
         * Times the post was shown
         */
        impressions?: number;
        /**
         * Unique members who saw the post
         */
        reach?: number;
        /**
         * Reactions on the post
         */
        likes?: number;
        /**
         * Comments on the post
         */
        comments?: number;
        /**
         * Reshares of the post
         */
        shares?: number;
        /**
         * Times the post was saved (personal accounts only; 0 for organization accounts)
         */
        saves?: number;
        /**
         * Times the post was sent via LinkedIn messaging (personal accounts only; 0 for organization accounts)
         */
        sends?: number;
        /**
         * Clicks on the post (organization accounts only)
         */
        clicks?: number;
        /**
         * Video views (video posts only)
         */
        views?: number;
        /**
         * Engagement rate, as a percentage rounded to 2 decimals: (likes + comments + shares + clicks + saves + sends) / impressions * 100. Unlike PostAnalytics.engagementRate on GET /v1/analytics, this one DOES count clicks and has no fallback denominator, so it is 0 whenever impressions is 0. For organization accounts the value is the rate LinkedIn returns, not one computed here.
         */
        engagementRate?: number;
    };
    lastUpdated?: string;
});
type GetLinkedInPostAnalyticsError = ({
    error?: string;
    code?: 'missing_urn' | 'invalid_urn' | 'invalid_platform';
} | {
    error?: string;
} | unknown | {
    error?: string;
    code?: string;
    requiredScope?: string;
    action?: string;
} | {
    error?: string;
    code?: string;
});
type GetLinkedInPostReactionsData = {
    path: {
        /**
         * The ID of the LinkedIn organization account
         */
        accountId: string;
    };
    query: {
        /**
         * Offset-based pagination start index
         */
        cursor?: number;
        /**
         * Maximum number of reactions to return per page
         */
        limit?: number;
        /**
         * The LinkedIn post URN
         */
        urn: string;
    };
};
type GetLinkedInPostReactionsResponse = ({
    accountId?: string;
    platform?: string;
    accountType?: string;
    username?: string;
    postUrn?: string;
    reactions?: Array<{
        /**
         * LinkedIn reaction enum (LIKE, PRAISE, EMPATHY, INTEREST, APPRECIATION, ENTERTAINMENT)
         */
        reactionType?: string;
        /**
         * User-friendly label (Like, Celebrate, Love, Insightful, Support, Funny)
         */
        reactionLabel?: string;
        reactedAt?: string;
        from?: {
            /**
             * LinkedIn person or organization URN
             */
            urn?: string;
            /**
             * Reactor's display name
             */
            name?: string;
            /**
             * Reactor's headline/job title
             */
            headline?: string;
            /**
             * LinkedIn vanity name
             */
            username?: string;
            /**
             * Profile picture URL
             */
            profilePicture?: string;
            /**
             * Direct link to LinkedIn profile
             */
            profileUrl?: string;
        };
    }>;
    pagination?: {
        hasMore?: boolean;
        /**
         * Offset for next page
         */
        cursor?: string;
        /**
         * Total number of reactions (when available)
         */
        total?: number;
    };
    lastUpdated?: string;
});
type GetLinkedInPostReactionsError = (ErrorResponse | {
    error?: string;
} | unknown);
type UpdateLinkedInOrganizationData = {
    body: {
        accountType: 'personal' | 'organization';
        selectedOrganization?: {
            [key: string]: unknown;
        };
    };
    path: {
        accountId: string;
    };
};
type UpdateLinkedInOrganizationResponse = ({
    message?: string;
    accountType?: 'personal' | 'organization';
    accountName?: string;
});
type UpdateLinkedInOrganizationError = (unknown | {
    error?: string;
});
type GetLinkedInMentionsData = {
    path: {
        /**
         * The LinkedIn account ID
         */
        accountId: string;
    };
    query: {
        /**
         * Exact display name as shown on LinkedIn. Required for person mentions to be clickable. Optional for org mentions.
         */
        displayName?: string;
        /**
         * LinkedIn profile URL, company URL, or vanity name.
         */
        url: string;
    };
};
type GetLinkedInMentionsResponse = ({
    /**
     * The LinkedIn URN (person or organization)
     */
    urn?: string;
    /**
     * The type of entity (person or organization)
     */
    type?: 'person' | 'organization';
    /**
     * Display name (provided, from API, or derived from vanity URL)
     */
    displayName?: string;
    /**
     * Ready-to-use mention format for post content
     */
    mentionFormat?: string;
    /**
     * The vanity name/slug (only for organization mentions)
     */
    vanityName?: string;
    /**
     * Warning about clickable mentions (only present for person mentions if displayName was not provided)
     */
    warning?: string;
});
type GetLinkedInMentionsError = ({
    error?: string;
});
type ListInstagramStoriesData = {
    path: {
        /**
         * The Instagram account ID
         */
        accountId: string;
    };
};
type ListInstagramStoriesResponse = ({
    data: Array<{
        /**
         * Instagram media ID of the story.
         */
        id: string;
        /**
         * IMAGE / VIDEO / CAROUSEL_ALBUM
         */
        mediaType?: (string) | null;
        /**
         * Always 'STORY' for this endpoint.
         */
        mediaProductType?: (string) | null;
        /**
         * Direct media URL. Null if Meta flagged the story for copyright. URL expires when the story expires.
         */
        mediaUrl?: (string) | null;
        /**
         * Public Instagram permalink to the story (only viewable while live).
         */
        permalink?: (string) | null;
        /**
         * Thumbnail URL for video stories.
         */
        thumbnailUrl?: (string) | null;
        /**
         * When the story was posted.
         */
        timestamp?: (string) | null;
    }>;
});
type ListInstagramStoriesError = (unknown | {
    error?: string;
});
type GetInstagramPublishingLimitData = {
    path: {
        /**
         * The ID of the Instagram account
         */
        accountId: string;
    };
};
type GetInstagramPublishingLimitResponse = ({
    /**
     * Containers published so far in the current window
     */
    quotaUsage?: number;
    /**
     * Maximum containers publishable per window
     */
    quotaTotal?: number;
    /**
     * Length of the rolling window in seconds
     */
    quotaDurationSeconds?: number;
});
type GetInstagramPublishingLimitError = (unknown | {
    error?: string;
});
type SearchInstagramAudioData = {
    path: {
        /**
         * The ID of the Instagram account
         */
        accountId: string;
    };
    query: {
        /**
         * Catalog to search: licensed music or original sounds from Reels.
         */
        audioType: 'music' | 'original_sound';
        /**
         * Search keywords. Omit to get the current trending list.
         */
        q?: string;
    };
};
type SearchInstagramAudioResponse = ({
    audio?: Array<InstagramAudioAsset>;
});
type SearchInstagramAudioError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetInstagramAudioData = {
    path: {
        /**
         * The ID of the Instagram account
         */
        accountId: string;
        /**
         * Instagram audio asset ID
         */
        audioId: string;
    };
};
type GetInstagramAudioResponse = ({
    audio?: InstagramAudioAsset;
});
type GetInstagramAudioError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetInstagramStoryInsightsData = {
    path: {
        /**
         * The Instagram account ID
         */
        accountId: string;
        /**
         * The Instagram media ID of the story.
         */
        storyId: string;
    };
};
type GetInstagramStoryInsightsResponse = ({
    data: {
        source: 'live' | 'cached' | 'unavailable';
        metrics: {
            /**
             * Total story plays. Replaces deprecated 'impressions' for media created after 2024-07-02.
             */
            views: number;
            /**
             * Unique accounts that saw the story.
             */
            reach: number;
            /**
             * DMs sent in reply to the story.
             */
            replies: number;
            shares: number;
            /**
             * Total nav actions (tapsForward + tapsBack + exits + swipesForward).
             */
            navigation: number;
            /**
             * Tapped right to next slide of SAME story.
             */
            tapsForward: number;
            /**
             * Tapped left to previous slide.
             */
            tapsBack: number;
            /**
             * Closed Stories interface entirely.
             */
            exits: number;
            /**
             * Swiped left to next account's story.
             */
            swipesForward: number;
            profileVisits: number;
            follows: number;
            reposts: number;
            totalInteractions: number;
        };
    };
});
type GetInstagramStoryInsightsError = (unknown | {
    error?: string;
});
type GetPinterestBoardsData = {
    path: {
        accountId: string;
    };
};
type GetPinterestBoardsResponse = ({
    boards?: Array<{
        id?: string;
        name?: string;
        description?: string;
        privacy?: string;
    }>;
});
type GetPinterestBoardsError = (unknown | {
    error?: string;
});
type UpdatePinterestBoardsData = {
    body: {
        defaultBoardId: string;
        defaultBoardName?: string;
    };
    path: {
        accountId: string;
    };
};
type UpdatePinterestBoardsResponse = ({
    message?: string;
    account?: SocialAccount;
});
type UpdatePinterestBoardsError = (unknown | {
    error?: string;
});
type CreatePinterestBoardData = {
    body: {
        /**
         * Name of the board
         */
        name: string;
        /**
         * Board description
         */
        description?: string;
        /**
         * Board privacy setting
         */
        privacy?: 'PUBLIC' | 'PROTECTED' | 'SECRET';
    };
    path: {
        accountId: string;
    };
};
type CreatePinterestBoardResponse = ({
    board?: {
        id?: string;
        name?: string;
        description?: string;
        privacy?: string;
        url?: string;
    };
});
type CreatePinterestBoardError = (unknown | {
    error?: string;
});
type GetYoutubePlaylistsData = {
    path: {
        accountId: string;
    };
};
type GetYoutubePlaylistsResponse = ({
    playlists?: Array<{
        id?: string;
        title?: string;
        description?: string;
        privacy?: 'public' | 'private' | 'unlisted';
        itemCount?: number;
        thumbnailUrl?: string;
    }>;
    defaultPlaylistId?: (string) | null;
});
type GetYoutubePlaylistsError = (unknown | {
    error?: string;
});
type UpdateYoutubeDefaultPlaylistData = {
    body: {
        defaultPlaylistId: string;
        defaultPlaylistName?: string;
    };
    path: {
        accountId: string;
    };
};
type UpdateYoutubeDefaultPlaylistResponse = ({
    success?: boolean;
});
type UpdateYoutubeDefaultPlaylistError = (unknown | {
    error?: string;
});
type GetGmbLocationsData = {
    path: {
        accountId: string;
    };
    query?: {
        /**
         * Raw Google Business Information API filter expression (advanced; takes precedence over search), e.g. storeCode="LH279411".
         */
        filter?: string;
        /**
         * Max locations to return (default 100, max 500). Raise it to enumerate an account with more than 100 locations; for accounts with thousands, use search/filter instead.
         */
        limit?: number;
        /**
         * Free-text search on the business name, applied server-side by Google. Use for accounts with many locations.
         */
        search?: string;
    };
};
type GetGmbLocationsResponse = ({
    locations?: Array<{
        id?: string;
        name?: string;
        accountId?: string;
        accountName?: string;
        address?: string;
        category?: string;
        websiteUrl?: string;
        storeCode?: string;
    }>;
    /**
     * True when more locations exist than were returned (use search to narrow down).
     */
    hasMore?: boolean;
    selectedLocationId?: string;
    cached?: boolean;
});
type GetGmbLocationsError = (unknown | {
    error?: string;
});
type UpdateGmbLocationData = {
    body: {
        selectedLocationId: string;
        /**
         * Optional but recommended. The Google Business Account resource name ("accounts/123") that owns the new location (from GET gmb-locations). When provided, the location is resolved directly instead of by enumerating the account, which is required for accounts with many locations. Named `googleAccountId` to disambiguate from the path `accountId` (the Zernio account). The legacy field name `accountId` is still accepted for backwards compatibility.
         *
         */
        googleAccountId?: string;
    };
    path: {
        accountId: string;
    };
};
type UpdateGmbLocationResponse = ({
    message?: string;
    selectedLocation?: {
        id?: string;
        name?: string;
    };
});
type UpdateGmbLocationError = (unknown | {
    error?: string;
});
type AssignGoogleBusinessLocationData = {
    body: {
        /**
         * Target profile to connect the location onto.
         */
        profileId: string;
        /**
         * The Google Business location ID to assign (e.g. "locations/123").
         */
        selectedLocationId: string;
        /**
         * Optional but recommended. The Google Business Account resource name ("accounts/123") that owns the location (from GET gmb-locations). When provided the location is resolved directly instead of by enumerating the account, required for accounts with many locations.
         *
         */
        googleAccountId?: string;
    };
    path: {
        /**
         * A source connected GBP account whose OAuth grant is reused.
         */
        accountId: string;
    };
};
type AssignGoogleBusinessLocationResponse = ({
    message?: string;
    account?: {
        accountId?: string;
        platform?: string;
        username?: string;
        displayName?: string;
        isActive?: boolean;
        /**
         * Human-readable location display name (e.g. "Snap Fitness Dianella"), NOT a resource name. Do not use it to build API paths.
         */
        selectedLocationName?: string;
        /**
         * Bare GBP location id (digits only). Combine with the GBP account id as accounts/{gbpAccountId}/locations/{selectedLocationId} to form the location resource names that gmb-reviews/batch expects in locationNames.
         */
        selectedLocationId?: string;
    };
});
type AssignGoogleBusinessLocationError = (unknown | {
    error?: string;
});
type GetFacebookPostReactionsData = {
    path: {
        /**
         * The ID of the Facebook Page account
         */
        accountId: string;
    };
    query: {
        /**
         * The Facebook post ID
         */
        postId: string;
    };
};
type GetFacebookPostReactionsResponse = ({
    accountId?: string;
    platform?: string;
    username?: string;
    postId?: string;
    /**
     * Total reactions across all types
     */
    total?: number;
    /**
     * Count per reaction type. A type with no reactions returns 0.
     */
    breakdown?: {
        like?: number;
        love?: number;
        haha?: number;
        wow?: number;
        sad?: number;
        angry?: number;
        care?: number;
    };
    lastUpdated?: string;
});
type GetFacebookPostReactionsError = (unknown | {
    error?: string;
});
type GetRedditSubredditsData = {
    path: {
        accountId: string;
    };
};
type GetRedditSubredditsResponse = ({
    subreddits?: Array<{
        /**
         * Reddit subreddit ID
         */
        id?: string;
        /**
         * Subreddit name without r/ prefix
         */
        name?: string;
        /**
         * Subreddit title
         */
        title?: string;
        /**
         * Subreddit URL path
         */
        url?: string;
        /**
         * Whether the subreddit is NSFW
         */
        over18?: boolean;
    }>;
    /**
     * Currently set default subreddit for posting
     */
    defaultSubreddit?: string;
});
type GetRedditSubredditsError = (unknown | {
    error?: string;
});
type UpdateRedditSubredditsData = {
    body: {
        defaultSubreddit: string;
    };
    path: {
        accountId: string;
    };
};
type UpdateRedditSubredditsResponse = ({
    success?: boolean;
});
type UpdateRedditSubredditsError = (unknown | {
    error?: string;
});
type GetSubredditRulesData = {
    path: {
        /**
         * The ID of the Reddit account
         */
        accountId: string;
        /**
         * Subreddit name (without the "r/" prefix)
         */
        subreddit: string;
    };
};
type GetSubredditRulesResponse = ({
    rules?: Array<{
        /**
         * Scope of the rule: 'link', 'comment', or 'all'
         */
        kind?: string;
        /**
         * Short rule title shown in the subreddit sidebar
         */
        shortName?: string;
        /**
         * Full rule text
         */
        description?: string;
        /**
         * Reason shown to a user when the rule is enforced
         */
        violationReason?: string;
        /**
         * Unix timestamp when the rule was created
         */
        createdUtc?: number;
        /**
         * Display order of the rule
         */
        priority?: number;
    }>;
    /**
     * Reddit's site-wide content policy rules
     */
    siteRules?: Array<(string)>;
});
type GetSubredditRulesError = (unknown | {
    error?: string;
});
type VoteRedditThingData = {
    body: {
        /**
         * Reddit fullname of the target. Prefix "t3_" for a post and "t1_" for a comment. A bare id with no prefix is treated as a post ("t3_").
         *
         */
        thingId: string;
        /**
         * 1 to upvote, -1 to downvote, 0 to clear an existing vote
         */
        direction: 1 | 0 | -1;
    };
    path: {
        /**
         * The ID of the Reddit account casting the vote
         */
        accountId: string;
    };
};
type VoteRedditThingResponse = ({
    success?: boolean;
});
type VoteRedditThingError = (unknown | {
    error?: string;
});
type GetRedditFlairsData = {
    path: {
        accountId: string;
    };
    query: {
        /**
         * Subreddit name (without "r/" prefix) to fetch flairs for
         */
        subreddit: string;
    };
};
type GetRedditFlairsResponse = ({
    flairs?: Array<{
        /**
         * Flair ID to pass as flairId in platformSpecificData
         */
        id?: string;
        /**
         * Flair display text
         */
        text?: string;
        /**
         * Text color: 'dark' or 'light'
         */
        textColor?: string;
        /**
         * Background hex color (e.g. '#ff4500')
         */
        backgroundColor?: string;
    }>;
});
type GetRedditFlairsError = (unknown | {
    error?: string;
});
type SetRedditPostFlairData = {
    body: {
        /**
         * Subreddit name (without the "r/" prefix)
         */
        subreddit: string;
        /**
         * Reddit post id, with or without the t3_ prefix
         */
        postId: string;
        /**
         * Flair template id from the GET on this path
         */
        flairTemplateId: string;
        /**
         * Optional override text, only for editable flair templates
         */
        text?: string;
    };
    path: {
        /**
         * The ID of the Reddit account that owns the post
         */
        accountId: string;
    };
};
type SetRedditPostFlairResponse = ({
    success?: boolean;
});
type SetRedditPostFlairError = (unknown | {
    error?: string;
});
type GetSlackSettingsData = {
    path: {
        accountId: string;
    };
};
type GetSlackSettingsResponse = ({
    account?: {
        _id?: string;
        platform?: string;
        displayName?: (string) | null;
        channelId?: (string) | null;
        channelName?: (string) | null;
        /**
         * public or private
         */
        channelType?: (string) | null;
        teamId?: (string) | null;
        teamName?: (string) | null;
        defaultUsername?: (string) | null;
        defaultIconUrl?: (string) | null;
    };
});
type GetSlackSettingsError = (ErrorResponse | {
    error?: string;
} | unknown);
type UpdateSlackSettingsData = {
    body: {
        /**
         * Author name shown on posts. Empty string clears it.
         */
        defaultUsername?: string;
        /**
         * Author avatar image URL. Empty string clears it.
         */
        defaultIconUrl?: string;
    };
    path: {
        accountId: string;
    };
};
type UpdateSlackSettingsResponse = (unknown);
type UpdateSlackSettingsError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetBlueskySettingsData = {
    path: {
        accountId: string;
    };
};
type GetBlueskySettingsResponse = ({
    defaultLangs?: Array<(string)> | null;
});
type GetBlueskySettingsError = (ErrorResponse | {
    error?: string;
} | unknown);
type UpdateBlueskySettingsData = {
    body: {
        defaultLangs: Array<(string)> | null;
    };
    path: {
        accountId: string;
    };
};
type UpdateBlueskySettingsResponse = (unknown);
type UpdateBlueskySettingsError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetDiscordSettingsData = {
    path: {
        accountId: string;
    };
};
type GetDiscordSettingsResponse = ({
    account?: {
        _id?: string;
        platform?: string;
        /**
         * Channel name
         */
        username?: string;
        /**
         * Guild - #channel display name
         */
        displayName?: string;
        /**
         * Guild icon URL
         */
        profilePicture?: string;
        /**
         * Connected channel snowflake ID
         */
        channelId?: string;
        /**
         * Channel name
         */
        channelName?: string;
        /**
         * Channel type (0 = text, 5 = announcement, 15 = forum)
         */
        channelType?: string;
        /**
         * Guild (server) snowflake ID
         */
        guildId?: string;
        /**
         * Custom webhook display name (null = default "Zernio")
         */
        webhookUsername?: (string) | null;
        /**
         * Custom webhook avatar URL (null = default bot avatar)
         */
        webhookAvatarUrl?: (string) | null;
    };
});
type GetDiscordSettingsError = (unknown | {
    error?: string;
});
type UpdateDiscordSettingsData = {
    body: {
        /**
         * Custom display name for the webhook (1-80 chars). Empty string resets to default ("Zernio"). Cannot contain "clyde" or "discord".
         */
        webhookUsername?: string;
        /**
         * Custom avatar URL. Empty string resets to default bot avatar.
         */
        webhookAvatarUrl?: string;
        /**
         * Switch to a different channel in the same guild. Must be a text (0), announcement (5), or forum (15) channel.
         */
        channelId?: string;
    };
    path: {
        accountId: string;
    };
};
type UpdateDiscordSettingsResponse = ({
    message?: string;
    account?: {
        _id?: string;
        platform?: string;
        username?: string;
        displayName?: string;
        profilePicture?: string;
        channelId?: string;
        channelName?: string;
        channelType?: string;
        guildId?: string;
        webhookUsername?: (string) | null;
        webhookAvatarUrl?: (string) | null;
    };
});
type UpdateDiscordSettingsError = (unknown | {
    error?: string;
});
type GetDiscordChannelsData = {
    path: {
        accountId: string;
    };
};
type GetDiscordChannelsResponse = ({
    channels?: Array<{
        /**
         * Channel snowflake ID
         */
        id?: string;
        /**
         * Channel name
         */
        name?: string;
        /**
         * Channel type: 0 (text), 5 (announcement), 15 (forum)
         */
        type?: number;
    }>;
});
type GetDiscordChannelsError = (unknown | {
    error?: string;
});
type ListSlackMembersData = {
    path: {
        accountId: string;
    };
    query?: {
        limit?: number;
        /**
         * Case-insensitive filter over display name and handle.
         */
        query?: string;
    };
};
type ListSlackMembersResponse = ({
    members?: Array<{
        /**
         * Slack member id (pass as participantId to start a DM).
         */
        id?: string;
        /**
         * Display name
         */
        name?: string;
        /**
         * Slack handle
         */
        username?: (string) | null;
        /**
         * Avatar URL
         */
        picture?: (string) | null;
    }>;
});
type ListSlackMembersError = (ErrorResponse | {
    error?: string;
} | unknown);
type SendDiscordDirectMessageData = {
    body: {
        /**
         * SocialAccount _id of the connected Discord account the bot speaks as. Caller must own the account (directly or via team membership).
         */
        accountId: string;
        /**
         * Discord snowflake ID of the recipient (15-21 digits).
         */
        userId: string;
        /**
         * Message text, up to 2,000 characters.
         */
        content?: string;
        /**
         * Up to 10 Discord embeds. Same shape as channel-post embeds (title, description, color, fields, etc.). See DiscordPlatformData.embeds for the embed object schema.
         */
        embeds?: Array<{
            [key: string]: unknown;
        }>;
        /**
         * Up to 10 media attachments. Each is `{ type: image|video|gif|document, url, filename?, mimeType?, size? }`.
         */
        attachments?: Array<{
            type: 'image' | 'video' | 'gif' | 'document';
            url: string;
            filename?: string;
            mimeType?: string;
            size?: number;
        }>;
        /**
         * Send as text-to-speech message.
         */
        tts?: boolean;
    };
};
type SendDiscordDirectMessageResponse = ({
    /**
     * Discord message snowflake ID
     */
    messageId?: string;
    /**
     * DM channel snowflake (Discord auto-creates one per recipient pair)
     */
    channelId?: string;
    /**
     * Direct link to the message — uses Discord's @me path for DMs
     */
    url?: string;
    timestamp?: string;
    recipient?: {
        userId?: string;
        platform?: string;
    };
    account?: {
        id?: string;
        username?: string;
        displayName?: string;
    };
});
type SendDiscordDirectMessageError = (unknown | {
    error?: string;
});
type ListDiscordGuildRolesData = {
    path: {
        /**
         * Discord guild snowflake ID
         */
        guildId: string;
    };
    query: {
        /**
         * SocialAccount _id of the Discord account bound to this guild
         */
        accountId: string;
    };
};
type ListDiscordGuildRolesResponse = ({
    data?: Array<{
        /**
         * Role snowflake ID
         */
        id?: string;
        name?: string;
        /**
         * Decimal color (0 = no color). Convert to hex via .toString(16).
         */
        color?: number;
        /**
         * Position in role hierarchy (higher = more authority)
         */
        position?: number;
        /**
         * Permissions bitfield as a stringified integer
         */
        permissions?: string;
        /**
         * True for integration-managed roles (bot roles)
         */
        managed?: boolean;
        mentionable?: boolean;
        /**
         * True if role is displayed separately in member list
         */
        hoist?: boolean;
    }>;
});
type ListDiscordGuildRolesError = (unknown | {
    error?: string;
});
type CreateDiscordGuildRoleData = {
    body: {
        name: string;
        /**
         * Decimal color (0 = no color). 0xFF0000 red is 16711680.
         */
        color?: number;
        /**
         * Display members with this role separately in the member list
         */
        hoist?: boolean;
        /**
         * Allow anyone to @mention this role
         */
        mentionable?: boolean;
        /**
         * Permissions bitfield as a stringified integer
         */
        permissions?: string;
    };
    path: {
        /**
         * Discord guild snowflake ID
         */
        guildId: string;
    };
    query: {
        /**
         * SocialAccount _id of the Discord account bound to this guild
         */
        accountId: string;
    };
};
type CreateDiscordGuildRoleResponse = ({
    data?: DiscordRole;
});
type CreateDiscordGuildRoleError = (unknown | {
    error?: string;
});
type EditDiscordGuildRoleData = {
    body: {
        name?: string;
        color?: number;
        hoist?: boolean;
        mentionable?: boolean;
        /**
         * Permissions bitfield as a stringified integer
         */
        permissions?: string;
    };
    path: {
        /**
         * Discord guild snowflake ID
         */
        guildId: string;
        /**
         * Discord role snowflake ID
         */
        roleId: string;
    };
    query: {
        /**
         * SocialAccount _id of the Discord account bound to this guild
         */
        accountId: string;
    };
};
type EditDiscordGuildRoleResponse = ({
    data?: DiscordRole;
});
type EditDiscordGuildRoleError = (unknown | {
    error?: string;
});
type DeleteDiscordGuildRoleData = {
    path: {
        /**
         * Discord guild snowflake ID
         */
        guildId: string;
        /**
         * Discord role snowflake ID
         */
        roleId: string;
    };
    query: {
        /**
         * SocialAccount _id of the Discord account bound to this guild
         */
        accountId: string;
    };
};
type DeleteDiscordGuildRoleResponse = ({
    success?: boolean;
});
type DeleteDiscordGuildRoleError = (unknown | {
    error?: string;
});
type ListDiscordGuildMembersData = {
    path: {
        guildId: string;
    };
    query: {
        accountId: string;
        /**
         * Snowflake of the last member from the previous page.
         */
        after?: string;
        /**
         * Page size (1-1000).
         */
        limit?: number;
    };
};
type ListDiscordGuildMembersResponse = ({
    data?: Array<DiscordGuildMember>;
    pagination?: {
        /**
         * Pass as `after` on the next call. Null when there are no more pages.
         */
        nextCursor?: (string) | null;
        hasMore?: boolean;
    };
});
type ListDiscordGuildMembersError = (unknown | {
    error?: string;
});
type SearchDiscordGuildMembersData = {
    path: {
        guildId: string;
    };
    query: {
        accountId: string;
        limit?: number;
        /**
         * Username or nickname prefix to match.
         */
        query: string;
    };
};
type SearchDiscordGuildMembersResponse = ({
    data?: Array<DiscordGuildMember>;
});
type SearchDiscordGuildMembersError = (unknown | {
    error?: string;
});
type GetDiscordGuildMemberData = {
    path: {
        guildId: string;
        /**
         * Discord user snowflake.
         */
        userId: string;
    };
    query: {
        accountId: string;
    };
};
type GetDiscordGuildMemberResponse = ({
    data?: DiscordGuildMember;
});
type GetDiscordGuildMemberError = (ErrorResponse | {
    error?: string;
} | unknown);
type AddDiscordMemberRoleData = {
    path: {
        guildId: string;
        roleId: string;
        /**
         * Discord user snowflake to assign the role to.
         */
        userId: string;
    };
    query: {
        accountId: string;
    };
};
type AddDiscordMemberRoleResponse = ({
    success?: boolean;
    operation?: 'role_assigned';
    guildId?: string;
    userId?: string;
    roleId?: string;
});
type AddDiscordMemberRoleError = (unknown | {
    error?: string;
});
type RemoveDiscordMemberRoleData = {
    path: {
        guildId: string;
        roleId: string;
        userId: string;
    };
    query: {
        accountId: string;
    };
};
type RemoveDiscordMemberRoleResponse = ({
    success?: boolean;
    operation?: 'role_removed';
    guildId?: string;
    userId?: string;
    roleId?: string;
});
type RemoveDiscordMemberRoleError = (unknown | {
    error?: string;
});
type DeleteDiscordMessageData = {
    path: {
        /**
         * Discord channel snowflake ID
         */
        channelId: string;
        /**
         * Discord message snowflake ID
         */
        messageId: string;
    };
    query: {
        /**
         * SocialAccount _id of the Discord account bound to this channel's guild
         */
        accountId: string;
    };
};
type DeleteDiscordMessageResponse = ({
    success?: boolean;
});
type DeleteDiscordMessageError = (unknown | {
    error?: string;
});
type CrosspostDiscordMessageData = {
    path: {
        /**
         * Discord announcement channel snowflake ID
         */
        channelId: string;
        /**
         * Discord message snowflake ID
         */
        messageId: string;
    };
    query: {
        /**
         * SocialAccount _id of the Discord account bound to this channel's guild
         */
        accountId: string;
    };
};
type CrosspostDiscordMessageResponse = ({
    /**
     * The crossposted Discord message object.
     */
    data?: {
        [key: string]: unknown;
    };
});
type CrosspostDiscordMessageError = (unknown | {
    error?: string;
});
type CreateDiscordThreadData = {
    body: {
        /**
         * Thread name
         */
        name: string;
        /**
         * Optional message snowflake to start the thread from. Omit for a standalone thread.
         */
        messageId?: string;
        /**
         * Minutes of inactivity before the thread auto-archives. Discord accepts only these four values.
         */
        autoArchiveDuration?: 60 | 1440 | 4320 | 10080;
    };
    path: {
        /**
         * Discord channel snowflake ID
         */
        channelId: string;
    };
    query: {
        /**
         * SocialAccount _id of the Discord account bound to this channel's guild
         */
        accountId: string;
    };
};
type CreateDiscordThreadResponse = ({
    data?: {
        /**
         * Thread snowflake ID
         */
        id?: string;
        name?: string;
    };
});
type CreateDiscordThreadError = (unknown | {
    error?: string;
});
type ListDiscordPinnedMessagesData = {
    path: {
        /**
         * Discord channel snowflake.
         */
        channelId: string;
    };
    query: {
        /**
         * SocialAccount _id of any Discord account in the same guild.
         */
        accountId: string;
    };
};
type ListDiscordPinnedMessagesResponse = ({
    data?: Array<{
        id?: string;
        channel_id?: string;
        content?: string;
        timestamp?: string;
        author?: {
            [key: string]: unknown;
        };
        attachments?: Array<{
            [key: string]: unknown;
        }>;
        embeds?: Array<{
            [key: string]: unknown;
        }>;
    }>;
});
type ListDiscordPinnedMessagesError = (unknown | {
    error?: string;
});
type PinDiscordMessageData = {
    path: {
        channelId: string;
        messageId: string;
    };
    query: {
        accountId: string;
    };
};
type PinDiscordMessageResponse = ({
    success?: boolean;
    operation?: 'message_pinned';
    channelId?: string;
    messageId?: string;
});
type PinDiscordMessageError = (unknown | {
    error?: string;
});
type UnpinDiscordMessageData = {
    path: {
        channelId: string;
        messageId: string;
    };
    query: {
        accountId: string;
    };
};
type UnpinDiscordMessageResponse = ({
    success?: boolean;
    operation?: 'message_unpinned';
    channelId?: string;
    messageId?: string;
});
type UnpinDiscordMessageError = (unknown | {
    error?: string;
});
type ListDiscordScheduledEventsData = {
    path: {
        guildId: string;
    };
    query: {
        accountId: string;
        /**
         * Include user_count on each event.
         */
        withUserCount?: boolean;
    };
};
type ListDiscordScheduledEventsResponse = ({
    data?: Array<DiscordScheduledEvent>;
});
type ListDiscordScheduledEventsError = (unknown | {
    error?: string;
});
type CreateDiscordScheduledEventData = {
    body: {
        accountId: string;
        name: string;
        description?: string;
        /**
         * ISO 8601 start time. Must be in the future.
         */
        startsAt: string;
        entity: ({
            type: 'external';
            /**
             * Where the event takes place (e.g. "Zoom link", "123 Main St")
             */
            location: string;
            endsAt: string;
        } | {
            type: 'voice';
            /**
             * Voice channel snowflake.
             */
            channelId: string;
            endsAt?: string;
        } | {
            type: 'stage';
            /**
             * Stage channel snowflake.
             */
            channelId: string;
            endsAt?: string;
        });
        /**
         * Optional cover image as a base64 data URI.
         */
        imageDataUri?: string;
    };
    path: {
        guildId: string;
    };
};
type CreateDiscordScheduledEventResponse = ({
    data?: DiscordScheduledEvent;
});
type CreateDiscordScheduledEventError = (unknown | {
    error?: string;
});
type GetDiscordScheduledEventData = {
    path: {
        eventId: string;
        guildId: string;
    };
    query: {
        accountId: string;
    };
};
type GetDiscordScheduledEventResponse = ({
    data?: DiscordScheduledEvent;
});
type GetDiscordScheduledEventError = ({
    error?: string;
} | unknown);
type UpdateDiscordScheduledEventData = {
    body: {
        accountId: string;
        name?: string;
        description?: string;
        startsAt?: string;
        endsAt?: string;
        /**
         * For external events.
         */
        location?: string;
        /**
         * Status transition. Most common: 'cancelled' to cancel an event.
         */
        status?: 'scheduled' | 'active' | 'completed' | 'cancelled';
        imageDataUri?: string;
    };
    path: {
        eventId: string;
        guildId: string;
    };
};
type UpdateDiscordScheduledEventResponse = ({
    data?: DiscordScheduledEvent;
});
type UpdateDiscordScheduledEventError = (unknown | {
    error?: string;
});
type DeleteDiscordScheduledEventData = {
    path: {
        eventId: string;
        guildId: string;
    };
    query: {
        accountId: string;
    };
};
type DeleteDiscordScheduledEventResponse = ({
    success?: boolean;
    /**
     * The deleted event's snowflake.
     */
    deleted?: string;
});
type DeleteDiscordScheduledEventError = ({
    error?: string;
} | unknown);
type ListQueueSlotsData = {
    query: {
        /**
         * Set to 'true' to list all queues for the profile
         */
        all?: 'true' | 'false';
        /**
         * Profile ID to get queues for
         */
        profileId: string;
        /**
         * Specific queue ID to retrieve (optional)
         */
        queueId?: string;
    };
};
type ListQueueSlotsResponse = ((QueueSlotsResponse | {
    queues?: Array<QueueSchedule>;
    count?: number;
}));
type ListQueueSlotsError = (unknown | {
    error?: string;
});
type CreateQueueSlotData = {
    body: {
        /**
         * Profile ID
         */
        profileId: string;
        /**
         * Queue name (e.g., Evening Posts)
         */
        name: string;
        /**
         * IANA timezone
         */
        timezone: string;
        slots: Array<QueueSlot>;
        active?: boolean;
    };
};
type CreateQueueSlotResponse = ({
    success?: boolean;
    schedule?: QueueSchedule;
    nextSlots?: Array<(string)>;
});
type CreateQueueSlotError = (unknown | {
    error?: string;
});
type UpdateQueueSlotData = {
    body: {
        profileId: string;
        /**
         * Queue ID to update (optional)
         */
        queueId?: string;
        /**
         * Queue name
         */
        name?: string;
        timezone: string;
        slots: Array<QueueSlot>;
        active?: boolean;
        /**
         * Make this queue the default
         */
        setAsDefault?: boolean;
        /**
         * Whether to reschedule existing queued posts to match new slots
         */
        reshuffleExisting?: boolean;
    };
};
type UpdateQueueSlotResponse = (QueueUpdateResponse);
type UpdateQueueSlotError = (unknown | {
    error?: string;
});
type DeleteQueueSlotData = {
    query: {
        profileId: string;
        /**
         * Queue ID to delete. Omit to delete all queues for the profile
         */
        queueId?: string;
    };
};
type DeleteQueueSlotResponse = (QueueDeleteResponse);
type DeleteQueueSlotError = (unknown | {
    error?: string;
});
type PreviewQueueData = {
    query: {
        count?: number;
        profileId: string;
        /**
         * Filter by specific queue ID. Omit to use the default queue.
         */
        queueId?: string;
    };
};
type PreviewQueueResponse = (QueuePreviewResponse);
type PreviewQueueError = (unknown | {
    error?: string;
});
type GetNextQueueSlotData = {
    query: {
        profileId: string;
        /**
         * Specific queue ID (optional, defaults to profile's default queue)
         */
        queueId?: string;
    };
};
type GetNextQueueSlotResponse = (QueueNextSlotResponse);
type GetNextQueueSlotError = (unknown | {
    error?: string;
});
type GetWebhookSettingsResponse = ({
    webhooks?: Array<Webhook>;
});
type GetWebhookSettingsError = ({
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
});
type CreateWebhookSettingsData = {
    body: {
        /**
         * Webhook name (1-50 characters)
         */
        name: string;
        /**
         * Webhook endpoint URL (must be a valid URL, whitespace trimmed)
         */
        url: string;
        /**
         * Secret key for HMAC-SHA256 signature verification
         */
        secret?: string;
        /**
         * Events to subscribe to (at least one required)
         */
        events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'verification.approved' | 'verification.failed')>;
        /**
         * Enable or disable webhook delivery. Defaults to `true` when omitted.
         */
        isActive?: boolean;
        /**
         * Custom headers to include in webhook requests
         */
        customHeaders?: {
            [key: string]: (string);
        };
        /**
         * Resource groups this subscription does not receive (opt-out denylist). Omit or send an empty array to receive every event in `events`. Listing a group here drops its events before delivery and on every replay path. Set at creation it applies to everything this subscription ever receives; changed later via PUT it applies to events emitted after the change, with a five-minute tail for events already queued (see that operation). When the caller is a restricted (zrk_) key, that key's own disabled groups are unioned into whatever you send here, so a restricted key can never create a subscription wider than itself.
         */
        disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
    };
};
type CreateWebhookSettingsResponse = ({
    success?: boolean;
    webhook?: Webhook;
});
type CreateWebhookSettingsError = (unknown | {
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
});
type UpdateWebhookSettingsData = {
    body: {
        /**
         * Webhook ID to update (required)
         */
        _id: string;
        /**
         * Webhook name (1-50 characters). Must be non-empty if provided.
         */
        name?: string;
        /**
         * Webhook endpoint URL (must be a valid URL, whitespace trimmed). Must be a valid URL if provided.
         */
        url?: string;
        /**
         * Secret key for HMAC-SHA256 signature verification
         */
        secret?: string;
        /**
         * Events to subscribe to. Must contain at least one event if provided.
         */
        events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'verification.approved' | 'verification.failed')>;
        /**
         * Enable or disable webhook delivery
         */
        isActive?: boolean;
        /**
         * Custom headers to include in webhook requests
         */
        customHeaders?: {
            [key: string]: (string);
        };
        /**
         * Replaces the subscription's denylist. Send an empty array to clear it and receive every event in `events` again. Omitting the field leaves the current denylist untouched. Applies to events emitted after the update; already-queued events can still deliver for up to five minutes after they were enqueued. When the caller is a restricted (zrk_) key, that key's own disabled groups are unioned back in either way, so a restricted key can neither clear nor widen a subscription past its own groups.
         */
        disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
    };
};
type UpdateWebhookSettingsResponse = ({
    success?: boolean;
    webhook?: Webhook;
});
type UpdateWebhookSettingsError = (unknown | {
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
});
type DeleteWebhookSettingsData = {
    query: {
        /**
         * Webhook ID to delete
         */
        id: string;
    };
};
type DeleteWebhookSettingsResponse = ({
    success?: boolean;
});
type DeleteWebhookSettingsError = (unknown | {
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
});
type GetWebhookLogsData = {
    query?: {
        /**
         * Filter by event type (e.g. post.published)
         */
        event?: string;
        /**
         * Filter by stable webhook event ID
         */
        eventId?: string;
        /**
         * Maximum number of logs to return
         */
        limit?: number;
        /**
         * Number of logs to skip (offset-based pagination)
         */
        skip?: number;
        /**
         * Filter by delivery outcome
         */
        status?: 'success' | 'failed';
        /**
         * Filter by webhook configuration ID
         */
        webhookId?: string;
    };
};
type GetWebhookLogsResponse = ({
    logs?: Array<WebhookLog>;
    pagination?: {
        /**
         * Total number of matching logs
         */
        total?: number;
        /**
         * Maximum number of logs returned per page
         */
        limit?: number;
        /**
         * Number of logs skipped
         */
        skip?: number;
        /**
         * Total number of pages
         */
        pages?: number;
        /**
         * Whether more logs are available beyond this page
         */
        hasMore?: boolean;
    };
});
type GetWebhookLogsError = (unknown | {
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
});
type TestWebhookData = {
    body: {
        /**
         * ID of the webhook to test
         */
        webhookId: string;
    };
};
type TestWebhookResponse = ({
    success?: boolean;
    message?: string;
});
type TestWebhookError = (unknown | {
    error?: string;
} | {
    error?: string;
    code?: 'insufficient_permissions' | 'unclassified_resource';
    /**
     * The resource group the key needs for this operation. Absent on admin-plane and unclassified-path denials.
     */
    required_group?: 'publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks';
} | {
    success?: boolean;
    message?: string;
});
type ListLogsData = {
    query?: {
        /**
         * Filter by connected account ID
         */
        account_id?: string;
        /**
         * Filter by action (e.g., post.published, message.sent, account.connected, webhook.delivered)
         */
        action?: string;
        /**
         * Filter by the API key that made the request (api_request logs)
         */
        api_key_id?: string;
        /**
         * Number of days to look back (max 90)
         */
        days?: number;
        /**
         * Filter webhook logs by event (e.g. post.published, message.received)
         */
        event?: string;
        /**
         * Precise start instant (ISO 8601); narrows within the day range
         */
        from?: string;
        /**
         * Include message.read / message.delivered events (hidden by default for messaging logs)
         */
        include_read_receipts?: boolean;
        /**
         * Maximum number of logs to return (max 100)
         */
        limit?: number;
        /**
         * Filter by platform
         */
        platform?: 'tiktok' | 'instagram' | 'whatsapp' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'all';
        /**
         * Correlation ID — returns every log spawned by a single API request
         */
        request_id?: string;
        /**
         * Free-text search across log fields
         */
        search?: string;
        /**
         * Number of logs to skip (for pagination)
         */
        skip?: number;
        /**
         * Filter by status
         */
        status?: 'success' | 'failed' | 'pending' | 'skipped' | 'all';
        /**
         * Filter by exact HTTP status code (api_request logs)
         */
        status_code?: number;
        /**
         * Precise end instant (ISO 8601)
         */
        to?: string;
        /**
         * Log category to query. Use `all` for the unified view across every category,
         * or `api_request` for your API request logs (method, path, status, latency).
         *
         */
        type?: 'all' | 'publishing' | 'connections' | 'webhooks' | 'messaging' | 'workflow_event' | 'api_request';
    };
};
type ListLogsResponse = ({
    logs?: Array<{
        /**
         * Log category (publishing, connections, webhooks, messaging)
         */
        type?: string;
        /**
         * Specific action (post.published, message.sent, account.connected, etc.)
         */
        action?: string;
        user_id?: string;
        platform?: string;
        account_id?: string;
        status?: 'success' | 'failed' | 'pending' | 'skipped';
        status_code?: number;
        error_message?: string;
        error_code?: string;
        duration_ms?: number;
        /**
         * The API endpoint that triggered this log
         */
        endpoint?: string;
        /**
         * Request JSON (truncated to 5KB)
         */
        request_body?: string;
        /**
         * Response JSON (truncated to 10KB)
         */
        response_body?: string;
        created_at?: string;
        /**
         * Additional context as JSON string
         */
        metadata?: string;
        /**
         * Correlation ID linking every log from one API request (api_request logs)
         */
        request_id?: string;
        /**
         * The API key that made the request (api_request logs)
         */
        api_key_id?: string;
        /**
         * HTTP method (api_request logs)
         */
        method?: string;
        /**
         * Request path (api_request logs)
         */
        path?: string;
        /**
         * Client IP address (api_request logs)
         */
        ip_address?: string;
        /**
         * Client user-agent (api_request logs)
         */
        user_agent?: string;
    }>;
    pagination?: {
        total?: number;
        limit?: number;
        skip?: number;
        pages?: number;
        hasMore?: boolean;
    };
});
type ListLogsError = ({
    error?: string;
});
type ListInboxConversationsData = {
    query?: {
        /**
         * Filter by specific social account ID
         */
        accountId?: string;
        /**
         * Pagination cursor for next page
         */
        cursor?: string;
        /**
         * Maximum number of conversations to return
         */
        limit?: number;
        /**
         * Filter by platform
         */
        platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'reddit' | 'telegram' | 'whatsapp';
        /**
         * Filter by profile ID
         */
        profileId?: string;
        /**
         * Sort order by updated time
         */
        sortOrder?: 'asc' | 'desc';
        /**
         * Filter by conversation status
         */
        status?: 'active' | 'archived';
    };
};
type ListInboxConversationsResponse = ({
    data?: Array<{
        /**
         * Opaque conversation identifier. Pass it back verbatim to any /v1/inbox/conversations/{conversationId} route; do not assume a fixed format.
         */
        id?: string;
        platform?: string;
        accountId?: string;
        accountUsername?: string;
        participantId?: string;
        participantName?: string;
        participantPicture?: (string) | null;
        /**
         * X/Twitter verified badge type. Only present for Twitter/X conversations.
         */
        participantVerifiedType?: ('blue' | 'government' | 'business' | 'none') | null;
        lastMessage?: string;
        updatedTime?: string;
        status?: 'active' | 'archived';
        /**
         * Number of unread messages
         */
        unreadCount?: (number) | null;
        /**
         * Direct link to open the conversation on the platform (if available)
         */
        url?: (string) | null;
        /**
         * Instagram profile data for the participant. Only present for Instagram conversations.
         */
        instagramProfile?: {
            /**
             * Whether the participant follows your Instagram business account
             */
            isFollower?: (boolean) | null;
            /**
             * Whether your Instagram business account follows the participant
             */
            isFollowing?: (boolean) | null;
            /**
             * The participant's follower count on Instagram
             */
            followerCount?: (number) | null;
            /**
             * Whether the participant is a verified Instagram user
             */
            isVerified?: (boolean) | null;
            /**
             * When this profile data was last fetched from Instagram
             */
            fetchedAt?: (string) | null;
        } | null;
        /**
         * Click attribution for a conversation that started from a Meta ad or
         * a ref-tagged ig.me / m.me link. Absent when the conversation did not
         * originate from an attributable click.
         *
         * Captured from the referral Meta delivers for the click. If the same
         * person later arrives through a different ad or link, the original
         * values are kept, so the first referral wins; read the fresh referral
         * per click on the `message.received` / `referral.received` webhooks
         * instead. One exception on WhatsApp: when Meta omits `ctwa_clid`
         * from that referral, a later Meta automatic event can supply it and
         * refresh `ctwa_captured_at`, so treat `ctwa_captured_at` as the time
         * Zernio stored the value, not the time of the click.
         *
         * Two families of keys, one per surface. They never appear together:
         *
         * - `ctwa_*` is WhatsApp Click-to-WhatsApp. The ad ID is
         * `ctwa_source_id`. There is no `meta_ad_id` on WhatsApp.
         * - `meta_ad_*` is Instagram Click-to-Direct, Facebook Messenger
         * Click-to-Message, and ig.me / m.me ref links. The ad ID is
         * `meta_ad_id` (ad clicks only; a link capture carries
         * `meta_ad_ref` without it). `ctwa_clid` never appears on these
         * platforms.
         *
         * Every key is optional and only the keys Meta supplied are returned, so
         * read defensively. Meta does not send a campaign or ad set ID, so none
         * is exposed here. More keys may be added over time. Treat any key you
         * do not recognise as an opaque string.
         *
         * Key names differ from the `message.received` webhook on purpose. The
         * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
         * while the stored conversation record uses the prefixed names below.
         * Renaming either side would break existing integrations, so both
         * spellings are kept.
         *
         */
        metadata?: {
            /**
             * WhatsApp only. Meta's click identifier, the value to forward to the Meta Conversions API for Business Messaging. Meta omits it on some numbers, so a WhatsApp referral can arrive without it.
             */
            ctwa_clid?: string;
            /**
             * WhatsApp only. The Meta ad ID the user clicked. This is the WhatsApp equivalent of meta_ad_id.
             */
            ctwa_source_id?: string;
            /**
             * WhatsApp only. What the user clicked, as supplied by Meta (for example ad or post).
             */
            ctwa_source_type?: string;
            /**
             * WhatsApp only. Meta's URL for the ad that was clicked, normally an fb.me short link.
             */
            ctwa_source_url?: string;
            /**
             * WhatsApp only. Headline of the ad creative at click time.
             */
            ctwa_headline?: string;
            /**
             * WhatsApp only. When Zernio stored this referral. Always present when a WhatsApp referral was captured.
             */
            ctwa_captured_at?: string;
            /**
             * Instagram and Facebook only. The Meta ad ID the user clicked. Present for ad clicks; absent when the capture came from an ig.me / m.me ref link.
             */
            meta_ad_id?: string;
            /**
             * Instagram and Facebook only. Meta-supplied source identifier: ADS for ad clicks; SHORTLINK, SHORTLINKS or IGME-SOURCE-LINK for ref links (treat as opaque).
             */
            meta_ad_source?: string;
            /**
             * Instagram and Facebook only. Meta-supplied referral type, for example OPEN_THREAD.
             */
            meta_ad_type?: string;
            /**
             * Instagram and Facebook only. The ref parameter passed through from the ad creative or the ig.me / m.me link.
             */
            meta_ad_ref?: string;
            /**
             * Instagram and Facebook only. Title of the ad creative at click time.
             */
            meta_ad_title?: string;
            /**
             * Instagram and Facebook only. Image of the ad creative at click time.
             */
            meta_ad_photo_url?: string;
            /**
             * Instagram and Facebook only. Video of the ad creative at click time.
             */
            meta_ad_video_url?: string;
            /**
             * Instagram and Facebook only. The organic post the ad promoted, when the ad was a boosted post.
             */
            meta_ad_post_id?: string;
            /**
             * Instagram and Facebook only. The catalogue product the user clicked, for product ads.
             */
            meta_ad_product_id?: string;
            /**
             * Instagram and Facebook only. The Meta flow the ad launched, for flow ads.
             */
            meta_ad_flow_id?: string;
            /**
             * Instagram and Facebook only. When Zernio stored this referral. Always present when an Instagram or Facebook referral was captured.
             */
            meta_ad_captured_at?: string;
        } | null;
    }>;
    pagination?: {
        hasMore?: boolean;
        nextCursor?: (string) | null;
    };
    meta?: {
        accountsQueried?: number;
        accountsFailed?: number;
        failedAccounts?: Array<{
            accountId?: string;
            accountUsername?: (string) | null;
            platform?: string;
            error?: string;
            /**
             * Error code if available
             */
            code?: (string) | null;
            /**
             * Seconds to wait before retry (rate limits)
             */
            retryAfter?: (number) | null;
        }>;
        lastUpdated?: string;
    };
});
type ListInboxConversationsError = ({
    error?: string;
} | unknown);
type CreateInboxConversationData = {
    body: {
        /**
         * The social account ID to send from
         */
        accountId: string;
        /**
         * Recipient identifier. For X this is the numeric user ID; for WhatsApp and SMS, the recipient phone number in international format (digits, country code included); for Slack, the workspace member id (e.g. U01ABCDEF). Provide either this or participantUsername.
         */
        participantId?: string;
        /**
         * Recipient handle/username — an X or Bluesky handle (with or without @) or a Reddit username (with or without u/). Resolved via lookup. Provide either this or participantId.
         */
        participantUsername?: string;
        /**
         * Text content of the message. At least one of message, attachment, or (for WhatsApp) templateName is required. Required when category is set (a Direct Send utility message is a text message).
         */
        message?: string;
        /**
         * X/Twitter only. Skip the receives_your_dm eligibility check before sending. Use if you have already verified the recipient accepts DMs.
         */
        skipDmCheck?: boolean;
        /**
         * WhatsApp only. Name of the approved template to start the conversation with. Required for WhatsApp unless category is used instead (Direct Send). Cannot be combined with category.
         */
        templateName?: string;
        /**
         * WhatsApp only (Meta Direct Send). Combined with message and without templateName, starts the conversation with a business-initiated UTILITY message and no pre-approved template; Meta matches or auto-creates a template asynchronously. The WhatsApp Business Account must be eligible for Direct Send, otherwise the send fails with an error telling you to use an approved message template instead. Cannot be combined with templateName (templates are already categorized at creation). Utility messages only; marketing content is not allowed under this category. Accepted on the JSON body only, not on multipart requests.
         */
        category?: 'utility';
        /**
         * WhatsApp only. Set false to send the Direct Send (category: 'utility') text message without a link-preview thumbnail for the first URL in the text. Defaults to true, which is how every WhatsApp text has been sent to date. Does not apply to template sends. Accepted on the JSON body only, not on multipart requests.
         */
        linkPreview?: boolean;
        /**
         * WhatsApp only. Template language code (e.g. en_US).
         */
        templateLanguage?: string;
        /**
         * WhatsApp only. Template variable values as one flat array, in the order the variables appear across the whole template: text-header variables first, then body variables, then one value per dynamic URL button (in button order). Works with positional placeholders ({{1}}, {{2}}, ...) and with named placeholders ({{name}}, {{company}} - how Meta Business Manager creates templates), where values fill the named slots in order of appearance. Example - a body with {{1}}, {{2}} plus a URL button https://example.com/{{1}} takes three values: [body1, body2, buttonSuffix]. Media headers (image, video, document) are filled automatically from the approved template and take no value here (use headerMedia to override the header asset per send).
         */
        templateParams?: Array<(string)>;
        /**
         * WhatsApp only. Overrides a media-header template's header asset for THIS send, so a template with an image/video/document header can carry a different asset per message (e.g. each recipient their own invoice PDF). Without it, the template's approved sample asset is sent. Provide exactly one of link or id.
         */
        headerMedia?: {
            /**
             * Must match the template header's media type.
             */
            type: 'image' | 'video' | 'document';
            /**
             * Public URL of the asset to send. Must be reachable without auth.
             */
            link?: string;
            /**
             * A Meta media id (from the media upload endpoint), as an alternative to link.
             */
            id?: string;
            /**
             * Document display name shown to the recipient (e.g. "Factura 0001-123.pdf"). document type only; ignored for image/video.
             */
            filename?: string;
        };
    };
};
type CreateInboxConversationResponse = ({
    success?: boolean;
    data?: {
        /**
         * Platform message ID (dm_event_id)
         */
        messageId?: string;
        /**
         * Platform conversation ID (dm_conversation_id). For WhatsApp, this is Zernio's internal conversation id (24-character hex) which matches the id returned by the list-conversations endpoint and the conversationId in the message.received and conversation.started webhooks; use it to correlate the created thread with inbound events.
         */
        conversationId?: string;
        /**
         * Twitter numeric user ID of the recipient
         */
        participantId?: string;
        /**
         * Display name of the recipient
         */
        participantName?: (string) | null;
        /**
         * Twitter username of the recipient
         */
        participantUsername?: (string) | null;
    };
});
type CreateInboxConversationError = ({
    error?: string;
    code?: 'PLATFORM_NOT_SUPPORTED';
} | {
    error?: string;
} | unknown | {
    error?: string;
    code?: 'account_not_found' | 'PARTICIPANT_NOT_FOUND';
} | {
    error?: string;
    code?: 'DM_NOT_ALLOWED';
} | {
    error?: string;
    code?: 'rate_limited';
});
type SearchInboxConversationsData = {
    query: {
        /**
         * Filter by specific social account ID
         */
        accountId?: string;
        /**
         * Opaque pagination cursor. Pass back pagination.nextCursor verbatim; do not construct one.
         */
        cursor?: string;
        /**
         * Only match messages sent to you (incoming) or by you (outgoing). Contact-identity matching is not applied when this is set.
         */
        direction?: 'incoming' | 'outgoing';
        /**
         * Maximum number of conversations to return
         */
        limit?: number;
        /**
         * Filter by platform (searchable platforms only)
         */
        platform?: 'facebook' | 'instagram' | 'telegram' | 'whatsapp' | 'sms' | 'slack';
        /**
         * Filter by profile ID
         */
        profileId?: string;
        /**
         * Text to search for, in message content and in the contact's name, username, or phone number
         */
        query: string;
    };
};
type SearchInboxConversationsResponse = ({
    data?: Array<{
        conversation?: {
            /**
             * Conversation ID, usable with the conversation messages endpoints
             */
            id?: string;
            platform?: string;
            accountId?: string;
            participantName?: (string) | null;
            participantUsername?: (string) | null;
            participantPicture?: (string) | null;
            status?: 'active' | 'archived';
            /**
             * The conversation's most recent message preview
             */
            lastMessage?: (string) | null;
            lastMessageAt?: (string) | null;
        };
        /**
         * Number of matching messages in this conversation. 0 when the conversation matched only on contact identity (name, username, or phone number), not on message text.
         */
        matchCount?: number;
        /**
         * Up to 3 most-recent matching messages (empty for an identity-only match)
         */
        matches?: Array<{
            id?: string;
            text?: (string) | null;
            direction?: 'incoming' | 'outgoing';
            timestamp?: string;
        }>;
    }>;
    pagination?: {
        hasMore?: boolean;
        nextCursor?: (string) | null;
    };
    meta?: {
        accountsQueried?: number;
        accountsFailed?: number;
        failedAccounts?: Array<{
            accountId?: string;
            accountUsername?: (string) | null;
            platform?: string;
            error?: string;
        }>;
        lastUpdated?: string;
        /**
         * Connected messaging accounts that cannot be searched (live-fetched platforms)
         */
        accountsSkipped?: Array<{
            accountId?: string;
            platform?: string;
        }>;
    };
});
type SearchInboxConversationsError = (unknown | {
    error?: string;
});
type GetInboxConversationData = {
    path: {
        /**
         * The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
         */
        conversationId: string;
    };
    query: {
        /**
         * The social account ID
         */
        accountId: string;
    };
};
type GetInboxConversationResponse = ({
    data?: {
        id?: string;
        accountId?: string;
        accountUsername?: string;
        platform?: string;
        status?: 'active' | 'archived';
        participantName?: string;
        participantId?: string;
        /**
         * X/Twitter verified badge type. Only present for Twitter/X conversations.
         */
        participantVerifiedType?: ('blue' | 'government' | 'business' | 'none') | null;
        lastMessage?: string;
        lastMessageAt?: string;
        updatedTime?: string;
        participants?: Array<{
            id?: string;
            name?: string;
        }>;
        /**
         * Instagram profile data for the participant. Only present for Instagram conversations.
         */
        instagramProfile?: {
            /**
             * Whether the participant follows your Instagram business account
             */
            isFollower?: (boolean) | null;
            /**
             * Whether your Instagram business account follows the participant
             */
            isFollowing?: (boolean) | null;
            /**
             * The participant's follower count on Instagram
             */
            followerCount?: (number) | null;
            /**
             * Whether the participant is a verified Instagram user
             */
            isVerified?: (boolean) | null;
            /**
             * When this profile data was last fetched from Instagram
             */
            fetchedAt?: (string) | null;
        } | null;
        /**
         * Ad-click attribution for a conversation that started from a Meta ad.
         * Absent when the conversation did not originate from an ad click.
         *
         * Captured once, on the first inbound message after the click, and never
         * overwritten. If the same person later clicks a different ad, the
         * original values are kept. Meta only sends the referral on that first
         * message.
         *
         * This operation currently returns only the `meta_ad_*` family, which
         * covers Instagram Click-to-Direct and Facebook Messenger
         * Click-to-Message. WhatsApp Click-to-WhatsApp attribution (the `ctwa_*`
         * keys, where the ad ID is `ctwa_source_id`) is returned by
         * `GET /v1/inbox/conversations` instead.
         *
         * Every key is optional and only the keys Meta supplied are returned, so
         * read defensively. Meta does not send a campaign or ad set ID, so none is
         * exposed here. More keys may be added over time. Treat any key you do not
         * recognise as an opaque string.
         *
         * Key names differ from the `message.received` webhook on purpose. The
         * webhook forwards Meta's referral verbatim (`ad_id`, `source`, `type`)
         * while the stored conversation record uses the prefixed names below.
         * Renaming either side would break existing integrations, so both
         * spellings are kept.
         *
         */
        metadata?: {
            /**
             * The Meta ad ID the user clicked. Always present when a referral was captured.
             */
            meta_ad_id?: string;
            /**
             * Meta-supplied source identifier, for example ADS.
             */
            meta_ad_source?: string;
            /**
             * Meta-supplied referral type, for example OPEN_THREAD.
             */
            meta_ad_type?: string;
            /**
             * The ref parameter passed through from the ad creative.
             */
            meta_ad_ref?: string;
            /**
             * Title of the ad creative at click time.
             */
            meta_ad_title?: string;
            /**
             * Image of the ad creative at click time.
             */
            meta_ad_photo_url?: string;
            /**
             * Video of the ad creative at click time.
             */
            meta_ad_video_url?: string;
            /**
             * The organic post the ad promoted, when the ad was a boosted post.
             */
            meta_ad_post_id?: string;
            /**
             * The catalogue product the user clicked, for product ads.
             */
            meta_ad_product_id?: string;
            /**
             * The Meta flow the ad launched, for flow ads.
             */
            meta_ad_flow_id?: string;
            /**
             * When Zernio stored this referral. Always present when a referral was captured.
             */
            meta_ad_captured_at?: string;
        } | null;
    };
});
type GetInboxConversationError = ({
    error?: string;
} | unknown);
type UpdateInboxConversationData = {
    body: {
        /**
         * Social account ID
         */
        accountId: string;
        status: 'active' | 'archived';
    };
    path: {
        /**
         * The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
         */
        conversationId: string;
    };
};
type UpdateInboxConversationResponse = ({
    success?: boolean;
    data?: {
        id?: string;
        accountId?: string;
        status?: 'active' | 'archived';
        platform?: string;
        updatedAt?: string;
    };
});
type UpdateInboxConversationError = ({
    error?: string;
} | unknown);
type GetInboxConversationMessagesData = {
    path: {
        /**
         * The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
         */
        conversationId: string;
    };
    query: {
        /**
         * Social account ID
         */
        accountId: string;
        /**
         * Opaque pagination cursor. Pass `pagination.nextCursor` from a prior response verbatim: a cursor we cannot parse returns 400 rather than silently restarting from the first page.
         */
        cursor?: string;
        /**
         * Number of messages to return per page. Default 100, max 100.
         */
        limit?: number;
        /**
         * Order of returned messages. Default `asc` (oldest first, chat style).
         * Twitter, Instagram, Telegram, WhatsApp and Reddit honor this order
         * across cursor pages. For Facebook and Bluesky, only intra-page
         * ordering is affected — pages always walk newest→oldest. See
         * `sortOrderApplied` in the response.
         *
         */
        sortOrder?: 'asc' | 'desc';
    };
};
type GetInboxConversationMessagesResponse = ({
    status?: string;
    pagination?: {
        /**
         * Whether more messages are available beyond this page.
         */
        hasMore?: boolean;
        /**
         * Opaque cursor to fetch the next page. `null` on the last page.
         */
        nextCursor?: (string) | null;
    };
    /**
     * Sort order actually applied to the returned page. May
     * differ from the requested `sortOrder` for Facebook and
     * Bluesky (always `desc` regardless of request).
     *
     */
    sortOrderApplied?: 'asc' | 'desc';
    messages?: Array<{
        id?: string;
        conversationId?: string;
        accountId?: string;
        platform?: string;
        message?: string;
        senderId?: string;
        senderName?: (string) | null;
        /**
         * X/Twitter verified badge type. Only present for Twitter/X messages.
         */
        senderVerifiedType?: ('blue' | 'government' | 'business' | 'none') | null;
        direction?: 'incoming' | 'outgoing';
        createdAt?: string;
        attachments?: Array<{
            id?: string;
            type?: 'image' | 'video' | 'audio' | 'file' | 'sticker' | 'share';
            /**
             * Direct media link. On Instagram and Facebook this is a signed Meta CDN url that EXPIRES: use it now, do not store it. Persist `refreshUrl` instead.
             */
            url?: string;
            /**
             * Instagram and Facebook only. Endpoint that resolves this attachment to a working url every time, re-minting it from Meta when the stored one has expired. Safe to store and render indefinitely.
             */
            refreshUrl?: (string) | null;
            filename?: (string) | null;
            previewUrl?: (string) | null;
        }>;
        /**
         * Reddit message subject
         */
        subject?: (string) | null;
        /**
         * Instagram story reply
         */
        storyReply?: (boolean) | null;
        /**
         * Instagram story mention
         */
        isStoryMention?: (boolean) | null;
        /**
         * True if the sender has edited this message at least once.
         */
        isEdited?: boolean;
        /**
         * When the most recent edit happened.
         */
        editedAt?: (string) | null;
        /**
         * Total number of edits applied.
         */
        editCount?: number;
        /**
         * Every prior version of the message, oldest first.
         */
        editHistory?: Array<InboxMessageEditHistoryEntry>;
        /**
         * True if the sender has deleted (unsent) this message. The original message and attachments fields remain populated.
         */
        isDeleted?: boolean;
        deletedAt?: (string) | null;
        /**
         * Lifecycle status for outgoing messages. Not all platforms emit every state (see webhook support matrix).
         */
        deliveryStatus?: ('sent' | 'delivered' | 'read' | 'failed' | 'deleted') | null;
        deliveredAt?: (string) | null;
        readAt?: (string) | null;
        /**
         * Original send time for outgoing messages (used for Messenger watermark queries).
         */
        sentAt?: (string) | null;
        /**
         * Populated when deliveryStatus === "failed".
         */
        deliveryError?: {
            code?: number;
            title?: string;
            message?: string;
        } | null;
        /**
         * Emoji reactions on this message (WhatsApp / Telegram). At most one per party in a 1:1 thread.
         */
        reactions?: Array<{
            emoji?: string;
            /**
             * true if the connected account reacted, false if the contact did.
             */
            fromMe?: boolean;
            reactedAt?: string;
        }>;
        /**
         * Platform-specific extras. Free-form, but commonly includes:
         * `quotedMessageId` (platformMessageId this message replies to),
         * `waInteractive` (a compact descriptor of WhatsApp interactive
         * content sent: buttons / list / cta_url / flow / location_request),
         * and for inbound interactive taps `interactiveType` / `interactiveId`.
         *
         */
        metadata?: {
            [key: string]: unknown;
        };
    }>;
    lastUpdated?: string;
});
type GetInboxConversationMessagesError = (ErrorResponse | {
    error?: string;
} | unknown);
type SendInboxMessageData = {
    body: {
        /**
         * Social account ID
         */
        accountId: string;
        /**
         * Message text
         */
        message?: string;
        /**
         * URL of the attachment to send (image, video, audio, or file). The URL must be publicly accessible. For binary file uploads, use multipart/form-data instead. On WhatsApp, combining an image, video, or file with `buttons` renders the media as the header of one interactive reply-button message; audio cannot be combined with buttons.
         */
        attachmentUrl?: string;
        /**
         * WhatsApp only (Meta Direct Send). Sends this message as a business-initiated UTILITY message without an approved template, for example outside the 24-hour customer service window; Meta matches or auto-creates a template asynchronously. The WhatsApp Business Account must be eligible for Direct Send, otherwise the send fails with an error telling you to use an approved message template instead. Supported only for text messages (link preview ok) and interactive messages (reply buttons, CTA URL buttons, voice-call button, header of text/image/video/document). Cannot be combined with template, attachments, location, or contacts. Utility messages only; marketing content is not allowed under this category. Accepted on the JSON body only, not on multipart requests.
         */
        category?: 'utility';
        /**
         * WhatsApp only. Set false to send the message without a link-preview thumbnail for the first URL in the text. Defaults to true, which is how every WhatsApp text has been sent to date. Ignored on other platforms. Accepted on the JSON body only, not on multipart requests.
         */
        linkPreview?: boolean;
        /**
         * Type of attachment. Defaults to file if not specified.
         */
        attachmentType?: 'image' | 'video' | 'audio' | 'file';
        /**
         * WhatsApp only. Display name for a document sent via attachmentUrl with attachmentType: file (e.g. "Report.pdf"). Maps to the recipient's file name; without it WhatsApp derives the name from the URL and shows "Untitled". Ignored for image/video/audio and for binary uploads (which use the uploaded file's name).
         */
        attachmentName?: string;
        /**
         * WhatsApp only. When `true` on an audio attachment, the message is sent
         * as a voice message (PTT) — the recipient sees the waveform + voice-note
         * UI instead of a basic audio attachment. The audio file MUST be `.ogg`
         * encoded with the OPUS codec (mono) per Meta's voice-message contract;
         * other formats are rejected by WhatsApp. Ignored for non-audio attachments.
         *
         */
        voiceNote?: boolean;
        /**
         * Quick reply buttons. Mutually exclusive with buttons. Max 13 items.
         */
        quickReplies?: Array<{
            /**
             * Button label (max 20 chars)
             */
            title: string;
            /**
             * Payload sent back on tap
             */
            payload: string;
            /**
             * Optional icon URL (Meta only)
             */
            imageUrl?: string;
        }>;
        /**
         * Action buttons. Mutually exclusive with quickReplies. Max 3 items.
         *
         * Instagram / Facebook: also mutually exclusive with `template`.
         * A Meta message carries one body shape, so sending both is a 400
         * rather than a silent drop of the buttons.
         *
         * WhatsApp: buttons always render as interactive reply buttons.
         * Only `title` and `payload` are used — `type`, `url`, and `phone`
         * are ignored (WhatsApp has no URL/phone button in this field; use
         * the `interactive` field with `type: cta_url` for a link button).
         * `payload` becomes the button reply ID delivered on the
         * `message.received` webhook when the user taps. To send a simple
         * reply-button message, provide `title` + `payload` and set
         * `type: postback`, e.g.
         * `{ "type": "postback", "title": "Yes", "payload": "yes" }`.
         *
         * Combine `buttons` with `attachmentUrl` and `attachmentType`
         * `image`, `video`, or `file` to render one WhatsApp message with
         * a media header, body text, and reply buttons. Audio is not a
         * supported interactive header and returns 400 when combined
         * with buttons.
         *
         */
        buttons?: Array<{
            /**
             * Button type. phone is Facebook only. Ignored on WhatsApp (buttons always render as reply buttons).
             */
            type: 'url' | 'postback' | 'phone';
            /**
             * Button label (max 20 chars)
             */
            title: string;
            /**
             * URL for url-type buttons (Facebook/Instagram only)
             */
            url?: string;
            /**
             * Payload for postback-type buttons. On WhatsApp, this is the reply ID returned on the message.received webhook when the button is tapped.
             */
            payload?: string;
            /**
             * Phone number for phone-type buttons (Facebook only)
             */
            phone?: string;
        }>;
        /**
         * Platform-dependent template payload. Ignored on Telegram.
         *
         * Instagram / Facebook: a generic template (carousel). Set `type: generic`
         * and provide up to 10 `elements`, each with a `title` (required) and
         * optional `subtitle`, `imageUrl`, and `buttons`. Mutually exclusive with
         * the top-level `buttons` field (sending both is a 400); put the card's
         * buttons on its `elements` instead.
         *
         * WhatsApp: sends an approved WhatsApp template message, the only message
         * type WhatsApp accepts when the 24-hour customer-service window is closed.
         * Provide exactly one element carrying the template reference:
         * `{ "elements": [{ "name": "order_update", "language": "en_US", "components": [...] }] }`
         * (`type` is ignored on WhatsApp). `components` is optional and is forwarded
         * unchanged as the `template.components` array of Meta's Cloud API send
         * payload; use it to fill body/header variables and button parameters, e.g.
         * `[{ "type": "body", "parameters": [{ "type": "text", "text": "John" }] }]`.
         * Templates with media headers (image, video, document) must include the
         * header component with its media link here at send time. To send a template
         * to a phone number with no existing conversation, or to have media headers
         * filled in automatically from the template definition, use the
         * create-conversation endpoint (POST /v1/inbox/conversations) instead.
         *
         */
        template?: {
            /**
             * Template type. Required for Instagram/Facebook generic templates; ignored on WhatsApp.
             */
            type?: 'generic';
            elements?: Array<{
                /**
                 * Element title (max 80 chars). Required for Instagram/Facebook generic templates.
                 */
                title?: string;
                /**
                 * Element subtitle (Instagram/Facebook only)
                 */
                subtitle?: string;
                /**
                 * Element image URL (Instagram/Facebook only)
                 */
                imageUrl?: string;
                /**
                 * Element buttons (Instagram/Facebook only)
                 */
                buttons?: Array<{
                    type?: 'url' | 'postback';
                    title?: string;
                    url?: string;
                    payload?: string;
                }>;
                /**
                 * WhatsApp only. Name of the approved template to send.
                 */
                name?: string;
                /**
                 * WhatsApp only. Template language code (e.g. en_US).
                 */
                language?: string;
                /**
                 * WhatsApp only. Meta Cloud API send-shape components array, forwarded to Meta verbatim.
                 */
                components?: Array<{
                    [key: string]: unknown;
                }>;
            }>;
        };
        /**
         * WhatsApp-only. Rich interactive payload for list messages, CTA URL
         * buttons, Flow prompts, location requests, voice-call buttons, and
         * commerce messages (single product, product list, catalog, and
         * carousel). When set, takes priority over `buttons` and
         * `quickReplies`. The shape mirrors Meta's Cloud API `interactive`
         * object verbatim, so any payload that works against Meta directly
         * will also work here.
         *
         * Use `buttons` / `quickReplies` for simple button replies
         * (WhatsApp's `interactive.type: "button"`): the abstraction caps at
         * 3 buttons and handles the auto-conversion for you. Use this field
         * only for the types listed in the enum below.
         *
         * All interactive messages are session messages: they can only be
         * sent inside the 24-hour customer service window opened by the
         * user's last inbound message.
         *
         * Commerce types (`product`, `product_list`, `catalog_message`, and
         * product carousels) require a Meta catalog connected to the
         * WhatsApp Business Account in Commerce Manager. Media carousels
         * (image/video cards) do not need a catalog.
         *
         * For `product`, `body` is optional (WhatsApp renders the product
         * card itself) and `header` is not allowed (the product image is
         * the header). For `product_list`, a `header` with `type: "text"`
         * is required. For `carousel`, top-level `header`/`footer` are not
         * supported; media goes on each card instead.
         *
         * For `voice_call`, the message renders WhatsApp's native call
         * button; tapping it starts a voice call to your business number.
         * Requires WhatsApp Business Calling to be enabled on the sending
         * number. The optional `parameters.payload` string is echoed back on
         * the `calls` webhook (as `cta_payload`) for attribution.
         *
         * For `location_request_message`, `action` may be omitted (we default
         * it to `{ "name": "send_location" }`). WhatsApp renders a localized
         * "Send location" button; the user's reply arrives as a regular
         * location message in the conversation.
         *
         * For `request_contact_info`, `action` may be omitted (we default it
         * to `{ "name": "request_contact_info" }`). WhatsApp renders a
         * localized share button that cannot be relabelled, so put the reason
         * for asking in `body.text`: this is a consent prompt, and a bare
         * request converts badly. The reply arrives as an inbound `contacts`
         * message with `metadata.contactsOrigin` set to `contact_request`,
         * and we fold the shared number back into the contact automatically.
         * A `contacts` message with origin `other` is a card the user picked
         * from their address book and is NOT proof of their own number.
         *
         * For `catalog_message`, `action` may also be omitted (we default it
         * to `{ "name": "catalog_message" }`).
         *
         * Tap events come back via the `message.received` webhook with
         * `metadata.interactiveType` set to `list_reply` or `nfm_reply`.
         * Carts submitted from commerce messages arrive as `metadata.order`;
         * product inquiries arrive as `metadata.referredProduct`.
         *
         */
        interactive?: {
            /**
             * Which interactive layout to render.
             */
            type: 'list' | 'cta_url' | 'flow' | 'location_request_message' | 'request_contact_info' | 'voice_call' | 'product' | 'product_list' | 'catalog_message' | 'carousel';
            /**
             * Optional header shown above the body. Required with
             * `type: "text"` for `product_list`; not allowed for `product`
             * or `carousel`.
             *
             */
            header?: {
                type?: 'text' | 'image' | 'video' | 'document';
                /**
                 * Required when header type is text.
                 */
                text?: string;
                image?: {
                    link?: string;
                };
                video?: {
                    link?: string;
                };
                document?: {
                    link?: string;
                };
            };
            /**
             * Required for every type except `product`, where it is optional.
             */
            body?: {
                /**
                 * Main body text.
                 */
                text: string;
            };
            /**
             * Optional footer shown below the action.
             */
            footer?: {
                text?: string;
            };
            action?: ({
                /**
                 * CTA label that opens the list (max ~20 chars).
                 */
                button: string;
                /**
                 * 1-10 sections. Total rows across all sections cannot exceed 10.
                 */
                sections: Array<{
                    /**
                     * Optional section header (max 24 chars).
                     */
                    title?: string;
                    rows: Array<{
                        /**
                         * Identifier returned in the webhook as metadata.interactiveId (max 200 chars).
                         */
                        id: string;
                        /**
                         * Row label (max 24 chars).
                         */
                        title: string;
                        /**
                         * Optional description below the title (max 72 chars).
                         */
                        description?: string;
                    }>;
                }>;
            } | {
                name: 'cta_url';
                parameters: {
                    /**
                     * Button label (max 20 chars).
                     */
                    display_text: string;
                    /**
                     * Target URL opened when the user taps the button.
                     */
                    url: string;
                };
            } | {
                name: 'voice_call';
                /**
                 * All optional.
                 */
                parameters?: {
                    /**
                     * Button label. Defaults to "Call Now".
                     */
                    display_text?: string;
                    /**
                     * How long the button stays tappable. Defaults to 10080 (7 days).
                     */
                    ttl_minutes?: number;
                    /**
                     * Arbitrary string echoed back as `cta_payload` on the `calls` webhook (connect/terminate) for attribution.
                     */
                    payload?: string;
                };
            } | {
                name: 'flow';
                parameters: {
                    /**
                     * Defaults to "3" when omitted.
                     */
                    flow_message_version?: '3';
                    /**
                     * Opaque token you choose to correlate Flow responses with your own state (max 200 chars).
                     */
                    flow_token: string;
                    /**
                     * Published Flow ID from Meta Business Manager.
                     */
                    flow_id: string;
                    /**
                     * Button label that opens the Flow (max 20 chars).
                     */
                    flow_cta: string;
                    /**
                     * `navigate` sends the user to `flow_action_payload.screen`; `data_exchange` posts data to your Flow endpoint.
                     */
                    flow_action: 'navigate' | 'data_exchange';
                    /**
                     * Required when flow_action is `navigate`.
                     */
                    flow_action_payload?: {
                        /**
                         * First screen to show.
                         */
                        screen?: string;
                        /**
                         * Optional pre-filled data passed to the screen.
                         */
                        data?: {
                            [key: string]: unknown;
                        };
                    };
                    /**
                     * Set to `draft` to test an unpublished Flow.
                     */
                    mode?: 'draft';
                };
            } | {
                name: 'send_location';
            } | {
                name: 'request_contact_info';
            } | {
                /**
                 * Meta catalog ID connected to the WhatsApp Business Account.
                 */
                catalog_id: string;
                /**
                 * Retailer ID (SKU) of the product inside the catalog.
                 */
                product_retailer_id: string;
            } | {
                /**
                 * Meta catalog ID connected to the WhatsApp Business Account.
                 */
                catalog_id: string;
                /**
                 * 1-10 sections. Total products across all sections cannot exceed 30.
                 */
                sections: Array<{
                    /**
                     * Optional section header.
                     */
                    title?: string;
                    product_items: Array<{
                        /**
                         * Retailer ID (SKU) of the product inside the catalog.
                         */
                        product_retailer_id: string;
                    }>;
                }>;
            } | {
                name: 'catalog_message';
                parameters?: {
                    /**
                     * Optional product whose image is used as the message thumbnail. Falls back to the first catalog item when omitted.
                     */
                    thumbnail_product_retailer_id?: string;
                };
            } | {
                cards: Array<{
                    /**
                     * Card position. Auto-filled sequentially when omitted.
                     */
                    card_index?: number;
                    /**
                     * `product` for a product card; media cards use `cta_url` or a quick-reply type.
                     */
                    type?: string;
                    /**
                     * Media cards only, required. Carries the card's image or video.
                     */
                    header?: {
                        [key: string]: unknown;
                    };
                    /**
                     * Optional card body text.
                     */
                    body?: {
                        [key: string]: unknown;
                    };
                    /**
                     * Product cards: `{ catalog_id, product_retailer_id }` (required). Media cards: the card's button action (e.g. `cta_url` with `parameters.display_text` and `parameters.url`).
                     */
                    action?: {
                        [key: string]: unknown;
                    };
                    [key: string]: unknown | number | string;
                }>;
            });
        };
        /**
         * Telegram-native keyboard markup. Ignored on other platforms.
         */
        replyMarkup?: {
            /**
             * Keyboard type
             */
            type?: 'inline_keyboard' | 'reply_keyboard';
            /**
             * Array of rows, each row is an array of buttons
             */
            keyboard?: Array<Array<{
                /**
                 * Button text
                 */
                text?: string;
                /**
                 * Callback data (inline_keyboard only, max 64 bytes)
                 */
                callbackData?: string;
                /**
                 * URL to open (inline_keyboard only)
                 */
                url?: string;
            }>>;
            /**
             * Hide keyboard after use (reply_keyboard only)
             */
            oneTime?: boolean;
        };
        /**
         * Facebook messaging type. Required when using messageTag.
         */
        messagingType?: 'RESPONSE' | 'UPDATE' | 'MESSAGE_TAG';
        /**
         * Facebook message tag for messaging outside 24h window. Requires messagingType MESSAGE_TAG. Instagram only supports HUMAN_AGENT.
         */
        messageTag?: 'CONFIRMED_EVENT_UPDATE' | 'POST_PURCHASE_UPDATE' | 'ACCOUNT_UPDATE' | 'HUMAN_AGENT';
        /**
         * Platform message ID to quote-reply to. For WhatsApp, pass the wamid; for Telegram, the Telegram message ID (both available in message.platformMessageId from webhooks or the list-messages endpoint). On Slack it threads the reply (thread_ts) instead of quoting. Silently ignored on platforms without send-side reply support, including Instagram and Facebook Messenger (Meta's Send API rejects reply_to on Instagram and does not expose it on Messenger).
         */
        replyTo?: string;
        /**
         * WhatsApp-only. Send a location pin.
         */
        location?: {
            /**
             * Latitude in decimal degrees.
             */
            latitude: number;
            /**
             * Longitude in decimal degrees.
             */
            longitude: number;
            /**
             * Optional location name.
             */
            name?: string;
            /**
             * Optional street address.
             */
            address?: string;
        };
        /**
         * WhatsApp-only. Send one or more contact cards.
         */
        contacts?: Array<{
            name: {
                /**
                 * Full display name.
                 */
                formatted_name: string;
                first_name?: string;
                last_name?: string;
            };
            phones?: Array<{
                phone?: string;
                /**
                 * e.g. CELL, WORK, HOME.
                 */
                type?: string;
            }>;
            emails?: Array<{
                email?: string;
                type?: string;
            }>;
        }>;
    };
    headers?: {
        /**
         * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
         */
        'Idempotency-Key'?: string;
    };
    path: {
        /**
         * Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
         */
        conversationId: string;
    };
};
type SendInboxMessageResponse = ({
    success?: boolean;
    data?: {
        /**
         * Platform id of the sent message (not returned for Reddit). For WhatsApp this is the raw Meta wamid, the same id delivered as message.platformMessageId on webhooks and delivery-status updates, and the value to pass as replyTo to quote-reply.
         */
        messageId?: string;
        /**
         * Zernio conversation id, echoed so the thread can be read back or replied to. It equals the id the list-conversations endpoint returns for Telegram, WhatsApp, SMS and Slack; for Facebook, Instagram, Bluesky and Reddit that endpoint returns the platform thread id instead, so do not correlate the two by equality. For X (Twitter), when the request addressed the conversation by its Twitter dm_conversation_id, that platform id is echoed back instead. Omitted when the send succeeded but the conversation could not be resolved to a stored record.
         */
        conversationId?: string;
        /**
         * Echo of the sent attachment with its resolved public URL, when one is available (Facebook, Instagram, Telegram, WhatsApp).
         */
        attachments?: Array<{
            type?: string;
            url?: string;
        }>;
    };
});
type SendInboxMessageError = ({
    error?: string;
    /**
     * Stable machine-readable reason. PLATFORM_LIMITATION covers a capability the platform does not offer (e.g. Bluesky and Reddit DMs reject media); MISSING_PARTICIPANT means the stored conversation has no recipient to send to.
     */
    code?: 'PLATFORM_LIMITATION' | 'MISSING_PARTICIPANT';
    /**
     * Instagram/Facebook only. Meta's own diagnostic fields for the rejected send, passed through verbatim so you can tell failure classes apart and quote them to Meta. Absent when the failure did not come from Meta.
     */
    platformError?: {
        /**
         * Meta error code
         */
        code?: number;
        /**
         * Meta error_subcode
         */
        subcode?: number;
        /**
         * Meta fbtrace_id, quote this in a Meta bug report
         */
        fbtraceId?: string;
        /**
         * Meta error type (e.g. OAuthException)
         */
        type?: string;
    };
} | {
    error?: string;
} | unknown);
type GetWhatsAppMediaData = {
    path: {
        /**
         * The media id from `attachments[].payload.id`.
         */
        mediaId: string;
    };
    query: {
        /**
         * The WhatsApp account that received the media.
         */
        accountId: string;
    };
};
type GetWhatsAppMediaResponse = ((Blob | File));
type GetWhatsAppMediaError = (unknown | {
    error?: string;
});
type EditInboxMessageData = {
    body: {
        /**
         * Social account ID
         */
        accountId: string;
        /**
         * New message text
         */
        text?: string;
        /**
         * New inline keyboard markup
         */
        replyMarkup?: {
            type?: 'inline_keyboard';
            keyboard?: Array<Array<{
                text?: string;
                callbackData?: string;
                url?: string;
            }>>;
        };
    };
    path: {
        /**
         * The conversation ID
         */
        conversationId: string;
        /**
         * The Telegram message ID to edit
         */
        messageId: string;
    };
};
type EditInboxMessageResponse = ({
    success?: boolean;
    data?: {
        messageId?: number;
    };
});
type EditInboxMessageError = (unknown | {
    error?: string;
});
type DeleteInboxMessageData = {
    path: {
        /**
         * The conversation ID
         */
        conversationId: string;
        /**
         * The platform message ID to delete
         */
        messageId: string;
    };
    query: {
        /**
         * Social account ID
         */
        accountId: string;
    };
};
type DeleteInboxMessageResponse = ({
    success?: boolean;
});
type DeleteInboxMessageError = (unknown | {
    error?: string;
});
type SendTypingIndicatorData = {
    body: {
        /**
         * Social account ID
         */
        accountId: string;
    };
    path: {
        /**
         * The conversation ID
         */
        conversationId: string;
    };
};
type SendTypingIndicatorResponse = ({
    success?: boolean;
});
type SendTypingIndicatorError = (ErrorResponse | {
    error?: string;
} | unknown);
type MarkConversationReadData = {
    body: {
        /**
         * Social account ID
         */
        accountId: string;
    };
    path: {
        /**
         * The conversation ID
         */
        conversationId: string;
    };
};
type MarkConversationReadResponse = ({
    success?: boolean;
    /**
     * Number of messages marked read by this call
     */
    markedCount?: number;
});
type MarkConversationReadError = ({
    error?: string;
} | unknown);
type AddMessageReactionData = {
    body: {
        /**
         * Social account ID
         */
        accountId: string;
        /**
         * Emoji character (e.g. "👍", "❤️")
         */
        emoji: string;
    };
    path: {
        /**
         * The conversation ID
         */
        conversationId: string;
        /**
         * The platform message ID to react to
         */
        messageId: string;
    };
};
type AddMessageReactionResponse = ({
    success?: boolean;
});
type AddMessageReactionError = (unknown | {
    error?: string;
});
type RemoveMessageReactionData = {
    path: {
        /**
         * The conversation ID
         */
        conversationId: string;
        /**
         * The platform message ID
         */
        messageId: string;
    };
    query: {
        /**
         * Social account ID
         */
        accountId: string;
    };
};
type RemoveMessageReactionResponse = ({
    success?: boolean;
});
type RemoveMessageReactionError = (unknown | {
    error?: string;
});
type UploadMediaDirectData = {
    body: {
        /**
         * The file to upload (max 25MB)
         */
        file: (Blob | File);
        /**
         * Override MIME type (e.g. "image/jpeg"). Auto-detected from file if not provided.
         */
        contentType?: string;
    };
};
type UploadMediaDirectResponse = ({
    /**
     * Publicly accessible URL for the uploaded file
     */
    url?: string;
    /**
     * Generated unique filename
     */
    filename?: string;
    /**
     * MIME type of the file
     */
    contentType?: string;
    /**
     * File size in bytes
     */
    size?: number;
});
type UploadMediaDirectError = (unknown | {
    error?: string;
});
type GetMessengerMenuData = {
    path: {
        accountId: string;
    };
};
type GetMessengerMenuResponse = ({
    data?: Array<{
        [key: string]: unknown;
    }>;
});
type GetMessengerMenuError = (unknown | {
    error?: string;
});
type SetMessengerMenuData = {
    body: {
        /**
         * Persistent menu configuration array (Meta format)
         */
        persistent_menu: Array<{
            [key: string]: unknown;
        }>;
    };
    path: {
        accountId: string;
    };
};
type SetMessengerMenuResponse = (unknown);
type SetMessengerMenuError = (unknown | {
    error?: string;
});
type DeleteMessengerMenuData = {
    path: {
        accountId: string;
    };
};
type DeleteMessengerMenuResponse = (unknown);
type DeleteMessengerMenuError = (ErrorResponse | {
    error?: string;
});
type GetInstagramIceBreakersData = {
    path: {
        accountId: string;
    };
};
type GetInstagramIceBreakersResponse = ({
    data?: Array<{
        [key: string]: unknown;
    }>;
});
type GetInstagramIceBreakersError = (unknown | {
    error?: string;
});
type SetInstagramIceBreakersData = {
    body: {
        ice_breakers: Array<{
            question: string;
            payload: string;
        }>;
    };
    path: {
        accountId: string;
    };
};
type SetInstagramIceBreakersResponse = (unknown);
type SetInstagramIceBreakersError = (unknown | {
    error?: string;
});
type DeleteInstagramIceBreakersData = {
    path: {
        accountId: string;
    };
};
type DeleteInstagramIceBreakersResponse = (unknown);
type DeleteInstagramIceBreakersError = (ErrorResponse | {
    error?: string;
});
type GetTelegramCommandsData = {
    path: {
        accountId: string;
    };
};
type GetTelegramCommandsResponse = ({
    data?: Array<{
        command?: string;
        description?: string;
    }>;
});
type GetTelegramCommandsError = (unknown | {
    error?: string;
});
type SetTelegramCommandsData = {
    body: {
        commands: Array<{
            /**
             * Bot command without leading slash
             */
            command: string;
            /**
             * Command description
             */
            description: string;
        }>;
    };
    path: {
        accountId: string;
    };
};
type SetTelegramCommandsResponse = (unknown);
type SetTelegramCommandsError = (unknown | {
    error?: string;
});
type DeleteTelegramCommandsData = {
    path: {
        accountId: string;
    };
};
type DeleteTelegramCommandsResponse = (unknown);
type DeleteTelegramCommandsError = (ErrorResponse | {
    error?: string;
});
type GetMessageAttachmentData = {
    path: {
        /**
         * The conversation ID (Zernio id or platform conversation id)
         */
        conversationId: string;
        /**
         * Zero-based position of the attachment in the message's attachments array
         */
        index: number;
        /**
         * The message id as returned by the list-messages endpoint (the platform message id)
         */
        messageId: string;
    };
    query: {
        /**
         * Social account ID
         */
        accountId: string;
        /**
         * `redirect` (default) answers 302 to the media; `json` returns the url in the body
         */
        format?: 'redirect' | 'json';
    };
};
type GetMessageAttachmentResponse = ({
    status?: string;
    /**
     * Live media url. Short-lived; re-request this endpoint rather than storing it.
     */
    url?: string;
    /**
     * True when the stored url had expired and was re-minted from the platform.
     */
    refreshed?: boolean;
});
type GetMessageAttachmentError = (unknown | ErrorResponse | {
    error?: string;
});
type ListInboxCommentsData = {
    query?: {
        /**
         * Filter by specific social account ID
         */
        accountId?: string;
        cursor?: string;
        limit?: number;
        /**
         * Minimum comment count
         */
        minComments?: number;
        /**
         * Filter by platform. `metaads` is a synthetic value meaning the user's ads (boosted/dark posts) only; `facebook`/`instagram` return organic posts only.
         */
        platform?: 'facebook' | 'instagram' | 'twitter' | 'bluesky' | 'threads' | 'youtube' | 'linkedin' | 'reddit' | 'metaads';
        /**
         * Filter by profile ID
         */
        profileId?: string;
        /**
         * Posts created after this date
         */
        since?: string;
        /**
         * Sort field
         */
        sortBy?: 'date' | 'comments';
        /**
         * Sort order
         */
        sortOrder?: 'asc' | 'desc';
    };
};
type ListInboxCommentsResponse = ({
    data?: Array<{
        id?: string;
        platform?: string;
        accountId?: string;
        accountUsername?: string;
        /**
         * The post text/caption. On ad rows (isAd: true) this is the AD NAME, not the underlying post's caption — the creative text isn't exposed here.
         */
        content?: string;
        /**
         * Post media thumbnail. On ad rows this is the ad creative thumbnail.
         */
        picture?: (string) | null;
        /**
         * Public URL of the post. On ad rows: the Facebook dark-post URL (facebook placement) or the IG media permalink (instagram placement); may be null when unknown.
         */
        permalink?: (string) | null;
        createdTime?: string;
        commentCount?: number;
        /**
         * Not fetched for ad rows (always 0 there).
         */
        likeCount?: number;
        /**
         * Bluesky content identifier
         */
        cid?: (string) | null;
        /**
         * Reddit subreddit name
         */
        subreddit?: (string) | null;
        /**
         * True when this row is an ad (boosted/dark post). `platform` is then the placement (facebook = the Page dark post / instagram = the IG media), `id` is `{adId}:{placement}`, and the thread is at GET /v1/ads/{adId}/comments?placement={placement}.
         */
        isAd?: boolean;
        /**
         * Internal Zernio ad id — only on ad rows.
         */
        adId?: string;
        /**
         * Which side of the ad this row's comments are on — only on ad rows.
         */
        placement?: 'facebook' | 'instagram';
    }>;
    pagination?: {
        hasMore?: boolean;
        nextCursor?: (string) | null;
    };
    meta?: {
        accountsQueried?: number;
        accountsFailed?: number;
        failedAccounts?: Array<{
            accountId?: string;
            accountUsername?: (string) | null;
            platform?: string;
            error?: string;
            /**
             * Error code if available
             */
            code?: (string) | null;
            /**
             * Seconds to wait before retry (rate limits)
             */
            retryAfter?: (number) | null;
        }>;
        lastUpdated?: string;
    };
});
type ListInboxCommentsError = ({
    error?: string;
} | unknown);
type GetInboxPostCommentsData = {
    path: {
        /**
         * Zernio post ID or platform-specific post ID. Zernio IDs are auto-resolved. LinkedIn third-party posts accept full activity URN or numeric ID. On Facebook and Instagram, a comment ID is also accepted here and returns that comment's replies.
         */
        postId: string;
    };
    query: {
        accountId: string;
        /**
         * (Reddit only) Get replies to a specific comment
         */
        commentId?: string;
        /**
         * Pagination cursor, returned by a previous call as `pagination.cursor`. This is the platform's own opaque paging value passed through verbatim: never construct, decode or validate it client-side.
         */
        cursor?: string;
        /**
         * Maximum number of comments to return
         */
        limit?: number;
        /**
         * (Reddit only) Subreddit name
         */
        subreddit?: string;
    };
};
type GetInboxPostCommentsResponse = ({
    status?: string;
    comments?: Array<{
        id?: string;
        message?: string;
        createdTime?: string;
        from?: {
            id?: string;
            name?: string;
            username?: string;
            picture?: (string) | null;
            isOwner?: boolean;
            /**
             * X/Twitter verified badge type. Only present for Twitter/X comments.
             */
            verifiedType?: ('blue' | 'government' | 'business' | 'none') | null;
        };
        likeCount?: number;
        /**
         * The platform's own reply count, which includes hidden and deleted replies. Can exceed replies[].length even when repliesHasMore is false or absent.
         */
        replyCount?: number;
        /**
         * The platform this comment is from
         */
        platform?: string;
        /**
         * Direct link to the comment on the platform (if available)
         */
        url?: (string) | null;
        replies?: Array<{
            [key: string]: unknown;
        }>;
        /**
         * Facebook only. True when replies[] (capped at 10) does not hold the comment's full reply thread; fetch the rest by passing the comment id as postId to GET /v1/inbox/comments/{postId}. Absent (not false) on every other platform, including Instagram, which has no equivalent signal.
         */
        repliesHasMore?: boolean;
        canReply?: boolean;
        canDelete?: boolean;
        /**
         * Whether this comment can be hidden (Facebook, Instagram, Threads)
         */
        canHide?: boolean;
        /**
         * Whether this comment can be liked (Facebook, Twitter/X, Bluesky, Reddit)
         */
        canLike?: boolean;
        /**
         * Whether the comment is currently hidden
         */
        isHidden?: boolean;
        /**
         * Whether the current user has liked this comment
         */
        isLiked?: boolean;
        /**
         * Bluesky like URI for unliking
         */
        likeUri?: (string) | null;
        /**
         * Bluesky content identifier
         */
        cid?: (string) | null;
        /**
         * ID of the parent comment. Present on entries inside replies[] for Facebook, Instagram and X/Twitter. On X/Twitter it is also present on top-level entries, where it holds the ID of the post replied to. Omitted entirely (key absent, not null) on top-level Facebook and Instagram entries and on every other platform, which express the parent relationship only through replies[] nesting.
         */
        parentId?: (string) | null;
        /**
         * Bluesky root post URI
         */
        rootUri?: (string) | null;
        /**
         * Bluesky root post CID
         */
        rootCid?: (string) | null;
    }>;
    /**
     * (Reddit only) Metadata for the target post, returned alongside the comments in Reddit's
     * single round-trip. Lets integrators render a preview of the post the user is commenting on
     * without an additional request. Absent for non-Reddit platforms and when the upstream
     * response is missing the post listing (deleted post, malformed response).
     *
     */
    post?: {
        /**
         * Reddit post base36 id (e.g. "1tjtj26")
         */
        id?: string;
        /**
         * Fullname with type prefix (e.g. "t3_1tjtj26")
         */
        fullname?: string;
        title?: string;
        /**
         * Body text for self-posts (empty for link posts)
         */
        selftext?: string;
        /**
         * Reddit username, without the u/ prefix
         */
        author?: string;
        /**
         * Subreddit name, without the r/ prefix
         */
        subreddit?: string;
        /**
         * Absolute URL to the post on reddit.com
         */
        permalink?: string;
        /**
         * For link posts, the external URL; for self-posts, the Reddit permalink
         */
        url?: string;
        /**
         * Net upvotes (upvotes minus downvotes)
         */
        score?: number;
        numComments?: number;
        /**
         * Unix timestamp in seconds
         */
        createdUtc?: number;
        over18?: boolean;
        stickied?: boolean;
        /**
         * Link flair text if any
         */
        flairText?: (string) | null;
        /**
         * True if the post is a Reddit gallery (multiple images)
         */
        isGallery?: boolean;
    } | null;
    pagination?: {
        hasMore?: boolean;
        /**
         * Only present when hasMore is true. Absent on the last page, so treat its absence as the end of the thread.
         */
        cursor?: (string) | null;
    };
    meta?: {
        platform?: string;
        postId?: string;
        accountId?: string;
        /**
         * (Reddit only) Subreddit name
         */
        subreddit?: (string) | null;
        lastUpdated?: string;
        /**
         * (Facebook/Instagram only) Present when this post has no organic comments but is a boosted post — the engagement lives on the ad. Use the ad-comments endpoint instead.
         */
        adComments?: {
            /**
             * Internal Zernio ad ID
             */
            adId?: string;
            /**
             * Path to fetch the ad's comments (GET /v1/ads/{adId}/comments)
             */
            adCommentsUrl?: string;
        } | null;
    };
});
type GetInboxPostCommentsError = (unknown | {
    error?: string;
} | ErrorResponse);
type ReplyToInboxPostData = {
    body: {
        accountId: string;
        message: string;
        /**
         * (Facebook only) URL of an image to attach, publishing a photo comment alongside the text. The URL must be publicly accessible so Meta can fetch it. Returns 400 for other platforms.
         */
        attachmentUrl?: string;
        /**
         * Reply to specific comment (optional)
         */
        commentId?: string;
        /**
         * (Bluesky only) Parent content identifier
         */
        parentCid?: string;
        /**
         * (Bluesky only) Root post URI
         */
        rootUri?: string;
        /**
         * (Bluesky only) Root post CID
         */
        rootCid?: string;
    };
    path: {
        /**
         * Zernio post ID or platform-specific post ID. LinkedIn third-party posts accept full activity URN or numeric ID.
         */
        postId: string;
    };
};
type ReplyToInboxPostResponse = ({
    success?: boolean;
    data?: {
        commentId?: string;
        isReply?: boolean;
        /**
         * Bluesky CID
         */
        cid?: (string) | null;
    };
});
type ReplyToInboxPostError = (unknown | {
    error?: string;
} | ErrorResponse);
type DeleteInboxCommentData = {
    path: {
        /**
         * Zernio post ID or platform-specific post ID. LinkedIn third-party posts accept full activity URN or numeric ID.
         */
        postId: string;
    };
    query: {
        accountId: string;
        /**
         * For LinkedIn, accepts either the numeric comment ID or the composite comment URN returned by the comments listing (e.g. urn:li:comment:(threadUrn,id))
         */
        commentId: string;
    };
};
type DeleteInboxCommentResponse = ({
    success?: boolean;
    data?: {
        message?: string;
    };
});
type DeleteInboxCommentError = ({
    error?: string;
} | unknown | ErrorResponse);
type EditInboxCommentData = {
    body: {
        /**
         * The social account ID
         */
        accountId: string;
        /**
         * Only Reddit supports editing a comment
         */
        platform: 'reddit';
        /**
         * The new comment body
         */
        content: string;
    };
    path: {
        commentId: string;
        postId: string;
    };
};
type EditInboxCommentResponse = ({
    status?: string;
    commentId?: string;
    platform?: string;
});
type EditInboxCommentError = (unknown | {
    error?: string;
});
type SetCommentModerationData = {
    body: {
        /**
         * The social account ID
         */
        accountId: string;
        /**
         * Only YouTube supports comment moderation
         */
        platform: 'youtube';
        /**
         * published approves the comment, rejected removes it, heldForReview returns it to the queue.
         */
        moderationStatus: 'published' | 'rejected' | 'heldForReview';
        /**
         * Also ban the comment's author, auto-rejecting their future comments. Only valid when moderationStatus is "rejected"; any other pairing is a 400.
         *
         */
        banAuthor?: boolean;
    };
    path: {
        commentId: string;
        postId: string;
    };
};
type SetCommentModerationResponse = ({
    success?: boolean;
});
type SetCommentModerationError = (unknown | {
    error?: string;
});
type HideInboxCommentData = {
    body: {
        /**
         * The social account ID
         */
        accountId: string;
    };
    path: {
        commentId: string;
        postId: string;
    };
};
type HideInboxCommentResponse = ({
    status?: string;
    commentId?: string;
    hidden?: boolean;
    platform?: string;
});
type HideInboxCommentError = (unknown | {
    error?: string;
});
type UnhideInboxCommentData = {
    path: {
        commentId: string;
        postId: string;
    };
    query: {
        accountId: string;
    };
};
type UnhideInboxCommentResponse = ({
    status?: string;
    commentId?: string;
    hidden?: boolean;
    platform?: string;
});
type UnhideInboxCommentError = (unknown | {
    error?: string;
});
type LikeInboxCommentData = {
    body: {
        /**
         * The social account ID
         */
        accountId: string;
        /**
         * (LinkedIn only) Reaction to create. Defaults to LIKE; ignored on other platforms.
         */
        reactionType?: 'LIKE' | 'PRAISE' | 'EMPATHY' | 'INTEREST' | 'APPRECIATION' | 'ENTERTAINMENT';
        /**
         * (Bluesky only) Content identifier for the comment
         */
        cid?: string;
    };
    path: {
        commentId: string;
        postId: string;
    };
};
type LikeInboxCommentResponse = ({
    status?: string;
    commentId?: string;
    liked?: boolean;
    /**
     * (Bluesky only) URI to use for unliking
     */
    likeUri?: string;
    platform?: string;
});
type LikeInboxCommentError = (unknown | {
    error?: string;
});
type UnlikeInboxCommentData = {
    path: {
        commentId: string;
        postId: string;
    };
    query: {
        accountId: string;
        /**
         * (Bluesky only) The like URI returned when liking
         */
        likeUri?: string;
    };
};
type UnlikeInboxCommentResponse = ({
    status?: string;
    commentId?: string;
    liked?: boolean;
    platform?: string;
});
type UnlikeInboxCommentError = (unknown | {
    error?: string;
});
type LikePostData = {
    body: {
        /**
         * The social account acting as the liker
         */
        accountId: string;
        /**
         * (LinkedIn only) Reaction to create. Defaults to LIKE; ignored on other platforms.
         */
        reactionType?: 'LIKE' | 'PRAISE' | 'EMPATHY' | 'INTEREST' | 'APPRECIATION' | 'ENTERTAINMENT';
        /**
         * (Bluesky only) Content identifier of the post
         */
        cid?: string;
    };
    path: {
        /**
         * Zernio post ID or the platform's native post ID
         */
        postId: string;
    };
};
type LikePostResponse = ({
    status?: string;
    /**
     * The resolved native post ID
     */
    postId?: string;
    platform?: string;
    liked?: boolean;
    /**
     * (Bluesky only) URI to use for unliking
     */
    likeUri?: string;
});
type LikePostError = (ErrorResponse | {
    error?: string;
} | unknown);
type UnlikePostData = {
    path: {
        /**
         * Zernio post ID or the platform's native post ID
         */
        postId: string;
    };
    query: {
        accountId: string;
        /**
         * (Bluesky only) The like URI returned when liking
         */
        likeUri?: string;
    };
};
type UnlikePostResponse = ({
    status?: string;
    /**
     * The resolved native post ID
     */
    postId?: string;
    platform?: string;
    liked?: boolean;
});
type UnlikePostError = (ErrorResponse | {
    error?: string;
} | unknown);
type SendPrivateReplyToCommentData = {
    body: {
        /**
         * The social account ID (Instagram or Facebook)
         */
        accountId: string;
        /**
         * The message text to send as a private DM
         */
        message: string;
        /**
         * Optional quick-reply chips appended to the message. Visible only in the
         * Instagram and Messenger apps (not on web). Maximum 13 entries. Mutually
         * exclusive with `buttons`. Note: chips do NOT render in the Instagram
         * Message Requests folder where DMs from non-followers land — use `buttons`
         * instead for cold reach.
         *
         */
        quickReplies?: Array<{
            /**
             * Label shown on the chip. Truncated by Meta beyond 20 characters.
             */
            title: string;
            /**
             * Opaque value returned in the inbound webhook when the user taps the chip.
             */
            payload: string;
            /**
             * Optional thumbnail shown next to the chip title.
             */
            imageUrl?: string;
        }>;
        /**
         * Optional 1-3 inline buttons rendered as part of the same message bubble
         * via Meta's button_template. Visible in the Instagram Message Requests
         * folder (unlike quick replies). Mutually exclusive with `quickReplies`.
         *
         */
        buttons?: Array<({
            type: 'url';
            /**
             * Label shown on the button.
             */
            title: string;
            /**
             * URL opened when the button is tapped.
             */
            url: string;
        } | {
            type: 'postback';
            /**
             * Label shown on the button.
             */
            title: string;
            /**
             * Opaque value returned in the inbound webhook when the user taps the button.
             */
            payload: string;
        } | {
            type: 'phone';
            /**
             * Label shown on the button. Facebook only.
             */
            title: string;
            /**
             * E.164 phone number dialed when tapped. Facebook only.
             */
            phone: string;
        })>;
    };
    path: {
        /**
         * The comment ID to send a private reply to
         */
        commentId: string;
        /**
         * The media/post ID (Instagram media ID or Facebook post ID)
         */
        postId: string;
    };
};
type SendPrivateReplyToCommentResponse = ({
    status?: string;
    /**
     * The ID of the sent message
     */
    messageId?: string;
    /**
     * The comment ID that was replied to
     */
    commentId?: string;
    platform?: 'instagram' | 'facebook';
});
type SendPrivateReplyToCommentError = ({
    error?: string;
    code?: 'PLATFORM_LIMITATION';
} | {
    error?: string;
} | unknown);
type RetweetPostData = {
    body: {
        /**
         * The social account ID
         */
        accountId: string;
        /**
         * The ID of the tweet to retweet
         */
        tweetId: string;
    };
};
type RetweetPostResponse = ({
    status?: string;
    tweetId?: string;
    retweeted?: boolean;
    platform?: string;
});
type RetweetPostError = (unknown | {
    error?: string;
});
type UndoRetweetData = {
    query: {
        accountId: string;
        /**
         * The ID of the original tweet to un-retweet
         */
        tweetId: string;
    };
};
type UndoRetweetResponse = ({
    status?: string;
    tweetId?: string;
    retweeted?: boolean;
    platform?: string;
});
type UndoRetweetError = (unknown | {
    error?: string;
});
type BookmarkPostData = {
    body: {
        /**
         * The social account ID
         */
        accountId: string;
        /**
         * The ID of the tweet to bookmark
         */
        tweetId: string;
    };
};
type BookmarkPostResponse = ({
    status?: string;
    tweetId?: string;
    bookmarked?: boolean;
    platform?: string;
});
type BookmarkPostError = (unknown | {
    error?: string;
});
type RemoveBookmarkData = {
    query: {
        accountId: string;
        /**
         * The ID of the tweet to unbookmark
         */
        tweetId: string;
    };
};
type RemoveBookmarkResponse = ({
    status?: string;
    tweetId?: string;
    bookmarked?: boolean;
    platform?: string;
});
type RemoveBookmarkError = (unknown | {
    error?: string;
});
type FollowUserData = {
    body: {
        /**
         * The social account ID
         */
        accountId: string;
        /**
         * The Twitter ID of the user to follow
         */
        targetUserId: string;
    };
};
type FollowUserResponse = ({
    status?: string;
    targetUserId?: string;
    following?: boolean;
    /**
     * True if the target account is protected and a follow request was sent
     */
    pending_follow?: boolean;
    platform?: string;
});
type FollowUserError = (unknown | {
    error?: string;
});
type UnfollowUserData = {
    query: {
        accountId: string;
        /**
         * The Twitter ID of the user to unfollow
         */
        targetUserId: string;
    };
};
type UnfollowUserResponse = ({
    status?: string;
    targetUserId?: string;
    following?: boolean;
    platform?: string;
});
type UnfollowUserError = (unknown | {
    error?: string;
});
type SearchTweetsData = {
    query: {
        /**
         * The social account ID
         */
        accountId: string;
        /**
         * Pagination cursor from a previous response
         */
        cursor?: string;
        /**
         * Newest UTC timestamp (ISO 8601, exclusive), within the last 7 days
         */
        endTime?: string;
        /**
         * Results per page. X requires a minimum of 10; values below 10 are rejected.
         */
        limit?: number;
        /**
         * X search query, max 512 characters. Operators are passed through unchanged; X rejects malformed queries with a 400.
         */
        query: string;
        /**
         * Only return tweets with an ID greater than (more recent than) this numeric tweet ID. Non-numeric values are rejected with 400.
         */
        sinceId?: string;
        sortOrder?: 'recency' | 'relevancy';
        /**
         * Oldest UTC timestamp (ISO 8601, inclusive), within the last 7 days
         */
        startTime?: string;
        /**
         * Only return tweets with an ID less than (older than) this numeric tweet ID. Non-numeric values are rejected with 400.
         */
        untilId?: string;
    };
};
type SearchTweetsResponse = ({
    status?: string;
    tweets?: Array<{
        id?: string;
        text?: string;
        created?: string;
        conversationId?: string;
        /**
         * Parent tweet ID when the result is itself a reply
         */
        inReplyToTweetId?: (string) | null;
        lang?: string;
        author?: {
            id?: string;
            username?: string;
            displayName?: string;
            avatar?: string;
            verifiedType?: string;
        };
        likeCount?: number;
        replyCount?: number;
        retweetCount?: number;
        quoteCount?: number;
        platform?: string;
    }>;
    pagination?: {
        hasMore?: boolean;
        cursor?: (string) | null;
    };
    meta?: {
        resultCount?: number;
        newestId?: (string) | null;
        oldestId?: (string) | null;
        platform?: string;
    };
});
type SearchTweetsError = (unknown | {
    error?: string;
});
type GetTweetData = {
    query: {
        /**
         * The social account ID whose X token is used for the lookup
         */
        accountId: string;
        /**
         * Numeric tweet ID or a tweet URL (e.g. https://x.com/user/status/123...)
         */
        id: string;
    };
};
type GetTweetResponse = ({
    status?: string;
    tweet?: {
        id?: string;
        text?: string;
        created?: string;
        conversationId?: string;
        /**
         * Parent tweet ID when the tweet is itself a reply
         */
        inReplyToTweetId?: (string) | null;
        lang?: string;
        author?: {
            id?: string;
            username?: string;
            displayName?: string;
            avatar?: string;
            verifiedType?: string;
        };
        likeCount?: number;
        replyCount?: number;
        retweetCount?: number;
        quoteCount?: number;
        platform?: string;
    };
});
type GetTweetError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListInboxMentionsData = {
    query?: {
        /**
         * Filter by social account ID
         */
        accountId?: string;
        /**
         * Cursor for pagination (ID of the last item from the previous page)
         */
        cursor?: string;
        limit?: number;
        /**
         * Filter by profile ID
         */
        profileId?: string;
        /**
         * Sort order by publishedAt
         */
        sortOrder?: 'asc' | 'desc';
    };
};
type ListInboxMentionsResponse = ({
    data?: Array<{
        /**
         * Mention document ID
         */
        id?: string;
        platform?: 'linkedin';
        accountId?: string;
        accountUsername?: string;
        /**
         * Text of the post that mentioned you
         */
        content?: string;
        /**
         * URL to the source post on LinkedIn
         */
        permalink?: (string) | null;
        /**
         * LinkedIn URN of the person who mentioned you
         */
        authorUrn?: (string) | null;
        /**
         * Display name of the author, resolved from authorUrn. Null when LinkedIn does not allow resolving the profile.
         */
        authorName?: (string) | null;
        /**
         * LinkedIn vanity name of the author (the slug in their profile URL)
         */
        authorUsername?: (string) | null;
        /**
         * Profile picture URL of the author. LinkedIn CDN URLs expire after some time, so fetch promptly rather than storing long-term.
         */
        authorPicture?: (string) | null;
        /**
         * URN of the organization that was mentioned
         */
        organizationalEntity?: string;
        publishedAt?: string;
        createdAt?: string;
    }>;
    pagination?: {
        hasMore?: boolean;
        cursor?: (string) | null;
    };
    meta?: {
        total?: number;
        sortOrder?: 'asc' | 'desc';
    };
});
type ListInboxMentionsError = ({
    error?: string;
} | unknown);
type ReplyToMentionData = {
    body: {
        /**
         * The Instagram social account ID
         */
        accountId: string;
        /**
         * The ID of the media the account was mentioned in
         */
        mediaId: string;
        /**
         * The mentioning comment's ID. Omit for a caption mention.
         */
        commentId?: string;
        /**
         * The reply text
         */
        message: string;
    };
};
type ReplyToMentionResponse = ({
    success?: boolean;
    /**
     * ID of the created reply or comment
     */
    id?: string;
});
type ReplyToMentionError = (unknown | {
    error?: string;
});
type ListInboxReviewsData = {
    query?: {
        /**
         * Filter by specific social account ID
         */
        accountId?: string;
        cursor?: string;
        /**
         * Filter by reply status
         */
        hasReply?: boolean;
        limit?: number;
        maxRating?: number;
        minRating?: number;
        platform?: 'facebook' | 'googlebusiness';
        profileId?: string;
        sortBy?: 'date' | 'rating';
        sortOrder?: 'asc' | 'desc';
    };
};
type ListInboxReviewsResponse = ({
    status?: string;
    data?: Array<{
        /**
         * Review identifier. For Google Business this is the full review resource name (accounts/{accountId}/locations/{locationId}/reviews/{reviewId}), so it also encodes the location.
         */
        id?: string;
        platform?: string;
        accountId?: string;
        accountUsername?: string;
        /**
         * Bare GBP location id the review belongs to. Google Business only; absent for other platforms.
         */
        locationId?: string;
        /**
         * Human-readable GBP location display name. Google Business only; absent for other platforms.
         */
        locationName?: (string) | null;
        reviewer?: {
            id?: (string) | null;
            name?: string;
            profileImage?: (string) | null;
        };
        rating?: number;
        text?: string;
        created?: string;
        hasReply?: boolean;
        /**
         * Whether the review has at least one photo. Google Business only; always false for other platforms.
         */
        hasPhotos?: boolean;
        /**
         * Number of photos attached to the review (photos only; videos are not counted). Google Business only; 0 for other platforms.
         */
        photoCount?: number;
        /**
         * Photos attached to the review. Google Business only; always an empty array for other platforms.
         */
        photos?: Array<{
            url?: string;
        }>;
        reply?: {
            id?: string;
            text?: string;
            created?: string;
        } | null;
        reviewUrl?: (string) | null;
    }>;
    pagination?: {
        hasMore?: boolean;
        nextCursor?: (string) | null;
    };
    meta?: {
        accountsQueried?: number;
        accountsFailed?: number;
        failedAccounts?: Array<{
            accountId?: string;
            accountUsername?: (string) | null;
            platform?: string;
            error?: string;
            /**
             * Error code if available
             */
            code?: (string) | null;
            /**
             * Seconds to wait before retry (rate limits)
             */
            retryAfter?: (number) | null;
        }>;
        lastUpdated?: string;
    };
    summary?: {
        totalReviews?: number;
        averageRating?: (number) | null;
    };
});
type ListInboxReviewsError = ({
    error?: string;
} | unknown);
type ReplyToInboxReviewData = {
    body: {
        accountId: string;
        message: string;
    };
    path: {
        /**
         * Review ID (URL-encoded for Google Business)
         */
        reviewId: string;
    };
};
type ReplyToInboxReviewResponse = ({
    status?: string;
    reply?: {
        id?: string;
        text?: string;
        created?: string;
    };
    platform?: string;
});
type ReplyToInboxReviewError = ({
    error?: string;
} | unknown);
type DeleteInboxReviewReplyData = {
    body: {
        accountId: string;
    };
    path: {
        reviewId: string;
    };
};
type DeleteInboxReviewReplyResponse = ({
    status?: string;
    message?: string;
    platform?: string;
});
type DeleteInboxReviewReplyError = ({
    error?: string;
} | unknown);
type GetWhatsAppTemplatesData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type GetWhatsAppTemplatesResponse = ({
    success?: boolean;
    templates?: Array<{
        /**
         * WhatsApp template ID
         */
        id?: string;
        name?: string;
        status?: 'APPROVED' | 'PENDING' | 'REJECTED';
        category?: 'AUTHENTICATION' | 'MARKETING' | 'UTILITY';
        language?: string;
        components?: Array<{
            [key: string]: unknown;
        }>;
    }>;
});
type GetWhatsAppTemplatesError = (unknown | {
    error?: string;
});
type CreateWhatsAppTemplateData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Template name (lowercase, letters/numbers/underscores, must start with a letter)
         */
        name: string;
        /**
         * Template category
         */
        category: 'AUTHENTICATION' | 'MARKETING' | 'UTILITY';
        /**
         * Template language code (e.g., en_US)
         */
        language: string;
        /**
         * Variable style: POSITIONAL ({{1}}, the default) or NAMED ({{customer_name}}). Named templates provide examples via body_text_named_params / header_text_named_params. Inferred as NAMED when omitted but a named-params example is present.
         */
        parameter_format?: 'POSITIONAL' | 'NAMED' | 'positional' | 'named';
        /**
         * Template components (header, body, footer, buttons, carousel, limited_time_offer). Required for custom templates, omit when using library_template_name.
         */
        components?: Array<WhatsAppTemplateComponent>;
        /**
         * Name of a pre-built template from Meta's template library (e.g., "appointment_reminder",
         * "auto_pay_reminder_1", "address_update"). When provided, the template is pre-approved
         * by Meta with no review wait. Omit components when using this field.
         *
         */
        library_template_name?: string;
        /**
         * Optional body customizations for library templates. Available options depend on the
         * template (e.g., add_contact_number, add_learn_more_link, add_security_recommendation,
         * add_track_package_link, code_expiration_minutes).
         *
         */
        library_template_body_inputs?: {
            [key: string]: unknown;
        };
        /**
         * Optional button customizations for library templates. Each item specifies button type
         * and configuration (e.g., URL, phone number, quick reply).
         *
         */
        library_template_button_inputs?: Array<{
            type?: 'quick_reply' | 'url' | 'phone_number';
            url?: {
                base_url?: string;
            };
            phone_number?: string;
        }>;
    };
};
type CreateWhatsAppTemplateResponse = ({
    success?: boolean;
    template?: {
        id?: string;
        name?: string;
        /**
         * APPROVED for library templates, PENDING for custom
         */
        status?: string;
        category?: string;
        language?: string;
    };
});
type CreateWhatsAppTemplateError = (unknown | {
    error?: string;
});
type GetWhatsAppTemplateData = {
    path: {
        /**
         * Template name
         */
        templateName: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type GetWhatsAppTemplateResponse = ({
    success?: boolean;
    template?: {
        id?: string;
        name?: string;
        status?: string;
        category?: string;
        language?: string;
        components?: Array<{
            [key: string]: unknown;
        }>;
    };
});
type GetWhatsAppTemplateError = (unknown | {
    error?: string;
});
type UpdateWhatsAppTemplateData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Updated template components
         */
        components: Array<WhatsAppTemplateComponent>;
    };
    path: {
        /**
         * Template name
         */
        templateName: string;
    };
};
type UpdateWhatsAppTemplateResponse = ({
    success?: boolean;
    template?: {
        id?: string;
        name?: string;
        status?: string;
    };
});
type UpdateWhatsAppTemplateError = (unknown | {
    error?: string;
});
type DeleteWhatsAppTemplateData = {
    path: {
        /**
         * Template name
         */
        templateName: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type DeleteWhatsAppTemplateResponse = ({
    success?: boolean;
    message?: string;
});
type DeleteWhatsAppTemplateError = (unknown | {
    error?: string;
});
type GetWhatsAppCallingConfigData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type GetWhatsAppCallingConfigResponse = ({
    /**
     * Phone number record ID (use on /v1/phone-numbers/{id}/whatsapp/calling)
     */
    phoneNumberDocId?: string;
    phoneNumber?: string;
    callingEnabled?: boolean;
    /**
     * Public calling deep link (https://wa.me/call/<number>). Tapping it on a phone starts a WhatsApp voice call to this number. Embed it on websites, emails, or QR codes. Null while calling is disabled; not supported by WhatsApp desktop clients.
     */
    callDeepLink?: (string) | null;
    /**
     * tel:+E164 / sip:... / wss://... destination
     */
    forwardTo?: (string) | null;
    recordingEnabled?: boolean;
    sipAuthUsername?: (string) | null;
    /**
     * True when a SIP digest password is stored. The plaintext is never returned.
     */
    sipAuthPasswordConfigured?: boolean;
    callIconCountries?: Array<(string)> | null;
    /**
     * Caller ID the forward-leg callee sees on tel: forwards. business = this WhatsApp number; platform = a Zernio number (customer-brought number without verified caller ID; verify via /v1/phone-numbers/{id}/whatsapp/caller-id-verification).
     */
    callerIdMode?: 'business' | 'platform';
    /**
     * True once the number completed caller-ID verification.
     */
    callerIdVerified?: boolean;
    /**
     * Hard cap (seconds) on forwarded calls; null = no cap.
     */
    maxCallDurationSeconds?: (number) | null;
    forwardCallerId?: 'business' | 'caller';
});
type GetWhatsAppCallingConfigError = ({
    error?: string;
} | unknown);
type EnableWhatsAppCallingLegacyData = {
    body: {
        accountId: string;
        /**
         * tel:+E164 / sip:... / wss://... destination
         */
        forwardTo: string;
        sipAuthUsername?: string;
        /**
         * Stored encrypted, never returned by any endpoint.
         */
        sipAuthPassword?: string;
        recordingEnabled?: boolean;
        callIconCountries?: Array<(string)>;
        /**
         * Hard cap (seconds) on a forwarded call; the carrier hangs up both legs when it fires. Safety valve against dead-air billing when a destination hangs up but the signal is lost.
         */
        maxCallDurationSeconds?: number;
        /**
         * Caller ID presented to the forward destination. caller = the WhatsApp user's number (sip: destinations only; ignored on tel: forwards). Fixes AI-agent trunks that reject seeing the business number call itself.
         */
        forwardCallerId?: 'business' | 'caller';
    };
    path: {
        /**
         * WhatsAppPhoneNumber Mongo ID
         */
        id: string;
    };
};
type EnableWhatsAppCallingLegacyResponse = ({
    success?: boolean;
    callingEnabled?: boolean;
    sipHostname?: string;
    forwardTo?: string;
    /**
     * Caller ID the forward-leg callee sees on tel: forwards. business = this WhatsApp number; platform = a Zernio number (customer-brought number without verified caller ID).
     */
    callerIdMode?: 'business' | 'platform';
});
type EnableWhatsAppCallingLegacyError = (unknown | {
    error?: string;
});
type UpdateWhatsAppCallingLegacyData = {
    body: {
        accountId: string;
        forwardTo?: string;
        sipAuthUsername?: (string) | null;
        sipAuthPassword?: (string) | null;
        recordingEnabled?: boolean;
        callIconCountries?: Array<(string)> | null;
        /**
         * Hard cap (seconds) on forwarded calls; null clears the cap.
         */
        maxCallDurationSeconds?: (number) | null;
        /**
         * caller = present the WhatsApp user's number to the forward destination (sip: only).
         */
        forwardCallerId?: 'business' | 'caller';
    };
    path: {
        id: string;
    };
};
type UpdateWhatsAppCallingLegacyResponse = (unknown);
type UpdateWhatsAppCallingLegacyError = (unknown | {
    error?: string;
});
type DisableWhatsAppCallingLegacyData = {
    path: {
        id: string;
    };
    query: {
        accountId: string;
    };
};
type DisableWhatsAppCallingLegacyResponse = (unknown);
type DisableWhatsAppCallingLegacyError = (unknown | {
    error?: string;
});
type GetWhatsAppCallPermissionsData = {
    query: {
        accountId: string;
        /**
         * Consumer wa_id (E.164, leading + optional)
         */
        to: string;
    };
};
type GetWhatsAppCallPermissionsResponse = ({
    permission?: {
        status?: 'temporary' | 'no_permission' | 'permanent';
        /**
         * Unix seconds when temporary
         */
        expiration_time?: number;
    };
    actions?: Array<{
        action_name?: 'send_call_permission_request' | 'start_call';
        can_perform_action?: boolean;
    }>;
});
type GetWhatsAppCallPermissionsError = ({
    error?: string;
} | unknown);
type InitiateWhatsAppCallData = {
    body: {
        accountId: string;
        /**
         * Consumer wa_id (E.164, leading + optional)
         */
        to: string;
        /**
         * Omit to place a call. Set to send the consent prompt instead.
         */
        action?: 'send_call_permission_request';
        /**
         * Body text shown with the consent prompt (send_call_permission_request only).
         */
        bodyText?: string;
        /**
         * Per-call destination override. Same accepted shape as the
         * number's stored forwardTo (tel:+E164, sip:..., wss://...).
         *
         */
        forwardTo?: string;
        recordOverride?: boolean;
        /**
         * Accepted for forward compatibility. Not currently echoed
         * back in webhook payloads (SIP-first flow does not pass
         * through Meta's Graph API where Meta would echo this).
         *
         */
        biz_opaque_callback_data?: string;
    };
    headers?: {
        /**
         * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
         */
        'Idempotency-Key'?: string;
    };
};
type InitiateWhatsAppCallResponse = ({
    success?: boolean;
    /**
     * Internal Call doc ID
     */
    callId?: string;
    /**
     * Telnyx call_control_id of the outbound leg
     */
    telnyxCallControlId?: string;
    status?: 'dialing';
    direction?: 'outbound';
    to?: string;
    forwardTo?: (string) | null;
    recordingEnabled?: boolean;
});
type InitiateWhatsAppCallError = ({
    error?: string;
} | unknown);
type ListWhatsAppCallsData = {
    query: {
        accountId: string;
        /**
         * Return calls with startedAt strictly before this instant (use the previous page's nextCursor).
         */
        before?: string;
        direction?: 'inbound' | 'outbound';
        limit?: number;
        since?: string;
        status?: 'ringing' | 'answered' | 'ended' | 'failed';
        until?: string;
    };
};
type ListWhatsAppCallsResponse = ({
    calls?: Array<{
        _id?: string;
        direction?: 'inbound' | 'outbound';
        from?: string;
        to?: string;
        status?: 'ringing' | 'answered' | 'ended' | 'failed';
        startedAt?: string;
        endedAt?: string;
        durationSeconds?: number;
        endReason?: 'hangup' | 'no_answer' | 'rejected' | 'error';
        recordingUrl?: string;
        billing?: {
            /**
             * Meta per-minute charge, billed by Meta directly to your WABA. Display only; not billed by Zernio.
             */
            metaCostUSD?: number;
            telnyxCostUSD?: number;
            recordingCostUSD?: number;
            /**
             * Amount Zernio bills you = Telnyx leg + recording (excludes Meta).
             */
            billableCostUSD?: number;
            /**
             * Full cost incl. the Meta portion you pay directly. Display only.
             */
            totalCostUSD?: number;
            currency?: string;
        };
    }>;
    /**
     * Pass as `before` for the next page; null on the last page.
     */
    nextCursor?: (string) | null;
});
type ListWhatsAppCallsError = ({
    error?: string;
});
type GetWhatsAppCallData = {
    path: {
        id: string;
    };
    query: {
        accountId: string;
    };
};
type GetWhatsAppCallResponse = ({
    call?: {
        [key: string]: unknown;
    };
});
type GetWhatsAppCallError = ({
    error?: string;
} | unknown);
type GetWhatsAppCallRecordingData = {
    path: {
        id: string;
    };
    query: {
        accountId: string;
        /**
         * `json` returns `{ url }` instead of a 302 redirect.
         */
        as?: 'json';
    };
};
type GetWhatsAppCallRecordingResponse = ({
    url?: string;
});
type GetWhatsAppCallRecordingError = (unknown | {
    error?: string;
});
type GetWhatsAppCallEstimateData = {
    query: {
        accountId: string;
        minutes?: number;
        recording?: boolean;
        to: string;
    };
};
type GetWhatsAppCallEstimateResponse = ({
    destinationCountry?: (string) | null;
    perMinuteUsd?: number;
    breakdown?: {
        metaMinutes?: number;
        /**
         * Estimated Meta per-minute charge, billed by Meta directly to your WABA. Display only; not billed by Zernio.
         */
        metaCostUSD?: number;
        telnyxCostUSD?: number;
        recordingCostUSD?: number;
        /**
         * Estimated amount Zernio bills you = Telnyx leg + recording (excludes Meta).
         */
        billableCostUSD?: number;
        /**
         * Estimated full cost incl. the Meta portion you pay directly. Display only.
         */
        totalCostUSD?: number;
    };
});
type GetWhatsAppCallEstimateError = ({
    error?: string;
});
type ListCallsData = {
    query?: {
        /**
         * Return calls with startedAt strictly before this instant (use the previous page's nextCursor).
         */
        before?: string;
        channel?: 'whatsapp' | 'pstn';
        direction?: 'inbound' | 'outbound';
        limit?: number;
        /**
         * Exact filter: calls involving this number (typically one of YOUR numbers, to scope history to a single line). E.164, leading + optional.
         */
        number?: string;
        /**
         * Free-text match on the from/to numbers. Non-digits are stripped, so partial queries like `302` or `+1 302` work.
         */
        search?: string;
        status?: 'ringing' | 'answered' | 'ended' | 'failed';
    };
};
type ListCallsResponse = ({
    calls?: Array<(CallRecord & {
        /**
         * CRM contact name for the counterparty, when resolved.
         */
        contactName?: string;
    })>;
    /**
     * Pass as `before` for the next page; null on the last page.
     */
    nextCursor?: (string) | null;
});
type ListCallsError = ({
    error?: string;
} | unknown);
type GetCallData = {
    path: {
        id: string;
    };
};
type GetCallResponse = ({
    call?: (CallRecord & {
        /**
         * CRM contact name for the counterparty, when resolved.
         */
        contactName?: string;
    });
});
type GetCallError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetCallRecordingData = {
    path: {
        id: string;
    };
    query?: {
        /**
         * `json` returns `{ url }` instead of a 302 redirect.
         */
        as?: 'json';
    };
};
type GetCallRecordingResponse = ({
    url?: string;
});
type GetCallRecordingError = (unknown | ErrorResponse | {
    error?: string;
});
type CreateVoiceCallData = {
    body: {
        /**
         * Destination to dial, E.164 with leading +.
         */
        to: string;
        /**
         * Which of your voice-enabled numbers to dial from. Optional when you have exactly one.
         */
        fromNumber?: string;
        /**
         * Per-call agent override (tel:+E164, sip:..., or wss://...); defaults to the number's stored forward destination.
         */
        forwardTo?: string;
        /**
         * Spoken to the callee when they answer, before the bridge.
         */
        greeting?: string;
        /**
         * Per-call recording toggle; defaults to the number's setting.
         */
        recordOverride?: boolean;
        /**
         * Per-call transcription toggle; defaults to the number's setting.
         */
        transcribeOverride?: boolean;
        /**
         * 'auto' derives from the callee's country; 'en'/'es' force it.
         */
        transcriptionLanguage?: 'auto' | 'en' | 'es';
        /**
         * Answering-machine detection; defers the bridge until human vs machine is known.
         */
        amd?: boolean;
        /**
         * Spoken to a detected machine, then hang up (implies `amd`). For outbound voicemail drops.
         */
        voicemailDropMessage?: string;
    };
    headers?: {
        /**
         * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
         */
        'Idempotency-Key'?: string;
    };
};
type CreateVoiceCallResponse = ({
    success?: boolean;
    /**
     * Internal Call doc ID
     */
    callId?: string;
    telnyxCallControlId?: string;
    status?: 'dialing';
    direction?: 'outbound';
    from?: string;
    to?: string;
    forwardTo?: string;
    greeting?: (string) | null;
    recordingEnabled?: boolean;
    transcriptionEnabled?: boolean;
    transcriptionLanguage?: 'auto' | 'en' | 'es';
});
type CreateVoiceCallError = ({
    error?: string;
} | unknown);
type ListVoiceCallsData = {
    query?: {
        before?: string;
        direction?: 'inbound' | 'outbound';
        limit?: number;
        /**
         * Exact filter: calls involving this number (typically one of your DIDs). E.164, leading + optional.
         */
        number?: string;
        status?: 'ringing' | 'answered' | 'ended' | 'failed';
    };
};
type ListVoiceCallsResponse = ({
    calls?: Array<CallRecord>;
    nextCursor?: (string) | null;
});
type ListVoiceCallsError = ({
    error?: string;
});
type GetVoiceCallData = {
    path: {
        id: string;
    };
};
type GetVoiceCallResponse = ({
    call?: CallRecord;
});
type GetVoiceCallError = ({
    error?: string;
} | unknown);
type EndVoiceCallData = {
    path: {
        id: string;
    };
};
type EndVoiceCallResponse = ({
    success?: boolean;
    callId?: string;
    /**
     * `ending` when a hangup was issued; otherwise the call's current status.
     */
    status?: string;
});
type EndVoiceCallError = ({
    error?: string;
} | unknown);
type GetVoiceCallRecordingData = {
    path: {
        id: string;
    };
    query?: {
        /**
         * `json` returns `{ url }` instead of a 302 redirect.
         */
        as?: 'json';
    };
};
type GetVoiceCallRecordingResponse = ({
    url?: string;
});
type GetVoiceCallRecordingError = (unknown | {
    error?: string;
});
type TransferVoiceCallData = {
    body: {
        /**
         * +E164 phone number (tel: prefix optional) or a sip: URI. wss:// is not a valid transfer target.
         */
        to: string;
    };
    path: {
        id: string;
    };
};
type TransferVoiceCallResponse = ({
    success?: boolean;
    callId?: string;
    transferredTo?: string;
});
type TransferVoiceCallError = ({
    error?: string;
} | unknown);
type GetVoiceCallEstimateData = {
    query: {
        minutes?: number;
        recording?: boolean;
        /**
         * Destination number, E.164 (leading + optional).
         */
        to: string;
        transcription?: boolean;
    };
};
type GetVoiceCallEstimateResponse = ({
    destinationCountry?: (string) | null;
    minutes?: number;
    /**
     * Billable cost per minute for the requested options.
     */
    perMinuteUsd?: number;
    breakdown?: {
        telnyxCostUSD?: number;
        recordingCostUSD?: number;
        transcriptionCostUSD?: number;
        /**
         * What Zernio bills for the call.
         */
        billableCostUSD?: number;
        /**
         * Equals billableCostUSD (no separate Meta bill on PSTN); kept for shape parity with the WhatsApp estimate.
         */
        totalCostUSD?: number;
    };
});
type GetVoiceCallEstimateError = ({
    error?: string;
});
type CreateVoiceWebSessionResponse = ({
    success?: boolean;
    /**
     * Login token for the browser WebRTC SDK.
     */
    token?: string;
    /**
     * Pass to POST /v1/voice/calls/web/dial once the browser is registered.
     */
    credentialId?: string;
    expiresAt?: string;
    sdk?: string;
});
type CreateVoiceWebSessionError = ({
    error?: string;
} | unknown);
type DialVoiceWebCallData = {
    body: {
        /**
         * The number to call, E.164 with leading +.
         */
        to: string;
        /**
         * The WebRTC credential id returned by POST /v1/voice/calls/web (the registered browser).
         */
        credentialId: string;
        /**
         * Which of your voice-enabled numbers to call from (optional when you have one).
         */
        fromNumber?: string;
        recordOverride?: boolean;
    };
};
type DialVoiceWebCallResponse = ({
    success?: boolean;
    callId?: string;
    telnyxCallControlId?: string;
    status?: 'dialing';
    direction?: 'outbound';
    from?: string;
    to?: string;
    recordingEnabled?: boolean;
});
type DialVoiceWebCallError = ({
    error?: string;
} | unknown);
type SendSmsData = {
    body: {
        /**
         * One of your SMS-enabled numbers (E.164; formatting is normalized).
         */
        from: string;
        /**
         * Recipient number (E.164).
         */
        to: string;
        /**
         * Message body. Required unless `mediaUrls` is set. Max 10 SMS segments (1530 GSM-7 or 670 unicode characters).
         */
        text?: string;
        /**
         * Public media URLs to attach (sends as MMS). Max 10.
         */
        mediaUrls?: Array<(string)>;
        /**
         * Optional. Schedule the send for a future time (ISO 8601 with offset, e.g. `2026-08-01T12:00:00Z`). Must be in the future. The message is queued and the `message.delivered` webhook fires when it actually sends.
         */
        sendAt?: string;
    };
    headers?: {
        /**
         * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
         */
        'Idempotency-Key'?: string;
    };
};
type SendSmsResponse = ({
    /**
     * Message ID
     */
    id?: string;
    /**
     * Inbox conversation the message was threaded into.
     */
    conversationId?: string;
    status?: 'sent';
});
type SendSmsError = (ErrorResponse | {
    error?: string;
} | unknown);
type LookupSmsNumberData = {
    query: {
        /**
         * Number to look up (E.164; formatting is normalized).
         */
        number: string;
    };
};
type LookupSmsNumberResponse = ({
    phoneNumber?: string;
    carrierName?: (string) | null;
    lineType?: 'mobile' | 'landline' | 'voip' | 'toll-free' | 'unknown';
    /**
     * True when the line type can receive SMS (not a landline).
     */
    smsReachable?: boolean;
});
type LookupSmsNumberError = ({
    error?: string;
} | unknown);
type ListSmsOptOutsData = {
    query?: {
        format?: 'json' | 'csv';
        limit?: number;
    };
};
type ListSmsOptOutsResponse = ({
    optOuts?: Array<{
        phoneNumber?: string;
        optedOutAt?: (string) | null;
        /**
         * The keyword they sent (e.g. STOP), when the carrier recorded one.
         */
        keyword?: (string) | null;
        /**
         * Which of your numbers the recipient opted out from.
         */
        from?: (string) | null;
    }>;
    count?: number;
});
type ListSmsOptOutsError = ({
    error?: string;
});
type CreateSmsSenderIdData = {
    body: {
        /**
         * The sender ID recipients will see (3-11 letters/digits/spaces, at least one letter, no leading/trailing space).
         */
        senderId: string;
    };
};
type CreateSmsSenderIdResponse = ({
    /**
     * Sender ID resource id.
     */
    id?: string;
    senderId?: string;
    isActive?: boolean;
});
type CreateSmsSenderIdError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListSmsSenderIdsResponse = ({
    senderIds?: Array<{
        id?: string;
        senderId?: string;
        isActive?: boolean;
        createdAt?: (string) | null;
    }>;
    /**
     * Workspace-wide daily sending budget, shared by every sender ID (resets midnight UTC).
     */
    budget?: {
        /**
         * Daily message cap (raisable via `/v1/sms/sender-ids/limit-request`).
         */
        cap?: number;
        /**
         * Messages already counted against today's cap.
         */
        usedToday?: number;
        /**
         * Cap tier (Level 1 = 500/day).
         */
        level?: number;
        /**
         * The in-flight cap-raise request awaiting review, or null. While set, further requests return 409.
         */
        pendingRequest?: {
            requestedCap?: number;
            level?: number;
            requestedAt?: (string) | null;
        } | null;
    };
});
type ListSmsSenderIdsError = ({
    error?: string;
});
type RequestSmsSenderIdLimitIncreaseData = {
    body: {
        /**
         * Desired daily message cap. Must exceed the current cap.
         */
        requestedCap: number;
        /**
         * Use case and audience (what you send, to whom, opt-in status).
         */
        reason: string;
    };
};
type RequestSmsSenderIdLimitIncreaseResponse = ({
    requested?: boolean;
    requestedCap?: number;
});
type RequestSmsSenderIdLimitIncreaseError = (ErrorResponse | {
    error?: string;
} | unknown);
type DeleteSmsSenderIdData = {
    path: {
        /**
         * Sender ID resource id.
         */
        id: string;
    };
};
type DeleteSmsSenderIdResponse = ({
    deleted?: boolean;
});
type DeleteSmsSenderIdError = (ErrorResponse | {
    error?: string;
} | unknown);
type StartSmsRegistrationData = {
    body: {
        registrationType: 'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free';
        /**
         * Your numbers this registration covers. When omitted or empty on a 10DLC registration, defaults to your active SMS-enabled US local numbers not already covered by another registration.
         */
        phoneNumbers?: Array<(string)>;
        /**
         * Required for 10DLC. The legal entity behind the traffic (TCR brand).
         */
        brand?: {
            entityType: 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR';
            displayName: string;
            /**
             * Legal company name. Required for every entityType except SOLE_PROPRIETOR.
             */
            companyName?: string;
            /**
             * Required for every entityType except SOLE_PROPRIETOR.
             */
            ein?: string;
            /**
             * Business contact phone. Required for every entityType except SOLE_PROPRIETOR.
             */
            phone?: string;
            /**
             * Required for SOLE_PROPRIETOR; the verification OTP is texted there (US/CA mobile).
             */
            mobilePhone?: string;
            street: string;
            city: string;
            state: string;
            postalCode: string;
            /**
             * ISO 3166-1 alpha-2 country where the company is registered. Companies worldwide can register standard 10DLC (non-US companies use their local tax ID in `ein`; carrier vetting may take longer). SOLE_PROPRIETOR is US/CA only.
             */
            country: string;
            /**
             * Brand contact email; defaults to your account email when omitted.
             */
            email?: string;
            /**
             * The brand's website (sole proprietors may use a social profile such as LinkedIn or a business Facebook page). Carriers verify the brand against it; a bare domain is normalized to https://.
             */
            website: string;
            vertical: 'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'HUMAN_RESOURCES' | 'INSURANCE' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY' | 'TRANSPORTATION';
            stockSymbol?: string;
        };
        /**
         * Required for 10DLC. What you'll send and how recipients opt in/out.
         * The opt-in/opt-out/help auto-responses (`optinMessage`,
         * `optoutMessage`, `helpMessage`) are optional: when omitted, a
         * compliant, brand-named template with the carrier-required
         * disclosures is generated for you. If you do send them, they must
         * name the registered brand and carry the disclosures — submissions
         * that don't are rewritten to the compliant template before the
         * campaign is filed.
         *
         */
        campaign?: {
            usecase: string;
            /**
             * The concrete kinds of messages a MIXED campaign sends (the carrier
             * registry requires 2-5, and reviewers match them against the sample
             * messages). Omitted: a default pair is applied for MIXED.
             *
             */
            subUsecases?: Array<('2FA' | 'ACCOUNT_NOTIFICATION' | 'CUSTOMER_CARE' | 'DELIVERY_NOTIFICATION' | 'FRAUD_ALERT' | 'HIGHER_EDUCATION' | 'MARKETING' | 'POLLING_VOTING' | 'PUBLIC_SERVICE_ANNOUNCEMENT' | 'SECURITY_ALERT')>;
            description: string;
            /**
             * How a recipient ends up receiving your messages (the opt-in flow). Include a link to the page or form where they opt in — carrier reviewers reject campaigns whose consent they can't verify.
             */
            messageFlow: string;
            sample1: string;
            /**
             * Second example message; carriers require two distinct samples, so it must differ from sample1.
             */
            sample2: string;
            helpMessage?: string;
            optinKeywords: string;
            optinMessage?: string;
            optoutKeywords: string;
            optoutMessage?: string;
            helpKeywords: string;
            /**
             * Whether messages carry links. Auto-derived from the samples when omitted, so the declaration matches what the reviewer reads.
             */
            embeddedLink?: boolean;
            /**
             * Whether messages carry phone numbers. Auto-derived from the samples when omitted.
             */
            embeddedPhone?: boolean;
            numberPool?: boolean;
            ageGated?: boolean;
            directLending?: boolean;
            /**
             * Link to your privacy policy. Recommended: reviewers check that it says mobile information is not sold or shared with third parties for promotional purposes. A bare domain is normalized to https://.
             */
            privacyPolicyLink?: string;
            /**
             * Link to your terms & conditions. A bare domain is normalized to https://.
             */
            termsAndConditionsLink?: string;
        };
        /**
         * DBA / trade name used to brand message content (samples and auto-replies) when it differs from the legal name, e.g. a sole proprietor texting under a business name. The legal `brand.displayName` is still what the carrier vets.
         */
        messagingBrandName?: string;
        /**
         * Raw dashboard-wizard answers, stored only to prefill edit-and-resubmit. API integrators can omit.
         */
        wizardValues?: {
            [key: string]: (string);
        };
        /**
         * Resubmit a registration that was returned for changes — updates it in place instead of creating a new one.
         */
        resubmitRequestId?: string;
        /**
         * Required for toll_free.
         */
        tollFree?: {
            businessName: string;
            corporateWebsite: string;
            phoneNumbers: Array<(string)>;
            useCase: string;
            useCaseSummary: string;
            productionMessageContent: string;
            /**
             * How recipients opt in to your messages.
             */
            optInWorkflow: string;
            /**
             * Screenshot URL(s) showing the opt-in flow (at least one).
             */
            optInWorkflowImageUrls: Array<(string)>;
            /**
             * Expected monthly message volume tier.
             */
            messageVolume: '10' | '100' | '1,000' | '10,000' | '100,000' | '250,000' | '500,000' | '750,000' | '1,000,000' | '5,000,000' | '10,000,000+';
            additionalInformation: string;
            businessAddr1: string;
            businessAddr2?: string;
            businessCity: string;
            businessState: string;
            businessZip: string;
            businessContactFirstName: string;
            businessContactLastName: string;
            businessContactEmail: string;
            businessContactPhone: string;
            businessRegistrationNumber: string;
            /**
             * e.g. EIN (US), Companies House (UK), ABN (AU).
             */
            businessRegistrationType: string;
            /**
             * ISO 3166-1 alpha-2.
             */
            businessRegistrationCountry: string;
        };
    };
};
type StartSmsRegistrationResponse = ({
    registrationId?: string;
    status?: 'pending';
    /**
     * True for sole-prop 10DLC: an OTP was texted to the brand's mobile; submit it via /verify-otp.
     */
    awaitingOtp?: boolean;
});
type StartSmsRegistrationError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListSmsRegistrationsData = {
    query?: {
        /**
         * Deactivated (terminated) registrations are hidden by default — pass true to include them.
         */
        includeDeactivated?: boolean;
    };
};
type ListSmsRegistrationsResponse = ({
    registrations?: Array<{
        id?: string;
        registrationType?: 'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free';
        displayName?: (string) | null;
        /**
         * requested/changes_requested = pre-submission review states; customers see them as pending / needs changes.
         */
        status?: 'pending' | 'approved' | 'rejected' | 'requested' | 'changes_requested' | 'deactivated';
        /**
         * Carrier-registry brand status (e.g. VERIFIED).
         */
        brandStatus?: string;
        campaignStatus?: string;
        /**
         * TCR brand id, useful when referencing the brand in carrier support threads.
         */
        brandId?: (string) | null;
        /**
         * TCR campaign id.
         */
        campaignId?: (string) | null;
        declineReason?: (string) | null;
        /**
         * Toll-free only: when the carrier requested changes ("Waiting For Customer"). The request must be resubmitted within 7 days of this timestamp or it expires.
         */
        tfActionRequiredAt?: (string) | null;
        phoneNumbers?: Array<(string)>;
        /**
         * Sole-prop 10DLC only; the OTP step is still pending.
         */
        awaitingOtp?: boolean;
        /**
         * Carrier-assigned brand trust score; drives throughput.
         */
        trustScore?: (number) | null;
        /**
         * Carrier throughput tier derived from the trust score.
         */
        throughput?: {
            label?: string;
            smsPerMinute?: number;
            smsPerDay?: number;
        };
    }>;
});
type ListSmsRegistrationsError = (ErrorResponse | {
    error?: string;
});
type PreflightSmsRegistrationData = {
    body: {
        registrationType: 'standard_10dlc' | 'sole_prop_10dlc';
        phoneNumbers?: Array<(string)>;
        /**
         * Same shape as the registration `brand`.
         */
        brand: {
            [key: string]: unknown;
        };
        /**
         * Same shape as the registration `campaign`.
         */
        campaign: {
            [key: string]: unknown;
        };
        messagingBrandName?: string;
    };
};
type PreflightSmsRegistrationResponse = ({
    /**
     * The exact payloads a submission would store (post-branding, disclosures appended, auto-replies generated).
     */
    composed?: {
        brand?: {
            [key: string]: unknown;
        };
        campaign?: {
            [key: string]: unknown;
        };
    };
    advisories?: Array<{
        /**
         * The payload field the finding is about, when attributable.
         */
        field?: (string) | null;
        /**
         * Stable rule id for deterministic findings; absent on AI findings.
         */
        code?: (string) | null;
        concern?: string;
        severity?: 'block' | 'warn';
    }>;
    verdict?: 'pass' | 'warn' | 'fail' | 'unreviewed';
    /**
     * True when the AI portion of the check could not run; advisories then contain only deterministic findings.
     */
    aiUnavailable?: boolean;
});
type PreflightSmsRegistrationError = (ErrorResponse | {
    error?: string;
});
type DeactivateSmsRegistrationData = {
    path: {
        id: string;
    };
};
type DeactivateSmsRegistrationResponse = ({
    status?: 'deactivated';
});
type DeactivateSmsRegistrationError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetSmsRegistrationData = {
    path: {
        id: string;
    };
};
type GetSmsRegistrationResponse = ({
    id?: string;
    registrationType?: 'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free';
    /**
     * requested/changes_requested = pre-submission review states; customers see them as pending / needs changes.
     */
    status?: 'pending' | 'approved' | 'rejected' | 'requested' | 'changes_requested' | 'deactivated';
    brandStatus?: string;
    campaignStatus?: string;
    declineReason?: (string) | null;
    phoneNumbers?: Array<(string)>;
    awaitingOtp?: boolean;
    /**
     * The submitted campaign content, present only for rejected
     * registrations with a campaign. Edit and resubmit it via the
     * appeal endpoint's optional content fields.
     *
     */
    campaignContent?: {
        messageFlow?: string;
        sample1?: string;
        sample2?: string;
    };
});
type GetSmsRegistrationError = (ErrorResponse | {
    error?: string;
} | unknown);
type VerifySmsRegistrationOtpData = {
    body: {
        otpPin: string;
    };
    path: {
        id: string;
    };
};
type VerifySmsRegistrationOtpResponse = ({
    verified?: boolean;
});
type VerifySmsRegistrationOtpError = (ErrorResponse | {
    error?: string;
} | unknown);
type ResendSmsRegistrationOtpData = {
    path: {
        id: string;
    };
};
type ResendSmsRegistrationOtpResponse = ({
    sent?: boolean;
});
type ResendSmsRegistrationOtpError = (unknown | {
    error?: string;
});
type AppealSmsRegistrationData = {
    body: {
        /**
         * Goes verbatim to the carrier reviewer — address the decline reason directly.
         */
        appealReason: string;
        /**
         * Corrected opt-in flow; include a link to the opt-in page/form.
         */
        messageFlow?: string;
        sample1?: string;
        sample2?: string;
    };
    path: {
        id: string;
    };
};
type AppealSmsRegistrationResponse = ({
    status?: 'pending';
});
type AppealSmsRegistrationError = (unknown | {
    error?: string;
});
type RespondToSmsRegistrationReviewData = {
    body: {
        /**
         * Answer for the reviewer. Required when no files are sent.
         */
        note?: string;
        /**
         * Hosted document URLs returned by POST /v1/sms/opt-in-proof.
         */
        files?: Array<(string)>;
    };
    path: {
        id: string;
    };
};
type RespondToSmsRegistrationReviewResponse = ({
    status?: 'requested';
});
type RespondToSmsRegistrationReviewError = (ErrorResponse | {
    error?: string;
} | unknown);
type UploadSmsOptInProofFileData = {
    body: {
        /**
         * PNG, JPG, WebP, GIF or PDF, max 4MB.
         */
        file: (Blob | File);
    };
};
type UploadSmsOptInProofFileResponse = ({
    /**
     * Public URL to reference in the opt-in flow text.
     */
    url?: string;
});
type UploadSmsOptInProofFileError = ({
    error?: string;
} | unknown);
type UploadSmsOptInProofData = {
    body: {
        /**
         * PNG, JPG, WebP, GIF or PDF, max 4MB.
         */
        file: (Blob | File);
    };
    path: {
        id: string;
    };
};
type UploadSmsOptInProofResponse = ({
    /**
     * Public URL to reference in the opt-in flow text.
     */
    url?: string;
});
type UploadSmsOptInProofError = ({
    error?: string;
} | unknown);
type ShareSmsRegistrationData = {
    body: {
        /**
         * Your phone number's ID (from GET /v1/phone-numbers).
         */
        numberId: string;
    };
};
type ShareSmsRegistrationResponse = ({
    url?: string;
    expiresAt?: string;
});
type ShareSmsRegistrationError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetWhatsAppLibraryTemplateData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Exact library template name
         */
        name: string;
    };
};
type GetWhatsAppLibraryTemplateResponse = ({
    template?: {
        name?: string;
        language?: string;
        category?: string;
        body?: string;
        body_params?: Array<(string)>;
        buttons?: Array<{
            /**
             * QUICK_REPLY, URL, PHONE_NUMBER, OTP, FLOW, ...
             */
            type?: string;
            text?: string;
        }>;
    } | null;
});
type GetWhatsAppLibraryTemplateError = (unknown | {
    error?: string;
});
type GetWhatsAppBusinessProfileData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type GetWhatsAppBusinessProfileResponse = ({
    success?: boolean;
    businessProfile?: {
        /**
         * Short description (max 139 chars)
         */
        about?: string;
        address?: string;
        /**
         * Full description (max 512 chars)
         */
        description?: string;
        email?: string;
        profilePictureUrl?: string;
        websites?: Array<(string)>;
        /**
         * Business category
         */
        vertical?: string;
    };
});
type GetWhatsAppBusinessProfileError = (unknown | {
    error?: string;
});
type UpdateWhatsAppBusinessProfileData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Short business description (max 139 characters)
         */
        about?: string;
        /**
         * Business address
         */
        address?: string;
        /**
         * Full business description (max 512 characters)
         */
        description?: string;
        /**
         * Business email
         */
        email?: string;
        /**
         * Business websites (max 2)
         */
        websites?: Array<(string)>;
        /**
         * Business category (e.g., RETAIL, ENTERTAINMENT, etc.)
         */
        vertical?: string;
        /**
         * Handle from resumable upload for profile picture
         */
        profilePictureHandle?: string;
    };
};
type UpdateWhatsAppBusinessProfileResponse = ({
    success?: boolean;
    message?: string;
});
type UpdateWhatsAppBusinessProfileError = (unknown | {
    error?: string;
});
type UploadWhatsAppProfilePhotoData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Image file (JPEG or PNG, max 5MB, recommended 640x640)
         */
        file: (Blob | File);
    };
};
type UploadWhatsAppProfilePhotoResponse = ({
    success?: boolean;
    message?: string;
});
type UploadWhatsAppProfilePhotoError = (unknown | {
    error?: string;
});
type GetWhatsAppDisplayNameData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type GetWhatsAppDisplayNameResponse = ({
    success?: boolean;
    displayName?: {
        /**
         * Current verified display name
         */
        name?: string;
        /**
         * Meta review status for the display name
         */
        status?: 'APPROVED' | 'PENDING_REVIEW' | 'DECLINED' | 'NONE';
        /**
         * Display phone number
         */
        phoneNumber?: string;
    };
});
type GetWhatsAppDisplayNameError = (unknown | {
    error?: string;
});
type UpdateWhatsAppDisplayNameData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * New display name (must follow WhatsApp naming guidelines)
         */
        displayName: string;
    };
};
type UpdateWhatsAppDisplayNameResponse = ({
    success?: boolean;
    message?: string;
    displayName?: {
        name?: string;
        status?: 'PENDING_REVIEW';
    };
});
type UpdateWhatsAppDisplayNameError = (unknown | {
    error?: string;
});
type GetWhatsappBusinessUsernameData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type GetWhatsappBusinessUsernameResponse = ({
    success?: boolean;
    /**
     * The current username, or null if none is set
     */
    username?: (string) | null;
    /**
     * Approval state of the username
     */
    status?: 'approved' | 'reserved' | 'none';
});
type GetWhatsappBusinessUsernameError = ({
    error?: string;
} | unknown);
type SetWhatsappBusinessUsernameData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Desired username. Letters, digits, period, and underscore only. Must contain at least one letter. No leading, trailing, or consecutive periods. No www prefix. No domain TLD suffix.
         *
         */
        username: string;
        /**
         * Pass `force_transfer` to request a transfer if the username is held by another account
         */
        transferAction?: 'none' | 'force_transfer';
    };
};
type SetWhatsappBusinessUsernameResponse = ({
    success?: boolean;
    username?: string;
    status?: 'approved' | 'reserved' | 'none';
});
type SetWhatsappBusinessUsernameError = (unknown | {
    error?: string;
});
type DeleteWhatsappBusinessUsernameData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type DeleteWhatsappBusinessUsernameResponse = ({
    success?: boolean;
});
type DeleteWhatsappBusinessUsernameError = ({
    error?: string;
} | unknown);
type GetWhatsappBusinessUsernameSuggestionsData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type GetWhatsappBusinessUsernameSuggestionsResponse = ({
    success?: boolean;
    /**
     * List of available username suggestions
     */
    suggestions?: Array<(string)>;
});
type GetWhatsappBusinessUsernameSuggestionsError = ({
    error?: string;
} | unknown);
type GetWhatsAppNumberInfoData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type GetWhatsAppNumberInfoResponse = ({
    phone?: {
        display_phone_number?: string;
        verified_name?: string;
        /**
         * APPROVED, AVAILABLE_WITHOUT_REVIEW, PENDING_REVIEW, DECLINED, EXPIRED, NONE
         */
        name_status?: string;
        /**
         * GREEN, YELLOW, RED, UNKNOWN
         */
        quality_rating?: string;
        /**
         * e.g. TIER_250, TIER_1K, TIER_UNLIMITED
         */
        messaging_limit_tier?: string;
        throughput?: {
            /**
             * STANDARD or HIGH
             */
            level?: string;
        };
        /**
         * e.g. CONNECTED
         */
        status?: string;
        is_official_business_account?: boolean;
        /**
         * e.g. CLOUD_API
         */
        platform_type?: string;
        /**
         * Meta's can_send_message health object (messaging + calling signals)
         */
        health_status?: {
            [key: string]: unknown;
        };
    };
    waba?: {
        name?: string;
        /**
         * verified, not_verified, pending, ...
         */
        business_verification_status?: string;
        /**
         * Meta integer timezone-enum id
         */
        timezone_id?: string;
        health_status?: {
            [key: string]: unknown;
        };
    } | null;
});
type GetWhatsAppNumberInfoError = (unknown | {
    error?: string;
});
type GetWhatsAppBlockStatusData = {
    query: {
        accountId: string;
        /**
         * Consumer wa_id or E.164 phone (leading + optional)
         */
        user: string;
    };
};
type GetWhatsAppBlockStatusResponse = ({
    blocked?: boolean;
});
type GetWhatsAppBlockStatusError = ({
    error?: string;
} | unknown);
type GetWhatsAppBlockedUsersData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Cursor from a previous response's `nextCursor`.
         */
        after?: string;
        /**
         * Page size.
         */
        limit?: number;
    };
};
type GetWhatsAppBlockedUsersResponse = ({
    blockedUsers?: Array<{
        /**
         * WhatsApp user ID (usually the phone number without `+`).
         */
        waId?: string;
    }>;
    /**
     * Pass as `after` to fetch the next page. Null when there are no more pages.
     */
    nextCursor?: (string) | null;
});
type GetWhatsAppBlockedUsersError = ({
    error?: string;
} | unknown);
type BlockWhatsAppUsersData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Phone numbers (E.164, e.g. "+16505551234") or WhatsApp user IDs to block.
         */
        users: Array<(string)>;
    };
};
type BlockWhatsAppUsersResponse = ({
    /**
     * Users successfully blocked.
     */
    blocked?: Array<{
        /**
         * The value you sent.
         */
        input?: string;
        /**
         * Resolved WhatsApp user ID.
         */
        waId?: string;
    }>;
    /**
     * Users that could not be blocked, with reasons.
     */
    failed?: Array<{
        input?: string;
        errors?: Array<(string)>;
    }>;
});
type BlockWhatsAppUsersError = ({
    error?: string;
} | unknown);
type UnblockWhatsAppUsersData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Phone numbers (E.164) or WhatsApp user IDs to unblock.
         */
        users: Array<(string)>;
    };
};
type UnblockWhatsAppUsersResponse = ({
    /**
     * Users successfully unblocked.
     */
    unblocked?: Array<{
        /**
         * The value you sent.
         */
        input?: string;
        /**
         * Resolved WhatsApp user ID.
         */
        waId?: string;
    }>;
    /**
     * Users that could not be unblocked, with reasons.
     */
    failed?: Array<{
        input?: string;
        errors?: Array<(string)>;
    }>;
});
type UnblockWhatsAppUsersError = ({
    error?: string;
} | unknown);
type ListWhatsAppAccountEventsData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Maximum events to return
         */
        limit?: number;
    };
};
type ListWhatsAppAccountEventsResponse = ({
    events?: Array<{
        id?: string;
        /**
         * WhatsApp social account the event belongs to
         */
        accountId?: string;
        /**
         * Event kind, e.g. template_approved, template_rejected, account_restricted, account_disconnected
         */
        type?: string;
        severity?: 'info' | 'success' | 'warning' | 'critical';
        title?: string;
        detail?: (string) | null;
        createdAt?: string;
    }>;
});
type ListWhatsAppAccountEventsError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetWhatsAppDatasetData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type GetWhatsAppDatasetResponse = ({
    /**
     * Meta dataset ID linked to the WABA, or null if not provisioned yet
     */
    datasetId?: (string) | null;
});
type GetWhatsAppDatasetError = ({
    error?: string;
} | unknown);
type CreateWhatsAppDatasetData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type CreateWhatsAppDatasetResponse = ({
    /**
     * Meta dataset ID linked to the WABA
     */
    datasetId?: string;
    /**
     * True if Meta created a new dataset on this call; false if one already existed
     */
    created?: boolean;
});
type CreateWhatsAppDatasetError = ({
    error?: string;
} | unknown);
type ListPhoneNumbersData = {
    query?: {
        /**
         * Filter by profile
         */
        profileId?: string;
        /**
         * Filter by status (by default excludes released numbers). NOTE:
         * `status=pending_regulatory` returns the "provisioning" view — numbers
         * still in review PLUS recently-declined (last 30 days) ones, so a
         * failed registration surfaces (with `regulatoryDeclineReason`) instead
         * of silently disappearing. Declined numbers can be re-submitted via
         * POST /v1/phone-numbers/{id}/remediate. `verifying` is the
         * short-lived state after the number is provisioned on our side while
         * WhatsApp confirms the activation code; the number is not billed until
         * it reaches `active`.
         *
         */
        status?: 'provisioning' | 'verifying' | 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'active' | 'suspended' | 'releasing' | 'released';
    };
};
type ListPhoneNumbersResponse = ({
    numbers?: Array<{
        _id?: string;
        phoneNumber?: string;
        country?: string;
        status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
        /**
         * For regulated numbers, who it's registered for (company or person) — set from the submitted KYC.
         */
        registrantName?: (string) | null;
        /**
         * Present once the number order has been placed (i.e. the requirement group was approved). Absent while still in identity review.
         */
        telnyxOrderId?: (string) | null;
        /**
         * Per-country monthly price in cents ($2..$25).
         */
        monthlyCents?: number;
        /**
         * False for numbers you brought yourself (connected via Meta embedded signup) — they live on your own carrier, so SMS/Calls can't be enabled on them.
         */
        hostedByZernio?: boolean;
        profileId?: {
            [key: string]: unknown;
        };
        provisionedAt?: string;
        metaPreverifiedId?: string;
        metaVerificationStatus?: string;
        /**
         * For regulated (Tier 3/4) numbers with an Onfido ID-verification step — the link to forward to the end user. Set once the order is placed; null otherwise. Poll this field after submitting KYC.
         */
        onfidoVerificationUrl?: (string) | null;
        endUserFirstName?: (string) | null;
        endUserLastName?: (string) | null;
        /**
         * Reviewer rejection reason when status is regulatory_declined.
         */
        regulatoryDeclineReason?: (string) | null;
        /**
         * Whether WhatsApp Business Calling is enabled on this number (manage via /v1/whatsapp/phone-numbers/{id}/calling).
         */
        callingEnabled?: boolean;
        createdAt?: string;
    }>;
    /**
     * Connected (bring-your-own) WhatsApp numbers — your own WABA
     * numbers linked via Embedded Signup. Not provisioned or billed
     * by Zernio, so they are not in `numbers`; `accountId` is the
     * social-account id used by the messaging and inbox endpoints.
     * Included only on the default and `status=active` views.
     *
     */
    connected?: Array<{
        accountId?: string;
        phoneNumber?: (string) | null;
        displayName?: (string) | null;
        profileId?: (string) | null;
        connectedAt?: (string) | null;
        /**
         * Whether WhatsApp Business Calling is enabled on this number.
         */
        callingEnabled?: boolean;
    }>;
    /**
     * The shared WhatsApp sandbox (one Zernio-owned number, all users test
     * against it). Present when the sandbox is configured; null otherwise.
     * The `accountId` lets you address the sandbox in compose endpoints.
     * `template` is the only template a sandbox send is allowed to use.
     *
     */
    sandbox?: {
        phoneNumber?: string;
        accountId?: (string) | null;
        template?: {
            name?: string;
            language?: string;
        };
        isSandbox?: boolean;
    } | null;
});
type ListPhoneNumbersError = ({
    error?: string;
});
type GetPhoneNumberData = {
    path: {
        /**
         * Phone number record ID
         */
        id: string;
    };
};
type GetPhoneNumberResponse = ({
    phoneNumber?: {
        id?: string;
        phoneNumber?: string;
        status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
        country?: string;
        metaPreverifiedId?: string;
        metaVerificationStatus?: string;
        /**
         * For a regulated number with an Onfido ID step — the link to forward to the end user. Appears once the order is placed; null otherwise.
         */
        onfidoVerificationUrl?: (string) | null;
        endUserFirstName?: (string) | null;
        endUserLastName?: (string) | null;
        /**
         * Reviewer rejection reason when status is regulatory_declined.
         */
        regulatoryDeclineReason?: (string) | null;
        provisionedAt?: string;
    };
});
type GetPhoneNumberError = ({
    error?: string;
});
type ReleasePhoneNumberData = {
    path: {
        /**
         * Phone number record ID
         */
        id: string;
    };
};
type ReleasePhoneNumberResponse = ({
    message?: string;
    phoneNumber?: {
        id?: string;
        phoneNumber?: string;
        /**
         * "released"
         */
        status?: string;
        releasedAt?: string;
    };
});
type ReleasePhoneNumberError = (unknown | {
    error?: string;
});
type PurchasePhoneNumberData = {
    body: {
        /**
         * Preferred profile for the number. One number = one profile, so when the requested profile already holds a number the API assigns the next free profile instead (or creates one) and returns the actual assignment in `profileId` on the response.
         *
         */
        profileId: string;
        /**
         * ISO 3166-1 alpha-2 country for the number (default US). International numbers require usage-based billing. Tier 3/4 countries return 202 { status: "kyc_required", kycUrl } — the customer must complete KYC at that URL before the number is ordered. See GET /v1/phone-numbers/countries.
         *
         */
        country?: string;
        /**
         * Which of the country's offered number types to order (see `types[]` on GET /v1/phone-numbers/countries). Omitted = the country's default type, which is always the WhatsApp-safe choice. Capabilities, price, and KYC requirements are per (country, type): toll_free can never connect WhatsApp (400 when combined with connectWhatsapp:true), and wantsSms:true requires an SMS-capable type.
         *
         */
        numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
        /**
         * Area code (national destination code, e.g. 11 for Sao Paulo) the number must be in. Hard constraint: when the area has no deliverable inventory the purchase fails with 409 code AREA_CODE_UNAVAILABLE instead of assigning a number from another area, and later replacements stay in this area too. Omit for any area. Get live options from GET /v1/phone-numbers/availability (areaOptions).
         *
         */
        areaCode?: string;
        /**
         * A phone number is the unit; WhatsApp is one optional feature. Pass false to buy a STANDALONE number (Calls/SMS only): provisioning skips the Meta pre-verify/OTP steps and the number activates immediately. Omitted defaults to the WhatsApp provisioning path. WhatsApp can be connected to a standalone number later from the connect flow.
         *
         */
        connectWhatsapp?: boolean;
        /**
         * SMS capability is per-number, not per-country. Pass true to provision from the SMS-capable inventory pool so the number can actually text (see also GET /v1/phone-numbers/available with sms=true, and smsAvailable on GET /v1/phone-numbers/countries).
         *
         */
        wantsSms?: boolean;
        /**
         * Declare WhatsApp intent on a STANDALONE purchase (connectWhatsapp:false). The number still activates and bills immediately, but if WhatsApp's buy-time check rejects the assigned number, it is automatically swapped for a WhatsApp-eligible one during the purchase instead of being delivered with WhatsApp unavailable. Ignored on the WhatsApp provisioning path (connectWhatsapp omitted or true), which always delivers a WhatsApp-verified number.
         *
         */
        wantsWhatsapp?: boolean;
        /**
         * Optional idempotency key. Send the same value when retrying a purchase: if a number was already bought under this key, the API returns { status: "already_purchased", numberId, phoneNumber, profileId } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.
         *
         */
        purchaseIntentId?: string;
        /**
         * Any second purchase within 10 minutes of a previous one is rejected with 409 code PURCHASE_VELOCITY as duplicate protection. Pass true to confirm the additional purchase is intentional (e.g. bulk provisioning).
         *
         */
        allowMultiple?: boolean;
    };
};
type PurchasePhoneNumberResponse = (({
    message?: string;
    checkoutUrl?: string;
} | {
    message?: string;
    phoneNumber?: {
        id?: string;
        phoneNumber?: string;
        status?: string;
        country?: string;
        provisionedAt?: string;
        metaPreverifiedId?: string;
        metaVerificationStatus?: string;
        /**
         * The profile the number was actually assigned to.
         */
        profileId?: string;
    };
} | {
    status?: 'already_purchased';
    numberId?: string;
    phoneNumber?: string;
    /**
     * The profile the number was actually assigned to.
     */
    profileId?: string;
}) | {
    status?: 'kyc_required';
    country?: string;
    /**
     * The type that will be ordered after KYC approval.
     */
    numberType?: string;
    kycUrl?: string;
});
type PurchasePhoneNumberError = (unknown | {
    error?: string;
} | {
    error?: string;
    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE';
});
type ListPhoneNumberCountriesResponse = ({
    countries?: Array<{
        /**
         * ISO 3166-1 alpha-2
         */
        code?: string;
        tier?: 1 | 2 | 3 | 4;
        monthlyCents?: number;
        needsKyc?: boolean;
        /**
         * Regular phone (PSTN) calling on the number, inbound + outbound. Available on every offerable country.
         */
        callsAvailable?: boolean;
        /**
         * WhatsApp can be enabled on numbers from this country.
         */
        whatsappAvailable?: boolean;
        /**
         * Whether this country's number type can do SMS. Use it to filter the picker when the buyer wants SMS (pair with `wantsSms` on purchase).
         */
        smsAvailable?: boolean;
        /**
         * WhatsApp Business Calling (BIC) outbound availability, a Meta feature blocked in some countries. NOT the PSTN Calls feature (`callsAvailable`).
         */
        outboundCallingAvailable?: boolean;
        /**
         * Live carrier-stock snapshot (refreshed every 6h + on availability checks): false when NO offered type currently has deliverable inventory, so a purchase would fail. Treat as advisory; the purchase itself re-checks.
         */
        inStock?: boolean;
        /**
         * Every number type offered in this country (default first). Capabilities, KYC tier, monthly price, and stock are per type. The country-level fields above mirror the first (default) entry. Pass the chosen `numberType` to POST /v1/phone-numbers/purchase.
         *
         */
        types?: Array<{
            numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
            tier?: 1 | 2 | 3 | 4;
            needsKyc?: boolean;
            monthlyCents?: number;
            /**
             * Always false for toll_free (WhatsApp does not reliably register toll-free numbers).
             */
            whatsappAvailable?: boolean;
            smsAvailable?: boolean;
            callsAvailable?: boolean;
            inStock?: boolean;
        }>;
    }>;
});
type ListPhoneNumberCountriesError = ({
    error?: string;
});
type SearchAvailablePhoneNumbersData = {
    query?: {
        /**
         * Pattern to match within the number
         */
        contains?: string;
        country?: string;
        limit?: number;
        /**
         * City
         */
        locality?: string;
        /**
         * Area code
         */
        prefix?: string;
        /**
         * true narrows the pool to SMS-capable numbers. Each result still carries its full `features` list for per-number capability badging.
         */
        sms?: boolean;
        /**
         * Number type; defaults to the country's WhatsApp-safe type
         */
        type?: string;
    };
};
type SearchAvailablePhoneNumbersResponse = ({
    country?: string;
    numberType?: string;
    /**
     * Echo of the `sms` filter applied to this search.
     */
    requireSms?: boolean;
    numbers?: Array<{
        phoneNumber?: string;
        /**
         * Provider capability list for this number (e.g. voice, sms, mms).
         */
        features?: Array<(string)>;
    }>;
});
type SearchAvailablePhoneNumbersError = (unknown | {
    error?: string;
});
type CheckPhoneNumberAvailabilityData = {
    query: {
        /**
         * ISO-2 country code.
         */
        country: string;
        /**
         * Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
         */
        numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
        /**
         * Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.
         */
        sms?: boolean;
    };
};
type CheckPhoneNumberAvailabilityResponse = ({
    country?: string;
    numberType?: string;
    /**
     * Whether deliverable voice inventory exists right now.
     */
    available?: boolean;
    addressConstraint?: 'geo' | 'country' | 'none';
    /**
     * For `geo` only — the area(s) the registered address must be in.
     */
    areas?: Array<(string)>;
    /**
     * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area.
     *
     */
    areaOptions?: Array<{
        /**
         * Area code (national destination code), e.g. "11".
         */
        ndc?: string;
        /**
         * Area name: "City, ST" for US/CA (e.g. "Miami, FL"), city otherwise (e.g. "Sao Paulo").
         */
        name?: string;
        /**
         * Numbers available in this area: country-wide count for US/CA, numbers seen on the latest inventory page otherwise.
         */
        count?: number;
    }>;
});
type CheckPhoneNumberAvailabilityError = (unknown | {
    error?: string;
});
type GetWhatsAppPhoneNumbersData = {
    query?: {
        /**
         * Filter by profile
         */
        profileId?: string;
        /**
         * Filter by status (by default excludes released numbers). NOTE:
         * `status=pending_regulatory` returns the "provisioning" view — numbers
         * still in review PLUS recently-declined (last 30 days) ones, so a
         * failed registration surfaces (with `regulatoryDeclineReason`) instead
         * of silently disappearing. Declined numbers can be re-submitted via
         * POST /v1/whatsapp/phone-numbers/{id}/remediate. `verifying` is the
         * short-lived state after the number is provisioned on our side while
         * WhatsApp confirms the activation code; the number is not billed until
         * it reaches `active`.
         *
         */
        status?: 'provisioning' | 'verifying' | 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'active' | 'suspended' | 'releasing' | 'released';
    };
};
type GetWhatsAppPhoneNumbersResponse = ({
    numbers?: Array<{
        _id?: string;
        phoneNumber?: string;
        country?: string;
        status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
        /**
         * For regulated numbers, who it's registered for (company or person) — set from the submitted KYC.
         */
        registrantName?: (string) | null;
        /**
         * Present once the number order has been placed (i.e. the requirement group was approved). Absent while still in identity review.
         */
        telnyxOrderId?: (string) | null;
        /**
         * Per-country monthly price in cents ($2..$25).
         */
        monthlyCents?: number;
        /**
         * False for numbers you brought yourself (connected via Meta embedded signup) — they live on your own carrier, so SMS/Calls can't be enabled on them.
         */
        hostedByZernio?: boolean;
        profileId?: {
            [key: string]: unknown;
        };
        provisionedAt?: string;
        metaPreverifiedId?: string;
        metaVerificationStatus?: string;
        /**
         * For regulated (Tier 3/4) numbers with an Onfido ID-verification step — the link to forward to the end user. Set once the order is placed; null otherwise. Poll this field after submitting KYC.
         */
        onfidoVerificationUrl?: (string) | null;
        endUserFirstName?: (string) | null;
        endUserLastName?: (string) | null;
        /**
         * Reviewer rejection reason when status is regulatory_declined.
         */
        regulatoryDeclineReason?: (string) | null;
        /**
         * Whether WhatsApp Business Calling is enabled on this number (manage via /v1/whatsapp/phone-numbers/{id}/calling).
         */
        callingEnabled?: boolean;
        createdAt?: string;
    }>;
    /**
     * Connected (bring-your-own) WhatsApp numbers — your own WABA
     * numbers linked via Embedded Signup. Not provisioned or billed
     * by Zernio, so they are not in `numbers`; `accountId` is the
     * social-account id used by the messaging and inbox endpoints.
     * Included only on the default and `status=active` views.
     *
     */
    connected?: Array<{
        accountId?: string;
        phoneNumber?: (string) | null;
        displayName?: (string) | null;
        profileId?: (string) | null;
        connectedAt?: (string) | null;
        /**
         * Whether WhatsApp Business Calling is enabled on this number.
         */
        callingEnabled?: boolean;
    }>;
    /**
     * The shared WhatsApp sandbox (one Zernio-owned number, all users test
     * against it). Present when the sandbox is configured; null otherwise.
     * The `accountId` lets you address the sandbox in compose endpoints.
     * `template` is the only template a sandbox send is allowed to use.
     *
     */
    sandbox?: {
        phoneNumber?: string;
        accountId?: (string) | null;
        template?: {
            name?: string;
            language?: string;
        };
        isSandbox?: boolean;
    } | null;
});
type GetWhatsAppPhoneNumbersError = (ErrorResponse | {
    error?: string;
});
type PurchaseWhatsAppPhoneNumberData = {
    body: {
        /**
         * Profile to associate the number with
         */
        profileId: string;
        /**
         * ISO 3166-1 alpha-2 country for the number (default US). International numbers require usage-based billing. Tier 3/4 countries return 202 { status: "kyc_required", kycUrl } — the customer must complete KYC at that URL before the number is ordered. See GET /v1/whatsapp/phone-numbers/countries.
         *
         */
        country?: string;
        /**
         * Optional idempotency key. Send the same value when retrying a purchase: if a number was already bought under this key, the API returns { status: "already_purchased", numberId, phoneNumber } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.
         *
         */
        purchaseIntentId?: string;
        /**
         * Any second purchase within 10 minutes of a previous one is rejected with 409 code PURCHASE_VELOCITY as duplicate protection. Pass true to confirm the additional purchase is intentional (e.g. bulk provisioning).
         *
         */
        allowMultiple?: boolean;
    };
};
type PurchaseWhatsAppPhoneNumberResponse = (({
    message?: string;
    checkoutUrl?: string;
} | {
    message?: string;
    phoneNumber?: {
        id?: string;
        phoneNumber?: string;
        status?: string;
        country?: string;
        provisionedAt?: string;
        metaPreverifiedId?: string;
        metaVerificationStatus?: string;
    };
} | {
    status?: 'already_purchased';
    numberId?: string;
    phoneNumber?: string;
}) | {
    status?: 'kyc_required';
    country?: string;
    /**
     * The type that will be ordered after KYC approval.
     */
    numberType?: string;
    kycUrl?: string;
});
type PurchaseWhatsAppPhoneNumberError = (unknown | {
    error?: string;
} | {
    error?: string;
    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE';
});
type ListWhatsAppNumberCountriesResponse = ({
    countries?: Array<{
        /**
         * ISO 3166-1 alpha-2
         */
        code?: string;
        tier?: 1 | 2 | 3 | 4;
        monthlyCents?: number;
        needsKyc?: boolean;
        outboundCallingAvailable?: boolean;
    }>;
});
type ListWhatsAppNumberCountriesError = ({
    error?: string;
});
type SearchAvailableWhatsAppNumbersData = {
    query?: {
        /**
         * Pattern to match within the number
         */
        contains?: string;
        country?: string;
        limit?: number;
        /**
         * City
         */
        locality?: string;
        /**
         * Area code
         */
        prefix?: string;
        /**
         * Number type; defaults to the country's WhatsApp-safe type
         */
        type?: string;
    };
};
type SearchAvailableWhatsAppNumbersResponse = ({
    country?: string;
    numberType?: string;
    numbers?: Array<{
        phoneNumber?: string;
    }>;
});
type SearchAvailableWhatsAppNumbersError = (unknown | {
    error?: string;
});
type CheckWhatsAppNumberAvailabilityData = {
    query: {
        /**
         * ISO-2 country code.
         */
        country: string;
        /**
         * Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
         */
        numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
        /**
         * Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.
         */
        sms?: boolean;
    };
};
type CheckWhatsAppNumberAvailabilityResponse = ({
    country?: string;
    numberType?: string;
    /**
     * Whether deliverable voice inventory exists right now.
     */
    available?: boolean;
    addressConstraint?: 'geo' | 'country' | 'none';
    /**
     * For `geo` only — the area(s) the registered address must be in.
     */
    areas?: Array<(string)>;
    /**
     * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area.
     *
     */
    areaOptions?: Array<{
        /**
         * Area code (national destination code), e.g. "11".
         */
        ndc?: string;
        /**
         * Area name: "City, ST" for US/CA (e.g. "Miami, FL"), city otherwise (e.g. "Sao Paulo").
         */
        name?: string;
        /**
         * Numbers available in this area: country-wide count for US/CA, numbers seen on the latest inventory page otherwise.
         */
        count?: number;
    }>;
});
type CheckWhatsAppNumberAvailabilityError = (unknown | {
    error?: string;
});
type GetPhoneNumberKycFormData = {
    query: {
        country: string;
        /**
         * Requirements and reuse eligibility are per (country, type). Omitted = the country's default type. Pass the same value on the POST.
         */
        numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
    };
};
type GetPhoneNumberKycFormResponse = ({
    country?: string;
    numberType?: string;
    fields?: Array<{
        requirementId?: string;
        label?: string;
        /**
         * "action" = an out-of-band verification (e.g. Onfido); not filled here, fulfilled after the order via a link.
         */
        kind?: 'text' | 'date' | 'address' | 'file' | 'action';
        /**
         * Plain-English explanation of what to provide.
         */
        description?: (string) | null;
        /**
         * Concrete example value.
         */
        example?: (string) | null;
        /**
         * ISO country the value must be local to
         */
        localTo?: (string) | null;
    }>;
    /**
     * Present when this account already has a reusable verification for the country (skip the form). `fromPhoneNumber`/`details` mirror the first option; `options` lists ALL reusable verifications (agencies hold one per end client), approved-first. Pass the chosen option's `id` as `reuseOptionId` on POST. Each option's `instant` says whether it activates in minutes (group-approved) or still queues for carrier review (1-3 days).
     */
    reusable?: {
        available?: boolean;
        fromPhoneNumber?: string;
        /**
         * Human-readable summary of the verification on file (field labels + values, plus the address as one line). Best-effort — may be empty if the provider lookup fails.
         */
        details?: Array<{
            label?: string;
            value?: string;
        }>;
        /**
         * One entry per distinct approved verification, newest first.
         */
        options?: Array<{
            /**
             * Opaque option id — pass as `reuseOptionId` on POST. Stable selection key (a phone number is not unique across verifications).
             */
            id?: string;
            /**
             * Display only — the number this verification was submitted for. Not a selection key.
             */
            fromPhoneNumber?: string;
            /**
             * true = group-approved, a new order activates in minutes; false = documents are reused but the order still queues for carrier review (1-3 days).
             */
            instant?: boolean;
            details?: Array<{
                label?: string;
                value?: string;
                /**
                 * Present on document rows — the Telnyx document id. GET /v1/whatsapp/phone-numbers/kyc/document/{documentId} streams it (auth-scoped, inline PDF).
                 */
                documentId?: string;
            }>;
        }>;
    } | null;
    /**
     * true when this account already has a number for this country in regulatory review (status pending_regulatory). Scope is the whole account across all profiles, and the country only (any number type), so it is not a per-end-client signal on a multi-tenant setup. Informational only: it never blocks a submission, and several same-country numbers may sit in review at once. For a per-end-client view, call GET /v1/phone-numbers with `profileId` and `status=pending_regulatory`; that view also lists numbers declined in the last 30 days.
     */
    pendingReview?: boolean;
});
type GetPhoneNumberKycFormError = (unknown | {
    error?: string;
});
type SubmitPhoneNumberKycData = {
    body: {
        profileId: string;
        country: string;
        /**
         * Idempotency token for this submission attempt. Once the number has been ordered, a retry with the same token returns that same number instead of ordering another. A submission that fails before the number is ordered releases the token, so you can correct your details and re-submit with it. Omit it and every call provisions a new number.
         */
        submissionId?: string;
        /**
         * Provision several same-country numbers from one submission (1-5). The single verification covers all of them; each number is billed only when it activates. Numbers that fail to order are skipped (best-effort). With `areaCode`, a quantity above that area's live stock is rejected with a 400.
         */
        quantity?: number;
        /**
         * Reuse a prior approved verification for this country (skips document/field collection; places the order immediately).
         */
        reuse?: boolean;
        /**
         * Which reusable verification to use (GET reusable.options[].id). The unambiguous selection key. Omitted = the approved default. No match = 409.
         */
        reuseOptionId?: string;
        /**
         * Legacy fallback for `reuseOptionId`: the source phone number (GET reusable.options[].fromPhoneNumber). Ambiguous when a number labels two verifications — prefer `reuseOptionId`. Omitted = the approved default. No match = 409.
         */
        reuseFrom?: string;
        /**
         * Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
         */
        areaCode?: string;
        /**
         * End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
         */
        endUserFirstName?: string;
        /**
         * End user's legal last name. Same condition as endUserFirstName.
         */
        endUserLastName?: string;
        /**
         * requirementId → textual value
         */
        values?: {
            [key: string]: (string);
        };
        /**
         * One per document requirement. Each is EITHER inline base64 OR a `documentId` returned by POST /v1/phone-numbers/kyc/upload-document (use the upload endpoint for large files to stay under the request-size limit).
         */
        documents?: Array<({
            requirementId: string;
            filename: string;
            base64: string;
        } | {
            requirementId: string;
            /**
             * Id from POST /v1/phone-numbers/kyc/upload-document.
             */
            documentId: string;
        })>;
        address?: {
            requirementId?: string;
            country_code?: string;
            business_name?: string;
            first_name?: string;
            last_name?: string;
            street_address?: string;
            /**
             * Address complement: apartment, suite, unit, or the quadra/lote used in some countries. Optional. Does not substitute for a building number on street_address.
             */
            extended_address?: string;
            locality?: string;
            administrative_area?: string;
            postal_code?: string;
        };
    };
};
type SubmitPhoneNumberKycResponse = ({
    status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
    /**
     * The first/primary number, kept at the top level for backward compatibility. See `numbers` for the full set when `quantity` > 1.
     */
    phoneNumber?: {
        id?: string;
        status?: string;
        country?: string;
    };
    /**
     * Every number provisioned from this submission. Length equals the requested `quantity` on full success (fewer if some orders failed; best-effort). The first element mirrors `phoneNumber`.
     */
    numbers?: Array<{
        id?: string;
        status?: string;
        phoneNumber?: string;
        country?: string;
    }>;
});
type SubmitPhoneNumberKycError = (unknown | {
    error?: string;
});
type ViewPhoneNumberKycDocumentData = {
    path: {
        /**
         * The Telnyx document id (from `reusable.options[].details[].documentId`).
         */
        documentId: string;
    };
};
type ViewPhoneNumberKycDocumentResponse = ((Blob | File));
type ViewPhoneNumberKycDocumentError = (ErrorResponse | {
    error?: string;
} | unknown);
type UploadPhoneNumberKycDocumentData = {
    body: (Blob | File);
    headers: {
        /**
         * URL-encoded original filename.
         */
        'X-Filename': string;
    };
};
type UploadPhoneNumberKycDocumentResponse = ({
    /**
     * Reference this id in the KYC submit's documents[].documentId.
     */
    documentId?: string;
});
type UploadPhoneNumberKycDocumentError = (unknown | {
    error?: string;
});
type ValidatePhoneNumberKycAddressData = {
    body: {
        /**
         * ISO 3166-1 alpha-2 country code.
         */
        country: string;
        street_address: string;
        /**
         * Address complement: apartment, suite, unit, or the quadra/lote used in some countries. Optional. Does not substitute for a building number on street_address.
         */
        extended_address?: string;
        /**
         * City / town.
         */
        locality: string;
        /**
         * State / province / region. When omitted, the pre-check is skipped (the final submit still validates).
         */
        administrative_area?: string;
        postal_code: string;
    };
};
type ValidatePhoneNumberKycAddressResponse = ({
    ok?: boolean;
    /**
     * true when no `administrative_area` was supplied, so no pre-check ran.
     */
    skipped?: boolean;
});
type ValidatePhoneNumberKycAddressError = ({
    /**
     * Human-readable message.
     */
    error?: string;
    type?: string;
    code?: string;
    param?: string;
    details?: {
        addressSuggestions?: Array<{
            field?: string;
            label?: string;
            value?: string;
        }>;
    };
} | {
    error?: string;
});
type CreatePhoneNumberKycLinkData = {
    body: {
        profileId: string;
        /**
         * ISO 3166-1 alpha-2 country code (must be a regulated/KYC country).
         */
        country: string;
        /**
         * Area code (NDC) the eventual number must be in. Hard constraint carried by the link; the end customer filling the form makes no area choice. Options come from GET /v1/phone-numbers/availability (areaOptions).
         */
        areaCode?: string;
        /**
         * Optional white-label of the hosted page the end customer sees.
         */
        branding?: {
            /**
             * Your company name, shown on the hosted page.
             */
            companyName?: string;
            /**
             * Logo shown above the form.
             */
            logoUrl?: string;
            /**
             * Hex color (e.g. #1a73e8) used as a brand accent on the page.
             */
            brandColor?: string;
        };
        /**
         * Where to send the end customer's browser after a successful
         * submit. On completion Zernio appends `kyc=submitted` and
         * `country=<ISO-2>` as query params. When omitted, the hosted
         * page shows a built-in confirmation screen instead.
         *
         */
        redirect_url?: string;
    };
};
type CreatePhoneNumberKycLinkResponse = ({
    /**
     * The hosted link to send your end customer.
     */
    url?: string;
    token?: string;
    expiresAt?: string;
});
type CreatePhoneNumberKycLinkError = (unknown | {
    error?: string;
});
type CreatePhoneNumberPortInData = {
    body: {
        /**
         * E.164 numbers to port in.
         */
        phoneNumbers: Array<(string)>;
        /**
         * End-user / current-carrier account info that authorizes the port. The
         * losing carrier matches every field against its records and rejects the
         * whole port on a mismatch — enter values exactly as they appear on the
         * carrier bill.
         *
         */
        endUser: {
            /**
             * Account holder / business name, as on the carrier account.
             */
            entityName: string;
            /**
             * Full name (first + last) of the person authorizing the port — must match the LOA signature.
             */
            authPersonName: string;
            /**
             * Phone number on the losing carrier's bill. Defaults to the ported number itself on single-number orders. Validated as a real phone number when present.
             */
            billingPhoneNumber?: string;
            /**
             * Account number with the losing carrier — required (carriers reject ports without it; on prepaid mobile plans it is often the phone number itself).
             */
            accountNumber: string;
            /**
             * Transfer PIN. Required for US/CA mobile numbers (wireless carriers reject PIN-less ports). Forwarded to the carrier, never stored. International porting codes (e.g. the UK PAC) go through `requirements` instead.
             */
            pinPasscode?: string;
            /**
             * Company tax id on the carrier account (EU ports, e.g. Spanish CIF).
             */
            taxIdentifier?: string;
            /**
             * Business registration id on the carrier account (EU ports).
             */
            businessIdentifier?: string;
            streetAddress: string;
            extendedAddress?: string;
            locality: string;
            /**
             * Region. Required for US/CA as the 2-letter state/province code (full names are accepted and normalized); optional elsewhere.
             */
            administrativeArea?: string;
            /**
             * Postal code. Validated as a US ZIP / Canadian postal code for US/CA; free-form elsewhere.
             */
            postalCode: string;
            /**
             * Service-address country (a supported port-in country).
             */
            countryCode: 'US' | 'CA' | 'GB' | 'ES' | 'DE' | 'FR' | 'NL' | 'AU' | 'BR';
        };
        /**
         * Document id from POST /v1/phone-numbers/port-in/documents (kind=loa).
         */
        loaDocumentId: string;
        /**
         * Document id from POST /v1/phone-numbers/port-in/documents (kind=invoice).
         */
        invoiceDocumentId: string;
        /**
         * Requested port date; the carrier confirms the actual FOC later. US/CA default is one week out (shifted off weekends); international orders are scheduled into the carrier's next allowed porting window at or after this date.
         */
        focDatetimeRequested?: string;
        customerReference?: string;
        /**
         * Whether the losing account ports all its numbers (full) or keeps some (partial).
         */
        portType?: 'full' | 'partial';
        /**
         * Country-specific requirement values for international ports (from GET /v1/phone-numbers/port-in/requirements). Not needed for US/CA. The LOA and invoice requirements are satisfied automatically by loaDocumentId/invoiceDocumentId, and address-type requirements by the endUser service address.
         */
        requirements?: Array<{
            /**
             * The requirement's id, from the requirements endpoint.
             */
            requirementTypeId: string;
            /**
             * Text value, ISO datetime, or a documentId from POST /v1/phone-numbers/port-in/documents, per the requirement's kind.
             */
            fieldValue: string;
        }>;
    };
};
type CreatePhoneNumberPortInResponse = ({
    /**
     * Porting order ID.
     */
    id?: string;
    telnyxPortingOrderId?: string;
    status?: 'draft' | 'pending' | 'foc_confirmed' | 'ported' | 'exception' | 'cancelled';
    phoneNumbers?: Array<(string)>;
    orders?: Array<{
        id?: string;
        telnyxPortingOrderId?: string;
        status?: string;
        phoneNumbers?: Array<(string)>;
        /**
         * Present when this split order failed to submit (it stays as a cancellable draft).
         */
        error?: string;
    }>;
});
type CreatePhoneNumberPortInError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListPhoneNumberPortInsResponse = ({
    orders?: Array<{
        id?: string;
        status?: 'draft' | 'pending' | 'foc_confirmed' | 'ported' | 'exception' | 'cancelled';
        /**
         * Raw carrier status string.
         */
        telnyxStatusValue?: (string) | null;
        phoneNumbers?: Array<(string)>;
        fastPortEligible?: (boolean) | null;
        focDatetimeRequested?: (string) | null;
        focDatetimeActual?: (string) | null;
        declineReason?: (string) | null;
        submittedAt?: (string) | null;
        portedAt?: (string) | null;
        createdAt?: string;
    }>;
});
type ListPhoneNumberPortInsError = ({
    error?: string;
});
type CheckPhoneNumberPortabilityData = {
    body: {
        /**
         * E.164 numbers to check, e.g. +13035550000.
         */
        phoneNumbers: Array<(string)>;
    };
};
type CheckPhoneNumberPortabilityResponse = ({
    results?: Array<{
        phoneNumber?: string;
        portable?: boolean;
        /**
         * Qualifies for the carrier's accelerated FastPort lane.
         */
        fastPortable?: boolean;
        /**
         * Line type when known (mobile, landline, voip…). A US/CA mobile number requires the transfer PIN at submit.
         */
        lineType?: (string) | null;
        /**
         * ISO country of the number — pass it to GET /v1/phone-numbers/port-in/requirements for international numbers.
         */
        countryCode?: (string) | null;
        /**
         * Carrier number-type classification (local, mobile, national, toll_free…) — the numberType for the requirements endpoint.
         */
        phoneNumberType?: (string) | null;
        /**
         * Carrier reason when not portable; null when portable.
         */
        notPortableReason?: (string) | null;
    }>;
});
type CheckPhoneNumberPortabilityError = ({
    error?: string;
});
type UploadPhoneNumberPortInDocumentData = {
    body: {
        /**
         * The document (PDF/JPEG/PNG, 10MB max).
         */
        file: (Blob | File);
        /**
         * 'loa', 'invoice', or any short slug for requirement documents. Informational; used for the stored filename.
         */
        kind?: string;
    };
};
type UploadPhoneNumberPortInDocumentResponse = ({
    documentId?: string;
});
type UploadPhoneNumberPortInDocumentError = (unknown | {
    error?: string;
});
type GetPhoneNumberPortInRequirementsData = {
    query: {
        /**
         * ISO country of the numbers being ported (a supported port-in country).
         */
        country: string;
        /**
         * The portability check's phoneNumberType — requirements differ by type.
         */
        numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
    };
};
type GetPhoneNumberPortInRequirementsResponse = ({
    country?: string;
    numberType?: string;
    /**
     * false when the combination includes a step that can't be completed through the API (e.g. an in-person identity verification) — porting it needs support.
     */
    supported?: boolean;
    fields?: Array<{
        /**
         * Pass back as requirements[].requirementTypeId.
         */
        requirementId?: string;
        label?: string;
        /**
         * text/date take a string value; file takes a documentId from the documents endpoint; address is satisfied automatically from the end-user service address.
         */
        kind?: 'text' | 'date' | 'address' | 'file' | 'action';
        description?: string;
        example?: string;
        /**
         * When present, the value must be one of these.
         */
        acceptableValues?: Array<(string)>;
    }>;
});
type GetPhoneNumberPortInRequirementsError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetPhoneNumberPortInOrderRequirementsData = {
    path: {
        /**
         * Porting order ID (from the port-in list).
         */
        id: string;
    };
};
type GetPhoneNumberPortInOrderRequirementsResponse = ({
    country?: string;
    requirements?: Array<{
        requirementId?: string;
        label?: string;
        kind?: 'text' | 'date' | 'address' | 'file' | 'action';
        description?: string;
        example?: string;
        acceptableValues?: Array<(string)>;
        /**
         * requirement-info-pending | requirement-info-under-review | requirement-info-exception | approved
         */
        status?: string;
        filled?: boolean;
    }>;
});
type GetPhoneNumberPortInOrderRequirementsError = (ErrorResponse | {
    error?: string;
} | unknown);
type CancelPhoneNumberPortInData = {
    path: {
        /**
         * Porting order ID (from the port-in list).
         */
        id: string;
    };
};
type CancelPhoneNumberPortInResponse = ({
    id?: string;
    status?: 'draft' | 'pending' | 'foc_confirmed' | 'ported' | 'exception' | 'cancelled';
});
type CancelPhoneNumberPortInError = ({
    error?: string;
} | unknown);
type ReviewPhoneNumberKycPacketData = {
    body: {
        country: string;
        numberType: string;
        /**
         * requirementId to declared textual value.
         */
        values?: {
            [key: string]: (string);
        };
        /**
         * Declared address (street_address, locality, ...), so a mismatched proof-of-address can be flagged.
         */
        address?: {
            [key: string]: (string);
        };
        docs: Array<{
            requirementId: string;
            /**
             * Id from POST /v1/phone-numbers/kyc/upload-document.
             */
            documentId: string;
        }>;
    };
};
type ReviewPhoneNumberKycPacketResponse = ({
    advisories?: Array<{
        requirementId?: string;
        /**
         * One short plain-language concern about that requirement's document.
         */
        concern?: string;
    }>;
});
type ReviewPhoneNumberKycPacketError = ({
    error?: string;
});
type GetPhoneNumberRemediationData = {
    path: {
        /**
         * Phone number record ID.
         */
        id: string;
    };
};
type GetPhoneNumberRemediationResponse = ({
    country?: string;
    numberType?: string;
    declineReason?: (string) | null;
    /**
     * Same field shape as GET /v1/phone-numbers/kyc.
     */
    fields?: Array<{
        [key: string]: unknown;
    }>;
});
type GetPhoneNumberRemediationError = (unknown | {
    error?: string;
});
type RemediatePhoneNumberData = {
    body: {
        values?: {
            [key: string]: (string);
        };
        documents?: Array<({
            requirementId: string;
            filename: string;
            base64: string;
        } | {
            requirementId: string;
            documentId: string;
        })>;
        /**
         * Same shape as the KYC submit address.
         */
        address?: {
            [key: string]: unknown;
        };
    };
    path: {
        id: string;
    };
};
type RemediatePhoneNumberResponse = ({
    status?: string;
    phoneNumber?: {
        id?: string;
        status?: string;
    };
});
type RemediatePhoneNumberError = (unknown | {
    error?: string;
});
type ReplyToPhoneNumberReviewerData = {
    body: {
        /**
         * The reply message to the reviewer.
         */
        text?: string;
        /**
         * Files (PDF/JPG/PNG/WEBP, max 10 MB each) whose links are added to the reply.
         */
        attachments?: Array<{
            filename: string;
            /**
             * Base64-encoded file bytes.
             */
            base64: string;
        }>;
    };
    path: {
        id: string;
    };
};
type ReplyToPhoneNumberReviewerResponse = ({
    posted?: boolean;
    /**
     * Number of attachments uploaded.
     */
    attachments?: number;
});
type ReplyToPhoneNumberReviewerError = (ErrorResponse | {
    error?: string;
} | unknown);
type RespondToPhoneNumberReviewerData = {
    body: {
        /**
         * Your message to the reviewer.
         */
        message?: string;
        /**
         * Corrected requirement documents, each keyed to its requirement.
         */
        documents?: Array<{
            requirementId: string;
            filename?: string;
            /**
             * Base64-encoded file bytes (or supply documentId instead).
             */
            base64?: string;
            /**
             * Id of a document already uploaded out-of-band.
             */
            documentId?: string;
        }>;
        /**
         * A corrected address record, keyed to its requirement.
         */
        address?: {
            [key: string]: unknown;
        };
        entityType?: ('individual' | 'business') | null;
        /**
         * Loose files (PDF/JPG/PNG/WEBP, max 10 MB each) whose links are added to your message.
         */
        attachments?: Array<{
            filename: string;
            /**
             * Base64-encoded file bytes.
             */
            base64: string;
        }>;
    };
    path: {
        id: string;
    };
};
type RespondToPhoneNumberReviewerResponse = ({
    /**
     * `resubmitted` when corrections were submitted, `replied` when it was message-only.
     */
    status?: 'resubmitted' | 'replied';
    /**
     * Whether a message/attachments were posted to the reviewer.
     */
    posted?: boolean;
    phoneNumber?: {
        id?: string;
        status?: string;
    };
    /**
     * Other numbers on the same registration the correction fanned out to.
     */
    siblingsResubmitted?: number;
});
type RespondToPhoneNumberReviewerError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetWhatsAppNumberKycFormData = {
    query: {
        country: string;
        profileId: string;
    };
};
type GetWhatsAppNumberKycFormResponse = ({
    country?: string;
    numberType?: string;
    fields?: Array<{
        requirementId?: string;
        label?: string;
        /**
         * "action" = an out-of-band verification (e.g. Onfido); not filled here, fulfilled after the order via a link.
         */
        kind?: 'text' | 'date' | 'address' | 'file' | 'action';
        /**
         * Plain-English explanation of what to provide.
         */
        description?: (string) | null;
        /**
         * Concrete example value.
         */
        example?: (string) | null;
        /**
         * ISO country the value must be local to
         */
        localTo?: (string) | null;
        /**
         * When set, the requirement applies ONLY to this end-user type — provide it for that type and OMIT it for the other (e.g. Brazil: "Cartão CNPJ" is business-only, "CPF" and "ID/Passport Copy" are personal-only). Submitting both sets makes the regulator ask whether the number is for personal or business use and stalls the review. Pass `entityType` on POST so the server drops the inapplicable set.
         */
        audience?: ('business' | 'individual') | null;
    }>;
    /**
     * Present when this account already has a reusable verification for the country (skip the form). `fromPhoneNumber`/`details` mirror the first option; `options` lists ALL reusable verifications (agencies hold one per end client), approved-first. Pass the chosen option's `id` as `reuseOptionId` on POST. Each option's `instant` says whether it activates in minutes (group-approved) or still queues for carrier review (1-3 days).
     */
    reusable?: {
        available?: boolean;
        fromPhoneNumber?: string;
        /**
         * Human-readable summary of the verification on file (field labels + values, plus the address as one line). Best-effort — may be empty if the provider lookup fails.
         */
        details?: Array<{
            label?: string;
            value?: string;
        }>;
        /**
         * One entry per distinct approved verification, newest first.
         */
        options?: Array<{
            /**
             * Opaque option id — pass as `reuseOptionId` on POST. Stable selection key (a phone number is not unique across verifications).
             */
            id?: string;
            /**
             * Display only — the number this verification was submitted for. Not a selection key.
             */
            fromPhoneNumber?: string;
            /**
             * true = group-approved, a new order activates in minutes; false = documents are reused but the order still queues for carrier review (1-3 days).
             */
            instant?: boolean;
            details?: Array<{
                label?: string;
                value?: string;
                /**
                 * Present on document rows — the Telnyx document id. GET /v1/whatsapp/phone-numbers/kyc/document/{documentId} streams it (auth-scoped, inline PDF).
                 */
                documentId?: string;
            }>;
        }>;
    } | null;
    /**
     * true when this account already has a number for this country in regulatory review (status pending_regulatory). Scope is the whole account across all profiles, and the country only (any number type), so it is not a per-end-client signal on a multi-tenant setup. Informational only: it never blocks a submission, and several same-country numbers may sit in review at once. For a per-end-client view, call GET /v1/phone-numbers with `profileId` and `status=pending_regulatory`; that view also lists numbers declined in the last 30 days.
     */
    pendingReview?: boolean;
});
type GetWhatsAppNumberKycFormError = (unknown | {
    error?: string;
});
type SubmitWhatsAppNumberKycData = {
    body: {
        profileId: string;
        country: string;
        /**
         * Idempotency token for this submission attempt. Once the number has been ordered, a retry with the same token returns that same number instead of ordering another. A submission that fails before the number is ordered releases the token, so you can correct your details and re-submit with it. Omit it and every call provisions a new number.
         */
        submissionId?: string;
        /**
         * Provision several same-country numbers from one submission (1-5). The single verification covers all of them; each number is billed only when it activates. Numbers that fail to order are skipped (best-effort). With `areaCode`, a quantity above that area's live stock is rejected with a 400.
         */
        quantity?: number;
        /**
         * Reuse a prior approved verification for this country (skips document/field collection; places the order immediately).
         */
        reuse?: boolean;
        /**
         * Which reusable verification to use (GET reusable.options[].id). The unambiguous selection key. Omitted = the approved default. No match = 409.
         */
        reuseOptionId?: string;
        /**
         * Legacy fallback for `reuseOptionId`: the source phone number (GET reusable.options[].fromPhoneNumber). Ambiguous when a number labels two verifications — prefer `reuseOptionId`. Omitted = the approved default. No match = 409.
         */
        reuseFrom?: string;
        /**
         * Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
         */
        areaCode?: string;
        /**
         * End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
         */
        endUserFirstName?: string;
        /**
         * End user's legal last name. Same condition as endUserFirstName.
         */
        endUserLastName?: string;
        /**
         * requirementId → textual value
         */
        values?: {
            [key: string]: (string);
        };
        /**
         * One per document requirement. Each is EITHER inline base64 OR a `documentId` returned by POST /v1/whatsapp/phone-numbers/kyc/upload-document (use the upload endpoint for large files to stay under the request-size limit).
         */
        documents?: Array<({
            requirementId: string;
            filename: string;
            base64: string;
        } | {
            requirementId: string;
            /**
             * Id from POST /v1/whatsapp/phone-numbers/kyc/upload-document.
             */
            documentId: string;
        })>;
        address?: {
            requirementId?: string;
            country_code?: string;
            business_name?: string;
            first_name?: string;
            last_name?: string;
            street_address?: string;
            /**
             * Address complement: apartment, suite, unit, or the quadra/lote used in some countries. Optional. Does not substitute for a building number on street_address.
             */
            extended_address?: string;
            locality?: string;
            administrative_area?: string;
            postal_code?: string;
        };
    };
};
type SubmitWhatsAppNumberKycResponse = ({
    status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
    /**
     * The first/primary number, kept at the top level for backward compatibility. See `numbers` for the full set when `quantity` > 1.
     */
    phoneNumber?: {
        id?: string;
        status?: string;
        country?: string;
    };
    /**
     * Every number provisioned from this submission. Length equals the requested `quantity` on full success (fewer if some orders failed; best-effort). The first element mirrors `phoneNumber`.
     */
    numbers?: Array<{
        id?: string;
        status?: string;
        phoneNumber?: string;
        country?: string;
    }>;
});
type SubmitWhatsAppNumberKycError = (unknown | {
    error?: string;
});
type UploadWhatsAppNumberKycDocumentData = {
    body: (Blob | File);
    headers: {
        /**
         * URL-encoded original filename.
         */
        'X-Filename': string;
    };
};
type UploadWhatsAppNumberKycDocumentResponse = ({
    /**
     * Reference this id in the KYC submit's documents[].documentId.
     */
    documentId?: string;
});
type UploadWhatsAppNumberKycDocumentError = (unknown | {
    error?: string;
});
type ValidateWhatsAppNumberKycAddressData = {
    body: {
        /**
         * ISO 3166-1 alpha-2 country code.
         */
        country: string;
        street_address: string;
        /**
         * Address complement: apartment, suite, unit, or the quadra/lote used in some countries. Optional. Does not substitute for a building number on street_address.
         */
        extended_address?: string;
        /**
         * City / town.
         */
        locality: string;
        /**
         * State / province / region. When omitted, the pre-check is skipped (the final submit still validates).
         */
        administrative_area?: string;
        postal_code: string;
    };
};
type ValidateWhatsAppNumberKycAddressResponse = ({
    ok?: boolean;
    /**
     * true when no `administrative_area` was supplied, so no pre-check ran.
     */
    skipped?: boolean;
});
type ValidateWhatsAppNumberKycAddressError = ({
    /**
     * Human-readable message.
     */
    error?: string;
    type?: string;
    code?: string;
    param?: string;
    details?: {
        addressSuggestions?: Array<{
            field?: string;
            label?: string;
            value?: string;
        }>;
    };
} | {
    error?: string;
});
type CreateWhatsAppNumberKycLinkData = {
    body: {
        profileId: string;
        /**
         * ISO 3166-1 alpha-2 country code (must be a regulated/KYC country).
         */
        country: string;
        /**
         * Area code (NDC) the eventual number must be in. Hard constraint carried by the link; the end customer filling the form makes no area choice. Options come from GET /v1/phone-numbers/availability (areaOptions).
         */
        areaCode?: string;
        /**
         * Optional white-label of the hosted page the end customer sees.
         */
        branding?: {
            /**
             * Your company name, shown on the hosted page.
             */
            companyName?: string;
            /**
             * Logo shown above the form.
             */
            logoUrl?: string;
            /**
             * Hex color (e.g. #1a73e8) used as a brand accent on the page.
             */
            brandColor?: string;
        };
        /**
         * Where to send the end customer's browser after a successful
         * submit. On completion Zernio appends `kyc=submitted` and
         * `country=<ISO-2>` as query params. When omitted, the hosted
         * page shows a built-in confirmation screen instead.
         *
         */
        redirect_url?: string;
    };
};
type CreateWhatsAppNumberKycLinkResponse = ({
    /**
     * The hosted link to send your end customer.
     */
    url?: string;
    token?: string;
    expiresAt?: string;
});
type CreateWhatsAppNumberKycLinkError = (unknown | {
    error?: string;
});
type MoveWhatsAppNumberToProfileData = {
    body: {
        /**
         * Destination profile id. Must belong to the same team.
         */
        profileId: string;
    };
    path: {
        /**
         * WhatsAppPhoneNumber id.
         */
        id: string;
    };
};
type MoveWhatsAppNumberToProfileResponse = ({
    message?: string;
    /**
     * The profile the number is now on.
     */
    profileId?: string;
    /**
     * Platforms whose accounts travelled with the number (phone, sms, whatsapp). Absent when the number was already on the destination profile.
     */
    movedPlatforms?: Array<(string)>;
});
type MoveWhatsAppNumberToProfileError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetWhatsAppNumberRemediationData = {
    path: {
        /**
         * WhatsAppPhoneNumber id.
         */
        id: string;
    };
};
type GetWhatsAppNumberRemediationResponse = ({
    country?: string;
    numberType?: string;
    declineReason?: (string) | null;
    /**
     * Same field shape as GET /v1/whatsapp/phone-numbers/kyc.
     */
    fields?: Array<{
        [key: string]: unknown;
    }>;
});
type GetWhatsAppNumberRemediationError = (unknown | {
    error?: string;
});
type RemediateWhatsAppNumberData = {
    body: {
        values?: {
            [key: string]: (string);
        };
        documents?: Array<({
            requirementId: string;
            filename: string;
            base64: string;
        } | {
            requirementId: string;
            documentId: string;
        })>;
        /**
         * Same shape as the KYC submit address.
         */
        address?: {
            [key: string]: unknown;
        };
    };
    path: {
        id: string;
    };
};
type RemediateWhatsAppNumberResponse = ({
    status?: string;
    phoneNumber?: {
        id?: string;
        status?: string;
    };
});
type RemediateWhatsAppNumberError = (unknown | {
    error?: string;
});
type EnableVoiceOnNumberData = {
    body?: {
        /**
         * tel:+E164, sip:..., or wss://... destination for inbound calls. Empty string clears the forward (outbound-only); omitted preserves the current one.
         */
        forwardTo?: string;
        recordingEnabled?: boolean;
        transcriptionEnabled?: boolean;
        transcriptionLanguage?: 'auto' | 'en' | 'es';
        /**
         * Voicemail is taken when there's no live destination. Default on.
         */
        voicemailEnabled?: boolean;
        /**
         * Custom spoken greeting; empty string restores the default.
         */
        voicemailGreeting?: string;
        /**
         * Outside the windows, inbound skips the forward and goes to voicemail. Off = 24/7.
         */
        businessHoursEnabled?: boolean;
        /**
         * IANA timezone the windows are evaluated in.
         */
        businessHoursTimezone?: string;
        businessHours?: Array<{
            /**
             * 0 = Sunday.
             */
            day: number;
            open: string;
            close: string;
        }>;
        /**
         * E.164 numbers rejected before answer. Replaces the whole list; bare 10-digit values are normalized as US numbers.
         */
        blockedCallers?: Array<(string)>;
        /**
         * Caller ID on the forwarded leg: your number (`business`) or the original caller's (`caller`).
         */
        forwardCallerId?: 'business' | 'caller';
        /**
         * IVR menu (supersedes the plain forward within business hours).
         */
        ivrEnabled?: boolean;
        ivrPrompt?: string;
        ivrOptions?: Array<{
            digit: string;
            /**
             * tel:+E164, sip:..., or wss://... destination for this digit.
             */
            forwardTo: string;
            label?: string;
        }>;
    };
    path: {
        /**
         * Phone number record ID (from GET /v1/phone-numbers).
         */
        id: string;
    };
};
type EnableVoiceOnNumberResponse = ({
    enabled?: boolean;
    phoneNumber?: string;
    pstnForwardTo?: (string) | null;
    recordingEnabled?: boolean;
    transcriptionEnabled?: boolean;
    transcriptionLanguage?: 'auto' | 'en' | 'es';
    voicemailEnabled?: boolean;
    voicemailGreeting?: (string) | null;
    businessHoursEnabled?: boolean;
    businessHoursTimezone?: (string) | null;
    businessHours?: Array<{
        day?: number;
        open?: string;
        close?: string;
    }>;
    blockedCallers?: Array<(string)>;
    forwardCallerId?: 'business' | 'caller';
    ivrEnabled?: boolean;
    ivrPrompt?: (string) | null;
    ivrOptions?: Array<{
        digit?: string;
        forwardTo?: string;
        label?: string;
    }>;
});
type EnableVoiceOnNumberError = ({
    error?: string;
} | unknown);
type DisableVoiceOnNumberData = {
    path: {
        id: string;
    };
};
type DisableVoiceOnNumberResponse = ({
    /**
     * Always false after a successful disable.
     */
    enabled?: boolean;
    phoneNumber?: string;
});
type DisableVoiceOnNumberError = ({
    error?: string;
} | unknown);
type EnableSmsOnNumberData = {
    path: {
        /**
         * Phone number record ID (from GET /v1/phone-numbers).
         */
        id: string;
    };
};
type EnableSmsOnNumberResponse = ({
    enabled?: boolean;
    /**
     * The SMS social account ID (present when enabled).
     */
    id?: string;
    phoneNumber?: string;
    /**
     * False for US numbers until their registration is approved.
     */
    isActive?: boolean;
    country?: string;
    /**
     * Null when capability can't be read yet (still provisioning).
     */
    smsCapable?: (boolean) | null;
    mmsCapable?: boolean;
    domesticOnly?: boolean;
    /**
     * Number is still provisioning at the carrier; retry shortly.
     */
    notReady?: boolean;
    /**
     * US only; a carrier registration is required before delivery.
     */
    needsRegistration?: boolean;
    /**
     * A prior non-rejected registration already covers this number; no re-submit needed.
     */
    alreadyRegistered?: boolean;
    registrationStatus?: ('pending' | 'approved' | 'rejected') | null;
    /**
     * Present when an existing approved registration can cover this number via /sms/reuse-registration.
     */
    reusable?: {
        registrationId?: string;
        status?: string;
    } | null;
    /**
     * Human-readable explanation when `enabled` is false.
     */
    message?: string;
});
type EnableSmsOnNumberError = ({
    error?: string;
} | unknown);
type DisableSmsOnNumberData = {
    path: {
        id: string;
    };
};
type DisableSmsOnNumberResponse = ({
    /**
     * Always false after a successful disable.
     */
    enabled?: boolean;
    phoneNumber?: string;
    /**
     * False when SMS was already off. Legacy field; prefer `enabled`.
     */
    disabled?: boolean;
});
type DisableSmsOnNumberError = ({
    error?: string;
} | unknown);
type ReuseSmsRegistrationForNumberData = {
    path: {
        id: string;
    };
};
type ReuseSmsRegistrationForNumberResponse = ({
    registrationId?: string;
    /**
     * requested/changes_requested = pre-submission review states; customers see them as pending / needs changes.
     */
    status?: 'pending' | 'approved' | 'rejected' | 'requested' | 'changes_requested' | 'deactivated';
});
type ReuseSmsRegistrationForNumberError = ({
    error?: string;
} | unknown);
type GetWhatsAppCallingData = {
    path: {
        /**
         * Phone number record ID (from GET /v1/phone-numbers).
         */
        id: string;
    };
};
type GetWhatsAppCallingResponse = ({
    phoneNumber?: string;
    callingEnabled?: boolean;
    /**
     * Public calling deep link (https://wa.me/call/<number>). Null while calling is disabled.
     */
    callDeepLink?: (string) | null;
    /**
     * tel:+E164 / sip:... / wss://... destination
     */
    forwardTo?: (string) | null;
    recordingEnabled?: boolean;
    sipAuthUsername?: (string) | null;
    /**
     * True when a SIP digest password is stored. The plaintext is never returned.
     */
    sipAuthPasswordConfigured?: boolean;
    callIconCountries?: Array<(string)> | null;
    /**
     * True when the number's country blocks business-initiated (outbound) WhatsApp calling; inbound still works.
     */
    outboundDisabled?: boolean;
    /**
     * Caller ID the forward-leg callee sees on tel: forwards. business = this WhatsApp number; platform = a Zernio number (used when the number was brought by the customer and its caller ID is not verified for PSTN origination).
     */
    callerIdMode?: 'business' | 'platform';
    /**
     * True once the number completed caller-ID verification, making tel: forwards display the business number itself.
     */
    callerIdVerified?: boolean;
    /**
     * Hard cap (seconds) on forwarded calls; null = no cap.
     */
    maxCallDurationSeconds?: (number) | null;
    forwardCallerId?: 'business' | 'caller';
});
type GetWhatsAppCallingError = (unknown | {
    error?: string;
});
type EnableWhatsAppCallingData = {
    body: {
        accountId: string;
        /**
         * tel:+E164 / sip:... / wss://... destination
         */
        forwardTo: string;
        sipAuthUsername?: string;
        /**
         * Stored encrypted, never returned by any endpoint.
         */
        sipAuthPassword?: string;
        recordingEnabled?: boolean;
        callIconCountries?: Array<(string)>;
        /**
         * Hard cap (seconds) on a forwarded call; the carrier hangs up both legs when it fires. Safety valve against dead-air billing when a destination hangs up but the signal is lost.
         */
        maxCallDurationSeconds?: number;
        /**
         * Caller ID presented to the forward destination. caller = the WhatsApp user's number (sip: destinations only; ignored on tel: forwards). Fixes AI-agent trunks that reject seeing the business number call itself.
         */
        forwardCallerId?: 'business' | 'caller';
    };
    path: {
        /**
         * Phone number record ID (from GET /v1/phone-numbers).
         */
        id: string;
    };
};
type EnableWhatsAppCallingResponse = ({
    success?: boolean;
    callingEnabled?: boolean;
    sipHostname?: string;
    forwardTo?: string;
    /**
     * Caller ID the forward-leg callee sees on tel: forwards. business = this WhatsApp number; platform = a Zernio number (customer-brought number without verified caller ID).
     */
    callerIdMode?: 'business' | 'platform';
});
type EnableWhatsAppCallingError = (unknown | {
    error?: string;
});
type UpdateWhatsAppCallingData = {
    body: {
        accountId: string;
        forwardTo?: string;
        sipAuthUsername?: (string) | null;
        sipAuthPassword?: (string) | null;
        recordingEnabled?: boolean;
        callIconCountries?: Array<(string)> | null;
        /**
         * Hard cap (seconds) on forwarded calls; null clears the cap.
         */
        maxCallDurationSeconds?: (number) | null;
        /**
         * caller = present the WhatsApp user's number to the forward destination (sip: only).
         */
        forwardCallerId?: 'business' | 'caller';
    };
    path: {
        id: string;
    };
};
type UpdateWhatsAppCallingResponse = (unknown);
type UpdateWhatsAppCallingError = (unknown | {
    error?: string;
});
type DisableWhatsAppCallingData = {
    path: {
        id: string;
    };
    query: {
        accountId: string;
    };
};
type DisableWhatsAppCallingResponse = (unknown);
type DisableWhatsAppCallingError = (unknown | {
    error?: string;
});
type StartWhatsAppCallerIdVerificationData = {
    body?: {
        method?: 'sms' | 'call';
    };
    path: {
        /**
         * Phone number record ID (from GET /v1/phone-numbers).
         */
        id: string;
    };
};
type StartWhatsAppCallerIdVerificationResponse = ({
    verified?: boolean;
    codeSent?: boolean;
    method?: 'sms' | 'call';
});
type StartWhatsAppCallerIdVerificationError = (ErrorResponse | {
    error?: string;
} | unknown);
type VerifyWhatsAppCallerIdData = {
    body: {
        code: string;
    };
    path: {
        /**
         * Phone number record ID (from GET /v1/phone-numbers).
         */
        id: string;
    };
};
type VerifyWhatsAppCallerIdResponse = ({
    verified?: boolean;
});
type VerifyWhatsAppCallerIdError = (unknown | {
    error?: string;
});
type GetWhatsAppPhoneNumberData = {
    path: {
        /**
         * Phone number record ID
         */
        phoneNumberId: string;
    };
};
type GetWhatsAppPhoneNumberResponse = ({
    phoneNumber?: {
        id?: string;
        phoneNumber?: string;
        status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
        country?: string;
        metaPreverifiedId?: string;
        metaVerificationStatus?: string;
        /**
         * For a regulated number with an Onfido ID step — the link to forward to the end user. Appears once the order is placed; null otherwise.
         */
        onfidoVerificationUrl?: (string) | null;
        endUserFirstName?: (string) | null;
        endUserLastName?: (string) | null;
        /**
         * Reviewer rejection reason when status is regulatory_declined.
         */
        regulatoryDeclineReason?: (string) | null;
        provisionedAt?: string;
    };
});
type GetWhatsAppPhoneNumberError = ({
    error?: string;
});
type ReleaseWhatsAppPhoneNumberData = {
    path: {
        /**
         * Phone number record ID
         */
        phoneNumberId: string;
    };
};
type ReleaseWhatsAppPhoneNumberResponse = ({
    message?: string;
    phoneNumber?: {
        id?: string;
        phoneNumber?: string;
        /**
         * "released"
         */
        status?: string;
        releasedAt?: string;
    };
});
type ReleaseWhatsAppPhoneNumberError = (unknown | {
    error?: string;
});
type ListWhatsAppSandboxSessionsResponse = ({
    sessions?: Array<WhatsAppSandboxSession>;
    /**
     * The shared sandbox phone number in E.164 form.
     */
    sandboxNumber?: (string) | null;
});
type ListWhatsAppSandboxSessionsError = ({
    error?: string;
} | unknown);
type CreateWhatsAppSandboxSessionData = {
    body: {
        /**
         * Recipient phone in international format. Digits, spaces, dashes and a leading `+` are all accepted; the server normalizes to E.164 digits-only.
         */
        phone: string;
    };
};
type CreateWhatsAppSandboxSessionResponse = ({
    session?: WhatsAppSandboxSession;
    sandboxNumber?: string;
});
type CreateWhatsAppSandboxSessionError = (unknown | {
    error?: string;
});
type DeleteWhatsAppSandboxSessionData = {
    path: {
        /**
         * The session id returned by POST /v1/whatsapp/sandbox/sessions.
         */
        sessionId: string;
    };
};
type DeleteWhatsAppSandboxSessionResponse = ({
    success?: boolean;
});
type DeleteWhatsAppSandboxSessionError = (unknown | {
    error?: string;
});
type ListWhatsAppGroupChatsData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Pagination cursor
         */
        after?: string;
        /**
         * Max groups to return
         */
        limit?: number;
    };
};
type ListWhatsAppGroupChatsResponse = ({
    groups?: Array<{
        /**
         * Group ID
         */
        id?: string;
        /**
         * Group name
         */
        subject?: string;
        /**
         * Group creation timestamp
         */
        createdAt?: string;
    }>;
    paging?: {
        cursors?: {
            after?: string;
            before?: string;
        };
    };
});
type ListWhatsAppGroupChatsError = (ErrorResponse | {
    error?: string;
});
type CreateWhatsAppGroupChatData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Group name (max 128 characters)
         */
        subject: string;
        /**
         * Group description (max 2048 characters)
         */
        description?: string;
        /**
         * Whether users need approval to join via invite link
         */
        joinApprovalMode?: 'approval_required' | 'auto_approve';
    };
};
type CreateWhatsAppGroupChatResponse = ({
    success?: boolean;
    group?: {
        groupId?: string;
        inviteLink?: string;
    };
});
type CreateWhatsAppGroupChatError = (ErrorResponse | {
    error?: string;
});
type GetWhatsAppGroupChatData = {
    path: {
        /**
         * Group ID
         */
        groupId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type GetWhatsAppGroupChatResponse = ({
    success?: boolean;
    group?: {
        id?: string;
        subject?: string;
        description?: string;
        joinApprovalMode?: string;
        participants?: Array<{
            /**
             * Phone number
             */
            user?: string;
            admin?: string;
        }>;
        participantCount?: number;
        /**
         * UNIX timestamp
         */
        createdAt?: number;
        isSuspended?: boolean;
    };
});
type GetWhatsAppGroupChatError = (ErrorResponse | {
    error?: string;
});
type UpdateWhatsAppGroupChatData = {
    body: {
        subject?: string;
        description?: string;
        joinApprovalMode?: 'approval_required' | 'auto_approve';
    };
    path: {
        /**
         * Group ID
         */
        groupId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type UpdateWhatsAppGroupChatResponse = ({
    success?: boolean;
    message?: string;
});
type UpdateWhatsAppGroupChatError = (ErrorResponse | {
    error?: string;
});
type DeleteWhatsAppGroupChatData = {
    path: {
        /**
         * Group ID
         */
        groupId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type DeleteWhatsAppGroupChatResponse = ({
    success?: boolean;
    message?: string;
});
type DeleteWhatsAppGroupChatError = (ErrorResponse | {
    error?: string;
});
type AddWhatsAppGroupParticipantsData = {
    body: {
        /**
         * Phone numbers in E.164 format (max 8)
         */
        phoneNumbers: Array<(string)>;
    };
    path: {
        /**
         * Group ID
         */
        groupId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type AddWhatsAppGroupParticipantsResponse = ({
    success?: boolean;
    message?: string;
});
type AddWhatsAppGroupParticipantsError = (ErrorResponse | {
    error?: string;
});
type RemoveWhatsAppGroupParticipantsData = {
    body: {
        /**
         * Phone numbers to remove
         */
        phoneNumbers: Array<(string)>;
    };
    path: {
        /**
         * Group ID
         */
        groupId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type RemoveWhatsAppGroupParticipantsResponse = ({
    success?: boolean;
    message?: string;
});
type RemoveWhatsAppGroupParticipantsError = (ErrorResponse | {
    error?: string;
});
type CreateWhatsAppGroupInviteLinkData = {
    path: {
        /**
         * Group ID
         */
        groupId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type CreateWhatsAppGroupInviteLinkResponse = ({
    success?: boolean;
    inviteLink?: string;
});
type CreateWhatsAppGroupInviteLinkError = (ErrorResponse | {
    error?: string;
});
type ListWhatsAppGroupJoinRequestsData = {
    path: {
        /**
         * Group ID
         */
        groupId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type ListWhatsAppGroupJoinRequestsResponse = ({
    success?: boolean;
    joinRequests?: Array<{
        /**
         * Phone number
         */
        user?: string;
        /**
         * UNIX timestamp of request
         */
        timestamp?: number;
    }>;
});
type ListWhatsAppGroupJoinRequestsError = (ErrorResponse | {
    error?: string;
});
type ApproveWhatsAppGroupJoinRequestsData = {
    body: {
        /**
         * Phone numbers to approve
         */
        phoneNumbers: Array<(string)>;
    };
    path: {
        /**
         * Group ID
         */
        groupId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type ApproveWhatsAppGroupJoinRequestsResponse = ({
    success?: boolean;
    message?: string;
});
type ApproveWhatsAppGroupJoinRequestsError = (ErrorResponse | {
    error?: string;
});
type RejectWhatsAppGroupJoinRequestsData = {
    body: {
        /**
         * Phone numbers to reject
         */
        phoneNumbers: Array<(string)>;
    };
    path: {
        /**
         * Group ID
         */
        groupId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type RejectWhatsAppGroupJoinRequestsResponse = ({
    success?: boolean;
    message?: string;
});
type RejectWhatsAppGroupJoinRequestsError = (ErrorResponse | {
    error?: string;
});
type ListWhatsAppFlowsData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type ListWhatsAppFlowsResponse = ({
    success?: boolean;
    flows?: Array<{
        id?: string;
        name?: string;
        status?: 'DRAFT' | 'PUBLISHED' | 'DEPRECATED' | 'BLOCKED' | 'THROTTLED';
        categories?: Array<(string)>;
        validation_errors?: Array<{
            [key: string]: unknown;
        }>;
        /**
         * 1-based version within the flow's clone lineage (Zernio-tracked; Meta has no native versioning). Standalone flows are version 1.
         */
        version?: number;
        /**
         * Stable group key for the flow's version lineage (the root flow's ID).
         */
        lineageId?: string;
    }>;
});
type ListWhatsAppFlowsError = (unknown | {
    error?: string;
});
type CreateWhatsAppFlowData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Flow display name
         */
        name: string;
        /**
         * Flow categories
         */
        categories: Array<('SIGN_UP' | 'SIGN_IN' | 'APPOINTMENT_BOOKING' | 'LEAD_GENERATION' | 'CONTACT_US' | 'CUSTOMER_SUPPORT' | 'SURVEY' | 'OTHER')>;
        /**
         * Optional: ID of an existing flow to clone the Flow JSON from
         */
        cloneFlowId?: string;
        /**
         * When cloning, true keeps the clone in cloneFlowId's version lineage (auto-numbered next version); false/absent creates an independent flow. Ignored without cloneFlowId.
         */
        asVersion?: boolean;
    };
};
type CreateWhatsAppFlowResponse = ({
    success?: boolean;
    flow?: {
        id?: string;
        name?: string;
        status?: string;
        categories?: Array<(string)>;
        /**
         * Version within the clone lineage
         */
        version?: number;
        /**
         * Version-lineage group key
         */
        lineageId?: string;
    };
});
type CreateWhatsAppFlowError = (unknown | {
    error?: string;
});
type GetWhatsAppFlowData = {
    path: {
        /**
         * Flow ID
         */
        flowId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Comma-separated fields to return (default: id,name,status,categories,validation_errors,json_version,preview,data_api_version,endpoint_uri)
         */
        fields?: string;
    };
};
type GetWhatsAppFlowResponse = ({
    success?: boolean;
    flow?: {
        id?: string;
        name?: string;
        status?: string;
        categories?: Array<(string)>;
        validation_errors?: Array<{
            [key: string]: unknown;
        }>;
        json_version?: string;
        preview?: {
            preview_url?: string;
            expires_at?: string;
        };
    };
});
type GetWhatsAppFlowError = ({
    error?: string;
} | unknown);
type UpdateWhatsAppFlowData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * New flow name
         */
        name?: string;
        categories?: Array<('SIGN_UP' | 'SIGN_IN' | 'APPOINTMENT_BOOKING' | 'LEAD_GENERATION' | 'CONTACT_US' | 'CUSTOMER_SUPPORT' | 'SURVEY' | 'OTHER')>;
    };
    path: {
        /**
         * Flow ID
         */
        flowId: string;
    };
};
type UpdateWhatsAppFlowResponse = ({
    success?: boolean;
});
type UpdateWhatsAppFlowError = (unknown | {
    error?: string;
});
type DeleteWhatsAppFlowData = {
    path: {
        /**
         * Flow ID
         */
        flowId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type DeleteWhatsAppFlowResponse = ({
    success?: boolean;
});
type DeleteWhatsAppFlowError = (unknown | {
    error?: string;
});
type GetWhatsAppFlowJsonData = {
    path: {
        /**
         * Flow ID
         */
        flowId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type GetWhatsAppFlowJsonResponse = ({
    success?: boolean;
    assets?: Array<{
        name?: string;
        asset_type?: string;
        /**
         * Temporary URL to download the flow JSON
         */
        download_url?: string;
    }>;
});
type GetWhatsAppFlowJsonError = ({
    error?: string;
} | unknown);
type UploadWhatsAppFlowJsonData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * The Flow JSON content. Pass as a JSON object or a JSON string.
         */
        flow_json: ({
            [key: string]: unknown;
        } | string);
    };
    path: {
        /**
         * Flow ID
         */
        flowId: string;
    };
};
type UploadWhatsAppFlowJsonResponse = ({
    success?: boolean;
    /**
     * Empty array if valid; otherwise, contains validation error details from Meta
     */
    validation_errors?: Array<{
        error?: string;
        error_type?: string;
        message?: string;
        line_start?: number;
        line_end?: number;
        column_start?: number;
        column_end?: number;
    }>;
});
type UploadWhatsAppFlowJsonError = (unknown | {
    error?: string;
});
type GetWhatsAppFlowPreviewData = {
    path: {
        /**
         * Flow ID
         */
        flowId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Mint a fresh preview link (default false)
         */
        invalidate?: boolean;
    };
};
type GetWhatsAppFlowPreviewResponse = ({
    preview_url?: (string) | null;
    expires_at?: (string) | null;
});
type GetWhatsAppFlowPreviewError = ({
    error?: string;
} | unknown);
type ListWhatsAppFlowVersionsData = {
    path: {
        /**
         * Flow ID
         */
        flowId: string;
    };
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
};
type ListWhatsAppFlowVersionsResponse = ({
    versions?: Array<{
        flowId?: string;
        version?: number;
        parentFlowId?: (string) | null;
        name?: (string) | null;
        status?: (string) | null;
        /**
         * True when Meta no longer has this flow
         */
        missing?: boolean;
    }>;
});
type ListWhatsAppFlowVersionsError = ({
    error?: string;
} | unknown);
type PublishWhatsAppFlowData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
    path: {
        /**
         * Flow ID
         */
        flowId: string;
    };
};
type PublishWhatsAppFlowResponse = ({
    success?: boolean;
});
type PublishWhatsAppFlowError = (unknown | {
    error?: string;
});
type DeprecateWhatsAppFlowData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
    };
    path: {
        /**
         * Flow ID
         */
        flowId: string;
    };
};
type DeprecateWhatsAppFlowResponse = ({
    success?: boolean;
});
type DeprecateWhatsAppFlowError = (unknown | {
    error?: string;
});
type SendWhatsAppFlowMessageData = {
    body: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Recipient phone number (E.164 format, e.g. +1234567890)
         */
        to: string;
        /**
         * Published flow ID
         */
        flow_id: string;
        /**
         * CTA button text (e.g. 'Book Now', 'Sign Up')
         */
        flow_cta: string;
        /**
         * Action type: navigate opens a screen directly, data_exchange hits your endpoint first
         */
        flow_action?: 'navigate' | 'data_exchange';
        /**
         * Unique token to correlate responses. If omitted, auto-generated as '<flowId>:<uuid>' so the response can be attributed to this flow in the Flow Responses view.
         */
        flow_token?: string;
        flow_action_payload?: {
            /**
             * First screen ID to navigate to
             */
            screen?: string;
            /**
             * Optional data to pass to the screen
             */
            data?: {
                [key: string]: unknown;
            };
        };
        /**
         * Message body text
         */
        body: string;
        header?: {
            type?: 'text';
            text?: string;
        };
        /**
         * Optional footer text
         */
        footer?: string;
        /**
         * Set true to test an unpublished (DRAFT) flow
         */
        draft?: boolean;
    };
};
type SendWhatsAppFlowMessageResponse = ({
    success?: boolean;
    /**
     * WhatsApp message ID (WAMID)
     */
    messageId?: string;
});
type SendWhatsAppFlowMessageError = (unknown | {
    error?: string;
});
type ListWhatsAppFlowResponsesData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Scope to responses for this flow
         */
        flowId?: string;
        /**
         * Max responses to return
         */
        limit?: number;
    };
};
type ListWhatsAppFlowResponsesResponse = ({
    responses?: Array<{
        /**
         * Message ID
         */
        id?: string;
        receivedAt?: string;
        /**
         * Sender wa_id / phone
         */
        from?: (string) | null;
        senderName?: (string) | null;
        conversationId?: (string) | null;
        flowToken?: (string) | null;
        /**
         * Submitted field values (flow_token removed)
         */
        data?: {
            [key: string]: unknown;
        };
        /**
         * Raw response_json string
         */
        raw?: (string) | null;
    }>;
});
type ListWhatsAppFlowResponsesError = ({
    error?: string;
} | unknown);
type ListContactsData = {
    query?: {
        /**
         * Filter by the SocialAccount that owns the contact channel. Contacts are resolved through their channels, so the profileId contact filter is not applied while accountId is set. A profileId sent alongside is still access-checked and still scopes the returned filters.tags list.
         */
        accountId?: string;
        isSubscribed?: 'true' | 'false';
        limit?: number;
        platform?: 'instagram' | 'facebook' | 'telegram' | 'twitter' | 'bluesky' | 'reddit' | 'whatsapp';
        /**
         * Filter by profile. Omit to list across all profiles. Matches the profile recorded on the contact itself, which is set when the contact is created and is independent of the profile its account currently belongs to. Filter by accountId to list a contact through its channel instead.
         */
        profileId?: string;
        /**
         * Case-insensitive substring match on the contact name, email and company. Phone numbers and other platform identifiers are not matched: they live on the contact channel, not on the contact. To reach a contact from an inbox webhook, use the conversation.contactId it already carries.
         */
        search?: string;
        skip?: number;
        tag?: string;
        /**
         * Comma-separated tags, matches contacts carrying any of them
         */
        tags?: string;
    };
};
type ListContactsResponse = ({
    success?: boolean;
    contacts?: Array<{
        id?: string;
        name?: string;
        email?: string;
        company?: string;
        avatarUrl?: string;
        tags?: Array<(string)>;
        isSubscribed?: boolean;
        isBlocked?: boolean;
        lastMessageSentAt?: string;
        lastMessageReceivedAt?: string;
        messagesSentCount?: number;
        messagesReceivedCount?: number;
        customFields?: {
            [key: string]: unknown;
        };
        notes?: string;
        createdAt?: string;
        platform?: string;
        platformIdentifier?: string;
        displayIdentifier?: string;
    }>;
    filters?: {
        tags?: Array<(string)>;
    };
    pagination?: {
        total?: number;
        limit?: number;
        skip?: number;
        hasMore?: boolean;
    };
});
type ListContactsError = (unknown | {
    error?: string;
});
type CreateContactData = {
    body: {
        profileId: string;
        name: string;
        email?: string;
        company?: string;
        tags?: Array<(string)>;
        isSubscribed?: boolean;
        notes?: string;
        /**
         * Optional. Creates a channel if provided with platform + platformIdentifier
         */
        accountId?: string;
        platform?: string;
        platformIdentifier?: string;
        displayIdentifier?: string;
    };
};
type CreateContactResponse = ({
    success?: boolean;
    contact?: {
        id?: string;
        name?: string;
        email?: string;
        company?: string;
        tags?: Array<(string)>;
        isSubscribed?: boolean;
        isBlocked?: boolean;
        customFields?: {
            [key: string]: unknown;
        };
        notes?: string;
        createdAt?: string;
    };
    /**
     * Created when accountId, platform, and platformIdentifier are provided
     */
    channel?: {
        id?: string;
        platform?: string;
        platformIdentifier?: string;
        displayIdentifier?: string;
    };
    warning?: string;
});
type CreateContactError = (unknown | {
    error?: string;
});
type GetContactData = {
    path: {
        contactId: string;
    };
};
type GetContactResponse = ({
    success?: boolean;
    contact?: {
        id?: string;
        name?: string;
        email?: string;
        company?: string;
        avatarUrl?: string;
        tags?: Array<(string)>;
        isSubscribed?: boolean;
        isBlocked?: boolean;
        /**
         * Messages sent to the contact, derived live from message history across all linked conversations.
         */
        messagesSentCount?: number;
        /**
         * Messages received from the contact, derived live from message history across all linked conversations.
         */
        messagesReceivedCount?: number;
        /**
         * Timestamp of the most recent outgoing message, or null if none.
         */
        lastMessageSentAt?: (string) | null;
        /**
         * Timestamp of the most recent incoming message, or null if none.
         */
        lastMessageReceivedAt?: (string) | null;
        customFields?: {
            [key: string]: unknown;
        };
        notes?: string;
        conversationIds?: Array<(string)>;
        createdAt?: string;
        updatedAt?: string;
    };
    channels?: Array<{
        id?: string;
        accountId?: string;
        platform?: string;
        platformIdentifier?: string;
        displayIdentifier?: string;
        isSubscribed?: boolean;
        conversationId?: string;
        /**
         * Most recent message (either direction) in this channel's conversation, or null if none.
         */
        lastActiveAt?: (string) | null;
        createdAt?: string;
    }>;
});
type GetContactError = (unknown | {
    error?: string;
});
type UpdateContactData = {
    body?: {
        name?: string;
        email?: string;
        company?: string;
        avatarUrl?: string;
        tags?: Array<(string)>;
        isSubscribed?: boolean;
        isBlocked?: boolean;
        notes?: string;
    };
    path: {
        contactId: string;
    };
};
type UpdateContactResponse = ({
    success?: boolean;
    contact?: {
        id?: string;
        name?: string;
        email?: string;
        company?: string;
        avatarUrl?: string;
        tags?: Array<(string)>;
        isSubscribed?: boolean;
        isBlocked?: boolean;
        notes?: string;
        updatedAt?: string;
    };
});
type UpdateContactError = (unknown | {
    error?: string;
});
type DeleteContactData = {
    path: {
        contactId: string;
    };
};
type DeleteContactResponse = (unknown);
type DeleteContactError = (unknown | {
    error?: string;
});
type GetContactChannelsData = {
    path: {
        contactId: string;
    };
};
type GetContactChannelsResponse = ({
    success?: boolean;
    channels?: Array<{
        id?: string;
        accountId?: string;
        platform?: string;
        platformIdentifier?: string;
        displayIdentifier?: string;
        isSubscribed?: boolean;
        conversationId?: string;
        metadata?: {
            [key: string]: unknown;
        };
        createdAt?: string;
    }>;
});
type GetContactChannelsError = (unknown | {
    error?: string;
});
type BulkCreateContactsData = {
    body: {
        profileId: string;
        /**
         * Required when contacts carry channel data (platformIdentifier or a row-level accountId). Omit for a plain CRM import with no channels.
         */
        accountId?: string;
        /**
         * Ignored when accountId is set: the platform is derived from the resolved account. Only relevant to disambiguate accountId lookup; a mismatch 404s.
         */
        platform?: string;
        contacts: Array<{
            name: string;
            /**
             * Required when the top-level accountId is set (channel mode). A row missing it in that mode is rejected individually and reported in errors[], not a 400 for the whole import.
             */
            platformIdentifier?: string;
            displayIdentifier?: string;
            email?: string;
            company?: string;
            tags?: Array<(string)>;
        }>;
    };
};
type BulkCreateContactsResponse = ({
    success?: boolean;
    created?: number;
    skipped?: number;
    /**
     * Per-contact failures, e.g. an identifier that is not a valid phone number
     */
    errors?: Array<(string)>;
    total?: number;
});
type BulkCreateContactsError = (unknown | {
    error?: string;
});
type SetContactFieldValueData = {
    body: {
        /**
         * Field value (type depends on field definition)
         */
        value: unknown;
    };
    path: {
        contactId: string;
        slug: string;
    };
};
type SetContactFieldValueResponse = (unknown);
type SetContactFieldValueError = ({
    error?: string;
});
type ClearContactFieldValueData = {
    path: {
        contactId: string;
        slug: string;
    };
};
type ClearContactFieldValueResponse = (unknown);
type ClearContactFieldValueError = ({
    error?: string;
});
type ListCustomFieldsData = {
    query?: {
        /**
         * Filter by profile. Omit to list across all profiles
         */
        profileId?: string;
    };
};
type ListCustomFieldsResponse = ({
    success?: boolean;
    fields?: Array<{
        id?: string;
        name?: string;
        slug?: string;
        type?: 'text' | 'number' | 'date' | 'boolean' | 'select';
        options?: Array<(string)>;
        createdAt?: string;
    }>;
});
type ListCustomFieldsError = (unknown | {
    error?: string;
});
type CreateCustomFieldData = {
    body: {
        profileId: string;
        name: string;
        /**
         * Auto-generated from name if not provided
         */
        slug?: string;
        type: 'text' | 'number' | 'date' | 'boolean' | 'select';
        /**
         * Required for select type
         */
        options?: Array<(string)>;
    };
};
type CreateCustomFieldResponse = ({
    success?: boolean;
    field?: {
        id?: string;
        name?: string;
        slug?: string;
        type?: 'text' | 'number' | 'date' | 'boolean' | 'select';
        options?: Array<(string)>;
        createdAt?: string;
    };
});
type CreateCustomFieldError = (unknown | {
    error?: string;
});
type UpdateCustomFieldData = {
    body: {
        name?: string;
        options?: Array<(string)>;
    };
    path: {
        fieldId: string;
    };
};
type UpdateCustomFieldResponse = ({
    success?: boolean;
    field?: {
        id?: string;
        name?: string;
        slug?: string;
        type?: string;
        options?: Array<(string)>;
    };
});
type UpdateCustomFieldError = (unknown | {
    error?: string;
});
type DeleteCustomFieldData = {
    path: {
        fieldId: string;
    };
};
type DeleteCustomFieldResponse = (unknown);
type DeleteCustomFieldError = (unknown | {
    error?: string;
});
type ListBroadcastsData = {
    query?: {
        limit?: number;
        platform?: string;
        /**
         * Filter by profile. Omit to list across all profiles
         */
        profileId?: string;
        skip?: number;
        status?: 'draft' | 'scheduled' | 'sending' | 'completed' | 'failed' | 'cancelled';
    };
};
type ListBroadcastsResponse = ({
    success?: boolean;
    broadcasts?: Array<{
        id?: string;
        name?: string;
        description?: string;
        platform?: string;
        accountId?: string;
        /**
         * Display name of the sending account
         */
        accountName?: string;
        status?: 'draft' | 'scheduled' | 'sending' | 'completed' | 'failed' | 'cancelled';
        /**
         * Template name or message text snippet
         */
        messagePreview?: string;
        scheduledAt?: string;
        startedAt?: string;
        completedAt?: string;
        recipientCount?: number;
        sentCount?: number;
        deliveredCount?: number;
        readCount?: number;
        failedCount?: number;
        createdAt?: string;
    }>;
    pagination?: {
        total?: number;
        limit?: number;
        skip?: number;
        hasMore?: boolean;
    };
});
type ListBroadcastsError = (unknown | {
    error?: string;
});
type CreateBroadcastData = {
    body: {
        profileId: string;
        accountId: string;
        platform: 'instagram' | 'facebook' | 'telegram' | 'twitter' | 'bluesky' | 'reddit' | 'whatsapp';
        name: string;
        description?: string;
        message?: {
            text?: string;
            attachments?: Array<{
                type?: string;
                url?: string;
                filename?: string;
            }>;
        };
        /**
         * WhatsApp template (required when platform is whatsapp)
         */
        template?: {
            name?: string;
            language?: string;
            components?: Array<{
                [key: string]: unknown;
            }>;
            /**
             * Maps template variable positions ("1", "2") to contact fields or static values. Resolved per recipient at send time.
             */
            variableMapping?: {
                [key: string]: {
                    field?: 'name' | 'phone' | 'email' | 'company' | 'custom';
                    /**
                     * Static value used when field is "custom"
                     */
                    customValue?: string;
                };
            };
        };
        segmentFilters?: {
            tags?: Array<(string)>;
            isSubscribed?: boolean;
        };
    };
};
type CreateBroadcastResponse = ({
    success?: boolean;
    broadcast?: {
        id?: string;
        name?: string;
        description?: string;
        platform?: string;
        accountId?: string;
        status?: string;
        createdAt?: string;
    };
});
type CreateBroadcastError = (unknown | {
    error?: string;
});
type GetBroadcastData = {
    path: {
        broadcastId: string;
    };
};
type GetBroadcastResponse = ({
    success?: boolean;
    broadcast?: {
        id?: string;
        name?: string;
        description?: string;
        platform?: string;
        accountId?: string;
        message?: {
            text?: string;
        };
        template?: {
            name?: string;
            language?: string;
        };
        segmentFilters?: {
            tags?: Array<(string)>;
        };
        status?: 'draft' | 'scheduled' | 'sending' | 'completed' | 'failed' | 'cancelled';
        scheduledAt?: string;
        startedAt?: string;
        completedAt?: string;
        recipientCount?: number;
        sentCount?: number;
        deliveredCount?: number;
        readCount?: number;
        failedCount?: number;
        createdAt?: string;
        updatedAt?: string;
    };
});
type GetBroadcastError = ({
    error?: string;
});
type UpdateBroadcastData = {
    body?: {
        name?: string;
        description?: string;
        /**
         * Generic message payload (used for non-WhatsApp platforms).
         */
        message?: {
            text?: string;
        };
        /**
         * WhatsApp template payload (used when platform is `whatsapp`).
         */
        template?: {
            name?: string;
            language?: string;
            /**
             * Maps template variable positions to contact fields. Keys are position strings ("1", "2"); values are { field, customValue }.
             */
            variableMapping?: {
                [key: string]: {
                    field?: 'name' | 'phone' | 'email' | 'company' | 'custom';
                    customValue?: string;
                };
            };
        };
        /**
         * Recipient segment filters (tags, channels, subscription state).
         */
        segmentFilters?: {
            [key: string]: unknown;
        };
    };
    path: {
        broadcastId: string;
    };
};
type UpdateBroadcastResponse = ({
    success?: boolean;
    broadcast?: {
        id?: string;
        name?: string;
        description?: string;
        status?: string;
        updatedAt?: string;
    };
});
type UpdateBroadcastError = ({
    error?: string;
});
type DeleteBroadcastData = {
    path: {
        broadcastId: string;
    };
};
type DeleteBroadcastResponse = (unknown);
type DeleteBroadcastError = ({
    error?: string;
});
type SendBroadcastData = {
    path: {
        broadcastId: string;
    };
};
type SendBroadcastResponse = ({
    success?: boolean;
    /**
     * Current broadcast status after processing first batch
     */
    status?: 'sending' | 'completed' | 'failed';
    /**
     * Recipients sent in this batch
     */
    sent?: number;
    /**
     * Recipients failed in this batch
     */
    failed?: number;
    /**
     * Total recipient count
     */
    recipientCount?: number;
});
type SendBroadcastError = (unknown | {
    error?: string;
});
type ScheduleBroadcastData = {
    body: {
        scheduledAt: string;
    };
    path: {
        broadcastId: string;
    };
};
type ScheduleBroadcastResponse = ({
    success?: boolean;
    broadcast?: {
        id?: string;
        status?: string;
        scheduledAt?: string;
    };
});
type ScheduleBroadcastError = (unknown | {
    error?: string;
});
type CancelBroadcastData = {
    path: {
        broadcastId: string;
    };
};
type CancelBroadcastResponse = ({
    success?: boolean;
    broadcast?: {
        id?: string;
        status?: string;
    };
});
type CancelBroadcastError = (unknown | {
    error?: string;
});
type ListBroadcastRecipientsData = {
    path: {
        broadcastId: string;
    };
    query?: {
        limit?: number;
        skip?: number;
        status?: 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
    };
};
type ListBroadcastRecipientsResponse = ({
    success?: boolean;
    recipients?: Array<{
        id?: string;
        contactId?: string;
        channelId?: string;
        platformIdentifier?: string;
        contactName?: (string) | null;
        status?: 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
        messageId?: string;
        error?: string;
        /**
         * Meta WhatsApp error code (e.g. 131049 for antispam, 131021 for invalid phone, 131026 for re-engagement required). Only populated for status=failed.
         */
        errorCode?: (number) | null;
        /**
         * Plain-language translation of errorCode (e.g. for 131026, that the recipient has likely opted out of marketing messages). Null for unmapped codes; fall back to error.
         */
        errorExplanation?: (string) | null;
        /**
         * Meta trace id (fbtrace_id) for the failed send. Quote this when escalating to Meta Direct Support. Only populated for status=failed on Meta platforms.
         */
        errorTraceId?: (string) | null;
        sentAt?: string;
        deliveredAt?: string;
        readAt?: string;
    }>;
    pagination?: {
        total?: number;
        limit?: number;
        skip?: number;
        hasMore?: boolean;
    };
});
type ListBroadcastRecipientsError = (unknown | {
    error?: string;
});
type AddBroadcastRecipientsData = {
    body: {
        /**
         * Specific contact IDs to add. Zernio contact ids (24-character hex), as returned by the list-contacts endpoint. A platform identifier such as a WhatsApp wa_id is rejected with 400; use phones for raw numbers.
         */
        contactIds?: Array<(string)>;
        /**
         * Raw phone numbers (auto-creates contacts). Useful for WhatsApp/Telegram manual entry
         */
        phones?: Array<(string)>;
        /**
         * Auto-populate from broadcast segment filters
         */
        useSegment?: boolean;
    };
    path: {
        broadcastId: string;
    };
};
type AddBroadcastRecipientsResponse = ({
    success?: boolean;
    /**
     * Number of recipients successfully added
     */
    added?: number;
    /**
     * Number skipped (duplicates or missing channels)
     */
    skipped?: number;
});
type AddBroadcastRecipientsError = (unknown | {
    error?: string;
});
type ListWorkflowsData = {
    query?: {
        limit?: number;
        /**
         * Filter by profile. Omit to list across all profiles
         */
        profileId?: string;
        skip?: number;
        status?: 'draft' | 'active' | 'paused';
    };
};
type ListWorkflowsResponse = ({
    success?: boolean;
    workflows?: Array<{
        id?: string;
        name?: string;
        description?: string;
        platform?: string;
        accountId?: string;
        accountName?: string;
        status?: 'draft' | 'active' | 'paused';
        nodeCount?: number;
        totalStarted?: number;
        totalCompleted?: number;
        totalExited?: number;
        createdAt?: string;
    }>;
    pagination?: {
        total?: number;
        limit?: number;
        skip?: number;
        hasMore?: boolean;
    };
});
type ListWorkflowsError = ({
    error?: string;
});
type CreateWorkflowData = {
    body: {
        profileId: string;
        accountId: string;
        platform?: 'whatsapp' | 'instagram' | 'facebook' | 'telegram' | 'twitter' | 'bluesky' | 'reddit';
        name: string;
        description?: string;
        nodes?: Array<WorkflowNode>;
        edges?: Array<WorkflowEdge>;
        /**
         * The trigger node id; derived from the single trigger node if omitted
         */
        entryNodeId?: string;
    };
};
type CreateWorkflowResponse = ({
    success?: boolean;
    workflow?: {
        id?: string;
        name?: string;
        description?: string;
        platform?: string;
        status?: string;
        nodeCount?: number;
        entryNodeId?: string;
        createdAt?: string;
    };
});
type CreateWorkflowError = (unknown | {
    error?: string;
});
type GetWorkflowData = {
    path: {
        workflowId: string;
    };
};
type GetWorkflowResponse = ({
    success?: boolean;
    workflow?: {
        id?: string;
        name?: string;
        description?: string;
        platform?: string;
        accountId?: string;
        profileId?: string;
        status?: 'draft' | 'active' | 'paused';
        entryNodeId?: string;
        nodes?: Array<WorkflowNode>;
        edges?: Array<WorkflowEdge>;
        totalStarted?: number;
        totalCompleted?: number;
        totalExited?: number;
        createdAt?: string;
        updatedAt?: string;
    };
});
type GetWorkflowError = ({
    error?: string;
});
type UpdateWorkflowData = {
    body?: {
        name?: string;
        description?: string;
        nodes?: Array<WorkflowNode>;
        edges?: Array<WorkflowEdge>;
        entryNodeId?: (string) | null;
        /**
         * Reassign the workflow to a different `SocialAccount`. `platform` and `profileId` are derived server-side from the new account (the client never sends them directly). The account must belong to the caller's workspace and be on a workflow-supported platform (whatsapp, instagram, facebook, telegram, twitter, bluesky, reddit). Changing this triggers a graph revalidation against the new platform.
         *
         */
        accountId?: string;
    };
    path: {
        workflowId: string;
    };
};
type UpdateWorkflowResponse = ({
    success?: boolean;
    workflow?: {
        id?: string;
        name?: string;
        description?: string;
        status?: string;
        entryNodeId?: string;
        nodeCount?: number;
        updatedAt?: string;
    };
});
type UpdateWorkflowError = (unknown | {
    error?: string;
});
type DeleteWorkflowData = {
    path: {
        workflowId: string;
    };
};
type DeleteWorkflowResponse = (unknown);
type DeleteWorkflowError = ({
    error?: string;
});
type ActivateWorkflowData = {
    path: {
        workflowId: string;
    };
};
type ActivateWorkflowResponse = ({
    success?: boolean;
    workflow?: {
        id?: string;
        status?: string;
        entryNodeId?: string;
    };
});
type ActivateWorkflowError = (unknown | {
    error?: string;
});
type PauseWorkflowData = {
    path: {
        workflowId: string;
    };
};
type PauseWorkflowResponse = ({
    success?: boolean;
    workflow?: {
        id?: string;
        status?: string;
    };
});
type PauseWorkflowError = (ErrorResponse | {
    error?: string;
});
type ListWorkflowExecutionsData = {
    path: {
        workflowId: string;
    };
    query?: {
        limit?: number;
        skip?: number;
        status?: 'running' | 'waiting' | 'completed' | 'exited' | 'failed';
    };
};
type ListWorkflowExecutionsResponse = ({
    success?: boolean;
    executions?: Array<{
        id?: string;
        status?: 'running' | 'waiting' | 'completed' | 'exited' | 'failed';
        currentNodeId?: string;
        waitingFor?: {
            kind?: 'timer' | 'reply';
            nodeId?: string;
        } | null;
        variables?: {
            [key: string]: unknown;
        };
        platformIdentifier?: string;
        conversationId?: string;
        stepCount?: number;
        lastError?: (string) | null;
        resumeAt?: (string) | null;
        createdAt?: string;
        updatedAt?: string;
        completedAt?: (string) | null;
    }>;
    pagination?: {
        total?: number;
        limit?: number;
        skip?: number;
        hasMore?: boolean;
    };
});
type ListWorkflowExecutionsError = (unknown | {
    error?: string;
});
type TriggerWorkflowData = {
    body: {
        /**
         * Recipient phone (WhatsApp only)
         */
        to?: string;
        /**
         * An existing conversation to run in (required for non-WhatsApp workflows)
         */
        conversationId?: string;
        /**
         * Simulated inbound text, seeded as the run's lastMessage variable
         */
        text?: string;
    };
    path: {
        workflowId: string;
    };
};
type TriggerWorkflowResponse = ({
    success?: boolean;
    execution?: {
        id?: string;
        status?: string;
        currentNodeId?: string;
        waitingFor?: {
            [key: string]: unknown;
        } | null;
        variables?: {
            [key: string]: unknown;
        };
        conversationId?: string;
    } | null;
});
type TriggerWorkflowError = (unknown | {
    error?: string;
});
type ListWorkflowExecutionEventsData = {
    path: {
        executionId: string;
        workflowId: string;
    };
};
type ListWorkflowExecutionEventsResponse = ({
    success?: boolean;
    execution?: {
        id?: string;
        status?: 'running' | 'waiting' | 'completed' | 'exited' | 'failed';
        startedAt?: (string) | null;
        completedAt?: (string) | null;
    };
    /**
     * Events in chronological order (oldest first).
     */
    events?: Array<WorkflowExecutionEvent>;
});
type ListWorkflowExecutionEventsError = (ErrorResponse | {
    error?: string;
});
type DuplicateWorkflowData = {
    path: {
        workflowId: string;
    };
};
type DuplicateWorkflowResponse = ({
    success?: boolean;
    workflow?: {
        id?: string;
        name?: string;
        description?: string;
        status?: 'draft';
        platform?: string;
        accountId?: string;
        profileId?: string;
        entryNodeId?: (string) | null;
        nodeCount?: number;
        createdAt?: string;
    };
});
type DuplicateWorkflowError = (ErrorResponse | {
    error?: string;
});
type ListWorkflowVersionsData = {
    path: {
        workflowId: string;
    };
};
type ListWorkflowVersionsResponse = ({
    success?: boolean;
    /**
     * Versions in reverse chronological order (newest first).
     */
    versions?: Array<{
        /**
         * Monotonically increasing version number
         */
        version?: number;
        name?: string;
        description?: (string) | null;
        /**
         * User id that authored this version
         */
        createdBy?: (string) | null;
        /**
         * Denormalized email so the history UI can render without a join
         */
        createdByEmail?: (string) | null;
        /**
         * When non-null, this snapshot was created by restoring that version
         */
        restoredFromVersion?: (number) | null;
        createdAt?: string;
    }>;
});
type ListWorkflowVersionsError = (ErrorResponse | {
    error?: string;
});
type GetWorkflowVersionData = {
    path: {
        version: number;
        workflowId: string;
    };
};
type GetWorkflowVersionResponse = ({
    success?: boolean;
    version?: {
        version?: number;
        name?: string;
        description?: (string) | null;
        entryNodeId?: (string) | null;
        nodes?: Array<WorkflowNode>;
        edges?: Array<WorkflowEdge>;
        platform?: string;
        accountId?: string;
        profileId?: string;
        createdBy?: (string) | null;
        createdByEmail?: (string) | null;
        restoredFromVersion?: (number) | null;
        createdAt?: string;
    };
});
type GetWorkflowVersionError = (ErrorResponse | {
    error?: string;
});
type RestoreWorkflowVersionData = {
    path: {
        version: number;
        workflowId: string;
    };
};
type RestoreWorkflowVersionResponse = ({
    success?: boolean;
    workflow?: {
        id?: string;
        name?: string;
        description?: string;
        status?: string;
        entryNodeId?: (string) | null;
        nodeCount?: number;
        updatedAt?: string;
    };
    restoredFromVersion?: number;
});
type RestoreWorkflowVersionError = (unknown | {
    error?: string;
});
type ListSequencesData = {
    query?: {
        limit?: number;
        /**
         * Filter by profile. Omit to list across all profiles
         */
        profileId?: string;
        skip?: number;
        status?: 'draft' | 'active' | 'paused';
    };
};
type ListSequencesResponse = ({
    success?: boolean;
    sequences?: Array<{
        id?: string;
        name?: string;
        description?: string;
        platform?: string;
        accountId?: string;
        /**
         * Display name of the sending account
         */
        accountName?: string;
        /**
         * First step template name or message text snippet
         */
        messagePreview?: string;
        status?: 'draft' | 'active' | 'paused';
        stepsCount?: number;
        exitOnReply?: boolean;
        exitOnUnsubscribe?: boolean;
        totalEnrolled?: number;
        totalCompleted?: number;
        totalExited?: number;
        createdAt?: string;
    }>;
    pagination?: {
        total?: number;
        limit?: number;
        skip?: number;
        hasMore?: boolean;
    };
});
type ListSequencesError = (unknown | {
    error?: string;
});
type CreateSequenceData = {
    body: {
        profileId: string;
        accountId: string;
        platform: 'instagram' | 'facebook' | 'telegram' | 'twitter' | 'bluesky' | 'reddit' | 'whatsapp';
        name: string;
        description?: string;
        steps?: Array<{
            order: number;
            delayMinutes: number;
            message?: {
                text?: string;
            };
            template?: {
                name?: string;
                language?: string;
                /**
                 * Maps template variable positions to contact fields. Keys are position strings ("1", "2"), values are objects with field and optional customValue
                 */
                variableMapping?: {
                    [key: string]: {
                        field?: 'name' | 'phone' | 'email' | 'company' | 'custom';
                        /**
                         * Static value when field is "custom"
                         */
                        customValue?: string;
                    };
                };
            };
        }>;
        exitOnReply?: boolean;
        exitOnUnsubscribe?: boolean;
    };
};
type CreateSequenceResponse = ({
    success?: boolean;
    sequence?: {
        id?: string;
        name?: string;
        description?: string;
        platform?: string;
        status?: string;
        stepsCount?: number;
        createdAt?: string;
    };
});
type CreateSequenceError = (unknown | {
    error?: string;
});
type GetSequenceData = {
    path: {
        sequenceId: string;
    };
};
type GetSequenceResponse = ({
    success?: boolean;
    sequence?: {
        id?: string;
        name?: string;
        description?: string;
        platform?: string;
        accountId?: string;
        status?: 'draft' | 'active' | 'paused';
        steps?: Array<{
            order?: number;
            delayMinutes?: number;
            message?: {
                text?: string;
            };
            template?: {
                name?: string;
                language?: string;
                variableMapping?: {
                    [key: string]: unknown;
                };
            };
        }>;
        exitOnReply?: boolean;
        exitOnUnsubscribe?: boolean;
        totalEnrolled?: number;
        totalCompleted?: number;
        totalExited?: number;
        createdAt?: string;
        updatedAt?: string;
    };
});
type GetSequenceError = (unknown | {
    error?: string;
});
type UpdateSequenceData = {
    body?: {
        name?: string;
        description?: string;
        /**
         * Replace the full step list. Only allowed while the sequence is draft or paused.
         */
        steps?: Array<{
            order: number;
            delayMinutes: number;
            message?: {
                text?: string;
            };
            template?: {
                name?: string;
                language?: string;
                variableMapping?: {
                    [key: string]: {
                        field?: 'name' | 'phone' | 'email' | 'company' | 'custom';
                        customValue?: string;
                    };
                };
            };
        }>;
        exitOnReply?: boolean;
        exitOnUnsubscribe?: boolean;
    };
    path: {
        sequenceId: string;
    };
};
type UpdateSequenceResponse = ({
    success?: boolean;
    sequence?: {
        id?: string;
        name?: string;
        description?: string;
        status?: string;
        steps?: Array<{
            [key: string]: unknown;
        }>;
        exitOnReply?: boolean;
        exitOnUnsubscribe?: boolean;
        updatedAt?: string;
    };
});
type UpdateSequenceError = (unknown | {
    error?: string;
});
type DeleteSequenceData = {
    path: {
        sequenceId: string;
    };
};
type DeleteSequenceResponse = (unknown);
type DeleteSequenceError = (unknown | {
    error?: string;
});
type ActivateSequenceData = {
    path: {
        sequenceId: string;
    };
};
type ActivateSequenceResponse = ({
    success?: boolean;
    sequence?: {
        id?: string;
        status?: string;
    };
});
type ActivateSequenceError = (unknown | {
    error?: string;
});
type PauseSequenceData = {
    path: {
        sequenceId: string;
    };
};
type PauseSequenceResponse = ({
    success?: boolean;
    sequence?: {
        id?: string;
        status?: string;
    };
});
type PauseSequenceError = (unknown | {
    error?: string;
});
type EnrollContactsData = {
    body: {
        contactIds: Array<(string)>;
        /**
         * Optional. Auto-detected if not provided.
         */
        channelIds?: Array<(string)>;
    };
    path: {
        sequenceId: string;
    };
};
type EnrollContactsResponse = ({
    success?: boolean;
    /**
     * Number of contacts successfully enrolled
     */
    enrolled?: number;
    /**
     * Number that failed (already enrolled, or no subscribed channel on the sequence platform)
     */
    failed?: number;
    /**
     * Per-contact outcome
     */
    results?: Array<{
        contactId?: string;
        success?: boolean;
        /**
         * Present when success is false
         */
        error?: string;
    }>;
});
type EnrollContactsError = (unknown | {
    error?: string;
});
type UnenrollContactData = {
    path: {
        contactId: string;
        sequenceId: string;
    };
};
type UnenrollContactResponse = (unknown);
type UnenrollContactError = (unknown | {
    error?: string;
});
type ListSequenceEnrollmentsData = {
    path: {
        sequenceId: string;
    };
    query?: {
        limit?: number;
        skip?: number;
        status?: 'active' | 'completed' | 'exited' | 'paused';
    };
};
type ListSequenceEnrollmentsResponse = ({
    success?: boolean;
    enrollments?: Array<{
        id?: string;
        contactId?: string;
        channelId?: string;
        platformIdentifier?: string;
        contactName?: string;
        currentStepIndex?: number;
        status?: 'active' | 'completed' | 'exited' | 'paused';
        exitReason?: (string) | null;
        nextStepAt?: (string) | null;
        stepsSent?: number;
        lastStepSentAt?: (string) | null;
        createdAt?: string;
    }>;
    pagination?: {
        total?: number;
        limit?: number;
        skip?: number;
        hasMore?: boolean;
    };
});
type ListSequenceEnrollmentsError = (unknown | {
    error?: string;
});
type ListCommentAutomationsData = {
    query?: {
        /**
         * Filter by profile. Omit to list across all profiles
         */
        profileId?: string;
    };
};
type ListCommentAutomationsResponse = ({
    success?: boolean;
    automations?: Array<{
        id?: string;
        name?: string;
        platform?: 'instagram' | 'facebook';
        trigger?: 'comment' | 'story_reply';
        accountId?: string;
        platformPostId?: string;
        postTitle?: string;
        keywords?: Array<(string)>;
        /**
         * How a keyword is compared with the comment. 'contains' (default) matches anywhere, even inside another word (keyword 'app' fires on 'happy'). 'word' matches the keyword only as a standalone word. 'exact' requires the whole comment to be exactly the keyword.
         */
        matchMode?: 'exact' | 'contains' | 'word';
        /**
         * Comments containing one of these never trigger the automation, even when a trigger keyword also matches. Compared using the same matchMode.
         */
        excludeKeywords?: Array<(string)>;
        /**
         * Only with matchMode=word: also fire on close misspellings of a keyword (one edit for 4-7 character keywords, two from 8 up). Keywords shorter than 4 characters are never fuzzy-matched.
         */
        typoTolerance?: boolean;
        dmMessage?: string;
        /**
         * Inline DM buttons (up to 3). Omitted when none are set.
         */
        buttons?: Array<DmButton>;
        template?: CommentAutomationTemplate;
        commentReply?: string;
        /**
         * Alternate DM texts rotated at random with dmMessage. Omitted when none.
         */
        dmMessageVariations?: Array<(string)>;
        /**
         * Alternate public replies rotated at random with commentReply. Omitted when none.
         */
        commentReplyVariations?: Array<(string)>;
        /**
         * Whether link buttons in the DM are wrapped in a tracked redirect to count clicks.
         */
        linkTracking?: boolean;
        /**
         * Tag applied to a contact when they click a tracked link.
         */
        clickTag?: string;
        /**
         * Seconds waited after the trigger before the DM is sent. Absent when the DM goes out immediately.
         */
        dmDelaySeconds?: number;
        /**
         * Seconds waited before the public reply is posted. Absent when it follows the DM immediately.
         */
        commentReplyDelaySeconds?: number;
        /**
         * Whether these keywords also fire on a plain inbound DM.
         */
        alsoMatchInDms?: boolean;
        isActive?: boolean;
        stats?: {
            triggered?: number;
            dmsSent?: number;
            dmsFailed?: number;
            uniqueContacts?: number;
            /**
             * DMs sent with a trackable (wrapped) link. CTR denominator: divide clicks by this, not dmsSent. Lags dmsSent for campaigns that predate click tracking.
             */
            trackedSends?: number;
            /**
             * Total clicks on tracked links (bots/prefetch excluded).
             */
            linkClicks?: number;
            /**
             * Distinct people who clicked a tracked link.
             */
            uniqueClicks?: number;
            /**
             * DMs confirmed delivered (Messenger; IG emits no delivery receipt).
             */
            delivered?: number;
            /**
             * DMs confirmed read (IG messaging_seen / Messenger message_reads).
             */
            read?: number;
        };
        createdAt?: string;
    }>;
});
type ListCommentAutomationsError = (unknown | {
    error?: string;
});
type CreateCommentAutomationData = {
    body: {
        profileId: string;
        /**
         * Instagram or Facebook account ID
         */
        accountId: string;
        /**
         * What fires the automation. 'comment' (keyword comment on a post) or 'story_reply' (keyword reply to an Instagram story). For 'story_reply', platformPostId is the story media id (omit for any story).
         */
        trigger?: 'comment' | 'story_reply';
        /**
         * Platform media/post ID (or story media id when trigger=story_reply). Omit for an account-wide (any-post / any-story) automation.
         */
        platformPostId?: string;
        /**
         * Zernio post ID. Required only when also targeting a specific post via platformPostId.
         */
        postId?: string;
        /**
         * Post content snippet for display
         */
        postTitle?: string;
        /**
         * Automation label
         */
        name: string;
        /**
         * Trigger keywords (empty = any comment triggers)
         */
        keywords?: Array<(string)>;
        /**
         * How a keyword is compared with the comment. 'contains' (default) matches anywhere, even inside another word (keyword 'app' fires on 'happy'). 'word' matches the keyword only as a standalone word. 'exact' requires the whole comment to be exactly the keyword.
         */
        matchMode?: 'exact' | 'contains' | 'word';
        /**
         * Comments containing one of these never trigger the automation, even when a trigger keyword also matches. Compared using the same matchMode.
         */
        excludeKeywords?: Array<(string)>;
        /**
         * Only with matchMode=word: also fire on close misspellings of a keyword (one edit for 4-7 character keywords, two from 8 up). Keywords shorter than 4 characters are never fuzzy-matched.
         */
        typoTolerance?: boolean;
        /**
         * DM text to send to commenter. Max 640 chars when buttons are set, otherwise ~1000.
         */
        dmMessage: string;
        /**
         * Optional inline DM buttons (1-3). Phone buttons are Facebook-only. Omit or pass [] for a plain-text DM.
         */
        buttons?: Array<DmButton>;
        /**
         * Optional product card sent INSTEAD of the plain dmMessage bubble. Mutually exclusive with buttons. dmMessage stays required: it is what gets sent the moment the card is cleared.
         */
        template?: (CommentAutomationTemplate);
        /**
         * Optional public reply to the comment
         */
        commentReply?: string;
        /**
         * Optional alternate DM texts for random rotation. When set, each triggered comment sends one picked at random from [dmMessage, ...dmMessageVariations], so repeat commenters get slightly different DMs (helps avoid identical-message patterns). Up to 5. Buttons are attached to whichever text is picked, not varied.
         */
        dmMessageVariations?: Array<(string)>;
        /**
         * Optional alternate public replies, rotated at random alongside commentReply (picked independently of the DM). Up to 5.
         */
        commentReplyVariations?: Array<(string)>;
        /**
         * Wrap link buttons in the DM in a tracked redirect so clicks are counted (Link Clicks / CTR). Pass false to send links exactly as written. Defaults to on.
         */
        linkTracking?: boolean;
        /**
         * Optional tag applied to a contact when they click a tracked link (requires linkTracking). Lets you segment clickers for broadcasts/sequences.
         */
        clickTag?: string;
        /**
         * Seconds to wait after the trigger before sending the DM. Omit or send 0 to reply immediately (the default). Max 86400 (24h). The trigger is still matched and deduplicated the moment the comment arrives, so a delay only moves when the response is sent.
         */
        dmDelaySeconds?: number;
        /**
         * Seconds to wait before posting the public comment reply. Omit or send 0 to post it right after the DM (the default). The reply never goes out before the DM, so a value below dmDelaySeconds is raised to it. Ignored when trigger=story_reply, which has no public reply.
         */
        commentReplyDelaySeconds?: number;
        /**
         * Also fire these keywords on a plain inbound DM, so the automation answers people who message the keyword instead of commenting it. Requires at least one keyword (an empty keyword list means 'match anything', which would answer every inbound message) and is rejected on story_reply automations, which already trigger on DMs. Dedup is per door: a contact who already received the DM from their comment can still receive it from a DM.
         */
        alsoMatchInDms?: boolean;
        audience?: CommentAutomationAudience;
        followGate?: CommentAutomationFollowGate;
    };
};
type CreateCommentAutomationResponse = ({
    success?: boolean;
    automation?: {
        id?: string;
        name?: string;
        platform?: string;
        trigger?: 'comment' | 'story_reply';
        platformPostId?: string;
        keywords?: Array<(string)>;
        /**
         * How a keyword is compared with the comment. 'contains' (default) matches anywhere, even inside another word (keyword 'app' fires on 'happy'). 'word' matches the keyword only as a standalone word. 'exact' requires the whole comment to be exactly the keyword.
         */
        matchMode?: 'exact' | 'contains' | 'word';
        /**
         * Comments containing one of these never trigger the automation, even when a trigger keyword also matches. Compared using the same matchMode.
         */
        excludeKeywords?: Array<(string)>;
        /**
         * Only with matchMode=word: also fire on close misspellings of a keyword (one edit for 4-7 character keywords, two from 8 up). Keywords shorter than 4 characters are never fuzzy-matched.
         */
        typoTolerance?: boolean;
        dmMessage?: string;
        /**
         * Inline DM buttons (up to 3). Omitted when none are set.
         */
        buttons?: Array<DmButton>;
        template?: CommentAutomationTemplate;
        commentReply?: string;
        /**
         * Alternate DM texts rotated at random with dmMessage. Omitted when none.
         */
        dmMessageVariations?: Array<(string)>;
        /**
         * Alternate public replies rotated at random with commentReply. Omitted when none.
         */
        commentReplyVariations?: Array<(string)>;
        linkTracking?: boolean;
        clickTag?: string;
        /**
         * Seconds waited after the trigger before the DM is sent. Absent when the DM goes out immediately.
         */
        dmDelaySeconds?: number;
        /**
         * Seconds waited before the public reply is posted. Absent when it follows the DM immediately.
         */
        commentReplyDelaySeconds?: number;
        audience?: CommentAutomationAudience;
        followGate?: CommentAutomationFollowGate;
        /**
         * Whether these keywords also fire on a plain inbound DM.
         */
        alsoMatchInDms?: boolean;
        isActive?: boolean;
        stats?: {
            totalTriggered?: number;
            totalSent?: number;
            totalFailed?: number;
        };
        createdAt?: string;
    };
});
type CreateCommentAutomationError = (unknown | {
    error?: string;
});
type GetCommentAutomationData = {
    path: {
        automationId: string;
    };
};
type GetCommentAutomationResponse = ({
    success?: boolean;
    automation?: {
        id?: string;
        name?: string;
        platform?: string;
        trigger?: 'comment' | 'story_reply';
        accountId?: string;
        platformPostId?: string;
        postId?: string;
        postTitle?: string;
        keywords?: Array<(string)>;
        /**
         * How a keyword is compared with the comment. 'contains' (default) matches anywhere, even inside another word (keyword 'app' fires on 'happy'). 'word' matches the keyword only as a standalone word. 'exact' requires the whole comment to be exactly the keyword.
         */
        matchMode?: 'exact' | 'contains' | 'word';
        /**
         * Comments containing one of these never trigger the automation, even when a trigger keyword also matches. Compared using the same matchMode.
         */
        excludeKeywords?: Array<(string)>;
        /**
         * Only with matchMode=word: also fire on close misspellings of a keyword (one edit for 4-7 character keywords, two from 8 up). Keywords shorter than 4 characters are never fuzzy-matched.
         */
        typoTolerance?: boolean;
        dmMessage?: string;
        /**
         * Inline DM buttons (up to 3). Omitted when none are set.
         */
        buttons?: Array<DmButton>;
        template?: CommentAutomationTemplate;
        commentReply?: string;
        /**
         * Alternate DM texts rotated at random with dmMessage. Omitted when none.
         */
        dmMessageVariations?: Array<(string)>;
        /**
         * Alternate public replies rotated at random with commentReply. Omitted when none.
         */
        commentReplyVariations?: Array<(string)>;
        linkTracking?: boolean;
        clickTag?: string;
        /**
         * Seconds waited after the trigger before the DM is sent. Absent when the DM goes out immediately.
         */
        dmDelaySeconds?: number;
        /**
         * Seconds waited before the public reply is posted. Absent when it follows the DM immediately.
         */
        commentReplyDelaySeconds?: number;
        audience?: CommentAutomationAudience;
        followGate?: CommentAutomationFollowGate;
        /**
         * Whether these keywords also fire on a plain inbound DM.
         */
        alsoMatchInDms?: boolean;
        isActive?: boolean;
        stats?: {
            totalTriggered?: number;
            totalSent?: number;
            totalFailed?: number;
        };
        createdAt?: string;
        updatedAt?: string;
    };
    logs?: Array<{
        id?: string;
        commentId?: string;
        commenterId?: string;
        commenterName?: string;
        commentText?: string;
        /**
         * Which door triggered this send. Absent on rows written before this field existed (all of those are comment-triggered).
         */
        source?: 'comment' | 'story_reply' | 'dm';
        /**
         * DM outcome. 'pending' = the automation has a dmDelaySeconds and the response is queued but not sent yet. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap.
         */
        status?: 'pending' | 'sent' | 'failed' | 'skipped' | 'gated';
        /**
         * How the audience rule resolved. Absent on automations without one.
         */
        audienceOutcome?: 'passed' | 'blocked' | 'gate_sent' | 'gate_passed' | 'gate_failed';
        /**
         * Follow relationship at decision time. Absent when Instagram would not tell us (the commenter never messaged the account).
         */
        commenterIsFollower?: boolean;
        commenterFollowerCount?: number;
        /**
         * DM error message if status is failed
         */
        error?: string;
        /**
         * Outcome of the optional public reply on the triggering comment. 'skipped' if no commentReply was configured or if the DM failed (the public reply is not attempted in that case).
         */
        commentReplyStatus?: 'sent' | 'failed' | 'skipped';
        /**
         * Public-reply error message if commentReplyStatus is failed
         */
        commentReplyError?: string;
        /**
         * When the next queued send fires. Present only while something is still pending.
         */
        nextDueAt?: string;
        createdAt?: string;
    }>;
});
type GetCommentAutomationError = ({
    error?: string;
});
type UpdateCommentAutomationData = {
    body?: {
        name?: string;
        /**
         * What fires the automation. Changing it detaches the automation from its bound post or story (a post id and a story id are different objects), unless this same request sets a new binding. 'story_reply' is Instagram only.
         */
        trigger?: 'comment' | 'story_reply';
        keywords?: Array<(string)>;
        /**
         * How a keyword is compared with the comment. 'contains' (default) matches anywhere, even inside another word (keyword 'app' fires on 'happy'). 'word' matches the keyword only as a standalone word. 'exact' requires the whole comment to be exactly the keyword.
         */
        matchMode?: 'exact' | 'contains' | 'word';
        /**
         * Comments containing one of these never trigger the automation, even when a trigger keyword also matches. Compared using the same matchMode.
         */
        excludeKeywords?: Array<(string)>;
        /**
         * Only with matchMode=word: also fire on close misspellings of a keyword (one edit for 4-7 character keywords, two from 8 up). Keywords shorter than 4 characters are never fuzzy-matched.
         */
        typoTolerance?: boolean;
        dmMessage?: string;
        /**
         * Inline DM buttons (1-3). Pass [] to clear all buttons.
         */
        buttons?: Array<DmButton>;
        /**
         * Product card sent instead of the plain dmMessage bubble. Pass null to clear it and fall back to dmMessage. Mutually exclusive with buttons, including with the buttons already stored on the automation.
         */
        template?: (CommentAutomationTemplate | null);
        commentReply?: string;
        /**
         * Alternate DM texts for random rotation (see create). Pass [] to clear.
         */
        dmMessageVariations?: Array<(string)>;
        /**
         * Alternate public replies for random rotation. Pass [] to clear.
         */
        commentReplyVariations?: Array<(string)>;
        /**
         * Wrap link buttons in a tracked redirect to count clicks. Pass false to send links untouched.
         */
        linkTracking?: boolean;
        /**
         * Tag applied to a contact when they click a tracked link (requires linkTracking). Empty string clears it.
         */
        clickTag?: string;
        /**
         * Also fire these keywords on a plain inbound DM. Enabling it requires the automation to end up with at least one keyword (this request's keywords if you send them, otherwise the stored ones) and is rejected on story_reply automations.
         */
        alsoMatchInDms?: boolean;
        /**
         * Seconds to wait after the trigger before sending the DM. Send 0 to clear the delay and reply immediately.
         */
        dmDelaySeconds?: number;
        /**
         * Seconds to wait before posting the public comment reply. Send 0 to clear it. The reply never goes out before the DM.
         */
        commentReplyDelaySeconds?: number;
        audience?: CommentAutomationAudience;
        followGate?: CommentAutomationFollowGate;
        isActive?: boolean;
    };
    path: {
        automationId: string;
    };
};
type UpdateCommentAutomationResponse = ({
    success?: boolean;
    automation?: {
        id?: string;
        name?: string;
        keywords?: Array<(string)>;
        /**
         * How a keyword is compared with the comment. 'contains' (default) matches anywhere, even inside another word (keyword 'app' fires on 'happy'). 'word' matches the keyword only as a standalone word. 'exact' requires the whole comment to be exactly the keyword.
         */
        matchMode?: 'exact' | 'contains' | 'word';
        /**
         * Comments containing one of these never trigger the automation, even when a trigger keyword also matches. Compared using the same matchMode.
         */
        excludeKeywords?: Array<(string)>;
        /**
         * Only with matchMode=word: also fire on close misspellings of a keyword (one edit for 4-7 character keywords, two from 8 up). Keywords shorter than 4 characters are never fuzzy-matched.
         */
        typoTolerance?: boolean;
        dmMessage?: string;
        /**
         * Inline DM buttons (up to 3). Omitted when none are set.
         */
        buttons?: Array<DmButton>;
        template?: CommentAutomationTemplate;
        commentReply?: string;
        /**
         * Alternate DM texts rotated at random with dmMessage. Omitted when none.
         */
        dmMessageVariations?: Array<(string)>;
        /**
         * Alternate public replies rotated at random with commentReply. Omitted when none.
         */
        commentReplyVariations?: Array<(string)>;
        audience?: CommentAutomationAudience;
        followGate?: CommentAutomationFollowGate;
        /**
         * Whether these keywords also fire on a plain inbound DM.
         */
        alsoMatchInDms?: boolean;
        isActive?: boolean;
        updatedAt?: string;
    };
});
type UpdateCommentAutomationError = ({
    error?: string;
});
type DeleteCommentAutomationData = {
    path: {
        automationId: string;
    };
};
type DeleteCommentAutomationResponse = (unknown);
type DeleteCommentAutomationError = ({
    error?: string;
});
type ListCommentAutomationLogsData = {
    path: {
        automationId: string;
    };
    query?: {
        limit?: number;
        skip?: number;
        /**
         * Filter by result status
         */
        status?: 'pending' | 'sent' | 'failed' | 'skipped' | 'gated';
    };
};
type ListCommentAutomationLogsResponse = ({
    success?: boolean;
    logs?: Array<{
        id?: string;
        commentId?: string;
        commenterId?: string;
        commenterName?: string;
        commentText?: string;
        /**
         * Which door triggered this send. Absent on rows written before this field existed (all of those are comment-triggered).
         */
        source?: 'comment' | 'story_reply' | 'dm';
        /**
         * DM outcome. 'pending' = the automation has a dmDelaySeconds and the response is queued but not sent yet. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap.
         */
        status?: 'pending' | 'sent' | 'failed' | 'skipped' | 'gated';
        /**
         * How the audience rule resolved. Absent on automations without one.
         */
        audienceOutcome?: 'passed' | 'blocked' | 'gate_sent' | 'gate_passed' | 'gate_failed';
        /**
         * Follow relationship at decision time. Absent when Instagram would not tell us (the commenter never messaged the account).
         */
        commenterIsFollower?: boolean;
        commenterFollowerCount?: number;
        /**
         * DM error message if status is failed
         */
        error?: string;
        /**
         * Outcome of the optional public reply on the triggering comment. 'skipped' if no commentReply was configured or if the DM failed (the public reply is not attempted in that case).
         */
        commentReplyStatus?: 'sent' | 'failed' | 'skipped';
        /**
         * Public-reply error message if commentReplyStatus is failed
         */
        commentReplyError?: string;
        /**
         * When the next queued send fires. Present only while something is still pending.
         */
        nextDueAt?: string;
        createdAt?: string;
    }>;
    pagination?: {
        total?: number;
        limit?: number;
        skip?: number;
        hasMore?: boolean;
    };
    /**
     * Comments that reached this automation but matched none of its keywords. These produce no log entry, so this is the only signal that a keyword is catching nothing. Retained for a short window, then dropped.
     */
    misses?: {
        /**
         * Number of non-matching comments in the retention window
         */
        total?: number;
        /**
         * How many days of non-matching comments the total covers
         */
        retentionDays?: number;
        /**
         * A few of the most recent non-matching comments, for diagnosing a keyword setup.
         */
        samples?: Array<{
            commentText?: string;
            commenterName?: string;
            /**
             * Set when an exclusion keyword vetoed an otherwise matching comment
             */
            excludedBy?: string;
            at?: string;
        }>;
    };
});
type ListCommentAutomationLogsError = (ErrorResponse | {
    error?: string;
});
type ListAdsData = {
    query?: {
        /**
         * Social account ID
         */
        accountId?: string;
        /**
         * Platform ad account ID (e.g. act_123 for Meta). Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.
         */
        adAccountId?: string;
        /**
         * Platform campaign ID (filter ads within a campaign)
         */
        campaignId?: string;
        /**
         * Instagram media ID of the boosted post (Meta `effective_instagram_media_id`). Use to map a Business-Manager-visible IG post back to the Zernio ad.
         */
        effectiveInstagramMediaId?: string;
        /**
         * Facebook `{pageId}_{postId}` of the post the ad's engagement lives on (Meta `effective_object_story_id`). Use to map a Business-Manager-visible post back to the Zernio ad.
         */
        effectiveObjectStoryId?: string;
        /**
         * Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago.
         */
        fromDate?: string;
        limit?: number;
        /**
         * Page number (1-based)
         */
        page?: number;
        /**
         * Meta only: Facebook Page ID. Returns only ads whose creative is backed by this Page (a Meta ad account serves ads for every Page in the Business Manager). Matches each ad's `creative.pageId`; ads with no page signal (rare IG-only creatives) never match. Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.
         */
        pageId?: string;
        platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
        /**
         * Meta ad ID. Returns the ad with this platform-side ad ID.
         */
        platformAdId?: string;
        /**
         * Profile ID
         */
        profileId?: string;
        /**
         * all (default) = Zernio-created + platform-discovered ads. zernio = restrict to Zernio-created only.
         */
        source?: 'zernio' | 'all';
        status?: AdStatus;
        /**
         * End of metrics date range (YYYY-MM-DD). Defaults to today. Max 730-day range.
         */
        toDate?: string;
    };
};
type ListAdsResponse = (AdsListResponse | (AdsListResponse & {
    /**
     * Always true on this response. Part of the requested range is still being backfilled; retry until the request returns 200.
     */
    backfillPending: boolean;
}));
type ListAdsError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetAdsSearchTermsData = {
    query: {
        /**
         * Google ads SocialAccount id.
         */
        accountId: string;
        /**
         * Numeric Google ad group id filter.
         */
        adGroupId?: string;
        /**
         * Numeric Google campaign id filter.
         */
        campaignId?: string;
        /**
         * Numeric Google Ads customer id (no dashes). Defaults to the account's connected customer.
         */
        customerId?: string;
        /**
         * Defaults to 30 days ago.
         */
        fromDate?: string;
        /**
         * Cursor from paging.nextPageToken of the previous page.
         */
        pageToken?: string;
        /**
         * Defaults to today.
         */
        toDate?: string;
    };
};
type GetAdsSearchTermsResponse = ({
    customerId?: string;
    data?: Array<{
        searchTerm?: (string) | null;
        /**
         * ADDED / EXCLUDED / ADDED_EXCLUDED / NONE — whether the term is already a keyword or a negative.
         */
        status?: (string) | null;
        /**
         * How the term matched (BROAD, PHRASE, EXACT, NEAR_PHRASE, NEAR_EXACT).
         */
        matchType?: (string) | null;
        campaignId?: (string) | null;
        campaignName?: (string) | null;
        adGroupId?: (string) | null;
        adGroupName?: (string) | null;
        impressions?: number;
        clicks?: number;
        /**
         * Cost in micros of the account currency (divide by 1,000,000).
         */
        costMicros?: number;
        conversions?: number;
        conversionsValue?: number;
    }>;
    paging?: {
        /**
         * Null when the last page was returned.
         */
        nextPageToken?: (string) | null;
    };
});
type GetAdsSearchTermsError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListLocalServicesLeadsData = {
    query: {
        /**
         * Google ads SocialAccount id.
         */
        accountId: string;
        /**
         * true = only leads Google charged for.
         */
        chargedOnly?: boolean;
        /**
         * Numeric Google Ads customer id (no dashes). Defaults to the account's connected customer.
         */
        customerId?: string;
        /**
         * Leads created at/after this day.
         */
        fromDate?: string;
        /**
         * Google LocalServicesLeadStatus enum value (e.g. NEW, BOOKED, WIPED_OUT).
         */
        leadStatus?: string;
        leadType?: 'PHONE_CALL' | 'MESSAGE' | 'BOOKING';
        /**
         * Cursor from paging.nextPageToken of the previous page.
         */
        pageToken?: string;
        /**
         * Leads created at/before this day.
         */
        toDate?: string;
    };
};
type ListLocalServicesLeadsResponse = ({
    customerId?: string;
    data?: Array<{
        /**
         * Lead id; pass to /v1/ads/local-services/leads/{leadId}/conversations.
         */
        id?: (string) | null;
        /**
         * PHONE_CALL / MESSAGE / BOOKING.
         */
        leadType?: (string) | null;
        categoryId?: (string) | null;
        serviceId?: (string) | null;
        /**
         * Null for WIPED_OUT leads (contact erased by Google).
         */
        contact?: {
            consumerName?: (string) | null;
            email?: (string) | null;
            phoneNumber?: (string) | null;
        } | null;
        status?: (string) | null;
        /**
         * Google datetime in the customer's timezone (YYYY-MM-DD HH:MM:SS).
         */
        createdTime?: (string) | null;
        locale?: (string) | null;
        charged?: boolean;
        creditState?: (string) | null;
        creditStateLastUpdate?: (string) | null;
    }>;
    paging?: {
        /**
         * Null when the last page was returned.
         */
        nextPageToken?: (string) | null;
    };
});
type ListLocalServicesLeadsError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListLocalServicesLeadConversationsData = {
    path: {
        /**
         * Numeric lead id from /v1/ads/local-services/leads.
         */
        leadId: string;
    };
    query: {
        /**
         * Google ads SocialAccount id.
         */
        accountId: string;
        /**
         * Numeric Google Ads customer id (no dashes). Defaults to the account's connected customer.
         */
        customerId?: string;
        /**
         * Cursor from paging.nextPageToken of the previous page.
         */
        pageToken?: string;
    };
};
type ListLocalServicesLeadConversationsResponse = ({
    customerId?: string;
    data?: Array<{
        id?: (string) | null;
        /**
         * PHONE_CALL / MESSAGE / SMS / EMAIL / WHATSAPP / ADS_API.
         */
        channel?: (string) | null;
        /**
         * ADVERTISER or CONSUMER.
         */
        participantType?: (string) | null;
        eventDateTime?: (string) | null;
        /**
         * Only on PHONE_CALL entries.
         */
        phoneCall?: {
            callDurationMillis?: (number) | null;
            callRecordingUrl?: (string) | null;
        } | null;
        /**
         * Only on message-channel entries.
         */
        message?: {
            text?: (string) | null;
            attachmentUrls?: Array<(string)>;
        } | null;
    }>;
    paging?: {
        /**
         * Null when the last page was returned.
         */
        nextPageToken?: (string) | null;
    };
});
type ListLocalServicesLeadConversationsError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListAdKeywordsData = {
    query?: {
        /**
         * Social account ID
         */
        accountId?: string;
        /**
         * Platform ad account ID (Google customer ID). Mirrors the same filter on /v1/ads.
         */
        adAccountId?: string;
        /**
         * Platform ad group ID (Google ad group)
         */
        adSetId?: string;
        /**
         * Platform campaign ID
         */
        campaignId?: string;
        limit?: number;
        matchType?: 'exact' | 'phrase' | 'broad' | 'unknown';
        /**
         * true = negative keywords only, false = positive only. Omit for both.
         */
        negative?: boolean;
        /**
         * Page number (1-based)
         */
        page?: number;
        /**
         * Profile ID
         */
        profileId?: string;
        /**
         * Case-insensitive substring match on the keyword text
         */
        search?: string;
        /**
         * Keyword criterion status
         */
        status?: 'active' | 'paused';
    };
};
type ListAdKeywordsResponse = ({
    keywords?: Array<{
        id?: string;
        /**
         * Social account ID owning the sync
         */
        accountId?: string;
        profileId?: string;
        platform?: 'google';
        /**
         * Google customer ID
         */
        adAccountId?: string;
        campaignId?: string;
        campaignName?: (string) | null;
        campaignStatus?: (string) | null;
        /**
         * Google ad group ID
         */
        adSetId?: string;
        adSetName?: (string) | null;
        adSetStatus?: (string) | null;
        keyword?: string;
        matchType?: 'exact' | 'phrase' | 'broad' | 'unknown';
        status?: 'active' | 'paused';
        negative?: boolean;
        syncedAt?: (string) | null;
    }>;
    pagination?: Pagination;
});
type ListAdKeywordsError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListAdCampaignsData = {
    query?: {
        /**
         * Social account ID
         */
        accountId?: string;
        /**
         * Platform ad account ID (e.g. act_123 for Meta)
         */
        adAccountId?: string;
        /**
         * Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
         */
        fromDate?: string;
        /**
         * Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window. Filters the campaign set itself, so `pagination.total` counts only matching campaigns. Mirrors the same filter on /v1/ads/tree.
         */
        hasDelivery?: boolean;
        /**
         * Meta only. Campaign reads aggregate over ad documents, so a campaign with ZERO ads is normally invisible here — the state the two-step create (campaign, then ads via `existingCampaignId`) leaves behind whenever Meta rejects the ad step. Set true to list those too, with `adCount: 0` and zeroed metrics. Requires `accountId` and `adAccountId`, since an empty campaign has no ad row to resolve a token or ad account from.
         */
        includeEmpty?: boolean;
        limit?: number;
        /**
         * Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount, in each campaign's OWN currency (the `currency` field on the campaign). Implies `hasDelivery`; `minSpend=0` applies no filter. Mirrors the same filter on /v1/ads/tree.
         */
        minSpend?: number;
        /**
         * Page number (1-based)
         */
        page?: number;
        /**
         * Meta only: Facebook Page ID. Campaigns have no Page of their own, so this keeps campaigns having at least one ad backed by this Page, with adCount and metrics computed over those ads only. Mirrors the same filter on /v1/ads and /v1/ads/tree.
         */
        pageId?: string;
        platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
        /**
         * Profile ID
         */
        profileId?: string;
        /**
         * `all` (default) returns both Zernio-created ads and those discovered from the platform's ad manager — matches the web UI's default view. Pass `zernio` to restrict to isExternal=false only. Status is NOT filtered by default — use the `status` param for that.
         */
        source?: 'zernio' | 'all';
        /**
         * Filter by derived campaign status (post-aggregation)
         */
        status?: AdStatus;
        /**
         * End of metrics date range (YYYY-MM-DD, inclusive). Defaults to today. Max 730-day range.
         */
        toDate?: string;
    };
};
type ListAdCampaignsResponse = ({
    campaigns?: Array<AdCampaign>;
    pagination?: Pagination;
});
type ListAdCampaignsError = (ErrorResponse | {
    error?: string;
} | unknown);
type CreateAdCampaignData = {
    body: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        name: string;
        /**
         * Mapped to the ODAX objective (same mapping as POST /v1/ads/create).
         */
        goal: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'job_applicants' | 'conversions' | 'app_promotion' | 'catalog_sales';
        specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'ISSUES_ELECTIONS_POLITICS' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ONLINE_GAMBLING_AND_GAMING')>;
        /**
         * Campaign-level (CBO) budget in WHOLE currency units (USD: 50 = $50.00), NOT cents — Meta's own Marketing API takes this same number in minor units, so it is an easy and expensive mix-up. Requires budgetType.
         */
        budgetAmount?: number;
        budgetType?: 'daily' | 'lifetime';
        status?: 'ACTIVE' | 'PAUSED';
        /**
         * Campaign bid strategy. Meta stores `bid_strategy` alongside the budget, so this REQUIRES `budgetAmount` + `budgetType` on the same request; sending it without a campaign budget is a 400. A campaign carrying a strategy without its `bid_amount` makes every ad set created under it fail with an error that names the ad set (code 100, subcode 1815857), so the bad state is rejected up front rather than accepted. To bid at ad-set level, set the strategy there instead.
         */
        bidStrategy?: 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP' | 'LOWEST_COST_WITH_MIN_ROAS';
        /**
         * Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise. Validated here but NOT stored by Meta: the campaign object has no bid_amount field, only bid_strategy lives on it. The amount takes effect once an ad set joins this campaign (existingCampaignId on POST /v1/ads/create) and supplies its own bidAmount there.
         */
        bidAmount?: number;
        /**
         * Decimal ROAS multiplier (2.0 = 2.0x). Required for LOWEST_COST_WITH_MIN_ROAS.
         */
        roasAverageFloor?: number;
    };
    headers?: {
        /**
         * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409. Only 2xx responses are stored, so a request that failed with a 4xx can be retried with a corrected body under the SAME key.
         */
        'Idempotency-Key'?: string;
    };
};
type CreateAdCampaignResponse = ({
    adAccountId?: string;
    /**
     * Platform id of the new campaign
     */
    campaignId?: string;
    /**
     * Resolved ODAX objective (e.g. OUTCOME_SALES).
     */
    objective?: string;
    status?: 'ACTIVE' | 'PAUSED';
});
type CreateAdCampaignError = (unknown | {
    error?: string;
});
type UpdateAdCampaignStatusData = {
    body: {
        status: 'active' | 'paused';
        platform: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
    };
    path: {
        /**
         * Platform campaign ID
         */
        campaignId: string;
    };
};
type UpdateAdCampaignStatusResponse = ({
    /**
     * The status written to the campaign
     */
    status?: 'active' | 'paused';
    /**
     * Number of ads whose own stored status changed too. 0 is normal on a resume whose ads are all awaiting the platform.
     */
    updated?: number;
    /**
     * Number of ads whose own status was left as it was
     */
    skipped?: number;
    /**
     * Why each group of ads was skipped
     */
    skippedReasons?: Array<(string)>;
});
type UpdateAdCampaignStatusError = (unknown | {
    error?: string;
});
type UpdateAdCampaignData = {
    body: {
        /**
         * Required: platform campaign IDs are not globally unique.
         */
        platform: 'facebook' | 'instagram' | 'google';
        /**
         * **Meta only.** Zernio SocialAccount id owning the ad account. Needed only for an EMPTY campaign (zero ads); ignored otherwise.
         */
        accountId?: string;
        /**
         * **Meta + Google.** On Meta, the campaign default that ad sets inherit unless they override it. On Google, the campaign's own bidding strategy.
         */
        bidStrategy?: (BidStrategy);
        /**
         * **Google only.** Whole currency units (USD: 12 = $12.00). Max CPC for LOWEST_COST_WITH_BID_CAP, CPA target for COST_CAP; required for both.
         */
        bidAmount?: number;
        /**
         * **Google only.** Decimal ROAS multiplier (2.0 = 2.0x), required for LOWEST_COST_WITH_MIN_ROAS.
         */
        roasAverageFloor?: number;
        /**
         * **Meta only.** The CBO budget.
         */
        budget?: {
            /**
             * Budget amount in the ad account's currency
             */
            amount: number;
            type: 'daily' | 'lifetime';
        };
        /**
         * **Meta only.** Rename the campaign.
         */
        name?: string;
        /**
         * **Meta only.** Platform implied by the `platform` body param, same convention as POST /v1/ads/create.
         */
        platformSpecificData?: {
            /**
             * Campaign lifetime spend cap, in the ad account's currency (Meta `spend_cap`). Pass null to remove the cap; 0 is rejected by Meta.
             */
            spendCap?: (number) | null;
        };
    };
    path: {
        /**
         * Platform campaign ID
         */
        campaignId: string;
    };
};
type UpdateAdCampaignResponse = ({
    /**
     * Local Ad documents mirrored. 0 on the empty-campaign path.
     */
    updated?: number;
    budget?: AdBudget;
    budgetLevel?: 'campaign';
    bidStrategy?: BidStrategy;
    bidAmount?: number;
    roasAverageFloor?: number;
    platformSpecificData?: {
        [key: string]: unknown;
    };
});
type UpdateAdCampaignError = (unknown | {
    error?: string;
});
type DeleteAdCampaignData = {
    body: {
        platform: 'facebook' | 'instagram';
        /**
         * Zernio SocialAccount id owning the ad account. Required only to delete an EMPTY campaign (zero ads), which has no local Ad documents to resolve a token from.
         */
        accountId?: string;
    };
    path: {
        /**
         * Platform campaign ID
         */
        campaignId: string;
    };
};
type DeleteAdCampaignResponse = ({
    deleted?: boolean;
    /**
     * Number of local Ad docs marked cancelled
     */
    adCount?: number;
});
type DeleteAdCampaignError = ({
    error?: string;
} | unknown);
type BulkUpdateAdCampaignStatusData = {
    body: {
        status: 'active' | 'paused';
        campaigns: Array<{
            platformCampaignId: string;
            platform: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
        }>;
    };
};
type BulkUpdateAdCampaignStatusResponse = ({
    status?: 'active' | 'paused';
    totals?: {
        updated?: number;
        skipped?: number;
        failed?: number;
    };
    results?: Array<{
        platformCampaignId?: string;
        platform?: string;
        updated?: number;
        skipped?: number;
        error?: string;
    }>;
});
type BulkUpdateAdCampaignStatusError = (unknown | {
    error?: string;
});
type DuplicateAdCampaignData = {
    body: {
        platform: 'facebook' | 'instagram' | 'tiktok' | 'linkedin';
        /**
         * Copy child ad sets + ads + creatives + targeting
         */
        deepCopy?: boolean;
        /**
         * ACTIVE = launch the clone immediately (spends the moment LinkedIn approves it). PAUSED = clone stays DRAFT, safe default. INHERITED_FROM_SOURCE = mirror each entity's source status per-entity. Duplicating an ACTIVE campaign this way starts a second front of spend.
         *
         */
        statusOption?: 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE';
        /**
         * Reschedule the copied hierarchy's start time
         */
        startTime?: string;
        endTime?: string;
        renameStrategy?: 'DEEP_RENAME' | 'ONLY_TOP_LEVEL_RENAME' | 'NO_RENAME';
        renamePrefix?: string;
        renameSuffix?: string;
        /**
         * Trigger ads discovery on the owning account after the copy succeeds
         */
        syncAfter?: boolean;
    };
    headers?: {
        /**
         * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409. Only 2xx responses are stored, so a request that failed with a 4xx can be retried with a corrected body under the SAME key.
         */
        'Idempotency-Key'?: string;
    };
    path: {
        /**
         * Source platform campaign ID
         */
        campaignId: string;
    };
};
type DuplicateAdCampaignResponse = ({
    /**
     * Platform ID of the new campaign
     */
    copiedCampaignId?: string;
    discovery?: 'triggered' | 'skipped' | 'failed';
    /**
     * Platform-native response from the copy endpoint (Meta includes ad_object_ids for child copies)
     */
    raw?: {
        [key: string]: unknown;
    };
});
type DuplicateAdCampaignError = (unknown | {
    error?: string;
});
type DuplicateAdSetData = {
    body: {
        platform: 'facebook' | 'instagram';
        /**
         * Destination platform campaign id (defaults to the source's campaign)
         */
        campaignId?: string;
        /**
         * Copy child ads + creatives
         */
        deepCopy?: boolean;
        statusOption?: 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE';
        /**
         * Reschedule the copy's start time
         */
        startTime?: string;
        endTime?: string;
        renameStrategy?: 'DEEP_RENAME' | 'ONLY_TOP_LEVEL_RENAME' | 'NO_RENAME';
        renamePrefix?: string;
        renameSuffix?: string;
        syncAfter?: boolean;
    };
    headers?: {
        /**
         * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409. Only 2xx responses are stored, so a request that failed with a 4xx can be retried with a corrected body under the SAME key.
         */
        'Idempotency-Key'?: string;
    };
    path: {
        /**
         * Source platform ad set ID
         */
        adSetId: string;
    };
};
type DuplicateAdSetResponse = ({
    /**
     * Platform ID of the new ad set
     */
    copiedAdSetId?: string;
    discovery?: 'triggered' | 'skipped' | 'failed';
    /**
     * Meta's native copy response (includes ad_object_ids for child copies)
     */
    raw?: {
        [key: string]: unknown;
    };
});
type DuplicateAdSetError = (unknown | {
    error?: string;
});
type DuplicateAdData = {
    body?: {
        /**
         * Destination platform ad set id (defaults to the source's ad set)
         */
        adSetId?: string;
        statusOption?: 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE';
        renameStrategy?: 'DEEP_RENAME' | 'ONLY_TOP_LEVEL_RENAME' | 'NO_RENAME';
        renamePrefix?: string;
        renameSuffix?: string;
        syncAfter?: boolean;
    };
    headers?: {
        /**
         * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409. Only 2xx responses are stored, so a request that failed with a 4xx can be retried with a corrected body under the SAME key.
         */
        'Idempotency-Key'?: string;
    };
    path: {
        /**
         * Zernio ad ID or platform ad ID
         */
        adId: string;
    };
};
type DuplicateAdResponse = ({
    /**
     * Platform ID of the new ad
     */
    copiedAdId?: string;
    discovery?: 'triggered' | 'skipped' | 'failed';
    raw?: {
        [key: string]: unknown;
    };
});
type DuplicateAdError = (unknown | {
    error?: string;
});
type GetAdSetDetailsData = {
    path: {
        /**
         * Meta ad set id (platformAdSetId).
         */
        adSetId: string;
    };
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Comma-separated Graph field override (supports nested {} projections).
         */
        fields?: string;
    };
};
type GetAdSetDetailsResponse = ({
    /**
     * Raw Meta ad set; keys are the requested Graph fields.
     */
    adSet?: {
        [key: string]: unknown;
    };
});
type GetAdSetDetailsError = (unknown | {
    error?: string;
});
type UpdateAdSetData = {
    body: {
        platform: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
        /**
         * Omit if not updating budget
         */
        budget?: {
            amount?: number;
            type?: 'daily' | 'lifetime';
        };
        /**
         * Writes the ad set's own on/off switch (Meta: `configured_status`) on Meta and LinkedIn, whatever delivery status its ads report. Omit if not toggling delivery state.
         */
        status?: 'active' | 'paused';
        /**
         * Rename the ad set (Meta only; other platforms return 501). At least one of budget/status/bidStrategy/name is required.
         */
        name?: string;
        /**
         * Ad-set-level bid strategy. Overrides the campaign-level default.
         * Supported on Meta (facebook, instagram), TikTok, and OpenAI. On TikTok the
         * Meta-style enum is mapped to bid_type / bid_price / deep_bid_type
         * automatically. On OpenAI, LOWEST_COST_WITH_BID_CAP and COST_CAP both map to
         * the ad group's `bidding_config.max_bid_micros` (one knob covers both);
         * LOWEST_COST_WITH_MIN_ROAS is rejected with 422 (OpenAI has no ROAS-based
         * bidding). Other platforms (linkedin, pinterest, google, twitter) return 501
         * Not Implemented when bidStrategy is set.
         *
         */
        bidStrategy?: (BidStrategy);
        /**
         * Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
         * bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's
         * smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000). Meta only:
         * may be sent alone, WITHOUT bidStrategy, to update the cap amount on an ad set whose
         * parent campaign is COST_CAP or LOWEST_COST_WITH_BID_CAP (the strategy is inherited
         * from the campaign and is left untouched).
         *
         */
        bidAmount?: number;
        /**
         * Minimum ROAS as a decimal multiplier (2.0 = 2.0x). Required when bidStrategy is
         * LOWEST_COST_WITH_MIN_ROAS. Sent to Meta as `bid_constraints.roas_average_floor` × 10000.
         * Not supported on OpenAI (422).
         *
         */
        roasAverageFloor?: number;
        /**
         * Meta only (other platforms return 501). Value rule set to attach to this ad
         * set, from `/v1/ads/value-rule-sets`. Sending a different id replaces the
         * current association. To DETACH, send `valueRulesApplied: false` and omit
         * this field.
         *
         */
        valueRuleSetId?: string;
        /**
         * Meta only (other platforms return 501). `false` DETACHES the ad set's value
         * rule set and must be sent WITHOUT `valueRuleSetId`; the combination returns
         * 400. `true` is optional when attaching, since attachment is driven by
         * `valueRuleSetId`, and requires it to be present.
         *
         */
        valueRulesApplied?: boolean;
        /**
         * Platform-specific post-launch delivery settings. The platform is implied by the
         * `platform` body param. Meta only; other platforms return 400. Unknown keys are rejected.
         *
         */
        platformSpecificData?: {
            /**
             * Meta ad-set optimization_goal (e.g. OFFSITE_CONVERSIONS, LANDING_PAGE_VIEWS).
             */
            optimizationGoal?: string;
            /**
             * Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY).
             */
            billingEvent?: string;
            /**
             * Ad set start_time (ISO 8601).
             */
            startDate?: string;
            /**
             * Ad set end_time (ISO 8601).
             */
            endDate?: string;
            /**
             * Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create). Unknown keys are rejected with 400.
             */
            promotedObject?: {
                pixelId?: string;
                customEventType?: string;
                /**
                 * Pixel custom-event name (custom_event_str); requires customEventType OTHER. Same pairing rules as /v1/ads/create.
                 */
                customEventStr?: string;
                pageId?: string;
                applicationId?: string;
                objectStoreUrl?: string;
                customConversionId?: string;
                productCatalogId?: string;
                productSetId?: string;
                offlineConversionDataSetId?: string;
                whatsappPhoneNumber?: string;
            };
        };
    };
    path: {
        /**
         * Platform ad set ID
         */
        adSetId: string;
    };
};
type UpdateAdSetResponse = ({
    budget?: AdBudget;
    budgetLevel?: 'adset';
    /**
     * The status written to the ad set. Absent when nothing was written (see statusMessage).
     */
    status?: 'active' | 'paused';
    /**
     * Number of ads whose own stored status changed alongside the ad set switch
     */
    statusUpdated?: number;
    /**
     * Number of ads whose own status was left as it was
     */
    statusSkipped?: number;
    /**
     * Why each group of ads was skipped
     */
    statusSkippedReasons?: Array<(string)>;
    /**
     * Present only where the platform has no ad-set switch and no child ad was actionable; `status` is then absent because nothing was written
     */
    statusMessage?: string;
    bidStrategy?: BidStrategy;
    bidAmount?: (number) | null;
    roasAverageFloor?: (number) | null;
    platformSpecificData?: {
        [key: string]: unknown;
    };
});
type UpdateAdSetError = (unknown | {
    error?: string;
});
type UpdateAdSetStatusData = {
    body: {
        status: 'active' | 'paused';
        platform: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
    };
    path: {
        /**
         * Platform ad set ID
         */
        adSetId: string;
    };
};
type UpdateAdSetStatusResponse = ({
    /**
     * The status written to the ad set. Absent when nothing was written (see message).
     */
    status?: 'active' | 'paused';
    /**
     * Number of ads whose own stored status changed too. 0 is normal on a resume whose ads are all awaiting the platform.
     */
    updated?: number;
    /**
     * Number of ads whose own status was left as it was
     */
    skipped?: number;
    /**
     * Why each group of ads was skipped
     */
    skippedReasons?: Array<(string)>;
    /**
     * Present only where the platform has no ad-set switch and no child ad was actionable
     */
    message?: string;
});
type UpdateAdSetStatusError = (unknown | {
    error?: string;
});
type GetAdTreeData = {
    query?: {
        /**
         * Social account ID
         */
        accountId?: string;
        /**
         * Platform ad account ID
         */
        adAccountId?: string;
        /**
         * Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads.
         */
        campaignId?: string;
        /**
         * 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.
         */
        dailyLevel?: 'campaign' | 'adset' | 'ad';
        /**
         * Start of the METRICS date range (YYYY-MM-DD). On its own it affects only the spend/impression numbers overlaid on each node, not which campaigns are returned — pass `hasDelivery` or `minSpend` to also filter the campaign set to this window. Defaults to 90 days ago.
         */
        fromDate?: string;
        /**
         * Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window, so a campaign that spent then and is paused today is still returned. Filters the campaign set itself, so `pagination.total` counts only matching campaigns.
         */
        hasDelivery?: boolean;
        /**
         * Campaigns per page
         */
        limit?: number;
        /**
         * Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount. Expressed in each campaign's OWN currency (the `currency` field on the campaign node): spend is stored per ad account in its native currency and one response can span several. Implies `hasDelivery`; `minSpend=0` applies no filter.
         */
        minSpend?: number;
        /**
         * Page number (1-based)
         */
        page?: number;
        /**
         * Meta only: Facebook Page ID. Prunes the tree to ads whose creative is backed by this Page — campaigns and ad sets with no ad on the Page drop out, and rolled-up metrics cover only the Page's ads. Mirrors the same filter on /v1/ads and /v1/ads/campaigns.
         */
        pageId?: string;
        platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
        /**
         * Profile ID
         */
        profileId?: string;
        /**
         * Campaign-level sort order. `newest` (default) / `oldest` order by the campaign's newest-ad createdAt. `spend_desc` / `spend_asc` order by aggregated spend in the requested date range; campaigns with no spend land at the end.
         */
        sort?: 'newest' | 'oldest' | 'spend_desc' | 'spend_asc';
        /**
         * `all` (default) returns both Zernio-created ads and those discovered from the platform's ad manager — matches the web UI's default view. Pass `zernio` to restrict to isExternal=false only. Status is NOT filtered by default — use the `status` param for that.
         */
        source?: 'zernio' | 'all';
        /**
         * Filter by derived campaign status (post-aggregation)
         */
        status?: AdStatus;
        /**
         * Set to `1` to also return a daily breakdown. Mirrors Meta Insights' `time_increment=1`: each node gains a `daily[]` array of per-day metrics (same fields as the aggregated `metrics`) alongside the range total, so you get per-entity daily trends in ONE call instead of calling the tree once per day. Only `1` (daily) is supported. The daily series covers the same date range and uses the same source data as `metrics`, except `reach` on Meta and TikTok: the range total is the platform's de-duplicated value, so daily reach does not sum to it. See `dailyLevel` to control which levels carry it.
         */
        timeIncrement?: 1;
        /**
         * End of metrics date range (YYYY-MM-DD). Defaults to today. Max 730-day range.
         */
        toDate?: string;
    };
};
type GetAdTreeResponse = (AdTreeResponse | (AdTreeResponse & {
    /**
     * Always true on this response. Part of the requested range is still being backfilled; retry until the request returns 200.
     */
    backfillPending: boolean;
}));
type GetAdTreeError = ({
    error?: string;
} | unknown);
type GetAdsTimelineData = {
    query: {
        /**
         * Social account ID. Sibling-expanded to its linked posting↔ads pair.
         */
        accountId: string;
        /**
         * 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;
        /**
         * Inclusive start of metrics range (YYYY-MM-DD). Defaults to 90 days ago.
         */
        fromDate?: string;
        /**
         * Restrict to one platform.
         */
        platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai';
        /**
         * Inclusive end of metrics range (YYYY-MM-DD). Defaults to today. Max 730-day range.
         */
        toDate?: string;
    };
};
type GetAdsTimelineResponse = (AdsTimelineResponse | (AdsTimelineResponse & {
    /**
     * Always true on this response. Part of the requested range is still being backfilled; retry until the request returns 200.
     */
    backfillPending: boolean;
}));
type GetAdsTimelineError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetAdData = {
    path: {
        /**
         * Zernio `_id` (hex), Meta `platformAdId` (numeric), or one of the creative's effective story/media IDs. See description for details.
         *
         */
        adId: string;
    };
};
type GetAdResponse = ({
    ad?: Ad;
});
type GetAdError = ({
    error?: string;
});
type UpdateAdData = {
    body: {
        status?: 'active' | 'paused';
        budget?: {
            /**
             * Minimum varies by platform: TikTok=$20, Pinterest=$5, others=$1
             */
            amount?: number;
            /**
             * OpenAI Ads accepts lifetime only; sending daily returns 422.
             */
            type?: 'daily' | 'lifetime';
        };
        /**
         * Meta + TikTok (demographics/interests) and Google (keyword edits only).
         * Pinterest / X / LinkedIn return 501.
         *
         */
        targeting?: {
            /**
             * Google only. The FULL new set of positive keywords for the ad group; live keywords not listed are removed. Entries are strings (BROAD) or { text, matchType } with matchType exact | phrase | broad. Mirrored to GET /v1/ads/keywords immediately.
             */
            keywords?: Array<(string | {
                text: string;
                matchType?: 'exact' | 'phrase' | 'broad';
            })>;
            /**
             * Google only. Same declarative contract as keywords, for the ad group's negative keywords.
             */
            negativeKeywords?: Array<(string | {
                text: string;
                matchType?: 'exact' | 'phrase' | 'broad';
            })>;
            ageMin?: number;
            ageMax?: number;
            countries?: Array<(string)>;
            /**
             * Interest objects from /v1/ads/interests. Each must include id and name.
             */
            interests?: Array<{
                id: string;
                name: string;
            }>;
            /**
             * Meta only. Omit to preserve the existing setting on update. 0 = disabled, 1 = enabled.
             */
            advantage_audience?: 0 | 1;
        };
        /**
         * Replace the ad's creative. Meta + TikTok only.
         *
         * - **Meta**: requires `headline`, `body`, `callToAction`, `linkUrl`, `imageUrl`. The
         * ad's existing creative is replaced via a new `/act_X/adcreatives` upload + ad
         * update. The old creative is retained on the ad account for historical reporting.
         * - **TikTok**: patch-style. Pass any subset; `headline` is ignored (TikTok creatives
         * have no headline slot). `body` becomes the in-feed `ad_text`; `linkUrl` becomes
         * `landing_page_url`; `videoUrl` triggers a fresh upload.
         *
         */
        creative?: {
            /**
             * Meta only
             */
            headline?: string;
            body?: string;
            callToAction?: string;
            linkUrl?: string;
            imageUrl?: string;
            videoUrl?: string;
        };
        /**
         * Rename the ad. Now propagated to Meta (POST /{ad-id}); non-Meta platforms return 501.
         */
        name?: string;
    };
    path: {
        adId: string;
    };
};
type UpdateAdResponse = ({
    ad?: Ad;
    message?: string;
});
type UpdateAdError = (unknown | {
    error?: string;
});
type DeleteAdData = {
    path: {
        adId: string;
    };
};
type DeleteAdResponse = ({
    message?: string;
});
type DeleteAdError = ({
    error?: string;
});
type UpdateAdStatusData = {
    body: {
        status: 'active' | 'paused';
    };
    path: {
        /**
         * Zernio `_id` (hex), Meta `platformAdId` (numeric), or one of the creative's effective story/media IDs.
         */
        adId: string;
    };
};
type UpdateAdStatusResponse = ({
    /**
     * 1 when the status changed, 0 when skipped
     */
    updated?: number;
    /**
     * 1 when skipped (terminal status or already in target state), else 0
     */
    skipped?: number;
    /**
     * Human-readable summary (present only when skipped)
     */
    message?: string;
});
type UpdateAdStatusError = (unknown | {
    error?: string;
});
type GetCampaignAnalyticsData = {
    path: {
        /**
         * Platform campaign id (platformCampaignId).
         */
        campaignId: string;
    };
    query?: {
        /**
         * Comma-separated breakdown dimensions.
         *
         * **Meta**: age, gender, country, publisher_platform, device_platform, region,
         * platform_position, impression_device, video_asset, image_asset, body_asset, title_asset.
         *
         * **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
         * company, company_size, country, region. Rows carry the raw pivot `value`
         * plus a resolved `name`. LinkedIn serves these aggregated over the whole
         * range, delays the data 12-24h, and omits segments with fewer than 3 events.
         *
         */
        breakdowns?: string;
        /**
         * Start of date range (YYYY-MM-DD). Defaults to 90 days ago.
         */
        fromDate?: string;
        /**
         * Disambiguate when the campaign id exists across platforms (e.g. facebook, instagram).
         */
        platform?: string;
        /**
         * End of date range (YYYY-MM-DD). Defaults to today. Max 730-day range.
         */
        toDate?: string;
    };
};
type GetCampaignAnalyticsResponse = (CampaignAnalyticsResponse | (CampaignAnalyticsResponse & {
    /**
     * Always true on this response. Part of the requested range is still being backfilled; retry until the request returns 200.
     */
    backfillPending: boolean;
}));
type GetCampaignAnalyticsError = (ErrorResponse | {
    error?: string;
} | unknown);
type GenerateAdPreviewsData = {
    body: {
        /**
         * Zernio SocialAccount id used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        /**
         * Meta ad_format values, one preview per format. Defaults to [DESKTOP_FEED_STANDARD].
         */
        formats?: Array<(string)>;
        /**
         * Preview an existing ad-account creative by id. Mutually exclusive with creativeSpec.
         */
        existingCreativeId?: string;
        /**
         * Raw Meta creative spec forwarded verbatim to /generatepreviews. Mutually exclusive with existingCreativeId.
         */
        creativeSpec?: {
            [key: string]: unknown;
        };
    };
};
type GenerateAdPreviewsResponse = ({
    previews?: Array<{
        format?: string;
        /**
         * Meta's <iframe> snippet; null when Meta returned no preview for the format.
         */
        html?: (string) | null;
    }>;
});
type GenerateAdPreviewsError = (unknown | {
    error?: string;
});
type GetAdPreviewsData = {
    path: {
        /**
         * Zernio ad id (24-char hex).
         */
        adId: string;
    };
    query?: {
        /**
         * Comma-separated Meta ad_format values (max 10), one preview per format. Defaults to DESKTOP_FEED_STANDARD.
         */
        formats?: string;
    };
};
type GetAdPreviewsResponse = ({
    adId?: string;
    previews?: Array<{
        format?: string;
        /**
         * Meta's <iframe> snippet; null when Meta returned no preview for the format.
         */
        html?: (string) | null;
    }>;
});
type GetAdPreviewsError = (unknown | {
    error?: string;
});
type GenerateKeywordIdeasData = {
    body: {
        /**
         * Zernio googleads SocialAccount id.
         */
        accountId: string;
        /**
         * Numeric Google Ads customer id (no dashes); only needed when the connection has several accounts.
         */
        customerId?: string;
        /**
         * Seed terms. Provide these, seedUrl, or both.
         */
        seedKeywords?: Array<(string)>;
        /**
         * Landing page to mine for ideas. Provide this, seedKeywords, or both.
         */
        seedUrl?: string;
        /**
         * ISO 3166-1 alpha-2 country codes. Omitted = worldwide.
         */
        countries?: Array<(string)>;
        /**
         * Google languageConstant id (1000 = English).
         */
        languageConstantId?: string;
        network?: 'GOOGLE_SEARCH' | 'GOOGLE_SEARCH_AND_PARTNERS';
        includeAdultKeywords?: boolean;
        pageSize?: number;
        /**
         * Cursor from paging.nextPageToken of the previous page.
         */
        pageToken?: string;
    };
};
type GenerateKeywordIdeasResponse = ({
    /**
     * The customer the request ran against.
     */
    customerId?: string;
    data?: Array<{
        [key: string]: unknown;
    }>;
    aggregateMetricResults?: {
        [key: string]: unknown;
    } | null;
    paging?: {
        /**
         * Cursor for the next page; null when exhausted.
         */
        nextPageToken?: (string) | null;
    };
});
type GenerateKeywordIdeasError = (unknown | {
    error?: string;
});
type GenerateKeywordHistoricalMetricsData = {
    body: {
        /**
         * Zernio googleads SocialAccount id.
         */
        accountId: string;
        /**
         * Numeric Google Ads customer id (no dashes); only needed when the connection has several accounts.
         */
        customerId?: string;
        keywords: Array<(string)>;
        /**
         * ISO 3166-1 alpha-2 country codes. Omitted = worldwide.
         */
        countries?: Array<(string)>;
        /**
         * Google languageConstant id (1000 = English).
         */
        languageConstantId?: string;
        network?: 'GOOGLE_SEARCH' | 'GOOGLE_SEARCH_AND_PARTNERS';
        includeAdultKeywords?: boolean;
        /**
         * Adds averageCpcMicros to each row's keywordMetrics.
         */
        includeAverageCpc?: boolean;
    };
};
type GenerateKeywordHistoricalMetricsResponse = ({
    /**
     * The customer the request ran against.
     */
    customerId?: string;
    data?: Array<{
        [key: string]: unknown;
    }>;
    aggregateMetricResults?: {
        [key: string]: unknown;
    } | null;
});
type GenerateKeywordHistoricalMetricsError = (unknown | {
    error?: string;
});
type QueryAdInsightsData = {
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant); its platform selects the Meta or Google contract.
         */
        accountId: string;
        /**
         * Comma-separated Meta attribution windows. Action values are returned keyed per window.
         */
        actionAttributionWindows?: string;
        /**
         * Comma-separated Graph action breakdowns. Segments the actions[] arrays in each row.
         */
        actionBreakdowns?: string;
        /**
         * When actions are counted: impression, conversion or mixed.
         */
        actionReportTime?: string;
        /**
         * Cursor from paging.after of the previous page.
         */
        after?: string;
        /**
         * Comma-separated Graph breakdowns (e.g. age,gender or publisher_platform).
         */
        breakdowns?: string;
        /**
         * Google only: numeric customer id (no dashes) when the connection has several Google Ads accounts.
         */
        customerId?: string;
        /**
         * Meta date_preset (e.g. last_7d, last_30d, this_month). Mutually exclusive with fromDate/toDate.
         */
        datePreset?: string;
        /**
         * Comma-separated Graph insights fields (e.g. spend,impressions,frequency,website_purchase_roas). Omitted = Meta's default set.
         */
        fields?: string;
        /**
         * JSON array of Meta filter objects: [{"field", "operator", "value"}]. Applied server-side by Meta.
         */
        filtering?: string;
        /**
         * Start of range (YYYY-MM-DD); requires toDate.
         */
        fromDate?: string;
        /**
         * Row granularity
         */
        level?: 'ad' | 'adset' | 'campaign' | 'account';
        /**
         * Rows per page
         */
        limit?: number;
        /**
         * Meta only (required there): insights node — act_<n>, campaign id, ad set id or ad id.
         */
        objectId?: string;
        /**
         * Google only: cursor from paging.nextPageToken of the previous page.
         */
        pageToken?: string;
        /**
         * Google only (required there): the GAQL SELECT statement to run.
         */
        query?: string;
        /**
         * Days per row (1-90), monthly, or all_days.
         */
        timeIncrement?: string;
        /**
         * End of range (YYYY-MM-DD); requires fromDate.
         */
        toDate?: string;
        /**
         * Use the ad sets' own attribution settings for action counting.
         */
        useUnifiedAttributionSetting?: boolean;
    };
};
type QueryAdInsightsResponse = ({
    /**
     * Meta responses only.
     */
    objectId?: string;
    /**
     * Google responses only: the customer the query ran against.
     */
    customerId?: string;
    /**
     * Google responses only: the selected fields echoed by Google.
     */
    fieldMask?: (string) | null;
    data?: Array<{
        [key: string]: unknown;
    }>;
    paging?: {
        /**
         * Meta cursor for the next page; null when exhausted.
         */
        after?: (string) | null;
        /**
         * Google cursor for the next page; null when exhausted.
         */
        nextPageToken?: (string) | null;
    };
});
type QueryAdInsightsError = (unknown | {
    error?: string;
});
type CreateAdInsightsReportData = {
    body: {
        /**
         * Zernio SocialAccount id (posting or ads variant).
         */
        accountId: string;
        /**
         * Meta insights node: act_<n>, campaign id, ad set id or ad id.
         */
        objectId: string;
        level?: 'ad' | 'adset' | 'campaign' | 'account';
        /**
         * Comma-separated Graph insights fields.
         */
        fields?: string;
        /**
         * Comma-separated Graph breakdowns.
         */
        breakdowns?: string;
        /**
         * Comma-separated Graph action breakdowns (e.g. action_type,action_destination).
         */
        actionBreakdowns?: string;
        /**
         * Meta attribution windows (e.g. ["7d_click", "1d_view"]). Action values are returned keyed per window.
         */
        actionAttributionWindows?: Array<(string)>;
        /**
         * When actions are counted: impression, conversion or mixed.
         */
        actionReportTime?: string;
        /**
         * Use the ad sets' own attribution settings for action counting.
         */
        useUnifiedAttributionSetting?: boolean;
        /**
         * Meta filter objects, applied server-side.
         */
        filtering?: Array<{
            field: string;
            operator: string;
            value?: unknown;
        }>;
        /**
         * Mutually exclusive with fromDate/toDate.
         */
        datePreset?: string;
        fromDate?: string;
        toDate?: string;
        timeIncrement?: (number | 'monthly' | 'all_days');
    };
};
type CreateAdInsightsReportResponse = ({
    reportRunId?: string;
    status?: string;
});
type CreateAdInsightsReportError = (unknown | {
    error?: string;
});
type GetAdInsightsReportData = {
    path: {
        reportRunId: string;
    };
    query: {
        /**
         * Zernio SocialAccount id used to resolve the Meta token (must be the same connection that created the run).
         */
        accountId: string;
        after?: string;
        limit?: number;
    };
};
type GetAdInsightsReportResponse = ({
    reportRunId?: string;
    /**
     * Meta async_status: Job Not Started, Job Started, Job Running, Job Completed, Job Failed, Job Skipped.
     */
    status?: string;
    percentCompletion?: number;
    dateStart?: string;
    dateStop?: string;
    /**
     * Present only when status is Job Completed.
     */
    data?: Array<{
        [key: string]: unknown;
    }>;
    paging?: {
        after?: (string) | null;
    };
});
type GetAdInsightsReportError = (unknown | {
    error?: string;
});
type GetAdAnalyticsData = {
    path: {
        adId: string;
    };
    query?: {
        /**
         * Comma-separated breakdown dimensions.
         *
         * **Meta**: age, gender, country, publisher_platform, device_platform, region.
         *
         * **TikTok**: gender, age, country_code, platform, ac, language.
         *
         * **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
         * company, company_size, country, region. Rows carry the raw pivot `value`
         * plus a resolved `name`. LinkedIn serves these aggregated over the whole
         * range, delays the data 12-24h, and omits segments with fewer than 3 events.
         *
         */
        breakdowns?: string;
        /**
         * Start of date range (YYYY-MM-DD). Defaults to 90 days ago.
         */
        fromDate?: string;
        /**
         * End of date range (YYYY-MM-DD). Defaults to today. Max 730-day range.
         */
        toDate?: string;
    };
};
type GetAdAnalyticsResponse = (AdAnalyticsResponse | (AdAnalyticsResponse & {
    /**
     * Always true on this response. Part of the requested range is still being backfilled; retry until the request returns 200.
     */
    backfillPending: boolean;
}));
type GetAdAnalyticsError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetAdTrackingTagsData = {
    path: {
        /**
         * Ad id (hex _id, platformAdId, or effective story/media id).
         */
        adId: string;
    };
};
type GetAdTrackingTagsResponse = ({
    platform?: string;
    level?: 'creative' | 'campaign';
    /**
     * Meta: &-joined click-URL params.
     */
    urlTags?: (string) | null;
    /**
     * Meta: third-party click-tracking template (Dynamic Ads).
     */
    templateUrlSpec?: {
        [key: string]: unknown;
    } | null;
    /**
     * Google.
     */
    trackingUrlTemplate?: (string) | null;
    /**
     * Google.
     */
    finalUrlSuffix?: (string) | null;
    /**
     * LinkedIn.
     */
    dynamicValueParameters?: {
        [key: string]: unknown;
    } | null;
    /**
     * LinkedIn.
     */
    customValueParameters?: {
        [key: string]: unknown;
    } | null;
});
type GetAdTrackingTagsError = ({
    error?: string;
} | unknown);
type UpdateAdTrackingTagsData = {
    body: {
        /**
         * Meta only. Click-URL params appended to a freshly-rebuilt creative. Meta dynamic macros ({{ad.id}}, {{campaign.id}}, {{placement}}, ...) are sent through unescaped so Meta expands them; every other character is percent-encoded.
         */
        urlTags?: Array<{
            key: string;
            value: string;
        }>;
        /**
         * Meta only. OPTIONAL — omit to preserve the existing creative verbatim (default). Provide it only to rebuild the creative explicitly, or for creatives whose object_story_spec Meta strips.
         */
        creative?: {
            headline: string;
            body: string;
            callToAction: string;
            linkUrl: string;
            imageUrl: string;
            videoUrl?: string;
        };
        /**
         * Google only. Full tracking template (must contain {lpurl}).
         */
        trackingUrlTemplate?: string;
        /**
         * Google only. Parse-only key=value params.
         */
        finalUrlSuffix?: string;
        /**
         * LinkedIn only. key -> dynamic value enum (CAMPAIGN_ID, CAMPAIGN_NAME, CREATIVE_ID, ...).
         */
        dynamicValueParameters?: {
            [key: string]: (string);
        };
        /**
         * LinkedIn only. key -> static value.
         */
        customValueParameters?: {
            [key: string]: (string);
        };
    };
    path: {
        adId: string;
    };
};
type UpdateAdTrackingTagsResponse = (unknown);
type UpdateAdTrackingTagsError = ({
    error?: string;
} | unknown);
type GetAdCommentsData = {
    path: {
        /**
         * Internal Zernio ad ID (ObjectId).
         */
        adId: string;
    };
    query?: {
        /**
         * Pagination cursor from a previous response.
         */
        cursor?: string;
        limit?: number;
        /**
         * Which side of the ad to return comments for. Omit to default to the Instagram side when present, else Facebook. Returns ad_not_commentable if the ad has no such placement.
         */
        placement?: 'facebook' | 'instagram';
    };
};
type GetAdCommentsResponse = ({
    status: 'success';
    comments: Array<{
        [key: string]: unknown;
    }>;
    pagination: {
        hasMore?: boolean;
        cursor?: string;
    };
    meta: {
        /**
         * Which side these comments are on (same as `placement`).
         */
        platform: 'facebook' | 'instagram';
        /**
         * The placement these comments are for — useful when you didn't pass ?placement= and want to know which one you got.
         */
        placement: 'facebook' | 'instagram';
        /**
         * Internal Zernio ad ID.
         */
        adId: string;
        /**
         * Meta ad ID.
         */
        platformAdId: string;
        /**
         * Underlying post ID the comments belong to. effective_object_story_id for the Facebook side, effective_instagram_media_id for the Instagram side.
         */
        effectiveStoryId: string;
        /**
         * Facebook-only. The connected Facebook Page SocialAccount these comments were read through — pass it as `accountId` (with `effectiveStoryId` as the postId) to /v1/inbox/comments to reply/hide/delete. Null when no connected Page was used (then moderation isn't possible).
         */
        facebookAccountId?: (string) | null;
        /**
         * Instagram-only. The Instagram-scoped business ID that owns the boosted media (creative.instagram_user_id).
         */
        instagramUserId?: string;
        /**
         * Instagram-only. Public permalink of the boosted IG post (creative.instagram_permalink_url).
         */
        instagramPermalink?: string;
        /**
         * Instagram-only. The connected Instagram SocialAccount these comments were read through — pass it as `accountId` (with `effectiveStoryId` as the postId) to /v1/inbox/comments to reply/hide/delete.
         */
        instagramAccountId?: string;
        /**
         * Social account ID (ads SocialAccount).
         */
        accountId: string;
        lastUpdated: string;
    };
});
type GetAdCommentsError = (unknown | {
    error?: string;
});
type ListAdsBusinessCentersData = {
    query: {
        /**
         * ID of the `tiktokads` (or parent `tiktok` posting) SocialAccount
         */
        accountId: string;
    };
};
type ListAdsBusinessCentersResponse = ({
    businessCenters?: Array<BusinessCenter>;
});
type ListAdsBusinessCentersError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetAdsActivityLogData = {
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        /**
         * Cursor from paging.after of the previous page.
         */
        after?: string;
        /**
         * Rows per page
         */
        limit?: number;
        /**
         * Client-side filter to one Meta object id (campaign, ad set or ad).
         */
        objectId?: string;
        /**
         * Start of range (YYYY-MM-DD).
         */
        since?: string;
        /**
         * End of range (YYYY-MM-DD).
         */
        until?: string;
    };
};
type GetAdsActivityLogResponse = ({
    adAccountId?: string;
    data?: Array<{
        [key: string]: unknown;
    }>;
    paging?: {
        /**
         * Cursor for the next page; null when exhausted.
         */
        after?: (string) | null;
    };
});
type GetAdsActivityLogError = (unknown | {
    error?: string;
});
type CreateRfPredictionData = {
    body: {
        /**
         * Zernio SocialAccount id (posting or ads variant).
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        /**
         * Whole currency units. Exactly one of budgetAmount / reach.
         */
        budgetAmount?: number;
        /**
         * Target unique reach. Exactly one of budgetAmount / reach.
         */
        reach?: number;
        /**
         * Campaign window start (must be in the future).
         */
        startDate: string;
        endDate: string;
        /**
         * Max impressions per person over the window.
         */
        frequencyCap?: number;
        /**
         * Canonical camelCase TargetingSpec (same shape as /v1/ads/create's `targeting`). Defaults to countries: [US].
         */
        targeting?: {
            [key: string]: unknown;
        };
        /**
         * Meta placements object (same shape as /v1/ads/create's `placements`).
         */
        placements?: {
            [key: string]: unknown;
        };
    };
};
type CreateRfPredictionResponse = ({
    adAccountId?: string;
    currency?: string;
    prediction?: RfPrediction;
});
type CreateRfPredictionError = (unknown | {
    error?: string;
});
type GetRfPredictionData = {
    path: {
        predictionId: string;
    };
    query: {
        accountId: string;
        adAccountId: string;
    };
};
type GetRfPredictionResponse = ({
    adAccountId?: string;
    currency?: string;
    prediction?: RfPrediction;
});
type GetRfPredictionError = (unknown | {
    error?: string;
});
type CancelRfReservationData = {
    path: {
        predictionId: string;
    };
    query: {
        accountId: string;
        adAccountId: string;
    };
};
type CancelRfReservationResponse = (unknown);
type CancelRfReservationError = (unknown | {
    error?: string;
});
type ReserveRfPredictionData = {
    body: {
        accountId: string;
        adAccountId: string;
    };
    path: {
        predictionId: string;
    };
};
type ReserveRfPredictionResponse = ({
    adAccountId?: string;
    prediction?: RfPrediction;
});
type ReserveRfPredictionError = (unknown | {
    error?: string;
});
type ListAdStudiesData = {
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        /**
         * Cursor from paging.after of the previous page.
         */
        after?: string;
        /**
         * Comma-separated Graph field override (supports nested {} projections).
         */
        fields?: string;
        /**
         * Rows per page
         */
        limit?: number;
    };
};
type ListAdStudiesResponse = ({
    adAccountId?: string;
    data?: Array<{
        [key: string]: unknown;
    }>;
    paging?: {
        /**
         * Cursor for the next page; null when exhausted.
         */
        after?: (string) | null;
    };
});
type ListAdStudiesError = (unknown | {
    error?: string;
});
type ListMetaBusinessesData = {
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Cursor from paging.after of the previous page.
         */
        after?: string;
        /**
         * Rows per page
         */
        limit?: number;
    };
};
type ListMetaBusinessesResponse = ({
    data?: Array<{
        [key: string]: unknown;
    }>;
    paging?: {
        /**
         * Cursor for the next page; null when exhausted.
         */
        after?: (string) | null;
    };
});
type ListMetaBusinessesError = (unknown | {
    error?: string;
});
type ListAdLabelsData = {
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        /**
         * Cursor from paging.after of the previous page.
         */
        after?: string;
        /**
         * Rows per page
         */
        limit?: number;
    };
};
type ListAdLabelsResponse = ({
    adAccountId?: string;
    data?: Array<{
        [key: string]: unknown;
    }>;
    paging?: {
        /**
         * Cursor for the next page; null when exhausted.
         */
        after?: (string) | null;
    };
});
type ListAdLabelsError = (unknown | {
    error?: string;
});
type ListHighDemandPeriodsData = {
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Platform ad set id. Exactly one of campaignId / adSetId.
         */
        adSetId?: string;
        /**
         * Cursor from paging.after of the previous page.
         */
        after?: string;
        /**
         * Platform campaign id. Exactly one of campaignId / adSetId.
         */
        campaignId?: string;
        /**
         * Rows per page
         */
        limit?: number;
    };
};
type ListHighDemandPeriodsResponse = ({
    /**
     * The campaign / ad set id the schedules belong to.
     */
    objectId?: string;
    data?: Array<{
        [key: string]: unknown;
    }>;
    paging?: {
        /**
         * Cursor for the next page; null when exhausted.
         */
        after?: (string) | null;
    };
});
type ListHighDemandPeriodsError = (unknown | {
    error?: string;
});
type CreateHighDemandPeriodData = {
    body: {
        /**
         * Zernio SocialAccount id used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Platform campaign id. Exactly one of campaignId / adSetId.
         */
        campaignId?: string;
        /**
         * Platform ad set id. Exactly one of campaignId / adSetId.
         */
        adSetId?: string;
        /**
         * With ABSOLUTE, a budget in the ad account's currency in WHOLE units (50 = $50.00). With MULTIPLIER, a factor of the existing budget (2 = double it) and NOT a currency amount.
         */
        budgetValue: number;
        budgetValueType: 'ABSOLUTE' | 'MULTIPLIER';
        /**
         * Unix seconds, on a 15-minute boundary (:00, :15, :30, :45).
         */
        timeStart: number;
        /**
         * Unix seconds, on a 15-minute boundary and after timeStart.
         */
        timeEnd: number;
        recurrenceType?: 'ONE_TIME' | 'WEEKLY' | 'MONTHLY';
        /**
         * Ad account currency, for the ABSOLUTE minor-unit conversion. Ignored for MULTIPLIER.
         */
        currency?: string;
    };
};
type CreateHighDemandPeriodResponse = ({
    /**
     * The campaign / ad set the schedule was attached to.
     */
    objectId?: string;
    /**
     * Meta budget schedule id.
     */
    id?: string;
});
type CreateHighDemandPeriodError = (unknown | {
    error?: string;
});
type ListAdCreativesData = {
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        /**
         * Cursor from paging.after of the previous page.
         */
        after?: string;
        /**
         * Comma-separated Graph field override (supports nested {} projections).
         */
        fields?: string;
        /**
         * Rows per page
         */
        limit?: number;
    };
};
type ListAdCreativesResponse = ({
    adAccountId?: string;
    data?: Array<{
        [key: string]: unknown;
    }>;
    paging?: {
        /**
         * Cursor for the next page; null when exhausted.
         */
        after?: (string) | null;
    };
});
type ListAdCreativesError = (unknown | {
    error?: string;
});
type CreateAdCreativeData = {
    body: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token and Page.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        headline: string;
        /**
         * Primary text
         */
        body: string;
        /**
         * Link description below the headline; omitted = Meta scrapes the destination's OG description.
         */
        description?: string;
        /**
         * CTA type (same whitelist as POST /v1/ads/create).
         */
        callToAction?: string;
        linkUrl: string;
        /**
         * Publicly reachable image; uploaded to the account's library server-side.
         */
        imageUrl?: string;
        /**
         * Existing library image hash (POST /v1/ads/images or GET /v1/ads/images).
         */
        imageHash?: string;
        carouselCards?: Array<{
            imageUrl: string;
            linkUrl: string;
            headline?: string;
            description?: string;
            callToAction?: string;
        }>;
        /**
         * Appended to every outbound URL (e.g. utm_source=fb).
         */
        urlTags?: string;
        /**
         * Advantage+ creative enhancements: partial map of Meta creative feature keys (snake_case) to enroll status, forwarded as degrees_of_freedom_spec.creative_features_spec. Unspecified features default to OPT_OUT.
         */
        creativeFeatures?: {
            [key: string]: ('OPT_IN' | 'OPT_OUT');
        };
        /**
         * Meta only. Multi-advertiser ads: whether Meta may show this ad alongside other advertisers' in one unit. Meta auto-enrols since Aug 2024, so send OPT_OUT to leave. It is a top-level creative field, NOT a `creativeFeatures` key — Meta rejects it there.
         */
        multiAdvertiser?: 'OPT_IN' | 'OPT_OUT';
    };
};
type CreateAdCreativeResponse = ({
    adAccountId?: string;
    /**
     * Platform creative id, reusable via existingCreativeId.
     */
    creativeId?: string;
});
type CreateAdCreativeError = (unknown | {
    error?: string;
});
type GetAdCreativeData = {
    path: {
        /**
         * Platform creative id
         */
        creativeId: string;
    };
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Comma-separated Graph field override (supports nested {} projections).
         */
        fields?: string;
    };
};
type GetAdCreativeResponse = ({
    /**
     * Raw Meta creative node
     */
    creative?: {
        [key: string]: unknown;
    };
});
type GetAdCreativeError = (unknown | {
    error?: string;
});
type UpdateAdCreativeData = {
    body: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        name: string;
    };
    path: {
        /**
         * Platform creative id
         */
        creativeId: string;
    };
};
type UpdateAdCreativeResponse = ({
    creativeId?: string;
    name?: string;
    message?: string;
});
type UpdateAdCreativeError = (unknown | {
    error?: string;
});
type DeleteAdCreativeData = {
    path: {
        /**
         * Platform creative id
         */
        creativeId: string;
    };
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
    };
};
type DeleteAdCreativeResponse = ({
    creativeId?: string;
    message?: string;
});
type DeleteAdCreativeError = (unknown | {
    error?: string;
});
type ListValueRuleSetsData = {
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        /**
         * Cursor from paging.after of the previous page. Meta does not document paging on this edge; `after` comes back null when it omits cursors.
         */
        after?: string;
        /**
         * Rows per page
         */
        limit?: number;
    };
};
type ListValueRuleSetsResponse = ({
    adAccountId?: string;
    data?: Array<ValueRuleSet>;
    paging?: {
        /**
         * Cursor for the next page; null when exhausted or when Meta omits paging.
         */
        after?: (string) | null;
    };
});
type ListValueRuleSetsError = (unknown | {
    error?: string;
});
type CreateValueRuleSetData = {
    body: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        name: string;
        /**
         * Evaluated in order; the first matching rule wins.
         */
        rules: Array<ValueRule>;
    };
};
type CreateValueRuleSetResponse = ({
    adAccountId?: string;
    /**
     * The new rule set id. Meta does not document the create response body, so this is null on the (unobserved) case where it omits the id.
     */
    valueRuleSetId?: (string) | null;
});
type CreateValueRuleSetError = (unknown | {
    error?: string;
});
type GetValueRuleSetData = {
    path: {
        /**
         * Platform value rule set id.
         */
        valueRuleSetId: string;
    };
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
    };
};
type GetValueRuleSetResponse = ({
    valueRuleSet?: ValueRuleSet;
});
type GetValueRuleSetError = (unknown | {
    error?: string;
});
type UpdateValueRuleSetData = {
    body: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Required: the update replaces the whole set.
         */
        name: string;
        /**
         * The COMPLETE rule list. Omitting a rule deletes it on Meta.
         */
        rules: Array<ValueRule>;
    };
    path: {
        /**
         * Platform value rule set id.
         */
        valueRuleSetId: string;
    };
};
type UpdateValueRuleSetResponse = ({
    valueRuleSetId?: string;
    name?: string;
    rules?: Array<ValueRule>;
    message?: string;
});
type UpdateValueRuleSetError = (unknown | {
    error?: string;
});
type DeleteValueRuleSetData = {
    path: {
        /**
         * Platform value rule set id.
         */
        valueRuleSetId: string;
    };
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
    };
};
type DeleteValueRuleSetResponse = ({
    valueRuleSetId?: string;
    message?: string;
});
type DeleteValueRuleSetError = (unknown | {
    error?: string;
});
type GetAdAccountFinanceData = {
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
    };
};
type GetAdAccountFinanceResponse = ({
    adAccountId?: string;
    /**
     * ISO 4217 code all money values are expressed in.
     */
    currency?: string;
    /**
     * Outstanding/prepaid balance in whole currency units.
     */
    balance?: number;
    /**
     * Lifetime amount spent in whole currency units.
     */
    amountSpent?: number;
    /**
     * Account spend cap; null when none is set.
     */
    spendCap?: (number) | null;
    fundingSource?: {
        /**
         * Human-readable payment method, e.g. 'Mastercard *4985'.
         */
        displayString?: string;
        /**
         * Meta funding source type code.
         */
        type?: number;
    } | null;
});
type GetAdAccountFinanceError = (unknown | {
    error?: string;
});
type ListAdAccountsData = {
    query: {
        /**
         * Social account ID
         */
        accountId: string;
        /**
         * Filter response to a single platform ad account ID (e.g. `act_123` for Meta, advertiser_id for TikTok). Returns at most one item.
         */
        adAccountId?: string;
        /**
         * Clamp the returned `accounts[]` length. Useful for typeahead pickers on agency tokens with hundreds of advertisers.
         */
        limit?: number;
    };
};
type ListAdAccountsResponse = ({
    accounts?: Array<{
        /**
         * Platform ad account ID (e.g. act_123)
         */
        id?: string;
        name?: string;
        currency?: string;
        /**
         * LinkedIn only. LinkedIn's own ad account status. In practice always `ACTIVE`, because the LinkedIn query filters to active accounts. Meta, Google, TikTok and Pinterest report `accountStatus` instead; X reports `approvalStatus`.
         */
        status?: string;
        /**
         * The platform's own account status, forwarded unchanged. No JSON type is
         * declared because the type differs per platform: Meta sends an integer,
         * Google, TikTok and Pinterest send a string. Absent on LinkedIn (reports
         * `status`) and on X (reports `approvalStatus`).
         *
         * If all you need is whether the account can run ads right now, read
         * `selectable` and skip this field. Read this one when you need to tell
         * the states apart, because they call for different responses:
         *
         * - `1` ACTIVE. Running normally.
         * - `2` DISABLED. Disabled by Meta. Read `disableReason` to tell a policy
         * action apart from a billing one; they need very different follow-ups.
         * - `3` UNSETTLED. There is an unpaid balance, but the account still runs
         * ads. Not a ban.
         * - `7` PENDING_RISK_REVIEW. Meta is reviewing the account. Wait for the
         * outcome.
         * - `8` PENDING_SETTLEMENT. Meta blocks new ads until an outstanding
         * balance clears. Settle it and the account runs again.
         * - `9` IN_GRACE_PERIOD. Still running, on a deadline.
         * - `100` PENDING_CLOSURE. Scheduled to close.
         * - `101` CLOSED. Terminal.
         *
         */
        accountStatus?: unknown;
        /**
         * X only. X's own ad account approval status. Observed values are `ACCEPTED`, `PENDING` and `REJECTED`, but X does not publish the full vocabulary, so treat an unrecognised value as not usable. Other platforms report `accountStatus` or `status` instead.
         */
        approvalStatus?: string;
        /**
         * Meta only. Meta's `disable_reason` code, forwarded unchanged. Present when `accountStatus` is `2` (DISABLED) and Meta gives a reason, which is what separates a policy action from a payment problem. Meta does not publish a stable list of values for this field, so none are enumerated here: resolve the code against Meta's own ad account reference. Absent when Meta reports no reason, or when the connected token cannot read the field.
         */
        disableReason?: number;
        /**
         * IANA timezone of the ad account (Meta only). Drives daily-budget reset and Insights day boundaries.
         */
        timezoneName?: string;
        /**
         * Signed UTC offset in hours, reflecting current DST (Meta only).
         */
        timezoneOffsetHoursUtc?: number;
        /**
         * Meta only. Minimum daily budget for the account, in the account currency's major units. This is the impressions-billed minimum; other billing events have higher minimums. Absent when the connected token cannot read it.
         */
        minimumDailyBudget?: number;
        /**
         * Meta and X only. Whether the account can create/run ads now. Absent (treat as true) on other platforms.
         */
        selectable?: boolean;
        /**
         * Meta and X only. Human-readable reason when selectable is false; null when selectable.
         */
        unusableReason?: (string) | null;
    }>;
});
type ListAdAccountsError = ({
    error?: string;
} | unknown | ErrorResponse);
type UpdateAdAccountData = {
    body: {
        /**
         * Social account ID (metaads, or a facebook/instagram posting account)
         */
        accountId: string;
        /**
         * Meta ad account ID (act_...)
         */
        adAccountId: string;
        /**
         * Legal entity benefiting from ads on this ad account
         */
        defaultDsaBeneficiary: string;
        /**
         * Legal entity paying for ads on this ad account. Defaults to defaultDsaBeneficiary when omitted.
         */
        defaultDsaPayor?: string;
    };
};
type UpdateAdAccountResponse = ({
    adAccountId?: string;
    dsaDefaults?: {
        beneficiary?: string;
        payor?: string;
    };
});
type UpdateAdAccountError = (unknown | {
    error?: string;
});
type GetDsaDefaultsData = {
    query: {
        /**
         * Social account ID (metaads, or a facebook/instagram posting account)
         */
        accountId: string;
        /**
         * Meta ad account ID (act_...)
         */
        adAccountId: string;
    };
};
type GetDsaDefaultsResponse = ({
    adAccountId?: string;
    dsaDefaults?: {
        beneficiary?: string;
        payor?: string;
    };
});
type GetDsaDefaultsError = (unknown | {
    error?: string;
});
type GetDsaRecommendationsData = {
    query: {
        /**
         * Social account ID (metaads, or a facebook/instagram posting account)
         */
        accountId: string;
        /**
         * Meta ad account ID (act_...)
         */
        adAccountId: string;
    };
};
type GetDsaRecommendationsResponse = ({
    adAccountId?: string;
    recommendations?: Array<(string)>;
});
type GetDsaRecommendationsError = (unknown | {
    error?: string;
});
type BoostPostData = {
    body: {
        /**
         * Zernio post ID (provide this or platformPostId)
         */
        postId?: string;
        /**
         * Platform post ID (alternative to postId)
         */
        platformPostId?: string;
        /**
         * Social account ID
         */
        accountId: string;
        /**
         * Platform ad account ID
         */
        adAccountId: string;
        name: string;
        /**
         * Available goals vary by platform. Meta (Facebook/Instagram) and TikTok support all 7. LinkedIn supports all except app_promotion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
         */
        goal: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'conversions' | 'app_promotion';
        /**
         * Meta only. Attach the boosted post to this existing ad set instead of creating a campaign. The ad set then owns budget, schedule and targeting; sending those too is a 400.
         */
        adSetId?: string;
        /**
         * Required unless adSetId is set.
         */
        budget?: {
            /**
             * Minimum varies: TikTok=$20, Pinterest=$5, others=$1
             */
            amount: number;
            type: 'daily' | 'lifetime';
        };
        /**
         * Meta only. Instagram identity the ad runs AS (creative.instagram_user_id), overriding the account linked to the Page. Live-verified against a Page-post creative.
         */
        instagramAccountId?: string;
        /**
         * Meta only. Ad-set destination_type — where the click LANDS, as opposed to instagramAccountId which is who the ad runs as. Lead ads force ON_AD and ignore this.
         */
        destinationType?: 'INSTAGRAM_PROFILE' | 'WEBSITE' | 'ON_AD' | 'MESSENGER' | 'WHATSAPP';
        /**
         * ISO 4217 currency code matching the ad account's currency. Meta only. Optional: Zernio resolves it from the ad account when omitted. The value selects the minor-unit exponent Zernio converts budget/bid amounts by before calling Meta (most currencies are cents; zero-decimal currencies like JPY/KRW are sent as-is).
         */
        currency?: string;
        schedule?: {
            startDate?: string;
            /**
             * Required for lifetime budgets
             */
            endDate?: string;
        };
        /**
         * Same geo/demographic fields as the `TargetingSpec` used by /v1/ads/create.
         * Geo keys (`regions`/`cities`/`zips`/`metros`) resolve via
         * GET /v1/ads/targeting/search?dimension=geo. City radius and lat/lng
         * `customLocations` are Meta-only and preserve the boosted post's
         * social proof (the ad references the existing post).
         *
         */
        targeting?: {
            ageMin?: number;
            ageMax?: number;
            /**
             * Applied on Meta, TikTok and Pinterest. Ignored on Google, LinkedIn and X.
             */
            gender?: 'all' | 'male' | 'female';
            /**
             * Meta locale ids (numeric), passed through as given.
             */
            languages?: Array<(string)>;
            /**
             * ISO country codes. Required for TikTok boosts (TikTok's ad group requires location_ids); optional on other platforms.
             */
            countries?: Array<(string)>;
            /**
             * Region/state targeting. `key` from /v1/ads/targeting/search?dimension=geo&geoType=region.
             */
            regions?: Array<{
                key: string;
                name?: string;
            }>;
            /**
             * City targeting. Optional `radius` + `distanceUnit` extend beyond the city limits (both set together, Meta only).
             */
            cities?: Array<{
                key: string;
                name?: string;
                /**
                 * Requires distanceUnit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng).
                 */
                radius?: number;
                distanceUnit?: 'mile' | 'kilometer';
            }>;
            /**
             * Postal/ZIP targeting. `key` is the platform's postal location ID (e.g. Meta `US:94304`).
             */
            zips?: Array<{
                key: string;
                name?: string;
            }>;
            /**
             * DMA / metro-area targeting. `key` is the platform's metro ID (e.g. Meta `DMA:807`).
             */
            metros?: Array<{
                key: string;
                name?: string;
            }>;
            /**
             * Point-radius (lat/lng) targeting (Meta custom_locations). No geo `key` lookup needed.
             */
            customLocations?: Array<{
                latitude: number;
                longitude: number;
                radius: number;
                distanceUnit: 'mile' | 'kilometer';
                name?: string;
                /**
                 * Optional label, sent to Meta as `address_string`.
                 */
                address?: string;
            }>;
            /**
             * Interest objects from /v1/ads/interests. Each must include id and name.
             */
            interests?: Array<{
                id: string;
                name: string;
            }>;
            /**
             * Meta only. 0 = disabled (default), 1 = enabled.
             */
            advantage_audience?: 0 | 1;
        };
        /**
         * Meta only. A Meta-native targeting spec (e.g.
         * `{ "geo_locations": { "cities": [{ "key": "...", "radius": 15, "distance_unit": "kilometer" }] } }`).
         * Sent alone it is forwarded unchanged. Use for advanced fields the structured
         * object does not expose (flexible_spec, excluded audiences, business places,
         * user_os, wireless_carrier).
         *
         * Can be combined with `targeting`: rawTargeting is the BASE layer and the
         * built camelCase spec is merged on top, key by key (camelCase wins on
         * collision). The merge goes one level deep inside `geo_locations` and
         * `excluded_geo_locations` (built sub-keys win; raw-only sub-keys such as
         * `location_types` survive). Array values (`flexible_spec`, ...) are replaced
         * as a whole key, never element-merged.
         *
         * When `rawTargeting` is present the `advantage_audience: 0` default that
         * Zernio normally applies is no longer emitted, so it cannot clobber a
         * `targeting_automation` sent in the raw spec. Meta requires
         * `targeting_automation` on ad set creation, so include it in the raw spec,
         * or send `targeting.advantage_audience` (0 or 1), which is merged over raw
         * as `targeting_automation`.
         *
         */
        rawTargeting?: {
            [key: string]: unknown;
        };
        /**
         * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
         *
         * Meta bid strategy applied to the ad set. On TikTok, mapped to
         * `bid_type` / `bid_price` / `deep_bid_type` automatically.
         *
         * @deprecated
         */
        bidStrategy?: (BidStrategy);
        /**
         * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
         *
         * Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
         * `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`. Backward-compat: providing
         * `bidAmount` without `bidStrategy` is treated as `LOWEST_COST_WITH_BID_CAP`.
         *
         * @deprecated
         */
        bidAmount?: number;
        /**
         * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
         *
         * Minimum ROAS as a decimal multiplier (e.g. 2.0 = 2.0x ROAS). Required when
         * `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sent to Meta as
         * `bid_constraints.roas_average_floor` × 10000 (Meta uses fixed-point integers).
         *
         * @deprecated
         */
        roasAverageFloor?: number;
        /**
         * Platform-specific options. The platform is derived from `accountId`;
         * sending options for a different platform returns a 400. LinkedIn
         * (campaign bidding and delivery controls) and Meta (the bid trio)
         * have options today.
         *
         * **Meta**: `bidStrategy`, `bidAmount` and `roasAverageFloor` may be
         * sent here instead of at the root — the preferred home going forward.
         * Sending the bid fields in BOTH places returns a 400
         * (`mutually_exclusive_fields`).
         *
         */
        platformSpecificData?: (LinkedInAdsPlatformData | MetaAdsPlatformData);
        /**
         * Meta only. Tracking specs (pixel, URL tags).
         */
        tracking?: {
            pixelId?: string;
            /**
             * URL parameters appended to the ad link, rendered as `key=value` pairs joined with `&`. Meta dynamic macros ({{ad.id}}, {{campaign.id}}, {{placement}}, ...) are sent through unescaped so Meta expands them; every other character is percent-encoded.
             */
            urlTags?: Array<{
                key?: string;
                value?: string;
            }>;
        };
        /**
         * Meta only. Required for housing, employment, credit, or political ads.
         */
        specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
        /**
         * Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires specialAdCategories to be set (400 otherwise).
         */
        specialAdCategoryCountry?: Array<(string)>;
        /**
         * Destination URL for the CTA button. Send it together with `callToAction`.
         *
         * **Meta**: adds a top-level `call_to_action` to the post-reference creative.
         * This is what gives a `traffic` boost a clickable destination without
         * replacing the creative and losing the post's social proof. Ignored when
         * `leadGenFormId` is set, which supplies its own destination. Live-verified
         * against a Page-post creative.
         *
         * **TikTok**: maps to `landing_page_url` on the Spark Ad creative
         * (`AdcreateCreatives.landing_page_url`); Spark Ads have no clickable
         * destination without it.
         *
         * Ignored on LinkedIn / Pinterest / X / Google, which infer the destination
         * from the boosted post.
         *
         */
        linkUrl?: string;
        /**
         * CTA button label. Send it together with `linkUrl` — a CTA without a
         * destination produces a button that goes nowhere, so sending one alone is a 400.
         *
         * **Meta**: the CTA enum of POST /v1/ads/create plus
         * `VIEW_INSTAGRAM_PROFILE`, which is accepted on boost only. For that
         * value `linkUrl` is typically the Instagram profile URL.
         *
         * **TikTok**: pass-through to `call_to_action` on the Spark Ad creative; the
         * platform validates the value. See TikTok's "Enumeration - Call-to-Action".
         *
         */
        callToAction?: string;
        /**
         * TikTok-only. Spark Code (creator's `auth_code`) authorizing cross-creator
         * Spark Ads — the advertiser can boost a video owned by a DIFFERENT TikTok
         * account. Without this, boosts are limited to videos owned by the same
         * account running the ads (same-BC creators only). The creator generates the
         * code in their TikTok app's Promote settings and shares it with the
         * advertiser. Maps to `auth_code` on the creative entry of /v2/ad/create/.
         *
         */
        sparkAuthCode?: string;
        /**
         * Legal entity that benefits from the ad. Required when targeting EU users
         * (EU DSA, Article 26). Optional if the ad account has a default beneficiary:
         * set it once via `PATCH /v1/ads/accounts` or in Meta Ads Manager, and Meta
         * fills it in whenever the field is omitted.
         *
         */
        dsaBeneficiary?: string;
        /**
         * Legal entity that pays for the ad. Can differ from `dsaBeneficiary`
         * (for example, an agency paying for a client's ads). Same rules as
         * `dsaBeneficiary`: required for EU targeting unless the ad account has
         * a default payor.
         *
         */
        dsaPayor?: string;
        /**
         * Meta only. Explicit ad-set `optimization_goal` override. When omitted,
         * defaults to the value derived from `goal`. The value must be compatible
         * with the objective Meta derives from `goal`, not with the objective used
         * by `POST /v1/ads/create` for the same `goal` name: boost maps `goal:
         * "engagement"` to objective `OUTCOME_AWARENESS`, which accepts
         * `REACH`, `IMPRESSIONS`, `AD_RECALL_LIFT`, or THRUPLAY-class values, and
         * rejects `POST_ENGAGEMENT` (that value is only valid under
         * `OUTCOME_ENGAGEMENT`, which create uses for the same goal name).
         *
         */
        optimizationGoal?: string;
    };
    headers?: {
        /**
         * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
         */
        'Idempotency-Key'?: string;
    };
};
type BoostPostResponse = ({
    ad?: Ad;
    message?: string;
});
type BoostPostError = (unknown | {
    error?: string;
});
type CreateStandaloneAdData = {
    body: {
        accountId: string;
        adAccountId: string;
        name: string;
        /**
         * Meta only. Exact campaign name. Overrides the default `<name> - Campaign`.
         */
        campaignName?: string;
        /**
         * Meta only. Exact ad set name. Overrides the default `<name> - Ad Set`. (For per-ad names on the multi-creative shape, set `name` on each `creatives[]` entry.)
         */
        adSetName?: string;
        /**
         * Meta only. Exact ad name (the single-creative ad object's name). Overrides the default, which is `name`. (For per-ad names on the multi-creative shape, set `name` on each `creatives[]` entry instead.)
         */
        adName?: string;
        /**
         * Meta only. Attaches pixel measurement to the ad regardless of the optimization goal (the "Website events" tracking row in Ads Manager). `pixelId` becomes the ad's `tracking_specs` (offsite_conversion + fb_pixel); `urlTags` becomes the ad's `url_tags` (click-tracking query params). Applied on the legacy single-creative shape, every ad of the multi-creative shape, and the attach shape. NOTE: tracking lives on the AD object and is not inherited from the ad set, so pass it on EVERY attach call that should carry the pixel.
         */
        tracking?: {
            /**
             * Meta Pixel ID to attach for offsite-conversion measurement.
             */
            pixelId?: string;
            /**
             * Click-URL params appended to the ad's destination as `url_tags` (e.g. utm_source). Meta dynamic macros ({{ad.id}}, {{campaign.id}}, {{placement}}, ...) are sent through unescaped so Meta expands them; every other character is percent-encoded.
             */
            urlTags?: Array<{
                key: string;
                value: string;
            }>;
        };
        /**
         * Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
         *
         * **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.
         * - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT (or `promotedObject.customConversionId` to optimise against a Custom Conversion instead). Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
         * - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
         * - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
         * - `catalog_sales`: Advantage+ catalog ads, for example vehicle inventory. Requires `promotedObject.productSetId`, `promotedObject.pixelId` and `promotedObject.customEventType`. Builds a catalog TEMPLATE creative from the copy fields, which may carry template tags like {{product.name}} or {{vehicle.make}}. No imageUrl or video is sent; Meta renders the visuals per catalog item. Discover catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets. Single shape only, no creatives[], adSetId, dynamicCreative or placementAssets.
         *
         * **TikTok**
         * - `conversions`: website-conversion ad group. Requires `promotedObject.pixelId`, your TikTok Pixel ID. Accepts an optional `promotedObject.customEventType` with a TikTok optimization_event code your pixel tracks (newer pixels use e.g. SHOPPING for purchase events; legacy pixels use ON_WEB_ORDER, INITIATE_ORDER, ON_WEB_REGISTER or FORM). To inherit pixel and event from an existing ad group, pass `adSetId` instead.
         *
         * **LinkedIn**
         * - `engagement`, `traffic`, `awareness` and `video_views` create standalone Direct Sponsored Content ads. `traffic` requires `linkUrl`; `video_views` requires `video`.
         * - `job_applicants` requires a `platformSpecificData.jobs` creative.
         * - For `lead_generation` or `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.
         *
         * **OpenAI Ads**
         * - Only `traffic`, `awareness`, and `conversions` are supported (other goals return 400). Maps to OpenAI's `bidding_type` (clicks, impressions, conversions respectively). `conversions` requires an active conversion event setting on the account; create a tracking tag with `defaultEventType` via the tracking-tags API (`POST /v1/accounts/{accountId}/tracking-tags`), or configure a conversion event in OpenAI Ads Manager, or the request returns 422.
         *
         */
        goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
        /**
         * Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
         */
        optimizationGoal?: string;
        /**
         * Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
         */
        billingEvent?: string;
        /**
         * Meta only. RESERVED = Reach & Frequency: requires `rfPredictionId` (a RESERVED prediction from /v1/ads/rf-predictions + /reserve). Budget, schedule and pricing come from the reservation, so budgetAmount/budgetType are not required and bid fields are ignored. Only the plain single-ad shape (no creatives[], adSetId, existingCampaignId or dynamicCreative).
         */
        buyingType?: 'AUCTION' | 'RESERVED';
        /**
         * Meta only. The RESERVED prediction id the R&F ad set runs on (reserving mints a new id — pass that one). Requires buyingType RESERVED.
         */
        rfPredictionId?: string;
        /**
         * Meta only. Advantage+ creative enhancements: a partial map of Meta creative feature keys (snake_case, e.g. enhance_cta, image_brightness_and_contrast, text_optimizations) to enroll status, forwarded as degrees_of_freedom_spec.creative_features_spec. Meta validates the keys; unspecified features default to OPT_OUT. The legacy standard_enhancements bundle is deprecated by Meta and rejected.
         */
        creativeFeatures?: {
            [key: string]: ('OPT_IN' | 'OPT_OUT');
        };
        /**
         * Meta only. Multi-advertiser ads: whether Meta may show this ad alongside other advertisers' in one unit. Meta auto-enrols since Aug 2024, so send OPT_OUT to leave. It is a top-level creative field, NOT a `creativeFeatures` key — Meta rejects it there.
         */
        multiAdvertiser?: 'OPT_IN' | 'OPT_OUT';
        /**
         * Meta only, single standalone shape only (no creatives[], adSetId, or RESERVED). Dry-run: each node runs Meta's execution_options validate_only and NOTHING is created or persisted. Children need real parents, so a fresh tree validates the campaign + creative (the ad set needs its campaign to exist — pass existingCampaignId to validate it too; the ad itself is never validatable pre-create). A Meta validation failure returns the 400 verbatim; success returns 200 with per-node results instead of an ad.
         */
        validateOnly?: boolean;
        /**
         * Budget in WHOLE currency units (USD: 50 = $50.00), NOT cents — Meta's own Marketing API takes this same number in minor units, so it is an easy and expensive mix-up. Required on legacy + multi-creative shapes. Inherited on attach. OpenAI Ads requires a $1 minimum (its budget is lifetime-only, see budgetType).
         */
        budgetAmount?: number;
        /**
         * Required on legacy + multi-creative shapes. Inherited on attach. OpenAI Ads accepts lifetime only (no daily-budget concept on the platform); sending daily returns 422. OpenAI Ads lifetime budgets require `endDate` to give the lifetime cap a spend window.
         */
        budgetType?: 'daily' | 'lifetime';
        /**
         * Meta and TikTok. Publish state of the created entities. Omitted or ACTIVE publishes live (default, back-compat); PAUSED creates them paused so you can review before they spend. On Meta the pause is held on the campaign this call creates, leaving the ad set and ad switched on, so a single PUT /v1/ads/campaigns/{campaignId}/status with `active` brings the whole thing live. It is held at every level instead when the pause cannot rely on the campaign: `existingCampaignId` (that campaign may be running and is never touched) or `campaignStatus: ACTIVE`. On TikTok the whole campaign > ad group > ad hierarchy stays paused.
         */
        status?: 'ACTIVE' | 'PAUSED';
        /**
         * Meta only. Overrides `status` for the campaign level alone, so you can create a live campaign whose ad set and ad stay paused, or the reverse. Omitted, it follows `status`.
         */
        campaignStatus?: 'ACTIVE' | 'PAUSED';
        /**
         * Meta only. Where the budget lives, which selects the Meta budget model:
         * - `adset` (default): ABO (Ad-set Budget Optimization). The budget is set on the
         * ad set. This is the back-compatible behaviour — omit this field to keep it.
         * - `campaign`: CBO (Campaign Budget Optimization / Advantage Campaign Budget). The
         * budget AND `bidStrategy` are set on the CAMPAIGN, and Meta distributes spend
         * across ad sets automatically.
         * Meta requires the budget at exactly one level, never both. Non-Meta platforms ignore
         * this field. Ignored on the attach shape (`adSetId`), which inherits the existing budget.
         *
         */
        budgetLevel?: 'adset' | 'campaign';
        /**
         * ISO 4217 currency code matching the ad account's currency (e.g. `USD`). Meta only. Optional: Zernio resolves it from the ad account when omitted. The value selects the minor-unit exponent Zernio converts budget/bid amounts by before calling Meta (most currencies are cents; zero-decimal currencies like JPY/KRW are sent as-is).
         */
        currency?: string;
        /**
         * Required for Meta, Google, Pinterest, LinkedIn, and OpenAI Ads on legacy + attach shapes (skip for multi-creative — use `creatives[].headline`). Ignored for TikTok and X/Twitter. Max: Meta=255, Google=30, Pinterest=100, LinkedIn=400, OpenAI=50 (min 3). On LinkedIn this is the ad's headline (the bold text on the creative); for traffic ads it's the link card title. On OpenAI Ads this is the chat card's title.
         */
        headline?: string;
        /**
         * Google Display only — defaults to `headline` if omitted. On LinkedIn, reused as the optional secondary description text on traffic (link) ads; omitted if not provided.
         */
        longHeadline?: string;
        /**
         * Required on legacy + attach shapes. For X/Twitter this is the tweet text (max 280 chars including a ~24-char URL when `linkUrl` is set). On LinkedIn this is the post commentary (the intro text shown above the ad). On OpenAI Ads this is the chat card's body text. Max: Google=90, Pinterest=500, OpenAI=100.
         */
        body?: string;
        /**
         * Meta only (facebook/instagram). Link description — the secondary text shown below the headline (Meta's link_data.description; on video creatives mapped to video_data.link_description). When omitted, Meta auto-pulls the destination URL's OpenGraph description. Applies on legacy, attach, and placementAssets shapes; for multi-creative use creatives[].description (this field is the shared fallback). For multi-text variations use dynamicCreative.descriptions instead.
         */
        description?: string;
        /**
         * Required on legacy + attach shapes for Meta. Honoured on TikTok (passes through to the Spark Ad creative's `call_to_action`) and on LinkedIn (the CTA button on the ad; defaults to LEARN_MORE when `linkUrl` is set). LinkedIn accepts: LEARN_MORE, SIGN_UP, DOWNLOAD, SUBSCRIBE, REGISTER, JOIN, ATTEND, REQUEST_DEMO, VIEW_QUOTE, APPLY, SEE_MORE, SHOP_NOW, BUY_NOW. Ignored by Google, Pinterest, and X/Twitter.
         */
        callToAction?: 'LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | 'BOOK_TRAVEL' | 'CONTACT_US' | 'DOWNLOAD' | 'GET_OFFER' | 'GET_QUOTE' | 'SUBSCRIBE' | 'WATCH_MORE' | 'ADD_TO_CART' | 'APPLY_NOW' | 'BOOK_NOW' | 'BUY_TICKETS' | 'DONATE' | 'DONATE_NOW' | 'GET_DIRECTIONS' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'ORDER_NOW' | 'PLAY_GAME' | 'REQUEST_TIME' | 'SEE_MENU' | 'START_ORDER' | 'INSTALL_MOBILE_APP' | 'USE_APP' | 'REGISTER' | 'JOIN' | 'ATTEND' | 'REQUEST_DEMO' | 'VIEW_QUOTE' | 'APPLY' | 'SEE_MORE' | 'BUY_NOW';
        /**
         * Required on legacy + attach shapes (skip for multi-creative). On LinkedIn it's the ad's destination URL; required for `traffic` ads, optional for `engagement` / `awareness`. NOT required when `goal` is `lead_generation` (the ad opens a Lead Gen form instead of a destination). On LinkedIn, `imageUrl` + `linkUrl` publishes an ARTICLE-content creative; this is LinkedIn's article ad format, with the image as thumbnail and `longHeadline` as description. Required for OpenAI Ads (the chat card's target_url).
         */
        linkUrl?: string;
        /**
         * Meta Lead Gen forms only (facebook/instagram). The leadgen_forms ID to attach to the ad's creative — create one via POST /v1/ads/lead-forms. REQUIRED when `goal` is `lead_generation`, and on every ATTACH (`adSetId`) call that targets a lead ad set (the form attaches per-ad; Meta rejects a formless ad in a lead ad set). Ignored otherwise. The ad set's promoted_object.page_id + LEAD_GENERATION optimization + destination_type ON_AD are derived automatically from the goal. Both `placementAssets` (per-placement creative) and `dynamicCreative` (multi-text / multi-asset pool, e.g. multiple headlines and primary texts) ARE supported on instant-form lead ads — the form is attached for you, and for `dynamicCreative` the ad set is created as a Dynamic Creative ad set automatically (Meta requires that for any multi-text feed; there is no non-DCO multi-text path). Send a single `imageUrls` (or `videoUrls`) entry plus your text variations to get Meta's "Multiple Text Options" behavior on a lead ad.
         */
        leadGenFormId?: string;
        /**
         * Image creative for Meta/Google/Pinterest/LinkedIn on legacy + attach shapes (mutually exclusive with `video`). Required for LinkedIn ads unless `video` is set. Not required for Google Search campaigns. For TikTok, this field carries the VIDEO URL (the TikTok ads endpoint is video-only; the field retains the `imageUrl` name for cross-platform consistency). Ignored for X/Twitter. For Google Display, treated as the landscape image (alias of `images.landscape`); supply `images.square` alongside or the request is rejected. For LinkedIn the image is uploaded to LinkedIn under the authoring Company Page (see `organizationId`); recommended ratio 1.91:1 (e.g. 1200×627). Required for OpenAI Ads (uploaded as the chat card's image; OpenAI has no video ad format).
         */
        imageUrl?: string;
        /**
         * Google Display (Responsive Display Ads) only. Google RDA requires both a landscape (1.91:1) and a square (1:1) marketing image; sending only one is rejected upstream as 'Too few.' (NOT_ENOUGH_*_MARKETING_IMAGE_ASSET). Supply both URLs here. Either this field or the legacy `imageUrl` can provide the landscape, but `square` has no legacy counterpart so it must be set here for Display.
         */
        images?: {
            /**
             * Landscape 1.91:1 marketing image URL (e.g. 1200x628). Also accepted via the top-level `imageUrl` for backward compatibility.
             */
            landscape?: string;
            /**
             * Square 1:1 marketing image URL (e.g. 1080x1080). Required for Google Display.
             */
            square?: string;
        };
        /**
         * Meta (facebook, instagram) and LinkedIn. Creates a single VIDEO ad. Mutually exclusive with `imageUrl`. Supply `url` to upload a file, or `id` to reuse a video already on the ad account (list them with GET /v1/ads/videos). Works on the single-ad and attach (`adSetId`) shapes; for Meta multi-creative, set `video` per entry inside `creatives[]` instead. For LinkedIn the video is uploaded to LinkedIn under the authoring Company Page (see `organizationId`) and the campaign format is set to SINGLE_VIDEO; LinkedIn ignores `thumbnailUrl` (it auto-generates the poster frame) — supply MP4 H.264/AAC, 3s-30min, 75KB-500MB.
         */
        video?: {
            /**
             * Public URL of the video. Meta: uploaded via chunked transfer on /act_X/advideos, then the request blocks on Meta's transcoding until status.video_status === 'ready'. LinkedIn: uploaded via the Videos API (multipart), then the request blocks until LinkedIn finishes transcoding (status AVAILABLE) — short clips take ~10-30s. Provide either `url` or `id`.
             */
            url?: string;
            /**
             * Meta only. Reuse a video ALREADY uploaded to this ad account instead of re-uploading the file: pass the `videoId` returned by a previous create. Wins over `url`, so N ads that differ only in copy share one upload (`existingCreativeId` only covers the identical-copy case). Provide either `url` or `id`.
             */
            id?: string;
            /**
             * Public URL of a still-image thumbnail for the video. OPTIONAL: when omitted on Meta, the poster is auto-generated from Meta's own preferred video thumbnail (the same candidates Ads Manager shows), so video ads usually publish without supplying one. When Meta produces no candidate the request fails with a 502 platform_error (reason: video_thumbnail_unavailable) — retry, or supply this field. Provide it to control the poster frame exactly (uploaded as an ad image and referenced in object_story_spec.video_data). Ignored by LinkedIn (auto-generated poster frame).
             */
            thumbnailUrl?: string;
        };
        /**
         * Meta-only. When present, switches to the multi-creative shape:
         * creates 1 campaign + 1 ad set + N ads (one per entry here).
         * Top-level `headline` / `body` / `imageUrl` / `linkUrl` /
         * `callToAction` are ignored in this mode. Mutually exclusive with `adSetId`.
         *
         */
        creatives?: Array<{
            /**
             * Exact name for this ad. Falls back to `<name> #N` (N = 1-based position).
             */
            name?: string;
            headline: string;
            body: string;
            /**
             * Link description for this ad (link_data.description; video creatives: video_data.link_description). Falls back to the top-level `description`; when both are omitted Meta scrapes the destination URL's OG description.
             */
            description?: string;
            /**
             * Image creative. Mutually exclusive with `video`.
             */
            imageUrl?: string;
            /**
             * Video creative for this entry. Mutually exclusive with `imageUrl`. thumbnailUrl is optional: when omitted, the poster is auto-generated from Meta's preferred video thumbnail, and the request fails with a 502 platform_error (reason: video_thumbnail_unavailable) if Meta produces no candidate.
             */
            video?: {
                url: string;
                thumbnailUrl?: string;
            };
            linkUrl: string;
            callToAction: 'LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | 'BOOK_TRAVEL' | 'CONTACT_US' | 'DOWNLOAD' | 'GET_OFFER' | 'GET_QUOTE' | 'SUBSCRIBE' | 'WATCH_MORE' | 'ADD_TO_CART' | 'APPLY_NOW' | 'BOOK_NOW' | 'BUY_TICKETS' | 'DONATE' | 'DONATE_NOW' | 'GET_DIRECTIONS' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'ORDER_NOW' | 'PLAY_GAME' | 'REQUEST_TIME' | 'SEE_MENU' | 'START_ORDER' | 'INSTALL_MOBILE_APP' | 'USE_APP';
        }>;
        /**
         * When present, switches to the attach shape: adds
         * one new ad to this existing ad set without creating a new
         * campaign. Budget, targeting, goal, schedule, AND bid strategy
         * are inherited from the ad set on Meta — passing `bidStrategy`
         * in attach mode returns 400. To change an existing ad set's
         * bid, use `PUT /v1/ads/ad-sets/{adSetId}`. Mutually exclusive
         * with `creatives[]`.
         *
         * The attached ad takes the full single-creative surface:
         * `headline`/`body`/`description`/`callToAction` plus either
         * `imageUrl`/`video` OR `placementAssets` (its own per-placement
         * Feed/Story assets) OR `translations`/`defaultLocale` (its own
         * per-locale asset feed, Meta only), and `leadGenFormId` when
         * the target is a lead ad set (the parent must be ON_AD, true for ad sets
         * created via goal `lead_generation`; Meta rejects a formless ad
         * there, so pass the form on EVERY attached ad). This is the way
         * to build N full ads sharing one ad set: create the first ad
         * via the normal shape, then attach the rest one call each.
         *
         * Supported on Meta (facebook, instagram), TikTok, and
         * LinkedIn. On TikTok the `adSetId` is the ad group ID; the
         * new ad inherits the ad group's bid + budget + targeting.
         * On LinkedIn the `adSetId` is the LinkedIn Campaign ID
         * (numeric); we attach a new Creative to that Campaign, so
         * the Campaign's `platformSpecificData` bidding, targeting,
         * budget and schedule are inherited (passing those fields
         * returns 400).
         *
         */
        adSetId?: string;
        /**
         * Meta + LinkedIn. On Meta: add the new ad set under this
         * EXISTING campaign instead of creating a new one
         * (multi-ad-set audience testing). The new ad set's budget
         * is matched to the campaign's mode automatically: for a
         * CBO campaign (campaign-level budget) omit
         * `budgetAmount`/`budgetType` — the campaign owns the
         * budget; for an ABO campaign pass them (they go on the new
         * ad set). On LinkedIn: create a new Campaign (and its
         * Creative) under this EXISTING CampaignGroup. On failure
         * only the entities we authored are cleaned up; the
         * pre-existing parent is left untouched and is never
         * (re)activated. Mutually exclusive with `adSetId` and
         * `creatives[]`.
         *
         */
        existingCampaignId?: string;
        /**
         * Meta only. Reuse an EXISTING ad creative by id instead of
         * building a new one from the copy/media fields (which are then
         * ignored). Combine with `existingCampaignId` to build a
         * multi-ad-set campaign that shares one creative. Mutually
         * exclusive with `creatives[]`, `dynamicCreative`, and
         * `placementAssets`. The creative id used is returned as
         * `creativeId` on the create response.
         *
         */
        existingCreativeId?: string;
        /**
         * Google Display only
         */
        businessName?: string;
        /**
         * Pinterest only. Board ID (auto-creates if not provided).
         */
        boardId?: string;
        /**
         * LinkedIn only. The Company Page that authors the Direct Sponsored Content ("dark") post backing the ad — accepts a numeric organization ID or a full `urn:li:organization:N` URN. Required unless the resolved `accountId` is a connected LinkedIn Company-Page account (defaults to that page) or the LinkedIn ad account is org-owned (defaults to the account's owning organization). The authenticated member must be an ADMINISTRATOR or DIRECT_SPONSORED_CONTENT_POSTER of this page (and the page must be associated with the ad account), or LinkedIn returns 403. Ignored by every other platform.
         */
        organizationId?: string;
        /**
         * Nested targeting object — the same TargetingSpec shape as `POST /v1/ads/boost`,
         * `POST /v1/ads/targeting/reach-estimate`, and `saved_targeting` audiences. Merged
         * UNDER the flat inline targeting fields below: `savedTargetingId` < `targeting` <
         * flat fields (a flat field present on the body replaces the nested value entirely).
         * Both forms are equivalent; use whichever your integration already builds.
         *
         */
        targeting?: (TargetingSpec);
        /**
         * ISO 3166-1 alpha-2 country codes (e.g. ['NL']). Defaults to ['US'] when no other geo targeting (flat or nested `targeting`) is provided. (LinkedIn and OpenAI Ads currently honour country-level targeting only; any other targeting field returns 400 for OpenAI Ads.)
         */
        countries?: Array<(string)>;
        /**
         * City-level geo targeting (Meta and TikTok). Each city is targeted by the platform's opaque `key` (the city ID) which can be looked up via `GET /v1/ads/targeting/search?dimension=geo&q=<name>&countryCode=<ISO>`. Optional `radius` + `distance_unit` (Meta only) extend the targeting beyond the city limits (e.g. radius 25 km around the city center). Both must be set together, or both omitted (Meta defaults to ~16 km when omitted).
         *
         * On Meta, cannot overlap with the same country in `countries` (Meta returns a "locations overlap" error). Either drop the country or scope it to a different country. On TikTok, keys are numeric location ids and can be sent without `countries`.
         *
         */
        cities?: Array<{
            /**
             * Meta city ID, from /v1/ads/targeting/search results.
             */
            key: string;
            /**
             * Optional radius around the city. Must be set together with distance_unit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng).
             */
            radius?: number;
            /**
             * Unit for radius. Required if radius is set.
             */
            distance_unit?: 'mile' | 'kilometer';
        }>;
        /**
         * Region-level (state/province) geo targeting (Meta and TikTok). Each region is targeted by the platform's opaque `key` (the region ID) which can be looked up via `GET /v1/ads/targeting/search?dimension=geo&q=<name>&countryCode=<ISO>`.
         *
         */
        regions?: Array<{
            /**
             * Platform region ID, from /v1/ads/targeting/search results.
             */
            key: string;
        }>;
        ageMin?: number;
        ageMax?: number;
        /**
         * Interest objects from /v1/ads/interests. Each must include id and name.
         */
        interests?: Array<{
            id: string;
            name: string;
        }>;
        /**
         * Postal/ZIP geo targeting. `key` is the platform's postal location ID from /v1/ads/targeting/search?dimension=geo&geoType=zip. Supported on Meta, Google, TikTok, Pinterest, X.
         */
        zips?: Array<{
            key: string;
            name?: string;
        }>;
        /**
         * DMA / metro-area geo targeting (Meta and TikTok). `key` is the platform's metro ID from /v1/ads/targeting/search?dimension=geo&geoType=metro (TikTok metros appear as type `metro`, e.g. the New York DMA).
         */
        metros?: Array<{
            key: string;
            name?: string;
        }>;
        /**
         * Point-radius (lat/lng) geo targeting. Meta only (custom_locations). Rejected on platforms without radius support.
         */
        customLocations?: Array<{
            latitude: number;
            longitude: number;
            radius: number;
            distanceUnit: 'mile' | 'kilometer';
            name?: string;
            address?: string;
        }>;
        /**
         * Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta and TikTok. Each must include id.
         */
        behaviors?: Array<{
            id: string;
            name?: string;
        }>;
        /**
         * Normalized household-income tier. Meta and TikTok express all four; Google maps only
         * `top_10`; rejected on LinkedIn, X, and Pinterest. On Meta, income targeting is incompatible
         * with housing/employment/credit `specialAdCategories`.
         *
         */
        incomeTier?: 'top_5' | 'top_10' | 'top_10_25' | 'top_25_50';
        /**
         * Language codes restricting the audience by language. On Meta, ISO 639-1 codes (e.g. ['en'], ['de']); a bare code targets all regional variants ("en" = all English), or use a region-qualified code for a specific one ("en_GB", "pt_BR", "zh_TW"). Unknown codes are rejected. Other ad platforms use their own language-code systems.
         */
        languages?: Array<(string)>;
        /**
         * Meta only. Manual ad placements. Omit for automatic placements (Meta's default,
         * recommended for most cases — Meta optimises delivery across all eligible surfaces).
         * When set, restricts delivery to the chosen surfaces, mapped onto the ad set's
         * `targeting.{publisher_platforms, facebook_positions, instagram_positions,
         * messenger_positions, audience_network_positions, threads_positions,
         * whatsapp_positions, device_platforms}`. Enum membership is validated here; Meta
         * additionally enforces co-selection rules (e.g. some positions require their parent
         * publisher platform) and returns an actionable error which we surface. Non-Meta
         * platforms reject this field.
         *
         */
        placements?: {
            /**
             * Top-level platforms to deliver on. A position field below is only honoured when its parent platform is included here.
             */
            publisherPlatforms?: Array<('facebook' | 'instagram' | 'threads' | 'messenger' | 'audience_network' | 'whatsapp')>;
            facebookPositions?: Array<('feed' | 'right_hand_column' | 'marketplace' | 'video_feeds' | 'story' | 'search' | 'instream_video' | 'facebook_reels' | 'facebook_reels_overlay' | 'profile_feed' | 'notification')>;
            instagramPositions?: Array<('stream' | 'story' | 'explore' | 'explore_home' | 'reels' | 'profile_feed' | 'ig_search' | 'profile_reels')>;
            messengerPositions?: Array<('messenger_home' | 'sponsored_messages' | 'story')>;
            audienceNetworkPositions?: Array<('classic' | 'rewarded_video')>;
            threadsPositions?: Array<('threads_stream')>;
            whatsappPositions?: Array<('status')>;
            /**
             * Restrict by device. Omit to deliver on both mobile and desktop.
             */
            devicePlatforms?: Array<('mobile' | 'desktop')>;
        };
        /**
         * ID of a `saved_targeting` audience (created via POST /v1/ads/audiences). When set, its stored
         * TargetingSpec is expanded as the base targeting; inline fields on this body merge on top. Lets you
         * reuse a named targeting preset without re-sending every field.
         *
         */
        savedTargetingId?: string;
        /**
         * Meta only. A raw Meta-native targeting spec (snake_case: `geo_locations`, `age_min`,
         * `excluded_custom_audiences`, `flexible_spec`, `targeting_automation`, `user_os`,
         * `wireless_carrier`, business places, etc.) — exactly the shape `GET /v1/ads/{adId}` returns for
         * external ads. Sent alone it reaches the ad set VERBATIM (the clone-a-campaign's-targeting-exactly
         * path). Meta validates and surfaces any errors.
         *
         * Can be combined with the camelCase targeting fields (countries/regions/cities/interests/ageMin/...,
         * `targeting`, `savedTargetingId`, `audienceId`): rawTargeting is the BASE layer and the built
         * camelCase spec is merged on top, key by key, with the camelCase side winning on collision (the
         * camelCase precedence chain stays `savedTargetingId` < `targeting` < flat fields). The merge goes
         * one level deep inside `geo_locations` and `excluded_geo_locations`: built sub-keys win, raw-only
         * sub-keys such as `location_types` survive alongside built `countries`. Array values
         * (`flexible_spec`, ...) are replaced as a WHOLE key when the camelCase spec builds them, never
         * element-merged. When rawTargeting is present the defaults the camelCase builder normally injects
         * (US geo, `targeting_automation.advantage_audience: 0`) are suppressed, so raw's values are not
         * clobbered — include `targeting_automation` in the raw spec (or send `advantageAudience`) as Meta
         * requires it on create. If cloning an EU campaign, also pass `dsaBeneficiary` / `dsaPayor` (those
         * are separate fields, not part of targeting).
         *
         */
        rawTargeting?: {
            [key: string]: unknown;
        };
        /**
         * Meta only. Declares the ad's special category, required for housing, employment, credit, or
         * political/social-issue ads (Meta enforces restricted targeting for these). Note: setting a special
         * category disables income/zip targeting on Meta.
         *
         */
        specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
        /**
         * Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires
         * specialAdCategories to be set (400 otherwise). Ignored when joining an existing campaign via
         * existingCampaignId (the existing campaign's category/country already governs it).
         *
         */
        specialAdCategoryCountry?: Array<(string)>;
        /**
         * Required for lifetime budgets
         */
        endDate?: string;
        /**
         * Meta only. Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the
         * ad set's `start_time`. When omitted the ad starts delivering immediately. For lifetime
         * budgets Meta also requires `endDate`. (Same `schedule.startDate` semantics already
         * available on `POST /v1/ads/boost`.)
         *
         */
        startDate?: string;
        /**
         * Meta only. Override the Instagram account the ad is delivered as — pass an Instagram
         * Business Account ID (e.g. 17841...), mapped to the creative's `instagram_user_id`.
         * When omitted we use the Instagram actor Meta already runs the Page's other ads as,
         * falling back to the Page's page-backed Instagram account. Useful when a Page has more
         * than one eligible IG account.
         *
         */
        instagramAccountId?: string;
        /**
         * Meta only. Dynamic Creative: supply a POOL of assets and Meta auto-combines and
         * optimises them into the best-performing variations within a single ad (mapped to the
         * creative's `asset_feed_spec`). When set, the top-level single-creative fields
         * (`imageUrl`, `headline`, `body`, `linkUrl`, `callToAction`) are ignored. Mutually
         * exclusive with the `creatives[]` multi-creative shape. Exactly ONE of `imageUrls` /
         * `videoUrls` is required (Meta allows one ad format per asset feed; sending both →
         * 400). Meta limits: ≤10 images or ≤10 videos, ≤5 bodies / titles / descriptions.
         *
         */
        dynamicCreative?: {
            /**
             * Pool of image URLs (1-10). Uploaded to the ad account and referenced by hash in the asset feed. Mutually exclusive with `videoUrls`.
             */
            imageUrls?: Array<(string)>;
            /**
             * Pool of video URLs (1-10). Uploaded to the ad account and referenced by video id in the asset feed. No thumbnails are needed: Meta auto-generates a poster per video. Mutually exclusive with `imageUrls`; `adFormat` defaults to SINGLE_VIDEO.
             */
            videoUrls?: Array<(string)>;
            /**
             * Primary-text variations (the body copy).
             */
            bodies?: Array<(string)>;
            /**
             * Headline variations.
             */
            titles?: Array<(string)>;
            /**
             * Description (link caption) variations.
             */
            descriptions?: Array<(string)>;
            /**
             * Destination URL variations. At least one is required unless `goal` is `lead_generation`.
             */
            linkUrls?: Array<(string)>;
            /**
             * CTA-button variations. Required.
             */
            callToActionTypes?: Array<('LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | 'BOOK_TRAVEL' | 'CONTACT_US' | 'DOWNLOAD' | 'GET_OFFER' | 'GET_QUOTE' | 'SUBSCRIBE' | 'WATCH_MORE' | 'ADD_TO_CART' | 'APPLY_NOW' | 'BOOK_NOW' | 'BUY_TICKETS' | 'DONATE' | 'DONATE_NOW' | 'GET_DIRECTIONS' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'ORDER_NOW' | 'PLAY_GAME' | 'REQUEST_TIME' | 'SEE_MENU' | 'START_ORDER' | 'INSTALL_MOBILE_APP' | 'USE_APP' | 'REGISTER' | 'JOIN' | 'ATTEND' | 'REQUEST_DEMO' | 'VIEW_QUOTE' | 'APPLY' | 'SEE_MORE' | 'BUY_NOW')>;
            /**
             * Asset-feed ad format. Must match the pool: SINGLE_IMAGE / CAROUSEL_IMAGE require `imageUrls`, SINGLE_VIDEO requires `videoUrls` (400 otherwise). Defaults to SINGLE_IMAGE with `imageUrls`, SINGLE_VIDEO with `videoUrls`.
             */
            adFormat?: 'SINGLE_IMAGE' | 'CAROUSEL_IMAGE' | 'SINGLE_VIDEO';
        };
        /**
         * Meta only. Hand-built carousel: 2-10 authored cards in DETERMINISTIC order, mapped to
         * the creative's `link_data.child_attachments`. Unlike `dynamicCreative`,
         * you control the card order and per-card copy/link. Requires top-level `body`,
         * `linkUrl` and `callToAction`.
         * Mutually exclusive with `imageUrl`/`video`, `creatives[]`, `dynamicCreative`,
         * `placementAssets`, `existingCreativeId`, `adSetId`, `leadGenFormId` and goal
         * `catalog_sales`.
         *
         */
        carouselCards?: Array<{
            /**
             * Card image; uploaded to the ad account and referenced by hash.
             */
            imageUrl: string;
            /**
             * Card destination URL. Defaults to the top-level linkUrl.
             */
            linkUrl?: string;
            /**
             * Card headline, shown below the card image.
             */
            headline?: string;
            /**
             * Card description, shown under the headline.
             */
            description?: string;
            /**
             * Card CTA override. Defaults to the top-level callToAction; same enum.
             */
            callToAction?: string;
        }>;
        /**
         * Meta only. Language the top-level copy is written in (e.g. `en`, `pt_BR`), used by the `translations` default rule. Defaults to `en`. Meta rejects a language asset feed whose default rule carries no locales of its own. Must NOT also appear as an entry in `translations`.
         */
        defaultLocale?: string;
        /**
         * Meta only. Multi-language ads (Dynamic Language Optimization): ONE ad carrying
         * per-locale copy and, optionally, per-locale media — the "Languages" toggle in Ads
         * Manager. Keeps social proof (likes/comments/shares) on a SINGLE post instead of
         * splitting it across one ad per language.
         *
         * The ad's top-level copy is the DEFAULT shown to every locale you do NOT list,
         * and it counts as one of the language variants.
         *
         * IMPORTANT, and the opposite of what you might expect: text does NOT inherit.
         * Every entry must carry its own `headline`, `body` AND `description`, and all of
         * them must be DISTINCT from each other and from the ad's top-level copy. Meta
         * deduplicates identical strings inside the asset feed, so two locales sharing a
         * string collapse into one asset and the create fails with a misleading "Too few
         * ... texts provided in asset creation" (subcode 1885817) that names a field which
         * is actually present. We validate this before calling Meta and return a 400
         * naming the offending locale and field. `description` is therefore effectively
         * required on the ad whenever `translations` is present, even though it is
         * optional otherwise.
         *
         * Do NOT list `defaultLocale` inside `translations`: Meta rejects the duplicate
         * with "The language asset feed includes an unsupported targeting field"
         * (subcode 1885985).
         *
         * Media DOES inherit and is uploaded once when shared, and `linkUrl` inherits
         * too: each locale may name its own landing page and unlisted locales fall back
         * to the ad's top-level `linkUrl`. Note that Meta enforces
         * Dynamic Creative image dimensions on language feeds, so an `imageUrl` that
         * works on a normal ad may be rejected with "The following images have invalid
         * dimensions for Dynamic Creative" (subcode 1885558). Video is not affected.
         *
         * Mutually exclusive with `dynamicCreative`, `placementAssets`, `carouselCards`,
         * `existingCreativeId` and `creatives[]`. Meta allows one `asset_feed_spec` shape per creative.
         *
         */
        translations?: Array<{
            /**
             * Language code, resolved to Meta's numeric locale id. Bare codes target the '(All)' umbrella (`es` = every Spanish variant); region-qualified codes target the variant (`pt_BR`, `en_GB`).
             */
            locale: string;
            /**
             * Headline for this language. REQUIRED, and must differ from every other locale and from the ad's top-level headline.
             */
            headline: string;
            /**
             * Primary text for this language. REQUIRED, and must differ from every other locale and from the ad's top-level body.
             */
            body: string;
            /**
             * Link description for this language. REQUIRED, and must differ from every other locale and from the ad's top-level description.
             */
            description: string;
            /**
             * Destination URL for this language. Inherits the ad's top-level `linkUrl` when omitted, and requires it to be present (400 otherwise): the top-level URL is the destination for every locale you did not override. Unlike text, identical URLs across locales are fine (they share one asset).
             */
            linkUrl?: string;
            /**
             * Image for this language. Inherits the ad's `imageUrl` when omitted. The feed is all-image OR all-video.
             */
            imageUrl?: string;
            /**
             * Video for this language. Inherits the ad's `video.url` when omitted. The feed is all-image OR all-video.
             */
            videoUrl?: string;
            /**
             * Poster frame for this language's video.
             */
            thumbnailUrl?: string;
        }>;
        /**
         * Meta only. Placement asset customization: pin a SPECIFIC asset (image OR video) to
         * each placement group on a SINGLE ad (e.g. a 9:16 on Stories/Reels and a 4:5 on Feed).
         * The same thing Meta Ads Manager produces with "different creative per placement",
         * mapped to the creative's `asset_feed_spec` + `asset_customization_rules`. Deterministic
         * pinning, NOT the auto-optimizing pool of `dynamicCreative` (mutually exclusive). Works
         * on the legacy single shape AND the attach shape (`adSetId` + placementAssets adds one
         * placement-customized ad to an existing ad set — the way to build N per-placement ads
         * sharing one ad set: create the first normally, attach the rest). Cannot be combined
         * with `creatives[]`. Shared copy (headline, body, link,
         * CTA) comes from the top-level single-creative fields since only the asset varies by
         * placement. Each rule's `placements` accepts the same fields as the top-level
         * `placements` object; Meta enforces co-selection rules and returns an actionable error.
         *
         * Note on text rendering: Meta suppresses primary text and headline on fullscreen
         * placements (Stories and Reels) in actual ad delivery; the fields are accepted and
         * the ad publishes, but the copy is not shown to users. For visible copy on those
         * placements, bake the text into the creative image or video itself.
         *
         * A block is all-image OR all-video, never mixed (Meta's asset_feed_spec carries one ad
         * format). Image mode: `defaultImageUrl` + `rules[].imageUrl`. Video mode:
         * `defaultVideoUrl` + `rules[].videoUrl` (optional `thumbnailUrl`/`defaultThumbnailUrl`
         * posters; Meta auto-generates when omitted). Exactly one catch-all default is required.
         *
         */
        placementAssets?: {
            /**
             * Image mode. Catch-all image for any placement no rule matches. Required in image mode (Meta mandates a default rule).
             */
            defaultImageUrl?: string;
            /**
             * Video mode. Catch-all video for any placement no rule matches. Required in video mode.
             */
            defaultVideoUrl?: string;
            /**
             * Video mode (optional). Poster image for the default video; Meta auto-generates one when omitted.
             */
            defaultThumbnailUrl?: string;
            /**
             * One entry per placement group you want to pin a specific asset to.
             */
            rules: Array<{
                /**
                 * Image mode. The image to deliver for this rule's placements.
                 */
                imageUrl?: string;
                /**
                 * Video mode. The video to deliver for this rule's placements.
                 */
                videoUrl?: string;
                /**
                 * Video mode (optional). Poster image for this rule's video; auto-generated when omitted.
                 */
                thumbnailUrl?: string;
                /**
                 * Placements this asset is pinned to. At least one field must be set (an empty rule is invalid — that role is served by the default asset). Same enums as the top-level `placements` object.
                 */
                placements: {
                    publisherPlatforms?: Array<('facebook' | 'instagram' | 'threads' | 'messenger' | 'audience_network' | 'whatsapp')>;
                    facebookPositions?: Array<('feed' | 'right_hand_column' | 'marketplace' | 'video_feeds' | 'story' | 'search' | 'instream_video' | 'facebook_reels' | 'facebook_reels_overlay' | 'profile_feed' | 'notification')>;
                    instagramPositions?: Array<('stream' | 'story' | 'explore' | 'explore_home' | 'reels' | 'profile_feed' | 'ig_search' | 'profile_reels')>;
                    messengerPositions?: Array<('messenger_home' | 'sponsored_messages' | 'story')>;
                    audienceNetworkPositions?: Array<('classic' | 'rewarded_video')>;
                    threadsPositions?: Array<('threads_stream')>;
                    whatsappPositions?: Array<('status')>;
                    devicePlatforms?: Array<('mobile' | 'desktop')>;
                };
            }>;
        };
        /**
         * Custom audience ID for targeting
         */
        audienceId?: string;
        /**
         * Google only
         */
        campaignType?: 'display' | 'search';
        /**
         * Google Search only. BROAD-match keywords on the new ad group (first 20).
         */
        keywords?: Array<(string)>;
        /**
         * Google Search only; other platforms return 400. BROAD-match negative keywords on the new ad group. Editable later via PUT /v1/ads/{adId} targeting.negativeKeywords.
         */
        negativeKeywords?: Array<(string)>;
        /**
         * Google Search RSA only. Extra headlines.
         */
        additionalHeadlines?: Array<(string)>;
        /**
         * Google Search RSA only. Extra descriptions.
         */
        additionalDescriptions?: Array<(string)>;
        /**
         * Meta only. Controls the Advantage audience feature (targeting_automation). 0 = disabled (default), 1 = enabled. Meta Marketing API requires this field on all ad set creation requests.
         */
        advantageAudience?: 0 | 1;
        /**
         * Meta only. Conversion attribution window for the ad set — maps 1:1 to Meta's
         * ad-set `attribution_spec`. Only honored for conversion goals (`conversions`,
         * `lead_generation`, `app_promotion`); ignored for awareness/traffic/engagement.
         * Omit to use Meta's default (`7-day click` + `1-day view`). Meta enforces the
         * valid combinations: `VIEW_THROUGH` only allows `windowDays: 1` (7d/28d view
         * windows were removed Jan 2026); `ENGAGED_VIDEO_VIEW` only `1` and only alongside
         * `VIEW_THROUGH: 1`; `CLICK_THROUGH: 28` only on certain objectives. Invalid combos
         * surface as a Meta 400.
         * Example: `[{ "eventType": "CLICK_THROUGH", "windowDays": 7 }, { "eventType": "VIEW_THROUGH", "windowDays": 1 }]`
         *
         */
        attributionSpec?: Array<{
            eventType: 'CLICK_THROUGH' | 'VIEW_THROUGH' | 'ENGAGED_VIDEO_VIEW';
            windowDays: 1 | 7 | 28;
        }>;
        /**
         * Restrict the audience by gender. 'male' targets men only, 'female' targets women only, 'all' (default) targets everyone. Applied on Meta, TikTok and Pinterest. Ignored on Google, LinkedIn and X.
         */
        gender?: 'all' | 'male' | 'female';
        /**
         * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
         *
         * Meta bid strategy applied to the ad set.
         *
         * OpenAI Ads: required on every ad group via this flat field, the only channel it supports (`platformSpecificData` is Meta/LinkedIn-only and returns 400 for OpenAI). No auto-bid option exists; send `LOWEST_COST_WITH_BID_CAP` or `COST_CAP` together with `bidAmount`, omitting it returns 400.
         *
         * @deprecated
         */
        bidStrategy?: (BidStrategy);
        /**
         * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
         *
         * Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
         * `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`. Meta only: sending
         * `bidAmount` WITHOUT `bidStrategy` requires `existingCampaignId` (400 otherwise),
         * and sets the new ad set's cap under the joined campaign's COST_CAP /
         * LOWEST_COST_WITH_BID_CAP parent. The strategy itself is inherited from the
         * campaign. Restating bidStrategy here is accepted but has no effect on the ad set.
         *
         * Rejected with 400 in `adSetId` attach mode: that shape inherits its cap from
         * the platform. Use `PUT /v1/ads/ad-sets/{adSetId}` there instead.
         *
         * @deprecated
         */
        bidAmount?: number;
        /**
         * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
         *
         * Minimum ROAS as a decimal multiplier (e.g. 2.0 = 2.0x ROAS). Required when
         * `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sending it without `bidStrategy`
         * is a 400. Sent to Meta as
         * `bid_constraints.roas_average_floor` × 10000. Known gap: a CBO campaign's
         * ROAS floor lives on the campaign only (set via `POST /v1/ads/campaigns`);
         * there is no supported way to set it while joining a CBO campaign here.
         *
         * @deprecated
         */
        roasAverageFloor?: number;
        /**
         * Meta only (facebook, instagram; other platforms return 400). Value rule set
         * to attach to the new ad set, from `/v1/ads/value-rule-sets`. Attachment is
         * driven by this id, so `valueRulesApplied` is optional alongside it.
         *
         * Rejected with 400 in `adSetId` attach mode: that shape inherits the existing
         * ad set's attachment, so the field would be silently ignored. Use
         * `PUT /v1/ads/ad-sets/{adSetId}` there instead.
         *
         * Ignored (stripped before the ad-set create) when `buyingType` is `RESERVED`:
         * value rules only apply to auction ad sets on `LOWEST_COST_WITHOUT_CAP` or
         * `COST_CAP`, and a Reach & Frequency reservation has no auction bid strategy.
         *
         * Read back with `GET /v1/ads/ad-sets/{adSetId}?fields=value_rule_set_id`; the
         * attachment is not mirrored onto Zernio's ad documents.
         *
         */
        valueRuleSetId?: string;
        /**
         * Meta only (facebook, instagram; other platforms return 400). Optional when
         * attaching, and requires `valueRuleSetId`. `false` is REJECTED here with 400:
         * a newly created ad set has nothing to detach, so detaching lives on
         * `PUT /v1/ads/ad-sets/{adSetId}`.
         *
         */
        valueRulesApplied?: boolean;
        /**
         * Platform-specific options. The platform is derived from `accountId`;
         * sending options for a different platform returns a 400. LinkedIn
         * (campaign bidding and delivery controls) and Meta (the bid trio)
         * have options today.
         *
         * **Meta**: `bidStrategy`, `bidAmount` and `roasAverageFloor` may be
         * sent here instead of at the root — the preferred home going forward.
         * Sending the bid fields in BOTH places returns a 400
         * (`mutually_exclusive_fields`), and sending any of them in
         * `adSetId` attach mode is a 400 too (the ad set already has its bid).
         *
         */
        platformSpecificData?: (LinkedInAdsPlatformData | MetaAdsPlatformData);
        /**
         * Legal entity that benefits from the ad. Required when targeting EU users
         * (EU DSA, Article 26). Optional if the ad account has a default beneficiary:
         * set it once via `PATCH /v1/ads/accounts` or in Meta Ads Manager, and Meta
         * fills it in whenever the field is omitted.
         *
         */
        dsaBeneficiary?: string;
        /**
         * Legal entity that pays for the ad. Can differ from `dsaBeneficiary`
         * (for example, an agency paying for a client's ads). Same rules as
         * `dsaBeneficiary`: required for EU targeting unless the ad account has
         * a default payor.
         *
         */
        dsaPayor?: string;
        /**
         * TikTok only. Synthetic Brand Identity used when the ad
         * attributes to a CUSTOMIZED_USER (instead of a real TT_USER
         * @username). Required on the FIRST CUSTOMIZED_USER ad on a
         * `tiktokads` SocialAccount with no cached identity; omit on
         * subsequent ads (the identity is cached on the account after
         * first creation). Non-TikTok platforms ignore this field.
         *
         * Alternative: configure once via `PATCH /v1/connect/tiktok-ads`,
         * then create ads without this field.
         *
         */
        brandIdentity?: {
            /**
             * Brand name shown above the ad on TikTok.
             */
            displayName: string;
            /**
             * Public URL of a square brand image (≥98×98 px, JPG/PNG). Used as the brand avatar on the ad.
             */
            imageUrl: string;
        };
        /**
         * TikTok only. Forces the identity attribution on the ad:
         *
         * - `TT_USER`: the posting account's open_id (real @username
         * branding). Requires a connected TikTok posting account
         * on the same profile.
         * - `CUSTOMIZED_USER`: synthetic Brand Identity (display
         * name + avatar). Requires a configured Brand Identity
         * (cached on the `tiktokads` SocialAccount via
         * `PATCH /v1/connect/tiktok-ads`) or an inline
         * `brandIdentity` to create one on the fly.
         *
         * When omitted, defaults to `TT_USER` if a posting account is
         * connected on this profile, else `CUSTOMIZED_USER`. Spark
         * Ads (`POST /v1/ads/boost`) always use `TT_USER` regardless
         * of this field — TikTok requires the original organic
         * post's author identity for Spark.
         *
         */
        identityType?: 'TT_USER' | 'CUSTOMIZED_USER';
        /**
         * TikTok only. Creates the ad as a TikTok Upgraded Smart+
         * campaign: TikTok automates targeting, bidding and delivery. Supports goals
         * `conversions` (Smart+ Web Conversions), `lead_generation` (Smart+ Lead
         * Generation with a website form on `linkUrl`; TikTok Instant Forms not supported)
         * and `app_promotion` (Smart+ App installs; the ad's destination is the app store,
         * so `linkUrl` is not used). The web goals require `promotedObject.pixelId` AND
         * `promotedObject.customEventType`; `app_promotion` requires
         * `promotedObject.applicationId` instead.
         * 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`.
         *
         */
        smartPlus?: boolean;
        /**
         * What the ad optimises against. Behaviour depends on the platform.
         *
         * **Meta**: forwarded to the ad set's `promoted_object` (snake-cased).
         * Required for goals whose ad-set optimization_goal points at a specific
         * event/page/app (without it Meta rejects the ad-set create with
         * `error_subcode: 1815430` "Please select a promoted object for your ad set"):
         * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition). For a pixel CUSTOM event (one you named yourself in CAPI/Events Manager), send `customEventType: OTHER` + `customEventStr` with the event name.
         * - `goal: app_promotion` (APP_INSTALLS): requires `applicationId` + `objectStoreUrl`
         * - `goal: lead_generation` (LEAD_GENERATION): `pageId` is auto-filled from the connected Page when omitted
         *
         * Other Meta goals (engagement, traffic, awareness, video_views) ignore this field.
         *
         * **TikTok**: used by `goal: conversions` and the Smart+ goals (`smartPlus: true`).
         * - `pixelId` maps to the ad group's `pixel_id`. Required: a TikTok website-conversion
         * ad group without a pixel is rejected with `40002: Please select a pixel`.
         * - `customEventType` maps to the ad group's `optimization_event` (the pixel event to
         * optimise for). Optional on the regular conversions flow, required on Smart+.
         * See the `customEventType` field below for the valid TikTok codes.
         * - `applicationId` (Smart+ `goal: app_promotion` only) maps to the ad group's `app_id`:
         * the App ID of an app registered on the TikTok Ads account (Assets → Events →
         * App Events). Install optimization needs the app's MMP tracking configured.
         *
         * The remaining `promotedObject.*` fields are Meta-only. Platforms other than
         * Meta and TikTok ignore `promotedObject` entirely.
         *
         */
        promotedObject?: {
            /**
             * Pixel ID. **Meta:** Facebook Pixel ID, required for `goal: conversions`.
             * Requires `customEventType` alongside it; Meta rejects any promoted_object
             * carrying `pixel_id` without `custom_event_type` (error_subcode 1885014),
             * even when `customConversionId` is also present.
             * **TikTok:** TikTok Pixel ID, required for `goal: conversions`.
             * To discover the pixels an ad account can use, call
             * `GET /v1/accounts/{accountId}/tracking-tags?adAccountId=act_...` (each entry
             * carries `kind` and `ownerAdAccountId`), or
             * `GET /v1/accounts/{accountId}/conversion-destinations`. Note this is a
             * different resource from `GET /v1/ads/{adId}/tracking-tags`, which reads an
             * ad's click-URL params (`url_tags`), not pixels.
             *
             */
            pixelId?: string;
            /**
             * The event the campaign/ad group optimises against.
             *
             * **Meta:** standard event like `PURCHASE`, `LEAD`, `COMPLETE_REGISTRATION`,
             * `ADD_TO_CART`. Uppercased internally so callers can pass any case. Required
             * for `goal: conversions`.
             *
             * **TikTok:** an `optimization_event` code (UPPER_SNAKE, not Meta's vocabulary
             * and not PascalCase), OR the exact event name shown in TikTok Events Manager
             * (auto-resolved to its code). Must be one of the event types your TikTok
             * Pixel tracks; custom events are not optimizable. Current taxonomy:
             * `SHOPPING` (Purchase), `ON_WEB_CART` (Add to Cart), `INITIATE_ORDER`
             * (Initiate Checkout), `FORM` (Lead), `ON_WEB_REGISTER` (Complete
             * Registration), `ON_WEB_DETAIL` (View Content). `ON_WEB_ORDER` is
             * deprecated. On rejection the error lists the event types your pixel
             * actually tracks. Optional for `goal: conversions`.
             *
             */
            customEventType?: string;
            /**
             * Meta only. Pixel custom-event name to optimise against (Meta's
             * `custom_event_str`), exactly as it appears in Events Manager and in your
             * CAPI payloads (case-sensitive, not uppercased). Requires
             * `customEventType: OTHER`, and `OTHER` requires this field (400 either way).
             * The same as picking a custom event in Ads Manager's conversion-event
             * dropdown. For rule-based Custom Conversions use `customConversionId`
             * instead.
             *
             */
            customEventStr?: string;
            /**
             * Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
             * connected Page when omitted.
             *
             */
            pageId?: string;
            /**
             * App ID. Required for `goal: app_promotion`.
             */
            applicationId?: string;
            /**
             * App Store / Play Store listing URL. Required for `goal: app_promotion`.
             */
            objectStoreUrl?: string;
            /**
             * Custom Conversion ID, when optimising against one instead of a standard
             * event. Accepted alone by this API, without `pixelId` or `customEventType`.
             * If `pixelId` is also sent, `customEventType` is still required on the
             * promoted_object (Meta rejects `pixel_id` without `custom_event_type`,
             * error_subcode 1885014).
             *
             */
            customConversionId?: string;
            /**
             * Catalog ID for catalog/Advantage+ Shopping campaigns.
             */
            productCatalogId?: string;
            /**
             * Product Set ID inside the catalog.
             */
            productSetId?: string;
            /**
             * Meta only. Offline event set (dataset) to optimise toward. Post-merger these are datasets: the id is the dataset id (for pixel-backed datasets, the pixel id).
             */
            offlineConversionDataSetId?: string;
            /**
             * Meta only. WhatsApp number on messaging-destination ad sets.
             */
            whatsappPhoneNumber?: string;
        };
    };
    headers?: {
        /**
         * Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
         */
        'Idempotency-Key'?: string;
    };
};
type CreateStandaloneAdResponse = ({
    /**
     * Always true in a validate-only response.
     */
    validateOnly?: boolean;
    results?: Array<{
        node?: 'campaign' | 'adSet' | 'creative' | 'ad';
        status?: 'validated' | 'skipped';
        /**
         * Why the node could not be validated (only on skipped).
         */
        reason?: string;
    }>;
    message?: string;
} | ({
    ad?: Ad;
    message?: string;
} | {
    ads?: Array<Ad>;
    platformCampaignId?: string;
    platformAdSetId?: string;
    message?: string;
}));
type CreateStandaloneAdError = (unknown | {
    error?: string;
});
type ListLeadsData = {
    query?: {
        /**
         * Filter to a single connected account. LinkedIn ads accounts switch to the live fetch.
         */
        accountId?: string;
        /**
         * LinkedIn only: the LinkedIn ad account id whose responses to read (owner-scoped finder).
         */
        adAccountId?: string;
        /**
         * Keyset cursor from a previous response's pagination.cursor (Meta: AdLead id; LinkedIn: numeric start offset).
         */
        cursor?: string;
        /**
         * Filter to a single lead form.
         */
        formId?: string;
        limit?: number;
        /**
         * Unix seconds; only leads created at/after this timestamp.
         */
        since?: number;
    };
};
type ListLeadsResponse = ({
    status?: string;
    leads?: Array<{
        /**
         * Zernio lead id.
         */
        id?: string;
        /**
         * Meta lead id. On LinkedIn, the leadFormResponse id.
         */
        leadgenId?: string;
        formId?: string;
        formName?: (string) | null;
        accountId?: string;
        adId?: (string) | null;
        adsetId?: (string) | null;
        /**
         * On LinkedIn, this is the LinkedIn Campaign id, which corresponds to platformAdSetId on GET /v1/ads (LinkedIn's Campaign Group is Zernio's campaign).
         */
        campaignId?: (string) | null;
        isOrganic?: boolean;
        /**
         * ISO 8601.
         */
        createdTime?: (string) | null;
        /**
         * Question key → answer. On LinkedIn, the key is the lowercased predefinedField, else the question name, else the numeric questionId; multiple-choice values are option labels (unlike Meta, which returns the option key).
         */
        fields?: {
            [key: string]: (string);
        };
        /**
         * Raw Meta field_data.
         */
        fieldData?: Array<{
            [key: string]: unknown;
        }>;
    }>;
    pagination?: {
        hasMore?: boolean;
        cursor?: (string) | null;
    };
});
type ListLeadsError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListLeadFormsData = {
    query: {
        /**
         * Connected facebook or linkedin ads account id.
         */
        accountId: string;
        /**
         * LinkedIn only: the LinkedIn ad account id (used to resolve the owning organization). Required for LinkedIn.
         */
        adAccountId?: string;
        cursor?: string;
        limit?: number;
    };
};
type ListLeadFormsResponse = ({
    status?: string;
    forms?: Array<{
        [key: string]: unknown;
    }>;
    pagination?: {
        hasMore?: boolean;
        cursor?: (string) | null;
    };
});
type ListLeadFormsError = (ErrorResponse | {
    error?: string;
} | unknown);
type CreateLeadFormData = {
    body: {
        accountId: string;
        name: string;
        /**
         * Deprecated (Meta legacy shape): use platformSpecificData.questions.
         * @deprecated
         */
        questions?: Array<{
            /**
             * EMAIL, PHONE, FULL_NAME, FIRST_NAME, LAST_NAME, CUSTOM, …
             */
            type: string;
            /**
             * CUSTOM questions only.
             */
            key?: string;
            /**
             * CUSTOM questions only.
             */
            label?: string;
            options?: Array<{
                key?: string;
                value?: string;
            }>;
            inline_context?: string;
        }>;
        privacyPolicyUrl: string;
        /**
         * Deprecated: use platformSpecificData.privacyPolicyLinkText.
         * @deprecated
         */
        privacyPolicyLinkText?: string;
        /**
         * Deprecated: use platformSpecificData.followUpActionUrl.
         * @deprecated
         */
        followUpActionUrl?: string;
        /**
         * Deprecated: use platformSpecificData.locale.
         * @deprecated
         */
        locale?: string;
        /**
         * Deprecated: use platformSpecificData.thankYouTitle.
         * @deprecated
         */
        thankYouTitle?: string;
        /**
         * Deprecated: use platformSpecificData.thankYouBody.
         * @deprecated
         */
        thankYouBody?: string;
        /**
         * Deprecated: use platformSpecificData.thankYouButtonText.
         * @deprecated
         */
        thankYouButtonText?: string;
        /**
         * Deprecated: use platformSpecificData.thankYouButtonType.
         * @deprecated
         */
        thankYouButtonType?: string;
        /**
         * Deprecated: use platformSpecificData.thankYouWebsiteUrl.
         * @deprecated
         */
        thankYouWebsiteUrl?: string;
        /**
         * Deprecated: use platformSpecificData.isOptimizedForQuality.
         * @deprecated
         */
        isOptimizedForQuality?: boolean;
        /**
         * Form content; the shape is selected by the accountId's platform. Unknown fields are a 400 (strict-parsed).
         */
        platformSpecificData?: ({
            questions: Array<{
                /**
                 * EMAIL, PHONE, FULL_NAME, FIRST_NAME, LAST_NAME, CUSTOM, …
                 */
                type: string;
                /**
                 * CUSTOM questions only.
                 */
                key?: string;
                /**
                 * CUSTOM questions only.
                 */
                label?: string;
                options?: Array<{
                    key?: string;
                    value?: string;
                }>;
                inline_context?: string;
            }>;
            privacyPolicyLinkText?: string;
            followUpActionUrl?: string;
            locale?: string;
            thankYouTitle?: string;
            thankYouBody?: string;
            thankYouButtonText?: string;
            thankYouButtonType?: string;
            thankYouWebsiteUrl?: string;
            /**
             * Set true for a higher-intent form (adds a review step before submit).
             */
            isOptimizedForQuality?: boolean;
            blockDisplayForNonTargetedViewer?: boolean;
            questionPageCustomHeadline?: string;
            contextCard?: {
                title?: string;
                content?: Array<(string)>;
                style?: 'LIST_STYLE' | 'PARAGRAPH_STYLE';
                buttonText?: string;
                coverPhoto?: string;
            };
        } | {
            /**
             * LinkedIn ad account id (resolves the owning organization).
             */
            adAccountId: string;
            headline: string;
            description: string;
            /**
             * Defaults to DRAFT.
             */
            state?: 'DRAFT' | 'PUBLISHED';
            locale?: {
                country?: string;
                language?: string;
            };
            consents?: Array<{
                description: string;
                /**
                 * Whether the viewer must tick this consent to submit. Defaults to false.
                 */
                required?: boolean;
            }>;
            questions: Array<({
                kind: 'text';
                name: string;
                question: string;
                required?: boolean;
                responseEditable?: boolean;
                /**
                 * Defaults to 300 on LinkedIn's side.
                 */
                maxResponseLength?: number;
            } | {
                kind: 'multipleChoice';
                name: string;
                question: string;
                required?: boolean;
                responseEditable?: boolean;
                choices: Array<{
                    id: number;
                    text: string;
                }>;
            })>;
        });
    };
};
type CreateLeadFormResponse = ({
    status?: string;
    form?: {
        id?: string;
        name?: string;
    };
});
type CreateLeadFormError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetLeadFormData = {
    path: {
        /**
         * Numeric form id (Meta leadgen_form id or LinkedIn leadForm id).
         */
        formId: string;
    };
    query: {
        /**
         * Connected facebook or linkedin ads account id (selects the platform).
         */
        accountId: string;
    };
};
type GetLeadFormResponse = ({
    status?: string;
    form?: {
        [key: string]: unknown;
    };
});
type GetLeadFormError = (ErrorResponse | {
    error?: string;
});
type ArchiveLeadFormData = {
    path: {
        /**
         * Numeric form id (Meta leadgen_form id or LinkedIn leadForm id).
         */
        formId: string;
    };
    query: {
        /**
         * Connected facebook or linkedin ads account id (selects the platform).
         */
        accountId: string;
    };
};
type ArchiveLeadFormResponse = ({
    status?: string;
    formId?: string;
    archived?: boolean;
});
type ArchiveLeadFormError = (ErrorResponse | {
    error?: string;
});
type ListFormLeadsData = {
    path: {
        formId: string;
    };
    query: {
        accountId: string;
        cursor?: string;
        limit?: number;
        /**
         * Unix seconds.
         */
        since?: number;
    };
};
type ListFormLeadsResponse = ({
    status?: string;
    leads?: Array<{
        id?: string;
        createdTime?: (string) | null;
        adId?: (string) | null;
        formId?: string;
        fields?: {
            [key: string]: (string);
        };
        fieldData?: Array<{
            [key: string]: unknown;
        }>;
    }>;
    pagination?: {
        hasMore?: boolean;
        cursor?: (string) | null;
    };
});
type ListFormLeadsError = (ErrorResponse | {
    error?: string;
});
type CreateTestLeadData = {
    body: {
        accountId: string;
        fieldData: Array<{
            name: string;
            values: Array<(string)>;
        }>;
    };
    path: {
        formId: string;
    };
};
type CreateTestLeadResponse = ({
    status?: string;
    testLead?: {
        id?: string;
    };
});
type CreateTestLeadError = (ErrorResponse | {
    error?: string;
});
type UploadAdImageData = {
    body: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        /**
         * Raw base64 image bytes, or a full data URL (the data:image/...;base64, prefix is stripped).
         */
        imageBase64: string;
        /**
         * Optional filename shown in Meta's image library. Defaults to ad_image.jpg.
         */
        filename?: string;
    };
};
type UploadAdImageResponse = ({
    adAccountId?: string;
    image?: {
        /**
         * Meta image hash, reusable wherever image_hash is accepted.
         */
        hash?: string;
        /**
         * Meta-hosted image URL; usable as imageUrl on the create endpoints.
         */
        url?: string;
    };
});
type UploadAdImageError = (unknown | {
    error?: string;
});
type ListAdImagesData = {
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        /**
         * Cursor from paging.after of the previous page.
         */
        after?: string;
        /**
         * Comma-separated Graph field override (supports nested {} projections).
         */
        fields?: string;
        /**
         * Rows per page
         */
        limit?: number;
    };
};
type ListAdImagesResponse = ({
    adAccountId?: string;
    data?: Array<{
        [key: string]: unknown;
    }>;
    paging?: {
        /**
         * Cursor for the next page; null when exhausted.
         */
        after?: (string) | null;
    };
});
type ListAdImagesError = (unknown | {
    error?: string;
});
type ListAdVideosData = {
    query: {
        /**
         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
         */
        accountId: string;
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        /**
         * Cursor from paging.after of the previous page.
         */
        after?: string;
        /**
         * Comma-separated Graph field override (supports nested {} projections).
         */
        fields?: string;
        /**
         * Rows per page
         */
        limit?: number;
    };
};
type ListAdVideosResponse = ({
    adAccountId?: string;
    data?: Array<{
        [key: string]: unknown;
    }>;
    paging?: {
        /**
         * Cursor for the next page; null when exhausted.
         */
        after?: (string) | null;
    };
});
type ListAdVideosError = (ErrorResponse | {
    error?: string;
} | unknown);
type SearchAdInterestsData = {
    query: {
        /**
         * Social account ID
         */
        accountId: string;
        /**
         * Search query
         */
        q: string;
    };
};
type SearchAdInterestsResponse = ({
    interests?: Array<{
        id?: string;
        name?: string;
        category?: string;
    }>;
});
type SearchAdInterestsError = ({
    error?: string;
} | unknown);
type SearchAdTargetingData = {
    query: {
        /**
         * Social account ID (a connected account on the target ad platform).
         */
        accountId: string;
        /**
         * ISO 3166-1 alpha-2 country code (e.g. NL) to scope a geo search.
         */
        countryCode?: string;
        /**
         * What to search. `geo` resolves locations (scope further with `geoType`), `interest`/`behavior` resolve audience entities, `income` resolves income-tier options. Defaults to `interest` for backward compatibility with the deprecated /v1/ads/interests alias.
         */
        dimension?: 'geo' | 'interest' | 'behavior' | 'income';
        /**
         * Only used when `dimension=geo`. The kind of location to resolve. `all` searches every type in one relevance-ranked call. Defaults to `city`.
         */
        geoType?: 'all' | 'country' | 'region' | 'city' | 'subcity' | 'neighborhood' | 'place' | 'zip' | 'metro_area' | 'geo_market';
        /**
         * Maximum results to return.
         */
        limit?: number;
        /**
         * Search query. For geo, the locality name only (no region/country suffix).
         */
        q: string;
    };
};
type SearchAdTargetingResponse = ({
    results?: Array<{
        /**
         * The platform's opaque id. Use as a geo `key` (regions/cities/zips/metros) or an entity `id` (interests/behaviors) in TargetingSpec.
         */
        id: string;
        /**
         * Human-readable label.
         */
        name: string;
        /**
         * What the result is (e.g. city, region, country, zip, metro, location, interest, behavior, income).
         */
        type: string;
        /**
         * Optional breadcrumb of parent labels (e.g. ['United States', 'California', 'Los Angeles']). Disambiguates same-named results.
         */
        path?: Array<(string)>;
        /**
         * Optional estimated reachable users for this option, when the platform returns it.
         */
        audienceSize?: (number) | null;
    }>;
});
type SearchAdTargetingError = (unknown | {
    error?: string;
});
type EstimateAdReachData = {
    body: {
        /**
         * Zernio social account ID on the target ad platform (the estimate runs against its platform).
         */
        accountId: string;
        /**
         * Required. The platform ad-account ID the reach call runs against (Meta act_..., LinkedIn numeric sponsoredAccount ID, Pinterest ad-account ID, X account ID) - every backing reach API is scoped to one ad account. Get it from GET /v1/ads/accounts.
         */
        adAccountId: string;
        /**
         * The targeting spec to estimate. Same shape used by POST /v1/ads/create.
         */
        spec: (TargetingSpec);
        /**
         * Optional. The optimization goal the estimate should assume (platform's
         * own vocabulary, e.g. Meta `REACH`, `LINK_CLICKS`, `OFFSITE_CONVERSIONS`).
         * Some platforms vary the estimate by goal; omit to use the platform default.
         *
         */
        optimizationGoal?: string;
    };
};
type EstimateAdReachResponse = ({
    /**
     * Whether a pre-flight estimate is available on this platform. False for Google and TikTok.
     */
    available: boolean;
    /**
     * Lower bound of the estimated reachable audience. Present only when available.
     */
    lower?: (number) | null;
    /**
     * Upper bound of the estimated reachable audience. Present only when available.
     */
    upper?: (number) | null;
    /**
     * Optional estimated daily reach/results at the given budget, when the platform returns it.
     */
    daily?: (number) | null;
    /**
     * Currency of any monetary fields in the estimate, when applicable.
     */
    currency?: (string) | null;
    /**
     * Meta only. False when Meta is still computing the estimate (the audience is too new); retry shortly.
     */
    estimateReady?: (boolean) | null;
});
type EstimateAdReachError = (unknown | {
    error?: string;
});
type GetLinkedInBidPricingData = {
    body: {
        /**
         * Zernio social account ID (LinkedIn).
         */
        accountId: string;
        /**
         * LinkedIn ad account ID (numeric).
         */
        adAccountId: string;
        /**
         * Same targeting spec used by POST /v1/ads/create.
         */
        spec: (TargetingSpec);
        /**
         * Defaults to SPONSORED_UPDATES.
         */
        campaignType?: 'TEXT_AD' | 'SPONSORED_UPDATES' | 'SPONSORED_INMAILS';
        /**
         * Defaults to CPM.
         */
        bidType?: 'CPM' | 'CPC' | 'CPV';
        /**
         * Defaults to EXACT.
         */
        matchType?: 'EXACT' | 'AUDIENCE_EXPANDED';
        /**
         * ISO 4217, defaults to USD.
         */
        currency?: string;
        /**
         * LinkedIn objectiveType, e.g. WEBSITE_VISIT, LEAD_GENERATION, VIDEO_VIEW.
         */
        objectiveType?: string;
        /**
         * LinkedIn optimizationTargetType, e.g. MAX_CLICK, MAX_IMPRESSION.
         */
        optimizationTargetType?: string;
        /**
         * Optional daily budget in whole account-currency units. LinkedIn refines the suggested bid to this budget.
         */
        dailyBudget?: number;
    };
};
type GetLinkedInBidPricingResponse = ({
    available: boolean;
    /**
     * LinkedIn's adBudgetPricing element. Null when LinkedIn has no data for the combination.
     */
    pricing?: {
        bidLimits?: {
            min?: MoneyAmount;
            max?: MoneyAmount;
        };
        suggestedBid?: {
            min?: MoneyAmount;
            default?: MoneyAmount;
            max?: MoneyAmount;
        };
        dailyBudgetLimits?: {
            min?: MoneyAmount;
            default?: MoneyAmount;
            max?: MoneyAmount;
        };
    } | null;
});
type GetLinkedInBidPricingError = (unknown | {
    error?: string;
});
type GetLinkedInSupplyForecastData = {
    body: {
        accountId: string;
        adAccountId: string;
        spec: (TargetingSpec);
        /**
         * Defaults to SPONSORED_UPDATES.
         */
        campaignType?: 'SPONSORED_UPDATES' | 'SPONSORED_INMAILS' | 'DYNAMIC';
        /**
         * Unix ms. Must be in the future.
         */
        timeRangeStart: number;
        /**
         * Unix ms. Must be after start and within LinkedIn's max horizon.
         */
        timeRangeEnd: number;
        objectiveType?: string;
        /**
         * When set, the forecast assumes auto-bidding. When unset, competingBid is required.
         */
        optimizationTarget?: string;
        /**
         * Either dailyBudget or totalBudget is required.
         */
        dailyBudget?: number;
        totalBudget?: number;
        /**
         * ISO 4217, defaults to USD.
         */
        currency?: string;
        /**
         * Required for manual-bid forecasts (when optimizationTarget is not set).
         */
        competingBid?: {
            bidType: 'CPM' | 'CPC' | 'CPV';
            amount: number;
        };
        /**
         * Defaults to false. Required true for connectedTelevisionOnly.
         */
        enableAudienceNetwork?: boolean;
        /**
         * Defaults to false.
         */
        enableAudienceExpansion?: boolean;
        /**
         * Defaults to false.
         */
        connectedTelevisionOnly?: boolean;
    };
};
type GetLinkedInSupplyForecastResponse = ({
    available: boolean;
    forecast?: Array<{
        metricType?: string;
        granularity?: 'DAILY' | 'SEVEN_DAY' | 'THIRTY_DAY' | 'CUSTOM';
        timeSeries?: Array<{
            timestamp?: number;
            value?: number;
            adForecastRange?: {
                lowEnd?: number;
                highEnd?: number;
            };
        }>;
    }>;
});
type GetLinkedInSupplyForecastError = (unknown | {
    error?: string;
});
type ListAdCatalogsData = {
    query: {
        /**
         * A facebook, instagram, or metaads social account ID
         */
        accountId: string;
        /**
         * Meta ad account ID (act_...)
         */
        adAccountId: string;
    };
};
type ListAdCatalogsResponse = ({
    catalogs?: Array<{
        id?: string;
        name?: string;
        /**
         * Catalog vertical (e.g. commerce, vehicles, hotels)
         */
        vertical?: (string) | null;
        productCount?: number;
    }>;
});
type ListAdCatalogsError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListAdCatalogProductSetsData = {
    path: {
        /**
         * Meta product catalog ID (from GET /v1/ads/catalogs)
         */
        catalogId: string;
    };
    query: {
        /**
         * A facebook, instagram, or metaads social account ID
         */
        accountId: string;
    };
};
type ListAdCatalogProductSetsResponse = ({
    productSets?: Array<{
        id?: string;
        name?: string;
        productCount?: number;
    }>;
});
type ListAdCatalogProductSetsError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListAdAudiencesData = {
    query: {
        /**
         * Social account ID
         */
        accountId: string;
        /**
         * Platform ad account ID
         */
        adAccountId: string;
        platform?: 'facebook' | 'instagram' | 'googleads' | 'tiktok' | 'tiktokads' | 'pinterest' | 'linkedin' | 'linkedinads' | 'twitter' | 'xads';
        /**
         * Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences.
         */
        type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
    };
};
type ListAdAudiencesResponse = ({
    audiences?: Array<{
        id?: (string) | null;
        /**
         * Social account the audience was created against. Returned for saved_targeting items.
         */
        accountId?: string;
        platformAudienceId?: string;
        name?: string;
        description?: string;
        type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
        /**
         * Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
         */
        spec?: (TargetingSpec | null);
        platform?: string;
        size?: number;
        status?: string;
    }>;
});
type ListAdAudiencesError = ({
    error?: string;
} | unknown);
type CreateAdAudienceData = {
    body: ({
        accountId: string;
        /**
         * Platform ad account ID. Must start with act_ for Meta; bare platform id for others (Google customer id, X/TikTok/LinkedIn/Pinterest account id).
         */
        adAccountId: string;
        name: string;
        description?: string;
        type: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike';
        /**
         * Required for website_retargeting audiences (LinkedIn only).
         * Each rule is a URL pattern; a member who visits any
         * matching page enters the segment. Needs the LinkedIn
         * Insight Tag installed on the customer's site — the
         * segment only starts filling once the tag reports visits.
         *
         * The response's `platformAudienceId` is the LinkedIn
         * adSegment id, valid for downstream use.
         * These segments appear in GET /v1/ads/audiences with
         * `type: website_retargeting` once LinkedIn has finished building them.
         *
         */
        matchRules?: Array<{
            matchType: 'EXACT' | 'STARTS_WITH' | 'CONTAINS' | 'ENDS_WITH';
            matchValue: string;
        }>;
        /**
         * Required for engagement audiences (LinkedIn only): what
         * members engaged with — a video/leadgen/single-image ad
         * campaign, a Company Page or an Event page.
         *
         */
        sourceType?: 'VIDEO_ADS' | 'LEAD_GEN_FORMS' | 'ORGANIZATION_PAGES' | 'EVENT_PAGES' | 'SINGLE_IMAGE_ADS';
        /**
         * Required for engagement audiences. The action, validated
         * by LinkedIn against `sourceType`. Common values:
         * VIDEO_ADS FIRST_QUARTILE / MIDPOINT / THIRD_QUARTILE /
         * FULL_COMPLETE; LEAD_GEN_FORMS VIEW_FORM /
         * LEAD_FORM_SUBMIT; ORGANIZATION_PAGES VIEW / CTA_CLICK;
         * EVENT_PAGES RSVPED / VIDEO_VIEWED / ENGAGEMENT / CLICK.
         *
         */
        trigger?: string;
        /**
         * Required for engagement audiences. Rolling window.
         */
        lookbackDays?: 30 | 60 | 90 | 180 | 365;
        /**
         * Required for engagement audiences. Campaign URNs for the
         * ad source types, organization URNs for pages and events.
         * LinkedIn creates one rule per source, all sharing the
         * same trigger and lookbackDays.
         *
         */
        engagementSources?: Array<(string)>;
        /**
         * Required for company_list audiences (LinkedIn only): plain-text
         * company rows for account targeting. Each row needs at least one
         * identifier. Not hashed, LinkedIn matches these against its own
         * company graph. LinkedIn recommends 1,000+ companies for a usable
         * match rate and takes up to 48h to process the list. Replace the
         * list later with POST /v1/ads/audiences/{audienceId}/companies.
         *
         */
        companies?: Array<{
            name?: string;
            domain?: string;
            website?: string;
            linkedinPageUrl?: string;
        }>;
        /**
         * Required for website audiences
         */
        pixelId?: string;
        /**
         * Required for website (max 180) and meta_engagement (max 365) audiences.
         */
        retentionDays?: number;
        /**
         * Required for meta_engagement audiences (Meta only): what people
         * engaged with. `page` = a Facebook Page, `instagram` = an IG
         * professional account, `video` = a video. The source object must be
         * eligible for engagement audiences or Meta rejects with subcode
         * 1713151 ("Invalid Event Name"), surfaced verbatim.
         *
         */
        engagementSource?: 'page' | 'instagram' | 'video';
        /**
         * Required for meta_engagement: the Page / IG account / video id.
         */
        sourceId?: string;
        /**
         * meta_engagement only. The engagement event; defaults per source
         * (page → page_engaged, instagram → ig_business_profile_all,
         * video → video_watched). Ignored when `rule` is provided.
         *
         */
        event?: string;
        /**
         * Required for lookalike audiences
         */
        sourceAudienceId?: string;
        /**
         * 2-letter code, required for lookalike audiences
         */
        country?: string;
        /**
         * Required for lookalike audiences
         */
        ratio?: number;
        /**
         * website only. Narrows the audience from all visitors to visitors of
         * URLs containing this substring. Ignored when `rule` is supplied.
         *
         */
        urlContains?: string;
        /**
         * Optional raw Meta rule, replacing the one we build. Omit it for all
         * visitors of `pixelId`, or use `urlContains` for the common page-match
         * case.
         *
         * For `website` this is Meta's Flexible Audience Rule and is VALIDATED
         * before we call Meta: every entry in `inclusions.rules` (and
         * `exclusions.rules`) must carry `event_sources`, `retention_seconds`
         * AND `filter`. Meta rejects a rule missing any of the three with code
         * 100 / subcode 1713098 ("Invalid rule JSON format"), so a bad shape is
         * a 400 here instead. The pre-2018 flat shapes (`{url: ...}`,
         * `{event: ...}`) are not accepted by Meta at all (subcode 1870029).
         *
         * Example, visitors of /checkout in the last 30 days:
         * `{"inclusions":{"operator":"or","rules":[{"event_sources":[{"id":"<pixelId>","type":"pixel"}],"retention_seconds":2592000,"filter":{"operator":"and","filters":[{"field":"url","operator":"i_contains","value":"/checkout"}]}}]}}`
         *
         * Note Meta DERIVES `retention_days` from `retention_seconds` and
         * stores `event_sources[].id` as a number, so a rule read back will
         * not be byte-identical to the one you sent.
         *
         * For `meta_engagement` the rule is forwarded verbatim and NOT
         * validated: that type has two dialects (the `video` source uses a
         * legacy flat array), so no single schema covers both.
         *
         */
        rule?: {
            [key: string]: unknown;
        };
        /**
         * Data source declaration for GDPR compliance (customer_list only)
         */
        customerFileSource?: string;
    } | {
        type: 'saved_targeting';
        /**
         * Social account ID on the target ad platform.
         */
        accountId: string;
        name: string;
        description?: string;
        /**
         * The targeting spec to store.
         */
        spec: (TargetingSpec);
    });
};
type CreateAdAudienceResponse = ({
    audience?: {
        [key: string]: unknown;
    };
    message?: string;
});
type CreateAdAudienceError = (unknown | {
    error?: string;
});
type GetAdAudienceData = {
    path: {
        audienceId: string;
    };
};
type GetAdAudienceResponse = ({
    audience?: {
        [key: string]: unknown;
    };
    /**
     * Fresh data from Meta API
     */
    metaData?: {
        [key: string]: unknown;
    } | null;
});
type GetAdAudienceError = ({
    error?: string;
} | unknown);
type UpdateAdAudienceData = {
    body: {
        name?: string;
        description?: string;
        /**
         * Full replacement for the stored targeting spec.
         */
        spec?: (TargetingSpec);
    };
    path: {
        audienceId: string;
    };
};
type UpdateAdAudienceResponse = ({
    audience?: {
        [key: string]: unknown;
    };
    message?: string;
});
type UpdateAdAudienceError = (unknown | {
    error?: string;
});
type DeleteAdAudienceData = {
    path: {
        audienceId: string;
    };
};
type DeleteAdAudienceResponse = ({
    message?: string;
});
type DeleteAdAudienceError = ({
    error?: string;
} | unknown);
type AddUsersToAdAudienceData = {
    body: {
        users: Array<{
            email?: string;
            phone?: string;
        }>;
    };
    path: {
        audienceId: string;
    };
};
type AddUsersToAdAudienceResponse = ({
    message?: string;
    numReceived?: number;
    numInvalid?: number;
});
type AddUsersToAdAudienceError = (unknown | {
    error?: string;
});
type ReplaceAdAudienceCompaniesData = {
    body: {
        /**
         * The complete company list. Each row needs at least one of name, domain, website or linkedinPageUrl.
         */
        companies: Array<{
            name?: string;
            domain?: string;
            website?: string;
            linkedinPageUrl?: string;
        }>;
    };
    path: {
        audienceId: string;
    };
};
type ReplaceAdAudienceCompaniesResponse = ({
    message?: string;
    /**
     * Rows sent to LinkedIn. Matching happens asynchronously, so this is not the matched company count.
     */
    numReceived?: number;
});
type ReplaceAdAudienceCompaniesError = (unknown | {
    error?: string;
});
type GetConversionsQualityData = {
    query: {
        /**
         * SocialAccount _id (must be a metaads account).
         */
        accountId: string;
        /**
         * Meta pixel/dataset ID.
         */
        destinationId: string;
    };
};
type GetConversionsQualityResponse = ({
    platform?: string;
    rows?: Array<{
        eventName?: string;
        /**
         * Composite EMQ score, 0-10.
         */
        compositeScore?: number;
        matchKeys?: Array<{
            identifier?: string;
            coveragePercentage?: number;
        }>;
        /**
         * Pixel↔CAPI coverage rate for this event.
         */
        eventCoveragePercentage?: number;
    }>;
});
type GetConversionsQualityError = (ErrorResponse | {
    error?: string;
} | unknown);
type SendConversionsData = {
    body: {
        /**
         * SocialAccount ID (metaads, googleads, linkedinads, tiktokads, or openaiads).
         */
        accountId: string;
        /**
         * Platform destination identifier. For Meta, the pixel/dataset
         * ID. For Google, the conversion action resource name. For
         * LinkedIn, the conversion rule ID or full
         * `urn:lla:llaPartnerConversion:{id}` URN. For OpenAI Ads, the
         * pixel wire id.
         *
         */
        destinationId: string;
        events: Array<ConversionEvent>;
        /**
         * Meta `test_event_code` passthrough. Ignored by Google, LinkedIn, and OpenAI Ads.
         */
        testCode?: string;
        /**
         * Batch-level user consent. Required by Google for EEA/UK
         * events under the Feb 2026 restrictions. On Meta, any
         * DENIED flag enables Limited Data Use on every event in
         * the batch (data_processing_options ["LDU"] with
         * geolocation, country 0 / state 0); GRANTED or absent
         * consent sends events with Meta's default processing.
         * Ignored by LinkedIn.
         *
         */
        consent?: {
            adUserData?: 'GRANTED' | 'DENIED';
            adPersonalization?: 'GRANTED' | 'DENIED';
        };
    };
};
type SendConversionsResponse = ({
    platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads' | 'openaiads';
    /**
     * Events accepted by the platform.
     */
    eventsReceived?: number;
    /**
     * Events rejected (see failures).
     */
    eventsFailed?: number;
    failures?: Array<{
        /**
         * Index into the submitted events array.
         */
        eventIndex?: number;
        /**
         * Echoes back the eventId of the failed event.
         */
        eventId?: string;
        message?: string;
        code?: (string | number);
    }>;
    /**
     * Platform trace ID for debugging. fbtrace_id for Meta,
     * requestId for Google. Absent for LinkedIn (LinkedIn's
     * conversionEvents endpoint does not surface a trace ID)
     * and OpenAI Ads (no trace ID surfaced).
     *
     */
    traceId?: string;
});
type SendConversionsError = (unknown | {
    error?: string;
});
type AdjustConversionsData = {
    body: {
        /**
         * SocialAccount ID. Must be a `googleads` account.
         */
        accountId: string;
        /**
         * Conversion action resource name, e.g. `customers/1234567890/conversionActions/987654321`.
         */
        destinationId: string;
        adjustments: Array<{
            adjustmentType: 'RETRACTION' | 'RESTATEMENT' | 'ENHANCEMENT';
            /**
             * When the adjustment occurred, unix seconds.
             */
            adjustmentTime: number;
            /**
             * Transaction ID of the original conversion (the `eventId` you sent). Recommended; required for ENHANCEMENT.
             */
            orderId?: string;
            /**
             * Alternative key — the original click ID. Pair with `conversionTime`. Not valid for ENHANCEMENT.
             */
            gclid?: string;
            /**
             * The original conversion's time, unix seconds. Required when identifying by `gclid`.
             */
            conversionTime?: number;
            /**
             * RESTATEMENT only — the corrected TOTAL conversion value.
             */
            restatementValue?: number;
            /**
             * RESTATEMENT only — ISO 4217 currency for `restatementValue`.
             */
            currency?: string;
            /**
             * ENHANCEMENT only — first-party identifiers (hashed server-side). At least one of email/phone required.
             */
            user?: {
                email?: string;
                phone?: string;
            };
            /**
             * ENHANCEMENT only — the original conversion's user agent (improves match quality).
             */
            userAgent?: string;
        }>;
    };
};
type AdjustConversionsResponse = ({
    platform?: 'googleads';
    /**
     * Adjustments accepted by Google.
     */
    adjustmentsReceived?: number;
    /**
     * Adjustments rejected (see failures).
     */
    adjustmentsFailed?: number;
    failures?: Array<{
        /**
         * Index into the submitted adjustments array.
         */
        adjustmentIndex?: number;
        message?: string;
        code?: (string | number);
    }>;
    traceId?: string;
});
type AdjustConversionsError = (unknown | {
    error?: string;
});
type ListConversionDestinationsData = {
    path: {
        /**
         * SocialAccount ID (metaads, googleads, linkedinads, tiktokads, or openaiads).
         */
        accountId: string;
    };
};
type ListConversionDestinationsResponse = ({
    platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads' | 'openaiads';
    destinations?: Array<{
        /**
         * Destination identifier. Meta: pixel ID. Google:
         * conversion action resource name. LinkedIn:
         * numeric conversion rule ID. OpenAI Ads: pixel wire
         * id.
         *
         */
        id?: string;
        name?: string;
        /**
         * Present when the platform locks event type to the
         * destination (Google conversion actions, LinkedIn
         * conversion rules).
         *
         */
        type?: string;
        status?: 'active' | 'inactive';
        /**
         * Set by adapters whose destinations are scoped to a
         * specific ad account (LinkedIn). Pass back on
         * subsequent CRUD calls.
         *
         */
        adAccountId?: string;
    }>;
});
type ListConversionDestinationsError = (unknown | {
    error?: string;
});
type CreateConversionDestinationData = {
    body: {
        /**
         * Ad account ID. For LinkedIn: numeric (e.g. "5123456") or
         * full `urn:li:sponsoredAccount:{id}` URN. For Google: numeric
         * customer ID (e.g. "1234567890") or `customers/{id}` form.
         *
         */
        adAccountId: string;
        name: string;
        /**
         * Conversion type. For LinkedIn: a unified standard event name
         * (e.g. "Purchase", "Lead", "AddToCart") or a LinkedIn rule
         * type enum (e.g. "PURCHASE", "QUALIFIED_LEAD"). For Google:
         * a unified standard event name (Purchase, Subscribe,
         * CompleteRegistration, Lead, Schedule) or a Google
         * ConversionActionCategory enum value directly (e.g.
         * "PURCHASE", "SUBSCRIBE_PAID", "SIGNUP", "IMPORTED_LEAD",
         * "BOOK_APPOINTMENT"). Unknown values pass through to the
         * platform.
         *
         */
        type: string;
        /**
         * LinkedIn only.
         */
        attributionType?: 'LAST_TOUCH_BY_CAMPAIGN' | 'LAST_TOUCH_BY_CONVERSION';
        /**
         * LinkedIn only. Default 30. 365 only allowed for LEAD,
         * PURCHASE, ADD_TO_CART, QUALIFIED_LEAD, SUBMIT_APPLICATION
         * rule types; the API rejects other combinations locally.
         *
         */
        postClickAttributionWindowSize?: 1 | 7 | 30 | 90 | 365;
        /**
         * LinkedIn only. Default 7. Same 365-day-window type
         * restriction applies as `postClickAttributionWindowSize`.
         *
         */
        viewThroughAttributionWindowSize?: 1 | 7 | 30 | 90 | 365;
        /**
         * LinkedIn only. DYNAMIC (default) uses the per-event `value`
         * from `sendConversions`. FIXED uses the rule's `value` field.
         * NO_VALUE drops monetary value entirely.
         *
         */
        valueType?: 'DYNAMIC' | 'FIXED' | 'NO_VALUE';
        /**
         * LinkedIn only. Static conversion value. Used when
         * `valueType=FIXED`. The currency should match the ad
         * account's currency.
         *
         */
        value?: {
            /**
             * ISO 4217 (e.g. "USD").
             */
            currencyCode: string;
            /**
             * Decimal string (e.g. "49.99").
             */
            amount: string;
        };
        /**
         * LinkedIn only. Controls campaign association at rule-creation
         * time:
         * - ALL_CAMPAIGNS: associate the rule with every active,
         * paused, and draft campaign in the ad account
         * - OBJECTIVE_BASED: associate only campaigns whose
         * objective matches the rule's type
         * - NONE: don't auto-associate. Manage associations via
         * the `/associations` endpoints below.
         * Note: auto-association runs once at create time; new
         * campaigns added after the rule still need explicit
         * association.
         *
         */
        autoAssociationType?: 'ALL_CAMPAIGNS' | 'OBJECTIVE_BASED' | 'NONE';
        /**
         * Google Ads only. Whether to count multiple conversions from
         * the same click (MANY_PER_CLICK) or at most one
         * (ONE_PER_CLICK). Defaults to MANY_PER_CLICK if omitted.
         *
         */
        countingType?: 'MANY_PER_CLICK' | 'ONE_PER_CLICK';
        /**
         * Google Ads only. When true, the conversion action is marked
         * as primary and immediately influences Smart Bidding. Defaults
         * to false (secondary, record-only) to avoid unintentionally
         * steering the customer's campaigns on creation.
         *
         */
        primaryForGoal?: boolean;
    };
    path: {
        /**
         * SocialAccount ID (linkedinads or googleads).
         */
        accountId: string;
    };
};
type CreateConversionDestinationResponse = ({
    platform?: 'linkedinads' | 'googleads';
    destination?: ConversionDestination;
});
type CreateConversionDestinationError = (unknown | {
    error?: string;
});
type GetConversionDestinationData = {
    path: {
        accountId: string;
        destinationId: string;
    };
    query: {
        /**
         * Numeric ID or full `urn:li:sponsoredAccount:{id}` URN.
         */
        adAccountId: string;
    };
};
type GetConversionDestinationResponse = ({
    platform?: 'linkedinads';
    destination?: ConversionDestination;
});
type GetConversionDestinationError = (unknown | {
    error?: string;
});
type UpdateConversionDestinationData = {
    body: {
        adAccountId: string;
        name?: string;
        /**
         * Setting `false` is equivalent to calling DELETE — the
         * rule will appear as `inactive` afterwards.
         *
         */
        enabled?: boolean;
        attributionType?: 'LAST_TOUCH_BY_CAMPAIGN' | 'LAST_TOUCH_BY_CONVERSION';
        /**
         * 365 only allowed for LEAD, PURCHASE, ADD_TO_CART,
         * QUALIFIED_LEAD, SUBMIT_APPLICATION rule types.
         *
         */
        postClickAttributionWindowSize?: 1 | 7 | 30 | 90 | 365;
        /**
         * 365 only allowed for LEAD, PURCHASE, ADD_TO_CART,
         * QUALIFIED_LEAD, SUBMIT_APPLICATION rule types.
         *
         */
        viewThroughAttributionWindowSize?: 1 | 7 | 30 | 90 | 365;
        valueType?: 'DYNAMIC' | 'FIXED' | 'NO_VALUE';
        /**
         * Used when `valueType=FIXED`.
         */
        value?: {
            /**
             * ISO 4217.
             */
            currencyCode?: string;
            /**
             * Decimal string (e.g. "49.99").
             */
            amount?: string;
        };
    };
    path: {
        accountId: string;
        destinationId: string;
    };
};
type UpdateConversionDestinationResponse = ({
    platform?: 'linkedinads';
    destination?: ConversionDestination;
});
type UpdateConversionDestinationError = (unknown | {
    error?: string;
});
type DeleteConversionDestinationData = {
    path: {
        accountId: string;
        destinationId: string;
    };
    query?: {
        /**
         * Required as query OR in JSON body.
         */
        adAccountId?: string;
    };
};
type DeleteConversionDestinationResponse = (void);
type DeleteConversionDestinationError = (unknown | {
    error?: string;
});
type ListConversionAssociationsData = {
    path: {
        accountId: string;
        destinationId: string;
    };
    query: {
        adAccountId: string;
    };
};
type ListConversionAssociationsResponse = ({
    platform?: 'linkedinads';
    associations?: Array<{
        campaignId?: string;
        conversionId?: string;
        /**
         * Epoch ms.
         */
        associatedAt?: number;
    }>;
});
type ListConversionAssociationsError = (unknown | {
    error?: string;
});
type AddConversionAssociationsData = {
    body: {
        adAccountId: string;
        campaignIds: Array<(string)>;
    };
    path: {
        accountId: string;
        destinationId: string;
    };
};
type AddConversionAssociationsResponse = ({
    platform?: 'linkedinads';
    /**
     * Numeric campaign IDs that were successfully associated.
     */
    succeeded?: Array<(string)>;
    failed?: Array<{
        campaignId?: string;
        reason?: string;
    }>;
});
type AddConversionAssociationsError = (unknown | {
    error?: string;
});
type RemoveConversionAssociationsData = {
    path: {
        accountId: string;
        destinationId: string;
    };
    query: {
        adAccountId: string;
        /**
         * Comma-separated list of campaign IDs.
         */
        campaignIds: string;
    };
};
type RemoveConversionAssociationsResponse = ({
    platform?: 'linkedinads';
    /**
     * Numeric campaign IDs that were successfully removed.
     */
    succeeded?: Array<(string)>;
    failed?: Array<{
        campaignId?: string;
        reason?: string;
    }>;
});
type RemoveConversionAssociationsError = (unknown | {
    error?: string;
});
type GetConversionMetricsData = {
    path: {
        accountId: string;
        destinationId: string;
    };
    query: {
        adAccountId: string;
        endDate?: string;
        granularity?: 'ALL' | 'DAILY' | 'MONTHLY' | 'YEARLY';
        startDate: string;
    };
};
type GetConversionMetricsResponse = ({
    platform?: 'linkedinads';
    granularity?: 'ALL' | 'DAILY' | 'MONTHLY' | 'YEARLY';
    rows?: Array<{
        /**
         * YYYY-MM-DD
         */
        start?: string;
        /**
         * YYYY-MM-DD (inclusive)
         */
        end?: string;
        metrics?: {
            [key: string]: (number | string);
        };
    }>;
});
type GetConversionMetricsError = (unknown | {
    error?: string;
});
type ListWhatsAppConversionsData = {
    query: {
        /**
         * WhatsApp social account ID
         */
        accountId: string;
        /**
         * Max events to return (1-200, default 50).
         */
        limit?: number;
    };
};
type ListWhatsAppConversionsResponse = ({
    events?: Array<{
        /**
         * When the event was sent to Meta.
         */
        timestamp?: string;
        /**
         * One of LeadSubmitted, Purchase, AddToCart, InitiateCheckout, ViewContent.
         */
        eventName?: string;
        conversationId?: (string) | null;
        /**
         * Number of events Meta accepted on this send (usually 1).
         */
        eventsReceived?: (number) | null;
        /**
         * Number of events Meta rejected (usually 0).
         */
        eventsFailed?: (number) | null;
        /**
         * Meta fbtrace_id for cross-referencing in Events Manager.
         */
        traceId?: (string) | null;
        durationMs?: (number) | null;
    }>;
});
type ListWhatsAppConversionsError = ({
    error?: string;
} | unknown);
type SendWhatsAppConversionData = {
    body: {
        /**
         * WhatsApp SocialAccount ID.
         */
        accountId: string;
        /**
         * Live-verified allowlist of event names accepted by Meta's
         * CAPI for Business Messaging (Graph API v25.0). Other
         * standard pixel events including `Lead`,
         * `CompleteRegistration`, `Subscribe`, `Schedule`, `Contact`,
         * `StartTrial`, `AddPaymentInfo`, `Search`, and
         * `SubmitApplication` are rejected with subcode 2804066
         * ("Messaging Event Invalid Event Type") on
         * `action_source = business_messaging` events. Custom event
         * names are also rejected.
         *
         * Use `LeadSubmitted` (NOT `Lead`) for lead-style conversions.
         *
         */
        eventName: 'LeadSubmitted' | 'Purchase' | 'AddToCart' | 'InitiateCheckout' | 'ViewContent';
        /**
         * Unix seconds. Defaults to the time of the request when
         * omitted. Meta's attribution window is 7 days from click;
         * events older than that lose attribution.
         *
         */
        eventTime?: number;
        /**
         * Stable dedup key. Reuse to suppress duplicate events
         * (Meta dedupes against pixel events with the same id).
         *
         */
        eventId: string;
        /**
         * Zernio Conversation `_id` (preferred lookup). The
         * conversation must have a captured `ctwa_clid` in metadata
         * (set automatically by the WhatsApp webhook on the first
         * inbound message after a CTWA ad click).
         *
         */
        conversationId?: string;
        /**
         * Contact phone number, digits only with no '+'. When used
         * in lieu of `conversationId`, the handler resolves to the
         * most recent CTWA-attributed conversation for this phone
         * on the supplied account.
         *
         */
        phoneE164?: string;
        /**
         * Conversion value (e.g. order total).
         */
        value?: number;
        /**
         * ISO 4217 currency code (e.g. `USD`).
         */
        currency?: string;
        /**
         * Optional product / content identifiers.
         */
        contentIds?: Array<(string)>;
        /**
         * User email. Normalized + SHA-256 hashed before sending to Meta.
         */
        email?: string;
        /**
         * Stable customer identifier. Lowercased + SHA-256 hashed
         * before sending to Meta.
         *
         */
        externalId?: string;
        /**
         * Meta `test_event_code` passthrough. Routes the event to
         * the Test Events tab in Events Manager instead of the
         * production dataset, useful for development.
         *
         */
        testCode?: string;
    };
};
type SendWhatsAppConversionResponse = ({
    platform?: 'metaads';
    /**
     * Events accepted by Meta.
     */
    eventsReceived?: number;
    /**
     * Events rejected by Meta (see failures).
     */
    eventsFailed?: number;
    /**
     * Per-event failure detail. Empty when all events were
     * accepted.
     *
     */
    failures?: Array<{
        /**
         * Index into the submitted events array.
         */
        eventIndex?: number;
        /**
         * Echoes back the eventId of the failed event.
         */
        eventId?: string;
        message?: string;
        code?: (string | number);
    }>;
    /**
     * Meta `fbtrace_id` for debugging. Surface in support
     * tickets.
     *
     */
    traceId?: string;
});
type SendWhatsAppConversionError = (unknown | {
    error?: string;
});
type CreateMessagingAdData = {
    body: (CtwaAdRequestBody & {
        /**
         * Where the conversation opens when the ad is tapped.
         */
        destination: 'whatsapp' | 'messenger' | 'instagram_direct';
    });
};
type CreateMessagingAdResponse = (unknown);
type CreateMessagingAdError = (unknown | {
    error?: string;
});
type CreateCallAdData = {
    body: (CtwaAdRequestBody & {
        /**
         * E.164 number the CALL_NOW CTA dials (e.g. +34600111222).
         */
        phoneNumber: string;
        /**
         * Website shown as the creative's link. Required: Meta rejects tel: as link_data.link; the phone number rides only the CTA.
         */
        linkUrl: string;
    });
};
type CreateCallAdResponse = (unknown);
type CreateCallAdError = (unknown | {
    error?: string;
});
type CreateCtwaAdData = {
    body: CtwaAdRequestBody;
};
type CreateCtwaAdResponse = ((CtwaSingleResponse | CtwaMultiResponse));
type CreateCtwaAdError = (unknown | {
    error?: string;
});
type ListCustomConversionsData = {
    path: {
        /**
         * Meta ads SocialAccount id.
         */
        accountId: string;
    };
    query: {
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
    };
};
type ListCustomConversionsResponse = ({
    adAccountId?: string;
    data?: Array<CustomConversion>;
});
type ListCustomConversionsError = (unknown | {
    error?: string;
});
type CreateCustomConversionData = {
    body: {
        /**
         * Meta ad account id (act_<n>).
         */
        adAccountId: string;
        /**
         * Also the reuse key, together with pixelId.
         */
        name: string;
        /**
         * Meta pixel id (event_source_id). From GET /v1/accounts/{accountId}/tracking-tags.
         */
        pixelId: string;
        /**
         * Meta custom_event_type, e.g. LEAD, PURCHASE, OTHER.
         */
        customEventType: string;
        /**
         * Meta conversion rule, forwarded verbatim.
         */
        rule: {
            [key: string]: unknown;
        };
    };
    path: {
        /**
         * Meta ads SocialAccount id.
         */
        accountId: string;
    };
};
type CreateCustomConversionResponse = (CustomConversionResult);
type CreateCustomConversionError = (unknown | {
    error?: string;
});
type ListTrackingTagsData = {
    path: {
        /**
         * Ads SocialAccount id (platform `metaads` or `openaiads`).
         */
        accountId: string;
    };
    query?: {
        /**
         * Optional, Meta only. Scope to one ad account, e.g. `act_123456789`. Ignored for OpenAI Ads.
         */
        adAccountId?: string;
    };
};
type ListTrackingTagsResponse = ({
    platform?: 'metaads' | 'openaiads';
    tags?: Array<TrackingTag>;
});
type ListTrackingTagsError = (unknown | {
    error?: string;
});
type CreateTrackingTagData = {
    body: {
        /**
         * Meta ad account id, e.g. `act_123456789`. Required by this endpoint but ignored for OpenAI Ads.
         */
        adAccountId: string;
        name: string;
    };
    path: {
        /**
         * Ads SocialAccount id (platform `metaads` or `openaiads`).
         */
        accountId: string;
    };
};
type CreateTrackingTagResponse = ({
    platform?: 'metaads' | 'openaiads';
    tag?: TrackingTag;
});
type CreateTrackingTagError = (unknown | {
    error?: string;
});
type GetTrackingTagData = {
    path: {
        accountId: string;
        /**
         * Pixel id.
         */
        tagId: string;
    };
};
type GetTrackingTagResponse = ({
    platform?: 'metaads';
    tag?: TrackingTag;
});
type GetTrackingTagError = ({
    error?: string;
} | unknown);
type UpdateTrackingTagData = {
    body: {
        name?: string;
        /**
         * Meta Advanced Matching toggle (`enable_automatic_matching`).
         */
        enableAutomaticMatching?: boolean;
        /**
         * Which user fields Advanced Matching may collect. Meta's
         * terse codes: em=email, ph=phone, fn=first name, ln=last
         * name, ge=gender, db=date of birth, ct=city, st=state,
         * zp=zip.
         *
         */
        automaticMatchingFields?: Array<('em' | 'ph' | 'fn' | 'ln' | 'ge' | 'db' | 'ct' | 'st' | 'zp' | 'country' | 'external_id')>;
        firstPartyCookieStatus?: 'empty' | 'first_party_cookie_disabled' | 'first_party_cookie_enabled';
        dataUseSetting?: 'advertising_and_analytics' | 'analytics_only' | 'empty';
    };
    path: {
        accountId: string;
        /**
         * Pixel id.
         */
        tagId: string;
    };
};
type UpdateTrackingTagResponse = ({
    platform?: 'metaads';
    tag?: TrackingTag;
});
type UpdateTrackingTagError = (unknown | {
    error?: string;
});
type ListTrackingTagSharedAccountsData = {
    path: {
        accountId: string;
        /**
         * Pixel id.
         */
        tagId: string;
    };
};
type ListTrackingTagSharedAccountsResponse = ({
    platform?: 'metaads';
    sharedAccounts?: Array<SharedAdAccount>;
});
type ListTrackingTagSharedAccountsError = ({
    error?: string;
} | unknown);
type AddTrackingTagSharedAccountData = {
    body: {
        /**
         * Ad account to share with, e.g. `act_123456789`.
         */
        adAccountId: string;
    };
    path: {
        accountId: string;
        /**
         * Pixel id.
         */
        tagId: string;
    };
};
type AddTrackingTagSharedAccountResponse = ({
    platform?: 'metaads';
    ok?: boolean;
});
type AddTrackingTagSharedAccountError = (unknown | {
    error?: string;
});
type RemoveTrackingTagSharedAccountData = {
    path: {
        accountId: string;
        /**
         * Pixel id.
         */
        tagId: string;
    };
    query?: {
        /**
         * Ad account to unshare, e.g. `act_123456789`. May also be sent in the JSON body.
         */
        adAccountId?: string;
    };
};
type RemoveTrackingTagSharedAccountResponse = (void);
type RemoveTrackingTagSharedAccountError = (unknown | {
    error?: string;
});
type GetTrackingTagStatsData = {
    path: {
        accountId: string;
        /**
         * Pixel id.
         */
        tagId: string;
    };
    query?: {
        /**
         * Aggregation dimension. Defaults to `event`.
         */
        aggregation?: 'event' | 'host' | 'url' | 'url_by_rule' | 'pixel_fire' | 'device_type' | 'device_os' | 'browser_type' | 'had_pii' | 'custom_data_field' | 'match_keys' | 'event_source' | 'event_detection_method' | 'event_processing_results' | 'event_total_counts' | 'event_value_count';
        /**
         * Unix seconds upper bound.
         */
        endTime?: number;
        /**
         * Unix seconds lower bound.
         */
        startTime?: number;
    };
};
type GetTrackingTagStatsResponse = ({
    platform?: 'metaads';
    stats?: {
        aggregation?: string;
        startTime?: number;
        endTime?: number;
        rows?: Array<{
            [key: string]: unknown;
        }>;
    };
});
type GetTrackingTagStatsError = (unknown | {
    error?: string;
});
type ListBlogsData = {
    path: {
        /**
         * Connected Shopify SocialAccount id.
         */
        accountId: string;
    };
    query?: {
        /**
         * Opaque cursor from a previous response. Omit for the first page.
         */
        cursor?: string;
        /**
         * Page size (1-50).
         */
        limit?: number;
    };
};
type ListBlogsResponse = ({
    platform?: 'shopify';
    blogs?: Array<Blog>;
    /**
     * Cursor for the next page; null when there are no more pages.
     */
    nextCursor?: (string) | null;
});
type ListBlogsError = (ErrorResponse | {
    error?: string;
} | unknown);
type CreateBlogData = {
    body: {
        title: string;
        /**
         * URL slug. Generated from the title when omitted.
         */
        handle?: string;
    };
    path: {
        /**
         * Connected Shopify SocialAccount id.
         */
        accountId: string;
    };
};
type CreateBlogResponse = ({
    platform?: 'shopify';
    blog?: Blog;
});
type CreateBlogError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetBlogData = {
    path: {
        /**
         * Connected Shopify SocialAccount id.
         */
        accountId: string;
        /**
         * Platform-native numeric blog id. Non-numeric values return 400.
         */
        blogId: string;
    };
};
type GetBlogResponse = ({
    platform?: 'shopify';
    blog?: Blog;
});
type GetBlogError = (ErrorResponse | {
    error?: string;
} | unknown);
type UpdateBlogData = {
    body: {
        title?: string;
        /**
         * URL slug. Changing it changes the blog URL on the store.
         */
        handle?: string;
    };
    path: {
        /**
         * Connected Shopify SocialAccount id.
         */
        accountId: string;
        /**
         * Platform-native numeric blog id. Non-numeric values return 400.
         */
        blogId: string;
    };
};
type UpdateBlogResponse = ({
    platform?: 'shopify';
    blog?: Blog;
});
type UpdateBlogError = (ErrorResponse | {
    error?: string;
} | unknown);
type DeleteBlogData = {
    path: {
        /**
         * Connected Shopify SocialAccount id.
         */
        accountId: string;
        /**
         * Platform-native numeric blog id. Non-numeric values return 400.
         */
        blogId: string;
    };
};
type DeleteBlogResponse = (void);
type DeleteBlogError = (ErrorResponse | {
    error?: string;
} | unknown);
type ListBlogArticlesData = {
    path: {
        /**
         * Connected Shopify SocialAccount id.
         */
        accountId: string;
        /**
         * Platform-native numeric blog id. Non-numeric values return 400.
         */
        blogId: string;
    };
    query?: {
        /**
         * Opaque cursor from a previous response. Omit for the first page.
         */
        cursor?: string;
        /**
         * Page size (1-50).
         */
        limit?: number;
    };
};
type ListBlogArticlesResponse = ({
    platform?: 'shopify';
    articles?: Array<BlogArticle>;
    /**
     * Cursor for the next page; null when there are no more pages.
     */
    nextCursor?: (string) | null;
});
type ListBlogArticlesError = (ErrorResponse | {
    error?: string;
} | unknown);
type CreateBlogArticleData = {
    body: {
        title: string;
        /**
         * Article body as HTML.
         */
        bodyHtml?: string;
        /**
         * URL slug. Generated from the title when omitted.
         */
        handle?: string;
        tags?: Array<(string)>;
        /**
         * Display name of the article author.
         */
        author?: string;
        /**
         * Short summary shown in blog listings.
         */
        excerpt?: string;
        /**
         * Featured image. The platform downloads it, so the URL must be publicly reachable.
         */
        image?: {
            url: string;
            altText?: string;
        };
        /**
         * Search-engine overrides. Maps to Shopify global metafields (title_tag and description_tag).
         */
        seo?: {
            title?: string;
            description?: string;
        };
        /**
         * Set false to create the article as a draft.
         */
        isPublished?: boolean;
        /**
         * ISO 8601 datetime with offset (or Z). A future date schedules publication natively on the platform.
         */
        publishDate?: string;
    };
    path: {
        /**
         * Connected Shopify SocialAccount id.
         */
        accountId: string;
        /**
         * Platform-native numeric blog id. Non-numeric values return 400.
         */
        blogId: string;
    };
};
type CreateBlogArticleResponse = ({
    platform?: 'shopify';
    article?: BlogArticle;
});
type CreateBlogArticleError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetBlogArticleData = {
    path: {
        /**
         * Connected Shopify SocialAccount id.
         */
        accountId: string;
        /**
         * Platform-native numeric article id. Non-numeric values return 400.
         */
        articleId: string;
        /**
         * Platform-native numeric blog id. Non-numeric values return 400.
         */
        blogId: string;
    };
};
type GetBlogArticleResponse = ({
    platform?: 'shopify';
    article?: BlogArticle;
});
type GetBlogArticleError = (ErrorResponse | {
    error?: string;
} | unknown);
type UpdateBlogArticleData = {
    body: {
        title?: string;
        /**
         * Article body as HTML.
         */
        bodyHtml?: string;
        /**
         * URL slug of the article.
         */
        handle?: string;
        /**
         * Replaces the full tag list.
         */
        tags?: Array<(string)>;
        /**
         * Display name of the article author.
         */
        author?: string;
        /**
         * Short summary shown in blog listings.
         */
        excerpt?: string;
        /**
         * Featured image. The platform downloads it, so the URL must be publicly reachable.
         */
        image?: {
            url: string;
            altText?: string;
        };
        /**
         * Search-engine overrides. Maps to Shopify global metafields (title_tag and description_tag).
         */
        seo?: {
            title?: string;
            description?: string;
        };
        /**
         * Set false to unpublish the article back to a draft.
         */
        isPublished?: boolean;
        /**
         * ISO 8601 datetime with offset (or Z). A future date schedules publication natively on the platform.
         */
        publishDate?: string;
    };
    path: {
        /**
         * Connected Shopify SocialAccount id.
         */
        accountId: string;
        /**
         * Platform-native numeric article id. Non-numeric values return 400.
         */
        articleId: string;
        /**
         * Platform-native numeric blog id. Non-numeric values return 400.
         */
        blogId: string;
    };
};
type UpdateBlogArticleResponse = ({
    platform?: 'shopify';
    article?: BlogArticle;
});
type UpdateBlogArticleError = (ErrorResponse | {
    error?: string;
} | unknown);
type DeleteBlogArticleData = {
    path: {
        /**
         * Connected Shopify SocialAccount id.
         */
        accountId: string;
        /**
         * Platform-native numeric article id. Non-numeric values return 400.
         */
        articleId: string;
        /**
         * Platform-native numeric blog id. Non-numeric values return 400.
         */
        blogId: string;
    };
};
type DeleteBlogArticleResponse = (void);
type DeleteBlogArticleError = (ErrorResponse | {
    error?: string;
} | unknown);
type CreateVerificationData = {
    body: {
        /**
         * SMS-only for now.
         */
        channel: 'sms';
        /**
         * E.164 phone number.
         */
        to: string;
        /**
         * The SMS-enabled number on your account to send from. Defaults to your only SMS number.
         */
        from?: string;
        /**
         * Your app or business name, rendered in the message. Defaults to your account name. Letters, numbers, and basic punctuation only.
         */
        brandName?: string;
        codeLength?: number;
        ttlMinutes?: number;
    };
};
type CreateVerificationResponse = (Verification);
type CreateVerificationError = (ErrorResponse | {
    error?: string;
} | unknown);
type GetVerificationData = {
    path: {
        verificationId: string;
    };
};
type GetVerificationResponse = (Verification);
type GetVerificationError = (ErrorResponse | {
    error?: string;
} | unknown);
type CheckVerificationData = {
    body: {
        code: string;
    };
    path: {
        verificationId: string;
    };
};
type CheckVerificationResponse = ((Verification & {
    valid?: boolean;
}));
type CheckVerificationError = (ErrorResponse | {
    error?: string;
} | unknown);

export { type AccountWithFollowerStats, type AccountsListResponse, type ActivateSequenceData, type ActivateSequenceError, type ActivateSequenceResponse, type ActivateWorkflowData, type ActivateWorkflowError, type ActivateWorkflowResponse, type Ad, type AdAnalyticsResponse, type AdBudget, type AdCampaign, type AdDailyMetrics, type AdEngagementCounts, type AdFunnelCounts, type AdMetrics, type AdReviewStatus, type AdStatus, type AdTreeAdSet, type AdTreeCampaign, type AdTreeResponse, type AddBroadcastRecipientsData, type AddBroadcastRecipientsError, type AddBroadcastRecipientsResponse, type AddConversionAssociationsData, type AddConversionAssociationsError, type AddConversionAssociationsResponse, type AddDiscordMemberRoleData, type AddDiscordMemberRoleError, type AddDiscordMemberRoleResponse, type AddMessageReactionData, type AddMessageReactionError, type AddMessageReactionResponse, type AddTrackingTagSharedAccountData, type AddTrackingTagSharedAccountError, type AddTrackingTagSharedAccountResponse, type AddUsersToAdAudienceData, type AddUsersToAdAudienceError, type AddUsersToAdAudienceResponse, type AddWhatsAppGroupParticipantsData, type AddWhatsAppGroupParticipantsError, type AddWhatsAppGroupParticipantsResponse, type AdjustConversionsData, type AdjustConversionsError, type AdjustConversionsResponse, type AdsListResponse, type AdsTimelineResponse, type AnalyticsListResponse, type AnalyticsOverview, type AnalyticsSinglePostResponse, type ApiKey, type AppealSmsRegistrationData, type AppealSmsRegistrationError, type AppealSmsRegistrationResponse, type ApproveWhatsAppGroupJoinRequestsData, type ApproveWhatsAppGroupJoinRequestsError, type ApproveWhatsAppGroupJoinRequestsResponse, type ArchiveLeadFormData, type ArchiveLeadFormError, type ArchiveLeadFormResponse, type AssignGoogleBusinessLocationData, type AssignGoogleBusinessLocationError, type AssignGoogleBusinessLocationResponse, type BatchGetGoogleBusinessReviewsData, type BatchGetGoogleBusinessReviewsError, type BatchGetGoogleBusinessReviewsResponse, type BidStrategy, type BillingSnapshot, type BlockWhatsAppUsersData, type BlockWhatsAppUsersError, type BlockWhatsAppUsersResponse, type Blog, type BlogArticle, type BlueskyPlatformData, type BookmarkPostData, type BookmarkPostError, type BookmarkPostResponse, type BoostPostData, type BoostPostError, type BoostPostResponse, type BulkCreateContactsData, type BulkCreateContactsError, type BulkCreateContactsResponse, type BulkUpdateAdCampaignStatusData, type BulkUpdateAdCampaignStatusError, type BulkUpdateAdCampaignStatusResponse, type BulkUploadPostsData, type BulkUploadPostsError, type BulkUploadPostsResponse, type BulkUploadResult, type BusinessCenter, type CallRecord, type CampaignAnalyticsResponse, type CancelBroadcastData, type CancelBroadcastError, type CancelBroadcastResponse, type CancelPhoneNumberPortInData, type CancelPhoneNumberPortInError, type CancelPhoneNumberPortInResponse, type CancelRfReservationData, type CancelRfReservationError, type CancelRfReservationResponse, type CheckPhoneNumberAvailabilityData, type CheckPhoneNumberAvailabilityError, type CheckPhoneNumberAvailabilityResponse, type CheckPhoneNumberPortabilityData, type CheckPhoneNumberPortabilityError, type CheckPhoneNumberPortabilityResponse, type CheckVerificationData, type CheckVerificationError, type CheckVerificationResponse, type CheckWhatsAppNumberAvailabilityData, type CheckWhatsAppNumberAvailabilityError, type CheckWhatsAppNumberAvailabilityResponse, type ClearContactFieldValueData, type ClearContactFieldValueError, type ClearContactFieldValueResponse, type ClientOptions, type CommentAutomationAudience, type CommentAutomationFollowGate, type CommentAutomationTemplate, type CommentAutomationTemplateElement, type CompleteGoogleBusinessVerificationData, type CompleteGoogleBusinessVerificationError, type CompleteGoogleBusinessVerificationResponse, type CompleteTelegramConnectData, type CompleteTelegramConnectError, type CompleteTelegramConnectResponse, type CompleteWhatsAppPhoneSelectionData, type CompleteWhatsAppPhoneSelectionError, type CompleteWhatsAppPhoneSelectionResponse, type ConfigureTikTokAdsBrandIdentityData, type ConfigureTikTokAdsBrandIdentityError, type ConfigureTikTokAdsBrandIdentityResponse, type ConnectAdsData, type ConnectAdsError, type ConnectAdsResponse, type ConnectBlueskyCredentialsData, type ConnectBlueskyCredentialsError, type ConnectBlueskyCredentialsResponse, type ConnectOpenAiAdsCredentialsData, type ConnectOpenAiAdsCredentialsError, type ConnectOpenAiAdsCredentialsResponse, type ConnectShopifyWithTokenData, type ConnectShopifyWithTokenError, type ConnectShopifyWithTokenResponse, type ConnectWhatsAppCredentialsData, type ConnectWhatsAppCredentialsError, type ConnectWhatsAppCredentialsResponse, type ConnectedApp, type ConversionDestination, type ConversionEvent, type CreateAccountGroupData, type CreateAccountGroupError, type CreateAccountGroupResponse, type CreateAdAudienceData, type CreateAdAudienceError, type CreateAdAudienceResponse, type CreateAdCampaignData, type CreateAdCampaignError, type CreateAdCampaignResponse, type CreateAdCreativeData, type CreateAdCreativeError, type CreateAdCreativeResponse, type CreateAdInsightsReportData, type CreateAdInsightsReportError, type CreateAdInsightsReportResponse, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyResponse, type CreateBlogArticleData, type CreateBlogArticleError, type CreateBlogArticleResponse, type CreateBlogData, type CreateBlogError, type CreateBlogResponse, type CreateBroadcastData, type CreateBroadcastError, type CreateBroadcastResponse, type CreateCallAdData, type CreateCallAdError, type CreateCallAdResponse, type CreateCommentAutomationData, type CreateCommentAutomationError, type CreateCommentAutomationResponse, type CreateContactData, type CreateContactError, type CreateContactResponse, type CreateConversionDestinationData, type CreateConversionDestinationError, type CreateConversionDestinationResponse, type CreateCtwaAdData, type CreateCtwaAdError, type CreateCtwaAdResponse, type CreateCustomConversionData, type CreateCustomConversionError, type CreateCustomConversionResponse, type CreateCustomFieldData, type CreateCustomFieldError, type CreateCustomFieldResponse, type CreateDiscordGuildRoleData, type CreateDiscordGuildRoleError, type CreateDiscordGuildRoleResponse, type CreateDiscordScheduledEventData, type CreateDiscordScheduledEventError, type CreateDiscordScheduledEventResponse, type CreateDiscordThreadData, type CreateDiscordThreadError, type CreateDiscordThreadResponse, type CreateGoogleBusinessMediaData, type CreateGoogleBusinessMediaError, type CreateGoogleBusinessMediaResponse, type CreateGoogleBusinessPlaceActionData, type CreateGoogleBusinessPlaceActionError, type CreateGoogleBusinessPlaceActionResponse, type CreateHighDemandPeriodData, type CreateHighDemandPeriodError, type CreateHighDemandPeriodResponse, type CreateInboxConversationData, type CreateInboxConversationError, type CreateInboxConversationResponse, type CreateInviteTokenData, type CreateInviteTokenError, type CreateInviteTokenResponse, type CreateLeadFormData, type CreateLeadFormError, type CreateLeadFormResponse, type CreateMessagingAdData, type CreateMessagingAdError, type CreateMessagingAdResponse, type CreatePhoneNumberKycLinkData, type CreatePhoneNumberKycLinkError, type CreatePhoneNumberKycLinkResponse, type CreatePhoneNumberPortInData, type CreatePhoneNumberPortInError, type CreatePhoneNumberPortInResponse, type CreatePinterestBoardData, type CreatePinterestBoardError, type CreatePinterestBoardResponse, type CreatePostData, type CreatePostError, type CreatePostResponse, type CreateProfileData, type CreateProfileError, type CreateProfileResponse, type CreateQueueSlotData, type CreateQueueSlotError, type CreateQueueSlotResponse, type CreateRfPredictionData, type CreateRfPredictionError, type CreateRfPredictionResponse, type CreateSequenceData, type CreateSequenceError, type CreateSequenceResponse, type CreateSmsSenderIdData, type CreateSmsSenderIdError, type CreateSmsSenderIdResponse, type CreateStandaloneAdData, type CreateStandaloneAdError, type CreateStandaloneAdResponse, type CreateTestLeadData, type CreateTestLeadError, type CreateTestLeadResponse, type CreateTrackingTagData, type CreateTrackingTagError, type CreateTrackingTagResponse, type CreateValueRuleSetData, type CreateValueRuleSetError, type CreateValueRuleSetResponse, type CreateVerificationData, type CreateVerificationError, type CreateVerificationResponse, type CreateVoiceCallData, type CreateVoiceCallError, type CreateVoiceCallResponse, type CreateVoiceWebSessionError, type CreateVoiceWebSessionResponse, type CreateWebhookSettingsData, type CreateWebhookSettingsError, type CreateWebhookSettingsResponse, type CreateWhatsAppDatasetData, type CreateWhatsAppDatasetError, type CreateWhatsAppDatasetResponse, type CreateWhatsAppFlowData, type CreateWhatsAppFlowError, type CreateWhatsAppFlowResponse, type CreateWhatsAppGroupChatData, type CreateWhatsAppGroupChatError, type CreateWhatsAppGroupChatResponse, type CreateWhatsAppGroupInviteLinkData, type CreateWhatsAppGroupInviteLinkError, type CreateWhatsAppGroupInviteLinkResponse, type CreateWhatsAppNumberKycLinkData, type CreateWhatsAppNumberKycLinkError, type CreateWhatsAppNumberKycLinkResponse, type CreateWhatsAppSandboxSessionData, type CreateWhatsAppSandboxSessionError, type CreateWhatsAppSandboxSessionResponse, type CreateWhatsAppTemplateData, type CreateWhatsAppTemplateError, type CreateWhatsAppTemplateResponse, type CreateWorkflowData, type CreateWorkflowError, type CreateWorkflowResponse, type CrosspostDiscordMessageData, type CrosspostDiscordMessageError, type CrosspostDiscordMessageResponse, type CtwaAdRequestBody, type CtwaMultiResponse, type CtwaSingleResponse, type CustomConversion, type CustomConversionResult, type DeactivateSmsRegistrationData, type DeactivateSmsRegistrationError, type DeactivateSmsRegistrationResponse, type DeleteAccountData, type DeleteAccountError, type DeleteAccountGroupData, type DeleteAccountGroupError, type DeleteAccountGroupResponse, type DeleteAccountResponse, type DeleteAdAudienceData, type DeleteAdAudienceError, type DeleteAdAudienceResponse, type DeleteAdCampaignData, type DeleteAdCampaignError, type DeleteAdCampaignResponse, type DeleteAdCreativeData, type DeleteAdCreativeError, type DeleteAdCreativeResponse, type DeleteAdData, type DeleteAdError, type DeleteAdResponse, type DeleteApiKeyData, type DeleteApiKeyError, type DeleteApiKeyResponse, type DeleteBlogArticleData, type DeleteBlogArticleError, type DeleteBlogArticleResponse, type DeleteBlogData, type DeleteBlogError, type DeleteBlogResponse, type DeleteBroadcastData, type DeleteBroadcastError, type DeleteBroadcastResponse, type DeleteCommentAutomationData, type DeleteCommentAutomationError, type DeleteCommentAutomationResponse, type DeleteContactData, type DeleteContactError, type DeleteContactResponse, type DeleteConversionDestinationData, type DeleteConversionDestinationError, type DeleteConversionDestinationResponse, type DeleteCustomFieldData, type DeleteCustomFieldError, type DeleteCustomFieldResponse, type DeleteDiscordGuildRoleData, type DeleteDiscordGuildRoleError, type DeleteDiscordGuildRoleResponse, type DeleteDiscordMessageData, type DeleteDiscordMessageError, type DeleteDiscordMessageResponse, type DeleteDiscordScheduledEventData, type DeleteDiscordScheduledEventError, type DeleteDiscordScheduledEventResponse, type DeleteGoogleBusinessMediaData, type DeleteGoogleBusinessMediaError, type DeleteGoogleBusinessMediaResponse, type DeleteGoogleBusinessPlaceActionData, type DeleteGoogleBusinessPlaceActionError, type DeleteGoogleBusinessPlaceActionResponse, type DeleteGoogleBusinessReviewReplyData, type DeleteGoogleBusinessReviewReplyError, type DeleteGoogleBusinessReviewReplyResponse, type DeleteInboxCommentData, type DeleteInboxCommentError, type DeleteInboxCommentResponse, type DeleteInboxMessageData, type DeleteInboxMessageError, type DeleteInboxMessageResponse, type DeleteInboxReviewReplyData, type DeleteInboxReviewReplyError, type DeleteInboxReviewReplyResponse, type DeleteInstagramIceBreakersData, type DeleteInstagramIceBreakersError, type DeleteInstagramIceBreakersResponse, type DeleteMessengerMenuData, type DeleteMessengerMenuError, type DeleteMessengerMenuResponse, type DeletePostData, type DeletePostError, type DeletePostResponse, type DeleteProfileData, type DeleteProfileError, type DeleteProfileResponse, type DeleteQueueSlotData, type DeleteQueueSlotError, type DeleteQueueSlotResponse, type DeleteSequenceData, type DeleteSequenceError, type DeleteSequenceResponse, type DeleteSmsSenderIdData, type DeleteSmsSenderIdError, type DeleteSmsSenderIdResponse, type DeleteTelegramCommandsData, type DeleteTelegramCommandsError, type DeleteTelegramCommandsResponse, type DeleteValueRuleSetData, type DeleteValueRuleSetError, type DeleteValueRuleSetResponse, type DeleteWebhookSettingsData, type DeleteWebhookSettingsError, type DeleteWebhookSettingsResponse, type DeleteWhatsAppFlowData, type DeleteWhatsAppFlowError, type DeleteWhatsAppFlowResponse, type DeleteWhatsAppGroupChatData, type DeleteWhatsAppGroupChatError, type DeleteWhatsAppGroupChatResponse, type DeleteWhatsAppSandboxSessionData, type DeleteWhatsAppSandboxSessionError, type DeleteWhatsAppSandboxSessionResponse, type DeleteWhatsAppTemplateData, type DeleteWhatsAppTemplateError, type DeleteWhatsAppTemplateResponse, type DeleteWhatsappBusinessUsernameData, type DeleteWhatsappBusinessUsernameError, type DeleteWhatsappBusinessUsernameResponse, type DeleteWorkflowData, type DeleteWorkflowError, type DeleteWorkflowResponse, type DeprecateWhatsAppFlowData, type DeprecateWhatsAppFlowError, type DeprecateWhatsAppFlowResponse, type DialVoiceWebCallData, type DialVoiceWebCallError, type DialVoiceWebCallResponse, type DisableSmsOnNumberData, type DisableSmsOnNumberError, type DisableSmsOnNumberResponse, type DisableVoiceOnNumberData, type DisableVoiceOnNumberError, type DisableVoiceOnNumberResponse, type DisableWhatsAppCallingData, type DisableWhatsAppCallingError, type DisableWhatsAppCallingLegacyData, type DisableWhatsAppCallingLegacyError, type DisableWhatsAppCallingLegacyResponse, type DisableWhatsAppCallingResponse, type DiscordGuildMember, type DiscordPlatformData, type DiscordRole, type DiscordScheduledEvent, type DmButton, type DuplicateAdCampaignData, type DuplicateAdCampaignError, type DuplicateAdCampaignResponse, type DuplicateAdData, type DuplicateAdError, type DuplicateAdResponse, type DuplicateAdSetData, type DuplicateAdSetError, type DuplicateAdSetResponse, type DuplicateWorkflowData, type DuplicateWorkflowError, type DuplicateWorkflowResponse, type EditDiscordGuildRoleData, type EditDiscordGuildRoleError, type EditDiscordGuildRoleResponse, type EditInboxCommentData, type EditInboxCommentError, type EditInboxCommentResponse, type EditInboxMessageData, type EditInboxMessageError, type EditInboxMessageResponse, type EditPostData, type EditPostError, type EditPostResponse, type EnableSmsOnNumberData, type EnableSmsOnNumberError, type EnableSmsOnNumberResponse, type EnableVoiceOnNumberData, type EnableVoiceOnNumberError, type EnableVoiceOnNumberResponse, type EnableWhatsAppCallingData, type EnableWhatsAppCallingError, type EnableWhatsAppCallingLegacyData, type EnableWhatsAppCallingLegacyError, type EnableWhatsAppCallingLegacyResponse, type EnableWhatsAppCallingResponse, type EndVoiceCallData, type EndVoiceCallError, type EndVoiceCallResponse, type EnrollContactsData, type EnrollContactsError, type EnrollContactsResponse, type ErrorResponse, type EstimateAdReachData, type EstimateAdReachError, type EstimateAdReachResponse, type ExternalPostMediaItem, type ExternalPostSummary, type ExternalPostWebhookPost, type FacebookPlatformData, type FacebookPostEarningsResponse, type FacebookSettings, type FetchGoogleBusinessVerificationOptionsData, type FetchGoogleBusinessVerificationOptionsError, type FetchGoogleBusinessVerificationOptionsResponse, type FollowUserData, type FollowUserError, type FollowUserResponse, type FollowerStatsResponse, type FoodMenu, type FoodMenuItem, type FoodMenuItemAttributes, type FoodMenuLabel, type FoodMenuSection, type GenerateAdPreviewsData, type GenerateAdPreviewsError, type GenerateAdPreviewsResponse, type GenerateKeywordHistoricalMetricsData, type GenerateKeywordHistoricalMetricsError, type GenerateKeywordHistoricalMetricsResponse, type GenerateKeywordIdeasData, type GenerateKeywordIdeasError, type GenerateKeywordIdeasResponse, type GeoRestriction, type GetAccountHealthData, type GetAccountHealthError, type GetAccountHealthResponse, type GetAdAccountFinanceData, type GetAdAccountFinanceError, type GetAdAccountFinanceResponse, type GetAdAnalyticsData, type GetAdAnalyticsError, type GetAdAnalyticsResponse, type GetAdAudienceData, type GetAdAudienceError, type GetAdAudienceResponse, type GetAdCommentsData, type GetAdCommentsError, type GetAdCommentsResponse, type GetAdCreativeData, type GetAdCreativeError, type GetAdCreativeResponse, type GetAdData, type GetAdError, type GetAdInsightsReportData, type GetAdInsightsReportError, type GetAdInsightsReportResponse, type GetAdPreviewsData, type GetAdPreviewsError, type GetAdPreviewsResponse, type GetAdResponse, type GetAdSetDetailsData, type GetAdSetDetailsError, type GetAdSetDetailsResponse, type GetAdTrackingTagsData, type GetAdTrackingTagsError, type GetAdTrackingTagsResponse, type GetAdTreeData, type GetAdTreeError, type GetAdTreeResponse, type GetAdsActivityLogData, type GetAdsActivityLogError, type GetAdsActivityLogResponse, type GetAdsSearchTermsData, type GetAdsSearchTermsError, type GetAdsSearchTermsResponse, type GetAdsTimelineData, type GetAdsTimelineError, type GetAdsTimelineResponse, type GetAllAccountsHealthData, type GetAllAccountsHealthError, type GetAllAccountsHealthResponse, type GetAnalyticsData, type GetAnalyticsError, type GetAnalyticsResponse, type GetBestTimeToPostData, type GetBestTimeToPostError, type GetBestTimeToPostResponse, type GetBillingError, type GetBillingResponse, type GetBlogArticleData, type GetBlogArticleError, type GetBlogArticleResponse, type GetBlogData, type GetBlogError, type GetBlogResponse, type GetBlueskySettingsData, type GetBlueskySettingsError, type GetBlueskySettingsResponse, type GetBroadcastData, type GetBroadcastError, type GetBroadcastResponse, type GetCallData, type GetCallError, type GetCallRecordingData, type GetCallRecordingError, type GetCallRecordingResponse, type GetCallResponse, type GetCallsUsageData, type GetCallsUsageError, type GetCallsUsageResponse, type GetCampaignAnalyticsData, type GetCampaignAnalyticsError, type GetCampaignAnalyticsResponse, type GetCommentAutomationData, type GetCommentAutomationError, type GetCommentAutomationResponse, type GetConnectUrlData, type GetConnectUrlError, type GetConnectUrlResponse, type GetContactChannelsData, type GetContactChannelsError, type GetContactChannelsResponse, type GetContactData, type GetContactError, type GetContactResponse, type GetContentDecayData, type GetContentDecayError, type GetContentDecayResponse, type GetConversionDestinationData, type GetConversionDestinationError, type GetConversionDestinationResponse, type GetConversionMetricsData, type GetConversionMetricsError, type GetConversionMetricsResponse, type GetConversionsQualityData, type GetConversionsQualityError, type GetConversionsQualityResponse, type GetDailyMetricsData, type GetDailyMetricsError, type GetDailyMetricsResponse, type GetDiscordChannelsData, type GetDiscordChannelsError, type GetDiscordChannelsResponse, type GetDiscordGuildMemberData, type GetDiscordGuildMemberError, type GetDiscordGuildMemberResponse, type GetDiscordScheduledEventData, type GetDiscordScheduledEventError, type GetDiscordScheduledEventResponse, type GetDiscordSettingsData, type GetDiscordSettingsError, type GetDiscordSettingsResponse, type GetDsaDefaultsData, type GetDsaDefaultsError, type GetDsaDefaultsResponse, type GetDsaRecommendationsData, type GetDsaRecommendationsError, type GetDsaRecommendationsResponse, type GetFacebookPageInsightsData, type GetFacebookPageInsightsError, type GetFacebookPageInsightsResponse, type GetFacebookPagesData, type GetFacebookPagesError, type GetFacebookPagesResponse, type GetFacebookPostEarningsData, type GetFacebookPostEarningsError, type GetFacebookPostEarningsResponse, type GetFacebookPostReactionsData, type GetFacebookPostReactionsError, type GetFacebookPostReactionsResponse, type GetFollowerStatsData, type GetFollowerStatsError, type GetFollowerStatsResponse, type GetGmbAttributeMetadataData, type GetGmbAttributeMetadataError, type GetGmbAttributeMetadataResponse, type GetGmbLocationsData, type GetGmbLocationsError, type GetGmbLocationsResponse, type GetGoogleBusinessAttributesData, type GetGoogleBusinessAttributesError, type GetGoogleBusinessAttributesResponse, type GetGoogleBusinessFoodMenusData, type GetGoogleBusinessFoodMenusError, type GetGoogleBusinessFoodMenusResponse, type GetGoogleBusinessLocationDetailsData, type GetGoogleBusinessLocationDetailsError, type GetGoogleBusinessLocationDetailsResponse, type GetGoogleBusinessPerformanceData, type GetGoogleBusinessPerformanceError, type GetGoogleBusinessPerformanceResponse, type GetGoogleBusinessReviewsData, type GetGoogleBusinessReviewsError, type GetGoogleBusinessReviewsResponse, type GetGoogleBusinessSearchKeywordsData, type GetGoogleBusinessSearchKeywordsError, type GetGoogleBusinessSearchKeywordsResponse, type GetGoogleBusinessServicesData, type GetGoogleBusinessServicesError, type GetGoogleBusinessServicesResponse, type GetGoogleBusinessVerificationsData, type GetGoogleBusinessVerificationsError, type GetGoogleBusinessVerificationsResponse, type GetInboxConversationAnalyticsData, type GetInboxConversationAnalyticsError, type GetInboxConversationAnalyticsResponse, type GetInboxConversationData, type GetInboxConversationError, type GetInboxConversationMessagesData, type GetInboxConversationMessagesError, type GetInboxConversationMessagesResponse, type GetInboxConversationResponse, type GetInboxHeatmapData, type GetInboxHeatmapError, type GetInboxHeatmapResponse, type GetInboxPostCommentsData, type GetInboxPostCommentsError, type GetInboxPostCommentsResponse, type GetInboxResponseTimeData, type GetInboxResponseTimeError, type GetInboxResponseTimeResponse, type GetInboxSourceBreakdownData, type GetInboxSourceBreakdownError, type GetInboxSourceBreakdownResponse, type GetInboxTopAccountsData, type GetInboxTopAccountsError, type GetInboxTopAccountsResponse, type GetInboxVolumeData, type GetInboxVolumeError, type GetInboxVolumeResponse, type GetInstagramAccountInsightsData, type GetInstagramAccountInsightsError, type GetInstagramAccountInsightsResponse, type GetInstagramAudioData, type GetInstagramAudioError, type GetInstagramAudioResponse, type GetInstagramDemographicsData, type GetInstagramDemographicsError, type GetInstagramDemographicsResponse, type GetInstagramFollowStatusData, type GetInstagramFollowStatusError, type GetInstagramFollowStatusResponse, type GetInstagramFollowerHistoryData, type GetInstagramFollowerHistoryError, type GetInstagramFollowerHistoryResponse, type GetInstagramIceBreakersData, type GetInstagramIceBreakersError, type GetInstagramIceBreakersResponse, type GetInstagramPublishingLimitData, type GetInstagramPublishingLimitError, type GetInstagramPublishingLimitResponse, type GetInstagramStoryInsightsData, type GetInstagramStoryInsightsError, type GetInstagramStoryInsightsResponse, type GetLeadFormData, type GetLeadFormError, type GetLeadFormResponse, type GetLinkedInAggregateAnalyticsData, type GetLinkedInAggregateAnalyticsError, type GetLinkedInAggregateAnalyticsResponse, type GetLinkedInBidPricingData, type GetLinkedInBidPricingError, type GetLinkedInBidPricingResponse, type GetLinkedInMentionsData, type GetLinkedInMentionsError, type GetLinkedInMentionsResponse, type GetLinkedInOrgAggregateAnalyticsData, type GetLinkedInOrgAggregateAnalyticsError, type GetLinkedInOrgAggregateAnalyticsResponse, type GetLinkedInOrganizationsData, type GetLinkedInOrganizationsError, type GetLinkedInOrganizationsResponse, type GetLinkedInPostAnalyticsData, type GetLinkedInPostAnalyticsError, type GetLinkedInPostAnalyticsResponse, type GetLinkedInPostReactionsData, type GetLinkedInPostReactionsError, type GetLinkedInPostReactionsResponse, type GetLinkedInSupplyForecastData, type GetLinkedInSupplyForecastError, type GetLinkedInSupplyForecastResponse, type GetMediaPresignedUrlData, type GetMediaPresignedUrlError, type GetMediaPresignedUrlResponse, type GetMessageAttachmentData, type GetMessageAttachmentError, type GetMessageAttachmentResponse, type GetMessengerMenuData, type GetMessengerMenuError, type GetMessengerMenuResponse, type GetNextQueueSlotData, type GetNextQueueSlotError, type GetNextQueueSlotResponse, type GetPendingOAuthDataData, type GetPendingOAuthDataError, type GetPendingOAuthDataResponse, type GetPhoneNumberData, type GetPhoneNumberError, type GetPhoneNumberKycFormData, type GetPhoneNumberKycFormError, type GetPhoneNumberKycFormResponse, type GetPhoneNumberPortInOrderRequirementsData, type GetPhoneNumberPortInOrderRequirementsError, type GetPhoneNumberPortInOrderRequirementsResponse, type GetPhoneNumberPortInRequirementsData, type GetPhoneNumberPortInRequirementsError, type GetPhoneNumberPortInRequirementsResponse, type GetPhoneNumberRemediationData, type GetPhoneNumberRemediationError, type GetPhoneNumberRemediationResponse, type GetPhoneNumberResponse, type GetPinterestBoardsData, type GetPinterestBoardsError, type GetPinterestBoardsResponse, type GetPostData, type GetPostError, type GetPostResponse, type GetPostTimelineData, type GetPostTimelineError, type GetPostTimelineResponse, type GetPostingFrequencyData, type GetPostingFrequencyError, type GetPostingFrequencyResponse, type GetProfileData, type GetProfileError, type GetProfileResponse, type GetRedditFeedData, type GetRedditFeedError, type GetRedditFeedResponse, type GetRedditFlairsData, type GetRedditFlairsError, type GetRedditFlairsResponse, type GetRedditSubredditsData, type GetRedditSubredditsError, type GetRedditSubredditsResponse, type GetRfPredictionData, type GetRfPredictionError, type GetRfPredictionResponse, type GetSequenceData, type GetSequenceError, type GetSequenceResponse, type GetShopifyConnectUrlData, type GetShopifyConnectUrlError, type GetShopifyConnectUrlResponse, type GetSlackSettingsData, type GetSlackSettingsError, type GetSlackSettingsResponse, type GetSmsRegistrationData, type GetSmsRegistrationError, type GetSmsRegistrationResponse, type GetSmsUsageData, type GetSmsUsageError, type GetSmsUsageResponse, type GetSubredditRulesData, type GetSubredditRulesError, type GetSubredditRulesResponse, type GetTelegramCommandsData, type GetTelegramCommandsError, type GetTelegramCommandsResponse, type GetTelegramConnectStatusData, type GetTelegramConnectStatusError, type GetTelegramConnectStatusResponse, type GetTikTokAccountInsightsData, type GetTikTokAccountInsightsError, type GetTikTokAccountInsightsResponse, type GetTikTokCreatorInfoData, type GetTikTokCreatorInfoError, type GetTikTokCreatorInfoResponse, type GetTrackingTagData, type GetTrackingTagError, type GetTrackingTagResponse, type GetTrackingTagStatsData, type GetTrackingTagStatsError, type GetTrackingTagStatsResponse, type GetTweetData, type GetTweetError, type GetTweetResponse, type GetUsageData, type GetUsageError, type GetUsageResponse, type GetUsageStatsData, type GetUsageStatsError, type GetUsageStatsResponse, type GetUserData, type GetUserError, type GetUserResponse, type GetValueRuleSetData, type GetValueRuleSetError, type GetValueRuleSetResponse, type GetVerificationData, type GetVerificationError, type GetVerificationResponse, type GetVoiceCallData, type GetVoiceCallError, type GetVoiceCallEstimateData, type GetVoiceCallEstimateError, type GetVoiceCallEstimateResponse, type GetVoiceCallRecordingData, type GetVoiceCallRecordingError, type GetVoiceCallRecordingResponse, type GetVoiceCallResponse, type GetWebhookLogsData, type GetWebhookLogsError, type GetWebhookLogsResponse, type GetWebhookSettingsError, type GetWebhookSettingsResponse, type GetWhatsAppBlockStatusData, type GetWhatsAppBlockStatusError, type GetWhatsAppBlockStatusResponse, type GetWhatsAppBlockedUsersData, type GetWhatsAppBlockedUsersError, type GetWhatsAppBlockedUsersResponse, type GetWhatsAppBusinessProfileData, type GetWhatsAppBusinessProfileError, type GetWhatsAppBusinessProfileResponse, type GetWhatsAppCallData, type GetWhatsAppCallError, type GetWhatsAppCallEstimateData, type GetWhatsAppCallEstimateError, type GetWhatsAppCallEstimateResponse, type GetWhatsAppCallPermissionsData, type GetWhatsAppCallPermissionsError, type GetWhatsAppCallPermissionsResponse, type GetWhatsAppCallRecordingData, type GetWhatsAppCallRecordingError, type GetWhatsAppCallRecordingResponse, type GetWhatsAppCallResponse, type GetWhatsAppCallingConfigData, type GetWhatsAppCallingConfigError, type GetWhatsAppCallingConfigResponse, type GetWhatsAppCallingData, type GetWhatsAppCallingError, type GetWhatsAppCallingResponse, type GetWhatsAppDatasetData, type GetWhatsAppDatasetError, type GetWhatsAppDatasetResponse, type GetWhatsAppDisplayNameData, type GetWhatsAppDisplayNameError, type GetWhatsAppDisplayNameResponse, type GetWhatsAppFlowData, type GetWhatsAppFlowError, type GetWhatsAppFlowJsonData, type GetWhatsAppFlowJsonError, type GetWhatsAppFlowJsonResponse, type GetWhatsAppFlowPreviewData, type GetWhatsAppFlowPreviewError, type GetWhatsAppFlowPreviewResponse, type GetWhatsAppFlowResponse, type GetWhatsAppGroupChatData, type GetWhatsAppGroupChatError, type GetWhatsAppGroupChatResponse, type GetWhatsAppLibraryTemplateData, type GetWhatsAppLibraryTemplateError, type GetWhatsAppLibraryTemplateResponse, type GetWhatsAppMediaData, type GetWhatsAppMediaError, type GetWhatsAppMediaResponse, type GetWhatsAppNumberInfoData, type GetWhatsAppNumberInfoError, type GetWhatsAppNumberInfoResponse, type GetWhatsAppNumberKycFormData, type GetWhatsAppNumberKycFormError, type GetWhatsAppNumberKycFormResponse, type GetWhatsAppNumberRemediationData, type GetWhatsAppNumberRemediationError, type GetWhatsAppNumberRemediationResponse, type GetWhatsAppPhoneNumberData, type GetWhatsAppPhoneNumberError, type GetWhatsAppPhoneNumberResponse, type GetWhatsAppPhoneNumbersData, type GetWhatsAppPhoneNumbersError, type GetWhatsAppPhoneNumbersResponse, type GetWhatsAppTemplateData, type GetWhatsAppTemplateError, type GetWhatsAppTemplateResponse, type GetWhatsAppTemplatesData, type GetWhatsAppTemplatesError, type GetWhatsAppTemplatesResponse, type GetWhatsappBusinessUsernameData, type GetWhatsappBusinessUsernameError, type GetWhatsappBusinessUsernameResponse, type GetWhatsappBusinessUsernameSuggestionsData, type GetWhatsappBusinessUsernameSuggestionsError, type GetWhatsappBusinessUsernameSuggestionsResponse, type GetWorkflowData, type GetWorkflowError, type GetWorkflowResponse, type GetWorkflowVersionData, type GetWorkflowVersionError, type GetWorkflowVersionResponse, type GetXApiPricingError, type GetXApiPricingResponse, type GetYouTubeChannelInsightsData, type GetYouTubeChannelInsightsError, type GetYouTubeChannelInsightsResponse, type GetYouTubeDailyViewsData, type GetYouTubeDailyViewsError, type GetYouTubeDailyViewsResponse, type GetYouTubeDemographicsData, type GetYouTubeDemographicsError, type GetYouTubeDemographicsResponse, type GetYouTubeVideoRetentionData, type GetYouTubeVideoRetentionError, type GetYouTubeVideoRetentionResponse, type GetYoutubePlaylistsData, type GetYoutubePlaylistsError, type GetYoutubePlaylistsResponse, type GoogleBusinessPlatformData, type HandleOAuthCallbackData, type HandleOAuthCallbackError, type HandleOAuthCallbackResponse, type HideInboxCommentData, type HideInboxCommentError, type HideInboxCommentResponse, type InboxMessageEditAttachment, type InboxMessageEditHistoryEntry, type InboxWebhookAccount, type InboxWebhookConversation, type InboxWebhookMessage, type InitiateTelegramConnectData, type InitiateTelegramConnectError, type InitiateTelegramConnectResponse, type InitiateWhatsAppCallData, type InitiateWhatsAppCallError, type InitiateWhatsAppCallResponse, type InstagramAccountInsightsResponse, type InstagramAudioAsset, type InstagramDemographicsResponse, type InstagramPlatformData, Late, LateApiError, type LikeInboxCommentData, type LikeInboxCommentError, type LikeInboxCommentResponse, type LikePostData, type LikePostError, type LikePostResponse, type LinkedInAdsPlatformData, type LinkedInAggregateAnalyticsDailyResponse, type LinkedInAggregateAnalyticsTotalResponse, type LinkedInPlatformData, type ListAccountGroupsError, type ListAccountGroupsResponse, type ListAccountsData, type ListAccountsError, type ListAccountsResponse, type ListAdAccountsData, type ListAdAccountsError, type ListAdAccountsResponse, type ListAdAudiencesData, type ListAdAudiencesError, type ListAdAudiencesResponse, type ListAdCampaignsData, type ListAdCampaignsError, type ListAdCampaignsResponse, type ListAdCatalogProductSetsData, type ListAdCatalogProductSetsError, type ListAdCatalogProductSetsResponse, type ListAdCatalogsData, type ListAdCatalogsError, type ListAdCatalogsResponse, type ListAdCreativesData, type ListAdCreativesError, type ListAdCreativesResponse, type ListAdImagesData, type ListAdImagesError, type ListAdImagesResponse, type ListAdKeywordsData, type ListAdKeywordsError, type ListAdKeywordsResponse, type ListAdLabelsData, type ListAdLabelsError, type ListAdLabelsResponse, type ListAdStudiesData, type ListAdStudiesError, type ListAdStudiesResponse, type ListAdVideosData, type ListAdVideosError, type ListAdVideosResponse, type ListAdsBusinessCentersData, type ListAdsBusinessCentersError, type ListAdsBusinessCentersResponse, type ListAdsData, type ListAdsError, type ListAdsResponse, type ListApiKeysError, type ListApiKeysResponse, type ListBlogArticlesData, type ListBlogArticlesError, type ListBlogArticlesResponse, type ListBlogsData, type ListBlogsError, type ListBlogsResponse, type ListBroadcastRecipientsData, type ListBroadcastRecipientsError, type ListBroadcastRecipientsResponse, type ListBroadcastsData, type ListBroadcastsError, type ListBroadcastsResponse, type ListCallsData, type ListCallsError, type ListCallsResponse, type ListCommentAutomationLogsData, type ListCommentAutomationLogsError, type ListCommentAutomationLogsResponse, type ListCommentAutomationsData, type ListCommentAutomationsError, type ListCommentAutomationsResponse, type ListConnectedAppsError, type ListConnectedAppsResponse, type ListContactsData, type ListContactsError, type ListContactsResponse, type ListConversionAssociationsData, type ListConversionAssociationsError, type ListConversionAssociationsResponse, type ListConversionDestinationsData, type ListConversionDestinationsError, type ListConversionDestinationsResponse, type ListCustomConversionsData, type ListCustomConversionsError, type ListCustomConversionsResponse, type ListCustomFieldsData, type ListCustomFieldsError, type ListCustomFieldsResponse, type ListDiscordGuildMembersData, type ListDiscordGuildMembersError, type ListDiscordGuildMembersResponse, type ListDiscordGuildRolesData, type ListDiscordGuildRolesError, type ListDiscordGuildRolesResponse, type ListDiscordPinnedMessagesData, type ListDiscordPinnedMessagesError, type ListDiscordPinnedMessagesResponse, type ListDiscordScheduledEventsData, type ListDiscordScheduledEventsError, type ListDiscordScheduledEventsResponse, type ListFacebookPagesData, type ListFacebookPagesError, type ListFacebookPagesResponse, type ListFormLeadsData, type ListFormLeadsError, type ListFormLeadsResponse, type ListGoogleBusinessLocationsData, type ListGoogleBusinessLocationsError, type ListGoogleBusinessLocationsResponse, type ListGoogleBusinessMediaData, type ListGoogleBusinessMediaError, type ListGoogleBusinessMediaResponse, type ListGoogleBusinessPlaceActionsData, type ListGoogleBusinessPlaceActionsError, type ListGoogleBusinessPlaceActionsResponse, type ListHighDemandPeriodsData, type ListHighDemandPeriodsError, type ListHighDemandPeriodsResponse, type ListInboxCommentsData, type ListInboxCommentsError, type ListInboxCommentsResponse, type ListInboxConversationAnalyticsData, type ListInboxConversationAnalyticsError, type ListInboxConversationAnalyticsResponse, type ListInboxConversationsData, type ListInboxConversationsError, type ListInboxConversationsResponse, type ListInboxMentionsData, type ListInboxMentionsError, type ListInboxMentionsResponse, type ListInboxReviewsData, type ListInboxReviewsError, type ListInboxReviewsResponse, type ListInstagramPagesData, type ListInstagramPagesError, type ListInstagramPagesResponse, type ListInstagramStoriesData, type ListInstagramStoriesError, type ListInstagramStoriesResponse, type ListLeadFormsData, type ListLeadFormsError, type ListLeadFormsResponse, type ListLeadsData, type ListLeadsError, type ListLeadsResponse, type ListLinkedInOrganizationsData, type ListLinkedInOrganizationsError, type ListLinkedInOrganizationsResponse, type ListLocalServicesLeadConversationsData, type ListLocalServicesLeadConversationsError, type ListLocalServicesLeadConversationsResponse, type ListLocalServicesLeadsData, type ListLocalServicesLeadsError, type ListLocalServicesLeadsResponse, type ListLogsData, type ListLogsError, type ListLogsResponse, type ListMetaBusinessesData, type ListMetaBusinessesError, type ListMetaBusinessesResponse, type ListPhoneNumberCountriesError, type ListPhoneNumberCountriesResponse, type ListPhoneNumberPortInsError, type ListPhoneNumberPortInsResponse, type ListPhoneNumbersData, type ListPhoneNumbersError, type ListPhoneNumbersResponse, type ListPinterestBoardsForSelectionData, type ListPinterestBoardsForSelectionError, type ListPinterestBoardsForSelectionResponse, type ListPostsData, type ListPostsError, type ListPostsResponse, type ListProfilesData, type ListProfilesError, type ListProfilesResponse, type ListQueueSlotsData, type ListQueueSlotsError, type ListQueueSlotsResponse, type ListSequenceEnrollmentsData, type ListSequenceEnrollmentsError, type ListSequenceEnrollmentsResponse, type ListSequencesData, type ListSequencesError, type ListSequencesResponse, type ListSlackMembersData, type ListSlackMembersError, type ListSlackMembersResponse, type ListSmsOptOutsData, type ListSmsOptOutsError, type ListSmsOptOutsResponse, type ListSmsRegistrationsData, type ListSmsRegistrationsError, type ListSmsRegistrationsResponse, type ListSmsSenderIdsError, type ListSmsSenderIdsResponse, type ListSnapchatProfilesData, type ListSnapchatProfilesError, type ListSnapchatProfilesResponse, type ListTrackingTagSharedAccountsData, type ListTrackingTagSharedAccountsError, type ListTrackingTagSharedAccountsResponse, type ListTrackingTagsData, type ListTrackingTagsError, type ListTrackingTagsResponse, type ListUsersError, type ListUsersResponse, type ListValueRuleSetsData, type ListValueRuleSetsError, type ListValueRuleSetsResponse, type ListVoiceCallsData, type ListVoiceCallsError, type ListVoiceCallsResponse, type ListWhatsAppAccountEventsData, type ListWhatsAppAccountEventsError, type ListWhatsAppAccountEventsResponse, type ListWhatsAppCallsData, type ListWhatsAppCallsError, type ListWhatsAppCallsResponse, type ListWhatsAppConversionsData, type ListWhatsAppConversionsError, type ListWhatsAppConversionsResponse, type ListWhatsAppFlowResponsesData, type ListWhatsAppFlowResponsesError, type ListWhatsAppFlowResponsesResponse, type ListWhatsAppFlowVersionsData, type ListWhatsAppFlowVersionsError, type ListWhatsAppFlowVersionsResponse, type ListWhatsAppFlowsData, type ListWhatsAppFlowsError, type ListWhatsAppFlowsResponse, type ListWhatsAppGroupChatsData, type ListWhatsAppGroupChatsError, type ListWhatsAppGroupChatsResponse, type ListWhatsAppGroupJoinRequestsData, type ListWhatsAppGroupJoinRequestsError, type ListWhatsAppGroupJoinRequestsResponse, type ListWhatsAppNumberCountriesError, type ListWhatsAppNumberCountriesResponse, type ListWhatsAppPhoneNumbersData, type ListWhatsAppPhoneNumbersError, type ListWhatsAppPhoneNumbersResponse, type ListWhatsAppSandboxSessionsError, type ListWhatsAppSandboxSessionsResponse, type ListWorkflowExecutionEventsData, type ListWorkflowExecutionEventsError, type ListWorkflowExecutionEventsResponse, type ListWorkflowExecutionsData, type ListWorkflowExecutionsError, type ListWorkflowExecutionsResponse, type ListWorkflowVersionsData, type ListWorkflowVersionsError, type ListWorkflowVersionsResponse, type ListWorkflowsData, type ListWorkflowsError, type ListWorkflowsResponse, type LookupSmsNumberData, type LookupSmsNumberError, type LookupSmsNumberResponse, type MarkConversationReadData, type MarkConversationReadError, type MarkConversationReadResponse, type MediaItem, type MediaUploadResponse, type MetaAdsPlatformData, type Money, type MoneyAmount, type MoveAccountToProfileData, type MoveAccountToProfileError, type MoveAccountToProfileResponse, type MoveWhatsAppNumberToProfileData, type MoveWhatsAppNumberToProfileError, type MoveWhatsAppNumberToProfileResponse, type Pagination, type ParameterIdempotencyKeyHeader, type ParameterPageParam, type PauseSequenceData, type PauseSequenceError, type PauseSequenceResponse, type PauseWorkflowData, type PauseWorkflowError, type PauseWorkflowResponse, type PinDiscordMessageData, type PinDiscordMessageError, type PinDiscordMessageResponse, type PinterestPlatformData, type PlatformAnalytics, type PlatformTarget, type Post, type PostAnalytics, type PostCreateResponse, type PostDeleteResponse, type PostGetResponse, type PostRetryResponse, type PostUpdateResponse, type PostsListResponse, type PreflightSmsRegistrationData, type PreflightSmsRegistrationError, type PreflightSmsRegistrationResponse, type PreviewQueueData, type PreviewQueueError, type PreviewQueueResponse, type Profile, type ProfileCreateResponse, type ProfileDeleteResponse, type ProfileGetResponse, type ProfileUpdateResponse, type ProfilesListResponse, type PublishWhatsAppFlowData, type PublishWhatsAppFlowError, type PublishWhatsAppFlowResponse, type PurchasePhoneNumberData, type PurchasePhoneNumberError, type PurchasePhoneNumberResponse, type PurchaseWhatsAppPhoneNumberData, type PurchaseWhatsAppPhoneNumberError, type PurchaseWhatsAppPhoneNumberResponse, type QueryAdInsightsData, type QueryAdInsightsError, type QueryAdInsightsResponse, type QueueDeleteResponse, type QueueNextSlotResponse, type QueuePreviewResponse, type QueueSchedule, type QueueSlot, type QueueSlotsResponse, type QueueUpdateResponse, RateLimitError, type RecyclingConfig, type RecyclingState, type RedditPlatformData, type RedditPost, type RegisterWhatsAppNumberData, type RegisterWhatsAppNumberError, type RegisterWhatsAppNumberResponse, type RejectWhatsAppGroupJoinRequestsData, type RejectWhatsAppGroupJoinRequestsError, type RejectWhatsAppGroupJoinRequestsResponse, type ReleasePhoneNumberData, type ReleasePhoneNumberError, type ReleasePhoneNumberResponse, type ReleaseWhatsAppPhoneNumberData, type ReleaseWhatsAppPhoneNumberError, type ReleaseWhatsAppPhoneNumberResponse, type RemediatePhoneNumberData, type RemediatePhoneNumberError, type RemediatePhoneNumberResponse, type RemediateWhatsAppNumberData, type RemediateWhatsAppNumberError, type RemediateWhatsAppNumberResponse, type RemoveBookmarkData, type RemoveBookmarkError, type RemoveBookmarkResponse, type RemoveConversionAssociationsData, type RemoveConversionAssociationsError, type RemoveConversionAssociationsResponse, type RemoveDiscordMemberRoleData, type RemoveDiscordMemberRoleError, type RemoveDiscordMemberRoleResponse, type RemoveMessageReactionData, type RemoveMessageReactionError, type RemoveMessageReactionResponse, type RemoveTrackingTagSharedAccountData, type RemoveTrackingTagSharedAccountError, type RemoveTrackingTagSharedAccountResponse, type RemoveWhatsAppGroupParticipantsData, type RemoveWhatsAppGroupParticipantsError, type RemoveWhatsAppGroupParticipantsResponse, type ReplaceAdAudienceCompaniesData, type ReplaceAdAudienceCompaniesError, type ReplaceAdAudienceCompaniesResponse, type ReplyToGoogleBusinessReviewData, type ReplyToGoogleBusinessReviewError, type ReplyToGoogleBusinessReviewResponse, type ReplyToInboxPostData, type ReplyToInboxPostError, type ReplyToInboxPostResponse, type ReplyToInboxReviewData, type ReplyToInboxReviewError, type ReplyToInboxReviewResponse, type ReplyToMentionData, type ReplyToMentionError, type ReplyToMentionResponse, type ReplyToPhoneNumberReviewerData, type ReplyToPhoneNumberReviewerError, type ReplyToPhoneNumberReviewerResponse, type RequestSmsSenderIdLimitIncreaseData, type RequestSmsSenderIdLimitIncreaseError, type RequestSmsSenderIdLimitIncreaseResponse, type ResendSmsRegistrationOtpData, type ResendSmsRegistrationOtpError, type ResendSmsRegistrationOtpResponse, type ReserveRfPredictionData, type ReserveRfPredictionError, type ReserveRfPredictionResponse, type RespondToPhoneNumberReviewerData, type RespondToPhoneNumberReviewerError, type RespondToPhoneNumberReviewerResponse, type RespondToSmsRegistrationReviewData, type RespondToSmsRegistrationReviewError, type RespondToSmsRegistrationReviewResponse, type RestoreWorkflowVersionData, type RestoreWorkflowVersionError, type RestoreWorkflowVersionResponse, type RetryPostData, type RetryPostError, type RetryPostResponse, type RetweetPostData, type RetweetPostError, type RetweetPostResponse, type ReuseSmsRegistrationForNumberData, type ReuseSmsRegistrationForNumberError, type ReuseSmsRegistrationForNumberResponse, type ReviewPhoneNumberKycPacketData, type ReviewPhoneNumberKycPacketError, type ReviewPhoneNumberKycPacketResponse, type ReviewWebhookReview, type RevokeConnectedAppData, type RevokeConnectedAppError, type RevokeConnectedAppResponse, type RfPrediction, type ScheduleBroadcastData, type ScheduleBroadcastError, type ScheduleBroadcastResponse, type SearchAdInterestsData, type SearchAdInterestsError, type SearchAdInterestsResponse, type SearchAdTargetingData, type SearchAdTargetingError, type SearchAdTargetingResponse, type SearchAvailablePhoneNumbersData, type SearchAvailablePhoneNumbersError, type SearchAvailablePhoneNumbersResponse, type SearchAvailableWhatsAppNumbersData, type SearchAvailableWhatsAppNumbersError, type SearchAvailableWhatsAppNumbersResponse, type SearchDiscordGuildMembersData, type SearchDiscordGuildMembersError, type SearchDiscordGuildMembersResponse, type SearchInboxConversationsData, type SearchInboxConversationsError, type SearchInboxConversationsResponse, type SearchInstagramAudioData, type SearchInstagramAudioError, type SearchInstagramAudioResponse, type SearchRedditData, type SearchRedditError, type SearchRedditResponse, type SearchTweetsData, type SearchTweetsError, type SearchTweetsResponse, type SelectFacebookPageData, type SelectFacebookPageError, type SelectFacebookPageResponse, type SelectGoogleBusinessLocationData, type SelectGoogleBusinessLocationError, type SelectGoogleBusinessLocationResponse, type SelectInstagramAccountData, type SelectInstagramAccountError, type SelectInstagramAccountResponse, type SelectLinkedInOrganizationData, type SelectLinkedInOrganizationError, type SelectLinkedInOrganizationResponse, type SelectPinterestBoardData, type SelectPinterestBoardError, type SelectPinterestBoardResponse, type SelectSnapchatProfileData, type SelectSnapchatProfileError, type SelectSnapchatProfileResponse, type SendBroadcastData, type SendBroadcastError, type SendBroadcastResponse, type SendConversionsData, type SendConversionsError, type SendConversionsResponse, type SendDiscordDirectMessageData, type SendDiscordDirectMessageError, type SendDiscordDirectMessageResponse, type SendInboxMessageData, type SendInboxMessageError, type SendInboxMessageResponse, type SendPrivateReplyToCommentData, type SendPrivateReplyToCommentError, type SendPrivateReplyToCommentResponse, type SendSmsData, type SendSmsError, type SendSmsResponse, type SendTypingIndicatorData, type SendTypingIndicatorError, type SendTypingIndicatorResponse, type SendWhatsAppConversionData, type SendWhatsAppConversionError, type SendWhatsAppConversionResponse, type SendWhatsAppFlowMessageData, type SendWhatsAppFlowMessageError, type SendWhatsAppFlowMessageResponse, type SetCommentModerationData, type SetCommentModerationError, type SetCommentModerationResponse, type SetContactFieldValueData, type SetContactFieldValueError, type SetContactFieldValueResponse, type SetInstagramIceBreakersData, type SetInstagramIceBreakersError, type SetInstagramIceBreakersResponse, type SetMessengerMenuData, type SetMessengerMenuError, type SetMessengerMenuResponse, type SetRedditPostFlairData, type SetRedditPostFlairError, type SetRedditPostFlairResponse, type SetTelegramCommandsData, type SetTelegramCommandsError, type SetTelegramCommandsResponse, type SetWhatsappBusinessUsernameData, type SetWhatsappBusinessUsernameError, type SetWhatsappBusinessUsernameResponse, type ShareSmsRegistrationData, type ShareSmsRegistrationError, type ShareSmsRegistrationResponse, type SharedAdAccount, type SlackPlatformData, type SnapchatPlatformData, type SocialAccount, type StartGoogleBusinessVerificationData, type StartGoogleBusinessVerificationError, type StartGoogleBusinessVerificationResponse, type StartSmsRegistrationData, type StartSmsRegistrationError, type StartSmsRegistrationResponse, type StartWhatsAppCallerIdVerificationData, type StartWhatsAppCallerIdVerificationError, type StartWhatsAppCallerIdVerificationResponse, type SubmitPhoneNumberKycData, type SubmitPhoneNumberKycError, type SubmitPhoneNumberKycResponse, type SubmitWhatsAppNumberKycData, type SubmitWhatsAppNumberKycError, type SubmitWhatsAppNumberKycResponse, type SyncExternalPostsData, type SyncExternalPostsError, type SyncExternalPostsResponse, type TargetingSpec, type TelegramPlatformData, type TestWebhookData, type TestWebhookError, type TestWebhookResponse, type ThreadsPlatformData, type TikTokPlatformData, type TrackingTag, type TransferVoiceCallData, type TransferVoiceCallError, type TransferVoiceCallResponse, type TriggerWorkflowData, type TriggerWorkflowError, type TriggerWorkflowResponse, type TwitterPlatformData, type UnblockWhatsAppUsersData, type UnblockWhatsAppUsersError, type UnblockWhatsAppUsersResponse, type UndoRetweetData, type UndoRetweetError, type UndoRetweetResponse, type UnenrollContactData, type UnenrollContactError, type UnenrollContactResponse, type UnfollowUserData, type UnfollowUserError, type UnfollowUserResponse, type UnhideInboxCommentData, type UnhideInboxCommentError, type UnhideInboxCommentResponse, type UnlikeInboxCommentData, type UnlikeInboxCommentError, type UnlikeInboxCommentResponse, type UnlikePostData, type UnlikePostError, type UnlikePostResponse, type UnpinDiscordMessageData, type UnpinDiscordMessageError, type UnpinDiscordMessageResponse, type UnpublishPostData, type UnpublishPostError, type UnpublishPostResponse, type UpdateAccountData, type UpdateAccountError, type UpdateAccountGroupData, type UpdateAccountGroupError, type UpdateAccountGroupResponse, type UpdateAccountResponse, type UpdateAdAccountData, type UpdateAdAccountError, type UpdateAdAccountResponse, type UpdateAdAudienceData, type UpdateAdAudienceError, type UpdateAdAudienceResponse, type UpdateAdCampaignData, type UpdateAdCampaignError, type UpdateAdCampaignResponse, type UpdateAdCampaignStatusData, type UpdateAdCampaignStatusError, type UpdateAdCampaignStatusResponse, type UpdateAdCreativeData, type UpdateAdCreativeError, type UpdateAdCreativeResponse, type UpdateAdData, type UpdateAdError, type UpdateAdResponse, type UpdateAdSetData, type UpdateAdSetError, type UpdateAdSetResponse, type UpdateAdSetStatusData, type UpdateAdSetStatusError, type UpdateAdSetStatusResponse, type UpdateAdStatusData, type UpdateAdStatusError, type UpdateAdStatusResponse, type UpdateAdTrackingTagsData, type UpdateAdTrackingTagsError, type UpdateAdTrackingTagsResponse, type UpdateBlogArticleData, type UpdateBlogArticleError, type UpdateBlogArticleResponse, type UpdateBlogData, type UpdateBlogError, type UpdateBlogResponse, type UpdateBlueskySettingsData, type UpdateBlueskySettingsError, type UpdateBlueskySettingsResponse, type UpdateBroadcastData, type UpdateBroadcastError, type UpdateBroadcastResponse, type UpdateCommentAutomationData, type UpdateCommentAutomationError, type UpdateCommentAutomationResponse, type UpdateContactData, type UpdateContactError, type UpdateContactResponse, type UpdateConversionDestinationData, type UpdateConversionDestinationError, type UpdateConversionDestinationResponse, type UpdateCustomFieldData, type UpdateCustomFieldError, type UpdateCustomFieldResponse, type UpdateDiscordScheduledEventData, type UpdateDiscordScheduledEventError, type UpdateDiscordScheduledEventResponse, type UpdateDiscordSettingsData, type UpdateDiscordSettingsError, type UpdateDiscordSettingsResponse, type UpdateFacebookPageData, type UpdateFacebookPageError, type UpdateFacebookPageResponse, type UpdateGmbLocationData, type UpdateGmbLocationError, type UpdateGmbLocationResponse, type UpdateGoogleBusinessAttributesData, type UpdateGoogleBusinessAttributesError, type UpdateGoogleBusinessAttributesResponse, type UpdateGoogleBusinessFoodMenusData, type UpdateGoogleBusinessFoodMenusError, type UpdateGoogleBusinessFoodMenusResponse, type UpdateGoogleBusinessLocationDetailsData, type UpdateGoogleBusinessLocationDetailsError, type UpdateGoogleBusinessLocationDetailsResponse, type UpdateGoogleBusinessPlaceActionData, type UpdateGoogleBusinessPlaceActionError, type UpdateGoogleBusinessPlaceActionResponse, type UpdateGoogleBusinessServicesData, type UpdateGoogleBusinessServicesError, type UpdateGoogleBusinessServicesResponse, type UpdateInboxConversationData, type UpdateInboxConversationError, type UpdateInboxConversationResponse, type UpdateLinkedInOrganizationData, type UpdateLinkedInOrganizationError, type UpdateLinkedInOrganizationResponse, type UpdatePinterestBoardsData, type UpdatePinterestBoardsError, type UpdatePinterestBoardsResponse, type UpdatePostData, type UpdatePostError, type UpdatePostMetadataData, type UpdatePostMetadataError, type UpdatePostMetadataResponse, type UpdatePostResponse, type UpdateProfileData, type UpdateProfileError, type UpdateProfileResponse, type UpdateQueueSlotData, type UpdateQueueSlotError, type UpdateQueueSlotResponse, type UpdateRedditSubredditsData, type UpdateRedditSubredditsError, type UpdateRedditSubredditsResponse, type UpdateSequenceData, type UpdateSequenceError, type UpdateSequenceResponse, type UpdateSlackSettingsData, type UpdateSlackSettingsError, type UpdateSlackSettingsResponse, type UpdateTrackingTagData, type UpdateTrackingTagError, type UpdateTrackingTagResponse, type UpdateValueRuleSetData, type UpdateValueRuleSetError, type UpdateValueRuleSetResponse, type UpdateWebhookSettingsData, type UpdateWebhookSettingsError, type UpdateWebhookSettingsResponse, type UpdateWhatsAppBusinessProfileData, type UpdateWhatsAppBusinessProfileError, type UpdateWhatsAppBusinessProfileResponse, type UpdateWhatsAppCallingData, type UpdateWhatsAppCallingError, type UpdateWhatsAppCallingLegacyData, type UpdateWhatsAppCallingLegacyError, type UpdateWhatsAppCallingLegacyResponse, type UpdateWhatsAppCallingResponse, type UpdateWhatsAppDisplayNameData, type UpdateWhatsAppDisplayNameError, type UpdateWhatsAppDisplayNameResponse, type UpdateWhatsAppFlowData, type UpdateWhatsAppFlowError, type UpdateWhatsAppFlowResponse, type UpdateWhatsAppGroupChatData, type UpdateWhatsAppGroupChatError, type UpdateWhatsAppGroupChatResponse, type UpdateWhatsAppTemplateData, type UpdateWhatsAppTemplateError, type UpdateWhatsAppTemplateResponse, type UpdateWorkflowData, type UpdateWorkflowError, type UpdateWorkflowResponse, type UpdateYoutubeDefaultPlaylistData, type UpdateYoutubeDefaultPlaylistError, type UpdateYoutubeDefaultPlaylistResponse, type UploadAdImageData, type UploadAdImageError, type UploadAdImageResponse, type UploadMediaDirectData, type UploadMediaDirectError, type UploadMediaDirectResponse, type UploadPhoneNumberKycDocumentData, type UploadPhoneNumberKycDocumentError, type UploadPhoneNumberKycDocumentResponse, type UploadPhoneNumberPortInDocumentData, type UploadPhoneNumberPortInDocumentError, type UploadPhoneNumberPortInDocumentResponse, type UploadSmsOptInProofData, type UploadSmsOptInProofError, type UploadSmsOptInProofFileData, type UploadSmsOptInProofFileError, type UploadSmsOptInProofFileResponse, type UploadSmsOptInProofResponse, type UploadTokenResponse, type UploadTokenStatusResponse, type UploadWhatsAppFlowJsonData, type UploadWhatsAppFlowJsonError, type UploadWhatsAppFlowJsonResponse, type UploadWhatsAppNumberKycDocumentData, type UploadWhatsAppNumberKycDocumentError, type UploadWhatsAppNumberKycDocumentResponse, type UploadWhatsAppProfilePhotoData, type UploadWhatsAppProfilePhotoError, type UploadWhatsAppProfilePhotoResponse, type UploadedFile, type UsageMetering, type UsageStats, type User, type UserGetResponse, type UsersListResponse, type ValidateMediaData, type ValidateMediaError, type ValidateMediaResponse, type ValidatePhoneNumberKycAddressData, type ValidatePhoneNumberKycAddressError, type ValidatePhoneNumberKycAddressResponse, type ValidatePostData, type ValidatePostError, type ValidatePostLengthData, type ValidatePostLengthError, type ValidatePostLengthResponse, type ValidatePostResponse, type ValidateSubredditData, type ValidateSubredditError, type ValidateSubredditResponse, type ValidateWhatsAppNumberKycAddressData, type ValidateWhatsAppNumberKycAddressError, type ValidateWhatsAppNumberKycAddressResponse, ValidationError, type ValueRule, type ValueRuleCriterion, type ValueRuleSet, type Verification, type VerifyCredentialError, type VerifyCredentialResponse, type VerifySmsRegistrationOtpData, type VerifySmsRegistrationOtpError, type VerifySmsRegistrationOtpResponse, type VerifyWhatsAppCallerIdData, type VerifyWhatsAppCallerIdError, type VerifyWhatsAppCallerIdResponse, type ViewPhoneNumberKycDocumentData, type ViewPhoneNumberKycDocumentError, type ViewPhoneNumberKycDocumentResponse, type VoteRedditThingData, type VoteRedditThingError, type VoteRedditThingResponse, type Webhook, type WebhookLog, type WebhookPayloadAccountAdsInitialSyncCompleted, type WebhookPayloadAccountConnected, type WebhookPayloadAccountDisconnected, type WebhookPayloadAdStatusChanged, type WebhookPayloadCallEnded, type WebhookPayloadCallFailed, type WebhookPayloadCallPermissionRequest, type WebhookPayloadCallReceived, type WebhookPayloadComment, type WebhookPayloadConversationStarted, type WebhookPayloadExternalPost, type WebhookPayloadLead, type WebhookPayloadMessage, type WebhookPayloadMessageDeleted, type WebhookPayloadMessageDeliveryStatus, type WebhookPayloadMessageEdited, type WebhookPayloadMessageSent, type WebhookPayloadPost, type WebhookPayloadPostPlatform, type WebhookPayloadReaction, type WebhookPayloadReferral, type WebhookPayloadReviewNew, type WebhookPayloadReviewUpdated, type WebhookPayloadTest, type WebhookPayloadWhatsAppTemplateCategoryUpdated, type WebhookPayloadWhatsAppTemplateStatusUpdated, type WhatsAppBodyComponent, type WhatsAppButtonsComponent, type WhatsAppCarouselCardComponent, type WhatsAppCarouselComponent, type WhatsAppFooterComponent, type WhatsAppHeaderComponent, type WhatsAppLimitedTimeOfferComponent, type WhatsAppNamedParamExample, type WhatsAppSandboxSession, type WhatsAppTemplateButton, type WhatsAppTemplateComponent, type WorkflowEdge, type WorkflowExecutionEvent, type WorkflowNode, type XApiOperation, type XApiPricing, type XArticle, type XArticleBlock, type XArticleContentState, type XArticleEntity, type XArticleEntityRange, type XArticleInlineStyleRange, type XArticleTextRange, type YouTubeDailyViewsResponse, type YouTubeDemographicsResponse, type YouTubePlatformData, type YouTubeScopeMissingResponse, type YouTubeVideoRetentionResponse, Zernio, ZernioApiError, type action, type action2, type actionSource, type adType, type adType2, type adType3, type adjustSign, type advantageAudience, type aggregation, type aggregation2, type audioType, type autoArchiveDuration, type bidStrategy, type billingPeriod, type billingSystem, type billingSystem2, type budgetLevel, type budgetType, type callToAction, type category, type changeType, type channel, type channel2, type commercialContentType, type contactsOrigin, type contentType, type contentType2, type contentType3, type costType, type creativeSelection, type creativeType, type criteriaType, Zernio as default, type direction, type direction2, type disconnectionType, type duration, type endReason, type entity_type, type errorCategory, type errorCategory2, type errorSource, type event, type event10, type event11, type event12, type event13, type event14, type event15, type event16, type event17, type event18, type event19, type event2, type event20, type event21, type event22, type event23, type event24, type event25, type event26, type event3, type event4, type event5, type event6, type event7, type event8, type event9, type followerStatus, type format, type forwardCallerId, type gapFreq, type gender, type goal, type graduationStrategy, type granularity, type incomeTier, type interactiveType, type kind, type level, type mediaStatus, type mediaType, type mediaType2, type metric, type metricType, type mode, type mutability, type objective, type operator, type otp_type, parseApiError, type parseMode, type period, type permission, type platform, type platform10, type platform11, type platform12, type platform2, type platform3, type platform4, type platform5, type platform6, type platform7, type platform8, type platform9, type previousCategory, type privacy_level, type replySettings, type response, type scheduledCategory, type scope, type source, type source2, type source3, type spiciness, type status, type status10, type status11, type status12, type status13, type status14, type status15, type status2, type status3, type status4, type status5, type status6, type status7, type status8, type status9, type style, type syncStatus, type syncStatus2, type timeframe, type topicType, type transcriptionLanguage, type trialGraduationStrategy, type type, type type10, type type11, type type12, type type2, type type3, type type4, type type5, type type6, type type7, type type8, type type9, type unavailableReason, type visibility, type whenUnknown };