doc_out/QualityApi.html.md in purecloud-0.67.1 vs doc_out/QualityApi.html.md in purecloud-0.68.1
- old
+ new
@@ -4,53 +4,56 @@
## PureCloud::QualityApi
All URIs are relative to *https://api.mypurecloud.com*
-Method | HTTP request | Description
+Method | Description
------------- | ------------- | -------------
-|[**delete_calibrations_calibration_id**](QualityApi.html#delete_calibrations_calibration_id) | **DELETE** /api/v2/quality/calibrations/{calibrationId} | Delete a calibration by id.|
-|[**delete_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#delete_conversations_conversation_id_evaluations_evaluation_id) | **DELETE** /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} | Delete an evaluation|
-|[**delete_forms_form_id**](QualityApi.html#delete_forms_form_id) | **DELETE** /api/v2/quality/forms/{formId} | Delete an evaluation form.|
-|[**delete_keywordsets**](QualityApi.html#delete_keywordsets) | **DELETE** /api/v2/quality/keywordsets | Delete keyword sets|
-|[**delete_keywordsets_keywordset_id**](QualityApi.html#delete_keywordsets_keywordset_id) | **DELETE** /api/v2/quality/keywordsets/{keywordSetId} | Delete a keywordSet by id.|
-|[**get_agents_activity**](QualityApi.html#get_agents_activity) | **GET** /api/v2/quality/agents/activity | Gets a list of Agent Activities|
-|[**get_calibrations**](QualityApi.html#get_calibrations) | **GET** /api/v2/quality/calibrations | Get the list of calibrations|
-|[**get_calibrations_calibration_id**](QualityApi.html#get_calibrations_calibration_id) | **GET** /api/v2/quality/calibrations/{calibrationId} | Get a calibration by id.|
-|[**get_conversations_conversation_id_audits**](QualityApi.html#get_conversations_conversation_id_audits) | **GET** /api/v2/quality/conversations/{conversationId}/audits | Get audits for conversation or recording|
-|[**get_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#get_conversations_conversation_id_evaluations_evaluation_id) | **GET** /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} | Get an evaluation|
-|[**get_evaluations_query**](QualityApi.html#get_evaluations_query) | **GET** /api/v2/quality/evaluations/query | Queries Evaluations and returns a paged list|
-|[**get_evaluators_activity**](QualityApi.html#get_evaluators_activity) | **GET** /api/v2/quality/evaluators/activity | Get an evaluator activity|
-|[**get_forms**](QualityApi.html#get_forms) | **GET** /api/v2/quality/forms | Get the list of evaluation forms|
-|[**get_forms_form_id**](QualityApi.html#get_forms_form_id) | **GET** /api/v2/quality/forms/{formId} | Get an evaluation form|
-|[**get_forms_form_id_versions**](QualityApi.html#get_forms_form_id_versions) | **GET** /api/v2/quality/forms/{formId}/versions | Gets all the revisions for a specific evaluation.|
-|[**get_keywordsets**](QualityApi.html#get_keywordsets) | **GET** /api/v2/quality/keywordsets | Get the list of keyword sets|
-|[**get_keywordsets_keywordset_id**](QualityApi.html#get_keywordsets_keywordset_id) | **GET** /api/v2/quality/keywordsets/{keywordSetId} | Get a keywordSet by id.|
-|[**get_publishedforms**](QualityApi.html#get_publishedforms) | **GET** /api/v2/quality/publishedforms | Get the published evaluation forms.|
-|[**get_publishedforms_form_id**](QualityApi.html#get_publishedforms_form_id) | **GET** /api/v2/quality/publishedforms/{formId} | Get the published evaluation forms.|
-|[**post_calibrations**](QualityApi.html#post_calibrations) | **POST** /api/v2/quality/calibrations | Create a calibration|
-|[**post_conversations_conversation_id_evaluations**](QualityApi.html#post_conversations_conversation_id_evaluations) | **POST** /api/v2/quality/conversations/{conversationId}/evaluations | Create an evaluation|
-|[**post_evaluations_aggregates_query**](QualityApi.html#post_evaluations_aggregates_query) | **POST** /api/v2/analytics/evaluations/aggregates/query | Query for evaluation aggregates|
-|[**post_evaluations_scoring**](QualityApi.html#post_evaluations_scoring) | **POST** /api/v2/quality/evaluations/scoring | Score evaluation|
-|[**post_forms**](QualityApi.html#post_forms) | **POST** /api/v2/quality/forms | Create an evaluation form.|
-|[**post_keywordsets**](QualityApi.html#post_keywordsets) | **POST** /api/v2/quality/keywordsets | Create a Keyword Set|
-|[**post_publishedforms**](QualityApi.html#post_publishedforms) | **POST** /api/v2/quality/publishedforms | Publish an evaluation form.|
-|[**post_spotability**](QualityApi.html#post_spotability) | **POST** /api/v2/quality/spotability | Retrieve the spotability statistic|
-|[**put_calibrations_calibration_id**](QualityApi.html#put_calibrations_calibration_id) | **PUT** /api/v2/quality/calibrations/{calibrationId} | Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex|
-|[**put_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#put_conversations_conversation_id_evaluations_evaluation_id) | **PUT** /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} | Update an evaluation|
-|[**put_forms_form_id**](QualityApi.html#put_forms_form_id) | **PUT** /api/v2/quality/forms/{formId} | Update an evaluation form.|
-|[**put_keywordsets_keywordset_id**](QualityApi.html#put_keywordsets_keywordset_id) | **PUT** /api/v2/quality/keywordsets/{keywordSetId} | Update a keywordSet to the specified keywordSet via PUT.|
+[**delete_calibrations_calibration_id**](QualityApi.html#delete_calibrations_calibration_id) | Delete a calibration by id.
+[**delete_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#delete_conversations_conversation_id_evaluations_evaluation_id) | Delete an evaluation
+[**delete_forms_form_id**](QualityApi.html#delete_forms_form_id) | Delete an evaluation form.
+[**delete_keywordsets**](QualityApi.html#delete_keywordsets) | Delete keyword sets
+[**delete_keywordsets_keywordset_id**](QualityApi.html#delete_keywordsets_keywordset_id) | Delete a keywordSet by id.
+[**get_agents_activity**](QualityApi.html#get_agents_activity) | Gets a list of Agent Activities
+[**get_calibrations**](QualityApi.html#get_calibrations) | Get the list of calibrations
+[**get_calibrations_calibration_id**](QualityApi.html#get_calibrations_calibration_id) | Get a calibration by id.
+[**get_conversations_conversation_id_audits**](QualityApi.html#get_conversations_conversation_id_audits) | Get audits for conversation or recording
+[**get_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#get_conversations_conversation_id_evaluations_evaluation_id) | Get an evaluation
+[**get_evaluations_query**](QualityApi.html#get_evaluations_query) | Queries Evaluations and returns a paged list
+[**get_evaluators_activity**](QualityApi.html#get_evaluators_activity) | Get an evaluator activity
+[**get_forms**](QualityApi.html#get_forms) | Get the list of evaluation forms
+[**get_forms_form_id**](QualityApi.html#get_forms_form_id) | Get an evaluation form
+[**get_forms_form_id_versions**](QualityApi.html#get_forms_form_id_versions) | Gets all the revisions for a specific evaluation.
+[**get_keywordsets**](QualityApi.html#get_keywordsets) | Get the list of keyword sets
+[**get_keywordsets_keywordset_id**](QualityApi.html#get_keywordsets_keywordset_id) | Get a keywordSet by id.
+[**get_publishedforms**](QualityApi.html#get_publishedforms) | Get the published evaluation forms.
+[**get_publishedforms_form_id**](QualityApi.html#get_publishedforms_form_id) | Get the published evaluation forms.
+[**post_calibrations**](QualityApi.html#post_calibrations) | Create a calibration
+[**post_conversations_conversation_id_evaluations**](QualityApi.html#post_conversations_conversation_id_evaluations) | Create an evaluation
+[**post_evaluations_aggregates_query**](QualityApi.html#post_evaluations_aggregates_query) | Query for evaluation aggregates
+[**post_evaluations_scoring**](QualityApi.html#post_evaluations_scoring) | Score evaluation
+[**post_forms**](QualityApi.html#post_forms) | Create an evaluation form.
+[**post_keywordsets**](QualityApi.html#post_keywordsets) | Create a Keyword Set
+[**post_publishedforms**](QualityApi.html#post_publishedforms) | Publish an evaluation form.
+[**post_spotability**](QualityApi.html#post_spotability) | Retrieve the spotability statistic
+[**put_calibrations_calibration_id**](QualityApi.html#put_calibrations_calibration_id) | Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
+[**put_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#put_conversations_conversation_id_evaluations_evaluation_id) | Update an evaluation
+[**put_forms_form_id**](QualityApi.html#put_forms_form_id) | Update an evaluation form.
+[**put_keywordsets_keywordset_id**](QualityApi.html#put_keywordsets_keywordset_id) | Update a keywordSet to the specified keywordSet via PUT.
{: class="table table-striped"}
<a name="delete_calibrations_calibration_id"></a>
## -[**Calibration**](Calibration.html) delete_calibrations_calibration_id(calibration_id, calibrator_id)
Delete a calibration by id.
+Wraps DELETE /api/v2/quality/calibrations/{calibrationId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -106,10 +109,13 @@
Delete an evaluation
+Wraps DELETE /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -169,10 +175,13 @@
Delete an evaluation form.
+Wraps DELETE /api/v2/quality/forms/{formId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -225,10 +234,13 @@
Delete keyword sets
Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.
+Wraps DELETE /api/v2/quality/keywordsets
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -281,10 +293,13 @@
Delete a keywordSet by id.
+Wraps DELETE /api/v2/quality/keywordsets/{keywordSetId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -336,10 +351,13 @@
Gets a list of Agent Activities
Including the number of evaluations and average evaluation score
+Wraps GET /api/v2/quality/agents/activity
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -415,10 +433,13 @@
Get the list of calibrations
+Wraps GET /api/v2/quality/calibrations
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -491,10 +512,13 @@
Get a calibration by id.
+Wraps GET /api/v2/quality/calibrations/{calibrationId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -550,10 +574,13 @@
Get audits for conversation or recording
+Wraps GET /api/v2/quality/conversations/{conversationId}/audits
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -624,10 +651,13 @@
Get an evaluation
+Wraps GET /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -687,10 +717,13 @@
Queries Evaluations and returns a paged list
Query params must include one of conversationId, evaluatorUserId, or agentUserId
+Wraps GET /api/v2/quality/evaluations/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -776,10 +809,13 @@
Get an evaluator activity
+Wraps GET /api/v2/quality/evaluators/activity
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -853,10 +889,13 @@
Get the list of evaluation forms
+Wraps GET /api/v2/quality/forms
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -922,10 +961,13 @@
Get an evaluation form
+Wraps GET /api/v2/quality/forms/{formId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -978,10 +1020,13 @@
Gets all the revisions for a specific evaluation.
+Wraps GET /api/v2/quality/forms/{formId}/versions
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1040,10 +1085,13 @@
Get the list of keyword sets
+Wraps GET /api/v2/quality/keywordsets
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1066,11 +1114,12 @@
expand: nil, # Array<Object> | variable name requested by expand list
next_page: "next_page_example", # String | next page token
previous_page: "previous_page_example", # String | Previous page token
name: "name_example", # String | the keyword set name - used for filtering results in searches.
queue_id: "queue_id_example", # String | the queue id - used for filtering results in searches.
- agent_id: "agent_id_example" # String | the agent id - used for filtering results in searches.
+ agent_id: "agent_id_example", # String | the agent id - used for filtering results in searches.
+ operator: "operator_example" # String | If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.
}
begin
#Get the list of keyword sets
result = api_instance.get_keywordsets(opts)
@@ -1091,10 +1140,11 @@
**next_page** | **String**| next page token | [optional]
**previous_page** | **String**| Previous page token | [optional]
**name** | **String**| the keyword set name - used for filtering results in searches. | [optional]
**queue_id** | **String**| the queue id - used for filtering results in searches. | [optional]
**agent_id** | **String**| the agent id - used for filtering results in searches. | [optional]
+ **operator** | **String**| If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters. | [optional]
{: class="table table-striped"}
### Return type
@@ -1113,10 +1163,13 @@
Get a keywordSet by id.
+Wraps GET /api/v2/quality/keywordsets/{keywordSetId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1169,10 +1222,13 @@
Get the published evaluation forms.
+Wraps GET /api/v2/quality/publishedforms
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1230,10 +1286,13 @@
Get the published evaluation forms.
+Wraps GET /api/v2/quality/publishedforms/{formId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1286,10 +1345,13 @@
Create a calibration
+Wraps POST /api/v2/quality/calibrations
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1346,10 +1408,13 @@
Create an evaluation
+Wraps POST /api/v2/quality/conversations/{conversationId}/evaluations
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1409,10 +1474,13 @@
Query for evaluation aggregates
+Wraps POST /api/v2/analytics/evaluations/aggregates/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1465,10 +1533,13 @@
Score evaluation
+Wraps POST /api/v2/quality/evaluations/scoring
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1521,10 +1592,13 @@
Create an evaluation form.
+Wraps POST /api/v2/quality/forms
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1577,10 +1651,13 @@
Create a Keyword Set
+Wraps POST /api/v2/quality/keywordsets
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1637,10 +1714,13 @@
Publish an evaluation form.
+Wraps POST /api/v2/quality/publishedforms
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1693,10 +1773,13 @@
Retrieve the spotability statistic
+Wraps POST /api/v2/quality/spotability
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1750,10 +1833,13 @@
Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
+Wraps PUT /api/v2/quality/calibrations/{calibrationId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1809,10 +1895,13 @@
Update an evaluation
+Wraps PUT /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1875,10 +1964,13 @@
Update an evaluation form.
+Wraps PUT /api/v2/quality/forms/{formId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1932,9 +2024,12 @@
## -[**KeywordSet**](KeywordSet.html) put_keywordsets_keywordset_id(keyword_set_id, body)
Update a keywordSet to the specified keywordSet via PUT.
+
+
+Wraps PUT /api/v2/quality/keywordsets/{keywordSetId}
### Example
~~~ruby
# load the gem