class SunshineConversationsClient::Destination
The destination of the message, in the case of [channel targeting](docs.smooch.io/guide/sending-messages/#targeting-a-specific-channel) or sending [silent messages](docs.smooch.io/guide/sending-messages/#silent-messages). Only applicable if the author role is `business` and the conversation is of type `personal`.
Attributes
The id of the integration to deliver the message to. Will return an error if the integration does not exist or if the user does not have a client for the integration attached to the conversation.
The type of the integration to deliver the message to. Can be set to `none` if sending a [silent message](docs.smooch.io/guide/sending-messages/#silent-messages). Will return an error if the user does not have a client of that type attached to the conversation.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sunshine-conversations-client/models/destination.rb, line 22 def self.attribute_map { :'integration_id' => :'integrationId', :'integration_type' => :'integrationType' } 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/destination.rb, line 128 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/destination.rb, line 53 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Destination` 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::Destination`. 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?(:'integration_id') self.integration_id = attributes[:'integration_id'] end if attributes.key?(:'integration_type') self.integration_type = attributes[:'integration_type'] end end
List of attributes with nullable: true
# File lib/sunshine-conversations-client/models/destination.rb, line 38 def self.openapi_nullable Set.new([ ]) end
List of class defined in oneOf (OpenAPI v3)
# File lib/sunshine-conversations-client/models/destination.rb, line 44 def self.openapi_one_of [ :'IntegrationId', :'IntegrationType' ] end
Attribute type mapping.
# File lib/sunshine-conversations-client/models/destination.rb, line 30 def self.openapi_types { :'integration_id' => :'String', :'integration_type' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/destination.rb, line 106 def ==(o) return true if self.equal?(o) self.class == o.class && integration_id == o.integration_id && integration_type == o.integration_type 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/destination.rb, line 156 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/destination.rb, line 225 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/destination.rb, line 135 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/destination.rb, line 115 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/sunshine-conversations-client/models/destination.rb, line 121 def hash [integration_id, integration_type].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/destination.rb, line 77 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/sunshine-conversations-client/models/destination.rb, line 207 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/destination.rb, line 195 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/destination.rb, line 84 def valid? _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