Class: PureCloud::Message

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Message

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
430
431
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 204

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#after_call_work ⇒ Object

After-call work for the communication.



87
88
89
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 87

def after_call_work
  @after_call_work
end

#after_call_work_required ⇒ Object

Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested.



90
91
92
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 90

def after_call_work_required
  @after_call_work_required
end

#connected_time ⇒ Object

The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 51

def connected_time
  @connected_time
end

#direction ⇒ Object

The direction of the message.



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

def direction
  @direction
end

#disconnect_type ⇒ Object

System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.



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

def disconnect_type
  @disconnect_type
end

#disconnected_time ⇒ Object

The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



54
55
56
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 54

def disconnected_time
  @disconnected_time
end

#error_info ⇒ Object

Returns the value of attribute error_info.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 39

def error_info
  @error_info
end

#from_address ⇒ Object

Address and name data for a call endpoint.



78
79
80
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 78

def from_address
  @from_address
end

#held ⇒ Object

True if this call is held and the person on this side hears silence.



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

def held
  @held
end

#id ⇒ Object

A globally unique identifier for this communication.



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

def id
  @id
end

#messages ⇒ Object

The messages sent on this communication channel.



81
82
83
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 81

def messages
  @messages
end

#peer_id ⇒ Object

The id of the peer communication corresponding to a matching leg for this communication.



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

def peer_id
  @peer_id
end

#provider ⇒ Object

The source provider for the message.



57
58
59
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 57

def provider
  @provider
end

#recipient_country ⇒ Object

Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format.



63
64
65
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 63

def recipient_country
  @recipient_country
end

#recipient_type ⇒ Object

The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type.



66
67
68
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 66

def recipient_type
  @recipient_type
end

#recording_id ⇒ Object

A globally unique identifier for the recording associated with this message.



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

def recording_id
  @recording_id
end

#script_id ⇒ Object

The UUID of the script to use.



69
70
71
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 69

def script_id
  @script_id
end

#segments ⇒ Object

The time line of the participant’s message, divided into activity segments.



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

def segments
  @segments
end

#start_alerting_time ⇒ Object

The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



48
49
50
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 48

def start_alerting_time
  @start_alerting_time
end

#start_hold_time ⇒ Object

The timestamp the message was placed on hold in the cloud clock if the message is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 45

def start_hold_time
  @start_hold_time
end

#state ⇒ Object

The connection state of this communication.



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

def state
  @state
end

#to_address ⇒ Object

Address and name data for a call endpoint.



75
76
77
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 75

def to_address
  @to_address
end

#type ⇒ Object

Indicates the type of message platform from which the message originated.



60
61
62
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 60

def type
  @type
end

#wrapup ⇒ Object

Call wrap up or disposition data.



84
85
86
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 84

def wrapup
  @wrapup
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'state' => :'state',
    
    :'id' => :'id',
    
    :'held' => :'held',
    
    :'segments' => :'segments',
    
    :'direction' => :'direction',
    
    :'recording_id' => :'recordingId',
    
    :'error_info' => :'errorInfo',
    
    :'disconnect_type' => :'disconnectType',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'start_alerting_time' => :'startAlertingTime',
    
    :'connected_time' => :'connectedTime',
    
    :'disconnected_time' => :'disconnectedTime',
    
    :'provider' => :'provider',
    
    :'type' => :'type',
    
    :'recipient_country' => :'recipientCountry',
    
    :'recipient_type' => :'recipientType',
    
    :'script_id' => :'scriptId',
    
    :'peer_id' => :'peerId',
    
    :'to_address' => :'toAddress',
    
    :'from_address' => :'fromAddress',
    
    :'messages' => :'messages',
    
    :'wrapup' => :'wrapup',
    
    :'after_call_work' => :'afterCallWork',
    
    :'after_call_work_required' => :'afterCallWorkRequired'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'state' => :'String',
    
    :'id' => :'String',
    
    :'held' => :'BOOLEAN',
    
    :'segments' => :'Array<Segment>',
    
    :'direction' => :'String',
    
    :'recording_id' => :'String',
    
    :'error_info' => :'ErrorBody',
    
    :'disconnect_type' => :'String',
    
    :'start_hold_time' => :'DateTime',
    
    :'start_alerting_time' => :'DateTime',
    
    :'connected_time' => :'DateTime',
    
    :'disconnected_time' => :'DateTime',
    
    :'provider' => :'String',
    
    :'type' => :'String',
    
    :'recipient_country' => :'String',
    
    :'recipient_type' => :'String',
    
    :'script_id' => :'String',
    
    :'peer_id' => :'String',
    
    :'to_address' => :'Address',
    
    :'from_address' => :'Address',
    
    :'messages' => :'Array<MessageDetails>',
    
    :'wrapup' => :'Wrapup',
    
    :'after_call_work' => :'AfterCallWork',
    
    :'after_call_work_required' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 723

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      id == o.id &&
      held == o.held &&
      segments == o.segments &&
      direction == o.direction &&
      recording_id == o.recording_id &&
      error_info == o.error_info &&
      disconnect_type == o.disconnect_type &&
      start_hold_time == o.start_hold_time &&
      start_alerting_time == o.start_alerting_time &&
      connected_time == o.connected_time &&
      disconnected_time == o.disconnected_time &&
      provider == o.provider &&
      type == o.type &&
      recipient_country == o.recipient_country &&
      recipient_type == o.recipient_type &&
      script_id == o.script_id &&
      peer_id == o.peer_id &&
      to_address == o.to_address &&
      from_address == o.from_address &&
      messages == o.messages &&
      wrapup == o.wrapup &&
      after_call_work == o.after_call_work &&
      after_call_work_required == o.after_call_work_required
end

#_deserialize(type, value) ⇒ Object 



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 784

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



844
845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 844

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



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 765

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


754
755
756
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 754

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



760
761
762
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 760

def hash
  [state, id, held, segments, direction, recording_id, error_info, disconnect_type, start_hold_time, start_alerting_time, connected_time, disconnected_time, provider, type, recipient_country, recipient_type, script_id, peer_id, to_address, from_address, messages, wrapup, after_call_work, after_call_work_required].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



435
436
437
438
439
440
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 435

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



827
828
829
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 827

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



832
833
834
835
836
837
838
839
840
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 832

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 



822
823
824
 
# File 'lib/purecloudplatformclientv2/models/message.rb', line 822

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



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

def valid?
  
  
  
  allowed_values = ["alerting", "connected", "disconnected"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["inbound", "outbound"]
  if @direction && !allowed_values.include?(@direction)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["endpoint", "client", "system", "timeout", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transfer.noanswer", "transfer.notavailable", "transport.failure", "error", "peer", "other", "spam", "uncallable"]
  if @disconnect_type && !allowed_values.include?(@disconnect_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["unknown", "sms", "twitter", "facebook", "line", "whatsapp", "telegram", "kakao", "webmessaging"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end