npm - purecloud-platform-client-v2 - Versions diffs - 231.0.0 → 232.0.0 - Mend

purecloud-platform-client-v2 231.0.0 → 232.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 (93) hide show

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 231.0.0
+	 * @version 232.0.0
 	 */
 	/**
@@ -189,6 +189,9 @@ class IntegrationsApi {
 	 * @param {Array.<String>} opts.expand variable name requested by expand list
 	 * @param {String} opts.nextPage next page token
 	 * @param {String} opts.previousPage Previous page token
+	 * @param {Array.<String>} opts.ids Comma-separated list of integration IDs to filter by (max 100)
+	 * @param {String} opts.integrationType Filter integrations by integration type ID
+	 * @param {Object} opts.reportedState Filter integrations by reported state (case-insensitive)
 	 */
 	getIntegrations(opts) {
 		opts = opts || {};
@@ -198,7 +201,7 @@ class IntegrationsApi {
 			'/api/v2/integrations',
 			'GET',
 			{  },
-			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] },
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'integrationType': opts['integrationType'],'reportedState': opts['reportedState'] },
 			{  },
 			{  },
 			null,

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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.0.0
 	 */
 	/**
@@ -1003,8 +1003,12 @@ class LearningApi {
 	 * This will update a learning module rule with the specified fields.
 	 * @param {String} moduleId The ID of the learning module
 	 * @param {Object} body The learning module rule to be updated
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.assign Whether to assign the module to users or not (default to true)
 	 */
-	putLearningModuleRule(moduleId, body) {
+	putLearningModuleRule(moduleId, body, opts) {
+		opts = opts || {};
 		// verify the required parameter 'moduleId' is set
 		if (moduleId === undefined || moduleId === null || moduleId === '') {
 			throw 'Missing the required parameter "moduleId" when calling putLearningModuleRule';
@@ -1018,7 +1022,7 @@ class LearningApi {
 			'/api/v2/learning/modules/{moduleId}/rule',
 			'PUT',
 			{ 'moduleId': moduleId },
-			{  },
+			{ 'assign': opts['assign'] },
 			{  },
 			{  },
 			body,

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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.0.0
 	 */
 	/**
@@ -588,7 +588,7 @@ class QualityApi {
 	}
 	/**
-	 * Get an evaluator activity
+	 * Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests.
 	 *
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageSize The total page size requested (default to 25)

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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.0.0
 	 */
 	/**
@@ -1239,6 +1239,8 @@ class RoutingApi {
 	 * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
 	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
 	 * @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
+	 * @param {String} opts.kpiId Standard or custom KPI id used to filter predictors.
+	 * @param {Object} opts.state The state used to filter predictors.
 	 */
 	getRoutingPredictors(opts) {
 		opts = opts || {};
@@ -1248,7 +1250,7 @@ class RoutingApi {
 			'/api/v2/routing/predictors',
 			'GET',
 			{  },
-			{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'queueId': this.apiClient.buildCollectionParam(opts['queueId'], 'multi') },
+			{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'queueId': this.apiClient.buildCollectionParam(opts['queueId'], 'multi'),'kpiId': opts['kpiId'],'state': opts['state'] },
 			{  },
 			{  },
 			null,
@@ -1317,7 +1319,7 @@ class RoutingApi {
 	 *
 	 * @param {String} queueId Queue ID
 	 * @param {Object} opts Optional parameters
-	 * @param {Object} opts.expand Which fields, if any, to expand.
+	 * @param {Array.<String>} opts.expand Which fields, if any, to expand.
 	 */
 	getRoutingQueueAssistant(queueId, opts) {
 		opts = opts || {};
@@ -1331,7 +1333,7 @@ class RoutingApi {
 			'/api/v2/routing/queues/{queueId}/assistant',
 			'GET',
 			{ 'queueId': queueId },
-			{ 'expand': opts['expand'] },
+			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
 			{  },
 			{  },
 			null,

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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.0
 	 */
 	/**

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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.0
 	 */
 	/**
@@ -79,7 +79,8 @@ class WebChatApi {
 	/**
 	 * Remove WebChat deployment settings
-	 *
+	 * This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
+	 * @deprecated
 	 */
 	deleteWebchatSettings() {
@@ -330,7 +331,8 @@ class WebChatApi {
 	/**
 	 * Get WebChat deployment settings
-	 *
+	 * This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
+	 * @deprecated
 	 */
 	getWebchatSettings() {
@@ -536,8 +538,9 @@ class WebChatApi {
 	/**
 	 * Update WebChat deployment settings
-	 *
+	 * This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
 	 * @param {Object} body webChatSettings
+	 * @deprecated
 	 */
 	putWebchatSettings(body) {
 		// verify the required parameter 'body' is set

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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.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 231.0.0
+	 * @version 232.0.0
 	 */
 	/**