purecloud-platform-client-v2 211.1.0 → 212.1.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 +1049 -239
- package/dist/web-amd/purecloud-platform-client-v2.js +1050 -239
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +471 -277
- package/dist/web-cjs/purecloud-platform-client-v2.js +662 -6356
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +843 -236
- 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 +212 -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 +7 -3
- 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 +3 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -2
- 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 +2 -2
- 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 +443 -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 +94 -1
- package/src/purecloud-platform-client-v2/index.js +8 -3
|
@@ -1,8 +1,7 @@
|
|
|
1
|
-
define(['
|
|
1
|
+
define(['axios', 'qs'], (function (axios, qs) { 'use strict';
|
|
2
2
|
|
|
3
3
|
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
4
4
|
|
|
5
|
-
var https__default = /*#__PURE__*/_interopDefaultLegacy(https);
|
|
6
5
|
var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
|
|
7
6
|
var qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
|
|
8
7
|
|
|
@@ -24,6 +23,138 @@ define(['https', 'axios', 'qs'], (function (https, axios, qs) { 'use strict';
|
|
|
24
23
|
eu_central_2: 'euc2.pure.cloud',
|
|
25
24
|
};
|
|
26
25
|
|
|
26
|
+
class AbstractHttpClient {
|
|
27
|
+
|
|
28
|
+
constructor() {
|
|
29
|
+
this.timeout = 16000;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
setTimeout(timeout) {
|
|
33
|
+
if (timeout === null || timeout === undefined || typeof timeout !== 'number') {
|
|
34
|
+
throw new Error("The 'timeout' property must be a number");
|
|
35
|
+
}
|
|
36
|
+
this.timeout = timeout;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
setHttpsAgent(httpsAgent) {
|
|
40
|
+
if (httpsAgent && typeof httpsAgent !== 'object') {
|
|
41
|
+
throw new Error("The 'httpsAgent' property must be an object");
|
|
42
|
+
}
|
|
43
|
+
this.httpsAgent = httpsAgent;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
request(httpRequestOptions) {
|
|
47
|
+
throw new Error("method must be implemented");
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
class HttpRequestOptions {
|
|
52
|
+
|
|
53
|
+
constructor(url, method, headers, params, data, timeout) {
|
|
54
|
+
this.setUrl(url);
|
|
55
|
+
this.setMethod(method);
|
|
56
|
+
if (headers) {
|
|
57
|
+
this.setHeaders(headers);
|
|
58
|
+
}
|
|
59
|
+
if (params) {
|
|
60
|
+
this.setParams(params);
|
|
61
|
+
}
|
|
62
|
+
if (data) {
|
|
63
|
+
this.setData(data);
|
|
64
|
+
}
|
|
65
|
+
if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
|
|
66
|
+
else this.timeout = 16000;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
// Mandatory fields with validation
|
|
70
|
+
setUrl(url) {
|
|
71
|
+
if (!url) throw new Error("The 'url' property is required");
|
|
72
|
+
this.url = url;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
setMethod(method) {
|
|
76
|
+
const validMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS', 'HEAD'];
|
|
77
|
+
if (!method || !validMethods.includes(method.toUpperCase())) {
|
|
78
|
+
throw new Error("The 'method' property is invalid or missing");
|
|
79
|
+
}
|
|
80
|
+
this.method = method.toUpperCase();
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
setData(data) {
|
|
84
|
+
if (data === undefined || data === null) {
|
|
85
|
+
throw new Error("The 'data' property is required");
|
|
86
|
+
}
|
|
87
|
+
this.data = data;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
// Optional fields
|
|
91
|
+
setParams(params) {
|
|
92
|
+
if (params && typeof params !== 'object') {
|
|
93
|
+
throw new Error("The 'params' property must be an object");
|
|
94
|
+
}
|
|
95
|
+
this.params = params;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
// Optional fields
|
|
99
|
+
setHeaders(headers) {
|
|
100
|
+
if (headers && typeof headers !== 'object') {
|
|
101
|
+
throw new Error("The 'headers' property must be an object");
|
|
102
|
+
}
|
|
103
|
+
this.headers = headers;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
setTimeout(timeout) {
|
|
107
|
+
if (timeout === undefined || timeout === null || typeof timeout !== 'number') {
|
|
108
|
+
throw new Error("The 'timeout' property must be a number");
|
|
109
|
+
}
|
|
110
|
+
this.timeout = timeout;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
// Default client is Axios
|
|
116
|
+
class DefaultHttpClient extends AbstractHttpClient{
|
|
117
|
+
|
|
118
|
+
constructor(timeout, httpsAgent) {
|
|
119
|
+
super();
|
|
120
|
+
if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
|
|
121
|
+
else this.timeout = 16000;
|
|
122
|
+
if (httpsAgent !== null && httpsAgent !== undefined) this.setHttpsAgent(httpsAgent);
|
|
123
|
+
else this.httpsAgent;
|
|
124
|
+
this._axiosInstance = axios__default["default"].create({});
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
request(httpRequestOptions) {
|
|
128
|
+
if(!(httpRequestOptions instanceof HttpRequestOptions)) {
|
|
129
|
+
throw new Error(`httpRequestOptions must be instance of HttpRequestOptions `);
|
|
130
|
+
}
|
|
131
|
+
const config = this.toAxiosConfig(httpRequestOptions);
|
|
132
|
+
return this._axiosInstance.request(config);
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
// Method to generate Axios-compatible config
|
|
136
|
+
toAxiosConfig(httpRequestOptions) {
|
|
137
|
+
if (!httpRequestOptions.url || !httpRequestOptions.method) {
|
|
138
|
+
throw new Error(
|
|
139
|
+
"Mandatory fields 'url' and 'method' must be set before making a request"
|
|
140
|
+
);
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
var config = {
|
|
144
|
+
url: httpRequestOptions.url,
|
|
145
|
+
method: httpRequestOptions.method
|
|
146
|
+
};
|
|
147
|
+
|
|
148
|
+
if (httpRequestOptions.params) config.params = httpRequestOptions.params;
|
|
149
|
+
if (httpRequestOptions.headers) config.headers = httpRequestOptions.headers;
|
|
150
|
+
if(httpRequestOptions.data) config.data = httpRequestOptions.data;
|
|
151
|
+
if (this.timeout != null && this.timeout != undefined) config.timeout = this.timeout;
|
|
152
|
+
if (this.httpsAgent) config.httpsAgent = this.httpsAgent;
|
|
153
|
+
|
|
154
|
+
return config;
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
|
|
27
158
|
const logLevels = {
|
|
28
159
|
levels: {
|
|
29
160
|
none: 0,
|
|
@@ -484,141 +615,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
484
615
|
}
|
|
485
616
|
}
|
|
486
617
|
|
|
487
|
-
class AbstractHttpClient {
|
|
488
|
-
|
|
489
|
-
constructor() {
|
|
490
|
-
this.timeout = 16000;
|
|
491
|
-
}
|
|
492
|
-
|
|
493
|
-
setTimeout(timeout) {
|
|
494
|
-
if (timeout === null || timeout === undefined || typeof timeout !== 'number') {
|
|
495
|
-
throw new Error("The 'timeout' property must be a number");
|
|
496
|
-
}
|
|
497
|
-
this.timeout = timeout;
|
|
498
|
-
}
|
|
499
|
-
|
|
500
|
-
setHttpsAgent(httpsAgent) {
|
|
501
|
-
if (httpsAgent && typeof httpsAgent !== 'object') {
|
|
502
|
-
throw new Error("The 'httpsAgent' property must be an object");
|
|
503
|
-
}
|
|
504
|
-
this.httpsAgent = httpsAgent;
|
|
505
|
-
}
|
|
506
|
-
|
|
507
|
-
request(httpRequestOptions) {
|
|
508
|
-
throw new Error("method must be implemented");
|
|
509
|
-
}
|
|
510
|
-
}
|
|
511
|
-
|
|
512
|
-
class HttpRequestOptions {
|
|
513
|
-
|
|
514
|
-
constructor(url, method, headers, params, data, timeout) {
|
|
515
|
-
this.setUrl(url);
|
|
516
|
-
this.setMethod(method);
|
|
517
|
-
if (headers) {
|
|
518
|
-
this.setHeaders(headers);
|
|
519
|
-
}
|
|
520
|
-
if (params) {
|
|
521
|
-
this.setParams(params);
|
|
522
|
-
}
|
|
523
|
-
if (data) {
|
|
524
|
-
this.setData(data);
|
|
525
|
-
}
|
|
526
|
-
if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
|
|
527
|
-
else this.timeout = 16000;
|
|
528
|
-
}
|
|
529
|
-
|
|
530
|
-
// Mandatory fields with validation
|
|
531
|
-
setUrl(url) {
|
|
532
|
-
if (!url) throw new Error("The 'url' property is required");
|
|
533
|
-
this.url = url;
|
|
534
|
-
}
|
|
535
|
-
|
|
536
|
-
setMethod(method) {
|
|
537
|
-
const validMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS', 'HEAD'];
|
|
538
|
-
if (!method || !validMethods.includes(method.toUpperCase())) {
|
|
539
|
-
throw new Error("The 'method' property is invalid or missing");
|
|
540
|
-
}
|
|
541
|
-
this.method = method.toUpperCase();
|
|
542
|
-
}
|
|
543
|
-
|
|
544
|
-
setData(data) {
|
|
545
|
-
if (data === undefined || data === null) {
|
|
546
|
-
throw new Error("The 'data' property is required");
|
|
547
|
-
}
|
|
548
|
-
this.data = data;
|
|
549
|
-
}
|
|
550
|
-
|
|
551
|
-
// Optional fields
|
|
552
|
-
setParams(params) {
|
|
553
|
-
if (params && typeof params !== 'object') {
|
|
554
|
-
throw new Error("The 'params' property must be an object");
|
|
555
|
-
}
|
|
556
|
-
this.params = params;
|
|
557
|
-
}
|
|
558
|
-
|
|
559
|
-
// Optional fields
|
|
560
|
-
setHeaders(headers) {
|
|
561
|
-
if (headers && typeof headers !== 'object') {
|
|
562
|
-
throw new Error("The 'headers' property must be an object");
|
|
563
|
-
}
|
|
564
|
-
this.headers = headers;
|
|
565
|
-
}
|
|
566
|
-
|
|
567
|
-
setTimeout(timeout) {
|
|
568
|
-
if (timeout === undefined || timeout === null || typeof timeout !== 'number') {
|
|
569
|
-
throw new Error("The 'timeout' property must be a number");
|
|
570
|
-
}
|
|
571
|
-
this.timeout = timeout;
|
|
572
|
-
}
|
|
573
|
-
|
|
574
|
-
}
|
|
575
|
-
|
|
576
|
-
// Default client is Axios
|
|
577
|
-
class DefaultHttpClient extends AbstractHttpClient{
|
|
578
|
-
|
|
579
|
-
constructor(timeout, httpsAgent) {
|
|
580
|
-
super();
|
|
581
|
-
if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
|
|
582
|
-
else this.timeout = 16000;
|
|
583
|
-
if (httpsAgent !== null && httpsAgent !== undefined) this.setHttpsAgent(httpsAgent);
|
|
584
|
-
else this.httpsAgent;
|
|
585
|
-
this._axiosInstance = axios__default["default"].create({});
|
|
586
|
-
}
|
|
587
|
-
|
|
588
|
-
request(httpRequestOptions) {
|
|
589
|
-
if(!(httpRequestOptions instanceof HttpRequestOptions)) {
|
|
590
|
-
throw new Error(`httpRequestOptions must be instance of HttpRequestOptions `);
|
|
591
|
-
}
|
|
592
|
-
const config = this.toAxiosConfig(httpRequestOptions);
|
|
593
|
-
return this._axiosInstance.request(config);
|
|
594
|
-
}
|
|
595
|
-
|
|
596
|
-
// Method to generate Axios-compatible config
|
|
597
|
-
toAxiosConfig(httpRequestOptions) {
|
|
598
|
-
if (!httpRequestOptions.url || !httpRequestOptions.method) {
|
|
599
|
-
throw new Error(
|
|
600
|
-
"Mandatory fields 'url' and 'method' must be set before making a request"
|
|
601
|
-
);
|
|
602
|
-
}
|
|
603
|
-
|
|
604
|
-
var config = {
|
|
605
|
-
url: httpRequestOptions.url,
|
|
606
|
-
method: httpRequestOptions.method
|
|
607
|
-
};
|
|
608
|
-
|
|
609
|
-
if (httpRequestOptions.params) config.params = httpRequestOptions.params;
|
|
610
|
-
if (httpRequestOptions.headers) config.headers = httpRequestOptions.headers;
|
|
611
|
-
if(httpRequestOptions.data) config.data = httpRequestOptions.data;
|
|
612
|
-
if (this.timeout != null && this.timeout != undefined) config.timeout = this.timeout;
|
|
613
|
-
if (this.httpsAgent) config.httpsAgent = this.httpsAgent;
|
|
614
|
-
|
|
615
|
-
return config;
|
|
616
|
-
}
|
|
617
|
-
}
|
|
618
|
-
|
|
619
618
|
/**
|
|
620
619
|
* @module purecloud-platform-client-v2/ApiClient
|
|
621
|
-
* @version
|
|
620
|
+
* @version 212.1.0
|
|
622
621
|
*/
|
|
623
622
|
class ApiClient {
|
|
624
623
|
/**
|
|
@@ -865,11 +864,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
865
864
|
|
|
866
865
|
agentOptions.rejectUnauthorized = true;
|
|
867
866
|
|
|
868
|
-
this.proxyAgent = new
|
|
867
|
+
this.proxyAgent = new require('https').Agent(agentOptions);
|
|
869
868
|
const httpClient = this.getHttpClient();
|
|
870
869
|
httpClient.setHttpsAgent(this.proxyAgent);
|
|
871
870
|
} else {
|
|
872
|
-
throw new Error("
|
|
871
|
+
throw new Error("MTLS authentication is managed by the Browser itself. MTLS certificates cannot be set via code on Browser.");
|
|
873
872
|
}
|
|
874
873
|
}
|
|
875
874
|
|
|
@@ -880,24 +879,28 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
880
879
|
* @param {string} caContent - content for public certs
|
|
881
880
|
*/
|
|
882
881
|
setMTLSContents(certContent, keyContent, caContent) {
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
882
|
+
if (typeof window === 'undefined') {
|
|
883
|
+
const agentOptions = {};
|
|
884
|
+
if (certContent) {
|
|
885
|
+
agentOptions.cert = certContent;
|
|
886
|
+
}
|
|
887
887
|
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
888
|
+
if (keyContent) {
|
|
889
|
+
agentOptions.key = keyContent;
|
|
890
|
+
}
|
|
891
891
|
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
892
|
+
if (caContent) {
|
|
893
|
+
agentOptions.ca = caContent;
|
|
894
|
+
}
|
|
895
895
|
|
|
896
|
-
|
|
896
|
+
agentOptions.rejectUnauthorized = true;
|
|
897
897
|
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
898
|
+
this.proxyAgent = new require('https').Agent(agentOptions);
|
|
899
|
+
const httpClient = this.getHttpClient();
|
|
900
|
+
httpClient.setHttpsAgent(this.proxyAgent);
|
|
901
|
+
} else {
|
|
902
|
+
throw new Error("MTLS authentication is managed by the Browser itself. MTLS certificates cannot be set via code on Browser.");
|
|
903
|
+
}
|
|
901
904
|
}
|
|
902
905
|
|
|
903
906
|
/**
|
|
@@ -2138,7 +2141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2138
2141
|
/**
|
|
2139
2142
|
* AgentAssistants service.
|
|
2140
2143
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2141
|
-
* @version
|
|
2144
|
+
* @version 212.1.0
|
|
2142
2145
|
*/
|
|
2143
2146
|
|
|
2144
2147
|
/**
|
|
@@ -2514,7 +2517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2514
2517
|
/**
|
|
2515
2518
|
* AgentCopilot service.
|
|
2516
2519
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2517
|
-
* @version
|
|
2520
|
+
* @version 212.1.0
|
|
2518
2521
|
*/
|
|
2519
2522
|
|
|
2520
2523
|
/**
|
|
@@ -2590,7 +2593,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2590
2593
|
/**
|
|
2591
2594
|
* AgentUI service.
|
|
2592
2595
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2593
|
-
* @version
|
|
2596
|
+
* @version 212.1.0
|
|
2594
2597
|
*/
|
|
2595
2598
|
|
|
2596
2599
|
/**
|
|
@@ -2721,7 +2724,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2721
2724
|
/**
|
|
2722
2725
|
* Alerting service.
|
|
2723
2726
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2724
|
-
* @version
|
|
2727
|
+
* @version 212.1.0
|
|
2725
2728
|
*/
|
|
2726
2729
|
|
|
2727
2730
|
/**
|
|
@@ -3382,7 +3385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3382
3385
|
/**
|
|
3383
3386
|
* Analytics service.
|
|
3384
3387
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3385
|
-
* @version
|
|
3388
|
+
* @version 212.1.0
|
|
3386
3389
|
*/
|
|
3387
3390
|
|
|
3388
3391
|
/**
|
|
@@ -3503,6 +3506,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3503
3506
|
);
|
|
3504
3507
|
}
|
|
3505
3508
|
|
|
3509
|
+
/**
|
|
3510
|
+
* Get an agent and their active sessions by user ID
|
|
3511
|
+
*
|
|
3512
|
+
* @param {String} userId userId
|
|
3513
|
+
* getAnalyticsAgentStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3514
|
+
*/
|
|
3515
|
+
getAnalyticsAgentStatus(userId) {
|
|
3516
|
+
// verify the required parameter 'userId' is set
|
|
3517
|
+
if (userId === undefined || userId === null) {
|
|
3518
|
+
throw 'Missing the required parameter "userId" when calling getAnalyticsAgentStatus';
|
|
3519
|
+
}
|
|
3520
|
+
|
|
3521
|
+
return this.apiClient.callApi(
|
|
3522
|
+
'/api/v2/analytics/agents/{userId}/status',
|
|
3523
|
+
'GET',
|
|
3524
|
+
{ 'userId': userId },
|
|
3525
|
+
{ },
|
|
3526
|
+
{ },
|
|
3527
|
+
{ },
|
|
3528
|
+
null,
|
|
3529
|
+
['PureCloud OAuth'],
|
|
3530
|
+
['application/json'],
|
|
3531
|
+
['application/json']
|
|
3532
|
+
);
|
|
3533
|
+
}
|
|
3534
|
+
|
|
3506
3535
|
/**
|
|
3507
3536
|
* Get status for async query for agent copilot aggregates
|
|
3508
3537
|
*
|
|
@@ -4446,6 +4475,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4446
4475
|
);
|
|
4447
4476
|
}
|
|
4448
4477
|
|
|
4478
|
+
/**
|
|
4479
|
+
* Get status for async query for summary aggregates
|
|
4480
|
+
*
|
|
4481
|
+
* @param {String} jobId jobId
|
|
4482
|
+
* getAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4483
|
+
*/
|
|
4484
|
+
getAnalyticsSummariesAggregatesJob(jobId) {
|
|
4485
|
+
// verify the required parameter 'jobId' is set
|
|
4486
|
+
if (jobId === undefined || jobId === null) {
|
|
4487
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsSummariesAggregatesJob';
|
|
4488
|
+
}
|
|
4489
|
+
|
|
4490
|
+
return this.apiClient.callApi(
|
|
4491
|
+
'/api/v2/analytics/summaries/aggregates/jobs/{jobId}',
|
|
4492
|
+
'GET',
|
|
4493
|
+
{ 'jobId': jobId },
|
|
4494
|
+
{ },
|
|
4495
|
+
{ },
|
|
4496
|
+
{ },
|
|
4497
|
+
null,
|
|
4498
|
+
['PureCloud OAuth'],
|
|
4499
|
+
['application/json'],
|
|
4500
|
+
['application/json']
|
|
4501
|
+
);
|
|
4502
|
+
}
|
|
4503
|
+
|
|
4504
|
+
/**
|
|
4505
|
+
* Fetch a page of results for an async aggregates query
|
|
4506
|
+
*
|
|
4507
|
+
* @param {String} jobId jobId
|
|
4508
|
+
* @param {Object} opts Optional parameters
|
|
4509
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
4510
|
+
* getAnalyticsSummariesAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4511
|
+
*/
|
|
4512
|
+
getAnalyticsSummariesAggregatesJobResults(jobId, opts) {
|
|
4513
|
+
opts = opts || {};
|
|
4514
|
+
|
|
4515
|
+
// verify the required parameter 'jobId' is set
|
|
4516
|
+
if (jobId === undefined || jobId === null) {
|
|
4517
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsSummariesAggregatesJobResults';
|
|
4518
|
+
}
|
|
4519
|
+
|
|
4520
|
+
return this.apiClient.callApi(
|
|
4521
|
+
'/api/v2/analytics/summaries/aggregates/jobs/{jobId}/results',
|
|
4522
|
+
'GET',
|
|
4523
|
+
{ 'jobId': jobId },
|
|
4524
|
+
{ 'cursor': opts['cursor'] },
|
|
4525
|
+
{ },
|
|
4526
|
+
{ },
|
|
4527
|
+
null,
|
|
4528
|
+
['PureCloud OAuth'],
|
|
4529
|
+
['application/json'],
|
|
4530
|
+
['application/json']
|
|
4531
|
+
);
|
|
4532
|
+
}
|
|
4533
|
+
|
|
4449
4534
|
/**
|
|
4450
4535
|
* Get status for async query for survey aggregates
|
|
4451
4536
|
*
|
|
@@ -4872,6 +4957,58 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4872
4957
|
);
|
|
4873
4958
|
}
|
|
4874
4959
|
|
|
4960
|
+
/**
|
|
4961
|
+
* Count agents by segment type
|
|
4962
|
+
*
|
|
4963
|
+
* @param {Object} body query
|
|
4964
|
+
* postAnalyticsAgentsStatusCounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4965
|
+
*/
|
|
4966
|
+
postAnalyticsAgentsStatusCounts(body) {
|
|
4967
|
+
// verify the required parameter 'body' is set
|
|
4968
|
+
if (body === undefined || body === null) {
|
|
4969
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsAgentsStatusCounts';
|
|
4970
|
+
}
|
|
4971
|
+
|
|
4972
|
+
return this.apiClient.callApi(
|
|
4973
|
+
'/api/v2/analytics/agents/status/counts',
|
|
4974
|
+
'POST',
|
|
4975
|
+
{ },
|
|
4976
|
+
{ },
|
|
4977
|
+
{ },
|
|
4978
|
+
{ },
|
|
4979
|
+
body,
|
|
4980
|
+
['PureCloud OAuth'],
|
|
4981
|
+
['application/json'],
|
|
4982
|
+
['application/json']
|
|
4983
|
+
);
|
|
4984
|
+
}
|
|
4985
|
+
|
|
4986
|
+
/**
|
|
4987
|
+
* Retrieve the top 50 agents matching the query filters
|
|
4988
|
+
*
|
|
4989
|
+
* @param {Object} body query
|
|
4990
|
+
* postAnalyticsAgentsStatusQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4991
|
+
*/
|
|
4992
|
+
postAnalyticsAgentsStatusQuery(body) {
|
|
4993
|
+
// verify the required parameter 'body' is set
|
|
4994
|
+
if (body === undefined || body === null) {
|
|
4995
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsAgentsStatusQuery';
|
|
4996
|
+
}
|
|
4997
|
+
|
|
4998
|
+
return this.apiClient.callApi(
|
|
4999
|
+
'/api/v2/analytics/agents/status/query',
|
|
5000
|
+
'POST',
|
|
5001
|
+
{ },
|
|
5002
|
+
{ },
|
|
5003
|
+
{ },
|
|
5004
|
+
{ },
|
|
5005
|
+
body,
|
|
5006
|
+
['PureCloud OAuth'],
|
|
5007
|
+
['application/json'],
|
|
5008
|
+
['application/json']
|
|
5009
|
+
);
|
|
5010
|
+
}
|
|
5011
|
+
|
|
4875
5012
|
/**
|
|
4876
5013
|
* Query for bot aggregates asynchronously
|
|
4877
5014
|
*
|
|
@@ -5595,6 +5732,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5595
5732
|
);
|
|
5596
5733
|
}
|
|
5597
5734
|
|
|
5735
|
+
/**
|
|
5736
|
+
* Query for resolution aggregates
|
|
5737
|
+
*
|
|
5738
|
+
* @param {Object} body query
|
|
5739
|
+
*/
|
|
5740
|
+
postAnalyticsResolutionsAggregatesQuery(body) {
|
|
5741
|
+
// verify the required parameter 'body' is set
|
|
5742
|
+
if (body === undefined || body === null) {
|
|
5743
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsResolutionsAggregatesQuery';
|
|
5744
|
+
}
|
|
5745
|
+
|
|
5746
|
+
return this.apiClient.callApi(
|
|
5747
|
+
'/api/v2/analytics/resolutions/aggregates/query',
|
|
5748
|
+
'POST',
|
|
5749
|
+
{ },
|
|
5750
|
+
{ },
|
|
5751
|
+
{ },
|
|
5752
|
+
{ },
|
|
5753
|
+
body,
|
|
5754
|
+
['PureCloud OAuth'],
|
|
5755
|
+
['application/json'],
|
|
5756
|
+
['application/json']
|
|
5757
|
+
);
|
|
5758
|
+
}
|
|
5759
|
+
|
|
5598
5760
|
/**
|
|
5599
5761
|
* Query for user activity observations
|
|
5600
5762
|
*
|
|
@@ -5625,6 +5787,58 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5625
5787
|
);
|
|
5626
5788
|
}
|
|
5627
5789
|
|
|
5790
|
+
/**
|
|
5791
|
+
* Query for summary aggregates asynchronously
|
|
5792
|
+
*
|
|
5793
|
+
* @param {Object} body query
|
|
5794
|
+
* postAnalyticsSummariesAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5795
|
+
*/
|
|
5796
|
+
postAnalyticsSummariesAggregatesJobs(body) {
|
|
5797
|
+
// verify the required parameter 'body' is set
|
|
5798
|
+
if (body === undefined || body === null) {
|
|
5799
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsSummariesAggregatesJobs';
|
|
5800
|
+
}
|
|
5801
|
+
|
|
5802
|
+
return this.apiClient.callApi(
|
|
5803
|
+
'/api/v2/analytics/summaries/aggregates/jobs',
|
|
5804
|
+
'POST',
|
|
5805
|
+
{ },
|
|
5806
|
+
{ },
|
|
5807
|
+
{ },
|
|
5808
|
+
{ },
|
|
5809
|
+
body,
|
|
5810
|
+
['PureCloud OAuth'],
|
|
5811
|
+
['application/json'],
|
|
5812
|
+
['application/json']
|
|
5813
|
+
);
|
|
5814
|
+
}
|
|
5815
|
+
|
|
5816
|
+
/**
|
|
5817
|
+
* Query for summary aggregates
|
|
5818
|
+
*
|
|
5819
|
+
* @param {Object} body query
|
|
5820
|
+
* postAnalyticsSummariesAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5821
|
+
*/
|
|
5822
|
+
postAnalyticsSummariesAggregatesQuery(body) {
|
|
5823
|
+
// verify the required parameter 'body' is set
|
|
5824
|
+
if (body === undefined || body === null) {
|
|
5825
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsSummariesAggregatesQuery';
|
|
5826
|
+
}
|
|
5827
|
+
|
|
5828
|
+
return this.apiClient.callApi(
|
|
5829
|
+
'/api/v2/analytics/summaries/aggregates/query',
|
|
5830
|
+
'POST',
|
|
5831
|
+
{ },
|
|
5832
|
+
{ },
|
|
5833
|
+
{ },
|
|
5834
|
+
{ },
|
|
5835
|
+
body,
|
|
5836
|
+
['PureCloud OAuth'],
|
|
5837
|
+
['application/json'],
|
|
5838
|
+
['application/json']
|
|
5839
|
+
);
|
|
5840
|
+
}
|
|
5841
|
+
|
|
5628
5842
|
/**
|
|
5629
5843
|
* Query for survey aggregates asynchronously
|
|
5630
5844
|
*
|
|
@@ -5995,7 +6209,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5995
6209
|
/**
|
|
5996
6210
|
* Architect service.
|
|
5997
6211
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5998
|
-
* @version
|
|
6212
|
+
* @version 212.1.0
|
|
5999
6213
|
*/
|
|
6000
6214
|
|
|
6001
6215
|
/**
|
|
@@ -10117,7 +10331,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10117
10331
|
/**
|
|
10118
10332
|
* Audit service.
|
|
10119
10333
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10120
|
-
* @version
|
|
10334
|
+
* @version 212.1.0
|
|
10121
10335
|
*/
|
|
10122
10336
|
|
|
10123
10337
|
/**
|
|
@@ -10318,7 +10532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10318
10532
|
/**
|
|
10319
10533
|
* Authorization service.
|
|
10320
10534
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10321
|
-
* @version
|
|
10535
|
+
* @version 212.1.0
|
|
10322
10536
|
*/
|
|
10323
10537
|
|
|
10324
10538
|
/**
|
|
@@ -11601,7 +11815,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11601
11815
|
/**
|
|
11602
11816
|
* Billing service.
|
|
11603
11817
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11604
|
-
* @version
|
|
11818
|
+
* @version 212.1.0
|
|
11605
11819
|
*/
|
|
11606
11820
|
|
|
11607
11821
|
/**
|
|
@@ -11681,7 +11895,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11681
11895
|
/**
|
|
11682
11896
|
* CarrierServices service.
|
|
11683
11897
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11684
|
-
* @version
|
|
11898
|
+
* @version 212.1.0
|
|
11685
11899
|
*/
|
|
11686
11900
|
|
|
11687
11901
|
/**
|
|
@@ -11751,7 +11965,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11751
11965
|
/**
|
|
11752
11966
|
* Chat service.
|
|
11753
11967
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11754
|
-
* @version
|
|
11968
|
+
* @version 212.1.0
|
|
11755
11969
|
*/
|
|
11756
11970
|
|
|
11757
11971
|
/**
|
|
@@ -12687,7 +12901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12687
12901
|
/**
|
|
12688
12902
|
* Coaching service.
|
|
12689
12903
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12690
|
-
* @version
|
|
12904
|
+
* @version 212.1.0
|
|
12691
12905
|
*/
|
|
12692
12906
|
|
|
12693
12907
|
/**
|
|
@@ -13264,7 +13478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13264
13478
|
/**
|
|
13265
13479
|
* ContentManagement service.
|
|
13266
13480
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13267
|
-
* @version
|
|
13481
|
+
* @version 212.1.0
|
|
13268
13482
|
*/
|
|
13269
13483
|
|
|
13270
13484
|
/**
|
|
@@ -14345,7 +14559,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14345
14559
|
/**
|
|
14346
14560
|
* Conversations service.
|
|
14347
14561
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14348
|
-
* @version
|
|
14562
|
+
* @version 212.1.0
|
|
14349
14563
|
*/
|
|
14350
14564
|
|
|
14351
14565
|
/**
|
|
@@ -20552,8 +20766,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20552
20766
|
* Send an agentless outbound message
|
|
20553
20767
|
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the fromAddress and toAddress specified, the useExistingActiveConversation param can be used to barge in to the ongoing conversation.
|
|
20554
20768
|
* @param {Object} body Create agentless outbound messaging request
|
|
20769
|
+
* @param {Object} opts Optional parameters
|
|
20770
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, messagingTemplate) (default to false)
|
|
20555
20771
|
*/
|
|
20556
|
-
postConversationsMessagesAgentless(body) {
|
|
20772
|
+
postConversationsMessagesAgentless(body, opts) {
|
|
20773
|
+
opts = opts || {};
|
|
20774
|
+
|
|
20557
20775
|
// verify the required parameter 'body' is set
|
|
20558
20776
|
if (body === undefined || body === null) {
|
|
20559
20777
|
throw 'Missing the required parameter "body" when calling postConversationsMessagesAgentless';
|
|
@@ -20563,7 +20781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20563
20781
|
'/api/v2/conversations/messages/agentless',
|
|
20564
20782
|
'POST',
|
|
20565
20783
|
{ },
|
|
20566
|
-
{
|
|
20784
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
20567
20785
|
{ },
|
|
20568
20786
|
{ },
|
|
20569
20787
|
body,
|
|
@@ -21486,7 +21704,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21486
21704
|
/**
|
|
21487
21705
|
* DataExtensions service.
|
|
21488
21706
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21489
|
-
* @version
|
|
21707
|
+
* @version 212.1.0
|
|
21490
21708
|
*/
|
|
21491
21709
|
|
|
21492
21710
|
/**
|
|
@@ -21572,7 +21790,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21572
21790
|
/**
|
|
21573
21791
|
* DataPrivacy service.
|
|
21574
21792
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
21575
|
-
* @version
|
|
21793
|
+
* @version 212.1.0
|
|
21576
21794
|
*/
|
|
21577
21795
|
|
|
21578
21796
|
/**
|
|
@@ -21742,7 +21960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21742
21960
|
/**
|
|
21743
21961
|
* Downloads service.
|
|
21744
21962
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21745
|
-
* @version
|
|
21963
|
+
* @version 212.1.0
|
|
21746
21964
|
*/
|
|
21747
21965
|
|
|
21748
21966
|
/**
|
|
@@ -21794,7 +22012,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21794
22012
|
/**
|
|
21795
22013
|
* Emails service.
|
|
21796
22014
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21797
|
-
* @version
|
|
22015
|
+
* @version 212.1.0
|
|
21798
22016
|
*/
|
|
21799
22017
|
|
|
21800
22018
|
/**
|
|
@@ -21859,7 +22077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21859
22077
|
/**
|
|
21860
22078
|
* EmployeeEngagement service.
|
|
21861
22079
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
21862
|
-
* @version
|
|
22080
|
+
* @version 212.1.0
|
|
21863
22081
|
*/
|
|
21864
22082
|
|
|
21865
22083
|
/**
|
|
@@ -22010,7 +22228,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22010
22228
|
/**
|
|
22011
22229
|
* Events service.
|
|
22012
22230
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
22013
|
-
* @version
|
|
22231
|
+
* @version 212.1.0
|
|
22014
22232
|
*/
|
|
22015
22233
|
|
|
22016
22234
|
/**
|
|
@@ -22106,7 +22324,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22106
22324
|
/**
|
|
22107
22325
|
* ExternalContacts service.
|
|
22108
22326
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
22109
|
-
* @version
|
|
22327
|
+
* @version 212.1.0
|
|
22110
22328
|
*/
|
|
22111
22329
|
|
|
22112
22330
|
/**
|
|
@@ -23982,10 +24200,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23982
24200
|
|
|
23983
24201
|
/**
|
|
23984
24202
|
* Fetch a contact using an identifier type and value.
|
|
23985
|
-
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
24203
|
+
* NOTE: Deprecated. Please use /api/v2/externalcontacts/identifierlookup/contacts as an alternative endpoint instead. Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
23986
24204
|
* @param {Object} identifier
|
|
23987
24205
|
* @param {Object} opts Optional parameters
|
|
23988
24206
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
24207
|
+
* @deprecated
|
|
23989
24208
|
*/
|
|
23990
24209
|
postExternalcontactsIdentifierlookup(identifier, opts) {
|
|
23991
24210
|
opts = opts || {};
|
|
@@ -24670,7 +24889,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24670
24889
|
/**
|
|
24671
24890
|
* Fax service.
|
|
24672
24891
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24673
|
-
* @version
|
|
24892
|
+
* @version 212.1.0
|
|
24674
24893
|
*/
|
|
24675
24894
|
|
|
24676
24895
|
/**
|
|
@@ -24885,7 +25104,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24885
25104
|
/**
|
|
24886
25105
|
* Flows service.
|
|
24887
25106
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
24888
|
-
* @version
|
|
25107
|
+
* @version 212.1.0
|
|
24889
25108
|
*/
|
|
24890
25109
|
|
|
24891
25110
|
/**
|
|
@@ -25068,7 +25287,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25068
25287
|
/**
|
|
25069
25288
|
* Gamification service.
|
|
25070
25289
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25071
|
-
* @version
|
|
25290
|
+
* @version 212.1.0
|
|
25072
25291
|
*/
|
|
25073
25292
|
|
|
25074
25293
|
/**
|
|
@@ -25407,6 +25626,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25407
25626
|
);
|
|
25408
25627
|
}
|
|
25409
25628
|
|
|
25629
|
+
/**
|
|
25630
|
+
* Get insights rankings
|
|
25631
|
+
*
|
|
25632
|
+
* @param {Object} filterType Filter type for the query request.
|
|
25633
|
+
* @param {String} filterId ID for the filter type.
|
|
25634
|
+
* @param {Object} granularity Granularity
|
|
25635
|
+
* @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
25636
|
+
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
25637
|
+
* @param {Object} sortKey Sort key
|
|
25638
|
+
* @param {Object} opts Optional parameters
|
|
25639
|
+
* @param {String} opts.sortMetricId Sort Metric Id
|
|
25640
|
+
* @param {Number} opts.sectionSize The number of top and bottom users to return before ties
|
|
25641
|
+
* @param {String} opts.userIds A list of up to 100 comma-separated user Ids
|
|
25642
|
+
*/
|
|
25643
|
+
getGamificationInsightsRankings(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, sortKey, opts) {
|
|
25644
|
+
opts = opts || {};
|
|
25645
|
+
|
|
25646
|
+
// verify the required parameter 'filterType' is set
|
|
25647
|
+
if (filterType === undefined || filterType === null) {
|
|
25648
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsRankings';
|
|
25649
|
+
}
|
|
25650
|
+
// verify the required parameter 'filterId' is set
|
|
25651
|
+
if (filterId === undefined || filterId === null) {
|
|
25652
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsRankings';
|
|
25653
|
+
}
|
|
25654
|
+
// verify the required parameter 'granularity' is set
|
|
25655
|
+
if (granularity === undefined || granularity === null) {
|
|
25656
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsRankings';
|
|
25657
|
+
}
|
|
25658
|
+
// verify the required parameter 'comparativePeriodStartWorkday' is set
|
|
25659
|
+
if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
|
|
25660
|
+
throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsRankings';
|
|
25661
|
+
}
|
|
25662
|
+
// verify the required parameter 'primaryPeriodStartWorkday' is set
|
|
25663
|
+
if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
|
|
25664
|
+
throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsRankings';
|
|
25665
|
+
}
|
|
25666
|
+
// verify the required parameter 'sortKey' is set
|
|
25667
|
+
if (sortKey === undefined || sortKey === null) {
|
|
25668
|
+
throw 'Missing the required parameter "sortKey" when calling getGamificationInsightsRankings';
|
|
25669
|
+
}
|
|
25670
|
+
|
|
25671
|
+
return this.apiClient.callApi(
|
|
25672
|
+
'/api/v2/gamification/insights/rankings',
|
|
25673
|
+
'GET',
|
|
25674
|
+
{ },
|
|
25675
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'sortKey': sortKey,'sortMetricId': opts['sortMetricId'],'sectionSize': opts['sectionSize'],'userIds': opts['userIds'] },
|
|
25676
|
+
{ },
|
|
25677
|
+
{ },
|
|
25678
|
+
null,
|
|
25679
|
+
['PureCloud OAuth'],
|
|
25680
|
+
['application/json'],
|
|
25681
|
+
['application/json']
|
|
25682
|
+
);
|
|
25683
|
+
}
|
|
25684
|
+
|
|
25410
25685
|
/**
|
|
25411
25686
|
* Get insights user trend for the current user
|
|
25412
25687
|
*
|
|
@@ -27154,7 +27429,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27154
27429
|
/**
|
|
27155
27430
|
* GeneralDataProtectionRegulation service.
|
|
27156
27431
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27157
|
-
* @version
|
|
27432
|
+
* @version 212.1.0
|
|
27158
27433
|
*/
|
|
27159
27434
|
|
|
27160
27435
|
/**
|
|
@@ -27284,7 +27559,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27284
27559
|
/**
|
|
27285
27560
|
* Geolocation service.
|
|
27286
27561
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27287
|
-
* @version
|
|
27562
|
+
* @version 212.1.0
|
|
27288
27563
|
*/
|
|
27289
27564
|
|
|
27290
27565
|
/**
|
|
@@ -27415,7 +27690,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27415
27690
|
/**
|
|
27416
27691
|
* Greetings service.
|
|
27417
27692
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27418
|
-
* @version
|
|
27693
|
+
* @version 212.1.0
|
|
27419
27694
|
*/
|
|
27420
27695
|
|
|
27421
27696
|
/**
|
|
@@ -27870,7 +28145,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27870
28145
|
/**
|
|
27871
28146
|
* Groups service.
|
|
27872
28147
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27873
|
-
* @version
|
|
28148
|
+
* @version 212.1.0
|
|
27874
28149
|
*/
|
|
27875
28150
|
|
|
27876
28151
|
/**
|
|
@@ -28389,7 +28664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28389
28664
|
/**
|
|
28390
28665
|
* IdentityProvider service.
|
|
28391
28666
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28392
|
-
* @version
|
|
28667
|
+
* @version 212.1.0
|
|
28393
28668
|
*/
|
|
28394
28669
|
|
|
28395
28670
|
/**
|
|
@@ -29250,7 +29525,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29250
29525
|
/**
|
|
29251
29526
|
* InfrastructureAsCode service.
|
|
29252
29527
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
29253
|
-
* @version
|
|
29528
|
+
* @version 212.1.0
|
|
29254
29529
|
*/
|
|
29255
29530
|
|
|
29256
29531
|
/**
|
|
@@ -29417,7 +29692,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29417
29692
|
/**
|
|
29418
29693
|
* Integrations service.
|
|
29419
29694
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
29420
|
-
* @version
|
|
29695
|
+
* @version 212.1.0
|
|
29421
29696
|
*/
|
|
29422
29697
|
|
|
29423
29698
|
/**
|
|
@@ -31859,7 +32134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31859
32134
|
/**
|
|
31860
32135
|
* Journey service.
|
|
31861
32136
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
31862
|
-
* @version
|
|
32137
|
+
* @version 212.1.0
|
|
31863
32138
|
*/
|
|
31864
32139
|
|
|
31865
32140
|
/**
|
|
@@ -33824,7 +34099,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33824
34099
|
/**
|
|
33825
34100
|
* Knowledge service.
|
|
33826
34101
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
33827
|
-
* @version
|
|
34102
|
+
* @version 212.1.0
|
|
33828
34103
|
*/
|
|
33829
34104
|
|
|
33830
34105
|
/**
|
|
@@ -37700,7 +37975,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37700
37975
|
/**
|
|
37701
37976
|
* LanguageUnderstanding service.
|
|
37702
37977
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
37703
|
-
* @version
|
|
37978
|
+
* @version 212.1.0
|
|
37704
37979
|
*/
|
|
37705
37980
|
|
|
37706
37981
|
/**
|
|
@@ -38343,7 +38618,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38343
38618
|
/**
|
|
38344
38619
|
* Get Organization Configuration
|
|
38345
38620
|
*
|
|
38346
|
-
* getLanguageunderstandingSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38347
38621
|
*/
|
|
38348
38622
|
getLanguageunderstandingSettings() {
|
|
38349
38623
|
|
|
@@ -38734,7 +39008,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38734
39008
|
/**
|
|
38735
39009
|
* Languages service.
|
|
38736
39010
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
38737
|
-
* @version
|
|
39011
|
+
* @version 212.1.0
|
|
38738
39012
|
*/
|
|
38739
39013
|
|
|
38740
39014
|
/**
|
|
@@ -38956,7 +39230,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38956
39230
|
/**
|
|
38957
39231
|
* Learning service.
|
|
38958
39232
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
38959
|
-
* @version
|
|
39233
|
+
* @version 212.1.0
|
|
38960
39234
|
*/
|
|
38961
39235
|
|
|
38962
39236
|
/**
|
|
@@ -39985,7 +40259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39985
40259
|
/**
|
|
39986
40260
|
* License service.
|
|
39987
40261
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
39988
|
-
* @version
|
|
40262
|
+
* @version 212.1.0
|
|
39989
40263
|
*/
|
|
39990
40264
|
|
|
39991
40265
|
/**
|
|
@@ -40223,7 +40497,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40223
40497
|
/**
|
|
40224
40498
|
* Locations service.
|
|
40225
40499
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
40226
|
-
* @version
|
|
40500
|
+
* @version 212.1.0
|
|
40227
40501
|
*/
|
|
40228
40502
|
|
|
40229
40503
|
/**
|
|
@@ -40459,7 +40733,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40459
40733
|
/**
|
|
40460
40734
|
* LogCapture service.
|
|
40461
40735
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
40462
|
-
* @version
|
|
40736
|
+
* @version 212.1.0
|
|
40463
40737
|
*/
|
|
40464
40738
|
|
|
40465
40739
|
/**
|
|
@@ -40659,7 +40933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40659
40933
|
/**
|
|
40660
40934
|
* Messaging service.
|
|
40661
40935
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
40662
|
-
* @version
|
|
40936
|
+
* @version 212.1.0
|
|
40663
40937
|
*/
|
|
40664
40938
|
|
|
40665
40939
|
/**
|
|
@@ -41018,7 +41292,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41018
41292
|
/**
|
|
41019
41293
|
* MobileDevices service.
|
|
41020
41294
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
41021
|
-
* @version
|
|
41295
|
+
* @version 212.1.0
|
|
41022
41296
|
*/
|
|
41023
41297
|
|
|
41024
41298
|
/**
|
|
@@ -41169,7 +41443,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41169
41443
|
/**
|
|
41170
41444
|
* Notifications service.
|
|
41171
41445
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
41172
|
-
* @version
|
|
41446
|
+
* @version 212.1.0
|
|
41173
41447
|
*/
|
|
41174
41448
|
|
|
41175
41449
|
/**
|
|
@@ -41402,7 +41676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41402
41676
|
/**
|
|
41403
41677
|
* OAuth service.
|
|
41404
41678
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
41405
|
-
* @version
|
|
41679
|
+
* @version 212.1.0
|
|
41406
41680
|
*/
|
|
41407
41681
|
|
|
41408
41682
|
/**
|
|
@@ -41768,7 +42042,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41768
42042
|
/**
|
|
41769
42043
|
* Objects service.
|
|
41770
42044
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
41771
|
-
* @version
|
|
42045
|
+
* @version 212.1.0
|
|
41772
42046
|
*/
|
|
41773
42047
|
|
|
41774
42048
|
/**
|
|
@@ -42038,7 +42312,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42038
42312
|
/**
|
|
42039
42313
|
* OperationalEvents service.
|
|
42040
42314
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
42041
|
-
* @version
|
|
42315
|
+
* @version 212.1.0
|
|
42042
42316
|
*/
|
|
42043
42317
|
|
|
42044
42318
|
/**
|
|
@@ -42155,7 +42429,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42155
42429
|
/**
|
|
42156
42430
|
* Organization service.
|
|
42157
42431
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
42158
|
-
* @version
|
|
42432
|
+
* @version 212.1.0
|
|
42159
42433
|
*/
|
|
42160
42434
|
|
|
42161
42435
|
/**
|
|
@@ -42697,7 +42971,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42697
42971
|
/**
|
|
42698
42972
|
* OrganizationAuthorization service.
|
|
42699
42973
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
42700
|
-
* @version
|
|
42974
|
+
* @version 212.1.0
|
|
42701
42975
|
*/
|
|
42702
42976
|
|
|
42703
42977
|
/**
|
|
@@ -44091,7 +44365,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44091
44365
|
/**
|
|
44092
44366
|
* Outbound service.
|
|
44093
44367
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
44094
|
-
* @version
|
|
44368
|
+
* @version 212.1.0
|
|
44095
44369
|
*/
|
|
44096
44370
|
|
|
44097
44371
|
/**
|
|
@@ -48638,7 +48912,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48638
48912
|
/**
|
|
48639
48913
|
* Presence service.
|
|
48640
48914
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
48641
|
-
* @version
|
|
48915
|
+
* @version 212.1.0
|
|
48642
48916
|
*/
|
|
48643
48917
|
|
|
48644
48918
|
/**
|
|
@@ -49382,7 +49656,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49382
49656
|
/**
|
|
49383
49657
|
* ProcessAutomation service.
|
|
49384
49658
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
49385
|
-
* @version
|
|
49659
|
+
* @version 212.1.0
|
|
49386
49660
|
*/
|
|
49387
49661
|
|
|
49388
49662
|
/**
|
|
@@ -49621,7 +49895,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49621
49895
|
/**
|
|
49622
49896
|
* Quality service.
|
|
49623
49897
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
49624
|
-
* @version
|
|
49898
|
+
* @version 212.1.0
|
|
49625
49899
|
*/
|
|
49626
49900
|
|
|
49627
49901
|
/**
|
|
@@ -51409,7 +51683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51409
51683
|
/**
|
|
51410
51684
|
* Recording service.
|
|
51411
51685
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
51412
|
-
* @version
|
|
51686
|
+
* @version 212.1.0
|
|
51413
51687
|
*/
|
|
51414
51688
|
|
|
51415
51689
|
/**
|
|
@@ -53068,7 +53342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53068
53342
|
/**
|
|
53069
53343
|
* ResponseManagement service.
|
|
53070
53344
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
53071
|
-
* @version
|
|
53345
|
+
* @version 212.1.0
|
|
53072
53346
|
*/
|
|
53073
53347
|
|
|
53074
53348
|
/**
|
|
@@ -53578,7 +53852,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53578
53852
|
/**
|
|
53579
53853
|
* Routing service.
|
|
53580
53854
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
53581
|
-
* @version
|
|
53855
|
+
* @version 212.1.0
|
|
53582
53856
|
*/
|
|
53583
53857
|
|
|
53584
53858
|
/**
|
|
@@ -56223,7 +56497,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56223
56497
|
}
|
|
56224
56498
|
|
|
56225
56499
|
/**
|
|
56226
|
-
* Join or unjoin a set of users for a queue
|
|
56500
|
+
* Join or unjoin a set of up to 100 users for a queue
|
|
56227
56501
|
*
|
|
56228
56502
|
* @param {String} queueId Queue ID
|
|
56229
56503
|
* @param {Array.<Object>} body Queue Members
|
|
@@ -57730,7 +58004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57730
58004
|
/**
|
|
57731
58005
|
* SCIM service.
|
|
57732
58006
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
57733
|
-
* @version
|
|
58007
|
+
* @version 212.1.0
|
|
57734
58008
|
*/
|
|
57735
58009
|
|
|
57736
58010
|
/**
|
|
@@ -58607,7 +58881,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58607
58881
|
/**
|
|
58608
58882
|
* ScreenRecording service.
|
|
58609
58883
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
58610
|
-
* @version
|
|
58884
|
+
* @version 212.1.0
|
|
58611
58885
|
*/
|
|
58612
58886
|
|
|
58613
58887
|
/**
|
|
@@ -58652,7 +58926,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58652
58926
|
/**
|
|
58653
58927
|
* Scripts service.
|
|
58654
58928
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
58655
|
-
* @version
|
|
58929
|
+
* @version 212.1.0
|
|
58656
58930
|
*/
|
|
58657
58931
|
|
|
58658
58932
|
/**
|
|
@@ -59096,7 +59370,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59096
59370
|
/**
|
|
59097
59371
|
* Search service.
|
|
59098
59372
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
59099
|
-
* @version
|
|
59373
|
+
* @version 212.1.0
|
|
59100
59374
|
*/
|
|
59101
59375
|
|
|
59102
59376
|
/**
|
|
@@ -59839,7 +60113,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59839
60113
|
/**
|
|
59840
60114
|
* Settings service.
|
|
59841
60115
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
59842
|
-
* @version
|
|
60116
|
+
* @version 212.1.0
|
|
59843
60117
|
*/
|
|
59844
60118
|
|
|
59845
60119
|
/**
|
|
@@ -60059,7 +60333,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60059
60333
|
/**
|
|
60060
60334
|
* SocialMedia service.
|
|
60061
60335
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
60062
|
-
* @version
|
|
60336
|
+
* @version 212.1.0
|
|
60063
60337
|
*/
|
|
60064
60338
|
|
|
60065
60339
|
/**
|
|
@@ -60964,7 +61238,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60964
61238
|
/**
|
|
60965
61239
|
* SpeechTextAnalytics service.
|
|
60966
61240
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
60967
|
-
* @version
|
|
61241
|
+
* @version 212.1.0
|
|
60968
61242
|
*/
|
|
60969
61243
|
|
|
60970
61244
|
/**
|
|
@@ -62299,7 +62573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62299
62573
|
/**
|
|
62300
62574
|
* Stations service.
|
|
62301
62575
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
62302
|
-
* @version
|
|
62576
|
+
* @version 212.1.0
|
|
62303
62577
|
*/
|
|
62304
62578
|
|
|
62305
62579
|
/**
|
|
@@ -62401,7 +62675,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62401
62675
|
/**
|
|
62402
62676
|
* Suggest service.
|
|
62403
62677
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
62404
|
-
* @version
|
|
62678
|
+
* @version 212.1.0
|
|
62405
62679
|
*/
|
|
62406
62680
|
|
|
62407
62681
|
/**
|
|
@@ -62540,7 +62814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62540
62814
|
/**
|
|
62541
62815
|
* TaskManagement service.
|
|
62542
62816
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
62543
|
-
* @version
|
|
62817
|
+
* @version 212.1.0
|
|
62544
62818
|
*/
|
|
62545
62819
|
|
|
62546
62820
|
/**
|
|
@@ -62605,6 +62879,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62605
62879
|
);
|
|
62606
62880
|
}
|
|
62607
62881
|
|
|
62882
|
+
/**
|
|
62883
|
+
* Delete a bulk add job
|
|
62884
|
+
*
|
|
62885
|
+
* @param {String} bulkJobId Bulk job id
|
|
62886
|
+
*/
|
|
62887
|
+
deleteTaskmanagementWorkitemsBulkAddJob(bulkJobId) {
|
|
62888
|
+
// verify the required parameter 'bulkJobId' is set
|
|
62889
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
62890
|
+
throw 'Missing the required parameter "bulkJobId" when calling deleteTaskmanagementWorkitemsBulkAddJob';
|
|
62891
|
+
}
|
|
62892
|
+
|
|
62893
|
+
return this.apiClient.callApi(
|
|
62894
|
+
'/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}',
|
|
62895
|
+
'DELETE',
|
|
62896
|
+
{ 'bulkJobId': bulkJobId },
|
|
62897
|
+
{ },
|
|
62898
|
+
{ },
|
|
62899
|
+
{ },
|
|
62900
|
+
null,
|
|
62901
|
+
['PureCloud OAuth'],
|
|
62902
|
+
['application/json'],
|
|
62903
|
+
['application/json']
|
|
62904
|
+
);
|
|
62905
|
+
}
|
|
62906
|
+
|
|
62907
|
+
/**
|
|
62908
|
+
* Delete a Bulk job
|
|
62909
|
+
*
|
|
62910
|
+
* @param {String} bulkJobId Bulk job id
|
|
62911
|
+
*/
|
|
62912
|
+
deleteTaskmanagementWorkitemsBulkTerminateJob(bulkJobId) {
|
|
62913
|
+
// verify the required parameter 'bulkJobId' is set
|
|
62914
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
62915
|
+
throw 'Missing the required parameter "bulkJobId" when calling deleteTaskmanagementWorkitemsBulkTerminateJob';
|
|
62916
|
+
}
|
|
62917
|
+
|
|
62918
|
+
return this.apiClient.callApi(
|
|
62919
|
+
'/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}',
|
|
62920
|
+
'DELETE',
|
|
62921
|
+
{ 'bulkJobId': bulkJobId },
|
|
62922
|
+
{ },
|
|
62923
|
+
{ },
|
|
62924
|
+
{ },
|
|
62925
|
+
null,
|
|
62926
|
+
['PureCloud OAuth'],
|
|
62927
|
+
['application/json'],
|
|
62928
|
+
['application/json']
|
|
62929
|
+
);
|
|
62930
|
+
}
|
|
62931
|
+
|
|
62608
62932
|
/**
|
|
62609
62933
|
* Delete a schema
|
|
62610
62934
|
*
|
|
@@ -62655,6 +62979,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62655
62979
|
);
|
|
62656
62980
|
}
|
|
62657
62981
|
|
|
62982
|
+
/**
|
|
62983
|
+
* Delete a date based rule
|
|
62984
|
+
*
|
|
62985
|
+
* @param {String} worktypeId Worktype id
|
|
62986
|
+
* @param {String} ruleId ruleId
|
|
62987
|
+
*/
|
|
62988
|
+
deleteTaskmanagementWorktypeFlowsDatebasedRule(worktypeId, ruleId) {
|
|
62989
|
+
// verify the required parameter 'worktypeId' is set
|
|
62990
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
62991
|
+
throw 'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsDatebasedRule';
|
|
62992
|
+
}
|
|
62993
|
+
// verify the required parameter 'ruleId' is set
|
|
62994
|
+
if (ruleId === undefined || ruleId === null) {
|
|
62995
|
+
throw 'Missing the required parameter "ruleId" when calling deleteTaskmanagementWorktypeFlowsDatebasedRule';
|
|
62996
|
+
}
|
|
62997
|
+
|
|
62998
|
+
return this.apiClient.callApi(
|
|
62999
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId}',
|
|
63000
|
+
'DELETE',
|
|
63001
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
63002
|
+
{ },
|
|
63003
|
+
{ },
|
|
63004
|
+
{ },
|
|
63005
|
+
null,
|
|
63006
|
+
['PureCloud OAuth'],
|
|
63007
|
+
['application/json'],
|
|
63008
|
+
['application/json']
|
|
63009
|
+
);
|
|
63010
|
+
}
|
|
63011
|
+
|
|
62658
63012
|
/**
|
|
62659
63013
|
* Delete a rule
|
|
62660
63014
|
*
|
|
@@ -63058,6 +63412,133 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63058
63412
|
);
|
|
63059
63413
|
}
|
|
63060
63414
|
|
|
63415
|
+
/**
|
|
63416
|
+
* Get the bulk add job associated with the job id.
|
|
63417
|
+
*
|
|
63418
|
+
* @param {String} bulkJobId Bulk job id
|
|
63419
|
+
*/
|
|
63420
|
+
getTaskmanagementWorkitemsBulkAddJob(bulkJobId) {
|
|
63421
|
+
// verify the required parameter 'bulkJobId' is set
|
|
63422
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
63423
|
+
throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkAddJob';
|
|
63424
|
+
}
|
|
63425
|
+
|
|
63426
|
+
return this.apiClient.callApi(
|
|
63427
|
+
'/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}',
|
|
63428
|
+
'GET',
|
|
63429
|
+
{ 'bulkJobId': bulkJobId },
|
|
63430
|
+
{ },
|
|
63431
|
+
{ },
|
|
63432
|
+
{ },
|
|
63433
|
+
null,
|
|
63434
|
+
['PureCloud OAuth'],
|
|
63435
|
+
['application/json'],
|
|
63436
|
+
['application/json']
|
|
63437
|
+
);
|
|
63438
|
+
}
|
|
63439
|
+
|
|
63440
|
+
/**
|
|
63441
|
+
* Get bulk add job results.
|
|
63442
|
+
*
|
|
63443
|
+
* @param {String} bulkJobId Bulk job id
|
|
63444
|
+
*/
|
|
63445
|
+
getTaskmanagementWorkitemsBulkAddJobResults(bulkJobId) {
|
|
63446
|
+
// verify the required parameter 'bulkJobId' is set
|
|
63447
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
63448
|
+
throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkAddJobResults';
|
|
63449
|
+
}
|
|
63450
|
+
|
|
63451
|
+
return this.apiClient.callApi(
|
|
63452
|
+
'/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}/results',
|
|
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 jobs created by the currently logged in user.
|
|
63467
|
+
*
|
|
63468
|
+
* @param {Object} opts Optional parameters
|
|
63469
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
63470
|
+
* @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)
|
|
63471
|
+
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
63472
|
+
* @param {Object} opts.action The bulk job action.
|
|
63473
|
+
*/
|
|
63474
|
+
getTaskmanagementWorkitemsBulkJobsUsersMe(opts) {
|
|
63475
|
+
opts = opts || {};
|
|
63476
|
+
|
|
63477
|
+
|
|
63478
|
+
return this.apiClient.callApi(
|
|
63479
|
+
'/api/v2/taskmanagement/workitems/bulk/jobs/users/me',
|
|
63480
|
+
'GET',
|
|
63481
|
+
{ },
|
|
63482
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'action': opts['action'] },
|
|
63483
|
+
{ },
|
|
63484
|
+
{ },
|
|
63485
|
+
null,
|
|
63486
|
+
['PureCloud OAuth'],
|
|
63487
|
+
['application/json'],
|
|
63488
|
+
['application/json']
|
|
63489
|
+
);
|
|
63490
|
+
}
|
|
63491
|
+
|
|
63492
|
+
/**
|
|
63493
|
+
* Get the bulk job associated with the job id.
|
|
63494
|
+
*
|
|
63495
|
+
* @param {String} bulkJobId Bulk job id
|
|
63496
|
+
*/
|
|
63497
|
+
getTaskmanagementWorkitemsBulkTerminateJob(bulkJobId) {
|
|
63498
|
+
// verify the required parameter 'bulkJobId' is set
|
|
63499
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
63500
|
+
throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkTerminateJob';
|
|
63501
|
+
}
|
|
63502
|
+
|
|
63503
|
+
return this.apiClient.callApi(
|
|
63504
|
+
'/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}',
|
|
63505
|
+
'GET',
|
|
63506
|
+
{ 'bulkJobId': bulkJobId },
|
|
63507
|
+
{ },
|
|
63508
|
+
{ },
|
|
63509
|
+
{ },
|
|
63510
|
+
null,
|
|
63511
|
+
['PureCloud OAuth'],
|
|
63512
|
+
['application/json'],
|
|
63513
|
+
['application/json']
|
|
63514
|
+
);
|
|
63515
|
+
}
|
|
63516
|
+
|
|
63517
|
+
/**
|
|
63518
|
+
* Get bulk terminate job results.
|
|
63519
|
+
*
|
|
63520
|
+
* @param {String} bulkJobId Bulk job id
|
|
63521
|
+
*/
|
|
63522
|
+
getTaskmanagementWorkitemsBulkTerminateJobResults(bulkJobId) {
|
|
63523
|
+
// verify the required parameter 'bulkJobId' is set
|
|
63524
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
63525
|
+
throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkTerminateJobResults';
|
|
63526
|
+
}
|
|
63527
|
+
|
|
63528
|
+
return this.apiClient.callApi(
|
|
63529
|
+
'/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}/results',
|
|
63530
|
+
'GET',
|
|
63531
|
+
{ 'bulkJobId': bulkJobId },
|
|
63532
|
+
{ },
|
|
63533
|
+
{ },
|
|
63534
|
+
{ },
|
|
63535
|
+
null,
|
|
63536
|
+
['PureCloud OAuth'],
|
|
63537
|
+
['application/json'],
|
|
63538
|
+
['application/json']
|
|
63539
|
+
);
|
|
63540
|
+
}
|
|
63541
|
+
|
|
63061
63542
|
/**
|
|
63062
63543
|
* Get the workitem query job associated with the job id.
|
|
63063
63544
|
*
|
|
@@ -63237,6 +63718,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63237
63718
|
);
|
|
63238
63719
|
}
|
|
63239
63720
|
|
|
63721
|
+
/**
|
|
63722
|
+
* Get a date based rule
|
|
63723
|
+
*
|
|
63724
|
+
* @param {String} worktypeId Worktype id
|
|
63725
|
+
* @param {String} ruleId ruleId
|
|
63726
|
+
*/
|
|
63727
|
+
getTaskmanagementWorktypeFlowsDatebasedRule(worktypeId, ruleId) {
|
|
63728
|
+
// verify the required parameter 'worktypeId' is set
|
|
63729
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
63730
|
+
throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsDatebasedRule';
|
|
63731
|
+
}
|
|
63732
|
+
// verify the required parameter 'ruleId' is set
|
|
63733
|
+
if (ruleId === undefined || ruleId === null) {
|
|
63734
|
+
throw 'Missing the required parameter "ruleId" when calling getTaskmanagementWorktypeFlowsDatebasedRule';
|
|
63735
|
+
}
|
|
63736
|
+
|
|
63737
|
+
return this.apiClient.callApi(
|
|
63738
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId}',
|
|
63739
|
+
'GET',
|
|
63740
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
63741
|
+
{ },
|
|
63742
|
+
{ },
|
|
63743
|
+
{ },
|
|
63744
|
+
null,
|
|
63745
|
+
['PureCloud OAuth'],
|
|
63746
|
+
['application/json'],
|
|
63747
|
+
['application/json']
|
|
63748
|
+
);
|
|
63749
|
+
}
|
|
63750
|
+
|
|
63751
|
+
/**
|
|
63752
|
+
* Get all date based rules for a worktype
|
|
63753
|
+
*
|
|
63754
|
+
* @param {String} worktypeId Worktype id
|
|
63755
|
+
* @param {Object} opts Optional parameters
|
|
63756
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
63757
|
+
* @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)
|
|
63758
|
+
*/
|
|
63759
|
+
getTaskmanagementWorktypeFlowsDatebasedRules(worktypeId, opts) {
|
|
63760
|
+
opts = opts || {};
|
|
63761
|
+
|
|
63762
|
+
// verify the required parameter 'worktypeId' is set
|
|
63763
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
63764
|
+
throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsDatebasedRules';
|
|
63765
|
+
}
|
|
63766
|
+
|
|
63767
|
+
return this.apiClient.callApi(
|
|
63768
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules',
|
|
63769
|
+
'GET',
|
|
63770
|
+
{ 'worktypeId': worktypeId },
|
|
63771
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
63772
|
+
{ },
|
|
63773
|
+
{ },
|
|
63774
|
+
null,
|
|
63775
|
+
['PureCloud OAuth'],
|
|
63776
|
+
['application/json'],
|
|
63777
|
+
['application/json']
|
|
63778
|
+
);
|
|
63779
|
+
}
|
|
63780
|
+
|
|
63240
63781
|
/**
|
|
63241
63782
|
* Get an attribute change rule
|
|
63242
63783
|
*
|
|
@@ -63663,6 +64204,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63663
64204
|
);
|
|
63664
64205
|
}
|
|
63665
64206
|
|
|
64207
|
+
/**
|
|
64208
|
+
* Update workitem bulk add job.
|
|
64209
|
+
*
|
|
64210
|
+
* @param {String} bulkJobId Bulk job id
|
|
64211
|
+
* @param {Object} body Bulk add job update request
|
|
64212
|
+
*/
|
|
64213
|
+
patchTaskmanagementWorkitemsBulkAddJob(bulkJobId, body) {
|
|
64214
|
+
// verify the required parameter 'bulkJobId' is set
|
|
64215
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
64216
|
+
throw 'Missing the required parameter "bulkJobId" when calling patchTaskmanagementWorkitemsBulkAddJob';
|
|
64217
|
+
}
|
|
64218
|
+
// verify the required parameter 'body' is set
|
|
64219
|
+
if (body === undefined || body === null) {
|
|
64220
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorkitemsBulkAddJob';
|
|
64221
|
+
}
|
|
64222
|
+
|
|
64223
|
+
return this.apiClient.callApi(
|
|
64224
|
+
'/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}',
|
|
64225
|
+
'PATCH',
|
|
64226
|
+
{ 'bulkJobId': bulkJobId },
|
|
64227
|
+
{ },
|
|
64228
|
+
{ },
|
|
64229
|
+
{ },
|
|
64230
|
+
body,
|
|
64231
|
+
['PureCloud OAuth'],
|
|
64232
|
+
['application/json'],
|
|
64233
|
+
['application/json']
|
|
64234
|
+
);
|
|
64235
|
+
}
|
|
64236
|
+
|
|
64237
|
+
/**
|
|
64238
|
+
* Update workitem bulk terminate job.
|
|
64239
|
+
*
|
|
64240
|
+
* @param {String} bulkJobId Bulk job id
|
|
64241
|
+
* @param {Object} body Bulk job update request
|
|
64242
|
+
*/
|
|
64243
|
+
patchTaskmanagementWorkitemsBulkTerminateJob(bulkJobId, body) {
|
|
64244
|
+
// verify the required parameter 'bulkJobId' is set
|
|
64245
|
+
if (bulkJobId === undefined || bulkJobId === null) {
|
|
64246
|
+
throw 'Missing the required parameter "bulkJobId" when calling patchTaskmanagementWorkitemsBulkTerminateJob';
|
|
64247
|
+
}
|
|
64248
|
+
// verify the required parameter 'body' is set
|
|
64249
|
+
if (body === undefined || body === null) {
|
|
64250
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorkitemsBulkTerminateJob';
|
|
64251
|
+
}
|
|
64252
|
+
|
|
64253
|
+
return this.apiClient.callApi(
|
|
64254
|
+
'/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}',
|
|
64255
|
+
'PATCH',
|
|
64256
|
+
{ 'bulkJobId': bulkJobId },
|
|
64257
|
+
{ },
|
|
64258
|
+
{ },
|
|
64259
|
+
{ },
|
|
64260
|
+
body,
|
|
64261
|
+
['PureCloud OAuth'],
|
|
64262
|
+
['application/json'],
|
|
64263
|
+
['application/json']
|
|
64264
|
+
);
|
|
64265
|
+
}
|
|
64266
|
+
|
|
63666
64267
|
/**
|
|
63667
64268
|
* Update the attributes of a worktype
|
|
63668
64269
|
*
|
|
@@ -63693,6 +64294,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63693
64294
|
);
|
|
63694
64295
|
}
|
|
63695
64296
|
|
|
64297
|
+
/**
|
|
64298
|
+
* Update the attributes of a date based rule
|
|
64299
|
+
*
|
|
64300
|
+
* @param {String} worktypeId Worktype id
|
|
64301
|
+
* @param {String} ruleId ruleId
|
|
64302
|
+
* @param {Object} body Rule
|
|
64303
|
+
*/
|
|
64304
|
+
patchTaskmanagementWorktypeFlowsDatebasedRule(worktypeId, ruleId, body) {
|
|
64305
|
+
// verify the required parameter 'worktypeId' is set
|
|
64306
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
64307
|
+
throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsDatebasedRule';
|
|
64308
|
+
}
|
|
64309
|
+
// verify the required parameter 'ruleId' is set
|
|
64310
|
+
if (ruleId === undefined || ruleId === null) {
|
|
64311
|
+
throw 'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsDatebasedRule';
|
|
64312
|
+
}
|
|
64313
|
+
// verify the required parameter 'body' is set
|
|
64314
|
+
if (body === undefined || body === null) {
|
|
64315
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktypeFlowsDatebasedRule';
|
|
64316
|
+
}
|
|
64317
|
+
|
|
64318
|
+
return this.apiClient.callApi(
|
|
64319
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId}',
|
|
64320
|
+
'PATCH',
|
|
64321
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
64322
|
+
{ },
|
|
64323
|
+
{ },
|
|
64324
|
+
{ },
|
|
64325
|
+
body,
|
|
64326
|
+
['PureCloud OAuth'],
|
|
64327
|
+
['application/json'],
|
|
64328
|
+
['application/json']
|
|
64329
|
+
);
|
|
64330
|
+
}
|
|
64331
|
+
|
|
63696
64332
|
/**
|
|
63697
64333
|
* Update the attributes of a rule
|
|
63698
64334
|
*
|
|
@@ -63952,6 +64588,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63952
64588
|
);
|
|
63953
64589
|
}
|
|
63954
64590
|
|
|
64591
|
+
/**
|
|
64592
|
+
* Create a workitem bulk add job.
|
|
64593
|
+
*
|
|
64594
|
+
* @param {Object} body Bulk job definition.
|
|
64595
|
+
*/
|
|
64596
|
+
postTaskmanagementWorkitemsBulkAddJobs(body) {
|
|
64597
|
+
// verify the required parameter 'body' is set
|
|
64598
|
+
if (body === undefined || body === null) {
|
|
64599
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsBulkAddJobs';
|
|
64600
|
+
}
|
|
64601
|
+
|
|
64602
|
+
return this.apiClient.callApi(
|
|
64603
|
+
'/api/v2/taskmanagement/workitems/bulk/add/jobs',
|
|
64604
|
+
'POST',
|
|
64605
|
+
{ },
|
|
64606
|
+
{ },
|
|
64607
|
+
{ },
|
|
64608
|
+
{ },
|
|
64609
|
+
body,
|
|
64610
|
+
['PureCloud OAuth'],
|
|
64611
|
+
['application/json'],
|
|
64612
|
+
['application/json']
|
|
64613
|
+
);
|
|
64614
|
+
}
|
|
64615
|
+
|
|
64616
|
+
/**
|
|
64617
|
+
* Create a workitem bulk terminate job.
|
|
64618
|
+
*
|
|
64619
|
+
* @param {Object} body Bulk job definition.
|
|
64620
|
+
*/
|
|
64621
|
+
postTaskmanagementWorkitemsBulkTerminateJobs(body) {
|
|
64622
|
+
// verify the required parameter 'body' is set
|
|
64623
|
+
if (body === undefined || body === null) {
|
|
64624
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsBulkTerminateJobs';
|
|
64625
|
+
}
|
|
64626
|
+
|
|
64627
|
+
return this.apiClient.callApi(
|
|
64628
|
+
'/api/v2/taskmanagement/workitems/bulk/terminate/jobs',
|
|
64629
|
+
'POST',
|
|
64630
|
+
{ },
|
|
64631
|
+
{ },
|
|
64632
|
+
{ },
|
|
64633
|
+
{ },
|
|
64634
|
+
body,
|
|
64635
|
+
['PureCloud OAuth'],
|
|
64636
|
+
['application/json'],
|
|
64637
|
+
['application/json']
|
|
64638
|
+
);
|
|
64639
|
+
}
|
|
64640
|
+
|
|
63955
64641
|
/**
|
|
63956
64642
|
* Query for workitems
|
|
63957
64643
|
* This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
|
|
@@ -64028,6 +64714,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64028
64714
|
);
|
|
64029
64715
|
}
|
|
64030
64716
|
|
|
64717
|
+
/**
|
|
64718
|
+
* Add a date based rule to a worktype
|
|
64719
|
+
*
|
|
64720
|
+
* @param {String} worktypeId Worktype id
|
|
64721
|
+
* @param {Object} body Rule
|
|
64722
|
+
*/
|
|
64723
|
+
postTaskmanagementWorktypeFlowsDatebasedRules(worktypeId, body) {
|
|
64724
|
+
// verify the required parameter 'worktypeId' is set
|
|
64725
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
64726
|
+
throw 'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsDatebasedRules';
|
|
64727
|
+
}
|
|
64728
|
+
// verify the required parameter 'body' is set
|
|
64729
|
+
if (body === undefined || body === null) {
|
|
64730
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypeFlowsDatebasedRules';
|
|
64731
|
+
}
|
|
64732
|
+
|
|
64733
|
+
return this.apiClient.callApi(
|
|
64734
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules',
|
|
64735
|
+
'POST',
|
|
64736
|
+
{ 'worktypeId': worktypeId },
|
|
64737
|
+
{ },
|
|
64738
|
+
{ },
|
|
64739
|
+
{ },
|
|
64740
|
+
body,
|
|
64741
|
+
['PureCloud OAuth'],
|
|
64742
|
+
['application/json'],
|
|
64743
|
+
['application/json']
|
|
64744
|
+
);
|
|
64745
|
+
}
|
|
64746
|
+
|
|
64031
64747
|
/**
|
|
64032
64748
|
* Add an attribute-change rule to a worktype
|
|
64033
64749
|
*
|
|
@@ -64204,7 +64920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64204
64920
|
/**
|
|
64205
64921
|
* Teams service.
|
|
64206
64922
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
64207
|
-
* @version
|
|
64923
|
+
* @version 212.1.0
|
|
64208
64924
|
*/
|
|
64209
64925
|
|
|
64210
64926
|
/**
|
|
@@ -64509,7 +65225,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64509
65225
|
/**
|
|
64510
65226
|
* Telephony service.
|
|
64511
65227
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
64512
|
-
* @version
|
|
65228
|
+
* @version 212.1.0
|
|
64513
65229
|
*/
|
|
64514
65230
|
|
|
64515
65231
|
/**
|
|
@@ -64691,7 +65407,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64691
65407
|
/**
|
|
64692
65408
|
* TelephonyProvidersEdge service.
|
|
64693
65409
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
64694
|
-
* @version
|
|
65410
|
+
* @version 212.1.0
|
|
64695
65411
|
*/
|
|
64696
65412
|
|
|
64697
65413
|
/**
|
|
@@ -68142,7 +68858,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68142
68858
|
/**
|
|
68143
68859
|
* Textbots service.
|
|
68144
68860
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
68145
|
-
* @version
|
|
68861
|
+
* @version 212.1.0
|
|
68146
68862
|
*/
|
|
68147
68863
|
|
|
68148
68864
|
/**
|
|
@@ -68270,7 +68986,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68270
68986
|
/**
|
|
68271
68987
|
* Tokens service.
|
|
68272
68988
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
68273
|
-
* @version
|
|
68989
|
+
* @version 212.1.0
|
|
68274
68990
|
*/
|
|
68275
68991
|
|
|
68276
68992
|
/**
|
|
@@ -68424,7 +69140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68424
69140
|
/**
|
|
68425
69141
|
* Uploads service.
|
|
68426
69142
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
68427
|
-
* @version
|
|
69143
|
+
* @version 212.1.0
|
|
68428
69144
|
*/
|
|
68429
69145
|
|
|
68430
69146
|
/**
|
|
@@ -68693,7 +69409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68693
69409
|
/**
|
|
68694
69410
|
* Usage service.
|
|
68695
69411
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
68696
|
-
* @version
|
|
69412
|
+
* @version 212.1.0
|
|
68697
69413
|
*/
|
|
68698
69414
|
|
|
68699
69415
|
/**
|
|
@@ -68908,7 +69624,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68908
69624
|
/**
|
|
68909
69625
|
* UserRecordings service.
|
|
68910
69626
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
68911
|
-
* @version
|
|
69627
|
+
* @version 212.1.0
|
|
68912
69628
|
*/
|
|
68913
69629
|
|
|
68914
69630
|
/**
|
|
@@ -69123,7 +69839,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69123
69839
|
/**
|
|
69124
69840
|
* Users service.
|
|
69125
69841
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
69126
|
-
* @version
|
|
69842
|
+
* @version 212.1.0
|
|
69127
69843
|
*/
|
|
69128
69844
|
|
|
69129
69845
|
/**
|
|
@@ -71952,7 +72668,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71952
72668
|
/**
|
|
71953
72669
|
* Utilities service.
|
|
71954
72670
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
71955
|
-
* @version
|
|
72671
|
+
* @version 212.1.0
|
|
71956
72672
|
*/
|
|
71957
72673
|
|
|
71958
72674
|
/**
|
|
@@ -72063,7 +72779,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72063
72779
|
/**
|
|
72064
72780
|
* Voicemail service.
|
|
72065
72781
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
72066
|
-
* @version
|
|
72782
|
+
* @version 212.1.0
|
|
72067
72783
|
*/
|
|
72068
72784
|
|
|
72069
72785
|
/**
|
|
@@ -72785,7 +73501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72785
73501
|
/**
|
|
72786
73502
|
* WebChat service.
|
|
72787
73503
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
72788
|
-
* @version
|
|
73504
|
+
* @version 212.1.0
|
|
72789
73505
|
*/
|
|
72790
73506
|
|
|
72791
73507
|
/**
|
|
@@ -73336,7 +74052,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73336
74052
|
/**
|
|
73337
74053
|
* WebDeployments service.
|
|
73338
74054
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
73339
|
-
* @version
|
|
74055
|
+
* @version 212.1.0
|
|
73340
74056
|
*/
|
|
73341
74057
|
|
|
73342
74058
|
/**
|
|
@@ -73863,7 +74579,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73863
74579
|
/**
|
|
73864
74580
|
* WebMessaging service.
|
|
73865
74581
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
73866
|
-
* @version
|
|
74582
|
+
* @version 212.1.0
|
|
73867
74583
|
*/
|
|
73868
74584
|
|
|
73869
74585
|
/**
|
|
@@ -73909,7 +74625,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73909
74625
|
/**
|
|
73910
74626
|
* Widgets service.
|
|
73911
74627
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
73912
|
-
* @version
|
|
74628
|
+
* @version 212.1.0
|
|
73913
74629
|
*/
|
|
73914
74630
|
|
|
73915
74631
|
/**
|
|
@@ -74055,7 +74771,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74055
74771
|
/**
|
|
74056
74772
|
* WorkforceManagement service.
|
|
74057
74773
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
74058
|
-
* @version
|
|
74774
|
+
* @version 212.1.0
|
|
74059
74775
|
*/
|
|
74060
74776
|
|
|
74061
74777
|
/**
|
|
@@ -75296,6 +76012,99 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75296
76012
|
);
|
|
75297
76013
|
}
|
|
75298
76014
|
|
|
76015
|
+
/**
|
|
76016
|
+
* Get the latest session for the business unit ID
|
|
76017
|
+
*
|
|
76018
|
+
* @param {String} businessUnitId
|
|
76019
|
+
* getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76020
|
+
*/
|
|
76021
|
+
getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession(businessUnitId) {
|
|
76022
|
+
// verify the required parameter 'businessUnitId' is set
|
|
76023
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
76024
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession';
|
|
76025
|
+
}
|
|
76026
|
+
|
|
76027
|
+
return this.apiClient.callApi(
|
|
76028
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session',
|
|
76029
|
+
'GET',
|
|
76030
|
+
{ 'businessUnitId': businessUnitId },
|
|
76031
|
+
{ },
|
|
76032
|
+
{ },
|
|
76033
|
+
{ },
|
|
76034
|
+
null,
|
|
76035
|
+
['PureCloud OAuth'],
|
|
76036
|
+
['application/json'],
|
|
76037
|
+
['application/json']
|
|
76038
|
+
);
|
|
76039
|
+
}
|
|
76040
|
+
|
|
76041
|
+
/**
|
|
76042
|
+
* Get the session details for the session ID
|
|
76043
|
+
*
|
|
76044
|
+
* @param {String} businessUnitId
|
|
76045
|
+
* @param {String} sessionId
|
|
76046
|
+
* getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76047
|
+
*/
|
|
76048
|
+
getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId(businessUnitId, sessionId) {
|
|
76049
|
+
// verify the required parameter 'businessUnitId' is set
|
|
76050
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
76051
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId';
|
|
76052
|
+
}
|
|
76053
|
+
// verify the required parameter 'sessionId' is set
|
|
76054
|
+
if (sessionId === undefined || sessionId === null) {
|
|
76055
|
+
throw 'Missing the required parameter "sessionId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId';
|
|
76056
|
+
}
|
|
76057
|
+
|
|
76058
|
+
return this.apiClient.callApi(
|
|
76059
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/{sessionId}',
|
|
76060
|
+
'GET',
|
|
76061
|
+
{ 'businessUnitId': businessUnitId,'sessionId': sessionId },
|
|
76062
|
+
{ },
|
|
76063
|
+
{ },
|
|
76064
|
+
{ },
|
|
76065
|
+
null,
|
|
76066
|
+
['PureCloud OAuth'],
|
|
76067
|
+
['application/json'],
|
|
76068
|
+
['application/json']
|
|
76069
|
+
);
|
|
76070
|
+
}
|
|
76071
|
+
|
|
76072
|
+
/**
|
|
76073
|
+
* Get the snapshot details for the snapshot ID
|
|
76074
|
+
*
|
|
76075
|
+
* @param {String} businessUnitId
|
|
76076
|
+
* @param {String} sessionId
|
|
76077
|
+
* @param {String} snapshotId
|
|
76078
|
+
* getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76079
|
+
*/
|
|
76080
|
+
getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId(businessUnitId, sessionId, snapshotId) {
|
|
76081
|
+
// verify the required parameter 'businessUnitId' is set
|
|
76082
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
76083
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId';
|
|
76084
|
+
}
|
|
76085
|
+
// verify the required parameter 'sessionId' is set
|
|
76086
|
+
if (sessionId === undefined || sessionId === null) {
|
|
76087
|
+
throw 'Missing the required parameter "sessionId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId';
|
|
76088
|
+
}
|
|
76089
|
+
// verify the required parameter 'snapshotId' is set
|
|
76090
|
+
if (snapshotId === undefined || snapshotId === null) {
|
|
76091
|
+
throw 'Missing the required parameter "snapshotId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId';
|
|
76092
|
+
}
|
|
76093
|
+
|
|
76094
|
+
return this.apiClient.callApi(
|
|
76095
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/{sessionId}/snapshot/{snapshotId}',
|
|
76096
|
+
'GET',
|
|
76097
|
+
{ 'businessUnitId': businessUnitId,'sessionId': sessionId,'snapshotId': snapshotId },
|
|
76098
|
+
{ },
|
|
76099
|
+
{ },
|
|
76100
|
+
{ },
|
|
76101
|
+
null,
|
|
76102
|
+
['PureCloud OAuth'],
|
|
76103
|
+
['application/json'],
|
|
76104
|
+
['application/json']
|
|
76105
|
+
);
|
|
76106
|
+
}
|
|
76107
|
+
|
|
75299
76108
|
/**
|
|
75300
76109
|
* Get all authorized management units in the business unit
|
|
75301
76110
|
*
|
|
@@ -81261,7 +82070,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81261
82070
|
* </pre>
|
|
81262
82071
|
* </p>
|
|
81263
82072
|
* @module purecloud-platform-client-v2/index
|
|
81264
|
-
* @version
|
|
82073
|
+
* @version 212.1.0
|
|
81265
82074
|
*/
|
|
81266
82075
|
class platformClient {
|
|
81267
82076
|
constructor() {
|
|
@@ -81680,8 +82489,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81680
82489
|
* @property {module:purecloud-platform-client-v2/MyPureCloudRegionHost}
|
|
81681
82490
|
*/
|
|
81682
82491
|
this.PureCloudRegionHosts = PureCloudRegionHosts;
|
|
81683
|
-
|
|
81684
|
-
|
|
82492
|
+
|
|
82493
|
+
this.AbstractHttpClient = AbstractHttpClient;
|
|
82494
|
+
this.DefaultHttpClient = DefaultHttpClient;
|
|
82495
|
+
this.HttpRequestOptions = HttpRequestOptions;
|
|
81685
82496
|
}
|
|
81686
82497
|
}
|
|
81687
82498
|
|