@privy-io/api-types 0.15.0 → 0.16.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.
@@ -1670,7 +1673,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 +1723,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 +1741,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.
  */
@@ -2113,6 +2130,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/index.ts

@@ -16,6 +16,7 @@ export {
   type BalanceAsset,
   type BalanceAssetByChain,
   type BalanceResponse,
+  type ChainTestnetMode,
   type CreateAccountFromWalletIDsInput,
   type CreateAccountFromWalletsConfigurationInput,
   type CreateAccountInput,
@@ -31,14 +32,18 @@ export {
   type AggregationMethod,
   type AggregationMetric,
   type AggregationWindow,
+  type RollingAggregationWindow,
 } from './aggregations';
 export { Analytics, type AnalyticsEventInput } from './analytics';
 export {
   Apps,
   type AllowlistDeletionResponse,
   type AllowlistEntry,
+  type AppAllowlistConfig,
+  type AppCustomOAuthProvider,
   type AppResponse,
   type Caip2,
+  type CaptchaProvider,
   type Currency,
   type CurrencyAsset,
   type EmailDomain,
@@ -55,6 +60,7 @@ export {
   type GasSpendCurrency,
   type GasSpendRequestBody,
   type GasSpendResponseBody,
+  type MfaMethod,
   type PhoneInviteInput,
   type TelegramAuthConfigSchema,
   type TestAccount,
@@ -210,6 +216,7 @@ export {
   type SiwsInitResponseBody,
   type SiwsInput,
   type SiwsLinkRequestBody,
+  type SiwsMessageType,
   type SiwsNonce,
   type SiwsUnlinkRequestBody,
   type SmartWalletSiweInput,
@@ -297,8 +304,11 @@ export {
   type BaseActionResult,
   type BaseIntentResponse,
   type IntentAuthorization,
+  type IntentAuthorizationKeyMember,
+  type IntentAuthorizationKeyQuorum,
   type IntentAuthorizationKeyQuorumMember,
   type IntentAuthorizationMember,
+  type IntentAuthorizationUserMember,
   type IntentAuthorizeInput,
   type IntentCreationHeaders,
   type IntentResponse,
@@ -311,6 +321,7 @@ export {
   type RpcIntentResponse,
   type RuleDeleteIntentResponse,
   type RuleIntentCreateRequestDetails,
+  type RuleIntentDeleteRequestBody,
   type RuleIntentDeleteRequestDetails,
   type RuleIntentRequestDetails,
   type RuleIntentResponse,
@@ -322,6 +333,7 @@ export {
 } from './intents';
 export {
   KeyQuorums,
+  type AuthorizationKey,
   type KeyQuorum,
   type KeyQuorumAuthorizationHeaders,
   type KeyQuorumCreateRequestBody,
@@ -350,6 +362,7 @@ export {
   type KrakenEmbedEarnAprEstimate,
   type KrakenEmbedEarnAsset,
   type KrakenEmbedEarnUserAllocation,
+  type KrakenEmbedFullName,
   type KrakenEmbedGetAssetListQueryParamsSchema,
   type KrakenEmbedGetCustomOrderHistoryQueryParams,
   type KrakenEmbedGetCustomOrderHistoryResponse,
@@ -368,11 +381,16 @@ export {
   type KrakenEmbedGetPortfolioDetailsQueryParamsSchema,
   type KrakenEmbedGetPortfolioSummaryQueryParams,
   type KrakenEmbedGetPortfolioSummaryResponse,
+  type KrakenEmbedGetPortfolioSummaryResult,
   type KrakenEmbedGetPortfolioTransactionsQueryParamsSchema,
   type KrakenEmbedGetQuoteQueryParams,
   type KrakenEmbedListCustomOrdersQueryParams,
   type KrakenEmbedListCustomOrdersResponse,
   type KrakenEmbedListCustomOrdersResult,
+  type KrakenEmbedPortfolioSummaryPayload,
+  type KrakenEmbedPortfolioTransactionRefID,
+  type KrakenEmbedPortfolioTransactionRefIDType,
+  type KrakenEmbedResidence,
   type KrakenEmbedStartAddressMetadata,
   type KrakenEmbedStartAddressVerificationURLInput,
   type KrakenEmbedStartIdentityInfo,
@@ -406,7 +424,6 @@ export {
   type CreateOrUpdateFiatCustomerRequestInput,
   type CreateStripeOnrampSessionInput,
   type CreateStripeOnrampSessionResponse,
-  type CryptoCurrencyCode,
   type ExchangeStripeTokensInput,
   type ExchangeStripeTokensResponse,
   type FiatAmount,
@@ -433,7 +450,6 @@ export {
   type LinkAuthIntentNoAccount,
   type ListStripeConsumerWalletsResponse,
   type ListStripePaymentTokensResponse,
-  type OnrampSessionFees,
   type OnrampSessionParams,
   type OnrampSessionTransactionDetails,
   type RefreshStripeQuoteResponse,
@@ -441,10 +457,11 @@ export {
   type StripeCryptoCustomerActive,
   type StripeCryptoCustomerExpired,
   type StripeCryptoCustomerNone,
+  type StripeKYCRegion,
+  type StripeKYCTier,
   type StripeOnrampCheckoutResponse,
   type StripeOnrampSessionStatus,
   type StripePaymentToken,
-  type StripeQuote,
   type StripeTransactionDetails,
   type StripeVerification,
 } from './onramps';
@@ -479,6 +496,8 @@ export {
   type EthereumTransactionCondition,
   type EthereumTypedDataDomainCondition,
   type EthereumTypedDataMessageCondition,
+  type MessageSigningCondition,
+  type MessageSigningField,
   type Policy,
   type PolicyAction,
   type PolicyAuthorizationHeaders,
@@ -500,6 +519,7 @@ export {
   type TempoTransactionConditionField,
   type TronCalldataCondition,
   type TronTransactionCondition,
+  type TypedDataInput,
   type UpdateConditionSetRequestBody,
 } from './policies';
 export {
@@ -517,7 +537,9 @@ export {
   type P256PublicKey,
   type SolanaAddress,
   type SuccessResponse,
+  type TokenIdentifier,
   type TronAddress,
+  type TronHexAddress,
 } from './shared';
 export {
   Swaps,
@@ -620,6 +642,8 @@ export {
 } from './users';
 export {
   WalletActions,
+  type CustodianTransactionWalletActionStep,
+  type CustodianTransactionWalletActionStepStatus,
   type EvmTransactionWalletActionStep,
   type EvmUserOperationWalletActionStep,
   type EvmWalletActionStepStatus,
@@ -641,10 +665,15 @@ export {
   type ExternalTransactionWalletActionStep,
   type ExternalTransactionWalletActionStepStatus,
   type FailureReason,
+  type ListWalletActionsQuery,
+  type ListWalletActionsResponse,
   type SvmTransactionWalletActionStep,
   type SvmWalletActionStepStatus,
   type SwapActionResponse,
+  type TvmTransactionWalletActionStep,
+  type TvmWalletActionStepStatus,
   type TransferActionResponse,
+  type WalletActionInclude,
   type WalletActionResponse,
   type WalletActionStatus,
   type WalletActionStep,
@@ -653,9 +682,13 @@ export {
 } from './wallet-actions';
 export {
   Wallets,
+  type AccessListEntry,
   type AdditionalSignerInput,
   type AdditionalSignerItemInput,
   type Address,
+  type AdvancedSwapPlatformFee,
+  type AdvancedSwapRequestBody,
+  type AdvancedSwapResponse,
   type AmountType,
   type AuthorizationKeyDashboardResponse,
   type AuthorizationKeyResponse,
@@ -668,6 +701,9 @@ export {
   type CustodialWalletProvider,
   type CustomTokenTransferSource,
   type DeveloperFee,
+  type EncryptedAuthorizationKey,
+  type EncryptedBoundAuthenticateResponse,
+  type EncryptedWalletAuthenticateResponse,
   type EthereumPersonalSignRpcInput,
   type EthereumPersonalSignRpcInputParams,
   type EthereumPersonalSignRpcResponse,
@@ -723,6 +759,7 @@ export {
   type HpkeEncryption,
   type HpkeImportConfig,
   type Hex,
+  type IntentBinding,
   type NamedTokenTransferSource,
   type OutputWithPreviousTransactionData,
   type PolicyInput,
@@ -732,6 +769,7 @@ export {
   type PrivateKeySubmitInput,
   type PrivyFee,
   type Quantity,
+  type RawBoundAuthenticateResponse,
   type RawSignBytesEncoding,
   type RawSignBytesHashFunction,
   type RawSignBytesParams,
@@ -740,10 +778,13 @@ export {
   type RawSignInputParams,
   type RawSignResponse,
   type RawSignResponseData,
+  type RawWalletAuthenticateResponse,
   type RecipientPublicKey,
   type RelayerFee,
   type SeedPhraseExportInput,
   type SeedPhraseExportResponse,
+  type SignatureOptions,
+  type SignatureType,
   type SigningAlgorithm,
   type SolanaRpcInput,
   type SolanaRpcResponse,
@@ -805,6 +846,7 @@ export {
   type SparkUserTokenMetadata,
   type SparkWalletLeaf,
   type SuiCommandName,
+  type SwapSubmissionStatus,
   type TempoAaAuthorization,
   type TempoCall,
   type TempoFeePayerSignature,
@@ -819,6 +861,21 @@ export {
   type TransferReceivedTransactionDetail,
   type TransferRequestBody,
   type TransferSentTransactionDetail,
+  type TronContract,
+  type TronRawDataForSend,
+  type TronRawDataForSign,
+  type TronRpcInput,
+  type TronRpcResponse,
+  type TronSendTransactionRpcInput,
+  type TronSendTransactionRpcInputParams,
+  type TronSendTransactionRpcResponse,
+  type TronSendTransactionRpcResponseData,
+  type TronSignTransactionRpcInput,
+  type TronSignTransactionRpcInputParams,
+  type TronSignTransactionRpcResponse,
+  type TronSignTransactionRpcResponseData,
+  type TronTransferContract,
+  type TronTriggerSmartContract,
   type TypedDataDomainInputParams,
   type TypedDataTypeFieldInput,
   type TypedDataTypesInputParams,
@@ -826,12 +883,17 @@ export {
   type UnsignedStandardEthereumTransaction,
   type UnsignedTempoTransaction,
   type UserOperationInput,
+  type UserSigningKeyBinding,
   type Wallet,
   type WalletAdditionalSigner,
   type WalletAdditionalSignerItem,
   type WalletAPIRegisterAuthorizationKeyInput,
   type WalletAPIRevokeAuthorizationKeyInput,
   type WalletAsset,
+  type WalletAuthenticateBoundEncryptedRequestBody,
+  type WalletAuthenticateBoundRequestBody,
+  type WalletAuthenticateBoundUnencryptedRequestBody,
+  type WalletAuthenticateIntentsResponse,
   type WalletAuthenticateRequestBody,
   type WalletAuthenticateWithJwtResponse,
   type WalletAuthorizationHeaders,
@@ -858,12 +920,14 @@ export {
   type WalletUpdateParams,
   type WalletListParams,
   type WalletExportParams,
+  type WalletGetParams,
   type WalletRawSignParams,
   type WalletRpcParams,
   type WalletsCursor,
 } from './wallets/wallets';
 export {
   Webhooks,
+  type BlockInfo,
   type BridgeCryptoDepositMetadata,
   type BridgeCryptoTransferMetadata,
   type BridgeFiatDepositMetadata,
@@ -903,6 +967,7 @@ export {
   type UserCreatedWebhookPayload,
   type UserLinkedAccountWebhookPayload,
   type UserOperationCompletedWebhookPayload,
+  type UserReference,
   type UserTransferredAccountWebhookPayload,
   type UserUnlinkedAccountWebhookPayload,
   type UserUpdatedAccountWebhookPayload,
@@ -927,6 +992,7 @@ export {
   type WalletActionTransferFailedWebhookPayload,
   type WalletActionTransferRejectedWebhookPayload,
   type WalletActionTransferSucceededWebhookPayload,
+  type WalletArchivedWebhookPayload,
   type WalletFundsAsset,
   type WalletFundsErc20Asset,
   type WalletFundsNativeTokenAsset,
@@ -934,8 +1000,10 @@ export {
   type WalletFundsSplAsset,
   type WalletRecoveredWebhookPayload,
   type WalletRecoverySetupWebhookPayload,
+  type WalletRestoredWebhookPayload,
   type WebhookPayload,
   type YieldClaimConfirmedWebhookPayload,
+  type YieldClaimReward,
   type YieldDepositConfirmedWebhookPayload,
   type YieldWithdrawConfirmedWebhookPayload,
 } from './webhooks';
@@ -959,5 +1027,6 @@ export {
   type EthereumYieldSweepType,
   type EthereumYieldWithdrawInput,
   type EvmCaip2ChainID,
+  type VaultAsset,
   type YieldAuthorizationHeaders,
 } from './yield';