class PureCloud::ConversationQuery
Attributes
Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters
Filters that target conversation-level data
Filters that target quality management evaluation-level data
Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
Sort the result set in ascending/descending order. Default is ascending
Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart
Page
size and number to control iterating through large result sets. Default page size is 25
Filters that target individual segments within a conversation
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/conversation_query.rb, line 46 def self.attribute_map { :'interval' => :'interval', :'conversation_filters' => :'conversationFilters', :'evaluation_filters' => :'evaluationFilters', :'segment_filters' => :'segmentFilters', :'aggregations' => :'aggregations', :'paging' => :'paging', :'order' => :'order', :'order_by' => :'orderBy' } end
# File lib/purecloud/models/conversation_query.rb, line 83 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} if attributes[:'interval'] self.interval = attributes[:'interval'] end if attributes[:'conversationFilters'] if (value = attributes[:'conversationFilters']).is_a?(Array) self.conversation_filters = value end end if attributes[:'evaluationFilters'] if (value = attributes[:'evaluationFilters']).is_a?(Array) self.evaluation_filters = value end end if attributes[:'segmentFilters'] if (value = attributes[:'segmentFilters']).is_a?(Array) self.segment_filters = value end end if attributes[:'aggregations'] if (value = attributes[:'aggregations']).is_a?(Array) self.aggregations = value end end if attributes[:'paging'] self.paging = attributes[:'paging'] end if attributes[:'order'] self.order = attributes[:'order'] end if attributes[:'orderBy'] self.order_by = attributes[:'orderBy'] end end
Attribute
type mapping.
# File lib/purecloud/models/conversation_query.rb, line 69 def self.swagger_types { :'interval' => :'String', :'conversation_filters' => :'Array<AnalyticsQueryFilter>', :'evaluation_filters' => :'Array<AnalyticsQueryFilter>', :'segment_filters' => :'Array<AnalyticsQueryFilter>', :'aggregations' => :'Array<AnalyticsQueryAggregation>', :'paging' => :'PagingSpec', :'order' => :'String', :'order_by' => :'String' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/conversation_query.rb, line 151 def ==(o) return true if self.equal?(o) self.class == o.class && interval == o.interval && conversation_filters == o.conversation_filters && evaluation_filters == o.evaluation_filters && segment_filters == o.segment_filters && aggregations == o.aggregations && paging == o.paging && order == o.order && order_by == o.order_by end
# File lib/purecloud/models/conversation_query.rb, line 194 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/purecloud/models/conversation_query.rb, line 254 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/purecloud/models/conversation_query.rb, line 175 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
# File lib/purecloud/models/conversation_query.rb, line 165 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/conversation_query.rb, line 170 def hash [interval, conversation_filters, evaluation_filters, segment_filters, aggregations, paging, order, order_by].hash end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/conversation_query.rb, line 133 def order=(order) allowed_values = ["asc", "desc"] if order && !allowed_values.include?(order) fail "invalid value for 'order', must be one of #{allowed_values}" end @order = order end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/conversation_query.rb, line 142 def order_by=(order_by) allowed_values = ["conversationStart", "conversationEnd", "segmentStart", "segmentEnd"] if order_by && !allowed_values.include?(order_by) fail "invalid value for 'order_by', must be one of #{allowed_values}" end @order_by = order_by end
return the object in the form of hash
# File lib/purecloud/models/conversation_query.rb, line 242 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/purecloud/models/conversation_query.rb, line 232 def to_s to_hash.to_s end