@privy-io/api-types 0.23.0 → 0.24.0

package/src/resources/users.ts

@@ -211,6 +211,11 @@ export interface LinkedAccountBitcoinSegwitEmbeddedWallet {
 
   type: 'wallet';
 
+  /**
+   * Whether the user can unilaterally sign with this wallet.
+   */
+  user_can_sign: boolean;
+
   verified_at: number;
 
   wallet_client: 'privy';
@@ -218,11 +223,6 @@ export interface LinkedAccountBitcoinSegwitEmbeddedWallet {
   wallet_client_type: 'privy';
 
   wallet_index: number;
-
-  /**
-   * Whether the user can unilaterally sign with this wallet.
-   */
-  user_can_sign?: boolean;
 }
 
 /**
@@ -256,6 +256,11 @@ export interface LinkedAccountBitcoinTaprootEmbeddedWallet {
 
   type: 'wallet';
 
+  /**
+   * Whether the user can unilaterally sign with this wallet.
+   */
+  user_can_sign: boolean;
+
   verified_at: number;
 
   wallet_client: 'privy';
@@ -263,11 +268,6 @@ export interface LinkedAccountBitcoinTaprootEmbeddedWallet {
   wallet_client_type: 'privy';
 
   wallet_index: number;
-
-  /**
-   * Whether the user can unilaterally sign with this wallet.
-   */
-  user_can_sign?: boolean;
 }
 
 /**
@@ -325,6 +325,11 @@ export interface LinkedAccountCurveSigningEmbeddedWallet {
 
   type: 'wallet';
 
+  /**
+   * Whether the user can unilaterally sign with this wallet.
+   */
+  user_can_sign: boolean;
+
   verified_at: number;
 
   wallet_client: 'privy';
@@ -332,11 +337,6 @@ export interface LinkedAccountCurveSigningEmbeddedWallet {
   wallet_client_type: 'privy';
 
   wallet_index: number;
-
-  /**
-   * Whether the user can unilaterally sign with this wallet.
-   */
-  user_can_sign?: boolean;
 }
 
 /**
@@ -572,6 +572,11 @@ export interface LinkedAccountEthereumEmbeddedWallet {
 
   type: 'wallet';
 
+  /**
+   * Whether the user can unilaterally sign with this wallet.
+   */
+  user_can_sign: boolean;
+
   verified_at: number;
 
   wallet_client: 'privy';
@@ -579,11 +584,6 @@ export interface LinkedAccountEthereumEmbeddedWallet {
   wallet_client_type: 'privy';
 
   wallet_index: number;
-
-  /**
-   * Whether the user can unilaterally sign with this wallet.
-   */
-  user_can_sign?: boolean;
 }
 
 /**
@@ -983,6 +983,11 @@ export interface LinkedAccountSolanaEmbeddedWallet {
 
   type: 'wallet';
 
+  /**
+   * Whether the user can unilaterally sign with this wallet.
+   */
+  user_can_sign: boolean;
+
   verified_at: number;
 
   wallet_client: 'privy';
@@ -990,11 +995,6 @@ export interface LinkedAccountSolanaEmbeddedWallet {
   wallet_client_type: 'privy';
 
   wallet_index: number;
-
-  /**
-   * Whether the user can unilaterally sign with this wallet.
-   */
-  user_can_sign?: boolean;
 }
 
 /**
@@ -1294,6 +1294,12 @@ export interface User {
    * Custom metadata associated with the user.
    */
   custom_metadata?: CustomMetadata;
+
+  /**
+   * Unix timestamp in seconds of when the user was frozen, or `null` if not frozen.
+   * Not included in every user response.
+   */
+  frozen_at?: number | null;
 }
 
 /**

package/src/resources/wallet-automations.ts

@@ -415,6 +415,11 @@ export interface WalletAutomationReindexRequestBody {
    */
   asset_address: string;
 
+  /**
+   * Automation to target when more than one active automation matches the asset.
+   */
+  automation_id?: string;
+
   /**
    * An EVM, Solana, or Tron CAIP-2 chain identifier supported by wallet automation
    * reindex.

package/src/resources/wallets/actions.ts

@@ -27,8 +27,7 @@ export interface AaveVaultDetails {
   admin_wallet_id: string;
 
   /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points.
+   * Annual percentage yield earned by the app from vault fees, in basis points.
    */
   app_apy: number | null;
 
@@ -898,6 +897,9 @@ export interface FailureReason {
  * Query parameters for listing wallet actions.
  */
 export interface ListWalletActionsQuery {
+  /**
+   * Cursor returned by the previous page.
+   */
   cursor?: string;
 
   limit?: number | null;
@@ -937,8 +939,7 @@ export interface MorphoVaultDetails {
   admin_wallet_id: string;
 
   /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points.
+   * Annual percentage yield earned by the app from vault fees, in basis points.
    */
   app_apy: number | null;
 
@@ -1006,6 +1007,12 @@ export interface PayoutResponse {
    */
   destination: FiatAPI.PayoutDestination;
 
+  /**
+   * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+   * "1.5" for 1.5%.
+   */
+  developer_fee_percent: FiatAPI.DeveloperFeePercent;
+
   /**
    * The Privy API environment.
    */
@@ -1261,8 +1268,7 @@ export interface TempoVaultDetails {
   admin_wallet_id: string | null;
 
   /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points.
+   * Annual percentage yield earned by the app from vault fees, in basis points.
    */
   app_apy: number | null;
 
@@ -1305,6 +1311,34 @@ export interface TempoVaultDetails {
   vault_address: string;
 }
 
+/**
+ * A wallet action step representing a Tempo Zone settlement on its parent chain.
+ */
+export interface TempoZoneSettlementWalletActionStep {
+  /**
+   * CAIP-2 identifier of the Tempo parent chain, or null when unavailable.
+   */
+  caip2: string | null;
+
+  /**
+   * Status of an external transaction step in a wallet action.
+   */
+  status: ExternalTransactionWalletActionStepStatus;
+
+  /**
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
+   * bytes).
+   */
+  transaction_hash: WalletsAPI.Hex | null;
+
+  type: 'tempo_zone_settlement';
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason?: FailureReason;
+}
+
 /**
  * Response for a transfer action.
  */
@@ -1447,8 +1481,7 @@ export interface VedaVaultDetails {
   admin_wallet_id: string;
 
   /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points.
+   * Annual percentage yield earned by the app from vault fees, in basis points.
    */
   app_apy: number | null;
 
@@ -1522,7 +1555,8 @@ export type WalletActionStep =
   | SvmTransactionWalletActionStep
   | TvmTransactionWalletActionStep
   | ExternalTransactionWalletActionStep
-  | CustodianTransactionWalletActionStep;
+  | CustodianTransactionWalletActionStep
+  | TempoZoneSettlementWalletActionStep;
 
 /**
  * Type of a wallet action step.
@@ -1533,7 +1567,8 @@ export type WalletActionStepType =
   | 'svm_transaction'
   | 'tvm_transaction'
   | 'external_transaction'
-  | 'custodian_transaction';
+  | 'custodian_transaction'
+  | 'tempo_zone_settlement';
 
 /**
  * Type of wallet action
@@ -1588,6 +1623,7 @@ export declare namespace Actions {
     type TvmTransactionWalletActionStep as TvmTransactionWalletActionStep,
     type TvmWalletActionStepStatus as TvmWalletActionStepStatus,
     type TempoVaultDetails as TempoVaultDetails,
+    type TempoZoneSettlementWalletActionStep as TempoZoneSettlementWalletActionStep,
     type TransferActionResponse as TransferActionResponse,
     type VedaVaultDetails as VedaVaultDetails,
     type WalletActionInclude as WalletActionInclude,

package/src/resources/wallets/balance.ts

@@ -42,6 +42,7 @@ export namespace BalanceGetResponse {
       | 'avax'
       | 'pol'
       | 'bnb'
+      | 'mon'
       | 'usdt'
       | 'eurc'
       | 'usdb'
@@ -84,6 +85,7 @@ export interface BalanceGetParams {
     | 'avax'
     | 'pol'
     | 'bnb'
+    | 'mon'
     | 'usdt'
     | 'eurc'
     | 'usdb'
@@ -119,6 +121,7 @@ export interface BalanceGetParams {
     | 'hyperevm'
     | 'hypercore'
     | 'arc'
+    | 'monad'
     | 'tempo_testnet'
     | 'hoodi'
     | 'sepolia'

package/src/resources/wallets/index.ts

@@ -41,6 +41,7 @@ export {
   type TvmTransactionWalletActionStep,
   type TvmWalletActionStepStatus,
   type TempoVaultDetails,
+  type TempoZoneSettlementWalletActionStep,
   type TransferActionResponse,
   type VedaVaultDetails,
   type WalletActionInclude,
@@ -82,6 +83,8 @@ export {
   type CryptoDepositAccountCaip2,
   type CryptoDepositAccountChain,
   type CryptoDepositAccountConfigResponse,
+  type CryptoDepositAccountConfigSearchResponse,
+  type CryptoDepositAccountSearchCurrency,
   type CryptoDepositAccountSourceChain,
   type CryptoDepositAccountSourceCurrency,
   type CryptoDepositAddressRoute,
@@ -103,6 +106,7 @@ export {
   type DepositAccountCryptoQuoteAsset,
   type DepositAccountCryptoQuoteRequestBody,
   type DepositAccountCryptoQuoteResponse,
+  type DerivationInput,
   type DetachWalletAutomationRequestBody,
   type DeveloperFee,
   type EncryptedAuthorizationKey,

package/src/resources/wallets/transactions.ts

@@ -104,6 +104,7 @@ export interface TransactionGetParams {
     | 'avax'
     | 'pol'
     | 'bnb'
+    | 'mon'
     | 'usdt'
     | 'eurc'
     | 'usdb'
@@ -113,6 +114,9 @@ export interface TransactionGetParams {
     | 'trx'
     | Array<WalletsAPI.WalletAsset>;
 
+  /**
+   * Cursor returned by the previous page.
+   */
   cursor?: string;
 
   /**

package/src/resources/wallets/wallets.ts

@@ -45,6 +45,7 @@ import {
   SvmWalletActionStepStatus,
   SwapActionResponse,
   TempoVaultDetails,
+  TempoZoneSettlementWalletActionStep,
   TransferActionResponse,
   TvmTransactionWalletActionStep,
   TvmWalletActionStepStatus,
@@ -726,6 +727,37 @@ export interface CryptoDepositAccountConfigResponse {
   currencies: Array<CryptoDepositAccountSourceCurrency>;
 }
 
+/**
+ * Source tokens matching a crypto deposit-account search.
+ */
+export interface CryptoDepositAccountConfigSearchResponse {
+  chains: { [key: string]: CryptoDepositAccountChain };
+
+  currencies: Array<CryptoDepositAccountSearchCurrency>;
+}
+
+/**
+ * A source token matched by crypto deposit-account search.
+ */
+export interface CryptoDepositAccountSearchCurrency {
+  chains: Array<CryptoDepositAccountSourceChain>;
+
+  name: string;
+
+  symbol: string;
+
+  /**
+   * Whether this token is verified as the canonical token for its symbol, since
+   * unverified tokens may be lookalikes.
+   */
+  verified: boolean;
+
+  /**
+   * URL of the token logo, omitted when none is known.
+   */
+  logo_uri?: string;
+}
+
 /**
  * A token contract on one source chain in the crypto deposit-account catalog.
  */
@@ -1048,6 +1080,17 @@ export interface DepositAccountCryptoQuoteResponse {
   input_amount: string;
 }
 
+/**
+ * Derives the new wallet from an existing HD root wallet so both share one seed
+ * phrase.
+ */
+export interface DerivationInput {
+  /**
+   * ID of the HD root wallet to derive the new wallet from.
+   */
+  wallet_id: string;
+}
+
 /**
  * Request body for detaching automations from a wallet (wallet ID comes from the
  * URL).
@@ -3669,6 +3712,7 @@ export type TransactionChainNameInput =
   | 'solana'
   | 'sepolia'
   | 'arc'
+  | 'monad'
   | (string & {});
 
 /**
@@ -3857,6 +3901,7 @@ export interface TransferReceivedTransactionDetail {
     | 'avax'
     | 'pol'
     | 'bnb'
+    | 'mon'
     | 'usdt'
     | 'eurc'
     | 'usdb'
@@ -4061,6 +4106,7 @@ export interface TransferSentTransactionDetail {
     | 'avax'
     | 'pol'
     | 'bnb'
+    | 'mon'
     | 'usdt'
     | 'eurc'
     | 'usdb'
@@ -4638,6 +4684,12 @@ export interface Wallet {
    */
   external_id?: string;
 
+  /**
+   * ID of the HD root wallet this wallet was derived from, or null if it was not
+   * derived from another wallet.
+   */
+  parent_wallet_id?: string | null;
+
   /**
    * The compressed, raw public key for the wallet along the chain cryptographic
    * curve.
@@ -4704,6 +4756,7 @@ export type WalletAsset =
   | 'avax'
   | 'pol'
   | 'bnb'
+  | 'mon'
   | 'usdt'
   | 'eurc'
   | 'usdb'
@@ -4737,6 +4790,7 @@ export type WalletAssetChainNameInput =
   | 'hyperevm'
   | 'hypercore'
   | 'arc'
+  | 'monad'
   | 'tempo_testnet'
   | 'hoodi'
   | 'sepolia'
@@ -4966,6 +5020,12 @@ export interface WalletBatchItemInput {
    */
   additional_signers?: AdditionalSignerInput;
 
+  /**
+   * Derives the new wallet from an existing HD root wallet so both share one seed
+   * phrase.
+   */
+  derivation?: DerivationInput;
+
   /**
    * A human-readable label for the wallet.
    */
@@ -5133,6 +5193,7 @@ export type WalletEthereumAsset =
   | 'avax'
   | 'pol'
   | 'bnb'
+  | 'mon'
   | 'usdt'
   | 'eurc'
   | 'usdb'
@@ -5418,6 +5479,12 @@ export interface WalletCreateParams {
    */
   additional_signers?: AdditionalSignerInput;
 
+  /**
+   * Body param: Derives the new wallet from an existing HD root wallet so both share
+   * one seed phrase.
+   */
+  derivation?: DerivationInput;
+
   /**
    * Body param: A human-readable label for the wallet.
    */
@@ -6884,6 +6951,8 @@ export declare namespace Wallets {
     type CryptoDepositAccountCaip2 as CryptoDepositAccountCaip2,
     type CryptoDepositAccountChain as CryptoDepositAccountChain,
     type CryptoDepositAccountConfigResponse as CryptoDepositAccountConfigResponse,
+    type CryptoDepositAccountConfigSearchResponse as CryptoDepositAccountConfigSearchResponse,
+    type CryptoDepositAccountSearchCurrency as CryptoDepositAccountSearchCurrency,
     type CryptoDepositAccountSourceChain as CryptoDepositAccountSourceChain,
     type CryptoDepositAccountSourceCurrency as CryptoDepositAccountSourceCurrency,
     type CryptoDepositAddressRoute as CryptoDepositAddressRoute,
@@ -6905,6 +6974,7 @@ export declare namespace Wallets {
     type DepositAccountCryptoQuoteAsset as DepositAccountCryptoQuoteAsset,
     type DepositAccountCryptoQuoteRequestBody as DepositAccountCryptoQuoteRequestBody,
     type DepositAccountCryptoQuoteResponse as DepositAccountCryptoQuoteResponse,
+    type DerivationInput as DerivationInput,
     type DetachWalletAutomationRequestBody as DetachWalletAutomationRequestBody,
     type DeveloperFee as DeveloperFee,
     type EncryptedAuthorizationKey as EncryptedAuthorizationKey,
@@ -7234,6 +7304,7 @@ export declare namespace Wallets {
     type TvmTransactionWalletActionStep as TvmTransactionWalletActionStep,
     type TvmWalletActionStepStatus as TvmWalletActionStepStatus,
     type TempoVaultDetails as TempoVaultDetails,
+    type TempoZoneSettlementWalletActionStep as TempoZoneSettlementWalletActionStep,
     type TransferActionResponse as TransferActionResponse,
     type VedaVaultDetails as VedaVaultDetails,
     type WalletActionInclude as WalletActionInclude,

package/src/resources/webhooks.ts

@@ -216,6 +216,18 @@ export interface DepositFailedData {
   source: DepositStartedSource;
 }
 
+/**
+ * Metadata identifying a refunded wallet deposit.
+ */
+export interface DepositMetadata {
+  /**
+   * Relay details for a refunded wallet deposit.
+   */
+  details: RefundDetails;
+
+  type: 'refund';
+}
+
 /**
  * Details of a fiat deposit that has begun processing into a deposit account.
  */
@@ -336,6 +348,11 @@ export interface FundsDepositedWebhookPayload {
    */
   bridge_metadata?: BridgeMetadata;
 
+  /**
+   * Metadata identifying a refunded wallet deposit.
+   */
+  deposit_metadata?: DepositMetadata;
+
   /**
    * The transaction fee paid, as a stringified bigint in the chain's native token.
    */
@@ -1009,6 +1026,58 @@ export interface PrivateKeyExportWebhookPayload {
   export_source?: WalletsAPI.ExportType;
 }
 
+/**
+ * Relay details for a refunded wallet deposit.
+ */
+export interface RefundDetails {
+  /**
+   * The transaction hash of the transfer that was refunded.
+   */
+  original_transaction_hash: string;
+
+  /**
+   * The provider that handled the refund.
+   */
+  provider: 'relay';
+
+  /**
+   * The Privy wallet action ID of the transfer that was refunded.
+   */
+  wallet_action_id: string;
+}
+
+/**
+ * Metadata identifying a refunded wallet deposit.
+ */
+export interface RefundMetadata {
+  /**
+   * Relay details for a refunded wallet deposit.
+   */
+  details: RefundDetails;
+
+  type: 'refund';
+}
+
+/**
+ * Relay details for a refunded wallet deposit.
+ */
+export interface RelayRefundDetails {
+  /**
+   * The transaction hash of the transfer that was refunded.
+   */
+  original_transaction_hash: string;
+
+  /**
+   * The provider that handled the refund.
+   */
+  provider: 'relay';
+
+  /**
+   * The Privy wallet action ID of the transfer that was refunded.
+   */
+  wallet_action_id: string;
+}
+
 /**
  * Payload for the wallet.seed_phrase_export webhook event.
  */
@@ -1441,6 +1510,11 @@ export interface UserKYCUpdatedData {
    * Terms of service status in a KYC update event.
    */
   tos: UserKYCUpdatedTosData;
+
+  /**
+   * Stripe Issuing cardholder ID assigned by Bridge for this user.
+   */
+  stripe_cardholder_id?: string;
 }
 
 /**
@@ -4355,6 +4429,7 @@ export declare namespace Webhooks {
     type DepositCompletedData as DepositCompletedData,
     type DepositCompletedDestination as DepositCompletedDestination,
     type DepositFailedData as DepositFailedData,
+    type DepositMetadata as DepositMetadata,
     type DepositStartedData as DepositStartedData,
     type DepositStartedDestination as DepositStartedDestination,
     type DepositStartedSource as DepositStartedSource,
@@ -4381,6 +4456,9 @@ export declare namespace Webhooks {
     type OrganizationKYBUpdatedKYBData as OrganizationKYBUpdatedKYBData,
     type OrganizationKYBUpdatedTosData as OrganizationKYBUpdatedTosData,
     type PrivateKeyExportWebhookPayload as PrivateKeyExportWebhookPayload,
+    type RefundDetails as RefundDetails,
+    type RefundMetadata as RefundMetadata,
+    type RelayRefundDetails as RelayRefundDetails,
     type SeedPhraseExportWebhookPayload as SeedPhraseExportWebhookPayload,
     type TransactionBroadcastedWebhookPayload as TransactionBroadcastedWebhookPayload,
     type TransactionConfirmedWebhookPayload as TransactionConfirmedWebhookPayload,

package/src/resources/yield.ts

@@ -25,8 +25,8 @@ export interface EthereumVaultDetailsResponse {
   id: string;
 
   /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points. Null when APY data is unavailable.
+   * Annual percentage yield earned by the app from vault fees, in basis points. Null
+   * when APY data is unavailable.
    */
   app_apy: number | null;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.23.0'; // x-release-please-version
+export const VERSION = '0.24.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.23.0";
+export declare const VERSION = "0.24.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.23.0";
+export declare const VERSION = "0.24.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.23.0'; // x-release-please-version
+exports.VERSION = '0.24.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.23.0'; // x-release-please-version
+export const VERSION = '0.24.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map