@privy-io/api-types 0.15.0 → 0.17.0

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,