Class: Intrinio::InsiderTransactionFiling

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

Overview

An insider transaction SEC filing and its associated transactions

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InsiderTransactionFiling

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 68

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

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

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

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

  if attributes.has_key?(:'transactions')
    if (value = attributes[:'transactions']).is_a?(Array)
      self.transactions = value
    end
  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

#company ⇒ Object

The company associated with the filing



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

def company
  @company
end

#filing_url ⇒ Object

The URL of the filing with the SEC



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

def filing_url
  @filing_url
end

#issuer_cik ⇒ Object

The Central Index Key (CIK) of the issuing company.



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

def issuer_cik
  @issuer_cik
end

#issuer_company ⇒ Object

The name of the issuing company.



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

def issuer_company
  @issuer_company
end

#issuer_ticker ⇒ Object

The ticker of the issuing company.



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

def issuer_ticker
  @issuer_ticker
end

#owner ⇒ Object

The owner associated with the filing



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

def owner
  @owner
end

#transactions ⇒ Object

The insider transactions associated with the filing



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

def transactions
  @transactions
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 41

def self.attribute_map
  {
    :'filing_url' => :'filing_url',
    :'issuer_ticker' => :'issuer_ticker',
    :'issuer_cik' => :'issuer_cik',
    :'issuer_company' => :'issuer_company',
    :'transactions' => :'transactions',
    :'company' => :'company',
    :'owner' => :'owner'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 54

def self.swagger_types
  {
    :'filing_url' => :'String',
    :'issuer_ticker' => :'String',
    :'issuer_cik' => :'String',
    :'issuer_company' => :'String',
    :'transactions' => :'Array<InsiderTransaction>',
    :'company' => :'CompanySummary',
    :'owner' => :'OwnerSummary'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 121

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      filing_url == o.filing_url &&
      issuer_ticker == o.issuer_ticker &&
      issuer_cik == o.issuer_cik &&
      issuer_company == o.issuer_company &&
      transactions == o.transactions &&
      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



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
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 169

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



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 235

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 148

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


135
136
137
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 135

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



141
142
143
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 141

def hash
  [filing_url, issuer_ticker, issuer_cik, issuer_company, transactions, 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



108
109
110
111
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 108

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



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

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



221
222
223
224
225
226
227
228
229
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 221

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



209
210
211
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 209

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



115
116
117
 
# File 'lib/intrinio-sdk/models/insider_transaction_filing.rb', line 115

def valid?
  return true
end