purecloud-platform-client-v2 149.0.0 → 150.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "149.0.0",
+  "version": "150.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 149.0.0
+ * @version 150.0.0
  */
 class ApiClient {
 	/**

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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.0.0
 	 */
 
 	/**
@@ -1515,8 +1515,12 @@ class ConversationsApi {
 	 * Get message
 	 * 
 	 * @param {String} messageId messageId
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
 	 */
-	getConversationsMessageDetails(messageId) { 
+	getConversationsMessageDetails(messageId, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'messageId' is set
 		if (messageId === undefined || messageId === null) {
 			throw 'Missing the required parameter "messageId" when calling getConversationsMessageDetails';
@@ -1526,7 +1530,7 @@ class ConversationsApi {
 			'/api/v2/conversations/messages/{messageId}/details', 
 			'GET', 
 			{ 'messageId': messageId },
-			{  },
+			{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
 			{  },
 			{  },
 			null, 
@@ -1541,8 +1545,12 @@ class ConversationsApi {
 	 * 
 	 * @param {String} conversationId conversationId
 	 * @param {String} messageId messageId
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
 	 */
-	getConversationsMessageMessage(conversationId, messageId) { 
+	getConversationsMessageMessage(conversationId, messageId, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'conversationId' is set
 		if (conversationId === undefined || conversationId === null) {
 			throw 'Missing the required parameter "conversationId" when calling getConversationsMessageMessage';
@@ -1556,7 +1564,7 @@ class ConversationsApi {
 			'/api/v2/conversations/messages/{conversationId}/messages/{messageId}', 
 			'GET', 
 			{ 'conversationId': conversationId,'messageId': messageId },
-			{  },
+			{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
 			{  },
 			{  },
 			null, 
@@ -4174,6 +4182,31 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Create an email conversation, per API
+	 * 
+	 * @param {Object} body Create agentless email request
+	 */
+	postConversationsEmailsAgentless(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationsEmailsAgentless';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/emails/agentless', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Create Fax Conversation
 	 * 
@@ -4255,8 +4288,12 @@ class ConversationsApi {
 	 * @param {String} conversationId conversationId
 	 * @param {String} communicationId communicationId
 	 * @param {Object} body Message
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
 	 */
-	postConversationsMessageCommunicationMessages(conversationId, communicationId, body) { 
+	postConversationsMessageCommunicationMessages(conversationId, communicationId, body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'conversationId' is set
 		if (conversationId === undefined || conversationId === null) {
 			throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessages';
@@ -4274,7 +4311,7 @@ class ConversationsApi {
 			'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages', 
 			'POST', 
 			{ 'conversationId': conversationId,'communicationId': communicationId },
-			{  },
+			{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
 			{  },
 			{  },
 			body, 
@@ -4319,6 +4356,7 @@ class ConversationsApi {
 	 * The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
 	 * @param {String} conversationId 
 	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
 	 * @param {Array.<String>} opts.body messageIds
 	 */
 	postConversationsMessageMessagesBulk(conversationId, opts) { 
@@ -4333,7 +4371,7 @@ class ConversationsApi {
 			'/api/v2/conversations/messages/{conversationId}/messages/bulk', 
 			'POST', 
 			{ 'conversationId': conversationId },
-			{  },
+			{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
 			{  },
 			{  },
 			opts['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 149.0.0
+	 * @version 150.0.0
 	 */
 
 	/**

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

@@ -0,0 +1,57 @@
+import ApiClient from '../ApiClient.js';
+
+
+class DownloadsApi {
+	/**
+	 * Downloads service.
+	 * @module purecloud-platform-client-v2/api/DownloadsApi
+	 * @version 150.0.0
+	 */
+
+	/**
+	 * Constructs a new DownloadsApi. 
+	 * @alias module:purecloud-platform-client-v2/api/DownloadsApi
+	 * @class
+	 * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
+	 * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
+	 */
+	constructor(apiClient) {
+		this.apiClient = apiClient || ApiClient.instance;
+	}
+
+
+	/**
+	 * Issues a redirect to a signed secure download URL for specified download
+	 * this method will issue a redirect to the url to the content
+	 * @param {String} downloadId Download ID
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.contentDisposition 
+	 * @param {Boolean} opts.issueRedirect  (default to true)
+	 * @param {Boolean} opts.redirectToAuth  (default to true)
+	 */
+	getDownload(downloadId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'downloadId' is set
+		if (downloadId === undefined || downloadId === null) {
+			throw 'Missing the required parameter "downloadId" when calling getDownload';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/downloads/{downloadId}', 
+			'GET', 
+			{ 'downloadId': downloadId },
+			{ 'contentDisposition': opts['contentDisposition'],'issueRedirect': opts['issueRedirect'],'redirectToAuth': opts['redirectToAuth'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+}
+
+
+export default DownloadsApi;

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

@@ -0,0 +1,101 @@
+import ApiClient from '../ApiClient.js';
+
+
+class EventsApi {
+	/**
+	 * Events service.
+	 * @module purecloud-platform-client-v2/api/EventsApi
+	 * @version 150.0.0
+	 */
+
+	/**
+	 * Constructs a new EventsApi. 
+	 * @alias module:purecloud-platform-client-v2/api/EventsApi
+	 * @class
+	 * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
+	 * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
+	 */
+	constructor(apiClient) {
+		this.apiClient = apiClient || ApiClient.instance;
+	}
+
+
+	/**
+	 * Publish Conversation Batch Events
+	 * 
+	 * @param {Object} body batchRequest
+	 */
+	postEventsConversations(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postEventsConversations';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/events/conversations', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Publish User Presence Status Batch Events
+	 * 
+	 * @param {Object} body batchRequest
+	 */
+	postEventsUsersPresence(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postEventsUsersPresence';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/events/users/presence', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Publish Agent Routing Status Batch Events
+	 * 
+	 * @param {Object} body batchRequest
+	 */
+	postEventsUsersRoutingstatus(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/events/users/routingstatus', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+}
+
+
+export default EventsApi;

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 149.0.0
+	 * @version 150.0.0
 	 */
 
 	/**
@@ -234,6 +234,31 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * List the identifiers for a contact
+	 * 
+	 * @param {String} contactId ExternalContact ID
+	 */
+	getExternalcontactsContactIdentifiers(contactId) { 
+		// verify the required parameter 'contactId' is set
+		if (contactId === undefined || contactId === null) {
+			throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactIdentifiers';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/contacts/{contactId}/identifiers', 
+			'GET', 
+			{ 'contactId': contactId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Fetch a note for an external contact
 	 * 
@@ -300,6 +325,35 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * Fetch an unresolved external contact
+	 * 
+	 * @param {String} contactId ExternalContact ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
+	 */
+	getExternalcontactsContactUnresolved(contactId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'contactId' is set
+		if (contactId === undefined || contactId === null) {
+			throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactUnresolved';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/contacts/{contactId}/unresolved', 
+			'GET', 
+			{ 'contactId': contactId },
+			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Search for external contacts
 	 * 
@@ -877,6 +931,36 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * Claim or release identifiers for a contact
+	 * 
+	 * @param {String} contactId ExternalContact ID
+	 * @param {Object} body ClaimRequest
+	 */
+	patchExternalcontactsContactIdentifiers(contactId, body) { 
+		// verify the required parameter 'contactId' is set
+		if (contactId === undefined || contactId === null) {
+			throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContactIdentifiers';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchExternalcontactsContactIdentifiers';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/contacts/{contactId}/identifiers', 
+			'PATCH', 
+			{ 'contactId': contactId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Bulk fetch contacts
 	 * 
@@ -952,6 +1036,31 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * Bulk fetch unresolved ancestor contacts
+	 * 
+	 * @param {Object} body Contact ids
+	 */
+	postExternalcontactsBulkContactsUnresolved(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsUnresolved';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/bulk/contacts/unresolved', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Bulk update contacts
 	 * 
@@ -1307,6 +1416,31 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * Promote an observed contact (ephemeral or identified) to a curated contact
+	 * 
+	 * @param {String} contactId ExternalContact ID
+	 */
+	postExternalcontactsContactPromotion(contactId) { 
+		// verify the required parameter 'contactId' is set
+		if (contactId === undefined || contactId === null) {
+			throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactPromotion';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/contacts/{contactId}/promotion', 
+			'POST', 
+			{ 'contactId': contactId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Create an external contact
 	 * 
@@ -1357,6 +1491,56 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * Fetch a contact using an identifier type and value.
+	 * Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
+	 * @param {Object} identifier 
+	 */
+	postExternalcontactsIdentifierlookup(identifier) { 
+		// verify the required parameter 'identifier' is set
+		if (identifier === undefined || identifier === null) {
+			throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/identifierlookup', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			identifier, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Merge two contacts into a new contact record
+	 * 
+	 * @param {Object} body MergeRequest
+	 */
+	postExternalcontactsMergeContacts(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postExternalcontactsMergeContacts';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/merge/contacts', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Create a note for an external organization
 	 * 

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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.0.0
 	 */
 
 	/**

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 149.0.0
+	 * @version 150.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 149.0.0
+	 * @version 150.0.0
 	 */
 
 	/**