purecloud-platform-client-v2 205.0.0 → 207.0.0

package/package.json

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

@@ -4,7 +4,7 @@ import { default as qs } from 'qs';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 205.0.0
+ * @version 207.0.0
  */
 class ApiClient {
 	/**
@@ -202,6 +202,21 @@ class ApiClient {
 		this.config.setEnvironment(environment);
 	}
 
+	/**
+	 * @description Sets the gateway used by the session
+	 * @param {object} gateway - Gateway Configuration interface
+	 * @param {string} gateway.host - The address of the gateway.
+	 * @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
+	 * @param {string} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater than 0).
+	 * @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
+	 * @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
+	 * @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
+	 * @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
+	 */
+	setGateway(gateway) {
+		this.config.setGateway(gateway);
+	}
+
 	/**
 	 * @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
 	 * @param {string} clientId - The client ID of an OAuth Implicit Grant client
@@ -266,6 +281,7 @@ class ApiClient {
 	loginClientCredentialsGrant(clientId, clientSecret) {
 		this.clientId = clientId;
 		var authHeader = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');
+		var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
 
 		return new Promise((resolve, reject) => {
 			// Block browsers from using client credentials
@@ -278,7 +294,7 @@ class ApiClient {
 			}
 			axios({
 				method: `POST`,
-				url: `https://login.${this.config.environment}/oauth/token`,
+				url: `${loginBasePath}/oauth/token`,
 				headers: headers,
 				data: 'grant_type=client_credentials',
 				httpsAgent: this.proxyAgent
@@ -289,7 +305,7 @@ class ApiClient {
 						'trace',
 						response.status,
 						'POST',
-						`https://login.${this.config.environment}/oauth/token`,
+						`${loginBasePath}/oauth/token`,
 						headers,
 						response.headers,
 						{ grant_type: 'client_credentials' },
@@ -299,7 +315,7 @@ class ApiClient {
 						'debug',
 						response.status,
 						'POST',
-						`https://login.${this.config.environment}/oauth/token`,
+						`${loginBasePath}/oauth/token`,
 						headers,
 						undefined,
 						{ grant_type: 'client_credentials' },
@@ -323,7 +339,7 @@ class ApiClient {
 							'error',
 							error.response.status,
 							'POST',
-							`https://login.${this.config.environment}/oauth/token`,
+							`${loginBasePath}/oauth/token`,
 							headers,
 							error.response.headers,
 							{ grant_type: 'client_credentials' },
@@ -344,6 +360,7 @@ class ApiClient {
 	 */
     loginSaml2BearerGrant(clientId, clientSecret, orgName, assertion) {
 		this.clientId = clientId;
+		var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
 		return new Promise((resolve, reject) => {
 			if (typeof window !== 'undefined') {
 				reject(new Error('The saml2bearer grant is not supported in a browser.'));
@@ -369,7 +386,7 @@ class ApiClient {
 						'trace',
 						response.status,
 						'POST',
-						`https://login.${this.config.environment}/oauth/token`,
+						`${loginBasePath}/oauth/token`,
 						request.headers,
 						response.headers,
 						bodyParam,
@@ -379,7 +396,7 @@ class ApiClient {
 						'debug',
 						response.status,
 						'POST',
-						`https://login.${this.config.environment}/oauth/token`,
+						`${loginBasePath}/oauth/token`,
 						request.headers,
 						undefined,
 						bodyParam,
@@ -403,7 +420,7 @@ class ApiClient {
 							'error',
 							error.response.status,
 							'POST',
-							`https://login.${this.config.environment}/oauth/token`,
+							`${loginBasePath}/oauth/token`,
 							request.headers,
 							error.response.headers,
 							bodyParam,
@@ -424,10 +441,11 @@ class ApiClient {
 	 */
     authorizePKCEGrant(clientId, codeVerifier, authCode, redirectUri) {
 		this.clientId = clientId;
+		var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
 		return new Promise((resolve, reject) => {
 			var request = axios({
 				method: `POST`,
-				url: `https://login.${this.config.environment}/oauth/token`,
+				url: `${loginBasePath}/oauth/token`,
 				headers: {
 					'Content-Type': 'application/x-www-form-urlencoded'
 				},
@@ -454,7 +472,7 @@ class ApiClient {
 					'trace',
 					response.status,
 					'POST',
-					`https://login.${this.config.environment}/oauth/token`,
+					`${loginBasePath}/oauth/token`,
 					request.headers,
 					response.headers,
 					bodyParam,
@@ -464,7 +482,7 @@ class ApiClient {
 					'debug',
 					response.status,
 					'POST',
-					`https://login.${this.config.environment}/oauth/token`,
+					`${loginBasePath}/oauth/token`,
 					request.headers,
 					undefined,
 					bodyParam,
@@ -488,7 +506,7 @@ class ApiClient {
 						'error',
 						error.response.status,
 						'POST',
-						`https://login.${this.config.environment}/oauth/token`,
+						`${loginBasePath}/oauth/token`,
 						request.headers,
 						error.response.headers,
 						bodyParam,
@@ -812,6 +830,8 @@ class ApiClient {
 	 * @param {function} reject - Promise reject callback
 	 */
 	_handleCodeAuthorizationResponse(request, bodyParam, resolve, reject) {
+		var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
+
 		request
 			.then((response) => {
 				// Logging
@@ -819,7 +839,7 @@ class ApiClient {
 					'trace',
 					response.status,
 					'POST',
-					`https://login.${this.config.environment}/oauth/token`,
+					`${loginBasePath}/oauth/token`,
 					request.headers,
 					response.headers,
 					bodyParam,
@@ -829,7 +849,7 @@ class ApiClient {
 					'debug',
 					response.status,
 					'POST',
-					`https://login.${this.config.environment}/oauth/token`,
+					`${loginBasePath}/oauth/token`,
 					request.headers,
 					undefined,
 					bodyParam,
@@ -855,7 +875,7 @@ class ApiClient {
 						'error',
 						error.response.status,
 						'POST',
-						`https://login.${this.config.environment}/oauth/token`,
+						`${loginBasePath}/oauth/token`,
 						request.headers,
 						error.response.headers,
 						bodyParam,
@@ -873,9 +893,10 @@ class ApiClient {
 	 * @param {object} data - data to url form encode
 	 */
 	_formAuthRequest(encodedData, data) {
+		var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
 		var request = axios({
 			method: `POST`,
-			url: `https://login.${this.config.environment}/oauth/token`,
+			url: `${loginBasePath}/oauth/token`,
 			headers: {
 				'Authorization': 'Basic ' + encodedData,
 				'Content-Type': 'application/x-www-form-urlencoded'
@@ -1064,7 +1085,8 @@ class ApiClient {
 	 */
 	_buildAuthUrl(path, query) {
 		if (!query) query = {};
-		return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${this.config.authUrl}/${path}?`);
+		var loginBasePath = this.config.getConfUrl('login', this.config.authUrl);
+		return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${loginBasePath}/${path}?`);
 	}
 
 	/**
@@ -1126,7 +1148,7 @@ class ApiClient {
 		if (!path.match(/^\//)) {
 			path = `/${path}`;
 		}
-		var url = this.config.basePath + path;
+		var url = this.config.getConfUrl('api', this.config.basePath) + path;
 		url = url.replace(/\{([\w-]+)\}/g, (fullMatch, key) => {
 			var value;
 			if (pathParams.hasOwnProperty(key)) {

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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.0.0
 	 */
 
 	/**

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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.0.0
 	 */
 
 	/**
@@ -856,6 +856,7 @@ class AnalyticsApi {
 	 * @param {Number} opts.pageSize  (default to 25)
 	 * @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
 	 * @param {Object} opts.state Only list users of this state
+	 * @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
 	 */
 	getAnalyticsReportingDashboardsUsers(opts) { 
 		opts = opts || {};
@@ -865,7 +866,7 @@ class AnalyticsApi {
 			'/api/v2/analytics/reporting/dashboards/users', 
 			'GET', 
 			{  },
-			{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'] },
+			{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'],'deletedOnly': opts['deletedOnly'] },
 			{  },
 			{  },
 			null, 
@@ -987,6 +988,7 @@ class AnalyticsApi {
 	 * @param {Number} opts.pageSize  (default to 50)
 	 * @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
 	 * @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
+	 * @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
 	 * @param {String} opts.name retrieve dashboards that match with given name
 	 */
 	getAnalyticsReportingSettingsUserDashboards(userId, opts) { 
@@ -1001,7 +1003,7 @@ class AnalyticsApi {
 			'/api/v2/analytics/reporting/settings/users/{userId}/dashboards', 
 			'GET', 
 			{ 'userId': userId },
-			{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'name': opts['name'] },
+			{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'deletedOnly': opts['deletedOnly'],'name': opts['name'] },
 			{  },
 			{  },
 			null, 
@@ -2091,7 +2093,7 @@ class AnalyticsApi {
 	}
 
 	/**
-	 * Bulk delete dashboards owned by other user(s)
+	 * Bulk soft delete dashboards owned by other user(s)
 	 * 
 	 * @param {Array.<String>} body List of userIds
 	 */
@@ -2141,7 +2143,7 @@ class AnalyticsApi {
 	}
 
 	/**
-	 * Bulk remove dashboard configurations
+	 * Bulk soft delete dashboard configurations
 	 * 
 	 * @param {Object} body 
 	 */
@@ -2327,7 +2329,6 @@ class AnalyticsApi {
 	 * Query for task management aggregates
 	 * 
 	 * @param {Object} body query
-	 * postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postAnalyticsTaskmanagementAggregatesQuery(body) { 
 		// verify the required parameter 'body' is set

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 205.0.0
+	 * @version 207.0.0
 	 */
 
 	/**
@@ -1750,7 +1750,7 @@ class ArchitectApi {
 	}
 
 	/**
-	 * Create flow version configuration
+	 * Get flow version configuration
 	 * 
 	 * @param {String} flowId Flow ID
 	 * @param {String} versionId Version ID

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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.0.0
 	 */
 
 	/**
@@ -394,7 +394,6 @@ class ContentManagementApi {
 	 * This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
 	 * @param {String} sharedId Shared ID
 	 * @param {Object} opts Optional parameters
-	 * @param {Boolean} opts.redirect Turn on or off redirect (default to true)
 	 * @param {Object} opts.disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (default to attachment)
 	 * @param {String} opts.contentType The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
 	 * @param {Object} opts.expand Expand some document fields
@@ -411,7 +410,7 @@ class ContentManagementApi {
 			'/api/v2/contentmanagement/shared/{sharedId}', 
 			'GET', 
 			{ 'sharedId': sharedId },
-			{ 'redirect': opts['redirect'],'disposition': opts['disposition'],'contentType': opts['contentType'],'expand': opts['expand'] },
+			{ 'disposition': opts['disposition'],'contentType': opts['contentType'],'expand': opts['expand'] },
 			{  },
 			{  },
 			null, 

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 205.0.0
+	 * @version 207.0.0
 	 */
 
 	/**
@@ -3751,7 +3751,6 @@ class ConversationsApi {
 	 * @param {String} conversationId conversationId
 	 * @param {String} participantId participantId
 	 * @param {Object} body Parking update request
-	 * patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	patchConversationsEmailParticipantParkingstate(conversationId, participantId, body) { 
 		// verify the required parameter 'conversationId' is set
@@ -4699,9 +4698,10 @@ class ConversationsApi {
 
 	/**
 	 * Suggestion feedback.
-	 * 
+	 * Google Agent Assist offering within Genesys will no longer be supported
 	 * @param {String} conversationId Conversation ID
 	 * @param {Object} body SuggestionFeedback
+	 * @deprecated
 	 */
 	postConversationSuggestionsFeedback(conversationId, body) { 
 		// verify the required parameter 'conversationId' is set
@@ -5991,8 +5991,12 @@ class ConversationsApi {
 	 * Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
 	 * @param {String} integrationId integrationId
 	 * @param {Object} body NormalizedMessage
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.prefetchConversationId Indicates whether or not to prefetch conversationId (default to false)
 	 */
-	postConversationsMessageInboundOpenMessage(integrationId, body) { 
+	postConversationsMessageInboundOpenMessage(integrationId, body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'integrationId' is set
 		if (integrationId === undefined || integrationId === null) {
 			throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
@@ -6006,7 +6010,7 @@ class ConversationsApi {
 			'/api/v2/conversations/messages/{integrationId}/inbound/open/message', 
 			'POST', 
 			{ 'integrationId': integrationId },
-			{  },
+			{ 'prefetchConversationId': opts['prefetchConversationId'] },
 			{  },
 			{  },
 			body, 

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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.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 205.0.0
+	 * @version 207.0.0
 	 */
 
 	/**