purecloud-platform-client-v2 138.0.0 → 140.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "138.0.0",
+  "version": "140.0.0",
   "description": "A JavaScript library to interface with the PureCloud Platform API",
   "license": "MIT",
   "main": "dist/node/purecloud-platform-client-v2.js",

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

@@ -3,7 +3,7 @@ import Configuration from './configuration.js';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 138.0.0
+ * @version 140.0.0
  */
 class ApiClient {
 	/**
@@ -756,7 +756,7 @@ class ApiClient {
 	serialize(obj) {
 		var result = {};
 		for (var p in obj) {
-			if (obj.hasOwnProperty(p)) {
+			if (obj.hasOwnProperty(p) && obj[p] !== undefined) {
 				result[encodeURIComponent(p)] = Array.isArray(obj[p]) ? obj[p].join(",") : this.paramToString(obj[p]);
 			}
 		}
@@ -893,6 +893,9 @@ class ApiClient {
 	 */
 	buildCollectionParam(param, collectionFormat) {
 		if (!param) return;
+		if (!Array.isArray(param)) {
+			param = [param]
+		}
 
 		switch (collectionFormat) {
 			case 'csv':

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

@@ -5,7 +5,7 @@ class AlertingApi {
 	/**
 	 * Alerting service.
 	 * @module purecloud-platform-client-v2/api/AlertingApi
-	 * @version 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class AnalyticsApi {
 	/**
 	 * Analytics service.
 	 * @module purecloud-platform-client-v2/api/AnalyticsApi
-	 * @version 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ArchitectApi {
 	/**
 	 * Architect service.
 	 * @module purecloud-platform-client-v2/api/ArchitectApi
-	 * @version 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class AuditApi {
 	/**
 	 * Audit service.
 	 * @module purecloud-platform-client-v2/api/AuditApi
-	 * @version 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class AuthorizationApi {
 	/**
 	 * Authorization service.
 	 * @module purecloud-platform-client-v2/api/AuthorizationApi
-	 * @version 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**
@@ -610,18 +610,18 @@ class AuthorizationApi {
 	/**
 	 * Returns a listing of roles and permissions for a user.
 	 * 
-	 * @param {String} userId User ID
+	 * @param {String} subjectId User ID
 	 */
-	getUserRoles(userId) { 
-		// verify the required parameter 'userId' is set
-		if (userId === undefined || userId === null) {
-			throw 'Missing the required parameter "userId" when calling getUserRoles';
+	getUserRoles(subjectId) { 
+		// verify the required parameter 'subjectId' is set
+		if (subjectId === undefined || subjectId === null) {
+			throw 'Missing the required parameter "subjectId" when calling getUserRoles';
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/users/{userId}/roles', 
+			'/api/v2/users/{subjectId}/roles', 
 			'GET', 
-			{ 'userId': userId },
+			{ 'subjectId': subjectId },
 			{  },
 			{  },
 			{  },
@@ -1155,13 +1155,13 @@ class AuthorizationApi {
 	/**
 	 * Sets the user's roles
 	 * 
-	 * @param {String} userId User ID
+	 * @param {String} subjectId User ID
 	 * @param {Array.<String>} body List of roles
 	 */
-	putUserRoles(userId, body) { 
-		// verify the required parameter 'userId' is set
-		if (userId === undefined || userId === null) {
-			throw 'Missing the required parameter "userId" when calling putUserRoles';
+	putUserRoles(subjectId, body) { 
+		// verify the required parameter 'subjectId' is set
+		if (subjectId === undefined || subjectId === null) {
+			throw 'Missing the required parameter "subjectId" when calling putUserRoles';
 		}
 		// verify the required parameter 'body' is set
 		if (body === undefined || body === null) {
@@ -1169,9 +1169,9 @@ class AuthorizationApi {
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/users/{userId}/roles', 
+			'/api/v2/users/{subjectId}/roles', 
 			'PUT', 
-			{ 'userId': userId },
+			{ 'subjectId': subjectId },
 			{  },
 			{  },
 			{  },

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

@@ -5,7 +5,7 @@ class BillingApi {
 	/**
 	 * Billing service.
 	 * @module purecloud-platform-client-v2/api/BillingApi
-	 * @version 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ChatApi {
 	/**
 	 * Chat service.
 	 * @module purecloud-platform-client-v2/api/ChatApi
-	 * @version 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class CoachingApi {
 	/**
 	 * Coaching service.
 	 * @module purecloud-platform-client-v2/api/CoachingApi
-	 * @version 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ContentManagementApi {
 	/**
 	 * ContentManagement service.
 	 * @module purecloud-platform-client-v2/api/ContentManagementApi
-	 * @version 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ConversationsApi {
 	/**
 	 * Conversations service.
 	 * @module purecloud-platform-client-v2/api/ConversationsApi
-	 * @version 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**
@@ -4553,6 +4553,126 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Update a conversation by setting its recording state
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {Object} body SetRecordingState
+	 */
+	putConversationsCallRecordingstate(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling putConversationsCallRecordingstate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsCallRecordingstate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/calls/{conversationId}/recordingstate', 
+			'PUT', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update a conversation by setting its recording state
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {Object} body SetRecordingState
+	 */
+	putConversationsCallbackRecordingstate(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling putConversationsCallbackRecordingstate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsCallbackRecordingstate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/callbacks/{conversationId}/recordingstate', 
+			'PUT', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update a conversation by setting its recording state
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {Object} body SetRecordingState
+	 */
+	putConversationsChatRecordingstate(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsChatRecordingstate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/chats/{conversationId}/recordingstate', 
+			'PUT', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update a conversation by setting its recording state
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {Object} body SetRecordingState
+	 */
+	putConversationsCobrowsesessionRecordingstate(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsCobrowsesessionRecordingstate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate', 
+			'PUT', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update conversation draft reply
 	 * 
@@ -4583,6 +4703,66 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Update a conversation by setting its recording state
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {Object} body SetRecordingState
+	 */
+	putConversationsEmailRecordingstate(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling putConversationsEmailRecordingstate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsEmailRecordingstate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/emails/{conversationId}/recordingstate', 
+			'PUT', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update a conversation by setting its recording state
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {Object} body SetRecordingState
+	 */
+	putConversationsMessageRecordingstate(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messages/{conversationId}/recordingstate', 
+			'PUT', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update a LINE messenger integration
 	 * 
@@ -4663,6 +4843,96 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Update a conversation by setting its recording state
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {Object} body SetRecordingState
+	 */
+	putConversationsScreenshareRecordingstate(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsScreenshareRecordingstate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/screenshares/{conversationId}/recordingstate', 
+			'PUT', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update a conversation by setting its recording state
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {Object} body SetRecordingState
+	 */
+	putConversationsSocialRecordingstate(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling putConversationsSocialRecordingstate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsSocialRecordingstate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/socials/{conversationId}/recordingstate', 
+			'PUT', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update a conversation by setting its recording state
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {Object} body SetRecordingState
+	 */
+	putConversationsVideoRecordingstate(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling putConversationsVideoRecordingstate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/videos/{conversationId}/recordingstate', 
+			'PUT', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 }
 
 

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

@@ -5,7 +5,7 @@ class DataExtensionsApi {
 	/**
 	 * DataExtensions service.
 	 * @module purecloud-platform-client-v2/api/DataExtensionsApi
-	 * @version 138.0.0
+	 * @version 140.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 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**

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 138.0.0
+	 * @version 140.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 138.0.0
+	 * @version 140.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 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**
@@ -150,7 +150,7 @@ class GamificationApi {
 
 	/**
 	 * Gamified metric by id
-	 * 
+	 * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
 	 * @param {String} metricId metric Id
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
@@ -225,7 +225,7 @@ class GamificationApi {
 
 	/**
 	 * All gamified metrics for a given profile
-	 * 
+	 * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
 	 * @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
@@ -276,18 +276,18 @@ class GamificationApi {
 	/**
 	 * Members of a given performance profile
 	 * 
-	 * @param {String} performanceProfileId Performance Profile Id
+	 * @param {String} profileId Profile Id
 	 */
-	getGamificationProfileMembers(performanceProfileId) { 
-		// verify the required parameter 'performanceProfileId' is set
-		if (performanceProfileId === undefined || performanceProfileId === null) {
-			throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
+	getGamificationProfileMembers(profileId) { 
+		// verify the required parameter 'profileId' is set
+		if (profileId === undefined || profileId === null) {
+			throw 'Missing the required parameter "profileId" when calling getGamificationProfileMembers';
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/gamification/profiles/{performanceProfileId}/members', 
+			'/api/v2/gamification/profiles/{profileId}/members', 
 			'GET', 
-			{ 'performanceProfileId': performanceProfileId },
+			{ 'profileId': profileId },
 			{  },
 			{  },
 			{  },
@@ -339,6 +339,7 @@ class GamificationApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Array.<String>} opts.expand Which fields, if any, to expand.
 	 * @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {String} opts.metricIds List of metric ids to filter the response (Optional, comma-separated).
 	 */
 	getGamificationProfileMetrics(profileId, opts) { 
 		opts = opts || {};
@@ -352,7 +353,7 @@ class GamificationApi {
 			'/api/v2/gamification/profiles/{profileId}/metrics', 
 			'GET', 
 			{ 'profileId': profileId },
-			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'] },
+			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'],'metricIds': opts['metricIds'] },
 			{  },
 			{  },
 			null, 
@@ -1079,7 +1080,7 @@ class GamificationApi {
 
 	/**
 	 * Creates a gamified metric with a given metric definition and metric objective
-	 * 
+	 * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
 	 * @param {Object} body Metric
 	 */
 	postGamificationMetrics(body) { 
@@ -1155,13 +1156,13 @@ class GamificationApi {
 	/**
 	 * Assign members to a given performance profile
 	 * 
-	 * @param {String} performanceProfileId Performance Profile Id
+	 * @param {String} profileId Profile Id
 	 * @param {Object} body assignUsers
 	 */
-	postGamificationProfileMembers(performanceProfileId, body) { 
-		// verify the required parameter 'performanceProfileId' is set
-		if (performanceProfileId === undefined || performanceProfileId === null) {
-			throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
+	postGamificationProfileMembers(profileId, body) { 
+		// verify the required parameter 'profileId' is set
+		if (profileId === undefined || profileId === null) {
+			throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembers';
 		}
 		// verify the required parameter 'body' is set
 		if (body === undefined || body === null) {
@@ -1169,9 +1170,9 @@ class GamificationApi {
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/gamification/profiles/{performanceProfileId}/members', 
+			'/api/v2/gamification/profiles/{profileId}/members', 
 			'POST', 
-			{ 'performanceProfileId': performanceProfileId },
+			{ 'profileId': profileId },
 			{  },
 			{  },
 			{  },
@@ -1185,13 +1186,13 @@ class GamificationApi {
 	/**
 	 * Validate member assignment
 	 * 
-	 * @param {String} performanceProfileId Performance Profile Id
+	 * @param {String} profileId Profile Id
 	 * @param {Object} body memberAssignments
 	 */
-	postGamificationProfileMembersValidate(performanceProfileId, body) { 
-		// verify the required parameter 'performanceProfileId' is set
-		if (performanceProfileId === undefined || performanceProfileId === null) {
-			throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
+	postGamificationProfileMembersValidate(profileId, body) { 
+		// verify the required parameter 'profileId' is set
+		if (profileId === undefined || profileId === null) {
+			throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';
 		}
 		// verify the required parameter 'body' is set
 		if (body === undefined || body === null) {
@@ -1199,9 +1200,9 @@ class GamificationApi {
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/gamification/profiles/{performanceProfileId}/members/validate', 
+			'/api/v2/gamification/profiles/{profileId}/members/validate', 
 			'POST', 
-			{ 'performanceProfileId': performanceProfileId },
+			{ 'profileId': profileId },
 			{  },
 			{  },
 			{  },
@@ -1308,7 +1309,7 @@ class GamificationApi {
 
 	/**
 	 * Updates a metric
-	 * 
+	 * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
 	 * @param {String} metricId metric Id
 	 * @param {Object} body Metric
 	 * @param {Object} opts Optional parameters

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 138.0.0
+	 * @version 140.0.0
 	 */
 
 	/**