purecloud-platform-client-v2 223.0.0 → 224.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "223.0.0",
+  "version": "224.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 224.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 224.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) {
+			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) {
+			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) {
+			throw 'Missing the required parameter "guideId" when calling getGuideJob';
+		}
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			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) {
+			throw 'Missing the required parameter "guideId" when calling getGuideVersion';
+		}
+		// verify the required parameter 'versionId' is set
+		if (versionId === undefined || versionId === null) {
+			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) {
+			throw 'Missing the required parameter "guideId" when calling getGuideVersionJob';
+		}
+		// verify the required parameter 'versionId' is set
+		if (versionId === undefined || versionId === null) {
+			throw 'Missing the required parameter "versionId" when calling getGuideVersionJob';
+		}
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			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) {
+			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) {
+			throw 'Missing the required parameter "guideId" when calling patchGuideVersion';
+		}
+		// verify the required parameter 'versionId' is set
+		if (versionId === undefined || versionId === null) {
+			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) {
+			throw 'Missing the required parameter "guideId" when calling postGuideVersionJobs';
+		}
+		// verify the required parameter 'versionId' is set
+		if (versionId === undefined || versionId === null) {
+			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) {
+			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 224.0.0
 	 */
 
 	/**

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 224.0.0
 	 */
 
 	/**

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 224.0.0
 	 */
 
 	/**

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 224.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class AnalyticsApi {
 	/**
 	 * Analytics service.
 	 * @module purecloud-platform-client-v2/api/AnalyticsApi
-	 * @version 223.0.0
+	 * @version 224.0.0
 	 */
 
 	/**
@@ -1578,7 +1578,7 @@ class AnalyticsApi {
 	}
 
 	/**
-	 * Count agents by segment type
+	 * Count agents by different groupings
 	 * 
 	 * @param {Object} body query
 	 */

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

@@ -5,7 +5,7 @@ class ArchitectApi {
 	/**
 	 * Architect service.
 	 * @module purecloud-platform-client-v2/api/ArchitectApi
-	 * @version 223.0.0
+	 * @version 224.0.0
 	 */
 
 	/**
@@ -891,7 +891,7 @@ class ArchitectApi {
 
 	/**
 	 * Get a pageable list of basic emergency group objects filterable by query parameters.
-	 * This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.
+	 * This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch emergency groups that match the given ID(s) and not use any additional supplied query parameters in the search.
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Number} opts.pageSize Page size (default to 25)
@@ -3049,6 +3049,7 @@ class ArchitectApi {
 	 * 
 	 * @param {String} promptId Prompt ID
 	 * @param {String} languageCode Language
+	 * postArchitectPromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postArchitectPromptResourceUploads(promptId, languageCode) { 
 		// verify the required parameter 'promptId' is set
@@ -3209,6 +3210,7 @@ class ArchitectApi {
 	 * 
 	 * @param {String} promptId Prompt ID
 	 * @param {String} languageCode Language
+	 * postArchitectSystempromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postArchitectSystempromptResourceUploads(promptId, languageCode) { 
 		// verify the required parameter 'promptId' is set

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

@@ -5,7 +5,7 @@ class AuditApi {
 	/**
 	 * Audit service.
 	 * @module purecloud-platform-client-v2/api/AuditApi
-	 * @version 223.0.0
+	 * @version 224.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class AuthorizationApi {
 	/**
 	 * Authorization service.
 	 * @module purecloud-platform-client-v2/api/AuthorizationApi
-	 * @version 223.0.0
+	 * @version 224.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class BillingApi {
 	/**
 	 * Billing service.
 	 * @module purecloud-platform-client-v2/api/BillingApi
-	 * @version 223.0.0
+	 * @version 224.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class BusinessRulesApi {
 	/**
 	 * BusinessRules service.
 	 * @module purecloud-platform-client-v2/api/BusinessRulesApi
-	 * @version 223.0.0
+	 * @version 224.0.0
 	 */
 
 	/**
@@ -339,6 +339,9 @@ class BusinessRulesApi {
 	 * @param {String} opts.pageSize Number of entities to return. Maximum of 100.
 	 * @param {String} opts.schemaId Search for decision tables that use the schema with this ID. Cannot be combined with name search. Search results will not be paginated if used.
 	 * @param {String} opts.name Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name. Cannot be combined with schema search. Search results will not be paginated if used.
+	 * @param {Boolean} opts.withPublishedVersion Filters results to only decision tables that have at least one version in Published status
+	 * @param {Array.<String>} opts.expand Fields to expand in response
+	 * @param {Array.<String>} opts.ids Decision table IDs to search for
 	 * getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getBusinessrulesDecisiontablesSearch(opts) { 
@@ -349,7 +352,7 @@ class BusinessRulesApi {
 			'/api/v2/businessrules/decisiontables/search', 
 			'GET', 
 			{  },
-			{ 'after': opts['after'],'pageSize': opts['pageSize'],'schemaId': opts['schemaId'],'name': opts['name'] },
+			{ 'after': opts['after'],'pageSize': opts['pageSize'],'schemaId': opts['schemaId'],'name': opts['name'],'withPublishedVersion': opts['withPublishedVersion'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi') },
 			{  },
 			{  },
 			null, 
@@ -521,12 +524,13 @@ class BusinessRulesApi {
 	}
 
 	/**
-	 * Update a decision table row
+	 * Partially update a decision table row. Will be deprecated, we should use PUT request.
 	 * 
 	 * @param {String} tableId Table ID
 	 * @param {Number} tableVersion Table Version
 	 * @param {String} rowId Row ID
-	 * @param {Object} body Update decision table row request
+	 * @param {Object} body Partially update decision table row request
+	 * @deprecated
 	 * patchBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	patchBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) { 
@@ -881,6 +885,47 @@ class BusinessRulesApi {
 		);
 	}
 
+	/**
+	 * Full update a decision table row
+	 * 
+	 * @param {String} tableId Table ID
+	 * @param {Number} tableVersion Table Version
+	 * @param {String} rowId Row ID
+	 * @param {Object} body Full update decision table row request
+	 * putBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	putBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) { 
+		// verify the required parameter 'tableId' is set
+		if (tableId === undefined || tableId === null) {
+			throw 'Missing the required parameter "tableId" when calling putBusinessrulesDecisiontableVersionRow';
+		}
+		// verify the required parameter 'tableVersion' is set
+		if (tableVersion === undefined || tableVersion === null) {
+			throw 'Missing the required parameter "tableVersion" when calling putBusinessrulesDecisiontableVersionRow';
+		}
+		// verify the required parameter 'rowId' is set
+		if (rowId === undefined || rowId === null) {
+			throw 'Missing the required parameter "rowId" when calling putBusinessrulesDecisiontableVersionRow';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putBusinessrulesDecisiontableVersionRow';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}', 
+			'PUT', 
+			{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update a schema
 	 * 

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

@@ -5,7 +5,7 @@ class CarrierServicesApi {
 	/**
 	 * CarrierServices service.
 	 * @module purecloud-platform-client-v2/api/CarrierServicesApi
-	 * @version 223.0.0
+	 * @version 224.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ChatApi {
 	/**
 	 * Chat service.
 	 * @module purecloud-platform-client-v2/api/ChatApi
-	 * @version 223.0.0
+	 * @version 224.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class CoachingApi {
 	/**
 	 * Coaching service.
 	 * @module purecloud-platform-client-v2/api/CoachingApi
-	 * @version 223.0.0
+	 * @version 224.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ContentManagementApi {
 	/**
 	 * ContentManagement service.
 	 * @module purecloud-platform-client-v2/api/ContentManagementApi
-	 * @version 223.0.0
+	 * @version 224.0.0
 	 */
 
 	/**