@privy-io/api-types 0.8.0 → 0.10.0

package/src/resources/apps.ts

@@ -7,136 +7,25 @@ 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.
+ * Confirmation response for deleting an allowlist entry.
  */
-export interface FundingOption {
-  method: string;
-
-  provider: string;
+export interface AllowlistDeletionResponse {
+  message: string;
 }
 
 /**
- * Configuration for funding and on-ramp options.
+ * An allowlist entry for an app.
  */
-export interface FundingConfigResponseSchema {
-  cross_chain_bridging_enabled: boolean;
-
-  default_recommended_amount: string;
+export interface AllowlistEntry {
+  id: string;
 
-  /**
-   * A crypto currency identified by a CAIP-2 chain ID and optional asset.
-   */
-  default_recommended_currency: Currency;
+  acceptedAt: number | null;
 
-  methods: Array<FundingMethodEnum>;
+  appId: string;
 
-  options: Array<FundingOption>;
+  type: string;
 
-  prompt_funding_on_wallet_creation: boolean;
+  value: string;
 }
 
 /**
@@ -294,6 +183,48 @@ export namespace AppResponse {
   }
 }
 
+/**
+ * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+ */
+export type Caip2 = string;
+
+/**
+ * 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;
+}
+
+/**
+ * A currency asset type.
+ */
+export type CurrencyAsset = 'native-currency' | 'USDC';
+
+/**
+ * An email domain.
+ */
+export type EmailDomain = string;
+
+/**
+ * Allowlist invite input for an email domain.
+ */
+export interface EmailDomainInviteInput {
+  type: 'emailDomain';
+
+  /**
+   * An email domain.
+   */
+  value: EmailDomain;
+}
+
 /**
  * Allowlist invite input for an email address.
  */
@@ -304,48 +235,177 @@ export interface EmailInviteInput {
 }
 
 /**
- * Allowlist invite input for a wallet address.
+ * Chain-specific configuration for embedded wallets.
  */
-export interface WalletInviteInput {
-  type: 'wallet';
+export interface EmbeddedWalletChainConfig {
+  /**
+   * Whether to create embedded wallets on login.
+   */
+  create_on_login: EmbeddedWalletCreateOnLogin;
+}
 
-  value: string;
+/**
+ * Configuration for embedded wallets including the mode.
+ */
+export interface EmbeddedWalletConfigSchema extends EmbeddedWalletInputSchema {
+  /**
+   * The mode for embedded wallets.
+   */
+  mode: EmbeddedWalletMode;
 }
 
 /**
- * Allowlist invite input for a phone number.
+ * Whether to create embedded wallets on login.
  */
-export interface PhoneInviteInput {
-  type: 'phone';
+export type EmbeddedWalletCreateOnLogin = 'users-without-wallets' | 'all-users' | 'off';
+
+/**
+ * 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 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;
+}
+
+/**
+ * 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;
+}
+
+/**
+ * Currency for gas spend values.
+ */
+export type GasSpendCurrency = 'usd';
+
+/**
+ * Query parameters for getting gas spend for a set of wallets.
+ */
+export interface GasSpendRequestBody {
+  /**
+   * Unix timestamp in milliseconds, exclusive.
+   */
+  end_timestamp: number;
+
+  /**
+   * Unix timestamp in milliseconds, inclusive.
+   */
+  start_timestamp: number;
+
+  /**
+   * List of wallet IDs to query gas spend for. Maximum 100.
+   */
+  wallet_ids: Array<string>;
+}
+
+/**
+ * Aggregated Privy gas credits charged for a set of wallets over a time range.
+ */
+export interface GasSpendResponseBody {
+  /**
+   * Currency for gas spend values.
+   */
+  currency: GasSpendCurrency;
 
+  /**
+   * Total Privy credits charged as a decimal string.
+   */
   value: string;
 }
 
 /**
- * Input for adding or removing an allowlist entry. Discriminated by type.
+ * Gas sponsorship configuration for an app.
  */
-export type UserInviteInput = EmailInviteInput | WalletInviteInput | PhoneInviteInput;
+export interface GasSponsorshipConfiguration {
+  configured_networks: Array<Caip2>;
+
+  require_app_secret: boolean;
+
+  sponsorship_enabled: boolean;
+}
 
 /**
- * An allowlist entry for an app.
+ * Input for configuring gas sponsorship settings for an app.
  */
-export interface AllowlistEntry {
-  id: string;
+export interface GasSponsorshipConfigurationInput {
+  configured_networks?: Array<Caip2>;
 
-  acceptedAt: number | null;
+  require_app_secret?: boolean;
 
-  appId: string;
+  sponsorship_enabled?: boolean;
+}
 
-  type: string;
+/**
+ * Allowlist invite input for a phone number.
+ */
+export interface PhoneInviteInput {
+  type: 'phone';
 
   value: string;
 }
 
 /**
- * Confirmation response for deleting an allowlist entry.
+ * Configuration for Telegram authentication.
  */
-export interface AllowlistDeletionResponse {
-  message: string;
+export interface TelegramAuthConfigSchema {
+  bot_id: string;
+
+  bot_name: string;
+
+  link_enabled: boolean;
+
+  seamless_auth_enabled: boolean;
 }
 
 /**
@@ -373,52 +433,58 @@ export interface TestAccountsResponse {
 }
 
 /**
- * Input for configuring gas sponsorship settings for an app.
+ * Input for adding or removing an allowlist entry. Discriminated by type.
  */
-export interface GasSponsorshipConfigurationInput {
-  configured_networks?: Array<Caip2>;
-
-  require_app_secret?: boolean;
-
-  sponsorship_enabled?: boolean;
-}
+export type UserInviteInput =
+  | EmailInviteInput
+  | EmailDomainInviteInput
+  | WalletInviteInput
+  | PhoneInviteInput;
 
 /**
- * Gas sponsorship configuration for an app.
+ * A user-owned recovery option for embedded wallets.
  */
-export interface GasSponsorshipConfiguration {
-  configured_networks: Array<Caip2>;
+export type UserOwnedRecoveryOption = 'user-passcode' | 'google-drive' | 'icloud';
 
-  require_app_secret: boolean;
+/**
+ * Allowlist invite input for a wallet address.
+ */
+export interface WalletInviteInput {
+  type: 'wallet';
 
-  sponsorship_enabled: boolean;
+  value: string;
 }
 
 export declare namespace Apps {
   export {
+    type AllowlistDeletionResponse as AllowlistDeletionResponse,
+    type AllowlistEntry as AllowlistEntry,
+    type AppResponse as AppResponse,
     type Caip2 as Caip2,
-    type CurrencyAsset as CurrencyAsset,
     type Currency as Currency,
-    type EmbeddedWalletCreateOnLogin as EmbeddedWalletCreateOnLogin,
+    type CurrencyAsset as CurrencyAsset,
+    type EmailDomain as EmailDomain,
+    type EmailDomainInviteInput as EmailDomainInviteInput,
+    type EmailInviteInput as EmailInviteInput,
     type EmbeddedWalletChainConfig as EmbeddedWalletChainConfig,
-    type UserOwnedRecoveryOption as UserOwnedRecoveryOption,
+    type EmbeddedWalletConfigSchema as EmbeddedWalletConfigSchema,
+    type EmbeddedWalletCreateOnLogin as EmbeddedWalletCreateOnLogin,
     type EmbeddedWalletInputSchema as EmbeddedWalletInputSchema,
     type EmbeddedWalletMode as EmbeddedWalletMode,
-    type EmbeddedWalletConfigSchema as EmbeddedWalletConfigSchema,
-    type TelegramAuthConfigSchema as TelegramAuthConfigSchema,
+    type FundingConfigResponseSchema as FundingConfigResponseSchema,
     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 GasSpendCurrency as GasSpendCurrency,
+    type GasSpendRequestBody as GasSpendRequestBody,
+    type GasSpendResponseBody as GasSpendResponseBody,
+    type GasSponsorshipConfiguration as GasSponsorshipConfiguration,
+    type GasSponsorshipConfigurationInput as GasSponsorshipConfigurationInput,
     type PhoneInviteInput as PhoneInviteInput,
-    type UserInviteInput as UserInviteInput,
-    type AllowlistEntry as AllowlistEntry,
-    type AllowlistDeletionResponse as AllowlistDeletionResponse,
+    type TelegramAuthConfigSchema as TelegramAuthConfigSchema,
     type TestAccount as TestAccount,
     type TestAccountsResponse as TestAccountsResponse,
-    type GasSponsorshipConfigurationInput as GasSponsorshipConfigurationInput,
-    type GasSponsorshipConfiguration as GasSponsorshipConfiguration,
+    type UserInviteInput as UserInviteInput,
+    type UserOwnedRecoveryOption as UserOwnedRecoveryOption,
+    type WalletInviteInput as WalletInviteInput,
   };
 }