Class: PureCloud::ConversationHistoricalQueryRequestFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/conversation_historical_query_request_filter.rb

Overview

Historical conversation request filter

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationHistoricalQueryRequestFilter

Returns a new instance of ConversationHistoricalQueryRequestFilter.


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 38

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[:'target']
    self.target = attributes[:'target']
  end
  
  if attributes[:'operator']
    self.operator = attributes[:'operator']
  end
  
  if attributes[:'values']
    if (value = attributes[:'values']).is_a?(Array)
      self.values = value
    end
  end
  
end

Instance Attribute Details

#operator ⇒ Object

Filter operator. For target ‘interval’ allowable values are ‘=’, ‘between’, ‘<=’, ‘before’, ‘>=’, ‘after’. For targets ‘active’, ‘agentId’, ‘connectedOnly’, ‘dialerCampaignId’, ‘disconnectType’, ‘mediaType’, ‘purpose’, ‘qualityEvaluationAgent’, ‘qualityEvaluationForm’, ‘qualityEvaluator’, ‘queueId’, ‘wrapUpCode’ allowable value is ‘=’. For target ‘duration’ allowable values are ‘=’, ‘<’, ‘<=’, ‘>’, ‘>=’. For targets ‘ani’, ‘dnis’, ‘freeText’ allowable value is ‘contains’. For targets ‘recordingRestored’, ‘qualityEvaluationCriticalScore’, ‘, qualityEvaluationScore’ no operator is required


10
11
12
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 10

def operator
  @operator
end

#target ⇒ Object

Filter target


7
8
9
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 7

def target
  @target
end

#values ⇒ Object

Filter values. For target ‘interval’ with operators ‘=’ or ‘between’, only 1 value is allowed in the form of 2 ISO-8601 dates separated by a ‘/’ with no spaces. For target ‘interval’ with operators ‘<=’, ‘before’, ‘>=’, ‘after’, only 1 value is allowed in the form of 1 ISO-8601 date. For targets ‘agentId’, ‘dialerCampaignId’, ‘qualityEvaluationAgent’, ‘qualityEvaluationForm’, ‘qualityEvaluator’, ‘queueId’, ‘wrapUpCode’ multiple values are allowed. All values are UUIDs. For target ‘disconnectType’ multiple values are allowed. Values can be one of ‘TRANSFER’, ‘CLIENT’, ‘REMOTE’. For target ‘mediaType’ multiple values are allowed. Values can be one of ‘VOICE’, ‘CHAT’, ‘EMAIL’.For target ‘purpose’ multiple values are allowed. For targets ‘active’, ‘connectedOnly’1 value is required and it must be either ‘true’ or ‘false’. For target ‘duration’ 2 values are required for operator ‘=’. For all other operators, 1 value is required. For targets ‘ani’, ‘dnis’, ‘freeText’ only a single value is allowed. For targets ‘recordingRestored’, ‘qualityEvaluationCriticalScore’, ‘, qualityEvaluationScore’ no values are required.


13
14
15
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 13

def values
  @values
end

Class Method Details

.attribute_map ⇒ Object

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


16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 16

def self.attribute_map
  {
    
    :'target' => :'target',
    
    :'operator' => :'operator',
    
    :'values' => :'values'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.


29
30
31
32
33
34
35
36
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 29

def self.swagger_types
  {
    :'target' => :'String',
    :'operator' => :'String',
    :'values' => :'Array<String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.


71
72
73
74
75
76
77
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 71

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      target == o.target &&
      operator == o.operator &&
      values == o.values
end

#_deserialize(type, value) ⇒ Object 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 109

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value


166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 166

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) ⇒ Object

build the object from hash


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 90

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) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method

80
81
82
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 80

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.


85
86
87
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 85

def hash
  [target, operator, values].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))


149
150
151
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 149

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash


154
155
156
157
158
159
160
161
162
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 154

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 ⇒ Object 


144
145
146
 
# File 'lib/purecloud/models/conversation_historical_query_request_filter.rb', line 144

def to_s
  to_hash.to_s
end