purecloud-platform-client-v2 131.0.0 → 133.0.0

package/src/purecloud-platform-client-v2/api/QualityApi.js

@@ -5,7 +5,7 @@ class QualityApi {
 	/**
 	 * Quality service.
 	 * @module purecloud-platform-client-v2/api/QualityApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**
@@ -56,7 +56,7 @@ class QualityApi {
 	 * @param {String} conversationId conversationId
 	 * @param {String} evaluationId evaluationId
 	 * @param {Object} opts Optional parameters
-	 * @param {String} opts.expand evaluatorId
+	 * @param {String} opts.expand evaluatorId, evaluationForm
 	 */
 	deleteQualityConversationEvaluation(conversationId, evaluationId, opts) { 
 		opts = opts || {};
@@ -161,7 +161,7 @@ class QualityApi {
 
 	/**
 	 * Gets a list of Agent Activities
-	 * Includes the number of evaluations and average evaluation score. These statistics include released evaluations only when evaluatorUserId is provided. In the absence of evaluatorUserId in the request, the api excludes evaluations which are set to never release for the calculation of evaluation statistics. 
+	 * 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
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageSize The total page size requested (default to 25)
 	 * @param {Number} opts.pageNumber The page number requested (default to 1)
@@ -624,6 +624,31 @@ class QualityApi {
 		);
 	}
 
+	/**
+	 * Retrieve a list of the latest published evaluation form versions by context ids
+	 * 
+	 * @param {Array.<String>} contextId A comma-delimited list of valid evaluation form context ids
+	 */
+	getQualityFormsEvaluationsBulkContexts(contextId) { 
+		// verify the required parameter 'contextId' is set
+		if (contextId === undefined || contextId === null) {
+			throw 'Missing the required parameter "contextId" when calling getQualityFormsEvaluationsBulkContexts';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/quality/forms/evaluations/bulk/contexts', 
+			'GET', 
+			{  }, 
+			{ 'contextId': this.apiClient.buildCollectionParam(contextId, 'multi') }, 
+			{  }, 
+			{  }, 
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a survey form
 	 * 
@@ -1138,6 +1163,31 @@ class QualityApi {
 		);
 	}
 
+	/**
+	 * Query for evaluation aggregates for the current user
+	 * 
+	 * @param {Object} body query
+	 */
+	postQualityEvaluationsAggregatesQueryMe(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postQualityEvaluationsAggregatesQueryMe';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/quality/evaluations/aggregates/query/me', 
+			'POST', 
+			{  }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Score evaluation
 	 * 
@@ -1375,7 +1425,7 @@ class QualityApi {
 	 * @param {String} evaluationId evaluationId
 	 * @param {Object} body evaluation
 	 * @param {Object} opts Optional parameters
-	 * @param {String} opts.expand evaluatorId
+	 * @param {String} opts.expand evaluatorId, evaluationForm
 	 */
 	putQualityConversationEvaluation(conversationId, evaluationId, body, opts) { 
 		opts = opts || {};

package/src/purecloud-platform-client-v2/api/RecordingApi.js

@@ -5,7 +5,7 @@ class RecordingApi {
 	/**
 	 * Recording service.
 	 * @module purecloud-platform-client-v2/api/RecordingApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**
@@ -218,6 +218,7 @@ class RecordingApi {
 	 * @param {Boolean} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
 	 * @param {String} opts.fileName the name of the downloaded fileName
 	 * @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
+	 * @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
 	 */
 	getConversationRecording(conversationId, recordingId, opts) { 
 		opts = opts || {};
@@ -235,7 +236,7 @@ class RecordingApi {
 			'/api/v2/conversations/{conversationId}/recordings/{recordingId}', 
 			'GET', 
 			{ 'conversationId': conversationId,'recordingId': recordingId }, 
-			{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'] }, 
+			{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') }, 
 			{  }, 
 			{  }, 
 			null, 
@@ -371,7 +372,8 @@ class RecordingApi {
 	 * @param {String} conversationId Conversation ID
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
-	 * @param {Object} opts.formatId The desired media format . Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
+	 * @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
+	 * @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
 	 */
 	getConversationRecordings(conversationId, opts) { 
 		opts = opts || {};
@@ -385,7 +387,7 @@ class RecordingApi {
 			'/api/v2/conversations/{conversationId}/recordings', 
 			'GET', 
 			{ 'conversationId': conversationId }, 
-			{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'] }, 
+			{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') }, 
 			{  }, 
 			{  }, 
 			null, 
@@ -432,6 +434,7 @@ class RecordingApi {
 	 * @param {Boolean} opts.download requesting a download format of the recording (default to false)
 	 * @param {String} opts.fileName the name of the downloaded fileName
 	 * @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
+	 * @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
 	 */
 	getOrphanrecordingMedia(orphanId, opts) { 
 		opts = opts || {};
@@ -445,7 +448,7 @@ class RecordingApi {
 			'/api/v2/orphanrecordings/{orphanId}/media', 
 			'GET', 
 			{ 'orphanId': orphanId }, 
-			{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'] }, 
+			{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') }, 
 			{  }, 
 			{  }, 
 			null, 

package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js

@@ -5,7 +5,7 @@ class ResponseManagementApi {
 	/**
 	 * ResponseManagement service.
 	 * @module purecloud-platform-client-v2/api/ResponseManagementApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/RoutingApi.js

@@ -5,7 +5,7 @@ class RoutingApi {
 	/**
 	 * Routing service.
 	 * @module purecloud-platform-client-v2/api/RoutingApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/SCIMApi.js

@@ -5,7 +5,7 @@ class SCIMApi {
 	/**
 	 * SCIM service.
 	 * @module purecloud-platform-client-v2/api/SCIMApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/ScriptsApi.js

@@ -5,7 +5,7 @@ class ScriptsApi {
 	/**
 	 * Scripts service.
 	 * @module purecloud-platform-client-v2/api/ScriptsApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/SearchApi.js

@@ -5,7 +5,7 @@ class SearchApi {
 	/**
 	 * Search service.
 	 * @module purecloud-platform-client-v2/api/SearchApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js

@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
 	/**
 	 * SpeechTextAnalytics service.
 	 * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/StationsApi.js

@@ -5,7 +5,7 @@ class StationsApi {
 	/**
 	 * Stations service.
 	 * @module purecloud-platform-client-v2/api/StationsApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/SuggestApi.js

@@ -5,7 +5,7 @@ class SuggestApi {
 	/**
 	 * Suggest service.
 	 * @module purecloud-platform-client-v2/api/SuggestApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/TelephonyApi.js

@@ -5,7 +5,7 @@ class TelephonyApi {
 	/**
 	 * Telephony service.
 	 * @module purecloud-platform-client-v2/api/TelephonyApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js

@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
 	/**
 	 * TelephonyProvidersEdge service.
 	 * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**
@@ -1419,7 +1419,7 @@ class TelephonyProvidersEdgeApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageSize Page size (default to 25)
 	 * @param {Number} opts.pageNumber Page number (default to 1)
-	 * @param {String} opts.sortBy Sort by (default to startNumber)
+	 * @param {String} opts.sortBy Sort by
 	 * @param {String} opts._number Number
 	 */
 	getTelephonyProvidersEdgesExtensionpools(opts) { 

package/src/purecloud-platform-client-v2/api/TextbotsApi.js

@@ -5,7 +5,7 @@ class TextbotsApi {
 	/**
 	 * Textbots service.
 	 * @module purecloud-platform-client-v2/api/TextbotsApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/TokensApi.js

@@ -5,7 +5,7 @@ class TokensApi {
 	/**
 	 * Tokens service.
 	 * @module purecloud-platform-client-v2/api/TokensApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/UploadsApi.js

@@ -5,7 +5,7 @@ class UploadsApi {
 	/**
 	 * Uploads service.
 	 * @module purecloud-platform-client-v2/api/UploadsApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/UsageApi.js

@@ -5,7 +5,7 @@ class UsageApi {
 	/**
 	 * Usage service.
 	 * @module purecloud-platform-client-v2/api/UsageApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js

@@ -5,7 +5,7 @@ class UserRecordingsApi {
 	/**
 	 * UserRecordings service.
 	 * @module purecloud-platform-client-v2/api/UserRecordingsApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/UsersApi.js

@@ -5,7 +5,7 @@ class UsersApi {
 	/**
 	 * Users service.
 	 * @module purecloud-platform-client-v2/api/UsersApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/UtilitiesApi.js

@@ -5,7 +5,7 @@ class UtilitiesApi {
 	/**
 	 * Utilities service.
 	 * @module purecloud-platform-client-v2/api/UtilitiesApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/VoicemailApi.js

@@ -5,7 +5,7 @@ class VoicemailApi {
 	/**
 	 * Voicemail service.
 	 * @module purecloud-platform-client-v2/api/VoicemailApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/WebChatApi.js

@@ -5,7 +5,7 @@ class WebChatApi {
 	/**
 	 * WebChat service.
 	 * @module purecloud-platform-client-v2/api/WebChatApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js

@@ -5,7 +5,7 @@ class WebDeploymentsApi {
 	/**
 	 * WebDeployments service.
 	 * @module purecloud-platform-client-v2/api/WebDeploymentsApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/WebMessagingApi.js

@@ -5,7 +5,7 @@ class WebMessagingApi {
 	/**
 	 * WebMessaging service.
 	 * @module purecloud-platform-client-v2/api/WebMessagingApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/WidgetsApi.js

@@ -5,7 +5,7 @@ class WidgetsApi {
 	/**
 	 * Widgets service.
 	 * @module purecloud-platform-client-v2/api/WidgetsApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js

@@ -5,7 +5,7 @@ class WorkforceManagementApi {
 	/**
 	 * WorkforceManagement service.
 	 * @module purecloud-platform-client-v2/api/WorkforceManagementApi
-	 * @version 131.0.0
+	 * @version 133.0.0
 	 */
 
 	/**
@@ -2106,7 +2106,7 @@ class WorkforceManagementApi {
 
 	/**
 	 * Get a list of notifications for the current user
-	 * 
+	 * Notifications are only initially sent if you have the relevant Notify and Edit permissions
 	 */
 	getWorkforcemanagementNotifications() { 
 

package/src/purecloud-platform-client-v2/index.js

@@ -94,7 +94,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
  * </pre>
  * </p>
  * @module purecloud-platform-client-v2/index
- * @version 131.0.0
+ * @version 133.0.0
  */
 class platformClient {
 	constructor() {