purecloud-platform-client-v2 189.0.0 → 190.0.0

package/package.json

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

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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.0.0
 	 */
 
 	/**
@@ -25,7 +25,6 @@ class ChatApi {
 	 * 
 	 * @param {String} roomJid roomId
 	 * @param {String} messageId messageId
-	 * deleteChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	deleteChatsRoomMessage(roomJid, messageId) { 
 		// verify the required parameter 'roomJid' is set
@@ -56,7 +55,6 @@ class ChatApi {
 	 * 
 	 * @param {String} roomJid roomJid
 	 * @param {String} userId userId
-	 * deleteChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	deleteChatsRoomParticipant(roomJid, userId) { 
 		// verify the required parameter 'roomJid' is set
@@ -87,7 +85,6 @@ class ChatApi {
 	 * 
 	 * @param {String} roomJid roomJid
 	 * @param {String} pinnedMessageId pinnedMessageId
-	 * deleteChatsRoomPinnedmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	deleteChatsRoomPinnedmessage(roomJid, pinnedMessageId) { 
 		// verify the required parameter 'roomJid' is set
@@ -118,7 +115,6 @@ class ChatApi {
 	 * 
 	 * @param {String} userId userId
 	 * @param {String} messageId messageId
-	 * deleteChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	deleteChatsUserMessage(userId, messageId) { 
 		// verify the required parameter 'userId' is set
@@ -148,7 +144,6 @@ class ChatApi {
 	 * Get a message
 	 * 
 	 * @param {String} messageId messageId
-	 * getChatsMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getChatsMessage(messageId) { 
 		// verify the required parameter 'messageId' is set
@@ -174,7 +169,6 @@ class ChatApi {
 	 * Get a room
 	 * 
 	 * @param {String} roomJid roomJid
-	 * getChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getChatsRoom(roomJid) { 
 		// verify the required parameter 'roomJid' is set
@@ -201,7 +195,6 @@ class ChatApi {
 	 * 
 	 * @param {String} roomJid roomJid
 	 * @param {String} messageIds messageIds, comma separated
-	 * getChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getChatsRoomMessage(roomJid, messageIds) { 
 		// verify the required parameter 'roomJid' is set
@@ -235,7 +228,6 @@ class ChatApi {
 	 * @param {String} opts.limit The maximum number of messages to retrieve
 	 * @param {String} opts.before The cutoff date for messages to retrieve
 	 * @param {String} opts.after The beginning date for messages to retrieve
-	 * getChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getChatsRoomMessages(roomJid, opts) { 
 		opts = opts || {};
@@ -259,6 +251,61 @@ class ChatApi {
 		);
 	}
 
+	/**
+	 * Get a room participant
+	 * 
+	 * @param {String} roomJid roomJid
+	 * @param {String} participantJid participantJid
+	 */
+	getChatsRoomParticipant(roomJid, participantJid) { 
+		// verify the required parameter 'roomJid' is set
+		if (roomJid === undefined || roomJid === null) {
+			throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';
+		}
+		// verify the required parameter 'participantJid' is set
+		if (participantJid === undefined || participantJid === null) {
+			throw 'Missing the required parameter "participantJid" when calling getChatsRoomParticipant';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/chats/rooms/{roomJid}/participants/{participantJid}', 
+			'GET', 
+			{ 'roomJid': roomJid,'participantJid': participantJid },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get room participants in a room
+	 * 
+	 * @param {String} roomJid roomJid
+	 */
+	getChatsRoomParticipants(roomJid) { 
+		// verify the required parameter 'roomJid' is set
+		if (roomJid === undefined || roomJid === null) {
+			throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/chats/rooms/{roomJid}/participants', 
+			'GET', 
+			{ 'roomJid': roomJid },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get Chat Settings.
 	 * 
@@ -287,7 +334,6 @@ class ChatApi {
 	 * @param {String} opts.limit The maximum number of messages to retrieve
 	 * @param {String} opts.before The cutoff date for messages to retrieve
 	 * @param {String} opts.after The beginning date for messages to retrieve
-	 * getChatsThreadMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getChatsThreadMessages(threadId, opts) { 
 		opts = opts || {};
@@ -316,7 +362,6 @@ class ChatApi {
 	 * 
 	 * @param {String} userId userId
 	 * @param {String} messageIds messageIds, comma separated
-	 * getChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getChatsUserMessage(userId, messageIds) { 
 		// verify the required parameter 'userId' is set
@@ -350,7 +395,6 @@ class ChatApi {
 	 * @param {String} opts.limit The maximum number of messages to retrieve
 	 * @param {String} opts.before The cutoff date for messages to retrieve
 	 * @param {String} opts.after The beginning date for messages to retrieve
-	 * getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getChatsUserMessages(userId, opts) { 
 		opts = opts || {};
@@ -405,7 +449,6 @@ class ChatApi {
 	 * 
 	 * @param {String} roomJid roomJid
 	 * @param {Object} body Room properties
-	 * patchChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	patchChatsRoom(roomJid, body) { 
 		// verify the required parameter 'roomJid' is set
@@ -437,7 +480,6 @@ class ChatApi {
 	 * @param {String} roomJid roomId
 	 * @param {String} messageId messageId
 	 * @param {Object} body messageBody
-	 * patchChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	patchChatsRoomMessage(roomJid, messageId, body) { 
 		// verify the required parameter 'roomJid' is set
@@ -498,7 +540,6 @@ class ChatApi {
 	 * @param {String} userId userId
 	 * @param {String} messageId messageId
 	 * @param {Object} body message body
-	 * patchChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	patchChatsUserMessage(userId, messageId, body) { 
 		// verify the required parameter 'userId' is set
@@ -564,7 +605,6 @@ class ChatApi {
 	 * 
 	 * @param {String} roomJid roomId
 	 * @param {Object} body messageBody
-	 * postChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postChatsRoomMessages(roomJid, body) { 
 		// verify the required parameter 'roomJid' is set
@@ -595,7 +635,6 @@ class ChatApi {
 	 * 
 	 * @param {String} roomJid roomJid
 	 * @param {String} userId userId
-	 * postChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postChatsRoomParticipant(roomJid, userId) { 
 		// verify the required parameter 'roomJid' is set
@@ -626,7 +665,6 @@ class ChatApi {
 	 * 
 	 * @param {String} roomJid roomJid
 	 * @param {Object} body Pinned Message Ids
-	 * postChatsRoomPinnedmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postChatsRoomPinnedmessages(roomJid, body) { 
 		// verify the required parameter 'roomJid' is set
@@ -656,7 +694,6 @@ class ChatApi {
 	 * Create an adhoc room
 	 * 
 	 * @param {Object} body Room properties
-	 * postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postChatsRooms(body) { 
 		// verify the required parameter 'body' is set
@@ -683,7 +720,6 @@ class ChatApi {
 	 * 
 	 * @param {String} userId userId
 	 * @param {Object} body message body
-	 * postChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postChatsUserMessages(userId, body) { 
 		// verify the required parameter 'userId' is set
@@ -709,6 +745,36 @@ class ChatApi {
 		);
 	}
 
+	/**
+	 * Update reactions to a message
+	 * 
+	 * @param {String} messageId messageId
+	 * @param {Object} body reactionUpdate
+	 */
+	putChatsMessageReactions(messageId, body) { 
+		// verify the required parameter 'messageId' is set
+		if (messageId === undefined || messageId === null) {
+			throw 'Missing the required parameter "messageId" when calling putChatsMessageReactions';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putChatsMessageReactions';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/chats/messages/{messageId}/reactions', 
+			'PUT', 
+			{ 'messageId': messageId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update Chat Settings.
 	 * 

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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.0.0
 	 */
 
 	/**
@@ -298,8 +298,9 @@ class ConversationsApi {
 
 	/**
 	 * Delete a Twitter messaging integration
-	 * 
+	 * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
 	 * @param {String} integrationId Integration ID
+	 * @deprecated
 	 */
 	deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) { 
 		// verify the required parameter 'integrationId' is set
@@ -2374,14 +2375,15 @@ class ConversationsApi {
 	}
 
 	/**
-	 * Get a list of Twitter Integrations
-	 * 
+	 * Get a list of Twitter Integrations (Deprecated)
+	 * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageSize Page size (default to 25)
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Object} opts.expand Expand instructions for the return value.
 	 * @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
 	 * @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
+	 * @deprecated
 	 */
 	getConversationsMessagingIntegrationsTwitter(opts) { 
 		opts = opts || {};
@@ -2402,11 +2404,12 @@ class ConversationsApi {
 	}
 
 	/**
-	 * Get a Twitter messaging integration
-	 * 
+	 * Get a Twitter messaging integration (Deprecated)
+	 * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
 	 * @param {String} integrationId Integration ID
 	 * @param {Object} opts Optional parameters
 	 * @param {Object} opts.expand Expand instructions for the return value.
+	 * @deprecated
 	 */
 	getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) { 
 		opts = opts || {};
@@ -4025,9 +4028,10 @@ class ConversationsApi {
 
 	/**
 	 * Update Twitter messaging integration
-	 * 
+	 * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
 	 * @param {String} integrationId Integration ID
 	 * @param {Object} body TwitterIntegrationRequest
+	 * @deprecated
 	 */
 	patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) { 
 		// verify the required parameter 'integrationId' is set
@@ -6313,8 +6317,9 @@ class ConversationsApi {
 
 	/**
 	 * Create a Twitter Integration
-	 * 
+	 * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
 	 * @param {Object} body TwitterIntegrationRequest
+	 * @deprecated
 	 */
 	postConversationsMessagingIntegrationsTwitter(body) { 
 		// verify the required parameter 'body' is set

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

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

@@ -5,7 +5,7 @@ class DownloadsApi {
 	/**
 	 * Downloads service.
 	 * @module purecloud-platform-client-v2/api/DownloadsApi
-	 * @version 189.0.0
+	 * @version 190.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class EmailsApi {
 	/**
 	 * Emails service.
 	 * @module purecloud-platform-client-v2/api/EmailsApi
-	 * @version 189.0.0
+	 * @version 190.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class EventsApi {
 	/**
 	 * Events service.
 	 * @module purecloud-platform-client-v2/api/EventsApi
-	 * @version 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.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 189.0.0
+	 * @version 190.0.0
 	 */
 
 	/**