doc_out/QualityApi.html.md in purecloud-0.44.1 vs doc_out/QualityApi.html.md in purecloud-0.45.1
- old
+ new
@@ -1275,11 +1275,11 @@
<a name="post_calibrations"></a>
-## -[**Calibration**](Calibration.html) post_calibrations(opts)
+## -[**Calibration**](Calibration.html) post_calibrations(body, opts)
Create a calibration
@@ -1298,29 +1298,30 @@
config.access_token = @authToken
end
api_instance = PureCloud::QualityApi.new
+body = PureCloud::Calibration.new # Calibration | calibration
+
opts = {
- body: PureCloud::Calibration.new, # Calibration | calibration
expand: "expand_example" # String | calibratorId
}
begin
#Create a calibration
- result = api_instance.post_calibrations(opts)
+ result = api_instance.post_calibrations(body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling QualityApi->post_calibrations: #{e}"
end
~~~
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **body** | [**Calibration**](Calibration.html)| calibration | [optional]
+ **body** | [**Calibration**](Calibration.html)| calibration |
**expand** | **String**| calibratorId | [optional]
{: class="table table-striped"}
### Return type
@@ -1334,11 +1335,11 @@
<a name="post_conversations_conversation_id_evaluations"></a>
-## -[**Evaluation**](Evaluation.html) post_conversations_conversation_id_evaluations(conversation_id, opts)
+## -[**Evaluation**](Evaluation.html) post_conversations_conversation_id_evaluations(conversation_id, body, opts)
Create an evaluation
@@ -1359,18 +1360,19 @@
api_instance = PureCloud::QualityApi.new
conversation_id = "conversation_id_example" # String |
+body = PureCloud::Evaluation.new # Evaluation | evaluation
+
opts = {
- body: PureCloud::Evaluation.new, # Evaluation | evaluation
expand: "expand_example" # String | evaluatorId
}
begin
#Create an evaluation
- result = api_instance.post_conversations_conversation_id_evaluations(conversation_id, opts)
+ result = api_instance.post_conversations_conversation_id_evaluations(conversation_id, body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling QualityApi->post_conversations_conversation_id_evaluations: #{e}"
end
~~~
@@ -1378,11 +1380,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**conversation_id** | **String**| |
- **body** | [**Evaluation**](Evaluation.html)| evaluation | [optional]
+ **body** | [**Evaluation**](Evaluation.html)| evaluation |
**expand** | **String**| evaluatorId | [optional]
{: class="table table-striped"}
### Return type
@@ -1396,11 +1398,11 @@
<a name="post_evaluations_aggregates_query"></a>
-## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_evaluations_aggregates_query(opts)
+## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_evaluations_aggregates_query(body)
Query for evaluation aggregates
@@ -1419,28 +1421,27 @@
config.access_token = @authToken
end
api_instance = PureCloud::QualityApi.new
-opts = {
- body: PureCloud::AggregationQuery.new # AggregationQuery | query
-}
+body = PureCloud::AggregationQuery.new # AggregationQuery | query
+
begin
#Query for evaluation aggregates
- result = api_instance.post_evaluations_aggregates_query(opts)
+ result = api_instance.post_evaluations_aggregates_query(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling QualityApi->post_evaluations_aggregates_query: #{e}"
end
~~~
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional]
+ **body** | [**AggregationQuery**](AggregationQuery.html)| query |
{: class="table table-striped"}
### Return type
@@ -1453,11 +1454,11 @@
<a name="post_evaluations_scoring"></a>
-## -[**EvaluationScoringSet**](EvaluationScoringSet.html) post_evaluations_scoring(opts)
+## -[**EvaluationScoringSet**](EvaluationScoringSet.html) post_evaluations_scoring(body)
Score evaluation
@@ -1476,28 +1477,27 @@
config.access_token = @authToken
end
api_instance = PureCloud::QualityApi.new
-opts = {
- body: PureCloud::EvaluationFormAndScoringSet.new # EvaluationFormAndScoringSet | evaluationAndScoringSet
-}
+body = PureCloud::EvaluationFormAndScoringSet.new # EvaluationFormAndScoringSet | evaluationAndScoringSet
+
begin
#Score evaluation
- result = api_instance.post_evaluations_scoring(opts)
+ result = api_instance.post_evaluations_scoring(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling QualityApi->post_evaluations_scoring: #{e}"
end
~~~
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **body** | [**EvaluationFormAndScoringSet**](EvaluationFormAndScoringSet.html)| evaluationAndScoringSet | [optional]
+ **body** | [**EvaluationFormAndScoringSet**](EvaluationFormAndScoringSet.html)| evaluationAndScoringSet |
{: class="table table-striped"}
### Return type
@@ -1510,11 +1510,11 @@
<a name="post_forms"></a>
-## -[**EvaluationForm**](EvaluationForm.html) post_forms(opts)
+## -[**EvaluationForm**](EvaluationForm.html) post_forms(body)
Create an evaluation form.
@@ -1533,28 +1533,27 @@
config.access_token = @authToken
end
api_instance = PureCloud::QualityApi.new
-opts = {
- body: PureCloud::EvaluationForm.new # EvaluationForm |
-}
+body = PureCloud::EvaluationForm.new # EvaluationForm | Evaluation form
+
begin
#Create an evaluation form.
- result = api_instance.post_forms(opts)
+ result = api_instance.post_forms(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling QualityApi->post_forms: #{e}"
end
~~~
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **body** | [**EvaluationForm**](EvaluationForm.html)| | [optional]
+ **body** | [**EvaluationForm**](EvaluationForm.html)| Evaluation form |
{: class="table table-striped"}
### Return type
@@ -1567,11 +1566,11 @@
<a name="post_keywordsets"></a>
-## -[**KeywordSet**](KeywordSet.html) post_keywordsets(opts)
+## -[**KeywordSet**](KeywordSet.html) post_keywordsets(body, opts)
Create a Keyword Set
@@ -1590,29 +1589,30 @@
config.access_token = @authToken
end
api_instance = PureCloud::QualityApi.new
+body = PureCloud::KeywordSet.new # KeywordSet | keywordSet
+
opts = {
- body: PureCloud::KeywordSet.new, # KeywordSet | keywordSet
expand: "expand_example" # String | queueId
}
begin
#Create a Keyword Set
- result = api_instance.post_keywordsets(opts)
+ result = api_instance.post_keywordsets(body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling QualityApi->post_keywordsets: #{e}"
end
~~~
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **body** | [**KeywordSet**](KeywordSet.html)| keywordSet | [optional]
+ **body** | [**KeywordSet**](KeywordSet.html)| keywordSet |
**expand** | **String**| queueId | [optional]
{: class="table table-striped"}
### Return type
@@ -1626,11 +1626,11 @@
<a name="post_publishedforms"></a>
-## -[**EvaluationForm**](EvaluationForm.html) post_publishedforms(opts)
+## -[**EvaluationForm**](EvaluationForm.html) post_publishedforms(body)
Publish an evaluation form.
@@ -1649,28 +1649,27 @@
config.access_token = @authToken
end
api_instance = PureCloud::QualityApi.new
-opts = {
- body: PureCloud::EvaluationForm.new # EvaluationForm |
-}
+body = PureCloud::EvaluationForm.new # EvaluationForm | Evaluation form
+
begin
#Publish an evaluation form.
- result = api_instance.post_publishedforms(opts)
+ result = api_instance.post_publishedforms(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling QualityApi->post_publishedforms: #{e}"
end
~~~
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **body** | [**EvaluationForm**](EvaluationForm.html)| | [optional]
+ **body** | [**EvaluationForm**](EvaluationForm.html)| Evaluation form |
{: class="table table-striped"}
### Return type
@@ -1683,11 +1682,11 @@
<a name="put_calibrations_calibration_id"></a>
-## -[**Calibration**](Calibration.html) put_calibrations_calibration_id(calibration_id, opts)
+## -[**Calibration**](Calibration.html) put_calibrations_calibration_id(calibration_id, body)
Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
@@ -1708,17 +1707,16 @@
api_instance = PureCloud::QualityApi.new
calibration_id = "calibration_id_example" # String | Calibration ID
-opts = {
- body: PureCloud::Calibration.new # Calibration | Calibration
-}
+body = PureCloud::Calibration.new # Calibration | Calibration
+
begin
#Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
- result = api_instance.put_calibrations_calibration_id(calibration_id, opts)
+ result = api_instance.put_calibrations_calibration_id(calibration_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling QualityApi->put_calibrations_calibration_id: #{e}"
end
~~~
@@ -1726,11 +1724,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**calibration_id** | **String**| Calibration ID |
- **body** | [**Calibration**](Calibration.html)| Calibration | [optional]
+ **body** | [**Calibration**](Calibration.html)| Calibration |
{: class="table table-striped"}
### Return type
@@ -1743,11 +1741,11 @@
<a name="put_conversations_conversation_id_evaluations_evaluation_id"></a>
-## -[**Evaluation**](Evaluation.html) put_conversations_conversation_id_evaluations_evaluation_id(conversation_id, evaluation_id, opts)
+## -[**Evaluation**](Evaluation.html) put_conversations_conversation_id_evaluations_evaluation_id(conversation_id, evaluation_id, body, opts)
Update an evaluation
@@ -1770,18 +1768,19 @@
conversation_id = "conversation_id_example" # String |
evaluation_id = "evaluation_id_example" # String |
+body = PureCloud::Evaluation.new # Evaluation | evaluation
+
opts = {
- body: PureCloud::Evaluation.new, # Evaluation | evaluation
expand: "expand_example" # String | evaluatorId
}
begin
#Update an evaluation
- result = api_instance.put_conversations_conversation_id_evaluations_evaluation_id(conversation_id, evaluation_id, opts)
+ result = api_instance.put_conversations_conversation_id_evaluations_evaluation_id(conversation_id, evaluation_id, body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling QualityApi->put_conversations_conversation_id_evaluations_evaluation_id: #{e}"
end
~~~
@@ -1790,11 +1789,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**conversation_id** | **String**| |
**evaluation_id** | **String**| |
- **body** | [**Evaluation**](Evaluation.html)| evaluation | [optional]
+ **body** | [**Evaluation**](Evaluation.html)| evaluation |
**expand** | **String**| evaluatorId | [optional]
{: class="table table-striped"}
### Return type
@@ -1808,11 +1807,11 @@
<a name="put_forms_form_id"></a>
-## -[**EvaluationForm**](EvaluationForm.html) put_forms_form_id(form_id, opts)
+## -[**EvaluationForm**](EvaluationForm.html) put_forms_form_id(form_id, body)
Update an evaluation form.
@@ -1833,17 +1832,16 @@
api_instance = PureCloud::QualityApi.new
form_id = "form_id_example" # String | Form ID
-opts = {
- body: PureCloud::EvaluationForm.new # EvaluationForm |
-}
+body = PureCloud::EvaluationForm.new # EvaluationForm | Evaluation form
+
begin
#Update an evaluation form.
- result = api_instance.put_forms_form_id(form_id, opts)
+ result = api_instance.put_forms_form_id(form_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling QualityApi->put_forms_form_id: #{e}"
end
~~~
@@ -1851,11 +1849,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**form_id** | **String**| Form ID |
- **body** | [**EvaluationForm**](EvaluationForm.html)| | [optional]
+ **body** | [**EvaluationForm**](EvaluationForm.html)| Evaluation form |
{: class="table table-striped"}
### Return type
@@ -1868,11 +1866,11 @@
<a name="put_keywordsets_keywordset_id"></a>
-## -[**KeywordSet**](KeywordSet.html) put_keywordsets_keywordset_id(keyword_set_id, opts)
+## -[**KeywordSet**](KeywordSet.html) put_keywordsets_keywordset_id(keyword_set_id, body)
Update a keywordSet to the specified keywordSet via PUT.
@@ -1893,17 +1891,16 @@
api_instance = PureCloud::QualityApi.new
keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID
-opts = {
- body: PureCloud::KeywordSet.new # KeywordSet | keywordSet
-}
+body = PureCloud::KeywordSet.new # KeywordSet | keywordSet
+
begin
#Update a keywordSet to the specified keywordSet via PUT.
- result = api_instance.put_keywordsets_keywordset_id(keyword_set_id, opts)
+ result = api_instance.put_keywordsets_keywordset_id(keyword_set_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling QualityApi->put_keywordsets_keywordset_id: #{e}"
end
~~~
@@ -1911,10 +1908,10 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**keyword_set_id** | **String**| KeywordSet ID |
- **body** | [**KeywordSet**](KeywordSet.html)| keywordSet | [optional]
+ **body** | [**KeywordSet**](KeywordSet.html)| keywordSet |
{: class="table table-striped"}
### Return type