Class: PureCloud::QualityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/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.



23
24
25
 
# File 'lib/purecloudclient_v2a/api/quality_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/purecloudclient_v2a/api/quality_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_quality_calibration(calibration_id, calibrator_id, opts = {}) ⇒ Calibration

Delete a calibration by id.

Parameters:

  • calibration_id —

    Calibration ID

  • calibrator_id —

    calibratorId

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

    the optional parameters

Returns:



33
34
35
36
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 33

def delete_quality_calibration(calibration_id, calibrator_id, opts = {})
  data, _status_code, _headers = delete_quality_calibration_with_http_info(calibration_id, calibrator_id, opts)
  return data
end

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

Delete a calibration by id.

Parameters:

  • calibration_id —

    Calibration ID

  • calibrator_id —

    calibratorId

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

    the optional parameters

Returns:

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

    Calibration data, response status code and response headers



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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 44

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

  # query parameters
  query_params = {}
  query_params[:'calibratorId'] = calibrator_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(: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 => 'Calibration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#delete_quality_calibration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete an evaluation

Parameters:

  • conversation_id —

    conversationId

  • evaluation_id —

    evaluationId

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    evaluatorId

Returns:



110
111
112
113
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 110

def delete_quality_conversation_evaluation(conversation_id, evaluation_id, opts = {})
  data, _status_code, _headers = delete_quality_conversation_evaluation_with_http_info(conversation_id, evaluation_id, opts)
  return data
end

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

Delete an evaluation

Parameters:

  • conversation_id —

    conversationId

  • evaluation_id —

    evaluationId

  • 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



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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 122

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

#delete_quality_form(form_id, opts = {}) ⇒ nil

Delete an evaluation form.

Parameters:

  • form_id —

    Form ID

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

    the optional parameters

Returns:

  • (nil) 


192
193
194
195
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 192

def delete_quality_form(form_id, opts = {})
  delete_quality_form_with_http_info(form_id, opts)
  return nil
end

#delete_quality_form_with_http_info(form_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an evaluation form.

Parameters:

  • form_id —

    Form ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 202

def delete_quality_form_with_http_info(form_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.delete_quality_form ..."
  end
  
  
  # verify the required parameter 'form_id' is set
  fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.delete_quality_form" if form_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/forms/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_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: QualityApi#delete_quality_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_quality_keywordset(keyword_set_id, opts = {}) ⇒ nil

Delete a keywordSet by id.

Parameters:

  • keyword_set_id —

    KeywordSet ID

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

    the optional parameters

Returns:

  • (nil) 


256
257
258
259
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 256

def delete_quality_keywordset(keyword_set_id, opts = {})
  delete_quality_keywordset_with_http_info(keyword_set_id, opts)
  return nil
end

#delete_quality_keywordset_with_http_info(keyword_set_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a keywordSet by id.

Parameters:

  • keyword_set_id —

    KeywordSet ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 266

def delete_quality_keywordset_with_http_info(keyword_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.delete_quality_keywordset ..."
  end
  
  
  # verify the required parameter 'keyword_set_id' is set
  fail ArgumentError, "Missing the required parameter 'keyword_set_id' when calling QualityApi.delete_quality_keywordset" if keyword_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/keywordsets/{keywordSetId}".sub('{format}','json').sub('{' + 'keywordSetId' + '}', keyword_set_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: QualityApi#delete_quality_keywordset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_quality_keywordsets(ids, opts = {}) ⇒ nil

Delete keyword sets Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.

Parameters:

  • ids —

    A comma-delimited list of valid KeywordSet ids

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

    the optional parameters

Returns:

  • (nil) 


320
321
322
323
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 320

def delete_quality_keywordsets(ids, opts = {})
  delete_quality_keywordsets_with_http_info(ids, opts)
  return nil
end

#delete_quality_keywordsets_with_http_info(ids, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete keyword sets Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.

Parameters:

  • ids —

    A comma-delimited list of valid KeywordSet ids

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 330

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

#get_quality_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 (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

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

    user id of agent requested

  • :evaluator_user_id (String) —

    user id of the evaluator

  • :name (String) —

    name

  • :group (String) —

    group id

Returns:



396
397
398
399
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 396

def get_quality_agents_activity(opts = {})
  data, _status_code, _headers = get_quality_agents_activity_with_http_info(opts)
  return data
end

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

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

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

    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



417
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
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 417

def get_quality_agents_activity_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_agents_activity ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/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[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  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)
  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 => 'AgentActivityEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#get_quality_agents_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a calibration by id. Requires either calibrator id or conversation id

Parameters:

  • calibration_id —

    Calibration ID

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

    the optional parameters

Options Hash (opts):

  • :calibrator_id (String) —

    calibratorId

  • :conversation_id (String) —

    conversationId

Returns:



550
551
552
553
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 550

def get_quality_calibration(calibration_id, opts = {})
  data, _status_code, _headers = get_quality_calibration_with_http_info(calibration_id, opts)
  return data
end

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

Get a calibration by id. Requires either calibrator id or conversation id

Parameters:

  • calibration_id —

    Calibration ID

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

    the optional parameters

Options Hash (opts):

  • :calibrator_id (String) —

    calibratorId

  • :conversation_id (String) —

    conversationId

Returns:

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

    Calibration data, response status code and response headers



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 562

def get_quality_calibration_with_http_info(calibration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_calibration ..."
  end
  
  
  # verify the required parameter 'calibration_id' is set
  fail ArgumentError, "Missing the required parameter 'calibration_id' when calling QualityApi.get_quality_calibration" if calibration_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/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']
  query_params[:'conversationId'] = opts[:'conversation_id'] if opts[:'conversation_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 => 'Calibration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#get_quality_calibration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quality_calibrations(calibrator_id, opts = {}) ⇒ CalibrationEntityListing

Get the list of calibrations

Parameters:

  • calibrator_id —

    user id of calibrator

  • 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

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

Returns:



640
641
642
643
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 640

def get_quality_calibrations(calibrator_id, opts = {})
  data, _status_code, _headers = get_quality_calibrations_with_http_info(calibrator_id, opts)
  return data
end

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

Get the list of calibrations

Parameters:

  • calibrator_id —

    user id of calibrator

  • 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

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

Returns:

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

    CalibrationEntityListing data, response status code and response headers



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
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
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 659

def get_quality_calibrations_with_http_info(calibrator_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_calibrations ..."
  end
  
  
  # verify the required parameter 'calibrator_id' is set
  fail ArgumentError, "Missing the required parameter 'calibrator_id' when calling QualityApi.get_quality_calibrations" if calibrator_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/calibrations".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'calibratorId'] = calibrator_id
  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[:'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']

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

#get_quality_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 (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

  • :recording_id (String) —

    id of the recording

  • :entity_type (String) —

    entity type options: Recording, Calibration, Evaluation, Annotation, Screen_Recording (default to RECORDING)

Returns:



786
787
788
789
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 786

def get_quality_conversation_audits(conversation_id, opts = {})
  data, _status_code, _headers = get_quality_conversation_audits_with_http_info(conversation_id, opts)
  return data
end

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

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :recording_id (String) —

    id of the recording

  • :entity_type (String) —

    entity type options: Recording, Calibration, Evaluation, Annotation, Screen_Recording

Returns:

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

    QualityAuditPage data, response status code and response headers



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
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
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
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 804

def get_quality_conversation_audits_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_conversation_audits ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling QualityApi.get_quality_conversation_audits" if conversation_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/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[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  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)
  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 => 'QualityAuditPage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#get_quality_conversation_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get an evaluation

Parameters:

  • conversation_id —

    conversationId

  • evaluation_id —

    evaluationId

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    agent, evaluator, evaluationForm

Returns:



917
918
919
920
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 917

def get_quality_conversation_evaluation(conversation_id, evaluation_id, opts = {})
  data, _status_code, _headers = get_quality_conversation_evaluation_with_http_info(conversation_id, evaluation_id, opts)
  return data
end

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

Get an evaluation

Parameters:

  • conversation_id —

    conversationId

  • evaluation_id —

    evaluationId

  • 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



929
930
931
932
933
934
935
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
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 929

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

#get_quality_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 (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

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

  • :sort_order (String) —

    sort order options for agentUserId or evaluatorUserId query. Valid options are &#39;a&#39;, &#39;asc&#39;, &#39;ascending&#39;, &#39;d&#39;, &#39;desc&#39;, &#39;descending&#39;

Returns:



1016
1017
1018
1019
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1016

def get_quality_evaluations_query(opts = {})
  data, _status_code, _headers = get_quality_evaluations_query_with_http_info(opts)
  return data
end

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

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

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

  • :sort_order (String) —

    sort order options for agentUserId or evaluatorUserId query. Valid options are &#39;a&#39;, &#39;asc&#39;, &#39;ascending&#39;, &#39;d&#39;, &#39;desc&#39;, &#39;descending&#39;

Returns:

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

    EvaluationEntityListing data, response status code and response headers



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
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1043

def get_quality_evaluations_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_evaluations_query ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/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[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  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']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

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

#get_quality_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 (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

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

    permission strings

  • :group (String) —

    group id

Returns:



1226
1227
1228
1229
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1226

def get_quality_evaluators_activity(opts = {})
  data, _status_code, _headers = get_quality_evaluators_activity_with_http_info(opts)
  return data
end

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

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

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

    permission strings

  • :group (String) —

    group id

Returns:



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
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
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
1355
1356
1357
1358
1359
1360
1361
1362
1363
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1246

def get_quality_evaluators_activity_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_evaluators_activity ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/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[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  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)
  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 => 'EvaluatorActivityEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#get_quality_evaluators_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quality_form(form_id, opts = {}) ⇒ EvaluationForm

Get an evaluation form

Parameters:

  • form_id —

    Form ID

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

    the optional parameters

Returns:



1370
1371
1372
1373
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1370

def get_quality_form(form_id, opts = {})
  data, _status_code, _headers = get_quality_form_with_http_info(form_id, opts)
  return data
end

#get_quality_form_versions(form_id, opts = {}) ⇒ EvaluationFormEntityListing

Gets all the revisions for a specific evaluation.

Parameters:

  • form_id —

    Form ID

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



1437
1438
1439
1440
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1437

def get_quality_form_versions(form_id, opts = {})
  data, _status_code, _headers = get_quality_form_versions_with_http_info(form_id, opts)
  return data
end

#get_quality_form_versions_with_http_info(form_id, opts = {}) ⇒ Array<(EvaluationFormEntityListing, Fixnum, Hash)>

Gets all the revisions for a specific evaluation.

Parameters:

  • form_id —

    Form ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
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
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1449

def get_quality_form_versions_with_http_info(form_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_form_versions ..."
  end
  
  
  # verify the required parameter 'form_id' is set
  fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.get_quality_form_versions" if form_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/forms/{formId}/versions".sub('{format}','json').sub('{' + 'formId' + '}', form_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']

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

#get_quality_form_with_http_info(form_id, opts = {}) ⇒ Array<(EvaluationForm, Fixnum, Hash)>

Get an evaluation form

Parameters:

  • form_id —

    Form ID

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

    the optional parameters

Returns:

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

    EvaluationForm data, response status code and response headers



1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
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
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1380

def get_quality_form_with_http_info(form_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_form ..."
  end
  
  
  # verify the required parameter 'form_id' is set
  fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.get_quality_form" if form_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/forms/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_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 => 'EvaluationForm')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#get_quality_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quality_forms(opts = {}) ⇒ EvaluationFormEntityListing

Get the list of evaluation forms

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

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :expand (String) —

    Expand

  • :name (String) —

    Name

Returns:



1524
1525
1526
1527
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1524

def get_quality_forms(opts = {})
  data, _status_code, _headers = get_quality_forms_with_http_info(opts)
  return data
end

#get_quality_forms_with_http_info(opts = {}) ⇒ Array<(EvaluationFormEntityListing, Fixnum, Hash)>

Get the list of evaluation forms

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

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :expand (String) —

    Expand

  • :name (String) —

    Name

Returns:



1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
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
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1540

def get_quality_forms_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_forms ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/forms".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[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
  query_params[:'name'] = opts[:'name'] if opts[:'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 => 'EvaluationFormEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#get_quality_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quality_keywordset(keyword_set_id, opts = {}) ⇒ KeywordSet

Get a keywordSet by id.

Parameters:

  • keyword_set_id —

    KeywordSet ID

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

    the optional parameters

Returns:



1636
1637
1638
1639
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1636

def get_quality_keywordset(keyword_set_id, opts = {})
  data, _status_code, _headers = get_quality_keywordset_with_http_info(keyword_set_id, opts)
  return data
end

#get_quality_keywordset_with_http_info(keyword_set_id, opts = {}) ⇒ Array<(KeywordSet, Fixnum, Hash)>

Get a keywordSet by id.

Parameters:

  • keyword_set_id —

    KeywordSet ID

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

    the optional parameters

Returns:

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

    KeywordSet data, response status code and response headers



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
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1646

def get_quality_keywordset_with_http_info(keyword_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_keywordset ..."
  end
  
  
  # verify the required parameter 'keyword_set_id' is set
  fail ArgumentError, "Missing the required parameter 'keyword_set_id' when calling QualityApi.get_quality_keywordset" if keyword_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/keywordsets/{keywordSetId}".sub('{format}','json').sub('{' + 'keywordSetId' + '}', keyword_set_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 => 'KeywordSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#get_quality_keywordset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quality_keywordsets(opts = {}) ⇒ KeywordSetEntityListing

Get the list of keyword sets

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 keyword set name - used for filtering results in searches.

  • :queue_id (String) —

    the queue id - used for filtering results in searches.

  • :agent_id (String) —

    the agent id - used for filtering results in searches.

  • :operator (String) —

    If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.

Returns:



1710
1711
1712
1713
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1710

def get_quality_keywordsets(opts = {})
  data, _status_code, _headers = get_quality_keywordsets_with_http_info(opts)
  return data
end

#get_quality_keywordsets_with_http_info(opts = {}) ⇒ Array<(KeywordSetEntityListing, Fixnum, Hash)>

Get the list of keyword sets

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 keyword set name - used for filtering results in searches.

  • :queue_id (String) —

    the queue id - used for filtering results in searches.

  • :agent_id (String) —

    the agent id - used for filtering results in searches.

  • :operator (String) —

    If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.

Returns:

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

    KeywordSetEntityListing data, response status code and response headers



1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
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
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1729

def get_quality_keywordsets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_keywordsets ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'operator'] && !['AND', 'OR'].include?(opts[:'operator'])
    fail ArgumentError, 'invalid value for "operator", must be one of AND, OR'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/keywordsets".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[:'queueId'] = opts[:'queue_id'] if opts[:'queue_id']
  query_params[:'agentId'] = opts[:'agent_id'] if opts[:'agent_id']
  query_params[:'operator'] = opts[:'operator'] if opts[:'operator']

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

#get_quality_publishedform(form_id, opts = {}) ⇒ EvaluationForm

Get the published evaluation forms.

Parameters:

  • form_id —

    Form ID

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

    the optional parameters

Returns:



1850
1851
1852
1853
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1850

def get_quality_publishedform(form_id, opts = {})
  data, _status_code, _headers = get_quality_publishedform_with_http_info(form_id, opts)
  return data
end

#get_quality_publishedform_with_http_info(form_id, opts = {}) ⇒ Array<(EvaluationForm, Fixnum, Hash)>

Get the published evaluation forms.

Parameters:

  • form_id —

    Form ID

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

    the optional parameters

Returns:

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

    EvaluationForm data, response status code and response headers



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

def get_quality_publishedform_with_http_info(form_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_publishedform ..."
  end
  
  
  # verify the required parameter 'form_id' is set
  fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.get_quality_publishedform" if form_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/publishedforms/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_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 => 'EvaluationForm')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#get_quality_publishedform\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quality_publishedforms(opts = {}) ⇒ EvaluationFormEntityListing

Get the published evaluation forms.

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)

  • :name (String) —

    Name

Returns:



1917
1918
1919
1920
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1917

def get_quality_publishedforms(opts = {})
  data, _status_code, _headers = get_quality_publishedforms_with_http_info(opts)
  return data
end

#get_quality_publishedforms_with_http_info(opts = {}) ⇒ Array<(EvaluationFormEntityListing, Fixnum, Hash)>

Get the published evaluation forms.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

Returns:



1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1929

def get_quality_publishedforms_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.get_quality_publishedforms ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/publishedforms".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[:'name'] = opts[:'name'] if opts[:'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 => 'EvaluationFormEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#get_quality_publishedforms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_analytics_evaluations_aggregates_query(body, opts = {}) ⇒ AggregateQueryResponse

Query for evaluation aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



1997
1998
1999
2000
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 1997

def post_analytics_evaluations_aggregates_query(body, opts = {})
  data, _status_code, _headers = post_analytics_evaluations_aggregates_query_with_http_info(body, opts)
  return data
end

#post_analytics_evaluations_aggregates_query_with_http_info(body, opts = {}) ⇒ Array<(AggregateQueryResponse, Fixnum, Hash)>

Query for evaluation aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:

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

    AggregateQueryResponse data, response status code and response headers



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
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2007

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

#post_quality_calibrations(body, opts = {}) ⇒ Calibration

Create a calibration

Parameters:

  • body —

    calibration

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    calibratorId

Returns:



2063
2064
2065
2066
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2063

def post_quality_calibrations(body, opts = {})
  data, _status_code, _headers = post_quality_calibrations_with_http_info(body, opts)
  return data
end

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

Create a calibration

Parameters:

  • body —

    calibration

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    calibratorId

Returns:

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

    Calibration data, response status code and response headers



2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2074

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

#post_quality_conversation_evaluations(conversation_id, body, opts = {}) ⇒ Evaluation

Create an evaluation

Parameters:

  • conversation_id —

    conversationId

  • body —

    evaluation

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    evaluatorId

Returns:



2138
2139
2140
2141
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2138

def post_quality_conversation_evaluations(conversation_id, body, opts = {})
  data, _status_code, _headers = post_quality_conversation_evaluations_with_http_info(conversation_id, body, opts)
  return data
end

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

Create an evaluation

Parameters:

  • conversation_id —

    conversationId

  • body —

    evaluation

  • 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



2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2150

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

#post_quality_evaluations_scoring(body, opts = {}) ⇒ EvaluationScoringSet

Score evaluation

Parameters:

  • body —

    evaluationAndScoringSet

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

    the optional parameters

Returns:



2220
2221
2222
2223
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2220

def post_quality_evaluations_scoring(body, opts = {})
  data, _status_code, _headers = post_quality_evaluations_scoring_with_http_info(body, opts)
  return data
end

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

Score evaluation

Parameters:

  • body —

    evaluationAndScoringSet

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

    the optional parameters

Returns:

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

    EvaluationScoringSet data, response status code and response headers



2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2230

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

#post_quality_forms(body, opts = {}) ⇒ EvaluationForm

Create an evaluation form.

Parameters:

  • body —

    Evaluation form

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

    the optional parameters

Returns:



2285
2286
2287
2288
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2285

def post_quality_forms(body, opts = {})
  data, _status_code, _headers = post_quality_forms_with_http_info(body, opts)
  return data
end

#post_quality_forms_with_http_info(body, opts = {}) ⇒ Array<(EvaluationForm, Fixnum, Hash)>

Create an evaluation form.

Parameters:

  • body —

    Evaluation form

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

    the optional parameters

Returns:

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

    EvaluationForm data, response status code and response headers



2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2295

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

#post_quality_keywordsets(body, opts = {}) ⇒ KeywordSet

Create a Keyword Set

Parameters:

  • body —

    keywordSet

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    queueId

Returns:



2351
2352
2353
2354
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2351

def post_quality_keywordsets(body, opts = {})
  data, _status_code, _headers = post_quality_keywordsets_with_http_info(body, opts)
  return data
end

#post_quality_keywordsets_with_http_info(body, opts = {}) ⇒ Array<(KeywordSet, Fixnum, Hash)>

Create a Keyword Set

Parameters:

  • body —

    keywordSet

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    queueId

Returns:

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

    KeywordSet data, response status code and response headers



2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2362

def post_quality_keywordsets_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.post_quality_keywordsets ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_keywordsets" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/keywordsets".sub('{format}','json')

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

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

#post_quality_publishedforms(body, opts = {}) ⇒ EvaluationForm

Publish an evaluation form.

Parameters:

  • body —

    Evaluation form

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

    the optional parameters

Returns:



2424
2425
2426
2427
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2424

def post_quality_publishedforms(body, opts = {})
  data, _status_code, _headers = post_quality_publishedforms_with_http_info(body, opts)
  return data
end

#post_quality_publishedforms_with_http_info(body, opts = {}) ⇒ Array<(EvaluationForm, Fixnum, Hash)>

Publish an evaluation form.

Parameters:

  • body —

    Evaluation form

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

    the optional parameters

Returns:

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

    EvaluationForm data, response status code and response headers



2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2434

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

#post_quality_spotability(opts = {}) ⇒ KeywordSet

Retrieve the spotability statistic

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2489
2490
2491
2492
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2489

def post_quality_spotability(opts = {})
  data, _status_code, _headers = post_quality_spotability_with_http_info(opts)
  return data
end

#post_quality_spotability_with_http_info(opts = {}) ⇒ Array<(KeywordSet, Fixnum, Hash)>

Retrieve the spotability statistic

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    KeywordSet data, response status code and response headers



2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2499

def post_quality_spotability_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.post_quality_spotability ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/spotability".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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KeywordSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#post_quality_spotability\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_quality_calibration(calibration_id, body, opts = {}) ⇒ Calibration

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

Parameters:

  • calibration_id —

    Calibration ID

  • body —

    Calibration

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

    the optional parameters

Returns:



2553
2554
2555
2556
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2553

def put_quality_calibration(calibration_id, body, opts = {})
  data, _status_code, _headers = put_quality_calibration_with_http_info(calibration_id, body, opts)
  return data
end

#put_quality_calibration_with_http_info(calibration_id, body, 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

  • body —

    Calibration

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

    the optional parameters

Returns:

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

    Calibration data, response status code and response headers



2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2564

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

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

Update an evaluation

Parameters:

  • conversation_id —

    conversationId

  • evaluation_id —

    evaluationId

  • body —

    evaluation

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    evaluatorId

Returns:



2630
2631
2632
2633
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2630

def put_quality_conversation_evaluation(conversation_id, evaluation_id, body, opts = {})
  data, _status_code, _headers = put_quality_conversation_evaluation_with_http_info(conversation_id, evaluation_id, body, opts)
  return data
end

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

Update an evaluation

Parameters:

  • conversation_id —

    conversationId

  • evaluation_id —

    evaluationId

  • body —

    evaluation

  • 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



2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2643

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

#put_quality_form(form_id, body, opts = {}) ⇒ EvaluationForm

Update an evaluation form.

Parameters:

  • form_id —

    Form ID

  • body —

    Evaluation form

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

    the optional parameters

Returns:



2722
2723
2724
2725
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2722

def put_quality_form(form_id, body, opts = {})
  data, _status_code, _headers = put_quality_form_with_http_info(form_id, body, opts)
  return data
end

#put_quality_form_with_http_info(form_id, body, opts = {}) ⇒ Array<(EvaluationForm, Fixnum, Hash)>

Update an evaluation form.

Parameters:

  • form_id —

    Form ID

  • body —

    Evaluation form

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

    the optional parameters

Returns:

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

    EvaluationForm data, response status code and response headers



2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2733

def put_quality_form_with_http_info(form_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.put_quality_form ..."
  end
  
  
  # verify the required parameter 'form_id' is set
  fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.put_quality_form" if form_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.put_quality_form" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/forms/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_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 => 'EvaluationForm')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#put_quality_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_quality_keywordset(keyword_set_id, body, opts = {}) ⇒ KeywordSet

Update a keywordSet to the specified keywordSet via PUT.

Parameters:

  • keyword_set_id —

    KeywordSet ID

  • body —

    keywordSet

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

    the optional parameters

Returns:



2797
2798
2799
2800
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2797

def put_quality_keywordset(keyword_set_id, body, opts = {})
  data, _status_code, _headers = put_quality_keywordset_with_http_info(keyword_set_id, body, opts)
  return data
end

#put_quality_keywordset_with_http_info(keyword_set_id, body, opts = {}) ⇒ Array<(KeywordSet, Fixnum, Hash)>

Update a keywordSet to the specified keywordSet via PUT.

Parameters:

  • keyword_set_id —

    KeywordSet ID

  • body —

    keywordSet

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

    the optional parameters

Returns:

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

    KeywordSet data, response status code and response headers



2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
 
# File 'lib/purecloudclient_v2a/api/quality_api.rb', line 2808

def put_quality_keywordset_with_http_info(keyword_set_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QualityApi.put_quality_keywordset ..."
  end
  
  
  # verify the required parameter 'keyword_set_id' is set
  fail ArgumentError, "Missing the required parameter 'keyword_set_id' when calling QualityApi.put_quality_keywordset" if keyword_set_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.put_quality_keywordset" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/quality/keywordsets/{keywordSetId}".sub('{format}','json').sub('{' + 'keywordSetId' + '}', keyword_set_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 => 'KeywordSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QualityApi#put_quality_keywordset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end