purecloud-platform-client-v2 206.0.0 → 208.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 206.0.0
+	 * @version 208.0.0
 	 */
 
 	/**
@@ -176,7 +176,7 @@ class UsersApi {
 	}
 
 	/**
-	 * Remove routing language from user
+	 * Remove a routing language from a user
 	 * 
 	 * @param {String} userId User ID
 	 * @param {String} languageId languageId
@@ -206,7 +206,7 @@ class UsersApi {
 	}
 
 	/**
-	 * Remove routing skill from user
+	 * Remove a routing skill from a user
 	 * 
 	 * @param {String} userId User ID
 	 * @param {String} skillId skillId
@@ -1038,7 +1038,7 @@ class UsersApi {
 	}
 
 	/**
-	 * List routing language for user
+	 * List routing languages assigned to a user
 	 * 
 	 * @param {String} userId User ID
 	 * @param {Object} opts Optional parameters
@@ -1069,7 +1069,7 @@ class UsersApi {
 	}
 
 	/**
-	 * List routing skills for user
+	 * List routing skills assigned to a user
 	 * 
 	 * @param {String} userId User ID
 	 * @param {Object} opts Optional parameters
@@ -1320,6 +1320,32 @@ class UsersApi {
 		);
 	}
 
+	/**
+	 * Get chats for a user
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
+	 * @param {Boolean} opts.includePresence Whether or not to include user presence
+	 * @param {String} opts.after The key to start after
+	 */
+	getUsersChatsMe(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/users/chats/me', 
+			'GET', 
+			{  },
+			{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'after': opts['after'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get list of Development Activities
 	 * Either moduleId or userId is required. Results are filtered based on the applicable permissions.
@@ -1639,7 +1665,7 @@ class UsersApi {
 	}
 
 	/**
-	 * Update routing language proficiency or state.
+	 * Update an assigned routing language's proficiency
 	 * 
 	 * @param {String} userId User ID
 	 * @param {String} languageId languageId
@@ -1674,7 +1700,7 @@ class UsersApi {
 	}
 
 	/**
-	 * Add bulk routing language to user. Max limit 50 languages
+	 * Assign multiple routing languages to a user. Max 50 routing languages in request body
 	 * 
 	 * @param {String} userId User ID
 	 * @param {Array.<Object>} body Language
@@ -1704,7 +1730,7 @@ class UsersApi {
 	}
 
 	/**
-	 * Bulk add routing skills to user
+	 * Assign multiple routing skills to a user
 	 * 
 	 * @param {String} userId User ID
 	 * @param {Array.<Object>} body Skill
@@ -2141,7 +2167,7 @@ class UsersApi {
 	}
 
 	/**
-	 * Add routing language to user
+	 * Assign a routing language to a user
 	 * 
 	 * @param {String} userId User ID
 	 * @param {Object} body Language
@@ -2171,7 +2197,7 @@ class UsersApi {
 	}
 
 	/**
-	 * Add routing skill to user
+	 * Assign a routing skill to a user
 	 * 
 	 * @param {String} userId User ID
 	 * @param {Object} body Skill
@@ -2583,7 +2609,7 @@ class UsersApi {
 	}
 
 	/**
-	 * Update routing skill proficiency or state.
+	 * Update an assigned routing skill's proficiency
 	 * 
 	 * @param {String} userId User ID
 	 * @param {String} skillId skillId
@@ -2618,7 +2644,7 @@ class UsersApi {
 	}
 
 	/**
-	 * Replace all routing skills assigned to a user
+	 * Assign multiple routing skills to a user, replacing any current assignments
 	 * 
 	 * @param {String} userId User ID
 	 * @param {Array.<Object>} body Skill

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 206.0.0
+	 * @version 208.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 206.0.0
+	 * @version 208.0.0
 	 */
 
 	/**
@@ -392,6 +392,61 @@ class VoicemailApi {
 		);
 	}
 
+	/**
+	 * Get a user's mailbox information
+	 * 
+	 * @param {String} userId userId
+	 */
+	getVoicemailUserMailbox(userId) { 
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling getVoicemailUserMailbox';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/voicemail/users/{userId}/mailbox', 
+			'GET', 
+			{ 'userId': userId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * List voicemail messages
+	 * 
+	 * @param {String} userId User ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageSize Page size (default to 25)
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 */
+	getVoicemailUserMessages(userId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling getVoicemailUserMessages';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/voicemail/users/{userId}/messages', 
+			'GET', 
+			{ 'userId': userId },
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a user's voicemail policy
 	 * 

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 206.0.0
+	 * @version 208.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 206.0.0
+	 * @version 208.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 206.0.0
+	 * @version 208.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 206.0.0
+	 * @version 208.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 206.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -35,6 +35,7 @@ class Configuration {
 		this.basePath;
 		this.authUrl;
 		this.config;
+		this.gateway = undefined;
 		this.logger = new Logger();
 		this.setEnvironment();
 		this.liveLoadConfig();
@@ -132,12 +133,72 @@ class Configuration {
 				: this.live_reload_config;
 		this.host = this.getConfigString('general', 'host') !== undefined ? this.getConfigString('general', 'host') : this.host;
 
+		if (this.getConfigString('gateway', 'host') !== undefined) {
+			let gateway = {
+				host: this.getConfigString('gateway', 'host')
+			};
+			if (this.getConfigString('gateway', 'protocol') !== undefined) gateway.protocol = this.getConfigString('gateway', 'protocol');
+			if (this.getConfigInt('gateway', 'port') !== undefined) gateway.port = this.getConfigInt('gateway', 'port');
+			if (this.getConfigString('gateway', 'path_params_login') !== undefined) gateway.path_params_login = this.getConfigString('gateway', 'path_params_login');
+			if (this.getConfigString('gateway', 'path_params_api') !== undefined) gateway.path_params_api = this.getConfigString('gateway', 'path_params_api');
+			if (this.getConfigString('gateway', 'username') !== undefined) gateway.username = this.getConfigString('gateway', 'username');
+			if (this.getConfigString('gateway', 'password') !== undefined) gateway.password = this.getConfigString('gateway', 'password');
+			this.setGateway(gateway);
+		} else {
+			this.setGateway();
+		}
+
 		this.setEnvironment();
 
 		// Update logging configs
 		this.logger.setLogger();
 	}
 
+	/**
+	 * @description Sets the gateway used by the session
+	 * @param {object} gateway - Gateway Configuration interface
+	 * @param {string} gateway.host - The address of the gateway.
+	 * @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
+	 * @param {number} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater or equal to 0).
+	 * @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
+	 * @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
+	 * @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
+	 * @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
+	 */
+	setGateway(gateway) {
+		if (gateway) {
+			this.gateway = {
+				host: ''
+			};
+
+			if (gateway.protocol) this.gateway.protocol = gateway.protocol;
+			else this.gateway.protocol = 'https';
+			
+			if (gateway.host) this.gateway.host = gateway.host;
+			else this.gateway.host = '';
+
+			if (gateway.port && gateway.port > -1) this.gateway.port = gateway.port;
+			else this.gateway.port = -1;
+
+			if (gateway.path_params_login) {
+				this.gateway.path_params_login = gateway.path_params_login;
+				// Strip trailing slash
+				this.gateway.path_params_login = this.gateway.path_params_login.replace(/\/+$/, '');
+			} else this.gateway.path_params_login = '';
+
+			if (gateway.path_params_api) {
+				this.gateway.path_params_api = gateway.path_params_api;
+				// Strip trailing slash
+				this.gateway.path_params_api = this.gateway.path_params_api.replace(/\/+$/, '');
+			} else this.gateway.path_params_api = '';
+
+			if (gateway.username) this.gateway.username = gateway.username;
+			if (gateway.password) this.gateway.password = gateway.password;
+		} else {
+			this.gateway = undefined;
+		}
+	}
+
 	setEnvironment(env) {
 		// Default value
 		if (env) this.environment = env;
@@ -155,6 +216,26 @@ class Configuration {
 		this.authUrl = `https://login.${this.environment}`;
 	}
 
+	getConfUrl(pathType, regionUrl) {
+		if (!this.gateway) return regionUrl;
+		if (!this.gateway.host) return regionUrl;
+		
+		var url = this.gateway.protocol + '://' + this.gateway.host;
+		if (this.gateway.port > -1) url = url + ':' + this.gateway.port.toString();
+		if (pathType === 'login') {
+			if (this.gateway.path_params_login) {
+				if (this.gateway.path_params_login.startsWith('/')) url = url + this.gateway.path_params_login;
+				else url = url + '/' + this.gateway.path_params_login;
+			}
+		} else {
+			if (this.gateway.path_params_api) {
+				if (this.gateway.path_params_api.startsWith('/')) url = url + this.gateway.path_params_api;
+				else url = url + '/' + this.gateway.path_params_api;
+			}
+		}
+		return url;
+	}
+
 	getConfigString(section, key) {
 		if (this.config._sections[section]) return this.config._sections[section][key];
 	}

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

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