purecloud-platform-client-v2 223.0.0 → 225.0.0

package/package.json

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

@@ -6,7 +6,7 @@ import { default as qs } from 'qs';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 223.0.0
+ * @version 225.0.0
  */
 class ApiClient {
 	/**

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

@@ -0,0 +1,387 @@
+import ApiClient from '../ApiClient.js';
+
+
+class AIStudioApi {
+	/**
+	 * AIStudio service.
+	 * @module purecloud-platform-client-v2/api/AIStudioApi
+	 * @version 225.0.0
+	 */
+
+	/**
+	 * Constructs a new AIStudioApi. 
+	 * @alias module:purecloud-platform-client-v2/api/AIStudioApi
+	 * @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;
+	}
+
+
+	/**
+	 * Start the deletion of a guide.
+	 * 
+	 * @param {String} guideId Guide ID
+	 * deleteGuideJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	deleteGuideJobs(guideId) { 
+		// verify the required parameter 'guideId' is set
+		if (guideId === undefined || guideId === null || guideId === '') {
+			throw 'Missing the required parameter "guideId" when calling deleteGuideJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/guides/{guideId}/jobs', 
+			'DELETE', 
+			{ 'guideId': guideId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get guide.
+	 * 
+	 * @param {String} guideId Guide ID
+	 * getGuide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getGuide(guideId) { 
+		// verify the required parameter 'guideId' is set
+		if (guideId === undefined || guideId === null || guideId === '') {
+			throw 'Missing the required parameter "guideId" when calling getGuide';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/guides/{guideId}', 
+			'GET', 
+			{ 'guideId': guideId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get the specified guide deletion job.
+	 * 
+	 * @param {String} guideId Guide ID
+	 * @param {String} jobId jobId
+	 * getGuideJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getGuideJob(guideId, jobId) { 
+		// verify the required parameter 'guideId' is set
+		if (guideId === undefined || guideId === null || guideId === '') {
+			throw 'Missing the required parameter "guideId" when calling getGuideJob';
+		}
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null || jobId === '') {
+			throw 'Missing the required parameter "jobId" when calling getGuideJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/guides/{guideId}/jobs/{jobId}', 
+			'GET', 
+			{ 'guideId': guideId,'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a guide version.
+	 * 
+	 * @param {String} guideId Guide ID
+	 * @param {String} versionId Version ID
+	 * getGuideVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getGuideVersion(guideId, versionId) { 
+		// verify the required parameter 'guideId' is set
+		if (guideId === undefined || guideId === null || guideId === '') {
+			throw 'Missing the required parameter "guideId" when calling getGuideVersion';
+		}
+		// verify the required parameter 'versionId' is set
+		if (versionId === undefined || versionId === null || versionId === '') {
+			throw 'Missing the required parameter "versionId" when calling getGuideVersion';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/guides/{guideId}/versions/{versionId}', 
+			'GET', 
+			{ 'guideId': guideId,'versionId': versionId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get the status of the publishing job for this guide version.
+	 * 
+	 * @param {String} guideId Guide ID
+	 * @param {String} versionId Version ID
+	 * @param {String} jobId jobId
+	 * getGuideVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getGuideVersionJob(guideId, versionId, jobId) { 
+		// verify the required parameter 'guideId' is set
+		if (guideId === undefined || guideId === null || guideId === '') {
+			throw 'Missing the required parameter "guideId" when calling getGuideVersionJob';
+		}
+		// verify the required parameter 'versionId' is set
+		if (versionId === undefined || versionId === null || versionId === '') {
+			throw 'Missing the required parameter "versionId" when calling getGuideVersionJob';
+		}
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null || jobId === '') {
+			throw 'Missing the required parameter "jobId" when calling getGuideVersionJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/guides/{guideId}/versions/{versionId}/jobs/{jobId}', 
+			'GET', 
+			{ 'guideId': guideId,'versionId': versionId,'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get all guides.
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.name Filter by matching name - case insensitive.
+	 * @param {String} opts.nameContains Filter by name contains - case insensitive.
+	 * @param {Object} opts.status Filter by status.
+	 * @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
+	 * @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
+	 * @param {Number} opts.pageNumber Page number. (default to 1)
+	 * @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
+	 * getGuides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getGuides(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/guides', 
+			'GET', 
+			{  },
+			{ 'name': opts['name'],'nameContains': opts['nameContains'],'status': opts['status'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get the status of the guide content generation job.
+	 * 
+	 * @param {String} jobId jobId
+	 * getGuidesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getGuidesJob(jobId) { 
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null || jobId === '') {
+			throw 'Missing the required parameter "jobId" when calling getGuidesJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/guides/jobs/{jobId}', 
+			'GET', 
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update a guide version.
+	 * 
+	 * @param {String} guideId Guide ID
+	 * @param {String} versionId Version ID
+	 * @param {Object} body 
+	 * patchGuideVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	patchGuideVersion(guideId, versionId, body) { 
+		// verify the required parameter 'guideId' is set
+		if (guideId === undefined || guideId === null || guideId === '') {
+			throw 'Missing the required parameter "guideId" when calling patchGuideVersion';
+		}
+		// verify the required parameter 'versionId' is set
+		if (versionId === undefined || versionId === null || versionId === '') {
+			throw 'Missing the required parameter "versionId" when calling patchGuideVersion';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchGuideVersion';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/guides/{guideId}/versions/{versionId}', 
+			'PATCH', 
+			{ 'guideId': guideId,'versionId': versionId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Start the publishing of a guide version.
+	 * 
+	 * @param {String} guideId Guide ID
+	 * @param {String} versionId Version ID
+	 * @param {Object} body 
+	 * postGuideVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postGuideVersionJobs(guideId, versionId, body) { 
+		// verify the required parameter 'guideId' is set
+		if (guideId === undefined || guideId === null || guideId === '') {
+			throw 'Missing the required parameter "guideId" when calling postGuideVersionJobs';
+		}
+		// verify the required parameter 'versionId' is set
+		if (versionId === undefined || versionId === null || versionId === '') {
+			throw 'Missing the required parameter "versionId" when calling postGuideVersionJobs';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postGuideVersionJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/guides/{guideId}/versions/{versionId}/jobs', 
+			'POST', 
+			{ 'guideId': guideId,'versionId': versionId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Create a guide version.
+	 * 
+	 * @param {String} guideId Guide ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body 
+	 * postGuideVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postGuideVersions(guideId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'guideId' is set
+		if (guideId === undefined || guideId === null || guideId === '') {
+			throw 'Missing the required parameter "guideId" when calling postGuideVersions';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/guides/{guideId}/versions', 
+			'POST', 
+			{ 'guideId': guideId },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Create a guide.
+	 * 
+	 * @param {Object} body 
+	 * postGuides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postGuides(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postGuides';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/guides', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Start a guide content generation job.
+	 * 
+	 * @param {Object} body 
+	 * postGuidesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postGuidesJobs(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postGuidesJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/guides/jobs', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+}
+
+
+export default AIStudioApi;

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

@@ -5,7 +5,7 @@ class AgentAssistantsApi {
 	/**
 	 * AgentAssistants service.
 	 * @module purecloud-platform-client-v2/api/AgentAssistantsApi
-	 * @version 223.0.0
+	 * @version 225.0.0
 	 */
 
 	/**
@@ -27,7 +27,7 @@ class AgentAssistantsApi {
 	 */
 	deleteAssistant(assistantId) { 
 		// verify the required parameter 'assistantId' is set
-		if (assistantId === undefined || assistantId === null) {
+		if (assistantId === undefined || assistantId === null || assistantId === '') {
 			throw 'Missing the required parameter "assistantId" when calling deleteAssistant';
 		}
 
@@ -53,11 +53,11 @@ class AgentAssistantsApi {
 	 */
 	deleteAssistantQueue(assistantId, queueId) { 
 		// verify the required parameter 'assistantId' is set
-		if (assistantId === undefined || assistantId === null) {
+		if (assistantId === undefined || assistantId === null || assistantId === '') {
 			throw 'Missing the required parameter "assistantId" when calling deleteAssistantQueue';
 		}
 		// verify the required parameter 'queueId' is set
-		if (queueId === undefined || queueId === null) {
+		if (queueId === undefined || queueId === null || queueId === '') {
 			throw 'Missing the required parameter "queueId" when calling deleteAssistantQueue';
 		}
 
@@ -86,7 +86,7 @@ class AgentAssistantsApi {
 		opts = opts || {};
 		
 		// verify the required parameter 'assistantId' is set
-		if (assistantId === undefined || assistantId === null) {
+		if (assistantId === undefined || assistantId === null || assistantId === '') {
 			throw 'Missing the required parameter "assistantId" when calling deleteAssistantQueues';
 		}
 
@@ -115,7 +115,7 @@ class AgentAssistantsApi {
 		opts = opts || {};
 		
 		// verify the required parameter 'assistantId' is set
-		if (assistantId === undefined || assistantId === null) {
+		if (assistantId === undefined || assistantId === null || assistantId === '') {
 			throw 'Missing the required parameter "assistantId" when calling getAssistant';
 		}
 
@@ -145,11 +145,11 @@ class AgentAssistantsApi {
 		opts = opts || {};
 		
 		// verify the required parameter 'assistantId' is set
-		if (assistantId === undefined || assistantId === null) {
+		if (assistantId === undefined || assistantId === null || assistantId === '') {
 			throw 'Missing the required parameter "assistantId" when calling getAssistantQueue';
 		}
 		// verify the required parameter 'queueId' is set
-		if (queueId === undefined || queueId === null) {
+		if (queueId === undefined || queueId === null || queueId === '') {
 			throw 'Missing the required parameter "queueId" when calling getAssistantQueue';
 		}
 
@@ -181,7 +181,7 @@ class AgentAssistantsApi {
 		opts = opts || {};
 		
 		// verify the required parameter 'assistantId' is set
-		if (assistantId === undefined || assistantId === null) {
+		if (assistantId === undefined || assistantId === null || assistantId === '') {
 			throw 'Missing the required parameter "assistantId" when calling getAssistantQueues';
 		}
 
@@ -264,7 +264,7 @@ class AgentAssistantsApi {
 	 */
 	patchAssistant(assistantId, body) { 
 		// verify the required parameter 'assistantId' is set
-		if (assistantId === undefined || assistantId === null) {
+		if (assistantId === undefined || assistantId === null || assistantId === '') {
 			throw 'Missing the required parameter "assistantId" when calling patchAssistant';
 		}
 		// verify the required parameter 'body' is set
@@ -294,7 +294,7 @@ class AgentAssistantsApi {
 	 */
 	patchAssistantQueues(assistantId, body) { 
 		// verify the required parameter 'assistantId' is set
-		if (assistantId === undefined || assistantId === null) {
+		if (assistantId === undefined || assistantId === null || assistantId === '') {
 			throw 'Missing the required parameter "assistantId" when calling patchAssistantQueues';
 		}
 		// verify the required parameter 'body' is set
@@ -350,11 +350,11 @@ class AgentAssistantsApi {
 	 */
 	putAssistantQueue(assistantId, queueId, body) { 
 		// verify the required parameter 'assistantId' is set
-		if (assistantId === undefined || assistantId === null) {
+		if (assistantId === undefined || assistantId === null || assistantId === '') {
 			throw 'Missing the required parameter "assistantId" when calling putAssistantQueue';
 		}
 		// verify the required parameter 'queueId' is set
-		if (queueId === undefined || queueId === null) {
+		if (queueId === undefined || queueId === null || queueId === '') {
 			throw 'Missing the required parameter "queueId" when calling putAssistantQueue';
 		}
 		// verify the required parameter 'body' is set

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

@@ -5,7 +5,7 @@ class AgentCopilotApi {
 	/**
 	 * AgentCopilot service.
 	 * @module purecloud-platform-client-v2/api/AgentCopilotApi
-	 * @version 223.0.0
+	 * @version 225.0.0
 	 */
 
 	/**
@@ -27,7 +27,7 @@ class AgentCopilotApi {
 	 */
 	getAssistantCopilot(assistantId) { 
 		// verify the required parameter 'assistantId' is set
-		if (assistantId === undefined || assistantId === null) {
+		if (assistantId === undefined || assistantId === null || assistantId === '') {
 			throw 'Missing the required parameter "assistantId" when calling getAssistantCopilot';
 		}
 
@@ -53,7 +53,7 @@ class AgentCopilotApi {
 	 */
 	putAssistantCopilot(assistantId, body) { 
 		// verify the required parameter 'assistantId' is set
-		if (assistantId === undefined || assistantId === null) {
+		if (assistantId === undefined || assistantId === null || assistantId === '') {
 			throw 'Missing the required parameter "assistantId" when calling putAssistantCopilot';
 		}
 		// verify the required parameter 'body' is set

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

@@ -5,7 +5,7 @@ class AgentUIApi {
 	/**
 	 * AgentUI service.
 	 * @module purecloud-platform-client-v2/api/AgentUIApi
-	 * @version 223.0.0
+	 * @version 225.0.0
 	 */
 
 	/**
@@ -27,7 +27,7 @@ class AgentUIApi {
 	 */
 	deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) { 
 		// verify the required parameter 'agentId' is set
-		if (agentId === undefined || agentId === null) {
+		if (agentId === undefined || agentId === null || agentId === '') {
 			throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
 		}
 
@@ -52,7 +52,7 @@ class AgentUIApi {
 	 */
 	getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) { 
 		// verify the required parameter 'agentId' is set
-		if (agentId === undefined || agentId === null) {
+		if (agentId === undefined || agentId === null || agentId === '') {
 			throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
 		}
 
@@ -78,7 +78,7 @@ class AgentUIApi {
 	 */
 	patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) { 
 		// verify the required parameter 'agentId' is set
-		if (agentId === undefined || agentId === null) {
+		if (agentId === undefined || agentId === null || agentId === '') {
 			throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
 		}
 		// verify the required parameter 'body' is set
@@ -108,7 +108,7 @@ class AgentUIApi {
 	 */
 	putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) { 
 		// verify the required parameter 'agentId' is set
-		if (agentId === undefined || agentId === null) {
+		if (agentId === undefined || agentId === null || agentId === '') {
 			throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
 		}
 		// verify the required parameter 'body' is set

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

@@ -5,7 +5,7 @@ class AlertingApi {
 	/**
 	 * Alerting service.
 	 * @module purecloud-platform-client-v2/api/AlertingApi
-	 * @version 223.0.0
+	 * @version 225.0.0
 	 */
 
 	/**
@@ -27,7 +27,7 @@ class AlertingApi {
 	 */
 	deleteAlertingAlert(alertId) { 
 		// verify the required parameter 'alertId' is set
-		if (alertId === undefined || alertId === null) {
+		if (alertId === undefined || alertId === null || alertId === '') {
 			throw 'Missing the required parameter "alertId" when calling deleteAlertingAlert';
 		}
 
@@ -72,7 +72,7 @@ class AlertingApi {
 	 */
 	deleteAlertingRule(ruleId) { 
 		// verify the required parameter 'ruleId' is set
-		if (ruleId === undefined || ruleId === null) {
+		if (ruleId === undefined || ruleId === null || ruleId === '') {
 			throw 'Missing the required parameter "ruleId" when calling deleteAlertingRule';
 		}
 
@@ -97,7 +97,7 @@ class AlertingApi {
 	 */
 	getAlertingAlert(alertId) { 
 		// verify the required parameter 'alertId' is set
-		if (alertId === undefined || alertId === null) {
+		if (alertId === undefined || alertId === null || alertId === '') {
 			throw 'Missing the required parameter "alertId" when calling getAlertingAlert';
 		}
 
@@ -122,7 +122,7 @@ class AlertingApi {
 	 */
 	getAlertingRule(ruleId) { 
 		// verify the required parameter 'ruleId' is set
-		if (ruleId === undefined || ruleId === null) {
+		if (ruleId === undefined || ruleId === null || ruleId === '') {
 			throw 'Missing the required parameter "ruleId" when calling getAlertingRule';
 		}
 
@@ -151,7 +151,7 @@ class AlertingApi {
 		opts = opts || {};
 		
 		// verify the required parameter 'alertId' is set
-		if (alertId === undefined || alertId === null) {
+		if (alertId === undefined || alertId === null || alertId === '') {
 			throw 'Missing the required parameter "alertId" when calling patchAlertingAlert';
 		}
 
@@ -352,7 +352,7 @@ class AlertingApi {
 		opts = opts || {};
 		
 		// verify the required parameter 'alertId' is set
-		if (alertId === undefined || alertId === null) {
+		if (alertId === undefined || alertId === null || alertId === '') {
 			throw 'Missing the required parameter "alertId" when calling putAlertingAlert';
 		}
 
@@ -378,7 +378,7 @@ class AlertingApi {
 	 */
 	putAlertingRule(ruleId, body) { 
 		// verify the required parameter 'ruleId' is set
-		if (ruleId === undefined || ruleId === null) {
+		if (ruleId === undefined || ruleId === null || ruleId === '') {
 			throw 'Missing the required parameter "ruleId" when calling putAlertingRule';
 		}
 		// verify the required parameter 'body' is set