Class: Privy::Models::KrakenEmbedPortfolioSummaryPayload

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/privy/models/kraken_embed_portfolio_summary_payload.rb,
sig/privy/models/kraken_embed_portfolio_summary_payload.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(available_balance:, currency:, open_orders:, portfolio_value:, timestamp:, withheld_value:, cost_basis: nil, current_day_pnl: nil, lots_upnl: nil) ⇒ Object

Some parameter documentations has been truncated, see Privy::Models::KrakenEmbedPortfolioSummaryPayload for more details.

Portfolio summary payload containing balances, value, and profit/loss information.

Parameters:

  • available_balance (String)
  • currency (String)
  • open_orders (String)
  • portfolio_value (String)
  • timestamp (Time)
  • withheld_value (String)
  • cost_basis (String, nil) (defaults to: nil)
  • current_day_pnl (Privy::Models::KrakenEmbedCurrentDayPnl, nil) (defaults to: nil) —

    Current day profit and loss for a portfolio, calculated from the most recent ava

  • lots_upnl (String, nil) (defaults to: nil) 



# File 'lib/privy/models/kraken_embed_portfolio_summary_payload.rb', line 53

Instance Attribute Details

#available_balance ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


9
 
# File 'lib/privy/models/kraken_embed_portfolio_summary_payload.rb', line 9

required :available_balance, String

#cost_basis ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


39
 
# File 'lib/privy/models/kraken_embed_portfolio_summary_payload.rb', line 39

optional :cost_basis, String, nil?: true

#currency ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/privy/models/kraken_embed_portfolio_summary_payload.rb', line 14

required :currency, String

#current_day_pnl ⇒ Privy::Models::KrakenEmbedCurrentDayPnl?

Current day profit and loss for a portfolio, calculated from the most recent available balance.

Parameters:

Returns:



46
 
# File 'lib/privy/models/kraken_embed_portfolio_summary_payload.rb', line 46

optional :current_day_pnl, -> { Privy::KrakenEmbedCurrentDayPnl }, nil?: true

#lots_upnl ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


51
 
# File 'lib/privy/models/kraken_embed_portfolio_summary_payload.rb', line 51

optional :lots_upnl, String, nil?: true

#open_orders ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/privy/models/kraken_embed_portfolio_summary_payload.rb', line 19

required :open_orders, String

#portfolio_value ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


24
 
# File 'lib/privy/models/kraken_embed_portfolio_summary_payload.rb', line 24

required :portfolio_value, String

#timestamp ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


29
 
# File 'lib/privy/models/kraken_embed_portfolio_summary_payload.rb', line 29

required :timestamp, Time

#withheld_value ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


34
 
# File 'lib/privy/models/kraken_embed_portfolio_summary_payload.rb', line 34

required :withheld_value, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


47
 
# File 'sig/privy/models/kraken_embed_portfolio_summary_payload.rbs', line 47

def to_hash: -> {