@privy-io/api-types 0.3.4 → 0.5.0

package/resources/users.d.ts

@@ -232,313 +232,137 @@ export declare class Users extends APIResource {
 }
 export type UsersCursor = Cursor<User>;
 /**
- * The authenticated user.
+ * An email account linked to the user.
  */
-export interface AuthenticatedUser {
-    token: string | null;
-    privy_access_token: string | null;
-    refresh_token: string | null;
-    /**
-     * Instructs the client on how to handle tokens received
-     */
-    session_update_action: 'set' | 'ignore' | 'clear';
-    user: User;
-    identity_token?: string;
-    is_new_user?: boolean;
-    /**
-     * OAuth tokens associated with the user.
-     */
-    oauth_tokens?: AuthenticatedUser.OAuthTokens;
+export interface LinkedAccountEmail {
+    address: string;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    type: 'email';
+    verified_at: number;
 }
-export declare namespace AuthenticatedUser {
-    /**
-     * OAuth tokens associated with the user.
-     */
-    interface OAuthTokens {
-        access_token: string;
-        provider: string;
-        access_token_expires_in_seconds?: number;
-        refresh_token?: string;
-        refresh_token_expires_in_seconds?: number;
-        scopes?: Array<string>;
-    }
+/**
+ * A phone number account linked to the user.
+ */
+export interface LinkedAccountPhone {
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    phoneNumber: string;
+    type: 'phone';
+    verified_at: number;
+    number?: string;
 }
 /**
- * A linked account for the user.
+ * Base schema for wallet accounts linked to the user.
  */
-export type LinkedAccount = LinkedAccount.LinkedAccountEmail | LinkedAccount.LinkedAccountPhone | LinkedAccount.LinkedAccountCrossApp | LinkedAccount.LinkedAccountAuthorizationKey | LinkedAccount.LinkedAccountCustomJwt | LinkedAccount.LinkedAccountAppleOAuth | LinkedAccount.LinkedAccountDiscordOAuth | LinkedAccount.LinkedAccountGitHubOAuth | LinkedAccount.LinkedAccountGoogleOAuth | LinkedAccount.LinkedAccountInstagramOAuth | LinkedAccount.LinkedAccountLinkedInOAuth | LinkedAccount.LinkedAccountSpotifyOAuth | LinkedAccount.LinkedAccountTiktokOAuth | LinkedAccount.LinkedAccountLineOAuth | LinkedAccount.LinkedAccountTwitchOAuth | LinkedAccount.LinkedAccountTwitterOAuth | LinkedAccountSmartWallet | LinkedAccount.LinkedAccountPasskey | LinkedAccount.LinkedAccountFarcaster | LinkedAccount.LinkedAccountTelegram | LinkedAccount.LinkedAccountEthereum | LinkedAccountEthereumEmbeddedWallet | LinkedAccount.LinkedAccountSolana | LinkedAccountSolanaEmbeddedWallet | LinkedAccountBitcoinSegwitEmbeddedWallet | LinkedAccountBitcoinTaprootEmbeddedWallet | LinkedAccountCurveSigningEmbeddedWallet | LinkedAccount.LinkedAccountCustomOAuth;
-export declare namespace LinkedAccount {
-    interface LinkedAccountEmail {
-        address: string;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        type: 'email';
-        verified_at: number;
-    }
-    interface LinkedAccountPhone {
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        phoneNumber: string;
-        type: 'phone';
-        verified_at: number;
-        number?: string;
-    }
-    interface LinkedAccountCrossApp {
-        embedded_wallets: Array<LinkedAccountCrossApp.EmbeddedWallet>;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        provider_app_id: string;
-        smart_wallets: Array<LinkedAccountCrossApp.SmartWallet>;
-        subject: string;
-        type: 'cross_app';
-        verified_at: number;
-    }
-    namespace LinkedAccountCrossApp {
-        interface EmbeddedWallet {
-            address: string;
-        }
-        interface SmartWallet {
-            address: string;
-        }
-    }
-    interface LinkedAccountAuthorizationKey {
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        public_key: string;
-        type: 'authorization_key';
-        verified_at: number;
-    }
-    interface LinkedAccountCustomJwt {
-        custom_user_id: string;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        type: 'custom_auth';
-        verified_at: number;
-    }
-    interface LinkedAccountAppleOAuth {
-        email: string | null;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        subject: string;
-        type: 'apple_oauth';
-        verified_at: number;
-    }
-    interface LinkedAccountDiscordOAuth {
-        email: string | null;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        subject: string;
-        type: 'discord_oauth';
-        username: string | null;
-        verified_at: number;
-    }
-    interface LinkedAccountGitHubOAuth {
-        email: string | null;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        name: string | null;
-        subject: string;
-        type: 'github_oauth';
-        username: string | null;
-        verified_at: number;
-    }
-    interface LinkedAccountGoogleOAuth {
-        email: string;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        name: string | null;
-        subject: string;
-        type: 'google_oauth';
-        verified_at: number;
-    }
-    interface LinkedAccountInstagramOAuth {
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        subject: string;
-        type: 'instagram_oauth';
-        username: string | null;
-        verified_at: number;
-    }
-    interface LinkedAccountLinkedInOAuth {
-        email: string | null;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        subject: string;
-        type: 'linkedin_oauth';
-        verified_at: number;
-        name?: string;
-        vanity_name?: string;
-    }
-    interface LinkedAccountSpotifyOAuth {
-        email: string | null;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        name: string | null;
-        subject: string;
-        type: 'spotify_oauth';
-        verified_at: number;
-    }
-    interface LinkedAccountTiktokOAuth {
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        name: string | null;
-        subject: string;
-        type: 'tiktok_oauth';
-        username: string | null;
-        verified_at: number;
-    }
-    interface LinkedAccountLineOAuth {
-        email: string | null;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        name: string | null;
-        profile_picture_url: string | null;
-        subject: string;
-        type: 'line_oauth';
-        verified_at: number;
-    }
-    interface LinkedAccountTwitchOAuth {
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        subject: string;
-        type: 'twitch_oauth';
-        username: string | null;
-        verified_at: number;
-    }
-    interface LinkedAccountTwitterOAuth {
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        name: string | null;
-        profile_picture_url: string | null;
-        subject: string;
-        type: 'twitter_oauth';
-        username: string | null;
-        verified_at: number;
-    }
-    interface LinkedAccountPasskey {
-        credential_id: string;
-        enrolled_in_mfa: boolean;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        type: 'passkey';
-        verified_at: number;
-        authenticator_name?: string;
-        created_with_browser?: string;
-        created_with_device?: string;
-        created_with_os?: string;
-        public_key?: string;
-    }
-    interface LinkedAccountFarcaster {
-        fid: number;
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        owner_address: string;
-        type: 'farcaster';
-        verified_at: number;
-        bio?: string;
-        display_name?: string;
-        homepage_url?: string;
-        profile_picture?: string;
-        profile_picture_url?: string;
-        signer_public_key?: string;
-        username?: string;
-    }
-    interface LinkedAccountTelegram {
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        telegram_user_id: string;
-        telegramUserId: string;
-        type: 'telegram';
-        verified_at: number;
-        first_name?: string | null;
-        firstName?: string | null;
-        last_name?: string | null;
-        photo_url?: string | null;
-        username?: string | null;
-    }
-    interface LinkedAccountEthereum {
-        address: string;
-        chain_type: 'ethereum';
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        type: 'wallet';
-        verified_at: number;
-        wallet_client: 'unknown';
-        chain_id?: string;
-        connector_type?: string;
-        wallet_client_type?: string;
-    }
-    interface LinkedAccountSolana {
-        address: string;
-        chain_type: 'solana';
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        type: 'wallet';
-        verified_at: number;
-        wallet_client: 'unknown';
-        connector_type?: string;
-        wallet_client_type?: string;
-    }
-    interface LinkedAccountCustomOAuth {
-        first_verified_at: number | null;
-        latest_verified_at: number | null;
-        subject: string;
-        /**
-         * The ID of a custom OAuth provider, set up for this app. Must start with
-         * "custom:".
-         */
-        type: ClientAuthAPI.CustomOAuthProviderID;
-        verified_at: number;
-        email?: string;
-        name?: string;
-        profile_picture_url?: string;
-        username?: string;
-    }
+export interface LinkedAccountBaseWallet {
+    address: string;
+    chain_type: 'solana' | 'ethereum';
+    type: 'wallet' | 'smart_wallet';
 }
-export interface User {
-    id: string;
-    /**
-     * Unix timestamp of when the user was created in milliseconds.
-     */
-    created_at: number;
-    /**
-     * Indicates if the user has accepted the terms of service.
-     */
-    has_accepted_terms: boolean;
-    /**
-     * Indicates if the user is a guest account user.
-     */
-    is_guest: boolean;
-    linked_accounts: Array<LinkedAccount>;
-    mfa_methods: Array<User.PasskeyMfaMethod | User.SMSMfaMethod | User.TotpMfaMethod>;
+/**
+ * An Ethereum wallet account linked to the user.
+ */
+export interface LinkedAccountEthereum {
+    address: string;
+    chain_type: 'ethereum';
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    type: 'wallet';
+    verified_at: number;
+    wallet_client: 'unknown';
+    chain_id?: string;
+    connector_type?: string;
+    wallet_client_type?: string;
+}
+/**
+ * The provider for a smart wallet.
+ */
+export type SmartWalletType = 'safe' | 'kernel' | 'light_account' | 'biconomy' | 'coinbase_smart_wallet' | 'thirdweb';
+/**
+ * A smart wallet account linked to the user.
+ */
+export interface LinkedAccountSmartWallet {
+    address: string;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
     /**
-     * Custom metadata associated with the user.
+     * The provider for a smart wallet.
      */
-    custom_metadata?: {
-        [key: string]: string | number | boolean;
-    };
+    smart_wallet_type: SmartWalletType;
+    type: 'smart_wallet';
+    verified_at: number;
+    smart_wallet_version?: string;
 }
-export declare namespace User {
-    interface PasskeyMfaMethod {
-        type: 'passkey';
-        verified_at: number;
-    }
-    interface SMSMfaMethod {
-        type: 'sms';
-        verified_at: number;
-    }
-    interface TotpMfaMethod {
-        type: 'totp';
-        verified_at: number;
-    }
+/**
+ * A Solana wallet account linked to the user.
+ */
+export interface LinkedAccountSolana {
+    address: string;
+    chain_type: 'solana';
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    type: 'wallet';
+    verified_at: number;
+    wallet_client: 'unknown';
+    connector_type?: string;
+    wallet_client_type?: string;
 }
 /**
- * The user object along their identity token.
+ * A Farcaster account linked to the user.
  */
-export interface UserWithIdentityToken {
-    user: User;
-    identity_token?: string;
+export interface LinkedAccountFarcaster {
+    fid: number;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    owner_address: string;
+    type: 'farcaster';
+    verified_at: number;
+    bio?: string;
+    display_name?: string;
+    homepage_url?: string;
+    profile_picture?: string;
+    profile_picture_url?: string;
+    signer_public_key?: string;
+    username?: string;
+}
+/**
+ * A passkey account linked to the user.
+ */
+export interface LinkedAccountPasskey {
+    credential_id: string;
+    enrolled_in_mfa: boolean;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    type: 'passkey';
+    verified_at: number;
+    authenticator_name?: string;
+    created_with_browser?: string;
+    created_with_device?: string;
+    created_with_os?: string;
+    public_key?: string;
 }
+/**
+ * A Telegram account linked to the user.
+ */
+export interface LinkedAccountTelegram {
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    telegram_user_id: string;
+    type: 'telegram';
+    verified_at: number;
+    first_name?: string | null;
+    last_name?: string | null;
+    photo_url?: string | null;
+    username?: string | null;
+}
+/**
+ * The method used to recover an embedded wallet account.
+ */
+export type EmbeddedWalletRecoveryMethod = 'privy' | 'user-passcode' | 'google-drive' | 'icloud' | 'recovery-encryption-key' | 'privy-v2';
+/**
+ * An Ethereum embedded wallet account linked to the user.
+ */
 export interface LinkedAccountEthereumEmbeddedWallet {
     id: string | null;
     address: string;
@@ -549,13 +373,19 @@ export interface LinkedAccountEthereumEmbeddedWallet {
     first_verified_at: number | null;
     imported: boolean;
     latest_verified_at: number | null;
-    recovery_method: 'privy' | 'user-passcode' | 'google-drive' | 'icloud' | 'recovery-encryption-key' | 'privy-v2';
+    /**
+     * The method used to recover an embedded wallet account.
+     */
+    recovery_method: EmbeddedWalletRecoveryMethod;
     type: 'wallet';
     verified_at: number;
     wallet_client: 'privy';
     wallet_client_type: 'privy';
     wallet_index: number;
 }
+/**
+ * A Solana embedded wallet account linked to the user.
+ */
 export interface LinkedAccountSolanaEmbeddedWallet {
     id: string | null;
     address: string;
@@ -567,13 +397,19 @@ export interface LinkedAccountSolanaEmbeddedWallet {
     imported: boolean;
     latest_verified_at: number | null;
     public_key: string;
-    recovery_method: 'privy' | 'user-passcode' | 'google-drive' | 'icloud' | 'recovery-encryption-key' | 'privy-v2';
+    /**
+     * The method used to recover an embedded wallet account.
+     */
+    recovery_method: EmbeddedWalletRecoveryMethod;
     type: 'wallet';
     verified_at: number;
     wallet_client: 'privy';
     wallet_client_type: 'privy';
     wallet_index: number;
 }
+/**
+ * A Bitcoin SegWit embedded wallet account linked to the user.
+ */
 export interface LinkedAccountBitcoinSegwitEmbeddedWallet {
     id: string | null;
     address: string;
@@ -585,13 +421,19 @@ export interface LinkedAccountBitcoinSegwitEmbeddedWallet {
     imported: boolean;
     latest_verified_at: number | null;
     public_key: string;
-    recovery_method: 'privy' | 'user-passcode' | 'google-drive' | 'icloud' | 'recovery-encryption-key' | 'privy-v2';
+    /**
+     * The method used to recover an embedded wallet account.
+     */
+    recovery_method: EmbeddedWalletRecoveryMethod;
     type: 'wallet';
     verified_at: number;
     wallet_client: 'privy';
     wallet_client_type: 'privy';
     wallet_index: number;
 }
+/**
+ * A Bitcoin Taproot embedded wallet account linked to the user.
+ */
 export interface LinkedAccountBitcoinTaprootEmbeddedWallet {
     id: string | null;
     address: string;
@@ -603,13 +445,19 @@ export interface LinkedAccountBitcoinTaprootEmbeddedWallet {
     imported: boolean;
     latest_verified_at: number | null;
     public_key: string;
-    recovery_method: 'privy' | 'user-passcode' | 'google-drive' | 'icloud' | 'recovery-encryption-key' | 'privy-v2';
+    /**
+     * The method used to recover an embedded wallet account.
+     */
+    recovery_method: EmbeddedWalletRecoveryMethod;
     type: 'wallet';
     verified_at: number;
     wallet_client: 'privy';
     wallet_client_type: 'privy';
     wallet_index: number;
 }
+/**
+ * A curve signing embedded wallet account linked to the user.
+ */
 export interface LinkedAccountCurveSigningEmbeddedWallet {
     id: string | null;
     address: string;
@@ -624,7 +472,10 @@ export interface LinkedAccountCurveSigningEmbeddedWallet {
     imported: boolean;
     latest_verified_at: number | null;
     public_key: string;
-    recovery_method: 'privy' | 'user-passcode' | 'google-drive' | 'icloud' | 'recovery-encryption-key' | 'privy-v2';
+    /**
+     * The method used to recover an embedded wallet account.
+     */
+    recovery_method: EmbeddedWalletRecoveryMethod;
     type: 'wallet';
     verified_at: number;
     wallet_client: 'privy';
@@ -632,155 +483,567 @@ export interface LinkedAccountCurveSigningEmbeddedWallet {
     wallet_index: number;
 }
 export type LinkedAccountEmbeddedWallet = LinkedAccountEthereumEmbeddedWallet | LinkedAccountSolanaEmbeddedWallet | LinkedAccountBitcoinSegwitEmbeddedWallet | LinkedAccountBitcoinTaprootEmbeddedWallet | LinkedAccountCurveSigningEmbeddedWallet;
+/**
+ * An embedded wallet account with an ID.
+ */
 export type LinkedAccountEmbeddedWalletWithID = LinkedAccountEmbeddedWalletWithID.LinkedAccountEthereumEmbeddedWallet | LinkedAccountEmbeddedWalletWithID.LinkedAccountSolanaEmbeddedWallet | LinkedAccountEmbeddedWalletWithID.LinkedAccountBitcoinSegwitEmbeddedWallet | LinkedAccountEmbeddedWalletWithID.LinkedAccountBitcoinTaprootEmbeddedWallet | LinkedAccountEmbeddedWalletWithID.LinkedAccountCurveSigningEmbeddedWallet;
 export declare namespace LinkedAccountEmbeddedWalletWithID {
+    /**
+     * An Ethereum embedded wallet account linked to the user.
+     */
     interface LinkedAccountEthereumEmbeddedWallet extends Omit<UsersAPI.LinkedAccountEthereumEmbeddedWallet, 'id' | 'recovery_method'> {
         id: string;
         recovery_method: 'privy-v2';
     }
+    /**
+     * A Solana embedded wallet account linked to the user.
+     */
     interface LinkedAccountSolanaEmbeddedWallet extends Omit<UsersAPI.LinkedAccountSolanaEmbeddedWallet, 'id' | 'recovery_method'> {
         id: string;
         recovery_method: 'privy-v2';
     }
+    /**
+     * A Bitcoin SegWit embedded wallet account linked to the user.
+     */
     interface LinkedAccountBitcoinSegwitEmbeddedWallet extends Omit<UsersAPI.LinkedAccountBitcoinSegwitEmbeddedWallet, 'id' | 'recovery_method'> {
         id: string;
         recovery_method: 'privy-v2';
     }
+    /**
+     * A Bitcoin Taproot embedded wallet account linked to the user.
+     */
     interface LinkedAccountBitcoinTaprootEmbeddedWallet extends Omit<UsersAPI.LinkedAccountBitcoinTaprootEmbeddedWallet, 'id' | 'recovery_method'> {
         id: string;
         recovery_method: 'privy-v2';
     }
+    /**
+     * A curve signing embedded wallet account linked to the user.
+     */
     interface LinkedAccountCurveSigningEmbeddedWallet extends Omit<UsersAPI.LinkedAccountCurveSigningEmbeddedWallet, 'id' | 'recovery_method'> {
         id: string;
         recovery_method: 'privy-v2';
     }
 }
-export type SmartWalletType = 'safe' | 'kernel' | 'light_account' | 'biconomy' | 'coinbase_smart_wallet' | 'thirdweb';
-export interface LinkedAccountSmartWallet {
+/**
+ * A Google OAuth account linked to the user.
+ */
+export interface LinkedAccountGoogleOAuth {
+    email: string;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    name: string | null;
+    subject: string;
+    type: 'google_oauth';
+    verified_at: number;
+}
+/**
+ * A Twitter OAuth account linked to the user.
+ */
+export interface LinkedAccountTwitterOAuth {
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    name: string | null;
+    profile_picture_url: string | null;
+    subject: string;
+    type: 'twitter_oauth';
+    username: string | null;
+    verified_at: number;
+}
+/**
+ * A Discord OAuth account linked to the user.
+ */
+export interface LinkedAccountDiscordOAuth {
+    email: string | null;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    subject: string;
+    type: 'discord_oauth';
+    username: string | null;
+    verified_at: number;
+}
+/**
+ * A GitHub OAuth account linked to the user.
+ */
+export interface LinkedAccountGitHubOAuth {
+    email: string | null;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    name: string | null;
+    subject: string;
+    type: 'github_oauth';
+    username: string | null;
+    verified_at: number;
+}
+/**
+ * A LinkedIn OAuth account linked to the user.
+ */
+export interface LinkedAccountLinkedInOAuth {
+    email: string | null;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    subject: string;
+    type: 'linkedin_oauth';
+    verified_at: number;
+    name?: string;
+    vanity_name?: string;
+}
+/**
+ * A Spotify OAuth account linked to the user.
+ */
+export interface LinkedAccountSpotifyOAuth {
+    email: string | null;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    name: string | null;
+    subject: string;
+    type: 'spotify_oauth';
+    verified_at: number;
+}
+/**
+ * An Instagram OAuth account linked to the user.
+ */
+export interface LinkedAccountInstagramOAuth {
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    subject: string;
+    type: 'instagram_oauth';
+    username: string | null;
+    verified_at: number;
+}
+/**
+ * A TikTok OAuth account linked to the user.
+ */
+export interface LinkedAccountTiktokOAuth {
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    name: string | null;
+    subject: string;
+    type: 'tiktok_oauth';
+    username: string | null;
+    verified_at: number;
+}
+/**
+ * A LINE OAuth account linked to the user.
+ */
+export interface LinkedAccountLineOAuth {
+    email: string | null;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    name: string | null;
+    profile_picture_url: string | null;
+    subject: string;
+    type: 'line_oauth';
+    verified_at: number;
+}
+/**
+ * A Twitch OAuth account linked to the user.
+ */
+export interface LinkedAccountTwitchOAuth {
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    subject: string;
+    type: 'twitch_oauth';
+    username: string | null;
+    verified_at: number;
+}
+/**
+ * An Apple OAuth account linked to the user.
+ */
+export interface LinkedAccountAppleOAuth {
+    email: string | null;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    subject: string;
+    type: 'apple_oauth';
+    verified_at: number;
+}
+/**
+ * A custom OAuth account linked to the user.
+ */
+export interface LinkedAccountCustomOAuth {
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    subject: string;
+    /**
+     * The ID of a custom OAuth provider, set up for this app. Must start with
+     * "custom:".
+     */
+    type: ClientAuthAPI.CustomOAuthProviderID;
+    verified_at: number;
+    email?: string;
+    name?: string;
+    profile_picture_url?: string;
+    username?: string;
+}
+/**
+ * A custom JWT account linked to the user.
+ */
+export interface LinkedAccountCustomJwt {
+    custom_user_id: string;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    type: 'custom_auth';
+    verified_at: number;
+}
+/**
+ * An embedded wallet associated with a cross-app account.
+ */
+export interface CrossAppEmbeddedWallet {
+    address: string;
+}
+/**
+ * A smart wallet associated with a cross-app account.
+ */
+export interface CrossAppSmartWallet {
     address: string;
+}
+/**
+ * A cross-app account linked to the user.
+ */
+export interface LinkedAccountCrossApp {
+    embedded_wallets: Array<CrossAppEmbeddedWallet>;
     first_verified_at: number | null;
     latest_verified_at: number | null;
-    smart_wallet_type: SmartWalletType;
-    type: 'smart_wallet';
+    provider_app_id: string;
+    smart_wallets: Array<CrossAppSmartWallet>;
+    subject: string;
+    type: 'cross_app';
     verified_at: number;
-    smart_wallet_version?: string;
+}
+/**
+ * An authorization key linked to the user.
+ */
+export interface LinkedAccountAuthorizationKey {
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+    public_key: string;
+    type: 'authorization_key';
+    verified_at: number;
+}
+/**
+ * A linked account for the user.
+ */
+export type LinkedAccount = LinkedAccountEmail | LinkedAccountPhone | LinkedAccountEthereum | LinkedAccountSolana | LinkedAccountSmartWallet | LinkedAccountEthereumEmbeddedWallet | LinkedAccountSolanaEmbeddedWallet | LinkedAccountBitcoinSegwitEmbeddedWallet | LinkedAccountBitcoinTaprootEmbeddedWallet | LinkedAccountCurveSigningEmbeddedWallet | LinkedAccountGoogleOAuth | LinkedAccountTwitterOAuth | LinkedAccountDiscordOAuth | LinkedAccountGitHubOAuth | LinkedAccountSpotifyOAuth | LinkedAccountInstagramOAuth | LinkedAccountTiktokOAuth | LinkedAccountLineOAuth | LinkedAccountTwitchOAuth | LinkedAccountLinkedInOAuth | LinkedAccountAppleOAuth | LinkedAccountCustomOAuth | LinkedAccountCustomJwt | LinkedAccountFarcaster | LinkedAccountPasskey | LinkedAccountTelegram | LinkedAccountCrossApp | LinkedAccountAuthorizationKey;
+/**
+ * The possible types of linked accounts.
+ */
+export type LinkedAccountType = 'email' | 'phone' | 'wallet' | 'smart_wallet' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth' | 'spotify_oauth' | 'instagram_oauth' | 'tiktok_oauth' | 'line_oauth' | 'twitch_oauth' | 'linkedin_oauth' | 'apple_oauth' | 'custom_auth' | 'farcaster' | 'passkey' | 'telegram' | 'cross_app' | 'authorization_key' | ClientAuthAPI.CustomOAuthProviderID;
+/**
+ * Custom metadata associated with the user.
+ */
+export type CustomMetadata = {
+    [key: string]: string | number | boolean;
+};
+/**
+ * The payload for importing a wallet account.
+ */
+export interface LinkedAccountWalletInput {
+    address: string;
+    chain_type: 'ethereum' | 'solana';
+    type: 'wallet';
+}
+/**
+ * The payload for importing an email account.
+ */
+export interface LinkedAccountEmailInput {
+    address: string;
+    type: 'email';
+}
+/**
+ * The payload for importing a phone account.
+ */
+export interface LinkedAccountPhoneInput {
+    number: string;
+    type: 'phone';
+}
+/**
+ * The payload for importing a Google account.
+ */
+export interface LinkedAccountGoogleInput {
+    email: string;
+    name: string;
+    subject: string;
+    type: 'google_oauth';
+}
+/**
+ * The payload for importing a Twitter account.
+ */
+export interface LinkedAccountTwitterInput {
+    name: string;
+    subject: string;
+    type: 'twitter_oauth';
+    username: string;
+    profile_picture_url?: string;
+}
+/**
+ * The payload for importing a Discord account.
+ */
+export interface LinkedAccountDiscordInput {
+    subject: string;
+    type: 'discord_oauth';
+    username: string;
+    email?: string;
+}
+/**
+ * The payload for importing a Github account.
+ */
+export interface LinkedAccountGitHubInput {
+    subject: string;
+    type: 'github_oauth';
+    username: string;
+    email?: string;
+    name?: string;
+}
+/**
+ * The payload for importing a Spotify account.
+ */
+export interface LinkedAccountSpotifyInput {
+    subject: string;
+    type: 'spotify_oauth';
+    email?: string;
+    name?: string;
+}
+/**
+ * The payload for importing an Instagram account.
+ */
+export interface LinkedAccountInstagramInput {
+    subject: string;
+    type: 'instagram_oauth';
+    username: string;
+}
+/**
+ * The payload for importing a Tiktok account.
+ */
+export interface LinkedAccountTiktokInput {
+    name: string | null;
+    subject: string;
+    type: 'tiktok_oauth';
+    username: string;
+}
+/**
+ * The payload for importing a LINE account.
+ */
+export interface LinkedAccountLineInput {
+    subject: string;
+    type: 'line_oauth';
+    email?: string;
+    name?: string;
+    profile_picture_url?: string;
+}
+/**
+ * The payload for importing a Twitch account.
+ */
+export interface LinkedAccountTwitchInput {
+    subject: string;
+    type: 'twitch_oauth';
+    username?: string;
+}
+/**
+ * The payload for importing an Apple account.
+ */
+export interface LinkedAccountAppleInput {
+    subject: string;
+    type: 'apple_oauth';
+    email?: string;
+}
+/**
+ * The payload for importing a LinkedIn account.
+ */
+export interface LinkedAccountLinkedInInput {
+    subject: string;
+    type: 'linkedin_oauth';
+    email?: string;
+    name?: string;
+    vanityName?: string;
+}
+/**
+ * The payload for importing a Farcaster account.
+ */
+export interface LinkedAccountFarcasterInput {
+    fid: number;
+    owner_address: string;
+    type: 'farcaster';
+    bio?: string;
+    display_name?: string;
+    homepage_url?: string;
+    profile_picture_url?: string;
+    username?: string;
+}
+/**
+ * The payload for importing a Telegram account.
+ */
+export interface LinkedAccountTelegramInput {
+    telegram_user_id: string;
+    type: 'telegram';
+    first_name?: string;
+    last_name?: string;
+    photo_url?: string;
+    username?: string;
+}
+/**
+ * The payload for importing a Custom JWT account.
+ */
+export interface LinkedAccountCustomJwtInput {
+    custom_user_id: string;
+    type: 'custom_auth';
+}
+/**
+ * The payload for importing a passkey account.
+ */
+export interface LinkedAccountPasskeyInput {
+    credential_device_type: 'singleDevice' | 'multiDevice';
+    credential_id: string;
+    credential_public_key: string;
+    credential_username: string;
+    type: 'passkey';
+}
+/**
+ * The input for adding a linked account to a user.
+ */
+export type LinkedAccountInput = LinkedAccountWalletInput | LinkedAccountEmailInput | LinkedAccountPhoneInput | LinkedAccountGoogleInput | LinkedAccountTwitterInput | LinkedAccountDiscordInput | LinkedAccountGitHubInput | LinkedAccountSpotifyInput | LinkedAccountInstagramInput | LinkedAccountTiktokInput | LinkedAccountLineInput | LinkedAccountTwitchInput | LinkedAccountAppleInput | LinkedAccountLinkedInInput | LinkedAccountFarcasterInput | LinkedAccountTelegramInput | LinkedAccountCustomJwtInput | LinkedAccountPasskeyInput;
+/**
+ * The payload for batch creating users.
+ */
+export interface UserBatchCreateInput {
+    users: Array<UserBatchCreateInput.User>;
+}
+export declare namespace UserBatchCreateInput {
+    interface User {
+        linked_accounts: Array<UsersAPI.LinkedAccountInput>;
+        create_embedded_wallet?: boolean;
+        create_ethereum_smart_wallet?: boolean;
+        create_ethereum_wallet?: boolean;
+        create_n_embedded_wallets?: number;
+        create_n_ethereum_wallets?: number;
+        create_solana_wallet?: boolean;
+        /**
+         * Custom metadata associated with the user.
+         */
+        custom_metadata?: UsersAPI.CustomMetadata;
+        wallets?: Array<User.Wallet>;
+    }
+    namespace User {
+        interface Wallet {
+            /**
+             * The wallet chain types.
+             */
+            chain_type: WalletsAPI.WalletChainType;
+            additional_signers?: Array<Wallet.AdditionalSigner>;
+            create_smart_wallet?: boolean;
+            policy_ids?: Array<string>;
+        }
+        namespace Wallet {
+            interface AdditionalSigner {
+                signer_id: string;
+                override_policy_ids?: Array<string>;
+            }
+        }
+    }
+}
+/**
+ * A SMS MFA method.
+ */
+export interface SMSMfaMethod {
+    type: 'sms';
+    verified_at: number;
+}
+/**
+ * A TOTP MFA method.
+ */
+export interface TotpMfaMethod {
+    type: 'totp';
+    verified_at: number;
+}
+/**
+ * A Passkey MFA method.
+ */
+export interface PasskeyMfaMethod {
+    type: 'passkey';
+    verified_at: number;
+}
+/**
+ * A multi-factor authentication method linked to the user.
+ */
+export type LinkedMfaMethod = SMSMfaMethod | TotpMfaMethod | PasskeyMfaMethod;
+/**
+ * A Privy user object.
+ */
+export interface User {
+    id: string;
+    /**
+     * Unix timestamp of when the user was created in milliseconds.
+     */
+    created_at: number;
+    /**
+     * Indicates if the user has accepted the terms of service.
+     */
+    has_accepted_terms: boolean;
+    /**
+     * Indicates if the user is a guest account user.
+     */
+    is_guest: boolean;
+    linked_accounts: Array<LinkedAccount>;
+    mfa_methods: Array<LinkedMfaMethod>;
+    /**
+     * Custom metadata associated with the user.
+     */
+    custom_metadata?: CustomMetadata;
+}
+/**
+ * OAuth tokens associated with the user.
+ */
+export interface OAuthTokens {
+    access_token: string;
+    provider: string;
+    access_token_expires_in_seconds?: number;
+    refresh_token?: string;
+    refresh_token_expires_in_seconds?: number;
+    scopes?: Array<string>;
+}
+/**
+ * The user object along their identity token.
+ */
+export interface UserWithIdentityToken {
+    identity_token: string | null;
+    /**
+     * A Privy user object.
+     */
+    user: User;
+}
+/**
+ * The authenticated user.
+ */
+export interface AuthenticatedUser {
+    token: string | null;
+    privy_access_token: string | null;
+    refresh_token: string | null;
+    /**
+     * Instructs the client on how to handle tokens received
+     */
+    session_update_action: 'set' | 'ignore' | 'clear';
+    /**
+     * A Privy user object.
+     */
+    user: User;
+    identity_token?: string;
+    is_new_user?: boolean;
+    /**
+     * OAuth tokens associated with the user.
+     */
+    oauth_tokens?: OAuthTokens;
 }
 export interface UserCreateParams {
-    linked_accounts: Array<UserCreateParams.LinkedAccountWalletInput | UserCreateParams.LinkedAccountEmailInput | UserCreateParams.LinkedAccountPhoneInput | UserCreateParams.LinkedAccountGoogleInput | UserCreateParams.LinkedAccountTwitterInput | UserCreateParams.LinkedAccountDiscordInput | UserCreateParams.LinkedAccountGitHubInput | UserCreateParams.LinkedAccountSpotifyInput | UserCreateParams.LinkedAccountInstagramInput | UserCreateParams.LinkedAccountTiktokInput | UserCreateParams.LinkedAccountLineInput | UserCreateParams.LinkedAccountTwitchInput | UserCreateParams.LinkedAccountAppleInput | UserCreateParams.LinkedAccountLinkedInInput | UserCreateParams.LinkedAccountFarcasterInput | UserCreateParams.LinkedAccountTelegramInput | UserCreateParams.LinkedAccountCustomJwtInput>;
+    linked_accounts: Array<LinkedAccountInput>;
     /**
      * Custom metadata associated with the user.
      */
-    custom_metadata?: {
-        [key: string]: string | number | boolean;
-    };
+    custom_metadata?: CustomMetadata;
     /**
      * Wallets to create for the user.
      */
     wallets?: Array<UserCreateParams.Wallet>;
 }
 export declare namespace UserCreateParams {
-    interface LinkedAccountWalletInput {
-        address: string;
-        chain_type: 'ethereum' | 'solana';
-        type: 'wallet';
-    }
-    interface LinkedAccountEmailInput {
-        address: string;
-        type: 'email';
-    }
-    interface LinkedAccountPhoneInput {
-        number: string;
-        type: 'phone';
-    }
-    interface LinkedAccountGoogleInput {
-        email: string;
-        name: string;
-        subject: string;
-        type: 'google_oauth';
-    }
-    interface LinkedAccountTwitterInput {
-        name: string;
-        subject: string;
-        type: 'twitter_oauth';
-        username: string;
-        profile_picture_url?: string;
-    }
-    interface LinkedAccountDiscordInput {
-        subject: string;
-        type: 'discord_oauth';
-        username: string;
-        email?: string;
-    }
-    interface LinkedAccountGitHubInput {
-        subject: string;
-        type: 'github_oauth';
-        username: string;
-        email?: string;
-        name?: string;
-    }
-    interface LinkedAccountSpotifyInput {
-        subject: string;
-        type: 'spotify_oauth';
-        email?: string;
-        name?: string;
-    }
-    interface LinkedAccountInstagramInput {
-        subject: string;
-        type: 'instagram_oauth';
-        username: string;
-    }
-    interface LinkedAccountTiktokInput {
-        name: string | null;
-        subject: string;
-        type: 'tiktok_oauth';
-        username: string;
-    }
-    interface LinkedAccountLineInput {
-        subject: string;
-        type: 'line_oauth';
-        email?: string;
-        name?: string;
-        profile_picture_url?: string;
-    }
-    interface LinkedAccountTwitchInput {
-        subject: string;
-        type: 'twitch_oauth';
-        username?: string;
-    }
-    interface LinkedAccountAppleInput {
-        subject: string;
-        type: 'apple_oauth';
-        email?: string;
-    }
-    interface LinkedAccountLinkedInInput {
-        subject: string;
-        type: 'linkedin_oauth';
-        email?: string;
-        name?: string;
-        vanityName?: string;
-    }
-    interface LinkedAccountFarcasterInput {
-        fid: number;
-        owner_address: string;
-        type: 'farcaster';
-        bio?: string;
-        display_name?: string;
-        homepage_url?: string;
-        profile_picture_url?: string;
-        username?: string;
-    }
-    interface LinkedAccountTelegramInput {
-        telegram_user_id: string;
-        type: 'telegram';
-        first_name?: string;
-        last_name?: string;
-        photo_url?: string;
-        username?: string;
-    }
-    interface LinkedAccountCustomJwtInput {
-        custom_user_id: string;
-        type: 'custom_auth';
-    }
     interface Wallet {
         /**
          * The wallet chain types.
@@ -889,16 +1152,17 @@ export interface UserSetCustomMetadataParams {
     /**
      * Custom metadata associated with the user.
      */
-    custom_metadata: {
-        [key: string]: string | number | boolean;
-    };
+    custom_metadata: CustomMetadata;
 }
 export interface UserUnlinkLinkedAccountParams {
     handle: string;
-    type: 'email' | 'wallet' | 'smart_wallet' | 'farcaster' | 'passkey' | 'phone' | 'google_oauth' | 'discord_oauth' | 'twitter_oauth' | 'github_oauth' | 'linkedin_oauth' | 'apple_oauth' | 'spotify_oauth' | 'instagram_oauth' | 'tiktok_oauth' | 'line_oauth' | 'twitch_oauth' | 'custom_auth' | 'telegram' | 'cross_app' | 'guest' | (string & {});
+    /**
+     * The possible types of linked accounts.
+     */
+    type: LinkedAccountType;
     provider?: string;
 }
 export declare namespace Users {
-    export { type AuthenticatedUser as AuthenticatedUser, type LinkedAccount as LinkedAccount, type User as User, type UserWithIdentityToken as UserWithIdentityToken, type LinkedAccountEthereumEmbeddedWallet as LinkedAccountEthereumEmbeddedWallet, type LinkedAccountSolanaEmbeddedWallet as LinkedAccountSolanaEmbeddedWallet, type LinkedAccountBitcoinSegwitEmbeddedWallet as LinkedAccountBitcoinSegwitEmbeddedWallet, type LinkedAccountBitcoinTaprootEmbeddedWallet as LinkedAccountBitcoinTaprootEmbeddedWallet, type LinkedAccountCurveSigningEmbeddedWallet as LinkedAccountCurveSigningEmbeddedWallet, type LinkedAccountEmbeddedWallet as LinkedAccountEmbeddedWallet, type LinkedAccountEmbeddedWalletWithID as LinkedAccountEmbeddedWalletWithID, type SmartWalletType as SmartWalletType, type LinkedAccountSmartWallet as LinkedAccountSmartWallet, type UsersCursor as UsersCursor, type UserCreateParams as UserCreateParams, type UserListParams as UserListParams, type UserGetByCustomAuthIDParams as UserGetByCustomAuthIDParams, type UserGetByDiscordUsernameParams as UserGetByDiscordUsernameParams, type UserGetByEmailAddressParams as UserGetByEmailAddressParams, type UserGetByFarcasterIDParams as UserGetByFarcasterIDParams, type UserGetByGitHubUsernameParams as UserGetByGitHubUsernameParams, type UserGetByPhoneNumberParams as UserGetByPhoneNumberParams, type UserGetBySmartWalletAddressParams as UserGetBySmartWalletAddressParams, type UserGetByTelegramUserIDParams as UserGetByTelegramUserIDParams, type UserGetByTelegramUsernameParams as UserGetByTelegramUsernameParams, type UserGetByTwitterSubjectParams as UserGetByTwitterSubjectParams, type UserGetByTwitterUsernameParams as UserGetByTwitterUsernameParams, type UserGetByWalletAddressParams as UserGetByWalletAddressParams, type UserPregenerateWalletsParams as UserPregenerateWalletsParams, type UserSearchParams as UserSearchParams, type UserSetCustomMetadataParams as UserSetCustomMetadataParams, type UserUnlinkLinkedAccountParams as UserUnlinkLinkedAccountParams, };
+    export { type LinkedAccountEmail as LinkedAccountEmail, type LinkedAccountPhone as LinkedAccountPhone, type LinkedAccountBaseWallet as LinkedAccountBaseWallet, type LinkedAccountEthereum as LinkedAccountEthereum, type SmartWalletType as SmartWalletType, type LinkedAccountSmartWallet as LinkedAccountSmartWallet, type LinkedAccountSolana as LinkedAccountSolana, type LinkedAccountFarcaster as LinkedAccountFarcaster, type LinkedAccountPasskey as LinkedAccountPasskey, type LinkedAccountTelegram as LinkedAccountTelegram, type EmbeddedWalletRecoveryMethod as EmbeddedWalletRecoveryMethod, type LinkedAccountEthereumEmbeddedWallet as LinkedAccountEthereumEmbeddedWallet, type LinkedAccountSolanaEmbeddedWallet as LinkedAccountSolanaEmbeddedWallet, type LinkedAccountBitcoinSegwitEmbeddedWallet as LinkedAccountBitcoinSegwitEmbeddedWallet, type LinkedAccountBitcoinTaprootEmbeddedWallet as LinkedAccountBitcoinTaprootEmbeddedWallet, type LinkedAccountCurveSigningEmbeddedWallet as LinkedAccountCurveSigningEmbeddedWallet, type LinkedAccountEmbeddedWallet as LinkedAccountEmbeddedWallet, type LinkedAccountEmbeddedWalletWithID as LinkedAccountEmbeddedWalletWithID, type LinkedAccountGoogleOAuth as LinkedAccountGoogleOAuth, type LinkedAccountTwitterOAuth as LinkedAccountTwitterOAuth, type LinkedAccountDiscordOAuth as LinkedAccountDiscordOAuth, type LinkedAccountGitHubOAuth as LinkedAccountGitHubOAuth, type LinkedAccountLinkedInOAuth as LinkedAccountLinkedInOAuth, type LinkedAccountSpotifyOAuth as LinkedAccountSpotifyOAuth, type LinkedAccountInstagramOAuth as LinkedAccountInstagramOAuth, type LinkedAccountTiktokOAuth as LinkedAccountTiktokOAuth, type LinkedAccountLineOAuth as LinkedAccountLineOAuth, type LinkedAccountTwitchOAuth as LinkedAccountTwitchOAuth, type LinkedAccountAppleOAuth as LinkedAccountAppleOAuth, type LinkedAccountCustomOAuth as LinkedAccountCustomOAuth, type LinkedAccountCustomJwt as LinkedAccountCustomJwt, type CrossAppEmbeddedWallet as CrossAppEmbeddedWallet, type CrossAppSmartWallet as CrossAppSmartWallet, type LinkedAccountCrossApp as LinkedAccountCrossApp, type LinkedAccountAuthorizationKey as LinkedAccountAuthorizationKey, type LinkedAccount as LinkedAccount, type LinkedAccountType as LinkedAccountType, type CustomMetadata as CustomMetadata, type LinkedAccountWalletInput as LinkedAccountWalletInput, type LinkedAccountEmailInput as LinkedAccountEmailInput, type LinkedAccountPhoneInput as LinkedAccountPhoneInput, type LinkedAccountGoogleInput as LinkedAccountGoogleInput, type LinkedAccountTwitterInput as LinkedAccountTwitterInput, type LinkedAccountDiscordInput as LinkedAccountDiscordInput, type LinkedAccountGitHubInput as LinkedAccountGitHubInput, type LinkedAccountSpotifyInput as LinkedAccountSpotifyInput, type LinkedAccountInstagramInput as LinkedAccountInstagramInput, type LinkedAccountTiktokInput as LinkedAccountTiktokInput, type LinkedAccountLineInput as LinkedAccountLineInput, type LinkedAccountTwitchInput as LinkedAccountTwitchInput, type LinkedAccountAppleInput as LinkedAccountAppleInput, type LinkedAccountLinkedInInput as LinkedAccountLinkedInInput, type LinkedAccountFarcasterInput as LinkedAccountFarcasterInput, type LinkedAccountTelegramInput as LinkedAccountTelegramInput, type LinkedAccountCustomJwtInput as LinkedAccountCustomJwtInput, type LinkedAccountPasskeyInput as LinkedAccountPasskeyInput, type LinkedAccountInput as LinkedAccountInput, type UserBatchCreateInput as UserBatchCreateInput, type SMSMfaMethod as SMSMfaMethod, type TotpMfaMethod as TotpMfaMethod, type PasskeyMfaMethod as PasskeyMfaMethod, type LinkedMfaMethod as LinkedMfaMethod, type User as User, type OAuthTokens as OAuthTokens, type UserWithIdentityToken as UserWithIdentityToken, type AuthenticatedUser as AuthenticatedUser, type UsersCursor as UsersCursor, type UserCreateParams as UserCreateParams, type UserListParams as UserListParams, type UserGetByCustomAuthIDParams as UserGetByCustomAuthIDParams, type UserGetByDiscordUsernameParams as UserGetByDiscordUsernameParams, type UserGetByEmailAddressParams as UserGetByEmailAddressParams, type UserGetByFarcasterIDParams as UserGetByFarcasterIDParams, type UserGetByGitHubUsernameParams as UserGetByGitHubUsernameParams, type UserGetByPhoneNumberParams as UserGetByPhoneNumberParams, type UserGetBySmartWalletAddressParams as UserGetBySmartWalletAddressParams, type UserGetByTelegramUserIDParams as UserGetByTelegramUserIDParams, type UserGetByTelegramUsernameParams as UserGetByTelegramUsernameParams, type UserGetByTwitterSubjectParams as UserGetByTwitterSubjectParams, type UserGetByTwitterUsernameParams as UserGetByTwitterUsernameParams, type UserGetByWalletAddressParams as UserGetByWalletAddressParams, type UserPregenerateWalletsParams as UserPregenerateWalletsParams, type UserSearchParams as UserSearchParams, type UserSetCustomMetadataParams as UserSetCustomMetadataParams, type UserUnlinkLinkedAccountParams as UserUnlinkLinkedAccountParams, };
 }
 //# sourceMappingURL=users.d.ts.map