npm - purecloud-platform-client-v2 - Versions diffs - 150.0.0 → 151.0.0 - Mend

purecloud-platform-client-v2 150.0.0 → 151.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (77) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "150.0.0",
+  "version": "151.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 CHANGED Viewed

@@ -4,7 +4,7 @@ import { default as qs } from 'qs';
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 150.0.0
+ * @version 151.0.0
  */
 class ApiClient {
 	/**

package/src/purecloud-platform-client-v2/api/AlertingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class AlertingApi {
 	/**
 	 * Alerting service.
 	 * @module purecloud-platform-client-v2/api/AlertingApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/AnalyticsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class AnalyticsApi {
 	/**
 	 * Analytics service.
 	 * @module purecloud-platform-client-v2/api/AnalyticsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ArchitectApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ArchitectApi {
 	/**
 	 * Architect service.
 	 * @module purecloud-platform-client-v2/api/ArchitectApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/AuditApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class AuditApi {
 	/**
 	 * Audit service.
 	 * @module purecloud-platform-client-v2/api/AuditApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/AuthorizationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class AuthorizationApi {
 	/**
 	 * Authorization service.
 	 * @module purecloud-platform-client-v2/api/AuthorizationApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/BillingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class BillingApi {
 	/**
 	 * Billing service.
 	 * @module purecloud-platform-client-v2/api/BillingApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ChatApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ChatApi {
 	/**
 	 * Chat service.
 	 * @module purecloud-platform-client-v2/api/ChatApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/CoachingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class CoachingApi {
 	/**
 	 * Coaching service.
 	 * @module purecloud-platform-client-v2/api/CoachingApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ContentManagementApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ContentManagementApi {
 	/**
 	 * ContentManagement service.
 	 * @module purecloud-platform-client-v2/api/ContentManagementApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ConversationsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ConversationsApi {
 	/**
 	 * Conversations service.
 	 * @module purecloud-platform-client-v2/api/ConversationsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**
@@ -4351,6 +4351,41 @@ class ConversationsApi {
 		);
 	}
+	/**
+	 * Send message typing event
+	 * Send message typing event for existing conversation/communication.
+	 * @param {String} conversationId conversationId
+	 * @param {String} communicationId communicationId
+	 * @param {Object} body MessageTypingEvent
+	 */
+	postConversationsMessageCommunicationTyping(conversationId, communicationId, body) {
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationTyping';
+		}
+		// verify the required parameter 'communicationId' is set
+		if (communicationId === undefined || communicationId === null) {
+			throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationTyping';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationTyping';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing',
+			'POST',
+			{ 'conversationId': conversationId,'communicationId': communicationId },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Get messages in batch
 	 * 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"]

package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class DataExtensionsApi {
 	/**
 	 * DataExtensions service.
 	 * @module purecloud-platform-client-v2/api/DataExtensionsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

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

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

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

@@ -5,7 +5,7 @@ class EventsApi {
 	/**
 	 * Events service.
 	 * @module purecloud-platform-client-v2/api/EventsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ExternalContactsApi {
 	/**
 	 * ExternalContacts service.
 	 * @module purecloud-platform-client-v2/api/ExternalContactsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**
@@ -259,6 +259,37 @@ class ExternalContactsApi {
 		);
 	}
+	/**
+	 * Retrieve all sessions for a given external contact.
+	 *
+	 * @param {String} contactId ExternalContact ID
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
+	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
+	 * @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
+	 */
+	getExternalcontactsContactJourneySessions(contactId, opts) {
+		opts = opts || {};
+		// verify the required parameter 'contactId' is set
+		if (contactId === undefined || contactId === null) {
+			throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
+			'GET',
+			{ 'contactId': contactId },
+			{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Fetch a note for an external contact
 	 *

package/src/purecloud-platform-client-v2/api/FaxApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class FaxApi {
 	/**
 	 * Fax service.
 	 * @module purecloud-platform-client-v2/api/FaxApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/FlowsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class FlowsApi {
 	/**
 	 * Flows service.
 	 * @module purecloud-platform-client-v2/api/FlowsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/GamificationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi {
 	/**
 	 * GeneralDataProtectionRegulation service.
 	 * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/GeolocationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class GeolocationApi {
 	/**
 	 * Geolocation service.
 	 * @module purecloud-platform-client-v2/api/GeolocationApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/GreetingsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class GreetingsApi {
 	/**
 	 * Greetings service.
 	 * @module purecloud-platform-client-v2/api/GreetingsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/GroupsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class GroupsApi {
 	/**
 	 * Groups service.
 	 * @module purecloud-platform-client-v2/api/GroupsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class IdentityProviderApi {
 	/**
 	 * IdentityProvider service.
 	 * @module purecloud-platform-client-v2/api/IdentityProviderApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/IntegrationsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/JourneyApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class JourneyApi {
 	/**
 	 * Journey service.
 	 * @module purecloud-platform-client-v2/api/JourneyApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/KnowledgeApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class KnowledgeApi {
 	/**
 	 * Knowledge service.
 	 * @module purecloud-platform-client-v2/api/KnowledgeApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
 	/**
 	 * LanguageUnderstanding service.
 	 * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/LanguagesApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class LanguagesApi {
 	/**
 	 * Languages service.
 	 * @module purecloud-platform-client-v2/api/LanguagesApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/LearningApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class LearningApi {
 	/**
 	 * Learning service.
 	 * @module purecloud-platform-client-v2/api/LearningApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/LicenseApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class LicenseApi {
 	/**
 	 * License service.
 	 * @module purecloud-platform-client-v2/api/LicenseApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/LocationsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class LocationsApi {
 	/**
 	 * Locations service.
 	 * @module purecloud-platform-client-v2/api/LocationsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/MessagingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class MessagingApi {
 	/**
 	 * Messaging service.
 	 * @module purecloud-platform-client-v2/api/MessagingApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class MobileDevicesApi {
 	/**
 	 * MobileDevices service.
 	 * @module purecloud-platform-client-v2/api/MobileDevicesApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/NotificationsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class NotificationsApi {
 	/**
 	 * Notifications service.
 	 * @module purecloud-platform-client-v2/api/NotificationsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/OAuthApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class OAuthApi {
 	/**
 	 * OAuth service.
 	 * @module purecloud-platform-client-v2/api/OAuthApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ObjectsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ObjectsApi {
 	/**
 	 * Objects service.
 	 * @module purecloud-platform-client-v2/api/ObjectsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/OrganizationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class OrganizationApi {
 	/**
 	 * Organization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
 	/**
 	 * OrganizationAuthorization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/OutboundApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class OutboundApi {
 	/**
 	 * Outbound service.
 	 * @module purecloud-platform-client-v2/api/OutboundApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/PresenceApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class PresenceApi {
 	/**
 	 * Presence service.
 	 * @module purecloud-platform-client-v2/api/PresenceApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**
@@ -99,7 +99,7 @@ class PresenceApi {
 	 * Get a list of Presence Sources
 	 *
 	 * @param {Object} opts Optional parameters
-	 * @param {String} opts.deleted Deleted query can be TRUE or FALSE (default to false)
+	 * @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
 	 */
 	getPresenceSources(opts) {
 		opts = opts || {};
@@ -109,7 +109,7 @@ class PresenceApi {
 			'/api/v2/presence/sources',
 			'GET',
 			{  },
-			{ 'deleted': opts['deleted'] },
+			{ 'deactivated': opts['deactivated'] },
 			{  },
 			{  },
 			null,

package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ProcessAutomationApi {
 	/**
 	 * ProcessAutomation service.
 	 * @module purecloud-platform-client-v2/api/ProcessAutomationApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**
@@ -46,7 +46,7 @@ class ProcessAutomationApi {
 	}
 	/**
-	 * Retrieve a single Trigger matching id.
+	 * Retrieve a single Trigger matching id
 	 *
 	 * @param {String} triggerId triggerId
 	 */
@@ -71,13 +71,13 @@ class ProcessAutomationApi {
 	}
 	/**
-	 * Retrieves all triggers
+	 * Retrieves all triggers, optionally filtered by query parameters.
 	 *
 	 * @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.topicName Topic name
+	 * @param {String} opts.topicName Topic name(s). Separated by commas
 	 * @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
 	 */
 	getProcessautomationTriggers(opts) {

package/src/purecloud-platform-client-v2/api/QualityApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class QualityApi {
 	/**
 	 * Quality service.
 	 * @module purecloud-platform-client-v2/api/QualityApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/RecordingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class RecordingApi {
 	/**
 	 * Recording service.
 	 * @module purecloud-platform-client-v2/api/RecordingApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ResponseManagementApi {
 	/**
 	 * ResponseManagement service.
 	 * @module purecloud-platform-client-v2/api/ResponseManagementApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/RoutingApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class RoutingApi {
 	/**
 	 * Routing service.
 	 * @module purecloud-platform-client-v2/api/RoutingApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/SCIMApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class SCIMApi {
 	/**
 	 * SCIM service.
 	 * @module purecloud-platform-client-v2/api/SCIMApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/ScriptsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class ScriptsApi {
 	/**
 	 * Scripts service.
 	 * @module purecloud-platform-client-v2/api/ScriptsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/SearchApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class SearchApi {
 	/**
 	 * Search service.
 	 * @module purecloud-platform-client-v2/api/SearchApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**
@@ -534,6 +534,31 @@ class SearchApi {
 		);
 	}
+	/**
+	 * Search users assigned to teams
+	 *
+	 * @param {Object} body Search request options
+	 */
+	postUsersSearchTeamsAssign(body) {
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/users/search/teams/assign',
+			'POST',
+			{  },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Search voicemails
 	 *

package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
 	/**
 	 * SpeechTextAnalytics service.
 	 * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
-	 * @version 150.0.0
+	 * @version 151.0.0
 	 */
 	/**