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



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

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
  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::GetCharactersCharacterIdOk`. 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?(:'birthday')
    self.birthday = attributes[:'birthday']
  end

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

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

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

  if attributes.key?(:'race_id')
    self.race_id = attributes[:'race_id']
  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



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

def alliance_id
  @alliance_id
end

#birthday ⇒ Object

Creation date of the character



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

def birthday
  @birthday
end

#bloodline_id ⇒ Object

bloodline_id integer



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

def bloodline_id
  @bloodline_id
end

#corporation_id ⇒ Object

The character’s corporation ID



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

def corporation_id
  @corporation_id
end

#description ⇒ Object

description string



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

def description
  @description
end

#faction_id ⇒ Object

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



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

def faction_id
  @faction_id
end

#gender ⇒ Object

gender string



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

def gender
  @gender
end

#name ⇒ Object

name string



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

def name
  @name
end

#race_id ⇒ Object

race_id integer



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

def race_id
  @race_id
end

#security_status ⇒ Object

security_status number



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

def security_status
  @security_status
end

#title ⇒ Object

The individual title of the character



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

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



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

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



260
261
262
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 260

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 90

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 229

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

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



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
322
323
324
325
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 290

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 359

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 267

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


247
248
249
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 253

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



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

def list_invalid_properties
  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

  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



335
336
337
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 335

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 341

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



329
330
331
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 329

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



205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/ruby-esi/models/get_characters_character_id_ok.rb', line 205

def valid?
  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('Object', ['female', 'male'])
  return false unless gender_validator.valid?(@gender)
  return false if @name.nil?
  return false if @race_id.nil?
  true
end