Class: ESIClient::GetCorporationsCorporationIdOk

Inherits:
Object
  • Object
show all
Defined in:
lib/esi_client/models/get_corporations_corporation_id_ok.rb

Overview

200 ok object

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetCorporationsCorporationIdOk

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/esi_client/models/get_corporations_corporation_id_ok.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?(:'alliance_id')
    self.alliance_id = attributes[:'alliance_id']
  end

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#alliance_idObject

id of alliance that corporation is a member of, if any



19
20
21
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 19

def alliance_id
  @alliance_id
end

#ceo_idObject

ceo_id integer



22
23
24
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 22

def ceo_id
  @ceo_id
end

#corporation_descriptionObject

corporation_description string



25
26
27
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 25

def corporation_description
  @corporation_description
end

#corporation_nameObject

the full name of the corporation



28
29
30
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 28

def corporation_name
  @corporation_name
end

#creation_dateObject

creation_date string



31
32
33
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 31

def creation_date
  @creation_date
end

#creator_idObject

creator_id integer



34
35
36
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 34

def creator_id
  @creator_id
end

#factionObject

faction string



37
38
39
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 37

def faction
  @faction
end

#member_countObject

member_count integer



40
41
42
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 40

def member_count
  @member_count
end

#tax_rateObject

tax_rate number



43
44
45
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 43

def tax_rate
  @tax_rate
end

#tickerObject

the short name of the corporation



46
47
48
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 46

def ticker
  @ticker
end

#urlObject

url string



49
50
51
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 49

def url
  @url
end

Class Method Details

.attribute_mapObject

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/esi_client/models/get_corporations_corporation_id_ok.rb', line 74

def self.attribute_map
  {
    :'alliance_id' => :'alliance_id',
    :'ceo_id' => :'ceo_id',
    :'corporation_description' => :'corporation_description',
    :'corporation_name' => :'corporation_name',
    :'creation_date' => :'creation_date',
    :'creator_id' => :'creator_id',
    :'faction' => :'faction',
    :'member_count' => :'member_count',
    :'tax_rate' => :'tax_rate',
    :'ticker' => :'ticker',
    :'url' => :'url'
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    :'alliance_id' => :'Integer',
    :'ceo_id' => :'Integer',
    :'corporation_description' => :'String',
    :'corporation_name' => :'String',
    :'creation_date' => :'DateTime',
    :'creator_id' => :'Integer',
    :'faction' => :'String',
    :'member_count' => :'Integer',
    :'tax_rate' => :'Float',
    :'ticker' => :'String',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 256

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alliance_id == o.alliance_id &&
      ceo_id == o.ceo_id &&
      corporation_description == o.corporation_description &&
      corporation_name == o.corporation_name &&
      creation_date == o.creation_date &&
      creator_id == o.creator_id &&
      faction == o.faction &&
      member_count == o.member_count &&
      tax_rate == o.tax_rate &&
      ticker == o.ticker &&
      url == o.url
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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 308

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 = ESIClient.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



374
375
376
377
378
379
380
381
382
383
384
385
386
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 374

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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 287

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


274
275
276
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 274

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



280
281
282
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 280

def hash
  [alliance_id, ceo_id, corporation_description, corporation_name, creation_date, creator_id, faction, member_count, tax_rate, ticker, url].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
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/esi_client/models/get_corporations_corporation_id_ok.rb', line 163

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 @corporation_description.nil?
    invalid_properties.push("invalid value for 'corporation_description', corporation_description cannot be nil.")
  end

  if @corporation_name.nil?
    invalid_properties.push("invalid value for 'corporation_name', corporation_name 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 @tax_rate.nil?
    invalid_properties.push("invalid value for 'tax_rate', tax_rate cannot be nil.")
  end

  if @tax_rate > 1
    invalid_properties.push("invalid value for 'tax_rate', must be smaller than or equal to 1.")
  end

  if @tax_rate < 0
    invalid_properties.push("invalid value for 'tax_rate', must be greater than or equal to 0.")
  end

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

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

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



354
355
356
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 354

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



360
361
362
363
364
365
366
367
368
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 360

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



348
349
350
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 348

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/esi_client/models/get_corporations_corporation_id_ok.rb', line 210

def valid?
  return false if @ceo_id.nil?
  return false if @corporation_description.nil?
  return false if @corporation_name.nil?
  return false if @creator_id.nil?
  faction_validator = EnumAttributeValidator.new('String', ["Minmatar", "Gallente", "Caldari", "Amarr"])
  return false unless faction_validator.valid?(@faction)
  return false if @member_count.nil?
  return false if @tax_rate.nil?
  return false if @tax_rate > 1
  return false if @tax_rate < 0
  return false if @ticker.nil?
  return false if @url.nil?
  return true
end