purecloud-platform-client-v2 173.0.0 → 174.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 173.0.0
+	 * @version 174.0.0
 	 */
 
 	/**
@@ -68,14 +68,18 @@ class TokensApi {
 	/**
 	 * Fetch information about the current token
 	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.preserveIdleTTL preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset.
 	 */
-	getTokensMe() { 
+	getTokensMe(opts) { 
+		opts = opts || {};
+		
 
 		return this.apiClient.callApi(
 			'/api/v2/tokens/me', 
 			'GET', 
 			{  },
-			{  },
+			{ 'preserveIdleTTL': opts['preserveIdleTTL'] },
 			{  },
 			{  },
 			null, 

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

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

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

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

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

@@ -5,7 +5,7 @@ class UserRecordingsApi {
 	/**
 	 * UserRecordings service.
 	 * @module purecloud-platform-client-v2/api/UserRecordingsApi
-	 * @version 173.0.0
+	 * @version 174.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 173.0.0
+	 * @version 174.0.0
 	 */
 
 	/**

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 173.0.0
+	 * @version 174.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 173.0.0
+	 * @version 174.0.0
 	 */
 
 	/**

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 173.0.0
+	 * @version 174.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 173.0.0
+	 * @version 174.0.0
 	 */
 
 	/**
@@ -233,8 +233,12 @@ class WebDeploymentsApi {
 	 * Get a deployment
 	 * 
 	 * @param {String} deploymentId The deployment ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected. 
 	 */
-	getWebdeploymentsDeployment(deploymentId) { 
+	getWebdeploymentsDeployment(deploymentId, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'deploymentId' is set
 		if (deploymentId === undefined || deploymentId === null) {
 			throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeployment';
@@ -244,7 +248,7 @@ class WebDeploymentsApi {
 			'/api/v2/webdeployments/deployments/{deploymentId}', 
 			'GET', 
 			{ 'deploymentId': deploymentId },
-			{  },
+			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
 			{  },
 			{  },
 			null, 
@@ -290,6 +294,7 @@ class WebDeploymentsApi {
 	 * @param {String} deploymentId The deployment ID
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.type Get active configuration on a deployment
+	 * @param {Array.<String>} opts.expand Expand instructions for the return value
 	 */
 	getWebdeploymentsDeploymentConfigurations(deploymentId, opts) { 
 		opts = opts || {};
@@ -303,7 +308,7 @@ class WebDeploymentsApi {
 			'/api/v2/webdeployments/deployments/{deploymentId}/configurations', 
 			'GET', 
 			{ 'deploymentId': deploymentId },
-			{ 'type': opts['type'] },
+			{ 'type': opts['type'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
 			{  },
 			{  },
 			null, 
@@ -317,7 +322,7 @@ class WebDeploymentsApi {
 	 * Get deployments
 	 * 
 	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected. Valid values:
+	 * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
 	 */
 	getWebdeploymentsDeployments(opts) { 
 		opts = opts || {};

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 173.0.0
+	 * @version 174.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 173.0.0
+	 * @version 174.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 173.0.0
+	 * @version 174.0.0
 	 */
 
 	/**
@@ -924,8 +924,12 @@ class WorkforceManagementApi {
 	 * 
 	 * @param {String} businessUnitId The ID of the business unit.
 	 * @param {String} serviceGoalTemplateId The ID of a service goal template to fetch
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<String>} opts.expand Include to access additional data on the service goal template
 	 */
-	getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId) { 
+	getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'businessUnitId' is set
 		if (businessUnitId === undefined || businessUnitId === null) {
 			throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';
@@ -939,7 +943,7 @@ class WorkforceManagementApi {
 			'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}', 
 			'GET', 
 			{ 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
-			{  },
+			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
 			{  },
 			{  },
 			null, 
@@ -953,8 +957,12 @@ class WorkforceManagementApi {
 	 * Gets list of service goal templates
 	 * 
 	 * @param {String} businessUnitId The ID of the business unit.
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<String>} opts.expand Include to access additional data on the service goal template
 	 */
-	getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId) { 
+	getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'businessUnitId' is set
 		if (businessUnitId === undefined || businessUnitId === null) {
 			throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';
@@ -964,7 +972,7 @@ class WorkforceManagementApi {
 			'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates', 
 			'GET', 
 			{ 'businessUnitId': businessUnitId },
-			{  },
+			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
 			{  },
 			{  },
 			null, 
@@ -1514,6 +1522,51 @@ class WorkforceManagementApi {
 		);
 	}
 
+	/**
+	 * Get integrations
+	 * 
+	 */
+	getWorkforcemanagementIntegrationsHris() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/integrations/hris', 
+			'GET', 
+			{  },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Query the results of time off types job
+	 * 
+	 * @param {String} jobId The ID of the job.
+	 */
+	getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId) { 
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementIntegrationsHrisTimeofftypesJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}', 
+			'GET', 
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get management unit
 	 * settings.shortTermForecasting is deprecated and now lives on the business unit
@@ -1544,7 +1597,7 @@ class WorkforceManagementApi {
 	}
 
 	/**
-	 * Get activity codes
+	 * Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes
 	 * 
 	 * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
 	 * @deprecated
@@ -2327,6 +2380,31 @@ class WorkforceManagementApi {
 		);
 	}
 
+	/**
+	 * Query the results of time off types job
+	 * 
+	 * @param {String} jobId The ID of the job.
+	 */
+	getWorkforcemanagementTimeoffbalanceJob(jobId) { 
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementTimeoffbalanceJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}', 
+			'GET', 
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a time off request for the current user
 	 * 
@@ -2698,6 +2776,45 @@ class WorkforceManagementApi {
 		);
 	}
 
+	/**
+	 * Set integration status for a time off request.
+	 * 
+	 * @param {String} managementUnitId The ID of the management unit.
+	 * @param {String} timeOffRequestId The ID of the time off request.
+	 * @param {String} userId The ID of user to whom the time off request belongs.
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body body
+	 */
+	patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'managementUnitId' is set
+		if (managementUnitId === undefined || managementUnitId === null) {
+			throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
+		}
+		// verify the required parameter 'timeOffRequestId' is set
+		if (timeOffRequestId === undefined || timeOffRequestId === null) {
+			throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
+		}
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus', 
+			'PATCH', 
+			{ 'managementUnitId': managementUnitId,'timeOffRequestId': timeOffRequestId,'userId': userId },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update a time off request
 	 * 
@@ -2935,6 +3052,7 @@ class WorkforceManagementApi {
 	 * 
 	 * @param {Object} opts Optional parameters
 	 * @param {Object} opts.body body
+	 * @deprecated
 	 */
 	postWorkforcemanagementAdherenceHistorical(opts) { 
 		opts = opts || {};
@@ -3043,6 +3161,54 @@ class WorkforceManagementApi {
 		);
 	}
 
+	/**
+	 * Move agents in and out of management unit
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body body
+	 */
+	postWorkforcemanagementAgents(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/agents', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Query integrations for agents
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body body
+	 */
+	postWorkforcemanagementAgentsIntegrationsHrisQuery(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/agents/integrations/hris/query', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get agent possible work shifts for requested time frame
 	 * 
@@ -3865,6 +4031,31 @@ class WorkforceManagementApi {
 		);
 	}
 
+	/**
+	 * Get list of time off types configured in integration
+	 * 
+	 * @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
+	 */
+	postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId) { 
+		// verify the required parameter 'hrisIntegrationId' is set
+		if (hrisIntegrationId === undefined || hrisIntegrationId === null) {
+			throw 'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs', 
+			'POST', 
+			{ 'hrisIntegrationId': hrisIntegrationId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Query published schedules for given given time range for set of users
 	 * 
@@ -4129,6 +4320,35 @@ class WorkforceManagementApi {
 		);
 	}
 
+	/**
+	 * Retrieves integration statuses for a list of time off requests
+	 * 
+	 * @param {String} managementUnitId The ID of the management unit.
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body body
+	 */
+	postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'managementUnitId' is set
+		if (managementUnitId === undefined || managementUnitId === null) {
+			throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query', 
+			'POST', 
+			{ 'managementUnitId': managementUnitId },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Fetches time off requests matching the conditions specified in the request body
 	 * Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days.  All other fields are filters
@@ -4257,6 +4477,40 @@ class WorkforceManagementApi {
 		);
 	}
 
+	/**
+	 * Estimates available time off for an agent
+	 * 
+	 * @param {String} managementUnitId The ID of the management unit
+	 * @param {String} userId The id of the user for whom the time off request estimate is requested
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body body
+	 */
+	postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'managementUnitId' is set
+		if (managementUnitId === undefined || managementUnitId === null) {
+			throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
+		}
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate', 
+			'POST', 
+			{ 'managementUnitId': managementUnitId,'userId': userId },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Matches a shift trade. This route can only be called by the receiving agent
 	 * 
@@ -4699,6 +4953,31 @@ class WorkforceManagementApi {
 		);
 	}
 
+	/**
+	 * Query time off balances for the current user for specified activity code and dates
+	 * 
+	 * @param {Object} body The request body
+	 */
+	postWorkforcemanagementTimeoffbalanceJobs(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffbalanceJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/timeoffbalance/jobs', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Queries available time off for the current user
 	 * 
@@ -4747,6 +5026,84 @@ class WorkforceManagementApi {
 		);
 	}
 
+	/**
+	 * Estimates available time off for current user
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body body
+	 */
+	postWorkforcemanagementTimeoffrequestsEstimate(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/timeoffrequests/estimate', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Retrieves integration statuses for a list of current user time off requests
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body body
+	 */
+	postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update integrations for agent
+	 * 
+	 * @param {String} agentId The ID of the agent
+	 * @param {Object} body body
+	 */
+	putWorkforcemanagementAgentIntegrationsHris(agentId, body) { 
+		// verify the required parameter 'agentId' is set
+		if (agentId === undefined || agentId === null) {
+			throw 'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/agents/{agentId}/integrations/hris', 
+			'PUT', 
+			{ 'agentId': agentId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Sets daily values for a date range of time off limit object
 	 * Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API

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

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