class FinnhubRuby::Report
Attributes
Accepted date %Y-%m-%d %H:%M:%S
.
Access number.
CIK.
Period end date %Y-%m-%d %H:%M:%S
.
Filed date %Y-%m-%d %H:%M:%S
.
Form type.
Quarter.
Period start date %Y-%m-%d %H:%M:%S
.
Symbol.
Year.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/finnhub_ruby/models/report.rb, line 68 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/finnhub_ruby/models/report.rb, line 51 def self.attribute_map { :'access_number' => :'accessNumber', :'symbol' => :'symbol', :'cik' => :'cik', :'year' => :'year', :'quarter' => :'quarter', :'form' => :'form', :'start_date' => :'startDate', :'end_date' => :'endDate', :'filed_date' => :'filedDate', :'accepted_date' => :'acceptedDate', :'report' => :'report' } 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/report.rb, line 201 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/report.rb, line 97 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::Report` 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::Report`. 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?(:'access_number') self.access_number = attributes[:'access_number'] end if attributes.key?(:'symbol') self.symbol = attributes[:'symbol'] end if attributes.key?(:'cik') self.cik = attributes[:'cik'] end if attributes.key?(:'year') self.year = attributes[:'year'] end if attributes.key?(:'quarter') self.quarter = attributes[:'quarter'] end if attributes.key?(:'form') self.form = attributes[:'form'] end if attributes.key?(:'start_date') self.start_date = attributes[:'start_date'] end if attributes.key?(:'end_date') self.end_date = attributes[:'end_date'] end if attributes.key?(:'filed_date') self.filed_date = attributes[:'filed_date'] end if attributes.key?(:'accepted_date') self.accepted_date = attributes[:'accepted_date'] end if attributes.key?(:'report') self.report = attributes[:'report'] end end
List of attributes with nullable: true
# File lib/finnhub_ruby/models/report.rb, line 90 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/finnhub_ruby/models/report.rb, line 73 def self.openapi_types { :'access_number' => :'String', :'symbol' => :'String', :'cik' => :'String', :'year' => :'Integer', :'quarter' => :'Integer', :'form' => :'String', :'start_date' => :'String', :'end_date' => :'String', :'filed_date' => :'String', :'accepted_date' => :'String', :'report' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/finnhub_ruby/models/report.rb, line 170 def ==(o) return true if self.equal?(o) self.class == o.class && access_number == o.access_number && symbol == o.symbol && cik == o.cik && year == o.year && quarter == o.quarter && form == o.form && start_date == o.start_date && end_date == o.end_date && filed_date == o.filed_date && accepted_date == o.accepted_date && report == o.report 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/report.rb, line 231 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/report.rb, line 302 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/report.rb, line 208 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/report.rb, line 188 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/finnhub_ruby/models/report.rb, line 194 def hash [access_number, symbol, cik, year, quarter, form, start_date, end_date, filed_date, accepted_date, report].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/report.rb, line 157 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/report.rb, line 284 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/report.rb, line 272 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/report.rb, line 164 def valid? true end