class SunshineConversationsClient::MailgunUpdate
Attributes
A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`.
Email address to use as the From and Reply-To address if it must be different from incomingAddress. Only use this option if the address that you supply is configured to forward emails to the incomingAddress, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user’s email client. May be unset with null.
A boolean value indicating whether the unsubscribe link should be omitted from outgoing emails. When enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. By default, the unsubscribe link will be included in all outgoing emails.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 24 def self.attribute_map { :'display_name' => :'displayName', :'hide_unsubscribe_link' => :'hideUnsubscribeLink', :'from_address' => :'fromAddress' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 162 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 59 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::MailgunUpdate` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::MailgunUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] end if attributes.key?(:'hide_unsubscribe_link') self.hide_unsubscribe_link = attributes[:'hide_unsubscribe_link'] end if attributes.key?(:'from_address') self.from_address = attributes[:'from_address'] end end
List of class defined in allOf (OpenAPI v3)
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 50 def self.openapi_all_of [ :'IntegrationUpdateBase', :'MailgunUpdateAllOf' ] end
List of attributes with nullable: true
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 42 def self.openapi_nullable Set.new([ :'display_name', :'from_address' ]) end
Attribute type mapping.
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 33 def self.openapi_types { :'display_name' => :'String', :'hide_unsubscribe_link' => :'Boolean', :'from_address' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 139 def ==(o) return true if self.equal?(o) self.class == o.class && display_name == o.display_name && hide_unsubscribe_link == o.hide_unsubscribe_link && from_address == o.from_address 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/sunshine-conversations-client/models/mailgun_update.rb, line 190 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 SunshineConversationsClient.const_get(type).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/sunshine-conversations-client/models/mailgun_update.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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 169 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_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
Custom
attribute writer method with validation @param [Object] display_name
Value to be assigned
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 115 def display_name=(display_name) if !display_name.nil? && display_name.to_s.length > 100 fail ArgumentError, 'invalid value for "display_name", the character length must be smaller than or equal to 100.' end if !display_name.nil? && display_name.to_s.length < 1 fail ArgumentError, 'invalid value for "display_name", the character length must be great than or equal to 1.' end @display_name = display_name end
@see the `==` method @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 149 def eql?(o) self == o end
Custom
attribute writer method with validation @param [Object] from_address
Value to be assigned
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 129 def from_address=(from_address) if !from_address.nil? && from_address.to_s.length < 1 fail ArgumentError, 'invalid value for "from_address", the character length must be great than or equal to 1.' end @from_address = from_address end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 155 def hash [display_name, hide_unsubscribe_link, from_address].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 87 def list_invalid_properties invalid_properties = Array.new if !@display_name.nil? && @display_name.to_s.length > 100 invalid_properties.push('invalid value for "display_name", the character length must be smaller than or equal to 100.') end if !@display_name.nil? && @display_name.to_s.length < 1 invalid_properties.push('invalid value for "display_name", the character length must be great than or equal to 1.') end if !@from_address.nil? && @from_address.to_s.length < 1 invalid_properties.push('invalid value for "from_address", the character length must be great than or equal to 1.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 241 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/sunshine-conversations-client/models/mailgun_update.rb, line 229 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/sunshine-conversations-client/models/mailgun_update.rb, line 106 def valid? return false if !@display_name.nil? && @display_name.to_s.length > 100 return false if !@display_name.nil? && @display_name.to_s.length < 1 return false if !@from_address.nil? && @from_address.to_s.length < 1 true end