class SmoochApi::AppUserLink
Attributes
A String of the appUser’s email address. Required for mailgun linking.
Allows you to specify the strategy used to initiate a link with the target user.
A String of the appUser’s given name. Used as additional criteria to increase the likelihood of a match. (Optional) Used for messenger linking.
The id of the integration to link, it must match the provided type.
A String of the appUser’s phone number. It must contain the + prefix and the country code. Required for messenger, twilio, messagebird and whatsapp linking.
Subject for the outgoing email. (Optional) Used for mailgun linking.
A String of the appUser’s surname. Used as additional criteria to increase the likelihood of a match. (Optional) Used for messenger linking.
The type of the channel to link. See [IntegrationTypeEnum](Enums.md#IntegrationTypeEnum) for available values.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/smooch-api/models/app_user_link.rb, line 44 def self.attribute_map { :'type' => :'type', :'integrationId' => :'integrationId', :'phoneNumber' => :'phoneNumber', :'address' => :'address', :'givenName' => :'givenName', :'surname' => :'surname', :'subject' => :'subject', :'confirmation' => :'confirmation' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/smooch-api/models/app_user_link.rb, line 73 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?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'integrationId') self.integrationId = attributes[:'integrationId'] end if attributes.has_key?(:'phoneNumber') self.phoneNumber = attributes[:'phoneNumber'] end if attributes.has_key?(:'address') self.address = attributes[:'address'] end if attributes.has_key?(:'givenName') self.givenName = attributes[:'givenName'] end if attributes.has_key?(:'surname') self.surname = attributes[:'surname'] end if attributes.has_key?(:'subject') self.subject = attributes[:'subject'] end if attributes.has_key?(:'confirmation') self.confirmation = attributes[:'confirmation'] end end
Attribute type mapping.
# File lib/smooch-api/models/app_user_link.rb, line 58 def self.swagger_types { :'type' => :'String', :'integrationId' => :'String', :'phoneNumber' => :'String', :'address' => :'String', :'givenName' => :'String', :'surname' => :'String', :'subject' => :'String', :'confirmation' => :'Confirmation' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/smooch-api/models/app_user_link.rb, line 138 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && integrationId == o.integrationId && phoneNumber == o.phoneNumber && address == o.address && givenName == o.givenName && surname == o.surname && subject == o.subject && confirmation == o.confirmation 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/smooch-api/models/app_user_link.rb, line 187 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 = SmoochApi.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/smooch-api/models/app_user_link.rb, line 253 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/smooch-api/models/app_user_link.rb, line 166 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 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/smooch-api/models/app_user_link.rb, line 153 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/smooch-api/models/app_user_link.rb, line 159 def hash [type, integrationId, phoneNumber, address, givenName, surname, subject, confirmation].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/smooch-api/models/app_user_link.rb, line 115 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push("invalid value for 'type', type cannot be nil.") end if @confirmation.nil? invalid_properties.push("invalid value for 'confirmation', confirmation cannot be nil.") end return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/smooch-api/models/app_user_link.rb, line 239 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/smooch-api/models/app_user_link.rb, line 227 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/smooch-api/models/app_user_link.rb, line 130 def valid? return false if @type.nil? return false if @confirmation.nil? return true end