Class: FinnhubRuby::BondProfile

Inherits:
Object
  • Object
show all
Defined in:
lib/finnhub_ruby/models/bond_profile.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BondProfile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
244
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 148

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::BondProfile` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FinnhubRuby::BondProfile`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'cusip')
    self.cusip = attributes[:'cusip']
  end

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

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

  if attributes.key?(:'maturity_date')
    self.maturity_date = attributes[:'maturity_date']
  end

  if attributes.key?(:'offering_price')
    self.offering_price = attributes[:'offering_price']
  end

  if attributes.key?(:'issue_date')
    self.issue_date = attributes[:'issue_date']
  end

  if attributes.key?(:'bond_type')
    self.bond_type = attributes[:'bond_type']
  end

  if attributes.key?(:'debt_type')
    self.debt_type = attributes[:'debt_type']
  end

  if attributes.key?(:'industry_group')
    self.industry_group = attributes[:'industry_group']
  end

  if attributes.key?(:'industry_sub_group')
    self.industry_sub_group = attributes[:'industry_sub_group']
  end

  if attributes.key?(:'asset')
    self.asset = attributes[:'asset']
  end

  if attributes.key?(:'asset_type')
    self.asset_type = attributes[:'asset_type']
  end

  if attributes.key?(:'dated_date')
    self.dated_date = attributes[:'dated_date']
  end

  if attributes.key?(:'first_coupon_date')
    self.first_coupon_date = attributes[:'first_coupon_date']
  end

  if attributes.key?(:'original_offering')
    self.original_offering = attributes[:'original_offering']
  end

  if attributes.key?(:'amount_outstanding')
    self.amount_outstanding = attributes[:'amount_outstanding']
  end

  if attributes.key?(:'payment_frequency')
    self.payment_frequency = attributes[:'payment_frequency']
  end

  if attributes.key?(:'security_level')
    self.security_level = attributes[:'security_level']
  end

  if attributes.key?(:'callable')
    self.callable = attributes[:'callable']
  end

  if attributes.key?(:'coupon_type')
    self.coupon_type = attributes[:'coupon_type']
  end
end

Instance Attribute Details

#amount_outstanding ⇒ Object

Outstanding amount.



67
68
69
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 67

def amount_outstanding
  @amount_outstanding
end

#asset ⇒ Object

Asset.



52
53
54
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 52

def asset
  @asset
end

#asset_type ⇒ Object

Asset.



55
56
57
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 55

def asset_type
  @asset_type
end

#bond_type ⇒ Object

Bond type.



40
41
42
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 40

def bond_type
  @bond_type
end

#callable ⇒ Object

Callable.



76
77
78
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 76

def callable
  @callable
end

#coupon ⇒ Object

Coupon.



28
29
30
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 28

def coupon
  @coupon
end

#coupon_type ⇒ Object

Coupon type.



79
80
81
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 79

def coupon_type
  @coupon_type
end

#cusip ⇒ Object

Cusip.



22
23
24
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 22

def cusip
  @cusip
end

#dated_date ⇒ Object

Dated date.



58
59
60
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 58

def dated_date
  @dated_date
end

#debt_type ⇒ Object

Bond type.



43
44
45
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 43

def debt_type
  @debt_type
end

#figi ⇒ Object

FIGI.



25
26
27
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 25

def figi
  @figi
end

#first_coupon_date ⇒ Object

First coupon date.



61
62
63
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 61

def first_coupon_date
  @first_coupon_date
end

#industry_group ⇒ Object

Industry.



46
47
48
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 46

def industry_group
  @industry_group
end

#industry_sub_group ⇒ Object

Sub-Industry.



49
50
51
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 49

def industry_sub_group
  @industry_sub_group
end

#isin ⇒ Object

ISIN.



19
20
21
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 19

def isin
  @isin
end

#issue_date ⇒ Object

Issue date.



37
38
39
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 37

def issue_date
  @issue_date
end

#maturity_date ⇒ Object

Period.



31
32
33
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 31

def maturity_date
  @maturity_date
end

#offering_price ⇒ Object

Offering price.



34
35
36
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 34

def offering_price
  @offering_price
end

#original_offering ⇒ Object

Offering amount.



64
65
66
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 64

def original_offering
  @original_offering
end

#payment_frequency ⇒ Object

Payment frequency.



70
71
72
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 70

def payment_frequency
  @payment_frequency
end

#security_level ⇒ Object

Security level.



73
74
75
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 73

def security_level
  @security_level
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



109
110
111
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 109

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 82

def self.attribute_map
  {
    :'isin' => :'isin',
    :'cusip' => :'cusip',
    :'figi' => :'figi',
    :'coupon' => :'coupon',
    :'maturity_date' => :'maturityDate',
    :'offering_price' => :'offeringPrice',
    :'issue_date' => :'issueDate',
    :'bond_type' => :'bondType',
    :'debt_type' => :'debtType',
    :'industry_group' => :'industryGroup',
    :'industry_sub_group' => :'industrySubGroup',
    :'asset' => :'asset',
    :'asset_type' => :'assetType',
    :'dated_date' => :'datedDate',
    :'first_coupon_date' => :'firstCouponDate',
    :'original_offering' => :'originalOffering',
    :'amount_outstanding' => :'amountOutstanding',
    :'payment_frequency' => :'paymentFrequency',
    :'security_level' => :'securityLevel',
    :'callable' => :'callable',
    :'coupon_type' => :'couponType'
  }
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



302
303
304
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 302

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



141
142
143
144
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 141

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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/finnhub_ruby/models/bond_profile.rb', line 114

def self.openapi_types
  {
    :'isin' => :'String',
    :'cusip' => :'String',
    :'figi' => :'String',
    :'coupon' => :'Float',
    :'maturity_date' => :'String',
    :'offering_price' => :'Float',
    :'issue_date' => :'String',
    :'bond_type' => :'String',
    :'debt_type' => :'String',
    :'industry_group' => :'String',
    :'industry_sub_group' => :'String',
    :'asset' => :'String',
    :'asset_type' => :'String',
    :'dated_date' => :'String',
    :'first_coupon_date' => :'String',
    :'original_offering' => :'Float',
    :'amount_outstanding' => :'Float',
    :'payment_frequency' => :'String',
    :'security_level' => :'String',
    :'callable' => :'Boolean',
    :'coupon_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      isin == o.isin &&
      cusip == o.cusip &&
      figi == o.figi &&
      coupon == o.coupon &&
      maturity_date == o.maturity_date &&
      offering_price == o.offering_price &&
      issue_date == o.issue_date &&
      bond_type == o.bond_type &&
      debt_type == o.debt_type &&
      industry_group == o.industry_group &&
      industry_sub_group == o.industry_sub_group &&
      asset == o.asset &&
      asset_type == o.asset_type &&
      dated_date == o.dated_date &&
      first_coupon_date == o.first_coupon_date &&
      original_offering == o.original_offering &&
      amount_outstanding == o.amount_outstanding &&
      payment_frequency == o.payment_frequency &&
      security_level == o.security_level &&
      callable == o.callable &&
      coupon_type == o.coupon_type
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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 332

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = FinnhubRuby.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 403

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 309

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


289
290
291
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 289

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



295
296
297
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 295

def hash
  [isin, cusip, figi, coupon, maturity_date, offering_price, issue_date, bond_type, debt_type, industry_group, industry_sub_group, asset, asset_type, dated_date, first_coupon_date, original_offering, amount_outstanding, payment_frequency, security_level, callable, coupon_type].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



248
249
250
251
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 248

def list_invalid_properties
  invalid_properties = Array.new
  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



379
380
381
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 379

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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 385

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



373
374
375
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 373

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



255
256
257
 
# File 'lib/finnhub_ruby/models/bond_profile.rb', line 255

def valid?
  true
end