Class: Intrinio::ApiResponseSecurityAverageDirectionalIndex

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

Overview

The Average Directional Index calculations for the Stock Prices of the given Security

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiResponseSecurityAverageDirectionalIndex

Initializes the object

Parameters:

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

    Model attributes in the form of hash



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 52

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?(:'technicals')
    if (value = attributes[:'technicals']).is_a?(Array)
      self.technicals = value
    end
  end

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

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

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

end

Instance Attribute Details

#indicator ⇒ Object

The name and symbol of the technical indicator



21
22
23
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 21

def indicator
  @indicator
end

#next_page ⇒ Object

The token required to request the next page of the data



27
28
29
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 27

def next_page
  @next_page
end

#security ⇒ Object

The Security of the Stock Price



24
25
26
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 24

def security
  @security
end

#technicals ⇒ Object

Returns the value of attribute technicals.



18
19
20
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 18

def technicals
  @technicals
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 31

def self.attribute_map
  {
    :'technicals' => :'technicals',
    :'indicator' => :'indicator',
    :'security' => :'security',
    :'next_page' => :'next_page'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 41

def self.swagger_types
  {
    :'technicals' => :'Array<AverageDirectionalIndexTechnicalValue>',
    :'indicator' => :'TechnicalIndicator',
    :'security' => :'SecuritySummary',
    :'next_page' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



93
94
95
96
97
98
99
100
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 93

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      technicals == o.technicals &&
      indicator == o.indicator &&
      security == o.security &&
      next_page == o.next_page
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



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
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 138

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



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 204

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 117

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


104
105
106
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 104

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



110
111
112
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 110

def hash
  [technicals, indicator, security, next_page].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



80
81
82
83
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 80

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



184
185
186
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 184

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



190
191
192
193
194
195
196
197
198
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 190

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



178
179
180
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 178

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



87
88
89
 
# File 'lib/intrinio-sdk/models/api_response_security_average_directional_index.rb', line 87

def valid?
  return true
end