Class: ESI::GetCharactersCharacterIdBookmarks200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb

Overview

200 ok object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetCharactersCharacterIdBookmarks200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 80

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bookmark_id ⇒ Object

bookmark_id integer



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

def bookmark_id
  @bookmark_id
end

#coordinates ⇒ Object

Returns the value of attribute coordinates.



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

def coordinates
  @coordinates
end

#created ⇒ Object

created string



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

def created
  @created
end

#creator_id ⇒ Object

creator_id integer



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

def creator_id
  @creator_id
end

#folder_id ⇒ Object

folder_id integer



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

def folder_id
  @folder_id
end

#item ⇒ Object

Returns the value of attribute item.



31
32
33
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 31

def item
  @item
end

#label ⇒ Object

label string



34
35
36
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 34

def label
  @label
end

#location_id ⇒ Object

location_id integer



37
38
39
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 37

def location_id
  @location_id
end

#notes ⇒ Object

notes string



40
41
42
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 40

def notes
  @notes
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 43

def self.attribute_map
  {
    :'bookmark_id' => :'bookmark_id',
    :'coordinates' => :'coordinates',
    :'created' => :'created',
    :'creator_id' => :'creator_id',
    :'folder_id' => :'folder_id',
    :'item' => :'item',
    :'label' => :'label',
    :'location_id' => :'location_id',
    :'notes' => :'notes'
  }
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



204
205
206
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 204

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



73
74
75
76
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 73

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'bookmark_id' => :'Object',
    :'coordinates' => :'Object',
    :'created' => :'Object',
    :'creator_id' => :'Object',
    :'folder_id' => :'Object',
    :'item' => :'Object',
    :'label' => :'Object',
    :'location_id' => :'Object',
    :'notes' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 175

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bookmark_id == o.bookmark_id &&
      coordinates == o.coordinates &&
      created == o.created &&
      creator_id == o.creator_id &&
      folder_id == o.folder_id &&
      item == o.item &&
      label == o.label &&
      location_id == o.location_id &&
      notes == o.notes
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 234

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 303

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 211

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


191
192
193
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



197
198
199
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 197

def hash
  [bookmark_id, coordinates, created, creator_id, folder_id, item, label, location_id, notes].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



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/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 132

def list_invalid_properties
  invalid_properties = Array.new
  if @bookmark_id.nil?
    invalid_properties.push('invalid value for "bookmark_id", bookmark_id cannot be nil.')
  end

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

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

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

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

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



279
280
281
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 279

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 285

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



273
274
275
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 273

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



163
164
165
166
167
168
169
170
171
 
# File 'lib/ruby-esi/models/get_characters_character_id_bookmarks_200_ok.rb', line 163

def valid?
  return false if @bookmark_id.nil?
  return false if @created.nil?
  return false if @creator_id.nil?
  return false if @label.nil?
  return false if @location_id.nil?
  return false if @notes.nil?
  true
end