class SunshineConversationsClient::MatchCriteria
The set of criteria used to determine the user's identity on a third-party channel.
Attributes
The user’s email address.
The ID of the integration to link. Must match the provided type.
The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368.
Flag indicating whether the client will become the primary for the target conversation once linking is complete.
May be specified to set the subject for the outgoing email.
The channel type.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sunshine-conversations-client/models/match_criteria.rb, line 34 def self.attribute_map { :'type' => :'type', :'integration_id' => :'integrationId', :'primary' => :'primary', :'address' => :'address', :'subject' => :'subject', :'phone_number' => :'phoneNumber' } 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/match_criteria.rb, line 201 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/match_criteria.rb, line 80 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::MatchCriteria` 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::MatchCriteria`. 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?(:'type') self.type = attributes[:'type'] else self.type = 'whatsapp' end if attributes.key?(:'integration_id') self.integration_id = attributes[:'integration_id'] end if attributes.key?(:'primary') self.primary = attributes[:'primary'] else self.primary = true end if attributes.key?(:'address') self.address = attributes[:'address'] end if attributes.key?(:'subject') self.subject = attributes[:'subject'] else self.subject = 'New message from {appName}' end if attributes.key?(:'phone_number') self.phone_number = attributes[:'phone_number'] end end
discriminator's property name in OpenAPI v3
# File lib/sunshine-conversations-client/models/match_criteria.rb, line 74 def self.openapi_discriminator_name :'type' end
List of attributes with nullable: true
# File lib/sunshine-conversations-client/models/match_criteria.rb, line 58 def self.openapi_nullable Set.new([ ]) end
List of class defined in oneOf (OpenAPI v3)
# File lib/sunshine-conversations-client/models/match_criteria.rb, line 64 def self.openapi_one_of [ :'MatchCriteriaMailgun', :'MatchCriteriaMessagebird', :'MatchCriteriaTwilio', :'MatchCriteriaWhatsapp' ] end
Attribute type mapping.
# File lib/sunshine-conversations-client/models/match_criteria.rb, line 46 def self.openapi_types { :'type' => :'String', :'integration_id' => :'String', :'primary' => :'Boolean', :'address' => :'String', :'subject' => :'String', :'phone_number' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/match_criteria.rb, line 175 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && integration_id == o.integration_id && primary == o.primary && address == o.address && subject == o.subject && phone_number == o.phone_number 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/match_criteria.rb, line 229 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/match_criteria.rb, line 298 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/match_criteria.rb, line 208 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
@see the `==` method @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/match_criteria.rb, line 188 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/sunshine-conversations-client/models/match_criteria.rb, line 194 def hash [type, integration_id, primary, address, subject, phone_number].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/match_criteria.rb, line 126 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @integration_id.nil? invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.') end if @address.nil? invalid_properties.push('invalid value for "address", address cannot be nil.') end if @phone_number.nil? invalid_properties.push('invalid value for "phone_number", phone_number 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/sunshine-conversations-client/models/match_criteria.rb, line 280 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/match_criteria.rb, line 268 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/match_criteria.rb, line 149 def valid? return false if @type.nil? return false if @integration_id.nil? return false if @address.nil? return false if @phone_number.nil? _one_of_found = false self.class.openapi_one_of.each do |_class| _one_of = SunshineConversationsClient.const_get(_class).build_from_hash(self.to_hash) if _one_of.valid? if _one_of_found return false else _one_of_found = true end end end if !_one_of_found return false end true end