npm - purecloud-platform-client-v2 - Versions diffs - 205.0.0 → 206.0.0 - Mend

purecloud-platform-client-v2 205.0.0 → 206.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 (89) hide show

package/package.json CHANGED Viewed

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

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

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

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

@@ -5,7 +5,7 @@ class AgentCopilotApi {
 	/**
 	 * AgentCopilot service.
 	 * @module purecloud-platform-client-v2/api/AgentCopilotApi
-	 * @version 205.0.0
+	 * @version 206.0.0
 	 */
 	/**

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

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

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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class CarrierServicesApi {
 	/**
 	 * CarrierServices service.
 	 * @module purecloud-platform-client-v2/api/CarrierServicesApi
-	 * @version 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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
@@ -5991,8 +5990,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 +6009,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 CHANGED Viewed

@@ -5,7 +5,7 @@ class DataExtensionsApi {
 	/**
 	 * DataExtensions service.
 	 * @module purecloud-platform-client-v2/api/DataExtensionsApi
-	 * @version 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.0.0
 	 */
 	/**

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

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

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

@@ -5,7 +5,7 @@ class EmployeeEngagementApi {
 	/**
 	 * EmployeeEngagement service.
 	 * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
-	 * @version 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.0.0
 	 */
 	/**

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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class InfrastructureAsCodeApi {
 	/**
 	 * InfrastructureAsCode service.
 	 * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
-	 * @version 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.0.0
 	 */
 	/**
@@ -852,6 +852,81 @@ class JourneyApi {
 		);
 	}
+	/**
+	 * Get a Chart by ID
+	 * returns the latest version
+	 * @param {String} viewId viewId
+	 * @param {String} journeyViewVersion Journey View Version
+	 * @param {String} chartId chartId
+	 */
+	getJourneyViewVersionChart(viewId, journeyViewVersion, chartId) {
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionChart';
+		}
+		// verify the required parameter 'journeyViewVersion' is set
+		if (journeyViewVersion === undefined || journeyViewVersion === null) {
+			throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChart';
+		}
+		// verify the required parameter 'chartId' is set
+		if (chartId === undefined || chartId === null) {
+			throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionChart';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}',
+			'GET',
+			{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'chartId': chartId },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
+	/**
+	 * Get a Chart by ID and version
+	 *
+	 * @param {String} viewId viewId
+	 * @param {String} journeyViewVersion Journey View Version
+	 * @param {String} chartId chartId
+	 * @param {String} chartVersion chartVersion
+	 */
+	getJourneyViewVersionChartVersion(viewId, journeyViewVersion, chartId, chartVersion) {
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionChartVersion';
+		}
+		// verify the required parameter 'journeyViewVersion' is set
+		if (journeyViewVersion === undefined || journeyViewVersion === null) {
+			throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChartVersion';
+		}
+		// verify the required parameter 'chartId' is set
+		if (chartId === undefined || chartId === null) {
+			throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionChartVersion';
+		}
+		// verify the required parameter 'chartVersion' is set
+		if (chartVersion === undefined || chartVersion === null) {
+			throw 'Missing the required parameter "chartVersion" when calling getJourneyViewVersionChartVersion';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}',
+			'GET',
+			{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'chartId': chartId,'chartVersion': chartVersion },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Get the job for a journey view version.
 	 * used for long descriptions
@@ -922,6 +997,46 @@ class JourneyApi {
 		);
 	}
+	/**
+	 * Get the chart result associated with a journey view job.
+	 *
+	 * @param {String} viewId Journey View Id
+	 * @param {String} journeyVersionId Journey View Version
+	 * @param {String} jobId JobId
+	 * @param {String} chartId ChartId
+	 */
+	getJourneyViewVersionJobResultsChart(viewId, journeyVersionId, jobId, chartId) {
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResultsChart';
+		}
+		// verify the required parameter 'journeyVersionId' is set
+		if (journeyVersionId === undefined || journeyVersionId === null) {
+			throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobResultsChart';
+		}
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResultsChart';
+		}
+		// verify the required parameter 'chartId' is set
+		if (chartId === undefined || chartId === null) {
+			throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionJobResultsChart';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}',
+			'GET',
+			{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId,'chartId': chartId },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Get the latest job of a journey view version.
 	 * used for long descriptions
@@ -1199,6 +1314,46 @@ class JourneyApi {
 		);
 	}
+	/**
+	 * Update the job for a journey view version. Only the status can be changed and only to Cancelled
+	 * used for long descriptions
+	 * @param {String} viewId Journey View Id
+	 * @param {String} journeyVersionId Journey View Version
+	 * @param {String} jobId JobId
+	 * @param {Object} body journeyViewJob
+	 */
+	patchJourneyViewVersionJob(viewId, journeyVersionId, jobId, body) {
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling patchJourneyViewVersionJob';
+		}
+		// verify the required parameter 'journeyVersionId' is set
+		if (journeyVersionId === undefined || journeyVersionId === null) {
+			throw 'Missing the required parameter "journeyVersionId" when calling patchJourneyViewVersionJob';
+		}
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling patchJourneyViewVersionJob';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchJourneyViewVersionJob';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}',
+			'PATCH',
+			{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Query for journey aggregates asynchronously
 	 *
@@ -1642,6 +1797,41 @@ class JourneyApi {
 		);
 	}
+	/**
+	 * Update a Journey View by ID and version
+	 * does not create a new version
+	 * @param {String} viewId viewId
+	 * @param {String} versionId versionId
+	 * @param {Object} body JourneyView
+	 */
+	putJourneyViewVersion(viewId, versionId, body) {
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling putJourneyViewVersion';
+		}
+		// verify the required parameter 'versionId' is set
+		if (versionId === undefined || versionId === null) {
+			throw 'Missing the required parameter "versionId" when calling putJourneyViewVersion';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putJourneyViewVersion';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/versions/{versionId}',
+			'PUT',
+			{ 'viewId': viewId,'versionId': versionId },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 }

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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class LogCaptureApi {
 	/**
 	 * LogCapture service.
 	 * @module purecloud-platform-client-v2/api/LogCaptureApi
-	 * @version 205.0.0
+	 * @version 206.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 205.0.0
+	 * @version 206.0.0
 	 */
 	/**