Class: Intrinio::ApiResponseCompanies

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiResponseCompanies

Initializes the object

Parameters:

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

    Model attributes in the form of hash



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/intrinio-sdk/models/api_response_companies.rb', line 42

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

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

end

Instance Attribute Details

#companies ⇒ Object

Returns the value of attribute companies.



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

def companies
  @companies
end

#next_page ⇒ Object

The token required to request the next page of the data. If null, no further results are available.



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

def next_page
  @next_page
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
 
# File 'lib/intrinio-sdk/models/api_response_companies.rb', line 25

def self.attribute_map
  {
    :'companies' => :'companies',
    :'next_page' => :'next_page'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'companies' => :'Array<CompanySummary>',
    :'next_page' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



75
76
77
78
79
80
 
# File 'lib/intrinio-sdk/models/api_response_companies.rb', line 75

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



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

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



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/intrinio-sdk/models/api_response_companies.rb', line 184

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/intrinio-sdk/models/api_response_companies.rb', line 97

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


84
85
86
 
# File 'lib/intrinio-sdk/models/api_response_companies.rb', line 84

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



90
91
92
 
# File 'lib/intrinio-sdk/models/api_response_companies.rb', line 90

def hash
  [companies, 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



62
63
64
65
 
# File 'lib/intrinio-sdk/models/api_response_companies.rb', line 62

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



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

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



170
171
172
173
174
175
176
177
178
 
# File 'lib/intrinio-sdk/models/api_response_companies.rb', line 170

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



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

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



69
70
71
 
# File 'lib/intrinio-sdk/models/api_response_companies.rb', line 69

def valid?
  return true
end