class Mimepost::Email
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/mimepost/models/email.rb, line 38 def self.attribute_map { :'html' => :'html', :'subject' => :'subject', :'from_email' => :'from_email', :'from_name' => :'from_name', :'global_merge_vars' => :'global_merge_vars', :'to' => :'to', :'cc' => :'cc', :'bcc' => :'bcc', :'attachments' => :'attachments', :'vars' => :'vars' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/mimepost/models/email.rb, line 71 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?(:'html') self.html = attributes[:'html'] end if attributes.has_key?(:'subject') self.subject = attributes[:'subject'] end if attributes.has_key?(:'from_email') self.from_email = attributes[:'from_email'] end if attributes.has_key?(:'from_name') self.from_name = attributes[:'from_name'] end if attributes.has_key?(:'global_merge_vars') if (value = attributes[:'global_merge_vars']).is_a?(Array) self.global_merge_vars = value end end if attributes.has_key?(:'to') if (value = attributes[:'to']).is_a?(Array) self.to = value end end if attributes.has_key?(:'cc') if (value = attributes[:'cc']).is_a?(Array) self.cc = value end end if attributes.has_key?(:'bcc') if (value = attributes[:'bcc']).is_a?(Array) self.bcc = value end end if attributes.has_key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value end end if attributes.has_key?(:'vars') if (value = attributes[:'vars']).is_a?(Hash) self.vars = value end end end
Attribute type mapping.
# File lib/mimepost/models/email.rb, line 54 def self.swagger_types { :'html' => :'String', :'subject' => :'String', :'from_email' => :'String', :'from_name' => :'String', :'global_merge_vars' => :'Array<EmailGlobalMergeVars>', :'to' => :'Array<EmailTo>', :'cc' => :'Array<String>', :'bcc' => :'Array<String>', :'attachments' => :'Array<EmailAttachments>', :'vars' => :'Hash<String, String>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/mimepost/models/email.rb, line 165 def ==(o) return true if self.equal?(o) self.class == o.class && html == o.html && subject == o.subject && from_email == o.from_email && from_name == o.from_name && global_merge_vars == o.global_merge_vars && to == o.to && cc == o.cc && bcc == o.bcc && attachments == o.attachments && vars == o.vars 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/mimepost/models/email.rb, line 216 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 = Mimepost.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/mimepost/models/email.rb, line 282 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/mimepost/models/email.rb, line 195 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/mimepost/models/email.rb, line 182 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/mimepost/models/email.rb, line 188 def hash [html, subject, from_email, from_name, global_merge_vars, to, cc, bcc, attachments, vars].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/mimepost/models/email.rb, line 132 def list_invalid_properties invalid_properties = Array.new if @html.nil? invalid_properties.push('invalid value for "html", html cannot be nil.') end if @subject.nil? invalid_properties.push('invalid value for "subject", subject cannot be nil.') end if @from_email.nil? invalid_properties.push('invalid value for "from_email", from_email cannot be nil.') end if @to.nil? invalid_properties.push('invalid value for "to", to cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/mimepost/models/email.rb, line 268 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/mimepost/models/email.rb, line 256 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/mimepost/models/email.rb, line 155 def valid? return false if @html.nil? return false if @subject.nil? return false if @from_email.nil? return false if @to.nil? true end