purecloud-platform-client-v2 196.0.0 → 198.0.0

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

@@ -5,7 +5,7 @@ class ExternalContactsApi {
 	/**
 	 * ExternalContacts service.
 	 * @module purecloud-platform-client-v2/api/ExternalContactsApi
-	 * @version 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**
@@ -210,7 +210,7 @@ class ExternalContactsApi {
 	 * 
 	 * @param {String} contactId ExternalContact ID
 	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
+	 * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
 	 */
 	getExternalcontactsContact(contactId, opts) { 
 		opts = opts || {};
@@ -361,7 +361,7 @@ class ExternalContactsApi {
 	 * 
 	 * @param {String} contactId ExternalContact ID
 	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
+	 * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
 	 */
 	getExternalcontactsContactUnresolved(contactId, opts) { 
 		opts = opts || {};
@@ -1526,8 +1526,12 @@ class ExternalContactsApi {
 	 * Fetch a contact using an identifier type and value.
 	 * Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
 	 * @param {Object} identifier 
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<String>} opts.expand which field, if any, to expand
 	 */
-	postExternalcontactsIdentifierlookup(identifier) { 
+	postExternalcontactsIdentifierlookup(identifier, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'identifier' is set
 		if (identifier === undefined || identifier === null) {
 			throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';
@@ -1537,7 +1541,7 @@ class ExternalContactsApi {
 			'/api/v2/externalcontacts/identifierlookup', 
 			'POST', 
 			{  },
-			{  },
+			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
 			{  },
 			{  },
 			identifier, 

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

@@ -5,7 +5,7 @@ class FaxApi {
 	/**
 	 * Fax service.
 	 * @module purecloud-platform-client-v2/api/FaxApi
-	 * @version 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class FlowsApi {
 	/**
 	 * Flows service.
 	 * @module purecloud-platform-client-v2/api/FlowsApi
-	 * @version 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi {
 	/**
 	 * GeneralDataProtectionRegulation service.
 	 * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
-	 * @version 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GeolocationApi {
 	/**
 	 * Geolocation service.
 	 * @module purecloud-platform-client-v2/api/GeolocationApi
-	 * @version 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GreetingsApi {
 	/**
 	 * Greetings service.
 	 * @module purecloud-platform-client-v2/api/GreetingsApi
-	 * @version 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GroupsApi {
 	/**
 	 * Groups service.
 	 * @module purecloud-platform-client-v2/api/GroupsApi
-	 * @version 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class IdentityProviderApi {
 	/**
 	 * IdentityProvider service.
 	 * @module purecloud-platform-client-v2/api/IdentityProviderApi
-	 * @version 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class InfrastructureAsCodeApi {
 	/**
 	 * InfrastructureAsCode service.
 	 * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
-	 * @version 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**
@@ -749,7 +749,7 @@ class JourneyApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
 	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
-	 * getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 * @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
 	 */
 	getJourneySessionEvents(sessionId, opts) { 
 		opts = opts || {};
@@ -763,7 +763,7 @@ class JourneyApi {
 			'/api/v2/journey/sessions/{sessionId}/events', 
 			'GET', 
 			{ 'sessionId': sessionId },
-			{ 'pageSize': opts['pageSize'],'after': opts['after'] },
+			{ 'pageSize': opts['pageSize'],'after': opts['after'],'eventType': opts['eventType'] },
 			{  },
 			{  },
 			null, 
@@ -1382,6 +1382,35 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Send a journey web event, used for tracking customer activity on a website.
+	 * 
+	 * @param {String} deploymentId The ID of the deployment sending the web event.
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body 
+	 */
+	postJourneyDeploymentWebevents(deploymentId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'deploymentId' is set
+		if (deploymentId === undefined || deploymentId === null) {
+			throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentWebevents';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/deployments/{deploymentId}/webevents', 
+			'POST', 
+			{ 'deploymentId': deploymentId },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Query for flow paths.
 	 * 

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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**
@@ -106,6 +106,7 @@ class LearningApi {
 	 * @param {String} stepId The ID of Learning Assignment Step
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.shareableContentObjectId The ID of SCO to load
+	 * @param {Object} opts.defaultShareableContentObject The default SCO to retrieve
 	 * @param {Array.<String>} opts.expand Fields to expand in response
 	 */
 	getLearningAssignmentStep(assignmentId, stepId, opts) { 
@@ -124,7 +125,7 @@ class LearningApi {
 			'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}', 
 			'GET', 
 			{ 'assignmentId': assignmentId,'stepId': stepId },
-			{ 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
+			{ 'shareableContentObjectId': opts['shareableContentObjectId'],'defaultShareableContentObject': opts['defaultShareableContentObject'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
 			{  },
 			{  },
 			null, 

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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**
@@ -619,7 +619,7 @@ class OutboundApi {
 
 	/**
 	 * Reset messaging campaign progress and recycle the messaging campaign
-	 * 
+	 * Documented permissions are applicable based on campaign type.
 	 * @param {String} messagingCampaignId The Messaging Campaign ID
 	 */
 	deleteOutboundMessagingcampaignProgress(messagingCampaignId) { 
@@ -2621,6 +2621,36 @@ class OutboundApi {
 		);
 	}
 
+	/**
+	 * Update a campaign.
+	 * 
+	 * @param {String} campaignId Campaign ID
+	 * @param {Object} body CampaignPatchRequest
+	 */
+	patchOutboundCampaign(campaignId, body) { 
+		// verify the required parameter 'campaignId' is set
+		if (campaignId === undefined || campaignId === null) {
+			throw 'Missing the required parameter "campaignId" when calling patchOutboundCampaign';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchOutboundCampaign';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/outbound/campaigns/{campaignId}', 
+			'PATCH', 
+			{ 'campaignId': campaignId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Add entries to or delete entries from a DNC list.
 	 * Only Internal DNC lists may be deleted from
@@ -2761,40 +2791,6 @@ class OutboundApi {
 		);
 	}
 
-	/**
-	 * Retrieves audits for dialer. (Deprecated)
-	 * This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
-	 * @param {Object} body AuditSearch
-	 * @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.sortBy Sort by (default to entity.name)
-	 * @param {String} opts.sortOrder Sort order (default to ascending)
-	 * @param {Boolean} opts.facetsOnly Facets only (default to false)
-	 * @deprecated
-	 */
-	postOutboundAudits(body, opts) { 
-		opts = opts || {};
-		
-		// verify the required parameter 'body' is set
-		if (body === undefined || body === null) {
-			throw 'Missing the required parameter "body" when calling postOutboundAudits';
-		}
-
-		return this.apiClient.callApi(
-			'/api/v2/outbound/audits', 
-			'POST', 
-			{  },
-			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'facetsOnly': opts['facetsOnly'] },
-			{  },
-			{  },
-			body, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
 	/**
 	 * Create callable time 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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**
@@ -1694,6 +1694,37 @@ class QualityApi {
 		);
 	}
 
+	/**
+	 * Update the Predictive Scoring settings of an evaluation form.
+	 * 
+	 * @param {String} formId Form ID
+	 * @param {Object} body Predictive Scoring Settings
+	 * putQualityFormsEvaluationPredictivescoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	putQualityFormsEvaluationPredictivescoringSettings(formId, body) { 
+		// verify the required parameter 'formId' is set
+		if (formId === undefined || formId === null) {
+			throw 'Missing the required parameter "formId" when calling putQualityFormsEvaluationPredictivescoringSettings';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putQualityFormsEvaluationPredictivescoringSettings';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/quality/forms/evaluations/{formId}/predictivescoring/settings', 
+			'PUT', 
+			{ 'formId': formId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update a survey form.
 	 * 

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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**
@@ -1916,6 +1916,7 @@ class RoutingApi {
 	 * @param {Object} opts.sortOrder Sort order
 	 * @param {String} opts.language A language tag (which is sometimes referred to as a locale identifier) to use to localize country field and sort operations (default to en-US)
 	 * @param {String} opts.integrationId Filter on the Genesys Cloud integration id to which the phone number belongs to
+	 * @param {String} opts.supportedContentId Filter based on the supported content ID
 	 */
 	getRoutingSmsPhonenumbers(opts) { 
 		opts = opts || {};
@@ -1925,7 +1926,7 @@ class RoutingApi {
 			'/api/v2/routing/sms/phonenumbers', 
 			'GET', 
 			{  },
-			{ 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'],'integration.id': opts['integrationId'] },
+			{ 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'],'integration.id': opts['integrationId'],'supportedContent.id': opts['supportedContentId'] },
 			{  },
 			{  },
 			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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**