@privy-io/api-types 0.9.0 → 0.11.0

package/src/resources/embedded-wallets.ts

@@ -7,130 +7,127 @@ import * as WalletsAPI from './wallets/wallets';
 export class EmbeddedWallets extends APIResource {}
 
 /**
- * The configuration object for smart wallets.
+ * The Alchemy paymaster context for a smart wallet network configuration.
  */
-export type SmartWalletConfiguration = SmartWalletConfigurationDisabled | SmartWalletConfigurationEnabled;
+export interface AlchemyPaymasterContext {
+  policy_id: string;
+}
 
 /**
- * The input configuration object for smart wallets.
+ * The fields describing embedded wallet creation, used for user import and
+ * embedded wallet generation.
  */
-export type SmartWalletConfigurationInput =
-  | SmartWalletConfigurationDisabled
-  | SmartWalletConfigurationInputEnabled;
+export interface EmbeddedWalletCreationInput {
+  /**
+   * Wallets to create.
+   */
+  wallets?: Array<WalletCreationInput>;
+}
 
 /**
- * An additional signer configuration for a wallet.
+ * The client type for iCloud recovery operations.
  */
-export interface WalletCreationAdditionalSignerItem {
-  /**
-   * A unique identifier for a key quorum.
-   */
-  signer_id: SharedAPI.KeyQuorumID;
+export type ICloudClientType = 'web' | 'expo-ios';
 
-  /**
-   * The array of policy IDs that will be applied to wallet requests. If specified,
-   * this will override the base policy IDs set on the wallet. Currently, only one
-   * policy is supported per signer.
-   */
-  override_policy_ids?: Array<string>;
+/**
+ * The response from authenticating with OAuth for recovery.
+ */
+export interface OAuthAuthenticateRecoveryResponse {
+  access_token: string;
 }
 
 /**
- * The fields on wallet creation that can be specified when creating a
- * user-controlled embedded server wallet.
+ * The input for the iCloud Expo OAuth callback.
  */
-export interface WalletCreationInput {
-  /**
-   * The wallet chain types.
-   */
-  chain_type: WalletsAPI.WalletChainType;
+export interface OAuthCallbackICloudExpoInput {
+  ckWebAuthToken: string;
+}
 
+/**
+ * The input for initiating an iCloud OAuth recovery flow.
+ */
+export interface OAuthInitICloudRecoveryInput {
   /**
-   * Additional signers for the wallet.
+   * The client type for iCloud recovery operations.
    */
-  additional_signers?: Array<WalletCreationAdditionalSignerItem>;
+  client_type: ICloudClientType;
+}
 
-  /**
-   * Create a smart wallet with this wallet as the signer. Only supported for wallets
-   * with `chain_type: "ethereum"`.
-   */
-  create_smart_wallet?: boolean;
+/**
+ * The input for initiating an OAuth recovery flow.
+ */
+export interface OAuthInitRecoveryInput {
+  redirect_to: string;
 
-  /**
-   * Policy IDs to enforce on the wallet. Currently, only one policy is supported per
-   * wallet.
-   */
-  policy_ids?: Array<string>;
+  token?: string;
+
+  code_challenge?: string;
+
+  state_code?: string;
 }
 
 /**
- * The fields describing embedded wallet creation, used for user import and
- * embedded wallet generation.
+ * The input for getting the iCloud recovery configuration.
  */
-export interface EmbeddedWalletCreationInput {
+export interface RecoveryConfigurationICloudInput {
   /**
-   * Wallets to create.
+   * The client type for iCloud recovery operations.
    */
-  wallets?: Array<WalletCreationInput>;
+  client_type: ICloudClientType;
 }
 
 /**
- * The supported smart wallet providers.
+ * The response containing the iCloud recovery configuration.
  */
-export type SmartWalletType =
-  | 'safe'
-  | 'kernel'
-  | 'light_account'
-  | 'biconomy'
-  | 'coinbase_smart_wallet'
-  | 'thirdweb';
+export interface RecoveryConfigurationICloudResponse {
+  api_token: string;
+
+  container_identifier: string;
+
+  environment: string;
+}
 
 /**
- * The Alchemy paymaster context for a smart wallet network configuration.
+ * The input for getting the recovery key material.
  */
-export interface AlchemyPaymasterContext {
-  policy_id: string;
+export interface RecoveryKeyMaterialInput {
+  chain_type?: string;
 }
 
 /**
- * Network configuration for a smart wallet.
+ * The response containing the recovery key material.
  */
-export interface SmartWalletNetworkConfiguration {
-  bundler_url: string;
+export interface RecoveryKeyMaterialResponse {
+  file_id: string;
 
-  chain_id: string;
+  icloud_record_name: string;
 
-  chain_name?: string;
+  recovery_code: string;
 
-  /**
-   * The Alchemy paymaster context for a smart wallet network configuration.
-   */
-  paymaster_context?: AlchemyPaymasterContext;
+  recovery_key: string;
 
-  paymaster_url?: string;
+  recovery_key_derivation_salt: string;
 
-  rpc_url?: string;
+  /**
+   * The type of recovery mechanism used for wallet recovery.
+   */
+  recovery_type: RecoveryType;
 }
 
 /**
- * Input for network configuration for a smart wallet.
+ * The type of recovery mechanism used for wallet recovery.
  */
-export interface SmartWalletNetworkConfigurationInput {
-  chain_id: string;
-
-  bundler_url?: string;
-
-  chain_name?: string;
-
-  /**
-   * The Alchemy paymaster context for a smart wallet network configuration.
-   */
-  paymaster_context?: AlchemyPaymasterContext;
-
-  paymaster_url?: string;
+export type RecoveryType =
+  | 'user_passcode_derived_recovery_key'
+  | 'privy_passcode_derived_recovery_key'
+  | 'privy_generated_recovery_key'
+  | 'google_drive_recovery_secret'
+  | 'icloud_recovery_secret';
 
-  rpc_url?: string;
-}
+/**
+ * The configuration object for smart wallets.
+ */
+export type SmartWalletConfiguration = SmartWalletConfigurationDisabled | SmartWalletConfigurationEnabled;
 
 /**
  * A disabled smart wallet configuration.
@@ -155,6 +152,13 @@ export interface SmartWalletConfigurationEnabled {
   smart_wallet_version?: string;
 }
 
+/**
+ * The input configuration object for smart wallets.
+ */
+export type SmartWalletConfigurationInput =
+  | SmartWalletConfigurationDisabled
+  | SmartWalletConfigurationInputEnabled;
+
 /**
  * An enabled smart wallet configuration input.
  */
@@ -172,128 +176,124 @@ export interface SmartWalletConfigurationInputEnabled {
 }
 
 /**
- * The type of recovery mechanism used for wallet recovery.
+ * Network configuration for a smart wallet.
  */
-export type RecoveryType =
-  | 'user_passcode_derived_recovery_key'
-  | 'privy_passcode_derived_recovery_key'
-  | 'privy_generated_recovery_key'
-  | 'google_drive_recovery_secret'
-  | 'icloud_recovery_secret';
+export interface SmartWalletNetworkConfiguration {
+  bundler_url: string;
 
-/**
- * The client type for iCloud recovery operations.
- */
-export type ICloudClientType = 'web' | 'expo-ios';
+  chain_id: string;
 
-/**
- * The input for getting the recovery key material.
- */
-export interface RecoveryKeyMaterialInput {
-  chain_type?: string;
+  chain_name?: string;
+
+  /**
+   * The Alchemy paymaster context for a smart wallet network configuration.
+   */
+  paymaster_context?: AlchemyPaymasterContext;
+
+  paymaster_url?: string;
+
+  rpc_url?: string;
 }
 
 /**
- * The response containing the recovery key material.
+ * Input for network configuration for a smart wallet.
  */
-export interface RecoveryKeyMaterialResponse {
-  file_id: string;
-
-  icloud_record_name: string;
-
-  recovery_code: string;
+export interface SmartWalletNetworkConfigurationInput {
+  chain_id: string;
 
-  recovery_key: string;
+  bundler_url?: string;
 
-  recovery_key_derivation_salt: string;
+  chain_name?: string;
 
   /**
-   * The type of recovery mechanism used for wallet recovery.
+   * The Alchemy paymaster context for a smart wallet network configuration.
    */
-  recovery_type: RecoveryType;
-}
-
-/**
- * The input for initiating an OAuth recovery flow.
- */
-export interface OAuthInitRecoveryInput {
-  redirect_to: string;
-
-  token?: string;
+  paymaster_context?: AlchemyPaymasterContext;
 
-  code_challenge?: string;
+  paymaster_url?: string;
 
-  state_code?: string;
+  rpc_url?: string;
 }
 
 /**
- * The response from authenticating with OAuth for recovery.
+ * The supported smart wallet providers.
  */
-export interface OAuthAuthenticateRecoveryResponse {
-  access_token: string;
-}
+export type SmartWalletType =
+  | 'safe'
+  | 'kernel'
+  | 'light_account'
+  | 'biconomy'
+  | 'coinbase_smart_wallet'
+  | 'thirdweb';
 
 /**
- * The input for initiating an iCloud OAuth recovery flow.
+ * An additional signer configuration for a wallet.
  */
-export interface OAuthInitICloudRecoveryInput {
+export interface WalletCreationAdditionalSignerItem {
   /**
-   * The client type for iCloud recovery operations.
+   * A unique identifier for a key quorum.
    */
-  client_type: ICloudClientType;
-}
+  signer_id: SharedAPI.KeyQuorumID;
 
-/**
- * The input for the iCloud Expo OAuth callback.
- */
-export interface OAuthCallbackICloudExpoInput {
-  ckWebAuthToken: string;
+  /**
+   * The array of policy IDs that will be applied to wallet requests. If specified,
+   * this will override the base policy IDs set on the wallet. Currently, only one
+   * policy is supported per signer.
+   */
+  override_policy_ids?: Array<string>;
 }
 
 /**
- * The input for getting the iCloud recovery configuration.
+ * The fields on wallet creation that can be specified when creating a
+ * user-controlled embedded server wallet.
  */
-export interface RecoveryConfigurationICloudInput {
+export interface WalletCreationInput {
   /**
-   * The client type for iCloud recovery operations.
+   * The wallet chain types.
    */
-  client_type: ICloudClientType;
-}
+  chain_type: WalletsAPI.WalletChainType;
 
-/**
- * The response containing the iCloud recovery configuration.
- */
-export interface RecoveryConfigurationICloudResponse {
-  api_token: string;
+  /**
+   * Additional signers for the wallet.
+   */
+  additional_signers?: Array<WalletCreationAdditionalSignerItem>;
 
-  container_identifier: string;
+  /**
+   * Create a smart wallet with this wallet as the signer. Only supported for wallets
+   * with `chain_type: "ethereum"`.
+   */
+  create_smart_wallet?: boolean;
 
-  environment: string;
+  /**
+   * Policy IDs to enforce on the wallet. Currently, only one policy is supported per
+   * wallet.
+   */
+  policy_ids?: Array<string>;
 }
 
 export declare namespace EmbeddedWallets {
   export {
-    type SmartWalletConfiguration as SmartWalletConfiguration,
-    type SmartWalletConfigurationInput as SmartWalletConfigurationInput,
-    type WalletCreationAdditionalSignerItem as WalletCreationAdditionalSignerItem,
-    type WalletCreationInput as WalletCreationInput,
-    type EmbeddedWalletCreationInput as EmbeddedWalletCreationInput,
-    type SmartWalletType as SmartWalletType,
     type AlchemyPaymasterContext as AlchemyPaymasterContext,
-    type SmartWalletNetworkConfiguration as SmartWalletNetworkConfiguration,
-    type SmartWalletNetworkConfigurationInput as SmartWalletNetworkConfigurationInput,
-    type SmartWalletConfigurationDisabled as SmartWalletConfigurationDisabled,
-    type SmartWalletConfigurationEnabled as SmartWalletConfigurationEnabled,
-    type SmartWalletConfigurationInputEnabled as SmartWalletConfigurationInputEnabled,
-    type RecoveryType as RecoveryType,
+    type EmbeddedWalletCreationInput as EmbeddedWalletCreationInput,
     type ICloudClientType as ICloudClientType,
-    type RecoveryKeyMaterialInput as RecoveryKeyMaterialInput,
-    type RecoveryKeyMaterialResponse as RecoveryKeyMaterialResponse,
-    type OAuthInitRecoveryInput as OAuthInitRecoveryInput,
     type OAuthAuthenticateRecoveryResponse as OAuthAuthenticateRecoveryResponse,
-    type OAuthInitICloudRecoveryInput as OAuthInitICloudRecoveryInput,
     type OAuthCallbackICloudExpoInput as OAuthCallbackICloudExpoInput,
+    type OAuthInitICloudRecoveryInput as OAuthInitICloudRecoveryInput,
+    type OAuthInitRecoveryInput as OAuthInitRecoveryInput,
     type RecoveryConfigurationICloudInput as RecoveryConfigurationICloudInput,
     type RecoveryConfigurationICloudResponse as RecoveryConfigurationICloudResponse,
+    type RecoveryKeyMaterialInput as RecoveryKeyMaterialInput,
+    type RecoveryKeyMaterialResponse as RecoveryKeyMaterialResponse,
+    type RecoveryType as RecoveryType,
+    type SmartWalletConfiguration as SmartWalletConfiguration,
+    type SmartWalletConfigurationDisabled as SmartWalletConfigurationDisabled,
+    type SmartWalletConfigurationEnabled as SmartWalletConfigurationEnabled,
+    type SmartWalletConfigurationInput as SmartWalletConfigurationInput,
+    type SmartWalletConfigurationInputEnabled as SmartWalletConfigurationInputEnabled,
+    type SmartWalletNetworkConfiguration as SmartWalletNetworkConfiguration,
+    type SmartWalletNetworkConfigurationInput as SmartWalletNetworkConfigurationInput,
+    type SmartWalletType as SmartWalletType,
+    type WalletCreationAdditionalSignerItem as WalletCreationAdditionalSignerItem,
+    type WalletCreationInput as WalletCreationInput,
   };
 }

package/src/resources/fiat.ts

@@ -0,0 +1,177 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+
+export class Fiat extends APIResource {}
+
+/**
+ * Supported fiat currencies.
+ */
+export type FiatCurrency = 'usd' | 'eur';
+
+/**
+ * Supported fiat payment rails.
+ */
+export type FiatPaymentRail = 'sepa' | 'ach_push' | 'wire';
+
+/**
+ * Deposit instructions for an offramp transfer.
+ */
+export interface OfframpDepositInstructions {
+  amount: string;
+
+  /**
+   * Supported blockchain chains for onramp and offramp.
+   */
+  chain: OnrampChain;
+
+  /**
+   * Supported crypto assets for onramp and offramp.
+   */
+  currency: OnrampAsset;
+
+  from_address: string;
+
+  to_address: string;
+}
+
+/**
+ * Response for an offramp transfer initiation.
+ */
+export interface OfframpResponse {
+  id: string;
+
+  /**
+   * Deposit instructions for an offramp transfer.
+   */
+  deposit_instructions: OfframpDepositInstructions;
+
+  /**
+   * Status of an onramp or offramp transfer.
+   */
+  status: OnrampTransferStatus;
+}
+
+/**
+ * Supported crypto assets for onramp and offramp.
+ */
+export type OnrampAsset = 'usdc';
+
+/**
+ * Supported blockchain chains for onramp and offramp.
+ */
+export type OnrampChain = 'ethereum' | 'base' | 'arbitrum' | 'polygon' | 'optimism';
+
+/**
+ * Bank deposit instructions for an onramp transfer.
+ */
+export interface OnrampDepositInstructions {
+  amount: string;
+
+  /**
+   * Supported fiat currencies.
+   */
+  currency: FiatCurrency;
+
+  /**
+   * Supported fiat payment rails.
+   */
+  payment_rail: FiatPaymentRail;
+
+  account_holder_name?: string;
+
+  bank_account_number?: string;
+
+  bank_address?: string;
+
+  bank_beneficiary_address?: string;
+
+  bank_beneficiary_name?: string;
+
+  bank_name?: string;
+
+  bank_routing_number?: string;
+
+  bic?: string;
+
+  deposit_message?: string;
+
+  iban?: string;
+}
+
+/**
+ * Response for an onramp KYC verification.
+ */
+export interface OnrampKYCResponse {
+  /**
+   * Status of the KYC verification process.
+   */
+  status: OnrampKYCStatus;
+
+  user_id: string;
+
+  provider_user_id?: string;
+}
+
+/**
+ * Status of the KYC verification process.
+ */
+export type OnrampKYCStatus =
+  | 'not_found'
+  | 'active'
+  | 'awaiting_questionnaire'
+  | 'awaiting_ubo'
+  | 'incomplete'
+  | 'not_started'
+  | 'offboarded'
+  | 'paused'
+  | 'rejected'
+  | 'under_review';
+
+/**
+ * Response for an onramp transfer initiation.
+ */
+export interface OnrampResponse {
+  id: string;
+
+  /**
+   * Bank deposit instructions for an onramp transfer.
+   */
+  deposit_instructions: OnrampDepositInstructions;
+
+  /**
+   * Status of an onramp or offramp transfer.
+   */
+  status: OnrampTransferStatus;
+}
+
+/**
+ * Status of an onramp or offramp transfer.
+ */
+export type OnrampTransferStatus =
+  | 'awaiting_funds'
+  | 'in_review'
+  | 'funds_received'
+  | 'payment_submitted'
+  | 'payment_processed'
+  | 'canceled'
+  | 'error'
+  | 'undeliverable'
+  | 'returned'
+  | 'refunded';
+
+export declare namespace Fiat {
+  export {
+    type FiatCurrency as FiatCurrency,
+    type FiatPaymentRail as FiatPaymentRail,
+    type OfframpDepositInstructions as OfframpDepositInstructions,
+    type OfframpResponse as OfframpResponse,
+    type OnrampAsset as OnrampAsset,
+    type OnrampChain as OnrampChain,
+    type OnrampDepositInstructions as OnrampDepositInstructions,
+    type OnrampKYCResponse as OnrampKYCResponse,
+    type OnrampKYCStatus as OnrampKYCStatus,
+    type OnrampResponse as OnrampResponse,
+    type OnrampTransferStatus as OnrampTransferStatus,
+  };
+}