purecloud-platform-client-v2 142.0.0 → 143.0.0

package/dist/web-cjs/purecloud-platform-client-v2.js

@@ -9306,7 +9306,7 @@ class Configuration {
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 142.0.0
+ * @version 143.0.0
  */
 class ApiClient {
 	/**
@@ -10378,7 +10378,7 @@ class AlertingApi {
 	/**
 	 * Alerting service.
 	 * @module purecloud-platform-client-v2/api/AlertingApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -10692,7 +10692,7 @@ class AnalyticsApi {
 	/**
 	 * Analytics service.
 	 * @module purecloud-platform-client-v2/api/AnalyticsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -11874,7 +11874,7 @@ class ArchitectApi {
 	/**
 	 * Architect service.
 	 * @module purecloud-platform-client-v2/api/ArchitectApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -14919,7 +14919,7 @@ class AuditApi {
 	/**
 	 * Audit service.
 	 * @module purecloud-platform-client-v2/api/AuditApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -15090,7 +15090,7 @@ class AuthorizationApi {
 	/**
 	 * Authorization service.
 	 * @module purecloud-platform-client-v2/api/AuthorizationApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -16273,7 +16273,7 @@ class BillingApi {
 	/**
 	 * Billing service.
 	 * @module purecloud-platform-client-v2/api/BillingApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -16353,7 +16353,7 @@ class ChatApi {
 	/**
 	 * Chat service.
 	 * @module purecloud-platform-client-v2/api/ChatApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -16444,7 +16444,7 @@ class CoachingApi {
 	/**
 	 * Coaching service.
 	 * @module purecloud-platform-client-v2/api/CoachingApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -17021,7 +17021,7 @@ class ContentManagementApi {
 	/**
 	 * ContentManagement service.
 	 * @module purecloud-platform-client-v2/api/ContentManagementApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -18161,7 +18161,7 @@ class ConversationsApi {
 	/**
 	 * Conversations service.
 	 * @module purecloud-platform-client-v2/api/ConversationsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -23095,7 +23095,7 @@ class DataExtensionsApi {
 	/**
 	 * DataExtensions service.
 	 * @module purecloud-platform-client-v2/api/DataExtensionsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -23181,7 +23181,7 @@ class ExternalContactsApi {
 	/**
 	 * ExternalContacts service.
 	 * @module purecloud-platform-client-v2/api/ExternalContactsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -24924,7 +24924,7 @@ class FaxApi {
 	/**
 	 * Fax service.
 	 * @module purecloud-platform-client-v2/api/FaxApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -25095,7 +25095,7 @@ class FlowsApi {
 	/**
 	 * Flows service.
 	 * @module purecloud-platform-client-v2/api/FlowsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -25166,7 +25166,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -25181,6 +25181,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
 	 * 
@@ -26390,6 +26465,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.
@@ -26748,7 +26901,7 @@ class GeneralDataProtectionRegulationApi {
 	/**
 	 * GeneralDataProtectionRegulation service.
 	 * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -26878,7 +27031,7 @@ class GeolocationApi {
 	/**
 	 * Geolocation service.
 	 * @module purecloud-platform-client-v2/api/GeolocationApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -27009,7 +27162,7 @@ class GreetingsApi {
 	/**
 	 * Greetings service.
 	 * @module purecloud-platform-client-v2/api/GreetingsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -27464,7 +27617,7 @@ class GroupsApi {
 	/**
 	 * Groups service.
 	 * @module purecloud-platform-client-v2/api/GroupsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -27869,7 +28022,7 @@ class IdentityProviderApi {
 	/**
 	 * IdentityProvider service.
 	 * @module purecloud-platform-client-v2/api/IdentityProviderApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -28625,7 +28778,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -30302,7 +30455,7 @@ class JourneyApi {
 	/**
 	 * Journey service.
 	 * @module purecloud-platform-client-v2/api/JourneyApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -31013,7 +31166,7 @@ class KnowledgeApi {
 	/**
 	 * Knowledge service.
 	 * @module purecloud-platform-client-v2/api/KnowledgeApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -31913,7 +32066,7 @@ class LanguageUnderstandingApi {
 	/**
 	 * LanguageUnderstanding service.
 	 * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -32817,7 +32970,7 @@ class LanguagesApi {
 	/**
 	 * Languages service.
 	 * @module purecloud-platform-client-v2/api/LanguagesApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -33085,7 +33238,7 @@ class LearningApi {
 	/**
 	 * Learning service.
 	 * @module purecloud-platform-client-v2/api/LearningApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -33820,7 +33973,7 @@ class LicenseApi {
 	/**
 	 * License service.
 	 * @module purecloud-platform-client-v2/api/LicenseApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -34058,7 +34211,7 @@ class LocationsApi {
 	/**
 	 * Locations service.
 	 * @module purecloud-platform-client-v2/api/LocationsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -34294,7 +34447,7 @@ class MessagingApi {
 	/**
 	 * Messaging service.
 	 * @module purecloud-platform-client-v2/api/MessagingApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -34445,7 +34598,7 @@ class MobileDevicesApi {
 	/**
 	 * MobileDevices service.
 	 * @module purecloud-platform-client-v2/api/MobileDevicesApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -34596,7 +34749,7 @@ class NotificationsApi {
 	/**
 	 * Notifications service.
 	 * @module purecloud-platform-client-v2/api/NotificationsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -34821,7 +34974,7 @@ class OAuthApi {
 	/**
 	 * OAuth service.
 	 * @module purecloud-platform-client-v2/api/OAuthApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -35187,7 +35340,7 @@ class ObjectsApi {
 	/**
 	 * Objects service.
 	 * @module purecloud-platform-client-v2/api/ObjectsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -35458,7 +35611,7 @@ class OrganizationApi {
 	/**
 	 * Organization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -35861,7 +36014,7 @@ class OrganizationAuthorizationApi {
 	/**
 	 * OrganizationAuthorization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -36786,7 +36939,7 @@ class OutboundApi {
 	/**
 	 * Outbound service.
 	 * @module purecloud-platform-client-v2/api/OutboundApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -40041,7 +40194,7 @@ class PresenceApi {
 	/**
 	 * Presence service.
 	 * @module purecloud-platform-client-v2/api/PresenceApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -40363,7 +40516,7 @@ class QualityApi {
 	/**
 	 * Quality service.
 	 * @module purecloud-platform-client-v2/api/QualityApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -41941,7 +42094,7 @@ class RecordingApi {
 	/**
 	 * Recording service.
 	 * @module purecloud-platform-client-v2/api/RecordingApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -43594,7 +43747,7 @@ class ResponseManagementApi {
 	/**
 	 * ResponseManagement service.
 	 * @module purecloud-platform-client-v2/api/ResponseManagementApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -44078,7 +44231,7 @@ class RoutingApi {
 	/**
 	 * Routing service.
 	 * @module purecloud-platform-client-v2/api/RoutingApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -46999,7 +47152,7 @@ class SCIMApi {
 	/**
 	 * SCIM service.
 	 * @module purecloud-platform-client-v2/api/SCIMApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -47876,7 +48029,7 @@ class ScriptsApi {
 	/**
 	 * Scripts service.
 	 * @module purecloud-platform-client-v2/api/ScriptsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -48295,7 +48448,7 @@ class SearchApi {
 	/**
 	 * Search service.
 	 * @module purecloud-platform-client-v2/api/SearchApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -48855,7 +49008,7 @@ class SpeechTextAnalyticsApi {
 	/**
 	 * SpeechTextAnalytics service.
 	 * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -49709,7 +49862,7 @@ class StationsApi {
 	/**
 	 * Stations service.
 	 * @module purecloud-platform-client-v2/api/StationsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -49856,7 +50009,7 @@ class SuggestApi {
 	/**
 	 * Suggest service.
 	 * @module purecloud-platform-client-v2/api/SuggestApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -49995,7 +50148,7 @@ class TeamsApi {
 	/**
 	 * Teams service.
 	 * @module purecloud-platform-client-v2/api/TeamsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -50174,7 +50327,7 @@ class TelephonyApi {
 	/**
 	 * Telephony service.
 	 * @module purecloud-platform-client-v2/api/TelephonyApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -50282,7 +50435,7 @@ class TelephonyProvidersEdgeApi {
 	/**
 	 * TelephonyProvidersEdge service.
 	 * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -53915,7 +54068,7 @@ class TextbotsApi {
 	/**
 	 * Textbots service.
 	 * @module purecloud-platform-client-v2/api/TextbotsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -54043,7 +54196,7 @@ class TokensApi {
 	/**
 	 * Tokens service.
 	 * @module purecloud-platform-client-v2/api/TokensApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -54149,7 +54302,7 @@ class UploadsApi {
 	/**
 	 * Uploads service.
 	 * @module purecloud-platform-client-v2/api/UploadsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -54300,7 +54453,7 @@ class UsageApi {
 	/**
 	 * Usage service.
 	 * @module purecloud-platform-client-v2/api/UsageApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -54371,7 +54524,7 @@ class UserRecordingsApi {
 	/**
 	 * UserRecordings service.
 	 * @module purecloud-platform-client-v2/api/UserRecordingsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -54555,7 +54708,7 @@ class UsersApi {
 	/**
 	 * Users service.
 	 * @module purecloud-platform-client-v2/api/UsersApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -56857,7 +57010,7 @@ class UtilitiesApi {
 	/**
 	 * Utilities service.
 	 * @module purecloud-platform-client-v2/api/UtilitiesApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -56968,7 +57121,7 @@ class VoicemailApi {
 	/**
 	 * Voicemail service.
 	 * @module purecloud-platform-client-v2/api/VoicemailApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -57635,7 +57788,7 @@ class WebChatApi {
 	/**
 	 * WebChat service.
 	 * @module purecloud-platform-client-v2/api/WebChatApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -58179,7 +58332,7 @@ class WebDeploymentsApi {
 	/**
 	 * WebDeployments service.
 	 * @module purecloud-platform-client-v2/api/WebDeploymentsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -58534,7 +58687,7 @@ class WebMessagingApi {
 	/**
 	 * WebMessaging service.
 	 * @module purecloud-platform-client-v2/api/WebMessagingApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -58580,7 +58733,7 @@ class WidgetsApi {
 	/**
 	 * Widgets service.
 	 * @module purecloud-platform-client-v2/api/WidgetsApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -58726,7 +58879,7 @@ class WorkforceManagementApi {
 	/**
 	 * WorkforceManagement service.
 	 * @module purecloud-platform-client-v2/api/WorkforceManagementApi
-	 * @version 142.0.0
+	 * @version 143.0.0
 	 */
 
 	/**
@@ -63002,7 +63155,7 @@ class WorkforceManagementApi {
  * </pre>
  * </p>
  * @module purecloud-platform-client-v2/index
- * @version 142.0.0
+ * @version 143.0.0
  */
 class platformClient {
 	constructor() {