purecloud-platform-client-v2 196.0.0 → 198.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "196.0.0",
+  "version": "198.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 196.0.0
+ * @version 198.0.0
  */
 class ApiClient {
 	/**

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

@@ -0,0 +1,136 @@
+import ApiClient from '../ApiClient.js';
+
+
+class AgentUIApi {
+	/**
+	 * AgentUI service.
+	 * @module purecloud-platform-client-v2/api/AgentUIApi
+	 * @version 198.0.0
+	 */
+
+	/**
+	 * Constructs a new AgentUIApi. 
+	 * @alias module:purecloud-platform-client-v2/api/AgentUIApi
+	 * @class
+	 * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
+	 * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
+	 */
+	constructor(apiClient) {
+		this.apiClient = apiClient || ApiClient.instance;
+	}
+
+
+	/**
+	 * Delete agent auto answer settings
+	 * 
+	 * @param {String} agentId The agent to apply the auto answer settings to
+	 */
+	deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) { 
+		// verify the required parameter 'agentId' is set
+		if (agentId === undefined || agentId === null) {
+			throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings', 
+			'DELETE', 
+			{ 'agentId': agentId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get agent auto answer settings
+	 * 
+	 * @param {String} agentId The agent to apply the auto answer settings to
+	 */
+	getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) { 
+		// verify the required parameter 'agentId' is set
+		if (agentId === undefined || agentId === null) {
+			throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings', 
+			'GET', 
+			{ 'agentId': agentId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update agent auto answer settings
+	 * 
+	 * @param {String} agentId The agent to apply the auto answer settings to
+	 * @param {Object} body AutoAnswerSettings
+	 */
+	patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) { 
+		// verify the required parameter 'agentId' is set
+		if (agentId === undefined || agentId === null) {
+			throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings', 
+			'PATCH', 
+			{ 'agentId': agentId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Set agent auto answer settings
+	 * 
+	 * @param {String} agentId The agent to apply the auto answer settings to
+	 * @param {Object} body AutoAnswerSettings
+	 */
+	putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) { 
+		// verify the required parameter 'agentId' is set
+		if (agentId === undefined || agentId === null) {
+			throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings', 
+			'PUT', 
+			{ 'agentId': agentId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+}
+
+
+export default AgentUIApi;

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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**
@@ -724,6 +724,69 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Get Suggestion.
+	 * 
+	 * @param {String} conversationId Conversation ID
+	 * @param {String} suggestionId Suggestion ID
+	 */
+	getConversationSuggestion(conversationId, suggestionId) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling getConversationSuggestion';
+		}
+		// verify the required parameter 'suggestionId' is set
+		if (suggestionId === undefined || suggestionId === null) {
+			throw 'Missing the required parameter "suggestionId" when calling getConversationSuggestion';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/{conversationId}/suggestions/{suggestionId}', 
+			'GET', 
+			{ 'conversationId': conversationId,'suggestionId': suggestionId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get all suggestions for a conversation.
+	 * 
+	 * @param {String} conversationId Conversation ID
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
+	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
+	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
+	 * @param {Object} opts.type Suggestion type to filter by.
+	 * @param {Object} opts.state Suggestion state to filter Copilot suggestions.
+	 */
+	getConversationSuggestions(conversationId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling getConversationSuggestions';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/{conversationId}/suggestions', 
+			'GET', 
+			{ 'conversationId': conversationId },
+			{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'type': opts['type'],'state': opts['state'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get active conversations for the logged in user
 	 * 
@@ -3657,6 +3720,42 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Update conversation by setting its parking state
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {String} participantId participantId
+	 * @param {Object} body Parking update request
+	 * patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	patchConversationsEmailParticipantParkingstate(conversationId, participantId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';
+		}
+		// verify the required parameter 'participantId' is set
+		if (participantId === undefined || participantId === null) {
+			throw 'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchConversationsEmailParticipantParkingstate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/emails/{conversationId}/participants/{participantId}/parkingstate', 
+			'PATCH', 
+			{ 'conversationId': conversationId,'participantId': participantId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update a conversation by disconnecting all of the participants
 	 * 
@@ -4539,6 +4638,71 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Save an engagement on the suggestion.
+	 * 
+	 * @param {String} conversationId Conversation ID
+	 * @param {String} suggestionId Suggestion ID
+	 * @param {Object} body 
+	 */
+	postConversationSuggestionEngagement(conversationId, suggestionId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionEngagement';
+		}
+		// verify the required parameter 'suggestionId' is set
+		if (suggestionId === undefined || suggestionId === null) {
+			throw 'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationSuggestionEngagement';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement', 
+			'POST', 
+			{ 'conversationId': conversationId,'suggestionId': suggestionId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Suggestion feedback.
+	 * 
+	 * @param {String} conversationId Conversation ID
+	 * @param {Object} body SuggestionFeedback
+	 */
+	postConversationSuggestionsFeedback(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationSuggestionsFeedback';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/{conversationId}/suggestions/feedback', 
+			'POST', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Submit feedback for the summary.
 	 * 

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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.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 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**

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

@@ -0,0 +1,156 @@
+import ApiClient from '../ApiClient.js';
+
+
+class EmployeeEngagementApi {
+	/**
+	 * EmployeeEngagement service.
+	 * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
+	 * @version 198.0.0
+	 */
+
+	/**
+	 * Constructs a new EmployeeEngagementApi. 
+	 * @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
+	 * @class
+	 * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
+	 * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
+	 */
+	constructor(apiClient) {
+		this.apiClient = apiClient || ApiClient.instance;
+	}
+
+
+	/**
+	 * Deletes a celebration
+	 * 
+	 * @param {String} celebrationId The ID of the celebration
+	 */
+	deleteEmployeeengagementCelebration(celebrationId) { 
+		// verify the required parameter 'celebrationId' is set
+		if (celebrationId === undefined || celebrationId === null) {
+			throw 'Missing the required parameter "celebrationId" when calling deleteEmployeeengagementCelebration';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/employeeengagement/celebrations/{celebrationId}', 
+			'DELETE', 
+			{ 'celebrationId': celebrationId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get all celebrations
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageNumber  (default to 1)
+	 * @param {Number} opts.pageSize  (default to 25)
+	 */
+	getEmployeeengagementCelebrations(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/employeeengagement/celebrations', 
+			'GET', 
+			{  },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Gets a single recognition
+	 * 
+	 * @param {String} recognitionId The Recognition ID
+	 */
+	getEmployeeengagementRecognition(recognitionId) { 
+		// verify the required parameter 'recognitionId' is set
+		if (recognitionId === undefined || recognitionId === null) {
+			throw 'Missing the required parameter "recognitionId" when calling getEmployeeengagementRecognition';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/employeeengagement/recognitions/{recognitionId}', 
+			'GET', 
+			{ 'recognitionId': recognitionId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Set a state for a celebration
+	 * 
+	 * @param {String} celebrationId The ID of the celebration
+	 * @param {Object} body Patch Celebration state
+	 */
+	patchEmployeeengagementCelebration(celebrationId, body) { 
+		// verify the required parameter 'celebrationId' is set
+		if (celebrationId === undefined || celebrationId === null) {
+			throw 'Missing the required parameter "celebrationId" when calling patchEmployeeengagementCelebration';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchEmployeeengagementCelebration';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/employeeengagement/celebrations/{celebrationId}', 
+			'PATCH', 
+			{ 'celebrationId': celebrationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Creates a recognition
+	 * 
+	 * @param {Object} body Create Recognition
+	 */
+	postEmployeeengagementRecognitions(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/employeeengagement/recognitions', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+}
+
+
+export default EmployeeEngagementApi;

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 196.0.0
+	 * @version 198.0.0
 	 */
 
 	/**