purecloud-platform-client-v2 125.0.0 → 128.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +810 -171
- package/dist/web-amd/purecloud-platform-client-v2.js +810 -171
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +810 -171
- package/dist/web-cjs/purecloud-platform-client-v2.js +810 -171
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +463 -268
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -26
- 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/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 -74
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +3 -3
- 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/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/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +216 -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/QualityApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -4
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +22 -2
- 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/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +28 -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 +473 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2263,7 +2263,7 @@ class Configuration {
|
|
|
2263
2263
|
|
|
2264
2264
|
/**
|
|
2265
2265
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2266
|
-
* @version
|
|
2266
|
+
* @version 128.0.0
|
|
2267
2267
|
*/
|
|
2268
2268
|
class ApiClient {
|
|
2269
2269
|
/**
|
|
@@ -3203,7 +3203,7 @@ class ApiClient {
|
|
|
3203
3203
|
|
|
3204
3204
|
// set header parameters
|
|
3205
3205
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
3206
|
-
//request.set({ 'purecloud-sdk': '
|
|
3206
|
+
//request.set({ 'purecloud-sdk': '128.0.0' });
|
|
3207
3207
|
|
|
3208
3208
|
// set request timeout
|
|
3209
3209
|
request.timeout(that.timeout);
|
|
@@ -3303,7 +3303,7 @@ class AlertingApi {
|
|
|
3303
3303
|
/**
|
|
3304
3304
|
* Alerting service.
|
|
3305
3305
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3306
|
-
* @version
|
|
3306
|
+
* @version 128.0.0
|
|
3307
3307
|
*/
|
|
3308
3308
|
|
|
3309
3309
|
/**
|
|
@@ -3617,7 +3617,7 @@ class AnalyticsApi {
|
|
|
3617
3617
|
/**
|
|
3618
3618
|
* Analytics service.
|
|
3619
3619
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3620
|
-
* @version
|
|
3620
|
+
* @version 128.0.0
|
|
3621
3621
|
*/
|
|
3622
3622
|
|
|
3623
3623
|
/**
|
|
@@ -4213,31 +4213,6 @@ class AnalyticsApi {
|
|
|
4213
4213
|
);
|
|
4214
4214
|
}
|
|
4215
4215
|
|
|
4216
|
-
/**
|
|
4217
|
-
* Patch AnalyticsReportingSettings values for an organization
|
|
4218
|
-
*
|
|
4219
|
-
* @param {Object} body AnalyticsReportingSettingsRequest
|
|
4220
|
-
*/
|
|
4221
|
-
patchAnalyticsReportingSettings(body) {
|
|
4222
|
-
// verify the required parameter 'body' is set
|
|
4223
|
-
if (body === undefined || body === null) {
|
|
4224
|
-
throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
|
|
4225
|
-
}
|
|
4226
|
-
|
|
4227
|
-
return this.apiClient.callApi(
|
|
4228
|
-
'/api/v2/analytics/reporting/settings',
|
|
4229
|
-
'PATCH',
|
|
4230
|
-
{ },
|
|
4231
|
-
{ },
|
|
4232
|
-
{ },
|
|
4233
|
-
{ },
|
|
4234
|
-
body,
|
|
4235
|
-
['PureCloud OAuth'],
|
|
4236
|
-
['application/json'],
|
|
4237
|
-
['application/json']
|
|
4238
|
-
);
|
|
4239
|
-
}
|
|
4240
|
-
|
|
4241
4216
|
/**
|
|
4242
4217
|
* Query for bot aggregates
|
|
4243
4218
|
*
|
|
@@ -4779,7 +4754,7 @@ class ArchitectApi {
|
|
|
4779
4754
|
/**
|
|
4780
4755
|
* Architect service.
|
|
4781
4756
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4782
|
-
* @version
|
|
4757
|
+
* @version 128.0.0
|
|
4783
4758
|
*/
|
|
4784
4759
|
|
|
4785
4760
|
/**
|
|
@@ -7775,7 +7750,7 @@ class AuditApi {
|
|
|
7775
7750
|
/**
|
|
7776
7751
|
* Audit service.
|
|
7777
7752
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7778
|
-
* @version
|
|
7753
|
+
* @version 128.0.0
|
|
7779
7754
|
*/
|
|
7780
7755
|
|
|
7781
7756
|
/**
|
|
@@ -7946,7 +7921,7 @@ class AuthorizationApi {
|
|
|
7946
7921
|
/**
|
|
7947
7922
|
* Authorization service.
|
|
7948
7923
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7949
|
-
* @version
|
|
7924
|
+
* @version 128.0.0
|
|
7950
7925
|
*/
|
|
7951
7926
|
|
|
7952
7927
|
/**
|
|
@@ -9129,7 +9104,7 @@ class BillingApi {
|
|
|
9129
9104
|
/**
|
|
9130
9105
|
* Billing service.
|
|
9131
9106
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9132
|
-
* @version
|
|
9107
|
+
* @version 128.0.0
|
|
9133
9108
|
*/
|
|
9134
9109
|
|
|
9135
9110
|
/**
|
|
@@ -9209,7 +9184,7 @@ class ChatApi {
|
|
|
9209
9184
|
/**
|
|
9210
9185
|
* Chat service.
|
|
9211
9186
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9212
|
-
* @version
|
|
9187
|
+
* @version 128.0.0
|
|
9213
9188
|
*/
|
|
9214
9189
|
|
|
9215
9190
|
/**
|
|
@@ -9300,7 +9275,7 @@ class CoachingApi {
|
|
|
9300
9275
|
/**
|
|
9301
9276
|
* Coaching service.
|
|
9302
9277
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9303
|
-
* @version
|
|
9278
|
+
* @version 128.0.0
|
|
9304
9279
|
*/
|
|
9305
9280
|
|
|
9306
9281
|
/**
|
|
@@ -9875,7 +9850,7 @@ class ContentManagementApi {
|
|
|
9875
9850
|
/**
|
|
9876
9851
|
* ContentManagement service.
|
|
9877
9852
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9878
|
-
* @version
|
|
9853
|
+
* @version 128.0.0
|
|
9879
9854
|
*/
|
|
9880
9855
|
|
|
9881
9856
|
/**
|
|
@@ -11015,7 +10990,7 @@ class ConversationsApi {
|
|
|
11015
10990
|
/**
|
|
11016
10991
|
* Conversations service.
|
|
11017
10992
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11018
|
-
* @version
|
|
10993
|
+
* @version 128.0.0
|
|
11019
10994
|
*/
|
|
11020
10995
|
|
|
11021
10996
|
/**
|
|
@@ -15404,7 +15379,7 @@ class DataExtensionsApi {
|
|
|
15404
15379
|
/**
|
|
15405
15380
|
* DataExtensions service.
|
|
15406
15381
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15407
|
-
* @version
|
|
15382
|
+
* @version 128.0.0
|
|
15408
15383
|
*/
|
|
15409
15384
|
|
|
15410
15385
|
/**
|
|
@@ -15490,7 +15465,7 @@ class ExternalContactsApi {
|
|
|
15490
15465
|
/**
|
|
15491
15466
|
* ExternalContacts service.
|
|
15492
15467
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15493
|
-
* @version
|
|
15468
|
+
* @version 128.0.0
|
|
15494
15469
|
*/
|
|
15495
15470
|
|
|
15496
15471
|
/**
|
|
@@ -17233,7 +17208,7 @@ class FaxApi {
|
|
|
17233
17208
|
/**
|
|
17234
17209
|
* Fax service.
|
|
17235
17210
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17236
|
-
* @version
|
|
17211
|
+
* @version 128.0.0
|
|
17237
17212
|
*/
|
|
17238
17213
|
|
|
17239
17214
|
/**
|
|
@@ -17404,7 +17379,7 @@ class FlowsApi {
|
|
|
17404
17379
|
/**
|
|
17405
17380
|
* Flows service.
|
|
17406
17381
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
17407
|
-
* @version
|
|
17382
|
+
* @version 128.0.0
|
|
17408
17383
|
*/
|
|
17409
17384
|
|
|
17410
17385
|
/**
|
|
@@ -17475,7 +17450,7 @@ class GamificationApi {
|
|
|
17475
17450
|
/**
|
|
17476
17451
|
* Gamification service.
|
|
17477
17452
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
17478
|
-
* @version
|
|
17453
|
+
* @version 128.0.0
|
|
17479
17454
|
*/
|
|
17480
17455
|
|
|
17481
17456
|
/**
|
|
@@ -18781,7 +18756,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18781
18756
|
/**
|
|
18782
18757
|
* GeneralDataProtectionRegulation service.
|
|
18783
18758
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18784
|
-
* @version
|
|
18759
|
+
* @version 128.0.0
|
|
18785
18760
|
*/
|
|
18786
18761
|
|
|
18787
18762
|
/**
|
|
@@ -18911,7 +18886,7 @@ class GeolocationApi {
|
|
|
18911
18886
|
/**
|
|
18912
18887
|
* Geolocation service.
|
|
18913
18888
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18914
|
-
* @version
|
|
18889
|
+
* @version 128.0.0
|
|
18915
18890
|
*/
|
|
18916
18891
|
|
|
18917
18892
|
/**
|
|
@@ -19042,7 +19017,7 @@ class GreetingsApi {
|
|
|
19042
19017
|
/**
|
|
19043
19018
|
* Greetings service.
|
|
19044
19019
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
19045
|
-
* @version
|
|
19020
|
+
* @version 128.0.0
|
|
19046
19021
|
*/
|
|
19047
19022
|
|
|
19048
19023
|
/**
|
|
@@ -19497,7 +19472,7 @@ class GroupsApi {
|
|
|
19497
19472
|
/**
|
|
19498
19473
|
* Groups service.
|
|
19499
19474
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19500
|
-
* @version
|
|
19475
|
+
* @version 128.0.0
|
|
19501
19476
|
*/
|
|
19502
19477
|
|
|
19503
19478
|
/**
|
|
@@ -19902,7 +19877,7 @@ class IdentityProviderApi {
|
|
|
19902
19877
|
/**
|
|
19903
19878
|
* IdentityProvider service.
|
|
19904
19879
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19905
|
-
* @version
|
|
19880
|
+
* @version 128.0.0
|
|
19906
19881
|
*/
|
|
19907
19882
|
|
|
19908
19883
|
/**
|
|
@@ -20658,7 +20633,7 @@ class IntegrationsApi {
|
|
|
20658
20633
|
/**
|
|
20659
20634
|
* Integrations service.
|
|
20660
20635
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20661
|
-
* @version
|
|
20636
|
+
* @version 128.0.0
|
|
20662
20637
|
*/
|
|
20663
20638
|
|
|
20664
20639
|
/**
|
|
@@ -22304,7 +22279,7 @@ class JourneyApi {
|
|
|
22304
22279
|
/**
|
|
22305
22280
|
* Journey service.
|
|
22306
22281
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22307
|
-
* @version
|
|
22282
|
+
* @version 128.0.0
|
|
22308
22283
|
*/
|
|
22309
22284
|
|
|
22310
22285
|
/**
|
|
@@ -23015,7 +22990,7 @@ class KnowledgeApi {
|
|
|
23015
22990
|
/**
|
|
23016
22991
|
* Knowledge service.
|
|
23017
22992
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23018
|
-
* @version
|
|
22993
|
+
* @version 128.0.0
|
|
23019
22994
|
*/
|
|
23020
22995
|
|
|
23021
22996
|
/**
|
|
@@ -23505,79 +23480,6 @@ class KnowledgeApi {
|
|
|
23505
23480
|
);
|
|
23506
23481
|
}
|
|
23507
23482
|
|
|
23508
|
-
/**
|
|
23509
|
-
* Update specific context data of the knowledge base.
|
|
23510
|
-
*
|
|
23511
|
-
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
23512
|
-
* @param {String} contextId Context ID.
|
|
23513
|
-
* @param {Object} opts Optional parameters
|
|
23514
|
-
* @param {Object} opts.body
|
|
23515
|
-
*/
|
|
23516
|
-
patchKnowledgeKnowledgebaseContext(knowledgeBaseId, contextId, opts) {
|
|
23517
|
-
opts = opts || {};
|
|
23518
|
-
|
|
23519
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
23520
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23521
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseContext';
|
|
23522
|
-
}
|
|
23523
|
-
// verify the required parameter 'contextId' is set
|
|
23524
|
-
if (contextId === undefined || contextId === null) {
|
|
23525
|
-
throw 'Missing the required parameter "contextId" when calling patchKnowledgeKnowledgebaseContext';
|
|
23526
|
-
}
|
|
23527
|
-
|
|
23528
|
-
return this.apiClient.callApi(
|
|
23529
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/contexts/{contextId}',
|
|
23530
|
-
'PATCH',
|
|
23531
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'contextId': contextId },
|
|
23532
|
-
{ },
|
|
23533
|
-
{ },
|
|
23534
|
-
{ },
|
|
23535
|
-
opts['body'],
|
|
23536
|
-
['PureCloud OAuth'],
|
|
23537
|
-
['application/json'],
|
|
23538
|
-
['application/json']
|
|
23539
|
-
);
|
|
23540
|
-
}
|
|
23541
|
-
|
|
23542
|
-
/**
|
|
23543
|
-
* Update context value.
|
|
23544
|
-
*
|
|
23545
|
-
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
23546
|
-
* @param {String} contextId Context ID.
|
|
23547
|
-
* @param {String} contextValueId Context Value ID.
|
|
23548
|
-
* @param {Object} opts Optional parameters
|
|
23549
|
-
* @param {Object} opts.body
|
|
23550
|
-
*/
|
|
23551
|
-
patchKnowledgeKnowledgebaseContextValue(knowledgeBaseId, contextId, contextValueId, opts) {
|
|
23552
|
-
opts = opts || {};
|
|
23553
|
-
|
|
23554
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
23555
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23556
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
23557
|
-
}
|
|
23558
|
-
// verify the required parameter 'contextId' is set
|
|
23559
|
-
if (contextId === undefined || contextId === null) {
|
|
23560
|
-
throw 'Missing the required parameter "contextId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
23561
|
-
}
|
|
23562
|
-
// verify the required parameter 'contextValueId' is set
|
|
23563
|
-
if (contextValueId === undefined || contextValueId === null) {
|
|
23564
|
-
throw 'Missing the required parameter "contextValueId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
23565
|
-
}
|
|
23566
|
-
|
|
23567
|
-
return this.apiClient.callApi(
|
|
23568
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/contexts/{contextId}/values/{contextValueId}',
|
|
23569
|
-
'PATCH',
|
|
23570
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'contextId': contextId,'contextValueId': contextValueId },
|
|
23571
|
-
{ },
|
|
23572
|
-
{ },
|
|
23573
|
-
{ },
|
|
23574
|
-
opts['body'],
|
|
23575
|
-
['PureCloud OAuth'],
|
|
23576
|
-
['application/json'],
|
|
23577
|
-
['application/json']
|
|
23578
|
-
);
|
|
23579
|
-
}
|
|
23580
|
-
|
|
23581
23483
|
/**
|
|
23582
23484
|
* Update category
|
|
23583
23485
|
*
|
|
@@ -23988,7 +23890,7 @@ class LanguageUnderstandingApi {
|
|
|
23988
23890
|
/**
|
|
23989
23891
|
* LanguageUnderstanding service.
|
|
23990
23892
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
23991
|
-
* @version
|
|
23893
|
+
* @version 128.0.0
|
|
23992
23894
|
*/
|
|
23993
23895
|
|
|
23994
23896
|
/**
|
|
@@ -24554,7 +24456,7 @@ class LanguageUnderstandingApi {
|
|
|
24554
24456
|
}
|
|
24555
24457
|
|
|
24556
24458
|
/**
|
|
24557
|
-
* Save information for the draft
|
|
24459
|
+
* Save information for the draft. Either topic draft or intent draft should be sent.
|
|
24558
24460
|
*
|
|
24559
24461
|
* @param {String} minerId Miner ID
|
|
24560
24462
|
* @param {String} draftId Draft ID
|
|
@@ -24798,7 +24700,7 @@ class LanguageUnderstandingApi {
|
|
|
24798
24700
|
}
|
|
24799
24701
|
|
|
24800
24702
|
/**
|
|
24801
|
-
* Start the mining process. Specify date range pair with mediaType
|
|
24703
|
+
* Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.
|
|
24802
24704
|
*
|
|
24803
24705
|
* @param {String} minerId Miner ID
|
|
24804
24706
|
* @param {Object} opts Optional parameters
|
|
@@ -24892,7 +24794,7 @@ class LanguagesApi {
|
|
|
24892
24794
|
/**
|
|
24893
24795
|
* Languages service.
|
|
24894
24796
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
24895
|
-
* @version
|
|
24797
|
+
* @version 128.0.0
|
|
24896
24798
|
*/
|
|
24897
24799
|
|
|
24898
24800
|
/**
|
|
@@ -25160,7 +25062,7 @@ class LearningApi {
|
|
|
25160
25062
|
/**
|
|
25161
25063
|
* Learning service.
|
|
25162
25064
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
25163
|
-
* @version
|
|
25065
|
+
* @version 128.0.0
|
|
25164
25066
|
*/
|
|
25165
25067
|
|
|
25166
25068
|
/**
|
|
@@ -25751,7 +25653,7 @@ class LicenseApi {
|
|
|
25751
25653
|
/**
|
|
25752
25654
|
* License service.
|
|
25753
25655
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
25754
|
-
* @version
|
|
25656
|
+
* @version 128.0.0
|
|
25755
25657
|
*/
|
|
25756
25658
|
|
|
25757
25659
|
/**
|
|
@@ -25989,7 +25891,7 @@ class LocationsApi {
|
|
|
25989
25891
|
/**
|
|
25990
25892
|
* Locations service.
|
|
25991
25893
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
25992
|
-
* @version
|
|
25894
|
+
* @version 128.0.0
|
|
25993
25895
|
*/
|
|
25994
25896
|
|
|
25995
25897
|
/**
|
|
@@ -26225,7 +26127,7 @@ class MobileDevicesApi {
|
|
|
26225
26127
|
/**
|
|
26226
26128
|
* MobileDevices service.
|
|
26227
26129
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
26228
|
-
* @version
|
|
26130
|
+
* @version 128.0.0
|
|
26229
26131
|
*/
|
|
26230
26132
|
|
|
26231
26133
|
/**
|
|
@@ -26376,7 +26278,7 @@ class NotificationsApi {
|
|
|
26376
26278
|
/**
|
|
26377
26279
|
* Notifications service.
|
|
26378
26280
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
26379
|
-
* @version
|
|
26281
|
+
* @version 128.0.0
|
|
26380
26282
|
*/
|
|
26381
26283
|
|
|
26382
26284
|
/**
|
|
@@ -26601,7 +26503,7 @@ class OAuthApi {
|
|
|
26601
26503
|
/**
|
|
26602
26504
|
* OAuth service.
|
|
26603
26505
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
26604
|
-
* @version
|
|
26506
|
+
* @version 128.0.0
|
|
26605
26507
|
*/
|
|
26606
26508
|
|
|
26607
26509
|
/**
|
|
@@ -26959,7 +26861,7 @@ class ObjectsApi {
|
|
|
26959
26861
|
/**
|
|
26960
26862
|
* Objects service.
|
|
26961
26863
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26962
|
-
* @version
|
|
26864
|
+
* @version 128.0.0
|
|
26963
26865
|
*/
|
|
26964
26866
|
|
|
26965
26867
|
/**
|
|
@@ -27230,7 +27132,7 @@ class OrganizationApi {
|
|
|
27230
27132
|
/**
|
|
27231
27133
|
* Organization service.
|
|
27232
27134
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
27233
|
-
* @version
|
|
27135
|
+
* @version 128.0.0
|
|
27234
27136
|
*/
|
|
27235
27137
|
|
|
27236
27138
|
/**
|
|
@@ -27633,7 +27535,7 @@ class OrganizationAuthorizationApi {
|
|
|
27633
27535
|
/**
|
|
27634
27536
|
* OrganizationAuthorization service.
|
|
27635
27537
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
27636
|
-
* @version
|
|
27538
|
+
* @version 128.0.0
|
|
27637
27539
|
*/
|
|
27638
27540
|
|
|
27639
27541
|
/**
|
|
@@ -27673,6 +27575,36 @@ class OrganizationAuthorizationApi {
|
|
|
27673
27575
|
);
|
|
27674
27576
|
}
|
|
27675
27577
|
|
|
27578
|
+
/**
|
|
27579
|
+
* Deletes cloned user
|
|
27580
|
+
*
|
|
27581
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
27582
|
+
* @param {String} trusteeUserId Id of the cloned user to delete
|
|
27583
|
+
*/
|
|
27584
|
+
deleteOrgauthorizationTrusteeCloneduser(trusteeOrgId, trusteeUserId) {
|
|
27585
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
27586
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
27587
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
27588
|
+
}
|
|
27589
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
27590
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
27591
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
27592
|
+
}
|
|
27593
|
+
|
|
27594
|
+
return this.apiClient.callApi(
|
|
27595
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}',
|
|
27596
|
+
'DELETE',
|
|
27597
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeUserId': trusteeUserId },
|
|
27598
|
+
{ },
|
|
27599
|
+
{ },
|
|
27600
|
+
{ },
|
|
27601
|
+
null,
|
|
27602
|
+
['PureCloud OAuth'],
|
|
27603
|
+
['application/json'],
|
|
27604
|
+
['application/json']
|
|
27605
|
+
);
|
|
27606
|
+
}
|
|
27607
|
+
|
|
27676
27608
|
/**
|
|
27677
27609
|
* Delete Trustee User
|
|
27678
27610
|
*
|
|
@@ -27758,6 +27690,36 @@ class OrganizationAuthorizationApi {
|
|
|
27758
27690
|
);
|
|
27759
27691
|
}
|
|
27760
27692
|
|
|
27693
|
+
/**
|
|
27694
|
+
* Delete Cloned User
|
|
27695
|
+
*
|
|
27696
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
27697
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
27698
|
+
*/
|
|
27699
|
+
deleteOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
27700
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
27701
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
27702
|
+
throw 'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
27703
|
+
}
|
|
27704
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
27705
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
27706
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
27707
|
+
}
|
|
27708
|
+
|
|
27709
|
+
return this.apiClient.callApi(
|
|
27710
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
27711
|
+
'DELETE',
|
|
27712
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
27713
|
+
{ },
|
|
27714
|
+
{ },
|
|
27715
|
+
{ },
|
|
27716
|
+
null,
|
|
27717
|
+
['PureCloud OAuth'],
|
|
27718
|
+
['application/json'],
|
|
27719
|
+
['application/json']
|
|
27720
|
+
);
|
|
27721
|
+
}
|
|
27722
|
+
|
|
27761
27723
|
/**
|
|
27762
27724
|
* Delete Trustee User
|
|
27763
27725
|
*
|
|
@@ -27838,6 +27800,31 @@ class OrganizationAuthorizationApi {
|
|
|
27838
27800
|
);
|
|
27839
27801
|
}
|
|
27840
27802
|
|
|
27803
|
+
/**
|
|
27804
|
+
* The list of cloned users from the trustee organization (i.e. users with a native user record).
|
|
27805
|
+
* There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged
|
|
27806
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
27807
|
+
*/
|
|
27808
|
+
getOrgauthorizationTrusteeClonedusers(trusteeOrgId) {
|
|
27809
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
27810
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
27811
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeClonedusers';
|
|
27812
|
+
}
|
|
27813
|
+
|
|
27814
|
+
return this.apiClient.callApi(
|
|
27815
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers',
|
|
27816
|
+
'GET',
|
|
27817
|
+
{ 'trusteeOrgId': trusteeOrgId },
|
|
27818
|
+
{ },
|
|
27819
|
+
{ },
|
|
27820
|
+
{ },
|
|
27821
|
+
null,
|
|
27822
|
+
['PureCloud OAuth'],
|
|
27823
|
+
['application/json'],
|
|
27824
|
+
['application/json']
|
|
27825
|
+
);
|
|
27826
|
+
}
|
|
27827
|
+
|
|
27841
27828
|
/**
|
|
27842
27829
|
* Get Trustee User
|
|
27843
27830
|
*
|
|
@@ -27953,6 +27940,26 @@ class OrganizationAuthorizationApi {
|
|
|
27953
27940
|
);
|
|
27954
27941
|
}
|
|
27955
27942
|
|
|
27943
|
+
/**
|
|
27944
|
+
* Get organization authorization trust with Customer Care, if one exists.
|
|
27945
|
+
*
|
|
27946
|
+
*/
|
|
27947
|
+
getOrgauthorizationTrusteesDefault() {
|
|
27948
|
+
|
|
27949
|
+
return this.apiClient.callApi(
|
|
27950
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
27951
|
+
'GET',
|
|
27952
|
+
{ },
|
|
27953
|
+
{ },
|
|
27954
|
+
{ },
|
|
27955
|
+
{ },
|
|
27956
|
+
null,
|
|
27957
|
+
['PureCloud OAuth'],
|
|
27958
|
+
['application/json'],
|
|
27959
|
+
['application/json']
|
|
27960
|
+
);
|
|
27961
|
+
}
|
|
27962
|
+
|
|
27956
27963
|
/**
|
|
27957
27964
|
* Get Org Trust
|
|
27958
27965
|
*
|
|
@@ -27978,6 +27985,61 @@ class OrganizationAuthorizationApi {
|
|
|
27978
27985
|
);
|
|
27979
27986
|
}
|
|
27980
27987
|
|
|
27988
|
+
/**
|
|
27989
|
+
* Get Cloned User
|
|
27990
|
+
*
|
|
27991
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
27992
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
27993
|
+
*/
|
|
27994
|
+
getOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
27995
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
27996
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
27997
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorCloneduser';
|
|
27998
|
+
}
|
|
27999
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
28000
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
28001
|
+
throw 'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrustorCloneduser';
|
|
28002
|
+
}
|
|
28003
|
+
|
|
28004
|
+
return this.apiClient.callApi(
|
|
28005
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
28006
|
+
'GET',
|
|
28007
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
28008
|
+
{ },
|
|
28009
|
+
{ },
|
|
28010
|
+
{ },
|
|
28011
|
+
null,
|
|
28012
|
+
['PureCloud OAuth'],
|
|
28013
|
+
['application/json'],
|
|
28014
|
+
['application/json']
|
|
28015
|
+
);
|
|
28016
|
+
}
|
|
28017
|
+
|
|
28018
|
+
/**
|
|
28019
|
+
* The list of cloned users in the trustor organization (i.e. users with a native user record).
|
|
28020
|
+
*
|
|
28021
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
28022
|
+
*/
|
|
28023
|
+
getOrgauthorizationTrustorClonedusers(trustorOrgId) {
|
|
28024
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
28025
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
28026
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorClonedusers';
|
|
28027
|
+
}
|
|
28028
|
+
|
|
28029
|
+
return this.apiClient.callApi(
|
|
28030
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers',
|
|
28031
|
+
'GET',
|
|
28032
|
+
{ 'trustorOrgId': trustorOrgId },
|
|
28033
|
+
{ },
|
|
28034
|
+
{ },
|
|
28035
|
+
{ },
|
|
28036
|
+
null,
|
|
28037
|
+
['PureCloud OAuth'],
|
|
28038
|
+
['application/json'],
|
|
28039
|
+
['application/json']
|
|
28040
|
+
);
|
|
28041
|
+
}
|
|
28042
|
+
|
|
27981
28043
|
/**
|
|
27982
28044
|
* Get Trustee User
|
|
27983
28045
|
*
|
|
@@ -28175,6 +28237,31 @@ class OrganizationAuthorizationApi {
|
|
|
28175
28237
|
);
|
|
28176
28238
|
}
|
|
28177
28239
|
|
|
28240
|
+
/**
|
|
28241
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
28242
|
+
*
|
|
28243
|
+
* @param {Object} opts Optional parameters
|
|
28244
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
28245
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
28246
|
+
*/
|
|
28247
|
+
postOrgauthorizationTrusteesDefault(opts) {
|
|
28248
|
+
opts = opts || {};
|
|
28249
|
+
|
|
28250
|
+
|
|
28251
|
+
return this.apiClient.callApi(
|
|
28252
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
28253
|
+
'POST',
|
|
28254
|
+
{ },
|
|
28255
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'] },
|
|
28256
|
+
{ },
|
|
28257
|
+
{ },
|
|
28258
|
+
null,
|
|
28259
|
+
['PureCloud OAuth'],
|
|
28260
|
+
['application/json'],
|
|
28261
|
+
['application/json']
|
|
28262
|
+
);
|
|
28263
|
+
}
|
|
28264
|
+
|
|
28178
28265
|
/**
|
|
28179
28266
|
* Get Org Trustor Audits
|
|
28180
28267
|
*
|
|
@@ -28307,6 +28394,36 @@ class OrganizationAuthorizationApi {
|
|
|
28307
28394
|
);
|
|
28308
28395
|
}
|
|
28309
28396
|
|
|
28397
|
+
/**
|
|
28398
|
+
* Creates a clone of the trustee user in the trustor org.
|
|
28399
|
+
*
|
|
28400
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
28401
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
28402
|
+
*/
|
|
28403
|
+
putOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
28404
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
28405
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
28406
|
+
throw 'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorCloneduser';
|
|
28407
|
+
}
|
|
28408
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
28409
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
28410
|
+
throw 'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorCloneduser';
|
|
28411
|
+
}
|
|
28412
|
+
|
|
28413
|
+
return this.apiClient.callApi(
|
|
28414
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
28415
|
+
'PUT',
|
|
28416
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
28417
|
+
{ },
|
|
28418
|
+
{ },
|
|
28419
|
+
{ },
|
|
28420
|
+
null,
|
|
28421
|
+
['PureCloud OAuth'],
|
|
28422
|
+
['application/json'],
|
|
28423
|
+
['application/json']
|
|
28424
|
+
);
|
|
28425
|
+
}
|
|
28426
|
+
|
|
28310
28427
|
/**
|
|
28311
28428
|
* Add a Trustee user to the trust.
|
|
28312
28429
|
*
|
|
@@ -28343,7 +28460,7 @@ class OutboundApi {
|
|
|
28343
28460
|
/**
|
|
28344
28461
|
* Outbound service.
|
|
28345
28462
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
28346
|
-
* @version
|
|
28463
|
+
* @version 128.0.0
|
|
28347
28464
|
*/
|
|
28348
28465
|
|
|
28349
28466
|
/**
|
|
@@ -31369,7 +31486,7 @@ class PresenceApi {
|
|
|
31369
31486
|
/**
|
|
31370
31487
|
* Presence service.
|
|
31371
31488
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
31372
|
-
* @version
|
|
31489
|
+
* @version 128.0.0
|
|
31373
31490
|
*/
|
|
31374
31491
|
|
|
31375
31492
|
/**
|
|
@@ -31741,7 +31858,7 @@ class QualityApi {
|
|
|
31741
31858
|
/**
|
|
31742
31859
|
* Quality service.
|
|
31743
31860
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
31744
|
-
* @version
|
|
31861
|
+
* @version 128.0.0
|
|
31745
31862
|
*/
|
|
31746
31863
|
|
|
31747
31864
|
/**
|
|
@@ -32114,7 +32231,7 @@ class QualityApi {
|
|
|
32114
32231
|
|
|
32115
32232
|
/**
|
|
32116
32233
|
* Queries Evaluations and returns a paged list
|
|
32117
|
-
* Query params must include one of conversationId, evaluatorUserId, or agentUserId
|
|
32234
|
+
* Query params must include one of conversationId, evaluatorUserId, or agentUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date.
|
|
32118
32235
|
* @param {Object} opts Optional parameters
|
|
32119
32236
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
32120
32237
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -33269,7 +33386,7 @@ class RecordingApi {
|
|
|
33269
33386
|
/**
|
|
33270
33387
|
* Recording service.
|
|
33271
33388
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
33272
|
-
* @version
|
|
33389
|
+
* @version 128.0.0
|
|
33273
33390
|
*/
|
|
33274
33391
|
|
|
33275
33392
|
/**
|
|
@@ -33865,6 +33982,8 @@ class RecordingApi {
|
|
|
33865
33982
|
* @param {Object} opts Optional parameters
|
|
33866
33983
|
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
33867
33984
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
33985
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
33986
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
33868
33987
|
*/
|
|
33869
33988
|
getRecordingJobFailedrecordings(jobId, opts) {
|
|
33870
33989
|
opts = opts || {};
|
|
@@ -33878,7 +33997,7 @@ class RecordingApi {
|
|
|
33878
33997
|
'/api/v2/recording/jobs/{jobId}/failedrecordings',
|
|
33879
33998
|
'GET',
|
|
33880
33999
|
{ 'jobId': jobId },
|
|
33881
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
34000
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
33882
34001
|
{ },
|
|
33883
34002
|
{ },
|
|
33884
34003
|
null,
|
|
@@ -33898,6 +34017,8 @@ class RecordingApi {
|
|
|
33898
34017
|
* @param {Object} opts.state Filter by state
|
|
33899
34018
|
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
33900
34019
|
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
34020
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
34021
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
33901
34022
|
*/
|
|
33902
34023
|
getRecordingJobs(opts) {
|
|
33903
34024
|
opts = opts || {};
|
|
@@ -33907,7 +34028,7 @@ class RecordingApi {
|
|
|
33907
34028
|
'/api/v2/recording/jobs',
|
|
33908
34029
|
'GET',
|
|
33909
34030
|
{ },
|
|
33910
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'] },
|
|
34031
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
33911
34032
|
{ },
|
|
33912
34033
|
{ },
|
|
33913
34034
|
null,
|
|
@@ -34788,7 +34909,7 @@ class ResponseManagementApi {
|
|
|
34788
34909
|
/**
|
|
34789
34910
|
* ResponseManagement service.
|
|
34790
34911
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
34791
|
-
* @version
|
|
34912
|
+
* @version 128.0.0
|
|
34792
34913
|
*/
|
|
34793
34914
|
|
|
34794
34915
|
/**
|
|
@@ -35113,7 +35234,7 @@ class RoutingApi {
|
|
|
35113
35234
|
/**
|
|
35114
35235
|
* Routing service.
|
|
35115
35236
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
35116
|
-
* @version
|
|
35237
|
+
* @version 128.0.0
|
|
35117
35238
|
*/
|
|
35118
35239
|
|
|
35119
35240
|
/**
|
|
@@ -36269,12 +36390,11 @@ class RoutingApi {
|
|
|
36269
36390
|
}
|
|
36270
36391
|
|
|
36271
36392
|
/**
|
|
36272
|
-
* Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
|
|
36393
|
+
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
36273
36394
|
*
|
|
36274
36395
|
* @param {Object} opts Optional parameters
|
|
36275
36396
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
36276
36397
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
36277
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
36278
36398
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
36279
36399
|
*/
|
|
36280
36400
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -36285,7 +36405,7 @@ class RoutingApi {
|
|
|
36285
36405
|
'/api/v2/routing/queues/divisionviews/all',
|
|
36286
36406
|
'GET',
|
|
36287
36407
|
{ },
|
|
36288
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
36408
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
36289
36409
|
{ },
|
|
36290
36410
|
{ },
|
|
36291
36411
|
null,
|
|
@@ -38033,7 +38153,7 @@ class SCIMApi {
|
|
|
38033
38153
|
/**
|
|
38034
38154
|
* SCIM service.
|
|
38035
38155
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
38036
|
-
* @version
|
|
38156
|
+
* @version 128.0.0
|
|
38037
38157
|
*/
|
|
38038
38158
|
|
|
38039
38159
|
/**
|
|
@@ -38910,7 +39030,7 @@ class ScriptsApi {
|
|
|
38910
39030
|
/**
|
|
38911
39031
|
* Scripts service.
|
|
38912
39032
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38913
|
-
* @version
|
|
39033
|
+
* @version 128.0.0
|
|
38914
39034
|
*/
|
|
38915
39035
|
|
|
38916
39036
|
/**
|
|
@@ -39263,7 +39383,7 @@ class SearchApi {
|
|
|
39263
39383
|
/**
|
|
39264
39384
|
* Search service.
|
|
39265
39385
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
39266
|
-
* @version
|
|
39386
|
+
* @version 128.0.0
|
|
39267
39387
|
*/
|
|
39268
39388
|
|
|
39269
39389
|
/**
|
|
@@ -39798,7 +39918,7 @@ class SpeechTextAnalyticsApi {
|
|
|
39798
39918
|
/**
|
|
39799
39919
|
* SpeechTextAnalytics service.
|
|
39800
39920
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
39801
|
-
* @version
|
|
39921
|
+
* @version 128.0.0
|
|
39802
39922
|
*/
|
|
39803
39923
|
|
|
39804
39924
|
/**
|
|
@@ -39969,7 +40089,7 @@ class SpeechTextAnalyticsApi {
|
|
|
39969
40089
|
|
|
39970
40090
|
/**
|
|
39971
40091
|
* Get list of supported Speech & Text Analytics dialects
|
|
39972
|
-
*
|
|
40092
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
39973
40093
|
*/
|
|
39974
40094
|
getSpeechandtextanalyticsDialects() {
|
|
39975
40095
|
|
|
@@ -40162,6 +40282,26 @@ class SpeechTextAnalyticsApi {
|
|
|
40162
40282
|
);
|
|
40163
40283
|
}
|
|
40164
40284
|
|
|
40285
|
+
/**
|
|
40286
|
+
* Get the list of Speech & Text Analytics sentiment supported dialects
|
|
40287
|
+
*
|
|
40288
|
+
*/
|
|
40289
|
+
getSpeechandtextanalyticsSentimentDialects() {
|
|
40290
|
+
|
|
40291
|
+
return this.apiClient.callApi(
|
|
40292
|
+
'/api/v2/speechandtextanalytics/sentiment/dialects',
|
|
40293
|
+
'GET',
|
|
40294
|
+
{ },
|
|
40295
|
+
{ },
|
|
40296
|
+
{ },
|
|
40297
|
+
{ },
|
|
40298
|
+
null,
|
|
40299
|
+
['PureCloud OAuth'],
|
|
40300
|
+
['application/json'],
|
|
40301
|
+
['application/json']
|
|
40302
|
+
);
|
|
40303
|
+
}
|
|
40304
|
+
|
|
40165
40305
|
/**
|
|
40166
40306
|
* Get the list of Speech & Text Analytics SentimentFeedback
|
|
40167
40307
|
*
|
|
@@ -40651,7 +40791,7 @@ class StationsApi {
|
|
|
40651
40791
|
/**
|
|
40652
40792
|
* Stations service.
|
|
40653
40793
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
40654
|
-
* @version
|
|
40794
|
+
* @version 128.0.0
|
|
40655
40795
|
*/
|
|
40656
40796
|
|
|
40657
40797
|
/**
|
|
@@ -40798,7 +40938,7 @@ class SuggestApi {
|
|
|
40798
40938
|
/**
|
|
40799
40939
|
* Suggest service.
|
|
40800
40940
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
40801
|
-
* @version
|
|
40941
|
+
* @version 128.0.0
|
|
40802
40942
|
*/
|
|
40803
40943
|
|
|
40804
40944
|
/**
|
|
@@ -40937,7 +41077,7 @@ class TelephonyApi {
|
|
|
40937
41077
|
/**
|
|
40938
41078
|
* Telephony service.
|
|
40939
41079
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40940
|
-
* @version
|
|
41080
|
+
* @version 128.0.0
|
|
40941
41081
|
*/
|
|
40942
41082
|
|
|
40943
41083
|
/**
|
|
@@ -41045,7 +41185,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
41045
41185
|
/**
|
|
41046
41186
|
* TelephonyProvidersEdge service.
|
|
41047
41187
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
41048
|
-
* @version
|
|
41188
|
+
* @version 128.0.0
|
|
41049
41189
|
*/
|
|
41050
41190
|
|
|
41051
41191
|
/**
|
|
@@ -44658,7 +44798,7 @@ class TextbotsApi {
|
|
|
44658
44798
|
/**
|
|
44659
44799
|
* Textbots service.
|
|
44660
44800
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
44661
|
-
* @version
|
|
44801
|
+
* @version 128.0.0
|
|
44662
44802
|
*/
|
|
44663
44803
|
|
|
44664
44804
|
/**
|
|
@@ -44673,6 +44813,33 @@ class TextbotsApi {
|
|
|
44673
44813
|
}
|
|
44674
44814
|
|
|
44675
44815
|
|
|
44816
|
+
/**
|
|
44817
|
+
* Find bots using the currently configured friendly name or ID.
|
|
44818
|
+
* The name does allow case-insensitive partial string matches or by IDs (up to 50), but not both at the same time. Optionally you can limit the scope of the search by providing one or more bot types. You can specify the maximum results to return, up to a limit of 100
|
|
44819
|
+
* @param {Object} opts Optional parameters
|
|
44820
|
+
* @param {Array.<String>} opts.botType Bot types
|
|
44821
|
+
* @param {String} opts.botName Bot name
|
|
44822
|
+
* @param {Array.<String>} opts.botId Bot IDs
|
|
44823
|
+
* @param {Number} opts.pageSize The maximum results to return (default to 25)
|
|
44824
|
+
*/
|
|
44825
|
+
getTextbotsBotsSearch(opts) {
|
|
44826
|
+
opts = opts || {};
|
|
44827
|
+
|
|
44828
|
+
|
|
44829
|
+
return this.apiClient.callApi(
|
|
44830
|
+
'/api/v2/textbots/bots/search',
|
|
44831
|
+
'GET',
|
|
44832
|
+
{ },
|
|
44833
|
+
{ 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'pageSize': opts['pageSize'] },
|
|
44834
|
+
{ },
|
|
44835
|
+
{ },
|
|
44836
|
+
null,
|
|
44837
|
+
['PureCloud OAuth'],
|
|
44838
|
+
['application/json'],
|
|
44839
|
+
['application/json']
|
|
44840
|
+
);
|
|
44841
|
+
}
|
|
44842
|
+
|
|
44676
44843
|
/**
|
|
44677
44844
|
* Issue a bot flow turn event
|
|
44678
44845
|
* Send a turn event to an executing bot flow and produce the next action to take.
|
|
@@ -44759,7 +44926,7 @@ class TokensApi {
|
|
|
44759
44926
|
/**
|
|
44760
44927
|
* Tokens service.
|
|
44761
44928
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
44762
|
-
* @version
|
|
44929
|
+
* @version 128.0.0
|
|
44763
44930
|
*/
|
|
44764
44931
|
|
|
44765
44932
|
/**
|
|
@@ -44865,7 +45032,7 @@ class UploadsApi {
|
|
|
44865
45032
|
/**
|
|
44866
45033
|
* Uploads service.
|
|
44867
45034
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44868
|
-
* @version
|
|
45035
|
+
* @version 128.0.0
|
|
44869
45036
|
*/
|
|
44870
45037
|
|
|
44871
45038
|
/**
|
|
@@ -45041,7 +45208,7 @@ class UsageApi {
|
|
|
45041
45208
|
/**
|
|
45042
45209
|
* Usage service.
|
|
45043
45210
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
45044
|
-
* @version
|
|
45211
|
+
* @version 128.0.0
|
|
45045
45212
|
*/
|
|
45046
45213
|
|
|
45047
45214
|
/**
|
|
@@ -45112,7 +45279,7 @@ class UserRecordingsApi {
|
|
|
45112
45279
|
/**
|
|
45113
45280
|
* UserRecordings service.
|
|
45114
45281
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
45115
|
-
* @version
|
|
45282
|
+
* @version 128.0.0
|
|
45116
45283
|
*/
|
|
45117
45284
|
|
|
45118
45285
|
/**
|
|
@@ -45296,7 +45463,7 @@ class UsersApi {
|
|
|
45296
45463
|
/**
|
|
45297
45464
|
* Users service.
|
|
45298
45465
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
45299
|
-
* @version
|
|
45466
|
+
* @version 128.0.0
|
|
45300
45467
|
*/
|
|
45301
45468
|
|
|
45302
45469
|
/**
|
|
@@ -47598,7 +47765,7 @@ class UtilitiesApi {
|
|
|
47598
47765
|
/**
|
|
47599
47766
|
* Utilities service.
|
|
47600
47767
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
47601
|
-
* @version
|
|
47768
|
+
* @version 128.0.0
|
|
47602
47769
|
*/
|
|
47603
47770
|
|
|
47604
47771
|
/**
|
|
@@ -47709,7 +47876,7 @@ class VoicemailApi {
|
|
|
47709
47876
|
/**
|
|
47710
47877
|
* Voicemail service.
|
|
47711
47878
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
47712
|
-
* @version
|
|
47879
|
+
* @version 128.0.0
|
|
47713
47880
|
*/
|
|
47714
47881
|
|
|
47715
47882
|
/**
|
|
@@ -48376,7 +48543,7 @@ class WebChatApi {
|
|
|
48376
48543
|
/**
|
|
48377
48544
|
* WebChat service.
|
|
48378
48545
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
48379
|
-
* @version
|
|
48546
|
+
* @version 128.0.0
|
|
48380
48547
|
*/
|
|
48381
48548
|
|
|
48382
48549
|
/**
|
|
@@ -48920,7 +49087,7 @@ class WebDeploymentsApi {
|
|
|
48920
49087
|
/**
|
|
48921
49088
|
* WebDeployments service.
|
|
48922
49089
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48923
|
-
* @version
|
|
49090
|
+
* @version 128.0.0
|
|
48924
49091
|
*/
|
|
48925
49092
|
|
|
48926
49093
|
/**
|
|
@@ -49275,7 +49442,7 @@ class WebMessagingApi {
|
|
|
49275
49442
|
/**
|
|
49276
49443
|
* WebMessaging service.
|
|
49277
49444
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
49278
|
-
* @version
|
|
49445
|
+
* @version 128.0.0
|
|
49279
49446
|
*/
|
|
49280
49447
|
|
|
49281
49448
|
/**
|
|
@@ -49321,7 +49488,7 @@ class WidgetsApi {
|
|
|
49321
49488
|
/**
|
|
49322
49489
|
* Widgets service.
|
|
49323
49490
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
49324
|
-
* @version
|
|
49491
|
+
* @version 128.0.0
|
|
49325
49492
|
*/
|
|
49326
49493
|
|
|
49327
49494
|
/**
|
|
@@ -49467,7 +49634,7 @@ class WorkforceManagementApi {
|
|
|
49467
49634
|
/**
|
|
49468
49635
|
* WorkforceManagement service.
|
|
49469
49636
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
49470
|
-
* @version
|
|
49637
|
+
* @version 128.0.0
|
|
49471
49638
|
*/
|
|
49472
49639
|
|
|
49473
49640
|
/**
|
|
@@ -49742,6 +49909,66 @@ class WorkforceManagementApi {
|
|
|
49742
49909
|
);
|
|
49743
49910
|
}
|
|
49744
49911
|
|
|
49912
|
+
/**
|
|
49913
|
+
* Deletes a time off limit object
|
|
49914
|
+
*
|
|
49915
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49916
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
49917
|
+
*/
|
|
49918
|
+
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
49919
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49920
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49921
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
49922
|
+
}
|
|
49923
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
49924
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
49925
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
49926
|
+
}
|
|
49927
|
+
|
|
49928
|
+
return this.apiClient.callApi(
|
|
49929
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
49930
|
+
'DELETE',
|
|
49931
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
49932
|
+
{ },
|
|
49933
|
+
{ },
|
|
49934
|
+
{ },
|
|
49935
|
+
null,
|
|
49936
|
+
['PureCloud OAuth'],
|
|
49937
|
+
['application/json'],
|
|
49938
|
+
['application/json']
|
|
49939
|
+
);
|
|
49940
|
+
}
|
|
49941
|
+
|
|
49942
|
+
/**
|
|
49943
|
+
* Deletes a time off plan
|
|
49944
|
+
*
|
|
49945
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49946
|
+
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
49947
|
+
*/
|
|
49948
|
+
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
49949
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49950
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49951
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
49952
|
+
}
|
|
49953
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
49954
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
49955
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
49956
|
+
}
|
|
49957
|
+
|
|
49958
|
+
return this.apiClient.callApi(
|
|
49959
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
49960
|
+
'DELETE',
|
|
49961
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
49962
|
+
{ },
|
|
49963
|
+
{ },
|
|
49964
|
+
{ },
|
|
49965
|
+
null,
|
|
49966
|
+
['PureCloud OAuth'],
|
|
49967
|
+
['application/json'],
|
|
49968
|
+
['application/json']
|
|
49969
|
+
);
|
|
49970
|
+
}
|
|
49971
|
+
|
|
49745
49972
|
/**
|
|
49746
49973
|
* Delete a work plan
|
|
49747
49974
|
*
|
|
@@ -50983,6 +51210,116 @@ class WorkforceManagementApi {
|
|
|
50983
51210
|
);
|
|
50984
51211
|
}
|
|
50985
51212
|
|
|
51213
|
+
/**
|
|
51214
|
+
* Gets a time off limit object
|
|
51215
|
+
* Returns properties of time off limit object, but not daily values.
|
|
51216
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51217
|
+
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
51218
|
+
*/
|
|
51219
|
+
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
51220
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51221
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51222
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
51223
|
+
}
|
|
51224
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
51225
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
51226
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
51227
|
+
}
|
|
51228
|
+
|
|
51229
|
+
return this.apiClient.callApi(
|
|
51230
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
51231
|
+
'GET',
|
|
51232
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
51233
|
+
{ },
|
|
51234
|
+
{ },
|
|
51235
|
+
{ },
|
|
51236
|
+
null,
|
|
51237
|
+
['PureCloud OAuth'],
|
|
51238
|
+
['application/json'],
|
|
51239
|
+
['application/json']
|
|
51240
|
+
);
|
|
51241
|
+
}
|
|
51242
|
+
|
|
51243
|
+
/**
|
|
51244
|
+
* Gets a list of time off limit objects under management unit.
|
|
51245
|
+
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
51246
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51247
|
+
*/
|
|
51248
|
+
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
51249
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51250
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51251
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';
|
|
51252
|
+
}
|
|
51253
|
+
|
|
51254
|
+
return this.apiClient.callApi(
|
|
51255
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
51256
|
+
'GET',
|
|
51257
|
+
{ 'managementUnitId': managementUnitId },
|
|
51258
|
+
{ },
|
|
51259
|
+
{ },
|
|
51260
|
+
{ },
|
|
51261
|
+
null,
|
|
51262
|
+
['PureCloud OAuth'],
|
|
51263
|
+
['application/json'],
|
|
51264
|
+
['application/json']
|
|
51265
|
+
);
|
|
51266
|
+
}
|
|
51267
|
+
|
|
51268
|
+
/**
|
|
51269
|
+
* Gets a time off plan
|
|
51270
|
+
*
|
|
51271
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51272
|
+
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
51273
|
+
*/
|
|
51274
|
+
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
51275
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51276
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51277
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
51278
|
+
}
|
|
51279
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
51280
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
51281
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
51282
|
+
}
|
|
51283
|
+
|
|
51284
|
+
return this.apiClient.callApi(
|
|
51285
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
51286
|
+
'GET',
|
|
51287
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
51288
|
+
{ },
|
|
51289
|
+
{ },
|
|
51290
|
+
{ },
|
|
51291
|
+
null,
|
|
51292
|
+
['PureCloud OAuth'],
|
|
51293
|
+
['application/json'],
|
|
51294
|
+
['application/json']
|
|
51295
|
+
);
|
|
51296
|
+
}
|
|
51297
|
+
|
|
51298
|
+
/**
|
|
51299
|
+
* Gets a list of time off plans
|
|
51300
|
+
*
|
|
51301
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51302
|
+
*/
|
|
51303
|
+
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
51304
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51305
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51306
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';
|
|
51307
|
+
}
|
|
51308
|
+
|
|
51309
|
+
return this.apiClient.callApi(
|
|
51310
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
51311
|
+
'GET',
|
|
51312
|
+
{ 'managementUnitId': managementUnitId },
|
|
51313
|
+
{ },
|
|
51314
|
+
{ },
|
|
51315
|
+
{ },
|
|
51316
|
+
null,
|
|
51317
|
+
['PureCloud OAuth'],
|
|
51318
|
+
['application/json'],
|
|
51319
|
+
['application/json']
|
|
51320
|
+
);
|
|
51321
|
+
}
|
|
51322
|
+
|
|
50986
51323
|
/**
|
|
50987
51324
|
* Get a time off request
|
|
50988
51325
|
*
|
|
@@ -51018,6 +51355,41 @@ class WorkforceManagementApi {
|
|
|
51018
51355
|
);
|
|
51019
51356
|
}
|
|
51020
51357
|
|
|
51358
|
+
/**
|
|
51359
|
+
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
51360
|
+
*
|
|
51361
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51362
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
51363
|
+
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
51364
|
+
*/
|
|
51365
|
+
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId) {
|
|
51366
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51367
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51368
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
51369
|
+
}
|
|
51370
|
+
// verify the required parameter 'userId' is set
|
|
51371
|
+
if (userId === undefined || userId === null) {
|
|
51372
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
51373
|
+
}
|
|
51374
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
51375
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
51376
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
51377
|
+
}
|
|
51378
|
+
|
|
51379
|
+
return this.apiClient.callApi(
|
|
51380
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits',
|
|
51381
|
+
'GET',
|
|
51382
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
51383
|
+
{ },
|
|
51384
|
+
{ },
|
|
51385
|
+
{ },
|
|
51386
|
+
null,
|
|
51387
|
+
['PureCloud OAuth'],
|
|
51388
|
+
['application/json'],
|
|
51389
|
+
['application/json']
|
|
51390
|
+
);
|
|
51391
|
+
}
|
|
51392
|
+
|
|
51021
51393
|
/**
|
|
51022
51394
|
* Get a list of time off requests for a given user
|
|
51023
51395
|
*
|
|
@@ -51451,6 +51823,31 @@ class WorkforceManagementApi {
|
|
|
51451
51823
|
);
|
|
51452
51824
|
}
|
|
51453
51825
|
|
|
51826
|
+
/**
|
|
51827
|
+
* Get the daily waitlist positions of a time off request for the current user
|
|
51828
|
+
*
|
|
51829
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
51830
|
+
*/
|
|
51831
|
+
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
51832
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
51833
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
51834
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';
|
|
51835
|
+
}
|
|
51836
|
+
|
|
51837
|
+
return this.apiClient.callApi(
|
|
51838
|
+
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions',
|
|
51839
|
+
'GET',
|
|
51840
|
+
{ 'timeOffRequestId': timeOffRequestId },
|
|
51841
|
+
{ },
|
|
51842
|
+
{ },
|
|
51843
|
+
{ },
|
|
51844
|
+
null,
|
|
51845
|
+
['PureCloud OAuth'],
|
|
51846
|
+
['application/json'],
|
|
51847
|
+
['application/json']
|
|
51848
|
+
);
|
|
51849
|
+
}
|
|
51850
|
+
|
|
51454
51851
|
/**
|
|
51455
51852
|
* Get a list of time off requests for the current user
|
|
51456
51853
|
*
|
|
@@ -51669,6 +52066,74 @@ class WorkforceManagementApi {
|
|
|
51669
52066
|
);
|
|
51670
52067
|
}
|
|
51671
52068
|
|
|
52069
|
+
/**
|
|
52070
|
+
* Updates a time off limit object.
|
|
52071
|
+
* Updates time off limit object properties, but not daily values.
|
|
52072
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
52073
|
+
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
52074
|
+
* @param {Object} opts Optional parameters
|
|
52075
|
+
* @param {Object} opts.body body
|
|
52076
|
+
*/
|
|
52077
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, opts) {
|
|
52078
|
+
opts = opts || {};
|
|
52079
|
+
|
|
52080
|
+
// verify the required parameter 'managementUnitId' is set
|
|
52081
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
52082
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
52083
|
+
}
|
|
52084
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
52085
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
52086
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
52087
|
+
}
|
|
52088
|
+
|
|
52089
|
+
return this.apiClient.callApi(
|
|
52090
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
52091
|
+
'PATCH',
|
|
52092
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
52093
|
+
{ },
|
|
52094
|
+
{ },
|
|
52095
|
+
{ },
|
|
52096
|
+
opts['body'],
|
|
52097
|
+
['PureCloud OAuth'],
|
|
52098
|
+
['application/json'],
|
|
52099
|
+
['application/json']
|
|
52100
|
+
);
|
|
52101
|
+
}
|
|
52102
|
+
|
|
52103
|
+
/**
|
|
52104
|
+
* Updates a time off plan
|
|
52105
|
+
*
|
|
52106
|
+
* @param {String} managementUnitId The management unit ID.
|
|
52107
|
+
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
52108
|
+
* @param {Object} opts Optional parameters
|
|
52109
|
+
* @param {Object} opts.body body
|
|
52110
|
+
*/
|
|
52111
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, opts) {
|
|
52112
|
+
opts = opts || {};
|
|
52113
|
+
|
|
52114
|
+
// verify the required parameter 'managementUnitId' is set
|
|
52115
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
52116
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
52117
|
+
}
|
|
52118
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
52119
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
52120
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
52121
|
+
}
|
|
52122
|
+
|
|
52123
|
+
return this.apiClient.callApi(
|
|
52124
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
52125
|
+
'PATCH',
|
|
52126
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
52127
|
+
{ },
|
|
52128
|
+
{ },
|
|
52129
|
+
{ },
|
|
52130
|
+
opts['body'],
|
|
52131
|
+
['PureCloud OAuth'],
|
|
52132
|
+
['application/json'],
|
|
52133
|
+
['application/json']
|
|
52134
|
+
);
|
|
52135
|
+
}
|
|
52136
|
+
|
|
51672
52137
|
/**
|
|
51673
52138
|
* Update a time off request
|
|
51674
52139
|
*
|
|
@@ -52530,6 +52995,93 @@ class WorkforceManagementApi {
|
|
|
52530
52995
|
);
|
|
52531
52996
|
}
|
|
52532
52997
|
|
|
52998
|
+
/**
|
|
52999
|
+
* Creates a new time off limit object under management unit.
|
|
53000
|
+
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
53001
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
53002
|
+
* @param {Object} opts Optional parameters
|
|
53003
|
+
* @param {Object} opts.body body
|
|
53004
|
+
*/
|
|
53005
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, opts) {
|
|
53006
|
+
opts = opts || {};
|
|
53007
|
+
|
|
53008
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53009
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53010
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
53011
|
+
}
|
|
53012
|
+
|
|
53013
|
+
return this.apiClient.callApi(
|
|
53014
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
53015
|
+
'POST',
|
|
53016
|
+
{ 'managementUnitId': managementUnitId },
|
|
53017
|
+
{ },
|
|
53018
|
+
{ },
|
|
53019
|
+
{ },
|
|
53020
|
+
opts['body'],
|
|
53021
|
+
['PureCloud OAuth'],
|
|
53022
|
+
['application/json'],
|
|
53023
|
+
['application/json']
|
|
53024
|
+
);
|
|
53025
|
+
}
|
|
53026
|
+
|
|
53027
|
+
/**
|
|
53028
|
+
* Retrieves time off limit related values based on a given set of filters.
|
|
53029
|
+
*
|
|
53030
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
53031
|
+
* @param {Object} opts Optional parameters
|
|
53032
|
+
* @param {Object} opts.body body
|
|
53033
|
+
*/
|
|
53034
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, opts) {
|
|
53035
|
+
opts = opts || {};
|
|
53036
|
+
|
|
53037
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53038
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53039
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
53040
|
+
}
|
|
53041
|
+
|
|
53042
|
+
return this.apiClient.callApi(
|
|
53043
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
53044
|
+
'POST',
|
|
53045
|
+
{ 'managementUnitId': managementUnitId },
|
|
53046
|
+
{ },
|
|
53047
|
+
{ },
|
|
53048
|
+
{ },
|
|
53049
|
+
opts['body'],
|
|
53050
|
+
['PureCloud OAuth'],
|
|
53051
|
+
['application/json'],
|
|
53052
|
+
['application/json']
|
|
53053
|
+
);
|
|
53054
|
+
}
|
|
53055
|
+
|
|
53056
|
+
/**
|
|
53057
|
+
* Creates a new time off plan
|
|
53058
|
+
*
|
|
53059
|
+
* @param {String} managementUnitId The management unit ID.
|
|
53060
|
+
* @param {Object} opts Optional parameters
|
|
53061
|
+
* @param {Object} opts.body body
|
|
53062
|
+
*/
|
|
53063
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, opts) {
|
|
53064
|
+
opts = opts || {};
|
|
53065
|
+
|
|
53066
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53067
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53068
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
53069
|
+
}
|
|
53070
|
+
|
|
53071
|
+
return this.apiClient.callApi(
|
|
53072
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
53073
|
+
'POST',
|
|
53074
|
+
{ 'managementUnitId': managementUnitId },
|
|
53075
|
+
{ },
|
|
53076
|
+
{ },
|
|
53077
|
+
{ },
|
|
53078
|
+
opts['body'],
|
|
53079
|
+
['PureCloud OAuth'],
|
|
53080
|
+
['application/json'],
|
|
53081
|
+
['application/json']
|
|
53082
|
+
);
|
|
53083
|
+
}
|
|
53084
|
+
|
|
52533
53085
|
/**
|
|
52534
53086
|
* Create a new time off request
|
|
52535
53087
|
*
|
|
@@ -52588,6 +53140,35 @@ class WorkforceManagementApi {
|
|
|
52588
53140
|
);
|
|
52589
53141
|
}
|
|
52590
53142
|
|
|
53143
|
+
/**
|
|
53144
|
+
* Retrieves daily waitlist position for a list of time off requests
|
|
53145
|
+
*
|
|
53146
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
53147
|
+
* @param {Object} opts Optional parameters
|
|
53148
|
+
* @param {Object} opts.body body
|
|
53149
|
+
*/
|
|
53150
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, opts) {
|
|
53151
|
+
opts = opts || {};
|
|
53152
|
+
|
|
53153
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53154
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53155
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
53156
|
+
}
|
|
53157
|
+
|
|
53158
|
+
return this.apiClient.callApi(
|
|
53159
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
53160
|
+
'POST',
|
|
53161
|
+
{ 'managementUnitId': managementUnitId },
|
|
53162
|
+
{ },
|
|
53163
|
+
{ },
|
|
53164
|
+
{ },
|
|
53165
|
+
opts['body'],
|
|
53166
|
+
['PureCloud OAuth'],
|
|
53167
|
+
['application/json'],
|
|
53168
|
+
['application/json']
|
|
53169
|
+
);
|
|
53170
|
+
}
|
|
53171
|
+
|
|
52591
53172
|
/**
|
|
52592
53173
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
52593
53174
|
*
|
|
@@ -52971,6 +53552,30 @@ class WorkforceManagementApi {
|
|
|
52971
53552
|
);
|
|
52972
53553
|
}
|
|
52973
53554
|
|
|
53555
|
+
/**
|
|
53556
|
+
* Queries available time off for the current user
|
|
53557
|
+
*
|
|
53558
|
+
* @param {Object} opts Optional parameters
|
|
53559
|
+
* @param {Object} opts.body body
|
|
53560
|
+
*/
|
|
53561
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(opts) {
|
|
53562
|
+
opts = opts || {};
|
|
53563
|
+
|
|
53564
|
+
|
|
53565
|
+
return this.apiClient.callApi(
|
|
53566
|
+
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
53567
|
+
'POST',
|
|
53568
|
+
{ },
|
|
53569
|
+
{ },
|
|
53570
|
+
{ },
|
|
53571
|
+
{ },
|
|
53572
|
+
opts['body'],
|
|
53573
|
+
['PureCloud OAuth'],
|
|
53574
|
+
['application/json'],
|
|
53575
|
+
['application/json']
|
|
53576
|
+
);
|
|
53577
|
+
}
|
|
53578
|
+
|
|
52974
53579
|
/**
|
|
52975
53580
|
* Create a time off request for the current user
|
|
52976
53581
|
*
|
|
@@ -52995,6 +53600,40 @@ class WorkforceManagementApi {
|
|
|
52995
53600
|
);
|
|
52996
53601
|
}
|
|
52997
53602
|
|
|
53603
|
+
/**
|
|
53604
|
+
* Sets daily values for a date range of time off limit object
|
|
53605
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
53606
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
53607
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
53608
|
+
* @param {Object} opts Optional parameters
|
|
53609
|
+
* @param {Object} opts.body body
|
|
53610
|
+
*/
|
|
53611
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, opts) {
|
|
53612
|
+
opts = opts || {};
|
|
53613
|
+
|
|
53614
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53615
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53616
|
+
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
53617
|
+
}
|
|
53618
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
53619
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
53620
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
53621
|
+
}
|
|
53622
|
+
|
|
53623
|
+
return this.apiClient.callApi(
|
|
53624
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
53625
|
+
'PUT',
|
|
53626
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
53627
|
+
{ },
|
|
53628
|
+
{ },
|
|
53629
|
+
{ },
|
|
53630
|
+
opts['body'],
|
|
53631
|
+
['PureCloud OAuth'],
|
|
53632
|
+
['application/json'],
|
|
53633
|
+
['application/json']
|
|
53634
|
+
);
|
|
53635
|
+
}
|
|
53636
|
+
|
|
52998
53637
|
}
|
|
52999
53638
|
|
|
53000
53639
|
/**
|
|
@@ -53026,7 +53665,7 @@ class WorkforceManagementApi {
|
|
|
53026
53665
|
* </pre>
|
|
53027
53666
|
* </p>
|
|
53028
53667
|
* @module purecloud-platform-client-v2/index
|
|
53029
|
-
* @version
|
|
53668
|
+
* @version 128.0.0
|
|
53030
53669
|
*/
|
|
53031
53670
|
class platformClient {
|
|
53032
53671
|
constructor() {
|