purecloud-platform-client-v2 130.0.0 → 132.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "130.0.0",
+  "version": "132.0.0",
   "description": "A JavaScript library to interface with the PureCloud Platform API",
   "license": "MIT",
   "main": "dist/node/purecloud-platform-client-v2.js",
@@ -31,18 +31,18 @@
   },
   "dependencies": {
     "configparser": "^0.3.9",
-    "superagent": "^3.8.3",
-    "winston": "^3.3.3"
+    "superagent": "^7.1.1",
+    "winston": "^3.6.0"
   },
   "devDependencies": {
-    "mocha": "~2.3.4",
-    "sinon": "1.17.3",
+    "mocha": "~9.2.0",
+    "sinon": "13.0.1",
     "expect.js": "~0.3.1",
-    "rollup-plugin-commonjs": "^9.1.3",
-    "rollup-plugin-node-resolve": "^3.3.0",
-    "rollup-plugin-json": "^4.0.0",
+    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "@rollup/plugin-json": "^4.1.0",
     "rollup-plugin-re": "^1.0.7",
     "rollup-plugin-node-builtins": "^2.1.2",
-    "rollup-plugin-node-globals": "^1.2.1"
+    "rollup-plugin-node-globals": "^1.4.0"
   }
 }

package/src/purecloud-platform-client-v2/ApiClient.js

@@ -3,7 +3,7 @@ import Configuration from './configuration.js';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 130.0.0
+ * @version 132.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': '130.0.0' });
+				//request.set({ 'purecloud-sdk': '132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.0.0
 	 */
 
 	/**
@@ -506,6 +506,26 @@ class AnalyticsApi {
 		);
 	}
 
+	/**
+	 * Get AnalyticsReportingSettings for an organization
+	 * 
+	 */
+	getAnalyticsReportingSettings() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/settings', 
+			'GET', 
+			{  }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a list of report time periods.
 	 * 
@@ -601,6 +621,31 @@ class AnalyticsApi {
 		);
 	}
 
+	/**
+	 * Patch AnalyticsReportingSettings values for an organization
+	 * 
+	 * @param {Object} body AnalyticsReportingSettingsRequest
+	 */
+	patchAnalyticsReportingSettings(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/settings', 
+			'PATCH', 
+			{  }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Query for bot aggregates
 	 * 

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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.0.0
 	 */
 
 	/**
@@ -295,6 +295,31 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Delete a supported content profile
+	 * 
+	 * @param {String} supportedContentId Supported Content ID
+	 */
+	deleteConversationsMessagingSupportedcontentSupportedContentId(supportedContentId) { 
+		// verify the required parameter 'supportedContentId' is set
+		if (supportedContentId === undefined || supportedContentId === null) {
+			throw 'Missing the required parameter "supportedContentId" when calling deleteConversationsMessagingSupportedcontentSupportedContentId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/supportedcontent/{supportedContentId}', 
+			'DELETE', 
+			{ 'supportedContentId': supportedContentId }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a conversation by id
 	 * 
@@ -1887,6 +1912,76 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Get a list of Supported Content profiles
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageSize Page size (default to 25)
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 */
+	getConversationsMessagingSupportedcontent(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/supportedcontent', 
+			'GET', 
+			{  }, 
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] }, 
+			{  }, 
+			{  }, 
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get the organization's default supported content profile that will be used as the default when creating an integration.
+	 * When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
+	 */
+	getConversationsMessagingSupportedcontentDefault() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/supportedcontent/default', 
+			'GET', 
+			{  }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a supported content profile
+	 * 
+	 * @param {String} supportedContentId Supported Content ID
+	 */
+	getConversationsMessagingSupportedcontentSupportedContentId(supportedContentId) { 
+		// verify the required parameter 'supportedContentId' is set
+		if (supportedContentId === undefined || supportedContentId === null) {
+			throw 'Missing the required parameter "supportedContentId" when calling getConversationsMessagingSupportedcontentSupportedContentId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/supportedcontent/{supportedContentId}', 
+			'GET', 
+			{ 'supportedContentId': supportedContentId }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get conversation threading window timeline for each messaging type
 	 * Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.
@@ -2968,6 +3063,36 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Update a supported content profile
+	 * 
+	 * @param {String} supportedContentId Supported Content ID
+	 * @param {Object} body SupportedContent
+	 */
+	patchConversationsMessagingSupportedcontentSupportedContentId(supportedContentId, body) { 
+		// verify the required parameter 'supportedContentId' is set
+		if (supportedContentId === undefined || supportedContentId === null) {
+			throw 'Missing the required parameter "supportedContentId" when calling patchConversationsMessagingSupportedcontentSupportedContentId';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchConversationsMessagingSupportedcontentSupportedContentId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/supportedcontent/{supportedContentId}', 
+			'PATCH', 
+			{ 'supportedContentId': supportedContentId }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Index conversation properties
 	 * 
@@ -4030,7 +4155,7 @@ class ConversationsApi {
 
 	/**
 	 * Send an agentless outbound message
-	 * Send an agentlesss (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.
+	 * Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.
 	 * @param {Object} body Create agentless outbound messaging request
 	 */
 	postConversationsMessagesAgentless(body) { 
@@ -4203,6 +4328,31 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Create a Supported Content profile
+	 * 
+	 * @param {Object} body SupportedContent
+	 */
+	postConversationsMessagingSupportedcontent(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationsMessagingSupportedcontent';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/supportedcontent', 
+			'POST', 
+			{  }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Set flagged reason on conversation participant to indicate bad conversation quality.
 	 * 
@@ -4363,6 +4513,31 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Set the organization's default supported content profile that may be assigned to an integration when it is created.
+	 * When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
+	 * @param {Object} body SupportedContent
+	 */
+	putConversationsMessagingSupportedcontentDefault(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsMessagingSupportedcontentDefault';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/supportedcontent/default', 
+			'PUT', 
+			{  }, 
+			{  }, 
+			{  }, 
+			{  }, 
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'], 
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update conversation threading window timeline for each messaging type
 	 * PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.

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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.0.0
 	 */
 
 	/**
@@ -1281,8 +1281,12 @@ class GamificationApi {
 	 * Create a new custom performance profile
 	 * 
 	 * @param {Object} body performanceProfile
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.copyMetrics Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile. (default to true)
 	 */
-	postGamificationProfiles(body) { 
+	postGamificationProfiles(body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'body' is set
 		if (body === undefined || body === null) {
 			throw 'Missing the required parameter "body" when calling postGamificationProfiles';
@@ -1292,7 +1296,7 @@ class GamificationApi {
 			'/api/v2/gamification/profiles', 
 			'POST', 
 			{  }, 
-			{  }, 
+			{ 'copyMetrics': opts['copyMetrics'] }, 
 			{  }, 
 			{  }, 
 			body, 

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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.0.0
 	 */
 
 	/**

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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.0.0
 	 */
 
 	/**
@@ -463,7 +463,7 @@ class LanguageUnderstandingApi {
 	 * @param {String} minerId Miner ID
 	 * @param {String} intentId The ID of the intent to be retrieved.
 	 * @param {Object} opts Optional parameters
-	 * @param {String} opts.expand Option to fetch utterances
+	 * @param {Object} opts.expand Option to fetch utterances
 	 */
 	getLanguageunderstandingMinerIntent(minerId, intentId, opts) { 
 		opts = opts || {};
@@ -496,7 +496,7 @@ class LanguageUnderstandingApi {
 	 * 
 	 * @param {String} minerId Miner ID
 	 * @param {Object} opts Optional parameters
-	 * @param {String} opts.expand Option to fetch utterances.
+	 * @param {Object} opts.expand Option to fetch utterances.
 	 */
 	getLanguageunderstandingMinerIntents(minerId, opts) { 
 		opts = opts || {};

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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.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 130.0.0
+	 * @version 132.0.0
 	 */
 
 	/**