privy_ruby 0.1.0 → 0.3.0

data/lib/privy/models/transfer_action_response.rb

@@ -1,163 +0,0 @@
-# frozen_string_literal: true
-
-module Privy
-  module Models
-    class TransferActionResponse < Privy::Internal::Type::BaseModel
-      # @!attribute id
-      #   The ID of the wallet action.
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute created_at
-      #   ISO 8601 timestamp of when the wallet action was created.
-      #
-      #   @return [Time]
-      required :created_at, Time
-
-      # @!attribute destination_address
-      #   Recipient address.
-      #
-      #   @return [String]
-      required :destination_address, String
-
-      # @!attribute source_chain
-      #   Chain name (e.g. "base", "ethereum").
-      #
-      #   @return [String]
-      required :source_chain, String
-
-      # @!attribute status
-      #   Status of a wallet action.
-      #
-      #   @return [Symbol, Privy::Models::WalletActionStatus]
-      required :status, enum: -> { Privy::WalletActionStatus }
-
-      # @!attribute type
-      #
-      #   @return [Symbol, Privy::Models::TransferActionResponse::Type]
-      required :type, enum: -> { Privy::TransferActionResponse::Type }
-
-      # @!attribute wallet_id
-      #   The ID of the wallet involved in the action.
-      #
-      #   @return [String]
-      required :wallet_id, String
-
-      # @!attribute destination_amount
-      #   Amount received on the destination chain. Populated immediately for exact_output
-      #   transfers, or after fill confirmation for exact_input transfers.
-      #
-      #   @return [String, nil]
-      optional :destination_amount, String
-
-      # @!attribute destination_asset
-      #   Destination asset for cross-asset transfers. Omitted for same-asset transfers.
-      #
-      #   @return [String, nil]
-      optional :destination_asset, String
-
-      # @!attribute destination_chain
-      #   Destination chain for cross-chain transfers. Omitted for same-chain transfers.
-      #
-      #   @return [String, nil]
-      optional :destination_chain, String
-
-      # @!attribute failure_reason
-      #   A description of why a wallet action (or a step within a wallet action) failed.
-      #
-      #   @return [Privy::Models::FailureReason, nil]
-      optional :failure_reason, -> { Privy::FailureReason }
-
-      # @!attribute fees
-      #   Fees paid for the transfer.
-      #
-      #   @return [Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>, nil]
-      optional :fees, -> { Privy::Internal::Type::ArrayOf[union: Privy::FeeLineItem] }
-
-      # @!attribute source_amount
-      #   Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
-      #   cross-chain transfers until the source amount is determined.
-      #
-      #   @return [String, nil]
-      optional :source_amount, String
-
-      # @!attribute source_asset
-      #   Asset identifier (e.g. "usdc", "eth"). Present when the transfer was initiated
-      #   with a named asset; omitted for custom-token transfers.
-      #
-      #   @return [String, nil]
-      optional :source_asset, String
-
-      # @!attribute source_asset_address
-      #   Token contract address (EVM) or mint address (Solana). Present when the transfer
-      #   was initiated with `asset_address`.
-      #
-      #   @return [String, nil]
-      optional :source_asset_address, String
-
-      # @!attribute source_asset_decimals
-      #   Number of decimals for the transferred token. Present when the transfer was
-      #   initiated with `asset_address` and the decimals were resolved on-chain.
-      #
-      #   @return [Integer, nil]
-      optional :source_asset_decimals, Integer
-
-      # @!attribute steps
-      #   The steps of the wallet action. Only returned if `?include=steps` is provided.
-      #
-      #   @return [Array<Privy::Models::EvmTransactionWalletActionStep, Privy::Models::EvmUserOperationWalletActionStep, Privy::Models::SvmTransactionWalletActionStep, Privy::Models::ExternalTransactionWalletActionStep>, nil]
-      optional :steps, -> { Privy::Internal::Type::ArrayOf[union: Privy::WalletActionStep] }
-
-      # @!method initialize(id:, created_at:, destination_address:, source_chain:, status:, type:, wallet_id:, destination_amount: nil, destination_asset: nil, destination_chain: nil, failure_reason: nil, fees: nil, source_amount: nil, source_asset: nil, source_asset_address: nil, source_asset_decimals: nil, steps: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Privy::Models::TransferActionResponse} for more details.
-      #
-      #   Response for a transfer action.
-      #
-      #   @param id [String] The ID of the wallet action.
-      #
-      #   @param created_at [Time] ISO 8601 timestamp of when the wallet action was created.
-      #
-      #   @param destination_address [String] Recipient address.
-      #
-      #   @param source_chain [String] Chain name (e.g. "base", "ethereum").
-      #
-      #   @param status [Symbol, Privy::Models::WalletActionStatus] Status of a wallet action.
-      #
-      #   @param type [Symbol, Privy::Models::TransferActionResponse::Type]
-      #
-      #   @param wallet_id [String] The ID of the wallet involved in the action.
-      #
-      #   @param destination_amount [String] Amount received on the destination chain. Populated immediately for exact_output
-      #
-      #   @param destination_asset [String] Destination asset for cross-asset transfers. Omitted for same-asset transfers.
-      #
-      #   @param destination_chain [String] Destination chain for cross-chain transfers. Omitted for same-chain transfers.
-      #
-      #   @param failure_reason [Privy::Models::FailureReason] A description of why a wallet action (or a step within a wallet action) failed.
-      #
-      #   @param fees [Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>] Fees paid for the transfer.
-      #
-      #   @param source_amount [String] Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output c
-      #
-      #   @param source_asset [String] Asset identifier (e.g. "usdc", "eth"). Present when the transfer was initiated w
-      #
-      #   @param source_asset_address [String] Token contract address (EVM) or mint address (Solana). Present when the transfer
-      #
-      #   @param source_asset_decimals [Integer] Number of decimals for the transferred token. Present when the transfer was init
-      #
-      #   @param steps [Array<Privy::Models::EvmTransactionWalletActionStep, Privy::Models::EvmUserOperationWalletActionStep, Privy::Models::SvmTransactionWalletActionStep, Privy::Models::ExternalTransactionWalletActionStep>] The steps of the wallet action. Only returned if `?include=steps` is provided.
-
-      # @see Privy::Models::TransferActionResponse#type
-      module Type
-        extend Privy::Internal::Type::Enum
-
-        TRANSFER = :transfer
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/privy/models/wallet_action_response.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Privy
-  module Models
-    # Response for a wallet action, discriminated on type.
-    module WalletActionResponse
-      extend Privy::Internal::Type::Union
-
-      discriminator :type
-
-      # Response for a swap action.
-      variant :swap, -> { Privy::SwapActionResponse }
-
-      # Response for a transfer action.
-      variant :transfer, -> { Privy::TransferActionResponse }
-
-      # Response for an earn deposit action.
-      variant :earn_deposit, -> { Privy::EarnDepositActionResponse }
-
-      # Response for an earn withdraw action.
-      variant :earn_withdraw, -> { Privy::EarnWithdrawActionResponse }
-
-      # Response for an earn incentive claim action.
-      variant :earn_incentive_claim, -> { Privy::EarnIncentiveClaimActionResponse }
-
-      # @!method self.variants
-      #   @return [Array(Privy::Models::SwapActionResponse, Privy::Models::TransferActionResponse, Privy::Models::EarnDepositActionResponse, Privy::Models::EarnWithdrawActionResponse, Privy::Models::EarnIncentiveClaimActionResponse)]
-    end
-  end
-end

data/lib/privy/models/wallet_action_step.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Privy
-  module Models
-    # A step within a wallet action, representing a single onchain action.
-    module WalletActionStep
-      extend Privy::Internal::Type::Union
-
-      discriminator :type
-
-      # A wallet action step consisting of an EVM transaction.
-      variant :evm_transaction, -> { Privy::EvmTransactionWalletActionStep }
-
-      # A wallet action step consisting of an EVM user operation.
-      variant :evm_user_operation, -> { Privy::EvmUserOperationWalletActionStep }
-
-      # A wallet action step consisting of an SVM (Solana) transaction.
-      variant :svm_transaction, -> { Privy::SvmTransactionWalletActionStep }
-
-      # A wallet action step representing a cross-chain/cross-asset fill by an external provider.
-      variant :external_transaction, -> { Privy::ExternalTransactionWalletActionStep }
-
-      # @!method self.variants
-      #   @return [Array(Privy::Models::EvmTransactionWalletActionStep, Privy::Models::EvmUserOperationWalletActionStep, Privy::Models::SvmTransactionWalletActionStep, Privy::Models::ExternalTransactionWalletActionStep)]
-    end
-  end
-end

data/lib/privy/models/wallet_action_step_type.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Privy
-  module Models
-    # Type of a wallet action step.
-    module WalletActionStepType
-      extend Privy::Internal::Type::Enum
-
-      EVM_TRANSACTION = :evm_transaction
-      EVM_USER_OPERATION = :evm_user_operation
-      SVM_TRANSACTION = :svm_transaction
-      EXTERNAL_TRANSACTION = :external_transaction
-
-      # @!method self.values
-      #   @return [Array<Symbol>]
-    end
-  end
-end

data/lib/privy/models/wallet_action_type.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Privy
-  module Models
-    # Type of wallet action
-    module WalletActionType
-      extend Privy::Internal::Type::Enum
-
-      SWAP = :swap
-      TRANSFER = :transfer
-      EARN_DEPOSIT = :earn_deposit
-      EARN_WITHDRAW = :earn_withdraw
-      EARN_INCENTIVE_CLAIM = :earn_incentive_claim
-
-      # @!method self.values
-      #   @return [Array<Symbol>]
-    end
-  end
-end

data/lib/privy/resources/wallet_actions.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Privy
-  module Resources
-    class WalletActions
-      # @api private
-      #
-      # @param client [Privy::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/privy/models/earn_asset.rbi

@@ -1,44 +0,0 @@
-# typed: strong
-
-module Privy
-  module Models
-    class EarnAsset < Privy::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias { T.any(Privy::EarnAsset, Privy::Internal::AnyHash) }
-
-      # Token contract address.
-      sig { returns(String) }
-      attr_accessor :address
-
-      # Number of decimals for the asset (e.g. 6 for USDC).
-      sig { returns(Integer) }
-      attr_accessor :decimals
-
-      # Lowercase token symbol (e.g. "usdc").
-      sig { returns(String) }
-      attr_accessor :symbol
-
-      # Asset metadata for an earn vault position.
-      sig do
-        params(address: String, decimals: Integer, symbol: String).returns(
-          T.attached_class
-        )
-      end
-      def self.new(
-        # Token contract address.
-        address:,
-        # Number of decimals for the asset (e.g. 6 for USDC).
-        decimals:,
-        # Lowercase token symbol (e.g. "usdc").
-        symbol:
-      )
-      end
-
-      sig do
-        override.returns({ address: String, decimals: Integer, symbol: String })
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/privy/models/earn_deposit_action_response.rbi

@@ -1,219 +0,0 @@
-# typed: strong
-
-module Privy
-  module Models
-    class EarnDepositActionResponse < Privy::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(Privy::EarnDepositActionResponse, Privy::Internal::AnyHash)
-        end
-
-      # The ID of the wallet action.
-      sig { returns(String) }
-      attr_accessor :id
-
-      # 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(Time) }
-      attr_accessor :created_at
-
-      # Base-unit amount of asset deposited (e.g. "1500000").
-      sig { returns(String) }
-      attr_accessor :raw_amount
-
-      # Vault shares received in base units. Populated after on-chain confirmation.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :share_amount
-
-      # Status of a wallet action.
-      sig { returns(Privy::WalletActionStatus::TaggedSymbol) }
-      attr_accessor :status
-
-      sig { returns(Privy::EarnDepositActionResponse::Type::TaggedSymbol) }
-      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 involved in the action.
-      sig { returns(String) }
-      attr_accessor :wallet_id
-
-      # Human-readable decimal amount of asset deposited (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
-
-      # A description of why a wallet action (or a step within a wallet action) failed.
-      sig { returns(T.nilable(Privy::FailureReason)) }
-      attr_reader :failure_reason
-
-      sig { params(failure_reason: Privy::FailureReason::OrHash).void }
-      attr_writer :failure_reason
-
-      # The steps of the wallet action. Only returned if `?include=steps` is provided.
-      sig { returns(T.nilable(T::Array[Privy::WalletActionStep::Variants])) }
-      attr_reader :steps
-
-      sig do
-        params(
-          steps:
-            T::Array[
-              T.any(
-                Privy::EvmTransactionWalletActionStep::OrHash,
-                Privy::EvmUserOperationWalletActionStep::OrHash,
-                Privy::SvmTransactionWalletActionStep::OrHash,
-                Privy::ExternalTransactionWalletActionStep::OrHash
-              )
-            ]
-        ).void
-      end
-      attr_writer :steps
-
-      # Response for an earn deposit action.
-      sig do
-        params(
-          id: String,
-          asset_address: String,
-          caip2: String,
-          created_at: Time,
-          raw_amount: String,
-          share_amount: T.nilable(String),
-          status: Privy::WalletActionStatus::OrSymbol,
-          type: Privy::EarnDepositActionResponse::Type::OrSymbol,
-          vault_address: String,
-          vault_id: String,
-          wallet_id: String,
-          amount: String,
-          asset: String,
-          decimals: Integer,
-          failure_reason: Privy::FailureReason::OrHash,
-          steps:
-            T::Array[
-              T.any(
-                Privy::EvmTransactionWalletActionStep::OrHash,
-                Privy::EvmUserOperationWalletActionStep::OrHash,
-                Privy::SvmTransactionWalletActionStep::OrHash,
-                Privy::ExternalTransactionWalletActionStep::OrHash
-              )
-            ]
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The ID of the wallet action.
-        id:,
-        # 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 asset deposited (e.g. "1500000").
-        raw_amount:,
-        # Vault shares received in base units. Populated after on-chain confirmation.
-        share_amount:,
-        # Status of a wallet action.
-        status:,
-        type:,
-        # ERC-4626 vault contract address.
-        vault_address:,
-        # The vault ID.
-        vault_id:,
-        # The ID of the wallet involved in the action.
-        wallet_id:,
-        # Human-readable decimal amount of asset deposited (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,
-        # A description of why a wallet action (or a step within a wallet action) failed.
-        failure_reason: nil,
-        # The steps of the wallet action. Only returned if `?include=steps` is provided.
-        steps: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            asset_address: String,
-            caip2: String,
-            created_at: Time,
-            raw_amount: String,
-            share_amount: T.nilable(String),
-            status: Privy::WalletActionStatus::TaggedSymbol,
-            type: Privy::EarnDepositActionResponse::Type::TaggedSymbol,
-            vault_address: String,
-            vault_id: String,
-            wallet_id: String,
-            amount: String,
-            asset: String,
-            decimals: Integer,
-            failure_reason: Privy::FailureReason,
-            steps: T::Array[Privy::WalletActionStep::Variants]
-          }
-        )
-      end
-      def to_hash
-      end
-
-      module Type
-        extend Privy::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Privy::EarnDepositActionResponse::Type) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        EARN_DEPOSIT =
-          T.let(
-            :earn_deposit,
-            Privy::EarnDepositActionResponse::Type::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[Privy::EarnDepositActionResponse::Type::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end

data/rbi/privy/models/earn_deposit_request_body.rbi

@@ -1,59 +0,0 @@
-# typed: strong
-
-module Privy
-  module Models
-    class EarnDepositRequestBody < Privy::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(Privy::EarnDepositRequestBody, Privy::Internal::AnyHash)
-        end
-
-      # The ID of the vault to deposit into.
-      sig { returns(String) }
-      attr_accessor :vault_id
-
-      # Human-readable decimal amount to deposit (e.g. "1.5" for 1.5 USDC). Exactly one
-      # of `amount` or `raw_amount` must be provided.
-      sig { returns(T.nilable(String)) }
-      attr_reader :amount
-
-      sig { params(amount: String).void }
-      attr_writer :amount
-
-      # Amount in smallest unit to deposit (e.g. "1500000" for 1.5 USDC with 6
-      # decimals). Exactly one of `amount` or `raw_amount` must be provided.
-      sig { returns(T.nilable(String)) }
-      attr_reader :raw_amount
-
-      sig { params(raw_amount: String).void }
-      attr_writer :raw_amount
-
-      # Input for depositing assets into an ERC-4626 vault. Exactly one of `amount` or
-      # `raw_amount` must be provided.
-      sig do
-        params(vault_id: String, amount: String, raw_amount: String).returns(
-          T.attached_class
-        )
-      end
-      def self.new(
-        # The ID of the vault to deposit into.
-        vault_id:,
-        # Human-readable decimal amount to deposit (e.g. "1.5" for 1.5 USDC). Exactly one
-        # of `amount` or `raw_amount` must be provided.
-        amount: nil,
-        # Amount in smallest unit to deposit (e.g. "1500000" for 1.5 USDC with 6
-        # decimals). Exactly one of `amount` or `raw_amount` must be provided.
-        raw_amount: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          { vault_id: String, amount: String, raw_amount: String }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end