@privy-io/api-types 0.8.0 → 0.10.0

package/src/resources/users.ts

@@ -324,221 +324,163 @@ export class Users extends APIResource {
 export type UsersCursor = Cursor<User>;
 
 /**
- * An email account linked to the user.
+ * The authenticated user.
  */
-export interface LinkedAccountEmail {
-  address: string;
-
-  first_verified_at: number | null;
-
-  latest_verified_at: number | null;
-
-  type: 'email';
+export interface AuthenticatedUser {
+  token: string | null;
 
-  verified_at: number;
-}
+  privy_access_token: string | null;
 
-/**
- * A phone number account linked to the user.
- */
-export interface LinkedAccountPhone {
-  first_verified_at: number | null;
+  refresh_token: string | null;
 
-  latest_verified_at: number | null;
+  /**
+   * Instructs the client on how to handle tokens received
+   */
+  session_update_action: 'set' | 'ignore' | 'clear';
 
-  phoneNumber: string;
+  /**
+   * A Privy user object.
+   */
+  user: User;
 
-  type: 'phone';
+  identity_token?: string;
 
-  verified_at: number;
+  is_new_user?: boolean;
 
-  number?: string;
+  /**
+   * OAuth tokens associated with the user.
+   */
+  oauth_tokens?: OAuthTokens;
 }
 
 /**
- * Base schema for wallet accounts linked to the user.
+ * An embedded wallet associated with a cross-app account.
  */
-export interface LinkedAccountBaseWallet {
+export interface CrossAppEmbeddedWallet {
   address: string;
-
-  chain_type: 'solana' | 'ethereum';
-
-  type: 'wallet' | 'smart_wallet';
 }
 
 /**
- * An Ethereum wallet account linked to the user.
+ * A smart wallet associated with a cross-app account.
  */
-export interface LinkedAccountEthereum {
+export interface CrossAppSmartWallet {
   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;
 }
 
 /**
- * A smart wallet account linked to the user.
+ * Custom metadata associated with the user.
  */
-export interface LinkedAccountSmartWallet {
-  address: string;
-
-  first_verified_at: number | null;
-
-  latest_verified_at: number | null;
-
-  /**
-   * The supported smart wallet providers.
-   */
-  smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
-
-  type: 'smart_wallet';
-
-  verified_at: number;
-
-  smart_wallet_version?: string;
-}
+export type CustomMetadata = { [key: string]: string | number | boolean };
 
 /**
- * A Solana wallet account linked to the user.
+ * The method used to recover an embedded wallet account.
  */
-export interface LinkedAccountSolana {
-  address: string;
-
-  chain_type: 'solana';
-
-  first_verified_at: number | null;
-
-  latest_verified_at: number | null;
-
-  type: 'wallet';
+export type EmbeddedWalletRecoveryMethod =
+  | 'privy'
+  | 'user-passcode'
+  | 'google-drive'
+  | 'icloud'
+  | 'recovery-encryption-key'
+  | 'privy-v2';
 
-  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;
 
-  wallet_client: 'unknown';
+/**
+ * The payload for importing an Apple account.
+ */
+export interface LinkedAccountAppleInput {
+  subject: string;
 
-  connector_type?: string;
+  type: 'apple_oauth';
 
-  wallet_client_type?: string;
+  email?: string;
 }
 
 /**
- * A Farcaster account linked to the user.
+ * An Apple OAuth account linked to the user.
  */
-export interface LinkedAccountFarcaster {
-  fid: number;
+export interface LinkedAccountAppleOAuth {
+  email: string | null;
 
   first_verified_at: number | null;
 
   latest_verified_at: number | null;
 
-  owner_address: string;
+  subject: string;
 
-  type: 'farcaster';
+  type: 'apple_oauth';
 
   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.
+ * An authorization key linked to the user.
  */
-export interface LinkedAccountPasskey {
-  credential_id: string;
-
-  enrolled_in_mfa: boolean;
-
+export interface LinkedAccountAuthorizationKey {
   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;
+  public_key: string;
 
-  created_with_os?: string;
+  type: 'authorization_key';
 
-  public_key?: string;
+  verified_at: number;
 }
 
 /**
- * A Telegram account linked to the user.
+ * Base schema for wallet accounts 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;
+export interface LinkedAccountBaseWallet {
+  address: string;
 
-  photo_url?: string | null;
+  chain_type: 'solana' | 'ethereum';
 
-  username?: string | null;
+  type: 'wallet' | 'smart_wallet';
 }
 
 /**
- * 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.
+ * A Bitcoin SegWit embedded wallet account linked to the user.
  */
-export interface LinkedAccountEthereumEmbeddedWallet {
+export interface LinkedAccountBitcoinSegwitEmbeddedWallet {
   id: string | null;
 
   address: string;
 
   chain_id: string;
 
-  chain_type: 'ethereum';
+  chain_type: 'bitcoin-segwit';
 
   connector_type: 'embedded';
 
@@ -550,6 +492,8 @@ export interface LinkedAccountEthereumEmbeddedWallet {
 
   latest_verified_at: number | null;
 
+  public_key: string;
+
   /**
    * The method used to recover an embedded wallet account.
    */
@@ -567,16 +511,16 @@ export interface LinkedAccountEthereumEmbeddedWallet {
 }
 
 /**
- * A Solana embedded wallet account linked to the user.
+ * A Bitcoin Taproot embedded wallet account linked to the user.
  */
-export interface LinkedAccountSolanaEmbeddedWallet {
+export interface LinkedAccountBitcoinTaprootEmbeddedWallet {
   id: string | null;
 
   address: string;
 
   chain_id: string;
 
-  chain_type: 'solana';
+  chain_type: 'bitcoin-taproot';
 
   connector_type: 'embedded';
 
@@ -607,16 +551,40 @@ export interface LinkedAccountSolanaEmbeddedWallet {
 }
 
 /**
- * A Bitcoin SegWit embedded wallet account linked to the user.
+ * A cross-app account linked to the user.
  */
-export interface LinkedAccountBitcoinSegwitEmbeddedWallet {
-  id: string | null;
+export interface LinkedAccountCrossApp {
+  embedded_wallets: Array<CrossAppEmbeddedWallet>;
 
-  address: string;
+  first_verified_at: number | null;
 
-  chain_id: string;
+  latest_verified_at: number | null;
 
-  chain_type: 'bitcoin-segwit';
+  provider_app_id: string;
+
+  smart_wallets: Array<CrossAppSmartWallet>;
+
+  subject: string;
+
+  type: 'cross_app';
+
+  verified_at: number;
+}
+
+/**
+ * A curve signing embedded wallet account linked to the user.
+ */
+export interface LinkedAccountCurveSigningEmbeddedWallet {
+  id: string | null;
+
+  address: string;
+
+  chain_id: string;
+
+  /**
+   * The wallet chain types that support curve-based signing.
+   */
+  chain_type: WalletsAPI.CurveSigningChainType;
 
   connector_type: 'embedded';
 
@@ -647,86 +615,110 @@ export interface LinkedAccountBitcoinSegwitEmbeddedWallet {
 }
 
 /**
- * A Bitcoin Taproot embedded wallet account linked to the user.
+ * The payload for importing a Custom JWT account.
  */
-export interface LinkedAccountBitcoinTaprootEmbeddedWallet {
-  id: string | null;
+export interface LinkedAccountCustomJwtInput {
+  custom_user_id: string;
 
-  address: string;
+  type: 'custom_auth';
+}
 
-  chain_id: string;
+/**
+ * A custom JWT account linked to the user.
+ */
+export interface LinkedAccountCustomJwt {
+  custom_user_id: string;
 
-  chain_type: 'bitcoin-taproot';
+  first_verified_at: number | null;
 
-  connector_type: 'embedded';
+  latest_verified_at: number | null;
 
-  delegated: boolean;
+  type: 'custom_auth';
 
-  first_verified_at: number | null;
+  verified_at: number;
+}
 
-  imported: boolean;
+/**
+ * A custom OAuth account linked to the user.
+ */
+export interface LinkedAccountCustomOAuth {
+  first_verified_at: number | null;
 
   latest_verified_at: number | null;
 
-  public_key: string;
+  subject: string;
 
   /**
-   * The method used to recover an embedded wallet account.
+   * The ID of a custom OAuth provider, set up for this app. Must start with
+   * "custom:".
    */
-  recovery_method: EmbeddedWalletRecoveryMethod;
-
-  type: 'wallet';
+  type: ClientAuthAPI.CustomOAuthProviderID;
 
   verified_at: number;
 
-  wallet_client: 'privy';
+  email?: string;
 
-  wallet_client_type: 'privy';
+  name?: string;
 
-  wallet_index: number;
+  profile_picture_url?: string;
+
+  username?: string;
 }
 
 /**
- * A curve signing embedded wallet account linked to the user.
+ * The payload for importing a Discord account.
  */
-export interface LinkedAccountCurveSigningEmbeddedWallet {
-  id: string | null;
-
-  address: string;
+export interface LinkedAccountDiscordInput {
+  subject: string;
 
-  chain_id: string;
+  type: 'discord_oauth';
 
-  /**
-   * The wallet chain types that support curve-based signing.
-   */
-  chain_type: WalletsAPI.CurveSigningChainType;
+  username: string;
 
-  connector_type: 'embedded';
+  email?: string;
+}
 
-  delegated: boolean;
+/**
+ * A Discord OAuth account linked to the user.
+ */
+export interface LinkedAccountDiscordOAuth {
+  email: string | null;
 
   first_verified_at: number | null;
 
-  imported: boolean;
-
   latest_verified_at: number | null;
 
-  public_key: string;
+  subject: string;
 
-  /**
-   * The method used to recover an embedded wallet account.
-   */
-  recovery_method: EmbeddedWalletRecoveryMethod;
+  type: 'discord_oauth';
 
-  type: 'wallet';
+  username: string | null;
 
   verified_at: number;
+}
 
-  wallet_client: 'privy';
+/**
+ * An email account linked to the user.
+ */
+export interface LinkedAccountEmail {
+  address: string;
 
-  wallet_client_type: 'privy';
+  first_verified_at: number | null;
 
-  wallet_index: number;
+  latest_verified_at: number | null;
+
+  type: 'email';
+
+  verified_at: number;
+}
+
+/**
+ * The payload for importing an email account.
+ */
+export interface LinkedAccountEmailInput {
+  address: string;
+
+  type: 'email';
 }
 
 export type LinkedAccountEmbeddedWallet =
@@ -799,110 +791,139 @@ export namespace LinkedAccountEmbeddedWalletWithID {
 }
 
 /**
- * A Google OAuth account linked to the user.
+ * An Ethereum wallet account linked to the user.
  */
-export interface LinkedAccountGoogleOAuth {
-  email: string;
+export interface LinkedAccountEthereum {
+  address: string;
+
+  chain_type: 'ethereum';
 
   first_verified_at: number | null;
 
   latest_verified_at: number | null;
 
-  name: string | null;
+  type: 'wallet';
 
-  subject: string;
+  verified_at: number;
 
-  type: 'google_oauth';
+  wallet_client: 'unknown';
 
-  verified_at: number;
+  chain_id?: string;
+
+  connector_type?: string;
+
+  wallet_client_type?: string;
 }
 
 /**
- * A Twitter OAuth account linked to the user.
+ * An Ethereum embedded wallet account linked to the user.
  */
-export interface LinkedAccountTwitterOAuth {
+export interface LinkedAccountEthereumEmbeddedWallet {
+  id: string | null;
+
+  address: string;
+
+  chain_id: string;
+
+  chain_type: 'ethereum';
+
+  connector_type: 'embedded';
+
+  delegated: boolean;
+
   first_verified_at: number | null;
 
+  imported: boolean;
+
   latest_verified_at: number | null;
 
-  name: string | null;
+  /**
+   * The method used to recover an embedded wallet account.
+   */
+  recovery_method: EmbeddedWalletRecoveryMethod;
 
-  profile_picture_url: string | null;
+  type: 'wallet';
 
-  subject: string;
+  verified_at: number;
 
-  type: 'twitter_oauth';
+  wallet_client: 'privy';
 
-  username: string | null;
+  wallet_client_type: 'privy';
 
-  verified_at: number;
+  wallet_index: number;
 }
 
 /**
- * A Discord OAuth account linked to the user.
+ * A Farcaster account linked to the user.
  */
-export interface LinkedAccountDiscordOAuth {
-  email: string | null;
+export interface LinkedAccountFarcaster {
+  fid: number;
 
   first_verified_at: number | null;
 
   latest_verified_at: number | null;
 
-  subject: string;
-
-  type: 'discord_oauth';
+  owner_address: string;
 
-  username: string | null;
+  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 GitHub OAuth account linked to the user.
+ * The payload for importing a Farcaster account.
  */
-export interface LinkedAccountGitHubOAuth {
-  email: string | null;
+export interface LinkedAccountFarcasterInput {
+  fid: number;
 
-  first_verified_at: number | null;
+  owner_address: string;
 
-  latest_verified_at: number | null;
+  type: 'farcaster';
 
-  name: string | null;
+  bio?: string;
 
-  subject: string;
+  display_name?: string;
 
-  type: 'github_oauth';
+  homepage_url?: string;
 
-  username: string | null;
+  profile_picture_url?: string;
 
-  verified_at: number;
+  username?: string;
 }
 
 /**
- * A LinkedIn OAuth account linked to the user.
+ * The payload for importing a Github account.
  */
-export interface LinkedAccountLinkedInOAuth {
-  email: string | null;
-
-  first_verified_at: number | null;
-
-  latest_verified_at: number | null;
-
+export interface LinkedAccountGitHubInput {
   subject: string;
 
-  type: 'linkedin_oauth';
+  type: 'github_oauth';
 
-  verified_at: number;
+  username: string;
 
-  name?: string;
+  email?: string;
 
-  vanity_name?: string;
+  name?: string;
 }
 
 /**
- * A Spotify OAuth account linked to the user.
+ * A GitHub OAuth account linked to the user.
  */
-export interface LinkedAccountSpotifyOAuth {
+export interface LinkedAccountGitHubOAuth {
   email: string | null;
 
   first_verified_at: number | null;
@@ -913,47 +934,111 @@ export interface LinkedAccountSpotifyOAuth {
 
   subject: string;
 
-  type: 'spotify_oauth';
+  type: 'github_oauth';
 
-  verified_at: number;
+  username: string | null;
+
+  verified_at: number;
 }
 
 /**
- * An Instagram OAuth account linked to the user.
+ * The payload for importing a Google account.
  */
-export interface LinkedAccountInstagramOAuth {
+export interface LinkedAccountGoogleInput {
+  email: string;
+
+  name: string;
+
+  subject: string;
+
+  type: 'google_oauth';
+}
+
+/**
+ * A Google OAuth account linked to the user.
+ */
+export interface LinkedAccountGoogleOAuth {
+  email: string;
+
   first_verified_at: number | null;
 
   latest_verified_at: number | null;
 
-  subject: string;
+  name: string | null;
 
-  type: 'instagram_oauth';
+  subject: string;
 
-  username: string | null;
+  type: 'google_oauth';
 
   verified_at: number;
 }
 
 /**
- * A TikTok OAuth account linked to the user.
+ * The input for adding a linked account to a user.
  */
-export interface LinkedAccountTiktokOAuth {
+export type LinkedAccountInput =
+  | LinkedAccountWalletInput
+  | LinkedAccountEmailInput
+  | LinkedAccountPhoneInput
+  | LinkedAccountGoogleInput
+  | LinkedAccountTwitterInput
+  | LinkedAccountDiscordInput
+  | LinkedAccountGitHubInput
+  | LinkedAccountSpotifyInput
+  | LinkedAccountInstagramInput
+  | LinkedAccountTiktokInput
+  | LinkedAccountLineInput
+  | LinkedAccountTwitchInput
+  | LinkedAccountAppleInput
+  | LinkedAccountLinkedInInput
+  | LinkedAccountFarcasterInput
+  | LinkedAccountTelegramInput
+  | LinkedAccountCustomJwtInput
+  | LinkedAccountPasskeyInput;
+
+/**
+ * The payload for importing an Instagram account.
+ */
+export interface LinkedAccountInstagramInput {
+  subject: string;
+
+  type: 'instagram_oauth';
+
+  username: string;
+}
+
+/**
+ * An Instagram OAuth account linked to the user.
+ */
+export interface LinkedAccountInstagramOAuth {
   first_verified_at: number | null;
 
   latest_verified_at: number | null;
 
-  name: string | null;
-
   subject: string;
 
-  type: 'tiktok_oauth';
+  type: 'instagram_oauth';
 
   username: string | null;
 
   verified_at: number;
 }
 
+/**
+ * The payload for importing a LINE account.
+ */
+export interface LinkedAccountLineInput {
+  subject: string;
+
+  type: 'line_oauth';
+
+  email?: string;
+
+  name?: string;
+
+  profile_picture_url?: string;
+}
+
 /**
  * A LINE OAuth account linked to the user.
  */
@@ -976,26 +1061,24 @@ export interface LinkedAccountLineOAuth {
 }
 
 /**
- * A Twitch OAuth account linked to the user.
+ * The payload for importing a LinkedIn account.
  */
-export interface LinkedAccountTwitchOAuth {
-  first_verified_at: number | null;
-
-  latest_verified_at: number | null;
-
+export interface LinkedAccountLinkedInInput {
   subject: string;
 
-  type: 'twitch_oauth';
+  type: 'linkedin_oauth';
 
-  username: string | null;
+  email?: string;
 
-  verified_at: number;
+  name?: string;
+
+  vanityName?: string;
 }
 
 /**
- * An Apple OAuth account linked to the user.
+ * A LinkedIn OAuth account linked to the user.
  */
-export interface LinkedAccountAppleOAuth {
+export interface LinkedAccountLinkedInOAuth {
   email: string | null;
 
   first_verified_at: number | null;
@@ -1004,489 +1087,463 @@ export interface LinkedAccountAppleOAuth {
 
   subject: string;
 
-  type: 'apple_oauth';
+  type: 'linkedin_oauth';
 
   verified_at: number;
+
+  name?: string;
+
+  vanity_name?: string;
 }
 
 /**
- * A custom OAuth account linked to the user.
+ * A passkey account linked to the user.
  */
-export interface LinkedAccountCustomOAuth {
+export interface LinkedAccountPasskey {
+  credential_id: string;
+
+  enrolled_in_mfa: boolean;
+
   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;
+  type: 'passkey';
 
   verified_at: number;
 
-  email?: string;
+  authenticator_name?: string;
 
-  name?: string;
+  created_with_browser?: string;
 
-  profile_picture_url?: string;
+  created_with_device?: string;
 
-  username?: string;
+  created_with_os?: string;
+
+  public_key?: string;
 }
 
 /**
- * A custom JWT account linked to the user.
+ * The payload for importing a passkey account.
  */
-export interface LinkedAccountCustomJwt {
-  custom_user_id: string;
+export interface LinkedAccountPasskeyInput {
+  credential_device_type: 'singleDevice' | 'multiDevice';
+
+  credential_id: string;
+
+  credential_public_key: string;
+
+  credential_username: string;
+
+  type: 'passkey';
+}
 
+/**
+ * A phone number account linked to the user.
+ */
+export interface LinkedAccountPhone {
   first_verified_at: number | null;
 
   latest_verified_at: number | null;
 
-  type: 'custom_auth';
+  phoneNumber: string;
+
+  type: 'phone';
 
   verified_at: number;
+
+  number?: string;
 }
 
 /**
- * An embedded wallet associated with a cross-app account.
+ * The payload for importing a phone account.
  */
-export interface CrossAppEmbeddedWallet {
-  address: string;
+export interface LinkedAccountPhoneInput {
+  number: string;
+
+  type: 'phone';
 }
 
 /**
- * A smart wallet associated with a cross-app account.
+ * A smart wallet account linked to the user.
  */
-export interface CrossAppSmartWallet {
+export interface LinkedAccountSmartWallet {
   address: string;
+
+  first_verified_at: number | null;
+
+  latest_verified_at: number | null;
+
+  /**
+   * The supported smart wallet providers.
+   */
+  smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
+
+  type: 'smart_wallet';
+
+  verified_at: number;
+
+  smart_wallet_version?: string;
 }
 
 /**
- * A cross-app account linked to the user.
+ * A Solana wallet account linked to the user.
  */
-export interface LinkedAccountCrossApp {
-  embedded_wallets: Array<CrossAppEmbeddedWallet>;
+export interface LinkedAccountSolana {
+  address: string;
+
+  chain_type: 'solana';
 
   first_verified_at: number | null;
 
   latest_verified_at: number | null;
 
-  provider_app_id: string;
+  type: 'wallet';
 
-  smart_wallets: Array<CrossAppSmartWallet>;
+  verified_at: number;
 
-  subject: string;
+  wallet_client: 'unknown';
 
-  type: 'cross_app';
+  connector_type?: string;
 
-  verified_at: number;
+  wallet_client_type?: string;
 }
 
 /**
- * An authorization key linked to the user.
+ * A Solana embedded wallet account linked to the user.
  */
-export interface LinkedAccountAuthorizationKey {
+export interface LinkedAccountSolanaEmbeddedWallet {
+  id: string | null;
+
+  address: string;
+
+  chain_id: string;
+
+  chain_type: 'solana';
+
+  connector_type: 'embedded';
+
+  delegated: boolean;
+
   first_verified_at: number | null;
 
+  imported: boolean;
+
   latest_verified_at: number | null;
 
   public_key: string;
 
-  type: 'authorization_key';
+  /**
+   * 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 linked account for the user.
+ * The payload for importing a Spotify account.
  */
-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;
+export interface LinkedAccountSpotifyInput {
+  subject: string;
 
-/**
- * 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;
+  type: 'spotify_oauth';
 
-/**
- * A SMS MFA method.
- */
-export interface SMSMfaMethod {
-  type: 'sms';
+  email?: string;
 
-  verified_at: number;
+  name?: string;
 }
 
 /**
- * A TOTP MFA method.
+ * A Spotify OAuth account linked to the user.
  */
-export interface TotpMfaMethod {
-  type: 'totp';
+export interface LinkedAccountSpotifyOAuth {
+  email: string | null;
 
-  verified_at: number;
-}
+  first_verified_at: number | null;
 
-/**
- * A Passkey MFA method.
- */
-export interface PasskeyMfaMethod {
-  type: 'passkey';
+  latest_verified_at: number | null;
 
-  verified_at: number;
-}
+  name: string | null;
 
-/**
- * A multi-factor authentication method linked to the user.
- */
-export type LinkedMfaMethod = SMSMfaMethod | TotpMfaMethod | PasskeyMfaMethod;
+  subject: string;
 
-/**
- * Custom metadata associated with the user.
- */
-export type CustomMetadata = { [key: string]: string | number | boolean };
+  type: 'spotify_oauth';
+
+  verified_at: number;
+}
 
 /**
- * A Privy user object.
+ * A Telegram account linked to the user.
  */
-export interface User {
-  id: string;
-
-  /**
-   * Unix timestamp of when the user was created in seconds.
-   */
-  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;
+export interface LinkedAccountTelegram {
+  first_verified_at: number | null;
 
-  linked_accounts: Array<LinkedAccount>;
+  latest_verified_at: number | null;
 
-  mfa_methods: Array<LinkedMfaMethod>;
+  telegram_user_id: string;
 
-  /**
-   * Custom metadata associated with the user.
-   */
-  custom_metadata?: CustomMetadata;
-}
+  type: 'telegram';
 
-/**
- * The payload for importing a wallet account.
- */
-export interface LinkedAccountWalletInput {
-  address: string;
+  verified_at: number;
 
-  chain_type: 'ethereum' | 'solana';
+  first_name?: string | null;
 
-  type: 'wallet';
-}
+  last_name?: string | null;
 
-/**
- * The payload for importing an email account.
- */
-export interface LinkedAccountEmailInput {
-  address: string;
+  photo_url?: string | null;
 
-  type: 'email';
+  username?: string | null;
 }
 
 /**
- * The payload for importing a phone account.
+ * The payload for importing a Telegram account.
  */
-export interface LinkedAccountPhoneInput {
-  number: string;
+export interface LinkedAccountTelegramInput {
+  telegram_user_id: string;
 
-  type: 'phone';
-}
+  type: 'telegram';
 
-/**
- * The payload for importing a Google account.
- */
-export interface LinkedAccountGoogleInput {
-  email: string;
+  first_name?: string;
 
-  name: string;
+  last_name?: string;
 
-  subject: string;
+  photo_url?: string;
 
-  type: 'google_oauth';
+  username?: string;
 }
 
 /**
- * The payload for importing a Twitter account.
+ * The payload for importing a Tiktok account.
  */
-export interface LinkedAccountTwitterInput {
-  name: string;
+export interface LinkedAccountTiktokInput {
+  name: string | null;
 
   subject: string;
 
-  type: 'twitter_oauth';
+  type: 'tiktok_oauth';
 
   username: string;
-
-  profile_picture_url?: string;
 }
 
 /**
- * The payload for importing a Discord account.
+ * A TikTok OAuth account linked to the user.
  */
-export interface LinkedAccountDiscordInput {
-  subject: string;
-
-  type: 'discord_oauth';
+export interface LinkedAccountTiktokOAuth {
+  first_verified_at: number | null;
 
-  username: string;
+  latest_verified_at: number | null;
 
-  email?: string;
-}
+  name: string | null;
 
-/**
- * The payload for importing a Github account.
- */
-export interface LinkedAccountGitHubInput {
   subject: string;
 
-  type: 'github_oauth';
-
-  username: string;
+  type: 'tiktok_oauth';
 
-  email?: string;
+  username: string | null;
 
-  name?: string;
+  verified_at: number;
 }
 
 /**
- * The payload for importing a Spotify account.
+ * The payload for importing a Twitch account.
  */
-export interface LinkedAccountSpotifyInput {
+export interface LinkedAccountTwitchInput {
   subject: string;
 
-  type: 'spotify_oauth';
-
-  email?: string;
+  type: 'twitch_oauth';
 
-  name?: string;
+  username?: string;
 }
 
 /**
- * The payload for importing an Instagram account.
+ * A Twitch OAuth account linked to the user.
  */
-export interface LinkedAccountInstagramInput {
+export interface LinkedAccountTwitchOAuth {
+  first_verified_at: number | null;
+
+  latest_verified_at: number | null;
+
   subject: string;
 
-  type: 'instagram_oauth';
+  type: 'twitch_oauth';
 
-  username: string;
+  username: string | null;
+
+  verified_at: number;
 }
 
 /**
- * The payload for importing a Tiktok account.
+ * The payload for importing a Twitter account.
  */
-export interface LinkedAccountTiktokInput {
-  name: string | null;
+export interface LinkedAccountTwitterInput {
+  name: string;
 
   subject: string;
 
-  type: 'tiktok_oauth';
+  type: 'twitter_oauth';
 
   username: string;
+
+  profile_picture_url?: string;
 }
 
 /**
- * The payload for importing a LINE account.
+ * A Twitter OAuth account linked to the user.
  */
-export interface LinkedAccountLineInput {
-  subject: string;
-
-  type: 'line_oauth';
+export interface LinkedAccountTwitterOAuth {
+  first_verified_at: number | null;
 
-  email?: string;
+  latest_verified_at: number | null;
 
-  name?: string;
+  name: string | null;
 
-  profile_picture_url?: string;
-}
+  profile_picture_url: string | null;
 
-/**
- * The payload for importing a Twitch account.
- */
-export interface LinkedAccountTwitchInput {
   subject: string;
 
-  type: 'twitch_oauth';
+  type: 'twitter_oauth';
 
-  username?: string;
+  username: string | null;
+
+  verified_at: number;
 }
 
 /**
- * The payload for importing an Apple account.
+ * The possible types of linked accounts.
  */
-export interface LinkedAccountAppleInput {
-  subject: string;
-
-  type: 'apple_oauth';
-
-  email?: string;
-}
+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;
 
 /**
- * The payload for importing a LinkedIn account.
+ * The payload for importing a wallet account.
  */
-export interface LinkedAccountLinkedInInput {
-  subject: string;
-
-  type: 'linkedin_oauth';
-
-  email?: string;
+export interface LinkedAccountWalletInput {
+  address: string;
 
-  name?: string;
+  chain_type: 'ethereum' | 'solana';
 
-  vanityName?: string;
+  type: 'wallet';
 }
 
 /**
- * The payload for importing a Farcaster account.
+ * A multi-factor authentication method linked to the user.
  */
-export interface LinkedAccountFarcasterInput {
-  fid: number;
-
-  owner_address: string;
+export type LinkedMfaMethod = SMSMfaMethod | TotpMfaMethod | PasskeyMfaMethod;
 
-  type: 'farcaster';
+/**
+ * OAuth tokens associated with the user.
+ */
+export interface OAuthTokens {
+  access_token: string;
 
-  bio?: string;
+  provider: string;
 
-  display_name?: string;
+  access_token_expires_in_seconds?: number;
 
-  homepage_url?: string;
+  refresh_token?: string;
 
-  profile_picture_url?: string;
+  refresh_token_expires_in_seconds?: number;
 
-  username?: string;
+  scopes?: Array<string>;
 }
 
 /**
- * The payload for importing a Telegram account.
+ * A Passkey MFA method.
  */
-export interface LinkedAccountTelegramInput {
-  telegram_user_id: string;
-
-  type: 'telegram';
+export interface PasskeyMfaMethod {
+  type: 'passkey';
 
-  first_name?: string;
+  verified_at: number;
+}
 
-  last_name?: string;
+/**
+ * The payload for partially updating custom metadata on a user.
+ */
+export interface PatchUsersCustomMetadata {
+  /**
+   * Custom metadata associated with the user.
+   */
+  custom_metadata: CustomMetadata;
+}
 
-  photo_url?: string;
+/**
+ * A SMS MFA method.
+ */
+export interface SMSMfaMethod {
+  type: 'sms';
 
-  username?: string;
+  verified_at: number;
 }
 
 /**
- * The payload for importing a Custom JWT account.
+ * A TOTP MFA method.
  */
-export interface LinkedAccountCustomJwtInput {
-  custom_user_id: string;
+export interface TotpMfaMethod {
+  type: 'totp';
 
-  type: 'custom_auth';
+  verified_at: number;
 }
 
 /**
- * The payload for importing a passkey account.
+ * A Privy user object.
  */
-export interface LinkedAccountPasskeyInput {
-  credential_device_type: 'singleDevice' | 'multiDevice';
+export interface User {
+  id: string;
 
-  credential_id: string;
+  /**
+   * Unix timestamp of when the user was created in seconds.
+   */
+  created_at: number;
 
-  credential_public_key: string;
+  /**
+   * Indicates if the user has accepted the terms of service.
+   */
+  has_accepted_terms: boolean;
 
-  credential_username: string;
+  /**
+   * Indicates if the user is a guest account user.
+   */
+  is_guest: boolean;
 
-  type: 'passkey';
-}
+  linked_accounts: Array<LinkedAccount>;
 
-/**
- * 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;
+  mfa_methods: Array<LinkedMfaMethod>;
+
+  /**
+   * Custom metadata associated with the user.
+   */
+  custom_metadata?: CustomMetadata;
+}
 
 /**
  * The payload for batch creating users.
@@ -1523,23 +1580,6 @@ export namespace UserBatchCreateInput {
   }
 }
 
-/**
- * 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.
  */
@@ -1552,36 +1592,6 @@ export interface UserWithIdentityToken {
   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<LinkedAccountInput>;
 
@@ -1728,71 +1738,72 @@ export interface UserUnlinkLinkedAccountParams {
 
 export declare namespace Users {
   export {
-    type LinkedAccountEmail as LinkedAccountEmail,
-    type LinkedAccountPhone as LinkedAccountPhone,
-    type LinkedAccountBaseWallet as LinkedAccountBaseWallet,
-    type LinkedAccountEthereum as LinkedAccountEthereum,
-    type LinkedAccountSmartWallet as LinkedAccountSmartWallet,
-    type LinkedAccountSolana as LinkedAccountSolana,
-    type LinkedAccountFarcaster as LinkedAccountFarcaster,
-    type LinkedAccountPasskey as LinkedAccountPasskey,
-    type LinkedAccountTelegram as LinkedAccountTelegram,
+    type AuthenticatedUser as AuthenticatedUser,
+    type CrossAppEmbeddedWallet as CrossAppEmbeddedWallet,
+    type CrossAppSmartWallet as CrossAppSmartWallet,
+    type CustomMetadata as CustomMetadata,
     type EmbeddedWalletRecoveryMethod as EmbeddedWalletRecoveryMethod,
-    type LinkedAccountEthereumEmbeddedWallet as LinkedAccountEthereumEmbeddedWallet,
-    type LinkedAccountSolanaEmbeddedWallet as LinkedAccountSolanaEmbeddedWallet,
+    type LinkedAccount as LinkedAccount,
+    type LinkedAccountAppleInput as LinkedAccountAppleInput,
+    type LinkedAccountAppleOAuth as LinkedAccountAppleOAuth,
+    type LinkedAccountAuthorizationKey as LinkedAccountAuthorizationKey,
+    type LinkedAccountBaseWallet as LinkedAccountBaseWallet,
     type LinkedAccountBitcoinSegwitEmbeddedWallet as LinkedAccountBitcoinSegwitEmbeddedWallet,
     type LinkedAccountBitcoinTaprootEmbeddedWallet as LinkedAccountBitcoinTaprootEmbeddedWallet,
+    type LinkedAccountCrossApp as LinkedAccountCrossApp,
     type LinkedAccountCurveSigningEmbeddedWallet as LinkedAccountCurveSigningEmbeddedWallet,
+    type LinkedAccountCustomJwtInput as LinkedAccountCustomJwtInput,
+    type LinkedAccountCustomJwt as LinkedAccountCustomJwt,
+    type LinkedAccountCustomOAuth as LinkedAccountCustomOAuth,
+    type LinkedAccountDiscordInput as LinkedAccountDiscordInput,
+    type LinkedAccountDiscordOAuth as LinkedAccountDiscordOAuth,
+    type LinkedAccountEmail as LinkedAccountEmail,
+    type LinkedAccountEmailInput as LinkedAccountEmailInput,
     type LinkedAccountEmbeddedWallet as LinkedAccountEmbeddedWallet,
     type LinkedAccountEmbeddedWalletWithID as LinkedAccountEmbeddedWalletWithID,
-    type LinkedAccountGoogleOAuth as LinkedAccountGoogleOAuth,
-    type LinkedAccountTwitterOAuth as LinkedAccountTwitterOAuth,
-    type LinkedAccountDiscordOAuth as LinkedAccountDiscordOAuth,
+    type LinkedAccountEthereum as LinkedAccountEthereum,
+    type LinkedAccountEthereumEmbeddedWallet as LinkedAccountEthereumEmbeddedWallet,
+    type LinkedAccountFarcaster as LinkedAccountFarcaster,
+    type LinkedAccountFarcasterInput as LinkedAccountFarcasterInput,
+    type LinkedAccountGitHubInput as LinkedAccountGitHubInput,
     type LinkedAccountGitHubOAuth as LinkedAccountGitHubOAuth,
+    type LinkedAccountGoogleInput as LinkedAccountGoogleInput,
+    type LinkedAccountGoogleOAuth as LinkedAccountGoogleOAuth,
+    type LinkedAccountInput as LinkedAccountInput,
+    type LinkedAccountInstagramInput as LinkedAccountInstagramInput,
+    type LinkedAccountInstagramOAuth as LinkedAccountInstagramOAuth,
+    type LinkedAccountLineInput as LinkedAccountLineInput,
+    type LinkedAccountLineOAuth as LinkedAccountLineOAuth,
+    type LinkedAccountLinkedInInput as LinkedAccountLinkedInInput,
     type LinkedAccountLinkedInOAuth as LinkedAccountLinkedInOAuth,
+    type LinkedAccountPasskey as LinkedAccountPasskey,
+    type LinkedAccountPasskeyInput as LinkedAccountPasskeyInput,
+    type LinkedAccountPhone as LinkedAccountPhone,
+    type LinkedAccountPhoneInput as LinkedAccountPhoneInput,
+    type LinkedAccountSmartWallet as LinkedAccountSmartWallet,
+    type LinkedAccountSolana as LinkedAccountSolana,
+    type LinkedAccountSolanaEmbeddedWallet as LinkedAccountSolanaEmbeddedWallet,
+    type LinkedAccountSpotifyInput as LinkedAccountSpotifyInput,
     type LinkedAccountSpotifyOAuth as LinkedAccountSpotifyOAuth,
-    type LinkedAccountInstagramOAuth as LinkedAccountInstagramOAuth,
+    type LinkedAccountTelegram as LinkedAccountTelegram,
+    type LinkedAccountTelegramInput as LinkedAccountTelegramInput,
+    type LinkedAccountTiktokInput as LinkedAccountTiktokInput,
     type LinkedAccountTiktokOAuth as LinkedAccountTiktokOAuth,
-    type LinkedAccountLineOAuth as LinkedAccountLineOAuth,
+    type LinkedAccountTwitchInput as LinkedAccountTwitchInput,
     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 LinkedAccountTwitterInput as LinkedAccountTwitterInput,
+    type LinkedAccountTwitterOAuth as LinkedAccountTwitterOAuth,
     type LinkedAccountType as LinkedAccountType,
+    type LinkedAccountWalletInput as LinkedAccountWalletInput,
+    type LinkedMfaMethod as LinkedMfaMethod,
+    type OAuthTokens as OAuthTokens,
+    type PasskeyMfaMethod as PasskeyMfaMethod,
+    type PatchUsersCustomMetadata as PatchUsersCustomMetadata,
     type SMSMfaMethod as SMSMfaMethod,
     type TotpMfaMethod as TotpMfaMethod,
-    type PasskeyMfaMethod as PasskeyMfaMethod,
-    type LinkedMfaMethod as LinkedMfaMethod,
-    type CustomMetadata as CustomMetadata,
     type User as User,
-    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 OAuthTokens as OAuthTokens,
     type UserWithIdentityToken as UserWithIdentityToken,
-    type AuthenticatedUser as AuthenticatedUser,
     type UsersCursor as UsersCursor,
     type UserCreateParams as UserCreateParams,
     type UserListParams as UserListParams,