purecloud-platform-client-v2 183.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 +1395 -92
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1395 -92
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +411 -107
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +411 -107
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +823 -54
  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 +109 -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 +8 -9
  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 +75 -0
  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 +7 -8
  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 +401 -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 +7 -1
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
399
399
 
400
400
  /**
401
401
  * @module purecloud-platform-client-v2/ApiClient
402
- * @version 183.0.0
402
+ * @version 185.0.0
403
403
  */
404
404
  class ApiClient {
405
405
  /**
@@ -810,6 +810,339 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
810
810
  });
811
811
  }
812
812
 
813
+ /**
814
+ * @description Completes the PKCE Code Authorization.
815
+ * @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
816
+ * @param {string} codeVerifier - code verifier used to generate the code challenge
817
+ * @param {string} authCode - Authorization code
818
+ * @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
819
+ */
820
+ authorizePKCEGrant(clientId, codeVerifier, authCode, redirectUri) {
821
+ this.clientId = clientId;
822
+ return new Promise((resolve, reject) => {
823
+ var request = axios__default["default"]({
824
+ method: `POST`,
825
+ url: `https://login.${this.config.environment}/oauth/token`,
826
+ headers: {
827
+ 'Content-Type': 'application/x-www-form-urlencoded'
828
+ },
829
+ data: qs__default["default"].stringify({ grant_type: 'authorization_code',
830
+ code: authCode,
831
+ code_verifier: codeVerifier,
832
+ client_id: clientId,
833
+ redirect_uri: redirectUri })
834
+ });
835
+
836
+ request.proxy = this.proxy;
837
+ var bodyParam = {
838
+ grant_type: 'authorization_code',
839
+ code: authCode,
840
+ code_verifier: codeVerifier,
841
+ client_id: clientId,
842
+ redirect_uri: redirectUri,
843
+ };
844
+ // Handle response
845
+ request
846
+ .then((response) => {
847
+ // Logging
848
+ this.config.logger.log(
849
+ 'trace',
850
+ response.status,
851
+ 'POST',
852
+ `https://login.${this.config.environment}/oauth/token`,
853
+ request.headers,
854
+ response.headers,
855
+ bodyParam,
856
+ undefined
857
+ );
858
+ this.config.logger.log(
859
+ 'debug',
860
+ response.status,
861
+ 'POST',
862
+ `https://login.${this.config.environment}/oauth/token`,
863
+ request.headers,
864
+ undefined,
865
+ bodyParam,
866
+ undefined
867
+ );
868
+
869
+ // Get access token from response
870
+ var access_token = response.data.access_token;
871
+
872
+ this.setAccessToken(access_token);
873
+ this.authData.tokenExpiryTime = new Date().getTime() + response.data['expires_in'] * 1000;
874
+ this.authData.tokenExpiryTimeString = new Date(this.authData.tokenExpiryTime).toUTCString();
875
+
876
+ // Return auth data
877
+ resolve(this.authData);
878
+ })
879
+ .catch((error) => {
880
+ // Log error
881
+ if (error.response) {
882
+ this.config.logger.log(
883
+ 'error',
884
+ error.response.status,
885
+ 'POST',
886
+ `https://login.${this.config.environment}/oauth/token`,
887
+ request.headers,
888
+ error.response.headers,
889
+ bodyParam,
890
+ error.response.data
891
+ );
892
+ }
893
+
894
+ reject(error);
895
+ });
896
+
897
+ });
898
+ }
899
+
900
+ /**
901
+ * @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
902
+ * @param {number} nChar - code length
903
+ */
904
+ generatePKCECodeVerifier(nChar) {
905
+ if (nChar < 43 || nChar > 128) {
906
+ throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
907
+ }
908
+ // Check for window
909
+ if (typeof window === 'undefined') {
910
+ try {
911
+ const getRandomValues = require('crypto').getRandomValues;
912
+ const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
913
+ let randomString = Array.from(getRandomValues(new Uint32Array(nChar)))
914
+ .map((x) => unreservedCharacters[x % unreservedCharacters.length])
915
+ .join('');
916
+ return randomString;
917
+ } catch (err) {
918
+ throw new Error(`Crypto module is missing/not supported.`);
919
+ }
920
+ } else {
921
+ const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
922
+ let randomString = Array.from(crypto.getRandomValues(new Uint32Array(nChar)))
923
+ .map((x) => unreservedCharacters[x % unreservedCharacters.length])
924
+ .join('');
925
+ return randomString;
926
+ }
927
+ }
928
+
929
+ /**
930
+ * @description Compute Base64Url PKCE Code Challenge from Code Verifier.
931
+ * @param {string} code - code verifier used to generate the code challenge
932
+ */
933
+ computePKCECodeChallenge(code) {
934
+ if (code.length < 43 || code.length > 128) {
935
+ throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
936
+ }
937
+ // Check for window
938
+ if (typeof window === 'undefined') {
939
+ // nodejs
940
+ try {
941
+ const createHash = require('crypto').createHash;
942
+ const utf8 = new TextEncoder().encode(code);
943
+ return new Promise((resolve, reject) => {
944
+ const hashHex = createHash('sha256').update(utf8).digest();
945
+ const hashBase64Url = Buffer.from(hashHex).toString('base64url');
946
+ resolve(hashBase64Url);
947
+ });
948
+ } catch (err) {
949
+ throw new Error(`Crypto module is missing/not supported.`);
950
+ }
951
+ } else {
952
+ // browser
953
+ const utf8 = new TextEncoder().encode(code);
954
+ return new Promise((resolve, reject) => {
955
+ window.crypto.subtle.digest("SHA-256", utf8).then((hashBuffer) => {
956
+ const hashBase64 = Buffer.from(hashBuffer).toString('base64');
957
+ let hashBase64Url = hashBase64.replaceAll("+", "-").replaceAll("/", "_");
958
+ hashBase64Url = hashBase64Url.split("=")[0];
959
+ resolve(hashBase64Url);
960
+ })
961
+ .catch((error) => {
962
+ // Handle failure
963
+ return reject(new Error(`Code Challenge Error ${error}`));
964
+ });
965
+ });
966
+ }
967
+ }
968
+
969
+ /**
970
+ * @description Initiates the pkce auth code grant login flow. Will attempt to load the token from local storage, if enabled.
971
+ * @param {string} clientId - The client ID of an OAuth Implicit Grant client
972
+ * @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
973
+ * @param {object} opts - (optional) Additional options
974
+ * @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.
975
+ * @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.
976
+ * @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.
977
+ * @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
978
+ */
979
+ loginPKCEGrant(clientId, redirectUri, opts, codeVerifier) {
980
+ // Need Local Storage or non null codeVerifier as parameter
981
+ if (!this.hasLocalStorage && !codeVerifier) {
982
+ throw new Error(`loginPKCEGrant requires Local Storage or codeVerifier as input parameter`);
983
+ }
984
+ // Check for auth code in query
985
+ const query = this._setValuesFromUrlQuery();
986
+
987
+ this.clientId = clientId;
988
+ this.redirectUri = redirectUri;
989
+
990
+ this.codeVerifier = codeVerifier;
991
+
992
+ if (!opts) opts = {};
993
+
994
+ return new Promise((resolve, reject) => {
995
+ // Abort if org and provider are not set together
996
+ if (opts.org && !opts.provider) {
997
+ reject(new Error('opts.provider must be set if opts.org is set'));
998
+ } else if (opts.provider && !opts.org) {
999
+ reject(new Error('opts.org must be set if opts.provider is set'));
1000
+ }
1001
+
1002
+ // Abort on auth error
1003
+ if (query && query.error) {
1004
+ // remove codeVerifier from session storage
1005
+ if (this.hasLocalStorage) {
1006
+ sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
1007
+ }
1008
+ // reset access token if any was stored
1009
+ this._saveSettings({ accessToken: undefined });
1010
+ return reject(new Error(`[${query.error}] ${query.error_description}`));
1011
+ }
1012
+
1013
+ // Get token on auth code
1014
+ if (query && query.code) {
1015
+ if (!this.codeVerifier) {
1016
+ // load codeVerifier from session storage
1017
+ if (this.hasLocalStorage) {
1018
+ this.codeVerifier = sessionStorage.getItem(`genesys_cloud_sdk_pkce_code_verifier`);
1019
+ }
1020
+ }
1021
+ this.authorizePKCEGrant(this.clientId, this.codeVerifier, query.code, this.redirectUri)
1022
+ .then(() => {
1023
+ // Do authenticated things
1024
+ this._testTokenAccess()
1025
+ .then(() => {
1026
+ if (!this.authData.state && query.state)
1027
+ this.authData.state = query.state;
1028
+ // remove codeVerifier from session storage
1029
+ if (this.hasLocalStorage) {
1030
+ sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
1031
+ }
1032
+ resolve(this.authData);
1033
+ })
1034
+ .catch((error) => {
1035
+ // Handle failure response
1036
+ this._saveSettings({ accessToken: undefined});
1037
+ // remove codeVerifier from session storage
1038
+ if (this.hasLocalStorage) {
1039
+ sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
1040
+ }
1041
+ return reject(new Error(`[${error.name}] ${error.msg}`));
1042
+ });
1043
+ })
1044
+ .catch((error) => {
1045
+ // Handle failure response
1046
+ this._saveSettings({ accessToken: undefined});
1047
+ // remove codeVerifier from session storage
1048
+ if (this.hasLocalStorage) {
1049
+ sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
1050
+ }
1051
+ return reject(new Error(`[${error.name}] ${error.msg}`));
1052
+ });
1053
+ } else {
1054
+ // Test token (if previously stored) and proceed with login
1055
+ this._testTokenAccess()
1056
+ .then(() => {
1057
+ if (!this.authData.state && opts.state)
1058
+ this.authData.state = opts.state;
1059
+ resolve(this.authData);
1060
+ })
1061
+ .catch((error) => {
1062
+ if (!this.codeVerifier) {
1063
+ this.codeVerifier = this.generatePKCECodeVerifier(128);
1064
+ // save codeVerifier in session storage
1065
+ if (this.hasLocalStorage) {
1066
+ sessionStorage.setItem(`genesys_cloud_sdk_pkce_code_verifier`, this.codeVerifier);
1067
+ }
1068
+ }
1069
+ this.computePKCECodeChallenge(this.codeVerifier)
1070
+ .then((codeChallenge) => {
1071
+ var tokenQuery = {
1072
+ client_id: encodeURIComponent(this.clientId),
1073
+ redirect_uri: encodeURIComponent(this.redirectUri),
1074
+ code_challenge: encodeURIComponent(codeChallenge),
1075
+ response_type: 'code',
1076
+ code_challenge_method: 'S256'
1077
+ };
1078
+ if (opts.state) tokenQuery.state = encodeURIComponent(opts.state);
1079
+ if (opts.org) tokenQuery.org = encodeURIComponent(opts.org);
1080
+ if (opts.provider) tokenQuery.provider = encodeURIComponent(opts.provider);
1081
+
1082
+ var url = this._buildAuthUrl('oauth/authorize', tokenQuery);
1083
+ window.location.replace(url);
1084
+ })
1085
+ .catch((err) => {
1086
+ return reject(new Error(`[${err.name}]`));
1087
+ });
1088
+ });
1089
+ }
1090
+ });
1091
+ }
1092
+
1093
+ /**
1094
+ * @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
1095
+ */
1096
+ _setValuesFromUrlQuery() {
1097
+ // Check for window
1098
+ if (!(typeof window !== 'undefined' && window.location.search)) return;
1099
+
1100
+ // Process query string
1101
+ let query = {};
1102
+ let queryParams = new URLSearchParams(window.location.search);
1103
+ let code = queryParams.get('code');
1104
+ let error = queryParams.get('error');
1105
+ let errorDescription = queryParams.get('error_description');
1106
+ let state = queryParams.get('state');
1107
+
1108
+ // Check for error
1109
+ if (error) {
1110
+ query.error = error;
1111
+ if (errorDescription) {
1112
+ query.error_description = errorDescription;
1113
+ }
1114
+ return query;
1115
+ }
1116
+
1117
+ // Everything goes in here because we only want to act if we found an access token
1118
+ if (code) {
1119
+ query.code = code;
1120
+ if (state) {
1121
+ query.state = state;
1122
+ }
1123
+ }
1124
+
1125
+ // Remove code from URL
1126
+ // Credit: https://stackoverflow.com/questions/1397329/how-to-remove-the-hash-from-window-location-with-javascript-without-page-refresh/5298684#5298684
1127
+ var scrollV, scrollH, loc = window.location;
1128
+ if ('replaceState' in history) {
1129
+ history.replaceState('', document.title, loc.pathname);
1130
+ } else {
1131
+ // Prevent scrolling by storing the page's current scroll offset
1132
+ scrollV = document.body.scrollTop;
1133
+ scrollH = document.body.scrollLeft;
1134
+
1135
+ // Remove code
1136
+ history.pushState('', document.title, loc.pathname);
1137
+
1138
+ // Restore the scroll offset, should be flicker free
1139
+ document.body.scrollTop = scrollV;
1140
+ document.body.scrollLeft = scrollH;
1141
+ }
1142
+
1143
+ return query;
1144
+ }
1145
+
813
1146
  /**
814
1147
  * @description Initiates the Code Authorization. Only available in node apps.
815
1148
  * @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
@@ -1485,7 +1818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1485
1818
  /**
1486
1819
  * Alerting service.
1487
1820
  * @module purecloud-platform-client-v2/api/AlertingApi
1488
- * @version 183.0.0
1821
+ * @version 185.0.0
1489
1822
  */
1490
1823
 
1491
1824
  /**
@@ -2146,7 +2479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2146
2479
  /**
2147
2480
  * Analytics service.
2148
2481
  * @module purecloud-platform-client-v2/api/AnalyticsApi
2149
- * @version 183.0.0
2482
+ * @version 185.0.0
2150
2483
  */
2151
2484
 
2152
2485
  /**
@@ -2672,6 +3005,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2672
3005
  );
2673
3006
  }
2674
3007
 
3008
+ /**
3009
+ * Get status for async query for flow execution aggregates
3010
+ *
3011
+ * @param {String} jobId jobId
3012
+ * getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3013
+ */
3014
+ getAnalyticsFlowexecutionsAggregatesJob(jobId) {
3015
+ // verify the required parameter 'jobId' is set
3016
+ if (jobId === undefined || jobId === null) {
3017
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJob';
3018
+ }
3019
+
3020
+ return this.apiClient.callApi(
3021
+ '/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}',
3022
+ 'GET',
3023
+ { 'jobId': jobId },
3024
+ { },
3025
+ { },
3026
+ { },
3027
+ null,
3028
+ ['PureCloud OAuth'],
3029
+ ['application/json'],
3030
+ ['application/json']
3031
+ );
3032
+ }
3033
+
3034
+ /**
3035
+ * Fetch a page of results for an async aggregates query
3036
+ *
3037
+ * @param {String} jobId jobId
3038
+ * @param {Object} opts Optional parameters
3039
+ * @param {String} opts.cursor Cursor token to retrieve next page
3040
+ * getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3041
+ */
3042
+ getAnalyticsFlowexecutionsAggregatesJobResults(jobId, opts) {
3043
+ opts = opts || {};
3044
+
3045
+ // verify the required parameter 'jobId' is set
3046
+ if (jobId === undefined || jobId === null) {
3047
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJobResults';
3048
+ }
3049
+
3050
+ return this.apiClient.callApi(
3051
+ '/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results',
3052
+ 'GET',
3053
+ { 'jobId': jobId },
3054
+ { 'cursor': opts['cursor'] },
3055
+ { },
3056
+ { },
3057
+ null,
3058
+ ['PureCloud OAuth'],
3059
+ ['application/json'],
3060
+ ['application/json']
3061
+ );
3062
+ }
3063
+
2675
3064
  /**
2676
3065
  * Get status for async query for Flow aggregates
2677
3066
  *
@@ -3855,6 +4244,58 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3855
4244
  );
3856
4245
  }
3857
4246
 
4247
+ /**
4248
+ * Query for flow execution aggregates asynchronously
4249
+ *
4250
+ * @param {Object} body query
4251
+ * postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4252
+ */
4253
+ postAnalyticsFlowexecutionsAggregatesJobs(body) {
4254
+ // verify the required parameter 'body' is set
4255
+ if (body === undefined || body === null) {
4256
+ throw 'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesJobs';
4257
+ }
4258
+
4259
+ return this.apiClient.callApi(
4260
+ '/api/v2/analytics/flowexecutions/aggregates/jobs',
4261
+ 'POST',
4262
+ { },
4263
+ { },
4264
+ { },
4265
+ { },
4266
+ body,
4267
+ ['PureCloud OAuth'],
4268
+ ['application/json'],
4269
+ ['application/json']
4270
+ );
4271
+ }
4272
+
4273
+ /**
4274
+ * Query for flow execution aggregates
4275
+ *
4276
+ * @param {Object} body query
4277
+ * postAnalyticsFlowexecutionsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4278
+ */
4279
+ postAnalyticsFlowexecutionsAggregatesQuery(body) {
4280
+ // verify the required parameter 'body' is set
4281
+ if (body === undefined || body === null) {
4282
+ throw 'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesQuery';
4283
+ }
4284
+
4285
+ return this.apiClient.callApi(
4286
+ '/api/v2/analytics/flowexecutions/aggregates/query',
4287
+ 'POST',
4288
+ { },
4289
+ { },
4290
+ { },
4291
+ { },
4292
+ body,
4293
+ ['PureCloud OAuth'],
4294
+ ['application/json'],
4295
+ ['application/json']
4296
+ );
4297
+ }
4298
+
3858
4299
  /**
3859
4300
  * Query for flow activity observations
3860
4301
  *
@@ -4628,7 +5069,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4628
5069
  /**
4629
5070
  * Architect service.
4630
5071
  * @module purecloud-platform-client-v2/api/ArchitectApi
4631
- * @version 183.0.0
5072
+ * @version 185.0.0
4632
5073
  */
4633
5074
 
4634
5075
  /**
@@ -7875,7 +8316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7875
8316
 
7876
8317
  /**
7877
8318
  * Create a new row entry for the datatable.
7878
- * 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" }
8319
+ * 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" }
7879
8320
  * @param {String} datatableId id of datatable
7880
8321
  * @param {Object.<String, {String: Object}>} dataTableRow
7881
8322
  */
@@ -8367,7 +8808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
8367
8808
 
8368
8809
  /**
8369
8810
  * Update a row entry
8370
- * 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" }
8811
+ * 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" }
8371
8812
  * @param {String} datatableId id of datatable
8372
8813
  * @param {String} rowId the key for the row
8373
8814
  * @param {Object} opts Optional parameters
@@ -8463,7 +8904,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
8463
8904
  /**
8464
8905
  * Audit service.
8465
8906
  * @module purecloud-platform-client-v2/api/AuditApi
8466
- * @version 183.0.0
8907
+ * @version 185.0.0
8467
8908
  */
8468
8909
 
8469
8910
  /**
@@ -8634,7 +9075,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
8634
9075
  /**
8635
9076
  * Authorization service.
8636
9077
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8637
- * @version 183.0.0
9078
+ * @version 185.0.0
8638
9079
  */
8639
9080
 
8640
9081
  /**
@@ -9017,7 +9458,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9017
9458
  * Get the organization role specified by its ID.
9018
9459
  * @param {String} roleId Role ID
9019
9460
  * @param {Object} opts Optional parameters
9020
- * @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division (default to true)
9461
+ * @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)
9021
9462
  * @param {Array.<String>} opts.expand Which fields, if any, to expand. unusedPermissions returns the permissions not used for the role
9022
9463
  */
9023
9464
  getAuthorizationRole(roleId, opts) {
@@ -9378,17 +9819,16 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9378
9819
  * Recreate a previously deleted division.
9379
9820
  *
9380
9821
  * @param {String} divisionId Division ID
9381
- * @param {Object} body Recreated division data
9822
+ * @param {Object} opts Optional parameters
9823
+ * @param {Object} opts.body Recreated division data
9382
9824
  */
9383
- postAuthorizationDivisionRestore(divisionId, body) {
9825
+ postAuthorizationDivisionRestore(divisionId, opts) {
9826
+ opts = opts || {};
9827
+
9384
9828
  // verify the required parameter 'divisionId' is set
9385
9829
  if (divisionId === undefined || divisionId === null) {
9386
9830
  throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
9387
9831
  }
9388
- // verify the required parameter 'body' is set
9389
- if (body === undefined || body === null) {
9390
- throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
9391
- }
9392
9832
 
9393
9833
  return this.apiClient.callApi(
9394
9834
  '/api/v2/authorization/divisions/{divisionId}/restore',
@@ -9397,7 +9837,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9397
9837
  { },
9398
9838
  { },
9399
9839
  { },
9400
- body,
9840
+ opts['body'],
9401
9841
  ['PureCloud OAuth'],
9402
9842
  ['application/json'],
9403
9843
  ['application/json']
@@ -9865,7 +10305,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9865
10305
  /**
9866
10306
  * Billing service.
9867
10307
  * @module purecloud-platform-client-v2/api/BillingApi
9868
- * @version 183.0.0
10308
+ * @version 185.0.0
9869
10309
  */
9870
10310
 
9871
10311
  /**
@@ -9945,7 +10385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9945
10385
  /**
9946
10386
  * CarrierServices service.
9947
10387
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
9948
- * @version 183.0.0
10388
+ * @version 185.0.0
9949
10389
  */
9950
10390
 
9951
10391
  /**
@@ -10015,7 +10455,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10015
10455
  /**
10016
10456
  * Chat service.
10017
10457
  * @module purecloud-platform-client-v2/api/ChatApi
10018
- * @version 183.0.0
10458
+ * @version 185.0.0
10019
10459
  */
10020
10460
 
10021
10461
  /**
@@ -10711,7 +11151,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10711
11151
  /**
10712
11152
  * Coaching service.
10713
11153
  * @module purecloud-platform-client-v2/api/CoachingApi
10714
- * @version 183.0.0
11154
+ * @version 185.0.0
10715
11155
  */
10716
11156
 
10717
11157
  /**
@@ -11288,7 +11728,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11288
11728
  /**
11289
11729
  * ContentManagement service.
11290
11730
  * @module purecloud-platform-client-v2/api/ContentManagementApi
11291
- * @version 183.0.0
11731
+ * @version 185.0.0
11292
11732
  */
11293
11733
 
11294
11734
  /**
@@ -12431,7 +12871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12431
12871
  /**
12432
12872
  * Conversations service.
12433
12873
  * @module purecloud-platform-client-v2/api/ConversationsApi
12434
- * @version 183.0.0
12874
+ * @version 185.0.0
12435
12875
  */
12436
12876
 
12437
12877
  /**
@@ -19571,7 +20011,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19571
20011
  /**
19572
20012
  * DataExtensions service.
19573
20013
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
19574
- * @version 183.0.0
20014
+ * @version 185.0.0
19575
20015
  */
19576
20016
 
19577
20017
  /**
@@ -19657,7 +20097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19657
20097
  /**
19658
20098
  * Downloads service.
19659
20099
  * @module purecloud-platform-client-v2/api/DownloadsApi
19660
- * @version 183.0.0
20100
+ * @version 185.0.0
19661
20101
  */
19662
20102
 
19663
20103
  /**
@@ -19709,7 +20149,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19709
20149
  /**
19710
20150
  * Emails service.
19711
20151
  * @module purecloud-platform-client-v2/api/EmailsApi
19712
- * @version 183.0.0
20152
+ * @version 185.0.0
19713
20153
  */
19714
20154
 
19715
20155
  /**
@@ -19774,7 +20214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19774
20214
  /**
19775
20215
  * Events service.
19776
20216
  * @module purecloud-platform-client-v2/api/EventsApi
19777
- * @version 183.0.0
20217
+ * @version 185.0.0
19778
20218
  */
19779
20219
 
19780
20220
  /**
@@ -19870,7 +20310,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19870
20310
  /**
19871
20311
  * ExternalContacts service.
19872
20312
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
19873
- * @version 183.0.0
20313
+ * @version 185.0.0
19874
20314
  */
19875
20315
 
19876
20316
  /**
@@ -21828,7 +22268,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21828
22268
  /**
21829
22269
  * Fax service.
21830
22270
  * @module purecloud-platform-client-v2/api/FaxApi
21831
- * @version 183.0.0
22271
+ * @version 185.0.0
21832
22272
  */
21833
22273
 
21834
22274
  /**
@@ -21999,7 +22439,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21999
22439
  /**
22000
22440
  * Flows service.
22001
22441
  * @module purecloud-platform-client-v2/api/FlowsApi
22002
- * @version 183.0.0
22442
+ * @version 185.0.0
22003
22443
  */
22004
22444
 
22005
22445
  /**
@@ -22183,7 +22623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22183
22623
  /**
22184
22624
  * Gamification service.
22185
22625
  * @module purecloud-platform-client-v2/api/GamificationApi
22186
- * @version 183.0.0
22626
+ * @version 185.0.0
22187
22627
  */
22188
22628
 
22189
22629
  /**
@@ -24269,7 +24709,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24269
24709
  /**
24270
24710
  * GeneralDataProtectionRegulation service.
24271
24711
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
24272
- * @version 183.0.0
24712
+ * @version 185.0.0
24273
24713
  */
24274
24714
 
24275
24715
  /**
@@ -24399,7 +24839,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24399
24839
  /**
24400
24840
  * Geolocation service.
24401
24841
  * @module purecloud-platform-client-v2/api/GeolocationApi
24402
- * @version 183.0.0
24842
+ * @version 185.0.0
24403
24843
  */
24404
24844
 
24405
24845
  /**
@@ -24530,7 +24970,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24530
24970
  /**
24531
24971
  * Greetings service.
24532
24972
  * @module purecloud-platform-client-v2/api/GreetingsApi
24533
- * @version 183.0.0
24973
+ * @version 185.0.0
24534
24974
  */
24535
24975
 
24536
24976
  /**
@@ -24985,7 +25425,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24985
25425
  /**
24986
25426
  * Groups service.
24987
25427
  * @module purecloud-platform-client-v2/api/GroupsApi
24988
- * @version 183.0.0
25428
+ * @version 185.0.0
24989
25429
  */
24990
25430
 
24991
25431
  /**
@@ -25504,7 +25944,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25504
25944
  /**
25505
25945
  * IdentityProvider service.
25506
25946
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
25507
- * @version 183.0.0
25947
+ * @version 185.0.0
25508
25948
  */
25509
25949
 
25510
25950
  /**
@@ -26260,7 +26700,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26260
26700
  /**
26261
26701
  * InfrastructureAsCode service.
26262
26702
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
26263
- * @version 183.0.0
26703
+ * @version 185.0.0
26264
26704
  */
26265
26705
 
26266
26706
  /**
@@ -26427,7 +26867,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26427
26867
  /**
26428
26868
  * Integrations service.
26429
26869
  * @module purecloud-platform-client-v2/api/IntegrationsApi
26430
- * @version 183.0.0
26870
+ * @version 185.0.0
26431
26871
  */
26432
26872
 
26433
26873
  /**
@@ -28389,7 +28829,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28389
28829
  /**
28390
28830
  * Journey service.
28391
28831
  * @module purecloud-platform-client-v2/api/JourneyApi
28392
- * @version 183.0.0
28832
+ * @version 185.0.0
28393
28833
  */
28394
28834
 
28395
28835
  /**
@@ -29620,7 +30060,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29620
30060
  /**
29621
30061
  * Knowledge service.
29622
30062
  * @module purecloud-platform-client-v2/api/KnowledgeApi
29623
- * @version 183.0.0
30063
+ * @version 185.0.0
29624
30064
  */
29625
30065
 
29626
30066
  /**
@@ -32441,7 +32881,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32441
32881
  /**
32442
32882
  * LanguageUnderstanding service.
32443
32883
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
32444
- * @version 183.0.0
32884
+ * @version 185.0.0
32445
32885
  */
32446
32886
 
32447
32887
  /**
@@ -33454,7 +33894,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33454
33894
  /**
33455
33895
  * Languages service.
33456
33896
  * @module purecloud-platform-client-v2/api/LanguagesApi
33457
- * @version 183.0.0
33897
+ * @version 185.0.0
33458
33898
  */
33459
33899
 
33460
33900
  /**
@@ -33676,7 +34116,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33676
34116
  /**
33677
34117
  * Learning service.
33678
34118
  * @module purecloud-platform-client-v2/api/LearningApi
33679
- * @version 183.0.0
34119
+ * @version 185.0.0
33680
34120
  */
33681
34121
 
33682
34122
  /**
@@ -34532,7 +34972,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34532
34972
  /**
34533
34973
  * License service.
34534
34974
  * @module purecloud-platform-client-v2/api/LicenseApi
34535
- * @version 183.0.0
34975
+ * @version 185.0.0
34536
34976
  */
34537
34977
 
34538
34978
  /**
@@ -34770,7 +35210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34770
35210
  /**
34771
35211
  * Locations service.
34772
35212
  * @module purecloud-platform-client-v2/api/LocationsApi
34773
- * @version 183.0.0
35213
+ * @version 185.0.0
34774
35214
  */
34775
35215
 
34776
35216
  /**
@@ -35002,11 +35442,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35002
35442
 
35003
35443
  }
35004
35444
 
35445
+ class LogCaptureApi {
35446
+ /**
35447
+ * LogCapture service.
35448
+ * @module purecloud-platform-client-v2/api/LogCaptureApi
35449
+ * @version 185.0.0
35450
+ */
35451
+
35452
+ /**
35453
+ * Constructs a new LogCaptureApi.
35454
+ * @alias module:purecloud-platform-client-v2/api/LogCaptureApi
35455
+ * @class
35456
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
35457
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
35458
+ */
35459
+ constructor(apiClient) {
35460
+ this.apiClient = apiClient || ApiClient.instance;
35461
+ }
35462
+
35463
+
35464
+ /**
35465
+ * Gets status of async download execution
35466
+ *
35467
+ * @param {String} jobId Job ID
35468
+ */
35469
+ getDiagnosticsLogcaptureBrowserEntriesDownloadJob(jobId) {
35470
+ // verify the required parameter 'jobId' is set
35471
+ if (jobId === undefined || jobId === null) {
35472
+ throw 'Missing the required parameter "jobId" when calling getDiagnosticsLogcaptureBrowserEntriesDownloadJob';
35473
+ }
35474
+
35475
+ return this.apiClient.callApi(
35476
+ '/api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId}',
35477
+ 'GET',
35478
+ { 'jobId': jobId },
35479
+ { },
35480
+ { },
35481
+ { },
35482
+ null,
35483
+ ['PureCloud OAuth'],
35484
+ ['application/json'],
35485
+ ['application/json']
35486
+ );
35487
+ }
35488
+
35489
+ /**
35490
+ * Creates an async download execution
35491
+ *
35492
+ * @param {Object} opts Optional parameters
35493
+ * @param {Object} opts.body
35494
+ */
35495
+ postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(opts) {
35496
+ opts = opts || {};
35497
+
35498
+
35499
+ return this.apiClient.callApi(
35500
+ '/api/v2/diagnostics/logcapture/browser/entries/download/jobs',
35501
+ 'POST',
35502
+ { },
35503
+ { },
35504
+ { },
35505
+ { },
35506
+ opts['body'],
35507
+ ['PureCloud OAuth'],
35508
+ ['application/json'],
35509
+ ['application/json']
35510
+ );
35511
+ }
35512
+
35513
+ }
35514
+
35005
35515
  class MessagingApi {
35006
35516
  /**
35007
35517
  * Messaging service.
35008
35518
  * @module purecloud-platform-client-v2/api/MessagingApi
35009
- * @version 183.0.0
35519
+ * @version 185.0.0
35010
35520
  */
35011
35521
 
35012
35522
  /**
@@ -35365,7 +35875,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35365
35875
  /**
35366
35876
  * MobileDevices service.
35367
35877
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
35368
- * @version 183.0.0
35878
+ * @version 185.0.0
35369
35879
  */
35370
35880
 
35371
35881
  /**
@@ -35516,7 +36026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35516
36026
  /**
35517
36027
  * Notifications service.
35518
36028
  * @module purecloud-platform-client-v2/api/NotificationsApi
35519
- * @version 183.0.0
36029
+ * @version 185.0.0
35520
36030
  */
35521
36031
 
35522
36032
  /**
@@ -35749,7 +36259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35749
36259
  /**
35750
36260
  * OAuth service.
35751
36261
  * @module purecloud-platform-client-v2/api/OAuthApi
35752
- * @version 183.0.0
36262
+ * @version 185.0.0
35753
36263
  */
35754
36264
 
35755
36265
  /**
@@ -36115,7 +36625,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36115
36625
  /**
36116
36626
  * Objects service.
36117
36627
  * @module purecloud-platform-client-v2/api/ObjectsApi
36118
- * @version 183.0.0
36628
+ * @version 185.0.0
36119
36629
  */
36120
36630
 
36121
36631
  /**
@@ -36299,17 +36809,16 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36299
36809
  * Recreate a previously deleted division.
36300
36810
  *
36301
36811
  * @param {String} divisionId Division ID
36302
- * @param {Object} body Recreated division data
36812
+ * @param {Object} opts Optional parameters
36813
+ * @param {Object} opts.body Recreated division data
36303
36814
  */
36304
- postAuthorizationDivisionRestore(divisionId, body) {
36815
+ postAuthorizationDivisionRestore(divisionId, opts) {
36816
+ opts = opts || {};
36817
+
36305
36818
  // verify the required parameter 'divisionId' is set
36306
36819
  if (divisionId === undefined || divisionId === null) {
36307
36820
  throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
36308
36821
  }
36309
- // verify the required parameter 'body' is set
36310
- if (body === undefined || body === null) {
36311
- throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
36312
- }
36313
36822
 
36314
36823
  return this.apiClient.callApi(
36315
36824
  '/api/v2/authorization/divisions/{divisionId}/restore',
@@ -36318,7 +36827,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36318
36827
  { },
36319
36828
  { },
36320
36829
  { },
36321
- body,
36830
+ opts['body'],
36322
36831
  ['PureCloud OAuth'],
36323
36832
  ['application/json'],
36324
36833
  ['application/json']
@@ -36386,7 +36895,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36386
36895
  /**
36387
36896
  * OperationalEvents service.
36388
36897
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
36389
- * @version 183.0.0
36898
+ * @version 185.0.0
36390
36899
  */
36391
36900
 
36392
36901
  /**
@@ -36452,7 +36961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36452
36961
  /**
36453
36962
  * Organization service.
36454
36963
  * @module purecloud-platform-client-v2/api/OrganizationApi
36455
- * @version 183.0.0
36964
+ * @version 185.0.0
36456
36965
  */
36457
36966
 
36458
36967
  /**
@@ -36907,7 +37416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36907
37416
  /**
36908
37417
  * OrganizationAuthorization service.
36909
37418
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
36910
- * @version 183.0.0
37419
+ * @version 185.0.0
36911
37420
  */
36912
37421
 
36913
37422
  /**
@@ -38254,7 +38763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38254
38763
  /**
38255
38764
  * Outbound service.
38256
38765
  * @module purecloud-platform-client-v2/api/OutboundApi
38257
- * @version 183.0.0
38766
+ * @version 185.0.0
38258
38767
  */
38259
38768
 
38260
38769
  /**
@@ -38554,6 +39063,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38554
39063
  );
38555
39064
  }
38556
39065
 
39066
+ /**
39067
+ * Delete Contact List Template
39068
+ *
39069
+ * @param {String} contactListTemplateId ContactListTemplate ID
39070
+ */
39071
+ deleteOutboundContactlisttemplate(contactListTemplateId) {
39072
+ // verify the required parameter 'contactListTemplateId' is set
39073
+ if (contactListTemplateId === undefined || contactListTemplateId === null) {
39074
+ throw 'Missing the required parameter "contactListTemplateId" when calling deleteOutboundContactlisttemplate';
39075
+ }
39076
+
39077
+ return this.apiClient.callApi(
39078
+ '/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
39079
+ 'DELETE',
39080
+ { 'contactListTemplateId': contactListTemplateId },
39081
+ { },
39082
+ { },
39083
+ { },
39084
+ null,
39085
+ ['PureCloud OAuth'],
39086
+ ['application/json'],
39087
+ ['application/json']
39088
+ );
39089
+ }
39090
+
39091
+ /**
39092
+ * Delete multiple contact list templates.
39093
+ *
39094
+ * @param {Array.<String>} id contact list template id(s) to delete
39095
+ */
39096
+ deleteOutboundContactlisttemplates(id) {
39097
+ // verify the required parameter 'id' is set
39098
+ if (id === undefined || id === null) {
39099
+ throw 'Missing the required parameter "id" when calling deleteOutboundContactlisttemplates';
39100
+ }
39101
+
39102
+ return this.apiClient.callApi(
39103
+ '/api/v2/outbound/contactlisttemplates',
39104
+ 'DELETE',
39105
+ { },
39106
+ { 'id': this.apiClient.buildCollectionParam(id, 'multi') },
39107
+ { },
39108
+ { },
39109
+ null,
39110
+ ['PureCloud OAuth'],
39111
+ ['application/json'],
39112
+ ['application/json']
39113
+ );
39114
+ }
39115
+
38557
39116
  /**
38558
39117
  * Delete an Outbound Digital Rule Set
38559
39118
  *
@@ -38691,6 +39250,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38691
39250
  );
38692
39251
  }
38693
39252
 
39253
+ /**
39254
+ * Delete Import Template
39255
+ *
39256
+ * @param {String} importTemplateId Import Template ID
39257
+ */
39258
+ deleteOutboundImporttemplate(importTemplateId) {
39259
+ // verify the required parameter 'importTemplateId' is set
39260
+ if (importTemplateId === undefined || importTemplateId === null) {
39261
+ throw 'Missing the required parameter "importTemplateId" when calling deleteOutboundImporttemplate';
39262
+ }
39263
+
39264
+ return this.apiClient.callApi(
39265
+ '/api/v2/outbound/importtemplates/{importTemplateId}',
39266
+ 'DELETE',
39267
+ { 'importTemplateId': importTemplateId },
39268
+ { },
39269
+ { },
39270
+ { },
39271
+ null,
39272
+ ['PureCloud OAuth'],
39273
+ ['application/json'],
39274
+ ['application/json']
39275
+ );
39276
+ }
39277
+
39278
+ /**
39279
+ * Delete multiple import templates.
39280
+ *
39281
+ * @param {Array.<String>} id import template id(s) to delete
39282
+ */
39283
+ deleteOutboundImporttemplates(id) {
39284
+ // verify the required parameter 'id' is set
39285
+ if (id === undefined || id === null) {
39286
+ throw 'Missing the required parameter "id" when calling deleteOutboundImporttemplates';
39287
+ }
39288
+
39289
+ return this.apiClient.callApi(
39290
+ '/api/v2/outbound/importtemplates',
39291
+ 'DELETE',
39292
+ { },
39293
+ { 'id': this.apiClient.buildCollectionParam(id, 'multi') },
39294
+ { },
39295
+ { },
39296
+ null,
39297
+ ['PureCloud OAuth'],
39298
+ ['application/json'],
39299
+ ['application/json']
39300
+ );
39301
+ }
39302
+
38694
39303
  /**
38695
39304
  * Delete an Outbound Messaging Campaign
38696
39305
  *
@@ -39703,6 +40312,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39703
40312
  );
39704
40313
  }
39705
40314
 
40315
+ /**
40316
+ * Get Contact List Template
40317
+ *
40318
+ * @param {String} contactListTemplateId ContactListTemplate ID
40319
+ */
40320
+ getOutboundContactlisttemplate(contactListTemplateId) {
40321
+ // verify the required parameter 'contactListTemplateId' is set
40322
+ if (contactListTemplateId === undefined || contactListTemplateId === null) {
40323
+ throw 'Missing the required parameter "contactListTemplateId" when calling getOutboundContactlisttemplate';
40324
+ }
40325
+
40326
+ return this.apiClient.callApi(
40327
+ '/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
40328
+ 'GET',
40329
+ { 'contactListTemplateId': contactListTemplateId },
40330
+ { },
40331
+ { },
40332
+ { },
40333
+ null,
40334
+ ['PureCloud OAuth'],
40335
+ ['application/json'],
40336
+ ['application/json']
40337
+ );
40338
+ }
40339
+
40340
+ /**
40341
+ * Query a list of contact list templates
40342
+ *
40343
+ * @param {Object} opts Optional parameters
40344
+ * @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
40345
+ * @param {Number} opts.pageNumber Page number (default to 1)
40346
+ * @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
40347
+ * @param {Object} opts.filterType Filter type (default to Prefix)
40348
+ * @param {String} opts.name Name
40349
+ * @param {String} opts.sortBy Sort by
40350
+ * @param {Object} opts.sortOrder Sort order (default to a)
40351
+ */
40352
+ getOutboundContactlisttemplates(opts) {
40353
+ opts = opts || {};
40354
+
40355
+
40356
+ return this.apiClient.callApi(
40357
+ '/api/v2/outbound/contactlisttemplates',
40358
+ 'GET',
40359
+ { },
40360
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
40361
+ { },
40362
+ { },
40363
+ null,
40364
+ ['PureCloud OAuth'],
40365
+ ['application/json'],
40366
+ ['application/json']
40367
+ );
40368
+ }
40369
+
39706
40370
  /**
39707
40371
  * Get an Outbound Digital Rule Set
39708
40372
  *
@@ -39993,6 +40657,91 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39993
40657
  );
39994
40658
  }
39995
40659
 
40660
+ /**
40661
+ * Get Import Template
40662
+ *
40663
+ * @param {String} importTemplateId Import Template ID
40664
+ */
40665
+ getOutboundImporttemplate(importTemplateId) {
40666
+ // verify the required parameter 'importTemplateId' is set
40667
+ if (importTemplateId === undefined || importTemplateId === null) {
40668
+ throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplate';
40669
+ }
40670
+
40671
+ return this.apiClient.callApi(
40672
+ '/api/v2/outbound/importtemplates/{importTemplateId}',
40673
+ 'GET',
40674
+ { 'importTemplateId': importTemplateId },
40675
+ { },
40676
+ { },
40677
+ { },
40678
+ null,
40679
+ ['PureCloud OAuth'],
40680
+ ['application/json'],
40681
+ ['application/json']
40682
+ );
40683
+ }
40684
+
40685
+ /**
40686
+ * Get the import status for an import template.
40687
+ *
40688
+ * @param {String} importTemplateId importTemplateId
40689
+ * @param {Object} opts Optional parameters
40690
+ * @param {String} opts.listNamePrefix listNamePrefix
40691
+ */
40692
+ getOutboundImporttemplateImportstatus(importTemplateId, opts) {
40693
+ opts = opts || {};
40694
+
40695
+ // verify the required parameter 'importTemplateId' is set
40696
+ if (importTemplateId === undefined || importTemplateId === null) {
40697
+ throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplateImportstatus';
40698
+ }
40699
+
40700
+ return this.apiClient.callApi(
40701
+ '/api/v2/outbound/importtemplates/{importTemplateId}/importstatus',
40702
+ 'GET',
40703
+ { 'importTemplateId': importTemplateId },
40704
+ { 'listNamePrefix': opts['listNamePrefix'] },
40705
+ { },
40706
+ { },
40707
+ null,
40708
+ ['PureCloud OAuth'],
40709
+ ['application/json'],
40710
+ ['application/json']
40711
+ );
40712
+ }
40713
+
40714
+ /**
40715
+ * Query Import Templates
40716
+ *
40717
+ * @param {Object} opts Optional parameters
40718
+ * @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
40719
+ * @param {Number} opts.pageNumber Page number (default to 1)
40720
+ * @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
40721
+ * @param {Object} opts.filterType Filter type (default to Prefix)
40722
+ * @param {String} opts.name Name
40723
+ * @param {String} opts.sortBy Sort by
40724
+ * @param {Object} opts.sortOrder Sort order (default to a)
40725
+ * @param {String} opts.contactListTemplateId Contact List Template ID
40726
+ */
40727
+ getOutboundImporttemplates(opts) {
40728
+ opts = opts || {};
40729
+
40730
+
40731
+ return this.apiClient.callApi(
40732
+ '/api/v2/outbound/importtemplates',
40733
+ 'GET',
40734
+ { },
40735
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'contactListTemplateId': opts['contactListTemplateId'] },
40736
+ { },
40737
+ { },
40738
+ null,
40739
+ ['PureCloud OAuth'],
40740
+ ['application/json'],
40741
+ ['application/json']
40742
+ );
40743
+ }
40744
+
39996
40745
  /**
39997
40746
  * Get an Outbound Messaging Campaign
39998
40747
  *
@@ -41031,6 +41780,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41031
41780
  );
41032
41781
  }
41033
41782
 
41783
+ /**
41784
+ * Create Contact List Template
41785
+ *
41786
+ * @param {Object} body ContactListTemplate
41787
+ */
41788
+ postOutboundContactlisttemplates(body) {
41789
+ // verify the required parameter 'body' is set
41790
+ if (body === undefined || body === null) {
41791
+ throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplates';
41792
+ }
41793
+
41794
+ return this.apiClient.callApi(
41795
+ '/api/v2/outbound/contactlisttemplates',
41796
+ 'POST',
41797
+ { },
41798
+ { },
41799
+ { },
41800
+ { },
41801
+ body,
41802
+ ['PureCloud OAuth'],
41803
+ ['application/json'],
41804
+ ['application/json']
41805
+ );
41806
+ }
41807
+
41808
+ /**
41809
+ * Add multiple contact list templates
41810
+ *
41811
+ * @param {Array.<Object>} body contact list template(s) to add
41812
+ */
41813
+ postOutboundContactlisttemplatesBulkAdd(body) {
41814
+ // verify the required parameter 'body' is set
41815
+ if (body === undefined || body === null) {
41816
+ throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkAdd';
41817
+ }
41818
+
41819
+ return this.apiClient.callApi(
41820
+ '/api/v2/outbound/contactlisttemplates/bulk/add',
41821
+ 'POST',
41822
+ { },
41823
+ { },
41824
+ { },
41825
+ { },
41826
+ body,
41827
+ ['PureCloud OAuth'],
41828
+ ['application/json'],
41829
+ ['application/json']
41830
+ );
41831
+ }
41832
+
41034
41833
  /**
41035
41834
  * Add phone numbers to a Dialer DNC list.
41036
41835
  *
@@ -41195,6 +41994,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41195
41994
  );
41196
41995
  }
41197
41996
 
41997
+ /**
41998
+ * Create Import Template
41999
+ *
42000
+ * @param {Object} body ImportTemplate
42001
+ */
42002
+ postOutboundImporttemplates(body) {
42003
+ // verify the required parameter 'body' is set
42004
+ if (body === undefined || body === null) {
42005
+ throw 'Missing the required parameter "body" when calling postOutboundImporttemplates';
42006
+ }
42007
+
42008
+ return this.apiClient.callApi(
42009
+ '/api/v2/outbound/importtemplates',
42010
+ 'POST',
42011
+ { },
42012
+ { },
42013
+ { },
42014
+ { },
42015
+ body,
42016
+ ['PureCloud OAuth'],
42017
+ ['application/json'],
42018
+ ['application/json']
42019
+ );
42020
+ }
42021
+
42022
+ /**
42023
+ * Add multiple import templates
42024
+ *
42025
+ * @param {Array.<Object>} body import template(s) to add
42026
+ */
42027
+ postOutboundImporttemplatesBulkAdd(body) {
42028
+ // verify the required parameter 'body' is set
42029
+ if (body === undefined || body === null) {
42030
+ throw 'Missing the required parameter "body" when calling postOutboundImporttemplatesBulkAdd';
42031
+ }
42032
+
42033
+ return this.apiClient.callApi(
42034
+ '/api/v2/outbound/importtemplates/bulk/add',
42035
+ 'POST',
42036
+ { },
42037
+ { },
42038
+ { },
42039
+ { },
42040
+ body,
42041
+ ['PureCloud OAuth'],
42042
+ ['application/json'],
42043
+ ['application/json']
42044
+ );
42045
+ }
42046
+
41198
42047
  /**
41199
42048
  * Create a Messaging Campaign
41200
42049
  *
@@ -41575,6 +42424,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41575
42424
  );
41576
42425
  }
41577
42426
 
42427
+ /**
42428
+ * Update a contact list template.
42429
+ *
42430
+ * @param {String} contactListTemplateId ContactListTemplate ID
42431
+ * @param {Object} body ContactListTemplate
42432
+ */
42433
+ putOutboundContactlisttemplate(contactListTemplateId, body) {
42434
+ // verify the required parameter 'contactListTemplateId' is set
42435
+ if (contactListTemplateId === undefined || contactListTemplateId === null) {
42436
+ throw 'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';
42437
+ }
42438
+ // verify the required parameter 'body' is set
42439
+ if (body === undefined || body === null) {
42440
+ throw 'Missing the required parameter "body" when calling putOutboundContactlisttemplate';
42441
+ }
42442
+
42443
+ return this.apiClient.callApi(
42444
+ '/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
42445
+ 'PUT',
42446
+ { 'contactListTemplateId': contactListTemplateId },
42447
+ { },
42448
+ { },
42449
+ { },
42450
+ body,
42451
+ ['PureCloud OAuth'],
42452
+ ['application/json'],
42453
+ ['application/json']
42454
+ );
42455
+ }
42456
+
41578
42457
  /**
41579
42458
  * Update an Outbound Digital Rule Set
41580
42459
  *
@@ -41635,6 +42514,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41635
42514
  );
41636
42515
  }
41637
42516
 
42517
+ /**
42518
+ * Update Import Template
42519
+ *
42520
+ * @param {String} importTemplateId Import Template ID
42521
+ * @param {Object} body importTemplate
42522
+ */
42523
+ putOutboundImporttemplate(importTemplateId, body) {
42524
+ // verify the required parameter 'importTemplateId' is set
42525
+ if (importTemplateId === undefined || importTemplateId === null) {
42526
+ throw 'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';
42527
+ }
42528
+ // verify the required parameter 'body' is set
42529
+ if (body === undefined || body === null) {
42530
+ throw 'Missing the required parameter "body" when calling putOutboundImporttemplate';
42531
+ }
42532
+
42533
+ return this.apiClient.callApi(
42534
+ '/api/v2/outbound/importtemplates/{importTemplateId}',
42535
+ 'PUT',
42536
+ { 'importTemplateId': importTemplateId },
42537
+ { },
42538
+ { },
42539
+ { },
42540
+ body,
42541
+ ['PureCloud OAuth'],
42542
+ ['application/json'],
42543
+ ['application/json']
42544
+ );
42545
+ }
42546
+
41638
42547
  /**
41639
42548
  * Update an Outbound Messaging Campaign
41640
42549
  *
@@ -41876,7 +42785,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41876
42785
  /**
41877
42786
  * Presence service.
41878
42787
  * @module purecloud-platform-client-v2/api/PresenceApi
41879
- * @version 183.0.0
42788
+ * @version 185.0.0
41880
42789
  */
41881
42790
 
41882
42791
  /**
@@ -42615,7 +43524,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42615
43524
  /**
42616
43525
  * ProcessAutomation service.
42617
43526
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
42618
- * @version 183.0.0
43527
+ * @version 185.0.0
42619
43528
  */
42620
43529
 
42621
43530
  /**
@@ -42854,7 +43763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42854
43763
  /**
42855
43764
  * Quality service.
42856
43765
  * @module purecloud-platform-client-v2/api/QualityApi
42857
- * @version 183.0.0
43766
+ * @version 185.0.0
42858
43767
  */
42859
43768
 
42860
43769
  /**
@@ -44611,7 +45520,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44611
45520
  /**
44612
45521
  * Recording service.
44613
45522
  * @module purecloud-platform-client-v2/api/RecordingApi
44614
- * @version 183.0.0
45523
+ * @version 185.0.0
44615
45524
  */
44616
45525
 
44617
45526
  /**
@@ -46248,7 +47157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46248
47157
  /**
46249
47158
  * ResponseManagement service.
46250
47159
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
46251
- * @version 183.0.0
47160
+ * @version 185.0.0
46252
47161
  */
46253
47162
 
46254
47163
  /**
@@ -46733,7 +47642,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46733
47642
  /**
46734
47643
  * Routing service.
46735
47644
  * @module purecloud-platform-client-v2/api/RoutingApi
46736
- * @version 183.0.0
47645
+ * @version 185.0.0
46737
47646
  */
46738
47647
 
46739
47648
  /**
@@ -47188,6 +48097,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47188
48097
  );
47189
48098
  }
47190
48099
 
48100
+ /**
48101
+ * Delete a utilization label
48102
+ *
48103
+ * @param {String} labelId Utilization Label ID
48104
+ * @param {Object} opts Optional parameters
48105
+ * @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
48106
+ * deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
48107
+ */
48108
+ deleteRoutingUtilizationLabel(labelId, opts) {
48109
+ opts = opts || {};
48110
+
48111
+ // verify the required parameter 'labelId' is set
48112
+ if (labelId === undefined || labelId === null) {
48113
+ throw 'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';
48114
+ }
48115
+
48116
+ return this.apiClient.callApi(
48117
+ '/api/v2/routing/utilization/labels/{labelId}',
48118
+ 'DELETE',
48119
+ { 'labelId': labelId },
48120
+ { 'forceDelete': opts['forceDelete'] },
48121
+ { },
48122
+ { },
48123
+ null,
48124
+ ['PureCloud OAuth'],
48125
+ ['application/json'],
48126
+ ['application/json']
48127
+ );
48128
+ }
48129
+
47191
48130
  /**
47192
48131
  * Delete an utilization tag
47193
48132
  *
@@ -48678,6 +49617,86 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48678
49617
  );
48679
49618
  }
48680
49619
 
49620
+ /**
49621
+ * Get details about this utilization label
49622
+ *
49623
+ * @param {String} labelId Utilization Label ID
49624
+ * getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49625
+ */
49626
+ getRoutingUtilizationLabel(labelId) {
49627
+ // verify the required parameter 'labelId' is set
49628
+ if (labelId === undefined || labelId === null) {
49629
+ throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';
49630
+ }
49631
+
49632
+ return this.apiClient.callApi(
49633
+ '/api/v2/routing/utilization/labels/{labelId}',
49634
+ 'GET',
49635
+ { 'labelId': labelId },
49636
+ { },
49637
+ { },
49638
+ { },
49639
+ null,
49640
+ ['PureCloud OAuth'],
49641
+ ['application/json'],
49642
+ ['application/json']
49643
+ );
49644
+ }
49645
+
49646
+ /**
49647
+ * Get list of agent ids associated with a utilization label
49648
+ *
49649
+ * @param {String} labelId Utilization Label ID
49650
+ * getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49651
+ */
49652
+ getRoutingUtilizationLabelAgents(labelId) {
49653
+ // verify the required parameter 'labelId' is set
49654
+ if (labelId === undefined || labelId === null) {
49655
+ throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';
49656
+ }
49657
+
49658
+ return this.apiClient.callApi(
49659
+ '/api/v2/routing/utilization/labels/{labelId}/agents',
49660
+ 'GET',
49661
+ { 'labelId': labelId },
49662
+ { },
49663
+ { },
49664
+ { },
49665
+ null,
49666
+ ['PureCloud OAuth'],
49667
+ ['application/json'],
49668
+ ['application/json']
49669
+ );
49670
+ }
49671
+
49672
+ /**
49673
+ * Get list of utilization labels
49674
+ *
49675
+ * @param {Object} opts Optional parameters
49676
+ * @param {Number} opts.pageSize Page size (default to 25)
49677
+ * @param {Number} opts.pageNumber Page number (default to 1)
49678
+ * @param {Object} opts.sortOrder Sort order by name (default to ascending)
49679
+ * @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
49680
+ * getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49681
+ */
49682
+ getRoutingUtilizationLabels(opts) {
49683
+ opts = opts || {};
49684
+
49685
+
49686
+ return this.apiClient.callApi(
49687
+ '/api/v2/routing/utilization/labels',
49688
+ 'GET',
49689
+ { },
49690
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
49691
+ { },
49692
+ { },
49693
+ null,
49694
+ ['PureCloud OAuth'],
49695
+ ['application/json'],
49696
+ ['application/json']
49697
+ );
49698
+ }
49699
+
48681
49700
  /**
48682
49701
  * Get details about this utilization tag
48683
49702
  *
@@ -49974,6 +50993,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49974
50993
  );
49975
50994
  }
49976
50995
 
50996
+ /**
50997
+ * Create a utilization label
50998
+ *
50999
+ * @param {Object} body UtilizationLabel
51000
+ * postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51001
+ */
51002
+ postRoutingUtilizationLabels(body) {
51003
+ // verify the required parameter 'body' is set
51004
+ if (body === undefined || body === null) {
51005
+ throw 'Missing the required parameter "body" when calling postRoutingUtilizationLabels';
51006
+ }
51007
+
51008
+ return this.apiClient.callApi(
51009
+ '/api/v2/routing/utilization/labels',
51010
+ 'POST',
51011
+ { },
51012
+ { },
51013
+ { },
51014
+ { },
51015
+ body,
51016
+ ['PureCloud OAuth'],
51017
+ ['application/json'],
51018
+ ['application/json']
51019
+ );
51020
+ }
51021
+
49977
51022
  /**
49978
51023
  * Create an utilization tag
49979
51024
  *
@@ -50340,6 +51385,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50340
51385
  );
50341
51386
  }
50342
51387
 
51388
+ /**
51389
+ * Update a utilization label
51390
+ *
51391
+ * @param {String} labelId Utilization Label ID
51392
+ * @param {Object} body UtilizationLabel
51393
+ * putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51394
+ */
51395
+ putRoutingUtilizationLabel(labelId, body) {
51396
+ // verify the required parameter 'labelId' is set
51397
+ if (labelId === undefined || labelId === null) {
51398
+ throw 'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';
51399
+ }
51400
+ // verify the required parameter 'body' is set
51401
+ if (body === undefined || body === null) {
51402
+ throw 'Missing the required parameter "body" when calling putRoutingUtilizationLabel';
51403
+ }
51404
+
51405
+ return this.apiClient.callApi(
51406
+ '/api/v2/routing/utilization/labels/{labelId}',
51407
+ 'PUT',
51408
+ { 'labelId': labelId },
51409
+ { },
51410
+ { },
51411
+ { },
51412
+ body,
51413
+ ['PureCloud OAuth'],
51414
+ ['application/json'],
51415
+ ['application/json']
51416
+ );
51417
+ }
51418
+
50343
51419
  /**
50344
51420
  * Update wrap-up code
50345
51421
  *
@@ -50441,7 +51517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50441
51517
  /**
50442
51518
  * SCIM service.
50443
51519
  * @module purecloud-platform-client-v2/api/SCIMApi
50444
- * @version 183.0.0
51520
+ * @version 185.0.0
50445
51521
  */
50446
51522
 
50447
51523
  /**
@@ -51318,7 +52394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51318
52394
  /**
51319
52395
  * Scripts service.
51320
52396
  * @module purecloud-platform-client-v2/api/ScriptsApi
51321
- * @version 183.0.0
52397
+ * @version 185.0.0
51322
52398
  */
51323
52399
 
51324
52400
  /**
@@ -51762,7 +52838,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51762
52838
  /**
51763
52839
  * Search service.
51764
52840
  * @module purecloud-platform-client-v2/api/SearchApi
51765
- * @version 183.0.0
52841
+ * @version 185.0.0
51766
52842
  */
51767
52843
 
51768
52844
  /**
@@ -52451,7 +53527,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
52451
53527
  /**
52452
53528
  * Settings service.
52453
53529
  * @module purecloud-platform-client-v2/api/SettingsApi
52454
- * @version 183.0.0
53530
+ * @version 185.0.0
52455
53531
  */
52456
53532
 
52457
53533
  /**
@@ -52516,7 +53592,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
52516
53592
  /**
52517
53593
  * SpeechTextAnalytics service.
52518
53594
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
52519
- * @version 183.0.0
53595
+ * @version 185.0.0
52520
53596
  */
52521
53597
 
52522
53598
  /**
@@ -53629,7 +54705,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53629
54705
  /**
53630
54706
  * Stations service.
53631
54707
  * @module purecloud-platform-client-v2/api/StationsApi
53632
- * @version 183.0.0
54708
+ * @version 185.0.0
53633
54709
  */
53634
54710
 
53635
54711
  /**
@@ -53731,7 +54807,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53731
54807
  /**
53732
54808
  * Suggest service.
53733
54809
  * @module purecloud-platform-client-v2/api/SuggestApi
53734
- * @version 183.0.0
54810
+ * @version 185.0.0
53735
54811
  */
53736
54812
 
53737
54813
  /**
@@ -53870,7 +54946,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53870
54946
  /**
53871
54947
  * TaskManagement service.
53872
54948
  * @module purecloud-platform-client-v2/api/TaskManagementApi
53873
- * @version 183.0.0
54949
+ * @version 185.0.0
53874
54950
  */
53875
54951
 
53876
54952
  /**
@@ -55151,7 +56227,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55151
56227
  /**
55152
56228
  * Teams service.
55153
56229
  * @module purecloud-platform-client-v2/api/TeamsApi
55154
- * @version 183.0.0
56230
+ * @version 185.0.0
55155
56231
  */
55156
56232
 
55157
56233
  /**
@@ -55453,7 +56529,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55453
56529
  /**
55454
56530
  * Telephony service.
55455
56531
  * @module purecloud-platform-client-v2/api/TelephonyApi
55456
- * @version 183.0.0
56532
+ * @version 185.0.0
55457
56533
  */
55458
56534
 
55459
56535
  /**
@@ -55637,7 +56713,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55637
56713
  /**
55638
56714
  * TelephonyProvidersEdge service.
55639
56715
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
55640
- * @version 183.0.0
56716
+ * @version 185.0.0
55641
56717
  */
55642
56718
 
55643
56719
  /**
@@ -56405,8 +57481,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56405
57481
  }
56406
57482
 
56407
57483
  /**
56408
- * Get the list of available languages.
57484
+ * Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
56409
57485
  *
57486
+ * @deprecated
56410
57487
  */
56411
57488
  getTelephonyProvidersEdgesAvailablelanguages() {
56412
57489
 
@@ -59011,7 +60088,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59011
60088
  /**
59012
60089
  * Textbots service.
59013
60090
  * @module purecloud-platform-client-v2/api/TextbotsApi
59014
- * @version 183.0.0
60091
+ * @version 185.0.0
59015
60092
  */
59016
60093
 
59017
60094
  /**
@@ -59139,7 +60216,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59139
60216
  /**
59140
60217
  * Tokens service.
59141
60218
  * @module purecloud-platform-client-v2/api/TokensApi
59142
- * @version 183.0.0
60219
+ * @version 185.0.0
59143
60220
  */
59144
60221
 
59145
60222
  /**
@@ -59295,7 +60372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59295
60372
  /**
59296
60373
  * Uploads service.
59297
60374
  * @module purecloud-platform-client-v2/api/UploadsApi
59298
- * @version 183.0.0
60375
+ * @version 185.0.0
59299
60376
  */
59300
60377
 
59301
60378
  /**
@@ -59471,7 +60548,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59471
60548
  /**
59472
60549
  * Usage service.
59473
60550
  * @module purecloud-platform-client-v2/api/UsageApi
59474
- * @version 183.0.0
60551
+ * @version 185.0.0
59475
60552
  */
59476
60553
 
59477
60554
  /**
@@ -59681,7 +60758,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59681
60758
  /**
59682
60759
  * UserRecordings service.
59683
60760
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
59684
- * @version 183.0.0
60761
+ * @version 185.0.0
59685
60762
  */
59686
60763
 
59687
60764
  /**
@@ -59866,7 +60943,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59866
60943
  /**
59867
60944
  * Users service.
59868
60945
  * @module purecloud-platform-client-v2/api/UsersApi
59869
- * @version 183.0.0
60946
+ * @version 185.0.0
59870
60947
  */
59871
60948
 
59872
60949
  /**
@@ -62517,7 +63594,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62517
63594
  /**
62518
63595
  * Utilities service.
62519
63596
  * @module purecloud-platform-client-v2/api/UtilitiesApi
62520
- * @version 183.0.0
63597
+ * @version 185.0.0
62521
63598
  */
62522
63599
 
62523
63600
  /**
@@ -62628,7 +63705,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62628
63705
  /**
62629
63706
  * Voicemail service.
62630
63707
  * @module purecloud-platform-client-v2/api/VoicemailApi
62631
- * @version 183.0.0
63708
+ * @version 185.0.0
62632
63709
  */
62633
63710
 
62634
63711
  /**
@@ -63295,7 +64372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63295
64372
  /**
63296
64373
  * WebChat service.
63297
64374
  * @module purecloud-platform-client-v2/api/WebChatApi
63298
- * @version 183.0.0
64375
+ * @version 185.0.0
63299
64376
  */
63300
64377
 
63301
64378
  /**
@@ -63844,7 +64921,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63844
64921
  /**
63845
64922
  * WebDeployments service.
63846
64923
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
63847
- * @version 183.0.0
64924
+ * @version 185.0.0
63848
64925
  */
63849
64926
 
63850
64927
  /**
@@ -64371,7 +65448,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64371
65448
  /**
64372
65449
  * WebMessaging service.
64373
65450
  * @module purecloud-platform-client-v2/api/WebMessagingApi
64374
- * @version 183.0.0
65451
+ * @version 185.0.0
64375
65452
  */
64376
65453
 
64377
65454
  /**
@@ -64417,7 +65494,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64417
65494
  /**
64418
65495
  * Widgets service.
64419
65496
  * @module purecloud-platform-client-v2/api/WidgetsApi
64420
- * @version 183.0.0
65497
+ * @version 185.0.0
64421
65498
  */
64422
65499
 
64423
65500
  /**
@@ -64563,7 +65640,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64563
65640
  /**
64564
65641
  * WorkforceManagement service.
64565
65642
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
64566
- * @version 183.0.0
65643
+ * @version 185.0.0
64567
65644
  */
64568
65645
 
64569
65646
  /**
@@ -65697,6 +66774,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65697
66774
  );
65698
66775
  }
65699
66776
 
66777
+ /**
66778
+ * Get the performance prediction for the associated schedule
66779
+ *
66780
+ * @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
66781
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format
66782
+ * @param {String} scheduleId The ID of the schedule the performance prediction belongs to
66783
+ */
66784
+ getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(businessUnitId, weekId, scheduleId) {
66785
+ // verify the required parameter 'businessUnitId' is set
66786
+ if (businessUnitId === undefined || businessUnitId === null) {
66787
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
66788
+ }
66789
+ // verify the required parameter 'weekId' is set
66790
+ if (weekId === undefined || weekId === null) {
66791
+ throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
66792
+ }
66793
+ // verify the required parameter 'scheduleId' is set
66794
+ if (scheduleId === undefined || scheduleId === null) {
66795
+ throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
66796
+ }
66797
+
66798
+ return this.apiClient.callApi(
66799
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions',
66800
+ 'GET',
66801
+ { 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
66802
+ { },
66803
+ { },
66804
+ { },
66805
+ null,
66806
+ ['PureCloud OAuth'],
66807
+ ['application/json'],
66808
+ ['application/json']
66809
+ );
66810
+ }
66811
+
66812
+ /**
66813
+ * Get recalculated performance prediction result
66814
+ *
66815
+ * @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
66816
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format
66817
+ * @param {String} scheduleId The ID of the schedule the recalculation belongs to
66818
+ * @param {String} recalculationId The ID of the recalculation request
66819
+ */
66820
+ getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(businessUnitId, weekId, scheduleId, recalculationId) {
66821
+ // verify the required parameter 'businessUnitId' is set
66822
+ if (businessUnitId === undefined || businessUnitId === null) {
66823
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
66824
+ }
66825
+ // verify the required parameter 'weekId' is set
66826
+ if (weekId === undefined || weekId === null) {
66827
+ throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
66828
+ }
66829
+ // verify the required parameter 'scheduleId' is set
66830
+ if (scheduleId === undefined || scheduleId === null) {
66831
+ throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
66832
+ }
66833
+ // verify the required parameter 'recalculationId' is set
66834
+ if (recalculationId === undefined || recalculationId === null) {
66835
+ throw 'Missing the required parameter "recalculationId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
66836
+ }
66837
+
66838
+ return this.apiClient.callApi(
66839
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}',
66840
+ 'GET',
66841
+ { 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId,'recalculationId': recalculationId },
66842
+ { },
66843
+ { },
66844
+ { },
66845
+ null,
66846
+ ['PureCloud OAuth'],
66847
+ ['application/json'],
66848
+ ['application/json']
66849
+ );
66850
+ }
66851
+
65700
66852
  /**
65701
66853
  * Get the list of week schedules for the specified week
65702
66854
  * 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
@@ -65920,6 +67072,45 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65920
67072
  );
65921
67073
  }
65922
67074
 
67075
+ /**
67076
+ * Get the staffing requirement by planning group for a forecast
67077
+ *
67078
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
67079
+ * @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
67080
+ * @param {String} forecastId The ID of the forecast
67081
+ * @param {Object} opts Optional parameters
67082
+ * @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
67083
+ */
67084
+ getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId, weekDateId, forecastId, opts) {
67085
+ opts = opts || {};
67086
+
67087
+ // verify the required parameter 'businessUnitId' is set
67088
+ if (businessUnitId === undefined || businessUnitId === null) {
67089
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
67090
+ }
67091
+ // verify the required parameter 'weekDateId' is set
67092
+ if (weekDateId === undefined || weekDateId === null) {
67093
+ throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
67094
+ }
67095
+ // verify the required parameter 'forecastId' is set
67096
+ if (forecastId === undefined || forecastId === null) {
67097
+ throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
67098
+ }
67099
+
67100
+ return this.apiClient.callApi(
67101
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement',
67102
+ 'GET',
67103
+ { 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
67104
+ { 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi') },
67105
+ { },
67106
+ { },
67107
+ null,
67108
+ ['PureCloud OAuth'],
67109
+ ['application/json'],
67110
+ ['application/json']
67111
+ );
67112
+ }
67113
+
65923
67114
  /**
65924
67115
  * Get short term forecasts
65925
67116
  * 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
@@ -67271,6 +68462,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67271
68462
  );
67272
68463
  }
67273
68464
 
68465
+ /**
68466
+ * Update agent configurations
68467
+ *
68468
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
68469
+ * @param {Object} opts Optional parameters
68470
+ * @param {Object} opts.body body
68471
+ */
68472
+ patchWorkforcemanagementManagementunitAgents(managementUnitId, opts) {
68473
+ opts = opts || {};
68474
+
68475
+ // verify the required parameter 'managementUnitId' is set
68476
+ if (managementUnitId === undefined || managementUnitId === null) {
68477
+ throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';
68478
+ }
68479
+
68480
+ return this.apiClient.callApi(
68481
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents',
68482
+ 'PATCH',
68483
+ { 'managementUnitId': managementUnitId },
68484
+ { },
68485
+ { },
68486
+ { },
68487
+ opts['body'],
68488
+ ['PureCloud OAuth'],
68489
+ ['application/json'],
68490
+ ['application/json']
68491
+ );
68492
+ }
68493
+
67274
68494
  /**
67275
68495
  * Updates a time off limit object.
67276
68496
  * Updates time off limit object properties, but not daily values.
@@ -68089,6 +69309,84 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68089
69309
  );
68090
69310
  }
68091
69311
 
69312
+ /**
69313
+ * Request a daily recalculation of the performance prediction for the associated schedule
69314
+ *
69315
+ * @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
69316
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format
69317
+ * @param {String} scheduleId The ID of the schedule the performance prediction belongs to
69318
+ * @param {Object} opts Optional parameters
69319
+ * @param {Object} opts.body body
69320
+ */
69321
+ postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId, opts) {
69322
+ opts = opts || {};
69323
+
69324
+ // verify the required parameter 'businessUnitId' is set
69325
+ if (businessUnitId === undefined || businessUnitId === null) {
69326
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
69327
+ }
69328
+ // verify the required parameter 'weekId' is set
69329
+ if (weekId === undefined || weekId === null) {
69330
+ throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
69331
+ }
69332
+ // verify the required parameter 'scheduleId' is set
69333
+ if (scheduleId === undefined || scheduleId === null) {
69334
+ throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
69335
+ }
69336
+
69337
+ return this.apiClient.callApi(
69338
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations',
69339
+ 'POST',
69340
+ { 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
69341
+ { },
69342
+ { },
69343
+ { },
69344
+ opts['body'],
69345
+ ['PureCloud OAuth'],
69346
+ ['application/json'],
69347
+ ['application/json']
69348
+ );
69349
+ }
69350
+
69351
+ /**
69352
+ * Upload daily activity changes to be able to request a performance prediction recalculation
69353
+ *
69354
+ * @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
69355
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format
69356
+ * @param {String} scheduleId The ID of the schedule the performance prediction belongs to
69357
+ * @param {Object} opts Optional parameters
69358
+ * @param {Object} opts.body body
69359
+ */
69360
+ postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId, opts) {
69361
+ opts = opts || {};
69362
+
69363
+ // verify the required parameter 'businessUnitId' is set
69364
+ if (businessUnitId === undefined || businessUnitId === null) {
69365
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
69366
+ }
69367
+ // verify the required parameter 'weekId' is set
69368
+ if (weekId === undefined || weekId === null) {
69369
+ throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
69370
+ }
69371
+ // verify the required parameter 'scheduleId' is set
69372
+ if (scheduleId === undefined || scheduleId === null) {
69373
+ throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
69374
+ }
69375
+
69376
+ return this.apiClient.callApi(
69377
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl',
69378
+ 'POST',
69379
+ { 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
69380
+ { },
69381
+ { },
69382
+ { },
69383
+ opts['body'],
69384
+ ['PureCloud OAuth'],
69385
+ ['application/json'],
69386
+ ['application/json']
69387
+ );
69388
+ }
69389
+
68092
69390
  /**
68093
69391
  * Start a rescheduling run
68094
69392
  *
@@ -69737,7 +71035,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69737
71035
  * </pre>
69738
71036
  * </p>
69739
71037
  * @module purecloud-platform-client-v2/index
69740
- * @version 183.0.0
71038
+ * @version 185.0.0
69741
71039
  */
69742
71040
  class platformClient {
69743
71041
  constructor() {
@@ -69916,6 +71214,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69916
71214
  * @property {module:purecloud-platform-client-v2/api/LocationsApi}
69917
71215
  */
69918
71216
  this.LocationsApi = LocationsApi;
71217
+ /**
71218
+ * The LogCaptureApi service constructor.
71219
+ * @property {module:purecloud-platform-client-v2/api/LogCaptureApi}
71220
+ */
71221
+ this.LogCaptureApi = LogCaptureApi;
69919
71222
  /**
69920
71223
  * The MessagingApi service constructor.
69921
71224
  * @property {module:purecloud-platform-client-v2/api/MessagingApi}