npm - purecloud-platform-client-v2 - Versions diffs - 249.1.0 → 250.1.0 - Mend

purecloud-platform-client-v2 249.1.0 → 250.1.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 (97) hide show

package/package.json CHANGED Viewed

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

@@ -6,7 +6,7 @@ import { default as qs } from 'qs';
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 249.1.0
+ * @version 250.1.0
  */
 class ApiClient {
 	/**
@@ -72,7 +72,7 @@ class ApiClient {
 			MULTI: 'multi'
 		};
-		this.useLegacyParameterFilter = true;
+		this.useLegacyParameterFilter = false;
 		/**
 		 * @description Value is `true` if local storage exists. Otherwise, false.

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

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

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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.0
 	 */
 	/**
@@ -205,6 +205,37 @@ class AnalyticsApi {
 		);
 	}
+	/**
+	 * Delete/cancel an async request for copilot aggregates
+	 *
+	 * @param {String} jobId jobId
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
+	 * deleteAnalyticsCopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	deleteAnalyticsCopilotsAggregatesJob(jobId, opts) {
+		opts = opts || {};
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null || jobId === '') {
+			throw 'Missing the required parameter "jobId" when calling deleteAnalyticsCopilotsAggregatesJob';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/analytics/copilots/aggregates/jobs/{jobId}',
+			'DELETE',
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json'],
+			opts['customHeaders']
+		);
+	}
 	/**
 	 * Delete/cancel an async request for evaluation aggregates
 	 *
@@ -1174,6 +1205,69 @@ class AnalyticsApi {
 		);
 	}
+	/**
+	 * Get status for async query for copilot aggregates
+	 *
+	 * @param {String} jobId jobId
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
+	 * getAnalyticsCopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAnalyticsCopilotsAggregatesJob(jobId, opts) {
+		opts = opts || {};
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null || jobId === '') {
+			throw 'Missing the required parameter "jobId" when calling getAnalyticsCopilotsAggregatesJob';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/analytics/copilots/aggregates/jobs/{jobId}',
+			'GET',
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json'],
+			opts['customHeaders']
+		);
+	}
+	/**
+	 * Fetch a page of results for an async aggregates query
+	 *
+	 * @param {String} jobId jobId
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.cursor Cursor token to retrieve next page
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
+	 * getAnalyticsCopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAnalyticsCopilotsAggregatesJobResults(jobId, opts) {
+		opts = opts || {};
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null || jobId === '') {
+			throw 'Missing the required parameter "jobId" when calling getAnalyticsCopilotsAggregatesJobResults';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/analytics/copilots/aggregates/jobs/{jobId}/results',
+			'GET',
+			{ 'jobId': jobId },
+			{ 'cursor': opts['cursor'] },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json'],
+			opts['customHeaders']
+		);
+	}
 	/**
 	 * Get analytics data warehouse file download
 	 *
@@ -2781,6 +2875,68 @@ class AnalyticsApi {
 		);
 	}
+	/**
+	 * Query for copilot aggregates asynchronously
+	 *
+	 * @param {Object} body query
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
+	 * postAnalyticsCopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postAnalyticsCopilotsAggregatesJobs(body, opts) {
+		opts = opts || {};
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAnalyticsCopilotsAggregatesJobs';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/analytics/copilots/aggregates/jobs',
+			'POST',
+			{  },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json'],
+			opts['customHeaders']
+		);
+	}
+	/**
+	 * Query for copilot aggregates
+	 *
+	 * @param {Object} body query
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
+	 * postAnalyticsCopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postAnalyticsCopilotsAggregatesQuery(body, opts) {
+		opts = opts || {};
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAnalyticsCopilotsAggregatesQuery';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/analytics/copilots/aggregates/query',
+			'POST',
+			{  },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json'],
+			opts['customHeaders']
+		);
+	}
 	/**
 	 * Get download URLs for analytics data warehouse files
 	 *
@@ -3643,7 +3799,6 @@ class AnalyticsApi {
 	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned. Used for pagination.
 	 * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.
 	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
-	 * postAnalyticsTaskmanagementMetricsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postAnalyticsTaskmanagementMetricsQuery(body, opts) {
 		opts = opts || {};

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 249.1.0
+	 * @version 250.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class AssistantCopilotVariationsApi {
 	/**
 	 * AssistantCopilotVariations service.
 	 * @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
-	 * @version 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class BackgroundAssistantApi {
 	/**
 	 * BackgroundAssistant service.
 	 * @module purecloud-platform-client-v2/api/BackgroundAssistantApi
-	 * @version 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class BusinessRulesApi {
 	/**
 	 * BusinessRules service.
 	 * @module purecloud-platform-client-v2/api/BusinessRulesApi
-	 * @version 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class CaseManagementApi {
 	/**
 	 * CaseManagement service.
 	 * @module purecloud-platform-client-v2/api/CaseManagementApi
-	 * @version 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.0
 	 */
 	/**
@@ -7881,6 +7881,46 @@ class ConversationsApi {
 		);
 	}
+	/**
+	 * Start/stop the snippet recording for a participant
+	 *
+	 * @param {String} conversationId conversationId
+	 * @param {String} participantId participantId
+	 * @param {Object} body snippetRecordingRequest
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
+	 */
+	postConversationsCallParticipantSnippetRecord(conversationId, participantId, body, opts) {
+		opts = opts || {};
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null || conversationId === '') {
+			throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantSnippetRecord';
+		}
+		// verify the required parameter 'participantId' is set
+		if (participantId === undefined || participantId === null || participantId === '') {
+			throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantSnippetRecord';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationsCallParticipantSnippetRecord';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/snippet/record',
+			'POST',
+			{ 'conversationId': conversationId,'participantId': participantId },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json'],
+			opts['customHeaders']
+		);
+	}
 	/**
 	 * Initiate voice consult transfer
 	 *

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 249.1.0
+	 * @version 250.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class DataPrivacyApi {
 	/**
 	 * DataPrivacy service.
 	 * @module purecloud-platform-client-v2/api/DataPrivacyApi
-	 * @version 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.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 249.1.0
+	 * @version 250.1.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class IntentsApi {
 	/**
 	 * Intents service.
 	 * @module purecloud-platform-client-v2/api/IntentsApi
-	 * @version 249.1.0
+	 * @version 250.1.0
 	 */
 	/**