Class: ESI::PostUiOpenwindowNewmailNewMail

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

Overview

new_mail object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostUiOpenwindowNewmailNewMail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
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
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 74

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

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

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

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

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

Instance Attribute Details

#body ⇒ Object

body string



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

def body
  @body
end

#recipients ⇒ Object

recipients array



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

def recipients
  @recipients
end

#subject ⇒ Object

subject string



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

def subject
  @subject
end

#to_corp_or_alliance_id ⇒ Object

to_corp_or_alliance_id integer



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

def to_corp_or_alliance_id
  @to_corp_or_alliance_id
end

#to_mailing_list_id ⇒ Object

Corporations, alliances and mailing lists are all types of mailing groups. You may only send to one mailing group, at a time, so you may fill out either this field or the to_corp_or_alliance_ids field



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

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 264

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



46
47
48
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 46

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 51

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 35

def self.attribute_map
  {
    :'body' => :'body',
    :'recipients' => :'recipients',
    :'subject' => :'subject',
    :'to_corp_or_alliance_id' => :'to_corp_or_alliance_id',
    :'to_mailing_list_id' => :'to_mailing_list_id'
  }
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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 240

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



67
68
69
70
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 56

def self.openapi_types
  {
    :'body' => :'String',
    :'recipients' => :'Array<Integer>',
    :'subject' => :'String',
    :'to_corp_or_alliance_id' => :'Integer',
    :'to_mailing_list_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 215

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



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

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


227
228
229
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

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



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
147
148
149
150
151
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 119

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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 @recipients.length > 50
    invalid_properties.push('invalid value for "recipients", number of items must be less than or equal to 50.')
  end

  if @recipients.length < 1
    invalid_properties.push('invalid value for "recipients", number of items must be greater than or equal to 1.')
  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

  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



311
312
313
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 311

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 317

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



305
306
307
 
# File 'lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb', line 305

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @body.nil?
  return false if @body.to_s.length > 10000
  return false if @recipients.nil?
  return false if @recipients.length > 50
  return false if @recipients.length < 1
  return false if @subject.nil?
  return false if @subject.to_s.length > 1000
  true
end