npm - purecloud-platform-client-v2 - Versions diffs - 193.0.0 → 194.0.0 - Mend

purecloud-platform-client-v2 193.0.0 → 194.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 (85) hide show

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 193.0.0
+	 * @version 194.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 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class OperationalEventsApi {
 	/**
 	 * OperationalEvents service.
 	 * @module purecloud-platform-client-v2/api/OperationalEventsApi
-	 * @version 193.0.0
+	 * @version 194.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 193.0.0
+	 * @version 194.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 193.0.0
+	 * @version 194.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 193.0.0
+	 * @version 194.0.0
 	 */
 	/**
@@ -1057,6 +1057,40 @@ class OutboundApi {
 		);
 	}
+	/**
+	 * Get line distribution information for campaigns using same Edge Group or Site as given campaign
+	 *
+	 * @param {String} campaignId Campaign ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.includeOnlyActiveCampaigns If true will return only active Campaigns (default to true)
+	 * @param {String} opts.edgeGroupId Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive.
+	 * @param {String} opts.siteId Site to be used in line distribution calculations instead of current Campaign's Site.  Campaign's Site and Edge Group are mutually exclusive.
+	 * @param {Boolean} opts.useWeight Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations
+	 * @param {Number} opts.relativeWeight Relative weight to be used in line distribution calculations instead of current Campaign's relative weight
+	 * @param {Number} opts.outboundLineCount The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count
+	 */
+	getOutboundCampaignLinedistribution(campaignId, opts) {
+		opts = opts || {};
+		// verify the required parameter 'campaignId' is set
+		if (campaignId === undefined || campaignId === null) {
+			throw 'Missing the required parameter "campaignId" when calling getOutboundCampaignLinedistribution';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/outbound/campaigns/{campaignId}/linedistribution',
+			'GET',
+			{ 'campaignId': campaignId },
+			{ 'includeOnlyActiveCampaigns': opts['includeOnlyActiveCampaigns'],'edgeGroupId': opts['edgeGroupId'],'siteId': opts['siteId'],'useWeight': opts['useWeight'],'relativeWeight': opts['relativeWeight'],'outboundLineCount': opts['outboundLineCount'] },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Get campaign progress
 	 *
@@ -3033,6 +3067,96 @@ class OutboundApi {
 		);
 	}
+	/**
+	 * Start an async job to delete contacts using a filter.
+	 *
+	 * @param {String} contactListId Contact List ID
+	 * @param {Object} body Contact filter information.
+	 */
+	postOutboundContactlistContactsBulkRemove(contactListId, body) {
+		// verify the required parameter 'contactListId' is set
+		if (contactListId === undefined || contactListId === null) {
+			throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkRemove';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postOutboundContactlistContactsBulkRemove';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove',
+			'POST',
+			{ 'contactListId': contactListId },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
+	/**
+	 * Start an async job to bulk edit contacts.
+	 *
+	 * @param {String} contactListId Contact List ID
+	 * @param {Object} body Contact bulk edit request information.
+	 */
+	postOutboundContactlistContactsBulkUpdate(contactListId, body) {
+		// verify the required parameter 'contactListId' is set
+		if (contactListId === undefined || contactListId === null) {
+			throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkUpdate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postOutboundContactlistContactsBulkUpdate';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update',
+			'POST',
+			{ 'contactListId': contactListId },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
+	/**
+	 * Query contacts from a contact list.
+	 *
+	 * @param {String} contactListId Contact List ID
+	 * @param {Object} body Contact search parameters.
+	 */
+	postOutboundContactlistContactsSearch(contactListId, body) {
+		// verify the required parameter 'contactListId' is set
+		if (contactListId === undefined || contactListId === null) {
+			throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsSearch';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postOutboundContactlistContactsSearch';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/outbound/contactlists/{contactListId}/contacts/search',
+			'POST',
+			{ 'contactListId': contactListId },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Initiate the export of a contact list.
 	 * Returns 200 if received OK.

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 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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 193.0.0
+	 * @version 194.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 193.0.0
+	 * @version 194.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 193.0.0
+	 * @version 194.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 193.0.0
+	 * @version 194.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 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class ScreenRecordingApi {
 	/**
 	 * ScreenRecording service.
 	 * @module purecloud-platform-client-v2/api/ScreenRecordingApi
-	 * @version 193.0.0
+	 * @version 194.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 193.0.0
+	 * @version 194.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 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class SettingsApi {
 	/**
 	 * Settings service.
 	 * @module purecloud-platform-client-v2/api/SettingsApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class StationsApi {
 	/**
 	 * Stations service.
 	 * @module purecloud-platform-client-v2/api/StationsApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class SuggestApi {
 	/**
 	 * Suggest service.
 	 * @module purecloud-platform-client-v2/api/SuggestApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TaskManagementApi {
 	/**
 	 * TaskManagement service.
 	 * @module purecloud-platform-client-v2/api/TaskManagementApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TeamsApi {
 	/**
 	 * Teams service.
 	 * @module purecloud-platform-client-v2/api/TeamsApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TelephonyApi {
 	/**
 	 * Telephony service.
 	 * @module purecloud-platform-client-v2/api/TelephonyApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
 	/**
 	 * TelephonyProvidersEdge service.
 	 * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TextbotsApi {
 	/**
 	 * Textbots service.
 	 * @module purecloud-platform-client-v2/api/TextbotsApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class TokensApi {
 	/**
 	 * Tokens service.
 	 * @module purecloud-platform-client-v2/api/TokensApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class UploadsApi {
 	/**
 	 * Uploads service.
 	 * @module purecloud-platform-client-v2/api/UploadsApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class UsageApi {
 	/**
 	 * Usage service.
 	 * @module purecloud-platform-client-v2/api/UsageApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class UserRecordingsApi {
 	/**
 	 * UserRecordings service.
 	 * @module purecloud-platform-client-v2/api/UserRecordingsApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class UsersApi {
 	/**
 	 * Users service.
 	 * @module purecloud-platform-client-v2/api/UsersApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class UtilitiesApi {
 	/**
 	 * Utilities service.
 	 * @module purecloud-platform-client-v2/api/UtilitiesApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class VoicemailApi {
 	/**
 	 * Voicemail service.
 	 * @module purecloud-platform-client-v2/api/VoicemailApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class WebChatApi {
 	/**
 	 * WebChat service.
 	 * @module purecloud-platform-client-v2/api/WebChatApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class WebDeploymentsApi {
 	/**
 	 * WebDeployments service.
 	 * @module purecloud-platform-client-v2/api/WebDeploymentsApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class WebMessagingApi {
 	/**
 	 * WebMessaging service.
 	 * @module purecloud-platform-client-v2/api/WebMessagingApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class WidgetsApi {
 	/**
 	 * Widgets service.
 	 * @module purecloud-platform-client-v2/api/WidgetsApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class WorkforceManagementApi {
 	/**
 	 * WorkforceManagement service.
 	 * @module purecloud-platform-client-v2/api/WorkforceManagementApi
-	 * @version 193.0.0
+	 * @version 194.0.0
 	 */
 	/**

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

@@ -107,7 +107,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
  * </pre>
  * </p>
  * @module purecloud-platform-client-v2/index
- * @version 193.0.0
+ * @version 194.0.0
  */
 class platformClient {
 	constructor() {