purecloud-platform-client-v2 192.2.0 → 194.0.0

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class OperationalEventsApi {
 	/**
 	 * OperationalEvents service.
 	 * @module purecloud-platform-client-v2/api/OperationalEventsApi
-	 * @version 192.2.0
+	 * @version 194.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OrganizationApi {
 	/**
 	 * Organization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationApi
-	 * @version 192.2.0
+	 * @version 194.0.0
 	 */
 
 	/**
@@ -181,6 +181,26 @@ class OrganizationApi {
 		);
 	}
 
+	/**
+	 * Get free trial limit documentation
+	 * 
+	 */
+	getOrganizationsLimitsDocsFreetrial() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/organizations/limits/docs/freetrial', 
+			'GET', 
+			{  },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get the effective limits in a namespace for an organization
 	 * 

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

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

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

@@ -5,7 +5,7 @@ class OutboundApi {
 	/**
 	 * Outbound service.
 	 * @module purecloud-platform-client-v2/api/OutboundApi
-	 * @version 192.2.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

@@ -5,7 +5,7 @@ class PresenceApi {
 	/**
 	 * Presence service.
 	 * @module purecloud-platform-client-v2/api/PresenceApi
-	 * @version 192.2.0
+	 * @version 194.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ProcessAutomationApi {
 	/**
 	 * ProcessAutomation service.
 	 * @module purecloud-platform-client-v2/api/ProcessAutomationApi
-	 * @version 192.2.0
+	 * @version 194.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class QualityApi {
 	/**
 	 * Quality service.
 	 * @module purecloud-platform-client-v2/api/QualityApi
-	 * @version 192.2.0
+	 * @version 194.0.0
 	 */
 
 	/**
@@ -493,7 +493,7 @@ class QualityApi {
 
 	/**
 	 * Queries Evaluations and returns a paged list
-	 * Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch.
+	 * Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch. The evaluation entities contained in the response might only contain a subset of all the properties listed below. It is often because a given propertys value has not yet been populated or is not applicable in the current state of the evaluation. It might also be because the missing property in the response was not requested by the user.
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageSize The total page size requested (default to 25)
 	 * @param {Number} opts.pageNumber The page number requested (default to 1)
@@ -513,7 +513,7 @@ class QualityApi {
 	 * @param {Array.<String>} opts.evaluationState 
 	 * @param {Boolean} opts.isReleased the evaluation has been released
 	 * @param {Boolean} opts.agentHasRead agent has the evaluation
-	 * @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
+	 * @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request.
 	 * @param {Number} opts.maximum the maximum number of results to return
 	 * @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
 	 */

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

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

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

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

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

@@ -5,7 +5,7 @@ class RoutingApi {
 	/**
 	 * Routing service.
 	 * @module purecloud-platform-client-v2/api/RoutingApi
-	 * @version 192.2.0
+	 * @version 194.0.0
 	 */
 
 	/**
@@ -2902,7 +2902,6 @@ class RoutingApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageSize The desired page size
 	 * @param {Number} opts.pageNumber The desired page number
-	 * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postAnalyticsRoutingActivityQuery(body, opts) { 
 		opts = opts || {};

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

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

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

@@ -5,7 +5,7 @@ class ScreenRecordingApi {
 	/**
 	 * ScreenRecording service.
 	 * @module purecloud-platform-client-v2/api/ScreenRecordingApi
-	 * @version 192.2.0
+	 * @version 194.0.0
 	 */
 
 	/**

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

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

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

@@ -5,7 +5,7 @@ class SearchApi {
 	/**
 	 * Search service.
 	 * @module purecloud-platform-client-v2/api/SearchApi
-	 * @version 192.2.0
+	 * @version 194.0.0
 	 */
 
 	/**

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

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

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

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

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

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

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

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