Class: PureCloud::UserDetailsQuery

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/user_details_query.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserDetailsQuery

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 93

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#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/purecloudclient_v2a/models/user_details_query.rb', line 22

def interval
  @interval
end

#order ⇒ Object

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



43
44
45
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 43

def order
  @order
end

#paging ⇒ Object

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



40
41
42
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 40

def paging
  @paging
end

#presence_aggregations ⇒ Object

Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters



34
35
36
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 34

def presence_aggregations
  @presence_aggregations
end

#presence_filters ⇒ Object

Filters that target system and organization presence-level data



28
29
30
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 28

def presence_filters
  @presence_filters
end

#routing_status_aggregations ⇒ Object

Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters



37
38
39
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 37

def routing_status_aggregations
  @routing_status_aggregations
end

#routing_status_filters ⇒ Object

Filters that target agent routing status-level data



31
32
33
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 31

def routing_status_filters
  @routing_status_filters
end

#user_filters ⇒ Object

Filters that target the users to retrieve data for



25
26
27
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 25

def user_filters
  @user_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/purecloudclient_v2a/models/user_details_query.rb', line 46

def self.attribute_map
  {
    
    :'interval' => :'interval',
    
    :'user_filters' => :'userFilters',
    
    :'presence_filters' => :'presenceFilters',
    
    :'routing_status_filters' => :'routingStatusFilters',
    
    :'presence_aggregations' => :'presenceAggregations',
    
    :'routing_status_aggregations' => :'routingStatusAggregations',
    
    :'paging' => :'paging',
    
    :'order' => :'order'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 69

def self.swagger_types
  {
    
    :'interval' => :'String',
    
    :'user_filters' => :'Array<AnalyticsQueryFilter>',
    
    :'presence_filters' => :'Array<AnalyticsQueryFilter>',
    
    :'routing_status_filters' => :'Array<AnalyticsQueryFilter>',
    
    :'presence_aggregations' => :'Array<AnalyticsQueryAggregation>',
    
    :'routing_status_aggregations' => :'Array<AnalyticsQueryAggregation>',
    
    :'paging' => :'PagingSpec',
    
    :'order' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 288

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      interval == o.interval &&
      user_filters == o.user_filters &&
      presence_filters == o.presence_filters &&
      routing_status_filters == o.routing_status_filters &&
      presence_aggregations == o.presence_aggregations &&
      routing_status_aggregations == o.routing_status_aggregations &&
      paging == o.paging &&
      order == o.order
end

#_deserialize(type, value) ⇒ Object 



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 333

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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 393

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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 314

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


303
304
305
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



309
310
311
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 309

def hash
  [interval, user_filters, presence_filters, routing_status_filters, presence_aggregations, routing_status_aggregations, paging, order].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



186
187
188
189
190
191
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 186

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



376
377
378
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 376

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



381
382
383
384
385
386
387
388
389
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 381

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 



371
372
373
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 371

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



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
231
232
233
234
 
# File 'lib/purecloudclient_v2a/models/user_details_query.rb', line 195

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["asc", "desc"]
  if @order && !allowed_values.include?(@order)
    return false
  end
  
  
  
end