purecloud-platform-client-v2 202.1.0 → 204.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "202.1.0",
+  "version": "204.0.0",
   "description": "A JavaScript library to interface with the PureCloud Platform API",
   "license": "MIT",
   "main": "dist/node/purecloud-platform-client-v2.js",
@@ -30,7 +30,7 @@
     "url": "https://developer.mypurecloud.com"
   },
   "dependencies": {
-    "axios": "^1.6.5",
+    "axios": "^1.7.4",
     "configparser": "^0.3.9",
     "qs": "^6.10.3",
     "winston": "^3.6.0"

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

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

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

@@ -0,0 +1,381 @@
+import ApiClient from '../ApiClient.js';
+
+
+class AgentAssistantsApi {
+	/**
+	 * AgentAssistants service.
+	 * @module purecloud-platform-client-v2/api/AgentAssistantsApi
+	 * @version 204.0.0
+	 */
+
+	/**
+	 * Constructs a new AgentAssistantsApi. 
+	 * @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
+	 * @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 assistant.
+	 * 
+	 * @param {String} assistantId Assistant ID
+	 */
+	deleteAssistant(assistantId) { 
+		// verify the required parameter 'assistantId' is set
+		if (assistantId === undefined || assistantId === null) {
+			throw 'Missing the required parameter "assistantId" when calling deleteAssistant';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/{assistantId}', 
+			'DELETE', 
+			{ 'assistantId': assistantId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Disassociate a queue from an assistant.
+	 * 
+	 * @param {String} assistantId Assistant ID
+	 * @param {String} queueId Queue ID
+	 */
+	deleteAssistantQueue(assistantId, queueId) { 
+		// verify the required parameter 'assistantId' is set
+		if (assistantId === undefined || assistantId === null) {
+			throw 'Missing the required parameter "assistantId" when calling deleteAssistantQueue';
+		}
+		// verify the required parameter 'queueId' is set
+		if (queueId === undefined || queueId === null) {
+			throw 'Missing the required parameter "queueId" when calling deleteAssistantQueue';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/{assistantId}/queues/{queueId}', 
+			'DELETE', 
+			{ 'assistantId': assistantId,'queueId': queueId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Disassociate the queues from an assistant for the given assistant ID and queue IDs.
+	 * 
+	 * @param {String} assistantId Assistant ID
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.queueIds Comma-separated identifiers of the queues that need to be deleted.
+	 */
+	deleteAssistantQueues(assistantId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'assistantId' is set
+		if (assistantId === undefined || assistantId === null) {
+			throw 'Missing the required parameter "assistantId" when calling deleteAssistantQueues';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/{assistantId}/queues', 
+			'DELETE', 
+			{ 'assistantId': assistantId },
+			{ 'queueIds': opts['queueIds'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get an assistant.
+	 * 
+	 * @param {String} assistantId Assistant ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.expand Which fields, if any, to expand.
+	 */
+	getAssistant(assistantId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'assistantId' is set
+		if (assistantId === undefined || assistantId === null) {
+			throw 'Missing the required parameter "assistantId" when calling getAssistant';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/{assistantId}', 
+			'GET', 
+			{ 'assistantId': assistantId },
+			{ 'expand': opts['expand'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get queue Information for an assistant.
+	 * 
+	 * @param {String} assistantId Assistant ID
+	 * @param {String} queueId Queue ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.expand Which fields, if any, to expand.
+	 */
+	getAssistantQueue(assistantId, queueId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'assistantId' is set
+		if (assistantId === undefined || assistantId === null) {
+			throw 'Missing the required parameter "assistantId" when calling getAssistantQueue';
+		}
+		// verify the required parameter 'queueId' is set
+		if (queueId === undefined || queueId === null) {
+			throw 'Missing the required parameter "queueId" when calling getAssistantQueue';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/{assistantId}/queues/{queueId}', 
+			'GET', 
+			{ 'assistantId': assistantId,'queueId': queueId },
+			{ 'expand': opts['expand'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get all the queues associated with an assistant.
+	 * 
+	 * @param {String} assistantId Assistant ID
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
+	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
+	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
+	 * @param {Object} opts.expand Which fields, if any, to expand.
+	 */
+	getAssistantQueues(assistantId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'assistantId' is set
+		if (assistantId === undefined || assistantId === null) {
+			throw 'Missing the required parameter "assistantId" when calling getAssistantQueues';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/{assistantId}/queues', 
+			'GET', 
+			{ 'assistantId': assistantId },
+			{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': opts['expand'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get all assistants.
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
+	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
+	 * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
+	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
+	 * @param {String} opts.name Return the assistant by the given name.
+	 */
+	getAssistants(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants', 
+			'GET', 
+			{  },
+			{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get all queues assigned to any assistant.
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
+	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
+	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
+	 * @param {String} opts.queueIds Comma-separated identifiers of the queues that need to be retrieved.
+	 * @param {Object} opts.expand Which fields, if any, to expand.
+	 */
+	getAssistantsQueues(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/queues', 
+			'GET', 
+			{  },
+			{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'queueIds': opts['queueIds'],'expand': opts['expand'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update an assistant.
+	 * 
+	 * @param {String} assistantId Assistant ID
+	 * @param {Object} body 
+	 */
+	patchAssistant(assistantId, body) { 
+		// verify the required parameter 'assistantId' is set
+		if (assistantId === undefined || assistantId === null) {
+			throw 'Missing the required parameter "assistantId" when calling patchAssistant';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchAssistant';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/{assistantId}', 
+			'PATCH', 
+			{ 'assistantId': assistantId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update Queues for an Assistant.
+	 * 
+	 * @param {String} assistantId Assistant ID
+	 * @param {Array.<Object>} body 
+	 */
+	patchAssistantQueues(assistantId, body) { 
+		// verify the required parameter 'assistantId' is set
+		if (assistantId === undefined || assistantId === null) {
+			throw 'Missing the required parameter "assistantId" when calling patchAssistantQueues';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchAssistantQueues';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/{assistantId}/queues', 
+			'PATCH', 
+			{ 'assistantId': assistantId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Create an Assistant.
+	 * 
+	 * @param {Object} body 
+	 */
+	postAssistants(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAssistants';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Create a queue assistant association.
+	 * 
+	 * @param {String} assistantId Assistant ID
+	 * @param {String} queueId Queue ID
+	 * @param {Object} body 
+	 */
+	putAssistantQueue(assistantId, queueId, body) { 
+		// verify the required parameter 'assistantId' is set
+		if (assistantId === undefined || assistantId === null) {
+			throw 'Missing the required parameter "assistantId" when calling putAssistantQueue';
+		}
+		// verify the required parameter 'queueId' is set
+		if (queueId === undefined || queueId === null) {
+			throw 'Missing the required parameter "queueId" when calling putAssistantQueue';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putAssistantQueue';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/{assistantId}/queues/{queueId}', 
+			'PUT', 
+			{ 'assistantId': assistantId,'queueId': queueId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+}
+
+
+export default AgentAssistantsApi;

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

@@ -0,0 +1,81 @@
+import ApiClient from '../ApiClient.js';
+
+
+class AgentCopilotApi {
+	/**
+	 * AgentCopilot service.
+	 * @module purecloud-platform-client-v2/api/AgentCopilotApi
+	 * @version 204.0.0
+	 */
+
+	/**
+	 * Constructs a new AgentCopilotApi. 
+	 * @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
+	 * @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;
+	}
+
+
+	/**
+	 * Get copilot configuration of an assistant.
+	 * 
+	 * @param {String} assistantId Assistant ID
+	 */
+	getAssistantCopilot(assistantId) { 
+		// verify the required parameter 'assistantId' is set
+		if (assistantId === undefined || assistantId === null) {
+			throw 'Missing the required parameter "assistantId" when calling getAssistantCopilot';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/{assistantId}/copilot', 
+			'GET', 
+			{ 'assistantId': assistantId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update agent copilot configuration
+	 * 
+	 * @param {String} assistantId Assistant ID
+	 * @param {Object} body 
+	 */
+	putAssistantCopilot(assistantId, body) { 
+		// verify the required parameter 'assistantId' is set
+		if (assistantId === undefined || assistantId === null) {
+			throw 'Missing the required parameter "assistantId" when calling putAssistantCopilot';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putAssistantCopilot';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/assistants/{assistantId}/copilot', 
+			'PUT', 
+			{ 'assistantId': assistantId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+}
+
+
+export default AgentCopilotApi;

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 202.1.0
+	 * @version 204.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 202.1.0
+	 * @version 204.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 202.1.0
+	 * @version 204.0.0
 	 */
 
 	/**
@@ -946,6 +946,7 @@ class AnalyticsApi {
 	 * @param {Object} dashboardType List dashboard of given type
 	 * @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard
 	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.name name of the dashboard
 	 * @param {String} opts.sortBy  (default to desc)
 	 * @param {Number} opts.pageNumber  (default to 1)
 	 * @param {Number} opts.pageSize  (default to 9)
@@ -966,7 +967,7 @@ class AnalyticsApi {
 			'/api/v2/analytics/reporting/settings/dashboards/query', 
 			'GET', 
 			{  },
-			{ 'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
+			{ 'name': opts['name'],'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
 			{  },
 			{  },
 			null, 
@@ -1471,7 +1472,6 @@ class AnalyticsApi {
 	 * Query for agent copilot aggregates
 	 * 
 	 * @param {Object} body query
-	 * postAnalyticsAgentcopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postAnalyticsAgentcopilotsAggregatesQuery(body) { 
 		// verify the required parameter 'body' is set

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 202.1.0
+	 * @version 204.0.0
 	 */
 
 	/**
@@ -412,7 +412,6 @@ class ArchitectApi {
 	 * Deletes a log level for a flow by flow id.
 	 * Deletes the associated log level for a flow by flow id
 	 * @param {String} flowId The flow id to delete the loglevel for
-	 * deleteFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	deleteFlowInstancesSettingsLoglevels(flowId) { 
 		// verify the required parameter 'flowId' is set
@@ -521,7 +520,6 @@ class ArchitectApi {
 	/**
 	 * Resets the org log level to default, base
 	 * Resets the org log level to default, base
-	 * deleteFlowsInstancesSettingsLoglevelsDefault is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	deleteFlowsInstancesSettingsLoglevelsDefault() { 
 
@@ -1672,7 +1670,6 @@ class ArchitectApi {
 	 * @param {String} flowId The flow id to get the loglevel for
 	 * @param {Object} opts Optional parameters
 	 * @param {Array.<String>} opts.expand Expand instructions for the result
-	 * getFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getFlowInstancesSettingsLoglevels(flowId, opts) { 
 		opts = opts || {};
@@ -2400,7 +2397,6 @@ class ArchitectApi {
 	/**
 	 * Get the execution history enabled setting.
 	 * Get the execution history enabled setting.
-	 * getFlowsInstancesSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getFlowsInstancesSettingsExecutiondata() { 
 
@@ -2425,7 +2421,6 @@ class ArchitectApi {
 	 * @param {Array.<String>} opts.expand Expand instructions for the result
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
-	 * getFlowsInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getFlowsInstancesSettingsLoglevels(opts) { 
 		opts = opts || {};
@@ -2448,7 +2443,6 @@ class ArchitectApi {
 	/**
 	 * Gets the available flow log level characteristics for this organization.
 	 * Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled.
-	 * getFlowsInstancesSettingsLoglevelsCharacteristics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getFlowsInstancesSettingsLoglevelsCharacteristics() { 
 
@@ -2471,7 +2465,6 @@ class ArchitectApi {
 	 * Returns the flow default log level which will be used if no specific flow id log level is found.
 	 * @param {Object} opts Optional parameters
 	 * @param {Array.<String>} opts.expand Expand instructions for the result
-	 * getFlowsInstancesSettingsLoglevelsDefault is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getFlowsInstancesSettingsLoglevelsDefault(opts) { 
 		opts = opts || {};
@@ -2763,7 +2756,6 @@ class ArchitectApi {
 	 * Edit the execution history enabled setting.
 	 * Edit the execution history enabled setting.
 	 * @param {Object} body New Execution Data Setting
-	 * patchFlowsInstancesSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	patchFlowsInstancesSettingsExecutiondata(body) { 
 		// verify the required parameter 'body' is set
@@ -3201,7 +3193,6 @@ class ArchitectApi {
 	 * @param {Object} body New LogLevel settings
 	 * @param {Object} opts Optional parameters
 	 * @param {Array.<String>} opts.expand Expand instructions for the result
-	 * postFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postFlowInstancesSettingsLoglevels(flowId, body, opts) { 
 		opts = opts || {};
@@ -3961,7 +3952,6 @@ class ArchitectApi {
 	 * @param {Object} body New LogLevel settings
 	 * @param {Object} opts Optional parameters
 	 * @param {Array.<String>} opts.expand Expand instructions for the result
-	 * putFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	putFlowInstancesSettingsLoglevels(flowId, body, opts) { 
 		opts = opts || {};
@@ -4063,7 +4053,6 @@ class ArchitectApi {
 	 * @param {Object} body New LogLevel settings
 	 * @param {Object} opts Optional parameters
 	 * @param {Array.<String>} opts.expand Expand instructions for the result
-	 * putFlowsInstancesSettingsLoglevelsDefault is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	putFlowsInstancesSettingsLoglevelsDefault(body, opts) { 
 		opts = opts || {};

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 202.1.0
+	 * @version 204.0.0
 	 */
 
 	/**