purecloud-platform-client-v2 161.0.1 → 163.0.0

package/index.d.ts

@@ -6,8 +6,8 @@ declare module 'purecloud-platform-client-v2' {
 
 declare class ApiClientClass {
 	instance: ApiClientClass;
-	proxy: ProxyConfig;
 	config: Configuration;
+    private proxyAgent: any;
 
 	callApi(path: string, httpMethod: string, pathParams: { [key: string]: string; }, queryParams: { [key: string]: object; }, headerParams: { [key: string]: object; }, formParams: { [key: string]: object; }, bodyParam: any, authNames: Array<string>, contentTypes: Array<string>, accepts: Array<string>): Promise<any>;
 	loginClientCredentialsGrant(clientId: string, clientSecret: string): Promise<AuthData>;
@@ -20,6 +20,7 @@ declare class ApiClientClass {
 	setPersistSettings(doPersist: boolean, prefix?: string): void;
 	setReturnExtendedResponses(returnExtended: boolean): void;
 	setStorageKey(storageKey: string): void;
+	setProxyAgent(agent: any): void;
 }
 
 declare class LoginImplicitGrantOptions {
@@ -710,6 +711,7 @@ declare namespace AuthorizationApi {
 		"query"?: string;
 	}
 	export interface getAuthorizationRoleOptions { 
+		"userCount"?: boolean;
 		"expand"?: Array<string>;
 	}
 	export interface getAuthorizationRoleSubjectgrantsOptions { 
@@ -770,8 +772,11 @@ declare namespace BillingApi {
 
 declare class ChatApi {  
   	getChatSettings(): Promise<Models.ChatSettings>; 
+  	getChatsSettings(): Promise<Models.ChatSettings>; 
   	patchChatSettings(body: Models.ChatSettings): Promise<Models.ChatSettings>; 
-  	putChatSettings(body: Models.ChatSettings): Promise<Models.ChatSettings>;
+  	patchChatsSettings(body: Models.ChatSettings): Promise<Models.ChatSettings>; 
+  	putChatSettings(body: Models.ChatSettings): Promise<Models.ChatSettings>; 
+  	putChatsSettings(body: Models.ChatSettings): Promise<Models.ChatSettings>;
 }
 
 declare namespace ChatApi { 
@@ -3904,7 +3909,7 @@ declare class RoutingApi {
   	getRoutingEmailOutboundDomain(domainId: string): Promise<Models.OutboundDomain>; 
   	getRoutingEmailOutboundDomainActivation(domainId: string): Promise<Models.EmailOutboundDomainResult>; 
   	getRoutingEmailOutboundDomainSearch(domainId: string): Promise<Models.OutboundDomain>; 
-  	getRoutingEmailOutboundDomains(): Promise<Models.OutboundDomainEntityListing>; 
+  	getRoutingEmailOutboundDomains(opts?: RoutingApi.getRoutingEmailOutboundDomainsOptions): Promise<Models.OutboundDomainEntityListing>; 
   	getRoutingEmailSetup(): Promise<Models.EmailSetup>; 
   	getRoutingLanguage(languageId: string): Promise<Models.Language>; 
   	getRoutingLanguages(opts?: RoutingApi.getRoutingLanguagesOptions): Promise<Models.LanguageEntityListing>; 
@@ -4023,6 +4028,10 @@ declare namespace RoutingApi {
 		"pageSize"?: number;
 		"pageNumber"?: number;
 		"excludeStatus"?: boolean;
+		"filter"?: string;
+	}
+	export interface getRoutingEmailOutboundDomainsOptions { 
+		"filter"?: string;
 	}
 	export interface getRoutingLanguagesOptions { 
 		"pageSize"?: number;
@@ -9557,6 +9566,13 @@ declare namespace Models {
 		"callbackScheduledTime"?: string;
 	}
 	
+	export interface CallbackMediaSettings { 
+		"enableAutoAnswer"?: boolean;
+		"alertingTimeoutSeconds"?: number;
+		"serviceLevel"?: Models.ServiceLevel;
+		"subTypeSettings"?: { [key: string]: Models.BaseMediaSettings; };
+	}
+	
 	export interface Campaign { 
 		"id"?: string;
 		"name": string;
@@ -13637,7 +13653,7 @@ declare namespace Models {
 		"memberCount"?: number;
 		"userMemberCount"?: number;
 		"joinedMemberCount"?: number;
-		"mediaSettings"?: { [key: string]: Models.MediaSetting; };
+		"mediaSettings"?: Models.QueueMediaSettings;
 		"routingRules"?: Array<Models.RoutingRule>;
 		"bullseye"?: Models.Bullseye;
 		"acwSettings"?: Models.AcwSettings;
@@ -18041,6 +18057,7 @@ declare namespace Models {
 		"name"?: string;
 		"uploadDestinationUri"?: string;
 		"uploadMethodType"?: string;
+		"headers"?: { [key: string]: string; };
 		"selfUri"?: string;
 	}
 	
@@ -22578,7 +22595,7 @@ declare namespace Models {
 		"waveformData"?: Array<number>;
 	}
 	
-	export interface MediaSetting { 
+	export interface MediaSettings { 
 		"enableAutoAnswer"?: boolean;
 		"alertingTimeoutSeconds"?: number;
 		"serviceLevel"?: Models.ServiceLevel;
@@ -25805,7 +25822,7 @@ declare namespace Models {
 		"memberCount"?: number;
 		"userMemberCount"?: number;
 		"joinedMemberCount"?: number;
-		"mediaSettings"?: { [key: string]: Models.MediaSetting; };
+		"mediaSettings"?: Models.QueueMediaSettings;
 		"routingRules"?: Array<Models.RoutingRule>;
 		"bullseye"?: Models.Bullseye;
 		"acwSettings"?: Models.AcwSettings;
@@ -28168,6 +28185,14 @@ declare namespace Models {
 		"pageCount"?: number;
 	}
 	
+	export interface QueueMediaSettings { 
+		"call"?: Models.MediaSettings;
+		"callback"?: Models.CallbackMediaSettings;
+		"chat"?: Models.MediaSettings;
+		"email"?: Models.MediaSettings;
+		"message"?: Models.MediaSettings;
+	}
+	
 	export interface QueueMember { 
 		"id"?: string;
 		"name"?: string;
@@ -28258,7 +28283,7 @@ declare namespace Models {
 		"memberCount"?: number;
 		"userMemberCount"?: number;
 		"joinedMemberCount"?: number;
-		"mediaSettings"?: { [key: string]: Models.MediaSetting; };
+		"mediaSettings"?: Models.QueueMediaSettings;
 		"routingRules"?: Array<Models.RoutingRule>;
 		"bullseye"?: Models.Bullseye;
 		"acwSettings"?: Models.AcwSettings;
@@ -30276,6 +30301,11 @@ declare namespace Models {
 		"selfUri"?: string;
 	}
 	
+	export interface ServiceGoalTemplateImpactOverride { 
+		"enabled": boolean;
+		"impact": Models.WfmServiceGoalImpactSettings;
+	}
+	
 	export interface ServiceGoalTemplateList { 
 		"entities"?: Array<Models.ServiceGoalTemplate>;
 	}
@@ -33788,7 +33818,7 @@ declare namespace Models {
 		"memberCount"?: number;
 		"userMemberCount"?: number;
 		"joinedMemberCount"?: number;
-		"mediaSettings"?: { [key: string]: Models.MediaSetting; };
+		"mediaSettings"?: Models.QueueMediaSettings;
 		"routingRules"?: Array<Models.RoutingRule>;
 		"bullseye"?: Models.Bullseye;
 		"acwSettings"?: Models.AcwSettings;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "161.0.1",
+  "version": "163.0.0",
   "description": "A JavaScript library to interface with the PureCloud Platform API",
   "license": "MIT",
   "main": "dist/node/purecloud-platform-client-v2.js",
@@ -33,8 +33,7 @@
     "axios": "^0.27.2",
     "configparser": "^0.3.9",
     "qs": "^6.10.3",
-    "winston": "^3.6.0",
-    "hpagent": "^1.2.0"
+    "winston": "^3.6.0"
   },
   "devDependencies": {
     "mocha": "~9.2.0",

package/src/purecloud-platform-client-v2/ApiClient.js

@@ -1,11 +1,10 @@
 import { default as axios } from 'axios';
 import Configuration from './configuration.js';
 import { default as qs } from 'qs';
-const { HttpsProxyAgent } = require('hpagent')
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 161.0.1
+ * @version 163.0.0
  */
 class ApiClient {
 	/**
@@ -277,18 +276,12 @@ class ApiClient {
 			const headers = {
 				'Authorization': `Basic ${authHeader}`
 			}
-			let httpsAgent;
-			if (this.proxy !== undefined){
-				httpsAgent = new HttpsProxyAgent({
-				    proxy : `${this.proxy.protocol}://${this.proxy.host}:${this.proxy.port}`
-				});
-			}
 			axios({
 				method: `POST`,
 				url: `https://login.${this.config.environment}/oauth/token`,
 				headers: headers,
 				data: 'grant_type=client_credentials',
-				httpsAgent: httpsAgent
+				httpsAgent: this.proxyAgent
 			})
 				.then((response) => {
 					// Logging
@@ -965,6 +958,14 @@ class ApiClient {
 		});
 	}
 
+	/**
+	 * @description Sets the proxy agent axios will use for requests 
+	 * @param {any} agent - The proxy agent
+	 */
+	setProxyAgent(agent) {
+		this.proxyAgent = agent
+	}
+
 	/**
 	 * Invokes the REST service using the supplied settings and parameters.
 	 * @param {String} path The base URL to invoke.
@@ -985,16 +986,10 @@ class ApiClient {
 			sendRequest(this);
 			function sendRequest(that) {
 				var url = that.buildUrl(path, pathParams);
-				let httpsAgent;
-				if (that.proxy !== undefined){
-				    httpsAgent = new HttpsProxyAgent({
-					proxy : `${that.proxy.protocol}://${that.proxy.host}:${that.proxy.port}`
-				    });
-				}
 				var request = {
 					method: httpMethod,
-					url: url,
-                    			httpsAgent: httpsAgent,
+					url: url,	
+					httpsAgent: that.proxyAgent,
 					timeout: that.timeout,
 					params: that.serialize(queryParams)
 				};

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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -97,7 +97,7 @@ class AnalyticsApi {
 
 	/**
 	 * Get Reporting Turns.
-	 * 
+	 * Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list.
 	 * @param {String} botFlowId ID of the bot flow.
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.

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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -386,6 +386,7 @@ class AuthorizationApi {
 	 * Get the organization role specified by its ID.
 	 * @param {String} roleId Role ID
 	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division (default to true)
 	 * @param {Array.<String>} opts.expand Which fields, if any, to expand. unusedPermissions returns the permissions not used for the role
 	 */
 	getAuthorizationRole(roleId, opts) { 
@@ -400,7 +401,7 @@ class AuthorizationApi {
 			'/api/v2/authorization/roles/{roleId}', 
 			'GET', 
 			{ 'roleId': roleId },
-			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
+			{ 'userCount': opts['userCount'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
 			{  },
 			{  },
 			null, 

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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -22,7 +22,7 @@ class ChatApi {
 
 	/**
 	 * Get Chat Settings.
-	 * 
+	 * This route is deprecated, please use /chats/settings instead
 	 */
 	getChatSettings() { 
 
@@ -41,8 +41,28 @@ class ChatApi {
 	}
 
 	/**
-	 * Patch Chat Settings.
+	 * Get Chat Settings.
 	 * 
+	 */
+	getChatsSettings() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/chats/settings', 
+			'GET', 
+			{  },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Patch Chat Settings.
+	 * This route is deprecated, please use /chats/settings instead
 	 * @param {Object} body Chat
 	 */
 	patchChatSettings(body) { 
@@ -66,10 +86,35 @@ class ChatApi {
 	}
 
 	/**
-	 * Update Chat Settings.
+	 * Patch Chat Settings.
 	 * 
 	 * @param {Object} body Chat
 	 */
+	patchChatsSettings(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchChatsSettings';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/chats/settings', 
+			'PATCH', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update Chat Settings.
+	 * This route is deprecated, please use /chats/settings instead
+	 * @param {Object} body Chat
+	 */
 	putChatSettings(body) { 
 		// verify the required parameter 'body' is set
 		if (body === undefined || body === null) {
@@ -90,6 +135,31 @@ class ChatApi {
 		);
 	}
 
+	/**
+	 * Update Chat Settings.
+	 * 
+	 * @param {Object} body Chat
+	 */
+	putChatsSettings(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putChatsSettings';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/chats/settings', 
+			'PUT', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 }
 
 

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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.0.0
 	 */
 
 	/**

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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.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 161.0.1
+	 * @version 163.0.0
 	 */
 
 	/**