purecloud-platform-client-v2 183.0.0 → 185.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +68 -2
- package/dist/node/purecloud-platform-client-v2.js +1395 -92
- package/dist/web-amd/purecloud-platform-client-v2.js +1395 -92
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +411 -107
- package/dist/web-cjs/purecloud-platform-client-v2.js +411 -107
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +823 -54
- 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 +109 -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 +8 -9
- 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 +75 -0
- 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 +7 -8
- 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 +401 -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 +7 -1
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 185.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -813,6 +813,339 @@ class ApiClient {
|
|
|
813
813
|
});
|
|
814
814
|
}
|
|
815
815
|
|
|
816
|
+
/**
|
|
817
|
+
* @description Completes the PKCE Code Authorization.
|
|
818
|
+
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
819
|
+
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
820
|
+
* @param {string} authCode - Authorization code
|
|
821
|
+
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
822
|
+
*/
|
|
823
|
+
authorizePKCEGrant(clientId, codeVerifier, authCode, redirectUri) {
|
|
824
|
+
this.clientId = clientId;
|
|
825
|
+
return new Promise((resolve, reject) => {
|
|
826
|
+
var request = axios__default["default"]({
|
|
827
|
+
method: `POST`,
|
|
828
|
+
url: `https://login.${this.config.environment}/oauth/token`,
|
|
829
|
+
headers: {
|
|
830
|
+
'Content-Type': 'application/x-www-form-urlencoded'
|
|
831
|
+
},
|
|
832
|
+
data: qs__default["default"].stringify({ grant_type: 'authorization_code',
|
|
833
|
+
code: authCode,
|
|
834
|
+
code_verifier: codeVerifier,
|
|
835
|
+
client_id: clientId,
|
|
836
|
+
redirect_uri: redirectUri })
|
|
837
|
+
});
|
|
838
|
+
|
|
839
|
+
request.proxy = this.proxy;
|
|
840
|
+
var bodyParam = {
|
|
841
|
+
grant_type: 'authorization_code',
|
|
842
|
+
code: authCode,
|
|
843
|
+
code_verifier: codeVerifier,
|
|
844
|
+
client_id: clientId,
|
|
845
|
+
redirect_uri: redirectUri,
|
|
846
|
+
};
|
|
847
|
+
// Handle response
|
|
848
|
+
request
|
|
849
|
+
.then((response) => {
|
|
850
|
+
// Logging
|
|
851
|
+
this.config.logger.log(
|
|
852
|
+
'trace',
|
|
853
|
+
response.status,
|
|
854
|
+
'POST',
|
|
855
|
+
`https://login.${this.config.environment}/oauth/token`,
|
|
856
|
+
request.headers,
|
|
857
|
+
response.headers,
|
|
858
|
+
bodyParam,
|
|
859
|
+
undefined
|
|
860
|
+
);
|
|
861
|
+
this.config.logger.log(
|
|
862
|
+
'debug',
|
|
863
|
+
response.status,
|
|
864
|
+
'POST',
|
|
865
|
+
`https://login.${this.config.environment}/oauth/token`,
|
|
866
|
+
request.headers,
|
|
867
|
+
undefined,
|
|
868
|
+
bodyParam,
|
|
869
|
+
undefined
|
|
870
|
+
);
|
|
871
|
+
|
|
872
|
+
// Get access token from response
|
|
873
|
+
var access_token = response.data.access_token;
|
|
874
|
+
|
|
875
|
+
this.setAccessToken(access_token);
|
|
876
|
+
this.authData.tokenExpiryTime = new Date().getTime() + response.data['expires_in'] * 1000;
|
|
877
|
+
this.authData.tokenExpiryTimeString = new Date(this.authData.tokenExpiryTime).toUTCString();
|
|
878
|
+
|
|
879
|
+
// Return auth data
|
|
880
|
+
resolve(this.authData);
|
|
881
|
+
})
|
|
882
|
+
.catch((error) => {
|
|
883
|
+
// Log error
|
|
884
|
+
if (error.response) {
|
|
885
|
+
this.config.logger.log(
|
|
886
|
+
'error',
|
|
887
|
+
error.response.status,
|
|
888
|
+
'POST',
|
|
889
|
+
`https://login.${this.config.environment}/oauth/token`,
|
|
890
|
+
request.headers,
|
|
891
|
+
error.response.headers,
|
|
892
|
+
bodyParam,
|
|
893
|
+
error.response.data
|
|
894
|
+
);
|
|
895
|
+
}
|
|
896
|
+
|
|
897
|
+
reject(error);
|
|
898
|
+
});
|
|
899
|
+
|
|
900
|
+
});
|
|
901
|
+
}
|
|
902
|
+
|
|
903
|
+
/**
|
|
904
|
+
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
905
|
+
* @param {number} nChar - code length
|
|
906
|
+
*/
|
|
907
|
+
generatePKCECodeVerifier(nChar) {
|
|
908
|
+
if (nChar < 43 || nChar > 128) {
|
|
909
|
+
throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
|
|
910
|
+
}
|
|
911
|
+
// Check for window
|
|
912
|
+
if (typeof window === 'undefined') {
|
|
913
|
+
try {
|
|
914
|
+
const getRandomValues = require('crypto').getRandomValues;
|
|
915
|
+
const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
|
|
916
|
+
let randomString = Array.from(getRandomValues(new Uint32Array(nChar)))
|
|
917
|
+
.map((x) => unreservedCharacters[x % unreservedCharacters.length])
|
|
918
|
+
.join('');
|
|
919
|
+
return randomString;
|
|
920
|
+
} catch (err) {
|
|
921
|
+
throw new Error(`Crypto module is missing/not supported.`);
|
|
922
|
+
}
|
|
923
|
+
} else {
|
|
924
|
+
const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
|
|
925
|
+
let randomString = Array.from(crypto.getRandomValues(new Uint32Array(nChar)))
|
|
926
|
+
.map((x) => unreservedCharacters[x % unreservedCharacters.length])
|
|
927
|
+
.join('');
|
|
928
|
+
return randomString;
|
|
929
|
+
}
|
|
930
|
+
}
|
|
931
|
+
|
|
932
|
+
/**
|
|
933
|
+
* @description Compute Base64Url PKCE Code Challenge from Code Verifier.
|
|
934
|
+
* @param {string} code - code verifier used to generate the code challenge
|
|
935
|
+
*/
|
|
936
|
+
computePKCECodeChallenge(code) {
|
|
937
|
+
if (code.length < 43 || code.length > 128) {
|
|
938
|
+
throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
|
|
939
|
+
}
|
|
940
|
+
// Check for window
|
|
941
|
+
if (typeof window === 'undefined') {
|
|
942
|
+
// nodejs
|
|
943
|
+
try {
|
|
944
|
+
const createHash = require('crypto').createHash;
|
|
945
|
+
const utf8 = new TextEncoder().encode(code);
|
|
946
|
+
return new Promise((resolve, reject) => {
|
|
947
|
+
const hashHex = createHash('sha256').update(utf8).digest();
|
|
948
|
+
const hashBase64Url = Buffer.from(hashHex).toString('base64url');
|
|
949
|
+
resolve(hashBase64Url);
|
|
950
|
+
});
|
|
951
|
+
} catch (err) {
|
|
952
|
+
throw new Error(`Crypto module is missing/not supported.`);
|
|
953
|
+
}
|
|
954
|
+
} else {
|
|
955
|
+
// browser
|
|
956
|
+
const utf8 = new TextEncoder().encode(code);
|
|
957
|
+
return new Promise((resolve, reject) => {
|
|
958
|
+
window.crypto.subtle.digest("SHA-256", utf8).then((hashBuffer) => {
|
|
959
|
+
const hashBase64 = Buffer.from(hashBuffer).toString('base64');
|
|
960
|
+
let hashBase64Url = hashBase64.replaceAll("+", "-").replaceAll("/", "_");
|
|
961
|
+
hashBase64Url = hashBase64Url.split("=")[0];
|
|
962
|
+
resolve(hashBase64Url);
|
|
963
|
+
})
|
|
964
|
+
.catch((error) => {
|
|
965
|
+
// Handle failure
|
|
966
|
+
return reject(new Error(`Code Challenge Error ${error}`));
|
|
967
|
+
});
|
|
968
|
+
});
|
|
969
|
+
}
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* @description Initiates the pkce auth code grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
974
|
+
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
975
|
+
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
976
|
+
* @param {object} opts - (optional) Additional options
|
|
977
|
+
* @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
|
|
978
|
+
* @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
|
|
979
|
+
* @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
|
|
980
|
+
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
981
|
+
*/
|
|
982
|
+
loginPKCEGrant(clientId, redirectUri, opts, codeVerifier) {
|
|
983
|
+
// Need Local Storage or non null codeVerifier as parameter
|
|
984
|
+
if (!this.hasLocalStorage && !codeVerifier) {
|
|
985
|
+
throw new Error(`loginPKCEGrant requires Local Storage or codeVerifier as input parameter`);
|
|
986
|
+
}
|
|
987
|
+
// Check for auth code in query
|
|
988
|
+
const query = this._setValuesFromUrlQuery();
|
|
989
|
+
|
|
990
|
+
this.clientId = clientId;
|
|
991
|
+
this.redirectUri = redirectUri;
|
|
992
|
+
|
|
993
|
+
this.codeVerifier = codeVerifier;
|
|
994
|
+
|
|
995
|
+
if (!opts) opts = {};
|
|
996
|
+
|
|
997
|
+
return new Promise((resolve, reject) => {
|
|
998
|
+
// Abort if org and provider are not set together
|
|
999
|
+
if (opts.org && !opts.provider) {
|
|
1000
|
+
reject(new Error('opts.provider must be set if opts.org is set'));
|
|
1001
|
+
} else if (opts.provider && !opts.org) {
|
|
1002
|
+
reject(new Error('opts.org must be set if opts.provider is set'));
|
|
1003
|
+
}
|
|
1004
|
+
|
|
1005
|
+
// Abort on auth error
|
|
1006
|
+
if (query && query.error) {
|
|
1007
|
+
// remove codeVerifier from session storage
|
|
1008
|
+
if (this.hasLocalStorage) {
|
|
1009
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1010
|
+
}
|
|
1011
|
+
// reset access token if any was stored
|
|
1012
|
+
this._saveSettings({ accessToken: undefined });
|
|
1013
|
+
return reject(new Error(`[${query.error}] ${query.error_description}`));
|
|
1014
|
+
}
|
|
1015
|
+
|
|
1016
|
+
// Get token on auth code
|
|
1017
|
+
if (query && query.code) {
|
|
1018
|
+
if (!this.codeVerifier) {
|
|
1019
|
+
// load codeVerifier from session storage
|
|
1020
|
+
if (this.hasLocalStorage) {
|
|
1021
|
+
this.codeVerifier = sessionStorage.getItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1022
|
+
}
|
|
1023
|
+
}
|
|
1024
|
+
this.authorizePKCEGrant(this.clientId, this.codeVerifier, query.code, this.redirectUri)
|
|
1025
|
+
.then(() => {
|
|
1026
|
+
// Do authenticated things
|
|
1027
|
+
this._testTokenAccess()
|
|
1028
|
+
.then(() => {
|
|
1029
|
+
if (!this.authData.state && query.state)
|
|
1030
|
+
this.authData.state = query.state;
|
|
1031
|
+
// remove codeVerifier from session storage
|
|
1032
|
+
if (this.hasLocalStorage) {
|
|
1033
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1034
|
+
}
|
|
1035
|
+
resolve(this.authData);
|
|
1036
|
+
})
|
|
1037
|
+
.catch((error) => {
|
|
1038
|
+
// Handle failure response
|
|
1039
|
+
this._saveSettings({ accessToken: undefined});
|
|
1040
|
+
// remove codeVerifier from session storage
|
|
1041
|
+
if (this.hasLocalStorage) {
|
|
1042
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1043
|
+
}
|
|
1044
|
+
return reject(new Error(`[${error.name}] ${error.msg}`));
|
|
1045
|
+
});
|
|
1046
|
+
})
|
|
1047
|
+
.catch((error) => {
|
|
1048
|
+
// Handle failure response
|
|
1049
|
+
this._saveSettings({ accessToken: undefined});
|
|
1050
|
+
// remove codeVerifier from session storage
|
|
1051
|
+
if (this.hasLocalStorage) {
|
|
1052
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1053
|
+
}
|
|
1054
|
+
return reject(new Error(`[${error.name}] ${error.msg}`));
|
|
1055
|
+
});
|
|
1056
|
+
} else {
|
|
1057
|
+
// Test token (if previously stored) and proceed with login
|
|
1058
|
+
this._testTokenAccess()
|
|
1059
|
+
.then(() => {
|
|
1060
|
+
if (!this.authData.state && opts.state)
|
|
1061
|
+
this.authData.state = opts.state;
|
|
1062
|
+
resolve(this.authData);
|
|
1063
|
+
})
|
|
1064
|
+
.catch((error) => {
|
|
1065
|
+
if (!this.codeVerifier) {
|
|
1066
|
+
this.codeVerifier = this.generatePKCECodeVerifier(128);
|
|
1067
|
+
// save codeVerifier in session storage
|
|
1068
|
+
if (this.hasLocalStorage) {
|
|
1069
|
+
sessionStorage.setItem(`genesys_cloud_sdk_pkce_code_verifier`, this.codeVerifier);
|
|
1070
|
+
}
|
|
1071
|
+
}
|
|
1072
|
+
this.computePKCECodeChallenge(this.codeVerifier)
|
|
1073
|
+
.then((codeChallenge) => {
|
|
1074
|
+
var tokenQuery = {
|
|
1075
|
+
client_id: encodeURIComponent(this.clientId),
|
|
1076
|
+
redirect_uri: encodeURIComponent(this.redirectUri),
|
|
1077
|
+
code_challenge: encodeURIComponent(codeChallenge),
|
|
1078
|
+
response_type: 'code',
|
|
1079
|
+
code_challenge_method: 'S256'
|
|
1080
|
+
};
|
|
1081
|
+
if (opts.state) tokenQuery.state = encodeURIComponent(opts.state);
|
|
1082
|
+
if (opts.org) tokenQuery.org = encodeURIComponent(opts.org);
|
|
1083
|
+
if (opts.provider) tokenQuery.provider = encodeURIComponent(opts.provider);
|
|
1084
|
+
|
|
1085
|
+
var url = this._buildAuthUrl('oauth/authorize', tokenQuery);
|
|
1086
|
+
window.location.replace(url);
|
|
1087
|
+
})
|
|
1088
|
+
.catch((err) => {
|
|
1089
|
+
return reject(new Error(`[${err.name}]`));
|
|
1090
|
+
});
|
|
1091
|
+
});
|
|
1092
|
+
}
|
|
1093
|
+
});
|
|
1094
|
+
}
|
|
1095
|
+
|
|
1096
|
+
/**
|
|
1097
|
+
* @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
|
|
1098
|
+
*/
|
|
1099
|
+
_setValuesFromUrlQuery() {
|
|
1100
|
+
// Check for window
|
|
1101
|
+
if (!(typeof window !== 'undefined' && window.location.search)) return;
|
|
1102
|
+
|
|
1103
|
+
// Process query string
|
|
1104
|
+
let query = {};
|
|
1105
|
+
let queryParams = new URLSearchParams(window.location.search);
|
|
1106
|
+
let code = queryParams.get('code');
|
|
1107
|
+
let error = queryParams.get('error');
|
|
1108
|
+
let errorDescription = queryParams.get('error_description');
|
|
1109
|
+
let state = queryParams.get('state');
|
|
1110
|
+
|
|
1111
|
+
// Check for error
|
|
1112
|
+
if (error) {
|
|
1113
|
+
query.error = error;
|
|
1114
|
+
if (errorDescription) {
|
|
1115
|
+
query.error_description = errorDescription;
|
|
1116
|
+
}
|
|
1117
|
+
return query;
|
|
1118
|
+
}
|
|
1119
|
+
|
|
1120
|
+
// Everything goes in here because we only want to act if we found an access token
|
|
1121
|
+
if (code) {
|
|
1122
|
+
query.code = code;
|
|
1123
|
+
if (state) {
|
|
1124
|
+
query.state = state;
|
|
1125
|
+
}
|
|
1126
|
+
}
|
|
1127
|
+
|
|
1128
|
+
// Remove code from URL
|
|
1129
|
+
// Credit: https://stackoverflow.com/questions/1397329/how-to-remove-the-hash-from-window-location-with-javascript-without-page-refresh/5298684#5298684
|
|
1130
|
+
var scrollV, scrollH, loc = window.location;
|
|
1131
|
+
if ('replaceState' in history) {
|
|
1132
|
+
history.replaceState('', document.title, loc.pathname);
|
|
1133
|
+
} else {
|
|
1134
|
+
// Prevent scrolling by storing the page's current scroll offset
|
|
1135
|
+
scrollV = document.body.scrollTop;
|
|
1136
|
+
scrollH = document.body.scrollLeft;
|
|
1137
|
+
|
|
1138
|
+
// Remove code
|
|
1139
|
+
history.pushState('', document.title, loc.pathname);
|
|
1140
|
+
|
|
1141
|
+
// Restore the scroll offset, should be flicker free
|
|
1142
|
+
document.body.scrollTop = scrollV;
|
|
1143
|
+
document.body.scrollLeft = scrollH;
|
|
1144
|
+
}
|
|
1145
|
+
|
|
1146
|
+
return query;
|
|
1147
|
+
}
|
|
1148
|
+
|
|
816
1149
|
/**
|
|
817
1150
|
* @description Initiates the Code Authorization. Only available in node apps.
|
|
818
1151
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
@@ -1488,7 +1821,7 @@ class AlertingApi {
|
|
|
1488
1821
|
/**
|
|
1489
1822
|
* Alerting service.
|
|
1490
1823
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1491
|
-
* @version
|
|
1824
|
+
* @version 185.0.0
|
|
1492
1825
|
*/
|
|
1493
1826
|
|
|
1494
1827
|
/**
|
|
@@ -2149,7 +2482,7 @@ class AnalyticsApi {
|
|
|
2149
2482
|
/**
|
|
2150
2483
|
* Analytics service.
|
|
2151
2484
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2152
|
-
* @version
|
|
2485
|
+
* @version 185.0.0
|
|
2153
2486
|
*/
|
|
2154
2487
|
|
|
2155
2488
|
/**
|
|
@@ -2675,6 +3008,62 @@ class AnalyticsApi {
|
|
|
2675
3008
|
);
|
|
2676
3009
|
}
|
|
2677
3010
|
|
|
3011
|
+
/**
|
|
3012
|
+
* Get status for async query for flow execution aggregates
|
|
3013
|
+
*
|
|
3014
|
+
* @param {String} jobId jobId
|
|
3015
|
+
* getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3016
|
+
*/
|
|
3017
|
+
getAnalyticsFlowexecutionsAggregatesJob(jobId) {
|
|
3018
|
+
// verify the required parameter 'jobId' is set
|
|
3019
|
+
if (jobId === undefined || jobId === null) {
|
|
3020
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJob';
|
|
3021
|
+
}
|
|
3022
|
+
|
|
3023
|
+
return this.apiClient.callApi(
|
|
3024
|
+
'/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}',
|
|
3025
|
+
'GET',
|
|
3026
|
+
{ 'jobId': jobId },
|
|
3027
|
+
{ },
|
|
3028
|
+
{ },
|
|
3029
|
+
{ },
|
|
3030
|
+
null,
|
|
3031
|
+
['PureCloud OAuth'],
|
|
3032
|
+
['application/json'],
|
|
3033
|
+
['application/json']
|
|
3034
|
+
);
|
|
3035
|
+
}
|
|
3036
|
+
|
|
3037
|
+
/**
|
|
3038
|
+
* Fetch a page of results for an async aggregates query
|
|
3039
|
+
*
|
|
3040
|
+
* @param {String} jobId jobId
|
|
3041
|
+
* @param {Object} opts Optional parameters
|
|
3042
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
3043
|
+
* getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3044
|
+
*/
|
|
3045
|
+
getAnalyticsFlowexecutionsAggregatesJobResults(jobId, opts) {
|
|
3046
|
+
opts = opts || {};
|
|
3047
|
+
|
|
3048
|
+
// verify the required parameter 'jobId' is set
|
|
3049
|
+
if (jobId === undefined || jobId === null) {
|
|
3050
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJobResults';
|
|
3051
|
+
}
|
|
3052
|
+
|
|
3053
|
+
return this.apiClient.callApi(
|
|
3054
|
+
'/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results',
|
|
3055
|
+
'GET',
|
|
3056
|
+
{ 'jobId': jobId },
|
|
3057
|
+
{ 'cursor': opts['cursor'] },
|
|
3058
|
+
{ },
|
|
3059
|
+
{ },
|
|
3060
|
+
null,
|
|
3061
|
+
['PureCloud OAuth'],
|
|
3062
|
+
['application/json'],
|
|
3063
|
+
['application/json']
|
|
3064
|
+
);
|
|
3065
|
+
}
|
|
3066
|
+
|
|
2678
3067
|
/**
|
|
2679
3068
|
* Get status for async query for Flow aggregates
|
|
2680
3069
|
*
|
|
@@ -3858,6 +4247,58 @@ class AnalyticsApi {
|
|
|
3858
4247
|
);
|
|
3859
4248
|
}
|
|
3860
4249
|
|
|
4250
|
+
/**
|
|
4251
|
+
* Query for flow execution aggregates asynchronously
|
|
4252
|
+
*
|
|
4253
|
+
* @param {Object} body query
|
|
4254
|
+
* postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4255
|
+
*/
|
|
4256
|
+
postAnalyticsFlowexecutionsAggregatesJobs(body) {
|
|
4257
|
+
// verify the required parameter 'body' is set
|
|
4258
|
+
if (body === undefined || body === null) {
|
|
4259
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesJobs';
|
|
4260
|
+
}
|
|
4261
|
+
|
|
4262
|
+
return this.apiClient.callApi(
|
|
4263
|
+
'/api/v2/analytics/flowexecutions/aggregates/jobs',
|
|
4264
|
+
'POST',
|
|
4265
|
+
{ },
|
|
4266
|
+
{ },
|
|
4267
|
+
{ },
|
|
4268
|
+
{ },
|
|
4269
|
+
body,
|
|
4270
|
+
['PureCloud OAuth'],
|
|
4271
|
+
['application/json'],
|
|
4272
|
+
['application/json']
|
|
4273
|
+
);
|
|
4274
|
+
}
|
|
4275
|
+
|
|
4276
|
+
/**
|
|
4277
|
+
* Query for flow execution aggregates
|
|
4278
|
+
*
|
|
4279
|
+
* @param {Object} body query
|
|
4280
|
+
* postAnalyticsFlowexecutionsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4281
|
+
*/
|
|
4282
|
+
postAnalyticsFlowexecutionsAggregatesQuery(body) {
|
|
4283
|
+
// verify the required parameter 'body' is set
|
|
4284
|
+
if (body === undefined || body === null) {
|
|
4285
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesQuery';
|
|
4286
|
+
}
|
|
4287
|
+
|
|
4288
|
+
return this.apiClient.callApi(
|
|
4289
|
+
'/api/v2/analytics/flowexecutions/aggregates/query',
|
|
4290
|
+
'POST',
|
|
4291
|
+
{ },
|
|
4292
|
+
{ },
|
|
4293
|
+
{ },
|
|
4294
|
+
{ },
|
|
4295
|
+
body,
|
|
4296
|
+
['PureCloud OAuth'],
|
|
4297
|
+
['application/json'],
|
|
4298
|
+
['application/json']
|
|
4299
|
+
);
|
|
4300
|
+
}
|
|
4301
|
+
|
|
3861
4302
|
/**
|
|
3862
4303
|
* Query for flow activity observations
|
|
3863
4304
|
*
|
|
@@ -4631,7 +5072,7 @@ class ArchitectApi {
|
|
|
4631
5072
|
/**
|
|
4632
5073
|
* Architect service.
|
|
4633
5074
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4634
|
-
* @version
|
|
5075
|
+
* @version 185.0.0
|
|
4635
5076
|
*/
|
|
4636
5077
|
|
|
4637
5078
|
/**
|
|
@@ -7878,7 +8319,7 @@ class ArchitectApi {
|
|
|
7878
8319
|
|
|
7879
8320
|
/**
|
|
7880
8321
|
* Create a new row entry for the datatable.
|
|
7881
|
-
* 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" }
|
|
7882
8323
|
* @param {String} datatableId id of datatable
|
|
7883
8324
|
* @param {Object.<String, {String: Object}>} dataTableRow
|
|
7884
8325
|
*/
|
|
@@ -8370,7 +8811,7 @@ class ArchitectApi {
|
|
|
8370
8811
|
|
|
8371
8812
|
/**
|
|
8372
8813
|
* Update a row entry
|
|
8373
|
-
* 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" }
|
|
8374
8815
|
* @param {String} datatableId id of datatable
|
|
8375
8816
|
* @param {String} rowId the key for the row
|
|
8376
8817
|
* @param {Object} opts Optional parameters
|
|
@@ -8466,7 +8907,7 @@ class AuditApi {
|
|
|
8466
8907
|
/**
|
|
8467
8908
|
* Audit service.
|
|
8468
8909
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8469
|
-
* @version
|
|
8910
|
+
* @version 185.0.0
|
|
8470
8911
|
*/
|
|
8471
8912
|
|
|
8472
8913
|
/**
|
|
@@ -8637,7 +9078,7 @@ class AuthorizationApi {
|
|
|
8637
9078
|
/**
|
|
8638
9079
|
* Authorization service.
|
|
8639
9080
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8640
|
-
* @version
|
|
9081
|
+
* @version 185.0.0
|
|
8641
9082
|
*/
|
|
8642
9083
|
|
|
8643
9084
|
/**
|
|
@@ -9020,7 +9461,7 @@ class AuthorizationApi {
|
|
|
9020
9461
|
* Get the organization role specified by its ID.
|
|
9021
9462
|
* @param {String} roleId Role ID
|
|
9022
9463
|
* @param {Object} opts Optional parameters
|
|
9023
|
-
* @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division (default to true)
|
|
9464
|
+
* @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division. Setting this value or defaulting to 'true' can lead to slower load times or timeouts for role queries with large member counts. (default to true)
|
|
9024
9465
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand. unusedPermissions returns the permissions not used for the role
|
|
9025
9466
|
*/
|
|
9026
9467
|
getAuthorizationRole(roleId, opts) {
|
|
@@ -9381,17 +9822,16 @@ class AuthorizationApi {
|
|
|
9381
9822
|
* Recreate a previously deleted division.
|
|
9382
9823
|
*
|
|
9383
9824
|
* @param {String} divisionId Division ID
|
|
9384
|
-
* @param {Object}
|
|
9825
|
+
* @param {Object} opts Optional parameters
|
|
9826
|
+
* @param {Object} opts.body Recreated division data
|
|
9385
9827
|
*/
|
|
9386
|
-
postAuthorizationDivisionRestore(divisionId,
|
|
9828
|
+
postAuthorizationDivisionRestore(divisionId, opts) {
|
|
9829
|
+
opts = opts || {};
|
|
9830
|
+
|
|
9387
9831
|
// verify the required parameter 'divisionId' is set
|
|
9388
9832
|
if (divisionId === undefined || divisionId === null) {
|
|
9389
9833
|
throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
|
|
9390
9834
|
}
|
|
9391
|
-
// verify the required parameter 'body' is set
|
|
9392
|
-
if (body === undefined || body === null) {
|
|
9393
|
-
throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
|
|
9394
|
-
}
|
|
9395
9835
|
|
|
9396
9836
|
return this.apiClient.callApi(
|
|
9397
9837
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
@@ -9400,7 +9840,7 @@ class AuthorizationApi {
|
|
|
9400
9840
|
{ },
|
|
9401
9841
|
{ },
|
|
9402
9842
|
{ },
|
|
9403
|
-
body,
|
|
9843
|
+
opts['body'],
|
|
9404
9844
|
['PureCloud OAuth'],
|
|
9405
9845
|
['application/json'],
|
|
9406
9846
|
['application/json']
|
|
@@ -9868,7 +10308,7 @@ class BillingApi {
|
|
|
9868
10308
|
/**
|
|
9869
10309
|
* Billing service.
|
|
9870
10310
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9871
|
-
* @version
|
|
10311
|
+
* @version 185.0.0
|
|
9872
10312
|
*/
|
|
9873
10313
|
|
|
9874
10314
|
/**
|
|
@@ -9948,7 +10388,7 @@ class CarrierServicesApi {
|
|
|
9948
10388
|
/**
|
|
9949
10389
|
* CarrierServices service.
|
|
9950
10390
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9951
|
-
* @version
|
|
10391
|
+
* @version 185.0.0
|
|
9952
10392
|
*/
|
|
9953
10393
|
|
|
9954
10394
|
/**
|
|
@@ -10018,7 +10458,7 @@ class ChatApi {
|
|
|
10018
10458
|
/**
|
|
10019
10459
|
* Chat service.
|
|
10020
10460
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10021
|
-
* @version
|
|
10461
|
+
* @version 185.0.0
|
|
10022
10462
|
*/
|
|
10023
10463
|
|
|
10024
10464
|
/**
|
|
@@ -10714,7 +11154,7 @@ class CoachingApi {
|
|
|
10714
11154
|
/**
|
|
10715
11155
|
* Coaching service.
|
|
10716
11156
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
10717
|
-
* @version
|
|
11157
|
+
* @version 185.0.0
|
|
10718
11158
|
*/
|
|
10719
11159
|
|
|
10720
11160
|
/**
|
|
@@ -11291,7 +11731,7 @@ class ContentManagementApi {
|
|
|
11291
11731
|
/**
|
|
11292
11732
|
* ContentManagement service.
|
|
11293
11733
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11294
|
-
* @version
|
|
11734
|
+
* @version 185.0.0
|
|
11295
11735
|
*/
|
|
11296
11736
|
|
|
11297
11737
|
/**
|
|
@@ -12434,7 +12874,7 @@ class ConversationsApi {
|
|
|
12434
12874
|
/**
|
|
12435
12875
|
* Conversations service.
|
|
12436
12876
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12437
|
-
* @version
|
|
12877
|
+
* @version 185.0.0
|
|
12438
12878
|
*/
|
|
12439
12879
|
|
|
12440
12880
|
/**
|
|
@@ -19574,7 +20014,7 @@ class DataExtensionsApi {
|
|
|
19574
20014
|
/**
|
|
19575
20015
|
* DataExtensions service.
|
|
19576
20016
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
19577
|
-
* @version
|
|
20017
|
+
* @version 185.0.0
|
|
19578
20018
|
*/
|
|
19579
20019
|
|
|
19580
20020
|
/**
|
|
@@ -19660,7 +20100,7 @@ class DownloadsApi {
|
|
|
19660
20100
|
/**
|
|
19661
20101
|
* Downloads service.
|
|
19662
20102
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
19663
|
-
* @version
|
|
20103
|
+
* @version 185.0.0
|
|
19664
20104
|
*/
|
|
19665
20105
|
|
|
19666
20106
|
/**
|
|
@@ -19712,7 +20152,7 @@ class EmailsApi {
|
|
|
19712
20152
|
/**
|
|
19713
20153
|
* Emails service.
|
|
19714
20154
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
19715
|
-
* @version
|
|
20155
|
+
* @version 185.0.0
|
|
19716
20156
|
*/
|
|
19717
20157
|
|
|
19718
20158
|
/**
|
|
@@ -19777,7 +20217,7 @@ class EventsApi {
|
|
|
19777
20217
|
/**
|
|
19778
20218
|
* Events service.
|
|
19779
20219
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
19780
|
-
* @version
|
|
20220
|
+
* @version 185.0.0
|
|
19781
20221
|
*/
|
|
19782
20222
|
|
|
19783
20223
|
/**
|
|
@@ -19873,7 +20313,7 @@ class ExternalContactsApi {
|
|
|
19873
20313
|
/**
|
|
19874
20314
|
* ExternalContacts service.
|
|
19875
20315
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
19876
|
-
* @version
|
|
20316
|
+
* @version 185.0.0
|
|
19877
20317
|
*/
|
|
19878
20318
|
|
|
19879
20319
|
/**
|
|
@@ -21831,7 +22271,7 @@ class FaxApi {
|
|
|
21831
22271
|
/**
|
|
21832
22272
|
* Fax service.
|
|
21833
22273
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
21834
|
-
* @version
|
|
22274
|
+
* @version 185.0.0
|
|
21835
22275
|
*/
|
|
21836
22276
|
|
|
21837
22277
|
/**
|
|
@@ -22002,7 +22442,7 @@ class FlowsApi {
|
|
|
22002
22442
|
/**
|
|
22003
22443
|
* Flows service.
|
|
22004
22444
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22005
|
-
* @version
|
|
22445
|
+
* @version 185.0.0
|
|
22006
22446
|
*/
|
|
22007
22447
|
|
|
22008
22448
|
/**
|
|
@@ -22186,7 +22626,7 @@ class GamificationApi {
|
|
|
22186
22626
|
/**
|
|
22187
22627
|
* Gamification service.
|
|
22188
22628
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22189
|
-
* @version
|
|
22629
|
+
* @version 185.0.0
|
|
22190
22630
|
*/
|
|
22191
22631
|
|
|
22192
22632
|
/**
|
|
@@ -24272,7 +24712,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
24272
24712
|
/**
|
|
24273
24713
|
* GeneralDataProtectionRegulation service.
|
|
24274
24714
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24275
|
-
* @version
|
|
24715
|
+
* @version 185.0.0
|
|
24276
24716
|
*/
|
|
24277
24717
|
|
|
24278
24718
|
/**
|
|
@@ -24402,7 +24842,7 @@ class GeolocationApi {
|
|
|
24402
24842
|
/**
|
|
24403
24843
|
* Geolocation service.
|
|
24404
24844
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24405
|
-
* @version
|
|
24845
|
+
* @version 185.0.0
|
|
24406
24846
|
*/
|
|
24407
24847
|
|
|
24408
24848
|
/**
|
|
@@ -24533,7 +24973,7 @@ class GreetingsApi {
|
|
|
24533
24973
|
/**
|
|
24534
24974
|
* Greetings service.
|
|
24535
24975
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24536
|
-
* @version
|
|
24976
|
+
* @version 185.0.0
|
|
24537
24977
|
*/
|
|
24538
24978
|
|
|
24539
24979
|
/**
|
|
@@ -24988,7 +25428,7 @@ class GroupsApi {
|
|
|
24988
25428
|
/**
|
|
24989
25429
|
* Groups service.
|
|
24990
25430
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
24991
|
-
* @version
|
|
25431
|
+
* @version 185.0.0
|
|
24992
25432
|
*/
|
|
24993
25433
|
|
|
24994
25434
|
/**
|
|
@@ -25507,7 +25947,7 @@ class IdentityProviderApi {
|
|
|
25507
25947
|
/**
|
|
25508
25948
|
* IdentityProvider service.
|
|
25509
25949
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25510
|
-
* @version
|
|
25950
|
+
* @version 185.0.0
|
|
25511
25951
|
*/
|
|
25512
25952
|
|
|
25513
25953
|
/**
|
|
@@ -26263,7 +26703,7 @@ class InfrastructureAsCodeApi {
|
|
|
26263
26703
|
/**
|
|
26264
26704
|
* InfrastructureAsCode service.
|
|
26265
26705
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
26266
|
-
* @version
|
|
26706
|
+
* @version 185.0.0
|
|
26267
26707
|
*/
|
|
26268
26708
|
|
|
26269
26709
|
/**
|
|
@@ -26430,7 +26870,7 @@ class IntegrationsApi {
|
|
|
26430
26870
|
/**
|
|
26431
26871
|
* Integrations service.
|
|
26432
26872
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26433
|
-
* @version
|
|
26873
|
+
* @version 185.0.0
|
|
26434
26874
|
*/
|
|
26435
26875
|
|
|
26436
26876
|
/**
|
|
@@ -28392,7 +28832,7 @@ class JourneyApi {
|
|
|
28392
28832
|
/**
|
|
28393
28833
|
* Journey service.
|
|
28394
28834
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28395
|
-
* @version
|
|
28835
|
+
* @version 185.0.0
|
|
28396
28836
|
*/
|
|
28397
28837
|
|
|
28398
28838
|
/**
|
|
@@ -29623,7 +30063,7 @@ class KnowledgeApi {
|
|
|
29623
30063
|
/**
|
|
29624
30064
|
* Knowledge service.
|
|
29625
30065
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
29626
|
-
* @version
|
|
30066
|
+
* @version 185.0.0
|
|
29627
30067
|
*/
|
|
29628
30068
|
|
|
29629
30069
|
/**
|
|
@@ -32444,7 +32884,7 @@ class LanguageUnderstandingApi {
|
|
|
32444
32884
|
/**
|
|
32445
32885
|
* LanguageUnderstanding service.
|
|
32446
32886
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32447
|
-
* @version
|
|
32887
|
+
* @version 185.0.0
|
|
32448
32888
|
*/
|
|
32449
32889
|
|
|
32450
32890
|
/**
|
|
@@ -33457,7 +33897,7 @@ class LanguagesApi {
|
|
|
33457
33897
|
/**
|
|
33458
33898
|
* Languages service.
|
|
33459
33899
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33460
|
-
* @version
|
|
33900
|
+
* @version 185.0.0
|
|
33461
33901
|
*/
|
|
33462
33902
|
|
|
33463
33903
|
/**
|
|
@@ -33679,7 +34119,7 @@ class LearningApi {
|
|
|
33679
34119
|
/**
|
|
33680
34120
|
* Learning service.
|
|
33681
34121
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33682
|
-
* @version
|
|
34122
|
+
* @version 185.0.0
|
|
33683
34123
|
*/
|
|
33684
34124
|
|
|
33685
34125
|
/**
|
|
@@ -34535,7 +34975,7 @@ class LicenseApi {
|
|
|
34535
34975
|
/**
|
|
34536
34976
|
* License service.
|
|
34537
34977
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34538
|
-
* @version
|
|
34978
|
+
* @version 185.0.0
|
|
34539
34979
|
*/
|
|
34540
34980
|
|
|
34541
34981
|
/**
|
|
@@ -34773,7 +35213,7 @@ class LocationsApi {
|
|
|
34773
35213
|
/**
|
|
34774
35214
|
* Locations service.
|
|
34775
35215
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34776
|
-
* @version
|
|
35216
|
+
* @version 185.0.0
|
|
34777
35217
|
*/
|
|
34778
35218
|
|
|
34779
35219
|
/**
|
|
@@ -35005,11 +35445,81 @@ class LocationsApi {
|
|
|
35005
35445
|
|
|
35006
35446
|
}
|
|
35007
35447
|
|
|
35448
|
+
class LogCaptureApi {
|
|
35449
|
+
/**
|
|
35450
|
+
* LogCapture service.
|
|
35451
|
+
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
35452
|
+
* @version 185.0.0
|
|
35453
|
+
*/
|
|
35454
|
+
|
|
35455
|
+
/**
|
|
35456
|
+
* Constructs a new LogCaptureApi.
|
|
35457
|
+
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
35458
|
+
* @class
|
|
35459
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
35460
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
35461
|
+
*/
|
|
35462
|
+
constructor(apiClient) {
|
|
35463
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
35464
|
+
}
|
|
35465
|
+
|
|
35466
|
+
|
|
35467
|
+
/**
|
|
35468
|
+
* Gets status of async download execution
|
|
35469
|
+
*
|
|
35470
|
+
* @param {String} jobId Job ID
|
|
35471
|
+
*/
|
|
35472
|
+
getDiagnosticsLogcaptureBrowserEntriesDownloadJob(jobId) {
|
|
35473
|
+
// verify the required parameter 'jobId' is set
|
|
35474
|
+
if (jobId === undefined || jobId === null) {
|
|
35475
|
+
throw 'Missing the required parameter "jobId" when calling getDiagnosticsLogcaptureBrowserEntriesDownloadJob';
|
|
35476
|
+
}
|
|
35477
|
+
|
|
35478
|
+
return this.apiClient.callApi(
|
|
35479
|
+
'/api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId}',
|
|
35480
|
+
'GET',
|
|
35481
|
+
{ 'jobId': jobId },
|
|
35482
|
+
{ },
|
|
35483
|
+
{ },
|
|
35484
|
+
{ },
|
|
35485
|
+
null,
|
|
35486
|
+
['PureCloud OAuth'],
|
|
35487
|
+
['application/json'],
|
|
35488
|
+
['application/json']
|
|
35489
|
+
);
|
|
35490
|
+
}
|
|
35491
|
+
|
|
35492
|
+
/**
|
|
35493
|
+
* Creates an async download execution
|
|
35494
|
+
*
|
|
35495
|
+
* @param {Object} opts Optional parameters
|
|
35496
|
+
* @param {Object} opts.body
|
|
35497
|
+
*/
|
|
35498
|
+
postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(opts) {
|
|
35499
|
+
opts = opts || {};
|
|
35500
|
+
|
|
35501
|
+
|
|
35502
|
+
return this.apiClient.callApi(
|
|
35503
|
+
'/api/v2/diagnostics/logcapture/browser/entries/download/jobs',
|
|
35504
|
+
'POST',
|
|
35505
|
+
{ },
|
|
35506
|
+
{ },
|
|
35507
|
+
{ },
|
|
35508
|
+
{ },
|
|
35509
|
+
opts['body'],
|
|
35510
|
+
['PureCloud OAuth'],
|
|
35511
|
+
['application/json'],
|
|
35512
|
+
['application/json']
|
|
35513
|
+
);
|
|
35514
|
+
}
|
|
35515
|
+
|
|
35516
|
+
}
|
|
35517
|
+
|
|
35008
35518
|
class MessagingApi {
|
|
35009
35519
|
/**
|
|
35010
35520
|
* Messaging service.
|
|
35011
35521
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
35012
|
-
* @version
|
|
35522
|
+
* @version 185.0.0
|
|
35013
35523
|
*/
|
|
35014
35524
|
|
|
35015
35525
|
/**
|
|
@@ -35368,7 +35878,7 @@ class MobileDevicesApi {
|
|
|
35368
35878
|
/**
|
|
35369
35879
|
* MobileDevices service.
|
|
35370
35880
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
35371
|
-
* @version
|
|
35881
|
+
* @version 185.0.0
|
|
35372
35882
|
*/
|
|
35373
35883
|
|
|
35374
35884
|
/**
|
|
@@ -35519,7 +36029,7 @@ class NotificationsApi {
|
|
|
35519
36029
|
/**
|
|
35520
36030
|
* Notifications service.
|
|
35521
36031
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
35522
|
-
* @version
|
|
36032
|
+
* @version 185.0.0
|
|
35523
36033
|
*/
|
|
35524
36034
|
|
|
35525
36035
|
/**
|
|
@@ -35752,7 +36262,7 @@ class OAuthApi {
|
|
|
35752
36262
|
/**
|
|
35753
36263
|
* OAuth service.
|
|
35754
36264
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
35755
|
-
* @version
|
|
36265
|
+
* @version 185.0.0
|
|
35756
36266
|
*/
|
|
35757
36267
|
|
|
35758
36268
|
/**
|
|
@@ -36118,7 +36628,7 @@ class ObjectsApi {
|
|
|
36118
36628
|
/**
|
|
36119
36629
|
* Objects service.
|
|
36120
36630
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
36121
|
-
* @version
|
|
36631
|
+
* @version 185.0.0
|
|
36122
36632
|
*/
|
|
36123
36633
|
|
|
36124
36634
|
/**
|
|
@@ -36302,17 +36812,16 @@ class ObjectsApi {
|
|
|
36302
36812
|
* Recreate a previously deleted division.
|
|
36303
36813
|
*
|
|
36304
36814
|
* @param {String} divisionId Division ID
|
|
36305
|
-
* @param {Object}
|
|
36815
|
+
* @param {Object} opts Optional parameters
|
|
36816
|
+
* @param {Object} opts.body Recreated division data
|
|
36306
36817
|
*/
|
|
36307
|
-
postAuthorizationDivisionRestore(divisionId,
|
|
36818
|
+
postAuthorizationDivisionRestore(divisionId, opts) {
|
|
36819
|
+
opts = opts || {};
|
|
36820
|
+
|
|
36308
36821
|
// verify the required parameter 'divisionId' is set
|
|
36309
36822
|
if (divisionId === undefined || divisionId === null) {
|
|
36310
36823
|
throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
|
|
36311
36824
|
}
|
|
36312
|
-
// verify the required parameter 'body' is set
|
|
36313
|
-
if (body === undefined || body === null) {
|
|
36314
|
-
throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
|
|
36315
|
-
}
|
|
36316
36825
|
|
|
36317
36826
|
return this.apiClient.callApi(
|
|
36318
36827
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
@@ -36321,7 +36830,7 @@ class ObjectsApi {
|
|
|
36321
36830
|
{ },
|
|
36322
36831
|
{ },
|
|
36323
36832
|
{ },
|
|
36324
|
-
body,
|
|
36833
|
+
opts['body'],
|
|
36325
36834
|
['PureCloud OAuth'],
|
|
36326
36835
|
['application/json'],
|
|
36327
36836
|
['application/json']
|
|
@@ -36389,7 +36898,7 @@ class OperationalEventsApi {
|
|
|
36389
36898
|
/**
|
|
36390
36899
|
* OperationalEvents service.
|
|
36391
36900
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
36392
|
-
* @version
|
|
36901
|
+
* @version 185.0.0
|
|
36393
36902
|
*/
|
|
36394
36903
|
|
|
36395
36904
|
/**
|
|
@@ -36455,7 +36964,7 @@ class OrganizationApi {
|
|
|
36455
36964
|
/**
|
|
36456
36965
|
* Organization service.
|
|
36457
36966
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
36458
|
-
* @version
|
|
36967
|
+
* @version 185.0.0
|
|
36459
36968
|
*/
|
|
36460
36969
|
|
|
36461
36970
|
/**
|
|
@@ -36910,7 +37419,7 @@ class OrganizationAuthorizationApi {
|
|
|
36910
37419
|
/**
|
|
36911
37420
|
* OrganizationAuthorization service.
|
|
36912
37421
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
36913
|
-
* @version
|
|
37422
|
+
* @version 185.0.0
|
|
36914
37423
|
*/
|
|
36915
37424
|
|
|
36916
37425
|
/**
|
|
@@ -38257,7 +38766,7 @@ class OutboundApi {
|
|
|
38257
38766
|
/**
|
|
38258
38767
|
* Outbound service.
|
|
38259
38768
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38260
|
-
* @version
|
|
38769
|
+
* @version 185.0.0
|
|
38261
38770
|
*/
|
|
38262
38771
|
|
|
38263
38772
|
/**
|
|
@@ -38557,6 +39066,56 @@ class OutboundApi {
|
|
|
38557
39066
|
);
|
|
38558
39067
|
}
|
|
38559
39068
|
|
|
39069
|
+
/**
|
|
39070
|
+
* Delete Contact List Template
|
|
39071
|
+
*
|
|
39072
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
39073
|
+
*/
|
|
39074
|
+
deleteOutboundContactlisttemplate(contactListTemplateId) {
|
|
39075
|
+
// verify the required parameter 'contactListTemplateId' is set
|
|
39076
|
+
if (contactListTemplateId === undefined || contactListTemplateId === null) {
|
|
39077
|
+
throw 'Missing the required parameter "contactListTemplateId" when calling deleteOutboundContactlisttemplate';
|
|
39078
|
+
}
|
|
39079
|
+
|
|
39080
|
+
return this.apiClient.callApi(
|
|
39081
|
+
'/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
|
|
39082
|
+
'DELETE',
|
|
39083
|
+
{ 'contactListTemplateId': contactListTemplateId },
|
|
39084
|
+
{ },
|
|
39085
|
+
{ },
|
|
39086
|
+
{ },
|
|
39087
|
+
null,
|
|
39088
|
+
['PureCloud OAuth'],
|
|
39089
|
+
['application/json'],
|
|
39090
|
+
['application/json']
|
|
39091
|
+
);
|
|
39092
|
+
}
|
|
39093
|
+
|
|
39094
|
+
/**
|
|
39095
|
+
* Delete multiple contact list templates.
|
|
39096
|
+
*
|
|
39097
|
+
* @param {Array.<String>} id contact list template id(s) to delete
|
|
39098
|
+
*/
|
|
39099
|
+
deleteOutboundContactlisttemplates(id) {
|
|
39100
|
+
// verify the required parameter 'id' is set
|
|
39101
|
+
if (id === undefined || id === null) {
|
|
39102
|
+
throw 'Missing the required parameter "id" when calling deleteOutboundContactlisttemplates';
|
|
39103
|
+
}
|
|
39104
|
+
|
|
39105
|
+
return this.apiClient.callApi(
|
|
39106
|
+
'/api/v2/outbound/contactlisttemplates',
|
|
39107
|
+
'DELETE',
|
|
39108
|
+
{ },
|
|
39109
|
+
{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
|
|
39110
|
+
{ },
|
|
39111
|
+
{ },
|
|
39112
|
+
null,
|
|
39113
|
+
['PureCloud OAuth'],
|
|
39114
|
+
['application/json'],
|
|
39115
|
+
['application/json']
|
|
39116
|
+
);
|
|
39117
|
+
}
|
|
39118
|
+
|
|
38560
39119
|
/**
|
|
38561
39120
|
* Delete an Outbound Digital Rule Set
|
|
38562
39121
|
*
|
|
@@ -38694,6 +39253,56 @@ class OutboundApi {
|
|
|
38694
39253
|
);
|
|
38695
39254
|
}
|
|
38696
39255
|
|
|
39256
|
+
/**
|
|
39257
|
+
* Delete Import Template
|
|
39258
|
+
*
|
|
39259
|
+
* @param {String} importTemplateId Import Template ID
|
|
39260
|
+
*/
|
|
39261
|
+
deleteOutboundImporttemplate(importTemplateId) {
|
|
39262
|
+
// verify the required parameter 'importTemplateId' is set
|
|
39263
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
39264
|
+
throw 'Missing the required parameter "importTemplateId" when calling deleteOutboundImporttemplate';
|
|
39265
|
+
}
|
|
39266
|
+
|
|
39267
|
+
return this.apiClient.callApi(
|
|
39268
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}',
|
|
39269
|
+
'DELETE',
|
|
39270
|
+
{ 'importTemplateId': importTemplateId },
|
|
39271
|
+
{ },
|
|
39272
|
+
{ },
|
|
39273
|
+
{ },
|
|
39274
|
+
null,
|
|
39275
|
+
['PureCloud OAuth'],
|
|
39276
|
+
['application/json'],
|
|
39277
|
+
['application/json']
|
|
39278
|
+
);
|
|
39279
|
+
}
|
|
39280
|
+
|
|
39281
|
+
/**
|
|
39282
|
+
* Delete multiple import templates.
|
|
39283
|
+
*
|
|
39284
|
+
* @param {Array.<String>} id import template id(s) to delete
|
|
39285
|
+
*/
|
|
39286
|
+
deleteOutboundImporttemplates(id) {
|
|
39287
|
+
// verify the required parameter 'id' is set
|
|
39288
|
+
if (id === undefined || id === null) {
|
|
39289
|
+
throw 'Missing the required parameter "id" when calling deleteOutboundImporttemplates';
|
|
39290
|
+
}
|
|
39291
|
+
|
|
39292
|
+
return this.apiClient.callApi(
|
|
39293
|
+
'/api/v2/outbound/importtemplates',
|
|
39294
|
+
'DELETE',
|
|
39295
|
+
{ },
|
|
39296
|
+
{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
|
|
39297
|
+
{ },
|
|
39298
|
+
{ },
|
|
39299
|
+
null,
|
|
39300
|
+
['PureCloud OAuth'],
|
|
39301
|
+
['application/json'],
|
|
39302
|
+
['application/json']
|
|
39303
|
+
);
|
|
39304
|
+
}
|
|
39305
|
+
|
|
38697
39306
|
/**
|
|
38698
39307
|
* Delete an Outbound Messaging Campaign
|
|
38699
39308
|
*
|
|
@@ -39706,6 +40315,61 @@ class OutboundApi {
|
|
|
39706
40315
|
);
|
|
39707
40316
|
}
|
|
39708
40317
|
|
|
40318
|
+
/**
|
|
40319
|
+
* Get Contact List Template
|
|
40320
|
+
*
|
|
40321
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
40322
|
+
*/
|
|
40323
|
+
getOutboundContactlisttemplate(contactListTemplateId) {
|
|
40324
|
+
// verify the required parameter 'contactListTemplateId' is set
|
|
40325
|
+
if (contactListTemplateId === undefined || contactListTemplateId === null) {
|
|
40326
|
+
throw 'Missing the required parameter "contactListTemplateId" when calling getOutboundContactlisttemplate';
|
|
40327
|
+
}
|
|
40328
|
+
|
|
40329
|
+
return this.apiClient.callApi(
|
|
40330
|
+
'/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
|
|
40331
|
+
'GET',
|
|
40332
|
+
{ 'contactListTemplateId': contactListTemplateId },
|
|
40333
|
+
{ },
|
|
40334
|
+
{ },
|
|
40335
|
+
{ },
|
|
40336
|
+
null,
|
|
40337
|
+
['PureCloud OAuth'],
|
|
40338
|
+
['application/json'],
|
|
40339
|
+
['application/json']
|
|
40340
|
+
);
|
|
40341
|
+
}
|
|
40342
|
+
|
|
40343
|
+
/**
|
|
40344
|
+
* Query a list of contact list templates
|
|
40345
|
+
*
|
|
40346
|
+
* @param {Object} opts Optional parameters
|
|
40347
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
40348
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40349
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
40350
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
40351
|
+
* @param {String} opts.name Name
|
|
40352
|
+
* @param {String} opts.sortBy Sort by
|
|
40353
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
40354
|
+
*/
|
|
40355
|
+
getOutboundContactlisttemplates(opts) {
|
|
40356
|
+
opts = opts || {};
|
|
40357
|
+
|
|
40358
|
+
|
|
40359
|
+
return this.apiClient.callApi(
|
|
40360
|
+
'/api/v2/outbound/contactlisttemplates',
|
|
40361
|
+
'GET',
|
|
40362
|
+
{ },
|
|
40363
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
40364
|
+
{ },
|
|
40365
|
+
{ },
|
|
40366
|
+
null,
|
|
40367
|
+
['PureCloud OAuth'],
|
|
40368
|
+
['application/json'],
|
|
40369
|
+
['application/json']
|
|
40370
|
+
);
|
|
40371
|
+
}
|
|
40372
|
+
|
|
39709
40373
|
/**
|
|
39710
40374
|
* Get an Outbound Digital Rule Set
|
|
39711
40375
|
*
|
|
@@ -39996,6 +40660,91 @@ class OutboundApi {
|
|
|
39996
40660
|
);
|
|
39997
40661
|
}
|
|
39998
40662
|
|
|
40663
|
+
/**
|
|
40664
|
+
* Get Import Template
|
|
40665
|
+
*
|
|
40666
|
+
* @param {String} importTemplateId Import Template ID
|
|
40667
|
+
*/
|
|
40668
|
+
getOutboundImporttemplate(importTemplateId) {
|
|
40669
|
+
// verify the required parameter 'importTemplateId' is set
|
|
40670
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
40671
|
+
throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplate';
|
|
40672
|
+
}
|
|
40673
|
+
|
|
40674
|
+
return this.apiClient.callApi(
|
|
40675
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}',
|
|
40676
|
+
'GET',
|
|
40677
|
+
{ 'importTemplateId': importTemplateId },
|
|
40678
|
+
{ },
|
|
40679
|
+
{ },
|
|
40680
|
+
{ },
|
|
40681
|
+
null,
|
|
40682
|
+
['PureCloud OAuth'],
|
|
40683
|
+
['application/json'],
|
|
40684
|
+
['application/json']
|
|
40685
|
+
);
|
|
40686
|
+
}
|
|
40687
|
+
|
|
40688
|
+
/**
|
|
40689
|
+
* Get the import status for an import template.
|
|
40690
|
+
*
|
|
40691
|
+
* @param {String} importTemplateId importTemplateId
|
|
40692
|
+
* @param {Object} opts Optional parameters
|
|
40693
|
+
* @param {String} opts.listNamePrefix listNamePrefix
|
|
40694
|
+
*/
|
|
40695
|
+
getOutboundImporttemplateImportstatus(importTemplateId, opts) {
|
|
40696
|
+
opts = opts || {};
|
|
40697
|
+
|
|
40698
|
+
// verify the required parameter 'importTemplateId' is set
|
|
40699
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
40700
|
+
throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplateImportstatus';
|
|
40701
|
+
}
|
|
40702
|
+
|
|
40703
|
+
return this.apiClient.callApi(
|
|
40704
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}/importstatus',
|
|
40705
|
+
'GET',
|
|
40706
|
+
{ 'importTemplateId': importTemplateId },
|
|
40707
|
+
{ 'listNamePrefix': opts['listNamePrefix'] },
|
|
40708
|
+
{ },
|
|
40709
|
+
{ },
|
|
40710
|
+
null,
|
|
40711
|
+
['PureCloud OAuth'],
|
|
40712
|
+
['application/json'],
|
|
40713
|
+
['application/json']
|
|
40714
|
+
);
|
|
40715
|
+
}
|
|
40716
|
+
|
|
40717
|
+
/**
|
|
40718
|
+
* Query Import Templates
|
|
40719
|
+
*
|
|
40720
|
+
* @param {Object} opts Optional parameters
|
|
40721
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
40722
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40723
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
40724
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
40725
|
+
* @param {String} opts.name Name
|
|
40726
|
+
* @param {String} opts.sortBy Sort by
|
|
40727
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
40728
|
+
* @param {String} opts.contactListTemplateId Contact List Template ID
|
|
40729
|
+
*/
|
|
40730
|
+
getOutboundImporttemplates(opts) {
|
|
40731
|
+
opts = opts || {};
|
|
40732
|
+
|
|
40733
|
+
|
|
40734
|
+
return this.apiClient.callApi(
|
|
40735
|
+
'/api/v2/outbound/importtemplates',
|
|
40736
|
+
'GET',
|
|
40737
|
+
{ },
|
|
40738
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'contactListTemplateId': opts['contactListTemplateId'] },
|
|
40739
|
+
{ },
|
|
40740
|
+
{ },
|
|
40741
|
+
null,
|
|
40742
|
+
['PureCloud OAuth'],
|
|
40743
|
+
['application/json'],
|
|
40744
|
+
['application/json']
|
|
40745
|
+
);
|
|
40746
|
+
}
|
|
40747
|
+
|
|
39999
40748
|
/**
|
|
40000
40749
|
* Get an Outbound Messaging Campaign
|
|
40001
40750
|
*
|
|
@@ -41034,6 +41783,56 @@ class OutboundApi {
|
|
|
41034
41783
|
);
|
|
41035
41784
|
}
|
|
41036
41785
|
|
|
41786
|
+
/**
|
|
41787
|
+
* Create Contact List Template
|
|
41788
|
+
*
|
|
41789
|
+
* @param {Object} body ContactListTemplate
|
|
41790
|
+
*/
|
|
41791
|
+
postOutboundContactlisttemplates(body) {
|
|
41792
|
+
// verify the required parameter 'body' is set
|
|
41793
|
+
if (body === undefined || body === null) {
|
|
41794
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplates';
|
|
41795
|
+
}
|
|
41796
|
+
|
|
41797
|
+
return this.apiClient.callApi(
|
|
41798
|
+
'/api/v2/outbound/contactlisttemplates',
|
|
41799
|
+
'POST',
|
|
41800
|
+
{ },
|
|
41801
|
+
{ },
|
|
41802
|
+
{ },
|
|
41803
|
+
{ },
|
|
41804
|
+
body,
|
|
41805
|
+
['PureCloud OAuth'],
|
|
41806
|
+
['application/json'],
|
|
41807
|
+
['application/json']
|
|
41808
|
+
);
|
|
41809
|
+
}
|
|
41810
|
+
|
|
41811
|
+
/**
|
|
41812
|
+
* Add multiple contact list templates
|
|
41813
|
+
*
|
|
41814
|
+
* @param {Array.<Object>} body contact list template(s) to add
|
|
41815
|
+
*/
|
|
41816
|
+
postOutboundContactlisttemplatesBulkAdd(body) {
|
|
41817
|
+
// verify the required parameter 'body' is set
|
|
41818
|
+
if (body === undefined || body === null) {
|
|
41819
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkAdd';
|
|
41820
|
+
}
|
|
41821
|
+
|
|
41822
|
+
return this.apiClient.callApi(
|
|
41823
|
+
'/api/v2/outbound/contactlisttemplates/bulk/add',
|
|
41824
|
+
'POST',
|
|
41825
|
+
{ },
|
|
41826
|
+
{ },
|
|
41827
|
+
{ },
|
|
41828
|
+
{ },
|
|
41829
|
+
body,
|
|
41830
|
+
['PureCloud OAuth'],
|
|
41831
|
+
['application/json'],
|
|
41832
|
+
['application/json']
|
|
41833
|
+
);
|
|
41834
|
+
}
|
|
41835
|
+
|
|
41037
41836
|
/**
|
|
41038
41837
|
* Add phone numbers to a Dialer DNC list.
|
|
41039
41838
|
*
|
|
@@ -41198,6 +41997,56 @@ class OutboundApi {
|
|
|
41198
41997
|
);
|
|
41199
41998
|
}
|
|
41200
41999
|
|
|
42000
|
+
/**
|
|
42001
|
+
* Create Import Template
|
|
42002
|
+
*
|
|
42003
|
+
* @param {Object} body ImportTemplate
|
|
42004
|
+
*/
|
|
42005
|
+
postOutboundImporttemplates(body) {
|
|
42006
|
+
// verify the required parameter 'body' is set
|
|
42007
|
+
if (body === undefined || body === null) {
|
|
42008
|
+
throw 'Missing the required parameter "body" when calling postOutboundImporttemplates';
|
|
42009
|
+
}
|
|
42010
|
+
|
|
42011
|
+
return this.apiClient.callApi(
|
|
42012
|
+
'/api/v2/outbound/importtemplates',
|
|
42013
|
+
'POST',
|
|
42014
|
+
{ },
|
|
42015
|
+
{ },
|
|
42016
|
+
{ },
|
|
42017
|
+
{ },
|
|
42018
|
+
body,
|
|
42019
|
+
['PureCloud OAuth'],
|
|
42020
|
+
['application/json'],
|
|
42021
|
+
['application/json']
|
|
42022
|
+
);
|
|
42023
|
+
}
|
|
42024
|
+
|
|
42025
|
+
/**
|
|
42026
|
+
* Add multiple import templates
|
|
42027
|
+
*
|
|
42028
|
+
* @param {Array.<Object>} body import template(s) to add
|
|
42029
|
+
*/
|
|
42030
|
+
postOutboundImporttemplatesBulkAdd(body) {
|
|
42031
|
+
// verify the required parameter 'body' is set
|
|
42032
|
+
if (body === undefined || body === null) {
|
|
42033
|
+
throw 'Missing the required parameter "body" when calling postOutboundImporttemplatesBulkAdd';
|
|
42034
|
+
}
|
|
42035
|
+
|
|
42036
|
+
return this.apiClient.callApi(
|
|
42037
|
+
'/api/v2/outbound/importtemplates/bulk/add',
|
|
42038
|
+
'POST',
|
|
42039
|
+
{ },
|
|
42040
|
+
{ },
|
|
42041
|
+
{ },
|
|
42042
|
+
{ },
|
|
42043
|
+
body,
|
|
42044
|
+
['PureCloud OAuth'],
|
|
42045
|
+
['application/json'],
|
|
42046
|
+
['application/json']
|
|
42047
|
+
);
|
|
42048
|
+
}
|
|
42049
|
+
|
|
41201
42050
|
/**
|
|
41202
42051
|
* Create a Messaging Campaign
|
|
41203
42052
|
*
|
|
@@ -41578,6 +42427,36 @@ class OutboundApi {
|
|
|
41578
42427
|
);
|
|
41579
42428
|
}
|
|
41580
42429
|
|
|
42430
|
+
/**
|
|
42431
|
+
* Update a contact list template.
|
|
42432
|
+
*
|
|
42433
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
42434
|
+
* @param {Object} body ContactListTemplate
|
|
42435
|
+
*/
|
|
42436
|
+
putOutboundContactlisttemplate(contactListTemplateId, body) {
|
|
42437
|
+
// verify the required parameter 'contactListTemplateId' is set
|
|
42438
|
+
if (contactListTemplateId === undefined || contactListTemplateId === null) {
|
|
42439
|
+
throw 'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';
|
|
42440
|
+
}
|
|
42441
|
+
// verify the required parameter 'body' is set
|
|
42442
|
+
if (body === undefined || body === null) {
|
|
42443
|
+
throw 'Missing the required parameter "body" when calling putOutboundContactlisttemplate';
|
|
42444
|
+
}
|
|
42445
|
+
|
|
42446
|
+
return this.apiClient.callApi(
|
|
42447
|
+
'/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
|
|
42448
|
+
'PUT',
|
|
42449
|
+
{ 'contactListTemplateId': contactListTemplateId },
|
|
42450
|
+
{ },
|
|
42451
|
+
{ },
|
|
42452
|
+
{ },
|
|
42453
|
+
body,
|
|
42454
|
+
['PureCloud OAuth'],
|
|
42455
|
+
['application/json'],
|
|
42456
|
+
['application/json']
|
|
42457
|
+
);
|
|
42458
|
+
}
|
|
42459
|
+
|
|
41581
42460
|
/**
|
|
41582
42461
|
* Update an Outbound Digital Rule Set
|
|
41583
42462
|
*
|
|
@@ -41638,6 +42517,36 @@ class OutboundApi {
|
|
|
41638
42517
|
);
|
|
41639
42518
|
}
|
|
41640
42519
|
|
|
42520
|
+
/**
|
|
42521
|
+
* Update Import Template
|
|
42522
|
+
*
|
|
42523
|
+
* @param {String} importTemplateId Import Template ID
|
|
42524
|
+
* @param {Object} body importTemplate
|
|
42525
|
+
*/
|
|
42526
|
+
putOutboundImporttemplate(importTemplateId, body) {
|
|
42527
|
+
// verify the required parameter 'importTemplateId' is set
|
|
42528
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
42529
|
+
throw 'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';
|
|
42530
|
+
}
|
|
42531
|
+
// verify the required parameter 'body' is set
|
|
42532
|
+
if (body === undefined || body === null) {
|
|
42533
|
+
throw 'Missing the required parameter "body" when calling putOutboundImporttemplate';
|
|
42534
|
+
}
|
|
42535
|
+
|
|
42536
|
+
return this.apiClient.callApi(
|
|
42537
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}',
|
|
42538
|
+
'PUT',
|
|
42539
|
+
{ 'importTemplateId': importTemplateId },
|
|
42540
|
+
{ },
|
|
42541
|
+
{ },
|
|
42542
|
+
{ },
|
|
42543
|
+
body,
|
|
42544
|
+
['PureCloud OAuth'],
|
|
42545
|
+
['application/json'],
|
|
42546
|
+
['application/json']
|
|
42547
|
+
);
|
|
42548
|
+
}
|
|
42549
|
+
|
|
41641
42550
|
/**
|
|
41642
42551
|
* Update an Outbound Messaging Campaign
|
|
41643
42552
|
*
|
|
@@ -41879,7 +42788,7 @@ class PresenceApi {
|
|
|
41879
42788
|
/**
|
|
41880
42789
|
* Presence service.
|
|
41881
42790
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
41882
|
-
* @version
|
|
42791
|
+
* @version 185.0.0
|
|
41883
42792
|
*/
|
|
41884
42793
|
|
|
41885
42794
|
/**
|
|
@@ -42618,7 +43527,7 @@ class ProcessAutomationApi {
|
|
|
42618
43527
|
/**
|
|
42619
43528
|
* ProcessAutomation service.
|
|
42620
43529
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
42621
|
-
* @version
|
|
43530
|
+
* @version 185.0.0
|
|
42622
43531
|
*/
|
|
42623
43532
|
|
|
42624
43533
|
/**
|
|
@@ -42857,7 +43766,7 @@ class QualityApi {
|
|
|
42857
43766
|
/**
|
|
42858
43767
|
* Quality service.
|
|
42859
43768
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
42860
|
-
* @version
|
|
43769
|
+
* @version 185.0.0
|
|
42861
43770
|
*/
|
|
42862
43771
|
|
|
42863
43772
|
/**
|
|
@@ -44614,7 +45523,7 @@ class RecordingApi {
|
|
|
44614
45523
|
/**
|
|
44615
45524
|
* Recording service.
|
|
44616
45525
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
44617
|
-
* @version
|
|
45526
|
+
* @version 185.0.0
|
|
44618
45527
|
*/
|
|
44619
45528
|
|
|
44620
45529
|
/**
|
|
@@ -46251,7 +47160,7 @@ class ResponseManagementApi {
|
|
|
46251
47160
|
/**
|
|
46252
47161
|
* ResponseManagement service.
|
|
46253
47162
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46254
|
-
* @version
|
|
47163
|
+
* @version 185.0.0
|
|
46255
47164
|
*/
|
|
46256
47165
|
|
|
46257
47166
|
/**
|
|
@@ -46736,7 +47645,7 @@ class RoutingApi {
|
|
|
46736
47645
|
/**
|
|
46737
47646
|
* Routing service.
|
|
46738
47647
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
46739
|
-
* @version
|
|
47648
|
+
* @version 185.0.0
|
|
46740
47649
|
*/
|
|
46741
47650
|
|
|
46742
47651
|
/**
|
|
@@ -47191,6 +48100,36 @@ class RoutingApi {
|
|
|
47191
48100
|
);
|
|
47192
48101
|
}
|
|
47193
48102
|
|
|
48103
|
+
/**
|
|
48104
|
+
* Delete a utilization label
|
|
48105
|
+
*
|
|
48106
|
+
* @param {String} labelId Utilization Label ID
|
|
48107
|
+
* @param {Object} opts Optional parameters
|
|
48108
|
+
* @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
|
|
48109
|
+
* deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48110
|
+
*/
|
|
48111
|
+
deleteRoutingUtilizationLabel(labelId, opts) {
|
|
48112
|
+
opts = opts || {};
|
|
48113
|
+
|
|
48114
|
+
// verify the required parameter 'labelId' is set
|
|
48115
|
+
if (labelId === undefined || labelId === null) {
|
|
48116
|
+
throw 'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';
|
|
48117
|
+
}
|
|
48118
|
+
|
|
48119
|
+
return this.apiClient.callApi(
|
|
48120
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
48121
|
+
'DELETE',
|
|
48122
|
+
{ 'labelId': labelId },
|
|
48123
|
+
{ 'forceDelete': opts['forceDelete'] },
|
|
48124
|
+
{ },
|
|
48125
|
+
{ },
|
|
48126
|
+
null,
|
|
48127
|
+
['PureCloud OAuth'],
|
|
48128
|
+
['application/json'],
|
|
48129
|
+
['application/json']
|
|
48130
|
+
);
|
|
48131
|
+
}
|
|
48132
|
+
|
|
47194
48133
|
/**
|
|
47195
48134
|
* Delete an utilization tag
|
|
47196
48135
|
*
|
|
@@ -48681,6 +49620,86 @@ class RoutingApi {
|
|
|
48681
49620
|
);
|
|
48682
49621
|
}
|
|
48683
49622
|
|
|
49623
|
+
/**
|
|
49624
|
+
* Get details about this utilization label
|
|
49625
|
+
*
|
|
49626
|
+
* @param {String} labelId Utilization Label ID
|
|
49627
|
+
* getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49628
|
+
*/
|
|
49629
|
+
getRoutingUtilizationLabel(labelId) {
|
|
49630
|
+
// verify the required parameter 'labelId' is set
|
|
49631
|
+
if (labelId === undefined || labelId === null) {
|
|
49632
|
+
throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';
|
|
49633
|
+
}
|
|
49634
|
+
|
|
49635
|
+
return this.apiClient.callApi(
|
|
49636
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
49637
|
+
'GET',
|
|
49638
|
+
{ 'labelId': labelId },
|
|
49639
|
+
{ },
|
|
49640
|
+
{ },
|
|
49641
|
+
{ },
|
|
49642
|
+
null,
|
|
49643
|
+
['PureCloud OAuth'],
|
|
49644
|
+
['application/json'],
|
|
49645
|
+
['application/json']
|
|
49646
|
+
);
|
|
49647
|
+
}
|
|
49648
|
+
|
|
49649
|
+
/**
|
|
49650
|
+
* Get list of agent ids associated with a utilization label
|
|
49651
|
+
*
|
|
49652
|
+
* @param {String} labelId Utilization Label ID
|
|
49653
|
+
* getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49654
|
+
*/
|
|
49655
|
+
getRoutingUtilizationLabelAgents(labelId) {
|
|
49656
|
+
// verify the required parameter 'labelId' is set
|
|
49657
|
+
if (labelId === undefined || labelId === null) {
|
|
49658
|
+
throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';
|
|
49659
|
+
}
|
|
49660
|
+
|
|
49661
|
+
return this.apiClient.callApi(
|
|
49662
|
+
'/api/v2/routing/utilization/labels/{labelId}/agents',
|
|
49663
|
+
'GET',
|
|
49664
|
+
{ 'labelId': labelId },
|
|
49665
|
+
{ },
|
|
49666
|
+
{ },
|
|
49667
|
+
{ },
|
|
49668
|
+
null,
|
|
49669
|
+
['PureCloud OAuth'],
|
|
49670
|
+
['application/json'],
|
|
49671
|
+
['application/json']
|
|
49672
|
+
);
|
|
49673
|
+
}
|
|
49674
|
+
|
|
49675
|
+
/**
|
|
49676
|
+
* Get list of utilization labels
|
|
49677
|
+
*
|
|
49678
|
+
* @param {Object} opts Optional parameters
|
|
49679
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
49680
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
49681
|
+
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
49682
|
+
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
49683
|
+
* getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49684
|
+
*/
|
|
49685
|
+
getRoutingUtilizationLabels(opts) {
|
|
49686
|
+
opts = opts || {};
|
|
49687
|
+
|
|
49688
|
+
|
|
49689
|
+
return this.apiClient.callApi(
|
|
49690
|
+
'/api/v2/routing/utilization/labels',
|
|
49691
|
+
'GET',
|
|
49692
|
+
{ },
|
|
49693
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
49694
|
+
{ },
|
|
49695
|
+
{ },
|
|
49696
|
+
null,
|
|
49697
|
+
['PureCloud OAuth'],
|
|
49698
|
+
['application/json'],
|
|
49699
|
+
['application/json']
|
|
49700
|
+
);
|
|
49701
|
+
}
|
|
49702
|
+
|
|
48684
49703
|
/**
|
|
48685
49704
|
* Get details about this utilization tag
|
|
48686
49705
|
*
|
|
@@ -49977,6 +50996,32 @@ class RoutingApi {
|
|
|
49977
50996
|
);
|
|
49978
50997
|
}
|
|
49979
50998
|
|
|
50999
|
+
/**
|
|
51000
|
+
* Create a utilization label
|
|
51001
|
+
*
|
|
51002
|
+
* @param {Object} body UtilizationLabel
|
|
51003
|
+
* postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51004
|
+
*/
|
|
51005
|
+
postRoutingUtilizationLabels(body) {
|
|
51006
|
+
// verify the required parameter 'body' is set
|
|
51007
|
+
if (body === undefined || body === null) {
|
|
51008
|
+
throw 'Missing the required parameter "body" when calling postRoutingUtilizationLabels';
|
|
51009
|
+
}
|
|
51010
|
+
|
|
51011
|
+
return this.apiClient.callApi(
|
|
51012
|
+
'/api/v2/routing/utilization/labels',
|
|
51013
|
+
'POST',
|
|
51014
|
+
{ },
|
|
51015
|
+
{ },
|
|
51016
|
+
{ },
|
|
51017
|
+
{ },
|
|
51018
|
+
body,
|
|
51019
|
+
['PureCloud OAuth'],
|
|
51020
|
+
['application/json'],
|
|
51021
|
+
['application/json']
|
|
51022
|
+
);
|
|
51023
|
+
}
|
|
51024
|
+
|
|
49980
51025
|
/**
|
|
49981
51026
|
* Create an utilization tag
|
|
49982
51027
|
*
|
|
@@ -50343,6 +51388,37 @@ class RoutingApi {
|
|
|
50343
51388
|
);
|
|
50344
51389
|
}
|
|
50345
51390
|
|
|
51391
|
+
/**
|
|
51392
|
+
* Update a utilization label
|
|
51393
|
+
*
|
|
51394
|
+
* @param {String} labelId Utilization Label ID
|
|
51395
|
+
* @param {Object} body UtilizationLabel
|
|
51396
|
+
* putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51397
|
+
*/
|
|
51398
|
+
putRoutingUtilizationLabel(labelId, body) {
|
|
51399
|
+
// verify the required parameter 'labelId' is set
|
|
51400
|
+
if (labelId === undefined || labelId === null) {
|
|
51401
|
+
throw 'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';
|
|
51402
|
+
}
|
|
51403
|
+
// verify the required parameter 'body' is set
|
|
51404
|
+
if (body === undefined || body === null) {
|
|
51405
|
+
throw 'Missing the required parameter "body" when calling putRoutingUtilizationLabel';
|
|
51406
|
+
}
|
|
51407
|
+
|
|
51408
|
+
return this.apiClient.callApi(
|
|
51409
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
51410
|
+
'PUT',
|
|
51411
|
+
{ 'labelId': labelId },
|
|
51412
|
+
{ },
|
|
51413
|
+
{ },
|
|
51414
|
+
{ },
|
|
51415
|
+
body,
|
|
51416
|
+
['PureCloud OAuth'],
|
|
51417
|
+
['application/json'],
|
|
51418
|
+
['application/json']
|
|
51419
|
+
);
|
|
51420
|
+
}
|
|
51421
|
+
|
|
50346
51422
|
/**
|
|
50347
51423
|
* Update wrap-up code
|
|
50348
51424
|
*
|
|
@@ -50444,7 +51520,7 @@ class SCIMApi {
|
|
|
50444
51520
|
/**
|
|
50445
51521
|
* SCIM service.
|
|
50446
51522
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
50447
|
-
* @version
|
|
51523
|
+
* @version 185.0.0
|
|
50448
51524
|
*/
|
|
50449
51525
|
|
|
50450
51526
|
/**
|
|
@@ -51321,7 +52397,7 @@ class ScriptsApi {
|
|
|
51321
52397
|
/**
|
|
51322
52398
|
* Scripts service.
|
|
51323
52399
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51324
|
-
* @version
|
|
52400
|
+
* @version 185.0.0
|
|
51325
52401
|
*/
|
|
51326
52402
|
|
|
51327
52403
|
/**
|
|
@@ -51765,7 +52841,7 @@ class SearchApi {
|
|
|
51765
52841
|
/**
|
|
51766
52842
|
* Search service.
|
|
51767
52843
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
51768
|
-
* @version
|
|
52844
|
+
* @version 185.0.0
|
|
51769
52845
|
*/
|
|
51770
52846
|
|
|
51771
52847
|
/**
|
|
@@ -52454,7 +53530,7 @@ class SettingsApi {
|
|
|
52454
53530
|
/**
|
|
52455
53531
|
* Settings service.
|
|
52456
53532
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
52457
|
-
* @version
|
|
53533
|
+
* @version 185.0.0
|
|
52458
53534
|
*/
|
|
52459
53535
|
|
|
52460
53536
|
/**
|
|
@@ -52519,7 +53595,7 @@ class SpeechTextAnalyticsApi {
|
|
|
52519
53595
|
/**
|
|
52520
53596
|
* SpeechTextAnalytics service.
|
|
52521
53597
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
52522
|
-
* @version
|
|
53598
|
+
* @version 185.0.0
|
|
52523
53599
|
*/
|
|
52524
53600
|
|
|
52525
53601
|
/**
|
|
@@ -53632,7 +54708,7 @@ class StationsApi {
|
|
|
53632
54708
|
/**
|
|
53633
54709
|
* Stations service.
|
|
53634
54710
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
53635
|
-
* @version
|
|
54711
|
+
* @version 185.0.0
|
|
53636
54712
|
*/
|
|
53637
54713
|
|
|
53638
54714
|
/**
|
|
@@ -53734,7 +54810,7 @@ class SuggestApi {
|
|
|
53734
54810
|
/**
|
|
53735
54811
|
* Suggest service.
|
|
53736
54812
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
53737
|
-
* @version
|
|
54813
|
+
* @version 185.0.0
|
|
53738
54814
|
*/
|
|
53739
54815
|
|
|
53740
54816
|
/**
|
|
@@ -53873,7 +54949,7 @@ class TaskManagementApi {
|
|
|
53873
54949
|
/**
|
|
53874
54950
|
* TaskManagement service.
|
|
53875
54951
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
53876
|
-
* @version
|
|
54952
|
+
* @version 185.0.0
|
|
53877
54953
|
*/
|
|
53878
54954
|
|
|
53879
54955
|
/**
|
|
@@ -55154,7 +56230,7 @@ class TeamsApi {
|
|
|
55154
56230
|
/**
|
|
55155
56231
|
* Teams service.
|
|
55156
56232
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
55157
|
-
* @version
|
|
56233
|
+
* @version 185.0.0
|
|
55158
56234
|
*/
|
|
55159
56235
|
|
|
55160
56236
|
/**
|
|
@@ -55456,7 +56532,7 @@ class TelephonyApi {
|
|
|
55456
56532
|
/**
|
|
55457
56533
|
* Telephony service.
|
|
55458
56534
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
55459
|
-
* @version
|
|
56535
|
+
* @version 185.0.0
|
|
55460
56536
|
*/
|
|
55461
56537
|
|
|
55462
56538
|
/**
|
|
@@ -55640,7 +56716,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
55640
56716
|
/**
|
|
55641
56717
|
* TelephonyProvidersEdge service.
|
|
55642
56718
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
55643
|
-
* @version
|
|
56719
|
+
* @version 185.0.0
|
|
55644
56720
|
*/
|
|
55645
56721
|
|
|
55646
56722
|
/**
|
|
@@ -56408,8 +57484,9 @@ class TelephonyProvidersEdgeApi {
|
|
|
56408
57484
|
}
|
|
56409
57485
|
|
|
56410
57486
|
/**
|
|
56411
|
-
* Get the list of available languages.
|
|
57487
|
+
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
56412
57488
|
*
|
|
57489
|
+
* @deprecated
|
|
56413
57490
|
*/
|
|
56414
57491
|
getTelephonyProvidersEdgesAvailablelanguages() {
|
|
56415
57492
|
|
|
@@ -59014,7 +60091,7 @@ class TextbotsApi {
|
|
|
59014
60091
|
/**
|
|
59015
60092
|
* Textbots service.
|
|
59016
60093
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
59017
|
-
* @version
|
|
60094
|
+
* @version 185.0.0
|
|
59018
60095
|
*/
|
|
59019
60096
|
|
|
59020
60097
|
/**
|
|
@@ -59142,7 +60219,7 @@ class TokensApi {
|
|
|
59142
60219
|
/**
|
|
59143
60220
|
* Tokens service.
|
|
59144
60221
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
59145
|
-
* @version
|
|
60222
|
+
* @version 185.0.0
|
|
59146
60223
|
*/
|
|
59147
60224
|
|
|
59148
60225
|
/**
|
|
@@ -59298,7 +60375,7 @@ class UploadsApi {
|
|
|
59298
60375
|
/**
|
|
59299
60376
|
* Uploads service.
|
|
59300
60377
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
59301
|
-
* @version
|
|
60378
|
+
* @version 185.0.0
|
|
59302
60379
|
*/
|
|
59303
60380
|
|
|
59304
60381
|
/**
|
|
@@ -59474,7 +60551,7 @@ class UsageApi {
|
|
|
59474
60551
|
/**
|
|
59475
60552
|
* Usage service.
|
|
59476
60553
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
59477
|
-
* @version
|
|
60554
|
+
* @version 185.0.0
|
|
59478
60555
|
*/
|
|
59479
60556
|
|
|
59480
60557
|
/**
|
|
@@ -59684,7 +60761,7 @@ class UserRecordingsApi {
|
|
|
59684
60761
|
/**
|
|
59685
60762
|
* UserRecordings service.
|
|
59686
60763
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
59687
|
-
* @version
|
|
60764
|
+
* @version 185.0.0
|
|
59688
60765
|
*/
|
|
59689
60766
|
|
|
59690
60767
|
/**
|
|
@@ -59869,7 +60946,7 @@ class UsersApi {
|
|
|
59869
60946
|
/**
|
|
59870
60947
|
* Users service.
|
|
59871
60948
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
59872
|
-
* @version
|
|
60949
|
+
* @version 185.0.0
|
|
59873
60950
|
*/
|
|
59874
60951
|
|
|
59875
60952
|
/**
|
|
@@ -62520,7 +63597,7 @@ class UtilitiesApi {
|
|
|
62520
63597
|
/**
|
|
62521
63598
|
* Utilities service.
|
|
62522
63599
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
62523
|
-
* @version
|
|
63600
|
+
* @version 185.0.0
|
|
62524
63601
|
*/
|
|
62525
63602
|
|
|
62526
63603
|
/**
|
|
@@ -62631,7 +63708,7 @@ class VoicemailApi {
|
|
|
62631
63708
|
/**
|
|
62632
63709
|
* Voicemail service.
|
|
62633
63710
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
62634
|
-
* @version
|
|
63711
|
+
* @version 185.0.0
|
|
62635
63712
|
*/
|
|
62636
63713
|
|
|
62637
63714
|
/**
|
|
@@ -63298,7 +64375,7 @@ class WebChatApi {
|
|
|
63298
64375
|
/**
|
|
63299
64376
|
* WebChat service.
|
|
63300
64377
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
63301
|
-
* @version
|
|
64378
|
+
* @version 185.0.0
|
|
63302
64379
|
*/
|
|
63303
64380
|
|
|
63304
64381
|
/**
|
|
@@ -63847,7 +64924,7 @@ class WebDeploymentsApi {
|
|
|
63847
64924
|
/**
|
|
63848
64925
|
* WebDeployments service.
|
|
63849
64926
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
63850
|
-
* @version
|
|
64927
|
+
* @version 185.0.0
|
|
63851
64928
|
*/
|
|
63852
64929
|
|
|
63853
64930
|
/**
|
|
@@ -64374,7 +65451,7 @@ class WebMessagingApi {
|
|
|
64374
65451
|
/**
|
|
64375
65452
|
* WebMessaging service.
|
|
64376
65453
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
64377
|
-
* @version
|
|
65454
|
+
* @version 185.0.0
|
|
64378
65455
|
*/
|
|
64379
65456
|
|
|
64380
65457
|
/**
|
|
@@ -64420,7 +65497,7 @@ class WidgetsApi {
|
|
|
64420
65497
|
/**
|
|
64421
65498
|
* Widgets service.
|
|
64422
65499
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
64423
|
-
* @version
|
|
65500
|
+
* @version 185.0.0
|
|
64424
65501
|
*/
|
|
64425
65502
|
|
|
64426
65503
|
/**
|
|
@@ -64566,7 +65643,7 @@ class WorkforceManagementApi {
|
|
|
64566
65643
|
/**
|
|
64567
65644
|
* WorkforceManagement service.
|
|
64568
65645
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
64569
|
-
* @version
|
|
65646
|
+
* @version 185.0.0
|
|
64570
65647
|
*/
|
|
64571
65648
|
|
|
64572
65649
|
/**
|
|
@@ -65700,6 +66777,81 @@ class WorkforceManagementApi {
|
|
|
65700
66777
|
);
|
|
65701
66778
|
}
|
|
65702
66779
|
|
|
66780
|
+
/**
|
|
66781
|
+
* Get the performance prediction for the associated schedule
|
|
66782
|
+
*
|
|
66783
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
66784
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
66785
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
66786
|
+
*/
|
|
66787
|
+
getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(businessUnitId, weekId, scheduleId) {
|
|
66788
|
+
// verify the required parameter 'businessUnitId' is set
|
|
66789
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
66790
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
66791
|
+
}
|
|
66792
|
+
// verify the required parameter 'weekId' is set
|
|
66793
|
+
if (weekId === undefined || weekId === null) {
|
|
66794
|
+
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
66795
|
+
}
|
|
66796
|
+
// verify the required parameter 'scheduleId' is set
|
|
66797
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
66798
|
+
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
66799
|
+
}
|
|
66800
|
+
|
|
66801
|
+
return this.apiClient.callApi(
|
|
66802
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions',
|
|
66803
|
+
'GET',
|
|
66804
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
66805
|
+
{ },
|
|
66806
|
+
{ },
|
|
66807
|
+
{ },
|
|
66808
|
+
null,
|
|
66809
|
+
['PureCloud OAuth'],
|
|
66810
|
+
['application/json'],
|
|
66811
|
+
['application/json']
|
|
66812
|
+
);
|
|
66813
|
+
}
|
|
66814
|
+
|
|
66815
|
+
/**
|
|
66816
|
+
* Get recalculated performance prediction result
|
|
66817
|
+
*
|
|
66818
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
66819
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
66820
|
+
* @param {String} scheduleId The ID of the schedule the recalculation belongs to
|
|
66821
|
+
* @param {String} recalculationId The ID of the recalculation request
|
|
66822
|
+
*/
|
|
66823
|
+
getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(businessUnitId, weekId, scheduleId, recalculationId) {
|
|
66824
|
+
// verify the required parameter 'businessUnitId' is set
|
|
66825
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
66826
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
66827
|
+
}
|
|
66828
|
+
// verify the required parameter 'weekId' is set
|
|
66829
|
+
if (weekId === undefined || weekId === null) {
|
|
66830
|
+
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
66831
|
+
}
|
|
66832
|
+
// verify the required parameter 'scheduleId' is set
|
|
66833
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
66834
|
+
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
66835
|
+
}
|
|
66836
|
+
// verify the required parameter 'recalculationId' is set
|
|
66837
|
+
if (recalculationId === undefined || recalculationId === null) {
|
|
66838
|
+
throw 'Missing the required parameter "recalculationId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
66839
|
+
}
|
|
66840
|
+
|
|
66841
|
+
return this.apiClient.callApi(
|
|
66842
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}',
|
|
66843
|
+
'GET',
|
|
66844
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId,'recalculationId': recalculationId },
|
|
66845
|
+
{ },
|
|
66846
|
+
{ },
|
|
66847
|
+
{ },
|
|
66848
|
+
null,
|
|
66849
|
+
['PureCloud OAuth'],
|
|
66850
|
+
['application/json'],
|
|
66851
|
+
['application/json']
|
|
66852
|
+
);
|
|
66853
|
+
}
|
|
66854
|
+
|
|
65703
66855
|
/**
|
|
65704
66856
|
* Get the list of week schedules for the specified week
|
|
65705
66857
|
* Use "recent" (without quotes) for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week
|
|
@@ -65923,6 +67075,45 @@ class WorkforceManagementApi {
|
|
|
65923
67075
|
);
|
|
65924
67076
|
}
|
|
65925
67077
|
|
|
67078
|
+
/**
|
|
67079
|
+
* Get the staffing requirement by planning group for a forecast
|
|
67080
|
+
*
|
|
67081
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
67082
|
+
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
67083
|
+
* @param {String} forecastId The ID of the forecast
|
|
67084
|
+
* @param {Object} opts Optional parameters
|
|
67085
|
+
* @param {Array.<String>} opts.weekNumbers The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified
|
|
67086
|
+
*/
|
|
67087
|
+
getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId, weekDateId, forecastId, opts) {
|
|
67088
|
+
opts = opts || {};
|
|
67089
|
+
|
|
67090
|
+
// verify the required parameter 'businessUnitId' is set
|
|
67091
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
67092
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67093
|
+
}
|
|
67094
|
+
// verify the required parameter 'weekDateId' is set
|
|
67095
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
67096
|
+
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67097
|
+
}
|
|
67098
|
+
// verify the required parameter 'forecastId' is set
|
|
67099
|
+
if (forecastId === undefined || forecastId === null) {
|
|
67100
|
+
throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67101
|
+
}
|
|
67102
|
+
|
|
67103
|
+
return this.apiClient.callApi(
|
|
67104
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement',
|
|
67105
|
+
'GET',
|
|
67106
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
67107
|
+
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi') },
|
|
67108
|
+
{ },
|
|
67109
|
+
{ },
|
|
67110
|
+
null,
|
|
67111
|
+
['PureCloud OAuth'],
|
|
67112
|
+
['application/json'],
|
|
67113
|
+
['application/json']
|
|
67114
|
+
);
|
|
67115
|
+
}
|
|
67116
|
+
|
|
65926
67117
|
/**
|
|
65927
67118
|
* Get short term forecasts
|
|
65928
67119
|
* Use "recent" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
@@ -67274,6 +68465,35 @@ class WorkforceManagementApi {
|
|
|
67274
68465
|
);
|
|
67275
68466
|
}
|
|
67276
68467
|
|
|
68468
|
+
/**
|
|
68469
|
+
* Update agent configurations
|
|
68470
|
+
*
|
|
68471
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
68472
|
+
* @param {Object} opts Optional parameters
|
|
68473
|
+
* @param {Object} opts.body body
|
|
68474
|
+
*/
|
|
68475
|
+
patchWorkforcemanagementManagementunitAgents(managementUnitId, opts) {
|
|
68476
|
+
opts = opts || {};
|
|
68477
|
+
|
|
68478
|
+
// verify the required parameter 'managementUnitId' is set
|
|
68479
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
68480
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';
|
|
68481
|
+
}
|
|
68482
|
+
|
|
68483
|
+
return this.apiClient.callApi(
|
|
68484
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents',
|
|
68485
|
+
'PATCH',
|
|
68486
|
+
{ 'managementUnitId': managementUnitId },
|
|
68487
|
+
{ },
|
|
68488
|
+
{ },
|
|
68489
|
+
{ },
|
|
68490
|
+
opts['body'],
|
|
68491
|
+
['PureCloud OAuth'],
|
|
68492
|
+
['application/json'],
|
|
68493
|
+
['application/json']
|
|
68494
|
+
);
|
|
68495
|
+
}
|
|
68496
|
+
|
|
67277
68497
|
/**
|
|
67278
68498
|
* Updates a time off limit object.
|
|
67279
68499
|
* Updates time off limit object properties, but not daily values.
|
|
@@ -68092,6 +69312,84 @@ class WorkforceManagementApi {
|
|
|
68092
69312
|
);
|
|
68093
69313
|
}
|
|
68094
69314
|
|
|
69315
|
+
/**
|
|
69316
|
+
* Request a daily recalculation of the performance prediction for the associated schedule
|
|
69317
|
+
*
|
|
69318
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
69319
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
69320
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
69321
|
+
* @param {Object} opts Optional parameters
|
|
69322
|
+
* @param {Object} opts.body body
|
|
69323
|
+
*/
|
|
69324
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId, opts) {
|
|
69325
|
+
opts = opts || {};
|
|
69326
|
+
|
|
69327
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69328
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69329
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69330
|
+
}
|
|
69331
|
+
// verify the required parameter 'weekId' is set
|
|
69332
|
+
if (weekId === undefined || weekId === null) {
|
|
69333
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69334
|
+
}
|
|
69335
|
+
// verify the required parameter 'scheduleId' is set
|
|
69336
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
69337
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69338
|
+
}
|
|
69339
|
+
|
|
69340
|
+
return this.apiClient.callApi(
|
|
69341
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations',
|
|
69342
|
+
'POST',
|
|
69343
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
69344
|
+
{ },
|
|
69345
|
+
{ },
|
|
69346
|
+
{ },
|
|
69347
|
+
opts['body'],
|
|
69348
|
+
['PureCloud OAuth'],
|
|
69349
|
+
['application/json'],
|
|
69350
|
+
['application/json']
|
|
69351
|
+
);
|
|
69352
|
+
}
|
|
69353
|
+
|
|
69354
|
+
/**
|
|
69355
|
+
* Upload daily activity changes to be able to request a performance prediction recalculation
|
|
69356
|
+
*
|
|
69357
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
69358
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
69359
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
69360
|
+
* @param {Object} opts Optional parameters
|
|
69361
|
+
* @param {Object} opts.body body
|
|
69362
|
+
*/
|
|
69363
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId, opts) {
|
|
69364
|
+
opts = opts || {};
|
|
69365
|
+
|
|
69366
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69367
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69368
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69369
|
+
}
|
|
69370
|
+
// verify the required parameter 'weekId' is set
|
|
69371
|
+
if (weekId === undefined || weekId === null) {
|
|
69372
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69373
|
+
}
|
|
69374
|
+
// verify the required parameter 'scheduleId' is set
|
|
69375
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
69376
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69377
|
+
}
|
|
69378
|
+
|
|
69379
|
+
return this.apiClient.callApi(
|
|
69380
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl',
|
|
69381
|
+
'POST',
|
|
69382
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
69383
|
+
{ },
|
|
69384
|
+
{ },
|
|
69385
|
+
{ },
|
|
69386
|
+
opts['body'],
|
|
69387
|
+
['PureCloud OAuth'],
|
|
69388
|
+
['application/json'],
|
|
69389
|
+
['application/json']
|
|
69390
|
+
);
|
|
69391
|
+
}
|
|
69392
|
+
|
|
68095
69393
|
/**
|
|
68096
69394
|
* Start a rescheduling run
|
|
68097
69395
|
*
|
|
@@ -69740,7 +71038,7 @@ class WorkforceManagementApi {
|
|
|
69740
71038
|
* </pre>
|
|
69741
71039
|
* </p>
|
|
69742
71040
|
* @module purecloud-platform-client-v2/index
|
|
69743
|
-
* @version
|
|
71041
|
+
* @version 185.0.0
|
|
69744
71042
|
*/
|
|
69745
71043
|
class platformClient {
|
|
69746
71044
|
constructor() {
|
|
@@ -69919,6 +71217,11 @@ class platformClient {
|
|
|
69919
71217
|
* @property {module:purecloud-platform-client-v2/api/LocationsApi}
|
|
69920
71218
|
*/
|
|
69921
71219
|
this.LocationsApi = LocationsApi;
|
|
71220
|
+
/**
|
|
71221
|
+
* The LogCaptureApi service constructor.
|
|
71222
|
+
* @property {module:purecloud-platform-client-v2/api/LogCaptureApi}
|
|
71223
|
+
*/
|
|
71224
|
+
this.LogCaptureApi = LogCaptureApi;
|
|
69922
71225
|
/**
|
|
69923
71226
|
* The MessagingApi service constructor.
|
|
69924
71227
|
* @property {module:purecloud-platform-client-v2/api/MessagingApi}
|