purecloud-platform-client-v2 138.0.1 → 140.0.1

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

@@ -5,7 +5,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**
@@ -150,7 +150,7 @@ class GamificationApi {
 
 	/**
 	 * Gamified metric by id
-	 * 
+	 * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
 	 * @param {String} metricId metric Id
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
@@ -225,7 +225,7 @@ class GamificationApi {
 
 	/**
 	 * All gamified metrics for a given profile
-	 * 
+	 * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
 	 * @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
@@ -276,18 +276,18 @@ class GamificationApi {
 	/**
 	 * Members of a given performance profile
 	 * 
-	 * @param {String} performanceProfileId Performance Profile Id
+	 * @param {String} profileId Profile Id
 	 */
-	getGamificationProfileMembers(performanceProfileId) { 
-		// verify the required parameter 'performanceProfileId' is set
-		if (performanceProfileId === undefined || performanceProfileId === null) {
-			throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
+	getGamificationProfileMembers(profileId) { 
+		// verify the required parameter 'profileId' is set
+		if (profileId === undefined || profileId === null) {
+			throw 'Missing the required parameter "profileId" when calling getGamificationProfileMembers';
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/gamification/profiles/{performanceProfileId}/members', 
+			'/api/v2/gamification/profiles/{profileId}/members', 
 			'GET', 
-			{ 'performanceProfileId': performanceProfileId },
+			{ 'profileId': profileId },
 			{  },
 			{  },
 			{  },
@@ -339,6 +339,7 @@ class GamificationApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Array.<String>} opts.expand Which fields, if any, to expand.
 	 * @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {String} opts.metricIds List of metric ids to filter the response (Optional, comma-separated).
 	 */
 	getGamificationProfileMetrics(profileId, opts) { 
 		opts = opts || {};
@@ -352,7 +353,7 @@ class GamificationApi {
 			'/api/v2/gamification/profiles/{profileId}/metrics', 
 			'GET', 
 			{ 'profileId': profileId },
-			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'] },
+			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'],'metricIds': opts['metricIds'] },
 			{  },
 			{  },
 			null, 
@@ -1079,7 +1080,7 @@ class GamificationApi {
 
 	/**
 	 * Creates a gamified metric with a given metric definition and metric objective
-	 * 
+	 * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
 	 * @param {Object} body Metric
 	 */
 	postGamificationMetrics(body) { 
@@ -1155,13 +1156,13 @@ class GamificationApi {
 	/**
 	 * Assign members to a given performance profile
 	 * 
-	 * @param {String} performanceProfileId Performance Profile Id
+	 * @param {String} profileId Profile Id
 	 * @param {Object} body assignUsers
 	 */
-	postGamificationProfileMembers(performanceProfileId, body) { 
-		// verify the required parameter 'performanceProfileId' is set
-		if (performanceProfileId === undefined || performanceProfileId === null) {
-			throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
+	postGamificationProfileMembers(profileId, body) { 
+		// verify the required parameter 'profileId' is set
+		if (profileId === undefined || profileId === null) {
+			throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembers';
 		}
 		// verify the required parameter 'body' is set
 		if (body === undefined || body === null) {
@@ -1169,9 +1170,9 @@ class GamificationApi {
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/gamification/profiles/{performanceProfileId}/members', 
+			'/api/v2/gamification/profiles/{profileId}/members', 
 			'POST', 
-			{ 'performanceProfileId': performanceProfileId },
+			{ 'profileId': profileId },
 			{  },
 			{  },
 			{  },
@@ -1185,13 +1186,13 @@ class GamificationApi {
 	/**
 	 * Validate member assignment
 	 * 
-	 * @param {String} performanceProfileId Performance Profile Id
+	 * @param {String} profileId Profile Id
 	 * @param {Object} body memberAssignments
 	 */
-	postGamificationProfileMembersValidate(performanceProfileId, body) { 
-		// verify the required parameter 'performanceProfileId' is set
-		if (performanceProfileId === undefined || performanceProfileId === null) {
-			throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
+	postGamificationProfileMembersValidate(profileId, body) { 
+		// verify the required parameter 'profileId' is set
+		if (profileId === undefined || profileId === null) {
+			throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';
 		}
 		// verify the required parameter 'body' is set
 		if (body === undefined || body === null) {
@@ -1199,9 +1200,9 @@ class GamificationApi {
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/gamification/profiles/{performanceProfileId}/members/validate', 
+			'/api/v2/gamification/profiles/{profileId}/members/validate', 
 			'POST', 
-			{ 'performanceProfileId': performanceProfileId },
+			{ 'profileId': profileId },
 			{  },
 			{  },
 			{  },
@@ -1308,7 +1309,7 @@ class GamificationApi {
 
 	/**
 	 * Updates a metric
-	 * 
+	 * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
 	 * @param {String} metricId metric Id
 	 * @param {Object} body Metric
 	 * @param {Object} opts Optional parameters

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

@@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi {
 	/**
 	 * GeneralDataProtectionRegulation service.
 	 * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GeolocationApi {
 	/**
 	 * Geolocation service.
 	 * @module purecloud-platform-client-v2/api/GeolocationApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GreetingsApi {
 	/**
 	 * Greetings service.
 	 * @module purecloud-platform-client-v2/api/GreetingsApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GroupsApi {
 	/**
 	 * Groups service.
 	 * @module purecloud-platform-client-v2/api/GroupsApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class IdentityProviderApi {
 	/**
 	 * IdentityProvider service.
 	 * @module purecloud-platform-client-v2/api/IdentityProviderApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class JourneyApi {
 	/**
 	 * Journey service.
 	 * @module purecloud-platform-client-v2/api/JourneyApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class KnowledgeApi {
 	/**
 	 * Knowledge service.
 	 * @module purecloud-platform-client-v2/api/KnowledgeApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**
@@ -183,7 +183,7 @@ class KnowledgeApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
 	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
-	 * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
+	 * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
 	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
 	 * @param {String} opts.name Filter to return the categories that starts with the given category name.
 	 */
@@ -291,7 +291,7 @@ class KnowledgeApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
 	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
-	 * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
+	 * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
 	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
 	 * @param {String} opts.categories Filter by categories ids, comma separated values expected.
 	 * @param {String} opts.title Filter by document title.
@@ -403,7 +403,7 @@ class KnowledgeApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
 	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
-	 * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
+	 * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
 	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
 	 * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
 	 */
@@ -439,7 +439,7 @@ class KnowledgeApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
 	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
-	 * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
+	 * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
 	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
 	 * @param {String} opts.name Filter by Name.
 	 * @param {Object} opts.coreLanguage Filter by core language.

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

@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
 	/**
 	 * LanguageUnderstanding service.
 	 * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LanguagesApi {
 	/**
 	 * Languages service.
 	 * @module purecloud-platform-client-v2/api/LanguagesApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LearningApi {
 	/**
 	 * Learning service.
 	 * @module purecloud-platform-client-v2/api/LearningApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**
@@ -203,6 +203,36 @@ class LearningApi {
 		);
 	}
 
+	/**
+	 * Get a specific Learning Module job status
+	 * 
+	 * @param {String} moduleId The ID of the learning module
+	 * @param {String} jobId The ID of the learning module job
+	 */
+	getLearningModuleJob(moduleId, jobId) { 
+		// verify the required parameter 'moduleId' is set
+		if (moduleId === undefined || moduleId === null) {
+			throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
+		}
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getLearningModuleJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/learning/modules/{moduleId}/jobs/{jobId}', 
+			'GET', 
+			{ 'moduleId': moduleId,'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a learning module rule
 	 * 
@@ -348,6 +378,56 @@ class LearningApi {
 		);
 	}
 
+	/**
+	 * Reassign Learning Assignment
+	 * This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
+	 * @param {String} assignmentId The Learning Assignment ID
+	 */
+	postLearningAssignmentReassign(assignmentId) { 
+		// verify the required parameter 'assignmentId' is set
+		if (assignmentId === undefined || assignmentId === null) {
+			throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/learning/assignments/{assignmentId}/reassign', 
+			'POST', 
+			{ 'assignmentId': assignmentId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Reset Learning Assignment
+	 * This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
+	 * @param {String} assignmentId The Learning Assignment ID
+	 */
+	postLearningAssignmentReset(assignmentId) { 
+		// verify the required parameter 'assignmentId' is set
+		if (assignmentId === undefined || assignmentId === null) {
+			throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/learning/assignments/{assignmentId}/reset', 
+			'POST', 
+			{ 'assignmentId': assignmentId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Create Learning Assignment
 	 * 
@@ -445,6 +525,36 @@ class LearningApi {
 		);
 	}
 
+	/**
+	 * Starts a specified operation on learning module
+	 * This will initiate operation specified in the request body for a learning module
+	 * @param {String} moduleId The ID of the learning module
+	 * @param {Object} body The learning module job request
+	 */
+	postLearningModuleJobs(moduleId, body) { 
+		// verify the required parameter 'moduleId' is set
+		if (moduleId === undefined || moduleId === null) {
+			throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/learning/modules/{moduleId}/jobs', 
+			'POST', 
+			{ 'moduleId': moduleId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Publish a Learning module
 	 * 

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

@@ -5,7 +5,7 @@ class LicenseApi {
 	/**
 	 * License service.
 	 * @module purecloud-platform-client-v2/api/LicenseApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LocationsApi {
 	/**
 	 * Locations service.
 	 * @module purecloud-platform-client-v2/api/LocationsApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class MessagingApi {
 	/**
 	 * Messaging service.
 	 * @module purecloud-platform-client-v2/api/MessagingApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class MobileDevicesApi {
 	/**
 	 * MobileDevices service.
 	 * @module purecloud-platform-client-v2/api/MobileDevicesApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class NotificationsApi {
 	/**
 	 * Notifications service.
 	 * @module purecloud-platform-client-v2/api/NotificationsApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OAuthApi {
 	/**
 	 * OAuth service.
 	 * @module purecloud-platform-client-v2/api/OAuthApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ObjectsApi {
 	/**
 	 * Objects service.
 	 * @module purecloud-platform-client-v2/api/ObjectsApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OrganizationApi {
 	/**
 	 * Organization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
 	/**
 	 * OrganizationAuthorization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OutboundApi {
 	/**
 	 * Outbound service.
 	 * @module purecloud-platform-client-v2/api/OutboundApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class PresenceApi {
 	/**
 	 * Presence service.
 	 * @module purecloud-platform-client-v2/api/PresenceApi
-	 * @version 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**
@@ -763,7 +763,7 @@ class QualityApi {
 	/**
 	 * Retrieve a list of the latest form versions by context ids
 	 * 
-	 * @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids
+	 * @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100.
 	 * @param {Object} opts Optional parameters
 	 * @param {Boolean} opts.published If true, the latest published version will be included. If false, only the unpublished version will be included. (default to true)
 	 */

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 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**

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 138.0.1
+	 * @version 140.0.1
 	 */
 
 	/**