purecloud-platform-client-v2 184.0.0 → 186.0.1
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.
- package/README.md +68 -2
- package/dist/node/purecloud-platform-client-v2.js +1103 -156
- package/dist/web-amd/purecloud-platform-client-v2.js +1103 -156
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +349 -140
- package/dist/web-cjs/purecloud-platform-client-v2.js +354 -142
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +711 -161
- package/package.json +2 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +334 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -4
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +58 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -62
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +7 -7
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +131 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +247 -2
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -3
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +5 -4
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +222 -1
- 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
|
|
405
|
+
* @version 186.0.1
|
|
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
|
|
1824
|
+
* @version 186.0.1
|
|
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
|
|
2485
|
+
* @version 186.0.1
|
|
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
|
|
5075
|
+
* @version 186.0.1
|
|
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
|
|
8910
|
+
* @version 186.0.1
|
|
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
|
|
9081
|
+
* @version 186.0.1
|
|
8749
9082
|
*/
|
|
8750
9083
|
|
|
8751
9084
|
/**
|
|
@@ -8919,7 +9252,6 @@ class AuthorizationApi {
|
|
|
8919
9252
|
* @param {String} opts.nextPage next page token
|
|
8920
9253
|
* @param {String} opts.previousPage Previous page token
|
|
8921
9254
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
8922
|
-
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
8923
9255
|
* @param {String} opts.name Search term to filter by division name
|
|
8924
9256
|
*/
|
|
8925
9257
|
getAuthorizationDivisions(opts) {
|
|
@@ -8930,7 +9262,7 @@ class AuthorizationApi {
|
|
|
8930
9262
|
'/api/v2/authorization/divisions',
|
|
8931
9263
|
'GET',
|
|
8932
9264
|
{ },
|
|
8933
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'
|
|
9265
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'name': opts['name'] },
|
|
8934
9266
|
{ },
|
|
8935
9267
|
{ },
|
|
8936
9268
|
null,
|
|
@@ -9128,7 +9460,7 @@ class AuthorizationApi {
|
|
|
9128
9460
|
* Get the organization role specified by its ID.
|
|
9129
9461
|
* @param {String} roleId Role ID
|
|
9130
9462
|
* @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)
|
|
9463
|
+
* @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
9464
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand. unusedPermissions returns the permissions not used for the role
|
|
9133
9465
|
*/
|
|
9134
9466
|
getAuthorizationRole(roleId, opts) {
|
|
@@ -9975,7 +10307,7 @@ class BillingApi {
|
|
|
9975
10307
|
/**
|
|
9976
10308
|
* Billing service.
|
|
9977
10309
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9978
|
-
* @version
|
|
10310
|
+
* @version 186.0.1
|
|
9979
10311
|
*/
|
|
9980
10312
|
|
|
9981
10313
|
/**
|
|
@@ -10055,7 +10387,7 @@ class CarrierServicesApi {
|
|
|
10055
10387
|
/**
|
|
10056
10388
|
* CarrierServices service.
|
|
10057
10389
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10058
|
-
* @version
|
|
10390
|
+
* @version 186.0.1
|
|
10059
10391
|
*/
|
|
10060
10392
|
|
|
10061
10393
|
/**
|
|
@@ -10125,7 +10457,7 @@ class ChatApi {
|
|
|
10125
10457
|
/**
|
|
10126
10458
|
* Chat service.
|
|
10127
10459
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10128
|
-
* @version
|
|
10460
|
+
* @version 186.0.1
|
|
10129
10461
|
*/
|
|
10130
10462
|
|
|
10131
10463
|
/**
|
|
@@ -10512,6 +10844,32 @@ class ChatApi {
|
|
|
10512
10844
|
);
|
|
10513
10845
|
}
|
|
10514
10846
|
|
|
10847
|
+
/**
|
|
10848
|
+
* Get a user's chat settings
|
|
10849
|
+
*
|
|
10850
|
+
* @param {String} userId User ID
|
|
10851
|
+
* getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10852
|
+
*/
|
|
10853
|
+
getChatsUserSettings(userId) {
|
|
10854
|
+
// verify the required parameter 'userId' is set
|
|
10855
|
+
if (userId === undefined || userId === null) {
|
|
10856
|
+
throw 'Missing the required parameter "userId" when calling getChatsUserSettings';
|
|
10857
|
+
}
|
|
10858
|
+
|
|
10859
|
+
return this.apiClient.callApi(
|
|
10860
|
+
'/api/v2/chats/users/{userId}/settings',
|
|
10861
|
+
'GET',
|
|
10862
|
+
{ 'userId': userId },
|
|
10863
|
+
{ },
|
|
10864
|
+
{ },
|
|
10865
|
+
{ },
|
|
10866
|
+
null,
|
|
10867
|
+
['PureCloud OAuth'],
|
|
10868
|
+
['application/json'],
|
|
10869
|
+
['application/json']
|
|
10870
|
+
);
|
|
10871
|
+
}
|
|
10872
|
+
|
|
10515
10873
|
/**
|
|
10516
10874
|
* Set properties for a room
|
|
10517
10875
|
*
|
|
@@ -10640,6 +10998,37 @@ class ChatApi {
|
|
|
10640
10998
|
);
|
|
10641
10999
|
}
|
|
10642
11000
|
|
|
11001
|
+
/**
|
|
11002
|
+
* Update a user's chat settings
|
|
11003
|
+
*
|
|
11004
|
+
* @param {String} userId User ID
|
|
11005
|
+
* @param {Object} body
|
|
11006
|
+
* patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11007
|
+
*/
|
|
11008
|
+
patchChatsUserSettings(userId, body) {
|
|
11009
|
+
// verify the required parameter 'userId' is set
|
|
11010
|
+
if (userId === undefined || userId === null) {
|
|
11011
|
+
throw 'Missing the required parameter "userId" when calling patchChatsUserSettings';
|
|
11012
|
+
}
|
|
11013
|
+
// verify the required parameter 'body' is set
|
|
11014
|
+
if (body === undefined || body === null) {
|
|
11015
|
+
throw 'Missing the required parameter "body" when calling patchChatsUserSettings';
|
|
11016
|
+
}
|
|
11017
|
+
|
|
11018
|
+
return this.apiClient.callApi(
|
|
11019
|
+
'/api/v2/chats/users/{userId}/settings',
|
|
11020
|
+
'PATCH',
|
|
11021
|
+
{ 'userId': userId },
|
|
11022
|
+
{ },
|
|
11023
|
+
{ },
|
|
11024
|
+
{ },
|
|
11025
|
+
body,
|
|
11026
|
+
['PureCloud OAuth'],
|
|
11027
|
+
['application/json'],
|
|
11028
|
+
['application/json']
|
|
11029
|
+
);
|
|
11030
|
+
}
|
|
11031
|
+
|
|
10643
11032
|
/**
|
|
10644
11033
|
* Send a message to a room
|
|
10645
11034
|
*
|
|
@@ -10821,7 +11210,7 @@ class CoachingApi {
|
|
|
10821
11210
|
/**
|
|
10822
11211
|
* Coaching service.
|
|
10823
11212
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
10824
|
-
* @version
|
|
11213
|
+
* @version 186.0.1
|
|
10825
11214
|
*/
|
|
10826
11215
|
|
|
10827
11216
|
/**
|
|
@@ -11398,7 +11787,7 @@ class ContentManagementApi {
|
|
|
11398
11787
|
/**
|
|
11399
11788
|
* ContentManagement service.
|
|
11400
11789
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11401
|
-
* @version
|
|
11790
|
+
* @version 186.0.1
|
|
11402
11791
|
*/
|
|
11403
11792
|
|
|
11404
11793
|
/**
|
|
@@ -11610,41 +11999,6 @@ class ContentManagementApi {
|
|
|
11610
11999
|
);
|
|
11611
12000
|
}
|
|
11612
12001
|
|
|
11613
|
-
/**
|
|
11614
|
-
* Get a list of audits for a document.
|
|
11615
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
11616
|
-
* @param {String} documentId Document ID
|
|
11617
|
-
* @param {Object} opts Optional parameters
|
|
11618
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11619
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11620
|
-
* @param {String} opts.transactionFilter Transaction filter
|
|
11621
|
-
* @param {String} opts.level level (default to USER)
|
|
11622
|
-
* @param {String} opts.sortBy Sort by
|
|
11623
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
11624
|
-
* @deprecated
|
|
11625
|
-
*/
|
|
11626
|
-
getContentmanagementDocumentAudits(documentId, opts) {
|
|
11627
|
-
opts = opts || {};
|
|
11628
|
-
|
|
11629
|
-
// verify the required parameter 'documentId' is set
|
|
11630
|
-
if (documentId === undefined || documentId === null) {
|
|
11631
|
-
throw 'Missing the required parameter "documentId" when calling getContentmanagementDocumentAudits';
|
|
11632
|
-
}
|
|
11633
|
-
|
|
11634
|
-
return this.apiClient.callApi(
|
|
11635
|
-
'/api/v2/contentmanagement/documents/{documentId}/audits',
|
|
11636
|
-
'GET',
|
|
11637
|
-
{ 'documentId': documentId },
|
|
11638
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'transactionFilter': opts['transactionFilter'],'level': opts['level'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
11639
|
-
{ },
|
|
11640
|
-
{ },
|
|
11641
|
-
null,
|
|
11642
|
-
['PureCloud OAuth'],
|
|
11643
|
-
['application/json'],
|
|
11644
|
-
['application/json']
|
|
11645
|
-
);
|
|
11646
|
-
}
|
|
11647
|
-
|
|
11648
12002
|
/**
|
|
11649
12003
|
* Download a document.
|
|
11650
12004
|
*
|
|
@@ -12166,32 +12520,6 @@ class ContentManagementApi {
|
|
|
12166
12520
|
);
|
|
12167
12521
|
}
|
|
12168
12522
|
|
|
12169
|
-
/**
|
|
12170
|
-
* Query audits
|
|
12171
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
12172
|
-
* @param {Object} body Allows for a filtered query returning facet information
|
|
12173
|
-
* @deprecated
|
|
12174
|
-
*/
|
|
12175
|
-
postContentmanagementAuditquery(body) {
|
|
12176
|
-
// verify the required parameter 'body' is set
|
|
12177
|
-
if (body === undefined || body === null) {
|
|
12178
|
-
throw 'Missing the required parameter "body" when calling postContentmanagementAuditquery';
|
|
12179
|
-
}
|
|
12180
|
-
|
|
12181
|
-
return this.apiClient.callApi(
|
|
12182
|
-
'/api/v2/contentmanagement/auditquery',
|
|
12183
|
-
'POST',
|
|
12184
|
-
{ },
|
|
12185
|
-
{ },
|
|
12186
|
-
{ },
|
|
12187
|
-
{ },
|
|
12188
|
-
body,
|
|
12189
|
-
['PureCloud OAuth'],
|
|
12190
|
-
['application/json'],
|
|
12191
|
-
['application/json']
|
|
12192
|
-
);
|
|
12193
|
-
}
|
|
12194
|
-
|
|
12195
12523
|
/**
|
|
12196
12524
|
* Update a document.
|
|
12197
12525
|
*
|
|
@@ -12541,7 +12869,7 @@ class ConversationsApi {
|
|
|
12541
12869
|
/**
|
|
12542
12870
|
* Conversations service.
|
|
12543
12871
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12544
|
-
* @version
|
|
12872
|
+
* @version 186.0.1
|
|
12545
12873
|
*/
|
|
12546
12874
|
|
|
12547
12875
|
/**
|
|
@@ -19681,7 +20009,7 @@ class DataExtensionsApi {
|
|
|
19681
20009
|
/**
|
|
19682
20010
|
* DataExtensions service.
|
|
19683
20011
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
19684
|
-
* @version
|
|
20012
|
+
* @version 186.0.1
|
|
19685
20013
|
*/
|
|
19686
20014
|
|
|
19687
20015
|
/**
|
|
@@ -19767,7 +20095,7 @@ class DownloadsApi {
|
|
|
19767
20095
|
/**
|
|
19768
20096
|
* Downloads service.
|
|
19769
20097
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
19770
|
-
* @version
|
|
20098
|
+
* @version 186.0.1
|
|
19771
20099
|
*/
|
|
19772
20100
|
|
|
19773
20101
|
/**
|
|
@@ -19819,7 +20147,7 @@ class EmailsApi {
|
|
|
19819
20147
|
/**
|
|
19820
20148
|
* Emails service.
|
|
19821
20149
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
19822
|
-
* @version
|
|
20150
|
+
* @version 186.0.1
|
|
19823
20151
|
*/
|
|
19824
20152
|
|
|
19825
20153
|
/**
|
|
@@ -19884,7 +20212,7 @@ class EventsApi {
|
|
|
19884
20212
|
/**
|
|
19885
20213
|
* Events service.
|
|
19886
20214
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
19887
|
-
* @version
|
|
20215
|
+
* @version 186.0.1
|
|
19888
20216
|
*/
|
|
19889
20217
|
|
|
19890
20218
|
/**
|
|
@@ -19980,7 +20308,7 @@ class ExternalContactsApi {
|
|
|
19980
20308
|
/**
|
|
19981
20309
|
* ExternalContacts service.
|
|
19982
20310
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
19983
|
-
* @version
|
|
20311
|
+
* @version 186.0.1
|
|
19984
20312
|
*/
|
|
19985
20313
|
|
|
19986
20314
|
/**
|
|
@@ -20306,7 +20634,7 @@ class ExternalContactsApi {
|
|
|
20306
20634
|
* @param {Object} opts Optional parameters
|
|
20307
20635
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20308
20636
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20309
|
-
* @param {String} opts.sortOrder
|
|
20637
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
20310
20638
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20311
20639
|
*/
|
|
20312
20640
|
getExternalcontactsContactNotes(contactId, opts) {
|
|
@@ -20367,7 +20695,7 @@ class ExternalContactsApi {
|
|
|
20367
20695
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20368
20696
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20369
20697
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
20370
|
-
* @param {String} opts.sortOrder
|
|
20698
|
+
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
20371
20699
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20372
20700
|
*/
|
|
20373
20701
|
getExternalcontactsContacts(opts) {
|
|
@@ -20526,7 +20854,7 @@ class ExternalContactsApi {
|
|
|
20526
20854
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20527
20855
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20528
20856
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
20529
|
-
* @param {String} opts.sortOrder
|
|
20857
|
+
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
20530
20858
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20531
20859
|
*/
|
|
20532
20860
|
getExternalcontactsOrganizationContacts(externalOrganizationId, opts) {
|
|
@@ -20592,7 +20920,7 @@ class ExternalContactsApi {
|
|
|
20592
20920
|
* @param {Object} opts Optional parameters
|
|
20593
20921
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20594
20922
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20595
|
-
* @param {String} opts.sortOrder
|
|
20923
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
20596
20924
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20597
20925
|
*/
|
|
20598
20926
|
getExternalcontactsOrganizationNotes(externalOrganizationId, opts) {
|
|
@@ -20625,7 +20953,7 @@ class ExternalContactsApi {
|
|
|
20625
20953
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20626
20954
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20627
20955
|
* @param {Object} opts.expand which fields, if any, to expand
|
|
20628
|
-
* @param {String} opts.sortOrder
|
|
20956
|
+
* @param {String} opts.sortOrder The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. createDate:asc, relationship:desc
|
|
20629
20957
|
*/
|
|
20630
20958
|
getExternalcontactsOrganizationRelationships(externalOrganizationId, opts) {
|
|
20631
20959
|
opts = opts || {};
|
|
@@ -20657,7 +20985,7 @@ class ExternalContactsApi {
|
|
|
20657
20985
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20658
20986
|
* @param {String} opts.q Search query
|
|
20659
20987
|
* @param {Array.<String>} opts.trustorId Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested
|
|
20660
|
-
* @param {String} opts.sortOrder
|
|
20988
|
+
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
20661
20989
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20662
20990
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
20663
20991
|
*/
|
|
@@ -21938,7 +22266,7 @@ class FaxApi {
|
|
|
21938
22266
|
/**
|
|
21939
22267
|
* Fax service.
|
|
21940
22268
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
21941
|
-
* @version
|
|
22269
|
+
* @version 186.0.1
|
|
21942
22270
|
*/
|
|
21943
22271
|
|
|
21944
22272
|
/**
|
|
@@ -22109,7 +22437,7 @@ class FlowsApi {
|
|
|
22109
22437
|
/**
|
|
22110
22438
|
* Flows service.
|
|
22111
22439
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22112
|
-
* @version
|
|
22440
|
+
* @version 186.0.1
|
|
22113
22441
|
*/
|
|
22114
22442
|
|
|
22115
22443
|
/**
|
|
@@ -22293,7 +22621,7 @@ class GamificationApi {
|
|
|
22293
22621
|
/**
|
|
22294
22622
|
* Gamification service.
|
|
22295
22623
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22296
|
-
* @version
|
|
22624
|
+
* @version 186.0.1
|
|
22297
22625
|
*/
|
|
22298
22626
|
|
|
22299
22627
|
/**
|
|
@@ -24379,7 +24707,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
24379
24707
|
/**
|
|
24380
24708
|
* GeneralDataProtectionRegulation service.
|
|
24381
24709
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24382
|
-
* @version
|
|
24710
|
+
* @version 186.0.1
|
|
24383
24711
|
*/
|
|
24384
24712
|
|
|
24385
24713
|
/**
|
|
@@ -24509,7 +24837,7 @@ class GeolocationApi {
|
|
|
24509
24837
|
/**
|
|
24510
24838
|
* Geolocation service.
|
|
24511
24839
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24512
|
-
* @version
|
|
24840
|
+
* @version 186.0.1
|
|
24513
24841
|
*/
|
|
24514
24842
|
|
|
24515
24843
|
/**
|
|
@@ -24640,7 +24968,7 @@ class GreetingsApi {
|
|
|
24640
24968
|
/**
|
|
24641
24969
|
* Greetings service.
|
|
24642
24970
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24643
|
-
* @version
|
|
24971
|
+
* @version 186.0.1
|
|
24644
24972
|
*/
|
|
24645
24973
|
|
|
24646
24974
|
/**
|
|
@@ -25095,7 +25423,7 @@ class GroupsApi {
|
|
|
25095
25423
|
/**
|
|
25096
25424
|
* Groups service.
|
|
25097
25425
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25098
|
-
* @version
|
|
25426
|
+
* @version 186.0.1
|
|
25099
25427
|
*/
|
|
25100
25428
|
|
|
25101
25429
|
/**
|
|
@@ -25614,7 +25942,7 @@ class IdentityProviderApi {
|
|
|
25614
25942
|
/**
|
|
25615
25943
|
* IdentityProvider service.
|
|
25616
25944
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25617
|
-
* @version
|
|
25945
|
+
* @version 186.0.1
|
|
25618
25946
|
*/
|
|
25619
25947
|
|
|
25620
25948
|
/**
|
|
@@ -26370,7 +26698,7 @@ class InfrastructureAsCodeApi {
|
|
|
26370
26698
|
/**
|
|
26371
26699
|
* InfrastructureAsCode service.
|
|
26372
26700
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
26373
|
-
* @version
|
|
26701
|
+
* @version 186.0.1
|
|
26374
26702
|
*/
|
|
26375
26703
|
|
|
26376
26704
|
/**
|
|
@@ -26537,7 +26865,7 @@ class IntegrationsApi {
|
|
|
26537
26865
|
/**
|
|
26538
26866
|
* Integrations service.
|
|
26539
26867
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26540
|
-
* @version
|
|
26868
|
+
* @version 186.0.1
|
|
26541
26869
|
*/
|
|
26542
26870
|
|
|
26543
26871
|
/**
|
|
@@ -27009,6 +27337,31 @@ class IntegrationsApi {
|
|
|
27009
27337
|
);
|
|
27010
27338
|
}
|
|
27011
27339
|
|
|
27340
|
+
/**
|
|
27341
|
+
* Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.
|
|
27342
|
+
*
|
|
27343
|
+
* @param {Object} opts Optional parameters
|
|
27344
|
+
* @param {Object} opts.status Indicates the validity of the certificate in question.
|
|
27345
|
+
* @param {Object} opts.type Indicates the type of the certificate.
|
|
27346
|
+
*/
|
|
27347
|
+
getIntegrationsActionsCertificates(opts) {
|
|
27348
|
+
opts = opts || {};
|
|
27349
|
+
|
|
27350
|
+
|
|
27351
|
+
return this.apiClient.callApi(
|
|
27352
|
+
'/api/v2/integrations/actions/certificates',
|
|
27353
|
+
'GET',
|
|
27354
|
+
{ },
|
|
27355
|
+
{ 'status': opts['status'],'type': opts['type'] },
|
|
27356
|
+
{ },
|
|
27357
|
+
{ },
|
|
27358
|
+
null,
|
|
27359
|
+
['PureCloud OAuth'],
|
|
27360
|
+
['application/json'],
|
|
27361
|
+
['application/json']
|
|
27362
|
+
);
|
|
27363
|
+
}
|
|
27364
|
+
|
|
27012
27365
|
/**
|
|
27013
27366
|
* Retrieves all action drafts associated with the filters passed in via query param.
|
|
27014
27367
|
*
|
|
@@ -28499,7 +28852,7 @@ class JourneyApi {
|
|
|
28499
28852
|
/**
|
|
28500
28853
|
* Journey service.
|
|
28501
28854
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28502
|
-
* @version
|
|
28855
|
+
* @version 186.0.1
|
|
28503
28856
|
*/
|
|
28504
28857
|
|
|
28505
28858
|
/**
|
|
@@ -29730,7 +30083,7 @@ class KnowledgeApi {
|
|
|
29730
30083
|
/**
|
|
29731
30084
|
* Knowledge service.
|
|
29732
30085
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
29733
|
-
* @version
|
|
30086
|
+
* @version 186.0.1
|
|
29734
30087
|
*/
|
|
29735
30088
|
|
|
29736
30089
|
/**
|
|
@@ -32551,7 +32904,7 @@ class LanguageUnderstandingApi {
|
|
|
32551
32904
|
/**
|
|
32552
32905
|
* LanguageUnderstanding service.
|
|
32553
32906
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32554
|
-
* @version
|
|
32907
|
+
* @version 186.0.1
|
|
32555
32908
|
*/
|
|
32556
32909
|
|
|
32557
32910
|
/**
|
|
@@ -33564,7 +33917,7 @@ class LanguagesApi {
|
|
|
33564
33917
|
/**
|
|
33565
33918
|
* Languages service.
|
|
33566
33919
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33567
|
-
* @version
|
|
33920
|
+
* @version 186.0.1
|
|
33568
33921
|
*/
|
|
33569
33922
|
|
|
33570
33923
|
/**
|
|
@@ -33786,7 +34139,7 @@ class LearningApi {
|
|
|
33786
34139
|
/**
|
|
33787
34140
|
* Learning service.
|
|
33788
34141
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33789
|
-
* @version
|
|
34142
|
+
* @version 186.0.1
|
|
33790
34143
|
*/
|
|
33791
34144
|
|
|
33792
34145
|
/**
|
|
@@ -34642,7 +34995,7 @@ class LicenseApi {
|
|
|
34642
34995
|
/**
|
|
34643
34996
|
* License service.
|
|
34644
34997
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34645
|
-
* @version
|
|
34998
|
+
* @version 186.0.1
|
|
34646
34999
|
*/
|
|
34647
35000
|
|
|
34648
35001
|
/**
|
|
@@ -34880,7 +35233,7 @@ class LocationsApi {
|
|
|
34880
35233
|
/**
|
|
34881
35234
|
* Locations service.
|
|
34882
35235
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34883
|
-
* @version
|
|
35236
|
+
* @version 186.0.1
|
|
34884
35237
|
*/
|
|
34885
35238
|
|
|
34886
35239
|
/**
|
|
@@ -35116,7 +35469,7 @@ class LogCaptureApi {
|
|
|
35116
35469
|
/**
|
|
35117
35470
|
* LogCapture service.
|
|
35118
35471
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
35119
|
-
* @version
|
|
35472
|
+
* @version 186.0.1
|
|
35120
35473
|
*/
|
|
35121
35474
|
|
|
35122
35475
|
/**
|
|
@@ -35131,6 +35484,31 @@ class LogCaptureApi {
|
|
|
35131
35484
|
}
|
|
35132
35485
|
|
|
35133
35486
|
|
|
35487
|
+
/**
|
|
35488
|
+
* Disable browser log capture for the user
|
|
35489
|
+
*
|
|
35490
|
+
* @param {String} userId The id of the user to disable browser log capture
|
|
35491
|
+
*/
|
|
35492
|
+
deleteDiagnosticsLogcaptureBrowserUser(userId) {
|
|
35493
|
+
// verify the required parameter 'userId' is set
|
|
35494
|
+
if (userId === undefined || userId === null) {
|
|
35495
|
+
throw 'Missing the required parameter "userId" when calling deleteDiagnosticsLogcaptureBrowserUser';
|
|
35496
|
+
}
|
|
35497
|
+
|
|
35498
|
+
return this.apiClient.callApi(
|
|
35499
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
35500
|
+
'DELETE',
|
|
35501
|
+
{ 'userId': userId },
|
|
35502
|
+
{ },
|
|
35503
|
+
{ },
|
|
35504
|
+
{ },
|
|
35505
|
+
null,
|
|
35506
|
+
['PureCloud OAuth'],
|
|
35507
|
+
['application/json'],
|
|
35508
|
+
['application/json']
|
|
35509
|
+
);
|
|
35510
|
+
}
|
|
35511
|
+
|
|
35134
35512
|
/**
|
|
35135
35513
|
* Gets status of async download execution
|
|
35136
35514
|
*
|
|
@@ -35156,6 +35534,55 @@ class LogCaptureApi {
|
|
|
35156
35534
|
);
|
|
35157
35535
|
}
|
|
35158
35536
|
|
|
35537
|
+
/**
|
|
35538
|
+
* Get log capture configuration for the user
|
|
35539
|
+
*
|
|
35540
|
+
* @param {String} userId The id of the user to get browser log capture configuration
|
|
35541
|
+
*/
|
|
35542
|
+
getDiagnosticsLogcaptureBrowserUser(userId) {
|
|
35543
|
+
// verify the required parameter 'userId' is set
|
|
35544
|
+
if (userId === undefined || userId === null) {
|
|
35545
|
+
throw 'Missing the required parameter "userId" when calling getDiagnosticsLogcaptureBrowserUser';
|
|
35546
|
+
}
|
|
35547
|
+
|
|
35548
|
+
return this.apiClient.callApi(
|
|
35549
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
35550
|
+
'GET',
|
|
35551
|
+
{ 'userId': userId },
|
|
35552
|
+
{ },
|
|
35553
|
+
{ },
|
|
35554
|
+
{ },
|
|
35555
|
+
null,
|
|
35556
|
+
['PureCloud OAuth'],
|
|
35557
|
+
['application/json'],
|
|
35558
|
+
['application/json']
|
|
35559
|
+
);
|
|
35560
|
+
}
|
|
35561
|
+
|
|
35562
|
+
/**
|
|
35563
|
+
* Get all log capture enabled users for an org
|
|
35564
|
+
*
|
|
35565
|
+
* @param {Object} opts Optional parameters
|
|
35566
|
+
* @param {Boolean} opts.includeExpired Include expired users with log captures still available for search or download (default to false)
|
|
35567
|
+
*/
|
|
35568
|
+
getDiagnosticsLogcaptureBrowserUsers(opts) {
|
|
35569
|
+
opts = opts || {};
|
|
35570
|
+
|
|
35571
|
+
|
|
35572
|
+
return this.apiClient.callApi(
|
|
35573
|
+
'/api/v2/diagnostics/logcapture/browser/users',
|
|
35574
|
+
'GET',
|
|
35575
|
+
{ },
|
|
35576
|
+
{ 'includeExpired': opts['includeExpired'] },
|
|
35577
|
+
{ },
|
|
35578
|
+
{ },
|
|
35579
|
+
null,
|
|
35580
|
+
['PureCloud OAuth'],
|
|
35581
|
+
['application/json'],
|
|
35582
|
+
['application/json']
|
|
35583
|
+
);
|
|
35584
|
+
}
|
|
35585
|
+
|
|
35159
35586
|
/**
|
|
35160
35587
|
* Creates an async download execution
|
|
35161
35588
|
*
|
|
@@ -35180,13 +35607,69 @@ class LogCaptureApi {
|
|
|
35180
35607
|
);
|
|
35181
35608
|
}
|
|
35182
35609
|
|
|
35610
|
+
/**
|
|
35611
|
+
* Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.
|
|
35612
|
+
*
|
|
35613
|
+
* @param {Object} opts Optional parameters
|
|
35614
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
35615
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
35616
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
35617
|
+
* @param {Object} opts.body
|
|
35618
|
+
*/
|
|
35619
|
+
postDiagnosticsLogcaptureBrowserEntriesQuery(opts) {
|
|
35620
|
+
opts = opts || {};
|
|
35621
|
+
|
|
35622
|
+
|
|
35623
|
+
return this.apiClient.callApi(
|
|
35624
|
+
'/api/v2/diagnostics/logcapture/browser/entries/query',
|
|
35625
|
+
'POST',
|
|
35626
|
+
{ },
|
|
35627
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
35628
|
+
{ },
|
|
35629
|
+
{ },
|
|
35630
|
+
opts['body'],
|
|
35631
|
+
['PureCloud OAuth'],
|
|
35632
|
+
['application/json'],
|
|
35633
|
+
['application/json']
|
|
35634
|
+
);
|
|
35635
|
+
}
|
|
35636
|
+
|
|
35637
|
+
/**
|
|
35638
|
+
* Enable log capture for a user or update expiration
|
|
35639
|
+
*
|
|
35640
|
+
* @param {String} userId The id of the user to enable browser log capture
|
|
35641
|
+
* @param {Object} opts Optional parameters
|
|
35642
|
+
* @param {Object} opts.body
|
|
35643
|
+
*/
|
|
35644
|
+
postDiagnosticsLogcaptureBrowserUser(userId, opts) {
|
|
35645
|
+
opts = opts || {};
|
|
35646
|
+
|
|
35647
|
+
// verify the required parameter 'userId' is set
|
|
35648
|
+
if (userId === undefined || userId === null) {
|
|
35649
|
+
throw 'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';
|
|
35650
|
+
}
|
|
35651
|
+
|
|
35652
|
+
return this.apiClient.callApi(
|
|
35653
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
35654
|
+
'POST',
|
|
35655
|
+
{ 'userId': userId },
|
|
35656
|
+
{ },
|
|
35657
|
+
{ },
|
|
35658
|
+
{ },
|
|
35659
|
+
opts['body'],
|
|
35660
|
+
['PureCloud OAuth'],
|
|
35661
|
+
['application/json'],
|
|
35662
|
+
['application/json']
|
|
35663
|
+
);
|
|
35664
|
+
}
|
|
35665
|
+
|
|
35183
35666
|
}
|
|
35184
35667
|
|
|
35185
35668
|
class MessagingApi {
|
|
35186
35669
|
/**
|
|
35187
35670
|
* Messaging service.
|
|
35188
35671
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
35189
|
-
* @version
|
|
35672
|
+
* @version 186.0.1
|
|
35190
35673
|
*/
|
|
35191
35674
|
|
|
35192
35675
|
/**
|
|
@@ -35545,7 +36028,7 @@ class MobileDevicesApi {
|
|
|
35545
36028
|
/**
|
|
35546
36029
|
* MobileDevices service.
|
|
35547
36030
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
35548
|
-
* @version
|
|
36031
|
+
* @version 186.0.1
|
|
35549
36032
|
*/
|
|
35550
36033
|
|
|
35551
36034
|
/**
|
|
@@ -35696,7 +36179,7 @@ class NotificationsApi {
|
|
|
35696
36179
|
/**
|
|
35697
36180
|
* Notifications service.
|
|
35698
36181
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
35699
|
-
* @version
|
|
36182
|
+
* @version 186.0.1
|
|
35700
36183
|
*/
|
|
35701
36184
|
|
|
35702
36185
|
/**
|
|
@@ -35929,7 +36412,7 @@ class OAuthApi {
|
|
|
35929
36412
|
/**
|
|
35930
36413
|
* OAuth service.
|
|
35931
36414
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
35932
|
-
* @version
|
|
36415
|
+
* @version 186.0.1
|
|
35933
36416
|
*/
|
|
35934
36417
|
|
|
35935
36418
|
/**
|
|
@@ -36295,7 +36778,7 @@ class ObjectsApi {
|
|
|
36295
36778
|
/**
|
|
36296
36779
|
* Objects service.
|
|
36297
36780
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
36298
|
-
* @version
|
|
36781
|
+
* @version 186.0.1
|
|
36299
36782
|
*/
|
|
36300
36783
|
|
|
36301
36784
|
/**
|
|
@@ -36379,7 +36862,6 @@ class ObjectsApi {
|
|
|
36379
36862
|
* @param {String} opts.nextPage next page token
|
|
36380
36863
|
* @param {String} opts.previousPage Previous page token
|
|
36381
36864
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
36382
|
-
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
36383
36865
|
* @param {String} opts.name Search term to filter by division name
|
|
36384
36866
|
*/
|
|
36385
36867
|
getAuthorizationDivisions(opts) {
|
|
@@ -36390,7 +36872,7 @@ class ObjectsApi {
|
|
|
36390
36872
|
'/api/v2/authorization/divisions',
|
|
36391
36873
|
'GET',
|
|
36392
36874
|
{ },
|
|
36393
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'
|
|
36875
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'name': opts['name'] },
|
|
36394
36876
|
{ },
|
|
36395
36877
|
{ },
|
|
36396
36878
|
null,
|
|
@@ -36565,7 +37047,7 @@ class OperationalEventsApi {
|
|
|
36565
37047
|
/**
|
|
36566
37048
|
* OperationalEvents service.
|
|
36567
37049
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
36568
|
-
* @version
|
|
37050
|
+
* @version 186.0.1
|
|
36569
37051
|
*/
|
|
36570
37052
|
|
|
36571
37053
|
/**
|
|
@@ -36631,7 +37113,7 @@ class OrganizationApi {
|
|
|
36631
37113
|
/**
|
|
36632
37114
|
* Organization service.
|
|
36633
37115
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
36634
|
-
* @version
|
|
37116
|
+
* @version 186.0.1
|
|
36635
37117
|
*/
|
|
36636
37118
|
|
|
36637
37119
|
/**
|
|
@@ -37086,7 +37568,7 @@ class OrganizationAuthorizationApi {
|
|
|
37086
37568
|
/**
|
|
37087
37569
|
* OrganizationAuthorization service.
|
|
37088
37570
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
37089
|
-
* @version
|
|
37571
|
+
* @version 186.0.1
|
|
37090
37572
|
*/
|
|
37091
37573
|
|
|
37092
37574
|
/**
|
|
@@ -38433,7 +38915,7 @@ class OutboundApi {
|
|
|
38433
38915
|
/**
|
|
38434
38916
|
* Outbound service.
|
|
38435
38917
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38436
|
-
* @version
|
|
38918
|
+
* @version 186.0.1
|
|
38437
38919
|
*/
|
|
38438
38920
|
|
|
38439
38921
|
/**
|
|
@@ -42455,7 +42937,7 @@ class PresenceApi {
|
|
|
42455
42937
|
/**
|
|
42456
42938
|
* Presence service.
|
|
42457
42939
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
42458
|
-
* @version
|
|
42940
|
+
* @version 186.0.1
|
|
42459
42941
|
*/
|
|
42460
42942
|
|
|
42461
42943
|
/**
|
|
@@ -43194,7 +43676,7 @@ class ProcessAutomationApi {
|
|
|
43194
43676
|
/**
|
|
43195
43677
|
* ProcessAutomation service.
|
|
43196
43678
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
43197
|
-
* @version
|
|
43679
|
+
* @version 186.0.1
|
|
43198
43680
|
*/
|
|
43199
43681
|
|
|
43200
43682
|
/**
|
|
@@ -43433,7 +43915,7 @@ class QualityApi {
|
|
|
43433
43915
|
/**
|
|
43434
43916
|
* Quality service.
|
|
43435
43917
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
43436
|
-
* @version
|
|
43918
|
+
* @version 186.0.1
|
|
43437
43919
|
*/
|
|
43438
43920
|
|
|
43439
43921
|
/**
|
|
@@ -45026,7 +45508,7 @@ class QualityApi {
|
|
|
45026
45508
|
|
|
45027
45509
|
/**
|
|
45028
45510
|
* Update an evaluation
|
|
45029
|
-
* The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.
|
|
45511
|
+
* The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.
|
|
45030
45512
|
* @param {String} conversationId conversationId
|
|
45031
45513
|
* @param {String} evaluationId evaluationId
|
|
45032
45514
|
* @param {Object} body evaluation
|
|
@@ -45190,7 +45672,7 @@ class RecordingApi {
|
|
|
45190
45672
|
/**
|
|
45191
45673
|
* Recording service.
|
|
45192
45674
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
45193
|
-
* @version
|
|
45675
|
+
* @version 186.0.1
|
|
45194
45676
|
*/
|
|
45195
45677
|
|
|
45196
45678
|
/**
|
|
@@ -46827,7 +47309,7 @@ class ResponseManagementApi {
|
|
|
46827
47309
|
/**
|
|
46828
47310
|
* ResponseManagement service.
|
|
46829
47311
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46830
|
-
* @version
|
|
47312
|
+
* @version 186.0.1
|
|
46831
47313
|
*/
|
|
46832
47314
|
|
|
46833
47315
|
/**
|
|
@@ -47312,7 +47794,7 @@ class RoutingApi {
|
|
|
47312
47794
|
/**
|
|
47313
47795
|
* Routing service.
|
|
47314
47796
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
47315
|
-
* @version
|
|
47797
|
+
* @version 186.0.1
|
|
47316
47798
|
*/
|
|
47317
47799
|
|
|
47318
47800
|
/**
|
|
@@ -47767,6 +48249,36 @@ class RoutingApi {
|
|
|
47767
48249
|
);
|
|
47768
48250
|
}
|
|
47769
48251
|
|
|
48252
|
+
/**
|
|
48253
|
+
* Delete a utilization label
|
|
48254
|
+
*
|
|
48255
|
+
* @param {String} labelId Utilization Label ID
|
|
48256
|
+
* @param {Object} opts Optional parameters
|
|
48257
|
+
* @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
|
|
48258
|
+
* deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48259
|
+
*/
|
|
48260
|
+
deleteRoutingUtilizationLabel(labelId, opts) {
|
|
48261
|
+
opts = opts || {};
|
|
48262
|
+
|
|
48263
|
+
// verify the required parameter 'labelId' is set
|
|
48264
|
+
if (labelId === undefined || labelId === null) {
|
|
48265
|
+
throw 'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';
|
|
48266
|
+
}
|
|
48267
|
+
|
|
48268
|
+
return this.apiClient.callApi(
|
|
48269
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
48270
|
+
'DELETE',
|
|
48271
|
+
{ 'labelId': labelId },
|
|
48272
|
+
{ 'forceDelete': opts['forceDelete'] },
|
|
48273
|
+
{ },
|
|
48274
|
+
{ },
|
|
48275
|
+
null,
|
|
48276
|
+
['PureCloud OAuth'],
|
|
48277
|
+
['application/json'],
|
|
48278
|
+
['application/json']
|
|
48279
|
+
);
|
|
48280
|
+
}
|
|
48281
|
+
|
|
47770
48282
|
/**
|
|
47771
48283
|
* Delete an utilization tag
|
|
47772
48284
|
*
|
|
@@ -49257,6 +49769,86 @@ class RoutingApi {
|
|
|
49257
49769
|
);
|
|
49258
49770
|
}
|
|
49259
49771
|
|
|
49772
|
+
/**
|
|
49773
|
+
* Get details about this utilization label
|
|
49774
|
+
*
|
|
49775
|
+
* @param {String} labelId Utilization Label ID
|
|
49776
|
+
* getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49777
|
+
*/
|
|
49778
|
+
getRoutingUtilizationLabel(labelId) {
|
|
49779
|
+
// verify the required parameter 'labelId' is set
|
|
49780
|
+
if (labelId === undefined || labelId === null) {
|
|
49781
|
+
throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';
|
|
49782
|
+
}
|
|
49783
|
+
|
|
49784
|
+
return this.apiClient.callApi(
|
|
49785
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
49786
|
+
'GET',
|
|
49787
|
+
{ 'labelId': labelId },
|
|
49788
|
+
{ },
|
|
49789
|
+
{ },
|
|
49790
|
+
{ },
|
|
49791
|
+
null,
|
|
49792
|
+
['PureCloud OAuth'],
|
|
49793
|
+
['application/json'],
|
|
49794
|
+
['application/json']
|
|
49795
|
+
);
|
|
49796
|
+
}
|
|
49797
|
+
|
|
49798
|
+
/**
|
|
49799
|
+
* Get list of agent ids associated with a utilization label
|
|
49800
|
+
*
|
|
49801
|
+
* @param {String} labelId Utilization Label ID
|
|
49802
|
+
* getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49803
|
+
*/
|
|
49804
|
+
getRoutingUtilizationLabelAgents(labelId) {
|
|
49805
|
+
// verify the required parameter 'labelId' is set
|
|
49806
|
+
if (labelId === undefined || labelId === null) {
|
|
49807
|
+
throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';
|
|
49808
|
+
}
|
|
49809
|
+
|
|
49810
|
+
return this.apiClient.callApi(
|
|
49811
|
+
'/api/v2/routing/utilization/labels/{labelId}/agents',
|
|
49812
|
+
'GET',
|
|
49813
|
+
{ 'labelId': labelId },
|
|
49814
|
+
{ },
|
|
49815
|
+
{ },
|
|
49816
|
+
{ },
|
|
49817
|
+
null,
|
|
49818
|
+
['PureCloud OAuth'],
|
|
49819
|
+
['application/json'],
|
|
49820
|
+
['application/json']
|
|
49821
|
+
);
|
|
49822
|
+
}
|
|
49823
|
+
|
|
49824
|
+
/**
|
|
49825
|
+
* Get list of utilization labels
|
|
49826
|
+
*
|
|
49827
|
+
* @param {Object} opts Optional parameters
|
|
49828
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
49829
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
49830
|
+
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
49831
|
+
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
49832
|
+
* getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49833
|
+
*/
|
|
49834
|
+
getRoutingUtilizationLabels(opts) {
|
|
49835
|
+
opts = opts || {};
|
|
49836
|
+
|
|
49837
|
+
|
|
49838
|
+
return this.apiClient.callApi(
|
|
49839
|
+
'/api/v2/routing/utilization/labels',
|
|
49840
|
+
'GET',
|
|
49841
|
+
{ },
|
|
49842
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
49843
|
+
{ },
|
|
49844
|
+
{ },
|
|
49845
|
+
null,
|
|
49846
|
+
['PureCloud OAuth'],
|
|
49847
|
+
['application/json'],
|
|
49848
|
+
['application/json']
|
|
49849
|
+
);
|
|
49850
|
+
}
|
|
49851
|
+
|
|
49260
49852
|
/**
|
|
49261
49853
|
* Get details about this utilization tag
|
|
49262
49854
|
*
|
|
@@ -49392,6 +49984,60 @@ class RoutingApi {
|
|
|
49392
49984
|
);
|
|
49393
49985
|
}
|
|
49394
49986
|
|
|
49987
|
+
/**
|
|
49988
|
+
* Get a simplified wrap-up code.
|
|
49989
|
+
*
|
|
49990
|
+
* @param {String} codeId Wrapup Code ID
|
|
49991
|
+
*/
|
|
49992
|
+
getRoutingWrapupcodesDivisionview(codeId) {
|
|
49993
|
+
// verify the required parameter 'codeId' is set
|
|
49994
|
+
if (codeId === undefined || codeId === null) {
|
|
49995
|
+
throw 'Missing the required parameter "codeId" when calling getRoutingWrapupcodesDivisionview';
|
|
49996
|
+
}
|
|
49997
|
+
|
|
49998
|
+
return this.apiClient.callApi(
|
|
49999
|
+
'/api/v2/routing/wrapupcodes/divisionviews/{codeId}',
|
|
50000
|
+
'GET',
|
|
50001
|
+
{ 'codeId': codeId },
|
|
50002
|
+
{ },
|
|
50003
|
+
{ },
|
|
50004
|
+
{ },
|
|
50005
|
+
null,
|
|
50006
|
+
['PureCloud OAuth'],
|
|
50007
|
+
['application/json'],
|
|
50008
|
+
['application/json']
|
|
50009
|
+
);
|
|
50010
|
+
}
|
|
50011
|
+
|
|
50012
|
+
/**
|
|
50013
|
+
* Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).
|
|
50014
|
+
* Specifying both name and ID parameters is not supported.
|
|
50015
|
+
* @param {Object} opts Optional parameters
|
|
50016
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
50017
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
50018
|
+
* @param {String} opts.name Name (trailing asterisks allowed)
|
|
50019
|
+
* @param {Array.<String>} opts.id Wrapup code ID(s)
|
|
50020
|
+
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
50021
|
+
* @param {Object} opts.includeState Wrapup code state(s) to include
|
|
50022
|
+
*/
|
|
50023
|
+
getRoutingWrapupcodesDivisionviews(opts) {
|
|
50024
|
+
opts = opts || {};
|
|
50025
|
+
|
|
50026
|
+
|
|
50027
|
+
return this.apiClient.callApi(
|
|
50028
|
+
'/api/v2/routing/wrapupcodes/divisionviews',
|
|
50029
|
+
'GET',
|
|
50030
|
+
{ },
|
|
50031
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'includeState': opts['includeState'] },
|
|
50032
|
+
{ },
|
|
50033
|
+
{ },
|
|
50034
|
+
null,
|
|
50035
|
+
['PureCloud OAuth'],
|
|
50036
|
+
['application/json'],
|
|
50037
|
+
['application/json']
|
|
50038
|
+
);
|
|
50039
|
+
}
|
|
50040
|
+
|
|
49395
50041
|
/**
|
|
49396
50042
|
* Get queues for user
|
|
49397
50043
|
*
|
|
@@ -49793,6 +50439,31 @@ class RoutingApi {
|
|
|
49793
50439
|
);
|
|
49794
50440
|
}
|
|
49795
50441
|
|
|
50442
|
+
/**
|
|
50443
|
+
* Patch Transcription Settings
|
|
50444
|
+
*
|
|
50445
|
+
* @param {Object} body Organization Settings
|
|
50446
|
+
*/
|
|
50447
|
+
patchRoutingSettingsTranscription(body) {
|
|
50448
|
+
// verify the required parameter 'body' is set
|
|
50449
|
+
if (body === undefined || body === null) {
|
|
50450
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSettingsTranscription';
|
|
50451
|
+
}
|
|
50452
|
+
|
|
50453
|
+
return this.apiClient.callApi(
|
|
50454
|
+
'/api/v2/routing/settings/transcription',
|
|
50455
|
+
'PATCH',
|
|
50456
|
+
{ },
|
|
50457
|
+
{ },
|
|
50458
|
+
{ },
|
|
50459
|
+
{ },
|
|
50460
|
+
body,
|
|
50461
|
+
['PureCloud OAuth'],
|
|
50462
|
+
['application/json'],
|
|
50463
|
+
['application/json']
|
|
50464
|
+
);
|
|
50465
|
+
}
|
|
50466
|
+
|
|
49796
50467
|
/**
|
|
49797
50468
|
* Update skill group definition
|
|
49798
50469
|
*
|
|
@@ -50531,7 +51202,6 @@ class RoutingApi {
|
|
|
50531
51202
|
* Imports a phone number for SMS
|
|
50532
51203
|
*
|
|
50533
51204
|
* @param {Object} body SmsPhoneNumber
|
|
50534
|
-
* postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
50535
51205
|
*/
|
|
50536
51206
|
postRoutingSmsPhonenumbersImport(body) {
|
|
50537
51207
|
// verify the required parameter 'body' is set
|
|
@@ -50553,6 +51223,32 @@ class RoutingApi {
|
|
|
50553
51223
|
);
|
|
50554
51224
|
}
|
|
50555
51225
|
|
|
51226
|
+
/**
|
|
51227
|
+
* Create a utilization label
|
|
51228
|
+
*
|
|
51229
|
+
* @param {Object} body UtilizationLabel
|
|
51230
|
+
* postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51231
|
+
*/
|
|
51232
|
+
postRoutingUtilizationLabels(body) {
|
|
51233
|
+
// verify the required parameter 'body' is set
|
|
51234
|
+
if (body === undefined || body === null) {
|
|
51235
|
+
throw 'Missing the required parameter "body" when calling postRoutingUtilizationLabels';
|
|
51236
|
+
}
|
|
51237
|
+
|
|
51238
|
+
return this.apiClient.callApi(
|
|
51239
|
+
'/api/v2/routing/utilization/labels',
|
|
51240
|
+
'POST',
|
|
51241
|
+
{ },
|
|
51242
|
+
{ },
|
|
51243
|
+
{ },
|
|
51244
|
+
{ },
|
|
51245
|
+
body,
|
|
51246
|
+
['PureCloud OAuth'],
|
|
51247
|
+
['application/json'],
|
|
51248
|
+
['application/json']
|
|
51249
|
+
);
|
|
51250
|
+
}
|
|
51251
|
+
|
|
50556
51252
|
/**
|
|
50557
51253
|
* Create an utilization tag
|
|
50558
51254
|
*
|
|
@@ -50919,6 +51615,37 @@ class RoutingApi {
|
|
|
50919
51615
|
);
|
|
50920
51616
|
}
|
|
50921
51617
|
|
|
51618
|
+
/**
|
|
51619
|
+
* Update a utilization label
|
|
51620
|
+
*
|
|
51621
|
+
* @param {String} labelId Utilization Label ID
|
|
51622
|
+
* @param {Object} body UtilizationLabel
|
|
51623
|
+
* putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51624
|
+
*/
|
|
51625
|
+
putRoutingUtilizationLabel(labelId, body) {
|
|
51626
|
+
// verify the required parameter 'labelId' is set
|
|
51627
|
+
if (labelId === undefined || labelId === null) {
|
|
51628
|
+
throw 'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';
|
|
51629
|
+
}
|
|
51630
|
+
// verify the required parameter 'body' is set
|
|
51631
|
+
if (body === undefined || body === null) {
|
|
51632
|
+
throw 'Missing the required parameter "body" when calling putRoutingUtilizationLabel';
|
|
51633
|
+
}
|
|
51634
|
+
|
|
51635
|
+
return this.apiClient.callApi(
|
|
51636
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
51637
|
+
'PUT',
|
|
51638
|
+
{ 'labelId': labelId },
|
|
51639
|
+
{ },
|
|
51640
|
+
{ },
|
|
51641
|
+
{ },
|
|
51642
|
+
body,
|
|
51643
|
+
['PureCloud OAuth'],
|
|
51644
|
+
['application/json'],
|
|
51645
|
+
['application/json']
|
|
51646
|
+
);
|
|
51647
|
+
}
|
|
51648
|
+
|
|
50922
51649
|
/**
|
|
50923
51650
|
* Update wrap-up code
|
|
50924
51651
|
*
|
|
@@ -51020,7 +51747,7 @@ class SCIMApi {
|
|
|
51020
51747
|
/**
|
|
51021
51748
|
* SCIM service.
|
|
51022
51749
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
51023
|
-
* @version
|
|
51750
|
+
* @version 186.0.1
|
|
51024
51751
|
*/
|
|
51025
51752
|
|
|
51026
51753
|
/**
|
|
@@ -51897,7 +52624,7 @@ class ScriptsApi {
|
|
|
51897
52624
|
/**
|
|
51898
52625
|
* Scripts service.
|
|
51899
52626
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51900
|
-
* @version
|
|
52627
|
+
* @version 186.0.1
|
|
51901
52628
|
*/
|
|
51902
52629
|
|
|
51903
52630
|
/**
|
|
@@ -52341,7 +53068,7 @@ class SearchApi {
|
|
|
52341
53068
|
/**
|
|
52342
53069
|
* Search service.
|
|
52343
53070
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
52344
|
-
* @version
|
|
53071
|
+
* @version 186.0.1
|
|
52345
53072
|
*/
|
|
52346
53073
|
|
|
52347
53074
|
/**
|
|
@@ -53030,7 +53757,7 @@ class SettingsApi {
|
|
|
53030
53757
|
/**
|
|
53031
53758
|
* Settings service.
|
|
53032
53759
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
53033
|
-
* @version
|
|
53760
|
+
* @version 186.0.1
|
|
53034
53761
|
*/
|
|
53035
53762
|
|
|
53036
53763
|
/**
|
|
@@ -53095,7 +53822,7 @@ class SpeechTextAnalyticsApi {
|
|
|
53095
53822
|
/**
|
|
53096
53823
|
* SpeechTextAnalytics service.
|
|
53097
53824
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
53098
|
-
* @version
|
|
53825
|
+
* @version 186.0.1
|
|
53099
53826
|
*/
|
|
53100
53827
|
|
|
53101
53828
|
/**
|
|
@@ -54208,7 +54935,7 @@ class StationsApi {
|
|
|
54208
54935
|
/**
|
|
54209
54936
|
* Stations service.
|
|
54210
54937
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
54211
|
-
* @version
|
|
54938
|
+
* @version 186.0.1
|
|
54212
54939
|
*/
|
|
54213
54940
|
|
|
54214
54941
|
/**
|
|
@@ -54310,7 +55037,7 @@ class SuggestApi {
|
|
|
54310
55037
|
/**
|
|
54311
55038
|
* Suggest service.
|
|
54312
55039
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
54313
|
-
* @version
|
|
55040
|
+
* @version 186.0.1
|
|
54314
55041
|
*/
|
|
54315
55042
|
|
|
54316
55043
|
/**
|
|
@@ -54449,7 +55176,7 @@ class TaskManagementApi {
|
|
|
54449
55176
|
/**
|
|
54450
55177
|
* TaskManagement service.
|
|
54451
55178
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
54452
|
-
* @version
|
|
55179
|
+
* @version 186.0.1
|
|
54453
55180
|
*/
|
|
54454
55181
|
|
|
54455
55182
|
/**
|
|
@@ -55730,7 +56457,7 @@ class TeamsApi {
|
|
|
55730
56457
|
/**
|
|
55731
56458
|
* Teams service.
|
|
55732
56459
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
55733
|
-
* @version
|
|
56460
|
+
* @version 186.0.1
|
|
55734
56461
|
*/
|
|
55735
56462
|
|
|
55736
56463
|
/**
|
|
@@ -56032,7 +56759,7 @@ class TelephonyApi {
|
|
|
56032
56759
|
/**
|
|
56033
56760
|
* Telephony service.
|
|
56034
56761
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
56035
|
-
* @version
|
|
56762
|
+
* @version 186.0.1
|
|
56036
56763
|
*/
|
|
56037
56764
|
|
|
56038
56765
|
/**
|
|
@@ -56071,7 +56798,6 @@ class TelephonyApi {
|
|
|
56071
56798
|
* Get a SIP message.
|
|
56072
56799
|
* Get the raw form of the SIP message
|
|
56073
56800
|
* @param {String} conversationId Conversation id
|
|
56074
|
-
* getTelephonySipmessagesConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56075
56801
|
*/
|
|
56076
56802
|
getTelephonySipmessagesConversation(conversationId) {
|
|
56077
56803
|
// verify the required parameter 'conversationId' is set
|
|
@@ -56099,7 +56825,6 @@ class TelephonyApi {
|
|
|
56099
56825
|
* @param {String} conversationId Conversation id
|
|
56100
56826
|
* @param {Object} opts Optional parameters
|
|
56101
56827
|
* @param {Array.<String>} opts.keys comma-separated list of header identifiers to query. e.g. ruri,to,from
|
|
56102
|
-
* getTelephonySipmessagesConversationHeaders is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56103
56828
|
*/
|
|
56104
56829
|
getTelephonySipmessagesConversationHeaders(conversationId, opts) {
|
|
56105
56830
|
opts = opts || {};
|
|
@@ -56216,7 +56941,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
56216
56941
|
/**
|
|
56217
56942
|
* TelephonyProvidersEdge service.
|
|
56218
56943
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
56219
|
-
* @version
|
|
56944
|
+
* @version 186.0.1
|
|
56220
56945
|
*/
|
|
56221
56946
|
|
|
56222
56947
|
/**
|
|
@@ -56984,8 +57709,9 @@ class TelephonyProvidersEdgeApi {
|
|
|
56984
57709
|
}
|
|
56985
57710
|
|
|
56986
57711
|
/**
|
|
56987
|
-
* Get the list of available languages.
|
|
57712
|
+
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
56988
57713
|
*
|
|
57714
|
+
* @deprecated
|
|
56989
57715
|
*/
|
|
56990
57716
|
getTelephonyProvidersEdgesAvailablelanguages() {
|
|
56991
57717
|
|
|
@@ -57404,7 +58130,6 @@ class TelephonyProvidersEdgeApi {
|
|
|
57404
58130
|
* @param {Array.<String>} opts.id ID of the Extension Pools to filter by.
|
|
57405
58131
|
* @param {String} opts.name Name of the Extension Pools to filter by.
|
|
57406
58132
|
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
57407
|
-
* getTelephonyProvidersEdgesExtensionpoolsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57408
58133
|
*/
|
|
57409
58134
|
getTelephonyProvidersEdgesExtensionpoolsDivisionviews(opts) {
|
|
57410
58135
|
opts = opts || {};
|
|
@@ -58176,6 +58901,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
58176
58901
|
* @param {String} opts.name Name
|
|
58177
58902
|
* @param {String} opts.locationId Location Id
|
|
58178
58903
|
* @param {Boolean} opts.managed Filter by managed
|
|
58904
|
+
* @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
|
|
58179
58905
|
*/
|
|
58180
58906
|
getTelephonyProvidersEdgesSites(opts) {
|
|
58181
58907
|
opts = opts || {};
|
|
@@ -58185,7 +58911,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
58185
58911
|
'/api/v2/telephony/providers/edges/sites',
|
|
58186
58912
|
'GET',
|
|
58187
58913
|
{ },
|
|
58188
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'location.id': opts['locationId'],'managed': opts['managed'] },
|
|
58914
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'location.id': opts['locationId'],'managed': opts['managed'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
58189
58915
|
{ },
|
|
58190
58916
|
{ },
|
|
58191
58917
|
null,
|
|
@@ -59590,7 +60316,7 @@ class TextbotsApi {
|
|
|
59590
60316
|
/**
|
|
59591
60317
|
* Textbots service.
|
|
59592
60318
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
59593
|
-
* @version
|
|
60319
|
+
* @version 186.0.1
|
|
59594
60320
|
*/
|
|
59595
60321
|
|
|
59596
60322
|
/**
|
|
@@ -59718,7 +60444,7 @@ class TokensApi {
|
|
|
59718
60444
|
/**
|
|
59719
60445
|
* Tokens service.
|
|
59720
60446
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
59721
|
-
* @version
|
|
60447
|
+
* @version 186.0.1
|
|
59722
60448
|
*/
|
|
59723
60449
|
|
|
59724
60450
|
/**
|
|
@@ -59874,7 +60600,7 @@ class UploadsApi {
|
|
|
59874
60600
|
/**
|
|
59875
60601
|
* Uploads service.
|
|
59876
60602
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
59877
|
-
* @version
|
|
60603
|
+
* @version 186.0.1
|
|
59878
60604
|
*/
|
|
59879
60605
|
|
|
59880
60606
|
/**
|
|
@@ -60050,7 +60776,7 @@ class UsageApi {
|
|
|
60050
60776
|
/**
|
|
60051
60777
|
* Usage service.
|
|
60052
60778
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
60053
|
-
* @version
|
|
60779
|
+
* @version 186.0.1
|
|
60054
60780
|
*/
|
|
60055
60781
|
|
|
60056
60782
|
/**
|
|
@@ -60260,7 +60986,7 @@ class UserRecordingsApi {
|
|
|
60260
60986
|
/**
|
|
60261
60987
|
* UserRecordings service.
|
|
60262
60988
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
60263
|
-
* @version
|
|
60989
|
+
* @version 186.0.1
|
|
60264
60990
|
*/
|
|
60265
60991
|
|
|
60266
60992
|
/**
|
|
@@ -60445,7 +61171,7 @@ class UsersApi {
|
|
|
60445
61171
|
/**
|
|
60446
61172
|
* Users service.
|
|
60447
61173
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
60448
|
-
* @version
|
|
61174
|
+
* @version 186.0.1
|
|
60449
61175
|
*/
|
|
60450
61176
|
|
|
60451
61177
|
/**
|
|
@@ -63096,7 +63822,7 @@ class UtilitiesApi {
|
|
|
63096
63822
|
/**
|
|
63097
63823
|
* Utilities service.
|
|
63098
63824
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
63099
|
-
* @version
|
|
63825
|
+
* @version 186.0.1
|
|
63100
63826
|
*/
|
|
63101
63827
|
|
|
63102
63828
|
/**
|
|
@@ -63207,7 +63933,7 @@ class VoicemailApi {
|
|
|
63207
63933
|
/**
|
|
63208
63934
|
* Voicemail service.
|
|
63209
63935
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
63210
|
-
* @version
|
|
63936
|
+
* @version 186.0.1
|
|
63211
63937
|
*/
|
|
63212
63938
|
|
|
63213
63939
|
/**
|
|
@@ -63874,7 +64600,7 @@ class WebChatApi {
|
|
|
63874
64600
|
/**
|
|
63875
64601
|
* WebChat service.
|
|
63876
64602
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
63877
|
-
* @version
|
|
64603
|
+
* @version 186.0.1
|
|
63878
64604
|
*/
|
|
63879
64605
|
|
|
63880
64606
|
/**
|
|
@@ -64423,7 +65149,7 @@ class WebDeploymentsApi {
|
|
|
64423
65149
|
/**
|
|
64424
65150
|
* WebDeployments service.
|
|
64425
65151
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
64426
|
-
* @version
|
|
65152
|
+
* @version 186.0.1
|
|
64427
65153
|
*/
|
|
64428
65154
|
|
|
64429
65155
|
/**
|
|
@@ -64950,7 +65676,7 @@ class WebMessagingApi {
|
|
|
64950
65676
|
/**
|
|
64951
65677
|
* WebMessaging service.
|
|
64952
65678
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
64953
|
-
* @version
|
|
65679
|
+
* @version 186.0.1
|
|
64954
65680
|
*/
|
|
64955
65681
|
|
|
64956
65682
|
/**
|
|
@@ -64996,7 +65722,7 @@ class WidgetsApi {
|
|
|
64996
65722
|
/**
|
|
64997
65723
|
* Widgets service.
|
|
64998
65724
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
64999
|
-
* @version
|
|
65725
|
+
* @version 186.0.1
|
|
65000
65726
|
*/
|
|
65001
65727
|
|
|
65002
65728
|
/**
|
|
@@ -65142,7 +65868,7 @@ class WorkforceManagementApi {
|
|
|
65142
65868
|
/**
|
|
65143
65869
|
* WorkforceManagement service.
|
|
65144
65870
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
65145
|
-
* @version
|
|
65871
|
+
* @version 186.0.1
|
|
65146
65872
|
*/
|
|
65147
65873
|
|
|
65148
65874
|
/**
|
|
@@ -66276,6 +67002,81 @@ class WorkforceManagementApi {
|
|
|
66276
67002
|
);
|
|
66277
67003
|
}
|
|
66278
67004
|
|
|
67005
|
+
/**
|
|
67006
|
+
* Get the performance prediction for the associated schedule
|
|
67007
|
+
*
|
|
67008
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
67009
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
67010
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
67011
|
+
*/
|
|
67012
|
+
getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(businessUnitId, weekId, scheduleId) {
|
|
67013
|
+
// verify the required parameter 'businessUnitId' is set
|
|
67014
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
67015
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
67016
|
+
}
|
|
67017
|
+
// verify the required parameter 'weekId' is set
|
|
67018
|
+
if (weekId === undefined || weekId === null) {
|
|
67019
|
+
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
67020
|
+
}
|
|
67021
|
+
// verify the required parameter 'scheduleId' is set
|
|
67022
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
67023
|
+
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
67024
|
+
}
|
|
67025
|
+
|
|
67026
|
+
return this.apiClient.callApi(
|
|
67027
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions',
|
|
67028
|
+
'GET',
|
|
67029
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
67030
|
+
{ },
|
|
67031
|
+
{ },
|
|
67032
|
+
{ },
|
|
67033
|
+
null,
|
|
67034
|
+
['PureCloud OAuth'],
|
|
67035
|
+
['application/json'],
|
|
67036
|
+
['application/json']
|
|
67037
|
+
);
|
|
67038
|
+
}
|
|
67039
|
+
|
|
67040
|
+
/**
|
|
67041
|
+
* Get recalculated performance prediction result
|
|
67042
|
+
*
|
|
67043
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
67044
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
67045
|
+
* @param {String} scheduleId The ID of the schedule the recalculation belongs to
|
|
67046
|
+
* @param {String} recalculationId The ID of the recalculation request
|
|
67047
|
+
*/
|
|
67048
|
+
getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(businessUnitId, weekId, scheduleId, recalculationId) {
|
|
67049
|
+
// verify the required parameter 'businessUnitId' is set
|
|
67050
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
67051
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
67052
|
+
}
|
|
67053
|
+
// verify the required parameter 'weekId' is set
|
|
67054
|
+
if (weekId === undefined || weekId === null) {
|
|
67055
|
+
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
67056
|
+
}
|
|
67057
|
+
// verify the required parameter 'scheduleId' is set
|
|
67058
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
67059
|
+
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
67060
|
+
}
|
|
67061
|
+
// verify the required parameter 'recalculationId' is set
|
|
67062
|
+
if (recalculationId === undefined || recalculationId === null) {
|
|
67063
|
+
throw 'Missing the required parameter "recalculationId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
67064
|
+
}
|
|
67065
|
+
|
|
67066
|
+
return this.apiClient.callApi(
|
|
67067
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}',
|
|
67068
|
+
'GET',
|
|
67069
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId,'recalculationId': recalculationId },
|
|
67070
|
+
{ },
|
|
67071
|
+
{ },
|
|
67072
|
+
{ },
|
|
67073
|
+
null,
|
|
67074
|
+
['PureCloud OAuth'],
|
|
67075
|
+
['application/json'],
|
|
67076
|
+
['application/json']
|
|
67077
|
+
);
|
|
67078
|
+
}
|
|
67079
|
+
|
|
66279
67080
|
/**
|
|
66280
67081
|
* Get the list of week schedules for the specified week
|
|
66281
67082
|
* 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 +67300,45 @@ class WorkforceManagementApi {
|
|
|
66499
67300
|
);
|
|
66500
67301
|
}
|
|
66501
67302
|
|
|
67303
|
+
/**
|
|
67304
|
+
* Get the staffing requirement by planning group for a forecast
|
|
67305
|
+
*
|
|
67306
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
67307
|
+
* @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
|
|
67308
|
+
* @param {String} forecastId The ID of the forecast
|
|
67309
|
+
* @param {Object} opts Optional parameters
|
|
67310
|
+
* @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
|
|
67311
|
+
*/
|
|
67312
|
+
getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId, weekDateId, forecastId, opts) {
|
|
67313
|
+
opts = opts || {};
|
|
67314
|
+
|
|
67315
|
+
// verify the required parameter 'businessUnitId' is set
|
|
67316
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
67317
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67318
|
+
}
|
|
67319
|
+
// verify the required parameter 'weekDateId' is set
|
|
67320
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
67321
|
+
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67322
|
+
}
|
|
67323
|
+
// verify the required parameter 'forecastId' is set
|
|
67324
|
+
if (forecastId === undefined || forecastId === null) {
|
|
67325
|
+
throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67326
|
+
}
|
|
67327
|
+
|
|
67328
|
+
return this.apiClient.callApi(
|
|
67329
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement',
|
|
67330
|
+
'GET',
|
|
67331
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
67332
|
+
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi') },
|
|
67333
|
+
{ },
|
|
67334
|
+
{ },
|
|
67335
|
+
null,
|
|
67336
|
+
['PureCloud OAuth'],
|
|
67337
|
+
['application/json'],
|
|
67338
|
+
['application/json']
|
|
67339
|
+
);
|
|
67340
|
+
}
|
|
67341
|
+
|
|
66502
67342
|
/**
|
|
66503
67343
|
* Get short term forecasts
|
|
66504
67344
|
* 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 +68690,35 @@ class WorkforceManagementApi {
|
|
|
67850
68690
|
);
|
|
67851
68691
|
}
|
|
67852
68692
|
|
|
68693
|
+
/**
|
|
68694
|
+
* Update agent configurations
|
|
68695
|
+
*
|
|
68696
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
68697
|
+
* @param {Object} opts Optional parameters
|
|
68698
|
+
* @param {Object} opts.body body
|
|
68699
|
+
*/
|
|
68700
|
+
patchWorkforcemanagementManagementunitAgents(managementUnitId, opts) {
|
|
68701
|
+
opts = opts || {};
|
|
68702
|
+
|
|
68703
|
+
// verify the required parameter 'managementUnitId' is set
|
|
68704
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
68705
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';
|
|
68706
|
+
}
|
|
68707
|
+
|
|
68708
|
+
return this.apiClient.callApi(
|
|
68709
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents',
|
|
68710
|
+
'PATCH',
|
|
68711
|
+
{ 'managementUnitId': managementUnitId },
|
|
68712
|
+
{ },
|
|
68713
|
+
{ },
|
|
68714
|
+
{ },
|
|
68715
|
+
opts['body'],
|
|
68716
|
+
['PureCloud OAuth'],
|
|
68717
|
+
['application/json'],
|
|
68718
|
+
['application/json']
|
|
68719
|
+
);
|
|
68720
|
+
}
|
|
68721
|
+
|
|
67853
68722
|
/**
|
|
67854
68723
|
* Updates a time off limit object.
|
|
67855
68724
|
* Updates time off limit object properties, but not daily values.
|
|
@@ -68668,6 +69537,84 @@ class WorkforceManagementApi {
|
|
|
68668
69537
|
);
|
|
68669
69538
|
}
|
|
68670
69539
|
|
|
69540
|
+
/**
|
|
69541
|
+
* Request a daily recalculation of the performance prediction for the associated schedule
|
|
69542
|
+
*
|
|
69543
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
69544
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
69545
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
69546
|
+
* @param {Object} opts Optional parameters
|
|
69547
|
+
* @param {Object} opts.body body
|
|
69548
|
+
*/
|
|
69549
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId, opts) {
|
|
69550
|
+
opts = opts || {};
|
|
69551
|
+
|
|
69552
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69553
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69554
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69555
|
+
}
|
|
69556
|
+
// verify the required parameter 'weekId' is set
|
|
69557
|
+
if (weekId === undefined || weekId === null) {
|
|
69558
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69559
|
+
}
|
|
69560
|
+
// verify the required parameter 'scheduleId' is set
|
|
69561
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
69562
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69563
|
+
}
|
|
69564
|
+
|
|
69565
|
+
return this.apiClient.callApi(
|
|
69566
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations',
|
|
69567
|
+
'POST',
|
|
69568
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
69569
|
+
{ },
|
|
69570
|
+
{ },
|
|
69571
|
+
{ },
|
|
69572
|
+
opts['body'],
|
|
69573
|
+
['PureCloud OAuth'],
|
|
69574
|
+
['application/json'],
|
|
69575
|
+
['application/json']
|
|
69576
|
+
);
|
|
69577
|
+
}
|
|
69578
|
+
|
|
69579
|
+
/**
|
|
69580
|
+
* Upload daily activity changes to be able to request a performance prediction recalculation
|
|
69581
|
+
*
|
|
69582
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
69583
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
69584
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
69585
|
+
* @param {Object} opts Optional parameters
|
|
69586
|
+
* @param {Object} opts.body body
|
|
69587
|
+
*/
|
|
69588
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId, opts) {
|
|
69589
|
+
opts = opts || {};
|
|
69590
|
+
|
|
69591
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69592
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69593
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69594
|
+
}
|
|
69595
|
+
// verify the required parameter 'weekId' is set
|
|
69596
|
+
if (weekId === undefined || weekId === null) {
|
|
69597
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69598
|
+
}
|
|
69599
|
+
// verify the required parameter 'scheduleId' is set
|
|
69600
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
69601
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69602
|
+
}
|
|
69603
|
+
|
|
69604
|
+
return this.apiClient.callApi(
|
|
69605
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl',
|
|
69606
|
+
'POST',
|
|
69607
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
69608
|
+
{ },
|
|
69609
|
+
{ },
|
|
69610
|
+
{ },
|
|
69611
|
+
opts['body'],
|
|
69612
|
+
['PureCloud OAuth'],
|
|
69613
|
+
['application/json'],
|
|
69614
|
+
['application/json']
|
|
69615
|
+
);
|
|
69616
|
+
}
|
|
69617
|
+
|
|
68671
69618
|
/**
|
|
68672
69619
|
* Start a rescheduling run
|
|
68673
69620
|
*
|
|
@@ -70316,7 +71263,7 @@ class WorkforceManagementApi {
|
|
|
70316
71263
|
* </pre>
|
|
70317
71264
|
* </p>
|
|
70318
71265
|
* @module purecloud-platform-client-v2/index
|
|
70319
|
-
* @version
|
|
71266
|
+
* @version 186.0.1
|
|
70320
71267
|
*/
|
|
70321
71268
|
class platformClient {
|
|
70322
71269
|
constructor() {
|