privy_ruby 0.2.0 → 0.4.0

data/lib/privy/models/spark_withdraw_rpc_input.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class SparkWithdrawRpcInput < Privy::Internal::Type::BaseModel
+      # @!attribute method_
+      #
+      #   @return [Symbol, Privy::Models::SparkWithdrawRpcInput::Method]
+      required :method_, enum: -> { Privy::SparkWithdrawRpcInput::Method }, api_name: :method
+
+      # @!attribute params
+      #   Parameters for the Spark `withdraw` RPC.
+      #
+      #   @return [Privy::Models::SparkWithdrawRpcInputParams]
+      required :params, -> { Privy::SparkWithdrawRpcInputParams }
+
+      # @!attribute network
+      #   The Spark network.
+      #
+      #   @return [Symbol, Privy::Models::SparkNetwork, nil]
+      optional :network, enum: -> { Privy::SparkNetwork }
+
+      # @!method initialize(method_:, params:, network: nil)
+      #   Withdraws from Spark to a Bitcoin L1 address (cooperative exit).
+      #
+      #   @param method_ [Symbol, Privy::Models::SparkWithdrawRpcInput::Method]
+      #
+      #   @param params [Privy::Models::SparkWithdrawRpcInputParams] Parameters for the Spark `withdraw` RPC.
+      #
+      #   @param network [Symbol, Privy::Models::SparkNetwork] The Spark network.
+
+      # @see Privy::Models::SparkWithdrawRpcInput#method_
+      module Method
+        extend Privy::Internal::Type::Enum
+
+        WITHDRAW = :withdraw
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/spark_withdraw_rpc_input_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class SparkWithdrawRpcInputParams < Privy::Internal::Type::BaseModel
+      # @!attribute exit_speed
+      #   The exit speed for a cooperative withdrawal from Spark to L1.
+      #
+      #   @return [Symbol, Privy::Models::SparkExitSpeed]
+      required :exit_speed, enum: -> { Privy::SparkExitSpeed }
+
+      # @!attribute onchain_address
+      #
+      #   @return [String]
+      required :onchain_address, String
+
+      # @!attribute amount_sats
+      #
+      #   @return [Float, nil]
+      optional :amount_sats, Float
+
+      # @!attribute deduct_fee_from_withdrawal_amount
+      #
+      #   @return [Boolean, nil]
+      optional :deduct_fee_from_withdrawal_amount, Privy::Internal::Type::Boolean
+
+      # @!attribute fee_amount_sats
+      #
+      #   @return [Float, nil]
+      optional :fee_amount_sats, Float
+
+      # @!attribute fee_quote_id
+      #
+      #   @return [String, nil]
+      optional :fee_quote_id, String
+
+      # @!method initialize(exit_speed:, onchain_address:, amount_sats: nil, deduct_fee_from_withdrawal_amount: nil, fee_amount_sats: nil, fee_quote_id: nil)
+      #   Parameters for the Spark `withdraw` RPC.
+      #
+      #   @param exit_speed [Symbol, Privy::Models::SparkExitSpeed] The exit speed for a cooperative withdrawal from Spark to L1.
+      #
+      #   @param onchain_address [String]
+      #
+      #   @param amount_sats [Float]
+      #
+      #   @param deduct_fee_from_withdrawal_amount [Boolean]
+      #
+      #   @param fee_amount_sats [Float]
+      #
+      #   @param fee_quote_id [String]
+    end
+  end
+end

data/lib/privy/models/spark_withdraw_rpc_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class SparkWithdrawRpcResponse < Privy::Internal::Type::BaseModel
+      # @!attribute method_
+      #
+      #   @return [Symbol, Privy::Models::SparkWithdrawRpcResponse::Method]
+      required :method_, enum: -> { Privy::SparkWithdrawRpcResponse::Method }, api_name: :method
+
+      # @!attribute data
+      #   A cooperative exit request from Spark to Bitcoin L1.
+      #
+      #   @return [Privy::Models::SparkCoopExitRequest, nil]
+      optional :data, -> { Privy::SparkCoopExitRequest }
+
+      # @!method initialize(method_:, data: nil)
+      #   Response to the Spark `withdraw` RPC.
+      #
+      #   @param method_ [Symbol, Privy::Models::SparkWithdrawRpcResponse::Method]
+      #
+      #   @param data [Privy::Models::SparkCoopExitRequest] A cooperative exit request from Spark to Bitcoin L1.
+
+      # @see Privy::Models::SparkWithdrawRpcResponse#method_
+      module Method
+        extend Privy::Internal::Type::Enum
+
+        WITHDRAW = :withdraw
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/stripe_crypto_customer_active.rb

@@ -8,6 +8,22 @@ module Privy
       #   @return [String]
       required :crypto_customer_id, String
 
+      # @!attribute kyc_region
+      #   Region derived from a Stripe user's country of residence.
+      #
+      #   @return [Symbol, Privy::Models::StripeKYCRegion, nil]
+      required :kyc_region, enum: -> { Privy::StripeKYCRegion }, nil?: true
+
+      # @!attribute kyc_tiers
+      #
+      #   @return [Array<Privy::Models::StripeKYCTier>]
+      required :kyc_tiers, -> { Privy::Internal::Type::ArrayOf[Privy::StripeKYCTier] }
+
+      # @!attribute provided_fields
+      #
+      #   @return [Array<String>]
+      required :provided_fields, Privy::Internal::Type::ArrayOf[String]
+
       # @!attribute status
       #
       #   @return [Symbol, Privy::Models::StripeCryptoCustomerActive::Status]
@@ -18,11 +34,19 @@ module Privy
       #   @return [Array<Privy::Models::StripeVerification>]
       required :verifications, -> { Privy::Internal::Type::ArrayOf[Privy::StripeVerification] }
 
-      # @!method initialize(crypto_customer_id:, status:, verifications:)
+      # @!method initialize(crypto_customer_id:, kyc_region:, kyc_tiers:, provided_fields:, status:, verifications:)
       #   Active onramp session with customer verifications.
       #
       #   @param crypto_customer_id [String]
+      #
+      #   @param kyc_region [Symbol, Privy::Models::StripeKYCRegion, nil] Region derived from a Stripe user's country of residence.
+      #
+      #   @param kyc_tiers [Array<Privy::Models::StripeKYCTier>]
+      #
+      #   @param provided_fields [Array<String>]
+      #
       #   @param status [Symbol, Privy::Models::StripeCryptoCustomerActive::Status]
+      #
       #   @param verifications [Array<Privy::Models::StripeVerification>]
 
       # @see Privy::Models::StripeCryptoCustomerActive#status

data/lib/privy/models/stripe_kyc_region.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # Region derived from a Stripe user's country of residence.
+    module StripeKYCRegion
+      extend Privy::Internal::Type::Enum
+
+      US = :us
+      EU = :eu
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/stripe_kyc_tier.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class StripeKYCTier < Privy::Internal::Type::BaseModel
+      # @!attribute tier
+      #
+      #   @return [String]
+      required :tier, String
+
+      # @!attribute verification_status
+      #
+      #   @return [String]
+      required :verification_status, String
+
+      # @!attribute verification_errors
+      #
+      #   @return [Array<String>, nil]
+      optional :verification_errors, Privy::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(tier:, verification_status:, verification_errors: nil)
+      #   A KYC tier with its verification status.
+      #
+      #   @param tier [String]
+      #   @param verification_status [String]
+      #   @param verification_errors [Array<String>]
+    end
+  end
+end

data/lib/privy/models/swap_quote_response.rb

@@ -47,7 +47,8 @@ module Privy
       required :output_token, String
 
       # @!attribute destination_caip2
-      #   Destination chain CAIP-2 identifier for cross-chain swaps.
+      #   Destination chain CAIP-2 identifier for cross-chain swaps. Only present for
+      #   cross-chain swaps.
       #
       #   @return [String, nil]
       optional :destination_caip2, String
@@ -66,7 +67,7 @@ module Privy
       optional :estimated_gas, -> { Privy::Gas }
 
       # @!attribute expires_at
-      #   Quote expiry as Unix timestamp (seconds). Present for cross-chain quotes.
+      #   Quote expiry as Unix timestamp (seconds). Only present for cross-chain quotes.
       #
       #   @return [Float, nil]
       optional :expires_at, Float
@@ -91,13 +92,13 @@ module Privy
       #
       #   @param output_token [String] Token address being bought.
       #
-      #   @param destination_caip2 [String] Destination chain CAIP-2 identifier for cross-chain swaps.
+      #   @param destination_caip2 [String] Destination chain CAIP-2 identifier for cross-chain swaps. Only present for cros
       #
       #   @param estimated_fees [Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>] Estimated fees for the swap. Only present for cross-chain swaps.
       #
       #   @param estimated_gas [Privy::Models::Gas] Gas cost for a blockchain action. Includes both raw base-unit amount and a human
       #
-      #   @param expires_at [Float] Quote expiry as Unix timestamp (seconds). Present for cross-chain quotes.
+      #   @param expires_at [Float] Quote expiry as Unix timestamp (seconds). Only present for cross-chain quotes.
     end
   end
 end

data/lib/privy/models/swap_submission_status.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # "accepted" if the network has acknowledged the transaction, "rejected" if the
+    # network refused it, "skipped" if dry_run was set. Not an onchain confirmation.
+    module SwapSubmissionStatus
+      extend Privy::Internal::Type::Enum
+
+      ACCEPTED = :accepted
+      REJECTED = :rejected
+      SKIPPED = :skipped
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/test_account.rb

@@ -33,7 +33,12 @@ module Privy
       #   @return [String]
       required :updated_at, String
 
-      # @!method initialize(id:, created_at:, email:, otp_code:, phone_number:, updated_at:)
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!method initialize(id:, created_at:, email:, otp_code:, phone_number:, updated_at:, name: nil)
       #   A test account for an app.
       #
       #   @param id [String]
@@ -42,6 +47,7 @@ module Privy
       #   @param otp_code [String]
       #   @param phone_number [String]
       #   @param updated_at [String]
+      #   @param name [String, nil]
     end
   end
 end

data/lib/privy/models/{crypto_currency_code.rb → token_identifier.rb}

@@ -2,6 +2,6 @@
 
 module Privy
   module Models
-    CryptoCurrencyCode = String
+    TokenIdentifier = String
   end
 end

data/lib/privy/models/transaction.rb

@@ -20,9 +20,10 @@ module Privy
       required :created_at, Float
 
       # @!attribute status
+      #   Status of a blockchain transaction submitted by Privy.
       #
-      #   @return [Symbol, Privy::Models::Transaction::Status]
-      required :status, enum: -> { Privy::Transaction::Status }
+      #   @return [Symbol, Privy::Models::BlockchainTransactionStatus]
+      required :status, enum: -> { Privy::BlockchainTransactionStatus }
 
       # @!attribute transaction_hash
       #
@@ -53,31 +54,22 @@ module Privy
       #   A transaction from a Privy wallet.
       #
       #   @param id [String]
+      #
       #   @param caip2 [String]
+      #
       #   @param created_at [Float]
-      #   @param status [Symbol, Privy::Models::Transaction::Status]
+      #
+      #   @param status [Symbol, Privy::Models::BlockchainTransactionStatus] Status of a blockchain transaction submitted by Privy.
+      #
       #   @param transaction_hash [String, nil]
+      #
       #   @param wallet_id [String]
+      #
       #   @param reference_id [String, nil]
+      #
       #   @param sponsored [Boolean]
+      #
       #   @param user_operation_hash [String]
-
-      # @see Privy::Models::Transaction#status
-      module Status
-        extend Privy::Internal::Type::Enum
-
-        BROADCASTED = :broadcasted
-        CONFIRMED = :confirmed
-        EXECUTION_REVERTED = :execution_reverted
-        FAILED = :failed
-        REPLACED = :replaced
-        FINALIZED = :finalized
-        PROVIDER_ERROR = :provider_error
-        PENDING = :pending
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/privy/models/transaction_chain_name_input.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # Chains supported for transaction history queries.
+    module TransactionChainNameInput
+      extend Privy::Internal::Type::Enum
+
+      ETHEREUM = :ethereum
+      ARBITRUM = :arbitrum
+      AVALANCHE = :avalanche
+      BASE = :base
+      BSC = :bsc
+      TEMPO = :tempo
+      LINEA = :linea
+      OPTIMISM = :optimism
+      POLYGON = :polygon
+      SOLANA = :solana
+      SEPOLIA = :sepolia
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/transfer_quote_request_body.rb

@@ -17,6 +17,14 @@ module Privy
       #   @return [Privy::Models::NamedTokenTransferSource, Privy::Models::CustomTokenTransferSource]
       required :source, union: -> { Privy::TokenTransferSource }
 
+      # @!attribute amount
+      #   Amount as a decimal string in the token's standard unit (e.g. "1.5" for 1.5
+      #   USDC). For exact_input, the amount to send. For exact_output, the exact amount
+      #   to receive. Takes precedence over source.amount when both are provided.
+      #
+      #   @return [String, nil]
+      optional :amount, String
+
       # @!attribute amount_type
       #   Whether the amount refers to the input token or output token.
       #
@@ -36,7 +44,7 @@ module Privy
       #   @return [Integer, nil]
       optional :slippage_bps, Integer
 
-      # @!method initialize(destination:, source:, amount_type: nil, fee_configuration: nil, slippage_bps: nil)
+      # @!method initialize(destination:, source:, amount: nil, amount_type: nil, fee_configuration: nil, slippage_bps: nil)
       #   Some parameter documentations has been truncated, see
       #   {Privy::Models::TransferQuoteRequestBody} for more details.
       #
@@ -47,6 +55,8 @@ module Privy
       #
       #   @param source [Privy::Models::NamedTokenTransferSource, Privy::Models::CustomTokenTransferSource] The source asset, amount, and chain for a token transfer. Specify either `asset`
       #
+      #   @param amount [String] Amount as a decimal string in the token's standard unit (e.g. "1.5" for 1.5 USDC
+      #
       #   @param amount_type [Symbol, Privy::Models::AmountType] Whether the amount refers to the input token or output token.
       #
       #   @param fee_configuration [Privy::Models::FeeConfiguration] Total fees assessed on a transfer, in BPS

data/lib/privy/models/transfer_quote_response.rb

@@ -11,19 +11,28 @@ module Privy
       required :destination, -> { Privy::TokenTransferDestination }
 
       # @!attribute estimated_fees
-      #   Estimated fees in USD
+      #   Estimated fees in USD for the transfer. Only present for cross-chain transfers.
       #
       #   @return [Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>]
       required :estimated_fees, -> { Privy::Internal::Type::ArrayOf[union: Privy::FeeLineItem] }
 
+      # @!attribute estimated_input_amount
+      #   Estimated input amount in decimals. For exact_input, this equals source.amount.
+      #   For exact_output, this is the estimated amount the sender needs to provide.
+      #
+      #   @return [String]
+      required :estimated_input_amount, String
+
       # @!attribute estimated_output_amount
-      #   Estimated output amount in decimals
+      #   Estimated output amount in decimals. For exact_input, this is an estimate
+      #   subject to slippage. For exact_output, this is the guaranteed exact amount to be
+      #   received.
       #
       #   @return [String]
       required :estimated_output_amount, String
 
       # @!attribute expires_at
-      #   Quote expiry as unix timestamp (seconds)
+      #   Quote expiry as Unix timestamp (seconds).
       #
       #   @return [Float]
       required :expires_at, Float
@@ -48,7 +57,7 @@ module Privy
       #   @return [Privy::Models::Gas, nil]
       optional :estimated_gas, -> { Privy::Gas }
 
-      # @!method initialize(destination:, estimated_fees:, estimated_output_amount:, expires_at:, source:, amount_type: nil, estimated_gas: nil)
+      # @!method initialize(destination:, estimated_fees:, estimated_input_amount:, estimated_output_amount:, expires_at:, source:, amount_type: nil, estimated_gas: nil)
       #   Some parameter documentations has been truncated, see
       #   {Privy::Models::TransferQuoteResponse} for more details.
       #
@@ -56,11 +65,13 @@ module Privy
       #
       #   @param destination [Privy::Models::TokenTransferDestination] The destination address for a token transfer. Optionally specify a different ass
       #
-      #   @param estimated_fees [Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>] Estimated fees in USD
+      #   @param estimated_fees [Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>] Estimated fees in USD for the transfer. Only present for cross-chain transfers.
+      #
+      #   @param estimated_input_amount [String] Estimated input amount in decimals. For exact_input, this equals source.amount.
       #
-      #   @param estimated_output_amount [String] Estimated output amount in decimals
+      #   @param estimated_output_amount [String] Estimated output amount in decimals. For exact_input, this is an estimate subjec
       #
-      #   @param expires_at [Float] Quote expiry as unix timestamp (seconds)
+      #   @param expires_at [Float] Quote expiry as Unix timestamp (seconds).
       #
       #   @param source [Privy::Models::NamedTokenTransferSource, Privy::Models::CustomTokenTransferSource] The source asset, amount, and chain for a token transfer. Specify either `asset`
       #

data/lib/privy/models/transfer_received_transaction_detail.rb

@@ -9,9 +9,10 @@ module Privy
       required :asset, union: -> { Privy::TransferReceivedTransactionDetail::Asset }
 
       # @!attribute chain
+      #   Supported blockchain network names for wallet balance and transaction queries.
       #
-      #   @return [Symbol, Privy::Models::TransferReceivedTransactionDetail::Chain]
-      required :chain, enum: -> { Privy::TransferReceivedTransactionDetail::Chain }
+      #   @return [Symbol, Privy::Models::WalletAssetChainNameInput]
+      required :chain, enum: -> { Privy::WalletAssetChainNameInput }
 
       # @!attribute display_values
       #
@@ -57,14 +58,23 @@ module Privy
       #   Details for a received transfer transaction.
       #
       #   @param asset [Symbol, String, Privy::Models::TransferReceivedTransactionDetail::Asset]
-      #   @param chain [Symbol, Privy::Models::TransferReceivedTransactionDetail::Chain]
+      #
+      #   @param chain [Symbol, Privy::Models::WalletAssetChainNameInput] Supported blockchain network names for wallet balance and transaction queries.
+      #
       #   @param display_values [Hash{Symbol=>String}]
+      #
       #   @param raw_value [String]
+      #
       #   @param raw_value_decimals [Float]
+      #
       #   @param recipient [String]
+      #
       #   @param recipient_privy_user_id [String, nil]
+      #
       #   @param sender [String]
+      #
       #   @param sender_privy_user_id [String, nil]
+      #
       #   @param type [Symbol, Privy::Models::TransferReceivedTransactionDetail::Type]
 
       # @see Privy::Models::TransferReceivedTransactionDetail#asset
@@ -81,6 +91,8 @@ module Privy
 
         variant const: -> { Privy::Models::TransferReceivedTransactionDetail::Asset::POL }
 
+        variant const: -> { Privy::Models::TransferReceivedTransactionDetail::Asset::BNB }
+
         variant const: -> { Privy::Models::TransferReceivedTransactionDetail::Asset::USDT }
 
         variant const: -> { Privy::Models::TransferReceivedTransactionDetail::Asset::EURC }
@@ -89,6 +101,8 @@ module Privy
 
         variant const: -> { Privy::Models::TransferReceivedTransactionDetail::Asset::SOL }
 
+        variant const: -> { Privy::Models::TransferReceivedTransactionDetail::Asset::TRX }
+
         variant String
 
         # @!method self.variants
@@ -105,42 +119,16 @@ module Privy
         ETH = :eth
         AVAX = :avax
         POL = :pol
+        BNB = :bnb
         USDT = :usdt
         EURC = :eurc
         USDB = :usdb
         SOL = :sol
+        TRX = :trx
 
         # @!endgroup
       end
 
-      # @see Privy::Models::TransferReceivedTransactionDetail#chain
-      module Chain
-        extend Privy::Internal::Type::Enum
-
-        ETHEREUM = :ethereum
-        ARBITRUM = :arbitrum
-        AVALANCHE = :avalanche
-        BASE = :base
-        TEMPO = :tempo
-        LINEA = :linea
-        OPTIMISM = :optimism
-        POLYGON = :polygon
-        SOLANA = :solana
-        ZKSYNC_ERA = :zksync_era
-        SEPOLIA = :sepolia
-        ARBITRUM_SEPOLIA = :arbitrum_sepolia
-        AVALANCHE_FUJI = :avalanche_fuji
-        BASE_SEPOLIA = :base_sepolia
-        LINEA_TESTNET = :linea_testnet
-        OPTIMISM_SEPOLIA = :optimism_sepolia
-        POLYGON_AMOY = :polygon_amoy
-        SOLANA_DEVNET = :solana_devnet
-        SOLANA_TESTNET = :solana_testnet
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
       # @see Privy::Models::TransferReceivedTransactionDetail#type
       module Type
         extend Privy::Internal::Type::Enum

data/lib/privy/models/transfer_request_body.rb

@@ -17,6 +17,14 @@ module Privy
       #   @return [Privy::Models::NamedTokenTransferSource, Privy::Models::CustomTokenTransferSource]
       required :source, union: -> { Privy::TokenTransferSource }
 
+      # @!attribute amount
+      #   Amount as a decimal string in the token's standard unit (e.g. "1.5" for 1.5
+      #   USDC). For exact_input, the amount to send. For exact_output, the exact amount
+      #   to receive. Takes precedence over source.amount when both are provided.
+      #
+      #   @return [String, nil]
+      optional :amount, String
+
       # @!attribute amount_type
       #   Whether the amount refers to the input token or output token.
       #
@@ -36,7 +44,7 @@ module Privy
       #   @return [Integer, nil]
       optional :slippage_bps, Integer
 
-      # @!method initialize(destination:, source:, amount_type: nil, fee_configuration: nil, slippage_bps: nil)
+      # @!method initialize(destination:, source:, amount: nil, amount_type: nil, fee_configuration: nil, slippage_bps: nil)
       #   Some parameter documentations has been truncated, see
       #   {Privy::Models::TransferRequestBody} for more details.
       #
@@ -46,6 +54,8 @@ module Privy
       #
       #   @param source [Privy::Models::NamedTokenTransferSource, Privy::Models::CustomTokenTransferSource] The source asset, amount, and chain for a token transfer. Specify either `asset`
       #
+      #   @param amount [String] Amount as a decimal string in the token's standard unit (e.g. "1.5" for 1.5 USDC
+      #
       #   @param amount_type [Symbol, Privy::Models::AmountType] Whether the amount refers to the input token or output token.
       #
       #   @param fee_configuration [Privy::Models::FeeConfiguration] Total fees assessed on a transfer, in BPS