@privy-io/api-types 0.3.4 → 0.5.0

package/src/resources/client-auth.ts

@@ -213,7 +213,7 @@ export interface GuestAuthenticateRequestBody {
 export interface MfaPasskeyEnrollmentRequestBody {
   credential_ids: Array<string>;
 
-  remove_for_login: boolean;
+  remove_for_login?: boolean;
 }
 
 /**
@@ -441,23 +441,10 @@ export interface OAuthLinkRequestBody {
  * The response for linking an OAuth account.
  */
 export interface OAuthLinkResponseBody extends UsersAPI.User {
-  oauth_tokens?: OAuthLinkResponseBody.OAuthTokens;
-}
-
-export namespace OAuthLinkResponseBody {
-  export interface OAuthTokens {
-    access_token: string;
-
-    provider: string;
-
-    access_token_expires_in_seconds?: number;
-
-    refresh_token?: string;
-
-    refresh_token_expires_in_seconds?: number;
-
-    scopes?: Array<string>;
-  }
+  /**
+   * OAuth tokens associated with the user.
+   */
+  oauth_tokens?: UsersAPI.OAuthTokens;
 }
 
 /**
@@ -884,7 +871,7 @@ export namespace PasskeyRegisterRequestBody {
 export interface PasskeyUnlinkRequestBody {
   credential_id: string;
 
-  remove_as_mfa: boolean;
+  remove_as_mfa?: boolean;
 }
 
 /**
@@ -985,17 +972,17 @@ export interface PasswordlessUpdateRequestBody {
  * The request body for authenticating a SIWE ceremony.
  */
 export interface SiweAuthenticateRequestBody {
-  chainId: string | null;
-
-  connectorType: string | null;
-
   message: string;
 
   signature: string;
 
-  walletClientType: string | null;
+  chainId?: string | null;
+
+  connectorType?: string | null;
 
   mode?: 'no-signup' | 'login-or-sign-up';
+
+  walletClientType?: string | null;
 }
 
 /**
@@ -1020,15 +1007,15 @@ export interface SiweInitResponseBody {
  * The request body for linking a SIWE ceremony.
  */
 export interface SiweLinkRequestBody {
-  chainId: string | null;
-
-  connectorType: string | null;
-
   message: string;
 
   signature: string;
 
-  walletClientType: string | null;
+  chainId?: string | null;
+
+  connectorType?: string | null;
+
+  walletClientType?: string | null;
 }
 
 /**
@@ -1055,17 +1042,17 @@ export interface SiweUnlinkRequestBody {
  * The request body for authenticating a SIWS ceremony.
  */
 export interface SiwsAuthenticateRequestBody {
-  connectorType: string | null;
-
   message: string;
 
   signature: string;
 
-  walletClientType: string | null;
+  connectorType?: string | null;
 
   message_type?: 'transaction' | 'plain';
 
   mode?: 'no-signup' | 'login-or-sign-up';
+
+  walletClientType?: string | null;
 }
 
 /**
@@ -1090,15 +1077,15 @@ export interface SiwsInitResponseBody {
  * The request body for linking a SIWS ceremony.
  */
 export interface SiwsLinkRequestBody {
-  connectorType: string | null;
-
   message: string;
 
   signature: string;
 
-  walletClientType: string | null;
+  connectorType?: string | null;
 
   message_type?: 'transaction' | 'plain';
+
+  walletClientType?: string | null;
 }
 
 /**
@@ -1245,6 +1232,271 @@ export type CustomOAuthProviderID = `custom:${string}`;
  */
 export type OAuthProviderID = ExternalOAuthProviderID | PrivyOAuthProviderID | CustomOAuthProviderID;
 
+/**
+ * Valid set of onramp providers
+ */
+export type OnrampProvider = 'bridge' | 'bridge-sandbox';
+
+/**
+ * The request input for getting a native onramp provider customer.
+ */
+export interface GetFiatCustomerRequestInput {
+  /**
+   * Valid set of onramp providers
+   */
+  provider: OnrampProvider;
+}
+
+/**
+ * The request input for creating (or updating) a native onramp provider customer.
+ */
+export interface CreateOrUpdateFiatCustomerRequestInput {
+  has_accepted_terms: boolean;
+
+  /**
+   * Valid set of onramp providers
+   */
+  provider: OnrampProvider;
+}
+
+/**
+ * The response for getting a native onramp provider customer.
+ */
+export interface BridgeFiatCustomerResponse {
+  has_accepted_terms: boolean;
+
+  provider: 'bridge';
+
+  status:
+    | 'not_found'
+    | 'active'
+    | 'awaiting_questionnaire'
+    | 'awaiting_ubo'
+    | 'incomplete'
+    | 'not_started'
+    | 'offboarded'
+    | 'paused'
+    | 'rejected'
+    | 'under_review';
+
+  kyc_url?: string;
+}
+
+/**
+ * The response for getting a native onramp provider customer.
+ */
+export interface BridgeSandboxFiatCustomerResponse {
+  has_accepted_terms: boolean;
+
+  provider: 'bridge-sandbox';
+
+  status:
+    | 'not_found'
+    | 'active'
+    | 'awaiting_questionnaire'
+    | 'awaiting_ubo'
+    | 'incomplete'
+    | 'not_started'
+    | 'offboarded'
+    | 'paused'
+    | 'rejected'
+    | 'under_review';
+
+  kyc_url?: string;
+}
+
+/**
+ * The response for getting a native onramp provider customer.
+ */
+export type FiatCustomerResponse = BridgeFiatCustomerResponse | BridgeSandboxFiatCustomerResponse;
+
+export type BridgeDestinationAsset = 'usdb' | 'usdc' | 'usdt' | 'dai' | 'pyusd' | 'eurc';
+
+export type BridgeSourceAsset = 'usd' | 'eur' | 'mxn' | 'brl' | 'gbp';
+
+export interface BridgeFiatVirtualAccountSource {
+  asset: BridgeSourceAsset;
+}
+
+export interface BridgeFiatVirtualAccountDestination {
+  address: string;
+
+  asset: BridgeDestinationAsset;
+
+  chain: string;
+}
+
+/**
+ * The request input for creating virtual account.
+ */
+export interface BridgeFiatVirtualAccountRequest {
+  destination: BridgeFiatVirtualAccountDestination;
+
+  provider: 'bridge';
+
+  source: BridgeFiatVirtualAccountSource;
+}
+
+/**
+ * The request input for creating virtual account.
+ */
+export interface BridgeSandboxFiatVirtualAccountRequest {
+  destination: BridgeFiatVirtualAccountDestination;
+
+  provider: 'bridge-sandbox';
+
+  source: BridgeFiatVirtualAccountSource;
+}
+
+/**
+ * The request input for creating virtual account.
+ */
+export type FiatVirtualAccountRequest =
+  | BridgeFiatVirtualAccountRequest
+  | BridgeSandboxFiatVirtualAccountRequest;
+
+/**
+ * The deposit instructions for a virtual account.
+ */
+export interface BridgeUsdFiatVirtualAccountDepositInstructions {
+  asset: 'usd';
+
+  bank_account_number: string;
+
+  bank_address: string;
+
+  bank_beneficiary_address: string;
+
+  bank_beneficiary_name: string;
+
+  bank_name: string;
+
+  bank_routing_number: string;
+
+  payment_rails: Array<'ach_push' | 'wire'>;
+}
+
+/**
+ * The deposit instructions for a virtual account.
+ */
+export interface BridgeEurFiatVirtualAccountDepositInstructions {
+  account_holder_name: string;
+
+  asset: 'eur';
+
+  bank_address: string;
+
+  bank_name: string;
+
+  bic: string;
+
+  iban: string;
+
+  payment_rails: Array<'sepa'>;
+}
+
+/**
+ * The deposit instructions for a virtual account.
+ */
+export interface BridgeMxnFiatVirtualAccountDepositInstructions {
+  account_holder_name: string;
+
+  asset: 'mxn';
+
+  bank_address: string;
+
+  bank_name: string;
+
+  clabe: string;
+
+  payment_rails: Array<'spei'>;
+}
+
+/**
+ * The deposit instructions for a virtual account.
+ */
+export interface BridgeBrlFiatVirtualAccountDepositInstructions {
+  account_holder_name: string;
+
+  asset: 'brl';
+
+  bank_address: string;
+
+  bank_name: string;
+
+  br_code: string;
+
+  payment_rails: Array<'pix'>;
+}
+
+/**
+ * The deposit instructions for a virtual account.
+ */
+export interface BridgeGbpFiatVirtualAccountDepositInstructions {
+  account_holder_name: string;
+
+  account_number: string;
+
+  asset: 'gbp';
+
+  bank_address: string;
+
+  bank_name: string;
+
+  payment_rails: Array<'faster_payments'>;
+
+  sort_code: string;
+}
+
+/**
+ * The deposit instructions for a virtual account.
+ */
+export type BridgeFiatVirtualAccountDepositInstructions =
+  | BridgeUsdFiatVirtualAccountDepositInstructions
+  | BridgeEurFiatVirtualAccountDepositInstructions
+  | BridgeMxnFiatVirtualAccountDepositInstructions
+  | BridgeBrlFiatVirtualAccountDepositInstructions
+  | BridgeGbpFiatVirtualAccountDepositInstructions;
+
+/**
+ * The response for creating virtual account.
+ */
+export interface BridgeFiatVirtualAccountResponse {
+  /**
+   * The deposit instructions for a virtual account.
+   */
+  deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
+
+  destination: BridgeFiatVirtualAccountDestination;
+
+  provider: 'bridge';
+
+  status: string;
+}
+
+/**
+ * The response for creating virtual account.
+ */
+export interface BridgeSandboxFiatVirtualAccountResponse {
+  /**
+   * The deposit instructions for a virtual account.
+   */
+  deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
+
+  destination: BridgeFiatVirtualAccountDestination;
+
+  provider: 'bridge-sandbox';
+
+  status: string;
+}
+
+/**
+ * The response for creating virtual account.
+ */
+export type FiatVirtualAccountResponse =
+  | BridgeFiatVirtualAccountResponse
+  | BridgeSandboxFiatVirtualAccountResponse;
+
 export declare namespace ClientAuth {
   export {
     type CustomJwtAuthenticateRequestBody as CustomJwtAuthenticateRequestBody,
@@ -1319,5 +1571,27 @@ export declare namespace ClientAuth {
     type PrivyOAuthProviderID as PrivyOAuthProviderID,
     type CustomOAuthProviderID as CustomOAuthProviderID,
     type OAuthProviderID as OAuthProviderID,
+    type OnrampProvider as OnrampProvider,
+    type GetFiatCustomerRequestInput as GetFiatCustomerRequestInput,
+    type CreateOrUpdateFiatCustomerRequestInput as CreateOrUpdateFiatCustomerRequestInput,
+    type BridgeFiatCustomerResponse as BridgeFiatCustomerResponse,
+    type BridgeSandboxFiatCustomerResponse as BridgeSandboxFiatCustomerResponse,
+    type FiatCustomerResponse as FiatCustomerResponse,
+    type BridgeDestinationAsset as BridgeDestinationAsset,
+    type BridgeSourceAsset as BridgeSourceAsset,
+    type BridgeFiatVirtualAccountSource as BridgeFiatVirtualAccountSource,
+    type BridgeFiatVirtualAccountDestination as BridgeFiatVirtualAccountDestination,
+    type BridgeFiatVirtualAccountRequest as BridgeFiatVirtualAccountRequest,
+    type BridgeSandboxFiatVirtualAccountRequest as BridgeSandboxFiatVirtualAccountRequest,
+    type FiatVirtualAccountRequest as FiatVirtualAccountRequest,
+    type BridgeUsdFiatVirtualAccountDepositInstructions as BridgeUsdFiatVirtualAccountDepositInstructions,
+    type BridgeEurFiatVirtualAccountDepositInstructions as BridgeEurFiatVirtualAccountDepositInstructions,
+    type BridgeMxnFiatVirtualAccountDepositInstructions as BridgeMxnFiatVirtualAccountDepositInstructions,
+    type BridgeBrlFiatVirtualAccountDepositInstructions as BridgeBrlFiatVirtualAccountDepositInstructions,
+    type BridgeGbpFiatVirtualAccountDepositInstructions as BridgeGbpFiatVirtualAccountDepositInstructions,
+    type BridgeFiatVirtualAccountDepositInstructions as BridgeFiatVirtualAccountDepositInstructions,
+    type BridgeFiatVirtualAccountResponse as BridgeFiatVirtualAccountResponse,
+    type BridgeSandboxFiatVirtualAccountResponse as BridgeSandboxFiatVirtualAccountResponse,
+    type FiatVirtualAccountResponse as FiatVirtualAccountResponse,
   };
 }

package/src/resources/funding.ts

@@ -15,7 +15,7 @@ export namespace CoinbaseOnRampInitInput {
   export interface UnionMember0 {
     addresses: Array<UnionMember0.Address>;
 
-    assets?: Array<'eth' | 'ETH' | 'USDC' | 'POL'>;
+    assets?: Array<'eth' | 'ETH' | 'USDC' | 'POL' | 'MON'>;
   }
 
   export namespace UnionMember0 {
@@ -32,6 +32,7 @@ export namespace CoinbaseOnRampInitInput {
         | 'polygon'
         | 'arbitrum'
         | 'stellar'
+        | 'monad'
       >;
     }
   }
@@ -56,6 +57,7 @@ export namespace CoinbaseOnRampInitInput {
         | 'polygon'
         | 'arbitrum'
         | 'stellar'
+        | 'monad'
       >;
     }
   }
@@ -127,6 +129,7 @@ export namespace MoonpayOnRampSignInput {
         | 'WBTC_ETHEREUM'
         | 'BNB_BNB'
         | 'BNB_BSC'
+        | 'MON_MON'
         | 'CELO'
         | 'CUSD'
         | 'DAI'

package/src/resources/index.ts

@@ -1,5 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Aggregations,
+  type AggregationMethod,
+  type AggregationMetric,
+  type AggregationWindow,
+  type AggregationGroupBy,
+  type Aggregation,
+  type AggregationInput,
+} from './aggregations';
 export { Analytics, type AnalyticsEventInput } from './analytics';
 export { Apps, type AppResponse } from './apps';
 export {
@@ -76,6 +85,28 @@ export {
   type PrivyOAuthProviderID,
   type CustomOAuthProviderID,
   type OAuthProviderID,
+  type OnrampProvider,
+  type GetFiatCustomerRequestInput,
+  type CreateOrUpdateFiatCustomerRequestInput,
+  type BridgeFiatCustomerResponse,
+  type BridgeSandboxFiatCustomerResponse,
+  type FiatCustomerResponse,
+  type BridgeDestinationAsset,
+  type BridgeSourceAsset,
+  type BridgeFiatVirtualAccountSource,
+  type BridgeFiatVirtualAccountDestination,
+  type BridgeFiatVirtualAccountRequest,
+  type BridgeSandboxFiatVirtualAccountRequest,
+  type FiatVirtualAccountRequest,
+  type BridgeUsdFiatVirtualAccountDepositInstructions,
+  type BridgeEurFiatVirtualAccountDepositInstructions,
+  type BridgeMxnFiatVirtualAccountDepositInstructions,
+  type BridgeBrlFiatVirtualAccountDepositInstructions,
+  type BridgeGbpFiatVirtualAccountDepositInstructions,
+  type BridgeFiatVirtualAccountDepositInstructions,
+  type BridgeFiatVirtualAccountResponse,
+  type BridgeSandboxFiatVirtualAccountResponse,
+  type FiatVirtualAccountResponse,
 } from './client-auth';
 export { CrossApp, type CrossAppConnectionsResponse } from './cross-app';
 export {
@@ -109,6 +140,11 @@ export {
 } from './key-quorums';
 export {
   Policies,
+  type SuiTransactionCommandOperator,
+  type SuiTransferObjectsCommandField,
+  type TronTransactionCondition,
+  type SuiTransactionCommandCondition,
+  type SuiTransferObjectsCommandCondition,
   type Policy,
   type PolicyCreateRuleResponse,
   type PolicyDeleteResponse,
@@ -131,10 +167,17 @@ export {
 } from './transactions';
 export {
   Users,
-  type AuthenticatedUser,
-  type LinkedAccount,
-  type User,
-  type UserWithIdentityToken,
+  type LinkedAccountEmail,
+  type LinkedAccountPhone,
+  type LinkedAccountBaseWallet,
+  type LinkedAccountEthereum,
+  type SmartWalletType,
+  type LinkedAccountSmartWallet,
+  type LinkedAccountSolana,
+  type LinkedAccountFarcaster,
+  type LinkedAccountPasskey,
+  type LinkedAccountTelegram,
+  type EmbeddedWalletRecoveryMethod,
   type LinkedAccountEthereumEmbeddedWallet,
   type LinkedAccountSolanaEmbeddedWallet,
   type LinkedAccountBitcoinSegwitEmbeddedWallet,
@@ -142,8 +185,54 @@ export {
   type LinkedAccountCurveSigningEmbeddedWallet,
   type LinkedAccountEmbeddedWallet,
   type LinkedAccountEmbeddedWalletWithID,
-  type SmartWalletType,
-  type LinkedAccountSmartWallet,
+  type LinkedAccountGoogleOAuth,
+  type LinkedAccountTwitterOAuth,
+  type LinkedAccountDiscordOAuth,
+  type LinkedAccountGitHubOAuth,
+  type LinkedAccountLinkedInOAuth,
+  type LinkedAccountSpotifyOAuth,
+  type LinkedAccountInstagramOAuth,
+  type LinkedAccountTiktokOAuth,
+  type LinkedAccountLineOAuth,
+  type LinkedAccountTwitchOAuth,
+  type LinkedAccountAppleOAuth,
+  type LinkedAccountCustomOAuth,
+  type LinkedAccountCustomJwt,
+  type CrossAppEmbeddedWallet,
+  type CrossAppSmartWallet,
+  type LinkedAccountCrossApp,
+  type LinkedAccountAuthorizationKey,
+  type LinkedAccount,
+  type LinkedAccountType,
+  type CustomMetadata,
+  type LinkedAccountWalletInput,
+  type LinkedAccountEmailInput,
+  type LinkedAccountPhoneInput,
+  type LinkedAccountGoogleInput,
+  type LinkedAccountTwitterInput,
+  type LinkedAccountDiscordInput,
+  type LinkedAccountGitHubInput,
+  type LinkedAccountSpotifyInput,
+  type LinkedAccountInstagramInput,
+  type LinkedAccountTiktokInput,
+  type LinkedAccountLineInput,
+  type LinkedAccountTwitchInput,
+  type LinkedAccountAppleInput,
+  type LinkedAccountLinkedInInput,
+  type LinkedAccountFarcasterInput,
+  type LinkedAccountTelegramInput,
+  type LinkedAccountCustomJwtInput,
+  type LinkedAccountPasskeyInput,
+  type LinkedAccountInput,
+  type UserBatchCreateInput,
+  type SMSMfaMethod,
+  type TotpMfaMethod,
+  type PasskeyMfaMethod,
+  type LinkedMfaMethod,
+  type User,
+  type OAuthTokens,
+  type UserWithIdentityToken,
+  type AuthenticatedUser,
   type UserCreateParams,
   type UserListParams,
   type UserGetByCustomAuthIDParams,
@@ -166,13 +255,23 @@ export {
 } from './users';
 export {
   Wallets,
+  type WalletRevokeResponse,
   type CurveSigningChainType,
+  type ExtendedChainType,
   type FirstClassChainType,
-  type Wallet,
   type WalletChainType,
-  type WalletRevokeResponse,
-  type ExtendedChainType,
   type WalletCustodian,
+  type CustodialWalletProvider,
+  type CustodialWalletChainType,
+  type CustodialWalletCreateInput,
+  type CustodialWallet,
+  type HpkeImportConfig,
+  type SuiCommandName,
+  type Wallet,
+  type WalletBatchItemInput,
+  type WalletBatchCreateInput,
+  type WalletBatchCreateResult,
+  type WalletBatchCreateResponse,
   type EthereumPersonalSignRpcInput,
   type EthereumSignTransactionRpcInput,
   type EthereumSendTransactionRpcInput,
@@ -211,3 +310,51 @@ export {
   type WalletCreateWalletsWithRecoveryParams,
   type WalletsCursor,
 } from './wallets/wallets';
+export {
+  Webhooks,
+  type UserCreatedWebhookPayload,
+  type UserAuthenticatedWebhookPayload,
+  type UserLinkedAccountWebhookPayload,
+  type UserUnlinkedAccountWebhookPayload,
+  type UserUpdatedAccountWebhookPayload,
+  type UserTransferredAccountWebhookPayload,
+  type UserWalletCreatedWebhookPayload,
+  type TransactionBroadcastedWebhookPayload,
+  type TransactionConfirmedWebhookPayload,
+  type TransactionExecutionRevertedWebhookPayload,
+  type TransactionStillPendingWebhookPayload,
+  type TransactionFailedWebhookPayload,
+  type TransactionReplacedWebhookPayload,
+  type TransactionProviderErrorWebhookPayload,
+  type FundsDepositedWebhookPayload,
+  type FundsWithdrawnWebhookPayload,
+  type PrivateKeyExportWebhookPayload,
+  type WalletRecoverySetupWebhookPayload,
+  type WalletRecoveredWebhookPayload,
+  type MfaEnabledWebhookPayload,
+  type MfaDisabledWebhookPayload,
+  type KrakenEmbedVerificationCompletedWebhookPayload,
+  type KrakenEmbedVerificationFailedWebhookPayload,
+  type KrakenEmbedQuoteExecutedWebhookPayload,
+  type KrakenEmbedQuoteExecutionFailedWebhookPayload,
+  type KrakenEmbedQuoteCancelledWebhookPayload,
+  type KrakenEmbedUserVerifiedWebhookPayload,
+  type KrakenEmbedUserDisabledWebhookPayload,
+  type KrakenEmbedUserClosedWebhookPayload,
+} from './webhooks';
+export {
+  Yield,
+  type EthereumYieldProvider,
+  type EthereumYieldSweepType,
+  type EthereumYieldSweepStatus,
+  type EthereumYieldDepositInput,
+  type EthereumYieldWithdrawInput,
+  type EthereumYieldSweepResponse,
+  type EthereumVaultDetailsInput,
+  type EthereumYieldSweepIDInput,
+  type EthereumVaultResponse,
+  type EthereumVaultDetailsResponse,
+  type EthereumYieldPositionsInput,
+  type EthereumVaultPosition,
+  type EthereumYieldPositionResponse,
+} from './yield';

package/src/resources/key-quorums.ts

@@ -93,6 +93,9 @@ export class KeyQuorums extends APIResource {
   }
 }
 
+/**
+ * A key quorum for authorizing wallet operations.
+ */
 export interface KeyQuorum {
   id: string;
 
@@ -158,7 +161,7 @@ export interface KeyQuorumUpdateParams {
   authorization_threshold?: number;
 
   /**
-   * Body param:
+   * Body param
    */
   display_name?: string;