privy_ruby 0.3.0 → 0.5.0

data/rbi/privy/models/wallet_action_earn_fee_collect_rejected_webhook_payload.rbi

@@ -0,0 +1,269 @@
+# typed: strong
+
+module Privy
+  module Models
+    class WalletActionEarnFeeCollectRejectedWebhookPayload < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::WalletActionEarnFeeCollectRejectedWebhookPayload,
+            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
+
+      # 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
+
+      # ISO 8601 timestamp of when the wallet action was rejected.
+      sig { returns(String) }
+      attr_accessor :rejected_at
+
+      # The status of the wallet action.
+      sig do
+        returns(
+          Privy::WalletActionEarnFeeCollectRejectedWebhookPayload::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # The steps of the wallet action at the time of rejection.
+      sig { returns(T::Array[Privy::Wallets::WalletActionStep::Variants]) }
+      attr_accessor :steps
+
+      # The type of webhook event.
+      sig do
+        returns(
+          Privy::WalletActionEarnFeeCollectRejectedWebhookPayload::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.rejected webhook event.
+      sig do
+        params(
+          action_type: Privy::Wallets::WalletActionType::OrSymbol,
+          asset_address: String,
+          caip2: String,
+          created_at: String,
+          failure_reason: Privy::Wallets::FailureReason::OrHash,
+          raw_amount: String,
+          rejected_at: String,
+          status:
+            Privy::WalletActionEarnFeeCollectRejectedWebhookPayload::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::WalletActionEarnFeeCollectRejectedWebhookPayload::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:,
+        # 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:,
+        # ISO 8601 timestamp of when the wallet action was rejected.
+        rejected_at:,
+        # The status of the wallet action.
+        status:,
+        # The steps of the wallet action at the time of rejection.
+        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,
+            failure_reason: Privy::Wallets::FailureReason,
+            raw_amount: String,
+            rejected_at: String,
+            status:
+              Privy::WalletActionEarnFeeCollectRejectedWebhookPayload::Status::TaggedSymbol,
+            steps: T::Array[Privy::Wallets::WalletActionStep::Variants],
+            type:
+              Privy::WalletActionEarnFeeCollectRejectedWebhookPayload::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::WalletActionEarnFeeCollectRejectedWebhookPayload::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        REJECTED =
+          T.let(
+            :rejected,
+            Privy::WalletActionEarnFeeCollectRejectedWebhookPayload::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::WalletActionEarnFeeCollectRejectedWebhookPayload::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::WalletActionEarnFeeCollectRejectedWebhookPayload::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WALLET_ACTION_EARN_FEE_COLLECT_REJECTED =
+          T.let(
+            :"wallet_action.earn_fee_collect.rejected",
+            Privy::WalletActionEarnFeeCollectRejectedWebhookPayload::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::WalletActionEarnFeeCollectRejectedWebhookPayload::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallet_action_earn_fee_collect_succeeded_webhook_payload.rbi

@@ -0,0 +1,258 @@
+# typed: strong
+
+module Privy
+  module Models
+    class WalletActionEarnFeeCollectSucceededWebhookPayload < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::WalletActionEarnFeeCollectSucceededWebhookPayload,
+            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 completed successfully.
+      sig { returns(String) }
+      attr_accessor :completed_at
+
+      # 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::WalletActionEarnFeeCollectSucceededWebhookPayload::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # The steps of the wallet action, including transaction hashes.
+      sig { returns(T::Array[Privy::Wallets::WalletActionStep::Variants]) }
+      attr_accessor :steps
+
+      # The type of webhook event.
+      sig do
+        returns(
+          Privy::WalletActionEarnFeeCollectSucceededWebhookPayload::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.succeeded webhook event.
+      sig do
+        params(
+          action_type: Privy::Wallets::WalletActionType::OrSymbol,
+          asset_address: String,
+          caip2: String,
+          completed_at: String,
+          created_at: String,
+          raw_amount: String,
+          status:
+            Privy::WalletActionEarnFeeCollectSucceededWebhookPayload::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::WalletActionEarnFeeCollectSucceededWebhookPayload::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 completed successfully.
+        completed_at:,
+        # 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 steps of the wallet action, including transaction hashes.
+        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,
+            completed_at: String,
+            created_at: String,
+            raw_amount: String,
+            status:
+              Privy::WalletActionEarnFeeCollectSucceededWebhookPayload::Status::TaggedSymbol,
+            steps: T::Array[Privy::Wallets::WalletActionStep::Variants],
+            type:
+              Privy::WalletActionEarnFeeCollectSucceededWebhookPayload::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::WalletActionEarnFeeCollectSucceededWebhookPayload::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SUCCEEDED =
+          T.let(
+            :succeeded,
+            Privy::WalletActionEarnFeeCollectSucceededWebhookPayload::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::WalletActionEarnFeeCollectSucceededWebhookPayload::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::WalletActionEarnFeeCollectSucceededWebhookPayload::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WALLET_ACTION_EARN_FEE_COLLECT_SUCCEEDED =
+          T.let(
+            :"wallet_action.earn_fee_collect.succeeded",
+            Privy::WalletActionEarnFeeCollectSucceededWebhookPayload::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::WalletActionEarnFeeCollectSucceededWebhookPayload::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallet_asset.rbi

@@ -14,10 +14,12 @@ module Privy
       ETH = T.let(:eth, Privy::WalletAsset::TaggedSymbol)
       AVAX = T.let(:avax, Privy::WalletAsset::TaggedSymbol)
       POL = T.let(:pol, Privy::WalletAsset::TaggedSymbol)
+      BNB = T.let(:bnb, Privy::WalletAsset::TaggedSymbol)
       USDT = T.let(:usdt, Privy::WalletAsset::TaggedSymbol)
       EURC = T.let(:eurc, Privy::WalletAsset::TaggedSymbol)
       USDB = T.let(:usdb, Privy::WalletAsset::TaggedSymbol)
       SOL = T.let(:sol, Privy::WalletAsset::TaggedSymbol)
+      TRX = T.let(:trx, Privy::WalletAsset::TaggedSymbol)
 
       sig { override.returns(T::Array[Privy::WalletAsset::TaggedSymbol]) }
       def self.values

data/rbi/privy/models/wallet_asset_chain_name_input.rbi

@@ -22,7 +22,9 @@ module Privy
       OPTIMISM =
         T.let(:optimism, Privy::WalletAssetChainNameInput::TaggedSymbol)
       POLYGON = T.let(:polygon, Privy::WalletAssetChainNameInput::TaggedSymbol)
+      BSC = T.let(:bsc, Privy::WalletAssetChainNameInput::TaggedSymbol)
       SOLANA = T.let(:solana, Privy::WalletAssetChainNameInput::TaggedSymbol)
+      TRON = T.let(:tron, Privy::WalletAssetChainNameInput::TaggedSymbol)
       ZKSYNC_ERA =
         T.let(:zksync_era, Privy::WalletAssetChainNameInput::TaggedSymbol)
       SEPOLIA = T.let(:sepolia, Privy::WalletAssetChainNameInput::TaggedSymbol)
@@ -42,6 +44,8 @@ module Privy
         T.let(:solana_devnet, Privy::WalletAssetChainNameInput::TaggedSymbol)
       SOLANA_TESTNET =
         T.let(:solana_testnet, Privy::WalletAssetChainNameInput::TaggedSymbol)
+      TRON_NILE =
+        T.let(:tron_nile, Privy::WalletAssetChainNameInput::TaggedSymbol)
 
       sig do
         override.returns(

data/rbi/privy/models/wallet_creation_input.rbi

@@ -34,6 +34,15 @@ module Privy
       sig { params(create_smart_wallet: T::Boolean).void }
       attr_writer :create_smart_wallet
 
+      # A customer-provided identifier for mapping to external systems. Write-once, set
+      # only at creation. Must be alphanumeric, hyphens, or underscores, max 64
+      # characters.
+      sig { returns(T.nilable(String)) }
+      attr_reader :external_id
+
+      sig { params(external_id: String).void }
+      attr_writer :external_id
+
       # Policy IDs to enforce on the wallet. Currently, only one policy is supported per
       # wallet.
       sig { returns(T.nilable(T::Array[String])) }
@@ -50,6 +59,7 @@ module Privy
           additional_signers:
             T::Array[Privy::WalletCreationAdditionalSignerItem::OrHash],
           create_smart_wallet: T::Boolean,
+          external_id: String,
           policy_ids: T::Array[String]
         ).returns(T.attached_class)
       end
@@ -61,6 +71,10 @@ module Privy
         # Create a smart wallet with this wallet as the signer. Only supported for wallets
         # with `chain_type: "ethereum"`.
         create_smart_wallet: nil,
+        # A customer-provided identifier for mapping to external systems. Write-once, set
+        # only at creation. Must be alphanumeric, hyphens, or underscores, max 64
+        # characters.
+        external_id: nil,
         # Policy IDs to enforce on the wallet. Currently, only one policy is supported per
         # wallet.
         policy_ids: nil
@@ -74,6 +88,7 @@ module Privy
             additional_signers:
               T::Array[Privy::WalletCreationAdditionalSignerItem],
             create_smart_wallet: T::Boolean,
+            external_id: String,
             policy_ids: T::Array[String]
           }
         )

data/rbi/privy/models/wallet_ethereum_asset.rbi

@@ -14,6 +14,7 @@ module Privy
       ETH = T.let(:eth, Privy::WalletEthereumAsset::TaggedSymbol)
       AVAX = T.let(:avax, Privy::WalletEthereumAsset::TaggedSymbol)
       POL = T.let(:pol, Privy::WalletEthereumAsset::TaggedSymbol)
+      BNB = T.let(:bnb, Privy::WalletEthereumAsset::TaggedSymbol)
       USDT = T.let(:usdt, Privy::WalletEthereumAsset::TaggedSymbol)
       EURC = T.let(:eurc, Privy::WalletEthereumAsset::TaggedSymbol)
       USDB = T.let(:usdb, Privy::WalletEthereumAsset::TaggedSymbol)

data/rbi/privy/models/wallet_rpc_request_body.rbi

@@ -29,6 +29,8 @@ module Privy
             Privy::SparkCreateLightningInvoiceRpcInput,
             Privy::SparkPayLightningInvoiceRpcInput,
             Privy::SparkSignMessageWithIdentityKeyRpcInput,
+            Privy::SparkWithdrawRpcInput,
+            Privy::SparkGetWithdrawalFeeQuoteRpcInput,
             Privy::TronSignTransactionRpcInput,
             Privy::TronSendTransactionRpcInput,
             Privy::ExportPrivateKeyRpcInput,

data/rbi/privy/models/wallet_rpc_response.rbi

@@ -29,6 +29,8 @@ module Privy
             Privy::SparkCreateLightningInvoiceRpcResponse,
             Privy::SparkPayLightningInvoiceRpcResponse,
             Privy::SparkSignMessageWithIdentityKeyRpcResponse,
+            Privy::SparkWithdrawRpcResponse,
+            Privy::SparkGetWithdrawalFeeQuoteRpcResponse,
             Privy::TronSignTransactionRpcResponse,
             Privy::TronSendTransactionRpcResponse,
             Privy::ExportPrivateKeyRpcResponse,

data/rbi/privy/models/wallet_tron_asset.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Privy
+  module Models
+    # A named asset on Tron.
+    module WalletTronAsset
+      extend Privy::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Privy::WalletTronAsset) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      TRX = T.let(:trx, Privy::WalletTronAsset::TaggedSymbol)
+      USDT = T.let(:usdt, Privy::WalletTronAsset::TaggedSymbol)
+      USDC = T.let(:usdc, Privy::WalletTronAsset::TaggedSymbol)
+
+      sig { override.returns(T::Array[Privy::WalletTronAsset::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end