@privy-io/api-types 0.4.0 → 0.6.0

package/src/resources/users.ts

@@ -318,112 +318,6 @@ export class Users extends APIResource {
 
 export type UsersCursor = Cursor<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;
-}
-
-/**
- * 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;
-
-/**
- * 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;
-}
-
-/**
- * The user object along their identity token.
- */
-export interface UserWithIdentityToken {
-  identity_token: string | null;
-
-  /**
-   * A Privy user object.
-   */
-  user: User;
-}
-
 /**
  * An email account linked to the user.
  */
@@ -1213,6 +1107,39 @@ export interface LinkedAccountAuthorizationKey {
   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.
  */
@@ -1466,6 +1393,21 @@ export interface LinkedAccountCustomJwtInput {
   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.
  */
@@ -1486,7 +1428,8 @@ export type LinkedAccountInput =
   | LinkedAccountLinkedInInput
   | LinkedAccountFarcasterInput
   | LinkedAccountTelegramInput
-  | LinkedAccountCustomJwtInput;
+  | LinkedAccountCustomJwtInput
+  | LinkedAccountPasskeyInput;
 
 /**
  * The payload for batch creating users.
@@ -1575,6 +1518,37 @@ export interface PasskeyMfaMethod {
  */
 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.
  */
@@ -1592,6 +1566,48 @@ export interface OAuthTokens {
   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<LinkedAccountInput>;
 
@@ -1761,10 +1777,6 @@ export interface UserUnlinkLinkedAccountParams {
 
 export declare namespace Users {
   export {
-    type AuthenticatedUser as AuthenticatedUser,
-    type LinkedAccount as LinkedAccount,
-    type User as User,
-    type UserWithIdentityToken as UserWithIdentityToken,
     type LinkedAccountEmail as LinkedAccountEmail,
     type LinkedAccountPhone as LinkedAccountPhone,
     type LinkedAccountBaseWallet as LinkedAccountBaseWallet,
@@ -1800,6 +1812,7 @@ export declare namespace Users {
     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,
@@ -1819,13 +1832,17 @@ export declare namespace Users {
     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,

package/src/resources/wallets/balance.ts

@@ -13,11 +13,14 @@ export class Balance extends APIResource {
    * ```ts
    * const balance = await client.wallets.balance.get(
    *   'wallet_id',
-   *   { asset: 'usdc', chain: 'ethereum' },
    * );
    * ```
    */
-  get(walletID: string, query: BalanceGetParams, options?: RequestOptions): APIPromise<BalanceGetResponse> {
+  get(
+    walletID: string,
+    query: BalanceGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BalanceGetResponse> {
     return this._client.get(path`/v1/wallets/${walletID}/balance`, { query, ...options });
   }
 }
@@ -28,7 +31,7 @@ export interface BalanceGetResponse {
 
 export namespace BalanceGetResponse {
   export interface Balance {
-    asset: 'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol';
+    asset: 'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
 
     chain:
       | 'ethereum'
@@ -57,7 +60,14 @@ export namespace BalanceGetResponse {
 }
 
 export interface BalanceGetParams {
-  asset:
+  /**
+   * The token contract address(es) to query in format "chain:address" (e.g.,
+   * "base:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" or
+   * "solana:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v").
+   */
+  token?: string | Array<string>;
+
+  asset?:
     | 'usdc'
     | 'eth'
     | 'pol'
@@ -67,7 +77,7 @@ export interface BalanceGetParams {
     | 'sol'
     | Array<'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol'>;
 
-  chain:
+  chain?:
     | 'ethereum'
     | 'arbitrum'
     | 'base'

package/src/resources/wallets/index.ts

@@ -4,12 +4,11 @@ export { Balance, type BalanceGetResponse, type BalanceGetParams } from './balan
 export { Transactions, type TransactionGetResponse, type TransactionGetParams } from './transactions';
 export {
   Wallets,
+  type WalletRevokeResponse,
   type CurveSigningChainType,
+  type ExtendedChainType,
   type FirstClassChainType,
-  type Wallet,
   type WalletChainType,
-  type WalletRevokeResponse,
-  type ExtendedChainType,
   type WalletCustodian,
   type CustodialWalletProvider,
   type CustodialWalletChainType,
@@ -17,6 +16,11 @@ export {
   type CustodialWallet,
   type HpkeImportConfig,
   type SuiCommandName,
+  type Wallet,
+  type WalletBatchItemInput,
+  type WalletBatchCreateInput,
+  type WalletBatchCreateResult,
+  type WalletBatchCreateResponse,
   type EthereumPersonalSignRpcInput,
   type EthereumSignTransactionRpcInput,
   type EthereumSendTransactionRpcInput,

package/src/resources/wallets/transactions.ts

@@ -61,7 +61,7 @@ export namespace TransactionGetResponse {
 
   export namespace Transaction {
     export interface UnionMember0 {
-      asset: 'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol';
+      asset: 'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
 
       chain:
         | 'ethereum'
@@ -99,7 +99,7 @@ export namespace TransactionGetResponse {
     }
 
     export interface UnionMember1 {
-      asset: 'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol';
+      asset: 'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
 
       chain:
         | 'ethereum'