@privy-io/api-types 0.6.1 → 0.8.0

package/src/resources/apps.ts

@@ -2,9 +2,143 @@
 
 import { APIResource } from '../core/resource';
 import * as ClientAuthAPI from './client-auth';
+import * as EmbeddedWalletsAPI from './embedded-wallets';
 
 export class Apps extends APIResource {}
 
+/**
+ * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+ */
+export type Caip2 = string;
+
+/**
+ * A currency asset type.
+ */
+export type CurrencyAsset = 'native-currency' | 'USDC';
+
+/**
+ * A crypto currency identified by a CAIP-2 chain ID and optional asset.
+ */
+export interface Currency {
+  /**
+   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   */
+  chain: Caip2;
+
+  /**
+   * A currency asset type.
+   */
+  asset?: CurrencyAsset;
+}
+
+/**
+ * Whether to create embedded wallets on login.
+ */
+export type EmbeddedWalletCreateOnLogin = 'users-without-wallets' | 'all-users' | 'off';
+
+/**
+ * Chain-specific configuration for embedded wallets.
+ */
+export interface EmbeddedWalletChainConfig {
+  /**
+   * Whether to create embedded wallets on login.
+   */
+  create_on_login: EmbeddedWalletCreateOnLogin;
+}
+
+/**
+ * A user-owned recovery option for embedded wallets.
+ */
+export type UserOwnedRecoveryOption = 'user-passcode' | 'google-drive' | 'icloud';
+
+/**
+ * Input configuration for embedded wallets.
+ */
+export interface EmbeddedWalletInputSchema {
+  /**
+   * Whether to create embedded wallets on login.
+   */
+  create_on_login: EmbeddedWalletCreateOnLogin;
+
+  /**
+   * Chain-specific configuration for embedded wallets.
+   */
+  ethereum: EmbeddedWalletChainConfig;
+
+  /**
+   * Chain-specific configuration for embedded wallets.
+   */
+  solana: EmbeddedWalletChainConfig;
+
+  user_owned_recovery_options: Array<UserOwnedRecoveryOption>;
+
+  require_user_owned_recovery_on_create?: boolean;
+
+  require_user_password_on_create?: boolean;
+}
+
+/**
+ * The mode for embedded wallets.
+ */
+export type EmbeddedWalletMode = 'legacy-embedded-wallets-only' | 'user-controlled-server-wallets-only';
+
+/**
+ * Configuration for embedded wallets including the mode.
+ */
+export interface EmbeddedWalletConfigSchema extends EmbeddedWalletInputSchema {
+  /**
+   * The mode for embedded wallets.
+   */
+  mode: EmbeddedWalletMode;
+}
+
+/**
+ * Configuration for Telegram authentication.
+ */
+export interface TelegramAuthConfigSchema {
+  bot_id: string;
+
+  bot_name: string;
+
+  link_enabled: boolean;
+
+  seamless_auth_enabled: boolean;
+}
+
+/**
+ * A funding method for on-ramp.
+ */
+export type FundingMethodEnum = 'moonpay' | 'coinbase-onramp' | 'external';
+
+/**
+ * A funding option with method and provider.
+ */
+export interface FundingOption {
+  method: string;
+
+  provider: string;
+}
+
+/**
+ * Configuration for funding and on-ramp options.
+ */
+export interface FundingConfigResponseSchema {
+  cross_chain_bridging_enabled: boolean;
+
+  default_recommended_amount: string;
+
+  /**
+   * A crypto currency identified by a CAIP-2 chain ID and optional asset.
+   */
+  default_recommended_currency: Currency;
+
+  methods: Array<FundingMethodEnum>;
+
+  options: Array<FundingOption>;
+
+  prompt_funding_on_wallet_creation: boolean;
+}
+
 /**
  * The response for getting an app.
  */
@@ -39,7 +173,10 @@ export interface AppResponse {
 
   email_auth: boolean;
 
-  embedded_wallet_config: AppResponse.EmbeddedWalletConfig;
+  /**
+   * Configuration for embedded wallets including the mode.
+   */
+  embedded_wallet_config: EmbeddedWalletConfigSchema;
 
   enabled_captcha_provider: 'turnstile' | 'hcaptcha' | null;
 
@@ -85,7 +222,10 @@ export interface AppResponse {
 
   show_wallet_login_first: boolean;
 
-  smart_wallet_config: AppResponse.Enabled | AppResponse.UnionMember1;
+  /**
+   * The configuration object for smart wallets.
+   */
+  smart_wallet_config: EmbeddedWalletsAPI.SmartWalletConfiguration;
 
   sms_auth: boolean;
 
@@ -117,9 +257,15 @@ export interface AppResponse {
 
   captcha_site_key?: string;
 
-  funding_config?: AppResponse.FundingConfig;
+  /**
+   * Configuration for funding and on-ramp options.
+   */
+  funding_config?: FundingConfigResponseSchema;
 
-  telegram_auth_config?: AppResponse.TelegramAuthConfig;
+  /**
+   * Configuration for Telegram authentication.
+   */
+  telegram_auth_config?: TelegramAuthConfigSchema;
 }
 
 export namespace AppResponse {
@@ -146,114 +292,133 @@ export namespace AppResponse {
 
     provider_icon_url: string;
   }
+}
 
-  export interface EmbeddedWalletConfig {
-    create_on_login: 'users-without-wallets' | 'all-users' | 'off';
-
-    ethereum: EmbeddedWalletConfig.Ethereum;
-
-    mode: 'legacy-embedded-wallets-only' | 'user-controlled-server-wallets-only';
-
-    solana: EmbeddedWalletConfig.Solana;
-
-    user_owned_recovery_options: Array<'user-passcode' | 'google-drive' | 'icloud'>;
-
-    require_user_owned_recovery_on_create?: boolean;
-
-    require_user_password_on_create?: boolean;
-  }
-
-  export namespace EmbeddedWalletConfig {
-    export interface Ethereum {
-      create_on_login: 'users-without-wallets' | 'all-users' | 'off';
-    }
-
-    export interface Solana {
-      create_on_login: 'users-without-wallets' | 'all-users' | 'off';
-    }
-  }
-
-  export interface Enabled {
-    enabled: false;
-  }
+/**
+ * Allowlist invite input for an email address.
+ */
+export interface EmailInviteInput {
+  type: 'email';
 
-  export interface UnionMember1 {
-    configured_networks: Array<UnionMember1.ConfiguredNetwork>;
+  value: string;
+}
 
-    enabled: true;
+/**
+ * Allowlist invite input for a wallet address.
+ */
+export interface WalletInviteInput {
+  type: 'wallet';
 
-    smart_wallet_type:
-      | 'safe'
-      | 'kernel'
-      | 'light_account'
-      | 'biconomy'
-      | 'coinbase_smart_wallet'
-      | 'thirdweb';
+  value: string;
+}
 
-    smart_wallet_version?: string;
-  }
+/**
+ * Allowlist invite input for a phone number.
+ */
+export interface PhoneInviteInput {
+  type: 'phone';
 
-  export namespace UnionMember1 {
-    export interface ConfiguredNetwork {
-      bundler_url: string;
+  value: string;
+}
 
-      chain_id: string;
+/**
+ * Input for adding or removing an allowlist entry. Discriminated by type.
+ */
+export type UserInviteInput = EmailInviteInput | WalletInviteInput | PhoneInviteInput;
 
-      chain_name?: string;
+/**
+ * An allowlist entry for an app.
+ */
+export interface AllowlistEntry {
+  id: string;
 
-      paymaster_context?: ConfiguredNetwork.PaymasterContext;
+  acceptedAt: number | null;
 
-      paymaster_url?: string;
+  appId: string;
 
-      rpc_url?: string;
-    }
+  type: string;
 
-    export namespace ConfiguredNetwork {
-      export interface PaymasterContext {
-        policy_id: string;
-      }
-    }
-  }
+  value: string;
+}
 
-  export interface FundingConfig {
-    cross_chain_bridging_enabled: boolean;
+/**
+ * Confirmation response for deleting an allowlist entry.
+ */
+export interface AllowlistDeletionResponse {
+  message: string;
+}
 
-    default_recommended_amount: string;
+/**
+ * A test account for an app.
+ */
+export interface TestAccount {
+  id: string;
 
-    default_recommended_currency: FundingConfig.DefaultRecommendedCurrency;
+  created_at: string;
 
-    methods: Array<'moonpay' | 'coinbase-onramp' | 'external'>;
+  email: string;
 
-    options: Array<FundingConfig.Option>;
+  otp_code: string;
 
-    prompt_funding_on_wallet_creation: boolean;
-  }
+  phone_number: string;
 
-  export namespace FundingConfig {
-    export interface DefaultRecommendedCurrency {
-      chain: string;
+  updated_at: string;
+}
 
-      asset?: 'native-currency' | 'USDC';
-    }
+/**
+ * Response for listing test accounts for an app.
+ */
+export interface TestAccountsResponse {
+  data: Array<TestAccount>;
+}
 
-    export interface Option {
-      method: string;
+/**
+ * Input for configuring gas sponsorship settings for an app.
+ */
+export interface GasSponsorshipConfigurationInput {
+  configured_networks?: Array<Caip2>;
 
-      provider: string;
-    }
-  }
+  require_app_secret?: boolean;
 
-  export interface TelegramAuthConfig {
-    bot_id: string;
+  sponsorship_enabled?: boolean;
+}
 
-    bot_name: string;
+/**
+ * Gas sponsorship configuration for an app.
+ */
+export interface GasSponsorshipConfiguration {
+  configured_networks: Array<Caip2>;
 
-    link_enabled: boolean;
+  require_app_secret: boolean;
 
-    seamless_auth_enabled: boolean;
-  }
+  sponsorship_enabled: boolean;
 }
 
 export declare namespace Apps {
-  export { type AppResponse as AppResponse };
+  export {
+    type Caip2 as Caip2,
+    type CurrencyAsset as CurrencyAsset,
+    type Currency as Currency,
+    type EmbeddedWalletCreateOnLogin as EmbeddedWalletCreateOnLogin,
+    type EmbeddedWalletChainConfig as EmbeddedWalletChainConfig,
+    type UserOwnedRecoveryOption as UserOwnedRecoveryOption,
+    type EmbeddedWalletInputSchema as EmbeddedWalletInputSchema,
+    type EmbeddedWalletMode as EmbeddedWalletMode,
+    type EmbeddedWalletConfigSchema as EmbeddedWalletConfigSchema,
+    type TelegramAuthConfigSchema as TelegramAuthConfigSchema,
+    type FundingMethodEnum as FundingMethodEnum,
+    type FundingOption as FundingOption,
+    type FundingConfigResponseSchema as FundingConfigResponseSchema,
+    type AppResponse as AppResponse,
+    type EmailInviteInput as EmailInviteInput,
+    type WalletInviteInput as WalletInviteInput,
+    type PhoneInviteInput as PhoneInviteInput,
+    type UserInviteInput as UserInviteInput,
+    type AllowlistEntry as AllowlistEntry,
+    type AllowlistDeletionResponse as AllowlistDeletionResponse,
+    type TestAccount as TestAccount,
+    type TestAccountsResponse as TestAccountsResponse,
+    type GasSponsorshipConfigurationInput as GasSponsorshipConfigurationInput,
+    type GasSponsorshipConfiguration as GasSponsorshipConfiguration,
+  };
 }