Class: Intrinio::InstitutionalHolding

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

Overview

A single institutional holding for an owner.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstitutionalHolding

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/institutional_holding.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#amount ⇒ Object

The number of shares held in the listed security



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

def amount
  @amount
end

#cusip ⇒ Object

The CUSIP number for the security report by the Institutional Owner



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

def cusip
  @cusip
end

#filing_date ⇒ Object

The date when the filing was submitted to the SEC by the company



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

def filing_date
  @filing_date
end

#investment_discretion ⇒ Object

Segregate the holdings of securities of a class according to the nature of the investment discretion held by the Manager.



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

def investment_discretion
  @investment_discretion
end

#no_voting_authority ⇒ Object

The number of shares where the insitutional holder has no voting authority



64
65
66
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 64

def no_voting_authority
  @no_voting_authority
end

#other_manager ⇒ Object

A code for other managerial authority of the securities listed



55
56
57
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 55

def other_manager
  @other_manager
end

#period_ended ⇒ Object

The date of the latest 13-F filing on record with the SEC.



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

def period_ended
  @period_ended
end

#security_name ⇒ Object

The name of the security



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

def security_name
  @security_name
end

#security_type ⇒ Object

The type of the security



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

def security_type
  @security_type
end

#shared_voting_authority ⇒ Object

The number of shares where the insitutional holder has shared voting authority



61
62
63
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 61

def shared_voting_authority
  @shared_voting_authority
end

#sole_voting_authority ⇒ Object

The number of shares where the insitutional holder has sole voting authority



58
59
60
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 58

def sole_voting_authority
  @sole_voting_authority
end

#stock_exchange ⇒ Object

The stock exchange where the security is traded



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

def stock_exchange
  @stock_exchange
end

#ticker ⇒ Object

The ticker symbol for the security



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

def ticker
  @ticker
end

#title_of_class ⇒ Object

The class of stock held



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

def title_of_class
  @title_of_class
end

#type ⇒ Object

Shares



49
50
51
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 49

def type
  @type
end

#value ⇒ Object

The market value in amount of dollars of the holding in the listed security



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

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'cusip' => :'cusip',
    :'ticker' => :'ticker',
    :'security_name' => :'security_name',
    :'security_type' => :'security_type',
    :'title_of_class' => :'title_of_class',
    :'stock_exchange' => :'stock_exchange',
    :'period_ended' => :'period_ended',
    :'filing_date' => :'filing_date',
    :'value' => :'value',
    :'amount' => :'amount',
    :'type' => :'type',
    :'investment_discretion' => :'investment_discretion',
    :'other_manager' => :'other_manager',
    :'sole_voting_authority' => :'sole_voting_authority',
    :'shared_voting_authority' => :'shared_voting_authority',
    :'no_voting_authority' => :'no_voting_authority'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'cusip' => :'String',
    :'ticker' => :'String',
    :'security_name' => :'String',
    :'security_type' => :'String',
    :'title_of_class' => :'String',
    :'stock_exchange' => :'String',
    :'period_ended' => :'Date',
    :'filing_date' => :'Date',
    :'value' => :'Float',
    :'amount' => :'Float',
    :'type' => :'String',
    :'investment_discretion' => :'String',
    :'other_manager' => :'String',
    :'sole_voting_authority' => :'Float',
    :'shared_voting_authority' => :'Float',
    :'no_voting_authority' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cusip == o.cusip &&
      ticker == o.ticker &&
      security_name == o.security_name &&
      security_type == o.security_type &&
      title_of_class == o.title_of_class &&
      stock_exchange == o.stock_exchange &&
      period_ended == o.period_ended &&
      filing_date == o.filing_date &&
      value == o.value &&
      amount == o.amount &&
      type == o.type &&
      investment_discretion == o.investment_discretion &&
      other_manager == o.other_manager &&
      sole_voting_authority == o.sole_voting_authority &&
      shared_voting_authority == o.shared_voting_authority &&
      no_voting_authority == o.no_voting_authority
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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 257

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 323

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 236

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


223
224
225
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



229
230
231
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 229

def hash
  [cusip, ticker, security_name, security_type, title_of_class, stock_exchange, period_ended, filing_date, value, amount, type, investment_discretion, other_manager, sole_voting_authority, shared_voting_authority, no_voting_authority].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



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

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



303
304
305
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 303

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



309
310
311
312
313
314
315
316
317
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 309

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



297
298
299
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 297

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



194
195
196
 
# File 'lib/intrinio-sdk/models/institutional_holding.rb', line 194

def valid?
  return true
end