class PureCloud::AsyncConversationQuery

Attributes

conversation_filters[RW]

Filters that target conversation-level data

evaluation_filters[RW]

Filters that target evaluations

interval[RW]

Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss

limit[RW]

Specify number of results to be returned

media_endpoint_stat_filters[RW]

Filters that target mediaEndpointStats

order[RW]

Sort the result set in ascending/descending order. Default is ascending

order_by[RW]

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

segment_filters[RW]

Filters that target individual segments within a conversation

start_of_day_interval_matching[RW]

Add a filter to only include conversations that started after the beginning of the interval start date (UTC)

survey_filters[RW]

Filters that target surveys

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 52
def self.attribute_map
  {
    
    :'conversation_filters' => :'conversationFilters',
    
    :'segment_filters' => :'segmentFilters',
    
    :'evaluation_filters' => :'evaluationFilters',
    
    :'media_endpoint_stat_filters' => :'mediaEndpointStatFilters',
    
    :'survey_filters' => :'surveyFilters',
    
    :'order' => :'order',
    
    :'order_by' => :'orderBy',
    
    :'interval' => :'interval',
    
    :'limit' => :'limit',
    
    :'start_of_day_interval_matching' => :'startOfDayIntervalMatching'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 107
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?(:'conversationFilters')
    
    if (value = attributes[:'conversationFilters']).is_a?(Array)
      self.conversation_filters = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'segmentFilters')
    
    if (value = attributes[:'segmentFilters']).is_a?(Array)
      self.segment_filters = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'evaluationFilters')
    
    if (value = attributes[:'evaluationFilters']).is_a?(Array)
      self.evaluation_filters = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'mediaEndpointStatFilters')
    
    if (value = attributes[:'mediaEndpointStatFilters']).is_a?(Array)
      self.media_endpoint_stat_filters = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'surveyFilters')
    
    if (value = attributes[:'surveyFilters']).is_a?(Array)
      self.survey_filters = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'order')
    
    
    self.order = attributes[:'order']
    
  
  end

  
  if attributes.has_key?(:'orderBy')
    
    
    self.order_by = attributes[:'orderBy']
    
  
  end

  
  if attributes.has_key?(:'interval')
    
    
    self.interval = attributes[:'interval']
    
  
  end

  
  if attributes.has_key?(:'limit')
    
    
    self.limit = attributes[:'limit']
    
  
  end

  
  if attributes.has_key?(:'startOfDayIntervalMatching')
    
    
    self.start_of_day_interval_matching = attributes[:'startOfDayIntervalMatching']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 79
def self.swagger_types
  {
    
    :'conversation_filters' => :'Array<ConversationDetailQueryFilter>',
    
    :'segment_filters' => :'Array<SegmentDetailQueryFilter>',
    
    :'evaluation_filters' => :'Array<EvaluationDetailQueryFilter>',
    
    :'media_endpoint_stat_filters' => :'Array<MediaEndpointStatDetailQueryFilter>',
    
    :'survey_filters' => :'Array<SurveyDetailQueryFilter>',
    
    :'order' => :'String',
    
    :'order_by' => :'String',
    
    :'interval' => :'String',
    
    :'limit' => :'Integer',
    
    :'start_of_day_interval_matching' => :'BOOLEAN'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 357
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      conversation_filters == o.conversation_filters &&
      segment_filters == o.segment_filters &&
      evaluation_filters == o.evaluation_filters &&
      media_endpoint_stat_filters == o.media_endpoint_stat_filters &&
      survey_filters == o.survey_filters &&
      order == o.order &&
      order_by == o.order_by &&
      interval == o.interval &&
      limit == o.limit &&
      start_of_day_interval_matching == o.start_of_day_interval_matching
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 404
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
_to_hash(value) click to toggle source

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/async_conversation_query.rb, line 464
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_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 385
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 374
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 380
def hash
  [conversation_filters, segment_filters, evaluation_filters, media_endpoint_stat_filters, survey_filters, order, order_by, interval, limit, start_of_day_interval_matching].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 218
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
order=(order) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] order Object to be assigned

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 315
def order=(order)
  allowed_values = ["asc", "desc"]
  if order && !allowed_values.include?(order)
    fail ArgumentError, "invalid value for 'order', must be one of #{allowed_values}."
  end
  @order = order
end
order_by=(order_by) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] order_by Object to be assigned

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 329
def order_by=(order_by)
  allowed_values = ["conversationStart", "conversationEnd", "segmentStart", "segmentEnd"]
  if order_by && !allowed_values.include?(order_by)
    fail ArgumentError, "invalid value for 'order_by', must be one of #{allowed_values}."
  end
  @order_by = order_by
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 447
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 452
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
to_s() click to toggle source
# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 442
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/async_conversation_query.rb, line 227
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["asc", "desc"]
  if @order && !allowed_values.include?(@order)
    return false
  end
  
  
  
  
  
  allowed_values = ["conversationStart", "conversationEnd", "segmentStart", "segmentEnd"]
  if @order_by && !allowed_values.include?(@order_by)
    return false
  end
  
  
  
  
  if @interval.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
end