class FinnhubRuby::Dividends
Attributes
Adjusted dividend.
Amount in local currency.
Currency.
Ex-Dividend date.
Declaration date.
Pay date.
Record date.
Symbol.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/finnhub_ruby/models/dividends.rb, line 57 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/finnhub_ruby/models/dividends.rb, line 43 def self.attribute_map { :'symbol' => :'symbol', :'date' => :'date', :'amount' => :'amount', :'adjusted_amount' => :'adjustedAmount', :'pay_date' => :'payDate', :'record_date' => :'recordDate', :'declaration_date' => :'declarationDate', :'currency' => :'currency' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/finnhub_ruby/models/dividends.rb, line 172 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/finnhub_ruby/models/dividends.rb, line 83 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::Dividends` 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 `FinnhubRuby::Dividends`. 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?(:'symbol') self.symbol = attributes[:'symbol'] end if attributes.key?(:'date') self.date = attributes[:'date'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'adjusted_amount') self.adjusted_amount = attributes[:'adjusted_amount'] end if attributes.key?(:'pay_date') self.pay_date = attributes[:'pay_date'] end if attributes.key?(:'record_date') self.record_date = attributes[:'record_date'] end if attributes.key?(:'declaration_date') self.declaration_date = attributes[:'declaration_date'] end if attributes.key?(:'currency') self.currency = attributes[:'currency'] end end
List of attributes with nullable: true
# File lib/finnhub_ruby/models/dividends.rb, line 76 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/finnhub_ruby/models/dividends.rb, line 62 def self.openapi_types { :'symbol' => :'String', :'date' => :'Date', :'amount' => :'Float', :'adjusted_amount' => :'Float', :'pay_date' => :'Date', :'record_date' => :'Date', :'declaration_date' => :'Date', :'currency' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/finnhub_ruby/models/dividends.rb, line 144 def ==(o) return true if self.equal?(o) self.class == o.class && symbol == o.symbol && date == o.date && amount == o.amount && adjusted_amount == o.adjusted_amount && pay_date == o.pay_date && record_date == o.record_date && declaration_date == o.declaration_date && currency == o.currency 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/finnhub_ruby/models/dividends.rb, line 202 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 = FinnhubRuby.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/finnhub_ruby/models/dividends.rb, line 273 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/finnhub_ruby/models/dividends.rb, line 179 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/finnhub_ruby/models/dividends.rb, line 159 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/finnhub_ruby/models/dividends.rb, line 165 def hash [symbol, date, amount, adjusted_amount, pay_date, record_date, declaration_date, currency].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/finnhub_ruby/models/dividends.rb, line 131 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/finnhub_ruby/models/dividends.rb, line 255 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/finnhub_ruby/models/dividends.rb, line 243 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/finnhub_ruby/models/dividends.rb, line 138 def valid? true end