class TinkoffInvestClient::PortfolioPosition
Attributes
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 58 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 41 def self.attribute_map { :'figi' => :'figi', :'ticker' => :'ticker', :'isin' => :'isin', :'instrument_type' => :'instrumentType', :'balance' => :'balance', :'blocked' => :'blocked', :'expected_yield' => :'expectedYield', :'lots' => :'lots', :'average_position_price' => :'averagePositionPrice', :'average_position_price_no_nkd' => :'averagePositionPriceNoNkd', :'name' => :'name' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 216 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 87 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TinkoffInvestClient::PortfolioPosition` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `TinkoffInvestClient::PortfolioPosition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'figi') self.figi = attributes[:'figi'] end if attributes.key?(:'ticker') self.ticker = attributes[:'ticker'] end if attributes.key?(:'isin') self.isin = attributes[:'isin'] end if attributes.key?(:'instrument_type') self.instrument_type = attributes[:'instrument_type'] end if attributes.key?(:'balance') self.balance = attributes[:'balance'] end if attributes.key?(:'blocked') self.blocked = attributes[:'blocked'] end if attributes.key?(:'expected_yield') self.expected_yield = attributes[:'expected_yield'] end if attributes.key?(:'lots') self.lots = attributes[:'lots'] end if attributes.key?(:'average_position_price') self.average_position_price = attributes[:'average_position_price'] end if attributes.key?(:'average_position_price_no_nkd') self.average_position_price_no_nkd = attributes[:'average_position_price_no_nkd'] end if attributes.key?(:'name') self.name = attributes[:'name'] end end
List of attributes with nullable: true
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 80 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 63 def self.openapi_types { :'figi' => :'String', :'ticker' => :'String', :'isin' => :'String', :'instrument_type' => :'InstrumentType', :'balance' => :'Float', :'blocked' => :'Float', :'expected_yield' => :'MoneyAmount', :'lots' => :'Integer', :'average_position_price' => :'MoneyAmount', :'average_position_price_no_nkd' => :'MoneyAmount', :'name' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 185 def ==(o) return true if self.equal?(o) self.class == o.class && figi == o.figi && ticker == o.ticker && isin == o.isin && instrument_type == o.instrument_type && balance == o.balance && blocked == o.blocked && expected_yield == o.expected_yield && lots == o.lots && average_position_price == o.average_position_price && average_position_price_no_nkd == o.average_position_price_no_nkd && name == o.name end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 246 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = TinkoffInvestClient.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 317 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 223 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 203 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 209 def hash [figi, ticker, isin, instrument_type, balance, blocked, expected_yield, lots, average_position_price, average_position_price_no_nkd, name].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 147 def list_invalid_properties invalid_properties = Array.new if @figi.nil? invalid_properties.push('invalid value for "figi", figi cannot be nil.') end if @instrument_type.nil? invalid_properties.push('invalid value for "instrument_type", instrument_type cannot be nil.') end if @balance.nil? invalid_properties.push('invalid value for "balance", balance cannot be nil.') end if @lots.nil? invalid_properties.push('invalid value for "lots", lots cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 299 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 287 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/tinkoff_invest_client/models/portfolio_position.rb, line 174 def valid? return false if @figi.nil? return false if @instrument_type.nil? return false if @balance.nil? return false if @lots.nil? return false if @name.nil? true end