class SibApiV3Sdk::UpdateContact
Attributes
Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in "SMS" field should be passed with proper country code. For example {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}
Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)
Ids of the lists to add the contact to
Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)
transactional email forbidden sender for contact. Use only for email Contact
Ids of the lists to remove the contact from
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sib-api-v3-sdk/models/update_contact.rb, line 36 def self.attribute_map { :'attributes' => :'attributes', :'email_blacklisted' => :'emailBlacklisted', :'sms_blacklisted' => :'smsBlacklisted', :'list_ids' => :'listIds', :'unlink_list_ids' => :'unlinkListIds', :'smtp_blacklist_sender' => :'smtpBlacklistSender' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/sib-api-v3-sdk/models/update_contact.rb, line 61 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?(:'attributes') self.attributes = attributes[:'attributes'] end if attributes.has_key?(:'emailBlacklisted') self.email_blacklisted = attributes[:'emailBlacklisted'] end if attributes.has_key?(:'smsBlacklisted') self.sms_blacklisted = attributes[:'smsBlacklisted'] end if attributes.has_key?(:'listIds') if (value = attributes[:'listIds']).is_a?(Array) self.list_ids = value end end if attributes.has_key?(:'unlinkListIds') if (value = attributes[:'unlinkListIds']).is_a?(Array) self.unlink_list_ids = value end end if attributes.has_key?(:'smtpBlacklistSender') if (value = attributes[:'smtpBlacklistSender']).is_a?(Array) self.smtp_blacklist_sender = value end end end
Attribute type mapping.
# File lib/sib-api-v3-sdk/models/update_contact.rb, line 48 def self.swagger_types { :'attributes' => :'Object', :'email_blacklisted' => :'BOOLEAN', :'sms_blacklisted' => :'BOOLEAN', :'list_ids' => :'Array<Integer>', :'unlink_list_ids' => :'Array<Integer>', :'smtp_blacklist_sender' => :'Array<String>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sib-api-v3-sdk/models/update_contact.rb, line 113 def ==(o) return true if self.equal?(o) self.class == o.class && attributes == o.attributes && email_blacklisted == o.email_blacklisted && sms_blacklisted == o.sms_blacklisted && list_ids == o.list_ids && unlink_list_ids == o.unlink_list_ids && smtp_blacklist_sender == o.smtp_blacklist_sender 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/sib-api-v3-sdk/models/update_contact.rb, line 160 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 = SibApiV3Sdk.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/sib-api-v3-sdk/models/update_contact.rb, line 226 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/sib-api-v3-sdk/models/update_contact.rb, line 139 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/sib-api-v3-sdk/models/update_contact.rb, line 126 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/sib-api-v3-sdk/models/update_contact.rb, line 132 def hash [attributes, email_blacklisted, sms_blacklisted, list_ids, unlink_list_ids, smtp_blacklist_sender].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/sib-api-v3-sdk/models/update_contact.rb, line 100 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/sib-api-v3-sdk/models/update_contact.rb, line 212 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/sib-api-v3-sdk/models/update_contact.rb, line 200 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/sib-api-v3-sdk/models/update_contact.rb, line 107 def valid? true end