Class: PureCloud::RecordingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/recording_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RecordingApi

Returns a new instance of RecordingApi.



23
24
25
 
# File 'lib/purecloud/api/recording_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloud/api/recording_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {}) ⇒ nil

Delete annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Returns:

  • (nil) 


34
35
36
37
 
# File 'lib/purecloud/api/recording_api.rb', line 34

def delete_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
  delete_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
  return nil
end

#delete_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



46
47
48
49
50
51
52
53
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/purecloud/api/recording_api.rb', line 46

def delete_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#delete_conversation_id_recordings_recording_id_annotations_annotation_id ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
  
  # verify the required parameter 'recording_id' is set
  fail "Missing the required parameter 'recording_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
  
  # verify the required parameter 'annotation_id' is set
  fail "Missing the required parameter 'annotation_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#delete_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_mediaretentionpolicies(ids, opts = {}) ⇒ String

Delete media retention policies Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.

Parameters:

  • ids
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


101
102
103
104
 
# File 'lib/purecloud/api/recording_api.rb', line 101

def delete_mediaretentionpolicies(ids, opts = {})
  data, status_code, headers = delete_mediaretentionpolicies_with_http_info(ids, opts)
  return data
end

#delete_mediaretentionpolicies_policy_id(policy_id, opts = {}) ⇒ String

Delete a media retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Returns:

  • (String) 


162
163
164
165
 
# File 'lib/purecloud/api/recording_api.rb', line 162

def delete_mediaretentionpolicies_policy_id(policy_id, opts = {})
  data, status_code, headers = delete_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
  return data
end

#delete_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a media retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
 
# File 'lib/purecloud/api/recording_api.rb', line 172

def delete_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#delete_mediaretentionpolicies_policy_id ..."
  end
  
  # verify the required parameter 'policy_id' is set
  fail "Missing the required parameter 'policy_id' when calling delete_mediaretentionpolicies_policy_id" if policy_id.nil?
  
  # resource path
  local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#delete_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_mediaretentionpolicies_with_http_info(ids, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete media retention policies Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.

Parameters:

  • ids
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/purecloud/api/recording_api.rb', line 111

def delete_mediaretentionpolicies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#delete_mediaretentionpolicies ..."
  end
  
  # verify the required parameter 'ids' is set
  fail "Missing the required parameter 'ids' when calling delete_mediaretentionpolicies" if ids.nil?
  
  # resource path
  local_var_path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'ids'] = ids

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#delete_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_orphan_id(orphan_id, opts = {}) ⇒ OrphanRecording

deletes a single orphan recording

Parameters:

  • orphan_id —

    Orphan ID

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

    the optional parameters

Returns:



222
223
224
225
 
# File 'lib/purecloud/api/recording_api.rb', line 222

def delete_orphan_id(orphan_id, opts = {})
  data, status_code, headers = delete_orphan_id_with_http_info(orphan_id, opts)
  return data
end

#delete_orphan_id_with_http_info(orphan_id, opts = {}) ⇒ Array<(OrphanRecording, Fixnum, Hash)>

deletes a single orphan recording

Parameters:

  • orphan_id —

    Orphan ID

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

    the optional parameters

Returns:

  • (Array<(OrphanRecording, Fixnum, Hash)>) —

    OrphanRecording data, response status code and response headers



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
 
# File 'lib/purecloud/api/recording_api.rb', line 232

def delete_orphan_id_with_http_info(orphan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#delete_orphan_id ..."
  end
  
  # verify the required parameter 'orphan_id' is set
  fail "Missing the required parameter 'orphan_id' when calling delete_orphan_id" if orphan_id.nil?
  
  # resource path
  local_var_path = "/api/v2/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OrphanRecording')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#delete_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_id_recordings(conversation_id, opts = {}) ⇒ Array<Recording>

Get all of a Conversation’s Recordings.

Parameters:

  • conversation_id —

    Conversation ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format (WEBM, WAV) (default to WEBM)

Returns:



283
284
285
286
 
# File 'lib/purecloud/api/recording_api.rb', line 283

def get_conversation_id_recordings(conversation_id, opts = {})
  data, status_code, headers = get_conversation_id_recordings_with_http_info(conversation_id, opts)
  return data
end

#get_conversation_id_recordings_recording_id(conversation_id, recording_id, opts = {}) ⇒ nil

Gets a specific recording.

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format (WEBM, WAV) (default to WEBM)

  • :download (BOOLEAN) —

    requesting a download format of the recording (default to false)

  • :file_name (String) —

    the name of the downloaded fileName

Returns:

  • (nil) 


353
354
355
356
 
# File 'lib/purecloud/api/recording_api.rb', line 353

def get_conversation_id_recordings_recording_id(conversation_id, recording_id, opts = {})
  get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts)
  return nil
end

#get_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, opts = {}) ⇒ Array<Annotation>

Get annotations for recording

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Returns:



427
428
429
430
 
# File 'lib/purecloud/api/recording_api.rb', line 427

def get_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, opts = {})
  data, status_code, headers = get_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts)
  return data
end

#get_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {}) ⇒ Annotation

Get annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Returns:



493
494
495
496
 
# File 'lib/purecloud/api/recording_api.rb', line 493

def get_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
  data, status_code, headers = get_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
  return data
end

#get_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {}) ⇒ Array<(Annotation, Fixnum, Hash)>

Get annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Returns:

  • (Array<(Annotation, Fixnum, Hash)>) —

    Annotation data, response status code and response headers



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
 
# File 'lib/purecloud/api/recording_api.rb', line 505

def get_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id_annotations_annotation_id ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
  
  # verify the required parameter 'recording_id' is set
  fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
  
  # verify the required parameter 'annotation_id' is set
  fail "Missing the required parameter 'annotation_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Annotation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts = {}) ⇒ Array<(Array<Annotation>, Fixnum, Hash)>

Get annotations for recording

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Returns:

  • (Array<(Array<Annotation>, Fixnum, Hash)>) —

    Array<Annotation> data, response status code and response headers



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
 
# File 'lib/purecloud/api/recording_api.rb', line 438

def get_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id_annotations ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id_annotations" if conversation_id.nil?
  
  # verify the required parameter 'recording_id' is set
  fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id_annotations" if recording_id.nil?
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Annotation>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Gets a specific recording.

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format (WEBM, WAV)

  • :download (BOOLEAN) —

    requesting a download format of the recording

  • :file_name (String) —

    the name of the downloaded fileName

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/purecloud/api/recording_api.rb', line 367

def get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id" if conversation_id.nil?
  
  # verify the required parameter 'recording_id' is set
  fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id" if recording_id.nil?
  
  if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
    fail 'invalid value for "format_id", must be one of WEBM, WAV'
  end
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
  query_params[:'download'] = opts[:'download'] if opts[:'download']
  query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_id_recordings_with_http_info(conversation_id, opts = {}) ⇒ Array<(Array<Recording>, Fixnum, Hash)>

Get all of a Conversation&#39;s Recordings.

Parameters:

  • conversation_id —

    Conversation ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format (WEBM, WAV)

Returns:

  • (Array<(Array<Recording>, Fixnum, Hash)>) —

    Array<Recording> data, response status code and response headers



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
 
# File 'lib/purecloud/api/recording_api.rb', line 294

def get_conversation_id_recordings_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings" if conversation_id.nil?
  
  if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
    fail 'invalid value for "format_id", must be one of WEBM, WAV'
  end
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/recordings".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Recording>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mediaretentionpolicies(opts = {}) ⇒ PolicyEntityListing

Gets media retention policy list with query options to filter on name and enabled. for a less verbose response, add summary=true to this endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested (default to 25)

  • :page_number (Integer) —

    The page number requested (default to 1)

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :name (String) —

    the policy name - used for filtering results in searches.

  • :enabled (BOOLEAN) —

    checks to see if policy is enabled - use enabled = true or enabled = false

  • :summary (BOOLEAN) —

    provides a less verbose response of policy lists. (default to false)

  • :has_errors (BOOLEAN) —

    provides a way to fetch all policies with errors or policies that do not have errors

Returns:



570
571
572
573
 
# File 'lib/purecloud/api/recording_api.rb', line 570

def get_mediaretentionpolicies(opts = {})
  data, status_code, headers = get_mediaretentionpolicies_with_http_info(opts)
  return data
end

#get_mediaretentionpolicies_policy_id(policy_id, opts = {}) ⇒ Policy

Get a media retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Returns:



646
647
648
649
 
# File 'lib/purecloud/api/recording_api.rb', line 646

def get_mediaretentionpolicies_policy_id(policy_id, opts = {})
  data, status_code, headers = get_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
  return data
end

#get_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {}) ⇒ Array<(Policy, Fixnum, Hash)>

Get a media retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Returns:

  • (Array<(Policy, Fixnum, Hash)>) —

    Policy data, response status code and response headers



656
657
658
659
660
661
662
663
664
665
666
667
668
669
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
697
698
699
 
# File 'lib/purecloud/api/recording_api.rb', line 656

def get_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_mediaretentionpolicies_policy_id ..."
  end
  
  # verify the required parameter 'policy_id' is set
  fail "Missing the required parameter 'policy_id' when calling get_mediaretentionpolicies_policy_id" if policy_id.nil?
  
  # resource path
  local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Policy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mediaretentionpolicies_with_http_info(opts = {}) ⇒ Array<(PolicyEntityListing, Fixnum, Hash)>

Gets media retention policy list with query options to filter on name and enabled. for a less verbose response, add summary=true to this endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :name (String) —

    the policy name - used for filtering results in searches.

  • :enabled (BOOLEAN) —

    checks to see if policy is enabled - use enabled = true or enabled = false

  • :summary (BOOLEAN) —

    provides a less verbose response of policy lists.

  • :has_errors (BOOLEAN) —

    provides a way to fetch all policies with errors or policies that do not have errors

Returns:

  • (Array<(PolicyEntityListing, Fixnum, Hash)>) —

    PolicyEntityListing data, response status code and response headers



589
590
591
592
593
594
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
632
633
634
635
636
637
638
639
 
# File 'lib/purecloud/api/recording_api.rb', line 589

def get_mediaretentionpolicies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_mediaretentionpolicies ..."
  end
  
  # resource path
  local_var_path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'enabled'] = opts[:'enabled'] if opts[:'enabled']
  query_params[:'summary'] = opts[:'summary'] if opts[:'summary']
  query_params[:'hasErrors'] = opts[:'has_errors'] if opts[:'has_errors']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PolicyEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orphan_id(orphan_id, opts = {}) ⇒ OrphanRecording

Gets a single orphan recording

Parameters:

  • orphan_id —

    Orphan ID

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

    the optional parameters

Returns:



706
707
708
709
 
# File 'lib/purecloud/api/recording_api.rb', line 706

def get_orphan_id(orphan_id, opts = {})
  data, status_code, headers = get_orphan_id_with_http_info(orphan_id, opts)
  return data
end

#get_orphan_id_with_http_info(orphan_id, opts = {}) ⇒ Array<(OrphanRecording, Fixnum, Hash)>

Gets a single orphan recording

Parameters:

  • orphan_id —

    Orphan ID

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

    the optional parameters

Returns:

  • (Array<(OrphanRecording, Fixnum, Hash)>) —

    OrphanRecording data, response status code and response headers



716
717
718
719
720
721
722
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
751
752
753
754
755
756
757
758
759
 
# File 'lib/purecloud/api/recording_api.rb', line 716

def get_orphan_id_with_http_info(orphan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_orphan_id ..."
  end
  
  # verify the required parameter 'orphan_id' is set
  fail "Missing the required parameter 'orphan_id' when calling get_orphan_id" if orphan_id.nil?
  
  # resource path
  local_var_path = "/api/v2/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OrphanRecording')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orphanrecordings(opts = {}) ⇒ OrphanRecordingListing

Gets all orphan recordings

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested (default to 25)

  • :page_number (Integer) —

    The page number requested (default to 1)

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



771
772
773
774
 
# File 'lib/purecloud/api/recording_api.rb', line 771

def get_orphanrecordings(opts = {})
  data, status_code, headers = get_orphanrecordings_with_http_info(opts)
  return data
end

#get_orphanrecordings_with_http_info(opts = {}) ⇒ Array<(OrphanRecordingListing, Fixnum, Hash)>

Gets all orphan recordings

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:

  • (Array<(OrphanRecordingListing, Fixnum, Hash)>) —

    OrphanRecordingListing data, response status code and response headers



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
821
822
823
824
825
826
827
828
829
830
831
832
 
# File 'lib/purecloud/api/recording_api.rb', line 786

def get_orphanrecordings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_orphanrecordings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/orphanrecordings".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OrphanRecordingListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_orphanrecordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_settings(opts = {}) ⇒ RecordingSettings

Get the Recording Settings for the Organization

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :create_default (BOOLEAN) —

    If no settings are found, a new one is created with default values (default to false)

Returns:



839
840
841
842
 
# File 'lib/purecloud/api/recording_api.rb', line 839

def get_settings(opts = {})
  data, status_code, headers = get_settings_with_http_info(opts)
  return data
end

#get_settings_with_http_info(opts = {}) ⇒ Array<(RecordingSettings, Fixnum, Hash)>

Get the Recording Settings for the Organization

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :create_default (BOOLEAN) —

    If no settings are found, a new one is created with default values

Returns:

  • (Array<(RecordingSettings, Fixnum, Hash)>) —

    RecordingSettings data, response status code and response headers



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/purecloud/api/recording_api.rb', line 849

def get_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_settings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/recording/settings".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'createDefault'] = opts[:'create_default'] if opts[:'create_default']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RecordingSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_mediaretentionpolicies_policy_id(policy_id, opts = {}) ⇒ Policy

Patch a media retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Options Hash (opts):

Returns:



898
899
900
901
 
# File 'lib/purecloud/api/recording_api.rb', line 898

def patch_mediaretentionpolicies_policy_id(policy_id, opts = {})
  data, status_code, headers = patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
  return data
end

#patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {}) ⇒ Array<(Policy, Fixnum, Hash)>

Patch a media retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Policy, Fixnum, Hash)>) —

    Policy data, response status code and response headers



909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'lib/purecloud/api/recording_api.rb', line 909

def patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#patch_mediaretentionpolicies_policy_id ..."
  end
  
  # verify the required parameter 'policy_id' is set
  fail "Missing the required parameter 'policy_id' when calling patch_mediaretentionpolicies_policy_id" if policy_id.nil?
  
  # resource path
  local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Policy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#patch_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, opts = {}) ⇒ Annotation

Create annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Options Hash (opts):

Returns:



961
962
963
964
 
# File 'lib/purecloud/api/recording_api.rb', line 961

def post_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, opts = {})
  data, status_code, headers = post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts)
  return data
end

#post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts = {}) ⇒ Array<(Annotation, Fixnum, Hash)>

Create annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Annotation, Fixnum, Hash)>) —

    Annotation data, response status code and response headers



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/purecloud/api/recording_api.rb', line 973

def post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#post_conversation_id_recordings_recording_id_annotations ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling post_conversation_id_recordings_recording_id_annotations" if conversation_id.nil?
  
  # verify the required parameter 'recording_id' is set
  fail "Missing the required parameter 'recording_id' when calling post_conversation_id_recordings_recording_id_annotations" if recording_id.nil?
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Annotation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#post_conversation_id_recordings_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_mediaretentionpolicies(opts = {}) ⇒ Policy

Create media retention policy

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1026
1027
1028
1029
 
# File 'lib/purecloud/api/recording_api.rb', line 1026

def post_mediaretentionpolicies(opts = {})
  data, status_code, headers = post_mediaretentionpolicies_with_http_info(opts)
  return data
end

#post_mediaretentionpolicies_with_http_info(opts = {}) ⇒ Array<(Policy, Fixnum, Hash)>

Create media retention policy

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Policy, Fixnum, Hash)>) —

    Policy data, response status code and response headers



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
 
# File 'lib/purecloud/api/recording_api.rb', line 1036

def post_mediaretentionpolicies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#post_mediaretentionpolicies ..."
  end
  
  # resource path
  local_var_path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Policy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#post_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_conversation_id_recordings_recording_id(conversation_id, recording_id, body, opts = {}) ⇒ nil

Updates the retention records on a recording. Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter ‘restoreDays’ is deprecated and will be removed in the next major version release. If ‘restoreDays’ is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate’s time stamp in the PUT body to 10 days in the future.

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • body —

    recording

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

    the optional parameters

Returns:

  • (nil) 


1085
1086
1087
1088
 
# File 'lib/purecloud/api/recording_api.rb', line 1085

def put_conversation_id_recordings_recording_id(conversation_id, recording_id, body, opts = {})
  put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts)
  return nil
end

#put_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {}) ⇒ Annotation

Update annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Options Hash (opts):

Returns:



1155
1156
1157
1158
 
# File 'lib/purecloud/api/recording_api.rb', line 1155

def put_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
  data, status_code, headers = put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
  return data
end

#put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {}) ⇒ Array<(Annotation, Fixnum, Hash)>

Update annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Annotation, Fixnum, Hash)>) —

    Annotation data, response status code and response headers



1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
 
# File 'lib/purecloud/api/recording_api.rb', line 1168

def put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#put_conversation_id_recordings_recording_id_annotations_annotation_id ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
  
  # verify the required parameter 'recording_id' is set
  fail "Missing the required parameter 'recording_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
  
  # verify the required parameter 'annotation_id' is set
  fail "Missing the required parameter 'annotation_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Annotation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#put_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Updates the retention records on a recording. Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter &#39;restoreDays&#39; is deprecated and will be removed in the next major version release. If &#39;restoreDays&#39; is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate&#39;s time stamp in the PUT body to 10 days in the future.

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • body —

    recording

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'lib/purecloud/api/recording_api.rb', line 1097

def put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#put_conversation_id_recordings_recording_id ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling put_conversation_id_recordings_recording_id" if conversation_id.nil?
  
  # verify the required parameter 'recording_id' is set
  fail "Missing the required parameter 'recording_id' when calling put_conversation_id_recordings_recording_id" if recording_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_conversation_id_recordings_recording_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#put_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_mediaretentionpolicies_policy_id(policy_id, opts = {}) ⇒ Policy

Update a media retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Options Hash (opts):

Returns:



1225
1226
1227
1228
 
# File 'lib/purecloud/api/recording_api.rb', line 1225

def put_mediaretentionpolicies_policy_id(policy_id, opts = {})
  data, status_code, headers = put_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
  return data
end

#put_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {}) ⇒ Array<(Policy, Fixnum, Hash)>

Update a media retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Policy, Fixnum, Hash)>) —

    Policy data, response status code and response headers



1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
 
# File 'lib/purecloud/api/recording_api.rb', line 1236

def put_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#put_mediaretentionpolicies_policy_id ..."
  end
  
  # verify the required parameter 'policy_id' is set
  fail "Missing the required parameter 'policy_id' when calling put_mediaretentionpolicies_policy_id" if policy_id.nil?
  
  # resource path
  local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Policy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#put_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_settings(opts = {}) ⇒ RecordingSettings

Update the Recording Settings for the Organization

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1286
1287
1288
1289
 
# File 'lib/purecloud/api/recording_api.rb', line 1286

def put_settings(opts = {})
  data, status_code, headers = put_settings_with_http_info(opts)
  return data
end

#put_settings_with_http_info(opts = {}) ⇒ Array<(RecordingSettings, Fixnum, Hash)>

Update the Recording Settings for the Organization

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(RecordingSettings, Fixnum, Hash)>) —

    RecordingSettings data, response status code and response headers



1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
 
# File 'lib/purecloud/api/recording_api.rb', line 1296

def put_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#put_settings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/recording/settings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RecordingSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#put_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end