Class: Intrinio::StockPriceAdjustment

Inherits:
Object
  • Object
show all
Defined in:
lib/intrinio-sdk/models/stock_price_adjustment.rb

Overview

A stock price adjustment for a security on a given day, most frequently representing a split and/or dividend.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StockPriceAdjustment

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 58

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'date')
    self.date = attributes[:'date']
  end

  if attributes.has_key?(:'factor')
    self.factor = attributes[:'factor']
  end

  if attributes.has_key?(:'dividend')
    self.dividend = attributes[:'dividend']
  end

  if attributes.has_key?(:'dividend_currency')
    self.dividend_currency = attributes[:'dividend_currency']
  end

  if attributes.has_key?(:'split_ratio')
    self.split_ratio = attributes[:'split_ratio']
  end

end

Instance Attribute Details

#date ⇒ Object

The date on which the adjustment occurred. The adjustment should be applied to all stock prices before this date.



19
20
21
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 19

def date
  @date
end

#dividend ⇒ Object

The dividend amount, if a dividend was paid.



25
26
27
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 25

def dividend
  @dividend
end

#dividend_currency ⇒ Object

The currency of the dividend, if known.



28
29
30
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 28

def dividend_currency
  @dividend_currency
end

#factor ⇒ Object

The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.



22
23
24
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 22

def factor
  @factor
end

#split_ratio ⇒ Object

The ratio of the stock split, if a stock split occurred.



31
32
33
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 31

def split_ratio
  @split_ratio
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 35

def self.attribute_map
  {
    :'date' => :'date',
    :'factor' => :'factor',
    :'dividend' => :'dividend',
    :'dividend_currency' => :'dividend_currency',
    :'split_ratio' => :'split_ratio'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 46

def self.swagger_types
  {
    :'date' => :'Date',
    :'factor' => :'Float',
    :'dividend' => :'Float',
    :'dividend_currency' => :'String',
    :'split_ratio' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



101
102
103
104
105
106
107
108
109
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 101

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      factor == o.factor &&
      dividend == o.dividend &&
      dividend_currency == o.dividend_currency &&
      split_ratio == o.split_ratio
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 147

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = Intrinio.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 213

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 126

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


113
114
115
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 113

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 119

def hash
  [date, factor, dividend, dividend_currency, split_ratio].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



88
89
90
91
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 88

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



193
194
195
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 193

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



199
200
201
202
203
204
205
206
207
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 199

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



187
188
189
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 187

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



95
96
97
 
# File 'lib/intrinio-sdk/models/stock_price_adjustment.rb', line 95

def valid?
  return true
end