purecloud-platform-client-v2 209.0.0 → 211.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -3
- package/dist/node/purecloud-platform-client-v2.js +773 -155
- package/dist/web-amd/purecloud-platform-client-v2.js +773 -156
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +295 -181
- package/dist/web-cjs/purecloud-platform-client-v2.js +6697 -534
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +937 -702
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/AbstractHttpClient.js +26 -0
- package/src/purecloud-platform-client-v2/ApiClient.js +136 -57
- package/src/purecloud-platform-client-v2/DefaultHttpClient.js +48 -0
- package/src/purecloud-platform-client-v2/HttpRequestOptions.js +65 -0
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +175 -0
- 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/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +240 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -9
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.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/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- 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 +5 -13
- package/src/purecloud-platform-client-v2/configuration.js +2 -0
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
+
var https = require('https');
|
|
3
4
|
var axios = require('axios');
|
|
4
5
|
var qs = require('qs');
|
|
5
6
|
|
|
6
7
|
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
7
8
|
|
|
9
|
+
var https__default = /*#__PURE__*/_interopDefaultLegacy(https);
|
|
8
10
|
var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
|
|
9
11
|
var qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
|
|
10
12
|
|
|
@@ -426,6 +428,8 @@ class Configuration {
|
|
|
426
428
|
}
|
|
427
429
|
}
|
|
428
430
|
|
|
431
|
+
|
|
432
|
+
|
|
429
433
|
setEnvironment(env) {
|
|
430
434
|
// Default value
|
|
431
435
|
if (env) this.environment = env;
|
|
@@ -484,9 +488,141 @@ class Configuration {
|
|
|
484
488
|
}
|
|
485
489
|
}
|
|
486
490
|
|
|
491
|
+
class AbstractHttpClient {
|
|
492
|
+
|
|
493
|
+
constructor() {
|
|
494
|
+
this.timeout = 16000;
|
|
495
|
+
}
|
|
496
|
+
|
|
497
|
+
setTimeout(timeout) {
|
|
498
|
+
if (timeout === null || timeout === undefined || typeof timeout !== 'number') {
|
|
499
|
+
throw new Error("The 'timeout' property must be a number");
|
|
500
|
+
}
|
|
501
|
+
this.timeout = timeout;
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
setHttpsAgent(httpsAgent) {
|
|
505
|
+
if (httpsAgent && typeof httpsAgent !== 'object') {
|
|
506
|
+
throw new Error("The 'httpsAgent' property must be an object");
|
|
507
|
+
}
|
|
508
|
+
this.httpsAgent = httpsAgent;
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
request(httpRequestOptions) {
|
|
512
|
+
throw new Error("method must be implemented");
|
|
513
|
+
}
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
class HttpRequestOptions {
|
|
517
|
+
|
|
518
|
+
constructor(url, method, headers, params, data, timeout) {
|
|
519
|
+
this.setUrl(url);
|
|
520
|
+
this.setMethod(method);
|
|
521
|
+
if (headers) {
|
|
522
|
+
this.setHeaders(headers);
|
|
523
|
+
}
|
|
524
|
+
if (params) {
|
|
525
|
+
this.setParams(params);
|
|
526
|
+
}
|
|
527
|
+
if (data) {
|
|
528
|
+
this.setData(data);
|
|
529
|
+
}
|
|
530
|
+
if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
|
|
531
|
+
else this.timeout = 16000;
|
|
532
|
+
}
|
|
533
|
+
|
|
534
|
+
// Mandatory fields with validation
|
|
535
|
+
setUrl(url) {
|
|
536
|
+
if (!url) throw new Error("The 'url' property is required");
|
|
537
|
+
this.url = url;
|
|
538
|
+
}
|
|
539
|
+
|
|
540
|
+
setMethod(method) {
|
|
541
|
+
const validMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS', 'HEAD'];
|
|
542
|
+
if (!method || !validMethods.includes(method.toUpperCase())) {
|
|
543
|
+
throw new Error("The 'method' property is invalid or missing");
|
|
544
|
+
}
|
|
545
|
+
this.method = method.toUpperCase();
|
|
546
|
+
}
|
|
547
|
+
|
|
548
|
+
setData(data) {
|
|
549
|
+
if (data === undefined || data === null) {
|
|
550
|
+
throw new Error("The 'data' property is required");
|
|
551
|
+
}
|
|
552
|
+
this.data = data;
|
|
553
|
+
}
|
|
554
|
+
|
|
555
|
+
// Optional fields
|
|
556
|
+
setParams(params) {
|
|
557
|
+
if (params && typeof params !== 'object') {
|
|
558
|
+
throw new Error("The 'params' property must be an object");
|
|
559
|
+
}
|
|
560
|
+
this.params = params;
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
// Optional fields
|
|
564
|
+
setHeaders(headers) {
|
|
565
|
+
if (headers && typeof headers !== 'object') {
|
|
566
|
+
throw new Error("The 'headers' property must be an object");
|
|
567
|
+
}
|
|
568
|
+
this.headers = headers;
|
|
569
|
+
}
|
|
570
|
+
|
|
571
|
+
setTimeout(timeout) {
|
|
572
|
+
if (timeout === undefined || timeout === null || typeof timeout !== 'number') {
|
|
573
|
+
throw new Error("The 'timeout' property must be a number");
|
|
574
|
+
}
|
|
575
|
+
this.timeout = timeout;
|
|
576
|
+
}
|
|
577
|
+
|
|
578
|
+
}
|
|
579
|
+
|
|
580
|
+
// Default client is Axios
|
|
581
|
+
class DefaultHttpClient extends AbstractHttpClient{
|
|
582
|
+
|
|
583
|
+
constructor(timeout, httpsAgent) {
|
|
584
|
+
super();
|
|
585
|
+
if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
|
|
586
|
+
else this.timeout = 16000;
|
|
587
|
+
if (httpsAgent !== null && httpsAgent !== undefined) this.setHttpsAgent(httpsAgent);
|
|
588
|
+
else this.httpsAgent;
|
|
589
|
+
this._axiosInstance = axios__default["default"].create({});
|
|
590
|
+
}
|
|
591
|
+
|
|
592
|
+
request(httpRequestOptions) {
|
|
593
|
+
if(!(httpRequestOptions instanceof HttpRequestOptions)) {
|
|
594
|
+
throw new Error(`httpRequestOptions must be instance of HttpRequestOptions `);
|
|
595
|
+
}
|
|
596
|
+
const config = this.toAxiosConfig(httpRequestOptions);
|
|
597
|
+
return this._axiosInstance.request(config);
|
|
598
|
+
}
|
|
599
|
+
|
|
600
|
+
// Method to generate Axios-compatible config
|
|
601
|
+
toAxiosConfig(httpRequestOptions) {
|
|
602
|
+
if (!httpRequestOptions.url || !httpRequestOptions.method) {
|
|
603
|
+
throw new Error(
|
|
604
|
+
"Mandatory fields 'url' and 'method' must be set before making a request"
|
|
605
|
+
);
|
|
606
|
+
}
|
|
607
|
+
|
|
608
|
+
var config = {
|
|
609
|
+
url: httpRequestOptions.url,
|
|
610
|
+
method: httpRequestOptions.method
|
|
611
|
+
};
|
|
612
|
+
|
|
613
|
+
if (httpRequestOptions.params) config.params = httpRequestOptions.params;
|
|
614
|
+
if (httpRequestOptions.headers) config.headers = httpRequestOptions.headers;
|
|
615
|
+
if(httpRequestOptions.data) config.data = httpRequestOptions.data;
|
|
616
|
+
if (this.timeout != null && this.timeout != undefined) config.timeout = this.timeout;
|
|
617
|
+
if (this.httpsAgent) config.httpsAgent = this.httpsAgent;
|
|
618
|
+
|
|
619
|
+
return config;
|
|
620
|
+
}
|
|
621
|
+
}
|
|
622
|
+
|
|
487
623
|
/**
|
|
488
624
|
* @module purecloud-platform-client-v2/ApiClient
|
|
489
|
-
* @version
|
|
625
|
+
* @version 211.0.0
|
|
490
626
|
*/
|
|
491
627
|
class ApiClient {
|
|
492
628
|
/**
|
|
@@ -591,6 +727,9 @@ class ApiClient {
|
|
|
591
727
|
// Transparently request a new access token when it expires (Code Authorization only)
|
|
592
728
|
this.refreshInProgress = false;
|
|
593
729
|
|
|
730
|
+
this.httpClient;
|
|
731
|
+
this.proxyAgent;
|
|
732
|
+
|
|
594
733
|
this.config = new Configuration();
|
|
595
734
|
|
|
596
735
|
if (typeof(window) !== 'undefined') window.ApiClient = this;
|
|
@@ -684,6 +823,87 @@ class ApiClient {
|
|
|
684
823
|
this.config.setEnvironment(environment);
|
|
685
824
|
}
|
|
686
825
|
|
|
826
|
+
/**
|
|
827
|
+
* @description Sets the dynamic HttpClient used by the client
|
|
828
|
+
* @param {object} httpClient - HttpClient to be injected
|
|
829
|
+
*/
|
|
830
|
+
setHttpClient(httpClient) {
|
|
831
|
+
if (!(httpClient instanceof AbstractHttpClient)) {
|
|
832
|
+
throw new Error("httpclient must be an instance of AbstractHttpClient. See DefaultltHttpClient for a prototype");
|
|
833
|
+
}
|
|
834
|
+
this.httpClient = httpClient;
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
/**
|
|
838
|
+
* @description Gets the HttpClient used by the client
|
|
839
|
+
*/
|
|
840
|
+
getHttpClient() {
|
|
841
|
+
if (this.httpClient) {
|
|
842
|
+
return this.httpClient;
|
|
843
|
+
} else {
|
|
844
|
+
this.httpClient = new DefaultHttpClient(this.timeout, this.proxyAgent);
|
|
845
|
+
return this.httpClient;
|
|
846
|
+
}
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
/**
|
|
850
|
+
* @description Sets the certificate paths if MTLS authentication is needed
|
|
851
|
+
* @param {string} certPath - path for certs
|
|
852
|
+
* @param {string} keyPath - path for key
|
|
853
|
+
* @param {string} caPath - path for public certs
|
|
854
|
+
*/
|
|
855
|
+
setMTLSCertificates(certPath, keyPath, caPath) {
|
|
856
|
+
if (typeof window === 'undefined') {
|
|
857
|
+
const agentOptions = {};
|
|
858
|
+
if (certPath) {
|
|
859
|
+
agentOptions.cert = require('fs').readFileSync(certPath);
|
|
860
|
+
}
|
|
861
|
+
|
|
862
|
+
if (keyPath) {
|
|
863
|
+
agentOptions.key = require('fs').readFileSync(keyPath);
|
|
864
|
+
}
|
|
865
|
+
|
|
866
|
+
if (caPath) {
|
|
867
|
+
agentOptions.ca = require('fs').readFileSync(caPath);
|
|
868
|
+
}
|
|
869
|
+
|
|
870
|
+
agentOptions.rejectUnauthorized = true;
|
|
871
|
+
|
|
872
|
+
this.proxyAgent = new https__default["default"].Agent(agentOptions);
|
|
873
|
+
const httpClient = this.getHttpClient();
|
|
874
|
+
httpClient.setHttpsAgent(this.proxyAgent);
|
|
875
|
+
} else {
|
|
876
|
+
throw new Error("Custom Agent Paths/ File System Access are not supported on Browser. Use setMTLSContents instead");
|
|
877
|
+
}
|
|
878
|
+
}
|
|
879
|
+
|
|
880
|
+
/**
|
|
881
|
+
* @description Sets the certificate content if MTLS authentication is needed
|
|
882
|
+
* @param {string} certContent - content for certs
|
|
883
|
+
* @param {string} keyContent - content for key
|
|
884
|
+
* @param {string} caContent - content for public certs
|
|
885
|
+
*/
|
|
886
|
+
setMTLSContents(certContent, keyContent, caContent) {
|
|
887
|
+
const agentOptions = {};
|
|
888
|
+
if (certContent) {
|
|
889
|
+
agentOptions.cert = certContent;
|
|
890
|
+
}
|
|
891
|
+
|
|
892
|
+
if (keyContent) {
|
|
893
|
+
agentOptions.key = keyContent;
|
|
894
|
+
}
|
|
895
|
+
|
|
896
|
+
if (caContent) {
|
|
897
|
+
agentOptions.ca = caContent;
|
|
898
|
+
}
|
|
899
|
+
|
|
900
|
+
agentOptions.rejectUnauthorized = true;
|
|
901
|
+
|
|
902
|
+
this.proxyAgent = new https__default["default"].Agent(agentOptions);
|
|
903
|
+
const httpClient = this.getHttpClient();
|
|
904
|
+
httpClient.setHttpsAgent(this.proxyAgent);
|
|
905
|
+
}
|
|
906
|
+
|
|
687
907
|
/**
|
|
688
908
|
* @description Sets the gateway used by the session
|
|
689
909
|
* @param {object} gateway - Gateway Configuration interface
|
|
@@ -774,14 +994,11 @@ class ApiClient {
|
|
|
774
994
|
const headers = {
|
|
775
995
|
'Authorization': `Basic ${authHeader}`
|
|
776
996
|
};
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
httpsAgent: this.proxyAgent
|
|
783
|
-
})
|
|
784
|
-
.then((response) => {
|
|
997
|
+
|
|
998
|
+
var requestOptions = new HttpRequestOptions(`${loginBasePath}/oauth/token`, `POST`, headers, null, 'grant_type=client_credentials', this.timeout);
|
|
999
|
+
const httpClient = this.getHttpClient();
|
|
1000
|
+
httpClient.request(requestOptions)
|
|
1001
|
+
.then((response) => {
|
|
785
1002
|
// Logging
|
|
786
1003
|
this.config.logger.log(
|
|
787
1004
|
'trace',
|
|
@@ -925,20 +1142,18 @@ class ApiClient {
|
|
|
925
1142
|
this.clientId = clientId;
|
|
926
1143
|
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
927
1144
|
return new Promise((resolve, reject) => {
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
});
|
|
1145
|
+
var headers = {
|
|
1146
|
+
'Content-Type': 'application/x-www-form-urlencoded'
|
|
1147
|
+
};
|
|
1148
|
+
var data = qs__default["default"].stringify({ grant_type: 'authorization_code',
|
|
1149
|
+
code: authCode,
|
|
1150
|
+
code_verifier: codeVerifier,
|
|
1151
|
+
client_id: clientId,
|
|
1152
|
+
redirect_uri: redirectUri });
|
|
1153
|
+
|
|
1154
|
+
var requestOptions = new HttpRequestOptions(`${loginBasePath}/oauth/token`, `POST`, headers, null, data, this.timeout);
|
|
1155
|
+
const httpClient = this.getHttpClient();
|
|
940
1156
|
|
|
941
|
-
request.proxy = this.proxy;
|
|
942
1157
|
var bodyParam = {
|
|
943
1158
|
grant_type: 'authorization_code',
|
|
944
1159
|
code: authCode,
|
|
@@ -947,7 +1162,7 @@ class ApiClient {
|
|
|
947
1162
|
redirect_uri: redirectUri,
|
|
948
1163
|
};
|
|
949
1164
|
// Handle response
|
|
950
|
-
request
|
|
1165
|
+
httpClient.request(requestOptions)
|
|
951
1166
|
.then((response) => {
|
|
952
1167
|
// Logging
|
|
953
1168
|
this.config.logger.log(
|
|
@@ -955,7 +1170,7 @@ class ApiClient {
|
|
|
955
1170
|
response.status,
|
|
956
1171
|
'POST',
|
|
957
1172
|
`${loginBasePath}/oauth/token`,
|
|
958
|
-
|
|
1173
|
+
requestOptions.headers,
|
|
959
1174
|
response.headers,
|
|
960
1175
|
bodyParam,
|
|
961
1176
|
undefined
|
|
@@ -965,7 +1180,7 @@ class ApiClient {
|
|
|
965
1180
|
response.status,
|
|
966
1181
|
'POST',
|
|
967
1182
|
`${loginBasePath}/oauth/token`,
|
|
968
|
-
|
|
1183
|
+
requestOptions.headers,
|
|
969
1184
|
undefined,
|
|
970
1185
|
bodyParam,
|
|
971
1186
|
undefined
|
|
@@ -989,7 +1204,7 @@ class ApiClient {
|
|
|
989
1204
|
error.response.status,
|
|
990
1205
|
'POST',
|
|
991
1206
|
`${loginBasePath}/oauth/token`,
|
|
992
|
-
|
|
1207
|
+
requestOptions.headers,
|
|
993
1208
|
error.response.headers,
|
|
994
1209
|
bodyParam,
|
|
995
1210
|
error.response.data
|
|
@@ -1129,7 +1344,7 @@ class ApiClient {
|
|
|
1129
1344
|
this._testTokenAccess()
|
|
1130
1345
|
.then(() => {
|
|
1131
1346
|
if (!this.authData.state && query.state)
|
|
1132
|
-
this.authData.state = query.state;
|
|
1347
|
+
this.authData.state = query.state;
|
|
1133
1348
|
// remove codeVerifier from session storage
|
|
1134
1349
|
if (this.hasLocalStorage) {
|
|
1135
1350
|
sessionStorage.removeItem(`genesys_cloud_sdk_pkce_code_verifier`);
|
|
@@ -1376,17 +1591,13 @@ class ApiClient {
|
|
|
1376
1591
|
*/
|
|
1377
1592
|
_formAuthRequest(encodedData, data) {
|
|
1378
1593
|
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
1379
|
-
var
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
|
|
1386
|
-
data: qs__default["default"].stringify(data)
|
|
1387
|
-
});
|
|
1388
|
-
|
|
1389
|
-
return request;
|
|
1594
|
+
var headers = {
|
|
1595
|
+
'Authorization': 'Basic ' + encodedData,
|
|
1596
|
+
'Content-Type': 'application/x-www-form-urlencoded'
|
|
1597
|
+
};
|
|
1598
|
+
var requestOptions = new HttpRequestOptions(loginBasePath, `POST`, headers, null, qs__default["default"].stringify(data), this.timeout);
|
|
1599
|
+
const httpClient = this.getHttpClient();
|
|
1600
|
+
return httpClient.request(requestOptions);
|
|
1390
1601
|
}
|
|
1391
1602
|
|
|
1392
1603
|
/**
|
|
@@ -1781,15 +1992,15 @@ class ApiClient {
|
|
|
1781
1992
|
data[auth.name] = auth.apiKey;
|
|
1782
1993
|
}
|
|
1783
1994
|
if (auth['in'] === 'header') {
|
|
1784
|
-
request.headers =
|
|
1995
|
+
request.headers = this.addHeaders(request.headers, data);
|
|
1785
1996
|
} else {
|
|
1786
|
-
request.
|
|
1997
|
+
request.setParams(this.serialize(data));
|
|
1787
1998
|
}
|
|
1788
1999
|
}
|
|
1789
2000
|
break;
|
|
1790
2001
|
case 'oauth2':
|
|
1791
2002
|
if (auth.accessToken) {
|
|
1792
|
-
request.headers =
|
|
2003
|
+
request.headers = this.addHeaders(request.headers, {'Authorization': `Bearer ${auth.accessToken}`});
|
|
1793
2004
|
}
|
|
1794
2005
|
break;
|
|
1795
2006
|
default:
|
|
@@ -1799,13 +2010,18 @@ class ApiClient {
|
|
|
1799
2010
|
}
|
|
1800
2011
|
|
|
1801
2012
|
/**
|
|
1802
|
-
* @description Sets the proxy agent axios will use for requests
|
|
2013
|
+
* @description Sets the proxy agent axios will use for requests
|
|
1803
2014
|
* @param {any} agent - The proxy agent
|
|
1804
2015
|
*/
|
|
1805
2016
|
setProxyAgent(agent) {
|
|
1806
2017
|
this.proxyAgent = agent;
|
|
2018
|
+
const httpClient = this.getHttpClient();
|
|
2019
|
+
httpClient.setHttpsAgent(this.proxyAgent);
|
|
1807
2020
|
}
|
|
1808
2021
|
|
|
2022
|
+
|
|
2023
|
+
|
|
2024
|
+
|
|
1809
2025
|
/**
|
|
1810
2026
|
* Invokes the REST service using the supplied settings and parameters.
|
|
1811
2027
|
* @param {String} path The base URL to invoke.
|
|
@@ -1826,13 +2042,7 @@ class ApiClient {
|
|
|
1826
2042
|
sendRequest(this);
|
|
1827
2043
|
function sendRequest(that) {
|
|
1828
2044
|
var url = that.buildUrl(path, pathParams);
|
|
1829
|
-
|
|
1830
|
-
method: httpMethod,
|
|
1831
|
-
url: url,
|
|
1832
|
-
httpsAgent: that.proxyAgent,
|
|
1833
|
-
timeout: that.timeout,
|
|
1834
|
-
params: that.serialize(queryParams)
|
|
1835
|
-
};
|
|
2045
|
+
var request = new HttpRequestOptions(url, httpMethod, null, that.serialize(queryParams), null, that.timeout);
|
|
1836
2046
|
|
|
1837
2047
|
// apply authentications
|
|
1838
2048
|
that.applyAuthToRequest(request, authNames);
|
|
@@ -1850,7 +2060,7 @@ class ApiClient {
|
|
|
1850
2060
|
}
|
|
1851
2061
|
|
|
1852
2062
|
if (contentType === 'application/x-www-form-urlencoded') {
|
|
1853
|
-
request.
|
|
2063
|
+
request.setData(that.normalizeParams(formParams));
|
|
1854
2064
|
} else if (contentType == 'multipart/form-data') {
|
|
1855
2065
|
var _formParams = that.normalizeParams(formParams);
|
|
1856
2066
|
for (var key in _formParams) {
|
|
@@ -1858,18 +2068,20 @@ class ApiClient {
|
|
|
1858
2068
|
// Looks like axios handles files and forms the same way
|
|
1859
2069
|
var formData = new FormData();
|
|
1860
2070
|
formData.set(key, _formParams[key]);
|
|
1861
|
-
request.
|
|
2071
|
+
request.setData(formData);
|
|
1862
2072
|
}
|
|
1863
2073
|
}
|
|
1864
2074
|
} else if (bodyParam) {
|
|
1865
|
-
request.
|
|
2075
|
+
request.setData(bodyParam);
|
|
1866
2076
|
}
|
|
1867
2077
|
|
|
1868
2078
|
var accept = that.jsonPreferredMime(accepts);
|
|
1869
2079
|
if (accept) {
|
|
1870
2080
|
request.headers['Accept'] = accept;
|
|
1871
2081
|
}
|
|
1872
|
-
|
|
2082
|
+
|
|
2083
|
+
const httpClient = that.getHttpClient();
|
|
2084
|
+
httpClient.request(request)
|
|
1873
2085
|
.then((response) => {
|
|
1874
2086
|
// Build response object
|
|
1875
2087
|
var data = (that.returnExtended === true) ? {
|
|
@@ -1890,8 +2102,8 @@ class ApiClient {
|
|
|
1890
2102
|
})
|
|
1891
2103
|
.catch((error) => {
|
|
1892
2104
|
var data = error;
|
|
1893
|
-
if (error.response && error.response.status == 401 && that.config.refresh_access_token && that.authData.refreshToken !== "") {
|
|
1894
|
-
|
|
2105
|
+
if (error.response && error.response.status == 401 && that.config.refresh_access_token && that.authData.refreshToken && that.authData.refreshToken !== "") {
|
|
2106
|
+
that._handleExpiredAccessToken()
|
|
1895
2107
|
.then(() => {
|
|
1896
2108
|
sendRequest(that);
|
|
1897
2109
|
})
|
|
@@ -1930,7 +2142,7 @@ class AgentAssistantsApi {
|
|
|
1930
2142
|
/**
|
|
1931
2143
|
* AgentAssistants service.
|
|
1932
2144
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1933
|
-
* @version
|
|
2145
|
+
* @version 211.0.0
|
|
1934
2146
|
*/
|
|
1935
2147
|
|
|
1936
2148
|
/**
|
|
@@ -2306,7 +2518,7 @@ class AgentCopilotApi {
|
|
|
2306
2518
|
/**
|
|
2307
2519
|
* AgentCopilot service.
|
|
2308
2520
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2309
|
-
* @version
|
|
2521
|
+
* @version 211.0.0
|
|
2310
2522
|
*/
|
|
2311
2523
|
|
|
2312
2524
|
/**
|
|
@@ -2382,7 +2594,7 @@ class AgentUIApi {
|
|
|
2382
2594
|
/**
|
|
2383
2595
|
* AgentUI service.
|
|
2384
2596
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2385
|
-
* @version
|
|
2597
|
+
* @version 211.0.0
|
|
2386
2598
|
*/
|
|
2387
2599
|
|
|
2388
2600
|
/**
|
|
@@ -2513,7 +2725,7 @@ class AlertingApi {
|
|
|
2513
2725
|
/**
|
|
2514
2726
|
* Alerting service.
|
|
2515
2727
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2516
|
-
* @version
|
|
2728
|
+
* @version 211.0.0
|
|
2517
2729
|
*/
|
|
2518
2730
|
|
|
2519
2731
|
/**
|
|
@@ -3174,7 +3386,7 @@ class AnalyticsApi {
|
|
|
3174
3386
|
/**
|
|
3175
3387
|
* Analytics service.
|
|
3176
3388
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3177
|
-
* @version
|
|
3389
|
+
* @version 211.0.0
|
|
3178
3390
|
*/
|
|
3179
3391
|
|
|
3180
3392
|
/**
|
|
@@ -5787,7 +5999,7 @@ class ArchitectApi {
|
|
|
5787
5999
|
/**
|
|
5788
6000
|
* Architect service.
|
|
5789
6001
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5790
|
-
* @version
|
|
6002
|
+
* @version 211.0.0
|
|
5791
6003
|
*/
|
|
5792
6004
|
|
|
5793
6005
|
/**
|
|
@@ -9909,7 +10121,7 @@ class AuditApi {
|
|
|
9909
10121
|
/**
|
|
9910
10122
|
* Audit service.
|
|
9911
10123
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9912
|
-
* @version
|
|
10124
|
+
* @version 211.0.0
|
|
9913
10125
|
*/
|
|
9914
10126
|
|
|
9915
10127
|
/**
|
|
@@ -10110,7 +10322,7 @@ class AuthorizationApi {
|
|
|
10110
10322
|
/**
|
|
10111
10323
|
* Authorization service.
|
|
10112
10324
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10113
|
-
* @version
|
|
10325
|
+
* @version 211.0.0
|
|
10114
10326
|
*/
|
|
10115
10327
|
|
|
10116
10328
|
/**
|
|
@@ -11393,7 +11605,7 @@ class BillingApi {
|
|
|
11393
11605
|
/**
|
|
11394
11606
|
* Billing service.
|
|
11395
11607
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11396
|
-
* @version
|
|
11608
|
+
* @version 211.0.0
|
|
11397
11609
|
*/
|
|
11398
11610
|
|
|
11399
11611
|
/**
|
|
@@ -11473,7 +11685,7 @@ class CarrierServicesApi {
|
|
|
11473
11685
|
/**
|
|
11474
11686
|
* CarrierServices service.
|
|
11475
11687
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11476
|
-
* @version
|
|
11688
|
+
* @version 211.0.0
|
|
11477
11689
|
*/
|
|
11478
11690
|
|
|
11479
11691
|
/**
|
|
@@ -11543,7 +11755,7 @@ class ChatApi {
|
|
|
11543
11755
|
/**
|
|
11544
11756
|
* Chat service.
|
|
11545
11757
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11546
|
-
* @version
|
|
11758
|
+
* @version 211.0.0
|
|
11547
11759
|
*/
|
|
11548
11760
|
|
|
11549
11761
|
/**
|
|
@@ -12479,7 +12691,7 @@ class CoachingApi {
|
|
|
12479
12691
|
/**
|
|
12480
12692
|
* Coaching service.
|
|
12481
12693
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12482
|
-
* @version
|
|
12694
|
+
* @version 211.0.0
|
|
12483
12695
|
*/
|
|
12484
12696
|
|
|
12485
12697
|
/**
|
|
@@ -13056,7 +13268,7 @@ class ContentManagementApi {
|
|
|
13056
13268
|
/**
|
|
13057
13269
|
* ContentManagement service.
|
|
13058
13270
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13059
|
-
* @version
|
|
13271
|
+
* @version 211.0.0
|
|
13060
13272
|
*/
|
|
13061
13273
|
|
|
13062
13274
|
/**
|
|
@@ -14137,7 +14349,7 @@ class ConversationsApi {
|
|
|
14137
14349
|
/**
|
|
14138
14350
|
* Conversations service.
|
|
14139
14351
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14140
|
-
* @version
|
|
14352
|
+
* @version 211.0.0
|
|
14141
14353
|
*/
|
|
14142
14354
|
|
|
14143
14355
|
/**
|
|
@@ -21278,7 +21490,7 @@ class DataExtensionsApi {
|
|
|
21278
21490
|
/**
|
|
21279
21491
|
* DataExtensions service.
|
|
21280
21492
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21281
|
-
* @version
|
|
21493
|
+
* @version 211.0.0
|
|
21282
21494
|
*/
|
|
21283
21495
|
|
|
21284
21496
|
/**
|
|
@@ -21360,11 +21572,181 @@ class DataExtensionsApi {
|
|
|
21360
21572
|
|
|
21361
21573
|
}
|
|
21362
21574
|
|
|
21575
|
+
class DataPrivacyApi {
|
|
21576
|
+
/**
|
|
21577
|
+
* DataPrivacy service.
|
|
21578
|
+
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
21579
|
+
* @version 211.0.0
|
|
21580
|
+
*/
|
|
21581
|
+
|
|
21582
|
+
/**
|
|
21583
|
+
* Constructs a new DataPrivacyApi.
|
|
21584
|
+
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
21585
|
+
* @class
|
|
21586
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
21587
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
21588
|
+
*/
|
|
21589
|
+
constructor(apiClient) {
|
|
21590
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
21591
|
+
}
|
|
21592
|
+
|
|
21593
|
+
|
|
21594
|
+
/**
|
|
21595
|
+
* Delete a masking rule.
|
|
21596
|
+
*
|
|
21597
|
+
* @param {String} ruleId ruleId
|
|
21598
|
+
*/
|
|
21599
|
+
deleteDataprivacyMaskingrule(ruleId) {
|
|
21600
|
+
// verify the required parameter 'ruleId' is set
|
|
21601
|
+
if (ruleId === undefined || ruleId === null) {
|
|
21602
|
+
throw 'Missing the required parameter "ruleId" when calling deleteDataprivacyMaskingrule';
|
|
21603
|
+
}
|
|
21604
|
+
|
|
21605
|
+
return this.apiClient.callApi(
|
|
21606
|
+
'/api/v2/dataprivacy/maskingrules/{ruleId}',
|
|
21607
|
+
'DELETE',
|
|
21608
|
+
{ 'ruleId': ruleId },
|
|
21609
|
+
{ },
|
|
21610
|
+
{ },
|
|
21611
|
+
{ },
|
|
21612
|
+
null,
|
|
21613
|
+
['PureCloud OAuth'],
|
|
21614
|
+
['application/json'],
|
|
21615
|
+
['application/json']
|
|
21616
|
+
);
|
|
21617
|
+
}
|
|
21618
|
+
|
|
21619
|
+
/**
|
|
21620
|
+
* Fetch details about a masking rule.
|
|
21621
|
+
*
|
|
21622
|
+
* @param {String} ruleId ruleId
|
|
21623
|
+
*/
|
|
21624
|
+
getDataprivacyMaskingrule(ruleId) {
|
|
21625
|
+
// verify the required parameter 'ruleId' is set
|
|
21626
|
+
if (ruleId === undefined || ruleId === null) {
|
|
21627
|
+
throw 'Missing the required parameter "ruleId" when calling getDataprivacyMaskingrule';
|
|
21628
|
+
}
|
|
21629
|
+
|
|
21630
|
+
return this.apiClient.callApi(
|
|
21631
|
+
'/api/v2/dataprivacy/maskingrules/{ruleId}',
|
|
21632
|
+
'GET',
|
|
21633
|
+
{ 'ruleId': ruleId },
|
|
21634
|
+
{ },
|
|
21635
|
+
{ },
|
|
21636
|
+
{ },
|
|
21637
|
+
null,
|
|
21638
|
+
['PureCloud OAuth'],
|
|
21639
|
+
['application/json'],
|
|
21640
|
+
['application/json']
|
|
21641
|
+
);
|
|
21642
|
+
}
|
|
21643
|
+
|
|
21644
|
+
/**
|
|
21645
|
+
* Retrieve the list of masking rules.
|
|
21646
|
+
*
|
|
21647
|
+
*/
|
|
21648
|
+
getDataprivacyMaskingrules() {
|
|
21649
|
+
|
|
21650
|
+
return this.apiClient.callApi(
|
|
21651
|
+
'/api/v2/dataprivacy/maskingrules',
|
|
21652
|
+
'GET',
|
|
21653
|
+
{ },
|
|
21654
|
+
{ },
|
|
21655
|
+
{ },
|
|
21656
|
+
{ },
|
|
21657
|
+
null,
|
|
21658
|
+
['PureCloud OAuth'],
|
|
21659
|
+
['application/json'],
|
|
21660
|
+
['application/json']
|
|
21661
|
+
);
|
|
21662
|
+
}
|
|
21663
|
+
|
|
21664
|
+
/**
|
|
21665
|
+
* Update information about a masking rule.
|
|
21666
|
+
*
|
|
21667
|
+
* @param {String} ruleId ruleId
|
|
21668
|
+
* @param {Object} opts Optional parameters
|
|
21669
|
+
* @param {Object} opts.body
|
|
21670
|
+
*/
|
|
21671
|
+
patchDataprivacyMaskingrule(ruleId, opts) {
|
|
21672
|
+
opts = opts || {};
|
|
21673
|
+
|
|
21674
|
+
// verify the required parameter 'ruleId' is set
|
|
21675
|
+
if (ruleId === undefined || ruleId === null) {
|
|
21676
|
+
throw 'Missing the required parameter "ruleId" when calling patchDataprivacyMaskingrule';
|
|
21677
|
+
}
|
|
21678
|
+
|
|
21679
|
+
return this.apiClient.callApi(
|
|
21680
|
+
'/api/v2/dataprivacy/maskingrules/{ruleId}',
|
|
21681
|
+
'PATCH',
|
|
21682
|
+
{ 'ruleId': ruleId },
|
|
21683
|
+
{ },
|
|
21684
|
+
{ },
|
|
21685
|
+
{ },
|
|
21686
|
+
opts['body'],
|
|
21687
|
+
['PureCloud OAuth'],
|
|
21688
|
+
['application/json'],
|
|
21689
|
+
['application/json']
|
|
21690
|
+
);
|
|
21691
|
+
}
|
|
21692
|
+
|
|
21693
|
+
/**
|
|
21694
|
+
* Create a new masking rule resource.
|
|
21695
|
+
*
|
|
21696
|
+
* @param {Object} body Details for creating masking rule resource
|
|
21697
|
+
*/
|
|
21698
|
+
postDataprivacyMaskingrules(body) {
|
|
21699
|
+
// verify the required parameter 'body' is set
|
|
21700
|
+
if (body === undefined || body === null) {
|
|
21701
|
+
throw 'Missing the required parameter "body" when calling postDataprivacyMaskingrules';
|
|
21702
|
+
}
|
|
21703
|
+
|
|
21704
|
+
return this.apiClient.callApi(
|
|
21705
|
+
'/api/v2/dataprivacy/maskingrules',
|
|
21706
|
+
'POST',
|
|
21707
|
+
{ },
|
|
21708
|
+
{ },
|
|
21709
|
+
{ },
|
|
21710
|
+
{ },
|
|
21711
|
+
body,
|
|
21712
|
+
['PureCloud OAuth'],
|
|
21713
|
+
['application/json'],
|
|
21714
|
+
['application/json']
|
|
21715
|
+
);
|
|
21716
|
+
}
|
|
21717
|
+
|
|
21718
|
+
/**
|
|
21719
|
+
* Validate masking before creating.
|
|
21720
|
+
*
|
|
21721
|
+
* @param {Object} body Text to be masked
|
|
21722
|
+
*/
|
|
21723
|
+
postDataprivacyMaskingrulesValidate(body) {
|
|
21724
|
+
// verify the required parameter 'body' is set
|
|
21725
|
+
if (body === undefined || body === null) {
|
|
21726
|
+
throw 'Missing the required parameter "body" when calling postDataprivacyMaskingrulesValidate';
|
|
21727
|
+
}
|
|
21728
|
+
|
|
21729
|
+
return this.apiClient.callApi(
|
|
21730
|
+
'/api/v2/dataprivacy/maskingrules/validate',
|
|
21731
|
+
'POST',
|
|
21732
|
+
{ },
|
|
21733
|
+
{ },
|
|
21734
|
+
{ },
|
|
21735
|
+
{ },
|
|
21736
|
+
body,
|
|
21737
|
+
['PureCloud OAuth'],
|
|
21738
|
+
['application/json'],
|
|
21739
|
+
['application/json']
|
|
21740
|
+
);
|
|
21741
|
+
}
|
|
21742
|
+
|
|
21743
|
+
}
|
|
21744
|
+
|
|
21363
21745
|
class DownloadsApi {
|
|
21364
21746
|
/**
|
|
21365
21747
|
* Downloads service.
|
|
21366
21748
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21367
|
-
* @version
|
|
21749
|
+
* @version 211.0.0
|
|
21368
21750
|
*/
|
|
21369
21751
|
|
|
21370
21752
|
/**
|
|
@@ -21416,7 +21798,7 @@ class EmailsApi {
|
|
|
21416
21798
|
/**
|
|
21417
21799
|
* Emails service.
|
|
21418
21800
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21419
|
-
* @version
|
|
21801
|
+
* @version 211.0.0
|
|
21420
21802
|
*/
|
|
21421
21803
|
|
|
21422
21804
|
/**
|
|
@@ -21481,7 +21863,7 @@ class EmployeeEngagementApi {
|
|
|
21481
21863
|
/**
|
|
21482
21864
|
* EmployeeEngagement service.
|
|
21483
21865
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
21484
|
-
* @version
|
|
21866
|
+
* @version 211.0.0
|
|
21485
21867
|
*/
|
|
21486
21868
|
|
|
21487
21869
|
/**
|
|
@@ -21632,7 +22014,7 @@ class EventsApi {
|
|
|
21632
22014
|
/**
|
|
21633
22015
|
* Events service.
|
|
21634
22016
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21635
|
-
* @version
|
|
22017
|
+
* @version 211.0.0
|
|
21636
22018
|
*/
|
|
21637
22019
|
|
|
21638
22020
|
/**
|
|
@@ -21728,7 +22110,7 @@ class ExternalContactsApi {
|
|
|
21728
22110
|
/**
|
|
21729
22111
|
* ExternalContacts service.
|
|
21730
22112
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21731
|
-
* @version
|
|
22113
|
+
* @version 211.0.0
|
|
21732
22114
|
*/
|
|
21733
22115
|
|
|
21734
22116
|
/**
|
|
@@ -21873,6 +22255,31 @@ class ExternalContactsApi {
|
|
|
21873
22255
|
);
|
|
21874
22256
|
}
|
|
21875
22257
|
|
|
22258
|
+
/**
|
|
22259
|
+
* Delete Settings
|
|
22260
|
+
*
|
|
22261
|
+
* @param {String} settingsId Settings id
|
|
22262
|
+
*/
|
|
22263
|
+
deleteExternalcontactsImportSetting(settingsId) {
|
|
22264
|
+
// verify the required parameter 'settingsId' is set
|
|
22265
|
+
if (settingsId === undefined || settingsId === null) {
|
|
22266
|
+
throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportSetting';
|
|
22267
|
+
}
|
|
22268
|
+
|
|
22269
|
+
return this.apiClient.callApi(
|
|
22270
|
+
'/api/v2/externalcontacts/import/settings/{settingsId}',
|
|
22271
|
+
'DELETE',
|
|
22272
|
+
{ 'settingsId': settingsId },
|
|
22273
|
+
{ },
|
|
22274
|
+
{ },
|
|
22275
|
+
{ },
|
|
22276
|
+
null,
|
|
22277
|
+
['PureCloud OAuth'],
|
|
22278
|
+
['application/json'],
|
|
22279
|
+
['application/json']
|
|
22280
|
+
);
|
|
22281
|
+
}
|
|
22282
|
+
|
|
21876
22283
|
/**
|
|
21877
22284
|
* Delete an external organization
|
|
21878
22285
|
*
|
|
@@ -22439,6 +22846,110 @@ class ExternalContactsApi {
|
|
|
22439
22846
|
);
|
|
22440
22847
|
}
|
|
22441
22848
|
|
|
22849
|
+
/**
|
|
22850
|
+
* Get job based on id
|
|
22851
|
+
*
|
|
22852
|
+
* @param {String} jobId Job id
|
|
22853
|
+
*/
|
|
22854
|
+
getExternalcontactsImportJob(jobId) {
|
|
22855
|
+
// verify the required parameter 'jobId' is set
|
|
22856
|
+
if (jobId === undefined || jobId === null) {
|
|
22857
|
+
throw 'Missing the required parameter "jobId" when calling getExternalcontactsImportJob';
|
|
22858
|
+
}
|
|
22859
|
+
|
|
22860
|
+
return this.apiClient.callApi(
|
|
22861
|
+
'/api/v2/externalcontacts/import/jobs/{jobId}',
|
|
22862
|
+
'GET',
|
|
22863
|
+
{ 'jobId': jobId },
|
|
22864
|
+
{ },
|
|
22865
|
+
{ },
|
|
22866
|
+
{ },
|
|
22867
|
+
null,
|
|
22868
|
+
['PureCloud OAuth'],
|
|
22869
|
+
['application/json'],
|
|
22870
|
+
['application/json']
|
|
22871
|
+
);
|
|
22872
|
+
}
|
|
22873
|
+
|
|
22874
|
+
/**
|
|
22875
|
+
* List jobs for organization
|
|
22876
|
+
*
|
|
22877
|
+
* @param {Object} opts Optional parameters
|
|
22878
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22879
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
22880
|
+
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
22881
|
+
* @param {Object} opts.jobStatus Search term to filter by jobStatus
|
|
22882
|
+
*/
|
|
22883
|
+
getExternalcontactsImportJobs(opts) {
|
|
22884
|
+
opts = opts || {};
|
|
22885
|
+
|
|
22886
|
+
|
|
22887
|
+
return this.apiClient.callApi(
|
|
22888
|
+
'/api/v2/externalcontacts/import/jobs',
|
|
22889
|
+
'GET',
|
|
22890
|
+
{ },
|
|
22891
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'jobStatus': opts['jobStatus'] },
|
|
22892
|
+
{ },
|
|
22893
|
+
{ },
|
|
22894
|
+
null,
|
|
22895
|
+
['PureCloud OAuth'],
|
|
22896
|
+
['application/json'],
|
|
22897
|
+
['application/json']
|
|
22898
|
+
);
|
|
22899
|
+
}
|
|
22900
|
+
|
|
22901
|
+
/**
|
|
22902
|
+
* Get setting based on id
|
|
22903
|
+
*
|
|
22904
|
+
* @param {String} settingsId Settings id
|
|
22905
|
+
*/
|
|
22906
|
+
getExternalcontactsImportSetting(settingsId) {
|
|
22907
|
+
// verify the required parameter 'settingsId' is set
|
|
22908
|
+
if (settingsId === undefined || settingsId === null) {
|
|
22909
|
+
throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportSetting';
|
|
22910
|
+
}
|
|
22911
|
+
|
|
22912
|
+
return this.apiClient.callApi(
|
|
22913
|
+
'/api/v2/externalcontacts/import/settings/{settingsId}',
|
|
22914
|
+
'GET',
|
|
22915
|
+
{ 'settingsId': settingsId },
|
|
22916
|
+
{ },
|
|
22917
|
+
{ },
|
|
22918
|
+
{ },
|
|
22919
|
+
null,
|
|
22920
|
+
['PureCloud OAuth'],
|
|
22921
|
+
['application/json'],
|
|
22922
|
+
['application/json']
|
|
22923
|
+
);
|
|
22924
|
+
}
|
|
22925
|
+
|
|
22926
|
+
/**
|
|
22927
|
+
* List settings for organization
|
|
22928
|
+
*
|
|
22929
|
+
* @param {Object} opts Optional parameters
|
|
22930
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22931
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
22932
|
+
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
22933
|
+
* @param {String} opts.name Search term to filter by settings name
|
|
22934
|
+
*/
|
|
22935
|
+
getExternalcontactsImportSettings(opts) {
|
|
22936
|
+
opts = opts || {};
|
|
22937
|
+
|
|
22938
|
+
|
|
22939
|
+
return this.apiClient.callApi(
|
|
22940
|
+
'/api/v2/externalcontacts/import/settings',
|
|
22941
|
+
'GET',
|
|
22942
|
+
{ },
|
|
22943
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
22944
|
+
{ },
|
|
22945
|
+
{ },
|
|
22946
|
+
null,
|
|
22947
|
+
['PureCloud OAuth'],
|
|
22948
|
+
['application/json'],
|
|
22949
|
+
['application/json']
|
|
22950
|
+
);
|
|
22951
|
+
}
|
|
22952
|
+
|
|
22442
22953
|
/**
|
|
22443
22954
|
* Fetch an external organization
|
|
22444
22955
|
*
|
|
@@ -23577,6 +24088,56 @@ class ExternalContactsApi {
|
|
|
23577
24088
|
);
|
|
23578
24089
|
}
|
|
23579
24090
|
|
|
24091
|
+
/**
|
|
24092
|
+
* Create a new job
|
|
24093
|
+
*
|
|
24094
|
+
* @param {Object} body Job
|
|
24095
|
+
*/
|
|
24096
|
+
postExternalcontactsImportJobs(body) {
|
|
24097
|
+
// verify the required parameter 'body' is set
|
|
24098
|
+
if (body === undefined || body === null) {
|
|
24099
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportJobs';
|
|
24100
|
+
}
|
|
24101
|
+
|
|
24102
|
+
return this.apiClient.callApi(
|
|
24103
|
+
'/api/v2/externalcontacts/import/jobs',
|
|
24104
|
+
'POST',
|
|
24105
|
+
{ },
|
|
24106
|
+
{ },
|
|
24107
|
+
{ },
|
|
24108
|
+
{ },
|
|
24109
|
+
body,
|
|
24110
|
+
['PureCloud OAuth'],
|
|
24111
|
+
['application/json'],
|
|
24112
|
+
['application/json']
|
|
24113
|
+
);
|
|
24114
|
+
}
|
|
24115
|
+
|
|
24116
|
+
/**
|
|
24117
|
+
* Create a new settings
|
|
24118
|
+
*
|
|
24119
|
+
* @param {Object} body Setting
|
|
24120
|
+
*/
|
|
24121
|
+
postExternalcontactsImportSettings(body) {
|
|
24122
|
+
// verify the required parameter 'body' is set
|
|
24123
|
+
if (body === undefined || body === null) {
|
|
24124
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportSettings';
|
|
24125
|
+
}
|
|
24126
|
+
|
|
24127
|
+
return this.apiClient.callApi(
|
|
24128
|
+
'/api/v2/externalcontacts/import/settings',
|
|
24129
|
+
'POST',
|
|
24130
|
+
{ },
|
|
24131
|
+
{ },
|
|
24132
|
+
{ },
|
|
24133
|
+
{ },
|
|
24134
|
+
body,
|
|
24135
|
+
['PureCloud OAuth'],
|
|
24136
|
+
['application/json'],
|
|
24137
|
+
['application/json']
|
|
24138
|
+
);
|
|
24139
|
+
}
|
|
24140
|
+
|
|
23580
24141
|
/**
|
|
23581
24142
|
* Merge two contacts into a new contact record
|
|
23582
24143
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
@@ -23892,6 +24453,66 @@ class ExternalContactsApi {
|
|
|
23892
24453
|
);
|
|
23893
24454
|
}
|
|
23894
24455
|
|
|
24456
|
+
/**
|
|
24457
|
+
* Update Job's workflow status
|
|
24458
|
+
*
|
|
24459
|
+
* @param {String} jobId Job id
|
|
24460
|
+
* @param {Object} body Status of the Job's workflow
|
|
24461
|
+
*/
|
|
24462
|
+
putExternalcontactsImportJob(jobId, body) {
|
|
24463
|
+
// verify the required parameter 'jobId' is set
|
|
24464
|
+
if (jobId === undefined || jobId === null) {
|
|
24465
|
+
throw 'Missing the required parameter "jobId" when calling putExternalcontactsImportJob';
|
|
24466
|
+
}
|
|
24467
|
+
// verify the required parameter 'body' is set
|
|
24468
|
+
if (body === undefined || body === null) {
|
|
24469
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportJob';
|
|
24470
|
+
}
|
|
24471
|
+
|
|
24472
|
+
return this.apiClient.callApi(
|
|
24473
|
+
'/api/v2/externalcontacts/import/jobs/{jobId}',
|
|
24474
|
+
'PUT',
|
|
24475
|
+
{ 'jobId': jobId },
|
|
24476
|
+
{ },
|
|
24477
|
+
{ },
|
|
24478
|
+
{ },
|
|
24479
|
+
body,
|
|
24480
|
+
['PureCloud OAuth'],
|
|
24481
|
+
['application/json'],
|
|
24482
|
+
['application/json']
|
|
24483
|
+
);
|
|
24484
|
+
}
|
|
24485
|
+
|
|
24486
|
+
/**
|
|
24487
|
+
* Update settings
|
|
24488
|
+
*
|
|
24489
|
+
* @param {String} settingsId Settings id
|
|
24490
|
+
* @param {Object} body Setting
|
|
24491
|
+
*/
|
|
24492
|
+
putExternalcontactsImportSetting(settingsId, body) {
|
|
24493
|
+
// verify the required parameter 'settingsId' is set
|
|
24494
|
+
if (settingsId === undefined || settingsId === null) {
|
|
24495
|
+
throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportSetting';
|
|
24496
|
+
}
|
|
24497
|
+
// verify the required parameter 'body' is set
|
|
24498
|
+
if (body === undefined || body === null) {
|
|
24499
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportSetting';
|
|
24500
|
+
}
|
|
24501
|
+
|
|
24502
|
+
return this.apiClient.callApi(
|
|
24503
|
+
'/api/v2/externalcontacts/import/settings/{settingsId}',
|
|
24504
|
+
'PUT',
|
|
24505
|
+
{ 'settingsId': settingsId },
|
|
24506
|
+
{ },
|
|
24507
|
+
{ },
|
|
24508
|
+
{ },
|
|
24509
|
+
body,
|
|
24510
|
+
['PureCloud OAuth'],
|
|
24511
|
+
['application/json'],
|
|
24512
|
+
['application/json']
|
|
24513
|
+
);
|
|
24514
|
+
}
|
|
24515
|
+
|
|
23895
24516
|
/**
|
|
23896
24517
|
* Update an external organization
|
|
23897
24518
|
*
|
|
@@ -24053,7 +24674,7 @@ class FaxApi {
|
|
|
24053
24674
|
/**
|
|
24054
24675
|
* Fax service.
|
|
24055
24676
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24056
|
-
* @version
|
|
24677
|
+
* @version 211.0.0
|
|
24057
24678
|
*/
|
|
24058
24679
|
|
|
24059
24680
|
/**
|
|
@@ -24268,7 +24889,7 @@ class FlowsApi {
|
|
|
24268
24889
|
/**
|
|
24269
24890
|
* Flows service.
|
|
24270
24891
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
24271
|
-
* @version
|
|
24892
|
+
* @version 211.0.0
|
|
24272
24893
|
*/
|
|
24273
24894
|
|
|
24274
24895
|
/**
|
|
@@ -24451,7 +25072,7 @@ class GamificationApi {
|
|
|
24451
25072
|
/**
|
|
24452
25073
|
* Gamification service.
|
|
24453
25074
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24454
|
-
* @version
|
|
25075
|
+
* @version 211.0.0
|
|
24455
25076
|
*/
|
|
24456
25077
|
|
|
24457
25078
|
/**
|
|
@@ -26537,7 +27158,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26537
27158
|
/**
|
|
26538
27159
|
* GeneralDataProtectionRegulation service.
|
|
26539
27160
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26540
|
-
* @version
|
|
27161
|
+
* @version 211.0.0
|
|
26541
27162
|
*/
|
|
26542
27163
|
|
|
26543
27164
|
/**
|
|
@@ -26667,7 +27288,7 @@ class GeolocationApi {
|
|
|
26667
27288
|
/**
|
|
26668
27289
|
* Geolocation service.
|
|
26669
27290
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26670
|
-
* @version
|
|
27291
|
+
* @version 211.0.0
|
|
26671
27292
|
*/
|
|
26672
27293
|
|
|
26673
27294
|
/**
|
|
@@ -26798,7 +27419,7 @@ class GreetingsApi {
|
|
|
26798
27419
|
/**
|
|
26799
27420
|
* Greetings service.
|
|
26800
27421
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26801
|
-
* @version
|
|
27422
|
+
* @version 211.0.0
|
|
26802
27423
|
*/
|
|
26803
27424
|
|
|
26804
27425
|
/**
|
|
@@ -27253,7 +27874,7 @@ class GroupsApi {
|
|
|
27253
27874
|
/**
|
|
27254
27875
|
* Groups service.
|
|
27255
27876
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27256
|
-
* @version
|
|
27877
|
+
* @version 211.0.0
|
|
27257
27878
|
*/
|
|
27258
27879
|
|
|
27259
27880
|
/**
|
|
@@ -27772,7 +28393,7 @@ class IdentityProviderApi {
|
|
|
27772
28393
|
/**
|
|
27773
28394
|
* IdentityProvider service.
|
|
27774
28395
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27775
|
-
* @version
|
|
28396
|
+
* @version 211.0.0
|
|
27776
28397
|
*/
|
|
27777
28398
|
|
|
27778
28399
|
/**
|
|
@@ -28633,7 +29254,7 @@ class InfrastructureAsCodeApi {
|
|
|
28633
29254
|
/**
|
|
28634
29255
|
* InfrastructureAsCode service.
|
|
28635
29256
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28636
|
-
* @version
|
|
29257
|
+
* @version 211.0.0
|
|
28637
29258
|
*/
|
|
28638
29259
|
|
|
28639
29260
|
/**
|
|
@@ -28800,7 +29421,7 @@ class IntegrationsApi {
|
|
|
28800
29421
|
/**
|
|
28801
29422
|
* Integrations service.
|
|
28802
29423
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28803
|
-
* @version
|
|
29424
|
+
* @version 211.0.0
|
|
28804
29425
|
*/
|
|
28805
29426
|
|
|
28806
29427
|
/**
|
|
@@ -31242,7 +31863,7 @@ class JourneyApi {
|
|
|
31242
31863
|
/**
|
|
31243
31864
|
* Journey service.
|
|
31244
31865
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
31245
|
-
* @version
|
|
31866
|
+
* @version 211.0.0
|
|
31246
31867
|
*/
|
|
31247
31868
|
|
|
31248
31869
|
/**
|
|
@@ -31413,7 +32034,7 @@ class JourneyApi {
|
|
|
31413
32034
|
|
|
31414
32035
|
/**
|
|
31415
32036
|
* Delete the Schedule of a JourneyView
|
|
31416
|
-
*
|
|
32037
|
+
*
|
|
31417
32038
|
* @param {String} viewId Journey View Id
|
|
31418
32039
|
*/
|
|
31419
32040
|
deleteJourneyViewSchedules(viewId) {
|
|
@@ -32086,7 +32707,7 @@ class JourneyApi {
|
|
|
32086
32707
|
|
|
32087
32708
|
/**
|
|
32088
32709
|
* Get the Schedule for a JourneyView
|
|
32089
|
-
*
|
|
32710
|
+
*
|
|
32090
32711
|
* @param {String} viewId Journey View Id
|
|
32091
32712
|
*/
|
|
32092
32713
|
getJourneyViewSchedules(viewId) {
|
|
@@ -32216,7 +32837,7 @@ class JourneyApi {
|
|
|
32216
32837
|
|
|
32217
32838
|
/**
|
|
32218
32839
|
* Get the job for a journey view version.
|
|
32219
|
-
*
|
|
32840
|
+
*
|
|
32220
32841
|
* @param {String} viewId Journey View Id
|
|
32221
32842
|
* @param {String} journeyVersionId Journey View Version
|
|
32222
32843
|
* @param {String} jobId JobId
|
|
@@ -32251,7 +32872,7 @@ class JourneyApi {
|
|
|
32251
32872
|
|
|
32252
32873
|
/**
|
|
32253
32874
|
* Get the result of a job for a journey view version.
|
|
32254
|
-
*
|
|
32875
|
+
*
|
|
32255
32876
|
* @param {String} viewId JourneyViewResult id
|
|
32256
32877
|
* @param {String} journeyViewVersion Journey View Version
|
|
32257
32878
|
* @param {String} jobId Id of the executing job
|
|
@@ -32326,7 +32947,7 @@ class JourneyApi {
|
|
|
32326
32947
|
|
|
32327
32948
|
/**
|
|
32328
32949
|
* Get the latest job of a journey view version.
|
|
32329
|
-
*
|
|
32950
|
+
*
|
|
32330
32951
|
* @param {String} viewId Journey View Id
|
|
32331
32952
|
* @param {String} journeyVersionId Journey View Version
|
|
32332
32953
|
*/
|
|
@@ -32626,7 +33247,7 @@ class JourneyApi {
|
|
|
32626
33247
|
|
|
32627
33248
|
/**
|
|
32628
33249
|
* Update the job for a journey view version. Only the status can be changed and only to Cancelled
|
|
32629
|
-
*
|
|
33250
|
+
*
|
|
32630
33251
|
* @param {String} viewId Journey View Id
|
|
32631
33252
|
* @param {String} journeyVersionId Journey View Version
|
|
32632
33253
|
* @param {String} jobId JobId
|
|
@@ -33029,7 +33650,7 @@ class JourneyApi {
|
|
|
33029
33650
|
|
|
33030
33651
|
/**
|
|
33031
33652
|
* Submit a job request for a journey view version.
|
|
33032
|
-
*
|
|
33653
|
+
*
|
|
33033
33654
|
* @param {String} viewId Journey View Id
|
|
33034
33655
|
* @param {String} journeyVersionId Journey View Version
|
|
33035
33656
|
*/
|
|
@@ -33138,7 +33759,7 @@ class JourneyApi {
|
|
|
33138
33759
|
|
|
33139
33760
|
/**
|
|
33140
33761
|
* Update the Schedule for a JourneyView
|
|
33141
|
-
*
|
|
33762
|
+
*
|
|
33142
33763
|
* @param {String} viewId Journey View Id
|
|
33143
33764
|
* @param {Object} body journeyViewSchedule
|
|
33144
33765
|
*/
|
|
@@ -33207,7 +33828,7 @@ class KnowledgeApi {
|
|
|
33207
33828
|
/**
|
|
33208
33829
|
* Knowledge service.
|
|
33209
33830
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
33210
|
-
* @version
|
|
33831
|
+
* @version 211.0.0
|
|
33211
33832
|
*/
|
|
33212
33833
|
|
|
33213
33834
|
/**
|
|
@@ -37083,7 +37704,7 @@ class LanguageUnderstandingApi {
|
|
|
37083
37704
|
/**
|
|
37084
37705
|
* LanguageUnderstanding service.
|
|
37085
37706
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
37086
|
-
* @version
|
|
37707
|
+
* @version 211.0.0
|
|
37087
37708
|
*/
|
|
37088
37709
|
|
|
37089
37710
|
/**
|
|
@@ -38117,7 +38738,7 @@ class LanguagesApi {
|
|
|
38117
38738
|
/**
|
|
38118
38739
|
* Languages service.
|
|
38119
38740
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
38120
|
-
* @version
|
|
38741
|
+
* @version 211.0.0
|
|
38121
38742
|
*/
|
|
38122
38743
|
|
|
38123
38744
|
/**
|
|
@@ -38339,7 +38960,7 @@ class LearningApi {
|
|
|
38339
38960
|
/**
|
|
38340
38961
|
* Learning service.
|
|
38341
38962
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
38342
|
-
* @version
|
|
38963
|
+
* @version 211.0.0
|
|
38343
38964
|
*/
|
|
38344
38965
|
|
|
38345
38966
|
/**
|
|
@@ -39368,7 +39989,7 @@ class LicenseApi {
|
|
|
39368
39989
|
/**
|
|
39369
39990
|
* License service.
|
|
39370
39991
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
39371
|
-
* @version
|
|
39992
|
+
* @version 211.0.0
|
|
39372
39993
|
*/
|
|
39373
39994
|
|
|
39374
39995
|
/**
|
|
@@ -39606,7 +40227,7 @@ class LocationsApi {
|
|
|
39606
40227
|
/**
|
|
39607
40228
|
* Locations service.
|
|
39608
40229
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
39609
|
-
* @version
|
|
40230
|
+
* @version 211.0.0
|
|
39610
40231
|
*/
|
|
39611
40232
|
|
|
39612
40233
|
/**
|
|
@@ -39842,7 +40463,7 @@ class LogCaptureApi {
|
|
|
39842
40463
|
/**
|
|
39843
40464
|
* LogCapture service.
|
|
39844
40465
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39845
|
-
* @version
|
|
40466
|
+
* @version 211.0.0
|
|
39846
40467
|
*/
|
|
39847
40468
|
|
|
39848
40469
|
/**
|
|
@@ -40042,7 +40663,7 @@ class MessagingApi {
|
|
|
40042
40663
|
/**
|
|
40043
40664
|
* Messaging service.
|
|
40044
40665
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
40045
|
-
* @version
|
|
40666
|
+
* @version 211.0.0
|
|
40046
40667
|
*/
|
|
40047
40668
|
|
|
40048
40669
|
/**
|
|
@@ -40401,7 +41022,7 @@ class MobileDevicesApi {
|
|
|
40401
41022
|
/**
|
|
40402
41023
|
* MobileDevices service.
|
|
40403
41024
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
40404
|
-
* @version
|
|
41025
|
+
* @version 211.0.0
|
|
40405
41026
|
*/
|
|
40406
41027
|
|
|
40407
41028
|
/**
|
|
@@ -40552,7 +41173,7 @@ class NotificationsApi {
|
|
|
40552
41173
|
/**
|
|
40553
41174
|
* Notifications service.
|
|
40554
41175
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
40555
|
-
* @version
|
|
41176
|
+
* @version 211.0.0
|
|
40556
41177
|
*/
|
|
40557
41178
|
|
|
40558
41179
|
/**
|
|
@@ -40785,7 +41406,7 @@ class OAuthApi {
|
|
|
40785
41406
|
/**
|
|
40786
41407
|
* OAuth service.
|
|
40787
41408
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40788
|
-
* @version
|
|
41409
|
+
* @version 211.0.0
|
|
40789
41410
|
*/
|
|
40790
41411
|
|
|
40791
41412
|
/**
|
|
@@ -41151,7 +41772,7 @@ class ObjectsApi {
|
|
|
41151
41772
|
/**
|
|
41152
41773
|
* Objects service.
|
|
41153
41774
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
41154
|
-
* @version
|
|
41775
|
+
* @version 211.0.0
|
|
41155
41776
|
*/
|
|
41156
41777
|
|
|
41157
41778
|
/**
|
|
@@ -41421,7 +42042,7 @@ class OperationalEventsApi {
|
|
|
41421
42042
|
/**
|
|
41422
42043
|
* OperationalEvents service.
|
|
41423
42044
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
41424
|
-
* @version
|
|
42045
|
+
* @version 211.0.0
|
|
41425
42046
|
*/
|
|
41426
42047
|
|
|
41427
42048
|
/**
|
|
@@ -41538,7 +42159,7 @@ class OrganizationApi {
|
|
|
41538
42159
|
/**
|
|
41539
42160
|
* Organization service.
|
|
41540
42161
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
41541
|
-
* @version
|
|
42162
|
+
* @version 211.0.0
|
|
41542
42163
|
*/
|
|
41543
42164
|
|
|
41544
42165
|
/**
|
|
@@ -42080,7 +42701,7 @@ class OrganizationAuthorizationApi {
|
|
|
42080
42701
|
/**
|
|
42081
42702
|
* OrganizationAuthorization service.
|
|
42082
42703
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
42083
|
-
* @version
|
|
42704
|
+
* @version 211.0.0
|
|
42084
42705
|
*/
|
|
42085
42706
|
|
|
42086
42707
|
/**
|
|
@@ -43474,7 +44095,7 @@ class OutboundApi {
|
|
|
43474
44095
|
/**
|
|
43475
44096
|
* Outbound service.
|
|
43476
44097
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
43477
|
-
* @version
|
|
44098
|
+
* @version 211.0.0
|
|
43478
44099
|
*/
|
|
43479
44100
|
|
|
43480
44101
|
/**
|
|
@@ -48021,7 +48642,7 @@ class PresenceApi {
|
|
|
48021
48642
|
/**
|
|
48022
48643
|
* Presence service.
|
|
48023
48644
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
48024
|
-
* @version
|
|
48645
|
+
* @version 211.0.0
|
|
48025
48646
|
*/
|
|
48026
48647
|
|
|
48027
48648
|
/**
|
|
@@ -48765,7 +49386,7 @@ class ProcessAutomationApi {
|
|
|
48765
49386
|
/**
|
|
48766
49387
|
* ProcessAutomation service.
|
|
48767
49388
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48768
|
-
* @version
|
|
49389
|
+
* @version 211.0.0
|
|
48769
49390
|
*/
|
|
48770
49391
|
|
|
48771
49392
|
/**
|
|
@@ -49004,7 +49625,7 @@ class QualityApi {
|
|
|
49004
49625
|
/**
|
|
49005
49626
|
* Quality service.
|
|
49006
49627
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
49007
|
-
* @version
|
|
49628
|
+
* @version 211.0.0
|
|
49008
49629
|
*/
|
|
49009
49630
|
|
|
49010
49631
|
/**
|
|
@@ -50792,7 +51413,7 @@ class RecordingApi {
|
|
|
50792
51413
|
/**
|
|
50793
51414
|
* Recording service.
|
|
50794
51415
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50795
|
-
* @version
|
|
51416
|
+
* @version 211.0.0
|
|
50796
51417
|
*/
|
|
50797
51418
|
|
|
50798
51419
|
/**
|
|
@@ -52451,7 +53072,7 @@ class ResponseManagementApi {
|
|
|
52451
53072
|
/**
|
|
52452
53073
|
* ResponseManagement service.
|
|
52453
53074
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
52454
|
-
* @version
|
|
53075
|
+
* @version 211.0.0
|
|
52455
53076
|
*/
|
|
52456
53077
|
|
|
52457
53078
|
/**
|
|
@@ -52961,7 +53582,7 @@ class RoutingApi {
|
|
|
52961
53582
|
/**
|
|
52962
53583
|
* Routing service.
|
|
52963
53584
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52964
|
-
* @version
|
|
53585
|
+
* @version 211.0.0
|
|
52965
53586
|
*/
|
|
52966
53587
|
|
|
52967
53588
|
/**
|
|
@@ -57113,7 +57734,7 @@ class SCIMApi {
|
|
|
57113
57734
|
/**
|
|
57114
57735
|
* SCIM service.
|
|
57115
57736
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
57116
|
-
* @version
|
|
57737
|
+
* @version 211.0.0
|
|
57117
57738
|
*/
|
|
57118
57739
|
|
|
57119
57740
|
/**
|
|
@@ -57990,7 +58611,7 @@ class ScreenRecordingApi {
|
|
|
57990
58611
|
/**
|
|
57991
58612
|
* ScreenRecording service.
|
|
57992
58613
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57993
|
-
* @version
|
|
58614
|
+
* @version 211.0.0
|
|
57994
58615
|
*/
|
|
57995
58616
|
|
|
57996
58617
|
/**
|
|
@@ -58035,7 +58656,7 @@ class ScriptsApi {
|
|
|
58035
58656
|
/**
|
|
58036
58657
|
* Scripts service.
|
|
58037
58658
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
58038
|
-
* @version
|
|
58659
|
+
* @version 211.0.0
|
|
58039
58660
|
*/
|
|
58040
58661
|
|
|
58041
58662
|
/**
|
|
@@ -58479,7 +59100,7 @@ class SearchApi {
|
|
|
58479
59100
|
/**
|
|
58480
59101
|
* Search service.
|
|
58481
59102
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
58482
|
-
* @version
|
|
59103
|
+
* @version 211.0.0
|
|
58483
59104
|
*/
|
|
58484
59105
|
|
|
58485
59106
|
/**
|
|
@@ -59222,7 +59843,7 @@ class SettingsApi {
|
|
|
59222
59843
|
/**
|
|
59223
59844
|
* Settings service.
|
|
59224
59845
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
59225
|
-
* @version
|
|
59846
|
+
* @version 211.0.0
|
|
59226
59847
|
*/
|
|
59227
59848
|
|
|
59228
59849
|
/**
|
|
@@ -59442,7 +60063,7 @@ class SocialMediaApi {
|
|
|
59442
60063
|
/**
|
|
59443
60064
|
* SocialMedia service.
|
|
59444
60065
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
59445
|
-
* @version
|
|
60066
|
+
* @version 211.0.0
|
|
59446
60067
|
*/
|
|
59447
60068
|
|
|
59448
60069
|
/**
|
|
@@ -60347,7 +60968,7 @@ class SpeechTextAnalyticsApi {
|
|
|
60347
60968
|
/**
|
|
60348
60969
|
* SpeechTextAnalytics service.
|
|
60349
60970
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
60350
|
-
* @version
|
|
60971
|
+
* @version 211.0.0
|
|
60351
60972
|
*/
|
|
60352
60973
|
|
|
60353
60974
|
/**
|
|
@@ -61682,7 +62303,7 @@ class StationsApi {
|
|
|
61682
62303
|
/**
|
|
61683
62304
|
* Stations service.
|
|
61684
62305
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
61685
|
-
* @version
|
|
62306
|
+
* @version 211.0.0
|
|
61686
62307
|
*/
|
|
61687
62308
|
|
|
61688
62309
|
/**
|
|
@@ -61784,7 +62405,7 @@ class SuggestApi {
|
|
|
61784
62405
|
/**
|
|
61785
62406
|
* Suggest service.
|
|
61786
62407
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
61787
|
-
* @version
|
|
62408
|
+
* @version 211.0.0
|
|
61788
62409
|
*/
|
|
61789
62410
|
|
|
61790
62411
|
/**
|
|
@@ -61923,7 +62544,7 @@ class TaskManagementApi {
|
|
|
61923
62544
|
/**
|
|
61924
62545
|
* TaskManagement service.
|
|
61925
62546
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
61926
|
-
* @version
|
|
62547
|
+
* @version 211.0.0
|
|
61927
62548
|
*/
|
|
61928
62549
|
|
|
61929
62550
|
/**
|
|
@@ -63587,7 +64208,7 @@ class TeamsApi {
|
|
|
63587
64208
|
/**
|
|
63588
64209
|
* Teams service.
|
|
63589
64210
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
63590
|
-
* @version
|
|
64211
|
+
* @version 211.0.0
|
|
63591
64212
|
*/
|
|
63592
64213
|
|
|
63593
64214
|
/**
|
|
@@ -63892,7 +64513,7 @@ class TelephonyApi {
|
|
|
63892
64513
|
/**
|
|
63893
64514
|
* Telephony service.
|
|
63894
64515
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
63895
|
-
* @version
|
|
64516
|
+
* @version 211.0.0
|
|
63896
64517
|
*/
|
|
63897
64518
|
|
|
63898
64519
|
/**
|
|
@@ -64074,7 +64695,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
64074
64695
|
/**
|
|
64075
64696
|
* TelephonyProvidersEdge service.
|
|
64076
64697
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
64077
|
-
* @version
|
|
64698
|
+
* @version 211.0.0
|
|
64078
64699
|
*/
|
|
64079
64700
|
|
|
64080
64701
|
/**
|
|
@@ -67525,7 +68146,7 @@ class TextbotsApi {
|
|
|
67525
68146
|
/**
|
|
67526
68147
|
* Textbots service.
|
|
67527
68148
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
67528
|
-
* @version
|
|
68149
|
+
* @version 211.0.0
|
|
67529
68150
|
*/
|
|
67530
68151
|
|
|
67531
68152
|
/**
|
|
@@ -67653,7 +68274,7 @@ class TokensApi {
|
|
|
67653
68274
|
/**
|
|
67654
68275
|
* Tokens service.
|
|
67655
68276
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
67656
|
-
* @version
|
|
68277
|
+
* @version 211.0.0
|
|
67657
68278
|
*/
|
|
67658
68279
|
|
|
67659
68280
|
/**
|
|
@@ -67807,7 +68428,7 @@ class UploadsApi {
|
|
|
67807
68428
|
/**
|
|
67808
68429
|
* Uploads service.
|
|
67809
68430
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
67810
|
-
* @version
|
|
68431
|
+
* @version 211.0.0
|
|
67811
68432
|
*/
|
|
67812
68433
|
|
|
67813
68434
|
/**
|
|
@@ -68076,7 +68697,7 @@ class UsageApi {
|
|
|
68076
68697
|
/**
|
|
68077
68698
|
* Usage service.
|
|
68078
68699
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
68079
|
-
* @version
|
|
68700
|
+
* @version 211.0.0
|
|
68080
68701
|
*/
|
|
68081
68702
|
|
|
68082
68703
|
/**
|
|
@@ -68291,7 +68912,7 @@ class UserRecordingsApi {
|
|
|
68291
68912
|
/**
|
|
68292
68913
|
* UserRecordings service.
|
|
68293
68914
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
68294
|
-
* @version
|
|
68915
|
+
* @version 211.0.0
|
|
68295
68916
|
*/
|
|
68296
68917
|
|
|
68297
68918
|
/**
|
|
@@ -68506,7 +69127,7 @@ class UsersApi {
|
|
|
68506
69127
|
/**
|
|
68507
69128
|
* Users service.
|
|
68508
69129
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
68509
|
-
* @version
|
|
69130
|
+
* @version 211.0.0
|
|
68510
69131
|
*/
|
|
68511
69132
|
|
|
68512
69133
|
/**
|
|
@@ -71335,7 +71956,7 @@ class UtilitiesApi {
|
|
|
71335
71956
|
/**
|
|
71336
71957
|
* Utilities service.
|
|
71337
71958
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
71338
|
-
* @version
|
|
71959
|
+
* @version 211.0.0
|
|
71339
71960
|
*/
|
|
71340
71961
|
|
|
71341
71962
|
/**
|
|
@@ -71446,7 +72067,7 @@ class VoicemailApi {
|
|
|
71446
72067
|
/**
|
|
71447
72068
|
* Voicemail service.
|
|
71448
72069
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
71449
|
-
* @version
|
|
72070
|
+
* @version 211.0.0
|
|
71450
72071
|
*/
|
|
71451
72072
|
|
|
71452
72073
|
/**
|
|
@@ -72168,7 +72789,7 @@ class WebChatApi {
|
|
|
72168
72789
|
/**
|
|
72169
72790
|
* WebChat service.
|
|
72170
72791
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
72171
|
-
* @version
|
|
72792
|
+
* @version 211.0.0
|
|
72172
72793
|
*/
|
|
72173
72794
|
|
|
72174
72795
|
/**
|
|
@@ -72719,7 +73340,7 @@ class WebDeploymentsApi {
|
|
|
72719
73340
|
/**
|
|
72720
73341
|
* WebDeployments service.
|
|
72721
73342
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
72722
|
-
* @version
|
|
73343
|
+
* @version 211.0.0
|
|
72723
73344
|
*/
|
|
72724
73345
|
|
|
72725
73346
|
/**
|
|
@@ -73246,7 +73867,7 @@ class WebMessagingApi {
|
|
|
73246
73867
|
/**
|
|
73247
73868
|
* WebMessaging service.
|
|
73248
73869
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
73249
|
-
* @version
|
|
73870
|
+
* @version 211.0.0
|
|
73250
73871
|
*/
|
|
73251
73872
|
|
|
73252
73873
|
/**
|
|
@@ -73292,7 +73913,7 @@ class WidgetsApi {
|
|
|
73292
73913
|
/**
|
|
73293
73914
|
* Widgets service.
|
|
73294
73915
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
73295
|
-
* @version
|
|
73916
|
+
* @version 211.0.0
|
|
73296
73917
|
*/
|
|
73297
73918
|
|
|
73298
73919
|
/**
|
|
@@ -73438,7 +74059,7 @@ class WorkforceManagementApi {
|
|
|
73438
74059
|
/**
|
|
73439
74060
|
* WorkforceManagement service.
|
|
73440
74061
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
73441
|
-
* @version
|
|
74062
|
+
* @version 211.0.0
|
|
73442
74063
|
*/
|
|
73443
74064
|
|
|
73444
74065
|
/**
|
|
@@ -76338,12 +76959,8 @@ class WorkforceManagementApi {
|
|
|
76338
76959
|
*
|
|
76339
76960
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
76340
76961
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
76341
|
-
* @param {Object} opts Optional parameters
|
|
76342
|
-
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
76343
76962
|
*/
|
|
76344
|
-
getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId
|
|
76345
|
-
opts = opts || {};
|
|
76346
|
-
|
|
76963
|
+
getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId) {
|
|
76347
76964
|
// verify the required parameter 'managementUnitId' is set
|
|
76348
76965
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
76349
76966
|
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';
|
|
@@ -76357,7 +76974,7 @@ class WorkforceManagementApi {
|
|
|
76357
76974
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests',
|
|
76358
76975
|
'GET',
|
|
76359
76976
|
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
76360
|
-
{
|
|
76977
|
+
{ },
|
|
76361
76978
|
{ },
|
|
76362
76979
|
{ },
|
|
76363
76980
|
null,
|
|
@@ -76848,18 +77465,14 @@ class WorkforceManagementApi {
|
|
|
76848
77465
|
/**
|
|
76849
77466
|
* Get a list of time off requests for the current user
|
|
76850
77467
|
*
|
|
76851
|
-
* @param {Object} opts Optional parameters
|
|
76852
|
-
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
76853
77468
|
*/
|
|
76854
|
-
getWorkforcemanagementTimeoffrequests(
|
|
76855
|
-
opts = opts || {};
|
|
76856
|
-
|
|
77469
|
+
getWorkforcemanagementTimeoffrequests() {
|
|
76857
77470
|
|
|
76858
77471
|
return this.apiClient.callApi(
|
|
76859
77472
|
'/api/v2/workforcemanagement/timeoffrequests',
|
|
76860
77473
|
'GET',
|
|
76861
77474
|
{ },
|
|
76862
|
-
{
|
|
77475
|
+
{ },
|
|
76863
77476
|
{ },
|
|
76864
77477
|
{ },
|
|
76865
77478
|
null,
|
|
@@ -80652,7 +81265,7 @@ class WorkforceManagementApi {
|
|
|
80652
81265
|
* </pre>
|
|
80653
81266
|
* </p>
|
|
80654
81267
|
* @module purecloud-platform-client-v2/index
|
|
80655
|
-
* @version
|
|
81268
|
+
* @version 211.0.0
|
|
80656
81269
|
*/
|
|
80657
81270
|
class platformClient {
|
|
80658
81271
|
constructor() {
|
|
@@ -80741,6 +81354,11 @@ class platformClient {
|
|
|
80741
81354
|
* @property {module:purecloud-platform-client-v2/api/DataExtensionsApi}
|
|
80742
81355
|
*/
|
|
80743
81356
|
this.DataExtensionsApi = DataExtensionsApi;
|
|
81357
|
+
/**
|
|
81358
|
+
* The DataPrivacyApi service constructor.
|
|
81359
|
+
* @property {module:purecloud-platform-client-v2/api/DataPrivacyApi}
|
|
81360
|
+
*/
|
|
81361
|
+
this.DataPrivacyApi = DataPrivacyApi;
|
|
80744
81362
|
/**
|
|
80745
81363
|
* The DownloadsApi service constructor.
|
|
80746
81364
|
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|