@privy-io/api-types 0.22.0 → 0.24.0

package/src/resources/apps.ts

@@ -242,6 +242,122 @@ export interface Currency {
  */
 export type CurrencyAsset = 'native-currency' | 'USDC';
 
+/**
+ * Denylist input for an email domain, which blocks every email address on the
+ * domain.
+ */
+export interface DenylistEmailDomainInput {
+  type: 'emailDomain';
+
+  /**
+   * An email domain.
+   */
+  value: EmailDomain;
+}
+
+/**
+ * Denylist input for an email address, which also blocks its `+` and `.` variants.
+ */
+export interface DenylistEmailInput {
+  type: 'email';
+
+  value: string;
+}
+
+/**
+ * A denylist entry for an app.
+ */
+export interface DenylistEntry {
+  /**
+   * The ID of the denylist entry.
+   */
+  id: string;
+
+  /**
+   * The type of identifier a denylist rule blocks.
+   */
+  rule_type: DenylistRuleType;
+
+  /**
+   * The blocked identifier.
+   */
+  value: string;
+}
+
+/**
+ * Input for adding a denylist entry. Discriminated by type.
+ */
+export type DenylistEntryCreateRequestBody =
+  | DenylistEmailInput
+  | DenylistEmailDomainInput
+  | DenylistPhoneInput
+  | DenylistEthereumAddressInput
+  | DenylistSolanaAddressInput;
+
+/**
+ * Input for removing a denylist entry.
+ */
+export interface DenylistEntryDeleteRequestBody {
+  /**
+   * The ID of the denylist entry to remove.
+   */
+  id: string;
+}
+
+/**
+ * Denylist input for an Ethereum wallet address, which blocks SIWE logins.
+ */
+export interface DenylistEthereumAddressInput {
+  type: 'ethereumAddress';
+
+  value: string;
+}
+
+/**
+ * A page of denylist entries for an app.
+ */
+export interface DenylistListResponse {
+  /**
+   * Denylist entries in this page.
+   */
+  data: Array<DenylistEntry>;
+
+  /**
+   * Cursor for the next page, which is null only when this page is empty, so keep
+   * paging until `data` is empty.
+   */
+  next_cursor: string | null;
+}
+
+/**
+ * Denylist input for a phone number.
+ */
+export interface DenylistPhoneInput {
+  type: 'phone';
+
+  value: string;
+}
+
+/**
+ * The type of identifier a denylist rule blocks.
+ */
+export type DenylistRuleType =
+  | 'email'
+  | 'emailDomain'
+  | 'phone'
+  | 'ethereumAddress'
+  | 'solanaAddress'
+  | (string & {});
+
+/**
+ * Denylist input for a Solana wallet address, which blocks SIWS logins.
+ */
+export interface DenylistSolanaAddressInput {
+  type: 'solanaAddress';
+
+  value: string;
+}
+
 /**
  * An email domain.
  */
@@ -490,6 +606,16 @@ export declare namespace Apps {
     type CaptchaProvider as CaptchaProvider,
     type Currency as Currency,
     type CurrencyAsset as CurrencyAsset,
+    type DenylistEmailDomainInput as DenylistEmailDomainInput,
+    type DenylistEmailInput as DenylistEmailInput,
+    type DenylistEntry as DenylistEntry,
+    type DenylistEntryCreateRequestBody as DenylistEntryCreateRequestBody,
+    type DenylistEntryDeleteRequestBody as DenylistEntryDeleteRequestBody,
+    type DenylistEthereumAddressInput as DenylistEthereumAddressInput,
+    type DenylistListResponse as DenylistListResponse,
+    type DenylistPhoneInput as DenylistPhoneInput,
+    type DenylistRuleType as DenylistRuleType,
+    type DenylistSolanaAddressInput as DenylistSolanaAddressInput,
     type EmailDomain as EmailDomain,
     type EmailDomainInviteInput as EmailDomainInviteInput,
     type EmailInviteInput as EmailInviteInput,

package/src/resources/cards.ts

@@ -57,13 +57,12 @@ export interface CardIssuingCardResponse {
   id: string;
 
   /**
-   * The asset the card funds from. 'usdc' on EVM and Solana, 'pathusd' on Tempo.
+   * The stablecoin the card settles in.
    */
   asset: string;
 
   /**
-   * USD balance of the card funding wallet on the configured chain, or null when
-   * unavailable.
+   * USD amount the card can spend right now, or null when unavailable.
    */
   balance_formatted: string | null;
 
@@ -94,6 +93,11 @@ export interface CardIssuingCardResponse {
    */
   exp_year: number | null;
 
+  /**
+   * The funding sources the card can spend from, with at most one `selected`.
+   */
+  funding_sources: Array<CardIssuingFundingSource>;
+
   last4: string | null;
 
   provider_id: string;
@@ -132,10 +136,21 @@ export interface CardIssuingCardsResponse {
  * Browser-safe configuration for rendering Stripe Issuing card details.
  */
 export interface CardIssuingConfig {
+  /**
+   * Logo for the in-app card face. Null when none is set.
+   */
+  card_logo_url: string | null;
+
   /**
    * Stripe publishable key for initializing Stripe.js in the browser.
    */
   publishable_key: string;
+
+  /**
+   * Stripe account the publishable key acts on; absent when the key belongs to the
+   * app directly.
+   */
+  stripe_account?: string;
 }
 
 /**
@@ -163,8 +178,7 @@ export interface CardIssuingConfigResponse {
  */
 export interface CardIssuingCreateCardInput {
   /**
-   * The asset to fund the card. Must be 'usdc' on EVM and Solana, or 'pathusd' on
-   * Tempo.
+   * The asset that funds the card on `chain_id`.
    */
   asset: string;
 
@@ -384,6 +398,48 @@ export interface CardIssuingEphemeralKeyResponse {
   data: CardIssuingEphemeralKey;
 }
 
+/**
+ * The funding wallet's shares in an ERC-4626 Earn vault, which the card spends
+ * instead of its `asset` balance.
+ */
+export interface CardIssuingErc4626VaultFundingSource {
+  /**
+   * Earn provider of an ERC-4626 vault a card can spend.
+   */
+  provider: CardIssuingErc4626VaultProvider;
+
+  /**
+   * Whether this is the source the card spends right now.
+   */
+  selected: boolean;
+
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  share_token_address: SharedAPI.EvmAddress;
+
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  spender_address: SharedAPI.EvmAddress;
+
+  type: 'erc4626_vault';
+}
+
+/**
+ * Earn provider of an ERC-4626 vault a card can spend.
+ */
+export type CardIssuingErc4626VaultProvider = 'morpho' | 'aave';
+
+/**
+ * Funds a card can spend, where `selected`, not list position, marks the one it
+ * spends.
+ */
+export type CardIssuingFundingSource =
+  | CardIssuingWalletFundingSource
+  | CardIssuingErc4626VaultFundingSource
+  | CardIssuingTempoEarnVaultFundingSource;
+
 /**
  * Query parameters for listing cards bound to the authenticated Privy user.
  */
@@ -471,6 +527,40 @@ export interface CardIssuingStatementQueryParams {
   environment: SharedAPI.IntegrationEnvironment;
 }
 
+/**
+ * The funding wallet's shares in a Tempo Earn vault, which a card that also lists
+ * its wallet can switch to and back from.
+ */
+export interface CardIssuingTempoEarnVaultFundingSource {
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  asset_address: SharedAPI.EvmAddress;
+
+  /**
+   * Whether the card spends this vault right now; neither it nor the wallet is when
+   * the wallet chose a vault outside the app's Earn vaults.
+   */
+  selected: boolean;
+
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  share_token_address: SharedAPI.EvmAddress;
+
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  spender_address: SharedAPI.EvmAddress;
+
+  type: 'tempo_earn_vault';
+
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  vault_address: SharedAPI.EvmAddress;
+}
+
 /**
  * Card activity
  */
@@ -539,6 +629,18 @@ export interface CardIssuingUpdateCardInput {
   status?: CardIssuingCardStatus;
 }
 
+/**
+ * The funding wallet's `asset` balance.
+ */
+export interface CardIssuingWalletFundingSource {
+  /**
+   * Whether this is the source the card spends right now.
+   */
+  selected: boolean;
+
+  type: 'wallet';
+}
+
 export declare namespace Cards {
   export {
     type CardIssuingBankAgreement as CardIssuingBankAgreement,
@@ -571,6 +673,9 @@ export declare namespace Cards {
     type CardIssuingEphemeralKey as CardIssuingEphemeralKey,
     type CardIssuingEphemeralKeyRequestBody as CardIssuingEphemeralKeyRequestBody,
     type CardIssuingEphemeralKeyResponse as CardIssuingEphemeralKeyResponse,
+    type CardIssuingErc4626VaultFundingSource as CardIssuingErc4626VaultFundingSource,
+    type CardIssuingErc4626VaultProvider as CardIssuingErc4626VaultProvider,
+    type CardIssuingFundingSource as CardIssuingFundingSource,
     type CardIssuingListCardsInput as CardIssuingListCardsInput,
     type CardIssuingListTransactionsInput as CardIssuingListTransactionsInput,
     type CardIssuingMerchant as CardIssuingMerchant,
@@ -578,9 +683,11 @@ export declare namespace Cards {
     type CardIssuingReplaceCardRequestBody as CardIssuingReplaceCardRequestBody,
     type CardIssuingReplacementReason as CardIssuingReplacementReason,
     type CardIssuingStatementQueryParams as CardIssuingStatementQueryParams,
+    type CardIssuingTempoEarnVaultFundingSource as CardIssuingTempoEarnVaultFundingSource,
     type CardIssuingTransactionResponse as CardIssuingTransactionResponse,
     type CardIssuingTransactionStatus as CardIssuingTransactionStatus,
     type CardIssuingTransactionsResponse as CardIssuingTransactionsResponse,
     type CardIssuingUpdateCardInput as CardIssuingUpdateCardInput,
+    type CardIssuingWalletFundingSource as CardIssuingWalletFundingSource,
   };
 }

package/src/resources/client-auth.ts

@@ -96,7 +96,7 @@ export interface BridgeBrlFiatVirtualAccountDepositInstructions {
 /**
  * Supported destination stablecoin assets for fiat-to-crypto transfers.
  */
-export type BridgeDestinationAsset = 'usdb' | 'usdc' | 'usdt' | 'dai' | 'pyusd' | 'eurc';
+export type BridgeDestinationAsset = 'usdb' | 'usdc' | 'usdt' | 'dai' | 'pyusd' | 'eurc' | 'ousd';
 
 /**
  * The deposit instructions for a virtual account.