Class: Intrinio::DividendRecord

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

Overview

A dividend record for the identifier

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DividendRecord

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 108

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?(:'ex_dividend')
    self.ex_dividend = attributes[:'ex_dividend']
  end

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#announcement_date ⇒ Object

Date dividend was announced



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

def announcement_date
  @announcement_date
end

#currency ⇒ Object

The 3-digit currency code the dividend amount was reported in



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

def currency
  @currency
end

#ex_dividend ⇒ Object

Amount of dividend in US dollars



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

def ex_dividend
  @ex_dividend
end

#forward_rate ⇒ Object

The forward dividend rate



43
44
45
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 43

def forward_rate
  @forward_rate
end

#forward_yield ⇒ Object

The forward dividend yield



40
41
42
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 40

def forward_yield
  @forward_yield
end

#frequency ⇒ Object

Identifies payment frequency of announced dividend



34
35
36
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 34

def frequency
  @frequency
end

#last_ex_dividend_date ⇒ Object

The last reported day the stock starts trading without the value of its next dividend payment



46
47
48
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 46

def last_ex_dividend_date
  @last_ex_dividend_date
end

#pay_date ⇒ Object

Date the divdiend was paid



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

def pay_date
  @pay_date
end

#record_date ⇒ Object

Date before which holders-of-record will receive the dividend



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

def record_date
  @record_date
end

#security ⇒ Object

Returns the value of attribute security.



48
49
50
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 48

def security
  @security
end

#status ⇒ Object

Status of the dividend



37
38
39
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 37

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 73

def self.attribute_map
  {
    :'ex_dividend' => :'ex_dividend',
    :'currency' => :'currency',
    :'announcement_date' => :'announcement_date',
    :'record_date' => :'record_date',
    :'pay_date' => :'pay_date',
    :'frequency' => :'frequency',
    :'status' => :'status',
    :'forward_yield' => :'forward_yield',
    :'forward_rate' => :'forward_rate',
    :'last_ex_dividend_date' => :'last_ex_dividend_date',
    :'security' => :'security'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 90

def self.swagger_types
  {
    :'ex_dividend' => :'Float',
    :'currency' => :'String',
    :'announcement_date' => :'Date',
    :'record_date' => :'Date',
    :'pay_date' => :'Date',
    :'frequency' => :'String',
    :'status' => :'String',
    :'forward_yield' => :'Float',
    :'forward_rate' => :'Float',
    :'last_ex_dividend_date' => :'Date',
    :'security' => :'SecuritySummary'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ex_dividend == o.ex_dividend &&
      currency == o.currency &&
      announcement_date == o.announcement_date &&
      record_date == o.record_date &&
      pay_date == o.pay_date &&
      frequency == o.frequency &&
      status == o.status &&
      forward_yield == o.forward_yield &&
      forward_rate == o.forward_rate &&
      last_ex_dividend_date == o.last_ex_dividend_date &&
      security == o.security
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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 239

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 305

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 218

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


205
206
207
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 211

def hash
  [ex_dividend, currency, announcement_date, record_date, pay_date, frequency, status, forward_yield, forward_rate, last_ex_dividend_date, security].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



162
163
164
165
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 162

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



285
286
287
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 285

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



291
292
293
294
295
296
297
298
299
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 291

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



279
280
281
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 279

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



169
170
171
172
173
 
# File 'lib/intrinio-sdk/models/dividend_record.rb', line 169

def valid?
  status_validator = EnumAttributeValidator.new('String', ["P", "X", "S", "R"])
  return false unless status_validator.valid?(@status)
  return true
end