purecloud-platform-client-v2 169.0.0 → 170.0.0

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 169.0.0
+	 * @version 170.0.0
 	 */
 
 	/**
@@ -1772,6 +1772,87 @@ class ArchitectApi {
 		);
 	}
 
+	/**
+	 * Start a process (job) to prepare a download of a singular flow execution data instance by Id
+	 * Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
+	 * @param {String} instanceId Instance ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.expand Expand various details.
+	 * getFlowsInstance is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getFlowsInstance(instanceId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'instanceId' is set
+		if (instanceId === undefined || instanceId === null) {
+			throw 'Missing the required parameter "instanceId" when calling getFlowsInstance';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/flows/instances/{instanceId}', 
+			'GET', 
+			{ 'instanceId': instanceId },
+			{ 'expand': opts['expand'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get the status and/or results of an asynchronous flow execution data retrieval job
+	 * 
+	 * @param {String} jobId The asynchronous job ID
+	 * getFlowsInstancesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getFlowsInstancesJob(jobId) { 
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getFlowsInstancesJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/flows/instances/jobs/{jobId}', 
+			'GET', 
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Retrieve a list of capabilities that the org can use to query for execution data
+	 * Returns the queryable parameters that can be used to build a query for execution data.
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.expand Expand various query types.
+	 * getFlowsInstancesQuerycapabilities is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getFlowsInstancesQuerycapabilities(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/flows/instances/querycapabilities', 
+			'GET', 
+			{  },
+			{ 'expand': opts['expand'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Fetch Architect Job Status
 	 * 
@@ -2603,6 +2684,66 @@ class ArchitectApi {
 		);
 	}
 
+	/**
+	 * Start a process (job) that will prepare a list of execution data IDs for download.
+	 * Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
+	 * @param {Object} body Requested Flow Ids
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.expand Expand various query types.
+	 * postFlowsInstancesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postFlowsInstancesJobs(body, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postFlowsInstancesJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/flows/instances/jobs', 
+			'POST', 
+			{  },
+			{ 'expand': opts['expand'] },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Query the database of existing flow histories to look for particular flow criteria
+	 * Returns a list of matching flow histories up to 200 max.
+	 * @param {Object} body query
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.indexOnly indexes only
+	 * postFlowsInstancesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postFlowsInstancesQuery(body, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postFlowsInstancesQuery';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/flows/instances/query', 
+			'POST', 
+			{  },
+			{ 'indexOnly': opts['indexOnly'] },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.
 	 * 

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 169.0.0
+	 * @version 170.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 169.0.0
+	 * @version 170.0.0
 	 */
 
 	/**
@@ -246,7 +246,7 @@ class AuthorizationApi {
 	 * @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.name Search term to filter by division name
-     	 * @deprecated
+	 * @deprecated
 	 */
 	getAuthorizationDivisionspermittedMe(permission, opts) { 
 		opts = opts || {};
@@ -308,7 +308,7 @@ class AuthorizationApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Number} opts.pageSize Page size (default to 25)
-     	 * @deprecated
+	 * @deprecated
 	 */
 	getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) { 
 		opts = opts || {};

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 169.0.0
+	 * @version 170.0.0
 	 */
 
 	/**

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 169.0.0
+	 * @version 170.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 169.0.0
+	 * @version 170.0.0
 	 */
 
 	/**
@@ -23,7 +23,7 @@ class ChatApi {
 	/**
 	 * Get Chat Settings.
 	 * This route is deprecated, please use /chats/settings instead
-     	 * @deprecated
+	 * @deprecated
 	 */
 	getChatSettings() { 
 
@@ -65,7 +65,7 @@ class ChatApi {
 	 * Patch Chat Settings.
 	 * This route is deprecated, please use /chats/settings instead
 	 * @param {Object} body Chat
-     	 * @deprecated
+	 * @deprecated
 	 */
 	patchChatSettings(body) { 
 		// verify the required parameter 'body' is set
@@ -116,7 +116,7 @@ class ChatApi {
 	 * Update Chat Settings.
 	 * This route is deprecated, please use /chats/settings instead
 	 * @param {Object} body Chat
-     	 * @deprecated
+	 * @deprecated
 	 */
 	putChatSettings(body) { 
 		// verify the required parameter 'body' is set

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 169.0.0
+	 * @version 170.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 169.0.0
+	 * @version 170.0.0
 	 */
 
 	/**
@@ -219,7 +219,7 @@ class ContentManagementApi {
 
 	/**
 	 * Get a list of audits for a document.
-	 * 
+	 * This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
 	 * @param {String} documentId Document ID
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageSize Page size (default to 25)
@@ -228,6 +228,7 @@ class ContentManagementApi {
 	 * @param {String} opts.level level (default to USER)
 	 * @param {String} opts.sortBy Sort by
 	 * @param {String} opts.sortOrder Sort order (default to ascending)
+	 * @deprecated
 	 */
 	getContentmanagementDocumentAudits(documentId, opts) { 
 		opts = opts || {};
@@ -292,7 +293,7 @@ class ContentManagementApi {
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {String} opts.sortBy name or dateCreated
 	 * @param {String} opts.sortOrder ascending or descending (default to ascending)
-     	 * @deprecated
+	 * @deprecated
 	 */
 	getContentmanagementDocuments(workspaceId, opts) { 
 		opts = opts || {};
@@ -774,8 +775,9 @@ class ContentManagementApi {
 
 	/**
 	 * Query audits
-	 * 
+	 * This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
 	 * @param {Object} body Allows for a filtered query returning facet information
+	 * @deprecated
 	 */
 	postContentmanagementAuditquery(body) { 
 		// verify the required parameter 'body' is set