doc_out/QualityApi.html.md in purecloud-0.38.1 vs doc_out/QualityApi.html.md in purecloud-0.39.1

- old
+ new

@@ -9,31 +9,37 @@ Method | HTTP request | 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.| |[**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.| {: class="table table-striped"} <a name="delete_calibrations_calibration_id"></a> ## -[**Calibration**](Calibration.html) delete_calibrations_calibration_id(calibration_id, calibrator_id) @@ -210,10 +216,121 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="delete_keywordsets"></a> + +## -String** delete_keywordsets(ids) + +Delete keyword sets + +Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param. + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::QualityApi.new + +ids = "ids_example" # String | A comma-delimited list of valid KeywordSet ids + + +begin + #Delete keyword sets + result = api_instance.delete_keywordsets(ids) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling QualityApi->delete_keywordsets: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ids** | **String**| A comma-delimited list of valid KeywordSet ids | +{: class="table table-striped"} + + +### Return type + +**String** + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="delete_keywordsets_keywordset_id"></a> + +## - delete_keywordsets_keywordset_id(keyword_set_id) + +Delete a keywordSet by id. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::QualityApi.new + +keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID + + +begin + #Delete a keywordSet by id. + api_instance.delete_keywordsets_keywordset_id(keyword_set_id) +rescue PureCloud::ApiError => e + puts "Exception when calling QualityApi->delete_keywordsets_keywordset_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **keyword_set_id** | **String**| KeywordSet ID | +{: class="table table-striped"} + + +### Return type + +nil (empty response body) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_agents_activity"></a> ## -[**AgentActivityEntityListing**](AgentActivityEntityListing.html) get_agents_activity(opts) Gets a list of Agent Activities @@ -914,10 +1031,135 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_keywordsets"></a> + +## -[**KeywordSetEntityListing**](KeywordSetEntityListing.html) get_keywordsets(opts) + +Get the list of keyword sets + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::QualityApi.new + +opts = { + page_size: 25, # Integer | The total page size requested + page_number: 1, # Integer | The page number requested + sort_by: "sort_by_example", # String | variable name requested to sort by + expand: ["expand_example"], # Array<String> | 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. +} + +begin + #Get the list of keyword sets + result = api_instance.get_keywordsets(opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling QualityApi->get_keywordsets: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page_size** | **Integer**| The total page size requested | [optional] [default to 25] + **page_number** | **Integer**| The page number requested | [optional] [default to 1] + **sort_by** | **String**| variable name requested to sort by | [optional] + **expand** | [**Array&lt;String&gt;**](String.html)| variable name requested by expand list | [optional] + **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] +{: class="table table-striped"} + + +### Return type + +[**KeywordSetEntityListing**](KeywordSetEntityListing.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_keywordsets_keywordset_id"></a> + +## -[**KeywordSet**](KeywordSet.html) get_keywordsets_keywordset_id(keyword_set_id) + +Get a keywordSet by id. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::QualityApi.new + +keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID + + +begin + #Get a keywordSet by id. + result = api_instance.get_keywordsets_keywordset_id(keyword_set_id) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling QualityApi->get_keywordsets_keywordset_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **keyword_set_id** | **String**| KeywordSet ID | +{: class="table table-striped"} + + +### Return type + +[**KeywordSet**](KeywordSet.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_publishedforms"></a> ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_publishedforms(opts) Get the published evaluation forms. @@ -1323,10 +1565,69 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="post_keywordsets"></a> + +## -[**KeywordSet**](KeywordSet.html) post_keywordsets(opts) + +Create a Keyword Set + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::QualityApi.new + +opts = { + body: PureCloud::KeywordSet.new, # KeywordSet | keywordSet + expand: "expand_example" # String | queueId +} + +begin + #Create a Keyword Set + result = api_instance.post_keywordsets(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] + **expand** | **String**| queueId | [optional] +{: class="table table-striped"} + + +### Return type + +[**KeywordSet**](KeywordSet.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="post_publishedforms"></a> ## -[**EvaluationForm**](EvaluationForm.html) post_publishedforms(opts) Publish an evaluation form. @@ -1557,9 +1858,69 @@ ### Return type [**EvaluationForm**](EvaluationForm.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="put_keywordsets_keywordset_id"></a> + +## -[**KeywordSet**](KeywordSet.html) put_keywordsets_keywordset_id(keyword_set_id, opts) + +Update a keywordSet to the specified keywordSet via PUT. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::QualityApi.new + +keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID + +opts = { + 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) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling QualityApi->put_keywordsets_keywordset_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **keyword_set_id** | **String**| KeywordSet ID | + **body** | [**KeywordSet**](KeywordSet.html)| keywordSet | [optional] +{: class="table table-striped"} + + +### Return type + +[**KeywordSet**](KeywordSet.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json