Class: Intrinio::SecuritySummary

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

Overview

The summary of a financial instrument representing shares of ownership in a publicly-traded company

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecuritySummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
93
94
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
 
# File 'lib/intrinio-sdk/models/security_summary.rb', line 88

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#code ⇒ Object

A 2-3 digit code classifying the Security (<a href="docs.intrinio.com/documentation/security_codes" target="_blank">reference</a>)



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

def code
  @code
end

#company_id ⇒ Object

The Intrinio ID for the Company for which the Security is issued



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

def company_id
  @company_id
end

#composite_figi ⇒ Object

The country-composite OpenFIGI identifier



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

def composite_figi
  @composite_figi
end

#composite_ticker ⇒ Object

The country-composite ticker of the Security



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

def composite_ticker
  @composite_ticker
end

#currency ⇒ Object

The currency in which the Security is traded on the exchange



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

def currency
  @currency
end

#figi ⇒ Object

The OpenFIGI identifier



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

def figi
  @figi
end

#id ⇒ Object

The Intrinio ID for Security



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

def id
  @id
end

#name ⇒ Object

The name of the Security



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

def name
  @name
end

#primary_listing ⇒ Object

If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange



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

def primary_listing
  @primary_listing
end

#share_class_figi ⇒ Object

The global-composite OpenFIGI identifier



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

def share_class_figi
  @share_class_figi
end

#ticker ⇒ Object

The common/local ticker of the Security



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

def ticker
  @ticker
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'company_id' => :'company_id',
    :'name' => :'name',
    :'code' => :'code',
    :'currency' => :'currency',
    :'ticker' => :'ticker',
    :'composite_ticker' => :'composite_ticker',
    :'figi' => :'figi',
    :'composite_figi' => :'composite_figi',
    :'share_class_figi' => :'share_class_figi',
    :'primary_listing' => :'primary_listing'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',
    :'company_id' => :'String',
    :'name' => :'String',
    :'code' => :'String',
    :'currency' => :'String',
    :'ticker' => :'String',
    :'composite_ticker' => :'String',
    :'figi' => :'String',
    :'composite_figi' => :'String',
    :'share_class_figi' => :'String',
    :'primary_listing' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/intrinio-sdk/models/security_summary.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      company_id == o.company_id &&
      name == o.name &&
      code == o.code &&
      currency == o.currency &&
      ticker == o.ticker &&
      composite_ticker == o.composite_ticker &&
      figi == o.figi &&
      composite_figi == o.composite_figi &&
      share_class_figi == o.share_class_figi &&
      primary_listing == o.primary_listing
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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/intrinio-sdk/models/security_summary.rb', line 207

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



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/intrinio-sdk/models/security_summary.rb', line 273

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



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

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


173
174
175
 
# File 'lib/intrinio-sdk/models/security_summary.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/intrinio-sdk/models/security_summary.rb', line 179

def hash
  [id, company_id, name, code, currency, ticker, composite_ticker, figi, composite_figi, share_class_figi, primary_listing].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



142
143
144
145
 
# File 'lib/intrinio-sdk/models/security_summary.rb', line 142

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



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

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



259
260
261
262
263
264
265
266
267
 
# File 'lib/intrinio-sdk/models/security_summary.rb', line 259

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



247
248
249
 
# File 'lib/intrinio-sdk/models/security_summary.rb', line 247

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



149
150
151
 
# File 'lib/intrinio-sdk/models/security_summary.rb', line 149

def valid?
  return true
end