Class: PureCloud::Recording

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Recording

Returns a new instance of Recording.



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
242
243
244
245
246
247
 
# File 'lib/purecloud/models/recording.rb', line 144

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'conversationId']
    self.conversation_id = attributes[:'conversationId']
  end
  
  if attributes[:'path']
    self._path = attributes[:'path']
  end
  
  if attributes[:'startTime']
    self.start_time = attributes[:'startTime']
  end
  
  if attributes[:'endTime']
    self.end_time = attributes[:'endTime']
  end
  
  if attributes[:'media']
    self.media = attributes[:'media']
  end
  
  if attributes[:'annotations']
    if (value = attributes[:'annotations']).is_a?(Array)
      self.annotations = value
    end
  end
  
  if attributes[:'transcript']
    if (value = attributes[:'transcript']).is_a?(Array)
      self.transcript = value
    end
  end
  
  if attributes[:'emailTranscript']
    if (value = attributes[:'emailTranscript']).is_a?(Array)
      self.email_transcript = value
    end
  end
  
  if attributes[:'fileState']
    self.file_state = attributes[:'fileState']
  end
  
  if attributes[:'restoreExpirationTime']
    self.restore_expiration_time = attributes[:'restoreExpirationTime']
  end
  
  if attributes[:'mediaUris']
    if (value = attributes[:'mediaUris']).is_a?(Array)
      self.media_uris = value
    end
  end
  
  if attributes[:'estimatedTranscodeTimeMs']
    self.estimated_transcode_time_ms = attributes[:'estimatedTranscodeTimeMs']
  end
  
  if attributes[:'actualTranscodeTimeMs']
    self.actual_transcode_time_ms = attributes[:'actualTranscodeTimeMs']
  end
  
  if attributes[:'archiveDate']
    self.archive_date = attributes[:'archiveDate']
  end
  
  if attributes[:'archiveMedium']
    self.archive_medium = attributes[:'archiveMedium']
  end
  
  if attributes[:'deleteDate']
    self.delete_date = attributes[:'deleteDate']
  end
  
  if attributes[:'maxAllowedRestorationsForOrg']
    self.max_allowed_restorations_for_org = attributes[:'maxAllowedRestorationsForOrg']
  end
  
  if attributes[:'remainingRestorationsAllowedForOrg']
    self.remaining_restorations_allowed_for_org = attributes[:'remainingRestorationsAllowedForOrg']
  end
  
  if attributes[:'sessionId']
    self.session_id = attributes[:'sessionId']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#_path ⇒ Object

Returns the value of attribute _path.



12
13
14
 
# File 'lib/purecloud/models/recording.rb', line 12

def _path
  @_path
end

#actual_transcode_time_ms ⇒ Object

Returns the value of attribute actual_transcode_time_ms.



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

def actual_transcode_time_ms
  @actual_transcode_time_ms
end

#annotations ⇒ Object

Annotations that belong to the recording.



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

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



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

def archive_date
  @archive_date
end

#archive_medium ⇒ Object

The type of archive medium used. Example: CloudArchive



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

def archive_medium
  @archive_medium
end

#conversation_id ⇒ Object

Returns the value of attribute conversation_id.



10
11
12
 
# File 'lib/purecloud/models/recording.rb', line 10

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



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

def delete_date
  @delete_date
end

#email_transcript ⇒ Object

Represents an email transcript



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

def email_transcript
  @email_transcript
end

#end_time ⇒ Object

Returns the value of attribute end_time.



16
17
18
 
# File 'lib/purecloud/models/recording.rb', line 16

def end_time
  @end_time
end

#estimated_transcode_time_ms ⇒ Object

Returns the value of attribute estimated_transcode_time_ms.



39
40
41
 
# File 'lib/purecloud/models/recording.rb', line 39

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



31
32
33
 
# File 'lib/purecloud/models/recording.rb', line 31

def file_state
  @file_state
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/recording.rb', line 6

def id
  @id
end

#max_allowed_restorations_for_org ⇒ Object

How many archive restorations the organization is allowed to have.



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

def max_allowed_restorations_for_org
  @max_allowed_restorations_for_org
end

#media ⇒ Object

The type of media that the recording is.



19
20
21
 
# File 'lib/purecloud/models/recording.rb', line 19

def media
  @media
end

#media_uris ⇒ Object

The different mediaUris for the recording.



37
38
39
 
# File 'lib/purecloud/models/recording.rb', line 37

def media_uris
  @media_uris
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/recording.rb', line 8

def name
  @name
end

#remaining_restorations_allowed_for_org ⇒ Object

The remaining archive restorations the organization has.



56
57
58
 
# File 'lib/purecloud/models/recording.rb', line 56

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



34
35
36
 
# File 'lib/purecloud/models/recording.rb', line 34

def restore_expiration_time
  @restore_expiration_time
end

#self_uri ⇒ Object

The URI for this object



62
63
64
 
# File 'lib/purecloud/models/recording.rb', line 62

def self_uri
  @self_uri
end

#session_id ⇒ Object

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



59
60
61
 
# File 'lib/purecloud/models/recording.rb', line 59

def session_id
  @session_id
end

#start_time ⇒ Object

Returns the value of attribute start_time.



14
15
16
 
# File 'lib/purecloud/models/recording.rb', line 14

def start_time
  @start_time
end

#transcript ⇒ Object

Represents a chat transcript



25
26
27
 
# File 'lib/purecloud/models/recording.rb', line 25

def transcript
  @transcript
end

Class Method Details

.attribute_map ⇒ Object

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



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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/purecloud/models/recording.rb', line 65

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',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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

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

#_deserialize(type, value) ⇒ Object 



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

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/purecloud/models/recording.rb', line 382

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/purecloud/models/recording.rb', line 306

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

Returns:

  • (Boolean)

See Also:

  • `==` method


296
297
298
 
# File 'lib/purecloud/models/recording.rb', line 296

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



301
302
303
 
# File 'lib/purecloud/models/recording.rb', line 301

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, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



365
366
367
 
# File 'lib/purecloud/models/recording.rb', line 365

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



370
371
372
373
374
375
376
377
378
 
# File 'lib/purecloud/models/recording.rb', line 370

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 



360
361
362
 
# File 'lib/purecloud/models/recording.rb', line 360

def to_s
  to_hash.to_s
end