purecloud-platform-client-v2 218.1.0 → 219.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 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**
@@ -45,6 +45,31 @@ class GamificationApi {
 		);
 	}
 
+	/**
+	 * Delete a Contest by Id
+	 * 
+	 * @param {String} contestId The ID of the contest
+	 */
+	deleteGamificationContest(contestId) { 
+		// verify the required parameter 'contestId' is set
+		if (contestId === undefined || contestId === null) {
+			throw 'Missing the required parameter "contestId" when calling deleteGamificationContest';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests/{contestId}', 
+			'DELETE', 
+			{ 'contestId': contestId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get an External Metric Definition
 	 * 
@@ -95,6 +120,236 @@ class GamificationApi {
 		);
 	}
 
+	/**
+	 * Get a Contest by Id
+	 * 
+	 * @param {String} contestId The ID of the contest
+	 */
+	getGamificationContest(contestId) { 
+		// verify the required parameter 'contestId' is set
+		if (contestId === undefined || contestId === null) {
+			throw 'Missing the required parameter "contestId" when calling getGamificationContest';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests/{contestId}', 
+			'GET', 
+			{ 'contestId': contestId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get Contest Scores (Admin)
+	 * 
+	 * @param {String} contestId The ID of the contest
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageNumber  (default to 1)
+	 * @param {Number} opts.pageSize  (default to 25)
+	 * @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {Object} opts.returnsView Desired response results (default to All)
+	 */
+	getGamificationContestAgentsScores(contestId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'contestId' is set
+		if (contestId === undefined || contestId === null) {
+			throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScores';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests/{contestId}/agents/scores', 
+			'GET', 
+			{ 'contestId': contestId },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get Contest Scores for the requesting Agent/Supervisor
+	 * 
+	 * @param {String} contestId The ID of the contest
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageNumber  (default to 1)
+	 * @param {Number} opts.pageSize  (default to 25)
+	 * @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {Object} opts.returnsView Desired response results (Supervisor Only) (default to All)
+	 */
+	getGamificationContestAgentsScoresMe(contestId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'contestId' is set
+		if (contestId === undefined || contestId === null) {
+			throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresMe';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests/{contestId}/agents/scores/me', 
+			'GET', 
+			{ 'contestId': contestId },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a Contest Score Trend (Average Trend)
+	 * 
+	 * @param {String} contestId The ID of the contest
+	 */
+	getGamificationContestAgentsScoresTrends(contestId) { 
+		// verify the required parameter 'contestId' is set
+		if (contestId === undefined || contestId === null) {
+			throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrends';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests/{contestId}/agents/scores/trends', 
+			'GET', 
+			{ 'contestId': contestId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a Contest Score Trend for the requesting Agent
+	 * 
+	 * @param {String} contestId The ID of the contest
+	 */
+	getGamificationContestAgentsScoresTrendsMe(contestId) { 
+		// verify the required parameter 'contestId' is set
+		if (contestId === undefined || contestId === null) {
+			throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrendsMe';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests/{contestId}/agents/scores/trends/me', 
+			'GET', 
+			{ 'contestId': contestId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a Contest Prize Image by Id
+	 * 
+	 * @param {String} contestId The ID of the contest
+	 * @param {String} prizeImageId The ID of the prize image
+	 */
+	getGamificationContestPrizeimage(contestId, prizeImageId) { 
+		// verify the required parameter 'contestId' is set
+		if (contestId === undefined || contestId === null) {
+			throw 'Missing the required parameter "contestId" when calling getGamificationContestPrizeimage';
+		}
+		// verify the required parameter 'prizeImageId' is set
+		if (prizeImageId === undefined || prizeImageId === null) {
+			throw 'Missing the required parameter "prizeImageId" when calling getGamificationContestPrizeimage';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests/{contestId}/prizeimages/{prizeImageId}', 
+			'GET', 
+			{ 'contestId': contestId,'prizeImageId': prizeImageId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a List of Contests (Admin)
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageNumber  (default to 1)
+	 * @param {Number} opts.pageSize  (default to 25)
+	 * @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {Array.<String>} opts.status 
+	 * @param {Object} opts.sortBy  (default to dateStart)
+	 * @param {Object} opts.sortOrder  (default to desc)
+	 */
+	getGamificationContests(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests', 
+			'GET', 
+			{  },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a List of Contests (Agent/Supervisor)
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageNumber  (default to 1)
+	 * @param {Number} opts.pageSize  (default to 25)
+	 * @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {Array.<String>} opts.status 
+	 * @param {Object} opts.sortBy  (default to dateStart)
+	 * @param {Object} opts.sortOrder  (default to desc)
+	 * @param {Object} opts.view  (default to participant)
+	 */
+	getGamificationContestsMe(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests/me', 
+			'GET', 
+			{  },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'view': opts['view'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get insights summary
 	 * 
@@ -1745,6 +2000,36 @@ class GamificationApi {
 		);
 	}
 
+	/**
+	 * Finalize a Contest by Id
+	 * 
+	 * @param {String} contestId The ID of the contest
+	 * @param {Object} body Finalize Contest
+	 */
+	patchGamificationContest(contestId, body) { 
+		// verify the required parameter 'contestId' is set
+		if (contestId === undefined || contestId === null) {
+			throw 'Missing the required parameter "contestId" when calling patchGamificationContest';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchGamificationContest';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests/{contestId}', 
+			'PATCH', 
+			{ 'contestId': contestId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Write External Metric Data
 	 * 
@@ -1793,6 +2078,56 @@ class GamificationApi {
 		);
 	}
 
+	/**
+	 * Creates a Contest
+	 * 
+	 * @param {Object} body Create Contest
+	 */
+	postGamificationContests(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postGamificationContests';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Generates pre-signed URL to upload a prize image for gamification contests
+	 * 
+	 * @param {Object} body query
+	 */
+	postGamificationContestsUploadsPrizeimages(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests/uploads/prizeimages', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Activate a performance profile
 	 * 
@@ -2052,6 +2387,36 @@ class GamificationApi {
 		);
 	}
 
+	/**
+	 * Update a Contest by Id
+	 * 
+	 * @param {String} contestId The ID of the contest
+	 * @param {Object} body Contest
+	 */
+	putGamificationContest(contestId, body) { 
+		// verify the required parameter 'contestId' is set
+		if (contestId === undefined || contestId === null) {
+			throw 'Missing the required parameter "contestId" when calling putGamificationContest';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putGamificationContest';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/contests/{contestId}', 
+			'PUT', 
+			{ 'contestId': contestId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Updates a performance profile
 	 * 

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 218.1.0
+	 * @version 219.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 218.1.0
+	 * @version 219.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 218.1.0
+	 * @version 219.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 218.1.0
+	 * @version 219.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 218.1.0
+	 * @version 219.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 218.1.0
+	 * @version 219.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 218.1.0
+	 * @version 219.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 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class KnowledgeApi {
 	/**
 	 * Knowledge service.
 	 * @module purecloud-platform-client-v2/api/KnowledgeApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
 	/**
 	 * LanguageUnderstanding service.
 	 * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LanguagesApi {
 	/**
 	 * Languages service.
 	 * @module purecloud-platform-client-v2/api/LanguagesApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LearningApi {
 	/**
 	 * Learning service.
 	 * @module purecloud-platform-client-v2/api/LearningApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LicenseApi {
 	/**
 	 * License service.
 	 * @module purecloud-platform-client-v2/api/LicenseApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LocationsApi {
 	/**
 	 * Locations service.
 	 * @module purecloud-platform-client-v2/api/LocationsApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LogCaptureApi {
 	/**
 	 * LogCapture service.
 	 * @module purecloud-platform-client-v2/api/LogCaptureApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class MessagingApi {
 	/**
 	 * Messaging service.
 	 * @module purecloud-platform-client-v2/api/MessagingApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class MobileDevicesApi {
 	/**
 	 * MobileDevices service.
 	 * @module purecloud-platform-client-v2/api/MobileDevicesApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class NotificationsApi {
 	/**
 	 * Notifications service.
 	 * @module purecloud-platform-client-v2/api/NotificationsApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OAuthApi {
 	/**
 	 * OAuth service.
 	 * @module purecloud-platform-client-v2/api/OAuthApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ObjectsApi {
 	/**
 	 * Objects service.
 	 * @module purecloud-platform-client-v2/api/ObjectsApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**
@@ -110,6 +110,31 @@ class ObjectsApi {
 		);
 	}
 
+	/**
+	 * Get a list of soft deleted divisions for the org
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 * @param {Number} opts.pageSize Page size (default to 25)
+	 */
+	getAuthorizationDivisionsDeleted(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/divisions/deleted', 
+			'GET', 
+			{  },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Retrieve the home division for the organization.
 	 * Will not include object counts.
@@ -150,6 +175,34 @@ class ObjectsApi {
 		);
 	}
 
+	/**
+	 * Retrieve a list of all divisions defined for the organization with cursor
+	 * Use "after" and "before" param to fetch next/previous page}
+	 * @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 {Array.<String>} opts.id Optionally request specific divisions by their IDs
+	 * @param {String} opts.name Optionally request specific divisions by division name
+	 */
+	getAuthorizationDivisionsQuery(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/divisions/query', 
+			'GET', 
+			{  },
+			{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Assign a list of objects to a division
 	 * Set the division of a specified list of objects. The objects must all be of the same type, one of:  CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER.  The body of the request is a list of object IDs, which are expected to be  GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]

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

@@ -5,7 +5,7 @@ class OperationalEventsApi {
 	/**
 	 * OperationalEvents service.
 	 * @module purecloud-platform-client-v2/api/OperationalEventsApi
-	 * @version 218.1.0
+	 * @version 219.0.0
 	 */
 
 	/**