Class: Intrinio::ETFHolding

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

Overview

The Exchange Traded Fund (ETF) holding data

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ETFHolding

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#as_of_date ⇒ Object

The date on which the holding and their weights correspond



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

def as_of_date
  @as_of_date
end

#composite_figi ⇒ Object

The OpenFIGI ticker for the holding



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

def composite_figi
  @composite_figi
end

#contract_expiry_date ⇒ Object

Expiry date for the futures contract held in the Exchange Traded Fund (ETF) or Exchange Traded Note (ETN)



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

def contract_expiry_date
  @contract_expiry_date
end

#coupon ⇒ Object

Coupon rate of the debt security, if available



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

def coupon
  @coupon
end

#face ⇒ Object

Face value of the debt security, if available



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

def face
  @face
end

#isin ⇒ Object

International Securities Identification Number (ISIN) for the holding



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

def isin
  @isin
end

#market_value_held ⇒ Object

The market value of this holding in the ETF as of the ‘as_of_date`



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

def market_value_held
  @market_value_held
end

#maturity ⇒ Object

Maturity date for the debt security, if available



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

def maturity
  @maturity
end

#name ⇒ Object

The common name for the holding



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

def name
  @name
end

#notional_value ⇒ Object

Notional value of derivatives contracts held in the Exchange Traded Fund (ETF) or Exchange Traded Note (ETN)



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

def notional_value
  @notional_value
end

#quantity_held ⇒ Object

Number of units of the security held if available



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

def quantity_held
  @quantity_held
end

#quantity_per_share ⇒ Object

Number of units of the security held per units of shares outstanding of the Exchange Traded Fund (ETF), if available



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

def quantity_per_share
  @quantity_per_share
end

#quantity_units ⇒ Object

The unit of the ‘quanity_held` field. Examples (’oz’, ‘shares’, ‘contracts’)



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

def quantity_units
  @quantity_units
end

#ric ⇒ Object

Reuters Instrument Code (RIC) for the holding



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

def ric
  @ric
end

#sedol ⇒ Object

Stock Exchange Daily Official List (SEDOL) for the holding



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

def sedol
  @sedol
end

#ticker ⇒ Object

The common exchange ticker for the holding



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

def ticker
  @ticker
end

#type ⇒ Object

The type of instrument for this holding. Examples (Bond = ‘BOND’, Equity = ‘EQUI’, Options = ‘OPTN’)



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

def type
  @type
end

#weighting ⇒ Object

Fraction of the funds market value held



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

def weighting
  @weighting
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'as_of_date' => :'as_of_date',
    :'name' => :'name',
    :'ticker' => :'ticker',
    :'type' => :'type',
    :'composite_figi' => :'composite_figi',
    :'isin' => :'isin',
    :'ric' => :'ric',
    :'sedol' => :'sedol',
    :'face' => :'face',
    :'coupon' => :'coupon',
    :'market_value_held' => :'market_value_held',
    :'notional_value' => :'notional_value',
    :'maturity' => :'maturity',
    :'quantity_held' => :'quantity_held',
    :'weighting' => :'weighting',
    :'quantity_units' => :'quantity_units',
    :'quantity_per_share' => :'quantity_per_share',
    :'contract_expiry_date' => :'contract_expiry_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 98

def self.swagger_types
  {
    :'as_of_date' => :'Date',
    :'name' => :'String',
    :'ticker' => :'String',
    :'type' => :'String',
    :'composite_figi' => :'String',
    :'isin' => :'String',
    :'ric' => :'String',
    :'sedol' => :'String',
    :'face' => :'Float',
    :'coupon' => :'Float',
    :'market_value_held' => :'Float',
    :'notional_value' => :'Float',
    :'maturity' => :'Date',
    :'quantity_held' => :'Float',
    :'weighting' => :'Float',
    :'quantity_units' => :'Float',
    :'quantity_per_share' => :'Float',
    :'contract_expiry_date' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 218

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      as_of_date == o.as_of_date &&
      name == o.name &&
      ticker == o.ticker &&
      type == o.type &&
      composite_figi == o.composite_figi &&
      isin == o.isin &&
      ric == o.ric &&
      sedol == o.sedol &&
      face == o.face &&
      coupon == o.coupon &&
      market_value_held == o.market_value_held &&
      notional_value == o.notional_value &&
      maturity == o.maturity &&
      quantity_held == o.quantity_held &&
      weighting == o.weighting &&
      quantity_units == o.quantity_units &&
      quantity_per_share == o.quantity_per_share &&
      contract_expiry_date == o.contract_expiry_date
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



277
278
279
280
281
282
283
284
285
286
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
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 277

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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 343

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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 256

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


243
244
245
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



249
250
251
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 249

def hash
  [as_of_date, name, ticker, type, composite_figi, isin, ric, sedol, face, coupon, market_value_held, notional_value, maturity, quantity_held, weighting, quantity_units, quantity_per_share, contract_expiry_date].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



205
206
207
208
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 205

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



323
324
325
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 323

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



329
330
331
332
333
334
335
336
337
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 329

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



317
318
319
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 317

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



212
213
214
 
# File 'lib/intrinio-sdk/models/etf_holding.rb', line 212

def valid?
  return true
end