class PureCloud::Evaluation
Attributes
Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Evaluation
form used for evaluation.
The globally unique identifier for the object.
List of different communication types used in conversation.
Signifies if the evaluation is never to be released. This cannot be set true if release date is also set.
Is only true when the user making the request does not have sufficient permissions to see evaluation
Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Is only true when evaluation is re-scored.
Only used for email evaluations. Will be null for all other evaluations.
The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.
The URI for this object
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/evaluation.rb, line 84 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'conversation' => :'conversation', :'evaluation_form' => :'evaluationForm', :'evaluator' => :'evaluator', :'agent' => :'agent', :'calibration' => :'calibration', :'status' => :'status', :'answers' => :'answers', :'agent_has_read' => :'agentHasRead', :'release_date' => :'releaseDate', :'assigned_date' => :'assignedDate', :'changed_date' => :'changedDate', :'queue' => :'queue', :'media_type' => :'mediaType', :'rescore' => :'rescore', :'conversation_date' => :'conversationDate', :'conversation_end_date' => :'conversationEndDate', :'never_release' => :'neverRelease', :'resource_id' => :'resourceId', :'resource_type' => :'resourceType', :'redacted' => :'redacted', :'is_scoring_index' => :'isScoringIndex', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/evaluation.rb, line 195 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'conversation') self.conversation = attributes[:'conversation'] end if attributes.has_key?(:'evaluationForm') self.evaluation_form = attributes[:'evaluationForm'] end if attributes.has_key?(:'evaluator') self.evaluator = attributes[:'evaluator'] end if attributes.has_key?(:'agent') self.agent = attributes[:'agent'] end if attributes.has_key?(:'calibration') self.calibration = attributes[:'calibration'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'answers') self.answers = attributes[:'answers'] end if attributes.has_key?(:'agentHasRead') self.agent_has_read = attributes[:'agentHasRead'] end if attributes.has_key?(:'releaseDate') self.release_date = attributes[:'releaseDate'] end if attributes.has_key?(:'assignedDate') self.assigned_date = attributes[:'assignedDate'] end if attributes.has_key?(:'changedDate') self.changed_date = attributes[:'changedDate'] end if attributes.has_key?(:'queue') self.queue = attributes[:'queue'] end if attributes.has_key?(:'mediaType') if (value = attributes[:'mediaType']).is_a?(Array) self.media_type = value end end if attributes.has_key?(:'rescore') self.rescore = attributes[:'rescore'] end if attributes.has_key?(:'conversationDate') self.conversation_date = attributes[:'conversationDate'] end if attributes.has_key?(:'conversationEndDate') self.conversation_end_date = attributes[:'conversationEndDate'] end if attributes.has_key?(:'neverRelease') self.never_release = attributes[:'neverRelease'] end if attributes.has_key?(:'resourceId') self.resource_id = attributes[:'resourceId'] end if attributes.has_key?(:'resourceType') self.resource_type = attributes[:'resourceType'] end if attributes.has_key?(:'redacted') self.redacted = attributes[:'redacted'] end if attributes.has_key?(:'isScoringIndex') self.is_scoring_index = attributes[:'isScoringIndex'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/evaluation.rb, line 139 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'conversation' => :'Conversation', :'evaluation_form' => :'EvaluationForm', :'evaluator' => :'User', :'agent' => :'User', :'calibration' => :'Calibration', :'status' => :'String', :'answers' => :'EvaluationScoringSet', :'agent_has_read' => :'BOOLEAN', :'release_date' => :'DateTime', :'assigned_date' => :'DateTime', :'changed_date' => :'DateTime', :'queue' => :'Queue', :'media_type' => :'Array<String>', :'rescore' => :'BOOLEAN', :'conversation_date' => :'DateTime', :'conversation_end_date' => :'DateTime', :'never_release' => :'BOOLEAN', :'resource_id' => :'String', :'resource_type' => :'String', :'redacted' => :'BOOLEAN', :'is_scoring_index' => :'BOOLEAN', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/evaluation.rb, line 684 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && conversation == o.conversation && evaluation_form == o.evaluation_form && evaluator == o.evaluator && agent == o.agent && calibration == o.calibration && status == o.status && answers == o.answers && agent_has_read == o.agent_has_read && release_date == o.release_date && assigned_date == o.assigned_date && changed_date == o.changed_date && queue == o.queue && media_type == o.media_type && rescore == o.rescore && conversation_date == o.conversation_date && conversation_end_date == o.conversation_end_date && never_release == o.never_release && resource_id == o.resource_id && resource_type == o.resource_type && redacted == o.redacted && is_scoring_index == o.is_scoring_index && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/evaluation.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/evaluation.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/evaluation.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
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/evaluation.rb, line 715 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/evaluation.rb, line 721 def hash [id, name, conversation, evaluation_form, evaluator, agent, calibration, status, answers, agent_has_read, release_date, assigned_date, changed_date, queue, media_type, rescore, conversation_date, conversation_end_date, never_release, resource_id, resource_type, redacted, is_scoring_index, self_uri].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/evaluation.rb, line 424 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] resource_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/evaluation.rb, line 656 def resource_type=(resource_type) allowed_values = ["EMAIL"] if resource_type && !allowed_values.include?(resource_type) fail ArgumentError, "invalid value for 'resource_type', must be one of #{allowed_values}." end @resource_type = resource_type end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/purecloudplatformclientv2/models/evaluation.rb, line 582 def status=(status) allowed_values = ["PENDING", "INPROGRESS", "FINISHED"] if status && !allowed_values.include?(status) fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}." end @status = status end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/evaluation.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/evaluation.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/evaluation.rb, line 433 def valid? allowed_values = ["PENDING", "INPROGRESS", "FINISHED"] if @status && !allowed_values.include?(@status) return false end allowed_values = ["EMAIL"] if @resource_type && !allowed_values.include?(@resource_type) return false end end