Class: PureCloud::ConversationQuery

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationQuery

Returns a new instance of ConversationQuery.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# 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

Instance Attribute Details

#aggregations ⇒ Object

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



34
35
36
 
# File 'lib/purecloud/models/conversation_query.rb', line 34

def aggregations
  @aggregations
end

#conversation_filters ⇒ Object

Filters that target conversation-level data



25
26
27
 
# File 'lib/purecloud/models/conversation_query.rb', line 25

def conversation_filters
  @conversation_filters
end

#evaluation_filters ⇒ Object

Filters that target quality management evaluation-level data



28
29
30
 
# File 'lib/purecloud/models/conversation_query.rb', line 28

def evaluation_filters
  @evaluation_filters
end

#interval ⇒ Object

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



22
23
24
 
# File 'lib/purecloud/models/conversation_query.rb', line 22

def interval
  @interval
end

#order ⇒ Object

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



40
41
42
 
# File 'lib/purecloud/models/conversation_query.rb', line 40

def order
  @order
end

#order_by ⇒ Object

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



43
44
45
 
# File 'lib/purecloud/models/conversation_query.rb', line 43

def order_by
  @order_by
end

#paging ⇒ Object

Page size and number to control iterating through large result sets. Default page size is 25



37
38
39
 
# File 'lib/purecloud/models/conversation_query.rb', line 37

def paging
  @paging
end

#segment_filters ⇒ Object

Filters that target individual segments within a conversation



31
32
33
 
# File 'lib/purecloud/models/conversation_query.rb', line 31

def segment_filters
  @segment_filters
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# 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

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



151
152
153
154
155
156
157
158
159
160
161
162
 
# 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

#_deserialize(type, value) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# 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

#_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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# 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_from_hash(attributes) ⇒ Object

build the object from hash



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# 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

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


165
166
167
 
# File 'lib/purecloud/models/conversation_query.rb', line 165

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



170
171
172
 
# 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

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



237
238
239
 
# File 'lib/purecloud/models/conversation_query.rb', line 237

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



242
243
244
245
246
247
248
249
250
 
# 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

#to_s ⇒ Object 



232
233
234
 
# File 'lib/purecloud/models/conversation_query.rb', line 232

def to_s
  to_hash.to_s
end