Class: ESI::GetCorporationsCorporationIdOk

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/models/get_corporations_corporation_id_ok.rb

Overview

200 ok object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetCorporationsCorporationIdOk

Initializes the object



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
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
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 107

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ESI::GetCorporationsCorporationIdOk` 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 `ESI::GetCorporationsCorporationIdOk`. 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?(:'alliance_id')
    self.alliance_id = attributes[:'alliance_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#alliance_idObject

ID of the alliance that corporation is a member of, if any



18
19
20
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 18

def alliance_id
  @alliance_id
end

#ceo_idObject

ceo_id integer



21
22
23
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 21

def ceo_id
  @ceo_id
end

#creator_idObject

creator_id integer



24
25
26
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 24

def creator_id
  @creator_id
end

#date_foundedObject

date_founded string



27
28
29
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 27

def date_founded
  @date_founded
end

#descriptionObject

description string



30
31
32
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 30

def description
  @description
end

#faction_idObject

faction_id integer



33
34
35
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 33

def faction_id
  @faction_id
end

#home_station_idObject

home_station_id integer



36
37
38
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 36

def home_station_id
  @home_station_id
end

#member_countObject

member_count integer



39
40
41
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 39

def member_count
  @member_count
end

#nameObject

the full name of the corporation



42
43
44
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 42

def name
  @name
end

#sharesObject

shares integer



45
46
47
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 45

def shares
  @shares
end

#tax_rateObject

tax_rate number



48
49
50
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 48

def tax_rate
  @tax_rate
end

#tickerObject

the short name of the corporation



51
52
53
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 51

def ticker
  @ticker
end

#urlObject

url string



54
55
56
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 54

def url
  @url
end

#war_eligibleObject

war_eligible boolean



57
58
59
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 57

def war_eligible
  @war_eligible
end

Class Method Details

.attribute_mapObject

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 60

def self.attribute_map
  {
    :'alliance_id' => :'alliance_id',
    :'ceo_id' => :'ceo_id',
    :'creator_id' => :'creator_id',
    :'date_founded' => :'date_founded',
    :'description' => :'description',
    :'faction_id' => :'faction_id',
    :'home_station_id' => :'home_station_id',
    :'member_count' => :'member_count',
    :'name' => :'name',
    :'shares' => :'shares',
    :'tax_rate' => :'tax_rate',
    :'ticker' => :'ticker',
    :'url' => :'url',
    :'war_eligible' => :'war_eligible'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



256
257
258
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 256

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

.openapi_nullableObject

List of attributes with nullable: true



100
101
102
103
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 100

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

.openapi_typesObject

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 80

def self.openapi_types
  {
    :'alliance_id' => :'Object',
    :'ceo_id' => :'Object',
    :'creator_id' => :'Object',
    :'date_founded' => :'Object',
    :'description' => :'Object',
    :'faction_id' => :'Object',
    :'home_station_id' => :'Object',
    :'member_count' => :'Object',
    :'name' => :'Object',
    :'shares' => :'Object',
    :'tax_rate' => :'Object',
    :'ticker' => :'Object',
    :'url' => :'Object',
    :'war_eligible' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alliance_id == o.alliance_id &&
      ceo_id == o.ceo_id &&
      creator_id == o.creator_id &&
      date_founded == o.date_founded &&
      description == o.description &&
      faction_id == o.faction_id &&
      home_station_id == o.home_station_id &&
      member_count == o.member_count &&
      name == o.name &&
      shares == o.shares &&
      tax_rate == o.tax_rate &&
      ticker == o.ticker &&
      url == o.url &&
      war_eligible == o.war_eligible
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 286

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
    ESI.const_get(type).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



355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 355

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 263

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


243
244
245
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 243

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.



249
250
251
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 249

def hash
  [alliance_id, ceo_id, creator_id, date_founded, description, faction_id, home_station_id, member_count, name, shares, tax_rate, ticker, url, war_eligible].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?



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
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  if @ceo_id.nil?
    invalid_properties.push('invalid value for "ceo_id", ceo_id cannot be nil.')
  end

  if @creator_id.nil?
    invalid_properties.push('invalid value for "creator_id", creator_id cannot be nil.')
  end

  if @member_count.nil?
    invalid_properties.push('invalid value for "member_count", member_count cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @tax_rate.nil?
    invalid_properties.push('invalid value for "tax_rate", tax_rate cannot be nil.')
  end

  if @ticker.nil?
    invalid_properties.push('invalid value for "ticker", ticker cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)



331
332
333
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 331

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash



337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 337

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_sString

Returns the string representation of the object



325
326
327
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 325

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid



210
211
212
213
214
215
216
217
218
# File 'lib/ruby-esi/models/get_corporations_corporation_id_ok.rb', line 210

def valid?
  return false if @ceo_id.nil?
  return false if @creator_id.nil?
  return false if @member_count.nil?
  return false if @name.nil?
  return false if @tax_rate.nil?
  return false if @ticker.nil?
  true
end