npm - purecloud-platform-client-v2 - Versions diffs - 239.0.0 → 241.1.0 - Mend

purecloud-platform-client-v2 239.0.0 → 241.1.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 (94) hide show

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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class LogCaptureApi {
 	/**
 	 * LogCapture service.
 	 * @module purecloud-platform-client-v2/api/LogCaptureApi
-	 * @version 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class OperationalEventsApi {
 	/**
 	 * OperationalEvents service.
 	 * @module purecloud-platform-client-v2/api/OperationalEventsApi
-	 * @version 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class ProcessAutomationApi {
 	/**
 	 * ProcessAutomation service.
 	 * @module purecloud-platform-client-v2/api/ProcessAutomationApi
-	 * @version 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.0
 	 */
 	/**
@@ -195,6 +195,32 @@ class RoutingApi {
 		);
 	}
+	/**
+	 * Delete a custom Key Performance Indicator.
+	 *
+	 * @param {String} kpiId Key Performance Indicator ID
+	 * deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	deleteRoutingPredictorsKeyperformanceindicator(kpiId) {
+		// verify the required parameter 'kpiId' is set
+		if (kpiId === undefined || kpiId === null || kpiId === '') {
+			throw 'Missing the required parameter "kpiId" when calling deleteRoutingPredictorsKeyperformanceindicator';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
+			'DELETE',
+			{ 'kpiId': kpiId },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Delete a queue
 	 *
@@ -1335,6 +1361,36 @@ class RoutingApi {
 		);
 	}
+	/**
+	 * Retrieve a single Key Performance Indicator.
+	 *
+	 * @param {String} kpiId Key Performance Indicator ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
+	 * getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getRoutingPredictorsKeyperformanceindicator(kpiId, opts) {
+		opts = opts || {};
+		// verify the required parameter 'kpiId' is set
+		if (kpiId === undefined || kpiId === null || kpiId === '') {
+			throw 'Missing the required parameter "kpiId" when calling getRoutingPredictorsKeyperformanceindicator';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
+			'GET',
+			{ 'kpiId': kpiId },
+			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Get a list of Key Performance Indicators
 	 *
@@ -1360,6 +1416,27 @@ class RoutingApi {
 		);
 	}
+	/**
+	 * Get a list of Key Performance Indicators Types available.
+	 *
+	 * getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getRoutingPredictorsKeyperformanceindicatortypes() {
+		return this.apiClient.callApi(
+			'/api/v2/routing/predictors/keyperformanceindicatortypes',
+			'GET',
+			{  },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Get details about this queue.
 	 *
@@ -2770,6 +2847,36 @@ class RoutingApi {
 		);
 	}
+	/**
+	 * Update a custom Key Performance Indicator.
+	 *
+	 * @param {String} kpiId Key Performance Indicator ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body
+	 * patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	patchRoutingPredictorsKeyperformanceindicator(kpiId, opts) {
+		opts = opts || {};
+		// verify the required parameter 'kpiId' is set
+		if (kpiId === undefined || kpiId === null || kpiId === '') {
+			throw 'Missing the required parameter "kpiId" when calling patchRoutingPredictorsKeyperformanceindicator';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
+			'PATCH',
+			{ 'kpiId': kpiId },
+			{  },
+			{  },
+			{  },
+			opts['body'],
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Update the ring number OR joined status for a queue member.
 	 *
@@ -3542,6 +3649,32 @@ class RoutingApi {
 		);
 	}
+	/**
+	 * Create a custom Key Performance Indicator.
+	 *
+	 * @param {Object} body request
+	 * postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postRoutingPredictorsKeyperformanceindicators(body) {
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postRoutingPredictorsKeyperformanceindicators';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/routing/predictors/keyperformanceindicators',
+			'POST',
+			{  },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Bulk add or delete up to 100 queue members
 	 *

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 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class ScreenRecordingApi {
 	/**
 	 * ScreenRecording service.
 	 * @module purecloud-platform-client-v2/api/ScreenRecordingApi
-	 * @version 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.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 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class SettingsApi {
 	/**
 	 * Settings service.
 	 * @module purecloud-platform-client-v2/api/SettingsApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class SocialMediaApi {
 	/**
 	 * SocialMedia service.
 	 * @module purecloud-platform-client-v2/api/SocialMediaApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**
@@ -907,6 +907,7 @@ class SocialMediaApi {
 	 * @param {Number} opts.pageSize Page size (default to 25)
 	 * @param {Array.<String>} opts.divisionIds One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
 	 * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
+	 * @param {String} opts.name Search for topic by name that contains the given search string, search is case insensitive
 	 */
 	getSocialmediaTopics(opts) {
 		opts = opts || {};
@@ -916,7 +917,7 @@ class SocialMediaApi {
 			'/api/v2/socialmedia/topics',
 			'GET',
 			{  },
-			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'] },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'],'name': opts['name'] },
 			{  },
 			{  },
 			null,

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

@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
 	/**
 	 * SpeechTextAnalytics service.
 	 * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class StationsApi {
 	/**
 	 * Stations service.
 	 * @module purecloud-platform-client-v2/api/StationsApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class SuggestApi {
 	/**
 	 * Suggest service.
 	 * @module purecloud-platform-client-v2/api/SuggestApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TaskManagementApi {
 	/**
 	 * TaskManagement service.
 	 * @module purecloud-platform-client-v2/api/TaskManagementApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TeamsApi {
 	/**
 	 * Teams service.
 	 * @module purecloud-platform-client-v2/api/TeamsApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TelephonyApi {
 	/**
 	 * Telephony service.
 	 * @module purecloud-platform-client-v2/api/TelephonyApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
 	/**
 	 * TelephonyProvidersEdge service.
 	 * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TextbotsApi {
 	/**
 	 * Textbots service.
 	 * @module purecloud-platform-client-v2/api/TextbotsApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TokensApi {
 	/**
 	 * Tokens service.
 	 * @module purecloud-platform-client-v2/api/TokensApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class UploadsApi {
 	/**
 	 * Uploads service.
 	 * @module purecloud-platform-client-v2/api/UploadsApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class UsageApi {
 	/**
 	 * Usage service.
 	 * @module purecloud-platform-client-v2/api/UsageApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class UserRecordingsApi {
 	/**
 	 * UserRecordings service.
 	 * @module purecloud-platform-client-v2/api/UserRecordingsApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class UsersApi {
 	/**
 	 * Users service.
 	 * @module purecloud-platform-client-v2/api/UsersApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class UsersRulesApi {
 	/**
 	 * UsersRules service.
 	 * @module purecloud-platform-client-v2/api/UsersRulesApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class UtilitiesApi {
 	/**
 	 * Utilities service.
 	 * @module purecloud-platform-client-v2/api/UtilitiesApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class VoicemailApi {
 	/**
 	 * Voicemail service.
 	 * @module purecloud-platform-client-v2/api/VoicemailApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class WebChatApi {
 	/**
 	 * WebChat service.
 	 * @module purecloud-platform-client-v2/api/WebChatApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class WebDeploymentsApi {
 	/**
 	 * WebDeployments service.
 	 * @module purecloud-platform-client-v2/api/WebDeploymentsApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class WebMessagingApi {
 	/**
 	 * WebMessaging service.
 	 * @module purecloud-platform-client-v2/api/WebMessagingApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class WidgetsApi {
 	/**
 	 * Widgets service.
 	 * @module purecloud-platform-client-v2/api/WidgetsApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class WorkforceManagementApi {
 	/**
 	 * WorkforceManagement service.
 	 * @module purecloud-platform-client-v2/api/WorkforceManagementApi
-	 * @version 239.0.0
+	 * @version 241.1.0
 	 */
 	/**

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

@@ -119,7 +119,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
  * </pre>
  * </p>
  * @module purecloud-platform-client-v2/index
- * @version 239.0.0
+ * @version 241.1.0
  */
 class platformClient {
 	constructor() {