purecloud-platform-client-v2 190.0.0 → 192.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "190.0.0",
+  "version": "192.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

@@ -4,7 +4,7 @@ import { default as qs } from 'qs';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 190.0.0
+ * @version 192.0.0
  */
 class ApiClient {
 	/**

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 190.0.0
+	 * @version 192.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 190.0.0
+	 * @version 192.0.0
 	 */
 
 	/**
@@ -755,6 +755,59 @@ class AnalyticsApi {
 		);
 	}
 
+	/**
+	 * Get dashboards summary for a user
+	 * 
+	 * @param {String} userId User ID
+	 */
+	getAnalyticsReportingDashboardsUser(userId) { 
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling getAnalyticsReportingDashboardsUser';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/dashboards/users/{userId}', 
+			'GET', 
+			{ 'userId': userId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get dashboards summary for users in a org
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.sortBy  (default to asc)
+	 * @param {Number} opts.pageNumber  (default to 1)
+	 * @param {Number} opts.pageSize  (default to 25)
+	 * @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
+	 * @param {Object} opts.state Only list users of this state
+	 */
+	getAnalyticsReportingDashboardsUsers(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/dashboards/users', 
+			'GET', 
+			{  },
+			{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get all view export requests for a user
 	 * 
@@ -1030,6 +1083,39 @@ class AnalyticsApi {
 		);
 	}
 
+	/**
+	 * Get list of dashboards for an user
+	 * 
+	 * @param {String} userId User ID
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.sortBy  (default to asc)
+	 * @param {Number} opts.pageNumber  (default to 1)
+	 * @param {Number} opts.pageSize  (default to 50)
+	 * @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
+	 * @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
+	 */
+	getAnalyticsReportingSettingsUserDashboards(userId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/settings/users/{userId}/dashboards', 
+			'GET', 
+			{ 'userId': userId },
+			{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a list of report time periods.
 	 * 
@@ -2080,6 +2166,31 @@ class AnalyticsApi {
 		);
 	}
 
+	/**
+	 * Bulk delete dashboards owned by other user(s)
+	 * 
+	 * @param {Array.<String>} body List of userIds
+	 */
+	postAnalyticsReportingDashboardsUsersBulkRemove(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAnalyticsReportingDashboardsUsersBulkRemove';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/dashboards/users/bulk/remove', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Generate a view export request
 	 * This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
@@ -2157,6 +2268,56 @@ class AnalyticsApi {
 		);
 	}
 
+	/**
+	 * Bulk remove dashboard configurations
+	 * 
+	 * @param {Object} body 
+	 */
+	postAnalyticsReportingSettingsDashboardsBulkRemove(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsBulkRemove';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/settings/dashboards/bulk/remove', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Query dashboard configurations
+	 * 
+	 * @param {Object} body 
+	 */
+	postAnalyticsReportingSettingsDashboardsQuery(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsQuery';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/settings/dashboards/query', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Query for resolution aggregates asynchronously
 	 * 

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 190.0.0
+	 * @version 192.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 190.0.0
+	 * @version 192.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 190.0.0
+	 * @version 192.0.0
 	 */
 
 	/**
@@ -565,8 +565,12 @@ class AuthorizationApi {
 	 * Returns a listing of roles and permissions for a user.
 	 * 
 	 * @param {String} subjectId Subject ID (user or group)
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
 	 */
-	getAuthorizationSubject(subjectId) { 
+	getAuthorizationSubject(subjectId, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'subjectId' is set
 		if (subjectId === undefined || subjectId === null) {
 			throw 'Missing the required parameter "subjectId" when calling getAuthorizationSubject';
@@ -576,7 +580,7 @@ class AuthorizationApi {
 			'/api/v2/authorization/subjects/{subjectId}', 
 			'GET', 
 			{ 'subjectId': subjectId },
-			{  },
+			{ 'includeDuplicates': opts['includeDuplicates'] },
 			{  },
 			{  },
 			null, 
@@ -589,14 +593,18 @@ class AuthorizationApi {
 	/**
 	 * Returns a listing of roles and permissions for the currently authenticated user.
 	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
 	 */
-	getAuthorizationSubjectsMe() { 
+	getAuthorizationSubjectsMe(opts) { 
+		opts = opts || {};
+		
 
 		return this.apiClient.callApi(
 			'/api/v2/authorization/subjects/me', 
 			'GET', 
 			{  },
-			{  },
+			{ 'includeDuplicates': opts['includeDuplicates'] },
 			{  },
 			{  },
 			null, 

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 190.0.0
+	 * @version 192.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class CarrierServicesApi {
 	/**
 	 * CarrierServices service.
 	 * @module purecloud-platform-client-v2/api/CarrierServicesApi
-	 * @version 190.0.0
+	 * @version 192.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 190.0.0
+	 * @version 192.0.0
 	 */
 
 	/**
@@ -51,25 +51,25 @@ class ChatApi {
 	}
 
 	/**
-	 * Remove a user from a room.
+	 * Remove a pinned message from a room
 	 * 
 	 * @param {String} roomJid roomJid
-	 * @param {String} userId userId
+	 * @param {String} pinnedMessageId pinnedMessageId
 	 */
-	deleteChatsRoomParticipant(roomJid, userId) { 
+	deleteChatsRoomMessagesPin(roomJid, pinnedMessageId) { 
 		// verify the required parameter 'roomJid' is set
 		if (roomJid === undefined || roomJid === null) {
-			throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';
+			throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomMessagesPin';
 		}
-		// verify the required parameter 'userId' is set
-		if (userId === undefined || userId === null) {
-			throw 'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';
+		// verify the required parameter 'pinnedMessageId' is set
+		if (pinnedMessageId === undefined || pinnedMessageId === null) {
+			throw 'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomMessagesPin';
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/chats/rooms/{roomJid}/participants/{userId}', 
+			'/api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}', 
 			'DELETE', 
-			{ 'roomJid': roomJid,'userId': userId },
+			{ 'roomJid': roomJid,'pinnedMessageId': pinnedMessageId },
 			{  },
 			{  },
 			{  },
@@ -81,25 +81,25 @@ class ChatApi {
 	}
 
 	/**
-	 * Remove a pinned message from a room
+	 * Remove a user from a room.
 	 * 
 	 * @param {String} roomJid roomJid
-	 * @param {String} pinnedMessageId pinnedMessageId
+	 * @param {String} userId userId
 	 */
-	deleteChatsRoomPinnedmessage(roomJid, pinnedMessageId) { 
+	deleteChatsRoomParticipant(roomJid, userId) { 
 		// verify the required parameter 'roomJid' is set
 		if (roomJid === undefined || roomJid === null) {
-			throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomPinnedmessage';
+			throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';
 		}
-		// verify the required parameter 'pinnedMessageId' is set
-		if (pinnedMessageId === undefined || pinnedMessageId === null) {
-			throw 'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomPinnedmessage';
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/chats/rooms/{roomJid}/pinnedmessages/{pinnedMessageId}', 
+			'/api/v2/chats/rooms/{roomJid}/participants/{userId}', 
 			'DELETE', 
-			{ 'roomJid': roomJid,'pinnedMessageId': pinnedMessageId },
+			{ 'roomJid': roomJid,'userId': userId },
 			{  },
 			{  },
 			{  },
@@ -140,6 +140,37 @@ class ChatApi {
 		);
 	}
 
+	/**
+	 * Remove a pinned message from a 1on1
+	 * 
+	 * @param {String} userId userId
+	 * @param {String} pinnedMessageId pinnedMessageId
+	 * deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	deleteChatsUserMessagesPin(userId, pinnedMessageId) { 
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';
+		}
+		// verify the required parameter 'pinnedMessageId' is set
+		if (pinnedMessageId === undefined || pinnedMessageId === null) {
+			throw 'Missing the required parameter "pinnedMessageId" when calling deleteChatsUserMessagesPin';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}', 
+			'DELETE', 
+			{ 'userId': userId,'pinnedMessageId': pinnedMessageId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a message
 	 * 
@@ -357,6 +388,32 @@ class ChatApi {
 		);
 	}
 
+	/**
+	 * Get information for a 1on1
+	 * 
+	 * @param {String} userId userId
+	 * getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getChatsUser(userId) { 
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling getChatsUser';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/chats/users/{userId}', 
+			'GET', 
+			{ 'userId': userId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get messages by id(s) from a 1on1
 	 * 
@@ -631,29 +688,29 @@ class ChatApi {
 	}
 
 	/**
-	 * Join a room
+	 * Add pinned messages for a room, up to a maximum of 5 pinned messages
 	 * 
 	 * @param {String} roomJid roomJid
-	 * @param {String} userId userId
+	 * @param {Object} body Pinned Message Ids
 	 */
-	postChatsRoomParticipant(roomJid, userId) { 
+	postChatsRoomMessagesPins(roomJid, body) { 
 		// verify the required parameter 'roomJid' is set
 		if (roomJid === undefined || roomJid === null) {
-			throw 'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';
+			throw 'Missing the required parameter "roomJid" when calling postChatsRoomMessagesPins';
 		}
-		// verify the required parameter 'userId' is set
-		if (userId === undefined || userId === null) {
-			throw 'Missing the required parameter "userId" when calling postChatsRoomParticipant';
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postChatsRoomMessagesPins';
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/chats/rooms/{roomJid}/participants/{userId}', 
+			'/api/v2/chats/rooms/{roomJid}/messages/pins', 
 			'POST', 
-			{ 'roomJid': roomJid,'userId': userId },
+			{ 'roomJid': roomJid },
 			{  },
 			{  },
 			{  },
-			null, 
+			body, 
 			['PureCloud OAuth'], 
 			['application/json'],
 			['application/json']
@@ -661,29 +718,29 @@ class ChatApi {
 	}
 
 	/**
-	 * Add pinned messages for a room, up to a maximum of 5 pinned messages
+	 * Join a room
 	 * 
 	 * @param {String} roomJid roomJid
-	 * @param {Object} body Pinned Message Ids
+	 * @param {String} userId userId
 	 */
-	postChatsRoomPinnedmessages(roomJid, body) { 
+	postChatsRoomParticipant(roomJid, userId) { 
 		// verify the required parameter 'roomJid' is set
 		if (roomJid === undefined || roomJid === null) {
-			throw 'Missing the required parameter "roomJid" when calling postChatsRoomPinnedmessages';
+			throw 'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';
 		}
-		// verify the required parameter 'body' is set
-		if (body === undefined || body === null) {
-			throw 'Missing the required parameter "body" when calling postChatsRoomPinnedmessages';
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling postChatsRoomParticipant';
 		}
 
 		return this.apiClient.callApi(
-			'/api/v2/chats/rooms/{roomJid}/pinnedmessages', 
+			'/api/v2/chats/rooms/{roomJid}/participants/{userId}', 
 			'POST', 
-			{ 'roomJid': roomJid },
+			{ 'roomJid': roomJid,'userId': userId },
 			{  },
 			{  },
 			{  },
-			body, 
+			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
 			['application/json']
@@ -745,6 +802,37 @@ class ChatApi {
 		);
 	}
 
+	/**
+	 * Add pinned messages for a 1on1, up to a maximum of 5 pinned messages
+	 * 
+	 * @param {String} userId userId
+	 * @param {Object} body Pinned Message Ids
+	 * postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postChatsUserMessagesPins(userId, body) { 
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling postChatsUserMessagesPins';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postChatsUserMessagesPins';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/chats/users/{userId}/messages/pins', 
+			'POST', 
+			{ 'userId': userId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update reactions to a message
 	 * 

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 190.0.0
+	 * @version 192.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 190.0.0
+	 * @version 192.0.0
 	 */
 
 	/**