Class: PureCloud::ConversationQuery

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationQuery

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



107
108
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/purecloudplatformclientv2/models/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?(:'interval')
    
    
    self.interval = attributes[:'interval']
    
  
  end

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

  
  if attributes.has_key?(:'paging')
    
    
    self.paging = attributes[:'paging']
    
  
  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



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 46

def aggregations
  @aggregations
end

#conversation_filters ⇒ Object

Filters that target conversation-level data



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

def conversation_filters
  @conversation_filters
end

#evaluation_filters ⇒ Object

Filters that target evaluations



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

def evaluation_filters
  @evaluation_filters
end

#interval ⇒ Object

Specifies the date and time range of data being queried. Results will include conversations that both started on a day touched by the interval AND either started, ended, or any activity during the interval. 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/purecloudplatformclientv2/models/conversation_query.rb', line 22

def interval
  @interval
end

#media_endpoint_stat_filters ⇒ Object

Filters that target mediaEndpointStats



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

def media_endpoint_stat_filters
  @media_endpoint_stat_filters
end

#order ⇒ Object

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



40
41
42
 
# File 'lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 49

def paging
  @paging
end

#segment_filters ⇒ Object

Filters that target individual segments within a conversation



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

def segment_filters
  @segment_filters
end

#survey_filters ⇒ Object

Filters that target surveys



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

def survey_filters
  @survey_filters
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 52

def self.attribute_map
  {
    
    :'interval' => :'interval',
    
    :'conversation_filters' => :'conversationFilters',
    
    :'segment_filters' => :'segmentFilters',
    
    :'evaluation_filters' => :'evaluationFilters',
    
    :'media_endpoint_stat_filters' => :'mediaEndpointStatFilters',
    
    :'survey_filters' => :'surveyFilters',
    
    :'order' => :'order',
    
    :'order_by' => :'orderBy',
    
    :'aggregations' => :'aggregations',
    
    :'paging' => :'paging'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 79

def self.swagger_types
  {
    
    :'interval' => :'String',
    
    :'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',
    
    :'aggregations' => :'Array<AnalyticsQueryAggregation>',
    
    :'paging' => :'PagingSpec'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 359

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      interval == o.interval &&
      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 &&
      aggregations == o.aggregations &&
      paging == o.paging
end

#_deserialize(type, value) ⇒ Object 



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 406

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



466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 466

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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 387

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


376
377
378
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 376

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



382
383
384
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 382

def hash
  [interval, conversation_filters, segment_filters, evaluation_filters, media_endpoint_stat_filters, survey_filters, order, order_by, aggregations, paging].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



220
221
222
223
224
225
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 220

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



449
450
451
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 449

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



454
455
456
457
458
459
460
461
462
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 454

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 



444
445
446
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 444

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/purecloudplatformclientv2/models/conversation_query.rb', line 229

def valid?
  
  
  if @interval.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  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
  
  
  
  
  
  
  
  
  
  
  
end