Class: EsiClient::PostCharactersCharacterIdMailMail

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

Overview

mail schema

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostCharactersCharacterIdMailMail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 52

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

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

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

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

end

Instance Attribute Details

#approved_cost ⇒ Object

approved_cost integer



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

def approved_cost
  @approved_cost
end

#body ⇒ Object

body string



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

def body
  @body
end

#recipients ⇒ Object

recipients array



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

def recipients
  @recipients
end

#subject ⇒ Object

subject string



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

def subject
  @subject
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 31

def self.attribute_map
  {
    :'approved_cost' => :'approved_cost',
    :'body' => :'body',
    :'recipients' => :'recipients',
    :'subject' => :'subject'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 41

def self.swagger_types
  {
    :'approved_cost' => :'Integer',
    :'body' => :'String',
    :'recipients' => :'Array<PostCharactersCharacterIdMailRecipient>',
    :'subject' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



148
149
150
151
152
153
154
155
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 148

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      approved_cost == o.approved_cost &&
      body == o.body &&
      recipients == o.recipients &&
      subject == o.subject
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



193
194
195
196
197
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
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 193

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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 259

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



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

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


159
160
161
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 159

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



165
166
167
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 165

def hash
  [approved_cost, body, recipients, subject].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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 82

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

  if @body.to_s.length > 10000
    invalid_properties.push("invalid value for 'body', the character length must be smaller than or equal to 10000.")
  end

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

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

  if @subject.to_s.length > 1000
    invalid_properties.push("invalid value for 'subject', the character length must be smaller than or equal to 1000.")
  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



239
240
241
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 239

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



245
246
247
248
249
250
251
252
253
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 245

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



233
234
235
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 233

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



109
110
111
112
113
114
115
116
 
# File 'lib/esi-ruby/models/post_characters_character_id_mail_mail.rb', line 109

def valid?
  return false if @body.nil?
  return false if @body.to_s.length > 10000
  return false if @recipients.nil?
  return false if @subject.nil?
  return false if @subject.to_s.length > 1000
  return true
end