purecloud-platform-client-v2 194.0.0 → 195.0.0

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**
@@ -99,6 +99,41 @@ class LearningApi {
 		);
 	}
 
+	/**
+	 * Get Learning Assignment Step
+	 * Permission not required if you are the assigned user of the learning assignment
+	 * @param {String} assignmentId The ID of Learning Assignment
+	 * @param {String} stepId The ID of Learning Assignment Step
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.shareableContentObjectId The ID of SCO to load
+	 * @param {Array.<String>} opts.expand Fields to expand in response
+	 */
+	getLearningAssignmentStep(assignmentId, stepId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'assignmentId' is set
+		if (assignmentId === undefined || assignmentId === null) {
+			throw 'Missing the required parameter "assignmentId" when calling getLearningAssignmentStep';
+		}
+		// verify the required parameter 'stepId' is set
+		if (stepId === undefined || stepId === null) {
+			throw 'Missing the required parameter "stepId" when calling getLearningAssignmentStep';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}', 
+			'GET', 
+			{ 'assignmentId': assignmentId,'stepId': stepId },
+			{ 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * List of Learning module Assignments
 	 * Either moduleId or user value is required
@@ -233,6 +268,31 @@ class LearningApi {
 		);
 	}
 
+	/**
+	 * Get a learning module preview
+	 * 
+	 * @param {String} moduleId The ID of the learning module
+	 */
+	getLearningModulePreview(moduleId) { 
+		// verify the required parameter 'moduleId' is set
+		if (moduleId === undefined || moduleId === null) {
+			throw 'Missing the required parameter "moduleId" when calling getLearningModulePreview';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/learning/modules/{moduleId}/preview', 
+			'GET', 
+			{ 'moduleId': moduleId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a learning module rule
 	 * 
@@ -385,6 +445,31 @@ class LearningApi {
 		);
 	}
 
+	/**
+	 * Get Learning SCORM Result
+	 * 
+	 * @param {String} scormId The ID of the SCORM package
+	 */
+	getLearningScormScormId(scormId) { 
+		// verify the required parameter 'scormId' is set
+		if (scormId === undefined || scormId === null) {
+			throw 'Missing the required parameter "scormId" when calling getLearningScormScormId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/learning/scorm/{scormId}', 
+			'GET', 
+			{ 'scormId': scormId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update Learning Assignment
 	 * 
@@ -443,6 +528,40 @@ class LearningApi {
 		);
 	}
 
+	/**
+	 * Update Learning Assignment Step
+	 * Permission not required if you are the assigned user of the learning assignment
+	 * @param {String} assignmentId The ID of Learning Assignment
+	 * @param {String} stepId The ID of Learning Assignment Step
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body The Learning Assignment Step to be updated
+	 */
+	patchLearningAssignmentStep(assignmentId, stepId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'assignmentId' is set
+		if (assignmentId === undefined || assignmentId === null) {
+			throw 'Missing the required parameter "assignmentId" when calling patchLearningAssignmentStep';
+		}
+		// verify the required parameter 'stepId' is set
+		if (stepId === undefined || stepId === null) {
+			throw 'Missing the required parameter "stepId" when calling patchLearningAssignmentStep';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}', 
+			'PATCH', 
+			{ 'assignmentId': assignmentId,'stepId': stepId },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update an external assignment for a specific user
 	 * 
@@ -794,6 +913,30 @@ class LearningApi {
 		);
 	}
 
+	/**
+	 * Create a SCORM package upload request
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body The SCORM package to be uploaded
+	 */
+	postLearningScorm(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/learning/scorm', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update a learning module
 	 * This will update the name, description, completion time in days and inform steps for a learning module
@@ -824,6 +967,36 @@ class LearningApi {
 		);
 	}
 
+	/**
+	 * Update a learning module preview
+	 * This will update a learning module preview
+	 * @param {String} moduleId The ID of the learning module
+	 * @param {Object} body The learning module to be updated
+	 */
+	putLearningModulePreview(moduleId, body) { 
+		// verify the required parameter 'moduleId' is set
+		if (moduleId === undefined || moduleId === null) {
+			throw 'Missing the required parameter "moduleId" when calling putLearningModulePreview';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putLearningModulePreview';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/learning/modules/{moduleId}/preview', 
+			'PUT', 
+			{ 'moduleId': moduleId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update a learning module rule
 	 * This will update a learning module rule with the specified fields.

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LogCaptureApi {
 	/**
 	 * LogCapture service.
 	 * @module purecloud-platform-client-v2/api/LogCaptureApi
-	 * @version 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OperationalEventsApi {
 	/**
 	 * OperationalEvents service.
 	 * @module purecloud-platform-client-v2/api/OperationalEventsApi
-	 * @version 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ProcessAutomationApi {
 	/**
 	 * ProcessAutomation service.
 	 * @module purecloud-platform-client-v2/api/ProcessAutomationApi
-	 * @version 194.0.0
+	 * @version 195.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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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 194.0.0
+	 * @version 195.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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**
@@ -466,7 +466,6 @@ class RoutingApi {
 	 * @param {String} labelId Utilization Label ID
 	 * @param {Object} opts Optional parameters
 	 * @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
-	 * deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	deleteRoutingUtilizationLabel(labelId, opts) { 
 		opts = opts || {};
@@ -1985,7 +1984,6 @@ class RoutingApi {
 	 * Get details about this utilization label
 	 * 
 	 * @param {String} labelId Utilization Label ID
-	 * getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getRoutingUtilizationLabel(labelId) { 
 		// verify the required parameter 'labelId' is set
@@ -2011,7 +2009,6 @@ class RoutingApi {
 	 * Get list of agent ids associated with a utilization label
 	 * 
 	 * @param {String} labelId Utilization Label ID
-	 * getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getRoutingUtilizationLabelAgents(labelId) { 
 		// verify the required parameter 'labelId' is set
@@ -2041,7 +2038,6 @@ class RoutingApi {
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Object} opts.sortOrder Sort order by name (default to ascending)
 	 * @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
-	 * getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getRoutingUtilizationLabels(opts) { 
 		opts = opts || {};
@@ -3464,7 +3460,6 @@ class RoutingApi {
 	 * Create a utilization label
 	 * 
 	 * @param {Object} body UtilizationLabel
-	 * postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postRoutingUtilizationLabels(body) { 
 		// verify the required parameter 'body' is set
@@ -3857,7 +3852,6 @@ class RoutingApi {
 	 * 
 	 * @param {String} labelId Utilization Label ID
 	 * @param {Object} body UtilizationLabel
-	 * putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	putRoutingUtilizationLabel(labelId, body) { 
 		// verify the required parameter 'labelId' is set

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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ScreenRecordingApi {
 	/**
 	 * ScreenRecording service.
 	 * @module purecloud-platform-client-v2/api/ScreenRecordingApi
-	 * @version 194.0.0
+	 * @version 195.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 194.0.0
+	 * @version 195.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 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class SettingsApi {
 	/**
 	 * Settings service.
 	 * @module purecloud-platform-client-v2/api/SettingsApi
-	 * @version 194.0.0
+	 * @version 195.0.0
 	 */
 
 	/**