@privy-io/api-types 0.6.1 → 0.8.0

package/src/resources/users.ts

@@ -3,6 +3,8 @@
 import { APIResource } from '../core/resource';
 import * as UsersAPI from './users';
 import * as ClientAuthAPI from './client-auth';
+import * as EmbeddedWalletsAPI from './embedded-wallets';
+import * as SharedAPI from './shared';
 import * as WalletsAPI from './wallets/wallets';
 import { APIPromise } from '../core/api-promise';
 import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
@@ -10,6 +12,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Operations related to users
+ */
 export class Users extends APIResource {
   /**
    * Create a new user with linked accounts. Optionally pre-generate embedded wallets
@@ -386,17 +391,6 @@ export interface LinkedAccountEthereum {
   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.
  */
@@ -408,9 +402,9 @@ export interface LinkedAccountSmartWallet {
   latest_verified_at: number | null;
 
   /**
-   * The provider for a smart wallet.
+   * The supported smart wallet providers.
    */
-  smart_wallet_type: SmartWalletType;
+  smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
 
   type: 'smart_wallet';
 
@@ -1167,11 +1161,74 @@ export type LinkedAccountType =
   | 'authorization_key'
   | ClientAuthAPI.CustomOAuthProviderID;
 
+/**
+ * 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;
+
 /**
  * Custom metadata associated with the user.
  */
 export type CustomMetadata = { [key: string]: string | number | boolean };
 
+/**
+ * A Privy user object.
+ */
+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;
+
+  linked_accounts: Array<LinkedAccount>;
+
+  mfa_methods: Array<LinkedMfaMethod>;
+
+  /**
+   * Custom metadata associated with the user.
+   */
+  custom_metadata?: CustomMetadata;
+}
+
 /**
  * The payload for importing a wallet account.
  */
@@ -1459,96 +1516,13 @@ export namespace UserBatchCreateInput {
      */
     custom_metadata?: UsersAPI.CustomMetadata;
 
-    wallets?: Array<User.Wallet>;
-  }
-
-  export namespace User {
-    export interface Wallet {
-      /**
-       * The wallet chain types.
-       */
-      chain_type: WalletsAPI.WalletChainType;
-
-      additional_signers?: Array<Wallet.AdditionalSigner>;
-
-      create_smart_wallet?: boolean;
-
-      policy_ids?: Array<string>;
-    }
-
-    export namespace Wallet {
-      export interface AdditionalSigner {
-        signer_id: string;
-
-        override_policy_ids?: Array<string>;
-      }
-    }
+    /**
+     * Wallets to create.
+     */
+    wallets?: Array<EmbeddedWalletsAPI.WalletCreationInput>;
   }
 }
 
-/**
- * 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.
  */
@@ -1650,9 +1624,9 @@ export namespace UserCreateParams {
   export namespace Wallet {
     export interface AdditionalSigner {
       /**
-       * The key quorum ID for the signer.
+       * A unique identifier for a key quorum.
        */
-      signer_id: string;
+      signer_id: SharedAPI.KeyQuorumID;
 
       /**
        * The array of policy IDs that will be applied to wallet requests. If specified,
@@ -1715,30 +1689,7 @@ export interface UserGetByWalletAddressParams {
 }
 
 export interface UserPregenerateWalletsParams {
-  wallets: Array<UserPregenerateWalletsParams.Wallet>;
-}
-
-export namespace UserPregenerateWalletsParams {
-  export interface Wallet {
-    /**
-     * The wallet chain types.
-     */
-    chain_type: WalletsAPI.WalletChainType;
-
-    additional_signers?: Array<Wallet.AdditionalSigner>;
-
-    create_smart_wallet?: boolean;
-
-    policy_ids?: Array<string>;
-  }
-
-  export namespace Wallet {
-    export interface AdditionalSigner {
-      signer_id: string;
-
-      override_policy_ids?: Array<string>;
-    }
-  }
+  wallets: Array<EmbeddedWalletsAPI.WalletCreationInput>;
 }
 
 export type UserSearchParams = UserSearchParams.Variant0 | UserSearchParams.Variant1;
@@ -1781,7 +1732,6 @@ export declare namespace Users {
     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,
@@ -1814,7 +1764,12 @@ export declare namespace Users {
     type LinkedAccountAuthorizationKey as LinkedAccountAuthorizationKey,
     type LinkedAccount as LinkedAccount,
     type LinkedAccountType as LinkedAccountType,
+    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,
@@ -1835,11 +1790,6 @@ export declare namespace Users {
     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,

package/src/resources/wallet-actions.ts

@@ -0,0 +1,251 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+
+export class WalletActions extends APIResource {}
+
+/**
+ * Type of wallet action
+ */
+export type WalletActionType = 'swap' | 'transfer';
+
+/**
+ * Status of a wallet action.
+ */
+export type WalletActionStatus = 'pending' | 'succeeded' | 'rejected' | 'failed';
+
+/**
+ * Type of a wallet action step.
+ */
+export type WalletActionStepType = 'evm_transaction' | 'evm_user_operation';
+
+/**
+ * Status of an EVM step in a wallet action.
+ */
+export type EvmWalletActionStepStatus =
+  | 'preparing'
+  | 'queued'
+  | 'pending'
+  | 'retrying'
+  | 'confirmed'
+  | 'rejected'
+  | 'reverted'
+  | 'replaced'
+  | 'abandoned';
+
+/**
+ * A description of why a wallet action (or a step within a wallet action) failed.
+ */
+export interface FailureReason {
+  /**
+   * Human-readable failure message.
+   */
+  message: string;
+
+  /**
+   * Additional error details, if available.
+   */
+  details?: unknown;
+}
+
+/**
+ * A wallet action step consisting of an EVM transaction.
+ */
+export interface EvmTransactionWalletActionStep {
+  /**
+   * CAIP-2 chain identifier of the transaction, containing the chain ID.
+   */
+  caip2: string;
+
+  /**
+   * Status of an EVM step in a wallet action.
+   */
+  status: EvmWalletActionStepStatus;
+
+  /**
+   * The transaction hash for this step. May change while the step status is
+   * non-terminal.
+   */
+  transaction_hash: string | null;
+
+  type: 'evm_transaction';
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason?: FailureReason;
+}
+
+/**
+ * A wallet action step consisting of an EVM user operation.
+ */
+export interface EvmUserOperationWalletActionStep {
+  /**
+   * Transaction hash of the bundle in which this user operation was included. Null
+   * until included by a bundler.
+   */
+  bundle_transaction_hash: string | null;
+
+  /**
+   * CAIP-2 network identifier, containing the chain ID of the user operation.
+   */
+  caip2: string;
+
+  /**
+   * The entrypoint version of the user operation.
+   */
+  entrypoint_version: '0.6' | '0.7' | '0.8' | '0.9';
+
+  /**
+   * Status of an EVM step in a wallet action.
+   */
+  status: EvmWalletActionStepStatus;
+
+  type: 'evm_user_operation';
+
+  /**
+   * The user operation hash for this step. May change while the step status is
+   * non-terminal.
+   */
+  user_operation_hash: string | null;
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason?: FailureReason;
+}
+
+/**
+ * A step within a wallet action, representing a single onchain action.
+ */
+export type WalletActionStep = EvmTransactionWalletActionStep | EvmUserOperationWalletActionStep;
+
+/**
+ * Response for a swap action.
+ */
+export interface SwapActionResponse {
+  /**
+   * The ID of the wallet action.
+   */
+  id: string;
+
+  /**
+   * CAIP-2 chain identifier for the swap.
+   */
+  caip2: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * Exact base-unit amount of input token. Populated after on-chain confirmation.
+   */
+  input_amount: string | null;
+
+  /**
+   * Token address or "native" for the token being sold.
+   */
+  input_token: string;
+
+  /**
+   * Exact base-unit amount of output token. Populated after on-chain confirmation.
+   */
+  output_amount: string | null;
+
+  /**
+   * Token address or "native" for the token being bought.
+   */
+  output_token: string;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionStatus;
+
+  type: 'swap';
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+
+  /**
+   * The steps of the wallet action. Only returned if `?include=steps` is provided.
+   */
+  steps?: Array<WalletActionStep>;
+}
+
+/**
+ * Response for a transfer action.
+ */
+export interface TransferActionResponse {
+  /**
+   * The ID of the wallet action.
+   */
+  id: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * Recipient address.
+   */
+  destination_address: string;
+
+  /**
+   * Decimal amount as the user provided (e.g. "1.5").
+   */
+  source_amount: string;
+
+  /**
+   * Asset identifier (e.g. "usdc", "eth").
+   */
+  source_asset: string;
+
+  /**
+   * Chain name (e.g. "base", "ethereum").
+   */
+  source_chain: string;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionStatus;
+
+  type: 'transfer';
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+
+  /**
+   * The steps of the wallet action. Only returned if `?include=steps` is provided.
+   */
+  steps?: Array<WalletActionStep>;
+}
+
+/**
+ * Response for a wallet action, discriminated on type.
+ */
+export type WalletActionResponse = SwapActionResponse | TransferActionResponse;
+
+export declare namespace WalletActions {
+  export {
+    type WalletActionType as WalletActionType,
+    type WalletActionStatus as WalletActionStatus,
+    type WalletActionStepType as WalletActionStepType,
+    type EvmWalletActionStepStatus as EvmWalletActionStepStatus,
+    type FailureReason as FailureReason,
+    type EvmTransactionWalletActionStep as EvmTransactionWalletActionStep,
+    type EvmUserOperationWalletActionStep as EvmUserOperationWalletActionStep,
+    type WalletActionStep as WalletActionStep,
+    type SwapActionResponse as SwapActionResponse,
+    type TransferActionResponse as TransferActionResponse,
+    type WalletActionResponse as WalletActionResponse,
+  };
+}

package/src/resources/wallets/balance.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Operations related to wallets
+ */
 export class Balance extends APIResource {
   /**
    * Get the balance of a wallet by wallet ID.
@@ -31,12 +34,13 @@ export interface BalanceGetResponse {
 
 export namespace BalanceGetResponse {
   export interface Balance {
-    asset: 'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
+    asset: 'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
 
     chain:
       | 'ethereum'
       | 'arbitrum'
       | 'base'
+      | 'tempo'
       | 'linea'
       | 'optimism'
       | 'polygon'
@@ -69,18 +73,20 @@ export interface BalanceGetParams {
 
   asset?:
     | 'usdc'
+    | 'usdc.e'
     | 'eth'
     | 'pol'
     | 'usdt'
     | 'eurc'
     | 'usdb'
     | 'sol'
-    | Array<'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol'>;
+    | Array<'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol'>;
 
   chain?:
     | 'ethereum'
     | 'arbitrum'
     | 'base'
+    | 'tempo'
     | 'linea'
     | 'optimism'
     | 'polygon'
@@ -98,6 +104,7 @@ export interface BalanceGetParams {
         | 'ethereum'
         | 'arbitrum'
         | 'base'
+        | 'tempo'
         | 'linea'
         | 'optimism'
         | 'polygon'