purecloud-platform-client-v2 189.1.0 → 190.0.0

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 189.1.0
+	 * @version 190.0.0
 	 */
 
 	/**
@@ -855,6 +855,109 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Get the job for a journey view version.
+	 * used for long descriptions
+	 * @param {String} viewId Journey View Id
+	 * @param {String} journeyVersionId Journey View Version
+	 * @param {String} jobId JobId
+	 * getJourneyViewVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getJourneyViewVersionJob(viewId, journeyVersionId, jobId) { 
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJob';
+		}
+		// verify the required parameter 'journeyVersionId' is set
+		if (journeyVersionId === undefined || journeyVersionId === null) {
+			throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJob';
+		}
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}', 
+			'GET', 
+			{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get the result of a job for a journey view version.
+	 * used for long descriptions
+	 * @param {String} viewId JourneyViewResult id
+	 * @param {String} journeyViewVersion Journey View Version
+	 * @param {String} jobId Id of the executing job
+	 * getJourneyViewVersionJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getJourneyViewVersionJobResults(viewId, journeyViewVersion, jobId) { 
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';
+		}
+		// verify the required parameter 'journeyViewVersion' is set
+		if (journeyViewVersion === undefined || journeyViewVersion === null) {
+			throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';
+		}
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results', 
+			'GET', 
+			{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get the latest job of a journey view version.
+	 * used for long descriptions
+	 * @param {String} viewId Journey View Id
+	 * @param {String} journeyVersionId Journey View Version
+	 * getJourneyViewVersionJobsLatest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getJourneyViewVersionJobsLatest(viewId, journeyVersionId) { 
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobsLatest';
+		}
+		// verify the required parameter 'journeyVersionId' is set
+		if (journeyVersionId === undefined || journeyVersionId === null) {
+			throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobsLatest';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest', 
+			'GET', 
+			{ 'viewId': viewId,'journeyVersionId': journeyVersionId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a list of Journey Views
 	 * 
@@ -876,6 +979,53 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Get an Event Definition
+	 * 
+	 * @param {String} eventDefinitionId Event Definition ID
+	 * getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getJourneyViewsEventdefinition(eventDefinitionId) { 
+		// verify the required parameter 'eventDefinitionId' is set
+		if (eventDefinitionId === undefined || eventDefinitionId === null) {
+			throw 'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}', 
+			'GET', 
+			{ 'eventDefinitionId': eventDefinitionId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a list of Event Definitions
+	 * 
+	 * getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getJourneyViewsEventdefinitions() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/eventdefinitions', 
+			'GET', 
+			{  },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update single action map.
 	 * 
@@ -1326,6 +1476,37 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Submit a job request for a journey view version.
+	 * used for long descriptions
+	 * @param {String} viewId Journey View Id
+	 * @param {String} journeyVersionId Journey View Version
+	 * postJourneyViewVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postJourneyViewVersionJobs(viewId, journeyVersionId) { 
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling postJourneyViewVersionJobs';
+		}
+		// verify the required parameter 'journeyVersionId' is set
+		if (journeyVersionId === undefined || journeyVersionId === null) {
+			throw 'Missing the required parameter "journeyVersionId" when calling postJourneyViewVersionJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs', 
+			'POST', 
+			{ 'viewId': viewId,'journeyVersionId': journeyVersionId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update a Journey View by ID
 	 * creates a new version
@@ -1383,6 +1564,31 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Validate whether an encoding exist for a label/value combination.
+	 * True indicates a valid encoding
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<Object>} opts.body 
+	 * postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postJourneyViewsEncodingsValidate(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/encodings/validate', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 }
 
 

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 189.1.0
+	 * @version 190.0.0
 	 */
 
 	/**

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 189.1.0
+	 * @version 190.0.0
 	 */
 
 	/**

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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.0.0
 	 */
 
 	/**

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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.0.0
 	 */
 
 	/**
@@ -162,7 +162,7 @@ class OrganizationApi {
 	}
 
 	/**
-	 * Get a link to the limit documentation
+	 * Get limit documentation
 	 * 
 	 */
 	getOrganizationsLimitsDocs() { 

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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.0.0
 	 */
 
 	/**
@@ -914,6 +914,27 @@ class RecordingApi {
 		);
 	}
 
+	/**
+	 * Retrieves an object containing the total number of concurrent active screen recordings
+	 * 
+	 * getRecordingsScreensessionsDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getRecordingsScreensessionsDetails() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/recordings/screensessions/details', 
+			'GET', 
+			{  },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Patch a media retention policy
 	 * 

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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.0.0
 	 */
 
 	/**
@@ -1453,11 +1453,12 @@ class RoutingApi {
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Number} opts.pageSize Page size (default to 25)
 	 * @param {Object} opts.sortOrder Note: results are sorted by name. (default to asc)
-	 * @param {String} opts.name Filter by queue name
-	 * @param {Array.<String>} opts.id Filter by queue ID(s)
-	 * @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
-	 * @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
-	 * @param {Boolean} opts.hasPeer Filter by queues associated with peer
+	 * @param {String} opts.name Include only queues with the given name (leading and trailing asterisks allowed)
+	 * @param {Array.<String>} opts.id Include only queues with the specified ID(s)
+	 * @param {Array.<String>} opts.divisionId Include only queues in the specified division ID(s)
+	 * @param {Array.<String>} opts.peerId Include only queues with the specified peer ID(s)
+	 * @param {String} opts.cannedResponseLibraryId Include only queues explicitly associated with the specified canned response library ID
+	 * @param {Boolean} opts.hasPeer Include only queues with a peer ID
 	 */
 	getRoutingQueues(opts) { 
 		opts = opts || {};
@@ -1467,7 +1468,7 @@ class RoutingApi {
 			'/api/v2/routing/queues', 
 			'GET', 
 			{  },
-			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'hasPeer': opts['hasPeer'] },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'cannedResponseLibraryId': opts['cannedResponseLibraryId'],'hasPeer': opts['hasPeer'] },
 			{  },
 			{  },
 			null, 

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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.0.0
 	 */
 
 	/**

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

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

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

@@ -5,7 +5,7 @@ class TeamsApi {
 	/**
 	 * Teams service.
 	 * @module purecloud-platform-client-v2/api/TeamsApi
-	 * @version 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.0.0
 	 */
 
 	/**

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 189.1.0
+	 * @version 190.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 189.1.0
+	 * @version 190.0.0
 	 */
 
 	/**