Class: PureCloud::ConversationNotificationMessage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationNotificationMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  
  if attributes.has_key?(:'provider')
    
    
    self.provider = attributes[:'provider']
    
  
  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?(:'disconnectType')
    
    
    self.disconnect_type = attributes[:'disconnectType']
    
  
  end

  
  if attributes.has_key?(:'startHoldTime')
    
    
    self.start_hold_time = attributes[:'startHoldTime']
    
  
  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?(:'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?(:'messagesTranscriptUri')
    
    
    self.messages_transcript_uri = attributes[:'messagesTranscriptUri']
    
  
  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?(:'additionalProperties')
    
    
    self.additional_properties = attributes[:'additionalProperties']
    
  
  end

  
end

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



55
56
57
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 55

def additional_properties
  @additional_properties
end

#connected_time ⇒ Object

Returns the value of attribute connected_time.



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

def connected_time
  @connected_time
end

#disconnect_type ⇒ Object

Returns the value of attribute disconnect_type.



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

def disconnect_type
  @disconnect_type
end

#disconnected_time ⇒ Object

Returns the value of attribute disconnected_time.



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

def disconnected_time
  @disconnected_time
end

#from_address ⇒ Object

Returns the value of attribute from_address.



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

def from_address
  @from_address
end

#held ⇒ Object

Returns the value of attribute held.



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

def held
  @held
end

#id ⇒ Object

Returns the value of attribute id.



21
22
23
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 21

def id
  @id
end

#messages ⇒ Object

Returns the value of attribute messages.



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

def messages
  @messages
end

#messages_transcript_uri ⇒ Object

Returns the value of attribute messages_transcript_uri.



47
48
49
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 47

def messages_transcript_uri
  @messages_transcript_uri
end

#peer_id ⇒ Object

Returns the value of attribute peer_id.



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

def peer_id
  @peer_id
end

#provider ⇒ Object

Returns the value of attribute provider.



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

def provider
  @provider
end

#recipient_country ⇒ Object

Returns the value of attribute recipient_country.



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

def recipient_country
  @recipient_country
end

#recipient_type ⇒ Object

Returns the value of attribute recipient_type.



53
54
55
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 53

def recipient_type
  @recipient_type
end

#script_id ⇒ Object

Returns the value of attribute script_id.



29
30
31
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 29

def script_id
  @script_id
end

#start_hold_time ⇒ Object

Returns the value of attribute start_hold_time.



35
36
37
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 35

def start_hold_time
  @start_hold_time
end

#state ⇒ Object

Returns the value of attribute state.



23
24
25
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 23

def state
  @state
end

#to_address ⇒ Object

Returns the value of attribute to_address.



41
42
43
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 41

def to_address
  @to_address
end

#type ⇒ Object

Returns the value of attribute type.



49
50
51
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 49

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 58

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'state' => :'state',
    
    :'held' => :'held',
    
    :'provider' => :'provider',
    
    :'script_id' => :'scriptId',
    
    :'peer_id' => :'peerId',
    
    :'disconnect_type' => :'disconnectType',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'connected_time' => :'connectedTime',
    
    :'disconnected_time' => :'disconnectedTime',
    
    :'to_address' => :'toAddress',
    
    :'from_address' => :'fromAddress',
    
    :'messages' => :'messages',
    
    :'messages_transcript_uri' => :'messagesTranscriptUri',
    
    :'type' => :'type',
    
    :'recipient_country' => :'recipientCountry',
    
    :'recipient_type' => :'recipientType',
    
    :'additional_properties' => :'additionalProperties'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'state' => :'String',
    
    :'held' => :'BOOLEAN',
    
    :'provider' => :'String',
    
    :'script_id' => :'String',
    
    :'peer_id' => :'String',
    
    :'disconnect_type' => :'String',
    
    :'start_hold_time' => :'DateTime',
    
    :'connected_time' => :'DateTime',
    
    :'disconnected_time' => :'DateTime',
    
    :'to_address' => :'ConversationNotificationAddress',
    
    :'from_address' => :'ConversationNotificationAddress',
    
    :'messages' => :'Array<ConversationNotificationMessages>',
    
    :'messages_transcript_uri' => :'String',
    
    :'type' => :'String',
    
    :'recipient_country' => :'String',
    
    :'recipient_type' => :'String',
    
    :'additional_properties' => :'Object'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 540

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      state == o.state &&
      held == o.held &&
      provider == o.provider &&
      script_id == o.script_id &&
      peer_id == o.peer_id &&
      disconnect_type == o.disconnect_type &&
      start_hold_time == o.start_hold_time &&
      connected_time == o.connected_time &&
      disconnected_time == o.disconnected_time &&
      to_address == o.to_address &&
      from_address == o.from_address &&
      messages == o.messages &&
      messages_transcript_uri == o.messages_transcript_uri &&
      type == o.type &&
      recipient_country == o.recipient_country &&
      recipient_type == o.recipient_type &&
      additional_properties == o.additional_properties
end

#_deserialize(type, value) ⇒ Object 



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 595

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



655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 655

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



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 576

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


565
566
567
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 565

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



571
572
573
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 571

def hash
  [id, state, held, provider, script_id, peer_id, disconnect_type, start_hold_time, connected_time, disconnected_time, to_address, from_address, messages, messages_transcript_uri, type, recipient_country, recipient_type, additional_properties].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



320
321
322
323
324
325
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 320

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



638
639
640
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 638

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



643
644
645
646
647
648
649
650
651
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 643

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 



633
634
635
 
# File 'lib/purecloudclient_v2a/models/conversation_notification_message.rb', line 633

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



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

def valid?
  
  
  
  
  
  
  
  allowed_values = ["ALERTING", "CONNECTED", "DISCONNECTED"]
  if @state && !allowed_values.include?(@state)
    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 = ["SMS"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end