Class: ESI::GetCharactersCharacterIdCalendarEventIdOk

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

Overview

Full details of a specific event

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetCharactersCharacterIdCalendarEventIdOk

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 121

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#dateObject

date string



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

def date
  @date
end

#durationObject

Length in minutes



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

def duration
  @duration
end

#event_idObject

event_id integer



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

def event_id
  @event_id
end

#importanceObject

importance integer



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

def importance
  @importance
end

#owner_idObject

owner_id integer



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

def owner_id
  @owner_id
end

#owner_nameObject

owner_name string



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

def owner_name
  @owner_name
end

#owner_typeObject

owner_type string



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

def owner_type
  @owner_type
end

#responseObject

response string



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

def response
  @response
end

#textObject

text string



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

def text
  @text
end

#titleObject

title string



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

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



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 419

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_mapObject

Returns attribute mapping this model knows about



88
89
90
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 88

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



93
94
95
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 93

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'date' => :'date',
    :'duration' => :'duration',
    :'event_id' => :'event_id',
    :'importance' => :'importance',
    :'owner_id' => :'owner_id',
    :'owner_name' => :'owner_name',
    :'owner_type' => :'owner_type',
    :'response' => :'response',
    :'text' => :'text',
    :'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



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 395

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_nullableObject

List of attributes with nullable: true



114
115
116
117
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 114

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

.openapi_typesObject

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 98

def self.openapi_types
  {
    :'date' => :'Time',
    :'duration' => :'Integer',
    :'event_id' => :'Integer',
    :'importance' => :'Integer',
    :'owner_id' => :'Integer',
    :'owner_name' => :'String',
    :'owner_type' => :'String',
    :'response' => :'String',
    :'text' => :'String',
    :'title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



365
366
367
368
369
370
371
372
373
374
375
376
377
378
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 365

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      duration == o.duration &&
      event_id == o.event_id &&
      importance == o.importance &&
      owner_id == o.owner_id &&
      owner_name == o.owner_name &&
      owner_type == o.owner_type &&
      response == o.response &&
      text == o.text &&
      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



490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 490

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


382
383
384
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 382

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



388
389
390
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 388

def hash
  [date, duration, event_id, importance, owner_id, owner_name, owner_type, response, text, title].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



466
467
468
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 466

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 472

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



460
461
462
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 460

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/ruby-esi/models/get_characters_character_id_calendar_event_id_ok.rb', line 246

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @date.nil?
  return false if @duration.nil?
  return false if @event_id.nil?
  return false if @importance.nil?
  return false if @owner_id.nil?
  return false if @owner_name.nil?
  return false if @owner_type.nil?
  owner_type_validator = EnumAttributeValidator.new('String', ["eve_server", "corporation", "faction", "character", "alliance"])
  return false unless owner_type_validator.valid?(@owner_type)
  return false if @response.nil?
  return false if @text.nil?
  return false if @title.nil?
  true
end