npm - purecloud-platform-client-v2 - Versions diffs - 147.0.0 → 149.0.0 - Mend

purecloud-platform-client-v2 147.0.0 → 149.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 (75) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "147.0.0",
+  "version": "149.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 147.0.0
+ * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.0.0
 	 */
 	/**
@@ -298,31 +298,6 @@ class GamificationApi {
 		);
 	}
-	/**
-	 * All gamified metrics for a given profile
-	 * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
-	 * @param {Object} opts Optional parameters
-	 * @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
-	 * @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
-	 */
-	getGamificationMetrics(opts) {
-		opts = opts || {};
-		return this.apiClient.callApi(
-			'/api/v2/gamification/metrics',
-			'GET',
-			{  },
-			{ 'performanceProfileId': opts['performanceProfileId'],'workday': opts['workday'] },
-			{  },
-			{  },
-			null,
-			['PureCloud OAuth'],
-			['application/json'],
-			['application/json']
-		);
-	}
 	/**
 	 * Performance profile by id
 	 *
@@ -1378,31 +1353,6 @@ class GamificationApi {
 		);
 	}
-	/**
-	 * Creates a gamified metric with a given metric definition and metric objective
-	 * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
-	 * @param {Object} body Metric
-	 */
-	postGamificationMetrics(body) {
-		// verify the required parameter 'body' is set
-		if (body === undefined || body === null) {
-			throw 'Missing the required parameter "body" when calling postGamificationMetrics';
-		}
-		return this.apiClient.callApi(
-			'/api/v2/gamification/metrics',
-			'POST',
-			{  },
-			{  },
-			{  },
-			{  },
-			body,
-			['PureCloud OAuth'],
-			['application/json'],
-			['application/json']
-		);
-	}
 	/**
 	 * Activate a performance profile
 	 *

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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.0.0
 	 */
 	/**
@@ -275,6 +275,7 @@ class GroupsApi {
 	 * @param {Number} opts.pageSize Page size (default to 25)
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Array.<String>} opts.id id
+	 * @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
 	 * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
 	 */
 	getProfilesGroups(opts) {
@@ -285,7 +286,7 @@ class GroupsApi {
 			'/api/v2/profiles/groups',
 			'GET',
 			{  },
-			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'sortOrder': opts['sortOrder'] },
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'jabberId': this.apiClient.buildCollectionParam(opts['jabberId'], 'multi'),'sortOrder': opts['sortOrder'] },
 			{  },
 			{  },
 			null,

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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.0.0
 	 */
 	/**
@@ -763,59 +763,6 @@ class IntegrationsApi {
 		);
 	}
-	/**
-	 * List all events
-	 *
-	 * @param {Object} opts Optional parameters
-	 * @param {Number} opts.pageSize Page size (default to 25)
-	 * @param {Number} opts.pageNumber Page number (default to 1)
-	 * @param {String} opts.sortBy Sort by (default to timestamp)
-	 * @param {String} opts.sortOrder Order by (default to descending)
-	 * @param {String} opts.entityId Include only events with this entity ID
-	 */
-	getIntegrationsEventlog(opts) {
-		opts = opts || {};
-		return this.apiClient.callApi(
-			'/api/v2/integrations/eventlog',
-			'GET',
-			{  },
-			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'entityId': opts['entityId'] },
-			{  },
-			{  },
-			null,
-			['PureCloud OAuth'],
-			['application/json'],
-			['application/json']
-		);
-	}
-	/**
-	 * Get a single event
-	 *
-	 * @param {String} eventId Event Id
-	 */
-	getIntegrationsEventlogEventId(eventId) {
-		// verify the required parameter 'eventId' is set
-		if (eventId === undefined || eventId === null) {
-			throw 'Missing the required parameter "eventId" when calling getIntegrationsEventlogEventId';
-		}
-		return this.apiClient.callApi(
-			'/api/v2/integrations/eventlog/{eventId}',
-			'GET',
-			{ 'eventId': eventId },
-			{  },
-			{  },
-			{  },
-			null,
-			['PureCloud OAuth'],
-			['application/json'],
-			['application/json']
-		);
-	}
 	/**
 	 * Get details about a Dialogflow agent
 	 *
@@ -1539,30 +1486,6 @@ class IntegrationsApi {
 		);
 	}
-	/**
-	 * Add a vendor connection
-	 *
-	 * @param {Object} opts Optional parameters
-	 * @param {Object} opts.body
-	 */
-	postIntegrationsWorkforcemanagementVendorconnection(opts) {
-		opts = opts || {};
-		return this.apiClient.callApi(
-			'/api/v2/integrations/workforcemanagement/vendorconnection',
-			'POST',
-			{  },
-			{  },
-			{  },
-			{  },
-			opts['body'],
-			['PureCloud OAuth'],
-			['application/json'],
-			['application/json']
-		);
-	}
 	/**
 	 * Update integration configuration.
 	 *

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 147.0.0
+	 * @version 149.0.0
 	 */
 	/**
@@ -180,6 +180,56 @@ class JourneyApi {
 		);
 	}
+	/**
+	 * Get status of job.
+	 *
+	 * @param {String} jobId ID of the job.
+	 */
+	getJourneyActionmapsEstimatesJob(jobId) {
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJob';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/journey/actionmaps/estimates/jobs/{jobId}',
+			'GET',
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
+	/**
+	 * Get estimates from completed job.
+	 *
+	 * @param {String} jobId ID of the job.
+	 */
+	getJourneyActionmapsEstimatesJobResults(jobId) {
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJobResults';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/journey/actionmaps/estimates/jobs/{jobId}/results',
+			'GET',
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Retrieve a single action target.
 	 *
@@ -638,6 +688,31 @@ class JourneyApi {
 		);
 	}
+	/**
+	 * Query for estimates
+	 *
+	 * @param {Object} body audience estimator request
+	 */
+	postJourneyActionmapsEstimatesJobs(body) {
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postJourneyActionmapsEstimatesJobs';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/journey/actionmaps/estimates/jobs',
+			'POST',
+			{  },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Create a single action template.
 	 *

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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.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 147.0.0
+	 * @version 149.0.0
 	 */
 	/**