class PureCloud::ConversationEventTopicCallback
Attributes
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb, line 70 def self.attribute_map { :'state' => :'state', :'id' => :'id', :'direction' => :'direction', :'held' => :'held', :'disconnect_type' => :'disconnectType', :'start_hold_time' => :'startHoldTime', :'dialer_preview' => :'dialerPreview', :'voicemail' => :'voicemail', :'callback_numbers' => :'callbackNumbers', :'callback_user_name' => :'callbackUserName', :'script_id' => :'scriptId', :'peer_id' => :'peerId', :'external_campaign' => :'externalCampaign', :'skip_enabled' => :'skipEnabled', :'provider' => :'provider', :'timeout_seconds' => :'timeoutSeconds', :'connected_time' => :'connectedTime', :'disconnected_time' => :'disconnectedTime', :'callback_scheduled_time' => :'callbackScheduledTime', :'automated_callback_config_id' => :'automatedCallbackConfigId', :'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/conversation_event_topic_callback.rb, line 181 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?(:'direction') self.direction = attributes[:'direction'] end if attributes.has_key?(:'held') self.held = attributes[:'held'] 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?(:'dialerPreview') self.dialer_preview = attributes[:'dialerPreview'] end if attributes.has_key?(:'voicemail') self.voicemail = attributes[:'voicemail'] end if attributes.has_key?(:'callbackNumbers') if (value = attributes[:'callbackNumbers']).is_a?(Array) self.callback_numbers = value end end if attributes.has_key?(:'callbackUserName') self.callback_user_name = attributes[:'callbackUserName'] 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?(:'externalCampaign') self.external_campaign = attributes[:'externalCampaign'] end if attributes.has_key?(:'skipEnabled') self.skip_enabled = attributes[:'skipEnabled'] end if attributes.has_key?(:'provider') self.provider = attributes[:'provider'] end if attributes.has_key?(:'timeoutSeconds') self.timeout_seconds = attributes[:'timeoutSeconds'] 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?(:'callbackScheduledTime') self.callback_scheduled_time = attributes[:'callbackScheduledTime'] end if attributes.has_key?(:'automatedCallbackConfigId') self.automated_callback_config_id = attributes[:'automatedCallbackConfigId'] 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/conversation_event_topic_callback.rb, line 125 def self.swagger_types { :'state' => :'String', :'id' => :'String', :'direction' => :'String', :'held' => :'BOOLEAN', :'disconnect_type' => :'String', :'start_hold_time' => :'DateTime', :'dialer_preview' => :'ConversationEventTopicDialerPreview', :'voicemail' => :'ConversationEventTopicVoicemail', :'callback_numbers' => :'Array<String>', :'callback_user_name' => :'String', :'script_id' => :'String', :'peer_id' => :'String', :'external_campaign' => :'BOOLEAN', :'skip_enabled' => :'BOOLEAN', :'provider' => :'String', :'timeout_seconds' => :'Integer', :'connected_time' => :'DateTime', :'disconnected_time' => :'DateTime', :'callback_scheduled_time' => :'DateTime', :'automated_callback_config_id' => :'String', :'wrapup' => :'ConversationEventTopicWrapup', :'after_call_work' => :'ConversationEventTopicAfterCallWork', :'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/conversation_event_topic_callback.rb, line 684 def ==(o) return true if self.equal?(o) self.class == o.class && state == o.state && id == o.id && direction == o.direction && held == o.held && disconnect_type == o.disconnect_type && start_hold_time == o.start_hold_time && dialer_preview == o.dialer_preview && voicemail == o.voicemail && callback_numbers == o.callback_numbers && callback_user_name == o.callback_user_name && script_id == o.script_id && peer_id == o.peer_id && external_campaign == o.external_campaign && skip_enabled == o.skip_enabled && provider == o.provider && timeout_seconds == o.timeout_seconds && connected_time == o.connected_time && disconnected_time == o.disconnected_time && callback_scheduled_time == o.callback_scheduled_time && automated_callback_config_id == o.automated_callback_config_id && 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/conversation_event_topic_callback.rb, line 745 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/conversation_event_topic_callback.rb, line 805 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/conversation_event_topic_callback.rb, line 726 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/conversation_event_topic_callback.rb, line 557 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/conversation_event_topic_callback.rb, line 576 def disconnect_type=(disconnect_type) allowed_values = ["ENDPOINT", "CLIENT", "SYSTEM", "TIMEOUT", "TRANSFER", "TRANSFER_CONFERENCE", "TRANSFER_CONSULT", "TRANSFER_NOANSWER", "TRANSFER_NOTAVAILABLE", "TRANSFER_FORWARD", "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/conversation_event_topic_callback.rb, line 715 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb, line 721 def hash [state, id, direction, held, disconnect_type, start_hold_time, dialer_preview, voicemail, callback_numbers, callback_user_name, script_id, peer_id, external_campaign, skip_enabled, provider, timeout_seconds, connected_time, disconnected_time, callback_scheduled_time, automated_callback_config_id, 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/conversation_event_topic_callback.rb, line 410 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/conversation_event_topic_callback.rb, line 538 def state=(state) allowed_values = ["ALERTING", "DIALING", "CONTACTING", "OFFERING", "CONNECTED", "DISCONNECTED", "TERMINATED", "SCHEDULED", "UPLOADING", "NONE"] 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/conversation_event_topic_callback.rb, line 793 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/conversation_event_topic_callback.rb, line 783 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/purecloudplatformclientv2/models/conversation_event_topic_callback.rb, line 419 def valid? allowed_values = ["ALERTING", "DIALING", "CONTACTING", "OFFERING", "CONNECTED", "DISCONNECTED", "TERMINATED", "SCHEDULED", "UPLOADING", "NONE"] 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_NOANSWER", "TRANSFER_NOTAVAILABLE", "TRANSFER_FORWARD", "TRANSPORT_FAILURE", "ERROR", "PEER", "OTHER", "SPAM", "UNCALLABLE"] if @disconnect_type && !allowed_values.include?(@disconnect_type) return false end end