npm - purecloud-platform-client-v2 - Versions diffs - 234.0.0 → 236.0.0 - Mend

purecloud-platform-client-v2 234.0.0 → 236.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (93) hide show

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

@@ -5,7 +5,7 @@ class LearningApi {
 	/**
 	 * Learning service.
 	 * @module purecloud-platform-client-v2/api/LearningApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 	/**
@@ -446,6 +446,31 @@ class LearningApi {
 		);
 	}
+	/**
+	 * Retrieve the status of the job for the slots where a learning activity can be scheduled.
+	 *
+	 * @param {String} jobId The ID of the job
+	 */
+	getLearningScheduleslotsJob(jobId) {
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null || jobId === '') {
+			throw 'Missing the required parameter "jobId" when calling getLearningScheduleslotsJob';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/learning/scheduleslots/jobs/{jobId}',
+			'GET',
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Get Learning SCORM Result
 	 *
@@ -889,6 +914,31 @@ class LearningApi {
 		);
 	}
+	/**
+	 * Start job to retrieve slots where a learning activity can be scheduled.
+	 *
+	 * @param {Object} body The slots search request
+	 */
+	postLearningScheduleslotsJobs(body) {
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postLearningScheduleslotsJobs';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/learning/scheduleslots/jobs',
+			'POST',
+			{  },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Get list of possible slots where a learning activity can be scheduled.
 	 *

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class ObjectsApi {
 	/**
 	 * Objects service.
 	 * @module purecloud-platform-client-v2/api/ObjectsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 	/**
@@ -181,7 +181,7 @@ class ObjectsApi {
 	 * @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.pageSize Number of entities to return. Maximum of 200.
+	 * @param {String} opts.pageSize Page size (max 200, default 25) (default to 25)
 	 * @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
 	 * @param {String} opts.name Optionally request specific divisions by division name
 	 */

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

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

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

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

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class ProcessAutomationApi {
 	/**
 	 * ProcessAutomation service.
 	 * @module purecloud-platform-client-v2/api/ProcessAutomationApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class QualityApi {
 	/**
 	 * Quality service.
 	 * @module purecloud-platform-client-v2/api/QualityApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 	/**
@@ -1069,59 +1069,6 @@ class QualityApi {
 		);
 	}
-	/**
-	 * Get the most recent published version of an evaluation form across any division.
-	 *
-	 * @param {String} evaluationFormId Evaluation Form ID
-	 * getQualityPublishedformsEvaluationsDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-	 */
-	getQualityPublishedformsEvaluationsDivisionview(evaluationFormId) {
-		// verify the required parameter 'evaluationFormId' is set
-		if (evaluationFormId === undefined || evaluationFormId === null || evaluationFormId === '') {
-			throw 'Missing the required parameter "evaluationFormId" when calling getQualityPublishedformsEvaluationsDivisionview';
-		}
-		return this.apiClient.callApi(
-			'/api/v2/quality/publishedforms/evaluations/divisionviews/{evaluationFormId}',
-			'GET',
-			{ 'evaluationFormId': evaluationFormId },
-			{  },
-			{  },
-			{  },
-			null,
-			['PureCloud OAuth'],
-			['application/json'],
-			['application/json']
-		);
-	}
-	/**
-	 * Get the published evaluation forms across any division.
-	 *
-	 * @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.name Name
-	 * getQualityPublishedformsEvaluationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-	 */
-	getQualityPublishedformsEvaluationsDivisionviews(opts) {
-		opts = opts || {};
-		return this.apiClient.callApi(
-			'/api/v2/quality/publishedforms/evaluations/divisionviews',
-			'GET',
-			{  },
-			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
-			{  },
-			{  },
-			null,
-			['PureCloud OAuth'],
-			['application/json'],
-			['application/json']
-		);
-	}
 	/**
 	 * Get the most recent published version of a survey form.
 	 *
@@ -1174,59 +1121,6 @@ class QualityApi {
 		);
 	}
-	/**
-	 * Get the most recent published version of an enabled survey form across any division.
-	 *
-	 * @param {String} surveyFormId Survey Form ID
-	 * getQualityPublishedformsSurveysDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-	 */
-	getQualityPublishedformsSurveysDivisionview(surveyFormId) {
-		// verify the required parameter 'surveyFormId' is set
-		if (surveyFormId === undefined || surveyFormId === null || surveyFormId === '') {
-			throw 'Missing the required parameter "surveyFormId" when calling getQualityPublishedformsSurveysDivisionview';
-		}
-		return this.apiClient.callApi(
-			'/api/v2/quality/publishedforms/surveys/divisionviews/{surveyFormId}',
-			'GET',
-			{ 'surveyFormId': surveyFormId },
-			{  },
-			{  },
-			{  },
-			null,
-			['PureCloud OAuth'],
-			['application/json'],
-			['application/json']
-		);
-	}
-	/**
-	 * Get the published and enabled survey forms across any division.
-	 *
-	 * @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.name Name
-	 * getQualityPublishedformsSurveysDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-	 */
-	getQualityPublishedformsSurveysDivisionviews(opts) {
-		opts = opts || {};
-		return this.apiClient.callApi(
-			'/api/v2/quality/publishedforms/surveys/divisionviews',
-			'GET',
-			{  },
-			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
-			{  },
-			{  },
-			null,
-			['PureCloud OAuth'],
-			['application/json'],
-			['application/json']
-		);
-	}
 	/**
 	 * Get a survey for a conversation
 	 *

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

@@ -5,7 +5,7 @@ class RecordingApi {
 	/**
 	 * Recording service.
 	 * @module purecloud-platform-client-v2/api/RecordingApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 	/**

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class ScreenRecordingApi {
 	/**
 	 * ScreenRecording service.
 	 * @module purecloud-platform-client-v2/api/ScreenRecordingApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 	/**

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

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

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

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

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

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

package/src/purecloud-platform-client-v2/api/SocialMediaApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class SocialMediaApi {
 	/**
 	 * SocialMedia service.
 	 * @module purecloud-platform-client-v2/api/SocialMediaApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 	/**

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

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

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

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

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

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

package/src/purecloud-platform-client-v2/api/TaskManagementApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class TaskManagementApi {
 	/**
 	 * TaskManagement service.
 	 * @module purecloud-platform-client-v2/api/TaskManagementApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/TeamsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class TeamsApi {
 	/**
 	 * Teams service.
 	 * @module purecloud-platform-client-v2/api/TeamsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 	/**

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

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

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

@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
 	/**
 	 * TelephonyProvidersEdge service.
 	 * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 	/**

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class WorkforceManagementApi {
 	/**
 	 * WorkforceManagement service.
 	 * @module purecloud-platform-client-v2/api/WorkforceManagementApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 	/**
@@ -2405,6 +2405,7 @@ class WorkforceManagementApi {
 	 * @param {String} forecastId The ID of the forecast
 	 * @param {Object} opts Optional parameters
 	 * @param {Array.<String>} opts.weekNumbers The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified
+	 * @param {Array.<String>} opts.expand Expand to include minimum staffing values in (staffing requirement response or applied to base staffing requirement values)
 	 */
 	getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId, weekDateId, forecastId, opts) {
 		opts = opts || {};
@@ -2426,7 +2427,7 @@ class WorkforceManagementApi {
 			'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement',
 			'GET',
 			{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
-			{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi') },
+			{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
 			{  },
 			{  },
 			null,