Class: ESI::GetCharactersCharacterIdOk

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/models/get_characters_character_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 = {}) ⇒ GetCharactersCharacterIdOk

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 126

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ESI::GetCharactersCharacterIdOk` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `ESI::GetCharactersCharacterIdOk`. Please check the name to make sure it's valid. List of attributes: " + acceptable_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?(:'birthday')
    self.birthday = attributes[:'birthday']
  else
    self.birthday = nil
  end

  if attributes.key?(:'bloodline_id')
    self.bloodline_id = attributes[:'bloodline_id']
  else
    self.bloodline_id = nil
  end

  if attributes.key?(:'corporation_id')
    self.corporation_id = attributes[:'corporation_id']
  else
    self.corporation_id = nil
  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?(:'gender')
    self.gender = attributes[:'gender']
  else
    self.gender = nil
  end

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

  if attributes.key?(:'race_id')
    self.race_id = attributes[:'race_id']
  else
    self.race_id = nil
  end

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

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

Instance Attribute Details

#alliance_id ⇒ Object

The character’s alliance ID



20
21
22
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 20

def alliance_id
  @alliance_id
end

#birthday ⇒ Object

Creation date of the character



23
24
25
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 23

def birthday
  @birthday
end

#bloodline_id ⇒ Object

bloodline_id integer



26
27
28
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 26

def bloodline_id
  @bloodline_id
end

#corporation_id ⇒ Object

The character’s corporation ID



29
30
31
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 29

def corporation_id
  @corporation_id
end

#description ⇒ Object

description string



32
33
34
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 32

def description
  @description
end

#faction_id ⇒ Object

ID of the faction the character is fighting for, if the character is enlisted in Factional Warfare



35
36
37
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 35

def faction_id
  @faction_id
end

#gender ⇒ Object

gender string



38
39
40
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 38

def gender
  @gender
end

#name ⇒ Object

name string



41
42
43
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 41

def name
  @name
end

#race_id ⇒ Object

race_id integer



44
45
46
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 44

def race_id
  @race_id
end

#security_status ⇒ Object

security_status number



47
48
49
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 47

def security_status
  @security_status
end

#title ⇒ Object

The individual title of the character



50
51
52
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 50

def title
  @title
end

Class Method Details

._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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 389

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = ESI.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



92
93
94
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 92

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 97

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 75

def self.attribute_map
  {
    :'alliance_id' => :'alliance_id',
    :'birthday' => :'birthday',
    :'bloodline_id' => :'bloodline_id',
    :'corporation_id' => :'corporation_id',
    :'description' => :'description',
    :'faction_id' => :'faction_id',
    :'gender' => :'gender',
    :'name' => :'name',
    :'race_id' => :'race_id',
    :'security_status' => :'security_status',
    :'title' => :'title'
  }
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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 365

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 102

def self.openapi_types
  {
    :'alliance_id' => :'Integer',
    :'birthday' => :'Time',
    :'bloodline_id' => :'Integer',
    :'corporation_id' => :'Integer',
    :'description' => :'String',
    :'faction_id' => :'Integer',
    :'gender' => :'String',
    :'name' => :'String',
    :'race_id' => :'Integer',
    :'security_status' => :'Float',
    :'title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alliance_id == o.alliance_id &&
      birthday == o.birthday &&
      bloodline_id == o.bloodline_id &&
      corporation_id == o.corporation_id &&
      description == o.description &&
      faction_id == o.faction_id &&
      gender == o.gender &&
      name == o.name &&
      race_id == o.race_id &&
      security_status == o.security_status &&
      title == o.title
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



460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 460

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


352
353
354
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 352

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



358
359
360
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 358

def hash
  [alliance_id, birthday, bloodline_id, corporation_id, description, faction_id, gender, name, race_id, security_status, title].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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 199

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @birthday.nil?
    invalid_properties.push('invalid value for "birthday", birthday cannot be nil.')
  end

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

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

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

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

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

  if !@security_status.nil? && @security_status > 1E+1
    invalid_properties.push('invalid value for "security_status", must be smaller than or equal to 1E+1.')
  end

  if !@security_status.nil? && @security_status < -1E+1
    invalid_properties.push('invalid value for "security_status", must be greater than or equal to -1E+1.')
  end

  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



436
437
438
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 436

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



442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 442

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



430
431
432
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 430

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 239

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @birthday.nil?
  return false if @bloodline_id.nil?
  return false if @corporation_id.nil?
  return false if @gender.nil?
  gender_validator = EnumAttributeValidator.new('String', ["female", "male"])
  return false unless gender_validator.valid?(@gender)
  return false if @name.nil?
  return false if @race_id.nil?
  return false if !@security_status.nil? && @security_status > 1E+1
  return false if !@security_status.nil? && @security_status < -1E+1
  true
end