privy_ruby 0.3.0 → 0.5.0

data/rbi/privy/models/spark_withdraw_rpc_response.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Privy
+  module Models
+    class SparkWithdrawRpcResponse < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Privy::SparkWithdrawRpcResponse, Privy::Internal::AnyHash)
+        end
+
+      sig { returns(Privy::SparkWithdrawRpcResponse::Method::TaggedSymbol) }
+      attr_accessor :method_
+
+      # A cooperative exit request from Spark to Bitcoin L1.
+      sig { returns(T.nilable(Privy::SparkCoopExitRequest)) }
+      attr_reader :data
+
+      sig { params(data: Privy::SparkCoopExitRequest::OrHash).void }
+      attr_writer :data
+
+      # Response to the Spark `withdraw` RPC.
+      sig do
+        params(
+          method_: Privy::SparkWithdrawRpcResponse::Method::OrSymbol,
+          data: Privy::SparkCoopExitRequest::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        method_:,
+        # A cooperative exit request from Spark to Bitcoin L1.
+        data: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            method_: Privy::SparkWithdrawRpcResponse::Method::TaggedSymbol,
+            data: Privy::SparkCoopExitRequest
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Method
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Privy::SparkWithdrawRpcResponse::Method)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WITHDRAW =
+          T.let(
+            :withdraw,
+            Privy::SparkWithdrawRpcResponse::Method::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Privy::SparkWithdrawRpcResponse::Method::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/transaction_chain_name_input.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Privy
+  module Models
+    # Chains supported for transaction history queries.
+    module TransactionChainNameInput
+      extend Privy::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Privy::TransactionChainNameInput) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      ETHEREUM =
+        T.let(:ethereum, Privy::TransactionChainNameInput::TaggedSymbol)
+      ARBITRUM =
+        T.let(:arbitrum, Privy::TransactionChainNameInput::TaggedSymbol)
+      AVALANCHE =
+        T.let(:avalanche, Privy::TransactionChainNameInput::TaggedSymbol)
+      BASE = T.let(:base, Privy::TransactionChainNameInput::TaggedSymbol)
+      BSC = T.let(:bsc, Privy::TransactionChainNameInput::TaggedSymbol)
+      TEMPO = T.let(:tempo, Privy::TransactionChainNameInput::TaggedSymbol)
+      LINEA = T.let(:linea, Privy::TransactionChainNameInput::TaggedSymbol)
+      OPTIMISM =
+        T.let(:optimism, Privy::TransactionChainNameInput::TaggedSymbol)
+      POLYGON = T.let(:polygon, Privy::TransactionChainNameInput::TaggedSymbol)
+      SOLANA = T.let(:solana, Privy::TransactionChainNameInput::TaggedSymbol)
+      SEPOLIA = T.let(:sepolia, Privy::TransactionChainNameInput::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Privy::TransactionChainNameInput::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/privy/models/transfer_received_transaction_detail.rbi

@@ -147,6 +147,11 @@ module Privy
             :pol,
             Privy::TransferReceivedTransactionDetail::Asset::TaggedSymbol
           )
+        BNB =
+          T.let(
+            :bnb,
+            Privy::TransferReceivedTransactionDetail::Asset::TaggedSymbol
+          )
         USDT =
           T.let(
             :usdt,
@@ -167,6 +172,11 @@ module Privy
             :sol,
             Privy::TransferReceivedTransactionDetail::Asset::TaggedSymbol
           )
+        TRX =
+          T.let(
+            :trx,
+            Privy::TransferReceivedTransactionDetail::Asset::TaggedSymbol
+          )
       end
 
       module Type

data/rbi/privy/models/transfer_sent_transaction_detail.rbi

@@ -136,6 +136,8 @@ module Privy
           )
         POL =
           T.let(:pol, Privy::TransferSentTransactionDetail::Asset::TaggedSymbol)
+        BNB =
+          T.let(:bnb, Privy::TransferSentTransactionDetail::Asset::TaggedSymbol)
         USDT =
           T.let(
             :usdt,
@@ -153,6 +155,8 @@ module Privy
           )
         SOL =
           T.let(:sol, Privy::TransferSentTransactionDetail::Asset::TaggedSymbol)
+        TRX =
+          T.let(:trx, Privy::TransferSentTransactionDetail::Asset::TaggedSymbol)
       end
 
       module Type

data/rbi/privy/models/unsafe_unwrap_webhook_event.rbi

@@ -42,6 +42,10 @@ module Privy
             Privy::WalletActionEarnDepositFailedWebhookPayload,
             Privy::WalletActionEarnDepositRejectedWebhookPayload,
             Privy::WalletActionEarnDepositSucceededWebhookPayload,
+            Privy::WalletActionEarnFeeCollectCreatedWebhookPayload,
+            Privy::WalletActionEarnFeeCollectFailedWebhookPayload,
+            Privy::WalletActionEarnFeeCollectRejectedWebhookPayload,
+            Privy::WalletActionEarnFeeCollectSucceededWebhookPayload,
             Privy::WalletActionEarnIncentiveClaimCreatedWebhookPayload,
             Privy::WalletActionEarnIncentiveClaimFailedWebhookPayload,
             Privy::WalletActionEarnIncentiveClaimRejectedWebhookPayload,

data/rbi/privy/models/wallet_action_earn_fee_collect_created_webhook_payload.rbi

@@ -0,0 +1,232 @@
+# typed: strong
+
+module Privy
+  module Models
+    class WalletActionEarnFeeCollectCreatedWebhookPayload < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::WalletActionEarnFeeCollectCreatedWebhookPayload,
+            Privy::Internal::AnyHash
+          )
+        end
+
+      # Type of wallet action
+      sig { returns(Privy::Wallets::WalletActionType::TaggedSymbol) }
+      attr_accessor :action_type
+
+      # Underlying asset token address.
+      sig { returns(String) }
+      attr_accessor :asset_address
+
+      # CAIP-2 chain identifier.
+      sig { returns(String) }
+      attr_accessor :caip2
+
+      # ISO 8601 timestamp of when the wallet action was created.
+      sig { returns(String) }
+      attr_accessor :created_at
+
+      # Base-unit amount of fees collected (e.g. "1500000").
+      sig { returns(String) }
+      attr_accessor :raw_amount
+
+      # The status of the wallet action.
+      sig do
+        returns(
+          Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # The type of webhook event.
+      sig do
+        returns(
+          Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      # ERC-4626 vault contract address.
+      sig { returns(String) }
+      attr_accessor :vault_address
+
+      # The vault ID.
+      sig { returns(String) }
+      attr_accessor :vault_id
+
+      # The ID of the wallet action.
+      sig { returns(String) }
+      attr_accessor :wallet_action_id
+
+      # The ID of the wallet involved in the action.
+      sig { returns(String) }
+      attr_accessor :wallet_id
+
+      # Human-readable decimal amount of fees collected (e.g. "1.5"). Only present when
+      # the token is known in the asset registry.
+      sig { returns(T.nilable(String)) }
+      attr_reader :amount
+
+      sig { params(amount: String).void }
+      attr_writer :amount
+
+      # Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
+      # the asset registry.
+      sig { returns(T.nilable(String)) }
+      attr_reader :asset
+
+      sig { params(asset: String).void }
+      attr_writer :asset
+
+      # Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
+      # present when the token is known in the asset registry.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :decimals
+
+      sig { params(decimals: Integer).void }
+      attr_writer :decimals
+
+      # Payload for the wallet_action.earn_fee_collect.created webhook event.
+      sig do
+        params(
+          action_type: Privy::Wallets::WalletActionType::OrSymbol,
+          asset_address: String,
+          caip2: String,
+          created_at: String,
+          raw_amount: String,
+          status:
+            Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Status::OrSymbol,
+          type:
+            Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Type::OrSymbol,
+          vault_address: String,
+          vault_id: String,
+          wallet_action_id: String,
+          wallet_id: String,
+          amount: String,
+          asset: String,
+          decimals: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Type of wallet action
+        action_type:,
+        # Underlying asset token address.
+        asset_address:,
+        # CAIP-2 chain identifier.
+        caip2:,
+        # ISO 8601 timestamp of when the wallet action was created.
+        created_at:,
+        # Base-unit amount of fees collected (e.g. "1500000").
+        raw_amount:,
+        # The status of the wallet action.
+        status:,
+        # The type of webhook event.
+        type:,
+        # ERC-4626 vault contract address.
+        vault_address:,
+        # The vault ID.
+        vault_id:,
+        # The ID of the wallet action.
+        wallet_action_id:,
+        # The ID of the wallet involved in the action.
+        wallet_id:,
+        # Human-readable decimal amount of fees collected (e.g. "1.5"). Only present when
+        # the token is known in the asset registry.
+        amount: nil,
+        # Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
+        # the asset registry.
+        asset: nil,
+        # Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
+        # present when the token is known in the asset registry.
+        decimals: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            action_type: Privy::Wallets::WalletActionType::TaggedSymbol,
+            asset_address: String,
+            caip2: String,
+            created_at: String,
+            raw_amount: String,
+            status:
+              Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Status::TaggedSymbol,
+            type:
+              Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Type::TaggedSymbol,
+            vault_address: String,
+            vault_id: String,
+            wallet_action_id: String,
+            wallet_id: String,
+            amount: String,
+            asset: String,
+            decimals: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of the wallet action.
+      module Status
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(
+            :pending,
+            Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The type of webhook event.
+      module Type
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WALLET_ACTION_EARN_FEE_COLLECT_CREATED =
+          T.let(
+            :"wallet_action.earn_fee_collect.created",
+            Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::WalletActionEarnFeeCollectCreatedWebhookPayload::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallet_action_earn_fee_collect_failed_webhook_payload.rbi

@@ -0,0 +1,271 @@
+# typed: strong
+
+module Privy
+  module Models
+    class WalletActionEarnFeeCollectFailedWebhookPayload < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::WalletActionEarnFeeCollectFailedWebhookPayload,
+            Privy::Internal::AnyHash
+          )
+        end
+
+      # Type of wallet action
+      sig { returns(Privy::Wallets::WalletActionType::TaggedSymbol) }
+      attr_accessor :action_type
+
+      # Underlying asset token address.
+      sig { returns(String) }
+      attr_accessor :asset_address
+
+      # CAIP-2 chain identifier.
+      sig { returns(String) }
+      attr_accessor :caip2
+
+      # ISO 8601 timestamp of when the wallet action was created.
+      sig { returns(String) }
+      attr_accessor :created_at
+
+      # ISO 8601 timestamp of when the wallet action failed.
+      sig { returns(String) }
+      attr_accessor :failed_at
+
+      # A description of why a wallet action (or a step within a wallet action) failed.
+      sig { returns(Privy::Wallets::FailureReason) }
+      attr_reader :failure_reason
+
+      sig { params(failure_reason: Privy::Wallets::FailureReason::OrHash).void }
+      attr_writer :failure_reason
+
+      # Base-unit amount of fees collected (e.g. "1500000").
+      sig { returns(String) }
+      attr_accessor :raw_amount
+
+      # The status of the wallet action.
+      sig do
+        returns(
+          Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # The steps of the wallet action. Completed steps will have transaction hashes;
+      # the failing step will have a failure_reason.
+      sig { returns(T::Array[Privy::Wallets::WalletActionStep::Variants]) }
+      attr_accessor :steps
+
+      # The type of webhook event.
+      sig do
+        returns(
+          Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      # ERC-4626 vault contract address.
+      sig { returns(String) }
+      attr_accessor :vault_address
+
+      # The vault ID.
+      sig { returns(String) }
+      attr_accessor :vault_id
+
+      # The ID of the wallet action.
+      sig { returns(String) }
+      attr_accessor :wallet_action_id
+
+      # The ID of the wallet involved in the action.
+      sig { returns(String) }
+      attr_accessor :wallet_id
+
+      # Human-readable decimal amount of fees collected (e.g. "1.5"). Only present when
+      # the token is known in the asset registry.
+      sig { returns(T.nilable(String)) }
+      attr_reader :amount
+
+      sig { params(amount: String).void }
+      attr_writer :amount
+
+      # Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
+      # the asset registry.
+      sig { returns(T.nilable(String)) }
+      attr_reader :asset
+
+      sig { params(asset: String).void }
+      attr_writer :asset
+
+      # Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
+      # present when the token is known in the asset registry.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :decimals
+
+      sig { params(decimals: Integer).void }
+      attr_writer :decimals
+
+      # Payload for the wallet_action.earn_fee_collect.failed webhook event.
+      sig do
+        params(
+          action_type: Privy::Wallets::WalletActionType::OrSymbol,
+          asset_address: String,
+          caip2: String,
+          created_at: String,
+          failed_at: String,
+          failure_reason: Privy::Wallets::FailureReason::OrHash,
+          raw_amount: String,
+          status:
+            Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Status::OrSymbol,
+          steps:
+            T::Array[
+              T.any(
+                Privy::Wallets::EvmTransactionWalletActionStep::OrHash,
+                Privy::Wallets::EvmUserOperationWalletActionStep::OrHash,
+                Privy::Wallets::SvmTransactionWalletActionStep::OrHash,
+                Privy::Wallets::TvmTransactionWalletActionStep::OrHash,
+                Privy::Wallets::ExternalTransactionWalletActionStep::OrHash,
+                Privy::Wallets::CustodianTransactionWalletActionStep::OrHash
+              )
+            ],
+          type:
+            Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Type::OrSymbol,
+          vault_address: String,
+          vault_id: String,
+          wallet_action_id: String,
+          wallet_id: String,
+          amount: String,
+          asset: String,
+          decimals: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Type of wallet action
+        action_type:,
+        # Underlying asset token address.
+        asset_address:,
+        # CAIP-2 chain identifier.
+        caip2:,
+        # ISO 8601 timestamp of when the wallet action was created.
+        created_at:,
+        # ISO 8601 timestamp of when the wallet action failed.
+        failed_at:,
+        # A description of why a wallet action (or a step within a wallet action) failed.
+        failure_reason:,
+        # Base-unit amount of fees collected (e.g. "1500000").
+        raw_amount:,
+        # The status of the wallet action.
+        status:,
+        # The steps of the wallet action. Completed steps will have transaction hashes;
+        # the failing step will have a failure_reason.
+        steps:,
+        # The type of webhook event.
+        type:,
+        # ERC-4626 vault contract address.
+        vault_address:,
+        # The vault ID.
+        vault_id:,
+        # The ID of the wallet action.
+        wallet_action_id:,
+        # The ID of the wallet involved in the action.
+        wallet_id:,
+        # Human-readable decimal amount of fees collected (e.g. "1.5"). Only present when
+        # the token is known in the asset registry.
+        amount: nil,
+        # Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
+        # the asset registry.
+        asset: nil,
+        # Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
+        # present when the token is known in the asset registry.
+        decimals: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            action_type: Privy::Wallets::WalletActionType::TaggedSymbol,
+            asset_address: String,
+            caip2: String,
+            created_at: String,
+            failed_at: String,
+            failure_reason: Privy::Wallets::FailureReason,
+            raw_amount: String,
+            status:
+              Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Status::TaggedSymbol,
+            steps: T::Array[Privy::Wallets::WalletActionStep::Variants],
+            type:
+              Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Type::TaggedSymbol,
+            vault_address: String,
+            vault_id: String,
+            wallet_action_id: String,
+            wallet_id: String,
+            amount: String,
+            asset: String,
+            decimals: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of the wallet action.
+      module Status
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FAILED =
+          T.let(
+            :failed,
+            Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The type of webhook event.
+      module Type
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WALLET_ACTION_EARN_FEE_COLLECT_FAILED =
+          T.let(
+            :"wallet_action.earn_fee_collect.failed",
+            Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::WalletActionEarnFeeCollectFailedWebhookPayload::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end