Class: PureCloud::QualityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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
 
# File 'lib/purecloudplatformclientv2/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:



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

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



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

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

Delete an evaluation form.

Parameters:

  • form_id —

    Form ID

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

    the optional parameters

Returns:

  • (String) 


158
159
160
161
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 158

def delete_quality_form(form_id, opts = {})
  data, _status_code, _headers = delete_quality_form_with_http_info(form_id, opts)
  return data
end

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

Delete an evaluation form.

Parameters:

  • form_id —

    Form ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

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,
    :return_type => 'String')
  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) 


215
216
217
218
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 215

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



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

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

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:

  • (String) 


271
272
273
274
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 271

def delete_quality_keywordsets(ids, opts = {})
  data, _status_code, _headers = delete_quality_keywordsets_with_http_info(ids, opts)
  return data
end

#delete_quality_keywordsets_with_http_info(ids, opts = {}) ⇒ Array<(String, 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<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
314
315
316
317
318
319
320
321
322
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 281

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,
    :return_type => 'String')
  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:



340
341
342
343
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 340

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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 361

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, calibrator_id, opts = {}) ⇒ Calibration

Get a calibration by id.

Parameters:

  • calibration_id —

    Calibration ID

  • calibrator_id —

    calibratorId

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

    the optional parameters

Returns:



419
420
421
422
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 419

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

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

Get 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



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

def get_quality_calibration_with_http_info(calibration_id, calibrator_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?
  # verify the required parameter 'calibrator_id' is set
  fail ArgumentError, "Missing the required parameter 'calibrator_id' when calling QualityApi.get_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(: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:



489
490
491
492
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 489

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



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

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 (default to RECORDING)

Returns:



573
574
575
576
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 573

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

Returns:

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

    QualityAuditPage data, response status code and response headers



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 591

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:



648
649
650
651
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 648

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



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

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

    evaluation state options: Pending, InProgress, Finished

  • :is_released (BOOLEAN) —

    the evaluation has been released

  • :agent_has_read (BOOLEAN) —

    agent has the evaluation

  • :expand_answer_total_scores (BOOLEAN) —

    get the total scores for evaluations

  • :maximum (Integer) —

    maximum

Returns:



726
727
728
729
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 726

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

    evaluation state options: Pending, InProgress, Finished

  • :is_released (BOOLEAN) —

    the evaluation has been released

  • :agent_has_read (BOOLEAN) —

    agent has the evaluation

  • :expand_answer_total_scores (BOOLEAN) —

    get the total scores for evaluations

  • :maximum (Integer) —

    maximum

Returns:

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

    EvaluationEntityListing data, response status code and response headers



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 752

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']

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



824
825
826
827
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 824

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:



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

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:



900
901
902
903
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 900

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:



959
960
961
962
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 959

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:



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

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



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

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:



1026
1027
1028
1029
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1026

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:



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1042

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:



1094
1095
1096
1097
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1094

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



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

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:



1160
1161
1162
1163
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1160

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



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1179

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:



1237
1238
1239
1240
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1237

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



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

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:



1296
1297
1298
1299
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1296

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:



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

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:



1356
1357
1358
1359
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1356

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



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
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
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1366

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:



1414
1415
1416
1417
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1414

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



1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1425

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:



1475
1476
1477
1478
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1475

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



1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1487

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:



1537
1538
1539
1540
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1537

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



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

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:



1594
1595
1596
1597
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1594

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



1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1604

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:



1652
1653
1654
1655
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1652

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



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
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1663

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:



1711
1712
1713
1714
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1711

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



1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1721

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:



1768
1769
1770
1771
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1768

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



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

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:



1824
1825
1826
1827
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1824

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



1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1835

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:



1887
1888
1889
1890
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1887

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



1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1900

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:



1953
1954
1955
1956
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1953

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



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
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 1964

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:



2014
2015
2016
2017
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 2014

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



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
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
 
# File 'lib/purecloudplatformclientv2/api/quality_api.rb', line 2025

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