purecloud-platform-client-v2 184.0.0 → 186.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +68 -2
- package/dist/node/purecloud-platform-client-v2.js +1103 -156
- package/dist/web-amd/purecloud-platform-client-v2.js +1103 -156
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +349 -140
- package/dist/web-cjs/purecloud-platform-client-v2.js +354 -142
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +711 -161
- package/package.json +2 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +334 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -4
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +58 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -62
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +7 -7
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +131 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +247 -2
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -3
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +5 -4
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +222 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 186.0.1
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -810,6 +810,339 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
810
810
|
});
|
|
811
811
|
}
|
|
812
812
|
|
|
813
|
+
/**
|
|
814
|
+
* @description Completes the PKCE Code Authorization.
|
|
815
|
+
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
816
|
+
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
817
|
+
* @param {string} authCode - Authorization code
|
|
818
|
+
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
819
|
+
*/
|
|
820
|
+
authorizePKCEGrant(clientId, codeVerifier, authCode, redirectUri) {
|
|
821
|
+
this.clientId = clientId;
|
|
822
|
+
return new Promise((resolve, reject) => {
|
|
823
|
+
var request = axios__default["default"]({
|
|
824
|
+
method: `POST`,
|
|
825
|
+
url: `https://login.${this.config.environment}/oauth/token`,
|
|
826
|
+
headers: {
|
|
827
|
+
'Content-Type': 'application/x-www-form-urlencoded'
|
|
828
|
+
},
|
|
829
|
+
data: qs__default["default"].stringify({ grant_type: 'authorization_code',
|
|
830
|
+
code: authCode,
|
|
831
|
+
code_verifier: codeVerifier,
|
|
832
|
+
client_id: clientId,
|
|
833
|
+
redirect_uri: redirectUri })
|
|
834
|
+
});
|
|
835
|
+
|
|
836
|
+
request.proxy = this.proxy;
|
|
837
|
+
var bodyParam = {
|
|
838
|
+
grant_type: 'authorization_code',
|
|
839
|
+
code: authCode,
|
|
840
|
+
code_verifier: codeVerifier,
|
|
841
|
+
client_id: clientId,
|
|
842
|
+
redirect_uri: redirectUri,
|
|
843
|
+
};
|
|
844
|
+
// Handle response
|
|
845
|
+
request
|
|
846
|
+
.then((response) => {
|
|
847
|
+
// Logging
|
|
848
|
+
this.config.logger.log(
|
|
849
|
+
'trace',
|
|
850
|
+
response.status,
|
|
851
|
+
'POST',
|
|
852
|
+
`https://login.${this.config.environment}/oauth/token`,
|
|
853
|
+
request.headers,
|
|
854
|
+
response.headers,
|
|
855
|
+
bodyParam,
|
|
856
|
+
undefined
|
|
857
|
+
);
|
|
858
|
+
this.config.logger.log(
|
|
859
|
+
'debug',
|
|
860
|
+
response.status,
|
|
861
|
+
'POST',
|
|
862
|
+
`https://login.${this.config.environment}/oauth/token`,
|
|
863
|
+
request.headers,
|
|
864
|
+
undefined,
|
|
865
|
+
bodyParam,
|
|
866
|
+
undefined
|
|
867
|
+
);
|
|
868
|
+
|
|
869
|
+
// Get access token from response
|
|
870
|
+
var access_token = response.data.access_token;
|
|
871
|
+
|
|
872
|
+
this.setAccessToken(access_token);
|
|
873
|
+
this.authData.tokenExpiryTime = new Date().getTime() + response.data['expires_in'] * 1000;
|
|
874
|
+
this.authData.tokenExpiryTimeString = new Date(this.authData.tokenExpiryTime).toUTCString();
|
|
875
|
+
|
|
876
|
+
// Return auth data
|
|
877
|
+
resolve(this.authData);
|
|
878
|
+
})
|
|
879
|
+
.catch((error) => {
|
|
880
|
+
// Log error
|
|
881
|
+
if (error.response) {
|
|
882
|
+
this.config.logger.log(
|
|
883
|
+
'error',
|
|
884
|
+
error.response.status,
|
|
885
|
+
'POST',
|
|
886
|
+
`https://login.${this.config.environment}/oauth/token`,
|
|
887
|
+
request.headers,
|
|
888
|
+
error.response.headers,
|
|
889
|
+
bodyParam,
|
|
890
|
+
error.response.data
|
|
891
|
+
);
|
|
892
|
+
}
|
|
893
|
+
|
|
894
|
+
reject(error);
|
|
895
|
+
});
|
|
896
|
+
|
|
897
|
+
});
|
|
898
|
+
}
|
|
899
|
+
|
|
900
|
+
/**
|
|
901
|
+
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
902
|
+
* @param {number} nChar - code length
|
|
903
|
+
*/
|
|
904
|
+
generatePKCECodeVerifier(nChar) {
|
|
905
|
+
if (nChar < 43 || nChar > 128) {
|
|
906
|
+
throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
|
|
907
|
+
}
|
|
908
|
+
// Check for window
|
|
909
|
+
if (typeof window === 'undefined') {
|
|
910
|
+
try {
|
|
911
|
+
const getRandomValues = require('crypto').getRandomValues;
|
|
912
|
+
const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
|
|
913
|
+
let randomString = Array.from(getRandomValues(new Uint32Array(nChar)))
|
|
914
|
+
.map((x) => unreservedCharacters[x % unreservedCharacters.length])
|
|
915
|
+
.join('');
|
|
916
|
+
return randomString;
|
|
917
|
+
} catch (err) {
|
|
918
|
+
throw new Error(`Crypto module is missing/not supported.`);
|
|
919
|
+
}
|
|
920
|
+
} else {
|
|
921
|
+
const unreservedCharacters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";
|
|
922
|
+
let randomString = Array.from(crypto.getRandomValues(new Uint32Array(nChar)))
|
|
923
|
+
.map((x) => unreservedCharacters[x % unreservedCharacters.length])
|
|
924
|
+
.join('');
|
|
925
|
+
return randomString;
|
|
926
|
+
}
|
|
927
|
+
}
|
|
928
|
+
|
|
929
|
+
/**
|
|
930
|
+
* @description Compute Base64Url PKCE Code Challenge from Code Verifier.
|
|
931
|
+
* @param {string} code - code verifier used to generate the code challenge
|
|
932
|
+
*/
|
|
933
|
+
computePKCECodeChallenge(code) {
|
|
934
|
+
if (code.length < 43 || code.length > 128) {
|
|
935
|
+
throw new Error(`PKCE Code Verifier (length) must be between 43 and 128 characters`);
|
|
936
|
+
}
|
|
937
|
+
// Check for window
|
|
938
|
+
if (typeof window === 'undefined') {
|
|
939
|
+
// nodejs
|
|
940
|
+
try {
|
|
941
|
+
const createHash = require('crypto').createHash;
|
|
942
|
+
const utf8 = new TextEncoder().encode(code);
|
|
943
|
+
return new Promise((resolve, reject) => {
|
|
944
|
+
const hashHex = createHash('sha256').update(utf8).digest();
|
|
945
|
+
const hashBase64Url = Buffer.from(hashHex).toString('base64url');
|
|
946
|
+
resolve(hashBase64Url);
|
|
947
|
+
});
|
|
948
|
+
} catch (err) {
|
|
949
|
+
throw new Error(`Crypto module is missing/not supported.`);
|
|
950
|
+
}
|
|
951
|
+
} else {
|
|
952
|
+
// browser
|
|
953
|
+
const utf8 = new TextEncoder().encode(code);
|
|
954
|
+
return new Promise((resolve, reject) => {
|
|
955
|
+
window.crypto.subtle.digest("SHA-256", utf8).then((hashBuffer) => {
|
|
956
|
+
const hashBase64 = Buffer.from(hashBuffer).toString('base64');
|
|
957
|
+
let hashBase64Url = hashBase64.replaceAll("+", "-").replaceAll("/", "_");
|
|
958
|
+
hashBase64Url = hashBase64Url.split("=")[0];
|
|
959
|
+
resolve(hashBase64Url);
|
|
960
|
+
})
|
|
961
|
+
.catch((error) => {
|
|
962
|
+
// Handle failure
|
|
963
|
+
return reject(new Error(`Code Challenge Error ${error}`));
|
|
964
|
+
});
|
|
965
|
+
});
|
|
966
|
+
}
|
|
967
|
+
}
|
|
968
|
+
|
|
969
|
+
/**
|
|
970
|
+
* @description Initiates the pkce auth code grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
971
|
+
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
972
|
+
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
973
|
+
* @param {object} opts - (optional) Additional options
|
|
974
|
+
* @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
|
|
975
|
+
* @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
|
|
976
|
+
* @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
|
|
977
|
+
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
978
|
+
*/
|
|
979
|
+
loginPKCEGrant(clientId, redirectUri, opts, codeVerifier) {
|
|
980
|
+
// Need Local Storage or non null codeVerifier as parameter
|
|
981
|
+
if (!this.hasLocalStorage && !codeVerifier) {
|
|
982
|
+
throw new Error(`loginPKCEGrant requires Local Storage or codeVerifier as input parameter`);
|
|
983
|
+
}
|
|
984
|
+
// Check for auth code in query
|
|
985
|
+
const query = this._setValuesFromUrlQuery();
|
|
986
|
+
|
|
987
|
+
this.clientId = clientId;
|
|
988
|
+
this.redirectUri = redirectUri;
|
|
989
|
+
|
|
990
|
+
this.codeVerifier = codeVerifier;
|
|
991
|
+
|
|
992
|
+
if (!opts) opts = {};
|
|
993
|
+
|
|
994
|
+
return new Promise((resolve, reject) => {
|
|
995
|
+
// Abort if org and provider are not set together
|
|
996
|
+
if (opts.org && !opts.provider) {
|
|
997
|
+
reject(new Error('opts.provider must be set if opts.org is set'));
|
|
998
|
+
} else if (opts.provider && !opts.org) {
|
|
999
|
+
reject(new Error('opts.org must be set if opts.provider is set'));
|
|
1000
|
+
}
|
|
1001
|
+
|
|
1002
|
+
// Abort on auth error
|
|
1003
|
+
if (query && query.error) {
|
|
1004
|
+
// remove codeVerifier from session storage
|
|
1005
|
+
if (this.hasLocalStorage) {
|
|
1006
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1007
|
+
}
|
|
1008
|
+
// reset access token if any was stored
|
|
1009
|
+
this._saveSettings({ accessToken: undefined });
|
|
1010
|
+
return reject(new Error(`[${query.error}] ${query.error_description}`));
|
|
1011
|
+
}
|
|
1012
|
+
|
|
1013
|
+
// Get token on auth code
|
|
1014
|
+
if (query && query.code) {
|
|
1015
|
+
if (!this.codeVerifier) {
|
|
1016
|
+
// load codeVerifier from session storage
|
|
1017
|
+
if (this.hasLocalStorage) {
|
|
1018
|
+
this.codeVerifier = sessionStorage.getItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1019
|
+
}
|
|
1020
|
+
}
|
|
1021
|
+
this.authorizePKCEGrant(this.clientId, this.codeVerifier, query.code, this.redirectUri)
|
|
1022
|
+
.then(() => {
|
|
1023
|
+
// Do authenticated things
|
|
1024
|
+
this._testTokenAccess()
|
|
1025
|
+
.then(() => {
|
|
1026
|
+
if (!this.authData.state && query.state)
|
|
1027
|
+
this.authData.state = query.state;
|
|
1028
|
+
// remove codeVerifier from session storage
|
|
1029
|
+
if (this.hasLocalStorage) {
|
|
1030
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1031
|
+
}
|
|
1032
|
+
resolve(this.authData);
|
|
1033
|
+
})
|
|
1034
|
+
.catch((error) => {
|
|
1035
|
+
// Handle failure response
|
|
1036
|
+
this._saveSettings({ accessToken: undefined});
|
|
1037
|
+
// remove codeVerifier from session storage
|
|
1038
|
+
if (this.hasLocalStorage) {
|
|
1039
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1040
|
+
}
|
|
1041
|
+
return reject(new Error(`[${error.name}] ${error.msg}`));
|
|
1042
|
+
});
|
|
1043
|
+
})
|
|
1044
|
+
.catch((error) => {
|
|
1045
|
+
// Handle failure response
|
|
1046
|
+
this._saveSettings({ accessToken: undefined});
|
|
1047
|
+
// remove codeVerifier from session storage
|
|
1048
|
+
if (this.hasLocalStorage) {
|
|
1049
|
+
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
1050
|
+
}
|
|
1051
|
+
return reject(new Error(`[${error.name}] ${error.msg}`));
|
|
1052
|
+
});
|
|
1053
|
+
} else {
|
|
1054
|
+
// Test token (if previously stored) and proceed with login
|
|
1055
|
+
this._testTokenAccess()
|
|
1056
|
+
.then(() => {
|
|
1057
|
+
if (!this.authData.state && opts.state)
|
|
1058
|
+
this.authData.state = opts.state;
|
|
1059
|
+
resolve(this.authData);
|
|
1060
|
+
})
|
|
1061
|
+
.catch((error) => {
|
|
1062
|
+
if (!this.codeVerifier) {
|
|
1063
|
+
this.codeVerifier = this.generatePKCECodeVerifier(128);
|
|
1064
|
+
// save codeVerifier in session storage
|
|
1065
|
+
if (this.hasLocalStorage) {
|
|
1066
|
+
sessionStorage.setItem(`genesys_cloud_sdk_pkce_code_verifier`, this.codeVerifier);
|
|
1067
|
+
}
|
|
1068
|
+
}
|
|
1069
|
+
this.computePKCECodeChallenge(this.codeVerifier)
|
|
1070
|
+
.then((codeChallenge) => {
|
|
1071
|
+
var tokenQuery = {
|
|
1072
|
+
client_id: encodeURIComponent(this.clientId),
|
|
1073
|
+
redirect_uri: encodeURIComponent(this.redirectUri),
|
|
1074
|
+
code_challenge: encodeURIComponent(codeChallenge),
|
|
1075
|
+
response_type: 'code',
|
|
1076
|
+
code_challenge_method: 'S256'
|
|
1077
|
+
};
|
|
1078
|
+
if (opts.state) tokenQuery.state = encodeURIComponent(opts.state);
|
|
1079
|
+
if (opts.org) tokenQuery.org = encodeURIComponent(opts.org);
|
|
1080
|
+
if (opts.provider) tokenQuery.provider = encodeURIComponent(opts.provider);
|
|
1081
|
+
|
|
1082
|
+
var url = this._buildAuthUrl('oauth/authorize', tokenQuery);
|
|
1083
|
+
window.location.replace(url);
|
|
1084
|
+
})
|
|
1085
|
+
.catch((err) => {
|
|
1086
|
+
return reject(new Error(`[${err.name}]`));
|
|
1087
|
+
});
|
|
1088
|
+
});
|
|
1089
|
+
}
|
|
1090
|
+
});
|
|
1091
|
+
}
|
|
1092
|
+
|
|
1093
|
+
/**
|
|
1094
|
+
* @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
|
|
1095
|
+
*/
|
|
1096
|
+
_setValuesFromUrlQuery() {
|
|
1097
|
+
// Check for window
|
|
1098
|
+
if (!(typeof window !== 'undefined' && window.location.search)) return;
|
|
1099
|
+
|
|
1100
|
+
// Process query string
|
|
1101
|
+
let query = {};
|
|
1102
|
+
let queryParams = new URLSearchParams(window.location.search);
|
|
1103
|
+
let code = queryParams.get('code');
|
|
1104
|
+
let error = queryParams.get('error');
|
|
1105
|
+
let errorDescription = queryParams.get('error_description');
|
|
1106
|
+
let state = queryParams.get('state');
|
|
1107
|
+
|
|
1108
|
+
// Check for error
|
|
1109
|
+
if (error) {
|
|
1110
|
+
query.error = error;
|
|
1111
|
+
if (errorDescription) {
|
|
1112
|
+
query.error_description = errorDescription;
|
|
1113
|
+
}
|
|
1114
|
+
return query;
|
|
1115
|
+
}
|
|
1116
|
+
|
|
1117
|
+
// Everything goes in here because we only want to act if we found an access token
|
|
1118
|
+
if (code) {
|
|
1119
|
+
query.code = code;
|
|
1120
|
+
if (state) {
|
|
1121
|
+
query.state = state;
|
|
1122
|
+
}
|
|
1123
|
+
}
|
|
1124
|
+
|
|
1125
|
+
// Remove code from URL
|
|
1126
|
+
// Credit: https://stackoverflow.com/questions/1397329/how-to-remove-the-hash-from-window-location-with-javascript-without-page-refresh/5298684#5298684
|
|
1127
|
+
var scrollV, scrollH, loc = window.location;
|
|
1128
|
+
if ('replaceState' in history) {
|
|
1129
|
+
history.replaceState('', document.title, loc.pathname);
|
|
1130
|
+
} else {
|
|
1131
|
+
// Prevent scrolling by storing the page's current scroll offset
|
|
1132
|
+
scrollV = document.body.scrollTop;
|
|
1133
|
+
scrollH = document.body.scrollLeft;
|
|
1134
|
+
|
|
1135
|
+
// Remove code
|
|
1136
|
+
history.pushState('', document.title, loc.pathname);
|
|
1137
|
+
|
|
1138
|
+
// Restore the scroll offset, should be flicker free
|
|
1139
|
+
document.body.scrollTop = scrollV;
|
|
1140
|
+
document.body.scrollLeft = scrollH;
|
|
1141
|
+
}
|
|
1142
|
+
|
|
1143
|
+
return query;
|
|
1144
|
+
}
|
|
1145
|
+
|
|
813
1146
|
/**
|
|
814
1147
|
* @description Initiates the Code Authorization. Only available in node apps.
|
|
815
1148
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
@@ -1485,7 +1818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1485
1818
|
/**
|
|
1486
1819
|
* Alerting service.
|
|
1487
1820
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1488
|
-
* @version
|
|
1821
|
+
* @version 186.0.1
|
|
1489
1822
|
*/
|
|
1490
1823
|
|
|
1491
1824
|
/**
|
|
@@ -2146,7 +2479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2146
2479
|
/**
|
|
2147
2480
|
* Analytics service.
|
|
2148
2481
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2149
|
-
* @version
|
|
2482
|
+
* @version 186.0.1
|
|
2150
2483
|
*/
|
|
2151
2484
|
|
|
2152
2485
|
/**
|
|
@@ -4736,7 +5069,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4736
5069
|
/**
|
|
4737
5070
|
* Architect service.
|
|
4738
5071
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4739
|
-
* @version
|
|
5072
|
+
* @version 186.0.1
|
|
4740
5073
|
*/
|
|
4741
5074
|
|
|
4742
5075
|
/**
|
|
@@ -7983,7 +8316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7983
8316
|
|
|
7984
8317
|
/**
|
|
7985
8318
|
* Create a new row entry for the datatable.
|
|
7986
|
-
* Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
8319
|
+
* Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
7987
8320
|
* @param {String} datatableId id of datatable
|
|
7988
8321
|
* @param {Object.<String, {String: Object}>} dataTableRow
|
|
7989
8322
|
*/
|
|
@@ -8475,7 +8808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8475
8808
|
|
|
8476
8809
|
/**
|
|
8477
8810
|
* Update a row entry
|
|
8478
|
-
* Updates a row with the given rowId (the value of the key field) to the new values. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
8811
|
+
* Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
8479
8812
|
* @param {String} datatableId id of datatable
|
|
8480
8813
|
* @param {String} rowId the key for the row
|
|
8481
8814
|
* @param {Object} opts Optional parameters
|
|
@@ -8571,7 +8904,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8571
8904
|
/**
|
|
8572
8905
|
* Audit service.
|
|
8573
8906
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8574
|
-
* @version
|
|
8907
|
+
* @version 186.0.1
|
|
8575
8908
|
*/
|
|
8576
8909
|
|
|
8577
8910
|
/**
|
|
@@ -8742,7 +9075,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8742
9075
|
/**
|
|
8743
9076
|
* Authorization service.
|
|
8744
9077
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8745
|
-
* @version
|
|
9078
|
+
* @version 186.0.1
|
|
8746
9079
|
*/
|
|
8747
9080
|
|
|
8748
9081
|
/**
|
|
@@ -8916,7 +9249,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8916
9249
|
* @param {String} opts.nextPage next page token
|
|
8917
9250
|
* @param {String} opts.previousPage Previous page token
|
|
8918
9251
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
8919
|
-
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
8920
9252
|
* @param {String} opts.name Search term to filter by division name
|
|
8921
9253
|
*/
|
|
8922
9254
|
getAuthorizationDivisions(opts) {
|
|
@@ -8927,7 +9259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8927
9259
|
'/api/v2/authorization/divisions',
|
|
8928
9260
|
'GET',
|
|
8929
9261
|
{ },
|
|
8930
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'
|
|
9262
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'name': opts['name'] },
|
|
8931
9263
|
{ },
|
|
8932
9264
|
{ },
|
|
8933
9265
|
null,
|
|
@@ -9125,7 +9457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9125
9457
|
* Get the organization role specified by its ID.
|
|
9126
9458
|
* @param {String} roleId Role ID
|
|
9127
9459
|
* @param {Object} opts Optional parameters
|
|
9128
|
-
* @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division (default to true)
|
|
9460
|
+
* @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division. Setting this value or defaulting to 'true' can lead to slower load times or timeouts for role queries with large member counts. (default to true)
|
|
9129
9461
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand. unusedPermissions returns the permissions not used for the role
|
|
9130
9462
|
*/
|
|
9131
9463
|
getAuthorizationRole(roleId, opts) {
|
|
@@ -9972,7 +10304,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9972
10304
|
/**
|
|
9973
10305
|
* Billing service.
|
|
9974
10306
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9975
|
-
* @version
|
|
10307
|
+
* @version 186.0.1
|
|
9976
10308
|
*/
|
|
9977
10309
|
|
|
9978
10310
|
/**
|
|
@@ -10052,7 +10384,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10052
10384
|
/**
|
|
10053
10385
|
* CarrierServices service.
|
|
10054
10386
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10055
|
-
* @version
|
|
10387
|
+
* @version 186.0.1
|
|
10056
10388
|
*/
|
|
10057
10389
|
|
|
10058
10390
|
/**
|
|
@@ -10122,7 +10454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10122
10454
|
/**
|
|
10123
10455
|
* Chat service.
|
|
10124
10456
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10125
|
-
* @version
|
|
10457
|
+
* @version 186.0.1
|
|
10126
10458
|
*/
|
|
10127
10459
|
|
|
10128
10460
|
/**
|
|
@@ -10509,6 +10841,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10509
10841
|
);
|
|
10510
10842
|
}
|
|
10511
10843
|
|
|
10844
|
+
/**
|
|
10845
|
+
* Get a user's chat settings
|
|
10846
|
+
*
|
|
10847
|
+
* @param {String} userId User ID
|
|
10848
|
+
* getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10849
|
+
*/
|
|
10850
|
+
getChatsUserSettings(userId) {
|
|
10851
|
+
// verify the required parameter 'userId' is set
|
|
10852
|
+
if (userId === undefined || userId === null) {
|
|
10853
|
+
throw 'Missing the required parameter "userId" when calling getChatsUserSettings';
|
|
10854
|
+
}
|
|
10855
|
+
|
|
10856
|
+
return this.apiClient.callApi(
|
|
10857
|
+
'/api/v2/chats/users/{userId}/settings',
|
|
10858
|
+
'GET',
|
|
10859
|
+
{ 'userId': userId },
|
|
10860
|
+
{ },
|
|
10861
|
+
{ },
|
|
10862
|
+
{ },
|
|
10863
|
+
null,
|
|
10864
|
+
['PureCloud OAuth'],
|
|
10865
|
+
['application/json'],
|
|
10866
|
+
['application/json']
|
|
10867
|
+
);
|
|
10868
|
+
}
|
|
10869
|
+
|
|
10512
10870
|
/**
|
|
10513
10871
|
* Set properties for a room
|
|
10514
10872
|
*
|
|
@@ -10637,6 +10995,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10637
10995
|
);
|
|
10638
10996
|
}
|
|
10639
10997
|
|
|
10998
|
+
/**
|
|
10999
|
+
* Update a user's chat settings
|
|
11000
|
+
*
|
|
11001
|
+
* @param {String} userId User ID
|
|
11002
|
+
* @param {Object} body
|
|
11003
|
+
* patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11004
|
+
*/
|
|
11005
|
+
patchChatsUserSettings(userId, body) {
|
|
11006
|
+
// verify the required parameter 'userId' is set
|
|
11007
|
+
if (userId === undefined || userId === null) {
|
|
11008
|
+
throw 'Missing the required parameter "userId" when calling patchChatsUserSettings';
|
|
11009
|
+
}
|
|
11010
|
+
// verify the required parameter 'body' is set
|
|
11011
|
+
if (body === undefined || body === null) {
|
|
11012
|
+
throw 'Missing the required parameter "body" when calling patchChatsUserSettings';
|
|
11013
|
+
}
|
|
11014
|
+
|
|
11015
|
+
return this.apiClient.callApi(
|
|
11016
|
+
'/api/v2/chats/users/{userId}/settings',
|
|
11017
|
+
'PATCH',
|
|
11018
|
+
{ 'userId': userId },
|
|
11019
|
+
{ },
|
|
11020
|
+
{ },
|
|
11021
|
+
{ },
|
|
11022
|
+
body,
|
|
11023
|
+
['PureCloud OAuth'],
|
|
11024
|
+
['application/json'],
|
|
11025
|
+
['application/json']
|
|
11026
|
+
);
|
|
11027
|
+
}
|
|
11028
|
+
|
|
10640
11029
|
/**
|
|
10641
11030
|
* Send a message to a room
|
|
10642
11031
|
*
|
|
@@ -10818,7 +11207,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10818
11207
|
/**
|
|
10819
11208
|
* Coaching service.
|
|
10820
11209
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
10821
|
-
* @version
|
|
11210
|
+
* @version 186.0.1
|
|
10822
11211
|
*/
|
|
10823
11212
|
|
|
10824
11213
|
/**
|
|
@@ -11395,7 +11784,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11395
11784
|
/**
|
|
11396
11785
|
* ContentManagement service.
|
|
11397
11786
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11398
|
-
* @version
|
|
11787
|
+
* @version 186.0.1
|
|
11399
11788
|
*/
|
|
11400
11789
|
|
|
11401
11790
|
/**
|
|
@@ -11607,41 +11996,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11607
11996
|
);
|
|
11608
11997
|
}
|
|
11609
11998
|
|
|
11610
|
-
/**
|
|
11611
|
-
* Get a list of audits for a document.
|
|
11612
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
11613
|
-
* @param {String} documentId Document ID
|
|
11614
|
-
* @param {Object} opts Optional parameters
|
|
11615
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11616
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11617
|
-
* @param {String} opts.transactionFilter Transaction filter
|
|
11618
|
-
* @param {String} opts.level level (default to USER)
|
|
11619
|
-
* @param {String} opts.sortBy Sort by
|
|
11620
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
11621
|
-
* @deprecated
|
|
11622
|
-
*/
|
|
11623
|
-
getContentmanagementDocumentAudits(documentId, opts) {
|
|
11624
|
-
opts = opts || {};
|
|
11625
|
-
|
|
11626
|
-
// verify the required parameter 'documentId' is set
|
|
11627
|
-
if (documentId === undefined || documentId === null) {
|
|
11628
|
-
throw 'Missing the required parameter "documentId" when calling getContentmanagementDocumentAudits';
|
|
11629
|
-
}
|
|
11630
|
-
|
|
11631
|
-
return this.apiClient.callApi(
|
|
11632
|
-
'/api/v2/contentmanagement/documents/{documentId}/audits',
|
|
11633
|
-
'GET',
|
|
11634
|
-
{ 'documentId': documentId },
|
|
11635
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'transactionFilter': opts['transactionFilter'],'level': opts['level'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
11636
|
-
{ },
|
|
11637
|
-
{ },
|
|
11638
|
-
null,
|
|
11639
|
-
['PureCloud OAuth'],
|
|
11640
|
-
['application/json'],
|
|
11641
|
-
['application/json']
|
|
11642
|
-
);
|
|
11643
|
-
}
|
|
11644
|
-
|
|
11645
11999
|
/**
|
|
11646
12000
|
* Download a document.
|
|
11647
12001
|
*
|
|
@@ -12163,32 +12517,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12163
12517
|
);
|
|
12164
12518
|
}
|
|
12165
12519
|
|
|
12166
|
-
/**
|
|
12167
|
-
* Query audits
|
|
12168
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
12169
|
-
* @param {Object} body Allows for a filtered query returning facet information
|
|
12170
|
-
* @deprecated
|
|
12171
|
-
*/
|
|
12172
|
-
postContentmanagementAuditquery(body) {
|
|
12173
|
-
// verify the required parameter 'body' is set
|
|
12174
|
-
if (body === undefined || body === null) {
|
|
12175
|
-
throw 'Missing the required parameter "body" when calling postContentmanagementAuditquery';
|
|
12176
|
-
}
|
|
12177
|
-
|
|
12178
|
-
return this.apiClient.callApi(
|
|
12179
|
-
'/api/v2/contentmanagement/auditquery',
|
|
12180
|
-
'POST',
|
|
12181
|
-
{ },
|
|
12182
|
-
{ },
|
|
12183
|
-
{ },
|
|
12184
|
-
{ },
|
|
12185
|
-
body,
|
|
12186
|
-
['PureCloud OAuth'],
|
|
12187
|
-
['application/json'],
|
|
12188
|
-
['application/json']
|
|
12189
|
-
);
|
|
12190
|
-
}
|
|
12191
|
-
|
|
12192
12520
|
/**
|
|
12193
12521
|
* Update a document.
|
|
12194
12522
|
*
|
|
@@ -12538,7 +12866,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12538
12866
|
/**
|
|
12539
12867
|
* Conversations service.
|
|
12540
12868
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12541
|
-
* @version
|
|
12869
|
+
* @version 186.0.1
|
|
12542
12870
|
*/
|
|
12543
12871
|
|
|
12544
12872
|
/**
|
|
@@ -19678,7 +20006,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19678
20006
|
/**
|
|
19679
20007
|
* DataExtensions service.
|
|
19680
20008
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
19681
|
-
* @version
|
|
20009
|
+
* @version 186.0.1
|
|
19682
20010
|
*/
|
|
19683
20011
|
|
|
19684
20012
|
/**
|
|
@@ -19764,7 +20092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19764
20092
|
/**
|
|
19765
20093
|
* Downloads service.
|
|
19766
20094
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
19767
|
-
* @version
|
|
20095
|
+
* @version 186.0.1
|
|
19768
20096
|
*/
|
|
19769
20097
|
|
|
19770
20098
|
/**
|
|
@@ -19816,7 +20144,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19816
20144
|
/**
|
|
19817
20145
|
* Emails service.
|
|
19818
20146
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
19819
|
-
* @version
|
|
20147
|
+
* @version 186.0.1
|
|
19820
20148
|
*/
|
|
19821
20149
|
|
|
19822
20150
|
/**
|
|
@@ -19881,7 +20209,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19881
20209
|
/**
|
|
19882
20210
|
* Events service.
|
|
19883
20211
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
19884
|
-
* @version
|
|
20212
|
+
* @version 186.0.1
|
|
19885
20213
|
*/
|
|
19886
20214
|
|
|
19887
20215
|
/**
|
|
@@ -19977,7 +20305,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19977
20305
|
/**
|
|
19978
20306
|
* ExternalContacts service.
|
|
19979
20307
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
19980
|
-
* @version
|
|
20308
|
+
* @version 186.0.1
|
|
19981
20309
|
*/
|
|
19982
20310
|
|
|
19983
20311
|
/**
|
|
@@ -20303,7 +20631,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20303
20631
|
* @param {Object} opts Optional parameters
|
|
20304
20632
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20305
20633
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20306
|
-
* @param {String} opts.sortOrder
|
|
20634
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
20307
20635
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20308
20636
|
*/
|
|
20309
20637
|
getExternalcontactsContactNotes(contactId, opts) {
|
|
@@ -20364,7 +20692,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20364
20692
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20365
20693
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20366
20694
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
20367
|
-
* @param {String} opts.sortOrder
|
|
20695
|
+
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
20368
20696
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20369
20697
|
*/
|
|
20370
20698
|
getExternalcontactsContacts(opts) {
|
|
@@ -20523,7 +20851,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20523
20851
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20524
20852
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20525
20853
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
20526
|
-
* @param {String} opts.sortOrder
|
|
20854
|
+
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
20527
20855
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20528
20856
|
*/
|
|
20529
20857
|
getExternalcontactsOrganizationContacts(externalOrganizationId, opts) {
|
|
@@ -20589,7 +20917,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20589
20917
|
* @param {Object} opts Optional parameters
|
|
20590
20918
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20591
20919
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20592
|
-
* @param {String} opts.sortOrder
|
|
20920
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
20593
20921
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20594
20922
|
*/
|
|
20595
20923
|
getExternalcontactsOrganizationNotes(externalOrganizationId, opts) {
|
|
@@ -20622,7 +20950,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20622
20950
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20623
20951
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20624
20952
|
* @param {Object} opts.expand which fields, if any, to expand
|
|
20625
|
-
* @param {String} opts.sortOrder
|
|
20953
|
+
* @param {String} opts.sortOrder The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. createDate:asc, relationship:desc
|
|
20626
20954
|
*/
|
|
20627
20955
|
getExternalcontactsOrganizationRelationships(externalOrganizationId, opts) {
|
|
20628
20956
|
opts = opts || {};
|
|
@@ -20654,7 +20982,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20654
20982
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20655
20983
|
* @param {String} opts.q Search query
|
|
20656
20984
|
* @param {Array.<String>} opts.trustorId Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested
|
|
20657
|
-
* @param {String} opts.sortOrder
|
|
20985
|
+
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
20658
20986
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20659
20987
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
20660
20988
|
*/
|
|
@@ -21935,7 +22263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21935
22263
|
/**
|
|
21936
22264
|
* Fax service.
|
|
21937
22265
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
21938
|
-
* @version
|
|
22266
|
+
* @version 186.0.1
|
|
21939
22267
|
*/
|
|
21940
22268
|
|
|
21941
22269
|
/**
|
|
@@ -22106,7 +22434,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22106
22434
|
/**
|
|
22107
22435
|
* Flows service.
|
|
22108
22436
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22109
|
-
* @version
|
|
22437
|
+
* @version 186.0.1
|
|
22110
22438
|
*/
|
|
22111
22439
|
|
|
22112
22440
|
/**
|
|
@@ -22290,7 +22618,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22290
22618
|
/**
|
|
22291
22619
|
* Gamification service.
|
|
22292
22620
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22293
|
-
* @version
|
|
22621
|
+
* @version 186.0.1
|
|
22294
22622
|
*/
|
|
22295
22623
|
|
|
22296
22624
|
/**
|
|
@@ -24376,7 +24704,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24376
24704
|
/**
|
|
24377
24705
|
* GeneralDataProtectionRegulation service.
|
|
24378
24706
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24379
|
-
* @version
|
|
24707
|
+
* @version 186.0.1
|
|
24380
24708
|
*/
|
|
24381
24709
|
|
|
24382
24710
|
/**
|
|
@@ -24506,7 +24834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24506
24834
|
/**
|
|
24507
24835
|
* Geolocation service.
|
|
24508
24836
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24509
|
-
* @version
|
|
24837
|
+
* @version 186.0.1
|
|
24510
24838
|
*/
|
|
24511
24839
|
|
|
24512
24840
|
/**
|
|
@@ -24637,7 +24965,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24637
24965
|
/**
|
|
24638
24966
|
* Greetings service.
|
|
24639
24967
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24640
|
-
* @version
|
|
24968
|
+
* @version 186.0.1
|
|
24641
24969
|
*/
|
|
24642
24970
|
|
|
24643
24971
|
/**
|
|
@@ -25092,7 +25420,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25092
25420
|
/**
|
|
25093
25421
|
* Groups service.
|
|
25094
25422
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25095
|
-
* @version
|
|
25423
|
+
* @version 186.0.1
|
|
25096
25424
|
*/
|
|
25097
25425
|
|
|
25098
25426
|
/**
|
|
@@ -25611,7 +25939,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25611
25939
|
/**
|
|
25612
25940
|
* IdentityProvider service.
|
|
25613
25941
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25614
|
-
* @version
|
|
25942
|
+
* @version 186.0.1
|
|
25615
25943
|
*/
|
|
25616
25944
|
|
|
25617
25945
|
/**
|
|
@@ -26367,7 +26695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26367
26695
|
/**
|
|
26368
26696
|
* InfrastructureAsCode service.
|
|
26369
26697
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
26370
|
-
* @version
|
|
26698
|
+
* @version 186.0.1
|
|
26371
26699
|
*/
|
|
26372
26700
|
|
|
26373
26701
|
/**
|
|
@@ -26534,7 +26862,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26534
26862
|
/**
|
|
26535
26863
|
* Integrations service.
|
|
26536
26864
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26537
|
-
* @version
|
|
26865
|
+
* @version 186.0.1
|
|
26538
26866
|
*/
|
|
26539
26867
|
|
|
26540
26868
|
/**
|
|
@@ -27006,6 +27334,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27006
27334
|
);
|
|
27007
27335
|
}
|
|
27008
27336
|
|
|
27337
|
+
/**
|
|
27338
|
+
* Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.
|
|
27339
|
+
*
|
|
27340
|
+
* @param {Object} opts Optional parameters
|
|
27341
|
+
* @param {Object} opts.status Indicates the validity of the certificate in question.
|
|
27342
|
+
* @param {Object} opts.type Indicates the type of the certificate.
|
|
27343
|
+
*/
|
|
27344
|
+
getIntegrationsActionsCertificates(opts) {
|
|
27345
|
+
opts = opts || {};
|
|
27346
|
+
|
|
27347
|
+
|
|
27348
|
+
return this.apiClient.callApi(
|
|
27349
|
+
'/api/v2/integrations/actions/certificates',
|
|
27350
|
+
'GET',
|
|
27351
|
+
{ },
|
|
27352
|
+
{ 'status': opts['status'],'type': opts['type'] },
|
|
27353
|
+
{ },
|
|
27354
|
+
{ },
|
|
27355
|
+
null,
|
|
27356
|
+
['PureCloud OAuth'],
|
|
27357
|
+
['application/json'],
|
|
27358
|
+
['application/json']
|
|
27359
|
+
);
|
|
27360
|
+
}
|
|
27361
|
+
|
|
27009
27362
|
/**
|
|
27010
27363
|
* Retrieves all action drafts associated with the filters passed in via query param.
|
|
27011
27364
|
*
|
|
@@ -28496,7 +28849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28496
28849
|
/**
|
|
28497
28850
|
* Journey service.
|
|
28498
28851
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28499
|
-
* @version
|
|
28852
|
+
* @version 186.0.1
|
|
28500
28853
|
*/
|
|
28501
28854
|
|
|
28502
28855
|
/**
|
|
@@ -29727,7 +30080,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29727
30080
|
/**
|
|
29728
30081
|
* Knowledge service.
|
|
29729
30082
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
29730
|
-
* @version
|
|
30083
|
+
* @version 186.0.1
|
|
29731
30084
|
*/
|
|
29732
30085
|
|
|
29733
30086
|
/**
|
|
@@ -32548,7 +32901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32548
32901
|
/**
|
|
32549
32902
|
* LanguageUnderstanding service.
|
|
32550
32903
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32551
|
-
* @version
|
|
32904
|
+
* @version 186.0.1
|
|
32552
32905
|
*/
|
|
32553
32906
|
|
|
32554
32907
|
/**
|
|
@@ -33561,7 +33914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33561
33914
|
/**
|
|
33562
33915
|
* Languages service.
|
|
33563
33916
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33564
|
-
* @version
|
|
33917
|
+
* @version 186.0.1
|
|
33565
33918
|
*/
|
|
33566
33919
|
|
|
33567
33920
|
/**
|
|
@@ -33783,7 +34136,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33783
34136
|
/**
|
|
33784
34137
|
* Learning service.
|
|
33785
34138
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33786
|
-
* @version
|
|
34139
|
+
* @version 186.0.1
|
|
33787
34140
|
*/
|
|
33788
34141
|
|
|
33789
34142
|
/**
|
|
@@ -34639,7 +34992,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34639
34992
|
/**
|
|
34640
34993
|
* License service.
|
|
34641
34994
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34642
|
-
* @version
|
|
34995
|
+
* @version 186.0.1
|
|
34643
34996
|
*/
|
|
34644
34997
|
|
|
34645
34998
|
/**
|
|
@@ -34877,7 +35230,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34877
35230
|
/**
|
|
34878
35231
|
* Locations service.
|
|
34879
35232
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34880
|
-
* @version
|
|
35233
|
+
* @version 186.0.1
|
|
34881
35234
|
*/
|
|
34882
35235
|
|
|
34883
35236
|
/**
|
|
@@ -35113,7 +35466,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35113
35466
|
/**
|
|
35114
35467
|
* LogCapture service.
|
|
35115
35468
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
35116
|
-
* @version
|
|
35469
|
+
* @version 186.0.1
|
|
35117
35470
|
*/
|
|
35118
35471
|
|
|
35119
35472
|
/**
|
|
@@ -35128,6 +35481,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35128
35481
|
}
|
|
35129
35482
|
|
|
35130
35483
|
|
|
35484
|
+
/**
|
|
35485
|
+
* Disable browser log capture for the user
|
|
35486
|
+
*
|
|
35487
|
+
* @param {String} userId The id of the user to disable browser log capture
|
|
35488
|
+
*/
|
|
35489
|
+
deleteDiagnosticsLogcaptureBrowserUser(userId) {
|
|
35490
|
+
// verify the required parameter 'userId' is set
|
|
35491
|
+
if (userId === undefined || userId === null) {
|
|
35492
|
+
throw 'Missing the required parameter "userId" when calling deleteDiagnosticsLogcaptureBrowserUser';
|
|
35493
|
+
}
|
|
35494
|
+
|
|
35495
|
+
return this.apiClient.callApi(
|
|
35496
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
35497
|
+
'DELETE',
|
|
35498
|
+
{ 'userId': userId },
|
|
35499
|
+
{ },
|
|
35500
|
+
{ },
|
|
35501
|
+
{ },
|
|
35502
|
+
null,
|
|
35503
|
+
['PureCloud OAuth'],
|
|
35504
|
+
['application/json'],
|
|
35505
|
+
['application/json']
|
|
35506
|
+
);
|
|
35507
|
+
}
|
|
35508
|
+
|
|
35131
35509
|
/**
|
|
35132
35510
|
* Gets status of async download execution
|
|
35133
35511
|
*
|
|
@@ -35153,6 +35531,55 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35153
35531
|
);
|
|
35154
35532
|
}
|
|
35155
35533
|
|
|
35534
|
+
/**
|
|
35535
|
+
* Get log capture configuration for the user
|
|
35536
|
+
*
|
|
35537
|
+
* @param {String} userId The id of the user to get browser log capture configuration
|
|
35538
|
+
*/
|
|
35539
|
+
getDiagnosticsLogcaptureBrowserUser(userId) {
|
|
35540
|
+
// verify the required parameter 'userId' is set
|
|
35541
|
+
if (userId === undefined || userId === null) {
|
|
35542
|
+
throw 'Missing the required parameter "userId" when calling getDiagnosticsLogcaptureBrowserUser';
|
|
35543
|
+
}
|
|
35544
|
+
|
|
35545
|
+
return this.apiClient.callApi(
|
|
35546
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
35547
|
+
'GET',
|
|
35548
|
+
{ 'userId': userId },
|
|
35549
|
+
{ },
|
|
35550
|
+
{ },
|
|
35551
|
+
{ },
|
|
35552
|
+
null,
|
|
35553
|
+
['PureCloud OAuth'],
|
|
35554
|
+
['application/json'],
|
|
35555
|
+
['application/json']
|
|
35556
|
+
);
|
|
35557
|
+
}
|
|
35558
|
+
|
|
35559
|
+
/**
|
|
35560
|
+
* Get all log capture enabled users for an org
|
|
35561
|
+
*
|
|
35562
|
+
* @param {Object} opts Optional parameters
|
|
35563
|
+
* @param {Boolean} opts.includeExpired Include expired users with log captures still available for search or download (default to false)
|
|
35564
|
+
*/
|
|
35565
|
+
getDiagnosticsLogcaptureBrowserUsers(opts) {
|
|
35566
|
+
opts = opts || {};
|
|
35567
|
+
|
|
35568
|
+
|
|
35569
|
+
return this.apiClient.callApi(
|
|
35570
|
+
'/api/v2/diagnostics/logcapture/browser/users',
|
|
35571
|
+
'GET',
|
|
35572
|
+
{ },
|
|
35573
|
+
{ 'includeExpired': opts['includeExpired'] },
|
|
35574
|
+
{ },
|
|
35575
|
+
{ },
|
|
35576
|
+
null,
|
|
35577
|
+
['PureCloud OAuth'],
|
|
35578
|
+
['application/json'],
|
|
35579
|
+
['application/json']
|
|
35580
|
+
);
|
|
35581
|
+
}
|
|
35582
|
+
|
|
35156
35583
|
/**
|
|
35157
35584
|
* Creates an async download execution
|
|
35158
35585
|
*
|
|
@@ -35177,13 +35604,69 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35177
35604
|
);
|
|
35178
35605
|
}
|
|
35179
35606
|
|
|
35607
|
+
/**
|
|
35608
|
+
* Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.
|
|
35609
|
+
*
|
|
35610
|
+
* @param {Object} opts Optional parameters
|
|
35611
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
35612
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
35613
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
35614
|
+
* @param {Object} opts.body
|
|
35615
|
+
*/
|
|
35616
|
+
postDiagnosticsLogcaptureBrowserEntriesQuery(opts) {
|
|
35617
|
+
opts = opts || {};
|
|
35618
|
+
|
|
35619
|
+
|
|
35620
|
+
return this.apiClient.callApi(
|
|
35621
|
+
'/api/v2/diagnostics/logcapture/browser/entries/query',
|
|
35622
|
+
'POST',
|
|
35623
|
+
{ },
|
|
35624
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
35625
|
+
{ },
|
|
35626
|
+
{ },
|
|
35627
|
+
opts['body'],
|
|
35628
|
+
['PureCloud OAuth'],
|
|
35629
|
+
['application/json'],
|
|
35630
|
+
['application/json']
|
|
35631
|
+
);
|
|
35632
|
+
}
|
|
35633
|
+
|
|
35634
|
+
/**
|
|
35635
|
+
* Enable log capture for a user or update expiration
|
|
35636
|
+
*
|
|
35637
|
+
* @param {String} userId The id of the user to enable browser log capture
|
|
35638
|
+
* @param {Object} opts Optional parameters
|
|
35639
|
+
* @param {Object} opts.body
|
|
35640
|
+
*/
|
|
35641
|
+
postDiagnosticsLogcaptureBrowserUser(userId, opts) {
|
|
35642
|
+
opts = opts || {};
|
|
35643
|
+
|
|
35644
|
+
// verify the required parameter 'userId' is set
|
|
35645
|
+
if (userId === undefined || userId === null) {
|
|
35646
|
+
throw 'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';
|
|
35647
|
+
}
|
|
35648
|
+
|
|
35649
|
+
return this.apiClient.callApi(
|
|
35650
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
35651
|
+
'POST',
|
|
35652
|
+
{ 'userId': userId },
|
|
35653
|
+
{ },
|
|
35654
|
+
{ },
|
|
35655
|
+
{ },
|
|
35656
|
+
opts['body'],
|
|
35657
|
+
['PureCloud OAuth'],
|
|
35658
|
+
['application/json'],
|
|
35659
|
+
['application/json']
|
|
35660
|
+
);
|
|
35661
|
+
}
|
|
35662
|
+
|
|
35180
35663
|
}
|
|
35181
35664
|
|
|
35182
35665
|
class MessagingApi {
|
|
35183
35666
|
/**
|
|
35184
35667
|
* Messaging service.
|
|
35185
35668
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
35186
|
-
* @version
|
|
35669
|
+
* @version 186.0.1
|
|
35187
35670
|
*/
|
|
35188
35671
|
|
|
35189
35672
|
/**
|
|
@@ -35542,7 +36025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35542
36025
|
/**
|
|
35543
36026
|
* MobileDevices service.
|
|
35544
36027
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
35545
|
-
* @version
|
|
36028
|
+
* @version 186.0.1
|
|
35546
36029
|
*/
|
|
35547
36030
|
|
|
35548
36031
|
/**
|
|
@@ -35693,7 +36176,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35693
36176
|
/**
|
|
35694
36177
|
* Notifications service.
|
|
35695
36178
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
35696
|
-
* @version
|
|
36179
|
+
* @version 186.0.1
|
|
35697
36180
|
*/
|
|
35698
36181
|
|
|
35699
36182
|
/**
|
|
@@ -35926,7 +36409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35926
36409
|
/**
|
|
35927
36410
|
* OAuth service.
|
|
35928
36411
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
35929
|
-
* @version
|
|
36412
|
+
* @version 186.0.1
|
|
35930
36413
|
*/
|
|
35931
36414
|
|
|
35932
36415
|
/**
|
|
@@ -36292,7 +36775,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36292
36775
|
/**
|
|
36293
36776
|
* Objects service.
|
|
36294
36777
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
36295
|
-
* @version
|
|
36778
|
+
* @version 186.0.1
|
|
36296
36779
|
*/
|
|
36297
36780
|
|
|
36298
36781
|
/**
|
|
@@ -36376,7 +36859,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36376
36859
|
* @param {String} opts.nextPage next page token
|
|
36377
36860
|
* @param {String} opts.previousPage Previous page token
|
|
36378
36861
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
36379
|
-
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
36380
36862
|
* @param {String} opts.name Search term to filter by division name
|
|
36381
36863
|
*/
|
|
36382
36864
|
getAuthorizationDivisions(opts) {
|
|
@@ -36387,7 +36869,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36387
36869
|
'/api/v2/authorization/divisions',
|
|
36388
36870
|
'GET',
|
|
36389
36871
|
{ },
|
|
36390
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'
|
|
36872
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'name': opts['name'] },
|
|
36391
36873
|
{ },
|
|
36392
36874
|
{ },
|
|
36393
36875
|
null,
|
|
@@ -36562,7 +37044,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36562
37044
|
/**
|
|
36563
37045
|
* OperationalEvents service.
|
|
36564
37046
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
36565
|
-
* @version
|
|
37047
|
+
* @version 186.0.1
|
|
36566
37048
|
*/
|
|
36567
37049
|
|
|
36568
37050
|
/**
|
|
@@ -36628,7 +37110,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36628
37110
|
/**
|
|
36629
37111
|
* Organization service.
|
|
36630
37112
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
36631
|
-
* @version
|
|
37113
|
+
* @version 186.0.1
|
|
36632
37114
|
*/
|
|
36633
37115
|
|
|
36634
37116
|
/**
|
|
@@ -37083,7 +37565,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37083
37565
|
/**
|
|
37084
37566
|
* OrganizationAuthorization service.
|
|
37085
37567
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
37086
|
-
* @version
|
|
37568
|
+
* @version 186.0.1
|
|
37087
37569
|
*/
|
|
37088
37570
|
|
|
37089
37571
|
/**
|
|
@@ -38430,7 +38912,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38430
38912
|
/**
|
|
38431
38913
|
* Outbound service.
|
|
38432
38914
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38433
|
-
* @version
|
|
38915
|
+
* @version 186.0.1
|
|
38434
38916
|
*/
|
|
38435
38917
|
|
|
38436
38918
|
/**
|
|
@@ -42452,7 +42934,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42452
42934
|
/**
|
|
42453
42935
|
* Presence service.
|
|
42454
42936
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
42455
|
-
* @version
|
|
42937
|
+
* @version 186.0.1
|
|
42456
42938
|
*/
|
|
42457
42939
|
|
|
42458
42940
|
/**
|
|
@@ -43191,7 +43673,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43191
43673
|
/**
|
|
43192
43674
|
* ProcessAutomation service.
|
|
43193
43675
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
43194
|
-
* @version
|
|
43676
|
+
* @version 186.0.1
|
|
43195
43677
|
*/
|
|
43196
43678
|
|
|
43197
43679
|
/**
|
|
@@ -43430,7 +43912,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43430
43912
|
/**
|
|
43431
43913
|
* Quality service.
|
|
43432
43914
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
43433
|
-
* @version
|
|
43915
|
+
* @version 186.0.1
|
|
43434
43916
|
*/
|
|
43435
43917
|
|
|
43436
43918
|
/**
|
|
@@ -45023,7 +45505,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45023
45505
|
|
|
45024
45506
|
/**
|
|
45025
45507
|
* Update an evaluation
|
|
45026
|
-
* The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.
|
|
45508
|
+
* The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.
|
|
45027
45509
|
* @param {String} conversationId conversationId
|
|
45028
45510
|
* @param {String} evaluationId evaluationId
|
|
45029
45511
|
* @param {Object} body evaluation
|
|
@@ -45187,7 +45669,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45187
45669
|
/**
|
|
45188
45670
|
* Recording service.
|
|
45189
45671
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
45190
|
-
* @version
|
|
45672
|
+
* @version 186.0.1
|
|
45191
45673
|
*/
|
|
45192
45674
|
|
|
45193
45675
|
/**
|
|
@@ -46824,7 +47306,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46824
47306
|
/**
|
|
46825
47307
|
* ResponseManagement service.
|
|
46826
47308
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46827
|
-
* @version
|
|
47309
|
+
* @version 186.0.1
|
|
46828
47310
|
*/
|
|
46829
47311
|
|
|
46830
47312
|
/**
|
|
@@ -47309,7 +47791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47309
47791
|
/**
|
|
47310
47792
|
* Routing service.
|
|
47311
47793
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
47312
|
-
* @version
|
|
47794
|
+
* @version 186.0.1
|
|
47313
47795
|
*/
|
|
47314
47796
|
|
|
47315
47797
|
/**
|
|
@@ -47764,6 +48246,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47764
48246
|
);
|
|
47765
48247
|
}
|
|
47766
48248
|
|
|
48249
|
+
/**
|
|
48250
|
+
* Delete a utilization label
|
|
48251
|
+
*
|
|
48252
|
+
* @param {String} labelId Utilization Label ID
|
|
48253
|
+
* @param {Object} opts Optional parameters
|
|
48254
|
+
* @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
|
|
48255
|
+
* deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48256
|
+
*/
|
|
48257
|
+
deleteRoutingUtilizationLabel(labelId, opts) {
|
|
48258
|
+
opts = opts || {};
|
|
48259
|
+
|
|
48260
|
+
// verify the required parameter 'labelId' is set
|
|
48261
|
+
if (labelId === undefined || labelId === null) {
|
|
48262
|
+
throw 'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';
|
|
48263
|
+
}
|
|
48264
|
+
|
|
48265
|
+
return this.apiClient.callApi(
|
|
48266
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
48267
|
+
'DELETE',
|
|
48268
|
+
{ 'labelId': labelId },
|
|
48269
|
+
{ 'forceDelete': opts['forceDelete'] },
|
|
48270
|
+
{ },
|
|
48271
|
+
{ },
|
|
48272
|
+
null,
|
|
48273
|
+
['PureCloud OAuth'],
|
|
48274
|
+
['application/json'],
|
|
48275
|
+
['application/json']
|
|
48276
|
+
);
|
|
48277
|
+
}
|
|
48278
|
+
|
|
47767
48279
|
/**
|
|
47768
48280
|
* Delete an utilization tag
|
|
47769
48281
|
*
|
|
@@ -49254,6 +49766,86 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49254
49766
|
);
|
|
49255
49767
|
}
|
|
49256
49768
|
|
|
49769
|
+
/**
|
|
49770
|
+
* Get details about this utilization label
|
|
49771
|
+
*
|
|
49772
|
+
* @param {String} labelId Utilization Label ID
|
|
49773
|
+
* getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49774
|
+
*/
|
|
49775
|
+
getRoutingUtilizationLabel(labelId) {
|
|
49776
|
+
// verify the required parameter 'labelId' is set
|
|
49777
|
+
if (labelId === undefined || labelId === null) {
|
|
49778
|
+
throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';
|
|
49779
|
+
}
|
|
49780
|
+
|
|
49781
|
+
return this.apiClient.callApi(
|
|
49782
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
49783
|
+
'GET',
|
|
49784
|
+
{ 'labelId': labelId },
|
|
49785
|
+
{ },
|
|
49786
|
+
{ },
|
|
49787
|
+
{ },
|
|
49788
|
+
null,
|
|
49789
|
+
['PureCloud OAuth'],
|
|
49790
|
+
['application/json'],
|
|
49791
|
+
['application/json']
|
|
49792
|
+
);
|
|
49793
|
+
}
|
|
49794
|
+
|
|
49795
|
+
/**
|
|
49796
|
+
* Get list of agent ids associated with a utilization label
|
|
49797
|
+
*
|
|
49798
|
+
* @param {String} labelId Utilization Label ID
|
|
49799
|
+
* getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49800
|
+
*/
|
|
49801
|
+
getRoutingUtilizationLabelAgents(labelId) {
|
|
49802
|
+
// verify the required parameter 'labelId' is set
|
|
49803
|
+
if (labelId === undefined || labelId === null) {
|
|
49804
|
+
throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';
|
|
49805
|
+
}
|
|
49806
|
+
|
|
49807
|
+
return this.apiClient.callApi(
|
|
49808
|
+
'/api/v2/routing/utilization/labels/{labelId}/agents',
|
|
49809
|
+
'GET',
|
|
49810
|
+
{ 'labelId': labelId },
|
|
49811
|
+
{ },
|
|
49812
|
+
{ },
|
|
49813
|
+
{ },
|
|
49814
|
+
null,
|
|
49815
|
+
['PureCloud OAuth'],
|
|
49816
|
+
['application/json'],
|
|
49817
|
+
['application/json']
|
|
49818
|
+
);
|
|
49819
|
+
}
|
|
49820
|
+
|
|
49821
|
+
/**
|
|
49822
|
+
* Get list of utilization labels
|
|
49823
|
+
*
|
|
49824
|
+
* @param {Object} opts Optional parameters
|
|
49825
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
49826
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
49827
|
+
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
49828
|
+
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
49829
|
+
* getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49830
|
+
*/
|
|
49831
|
+
getRoutingUtilizationLabels(opts) {
|
|
49832
|
+
opts = opts || {};
|
|
49833
|
+
|
|
49834
|
+
|
|
49835
|
+
return this.apiClient.callApi(
|
|
49836
|
+
'/api/v2/routing/utilization/labels',
|
|
49837
|
+
'GET',
|
|
49838
|
+
{ },
|
|
49839
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
49840
|
+
{ },
|
|
49841
|
+
{ },
|
|
49842
|
+
null,
|
|
49843
|
+
['PureCloud OAuth'],
|
|
49844
|
+
['application/json'],
|
|
49845
|
+
['application/json']
|
|
49846
|
+
);
|
|
49847
|
+
}
|
|
49848
|
+
|
|
49257
49849
|
/**
|
|
49258
49850
|
* Get details about this utilization tag
|
|
49259
49851
|
*
|
|
@@ -49389,6 +49981,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49389
49981
|
);
|
|
49390
49982
|
}
|
|
49391
49983
|
|
|
49984
|
+
/**
|
|
49985
|
+
* Get a simplified wrap-up code.
|
|
49986
|
+
*
|
|
49987
|
+
* @param {String} codeId Wrapup Code ID
|
|
49988
|
+
*/
|
|
49989
|
+
getRoutingWrapupcodesDivisionview(codeId) {
|
|
49990
|
+
// verify the required parameter 'codeId' is set
|
|
49991
|
+
if (codeId === undefined || codeId === null) {
|
|
49992
|
+
throw 'Missing the required parameter "codeId" when calling getRoutingWrapupcodesDivisionview';
|
|
49993
|
+
}
|
|
49994
|
+
|
|
49995
|
+
return this.apiClient.callApi(
|
|
49996
|
+
'/api/v2/routing/wrapupcodes/divisionviews/{codeId}',
|
|
49997
|
+
'GET',
|
|
49998
|
+
{ 'codeId': codeId },
|
|
49999
|
+
{ },
|
|
50000
|
+
{ },
|
|
50001
|
+
{ },
|
|
50002
|
+
null,
|
|
50003
|
+
['PureCloud OAuth'],
|
|
50004
|
+
['application/json'],
|
|
50005
|
+
['application/json']
|
|
50006
|
+
);
|
|
50007
|
+
}
|
|
50008
|
+
|
|
50009
|
+
/**
|
|
50010
|
+
* Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).
|
|
50011
|
+
* Specifying both name and ID parameters is not supported.
|
|
50012
|
+
* @param {Object} opts Optional parameters
|
|
50013
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
50014
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
50015
|
+
* @param {String} opts.name Name (trailing asterisks allowed)
|
|
50016
|
+
* @param {Array.<String>} opts.id Wrapup code ID(s)
|
|
50017
|
+
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
50018
|
+
* @param {Object} opts.includeState Wrapup code state(s) to include
|
|
50019
|
+
*/
|
|
50020
|
+
getRoutingWrapupcodesDivisionviews(opts) {
|
|
50021
|
+
opts = opts || {};
|
|
50022
|
+
|
|
50023
|
+
|
|
50024
|
+
return this.apiClient.callApi(
|
|
50025
|
+
'/api/v2/routing/wrapupcodes/divisionviews',
|
|
50026
|
+
'GET',
|
|
50027
|
+
{ },
|
|
50028
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'includeState': opts['includeState'] },
|
|
50029
|
+
{ },
|
|
50030
|
+
{ },
|
|
50031
|
+
null,
|
|
50032
|
+
['PureCloud OAuth'],
|
|
50033
|
+
['application/json'],
|
|
50034
|
+
['application/json']
|
|
50035
|
+
);
|
|
50036
|
+
}
|
|
50037
|
+
|
|
49392
50038
|
/**
|
|
49393
50039
|
* Get queues for user
|
|
49394
50040
|
*
|
|
@@ -49790,6 +50436,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49790
50436
|
);
|
|
49791
50437
|
}
|
|
49792
50438
|
|
|
50439
|
+
/**
|
|
50440
|
+
* Patch Transcription Settings
|
|
50441
|
+
*
|
|
50442
|
+
* @param {Object} body Organization Settings
|
|
50443
|
+
*/
|
|
50444
|
+
patchRoutingSettingsTranscription(body) {
|
|
50445
|
+
// verify the required parameter 'body' is set
|
|
50446
|
+
if (body === undefined || body === null) {
|
|
50447
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSettingsTranscription';
|
|
50448
|
+
}
|
|
50449
|
+
|
|
50450
|
+
return this.apiClient.callApi(
|
|
50451
|
+
'/api/v2/routing/settings/transcription',
|
|
50452
|
+
'PATCH',
|
|
50453
|
+
{ },
|
|
50454
|
+
{ },
|
|
50455
|
+
{ },
|
|
50456
|
+
{ },
|
|
50457
|
+
body,
|
|
50458
|
+
['PureCloud OAuth'],
|
|
50459
|
+
['application/json'],
|
|
50460
|
+
['application/json']
|
|
50461
|
+
);
|
|
50462
|
+
}
|
|
50463
|
+
|
|
49793
50464
|
/**
|
|
49794
50465
|
* Update skill group definition
|
|
49795
50466
|
*
|
|
@@ -50528,7 +51199,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50528
51199
|
* Imports a phone number for SMS
|
|
50529
51200
|
*
|
|
50530
51201
|
* @param {Object} body SmsPhoneNumber
|
|
50531
|
-
* postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
50532
51202
|
*/
|
|
50533
51203
|
postRoutingSmsPhonenumbersImport(body) {
|
|
50534
51204
|
// verify the required parameter 'body' is set
|
|
@@ -50550,6 +51220,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50550
51220
|
);
|
|
50551
51221
|
}
|
|
50552
51222
|
|
|
51223
|
+
/**
|
|
51224
|
+
* Create a utilization label
|
|
51225
|
+
*
|
|
51226
|
+
* @param {Object} body UtilizationLabel
|
|
51227
|
+
* postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51228
|
+
*/
|
|
51229
|
+
postRoutingUtilizationLabels(body) {
|
|
51230
|
+
// verify the required parameter 'body' is set
|
|
51231
|
+
if (body === undefined || body === null) {
|
|
51232
|
+
throw 'Missing the required parameter "body" when calling postRoutingUtilizationLabels';
|
|
51233
|
+
}
|
|
51234
|
+
|
|
51235
|
+
return this.apiClient.callApi(
|
|
51236
|
+
'/api/v2/routing/utilization/labels',
|
|
51237
|
+
'POST',
|
|
51238
|
+
{ },
|
|
51239
|
+
{ },
|
|
51240
|
+
{ },
|
|
51241
|
+
{ },
|
|
51242
|
+
body,
|
|
51243
|
+
['PureCloud OAuth'],
|
|
51244
|
+
['application/json'],
|
|
51245
|
+
['application/json']
|
|
51246
|
+
);
|
|
51247
|
+
}
|
|
51248
|
+
|
|
50553
51249
|
/**
|
|
50554
51250
|
* Create an utilization tag
|
|
50555
51251
|
*
|
|
@@ -50916,6 +51612,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50916
51612
|
);
|
|
50917
51613
|
}
|
|
50918
51614
|
|
|
51615
|
+
/**
|
|
51616
|
+
* Update a utilization label
|
|
51617
|
+
*
|
|
51618
|
+
* @param {String} labelId Utilization Label ID
|
|
51619
|
+
* @param {Object} body UtilizationLabel
|
|
51620
|
+
* putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51621
|
+
*/
|
|
51622
|
+
putRoutingUtilizationLabel(labelId, body) {
|
|
51623
|
+
// verify the required parameter 'labelId' is set
|
|
51624
|
+
if (labelId === undefined || labelId === null) {
|
|
51625
|
+
throw 'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';
|
|
51626
|
+
}
|
|
51627
|
+
// verify the required parameter 'body' is set
|
|
51628
|
+
if (body === undefined || body === null) {
|
|
51629
|
+
throw 'Missing the required parameter "body" when calling putRoutingUtilizationLabel';
|
|
51630
|
+
}
|
|
51631
|
+
|
|
51632
|
+
return this.apiClient.callApi(
|
|
51633
|
+
'/api/v2/routing/utilization/labels/{labelId}',
|
|
51634
|
+
'PUT',
|
|
51635
|
+
{ 'labelId': labelId },
|
|
51636
|
+
{ },
|
|
51637
|
+
{ },
|
|
51638
|
+
{ },
|
|
51639
|
+
body,
|
|
51640
|
+
['PureCloud OAuth'],
|
|
51641
|
+
['application/json'],
|
|
51642
|
+
['application/json']
|
|
51643
|
+
);
|
|
51644
|
+
}
|
|
51645
|
+
|
|
50919
51646
|
/**
|
|
50920
51647
|
* Update wrap-up code
|
|
50921
51648
|
*
|
|
@@ -51017,7 +51744,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51017
51744
|
/**
|
|
51018
51745
|
* SCIM service.
|
|
51019
51746
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
51020
|
-
* @version
|
|
51747
|
+
* @version 186.0.1
|
|
51021
51748
|
*/
|
|
51022
51749
|
|
|
51023
51750
|
/**
|
|
@@ -51894,7 +52621,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51894
52621
|
/**
|
|
51895
52622
|
* Scripts service.
|
|
51896
52623
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51897
|
-
* @version
|
|
52624
|
+
* @version 186.0.1
|
|
51898
52625
|
*/
|
|
51899
52626
|
|
|
51900
52627
|
/**
|
|
@@ -52338,7 +53065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52338
53065
|
/**
|
|
52339
53066
|
* Search service.
|
|
52340
53067
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
52341
|
-
* @version
|
|
53068
|
+
* @version 186.0.1
|
|
52342
53069
|
*/
|
|
52343
53070
|
|
|
52344
53071
|
/**
|
|
@@ -53027,7 +53754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53027
53754
|
/**
|
|
53028
53755
|
* Settings service.
|
|
53029
53756
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
53030
|
-
* @version
|
|
53757
|
+
* @version 186.0.1
|
|
53031
53758
|
*/
|
|
53032
53759
|
|
|
53033
53760
|
/**
|
|
@@ -53092,7 +53819,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53092
53819
|
/**
|
|
53093
53820
|
* SpeechTextAnalytics service.
|
|
53094
53821
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
53095
|
-
* @version
|
|
53822
|
+
* @version 186.0.1
|
|
53096
53823
|
*/
|
|
53097
53824
|
|
|
53098
53825
|
/**
|
|
@@ -54205,7 +54932,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54205
54932
|
/**
|
|
54206
54933
|
* Stations service.
|
|
54207
54934
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
54208
|
-
* @version
|
|
54935
|
+
* @version 186.0.1
|
|
54209
54936
|
*/
|
|
54210
54937
|
|
|
54211
54938
|
/**
|
|
@@ -54307,7 +55034,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54307
55034
|
/**
|
|
54308
55035
|
* Suggest service.
|
|
54309
55036
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
54310
|
-
* @version
|
|
55037
|
+
* @version 186.0.1
|
|
54311
55038
|
*/
|
|
54312
55039
|
|
|
54313
55040
|
/**
|
|
@@ -54446,7 +55173,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54446
55173
|
/**
|
|
54447
55174
|
* TaskManagement service.
|
|
54448
55175
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
54449
|
-
* @version
|
|
55176
|
+
* @version 186.0.1
|
|
54450
55177
|
*/
|
|
54451
55178
|
|
|
54452
55179
|
/**
|
|
@@ -55727,7 +56454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55727
56454
|
/**
|
|
55728
56455
|
* Teams service.
|
|
55729
56456
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
55730
|
-
* @version
|
|
56457
|
+
* @version 186.0.1
|
|
55731
56458
|
*/
|
|
55732
56459
|
|
|
55733
56460
|
/**
|
|
@@ -56029,7 +56756,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56029
56756
|
/**
|
|
56030
56757
|
* Telephony service.
|
|
56031
56758
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
56032
|
-
* @version
|
|
56759
|
+
* @version 186.0.1
|
|
56033
56760
|
*/
|
|
56034
56761
|
|
|
56035
56762
|
/**
|
|
@@ -56068,7 +56795,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56068
56795
|
* Get a SIP message.
|
|
56069
56796
|
* Get the raw form of the SIP message
|
|
56070
56797
|
* @param {String} conversationId Conversation id
|
|
56071
|
-
* getTelephonySipmessagesConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56072
56798
|
*/
|
|
56073
56799
|
getTelephonySipmessagesConversation(conversationId) {
|
|
56074
56800
|
// verify the required parameter 'conversationId' is set
|
|
@@ -56096,7 +56822,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56096
56822
|
* @param {String} conversationId Conversation id
|
|
56097
56823
|
* @param {Object} opts Optional parameters
|
|
56098
56824
|
* @param {Array.<String>} opts.keys comma-separated list of header identifiers to query. e.g. ruri,to,from
|
|
56099
|
-
* getTelephonySipmessagesConversationHeaders is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56100
56825
|
*/
|
|
56101
56826
|
getTelephonySipmessagesConversationHeaders(conversationId, opts) {
|
|
56102
56827
|
opts = opts || {};
|
|
@@ -56213,7 +56938,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56213
56938
|
/**
|
|
56214
56939
|
* TelephonyProvidersEdge service.
|
|
56215
56940
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
56216
|
-
* @version
|
|
56941
|
+
* @version 186.0.1
|
|
56217
56942
|
*/
|
|
56218
56943
|
|
|
56219
56944
|
/**
|
|
@@ -56981,8 +57706,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56981
57706
|
}
|
|
56982
57707
|
|
|
56983
57708
|
/**
|
|
56984
|
-
* Get the list of available languages.
|
|
57709
|
+
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
56985
57710
|
*
|
|
57711
|
+
* @deprecated
|
|
56986
57712
|
*/
|
|
56987
57713
|
getTelephonyProvidersEdgesAvailablelanguages() {
|
|
56988
57714
|
|
|
@@ -57401,7 +58127,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57401
58127
|
* @param {Array.<String>} opts.id ID of the Extension Pools to filter by.
|
|
57402
58128
|
* @param {String} opts.name Name of the Extension Pools to filter by.
|
|
57403
58129
|
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
57404
|
-
* getTelephonyProvidersEdgesExtensionpoolsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57405
58130
|
*/
|
|
57406
58131
|
getTelephonyProvidersEdgesExtensionpoolsDivisionviews(opts) {
|
|
57407
58132
|
opts = opts || {};
|
|
@@ -58173,6 +58898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58173
58898
|
* @param {String} opts.name Name
|
|
58174
58899
|
* @param {String} opts.locationId Location Id
|
|
58175
58900
|
* @param {Boolean} opts.managed Filter by managed
|
|
58901
|
+
* @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
|
|
58176
58902
|
*/
|
|
58177
58903
|
getTelephonyProvidersEdgesSites(opts) {
|
|
58178
58904
|
opts = opts || {};
|
|
@@ -58182,7 +58908,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58182
58908
|
'/api/v2/telephony/providers/edges/sites',
|
|
58183
58909
|
'GET',
|
|
58184
58910
|
{ },
|
|
58185
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'location.id': opts['locationId'],'managed': opts['managed'] },
|
|
58911
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'location.id': opts['locationId'],'managed': opts['managed'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
58186
58912
|
{ },
|
|
58187
58913
|
{ },
|
|
58188
58914
|
null,
|
|
@@ -59587,7 +60313,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59587
60313
|
/**
|
|
59588
60314
|
* Textbots service.
|
|
59589
60315
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
59590
|
-
* @version
|
|
60316
|
+
* @version 186.0.1
|
|
59591
60317
|
*/
|
|
59592
60318
|
|
|
59593
60319
|
/**
|
|
@@ -59715,7 +60441,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59715
60441
|
/**
|
|
59716
60442
|
* Tokens service.
|
|
59717
60443
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
59718
|
-
* @version
|
|
60444
|
+
* @version 186.0.1
|
|
59719
60445
|
*/
|
|
59720
60446
|
|
|
59721
60447
|
/**
|
|
@@ -59871,7 +60597,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59871
60597
|
/**
|
|
59872
60598
|
* Uploads service.
|
|
59873
60599
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
59874
|
-
* @version
|
|
60600
|
+
* @version 186.0.1
|
|
59875
60601
|
*/
|
|
59876
60602
|
|
|
59877
60603
|
/**
|
|
@@ -60047,7 +60773,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60047
60773
|
/**
|
|
60048
60774
|
* Usage service.
|
|
60049
60775
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
60050
|
-
* @version
|
|
60776
|
+
* @version 186.0.1
|
|
60051
60777
|
*/
|
|
60052
60778
|
|
|
60053
60779
|
/**
|
|
@@ -60257,7 +60983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60257
60983
|
/**
|
|
60258
60984
|
* UserRecordings service.
|
|
60259
60985
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
60260
|
-
* @version
|
|
60986
|
+
* @version 186.0.1
|
|
60261
60987
|
*/
|
|
60262
60988
|
|
|
60263
60989
|
/**
|
|
@@ -60442,7 +61168,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60442
61168
|
/**
|
|
60443
61169
|
* Users service.
|
|
60444
61170
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
60445
|
-
* @version
|
|
61171
|
+
* @version 186.0.1
|
|
60446
61172
|
*/
|
|
60447
61173
|
|
|
60448
61174
|
/**
|
|
@@ -63093,7 +63819,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63093
63819
|
/**
|
|
63094
63820
|
* Utilities service.
|
|
63095
63821
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
63096
|
-
* @version
|
|
63822
|
+
* @version 186.0.1
|
|
63097
63823
|
*/
|
|
63098
63824
|
|
|
63099
63825
|
/**
|
|
@@ -63204,7 +63930,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63204
63930
|
/**
|
|
63205
63931
|
* Voicemail service.
|
|
63206
63932
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
63207
|
-
* @version
|
|
63933
|
+
* @version 186.0.1
|
|
63208
63934
|
*/
|
|
63209
63935
|
|
|
63210
63936
|
/**
|
|
@@ -63871,7 +64597,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63871
64597
|
/**
|
|
63872
64598
|
* WebChat service.
|
|
63873
64599
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
63874
|
-
* @version
|
|
64600
|
+
* @version 186.0.1
|
|
63875
64601
|
*/
|
|
63876
64602
|
|
|
63877
64603
|
/**
|
|
@@ -64420,7 +65146,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64420
65146
|
/**
|
|
64421
65147
|
* WebDeployments service.
|
|
64422
65148
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
64423
|
-
* @version
|
|
65149
|
+
* @version 186.0.1
|
|
64424
65150
|
*/
|
|
64425
65151
|
|
|
64426
65152
|
/**
|
|
@@ -64947,7 +65673,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64947
65673
|
/**
|
|
64948
65674
|
* WebMessaging service.
|
|
64949
65675
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
64950
|
-
* @version
|
|
65676
|
+
* @version 186.0.1
|
|
64951
65677
|
*/
|
|
64952
65678
|
|
|
64953
65679
|
/**
|
|
@@ -64993,7 +65719,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64993
65719
|
/**
|
|
64994
65720
|
* Widgets service.
|
|
64995
65721
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
64996
|
-
* @version
|
|
65722
|
+
* @version 186.0.1
|
|
64997
65723
|
*/
|
|
64998
65724
|
|
|
64999
65725
|
/**
|
|
@@ -65139,7 +65865,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65139
65865
|
/**
|
|
65140
65866
|
* WorkforceManagement service.
|
|
65141
65867
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
65142
|
-
* @version
|
|
65868
|
+
* @version 186.0.1
|
|
65143
65869
|
*/
|
|
65144
65870
|
|
|
65145
65871
|
/**
|
|
@@ -66273,6 +66999,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66273
66999
|
);
|
|
66274
67000
|
}
|
|
66275
67001
|
|
|
67002
|
+
/**
|
|
67003
|
+
* Get the performance prediction for the associated schedule
|
|
67004
|
+
*
|
|
67005
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
67006
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
67007
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
67008
|
+
*/
|
|
67009
|
+
getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(businessUnitId, weekId, scheduleId) {
|
|
67010
|
+
// verify the required parameter 'businessUnitId' is set
|
|
67011
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
67012
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
67013
|
+
}
|
|
67014
|
+
// verify the required parameter 'weekId' is set
|
|
67015
|
+
if (weekId === undefined || weekId === null) {
|
|
67016
|
+
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
67017
|
+
}
|
|
67018
|
+
// verify the required parameter 'scheduleId' is set
|
|
67019
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
67020
|
+
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';
|
|
67021
|
+
}
|
|
67022
|
+
|
|
67023
|
+
return this.apiClient.callApi(
|
|
67024
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions',
|
|
67025
|
+
'GET',
|
|
67026
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
67027
|
+
{ },
|
|
67028
|
+
{ },
|
|
67029
|
+
{ },
|
|
67030
|
+
null,
|
|
67031
|
+
['PureCloud OAuth'],
|
|
67032
|
+
['application/json'],
|
|
67033
|
+
['application/json']
|
|
67034
|
+
);
|
|
67035
|
+
}
|
|
67036
|
+
|
|
67037
|
+
/**
|
|
67038
|
+
* Get recalculated performance prediction result
|
|
67039
|
+
*
|
|
67040
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
67041
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
67042
|
+
* @param {String} scheduleId The ID of the schedule the recalculation belongs to
|
|
67043
|
+
* @param {String} recalculationId The ID of the recalculation request
|
|
67044
|
+
*/
|
|
67045
|
+
getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(businessUnitId, weekId, scheduleId, recalculationId) {
|
|
67046
|
+
// verify the required parameter 'businessUnitId' is set
|
|
67047
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
67048
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
67049
|
+
}
|
|
67050
|
+
// verify the required parameter 'weekId' is set
|
|
67051
|
+
if (weekId === undefined || weekId === null) {
|
|
67052
|
+
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
67053
|
+
}
|
|
67054
|
+
// verify the required parameter 'scheduleId' is set
|
|
67055
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
67056
|
+
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
67057
|
+
}
|
|
67058
|
+
// verify the required parameter 'recalculationId' is set
|
|
67059
|
+
if (recalculationId === undefined || recalculationId === null) {
|
|
67060
|
+
throw 'Missing the required parameter "recalculationId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';
|
|
67061
|
+
}
|
|
67062
|
+
|
|
67063
|
+
return this.apiClient.callApi(
|
|
67064
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}',
|
|
67065
|
+
'GET',
|
|
67066
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId,'recalculationId': recalculationId },
|
|
67067
|
+
{ },
|
|
67068
|
+
{ },
|
|
67069
|
+
{ },
|
|
67070
|
+
null,
|
|
67071
|
+
['PureCloud OAuth'],
|
|
67072
|
+
['application/json'],
|
|
67073
|
+
['application/json']
|
|
67074
|
+
);
|
|
67075
|
+
}
|
|
67076
|
+
|
|
66276
67077
|
/**
|
|
66277
67078
|
* Get the list of week schedules for the specified week
|
|
66278
67079
|
* Use "recent" (without quotes) for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week
|
|
@@ -66496,6 +67297,45 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66496
67297
|
);
|
|
66497
67298
|
}
|
|
66498
67299
|
|
|
67300
|
+
/**
|
|
67301
|
+
* Get the staffing requirement by planning group for a forecast
|
|
67302
|
+
*
|
|
67303
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
67304
|
+
* @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
|
|
67305
|
+
* @param {String} forecastId The ID of the forecast
|
|
67306
|
+
* @param {Object} opts Optional parameters
|
|
67307
|
+
* @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
|
|
67308
|
+
*/
|
|
67309
|
+
getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId, weekDateId, forecastId, opts) {
|
|
67310
|
+
opts = opts || {};
|
|
67311
|
+
|
|
67312
|
+
// verify the required parameter 'businessUnitId' is set
|
|
67313
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
67314
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67315
|
+
}
|
|
67316
|
+
// verify the required parameter 'weekDateId' is set
|
|
67317
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
67318
|
+
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67319
|
+
}
|
|
67320
|
+
// verify the required parameter 'forecastId' is set
|
|
67321
|
+
if (forecastId === undefined || forecastId === null) {
|
|
67322
|
+
throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';
|
|
67323
|
+
}
|
|
67324
|
+
|
|
67325
|
+
return this.apiClient.callApi(
|
|
67326
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement',
|
|
67327
|
+
'GET',
|
|
67328
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
67329
|
+
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi') },
|
|
67330
|
+
{ },
|
|
67331
|
+
{ },
|
|
67332
|
+
null,
|
|
67333
|
+
['PureCloud OAuth'],
|
|
67334
|
+
['application/json'],
|
|
67335
|
+
['application/json']
|
|
67336
|
+
);
|
|
67337
|
+
}
|
|
67338
|
+
|
|
66499
67339
|
/**
|
|
66500
67340
|
* Get short term forecasts
|
|
66501
67341
|
* Use "recent" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
@@ -67847,6 +68687,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67847
68687
|
);
|
|
67848
68688
|
}
|
|
67849
68689
|
|
|
68690
|
+
/**
|
|
68691
|
+
* Update agent configurations
|
|
68692
|
+
*
|
|
68693
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
68694
|
+
* @param {Object} opts Optional parameters
|
|
68695
|
+
* @param {Object} opts.body body
|
|
68696
|
+
*/
|
|
68697
|
+
patchWorkforcemanagementManagementunitAgents(managementUnitId, opts) {
|
|
68698
|
+
opts = opts || {};
|
|
68699
|
+
|
|
68700
|
+
// verify the required parameter 'managementUnitId' is set
|
|
68701
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
68702
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';
|
|
68703
|
+
}
|
|
68704
|
+
|
|
68705
|
+
return this.apiClient.callApi(
|
|
68706
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents',
|
|
68707
|
+
'PATCH',
|
|
68708
|
+
{ 'managementUnitId': managementUnitId },
|
|
68709
|
+
{ },
|
|
68710
|
+
{ },
|
|
68711
|
+
{ },
|
|
68712
|
+
opts['body'],
|
|
68713
|
+
['PureCloud OAuth'],
|
|
68714
|
+
['application/json'],
|
|
68715
|
+
['application/json']
|
|
68716
|
+
);
|
|
68717
|
+
}
|
|
68718
|
+
|
|
67850
68719
|
/**
|
|
67851
68720
|
* Updates a time off limit object.
|
|
67852
68721
|
* Updates time off limit object properties, but not daily values.
|
|
@@ -68665,6 +69534,84 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68665
69534
|
);
|
|
68666
69535
|
}
|
|
68667
69536
|
|
|
69537
|
+
/**
|
|
69538
|
+
* Request a daily recalculation of the performance prediction for the associated schedule
|
|
69539
|
+
*
|
|
69540
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
69541
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
69542
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
69543
|
+
* @param {Object} opts Optional parameters
|
|
69544
|
+
* @param {Object} opts.body body
|
|
69545
|
+
*/
|
|
69546
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId, opts) {
|
|
69547
|
+
opts = opts || {};
|
|
69548
|
+
|
|
69549
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69550
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69551
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69552
|
+
}
|
|
69553
|
+
// verify the required parameter 'weekId' is set
|
|
69554
|
+
if (weekId === undefined || weekId === null) {
|
|
69555
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69556
|
+
}
|
|
69557
|
+
// verify the required parameter 'scheduleId' is set
|
|
69558
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
69559
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
69560
|
+
}
|
|
69561
|
+
|
|
69562
|
+
return this.apiClient.callApi(
|
|
69563
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations',
|
|
69564
|
+
'POST',
|
|
69565
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
69566
|
+
{ },
|
|
69567
|
+
{ },
|
|
69568
|
+
{ },
|
|
69569
|
+
opts['body'],
|
|
69570
|
+
['PureCloud OAuth'],
|
|
69571
|
+
['application/json'],
|
|
69572
|
+
['application/json']
|
|
69573
|
+
);
|
|
69574
|
+
}
|
|
69575
|
+
|
|
69576
|
+
/**
|
|
69577
|
+
* Upload daily activity changes to be able to request a performance prediction recalculation
|
|
69578
|
+
*
|
|
69579
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
69580
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
69581
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
69582
|
+
* @param {Object} opts Optional parameters
|
|
69583
|
+
* @param {Object} opts.body body
|
|
69584
|
+
*/
|
|
69585
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId, opts) {
|
|
69586
|
+
opts = opts || {};
|
|
69587
|
+
|
|
69588
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69589
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69590
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69591
|
+
}
|
|
69592
|
+
// verify the required parameter 'weekId' is set
|
|
69593
|
+
if (weekId === undefined || weekId === null) {
|
|
69594
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69595
|
+
}
|
|
69596
|
+
// verify the required parameter 'scheduleId' is set
|
|
69597
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
69598
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
69599
|
+
}
|
|
69600
|
+
|
|
69601
|
+
return this.apiClient.callApi(
|
|
69602
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl',
|
|
69603
|
+
'POST',
|
|
69604
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
69605
|
+
{ },
|
|
69606
|
+
{ },
|
|
69607
|
+
{ },
|
|
69608
|
+
opts['body'],
|
|
69609
|
+
['PureCloud OAuth'],
|
|
69610
|
+
['application/json'],
|
|
69611
|
+
['application/json']
|
|
69612
|
+
);
|
|
69613
|
+
}
|
|
69614
|
+
|
|
68668
69615
|
/**
|
|
68669
69616
|
* Start a rescheduling run
|
|
68670
69617
|
*
|
|
@@ -70313,7 +71260,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70313
71260
|
* </pre>
|
|
70314
71261
|
* </p>
|
|
70315
71262
|
* @module purecloud-platform-client-v2/index
|
|
70316
|
-
* @version
|
|
71263
|
+
* @version 186.0.1
|
|
70317
71264
|
*/
|
|
70318
71265
|
class platformClient {
|
|
70319
71266
|
constructor() {
|