purecloud-platform-client-v2 231.0.0 → 233.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "231.0.0",
+  "version": "233.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 231.0.0
+ * @version 233.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/api/AIStudioApi.js

@@ -5,7 +5,7 @@ class AIStudioApi {
 	/**
 	 * AIStudio service.
 	 * @module purecloud-platform-client-v2/api/AIStudioApi
-	 * @version 231.0.0
+	 * @version 233.0.0
 	 */
 
 	/**

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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.0.0
 	 */
 
 	/**
@@ -789,7 +789,7 @@ class BusinessRulesApi {
 	/**
 	 * Create a schema
 	 * 
-	 * @param {Object} body Schema
+	 * @param {Object} body Business Rules Schema Create Request
 	 * postBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postBusinessrulesSchemas(body) { 
@@ -888,7 +888,7 @@ class BusinessRulesApi {
 	 * Update a schema
 	 * 
 	 * @param {String} schemaId Schema ID
-	 * @param {Object} body Data Schema
+	 * @param {Object} body Business Rules Schema Update Request
 	 * putBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	putBusinessrulesSchema(schemaId, body) { 

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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.0.0
 	 */
 
 	/**
@@ -246,6 +246,31 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Delete an Apple messaging integration
+	 * 
+	 * @param {String} integrationId Integration ID
+	 */
+	deleteConversationsMessagingIntegrationsAppleIntegrationId(integrationId) { 
+		// verify the required parameter 'integrationId' is set
+		if (integrationId === undefined || integrationId === null || integrationId === '') {
+			throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsAppleIntegrationId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/apple/{integrationId}', 
+			'DELETE', 
+			{ 'integrationId': integrationId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Delete a Facebook messaging integration
 	 * 
@@ -2381,7 +2406,6 @@ class ConversationsApi {
 	 * Get Apple messaging integration identity resolution settings
 	 * 
 	 * @param {String} integrationId Integration ID
-	 * getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId) { 
 		// verify the required parameter 'integrationId' is set
@@ -2581,6 +2605,63 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Get a list of Apple Integrations
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageSize Page size (default to 25)
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 * @param {Object} opts.expand Expand instructions for the return value.
+	 * @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
+	 * @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
+	 */
+	getConversationsMessagingIntegrationsApple(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/apple', 
+			'GET', 
+			{  },
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get an Apple messaging integration
+	 * 
+	 * @param {String} integrationId Integration ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.expand Expand instructions for the return value.
+	 */
+	getConversationsMessagingIntegrationsAppleIntegrationId(integrationId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'integrationId' is set
+		if (integrationId === undefined || integrationId === null || integrationId === '') {
+			throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsAppleIntegrationId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/apple/{integrationId}', 
+			'GET', 
+			{ 'integrationId': integrationId },
+			{ 'expand': opts['expand'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a list of Facebook Integrations
 	 * 
@@ -2886,6 +2967,40 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Call Authentication provider callback to validate state and code
+	 * 
+	 * @param {String} code The authorization code to be sent to the authentication server during the token request.
+	 * @param {String} state The state/nonce value generated by Genesys Auth-Client Service.
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.error Error parameter from OAuth provider
+	 */
+	getConversationsMessagingOauthAppleCallback(code, state, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'code' is set
+		if (code === undefined || code === null) {
+			throw 'Missing the required parameter "code" when calling getConversationsMessagingOauthAppleCallback';
+		}
+		// verify the required parameter 'state' is set
+		if (state === undefined || state === null) {
+			throw 'Missing the required parameter "state" when calling getConversationsMessagingOauthAppleCallback';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/oauth/apple/callback', 
+			'GET', 
+			{  },
+			{ 'code': code,'state': state,'error': opts['error'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a messaging setting
 	 * 
@@ -4504,6 +4619,36 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Update an Apple messaging integration
+	 * 
+	 * @param {String} integrationId Integration ID
+	 * @param {Object} body AppleIntegrationUpdateRequest
+	 */
+	patchConversationsMessagingIntegrationsAppleIntegrationId(integrationId, body) { 
+		// verify the required parameter 'integrationId' is set
+		if (integrationId === undefined || integrationId === null || integrationId === '') {
+			throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/apple/{integrationId}', 
+			'PATCH', 
+			{ 'integrationId': integrationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update Facebook messaging integration
 	 * 
@@ -5958,7 +6103,7 @@ class ConversationsApi {
 	}
 
 	/**
-	 * Add participants to a conversation without a user context
+	 * Add participants to a conversation on behalf of a user
 	 * 
 	 * @param {String} conversationId conversationId
 	 * @param {String} userId userId
@@ -7267,6 +7412,31 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Create Apple Integration
+	 * 
+	 * @param {Object} body AppleIntegrationRequest
+	 */
+	postConversationsMessagingIntegrationsApple(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsApple';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/apple', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Create a Facebook Integration
 	 * 
@@ -8045,7 +8215,6 @@ class ConversationsApi {
 	 * 
 	 * @param {String} integrationId Integration ID
 	 * @param {Object} body IdentityResolutionConfig
-	 * putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId, body) { 
 		// verify the required parameter 'integrationId' is set

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 231.0.0
+	 * @version 233.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class DataPrivacyApi {
 	/**
 	 * DataPrivacy service.
 	 * @module purecloud-platform-client-v2/api/DataPrivacyApi
-	 * @version 231.0.0
+	 * @version 233.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class DownloadsApi {
 	/**
 	 * Downloads service.
 	 * @module purecloud-platform-client-v2/api/DownloadsApi
-	 * @version 231.0.0
+	 * @version 233.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class EmailsApi {
 	/**
 	 * Emails service.
 	 * @module purecloud-platform-client-v2/api/EmailsApi
-	 * @version 231.0.0
+	 * @version 233.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class EmployeeEngagementApi {
 	/**
 	 * EmployeeEngagement service.
 	 * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
-	 * @version 231.0.0
+	 * @version 233.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class EventsApi {
 	/**
 	 * Events service.
 	 * @module purecloud-platform-client-v2/api/EventsApi
-	 * @version 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.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 231.0.0
+	 * @version 233.0.0
 	 */
 
 	/**