purecloud-platform-client-v2 184.0.0 → 185.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "184.0.0",
+  "version": "185.0.0",
   "description": "A JavaScript library to interface with the PureCloud Platform API",
   "license": "MIT",
   "main": "dist/node/purecloud-platform-client-v2.js",

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

@@ -4,7 +4,7 @@ import { default as qs } from 'qs';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 184.0.0
+ * @version 185.0.0
  */
 class ApiClient {
 	/**
@@ -415,6 +415,339 @@ class ApiClient {
 		});
 	}
 
+	/**
+	 * @description Completes the PKCE Code Authorization.
+	 * @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
+	 * @param {string} codeVerifier - code verifier used to generate the code challenge
+	 * @param {string} authCode - Authorization code
+	 * @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
+	 */
+    authorizePKCEGrant(clientId, codeVerifier, authCode, redirectUri) {
+		this.clientId = clientId;
+		return new Promise((resolve, reject) => {
+			var request = axios({
+				method: `POST`,
+				url: `https://login.${this.config.environment}/oauth/token`,
+				headers: {
+					'Content-Type': 'application/x-www-form-urlencoded'
+				},
+				data: qs.stringify({ grant_type: 'authorization_code',
+									            code: authCode,
+												code_verifier: codeVerifier,
+												client_id: clientId,
+												redirect_uri: redirectUri })
+			});
+
+			request.proxy = this.proxy;
+			var bodyParam = {
+				grant_type: 'authorization_code',
+                code: authCode,
+                code_verifier: codeVerifier,
+                client_id: clientId,
+                redirect_uri: redirectUri,
+			};
+			// Handle response
+			request
+			.then((response) => {
+				// Logging
+				this.config.logger.log(
+					'trace',
+					response.status,
+					'POST',
+					`https://login.${this.config.environment}/oauth/token`,
+					request.headers,
+					response.headers,
+					bodyParam,
+					undefined
+				);
+				this.config.logger.log(
+					'debug',
+					response.status,
+					'POST',
+					`https://login.${this.config.environment}/oauth/token`,
+					request.headers,
+					undefined,
+					bodyParam,
+					undefined
+				);
+
+				// Get access token from response
+				var access_token = response.data.access_token;
+
+				this.setAccessToken(access_token);
+				this.authData.tokenExpiryTime = new Date().getTime() + response.data['expires_in'] * 1000;
+				this.authData.tokenExpiryTimeString = new Date(this.authData.tokenExpiryTime).toUTCString();
+
+				// Return auth data
+				resolve(this.authData);
+			})
+			.catch((error) => {
+				// Log error
+				if (error.response) {
+					this.config.logger.log(
+						'error',
+						error.response.status,
+						'POST',
+						`https://login.${this.config.environment}/oauth/token`,
+						request.headers,
+						error.response.headers,
+						bodyParam,
+						error.response.data
+					);
+				}
+
+				reject(error);
+			});
+
+		});
+	}
+
+	/**
+	 * @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
+	 * @param {number} nChar - code length
+	 */
+	generatePKCECodeVerifier(nChar) {
+		if (nChar < 43 || nChar > 128) {
+			throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
+		}
+		// Check for window
+		if (typeof window === 'undefined') {
+			try {
+				const getRandomValues = require('crypto').getRandomValues;
+				const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
+				let randomString = Array.from(getRandomValues(new Uint32Array(nChar)))
+					.map((x) => unreservedCharacters[x % unreservedCharacters.length])
+					.join('');
+				return randomString;
+			} catch (err) {
+				throw new Error(`Crypto module is missing/not supported.`);
+			}
+		} else {
+			const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
+			let randomString = Array.from(crypto.getRandomValues(new Uint32Array(nChar)))
+				.map((x) => unreservedCharacters[x % unreservedCharacters.length])
+				.join('');
+			return randomString;
+		}
+	}
+
+	/**
+	 * @description Compute Base64Url PKCE Code Challenge from Code Verifier.
+	 * @param {string} code - code verifier used to generate the code challenge
+	 */
+	computePKCECodeChallenge(code) {
+		if (code.length < 43 || code.length > 128) {
+			throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
+		}
+		// Check for window
+		if (typeof window === 'undefined') {
+			// nodejs
+			try {
+				const createHash = require('crypto').createHash;
+				const utf8 = new TextEncoder().encode(code);
+				return new Promise((resolve, reject) => {
+					const hashHex = createHash('sha256').update(utf8).digest();
+					const hashBase64Url = Buffer.from(hashHex).toString('base64url');
+					resolve(hashBase64Url);
+				});
+			} catch (err) {
+				throw new Error(`Crypto module is missing/not supported.`);
+			}
+		} else {
+			// browser
+			const utf8 = new TextEncoder().encode(code);
+			return new Promise((resolve, reject) => {
+				window.crypto.subtle.digest("SHA-256", utf8).then((hashBuffer) => {
+					const hashBase64 = Buffer.from(hashBuffer).toString('base64');
+					let hashBase64Url = hashBase64.replaceAll("+", "-").replaceAll("/", "_");
+					hashBase64Url = hashBase64Url.split("=")[0];
+					resolve(hashBase64Url);
+				})
+				.catch((error) => {
+					// Handle failure
+					return reject(new Error(`Code Challenge Error ${error}`));
+				});
+			});
+		}
+	}
+
+	/**
+    * @description Initiates the pkce auth code grant login flow. Will attempt to load the token from local storage, if enabled.
+    * @param {string} clientId - The client ID of an OAuth Implicit Grant client
+    * @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
+    * @param {object} opts - (optional) Additional options
+    * @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
+    * @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
+    * @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
+    * @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
+    */
+    loginPKCEGrant(clientId, redirectUri, opts, codeVerifier) {
+		// Need Local Storage or non null codeVerifier as parameter
+		if (!this.hasLocalStorage && !codeVerifier) {
+			throw new Error(`loginPKCEGrant requires Local Storage or codeVerifier as input parameter`);
+		}
+        // Check for auth code in query
+        const query = this._setValuesFromUrlQuery();
+
+        this.clientId = clientId;
+        this.redirectUri = redirectUri;
+
+		this.codeVerifier = codeVerifier;
+
+        if (!opts) opts = {};
+
+        return new Promise((resolve, reject) => {
+            // Abort if org and provider are not set together
+            if (opts.org && !opts.provider) {
+                reject(new Error('opts.provider must be set if opts.org is set'));
+            } else if (opts.provider && !opts.org) {
+            	reject(new Error('opts.org must be set if opts.provider is set'));
+            }
+
+            // Abort on auth error
+            if (query && query.error) {
+				// remove codeVerifier from session storage
+				if (this.hasLocalStorage) {
+					sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
+				}
+				// reset access token if any was stored
+				this._saveSettings({ accessToken: undefined });
+                return reject(new Error(`[${query.error}] ${query.error_description}`));
+            }
+
+            // Get token on auth code
+            if (query && query.code) {
+				if (!this.codeVerifier) {
+					// load codeVerifier from session storage
+					if (this.hasLocalStorage) {
+						this.codeVerifier = sessionStorage.getItem(`genesys_cloud_sdk_pkce_code_verifier`);
+					}
+				}
+                this.authorizePKCEGrant(this.clientId, this.codeVerifier, query.code, this.redirectUri)
+                  .then(() => {
+                      // Do authenticated things
+                      this._testTokenAccess()
+                      .then(() => {
+                        if (!this.authData.state && query.state)
+                          this.authData.state = query.state;	
+						// remove codeVerifier from session storage
+						if (this.hasLocalStorage) {
+							sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
+						}
+                        resolve(this.authData);
+                      })
+                      .catch((error) => {
+                        // Handle failure response
+                        this._saveSettings({ accessToken: undefined});
+						// remove codeVerifier from session storage
+						if (this.hasLocalStorage) {
+							sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
+						}
+                        return reject(new Error(`[${error.name}] ${error.msg}`));
+                      });
+                  })
+                  .catch((error) => {
+                    // Handle failure response
+                    this._saveSettings({ accessToken: undefined});
+					// remove codeVerifier from session storage
+					if (this.hasLocalStorage) {
+						sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
+					}
+                    return reject(new Error(`[${error.name}] ${error.msg}`));
+                  });
+            } else {
+                // Test token (if previously stored) and proceed with login
+                this._testTokenAccess()
+                  .then(() => {
+                    if (!this.authData.state && opts.state)
+                      this.authData.state = opts.state;
+                    resolve(this.authData);
+                  })
+                  .catch((error) => {
+					if (!this.codeVerifier) {
+						this.codeVerifier = this.generatePKCECodeVerifier(128);
+						// save codeVerifier in session storage
+						if (this.hasLocalStorage) {
+							sessionStorage.setItem(`genesys_cloud_sdk_pkce_code_verifier`, this.codeVerifier);
+						}
+					}
+                    this.computePKCECodeChallenge(this.codeVerifier)
+					.then((codeChallenge) => {
+                      var tokenQuery = {
+                        client_id: encodeURIComponent(this.clientId),
+                        redirect_uri: encodeURIComponent(this.redirectUri),
+                        code_challenge: encodeURIComponent(codeChallenge),
+                        response_type: 'code',
+                        code_challenge_method: 'S256'
+                      };
+                      if (opts.state) tokenQuery.state = encodeURIComponent(opts.state);
+                      if (opts.org) tokenQuery.org = encodeURIComponent(opts.org);
+                      if (opts.provider) tokenQuery.provider = encodeURIComponent(opts.provider);
+
+                      var url = this._buildAuthUrl('oauth/authorize', tokenQuery);
+                      window.location.replace(url);
+                    })
+                    .catch((err) => {
+                      return reject(new Error(`[${err.name}]`));
+                    });
+                  });
+            }
+		});
+	}
+
+    /**
+    * @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
+    */
+    _setValuesFromUrlQuery() {
+        // Check for window
+        if (!(typeof window !== 'undefined' && window.location.search)) return;
+
+        // Process query string
+        let query = {};
+        let queryParams = new URLSearchParams(window.location.search);
+        let code = queryParams.get('code');
+        let error = queryParams.get('error');
+		let errorDescription = queryParams.get('error_description');
+        let state = queryParams.get('state');
+
+        // Check for error
+        if (error) {
+            query.error = error;
+			if (errorDescription) {
+				query.error_description = errorDescription;
+			}
+            return query;
+        }
+
+        // Everything goes in here because we only want to act if we found an access token
+        if (code) {
+            query.code = code;
+            if (state) {
+				query.state = state;
+            }
+        }
+
+		// Remove code from URL
+		// Credit: https://stackoverflow.com/questions/1397329/how-to-remove-the-hash-from-window-location-with-javascript-without-page-refresh/5298684#5298684
+		var scrollV, scrollH, loc = window.location;
+		if ('replaceState' in history) {
+			history.replaceState('', document.title, loc.pathname);
+		} else {
+			// Prevent scrolling by storing the page's current scroll offset
+			scrollV = document.body.scrollTop;
+			scrollH = document.body.scrollLeft;
+
+			// Remove code
+			history.pushState('', document.title, loc.pathname);
+
+			// Restore the scroll offset, should be flicker free
+			document.body.scrollTop = scrollV;
+			document.body.scrollLeft = scrollH;
+		}
+
+		return query;
+    }
+
 	/**
 	 * @description Initiates the Code Authorization. Only available in node apps.
 	 * @param {string} clientId - The client ID of an OAuth Code Authorization Grant client

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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.0.0
 	 */
 
 	/**

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 184.0.0
+	 * @version 185.0.0
 	 */
 
 	/**
@@ -3252,7 +3252,7 @@ class ArchitectApi {
 
 	/**
 	 * Create a new row entry for the datatable.
-	 * Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema.  The DataTableRow should be a json-ized stream of key -> value pairs {      "Field1": "XYZZY",      "Field2": false,      "KEY": "27272"  }
+	 * Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema.  When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized stream of key -> value pairs {      "Field1": "XYZZY",      "Field2": false,      "KEY": "27272"  }
 	 * @param {String} datatableId id of datatable
 	 * @param {Object.<String, {String: Object}>} dataTableRow 
 	 */
@@ -3744,7 +3744,7 @@ class ArchitectApi {
 
 	/**
 	 * Update a row entry
-	 * Updates a row with the given rowId (the value of the key field) to the new values.  The DataTableRow should be a json-ized stream of key -> value pairs {     "Field1": "XYZZY",     "Field2": false,     "KEY": "27272" }
+	 * Updates a row with the given rowId (the value of the key field) to the new values.  When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized stream of key -> value pairs {     "Field1": "XYZZY",     "Field2": false,     "KEY": "27272" }
 	 * @param {String} datatableId id of datatable
 	 * @param {String} rowId the key for the row
 	 * @param {Object} opts Optional parameters

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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.0.0
 	 */
 
 	/**
@@ -388,7 +388,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 {Object} opts.userCount Fetch the count of users who have this role granted in at least one division. Setting this value or defaulting to 'true' can lead to slower load times or timeouts for role queries with large member counts. (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) { 

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 184.0.0
+	 * @version 185.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class CarrierServicesApi {
 	/**
 	 * CarrierServices service.
 	 * @module purecloud-platform-client-v2/api/CarrierServicesApi
-	 * @version 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.0.0
 	 */
 
 	/**

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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class EmailsApi {
 	/**
 	 * Emails service.
 	 * @module purecloud-platform-client-v2/api/EmailsApi
-	 * @version 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.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 184.0.0
+	 * @version 185.0.0
 	 */
 
 	/**