Class: PureCloud::Recording

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Recording

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#actual_transcode_time_ms ⇒ Object

Returns the value of attribute actual_transcode_time_ms.



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

def actual_transcode_time_ms
  @actual_transcode_time_ms
end

#annotations ⇒ Object

Annotations that belong to the recording.



38
39
40
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 38

def annotations
  @annotations
end

#archive_date ⇒ Object

The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def archive_date
  @archive_date
end

#archive_medium ⇒ Object

The type of archive medium used. Example: CloudArchive



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

def archive_medium
  @archive_medium
end

#conversation_id ⇒ Object

Returns the value of attribute conversation_id.



26
27
28
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 26

def conversation_id
  @conversation_id
end

#delete_date ⇒ Object

The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def delete_date
  @delete_date
end

#email_transcript ⇒ Object

Represents an email transcript



44
45
46
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 44

def email_transcript
  @email_transcript
end

#end_time ⇒ Object

Returns the value of attribute end_time.



32
33
34
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 32

def end_time
  @end_time
end

#estimated_transcode_time_ms ⇒ Object

Returns the value of attribute estimated_transcode_time_ms.



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

def estimated_transcode_time_ms
  @estimated_transcode_time_ms
end

#file_state ⇒ Object

Represents the current file state for a recording. Examples: Uploading, Archived, etc



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

def file_state
  @file_state
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#max_allowed_restorations_for_org ⇒ Object

How many archive restorations the organization is allowed to have.



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

def max_allowed_restorations_for_org
  @max_allowed_restorations_for_org
end

#media ⇒ Object

The type of media that the recording is. At the moment that could be audio, chat, or email.



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

def media
  @media
end

#media_uris ⇒ Object

The different mediaUris for the recording.



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

def media_uris
  @media_uris
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#path ⇒ Object

Returns the value of attribute path.



28
29
30
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 28

def path
  @path
end

#remaining_restorations_allowed_for_org ⇒ Object

The remaining archive restorations the organization has.



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

def remaining_restorations_allowed_for_org
  @remaining_restorations_allowed_for_org
end

#restore_expiration_time ⇒ Object

The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



50
51
52
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 50

def restore_expiration_time
  @restore_expiration_time
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#session_id ⇒ Object

The session id represents an external resource id, such as email, call, chat, etc



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

def session_id
  @session_id
end

#start_time ⇒ Object

Returns the value of attribute start_time.



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

def start_time
  @start_time
end

#transcript ⇒ Object

Represents a chat transcript



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

def transcript
  @transcript
end

#users ⇒ Object

The users participating in the conversation



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

def users
  @users
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'conversation_id' => :'conversationId',
    
    :'path' => :'path',
    
    :'start_time' => :'startTime',
    
    :'end_time' => :'endTime',
    
    :'media' => :'media',
    
    :'annotations' => :'annotations',
    
    :'transcript' => :'transcript',
    
    :'email_transcript' => :'emailTranscript',
    
    :'file_state' => :'fileState',
    
    :'restore_expiration_time' => :'restoreExpirationTime',
    
    :'media_uris' => :'mediaUris',
    
    :'estimated_transcode_time_ms' => :'estimatedTranscodeTimeMs',
    
    :'actual_transcode_time_ms' => :'actualTranscodeTimeMs',
    
    :'archive_date' => :'archiveDate',
    
    :'archive_medium' => :'archiveMedium',
    
    :'delete_date' => :'deleteDate',
    
    :'max_allowed_restorations_for_org' => :'maxAllowedRestorationsForOrg',
    
    :'remaining_restorations_allowed_for_org' => :'remainingRestorationsAllowedForOrg',
    
    :'session_id' => :'sessionId',
    
    :'users' => :'users',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'conversation_id' => :'String',
    
    :'path' => :'String',
    
    :'start_time' => :'String',
    
    :'end_time' => :'String',
    
    :'media' => :'String',
    
    :'annotations' => :'Array<Annotation>',
    
    :'transcript' => :'Array<ChatMessage>',
    
    :'email_transcript' => :'Array<RecordingEmailMessage>',
    
    :'file_state' => :'String',
    
    :'restore_expiration_time' => :'DateTime',
    
    :'media_uris' => :'Hash<String, MediaResult>',
    
    :'estimated_transcode_time_ms' => :'Integer',
    
    :'actual_transcode_time_ms' => :'Integer',
    
    :'archive_date' => :'DateTime',
    
    :'archive_medium' => :'String',
    
    :'delete_date' => :'DateTime',
    
    :'max_allowed_restorations_for_org' => :'Integer',
    
    :'remaining_restorations_allowed_for_org' => :'Integer',
    
    :'session_id' => :'String',
    
    :'users' => :'Array<User>',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 670

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      conversation_id == o.conversation_id &&
      path == o.path &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      media == o.media &&
      annotations == o.annotations &&
      transcript == o.transcript &&
      email_transcript == o.email_transcript &&
      file_state == o.file_state &&
      restore_expiration_time == o.restore_expiration_time &&
      media_uris == o.media_uris &&
      estimated_transcode_time_ms == o.estimated_transcode_time_ms &&
      actual_transcode_time_ms == o.actual_transcode_time_ms &&
      archive_date == o.archive_date &&
      archive_medium == o.archive_medium &&
      delete_date == o.delete_date &&
      max_allowed_restorations_for_org == o.max_allowed_restorations_for_org &&
      remaining_restorations_allowed_for_org == o.remaining_restorations_allowed_for_org &&
      session_id == o.session_id &&
      users == o.users &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 730

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



790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 790

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



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 711

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


700
701
702
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 700

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



706
707
708
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 706

def hash
  [id, name, conversation_id, path, start_time, end_time, media, annotations, transcript, email_transcript, file_state, restore_expiration_time, media_uris, estimated_transcode_time_ms, actual_transcode_time_ms, archive_date, archive_medium, delete_date, max_allowed_restorations_for_org, remaining_restorations_allowed_for_org, session_id, users, 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



419
420
421
422
423
424
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 419

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



773
774
775
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 773

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



778
779
780
781
782
783
784
785
786
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 778

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 



768
769
770
 
# File 'lib/purecloudclient_v2a/models/recording.rb', line 768

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["ARCHIVED", "AVAILABLE", "DELETED", "RESTORED", "RESTORING", "UPLOADING", "ERROR"]
  if @file_state && !allowed_values.include?(@file_state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["CLOUDARCHIVE"]
  if @archive_medium && !allowed_values.include?(@archive_medium)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end