privy_ruby 0.1.0 → 0.3.0

data/lib/privy/models/wallets/external_transaction_wallet_action_step.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class ExternalTransactionWalletActionStep < Privy::Internal::Type::BaseModel
+        # @!attribute status
+        #   Status of an external transaction step in a wallet action.
+        #
+        #   @return [Symbol, Privy::Models::Wallets::ExternalTransactionWalletActionStepStatus]
+        required :status, enum: -> { Privy::Wallets::ExternalTransactionWalletActionStepStatus }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Privy::Models::Wallets::ExternalTransactionWalletActionStep::Type]
+        required :type, enum: -> { Privy::Wallets::ExternalTransactionWalletActionStep::Type }
+
+        # @!attribute failure_reason
+        #   A description of why a wallet action (or a step within a wallet action) failed.
+        #
+        #   @return [Privy::Models::Wallets::FailureReason, nil]
+        optional :failure_reason, -> { Privy::Wallets::FailureReason }
+
+        # @!method initialize(status:, type:, failure_reason: nil)
+        #   A wallet action step representing a cross-chain/cross-asset fill by an external
+        #   provider.
+        #
+        #   @param status [Symbol, Privy::Models::Wallets::ExternalTransactionWalletActionStepStatus] Status of an external transaction step in a wallet action.
+        #
+        #   @param type [Symbol, Privy::Models::Wallets::ExternalTransactionWalletActionStep::Type]
+        #
+        #   @param failure_reason [Privy::Models::Wallets::FailureReason] A description of why a wallet action (or a step within a wallet action) failed.
+
+        # @see Privy::Models::Wallets::ExternalTransactionWalletActionStep#type
+        module Type
+          extend Privy::Internal::Type::Enum
+
+          EXTERNAL_TRANSACTION = :external_transaction
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/external_transaction_wallet_action_step_status.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      # Status of an external transaction step in a wallet action.
+      module ExternalTransactionWalletActionStepStatus
+        extend Privy::Internal::Type::Enum
+
+        PREPARING = :preparing
+        QUEUED = :queued
+        PENDING = :pending
+        CONFIRMED = :confirmed
+        REJECTED = :rejected
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/failure_reason.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class FailureReason < Privy::Internal::Type::BaseModel
+        # @!attribute message
+        #   Human-readable failure message.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute details
+        #   Additional error details, if available.
+        #
+        #   @return [Object, nil]
+        optional :details, Privy::Internal::Type::Unknown
+
+        # @!method initialize(message:, details: nil)
+        #   A description of why a wallet action (or a step within a wallet action) failed.
+        #
+        #   @param message [String] Human-readable failure message.
+        #
+        #   @param details [Object] Additional error details, if available.
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/list_wallet_actions_query.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class ListWalletActionsQuery < Privy::Internal::Type::BaseModel
+        # @!attribute cursor
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute limit
+        #
+        #   @return [Float, nil]
+        optional :limit, Float, nil?: true
+
+        # @!attribute type
+        #   Type of wallet action
+        #
+        #   @return [Symbol, Privy::Models::Wallets::WalletActionType, nil]
+        optional :type, enum: -> { Privy::Wallets::WalletActionType }
+
+        # @!method initialize(cursor: nil, limit: nil, type: nil)
+        #   Query parameters for listing wallet actions.
+        #
+        #   @param cursor [String]
+        #
+        #   @param limit [Float, nil]
+        #
+        #   @param type [Symbol, Privy::Models::Wallets::WalletActionType] Type of wallet action
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/list_wallet_actions_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class ListWalletActionsResponse < Privy::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Privy::Models::Wallets::SwapActionResponse, Privy::Models::Wallets::TransferActionResponse, Privy::Models::Wallets::EarnDepositActionResponse, Privy::Models::Wallets::EarnWithdrawActionResponse, Privy::Models::Wallets::EarnIncentiveClaimActionResponse>]
+        required :data, -> { Privy::Internal::Type::ArrayOf[union: Privy::Wallets::WalletActionResponse] }
+
+        # @!attribute next_cursor
+        #
+        #   @return [String, nil]
+        required :next_cursor, String, nil?: true
+
+        # @!method initialize(data:, next_cursor:)
+        #   Paginated list of wallet actions.
+        #
+        #   @param data [Array<Privy::Models::Wallets::SwapActionResponse, Privy::Models::Wallets::TransferActionResponse, Privy::Models::Wallets::EarnDepositActionResponse, Privy::Models::Wallets::EarnWithdrawActionResponse, Privy::Models::Wallets::EarnIncentiveClaimActionResponse>]
+        #   @param next_cursor [String, nil]
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/svm_transaction_wallet_action_step.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class SvmTransactionWalletActionStep < Privy::Internal::Type::BaseModel
+        # @!attribute caip2
+        #   CAIP-2 chain identifier for the Solana network.
+        #
+        #   @return [String]
+        required :caip2, String
+
+        # @!attribute status
+        #   Status of an SVM step in a wallet action.
+        #
+        #   @return [Symbol, Privy::Models::Wallets::SvmWalletActionStepStatus]
+        required :status, enum: -> { Privy::Wallets::SvmWalletActionStepStatus }
+
+        # @!attribute transaction_signature
+        #   The Solana transaction signature (base58-encoded). Null until broadcast.
+        #
+        #   @return [String, nil]
+        required :transaction_signature, String, nil?: true
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Privy::Models::Wallets::SvmTransactionWalletActionStep::Type]
+        required :type, enum: -> { Privy::Wallets::SvmTransactionWalletActionStep::Type }
+
+        # @!attribute failure_reason
+        #   A description of why a wallet action (or a step within a wallet action) failed.
+        #
+        #   @return [Privy::Models::Wallets::FailureReason, nil]
+        optional :failure_reason, -> { Privy::Wallets::FailureReason }
+
+        # @!attribute finalized
+        #   Whether this step has reached on-chain finality. Absent until finality is
+        #   confirmed.
+        #
+        #   @return [Boolean, nil]
+        optional :finalized, Privy::Internal::Type::Boolean
+
+        # @!attribute gas_credits_charged_usd
+        #   Amount charged in USD for gas sponsorship on this step.
+        #
+        #   @return [String, nil]
+        optional :gas_credits_charged_usd, String
+
+        # @!method initialize(caip2:, status:, transaction_signature:, type:, failure_reason: nil, finalized: nil, gas_credits_charged_usd: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Privy::Models::Wallets::SvmTransactionWalletActionStep} for more details.
+        #
+        #   A wallet action step consisting of an SVM (Solana) transaction.
+        #
+        #   @param caip2 [String] CAIP-2 chain identifier for the Solana network.
+        #
+        #   @param status [Symbol, Privy::Models::Wallets::SvmWalletActionStepStatus] Status of an SVM step in a wallet action.
+        #
+        #   @param transaction_signature [String, nil] The Solana transaction signature (base58-encoded). Null until broadcast.
+        #
+        #   @param type [Symbol, Privy::Models::Wallets::SvmTransactionWalletActionStep::Type]
+        #
+        #   @param failure_reason [Privy::Models::Wallets::FailureReason] A description of why a wallet action (or a step within a wallet action) failed.
+        #
+        #   @param finalized [Boolean] Whether this step has reached on-chain finality. Absent until finality is confir
+        #
+        #   @param gas_credits_charged_usd [String] Amount charged in USD for gas sponsorship on this step.
+
+        # @see Privy::Models::Wallets::SvmTransactionWalletActionStep#type
+        module Type
+          extend Privy::Internal::Type::Enum
+
+          SVM_TRANSACTION = :svm_transaction
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/svm_wallet_action_step_status.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      # Status of an SVM step in a wallet action.
+      module SvmWalletActionStepStatus
+        extend Privy::Internal::Type::Enum
+
+        PREPARING = :preparing
+        QUEUED = :queued
+        PENDING = :pending
+        CONFIRMED = :confirmed
+        REJECTED = :rejected
+        REVERTED = :reverted
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/swap_action_response.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class SwapActionResponse < Privy::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the wallet action.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute caip2
+        #   CAIP-2 chain identifier for the swap.
+        #
+        #   @return [String]
+        required :caip2, String
+
+        # @!attribute created_at
+        #   ISO 8601 timestamp of when the wallet action was created.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute input_amount
+        #   Exact base-unit amount of input token. Populated after on-chain confirmation.
+        #
+        #   @return [String, nil]
+        required :input_amount, String, nil?: true
+
+        # @!attribute input_token
+        #   Token address or "native" for the token being sold.
+        #
+        #   @return [String]
+        required :input_token, String
+
+        # @!attribute output_amount
+        #   Exact base-unit amount of output token. Populated after on-chain confirmation.
+        #
+        #   @return [String, nil]
+        required :output_amount, String, nil?: true
+
+        # @!attribute output_token
+        #   Token address or "native" for the token being bought.
+        #
+        #   @return [String]
+        required :output_token, String
+
+        # @!attribute status
+        #   Status of a wallet action.
+        #
+        #   @return [Symbol, Privy::Models::Wallets::WalletActionStatus]
+        required :status, enum: -> { Privy::Wallets::WalletActionStatus }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Privy::Models::Wallets::SwapActionResponse::Type]
+        required :type, enum: -> { Privy::Wallets::SwapActionResponse::Type }
+
+        # @!attribute wallet_id
+        #   The ID of the wallet involved in the action.
+        #
+        #   @return [String]
+        required :wallet_id, String
+
+        # @!attribute destination_address
+        #   Recipient address on the destination chain. Present for cross-chain swaps. May
+        #   differ from the source wallet address when swapping between chain types (e.g.
+        #   EVM to Solana).
+        #
+        #   @return [String, nil]
+        optional :destination_address, String
+
+        # @!attribute destination_caip2
+        #   Destination chain CAIP-2 identifier. Present for cross-chain swaps.
+        #
+        #   @return [String, nil]
+        optional :destination_caip2, String
+
+        # @!attribute estimated_fees
+        #   Estimated fee breakdown from the provider quote. Only present for cross-chain
+        #   swaps. Populated after on-chain confirmation.
+        #
+        #   @return [Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>, nil]
+        optional :estimated_fees, -> { Privy::Internal::Type::ArrayOf[union: Privy::FeeLineItem] }, nil?: true
+
+        # @!attribute estimated_gas
+        #   Gas cost for a blockchain action. Includes both raw base-unit amount and a
+        #   human-readable decimal string, plus the gas token symbol.
+        #
+        #   @return [Privy::Models::Gas, nil]
+        optional :estimated_gas, -> { Privy::Gas }, nil?: true
+
+        # @!attribute failure_reason
+        #   A description of why a wallet action (or a step within a wallet action) failed.
+        #
+        #   @return [Privy::Models::Wallets::FailureReason, nil]
+        optional :failure_reason, -> { Privy::Wallets::FailureReason }
+
+        # @!attribute fees
+        #   Actual fees paid for the swap. Populated after on-chain confirmation. Only
+        #   present for cross-chain swaps.
+        #
+        #   @return [Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>, nil]
+        optional :fees, -> { Privy::Internal::Type::ArrayOf[union: Privy::FeeLineItem] }, nil?: true
+
+        # @!attribute gas
+        #   Gas cost for a blockchain action. Includes both raw base-unit amount and a
+        #   human-readable decimal string, plus the gas token symbol.
+        #
+        #   @return [Privy::Models::Gas, nil]
+        optional :gas, -> { Privy::Gas }, nil?: true
+
+        # @!attribute steps
+        #   The steps of the wallet action. Only returned if `?include=steps` is provided.
+        #
+        #   @return [Array<Privy::Models::Wallets::EvmTransactionWalletActionStep, Privy::Models::Wallets::EvmUserOperationWalletActionStep, Privy::Models::Wallets::SvmTransactionWalletActionStep, Privy::Models::Wallets::TvmTransactionWalletActionStep, Privy::Models::Wallets::ExternalTransactionWalletActionStep, Privy::Models::Wallets::CustodianTransactionWalletActionStep>, nil]
+        optional :steps, -> { Privy::Internal::Type::ArrayOf[union: Privy::Wallets::WalletActionStep] }
+
+        # @!method initialize(id:, caip2:, created_at:, input_amount:, input_token:, output_amount:, output_token:, status:, type:, wallet_id:, destination_address: nil, destination_caip2: nil, estimated_fees: nil, estimated_gas: nil, failure_reason: nil, fees: nil, gas: nil, steps: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Privy::Models::Wallets::SwapActionResponse} for more details.
+        #
+        #   Response for a swap action.
+        #
+        #   @param id [String] The ID of the wallet action.
+        #
+        #   @param caip2 [String] CAIP-2 chain identifier for the swap.
+        #
+        #   @param created_at [Time] ISO 8601 timestamp of when the wallet action was created.
+        #
+        #   @param input_amount [String, nil] Exact base-unit amount of input token. Populated after on-chain confirmation.
+        #
+        #   @param input_token [String] Token address or "native" for the token being sold.
+        #
+        #   @param output_amount [String, nil] Exact base-unit amount of output token. Populated after on-chain confirmation.
+        #
+        #   @param output_token [String] Token address or "native" for the token being bought.
+        #
+        #   @param status [Symbol, Privy::Models::Wallets::WalletActionStatus] Status of a wallet action.
+        #
+        #   @param type [Symbol, Privy::Models::Wallets::SwapActionResponse::Type]
+        #
+        #   @param wallet_id [String] The ID of the wallet involved in the action.
+        #
+        #   @param destination_address [String] Recipient address on the destination chain. Present for cross-chain swaps. May d
+        #
+        #   @param destination_caip2 [String] Destination chain CAIP-2 identifier. Present for cross-chain swaps.
+        #
+        #   @param estimated_fees [Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>, nil] Estimated fee breakdown from the provider quote. Only present for cross-chain sw
+        #
+        #   @param estimated_gas [Privy::Models::Gas, nil] Gas cost for a blockchain action. Includes both raw base-unit amount and a human
+        #
+        #   @param failure_reason [Privy::Models::Wallets::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>, nil] Actual fees paid for the swap. Populated after on-chain confirmation. Only prese
+        #
+        #   @param gas [Privy::Models::Gas, nil] Gas cost for a blockchain action. Includes both raw base-unit amount and a human
+        #
+        #   @param steps [Array<Privy::Models::Wallets::EvmTransactionWalletActionStep, Privy::Models::Wallets::EvmUserOperationWalletActionStep, Privy::Models::Wallets::SvmTransactionWalletActionStep, Privy::Models::Wallets::TvmTransactionWalletActionStep, Privy::Models::Wallets::ExternalTransactionWalletActionStep, Privy::Models::Wallets::CustodianTransactionWalletActionStep>] The steps of the wallet action. Only returned if `?include=steps` is provided.
+
+        # @see Privy::Models::Wallets::SwapActionResponse#type
+        module Type
+          extend Privy::Internal::Type::Enum
+
+          SWAP = :swap
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/swap_execute_params.rb

@@ -28,7 +28,14 @@ module Privy
         #   @return [String, nil]
         optional :privy_idempotency_key, String
 
-        # @!method initialize(wallet_id:, privy_authorization_signature: nil, privy_idempotency_key: nil, request_options: {})
+        # @!attribute privy_request_expiry
+        #   Request expiry. Value is a Unix timestamp in milliseconds representing the
+        #   deadline by which the request must be processed.
+        #
+        #   @return [String, nil]
+        optional :privy_request_expiry, String
+
+        # @!method initialize(wallet_id:, privy_authorization_signature: nil, privy_idempotency_key: nil, privy_request_expiry: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Privy::Models::Wallets::SwapExecuteParams} for more details.
         #
@@ -38,6 +45,8 @@ module Privy
         #
         #   @param privy_idempotency_key [String] Idempotency keys ensure API requests are executed only once within a 24-hour win
         #
+        #   @param privy_request_expiry [String] Request expiry. Value is a Unix timestamp in milliseconds representing the deadl
+        #
         #   @param request_options [Privy::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/privy/models/wallets/swap_quote_params.rb

@@ -21,7 +21,14 @@ module Privy
         #   @return [String, nil]
         optional :privy_authorization_signature, String
 
-        # @!method initialize(wallet_id:, privy_authorization_signature: nil, request_options: {})
+        # @!attribute privy_request_expiry
+        #   Request expiry. Value is a Unix timestamp in milliseconds representing the
+        #   deadline by which the request must be processed.
+        #
+        #   @return [String, nil]
+        optional :privy_request_expiry, String
+
+        # @!method initialize(wallet_id:, privy_authorization_signature: nil, privy_request_expiry: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Privy::Models::Wallets::SwapQuoteParams} for more details.
         #
@@ -29,6 +36,8 @@ module Privy
         #
         #   @param privy_authorization_signature [String] Request authorization signature. If multiple signatures are required, they shoul
         #
+        #   @param privy_request_expiry [String] Request expiry. Value is a Unix timestamp in milliseconds representing the deadl
+        #
         #   @param request_options [Privy::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/privy/models/wallets/transaction_get_params.rb

@@ -38,6 +38,12 @@ module Privy
         #   @return [String, nil]
         optional :cursor, String
 
+        # @!attribute include_archived
+        #   Include archived wallets in lookup. Defaults to false.
+        #
+        #   @return [Boolean, nil]
+        optional :include_archived, Privy::Internal::Type::Boolean
+
         # @!attribute limit
         #
         #   @return [Float, nil]
@@ -48,7 +54,7 @@ module Privy
         #   @return [String, nil]
         optional :tx_hash, String
 
-        # @!method initialize(wallet_id:, chain:, token: nil, asset: nil, cursor: nil, limit: nil, tx_hash: nil, request_options: {})
+        # @!method initialize(wallet_id:, chain:, token: nil, asset: nil, cursor: nil, include_archived: nil, limit: nil, tx_hash: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Privy::Models::Wallets::TransactionGetParams} for more details.
         #
@@ -62,6 +68,8 @@ module Privy
         #
         #   @param cursor [String]
         #
+        #   @param include_archived [Boolean] Include archived wallets in lookup. Defaults to false.
+        #
         #   @param limit [Float, nil]
         #
         #   @param tx_hash [String]
@@ -113,6 +121,8 @@ module Privy
 
           variant const: -> { Privy::Models::Wallets::TransactionGetParams::Asset::ETH }
 
+          variant const: -> { Privy::Models::Wallets::TransactionGetParams::Asset::AVAX }
+
           variant const: -> { Privy::Models::Wallets::TransactionGetParams::Asset::POL }
 
           variant const: -> { Privy::Models::Wallets::TransactionGetParams::Asset::USDT }
@@ -142,6 +152,7 @@ module Privy
           USDC = :usdc
           USDC_E = :"usdc.e"
           ETH = :eth
+          AVAX = :avax
           POL = :pol
           USDT = :usdt
           EURC = :eurc

data/lib/privy/models/wallets/transaction_get_response.rb

@@ -43,9 +43,10 @@ module Privy
           required :privy_transaction_id, String
 
           # @!attribute status
+          #   Status of a blockchain transaction submitted by Privy.
           #
-          #   @return [Symbol, Privy::Models::Wallets::TransactionGetResponse::Transaction::Status]
-          required :status, enum: -> { Privy::Models::Wallets::TransactionGetResponse::Transaction::Status }
+          #   @return [Symbol, Privy::Models::BlockchainTransactionStatus]
+          required :status, enum: -> { Privy::BlockchainTransactionStatus }
 
           # @!attribute transaction_hash
           #
@@ -76,7 +77,7 @@ module Privy
           #
           #   @param privy_transaction_id [String]
           #
-          #   @param status [Symbol, Privy::Models::Wallets::TransactionGetResponse::Transaction::Status]
+          #   @param status [Symbol, Privy::Models::BlockchainTransactionStatus] Status of a blockchain transaction submitted by Privy.
           #
           #   @param transaction_hash [String, nil]
           #
@@ -91,23 +92,6 @@ module Privy
             # @!method initialize
             #   Details of a wallet transaction, varying by transaction type.
           end
-
-          # @see Privy::Models::Wallets::TransactionGetResponse::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