docs/QualityApi.md in purecloudplatformclientv2-34.0.0 vs docs/QualityApi.md in purecloudplatformclientv2-35.0.0

- old
+ new

@@ -62,17 +62,23 @@ <a name="delete_quality_calibration"></a> ## -[**Calibration**](Calibration.html) delete_quality_calibration(calibration_id, calibrator_id) + + Delete a calibration by id. Wraps DELETE /api/v2/quality/calibrations/{calibrationId} +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -124,17 +130,23 @@ <a name="delete_quality_conversation_evaluation"></a> ## -[**Evaluation**](Evaluation.html) delete_quality_conversation_evaluation(conversation_id, evaluation_id, opts) + + Delete an evaluation Wraps DELETE /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -190,17 +202,23 @@ <a name="delete_quality_form"></a> ## - delete_quality_form(form_id) +<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span> + Delete an evaluation form. Wraps DELETE /api/v2/quality/forms/{formId} +Requires ANY permissions: +* quality:evaluationForm:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -248,17 +266,23 @@ <a name="delete_quality_forms_evaluation"></a> ## - delete_quality_forms_evaluation(form_id) + + Delete an evaluation form. Wraps DELETE /api/v2/quality/forms/evaluations/{formId} +Requires ANY permissions: +* quality:evaluationForm:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -306,17 +330,23 @@ <a name="delete_quality_forms_survey"></a> ## - delete_quality_forms_survey(form_id) + + Delete a survey form. Wraps DELETE /api/v2/quality/forms/surveys/{formId} +Requires ANY permissions: +* quality:surveyForm:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -364,17 +394,23 @@ <a name="delete_quality_keywordset"></a> ## - delete_quality_keywordset(keyword_set_id) + + Delete a keywordSet by id. Wraps DELETE /api/v2/quality/keywordsets/{keywordSetId} +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -422,17 +458,23 @@ <a name="delete_quality_keywordsets"></a> ## - delete_quality_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. Wraps DELETE /api/v2/quality/keywordsets +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -480,17 +522,23 @@ <a name="get_quality_agents_activity"></a> ## -[**AgentActivityEntityListing**](AgentActivityEntityListing.html) get_quality_agents_activity(opts) + + Gets a list of Agent Activities Including the number of evaluations and average evaluation score Wraps GET /api/v2/quality/agents/activity +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -562,17 +610,23 @@ <a name="get_quality_calibration"></a> ## -[**Calibration**](Calibration.html) get_quality_calibration(calibration_id, opts) + + Get a calibration by id. Requires either calibrator id or conversation id Wraps GET /api/v2/quality/calibrations/{calibrationId} +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -627,17 +681,23 @@ <a name="get_quality_calibrations"></a> ## -[**CalibrationEntityListing**](CalibrationEntityListing.html) get_quality_calibrations(calibrator_id, opts) + + Get the list of calibrations Wraps GET /api/v2/quality/calibrations +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -706,17 +766,23 @@ <a name="get_quality_conversation_audits"></a> ## -[**QualityAuditPage**](QualityAuditPage.html) get_quality_conversation_audits(conversation_id, opts) + + Get audits for conversation or recording Wraps GET /api/v2/quality/conversations/{conversationId}/audits +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -783,17 +849,23 @@ <a name="get_quality_conversation_evaluation"></a> ## -[**Evaluation**](Evaluation.html) get_quality_conversation_evaluation(conversation_id, evaluation_id, opts) + + Get an evaluation Wraps GET /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -849,17 +921,23 @@ <a name="get_quality_evaluations_query"></a> ## -[**EvaluationEntityListing**](EvaluationEntityListing.html) get_quality_evaluations_query(opts) + + Queries Evaluations and returns a paged list Query params must include one of conversationId, evaluatorUserId, or agentUserId Wraps GET /api/v2/quality/evaluations/query +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -943,17 +1021,23 @@ <a name="get_quality_evaluators_activity"></a> ## -[**EvaluatorActivityEntityListing**](EvaluatorActivityEntityListing.html) get_quality_evaluators_activity(opts) + + Get an evaluator activity Wraps GET /api/v2/quality/evaluators/activity +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1023,17 +1107,23 @@ <a name="get_quality_form"></a> ## -[**EvaluationForm**](EvaluationForm.html) get_quality_form(form_id) +<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span> + Get an evaluation form Wraps GET /api/v2/quality/forms/{formId} +Requires ANY permissions: +* quality:evaluationForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1082,17 +1172,23 @@ <a name="get_quality_form_versions"></a> ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_form_versions(form_id, opts) +<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span> + Gets all the revisions for a specific evaluation. Wraps GET /api/v2/quality/forms/{formId}/versions +Requires ANY permissions: +* quality:evaluationForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1147,17 +1243,23 @@ <a name="get_quality_forms"></a> ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_forms(opts) +<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span> + Get the list of evaluation forms Wraps GET /api/v2/quality/forms +Requires ANY permissions: +* quality:evaluationForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1219,17 +1321,23 @@ <a name="get_quality_forms_evaluation"></a> ## -[**EvaluationForm**](EvaluationForm.html) get_quality_forms_evaluation(form_id) + + Get an evaluation form Wraps GET /api/v2/quality/forms/evaluations/{formId} +Requires ANY permissions: +* quality:evaluationForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1278,17 +1386,23 @@ <a name="get_quality_forms_evaluation_versions"></a> ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_forms_evaluation_versions(form_id, opts) + + Gets all the revisions for a specific evaluation. Wraps GET /api/v2/quality/forms/evaluations/{formId}/versions +Requires ANY permissions: +* quality:evaluationForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1343,17 +1457,23 @@ <a name="get_quality_forms_evaluations"></a> ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_forms_evaluations(opts) + + Get the list of evaluation forms Wraps GET /api/v2/quality/forms/evaluations +Requires ANY permissions: +* quality:evaluationForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1415,17 +1535,23 @@ <a name="get_quality_forms_survey"></a> ## -[**SurveyForm**](SurveyForm.html) get_quality_forms_survey(form_id) + + Get a survey form Wraps GET /api/v2/quality/forms/surveys/{formId} +Requires ANY permissions: +* quality:surveyForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1474,17 +1600,23 @@ <a name="get_quality_forms_survey_versions"></a> ## -[**SurveyFormEntityListing**](SurveyFormEntityListing.html) get_quality_forms_survey_versions(form_id, opts) + + Gets all the revisions for a specific survey. Wraps GET /api/v2/quality/forms/surveys/{formId}/versions +Requires ANY permissions: +* quality:surveyForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1539,17 +1671,23 @@ <a name="get_quality_forms_surveys"></a> ## -[**SurveyFormEntityListing**](SurveyFormEntityListing.html) get_quality_forms_surveys(opts) + + Get the list of survey forms Wraps GET /api/v2/quality/forms/surveys +Requires ANY permissions: +* quality:surveyForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1611,17 +1749,23 @@ <a name="get_quality_keywordset"></a> ## -[**KeywordSet**](KeywordSet.html) get_quality_keywordset(keyword_set_id) + + Get a keywordSet by id. Wraps GET /api/v2/quality/keywordsets/{keywordSetId} +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1670,17 +1814,23 @@ <a name="get_quality_keywordsets"></a> ## -[**KeywordSetEntityListing**](KeywordSetEntityListing.html) get_quality_keywordsets(opts) + + Get the list of keyword sets Wraps GET /api/v2/quality/keywordsets +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1748,17 +1898,23 @@ <a name="get_quality_publishedform"></a> ## -[**EvaluationForm**](EvaluationForm.html) get_quality_publishedform(form_id) +<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span> + Get the published evaluation forms. Wraps GET /api/v2/quality/publishedforms/{formId} +Requires ANY permissions: +* quality:evaluationForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1807,17 +1963,23 @@ <a name="get_quality_publishedforms"></a> ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_publishedforms(opts) +<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span> + Get the published evaluation forms. Wraps GET /api/v2/quality/publishedforms +Requires ANY permissions: +* quality:evaluationForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1871,17 +2033,23 @@ <a name="get_quality_publishedforms_evaluation"></a> ## -[**EvaluationForm**](EvaluationForm.html) get_quality_publishedforms_evaluation(form_id) + + Get the most recent published version of an evaluation form. Wraps GET /api/v2/quality/publishedforms/evaluations/{formId} +Requires ANY permissions: +* quality:evaluationForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1930,17 +2098,23 @@ <a name="get_quality_publishedforms_evaluations"></a> ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_publishedforms_evaluations(opts) + + Get the published evaluation forms. Wraps GET /api/v2/quality/publishedforms/evaluations +Requires ANY permissions: +* quality:evaluationForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1994,17 +2168,23 @@ <a name="get_quality_publishedforms_survey"></a> ## -[**SurveyForm**](SurveyForm.html) get_quality_publishedforms_survey(form_id) + + Get the most recent published version of a survey form. Wraps GET /api/v2/quality/publishedforms/surveys/{formId} +Requires ANY permissions: +* quality:surveyForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2053,17 +2233,23 @@ <a name="get_quality_publishedforms_surveys"></a> ## -[**SurveyFormEntityListing**](SurveyFormEntityListing.html) get_quality_publishedforms_surveys(opts) + + Get the published survey forms. Wraps GET /api/v2/quality/publishedforms/surveys +Requires ANY permissions: +* quality:surveyForm:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2117,17 +2303,23 @@ <a name="patch_quality_forms_survey"></a> ## -[**SurveyForm**](SurveyForm.html) patch_quality_forms_survey(form_id, body) + + Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form. Wraps PATCH /api/v2/quality/forms/surveys/{formId} +Requires ANY permissions: +* quality:surveyForm:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2179,17 +2371,23 @@ <a name="post_analytics_evaluations_aggregates_query"></a> ## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_evaluations_aggregates_query(body) + + Query for evaluation aggregates Wraps POST /api/v2/analytics/evaluations/aggregates/query +Requires ANY permissions: +* analytics:evaluationAggregate:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2238,17 +2436,23 @@ <a name="post_quality_calibrations"></a> ## -[**Calibration**](Calibration.html) post_quality_calibrations(body, opts) + + Create a calibration Wraps POST /api/v2/quality/calibrations +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2301,17 +2505,23 @@ <a name="post_quality_conversation_evaluations"></a> ## -[**Evaluation**](Evaluation.html) post_quality_conversation_evaluations(conversation_id, body, opts) + + Create an evaluation Wraps POST /api/v2/quality/conversations/{conversationId}/evaluations +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2367,17 +2577,23 @@ <a name="post_quality_evaluations_scoring"></a> ## -[**EvaluationScoringSet**](EvaluationScoringSet.html) post_quality_evaluations_scoring(body) + + Score evaluation Wraps POST /api/v2/quality/evaluations/scoring +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2426,17 +2642,23 @@ <a name="post_quality_forms"></a> ## -[**EvaluationForm**](EvaluationForm.html) post_quality_forms(body) +<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span> + Create an evaluation form. Wraps POST /api/v2/quality/forms +Requires ANY permissions: +* quality:evaluationForm:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2485,17 +2707,23 @@ <a name="post_quality_forms_evaluations"></a> ## -[**EvaluationForm**](EvaluationForm.html) post_quality_forms_evaluations(body) + + Create an evaluation form. Wraps POST /api/v2/quality/forms/evaluations +Requires ANY permissions: +* quality:evaluationForm:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2544,17 +2772,23 @@ <a name="post_quality_forms_surveys"></a> ## -[**SurveyForm**](SurveyForm.html) post_quality_forms_surveys(body) + + Create a survey form. Wraps POST /api/v2/quality/forms/surveys +Requires ANY permissions: +* quality:surveyForm:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2603,17 +2837,23 @@ <a name="post_quality_keywordsets"></a> ## -[**KeywordSet**](KeywordSet.html) post_quality_keywordsets(body, opts) + + Create a Keyword Set Wraps POST /api/v2/quality/keywordsets +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2666,17 +2906,23 @@ <a name="post_quality_publishedforms"></a> ## -[**EvaluationForm**](EvaluationForm.html) post_quality_publishedforms(body) +<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span> + Publish an evaluation form. Wraps POST /api/v2/quality/publishedforms +Requires ANY permissions: +* quality:evaluationForm:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2725,17 +2971,23 @@ <a name="post_quality_publishedforms_evaluations"></a> ## -[**EvaluationForm**](EvaluationForm.html) post_quality_publishedforms_evaluations(body) + + Publish an evaluation form. Wraps POST /api/v2/quality/publishedforms/evaluations +Requires ANY permissions: +* quality:evaluationForm:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2784,17 +3036,23 @@ <a name="post_quality_publishedforms_surveys"></a> ## -[**SurveyForm**](SurveyForm.html) post_quality_publishedforms_surveys(body) + + Publish a survey form. Wraps POST /api/v2/quality/publishedforms/surveys +Requires ANY permissions: +* quality:surveyForm:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2843,17 +3101,23 @@ <a name="post_quality_spotability"></a> ## -[**KeywordSet**](KeywordSet.html) post_quality_spotability(opts) + + Retrieve the spotability statistic Wraps POST /api/v2/quality/spotability +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2903,17 +3167,23 @@ <a name="put_quality_calibration"></a> ## -[**Calibration**](Calibration.html) put_quality_calibration(calibration_id, body) + + Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex Wraps PUT /api/v2/quality/calibrations/{calibrationId} +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2965,17 +3235,23 @@ <a name="put_quality_conversation_evaluation"></a> ## -[**Evaluation**](Evaluation.html) put_quality_conversation_evaluation(conversation_id, evaluation_id, body, opts) + + Update an evaluation Wraps PUT /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3034,17 +3310,23 @@ <a name="put_quality_form"></a> ## -[**EvaluationForm**](EvaluationForm.html) put_quality_form(form_id, body) +<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span> + Update an evaluation form. Wraps PUT /api/v2/quality/forms/{formId} +Requires ANY permissions: +* quality:evaluationForm:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3096,17 +3378,23 @@ <a name="put_quality_forms_evaluation"></a> ## -[**EvaluationForm**](EvaluationForm.html) put_quality_forms_evaluation(form_id, body) + + Update an evaluation form. Wraps PUT /api/v2/quality/forms/evaluations/{formId} +Requires ANY permissions: +* quality:evaluationForm:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3158,17 +3446,23 @@ <a name="put_quality_forms_survey"></a> ## -[**SurveyForm**](SurveyForm.html) put_quality_forms_survey(form_id, body) + + Update a survey form. Wraps PUT /api/v2/quality/forms/surveys/{formId} +Requires ANY permissions: +* quality:surveyForm:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3220,14 +3514,20 @@ <a name="put_quality_keywordset"></a> ## -[**KeywordSet**](KeywordSet.html) put_quality_keywordset(keyword_set_id, body) + + Update a keywordSet to the specified keywordSet via PUT. Wraps PUT /api/v2/quality/keywordsets/{keywordSetId} + +Requires NO permissions: + + ### Example ~~~ruby # load the gem