class FinnhubRuby::Transactions

Attributes

change[RW]

Number of share changed from the last period. A positive value suggests a BUY transaction. A negative value suggests a SELL transaction.

filing_date[RW]

Filing date.

name[RW]

Insider's name.

share[RW]

Number of shares held after the transaction.

transaction_code[RW]

Transaction code. A list of codes and their meanings can be found <a href="www.sec.gov/about/forms/form4data.pdf" target="_blank" rel="noopener">here</a>.

transaction_date[RW]

Transaction date.

transaction_price[RW]

Average transaction price.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/finnhub_ruby/models/transactions.rb, line 53
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/finnhub_ruby/models/transactions.rb, line 40
def self.attribute_map
  {
    :'name' => :'name',
    :'share' => :'share',
    :'change' => :'change',
    :'filing_date' => :'filingDate',
    :'transaction_date' => :'transactionDate',
    :'transaction_price' => :'transactionPrice',
    :'transaction_code' => :'transactionCode'
  }
end
build_from_hash(attributes) click to toggle source

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/transactions.rb, line 162
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/finnhub_ruby/models/transactions.rb, line 78
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::Transactions` 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::Transactions`. 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?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'share')
    self.share = attributes[:'share']
  end

  if attributes.key?(:'change')
    self.change = attributes[:'change']
  end

  if attributes.key?(:'filing_date')
    self.filing_date = attributes[:'filing_date']
  end

  if attributes.key?(:'transaction_date')
    self.transaction_date = attributes[:'transaction_date']
  end

  if attributes.key?(:'transaction_price')
    self.transaction_price = attributes[:'transaction_price']
  end

  if attributes.key?(:'transaction_code')
    self.transaction_code = attributes[:'transaction_code']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/finnhub_ruby/models/transactions.rb, line 71
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/finnhub_ruby/models/transactions.rb, line 58
def self.openapi_types
  {
    :'name' => :'String',
    :'share' => :'Integer',
    :'change' => :'Integer',
    :'filing_date' => :'Date',
    :'transaction_date' => :'Date',
    :'transaction_price' => :'Float',
    :'transaction_code' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/finnhub_ruby/models/transactions.rb, line 135
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      share == o.share &&
      change == o.change &&
      filing_date == o.filing_date &&
      transaction_date == o.transaction_date &&
      transaction_price == o.transaction_price &&
      transaction_code == o.transaction_code
end
_deserialize(type, value) click to toggle source

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/transactions.rb, line 192
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
_to_hash(value) click to toggle source

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/transactions.rb, line 263
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
build_from_hash(attributes) click to toggle source

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/transactions.rb, line 169
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/finnhub_ruby/models/transactions.rb, line 149
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/finnhub_ruby/models/transactions.rb, line 155
def hash
  [name, share, change, filing_date, transaction_date, transaction_price, transaction_code].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/finnhub_ruby/models/transactions.rb, line 122
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/finnhub_ruby/models/transactions.rb, line 239
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/finnhub_ruby/models/transactions.rb, line 245
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/finnhub_ruby/models/transactions.rb, line 233
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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/transactions.rb, line 129
def valid?
  true
end