purecloud-platform-client-v2 125.0.0 → 126.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 +757 -169
- package/dist/web-amd/purecloud-platform-client-v2.js +757 -169
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +757 -169
- package/dist/web-cjs/purecloud-platform-client-v2.js +757 -169
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +307 -49
- 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 +1 -1
- 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 +2 -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 +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 +473 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -6873,7 +6873,7 @@ class Configuration {
|
|
|
6873
6873
|
|
|
6874
6874
|
/**
|
|
6875
6875
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6876
|
-
* @version
|
|
6876
|
+
* @version 126.0.0
|
|
6877
6877
|
*/
|
|
6878
6878
|
class ApiClient {
|
|
6879
6879
|
/**
|
|
@@ -7813,7 +7813,7 @@ class ApiClient {
|
|
|
7813
7813
|
|
|
7814
7814
|
// set header parameters
|
|
7815
7815
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
7816
|
-
//request.set({ 'purecloud-sdk': '
|
|
7816
|
+
//request.set({ 'purecloud-sdk': '126.0.0' });
|
|
7817
7817
|
|
|
7818
7818
|
// set request timeout
|
|
7819
7819
|
request.timeout(that.timeout);
|
|
@@ -7913,7 +7913,7 @@ class AlertingApi {
|
|
|
7913
7913
|
/**
|
|
7914
7914
|
* Alerting service.
|
|
7915
7915
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
7916
|
-
* @version
|
|
7916
|
+
* @version 126.0.0
|
|
7917
7917
|
*/
|
|
7918
7918
|
|
|
7919
7919
|
/**
|
|
@@ -8227,7 +8227,7 @@ class AnalyticsApi {
|
|
|
8227
8227
|
/**
|
|
8228
8228
|
* Analytics service.
|
|
8229
8229
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8230
|
-
* @version
|
|
8230
|
+
* @version 126.0.0
|
|
8231
8231
|
*/
|
|
8232
8232
|
|
|
8233
8233
|
/**
|
|
@@ -8823,31 +8823,6 @@ class AnalyticsApi {
|
|
|
8823
8823
|
);
|
|
8824
8824
|
}
|
|
8825
8825
|
|
|
8826
|
-
/**
|
|
8827
|
-
* Patch AnalyticsReportingSettings values for an organization
|
|
8828
|
-
*
|
|
8829
|
-
* @param {Object} body AnalyticsReportingSettingsRequest
|
|
8830
|
-
*/
|
|
8831
|
-
patchAnalyticsReportingSettings(body) {
|
|
8832
|
-
// verify the required parameter 'body' is set
|
|
8833
|
-
if (body === undefined || body === null) {
|
|
8834
|
-
throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
|
|
8835
|
-
}
|
|
8836
|
-
|
|
8837
|
-
return this.apiClient.callApi(
|
|
8838
|
-
'/api/v2/analytics/reporting/settings',
|
|
8839
|
-
'PATCH',
|
|
8840
|
-
{ },
|
|
8841
|
-
{ },
|
|
8842
|
-
{ },
|
|
8843
|
-
{ },
|
|
8844
|
-
body,
|
|
8845
|
-
['PureCloud OAuth'],
|
|
8846
|
-
['application/json'],
|
|
8847
|
-
['application/json']
|
|
8848
|
-
);
|
|
8849
|
-
}
|
|
8850
|
-
|
|
8851
8826
|
/**
|
|
8852
8827
|
* Query for bot aggregates
|
|
8853
8828
|
*
|
|
@@ -9389,7 +9364,7 @@ class ArchitectApi {
|
|
|
9389
9364
|
/**
|
|
9390
9365
|
* Architect service.
|
|
9391
9366
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
9392
|
-
* @version
|
|
9367
|
+
* @version 126.0.0
|
|
9393
9368
|
*/
|
|
9394
9369
|
|
|
9395
9370
|
/**
|
|
@@ -12385,7 +12360,7 @@ class AuditApi {
|
|
|
12385
12360
|
/**
|
|
12386
12361
|
* Audit service.
|
|
12387
12362
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
12388
|
-
* @version
|
|
12363
|
+
* @version 126.0.0
|
|
12389
12364
|
*/
|
|
12390
12365
|
|
|
12391
12366
|
/**
|
|
@@ -12556,7 +12531,7 @@ class AuthorizationApi {
|
|
|
12556
12531
|
/**
|
|
12557
12532
|
* Authorization service.
|
|
12558
12533
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
12559
|
-
* @version
|
|
12534
|
+
* @version 126.0.0
|
|
12560
12535
|
*/
|
|
12561
12536
|
|
|
12562
12537
|
/**
|
|
@@ -13739,7 +13714,7 @@ class BillingApi {
|
|
|
13739
13714
|
/**
|
|
13740
13715
|
* Billing service.
|
|
13741
13716
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13742
|
-
* @version
|
|
13717
|
+
* @version 126.0.0
|
|
13743
13718
|
*/
|
|
13744
13719
|
|
|
13745
13720
|
/**
|
|
@@ -13819,7 +13794,7 @@ class ChatApi {
|
|
|
13819
13794
|
/**
|
|
13820
13795
|
* Chat service.
|
|
13821
13796
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
13822
|
-
* @version
|
|
13797
|
+
* @version 126.0.0
|
|
13823
13798
|
*/
|
|
13824
13799
|
|
|
13825
13800
|
/**
|
|
@@ -13910,7 +13885,7 @@ class CoachingApi {
|
|
|
13910
13885
|
/**
|
|
13911
13886
|
* Coaching service.
|
|
13912
13887
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13913
|
-
* @version
|
|
13888
|
+
* @version 126.0.0
|
|
13914
13889
|
*/
|
|
13915
13890
|
|
|
13916
13891
|
/**
|
|
@@ -14485,7 +14460,7 @@ class ContentManagementApi {
|
|
|
14485
14460
|
/**
|
|
14486
14461
|
* ContentManagement service.
|
|
14487
14462
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
14488
|
-
* @version
|
|
14463
|
+
* @version 126.0.0
|
|
14489
14464
|
*/
|
|
14490
14465
|
|
|
14491
14466
|
/**
|
|
@@ -15625,7 +15600,7 @@ class ConversationsApi {
|
|
|
15625
15600
|
/**
|
|
15626
15601
|
* Conversations service.
|
|
15627
15602
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
15628
|
-
* @version
|
|
15603
|
+
* @version 126.0.0
|
|
15629
15604
|
*/
|
|
15630
15605
|
|
|
15631
15606
|
/**
|
|
@@ -20014,7 +19989,7 @@ class DataExtensionsApi {
|
|
|
20014
19989
|
/**
|
|
20015
19990
|
* DataExtensions service.
|
|
20016
19991
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20017
|
-
* @version
|
|
19992
|
+
* @version 126.0.0
|
|
20018
19993
|
*/
|
|
20019
19994
|
|
|
20020
19995
|
/**
|
|
@@ -20100,7 +20075,7 @@ class ExternalContactsApi {
|
|
|
20100
20075
|
/**
|
|
20101
20076
|
* ExternalContacts service.
|
|
20102
20077
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20103
|
-
* @version
|
|
20078
|
+
* @version 126.0.0
|
|
20104
20079
|
*/
|
|
20105
20080
|
|
|
20106
20081
|
/**
|
|
@@ -21843,7 +21818,7 @@ class FaxApi {
|
|
|
21843
21818
|
/**
|
|
21844
21819
|
* Fax service.
|
|
21845
21820
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
21846
|
-
* @version
|
|
21821
|
+
* @version 126.0.0
|
|
21847
21822
|
*/
|
|
21848
21823
|
|
|
21849
21824
|
/**
|
|
@@ -22014,7 +21989,7 @@ class FlowsApi {
|
|
|
22014
21989
|
/**
|
|
22015
21990
|
* Flows service.
|
|
22016
21991
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22017
|
-
* @version
|
|
21992
|
+
* @version 126.0.0
|
|
22018
21993
|
*/
|
|
22019
21994
|
|
|
22020
21995
|
/**
|
|
@@ -22085,7 +22060,7 @@ class GamificationApi {
|
|
|
22085
22060
|
/**
|
|
22086
22061
|
* Gamification service.
|
|
22087
22062
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22088
|
-
* @version
|
|
22063
|
+
* @version 126.0.0
|
|
22089
22064
|
*/
|
|
22090
22065
|
|
|
22091
22066
|
/**
|
|
@@ -23391,7 +23366,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
23391
23366
|
/**
|
|
23392
23367
|
* GeneralDataProtectionRegulation service.
|
|
23393
23368
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
23394
|
-
* @version
|
|
23369
|
+
* @version 126.0.0
|
|
23395
23370
|
*/
|
|
23396
23371
|
|
|
23397
23372
|
/**
|
|
@@ -23521,7 +23496,7 @@ class GeolocationApi {
|
|
|
23521
23496
|
/**
|
|
23522
23497
|
* Geolocation service.
|
|
23523
23498
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
23524
|
-
* @version
|
|
23499
|
+
* @version 126.0.0
|
|
23525
23500
|
*/
|
|
23526
23501
|
|
|
23527
23502
|
/**
|
|
@@ -23652,7 +23627,7 @@ class GreetingsApi {
|
|
|
23652
23627
|
/**
|
|
23653
23628
|
* Greetings service.
|
|
23654
23629
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
23655
|
-
* @version
|
|
23630
|
+
* @version 126.0.0
|
|
23656
23631
|
*/
|
|
23657
23632
|
|
|
23658
23633
|
/**
|
|
@@ -24107,7 +24082,7 @@ class GroupsApi {
|
|
|
24107
24082
|
/**
|
|
24108
24083
|
* Groups service.
|
|
24109
24084
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
24110
|
-
* @version
|
|
24085
|
+
* @version 126.0.0
|
|
24111
24086
|
*/
|
|
24112
24087
|
|
|
24113
24088
|
/**
|
|
@@ -24512,7 +24487,7 @@ class IdentityProviderApi {
|
|
|
24512
24487
|
/**
|
|
24513
24488
|
* IdentityProvider service.
|
|
24514
24489
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
24515
|
-
* @version
|
|
24490
|
+
* @version 126.0.0
|
|
24516
24491
|
*/
|
|
24517
24492
|
|
|
24518
24493
|
/**
|
|
@@ -25268,7 +25243,7 @@ class IntegrationsApi {
|
|
|
25268
25243
|
/**
|
|
25269
25244
|
* Integrations service.
|
|
25270
25245
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
25271
|
-
* @version
|
|
25246
|
+
* @version 126.0.0
|
|
25272
25247
|
*/
|
|
25273
25248
|
|
|
25274
25249
|
/**
|
|
@@ -26914,7 +26889,7 @@ class JourneyApi {
|
|
|
26914
26889
|
/**
|
|
26915
26890
|
* Journey service.
|
|
26916
26891
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
26917
|
-
* @version
|
|
26892
|
+
* @version 126.0.0
|
|
26918
26893
|
*/
|
|
26919
26894
|
|
|
26920
26895
|
/**
|
|
@@ -27625,7 +27600,7 @@ class KnowledgeApi {
|
|
|
27625
27600
|
/**
|
|
27626
27601
|
* Knowledge service.
|
|
27627
27602
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
27628
|
-
* @version
|
|
27603
|
+
* @version 126.0.0
|
|
27629
27604
|
*/
|
|
27630
27605
|
|
|
27631
27606
|
/**
|
|
@@ -28115,79 +28090,6 @@ class KnowledgeApi {
|
|
|
28115
28090
|
);
|
|
28116
28091
|
}
|
|
28117
28092
|
|
|
28118
|
-
/**
|
|
28119
|
-
* Update specific context data of the knowledge base.
|
|
28120
|
-
*
|
|
28121
|
-
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
28122
|
-
* @param {String} contextId Context ID.
|
|
28123
|
-
* @param {Object} opts Optional parameters
|
|
28124
|
-
* @param {Object} opts.body
|
|
28125
|
-
*/
|
|
28126
|
-
patchKnowledgeKnowledgebaseContext(knowledgeBaseId, contextId, opts) {
|
|
28127
|
-
opts = opts || {};
|
|
28128
|
-
|
|
28129
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
28130
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
28131
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseContext';
|
|
28132
|
-
}
|
|
28133
|
-
// verify the required parameter 'contextId' is set
|
|
28134
|
-
if (contextId === undefined || contextId === null) {
|
|
28135
|
-
throw 'Missing the required parameter "contextId" when calling patchKnowledgeKnowledgebaseContext';
|
|
28136
|
-
}
|
|
28137
|
-
|
|
28138
|
-
return this.apiClient.callApi(
|
|
28139
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/contexts/{contextId}',
|
|
28140
|
-
'PATCH',
|
|
28141
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'contextId': contextId },
|
|
28142
|
-
{ },
|
|
28143
|
-
{ },
|
|
28144
|
-
{ },
|
|
28145
|
-
opts['body'],
|
|
28146
|
-
['PureCloud OAuth'],
|
|
28147
|
-
['application/json'],
|
|
28148
|
-
['application/json']
|
|
28149
|
-
);
|
|
28150
|
-
}
|
|
28151
|
-
|
|
28152
|
-
/**
|
|
28153
|
-
* Update context value.
|
|
28154
|
-
*
|
|
28155
|
-
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
28156
|
-
* @param {String} contextId Context ID.
|
|
28157
|
-
* @param {String} contextValueId Context Value ID.
|
|
28158
|
-
* @param {Object} opts Optional parameters
|
|
28159
|
-
* @param {Object} opts.body
|
|
28160
|
-
*/
|
|
28161
|
-
patchKnowledgeKnowledgebaseContextValue(knowledgeBaseId, contextId, contextValueId, opts) {
|
|
28162
|
-
opts = opts || {};
|
|
28163
|
-
|
|
28164
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
28165
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
28166
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
28167
|
-
}
|
|
28168
|
-
// verify the required parameter 'contextId' is set
|
|
28169
|
-
if (contextId === undefined || contextId === null) {
|
|
28170
|
-
throw 'Missing the required parameter "contextId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
28171
|
-
}
|
|
28172
|
-
// verify the required parameter 'contextValueId' is set
|
|
28173
|
-
if (contextValueId === undefined || contextValueId === null) {
|
|
28174
|
-
throw 'Missing the required parameter "contextValueId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
28175
|
-
}
|
|
28176
|
-
|
|
28177
|
-
return this.apiClient.callApi(
|
|
28178
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/contexts/{contextId}/values/{contextValueId}',
|
|
28179
|
-
'PATCH',
|
|
28180
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'contextId': contextId,'contextValueId': contextValueId },
|
|
28181
|
-
{ },
|
|
28182
|
-
{ },
|
|
28183
|
-
{ },
|
|
28184
|
-
opts['body'],
|
|
28185
|
-
['PureCloud OAuth'],
|
|
28186
|
-
['application/json'],
|
|
28187
|
-
['application/json']
|
|
28188
|
-
);
|
|
28189
|
-
}
|
|
28190
|
-
|
|
28191
28093
|
/**
|
|
28192
28094
|
* Update category
|
|
28193
28095
|
*
|
|
@@ -28598,7 +28500,7 @@ class LanguageUnderstandingApi {
|
|
|
28598
28500
|
/**
|
|
28599
28501
|
* LanguageUnderstanding service.
|
|
28600
28502
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
28601
|
-
* @version
|
|
28503
|
+
* @version 126.0.0
|
|
28602
28504
|
*/
|
|
28603
28505
|
|
|
28604
28506
|
/**
|
|
@@ -29164,7 +29066,7 @@ class LanguageUnderstandingApi {
|
|
|
29164
29066
|
}
|
|
29165
29067
|
|
|
29166
29068
|
/**
|
|
29167
|
-
* Save information for the draft
|
|
29069
|
+
* Save information for the draft. Either topic draft or intent draft should be sent.
|
|
29168
29070
|
*
|
|
29169
29071
|
* @param {String} minerId Miner ID
|
|
29170
29072
|
* @param {String} draftId Draft ID
|
|
@@ -29408,7 +29310,7 @@ class LanguageUnderstandingApi {
|
|
|
29408
29310
|
}
|
|
29409
29311
|
|
|
29410
29312
|
/**
|
|
29411
|
-
* Start the mining process. Specify date range pair with mediaType
|
|
29313
|
+
* 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.
|
|
29412
29314
|
*
|
|
29413
29315
|
* @param {String} minerId Miner ID
|
|
29414
29316
|
* @param {Object} opts Optional parameters
|
|
@@ -29502,7 +29404,7 @@ class LanguagesApi {
|
|
|
29502
29404
|
/**
|
|
29503
29405
|
* Languages service.
|
|
29504
29406
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
29505
|
-
* @version
|
|
29407
|
+
* @version 126.0.0
|
|
29506
29408
|
*/
|
|
29507
29409
|
|
|
29508
29410
|
/**
|
|
@@ -29770,7 +29672,7 @@ class LearningApi {
|
|
|
29770
29672
|
/**
|
|
29771
29673
|
* Learning service.
|
|
29772
29674
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
29773
|
-
* @version
|
|
29675
|
+
* @version 126.0.0
|
|
29774
29676
|
*/
|
|
29775
29677
|
|
|
29776
29678
|
/**
|
|
@@ -30361,7 +30263,7 @@ class LicenseApi {
|
|
|
30361
30263
|
/**
|
|
30362
30264
|
* License service.
|
|
30363
30265
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
30364
|
-
* @version
|
|
30266
|
+
* @version 126.0.0
|
|
30365
30267
|
*/
|
|
30366
30268
|
|
|
30367
30269
|
/**
|
|
@@ -30599,7 +30501,7 @@ class LocationsApi {
|
|
|
30599
30501
|
/**
|
|
30600
30502
|
* Locations service.
|
|
30601
30503
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
30602
|
-
* @version
|
|
30504
|
+
* @version 126.0.0
|
|
30603
30505
|
*/
|
|
30604
30506
|
|
|
30605
30507
|
/**
|
|
@@ -30835,7 +30737,7 @@ class MobileDevicesApi {
|
|
|
30835
30737
|
/**
|
|
30836
30738
|
* MobileDevices service.
|
|
30837
30739
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
30838
|
-
* @version
|
|
30740
|
+
* @version 126.0.0
|
|
30839
30741
|
*/
|
|
30840
30742
|
|
|
30841
30743
|
/**
|
|
@@ -30986,7 +30888,7 @@ class NotificationsApi {
|
|
|
30986
30888
|
/**
|
|
30987
30889
|
* Notifications service.
|
|
30988
30890
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
30989
|
-
* @version
|
|
30891
|
+
* @version 126.0.0
|
|
30990
30892
|
*/
|
|
30991
30893
|
|
|
30992
30894
|
/**
|
|
@@ -31211,7 +31113,7 @@ class OAuthApi {
|
|
|
31211
31113
|
/**
|
|
31212
31114
|
* OAuth service.
|
|
31213
31115
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
31214
|
-
* @version
|
|
31116
|
+
* @version 126.0.0
|
|
31215
31117
|
*/
|
|
31216
31118
|
|
|
31217
31119
|
/**
|
|
@@ -31569,7 +31471,7 @@ class ObjectsApi {
|
|
|
31569
31471
|
/**
|
|
31570
31472
|
* Objects service.
|
|
31571
31473
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
31572
|
-
* @version
|
|
31474
|
+
* @version 126.0.0
|
|
31573
31475
|
*/
|
|
31574
31476
|
|
|
31575
31477
|
/**
|
|
@@ -31840,7 +31742,7 @@ class OrganizationApi {
|
|
|
31840
31742
|
/**
|
|
31841
31743
|
* Organization service.
|
|
31842
31744
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
31843
|
-
* @version
|
|
31745
|
+
* @version 126.0.0
|
|
31844
31746
|
*/
|
|
31845
31747
|
|
|
31846
31748
|
/**
|
|
@@ -32243,7 +32145,7 @@ class OrganizationAuthorizationApi {
|
|
|
32243
32145
|
/**
|
|
32244
32146
|
* OrganizationAuthorization service.
|
|
32245
32147
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
32246
|
-
* @version
|
|
32148
|
+
* @version 126.0.0
|
|
32247
32149
|
*/
|
|
32248
32150
|
|
|
32249
32151
|
/**
|
|
@@ -32283,6 +32185,36 @@ class OrganizationAuthorizationApi {
|
|
|
32283
32185
|
);
|
|
32284
32186
|
}
|
|
32285
32187
|
|
|
32188
|
+
/**
|
|
32189
|
+
* Deletes cloned user
|
|
32190
|
+
*
|
|
32191
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
32192
|
+
* @param {String} trusteeUserId Id of the cloned user to delete
|
|
32193
|
+
*/
|
|
32194
|
+
deleteOrgauthorizationTrusteeCloneduser(trusteeOrgId, trusteeUserId) {
|
|
32195
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
32196
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
32197
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
32198
|
+
}
|
|
32199
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
32200
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
32201
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
32202
|
+
}
|
|
32203
|
+
|
|
32204
|
+
return this.apiClient.callApi(
|
|
32205
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}',
|
|
32206
|
+
'DELETE',
|
|
32207
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeUserId': trusteeUserId },
|
|
32208
|
+
{ },
|
|
32209
|
+
{ },
|
|
32210
|
+
{ },
|
|
32211
|
+
null,
|
|
32212
|
+
['PureCloud OAuth'],
|
|
32213
|
+
['application/json'],
|
|
32214
|
+
['application/json']
|
|
32215
|
+
);
|
|
32216
|
+
}
|
|
32217
|
+
|
|
32286
32218
|
/**
|
|
32287
32219
|
* Delete Trustee User
|
|
32288
32220
|
*
|
|
@@ -32368,6 +32300,36 @@ class OrganizationAuthorizationApi {
|
|
|
32368
32300
|
);
|
|
32369
32301
|
}
|
|
32370
32302
|
|
|
32303
|
+
/**
|
|
32304
|
+
* Delete Cloned User
|
|
32305
|
+
*
|
|
32306
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
32307
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
32308
|
+
*/
|
|
32309
|
+
deleteOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
32310
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
32311
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
32312
|
+
throw 'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
32313
|
+
}
|
|
32314
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
32315
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
32316
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
32317
|
+
}
|
|
32318
|
+
|
|
32319
|
+
return this.apiClient.callApi(
|
|
32320
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
32321
|
+
'DELETE',
|
|
32322
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
32323
|
+
{ },
|
|
32324
|
+
{ },
|
|
32325
|
+
{ },
|
|
32326
|
+
null,
|
|
32327
|
+
['PureCloud OAuth'],
|
|
32328
|
+
['application/json'],
|
|
32329
|
+
['application/json']
|
|
32330
|
+
);
|
|
32331
|
+
}
|
|
32332
|
+
|
|
32371
32333
|
/**
|
|
32372
32334
|
* Delete Trustee User
|
|
32373
32335
|
*
|
|
@@ -32448,6 +32410,31 @@ class OrganizationAuthorizationApi {
|
|
|
32448
32410
|
);
|
|
32449
32411
|
}
|
|
32450
32412
|
|
|
32413
|
+
/**
|
|
32414
|
+
* The list of cloned users from the trustee organization (i.e. users with a native user record).
|
|
32415
|
+
* There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged
|
|
32416
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
32417
|
+
*/
|
|
32418
|
+
getOrgauthorizationTrusteeClonedusers(trusteeOrgId) {
|
|
32419
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
32420
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
32421
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeClonedusers';
|
|
32422
|
+
}
|
|
32423
|
+
|
|
32424
|
+
return this.apiClient.callApi(
|
|
32425
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers',
|
|
32426
|
+
'GET',
|
|
32427
|
+
{ 'trusteeOrgId': trusteeOrgId },
|
|
32428
|
+
{ },
|
|
32429
|
+
{ },
|
|
32430
|
+
{ },
|
|
32431
|
+
null,
|
|
32432
|
+
['PureCloud OAuth'],
|
|
32433
|
+
['application/json'],
|
|
32434
|
+
['application/json']
|
|
32435
|
+
);
|
|
32436
|
+
}
|
|
32437
|
+
|
|
32451
32438
|
/**
|
|
32452
32439
|
* Get Trustee User
|
|
32453
32440
|
*
|
|
@@ -32563,6 +32550,26 @@ class OrganizationAuthorizationApi {
|
|
|
32563
32550
|
);
|
|
32564
32551
|
}
|
|
32565
32552
|
|
|
32553
|
+
/**
|
|
32554
|
+
* Get organization authorization trust with Customer Care, if one exists.
|
|
32555
|
+
*
|
|
32556
|
+
*/
|
|
32557
|
+
getOrgauthorizationTrusteesDefault() {
|
|
32558
|
+
|
|
32559
|
+
return this.apiClient.callApi(
|
|
32560
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
32561
|
+
'GET',
|
|
32562
|
+
{ },
|
|
32563
|
+
{ },
|
|
32564
|
+
{ },
|
|
32565
|
+
{ },
|
|
32566
|
+
null,
|
|
32567
|
+
['PureCloud OAuth'],
|
|
32568
|
+
['application/json'],
|
|
32569
|
+
['application/json']
|
|
32570
|
+
);
|
|
32571
|
+
}
|
|
32572
|
+
|
|
32566
32573
|
/**
|
|
32567
32574
|
* Get Org Trust
|
|
32568
32575
|
*
|
|
@@ -32588,6 +32595,61 @@ class OrganizationAuthorizationApi {
|
|
|
32588
32595
|
);
|
|
32589
32596
|
}
|
|
32590
32597
|
|
|
32598
|
+
/**
|
|
32599
|
+
* Get Cloned User
|
|
32600
|
+
*
|
|
32601
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
32602
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
32603
|
+
*/
|
|
32604
|
+
getOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
32605
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
32606
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
32607
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorCloneduser';
|
|
32608
|
+
}
|
|
32609
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
32610
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
32611
|
+
throw 'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrustorCloneduser';
|
|
32612
|
+
}
|
|
32613
|
+
|
|
32614
|
+
return this.apiClient.callApi(
|
|
32615
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
32616
|
+
'GET',
|
|
32617
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
32618
|
+
{ },
|
|
32619
|
+
{ },
|
|
32620
|
+
{ },
|
|
32621
|
+
null,
|
|
32622
|
+
['PureCloud OAuth'],
|
|
32623
|
+
['application/json'],
|
|
32624
|
+
['application/json']
|
|
32625
|
+
);
|
|
32626
|
+
}
|
|
32627
|
+
|
|
32628
|
+
/**
|
|
32629
|
+
* The list of cloned users in the trustor organization (i.e. users with a native user record).
|
|
32630
|
+
*
|
|
32631
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
32632
|
+
*/
|
|
32633
|
+
getOrgauthorizationTrustorClonedusers(trustorOrgId) {
|
|
32634
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
32635
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
32636
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorClonedusers';
|
|
32637
|
+
}
|
|
32638
|
+
|
|
32639
|
+
return this.apiClient.callApi(
|
|
32640
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers',
|
|
32641
|
+
'GET',
|
|
32642
|
+
{ 'trustorOrgId': trustorOrgId },
|
|
32643
|
+
{ },
|
|
32644
|
+
{ },
|
|
32645
|
+
{ },
|
|
32646
|
+
null,
|
|
32647
|
+
['PureCloud OAuth'],
|
|
32648
|
+
['application/json'],
|
|
32649
|
+
['application/json']
|
|
32650
|
+
);
|
|
32651
|
+
}
|
|
32652
|
+
|
|
32591
32653
|
/**
|
|
32592
32654
|
* Get Trustee User
|
|
32593
32655
|
*
|
|
@@ -32785,6 +32847,31 @@ class OrganizationAuthorizationApi {
|
|
|
32785
32847
|
);
|
|
32786
32848
|
}
|
|
32787
32849
|
|
|
32850
|
+
/**
|
|
32851
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
32852
|
+
*
|
|
32853
|
+
* @param {Object} opts Optional parameters
|
|
32854
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
32855
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
32856
|
+
*/
|
|
32857
|
+
postOrgauthorizationTrusteesDefault(opts) {
|
|
32858
|
+
opts = opts || {};
|
|
32859
|
+
|
|
32860
|
+
|
|
32861
|
+
return this.apiClient.callApi(
|
|
32862
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
32863
|
+
'POST',
|
|
32864
|
+
{ },
|
|
32865
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'] },
|
|
32866
|
+
{ },
|
|
32867
|
+
{ },
|
|
32868
|
+
null,
|
|
32869
|
+
['PureCloud OAuth'],
|
|
32870
|
+
['application/json'],
|
|
32871
|
+
['application/json']
|
|
32872
|
+
);
|
|
32873
|
+
}
|
|
32874
|
+
|
|
32788
32875
|
/**
|
|
32789
32876
|
* Get Org Trustor Audits
|
|
32790
32877
|
*
|
|
@@ -32917,6 +33004,36 @@ class OrganizationAuthorizationApi {
|
|
|
32917
33004
|
);
|
|
32918
33005
|
}
|
|
32919
33006
|
|
|
33007
|
+
/**
|
|
33008
|
+
* Creates a clone of the trustee user in the trustor org.
|
|
33009
|
+
*
|
|
33010
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
33011
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
33012
|
+
*/
|
|
33013
|
+
putOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
33014
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
33015
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
33016
|
+
throw 'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorCloneduser';
|
|
33017
|
+
}
|
|
33018
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
33019
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
33020
|
+
throw 'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorCloneduser';
|
|
33021
|
+
}
|
|
33022
|
+
|
|
33023
|
+
return this.apiClient.callApi(
|
|
33024
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
33025
|
+
'PUT',
|
|
33026
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
33027
|
+
{ },
|
|
33028
|
+
{ },
|
|
33029
|
+
{ },
|
|
33030
|
+
null,
|
|
33031
|
+
['PureCloud OAuth'],
|
|
33032
|
+
['application/json'],
|
|
33033
|
+
['application/json']
|
|
33034
|
+
);
|
|
33035
|
+
}
|
|
33036
|
+
|
|
32920
33037
|
/**
|
|
32921
33038
|
* Add a Trustee user to the trust.
|
|
32922
33039
|
*
|
|
@@ -32953,7 +33070,7 @@ class OutboundApi {
|
|
|
32953
33070
|
/**
|
|
32954
33071
|
* Outbound service.
|
|
32955
33072
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
32956
|
-
* @version
|
|
33073
|
+
* @version 126.0.0
|
|
32957
33074
|
*/
|
|
32958
33075
|
|
|
32959
33076
|
/**
|
|
@@ -35979,7 +36096,7 @@ class PresenceApi {
|
|
|
35979
36096
|
/**
|
|
35980
36097
|
* Presence service.
|
|
35981
36098
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
35982
|
-
* @version
|
|
36099
|
+
* @version 126.0.0
|
|
35983
36100
|
*/
|
|
35984
36101
|
|
|
35985
36102
|
/**
|
|
@@ -36351,7 +36468,7 @@ class QualityApi {
|
|
|
36351
36468
|
/**
|
|
36352
36469
|
* Quality service.
|
|
36353
36470
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
36354
|
-
* @version
|
|
36471
|
+
* @version 126.0.0
|
|
36355
36472
|
*/
|
|
36356
36473
|
|
|
36357
36474
|
/**
|
|
@@ -36724,7 +36841,7 @@ class QualityApi {
|
|
|
36724
36841
|
|
|
36725
36842
|
/**
|
|
36726
36843
|
* Queries Evaluations and returns a paged list
|
|
36727
|
-
* Query params must include one of conversationId, evaluatorUserId, or agentUserId
|
|
36844
|
+
* 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.
|
|
36728
36845
|
* @param {Object} opts Optional parameters
|
|
36729
36846
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
36730
36847
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -37879,7 +37996,7 @@ class RecordingApi {
|
|
|
37879
37996
|
/**
|
|
37880
37997
|
* Recording service.
|
|
37881
37998
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
37882
|
-
* @version
|
|
37999
|
+
* @version 126.0.0
|
|
37883
38000
|
*/
|
|
37884
38001
|
|
|
37885
38002
|
/**
|
|
@@ -39398,7 +39515,7 @@ class ResponseManagementApi {
|
|
|
39398
39515
|
/**
|
|
39399
39516
|
* ResponseManagement service.
|
|
39400
39517
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
39401
|
-
* @version
|
|
39518
|
+
* @version 126.0.0
|
|
39402
39519
|
*/
|
|
39403
39520
|
|
|
39404
39521
|
/**
|
|
@@ -39723,7 +39840,7 @@ class RoutingApi {
|
|
|
39723
39840
|
/**
|
|
39724
39841
|
* Routing service.
|
|
39725
39842
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
39726
|
-
* @version
|
|
39843
|
+
* @version 126.0.0
|
|
39727
39844
|
*/
|
|
39728
39845
|
|
|
39729
39846
|
/**
|
|
@@ -40879,12 +40996,11 @@ class RoutingApi {
|
|
|
40879
40996
|
}
|
|
40880
40997
|
|
|
40881
40998
|
/**
|
|
40882
|
-
* Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
|
|
40999
|
+
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
40883
41000
|
*
|
|
40884
41001
|
* @param {Object} opts Optional parameters
|
|
40885
41002
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
40886
41003
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40887
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
40888
41004
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
40889
41005
|
*/
|
|
40890
41006
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -40895,7 +41011,7 @@ class RoutingApi {
|
|
|
40895
41011
|
'/api/v2/routing/queues/divisionviews/all',
|
|
40896
41012
|
'GET',
|
|
40897
41013
|
{ },
|
|
40898
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
41014
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
40899
41015
|
{ },
|
|
40900
41016
|
{ },
|
|
40901
41017
|
null,
|
|
@@ -42643,7 +42759,7 @@ class SCIMApi {
|
|
|
42643
42759
|
/**
|
|
42644
42760
|
* SCIM service.
|
|
42645
42761
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
42646
|
-
* @version
|
|
42762
|
+
* @version 126.0.0
|
|
42647
42763
|
*/
|
|
42648
42764
|
|
|
42649
42765
|
/**
|
|
@@ -43520,7 +43636,7 @@ class ScriptsApi {
|
|
|
43520
43636
|
/**
|
|
43521
43637
|
* Scripts service.
|
|
43522
43638
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
43523
|
-
* @version
|
|
43639
|
+
* @version 126.0.0
|
|
43524
43640
|
*/
|
|
43525
43641
|
|
|
43526
43642
|
/**
|
|
@@ -43873,7 +43989,7 @@ class SearchApi {
|
|
|
43873
43989
|
/**
|
|
43874
43990
|
* Search service.
|
|
43875
43991
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
43876
|
-
* @version
|
|
43992
|
+
* @version 126.0.0
|
|
43877
43993
|
*/
|
|
43878
43994
|
|
|
43879
43995
|
/**
|
|
@@ -44408,7 +44524,7 @@ class SpeechTextAnalyticsApi {
|
|
|
44408
44524
|
/**
|
|
44409
44525
|
* SpeechTextAnalytics service.
|
|
44410
44526
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
44411
|
-
* @version
|
|
44527
|
+
* @version 126.0.0
|
|
44412
44528
|
*/
|
|
44413
44529
|
|
|
44414
44530
|
/**
|
|
@@ -44579,7 +44695,7 @@ class SpeechTextAnalyticsApi {
|
|
|
44579
44695
|
|
|
44580
44696
|
/**
|
|
44581
44697
|
* Get list of supported Speech & Text Analytics dialects
|
|
44582
|
-
*
|
|
44698
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
44583
44699
|
*/
|
|
44584
44700
|
getSpeechandtextanalyticsDialects() {
|
|
44585
44701
|
|
|
@@ -45261,7 +45377,7 @@ class StationsApi {
|
|
|
45261
45377
|
/**
|
|
45262
45378
|
* Stations service.
|
|
45263
45379
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
45264
|
-
* @version
|
|
45380
|
+
* @version 126.0.0
|
|
45265
45381
|
*/
|
|
45266
45382
|
|
|
45267
45383
|
/**
|
|
@@ -45408,7 +45524,7 @@ class SuggestApi {
|
|
|
45408
45524
|
/**
|
|
45409
45525
|
* Suggest service.
|
|
45410
45526
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
45411
|
-
* @version
|
|
45527
|
+
* @version 126.0.0
|
|
45412
45528
|
*/
|
|
45413
45529
|
|
|
45414
45530
|
/**
|
|
@@ -45547,7 +45663,7 @@ class TelephonyApi {
|
|
|
45547
45663
|
/**
|
|
45548
45664
|
* Telephony service.
|
|
45549
45665
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
45550
|
-
* @version
|
|
45666
|
+
* @version 126.0.0
|
|
45551
45667
|
*/
|
|
45552
45668
|
|
|
45553
45669
|
/**
|
|
@@ -45655,7 +45771,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
45655
45771
|
/**
|
|
45656
45772
|
* TelephonyProvidersEdge service.
|
|
45657
45773
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
45658
|
-
* @version
|
|
45774
|
+
* @version 126.0.0
|
|
45659
45775
|
*/
|
|
45660
45776
|
|
|
45661
45777
|
/**
|
|
@@ -49268,7 +49384,7 @@ class TextbotsApi {
|
|
|
49268
49384
|
/**
|
|
49269
49385
|
* Textbots service.
|
|
49270
49386
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
49271
|
-
* @version
|
|
49387
|
+
* @version 126.0.0
|
|
49272
49388
|
*/
|
|
49273
49389
|
|
|
49274
49390
|
/**
|
|
@@ -49369,7 +49485,7 @@ class TokensApi {
|
|
|
49369
49485
|
/**
|
|
49370
49486
|
* Tokens service.
|
|
49371
49487
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
49372
|
-
* @version
|
|
49488
|
+
* @version 126.0.0
|
|
49373
49489
|
*/
|
|
49374
49490
|
|
|
49375
49491
|
/**
|
|
@@ -49475,7 +49591,7 @@ class UploadsApi {
|
|
|
49475
49591
|
/**
|
|
49476
49592
|
* Uploads service.
|
|
49477
49593
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
49478
|
-
* @version
|
|
49594
|
+
* @version 126.0.0
|
|
49479
49595
|
*/
|
|
49480
49596
|
|
|
49481
49597
|
/**
|
|
@@ -49651,7 +49767,7 @@ class UsageApi {
|
|
|
49651
49767
|
/**
|
|
49652
49768
|
* Usage service.
|
|
49653
49769
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
49654
|
-
* @version
|
|
49770
|
+
* @version 126.0.0
|
|
49655
49771
|
*/
|
|
49656
49772
|
|
|
49657
49773
|
/**
|
|
@@ -49722,7 +49838,7 @@ class UserRecordingsApi {
|
|
|
49722
49838
|
/**
|
|
49723
49839
|
* UserRecordings service.
|
|
49724
49840
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
49725
|
-
* @version
|
|
49841
|
+
* @version 126.0.0
|
|
49726
49842
|
*/
|
|
49727
49843
|
|
|
49728
49844
|
/**
|
|
@@ -49906,7 +50022,7 @@ class UsersApi {
|
|
|
49906
50022
|
/**
|
|
49907
50023
|
* Users service.
|
|
49908
50024
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49909
|
-
* @version
|
|
50025
|
+
* @version 126.0.0
|
|
49910
50026
|
*/
|
|
49911
50027
|
|
|
49912
50028
|
/**
|
|
@@ -52208,7 +52324,7 @@ class UtilitiesApi {
|
|
|
52208
52324
|
/**
|
|
52209
52325
|
* Utilities service.
|
|
52210
52326
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
52211
|
-
* @version
|
|
52327
|
+
* @version 126.0.0
|
|
52212
52328
|
*/
|
|
52213
52329
|
|
|
52214
52330
|
/**
|
|
@@ -52319,7 +52435,7 @@ class VoicemailApi {
|
|
|
52319
52435
|
/**
|
|
52320
52436
|
* Voicemail service.
|
|
52321
52437
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
52322
|
-
* @version
|
|
52438
|
+
* @version 126.0.0
|
|
52323
52439
|
*/
|
|
52324
52440
|
|
|
52325
52441
|
/**
|
|
@@ -52986,7 +53102,7 @@ class WebChatApi {
|
|
|
52986
53102
|
/**
|
|
52987
53103
|
* WebChat service.
|
|
52988
53104
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
52989
|
-
* @version
|
|
53105
|
+
* @version 126.0.0
|
|
52990
53106
|
*/
|
|
52991
53107
|
|
|
52992
53108
|
/**
|
|
@@ -53530,7 +53646,7 @@ class WebDeploymentsApi {
|
|
|
53530
53646
|
/**
|
|
53531
53647
|
* WebDeployments service.
|
|
53532
53648
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
53533
|
-
* @version
|
|
53649
|
+
* @version 126.0.0
|
|
53534
53650
|
*/
|
|
53535
53651
|
|
|
53536
53652
|
/**
|
|
@@ -53885,7 +54001,7 @@ class WebMessagingApi {
|
|
|
53885
54001
|
/**
|
|
53886
54002
|
* WebMessaging service.
|
|
53887
54003
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
53888
|
-
* @version
|
|
54004
|
+
* @version 126.0.0
|
|
53889
54005
|
*/
|
|
53890
54006
|
|
|
53891
54007
|
/**
|
|
@@ -53931,7 +54047,7 @@ class WidgetsApi {
|
|
|
53931
54047
|
/**
|
|
53932
54048
|
* Widgets service.
|
|
53933
54049
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
53934
|
-
* @version
|
|
54050
|
+
* @version 126.0.0
|
|
53935
54051
|
*/
|
|
53936
54052
|
|
|
53937
54053
|
/**
|
|
@@ -54077,7 +54193,7 @@ class WorkforceManagementApi {
|
|
|
54077
54193
|
/**
|
|
54078
54194
|
* WorkforceManagement service.
|
|
54079
54195
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
54080
|
-
* @version
|
|
54196
|
+
* @version 126.0.0
|
|
54081
54197
|
*/
|
|
54082
54198
|
|
|
54083
54199
|
/**
|
|
@@ -54352,6 +54468,66 @@ class WorkforceManagementApi {
|
|
|
54352
54468
|
);
|
|
54353
54469
|
}
|
|
54354
54470
|
|
|
54471
|
+
/**
|
|
54472
|
+
* Deletes a time off limit object
|
|
54473
|
+
*
|
|
54474
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
54475
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
54476
|
+
*/
|
|
54477
|
+
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
54478
|
+
// verify the required parameter 'managementUnitId' is set
|
|
54479
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
54480
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
54481
|
+
}
|
|
54482
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
54483
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
54484
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
54485
|
+
}
|
|
54486
|
+
|
|
54487
|
+
return this.apiClient.callApi(
|
|
54488
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
54489
|
+
'DELETE',
|
|
54490
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
54491
|
+
{ },
|
|
54492
|
+
{ },
|
|
54493
|
+
{ },
|
|
54494
|
+
null,
|
|
54495
|
+
['PureCloud OAuth'],
|
|
54496
|
+
['application/json'],
|
|
54497
|
+
['application/json']
|
|
54498
|
+
);
|
|
54499
|
+
}
|
|
54500
|
+
|
|
54501
|
+
/**
|
|
54502
|
+
* Deletes a time off plan
|
|
54503
|
+
*
|
|
54504
|
+
* @param {String} managementUnitId The management unit ID.
|
|
54505
|
+
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
54506
|
+
*/
|
|
54507
|
+
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
54508
|
+
// verify the required parameter 'managementUnitId' is set
|
|
54509
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
54510
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
54511
|
+
}
|
|
54512
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
54513
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
54514
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
54515
|
+
}
|
|
54516
|
+
|
|
54517
|
+
return this.apiClient.callApi(
|
|
54518
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
54519
|
+
'DELETE',
|
|
54520
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
54521
|
+
{ },
|
|
54522
|
+
{ },
|
|
54523
|
+
{ },
|
|
54524
|
+
null,
|
|
54525
|
+
['PureCloud OAuth'],
|
|
54526
|
+
['application/json'],
|
|
54527
|
+
['application/json']
|
|
54528
|
+
);
|
|
54529
|
+
}
|
|
54530
|
+
|
|
54355
54531
|
/**
|
|
54356
54532
|
* Delete a work plan
|
|
54357
54533
|
*
|
|
@@ -55593,6 +55769,116 @@ class WorkforceManagementApi {
|
|
|
55593
55769
|
);
|
|
55594
55770
|
}
|
|
55595
55771
|
|
|
55772
|
+
/**
|
|
55773
|
+
* Gets a time off limit object
|
|
55774
|
+
* Returns properties of time off limit object, but not daily values.
|
|
55775
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
55776
|
+
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
55777
|
+
*/
|
|
55778
|
+
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
55779
|
+
// verify the required parameter 'managementUnitId' is set
|
|
55780
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
55781
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
55782
|
+
}
|
|
55783
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
55784
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
55785
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
55786
|
+
}
|
|
55787
|
+
|
|
55788
|
+
return this.apiClient.callApi(
|
|
55789
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
55790
|
+
'GET',
|
|
55791
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
55792
|
+
{ },
|
|
55793
|
+
{ },
|
|
55794
|
+
{ },
|
|
55795
|
+
null,
|
|
55796
|
+
['PureCloud OAuth'],
|
|
55797
|
+
['application/json'],
|
|
55798
|
+
['application/json']
|
|
55799
|
+
);
|
|
55800
|
+
}
|
|
55801
|
+
|
|
55802
|
+
/**
|
|
55803
|
+
* Gets a list of time off limit objects under management unit.
|
|
55804
|
+
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
55805
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
55806
|
+
*/
|
|
55807
|
+
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
55808
|
+
// verify the required parameter 'managementUnitId' is set
|
|
55809
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
55810
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';
|
|
55811
|
+
}
|
|
55812
|
+
|
|
55813
|
+
return this.apiClient.callApi(
|
|
55814
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
55815
|
+
'GET',
|
|
55816
|
+
{ 'managementUnitId': managementUnitId },
|
|
55817
|
+
{ },
|
|
55818
|
+
{ },
|
|
55819
|
+
{ },
|
|
55820
|
+
null,
|
|
55821
|
+
['PureCloud OAuth'],
|
|
55822
|
+
['application/json'],
|
|
55823
|
+
['application/json']
|
|
55824
|
+
);
|
|
55825
|
+
}
|
|
55826
|
+
|
|
55827
|
+
/**
|
|
55828
|
+
* Gets a time off plan
|
|
55829
|
+
*
|
|
55830
|
+
* @param {String} managementUnitId The management unit ID.
|
|
55831
|
+
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
55832
|
+
*/
|
|
55833
|
+
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
55834
|
+
// verify the required parameter 'managementUnitId' is set
|
|
55835
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
55836
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
55837
|
+
}
|
|
55838
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
55839
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
55840
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
55841
|
+
}
|
|
55842
|
+
|
|
55843
|
+
return this.apiClient.callApi(
|
|
55844
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
55845
|
+
'GET',
|
|
55846
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
55847
|
+
{ },
|
|
55848
|
+
{ },
|
|
55849
|
+
{ },
|
|
55850
|
+
null,
|
|
55851
|
+
['PureCloud OAuth'],
|
|
55852
|
+
['application/json'],
|
|
55853
|
+
['application/json']
|
|
55854
|
+
);
|
|
55855
|
+
}
|
|
55856
|
+
|
|
55857
|
+
/**
|
|
55858
|
+
* Gets a list of time off plans
|
|
55859
|
+
*
|
|
55860
|
+
* @param {String} managementUnitId The management unit ID.
|
|
55861
|
+
*/
|
|
55862
|
+
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
55863
|
+
// verify the required parameter 'managementUnitId' is set
|
|
55864
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
55865
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';
|
|
55866
|
+
}
|
|
55867
|
+
|
|
55868
|
+
return this.apiClient.callApi(
|
|
55869
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
55870
|
+
'GET',
|
|
55871
|
+
{ 'managementUnitId': managementUnitId },
|
|
55872
|
+
{ },
|
|
55873
|
+
{ },
|
|
55874
|
+
{ },
|
|
55875
|
+
null,
|
|
55876
|
+
['PureCloud OAuth'],
|
|
55877
|
+
['application/json'],
|
|
55878
|
+
['application/json']
|
|
55879
|
+
);
|
|
55880
|
+
}
|
|
55881
|
+
|
|
55596
55882
|
/**
|
|
55597
55883
|
* Get a time off request
|
|
55598
55884
|
*
|
|
@@ -55628,6 +55914,41 @@ class WorkforceManagementApi {
|
|
|
55628
55914
|
);
|
|
55629
55915
|
}
|
|
55630
55916
|
|
|
55917
|
+
/**
|
|
55918
|
+
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
55919
|
+
*
|
|
55920
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
55921
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
55922
|
+
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
55923
|
+
*/
|
|
55924
|
+
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId) {
|
|
55925
|
+
// verify the required parameter 'managementUnitId' is set
|
|
55926
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
55927
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
55928
|
+
}
|
|
55929
|
+
// verify the required parameter 'userId' is set
|
|
55930
|
+
if (userId === undefined || userId === null) {
|
|
55931
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
55932
|
+
}
|
|
55933
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
55934
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
55935
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
55936
|
+
}
|
|
55937
|
+
|
|
55938
|
+
return this.apiClient.callApi(
|
|
55939
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits',
|
|
55940
|
+
'GET',
|
|
55941
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
55942
|
+
{ },
|
|
55943
|
+
{ },
|
|
55944
|
+
{ },
|
|
55945
|
+
null,
|
|
55946
|
+
['PureCloud OAuth'],
|
|
55947
|
+
['application/json'],
|
|
55948
|
+
['application/json']
|
|
55949
|
+
);
|
|
55950
|
+
}
|
|
55951
|
+
|
|
55631
55952
|
/**
|
|
55632
55953
|
* Get a list of time off requests for a given user
|
|
55633
55954
|
*
|
|
@@ -56061,6 +56382,31 @@ class WorkforceManagementApi {
|
|
|
56061
56382
|
);
|
|
56062
56383
|
}
|
|
56063
56384
|
|
|
56385
|
+
/**
|
|
56386
|
+
* Get the daily waitlist positions of a time off request for the current user
|
|
56387
|
+
*
|
|
56388
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
56389
|
+
*/
|
|
56390
|
+
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
56391
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
56392
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
56393
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';
|
|
56394
|
+
}
|
|
56395
|
+
|
|
56396
|
+
return this.apiClient.callApi(
|
|
56397
|
+
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions',
|
|
56398
|
+
'GET',
|
|
56399
|
+
{ 'timeOffRequestId': timeOffRequestId },
|
|
56400
|
+
{ },
|
|
56401
|
+
{ },
|
|
56402
|
+
{ },
|
|
56403
|
+
null,
|
|
56404
|
+
['PureCloud OAuth'],
|
|
56405
|
+
['application/json'],
|
|
56406
|
+
['application/json']
|
|
56407
|
+
);
|
|
56408
|
+
}
|
|
56409
|
+
|
|
56064
56410
|
/**
|
|
56065
56411
|
* Get a list of time off requests for the current user
|
|
56066
56412
|
*
|
|
@@ -56279,6 +56625,74 @@ class WorkforceManagementApi {
|
|
|
56279
56625
|
);
|
|
56280
56626
|
}
|
|
56281
56627
|
|
|
56628
|
+
/**
|
|
56629
|
+
* Updates a time off limit object.
|
|
56630
|
+
* Updates time off limit object properties, but not daily values.
|
|
56631
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
56632
|
+
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
56633
|
+
* @param {Object} opts Optional parameters
|
|
56634
|
+
* @param {Object} opts.body body
|
|
56635
|
+
*/
|
|
56636
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, opts) {
|
|
56637
|
+
opts = opts || {};
|
|
56638
|
+
|
|
56639
|
+
// verify the required parameter 'managementUnitId' is set
|
|
56640
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
56641
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
56642
|
+
}
|
|
56643
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
56644
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
56645
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
56646
|
+
}
|
|
56647
|
+
|
|
56648
|
+
return this.apiClient.callApi(
|
|
56649
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
56650
|
+
'PATCH',
|
|
56651
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
56652
|
+
{ },
|
|
56653
|
+
{ },
|
|
56654
|
+
{ },
|
|
56655
|
+
opts['body'],
|
|
56656
|
+
['PureCloud OAuth'],
|
|
56657
|
+
['application/json'],
|
|
56658
|
+
['application/json']
|
|
56659
|
+
);
|
|
56660
|
+
}
|
|
56661
|
+
|
|
56662
|
+
/**
|
|
56663
|
+
* Updates a time off plan
|
|
56664
|
+
*
|
|
56665
|
+
* @param {String} managementUnitId The management unit ID.
|
|
56666
|
+
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
56667
|
+
* @param {Object} opts Optional parameters
|
|
56668
|
+
* @param {Object} opts.body body
|
|
56669
|
+
*/
|
|
56670
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, opts) {
|
|
56671
|
+
opts = opts || {};
|
|
56672
|
+
|
|
56673
|
+
// verify the required parameter 'managementUnitId' is set
|
|
56674
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
56675
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
56676
|
+
}
|
|
56677
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
56678
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
56679
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
56680
|
+
}
|
|
56681
|
+
|
|
56682
|
+
return this.apiClient.callApi(
|
|
56683
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
56684
|
+
'PATCH',
|
|
56685
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
56686
|
+
{ },
|
|
56687
|
+
{ },
|
|
56688
|
+
{ },
|
|
56689
|
+
opts['body'],
|
|
56690
|
+
['PureCloud OAuth'],
|
|
56691
|
+
['application/json'],
|
|
56692
|
+
['application/json']
|
|
56693
|
+
);
|
|
56694
|
+
}
|
|
56695
|
+
|
|
56282
56696
|
/**
|
|
56283
56697
|
* Update a time off request
|
|
56284
56698
|
*
|
|
@@ -57140,6 +57554,93 @@ class WorkforceManagementApi {
|
|
|
57140
57554
|
);
|
|
57141
57555
|
}
|
|
57142
57556
|
|
|
57557
|
+
/**
|
|
57558
|
+
* Creates a new time off limit object under management unit.
|
|
57559
|
+
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
57560
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
57561
|
+
* @param {Object} opts Optional parameters
|
|
57562
|
+
* @param {Object} opts.body body
|
|
57563
|
+
*/
|
|
57564
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, opts) {
|
|
57565
|
+
opts = opts || {};
|
|
57566
|
+
|
|
57567
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57568
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57569
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
57570
|
+
}
|
|
57571
|
+
|
|
57572
|
+
return this.apiClient.callApi(
|
|
57573
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
57574
|
+
'POST',
|
|
57575
|
+
{ 'managementUnitId': managementUnitId },
|
|
57576
|
+
{ },
|
|
57577
|
+
{ },
|
|
57578
|
+
{ },
|
|
57579
|
+
opts['body'],
|
|
57580
|
+
['PureCloud OAuth'],
|
|
57581
|
+
['application/json'],
|
|
57582
|
+
['application/json']
|
|
57583
|
+
);
|
|
57584
|
+
}
|
|
57585
|
+
|
|
57586
|
+
/**
|
|
57587
|
+
* Retrieves time off limit related values based on a given set of filters.
|
|
57588
|
+
*
|
|
57589
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
57590
|
+
* @param {Object} opts Optional parameters
|
|
57591
|
+
* @param {Object} opts.body body
|
|
57592
|
+
*/
|
|
57593
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, opts) {
|
|
57594
|
+
opts = opts || {};
|
|
57595
|
+
|
|
57596
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57597
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57598
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
57599
|
+
}
|
|
57600
|
+
|
|
57601
|
+
return this.apiClient.callApi(
|
|
57602
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
57603
|
+
'POST',
|
|
57604
|
+
{ 'managementUnitId': managementUnitId },
|
|
57605
|
+
{ },
|
|
57606
|
+
{ },
|
|
57607
|
+
{ },
|
|
57608
|
+
opts['body'],
|
|
57609
|
+
['PureCloud OAuth'],
|
|
57610
|
+
['application/json'],
|
|
57611
|
+
['application/json']
|
|
57612
|
+
);
|
|
57613
|
+
}
|
|
57614
|
+
|
|
57615
|
+
/**
|
|
57616
|
+
* Creates a new time off plan
|
|
57617
|
+
*
|
|
57618
|
+
* @param {String} managementUnitId The management unit ID.
|
|
57619
|
+
* @param {Object} opts Optional parameters
|
|
57620
|
+
* @param {Object} opts.body body
|
|
57621
|
+
*/
|
|
57622
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, opts) {
|
|
57623
|
+
opts = opts || {};
|
|
57624
|
+
|
|
57625
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57626
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57627
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
57628
|
+
}
|
|
57629
|
+
|
|
57630
|
+
return this.apiClient.callApi(
|
|
57631
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
57632
|
+
'POST',
|
|
57633
|
+
{ 'managementUnitId': managementUnitId },
|
|
57634
|
+
{ },
|
|
57635
|
+
{ },
|
|
57636
|
+
{ },
|
|
57637
|
+
opts['body'],
|
|
57638
|
+
['PureCloud OAuth'],
|
|
57639
|
+
['application/json'],
|
|
57640
|
+
['application/json']
|
|
57641
|
+
);
|
|
57642
|
+
}
|
|
57643
|
+
|
|
57143
57644
|
/**
|
|
57144
57645
|
* Create a new time off request
|
|
57145
57646
|
*
|
|
@@ -57198,6 +57699,35 @@ class WorkforceManagementApi {
|
|
|
57198
57699
|
);
|
|
57199
57700
|
}
|
|
57200
57701
|
|
|
57702
|
+
/**
|
|
57703
|
+
* Retrieves daily waitlist position for a list of time off requests
|
|
57704
|
+
*
|
|
57705
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
57706
|
+
* @param {Object} opts Optional parameters
|
|
57707
|
+
* @param {Object} opts.body body
|
|
57708
|
+
*/
|
|
57709
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, opts) {
|
|
57710
|
+
opts = opts || {};
|
|
57711
|
+
|
|
57712
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57713
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57714
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
57715
|
+
}
|
|
57716
|
+
|
|
57717
|
+
return this.apiClient.callApi(
|
|
57718
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
57719
|
+
'POST',
|
|
57720
|
+
{ 'managementUnitId': managementUnitId },
|
|
57721
|
+
{ },
|
|
57722
|
+
{ },
|
|
57723
|
+
{ },
|
|
57724
|
+
opts['body'],
|
|
57725
|
+
['PureCloud OAuth'],
|
|
57726
|
+
['application/json'],
|
|
57727
|
+
['application/json']
|
|
57728
|
+
);
|
|
57729
|
+
}
|
|
57730
|
+
|
|
57201
57731
|
/**
|
|
57202
57732
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
57203
57733
|
*
|
|
@@ -57581,6 +58111,30 @@ class WorkforceManagementApi {
|
|
|
57581
58111
|
);
|
|
57582
58112
|
}
|
|
57583
58113
|
|
|
58114
|
+
/**
|
|
58115
|
+
* Queries available time off for the current user
|
|
58116
|
+
*
|
|
58117
|
+
* @param {Object} opts Optional parameters
|
|
58118
|
+
* @param {Object} opts.body body
|
|
58119
|
+
*/
|
|
58120
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(opts) {
|
|
58121
|
+
opts = opts || {};
|
|
58122
|
+
|
|
58123
|
+
|
|
58124
|
+
return this.apiClient.callApi(
|
|
58125
|
+
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
58126
|
+
'POST',
|
|
58127
|
+
{ },
|
|
58128
|
+
{ },
|
|
58129
|
+
{ },
|
|
58130
|
+
{ },
|
|
58131
|
+
opts['body'],
|
|
58132
|
+
['PureCloud OAuth'],
|
|
58133
|
+
['application/json'],
|
|
58134
|
+
['application/json']
|
|
58135
|
+
);
|
|
58136
|
+
}
|
|
58137
|
+
|
|
57584
58138
|
/**
|
|
57585
58139
|
* Create a time off request for the current user
|
|
57586
58140
|
*
|
|
@@ -57605,6 +58159,40 @@ class WorkforceManagementApi {
|
|
|
57605
58159
|
);
|
|
57606
58160
|
}
|
|
57607
58161
|
|
|
58162
|
+
/**
|
|
58163
|
+
* Sets daily values for a date range of time off limit object
|
|
58164
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
58165
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
58166
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
58167
|
+
* @param {Object} opts Optional parameters
|
|
58168
|
+
* @param {Object} opts.body body
|
|
58169
|
+
*/
|
|
58170
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, opts) {
|
|
58171
|
+
opts = opts || {};
|
|
58172
|
+
|
|
58173
|
+
// verify the required parameter 'managementUnitId' is set
|
|
58174
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
58175
|
+
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
58176
|
+
}
|
|
58177
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
58178
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
58179
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
58180
|
+
}
|
|
58181
|
+
|
|
58182
|
+
return this.apiClient.callApi(
|
|
58183
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
58184
|
+
'PUT',
|
|
58185
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
58186
|
+
{ },
|
|
58187
|
+
{ },
|
|
58188
|
+
{ },
|
|
58189
|
+
opts['body'],
|
|
58190
|
+
['PureCloud OAuth'],
|
|
58191
|
+
['application/json'],
|
|
58192
|
+
['application/json']
|
|
58193
|
+
);
|
|
58194
|
+
}
|
|
58195
|
+
|
|
57608
58196
|
}
|
|
57609
58197
|
|
|
57610
58198
|
/**
|
|
@@ -57636,7 +58224,7 @@ class WorkforceManagementApi {
|
|
|
57636
58224
|
* </pre>
|
|
57637
58225
|
* </p>
|
|
57638
58226
|
* @module purecloud-platform-client-v2/index
|
|
57639
|
-
* @version
|
|
58227
|
+
* @version 126.0.0
|
|
57640
58228
|
*/
|
|
57641
58229
|
class platformClient {
|
|
57642
58230
|
constructor() {
|