purecloud-platform-client-v2 207.0.0 → 208.0.0

package/package.json

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

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

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 207.0.0
+	 * @version 208.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 207.0.0
+	 * @version 208.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 207.0.0
+	 * @version 208.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 207.0.0
+	 * @version 208.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 207.0.0
+	 * @version 208.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 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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 207.0.0
+	 * @version 208.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 207.0.0
+	 * @version 208.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 207.0.0
+	 * @version 208.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 207.0.0
+	 * @version 208.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 207.0.0
+	 * @version 208.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 207.0.0
+	 * @version 208.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 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ConversationsApi {
 	/**
 	 * Conversations service.
 	 * @module purecloud-platform-client-v2/api/ConversationsApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class DataExtensionsApi {
 	/**
 	 * DataExtensions service.
 	 * @module purecloud-platform-client-v2/api/DataExtensionsApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class DownloadsApi {
 	/**
 	 * Downloads service.
 	 * @module purecloud-platform-client-v2/api/DownloadsApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class EmailsApi {
 	/**
 	 * Emails service.
 	 * @module purecloud-platform-client-v2/api/EmailsApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class EmployeeEngagementApi {
 	/**
 	 * EmployeeEngagement service.
 	 * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class EventsApi {
 	/**
 	 * Events service.
 	 * @module purecloud-platform-client-v2/api/EventsApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ExternalContactsApi {
 	/**
 	 * ExternalContacts service.
 	 * @module purecloud-platform-client-v2/api/ExternalContactsApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**
@@ -104,7 +104,6 @@ class ExternalContactsApi {
 	 * Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
 	 * 
 	 * @param {String} externalSourceId External Source ID
-	 * deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	deleteExternalcontactsExternalsource(externalSourceId) { 
 		// verify the required parameter 'externalSourceId' is set
@@ -412,7 +411,7 @@ class ExternalContactsApi {
 	 * 
 	 * @param {String} contactId ExternalContact ID
 	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
+	 * @param {Array.<String>} opts.expand which fields, if any, to expand
 	 */
 	getExternalcontactsContactUnresolved(contactId, opts) { 
 		opts = opts || {};
@@ -568,7 +567,6 @@ class ExternalContactsApi {
 	 * Fetch an External Source
 	 * 
 	 * @param {String} externalSourceId External Source ID
-	 * getExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getExternalcontactsExternalsource(externalSourceId) { 
 		// verify the required parameter 'externalSourceId' is set
@@ -598,7 +596,6 @@ class ExternalContactsApi {
 	 * @param {Number} opts.limit The number of ExternalSources per page; must be between 10 and 200, default is 100
 	 * @param {String} opts.name Filter by external source name. Filtering is prefix filtering and not an exact match
 	 * @param {Boolean} opts.active Filter by active status of external source
-	 * getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getExternalcontactsExternalsources(opts) { 
 		opts = opts || {};
@@ -724,7 +721,7 @@ class ExternalContactsApi {
 	 * 
 	 * @param {String} externalOrganizationId External Organization ID
 	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand which fields, if any, to expand (externalDataSources)
+	 * @param {Array.<String>} opts.expand which fields, if any, to expand
 	 * @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
 	 */
 	getExternalcontactsOrganization(externalOrganizationId, opts) { 
@@ -1732,7 +1729,6 @@ class ExternalContactsApi {
 	 * Create an External Source
 	 * 
 	 * @param {Object} body External Source
-	 * postExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postExternalcontactsExternalsources(body) { 
 		// verify the required parameter 'body' is set
@@ -2118,7 +2114,6 @@ class ExternalContactsApi {
 	 * 
 	 * @param {String} externalSourceId External Source ID
 	 * @param {Object} body External Source
-	 * putExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	putExternalcontactsExternalsource(externalSourceId, body) { 
 		// verify the required parameter 'externalSourceId' is set

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

@@ -5,7 +5,7 @@ class FaxApi {
 	/**
 	 * Fax service.
 	 * @module purecloud-platform-client-v2/api/FaxApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class FlowsApi {
 	/**
 	 * Flows service.
 	 * @module purecloud-platform-client-v2/api/FlowsApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi {
 	/**
 	 * GeneralDataProtectionRegulation service.
 	 * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GeolocationApi {
 	/**
 	 * Geolocation service.
 	 * @module purecloud-platform-client-v2/api/GeolocationApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GreetingsApi {
 	/**
 	 * Greetings service.
 	 * @module purecloud-platform-client-v2/api/GreetingsApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GroupsApi {
 	/**
 	 * Groups service.
 	 * @module purecloud-platform-client-v2/api/GroupsApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class IdentityProviderApi {
 	/**
 	 * IdentityProvider service.
 	 * @module purecloud-platform-client-v2/api/IdentityProviderApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class InfrastructureAsCodeApi {
 	/**
 	 * InfrastructureAsCode service.
 	 * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**
@@ -299,8 +299,12 @@ class IntegrationsApi {
 	 * 
 	 * @param {String} actionId actionId
 	 * @param {String} fileName Name of schema file to be retrieved for this draft.
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
 	 */
-	getIntegrationsActionDraftSchema(actionId, fileName) { 
+	getIntegrationsActionDraftSchema(actionId, fileName, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'actionId' is set
 		if (actionId === undefined || actionId === null) {
 			throw 'Missing the required parameter "actionId" when calling getIntegrationsActionDraftSchema';
@@ -314,7 +318,7 @@ class IntegrationsApi {
 			'/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}', 
 			'GET', 
 			{ 'actionId': actionId,'fileName': fileName },
-			{  },
+			{ 'flatten': opts['flatten'] },
 			{  },
 			{  },
 			null, 
@@ -410,8 +414,12 @@ class IntegrationsApi {
 	 * 
 	 * @param {String} actionId actionId
 	 * @param {String} fileName Name of schema file to be retrieved for this action.
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
 	 */
-	getIntegrationsActionSchema(actionId, fileName) { 
+	getIntegrationsActionSchema(actionId, fileName, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'actionId' is set
 		if (actionId === undefined || actionId === null) {
 			throw 'Missing the required parameter "actionId" when calling getIntegrationsActionSchema';
@@ -425,7 +433,7 @@ class IntegrationsApi {
 			'/api/v2/integrations/actions/{actionId}/schemas/{fileName}', 
 			'GET', 
 			{ 'actionId': actionId,'fileName': fileName },
-			{  },
+			{ 'flatten': opts['flatten'] },
 			{  },
 			{  },
 			null, 
@@ -1962,8 +1970,12 @@ class IntegrationsApi {
 	 * 
 	 * @param {String} actionId actionId
 	 * @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
 	 */
-	postIntegrationsActionDraftTest(actionId, body) { 
+	postIntegrationsActionDraftTest(actionId, body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'actionId' is set
 		if (actionId === undefined || actionId === null) {
 			throw 'Missing the required parameter "actionId" when calling postIntegrationsActionDraftTest';
@@ -1977,7 +1989,7 @@ class IntegrationsApi {
 			'/api/v2/integrations/actions/{actionId}/draft/test', 
 			'POST', 
 			{ 'actionId': actionId },
-			{  },
+			{ 'flatten': opts['flatten'] },
 			{  },
 			{  },
 			body, 
@@ -1992,8 +2004,12 @@ class IntegrationsApi {
 	 * 
 	 * @param {String} actionId actionId
 	 * @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
 	 */
-	postIntegrationsActionExecute(actionId, body) { 
+	postIntegrationsActionExecute(actionId, body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'actionId' is set
 		if (actionId === undefined || actionId === null) {
 			throw 'Missing the required parameter "actionId" when calling postIntegrationsActionExecute';
@@ -2007,7 +2023,7 @@ class IntegrationsApi {
 			'/api/v2/integrations/actions/{actionId}/execute', 
 			'POST', 
 			{ 'actionId': actionId },
-			{  },
+			{ 'flatten': opts['flatten'] },
 			{  },
 			{  },
 			body, 
@@ -2022,8 +2038,12 @@ class IntegrationsApi {
 	 * 
 	 * @param {String} actionId actionId
 	 * @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
 	 */
-	postIntegrationsActionTest(actionId, body) { 
+	postIntegrationsActionTest(actionId, body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'actionId' is set
 		if (actionId === undefined || actionId === null) {
 			throw 'Missing the required parameter "actionId" when calling postIntegrationsActionTest';
@@ -2037,7 +2057,7 @@ class IntegrationsApi {
 			'/api/v2/integrations/actions/{actionId}/test', 
 			'POST', 
 			{ 'actionId': actionId },
-			{  },
+			{ 'flatten': opts['flatten'] },
 			{  },
 			{  },
 			body, 

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

@@ -5,7 +5,7 @@ class JourneyApi {
 	/**
 	 * Journey service.
 	 * @module purecloud-platform-client-v2/api/JourneyApi
-	 * @version 207.0.0
+	 * @version 208.0.0
 	 */
 
 	/**
@@ -174,6 +174,31 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Delete the Schedule of a JourneyView
+	 * used for long descriptions
+	 * @param {String} viewId Journey View Id
+	 */
+	deleteJourneyViewSchedules(viewId) { 
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling deleteJourneyViewSchedules';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/schedules', 
+			'DELETE', 
+			{ 'viewId': viewId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get status for async query for journey aggregates
 	 * 
@@ -822,6 +847,31 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Get the Schedule for a JourneyView
+	 * used for long descriptions
+	 * @param {String} viewId Journey View Id
+	 */
+	getJourneyViewSchedules(viewId) { 
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling getJourneyViewSchedules';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/schedules', 
+			'GET', 
+			{ 'viewId': viewId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a Journey View by ID and version
 	 * 
@@ -1167,6 +1217,31 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Get the journey schedules for an organization.
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageNumber The number of the page to return (default to 1)
+	 * @param {Number} opts.pageSize Max number of entities to return (default to 25)
+	 */
+	getJourneyViewsSchedules(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/schedules', 
+			'GET', 
+			{  },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update single action map.
 	 * 
@@ -1685,6 +1760,36 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Add a new Schedule to a JourneyView
+	 * 
+	 * @param {String} viewId Journey View Id
+	 * @param {Object} body journeyViewSchedule
+	 */
+	postJourneyViewSchedules(viewId, body) { 
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling postJourneyViewSchedules';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postJourneyViewSchedules';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/schedules', 
+			'POST', 
+			{ 'viewId': viewId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Submit a job request for a journey view version.
 	 * used for long descriptions
@@ -1794,6 +1899,36 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Update the Schedule for a JourneyView
+	 * used for long descriptions
+	 * @param {String} viewId Journey View Id
+	 * @param {Object} body journeyViewSchedule
+	 */
+	putJourneyViewSchedules(viewId, body) { 
+		// verify the required parameter 'viewId' is set
+		if (viewId === undefined || viewId === null) {
+			throw 'Missing the required parameter "viewId" when calling putJourneyViewSchedules';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putJourneyViewSchedules';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/views/{viewId}/schedules', 
+			'PUT', 
+			{ 'viewId': viewId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update a Journey View by ID and version
 	 * does not create a new version