purecloud-platform-client-v2 169.0.0 → 170.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 169.0.0
+	 * @version 170.0.0
 	 */
 
 	/**
@@ -195,6 +195,32 @@ class OrganizationAuthorizationApi {
 		);
 	}
 
+	/**
+	 * Delete Bulk Org Trustees
+	 * 
+	 * @param {Array.<String>} id Comma separated list of trustee ids to remove
+	 * deleteOrgauthorizationTrustees is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	deleteOrgauthorizationTrustees(id) { 
+		// verify the required parameter 'id' is set
+		if (id === undefined || id === null) {
+			throw 'Missing the required parameter "id" when calling deleteOrgauthorizationTrustees';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/orgauthorization/trustees', 
+			'DELETE', 
+			{  },
+			{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Delete Org Trust
 	 * 
@@ -310,6 +336,32 @@ class OrganizationAuthorizationApi {
 		);
 	}
 
+	/**
+	 * Delete Bulk Org Trustors
+	 * 
+	 * @param {Array.<String>} id Comma separated list of trustor ids to remove
+	 * deleteOrgauthorizationTrustors is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	deleteOrgauthorizationTrustors(id) { 
+		// verify the required parameter 'id' is set
+		if (id === undefined || id === null) {
+			throw 'Missing the required parameter "id" when calling deleteOrgauthorizationTrustors';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/orgauthorization/trustors', 
+			'DELETE', 
+			{  },
+			{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get Pairing Info
 	 * 

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 169.0.0
+	 * @version 170.0.0
 	 */
 
 	/**
@@ -2490,7 +2490,7 @@ class OutboundApi {
 	 * This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
 	 * @param {String} campaignId Campaign ID
 	 * @param {Object} body ContactCallbackRequest
-     	 * @deprecated
+	 * @deprecated
 	 */
 	postOutboundCampaignCallbackSchedule(campaignId, body) { 
 		// verify the required parameter 'campaignId' is set

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 169.0.0
+	 * @version 170.0.0
 	 */
 
 	/**
@@ -20,6 +20,32 @@ class PresenceApi {
 	}
 
 
+	/**
+	 * Delete a Presence Definition
+	 * 
+	 * @param {String} definitionId Presence Definition ID
+	 * deletePresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	deletePresenceDefinition0(definitionId) { 
+		// verify the required parameter 'definitionId' is set
+		if (definitionId === undefined || definitionId === null) {
+			throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/presence/definitions/{definitionId}', 
+			'DELETE', 
+			{ 'definitionId': definitionId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Delete a Presence Source
 	 * 
@@ -70,6 +96,58 @@ class PresenceApi {
 		);
 	}
 
+	/**
+	 * Get a Presence Definition
+	 * 
+	 * @param {String} definitionId Presence Definition ID
+	 * getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getPresenceDefinition0(definitionId) { 
+		// verify the required parameter 'definitionId' is set
+		if (definitionId === undefined || definitionId === null) {
+			throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/presence/definitions/{definitionId}', 
+			'GET', 
+			{ 'definitionId': definitionId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a list of Presence Definitions
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
+	 * @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
+	 * getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getPresenceDefinitions0(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/presence/definitions', 
+			'GET', 
+			{  },
+			{ 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get the presence settings
 	 * 
@@ -295,6 +373,59 @@ class PresenceApi {
 		);
 	}
 
+	/**
+	 * Get bulk user presences for a single presence source
+	 * 
+	 * @param {String} sourceId The requested presence source ID.
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
+	 */
+	getUsersPresenceBulk(sourceId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'sourceId' is set
+		if (sourceId === undefined || sourceId === null) {
+			throw 'Missing the required parameter "sourceId" when calling getUsersPresenceBulk';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/presences/{sourceId}/bulk', 
+			'GET', 
+			{ 'sourceId': sourceId },
+			{ 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
+	 */
+	getUsersPresencesPurecloudBulk(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/users/presences/purecloud/bulk', 
+			'GET', 
+			{  },
+			{ 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Patch a user's Presence
 	 * Patch a users presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the primary property to true. This will set the source defined in the path as the users primary presence source. Option 2: Provide the presenceDefinition value. The id is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
@@ -360,6 +491,32 @@ class PresenceApi {
 		);
 	}
 
+	/**
+	 * Create a Presence Definition
+	 * 
+	 * @param {Object} body The Presence Definition to create
+	 * postPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postPresenceDefinitions0(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/presence/definitions', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Create a Presence Source
 	 * 
@@ -410,6 +567,37 @@ class PresenceApi {
 		);
 	}
 
+	/**
+	 * Update a Presence Definition
+	 * 
+	 * @param {String} definitionId Presence Definition ID
+	 * @param {Object} body The updated Presence Definition
+	 * putPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	putPresenceDefinition0(definitionId, body) { 
+		// verify the required parameter 'definitionId' is set
+		if (definitionId === undefined || definitionId === null) {
+			throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/presence/definitions/{definitionId}', 
+			'PUT', 
+			{ 'definitionId': definitionId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update the presence settings
 	 * 

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 169.0.0
+	 * @version 170.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 169.0.0
+	 * @version 170.0.0
 	 */
 
 	/**
@@ -88,7 +88,7 @@ class QualityApi {
 	 * Delete an evaluation form.
 	 * 
 	 * @param {String} formId Form ID
-     	 * @deprecated
+	 * @deprecated
 	 */
 	deleteQualityForm(formId) { 
 		// verify the required parameter 'formId' is set
@@ -160,6 +160,118 @@ class QualityApi {
 		);
 	}
 
+	/**
+	 * Get status for async query for evaluation aggregates
+	 * 
+	 * @param {String} jobId jobId
+	 * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAnalyticsEvaluationsAggregatesJob(jobId) { 
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/evaluations/aggregates/jobs/{jobId}', 
+			'GET', 
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Fetch a page of results for an async aggregates query
+	 * 
+	 * @param {String} jobId jobId
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.cursor Cursor token to retrieve next page
+	 * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJobResults';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results', 
+			'GET', 
+			{ 'jobId': jobId },
+			{ 'cursor': opts['cursor'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get status for async query for survey aggregates
+	 * 
+	 * @param {String} jobId jobId
+	 * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAnalyticsSurveysAggregatesJob(jobId) { 
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/surveys/aggregates/jobs/{jobId}', 
+			'GET', 
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Fetch a page of results for an async aggregates query
+	 * 
+	 * @param {String} jobId jobId
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.cursor Cursor token to retrieve next page
+	 * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAnalyticsSurveysAggregatesJobResults(jobId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJobResults';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results', 
+			'GET', 
+			{ 'jobId': jobId },
+			{ 'cursor': opts['cursor'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Gets a list of Agent Activities
 	 * Each item on the list shows one agents evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent.  evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria.  If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria.  If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId.  If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users
@@ -457,7 +569,7 @@ class QualityApi {
 	 * Get an evaluation form
 	 * 
 	 * @param {String} formId Form ID
-     	 * @deprecated
+	 * @deprecated
 	 */
 	getQualityForm(formId) { 
 		// verify the required parameter 'formId' is set
@@ -486,7 +598,7 @@ class QualityApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageSize Page size (default to 25)
 	 * @param {Number} opts.pageNumber Page number (default to 1)
-     	 * @deprecated
+	 * @deprecated
 	 */
 	getQualityFormVersions(formId, opts) { 
 		opts = opts || {};
@@ -522,7 +634,7 @@ class QualityApi {
 	 * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
 	 * @param {String} opts.name Name
 	 * @param {String} opts.sortOrder Order to sort results, either asc or desc
-     	 * @deprecated
+	 * @deprecated
 	 */
 	getQualityForms(opts) { 
 		opts = opts || {};
@@ -798,7 +910,7 @@ class QualityApi {
 	 * Get the published evaluation forms.
 	 * 
 	 * @param {String} formId Form ID
-     	 * @deprecated
+	 * @deprecated
 	 */
 	getQualityPublishedform(formId) { 
 		// verify the required parameter 'formId' is set
@@ -828,7 +940,7 @@ class QualityApi {
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {String} opts.name Name
 	 * @param {Boolean} opts.onlyLatestPerContext onlyLatestPerContext (default to false)
-     	 * @deprecated
+	 * @deprecated
 	 */
 	getQualityPublishedforms(opts) { 
 		opts = opts || {};
@@ -1032,6 +1144,32 @@ class QualityApi {
 		);
 	}
 
+	/**
+	 * Query for evaluation aggregates asynchronously
+	 * 
+	 * @param {Object} body query
+	 * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postAnalyticsEvaluationsAggregatesJobs(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/evaluations/aggregates/jobs', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Query for evaluation aggregates
 	 * 
@@ -1057,6 +1195,32 @@ class QualityApi {
 		);
 	}
 
+	/**
+	 * Query for survey aggregates asynchronously
+	 * 
+	 * @param {Object} body query
+	 * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postAnalyticsSurveysAggregatesJobs(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/surveys/aggregates/jobs', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Query for survey aggregates
 	 * 
@@ -1224,7 +1388,7 @@ class QualityApi {
 	 * Create an evaluation form.
 	 * 
 	 * @param {Object} body Evaluation form
-     	 * @deprecated
+	 * @deprecated
 	 */
 	postQualityForms(body) { 
 		// verify the required parameter 'body' is set
@@ -1300,7 +1464,7 @@ class QualityApi {
 	 * Publish an evaluation form.
 	 * 
 	 * @param {Object} body Publish request containing id of form to publish
-     	 * @deprecated
+	 * @deprecated
 	 */
 	postQualityPublishedforms(body) { 
 		// verify the required parameter 'body' is set
@@ -1471,7 +1635,7 @@ class QualityApi {
 	 * 
 	 * @param {String} formId Form ID
 	 * @param {Object} body Evaluation form
-     	 * @deprecated
+	 * @deprecated
 	 */
 	putQualityForm(formId, body) { 
 		// verify the required parameter 'formId' is set

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 169.0.0
+	 * @version 170.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 169.0.0
+	 * @version 170.0.0
 	 */
 
 	/**