Package com.mypurecloud.sdk.v2.api

Class QualityApi

java.lang.Object

com.mypurecloud.sdk.v2.api.QualityApi

public class QualityApi
extends Object

Constructor Summary

Constructors

Constructor	Description
QualityApi()
QualityApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteAnalyticsEvaluationsAggregatesJob(DeleteAnalyticsEvaluationsAggregatesJobRequest request)	Delete/cancel an async request for evaluation aggregates
ApiResponse<Void>	deleteAnalyticsEvaluationsAggregatesJob(ApiRequest<Void> request)	Delete/cancel an async request for evaluation aggregates
void	deleteAnalyticsEvaluationsAggregatesJob(String jobId)	Delete/cancel an async request for evaluation aggregates
ApiResponse<Void>	deleteAnalyticsEvaluationsAggregatesJobWithHttpInfo(String jobId)	Delete/cancel an async request for evaluation aggregates
void	deleteAnalyticsSurveysAggregatesJob(DeleteAnalyticsSurveysAggregatesJobRequest request)	Delete/cancel an async request for survey aggregates
ApiResponse<Void>	deleteAnalyticsSurveysAggregatesJob(ApiRequest<Void> request)	Delete/cancel an async request for survey aggregates
void	deleteAnalyticsSurveysAggregatesJob(String jobId)	Delete/cancel an async request for survey aggregates
ApiResponse<Void>	deleteAnalyticsSurveysAggregatesJobWithHttpInfo(String jobId)	Delete/cancel an async request for survey aggregates
Calibration	deleteQualityCalibration(DeleteQualityCalibrationRequest request)	Delete a calibration by id.
ApiResponse<Calibration>	deleteQualityCalibration(ApiRequest<Void> request)	Delete a calibration by id.
Calibration	deleteQualityCalibration(String calibrationId, String calibratorId)	Delete a calibration by id.
ApiResponse<Calibration>	deleteQualityCalibrationWithHttpInfo(String calibrationId, String calibratorId)	Delete a calibration by id.
EvaluationResponse	deleteQualityConversationEvaluation(DeleteQualityConversationEvaluationRequest request)	Delete an evaluation
ApiResponse<EvaluationResponse>	deleteQualityConversationEvaluation(ApiRequest<Void> request)	Delete an evaluation
EvaluationResponse	deleteQualityConversationEvaluation(String conversationId, String evaluationId, String expand)	Delete an evaluation
ApiResponse<EvaluationResponse>	deleteQualityConversationEvaluationWithHttpInfo(String conversationId, String evaluationId, String expand)	Delete an evaluation
void	deleteQualityForm(DeleteQualityFormRequest request)	Deprecated.
ApiResponse<Void>	deleteQualityForm(ApiRequest<Void> request)	Deprecated.
void	deleteQualityForm(String formId)	Deprecated.
void	deleteQualityFormsEvaluation(DeleteQualityFormsEvaluationRequest request)	Delete an evaluation form.
ApiResponse<Void>	deleteQualityFormsEvaluation(ApiRequest<Void> request)	Delete an evaluation form.
void	deleteQualityFormsEvaluation(String formId)	Delete an evaluation form.
ApiResponse<Void>	deleteQualityFormsEvaluationWithHttpInfo(String formId)	Delete an evaluation form.
void	deleteQualityFormsSurvey(DeleteQualityFormsSurveyRequest request)	Delete a survey form.
ApiResponse<Void>	deleteQualityFormsSurvey(ApiRequest<Void> request)	Delete a survey form.
void	deleteQualityFormsSurvey(String formId)	Delete a survey form.
ApiResponse<Void>	deleteQualityFormsSurveyWithHttpInfo(String formId)	Delete a survey form.
ApiResponse<Void>	deleteQualityFormWithHttpInfo(String formId)	Deprecated.
void	deleteQualityProgramAgentscoringrule(DeleteQualityProgramAgentscoringruleRequest request)	Delete an Agent Scoring Rule
ApiResponse<Void>	deleteQualityProgramAgentscoringrule(ApiRequest<Void> request)	Delete an Agent Scoring Rule
void	deleteQualityProgramAgentscoringrule(String programId, String ruleId)	Delete an Agent Scoring Rule
ApiResponse<Void>	deleteQualityProgramAgentscoringruleWithHttpInfo(String programId, String ruleId)	Delete an Agent Scoring Rule
AsyncQueryStatus	getAnalyticsEvaluationsAggregatesJob(GetAnalyticsEvaluationsAggregatesJobRequest request)	Get status for async query for evaluation aggregates
ApiResponse<AsyncQueryStatus>	getAnalyticsEvaluationsAggregatesJob(ApiRequest<Void> request)	Get status for async query for evaluation aggregates
AsyncQueryStatus	getAnalyticsEvaluationsAggregatesJob(String jobId)	Get status for async query for evaluation aggregates
EvaluationAsyncAggregateQueryResponse	getAnalyticsEvaluationsAggregatesJobResults(GetAnalyticsEvaluationsAggregatesJobResultsRequest request)	Fetch a page of results for an async aggregates query
ApiResponse<EvaluationAsyncAggregateQueryResponse>	getAnalyticsEvaluationsAggregatesJobResults(ApiRequest<Void> request)	Fetch a page of results for an async aggregates query
EvaluationAsyncAggregateQueryResponse	getAnalyticsEvaluationsAggregatesJobResults(String jobId, String cursor)	Fetch a page of results for an async aggregates query
ApiResponse<EvaluationAsyncAggregateQueryResponse>	getAnalyticsEvaluationsAggregatesJobResultsWithHttpInfo(String jobId, String cursor)	Fetch a page of results for an async aggregates query
ApiResponse<AsyncQueryStatus>	getAnalyticsEvaluationsAggregatesJobWithHttpInfo(String jobId)	Get status for async query for evaluation aggregates
AsyncQueryStatus	getAnalyticsSurveysAggregatesJob(GetAnalyticsSurveysAggregatesJobRequest request)	Get status for async query for survey aggregates
ApiResponse<AsyncQueryStatus>	getAnalyticsSurveysAggregatesJob(ApiRequest<Void> request)	Get status for async query for survey aggregates
AsyncQueryStatus	getAnalyticsSurveysAggregatesJob(String jobId)	Get status for async query for survey aggregates
SurveyAsyncAggregateQueryResponse	getAnalyticsSurveysAggregatesJobResults(GetAnalyticsSurveysAggregatesJobResultsRequest request)	Fetch a page of results for an async aggregates query
ApiResponse<SurveyAsyncAggregateQueryResponse>	getAnalyticsSurveysAggregatesJobResults(ApiRequest<Void> request)	Fetch a page of results for an async aggregates query
SurveyAsyncAggregateQueryResponse	getAnalyticsSurveysAggregatesJobResults(String jobId, String cursor)	Fetch a page of results for an async aggregates query
ApiResponse<SurveyAsyncAggregateQueryResponse>	getAnalyticsSurveysAggregatesJobResultsWithHttpInfo(String jobId, String cursor)	Fetch a page of results for an async aggregates query
ApiResponse<AsyncQueryStatus>	getAnalyticsSurveysAggregatesJobWithHttpInfo(String jobId)	Get status for async query for survey aggregates
AgentActivityEntityListing	getQualityAgentsActivity(GetQualityAgentsActivityRequest request)	Gets a list of Agent Activities Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent.
ApiResponse<AgentActivityEntityListing>	getQualityAgentsActivity(ApiRequest<Void> request)	Gets a list of Agent Activities Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent.
AgentActivityEntityListing	getQualityAgentsActivity(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Date startTime, Date endTime, List<String> agentUserId, String evaluatorUserId, String name, String group, String agentTeamId, String formContextId, String userState)	Gets a list of Agent Activities Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent.
ApiResponse<AgentActivityEntityListing>	getQualityAgentsActivityWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Date startTime, Date endTime, List<String> agentUserId, String evaluatorUserId, String name, String group, String agentTeamId, String formContextId, String userState)	Gets a list of Agent Activities Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent.
Calibration	getQualityCalibration(GetQualityCalibrationRequest request)	Get a calibration by id.
ApiResponse<Calibration>	getQualityCalibration(ApiRequest<Void> request)	Get a calibration by id.
Calibration	getQualityCalibration(String calibrationId, String calibratorId, String conversationId)	Get a calibration by id.
CalibrationEntityListing	getQualityCalibrations(GetQualityCalibrationsRequest request)	Get the list of calibrations NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.
ApiResponse<CalibrationEntityListing>	getQualityCalibrations(ApiRequest<Void> request)	Get the list of calibrations NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.
CalibrationEntityListing	getQualityCalibrations(String calibratorId, Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String conversationId, Date startTime, Date endTime)	Get the list of calibrations NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.
ApiResponse<CalibrationEntityListing>	getQualityCalibrationsWithHttpInfo(String calibratorId, Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String conversationId, Date startTime, Date endTime)	Get the list of calibrations NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.
ApiResponse<Calibration>	getQualityCalibrationWithHttpInfo(String calibrationId, String calibratorId, String conversationId)	Get a calibration by id.
EvaluationResponse	getQualityConversationEvaluation(GetQualityConversationEvaluationRequest request)	Get an evaluation
ApiResponse<EvaluationResponse>	getQualityConversationEvaluation(ApiRequest<Void> request)	Get an evaluation
EvaluationResponse	getQualityConversationEvaluation(String conversationId, String evaluationId, String expand)	Get an evaluation
ApiResponse<EvaluationResponse>	getQualityConversationEvaluationWithHttpInfo(String conversationId, String evaluationId, String expand)	Get an evaluation
QualityAuditQueryExecutionStatusResponse	getQualityConversationsAuditsQueryTransactionId(GetQualityConversationsAuditsQueryTransactionIdRequest request)	Get status of audit query execution
ApiResponse<QualityAuditQueryExecutionStatusResponse>	getQualityConversationsAuditsQueryTransactionId(ApiRequest<Void> request)	Get status of audit query execution
QualityAuditQueryExecutionStatusResponse	getQualityConversationsAuditsQueryTransactionId(String transactionId)	Get status of audit query execution
QualityAuditQueryExecutionResultsResponse	getQualityConversationsAuditsQueryTransactionIdResults(GetQualityConversationsAuditsQueryTransactionIdResultsRequest request)	Get results of audit query
ApiResponse<QualityAuditQueryExecutionResultsResponse>	getQualityConversationsAuditsQueryTransactionIdResults(ApiRequest<Void> request)	Get results of audit query
QualityAuditQueryExecutionResultsResponse	getQualityConversationsAuditsQueryTransactionIdResults(String transactionId, String cursor, Integer pageSize, List<String> expand)	Get results of audit query
ApiResponse<QualityAuditQueryExecutionResultsResponse>	getQualityConversationsAuditsQueryTransactionIdResultsWithHttpInfo(String transactionId, String cursor, Integer pageSize, List<String> expand)	Get results of audit query
ApiResponse<QualityAuditQueryExecutionStatusResponse>	getQualityConversationsAuditsQueryTransactionIdWithHttpInfo(String transactionId)	Get status of audit query execution
List<Survey>	getQualityConversationSurveys(GetQualityConversationSurveysRequest request)	Get the surveys for a conversation
ApiResponse<List<Survey>>	getQualityConversationSurveys(ApiRequest<Void> request)	Get the surveys for a conversation
List<Survey>	getQualityConversationSurveys(String conversationId)	Get the surveys for a conversation
ApiResponse<List<Survey>>	getQualityConversationSurveysWithHttpInfo(String conversationId)	Get the surveys for a conversation
EvaluationEntityListing	getQualityEvaluationsQuery(GetQualityEvaluationsQueryRequest request)	Queries Evaluations and returns a paged list Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId.
ApiResponse<EvaluationEntityListing>	getQualityEvaluationsQuery(ApiRequest<Void> request)	Queries Evaluations and returns a paged list Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId.
EvaluationEntityListing	getQualityEvaluationsQuery(Integer pageSize, Integer pageNumber, List<String> expand, String previousPage, String conversationId, String agentUserId, String agentTeamId, String evaluatorUserId, String assigneeUserId, String queueId, String startTime, String endTime, String formContextId, List<String> evaluationState, Boolean isReleased, Boolean agentHasRead, Boolean expandAnswerTotalScores, Integer maximum, String sortOrder, Boolean includeDeletedUsers)	Queries Evaluations and returns a paged list Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId.
ApiResponse<EvaluationEntityListing>	getQualityEvaluationsQueryWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> expand, String previousPage, String conversationId, String agentUserId, String agentTeamId, String evaluatorUserId, String assigneeUserId, String queueId, String startTime, String endTime, String formContextId, List<String> evaluationState, Boolean isReleased, Boolean agentHasRead, Boolean expandAnswerTotalScores, Integer maximum, String sortOrder, Boolean includeDeletedUsers)	Queries Evaluations and returns a paged list Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId.
EvaluatorActivityEntityListing	getQualityEvaluatorsActivity(GetQualityEvaluatorsActivityRequest request)	Get an evaluator activity.
ApiResponse<EvaluatorActivityEntityListing>	getQualityEvaluatorsActivity(ApiRequest<Void> request)	Get an evaluator activity.
EvaluatorActivityEntityListing	getQualityEvaluatorsActivity(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Date startTime, Date endTime, String name, List<String> permission, String group, String agentTeamId)	Get an evaluator activity.
ApiResponse<EvaluatorActivityEntityListing>	getQualityEvaluatorsActivityWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Date startTime, Date endTime, String name, List<String> permission, String group, String agentTeamId)	Get an evaluator activity.
EvaluationFormResponse	getQualityForm(GetQualityFormRequest request)	Deprecated.
ApiResponse<EvaluationFormResponse>	getQualityForm(ApiRequest<Void> request)	Deprecated.
EvaluationFormResponse	getQualityForm(String formId)	Deprecated.
EvaluationFormResponseEntityListing	getQualityForms(GetQualityFormsRequest request)	Deprecated.
ApiResponse<EvaluationFormResponseEntityListing>	getQualityForms(ApiRequest<Void> request)	Deprecated.
EvaluationFormResponseEntityListing	getQualityForms(Integer pageSize, Integer pageNumber, String sortBy, String nextPage, String previousPage, String expand, String name, String sortOrder)	Deprecated.
EvaluationFormResponse	getQualityFormsEvaluation(GetQualityFormsEvaluationRequest request)	Get an evaluation form
ApiResponse<EvaluationFormResponse>	getQualityFormsEvaluation(ApiRequest<Void> request)	Get an evaluation form
EvaluationFormResponse	getQualityFormsEvaluation(String formId)	Get an evaluation form
EvaluationFormResponseEntityListing	getQualityFormsEvaluations(GetQualityFormsEvaluationsRequest request)	Get the list of evaluation forms By default, \"published\" field is always returned as false for all evaluation forms.
ApiResponse<EvaluationFormResponseEntityListing>	getQualityFormsEvaluations(ApiRequest<Void> request)	Get the list of evaluation forms By default, \"published\" field is always returned as false for all evaluation forms.
EvaluationFormResponseEntityListing	getQualityFormsEvaluations(Integer pageSize, Integer pageNumber, String sortBy, String nextPage, String previousPage, String expand, String name, String sortOrder)	Get the list of evaluation forms By default, \"published\" field is always returned as false for all evaluation forms.
EvaluationFormResponseEntityListing	getQualityFormsEvaluationsBulk(GetQualityFormsEvaluationsBulkRequest request)	Retrieve a list of evaluation forms by their ids
ApiResponse<EvaluationFormResponseEntityListing>	getQualityFormsEvaluationsBulk(ApiRequest<Void> request)	Retrieve a list of evaluation forms by their ids
EvaluationFormResponseEntityListing	getQualityFormsEvaluationsBulk(List<String> id, Boolean includeLatestVersionFormName)	Retrieve a list of evaluation forms by their ids
List<EvaluationFormResponse>	getQualityFormsEvaluationsBulkContexts(GetQualityFormsEvaluationsBulkContextsRequest request)	Retrieve a list of the latest published evaluation form versions by context ids
ApiResponse<List<EvaluationFormResponse>>	getQualityFormsEvaluationsBulkContexts(ApiRequest<Void> request)	Retrieve a list of the latest published evaluation form versions by context ids
List<EvaluationFormResponse>	getQualityFormsEvaluationsBulkContexts(List<String> contextId)	Retrieve a list of the latest published evaluation form versions by context ids
ApiResponse<List<EvaluationFormResponse>>	getQualityFormsEvaluationsBulkContextsWithHttpInfo(List<String> contextId)	Retrieve a list of the latest published evaluation form versions by context ids
ApiResponse<EvaluationFormResponseEntityListing>	getQualityFormsEvaluationsBulkWithHttpInfo(List<String> id, Boolean includeLatestVersionFormName)	Retrieve a list of evaluation forms by their ids
ApiResponse<EvaluationFormResponseEntityListing>	getQualityFormsEvaluationsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String nextPage, String previousPage, String expand, String name, String sortOrder)	Get the list of evaluation forms By default, \"published\" field is always returned as false for all evaluation forms.
EvaluationFormResponseEntityListing	getQualityFormsEvaluationVersions(GetQualityFormsEvaluationVersionsRequest request)	Gets all the revisions for a specific evaluation.
ApiResponse<EvaluationFormResponseEntityListing>	getQualityFormsEvaluationVersions(ApiRequest<Void> request)	Gets all the revisions for a specific evaluation.
EvaluationFormResponseEntityListing	getQualityFormsEvaluationVersions(String formId, Integer pageSize, Integer pageNumber, String sortOrder)	Gets all the revisions for a specific evaluation.
ApiResponse<EvaluationFormResponseEntityListing>	getQualityFormsEvaluationVersionsWithHttpInfo(String formId, Integer pageSize, Integer pageNumber, String sortOrder)	Gets all the revisions for a specific evaluation.
ApiResponse<EvaluationFormResponse>	getQualityFormsEvaluationWithHttpInfo(String formId)	Get an evaluation form
SurveyForm	getQualityFormsSurvey(GetQualityFormsSurveyRequest request)	Get a survey form
ApiResponse<SurveyForm>	getQualityFormsSurvey(ApiRequest<Void> request)	Get a survey form
SurveyForm	getQualityFormsSurvey(String formId)	Get a survey form
SurveyFormEntityListing	getQualityFormsSurveys(GetQualityFormsSurveysRequest request)	Get the list of survey forms.
ApiResponse<SurveyFormEntityListing>	getQualityFormsSurveys(ApiRequest<Void> request)	Get the list of survey forms.
SurveyFormEntityListing	getQualityFormsSurveys(Integer pageSize, Integer pageNumber, String sortBy, String nextPage, String previousPage, String expand, String name, String sortOrder)	Get the list of survey forms.
SurveyFormEntityListing	getQualityFormsSurveysBulk(GetQualityFormsSurveysBulkRequest request)	Retrieve a list of survey forms by their ids
ApiResponse<SurveyFormEntityListing>	getQualityFormsSurveysBulk(ApiRequest<Void> request)	Retrieve a list of survey forms by their ids
SurveyFormEntityListing	getQualityFormsSurveysBulk(List<String> id)	Retrieve a list of survey forms by their ids
List<SurveyForm>	getQualityFormsSurveysBulkContexts(GetQualityFormsSurveysBulkContextsRequest request)	Retrieve a list of the latest form versions by context ids
ApiResponse<List<SurveyForm>>	getQualityFormsSurveysBulkContexts(ApiRequest<Void> request)	Retrieve a list of the latest form versions by context ids
List<SurveyForm>	getQualityFormsSurveysBulkContexts(List<String> contextId, Boolean published)	Retrieve a list of the latest form versions by context ids
ApiResponse<List<SurveyForm>>	getQualityFormsSurveysBulkContextsWithHttpInfo(List<String> contextId, Boolean published)	Retrieve a list of the latest form versions by context ids
ApiResponse<SurveyFormEntityListing>	getQualityFormsSurveysBulkWithHttpInfo(List<String> id)	Retrieve a list of survey forms by their ids
ApiResponse<SurveyFormEntityListing>	getQualityFormsSurveysWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String nextPage, String previousPage, String expand, String name, String sortOrder)	Get the list of survey forms.
SurveyFormEntityListing	getQualityFormsSurveyVersions(GetQualityFormsSurveyVersionsRequest request)	Gets all the revisions for a specific survey.
ApiResponse<SurveyFormEntityListing>	getQualityFormsSurveyVersions(ApiRequest<Void> request)	Gets all the revisions for a specific survey.
SurveyFormEntityListing	getQualityFormsSurveyVersions(String formId, Integer pageSize, Integer pageNumber)	Gets all the revisions for a specific survey.
ApiResponse<SurveyFormEntityListing>	getQualityFormsSurveyVersionsWithHttpInfo(String formId, Integer pageSize, Integer pageNumber)	Gets all the revisions for a specific survey.
ApiResponse<SurveyForm>	getQualityFormsSurveyWithHttpInfo(String formId)	Get a survey form
ApiResponse<EvaluationFormResponseEntityListing>	getQualityFormsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String nextPage, String previousPage, String expand, String name, String sortOrder)	Deprecated.
EvaluationFormResponseEntityListing	getQualityFormVersions(GetQualityFormVersionsRequest request)	Deprecated.
ApiResponse<EvaluationFormResponseEntityListing>	getQualityFormVersions(ApiRequest<Void> request)	Deprecated.
EvaluationFormResponseEntityListing	getQualityFormVersions(String formId, Integer pageSize, Integer pageNumber, String sortOrder)	Deprecated.
ApiResponse<EvaluationFormResponseEntityListing>	getQualityFormVersionsWithHttpInfo(String formId, Integer pageSize, Integer pageNumber, String sortOrder)	Deprecated.
ApiResponse<EvaluationFormResponse>	getQualityFormWithHttpInfo(String formId)	Deprecated.
AgentScoringRule	getQualityProgramAgentscoringrule(GetQualityProgramAgentscoringruleRequest request)	Get an Agent Scoring Rule
ApiResponse<AgentScoringRule>	getQualityProgramAgentscoringrule(ApiRequest<Void> request)	Get an Agent Scoring Rule
AgentScoringRule	getQualityProgramAgentscoringrule(String programId, String ruleId)	Get an Agent Scoring Rule
AgentScoringRuleEntityListing	getQualityProgramAgentscoringrules(GetQualityProgramAgentscoringrulesRequest request)	Get Agent Scoring Rules for a program
ApiResponse<AgentScoringRuleEntityListing>	getQualityProgramAgentscoringrules(ApiRequest<Void> request)	Get Agent Scoring Rules for a program
AgentScoringRuleEntityListing	getQualityProgramAgentscoringrules(String programId)	Get Agent Scoring Rules for a program
ApiResponse<AgentScoringRuleEntityListing>	getQualityProgramAgentscoringrulesWithHttpInfo(String programId)	Get Agent Scoring Rules for a program
ApiResponse<AgentScoringRule>	getQualityProgramAgentscoringruleWithHttpInfo(String programId, String ruleId)	Get an Agent Scoring Rule
EvaluationFormResponse	getQualityPublishedform(GetQualityPublishedformRequest request)	Deprecated.
ApiResponse<EvaluationFormResponse>	getQualityPublishedform(ApiRequest<Void> request)	Deprecated.
EvaluationFormResponse	getQualityPublishedform(String formId)	Deprecated.
EvaluationFormResponseEntityListing	getQualityPublishedforms(GetQualityPublishedformsRequest request)	Deprecated.
ApiResponse<EvaluationFormResponseEntityListing>	getQualityPublishedforms(ApiRequest<Void> request)	Deprecated.
EvaluationFormResponseEntityListing	getQualityPublishedforms(Integer pageSize, Integer pageNumber, String name, Boolean onlyLatestPerContext)	Deprecated.
EvaluationFormResponse	getQualityPublishedformsEvaluation(GetQualityPublishedformsEvaluationRequest request)	Get the most recent published version of an evaluation form.
ApiResponse<EvaluationFormResponse>	getQualityPublishedformsEvaluation(ApiRequest<Void> request)	Get the most recent published version of an evaluation form.
EvaluationFormResponse	getQualityPublishedformsEvaluation(String formId)	Get the most recent published version of an evaluation form.
EvaluationFormResponseEntityListing	getQualityPublishedformsEvaluations(GetQualityPublishedformsEvaluationsRequest request)	Get the published evaluation forms.
ApiResponse<EvaluationFormResponseEntityListing>	getQualityPublishedformsEvaluations(ApiRequest<Void> request)	Get the published evaluation forms.
EvaluationFormResponseEntityListing	getQualityPublishedformsEvaluations(Integer pageSize, Integer pageNumber, String name, Boolean onlyLatestPerContext)	Get the published evaluation forms.
ApiResponse<EvaluationFormResponseEntityListing>	getQualityPublishedformsEvaluationsWithHttpInfo(Integer pageSize, Integer pageNumber, String name, Boolean onlyLatestPerContext)	Get the published evaluation forms.
ApiResponse<EvaluationFormResponse>	getQualityPublishedformsEvaluationWithHttpInfo(String formId)	Get the most recent published version of an evaluation form.
SurveyForm	getQualityPublishedformsSurvey(GetQualityPublishedformsSurveyRequest request)	Get the most recent published version of a survey form.
ApiResponse<SurveyForm>	getQualityPublishedformsSurvey(ApiRequest<Void> request)	Get the most recent published version of a survey form.
SurveyForm	getQualityPublishedformsSurvey(String formId)	Get the most recent published version of a survey form.
SurveyFormEntityListing	getQualityPublishedformsSurveys(GetQualityPublishedformsSurveysRequest request)	Get the published survey forms.
ApiResponse<SurveyFormEntityListing>	getQualityPublishedformsSurveys(ApiRequest<Void> request)	Get the published survey forms.
SurveyFormEntityListing	getQualityPublishedformsSurveys(Integer pageSize, Integer pageNumber, String name, Boolean onlyLatestEnabledPerContext)	Get the published survey forms.
ApiResponse<SurveyFormEntityListing>	getQualityPublishedformsSurveysWithHttpInfo(Integer pageSize, Integer pageNumber, String name, Boolean onlyLatestEnabledPerContext)	Get the published survey forms.
ApiResponse<SurveyForm>	getQualityPublishedformsSurveyWithHttpInfo(String formId)	Get the most recent published version of a survey form.
ApiResponse<EvaluationFormResponseEntityListing>	getQualityPublishedformsWithHttpInfo(Integer pageSize, Integer pageNumber, String name, Boolean onlyLatestPerContext)	Deprecated.
ApiResponse<EvaluationFormResponse>	getQualityPublishedformWithHttpInfo(String formId)	Deprecated.
Survey	getQualitySurvey(GetQualitySurveyRequest request)	Get a survey for a conversation
ApiResponse<Survey>	getQualitySurvey(ApiRequest<Void> request)	Get a survey for a conversation
Survey	getQualitySurvey(String surveyId)	Get a survey for a conversation
ScorableSurvey	getQualitySurveysScorable(GetQualitySurveysScorableRequest request)	Get a survey as an end-customer, for the purposes of scoring it.
ApiResponse<ScorableSurvey>	getQualitySurveysScorable(ApiRequest<Void> request)	Get a survey as an end-customer, for the purposes of scoring it.
ScorableSurvey	getQualitySurveysScorable(String customerSurveyUrl)	Get a survey as an end-customer, for the purposes of scoring it.
ApiResponse<ScorableSurvey>	getQualitySurveysScorableWithHttpInfo(String customerSurveyUrl)	Get a survey as an end-customer, for the purposes of scoring it.
ApiResponse<Survey>	getQualitySurveyWithHttpInfo(String surveyId)	Get a survey for a conversation
SurveyForm	patchQualityFormsSurvey(PatchQualityFormsSurveyRequest request)	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.
ApiResponse<SurveyForm>	patchQualityFormsSurvey(ApiRequest<SurveyForm> request)	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.
SurveyForm	patchQualityFormsSurvey(String formId, SurveyForm 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.
ApiResponse<SurveyForm>	patchQualityFormsSurveyWithHttpInfo(String formId, SurveyForm 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.
AsyncQueryResponse	postAnalyticsEvaluationsAggregatesJobs(PostAnalyticsEvaluationsAggregatesJobsRequest request)	Query for evaluation aggregates asynchronously
ApiResponse<AsyncQueryResponse>	postAnalyticsEvaluationsAggregatesJobs(ApiRequest<EvaluationAsyncAggregationQuery> request)	Query for evaluation aggregates asynchronously
AsyncQueryResponse	postAnalyticsEvaluationsAggregatesJobs(EvaluationAsyncAggregationQuery body)	Query for evaluation aggregates asynchronously
ApiResponse<AsyncQueryResponse>	postAnalyticsEvaluationsAggregatesJobsWithHttpInfo(EvaluationAsyncAggregationQuery body)	Query for evaluation aggregates asynchronously
EvaluationAggregateQueryResponse	postAnalyticsEvaluationsAggregatesQuery(PostAnalyticsEvaluationsAggregatesQueryRequest request)	Query for evaluation aggregates
ApiResponse<EvaluationAggregateQueryResponse>	postAnalyticsEvaluationsAggregatesQuery(ApiRequest<EvaluationAggregationQuery> request)	Query for evaluation aggregates
EvaluationAggregateQueryResponse	postAnalyticsEvaluationsAggregatesQuery(EvaluationAggregationQuery body)	Query for evaluation aggregates
ApiResponse<EvaluationAggregateQueryResponse>	postAnalyticsEvaluationsAggregatesQueryWithHttpInfo(EvaluationAggregationQuery body)	Query for evaluation aggregates
AsyncQueryResponse	postAnalyticsSurveysAggregatesJobs(PostAnalyticsSurveysAggregatesJobsRequest request)	Query for survey aggregates asynchronously
ApiResponse<AsyncQueryResponse>	postAnalyticsSurveysAggregatesJobs(ApiRequest<SurveyAsyncAggregationQuery> request)	Query for survey aggregates asynchronously
AsyncQueryResponse	postAnalyticsSurveysAggregatesJobs(SurveyAsyncAggregationQuery body)	Query for survey aggregates asynchronously
ApiResponse<AsyncQueryResponse>	postAnalyticsSurveysAggregatesJobsWithHttpInfo(SurveyAsyncAggregationQuery body)	Query for survey aggregates asynchronously
SurveyAggregateQueryResponse	postAnalyticsSurveysAggregatesQuery(PostAnalyticsSurveysAggregatesQueryRequest request)	Query for survey aggregates
ApiResponse<SurveyAggregateQueryResponse>	postAnalyticsSurveysAggregatesQuery(ApiRequest<SurveyAggregationQuery> request)	Query for survey aggregates
SurveyAggregateQueryResponse	postAnalyticsSurveysAggregatesQuery(SurveyAggregationQuery body)	Query for survey aggregates
ApiResponse<SurveyAggregateQueryResponse>	postAnalyticsSurveysAggregatesQueryWithHttpInfo(SurveyAggregationQuery body)	Query for survey aggregates
Calibration	postQualityCalibrations(PostQualityCalibrationsRequest request)	Create a calibration
ApiResponse<Calibration>	postQualityCalibrations(ApiRequest<CalibrationCreate> request)	Create a calibration
Calibration	postQualityCalibrations(CalibrationCreate body, String expand)	Create a calibration
ApiResponse<Calibration>	postQualityCalibrationsWithHttpInfo(CalibrationCreate body, String expand)	Create a calibration
Evaluation	postQualityConversationEvaluations(PostQualityConversationEvaluationsRequest request)	Create an evaluation
ApiResponse<Evaluation>	postQualityConversationEvaluations(ApiRequest<EvaluationCreateBody> request)	Create an evaluation
Evaluation	postQualityConversationEvaluations(String conversationId, EvaluationCreateBody body, String idempotencyKey, String expand)	Create an evaluation
ApiResponse<Evaluation>	postQualityConversationEvaluationsWithHttpInfo(String conversationId, EvaluationCreateBody body, String idempotencyKey, String expand)	Create an evaluation
QualityAuditQueryExecutionStatusResponse	postQualityConversationsAuditsQuery(PostQualityConversationsAuditsQueryRequest request)	Create audit query execution
ApiResponse<QualityAuditQueryExecutionStatusResponse>	postQualityConversationsAuditsQuery(ApiRequest<QMAuditQueryRequest> request)	Create audit query execution
QualityAuditQueryExecutionStatusResponse	postQualityConversationsAuditsQuery(QMAuditQueryRequest body)	Create audit query execution
ApiResponse<QualityAuditQueryExecutionStatusResponse>	postQualityConversationsAuditsQueryWithHttpInfo(QMAuditQueryRequest body)	Create audit query execution
EvaluationAggregateQueryResponse	postQualityEvaluationsAggregatesQueryMe(PostQualityEvaluationsAggregatesQueryMeRequest request)	Query for evaluation aggregates for the current user
ApiResponse<EvaluationAggregateQueryResponse>	postQualityEvaluationsAggregatesQueryMe(ApiRequest<EvaluationAggregationQueryMe> request)	Query for evaluation aggregates for the current user
EvaluationAggregateQueryResponse	postQualityEvaluationsAggregatesQueryMe(EvaluationAggregationQueryMe body)	Query for evaluation aggregates for the current user
ApiResponse<EvaluationAggregateQueryResponse>	postQualityEvaluationsAggregatesQueryMeWithHttpInfo(EvaluationAggregationQueryMe body)	Query for evaluation aggregates for the current user
EvaluationScoringSet	postQualityEvaluationsScoring(PostQualityEvaluationsScoringRequest request)	Score evaluation
ApiResponse<EvaluationScoringSet>	postQualityEvaluationsScoring(ApiRequest<EvaluationFormAndScoringSet> request)	Score evaluation
EvaluationScoringSet	postQualityEvaluationsScoring(EvaluationFormAndScoringSet body)	Score evaluation
ApiResponse<EvaluationScoringSet>	postQualityEvaluationsScoringWithHttpInfo(EvaluationFormAndScoringSet body)	Score evaluation
EvaluationSearchResponse	postQualityEvaluationsSearch(PostQualityEvaluationsSearchRequest request)	Search evaluations based along specified criteria Search Rules: 1.
ApiResponse<EvaluationSearchResponse>	postQualityEvaluationsSearch(ApiRequest<EvaluationSearchRequestDTO> request)	Search evaluations based along specified criteria Search Rules: 1.
EvaluationSearchResponse	postQualityEvaluationsSearch(EvaluationSearchRequestDTO body)	Search evaluations based along specified criteria Search Rules: 1.
ApiResponse<EvaluationSearchResponse>	postQualityEvaluationsSearchWithHttpInfo(EvaluationSearchRequestDTO body)	Search evaluations based along specified criteria Search Rules: 1.
EvaluationFormResponse	postQualityForms(PostQualityFormsRequest request)	Deprecated.
ApiResponse<EvaluationFormResponse>	postQualityForms(ApiRequest<EvaluationForm> request)	Deprecated.
EvaluationFormResponse	postQualityForms(EvaluationForm body)	Deprecated.
EvaluationFormResponse	postQualityFormsEvaluations(PostQualityFormsEvaluationsRequest request)	Create an evaluation form.
ApiResponse<EvaluationFormResponse>	postQualityFormsEvaluations(ApiRequest<EvaluationForm> request)	Create an evaluation form.
EvaluationFormResponse	postQualityFormsEvaluations(EvaluationForm body)	Create an evaluation form.
ApiResponse<EvaluationFormResponse>	postQualityFormsEvaluationsWithHttpInfo(EvaluationForm body)	Create an evaluation form.
SurveyForm	postQualityFormsSurveys(PostQualityFormsSurveysRequest request)	Create a survey form.
ApiResponse<SurveyForm>	postQualityFormsSurveys(ApiRequest<SurveyForm> request)	Create a survey form.
SurveyForm	postQualityFormsSurveys(SurveyForm body)	Create a survey form.
ApiResponse<SurveyForm>	postQualityFormsSurveysWithHttpInfo(SurveyForm body)	Create a survey form.
ApiResponse<EvaluationFormResponse>	postQualityFormsWithHttpInfo(EvaluationForm body)	Deprecated.
AgentScoringRule	postQualityProgramAgentscoringrules(PostQualityProgramAgentscoringrulesRequest request)	Create an Agent Scoring Rule Creates a new Agent Scoring Rule for AI-powered automated evaluation of agent interactions.
ApiResponse<AgentScoringRule>	postQualityProgramAgentscoringrules(ApiRequest<AgentScoringRule> request)	Create an Agent Scoring Rule Creates a new Agent Scoring Rule for AI-powered automated evaluation of agent interactions.
AgentScoringRule	postQualityProgramAgentscoringrules(String programId, AgentScoringRule body)	Create an Agent Scoring Rule Creates a new Agent Scoring Rule for AI-powered automated evaluation of agent interactions.
ApiResponse<AgentScoringRule>	postQualityProgramAgentscoringrulesWithHttpInfo(String programId, AgentScoringRule body)	Create an Agent Scoring Rule Creates a new Agent Scoring Rule for AI-powered automated evaluation of agent interactions.
EvaluationFormResponse	postQualityPublishedforms(PostQualityPublishedformsRequest request)	Deprecated.
ApiResponse<EvaluationFormResponse>	postQualityPublishedforms(ApiRequest<PublishForm> request)	Deprecated.
EvaluationFormResponse	postQualityPublishedforms(PublishForm body)	Deprecated.
EvaluationFormResponse	postQualityPublishedformsEvaluations(PostQualityPublishedformsEvaluationsRequest request)	Publish an evaluation form.
ApiResponse<EvaluationFormResponse>	postQualityPublishedformsEvaluations(ApiRequest<PublishForm> request)	Publish an evaluation form.
EvaluationFormResponse	postQualityPublishedformsEvaluations(PublishForm body)	Publish an evaluation form.
ApiResponse<EvaluationFormResponse>	postQualityPublishedformsEvaluationsWithHttpInfo(PublishForm body)	Publish an evaluation form.
SurveyForm	postQualityPublishedformsSurveys(PostQualityPublishedformsSurveysRequest request)	Publish a survey form.
ApiResponse<SurveyForm>	postQualityPublishedformsSurveys(ApiRequest<PublishForm> request)	Publish a survey form.
SurveyForm	postQualityPublishedformsSurveys(PublishForm body)	Publish a survey form.
ApiResponse<SurveyForm>	postQualityPublishedformsSurveysWithHttpInfo(PublishForm body)	Publish a survey form.
ApiResponse<EvaluationFormResponse>	postQualityPublishedformsWithHttpInfo(PublishForm body)	Deprecated.
CreateSurveyResponse	postQualitySurveys(PostQualitySurveysRequest request)	Create a survey for a conversation
ApiResponse<CreateSurveyResponse>	postQualitySurveys(ApiRequest<CreateSurveyRequest> request)	Create a survey for a conversation
CreateSurveyResponse	postQualitySurveys(CreateSurveyRequest body)	Create a survey for a conversation
SurveyScoringSet	postQualitySurveysScoring(PostQualitySurveysScoringRequest request)	Score survey
ApiResponse<SurveyScoringSet>	postQualitySurveysScoring(ApiRequest<SurveyFormAndScoringSet> request)	Score survey
SurveyScoringSet	postQualitySurveysScoring(SurveyFormAndScoringSet body)	Score survey
ApiResponse<SurveyScoringSet>	postQualitySurveysScoringWithHttpInfo(SurveyFormAndScoringSet body)	Score survey
ApiResponse<CreateSurveyResponse>	postQualitySurveysWithHttpInfo(CreateSurveyRequest body)	Create a survey for a conversation
Calibration	putQualityCalibration(PutQualityCalibrationRequest request)	Update a calibration to the specified calibration via PUT.
ApiResponse<Calibration>	putQualityCalibration(ApiRequest<Calibration> request)	Update a calibration to the specified calibration via PUT.
Calibration	putQualityCalibration(String calibrationId, Calibration body)	Update a calibration to the specified calibration via PUT.
ApiResponse<Calibration>	putQualityCalibrationWithHttpInfo(String calibrationId, Calibration body)	Update a calibration to the specified calibration via PUT.
EvaluationResponse	putQualityConversationEvaluation(PutQualityConversationEvaluationRequest request)	Update an evaluation The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.
ApiResponse<EvaluationResponse>	putQualityConversationEvaluation(ApiRequest<Evaluation> request)	Update an evaluation The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.
EvaluationResponse	putQualityConversationEvaluation(String conversationId, String evaluationId, Evaluation body, String expand)	Update an evaluation The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.
ApiResponse<EvaluationResponse>	putQualityConversationEvaluationWithHttpInfo(String conversationId, String evaluationId, Evaluation body, String expand)	Update an evaluation The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.
EvaluationFormResponse	putQualityForm(PutQualityFormRequest request)	Deprecated.
ApiResponse<EvaluationFormResponse>	putQualityForm(ApiRequest<EvaluationForm> request)	Deprecated.
EvaluationFormResponse	putQualityForm(String formId, EvaluationForm body)	Deprecated.
EvaluationFormResponse	putQualityFormsEvaluation(PutQualityFormsEvaluationRequest request)	Update an evaluation form.
ApiResponse<EvaluationFormResponse>	putQualityFormsEvaluation(ApiRequest<EvaluationForm> request)	Update an evaluation form.
EvaluationFormResponse	putQualityFormsEvaluation(String formId, EvaluationForm body)	Update an evaluation form.
AiScoringSettings	putQualityFormsEvaluationAiscoringSettings(PutQualityFormsEvaluationAiscoringSettingsRequest request)	Update the AI Scoring settings of an evaluation form.
ApiResponse<AiScoringSettings>	putQualityFormsEvaluationAiscoringSettings(ApiRequest<AiScoringSettings> request)	Update the AI Scoring settings of an evaluation form.
AiScoringSettings	putQualityFormsEvaluationAiscoringSettings(String formId, AiScoringSettings body)	Update the AI Scoring settings of an evaluation form.
ApiResponse<AiScoringSettings>	putQualityFormsEvaluationAiscoringSettingsWithHttpInfo(String formId, AiScoringSettings body)	Update the AI Scoring settings of an evaluation form.
ApiResponse<EvaluationFormResponse>	putQualityFormsEvaluationWithHttpInfo(String formId, EvaluationForm body)	Update an evaluation form.
SurveyForm	putQualityFormsSurvey(PutQualityFormsSurveyRequest request)	Update a survey form.
ApiResponse<SurveyForm>	putQualityFormsSurvey(ApiRequest<SurveyForm> request)	Update a survey form.
SurveyForm	putQualityFormsSurvey(String formId, SurveyForm body)	Update a survey form.
ApiResponse<SurveyForm>	putQualityFormsSurveyWithHttpInfo(String formId, SurveyForm body)	Update a survey form.
ApiResponse<EvaluationFormResponse>	putQualityFormWithHttpInfo(String formId, EvaluationForm body)	Deprecated.
AgentScoringRule	putQualityProgramAgentscoringrule(PutQualityProgramAgentscoringruleRequest request)	Update an Agent Scoring Rule
ApiResponse<AgentScoringRule>	putQualityProgramAgentscoringrule(ApiRequest<AgentScoringRule> request)	Update an Agent Scoring Rule
AgentScoringRule	putQualityProgramAgentscoringrule(String programId, String ruleId, AgentScoringRule body)	Update an Agent Scoring Rule
ApiResponse<AgentScoringRule>	putQualityProgramAgentscoringruleWithHttpInfo(String programId, String ruleId, AgentScoringRule body)	Update an Agent Scoring Rule
ScorableSurvey	putQualitySurveysScorable(PutQualitySurveysScorableRequest request)	Update a survey as an end-customer, for the purposes of scoring it.
ApiResponse<ScorableSurvey>	putQualitySurveysScorable(ApiRequest<ScorableSurvey> request)	Update a survey as an end-customer, for the purposes of scoring it.
ScorableSurvey	putQualitySurveysScorable(String customerSurveyUrl, ScorableSurvey body)	Update a survey as an end-customer, for the purposes of scoring it.
ApiResponse<ScorableSurvey>	putQualitySurveysScorableWithHttpInfo(String customerSurveyUrl, ScorableSurvey body)	Update a survey as an end-customer, for the purposes of scoring it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QualityApi

public QualityApi()

QualityApi

public QualityApi(ApiClient apiClient)

Method Details

deleteAnalyticsEvaluationsAggregatesJob

public void deleteAnalyticsEvaluationsAggregatesJob(String jobId)
                                             throws IOException,
ApiException

Delete/cancel an async request for evaluation aggregates

Parameters:

jobId - jobId (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAnalyticsEvaluationsAggregatesJobWithHttpInfo

public ApiResponse<Void> deleteAnalyticsEvaluationsAggregatesJobWithHttpInfo(String jobId)
                                                                      throws IOException

Delete/cancel an async request for evaluation aggregates

Parameters:

jobId - jobId (required)

Throws:

IOException - if the request fails to be processed

deleteAnalyticsEvaluationsAggregatesJob

public void deleteAnalyticsEvaluationsAggregatesJob(DeleteAnalyticsEvaluationsAggregatesJobRequest request)
                                             throws IOException,
ApiException

Delete/cancel an async request for evaluation aggregates

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAnalyticsEvaluationsAggregatesJob

public ApiResponse<Void> deleteAnalyticsEvaluationsAggregatesJob(ApiRequest<Void> request)
                                                          throws IOException

Delete/cancel an async request for evaluation aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteAnalyticsSurveysAggregatesJob

public void deleteAnalyticsSurveysAggregatesJob(String jobId)
                                         throws IOException,
ApiException

Delete/cancel an async request for survey aggregates

Parameters:

jobId - jobId (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAnalyticsSurveysAggregatesJobWithHttpInfo

public ApiResponse<Void> deleteAnalyticsSurveysAggregatesJobWithHttpInfo(String jobId)
                                                                  throws IOException

Delete/cancel an async request for survey aggregates

Parameters:

jobId - jobId (required)

Throws:

IOException - if the request fails to be processed

deleteAnalyticsSurveysAggregatesJob

public void deleteAnalyticsSurveysAggregatesJob(DeleteAnalyticsSurveysAggregatesJobRequest request)
                                         throws IOException,
ApiException

Delete/cancel an async request for survey aggregates

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAnalyticsSurveysAggregatesJob

public ApiResponse<Void> deleteAnalyticsSurveysAggregatesJob(ApiRequest<Void> request)
                                                      throws IOException

Delete/cancel an async request for survey aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteQualityCalibration

public Calibration deleteQualityCalibration(String calibrationId,
 String calibratorId)
                                     throws IOException,
ApiException

Delete a calibration by id.

Parameters:

calibrationId - Calibration ID (required)

calibratorId - calibratorId (required)

Returns:

Calibration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityCalibrationWithHttpInfo

public ApiResponse<Calibration> deleteQualityCalibrationWithHttpInfo(String calibrationId,
 String calibratorId)
                                                              throws IOException

Delete a calibration by id.

Parameters:

calibrationId - Calibration ID (required)

calibratorId - calibratorId (required)

Returns:

Calibration

Throws:

IOException - if the request fails to be processed

deleteQualityCalibration

public Calibration deleteQualityCalibration(DeleteQualityCalibrationRequest request)
                                     throws IOException,
ApiException

Delete a calibration by id.

Parameters:

request - The request object

Returns:

Calibration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityCalibration

public ApiResponse<Calibration> deleteQualityCalibration(ApiRequest<Void> request)
                                                  throws IOException

Delete a calibration by id.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteQualityConversationEvaluation

public EvaluationResponse deleteQualityConversationEvaluation(String conversationId,
 String evaluationId,
 String expand)
                                                       throws IOException,
ApiException

Delete an evaluation

Parameters:

conversationId - conversationId (required)

evaluationId - evaluationId (required)

expand - evaluatorId, evaluationForm (optional)

Returns:

EvaluationResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityConversationEvaluationWithHttpInfo

public ApiResponse<EvaluationResponse> deleteQualityConversationEvaluationWithHttpInfo(String conversationId,
 String evaluationId,
 String expand)
                                                                                throws IOException

Delete an evaluation

Parameters:

conversationId - conversationId (required)

evaluationId - evaluationId (required)

expand - evaluatorId, evaluationForm (optional)

Returns:

EvaluationResponse

Throws:

IOException - if the request fails to be processed

deleteQualityConversationEvaluation

public EvaluationResponse deleteQualityConversationEvaluation(DeleteQualityConversationEvaluationRequest request)
                                                       throws IOException,
ApiException

Delete an evaluation

Parameters:

request - The request object

Returns:

EvaluationResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityConversationEvaluation

public ApiResponse<EvaluationResponse> deleteQualityConversationEvaluation(ApiRequest<Void> request)
                                                                    throws IOException

Delete an evaluation

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteQualityForm

public void deleteQualityForm(String formId)
                       throws IOException,
ApiException

Deprecated.

Delete an evaluation form.

Parameters:

formId - Form ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityFormWithHttpInfo

public ApiResponse<Void> deleteQualityFormWithHttpInfo(String formId)
                                                throws IOException

Deprecated.

Delete an evaluation form.

Parameters:

formId - Form ID (required)

Throws:

IOException - if the request fails to be processed

deleteQualityForm

public void deleteQualityForm(DeleteQualityFormRequest request)
                       throws IOException,
ApiException

Deprecated.

Delete an evaluation form.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityForm

public ApiResponse<Void> deleteQualityForm(ApiRequest<Void> request)
                                    throws IOException

Deprecated.

Delete an evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteQualityFormsEvaluation

public void deleteQualityFormsEvaluation(String formId)
                                  throws IOException,
ApiException

Delete an evaluation form.

Parameters:

formId - Form ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityFormsEvaluationWithHttpInfo

public ApiResponse<Void> deleteQualityFormsEvaluationWithHttpInfo(String formId)
                                                           throws IOException

Delete an evaluation form.

Parameters:

formId - Form ID (required)

Throws:

IOException - if the request fails to be processed

deleteQualityFormsEvaluation

public void deleteQualityFormsEvaluation(DeleteQualityFormsEvaluationRequest request)
                                  throws IOException,
ApiException

Delete an evaluation form.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityFormsEvaluation

public ApiResponse<Void> deleteQualityFormsEvaluation(ApiRequest<Void> request)
                                               throws IOException

Delete an evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteQualityFormsSurvey

public void deleteQualityFormsSurvey(String formId)
                              throws IOException,
ApiException

Delete a survey form.

Parameters:

formId - Form ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityFormsSurveyWithHttpInfo

public ApiResponse<Void> deleteQualityFormsSurveyWithHttpInfo(String formId)
                                                       throws IOException

Delete a survey form.

Parameters:

formId - Form ID (required)

Throws:

IOException - if the request fails to be processed

deleteQualityFormsSurvey

public void deleteQualityFormsSurvey(DeleteQualityFormsSurveyRequest request)
                              throws IOException,
ApiException

Delete a survey form.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityFormsSurvey

public ApiResponse<Void> deleteQualityFormsSurvey(ApiRequest<Void> request)
                                           throws IOException

Delete a survey form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteQualityProgramAgentscoringrule

public void deleteQualityProgramAgentscoringrule(String programId,
 String ruleId)
                                          throws IOException,
ApiException

Delete an Agent Scoring Rule

Parameters:

programId - Program ID from Speech and Text Analytics (required)

ruleId - Agent Scoring Rule ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityProgramAgentscoringruleWithHttpInfo

public ApiResponse<Void> deleteQualityProgramAgentscoringruleWithHttpInfo(String programId,
 String ruleId)
                                                                   throws IOException

Delete an Agent Scoring Rule

Parameters:

programId - Program ID from Speech and Text Analytics (required)

ruleId - Agent Scoring Rule ID (required)

Throws:

IOException - if the request fails to be processed

deleteQualityProgramAgentscoringrule

public void deleteQualityProgramAgentscoringrule(DeleteQualityProgramAgentscoringruleRequest request)
                                          throws IOException,
ApiException

Delete an Agent Scoring Rule

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteQualityProgramAgentscoringrule

public ApiResponse<Void> deleteQualityProgramAgentscoringrule(ApiRequest<Void> request)
                                                       throws IOException

Delete an Agent Scoring Rule

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAnalyticsEvaluationsAggregatesJob

public AsyncQueryStatus getAnalyticsEvaluationsAggregatesJob(String jobId)
                                                      throws IOException,
ApiException

Get status for async query for evaluation aggregates

Parameters:

jobId - jobId (required)

Returns:

AsyncQueryStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsEvaluationsAggregatesJobWithHttpInfo

public ApiResponse<AsyncQueryStatus> getAnalyticsEvaluationsAggregatesJobWithHttpInfo(String jobId)
                                                                               throws IOException

Get status for async query for evaluation aggregates

Parameters:

jobId - jobId (required)

Returns:

AsyncQueryStatus

Throws:

IOException - if the request fails to be processed

getAnalyticsEvaluationsAggregatesJob

public AsyncQueryStatus getAnalyticsEvaluationsAggregatesJob(GetAnalyticsEvaluationsAggregatesJobRequest request)
                                                      throws IOException,
ApiException

Get status for async query for evaluation aggregates

Parameters:

request - The request object

Returns:

AsyncQueryStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsEvaluationsAggregatesJob

public ApiResponse<AsyncQueryStatus> getAnalyticsEvaluationsAggregatesJob(ApiRequest<Void> request)
                                                                   throws IOException

Get status for async query for evaluation aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAnalyticsEvaluationsAggregatesJobResults

public EvaluationAsyncAggregateQueryResponse getAnalyticsEvaluationsAggregatesJobResults(String jobId,
 String cursor)
                                                                                  throws IOException,
ApiException

Fetch a page of results for an async aggregates query

Parameters:

jobId - jobId (required)

cursor - Cursor token to retrieve next page (optional)

Returns:

EvaluationAsyncAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsEvaluationsAggregatesJobResultsWithHttpInfo

public ApiResponse<EvaluationAsyncAggregateQueryResponse> getAnalyticsEvaluationsAggregatesJobResultsWithHttpInfo(String jobId,
 String cursor)
                                                                                                           throws IOException

Fetch a page of results for an async aggregates query

Parameters:

jobId - jobId (required)

cursor - Cursor token to retrieve next page (optional)

Returns:

EvaluationAsyncAggregateQueryResponse

Throws:

IOException - if the request fails to be processed

getAnalyticsEvaluationsAggregatesJobResults

public EvaluationAsyncAggregateQueryResponse getAnalyticsEvaluationsAggregatesJobResults(GetAnalyticsEvaluationsAggregatesJobResultsRequest request)
                                                                                  throws IOException,
ApiException

Fetch a page of results for an async aggregates query

Parameters:

request - The request object

Returns:

EvaluationAsyncAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsEvaluationsAggregatesJobResults

public ApiResponse<EvaluationAsyncAggregateQueryResponse> getAnalyticsEvaluationsAggregatesJobResults(ApiRequest<Void> request)
                                                                                               throws IOException

Fetch a page of results for an async aggregates query

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAnalyticsSurveysAggregatesJob

public AsyncQueryStatus getAnalyticsSurveysAggregatesJob(String jobId)
                                                  throws IOException,
ApiException

Get status for async query for survey aggregates

Parameters:

jobId - jobId (required)

Returns:

AsyncQueryStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsSurveysAggregatesJobWithHttpInfo

public ApiResponse<AsyncQueryStatus> getAnalyticsSurveysAggregatesJobWithHttpInfo(String jobId)
                                                                           throws IOException

Get status for async query for survey aggregates

Parameters:

jobId - jobId (required)

Returns:

AsyncQueryStatus

Throws:

IOException - if the request fails to be processed

getAnalyticsSurveysAggregatesJob

public AsyncQueryStatus getAnalyticsSurveysAggregatesJob(GetAnalyticsSurveysAggregatesJobRequest request)
                                                  throws IOException,
ApiException

Get status for async query for survey aggregates

Parameters:

request - The request object

Returns:

AsyncQueryStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsSurveysAggregatesJob

public ApiResponse<AsyncQueryStatus> getAnalyticsSurveysAggregatesJob(ApiRequest<Void> request)
                                                               throws IOException

Get status for async query for survey aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAnalyticsSurveysAggregatesJobResults

public SurveyAsyncAggregateQueryResponse getAnalyticsSurveysAggregatesJobResults(String jobId,
 String cursor)
                                                                          throws IOException,
ApiException

Fetch a page of results for an async aggregates query

Parameters:

jobId - jobId (required)

cursor - Cursor token to retrieve next page (optional)

Returns:

SurveyAsyncAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsSurveysAggregatesJobResultsWithHttpInfo

public ApiResponse<SurveyAsyncAggregateQueryResponse> getAnalyticsSurveysAggregatesJobResultsWithHttpInfo(String jobId,
 String cursor)
                                                                                                   throws IOException

Fetch a page of results for an async aggregates query

Parameters:

jobId - jobId (required)

cursor - Cursor token to retrieve next page (optional)

Returns:

SurveyAsyncAggregateQueryResponse

Throws:

IOException - if the request fails to be processed

getAnalyticsSurveysAggregatesJobResults

public SurveyAsyncAggregateQueryResponse getAnalyticsSurveysAggregatesJobResults(GetAnalyticsSurveysAggregatesJobResultsRequest request)
                                                                          throws IOException,
ApiException

Fetch a page of results for an async aggregates query

Parameters:

request - The request object

Returns:

SurveyAsyncAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsSurveysAggregatesJobResults

public ApiResponse<SurveyAsyncAggregateQueryResponse> getAnalyticsSurveysAggregatesJobResults(ApiRequest<Void> request)
                                                                                       throws IOException

Fetch a page of results for an async aggregates query

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityAgentsActivity

public AgentActivityEntityListing getQualityAgentsActivity(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 Date startTime,
 Date endTime,
 List<String> agentUserId,
 String evaluatorUserId,
 String name,
 String group,
 String agentTeamId,
 String formContextId,
 String userState)
                                                    throws IOException,
ApiException

Gets a list of Agent Activities Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria. If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria. If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId. If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

startTime - Start time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

endTime - End time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

agentUserId - user id of agent requested (optional)

evaluatorUserId - user id of the evaluator (optional)

name - name (optional)

group - group id (optional)

agentTeamId - team id of agents requested (optional)

formContextId - shared id between form versions (optional)

userState - 'Legacy' fetches active and inactive users when evaluatorUserId or no user filters are supplied; otherwise fetches active users. 'Any' fetches users of 'active', 'inactive' and 'deleted' states. (optional, default to Legacy)

Returns:

AgentActivityEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityAgentsActivityWithHttpInfo

public ApiResponse<AgentActivityEntityListing> getQualityAgentsActivityWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 Date startTime,
 Date endTime,
 List<String> agentUserId,
 String evaluatorUserId,
 String name,
 String group,
 String agentTeamId,
 String formContextId,
 String userState)
                                                                             throws IOException

Gets a list of Agent Activities Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria. If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria. If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId. If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

startTime - Start time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

endTime - End time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

agentUserId - user id of agent requested (optional)

evaluatorUserId - user id of the evaluator (optional)

name - name (optional)

group - group id (optional)

agentTeamId - team id of agents requested (optional)

formContextId - shared id between form versions (optional)

userState - 'Legacy' fetches active and inactive users when evaluatorUserId or no user filters are supplied; otherwise fetches active users. 'Any' fetches users of 'active', 'inactive' and 'deleted' states. (optional, default to Legacy)

Returns:

AgentActivityEntityListing

Throws:

IOException - if the request fails to be processed

getQualityAgentsActivity

public AgentActivityEntityListing getQualityAgentsActivity(GetQualityAgentsActivityRequest request)
                                                    throws IOException,
ApiException

Gets a list of Agent Activities Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria. If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria. If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId. If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users

Parameters:

request - The request object

Returns:

AgentActivityEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityAgentsActivity

public ApiResponse<AgentActivityEntityListing> getQualityAgentsActivity(ApiRequest<Void> request)
                                                                 throws IOException

Gets a list of Agent Activities Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria. If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria. If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId. If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityCalibration

public Calibration getQualityCalibration(String calibrationId,
 String calibratorId,
 String conversationId)
                                  throws IOException,
ApiException

Get a calibration by id. Requires either calibrator id or conversation id

Parameters:

calibrationId - Calibration ID (required)

calibratorId - calibratorId (optional)

conversationId - conversationId (optional)

Returns:

Calibration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityCalibrationWithHttpInfo

public ApiResponse<Calibration> getQualityCalibrationWithHttpInfo(String calibrationId,
 String calibratorId,
 String conversationId)
                                                           throws IOException

Get a calibration by id. Requires either calibrator id or conversation id

Parameters:

calibrationId - Calibration ID (required)

calibratorId - calibratorId (optional)

conversationId - conversationId (optional)

Returns:

Calibration

Throws:

IOException - if the request fails to be processed

getQualityCalibration

public Calibration getQualityCalibration(GetQualityCalibrationRequest request)
                                  throws IOException,
ApiException

Get a calibration by id. Requires either calibrator id or conversation id

Parameters:

request - The request object

Returns:

Calibration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityCalibration

public ApiResponse<Calibration> getQualityCalibration(ApiRequest<Void> request)
                                               throws IOException

Get a calibration by id. Requires either calibrator id or conversation id

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityCalibrations

public CalibrationEntityListing getQualityCalibrations(String calibratorId,
 Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 String conversationId,
 Date startTime,
 Date endTime)
                                                throws IOException,
ApiException

Get the list of calibrations NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.

Parameters:

calibratorId - user id of calibrator (required)

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

conversationId - conversation id (optional)

startTime - Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

endTime - end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

Returns:

CalibrationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityCalibrationsWithHttpInfo

public ApiResponse<CalibrationEntityListing> getQualityCalibrationsWithHttpInfo(String calibratorId,
 Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 String conversationId,
 Date startTime,
 Date endTime)
                                                                         throws IOException

Get the list of calibrations NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.

Parameters:

calibratorId - user id of calibrator (required)

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

conversationId - conversation id (optional)

startTime - Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

endTime - end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

Returns:

CalibrationEntityListing

Throws:

IOException - if the request fails to be processed

getQualityCalibrations

public CalibrationEntityListing getQualityCalibrations(GetQualityCalibrationsRequest request)
                                                throws IOException,
ApiException

Get the list of calibrations NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.

Parameters:

request - The request object

Returns:

CalibrationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityCalibrations

public ApiResponse<CalibrationEntityListing> getQualityCalibrations(ApiRequest<Void> request)
                                                             throws IOException

Get the list of calibrations NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityConversationEvaluation

public EvaluationResponse getQualityConversationEvaluation(String conversationId,
 String evaluationId,
 String expand)
                                                    throws IOException,
ApiException

Get an evaluation

Parameters:

conversationId - conversationId (required)

evaluationId - evaluationId (required)

expand - agent, assignee, evaluator, evaluationForm (optional)

Returns:

EvaluationResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityConversationEvaluationWithHttpInfo

public ApiResponse<EvaluationResponse> getQualityConversationEvaluationWithHttpInfo(String conversationId,
 String evaluationId,
 String expand)
                                                                             throws IOException

Get an evaluation

Parameters:

conversationId - conversationId (required)

evaluationId - evaluationId (required)

expand - agent, assignee, evaluator, evaluationForm (optional)

Returns:

EvaluationResponse

Throws:

IOException - if the request fails to be processed

getQualityConversationEvaluation

public EvaluationResponse getQualityConversationEvaluation(GetQualityConversationEvaluationRequest request)
                                                    throws IOException,
ApiException

Get an evaluation

Parameters:

request - The request object

Returns:

EvaluationResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityConversationEvaluation

public ApiResponse<EvaluationResponse> getQualityConversationEvaluation(ApiRequest<Void> request)
                                                                 throws IOException

Get an evaluation

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityConversationSurveys

public List<Survey> getQualityConversationSurveys(String conversationId)
                                           throws IOException,
ApiException

Get the surveys for a conversation

Parameters:

conversationId - conversationId (required)

Returns:

List

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityConversationSurveysWithHttpInfo

public ApiResponse<List<Survey>> getQualityConversationSurveysWithHttpInfo(String conversationId)
                                                                    throws IOException

Get the surveys for a conversation

Parameters:

conversationId - conversationId (required)

Returns:

List

Throws:

IOException - if the request fails to be processed

getQualityConversationSurveys

public List<Survey> getQualityConversationSurveys(GetQualityConversationSurveysRequest request)
                                           throws IOException,
ApiException

Get the surveys for a conversation

Parameters:

request - The request object

Returns:

List

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityConversationSurveys

public ApiResponse<List<Survey>> getQualityConversationSurveys(ApiRequest<Void> request)
                                                        throws IOException

Get the surveys for a conversation

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityConversationsAuditsQueryTransactionId

public QualityAuditQueryExecutionStatusResponse getQualityConversationsAuditsQueryTransactionId(String transactionId)
                                                                                         throws IOException,
ApiException

Get status of audit query execution

Parameters:

transactionId - Transaction ID (required)

Returns:

QualityAuditQueryExecutionStatusResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityConversationsAuditsQueryTransactionIdWithHttpInfo

public ApiResponse<QualityAuditQueryExecutionStatusResponse> getQualityConversationsAuditsQueryTransactionIdWithHttpInfo(String transactionId)
                                                                                                                  throws IOException

Get status of audit query execution

Parameters:

transactionId - Transaction ID (required)

Returns:

QualityAuditQueryExecutionStatusResponse

Throws:

IOException - if the request fails to be processed

getQualityConversationsAuditsQueryTransactionId

public QualityAuditQueryExecutionStatusResponse getQualityConversationsAuditsQueryTransactionId(GetQualityConversationsAuditsQueryTransactionIdRequest request)
                                                                                         throws IOException,
ApiException

Get status of audit query execution

Parameters:

request - The request object

Returns:

QualityAuditQueryExecutionStatusResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityConversationsAuditsQueryTransactionId

public ApiResponse<QualityAuditQueryExecutionStatusResponse> getQualityConversationsAuditsQueryTransactionId(ApiRequest<Void> request)
                                                                                                      throws IOException

Get status of audit query execution

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityConversationsAuditsQueryTransactionIdResults

public QualityAuditQueryExecutionResultsResponse getQualityConversationsAuditsQueryTransactionIdResults(String transactionId,
 String cursor,
 Integer pageSize,
 List<String> expand)
                                                                                                 throws IOException,
ApiException

Get results of audit query

Parameters:

transactionId - Transaction ID (required)

cursor - Indicates where to resume query results (not required for first page) (optional)

pageSize - Page size (optional, default to 25)

expand - Which fields, if any, to expand (optional)

Returns:

QualityAuditQueryExecutionResultsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityConversationsAuditsQueryTransactionIdResultsWithHttpInfo

public ApiResponse<QualityAuditQueryExecutionResultsResponse> getQualityConversationsAuditsQueryTransactionIdResultsWithHttpInfo(String transactionId,
 String cursor,
 Integer pageSize,
 List<String> expand)
                                                                                                                          throws IOException

Get results of audit query

Parameters:

transactionId - Transaction ID (required)

cursor - Indicates where to resume query results (not required for first page) (optional)

pageSize - Page size (optional, default to 25)

expand - Which fields, if any, to expand (optional)

Returns:

QualityAuditQueryExecutionResultsResponse

Throws:

IOException - if the request fails to be processed

getQualityConversationsAuditsQueryTransactionIdResults

public QualityAuditQueryExecutionResultsResponse getQualityConversationsAuditsQueryTransactionIdResults(GetQualityConversationsAuditsQueryTransactionIdResultsRequest request)
                                                                                                 throws IOException,
ApiException

Get results of audit query

Parameters:

request - The request object

Returns:

QualityAuditQueryExecutionResultsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityConversationsAuditsQueryTransactionIdResults

public ApiResponse<QualityAuditQueryExecutionResultsResponse> getQualityConversationsAuditsQueryTransactionIdResults(ApiRequest<Void> request)
                                                                                                              throws IOException

Get results of audit query

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityEvaluationsQuery

public EvaluationEntityListing getQualityEvaluationsQuery(Integer pageSize,
 Integer pageNumber,
 List<String> expand,
 String previousPage,
 String conversationId,
 String agentUserId,
 String agentTeamId,
 String evaluatorUserId,
 String assigneeUserId,
 String queueId,
 String startTime,
 String endTime,
 String formContextId,
 List<String> evaluationState,
 Boolean isReleased,
 Boolean agentHasRead,
 Boolean expandAnswerTotalScores,
 Integer maximum,
 String sortOrder,
 Boolean includeDeletedUsers)
                                                   throws IOException,
ApiException

Queries Evaluations and returns a paged list Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch. The evaluation entities contained in the response might only contain a subset of all the properties listed below. It is often because a given property's value has not yet been populated or is not applicable in the current state of the evaluation. It might also be because the missing property in the response was not requested by the user.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

expand - variable name requested by expand list (optional)

previousPage - Previous page token (optional)

conversationId - conversationId specified (optional)

agentUserId - user id of the agent (optional)

agentTeamId - team id of the agent (optional)

evaluatorUserId - evaluator user id (optional)

assigneeUserId - assignee user id (optional)

queueId - queue id (optional)

startTime - start time of the evaluation query (optional)

endTime - end time of the evaluation query (optional)

formContextId - shared id between form versions (optional)

evaluationState - (optional)

isReleased - the evaluation has been released (optional)

agentHasRead - agent has the evaluation (optional)

expandAnswerTotalScores - get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request. (optional)

maximum - the maximum number of results to return (optional)

sortOrder - NOTE: Does not work when conversationId is supplied. (optional)

includeDeletedUsers - Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. (optional, default to false)

Returns:

EvaluationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityEvaluationsQueryWithHttpInfo

public ApiResponse<EvaluationEntityListing> getQualityEvaluationsQueryWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 List<String> expand,
 String previousPage,
 String conversationId,
 String agentUserId,
 String agentTeamId,
 String evaluatorUserId,
 String assigneeUserId,
 String queueId,
 String startTime,
 String endTime,
 String formContextId,
 List<String> evaluationState,
 Boolean isReleased,
 Boolean agentHasRead,
 Boolean expandAnswerTotalScores,
 Integer maximum,
 String sortOrder,
 Boolean includeDeletedUsers)
                                                                            throws IOException

Queries Evaluations and returns a paged list Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch. The evaluation entities contained in the response might only contain a subset of all the properties listed below. It is often because a given property's value has not yet been populated or is not applicable in the current state of the evaluation. It might also be because the missing property in the response was not requested by the user.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

expand - variable name requested by expand list (optional)

previousPage - Previous page token (optional)

conversationId - conversationId specified (optional)

agentUserId - user id of the agent (optional)

agentTeamId - team id of the agent (optional)

evaluatorUserId - evaluator user id (optional)

assigneeUserId - assignee user id (optional)

queueId - queue id (optional)

startTime - start time of the evaluation query (optional)

endTime - end time of the evaluation query (optional)

formContextId - shared id between form versions (optional)

evaluationState - (optional)

isReleased - the evaluation has been released (optional)

agentHasRead - agent has the evaluation (optional)

expandAnswerTotalScores - get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request. (optional)

maximum - the maximum number of results to return (optional)

sortOrder - NOTE: Does not work when conversationId is supplied. (optional)

includeDeletedUsers - Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. (optional, default to false)

Returns:

EvaluationEntityListing

Throws:

IOException - if the request fails to be processed

getQualityEvaluationsQuery

public EvaluationEntityListing getQualityEvaluationsQuery(GetQualityEvaluationsQueryRequest request)
                                                   throws IOException,
ApiException

Queries Evaluations and returns a paged list Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch. The evaluation entities contained in the response might only contain a subset of all the properties listed below. It is often because a given property's value has not yet been populated or is not applicable in the current state of the evaluation. It might also be because the missing property in the response was not requested by the user.

Parameters:

request - The request object

Returns:

EvaluationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityEvaluationsQuery

public ApiResponse<EvaluationEntityListing> getQualityEvaluationsQuery(ApiRequest<Void> request)
                                                                throws IOException

Queries Evaluations and returns a paged list Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch. The evaluation entities contained in the response might only contain a subset of all the properties listed below. It is often because a given property's value has not yet been populated or is not applicable in the current state of the evaluation. It might also be because the missing property in the response was not requested by the user.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityEvaluatorsActivity

public EvaluatorActivityEntityListing getQualityEvaluatorsActivity(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 Date startTime,
 Date endTime,
 String name,
 List<String> permission,
 String group,
 String agentTeamId)
                                                            throws IOException,
ApiException

Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

startTime - The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

endTime - The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

name - Evaluator name (optional)

permission - permission strings (optional)

group - group id (optional)

agentTeamId - team id of agents to be considered (optional)

Returns:

EvaluatorActivityEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityEvaluatorsActivityWithHttpInfo

public ApiResponse<EvaluatorActivityEntityListing> getQualityEvaluatorsActivityWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 Date startTime,
 Date endTime,
 String name,
 List<String> permission,
 String group,
 String agentTeamId)
                                                                                     throws IOException

Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

startTime - The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

endTime - The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

name - Evaluator name (optional)

permission - permission strings (optional)

group - group id (optional)

agentTeamId - team id of agents to be considered (optional)

Returns:

EvaluatorActivityEntityListing

Throws:

IOException - if the request fails to be processed

getQualityEvaluatorsActivity

public EvaluatorActivityEntityListing getQualityEvaluatorsActivity(GetQualityEvaluatorsActivityRequest request)
                                                            throws IOException,
ApiException

Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests.

Parameters:

request - The request object

Returns:

EvaluatorActivityEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityEvaluatorsActivity

public ApiResponse<EvaluatorActivityEntityListing> getQualityEvaluatorsActivity(ApiRequest<Void> request)
                                                                         throws IOException

Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityForm

public EvaluationFormResponse getQualityForm(String formId)
                                      throws IOException,
ApiException

Deprecated.

Get an evaluation form

Parameters:

formId - Form ID (required)

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormWithHttpInfo

public ApiResponse<EvaluationFormResponse> getQualityFormWithHttpInfo(String formId)
                                                               throws IOException

Deprecated.

Get an evaluation form

Parameters:

formId - Form ID (required)

Returns:

EvaluationFormResponse

Throws:

IOException - if the request fails to be processed

getQualityForm

public EvaluationFormResponse getQualityForm(GetQualityFormRequest request)
                                      throws IOException,
ApiException

Deprecated.

Get an evaluation form

Parameters:

request - The request object

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityForm

public ApiResponse<EvaluationFormResponse> getQualityForm(ApiRequest<Void> request)
                                                   throws IOException

Deprecated.

Get an evaluation form

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityFormVersions

public EvaluationFormResponseEntityListing getQualityFormVersions(String formId,
 Integer pageSize,
 Integer pageNumber,
 String sortOrder)
                                                           throws IOException,
ApiException

Deprecated.

Gets all the revisions for a specific evaluation.

Parameters:

formId - Form ID (required)

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

sortOrder - Sort order (optional, default to asc)

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormVersionsWithHttpInfo

public ApiResponse<EvaluationFormResponseEntityListing> getQualityFormVersionsWithHttpInfo(String formId,
 Integer pageSize,
 Integer pageNumber,
 String sortOrder)
                                                                                    throws IOException

Deprecated.

Gets all the revisions for a specific evaluation.

Parameters:

formId - Form ID (required)

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

sortOrder - Sort order (optional, default to asc)

Returns:

EvaluationFormResponseEntityListing

Throws:

IOException - if the request fails to be processed

getQualityFormVersions

public EvaluationFormResponseEntityListing getQualityFormVersions(GetQualityFormVersionsRequest request)
                                                           throws IOException,
ApiException

Deprecated.

Gets all the revisions for a specific evaluation.

Parameters:

request - The request object

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormVersions

public ApiResponse<EvaluationFormResponseEntityListing> getQualityFormVersions(ApiRequest<Void> request)
                                                                        throws IOException

Deprecated.

Gets all the revisions for a specific evaluation.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityForms

public EvaluationFormResponseEntityListing getQualityForms(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 String nextPage,
 String previousPage,
 String expand,
 String name,
 String sortOrder)
                                                    throws IOException,
ApiException

Deprecated.

Get the list of evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

expand - If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions (optional)

name - Name (optional)

sortOrder - Order to sort results, either asc or desc (optional)

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsWithHttpInfo

public ApiResponse<EvaluationFormResponseEntityListing> getQualityFormsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 String nextPage,
 String previousPage,
 String expand,
 String name,
 String sortOrder)
                                                                             throws IOException

Deprecated.

Get the list of evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

expand - If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions (optional)

name - Name (optional)

sortOrder - Order to sort results, either asc or desc (optional)

Returns:

EvaluationFormResponseEntityListing

Throws:

IOException - if the request fails to be processed

getQualityForms

public EvaluationFormResponseEntityListing getQualityForms(GetQualityFormsRequest request)
                                                    throws IOException,
ApiException

Deprecated.

Get the list of evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form.

Parameters:

request - The request object

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityForms

public ApiResponse<EvaluationFormResponseEntityListing> getQualityForms(ApiRequest<Void> request)
                                                                 throws IOException

Deprecated.

Get the list of evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityFormsEvaluation

public EvaluationFormResponse getQualityFormsEvaluation(String formId)
                                                 throws IOException,
ApiException

Get an evaluation form

Parameters:

formId - Form ID (required)

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsEvaluationWithHttpInfo

public ApiResponse<EvaluationFormResponse> getQualityFormsEvaluationWithHttpInfo(String formId)
                                                                          throws IOException

Get an evaluation form

Parameters:

formId - Form ID (required)

Returns:

EvaluationFormResponse

Throws:

IOException - if the request fails to be processed

getQualityFormsEvaluation

public EvaluationFormResponse getQualityFormsEvaluation(GetQualityFormsEvaluationRequest request)
                                                 throws IOException,
ApiException

Get an evaluation form

Parameters:

request - The request object

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsEvaluation

public ApiResponse<EvaluationFormResponse> getQualityFormsEvaluation(ApiRequest<Void> request)
                                                              throws IOException

Get an evaluation form

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityFormsEvaluationVersions

public EvaluationFormResponseEntityListing getQualityFormsEvaluationVersions(String formId,
 Integer pageSize,
 Integer pageNumber,
 String sortOrder)
                                                                      throws IOException,
ApiException

Gets all the revisions for a specific evaluation.

Parameters:

formId - Form ID (required)

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

sortOrder - Sort order (optional, default to asc)

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsEvaluationVersionsWithHttpInfo

public ApiResponse<EvaluationFormResponseEntityListing> getQualityFormsEvaluationVersionsWithHttpInfo(String formId,
 Integer pageSize,
 Integer pageNumber,
 String sortOrder)
                                                                                               throws IOException

Gets all the revisions for a specific evaluation.

Parameters:

formId - Form ID (required)

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

sortOrder - Sort order (optional, default to asc)

Returns:

EvaluationFormResponseEntityListing

Throws:

IOException - if the request fails to be processed

getQualityFormsEvaluationVersions

public EvaluationFormResponseEntityListing getQualityFormsEvaluationVersions(GetQualityFormsEvaluationVersionsRequest request)
                                                                      throws IOException,
ApiException

Gets all the revisions for a specific evaluation.

Parameters:

request - The request object

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsEvaluationVersions

public ApiResponse<EvaluationFormResponseEntityListing> getQualityFormsEvaluationVersions(ApiRequest<Void> request)
                                                                                   throws IOException

Gets all the revisions for a specific evaluation.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityFormsEvaluations

public EvaluationFormResponseEntityListing getQualityFormsEvaluations(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 String nextPage,
 String previousPage,
 String expand,
 String name,
 String sortOrder)
                                                               throws IOException,
ApiException

Get the list of evaluation forms By default, \"published\" field is always returned as false for all evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form. In addition, \"questionGroups\", the detailed information about evaluation form, is not returned. We will enhance this field in a future release.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

expand - If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions (optional)

name - Name (optional)

sortOrder - Order to sort results, either asc or desc (optional)

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsEvaluationsWithHttpInfo

public ApiResponse<EvaluationFormResponseEntityListing> getQualityFormsEvaluationsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 String nextPage,
 String previousPage,
 String expand,
 String name,
 String sortOrder)
                                                                                        throws IOException

Get the list of evaluation forms By default, \"published\" field is always returned as false for all evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form. In addition, \"questionGroups\", the detailed information about evaluation form, is not returned. We will enhance this field in a future release.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

expand - If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions (optional)

name - Name (optional)

sortOrder - Order to sort results, either asc or desc (optional)

Returns:

EvaluationFormResponseEntityListing

Throws:

IOException - if the request fails to be processed

getQualityFormsEvaluations

public EvaluationFormResponseEntityListing getQualityFormsEvaluations(GetQualityFormsEvaluationsRequest request)
                                                               throws IOException,
ApiException

Get the list of evaluation forms By default, \"published\" field is always returned as false for all evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form. In addition, \"questionGroups\", the detailed information about evaluation form, is not returned. We will enhance this field in a future release.

Parameters:

request - The request object

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsEvaluations

public ApiResponse<EvaluationFormResponseEntityListing> getQualityFormsEvaluations(ApiRequest<Void> request)
                                                                            throws IOException

Get the list of evaluation forms By default, \"published\" field is always returned as false for all evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form. In addition, \"questionGroups\", the detailed information about evaluation form, is not returned. We will enhance this field in a future release.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityFormsEvaluationsBulk

public EvaluationFormResponseEntityListing getQualityFormsEvaluationsBulk(List<String> id,
 Boolean includeLatestVersionFormName)
                                                                   throws IOException,
ApiException

Retrieve a list of evaluation forms by their ids

Parameters:

id - A comma-delimited list of valid evaluation form ids. The maximum number of ids allowed in this list is 100 (required)

includeLatestVersionFormName - Whether to include the name of the form's most recently published version (optional, default to false)

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsEvaluationsBulkWithHttpInfo

public ApiResponse<EvaluationFormResponseEntityListing> getQualityFormsEvaluationsBulkWithHttpInfo(List<String> id,
 Boolean includeLatestVersionFormName)
                                                                                            throws IOException

Retrieve a list of evaluation forms by their ids

Parameters:

id - A comma-delimited list of valid evaluation form ids. The maximum number of ids allowed in this list is 100 (required)

includeLatestVersionFormName - Whether to include the name of the form's most recently published version (optional, default to false)

Returns:

EvaluationFormResponseEntityListing

Throws:

IOException - if the request fails to be processed

getQualityFormsEvaluationsBulk

public EvaluationFormResponseEntityListing getQualityFormsEvaluationsBulk(GetQualityFormsEvaluationsBulkRequest request)
                                                                   throws IOException,
ApiException

Retrieve a list of evaluation forms by their ids

Parameters:

request - The request object

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsEvaluationsBulk

public ApiResponse<EvaluationFormResponseEntityListing> getQualityFormsEvaluationsBulk(ApiRequest<Void> request)
                                                                                throws IOException

Retrieve a list of evaluation forms by their ids

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityFormsEvaluationsBulkContexts

public List<EvaluationFormResponse> getQualityFormsEvaluationsBulkContexts(List<String> contextId)
                                                                    throws IOException,
ApiException

Retrieve a list of the latest published evaluation form versions by context ids

Parameters:

contextId - A comma-delimited list of valid evaluation form context ids (required)

Returns:

List

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsEvaluationsBulkContextsWithHttpInfo

public ApiResponse<List<EvaluationFormResponse>> getQualityFormsEvaluationsBulkContextsWithHttpInfo(List<String> contextId)
                                                                                             throws IOException

Retrieve a list of the latest published evaluation form versions by context ids

Parameters:

contextId - A comma-delimited list of valid evaluation form context ids (required)

Returns:

List

Throws:

IOException - if the request fails to be processed

getQualityFormsEvaluationsBulkContexts

public List<EvaluationFormResponse> getQualityFormsEvaluationsBulkContexts(GetQualityFormsEvaluationsBulkContextsRequest request)
                                                                    throws IOException,
ApiException

Retrieve a list of the latest published evaluation form versions by context ids

Parameters:

request - The request object

Returns:

List

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsEvaluationsBulkContexts

public ApiResponse<List<EvaluationFormResponse>> getQualityFormsEvaluationsBulkContexts(ApiRequest<Void> request)
                                                                                 throws IOException

Retrieve a list of the latest published evaluation form versions by context ids

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityFormsSurvey

public SurveyForm getQualityFormsSurvey(String formId)
                                 throws IOException,
ApiException

Get a survey form

Parameters:

formId - Form ID (required)

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsSurveyWithHttpInfo

public ApiResponse<SurveyForm> getQualityFormsSurveyWithHttpInfo(String formId)
                                                          throws IOException

Get a survey form

Parameters:

formId - Form ID (required)

Returns:

SurveyForm

Throws:

IOException - if the request fails to be processed

getQualityFormsSurvey

public SurveyForm getQualityFormsSurvey(GetQualityFormsSurveyRequest request)
                                 throws IOException,
ApiException

Get a survey form

Parameters:

request - The request object

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsSurvey

public ApiResponse<SurveyForm> getQualityFormsSurvey(ApiRequest<Void> request)
                                              throws IOException

Get a survey form

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityFormsSurveyVersions

public SurveyFormEntityListing getQualityFormsSurveyVersions(String formId,
 Integer pageSize,
 Integer pageNumber)
                                                      throws IOException,
ApiException

Gets all the revisions for a specific survey.

Parameters:

formId - Form ID (required)

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

Returns:

SurveyFormEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsSurveyVersionsWithHttpInfo

public ApiResponse<SurveyFormEntityListing> getQualityFormsSurveyVersionsWithHttpInfo(String formId,
 Integer pageSize,
 Integer pageNumber)
                                                                               throws IOException

Gets all the revisions for a specific survey.

Parameters:

formId - Form ID (required)

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

Returns:

SurveyFormEntityListing

Throws:

IOException - if the request fails to be processed

getQualityFormsSurveyVersions

public SurveyFormEntityListing getQualityFormsSurveyVersions(GetQualityFormsSurveyVersionsRequest request)
                                                      throws IOException,
ApiException

Gets all the revisions for a specific survey.

Parameters:

request - The request object

Returns:

SurveyFormEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsSurveyVersions

public ApiResponse<SurveyFormEntityListing> getQualityFormsSurveyVersions(ApiRequest<Void> request)
                                                                   throws IOException

Gets all the revisions for a specific survey.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityFormsSurveys

public SurveyFormEntityListing getQualityFormsSurveys(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 String nextPage,
 String previousPage,
 String expand,
 String name,
 String sortOrder)
                                               throws IOException,
ApiException

Get the list of survey forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding survey form.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

expand - If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions (optional)

name - Name (optional)

sortOrder - Order to sort results, either asc or desc (optional)

Returns:

SurveyFormEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsSurveysWithHttpInfo

public ApiResponse<SurveyFormEntityListing> getQualityFormsSurveysWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 String nextPage,
 String previousPage,
 String expand,
 String name,
 String sortOrder)
                                                                        throws IOException

Get the list of survey forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding survey form.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

expand - If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions (optional)

name - Name (optional)

sortOrder - Order to sort results, either asc or desc (optional)

Returns:

SurveyFormEntityListing

Throws:

IOException - if the request fails to be processed

getQualityFormsSurveys

public SurveyFormEntityListing getQualityFormsSurveys(GetQualityFormsSurveysRequest request)
                                               throws IOException,
ApiException

Get the list of survey forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding survey form.

Parameters:

request - The request object

Returns:

SurveyFormEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsSurveys

public ApiResponse<SurveyFormEntityListing> getQualityFormsSurveys(ApiRequest<Void> request)
                                                            throws IOException

Get the list of survey forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding survey form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityFormsSurveysBulk

public SurveyFormEntityListing getQualityFormsSurveysBulk(List<String> id)
                                                   throws IOException,
ApiException

Retrieve a list of survey forms by their ids

Parameters:

id - A comma-delimited list of valid survey form ids (required)

Returns:

SurveyFormEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsSurveysBulkWithHttpInfo

public ApiResponse<SurveyFormEntityListing> getQualityFormsSurveysBulkWithHttpInfo(List<String> id)
                                                                            throws IOException

Retrieve a list of survey forms by their ids

Parameters:

id - A comma-delimited list of valid survey form ids (required)

Returns:

SurveyFormEntityListing

Throws:

IOException - if the request fails to be processed

getQualityFormsSurveysBulk

public SurveyFormEntityListing getQualityFormsSurveysBulk(GetQualityFormsSurveysBulkRequest request)
                                                   throws IOException,
ApiException

Retrieve a list of survey forms by their ids

Parameters:

request - The request object

Returns:

SurveyFormEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsSurveysBulk

public ApiResponse<SurveyFormEntityListing> getQualityFormsSurveysBulk(ApiRequest<Void> request)
                                                                throws IOException

Retrieve a list of survey forms by their ids

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityFormsSurveysBulkContexts

public List<SurveyForm> getQualityFormsSurveysBulkContexts(List<String> contextId,
 Boolean published)
                                                    throws IOException,
ApiException

Retrieve a list of the latest form versions by context ids

Parameters:

contextId - A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100. (required)

published - If true, the latest published version will be included. If false, only the unpublished version will be included. (optional, default to true)

Returns:

List

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsSurveysBulkContextsWithHttpInfo

public ApiResponse<List<SurveyForm>> getQualityFormsSurveysBulkContextsWithHttpInfo(List<String> contextId,
 Boolean published)
                                                                             throws IOException

Retrieve a list of the latest form versions by context ids

Parameters:

contextId - A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100. (required)

published - If true, the latest published version will be included. If false, only the unpublished version will be included. (optional, default to true)

Returns:

List

Throws:

IOException - if the request fails to be processed

getQualityFormsSurveysBulkContexts

public List<SurveyForm> getQualityFormsSurveysBulkContexts(GetQualityFormsSurveysBulkContextsRequest request)
                                                    throws IOException,
ApiException

Retrieve a list of the latest form versions by context ids

Parameters:

request - The request object

Returns:

List

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityFormsSurveysBulkContexts

public ApiResponse<List<SurveyForm>> getQualityFormsSurveysBulkContexts(ApiRequest<Void> request)
                                                                 throws IOException

Retrieve a list of the latest form versions by context ids

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityProgramAgentscoringrule

public AgentScoringRule getQualityProgramAgentscoringrule(String programId,
 String ruleId)
                                                   throws IOException,
ApiException

Get an Agent Scoring Rule

Parameters:

programId - Program ID from Speech and Text Analytics (required)

ruleId - Agent Scoring Rule ID (required)

Returns:

AgentScoringRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityProgramAgentscoringruleWithHttpInfo

public ApiResponse<AgentScoringRule> getQualityProgramAgentscoringruleWithHttpInfo(String programId,
 String ruleId)
                                                                            throws IOException

Get an Agent Scoring Rule

Parameters:

programId - Program ID from Speech and Text Analytics (required)

ruleId - Agent Scoring Rule ID (required)

Returns:

AgentScoringRule

Throws:

IOException - if the request fails to be processed

getQualityProgramAgentscoringrule

public AgentScoringRule getQualityProgramAgentscoringrule(GetQualityProgramAgentscoringruleRequest request)
                                                   throws IOException,
ApiException

Get an Agent Scoring Rule

Parameters:

request - The request object

Returns:

AgentScoringRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityProgramAgentscoringrule

public ApiResponse<AgentScoringRule> getQualityProgramAgentscoringrule(ApiRequest<Void> request)
                                                                throws IOException

Get an Agent Scoring Rule

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityProgramAgentscoringrules

public AgentScoringRuleEntityListing getQualityProgramAgentscoringrules(String programId)
                                                                 throws IOException,
ApiException

Get Agent Scoring Rules for a program

Parameters:

programId - Program ID from Speech and Text Analytics (required)

Returns:

AgentScoringRuleEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityProgramAgentscoringrulesWithHttpInfo

public ApiResponse<AgentScoringRuleEntityListing> getQualityProgramAgentscoringrulesWithHttpInfo(String programId)
                                                                                          throws IOException

Get Agent Scoring Rules for a program

Parameters:

programId - Program ID from Speech and Text Analytics (required)

Returns:

AgentScoringRuleEntityListing

Throws:

IOException - if the request fails to be processed

getQualityProgramAgentscoringrules

public AgentScoringRuleEntityListing getQualityProgramAgentscoringrules(GetQualityProgramAgentscoringrulesRequest request)
                                                                 throws IOException,
ApiException

Get Agent Scoring Rules for a program

Parameters:

request - The request object

Returns:

AgentScoringRuleEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityProgramAgentscoringrules

public ApiResponse<AgentScoringRuleEntityListing> getQualityProgramAgentscoringrules(ApiRequest<Void> request)
                                                                              throws IOException

Get Agent Scoring Rules for a program

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityPublishedform

public EvaluationFormResponse getQualityPublishedform(String formId)
                                               throws IOException,
ApiException

Deprecated.

Get the published evaluation forms.

Parameters:

formId - Form ID (required)

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedformWithHttpInfo

public ApiResponse<EvaluationFormResponse> getQualityPublishedformWithHttpInfo(String formId)
                                                                        throws IOException

Deprecated.

Get the published evaluation forms.

Parameters:

formId - Form ID (required)

Returns:

EvaluationFormResponse

Throws:

IOException - if the request fails to be processed

getQualityPublishedform

public EvaluationFormResponse getQualityPublishedform(GetQualityPublishedformRequest request)
                                               throws IOException,
ApiException

Deprecated.

Get the published evaluation forms.

Parameters:

request - The request object

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedform

public ApiResponse<EvaluationFormResponse> getQualityPublishedform(ApiRequest<Void> request)
                                                            throws IOException

Deprecated.

Get the published evaluation forms.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityPublishedforms

public EvaluationFormResponseEntityListing getQualityPublishedforms(Integer pageSize,
 Integer pageNumber,
 String name,
 Boolean onlyLatestPerContext)
                                                             throws IOException,
ApiException

Deprecated.

Get the published evaluation forms.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

name - Name (optional)

onlyLatestPerContext - onlyLatestPerContext (optional, default to false)

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedformsWithHttpInfo

public ApiResponse<EvaluationFormResponseEntityListing> getQualityPublishedformsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String name,
 Boolean onlyLatestPerContext)
                                                                                      throws IOException

Deprecated.

Get the published evaluation forms.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

name - Name (optional)

onlyLatestPerContext - onlyLatestPerContext (optional, default to false)

Returns:

EvaluationFormResponseEntityListing

Throws:

IOException - if the request fails to be processed

getQualityPublishedforms

public EvaluationFormResponseEntityListing getQualityPublishedforms(GetQualityPublishedformsRequest request)
                                                             throws IOException,
ApiException

Deprecated.

Get the published evaluation forms.

Parameters:

request - The request object

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedforms

public ApiResponse<EvaluationFormResponseEntityListing> getQualityPublishedforms(ApiRequest<Void> request)
                                                                          throws IOException

Deprecated.

Get the published evaluation forms.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityPublishedformsEvaluation

public EvaluationFormResponse getQualityPublishedformsEvaluation(String formId)
                                                          throws IOException,
ApiException

Get the most recent published version of an evaluation form.

Parameters:

formId - Form ID (required)

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedformsEvaluationWithHttpInfo

public ApiResponse<EvaluationFormResponse> getQualityPublishedformsEvaluationWithHttpInfo(String formId)
                                                                                   throws IOException

Get the most recent published version of an evaluation form.

Parameters:

formId - Form ID (required)

Returns:

EvaluationFormResponse

Throws:

IOException - if the request fails to be processed

getQualityPublishedformsEvaluation

public EvaluationFormResponse getQualityPublishedformsEvaluation(GetQualityPublishedformsEvaluationRequest request)
                                                          throws IOException,
ApiException

Get the most recent published version of an evaluation form.

Parameters:

request - The request object

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedformsEvaluation

public ApiResponse<EvaluationFormResponse> getQualityPublishedformsEvaluation(ApiRequest<Void> request)
                                                                       throws IOException

Get the most recent published version of an evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityPublishedformsEvaluations

public EvaluationFormResponseEntityListing getQualityPublishedformsEvaluations(Integer pageSize,
 Integer pageNumber,
 String name,
 Boolean onlyLatestPerContext)
                                                                        throws IOException,
ApiException

Get the published evaluation forms.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

name - Name (optional)

onlyLatestPerContext - onlyLatestPerContext (optional, default to false)

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedformsEvaluationsWithHttpInfo

public ApiResponse<EvaluationFormResponseEntityListing> getQualityPublishedformsEvaluationsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String name,
 Boolean onlyLatestPerContext)
                                                                                                 throws IOException

Get the published evaluation forms.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

name - Name (optional)

onlyLatestPerContext - onlyLatestPerContext (optional, default to false)

Returns:

EvaluationFormResponseEntityListing

Throws:

IOException - if the request fails to be processed

getQualityPublishedformsEvaluations

public EvaluationFormResponseEntityListing getQualityPublishedformsEvaluations(GetQualityPublishedformsEvaluationsRequest request)
                                                                        throws IOException,
ApiException

Get the published evaluation forms.

Parameters:

request - The request object

Returns:

EvaluationFormResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedformsEvaluations

public ApiResponse<EvaluationFormResponseEntityListing> getQualityPublishedformsEvaluations(ApiRequest<Void> request)
                                                                                     throws IOException

Get the published evaluation forms.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityPublishedformsSurvey

public SurveyForm getQualityPublishedformsSurvey(String formId)
                                          throws IOException,
ApiException

Get the most recent published version of a survey form.

Parameters:

formId - Form ID (required)

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedformsSurveyWithHttpInfo

public ApiResponse<SurveyForm> getQualityPublishedformsSurveyWithHttpInfo(String formId)
                                                                   throws IOException

Get the most recent published version of a survey form.

Parameters:

formId - Form ID (required)

Returns:

SurveyForm

Throws:

IOException - if the request fails to be processed

getQualityPublishedformsSurvey

public SurveyForm getQualityPublishedformsSurvey(GetQualityPublishedformsSurveyRequest request)
                                          throws IOException,
ApiException

Get the most recent published version of a survey form.

Parameters:

request - The request object

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedformsSurvey

public ApiResponse<SurveyForm> getQualityPublishedformsSurvey(ApiRequest<Void> request)
                                                       throws IOException

Get the most recent published version of a survey form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualityPublishedformsSurveys

public SurveyFormEntityListing getQualityPublishedformsSurveys(Integer pageSize,
 Integer pageNumber,
 String name,
 Boolean onlyLatestEnabledPerContext)
                                                        throws IOException,
ApiException

Get the published survey forms.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

name - Name (optional)

onlyLatestEnabledPerContext - onlyLatestEnabledPerContext (optional, default to false)

Returns:

SurveyFormEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedformsSurveysWithHttpInfo

public ApiResponse<SurveyFormEntityListing> getQualityPublishedformsSurveysWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String name,
 Boolean onlyLatestEnabledPerContext)
                                                                                 throws IOException

Get the published survey forms.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

name - Name (optional)

onlyLatestEnabledPerContext - onlyLatestEnabledPerContext (optional, default to false)

Returns:

SurveyFormEntityListing

Throws:

IOException - if the request fails to be processed

getQualityPublishedformsSurveys

public SurveyFormEntityListing getQualityPublishedformsSurveys(GetQualityPublishedformsSurveysRequest request)
                                                        throws IOException,
ApiException

Get the published survey forms.

Parameters:

request - The request object

Returns:

SurveyFormEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualityPublishedformsSurveys

public ApiResponse<SurveyFormEntityListing> getQualityPublishedformsSurveys(ApiRequest<Void> request)
                                                                     throws IOException

Get the published survey forms.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualitySurvey

public Survey getQualitySurvey(String surveyId)
                        throws IOException,
ApiException

Get a survey for a conversation

Parameters:

surveyId - surveyId (required)

Returns:

Survey

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualitySurveyWithHttpInfo

public ApiResponse<Survey> getQualitySurveyWithHttpInfo(String surveyId)
                                                 throws IOException

Get a survey for a conversation

Parameters:

surveyId - surveyId (required)

Returns:

Survey

Throws:

IOException - if the request fails to be processed

getQualitySurvey

public Survey getQualitySurvey(GetQualitySurveyRequest request)
                        throws IOException,
ApiException

Get a survey for a conversation

Parameters:

request - The request object

Returns:

Survey

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualitySurvey

public ApiResponse<Survey> getQualitySurvey(ApiRequest<Void> request)
                                     throws IOException

Get a survey for a conversation

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getQualitySurveysScorable

public ScorableSurvey getQualitySurveysScorable(String customerSurveyUrl)
                                         throws IOException,
ApiException

Get a survey as an end-customer, for the purposes of scoring it.

Parameters:

customerSurveyUrl - customerSurveyUrl (required)

Returns:

ScorableSurvey

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualitySurveysScorableWithHttpInfo

public ApiResponse<ScorableSurvey> getQualitySurveysScorableWithHttpInfo(String customerSurveyUrl)
                                                                  throws IOException

Get a survey as an end-customer, for the purposes of scoring it.

Parameters:

customerSurveyUrl - customerSurveyUrl (required)

Returns:

ScorableSurvey

Throws:

IOException - if the request fails to be processed

getQualitySurveysScorable

public ScorableSurvey getQualitySurveysScorable(GetQualitySurveysScorableRequest request)
                                         throws IOException,
ApiException

Get a survey as an end-customer, for the purposes of scoring it.

Parameters:

request - The request object

Returns:

ScorableSurvey

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getQualitySurveysScorable

public ApiResponse<ScorableSurvey> getQualitySurveysScorable(ApiRequest<Void> request)
                                                      throws IOException

Get a survey as an end-customer, for the purposes of scoring it.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchQualityFormsSurvey

public SurveyForm patchQualityFormsSurvey(String formId,
 SurveyForm body)
                                   throws IOException,
ApiException

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.

Parameters:

formId - Form ID (required)

body - Survey form (required)

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchQualityFormsSurveyWithHttpInfo

public ApiResponse<SurveyForm> patchQualityFormsSurveyWithHttpInfo(String formId,
 SurveyForm body)
                                                            throws IOException

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.

Parameters:

formId - Form ID (required)

body - Survey form (required)

Returns:

SurveyForm

Throws:

IOException - if the request fails to be processed

patchQualityFormsSurvey

public SurveyForm patchQualityFormsSurvey(PatchQualityFormsSurveyRequest request)
                                   throws IOException,
ApiException

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.

Parameters:

request - The request object

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchQualityFormsSurvey

public ApiResponse<SurveyForm> patchQualityFormsSurvey(ApiRequest<SurveyForm> request)
                                                throws IOException

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.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAnalyticsEvaluationsAggregatesJobs

public AsyncQueryResponse postAnalyticsEvaluationsAggregatesJobs(EvaluationAsyncAggregationQuery body)
                                                          throws IOException,
ApiException

Query for evaluation aggregates asynchronously

Parameters:

body - query (required)

Returns:

AsyncQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsEvaluationsAggregatesJobsWithHttpInfo

public ApiResponse<AsyncQueryResponse> postAnalyticsEvaluationsAggregatesJobsWithHttpInfo(EvaluationAsyncAggregationQuery body)
                                                                                   throws IOException

Query for evaluation aggregates asynchronously

Parameters:

body - query (required)

Returns:

AsyncQueryResponse

Throws:

IOException - if the request fails to be processed

postAnalyticsEvaluationsAggregatesJobs

public AsyncQueryResponse postAnalyticsEvaluationsAggregatesJobs(PostAnalyticsEvaluationsAggregatesJobsRequest request)
                                                          throws IOException,
ApiException

Query for evaluation aggregates asynchronously

Parameters:

request - The request object

Returns:

AsyncQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsEvaluationsAggregatesJobs

public ApiResponse<AsyncQueryResponse> postAnalyticsEvaluationsAggregatesJobs(ApiRequest<EvaluationAsyncAggregationQuery> request)
                                                                       throws IOException

Query for evaluation aggregates asynchronously

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAnalyticsEvaluationsAggregatesQuery

public EvaluationAggregateQueryResponse postAnalyticsEvaluationsAggregatesQuery(EvaluationAggregationQuery body)
                                                                         throws IOException,
ApiException

Query for evaluation aggregates

Parameters:

body - query (required)

Returns:

EvaluationAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsEvaluationsAggregatesQueryWithHttpInfo

public ApiResponse<EvaluationAggregateQueryResponse> postAnalyticsEvaluationsAggregatesQueryWithHttpInfo(EvaluationAggregationQuery body)
                                                                                                  throws IOException

Query for evaluation aggregates

Parameters:

body - query (required)

Returns:

EvaluationAggregateQueryResponse

Throws:

IOException - if the request fails to be processed

postAnalyticsEvaluationsAggregatesQuery

public EvaluationAggregateQueryResponse postAnalyticsEvaluationsAggregatesQuery(PostAnalyticsEvaluationsAggregatesQueryRequest request)
                                                                         throws IOException,
ApiException

Query for evaluation aggregates

Parameters:

request - The request object

Returns:

EvaluationAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsEvaluationsAggregatesQuery

public ApiResponse<EvaluationAggregateQueryResponse> postAnalyticsEvaluationsAggregatesQuery(ApiRequest<EvaluationAggregationQuery> request)
                                                                                      throws IOException

Query for evaluation aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAnalyticsSurveysAggregatesJobs

public AsyncQueryResponse postAnalyticsSurveysAggregatesJobs(SurveyAsyncAggregationQuery body)
                                                      throws IOException,
ApiException

Query for survey aggregates asynchronously

Parameters:

body - query (required)

Returns:

AsyncQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsSurveysAggregatesJobsWithHttpInfo

public ApiResponse<AsyncQueryResponse> postAnalyticsSurveysAggregatesJobsWithHttpInfo(SurveyAsyncAggregationQuery body)
                                                                               throws IOException

Query for survey aggregates asynchronously

Parameters:

body - query (required)

Returns:

AsyncQueryResponse

Throws:

IOException - if the request fails to be processed

postAnalyticsSurveysAggregatesJobs

public AsyncQueryResponse postAnalyticsSurveysAggregatesJobs(PostAnalyticsSurveysAggregatesJobsRequest request)
                                                      throws IOException,
ApiException

Query for survey aggregates asynchronously

Parameters:

request - The request object

Returns:

AsyncQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsSurveysAggregatesJobs

public ApiResponse<AsyncQueryResponse> postAnalyticsSurveysAggregatesJobs(ApiRequest<SurveyAsyncAggregationQuery> request)
                                                                   throws IOException

Query for survey aggregates asynchronously

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAnalyticsSurveysAggregatesQuery

public SurveyAggregateQueryResponse postAnalyticsSurveysAggregatesQuery(SurveyAggregationQuery body)
                                                                 throws IOException,
ApiException

Query for survey aggregates

Parameters:

body - query (required)

Returns:

SurveyAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsSurveysAggregatesQueryWithHttpInfo

public ApiResponse<SurveyAggregateQueryResponse> postAnalyticsSurveysAggregatesQueryWithHttpInfo(SurveyAggregationQuery body)
                                                                                          throws IOException

Query for survey aggregates

Parameters:

body - query (required)

Returns:

SurveyAggregateQueryResponse

Throws:

IOException - if the request fails to be processed

postAnalyticsSurveysAggregatesQuery

public SurveyAggregateQueryResponse postAnalyticsSurveysAggregatesQuery(PostAnalyticsSurveysAggregatesQueryRequest request)
                                                                 throws IOException,
ApiException

Query for survey aggregates

Parameters:

request - The request object

Returns:

SurveyAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsSurveysAggregatesQuery

public ApiResponse<SurveyAggregateQueryResponse> postAnalyticsSurveysAggregatesQuery(ApiRequest<SurveyAggregationQuery> request)
                                                                              throws IOException

Query for survey aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityCalibrations

public Calibration postQualityCalibrations(CalibrationCreate body,
 String expand)
                                    throws IOException,
ApiException

Create a calibration

Parameters:

body - calibration (required)

expand - calibratorId (optional)

Returns:

Calibration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityCalibrationsWithHttpInfo

public ApiResponse<Calibration> postQualityCalibrationsWithHttpInfo(CalibrationCreate body,
 String expand)
                                                             throws IOException

Create a calibration

Parameters:

body - calibration (required)

expand - calibratorId (optional)

Returns:

Calibration

Throws:

IOException - if the request fails to be processed

postQualityCalibrations

public Calibration postQualityCalibrations(PostQualityCalibrationsRequest request)
                                    throws IOException,
ApiException

Create a calibration

Parameters:

request - The request object

Returns:

Calibration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityCalibrations

public ApiResponse<Calibration> postQualityCalibrations(ApiRequest<CalibrationCreate> request)
                                                 throws IOException

Create a calibration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityConversationEvaluations

public Evaluation postQualityConversationEvaluations(String conversationId,
 EvaluationCreateBody body,
 String idempotencyKey,
 String expand)
                                              throws IOException,
ApiException

Create an evaluation

Parameters:

conversationId - conversationId (required)

body - evaluation (required)

idempotencyKey - Idempotency key for request deduplication (optional)

expand - evaluatorId (optional)

Returns:

Evaluation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityConversationEvaluationsWithHttpInfo

public ApiResponse<Evaluation> postQualityConversationEvaluationsWithHttpInfo(String conversationId,
 EvaluationCreateBody body,
 String idempotencyKey,
 String expand)
                                                                       throws IOException

Create an evaluation

Parameters:

conversationId - conversationId (required)

body - evaluation (required)

idempotencyKey - Idempotency key for request deduplication (optional)

expand - evaluatorId (optional)

Returns:

Evaluation

Throws:

IOException - if the request fails to be processed

postQualityConversationEvaluations

public Evaluation postQualityConversationEvaluations(PostQualityConversationEvaluationsRequest request)
                                              throws IOException,
ApiException

Create an evaluation

Parameters:

request - The request object

Returns:

Evaluation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityConversationEvaluations

public ApiResponse<Evaluation> postQualityConversationEvaluations(ApiRequest<EvaluationCreateBody> request)
                                                           throws IOException

Create an evaluation

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityConversationsAuditsQuery

public QualityAuditQueryExecutionStatusResponse postQualityConversationsAuditsQuery(QMAuditQueryRequest body)
                                                                             throws IOException,
ApiException

Create audit query execution

Parameters:

body - query (required)

Returns:

QualityAuditQueryExecutionStatusResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityConversationsAuditsQueryWithHttpInfo

public ApiResponse<QualityAuditQueryExecutionStatusResponse> postQualityConversationsAuditsQueryWithHttpInfo(QMAuditQueryRequest body)
                                                                                                      throws IOException

Create audit query execution

Parameters:

body - query (required)

Returns:

QualityAuditQueryExecutionStatusResponse

Throws:

IOException - if the request fails to be processed

postQualityConversationsAuditsQuery

public QualityAuditQueryExecutionStatusResponse postQualityConversationsAuditsQuery(PostQualityConversationsAuditsQueryRequest request)
                                                                             throws IOException,
ApiException

Create audit query execution

Parameters:

request - The request object

Returns:

QualityAuditQueryExecutionStatusResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityConversationsAuditsQuery

public ApiResponse<QualityAuditQueryExecutionStatusResponse> postQualityConversationsAuditsQuery(ApiRequest<QMAuditQueryRequest> request)
                                                                                          throws IOException

Create audit query execution

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityEvaluationsAggregatesQueryMe

public EvaluationAggregateQueryResponse postQualityEvaluationsAggregatesQueryMe(EvaluationAggregationQueryMe body)
                                                                         throws IOException,
ApiException

Query for evaluation aggregates for the current user

Parameters:

body - query (required)

Returns:

EvaluationAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityEvaluationsAggregatesQueryMeWithHttpInfo

public ApiResponse<EvaluationAggregateQueryResponse> postQualityEvaluationsAggregatesQueryMeWithHttpInfo(EvaluationAggregationQueryMe body)
                                                                                                  throws IOException

Query for evaluation aggregates for the current user

Parameters:

body - query (required)

Returns:

EvaluationAggregateQueryResponse

Throws:

IOException - if the request fails to be processed

postQualityEvaluationsAggregatesQueryMe

public EvaluationAggregateQueryResponse postQualityEvaluationsAggregatesQueryMe(PostQualityEvaluationsAggregatesQueryMeRequest request)
                                                                         throws IOException,
ApiException

Query for evaluation aggregates for the current user

Parameters:

request - The request object

Returns:

EvaluationAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityEvaluationsAggregatesQueryMe

public ApiResponse<EvaluationAggregateQueryResponse> postQualityEvaluationsAggregatesQueryMe(ApiRequest<EvaluationAggregationQueryMe> request)
                                                                                      throws IOException

Query for evaluation aggregates for the current user

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityEvaluationsScoring

public EvaluationScoringSet postQualityEvaluationsScoring(EvaluationFormAndScoringSet body)
                                                   throws IOException,
ApiException

Score evaluation

Parameters:

body - evaluationAndScoringSet (required)

Returns:

EvaluationScoringSet

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityEvaluationsScoringWithHttpInfo

public ApiResponse<EvaluationScoringSet> postQualityEvaluationsScoringWithHttpInfo(EvaluationFormAndScoringSet body)
                                                                            throws IOException

Score evaluation

Parameters:

body - evaluationAndScoringSet (required)

Returns:

EvaluationScoringSet

Throws:

IOException - if the request fails to be processed

postQualityEvaluationsScoring

public EvaluationScoringSet postQualityEvaluationsScoring(PostQualityEvaluationsScoringRequest request)
                                                   throws IOException,
ApiException

Score evaluation

Parameters:

request - The request object

Returns:

EvaluationScoringSet

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityEvaluationsScoring

public ApiResponse<EvaluationScoringSet> postQualityEvaluationsScoring(ApiRequest<EvaluationFormAndScoringSet> request)
                                                                throws IOException

Score evaluation

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityEvaluationsSearch

public EvaluationSearchResponse postQualityEvaluationsSearch(EvaluationSearchRequestDTO body)
                                                      throws IOException,
ApiException

Search evaluations based along specified criteria Search Rules: 1. Time Range - Time Range: Max 3 months (required) 2. Question Group Level Query: Use at least one field containing 'questionGroup' in name + exactly one questionGroupId 3. Question Level Query: Use at least one field containing 'question' in name + exactly one questionId 4. Mixed Queries: questionId alone is sufficient 5. Search Logic: - Multiple criteria: AND operation - Multiple values per criterion: OR operation EXAMPLE: (agentId₁ OR agentId₂) AND (evaluatorId₁ OR evaluatorId₂) 5. Aggregations: - Omit or set pageSize = 0 - Choose: multiple aggregations OR single aggregation with multiple sub-aggregations - To aggregate against question fields, one must query by either a questionId OR a single top level TERM questionId aggregation AND query by a single formID or questionGroupId, or list of questionIds - To aggregate against question group fields, one must query either a questionId/questionGroupId OR a single top level TERM questionGroupId aggregation AND query by a single formID or list of questionGroupIds

Parameters:

body - Evaluation search request (required)

Returns:

EvaluationSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityEvaluationsSearchWithHttpInfo

public ApiResponse<EvaluationSearchResponse> postQualityEvaluationsSearchWithHttpInfo(EvaluationSearchRequestDTO body)
                                                                               throws IOException

Search evaluations based along specified criteria Search Rules: 1. Time Range - Time Range: Max 3 months (required) 2. Question Group Level Query: Use at least one field containing 'questionGroup' in name + exactly one questionGroupId 3. Question Level Query: Use at least one field containing 'question' in name + exactly one questionId 4. Mixed Queries: questionId alone is sufficient 5. Search Logic: - Multiple criteria: AND operation - Multiple values per criterion: OR operation EXAMPLE: (agentId₁ OR agentId₂) AND (evaluatorId₁ OR evaluatorId₂) 5. Aggregations: - Omit or set pageSize = 0 - Choose: multiple aggregations OR single aggregation with multiple sub-aggregations - To aggregate against question fields, one must query by either a questionId OR a single top level TERM questionId aggregation AND query by a single formID or questionGroupId, or list of questionIds - To aggregate against question group fields, one must query either a questionId/questionGroupId OR a single top level TERM questionGroupId aggregation AND query by a single formID or list of questionGroupIds

Parameters:

body - Evaluation search request (required)

Returns:

EvaluationSearchResponse

Throws:

IOException - if the request fails to be processed

postQualityEvaluationsSearch

public EvaluationSearchResponse postQualityEvaluationsSearch(PostQualityEvaluationsSearchRequest request)
                                                      throws IOException,
ApiException

Search evaluations based along specified criteria Search Rules: 1. Time Range - Time Range: Max 3 months (required) 2. Question Group Level Query: Use at least one field containing 'questionGroup' in name + exactly one questionGroupId 3. Question Level Query: Use at least one field containing 'question' in name + exactly one questionId 4. Mixed Queries: questionId alone is sufficient 5. Search Logic: - Multiple criteria: AND operation - Multiple values per criterion: OR operation EXAMPLE: (agentId₁ OR agentId₂) AND (evaluatorId₁ OR evaluatorId₂) 5. Aggregations: - Omit or set pageSize = 0 - Choose: multiple aggregations OR single aggregation with multiple sub-aggregations - To aggregate against question fields, one must query by either a questionId OR a single top level TERM questionId aggregation AND query by a single formID or questionGroupId, or list of questionIds - To aggregate against question group fields, one must query either a questionId/questionGroupId OR a single top level TERM questionGroupId aggregation AND query by a single formID or list of questionGroupIds

Parameters:

request - The request object

Returns:

EvaluationSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityEvaluationsSearch

public ApiResponse<EvaluationSearchResponse> postQualityEvaluationsSearch(ApiRequest<EvaluationSearchRequestDTO> request)
                                                                   throws IOException

Search evaluations based along specified criteria Search Rules: 1. Time Range - Time Range: Max 3 months (required) 2. Question Group Level Query: Use at least one field containing 'questionGroup' in name + exactly one questionGroupId 3. Question Level Query: Use at least one field containing 'question' in name + exactly one questionId 4. Mixed Queries: questionId alone is sufficient 5. Search Logic: - Multiple criteria: AND operation - Multiple values per criterion: OR operation EXAMPLE: (agentId₁ OR agentId₂) AND (evaluatorId₁ OR evaluatorId₂) 5. Aggregations: - Omit or set pageSize = 0 - Choose: multiple aggregations OR single aggregation with multiple sub-aggregations - To aggregate against question fields, one must query by either a questionId OR a single top level TERM questionId aggregation AND query by a single formID or questionGroupId, or list of questionIds - To aggregate against question group fields, one must query either a questionId/questionGroupId OR a single top level TERM questionGroupId aggregation AND query by a single formID or list of questionGroupIds

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityForms

public EvaluationFormResponse postQualityForms(EvaluationForm body)
                                        throws IOException,
ApiException

Deprecated.

Create an evaluation form.

Parameters:

body - Evaluation form (required)

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityFormsWithHttpInfo

public ApiResponse<EvaluationFormResponse> postQualityFormsWithHttpInfo(EvaluationForm body)
                                                                 throws IOException

Deprecated.

Create an evaluation form.

Parameters:

body - Evaluation form (required)

Returns:

EvaluationFormResponse

Throws:

IOException - if the request fails to be processed

postQualityForms

public EvaluationFormResponse postQualityForms(PostQualityFormsRequest request)
                                        throws IOException,
ApiException

Deprecated.

Create an evaluation form.

Parameters:

request - The request object

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityForms

public ApiResponse<EvaluationFormResponse> postQualityForms(ApiRequest<EvaluationForm> request)
                                                     throws IOException

Deprecated.

Create an evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityFormsEvaluations

public EvaluationFormResponse postQualityFormsEvaluations(EvaluationForm body)
                                                   throws IOException,
ApiException

Create an evaluation form.

Parameters:

body - Evaluation form (required)

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityFormsEvaluationsWithHttpInfo

public ApiResponse<EvaluationFormResponse> postQualityFormsEvaluationsWithHttpInfo(EvaluationForm body)
                                                                            throws IOException

Create an evaluation form.

Parameters:

body - Evaluation form (required)

Returns:

EvaluationFormResponse

Throws:

IOException - if the request fails to be processed

postQualityFormsEvaluations

public EvaluationFormResponse postQualityFormsEvaluations(PostQualityFormsEvaluationsRequest request)
                                                   throws IOException,
ApiException

Create an evaluation form.

Parameters:

request - The request object

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityFormsEvaluations

public ApiResponse<EvaluationFormResponse> postQualityFormsEvaluations(ApiRequest<EvaluationForm> request)
                                                                throws IOException

Create an evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityFormsSurveys

public SurveyForm postQualityFormsSurveys(SurveyForm body)
                                   throws IOException,
ApiException

Create a survey form.

Parameters:

body - Survey form (required)

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityFormsSurveysWithHttpInfo

public ApiResponse<SurveyForm> postQualityFormsSurveysWithHttpInfo(SurveyForm body)
                                                            throws IOException

Create a survey form.

Parameters:

body - Survey form (required)

Returns:

SurveyForm

Throws:

IOException - if the request fails to be processed

postQualityFormsSurveys

public SurveyForm postQualityFormsSurveys(PostQualityFormsSurveysRequest request)
                                   throws IOException,
ApiException

Create a survey form.

Parameters:

request - The request object

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityFormsSurveys

public ApiResponse<SurveyForm> postQualityFormsSurveys(ApiRequest<SurveyForm> request)
                                                throws IOException

Create a survey form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityProgramAgentscoringrules

public AgentScoringRule postQualityProgramAgentscoringrules(String programId,
 AgentScoringRule body)
                                                     throws IOException,
ApiException

Create an Agent Scoring Rule Creates a new Agent Scoring Rule for AI-powered automated evaluation of agent interactions. The rule defines how interactions should be selected and evaluated using the specified evaluation form.

Parameters:

programId - Program ID from Speech and Text Analytics (required)

body - Agent Scoring Rule (required)

Returns:

AgentScoringRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityProgramAgentscoringrulesWithHttpInfo

public ApiResponse<AgentScoringRule> postQualityProgramAgentscoringrulesWithHttpInfo(String programId,
 AgentScoringRule body)
                                                                              throws IOException

Create an Agent Scoring Rule Creates a new Agent Scoring Rule for AI-powered automated evaluation of agent interactions. The rule defines how interactions should be selected and evaluated using the specified evaluation form.

Parameters:

programId - Program ID from Speech and Text Analytics (required)

body - Agent Scoring Rule (required)

Returns:

AgentScoringRule

Throws:

IOException - if the request fails to be processed

postQualityProgramAgentscoringrules

public AgentScoringRule postQualityProgramAgentscoringrules(PostQualityProgramAgentscoringrulesRequest request)
                                                     throws IOException,
ApiException

Create an Agent Scoring Rule Creates a new Agent Scoring Rule for AI-powered automated evaluation of agent interactions. The rule defines how interactions should be selected and evaluated using the specified evaluation form.

Parameters:

request - The request object

Returns:

AgentScoringRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityProgramAgentscoringrules

public ApiResponse<AgentScoringRule> postQualityProgramAgentscoringrules(ApiRequest<AgentScoringRule> request)
                                                                  throws IOException

Create an Agent Scoring Rule Creates a new Agent Scoring Rule for AI-powered automated evaluation of agent interactions. The rule defines how interactions should be selected and evaluated using the specified evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityPublishedforms

public EvaluationFormResponse postQualityPublishedforms(PublishForm body)
                                                 throws IOException,
ApiException

Deprecated.

Publish an evaluation form.

Parameters:

body - Publish request containing id of form to publish (required)

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityPublishedformsWithHttpInfo

public ApiResponse<EvaluationFormResponse> postQualityPublishedformsWithHttpInfo(PublishForm body)
                                                                          throws IOException

Deprecated.

Publish an evaluation form.

Parameters:

body - Publish request containing id of form to publish (required)

Returns:

EvaluationFormResponse

Throws:

IOException - if the request fails to be processed

postQualityPublishedforms

public EvaluationFormResponse postQualityPublishedforms(PostQualityPublishedformsRequest request)
                                                 throws IOException,
ApiException

Deprecated.

Publish an evaluation form.

Parameters:

request - The request object

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityPublishedforms

public ApiResponse<EvaluationFormResponse> postQualityPublishedforms(ApiRequest<PublishForm> request)
                                                              throws IOException

Deprecated.

Publish an evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityPublishedformsEvaluations

public EvaluationFormResponse postQualityPublishedformsEvaluations(PublishForm body)
                                                            throws IOException,
ApiException

Publish an evaluation form.

Parameters:

body - Publish request containing id of form to publish (required)

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityPublishedformsEvaluationsWithHttpInfo

public ApiResponse<EvaluationFormResponse> postQualityPublishedformsEvaluationsWithHttpInfo(PublishForm body)
                                                                                     throws IOException

Publish an evaluation form.

Parameters:

body - Publish request containing id of form to publish (required)

Returns:

EvaluationFormResponse

Throws:

IOException - if the request fails to be processed

postQualityPublishedformsEvaluations

public EvaluationFormResponse postQualityPublishedformsEvaluations(PostQualityPublishedformsEvaluationsRequest request)
                                                            throws IOException,
ApiException

Publish an evaluation form.

Parameters:

request - The request object

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityPublishedformsEvaluations

public ApiResponse<EvaluationFormResponse> postQualityPublishedformsEvaluations(ApiRequest<PublishForm> request)
                                                                         throws IOException

Publish an evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualityPublishedformsSurveys

public SurveyForm postQualityPublishedformsSurveys(PublishForm body)
                                            throws IOException,
ApiException

Publish a survey form.

Parameters:

body - Survey form (required)

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityPublishedformsSurveysWithHttpInfo

public ApiResponse<SurveyForm> postQualityPublishedformsSurveysWithHttpInfo(PublishForm body)
                                                                     throws IOException

Publish a survey form.

Parameters:

body - Survey form (required)

Returns:

SurveyForm

Throws:

IOException - if the request fails to be processed

postQualityPublishedformsSurveys

public SurveyForm postQualityPublishedformsSurveys(PostQualityPublishedformsSurveysRequest request)
                                            throws IOException,
ApiException

Publish a survey form.

Parameters:

request - The request object

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualityPublishedformsSurveys

public ApiResponse<SurveyForm> postQualityPublishedformsSurveys(ApiRequest<PublishForm> request)
                                                         throws IOException

Publish a survey form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualitySurveys

public CreateSurveyResponse postQualitySurveys(CreateSurveyRequest body)
                                        throws IOException,
ApiException

Create a survey for a conversation

Parameters:

body - Survey creation request (required)

Returns:

CreateSurveyResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualitySurveysWithHttpInfo

public ApiResponse<CreateSurveyResponse> postQualitySurveysWithHttpInfo(CreateSurveyRequest body)
                                                                 throws IOException

Create a survey for a conversation

Parameters:

body - Survey creation request (required)

Returns:

CreateSurveyResponse

Throws:

IOException - if the request fails to be processed

postQualitySurveys

public CreateSurveyResponse postQualitySurveys(PostQualitySurveysRequest request)
                                        throws IOException,
ApiException

Create a survey for a conversation

Parameters:

request - The request object

Returns:

CreateSurveyResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualitySurveys

public ApiResponse<CreateSurveyResponse> postQualitySurveys(ApiRequest<CreateSurveyRequest> request)
                                                     throws IOException

Create a survey for a conversation

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postQualitySurveysScoring

public SurveyScoringSet postQualitySurveysScoring(SurveyFormAndScoringSet body)
                                           throws IOException,
ApiException

Score survey

Parameters:

body - surveyAndScoringSet (required)

Returns:

SurveyScoringSet

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualitySurveysScoringWithHttpInfo

public ApiResponse<SurveyScoringSet> postQualitySurveysScoringWithHttpInfo(SurveyFormAndScoringSet body)
                                                                    throws IOException

Score survey

Parameters:

body - surveyAndScoringSet (required)

Returns:

SurveyScoringSet

Throws:

IOException - if the request fails to be processed

postQualitySurveysScoring

public SurveyScoringSet postQualitySurveysScoring(PostQualitySurveysScoringRequest request)
                                           throws IOException,
ApiException

Score survey

Parameters:

request - The request object

Returns:

SurveyScoringSet

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postQualitySurveysScoring

public ApiResponse<SurveyScoringSet> postQualitySurveysScoring(ApiRequest<SurveyFormAndScoringSet> request)
                                                        throws IOException

Score survey

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putQualityCalibration

public Calibration putQualityCalibration(String calibrationId,
 Calibration body)
                                  throws IOException,
ApiException

Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex

Parameters:

calibrationId - Calibration ID (required)

body - Calibration (required)

Returns:

Calibration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityCalibrationWithHttpInfo

public ApiResponse<Calibration> putQualityCalibrationWithHttpInfo(String calibrationId,
 Calibration body)
                                                           throws IOException

Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex

Parameters:

calibrationId - Calibration ID (required)

body - Calibration (required)

Returns:

Calibration

Throws:

IOException - if the request fails to be processed

putQualityCalibration

public Calibration putQualityCalibration(PutQualityCalibrationRequest request)
                                  throws IOException,
ApiException

Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex

Parameters:

request - The request object

Returns:

Calibration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityCalibration

public ApiResponse<Calibration> putQualityCalibration(ApiRequest<Calibration> request)
                                               throws IOException

Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putQualityConversationEvaluation

public EvaluationResponse putQualityConversationEvaluation(String conversationId,
 String evaluationId,
 Evaluation body,
 String expand)
                                                    throws IOException,
ApiException

Update an evaluation The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.

Parameters:

conversationId - conversationId (required)

evaluationId - evaluationId (required)

body - evaluation (required)

expand - evaluatorId, evaluationForm, assignee, evaluator (optional)

Returns:

EvaluationResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityConversationEvaluationWithHttpInfo

public ApiResponse<EvaluationResponse> putQualityConversationEvaluationWithHttpInfo(String conversationId,
 String evaluationId,
 Evaluation body,
 String expand)
                                                                             throws IOException

Update an evaluation The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.

Parameters:

conversationId - conversationId (required)

evaluationId - evaluationId (required)

body - evaluation (required)

expand - evaluatorId, evaluationForm, assignee, evaluator (optional)

Returns:

EvaluationResponse

Throws:

IOException - if the request fails to be processed

putQualityConversationEvaluation

public EvaluationResponse putQualityConversationEvaluation(PutQualityConversationEvaluationRequest request)
                                                    throws IOException,
ApiException

Update an evaluation The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.

Parameters:

request - The request object

Returns:

EvaluationResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityConversationEvaluation

public ApiResponse<EvaluationResponse> putQualityConversationEvaluation(ApiRequest<Evaluation> request)
                                                                 throws IOException

Update an evaluation The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putQualityForm

public EvaluationFormResponse putQualityForm(String formId,
 EvaluationForm body)
                                      throws IOException,
ApiException

Deprecated.

Update an evaluation form.

Parameters:

formId - Form ID (required)

body - Evaluation form (required)

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityFormWithHttpInfo

public ApiResponse<EvaluationFormResponse> putQualityFormWithHttpInfo(String formId,
 EvaluationForm body)
                                                               throws IOException

Deprecated.

Update an evaluation form.

Parameters:

formId - Form ID (required)

body - Evaluation form (required)

Returns:

EvaluationFormResponse

Throws:

IOException - if the request fails to be processed

putQualityForm

public EvaluationFormResponse putQualityForm(PutQualityFormRequest request)
                                      throws IOException,
ApiException

Deprecated.

Update an evaluation form.

Parameters:

request - The request object

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityForm

public ApiResponse<EvaluationFormResponse> putQualityForm(ApiRequest<EvaluationForm> request)
                                                   throws IOException

Deprecated.

Update an evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putQualityFormsEvaluation

public EvaluationFormResponse putQualityFormsEvaluation(String formId,
 EvaluationForm body)
                                                 throws IOException,
ApiException

Update an evaluation form.

Parameters:

formId - Form ID (required)

body - Evaluation form (required)

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityFormsEvaluationWithHttpInfo

public ApiResponse<EvaluationFormResponse> putQualityFormsEvaluationWithHttpInfo(String formId,
 EvaluationForm body)
                                                                          throws IOException

Update an evaluation form.

Parameters:

formId - Form ID (required)

body - Evaluation form (required)

Returns:

EvaluationFormResponse

Throws:

IOException - if the request fails to be processed

putQualityFormsEvaluation

public EvaluationFormResponse putQualityFormsEvaluation(PutQualityFormsEvaluationRequest request)
                                                 throws IOException,
ApiException

Update an evaluation form.

Parameters:

request - The request object

Returns:

EvaluationFormResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityFormsEvaluation

public ApiResponse<EvaluationFormResponse> putQualityFormsEvaluation(ApiRequest<EvaluationForm> request)
                                                              throws IOException

Update an evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putQualityFormsEvaluationAiscoringSettings

public AiScoringSettings putQualityFormsEvaluationAiscoringSettings(String formId,
 AiScoringSettings body)
                                                             throws IOException,
ApiException

Update the AI Scoring settings of an evaluation form.

Parameters:

formId - Form ID (required)

body - AI Scoring Settings (required)

Returns:

AiScoringSettings

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityFormsEvaluationAiscoringSettingsWithHttpInfo

public ApiResponse<AiScoringSettings> putQualityFormsEvaluationAiscoringSettingsWithHttpInfo(String formId,
 AiScoringSettings body)
                                                                                      throws IOException

Update the AI Scoring settings of an evaluation form.

Parameters:

formId - Form ID (required)

body - AI Scoring Settings (required)

Returns:

AiScoringSettings

Throws:

IOException - if the request fails to be processed

putQualityFormsEvaluationAiscoringSettings

public AiScoringSettings putQualityFormsEvaluationAiscoringSettings(PutQualityFormsEvaluationAiscoringSettingsRequest request)
                                                             throws IOException,
ApiException

Update the AI Scoring settings of an evaluation form.

Parameters:

request - The request object

Returns:

AiScoringSettings

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityFormsEvaluationAiscoringSettings

public ApiResponse<AiScoringSettings> putQualityFormsEvaluationAiscoringSettings(ApiRequest<AiScoringSettings> request)
                                                                          throws IOException

Update the AI Scoring settings of an evaluation form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putQualityFormsSurvey

public SurveyForm putQualityFormsSurvey(String formId,
 SurveyForm body)
                                 throws IOException,
ApiException

Update a survey form.

Parameters:

formId - Form ID (required)

body - Survey form (required)

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityFormsSurveyWithHttpInfo

public ApiResponse<SurveyForm> putQualityFormsSurveyWithHttpInfo(String formId,
 SurveyForm body)
                                                          throws IOException

Update a survey form.

Parameters:

formId - Form ID (required)

body - Survey form (required)

Returns:

SurveyForm

Throws:

IOException - if the request fails to be processed

putQualityFormsSurvey

public SurveyForm putQualityFormsSurvey(PutQualityFormsSurveyRequest request)
                                 throws IOException,
ApiException

Update a survey form.

Parameters:

request - The request object

Returns:

SurveyForm

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityFormsSurvey

public ApiResponse<SurveyForm> putQualityFormsSurvey(ApiRequest<SurveyForm> request)
                                              throws IOException

Update a survey form.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putQualityProgramAgentscoringrule

public AgentScoringRule putQualityProgramAgentscoringrule(String programId,
 String ruleId,
 AgentScoringRule body)
                                                   throws IOException,
ApiException

Update an Agent Scoring Rule

Parameters:

programId - Program ID from Speech and Text Analytics (required)

ruleId - Agent Scoring Rule ID (required)

body - Agent Scoring Rule (required)

Returns:

AgentScoringRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityProgramAgentscoringruleWithHttpInfo

public ApiResponse<AgentScoringRule> putQualityProgramAgentscoringruleWithHttpInfo(String programId,
 String ruleId,
 AgentScoringRule body)
                                                                            throws IOException

Update an Agent Scoring Rule

Parameters:

programId - Program ID from Speech and Text Analytics (required)

ruleId - Agent Scoring Rule ID (required)

body - Agent Scoring Rule (required)

Returns:

AgentScoringRule

Throws:

IOException - if the request fails to be processed

putQualityProgramAgentscoringrule

public AgentScoringRule putQualityProgramAgentscoringrule(PutQualityProgramAgentscoringruleRequest request)
                                                   throws IOException,
ApiException

Update an Agent Scoring Rule

Parameters:

request - The request object

Returns:

AgentScoringRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualityProgramAgentscoringrule

public ApiResponse<AgentScoringRule> putQualityProgramAgentscoringrule(ApiRequest<AgentScoringRule> request)
                                                                throws IOException

Update an Agent Scoring Rule

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putQualitySurveysScorable

public ScorableSurvey putQualitySurveysScorable(String customerSurveyUrl,
 ScorableSurvey body)
                                         throws IOException,
ApiException

Update a survey as an end-customer, for the purposes of scoring it.

Parameters:

customerSurveyUrl - customerSurveyUrl (required)

body - survey (required)

Returns:

ScorableSurvey

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualitySurveysScorableWithHttpInfo

public ApiResponse<ScorableSurvey> putQualitySurveysScorableWithHttpInfo(String customerSurveyUrl,
 ScorableSurvey body)
                                                                  throws IOException

Update a survey as an end-customer, for the purposes of scoring it.

Parameters:

customerSurveyUrl - customerSurveyUrl (required)

body - survey (required)

Returns:

ScorableSurvey

Throws:

IOException - if the request fails to be processed

putQualitySurveysScorable

public ScorableSurvey putQualitySurveysScorable(PutQualitySurveysScorableRequest request)
                                         throws IOException,
ApiException

Update a survey as an end-customer, for the purposes of scoring it.

Parameters:

request - The request object

Returns:

ScorableSurvey

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putQualitySurveysScorable

public ApiResponse<ScorableSurvey> putQualitySurveysScorable(ApiRequest<ScorableSurvey> request)
                                                      throws IOException

Update a survey as an end-customer, for the purposes of scoring it.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed