purecloud-platform-client-v2 184.0.0 → 185.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +68 -2
- package/dist/node/purecloud-platform-client-v2.js +801 -79
- package/dist/web-amd/purecloud-platform-client-v2.js +801 -79
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +260 -99
- package/dist/web-cjs/purecloud-platform-client-v2.js +260 -99
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +557 -33
- package/package.json +1 -1
- 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 +2 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- 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 +1 -1
- 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 +1 -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 +1 -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 +1 -1
- 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 +1 -1
- 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 +168 -1
- 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 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
- 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
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 185.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -810,6 +810,339 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
810
810
|
});
|
|
811
811
|
}
|
|
812
812
|
|
|
813
|
+
/**
|
|
814
|
+
* @description Completes the PKCE Code Authorization.
|
|
815
|
+
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
816
|
+
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
817
|
+
* @param {string} authCode - Authorization code
|
|
818
|
+
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
819
|
+
*/
|
|
820
|
+
authorizePKCEGrant(clientId, codeVerifier, authCode, redirectUri) {
|
|
821
|
+
this.clientId = clientId;
|
|
822
|
+
return new Promise((resolve, reject) => {
|
|
823
|
+
var request = axios__default["default"]({
|
|
824
|
+
method: `POST`,
|
|
825
|
+
url: `https://login.${this.config.environment}/oauth/token`,
|
|
826
|
+
headers: {
|
|
827
|
+
'Content-Type': 'application/x-www-form-urlencoded'
|
|
828
|
+
},
|
|
829
|
+
data: qs__default["default"].stringify({ grant_type: 'authorization_code',
|
|
830
|
+
code: authCode,
|
|
831
|
+
code_verifier: codeVerifier,
|
|
832
|
+
client_id: clientId,
|
|
833
|
+
redirect_uri: redirectUri })
|
|
834
|
+
});
|
|
835
|
+
|
|
836
|
+
request.proxy = this.proxy;
|
|
837
|
+
var bodyParam = {
|
|
838
|
+
grant_type: 'authorization_code',
|
|
839
|
+
code: authCode,
|
|
840
|
+
code_verifier: codeVerifier,
|
|
841
|
+
client_id: clientId,
|
|
842
|
+
redirect_uri: redirectUri,
|
|
843
|
+
};
|
|
844
|
+
// Handle response
|
|
845
|
+
request
|
|
846
|
+
.then((response) => {
|
|
847
|
+
// Logging
|
|
848
|
+
this.config.logger.log(
|
|
849
|
+
'trace',
|
|
850
|
+
response.status,
|
|
851
|
+
'POST',
|
|
852
|
+
`https://login.${this.config.environment}/oauth/token`,
|
|
853
|
+
request.headers,
|
|
854
|
+
response.headers,
|
|
855
|
+
bodyParam,
|
|
856
|
+
undefined
|
|
857
|
+
);
|
|
858
|
+
this.config.logger.log(
|
|
859
|
+
'debug',
|
|
860
|
+
response.status,
|
|
861
|
+
'POST',
|
|
862
|
+
`https://login.${this.config.environment}/oauth/token`,
|
|
863
|
+
request.headers,
|
|
864
|
+
undefined,
|
|
865
|
+
bodyParam,
|
|
866
|
+
undefined
|
|
867
|
+
);
|
|
868
|
+
|
|
869
|
+
// Get access token from response
|
|
870
|
+
var access_token = response.data.access_token;
|
|
871
|
+
|
|
872
|
+
this.setAccessToken(access_token);
|
|
873
|
+
this.authData.tokenExpiryTime = new Date().getTime() + response.data['expires_in'] * 1000;
|
|
874
|
+
this.authData.tokenExpiryTimeString = new Date(this.authData.tokenExpiryTime).toUTCString();
|
|
875
|
+
|
|
876
|
+
// Return auth data
|
|
877
|
+
resolve(this.authData);
|
|
878
|
+
})
|
|
879
|
+
.catch((error) => {
|
|
880
|
+
// Log error
|
|
881
|
+
if (error.response) {
|
|
882
|
+
this.config.logger.log(
|
|
883
|
+
'error',
|
|
884
|
+
error.response.status,
|
|
885
|
+
'POST',
|
|
886
|
+
`https://login.${this.config.environment}/oauth/token`,
|
|
887
|
+
request.headers,
|
|
888
|
+
error.response.headers,
|
|
889
|
+
bodyParam,
|
|
890
|
+
error.response.data
|
|
891
|
+
);
|
|
892
|
+
}
|
|
893
|
+
|
|
894
|
+
reject(error);
|
|
895
|
+
});
|
|
896
|
+
|
|
897
|
+
});
|
|
898
|
+
}
|
|
899
|
+
|
|
900
|
+
/**
|
|
901
|
+
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
902
|
+
* @param {number} nChar - code length
|
|
903
|
+
*/
|
|
904
|
+
generatePKCECodeVerifier(nChar) {
|
|
905
|
+
if (nChar < 43 || nChar > 128) {
|
|
906
|
+
throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
|
|
907
|
+
}
|
|
908
|
+
// Check for window
|
|
909
|
+
if (typeof window === 'undefined') {
|
|
910
|
+
try {
|
|
911
|
+
const getRandomValues = require('crypto').getRandomValues;
|
|
912
|
+
const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
|
|
913
|
+
let randomString = Array.from(getRandomValues(new Uint32Array(nChar)))
|
|
914
|
+
.map((x) => unreservedCharacters[x % unreservedCharacters.length])
|
|
915
|
+
.join('');
|
|
916
|
+
return randomString;
|
|
917
|
+
} catch (err) {
|
|
918
|
+
throw new Error(`Crypto module is missing/not supported.`);
|
|
919
|
+
}
|
|
920
|
+
} else {
|
|
921
|
+
const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
|
|
922
|
+
let randomString = Array.from(crypto.getRandomValues(new Uint32Array(nChar)))
|
|
923
|
+
.map((x) => unreservedCharacters[x % unreservedCharacters.length])
|
|
924
|
+
.join('');
|
|
925
|
+
return randomString;
|
|
926
|
+
}
|
|
927
|
+
}
|
|
928
|
+
|
|
929
|
+
/**
|
|
930
|
+
* @description Compute Base64Url PKCE Code Challenge from Code Verifier.
|
|
931
|
+
* @param {string} code - code verifier used to generate the code challenge
|
|
932
|
+
*/
|
|
933
|
+
computePKCECodeChallenge(code) {
|
|
934
|
+
if (code.length < 43 || code.length > 128) {
|
|
935
|
+
throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
|
|
936
|
+
}
|
|
937
|
+
// Check for window
|
|
938
|
+
if (typeof window === 'undefined') {
|
|
939
|
+
// nodejs
|
|
940
|
+
try {
|
|
941
|
+
const createHash = require('crypto').createHash;
|
|
942
|
+
const utf8 = new TextEncoder().encode(code);
|
|
943
|
+
return new Promise((resolve, reject) => {
|
|
944
|
+
const hashHex = createHash('sha256').update(utf8).digest();
|
|
945
|
+
const hashBase64Url = Buffer.from(hashHex).toString('base64url');
|
|
946
|
+
resolve(hashBase64Url);
|
|
947
|
+
});
|
|
948
|
+
} catch (err) {
|
|
949
|
+
throw new Error(`Crypto module is missing/not supported.`);
|
|
950
|
+
}
|
|
951
|
+
} else {
|
|
952
|
+
// browser
|
|
953
|
+
const utf8 = new TextEncoder().encode(code);
|
|
954
|
+
return new Promise((resolve, reject) => {
|
|
955
|
+
window.crypto.subtle.digest("SHA-256", utf8).then((hashBuffer) => {
|
|
956
|
+
const hashBase64 = Buffer.from(hashBuffer).toString('base64');
|
|
957
|
+
let hashBase64Url = hashBase64.replaceAll("+", "-").replaceAll("/", "_");
|
|
958
|
+
hashBase64Url = hashBase64Url.split("=")[0];
|
|
959
|
+
resolve(hashBase64Url);
|
|
960
|
+
})
|
|
961
|
+
.catch((error) => {
|
|
962
|
+
// Handle failure
|
|
963
|
+
return reject(new Error(`Code Challenge Error ${error}`));
|
|
964
|
+
});
|
|
965
|
+
});
|
|
966
|
+
}
|
|
967
|
+
}
|
|
968
|
+
|
|
969
|
+
/**
|
|
970
|
+
* @description Initiates the pkce auth code grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
971
|
+
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
972
|
+
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
973
|
+
* @param {object} opts - (optional) Additional options
|
|
974
|
+
* @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
|
|
975
|
+
* @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
|
|
976
|
+
* @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
|
|
977
|
+
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
978
|
+
*/
|
|
979
|
+
loginPKCEGrant(clientId, redirectUri, opts, codeVerifier) {
|
|
980
|
+
// Need Local Storage or non null codeVerifier as parameter
|
|
981
|
+
if (!this.hasLocalStorage && !codeVerifier) {
|
|
982
|
+
throw new Error(`loginPKCEGrant requires Local Storage or codeVerifier as input parameter`);
|
|
983
|
+
}
|
|
984
|
+
// Check for auth code in query
|
|
985
|
+
const query = this._setValuesFromUrlQuery();
|
|
986
|
+
|
|
987
|
+
this.clientId = clientId;
|
|
988
|
+
this.redirectUri = redirectUri;
|
|
989
|
+
|
|
990
|
+
this.codeVerifier = codeVerifier;
|
|
991
|
+
|
|
992
|
+
if (!opts) opts = {};
|
|
993
|
+
|
|
994
|
+
return new Promise((resolve, reject) => {
|
|
995
|
+
// Abort if org and provider are not set together
|
|
996
|
+
if (opts.org && !opts.provider) {
|
|
997
|
+
reject(new Error('opts.provider must be set if opts.org is set'));
|
|
998
|
+
} else if (opts.provider && !opts.org) {
|
|
999
|
+
reject(new Error('opts.org must be set if opts.provider is set'));
|
|
1000
|
+
}
|
|
1001
|
+
|
|
1002
|
+
// Abort on auth error
|
|
1003
|
+
if (query && query.error) {
|
|
1004
|
+
// remove codeVerifier from session storage
|
|
1005
|
+
if (this.hasLocalStorage) {
|
|
1006
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1007
|
+
}
|
|
1008
|
+
// reset access token if any was stored
|
|
1009
|
+
this._saveSettings({ accessToken: undefined });
|
|
1010
|
+
return reject(new Error(`[${query.error}] ${query.error_description}`));
|
|
1011
|
+
}
|
|
1012
|
+
|
|
1013
|
+
// Get token on auth code
|
|
1014
|
+
if (query && query.code) {
|
|
1015
|
+
if (!this.codeVerifier) {
|
|
1016
|
+
// load codeVerifier from session storage
|
|
1017
|
+
if (this.hasLocalStorage) {
|
|
1018
|
+
this.codeVerifier = sessionStorage.getItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1019
|
+
}
|
|
1020
|
+
}
|
|
1021
|
+
this.authorizePKCEGrant(this.clientId, this.codeVerifier, query.code, this.redirectUri)
|
|
1022
|
+
.then(() => {
|
|
1023
|
+
// Do authenticated things
|
|
1024
|
+
this._testTokenAccess()
|
|
1025
|
+
.then(() => {
|
|
1026
|
+
if (!this.authData.state && query.state)
|
|
1027
|
+
this.authData.state = query.state;
|
|
1028
|
+
// remove codeVerifier from session storage
|
|
1029
|
+
if (this.hasLocalStorage) {
|
|
1030
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1031
|
+
}
|
|
1032
|
+
resolve(this.authData);
|
|
1033
|
+
})
|
|
1034
|
+
.catch((error) => {
|
|
1035
|
+
// Handle failure response
|
|
1036
|
+
this._saveSettings({ accessToken: undefined});
|
|
1037
|
+
// remove codeVerifier from session storage
|
|
1038
|
+
if (this.hasLocalStorage) {
|
|
1039
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1040
|
+
}
|
|
1041
|
+
return reject(new Error(`[${error.name}] ${error.msg}`));
|
|
1042
|
+
});
|
|
1043
|
+
})
|
|
1044
|
+
.catch((error) => {
|
|
1045
|
+
// Handle failure response
|
|
1046
|
+
this._saveSettings({ accessToken: undefined});
|
|
1047
|
+
// remove codeVerifier from session storage
|
|
1048
|
+
if (this.hasLocalStorage) {
|
|
1049
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1050
|
+
}
|
|
1051
|
+
return reject(new Error(`[${error.name}] ${error.msg}`));
|
|
1052
|
+
});
|
|
1053
|
+
} else {
|
|
1054
|
+
// Test token (if previously stored) and proceed with login
|
|
1055
|
+
this._testTokenAccess()
|
|
1056
|
+
.then(() => {
|
|
1057
|
+
if (!this.authData.state && opts.state)
|
|
1058
|
+
this.authData.state = opts.state;
|
|
1059
|
+
resolve(this.authData);
|
|
1060
|
+
})
|
|
1061
|
+
.catch((error) => {
|
|
1062
|
+
if (!this.codeVerifier) {
|
|
1063
|
+
this.codeVerifier = this.generatePKCECodeVerifier(128);
|
|
1064
|
+
// save codeVerifier in session storage
|
|
1065
|
+
if (this.hasLocalStorage) {
|
|
1066
|
+
sessionStorage.setItem(`genesys_cloud_sdk_pkce_code_verifier`, this.codeVerifier);
|
|
1067
|
+
}
|
|
1068
|
+
}
|
|
1069
|
+
this.computePKCECodeChallenge(this.codeVerifier)
|
|
1070
|
+
.then((codeChallenge) => {
|
|
1071
|
+
var tokenQuery = {
|
|
1072
|
+
client_id: encodeURIComponent(this.clientId),
|
|
1073
|
+
redirect_uri: encodeURIComponent(this.redirectUri),
|
|
1074
|
+
code_challenge: encodeURIComponent(codeChallenge),
|
|
1075
|
+
response_type: 'code',
|
|
1076
|
+
code_challenge_method: 'S256'
|
|
1077
|
+
};
|
|
1078
|
+
if (opts.state) tokenQuery.state = encodeURIComponent(opts.state);
|
|
1079
|
+
if (opts.org) tokenQuery.org = encodeURIComponent(opts.org);
|
|
1080
|
+
if (opts.provider) tokenQuery.provider = encodeURIComponent(opts.provider);
|
|
1081
|
+
|
|
1082
|
+
var url = this._buildAuthUrl('oauth/authorize', tokenQuery);
|
|
1083
|
+
window.location.replace(url);
|
|
1084
|
+
})
|
|
1085
|
+
.catch((err) => {
|
|
1086
|
+
return reject(new Error(`[${err.name}]`));
|
|
1087
|
+
});
|
|
1088
|
+
});
|
|
1089
|
+
}
|
|
1090
|
+
});
|
|
1091
|
+
}
|
|
1092
|
+
|
|
1093
|
+
/**
|
|
1094
|
+
* @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
|
|
1095
|
+
*/
|
|
1096
|
+
_setValuesFromUrlQuery() {
|
|
1097
|
+
// Check for window
|
|
1098
|
+
if (!(typeof window !== 'undefined' && window.location.search)) return;
|
|
1099
|
+
|
|
1100
|
+
// Process query string
|
|
1101
|
+
let query = {};
|
|
1102
|
+
let queryParams = new URLSearchParams(window.location.search);
|
|
1103
|
+
let code = queryParams.get('code');
|
|
1104
|
+
let error = queryParams.get('error');
|
|
1105
|
+
let errorDescription = queryParams.get('error_description');
|
|
1106
|
+
let state = queryParams.get('state');
|
|
1107
|
+
|
|
1108
|
+
// Check for error
|
|
1109
|
+
if (error) {
|
|
1110
|
+
query.error = error;
|
|
1111
|
+
if (errorDescription) {
|
|
1112
|
+
query.error_description = errorDescription;
|
|
1113
|
+
}
|
|
1114
|
+
return query;
|
|
1115
|
+
}
|
|
1116
|
+
|
|
1117
|
+
// Everything goes in here because we only want to act if we found an access token
|
|
1118
|
+
if (code) {
|
|
1119
|
+
query.code = code;
|
|
1120
|
+
if (state) {
|
|
1121
|
+
query.state = state;
|
|
1122
|
+
}
|
|
1123
|
+
}
|
|
1124
|
+
|
|
1125
|
+
// Remove code from URL
|
|
1126
|
+
// Credit: https://stackoverflow.com/questions/1397329/how-to-remove-the-hash-from-window-location-with-javascript-without-page-refresh/5298684#5298684
|
|
1127
|
+
var scrollV, scrollH, loc = window.location;
|
|
1128
|
+
if ('replaceState' in history) {
|
|
1129
|
+
history.replaceState('', document.title, loc.pathname);
|
|
1130
|
+
} else {
|
|
1131
|
+
// Prevent scrolling by storing the page's current scroll offset
|
|
1132
|
+
scrollV = document.body.scrollTop;
|
|
1133
|
+
scrollH = document.body.scrollLeft;
|
|
1134
|
+
|
|
1135
|
+
// Remove code
|
|
1136
|
+
history.pushState('', document.title, loc.pathname);
|
|
1137
|
+
|
|
1138
|
+
// Restore the scroll offset, should be flicker free
|
|
1139
|
+
document.body.scrollTop = scrollV;
|
|
1140
|
+
document.body.scrollLeft = scrollH;
|
|
1141
|
+
}
|
|
1142
|
+
|
|
1143
|
+
return query;
|
|
1144
|
+
}
|
|
1145
|
+
|
|
813
1146
|
/**
|
|
814
1147
|
* @description Initiates the Code Authorization. Only available in node apps.
|
|
815
1148
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
@@ -1485,7 +1818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1485
1818
|
/**
|
|
1486
1819
|
* Alerting service.
|
|
1487
1820
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1488
|
-
* @version
|
|
1821
|
+
* @version 185.0.0
|
|
1489
1822
|
*/
|
|
1490
1823
|
|
|
1491
1824
|
/**
|
|
@@ -2146,7 +2479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2146
2479
|
/**
|
|
2147
2480
|
* Analytics service.
|
|
2148
2481
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2149
|
-
* @version
|
|
2482
|
+
* @version 185.0.0
|
|
2150
2483
|
*/
|
|
2151
2484
|
|
|
2152
2485
|
/**
|
|
@@ -4736,7 +5069,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4736
5069
|
/**
|
|
4737
5070
|
* Architect service.
|
|
4738
5071
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4739
|
-
* @version
|
|
5072
|
+
* @version 185.0.0
|
|
4740
5073
|
*/
|
|
4741
5074
|
|
|
4742
5075
|
/**
|
|
@@ -7983,7 +8316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7983
8316
|
|
|
7984
8317
|
/**
|
|
7985
8318
|
* Create a new row entry for the datatable.
|
|
7986
|
-
* Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
8319
|
+
* Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
7987
8320
|
* @param {String} datatableId id of datatable
|
|
7988
8321
|
* @param {Object.<String, {String: Object}>} dataTableRow
|
|
7989
8322
|
*/
|
|
@@ -8475,7 +8808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8475
8808
|
|
|
8476
8809
|
/**
|
|
8477
8810
|
* Update a row entry
|
|
8478
|
-
* Updates a row with the given rowId (the value of the key field) to the new values. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
8811
|
+
* Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
8479
8812
|
* @param {String} datatableId id of datatable
|
|
8480
8813
|
* @param {String} rowId the key for the row
|
|
8481
8814
|
* @param {Object} opts Optional parameters
|
|
@@ -8571,7 +8904,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8571
8904
|
/**
|
|
8572
8905
|
* Audit service.
|
|
8573
8906
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8574
|
-
* @version
|
|
8907
|
+
* @version 185.0.0
|
|
8575
8908
|
*/
|
|
8576
8909
|
|
|
8577
8910
|
/**
|
|
@@ -8742,7 +9075,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8742
9075
|
/**
|
|
8743
9076
|
* Authorization service.
|
|
8744
9077
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8745
|
-
* @version
|
|
9078
|
+
* @version 185.0.0
|
|
8746
9079
|
*/
|
|
8747
9080
|
|
|
8748
9081
|
/**
|
|
@@ -9125,7 +9458,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9125
9458
|
* Get the organization role specified by its ID.
|
|
9126
9459
|
* @param {String} roleId Role ID
|
|
9127
9460
|
* @param {Object} opts Optional parameters
|
|
9128
|
-
* @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division (default to true)
|
|
9461
|
+
* @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division. Setting this value or defaulting to 'true' can lead to slower load times or timeouts for role queries with large member counts. (default to true)
|
|
9129
9462
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand. unusedPermissions returns the permissions not used for the role
|
|
9130
9463
|
*/
|
|
9131
9464
|
getAuthorizationRole(roleId, opts) {
|
|
@@ -9972,7 +10305,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9972
10305
|
/**
|
|
9973
10306
|
* Billing service.
|
|
9974
10307
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9975
|
-
* @version
|
|
10308
|
+
* @version 185.0.0
|
|
9976
10309
|
*/
|
|
9977
10310
|
|
|
9978
10311
|
/**
|
|
@@ -10052,7 +10385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10052
10385
|
/**
|
|
10053
10386
|
* CarrierServices service.
|
|
10054
10387
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10055
|
-
* @version
|
|
10388
|
+
* @version 185.0.0
|
|
10056
10389
|
*/
|
|
10057
10390
|
|
|
10058
10391
|
/**
|
|
@@ -10122,7 +10455,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10122
10455
|
/**
|
|
10123
10456
|
* Chat service.
|
|
10124
10457
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10125
|
-
* @version
|
|
10458
|
+
* @version 185.0.0
|
|
10126
10459
|
*/
|
|
10127
10460
|
|
|
10128
10461
|
/**
|
|
@@ -10818,7 +11151,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10818
11151
|
/**
|
|
10819
11152
|
* Coaching service.
|
|
10820
11153
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
10821
|
-
* @version
|
|
11154
|
+
* @version 185.0.0
|
|
10822
11155
|
*/
|
|
10823
11156
|
|
|
10824
11157
|
/**
|
|
@@ -11395,7 +11728,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11395
11728
|
/**
|
|
11396
11729
|
* ContentManagement service.
|
|
11397
11730
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11398
|
-
* @version
|
|
11731
|
+
* @version 185.0.0
|
|
11399
11732
|
*/
|
|
11400
11733
|
|
|
11401
11734
|
/**
|
|
@@ -12538,7 +12871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12538
12871
|
/**
|
|
12539
12872
|
* Conversations service.
|
|
12540
12873
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12541
|
-
* @version
|
|
12874
|
+
* @version 185.0.0
|
|
12542
12875
|
*/
|
|
12543
12876
|
|
|
12544
12877
|
/**
|
|
@@ -19678,7 +20011,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19678
20011
|
/**
|
|
19679
20012
|
* DataExtensions service.
|
|
19680
20013
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
19681
|
-
* @version
|
|
20014
|
+
* @version 185.0.0
|
|
19682
20015
|
*/
|
|
19683
20016
|
|
|
19684
20017
|
/**
|
|
@@ -19764,7 +20097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19764
20097
|
/**
|
|
19765
20098
|
* Downloads service.
|
|
19766
20099
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
19767
|
-
* @version
|
|
20100
|
+
* @version 185.0.0
|
|
19768
20101
|
*/
|
|
19769
20102
|
|
|
19770
20103
|
/**
|
|
@@ -19816,7 +20149,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19816
20149
|
/**
|
|
19817
20150
|
* Emails service.
|
|
19818
20151
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
19819
|
-
* @version
|
|
20152
|
+
* @version 185.0.0
|
|
19820
20153
|
*/
|
|
19821
20154
|
|
|
19822
20155
|
/**
|
|
@@ -19881,7 +20214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19881
20214
|
/**
|
|
19882
20215
|
* Events service.
|
|
19883
20216
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
19884
|
-
* @version
|
|
20217
|
+
* @version 185.0.0
|
|
19885
20218
|
*/
|
|
19886
20219
|
|
|
19887
20220
|
/**
|
|
@@ -19977,7 +20310,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19977
20310
|
/**
|
|
19978
20311
|
* ExternalContacts service.
|
|
19979
20312
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
19980
|
-
* @version
|
|
20313
|
+
* @version 185.0.0
|
|
19981
20314
|
*/
|
|
19982
20315
|
|
|
19983
20316
|
/**
|
|
@@ -21935,7 +22268,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21935
22268
|
/**
|
|
21936
22269
|
* Fax service.
|
|
21937
22270
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
21938
|
-
* @version
|
|
22271
|
+
* @version 185.0.0
|
|
21939
22272
|
*/
|
|
21940
22273
|
|
|
21941
22274
|
/**
|
|
@@ -22106,7 +22439,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22106
22439
|
/**
|
|
22107
22440
|
* Flows service.
|
|
22108
22441
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22109
|
-
* @version
|
|
22442
|
+
* @version 185.0.0
|
|
22110
22443
|
*/
|
|
22111
22444
|
|
|
22112
22445
|
/**
|
|
@@ -22290,7 +22623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22290
22623
|
/**
|
|
22291
22624
|
* Gamification service.
|
|
22292
22625
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22293
|
-
* @version
|
|
22626
|
+
* @version 185.0.0
|
|
22294
22627
|
*/
|
|
22295
22628
|
|
|
22296
22629
|
/**
|
|
@@ -24376,7 +24709,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24376
24709
|
/**
|
|
24377
24710
|
* GeneralDataProtectionRegulation service.
|
|
24378
24711
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24379
|
-
* @version
|
|
24712
|
+
* @version 185.0.0
|
|
24380
24713
|
*/
|
|
24381
24714
|
|
|
24382
24715
|
/**
|
|
@@ -24506,7 +24839,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24506
24839
|
/**
|
|
24507
24840
|
* Geolocation service.
|
|
24508
24841
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24509
|
-
* @version
|
|
24842
|
+
* @version 185.0.0
|
|
24510
24843
|
*/
|
|
24511
24844
|
|
|
24512
24845
|
/**
|
|
@@ -24637,7 +24970,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24637
24970
|
/**
|
|
24638
24971
|
* Greetings service.
|
|
24639
24972
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24640
|
-
* @version
|
|
24973
|
+
* @version 185.0.0
|
|
24641
24974
|
*/
|
|
24642
24975
|
|
|
24643
24976
|
/**
|
|
@@ -25092,7 +25425,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25092
25425
|
/**
|
|
25093
25426
|
* Groups service.
|
|
25094
25427
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25095
|
-
* @version
|
|
25428
|
+
* @version 185.0.0
|
|
25096
25429
|
*/
|
|
25097
25430
|
|
|
25098
25431
|
/**
|
|
@@ -25611,7 +25944,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25611
25944
|
/**
|
|
25612
25945
|
* IdentityProvider service.
|
|
25613
25946
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25614
|
-
* @version
|
|
25947
|
+
* @version 185.0.0
|
|
25615
25948
|
*/
|
|
25616
25949
|
|
|
25617
25950
|
/**
|
|
@@ -26367,7 +26700,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26367
26700
|
/**
|
|
26368
26701
|
* InfrastructureAsCode service.
|
|
26369
26702
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
26370
|
-
* @version
|
|
26703
|
+
* @version 185.0.0
|
|
26371
26704
|
*/
|
|
26372
26705
|
|
|
26373
26706
|
/**
|
|
@@ -26534,7 +26867,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26534
26867
|
/**
|
|
26535
26868
|
* Integrations service.
|
|
26536
26869
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26537
|
-
* @version
|
|
26870
|
+
* @version 185.0.0
|
|
26538
26871
|
*/
|
|
26539
26872
|
|
|
26540
26873
|
/**
|
|
@@ -28496,7 +28829,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28496
28829
|
/**
|
|
28497
28830
|
* Journey service.
|
|
28498
28831
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28499
|
-
* @version
|
|
28832
|
+
* @version 185.0.0
|
|
28500
28833
|
*/
|
|
28501
28834
|
|
|
28502
28835
|
/**
|
|
@@ -29727,7 +30060,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29727
30060
|
/**
|
|
29728
30061
|
* Knowledge service.
|
|
29729
30062
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
29730
|
-
* @version
|
|
30063
|
+
* @version 185.0.0
|
|
29731
30064
|
*/
|
|
29732
30065
|
|
|
29733
30066
|
/**
|
|
@@ -32548,7 +32881,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32548
32881
|
/**
|
|
32549
32882
|
* LanguageUnderstanding service.
|
|
32550
32883
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32551
|
-
* @version
|
|
32884
|
+
* @version 185.0.0
|
|
32552
32885
|
*/
|
|
32553
32886
|
|
|
32554
32887
|
/**
|
|
@@ -33561,7 +33894,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33561
33894
|
/**
|
|
33562
33895
|
* Languages service.
|
|
33563
33896
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33564
|
-
* @version
|
|
33897
|
+
* @version 185.0.0
|
|
33565
33898
|
*/
|
|
33566
33899
|
|
|
33567
33900
|
/**
|
|
@@ -33783,7 +34116,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33783
34116
|
/**
|
|
33784
34117
|
* Learning service.
|
|
33785
34118
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33786
|
-
* @version
|
|
34119
|
+
* @version 185.0.0
|
|
33787
34120
|
*/
|
|
33788
34121
|
|
|
33789
34122
|
/**
|
|
@@ -34639,7 +34972,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34639
34972
|
/**
|
|
34640
34973
|
* License service.
|
|
34641
34974
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34642
|
-
* @version
|
|
34975
|
+
* @version 185.0.0
|
|
34643
34976
|
*/
|
|
34644
34977
|
|
|
34645
34978
|
/**
|
|
@@ -34877,7 +35210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34877
35210
|
/**
|
|
34878
35211
|
* Locations service.
|
|
34879
35212
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34880
|
-
* @version
|
|
35213
|
+
* @version 185.0.0
|
|
34881
35214
|
*/
|
|
34882
35215
|
|
|
34883
35216
|
/**
|
|
@@ -35113,7 +35446,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35113
35446
|
/**
|
|
35114
35447
|
* LogCapture service.
|
|
35115
35448
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
35116
|
-
* @version
|
|
35449
|
+
* @version 185.0.0
|
|
35117
35450
|
*/
|
|
35118
35451
|
|
|
35119
35452
|
/**
|
|
@@ -35183,7 +35516,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35183
35516
|
/**
|
|
35184
35517
|
* Messaging service.
|
|
35185
35518
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
35186
|
-
* @version
|
|
35519
|
+
* @version 185.0.0
|
|
35187
35520
|
*/
|
|
35188
35521
|
|
|
35189
35522
|
/**
|
|
@@ -35542,7 +35875,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35542
35875
|
/**
|
|
35543
35876
|
* MobileDevices service.
|
|
35544
35877
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
35545
|
-
* @version
|
|
35878
|
+
* @version 185.0.0
|
|
35546
35879
|
*/
|
|
35547
35880
|
|
|
35548
35881
|
/**
|
|
@@ -35693,7 +36026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35693
36026
|
/**
|
|
35694
36027
|
* Notifications service.
|
|
35695
36028
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
35696
|
-
* @version
|
|
36029
|
+
* @version 185.0.0
|
|
35697
36030
|
*/
|
|
35698
36031
|
|
|
35699
36032
|
/**
|
|
@@ -35926,7 +36259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35926
36259
|
/**
|
|
35927
36260
|
* OAuth service.
|
|
35928
36261
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
35929
|
-
* @version
|
|
36262
|
+
* @version 185.0.0
|
|
35930
36263
|
*/
|
|
35931
36264
|
|
|
35932
36265
|
/**
|
|
@@ -36292,7 +36625,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36292
36625
|
/**
|
|
36293
36626
|
* Objects service.
|
|
36294
36627
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
36295
|
-
* @version
|
|
36628
|
+
* @version 185.0.0
|
|
36296
36629
|
*/
|
|
36297
36630
|
|
|
36298
36631
|
/**
|
|
@@ -36562,7 +36895,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36562
36895
|
/**
|
|
36563
36896
|
* OperationalEvents service.
|
|
36564
36897
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
36565
|
-
* @version
|
|
36898
|
+
* @version 185.0.0
|
|
36566
36899
|
*/
|
|
36567
36900
|
|
|
36568
36901
|
/**
|
|
@@ -36628,7 +36961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36628
36961
|
/**
|
|
36629
36962
|
* Organization service.
|
|
36630
36963
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
36631
|
-
* @version
|
|
36964
|
+
* @version 185.0.0
|
|
36632
36965
|
*/
|
|
36633
36966
|
|
|
36634
36967
|
/**
|
|
@@ -37083,7 +37416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37083
37416
|
/**
|
|
37084
37417
|
* OrganizationAuthorization service.
|
|
37085
37418
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
37086
|
-
* @version
|
|
37419
|
+
* @version 185.0.0
|
|
37087
37420
|
*/
|
|
37088
37421
|
|
|
37089
37422
|
/**
|
|
@@ -38430,7 +38763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38430
38763
|
/**
|
|
38431
38764
|
* Outbound service.
|
|
38432
38765
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38433
|
-
* @version
|
|
38766
|
+
* @version 185.0.0
|
|
38434
38767
|
*/
|
|
38435
38768
|
|
|
38436
38769
|
/**
|
|
@@ -42452,7 +42785,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42452
42785
|
/**
|
|
42453
42786
|
* Presence service.
|
|
42454
42787
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
42455
|
-
* @version
|
|
42788
|
+
* @version 185.0.0
|
|
42456
42789
|
*/
|
|
42457
42790
|
|
|
42458
42791
|
/**
|
|
@@ -43191,7 +43524,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43191
43524
|
/**
|
|
43192
43525
|
* ProcessAutomation service.
|
|
43193
43526
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
43194
|
-
* @version
|
|
43527
|
+
* @version 185.0.0
|
|
43195
43528
|
*/
|
|
43196
43529
|
|
|
43197
43530
|
/**
|
|
@@ -43430,7 +43763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43430
43763
|
/**
|
|
43431
43764
|
* Quality service.
|
|
43432
43765
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
43433
|
-
* @version
|
|
43766
|
+
* @version 185.0.0
|
|
43434
43767
|
*/
|
|
43435
43768
|
|
|
43436
43769
|
/**
|
|
@@ -45187,7 +45520,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45187
45520
|
/**
|
|
45188
45521
|
* Recording service.
|
|
45189
45522
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
45190
|
-
* @version
|
|
45523
|
+
* @version 185.0.0
|
|
45191
45524
|
*/
|
|
45192
45525
|
|
|
45193
45526
|
/**
|
|
@@ -46824,7 +47157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46824
47157
|
/**
|
|
46825
47158
|
* ResponseManagement service.
|
|
46826
47159
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46827
|
-
* @version
|
|
47160
|
+
* @version 185.0.0
|
|
46828
47161
|
*/
|
|
46829
47162
|
|
|
46830
47163
|
/**
|
|
@@ -47309,7 +47642,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47309
47642
|
/**
|
|
47310
47643
|
* Routing service.
|
|
47311
47644
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
47312
|
-
* @version
|
|
47645
|
+
* @version 185.0.0
|
|
47313
47646
|
*/
|
|
47314
47647
|
|
|
47315
47648
|
/**
|
|
@@ -47764,6 +48097,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47764
48097
|
);
|
|
47765
48098
|
}
|
|
47766
48099
|
|
|
48100
|
+
/**
|
|
48101
|
+
* Delete a utilization label
|
|
48102
|
+
*
|
|
48103
|
+
* @param {String} labelId Utilization Label ID
|
|
48104
|
+
* @param {Object} opts Optional parameters
|
|
48105
|
+
* @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
|
|
48106
|
+
* deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48107
|
+
*/
|
|
48108
|
+
deleteRoutingUtilizationLabel(labelId, opts) {
|
|
48109
|
+
opts = opts || {};
|
|
48110
|
+
|
|
48111
|
+
// verify the required parameter 'labelId' is set
|
|
48112
|
+
if (labelId === undefined || labelId === null) {
|
|
48113
|
+
throw 'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';
|
|
48114
|
+
}
|
|
48115
|
+
|
|
48116
|
+
return this.apiClient.callApi(
|
|
48117
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
48118
|
+
'DELETE',
|
|
48119
|
+
{ 'labelId': labelId },
|
|
48120
|
+
{ 'forceDelete': opts['forceDelete'] },
|
|
48121
|
+
{ },
|
|
48122
|
+
{ },
|
|
48123
|
+
null,
|
|
48124
|
+
['PureCloud OAuth'],
|
|
48125
|
+
['application/json'],
|
|
48126
|
+
['application/json']
|
|
48127
|
+
);
|
|
48128
|
+
}
|
|
48129
|
+
|
|
47767
48130
|
/**
|
|
47768
48131
|
* Delete an utilization tag
|
|
47769
48132
|
*
|
|
@@ -49254,6 +49617,86 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49254
49617
|
);
|
|
49255
49618
|
}
|
|
49256
49619
|
|
|
49620
|
+
/**
|
|
49621
|
+
* Get details about this utilization label
|
|
49622
|
+
*
|
|
49623
|
+
* @param {String} labelId Utilization Label ID
|
|
49624
|
+
* getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49625
|
+
*/
|
|
49626
|
+
getRoutingUtilizationLabel(labelId) {
|
|
49627
|
+
// verify the required parameter 'labelId' is set
|
|
49628
|
+
if (labelId === undefined || labelId === null) {
|
|
49629
|
+
throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';
|
|
49630
|
+
}
|
|
49631
|
+
|
|
49632
|
+
return this.apiClient.callApi(
|
|
49633
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
49634
|
+
'GET',
|
|
49635
|
+
{ 'labelId': labelId },
|
|
49636
|
+
{ },
|
|
49637
|
+
{ },
|
|
49638
|
+
{ },
|
|
49639
|
+
null,
|
|
49640
|
+
['PureCloud OAuth'],
|
|
49641
|
+
['application/json'],
|
|
49642
|
+
['application/json']
|
|
49643
|
+
);
|
|
49644
|
+
}
|
|
49645
|
+
|
|
49646
|
+
/**
|
|
49647
|
+
* Get list of agent ids associated with a utilization label
|
|
49648
|
+
*
|
|
49649
|
+
* @param {String} labelId Utilization Label ID
|
|
49650
|
+
* getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49651
|
+
*/
|
|
49652
|
+
getRoutingUtilizationLabelAgents(labelId) {
|
|
49653
|
+
// verify the required parameter 'labelId' is set
|
|
49654
|
+
if (labelId === undefined || labelId === null) {
|
|
49655
|
+
throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';
|
|
49656
|
+
}
|
|
49657
|
+
|
|
49658
|
+
return this.apiClient.callApi(
|
|
49659
|
+
'/api/v2/routing/utilization/labels/{labelId}/agents',
|
|
49660
|
+
'GET',
|
|
49661
|
+
{ 'labelId': labelId },
|
|
49662
|
+
{ },
|
|
49663
|
+
{ },
|
|
49664
|
+
{ },
|
|
49665
|
+
null,
|
|
49666
|
+
['PureCloud OAuth'],
|
|
49667
|
+
['application/json'],
|
|
49668
|
+
['application/json']
|
|
49669
|
+
);
|
|
49670
|
+
}
|
|
49671
|
+
|
|
49672
|
+
/**
|
|
49673
|
+
* Get list of utilization labels
|
|
49674
|
+
*
|
|
49675
|
+
* @param {Object} opts Optional parameters
|
|
49676
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
49677
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
49678
|
+
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
49679
|
+
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
49680
|
+
* getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49681
|
+
*/
|
|
49682
|
+
getRoutingUtilizationLabels(opts) {
|
|
49683
|
+
opts = opts || {};
|
|
49684
|
+
|
|
49685
|
+
|
|
49686
|
+
return this.apiClient.callApi(
|
|
49687
|
+
'/api/v2/routing/utilization/labels',
|
|
49688
|
+
'GET',
|
|
49689
|
+
{ },
|
|
49690
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
49691
|
+
{ },
|
|
49692
|
+
{ },
|
|
49693
|
+
null,
|
|
49694
|
+
['PureCloud OAuth'],
|
|
49695
|
+
['application/json'],
|
|
49696
|
+
['application/json']
|
|
49697
|
+
);
|
|
49698
|
+
}
|
|
49699
|
+
|
|
49257
49700
|
/**
|
|
49258
49701
|
* Get details about this utilization tag
|
|
49259
49702
|
*
|
|
@@ -50550,6 +50993,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50550
50993
|
);
|
|
50551
50994
|
}
|
|
50552
50995
|
|
|
50996
|
+
/**
|
|
50997
|
+
* Create a utilization label
|
|
50998
|
+
*
|
|
50999
|
+
* @param {Object} body UtilizationLabel
|
|
51000
|
+
* postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51001
|
+
*/
|
|
51002
|
+
postRoutingUtilizationLabels(body) {
|
|
51003
|
+
// verify the required parameter 'body' is set
|
|
51004
|
+
if (body === undefined || body === null) {
|
|
51005
|
+
throw 'Missing the required parameter "body" when calling postRoutingUtilizationLabels';
|
|
51006
|
+
}
|
|
51007
|
+
|
|
51008
|
+
return this.apiClient.callApi(
|
|
51009
|
+
'/api/v2/routing/utilization/labels',
|
|
51010
|
+
'POST',
|
|
51011
|
+
{ },
|
|
51012
|
+
{ },
|
|
51013
|
+
{ },
|
|
51014
|
+
{ },
|
|
51015
|
+
body,
|
|
51016
|
+
['PureCloud OAuth'],
|
|
51017
|
+
['application/json'],
|
|
51018
|
+
['application/json']
|
|
51019
|
+
);
|
|
51020
|
+
}
|
|
51021
|
+
|
|
50553
51022
|
/**
|
|
50554
51023
|
* Create an utilization tag
|
|
50555
51024
|
*
|
|
@@ -50916,6 +51385,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50916
51385
|
);
|
|
50917
51386
|
}
|
|
50918
51387
|
|
|
51388
|
+
/**
|
|
51389
|
+
* Update a utilization label
|
|
51390
|
+
*
|
|
51391
|
+
* @param {String} labelId Utilization Label ID
|
|
51392
|
+
* @param {Object} body UtilizationLabel
|
|
51393
|
+
* putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51394
|
+
*/
|
|
51395
|
+
putRoutingUtilizationLabel(labelId, body) {
|
|
51396
|
+
// verify the required parameter 'labelId' is set
|
|
51397
|
+
if (labelId === undefined || labelId === null) {
|
|
51398
|
+
throw 'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';
|
|
51399
|
+
}
|
|
51400
|
+
// verify the required parameter 'body' is set
|
|
51401
|
+
if (body === undefined || body === null) {
|
|
51402
|
+
throw 'Missing the required parameter "body" when calling putRoutingUtilizationLabel';
|
|
51403
|
+
}
|
|
51404
|
+
|
|
51405
|
+
return this.apiClient.callApi(
|
|
51406
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
51407
|
+
'PUT',
|
|
51408
|
+
{ 'labelId': labelId },
|
|
51409
|
+
{ },
|
|
51410
|
+
{ },
|
|
51411
|
+
{ },
|
|
51412
|
+
body,
|
|
51413
|
+
['PureCloud OAuth'],
|
|
51414
|
+
['application/json'],
|
|
51415
|
+
['application/json']
|
|
51416
|
+
);
|
|
51417
|
+
}
|
|
51418
|
+
|
|
50919
51419
|
/**
|
|
50920
51420
|
* Update wrap-up code
|
|
50921
51421
|
*
|
|
@@ -51017,7 +51517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51017
51517
|
/**
|
|
51018
51518
|
* SCIM service.
|
|
51019
51519
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
51020
|
-
* @version
|
|
51520
|
+
* @version 185.0.0
|
|
51021
51521
|
*/
|
|
51022
51522
|
|
|
51023
51523
|
/**
|
|
@@ -51894,7 +52394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51894
52394
|
/**
|
|
51895
52395
|
* Scripts service.
|
|
51896
52396
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51897
|
-
* @version
|
|
52397
|
+
* @version 185.0.0
|
|
51898
52398
|
*/
|
|
51899
52399
|
|
|
51900
52400
|
/**
|
|
@@ -52338,7 +52838,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52338
52838
|
/**
|
|
52339
52839
|
* Search service.
|
|
52340
52840
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
52341
|
-
* @version
|
|
52841
|
+
* @version 185.0.0
|
|
52342
52842
|
*/
|
|
52343
52843
|
|
|
52344
52844
|
/**
|
|
@@ -53027,7 +53527,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53027
53527
|
/**
|
|
53028
53528
|
* Settings service.
|
|
53029
53529
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
53030
|
-
* @version
|
|
53530
|
+
* @version 185.0.0
|
|
53031
53531
|
*/
|
|
53032
53532
|
|
|
53033
53533
|
/**
|
|
@@ -53092,7 +53592,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53092
53592
|
/**
|
|
53093
53593
|
* SpeechTextAnalytics service.
|
|
53094
53594
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
53095
|
-
* @version
|
|
53595
|
+
* @version 185.0.0
|
|
53096
53596
|
*/
|
|
53097
53597
|
|
|
53098
53598
|
/**
|
|
@@ -54205,7 +54705,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54205
54705
|
/**
|
|
54206
54706
|
* Stations service.
|
|
54207
54707
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
54208
|
-
* @version
|
|
54708
|
+
* @version 185.0.0
|
|
54209
54709
|
*/
|
|
54210
54710
|
|
|
54211
54711
|
/**
|
|
@@ -54307,7 +54807,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54307
54807
|
/**
|
|
54308
54808
|
* Suggest service.
|
|
54309
54809
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
54310
|
-
* @version
|
|
54810
|
+
* @version 185.0.0
|
|
54311
54811
|
*/
|
|
54312
54812
|
|
|
54313
54813
|
/**
|
|
@@ -54446,7 +54946,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54446
54946
|
/**
|
|
54447
54947
|
* TaskManagement service.
|
|
54448
54948
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
54449
|
-
* @version
|
|
54949
|
+
* @version 185.0.0
|
|
54450
54950
|
*/
|
|
54451
54951
|
|
|
54452
54952
|
/**
|
|
@@ -55727,7 +56227,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55727
56227
|
/**
|
|
55728
56228
|
* Teams service.
|
|
55729
56229
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
55730
|
-
* @version
|
|
56230
|
+
* @version 185.0.0
|
|
55731
56231
|
*/
|
|
55732
56232
|
|
|
55733
56233
|
/**
|
|
@@ -56029,7 +56529,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56029
56529
|
/**
|
|
56030
56530
|
* Telephony service.
|
|
56031
56531
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
56032
|
-
* @version
|
|
56532
|
+
* @version 185.0.0
|
|
56033
56533
|
*/
|
|
56034
56534
|
|
|
56035
56535
|
/**
|
|
@@ -56213,7 +56713,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56213
56713
|
/**
|
|
56214
56714
|
* TelephonyProvidersEdge service.
|
|
56215
56715
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
56216
|
-
* @version
|
|
56716
|
+
* @version 185.0.0
|
|
56217
56717
|
*/
|
|
56218
56718
|
|
|
56219
56719
|
/**
|
|
@@ -56981,8 +57481,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56981
57481
|
}
|
|
56982
57482
|
|
|
56983
57483
|
/**
|
|
56984
|
-
* Get the list of available languages.
|
|
57484
|
+
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
56985
57485
|
*
|
|
57486
|
+
* @deprecated
|
|
56986
57487
|
*/
|
|
56987
57488
|
getTelephonyProvidersEdgesAvailablelanguages() {
|
|
56988
57489
|
|
|
@@ -59587,7 +60088,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59587
60088
|
/**
|
|
59588
60089
|
* Textbots service.
|
|
59589
60090
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
59590
|
-
* @version
|
|
60091
|
+
* @version 185.0.0
|
|
59591
60092
|
*/
|
|
59592
60093
|
|
|
59593
60094
|
/**
|
|
@@ -59715,7 +60216,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59715
60216
|
/**
|
|
59716
60217
|
* Tokens service.
|
|
59717
60218
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
59718
|
-
* @version
|
|
60219
|
+
* @version 185.0.0
|
|
59719
60220
|
*/
|
|
59720
60221
|
|
|
59721
60222
|
/**
|
|
@@ -59871,7 +60372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59871
60372
|
/**
|
|
59872
60373
|
* Uploads service.
|
|
59873
60374
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
59874
|
-
* @version
|
|
60375
|
+
* @version 185.0.0
|
|
59875
60376
|
*/
|
|
59876
60377
|
|
|
59877
60378
|
/**
|
|
@@ -60047,7 +60548,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60047
60548
|
/**
|
|
60048
60549
|
* Usage service.
|
|
60049
60550
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
60050
|
-
* @version
|
|
60551
|
+
* @version 185.0.0
|
|
60051
60552
|
*/
|
|
60052
60553
|
|
|
60053
60554
|
/**
|
|
@@ -60257,7 +60758,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60257
60758
|
/**
|
|
60258
60759
|
* UserRecordings service.
|
|
60259
60760
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
60260
|
-
* @version
|
|
60761
|
+
* @version 185.0.0
|
|
60261
60762
|
*/
|
|
60262
60763
|
|
|
60263
60764
|
/**
|
|
@@ -60442,7 +60943,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60442
60943
|
/**
|
|
60443
60944
|
* Users service.
|
|
60444
60945
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
60445
|
-
* @version
|
|
60946
|
+
* @version 185.0.0
|
|
60446
60947
|
*/
|
|
60447
60948
|
|
|
60448
60949
|
/**
|
|
@@ -63093,7 +63594,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63093
63594
|
/**
|
|
63094
63595
|
* Utilities service.
|
|
63095
63596
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
63096
|
-
* @version
|
|
63597
|
+
* @version 185.0.0
|
|
63097
63598
|
*/
|
|
63098
63599
|
|
|
63099
63600
|
/**
|
|
@@ -63204,7 +63705,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63204
63705
|
/**
|
|
63205
63706
|
* Voicemail service.
|
|
63206
63707
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
63207
|
-
* @version
|
|
63708
|
+
* @version 185.0.0
|
|
63208
63709
|
*/
|
|
63209
63710
|
|
|
63210
63711
|
/**
|
|
@@ -63871,7 +64372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63871
64372
|
/**
|
|
63872
64373
|
* WebChat service.
|
|
63873
64374
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
63874
|
-
* @version
|
|
64375
|
+
* @version 185.0.0
|
|
63875
64376
|
*/
|
|
63876
64377
|
|
|
63877
64378
|
/**
|
|
@@ -64420,7 +64921,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64420
64921
|
/**
|
|
64421
64922
|
* WebDeployments service.
|
|
64422
64923
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
64423
|
-
* @version
|
|
64924
|
+
* @version 185.0.0
|
|
64424
64925
|
*/
|
|
64425
64926
|
|
|
64426
64927
|
/**
|
|
@@ -64947,7 +65448,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64947
65448
|
/**
|
|
64948
65449
|
* WebMessaging service.
|
|
64949
65450
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
64950
|
-
* @version
|
|
65451
|
+
* @version 185.0.0
|
|
64951
65452
|
*/
|
|
64952
65453
|
|
|
64953
65454
|
/**
|
|
@@ -64993,7 +65494,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64993
65494
|
/**
|
|
64994
65495
|
* Widgets service.
|
|
64995
65496
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
64996
|
-
* @version
|
|
65497
|
+
* @version 185.0.0
|
|
64997
65498
|
*/
|
|
64998
65499
|
|
|
64999
65500
|
/**
|
|
@@ -65139,7 +65640,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65139
65640
|
/**
|
|
65140
65641
|
* WorkforceManagement service.
|
|
65141
65642
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
65142
|
-
* @version
|
|
65643
|
+
* @version 185.0.0
|
|
65143
65644
|
*/
|
|
65144
65645
|
|
|
65145
65646
|
/**
|
|
@@ -66273,6 +66774,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66273
66774
|
);
|
|
66274
66775
|
}
|
|
66275
66776
|
|
|
66777
|
+
/**
|
|
66778
|
+
* Get the performance prediction for the associated schedule
|
|
66779
|
+
*
|
|
66780
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
66781
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
66782
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
66783
|
+
*/
|
|
66784
|
+
getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(businessUnitId, weekId, scheduleId) {
|
|
66785
|
+
// verify the required parameter 'businessUnitId' is set
|
|
66786
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
66787
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
66788
|
+
}
|
|
66789
|
+
// verify the required parameter 'weekId' is set
|
|
66790
|
+
if (weekId === undefined || weekId === null) {
|
|
66791
|
+
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
66792
|
+
}
|
|
66793
|
+
// verify the required parameter 'scheduleId' is set
|
|
66794
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
66795
|
+
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
66796
|
+
}
|
|
66797
|
+
|
|
66798
|
+
return this.apiClient.callApi(
|
|
66799
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions',
|
|
66800
|
+
'GET',
|
|
66801
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
66802
|
+
{ },
|
|
66803
|
+
{ },
|
|
66804
|
+
{ },
|
|
66805
|
+
null,
|
|
66806
|
+
['PureCloud OAuth'],
|
|
66807
|
+
['application/json'],
|
|
66808
|
+
['application/json']
|
|
66809
|
+
);
|
|
66810
|
+
}
|
|
66811
|
+
|
|
66812
|
+
/**
|
|
66813
|
+
* Get recalculated performance prediction result
|
|
66814
|
+
*
|
|
66815
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
66816
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
66817
|
+
* @param {String} scheduleId The ID of the schedule the recalculation belongs to
|
|
66818
|
+
* @param {String} recalculationId The ID of the recalculation request
|
|
66819
|
+
*/
|
|
66820
|
+
getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(businessUnitId, weekId, scheduleId, recalculationId) {
|
|
66821
|
+
// verify the required parameter 'businessUnitId' is set
|
|
66822
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
66823
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
66824
|
+
}
|
|
66825
|
+
// verify the required parameter 'weekId' is set
|
|
66826
|
+
if (weekId === undefined || weekId === null) {
|
|
66827
|
+
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
66828
|
+
}
|
|
66829
|
+
// verify the required parameter 'scheduleId' is set
|
|
66830
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
66831
|
+
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
66832
|
+
}
|
|
66833
|
+
// verify the required parameter 'recalculationId' is set
|
|
66834
|
+
if (recalculationId === undefined || recalculationId === null) {
|
|
66835
|
+
throw 'Missing the required parameter "recalculationId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
66836
|
+
}
|
|
66837
|
+
|
|
66838
|
+
return this.apiClient.callApi(
|
|
66839
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}',
|
|
66840
|
+
'GET',
|
|
66841
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId,'recalculationId': recalculationId },
|
|
66842
|
+
{ },
|
|
66843
|
+
{ },
|
|
66844
|
+
{ },
|
|
66845
|
+
null,
|
|
66846
|
+
['PureCloud OAuth'],
|
|
66847
|
+
['application/json'],
|
|
66848
|
+
['application/json']
|
|
66849
|
+
);
|
|
66850
|
+
}
|
|
66851
|
+
|
|
66276
66852
|
/**
|
|
66277
66853
|
* Get the list of week schedules for the specified week
|
|
66278
66854
|
* Use "recent" (without quotes) for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week
|
|
@@ -66496,6 +67072,45 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66496
67072
|
);
|
|
66497
67073
|
}
|
|
66498
67074
|
|
|
67075
|
+
/**
|
|
67076
|
+
* Get the staffing requirement by planning group for a forecast
|
|
67077
|
+
*
|
|
67078
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
67079
|
+
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
67080
|
+
* @param {String} forecastId The ID of the forecast
|
|
67081
|
+
* @param {Object} opts Optional parameters
|
|
67082
|
+
* @param {Array.<String>} opts.weekNumbers The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified
|
|
67083
|
+
*/
|
|
67084
|
+
getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId, weekDateId, forecastId, opts) {
|
|
67085
|
+
opts = opts || {};
|
|
67086
|
+
|
|
67087
|
+
// verify the required parameter 'businessUnitId' is set
|
|
67088
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
67089
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67090
|
+
}
|
|
67091
|
+
// verify the required parameter 'weekDateId' is set
|
|
67092
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
67093
|
+
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67094
|
+
}
|
|
67095
|
+
// verify the required parameter 'forecastId' is set
|
|
67096
|
+
if (forecastId === undefined || forecastId === null) {
|
|
67097
|
+
throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67098
|
+
}
|
|
67099
|
+
|
|
67100
|
+
return this.apiClient.callApi(
|
|
67101
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement',
|
|
67102
|
+
'GET',
|
|
67103
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
67104
|
+
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi') },
|
|
67105
|
+
{ },
|
|
67106
|
+
{ },
|
|
67107
|
+
null,
|
|
67108
|
+
['PureCloud OAuth'],
|
|
67109
|
+
['application/json'],
|
|
67110
|
+
['application/json']
|
|
67111
|
+
);
|
|
67112
|
+
}
|
|
67113
|
+
|
|
66499
67114
|
/**
|
|
66500
67115
|
* Get short term forecasts
|
|
66501
67116
|
* Use "recent" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
@@ -67847,6 +68462,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67847
68462
|
);
|
|
67848
68463
|
}
|
|
67849
68464
|
|
|
68465
|
+
/**
|
|
68466
|
+
* Update agent configurations
|
|
68467
|
+
*
|
|
68468
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
68469
|
+
* @param {Object} opts Optional parameters
|
|
68470
|
+
* @param {Object} opts.body body
|
|
68471
|
+
*/
|
|
68472
|
+
patchWorkforcemanagementManagementunitAgents(managementUnitId, opts) {
|
|
68473
|
+
opts = opts || {};
|
|
68474
|
+
|
|
68475
|
+
// verify the required parameter 'managementUnitId' is set
|
|
68476
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
68477
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';
|
|
68478
|
+
}
|
|
68479
|
+
|
|
68480
|
+
return this.apiClient.callApi(
|
|
68481
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents',
|
|
68482
|
+
'PATCH',
|
|
68483
|
+
{ 'managementUnitId': managementUnitId },
|
|
68484
|
+
{ },
|
|
68485
|
+
{ },
|
|
68486
|
+
{ },
|
|
68487
|
+
opts['body'],
|
|
68488
|
+
['PureCloud OAuth'],
|
|
68489
|
+
['application/json'],
|
|
68490
|
+
['application/json']
|
|
68491
|
+
);
|
|
68492
|
+
}
|
|
68493
|
+
|
|
67850
68494
|
/**
|
|
67851
68495
|
* Updates a time off limit object.
|
|
67852
68496
|
* Updates time off limit object properties, but not daily values.
|
|
@@ -68665,6 +69309,84 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68665
69309
|
);
|
|
68666
69310
|
}
|
|
68667
69311
|
|
|
69312
|
+
/**
|
|
69313
|
+
* Request a daily recalculation of the performance prediction for the associated schedule
|
|
69314
|
+
*
|
|
69315
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
69316
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
69317
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
69318
|
+
* @param {Object} opts Optional parameters
|
|
69319
|
+
* @param {Object} opts.body body
|
|
69320
|
+
*/
|
|
69321
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId, opts) {
|
|
69322
|
+
opts = opts || {};
|
|
69323
|
+
|
|
69324
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69325
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69326
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69327
|
+
}
|
|
69328
|
+
// verify the required parameter 'weekId' is set
|
|
69329
|
+
if (weekId === undefined || weekId === null) {
|
|
69330
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69331
|
+
}
|
|
69332
|
+
// verify the required parameter 'scheduleId' is set
|
|
69333
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
69334
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69335
|
+
}
|
|
69336
|
+
|
|
69337
|
+
return this.apiClient.callApi(
|
|
69338
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations',
|
|
69339
|
+
'POST',
|
|
69340
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
69341
|
+
{ },
|
|
69342
|
+
{ },
|
|
69343
|
+
{ },
|
|
69344
|
+
opts['body'],
|
|
69345
|
+
['PureCloud OAuth'],
|
|
69346
|
+
['application/json'],
|
|
69347
|
+
['application/json']
|
|
69348
|
+
);
|
|
69349
|
+
}
|
|
69350
|
+
|
|
69351
|
+
/**
|
|
69352
|
+
* Upload daily activity changes to be able to request a performance prediction recalculation
|
|
69353
|
+
*
|
|
69354
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
69355
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
69356
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
69357
|
+
* @param {Object} opts Optional parameters
|
|
69358
|
+
* @param {Object} opts.body body
|
|
69359
|
+
*/
|
|
69360
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId, opts) {
|
|
69361
|
+
opts = opts || {};
|
|
69362
|
+
|
|
69363
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69364
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69365
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69366
|
+
}
|
|
69367
|
+
// verify the required parameter 'weekId' is set
|
|
69368
|
+
if (weekId === undefined || weekId === null) {
|
|
69369
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69370
|
+
}
|
|
69371
|
+
// verify the required parameter 'scheduleId' is set
|
|
69372
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
69373
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69374
|
+
}
|
|
69375
|
+
|
|
69376
|
+
return this.apiClient.callApi(
|
|
69377
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl',
|
|
69378
|
+
'POST',
|
|
69379
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
69380
|
+
{ },
|
|
69381
|
+
{ },
|
|
69382
|
+
{ },
|
|
69383
|
+
opts['body'],
|
|
69384
|
+
['PureCloud OAuth'],
|
|
69385
|
+
['application/json'],
|
|
69386
|
+
['application/json']
|
|
69387
|
+
);
|
|
69388
|
+
}
|
|
69389
|
+
|
|
68668
69390
|
/**
|
|
68669
69391
|
* Start a rescheduling run
|
|
68670
69392
|
*
|
|
@@ -70313,7 +71035,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70313
71035
|
* </pre>
|
|
70314
71036
|
* </p>
|
|
70315
71037
|
* @module purecloud-platform-client-v2/index
|
|
70316
|
-
* @version
|
|
71038
|
+
* @version 185.0.0
|
|
70317
71039
|
*/
|
|
70318
71040
|
class platformClient {
|
|
70319
71041
|
constructor() {
|