Class: ESI::GetCharactersCharacterIdContacts200Ok

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
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
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 101

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

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

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

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

  if attributes.key?(:'label_ids')
    if (value = attributes[:'label_ids']).is_a?(Array)
      self.label_ids = value
    end
  end

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

Instance Attribute Details

#contact_id ⇒ Object

contact_id integer



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

def contact_id
  @contact_id
end

#contact_type ⇒ Object

contact_type string



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

def contact_type
  @contact_type
end

#is_blocked ⇒ Object

Whether this contact is in the blocked list. Note a missing value denotes unknown, not true or false



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

def is_blocked
  @is_blocked
end

#is_watched ⇒ Object

Whether this contact is being watched



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

def is_watched
  @is_watched
end

#label_ids ⇒ Object

label_ids array



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

def label_ids
  @label_ids
end

#standing ⇒ Object

Standing of the contact



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

def standing
  @standing
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



281
282
283
284
285
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
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 281

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



72
73
74
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 72

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 77

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 60

def self.attribute_map
  {
    :'contact_id' => :'contact_id',
    :'contact_type' => :'contact_type',
    :'is_blocked' => :'is_blocked',
    :'is_watched' => :'is_watched',
    :'label_ids' => :'label_ids',
    :'standing' => :'standing'
  }
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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 257

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



94
95
96
97
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 82

def self.openapi_types
  {
    :'contact_id' => :'Integer',
    :'contact_type' => :'String',
    :'is_blocked' => :'Boolean',
    :'is_watched' => :'Boolean',
    :'label_ids' => :'Array<Integer>',
    :'standing' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      contact_id == o.contact_id &&
      contact_type == o.contact_type &&
      is_blocked == o.is_blocked &&
      is_watched == o.is_watched &&
      label_ids == o.label_ids &&
      standing == o.standing
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



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 352

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


244
245
246
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 250

def hash
  [contact_id, contact_type, is_blocked, is_watched, label_ids, standing].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



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_contacts200_ok.rb', line 150

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

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

  if !@label_ids.nil? && @label_ids.length > 63
    invalid_properties.push('invalid value for "label_ids", number of items must be less than or equal to 63.')
  end

  if @standing.nil?
    invalid_properties.push('invalid value for "standing", standing 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



328
329
330
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 328

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



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

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



322
323
324
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 322

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



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/ruby-esi/models/get_characters_character_id_contacts200_ok.rb', line 174

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @contact_id.nil?
  return false if @contact_type.nil?
  contact_type_validator = EnumAttributeValidator.new('String', ["character", "corporation", "alliance", "faction"])
  return false unless contact_type_validator.valid?(@contact_type)
  return false if !@label_ids.nil? && @label_ids.length > 63
  return false if @standing.nil?
  true
end