@privy-io/api-types 0.17.0 → 0.18.0

package/src/resources/apps.ts

@@ -206,7 +206,7 @@ export interface AppResponse {
 }
 
 /**
- * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+ * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
  */
 export type Caip2 = string;
 
@@ -220,7 +220,7 @@ export type CaptchaProvider = 'turnstile' | 'hcaptcha';
  */
 export interface Currency {
   /**
-   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
    */
   chain: Caip2;
 
@@ -399,7 +399,7 @@ export interface GasSpendResponseBody {
 /**
  * A multi-factor authentication method supported by the app.
  */
-export type MfaMethod = 'sms' | 'totp' | 'passkey';
+export type MfaMethod = 'sms' | 'totp' | 'passkey' | 'email';
 
 /**
  * Allowlist invite input for a phone number.

package/src/resources/client-auth.ts

@@ -703,6 +703,43 @@ export interface LinkJwtInput {
   token?: string;
 }
 
+/**
+ * The request body for enrolling an email MFA code.
+ */
+export interface MfaEmailEnrollRequestBody {
+  code: string;
+
+  email_address: string;
+}
+
+/**
+ * Input for enrolling email MFA.
+ */
+export interface MfaEmailInitEnrollInput {
+  action: 'enroll';
+
+  email_address: string;
+}
+
+/**
+ * The request body for initiating an email MFA flow.
+ */
+export type MfaEmailInitRequestBody = MfaEmailInitVerifyInput | MfaEmailInitEnrollInput;
+
+/**
+ * Input for verifying email MFA.
+ */
+export interface MfaEmailInitVerifyInput {
+  action: 'verify';
+}
+
+/**
+ * The request body for verifying an email MFA code.
+ */
+export interface MfaEmailVerifyRequestBody {
+  code: string;
+}
+
 /**
  * The request body for enrolling a passkey MFA flow.
  */
@@ -2058,6 +2095,11 @@ export declare namespace ClientAuth {
     type FiatVirtualAccountResponse as FiatVirtualAccountResponse,
     type GuestAuthenticateRequestBody as GuestAuthenticateRequestBody,
     type LinkJwtInput as LinkJwtInput,
+    type MfaEmailEnrollRequestBody as MfaEmailEnrollRequestBody,
+    type MfaEmailInitEnrollInput as MfaEmailInitEnrollInput,
+    type MfaEmailInitRequestBody as MfaEmailInitRequestBody,
+    type MfaEmailInitVerifyInput as MfaEmailInitVerifyInput,
+    type MfaEmailVerifyRequestBody as MfaEmailVerifyRequestBody,
     type MfaPasskeyEnrollmentRequestBody as MfaPasskeyEnrollmentRequestBody,
     type MfaPasskeyInitRequestBody as MfaPasskeyInitRequestBody,
     type MfaPasskeyInitResponseBody as MfaPasskeyInitResponseBody,

package/src/resources/index.ts

@@ -130,6 +130,11 @@ export {
   type FiatVirtualAccountResponse,
   type GuestAuthenticateRequestBody,
   type LinkJwtInput,
+  type MfaEmailEnrollRequestBody,
+  type MfaEmailInitEnrollInput,
+  type MfaEmailInitRequestBody,
+  type MfaEmailInitVerifyInput,
+  type MfaEmailVerifyRequestBody,
   type MfaPasskeyEnrollmentRequestBody,
   type MfaPasskeyInitRequestBody,
   type MfaPasskeyInitResponseBody,
@@ -599,6 +604,7 @@ export {
   type CrossAppEmbeddedWallet,
   type CrossAppSmartWallet,
   type CustomMetadata,
+  type EmailMfaMethod,
   type EmbeddedWalletRecoveryMethod,
   type LinkedAccount,
   type LinkedAccountAppleInput,

package/src/resources/onramps.ts

@@ -51,8 +51,8 @@ export interface BridgeSandboxFiatCustomerResponse {
 }
 
 /**
- * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
- * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
+ * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:4217" for
+ * Tempo or "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
  */
 export type Caip2ChainID = string;
 
@@ -173,8 +173,8 @@ export interface FiatOnrampDestination {
   asset: SharedAPI.TokenIdentifier;
 
   /**
-   * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
-   * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
+   * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:4217" for
+   * Tempo or "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
    */
   chain: Caip2ChainID;
 }

package/src/resources/swaps.ts

@@ -195,7 +195,8 @@ export interface SwapSource {
   asset_address: string;
 
   /**
-   * CAIP-2 chain identifier (e.g., "eip155:1").
+   * CAIP-2 chain identifier (e.g., "eip155:4217" for Tempo, "eip155:1" for
+   * Ethereum).
    */
   caip2: string;
 }

package/src/resources/users.ts

@@ -62,6 +62,15 @@ export interface CrossAppSmartWallet {
  */
 export type CustomMetadata = { [key: string]: string | number | boolean };
 
+/**
+ * An Email MFA method.
+ */
+export interface EmailMfaMethod {
+  type: 'email';
+
+  verified_at: number;
+}
+
 /**
  * The method used to recover an embedded wallet account.
  */
@@ -1175,7 +1184,7 @@ export interface LinkedAccountWalletInput {
 /**
  * A multi-factor authentication method linked to the user.
  */
-export type LinkedMfaMethod = SMSMfaMethod | TotpMfaMethod | PasskeyMfaMethod;
+export type LinkedMfaMethod = SMSMfaMethod | TotpMfaMethod | PasskeyMfaMethod | EmailMfaMethod;
 
 /**
  * OAuth tokens associated with the user.
@@ -1316,6 +1325,7 @@ export declare namespace Users {
     type CrossAppEmbeddedWallet as CrossAppEmbeddedWallet,
     type CrossAppSmartWallet as CrossAppSmartWallet,
     type CustomMetadata as CustomMetadata,
+    type EmailMfaMethod as EmailMfaMethod,
     type EmbeddedWalletRecoveryMethod as EmbeddedWalletRecoveryMethod,
     type LinkedAccount as LinkedAccount,
     type LinkedAccountAppleInput as LinkedAccountAppleInput,

package/src/resources/wallets/actions.ts

@@ -46,7 +46,7 @@ export interface AaveVaultDetails {
   available_liquidity_usd: number | null;
 
   /**
-   * CAIP-2 chain identifier (e.g. "eip155:8453").
+   * CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:8453" for Base).
    */
   caip2: string;
 
@@ -442,7 +442,7 @@ export interface EarnIncentiveClaimActionResponse {
   id: string;
 
   /**
-   * EVM chain name (e.g. "base", "ethereum").
+   * EVM chain name (e.g. "tempo", "base").
    */
   chain: string;
 
@@ -485,8 +485,8 @@ export interface EarnIncentiveClaimActionResponse {
 export interface EarnIncentiveClaimRequestBody {
   /**
    * The blockchain network on which to perform the incentive claim. Supported chains
-   * include: 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and more, along
-   * with their respective testnets.
+   * include: 'tempo', 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and more,
+   * along with their respective testnets.
    */
   chain: string;
 }
@@ -526,7 +526,7 @@ export interface EarnIncentiveRewardEntry {
  */
 export interface EarnIncentiveRewardsQuery {
   /**
-   * Chain name to fetch rewards for (e.g. "base", "ethereum").
+   * Chain name to fetch rewards for (e.g. "tempo", "base").
    */
   chain: string;
 }
@@ -834,7 +834,7 @@ export interface MorphoVaultDetails {
   available_liquidity_usd: number | null;
 
   /**
-   * CAIP-2 chain identifier (e.g. "eip155:8453").
+   * CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:8453" for Base).
    */
   caip2: string;
 
@@ -1081,7 +1081,7 @@ export interface TransferActionResponse {
   destination_amount: string | null;
 
   /**
-   * Chain name (e.g. "base", "ethereum").
+   * Chain name (e.g. "tempo", "base").
    */
   source_chain: string;
 
@@ -1207,7 +1207,7 @@ export interface VedaVaultDetails {
   available_liquidity_usd: number | null;
 
   /**
-   * CAIP-2 chain identifier (e.g. "eip155:8453").
+   * CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:8453" for Base).
    */
   caip2: string;
 

package/src/resources/wallets/balance.ts

@@ -45,6 +45,7 @@ export namespace BalanceGetResponse {
       | 'usdt'
       | 'eurc'
       | 'usdb'
+      | 'pathusd'
       | 'sol'
       | 'trx'
       | (string & {});
@@ -65,7 +66,7 @@ export namespace BalanceGetResponse {
 export interface BalanceGetParams {
   /**
    * The token contract address(es) to query in format "chain:address" (e.g.,
-   * "base:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" or
+   * "tempo:0x20c000000000000000000000b9537d11c60e8b50" or
    * "solana:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"). Cannot be used together
    * with `asset`/`chain` or with `include_currency`.
    */
@@ -85,12 +86,13 @@ export interface BalanceGetParams {
     | 'usdt'
     | 'eurc'
     | 'usdb'
+    | 'pathusd'
     | 'sol'
     | 'trx'
     | Array<WalletsAPI.WalletAsset>;
 
   /**
-   * Chain(s) to query named assets on (e.g. `base`, `ethereum`). Use together with
+   * Chain(s) to query named assets on (e.g. `tempo`, `base`). Use together with
    * `asset`. Cannot be used with `token`.
    */
   chain?: WalletsAPI.WalletAssetChainNameInput | Array<WalletsAPI.WalletAssetChainNameInput>;

package/src/resources/wallets/transactions.ts

@@ -98,6 +98,7 @@ export interface TransactionGetParams {
     | 'usdt'
     | 'eurc'
     | 'usdb'
+    | 'pathusd'
     | 'sol'
     | 'trx'
     | Array<WalletsAPI.WalletAsset>;