Class: PureCloud::QualityApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ QualityApi

Returns a new instance of QualityApi.



7
8
9
 
# File 'lib/purecloud/api/quality_api.rb', line 7

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/quality_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#create_calibrations(opts = {}) ⇒ Calibration

Create a calibration

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Calibration) —

    calibration

  • :expand (String) —

    calibratorId

Returns:



756
757
758
759
 
# File 'lib/purecloud/api/quality_api.rb', line 756

def create_calibrations(opts = {})
  data, status_code, headers = create_calibrations_with_http_info(opts)
  return data
end

#create_calibrations_with_http_info(opts = {}) ⇒ Array<(Calibration, Fixnum, Hash)>

Create a calibration

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Calibration) —

    calibration

  • :expand (String) —

    calibratorId

Returns:

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

    Calibration data, response status code and response headers



767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'lib/purecloud/api/quality_api.rb', line 767

def create_calibrations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#create_calibrations ..."
  end
  
  # resource path
  path = "/api/v1/quality/calibrations".sub('{format}','json')

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Calibration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#create_calibrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_conversation_evaluations(conversation_id, opts = {}) ⇒ Evaluation

Create an evaluation

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Evaluation) —

    evaluation

  • :expand (String) —

    evaluatorId

Returns:



1088
1089
1090
1091
 
# File 'lib/purecloud/api/quality_api.rb', line 1088

def create_conversation_evaluations(conversation_id, opts = {})
  data, status_code, headers = create_conversation_evaluations_with_http_info(conversation_id, opts)
  return data
end

#create_conversation_evaluations_with_http_info(conversation_id, opts = {}) ⇒ Array<(Evaluation, Fixnum, Hash)>

Create an evaluation

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Evaluation) —

    evaluation

  • :expand (String) —

    evaluatorId

Returns:

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

    Evaluation data, response status code and response headers



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

def create_conversation_evaluations_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#create_conversation_evaluations ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling create_conversation_evaluations" if conversation_id.nil?
  
  # resource path
  path = "/api/v1/quality/conversations/{conversationId}/evaluations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Evaluation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#create_conversation_evaluations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Options Hash (opts):

Returns:



309
310
311
312
 
# File 'lib/purecloud/api/quality_api.rb', line 309

def create_conversation_recordings_by_recording_id_annotations(conversation_id, recording_id, opts = {})
  data, status_code, headers = create_conversation_recordings_by_recording_id_annotations_with_http_info(conversation_id, recording_id, opts)
  return data
end

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

Create annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Annotation data, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/purecloud/api/quality_api.rb', line 321

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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: QualityApi#create_conversation_recordings_by_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_evaluations_query(opts = {}) ⇒ EvaluationEntityListing

Query evaluations

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1463
1464
1465
1466
 
# File 'lib/purecloud/api/quality_api.rb', line 1463

def create_evaluations_query(opts = {})
  data, status_code, headers = create_evaluations_query_with_http_info(opts)
  return data
end

#create_evaluations_query_with_http_info(opts = {}) ⇒ Array<(EvaluationEntityListing, Fixnum, Hash)>

Query evaluations

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EvaluationEntityListing data, response status code and response headers



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
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'lib/purecloud/api/quality_api.rb', line 1474

def create_evaluations_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#create_evaluations_query ..."
  end
  
  # resource path
  path = "/api/v1/quality/evaluations/query".sub('{format}','json')

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EvaluationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#create_evaluations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_evaluations_scoring(opts = {}) ⇒ EvaluationScoringSet

Score evaluation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1523
1524
1525
1526
 
# File 'lib/purecloud/api/quality_api.rb', line 1523

def create_evaluations_scoring(opts = {})
  data, status_code, headers = create_evaluations_scoring_with_http_info(opts)
  return data
end

#create_evaluations_scoring_with_http_info(opts = {}) ⇒ Array<(EvaluationScoringSet, Fixnum, Hash)>

Score evaluation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EvaluationScoringSet data, response status code and response headers



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
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
 
# File 'lib/purecloud/api/quality_api.rb', line 1533

def create_evaluations_scoring_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#create_evaluations_scoring ..."
  end
  
  # resource path
  path = "/api/v1/quality/evaluations/scoring".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EvaluationScoringSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#create_evaluations_scoring\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_calibration(calibration_id, opts = {}) ⇒ Calibration

Delete a calibration by id.

Parameters:

  • calibration_id —

    Calibration ID

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

    the optional parameters

Options Hash (opts):

  • :calibrator_id (String) —

    calibratorId

Returns:



944
945
946
947
 
# File 'lib/purecloud/api/quality_api.rb', line 944

def delete_calibration(calibration_id, opts = {})
  data, status_code, headers = delete_calibration_with_http_info(calibration_id, opts)
  return data
end

#delete_calibration_with_http_info(calibration_id, opts = {}) ⇒ Array<(Calibration, Fixnum, Hash)>

Delete a calibration by id.

Parameters:

  • calibration_id —

    Calibration ID

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

    the optional parameters

Options Hash (opts):

  • :calibrator_id (String) —

    calibratorId

Returns:

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

    Calibration data, response status code and response headers



955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/purecloud/api/quality_api.rb', line 955

def delete_calibration_with_http_info(calibration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#delete_calibration ..."
  end
  
  # verify the required parameter 'calibration_id' is set
  fail "Missing the required parameter 'calibration_id' when calling delete_calibration" if calibration_id.nil?
  
  # resource path
  path = "/api/v1/quality/calibrations/{calibrationId}".sub('{format}','json').sub('{' + 'calibrationId' + '}', calibration_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'calibratorId'] = opts[:'calibrator_id'] if opts[:'calibrator_id']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#delete_conversation_evaluations_by_evaluation_id(conversation_id, evaluation_id, opts = {}) ⇒ Evaluation

Delete an evaluation

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    evaluatorId

Returns:



1294
1295
1296
1297
 
# File 'lib/purecloud/api/quality_api.rb', line 1294

def delete_conversation_evaluations_by_evaluation_id(conversation_id, evaluation_id, opts = {})
  data, status_code, headers = delete_conversation_evaluations_by_evaluation_id_with_http_info(conversation_id, evaluation_id, opts)
  return data
end

#delete_conversation_evaluations_by_evaluation_id_with_http_info(conversation_id, evaluation_id, opts = {}) ⇒ Array<(Evaluation, Fixnum, Hash)>

Delete an evaluation

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    evaluatorId

Returns:

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

    Evaluation data, response status code and response headers



1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
 
# File 'lib/purecloud/api/quality_api.rb', line 1306

def delete_conversation_evaluations_by_evaluation_id_with_http_info(conversation_id, evaluation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#delete_conversation_evaluations_by_evaluation_id ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling delete_conversation_evaluations_by_evaluation_id" if conversation_id.nil?
  
  # verify the required parameter 'evaluation_id' is set
  fail "Missing the required parameter 'evaluation_id' when calling delete_conversation_evaluations_by_evaluation_id" if evaluation_id.nil?
  
  # resource path
  path = "/api/v1/quality/conversations/{conversationId}/evaluations/{evaluationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'evaluationId' + '}', evaluation_id.to_s)

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

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

Delete annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Returns:

  • (nil) 


521
522
523
524
 
# File 'lib/purecloud/api/quality_api.rb', line 521

def delete_conversation_recordings_by_recording_id_annotations_by_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
  delete_conversation_recordings_by_recording_id_annotations_by_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
  return nil
end

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

Delete annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/purecloud/api/quality_api.rb', line 533

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: QualityApi#delete_conversation_recordings_by_recording_id_annotations_by_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_agents_activity(opts = {}) ⇒ AgentActivityEntityListing

Gets a list of Agent Activities Including the number of evaluations and average evaluation score

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :start_time (DateTime) —

    Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :end_time (DateTime) —

    End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :agent_user_id (Array<String>) —

    user id of agent requested

  • :evaluator_user_id (String) —

    user id of the evaluator

  • :name (String) —

    name

  • :group (String) —

    group id

Returns:



598
599
600
601
 
# File 'lib/purecloud/api/quality_api.rb', line 598

def get_agents_activity(opts = {})
  data, status_code, headers = get_agents_activity_with_http_info(opts)
  return data
end

#get_agents_activity_with_http_info(opts = {}) ⇒ Array<(AgentActivityEntityListing, Fixnum, Hash)>

Gets a list of Agent Activities Including the number of evaluations and average evaluation score

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :start_time (DateTime) —

    Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :end_time (DateTime) —

    End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :agent_user_id (Array<String>) —

    user id of agent requested

  • :evaluator_user_id (String) —

    user id of the evaluator

  • :name (String) —

    name

  • :group (String) —

    group id

Returns:

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

    AgentActivityEntityListing data, response status code and response headers



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
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
 
# File 'lib/purecloud/api/quality_api.rb', line 617

def get_agents_activity_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#get_agents_activity ..."
  end
  
  # resource path
  path = "/api/v1/quality/agents/activity".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[:'startTime'] = opts[:'start_time'] if opts[:'start_time']
  query_params[:'endTime'] = opts[:'end_time'] if opts[:'end_time']
  query_params[:'agentUserId'] = @api_client.build_collection_param(opts[:'agent_user_id'], :multi) if opts[:'agent_user_id']
  query_params[:'evaluatorUserId'] = opts[:'evaluator_user_id'] if opts[:'evaluator_user_id']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'group'] = opts[:'group'] if opts[:'group']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#get_calibration(calibration_id, opts = {}) ⇒ Calibration

Get a calibration by id.

Parameters:

  • calibration_id —

    Calibration ID

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

    the optional parameters

Options Hash (opts):

  • :calibrator_id (String) —

    calibratorId

Returns:



817
818
819
820
 
# File 'lib/purecloud/api/quality_api.rb', line 817

def get_calibration(calibration_id, opts = {})
  data, status_code, headers = get_calibration_with_http_info(calibration_id, opts)
  return data
end

#get_calibration_with_http_info(calibration_id, opts = {}) ⇒ Array<(Calibration, Fixnum, Hash)>

Get a calibration by id.

Parameters:

  • calibration_id —

    Calibration ID

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

    the optional parameters

Options Hash (opts):

  • :calibrator_id (String) —

    calibratorId

Returns:

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

    Calibration data, response status code and response headers



828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/purecloud/api/quality_api.rb', line 828

def get_calibration_with_http_info(calibration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#get_calibration ..."
  end
  
  # verify the required parameter 'calibration_id' is set
  fail "Missing the required parameter 'calibration_id' when calling get_calibration" if calibration_id.nil?
  
  # resource path
  path = "/api/v1/quality/calibrations/{calibrationId}".sub('{format}','json').sub('{' + 'calibrationId' + '}', calibration_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'calibratorId'] = opts[:'calibrator_id'] if opts[:'calibrator_id']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#get_calibrations(opts = {}) ⇒ CalibrationEntityListing

Get the list of calibrations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :conversation_id (String) —

    conversation id

  • :start_time (DateTime) —

    Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :end_time (DateTime) —

    end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :calibrator_id (String) —

    user id of calibrator

Returns:



682
683
684
685
 
# File 'lib/purecloud/api/quality_api.rb', line 682

def get_calibrations(opts = {})
  data, status_code, headers = get_calibrations_with_http_info(opts)
  return data
end

#get_calibrations_with_http_info(opts = {}) ⇒ Array<(CalibrationEntityListing, Fixnum, Hash)>

Get the list of calibrations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :conversation_id (String) —

    conversation id

  • :start_time (DateTime) —

    Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :end_time (DateTime) —

    end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :calibrator_id (String) —

    user id of calibrator

Returns:

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

    CalibrationEntityListing data, response status code and response headers



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
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/purecloud/api/quality_api.rb', line 699

def get_calibrations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#get_calibrations ..."
  end
  
  # resource path
  path = "/api/v1/quality/calibrations".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[:'conversationId'] = opts[:'conversation_id'] if opts[:'conversation_id']
  query_params[:'startTime'] = opts[:'start_time'] if opts[:'start_time']
  query_params[:'endTime'] = opts[:'end_time'] if opts[:'end_time']
  query_params[:'calibratorId'] = opts[:'calibrator_id'] if opts[:'calibrator_id']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#get_conversation_audits(conversation_id, opts = {}) ⇒ QualityAuditPage

Get audits for conversation or recording

Parameters:

  • conversation_id —

    Conversation ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :recording_id (String) —

    id of the recording

  • :entity_type (String) —

    entity type options: Recording, Calibration, Evaluation, Annotation

Returns:



1013
1014
1015
1016
 
# File 'lib/purecloud/api/quality_api.rb', line 1013

def get_conversation_audits(conversation_id, opts = {})
  data, status_code, headers = get_conversation_audits_with_http_info(conversation_id, opts)
  return data
end

#get_conversation_audits_with_http_info(conversation_id, opts = {}) ⇒ Array<(QualityAuditPage, Fixnum, Hash)>

Get audits for conversation or recording

Parameters:

  • conversation_id —

    Conversation ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :recording_id (String) —

    id of the recording

  • :entity_type (String) —

    entity type options: Recording, Calibration, Evaluation, Annotation

Returns:

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

    QualityAuditPage data, response status code and response headers



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

def get_conversation_audits_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#get_conversation_audits ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling get_conversation_audits" if conversation_id.nil?
  
  # resource path
  path = "/api/v1/quality/conversations/{conversationId}/audits".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)

  # 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[:'recordingId'] = opts[:'recording_id'] if opts[:'recording_id']
  query_params[:'entityType'] = opts[:'entity_type'] if opts[:'entity_type']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#get_conversation_evaluations_by_evaluation_id(conversation_id, evaluation_id, opts = {}) ⇒ Evaluation

Get an evaluation

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    agent, evaluator, evaluationForm

Returns:



1154
1155
1156
1157
 
# File 'lib/purecloud/api/quality_api.rb', line 1154

def get_conversation_evaluations_by_evaluation_id(conversation_id, evaluation_id, opts = {})
  data, status_code, headers = get_conversation_evaluations_by_evaluation_id_with_http_info(conversation_id, evaluation_id, opts)
  return data
end

#get_conversation_evaluations_by_evaluation_id_with_http_info(conversation_id, evaluation_id, opts = {}) ⇒ Array<(Evaluation, Fixnum, Hash)>

Get an evaluation

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    agent, evaluator, evaluationForm

Returns:

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

    Evaluation data, response status code and response headers



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
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'lib/purecloud/api/quality_api.rb', line 1166

def get_conversation_evaluations_by_evaluation_id_with_http_info(conversation_id, evaluation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#get_conversation_evaluations_by_evaluation_id ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling get_conversation_evaluations_by_evaluation_id" if conversation_id.nil?
  
  # verify the required parameter 'evaluation_id' is set
  fail "Missing the required parameter 'evaluation_id' when calling get_conversation_evaluations_by_evaluation_id" if evaluation_id.nil?
  
  # resource path
  path = "/api/v1/quality/conversations/{conversationId}/evaluations/{evaluationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'evaluationId' + '}', evaluation_id.to_s)

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Evaluation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#get_conversation_evaluations_by_evaluation_id\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&#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.

  • :format_id (String) —

    The desired format (WEBM, WAV, etc.)

Returns:



18
19
20
21
 
# File 'lib/purecloud/api/quality_api.rb', line 18

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_by_recording_id(conversation_id, recording_id, opts = {}) ⇒ nil

Gets a specific recording.

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Options Hash (opts):

  • :max_wait_ms (Integer) —

    The maximum number of milliseconds to wait for completion.

  • :format_id (String) —

    The desired format (WEBM, WAV, etc.)

  • :download (BOOLEAN) —

    requesting a download format of the recording

  • :file_name (String) —

    the name of the downloaded fileName

Returns:

  • (nil) 


92
93
94
95
 
# File 'lib/purecloud/api/quality_api.rb', line 92

def get_conversation_recordings_by_recording_id(conversation_id, recording_id, opts = {})
  get_conversation_recordings_by_recording_id_with_http_info(conversation_id, recording_id, opts)
  return nil
end

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

Get annotations for recording

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Returns:



242
243
244
245
 
# File 'lib/purecloud/api/quality_api.rb', line 242

def get_conversation_recordings_by_recording_id_annotations(conversation_id, recording_id, opts = {})
  data, status_code, headers = get_conversation_recordings_by_recording_id_annotations_with_http_info(conversation_id, recording_id, opts)
  return data
end

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

Get annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Returns:



377
378
379
380
 
# File 'lib/purecloud/api/quality_api.rb', line 377

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

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

Get annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Returns:

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

    Annotation data, response status code and response headers



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/purecloud/api/quality_api.rb', line 389

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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: QualityApi#get_conversation_recordings_by_recording_id_annotations_by_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get annotations for recording

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Returns:

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

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/purecloud/api/quality_api.rb', line 253

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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: QualityApi#get_conversation_recordings_by_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Gets a specific recording.

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

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

    the optional parameters

Options Hash (opts):

  • :max_wait_ms (Integer) —

    The maximum number of milliseconds to wait for completion.

  • :format_id (String) —

    The desired format (WEBM, WAV, etc.)

  • :download (BOOLEAN) —

    requesting a download format of the recording

  • :file_name (String) —

    the name of the downloaded fileName

Returns:

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

    nil, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/purecloud/api/quality_api.rb', line 107

def get_conversation_recordings_by_recording_id_with_http_info(conversation_id, recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#get_conversation_recordings_by_recording_id ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling get_conversation_recordings_by_recording_id" if conversation_id.nil?
  
  # verify the required parameter 'recording_id' is set
  fail "Missing the required parameter 'recording_id' when calling get_conversation_recordings_by_recording_id" if recording_id.nil?
  
  if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
    fail 'invalid value for "format_id", must be one of WEBM, WAV'
  end
  
  # resource path
  path = "/api/v1/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[:'maxWaitMs'] = opts[:'max_wait_ms'] if opts[:'max_wait_ms']
  query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
  query_params[:'download'] = opts[:'download'] if opts[:'download']
  query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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: QualityApi#get_conversation_recordings_by_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
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.

  • :format_id (String) —

    The desired format (WEBM, WAV, etc.)

Returns:

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

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



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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
 
# File 'lib/purecloud/api/quality_api.rb', line 30

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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: QualityApi#get_conversation_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_evaluations_query(opts = {}) ⇒ EvaluationEntityListing

Queries Evaluations and returns a paged list Query params must include one of conversationId, evaluatorUserId, or agentUserId

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :conversation_id (String) —

    conversationId specified

  • :agent_user_id (String) —

    user id of the agent

  • :evaluator_user_id (String) —

    evaluator user id

  • :queue_id (String) —

    queue id

  • :start_time (String) —

    start time of the evaluation query

  • :end_time (String) —

    end time of the evaluation query

  • :evaluation_state (Array<String>) —

    evaluation state options: Pending, InProgress, Finished

  • :is_released (BOOLEAN) —

    the evaluation has been released

  • :agent_has_read (BOOLEAN) —

    agent has the evaluation

  • :expand_answer_total_scores (BOOLEAN) —

    get the total scores for evaluations

  • :maximum (Integer) —

    maximum

Returns:



1375
1376
1377
1378
 
# File 'lib/purecloud/api/quality_api.rb', line 1375

def get_evaluations_query(opts = {})
  data, status_code, headers = get_evaluations_query_with_http_info(opts)
  return data
end

#get_evaluations_query_with_http_info(opts = {}) ⇒ Array<(EvaluationEntityListing, Fixnum, Hash)>

Queries Evaluations and returns a paged list Query params must include one of conversationId, evaluatorUserId, or agentUserId

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :conversation_id (String) —

    conversationId specified

  • :agent_user_id (String) —

    user id of the agent

  • :evaluator_user_id (String) —

    evaluator user id

  • :queue_id (String) —

    queue id

  • :start_time (String) —

    start time of the evaluation query

  • :end_time (String) —

    end time of the evaluation query

  • :evaluation_state (Array<String>) —

    evaluation state options: Pending, InProgress, Finished

  • :is_released (BOOLEAN) —

    the evaluation has been released

  • :agent_has_read (BOOLEAN) —

    agent has the evaluation

  • :expand_answer_total_scores (BOOLEAN) —

    get the total scores for evaluations

  • :maximum (Integer) —

    maximum

Returns:

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

    EvaluationEntityListing data, response status code and response headers



1399
1400
1401
1402
1403
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
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
 
# File 'lib/purecloud/api/quality_api.rb', line 1399

def get_evaluations_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#get_evaluations_query ..."
  end
  
  # resource path
  path = "/api/v1/quality/evaluations/query".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[:'conversationId'] = opts[:'conversation_id'] if opts[:'conversation_id']
  query_params[:'agentUserId'] = opts[:'agent_user_id'] if opts[:'agent_user_id']
  query_params[:'evaluatorUserId'] = opts[:'evaluator_user_id'] if opts[:'evaluator_user_id']
  query_params[:'queueId'] = opts[:'queue_id'] if opts[:'queue_id']
  query_params[:'startTime'] = opts[:'start_time'] if opts[:'start_time']
  query_params[:'endTime'] = opts[:'end_time'] if opts[:'end_time']
  query_params[:'evaluationState'] = @api_client.build_collection_param(opts[:'evaluation_state'], :multi) if opts[:'evaluation_state']
  query_params[:'isReleased'] = opts[:'is_released'] if opts[:'is_released']
  query_params[:'agentHasRead'] = opts[:'agent_has_read'] if opts[:'agent_has_read']
  query_params[:'expandAnswerTotalScores'] = opts[:'expand_answer_total_scores'] if opts[:'expand_answer_total_scores']
  query_params[:'maximum'] = opts[:'maximum'] if opts[:'maximum']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#get_evaluators_activity(opts = {}) ⇒ EvaluatorActivityEntityListing

Get an evaluator activity

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :start_time (DateTime) —

    The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :end_time (DateTime) —

    The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :name (String) —

    Evaluator name

  • :permission (Array<String>) —

    permission strings

  • :group (String) —

    group id

Returns:



1589
1590
1591
1592
 
# File 'lib/purecloud/api/quality_api.rb', line 1589

def get_evaluators_activity(opts = {})
  data, status_code, headers = get_evaluators_activity_with_http_info(opts)
  return data
end

#get_evaluators_activity_with_http_info(opts = {}) ⇒ Array<(EvaluatorActivityEntityListing, Fixnum, Hash)>

Get an evaluator activity

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :start_time (DateTime) —

    The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :end_time (DateTime) —

    The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • :name (String) —

    Evaluator name

  • :permission (Array<String>) —

    permission strings

  • :group (String) —

    group id

Returns:



1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
 
# File 'lib/purecloud/api/quality_api.rb', line 1607

def get_evaluators_activity_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#get_evaluators_activity ..."
  end
  
  # resource path
  path = "/api/v1/quality/evaluators/activity".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[:'startTime'] = opts[:'start_time'] if opts[:'start_time']
  query_params[:'endTime'] = opts[:'end_time'] if opts[:'end_time']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'permission'] = @api_client.build_collection_param(opts[:'permission'], :multi) if opts[:'permission']
  query_params[:'group'] = opts[:'group'] if opts[:'group']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#update_calibration(calibration_id, opts = {}) ⇒ Calibration

Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex

Parameters:

  • calibration_id —

    Calibration ID

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

    the optional parameters

Options Hash (opts):

Returns:



881
882
883
884
 
# File 'lib/purecloud/api/quality_api.rb', line 881

def update_calibration(calibration_id, opts = {})
  data, status_code, headers = update_calibration_with_http_info(calibration_id, opts)
  return data
end

#update_calibration_with_http_info(calibration_id, opts = {}) ⇒ Array<(Calibration, Fixnum, Hash)>

Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex

Parameters:

  • calibration_id —

    Calibration ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Calibration data, response status code and response headers



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
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/purecloud/api/quality_api.rb', line 892

def update_calibration_with_http_info(calibration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#update_calibration ..."
  end
  
  # verify the required parameter 'calibration_id' is set
  fail "Missing the required parameter 'calibration_id' when calling update_calibration" if calibration_id.nil?
  
  # resource path
  path = "/api/v1/quality/calibrations/{calibrationId}".sub('{format}','json').sub('{' + 'calibrationId' + '}', calibration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

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

#update_conversation_evaluations_by_evaluation_id(conversation_id, evaluation_id, opts = {}) ⇒ Evaluation

Update an evaluation

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Evaluation) —

    evaluation

  • :expand (String) —

    evaluatorId

Returns:



1224
1225
1226
1227
 
# File 'lib/purecloud/api/quality_api.rb', line 1224

def update_conversation_evaluations_by_evaluation_id(conversation_id, evaluation_id, opts = {})
  data, status_code, headers = update_conversation_evaluations_by_evaluation_id_with_http_info(conversation_id, evaluation_id, opts)
  return data
end

#update_conversation_evaluations_by_evaluation_id_with_http_info(conversation_id, evaluation_id, opts = {}) ⇒ Array<(Evaluation, Fixnum, Hash)>

Update an evaluation

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Evaluation) —

    evaluation

  • :expand (String) —

    evaluatorId

Returns:

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

    Evaluation data, response status code and response headers



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

def update_conversation_evaluations_by_evaluation_id_with_http_info(conversation_id, evaluation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#update_conversation_evaluations_by_evaluation_id ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling update_conversation_evaluations_by_evaluation_id" if conversation_id.nil?
  
  # verify the required parameter 'evaluation_id' is set
  fail "Missing the required parameter 'evaluation_id' when calling update_conversation_evaluations_by_evaluation_id" if evaluation_id.nil?
  
  # resource path
  path = "/api/v1/quality/conversations/{conversationId}/evaluations/{evaluationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'evaluationId' + '}', evaluation_id.to_s)

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

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

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

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

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • body —

    recording

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

    the optional parameters

Options Hash (opts):

  • :restore_days (Integer) —

    The number of days the recording will be available before it is re-archived. Deprecated.

Returns:

  • (nil) 


171
172
173
174
 
# File 'lib/purecloud/api/quality_api.rb', line 171

def update_conversation_recordings_by_recording_id(conversation_id, recording_id, body, opts = {})
  update_conversation_recordings_by_recording_id_with_http_info(conversation_id, recording_id, body, opts)
  return nil
end

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

Update annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Options Hash (opts):

Returns:



449
450
451
452
 
# File 'lib/purecloud/api/quality_api.rb', line 449

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

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

Update annotation

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • annotation_id —

    Annotation ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Annotation data, response status code and response headers



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/purecloud/api/quality_api.rb', line 462

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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: QualityApi#update_conversation_recordings_by_recording_id_annotations_by_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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

Parameters:

  • conversation_id —

    Conversation ID

  • recording_id —

    Recording ID

  • body —

    recording

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

    the optional parameters

Options Hash (opts):

  • :restore_days (Integer) —

    The number of days the recording will be available before it is re-archived. Deprecated.

Returns:

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

    nil, response status code and response headers



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/purecloud/api/quality_api.rb', line 184

def update_conversation_recordings_by_recording_id_with_http_info(conversation_id, recording_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi#update_conversation_recordings_by_recording_id ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling update_conversation_recordings_by_recording_id" if conversation_id.nil?
  
  # verify the required parameter 'recording_id' is set
  fail "Missing the required parameter 'recording_id' when calling update_conversation_recordings_by_recording_id" if recording_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling update_conversation_recordings_by_recording_id" if body.nil?
  
  # resource path
  path = "/api/v1/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[:'restoreDays'] = opts[:'restore_days'] if opts[:'restore_days']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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: QualityApi#update_conversation_recordings_by_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end