class PureCloud::Message
Attributes
After-call work for the communication.
Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent
Requested.
The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The direction of the message.
System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Address
and name data for a call endpoint.
True if this call is held and the person on this side hears silence.
A globally unique identifier for this communication.
The messages sent on this communication channel.
The id of the peer communication corresponding to a matching leg for this communication.
The source provider for the message.
Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format.
The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type.
A globally unique identifier for the recording associated with this message.
The UUID of the script to use.
The time line of the participant's message, divided into activity segments.
The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The timestamp the message was placed on hold in the cloud clock if the message is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The connection state of this communication.
Address
and name data for a call endpoint.
Indicates the type of message platform from which the message originated.
Call
wrap up or disposition data.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/message.rb, line 93 def self.attribute_map { :'state' => :'state', :'id' => :'id', :'held' => :'held', :'segments' => :'segments', :'direction' => :'direction', :'recording_id' => :'recordingId', :'error_info' => :'errorInfo', :'disconnect_type' => :'disconnectType', :'start_hold_time' => :'startHoldTime', :'start_alerting_time' => :'startAlertingTime', :'connected_time' => :'connectedTime', :'disconnected_time' => :'disconnectedTime', :'provider' => :'provider', :'type' => :'type', :'recipient_country' => :'recipientCountry', :'recipient_type' => :'recipientType', :'script_id' => :'scriptId', :'peer_id' => :'peerId', :'to_address' => :'toAddress', :'from_address' => :'fromAddress', :'messages' => :'messages', :'wrapup' => :'wrapup', :'after_call_work' => :'afterCallWork', :'after_call_work_required' => :'afterCallWorkRequired' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/message.rb, line 204 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?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'held') self.held = attributes[:'held'] end if attributes.has_key?(:'segments') if (value = attributes[:'segments']).is_a?(Array) self.segments = value end end if attributes.has_key?(:'direction') self.direction = attributes[:'direction'] end if attributes.has_key?(:'recordingId') self.recording_id = attributes[:'recordingId'] end if attributes.has_key?(:'errorInfo') self.error_info = attributes[:'errorInfo'] 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?(:'startAlertingTime') self.start_alerting_time = attributes[:'startAlertingTime'] 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?(:'provider') self.provider = attributes[:'provider'] 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?(:'scriptId') self.script_id = attributes[:'scriptId'] end if attributes.has_key?(:'peerId') self.peer_id = attributes[:'peerId'] 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?(:'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 end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/message.rb, line 148 def self.swagger_types { :'state' => :'String', :'id' => :'String', :'held' => :'BOOLEAN', :'segments' => :'Array<Segment>', :'direction' => :'String', :'recording_id' => :'String', :'error_info' => :'ErrorBody', :'disconnect_type' => :'String', :'start_hold_time' => :'DateTime', :'start_alerting_time' => :'DateTime', :'connected_time' => :'DateTime', :'disconnected_time' => :'DateTime', :'provider' => :'String', :'type' => :'String', :'recipient_country' => :'String', :'recipient_type' => :'String', :'script_id' => :'String', :'peer_id' => :'String', :'to_address' => :'Address', :'from_address' => :'Address', :'messages' => :'Array<MessageDetails>', :'wrapup' => :'Wrapup', :'after_call_work' => :'AfterCallWork', :'after_call_work_required' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/message.rb, line 723 def ==(o) return true if self.equal?(o) self.class == o.class && state == o.state && id == o.id && held == o.held && segments == o.segments && direction == o.direction && recording_id == o.recording_id && error_info == o.error_info && disconnect_type == o.disconnect_type && start_hold_time == o.start_hold_time && start_alerting_time == o.start_alerting_time && connected_time == o.connected_time && disconnected_time == o.disconnected_time && provider == o.provider && type == o.type && recipient_country == o.recipient_country && recipient_type == o.recipient_type && script_id == o.script_id && peer_id == o.peer_id && to_address == o.to_address && from_address == o.from_address && messages == o.messages && wrapup == o.wrapup && after_call_work == o.after_call_work && after_call_work_required == o.after_call_work_required end
# File lib/purecloudplatformclientv2/models/message.rb, line 784 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/message.rb, line 844 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/message.rb, line 765 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] direction Object to be assigned
# File lib/purecloudplatformclientv2/models/message.rb, line 597 def direction=(direction) allowed_values = ["inbound", "outbound"] if direction && !allowed_values.include?(direction) fail ArgumentError, "invalid value for 'direction', must be one of #{allowed_values}." end @direction = direction end
Custom attribute writer method checking allowed values (enum). @param [Object] disconnect_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/message.rb, line 621 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/message.rb, line 754 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/message.rb, line 760 def hash [state, id, held, segments, direction, recording_id, error_info, disconnect_type, start_hold_time, start_alerting_time, connected_time, disconnected_time, provider, type, recipient_country, recipient_type, script_id, peer_id, to_address, from_address, messages, wrapup, after_call_work, after_call_work_required].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/message.rb, line 435 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/message.rb, line 568 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/message.rb, line 832 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/message.rb, line 822 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/message.rb, line 660 def type=(type) allowed_values = ["unknown", "sms", "twitter", "facebook", "line", "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/message.rb, line 444 def valid? allowed_values = ["alerting", "connected", "disconnected"] if @state && !allowed_values.include?(@state) return false end allowed_values = ["inbound", "outbound"] if @direction && !allowed_values.include?(@direction) 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", "whatsapp", "telegram", "kakao", "webmessaging"] if @type && !allowed_values.include?(@type) return false end end