Class: Intrinio::ZacksInstitutionalHolding

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

Overview

Returns a list of all ownership interests and the value of their interests sourced from Zacks.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ZacksInstitutionalHolding

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
96
97
98
99
100
101
102
103
104
105
106
107
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
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 95

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'historical_holdings')
    if (value = attributes[:'historical_holdings']).is_a?(Array)
      self.historical_holdings = value
    end
  end

end

Instance Attribute Details

#as_of_date ⇒ Object

Quarter end date listed in the most recent 13F report filed by the institution



23
24
25
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 23

def as_of_date
  @as_of_date
end

#company ⇒ Object

Returns the value of attribute company.



18
19
20
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 18

def company
  @company
end

#historical_holdings ⇒ Object

Returns the value of attribute historical_holdings.



52
53
54
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 52

def historical_holdings
  @historical_holdings
end

#last_sec_filing_date ⇒ Object

The date of the latest SEC filing



47
48
49
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 47

def last_sec_filing_date
  @last_sec_filing_date
end

#last_sec_filing_shares ⇒ Object

The



50
51
52
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 50

def last_sec_filing_shares
  @last_sec_filing_shares
end

#last_sec_filing_type ⇒ Object

The report type of the latest SEC filing



44
45
46
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 44

def last_sec_filing_type
  @last_sec_filing_type
end

#market_value ⇒ Object

Market value of shares outstanding held of the stock listed



38
39
40
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 38

def market_value
  @market_value
end

#market_value_change ⇒ Object

Change in market value shares of the stock listed



41
42
43
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 41

def market_value_change
  @market_value_change
end

#owner ⇒ Object

Returns the value of attribute owner.



20
21
22
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 20

def owner
  @owner
end

#shared_held_percent ⇒ Object

Percent of shares outstanding held of the stock by the institution listed



29
30
31
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 29

def shared_held_percent
  @shared_held_percent
end

#shares_change ⇒ Object

Change in shares of the stock held by the institution listed



32
33
34
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 32

def shares_change
  @shares_change
end

#shares_change_percent ⇒ Object

Percentage change in shares of the stock held by the institution listed



35
36
37
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 35

def shares_change_percent
  @shares_change_percent
end

#shares_held ⇒ Object

Number of shares of the stock listed



26
27
28
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 26

def shares_held
  @shares_held
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 56

def self.attribute_map
  {
    :'company' => :'company',
    :'owner' => :'owner',
    :'as_of_date' => :'as_of_date',
    :'shares_held' => :'shares_held',
    :'shared_held_percent' => :'shared_held_percent',
    :'shares_change' => :'shares_change',
    :'shares_change_percent' => :'shares_change_percent',
    :'market_value' => :'market_value',
    :'market_value_change' => :'market_value_change',
    :'last_sec_filing_type' => :'last_sec_filing_type',
    :'last_sec_filing_date' => :'last_sec_filing_date',
    :'last_sec_filing_shares' => :'last_sec_filing_shares',
    :'historical_holdings' => :'historical_holdings'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 75

def self.swagger_types
  {
    :'company' => :'ZacksInstitutionalHoldingCompanySummary',
    :'owner' => :'ZacksInstitutionalHoldingOwnerSummary',
    :'as_of_date' => :'Date',
    :'shares_held' => :'Float',
    :'shared_held_percent' => :'Float',
    :'shares_change' => :'Float',
    :'shares_change_percent' => :'Float',
    :'market_value' => :'Float',
    :'market_value_change' => :'Float',
    :'last_sec_filing_type' => :'String',
    :'last_sec_filing_date' => :'Date',
    :'last_sec_filing_shares' => :'Float',
    :'historical_holdings' => :'Array<ZacksInstitutionalHoldingHistoricalSummary>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      company == o.company &&
      owner == o.owner &&
      as_of_date == o.as_of_date &&
      shares_held == o.shares_held &&
      shared_held_percent == o.shared_held_percent &&
      shares_change == o.shares_change &&
      shares_change_percent == o.shares_change_percent &&
      market_value == o.market_value &&
      market_value_change == o.market_value_change &&
      last_sec_filing_type == o.last_sec_filing_type &&
      last_sec_filing_date == o.last_sec_filing_date &&
      last_sec_filing_shares == o.last_sec_filing_shares &&
      historical_holdings == o.historical_holdings
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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 226

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 292

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 205

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


192
193
194
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



198
199
200
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 198

def hash
  [company, owner, as_of_date, shares_held, shared_held_percent, shares_change, shares_change_percent, market_value, market_value_change, last_sec_filing_type, last_sec_filing_date, last_sec_filing_shares, historical_holdings].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



159
160
161
162
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 159

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



272
273
274
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 272

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



278
279
280
281
282
283
284
285
286
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 278

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



266
267
268
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 266

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



166
167
168
 
# File 'lib/intrinio-sdk/models/zacks_institutional_holding.rb', line 166

def valid?
  return true
end