Class: Intrinio::DataTag

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataTag

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/intrinio-sdk/models/data_tag.rb', line 109

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#balance ⇒ Object

Whether the Data Tag represents a credit or debit



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

def balance
  @balance
end

#factor ⇒ Object

The operator forming the statement relationship between the child Data Tag (or Data Tags) and the parent Data Tag



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

def factor
  @factor
end

#id ⇒ Object

The Intrinio ID for the Data Tag



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

def id
  @id
end

#name ⇒ Object

The readable name of the Data Tag



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

def name
  @name
end

#parent ⇒ Object

The parent Data Tag forming the statement relationship with the factor



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

def parent
  @parent
end

#sequence ⇒ Object

The order in which the Data Tag appears in its logical group (such as a financial statement)



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

def sequence
  @sequence
end

#statement_code ⇒ Object

The code of the financial statement to which this Data Tag belongs



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

def statement_code
  @statement_code
end

#statement_type ⇒ Object

The format of the financial statment to which this Data Tag belongs



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

def statement_type
  @statement_type
end

#tag ⇒ Object

The code-name of the Data Tag



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

def tag
  @tag
end

#type ⇒ Object

The nature of the Data Tag, operating or nonoperating



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

def type
  @type
end

#unit ⇒ Object

The unit of the Data Tag



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

def unit
  @unit
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
 
# File 'lib/intrinio-sdk/models/data_tag.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'tag' => :'tag',
    :'statement_code' => :'statement_code',
    :'statement_type' => :'statement_type',
    :'parent' => :'parent',
    :'sequence' => :'sequence',
    :'factor' => :'factor',
    :'balance' => :'balance',
    :'type' => :'type',
    :'unit' => :'unit'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/intrinio-sdk/models/data_tag.rb', line 91

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'tag' => :'String',
    :'statement_code' => :'String',
    :'statement_type' => :'String',
    :'parent' => :'String',
    :'sequence' => :'Float',
    :'factor' => :'String',
    :'balance' => :'String',
    :'type' => :'String',
    :'unit' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      tag == o.tag &&
      statement_code == o.statement_code &&
      statement_type == o.statement_type &&
      parent == o.parent &&
      sequence == o.sequence &&
      factor == o.factor &&
      balance == o.balance &&
      type == o.type &&
      unit == o.unit
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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/intrinio-sdk/models/data_tag.rb', line 240

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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/intrinio-sdk/models/data_tag.rb', line 306

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/intrinio-sdk/models/data_tag.rb', line 219

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [id, name, tag, statement_code, statement_type, parent, sequence, factor, balance, type, unit].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



163
164
165
166
 
# File 'lib/intrinio-sdk/models/data_tag.rb', line 163

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



286
287
288
 
# File 'lib/intrinio-sdk/models/data_tag.rb', line 286

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



292
293
294
295
296
297
298
299
300
 
# File 'lib/intrinio-sdk/models/data_tag.rb', line 292

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



280
281
282
 
# File 'lib/intrinio-sdk/models/data_tag.rb', line 280

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



170
171
172
173
174
 
# File 'lib/intrinio-sdk/models/data_tag.rb', line 170

def valid?
  statement_type_validator = EnumAttributeValidator.new('String', ["financial", "industrial"])
  return false unless statement_type_validator.valid?(@statement_type)
  return true
end