purecloud-platform-client-v2 230.0.0 → 232.0.0

package/package.json

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

@@ -6,7 +6,7 @@ import { default as qs } from 'qs';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 230.0.0
+ * @version 232.0.0
  */
 class ApiClient {
 	/**
@@ -72,6 +72,8 @@ class ApiClient {
 			MULTI: 'multi'
 		};
 
+		this.useLegacyParameterFilter = true;
+
 		/**
 		 * @description Value is `true` if local storage exists. Otherwise, false.
 		 */
@@ -1190,12 +1192,35 @@ class ApiClient {
 		return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${loginBasePath}/${path}?`);
 	}
 
+	/**
+	 * @description If set to `true`, the ApiClient will continue to use its legacy approach for filtering method parameters (mapped to an API Endpoint's query parameter). This is option is meant to facilitate transition from legacy to current and accurate parameters filtering.
+	 * @param {boolean} useLegacyParameterFilter - `false` to use modern/accurate approach (default value), `true` to use legacy approach (i.e. parameters of boolean type and equal to false are ignored/filtered, parameters of type integer/number and equal to 0 are ignored/filtered)
+	 */
+	setUseLegacyParameterFilter(useLegacyParameterFilter) {
+		this.useLegacyParameterFilter = useLegacyParameterFilter;
+	}
+
+	getUseLegacyParameterFilter() {
+		return this.useLegacyParameterFilter;
+	}
+
 	/**
 	 * Returns a string representation for an actual parameter.
 	 * @param param The actual parameter.
 	 * @returns {String} The string representation of <code>param</code>.
 	 */
 	paramToString(param) {
+		if (this.useLegacyParameterFilter !== true) {
+			if (param !== null && param !== undefined) {
+				if (typeof param === "boolean") {
+					return param.toString().toLowerCase();
+				} else if (param instanceof Boolean) {
+					return param.toString().toLowerCase();
+				} else if (typeof param === "number") {
+					return param.toString();
+				}
+			}
+		}
 		if (!param) {
 			return '';
 		}
@@ -1359,16 +1384,16 @@ class ApiClient {
 
 		switch (collectionFormat) {
 			case 'csv':
-				return param.map(this.paramToString).join(',');
+				return param.map((x) => this.paramToString(x)).join(',');
 			case 'ssv':
-				return param.map(this.paramToString).join(' ');
+				return param.map((x) => this.paramToString(x)).join(' ');
 			case 'tsv':
-				return param.map(this.paramToString).join('\t');
+				return param.map((x) => this.paramToString(x)).join('\t');
 			case 'pipes':
-				return param.map(this.paramToString).join('|');
+				return param.map((x) => this.paramToString(x)).join('|');
 			case 'multi':
 				// return the array directly as axios will handle it as expected
-				return param.map(this.paramToString);
+				return param.map((x) => this.paramToString(x));
 			default:
 				throw new Error(`Unknown collection format: ${collectionFormat}`);
 		}

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

@@ -14,4 +14,6 @@ export default {
 	me_central_1: 'mec1.pure.cloud',
 	ap_northeast_3: 'apne3.pure.cloud',
 	eu_central_2: 'euc2.pure.cloud',
+	mx_central_1: 'mxc1.pure.cloud',
+	ap_southeast_1: 'apse1.pure.cloud',
 };

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

@@ -5,7 +5,7 @@ class AIStudioApi {
 	/**
 	 * AIStudio service.
 	 * @module purecloud-platform-client-v2/api/AIStudioApi
-	 * @version 230.0.0
+	 * @version 232.0.0
 	 */
 
 	/**
@@ -20,6 +20,31 @@ class AIStudioApi {
 	}
 
 
+	/**
+	 * Delete a summary setting.
+	 * 
+	 * @param {String} summarySettingId Summary setting id
+	 */
+	deleteConversationsSummariesSetting(summarySettingId) { 
+		// verify the required parameter 'summarySettingId' is set
+		if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
+			throw 'Missing the required parameter "summarySettingId" when calling deleteConversationsSummariesSetting';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/summaries/settings/{summarySettingId}', 
+			'DELETE', 
+			{ 'summarySettingId': summarySettingId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Start the deletion of a guide.
 	 * 
@@ -46,6 +71,60 @@ class AIStudioApi {
 		);
 	}
 
+	/**
+	 * Receive a summary setting.
+	 * 
+	 * @param {String} summarySettingId Summary setting id
+	 */
+	getConversationsSummariesSetting(summarySettingId) { 
+		// verify the required parameter 'summarySettingId' is set
+		if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
+			throw 'Missing the required parameter "summarySettingId" when calling getConversationsSummariesSetting';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/summaries/settings/{summarySettingId}', 
+			'GET', 
+			{ 'summarySettingId': summarySettingId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get all summary settings.
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.language Filter by matching language - case insensitive.
+	 * @param {String} opts.name Filter by partially matching name - case insensitive.
+	 * @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
+	 * @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
+	 * @param {Number} opts.pageNumber Page number. (default to 1)
+	 * @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
+	 */
+	getConversationsSummariesSettings(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/summaries/settings', 
+			'GET', 
+			{  },
+			{ 'language': opts['language'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get guide.
 	 * 
@@ -294,6 +373,56 @@ class AIStudioApi {
 		);
 	}
 
+	/**
+	 * Trigger summary preview event generation.
+	 * 
+	 * @param {Object} body 
+	 */
+	postConversationsSummariesPreview(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationsSummariesPreview';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/summaries/preview', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Create a summary setting.
+	 * 
+	 * @param {Object} body 
+	 */
+	postConversationsSummariesSettings(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationsSummariesSettings';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/summaries/settings', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Start the publishing of a guide version.
 	 * 
@@ -412,6 +541,36 @@ class AIStudioApi {
 		);
 	}
 
+	/**
+	 * Update a summary setting.
+	 * 
+	 * @param {String} summarySettingId Summary setting id
+	 * @param {Object} body 
+	 */
+	putConversationsSummariesSetting(summarySettingId, body) { 
+		// verify the required parameter 'summarySettingId' is set
+		if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
+			throw 'Missing the required parameter "summarySettingId" when calling putConversationsSummariesSetting';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putConversationsSummariesSetting';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/summaries/settings/{summarySettingId}', 
+			'PUT', 
+			{ 'summarySettingId': summarySettingId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 }
 
 

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

@@ -5,7 +5,7 @@ class AgentAssistantsApi {
 	/**
 	 * AgentAssistants service.
 	 * @module purecloud-platform-client-v2/api/AgentAssistantsApi
-	 * @version 230.0.0
+	 * @version 232.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class AgentCopilotApi {
 	/**
 	 * AgentCopilot service.
 	 * @module purecloud-platform-client-v2/api/AgentCopilotApi
-	 * @version 230.0.0
+	 * @version 232.0.0
 	 */
 
 	/**
@@ -45,6 +45,30 @@ class AgentCopilotApi {
 		);
 	}
 
+	/**
+	 * Get information about the support of features for all the languages or only for a certain language.
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.language Which language are the features supported for
+	 */
+	getAssistantsCopilotFeaturesupport(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/copilot/featuresupport', 
+			'GET', 
+			{  },
+			{ 'language': opts['language'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update agent copilot configuration
 	 * 

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

@@ -5,7 +5,7 @@ class AgentUIApi {
 	/**
 	 * AgentUI service.
 	 * @module purecloud-platform-client-v2/api/AgentUIApi
-	 * @version 230.0.0
+	 * @version 232.0.0
 	 */
 
 	/**

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 230.0.0
+	 * @version 232.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 230.0.0
+	 * @version 232.0.0
 	 */
 
 	/**
@@ -937,6 +937,62 @@ class AnalyticsApi {
 		);
 	}
 
+	/**
+	 * Get analytics data warehouse file download
+	 * 
+	 * @param {String} downloadId Unique file Id to download
+	 * getAnalyticsDataextractionDownload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAnalyticsDataextractionDownload(downloadId) { 
+		// verify the required parameter 'downloadId' is set
+		if (downloadId === undefined || downloadId === null || downloadId === '') {
+			throw 'Missing the required parameter "downloadId" when calling getAnalyticsDataextractionDownload';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/dataextraction/downloads/{downloadId}', 
+			'GET', 
+			{ 'downloadId': downloadId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get metadata on files available for extraction
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
+	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
+	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
+	 * @param {String} opts.dataSchema Data schema like conversations
+	 * @param {Date} opts.dateStart Start DateTime filter. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
+	 * @param {Date} opts.dateEnd End DateTime filter. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
+	 * getAnalyticsDataextractionDownloadsMetadata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAnalyticsDataextractionDownloadsMetadata(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/dataextraction/downloads/metadata', 
+			'GET', 
+			{  },
+			{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dataSchema': opts['dataSchema'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get analytics data retention setting
 	 * 
@@ -2229,6 +2285,32 @@ class AnalyticsApi {
 		);
 	}
 
+	/**
+	 * Get download URLs for analytics data warehouse files
+	 * 
+	 * @param {Object} body request
+	 * postAnalyticsDataextractionDownloadsBulk is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postAnalyticsDataextractionDownloadsBulk(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAnalyticsDataextractionDownloadsBulk';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/analytics/dataextraction/downloads/bulk', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Query for evaluation aggregates asynchronously
 	 * 

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

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

@@ -5,7 +5,7 @@ class BusinessRulesApi {
 	/**
 	 * BusinessRules service.
 	 * @module purecloud-platform-client-v2/api/BusinessRulesApi
-	 * @version 230.0.0
+	 * @version 232.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class CarrierServicesApi {
 	/**
 	 * CarrierServices service.
 	 * @module purecloud-platform-client-v2/api/CarrierServicesApi
-	 * @version 230.0.0
+	 * @version 232.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 230.0.0
+	 * @version 232.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 230.0.0
+	 * @version 232.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 230.0.0
+	 * @version 232.0.0
 	 */
 
 	/**