@privy-io/api-types 0.15.0 → 0.17.0

package/src/resources/accounts.ts

@@ -13,7 +13,7 @@ export interface AccountBalanceParams {
   /**
    * When set to true, returns balances from testnet chains instead of mainnets.
    */
-  testnet_mode?: 'true' | 'false';
+  testnet_mode?: ChainTestnetMode;
 }
 
 /**
@@ -236,6 +236,11 @@ export interface BalanceResponse {
   assets_by_chain?: Array<BalanceAssetByChain>;
 }
 
+/**
+ * When set to true, returns balances from testnet chains instead of mainnets.
+ */
+export type ChainTestnetMode = 'true' | 'false';
+
 /**
  * Input for creating a digital asset account from existing wallets with a
  * `wallet_ids` parameter.
@@ -326,6 +331,7 @@ export declare namespace Accounts {
     type BalanceAsset as BalanceAsset,
     type BalanceAssetByChain as BalanceAssetByChain,
     type BalanceResponse as BalanceResponse,
+    type ChainTestnetMode as ChainTestnetMode,
     type CreateAccountFromWalletIDsInput as CreateAccountFromWalletIDsInput,
     type CreateAccountFromWalletsConfigurationInput as CreateAccountFromWalletsConfigurationInput,
     type CreateAccountInput as CreateAccountInput,

package/src/resources/aggregations.ts

@@ -42,7 +42,7 @@ export interface Aggregation {
   owner_id: string | null;
 
   /**
-   * The time window configuration for an aggregation.
+   * A rolling time window defined by a duration in seconds.
    */
   window: AggregationWindow;
 
@@ -93,7 +93,7 @@ export interface AggregationInput {
   name: string;
 
   /**
-   * The time window configuration for an aggregation.
+   * A rolling time window defined by a duration in seconds.
    */
   window: AggregationWindow;
 
@@ -146,7 +146,7 @@ export interface AggregationMetric {
 }
 
 /**
- * The time window configuration for an aggregation.
+ * A rolling time window defined by a duration in seconds.
  */
 export interface AggregationWindow {
   /**
@@ -157,6 +157,18 @@ export interface AggregationWindow {
   type: 'rolling';
 }
 
+/**
+ * A rolling time window defined by a duration in seconds.
+ */
+export interface RollingAggregationWindow {
+  /**
+   * Duration of the rolling window in seconds (1-72 hours).
+   */
+  seconds: number;
+
+  type: 'rolling';
+}
+
 export declare namespace Aggregations {
   export {
     type Aggregation as Aggregation,
@@ -165,5 +177,6 @@ export declare namespace Aggregations {
     type AggregationMethod as AggregationMethod,
     type AggregationMetric as AggregationMetric,
     type AggregationWindow as AggregationWindow,
+    type RollingAggregationWindow as RollingAggregationWindow,
   };
 }

package/src/resources/apps.ts

@@ -28,6 +28,36 @@ export interface AllowlistEntry {
   value: string;
 }
 
+/**
+ * Configuration for the allowlist error page shown to users not on the allowlist.
+ */
+export interface AppAllowlistConfig {
+  cta_link: string | null;
+
+  cta_text: string | null;
+
+  error_detail: string | null;
+
+  error_title: string | null;
+}
+
+/**
+ * A custom OAuth provider configured for an app.
+ */
+export interface AppCustomOAuthProvider {
+  enabled: boolean;
+
+  /**
+   * The ID of a custom OAuth provider, set up for this app. Must start with
+   * "custom:".
+   */
+  provider: ClientAuthAPI.CustomOAuthProviderID;
+
+  provider_display_name: string;
+
+  provider_icon_url: string;
+}
+
 /**
  * The response for getting an app.
  */
@@ -42,7 +72,10 @@ export interface AppResponse {
 
   allowed_native_app_url_schemes: Array<string>;
 
-  allowlist_config: AppResponse.AllowlistConfig;
+  /**
+   * Configuration for the allowlist error page shown to users not on the allowlist.
+   */
+  allowlist_config: AppAllowlistConfig;
 
   allowlist_enabled: boolean;
 
@@ -54,7 +87,7 @@ export interface AppResponse {
 
   custom_jwt_auth: boolean;
 
-  custom_oauth_providers: Array<AppResponse.CustomOAuthProvider>;
+  custom_oauth_providers: Array<AppCustomOAuthProvider>;
 
   /**
    * Indicates that this response contains only publicly accessible data, not a
@@ -73,10 +106,15 @@ export interface AppResponse {
    */
   embedded_wallet_config: EmbeddedWalletConfigSchema;
 
-  enabled_captcha_provider: 'turnstile' | 'hcaptcha' | null;
+  /**
+   * The captcha provider enabled for an app.
+   */
+  enabled_captcha_provider: CaptchaProvider | null;
 
   enforce_wallet_uis: boolean;
 
+  external_wallets_for_signup_enabled: boolean;
+
   farcaster_auth: boolean;
 
   farcaster_link_wallets_enabled: boolean;
@@ -103,7 +141,9 @@ export interface AppResponse {
 
   max_linked_wallets_per_user: number | null;
 
-  mfa_methods: Array<'sms' | 'totp' | 'passkey'>;
+  merge_accounts_by_email: boolean;
+
+  mfa_methods: Array<MfaMethod>;
 
   name: string;
 
@@ -165,37 +205,16 @@ export interface AppResponse {
   telegram_auth_config?: TelegramAuthConfigSchema;
 }
 
-export namespace AppResponse {
-  export interface AllowlistConfig {
-    cta_link: string | null;
-
-    cta_text: string | null;
-
-    error_detail: string | null;
-
-    error_title: string | null;
-  }
-
-  export interface CustomOAuthProvider {
-    enabled: boolean;
-
-    /**
-     * The ID of a custom OAuth provider, set up for this app. Must start with
-     * "custom:".
-     */
-    provider: ClientAuthAPI.CustomOAuthProviderID;
-
-    provider_display_name: string;
-
-    provider_icon_url: string;
-  }
-}
-
 /**
  * A valid CAIP-2 chain ID (e.g. 'eip155:1').
  */
 export type Caip2 = string;
 
+/**
+ * The captcha provider enabled for an app.
+ */
+export type CaptchaProvider = 'turnstile' | 'hcaptcha';
+
 /**
  * A crypto currency identified by a CAIP-2 chain ID and optional asset.
  */
@@ -377,6 +396,11 @@ export interface GasSpendResponseBody {
   value: string;
 }
 
+/**
+ * A multi-factor authentication method supported by the app.
+ */
+export type MfaMethod = 'sms' | 'totp' | 'passkey';
+
 /**
  * Allowlist invite input for a phone number.
  */
@@ -414,6 +438,8 @@ export interface TestAccount {
   phone_number: string;
 
   updated_at: string;
+
+  name?: string | null;
 }
 
 /**
@@ -450,8 +476,11 @@ export declare namespace Apps {
   export {
     type AllowlistDeletionResponse as AllowlistDeletionResponse,
     type AllowlistEntry as AllowlistEntry,
+    type AppAllowlistConfig as AppAllowlistConfig,
+    type AppCustomOAuthProvider as AppCustomOAuthProvider,
     type AppResponse as AppResponse,
     type Caip2 as Caip2,
+    type CaptchaProvider as CaptchaProvider,
     type Currency as Currency,
     type CurrencyAsset as CurrencyAsset,
     type EmailDomain as EmailDomain,
@@ -468,6 +497,7 @@ export declare namespace Apps {
     type GasSpendCurrency as GasSpendCurrency,
     type GasSpendRequestBody as GasSpendRequestBody,
     type GasSpendResponseBody as GasSpendResponseBody,
+    type MfaMethod as MfaMethod,
     type PhoneInviteInput as PhoneInviteInput,
     type TelegramAuthConfigSchema as TelegramAuthConfigSchema,
     type TestAccount as TestAccount,

package/src/resources/client-auth.ts

@@ -63,7 +63,10 @@ export interface AuthenticateSiwsInput {
 
   connectorType?: string | null;
 
-  message_type?: 'transaction' | 'plain';
+  /**
+   * The type of SIWS message being signed.
+   */
+  message_type?: SiwsMessageType;
 
   /**
    * Whether to allow sign-up during authentication.
@@ -284,9 +287,14 @@ export interface BridgeUsdFiatVirtualAccountDepositInstructions {
 
   bank_routing_number: string;
 
-  payment_rails: Array<'ach_push' | 'wire'>;
+  payment_rails: Array<BridgeUsdFiatVirtualAccountDepositPaymentRail>;
 }
 
+/**
+ * Payment rails supported for USD virtual account deposits.
+ */
+export type BridgeUsdFiatVirtualAccountDepositPaymentRail = 'ach_push' | 'wire';
+
 /**
  * The request body for authenticating with a custom JWT.
  */
@@ -923,9 +931,9 @@ export interface OAuthTokenAuthorizationCodeRequestBody {
  */
 export interface OAuthTokenDeviceCodePendingError {
   /**
-   * The error code indicating why the token request failed.
+   * Error codes for the device authorization pending response per RFC 8628.
    */
-  error: 'authorization_pending' | 'slow_down' | 'access_denied' | 'expired_token';
+  error: OAuthTokenDeviceCodePendingErrorCode;
 
   /**
    * Human-readable description of the error.
@@ -938,6 +946,15 @@ export interface OAuthTokenDeviceCodePendingError {
   interval?: number;
 }
 
+/**
+ * Error codes for the device authorization pending response per RFC 8628.
+ */
+export type OAuthTokenDeviceCodePendingErrorCode =
+  | 'authorization_pending'
+  | 'slow_down'
+  | 'access_denied'
+  | 'expired_token';
+
 /**
  * Request body for the urn:ietf:params:oauth:grant-type:device_code grant type
  * (RFC 8628). Used by CLI clients to poll for authorization.
@@ -1670,7 +1687,10 @@ export interface SiwsAuthenticateRequestBody {
 
   connectorType?: string | null;
 
-  message_type?: 'transaction' | 'plain';
+  /**
+   * The type of SIWS message being signed.
+   */
+  message_type?: SiwsMessageType;
 
   /**
    * Whether to allow sign-up during authentication.
@@ -1717,7 +1737,10 @@ export interface SiwsInput {
 
   connectorType?: string | null;
 
-  message_type?: 'transaction' | 'plain';
+  /**
+   * The type of SIWS message being signed.
+   */
+  message_type?: SiwsMessageType;
 
   walletClientType?: string | null;
 }
@@ -1732,11 +1755,19 @@ export interface SiwsLinkRequestBody {
 
   connectorType?: string | null;
 
-  message_type?: 'transaction' | 'plain';
+  /**
+   * The type of SIWS message being signed.
+   */
+  message_type?: SiwsMessageType;
 
   walletClientType?: string | null;
 }
 
+/**
+ * The type of SIWS message being signed.
+ */
+export type SiwsMessageType = 'transaction' | 'plain' | 'offchain-message';
+
 /**
  * A SIWS nonce response.
  */
@@ -1988,6 +2019,7 @@ export declare namespace ClientAuth {
     type BridgeSandboxFiatVirtualAccountResponse as BridgeSandboxFiatVirtualAccountResponse,
     type BridgeSourceAsset as BridgeSourceAsset,
     type BridgeUsdFiatVirtualAccountDepositInstructions as BridgeUsdFiatVirtualAccountDepositInstructions,
+    type BridgeUsdFiatVirtualAccountDepositPaymentRail as BridgeUsdFiatVirtualAccountDepositPaymentRail,
     type CustomJwtAuthenticateRequestBody as CustomJwtAuthenticateRequestBody,
     type CustomJwtLinkRequestBody as CustomJwtLinkRequestBody,
     type CustomOAuthProviderID as CustomOAuthProviderID,
@@ -2048,6 +2080,7 @@ export declare namespace ClientAuth {
     type OAuthProviderID as OAuthProviderID,
     type OAuthTokenAuthorizationCodeRequestBody as OAuthTokenAuthorizationCodeRequestBody,
     type OAuthTokenDeviceCodePendingError as OAuthTokenDeviceCodePendingError,
+    type OAuthTokenDeviceCodePendingErrorCode as OAuthTokenDeviceCodePendingErrorCode,
     type OAuthTokenDeviceCodeRequestBody as OAuthTokenDeviceCodeRequestBody,
     type OAuthTokenGrantType as OAuthTokenGrantType,
     type OAuthTokenRefreshTokenRequestBody as OAuthTokenRefreshTokenRequestBody,
@@ -2113,6 +2146,7 @@ export declare namespace ClientAuth {
     type SiwsInitResponseBody as SiwsInitResponseBody,
     type SiwsInput as SiwsInput,
     type SiwsLinkRequestBody as SiwsLinkRequestBody,
+    type SiwsMessageType as SiwsMessageType,
     type SiwsNonce as SiwsNonce,
     type SiwsUnlinkRequestBody as SiwsUnlinkRequestBody,
     type SmartWalletSiweInput as SmartWalletSiweInput,

package/src/resources/embedded-wallets.ts

@@ -265,6 +265,13 @@ export interface WalletCreationInput {
    */
   create_smart_wallet?: boolean;
 
+  /**
+   * A customer-provided identifier for mapping to external systems. Write-once, set
+   * only at creation. Must be alphanumeric, hyphens, or underscores, max 64
+   * characters.
+   */
+  external_id?: string;
+
   /**
    * Policy IDs to enforce on the wallet. Currently, only one policy is supported per
    * wallet.