privy_ruby 0.1.0 → 0.3.0

data/rbi/privy/models/kraken_embed_get_portfolio_summary_query_params.rbi

@@ -11,11 +11,11 @@ module Privy
           )
         end
 
+      # A string-encoded boolean query parameter on including current day profit and
+      # loss.
       sig do
         returns(
-          T.nilable(
-            Privy::KrakenEmbedGetPortfolioSummaryQueryParams::IncludeCurrentDayPnl::OrSymbol
-          )
+          T.nilable(Privy::KrakenEmbedIncludeCurrentDayPnlQueryParam::OrSymbol)
         )
       end
       attr_reader :include_current_day_pnl
@@ -23,7 +23,7 @@ module Privy
       sig do
         params(
           include_current_day_pnl:
-            Privy::KrakenEmbedGetPortfolioSummaryQueryParams::IncludeCurrentDayPnl::OrSymbol
+            Privy::KrakenEmbedIncludeCurrentDayPnlQueryParam::OrSymbol
         ).void
       end
       attr_writer :include_current_day_pnl
@@ -38,58 +38,29 @@ module Privy
       sig do
         params(
           include_current_day_pnl:
-            Privy::KrakenEmbedGetPortfolioSummaryQueryParams::IncludeCurrentDayPnl::OrSymbol,
+            Privy::KrakenEmbedIncludeCurrentDayPnlQueryParam::OrSymbol,
           quote: String
         ).returns(T.attached_class)
       end
-      def self.new(include_current_day_pnl: nil, quote: nil)
+      def self.new(
+        # A string-encoded boolean query parameter on including current day profit and
+        # loss.
+        include_current_day_pnl: nil,
+        quote: nil
+      )
       end
 
       sig do
         override.returns(
           {
             include_current_day_pnl:
-              Privy::KrakenEmbedGetPortfolioSummaryQueryParams::IncludeCurrentDayPnl::OrSymbol,
+              Privy::KrakenEmbedIncludeCurrentDayPnlQueryParam::OrSymbol,
             quote: String
           }
         )
       end
       def to_hash
       end
-
-      module IncludeCurrentDayPnl
-        extend Privy::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Privy::KrakenEmbedGetPortfolioSummaryQueryParams::IncludeCurrentDayPnl
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        TRUE =
-          T.let(
-            :true,
-            Privy::KrakenEmbedGetPortfolioSummaryQueryParams::IncludeCurrentDayPnl::TaggedSymbol
-          )
-        FALSE =
-          T.let(
-            :false,
-            Privy::KrakenEmbedGetPortfolioSummaryQueryParams::IncludeCurrentDayPnl::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioSummaryQueryParams::IncludeCurrentDayPnl::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/privy/models/kraken_embed_get_portfolio_summary_response.rbi

@@ -11,13 +11,13 @@ module Privy
           )
         end
 
-      sig { returns(Privy::KrakenEmbedGetPortfolioSummaryResponse::Data) }
+      # Kraken API response envelope for portfolio summary, containing optional errors
+      # and the result payload.
+      sig { returns(Privy::KrakenEmbedGetPortfolioSummaryResult) }
       attr_reader :data
 
       sig do
-        params(
-          data: Privy::KrakenEmbedGetPortfolioSummaryResponse::Data::OrHash
-        ).void
+        params(data: Privy::KrakenEmbedGetPortfolioSummaryResult::OrHash).void
       end
       attr_writer :data
 
@@ -25,182 +25,21 @@ module Privy
       # balance, and unrealized P&L.
       sig do
         params(
-          data: Privy::KrakenEmbedGetPortfolioSummaryResponse::Data::OrHash
+          data: Privy::KrakenEmbedGetPortfolioSummaryResult::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(data:)
+      def self.new(
+        # Kraken API response envelope for portfolio summary, containing optional errors
+        # and the result payload.
+        data:
+      )
       end
 
       sig do
-        override.returns(
-          { data: Privy::KrakenEmbedGetPortfolioSummaryResponse::Data }
-        )
+        override.returns({ data: Privy::KrakenEmbedGetPortfolioSummaryResult })
       end
       def to_hash
       end
-
-      class Data < Privy::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Privy::KrakenEmbedGetPortfolioSummaryResponse::Data,
-              Privy::Internal::AnyHash
-            )
-          end
-
-        sig do
-          returns(
-            T.nilable(
-              Privy::KrakenEmbedGetPortfolioSummaryResponse::Data::Result
-            )
-          )
-        end
-        attr_reader :result
-
-        sig do
-          params(
-            result:
-              T.nilable(
-                Privy::KrakenEmbedGetPortfolioSummaryResponse::Data::Result::OrHash
-              )
-          ).void
-        end
-        attr_writer :result
-
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_reader :error
-
-        sig { params(error: T::Array[String]).void }
-        attr_writer :error
-
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_reader :errors
-
-        sig { params(errors: T::Array[String]).void }
-        attr_writer :errors
-
-        sig do
-          params(
-            result:
-              T.nilable(
-                Privy::KrakenEmbedGetPortfolioSummaryResponse::Data::Result::OrHash
-              ),
-            error: T::Array[String],
-            errors: T::Array[String]
-          ).returns(T.attached_class)
-        end
-        def self.new(result:, error: nil, errors: nil)
-        end
-
-        sig do
-          override.returns(
-            {
-              result:
-                T.nilable(
-                  Privy::KrakenEmbedGetPortfolioSummaryResponse::Data::Result
-                ),
-              error: T::Array[String],
-              errors: T::Array[String]
-            }
-          )
-        end
-        def to_hash
-        end
-
-        class Result < Privy::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Privy::KrakenEmbedGetPortfolioSummaryResponse::Data::Result,
-                Privy::Internal::AnyHash
-              )
-            end
-
-          sig { returns(String) }
-          attr_accessor :available_balance
-
-          sig { returns(String) }
-          attr_accessor :currency
-
-          sig { returns(String) }
-          attr_accessor :open_orders
-
-          sig { returns(String) }
-          attr_accessor :portfolio_value
-
-          sig { returns(Time) }
-          attr_accessor :timestamp
-
-          sig { returns(String) }
-          attr_accessor :withheld_value
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :cost_basis
-
-          # Current day profit and loss for a portfolio, calculated from the most recent
-          # available balance.
-          sig { returns(T.nilable(Privy::KrakenEmbedCurrentDayPnl)) }
-          attr_reader :current_day_pnl
-
-          sig do
-            params(
-              current_day_pnl:
-                T.nilable(Privy::KrakenEmbedCurrentDayPnl::OrHash)
-            ).void
-          end
-          attr_writer :current_day_pnl
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :lots_upnl
-
-          sig do
-            params(
-              available_balance: String,
-              currency: String,
-              open_orders: String,
-              portfolio_value: String,
-              timestamp: Time,
-              withheld_value: String,
-              cost_basis: T.nilable(String),
-              current_day_pnl:
-                T.nilable(Privy::KrakenEmbedCurrentDayPnl::OrHash),
-              lots_upnl: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            available_balance:,
-            currency:,
-            open_orders:,
-            portfolio_value:,
-            timestamp:,
-            withheld_value:,
-            cost_basis: nil,
-            # Current day profit and loss for a portfolio, calculated from the most recent
-            # available balance.
-            current_day_pnl: nil,
-            lots_upnl: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                available_balance: String,
-                currency: String,
-                open_orders: String,
-                portfolio_value: String,
-                timestamp: Time,
-                withheld_value: String,
-                cost_basis: T.nilable(String),
-                current_day_pnl: T.nilable(Privy::KrakenEmbedCurrentDayPnl),
-                lots_upnl: T.nilable(String)
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-      end
     end
   end
 end

data/rbi/privy/models/kraken_embed_get_portfolio_summary_result.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module Privy
+  module Models
+    class KrakenEmbedGetPortfolioSummaryResult < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::KrakenEmbedGetPortfolioSummaryResult,
+            Privy::Internal::AnyHash
+          )
+        end
+
+      # Portfolio summary payload containing balances, value, and profit/loss
+      # information.
+      sig { returns(T.nilable(Privy::KrakenEmbedPortfolioSummaryPayload)) }
+      attr_reader :result
+
+      sig do
+        params(
+          result: T.nilable(Privy::KrakenEmbedPortfolioSummaryPayload::OrHash)
+        ).void
+      end
+      attr_writer :result
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :error
+
+      sig { params(error: T::Array[String]).void }
+      attr_writer :error
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :errors
+
+      sig { params(errors: T::Array[String]).void }
+      attr_writer :errors
+
+      # Kraken API response envelope for portfolio summary, containing optional errors
+      # and the result payload.
+      sig do
+        params(
+          result: T.nilable(Privy::KrakenEmbedPortfolioSummaryPayload::OrHash),
+          error: T::Array[String],
+          errors: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Portfolio summary payload containing balances, value, and profit/loss
+        # information.
+        result:,
+        error: nil,
+        errors: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            result: T.nilable(Privy::KrakenEmbedPortfolioSummaryPayload),
+            error: T::Array[String],
+            errors: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/privy/models/kraken_embed_get_portfolio_transactions_query_params_schema.rbi

@@ -49,80 +49,49 @@ module Privy
 
       sig do
         returns(
-          T.nilable(
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID
-            ]
-          )
+          T.nilable(T::Array[Privy::KrakenEmbedPortfolioTransactionRefID])
         )
       end
       attr_reader :ref_ids
 
       sig do
         params(
-          ref_ids:
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID::OrHash
-            ]
+          ref_ids: T::Array[Privy::KrakenEmbedPortfolioTransactionRefID::OrHash]
         ).void
       end
       attr_writer :ref_ids
 
-      sig do
-        returns(
-          T.nilable(
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Sorting::OrSymbol
-          )
-        )
-      end
+      # Sort direction for paginated transaction lists.
+      sig { returns(T.nilable(Privy::KrakenEmbedSortingOrder::OrSymbol)) }
       attr_reader :sorting
 
-      sig do
-        params(
-          sorting:
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Sorting::OrSymbol
-        ).void
-      end
+      sig { params(sorting: Privy::KrakenEmbedSortingOrder::OrSymbol).void }
       attr_writer :sorting
 
       sig do
         returns(
-          T.nilable(
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Status::OrSymbol
-            ]
-          )
+          T.nilable(T::Array[Privy::KrakenEmbedTransactionStatus::OrSymbol])
         )
       end
       attr_reader :statuses
 
       sig do
         params(
-          statuses:
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Status::OrSymbol
-            ]
+          statuses: T::Array[Privy::KrakenEmbedTransactionStatus::OrSymbol]
         ).void
       end
       attr_writer :statuses
 
       sig do
         returns(
-          T.nilable(
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Type::OrSymbol
-            ]
-          )
+          T.nilable(T::Array[Privy::KrakenEmbedTransactionType::OrSymbol])
         )
       end
       attr_reader :types
 
       sig do
         params(
-          types:
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Type::OrSymbol
-            ]
+          types: T::Array[Privy::KrakenEmbedTransactionType::OrSymbol]
         ).void
       end
       attr_writer :types
@@ -143,19 +112,10 @@ module Privy
           page_size: Integer,
           quote: String,
           ref_ids:
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID::OrHash
-            ],
-          sorting:
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Sorting::OrSymbol,
-          statuses:
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Status::OrSymbol
-            ],
-          types:
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Type::OrSymbol
-            ],
+            T::Array[Privy::KrakenEmbedPortfolioTransactionRefID::OrHash],
+          sorting: Privy::KrakenEmbedSortingOrder::OrSymbol,
+          statuses: T::Array[Privy::KrakenEmbedTransactionStatus::OrSymbol],
+          types: T::Array[Privy::KrakenEmbedTransactionType::OrSymbol],
           until_time: Time
         ).returns(T.attached_class)
       end
@@ -167,6 +127,7 @@ module Privy
         page_size: nil,
         quote: nil,
         ref_ids: nil,
+        # Sort direction for paginated transaction lists.
         sorting: nil,
         statuses: nil,
         types: nil,
@@ -183,219 +144,16 @@ module Privy
             ids: T::Array[String],
             page_size: Integer,
             quote: String,
-            ref_ids:
-              T::Array[
-                Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID
-              ],
-            sorting:
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Sorting::OrSymbol,
-            statuses:
-              T::Array[
-                Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Status::OrSymbol
-              ],
-            types:
-              T::Array[
-                Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Type::OrSymbol
-              ],
+            ref_ids: T::Array[Privy::KrakenEmbedPortfolioTransactionRefID],
+            sorting: Privy::KrakenEmbedSortingOrder::OrSymbol,
+            statuses: T::Array[Privy::KrakenEmbedTransactionStatus::OrSymbol],
+            types: T::Array[Privy::KrakenEmbedTransactionType::OrSymbol],
             until_time: Time
           }
         )
       end
       def to_hash
       end
-
-      class RefID < Privy::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID,
-              Privy::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :ref_id
-
-        sig do
-          returns(
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID::Type::OrSymbol
-          )
-        end
-        attr_accessor :type
-
-        sig do
-          params(
-            ref_id: String,
-            type:
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID::Type::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(ref_id:, type:)
-        end
-
-        sig do
-          override.returns(
-            {
-              ref_id: String,
-              type:
-                Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID::Type::OrSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        module Type
-          extend Privy::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID::Type
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          SIMPLE_ORDER_QUOTE =
-            T.let(
-              :simple_order_quote,
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID::Type::TaggedSymbol
-            )
-          SIMPLE_ORDER_QUOTE_FAILED =
-            T.let(
-              :simple_order_quote_failed,
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID::Type::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::RefID::Type::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
-      module Sorting
-        extend Privy::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Sorting
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        DESCENDING =
-          T.let(
-            :descending,
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Sorting::TaggedSymbol
-          )
-        ASCENDING =
-          T.let(
-            :ascending,
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Sorting::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Sorting::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
-      module Status
-        extend Privy::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Status
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        UNSPECIFIED =
-          T.let(
-            :unspecified,
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Status::TaggedSymbol
-          )
-        IN_PROGRESS =
-          T.let(
-            :in_progress,
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Status::TaggedSymbol
-          )
-        SUCCESSFUL =
-          T.let(
-            :successful,
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Status::TaggedSymbol
-          )
-        FAILED =
-          T.let(
-            :failed,
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Status::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Status::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
-      module Type
-        extend Privy::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Type
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        SIMPLE_ORDER =
-          T.let(
-            :simple_order,
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Type::TaggedSymbol
-          )
-        SIMPLE_ORDER_FAILED =
-          T.let(
-            :simple_order_failed,
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Type::TaggedSymbol
-          )
-        EARN_REWARD =
-          T.let(
-            :earn_reward,
-            Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Type::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Privy::KrakenEmbedGetPortfolioTransactionsQueryParamsSchema::Type::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end