Class: PureCloud::UserQueue

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserQueue

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 139

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



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 53

def acw_settings
  @acw_settings
end

#bullseye ⇒ Object

The bulls-eye settings for the queue.



50
51
52
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 50

def bullseye
  @bullseye
end

#calling_party_name ⇒ Object

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



62
63
64
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 62

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.



65
66
67
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 65

def calling_party_number
  @calling_party_number
end

#created_by ⇒ Object

Returns the value of attribute created_by.



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 38

def created_by
  @created_by
end

#created_by_app ⇒ Object

Returns the value of attribute created_by_app.



44
45
46
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 44

def created_by_app
  @created_by_app
end

#date_created ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_created
  @date_created
end

#date_modified ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_modified
  @date_modified
end

#default_scripts ⇒ Object

The default script Ids for the communication types.



68
69
70
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 68

def default_scripts
  @default_scripts
end

#description ⇒ Object

Returns the value of attribute description.



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 26

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 22

def id
  @id
end

#joined ⇒ Object

Returns the value of attribute joined.



72
73
74
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 72

def joined
  @joined
end

#media_settings ⇒ Object

The media settings for the queue.



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 47

def media_settings
  @media_settings
end

#member_count ⇒ Object

Returns the value of attribute member_count.



74
75
76
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 74

def member_count
  @member_count
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 36

def modified_by
  @modified_by
end

#modified_by_app ⇒ Object

Returns the value of attribute modified_by_app.



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 42

def modified_by_app
  @modified_by_app
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 24

def name
  @name
end

#outbound_email_address ⇒ Object

Returns the value of attribute outbound_email_address.



70
71
72
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 70

def outbound_email_address
  @outbound_email_address
end

#queue_flow ⇒ Object

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



59
60
61
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 59

def queue_flow
  @queue_flow
end

#self_uri ⇒ Object

The URI for this object



77
78
79
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 77

def self_uri
  @self_uri
end

#skill_evaluation_method ⇒ Object

The skill evaluation method to use when routing conversations.



56
57
58
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 56

def skill_evaluation_method
  @skill_evaluation_method
end

#state ⇒ Object

Returns the value of attribute state.



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 40

def state
  @state
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    :'calling_party_name' => :'callingPartyName',
    :'calling_party_number' => :'callingPartyNumber',
    :'default_scripts' => :'defaultScripts',
    :'outbound_email_address' => :'outboundEmailAddress',
    :'joined' => :'joined',
    :'member_count' => :'memberCount',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 109

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',
    :'calling_party_name' => :'String',
    :'calling_party_number' => :'String',
    :'default_scripts' => :'Hash<String, Script>',
    :'outbound_email_address' => :'QueueEmailAddress',
    :'joined' => :'BOOLEAN',
    :'member_count' => :'Integer',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 297

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 &&
      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 &&
      joined == o.joined &&
      member_count == o.member_count &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 357

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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 417

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 338

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


327
328
329
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 327

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



333
334
335
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 333

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, calling_party_name, calling_party_number, default_scripts, outbound_email_address, joined, 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



245
246
247
248
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 245

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



400
401
402
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 400

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



405
406
407
408
409
410
411
412
413
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 405

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 



395
396
397
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 395

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/purecloudplatformclientv2/models/user_queue.rb', line 252

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