Class: Intrinio::EconomicIndex

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

Overview

An economic index provided by the St. Lous Fed FRED API, such as GDP, Unemployment, Fed Funds Rate, and more.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EconomicIndex

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 93

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#continent ⇒ Object

The continent of the country of focus for the Index



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

def continent
  @continent
end

#country ⇒ Object

The country of focus for the Index



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

def country
  @country
end

#description ⇒ Object

A paragraph describing the index and its scope



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

def description
  @description
end

#id ⇒ Object

The Intrinio ID for the Index



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

def id
  @id
end

#last_updated ⇒ Object

When the Index was updated last



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

def last_updated
  @last_updated
end

#name ⇒ Object

The name of the Index



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

def name
  @name
end

#observation_end ⇒ Object

The latest date for which data is available



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

def observation_end
  @observation_end
end

#observation_start ⇒ Object

The earliest date for which data is available



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

def observation_start
  @observation_start
end

#seasonal_adjustment ⇒ Object

Whether the data is adjusted to account for seasonality



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

def seasonal_adjustment
  @seasonal_adjustment
end

#symbol ⇒ Object

The symbol used to identify the Index



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

def symbol
  @symbol
end

#units ⇒ Object

The units of the data



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

def units
  @units
end

#update_frequency ⇒ Object

How often the Index is updated



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

def update_frequency
  @update_frequency
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 56

def self.attribute_map
  {
    :'id' => :'id',
    :'symbol' => :'symbol',
    :'name' => :'name',
    :'continent' => :'continent',
    :'country' => :'country',
    :'update_frequency' => :'update_frequency',
    :'last_updated' => :'last_updated',
    :'description' => :'description',
    :'observation_start' => :'observation_start',
    :'observation_end' => :'observation_end',
    :'seasonal_adjustment' => :'seasonal_adjustment',
    :'units' => :'units'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 74

def self.swagger_types
  {
    :'id' => :'String',
    :'symbol' => :'String',
    :'name' => :'String',
    :'continent' => :'String',
    :'country' => :'String',
    :'update_frequency' => :'String',
    :'last_updated' => :'DateTime',
    :'description' => :'String',
    :'observation_start' => :'Date',
    :'observation_end' => :'Date',
    :'seasonal_adjustment' => :'String',
    :'units' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      symbol == o.symbol &&
      name == o.name &&
      continent == o.continent &&
      country == o.country &&
      update_frequency == o.update_frequency &&
      last_updated == o.last_updated &&
      description == o.description &&
      observation_start == o.observation_start &&
      observation_end == o.observation_end &&
      seasonal_adjustment == o.seasonal_adjustment &&
      units == o.units
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



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
245
246
247
248
249
250
251
252
253
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 217

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 283

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 196

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


183
184
185
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 189

def hash
  [id, symbol, name, continent, country, update_frequency, last_updated, description, observation_start, observation_end, seasonal_adjustment, units].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



151
152
153
154
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 151

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



263
264
265
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 263

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 269

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



257
258
259
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 257

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



158
159
160
 
# File 'lib/intrinio-sdk/models/economic_index.rb', line 158

def valid?
  return true
end