purecloud-platform-client-v2 249.0.0 → 250.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 249.0.0
+	 * @version 250.0.0
 	 */
 
 	/**
@@ -24,8 +24,12 @@ class OAuthApi {
 	 * Delete OAuth Client
 	 * 
 	 * @param {String} clientId Client ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	deleteOauthClient(clientId) { 
+	deleteOauthClient(clientId, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'clientId' is set
 		if (clientId === undefined || clientId === null || clientId === '') {
 			throw 'Missing the required parameter "clientId" when calling deleteOauthClient';
@@ -41,7 +45,8 @@ class OAuthApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -51,6 +56,7 @@ class OAuthApi {
 	 * @param {String} clientId The ID of client
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.acceptLanguage The language in which to display the client descriptions. (default to en-us)
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	getOauthAuthorization(clientId, opts) { 
 		opts = opts || {};
@@ -70,7 +76,8 @@ class OAuthApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -79,6 +86,7 @@ class OAuthApi {
 	 * 
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.acceptLanguage The language in which to display the client descriptions. (default to en-us)
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	getOauthAuthorizations(opts) { 
 		opts = opts || {};
@@ -94,7 +102,8 @@ class OAuthApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -102,8 +111,12 @@ class OAuthApi {
 	 * Get OAuth Client
 	 * 
 	 * @param {String} clientId Client ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	getOauthClient(clientId) { 
+	getOauthClient(clientId, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'clientId' is set
 		if (clientId === undefined || clientId === null || clientId === '') {
 			throw 'Missing the required parameter "clientId" when calling getOauthClient';
@@ -119,7 +132,8 @@ class OAuthApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -128,8 +142,12 @@ class OAuthApi {
 	 * 
 	 * @param {String} executionId ID of the query execution
 	 * @param {String} clientId Client ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	getOauthClientUsageQueryResult(executionId, clientId) { 
+	getOauthClientUsageQueryResult(executionId, clientId, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'executionId' is set
 		if (executionId === undefined || executionId === null || executionId === '') {
 			throw 'Missing the required parameter "executionId" when calling getOauthClientUsageQueryResult';
@@ -149,7 +167,8 @@ class OAuthApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -159,6 +178,7 @@ class OAuthApi {
 	 * @param {String} clientId Client ID
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.days Previous number of days to query (default to 7)
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	getOauthClientUsageSummary(clientId, opts) { 
 		opts = opts || {};
@@ -178,15 +198,20 @@ class OAuthApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
 	/**
 	 * The list of OAuth clients
 	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	getOauthClients() { 
+	getOauthClients(opts) { 
+		opts = opts || {};
+		
 
 		return this.apiClient.callApi(
 			'/api/v2/oauth/clients', 
@@ -198,7 +223,8 @@ class OAuthApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -208,6 +234,7 @@ class OAuthApi {
 	 * @param {String} scopeId Scope ID
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.acceptLanguage The language with which to display the scope description. (default to en-us)
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	getOauthScope(scopeId, opts) { 
 		opts = opts || {};
@@ -227,7 +254,8 @@ class OAuthApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -236,6 +264,7 @@ class OAuthApi {
 	 * 
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.acceptLanguage The language with which to display the scope descriptions. (default to en-us)
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	getOauthScopes(opts) { 
 		opts = opts || {};
@@ -251,7 +280,8 @@ class OAuthApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -259,8 +289,12 @@ class OAuthApi {
 	 * Regenerate Client Secret
 	 * This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.
 	 * @param {String} clientId Client ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	postOauthClientSecret(clientId) { 
+	postOauthClientSecret(clientId, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'clientId' is set
 		if (clientId === undefined || clientId === null || clientId === '') {
 			throw 'Missing the required parameter "clientId" when calling postOauthClientSecret';
@@ -276,7 +310,8 @@ class OAuthApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -285,8 +320,12 @@ class OAuthApi {
 	 * After calling this method, you will then need to poll for the query results based on the returned execution Id
 	 * @param {String} clientId Client ID
 	 * @param {Object} body Query
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	postOauthClientUsageQuery(clientId, body) { 
+	postOauthClientUsageQuery(clientId, body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'clientId' is set
 		if (clientId === undefined || clientId === null || clientId === '') {
 			throw 'Missing the required parameter "clientId" when calling postOauthClientUsageQuery';
@@ -306,7 +345,8 @@ class OAuthApi {
 			body, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -314,8 +354,12 @@ class OAuthApi {
 	 * Create OAuth client
 	 * The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud.  The preferred authorizedGrantTypes is CODE which requires applications to send a client ID and client secret. This is typically a web server.  If the client is unable to secure the client secret then the TOKEN grant type aka IMPLICIT should be used. This is would be for browser or mobile apps.  If a client is to be used outside of the context of a user then the CLIENT-CREDENTIALS grant may be used. In this case the client must be granted roles  via the roleIds field.
 	 * @param {Object} body Client
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	postOauthClients(body) { 
+	postOauthClients(body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'body' is set
 		if (body === undefined || body === null) {
 			throw 'Missing the required parameter "body" when calling postOauthClients';
@@ -331,7 +375,8 @@ class OAuthApi {
 			body, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -340,8 +385,12 @@ class OAuthApi {
 	 * 
 	 * @param {String} clientId Client ID
 	 * @param {Object} body Client
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	putOauthClient(clientId, body) { 
+	putOauthClient(clientId, body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'clientId' is set
 		if (clientId === undefined || clientId === null || clientId === '') {
 			throw 'Missing the required parameter "clientId" when calling putOauthClient';
@@ -361,7 +410,8 @@ class OAuthApi {
 			body, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 

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 249.0.0
+	 * @version 250.0.0
 	 */
 
 	/**
@@ -26,6 +26,7 @@ class ObjectsApi {
 	 * @param {String} divisionId Division ID
 	 * @param {Object} opts Optional parameters
 	 * @param {Boolean} opts.force DEPRECATED -  Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (default to false)
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	deleteAuthorizationDivision(divisionId, opts) { 
 		opts = opts || {};
@@ -45,7 +46,8 @@ class ObjectsApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -55,6 +57,7 @@ class ObjectsApi {
 	 * @param {String} divisionId Division ID
 	 * @param {Object} opts Optional parameters
 	 * @param {Object} opts.objectCount Get count of objects in this division, grouped by type (default to false)
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	getAuthorizationDivision(divisionId, opts) { 
 		opts = opts || {};
@@ -74,7 +77,8 @@ class ObjectsApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -91,6 +95,7 @@ class ObjectsApi {
 	 * @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
 	 * @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
 	 * @param {String} opts.name Search term to filter by division name
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	getAuthorizationDivisions(opts) { 
 		opts = opts || {};
@@ -106,7 +111,8 @@ class ObjectsApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -116,6 +122,7 @@ class ObjectsApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageNumber Page number (default to 1)
 	 * @param {Number} opts.pageSize Page size (default to 25)
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	getAuthorizationDivisionsDeleted(opts) { 
 		opts = opts || {};
@@ -131,15 +138,20 @@ class ObjectsApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
 	/**
 	 * Retrieve the home division for the organization.
 	 * Will not include object counts.
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	getAuthorizationDivisionsHome() { 
+	getAuthorizationDivisionsHome(opts) { 
+		opts = opts || {};
+		
 
 		return this.apiClient.callApi(
 			'/api/v2/authorization/divisions/home', 
@@ -151,15 +163,20 @@ class ObjectsApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
 	/**
 	 * Returns the maximum allowed number of divisions.
 	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	getAuthorizationDivisionsLimit() { 
+	getAuthorizationDivisionsLimit(opts) { 
+		opts = opts || {};
+		
 
 		return this.apiClient.callApi(
 			'/api/v2/authorization/divisions/limit', 
@@ -171,7 +188,8 @@ class ObjectsApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -184,6 +202,7 @@ class ObjectsApi {
 	 * @param {String} opts.pageSize Page size (max 200, default 25) (default to 25)
 	 * @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
 	 * @param {String} opts.name Optionally request specific divisions by division name
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	getAuthorizationDivisionsQuery(opts) { 
 		opts = opts || {};
@@ -199,7 +218,8 @@ class ObjectsApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -209,8 +229,12 @@ class ObjectsApi {
 	 * @param {String} divisionId Division ID
 	 * @param {Object} objectType The type of the objects. Must be one of the valid object types
 	 * @param {Array.<String>} body Object Id List
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	postAuthorizationDivisionObject(divisionId, objectType, body) { 
+	postAuthorizationDivisionObject(divisionId, objectType, body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'divisionId' is set
 		if (divisionId === undefined || divisionId === null || divisionId === '') {
 			throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionObject';
@@ -234,7 +258,8 @@ class ObjectsApi {
 			body, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -243,8 +268,12 @@ class ObjectsApi {
 	 * 
 	 * @param {String} divisionId Division ID
 	 * @param {Object} body Recreated division data
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	postAuthorizationDivisionRestore(divisionId, body) { 
+	postAuthorizationDivisionRestore(divisionId, body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'divisionId' is set
 		if (divisionId === undefined || divisionId === null || divisionId === '') {
 			throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
@@ -264,7 +293,8 @@ class ObjectsApi {
 			body, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -272,8 +302,12 @@ class ObjectsApi {
 	 * Create a division.
 	 * 
 	 * @param {Object} body Division
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	postAuthorizationDivisions(body) { 
+	postAuthorizationDivisions(body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'body' is set
 		if (body === undefined || body === null) {
 			throw 'Missing the required parameter "body" when calling postAuthorizationDivisions';
@@ -289,7 +323,8 @@ class ObjectsApi {
 			body, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -298,8 +333,12 @@ class ObjectsApi {
 	 * 
 	 * @param {String} divisionId Division ID
 	 * @param {Object} body Updated division data
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	putAuthorizationDivision(divisionId, body) { 
+	putAuthorizationDivision(divisionId, body, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'divisionId' is set
 		if (divisionId === undefined || divisionId === null || divisionId === '') {
 			throw 'Missing the required parameter "divisionId" when calling putAuthorizationDivision';
@@ -319,7 +358,8 @@ class ObjectsApi {
 			body, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 

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 249.0.0
+	 * @version 250.0.0
 	 */
 
 	/**
@@ -24,8 +24,12 @@ class OperationalEventsApi {
 	 * Get an operational event definition by its id
 	 * 
 	 * @param {String} eventDefinitionId EventDefinition id
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	getUsageEventsDefinition(eventDefinitionId) { 
+	getUsageEventsDefinition(eventDefinitionId, opts) { 
+		opts = opts || {};
+		
 		// verify the required parameter 'eventDefinitionId' is set
 		if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
 			throw 'Missing the required parameter "eventDefinitionId" when calling getUsageEventsDefinition';
@@ -41,15 +45,20 @@ class OperationalEventsApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
 	/**
 	 * Get all operational event definitions
 	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
-	getUsageEventsDefinitions() { 
+	getUsageEventsDefinitions(opts) { 
+		opts = opts || {};
+		
 
 		return this.apiClient.callApi(
 			'/api/v2/usage/events/definitions', 
@@ -61,7 +70,8 @@ class OperationalEventsApi {
 			null, 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -70,6 +80,7 @@ class OperationalEventsApi {
 	 * 
 	 * @param {Object} opts Optional parameters
 	 * @param {Object} opts.body 
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	postUsageEventsAggregatesQuery(opts) { 
 		opts = opts || {};
@@ -85,7 +96,8 @@ class OperationalEventsApi {
 			opts['body'], 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}
 
@@ -97,6 +109,7 @@ class OperationalEventsApi {
 	 * @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.body 
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	postUsageEventsQuery(opts) { 
 		opts = opts || {};
@@ -112,7 +125,8 @@ class OperationalEventsApi {
 			opts['body'], 
 			['PureCloud OAuth'], 
 			['application/json'],
-			['application/json']
+			['application/json'],
+			opts['customHeaders']
 		);
 	}