class ESI::PostUiOpenwindowNewmailNewMail
new_mail object
Attributes
body string
recipients array
subject string
to_corp_or_alliance_id
integer
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
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 34 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 57 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?(:'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 if attributes.has_key?(:'to_corp_or_alliance_id') self.to_corp_or_alliance_id = attributes[:'to_corp_or_alliance_id'] end if attributes.has_key?(:'to_mailing_list_id') self.to_mailing_list_id = attributes[:'to_mailing_list_id'] end end
Attribute type mapping.
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 45 def self.swagger_types { :'body' => :'String', :'recipients' => :'Array<Integer>', :'subject' => :'String', :'to_corp_or_alliance_id' => :'Integer', :'to_mailing_list_id' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 154 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 200 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 = ESI.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 266 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
Custom attribute writer method with validation @param [Object] body Value to be assigned
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 126 def body=(body) if body.nil? fail ArgumentError, 'body cannot be nil' end if body.to_s.length > 10000 fail ArgumentError, 'invalid value for "body", the character length must be smaller than or equal to 10000.' end @body = body end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 179 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 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
@see the `==` method @param [Object] Object to be compared
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 166 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 172 def hash [body, recipients, subject, to_corp_or_alliance_id, to_mailing_list_id].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 88 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 invalid_properties end
Custom attribute writer method with validation @param [Object] subject Value to be assigned
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 140 def subject=(subject) if subject.nil? fail ArgumentError, 'subject cannot be nil' end if subject.to_s.length > 1000 fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 1000.' end @subject = subject end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 252 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 240 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/ruby-esi/models/post_ui_openwindow_newmail_new_mail.rb, line 115 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 true end