Class: PureCloud::Conversation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Conversation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
217
218
219
220
221
222
223
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 113

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#address ⇒ Object

The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound.



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

def address
  @address
end

#conversation_ids ⇒ Object

A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.



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

def conversation_ids
  @conversation_ids
end

#end_time ⇒ Object

The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def end_time
  @end_time
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#max_participants ⇒ Object

If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference.



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

def max_participants
  @max_participants
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#participants ⇒ Object

The list of all participants in the conversation.



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

def participants
  @participants
end

#recording_state ⇒ Object

On update, ‘paused’ initiates a secure pause, ‘active’ resumes any paused recordings; otherwise indicates state of conversation recording.



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

def recording_state
  @recording_state
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#start_time ⇒ Object

The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def start_time
  @start_time
end

#state ⇒ Object

The conversation’s state



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

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 54

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'start_time' => :'startTime',
    
    :'end_time' => :'endTime',
    
    :'address' => :'address',
    
    :'participants' => :'participants',
    
    :'conversation_ids' => :'conversationIds',
    
    :'max_participants' => :'maxParticipants',
    
    :'recording_state' => :'recordingState',
    
    :'state' => :'state',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'start_time' => :'DateTime',
    
    :'end_time' => :'DateTime',
    
    :'address' => :'String',
    
    :'participants' => :'Array<Participant>',
    
    :'conversation_ids' => :'Array<String>',
    
    :'max_participants' => :'Integer',
    
    :'recording_state' => :'String',
    
    :'state' => :'String',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 380

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      address == o.address &&
      participants == o.participants &&
      conversation_ids == o.conversation_ids &&
      max_participants == o.max_participants &&
      recording_state == o.recording_state &&
      state == o.state &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 428

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



488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 488

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



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 409

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


398
399
400
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 398

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



404
405
406
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 404

def hash
  [id, name, start_time, end_time, address, participants, conversation_ids, max_participants, recording_state, state, 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



227
228
229
230
231
232
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 227

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



471
472
473
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 471

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



476
477
478
479
480
481
482
483
484
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 476

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 



466
467
468
 
# File 'lib/purecloudclient_v2a/models/conversation.rb', line 466

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



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

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

  
  
  
  
  
  
  
  
  
  
  
  
  
  if @participants.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["ACTIVE", "PAUSED", "NONE"]
  if @recording_state && !allowed_values.include?(@recording_state)
    return false
  end
  
  
  
  
  
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "none"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
end