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

  • :max_wait_ms (Integer) —

    The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)

  • :format_id (String) —

    The desired media format (default to WEBM)

Returns:



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

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 = {}) ⇒ Recording

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. (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:



356
357
358
359
 
# File 'lib/purecloud/api/recording_api.rb', line 356

def get_conversation_id_recordings_recording_id(conversation_id, recording_id, opts = {})
  data, status_code, headers = get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts)
  return data
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:



431
432
433
434
 
# File 'lib/purecloud/api/recording_api.rb', line 431

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:



497
498
499
500
 
# File 'lib/purecloud/api/recording_api.rb', line 497

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



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/purecloud/api/recording_api.rb', line 509

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



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

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<(Recording, 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.

  • :download (BOOLEAN) —

    requesting a download format of the recording

  • :file_name (String) —

    the name of the downloaded fileName

Returns:

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

    Recording data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/purecloud/api/recording_api.rb', line 370

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'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
    fail 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE'
  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,
    :return_type => 'Recording')
  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):

  • :max_wait_ms (Integer) —

    The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value.

  • :format_id (String) —

    The desired media format

Returns:

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

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



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

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'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
    fail 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE'
  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[:'maxWaitMs'] = opts[:'max_wait_ms'] if opts[:'max_wait_ms']
  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_localkeys_settings(opts = {}) ⇒ LocalEncryptionConfigurationListing

gets a list local key settings data

Parameters:

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

    the optional parameters

Returns:



564
565
566
567
 
# File 'lib/purecloud/api/recording_api.rb', line 564

def get_localkeys_settings(opts = {})
  data, status_code, headers = get_localkeys_settings_with_http_info(opts)
  return data
end

#get_localkeys_settings_settings_id(settings_id, opts = {}) ⇒ LocalEncryptionConfiguration

Get the local encryption settings

Parameters:

  • settings_id —

    Settings Id

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

    the optional parameters

Returns:



620
621
622
623
 
# File 'lib/purecloud/api/recording_api.rb', line 620

def get_localkeys_settings_settings_id(settings_id, opts = {})
  data, status_code, headers = get_localkeys_settings_settings_id_with_http_info(settings_id, opts)
  return data
end

#get_localkeys_settings_settings_id_with_http_info(settings_id, opts = {}) ⇒ Array<(LocalEncryptionConfiguration, Fixnum, Hash)>

Get the local encryption settings

Parameters:

  • settings_id —

    Settings Id

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

    the optional parameters

Returns:



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/purecloud/api/recording_api.rb', line 630

def get_localkeys_settings_settings_id_with_http_info(settings_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_localkeys_settings_settings_id ..."
  end
  
  # verify the required parameter 'settings_id' is set
  fail "Missing the required parameter 'settings_id' when calling get_localkeys_settings_settings_id" if settings_id.nil?
  
  # resource path
  local_var_path = "/api/v2/recording/localkeys/settings/{settingsId}".sub('{format}','json').sub('{' + 'settingsId' + '}', settings_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 => 'LocalEncryptionConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_localkeys_settings_settings_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_localkeys_settings_with_http_info(opts = {}) ⇒ Array<(LocalEncryptionConfigurationListing, Fixnum, Hash)>

gets a list local key settings data

Parameters:

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

    the optional parameters

Returns:



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
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
 
# File 'lib/purecloud/api/recording_api.rb', line 573

def get_localkeys_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_localkeys_settings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/recording/localkeys/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 = 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 => 'LocalEncryptionConfigurationListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_localkeys_settings\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<Object>) —

    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:



689
690
691
692
 
# File 'lib/purecloud/api/recording_api.rb', line 689

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:



765
766
767
768
 
# File 'lib/purecloud/api/recording_api.rb', line 765

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



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/purecloud/api/recording_api.rb', line 775

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

    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



708
709
710
711
712
713
714
715
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
 
# File 'lib/purecloud/api/recording_api.rb', line 708

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:



825
826
827
828
 
# File 'lib/purecloud/api/recording_api.rb', line 825

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_media(orphan_id, opts = {}) ⇒ Recording

Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.

Parameters:

  • orphan_id —

    Orphan ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format. (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:



888
889
890
891
 
# File 'lib/purecloud/api/recording_api.rb', line 888

def get_orphan_id_media(orphan_id, opts = {})
  data, status_code, headers = get_orphan_id_media_with_http_info(orphan_id, opts)
  return data
end

#get_orphan_id_media_with_http_info(orphan_id, opts = {}) ⇒ Array<(Recording, Fixnum, Hash)>

Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.

Parameters:

  • orphan_id —

    Orphan ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format.

  • :download (BOOLEAN) —

    requesting a download format of the recording

  • :file_name (String) —

    the name of the downloaded fileName

Returns:

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

    Recording data, response status code and response headers



901
902
903
904
905
906
907
908
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
 
# File 'lib/purecloud/api/recording_api.rb', line 901

def get_orphan_id_media_with_http_info(orphan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_orphan_id_media ..."
  end
  
  # verify the required parameter 'orphan_id' is set
  fail "Missing the required parameter 'orphan_id' when calling get_orphan_id_media" if orphan_id.nil?
  
  if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
    fail 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE'
  end
  
  # resource path
  local_var_path = "/api/v2/orphanrecordings/{orphanId}/media".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_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,
    :return_type => 'Recording')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_orphan_id_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
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



835
836
837
838
839
840
841
842
843
844
845
846
847
848
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
 
# File 'lib/purecloud/api/recording_api.rb', line 835

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

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :has_conversation (BOOLEAN) —

    Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. (default to false)

Returns:



964
965
966
967
 
# File 'lib/purecloud/api/recording_api.rb', line 964

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

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :has_conversation (BOOLEAN) —

    Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.

Returns:

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

    OrphanRecordingListing data, response status code and response headers



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
1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'lib/purecloud/api/recording_api.rb', line 980

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']
  query_params[:'hasConversation'] = opts[:'has_conversation'] if opts[:'has_conversation']

  # 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_recordingkeys(opts = {}) ⇒ EncryptionKeyEntityListing

Get encryption key list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



1035
1036
1037
1038
 
# File 'lib/purecloud/api/recording_api.rb', line 1035

def get_recordingkeys(opts = {})
  data, status_code, headers = get_recordingkeys_with_http_info(opts)
  return data
end

#get_recordingkeys_rotationschedule(opts = {}) ⇒ KeyRotationSchedule

Get key rotation schedule

Parameters:

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

    the optional parameters

Returns:



1094
1095
1096
1097
 
# File 'lib/purecloud/api/recording_api.rb', line 1094

def get_recordingkeys_rotationschedule(opts = {})
  data, status_code, headers = get_recordingkeys_rotationschedule_with_http_info(opts)
  return data
end

#get_recordingkeys_rotationschedule_with_http_info(opts = {}) ⇒ Array<(KeyRotationSchedule, Fixnum, Hash)>

Get key rotation schedule

Parameters:

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

    the optional parameters

Returns:

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

    KeyRotationSchedule data, response status code and response headers



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

def get_recordingkeys_rotationschedule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_recordingkeys_rotationschedule ..."
  end
  
  # resource path
  local_var_path = "/api/v2/recording/recordingkeys/rotationschedule".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 = 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 => 'KeyRotationSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recordingkeys_with_http_info(opts = {}) ⇒ Array<(EncryptionKeyEntityListing, Fixnum, Hash)>

Get encryption key list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    EncryptionKeyEntityListing data, response status code and response headers



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
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'lib/purecloud/api/recording_api.rb', line 1046

def get_recordingkeys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#get_recordingkeys ..."
  end
  
  # resource path
  local_var_path = "/api/v2/recording/recordingkeys".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']

  # 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 => 'EncryptionKeyEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#get_recordingkeys\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:



1150
1151
1152
1153
 
# File 'lib/purecloud/api/recording_api.rb', line 1150

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



1160
1161
1162
1163
1164
1165
1166
1167
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
 
# File 'lib/purecloud/api/recording_api.rb', line 1160

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

#gets_screensessions(opts = {}) ⇒ ScreenRecordingSessionListing

Retrieves a paged listing of screen recording sessions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



1209
1210
1211
1212
 
# File 'lib/purecloud/api/recording_api.rb', line 1209

def gets_screensessions(opts = {})
  data, status_code, headers = gets_screensessions_with_http_info(opts)
  return data
end

#gets_screensessions_with_http_info(opts = {}) ⇒ Array<(ScreenRecordingSessionListing, Fixnum, Hash)>

Retrieves a paged listing of screen recording sessions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
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
 
# File 'lib/purecloud/api/recording_api.rb', line 1220

def gets_screensessions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#gets_screensessions ..."
  end
  
  # resource path
  local_var_path = "/api/v2/recordings/screensessions".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']

  # 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 => 'ScreenRecordingSessionListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#gets_screensessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Patch a media retention policy

Parameters:

  • policy_id —

    Policy ID

  • body —

    Policy

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

    the optional parameters

Returns:



1270
1271
1272
1273
 
# File 'lib/purecloud/api/recording_api.rb', line 1270

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

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

Patch a media retention policy

Parameters:

  • policy_id —

    Policy ID

  • body —

    Policy

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

    the optional parameters

Returns:

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

    Policy data, response status code and response headers



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
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
 
# File 'lib/purecloud/api/recording_api.rb', line 1281

def patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, body, 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?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling patch_mediaretentionpolicies_policy_id" if body.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(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

#patchs_screensessions_recordingsession_id(recording_session_id, opts = {}) ⇒ nil

Update a screen recording session

Parameters:

  • recording_session_id —

    Screen recording session ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1335
1336
1337
1338
 
# File 'lib/purecloud/api/recording_api.rb', line 1335

def patchs_screensessions_recordingsession_id(recording_session_id, opts = {})
  patchs_screensessions_recordingsession_id_with_http_info(recording_session_id, opts)
  return nil
end

#patchs_screensessions_recordingsession_id_with_http_info(recording_session_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a screen recording session

Parameters:

  • recording_session_id —

    Screen recording session ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'lib/purecloud/api/recording_api.rb', line 1346

def patchs_screensessions_recordingsession_id_with_http_info(recording_session_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#patchs_screensessions_recordingsession_id ..."
  end
  
  # verify the required parameter 'recording_session_id' is set
  fail "Missing the required parameter 'recording_session_id' when calling patchs_screensessions_recordingsession_id" if recording_session_id.nil?
  
  # resource path
  local_var_path = "/api/v2/recordings/screensessions/{recordingSessionId}".sub('{format}','json').sub('{' + 'recordingSessionId' + '}', recording_session_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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#patchs_screensessions_recordingsession_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, body, opts = {}) ⇒ Annotation

Create annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • body —

    annotation

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

    the optional parameters

Returns:



1397
1398
1399
1400
 
# File 'lib/purecloud/api/recording_api.rb', line 1397

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

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

Create annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • body —

    annotation

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

    the optional parameters

Returns:

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

    Annotation data, response status code and response headers



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/purecloud/api/recording_api.rb', line 1409

def post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, body, 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?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_conversation_id_recordings_recording_id_annotations" if body.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(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_localkeys(body, opts = {}) ⇒ EncryptionKey

create a local recording key

Parameters:

  • body —

    Local Encryption body

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

    the optional parameters

Returns:



1465
1466
1467
1468
 
# File 'lib/purecloud/api/recording_api.rb', line 1465

def post_localkeys(body, opts = {})
  data, status_code, headers = post_localkeys_with_http_info(body, opts)
  return data
end

#post_localkeys_settings(body, opts = {}) ⇒ LocalEncryptionConfiguration

create settings for local key creation

Parameters:

  • body —

    Local Encryption Configuration

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

    the optional parameters

Returns:



1525
1526
1527
1528
 
# File 'lib/purecloud/api/recording_api.rb', line 1525

def post_localkeys_settings(body, opts = {})
  data, status_code, headers = post_localkeys_settings_with_http_info(body, opts)
  return data
end

#post_localkeys_settings_with_http_info(body, opts = {}) ⇒ Array<(LocalEncryptionConfiguration, Fixnum, Hash)>

create settings for local key creation

Parameters:

  • body —

    Local Encryption Configuration

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

    the optional parameters

Returns:



1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
 
# File 'lib/purecloud/api/recording_api.rb', line 1535

def post_localkeys_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#post_localkeys_settings ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_localkeys_settings" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/recording/localkeys/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(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 => 'LocalEncryptionConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#post_localkeys_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_localkeys_with_http_info(body, opts = {}) ⇒ Array<(EncryptionKey, Fixnum, Hash)>

create a local recording key

Parameters:

  • body —

    Local Encryption body

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

    the optional parameters

Returns:

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

    EncryptionKey data, response status code and response headers



1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
 
# File 'lib/purecloud/api/recording_api.rb', line 1475

def post_localkeys_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#post_localkeys ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_localkeys" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/recording/localkeys".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(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 => 'EncryptionKey')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#post_localkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_mediaretentionpolicies(body, opts = {}) ⇒ Policy

Create media retention policy

Parameters:

  • body —

    Policy

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

    the optional parameters

Returns:



1585
1586
1587
1588
 
# File 'lib/purecloud/api/recording_api.rb', line 1585

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

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

Create media retention policy

Parameters:

  • body —

    Policy

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

    the optional parameters

Returns:

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

    Policy data, response status code and response headers



1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
 
# File 'lib/purecloud/api/recording_api.rb', line 1595

def post_mediaretentionpolicies_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#post_mediaretentionpolicies ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_mediaretentionpolicies" if body.nil?
  
  # 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(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

#post_recordingkeys(opts = {}) ⇒ EncryptionKey

Create encryption key

Parameters:

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

    the optional parameters

Returns:



1644
1645
1646
1647
 
# File 'lib/purecloud/api/recording_api.rb', line 1644

def post_recordingkeys(opts = {})
  data, status_code, headers = post_recordingkeys_with_http_info(opts)
  return data
end

#post_recordingkeys_with_http_info(opts = {}) ⇒ Array<(EncryptionKey, Fixnum, Hash)>

Create encryption key

Parameters:

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

    the optional parameters

Returns:

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

    EncryptionKey data, response status code and response headers



1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
 
# File 'lib/purecloud/api/recording_api.rb', line 1653

def post_recordingkeys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#post_recordingkeys ..."
  end
  
  # resource path
  local_var_path = "/api/v2/recording/recordingkeys".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 = nil
  
  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 => 'EncryptionKey')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#post_recordingkeys\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 = {}) ⇒ Recording

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.

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • body —

    recording

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

    the optional parameters

Returns:



1702
1703
1704
1705
 
# File 'lib/purecloud/api/recording_api.rb', line 1702

def put_conversation_id_recordings_recording_id(conversation_id, recording_id, body, opts = {})
  data, status_code, headers = put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts)
  return data
end

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

Update annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

  • body —

    annotation

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

    the optional parameters

Returns:



1773
1774
1775
1776
 
# File 'lib/purecloud/api/recording_api.rb', line 1773

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

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

Update annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

  • body —

    annotation

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

    the optional parameters

Returns:

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

    Annotation data, response status code and response headers



1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
 
# File 'lib/purecloud/api/recording_api.rb', line 1786

def put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, body, 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?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if body.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(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<(Recording, 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.

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • body —

    recording

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

    the optional parameters

Returns:

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

    Recording data, response status code and response headers



1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
 
# File 'lib/purecloud/api/recording_api.rb', line 1714

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,
    :return_type => 'Recording')
  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_localkeys_settings_settings_id(settings_id, body, opts = {}) ⇒ LocalEncryptionConfiguration

Update the local encryption settings

Parameters:

  • settings_id —

    Settings Id

  • body —

    Local Encryption metadata

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

    the optional parameters

Returns:



1846
1847
1848
1849
 
# File 'lib/purecloud/api/recording_api.rb', line 1846

def put_localkeys_settings_settings_id(settings_id, body, opts = {})
  data, status_code, headers = put_localkeys_settings_settings_id_with_http_info(settings_id, body, opts)
  return data
end

#put_localkeys_settings_settings_id_with_http_info(settings_id, body, opts = {}) ⇒ Array<(LocalEncryptionConfiguration, Fixnum, Hash)>

Update the local encryption settings

Parameters:

  • settings_id —

    Settings Id

  • body —

    Local Encryption metadata

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

    the optional parameters

Returns:



1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/purecloud/api/recording_api.rb', line 1857

def put_localkeys_settings_settings_id_with_http_info(settings_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#put_localkeys_settings_settings_id ..."
  end
  
  # verify the required parameter 'settings_id' is set
  fail "Missing the required parameter 'settings_id' when calling put_localkeys_settings_settings_id" if settings_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_localkeys_settings_settings_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/recording/localkeys/settings/{settingsId}".sub('{format}','json').sub('{' + 'settingsId' + '}', settings_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,
    :return_type => 'LocalEncryptionConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#put_localkeys_settings_settings_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a media retention policy

Parameters:

  • policy_id —

    Policy ID

  • body —

    Policy

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

    the optional parameters

Returns:



1911
1912
1913
1914
 
# File 'lib/purecloud/api/recording_api.rb', line 1911

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

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

Update a media retention policy

Parameters:

  • policy_id —

    Policy ID

  • body —

    Policy

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

    the optional parameters

Returns:

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

    Policy data, response status code and response headers



1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'lib/purecloud/api/recording_api.rb', line 1922

def put_mediaretentionpolicies_policy_id_with_http_info(policy_id, body, 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?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_mediaretentionpolicies_policy_id" if body.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(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_orphan_id(orphan_id, opts = {}) ⇒ Recording

Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.

Parameters:

  • orphan_id —

    Orphan ID

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

    the optional parameters

Options Hash (opts):

Returns:



1976
1977
1978
1979
 
# File 'lib/purecloud/api/recording_api.rb', line 1976

def put_orphan_id(orphan_id, opts = {})
  data, status_code, headers = put_orphan_id_with_http_info(orphan_id, opts)
  return data
end

#put_orphan_id_with_http_info(orphan_id, opts = {}) ⇒ Array<(Recording, Fixnum, Hash)>

Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.

Parameters:

  • orphan_id —

    Orphan ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Recording data, response status code and response headers



1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
 
# File 'lib/purecloud/api/recording_api.rb', line 1987

def put_orphan_id_with_http_info(orphan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#put_orphan_id ..."
  end
  
  # verify the required parameter 'orphan_id' is set
  fail "Missing the required parameter 'orphan_id' when calling put_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 = @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 => 'Recording')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#put_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_recordingkeys_rotationschedule(body, opts = {}) ⇒ KeyRotationSchedule

Update key rotation schedule

Parameters:

  • body —

    KeyRotationSchedule

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

    the optional parameters

Returns:



2037
2038
2039
2040
 
# File 'lib/purecloud/api/recording_api.rb', line 2037

def put_recordingkeys_rotationschedule(body, opts = {})
  data, status_code, headers = put_recordingkeys_rotationschedule_with_http_info(body, opts)
  return data
end

#put_recordingkeys_rotationschedule_with_http_info(body, opts = {}) ⇒ Array<(KeyRotationSchedule, Fixnum, Hash)>

Update key rotation schedule

Parameters:

  • body —

    KeyRotationSchedule

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

    the optional parameters

Returns:

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

    KeyRotationSchedule data, response status code and response headers



2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
 
# File 'lib/purecloud/api/recording_api.rb', line 2047

def put_recordingkeys_rotationschedule_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#put_recordingkeys_rotationschedule ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_recordingkeys_rotationschedule" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/recording/recordingkeys/rotationschedule".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(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 => 'KeyRotationSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecordingApi#put_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_settings(body, opts = {}) ⇒ RecordingSettings

Update the Recording Settings for the Organization

Parameters:

  • body —

    Recording settings

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

    the optional parameters

Returns:



2097
2098
2099
2100
 
# File 'lib/purecloud/api/recording_api.rb', line 2097

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

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

Update the Recording Settings for the Organization

Parameters:

  • body —

    Recording settings

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

    the optional parameters

Returns:

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

    RecordingSettings data, response status code and response headers



2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
 
# File 'lib/purecloud/api/recording_api.rb', line 2107

def put_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi#put_settings ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_settings" if body.nil?
  
  # 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(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