purecloud-platform-client-v2 162.0.0 → 163.0.0

package/README.md

@@ -27,7 +27,7 @@ For direct use in a browser script:
 
 ```html
 <!-- Include the CJS SDK -->
-<script src="https://sdk-cdn.mypurecloud.com/javascript/162.0.0/purecloud-platform-client-v2.min.js"></script>
+<script src="https://sdk-cdn.mypurecloud.com/javascript/163.0.0/purecloud-platform-client-v2.min.js"></script>
 
 <script type="text/javascript">
   // Obtain a reference to the platformClient object
@@ -44,7 +44,7 @@ For direct use in a browser script:
 
 <script type="text/javascript">
   // Obtain a reference to the platformClient object
-  requirejs(['https://sdk-cdn.mypurecloud.com/javascript/amd/162.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
+  requirejs(['https://sdk-cdn.mypurecloud.com/javascript/amd/163.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
     console.log(platformClient);
   });
 </script>
@@ -376,22 +376,21 @@ Extended response object example (`body` and `text` have been truncated):
 
 ### Using a Proxy (Node.js only)
 
-Using a proxy is accomplished by setting the proxy settings on the `client` object
+Using a proxy is accomplished by setting the `proxyAgent` on the `ApiClient` object.
+The `proxyAgent` will be used to set the `httpsAgent` on the axios request object used in all api calls. See [axios documentation](https://axios-http.com/docs/req_config) for details.
+We recommended using the npm package `hpagent` https://www.npmjs.com/package/hpagent to create a proxyAgent although other options are available.
+An example using `hpagent` to create the proxy is shown below
 
-NOTE: SDK proxy configuration is only available in the node.js package due to the axios proxy incompatibility with browsers.
+NOTE: The hpagent package is a NodeJS package. As such, web applications that wish to use this proxy must configure their build tools to handle transpiling and polyfilling the NodeJS package for their desired web target.
 
 ```javascript
+const {HttpsProxyAgent} = require('hpagent')
 const client = platformClient.ApiClient.instance;
-// Documentation: https://axios-http.com/docs/req_config
-client.proxy = {
-  host: '172.1.1.100',
-  port: 443,
-  protocol: 'https',
-  auth: {
-    username: 'john_doe',
-    password: 'abc123'
-  }
-};
+
+agent = new HttpsProxyAgent({
+  proxy: proxyUrl,
+});
+client.setProxyAgent(agent)
 ```
 
 

package/dist/node/purecloud-platform-client-v2.js

@@ -400,11 +400,9 @@ class Configuration {
 	}
 }
 
-const { HttpsProxyAgent } = require('hpagent');
-
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 162.0.0
+ * @version 163.0.0
  */
 class ApiClient {
 	/**
@@ -676,18 +674,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__default["default"]({
 				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
@@ -1364,6 +1356,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.
@@ -1384,16 +1384,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)
 				};
@@ -1494,7 +1488,7 @@ class AlertingApi {
 	/**
 	 * Alerting service.
 	 * @module purecloud-platform-client-v2/api/AlertingApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -1808,7 +1802,7 @@ class AnalyticsApi {
 	/**
 	 * Analytics service.
 	 * @module purecloud-platform-client-v2/api/AnalyticsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -3062,7 +3056,7 @@ class ArchitectApi {
 	/**
 	 * Architect service.
 	 * @module purecloud-platform-client-v2/api/ArchitectApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -6110,7 +6104,7 @@ class AuditApi {
 	/**
 	 * Audit service.
 	 * @module purecloud-platform-client-v2/api/AuditApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -6281,7 +6275,7 @@ class AuthorizationApi {
 	/**
 	 * Authorization service.
 	 * @module purecloud-platform-client-v2/api/AuthorizationApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -7510,7 +7504,7 @@ class BillingApi {
 	/**
 	 * Billing service.
 	 * @module purecloud-platform-client-v2/api/BillingApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -7590,7 +7584,7 @@ class ChatApi {
 	/**
 	 * Chat service.
 	 * @module purecloud-platform-client-v2/api/ChatApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -7751,7 +7745,7 @@ class CoachingApi {
 	/**
 	 * Coaching service.
 	 * @module purecloud-platform-client-v2/api/CoachingApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -8328,7 +8322,7 @@ class ContentManagementApi {
 	/**
 	 * ContentManagement service.
 	 * @module purecloud-platform-client-v2/api/ContentManagementApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -9468,7 +9462,7 @@ class ConversationsApi {
 	/**
 	 * Conversations service.
 	 * @module purecloud-platform-client-v2/api/ConversationsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -15488,7 +15482,7 @@ class DataExtensionsApi {
 	/**
 	 * DataExtensions service.
 	 * @module purecloud-platform-client-v2/api/DataExtensionsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -15574,7 +15568,7 @@ class DownloadsApi {
 	/**
 	 * Downloads service.
 	 * @module purecloud-platform-client-v2/api/DownloadsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -15626,7 +15620,7 @@ class EventsApi {
 	/**
 	 * Events service.
 	 * @module purecloud-platform-client-v2/api/EventsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -15722,7 +15716,7 @@ class ExternalContactsApi {
 	/**
 	 * ExternalContacts service.
 	 * @module purecloud-platform-client-v2/api/ExternalContactsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -17680,7 +17674,7 @@ class FaxApi {
 	/**
 	 * Fax service.
 	 * @module purecloud-platform-client-v2/api/FaxApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -17851,7 +17845,7 @@ class FlowsApi {
 	/**
 	 * Flows service.
 	 * @module purecloud-platform-client-v2/api/FlowsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -17922,7 +17916,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -19539,7 +19533,7 @@ class GeneralDataProtectionRegulationApi {
 	/**
 	 * GeneralDataProtectionRegulation service.
 	 * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -19669,7 +19663,7 @@ class GeolocationApi {
 	/**
 	 * Geolocation service.
 	 * @module purecloud-platform-client-v2/api/GeolocationApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -19800,7 +19794,7 @@ class GreetingsApi {
 	/**
 	 * Greetings service.
 	 * @module purecloud-platform-client-v2/api/GreetingsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -20255,7 +20249,7 @@ class GroupsApi {
 	/**
 	 * Groups service.
 	 * @module purecloud-platform-client-v2/api/GroupsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -20661,7 +20655,7 @@ class IdentityProviderApi {
 	/**
 	 * IdentityProvider service.
 	 * @module purecloud-platform-client-v2/api/IdentityProviderApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -21417,7 +21411,7 @@ class InfrastructureAsCodeApi {
 	/**
 	 * InfrastructureAsCode service.
 	 * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -21519,7 +21513,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -23119,7 +23113,7 @@ class JourneyApi {
 	/**
 	 * Journey service.
 	 * @module purecloud-platform-client-v2/api/JourneyApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -23999,7 +23993,7 @@ class KnowledgeApi {
 	/**
 	 * Knowledge service.
 	 * @module purecloud-platform-client-v2/api/KnowledgeApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -26431,7 +26425,7 @@ class LanguageUnderstandingApi {
 	/**
 	 * LanguageUnderstanding service.
 	 * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -27444,7 +27438,7 @@ class LanguagesApi {
 	/**
 	 * Languages service.
 	 * @module purecloud-platform-client-v2/api/LanguagesApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -27662,7 +27656,7 @@ class LearningApi {
 	/**
 	 * Learning service.
 	 * @module purecloud-platform-client-v2/api/LearningApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -28477,7 +28471,7 @@ class LicenseApi {
 	/**
 	 * License service.
 	 * @module purecloud-platform-client-v2/api/LicenseApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -28715,7 +28709,7 @@ class LocationsApi {
 	/**
 	 * Locations service.
 	 * @module purecloud-platform-client-v2/api/LocationsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -28951,7 +28945,7 @@ class MessagingApi {
 	/**
 	 * Messaging service.
 	 * @module purecloud-platform-client-v2/api/MessagingApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -29102,7 +29096,7 @@ class MobileDevicesApi {
 	/**
 	 * MobileDevices service.
 	 * @module purecloud-platform-client-v2/api/MobileDevicesApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -29253,7 +29247,7 @@ class NotificationsApi {
 	/**
 	 * Notifications service.
 	 * @module purecloud-platform-client-v2/api/NotificationsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -29486,7 +29480,7 @@ class OAuthApi {
 	/**
 	 * OAuth service.
 	 * @module purecloud-platform-client-v2/api/OAuthApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -29852,7 +29846,7 @@ class ObjectsApi {
 	/**
 	 * Objects service.
 	 * @module purecloud-platform-client-v2/api/ObjectsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -30123,7 +30117,7 @@ class OrganizationApi {
 	/**
 	 * Organization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -30526,7 +30520,7 @@ class OrganizationAuthorizationApi {
 	/**
 	 * OrganizationAuthorization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -31821,7 +31815,7 @@ class OutboundApi {
 	/**
 	 * Outbound service.
 	 * @module purecloud-platform-client-v2/api/OutboundApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -35417,7 +35411,7 @@ class PresenceApi {
 	/**
 	 * Presence service.
 	 * @module purecloud-platform-client-v2/api/PresenceApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -35968,7 +35962,7 @@ class ProcessAutomationApi {
 	/**
 	 * ProcessAutomation service.
 	 * @module purecloud-platform-client-v2/api/ProcessAutomationApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -36207,7 +36201,7 @@ class QualityApi {
 	/**
 	 * Quality service.
 	 * @module purecloud-platform-client-v2/api/QualityApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -37786,7 +37780,7 @@ class RecordingApi {
 	/**
 	 * Recording service.
 	 * @module purecloud-platform-client-v2/api/RecordingApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -39423,7 +39417,7 @@ class ResponseManagementApi {
 	/**
 	 * ResponseManagement service.
 	 * @module purecloud-platform-client-v2/api/ResponseManagementApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -39907,7 +39901,7 @@ class RoutingApi {
 	/**
 	 * Routing service.
 	 * @module purecloud-platform-client-v2/api/RoutingApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -43413,7 +43407,7 @@ class SCIMApi {
 	/**
 	 * SCIM service.
 	 * @module purecloud-platform-client-v2/api/SCIMApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -44290,7 +44284,7 @@ class ScriptsApi {
 	/**
 	 * Scripts service.
 	 * @module purecloud-platform-client-v2/api/ScriptsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -44709,7 +44703,7 @@ class SearchApi {
 	/**
 	 * Search service.
 	 * @module purecloud-platform-client-v2/api/SearchApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -45319,7 +45313,7 @@ class SpeechTextAnalyticsApi {
 	/**
 	 * SpeechTextAnalytics service.
 	 * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -46248,7 +46242,7 @@ class StationsApi {
 	/**
 	 * Stations service.
 	 * @module purecloud-platform-client-v2/api/StationsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -46395,7 +46389,7 @@ class SuggestApi {
 	/**
 	 * Suggest service.
 	 * @module purecloud-platform-client-v2/api/SuggestApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -46534,7 +46528,7 @@ class TeamsApi {
 	/**
 	 * Teams service.
 	 * @module purecloud-platform-client-v2/api/TeamsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -46805,7 +46799,7 @@ class TelephonyApi {
 	/**
 	 * Telephony service.
 	 * @module purecloud-platform-client-v2/api/TelephonyApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -46933,7 +46927,7 @@ class TelephonyProvidersEdgeApi {
 	/**
 	 * TelephonyProvidersEdge service.
 	 * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -50542,7 +50536,7 @@ class TextbotsApi {
 	/**
 	 * Textbots service.
 	 * @module purecloud-platform-client-v2/api/TextbotsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -50670,7 +50664,7 @@ class TokensApi {
 	/**
 	 * Tokens service.
 	 * @module purecloud-platform-client-v2/api/TokensApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -50776,7 +50770,7 @@ class UploadsApi {
 	/**
 	 * Uploads service.
 	 * @module purecloud-platform-client-v2/api/UploadsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -50952,7 +50946,7 @@ class UsageApi {
 	/**
 	 * Usage service.
 	 * @module purecloud-platform-client-v2/api/UsageApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -51023,7 +51017,7 @@ class UserRecordingsApi {
 	/**
 	 * UserRecordings service.
 	 * @module purecloud-platform-client-v2/api/UserRecordingsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -51208,7 +51202,7 @@ class UsersApi {
 	/**
 	 * Users service.
 	 * @module purecloud-platform-client-v2/api/UsersApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -53596,7 +53590,7 @@ class UtilitiesApi {
 	/**
 	 * Utilities service.
 	 * @module purecloud-platform-client-v2/api/UtilitiesApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -53707,7 +53701,7 @@ class VoicemailApi {
 	/**
 	 * Voicemail service.
 	 * @module purecloud-platform-client-v2/api/VoicemailApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -54374,7 +54368,7 @@ class WebChatApi {
 	/**
 	 * WebChat service.
 	 * @module purecloud-platform-client-v2/api/WebChatApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -54918,7 +54912,7 @@ class WebDeploymentsApi {
 	/**
 	 * WebDeployments service.
 	 * @module purecloud-platform-client-v2/api/WebDeploymentsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -55440,7 +55434,7 @@ class WebMessagingApi {
 	/**
 	 * WebMessaging service.
 	 * @module purecloud-platform-client-v2/api/WebMessagingApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -55486,7 +55480,7 @@ class WidgetsApi {
 	/**
 	 * Widgets service.
 	 * @module purecloud-platform-client-v2/api/WidgetsApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -55632,7 +55626,7 @@ class WorkforceManagementApi {
 	/**
 	 * WorkforceManagement service.
 	 * @module purecloud-platform-client-v2/api/WorkforceManagementApi
-	 * @version 162.0.0
+	 * @version 163.0.0
 	 */
 
 	/**
@@ -60376,7 +60370,7 @@ class WorkforceManagementApi {
  * </pre>
  * </p>
  * @module purecloud-platform-client-v2/index
- * @version 162.0.0
+ * @version 163.0.0
  */
 class platformClient {
 	constructor() {