purecloud-platform-client-v2 126.0.0 → 129.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "126.0.0",
+  "version": "129.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

@@ -3,7 +3,7 @@ import Configuration from './configuration.js';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 126.0.0
+ * @version 129.0.0
  */
 class ApiClient {
 	/**
@@ -950,7 +950,7 @@ class ApiClient {
 
 				// set header parameters
 				request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
-				//request.set({ 'purecloud-sdk': '126.0.0' });
+				//request.set({ 'purecloud-sdk': '129.0.0' });
 
 				// set request timeout
 				request.timeout(that.timeout);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 126.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -273,6 +273,31 @@ class GamificationApi {
 		);
 	}
 
+	/**
+	 * Members of a given performance profile
+	 * 
+	 * @param {String} performanceProfileId Performance Profile Id
+	 */
+	getGamificationProfileMembers(performanceProfileId) { 
+		// verify the required parameter 'performanceProfileId' is set
+		if (performanceProfileId === undefined || performanceProfileId === null) {
+			throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/profiles/{performanceProfileId}/members', 
+			'GET', 
+			{ 'performanceProfileId': performanceProfileId }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Performance profile gamified metric by id
 	 * 
@@ -1127,6 +1152,101 @@ class GamificationApi {
 		);
 	}
 
+	/**
+	 * Assign members to a given performance profile
+	 * 
+	 * @param {String} performanceProfileId Performance Profile Id
+	 * @param {Object} body assignUsers
+	 */
+	postGamificationProfileMembers(performanceProfileId, body) { 
+		// verify the required parameter 'performanceProfileId' is set
+		if (performanceProfileId === undefined || performanceProfileId === null) {
+			throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postGamificationProfileMembers';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/profiles/{performanceProfileId}/members', 
+			'POST', 
+			{ 'performanceProfileId': performanceProfileId }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
+	/**
+	 * Validate member assignment
+	 * 
+	 * @param {String} performanceProfileId Performance Profile Id
+	 * @param {Object} body memberAssignments
+	 */
+	postGamificationProfileMembersValidate(performanceProfileId, body) { 
+		// verify the required parameter 'performanceProfileId' is set
+		if (performanceProfileId === undefined || performanceProfileId === null) {
+			throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postGamificationProfileMembersValidate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/profiles/{performanceProfileId}/members/validate', 
+			'POST', 
+			{ 'performanceProfileId': performanceProfileId }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
+	/**
+	 * Creates a linked metric
+	 * 
+	 * @param {String} sourceProfileId Source Performance Profile Id
+	 * @param {String} sourceMetricId Source Metric Id
+	 * @param {Object} body linkedMetric
+	 */
+	postGamificationProfileMetricLink(sourceProfileId, sourceMetricId, body) { 
+		// verify the required parameter 'sourceProfileId' is set
+		if (sourceProfileId === undefined || sourceProfileId === null) {
+			throw 'Missing the required parameter "sourceProfileId" when calling postGamificationProfileMetricLink';
+		}
+		// verify the required parameter 'sourceMetricId' is set
+		if (sourceMetricId === undefined || sourceMetricId === null) {
+			throw 'Missing the required parameter "sourceMetricId" when calling postGamificationProfileMetricLink';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postGamificationProfileMetricLink';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link', 
+			'POST', 
+			{ 'sourceProfileId': sourceProfileId,'sourceMetricId': sourceMetricId }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Creates a gamified metric with a given metric definition and metric objective under in a performance profile
 	 * 

package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js

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

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

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

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 126.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -662,6 +662,35 @@ class IntegrationsApi {
 		);
 	}
 
+	/**
+	 * UC integration client application configuration.
+	 * This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageSize The total page size requested (default to 25)
+	 * @param {Number} opts.pageNumber The page number requested (default to 1)
+	 * @param {String} opts.sortBy variable name requested to sort by
+	 * @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
+	 */
+	getIntegrationsClientappsUnifiedcommunications(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/integrations/clientapps/unifiedcommunications', 
+			'GET', 
+			{  }, 
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] }, 
+			{  }, 
+			{  }, 
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a single credential with sensitive fields redacted
 	 * 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class RecordingApi {
 	/**
 	 * Recording service.
 	 * @module purecloud-platform-client-v2/api/RecordingApi
-	 * @version 126.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -601,6 +601,8 @@ class RecordingApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
 	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
+	 * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
 	 */
 	getRecordingJobFailedrecordings(jobId, opts) { 
 		opts = opts || {};
@@ -614,7 +616,7 @@ class RecordingApi {
 			'/api/v2/recording/jobs/{jobId}/failedrecordings', 
 			'GET', 
 			{ 'jobId': jobId }, 
-			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] }, 
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] }, 
 			{  }, 
 			{  }, 
 			null, 
@@ -634,6 +636,8 @@ class RecordingApi {
 	 * @param {Object} opts.state Filter by state
 	 * @param {Boolean} opts.showOnlyMyJobs Show only my jobs
 	 * @param {Object} opts.jobType Job Type (Can be left empty for both)
+	 * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
+	 * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
 	 */
 	getRecordingJobs(opts) { 
 		opts = opts || {};
@@ -643,7 +647,7 @@ class RecordingApi {
 			'/api/v2/recording/jobs', 
 			'GET', 
 			{  }, 
-			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'] }, 
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] }, 
 			{  }, 
 			{  }, 
 			null, 

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

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

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

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

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

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

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

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