Class: EsiClient::GetCharactersCharacterIdContacts200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/esi-ruby/models/get_characters_character_id_contacts_200_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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 83

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

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

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

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

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

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

end

Instance Attribute Details

#contact_id ⇒ Object

contact_id integer



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

def contact_id
  @contact_id
end

#contact_type ⇒ Object

contact_type string



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

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



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

def is_blocked
  @is_blocked
end

#is_watched ⇒ Object

Whether this contact is being watched



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

def is_watched
  @is_watched
end

#label_id ⇒ Object

Custom label of the contact



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

def label_id
  @label_id
end

#standing ⇒ Object

Standing of the contact



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

def standing
  @standing
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 58

def self.attribute_map
  {
    :'contact_id' => :'contact_id',
    :'contact_type' => :'contact_type',
    :'is_blocked' => :'is_blocked',
    :'is_watched' => :'is_watched',
    :'label_id' => :'label_id',
    :'standing' => :'standing'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 70

def self.swagger_types
  {
    :'contact_id' => :'Integer',
    :'contact_type' => :'String',
    :'is_blocked' => :'BOOLEAN',
    :'is_watched' => :'BOOLEAN',
    :'label_id' => :'Integer',
    :'standing' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 157

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_id == o.label_id &&
      standing == o.standing
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



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
236
237
238
239
240
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 204

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 270

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 183

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


170
171
172
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 170

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



176
177
178
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 176

def hash
  [contact_id, contact_type, is_blocked, is_watched, label_id, standing].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 117

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

  return 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



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

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



256
257
258
259
260
261
262
263
264
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 256

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



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

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



136
137
138
139
140
141
142
143
 
# File 'lib/esi-ruby/models/get_characters_character_id_contacts_200_ok.rb', line 136

def valid?
  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 @standing.nil?
  return true
end