purecloud-platform-client-v2 142.0.0 → 145.0.0

package/package.json

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

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

@@ -10,4 +10,5 @@ export default {
 	eu_west_2: 'euw2.pure.cloud',
 	ap_south_1: 'aps1.pure.cloud',
 	us_east_2: 'use2.us-gov-pure.cloud',
+	sa_east_1: 'sae1.pure.cloud',
 };

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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.0.0
 	 */
 
 	/**
@@ -598,6 +598,31 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Get the secure attributes on a conversation.
+	 * 
+	 * @param {String} conversationId conversation ID
+	 */
+	getConversationSecureattributes(conversationId) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling getConversationSecureattributes';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/{conversationId}/secureattributes', 
+			'GET', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get active conversations for the logged in user
 	 * 
@@ -1381,6 +1406,51 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Get the encryption key configurations
+	 * 
+	 * @param {String} keyconfigurationsId Key Configurations Id
+	 */
+	getConversationsKeyconfiguration(keyconfigurationsId) { 
+		// verify the required parameter 'keyconfigurationsId' is set
+		if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
+			throw 'Missing the required parameter "keyconfigurationsId" when calling getConversationsKeyconfiguration';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}', 
+			'GET', 
+			{ 'keyconfigurationsId': keyconfigurationsId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a list of key configurations data
+	 * 
+	 */
+	getConversationsKeyconfigurations() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/keyconfigurations', 
+			'GET', 
+			{  },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get message conversation
 	 * 
@@ -2097,6 +2167,36 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Update the secure attributes on a conversation.
+	 * 
+	 * @param {String} conversationId conversation ID
+	 * @param {Object} body Conversation Secure Attributes
+	 */
+	patchConversationSecureattributes(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchConversationSecureattributes';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/{conversationId}/secureattributes', 
+			'PATCH', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
 	 * 
@@ -4099,6 +4199,56 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Setup configurations for encryption key creation
+	 * 
+	 * @param {Object} body Encryption Configuration
+	 */
+	postConversationsKeyconfigurations(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurations';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/keyconfigurations', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Validate encryption key configurations without saving it
+	 * 
+	 * @param {Object} body Encryption Configuration
+	 */
+	postConversationsKeyconfigurationsValidate(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/keyconfigurations/validate', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Send message
 	 * Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.
@@ -4483,6 +4633,36 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Set the secure attributes on a conversation.
+	 * 
+	 * @param {String} conversationId conversation ID
+	 * @param {Object} body Conversation Secure Attributes
+	 */
+	putConversationSecureattributes(conversationId, body) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling putConversationSecureattributes';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationSecureattributes';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/{conversationId}/secureattributes', 
+			'PUT', 
+			{ 'conversationId': conversationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update the tags on a conversation.
 	 * 
@@ -4733,6 +4913,36 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Update the encryption key configurations
+	 * 
+	 * @param {String} keyconfigurationsId Key Configurations Id
+	 * @param {Object} body Encryption key configuration metadata
+	 */
+	putConversationsKeyconfiguration(keyconfigurationsId, body) { 
+		// verify the required parameter 'keyconfigurationsId' is set
+		if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
+			throw 'Missing the required parameter "keyconfigurationsId" when calling putConversationsKeyconfiguration';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsKeyconfiguration';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}', 
+			'PUT', 
+			{ 'keyconfigurationsId': keyconfigurationsId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update a conversation by setting its recording state
 	 * 

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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.0.0
 	 */
 
 	/**
@@ -20,6 +20,81 @@ class GamificationApi {
 	}
 
 
+	/**
+	 * Delete an External Metric Definition
+	 * 
+	 * @param {String} metricId Specifies the External Metric Definition ID
+	 */
+	deleteEmployeeperformanceExternalmetricsDefinition(metricId) { 
+		// verify the required parameter 'metricId' is set
+		if (metricId === undefined || metricId === null) {
+			throw 'Missing the required parameter "metricId" when calling deleteEmployeeperformanceExternalmetricsDefinition';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/employeeperformance/externalmetrics/definitions/{metricId}', 
+			'DELETE', 
+			{ 'metricId': metricId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get an External Metric Definition
+	 * 
+	 * @param {String} metricId Specifies the External Metric Definition ID
+	 */
+	getEmployeeperformanceExternalmetricsDefinition(metricId) { 
+		// verify the required parameter 'metricId' is set
+		if (metricId === undefined || metricId === null) {
+			throw 'Missing the required parameter "metricId" when calling getEmployeeperformanceExternalmetricsDefinition';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/employeeperformance/externalmetrics/definitions/{metricId}', 
+			'GET', 
+			{ 'metricId': metricId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a list of External Metric Definitions of an organization, sorted by name in ascending order
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageSize Page size (default to 25)
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 */
+	getEmployeeperformanceExternalmetricsDefinitions(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/employeeperformance/externalmetrics/definitions', 
+			'GET', 
+			{  },
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Leaderboard of the requesting user's division or performance profile
 	 * 
@@ -684,14 +759,14 @@ class GamificationApi {
 	 * @param {String} profileId performanceProfileId
 	 * @param {String} metricId metricId
 	 * @param {Object} filterType Filter type for the query request.
-	 * @param {String} filterId ID for the filter type. For example, division Id
 	 * @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
 	 * @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
 	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.filterId ID for the filter type. Only required when filterType is Division.
 	 * @param {String} opts.referenceWorkday Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
 	 * @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
 	 */
-	getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, filterId, startWorkday, endWorkday, opts) { 
+	getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, startWorkday, endWorkday, opts) { 
 		opts = opts || {};
 		
 		// verify the required parameter 'profileId' is set
@@ -706,10 +781,6 @@ class GamificationApi {
 		if (filterType === undefined || filterType === null) {
 			throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
 		}
-		// verify the required parameter 'filterId' is set
-		if (filterId === undefined || filterId === null) {
-			throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
-		}
 		// verify the required parameter 'startWorkday' is set
 		if (startWorkday === undefined || startWorkday === null) {
 			throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
@@ -723,7 +794,7 @@ class GamificationApi {
 			'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends', 
 			'GET', 
 			{ 'profileId': profileId,'metricId': metricId },
-			{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
+			{ 'filterType': filterType,'filterId': opts['filterId'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
 			{  },
 			{  },
 			null, 
@@ -1229,6 +1300,84 @@ class GamificationApi {
 		);
 	}
 
+	/**
+	 * Update External Metric Definition
+	 * 
+	 * @param {String} metricId Specifies the metric definition ID
+	 * @param {Object} body The External Metric Definition parameters to be updated
+	 */
+	patchEmployeeperformanceExternalmetricsDefinition(metricId, body) { 
+		// verify the required parameter 'metricId' is set
+		if (metricId === undefined || metricId === null) {
+			throw 'Missing the required parameter "metricId" when calling patchEmployeeperformanceExternalmetricsDefinition';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchEmployeeperformanceExternalmetricsDefinition';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/employeeperformance/externalmetrics/definitions/{metricId}', 
+			'PATCH', 
+			{ 'metricId': metricId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Write External Metric Data
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body The External Metric Data to be added
+	 */
+	postEmployeeperformanceExternalmetricsData(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/employeeperformance/externalmetrics/data', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Create External Metric Definition
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body The External Metric Definition to be created
+	 */
+	postEmployeeperformanceExternalmetricsDefinitions(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/employeeperformance/externalmetrics/definitions', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Creates a gamified metric with a given metric definition and metric objective
 	 * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.

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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.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 142.0.0
+	 * @version 145.0.0
 	 */
 
 	/**