Class: PureCloud::Queue

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Queue

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 202

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?(:'id')
    
    
    self.id = attributes[:'id']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#acw_settings ⇒ Object

The ACW settings for the queue.



60
61
62
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 60

def acw_settings
  @acw_settings
end

#auto_answer_only ⇒ Object

Specifies whether the configured whisper audio should play for all ACD calls, or only for those which are auto-answered.



72
73
74
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 72

def auto_answer_only
  @auto_answer_only
end

#bullseye ⇒ Object

The bulls-eye settings for the queue.



57
58
59
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 57

def bullseye
  @bullseye
end

#calling_party_name ⇒ Object

The name to use for caller identification for outbound calls from this queue.



75
76
77
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 75

def calling_party_name
  @calling_party_name
end

#calling_party_number ⇒ Object

The phone number to use for caller identification for outbound calls from this queue.



78
79
80
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 78

def calling_party_number
  @calling_party_number
end

#created_by ⇒ Object

The ID of the user that created the resource.



42
43
44
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 42

def created_by
  @created_by
end

#created_by_app ⇒ Object

The application that created the resource.



51
52
53
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 51

def created_by_app
  @created_by_app
end

#date_created ⇒ Object

The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



33
34
35
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 33

def date_created
  @date_created
end

#date_modified ⇒ Object

The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



36
37
38
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 36

def date_modified
  @date_modified
end

#default_scripts ⇒ Object

The default script Ids for the communication types.



81
82
83
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 81

def default_scripts
  @default_scripts
end

#description ⇒ Object

The resource’s description.



27
28
29
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 27

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 22

def id
  @id
end

#media_settings ⇒ Object

The media settings for the queue. Valid Key Values: CALL, CALLBACK, CHAT, EMAIL, SOCIAL_EXPRESSION



54
55
56
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 54

def media_settings
  @media_settings
end

#member_count ⇒ Object

Returns the value of attribute member_count.



85
86
87
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 85

def member_count
  @member_count
end

#modified_by ⇒ Object

The ID of the user that last modified the resource.



39
40
41
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 39

def modified_by
  @modified_by
end

#modified_by_app ⇒ Object

The application that last modified the resource.



48
49
50
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 48

def modified_by_app
  @modified_by_app
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 24

def name
  @name
end

#outbound_email_address ⇒ Object

Returns the value of attribute outbound_email_address.



83
84
85
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 83

def outbound_email_address
  @outbound_email_address
end

#queue_flow ⇒ Object

The in-queue flow to use for conversations waiting in queue.



66
67
68
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 66

def queue_flow
  @queue_flow
end

#self_uri ⇒ Object

The URI for this object



88
89
90
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 88

def self_uri
  @self_uri
end

#skill_evaluation_method ⇒ Object

The skill evaluation method to use when routing conversations.



63
64
65
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 63

def skill_evaluation_method
  @skill_evaluation_method
end

#state ⇒ Object

Indicates if the resource is active, inactive, or deleted.



45
46
47
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 45

def state
  @state
end

#version ⇒ Object

The current version of the resource.



30
31
32
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 30

def version
  @version
end

#whisper ⇒ Object

The prompt used for whisper audio on the queue, if configured.



69
70
71
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 69

def whisper
  @whisper
end

Class Method Details

.attribute_map ⇒ Object

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



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
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 91

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'version' => :'version',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'modified_by' => :'modifiedBy',
    
    :'created_by' => :'createdBy',
    
    :'state' => :'state',
    
    :'modified_by_app' => :'modifiedByApp',
    
    :'created_by_app' => :'createdByApp',
    
    :'media_settings' => :'mediaSettings',
    
    :'bullseye' => :'bullseye',
    
    :'acw_settings' => :'acwSettings',
    
    :'skill_evaluation_method' => :'skillEvaluationMethod',
    
    :'queue_flow' => :'queueFlow',
    
    :'whisper' => :'whisper',
    
    :'auto_answer_only' => :'autoAnswerOnly',
    
    :'calling_party_name' => :'callingPartyName',
    
    :'calling_party_number' => :'callingPartyNumber',
    
    :'default_scripts' => :'defaultScripts',
    
    :'outbound_email_address' => :'outboundEmailAddress',
    
    :'member_count' => :'memberCount',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'version' => :'Integer',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'modified_by' => :'String',
    
    :'created_by' => :'String',
    
    :'state' => :'String',
    
    :'modified_by_app' => :'String',
    
    :'created_by_app' => :'String',
    
    :'media_settings' => :'Hash<String, MediaSetting>',
    
    :'bullseye' => :'Bullseye',
    
    :'acw_settings' => :'AcwSettings',
    
    :'skill_evaluation_method' => :'String',
    
    :'queue_flow' => :'UriReference',
    
    :'whisper' => :'UriReference',
    
    :'auto_answer_only' => :'BOOLEAN',
    
    :'calling_party_name' => :'String',
    
    :'calling_party_number' => :'String',
    
    :'default_scripts' => :'Hash<String, Script>',
    
    :'outbound_email_address' => :'QueueEmailAddress',
    
    :'member_count' => :'Integer',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 708

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      version == o.version &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      modified_by == o.modified_by &&
      created_by == o.created_by &&
      state == o.state &&
      modified_by_app == o.modified_by_app &&
      created_by_app == o.created_by_app &&
      media_settings == o.media_settings &&
      bullseye == o.bullseye &&
      acw_settings == o.acw_settings &&
      skill_evaluation_method == o.skill_evaluation_method &&
      queue_flow == o.queue_flow &&
      whisper == o.whisper &&
      auto_answer_only == o.auto_answer_only &&
      calling_party_name == o.calling_party_name &&
      calling_party_number == o.calling_party_number &&
      default_scripts == o.default_scripts &&
      outbound_email_address == o.outbound_email_address &&
      member_count == o.member_count &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 769

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



829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 829

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



750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 750

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


739
740
741
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 739

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



745
746
747
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 745

def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, whisper, auto_answer_only, calling_party_name, calling_party_number, default_scripts, outbound_email_address, member_count, self_uri].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



433
434
435
436
437
438
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 433

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



812
813
814
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 812

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



817
818
819
820
821
822
823
824
825
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 817

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 



807
808
809
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 807

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



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/purecloudclient_v2a/models/queue.rb', line 442

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["active", "inactive", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  if @media_settings.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  if @acw_settings.nil?
    return false
  end

  
  
  
  
  
  if @skill_evaluation_method.nil?
    return false
  end

  
  
  allowed_values = ["NONE", "BEST", "ALL"]
  if @skill_evaluation_method && !allowed_values.include?(@skill_evaluation_method)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end