Class: Intrinio::InsiderTransaction

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

Overview

A transaction where the owner is considered an insider of that company. Criteria for being an insider include being a director, officer, or 10%+ owner in the company. Transactions are detailed for both non-derivative and derivative transactions by the insider.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InsiderTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 128

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#acquisition_disposition_code ⇒ Object

A symbol representing whether or not the derivative securities are Acquired or Disposed; A = Acquisition | D = Disposition



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

def acquisition_disposition_code
  @acquisition_disposition_code
end

#amount_of_shares ⇒ Object

The number of derivative securities involved in the subject transaction



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

def amount_of_shares
  @amount_of_shares
end

#company ⇒ Object

The company associated with the filing



70
71
72
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 70

def company
  @company
end

#conversion_exercise_price ⇒ Object

The conversion or exercise price of the derivative security transacted



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

def conversion_exercise_price
  @conversion_exercise_price
end

#derivative_transaction ⇒ Object

(true) A boolean indicating the transaction is a derivative transaction, which may or may not become common stock due to various possible exercise or conversion requirements



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

def derivative_transaction
  @derivative_transaction
end

#director ⇒ Object

(true/false) A boolean indicating whether or not the owner is a director in the company



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

def director
  @director
end

#officer ⇒ Object

(true/false) A boolean indicating whether or not the owner is a officer in the company



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

def officer
  @officer
end

#officer_title ⇒ Object

The officer title of the owner in the company



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

def officer_title
  @officer_title
end

#other_relation ⇒ Object

(true/false) A boolean indicating whether or not the owner has another relationship with the company beside, direct, officer, or significant owner in the company



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

def other_relation
  @other_relation
end

#owner ⇒ Object

The owner associated with the filing



73
74
75
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 73

def owner
  @owner
end

#ownership_type_code ⇒ Object

A symbol representing the ownership of the securities transacted; D = Direct Ownership | I = Indirect Ownership



67
68
69
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 67

def ownership_type_code
  @ownership_type_code
end

#security_title ⇒ Object

The name of the derivative security transacted



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

def security_title
  @security_title
end

#ten_percent_owner ⇒ Object

(true/false) A boolean indicating whether or not the owner has a ten percent or greater interest in the company



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

def ten_percent_owner
  @ten_percent_owner
end

#ticker ⇒ Object

The ticker symbol for the company’s common stock



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

def ticker
  @ticker
end

#total_shares_owned ⇒ Object

The total number of derivative securities owned following the subject transaction



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

def total_shares_owned
  @total_shares_owned
end

#transaction_price ⇒ Object

The price of the derivative securities



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

def transaction_price
  @transaction_price
end

#transaction_type_code ⇒ Object

A symbol representing the transaction type; P = Purchase | S = Sale | A = Award | M = Conversion to Common | C = Conversion | X = Exercise of Derivative More Transaction Codes



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

def transaction_type_code
  @transaction_type_code
end

#underlying_security_title ⇒ Object

The name of the underlying non-derivative security related to this derivative transaction



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

def underlying_security_title
  @underlying_security_title
end

#underlying_shares ⇒ Object

The number of non-derivative shares involved in the subject transaction



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

def underlying_shares
  @underlying_shares
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 77

def self.attribute_map
  {
    :'director' => :'director',
    :'officer' => :'officer',
    :'ten_percent_owner' => :'ten_percent_owner',
    :'other_relation' => :'other_relation',
    :'officer_title' => :'officer_title',
    :'derivative_transaction' => :'derivative_transaction',
    :'ticker' => :'ticker',
    :'security_title' => :'security_title',
    :'conversion_exercise_price' => :'conversion_exercise_price',
    :'transaction_type_code' => :'transaction_type_code',
    :'acquisition_disposition_code' => :'acquisition_disposition_code',
    :'amount_of_shares' => :'amount_of_shares',
    :'underlying_security_title' => :'underlying_security_title',
    :'underlying_shares' => :'underlying_shares',
    :'transaction_price' => :'transaction_price',
    :'total_shares_owned' => :'total_shares_owned',
    :'ownership_type_code' => :'ownership_type_code',
    :'company' => :'company',
    :'owner' => :'owner'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 102

def self.swagger_types
  {
    :'director' => :'BOOLEAN',
    :'officer' => :'BOOLEAN',
    :'ten_percent_owner' => :'BOOLEAN',
    :'other_relation' => :'BOOLEAN',
    :'officer_title' => :'String',
    :'derivative_transaction' => :'BOOLEAN',
    :'ticker' => :'String',
    :'security_title' => :'String',
    :'conversion_exercise_price' => :'Float',
    :'transaction_type_code' => :'String',
    :'acquisition_disposition_code' => :'String',
    :'amount_of_shares' => :'Float',
    :'underlying_security_title' => :'String',
    :'underlying_shares' => :'Float',
    :'transaction_price' => :'Float',
    :'total_shares_owned' => :'Float',
    :'ownership_type_code' => :'String',
    :'company' => :'CompanySummary',
    :'owner' => :'OwnerSummary'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      director == o.director &&
      officer == o.officer &&
      ten_percent_owner == o.ten_percent_owner &&
      other_relation == o.other_relation &&
      officer_title == o.officer_title &&
      derivative_transaction == o.derivative_transaction &&
      ticker == o.ticker &&
      security_title == o.security_title &&
      conversion_exercise_price == o.conversion_exercise_price &&
      transaction_type_code == o.transaction_type_code &&
      acquisition_disposition_code == o.acquisition_disposition_code &&
      amount_of_shares == o.amount_of_shares &&
      underlying_security_title == o.underlying_security_title &&
      underlying_shares == o.underlying_shares &&
      transaction_price == o.transaction_price &&
      total_shares_owned == o.total_shares_owned &&
      ownership_type_code == o.ownership_type_code &&
      company == o.company &&
      owner == o.owner
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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 287

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 353

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 266

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


253
254
255
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



259
260
261
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 259

def hash
  [director, officer, ten_percent_owner, other_relation, officer_title, derivative_transaction, ticker, security_title, conversion_exercise_price, transaction_type_code, acquisition_disposition_code, amount_of_shares, underlying_security_title, underlying_shares, transaction_price, total_shares_owned, ownership_type_code, company, owner].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



214
215
216
217
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 214

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



333
334
335
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 333

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



339
340
341
342
343
344
345
346
347
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 339

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



327
328
329
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 327

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



221
222
223
 
# File 'lib/intrinio-sdk/models/insider_transaction.rb', line 221

def valid?
  return true
end