purecloud-platform-client-v2 236.0.0 → 237.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 236.0.0
+	 * @version 237.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 236.0.0
+	 * @version 237.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 236.0.0
+	 * @version 237.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 236.0.0
+	 * @version 237.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class SocialMediaApi {
 	/**
 	 * SocialMedia service.
 	 * @module purecloud-platform-client-v2/api/SocialMediaApi
-	 * @version 236.0.0
+	 * @version 237.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 236.0.0
+	 * @version 237.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 236.0.0
+	 * @version 237.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 236.0.0
+	 * @version 237.0.0
 	 */
 
 	/**

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,294 @@
+import ApiClient from '../ApiClient.js';
+
+
+class UsersRulesApi {
+	/**
+	 * UsersRules service.
+	 * @module purecloud-platform-client-v2/api/UsersRulesApi
+	 * @version 237.0.0
+	 */
+
+	/**
+	 * Constructs a new UsersRulesApi. 
+	 * @alias module:purecloud-platform-client-v2/api/UsersRulesApi
+	 * @class
+	 * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
+	 * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
+	 */
+	constructor(apiClient) {
+		this.apiClient = apiClient || ApiClient.instance;
+	}
+
+
+	/**
+	 * Delete an existing users rule
+	 * 
+	 * @param {String} ruleId The id of the rule
+	 * deleteUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	deleteUsersRule(ruleId) { 
+		// verify the required parameter 'ruleId' is set
+		if (ruleId === undefined || ruleId === null || ruleId === '') {
+			throw 'Missing the required parameter "ruleId" when calling deleteUsersRule';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/rules/{ruleId}', 
+			'DELETE', 
+			{ 'ruleId': ruleId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a users rule
+	 * 
+	 * @param {String} ruleId The ID of the rule to retrieve
+	 * getUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getUsersRule(ruleId) { 
+		// verify the required parameter 'ruleId' is set
+		if (ruleId === undefined || ruleId === null || ruleId === '') {
+			throw 'Missing the required parameter "ruleId" when calling getUsersRule';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/rules/{ruleId}', 
+			'GET', 
+			{ 'ruleId': ruleId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get dependent of a users rule
+	 * 
+	 * @param {String} ruleId The ID of the rule for which to retrieve dependents
+	 * @param {Object} ruleType The type of the dependent
+	 * @param {String} typeId The type ID of the dependent
+	 * getUsersRuleDependentTypeId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getUsersRuleDependentTypeId(ruleId, ruleType, typeId) { 
+		// verify the required parameter 'ruleId' is set
+		if (ruleId === undefined || ruleId === null || ruleId === '') {
+			throw 'Missing the required parameter "ruleId" when calling getUsersRuleDependentTypeId';
+		}
+		// verify the required parameter 'ruleType' is set
+		if (ruleType === undefined || ruleType === null || ruleType === '') {
+			throw 'Missing the required parameter "ruleType" when calling getUsersRuleDependentTypeId';
+		}
+		// verify the required parameter 'typeId' is set
+		if (typeId === undefined || typeId === null || typeId === '') {
+			throw 'Missing the required parameter "typeId" when calling getUsersRuleDependentTypeId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/rules/{ruleId}/dependents/{ruleType}/{typeId}', 
+			'GET', 
+			{ 'ruleId': ruleId,'ruleType': ruleType,'typeId': typeId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get dependents for a users rule
+	 * 
+	 * @param {String} ruleId The ID of the rule for which to retrieve dependents
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageSize Number of results per page (default to 25)
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 * @param {Object} opts.sortOrder Sort order for dependents (by last run date, then created date) (default to descending)
+	 * getUsersRuleDependents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getUsersRuleDependents(ruleId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'ruleId' is set
+		if (ruleId === undefined || ruleId === null || ruleId === '') {
+			throw 'Missing the required parameter "ruleId" when calling getUsersRuleDependents';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/rules/{ruleId}/dependents', 
+			'GET', 
+			{ 'ruleId': ruleId },
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get the list of users rules
+	 * 
+	 * @param {Array.<String>} types The types of the rule
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 * @param {Number} opts.pageSize Number of results per page (default to 25)
+	 * @param {Array.<String>} opts.expand Fields to expand in response
+	 * @param {String} opts.searchTerm a search term for finding a rule by name
+	 * @param {Object} opts.sortOrder sort rules by name, ascending, descending (default to ascending)
+	 * getUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getUsersRules(types, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'types' is set
+		if (types === undefined || types === null) {
+			throw 'Missing the required parameter "types" when calling getUsersRules';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/rules', 
+			'GET', 
+			{  },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'types': this.apiClient.buildCollectionParam(types, 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'searchTerm': opts['searchTerm'],'sortOrder': opts['sortOrder'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get the settings for a specific users rule type
+	 * 
+	 * @param {Object} ruleType The type of the rule
+	 * getUsersRulesSetting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getUsersRulesSetting(ruleType) { 
+		// verify the required parameter 'ruleType' is set
+		if (ruleType === undefined || ruleType === null || ruleType === '') {
+			throw 'Missing the required parameter "ruleType" when calling getUsersRulesSetting';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/rules/settings/{ruleType}', 
+			'GET', 
+			{ 'ruleType': ruleType },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update an existing users rule
+	 * This will update an existing users rule with the specified fields.
+	 * @param {String} ruleId The ID of the rule to update
+	 * @param {Object} body updateRuleRequest
+	 * patchUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	patchUsersRule(ruleId, body) { 
+		// verify the required parameter 'ruleId' is set
+		if (ruleId === undefined || ruleId === null || ruleId === '') {
+			throw 'Missing the required parameter "ruleId" when calling patchUsersRule';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchUsersRule';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/rules/{ruleId}', 
+			'PATCH', 
+			{ 'ruleId': ruleId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Create a new rule
+	 * This will create a new rule with the specified fields.
+	 * @param {Object} body usersRulesCreateRuleRequest
+	 * postUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postUsersRules(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postUsersRules';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/rules', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Query the result of a users rule
+	 * This will query the result of a rule.
+	 * @param {Object} body usersRulesQueryRuleRequest
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 * @param {Number} opts.pageSize Number of results per page (default to 25)
+	 * postUsersRulesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postUsersRulesQuery(body, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postUsersRulesQuery';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/users/rules/query', 
+			'POST', 
+			{  },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+}
+
+
+export default UsersRulesApi;

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class WorkforceManagementApi {
 	/**
 	 * WorkforceManagement service.
 	 * @module purecloud-platform-client-v2/api/WorkforceManagementApi
-	 * @version 236.0.0
+	 * @version 237.0.0
 	 */
 
 	/**
@@ -769,6 +769,31 @@ class WorkforceManagementApi {
 		);
 	}
 
+	/**
+	 * Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status
+	 * Job details are only retained if the initial request returned a 202 ACCEPTED response
+	 * @param {String} jobId ID of the job to get
+	 */
+	getWorkforcemanagementAgentsMeAdherenceHistoricalJob(jobId) { 
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null || jobId === '') {
+			throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAgentsMeAdherenceHistoricalJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/agents/me/adherence/historical/jobs/{jobId}', 
+			'GET', 
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get the management unit to which the currently logged in agent belongs
 	 * 
@@ -5117,6 +5142,31 @@ class WorkforceManagementApi {
 		);
 	}
 
+	/**
+	 * Request an agent historical adherence report
+	 * The maximum supported range for historical adherence queries is 31 days, or 7 days when the expand query parameter includes any of the following: exceptionInfo, actuals, scheduledActivities
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<String>} opts.expand Which fields, if any, to expand with. wfm:AgentHistoricalAdherenceConformance:view permission is required for conformance, and wfm:agentSchedule:view permission is required for scheduledActivities.
+	 * @param {Object} opts.body body
+	 */
+	postWorkforcemanagementAgentsMeAdherenceHistoricalJobs(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/workforcemanagement/agents/me/adherence/historical/jobs', 
+			'POST', 
+			{  },
+			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get agent possible work shifts for requested time frame
 	 * 

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

@@ -79,6 +79,7 @@ import UploadsApi from './api/UploadsApi.js';
 import UsageApi from './api/UsageApi.js';
 import UserRecordingsApi from './api/UserRecordingsApi.js';
 import UsersApi from './api/UsersApi.js';
+import UsersRulesApi from './api/UsersRulesApi.js';
 import UtilitiesApi from './api/UtilitiesApi.js';
 import VoicemailApi from './api/VoicemailApi.js';
 import WebChatApi from './api/WebChatApi.js';
@@ -118,7 +119,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
  * </pre>
  * </p>
  * @module purecloud-platform-client-v2/index
- * @version 236.0.0
+ * @version 237.0.0
  */
 class platformClient {
 	constructor() {
@@ -507,6 +508,11 @@ class platformClient {
 		 * @property {module:purecloud-platform-client-v2/api/UsersApi}
 		 */
 		this.UsersApi = UsersApi;
+		/**
+		 * The UsersRulesApi service constructor.
+		 * @property {module:purecloud-platform-client-v2/api/UsersRulesApi}
+		 */
+		this.UsersRulesApi = UsersRulesApi;
 		/**
 		 * The UtilitiesApi service constructor.
 		 * @property {module:purecloud-platform-client-v2/api/UtilitiesApi}