purecloud-platform-client-v2 212.0.0 → 213.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 +18 -4
- package/dist/node/purecloud-platform-client-v2.js +767 -255
- package/dist/web-amd/purecloud-platform-client-v2.js +768 -255
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +430 -293
- package/dist/web-cjs/purecloud-platform-client-v2.js +660 -6380
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +441 -2
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +21 -18
- 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 +28 -2
- 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 +35 -18
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +57 -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 +2 -2
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +7 -3
- 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 +288 -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 +119 -1
- package/src/purecloud-platform-client-v2/index.js +8 -3
|
@@ -1,12 +1,10 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var https = require('https');
|
|
4
3
|
var axios = require('axios');
|
|
5
4
|
var qs = require('qs');
|
|
6
5
|
|
|
7
6
|
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
8
7
|
|
|
9
|
-
var https__default = /*#__PURE__*/_interopDefaultLegacy(https);
|
|
10
8
|
var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
|
|
11
9
|
var qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
|
|
12
10
|
|
|
@@ -28,6 +26,138 @@ var PureCloudRegionHosts = {
|
|
|
28
26
|
eu_central_2: 'euc2.pure.cloud',
|
|
29
27
|
};
|
|
30
28
|
|
|
29
|
+
class AbstractHttpClient {
|
|
30
|
+
|
|
31
|
+
constructor() {
|
|
32
|
+
this.timeout = 16000;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
setTimeout(timeout) {
|
|
36
|
+
if (timeout === null || timeout === undefined || typeof timeout !== 'number') {
|
|
37
|
+
throw new Error("The 'timeout' property must be a number");
|
|
38
|
+
}
|
|
39
|
+
this.timeout = timeout;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
setHttpsAgent(httpsAgent) {
|
|
43
|
+
if (httpsAgent && typeof httpsAgent !== 'object') {
|
|
44
|
+
throw new Error("The 'httpsAgent' property must be an object");
|
|
45
|
+
}
|
|
46
|
+
this.httpsAgent = httpsAgent;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
request(httpRequestOptions) {
|
|
50
|
+
throw new Error("method must be implemented");
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
class HttpRequestOptions {
|
|
55
|
+
|
|
56
|
+
constructor(url, method, headers, params, data, timeout) {
|
|
57
|
+
this.setUrl(url);
|
|
58
|
+
this.setMethod(method);
|
|
59
|
+
if (headers) {
|
|
60
|
+
this.setHeaders(headers);
|
|
61
|
+
}
|
|
62
|
+
if (params) {
|
|
63
|
+
this.setParams(params);
|
|
64
|
+
}
|
|
65
|
+
if (data) {
|
|
66
|
+
this.setData(data);
|
|
67
|
+
}
|
|
68
|
+
if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
|
|
69
|
+
else this.timeout = 16000;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
// Mandatory fields with validation
|
|
73
|
+
setUrl(url) {
|
|
74
|
+
if (!url) throw new Error("The 'url' property is required");
|
|
75
|
+
this.url = url;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
setMethod(method) {
|
|
79
|
+
const validMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS', 'HEAD'];
|
|
80
|
+
if (!method || !validMethods.includes(method.toUpperCase())) {
|
|
81
|
+
throw new Error("The 'method' property is invalid or missing");
|
|
82
|
+
}
|
|
83
|
+
this.method = method.toUpperCase();
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
setData(data) {
|
|
87
|
+
if (data === undefined || data === null) {
|
|
88
|
+
throw new Error("The 'data' property is required");
|
|
89
|
+
}
|
|
90
|
+
this.data = data;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
// Optional fields
|
|
94
|
+
setParams(params) {
|
|
95
|
+
if (params && typeof params !== 'object') {
|
|
96
|
+
throw new Error("The 'params' property must be an object");
|
|
97
|
+
}
|
|
98
|
+
this.params = params;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
// Optional fields
|
|
102
|
+
setHeaders(headers) {
|
|
103
|
+
if (headers && typeof headers !== 'object') {
|
|
104
|
+
throw new Error("The 'headers' property must be an object");
|
|
105
|
+
}
|
|
106
|
+
this.headers = headers;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
setTimeout(timeout) {
|
|
110
|
+
if (timeout === undefined || timeout === null || typeof timeout !== 'number') {
|
|
111
|
+
throw new Error("The 'timeout' property must be a number");
|
|
112
|
+
}
|
|
113
|
+
this.timeout = timeout;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
// Default client is Axios
|
|
119
|
+
class DefaultHttpClient extends AbstractHttpClient{
|
|
120
|
+
|
|
121
|
+
constructor(timeout, httpsAgent) {
|
|
122
|
+
super();
|
|
123
|
+
if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
|
|
124
|
+
else this.timeout = 16000;
|
|
125
|
+
if (httpsAgent !== null && httpsAgent !== undefined) this.setHttpsAgent(httpsAgent);
|
|
126
|
+
else this.httpsAgent;
|
|
127
|
+
this._axiosInstance = axios__default["default"].create({});
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
request(httpRequestOptions) {
|
|
131
|
+
if(!(httpRequestOptions instanceof HttpRequestOptions)) {
|
|
132
|
+
throw new Error(`httpRequestOptions must be instance of HttpRequestOptions `);
|
|
133
|
+
}
|
|
134
|
+
const config = this.toAxiosConfig(httpRequestOptions);
|
|
135
|
+
return this._axiosInstance.request(config);
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
// Method to generate Axios-compatible config
|
|
139
|
+
toAxiosConfig(httpRequestOptions) {
|
|
140
|
+
if (!httpRequestOptions.url || !httpRequestOptions.method) {
|
|
141
|
+
throw new Error(
|
|
142
|
+
"Mandatory fields 'url' and 'method' must be set before making a request"
|
|
143
|
+
);
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
var config = {
|
|
147
|
+
url: httpRequestOptions.url,
|
|
148
|
+
method: httpRequestOptions.method
|
|
149
|
+
};
|
|
150
|
+
|
|
151
|
+
if (httpRequestOptions.params) config.params = httpRequestOptions.params;
|
|
152
|
+
if (httpRequestOptions.headers) config.headers = httpRequestOptions.headers;
|
|
153
|
+
if(httpRequestOptions.data) config.data = httpRequestOptions.data;
|
|
154
|
+
if (this.timeout != null && this.timeout != undefined) config.timeout = this.timeout;
|
|
155
|
+
if (this.httpsAgent) config.httpsAgent = this.httpsAgent;
|
|
156
|
+
|
|
157
|
+
return config;
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
|
|
31
161
|
const logLevels = {
|
|
32
162
|
levels: {
|
|
33
163
|
none: 0,
|
|
@@ -488,141 +618,9 @@ class Configuration {
|
|
|
488
618
|
}
|
|
489
619
|
}
|
|
490
620
|
|
|
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
|
-
|
|
623
621
|
/**
|
|
624
622
|
* @module purecloud-platform-client-v2/ApiClient
|
|
625
|
-
* @version
|
|
623
|
+
* @version 213.0.0
|
|
626
624
|
*/
|
|
627
625
|
class ApiClient {
|
|
628
626
|
/**
|
|
@@ -869,11 +867,11 @@ class ApiClient {
|
|
|
869
867
|
|
|
870
868
|
agentOptions.rejectUnauthorized = true;
|
|
871
869
|
|
|
872
|
-
this.proxyAgent = new
|
|
870
|
+
this.proxyAgent = new require('https').Agent(agentOptions);
|
|
873
871
|
const httpClient = this.getHttpClient();
|
|
874
872
|
httpClient.setHttpsAgent(this.proxyAgent);
|
|
875
873
|
} else {
|
|
876
|
-
throw new Error("
|
|
874
|
+
throw new Error("MTLS authentication is managed by the Browser itself. MTLS certificates cannot be set via code on Browser.");
|
|
877
875
|
}
|
|
878
876
|
}
|
|
879
877
|
|
|
@@ -884,24 +882,28 @@ class ApiClient {
|
|
|
884
882
|
* @param {string} caContent - content for public certs
|
|
885
883
|
*/
|
|
886
884
|
setMTLSContents(certContent, keyContent, caContent) {
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
885
|
+
if (typeof window === 'undefined') {
|
|
886
|
+
const agentOptions = {};
|
|
887
|
+
if (certContent) {
|
|
888
|
+
agentOptions.cert = certContent;
|
|
889
|
+
}
|
|
891
890
|
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
891
|
+
if (keyContent) {
|
|
892
|
+
agentOptions.key = keyContent;
|
|
893
|
+
}
|
|
895
894
|
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
895
|
+
if (caContent) {
|
|
896
|
+
agentOptions.ca = caContent;
|
|
897
|
+
}
|
|
899
898
|
|
|
900
|
-
|
|
899
|
+
agentOptions.rejectUnauthorized = true;
|
|
901
900
|
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
901
|
+
this.proxyAgent = new require('https').Agent(agentOptions);
|
|
902
|
+
const httpClient = this.getHttpClient();
|
|
903
|
+
httpClient.setHttpsAgent(this.proxyAgent);
|
|
904
|
+
} else {
|
|
905
|
+
throw new Error("MTLS authentication is managed by the Browser itself. MTLS certificates cannot be set via code on Browser.");
|
|
906
|
+
}
|
|
905
907
|
}
|
|
906
908
|
|
|
907
909
|
/**
|
|
@@ -2142,7 +2144,7 @@ class AgentAssistantsApi {
|
|
|
2142
2144
|
/**
|
|
2143
2145
|
* AgentAssistants service.
|
|
2144
2146
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2145
|
-
* @version
|
|
2147
|
+
* @version 213.0.0
|
|
2146
2148
|
*/
|
|
2147
2149
|
|
|
2148
2150
|
/**
|
|
@@ -2518,7 +2520,7 @@ class AgentCopilotApi {
|
|
|
2518
2520
|
/**
|
|
2519
2521
|
* AgentCopilot service.
|
|
2520
2522
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2521
|
-
* @version
|
|
2523
|
+
* @version 213.0.0
|
|
2522
2524
|
*/
|
|
2523
2525
|
|
|
2524
2526
|
/**
|
|
@@ -2594,7 +2596,7 @@ class AgentUIApi {
|
|
|
2594
2596
|
/**
|
|
2595
2597
|
* AgentUI service.
|
|
2596
2598
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2597
|
-
* @version
|
|
2599
|
+
* @version 213.0.0
|
|
2598
2600
|
*/
|
|
2599
2601
|
|
|
2600
2602
|
/**
|
|
@@ -2725,7 +2727,7 @@ class AlertingApi {
|
|
|
2725
2727
|
/**
|
|
2726
2728
|
* Alerting service.
|
|
2727
2729
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2728
|
-
* @version
|
|
2730
|
+
* @version 213.0.0
|
|
2729
2731
|
*/
|
|
2730
2732
|
|
|
2731
2733
|
/**
|
|
@@ -3386,7 +3388,7 @@ class AnalyticsApi {
|
|
|
3386
3388
|
/**
|
|
3387
3389
|
* Analytics service.
|
|
3388
3390
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3389
|
-
* @version
|
|
3391
|
+
* @version 213.0.0
|
|
3390
3392
|
*/
|
|
3391
3393
|
|
|
3392
3394
|
/**
|
|
@@ -4355,6 +4357,7 @@ class AnalyticsApi {
|
|
|
4355
4357
|
* @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard
|
|
4356
4358
|
* @param {Object} opts Optional parameters
|
|
4357
4359
|
* @param {String} opts.name name of the dashboard
|
|
4360
|
+
* @param {Object} opts.dashboardState List dashboard of given state (default to Active)
|
|
4358
4361
|
* @param {String} opts.sortBy (default to desc)
|
|
4359
4362
|
* @param {Number} opts.pageNumber (default to 1)
|
|
4360
4363
|
* @param {Number} opts.pageSize (default to 9)
|
|
@@ -4375,7 +4378,7 @@ class AnalyticsApi {
|
|
|
4375
4378
|
'/api/v2/analytics/reporting/settings/dashboards/query',
|
|
4376
4379
|
'GET',
|
|
4377
4380
|
{ },
|
|
4378
|
-
{ 'name': opts['name'],'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
4381
|
+
{ 'name': opts['name'],'dashboardType': dashboardType,'dashboardState': opts['dashboardState'],'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
4379
4382
|
{ },
|
|
4380
4383
|
{ },
|
|
4381
4384
|
null,
|
|
@@ -5733,6 +5736,31 @@ class AnalyticsApi {
|
|
|
5733
5736
|
);
|
|
5734
5737
|
}
|
|
5735
5738
|
|
|
5739
|
+
/**
|
|
5740
|
+
* Query for resolution aggregates
|
|
5741
|
+
*
|
|
5742
|
+
* @param {Object} body query
|
|
5743
|
+
*/
|
|
5744
|
+
postAnalyticsResolutionsAggregatesQuery(body) {
|
|
5745
|
+
// verify the required parameter 'body' is set
|
|
5746
|
+
if (body === undefined || body === null) {
|
|
5747
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsResolutionsAggregatesQuery';
|
|
5748
|
+
}
|
|
5749
|
+
|
|
5750
|
+
return this.apiClient.callApi(
|
|
5751
|
+
'/api/v2/analytics/resolutions/aggregates/query',
|
|
5752
|
+
'POST',
|
|
5753
|
+
{ },
|
|
5754
|
+
{ },
|
|
5755
|
+
{ },
|
|
5756
|
+
{ },
|
|
5757
|
+
body,
|
|
5758
|
+
['PureCloud OAuth'],
|
|
5759
|
+
['application/json'],
|
|
5760
|
+
['application/json']
|
|
5761
|
+
);
|
|
5762
|
+
}
|
|
5763
|
+
|
|
5736
5764
|
/**
|
|
5737
5765
|
* Query for user activity observations
|
|
5738
5766
|
*
|
|
@@ -6185,7 +6213,7 @@ class ArchitectApi {
|
|
|
6185
6213
|
/**
|
|
6186
6214
|
* Architect service.
|
|
6187
6215
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6188
|
-
* @version
|
|
6216
|
+
* @version 213.0.0
|
|
6189
6217
|
*/
|
|
6190
6218
|
|
|
6191
6219
|
/**
|
|
@@ -10307,7 +10335,7 @@ class AuditApi {
|
|
|
10307
10335
|
/**
|
|
10308
10336
|
* Audit service.
|
|
10309
10337
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10310
|
-
* @version
|
|
10338
|
+
* @version 213.0.0
|
|
10311
10339
|
*/
|
|
10312
10340
|
|
|
10313
10341
|
/**
|
|
@@ -10508,7 +10536,7 @@ class AuthorizationApi {
|
|
|
10508
10536
|
/**
|
|
10509
10537
|
* Authorization service.
|
|
10510
10538
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10511
|
-
* @version
|
|
10539
|
+
* @version 213.0.0
|
|
10512
10540
|
*/
|
|
10513
10541
|
|
|
10514
10542
|
/**
|
|
@@ -11791,7 +11819,7 @@ class BillingApi {
|
|
|
11791
11819
|
/**
|
|
11792
11820
|
* Billing service.
|
|
11793
11821
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11794
|
-
* @version
|
|
11822
|
+
* @version 213.0.0
|
|
11795
11823
|
*/
|
|
11796
11824
|
|
|
11797
11825
|
/**
|
|
@@ -11871,7 +11899,7 @@ class CarrierServicesApi {
|
|
|
11871
11899
|
/**
|
|
11872
11900
|
* CarrierServices service.
|
|
11873
11901
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11874
|
-
* @version
|
|
11902
|
+
* @version 213.0.0
|
|
11875
11903
|
*/
|
|
11876
11904
|
|
|
11877
11905
|
/**
|
|
@@ -11941,7 +11969,7 @@ class ChatApi {
|
|
|
11941
11969
|
/**
|
|
11942
11970
|
* Chat service.
|
|
11943
11971
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11944
|
-
* @version
|
|
11972
|
+
* @version 213.0.0
|
|
11945
11973
|
*/
|
|
11946
11974
|
|
|
11947
11975
|
/**
|
|
@@ -12877,7 +12905,7 @@ class CoachingApi {
|
|
|
12877
12905
|
/**
|
|
12878
12906
|
* Coaching service.
|
|
12879
12907
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12880
|
-
* @version
|
|
12908
|
+
* @version 213.0.0
|
|
12881
12909
|
*/
|
|
12882
12910
|
|
|
12883
12911
|
/**
|
|
@@ -13454,7 +13482,7 @@ class ContentManagementApi {
|
|
|
13454
13482
|
/**
|
|
13455
13483
|
* ContentManagement service.
|
|
13456
13484
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13457
|
-
* @version
|
|
13485
|
+
* @version 213.0.0
|
|
13458
13486
|
*/
|
|
13459
13487
|
|
|
13460
13488
|
/**
|
|
@@ -14535,7 +14563,7 @@ class ConversationsApi {
|
|
|
14535
14563
|
/**
|
|
14536
14564
|
* Conversations service.
|
|
14537
14565
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14538
|
-
* @version
|
|
14566
|
+
* @version 213.0.0
|
|
14539
14567
|
*/
|
|
14540
14568
|
|
|
14541
14569
|
/**
|
|
@@ -15711,8 +15739,9 @@ class ConversationsApi {
|
|
|
15711
15739
|
|
|
15712
15740
|
/**
|
|
15713
15741
|
* Get chat conversation
|
|
15714
|
-
*
|
|
15742
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
15715
15743
|
* @param {String} conversationId conversationId
|
|
15744
|
+
* @deprecated
|
|
15716
15745
|
*/
|
|
15717
15746
|
getConversationsChat(conversationId) {
|
|
15718
15747
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15736,9 +15765,10 @@ class ConversationsApi {
|
|
|
15736
15765
|
|
|
15737
15766
|
/**
|
|
15738
15767
|
* Get a web chat conversation message
|
|
15739
|
-
* The current user must be involved with the conversation to get its messages.
|
|
15768
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
|
|
15740
15769
|
* @param {String} conversationId conversationId
|
|
15741
15770
|
* @param {String} messageId messageId
|
|
15771
|
+
* @deprecated
|
|
15742
15772
|
*/
|
|
15743
15773
|
getConversationsChatMessage(conversationId, messageId) {
|
|
15744
15774
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15766,13 +15796,14 @@ class ConversationsApi {
|
|
|
15766
15796
|
|
|
15767
15797
|
/**
|
|
15768
15798
|
* Get the messages of a chat conversation.
|
|
15769
|
-
* The current user must be involved with the conversation to get its messages.
|
|
15799
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
|
|
15770
15800
|
* @param {String} conversationId conversationId
|
|
15771
15801
|
* @param {Object} opts Optional parameters
|
|
15772
15802
|
* @param {String} opts.after If specified, get the messages chronologically after the id of this message
|
|
15773
15803
|
* @param {String} opts.before If specified, get the messages chronologically before the id of this message
|
|
15774
15804
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
15775
15805
|
* @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
|
|
15806
|
+
* @deprecated
|
|
15776
15807
|
*/
|
|
15777
15808
|
getConversationsChatMessages(conversationId, opts) {
|
|
15778
15809
|
opts = opts || {};
|
|
@@ -15798,12 +15829,13 @@ class ConversationsApi {
|
|
|
15798
15829
|
|
|
15799
15830
|
/**
|
|
15800
15831
|
* Get the wrap-up for this conversation communication.
|
|
15801
|
-
*
|
|
15832
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
15802
15833
|
* @param {String} conversationId conversationId
|
|
15803
15834
|
* @param {String} participantId participantId
|
|
15804
15835
|
* @param {String} communicationId communicationId
|
|
15805
15836
|
* @param {Object} opts Optional parameters
|
|
15806
15837
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
15838
|
+
* @deprecated
|
|
15807
15839
|
*/
|
|
15808
15840
|
getConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
15809
15841
|
opts = opts || {};
|
|
@@ -15837,11 +15869,12 @@ class ConversationsApi {
|
|
|
15837
15869
|
|
|
15838
15870
|
/**
|
|
15839
15871
|
* Get the wrap-up for this conversation participant.
|
|
15840
|
-
*
|
|
15872
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
15841
15873
|
* @param {String} conversationId conversationId
|
|
15842
15874
|
* @param {String} participantId participantId
|
|
15843
15875
|
* @param {Object} opts Optional parameters
|
|
15844
15876
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
15877
|
+
* @deprecated
|
|
15845
15878
|
*/
|
|
15846
15879
|
getConversationsChatParticipantWrapup(conversationId, participantId, opts) {
|
|
15847
15880
|
opts = opts || {};
|
|
@@ -15871,9 +15904,10 @@ class ConversationsApi {
|
|
|
15871
15904
|
|
|
15872
15905
|
/**
|
|
15873
15906
|
* Get list of wrapup codes for this conversation participant
|
|
15874
|
-
*
|
|
15907
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
15875
15908
|
* @param {String} conversationId conversationId
|
|
15876
15909
|
* @param {String} participantId participantId
|
|
15910
|
+
* @deprecated
|
|
15877
15911
|
*/
|
|
15878
15912
|
getConversationsChatParticipantWrapupcodes(conversationId, participantId) {
|
|
15879
15913
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15901,7 +15935,8 @@ class ConversationsApi {
|
|
|
15901
15935
|
|
|
15902
15936
|
/**
|
|
15903
15937
|
* Get active chat conversations for the logged in user
|
|
15904
|
-
*
|
|
15938
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
15939
|
+
* @deprecated
|
|
15905
15940
|
*/
|
|
15906
15941
|
getConversationsChats() {
|
|
15907
15942
|
|
|
@@ -17823,9 +17858,10 @@ class ConversationsApi {
|
|
|
17823
17858
|
|
|
17824
17859
|
/**
|
|
17825
17860
|
* Update a conversation by disconnecting all of the participants
|
|
17826
|
-
*
|
|
17861
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17827
17862
|
* @param {String} conversationId conversationId
|
|
17828
17863
|
* @param {Object} body Conversation
|
|
17864
|
+
* @deprecated
|
|
17829
17865
|
*/
|
|
17830
17866
|
patchConversationsChat(conversationId, body) {
|
|
17831
17867
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17853,10 +17889,11 @@ class ConversationsApi {
|
|
|
17853
17889
|
|
|
17854
17890
|
/**
|
|
17855
17891
|
* Update conversation participant
|
|
17856
|
-
*
|
|
17892
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17857
17893
|
* @param {String} conversationId conversationId
|
|
17858
17894
|
* @param {String} participantId participantId
|
|
17859
17895
|
* @param {Object} body Update request
|
|
17896
|
+
* @deprecated
|
|
17860
17897
|
*/
|
|
17861
17898
|
patchConversationsChatParticipant(conversationId, participantId, body) {
|
|
17862
17899
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17888,10 +17925,11 @@ class ConversationsApi {
|
|
|
17888
17925
|
|
|
17889
17926
|
/**
|
|
17890
17927
|
* Update the attributes on a conversation participant.
|
|
17891
|
-
*
|
|
17928
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17892
17929
|
* @param {String} conversationId conversationId
|
|
17893
17930
|
* @param {String} participantId participantId
|
|
17894
17931
|
* @param {Object} body Participant attributes
|
|
17932
|
+
* @deprecated
|
|
17895
17933
|
*/
|
|
17896
17934
|
patchConversationsChatParticipantAttributes(conversationId, participantId, body) {
|
|
17897
17935
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17923,11 +17961,12 @@ class ConversationsApi {
|
|
|
17923
17961
|
|
|
17924
17962
|
/**
|
|
17925
17963
|
* Update conversation participant's communication by disconnecting it.
|
|
17926
|
-
*
|
|
17964
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17927
17965
|
* @param {String} conversationId conversationId
|
|
17928
17966
|
* @param {String} participantId participantId
|
|
17929
17967
|
* @param {String} communicationId communicationId
|
|
17930
17968
|
* @param {Object} body Participant
|
|
17969
|
+
* @deprecated
|
|
17931
17970
|
*/
|
|
17932
17971
|
patchConversationsChatParticipantCommunication(conversationId, participantId, communicationId, body) {
|
|
17933
17972
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19830,10 +19869,11 @@ class ConversationsApi {
|
|
|
19830
19869
|
|
|
19831
19870
|
/**
|
|
19832
19871
|
* Send a message on behalf of a communication in a chat conversation.
|
|
19833
|
-
*
|
|
19872
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19834
19873
|
* @param {String} conversationId conversationId
|
|
19835
19874
|
* @param {String} communicationId communicationId
|
|
19836
19875
|
* @param {Object} body Message
|
|
19876
|
+
* @deprecated
|
|
19837
19877
|
*/
|
|
19838
19878
|
postConversationsChatCommunicationMessages(conversationId, communicationId, body) {
|
|
19839
19879
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19865,9 +19905,10 @@ class ConversationsApi {
|
|
|
19865
19905
|
|
|
19866
19906
|
/**
|
|
19867
19907
|
* Send a typing-indicator on behalf of a communication in a chat conversation.
|
|
19868
|
-
*
|
|
19908
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19869
19909
|
* @param {String} conversationId conversationId
|
|
19870
19910
|
* @param {String} communicationId communicationId
|
|
19911
|
+
* @deprecated
|
|
19871
19912
|
*/
|
|
19872
19913
|
postConversationsChatCommunicationTyping(conversationId, communicationId) {
|
|
19873
19914
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19895,12 +19936,13 @@ class ConversationsApi {
|
|
|
19895
19936
|
|
|
19896
19937
|
/**
|
|
19897
19938
|
* Apply wrap-up for this conversation communication
|
|
19898
|
-
*
|
|
19939
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19899
19940
|
* @param {String} conversationId conversationId
|
|
19900
19941
|
* @param {String} participantId participantId
|
|
19901
19942
|
* @param {String} communicationId communicationId
|
|
19902
19943
|
* @param {Object} opts Optional parameters
|
|
19903
19944
|
* @param {Object} opts.body Wrap-up
|
|
19945
|
+
* @deprecated
|
|
19904
19946
|
*/
|
|
19905
19947
|
postConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
19906
19948
|
opts = opts || {};
|
|
@@ -19934,10 +19976,11 @@ class ConversationsApi {
|
|
|
19934
19976
|
|
|
19935
19977
|
/**
|
|
19936
19978
|
* Replace this participant with the specified user and/or address
|
|
19937
|
-
*
|
|
19979
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19938
19980
|
* @param {String} conversationId conversationId
|
|
19939
19981
|
* @param {String} participantId participantId
|
|
19940
19982
|
* @param {Object} body Transfer request
|
|
19983
|
+
* @deprecated
|
|
19941
19984
|
*/
|
|
19942
19985
|
postConversationsChatParticipantReplace(conversationId, participantId, body) {
|
|
19943
19986
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19969,8 +20012,9 @@ class ConversationsApi {
|
|
|
19969
20012
|
|
|
19970
20013
|
/**
|
|
19971
20014
|
* Create a web chat conversation
|
|
19972
|
-
*
|
|
20015
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19973
20016
|
* @param {Object} body Create web chat request
|
|
20017
|
+
* @deprecated
|
|
19974
20018
|
*/
|
|
19975
20019
|
postConversationsChats(body) {
|
|
19976
20020
|
// verify the required parameter 'body' is set
|
|
@@ -21330,9 +21374,10 @@ class ConversationsApi {
|
|
|
21330
21374
|
|
|
21331
21375
|
/**
|
|
21332
21376
|
* Update a conversation by setting its recording state
|
|
21333
|
-
*
|
|
21377
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
21334
21378
|
* @param {String} conversationId conversationId
|
|
21335
21379
|
* @param {Object} body SetRecordingState
|
|
21380
|
+
* @deprecated
|
|
21336
21381
|
*/
|
|
21337
21382
|
putConversationsChatRecordingstate(conversationId, body) {
|
|
21338
21383
|
// verify the required parameter 'conversationId' is set
|
|
@@ -21680,7 +21725,7 @@ class DataExtensionsApi {
|
|
|
21680
21725
|
/**
|
|
21681
21726
|
* DataExtensions service.
|
|
21682
21727
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21683
|
-
* @version
|
|
21728
|
+
* @version 213.0.0
|
|
21684
21729
|
*/
|
|
21685
21730
|
|
|
21686
21731
|
/**
|
|
@@ -21766,7 +21811,7 @@ class DataPrivacyApi {
|
|
|
21766
21811
|
/**
|
|
21767
21812
|
* DataPrivacy service.
|
|
21768
21813
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
21769
|
-
* @version
|
|
21814
|
+
* @version 213.0.0
|
|
21770
21815
|
*/
|
|
21771
21816
|
|
|
21772
21817
|
/**
|
|
@@ -21936,7 +21981,7 @@ class DownloadsApi {
|
|
|
21936
21981
|
/**
|
|
21937
21982
|
* Downloads service.
|
|
21938
21983
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21939
|
-
* @version
|
|
21984
|
+
* @version 213.0.0
|
|
21940
21985
|
*/
|
|
21941
21986
|
|
|
21942
21987
|
/**
|
|
@@ -21988,7 +22033,7 @@ class EmailsApi {
|
|
|
21988
22033
|
/**
|
|
21989
22034
|
* Emails service.
|
|
21990
22035
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21991
|
-
* @version
|
|
22036
|
+
* @version 213.0.0
|
|
21992
22037
|
*/
|
|
21993
22038
|
|
|
21994
22039
|
/**
|
|
@@ -22053,7 +22098,7 @@ class EmployeeEngagementApi {
|
|
|
22053
22098
|
/**
|
|
22054
22099
|
* EmployeeEngagement service.
|
|
22055
22100
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22056
|
-
* @version
|
|
22101
|
+
* @version 213.0.0
|
|
22057
22102
|
*/
|
|
22058
22103
|
|
|
22059
22104
|
/**
|
|
@@ -22204,7 +22249,7 @@ class EventsApi {
|
|
|
22204
22249
|
/**
|
|
22205
22250
|
* Events service.
|
|
22206
22251
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
22207
|
-
* @version
|
|
22252
|
+
* @version 213.0.0
|
|
22208
22253
|
*/
|
|
22209
22254
|
|
|
22210
22255
|
/**
|
|
@@ -22300,7 +22345,7 @@ class ExternalContactsApi {
|
|
|
22300
22345
|
/**
|
|
22301
22346
|
* ExternalContacts service.
|
|
22302
22347
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
22303
|
-
* @version
|
|
22348
|
+
* @version 213.0.0
|
|
22304
22349
|
*/
|
|
22305
22350
|
|
|
22306
22351
|
/**
|
|
@@ -24865,7 +24910,7 @@ class FaxApi {
|
|
|
24865
24910
|
/**
|
|
24866
24911
|
* Fax service.
|
|
24867
24912
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24868
|
-
* @version
|
|
24913
|
+
* @version 213.0.0
|
|
24869
24914
|
*/
|
|
24870
24915
|
|
|
24871
24916
|
/**
|
|
@@ -25080,7 +25125,7 @@ class FlowsApi {
|
|
|
25080
25125
|
/**
|
|
25081
25126
|
* Flows service.
|
|
25082
25127
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25083
|
-
* @version
|
|
25128
|
+
* @version 213.0.0
|
|
25084
25129
|
*/
|
|
25085
25130
|
|
|
25086
25131
|
/**
|
|
@@ -25263,7 +25308,7 @@ class GamificationApi {
|
|
|
25263
25308
|
/**
|
|
25264
25309
|
* Gamification service.
|
|
25265
25310
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25266
|
-
* @version
|
|
25311
|
+
* @version 213.0.0
|
|
25267
25312
|
*/
|
|
25268
25313
|
|
|
25269
25314
|
/**
|
|
@@ -25602,6 +25647,62 @@ class GamificationApi {
|
|
|
25602
25647
|
);
|
|
25603
25648
|
}
|
|
25604
25649
|
|
|
25650
|
+
/**
|
|
25651
|
+
* Get insights rankings
|
|
25652
|
+
*
|
|
25653
|
+
* @param {Object} filterType Filter type for the query request.
|
|
25654
|
+
* @param {String} filterId ID for the filter type.
|
|
25655
|
+
* @param {Object} granularity Granularity
|
|
25656
|
+
* @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
25657
|
+
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
25658
|
+
* @param {Object} sortKey Sort key
|
|
25659
|
+
* @param {Object} opts Optional parameters
|
|
25660
|
+
* @param {String} opts.sortMetricId Sort Metric Id
|
|
25661
|
+
* @param {Number} opts.sectionSize The number of top and bottom users to return before ties
|
|
25662
|
+
* @param {String} opts.userIds A list of up to 100 comma-separated user Ids
|
|
25663
|
+
*/
|
|
25664
|
+
getGamificationInsightsRankings(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, sortKey, opts) {
|
|
25665
|
+
opts = opts || {};
|
|
25666
|
+
|
|
25667
|
+
// verify the required parameter 'filterType' is set
|
|
25668
|
+
if (filterType === undefined || filterType === null) {
|
|
25669
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsRankings';
|
|
25670
|
+
}
|
|
25671
|
+
// verify the required parameter 'filterId' is set
|
|
25672
|
+
if (filterId === undefined || filterId === null) {
|
|
25673
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsRankings';
|
|
25674
|
+
}
|
|
25675
|
+
// verify the required parameter 'granularity' is set
|
|
25676
|
+
if (granularity === undefined || granularity === null) {
|
|
25677
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsRankings';
|
|
25678
|
+
}
|
|
25679
|
+
// verify the required parameter 'comparativePeriodStartWorkday' is set
|
|
25680
|
+
if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
|
|
25681
|
+
throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsRankings';
|
|
25682
|
+
}
|
|
25683
|
+
// verify the required parameter 'primaryPeriodStartWorkday' is set
|
|
25684
|
+
if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
|
|
25685
|
+
throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsRankings';
|
|
25686
|
+
}
|
|
25687
|
+
// verify the required parameter 'sortKey' is set
|
|
25688
|
+
if (sortKey === undefined || sortKey === null) {
|
|
25689
|
+
throw 'Missing the required parameter "sortKey" when calling getGamificationInsightsRankings';
|
|
25690
|
+
}
|
|
25691
|
+
|
|
25692
|
+
return this.apiClient.callApi(
|
|
25693
|
+
'/api/v2/gamification/insights/rankings',
|
|
25694
|
+
'GET',
|
|
25695
|
+
{ },
|
|
25696
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'sortKey': sortKey,'sortMetricId': opts['sortMetricId'],'sectionSize': opts['sectionSize'],'userIds': opts['userIds'] },
|
|
25697
|
+
{ },
|
|
25698
|
+
{ },
|
|
25699
|
+
null,
|
|
25700
|
+
['PureCloud OAuth'],
|
|
25701
|
+
['application/json'],
|
|
25702
|
+
['application/json']
|
|
25703
|
+
);
|
|
25704
|
+
}
|
|
25705
|
+
|
|
25605
25706
|
/**
|
|
25606
25707
|
* Get insights user trend for the current user
|
|
25607
25708
|
*
|
|
@@ -27349,7 +27450,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
27349
27450
|
/**
|
|
27350
27451
|
* GeneralDataProtectionRegulation service.
|
|
27351
27452
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27352
|
-
* @version
|
|
27453
|
+
* @version 213.0.0
|
|
27353
27454
|
*/
|
|
27354
27455
|
|
|
27355
27456
|
/**
|
|
@@ -27479,7 +27580,7 @@ class GeolocationApi {
|
|
|
27479
27580
|
/**
|
|
27480
27581
|
* Geolocation service.
|
|
27481
27582
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27482
|
-
* @version
|
|
27583
|
+
* @version 213.0.0
|
|
27483
27584
|
*/
|
|
27484
27585
|
|
|
27485
27586
|
/**
|
|
@@ -27610,7 +27711,7 @@ class GreetingsApi {
|
|
|
27610
27711
|
/**
|
|
27611
27712
|
* Greetings service.
|
|
27612
27713
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27613
|
-
* @version
|
|
27714
|
+
* @version 213.0.0
|
|
27614
27715
|
*/
|
|
27615
27716
|
|
|
27616
27717
|
/**
|
|
@@ -28065,7 +28166,7 @@ class GroupsApi {
|
|
|
28065
28166
|
/**
|
|
28066
28167
|
* Groups service.
|
|
28067
28168
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28068
|
-
* @version
|
|
28169
|
+
* @version 213.0.0
|
|
28069
28170
|
*/
|
|
28070
28171
|
|
|
28071
28172
|
/**
|
|
@@ -28135,7 +28236,7 @@ class GroupsApi {
|
|
|
28135
28236
|
* Remove members
|
|
28136
28237
|
*
|
|
28137
28238
|
* @param {String} groupId Group ID
|
|
28138
|
-
* @param {String} ids Comma separated list of userIds to remove
|
|
28239
|
+
* @param {String} ids Comma separated list of userIds to remove. A maximum of 50 members are allowed per request.
|
|
28139
28240
|
*/
|
|
28140
28241
|
deleteGroupMembers(groupId, ids) {
|
|
28141
28242
|
// verify the required parameter 'groupId' is set
|
|
@@ -28584,7 +28685,7 @@ class IdentityProviderApi {
|
|
|
28584
28685
|
/**
|
|
28585
28686
|
* IdentityProvider service.
|
|
28586
28687
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28587
|
-
* @version
|
|
28688
|
+
* @version 213.0.0
|
|
28588
28689
|
*/
|
|
28589
28690
|
|
|
28590
28691
|
/**
|
|
@@ -29445,7 +29546,7 @@ class InfrastructureAsCodeApi {
|
|
|
29445
29546
|
/**
|
|
29446
29547
|
* InfrastructureAsCode service.
|
|
29447
29548
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
29448
|
-
* @version
|
|
29549
|
+
* @version 213.0.0
|
|
29449
29550
|
*/
|
|
29450
29551
|
|
|
29451
29552
|
/**
|
|
@@ -29612,7 +29713,7 @@ class IntegrationsApi {
|
|
|
29612
29713
|
/**
|
|
29613
29714
|
* Integrations service.
|
|
29614
29715
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
29615
|
-
* @version
|
|
29716
|
+
* @version 213.0.0
|
|
29616
29717
|
*/
|
|
29617
29718
|
|
|
29618
29719
|
/**
|
|
@@ -32054,7 +32155,7 @@ class JourneyApi {
|
|
|
32054
32155
|
/**
|
|
32055
32156
|
* Journey service.
|
|
32056
32157
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
32057
|
-
* @version
|
|
32158
|
+
* @version 213.0.0
|
|
32058
32159
|
*/
|
|
32059
32160
|
|
|
32060
32161
|
/**
|
|
@@ -34019,7 +34120,7 @@ class KnowledgeApi {
|
|
|
34019
34120
|
/**
|
|
34020
34121
|
* Knowledge service.
|
|
34021
34122
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
34022
|
-
* @version
|
|
34123
|
+
* @version 213.0.0
|
|
34023
34124
|
*/
|
|
34024
34125
|
|
|
34025
34126
|
/**
|
|
@@ -37895,7 +37996,7 @@ class LanguageUnderstandingApi {
|
|
|
37895
37996
|
/**
|
|
37896
37997
|
* LanguageUnderstanding service.
|
|
37897
37998
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
37898
|
-
* @version
|
|
37999
|
+
* @version 213.0.0
|
|
37899
38000
|
*/
|
|
37900
38001
|
|
|
37901
38002
|
/**
|
|
@@ -38928,7 +39029,7 @@ class LanguagesApi {
|
|
|
38928
39029
|
/**
|
|
38929
39030
|
* Languages service.
|
|
38930
39031
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
38931
|
-
* @version
|
|
39032
|
+
* @version 213.0.0
|
|
38932
39033
|
*/
|
|
38933
39034
|
|
|
38934
39035
|
/**
|
|
@@ -39150,7 +39251,7 @@ class LearningApi {
|
|
|
39150
39251
|
/**
|
|
39151
39252
|
* Learning service.
|
|
39152
39253
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
39153
|
-
* @version
|
|
39254
|
+
* @version 213.0.0
|
|
39154
39255
|
*/
|
|
39155
39256
|
|
|
39156
39257
|
/**
|
|
@@ -40179,7 +40280,7 @@ class LicenseApi {
|
|
|
40179
40280
|
/**
|
|
40180
40281
|
* License service.
|
|
40181
40282
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
40182
|
-
* @version
|
|
40283
|
+
* @version 213.0.0
|
|
40183
40284
|
*/
|
|
40184
40285
|
|
|
40185
40286
|
/**
|
|
@@ -40417,7 +40518,7 @@ class LocationsApi {
|
|
|
40417
40518
|
/**
|
|
40418
40519
|
* Locations service.
|
|
40419
40520
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
40420
|
-
* @version
|
|
40521
|
+
* @version 213.0.0
|
|
40421
40522
|
*/
|
|
40422
40523
|
|
|
40423
40524
|
/**
|
|
@@ -40653,7 +40754,7 @@ class LogCaptureApi {
|
|
|
40653
40754
|
/**
|
|
40654
40755
|
* LogCapture service.
|
|
40655
40756
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
40656
|
-
* @version
|
|
40757
|
+
* @version 213.0.0
|
|
40657
40758
|
*/
|
|
40658
40759
|
|
|
40659
40760
|
/**
|
|
@@ -40853,7 +40954,7 @@ class MessagingApi {
|
|
|
40853
40954
|
/**
|
|
40854
40955
|
* Messaging service.
|
|
40855
40956
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
40856
|
-
* @version
|
|
40957
|
+
* @version 213.0.0
|
|
40857
40958
|
*/
|
|
40858
40959
|
|
|
40859
40960
|
/**
|
|
@@ -41212,7 +41313,7 @@ class MobileDevicesApi {
|
|
|
41212
41313
|
/**
|
|
41213
41314
|
* MobileDevices service.
|
|
41214
41315
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
41215
|
-
* @version
|
|
41316
|
+
* @version 213.0.0
|
|
41216
41317
|
*/
|
|
41217
41318
|
|
|
41218
41319
|
/**
|
|
@@ -41363,7 +41464,7 @@ class NotificationsApi {
|
|
|
41363
41464
|
/**
|
|
41364
41465
|
* Notifications service.
|
|
41365
41466
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
41366
|
-
* @version
|
|
41467
|
+
* @version 213.0.0
|
|
41367
41468
|
*/
|
|
41368
41469
|
|
|
41369
41470
|
/**
|
|
@@ -41596,7 +41697,7 @@ class OAuthApi {
|
|
|
41596
41697
|
/**
|
|
41597
41698
|
* OAuth service.
|
|
41598
41699
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
41599
|
-
* @version
|
|
41700
|
+
* @version 213.0.0
|
|
41600
41701
|
*/
|
|
41601
41702
|
|
|
41602
41703
|
/**
|
|
@@ -41962,7 +42063,7 @@ class ObjectsApi {
|
|
|
41962
42063
|
/**
|
|
41963
42064
|
* Objects service.
|
|
41964
42065
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
41965
|
-
* @version
|
|
42066
|
+
* @version 213.0.0
|
|
41966
42067
|
*/
|
|
41967
42068
|
|
|
41968
42069
|
/**
|
|
@@ -42232,7 +42333,7 @@ class OperationalEventsApi {
|
|
|
42232
42333
|
/**
|
|
42233
42334
|
* OperationalEvents service.
|
|
42234
42335
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
42235
|
-
* @version
|
|
42336
|
+
* @version 213.0.0
|
|
42236
42337
|
*/
|
|
42237
42338
|
|
|
42238
42339
|
/**
|
|
@@ -42349,7 +42450,7 @@ class OrganizationApi {
|
|
|
42349
42450
|
/**
|
|
42350
42451
|
* Organization service.
|
|
42351
42452
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
42352
|
-
* @version
|
|
42453
|
+
* @version 213.0.0
|
|
42353
42454
|
*/
|
|
42354
42455
|
|
|
42355
42456
|
/**
|
|
@@ -42891,7 +42992,7 @@ class OrganizationAuthorizationApi {
|
|
|
42891
42992
|
/**
|
|
42892
42993
|
* OrganizationAuthorization service.
|
|
42893
42994
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
42894
|
-
* @version
|
|
42995
|
+
* @version 213.0.0
|
|
42895
42996
|
*/
|
|
42896
42997
|
|
|
42897
42998
|
/**
|
|
@@ -44285,7 +44386,7 @@ class OutboundApi {
|
|
|
44285
44386
|
/**
|
|
44286
44387
|
* Outbound service.
|
|
44287
44388
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
44288
|
-
* @version
|
|
44389
|
+
* @version 213.0.0
|
|
44289
44390
|
*/
|
|
44290
44391
|
|
|
44291
44392
|
/**
|
|
@@ -46582,6 +46683,8 @@ class OutboundApi {
|
|
|
46582
46683
|
* @param {Object} opts.type Campaign Type
|
|
46583
46684
|
* @param {String} opts.senderSmsPhoneNumber Sender SMS Phone Number
|
|
46584
46685
|
* @param {Array.<String>} opts.id A list of messaging campaign ids to bulk fetch
|
|
46686
|
+
* @param {String} opts.contentTemplateId Content template ID
|
|
46687
|
+
* @param {Object} opts.campaignStatus Campaign Status
|
|
46585
46688
|
*/
|
|
46586
46689
|
getOutboundMessagingcampaigns(opts) {
|
|
46587
46690
|
opts = opts || {};
|
|
@@ -46591,7 +46694,7 @@ class OutboundApi {
|
|
|
46591
46694
|
'/api/v2/outbound/messagingcampaigns',
|
|
46592
46695
|
'GET',
|
|
46593
46696
|
{ },
|
|
46594
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'contactListId': opts['contactListId'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'type': opts['type'],'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
46697
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'contactListId': opts['contactListId'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'type': opts['type'],'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'contentTemplateId': opts['contentTemplateId'],'campaignStatus': opts['campaignStatus'] },
|
|
46595
46698
|
{ },
|
|
46596
46699
|
{ },
|
|
46597
46700
|
null,
|
|
@@ -46637,6 +46740,8 @@ class OutboundApi {
|
|
|
46637
46740
|
* @param {Object} opts.type Campaign Type
|
|
46638
46741
|
* @param {Array.<String>} opts.id id
|
|
46639
46742
|
* @param {String} opts.senderSmsPhoneNumber Sender SMS Phone Number
|
|
46743
|
+
* @param {String} opts.contentTemplateId Content template ID
|
|
46744
|
+
* @param {Object} opts.campaignStatus Campaign Status
|
|
46640
46745
|
*/
|
|
46641
46746
|
getOutboundMessagingcampaignsDivisionviews(opts) {
|
|
46642
46747
|
opts = opts || {};
|
|
@@ -46646,7 +46751,7 @@ class OutboundApi {
|
|
|
46646
46751
|
'/api/v2/outbound/messagingcampaigns/divisionviews',
|
|
46647
46752
|
'GET',
|
|
46648
46753
|
{ },
|
|
46649
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'],'type': opts['type'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'] },
|
|
46754
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'],'type': opts['type'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'],'contentTemplateId': opts['contentTemplateId'],'campaignStatus': opts['campaignStatus'] },
|
|
46650
46755
|
{ },
|
|
46651
46756
|
{ },
|
|
46652
46757
|
null,
|
|
@@ -48832,7 +48937,7 @@ class PresenceApi {
|
|
|
48832
48937
|
/**
|
|
48833
48938
|
* Presence service.
|
|
48834
48939
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
48835
|
-
* @version
|
|
48940
|
+
* @version 213.0.0
|
|
48836
48941
|
*/
|
|
48837
48942
|
|
|
48838
48943
|
/**
|
|
@@ -49576,7 +49681,7 @@ class ProcessAutomationApi {
|
|
|
49576
49681
|
/**
|
|
49577
49682
|
* ProcessAutomation service.
|
|
49578
49683
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
49579
|
-
* @version
|
|
49684
|
+
* @version 213.0.0
|
|
49580
49685
|
*/
|
|
49581
49686
|
|
|
49582
49687
|
/**
|
|
@@ -49815,7 +49920,7 @@ class QualityApi {
|
|
|
49815
49920
|
/**
|
|
49816
49921
|
* Quality service.
|
|
49817
49922
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
49818
|
-
* @version
|
|
49923
|
+
* @version 213.0.0
|
|
49819
49924
|
*/
|
|
49820
49925
|
|
|
49821
49926
|
/**
|
|
@@ -51603,7 +51708,7 @@ class RecordingApi {
|
|
|
51603
51708
|
/**
|
|
51604
51709
|
* Recording service.
|
|
51605
51710
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
51606
|
-
* @version
|
|
51711
|
+
* @version 213.0.0
|
|
51607
51712
|
*/
|
|
51608
51713
|
|
|
51609
51714
|
/**
|
|
@@ -53262,7 +53367,7 @@ class ResponseManagementApi {
|
|
|
53262
53367
|
/**
|
|
53263
53368
|
* ResponseManagement service.
|
|
53264
53369
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
53265
|
-
* @version
|
|
53370
|
+
* @version 213.0.0
|
|
53266
53371
|
*/
|
|
53267
53372
|
|
|
53268
53373
|
/**
|
|
@@ -53772,7 +53877,7 @@ class RoutingApi {
|
|
|
53772
53877
|
/**
|
|
53773
53878
|
* Routing service.
|
|
53774
53879
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
53775
|
-
* @version
|
|
53880
|
+
* @version 213.0.0
|
|
53776
53881
|
*/
|
|
53777
53882
|
|
|
53778
53883
|
/**
|
|
@@ -57924,7 +58029,7 @@ class SCIMApi {
|
|
|
57924
58029
|
/**
|
|
57925
58030
|
* SCIM service.
|
|
57926
58031
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
57927
|
-
* @version
|
|
58032
|
+
* @version 213.0.0
|
|
57928
58033
|
*/
|
|
57929
58034
|
|
|
57930
58035
|
/**
|
|
@@ -58801,7 +58906,7 @@ class ScreenRecordingApi {
|
|
|
58801
58906
|
/**
|
|
58802
58907
|
* ScreenRecording service.
|
|
58803
58908
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
58804
|
-
* @version
|
|
58909
|
+
* @version 213.0.0
|
|
58805
58910
|
*/
|
|
58806
58911
|
|
|
58807
58912
|
/**
|
|
@@ -58846,7 +58951,7 @@ class ScriptsApi {
|
|
|
58846
58951
|
/**
|
|
58847
58952
|
* Scripts service.
|
|
58848
58953
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
58849
|
-
* @version
|
|
58954
|
+
* @version 213.0.0
|
|
58850
58955
|
*/
|
|
58851
58956
|
|
|
58852
58957
|
/**
|
|
@@ -59290,7 +59395,7 @@ class SearchApi {
|
|
|
59290
59395
|
/**
|
|
59291
59396
|
* Search service.
|
|
59292
59397
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
59293
|
-
* @version
|
|
59398
|
+
* @version 213.0.0
|
|
59294
59399
|
*/
|
|
59295
59400
|
|
|
59296
59401
|
/**
|
|
@@ -60033,7 +60138,7 @@ class SettingsApi {
|
|
|
60033
60138
|
/**
|
|
60034
60139
|
* Settings service.
|
|
60035
60140
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
60036
|
-
* @version
|
|
60141
|
+
* @version 213.0.0
|
|
60037
60142
|
*/
|
|
60038
60143
|
|
|
60039
60144
|
/**
|
|
@@ -60253,7 +60358,7 @@ class SocialMediaApi {
|
|
|
60253
60358
|
/**
|
|
60254
60359
|
* SocialMedia service.
|
|
60255
60360
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
60256
|
-
* @version
|
|
60361
|
+
* @version 213.0.0
|
|
60257
60362
|
*/
|
|
60258
60363
|
|
|
60259
60364
|
/**
|
|
@@ -61158,7 +61263,7 @@ class SpeechTextAnalyticsApi {
|
|
|
61158
61263
|
/**
|
|
61159
61264
|
* SpeechTextAnalytics service.
|
|
61160
61265
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
61161
|
-
* @version
|
|
61266
|
+
* @version 213.0.0
|
|
61162
61267
|
*/
|
|
61163
61268
|
|
|
61164
61269
|
/**
|
|
@@ -62493,7 +62598,7 @@ class StationsApi {
|
|
|
62493
62598
|
/**
|
|
62494
62599
|
* Stations service.
|
|
62495
62600
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
62496
|
-
* @version
|
|
62601
|
+
* @version 213.0.0
|
|
62497
62602
|
*/
|
|
62498
62603
|
|
|
62499
62604
|
/**
|
|
@@ -62595,7 +62700,7 @@ class SuggestApi {
|
|
|
62595
62700
|
/**
|
|
62596
62701
|
* Suggest service.
|
|
62597
62702
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
62598
|
-
* @version
|
|
62703
|
+
* @version 213.0.0
|
|
62599
62704
|
*/
|
|
62600
62705
|
|
|
62601
62706
|
/**
|
|
@@ -62734,7 +62839,7 @@ class TaskManagementApi {
|
|
|
62734
62839
|
/**
|
|
62735
62840
|
* TaskManagement service.
|
|
62736
62841
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
62737
|
-
* @version
|
|
62842
|
+
* @version 213.0.0
|
|
62738
62843
|
*/
|
|
62739
62844
|
|
|
62740
62845
|
/**
|
|
@@ -62799,6 +62904,56 @@ class TaskManagementApi {
|
|
|
62799
62904
|
);
|
|
62800
62905
|
}
|
|
62801
62906
|
|
|
62907
|
+
/**
|
|
62908
|
+
* Delete a bulk add job
|
|
62909
|
+
*
|
|
62910
|
+
* @param {String} bulkJobId Bulk job id
|
|
62911
|
+
*/
|
|
62912
|
+
deleteTaskmanagementWorkitemsBulkAddJob(bulkJobId) {
|
|
62913
|
+
// verify the required parameter 'bulkJobId' is set
|
|
62914
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
62915
|
+
throw 'Missing the required parameter "bulkJobId" when calling deleteTaskmanagementWorkitemsBulkAddJob';
|
|
62916
|
+
}
|
|
62917
|
+
|
|
62918
|
+
return this.apiClient.callApi(
|
|
62919
|
+
'/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}',
|
|
62920
|
+
'DELETE',
|
|
62921
|
+
{ 'bulkJobId': bulkJobId },
|
|
62922
|
+
{ },
|
|
62923
|
+
{ },
|
|
62924
|
+
{ },
|
|
62925
|
+
null,
|
|
62926
|
+
['PureCloud OAuth'],
|
|
62927
|
+
['application/json'],
|
|
62928
|
+
['application/json']
|
|
62929
|
+
);
|
|
62930
|
+
}
|
|
62931
|
+
|
|
62932
|
+
/**
|
|
62933
|
+
* Delete a Bulk job
|
|
62934
|
+
*
|
|
62935
|
+
* @param {String} bulkJobId Bulk job id
|
|
62936
|
+
*/
|
|
62937
|
+
deleteTaskmanagementWorkitemsBulkTerminateJob(bulkJobId) {
|
|
62938
|
+
// verify the required parameter 'bulkJobId' is set
|
|
62939
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
62940
|
+
throw 'Missing the required parameter "bulkJobId" when calling deleteTaskmanagementWorkitemsBulkTerminateJob';
|
|
62941
|
+
}
|
|
62942
|
+
|
|
62943
|
+
return this.apiClient.callApi(
|
|
62944
|
+
'/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}',
|
|
62945
|
+
'DELETE',
|
|
62946
|
+
{ 'bulkJobId': bulkJobId },
|
|
62947
|
+
{ },
|
|
62948
|
+
{ },
|
|
62949
|
+
{ },
|
|
62950
|
+
null,
|
|
62951
|
+
['PureCloud OAuth'],
|
|
62952
|
+
['application/json'],
|
|
62953
|
+
['application/json']
|
|
62954
|
+
);
|
|
62955
|
+
}
|
|
62956
|
+
|
|
62802
62957
|
/**
|
|
62803
62958
|
* Delete a schema
|
|
62804
62959
|
*
|
|
@@ -63282,6 +63437,133 @@ class TaskManagementApi {
|
|
|
63282
63437
|
);
|
|
63283
63438
|
}
|
|
63284
63439
|
|
|
63440
|
+
/**
|
|
63441
|
+
* Get the bulk add job associated with the job id.
|
|
63442
|
+
*
|
|
63443
|
+
* @param {String} bulkJobId Bulk job id
|
|
63444
|
+
*/
|
|
63445
|
+
getTaskmanagementWorkitemsBulkAddJob(bulkJobId) {
|
|
63446
|
+
// verify the required parameter 'bulkJobId' is set
|
|
63447
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
63448
|
+
throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkAddJob';
|
|
63449
|
+
}
|
|
63450
|
+
|
|
63451
|
+
return this.apiClient.callApi(
|
|
63452
|
+
'/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}',
|
|
63453
|
+
'GET',
|
|
63454
|
+
{ 'bulkJobId': bulkJobId },
|
|
63455
|
+
{ },
|
|
63456
|
+
{ },
|
|
63457
|
+
{ },
|
|
63458
|
+
null,
|
|
63459
|
+
['PureCloud OAuth'],
|
|
63460
|
+
['application/json'],
|
|
63461
|
+
['application/json']
|
|
63462
|
+
);
|
|
63463
|
+
}
|
|
63464
|
+
|
|
63465
|
+
/**
|
|
63466
|
+
* Get bulk add job results.
|
|
63467
|
+
*
|
|
63468
|
+
* @param {String} bulkJobId Bulk job id
|
|
63469
|
+
*/
|
|
63470
|
+
getTaskmanagementWorkitemsBulkAddJobResults(bulkJobId) {
|
|
63471
|
+
// verify the required parameter 'bulkJobId' is set
|
|
63472
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
63473
|
+
throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkAddJobResults';
|
|
63474
|
+
}
|
|
63475
|
+
|
|
63476
|
+
return this.apiClient.callApi(
|
|
63477
|
+
'/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}/results',
|
|
63478
|
+
'GET',
|
|
63479
|
+
{ 'bulkJobId': bulkJobId },
|
|
63480
|
+
{ },
|
|
63481
|
+
{ },
|
|
63482
|
+
{ },
|
|
63483
|
+
null,
|
|
63484
|
+
['PureCloud OAuth'],
|
|
63485
|
+
['application/json'],
|
|
63486
|
+
['application/json']
|
|
63487
|
+
);
|
|
63488
|
+
}
|
|
63489
|
+
|
|
63490
|
+
/**
|
|
63491
|
+
* Get bulk jobs created by the currently logged in user.
|
|
63492
|
+
*
|
|
63493
|
+
* @param {Object} opts Optional parameters
|
|
63494
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
63495
|
+
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
63496
|
+
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
63497
|
+
* @param {Object} opts.action The bulk job action.
|
|
63498
|
+
*/
|
|
63499
|
+
getTaskmanagementWorkitemsBulkJobsUsersMe(opts) {
|
|
63500
|
+
opts = opts || {};
|
|
63501
|
+
|
|
63502
|
+
|
|
63503
|
+
return this.apiClient.callApi(
|
|
63504
|
+
'/api/v2/taskmanagement/workitems/bulk/jobs/users/me',
|
|
63505
|
+
'GET',
|
|
63506
|
+
{ },
|
|
63507
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'action': opts['action'] },
|
|
63508
|
+
{ },
|
|
63509
|
+
{ },
|
|
63510
|
+
null,
|
|
63511
|
+
['PureCloud OAuth'],
|
|
63512
|
+
['application/json'],
|
|
63513
|
+
['application/json']
|
|
63514
|
+
);
|
|
63515
|
+
}
|
|
63516
|
+
|
|
63517
|
+
/**
|
|
63518
|
+
* Get the bulk job associated with the job id.
|
|
63519
|
+
*
|
|
63520
|
+
* @param {String} bulkJobId Bulk job id
|
|
63521
|
+
*/
|
|
63522
|
+
getTaskmanagementWorkitemsBulkTerminateJob(bulkJobId) {
|
|
63523
|
+
// verify the required parameter 'bulkJobId' is set
|
|
63524
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
63525
|
+
throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkTerminateJob';
|
|
63526
|
+
}
|
|
63527
|
+
|
|
63528
|
+
return this.apiClient.callApi(
|
|
63529
|
+
'/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}',
|
|
63530
|
+
'GET',
|
|
63531
|
+
{ 'bulkJobId': bulkJobId },
|
|
63532
|
+
{ },
|
|
63533
|
+
{ },
|
|
63534
|
+
{ },
|
|
63535
|
+
null,
|
|
63536
|
+
['PureCloud OAuth'],
|
|
63537
|
+
['application/json'],
|
|
63538
|
+
['application/json']
|
|
63539
|
+
);
|
|
63540
|
+
}
|
|
63541
|
+
|
|
63542
|
+
/**
|
|
63543
|
+
* Get bulk terminate job results.
|
|
63544
|
+
*
|
|
63545
|
+
* @param {String} bulkJobId Bulk job id
|
|
63546
|
+
*/
|
|
63547
|
+
getTaskmanagementWorkitemsBulkTerminateJobResults(bulkJobId) {
|
|
63548
|
+
// verify the required parameter 'bulkJobId' is set
|
|
63549
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
63550
|
+
throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkTerminateJobResults';
|
|
63551
|
+
}
|
|
63552
|
+
|
|
63553
|
+
return this.apiClient.callApi(
|
|
63554
|
+
'/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}/results',
|
|
63555
|
+
'GET',
|
|
63556
|
+
{ 'bulkJobId': bulkJobId },
|
|
63557
|
+
{ },
|
|
63558
|
+
{ },
|
|
63559
|
+
{ },
|
|
63560
|
+
null,
|
|
63561
|
+
['PureCloud OAuth'],
|
|
63562
|
+
['application/json'],
|
|
63563
|
+
['application/json']
|
|
63564
|
+
);
|
|
63565
|
+
}
|
|
63566
|
+
|
|
63285
63567
|
/**
|
|
63286
63568
|
* Get the workitem query job associated with the job id.
|
|
63287
63569
|
*
|
|
@@ -63947,6 +64229,66 @@ class TaskManagementApi {
|
|
|
63947
64229
|
);
|
|
63948
64230
|
}
|
|
63949
64231
|
|
|
64232
|
+
/**
|
|
64233
|
+
* Update workitem bulk add job.
|
|
64234
|
+
*
|
|
64235
|
+
* @param {String} bulkJobId Bulk job id
|
|
64236
|
+
* @param {Object} body Bulk add job update request
|
|
64237
|
+
*/
|
|
64238
|
+
patchTaskmanagementWorkitemsBulkAddJob(bulkJobId, body) {
|
|
64239
|
+
// verify the required parameter 'bulkJobId' is set
|
|
64240
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
64241
|
+
throw 'Missing the required parameter "bulkJobId" when calling patchTaskmanagementWorkitemsBulkAddJob';
|
|
64242
|
+
}
|
|
64243
|
+
// verify the required parameter 'body' is set
|
|
64244
|
+
if (body === undefined || body === null) {
|
|
64245
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorkitemsBulkAddJob';
|
|
64246
|
+
}
|
|
64247
|
+
|
|
64248
|
+
return this.apiClient.callApi(
|
|
64249
|
+
'/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}',
|
|
64250
|
+
'PATCH',
|
|
64251
|
+
{ 'bulkJobId': bulkJobId },
|
|
64252
|
+
{ },
|
|
64253
|
+
{ },
|
|
64254
|
+
{ },
|
|
64255
|
+
body,
|
|
64256
|
+
['PureCloud OAuth'],
|
|
64257
|
+
['application/json'],
|
|
64258
|
+
['application/json']
|
|
64259
|
+
);
|
|
64260
|
+
}
|
|
64261
|
+
|
|
64262
|
+
/**
|
|
64263
|
+
* Update workitem bulk terminate job.
|
|
64264
|
+
*
|
|
64265
|
+
* @param {String} bulkJobId Bulk job id
|
|
64266
|
+
* @param {Object} body Bulk job update request
|
|
64267
|
+
*/
|
|
64268
|
+
patchTaskmanagementWorkitemsBulkTerminateJob(bulkJobId, body) {
|
|
64269
|
+
// verify the required parameter 'bulkJobId' is set
|
|
64270
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
64271
|
+
throw 'Missing the required parameter "bulkJobId" when calling patchTaskmanagementWorkitemsBulkTerminateJob';
|
|
64272
|
+
}
|
|
64273
|
+
// verify the required parameter 'body' is set
|
|
64274
|
+
if (body === undefined || body === null) {
|
|
64275
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorkitemsBulkTerminateJob';
|
|
64276
|
+
}
|
|
64277
|
+
|
|
64278
|
+
return this.apiClient.callApi(
|
|
64279
|
+
'/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}',
|
|
64280
|
+
'PATCH',
|
|
64281
|
+
{ 'bulkJobId': bulkJobId },
|
|
64282
|
+
{ },
|
|
64283
|
+
{ },
|
|
64284
|
+
{ },
|
|
64285
|
+
body,
|
|
64286
|
+
['PureCloud OAuth'],
|
|
64287
|
+
['application/json'],
|
|
64288
|
+
['application/json']
|
|
64289
|
+
);
|
|
64290
|
+
}
|
|
64291
|
+
|
|
63950
64292
|
/**
|
|
63951
64293
|
* Update the attributes of a worktype
|
|
63952
64294
|
*
|
|
@@ -64271,6 +64613,56 @@ class TaskManagementApi {
|
|
|
64271
64613
|
);
|
|
64272
64614
|
}
|
|
64273
64615
|
|
|
64616
|
+
/**
|
|
64617
|
+
* Create a workitem bulk add job.
|
|
64618
|
+
*
|
|
64619
|
+
* @param {Object} body Bulk job definition.
|
|
64620
|
+
*/
|
|
64621
|
+
postTaskmanagementWorkitemsBulkAddJobs(body) {
|
|
64622
|
+
// verify the required parameter 'body' is set
|
|
64623
|
+
if (body === undefined || body === null) {
|
|
64624
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsBulkAddJobs';
|
|
64625
|
+
}
|
|
64626
|
+
|
|
64627
|
+
return this.apiClient.callApi(
|
|
64628
|
+
'/api/v2/taskmanagement/workitems/bulk/add/jobs',
|
|
64629
|
+
'POST',
|
|
64630
|
+
{ },
|
|
64631
|
+
{ },
|
|
64632
|
+
{ },
|
|
64633
|
+
{ },
|
|
64634
|
+
body,
|
|
64635
|
+
['PureCloud OAuth'],
|
|
64636
|
+
['application/json'],
|
|
64637
|
+
['application/json']
|
|
64638
|
+
);
|
|
64639
|
+
}
|
|
64640
|
+
|
|
64641
|
+
/**
|
|
64642
|
+
* Create a workitem bulk terminate job.
|
|
64643
|
+
*
|
|
64644
|
+
* @param {Object} body Bulk job definition.
|
|
64645
|
+
*/
|
|
64646
|
+
postTaskmanagementWorkitemsBulkTerminateJobs(body) {
|
|
64647
|
+
// verify the required parameter 'body' is set
|
|
64648
|
+
if (body === undefined || body === null) {
|
|
64649
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsBulkTerminateJobs';
|
|
64650
|
+
}
|
|
64651
|
+
|
|
64652
|
+
return this.apiClient.callApi(
|
|
64653
|
+
'/api/v2/taskmanagement/workitems/bulk/terminate/jobs',
|
|
64654
|
+
'POST',
|
|
64655
|
+
{ },
|
|
64656
|
+
{ },
|
|
64657
|
+
{ },
|
|
64658
|
+
{ },
|
|
64659
|
+
body,
|
|
64660
|
+
['PureCloud OAuth'],
|
|
64661
|
+
['application/json'],
|
|
64662
|
+
['application/json']
|
|
64663
|
+
);
|
|
64664
|
+
}
|
|
64665
|
+
|
|
64274
64666
|
/**
|
|
64275
64667
|
* Query for workitems
|
|
64276
64668
|
* This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
|
|
@@ -64553,7 +64945,7 @@ class TeamsApi {
|
|
|
64553
64945
|
/**
|
|
64554
64946
|
* Teams service.
|
|
64555
64947
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
64556
|
-
* @version
|
|
64948
|
+
* @version 213.0.0
|
|
64557
64949
|
*/
|
|
64558
64950
|
|
|
64559
64951
|
/**
|
|
@@ -64858,7 +65250,7 @@ class TelephonyApi {
|
|
|
64858
65250
|
/**
|
|
64859
65251
|
* Telephony service.
|
|
64860
65252
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
64861
|
-
* @version
|
|
65253
|
+
* @version 213.0.0
|
|
64862
65254
|
*/
|
|
64863
65255
|
|
|
64864
65256
|
/**
|
|
@@ -65040,7 +65432,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
65040
65432
|
/**
|
|
65041
65433
|
* TelephonyProvidersEdge service.
|
|
65042
65434
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
65043
|
-
* @version
|
|
65435
|
+
* @version 213.0.0
|
|
65044
65436
|
*/
|
|
65045
65437
|
|
|
65046
65438
|
/**
|
|
@@ -68491,7 +68883,7 @@ class TextbotsApi {
|
|
|
68491
68883
|
/**
|
|
68492
68884
|
* Textbots service.
|
|
68493
68885
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
68494
|
-
* @version
|
|
68886
|
+
* @version 213.0.0
|
|
68495
68887
|
*/
|
|
68496
68888
|
|
|
68497
68889
|
/**
|
|
@@ -68619,7 +69011,7 @@ class TokensApi {
|
|
|
68619
69011
|
/**
|
|
68620
69012
|
* Tokens service.
|
|
68621
69013
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
68622
|
-
* @version
|
|
69014
|
+
* @version 213.0.0
|
|
68623
69015
|
*/
|
|
68624
69016
|
|
|
68625
69017
|
/**
|
|
@@ -68773,7 +69165,7 @@ class UploadsApi {
|
|
|
68773
69165
|
/**
|
|
68774
69166
|
* Uploads service.
|
|
68775
69167
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
68776
|
-
* @version
|
|
69168
|
+
* @version 213.0.0
|
|
68777
69169
|
*/
|
|
68778
69170
|
|
|
68779
69171
|
/**
|
|
@@ -69042,7 +69434,7 @@ class UsageApi {
|
|
|
69042
69434
|
/**
|
|
69043
69435
|
* Usage service.
|
|
69044
69436
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
69045
|
-
* @version
|
|
69437
|
+
* @version 213.0.0
|
|
69046
69438
|
*/
|
|
69047
69439
|
|
|
69048
69440
|
/**
|
|
@@ -69257,7 +69649,7 @@ class UserRecordingsApi {
|
|
|
69257
69649
|
/**
|
|
69258
69650
|
* UserRecordings service.
|
|
69259
69651
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
69260
|
-
* @version
|
|
69652
|
+
* @version 213.0.0
|
|
69261
69653
|
*/
|
|
69262
69654
|
|
|
69263
69655
|
/**
|
|
@@ -69472,7 +69864,7 @@ class UsersApi {
|
|
|
69472
69864
|
/**
|
|
69473
69865
|
* Users service.
|
|
69474
69866
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
69475
|
-
* @version
|
|
69867
|
+
* @version 213.0.0
|
|
69476
69868
|
*/
|
|
69477
69869
|
|
|
69478
69870
|
/**
|
|
@@ -72301,7 +72693,7 @@ class UtilitiesApi {
|
|
|
72301
72693
|
/**
|
|
72302
72694
|
* Utilities service.
|
|
72303
72695
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
72304
|
-
* @version
|
|
72696
|
+
* @version 213.0.0
|
|
72305
72697
|
*/
|
|
72306
72698
|
|
|
72307
72699
|
/**
|
|
@@ -72412,7 +72804,7 @@ class VoicemailApi {
|
|
|
72412
72804
|
/**
|
|
72413
72805
|
* Voicemail service.
|
|
72414
72806
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
72415
|
-
* @version
|
|
72807
|
+
* @version 213.0.0
|
|
72416
72808
|
*/
|
|
72417
72809
|
|
|
72418
72810
|
/**
|
|
@@ -73134,7 +73526,7 @@ class WebChatApi {
|
|
|
73134
73526
|
/**
|
|
73135
73527
|
* WebChat service.
|
|
73136
73528
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
73137
|
-
* @version
|
|
73529
|
+
* @version 213.0.0
|
|
73138
73530
|
*/
|
|
73139
73531
|
|
|
73140
73532
|
/**
|
|
@@ -73685,7 +74077,7 @@ class WebDeploymentsApi {
|
|
|
73685
74077
|
/**
|
|
73686
74078
|
* WebDeployments service.
|
|
73687
74079
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
73688
|
-
* @version
|
|
74080
|
+
* @version 213.0.0
|
|
73689
74081
|
*/
|
|
73690
74082
|
|
|
73691
74083
|
/**
|
|
@@ -74212,7 +74604,7 @@ class WebMessagingApi {
|
|
|
74212
74604
|
/**
|
|
74213
74605
|
* WebMessaging service.
|
|
74214
74606
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
74215
|
-
* @version
|
|
74607
|
+
* @version 213.0.0
|
|
74216
74608
|
*/
|
|
74217
74609
|
|
|
74218
74610
|
/**
|
|
@@ -74258,7 +74650,7 @@ class WidgetsApi {
|
|
|
74258
74650
|
/**
|
|
74259
74651
|
* Widgets service.
|
|
74260
74652
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
74261
|
-
* @version
|
|
74653
|
+
* @version 213.0.0
|
|
74262
74654
|
*/
|
|
74263
74655
|
|
|
74264
74656
|
/**
|
|
@@ -74404,7 +74796,7 @@ class WorkforceManagementApi {
|
|
|
74404
74796
|
/**
|
|
74405
74797
|
* WorkforceManagement service.
|
|
74406
74798
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
74407
|
-
* @version
|
|
74799
|
+
* @version 213.0.0
|
|
74408
74800
|
*/
|
|
74409
74801
|
|
|
74410
74802
|
/**
|
|
@@ -75645,6 +76037,99 @@ class WorkforceManagementApi {
|
|
|
75645
76037
|
);
|
|
75646
76038
|
}
|
|
75647
76039
|
|
|
76040
|
+
/**
|
|
76041
|
+
* Get the latest session for the business unit ID
|
|
76042
|
+
*
|
|
76043
|
+
* @param {String} businessUnitId
|
|
76044
|
+
* getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76045
|
+
*/
|
|
76046
|
+
getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession(businessUnitId) {
|
|
76047
|
+
// verify the required parameter 'businessUnitId' is set
|
|
76048
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
76049
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession';
|
|
76050
|
+
}
|
|
76051
|
+
|
|
76052
|
+
return this.apiClient.callApi(
|
|
76053
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session',
|
|
76054
|
+
'GET',
|
|
76055
|
+
{ 'businessUnitId': businessUnitId },
|
|
76056
|
+
{ },
|
|
76057
|
+
{ },
|
|
76058
|
+
{ },
|
|
76059
|
+
null,
|
|
76060
|
+
['PureCloud OAuth'],
|
|
76061
|
+
['application/json'],
|
|
76062
|
+
['application/json']
|
|
76063
|
+
);
|
|
76064
|
+
}
|
|
76065
|
+
|
|
76066
|
+
/**
|
|
76067
|
+
* Get the session details for the session ID
|
|
76068
|
+
*
|
|
76069
|
+
* @param {String} businessUnitId
|
|
76070
|
+
* @param {String} sessionId
|
|
76071
|
+
* getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76072
|
+
*/
|
|
76073
|
+
getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId(businessUnitId, sessionId) {
|
|
76074
|
+
// verify the required parameter 'businessUnitId' is set
|
|
76075
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
76076
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId';
|
|
76077
|
+
}
|
|
76078
|
+
// verify the required parameter 'sessionId' is set
|
|
76079
|
+
if (sessionId === undefined || sessionId === null) {
|
|
76080
|
+
throw 'Missing the required parameter "sessionId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId';
|
|
76081
|
+
}
|
|
76082
|
+
|
|
76083
|
+
return this.apiClient.callApi(
|
|
76084
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/{sessionId}',
|
|
76085
|
+
'GET',
|
|
76086
|
+
{ 'businessUnitId': businessUnitId,'sessionId': sessionId },
|
|
76087
|
+
{ },
|
|
76088
|
+
{ },
|
|
76089
|
+
{ },
|
|
76090
|
+
null,
|
|
76091
|
+
['PureCloud OAuth'],
|
|
76092
|
+
['application/json'],
|
|
76093
|
+
['application/json']
|
|
76094
|
+
);
|
|
76095
|
+
}
|
|
76096
|
+
|
|
76097
|
+
/**
|
|
76098
|
+
* Get the snapshot details for the snapshot ID
|
|
76099
|
+
*
|
|
76100
|
+
* @param {String} businessUnitId
|
|
76101
|
+
* @param {String} sessionId
|
|
76102
|
+
* @param {String} snapshotId
|
|
76103
|
+
* getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76104
|
+
*/
|
|
76105
|
+
getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId(businessUnitId, sessionId, snapshotId) {
|
|
76106
|
+
// verify the required parameter 'businessUnitId' is set
|
|
76107
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
76108
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId';
|
|
76109
|
+
}
|
|
76110
|
+
// verify the required parameter 'sessionId' is set
|
|
76111
|
+
if (sessionId === undefined || sessionId === null) {
|
|
76112
|
+
throw 'Missing the required parameter "sessionId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId';
|
|
76113
|
+
}
|
|
76114
|
+
// verify the required parameter 'snapshotId' is set
|
|
76115
|
+
if (snapshotId === undefined || snapshotId === null) {
|
|
76116
|
+
throw 'Missing the required parameter "snapshotId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId';
|
|
76117
|
+
}
|
|
76118
|
+
|
|
76119
|
+
return this.apiClient.callApi(
|
|
76120
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/{sessionId}/snapshot/{snapshotId}',
|
|
76121
|
+
'GET',
|
|
76122
|
+
{ 'businessUnitId': businessUnitId,'sessionId': sessionId,'snapshotId': snapshotId },
|
|
76123
|
+
{ },
|
|
76124
|
+
{ },
|
|
76125
|
+
{ },
|
|
76126
|
+
null,
|
|
76127
|
+
['PureCloud OAuth'],
|
|
76128
|
+
['application/json'],
|
|
76129
|
+
['application/json']
|
|
76130
|
+
);
|
|
76131
|
+
}
|
|
76132
|
+
|
|
75648
76133
|
/**
|
|
75649
76134
|
* Get all authorized management units in the business unit
|
|
75650
76135
|
*
|
|
@@ -76875,6 +77360,31 @@ class WorkforceManagementApi {
|
|
|
76875
77360
|
);
|
|
76876
77361
|
}
|
|
76877
77362
|
|
|
77363
|
+
/**
|
|
77364
|
+
* Retrieves status of the historical data imports associated with job id
|
|
77365
|
+
*
|
|
77366
|
+
* @param {String} jobId The job Id of the historical data import request
|
|
77367
|
+
*/
|
|
77368
|
+
getWorkforcemanagementHistoricaldataImportstatusJobId(jobId) {
|
|
77369
|
+
// verify the required parameter 'jobId' is set
|
|
77370
|
+
if (jobId === undefined || jobId === null) {
|
|
77371
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementHistoricaldataImportstatusJobId';
|
|
77372
|
+
}
|
|
77373
|
+
|
|
77374
|
+
return this.apiClient.callApi(
|
|
77375
|
+
'/api/v2/workforcemanagement/historicaldata/importstatus/{jobId}',
|
|
77376
|
+
'GET',
|
|
77377
|
+
{ 'jobId': jobId },
|
|
77378
|
+
{ },
|
|
77379
|
+
{ },
|
|
77380
|
+
{ },
|
|
77381
|
+
null,
|
|
77382
|
+
['PureCloud OAuth'],
|
|
77383
|
+
['application/json'],
|
|
77384
|
+
['application/json']
|
|
77385
|
+
);
|
|
77386
|
+
}
|
|
77387
|
+
|
|
76878
77388
|
/**
|
|
76879
77389
|
* Get integrations
|
|
76880
77390
|
*
|
|
@@ -81610,7 +82120,7 @@ class WorkforceManagementApi {
|
|
|
81610
82120
|
* </pre>
|
|
81611
82121
|
* </p>
|
|
81612
82122
|
* @module purecloud-platform-client-v2/index
|
|
81613
|
-
* @version
|
|
82123
|
+
* @version 213.0.0
|
|
81614
82124
|
*/
|
|
81615
82125
|
class platformClient {
|
|
81616
82126
|
constructor() {
|
|
@@ -82029,8 +82539,10 @@ class platformClient {
|
|
|
82029
82539
|
* @property {module:purecloud-platform-client-v2/MyPureCloudRegionHost}
|
|
82030
82540
|
*/
|
|
82031
82541
|
this.PureCloudRegionHosts = PureCloudRegionHosts;
|
|
82032
|
-
|
|
82033
|
-
|
|
82542
|
+
|
|
82543
|
+
this.AbstractHttpClient = AbstractHttpClient;
|
|
82544
|
+
this.DefaultHttpClient = DefaultHttpClient;
|
|
82545
|
+
this.HttpRequestOptions = HttpRequestOptions;
|
|
82034
82546
|
}
|
|
82035
82547
|
}
|
|
82036
82548
|
|