class PureCloud::QueueConversationSocialExpressionEventTopicMessage
Attributes
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 66 def self.attribute_map { :'id' => :'id', :'state' => :'state', :'held' => :'held', :'error_info' => :'errorInfo', :'provider' => :'provider', :'script_id' => :'scriptId', :'peer_id' => :'peerId', :'disconnect_type' => :'disconnectType', :'start_hold_time' => :'startHoldTime', :'connected_time' => :'connectedTime', :'disconnected_time' => :'disconnectedTime', :'to_address' => :'toAddress', :'from_address' => :'fromAddress', :'messages' => :'messages', :'messages_transcript_uri' => :'messagesTranscriptUri', :'type' => :'type', :'recipient_country' => :'recipientCountry', :'recipient_type' => :'recipientType', :'wrapup' => :'wrapup', :'after_call_work' => :'afterCallWork', :'after_call_work_required' => :'afterCallWorkRequired', :'additional_properties' => :'additionalProperties' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 169 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'held') self.held = attributes[:'held'] end if attributes.has_key?(:'errorInfo') self.error_info = attributes[:'errorInfo'] end if attributes.has_key?(:'provider') self.provider = attributes[:'provider'] end if attributes.has_key?(:'scriptId') self.script_id = attributes[:'scriptId'] end if attributes.has_key?(:'peerId') self.peer_id = attributes[:'peerId'] end if attributes.has_key?(:'disconnectType') self.disconnect_type = attributes[:'disconnectType'] end if attributes.has_key?(:'startHoldTime') self.start_hold_time = attributes[:'startHoldTime'] end if attributes.has_key?(:'connectedTime') self.connected_time = attributes[:'connectedTime'] end if attributes.has_key?(:'disconnectedTime') self.disconnected_time = attributes[:'disconnectedTime'] end if attributes.has_key?(:'toAddress') self.to_address = attributes[:'toAddress'] end if attributes.has_key?(:'fromAddress') self.from_address = attributes[:'fromAddress'] end if attributes.has_key?(:'messages') if (value = attributes[:'messages']).is_a?(Array) self.messages = value end end if attributes.has_key?(:'messagesTranscriptUri') self.messages_transcript_uri = attributes[:'messagesTranscriptUri'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'recipientCountry') self.recipient_country = attributes[:'recipientCountry'] end if attributes.has_key?(:'recipientType') self.recipient_type = attributes[:'recipientType'] end if attributes.has_key?(:'wrapup') self.wrapup = attributes[:'wrapup'] end if attributes.has_key?(:'afterCallWork') self.after_call_work = attributes[:'afterCallWork'] end if attributes.has_key?(:'afterCallWorkRequired') self.after_call_work_required = attributes[:'afterCallWorkRequired'] end if attributes.has_key?(:'additionalProperties') self.additional_properties = attributes[:'additionalProperties'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 117 def self.swagger_types { :'id' => :'String', :'state' => :'String', :'held' => :'BOOLEAN', :'error_info' => :'QueueConversationSocialExpressionEventTopicErrorDetails', :'provider' => :'String', :'script_id' => :'String', :'peer_id' => :'String', :'disconnect_type' => :'String', :'start_hold_time' => :'DateTime', :'connected_time' => :'DateTime', :'disconnected_time' => :'DateTime', :'to_address' => :'QueueConversationSocialExpressionEventTopicAddress', :'from_address' => :'QueueConversationSocialExpressionEventTopicAddress', :'messages' => :'Array<QueueConversationSocialExpressionEventTopicMessageDetails>', :'messages_transcript_uri' => :'String', :'type' => :'String', :'recipient_country' => :'String', :'recipient_type' => :'String', :'wrapup' => :'QueueConversationSocialExpressionEventTopicWrapup', :'after_call_work' => :'QueueConversationSocialExpressionEventTopicAfterCallWork', :'after_call_work_required' => :'BOOLEAN', :'additional_properties' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 636 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && state == o.state && held == o.held && error_info == o.error_info && provider == o.provider && script_id == o.script_id && peer_id == o.peer_id && disconnect_type == o.disconnect_type && start_hold_time == o.start_hold_time && connected_time == o.connected_time && disconnected_time == o.disconnected_time && to_address == o.to_address && from_address == o.from_address && messages == o.messages && messages_transcript_uri == o.messages_transcript_uri && type == o.type && recipient_country == o.recipient_country && recipient_type == o.recipient_type && wrapup == o.wrapup && after_call_work == o.after_call_work && after_call_work_required == o.after_call_work_required && additional_properties == o.additional_properties end
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 695 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 =~ /^(true|t|yes|y|1)$/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 _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 755 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
build the object from hash
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 676 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end
Custom attribute writer method checking allowed values (enum). @param [Object] disconnect_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 544 def disconnect_type=(disconnect_type) allowed_values = ["ENDPOINT", "CLIENT", "SYSTEM", "TIMEOUT", "TRANSFER", "TRANSFER_CONFERENCE", "TRANSFER_CONSULT", "TRANSFER_FORWARD", "TRANSFER_NOANSWER", "TRANSFER_NOTAVAILABLE", "TRANSPORT_FAILURE", "ERROR", "PEER", "OTHER", "SPAM", "UNCALLABLE"] if disconnect_type && !allowed_values.include?(disconnect_type) fail ArgumentError, "invalid value for 'disconnect_type', must be one of #{allowed_values}." end @disconnect_type = disconnect_type end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 665 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 671 def hash [id, state, held, error_info, provider, script_id, peer_id, disconnect_type, start_hold_time, connected_time, disconnected_time, to_address, from_address, messages, messages_transcript_uri, type, recipient_country, recipient_type, wrapup, after_call_work, after_call_work_required, additional_properties].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 380 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 505 def state=(state) allowed_values = ["ALERTING", "CONNECTED", "DISCONNECTED"] if state && !allowed_values.include?(state) fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}." end @state = state end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 743 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
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 733 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 593 def type=(type) allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO", "WEBMESSAGING"] if type && !allowed_values.include?(type) fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}." end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb, line 389 def valid? allowed_values = ["ALERTING", "CONNECTED", "DISCONNECTED"] if @state && !allowed_values.include?(@state) return false end allowed_values = ["ENDPOINT", "CLIENT", "SYSTEM", "TIMEOUT", "TRANSFER", "TRANSFER_CONFERENCE", "TRANSFER_CONSULT", "TRANSFER_FORWARD", "TRANSFER_NOANSWER", "TRANSFER_NOTAVAILABLE", "TRANSPORT_FAILURE", "ERROR", "PEER", "OTHER", "SPAM", "UNCALLABLE"] if @disconnect_type && !allowed_values.include?(@disconnect_type) return false end allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO", "WEBMESSAGING"] if @type && !allowed_values.include?(@type) return false end end