purecloud-platform-client-v2 135.0.0 → 137.0.0

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 135.0.0
+	 * @version 137.0.0
 	 */
 
 	/**
@@ -34,13 +34,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actionmaps/{actionMapId}', 
 			'DELETE', 
-			{ 'actionMapId': actionMapId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'actionMapId': actionMapId },
+			{  },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -50,7 +50,7 @@ class JourneyApi {
 	 * 
 	 * @param {String} actionTemplateId ID of the action template.
 	 * @param {Object} opts Optional parameters
-	 * @param {Boolean} opts.hardDelete Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default.
+	 * @param {Boolean} opts.hardDelete Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default.
 	 */
 	deleteJourneyActiontemplate(actionTemplateId, opts) { 
 		opts = opts || {};
@@ -63,13 +63,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actiontemplates/{actionTemplateId}', 
 			'DELETE', 
-			{ 'actionTemplateId': actionTemplateId }, 
-			{ 'hardDelete': opts['hardDelete'] }, 
-			{  }, 
-			{  }, 
+			{ 'actionTemplateId': actionTemplateId },
+			{ 'hardDelete': opts['hardDelete'] },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -88,13 +88,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/outcomes/{outcomeId}', 
 			'DELETE', 
-			{ 'outcomeId': outcomeId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'outcomeId': outcomeId },
+			{  },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -113,13 +113,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/segments/{segmentId}', 
 			'DELETE', 
-			{ 'segmentId': segmentId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'segmentId': segmentId },
+			{  },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -138,13 +138,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actionmaps/{actionMapId}', 
 			'GET', 
-			{ 'actionMapId': actionMapId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'actionMapId': actionMapId },
+			{  },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -155,12 +155,12 @@ class JourneyApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Number} opts.pageSize Page size (default to 25)
-	 * @param {String} opts.sortBy Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).
-	 * @param {String} opts.filterField Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set.
-	 * @param {String} opts.filterValue Value to filter by. Requires 'filterValue' to also be set.
+	 * @param {String} opts.sortBy Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).
+	 * @param {String} opts.filterField Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set.
+	 * @param {String} opts.filterValue Value to filter by. Requires 'filterValue' to also be set.
 	 * @param {Array.<String>} opts.actionMapIds IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.
-	 * @param {Array.<String>} opts.queryFields Action Map field(s) to query on. Requires &#39;queryValue&#39; to also be set.
-	 * @param {String} opts.queryValue Value to query on. Requires &#39;queryFields&#39; to also be set.
+	 * @param {Array.<String>} opts.queryFields Action Map field(s) to query on. Requires 'queryValue' to also be set.
+	 * @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
 	 */
 	getJourneyActionmaps(opts) { 
 		opts = opts || {};
@@ -169,13 +169,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actionmaps', 
 			'GET', 
-			{  }, 
-			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'filterField': opts['filterField'],'filterValue': opts['filterValue'],'actionMapIds': this.apiClient.buildCollectionParam(opts['actionMapIds'], 'multi'),'queryFields': this.apiClient.buildCollectionParam(opts['queryFields'], 'multi'),'queryValue': opts['queryValue'] }, 
-			{  }, 
-			{  }, 
+			{  },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'filterField': opts['filterField'],'filterValue': opts['filterValue'],'actionMapIds': this.apiClient.buildCollectionParam(opts['actionMapIds'], 'multi'),'queryFields': this.apiClient.buildCollectionParam(opts['queryFields'], 'multi'),'queryValue': opts['queryValue'] },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -194,13 +194,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actiontargets/{actionTargetId}', 
 			'GET', 
-			{ 'actionTargetId': actionTargetId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'actionTargetId': actionTargetId },
+			{  },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -219,13 +219,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actiontargets', 
 			'GET', 
-			{  }, 
-			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] }, 
-			{  }, 
-			{  }, 
+			{  },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -244,13 +244,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actiontemplates/{actionTemplateId}', 
 			'GET', 
-			{ 'actionTemplateId': actionTemplateId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'actionTemplateId': actionTemplateId },
+			{  },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -261,11 +261,11 @@ class JourneyApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Number} opts.pageSize Page size (default to 25)
-	 * @param {String} opts.sortBy Field(s) to sort by. Prefix with &#39;-&#39; for descending (e.g. sortBy=name,-createdDate).
+	 * @param {String} opts.sortBy Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate).
 	 * @param {Object} opts.mediaType Media type
 	 * @param {Object} opts.state Action template state.
-	 * @param {Array.<String>} opts.queryFields ActionTemplate field(s) to query on. Requires &#39;queryValue&#39; to also be set.
-	 * @param {String} opts.queryValue Value to query on. Requires &#39;queryFields&#39; to also be set.
+	 * @param {Array.<String>} opts.queryFields ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.
+	 * @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
 	 */
 	getJourneyActiontemplates(opts) { 
 		opts = opts || {};
@@ -274,13 +274,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actiontemplates', 
 			'GET', 
-			{  }, 
-			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'mediaType': opts['mediaType'],'state': opts['state'],'queryFields': this.apiClient.buildCollectionParam(opts['queryFields'], 'multi'),'queryValue': opts['queryValue'] }, 
-			{  }, 
-			{  }, 
+			{  },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'mediaType': opts['mediaType'],'state': opts['state'],'queryFields': this.apiClient.buildCollectionParam(opts['queryFields'], 'multi'),'queryValue': opts['queryValue'] },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -299,13 +299,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/outcomes/{outcomeId}', 
 			'GET', 
-			{ 'outcomeId': outcomeId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'outcomeId': outcomeId },
+			{  },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -316,10 +316,10 @@ class JourneyApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Number} opts.pageSize Page size (default to 25)
-	 * @param {String} opts.sortBy Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with &#39;-&#39; for descending (e.g. sortBy=displayName,-createdDate).
+	 * @param {String} opts.sortBy Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).
 	 * @param {Array.<String>} opts.outcomeIds IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.
-	 * @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires &#39;queryValue&#39; to also be set.
-	 * @param {String} opts.queryValue Value to query on. Requires &#39;queryFields&#39; to also be set.
+	 * @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
+	 * @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
 	 */
 	getJourneyOutcomes(opts) { 
 		opts = opts || {};
@@ -328,13 +328,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/outcomes', 
 			'GET', 
-			{  }, 
-			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'outcomeIds': this.apiClient.buildCollectionParam(opts['outcomeIds'], 'multi'),'queryFields': this.apiClient.buildCollectionParam(opts['queryFields'], 'multi'),'queryValue': opts['queryValue'] }, 
-			{  }, 
-			{  }, 
+			{  },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'outcomeIds': this.apiClient.buildCollectionParam(opts['outcomeIds'], 'multi'),'queryFields': this.apiClient.buildCollectionParam(opts['queryFields'], 'multi'),'queryValue': opts['queryValue'] },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -353,13 +353,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/segments/{segmentId}', 
 			'GET', 
-			{ 'segmentId': segmentId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'segmentId': segmentId },
+			{  },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -368,13 +368,13 @@ class JourneyApi {
 	 * Retrieve all segments.
 	 * 
 	 * @param {Object} opts Optional parameters
-	 * @param {String} opts.sortBy Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with &#39;-&#39; for descending (e.g. sortBy=displayName,-createdDate).
+	 * @param {String} opts.sortBy Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).
 	 * @param {Number} opts.pageSize Page size (default to 25)
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Boolean} opts.isActive Determines whether or not to show only active segments.
 	 * @param {Array.<String>} opts.segmentIds IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.
-	 * @param {Array.<String>} opts.queryFields Segment field(s) to query on. Requires &#39;queryValue&#39; to also be set.
-	 * @param {String} opts.queryValue Value to query on. Requires &#39;queryFields&#39; to also be set.
+	 * @param {Array.<String>} opts.queryFields Segment field(s) to query on. Requires 'queryValue' to also be set.
+	 * @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
 	 */
 	getJourneySegments(opts) { 
 		opts = opts || {};
@@ -383,13 +383,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/segments', 
 			'GET', 
-			{  }, 
-			{ 'sortBy': opts['sortBy'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'isActive': opts['isActive'],'segmentIds': this.apiClient.buildCollectionParam(opts['segmentIds'], 'multi'),'queryFields': this.apiClient.buildCollectionParam(opts['queryFields'], 'multi'),'queryValue': opts['queryValue'] }, 
-			{  }, 
-			{  }, 
+			{  },
+			{ 'sortBy': opts['sortBy'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'isActive': opts['isActive'],'segmentIds': this.apiClient.buildCollectionParam(opts['segmentIds'], 'multi'),'queryFields': this.apiClient.buildCollectionParam(opts['queryFields'], 'multi'),'queryValue': opts['queryValue'] },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -408,13 +408,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/sessions/{sessionId}', 
 			'GET', 
-			{ 'sessionId': sessionId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'sessionId': sessionId },
+			{  },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -433,13 +433,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/sessions/{sessionId}/outcomescores', 
 			'GET', 
-			{ 'sessionId': sessionId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'sessionId': sessionId },
+			{  },
+			{  },
+			{  },
 			null, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -462,13 +462,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actionmaps/{actionMapId}', 
 			'PATCH', 
-			{ 'actionMapId': actionMapId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'actionMapId': actionMapId },
+			{  },
+			{  },
+			{  },
 			opts['body'], 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -491,13 +491,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actiontargets/{actionTargetId}', 
 			'PATCH', 
-			{ 'actionTargetId': actionTargetId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'actionTargetId': actionTargetId },
+			{  },
+			{  },
+			{  },
 			opts['body'], 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -520,13 +520,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actiontemplates/{actionTemplateId}', 
 			'PATCH', 
-			{ 'actionTemplateId': actionTemplateId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'actionTemplateId': actionTemplateId },
+			{  },
+			{  },
+			{  },
 			opts['body'], 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -549,13 +549,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/outcomes/{outcomeId}', 
 			'PATCH', 
-			{ 'outcomeId': outcomeId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'outcomeId': outcomeId },
+			{  },
+			{  },
+			{  },
 			opts['body'], 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -578,13 +578,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/segments/{segmentId}', 
 			'PATCH', 
-			{ 'segmentId': segmentId }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{ 'segmentId': segmentId },
+			{  },
+			{  },
+			{  },
 			opts['body'], 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -603,13 +603,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/analytics/journeys/aggregates/query', 
 			'POST', 
-			{  }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{  },
+			{  },
+			{  },
+			{  },
 			body, 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -627,13 +627,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actionmaps', 
 			'POST', 
-			{  }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{  },
+			{  },
+			{  },
+			{  },
 			opts['body'], 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -651,13 +651,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/actiontemplates', 
 			'POST', 
-			{  }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{  },
+			{  },
+			{  },
+			{  },
 			opts['body'], 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -675,13 +675,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/outcomes', 
 			'POST', 
-			{  }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{  },
+			{  },
+			{  },
+			{  },
 			opts['body'], 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}
@@ -699,13 +699,13 @@ class JourneyApi {
 		return this.apiClient.callApi(
 			'/api/v2/journey/segments', 
 			'POST', 
-			{  }, 
-			{  }, 
-			{  }, 
-			{  }, 
+			{  },
+			{  },
+			{  },
+			{  },
 			opts['body'], 
 			['PureCloud OAuth'], 
-			['application/json'], 
+			['application/json'],
 			['application/json']
 		);
 	}