npm - purecloud-platform-client-v2 - Versions diffs - 141.0.0 → 143.0.0 - Mend

purecloud-platform-client-v2 141.0.0 → 143.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (74) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "141.0.0",
+  "version": "143.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 CHANGED Viewed

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

package/src/purecloud-platform-client-v2/api/AlertingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class AlertingApi {
 	/**
 	 * Alerting service.
 	 * @module purecloud-platform-client-v2/api/AlertingApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/AnalyticsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class AnalyticsApi {
 	/**
 	 * Analytics service.
 	 * @module purecloud-platform-client-v2/api/AnalyticsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ArchitectApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ArchitectApi {
 	/**
 	 * Architect service.
 	 * @module purecloud-platform-client-v2/api/ArchitectApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/AuditApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class AuditApi {
 	/**
 	 * Audit service.
 	 * @module purecloud-platform-client-v2/api/AuditApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/AuthorizationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class AuthorizationApi {
 	/**
 	 * Authorization service.
 	 * @module purecloud-platform-client-v2/api/AuthorizationApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/BillingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class BillingApi {
 	/**
 	 * Billing service.
 	 * @module purecloud-platform-client-v2/api/BillingApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ChatApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ChatApi {
 	/**
 	 * Chat service.
 	 * @module purecloud-platform-client-v2/api/ChatApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/CoachingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class CoachingApi {
 	/**
 	 * Coaching service.
 	 * @module purecloud-platform-client-v2/api/CoachingApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ContentManagementApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ContentManagementApi {
 	/**
 	 * ContentManagement service.
 	 * @module purecloud-platform-client-v2/api/ContentManagementApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ConversationsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ConversationsApi {
 	/**
 	 * Conversations service.
 	 * @module purecloud-platform-client-v2/api/ConversationsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class DataExtensionsApi {
 	/**
 	 * DataExtensions service.
 	 * @module purecloud-platform-client-v2/api/DataExtensionsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ExternalContactsApi {
 	/**
 	 * ExternalContacts service.
 	 * @module purecloud-platform-client-v2/api/ExternalContactsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/FaxApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class FaxApi {
 	/**
 	 * Fax service.
 	 * @module purecloud-platform-client-v2/api/FaxApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/FlowsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class FlowsApi {
 	/**
 	 * Flows service.
 	 * @module purecloud-platform-client-v2/api/FlowsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/GamificationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 141.0.0
+	 * @version 143.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
 	 *
@@ -1229,6 +1304,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 CHANGED Viewed

@@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi {
 	/**
 	 * GeneralDataProtectionRegulation service.
 	 * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/GeolocationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class GeolocationApi {
 	/**
 	 * Geolocation service.
 	 * @module purecloud-platform-client-v2/api/GeolocationApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/GreetingsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class GreetingsApi {
 	/**
 	 * Greetings service.
 	 * @module purecloud-platform-client-v2/api/GreetingsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/GroupsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class GroupsApi {
 	/**
 	 * Groups service.
 	 * @module purecloud-platform-client-v2/api/GroupsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class IdentityProviderApi {
 	/**
 	 * IdentityProvider service.
 	 * @module purecloud-platform-client-v2/api/IdentityProviderApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/IntegrationsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/JourneyApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class JourneyApi {
 	/**
 	 * Journey service.
 	 * @module purecloud-platform-client-v2/api/JourneyApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/KnowledgeApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class KnowledgeApi {
 	/**
 	 * Knowledge service.
 	 * @module purecloud-platform-client-v2/api/KnowledgeApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
 	/**
 	 * LanguageUnderstanding service.
 	 * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/LanguagesApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class LanguagesApi {
 	/**
 	 * Languages service.
 	 * @module purecloud-platform-client-v2/api/LanguagesApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/LearningApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class LearningApi {
 	/**
 	 * Learning service.
 	 * @module purecloud-platform-client-v2/api/LearningApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/LicenseApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class LicenseApi {
 	/**
 	 * License service.
 	 * @module purecloud-platform-client-v2/api/LicenseApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/LocationsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class LocationsApi {
 	/**
 	 * Locations service.
 	 * @module purecloud-platform-client-v2/api/LocationsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/MessagingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class MessagingApi {
 	/**
 	 * Messaging service.
 	 * @module purecloud-platform-client-v2/api/MessagingApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class MobileDevicesApi {
 	/**
 	 * MobileDevices service.
 	 * @module purecloud-platform-client-v2/api/MobileDevicesApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/NotificationsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class NotificationsApi {
 	/**
 	 * Notifications service.
 	 * @module purecloud-platform-client-v2/api/NotificationsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/OAuthApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class OAuthApi {
 	/**
 	 * OAuth service.
 	 * @module purecloud-platform-client-v2/api/OAuthApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ObjectsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ObjectsApi {
 	/**
 	 * Objects service.
 	 * @module purecloud-platform-client-v2/api/ObjectsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/OrganizationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class OrganizationApi {
 	/**
 	 * Organization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
 	/**
 	 * OrganizationAuthorization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/OutboundApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class OutboundApi {
 	/**
 	 * Outbound service.
 	 * @module purecloud-platform-client-v2/api/OutboundApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/PresenceApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class PresenceApi {
 	/**
 	 * Presence service.
 	 * @module purecloud-platform-client-v2/api/PresenceApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/QualityApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class QualityApi {
 	/**
 	 * Quality service.
 	 * @module purecloud-platform-client-v2/api/QualityApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/RecordingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class RecordingApi {
 	/**
 	 * Recording service.
 	 * @module purecloud-platform-client-v2/api/RecordingApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ResponseManagementApi {
 	/**
 	 * ResponseManagement service.
 	 * @module purecloud-platform-client-v2/api/ResponseManagementApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/RoutingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class RoutingApi {
 	/**
 	 * Routing service.
 	 * @module purecloud-platform-client-v2/api/RoutingApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/SCIMApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class SCIMApi {
 	/**
 	 * SCIM service.
 	 * @module purecloud-platform-client-v2/api/SCIMApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ScriptsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ScriptsApi {
 	/**
 	 * Scripts service.
 	 * @module purecloud-platform-client-v2/api/ScriptsApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/SearchApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class SearchApi {
 	/**
 	 * Search service.
 	 * @module purecloud-platform-client-v2/api/SearchApi
-	 * @version 141.0.0
+	 * @version 143.0.0
 	 */
 	/**
@@ -484,6 +484,31 @@ class SearchApi {
 		);
 	}
+	/**
+	 * Search resources.
+	 *
+	 * @param {Object} body Search request options
+	 */
+	postTeamsSearch(body) {
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postTeamsSearch';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/teams/search',
+			'POST',
+			{  },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Search users
 	 *