Class: PureCloud::RecordingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/api/recording_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_conversation_recording_annotation(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/purecloudplatformclientv2/api/recording_api.rb', line 34

def delete_conversation_recording_annotation(conversation_id, recording_id, annotation_id, opts = {})
  delete_conversation_recording_annotation_with_http_info(conversation_id, recording_id, annotation_id, opts)
  return nil
end

#delete_conversation_recording_annotation_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
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 46

def delete_conversation_recording_annotation_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_recording_annotation ..."
  end
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling RecordingApi.delete_conversation_recording_annotation" if conversation_id.nil?
  # verify the required parameter 'recording_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_id' when calling RecordingApi.delete_conversation_recording_annotation" if recording_id.nil?
  # verify the required parameter 'annotation_id' is set
  fail ArgumentError, "Missing the required parameter 'annotation_id' when calling RecordingApi.delete_conversation_recording_annotation" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Deletes a single orphan recording

Parameters:

  • orphan_id —

    Orphan ID

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

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 96

def delete_orphanrecording(orphan_id, opts = {})
  data, _status_code, _headers = delete_orphanrecording_with_http_info(orphan_id, opts)
  return data
end

#delete_orphanrecording_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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 106

def delete_orphanrecording_with_http_info(orphan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.delete_orphanrecording ..."
  end
  # verify the required parameter 'orphan_id' is set
  fail ArgumentError, "Missing the required parameter 'orphan_id' when calling RecordingApi.delete_orphanrecording" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_orphanrecording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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


153
154
155
156
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 153

def delete_recording_mediaretentionpolicies(ids, opts = {})
  data, _status_code, _headers = delete_recording_mediaretentionpolicies_with_http_info(ids, opts)
  return data
end

#delete_recording_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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 163

def delete_recording_mediaretentionpolicies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.delete_recording_mediaretentionpolicies ..."
  end
  # verify the required parameter 'ids' is set
  fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.delete_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a media retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Returns:

  • (String) 


211
212
213
214
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 211

def delete_recording_mediaretentionpolicy(policy_id, opts = {})
  data, _status_code, _headers = delete_recording_mediaretentionpolicy_with_http_info(policy_id, opts)
  return data
end

#delete_recording_mediaretentionpolicy_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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 221

def delete_recording_mediaretentionpolicy_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.delete_recording_mediaretentionpolicy ..."
  end
  # verify the required parameter 'policy_id' is set
  fail ArgumentError, "Missing the required parameter 'policy_id' when calling RecordingApi.delete_recording_mediaretentionpolicy" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_mediaretentionpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_recording(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:



272
273
274
275
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 272

def get_conversation_recording(conversation_id, recording_id, opts = {})
  data, _status_code, _headers = get_conversation_recording_with_http_info(conversation_id, recording_id, opts)
  return data
end

#get_conversation_recording_annotation(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:



343
344
345
346
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 343

def get_conversation_recording_annotation(conversation_id, recording_id, annotation_id, opts = {})
  data, _status_code, _headers = get_conversation_recording_annotation_with_http_info(conversation_id, recording_id, annotation_id, opts)
  return data
end

#get_conversation_recording_annotation_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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 355

def get_conversation_recording_annotation_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_recording_annotation ..."
  end
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling RecordingApi.get_conversation_recording_annotation" if conversation_id.nil?
  # verify the required parameter 'recording_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_id' when calling RecordingApi.get_conversation_recording_annotation" if recording_id.nil?
  # verify the required parameter 'annotation_id' is set
  fail ArgumentError, "Missing the required parameter 'annotation_id' when calling RecordingApi.get_conversation_recording_annotation" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_recording_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:



407
408
409
410
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 407

def get_conversation_recording_annotations(conversation_id, recording_id, opts = {})
  data, _status_code, _headers = get_conversation_recording_annotations_with_http_info(conversation_id, recording_id, opts)
  return data
end

#get_conversation_recording_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



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 418

def get_conversation_recording_annotations_with_http_info(conversation_id, recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_conversation_recording_annotations ..."
  end
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling RecordingApi.get_conversation_recording_annotations" if conversation_id.nil?
  # verify the required parameter 'recording_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_id' when calling RecordingApi.get_conversation_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_recording_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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 286

def get_conversation_recording_with_http_info(conversation_id, recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_conversation_recording ..."
  end
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling RecordingApi.get_conversation_recording" if conversation_id.nil?
  # verify the required parameter 'recording_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_id' when calling RecordingApi.get_conversation_recording" if recording_id.nil?
  if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
    fail ArgumentError, '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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_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:



469
470
471
472
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 469

def get_conversation_recordings(conversation_id, opts = {})
  data, _status_code, _headers = get_conversation_recordings_with_http_info(conversation_id, opts)
  return data
end

#get_conversation_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



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 481

def get_conversation_recordings_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_conversation_recordings ..."
  end
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling RecordingApi.get_conversation_recordings" if conversation_id.nil?
  if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
    fail ArgumentError, '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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Gets a single orphan recording

Parameters:

  • orphan_id —

    Orphan ID

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

    the optional parameters

Returns:



533
534
535
536
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 533

def get_orphanrecording(orphan_id, opts = {})
  data, _status_code, _headers = get_orphanrecording_with_http_info(orphan_id, opts)
  return data
end

#get_orphanrecording_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:



593
594
595
596
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 593

def get_orphanrecording_media(orphan_id, opts = {})
  data, _status_code, _headers = get_orphanrecording_media_with_http_info(orphan_id, opts)
  return data
end

#get_orphanrecording_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



606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 606

def get_orphanrecording_media_with_http_info(orphan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_orphanrecording_media ..."
  end
  # verify the required parameter 'orphan_id' is set
  fail ArgumentError, "Missing the required parameter 'orphan_id' when calling RecordingApi.get_orphanrecording_media" if orphan_id.nil?
  if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
    fail ArgumentError, '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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_orphanrecording_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orphanrecording_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



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 543

def get_orphanrecording_with_http_info(orphan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_orphanrecording ..."
  end
  # verify the required parameter 'orphan_id' is set
  fail ArgumentError, "Missing the required parameter 'orphan_id' when calling RecordingApi.get_orphanrecording" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_orphanrecording\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:



665
666
667
668
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 665

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



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 681

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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_localkeys_setting(settings_id, opts = {}) ⇒ LocalEncryptionConfiguration

Get the local encryption settings

Parameters:

  • settings_id —

    Settings Id

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

    the optional parameters

Returns:



733
734
735
736
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 733

def get_recording_localkeys_setting(settings_id, opts = {})
  data, _status_code, _headers = get_recording_localkeys_setting_with_http_info(settings_id, opts)
  return data
end

#get_recording_localkeys_setting_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:



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 743

def get_recording_localkeys_setting_with_http_info(settings_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_recording_localkeys_setting ..."
  end
  # verify the required parameter 'settings_id' is set
  fail ArgumentError, "Missing the required parameter 'settings_id' when calling RecordingApi.get_recording_localkeys_setting" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_localkeys_setting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recording_localkeys_settings(opts = {}) ⇒ LocalEncryptionConfigurationListing

gets a list local key settings data

Parameters:

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

    the optional parameters

Returns:



789
790
791
792
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 789

def get_recording_localkeys_settings(opts = {})
  data, _status_code, _headers = get_recording_localkeys_settings_with_http_info(opts)
  return data
end

#get_recording_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:



798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 798

def get_recording_localkeys_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_localkeys_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recording_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 &#x3D; true or enabled &#x3D; 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:



852
853
854
855
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 852

def get_recording_mediaretentionpolicies(opts = {})
  data, _status_code, _headers = get_recording_mediaretentionpolicies_with_http_info(opts)
  return data
end

#get_recording_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&#x3D;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 &#x3D; true or enabled &#x3D; 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



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 871

def get_recording_mediaretentionpolicies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a media retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Returns:



926
927
928
929
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 926

def get_recording_mediaretentionpolicy(policy_id, opts = {})
  data, _status_code, _headers = get_recording_mediaretentionpolicy_with_http_info(policy_id, opts)
  return data
end

#get_recording_mediaretentionpolicy_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



936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 936

def get_recording_mediaretentionpolicy_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_recording_mediaretentionpolicy ..."
  end
  # verify the required parameter 'policy_id' is set
  fail ArgumentError, "Missing the required parameter 'policy_id' when calling RecordingApi.get_recording_mediaretentionpolicy" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_mediaretentionpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recording_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:



984
985
986
987
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 984

def get_recording_recordingkeys(opts = {})
  data, _status_code, _headers = get_recording_recordingkeys_with_http_info(opts)
  return data
end

#get_recording_recordingkeys_rotationschedule(opts = {}) ⇒ KeyRotationSchedule

Get key rotation schedule

Parameters:

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

    the optional parameters

Returns:



1041
1042
1043
1044
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1041

def get_recording_recordingkeys_rotationschedule(opts = {})
  data, _status_code, _headers = get_recording_recordingkeys_rotationschedule_with_http_info(opts)
  return data
end

#get_recording_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



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/purecloudplatformclientv2/api/recording_api.rb', line 1050

def get_recording_recordingkeys_rotationschedule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recording_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



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
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 995

def get_recording_recordingkeys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_recordingkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recording_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:



1095
1096
1097
1098
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1095

def get_recording_settings(opts = {})
  data, _status_code, _headers = get_recording_settings_with_http_info(opts)
  return data
end

#get_recording_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



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

def get_recording_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recordings_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:



1152
1153
1154
1155
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1152

def get_recordings_screensessions(opts = {})
  data, _status_code, _headers = get_recordings_screensessions_with_http_info(opts)
  return data
end

#get_recordings_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:



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
1202
1203
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1163

def get_recordings_screensessions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.get_recordings_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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#get_recordings_screensessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_recording_mediaretentionpolicy(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:



1211
1212
1213
1214
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1211

def patch_recording_mediaretentionpolicy(policy_id, body, opts = {})
  data, _status_code, _headers = patch_recording_mediaretentionpolicy_with_http_info(policy_id, body, opts)
  return data
end

#patch_recording_mediaretentionpolicy_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



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
1263
1264
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1222

def patch_recording_mediaretentionpolicy_with_http_info(policy_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.patch_recording_mediaretentionpolicy ..."
  end
  # verify the required parameter 'policy_id' is set
  fail ArgumentError, "Missing the required parameter 'policy_id' when calling RecordingApi.patch_recording_mediaretentionpolicy" if policy_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.patch_recording_mediaretentionpolicy" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_mediaretentionpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_recordings_screensession(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) 


1272
1273
1274
1275
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1272

def patch_recordings_screensession(recording_session_id, opts = {})
  patch_recordings_screensession_with_http_info(recording_session_id, opts)
  return nil
end

#patch_recordings_screensession_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



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

def patch_recordings_screensession_with_http_info(recording_session_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.patch_recordings_screensession ..."
  end
  # verify the required parameter 'recording_session_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_session_id' when calling RecordingApi.patch_recordings_screensession" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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#patch_recordings_screensession\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_conversation_recording_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:



1331
1332
1333
1334
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1331

def post_conversation_recording_annotations(conversation_id, recording_id, body, opts = {})
  data, _status_code, _headers = post_conversation_recording_annotations_with_http_info(conversation_id, recording_id, body, opts)
  return data
end

#post_conversation_recording_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



1343
1344
1345
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
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1343

def post_conversation_recording_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_recording_annotations ..."
  end
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling RecordingApi.post_conversation_recording_annotations" if conversation_id.nil?
  # verify the required parameter 'recording_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_id' when calling RecordingApi.post_conversation_recording_annotations" if recording_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.post_conversation_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_recording_localkeys(body, opts = {}) ⇒ EncryptionKey

create a local recording key

Parameters:

  • body —

    Local Encryption body

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

    the optional parameters

Returns:



1394
1395
1396
1397
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1394

def post_recording_localkeys(body, opts = {})
  data, _status_code, _headers = post_recording_localkeys_with_http_info(body, opts)
  return data
end

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

create settings for local key creation

Parameters:

  • body —

    Local Encryption Configuration

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

    the optional parameters

Returns:



1451
1452
1453
1454
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1451

def post_recording_localkeys_settings(body, opts = {})
  data, _status_code, _headers = post_recording_localkeys_settings_with_http_info(body, opts)
  return data
end

#post_recording_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:



1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
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
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1461

def post_recording_localkeys_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.post_recording_localkeys_settings ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.post_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_localkeys_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_recording_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



1404
1405
1406
1407
1408
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
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1404

def post_recording_localkeys_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.post_recording_localkeys ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.post_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_localkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create media retention policy

Parameters:

  • body —

    Policy

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

    the optional parameters

Returns:



1508
1509
1510
1511
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1508

def post_recording_mediaretentionpolicies(body, opts = {})
  data, _status_code, _headers = post_recording_mediaretentionpolicies_with_http_info(body, opts)
  return data
end

#post_recording_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



1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1518

def post_recording_mediaretentionpolicies_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.post_recording_mediaretentionpolicies ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.post_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_recording_recordingkeys(opts = {}) ⇒ EncryptionKey

Create encryption key

Parameters:

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

    the optional parameters

Returns:



1564
1565
1566
1567
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1564

def post_recording_recordingkeys(opts = {})
  data, _status_code, _headers = post_recording_recordingkeys_with_http_info(opts)
  return data
end

#post_recording_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



1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1573

def post_recording_recordingkeys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.post_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_recordingkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_conversation_recording(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:



1620
1621
1622
1623
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1620

def put_conversation_recording(conversation_id, recording_id, body, opts = {})
  data, _status_code, _headers = put_conversation_recording_with_http_info(conversation_id, recording_id, body, opts)
  return data
end

#put_conversation_recording_annotation(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:



1686
1687
1688
1689
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1686

def put_conversation_recording_annotation(conversation_id, recording_id, annotation_id, body, opts = {})
  data, _status_code, _headers = put_conversation_recording_annotation_with_http_info(conversation_id, recording_id, annotation_id, body, opts)
  return data
end

#put_conversation_recording_annotation_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



1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
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
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1699

def put_conversation_recording_annotation_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_recording_annotation ..."
  end
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling RecordingApi.put_conversation_recording_annotation" if conversation_id.nil?
  # verify the required parameter 'recording_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_id' when calling RecordingApi.put_conversation_recording_annotation" if recording_id.nil?
  # verify the required parameter 'annotation_id' is set
  fail ArgumentError, "Missing the required parameter 'annotation_id' when calling RecordingApi.put_conversation_recording_annotation" if annotation_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.put_conversation_recording_annotation" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_conversation_recording_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



1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1632

def put_conversation_recording_with_http_info(conversation_id, recording_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.put_conversation_recording ..."
  end
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling RecordingApi.put_conversation_recording" if conversation_id.nil?
  # verify the required parameter 'recording_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_id' when calling RecordingApi.put_conversation_recording" if recording_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.put_conversation_recording" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_orphanrecording(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:



1753
1754
1755
1756
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1753

def put_orphanrecording(orphan_id, opts = {})
  data, _status_code, _headers = put_orphanrecording_with_http_info(orphan_id, opts)
  return data
end

#put_orphanrecording_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



1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1764

def put_orphanrecording_with_http_info(orphan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.put_orphanrecording ..."
  end
  # verify the required parameter 'orphan_id' is set
  fail ArgumentError, "Missing the required parameter 'orphan_id' when calling RecordingApi.put_orphanrecording" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_orphanrecording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_recording_localkeys_setting(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:



1812
1813
1814
1815
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1812

def put_recording_localkeys_setting(settings_id, body, opts = {})
  data, _status_code, _headers = put_recording_localkeys_setting_with_http_info(settings_id, body, opts)
  return data
end

#put_recording_localkeys_setting_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:



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1823

def put_recording_localkeys_setting_with_http_info(settings_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.put_recording_localkeys_setting ..."
  end
  # verify the required parameter 'settings_id' is set
  fail ArgumentError, "Missing the required parameter 'settings_id' when calling RecordingApi.put_recording_localkeys_setting" if settings_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.put_recording_localkeys_setting" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_localkeys_setting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_recording_mediaretentionpolicy(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:



1873
1874
1875
1876
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1873

def put_recording_mediaretentionpolicy(policy_id, body, opts = {})
  data, _status_code, _headers = put_recording_mediaretentionpolicy_with_http_info(policy_id, body, opts)
  return data
end

#put_recording_mediaretentionpolicy_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



1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1884

def put_recording_mediaretentionpolicy_with_http_info(policy_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.put_recording_mediaretentionpolicy ..."
  end
  # verify the required parameter 'policy_id' is set
  fail ArgumentError, "Missing the required parameter 'policy_id' when calling RecordingApi.put_recording_mediaretentionpolicy" if policy_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.put_recording_mediaretentionpolicy" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_mediaretentionpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update key rotation schedule

Parameters:

  • body —

    KeyRotationSchedule

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

    the optional parameters

Returns:



1933
1934
1935
1936
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1933

def put_recording_recordingkeys_rotationschedule(body, opts = {})
  data, _status_code, _headers = put_recording_recordingkeys_rotationschedule_with_http_info(body, opts)
  return data
end

#put_recording_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



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
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1943

def put_recording_recordingkeys_rotationschedule_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.put_recording_recordingkeys_rotationschedule ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.put_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update the Recording Settings for the Organization

Parameters:

  • body —

    Recording settings

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

    the optional parameters

Returns:



1990
1991
1992
1993
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 1990

def put_recording_settings(body, opts = {})
  data, _status_code, _headers = put_recording_settings_with_http_info(body, opts)
  return data
end

#put_recording_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



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
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
 
# File 'lib/purecloudplatformclientv2/api/recording_api.rb', line 2000

def put_recording_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecordingApi.put_recording_settings ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.put_recording_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_recording_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end