@privy-io/api-types 0.16.0 → 0.17.0

package/src/resources/policies.ts

@@ -302,7 +302,10 @@ export interface EthereumCalldataCondition {
  * eth_sendTransaction request.
  */
 export interface EthereumTransactionCondition {
-  field: 'to' | 'value' | 'chain_id';
+  /**
+   * Ethereum transaction-level fields that can be referenced in a policy condition.
+   */
+  field: EthereumTransactionConditionField;
 
   field_source: 'ethereum_transaction';
 
@@ -318,11 +321,19 @@ export interface EthereumTransactionCondition {
   value: ConditionValue;
 }
 
+/**
+ * Ethereum transaction-level fields that can be referenced in a policy condition.
+ */
+export type EthereumTransactionConditionField = 'to' | 'value' | 'chain_id';
+
 /**
  * Attributes from the signing domain that will verify the signature.
  */
 export interface EthereumTypedDataDomainCondition {
-  field: 'chainId' | 'verifyingContract' | 'chain_id' | 'verifying_contract';
+  /**
+   * Supported fields for Ethereum typed data domain conditions.
+   */
+  field: EthereumTypedDataDomainConditionField;
 
   field_source: 'ethereum_typed_data_domain';
 
@@ -338,6 +349,15 @@ export interface EthereumTypedDataDomainCondition {
   value: ConditionValue;
 }
 
+/**
+ * Supported fields for Ethereum typed data domain conditions.
+ */
+export type EthereumTypedDataDomainConditionField =
+  | 'chainId'
+  | 'verifyingContract'
+  | 'chain_id'
+  | 'verifying_contract';
+
 /**
  * 'types' and 'primary_type' attributes of the TypedData JSON object defined in
  * EIP-712.
@@ -498,6 +518,8 @@ export type PolicyMethod =
   | 'exportSeedPhrase'
   | 'signTransactionBytes'
   | 'signRawMessageBytes'
+  | 'tron_sendTransaction'
+  | 'tron_signTransaction'
   | 'earn_deposit'
   | 'earn_withdraw'
   | 'transfer'
@@ -585,7 +607,11 @@ export interface SolanaProgramInstructionCondition {
  * fields.
  */
 export interface SolanaSystemProgramInstructionCondition {
-  field: 'instructionName' | 'Transfer.from' | 'Transfer.to' | 'Transfer.lamports';
+  /**
+   * Supported fields for Solana System Program conditions including Transfer
+   * instruction fields.
+   */
+  field: SolanaSystemProgramInstructionConditionField;
 
   field_source: 'solana_system_program_instruction';
 
@@ -601,36 +627,27 @@ export interface SolanaSystemProgramInstructionCondition {
   value: ConditionValue;
 }
 
+/**
+ * Supported fields for Solana System Program conditions including Transfer
+ * instruction fields.
+ */
+export type SolanaSystemProgramInstructionConditionField =
+  | 'instructionName'
+  | 'Transfer.from'
+  | 'Transfer.to'
+  | 'Transfer.lamports';
+
 /**
  * Solana Token Program attributes, including more granular TransferChecked
  * instruction fields.
  */
 export interface SolanaTokenProgramInstructionCondition {
-  field:
-    | 'instructionName'
-    | 'Transfer.source'
-    | 'Transfer.destination'
-    | 'Transfer.authority'
-    | 'Transfer.amount'
-    | 'TransferChecked.source'
-    | 'TransferChecked.destination'
-    | 'TransferChecked.authority'
-    | 'TransferChecked.amount'
-    | 'TransferChecked.mint'
-    | 'Burn.account'
-    | 'Burn.mint'
-    | 'Burn.authority'
-    | 'Burn.amount'
-    | 'MintTo.mint'
-    | 'MintTo.account'
-    | 'MintTo.authority'
-    | 'MintTo.amount'
-    | 'CloseAccount.account'
-    | 'CloseAccount.destination'
-    | 'CloseAccount.authority'
-    | 'InitializeAccount3.account'
-    | 'InitializeAccount3.mint'
-    | 'InitializeAccount3.owner';
+  /**
+   * Supported fields for Solana Token Program conditions including Transfer,
+   * TransferChecked, Burn, MintTo, CloseAccount, and InitializeAccount3 instruction
+   * fields.
+   */
+  field: SolanaTokenProgramInstructionConditionField;
 
   field_source: 'solana_token_program_instruction';
 
@@ -646,6 +663,37 @@ export interface SolanaTokenProgramInstructionCondition {
   value: ConditionValue;
 }
 
+/**
+ * Supported fields for Solana Token Program conditions including Transfer,
+ * TransferChecked, Burn, MintTo, CloseAccount, and InitializeAccount3 instruction
+ * fields.
+ */
+export type SolanaTokenProgramInstructionConditionField =
+  | 'instructionName'
+  | 'Transfer.source'
+  | 'Transfer.destination'
+  | 'Transfer.authority'
+  | 'Transfer.amount'
+  | 'TransferChecked.source'
+  | 'TransferChecked.destination'
+  | 'TransferChecked.authority'
+  | 'TransferChecked.amount'
+  | 'TransferChecked.mint'
+  | 'Burn.account'
+  | 'Burn.mint'
+  | 'Burn.authority'
+  | 'Burn.amount'
+  | 'MintTo.mint'
+  | 'MintTo.account'
+  | 'MintTo.authority'
+  | 'MintTo.amount'
+  | 'CloseAccount.account'
+  | 'CloseAccount.destination'
+  | 'CloseAccount.authority'
+  | 'InitializeAccount3.account'
+  | 'InitializeAccount3.mint'
+  | 'InitializeAccount3.owner';
+
 /**
  * SUI transaction command attributes, enables allowlisting specific command types.
  * Allowed commands: 'TransferObjects', 'SplitCoins', 'MergeCoins'. Only 'eq' and
@@ -792,15 +840,10 @@ export interface TronCalldataCondition {
  */
 export interface TronTransactionCondition {
   /**
-   * Supported TRON transaction fields in format "TransactionType.field_name"
+   * Supported TRON transaction fields for TransferContract and TriggerSmartContract
+   * in format "TransactionType.field_name".
    */
-  field:
-    | 'TransferContract.to_address'
-    | 'TransferContract.amount'
-    | 'TriggerSmartContract.contract_address'
-    | 'TriggerSmartContract.call_value'
-    | 'TriggerSmartContract.token_id'
-    | 'TriggerSmartContract.call_token_value';
+  field: TronTransactionConditionField;
 
   field_source: 'tron_transaction';
 
@@ -816,6 +859,18 @@ export interface TronTransactionCondition {
   value: ConditionValue;
 }
 
+/**
+ * Supported TRON transaction fields for TransferContract and TriggerSmartContract
+ * in format "TransactionType.field_name".
+ */
+export type TronTransactionConditionField =
+  | 'TransferContract.to_address'
+  | 'TransferContract.amount'
+  | 'TriggerSmartContract.contract_address'
+  | 'TriggerSmartContract.call_value'
+  | 'TriggerSmartContract.token_id'
+  | 'TriggerSmartContract.call_token_value';
+
 /**
  * The typed data structure containing EIP-712 types and the primary type for typed
  * data message policy conditions.
@@ -873,7 +928,9 @@ export declare namespace Policies {
     type Ethereum7702AuthorizationCondition as Ethereum7702AuthorizationCondition,
     type EthereumCalldataCondition as EthereumCalldataCondition,
     type EthereumTransactionCondition as EthereumTransactionCondition,
+    type EthereumTransactionConditionField as EthereumTransactionConditionField,
     type EthereumTypedDataDomainCondition as EthereumTypedDataDomainCondition,
+    type EthereumTypedDataDomainConditionField as EthereumTypedDataDomainConditionField,
     type EthereumTypedDataMessageCondition as EthereumTypedDataMessageCondition,
     type MessageSigningCondition as MessageSigningCondition,
     type MessageSigningField as MessageSigningField,
@@ -888,7 +945,9 @@ export declare namespace Policies {
     type PolicyRuleResponse as PolicyRuleResponse,
     type SolanaProgramInstructionCondition as SolanaProgramInstructionCondition,
     type SolanaSystemProgramInstructionCondition as SolanaSystemProgramInstructionCondition,
+    type SolanaSystemProgramInstructionConditionField as SolanaSystemProgramInstructionConditionField,
     type SolanaTokenProgramInstructionCondition as SolanaTokenProgramInstructionCondition,
+    type SolanaTokenProgramInstructionConditionField as SolanaTokenProgramInstructionConditionField,
     type SuiTransactionCommandCondition as SuiTransactionCommandCondition,
     type SuiTransactionCommandOperator as SuiTransactionCommandOperator,
     type SuiTransferObjectsCommandCondition as SuiTransferObjectsCommandCondition,
@@ -898,6 +957,7 @@ export declare namespace Policies {
     type TempoTransactionConditionField as TempoTransactionConditionField,
     type TronCalldataCondition as TronCalldataCondition,
     type TronTransactionCondition as TronTransactionCondition,
+    type TronTransactionConditionField as TronTransactionConditionField,
     type TypedDataInput as TypedDataInput,
     type UpdateConditionSetRequestBody as UpdateConditionSetRequestBody,
   };

package/src/resources/transactions.ts

@@ -4,6 +4,19 @@ import { APIResource } from '../core/resource';
 
 export class Transactions extends APIResource {}
 
+/**
+ * Status of a blockchain transaction submitted by Privy.
+ */
+export type BlockchainTransactionStatus =
+  | 'broadcasted'
+  | 'confirmed'
+  | 'execution_reverted'
+  | 'failed'
+  | 'replaced'
+  | 'finalized'
+  | 'provider_error'
+  | 'pending';
+
 /**
  * A transaction from a Privy wallet.
  */
@@ -14,15 +27,10 @@ export interface Transaction {
 
   created_at: number;
 
-  status:
-    | 'broadcasted'
-    | 'confirmed'
-    | 'execution_reverted'
-    | 'failed'
-    | 'replaced'
-    | 'finalized'
-    | 'provider_error'
-    | 'pending';
+  /**
+   * Status of a blockchain transaction submitted by Privy.
+   */
+  status: BlockchainTransactionStatus;
 
   transaction_hash: string | null;
 
@@ -236,6 +244,7 @@ export interface TransactionScanningValidationSuccessResult {
 
 export declare namespace Transactions {
   export {
+    type BlockchainTransactionStatus as BlockchainTransactionStatus,
     type Transaction as Transaction,
     type TransactionList as TransactionList,
     type TransactionScanningAssetDiff as TransactionScanningAssetDiff,

package/src/resources/users.ts

@@ -19,9 +19,9 @@ export interface AuthenticatedUser {
   refresh_token: string | null;
 
   /**
-   * Instructs the client on how to handle tokens received
+   * Instructs the client on how to handle tokens received from a session response.
    */
-  session_update_action: 'set' | 'ignore' | 'clear';
+  session_update_action: ClientSessionUpdateAction;
 
   /**
    * A Privy user object.
@@ -38,6 +38,11 @@ export interface AuthenticatedUser {
   oauth_tokens?: OAuthTokens;
 }
 
+/**
+ * Instructs the client on how to handle tokens received from a session response.
+ */
+export type ClientSessionUpdateAction = 'set' | 'ignore' | 'clear';
+
 /**
  * An embedded wallet associated with a cross-app account.
  */
@@ -150,11 +155,22 @@ export interface LinkedAccountAuthorizationKey {
 export interface LinkedAccountBaseWallet {
   address: string;
 
-  chain_type: 'solana' | 'ethereum';
+  /**
+   * The wallet chain types that offer first class support.
+   */
+  chain_type: WalletsAPI.FirstClassChainType;
 
-  type: 'wallet' | 'smart_wallet';
+  /**
+   * The type of wallet linked account (external wallet or smart wallet).
+   */
+  type: LinkedAccountBaseWalletType;
 }
 
+/**
+ * The type of wallet linked account (external wallet or smart wallet).
+ */
+export type LinkedAccountBaseWalletType = 'wallet' | 'smart_wallet';
+
 /**
  * A Bitcoin SegWit embedded wallet account linked to the user.
  */
@@ -811,11 +827,21 @@ export interface LinkedAccountPasskey {
   public_key?: string;
 }
 
+/**
+ * WebAuthn credential device type indicating platform or cross-platform
+ * authenticator residency.
+ */
+export type LinkedAccountPasskeyCredentialDeviceType = 'singleDevice' | 'multiDevice';
+
 /**
  * The payload for importing a passkey account.
  */
 export interface LinkedAccountPasskeyInput {
-  credential_device_type: 'singleDevice' | 'multiDevice';
+  /**
+   * WebAuthn credential device type indicating platform or cross-platform
+   * authenticator residency.
+   */
+  credential_device_type: LinkedAccountPasskeyCredentialDeviceType;
 
   credential_id: string;
 
@@ -1138,7 +1164,10 @@ export type LinkedAccountType =
 export interface LinkedAccountWalletInput {
   address: string;
 
-  chain_type: 'ethereum' | 'solana';
+  /**
+   * The wallet chain types that offer first class support.
+   */
+  chain_type: WalletsAPI.FirstClassChainType;
 
   type: 'wallet';
 }
@@ -1283,6 +1312,7 @@ export interface UserWithIdentityToken {
 export declare namespace Users {
   export {
     type AuthenticatedUser as AuthenticatedUser,
+    type ClientSessionUpdateAction as ClientSessionUpdateAction,
     type CrossAppEmbeddedWallet as CrossAppEmbeddedWallet,
     type CrossAppSmartWallet as CrossAppSmartWallet,
     type CustomMetadata as CustomMetadata,
@@ -1292,6 +1322,7 @@ export declare namespace Users {
     type LinkedAccountAppleOAuth as LinkedAccountAppleOAuth,
     type LinkedAccountAuthorizationKey as LinkedAccountAuthorizationKey,
     type LinkedAccountBaseWallet as LinkedAccountBaseWallet,
+    type LinkedAccountBaseWalletType as LinkedAccountBaseWalletType,
     type LinkedAccountBitcoinSegwitEmbeddedWallet as LinkedAccountBitcoinSegwitEmbeddedWallet,
     type LinkedAccountBitcoinTaprootEmbeddedWallet as LinkedAccountBitcoinTaprootEmbeddedWallet,
     type LinkedAccountCrossApp as LinkedAccountCrossApp,
@@ -1321,6 +1352,7 @@ export declare namespace Users {
     type LinkedAccountLinkedInInput as LinkedAccountLinkedInInput,
     type LinkedAccountLinkedInOAuth as LinkedAccountLinkedInOAuth,
     type LinkedAccountPasskey as LinkedAccountPasskey,
+    type LinkedAccountPasskeyCredentialDeviceType as LinkedAccountPasskeyCredentialDeviceType,
     type LinkedAccountPasskeyInput as LinkedAccountPasskeyInput,
     type LinkedAccountPhone as LinkedAccountPhone,
     type LinkedAccountPhoneInput as LinkedAccountPhoneInput,