purecloud-platform-client-v2 184.0.0 → 185.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/README.md +68 -2
  2. package/dist/node/purecloud-platform-client-v2.js +801 -79
  3. package/dist/web-amd/purecloud-platform-client-v2.js +801 -79
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +260 -99
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +260 -99
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +557 -33
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +334 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -3
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +2 -2
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RoutingApi.js +168 -1
  60. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
  71. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +222 -1
  84. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -402,7 +402,7 @@ class Configuration {
402
402
 
403
403
  /**
404
404
  * @module purecloud-platform-client-v2/ApiClient
405
- * @version 184.0.0
405
+ * @version 185.0.0
406
406
  */
407
407
  class ApiClient {
408
408
  /**
@@ -813,6 +813,339 @@ class ApiClient {
813
813
  });
814
814
  }
815
815
 
816
+ /**
817
+ * @description Completes the PKCE Code Authorization.
818
+ * @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
819
+ * @param {string} codeVerifier - code verifier used to generate the code challenge
820
+ * @param {string} authCode - Authorization code
821
+ * @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
822
+ */
823
+ authorizePKCEGrant(clientId, codeVerifier, authCode, redirectUri) {
824
+ this.clientId = clientId;
825
+ return new Promise((resolve, reject) => {
826
+ var request = axios__default["default"]({
827
+ method: `POST`,
828
+ url: `https://login.${this.config.environment}/oauth/token`,
829
+ headers: {
830
+ 'Content-Type': 'application/x-www-form-urlencoded'
831
+ },
832
+ data: qs__default["default"].stringify({ grant_type: 'authorization_code',
833
+ code: authCode,
834
+ code_verifier: codeVerifier,
835
+ client_id: clientId,
836
+ redirect_uri: redirectUri })
837
+ });
838
+
839
+ request.proxy = this.proxy;
840
+ var bodyParam = {
841
+ grant_type: 'authorization_code',
842
+ code: authCode,
843
+ code_verifier: codeVerifier,
844
+ client_id: clientId,
845
+ redirect_uri: redirectUri,
846
+ };
847
+ // Handle response
848
+ request
849
+ .then((response) => {
850
+ // Logging
851
+ this.config.logger.log(
852
+ 'trace',
853
+ response.status,
854
+ 'POST',
855
+ `https://login.${this.config.environment}/oauth/token`,
856
+ request.headers,
857
+ response.headers,
858
+ bodyParam,
859
+ undefined
860
+ );
861
+ this.config.logger.log(
862
+ 'debug',
863
+ response.status,
864
+ 'POST',
865
+ `https://login.${this.config.environment}/oauth/token`,
866
+ request.headers,
867
+ undefined,
868
+ bodyParam,
869
+ undefined
870
+ );
871
+
872
+ // Get access token from response
873
+ var access_token = response.data.access_token;
874
+
875
+ this.setAccessToken(access_token);
876
+ this.authData.tokenExpiryTime = new Date().getTime() + response.data['expires_in'] * 1000;
877
+ this.authData.tokenExpiryTimeString = new Date(this.authData.tokenExpiryTime).toUTCString();
878
+
879
+ // Return auth data
880
+ resolve(this.authData);
881
+ })
882
+ .catch((error) => {
883
+ // Log error
884
+ if (error.response) {
885
+ this.config.logger.log(
886
+ 'error',
887
+ error.response.status,
888
+ 'POST',
889
+ `https://login.${this.config.environment}/oauth/token`,
890
+ request.headers,
891
+ error.response.headers,
892
+ bodyParam,
893
+ error.response.data
894
+ );
895
+ }
896
+
897
+ reject(error);
898
+ });
899
+
900
+ });
901
+ }
902
+
903
+ /**
904
+ * @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
905
+ * @param {number} nChar - code length
906
+ */
907
+ generatePKCECodeVerifier(nChar) {
908
+ if (nChar < 43 || nChar > 128) {
909
+ throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
910
+ }
911
+ // Check for window
912
+ if (typeof window === 'undefined') {
913
+ try {
914
+ const getRandomValues = require('crypto').getRandomValues;
915
+ const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
916
+ let randomString = Array.from(getRandomValues(new Uint32Array(nChar)))
917
+ .map((x) => unreservedCharacters[x % unreservedCharacters.length])
918
+ .join('');
919
+ return randomString;
920
+ } catch (err) {
921
+ throw new Error(`Crypto module is missing/not supported.`);
922
+ }
923
+ } else {
924
+ const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
925
+ let randomString = Array.from(crypto.getRandomValues(new Uint32Array(nChar)))
926
+ .map((x) => unreservedCharacters[x % unreservedCharacters.length])
927
+ .join('');
928
+ return randomString;
929
+ }
930
+ }
931
+
932
+ /**
933
+ * @description Compute Base64Url PKCE Code Challenge from Code Verifier.
934
+ * @param {string} code - code verifier used to generate the code challenge
935
+ */
936
+ computePKCECodeChallenge(code) {
937
+ if (code.length < 43 || code.length > 128) {
938
+ throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
939
+ }
940
+ // Check for window
941
+ if (typeof window === 'undefined') {
942
+ // nodejs
943
+ try {
944
+ const createHash = require('crypto').createHash;
945
+ const utf8 = new TextEncoder().encode(code);
946
+ return new Promise((resolve, reject) => {
947
+ const hashHex = createHash('sha256').update(utf8).digest();
948
+ const hashBase64Url = Buffer.from(hashHex).toString('base64url');
949
+ resolve(hashBase64Url);
950
+ });
951
+ } catch (err) {
952
+ throw new Error(`Crypto module is missing/not supported.`);
953
+ }
954
+ } else {
955
+ // browser
956
+ const utf8 = new TextEncoder().encode(code);
957
+ return new Promise((resolve, reject) => {
958
+ window.crypto.subtle.digest("SHA-256", utf8).then((hashBuffer) => {
959
+ const hashBase64 = Buffer.from(hashBuffer).toString('base64');
960
+ let hashBase64Url = hashBase64.replaceAll("+", "-").replaceAll("/", "_");
961
+ hashBase64Url = hashBase64Url.split("=")[0];
962
+ resolve(hashBase64Url);
963
+ })
964
+ .catch((error) => {
965
+ // Handle failure
966
+ return reject(new Error(`Code Challenge Error ${error}`));
967
+ });
968
+ });
969
+ }
970
+ }
971
+
972
+ /**
973
+ * @description Initiates the pkce auth code grant login flow. Will attempt to load the token from local storage, if enabled.
974
+ * @param {string} clientId - The client ID of an OAuth Implicit Grant client
975
+ * @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
976
+ * @param {object} opts - (optional) Additional options
977
+ * @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.
978
+ * @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.
979
+ * @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.
980
+ * @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
981
+ */
982
+ loginPKCEGrant(clientId, redirectUri, opts, codeVerifier) {
983
+ // Need Local Storage or non null codeVerifier as parameter
984
+ if (!this.hasLocalStorage && !codeVerifier) {
985
+ throw new Error(`loginPKCEGrant requires Local Storage or codeVerifier as input parameter`);
986
+ }
987
+ // Check for auth code in query
988
+ const query = this._setValuesFromUrlQuery();
989
+
990
+ this.clientId = clientId;
991
+ this.redirectUri = redirectUri;
992
+
993
+ this.codeVerifier = codeVerifier;
994
+
995
+ if (!opts) opts = {};
996
+
997
+ return new Promise((resolve, reject) => {
998
+ // Abort if org and provider are not set together
999
+ if (opts.org && !opts.provider) {
1000
+ reject(new Error('opts.provider must be set if opts.org is set'));
1001
+ } else if (opts.provider && !opts.org) {
1002
+ reject(new Error('opts.org must be set if opts.provider is set'));
1003
+ }
1004
+
1005
+ // Abort on auth error
1006
+ if (query && query.error) {
1007
+ // remove codeVerifier from session storage
1008
+ if (this.hasLocalStorage) {
1009
+ sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
1010
+ }
1011
+ // reset access token if any was stored
1012
+ this._saveSettings({ accessToken: undefined });
1013
+ return reject(new Error(`[${query.error}] ${query.error_description}`));
1014
+ }
1015
+
1016
+ // Get token on auth code
1017
+ if (query && query.code) {
1018
+ if (!this.codeVerifier) {
1019
+ // load codeVerifier from session storage
1020
+ if (this.hasLocalStorage) {
1021
+ this.codeVerifier = sessionStorage.getItem(`genesys_cloud_sdk_pkce_code_verifier`);
1022
+ }
1023
+ }
1024
+ this.authorizePKCEGrant(this.clientId, this.codeVerifier, query.code, this.redirectUri)
1025
+ .then(() => {
1026
+ // Do authenticated things
1027
+ this._testTokenAccess()
1028
+ .then(() => {
1029
+ if (!this.authData.state && query.state)
1030
+ this.authData.state = query.state;
1031
+ // remove codeVerifier from session storage
1032
+ if (this.hasLocalStorage) {
1033
+ sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
1034
+ }
1035
+ resolve(this.authData);
1036
+ })
1037
+ .catch((error) => {
1038
+ // Handle failure response
1039
+ this._saveSettings({ accessToken: undefined});
1040
+ // remove codeVerifier from session storage
1041
+ if (this.hasLocalStorage) {
1042
+ sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
1043
+ }
1044
+ return reject(new Error(`[${error.name}] ${error.msg}`));
1045
+ });
1046
+ })
1047
+ .catch((error) => {
1048
+ // Handle failure response
1049
+ this._saveSettings({ accessToken: undefined});
1050
+ // remove codeVerifier from session storage
1051
+ if (this.hasLocalStorage) {
1052
+ sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
1053
+ }
1054
+ return reject(new Error(`[${error.name}] ${error.msg}`));
1055
+ });
1056
+ } else {
1057
+ // Test token (if previously stored) and proceed with login
1058
+ this._testTokenAccess()
1059
+ .then(() => {
1060
+ if (!this.authData.state && opts.state)
1061
+ this.authData.state = opts.state;
1062
+ resolve(this.authData);
1063
+ })
1064
+ .catch((error) => {
1065
+ if (!this.codeVerifier) {
1066
+ this.codeVerifier = this.generatePKCECodeVerifier(128);
1067
+ // save codeVerifier in session storage
1068
+ if (this.hasLocalStorage) {
1069
+ sessionStorage.setItem(`genesys_cloud_sdk_pkce_code_verifier`, this.codeVerifier);
1070
+ }
1071
+ }
1072
+ this.computePKCECodeChallenge(this.codeVerifier)
1073
+ .then((codeChallenge) => {
1074
+ var tokenQuery = {
1075
+ client_id: encodeURIComponent(this.clientId),
1076
+ redirect_uri: encodeURIComponent(this.redirectUri),
1077
+ code_challenge: encodeURIComponent(codeChallenge),
1078
+ response_type: 'code',
1079
+ code_challenge_method: 'S256'
1080
+ };
1081
+ if (opts.state) tokenQuery.state = encodeURIComponent(opts.state);
1082
+ if (opts.org) tokenQuery.org = encodeURIComponent(opts.org);
1083
+ if (opts.provider) tokenQuery.provider = encodeURIComponent(opts.provider);
1084
+
1085
+ var url = this._buildAuthUrl('oauth/authorize', tokenQuery);
1086
+ window.location.replace(url);
1087
+ })
1088
+ .catch((err) => {
1089
+ return reject(new Error(`[${err.name}]`));
1090
+ });
1091
+ });
1092
+ }
1093
+ });
1094
+ }
1095
+
1096
+ /**
1097
+ * @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
1098
+ */
1099
+ _setValuesFromUrlQuery() {
1100
+ // Check for window
1101
+ if (!(typeof window !== 'undefined' && window.location.search)) return;
1102
+
1103
+ // Process query string
1104
+ let query = {};
1105
+ let queryParams = new URLSearchParams(window.location.search);
1106
+ let code = queryParams.get('code');
1107
+ let error = queryParams.get('error');
1108
+ let errorDescription = queryParams.get('error_description');
1109
+ let state = queryParams.get('state');
1110
+
1111
+ // Check for error
1112
+ if (error) {
1113
+ query.error = error;
1114
+ if (errorDescription) {
1115
+ query.error_description = errorDescription;
1116
+ }
1117
+ return query;
1118
+ }
1119
+
1120
+ // Everything goes in here because we only want to act if we found an access token
1121
+ if (code) {
1122
+ query.code = code;
1123
+ if (state) {
1124
+ query.state = state;
1125
+ }
1126
+ }
1127
+
1128
+ // Remove code from URL
1129
+ // Credit: https://stackoverflow.com/questions/1397329/how-to-remove-the-hash-from-window-location-with-javascript-without-page-refresh/5298684#5298684
1130
+ var scrollV, scrollH, loc = window.location;
1131
+ if ('replaceState' in history) {
1132
+ history.replaceState('', document.title, loc.pathname);
1133
+ } else {
1134
+ // Prevent scrolling by storing the page's current scroll offset
1135
+ scrollV = document.body.scrollTop;
1136
+ scrollH = document.body.scrollLeft;
1137
+
1138
+ // Remove code
1139
+ history.pushState('', document.title, loc.pathname);
1140
+
1141
+ // Restore the scroll offset, should be flicker free
1142
+ document.body.scrollTop = scrollV;
1143
+ document.body.scrollLeft = scrollH;
1144
+ }
1145
+
1146
+ return query;
1147
+ }
1148
+
816
1149
  /**
817
1150
  * @description Initiates the Code Authorization. Only available in node apps.
818
1151
  * @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
@@ -1488,7 +1821,7 @@ class AlertingApi {
1488
1821
  /**
1489
1822
  * Alerting service.
1490
1823
  * @module purecloud-platform-client-v2/api/AlertingApi
1491
- * @version 184.0.0
1824
+ * @version 185.0.0
1492
1825
  */
1493
1826
 
1494
1827
  /**
@@ -2149,7 +2482,7 @@ class AnalyticsApi {
2149
2482
  /**
2150
2483
  * Analytics service.
2151
2484
  * @module purecloud-platform-client-v2/api/AnalyticsApi
2152
- * @version 184.0.0
2485
+ * @version 185.0.0
2153
2486
  */
2154
2487
 
2155
2488
  /**
@@ -4739,7 +5072,7 @@ class ArchitectApi {
4739
5072
  /**
4740
5073
  * Architect service.
4741
5074
  * @module purecloud-platform-client-v2/api/ArchitectApi
4742
- * @version 184.0.0
5075
+ * @version 185.0.0
4743
5076
  */
4744
5077
 
4745
5078
  /**
@@ -7986,7 +8319,7 @@ class ArchitectApi {
7986
8319
 
7987
8320
  /**
7988
8321
  * Create a new row entry for the datatable.
7989
- * 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" }
8322
+ * 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" }
7990
8323
  * @param {String} datatableId id of datatable
7991
8324
  * @param {Object.<String, {String: Object}>} dataTableRow
7992
8325
  */
@@ -8478,7 +8811,7 @@ class ArchitectApi {
8478
8811
 
8479
8812
  /**
8480
8813
  * Update a row entry
8481
- * 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" }
8814
+ * 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" }
8482
8815
  * @param {String} datatableId id of datatable
8483
8816
  * @param {String} rowId the key for the row
8484
8817
  * @param {Object} opts Optional parameters
@@ -8574,7 +8907,7 @@ class AuditApi {
8574
8907
  /**
8575
8908
  * Audit service.
8576
8909
  * @module purecloud-platform-client-v2/api/AuditApi
8577
- * @version 184.0.0
8910
+ * @version 185.0.0
8578
8911
  */
8579
8912
 
8580
8913
  /**
@@ -8745,7 +9078,7 @@ class AuthorizationApi {
8745
9078
  /**
8746
9079
  * Authorization service.
8747
9080
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8748
- * @version 184.0.0
9081
+ * @version 185.0.0
8749
9082
  */
8750
9083
 
8751
9084
  /**
@@ -9128,7 +9461,7 @@ class AuthorizationApi {
9128
9461
  * Get the organization role specified by its ID.
9129
9462
  * @param {String} roleId Role ID
9130
9463
  * @param {Object} opts Optional parameters
9131
- * @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division (default to true)
9464
+ * @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)
9132
9465
  * @param {Array.<String>} opts.expand Which fields, if any, to expand. unusedPermissions returns the permissions not used for the role
9133
9466
  */
9134
9467
  getAuthorizationRole(roleId, opts) {
@@ -9975,7 +10308,7 @@ class BillingApi {
9975
10308
  /**
9976
10309
  * Billing service.
9977
10310
  * @module purecloud-platform-client-v2/api/BillingApi
9978
- * @version 184.0.0
10311
+ * @version 185.0.0
9979
10312
  */
9980
10313
 
9981
10314
  /**
@@ -10055,7 +10388,7 @@ class CarrierServicesApi {
10055
10388
  /**
10056
10389
  * CarrierServices service.
10057
10390
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
10058
- * @version 184.0.0
10391
+ * @version 185.0.0
10059
10392
  */
10060
10393
 
10061
10394
  /**
@@ -10125,7 +10458,7 @@ class ChatApi {
10125
10458
  /**
10126
10459
  * Chat service.
10127
10460
  * @module purecloud-platform-client-v2/api/ChatApi
10128
- * @version 184.0.0
10461
+ * @version 185.0.0
10129
10462
  */
10130
10463
 
10131
10464
  /**
@@ -10821,7 +11154,7 @@ class CoachingApi {
10821
11154
  /**
10822
11155
  * Coaching service.
10823
11156
  * @module purecloud-platform-client-v2/api/CoachingApi
10824
- * @version 184.0.0
11157
+ * @version 185.0.0
10825
11158
  */
10826
11159
 
10827
11160
  /**
@@ -11398,7 +11731,7 @@ class ContentManagementApi {
11398
11731
  /**
11399
11732
  * ContentManagement service.
11400
11733
  * @module purecloud-platform-client-v2/api/ContentManagementApi
11401
- * @version 184.0.0
11734
+ * @version 185.0.0
11402
11735
  */
11403
11736
 
11404
11737
  /**
@@ -12541,7 +12874,7 @@ class ConversationsApi {
12541
12874
  /**
12542
12875
  * Conversations service.
12543
12876
  * @module purecloud-platform-client-v2/api/ConversationsApi
12544
- * @version 184.0.0
12877
+ * @version 185.0.0
12545
12878
  */
12546
12879
 
12547
12880
  /**
@@ -19681,7 +20014,7 @@ class DataExtensionsApi {
19681
20014
  /**
19682
20015
  * DataExtensions service.
19683
20016
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
19684
- * @version 184.0.0
20017
+ * @version 185.0.0
19685
20018
  */
19686
20019
 
19687
20020
  /**
@@ -19767,7 +20100,7 @@ class DownloadsApi {
19767
20100
  /**
19768
20101
  * Downloads service.
19769
20102
  * @module purecloud-platform-client-v2/api/DownloadsApi
19770
- * @version 184.0.0
20103
+ * @version 185.0.0
19771
20104
  */
19772
20105
 
19773
20106
  /**
@@ -19819,7 +20152,7 @@ class EmailsApi {
19819
20152
  /**
19820
20153
  * Emails service.
19821
20154
  * @module purecloud-platform-client-v2/api/EmailsApi
19822
- * @version 184.0.0
20155
+ * @version 185.0.0
19823
20156
  */
19824
20157
 
19825
20158
  /**
@@ -19884,7 +20217,7 @@ class EventsApi {
19884
20217
  /**
19885
20218
  * Events service.
19886
20219
  * @module purecloud-platform-client-v2/api/EventsApi
19887
- * @version 184.0.0
20220
+ * @version 185.0.0
19888
20221
  */
19889
20222
 
19890
20223
  /**
@@ -19980,7 +20313,7 @@ class ExternalContactsApi {
19980
20313
  /**
19981
20314
  * ExternalContacts service.
19982
20315
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
19983
- * @version 184.0.0
20316
+ * @version 185.0.0
19984
20317
  */
19985
20318
 
19986
20319
  /**
@@ -21938,7 +22271,7 @@ class FaxApi {
21938
22271
  /**
21939
22272
  * Fax service.
21940
22273
  * @module purecloud-platform-client-v2/api/FaxApi
21941
- * @version 184.0.0
22274
+ * @version 185.0.0
21942
22275
  */
21943
22276
 
21944
22277
  /**
@@ -22109,7 +22442,7 @@ class FlowsApi {
22109
22442
  /**
22110
22443
  * Flows service.
22111
22444
  * @module purecloud-platform-client-v2/api/FlowsApi
22112
- * @version 184.0.0
22445
+ * @version 185.0.0
22113
22446
  */
22114
22447
 
22115
22448
  /**
@@ -22293,7 +22626,7 @@ class GamificationApi {
22293
22626
  /**
22294
22627
  * Gamification service.
22295
22628
  * @module purecloud-platform-client-v2/api/GamificationApi
22296
- * @version 184.0.0
22629
+ * @version 185.0.0
22297
22630
  */
22298
22631
 
22299
22632
  /**
@@ -24379,7 +24712,7 @@ class GeneralDataProtectionRegulationApi {
24379
24712
  /**
24380
24713
  * GeneralDataProtectionRegulation service.
24381
24714
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
24382
- * @version 184.0.0
24715
+ * @version 185.0.0
24383
24716
  */
24384
24717
 
24385
24718
  /**
@@ -24509,7 +24842,7 @@ class GeolocationApi {
24509
24842
  /**
24510
24843
  * Geolocation service.
24511
24844
  * @module purecloud-platform-client-v2/api/GeolocationApi
24512
- * @version 184.0.0
24845
+ * @version 185.0.0
24513
24846
  */
24514
24847
 
24515
24848
  /**
@@ -24640,7 +24973,7 @@ class GreetingsApi {
24640
24973
  /**
24641
24974
  * Greetings service.
24642
24975
  * @module purecloud-platform-client-v2/api/GreetingsApi
24643
- * @version 184.0.0
24976
+ * @version 185.0.0
24644
24977
  */
24645
24978
 
24646
24979
  /**
@@ -25095,7 +25428,7 @@ class GroupsApi {
25095
25428
  /**
25096
25429
  * Groups service.
25097
25430
  * @module purecloud-platform-client-v2/api/GroupsApi
25098
- * @version 184.0.0
25431
+ * @version 185.0.0
25099
25432
  */
25100
25433
 
25101
25434
  /**
@@ -25614,7 +25947,7 @@ class IdentityProviderApi {
25614
25947
  /**
25615
25948
  * IdentityProvider service.
25616
25949
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
25617
- * @version 184.0.0
25950
+ * @version 185.0.0
25618
25951
  */
25619
25952
 
25620
25953
  /**
@@ -26370,7 +26703,7 @@ class InfrastructureAsCodeApi {
26370
26703
  /**
26371
26704
  * InfrastructureAsCode service.
26372
26705
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
26373
- * @version 184.0.0
26706
+ * @version 185.0.0
26374
26707
  */
26375
26708
 
26376
26709
  /**
@@ -26537,7 +26870,7 @@ class IntegrationsApi {
26537
26870
  /**
26538
26871
  * Integrations service.
26539
26872
  * @module purecloud-platform-client-v2/api/IntegrationsApi
26540
- * @version 184.0.0
26873
+ * @version 185.0.0
26541
26874
  */
26542
26875
 
26543
26876
  /**
@@ -28499,7 +28832,7 @@ class JourneyApi {
28499
28832
  /**
28500
28833
  * Journey service.
28501
28834
  * @module purecloud-platform-client-v2/api/JourneyApi
28502
- * @version 184.0.0
28835
+ * @version 185.0.0
28503
28836
  */
28504
28837
 
28505
28838
  /**
@@ -29730,7 +30063,7 @@ class KnowledgeApi {
29730
30063
  /**
29731
30064
  * Knowledge service.
29732
30065
  * @module purecloud-platform-client-v2/api/KnowledgeApi
29733
- * @version 184.0.0
30066
+ * @version 185.0.0
29734
30067
  */
29735
30068
 
29736
30069
  /**
@@ -32551,7 +32884,7 @@ class LanguageUnderstandingApi {
32551
32884
  /**
32552
32885
  * LanguageUnderstanding service.
32553
32886
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
32554
- * @version 184.0.0
32887
+ * @version 185.0.0
32555
32888
  */
32556
32889
 
32557
32890
  /**
@@ -33564,7 +33897,7 @@ class LanguagesApi {
33564
33897
  /**
33565
33898
  * Languages service.
33566
33899
  * @module purecloud-platform-client-v2/api/LanguagesApi
33567
- * @version 184.0.0
33900
+ * @version 185.0.0
33568
33901
  */
33569
33902
 
33570
33903
  /**
@@ -33786,7 +34119,7 @@ class LearningApi {
33786
34119
  /**
33787
34120
  * Learning service.
33788
34121
  * @module purecloud-platform-client-v2/api/LearningApi
33789
- * @version 184.0.0
34122
+ * @version 185.0.0
33790
34123
  */
33791
34124
 
33792
34125
  /**
@@ -34642,7 +34975,7 @@ class LicenseApi {
34642
34975
  /**
34643
34976
  * License service.
34644
34977
  * @module purecloud-platform-client-v2/api/LicenseApi
34645
- * @version 184.0.0
34978
+ * @version 185.0.0
34646
34979
  */
34647
34980
 
34648
34981
  /**
@@ -34880,7 +35213,7 @@ class LocationsApi {
34880
35213
  /**
34881
35214
  * Locations service.
34882
35215
  * @module purecloud-platform-client-v2/api/LocationsApi
34883
- * @version 184.0.0
35216
+ * @version 185.0.0
34884
35217
  */
34885
35218
 
34886
35219
  /**
@@ -35116,7 +35449,7 @@ class LogCaptureApi {
35116
35449
  /**
35117
35450
  * LogCapture service.
35118
35451
  * @module purecloud-platform-client-v2/api/LogCaptureApi
35119
- * @version 184.0.0
35452
+ * @version 185.0.0
35120
35453
  */
35121
35454
 
35122
35455
  /**
@@ -35186,7 +35519,7 @@ class MessagingApi {
35186
35519
  /**
35187
35520
  * Messaging service.
35188
35521
  * @module purecloud-platform-client-v2/api/MessagingApi
35189
- * @version 184.0.0
35522
+ * @version 185.0.0
35190
35523
  */
35191
35524
 
35192
35525
  /**
@@ -35545,7 +35878,7 @@ class MobileDevicesApi {
35545
35878
  /**
35546
35879
  * MobileDevices service.
35547
35880
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
35548
- * @version 184.0.0
35881
+ * @version 185.0.0
35549
35882
  */
35550
35883
 
35551
35884
  /**
@@ -35696,7 +36029,7 @@ class NotificationsApi {
35696
36029
  /**
35697
36030
  * Notifications service.
35698
36031
  * @module purecloud-platform-client-v2/api/NotificationsApi
35699
- * @version 184.0.0
36032
+ * @version 185.0.0
35700
36033
  */
35701
36034
 
35702
36035
  /**
@@ -35929,7 +36262,7 @@ class OAuthApi {
35929
36262
  /**
35930
36263
  * OAuth service.
35931
36264
  * @module purecloud-platform-client-v2/api/OAuthApi
35932
- * @version 184.0.0
36265
+ * @version 185.0.0
35933
36266
  */
35934
36267
 
35935
36268
  /**
@@ -36295,7 +36628,7 @@ class ObjectsApi {
36295
36628
  /**
36296
36629
  * Objects service.
36297
36630
  * @module purecloud-platform-client-v2/api/ObjectsApi
36298
- * @version 184.0.0
36631
+ * @version 185.0.0
36299
36632
  */
36300
36633
 
36301
36634
  /**
@@ -36565,7 +36898,7 @@ class OperationalEventsApi {
36565
36898
  /**
36566
36899
  * OperationalEvents service.
36567
36900
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
36568
- * @version 184.0.0
36901
+ * @version 185.0.0
36569
36902
  */
36570
36903
 
36571
36904
  /**
@@ -36631,7 +36964,7 @@ class OrganizationApi {
36631
36964
  /**
36632
36965
  * Organization service.
36633
36966
  * @module purecloud-platform-client-v2/api/OrganizationApi
36634
- * @version 184.0.0
36967
+ * @version 185.0.0
36635
36968
  */
36636
36969
 
36637
36970
  /**
@@ -37086,7 +37419,7 @@ class OrganizationAuthorizationApi {
37086
37419
  /**
37087
37420
  * OrganizationAuthorization service.
37088
37421
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
37089
- * @version 184.0.0
37422
+ * @version 185.0.0
37090
37423
  */
37091
37424
 
37092
37425
  /**
@@ -38433,7 +38766,7 @@ class OutboundApi {
38433
38766
  /**
38434
38767
  * Outbound service.
38435
38768
  * @module purecloud-platform-client-v2/api/OutboundApi
38436
- * @version 184.0.0
38769
+ * @version 185.0.0
38437
38770
  */
38438
38771
 
38439
38772
  /**
@@ -42455,7 +42788,7 @@ class PresenceApi {
42455
42788
  /**
42456
42789
  * Presence service.
42457
42790
  * @module purecloud-platform-client-v2/api/PresenceApi
42458
- * @version 184.0.0
42791
+ * @version 185.0.0
42459
42792
  */
42460
42793
 
42461
42794
  /**
@@ -43194,7 +43527,7 @@ class ProcessAutomationApi {
43194
43527
  /**
43195
43528
  * ProcessAutomation service.
43196
43529
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
43197
- * @version 184.0.0
43530
+ * @version 185.0.0
43198
43531
  */
43199
43532
 
43200
43533
  /**
@@ -43433,7 +43766,7 @@ class QualityApi {
43433
43766
  /**
43434
43767
  * Quality service.
43435
43768
  * @module purecloud-platform-client-v2/api/QualityApi
43436
- * @version 184.0.0
43769
+ * @version 185.0.0
43437
43770
  */
43438
43771
 
43439
43772
  /**
@@ -45190,7 +45523,7 @@ class RecordingApi {
45190
45523
  /**
45191
45524
  * Recording service.
45192
45525
  * @module purecloud-platform-client-v2/api/RecordingApi
45193
- * @version 184.0.0
45526
+ * @version 185.0.0
45194
45527
  */
45195
45528
 
45196
45529
  /**
@@ -46827,7 +47160,7 @@ class ResponseManagementApi {
46827
47160
  /**
46828
47161
  * ResponseManagement service.
46829
47162
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
46830
- * @version 184.0.0
47163
+ * @version 185.0.0
46831
47164
  */
46832
47165
 
46833
47166
  /**
@@ -47312,7 +47645,7 @@ class RoutingApi {
47312
47645
  /**
47313
47646
  * Routing service.
47314
47647
  * @module purecloud-platform-client-v2/api/RoutingApi
47315
- * @version 184.0.0
47648
+ * @version 185.0.0
47316
47649
  */
47317
47650
 
47318
47651
  /**
@@ -47767,6 +48100,36 @@ class RoutingApi {
47767
48100
  );
47768
48101
  }
47769
48102
 
48103
+ /**
48104
+ * Delete a utilization label
48105
+ *
48106
+ * @param {String} labelId Utilization Label ID
48107
+ * @param {Object} opts Optional parameters
48108
+ * @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
48109
+ * deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
48110
+ */
48111
+ deleteRoutingUtilizationLabel(labelId, opts) {
48112
+ opts = opts || {};
48113
+
48114
+ // verify the required parameter 'labelId' is set
48115
+ if (labelId === undefined || labelId === null) {
48116
+ throw 'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';
48117
+ }
48118
+
48119
+ return this.apiClient.callApi(
48120
+ '/api/v2/routing/utilization/labels/{labelId}',
48121
+ 'DELETE',
48122
+ { 'labelId': labelId },
48123
+ { 'forceDelete': opts['forceDelete'] },
48124
+ { },
48125
+ { },
48126
+ null,
48127
+ ['PureCloud OAuth'],
48128
+ ['application/json'],
48129
+ ['application/json']
48130
+ );
48131
+ }
48132
+
47770
48133
  /**
47771
48134
  * Delete an utilization tag
47772
48135
  *
@@ -49257,6 +49620,86 @@ class RoutingApi {
49257
49620
  );
49258
49621
  }
49259
49622
 
49623
+ /**
49624
+ * Get details about this utilization label
49625
+ *
49626
+ * @param {String} labelId Utilization Label ID
49627
+ * getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49628
+ */
49629
+ getRoutingUtilizationLabel(labelId) {
49630
+ // verify the required parameter 'labelId' is set
49631
+ if (labelId === undefined || labelId === null) {
49632
+ throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';
49633
+ }
49634
+
49635
+ return this.apiClient.callApi(
49636
+ '/api/v2/routing/utilization/labels/{labelId}',
49637
+ 'GET',
49638
+ { 'labelId': labelId },
49639
+ { },
49640
+ { },
49641
+ { },
49642
+ null,
49643
+ ['PureCloud OAuth'],
49644
+ ['application/json'],
49645
+ ['application/json']
49646
+ );
49647
+ }
49648
+
49649
+ /**
49650
+ * Get list of agent ids associated with a utilization label
49651
+ *
49652
+ * @param {String} labelId Utilization Label ID
49653
+ * getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49654
+ */
49655
+ getRoutingUtilizationLabelAgents(labelId) {
49656
+ // verify the required parameter 'labelId' is set
49657
+ if (labelId === undefined || labelId === null) {
49658
+ throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';
49659
+ }
49660
+
49661
+ return this.apiClient.callApi(
49662
+ '/api/v2/routing/utilization/labels/{labelId}/agents',
49663
+ 'GET',
49664
+ { 'labelId': labelId },
49665
+ { },
49666
+ { },
49667
+ { },
49668
+ null,
49669
+ ['PureCloud OAuth'],
49670
+ ['application/json'],
49671
+ ['application/json']
49672
+ );
49673
+ }
49674
+
49675
+ /**
49676
+ * Get list of utilization labels
49677
+ *
49678
+ * @param {Object} opts Optional parameters
49679
+ * @param {Number} opts.pageSize Page size (default to 25)
49680
+ * @param {Number} opts.pageNumber Page number (default to 1)
49681
+ * @param {Object} opts.sortOrder Sort order by name (default to ascending)
49682
+ * @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
49683
+ * getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49684
+ */
49685
+ getRoutingUtilizationLabels(opts) {
49686
+ opts = opts || {};
49687
+
49688
+
49689
+ return this.apiClient.callApi(
49690
+ '/api/v2/routing/utilization/labels',
49691
+ 'GET',
49692
+ { },
49693
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
49694
+ { },
49695
+ { },
49696
+ null,
49697
+ ['PureCloud OAuth'],
49698
+ ['application/json'],
49699
+ ['application/json']
49700
+ );
49701
+ }
49702
+
49260
49703
  /**
49261
49704
  * Get details about this utilization tag
49262
49705
  *
@@ -50553,6 +50996,32 @@ class RoutingApi {
50553
50996
  );
50554
50997
  }
50555
50998
 
50999
+ /**
51000
+ * Create a utilization label
51001
+ *
51002
+ * @param {Object} body UtilizationLabel
51003
+ * postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51004
+ */
51005
+ postRoutingUtilizationLabels(body) {
51006
+ // verify the required parameter 'body' is set
51007
+ if (body === undefined || body === null) {
51008
+ throw 'Missing the required parameter "body" when calling postRoutingUtilizationLabels';
51009
+ }
51010
+
51011
+ return this.apiClient.callApi(
51012
+ '/api/v2/routing/utilization/labels',
51013
+ 'POST',
51014
+ { },
51015
+ { },
51016
+ { },
51017
+ { },
51018
+ body,
51019
+ ['PureCloud OAuth'],
51020
+ ['application/json'],
51021
+ ['application/json']
51022
+ );
51023
+ }
51024
+
50556
51025
  /**
50557
51026
  * Create an utilization tag
50558
51027
  *
@@ -50919,6 +51388,37 @@ class RoutingApi {
50919
51388
  );
50920
51389
  }
50921
51390
 
51391
+ /**
51392
+ * Update a utilization label
51393
+ *
51394
+ * @param {String} labelId Utilization Label ID
51395
+ * @param {Object} body UtilizationLabel
51396
+ * putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51397
+ */
51398
+ putRoutingUtilizationLabel(labelId, body) {
51399
+ // verify the required parameter 'labelId' is set
51400
+ if (labelId === undefined || labelId === null) {
51401
+ throw 'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';
51402
+ }
51403
+ // verify the required parameter 'body' is set
51404
+ if (body === undefined || body === null) {
51405
+ throw 'Missing the required parameter "body" when calling putRoutingUtilizationLabel';
51406
+ }
51407
+
51408
+ return this.apiClient.callApi(
51409
+ '/api/v2/routing/utilization/labels/{labelId}',
51410
+ 'PUT',
51411
+ { 'labelId': labelId },
51412
+ { },
51413
+ { },
51414
+ { },
51415
+ body,
51416
+ ['PureCloud OAuth'],
51417
+ ['application/json'],
51418
+ ['application/json']
51419
+ );
51420
+ }
51421
+
50922
51422
  /**
50923
51423
  * Update wrap-up code
50924
51424
  *
@@ -51020,7 +51520,7 @@ class SCIMApi {
51020
51520
  /**
51021
51521
  * SCIM service.
51022
51522
  * @module purecloud-platform-client-v2/api/SCIMApi
51023
- * @version 184.0.0
51523
+ * @version 185.0.0
51024
51524
  */
51025
51525
 
51026
51526
  /**
@@ -51897,7 +52397,7 @@ class ScriptsApi {
51897
52397
  /**
51898
52398
  * Scripts service.
51899
52399
  * @module purecloud-platform-client-v2/api/ScriptsApi
51900
- * @version 184.0.0
52400
+ * @version 185.0.0
51901
52401
  */
51902
52402
 
51903
52403
  /**
@@ -52341,7 +52841,7 @@ class SearchApi {
52341
52841
  /**
52342
52842
  * Search service.
52343
52843
  * @module purecloud-platform-client-v2/api/SearchApi
52344
- * @version 184.0.0
52844
+ * @version 185.0.0
52345
52845
  */
52346
52846
 
52347
52847
  /**
@@ -53030,7 +53530,7 @@ class SettingsApi {
53030
53530
  /**
53031
53531
  * Settings service.
53032
53532
  * @module purecloud-platform-client-v2/api/SettingsApi
53033
- * @version 184.0.0
53533
+ * @version 185.0.0
53034
53534
  */
53035
53535
 
53036
53536
  /**
@@ -53095,7 +53595,7 @@ class SpeechTextAnalyticsApi {
53095
53595
  /**
53096
53596
  * SpeechTextAnalytics service.
53097
53597
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
53098
- * @version 184.0.0
53598
+ * @version 185.0.0
53099
53599
  */
53100
53600
 
53101
53601
  /**
@@ -54208,7 +54708,7 @@ class StationsApi {
54208
54708
  /**
54209
54709
  * Stations service.
54210
54710
  * @module purecloud-platform-client-v2/api/StationsApi
54211
- * @version 184.0.0
54711
+ * @version 185.0.0
54212
54712
  */
54213
54713
 
54214
54714
  /**
@@ -54310,7 +54810,7 @@ class SuggestApi {
54310
54810
  /**
54311
54811
  * Suggest service.
54312
54812
  * @module purecloud-platform-client-v2/api/SuggestApi
54313
- * @version 184.0.0
54813
+ * @version 185.0.0
54314
54814
  */
54315
54815
 
54316
54816
  /**
@@ -54449,7 +54949,7 @@ class TaskManagementApi {
54449
54949
  /**
54450
54950
  * TaskManagement service.
54451
54951
  * @module purecloud-platform-client-v2/api/TaskManagementApi
54452
- * @version 184.0.0
54952
+ * @version 185.0.0
54453
54953
  */
54454
54954
 
54455
54955
  /**
@@ -55730,7 +56230,7 @@ class TeamsApi {
55730
56230
  /**
55731
56231
  * Teams service.
55732
56232
  * @module purecloud-platform-client-v2/api/TeamsApi
55733
- * @version 184.0.0
56233
+ * @version 185.0.0
55734
56234
  */
55735
56235
 
55736
56236
  /**
@@ -56032,7 +56532,7 @@ class TelephonyApi {
56032
56532
  /**
56033
56533
  * Telephony service.
56034
56534
  * @module purecloud-platform-client-v2/api/TelephonyApi
56035
- * @version 184.0.0
56535
+ * @version 185.0.0
56036
56536
  */
56037
56537
 
56038
56538
  /**
@@ -56216,7 +56716,7 @@ class TelephonyProvidersEdgeApi {
56216
56716
  /**
56217
56717
  * TelephonyProvidersEdge service.
56218
56718
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
56219
- * @version 184.0.0
56719
+ * @version 185.0.0
56220
56720
  */
56221
56721
 
56222
56722
  /**
@@ -56984,8 +57484,9 @@ class TelephonyProvidersEdgeApi {
56984
57484
  }
56985
57485
 
56986
57486
  /**
56987
- * Get the list of available languages.
57487
+ * Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
56988
57488
  *
57489
+ * @deprecated
56989
57490
  */
56990
57491
  getTelephonyProvidersEdgesAvailablelanguages() {
56991
57492
 
@@ -59590,7 +60091,7 @@ class TextbotsApi {
59590
60091
  /**
59591
60092
  * Textbots service.
59592
60093
  * @module purecloud-platform-client-v2/api/TextbotsApi
59593
- * @version 184.0.0
60094
+ * @version 185.0.0
59594
60095
  */
59595
60096
 
59596
60097
  /**
@@ -59718,7 +60219,7 @@ class TokensApi {
59718
60219
  /**
59719
60220
  * Tokens service.
59720
60221
  * @module purecloud-platform-client-v2/api/TokensApi
59721
- * @version 184.0.0
60222
+ * @version 185.0.0
59722
60223
  */
59723
60224
 
59724
60225
  /**
@@ -59874,7 +60375,7 @@ class UploadsApi {
59874
60375
  /**
59875
60376
  * Uploads service.
59876
60377
  * @module purecloud-platform-client-v2/api/UploadsApi
59877
- * @version 184.0.0
60378
+ * @version 185.0.0
59878
60379
  */
59879
60380
 
59880
60381
  /**
@@ -60050,7 +60551,7 @@ class UsageApi {
60050
60551
  /**
60051
60552
  * Usage service.
60052
60553
  * @module purecloud-platform-client-v2/api/UsageApi
60053
- * @version 184.0.0
60554
+ * @version 185.0.0
60054
60555
  */
60055
60556
 
60056
60557
  /**
@@ -60260,7 +60761,7 @@ class UserRecordingsApi {
60260
60761
  /**
60261
60762
  * UserRecordings service.
60262
60763
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
60263
- * @version 184.0.0
60764
+ * @version 185.0.0
60264
60765
  */
60265
60766
 
60266
60767
  /**
@@ -60445,7 +60946,7 @@ class UsersApi {
60445
60946
  /**
60446
60947
  * Users service.
60447
60948
  * @module purecloud-platform-client-v2/api/UsersApi
60448
- * @version 184.0.0
60949
+ * @version 185.0.0
60449
60950
  */
60450
60951
 
60451
60952
  /**
@@ -63096,7 +63597,7 @@ class UtilitiesApi {
63096
63597
  /**
63097
63598
  * Utilities service.
63098
63599
  * @module purecloud-platform-client-v2/api/UtilitiesApi
63099
- * @version 184.0.0
63600
+ * @version 185.0.0
63100
63601
  */
63101
63602
 
63102
63603
  /**
@@ -63207,7 +63708,7 @@ class VoicemailApi {
63207
63708
  /**
63208
63709
  * Voicemail service.
63209
63710
  * @module purecloud-platform-client-v2/api/VoicemailApi
63210
- * @version 184.0.0
63711
+ * @version 185.0.0
63211
63712
  */
63212
63713
 
63213
63714
  /**
@@ -63874,7 +64375,7 @@ class WebChatApi {
63874
64375
  /**
63875
64376
  * WebChat service.
63876
64377
  * @module purecloud-platform-client-v2/api/WebChatApi
63877
- * @version 184.0.0
64378
+ * @version 185.0.0
63878
64379
  */
63879
64380
 
63880
64381
  /**
@@ -64423,7 +64924,7 @@ class WebDeploymentsApi {
64423
64924
  /**
64424
64925
  * WebDeployments service.
64425
64926
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
64426
- * @version 184.0.0
64927
+ * @version 185.0.0
64427
64928
  */
64428
64929
 
64429
64930
  /**
@@ -64950,7 +65451,7 @@ class WebMessagingApi {
64950
65451
  /**
64951
65452
  * WebMessaging service.
64952
65453
  * @module purecloud-platform-client-v2/api/WebMessagingApi
64953
- * @version 184.0.0
65454
+ * @version 185.0.0
64954
65455
  */
64955
65456
 
64956
65457
  /**
@@ -64996,7 +65497,7 @@ class WidgetsApi {
64996
65497
  /**
64997
65498
  * Widgets service.
64998
65499
  * @module purecloud-platform-client-v2/api/WidgetsApi
64999
- * @version 184.0.0
65500
+ * @version 185.0.0
65000
65501
  */
65001
65502
 
65002
65503
  /**
@@ -65142,7 +65643,7 @@ class WorkforceManagementApi {
65142
65643
  /**
65143
65644
  * WorkforceManagement service.
65144
65645
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
65145
- * @version 184.0.0
65646
+ * @version 185.0.0
65146
65647
  */
65147
65648
 
65148
65649
  /**
@@ -66276,6 +66777,81 @@ class WorkforceManagementApi {
66276
66777
  );
66277
66778
  }
66278
66779
 
66780
+ /**
66781
+ * Get the performance prediction for the associated schedule
66782
+ *
66783
+ * @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
66784
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format
66785
+ * @param {String} scheduleId The ID of the schedule the performance prediction belongs to
66786
+ */
66787
+ getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(businessUnitId, weekId, scheduleId) {
66788
+ // verify the required parameter 'businessUnitId' is set
66789
+ if (businessUnitId === undefined || businessUnitId === null) {
66790
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
66791
+ }
66792
+ // verify the required parameter 'weekId' is set
66793
+ if (weekId === undefined || weekId === null) {
66794
+ throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
66795
+ }
66796
+ // verify the required parameter 'scheduleId' is set
66797
+ if (scheduleId === undefined || scheduleId === null) {
66798
+ throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
66799
+ }
66800
+
66801
+ return this.apiClient.callApi(
66802
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions',
66803
+ 'GET',
66804
+ { 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
66805
+ { },
66806
+ { },
66807
+ { },
66808
+ null,
66809
+ ['PureCloud OAuth'],
66810
+ ['application/json'],
66811
+ ['application/json']
66812
+ );
66813
+ }
66814
+
66815
+ /**
66816
+ * Get recalculated performance prediction result
66817
+ *
66818
+ * @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
66819
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format
66820
+ * @param {String} scheduleId The ID of the schedule the recalculation belongs to
66821
+ * @param {String} recalculationId The ID of the recalculation request
66822
+ */
66823
+ getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(businessUnitId, weekId, scheduleId, recalculationId) {
66824
+ // verify the required parameter 'businessUnitId' is set
66825
+ if (businessUnitId === undefined || businessUnitId === null) {
66826
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
66827
+ }
66828
+ // verify the required parameter 'weekId' is set
66829
+ if (weekId === undefined || weekId === null) {
66830
+ throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
66831
+ }
66832
+ // verify the required parameter 'scheduleId' is set
66833
+ if (scheduleId === undefined || scheduleId === null) {
66834
+ throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
66835
+ }
66836
+ // verify the required parameter 'recalculationId' is set
66837
+ if (recalculationId === undefined || recalculationId === null) {
66838
+ throw 'Missing the required parameter "recalculationId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
66839
+ }
66840
+
66841
+ return this.apiClient.callApi(
66842
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}',
66843
+ 'GET',
66844
+ { 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId,'recalculationId': recalculationId },
66845
+ { },
66846
+ { },
66847
+ { },
66848
+ null,
66849
+ ['PureCloud OAuth'],
66850
+ ['application/json'],
66851
+ ['application/json']
66852
+ );
66853
+ }
66854
+
66279
66855
  /**
66280
66856
  * Get the list of week schedules for the specified week
66281
66857
  * Use "recent" (without quotes) for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week
@@ -66499,6 +67075,45 @@ class WorkforceManagementApi {
66499
67075
  );
66500
67076
  }
66501
67077
 
67078
+ /**
67079
+ * Get the staffing requirement by planning group for a forecast
67080
+ *
67081
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
67082
+ * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
67083
+ * @param {String} forecastId The ID of the forecast
67084
+ * @param {Object} opts Optional parameters
67085
+ * @param {Array.<String>} opts.weekNumbers The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified
67086
+ */
67087
+ getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId, weekDateId, forecastId, opts) {
67088
+ opts = opts || {};
67089
+
67090
+ // verify the required parameter 'businessUnitId' is set
67091
+ if (businessUnitId === undefined || businessUnitId === null) {
67092
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
67093
+ }
67094
+ // verify the required parameter 'weekDateId' is set
67095
+ if (weekDateId === undefined || weekDateId === null) {
67096
+ throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
67097
+ }
67098
+ // verify the required parameter 'forecastId' is set
67099
+ if (forecastId === undefined || forecastId === null) {
67100
+ throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
67101
+ }
67102
+
67103
+ return this.apiClient.callApi(
67104
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement',
67105
+ 'GET',
67106
+ { 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
67107
+ { 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi') },
67108
+ { },
67109
+ { },
67110
+ null,
67111
+ ['PureCloud OAuth'],
67112
+ ['application/json'],
67113
+ ['application/json']
67114
+ );
67115
+ }
67116
+
66502
67117
  /**
66503
67118
  * Get short term forecasts
66504
67119
  * Use "recent" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
@@ -67850,6 +68465,35 @@ class WorkforceManagementApi {
67850
68465
  );
67851
68466
  }
67852
68467
 
68468
+ /**
68469
+ * Update agent configurations
68470
+ *
68471
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
68472
+ * @param {Object} opts Optional parameters
68473
+ * @param {Object} opts.body body
68474
+ */
68475
+ patchWorkforcemanagementManagementunitAgents(managementUnitId, opts) {
68476
+ opts = opts || {};
68477
+
68478
+ // verify the required parameter 'managementUnitId' is set
68479
+ if (managementUnitId === undefined || managementUnitId === null) {
68480
+ throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';
68481
+ }
68482
+
68483
+ return this.apiClient.callApi(
68484
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents',
68485
+ 'PATCH',
68486
+ { 'managementUnitId': managementUnitId },
68487
+ { },
68488
+ { },
68489
+ { },
68490
+ opts['body'],
68491
+ ['PureCloud OAuth'],
68492
+ ['application/json'],
68493
+ ['application/json']
68494
+ );
68495
+ }
68496
+
67853
68497
  /**
67854
68498
  * Updates a time off limit object.
67855
68499
  * Updates time off limit object properties, but not daily values.
@@ -68668,6 +69312,84 @@ class WorkforceManagementApi {
68668
69312
  );
68669
69313
  }
68670
69314
 
69315
+ /**
69316
+ * Request a daily recalculation of the performance prediction for the associated schedule
69317
+ *
69318
+ * @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
69319
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format
69320
+ * @param {String} scheduleId The ID of the schedule the performance prediction belongs to
69321
+ * @param {Object} opts Optional parameters
69322
+ * @param {Object} opts.body body
69323
+ */
69324
+ postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId, opts) {
69325
+ opts = opts || {};
69326
+
69327
+ // verify the required parameter 'businessUnitId' is set
69328
+ if (businessUnitId === undefined || businessUnitId === null) {
69329
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
69330
+ }
69331
+ // verify the required parameter 'weekId' is set
69332
+ if (weekId === undefined || weekId === null) {
69333
+ throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
69334
+ }
69335
+ // verify the required parameter 'scheduleId' is set
69336
+ if (scheduleId === undefined || scheduleId === null) {
69337
+ throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
69338
+ }
69339
+
69340
+ return this.apiClient.callApi(
69341
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations',
69342
+ 'POST',
69343
+ { 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
69344
+ { },
69345
+ { },
69346
+ { },
69347
+ opts['body'],
69348
+ ['PureCloud OAuth'],
69349
+ ['application/json'],
69350
+ ['application/json']
69351
+ );
69352
+ }
69353
+
69354
+ /**
69355
+ * Upload daily activity changes to be able to request a performance prediction recalculation
69356
+ *
69357
+ * @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
69358
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format
69359
+ * @param {String} scheduleId The ID of the schedule the performance prediction belongs to
69360
+ * @param {Object} opts Optional parameters
69361
+ * @param {Object} opts.body body
69362
+ */
69363
+ postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId, opts) {
69364
+ opts = opts || {};
69365
+
69366
+ // verify the required parameter 'businessUnitId' is set
69367
+ if (businessUnitId === undefined || businessUnitId === null) {
69368
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
69369
+ }
69370
+ // verify the required parameter 'weekId' is set
69371
+ if (weekId === undefined || weekId === null) {
69372
+ throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
69373
+ }
69374
+ // verify the required parameter 'scheduleId' is set
69375
+ if (scheduleId === undefined || scheduleId === null) {
69376
+ throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
69377
+ }
69378
+
69379
+ return this.apiClient.callApi(
69380
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl',
69381
+ 'POST',
69382
+ { 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
69383
+ { },
69384
+ { },
69385
+ { },
69386
+ opts['body'],
69387
+ ['PureCloud OAuth'],
69388
+ ['application/json'],
69389
+ ['application/json']
69390
+ );
69391
+ }
69392
+
68671
69393
  /**
68672
69394
  * Start a rescheduling run
68673
69395
  *
@@ -70316,7 +71038,7 @@ class WorkforceManagementApi {
70316
71038
  * </pre>
70317
71039
  * </p>
70318
71040
  * @module purecloud-platform-client-v2/index
70319
- * @version 184.0.0
71041
+ * @version 185.0.0
70320
71042
  */
70321
71043
  class platformClient {
70322
71044
  constructor() {