@privy-io/api-types 0.15.0 → 0.17.0

package/src/resources/onramps.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as OnrampsAPI from './onramps';
 import * as ClientAuthAPI from './client-auth';
 import * as FiatAPI from './fiat';
+import * as SharedAPI from './shared';
 
 export class Onramps extends APIResource {}
 
@@ -61,6 +61,11 @@ export type Caip2ChainID = string;
  */
 export interface CreateLinkAuthIntentInput {
   email?: string;
+
+  /**
+   * Whether to use the sandbox or production environment for fiat onramp.
+   */
+  environment?: FiatOnrampEnvironment;
 }
 
 /**
@@ -115,21 +120,9 @@ export interface CreateStripeOnrampSessionResponse {
   /**
    * Transaction details returned from a Stripe onramp session.
    */
-  transaction_details?: CreateStripeOnrampSessionResponse.TransactionDetails;
+  transaction_details?: OnrampSessionTransactionDetails | null;
 }
 
-export namespace CreateStripeOnrampSessionResponse {
-  /**
-   * Transaction details returned from a Stripe onramp session.
-   */
-  export interface TransactionDetails extends OnrampsAPI.OnrampSessionTransactionDetails {}
-}
-
-/**
- * Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
- */
-export type CryptoCurrencyCode = string;
-
 /**
  * Input for exchanging a Link auth intent for OAuth tokens.
  */
@@ -137,6 +130,11 @@ export interface ExchangeStripeTokensInput {
   auth_intent_id: string;
 
   crypto_customer_id: string;
+
+  /**
+   * Whether to use the sandbox or production environment for fiat onramp.
+   */
+  environment?: FiatOnrampEnvironment;
 }
 
 /**
@@ -168,9 +166,11 @@ export interface FiatOnrampDestination {
   address: string;
 
   /**
-   * Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
+   * Token identifier string. EVM-shaped 40-hex token addresses normalize to checksum
+   * case, 16-byte Hyperliquid token IDs normalize to lowercase, and all other
+   * identifiers pass through unchanged.
    */
-  asset: CryptoCurrencyCode;
+  asset: SharedAPI.TokenIdentifier;
 
   /**
    * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
@@ -222,11 +222,15 @@ export interface FiatOnrampQuote {
 
   destination_currency_code?: string | null;
 
+  payment_method_category?: string;
+
   source_amount?: number | null;
 
   source_currency_code?: string | null;
 
   sub_provider?: string | null;
+
+  warning?: string | null;
 }
 
 /**
@@ -316,6 +320,12 @@ export interface GetFiatOnrampQuotesInput {
  * The response containing fiat onramp quotes.
  */
 export interface GetFiatOnrampQuotesResponse {
+  destination_currency_icon_url: string | null;
+
+  destination_currency_symbol: string;
+
+  destination_network_icon_url: string | null;
+
   quotes: Array<FiatOnrampQuote>;
 
   provider_errors?: Array<FiatOnrampProviderError>;
@@ -423,15 +433,6 @@ export interface ListStripePaymentTokensResponse {
   data: Array<StripePaymentToken>;
 }
 
-/**
- * Fee breakdown for a Stripe onramp transaction.
- */
-export interface OnrampSessionFees {
-  network_fee_monetary: string | null;
-
-  transaction_fee_monetary: string | null;
-}
-
 /**
  * Parameters for creating a Stripe onramp session.
  */
@@ -439,9 +440,11 @@ export interface OnrampSessionParams {
   crypto_customer_id: string;
 
   /**
-   * Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
+   * Token identifier string. EVM-shaped 40-hex token addresses normalize to checksum
+   * case, 16-byte Hyperliquid token IDs normalize to lowercase, and all other
+   * identifiers pass through unchanged.
    */
-  destination_currency: CryptoCurrencyCode;
+  destination_currency: SharedAPI.TokenIdentifier;
 
   destination_network: string;
 
@@ -467,31 +470,26 @@ export interface OnrampSessionTransactionDetails {
 
   destination_network: string | null;
 
-  /**
-   * Fee breakdown for a Stripe onramp transaction.
-   */
-  fees: OnrampSessionTransactionDetails.Fees;
-
-  source_amount: string | null;
+  fee: string | null;
 
   source_currency: string | null;
-}
 
-export namespace OnrampSessionTransactionDetails {
-  /**
-   * Fee breakdown for a Stripe onramp transaction.
-   */
-  export interface Fees extends OnrampsAPI.OnrampSessionFees {}
+  source_total_amount: string | null;
+
+  quote_expiration?: number | null;
 }
 
 /**
- * Refreshed quote with new expiry.
+ * Refreshed quote with amounts, fee, and expiry.
  */
 export interface RefreshStripeQuoteResponse {
-  /**
-   * A refreshed quote.
-   */
-  quote: StripeQuote;
+  destination_amount: string | null;
+
+  fee: string | null;
+
+  quote_expiration: number | null;
+
+  source_total_amount: string | null;
 }
 
 /**
@@ -511,6 +509,15 @@ export interface StripeConsumerWallet {
 export interface StripeCryptoCustomerActive {
   crypto_customer_id: string;
 
+  /**
+   * Region derived from a Stripe user's country of residence.
+   */
+  kyc_region: StripeKYCRegion | null;
+
+  kyc_tiers: Array<StripeKYCTier>;
+
+  provided_fields: Array<string>;
+
   status: 'active';
 
   verifications: Array<StripeVerification>;
@@ -532,6 +539,22 @@ export interface StripeCryptoCustomerNone {
   status: 'none';
 }
 
+/**
+ * Region derived from a Stripe user's country of residence.
+ */
+export type StripeKYCRegion = 'us' | 'eu';
+
+/**
+ * A KYC tier with its verification status.
+ */
+export interface StripeKYCTier {
+  tier: string;
+
+  verification_status: string;
+
+  verification_errors?: Array<string>;
+}
+
 /**
  * Checkout confirmation with client secret.
  */
@@ -558,13 +581,6 @@ export interface StripePaymentToken {
   type: string;
 }
 
-/**
- * A refreshed quote.
- */
-export interface StripeQuote {
-  expires_at: number;
-}
-
 /**
  * Transaction details from checkout.
  */
@@ -592,7 +608,6 @@ export declare namespace Onramps {
     type CreateOrUpdateFiatCustomerRequestInput as CreateOrUpdateFiatCustomerRequestInput,
     type CreateStripeOnrampSessionInput as CreateStripeOnrampSessionInput,
     type CreateStripeOnrampSessionResponse as CreateStripeOnrampSessionResponse,
-    type CryptoCurrencyCode as CryptoCurrencyCode,
     type ExchangeStripeTokensInput as ExchangeStripeTokensInput,
     type ExchangeStripeTokensResponse as ExchangeStripeTokensResponse,
     type FiatAmount as FiatAmount,
@@ -619,7 +634,6 @@ export declare namespace Onramps {
     type LinkAuthIntentNoAccount as LinkAuthIntentNoAccount,
     type ListStripeConsumerWalletsResponse as ListStripeConsumerWalletsResponse,
     type ListStripePaymentTokensResponse as ListStripePaymentTokensResponse,
-    type OnrampSessionFees as OnrampSessionFees,
     type OnrampSessionParams as OnrampSessionParams,
     type OnrampSessionTransactionDetails as OnrampSessionTransactionDetails,
     type RefreshStripeQuoteResponse as RefreshStripeQuoteResponse,
@@ -627,10 +641,11 @@ export declare namespace Onramps {
     type StripeCryptoCustomerActive as StripeCryptoCustomerActive,
     type StripeCryptoCustomerExpired as StripeCryptoCustomerExpired,
     type StripeCryptoCustomerNone as StripeCryptoCustomerNone,
+    type StripeKYCRegion as StripeKYCRegion,
+    type StripeKYCTier as StripeKYCTier,
     type StripeOnrampCheckoutResponse as StripeOnrampCheckoutResponse,
     type StripeOnrampSessionStatus as StripeOnrampSessionStatus,
     type StripePaymentToken as StripePaymentToken,
-    type StripeQuote as StripeQuote,
     type StripeTransactionDetails as StripeTransactionDetails,
     type StripeVerification as StripeVerification,
   };

package/src/resources/policies.ts

@@ -87,7 +87,17 @@ export interface AggregationCondition {
 /**
  * Operator to use for policy conditions.
  */
-export type ConditionOperator = 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+export type ConditionOperator =
+  | 'eq'
+  | 'gt'
+  | 'gte'
+  | 'lt'
+  | 'lte'
+  | 'in'
+  | 'in_condition_set'
+  | 'contains'
+  | 'starts_with'
+  | 'ends_with';
 
 /**
  * A condition set for grouping related condition values.
@@ -112,7 +122,7 @@ export interface ConditionSet {
   /**
    * A unique identifier for a key quorum.
    */
-  owner_id: SharedAPI.KeyQuorumID;
+  owner_id: SharedAPI.KeyQuorumID | null;
 }
 
 /**
@@ -205,8 +215,8 @@ export interface ConditionSetItemsResponse {
 }
 
 /**
- * Request body for creating a condition set. Exactly one of `owner` or `owner_id`
- * is required.
+ * Request body for creating a condition set. Optionally provide `owner` or
+ * `owner_id` (but not both) to specify ownership.
  */
 export interface ConditionSetRequestBody {
   /**
@@ -292,7 +302,10 @@ export interface EthereumCalldataCondition {
  * eth_sendTransaction request.
  */
 export interface EthereumTransactionCondition {
-  field: 'to' | 'value' | 'chain_id';
+  /**
+   * Ethereum transaction-level fields that can be referenced in a policy condition.
+   */
+  field: EthereumTransactionConditionField;
 
   field_source: 'ethereum_transaction';
 
@@ -308,11 +321,19 @@ export interface EthereumTransactionCondition {
   value: ConditionValue;
 }
 
+/**
+ * Ethereum transaction-level fields that can be referenced in a policy condition.
+ */
+export type EthereumTransactionConditionField = 'to' | 'value' | 'chain_id';
+
 /**
  * Attributes from the signing domain that will verify the signature.
  */
 export interface EthereumTypedDataDomainCondition {
-  field: 'chainId' | 'verifyingContract' | 'chain_id' | 'verifying_contract';
+  /**
+   * Supported fields for Ethereum typed data domain conditions.
+   */
+  field: EthereumTypedDataDomainConditionField;
 
   field_source: 'ethereum_typed_data_domain';
 
@@ -328,6 +349,15 @@ export interface EthereumTypedDataDomainCondition {
   value: ConditionValue;
 }
 
+/**
+ * Supported fields for Ethereum typed data domain conditions.
+ */
+export type EthereumTypedDataDomainConditionField =
+  | 'chainId'
+  | 'verifyingContract'
+  | 'chain_id'
+  | 'verifying_contract';
+
 /**
  * 'types' and 'primary_type' attributes of the TypedData JSON object defined in
  * EIP-712.
@@ -342,7 +372,11 @@ export interface EthereumTypedDataMessageCondition {
    */
   operator: ConditionOperator;
 
-  typed_data: EthereumTypedDataMessageCondition.TypedData;
+  /**
+   * The typed data structure containing EIP-712 types and the primary type for typed
+   * data message policy conditions.
+   */
+  typed_data: TypedDataInput;
 
   /**
    * Value to compare against in a policy condition. Can be a single string or an
@@ -351,17 +385,34 @@ export interface EthereumTypedDataMessageCondition {
   value: ConditionValue;
 }
 
-export namespace EthereumTypedDataMessageCondition {
-  export interface TypedData {
-    primary_type: string;
+/**
+ * Condition on the message being signed (e.g. in personal_sign).
+ */
+export interface MessageSigningCondition {
+  /**
+   * Supported fields for message signing conditions.
+   */
+  field: MessageSigningField;
 
-    /**
-     * The type definitions for EIP-712 typed data signing.
-     */
-    types: WalletsAPI.TypedDataTypesInputParams;
-  }
+  field_source: 'message';
+
+  /**
+   * Operator to use for policy conditions.
+   */
+  operator: ConditionOperator;
+
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
 }
 
+/**
+ * Supported fields for message signing conditions.
+ */
+export type MessageSigningField = 'content' | 'byte_length';
+
 /**
  * A policy for controlling wallet operations.
  */
@@ -388,9 +439,9 @@ export interface Policy {
   name: string;
 
   /**
-   * The key quorum ID of the owner of the policy.
+   * A unique identifier for a key quorum.
    */
-  owner_id: string | null;
+  owner_id: SharedAPI.KeyQuorumID | null;
 
   rules: Array<PolicyRuleResponse>;
 
@@ -446,7 +497,8 @@ export type PolicyCondition =
   | SuiTransactionCommandCondition
   | SuiTransferObjectsCommandCondition
   | ActionRequestBodyCondition
-  | AggregationCondition;
+  | AggregationCondition
+  | MessageSigningCondition;
 
 /**
  * Method the rule applies to.
@@ -461,9 +513,13 @@ export type PolicyMethod =
   | 'wallet_sendCalls'
   | 'signTransaction'
   | 'signAndSendTransaction'
+  | 'signMessage'
   | 'exportPrivateKey'
   | 'exportSeedPhrase'
   | 'signTransactionBytes'
+  | 'signRawMessageBytes'
+  | 'tron_sendTransaction'
+  | 'tron_signTransaction'
   | 'earn_deposit'
   | 'earn_withdraw'
   | 'transfer'
@@ -551,7 +607,11 @@ export interface SolanaProgramInstructionCondition {
  * fields.
  */
 export interface SolanaSystemProgramInstructionCondition {
-  field: 'instructionName' | 'Transfer.from' | 'Transfer.to' | 'Transfer.lamports';
+  /**
+   * Supported fields for Solana System Program conditions including Transfer
+   * instruction fields.
+   */
+  field: SolanaSystemProgramInstructionConditionField;
 
   field_source: 'solana_system_program_instruction';
 
@@ -567,36 +627,27 @@ export interface SolanaSystemProgramInstructionCondition {
   value: ConditionValue;
 }
 
+/**
+ * Supported fields for Solana System Program conditions including Transfer
+ * instruction fields.
+ */
+export type SolanaSystemProgramInstructionConditionField =
+  | 'instructionName'
+  | 'Transfer.from'
+  | 'Transfer.to'
+  | 'Transfer.lamports';
+
 /**
  * Solana Token Program attributes, including more granular TransferChecked
  * instruction fields.
  */
 export interface SolanaTokenProgramInstructionCondition {
-  field:
-    | 'instructionName'
-    | 'Transfer.source'
-    | 'Transfer.destination'
-    | 'Transfer.authority'
-    | 'Transfer.amount'
-    | 'TransferChecked.source'
-    | 'TransferChecked.destination'
-    | 'TransferChecked.authority'
-    | 'TransferChecked.amount'
-    | 'TransferChecked.mint'
-    | 'Burn.account'
-    | 'Burn.mint'
-    | 'Burn.authority'
-    | 'Burn.amount'
-    | 'MintTo.mint'
-    | 'MintTo.account'
-    | 'MintTo.authority'
-    | 'MintTo.amount'
-    | 'CloseAccount.account'
-    | 'CloseAccount.destination'
-    | 'CloseAccount.authority'
-    | 'InitializeAccount3.account'
-    | 'InitializeAccount3.mint'
-    | 'InitializeAccount3.owner';
+  /**
+   * Supported fields for Solana Token Program conditions including Transfer,
+   * TransferChecked, Burn, MintTo, CloseAccount, and InitializeAccount3 instruction
+   * fields.
+   */
+  field: SolanaTokenProgramInstructionConditionField;
 
   field_source: 'solana_token_program_instruction';
 
@@ -612,6 +663,37 @@ export interface SolanaTokenProgramInstructionCondition {
   value: ConditionValue;
 }
 
+/**
+ * Supported fields for Solana Token Program conditions including Transfer,
+ * TransferChecked, Burn, MintTo, CloseAccount, and InitializeAccount3 instruction
+ * fields.
+ */
+export type SolanaTokenProgramInstructionConditionField =
+  | 'instructionName'
+  | 'Transfer.source'
+  | 'Transfer.destination'
+  | 'Transfer.authority'
+  | 'Transfer.amount'
+  | 'TransferChecked.source'
+  | 'TransferChecked.destination'
+  | 'TransferChecked.authority'
+  | 'TransferChecked.amount'
+  | 'TransferChecked.mint'
+  | 'Burn.account'
+  | 'Burn.mint'
+  | 'Burn.authority'
+  | 'Burn.amount'
+  | 'MintTo.mint'
+  | 'MintTo.account'
+  | 'MintTo.authority'
+  | 'MintTo.amount'
+  | 'CloseAccount.account'
+  | 'CloseAccount.destination'
+  | 'CloseAccount.authority'
+  | 'InitializeAccount3.account'
+  | 'InitializeAccount3.mint'
+  | 'InitializeAccount3.owner';
+
 /**
  * SUI transaction command attributes, enables allowlisting specific command types.
  * Allowed commands: 'TransferObjects', 'SplitCoins', 'MergeCoins'. Only 'eq' and
@@ -758,15 +840,10 @@ export interface TronCalldataCondition {
  */
 export interface TronTransactionCondition {
   /**
-   * Supported TRON transaction fields in format "TransactionType.field_name"
+   * Supported TRON transaction fields for TransferContract and TriggerSmartContract
+   * in format "TransactionType.field_name".
    */
-  field:
-    | 'TransferContract.to_address'
-    | 'TransferContract.amount'
-    | 'TriggerSmartContract.contract_address'
-    | 'TriggerSmartContract.call_value'
-    | 'TriggerSmartContract.token_id'
-    | 'TriggerSmartContract.call_token_value';
+  field: TronTransactionConditionField;
 
   field_source: 'tron_transaction';
 
@@ -782,6 +859,31 @@ export interface TronTransactionCondition {
   value: ConditionValue;
 }
 
+/**
+ * Supported TRON transaction fields for TransferContract and TriggerSmartContract
+ * in format "TransactionType.field_name".
+ */
+export type TronTransactionConditionField =
+  | 'TransferContract.to_address'
+  | 'TransferContract.amount'
+  | 'TriggerSmartContract.contract_address'
+  | 'TriggerSmartContract.call_value'
+  | 'TriggerSmartContract.token_id'
+  | 'TriggerSmartContract.call_token_value';
+
+/**
+ * The typed data structure containing EIP-712 types and the primary type for typed
+ * data message policy conditions.
+ */
+export interface TypedDataInput {
+  primary_type: string;
+
+  /**
+   * The type definitions for EIP-712 typed data signing.
+   */
+  types: WalletsAPI.TypedDataTypesInputParams;
+}
+
 /**
  * Request body for updating a condition set. At least one field must be provided.
  * `owner` and `owner_id` are mutually exclusive.
@@ -826,8 +928,12 @@ export declare namespace Policies {
     type Ethereum7702AuthorizationCondition as Ethereum7702AuthorizationCondition,
     type EthereumCalldataCondition as EthereumCalldataCondition,
     type EthereumTransactionCondition as EthereumTransactionCondition,
+    type EthereumTransactionConditionField as EthereumTransactionConditionField,
     type EthereumTypedDataDomainCondition as EthereumTypedDataDomainCondition,
+    type EthereumTypedDataDomainConditionField as EthereumTypedDataDomainConditionField,
     type EthereumTypedDataMessageCondition as EthereumTypedDataMessageCondition,
+    type MessageSigningCondition as MessageSigningCondition,
+    type MessageSigningField as MessageSigningField,
     type Policy as Policy,
     type PolicyAction as PolicyAction,
     type PolicyAuthorizationHeaders as PolicyAuthorizationHeaders,
@@ -839,7 +945,9 @@ export declare namespace Policies {
     type PolicyRuleResponse as PolicyRuleResponse,
     type SolanaProgramInstructionCondition as SolanaProgramInstructionCondition,
     type SolanaSystemProgramInstructionCondition as SolanaSystemProgramInstructionCondition,
+    type SolanaSystemProgramInstructionConditionField as SolanaSystemProgramInstructionConditionField,
     type SolanaTokenProgramInstructionCondition as SolanaTokenProgramInstructionCondition,
+    type SolanaTokenProgramInstructionConditionField as SolanaTokenProgramInstructionConditionField,
     type SuiTransactionCommandCondition as SuiTransactionCommandCondition,
     type SuiTransactionCommandOperator as SuiTransactionCommandOperator,
     type SuiTransferObjectsCommandCondition as SuiTransferObjectsCommandCondition,
@@ -849,6 +957,8 @@ export declare namespace Policies {
     type TempoTransactionConditionField as TempoTransactionConditionField,
     type TronCalldataCondition as TronCalldataCondition,
     type TronTransactionCondition as TronTransactionCondition,
+    type TronTransactionConditionField as TronTransactionConditionField,
+    type TypedDataInput as TypedDataInput,
     type UpdateConditionSetRequestBody as UpdateConditionSetRequestBody,
   };
 }

package/src/resources/shared.ts

@@ -35,8 +35,9 @@ export type EvmAddress = string;
 export type EvmChecksumAddress = string;
 
 /**
- * Hyperliquid L1 spot token identifier: 0x followed by 32–40 hex characters,
- * normalized to lowercase.
+ * Hyperliquid L1 token identifier: 0x followed by either 32 hex characters
+ * (16-byte spot/perps token IDs) or 40 hex characters (20-byte HIP-3 DEX token
+ * IDs), normalized to lowercase.
  */
 export type HyperliquidTokenAddress = string;
 
@@ -91,11 +92,24 @@ export interface SuccessResponse {
   success: boolean;
 }
 
+/**
+ * Token identifier string. EVM-shaped 40-hex token addresses normalize to checksum
+ * case, 16-byte Hyperliquid token IDs normalize to lowercase, and all other
+ * identifiers pass through unchanged.
+ */
+export type TokenIdentifier = string;
+
 /**
  * Tron address: base58check-encoded, starting with T, 34 characters.
  */
 export type TronAddress = string;
 
+/**
+ * Tron address in hex format: 41-prefixed, 42 hex characters (21 bytes), no 0x
+ * prefix.
+ */
+export type TronHexAddress = string;
+
 export declare namespace Shared {
   export {
     type BitcoinAddress as BitcoinAddress,
@@ -111,6 +125,8 @@ export declare namespace Shared {
     type P256PublicKey as P256PublicKey,
     type SolanaAddress as SolanaAddress,
     type SuccessResponse as SuccessResponse,
+    type TokenIdentifier as TokenIdentifier,
     type TronAddress as TronAddress,
+    type TronHexAddress as TronHexAddress,
   };
 }

package/src/resources/swaps.ts

@@ -128,7 +128,8 @@ export interface SwapQuoteResponse {
   output_token: string;
 
   /**
-   * Destination chain CAIP-2 identifier for cross-chain swaps.
+   * Destination chain CAIP-2 identifier for cross-chain swaps. Only present for
+   * cross-chain swaps.
    */
   destination_caip2?: string;
 
@@ -144,7 +145,7 @@ export interface SwapQuoteResponse {
   estimated_gas?: WalletsAPI.Gas;
 
   /**
-   * Quote expiry as Unix timestamp (seconds). Present for cross-chain quotes.
+   * Quote expiry as Unix timestamp (seconds). Only present for cross-chain quotes.
    */
   expires_at?: number;
 }