purecloud-platform-client-v2 128.0.0 → 129.0.0

package/dist/node/purecloud-platform-client-v2.js

@@ -393,7 +393,7 @@ class Configuration {
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 128.0.0
+ * @version 129.0.0
  */
 class ApiClient {
 	/**
@@ -1340,7 +1340,7 @@ class ApiClient {
 
 				// set header parameters
 				request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
-				//request.set({ 'purecloud-sdk': '128.0.0' });
+				//request.set({ 'purecloud-sdk': '129.0.0' });
 
 				// set request timeout
 				request.timeout(that.timeout);
@@ -1440,7 +1440,7 @@ class AlertingApi {
 	/**
 	 * Alerting service.
 	 * @module purecloud-platform-client-v2/api/AlertingApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -1754,7 +1754,7 @@ class AnalyticsApi {
 	/**
 	 * Analytics service.
 	 * @module purecloud-platform-client-v2/api/AnalyticsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -2891,7 +2891,7 @@ class ArchitectApi {
 	/**
 	 * Architect service.
 	 * @module purecloud-platform-client-v2/api/ArchitectApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -5887,7 +5887,7 @@ class AuditApi {
 	/**
 	 * Audit service.
 	 * @module purecloud-platform-client-v2/api/AuditApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -6058,7 +6058,7 @@ class AuthorizationApi {
 	/**
 	 * Authorization service.
 	 * @module purecloud-platform-client-v2/api/AuthorizationApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -7241,7 +7241,7 @@ class BillingApi {
 	/**
 	 * Billing service.
 	 * @module purecloud-platform-client-v2/api/BillingApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -7321,7 +7321,7 @@ class ChatApi {
 	/**
 	 * Chat service.
 	 * @module purecloud-platform-client-v2/api/ChatApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -7412,7 +7412,7 @@ class CoachingApi {
 	/**
 	 * Coaching service.
 	 * @module purecloud-platform-client-v2/api/CoachingApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -7987,7 +7987,7 @@ class ContentManagementApi {
 	/**
 	 * ContentManagement service.
 	 * @module purecloud-platform-client-v2/api/ContentManagementApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -9127,7 +9127,7 @@ class ConversationsApi {
 	/**
 	 * Conversations service.
 	 * @module purecloud-platform-client-v2/api/ConversationsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -13516,7 +13516,7 @@ class DataExtensionsApi {
 	/**
 	 * DataExtensions service.
 	 * @module purecloud-platform-client-v2/api/DataExtensionsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -13602,7 +13602,7 @@ class ExternalContactsApi {
 	/**
 	 * ExternalContacts service.
 	 * @module purecloud-platform-client-v2/api/ExternalContactsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -15345,7 +15345,7 @@ class FaxApi {
 	/**
 	 * Fax service.
 	 * @module purecloud-platform-client-v2/api/FaxApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -15516,7 +15516,7 @@ class FlowsApi {
 	/**
 	 * Flows service.
 	 * @module purecloud-platform-client-v2/api/FlowsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -15587,7 +15587,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -15855,6 +15855,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
 	 * 
@@ -16709,6 +16734,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
 	 * 
@@ -16893,7 +17013,7 @@ class GeneralDataProtectionRegulationApi {
 	/**
 	 * GeneralDataProtectionRegulation service.
 	 * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -17023,7 +17143,7 @@ class GeolocationApi {
 	/**
 	 * Geolocation service.
 	 * @module purecloud-platform-client-v2/api/GeolocationApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -17154,7 +17274,7 @@ class GreetingsApi {
 	/**
 	 * Greetings service.
 	 * @module purecloud-platform-client-v2/api/GreetingsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -17609,7 +17729,7 @@ class GroupsApi {
 	/**
 	 * Groups service.
 	 * @module purecloud-platform-client-v2/api/GroupsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -18014,7 +18134,7 @@ class IdentityProviderApi {
 	/**
 	 * IdentityProvider service.
 	 * @module purecloud-platform-client-v2/api/IdentityProviderApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -18770,7 +18890,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -19427,6 +19547,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
 	 * 
@@ -20416,7 +20565,7 @@ class JourneyApi {
 	/**
 	 * Journey service.
 	 * @module purecloud-platform-client-v2/api/JourneyApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -21127,7 +21276,7 @@ class KnowledgeApi {
 	/**
 	 * Knowledge service.
 	 * @module purecloud-platform-client-v2/api/KnowledgeApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -22027,7 +22176,7 @@ class LanguageUnderstandingApi {
 	/**
 	 * LanguageUnderstanding service.
 	 * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -22931,7 +23080,7 @@ class LanguagesApi {
 	/**
 	 * Languages service.
 	 * @module purecloud-platform-client-v2/api/LanguagesApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -23199,7 +23348,7 @@ class LearningApi {
 	/**
 	 * Learning service.
 	 * @module purecloud-platform-client-v2/api/LearningApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -23790,7 +23939,7 @@ class LicenseApi {
 	/**
 	 * License service.
 	 * @module purecloud-platform-client-v2/api/LicenseApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -24028,7 +24177,7 @@ class LocationsApi {
 	/**
 	 * Locations service.
 	 * @module purecloud-platform-client-v2/api/LocationsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -24264,7 +24413,7 @@ class MobileDevicesApi {
 	/**
 	 * MobileDevices service.
 	 * @module purecloud-platform-client-v2/api/MobileDevicesApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -24415,7 +24564,7 @@ class NotificationsApi {
 	/**
 	 * Notifications service.
 	 * @module purecloud-platform-client-v2/api/NotificationsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -24640,7 +24789,7 @@ class OAuthApi {
 	/**
 	 * OAuth service.
 	 * @module purecloud-platform-client-v2/api/OAuthApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -24998,7 +25147,7 @@ class ObjectsApi {
 	/**
 	 * Objects service.
 	 * @module purecloud-platform-client-v2/api/ObjectsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -25269,7 +25418,7 @@ class OrganizationApi {
 	/**
 	 * Organization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -25672,7 +25821,7 @@ class OrganizationAuthorizationApi {
 	/**
 	 * OrganizationAuthorization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -26597,7 +26746,7 @@ class OutboundApi {
 	/**
 	 * Outbound service.
 	 * @module purecloud-platform-client-v2/api/OutboundApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -29623,7 +29772,7 @@ class PresenceApi {
 	/**
 	 * Presence service.
 	 * @module purecloud-platform-client-v2/api/PresenceApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -29995,7 +30144,7 @@ class QualityApi {
 	/**
 	 * Quality service.
 	 * @module purecloud-platform-client-v2/api/QualityApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -31523,7 +31672,7 @@ class RecordingApi {
 	/**
 	 * Recording service.
 	 * @module purecloud-platform-client-v2/api/RecordingApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -33046,7 +33195,7 @@ class ResponseManagementApi {
 	/**
 	 * ResponseManagement service.
 	 * @module purecloud-platform-client-v2/api/ResponseManagementApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -33371,7 +33520,7 @@ class RoutingApi {
 	/**
 	 * Routing service.
 	 * @module purecloud-platform-client-v2/api/RoutingApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -36290,7 +36439,7 @@ class SCIMApi {
 	/**
 	 * SCIM service.
 	 * @module purecloud-platform-client-v2/api/SCIMApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -37167,7 +37316,7 @@ class ScriptsApi {
 	/**
 	 * Scripts service.
 	 * @module purecloud-platform-client-v2/api/ScriptsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -37520,7 +37669,7 @@ class SearchApi {
 	/**
 	 * Search service.
 	 * @module purecloud-platform-client-v2/api/SearchApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -38055,7 +38204,7 @@ class SpeechTextAnalyticsApi {
 	/**
 	 * SpeechTextAnalytics service.
 	 * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -38928,7 +39077,7 @@ class StationsApi {
 	/**
 	 * Stations service.
 	 * @module purecloud-platform-client-v2/api/StationsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -39075,7 +39224,7 @@ class SuggestApi {
 	/**
 	 * Suggest service.
 	 * @module purecloud-platform-client-v2/api/SuggestApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -39214,7 +39363,7 @@ class TelephonyApi {
 	/**
 	 * Telephony service.
 	 * @module purecloud-platform-client-v2/api/TelephonyApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -39322,7 +39471,7 @@ class TelephonyProvidersEdgeApi {
 	/**
 	 * TelephonyProvidersEdge service.
 	 * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -40660,6 +40809,26 @@ class TelephonyProvidersEdgeApi {
 		);
 	}
 
+	/**
+	 * List of edges more than 4 edge versions behind the latest software.
+	 * 
+	 */
+	getTelephonyProvidersEdgesExpired() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/telephony/providers/edges/expired', 
+			'GET', 
+			{  }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get an extension by ID.
 	 * 
@@ -42935,7 +43104,7 @@ class TextbotsApi {
 	/**
 	 * Textbots service.
 	 * @module purecloud-platform-client-v2/api/TextbotsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -43063,7 +43232,7 @@ class TokensApi {
 	/**
 	 * Tokens service.
 	 * @module purecloud-platform-client-v2/api/TokensApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -43169,7 +43338,7 @@ class UploadsApi {
 	/**
 	 * Uploads service.
 	 * @module purecloud-platform-client-v2/api/UploadsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -43345,7 +43514,7 @@ class UsageApi {
 	/**
 	 * Usage service.
 	 * @module purecloud-platform-client-v2/api/UsageApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -43416,7 +43585,7 @@ class UserRecordingsApi {
 	/**
 	 * UserRecordings service.
 	 * @module purecloud-platform-client-v2/api/UserRecordingsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -43600,7 +43769,7 @@ class UsersApi {
 	/**
 	 * Users service.
 	 * @module purecloud-platform-client-v2/api/UsersApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -45902,7 +46071,7 @@ class UtilitiesApi {
 	/**
 	 * Utilities service.
 	 * @module purecloud-platform-client-v2/api/UtilitiesApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -46013,7 +46182,7 @@ class VoicemailApi {
 	/**
 	 * Voicemail service.
 	 * @module purecloud-platform-client-v2/api/VoicemailApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -46680,7 +46849,7 @@ class WebChatApi {
 	/**
 	 * WebChat service.
 	 * @module purecloud-platform-client-v2/api/WebChatApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -47224,7 +47393,7 @@ class WebDeploymentsApi {
 	/**
 	 * WebDeployments service.
 	 * @module purecloud-platform-client-v2/api/WebDeploymentsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -47579,7 +47748,7 @@ class WebMessagingApi {
 	/**
 	 * WebMessaging service.
 	 * @module purecloud-platform-client-v2/api/WebMessagingApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -47625,7 +47794,7 @@ class WidgetsApi {
 	/**
 	 * Widgets service.
 	 * @module purecloud-platform-client-v2/api/WidgetsApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -47771,7 +47940,7 @@ class WorkforceManagementApi {
 	/**
 	 * WorkforceManagement service.
 	 * @module purecloud-platform-client-v2/api/WorkforceManagementApi
-	 * @version 128.0.0
+	 * @version 129.0.0
 	 */
 
 	/**
@@ -51802,7 +51971,7 @@ class WorkforceManagementApi {
  * </pre>
  * </p>
  * @module purecloud-platform-client-v2/index
- * @version 128.0.0
+ * @version 129.0.0
  */
 class platformClient {
 	constructor() {