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
|
@@ -6873,7 +6873,7 @@ class Configuration {
|
|
|
6873
6873
|
|
|
6874
6874
|
/**
|
|
6875
6875
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6876
|
-
* @version
|
|
6876
|
+
* @version 128.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': '128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.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 128.0.0
|
|
37883
38000
|
*/
|
|
37884
38001
|
|
|
37885
38002
|
/**
|
|
@@ -38475,6 +38592,8 @@ class RecordingApi {
|
|
|
38475
38592
|
* @param {Object} opts Optional parameters
|
|
38476
38593
|
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
38477
38594
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38595
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
38596
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
38478
38597
|
*/
|
|
38479
38598
|
getRecordingJobFailedrecordings(jobId, opts) {
|
|
38480
38599
|
opts = opts || {};
|
|
@@ -38488,7 +38607,7 @@ class RecordingApi {
|
|
|
38488
38607
|
'/api/v2/recording/jobs/{jobId}/failedrecordings',
|
|
38489
38608
|
'GET',
|
|
38490
38609
|
{ 'jobId': jobId },
|
|
38491
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
38610
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
38492
38611
|
{ },
|
|
38493
38612
|
{ },
|
|
38494
38613
|
null,
|
|
@@ -38508,6 +38627,8 @@ class RecordingApi {
|
|
|
38508
38627
|
* @param {Object} opts.state Filter by state
|
|
38509
38628
|
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
38510
38629
|
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
38630
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
38631
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
38511
38632
|
*/
|
|
38512
38633
|
getRecordingJobs(opts) {
|
|
38513
38634
|
opts = opts || {};
|
|
@@ -38517,7 +38638,7 @@ class RecordingApi {
|
|
|
38517
38638
|
'/api/v2/recording/jobs',
|
|
38518
38639
|
'GET',
|
|
38519
38640
|
{ },
|
|
38520
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'] },
|
|
38641
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
38521
38642
|
{ },
|
|
38522
38643
|
{ },
|
|
38523
38644
|
null,
|
|
@@ -39398,7 +39519,7 @@ class ResponseManagementApi {
|
|
|
39398
39519
|
/**
|
|
39399
39520
|
* ResponseManagement service.
|
|
39400
39521
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
39401
|
-
* @version
|
|
39522
|
+
* @version 128.0.0
|
|
39402
39523
|
*/
|
|
39403
39524
|
|
|
39404
39525
|
/**
|
|
@@ -39723,7 +39844,7 @@ class RoutingApi {
|
|
|
39723
39844
|
/**
|
|
39724
39845
|
* Routing service.
|
|
39725
39846
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
39726
|
-
* @version
|
|
39847
|
+
* @version 128.0.0
|
|
39727
39848
|
*/
|
|
39728
39849
|
|
|
39729
39850
|
/**
|
|
@@ -40879,12 +41000,11 @@ class RoutingApi {
|
|
|
40879
41000
|
}
|
|
40880
41001
|
|
|
40881
41002
|
/**
|
|
40882
|
-
* Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
|
|
41003
|
+
* 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
41004
|
*
|
|
40884
41005
|
* @param {Object} opts Optional parameters
|
|
40885
41006
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
40886
41007
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40887
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
40888
41008
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
40889
41009
|
*/
|
|
40890
41010
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -40895,7 +41015,7 @@ class RoutingApi {
|
|
|
40895
41015
|
'/api/v2/routing/queues/divisionviews/all',
|
|
40896
41016
|
'GET',
|
|
40897
41017
|
{ },
|
|
40898
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
41018
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
40899
41019
|
{ },
|
|
40900
41020
|
{ },
|
|
40901
41021
|
null,
|
|
@@ -42643,7 +42763,7 @@ class SCIMApi {
|
|
|
42643
42763
|
/**
|
|
42644
42764
|
* SCIM service.
|
|
42645
42765
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
42646
|
-
* @version
|
|
42766
|
+
* @version 128.0.0
|
|
42647
42767
|
*/
|
|
42648
42768
|
|
|
42649
42769
|
/**
|
|
@@ -43520,7 +43640,7 @@ class ScriptsApi {
|
|
|
43520
43640
|
/**
|
|
43521
43641
|
* Scripts service.
|
|
43522
43642
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
43523
|
-
* @version
|
|
43643
|
+
* @version 128.0.0
|
|
43524
43644
|
*/
|
|
43525
43645
|
|
|
43526
43646
|
/**
|
|
@@ -43873,7 +43993,7 @@ class SearchApi {
|
|
|
43873
43993
|
/**
|
|
43874
43994
|
* Search service.
|
|
43875
43995
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
43876
|
-
* @version
|
|
43996
|
+
* @version 128.0.0
|
|
43877
43997
|
*/
|
|
43878
43998
|
|
|
43879
43999
|
/**
|
|
@@ -44408,7 +44528,7 @@ class SpeechTextAnalyticsApi {
|
|
|
44408
44528
|
/**
|
|
44409
44529
|
* SpeechTextAnalytics service.
|
|
44410
44530
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
44411
|
-
* @version
|
|
44531
|
+
* @version 128.0.0
|
|
44412
44532
|
*/
|
|
44413
44533
|
|
|
44414
44534
|
/**
|
|
@@ -44579,7 +44699,7 @@ class SpeechTextAnalyticsApi {
|
|
|
44579
44699
|
|
|
44580
44700
|
/**
|
|
44581
44701
|
* Get list of supported Speech & Text Analytics dialects
|
|
44582
|
-
*
|
|
44702
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
44583
44703
|
*/
|
|
44584
44704
|
getSpeechandtextanalyticsDialects() {
|
|
44585
44705
|
|
|
@@ -44772,6 +44892,26 @@ class SpeechTextAnalyticsApi {
|
|
|
44772
44892
|
);
|
|
44773
44893
|
}
|
|
44774
44894
|
|
|
44895
|
+
/**
|
|
44896
|
+
* Get the list of Speech & Text Analytics sentiment supported dialects
|
|
44897
|
+
*
|
|
44898
|
+
*/
|
|
44899
|
+
getSpeechandtextanalyticsSentimentDialects() {
|
|
44900
|
+
|
|
44901
|
+
return this.apiClient.callApi(
|
|
44902
|
+
'/api/v2/speechandtextanalytics/sentiment/dialects',
|
|
44903
|
+
'GET',
|
|
44904
|
+
{ },
|
|
44905
|
+
{ },
|
|
44906
|
+
{ },
|
|
44907
|
+
{ },
|
|
44908
|
+
null,
|
|
44909
|
+
['PureCloud OAuth'],
|
|
44910
|
+
['application/json'],
|
|
44911
|
+
['application/json']
|
|
44912
|
+
);
|
|
44913
|
+
}
|
|
44914
|
+
|
|
44775
44915
|
/**
|
|
44776
44916
|
* Get the list of Speech & Text Analytics SentimentFeedback
|
|
44777
44917
|
*
|
|
@@ -45261,7 +45401,7 @@ class StationsApi {
|
|
|
45261
45401
|
/**
|
|
45262
45402
|
* Stations service.
|
|
45263
45403
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
45264
|
-
* @version
|
|
45404
|
+
* @version 128.0.0
|
|
45265
45405
|
*/
|
|
45266
45406
|
|
|
45267
45407
|
/**
|
|
@@ -45408,7 +45548,7 @@ class SuggestApi {
|
|
|
45408
45548
|
/**
|
|
45409
45549
|
* Suggest service.
|
|
45410
45550
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
45411
|
-
* @version
|
|
45551
|
+
* @version 128.0.0
|
|
45412
45552
|
*/
|
|
45413
45553
|
|
|
45414
45554
|
/**
|
|
@@ -45547,7 +45687,7 @@ class TelephonyApi {
|
|
|
45547
45687
|
/**
|
|
45548
45688
|
* Telephony service.
|
|
45549
45689
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
45550
|
-
* @version
|
|
45690
|
+
* @version 128.0.0
|
|
45551
45691
|
*/
|
|
45552
45692
|
|
|
45553
45693
|
/**
|
|
@@ -45655,7 +45795,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
45655
45795
|
/**
|
|
45656
45796
|
* TelephonyProvidersEdge service.
|
|
45657
45797
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
45658
|
-
* @version
|
|
45798
|
+
* @version 128.0.0
|
|
45659
45799
|
*/
|
|
45660
45800
|
|
|
45661
45801
|
/**
|
|
@@ -49268,7 +49408,7 @@ class TextbotsApi {
|
|
|
49268
49408
|
/**
|
|
49269
49409
|
* Textbots service.
|
|
49270
49410
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
49271
|
-
* @version
|
|
49411
|
+
* @version 128.0.0
|
|
49272
49412
|
*/
|
|
49273
49413
|
|
|
49274
49414
|
/**
|
|
@@ -49283,6 +49423,33 @@ class TextbotsApi {
|
|
|
49283
49423
|
}
|
|
49284
49424
|
|
|
49285
49425
|
|
|
49426
|
+
/**
|
|
49427
|
+
* Find bots using the currently configured friendly name or ID.
|
|
49428
|
+
* 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
|
|
49429
|
+
* @param {Object} opts Optional parameters
|
|
49430
|
+
* @param {Array.<String>} opts.botType Bot types
|
|
49431
|
+
* @param {String} opts.botName Bot name
|
|
49432
|
+
* @param {Array.<String>} opts.botId Bot IDs
|
|
49433
|
+
* @param {Number} opts.pageSize The maximum results to return (default to 25)
|
|
49434
|
+
*/
|
|
49435
|
+
getTextbotsBotsSearch(opts) {
|
|
49436
|
+
opts = opts || {};
|
|
49437
|
+
|
|
49438
|
+
|
|
49439
|
+
return this.apiClient.callApi(
|
|
49440
|
+
'/api/v2/textbots/bots/search',
|
|
49441
|
+
'GET',
|
|
49442
|
+
{ },
|
|
49443
|
+
{ 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'pageSize': opts['pageSize'] },
|
|
49444
|
+
{ },
|
|
49445
|
+
{ },
|
|
49446
|
+
null,
|
|
49447
|
+
['PureCloud OAuth'],
|
|
49448
|
+
['application/json'],
|
|
49449
|
+
['application/json']
|
|
49450
|
+
);
|
|
49451
|
+
}
|
|
49452
|
+
|
|
49286
49453
|
/**
|
|
49287
49454
|
* Issue a bot flow turn event
|
|
49288
49455
|
* Send a turn event to an executing bot flow and produce the next action to take.
|
|
@@ -49369,7 +49536,7 @@ class TokensApi {
|
|
|
49369
49536
|
/**
|
|
49370
49537
|
* Tokens service.
|
|
49371
49538
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
49372
|
-
* @version
|
|
49539
|
+
* @version 128.0.0
|
|
49373
49540
|
*/
|
|
49374
49541
|
|
|
49375
49542
|
/**
|
|
@@ -49475,7 +49642,7 @@ class UploadsApi {
|
|
|
49475
49642
|
/**
|
|
49476
49643
|
* Uploads service.
|
|
49477
49644
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
49478
|
-
* @version
|
|
49645
|
+
* @version 128.0.0
|
|
49479
49646
|
*/
|
|
49480
49647
|
|
|
49481
49648
|
/**
|
|
@@ -49651,7 +49818,7 @@ class UsageApi {
|
|
|
49651
49818
|
/**
|
|
49652
49819
|
* Usage service.
|
|
49653
49820
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
49654
|
-
* @version
|
|
49821
|
+
* @version 128.0.0
|
|
49655
49822
|
*/
|
|
49656
49823
|
|
|
49657
49824
|
/**
|
|
@@ -49722,7 +49889,7 @@ class UserRecordingsApi {
|
|
|
49722
49889
|
/**
|
|
49723
49890
|
* UserRecordings service.
|
|
49724
49891
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
49725
|
-
* @version
|
|
49892
|
+
* @version 128.0.0
|
|
49726
49893
|
*/
|
|
49727
49894
|
|
|
49728
49895
|
/**
|
|
@@ -49906,7 +50073,7 @@ class UsersApi {
|
|
|
49906
50073
|
/**
|
|
49907
50074
|
* Users service.
|
|
49908
50075
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49909
|
-
* @version
|
|
50076
|
+
* @version 128.0.0
|
|
49910
50077
|
*/
|
|
49911
50078
|
|
|
49912
50079
|
/**
|
|
@@ -52208,7 +52375,7 @@ class UtilitiesApi {
|
|
|
52208
52375
|
/**
|
|
52209
52376
|
* Utilities service.
|
|
52210
52377
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
52211
|
-
* @version
|
|
52378
|
+
* @version 128.0.0
|
|
52212
52379
|
*/
|
|
52213
52380
|
|
|
52214
52381
|
/**
|
|
@@ -52319,7 +52486,7 @@ class VoicemailApi {
|
|
|
52319
52486
|
/**
|
|
52320
52487
|
* Voicemail service.
|
|
52321
52488
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
52322
|
-
* @version
|
|
52489
|
+
* @version 128.0.0
|
|
52323
52490
|
*/
|
|
52324
52491
|
|
|
52325
52492
|
/**
|
|
@@ -52986,7 +53153,7 @@ class WebChatApi {
|
|
|
52986
53153
|
/**
|
|
52987
53154
|
* WebChat service.
|
|
52988
53155
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
52989
|
-
* @version
|
|
53156
|
+
* @version 128.0.0
|
|
52990
53157
|
*/
|
|
52991
53158
|
|
|
52992
53159
|
/**
|
|
@@ -53530,7 +53697,7 @@ class WebDeploymentsApi {
|
|
|
53530
53697
|
/**
|
|
53531
53698
|
* WebDeployments service.
|
|
53532
53699
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
53533
|
-
* @version
|
|
53700
|
+
* @version 128.0.0
|
|
53534
53701
|
*/
|
|
53535
53702
|
|
|
53536
53703
|
/**
|
|
@@ -53885,7 +54052,7 @@ class WebMessagingApi {
|
|
|
53885
54052
|
/**
|
|
53886
54053
|
* WebMessaging service.
|
|
53887
54054
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
53888
|
-
* @version
|
|
54055
|
+
* @version 128.0.0
|
|
53889
54056
|
*/
|
|
53890
54057
|
|
|
53891
54058
|
/**
|
|
@@ -53931,7 +54098,7 @@ class WidgetsApi {
|
|
|
53931
54098
|
/**
|
|
53932
54099
|
* Widgets service.
|
|
53933
54100
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
53934
|
-
* @version
|
|
54101
|
+
* @version 128.0.0
|
|
53935
54102
|
*/
|
|
53936
54103
|
|
|
53937
54104
|
/**
|
|
@@ -54077,7 +54244,7 @@ class WorkforceManagementApi {
|
|
|
54077
54244
|
/**
|
|
54078
54245
|
* WorkforceManagement service.
|
|
54079
54246
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
54080
|
-
* @version
|
|
54247
|
+
* @version 128.0.0
|
|
54081
54248
|
*/
|
|
54082
54249
|
|
|
54083
54250
|
/**
|
|
@@ -54352,6 +54519,66 @@ class WorkforceManagementApi {
|
|
|
54352
54519
|
);
|
|
54353
54520
|
}
|
|
54354
54521
|
|
|
54522
|
+
/**
|
|
54523
|
+
* Deletes a time off limit object
|
|
54524
|
+
*
|
|
54525
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
54526
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
54527
|
+
*/
|
|
54528
|
+
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
54529
|
+
// verify the required parameter 'managementUnitId' is set
|
|
54530
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
54531
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
54532
|
+
}
|
|
54533
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
54534
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
54535
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
54536
|
+
}
|
|
54537
|
+
|
|
54538
|
+
return this.apiClient.callApi(
|
|
54539
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
54540
|
+
'DELETE',
|
|
54541
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
54542
|
+
{ },
|
|
54543
|
+
{ },
|
|
54544
|
+
{ },
|
|
54545
|
+
null,
|
|
54546
|
+
['PureCloud OAuth'],
|
|
54547
|
+
['application/json'],
|
|
54548
|
+
['application/json']
|
|
54549
|
+
);
|
|
54550
|
+
}
|
|
54551
|
+
|
|
54552
|
+
/**
|
|
54553
|
+
* Deletes a time off plan
|
|
54554
|
+
*
|
|
54555
|
+
* @param {String} managementUnitId The management unit ID.
|
|
54556
|
+
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
54557
|
+
*/
|
|
54558
|
+
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
54559
|
+
// verify the required parameter 'managementUnitId' is set
|
|
54560
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
54561
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
54562
|
+
}
|
|
54563
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
54564
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
54565
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
54566
|
+
}
|
|
54567
|
+
|
|
54568
|
+
return this.apiClient.callApi(
|
|
54569
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
54570
|
+
'DELETE',
|
|
54571
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
54572
|
+
{ },
|
|
54573
|
+
{ },
|
|
54574
|
+
{ },
|
|
54575
|
+
null,
|
|
54576
|
+
['PureCloud OAuth'],
|
|
54577
|
+
['application/json'],
|
|
54578
|
+
['application/json']
|
|
54579
|
+
);
|
|
54580
|
+
}
|
|
54581
|
+
|
|
54355
54582
|
/**
|
|
54356
54583
|
* Delete a work plan
|
|
54357
54584
|
*
|
|
@@ -55593,6 +55820,116 @@ class WorkforceManagementApi {
|
|
|
55593
55820
|
);
|
|
55594
55821
|
}
|
|
55595
55822
|
|
|
55823
|
+
/**
|
|
55824
|
+
* Gets a time off limit object
|
|
55825
|
+
* Returns properties of time off limit object, but not daily values.
|
|
55826
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
55827
|
+
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
55828
|
+
*/
|
|
55829
|
+
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
55830
|
+
// verify the required parameter 'managementUnitId' is set
|
|
55831
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
55832
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
55833
|
+
}
|
|
55834
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
55835
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
55836
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
55837
|
+
}
|
|
55838
|
+
|
|
55839
|
+
return this.apiClient.callApi(
|
|
55840
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
55841
|
+
'GET',
|
|
55842
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
55843
|
+
{ },
|
|
55844
|
+
{ },
|
|
55845
|
+
{ },
|
|
55846
|
+
null,
|
|
55847
|
+
['PureCloud OAuth'],
|
|
55848
|
+
['application/json'],
|
|
55849
|
+
['application/json']
|
|
55850
|
+
);
|
|
55851
|
+
}
|
|
55852
|
+
|
|
55853
|
+
/**
|
|
55854
|
+
* Gets a list of time off limit objects under management unit.
|
|
55855
|
+
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
55856
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
55857
|
+
*/
|
|
55858
|
+
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
55859
|
+
// verify the required parameter 'managementUnitId' is set
|
|
55860
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
55861
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';
|
|
55862
|
+
}
|
|
55863
|
+
|
|
55864
|
+
return this.apiClient.callApi(
|
|
55865
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
55866
|
+
'GET',
|
|
55867
|
+
{ 'managementUnitId': managementUnitId },
|
|
55868
|
+
{ },
|
|
55869
|
+
{ },
|
|
55870
|
+
{ },
|
|
55871
|
+
null,
|
|
55872
|
+
['PureCloud OAuth'],
|
|
55873
|
+
['application/json'],
|
|
55874
|
+
['application/json']
|
|
55875
|
+
);
|
|
55876
|
+
}
|
|
55877
|
+
|
|
55878
|
+
/**
|
|
55879
|
+
* Gets a time off plan
|
|
55880
|
+
*
|
|
55881
|
+
* @param {String} managementUnitId The management unit ID.
|
|
55882
|
+
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
55883
|
+
*/
|
|
55884
|
+
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
55885
|
+
// verify the required parameter 'managementUnitId' is set
|
|
55886
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
55887
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
55888
|
+
}
|
|
55889
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
55890
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
55891
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
55892
|
+
}
|
|
55893
|
+
|
|
55894
|
+
return this.apiClient.callApi(
|
|
55895
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
55896
|
+
'GET',
|
|
55897
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
55898
|
+
{ },
|
|
55899
|
+
{ },
|
|
55900
|
+
{ },
|
|
55901
|
+
null,
|
|
55902
|
+
['PureCloud OAuth'],
|
|
55903
|
+
['application/json'],
|
|
55904
|
+
['application/json']
|
|
55905
|
+
);
|
|
55906
|
+
}
|
|
55907
|
+
|
|
55908
|
+
/**
|
|
55909
|
+
* Gets a list of time off plans
|
|
55910
|
+
*
|
|
55911
|
+
* @param {String} managementUnitId The management unit ID.
|
|
55912
|
+
*/
|
|
55913
|
+
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
55914
|
+
// verify the required parameter 'managementUnitId' is set
|
|
55915
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
55916
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';
|
|
55917
|
+
}
|
|
55918
|
+
|
|
55919
|
+
return this.apiClient.callApi(
|
|
55920
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
55921
|
+
'GET',
|
|
55922
|
+
{ 'managementUnitId': managementUnitId },
|
|
55923
|
+
{ },
|
|
55924
|
+
{ },
|
|
55925
|
+
{ },
|
|
55926
|
+
null,
|
|
55927
|
+
['PureCloud OAuth'],
|
|
55928
|
+
['application/json'],
|
|
55929
|
+
['application/json']
|
|
55930
|
+
);
|
|
55931
|
+
}
|
|
55932
|
+
|
|
55596
55933
|
/**
|
|
55597
55934
|
* Get a time off request
|
|
55598
55935
|
*
|
|
@@ -55628,6 +55965,41 @@ class WorkforceManagementApi {
|
|
|
55628
55965
|
);
|
|
55629
55966
|
}
|
|
55630
55967
|
|
|
55968
|
+
/**
|
|
55969
|
+
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
55970
|
+
*
|
|
55971
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
55972
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
55973
|
+
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
55974
|
+
*/
|
|
55975
|
+
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId) {
|
|
55976
|
+
// verify the required parameter 'managementUnitId' is set
|
|
55977
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
55978
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
55979
|
+
}
|
|
55980
|
+
// verify the required parameter 'userId' is set
|
|
55981
|
+
if (userId === undefined || userId === null) {
|
|
55982
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
55983
|
+
}
|
|
55984
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
55985
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
55986
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
55987
|
+
}
|
|
55988
|
+
|
|
55989
|
+
return this.apiClient.callApi(
|
|
55990
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits',
|
|
55991
|
+
'GET',
|
|
55992
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
55993
|
+
{ },
|
|
55994
|
+
{ },
|
|
55995
|
+
{ },
|
|
55996
|
+
null,
|
|
55997
|
+
['PureCloud OAuth'],
|
|
55998
|
+
['application/json'],
|
|
55999
|
+
['application/json']
|
|
56000
|
+
);
|
|
56001
|
+
}
|
|
56002
|
+
|
|
55631
56003
|
/**
|
|
55632
56004
|
* Get a list of time off requests for a given user
|
|
55633
56005
|
*
|
|
@@ -56061,6 +56433,31 @@ class WorkforceManagementApi {
|
|
|
56061
56433
|
);
|
|
56062
56434
|
}
|
|
56063
56435
|
|
|
56436
|
+
/**
|
|
56437
|
+
* Get the daily waitlist positions of a time off request for the current user
|
|
56438
|
+
*
|
|
56439
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
56440
|
+
*/
|
|
56441
|
+
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
56442
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
56443
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
56444
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';
|
|
56445
|
+
}
|
|
56446
|
+
|
|
56447
|
+
return this.apiClient.callApi(
|
|
56448
|
+
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions',
|
|
56449
|
+
'GET',
|
|
56450
|
+
{ 'timeOffRequestId': timeOffRequestId },
|
|
56451
|
+
{ },
|
|
56452
|
+
{ },
|
|
56453
|
+
{ },
|
|
56454
|
+
null,
|
|
56455
|
+
['PureCloud OAuth'],
|
|
56456
|
+
['application/json'],
|
|
56457
|
+
['application/json']
|
|
56458
|
+
);
|
|
56459
|
+
}
|
|
56460
|
+
|
|
56064
56461
|
/**
|
|
56065
56462
|
* Get a list of time off requests for the current user
|
|
56066
56463
|
*
|
|
@@ -56279,6 +56676,74 @@ class WorkforceManagementApi {
|
|
|
56279
56676
|
);
|
|
56280
56677
|
}
|
|
56281
56678
|
|
|
56679
|
+
/**
|
|
56680
|
+
* Updates a time off limit object.
|
|
56681
|
+
* Updates time off limit object properties, but not daily values.
|
|
56682
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
56683
|
+
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
56684
|
+
* @param {Object} opts Optional parameters
|
|
56685
|
+
* @param {Object} opts.body body
|
|
56686
|
+
*/
|
|
56687
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, opts) {
|
|
56688
|
+
opts = opts || {};
|
|
56689
|
+
|
|
56690
|
+
// verify the required parameter 'managementUnitId' is set
|
|
56691
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
56692
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
56693
|
+
}
|
|
56694
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
56695
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
56696
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
56697
|
+
}
|
|
56698
|
+
|
|
56699
|
+
return this.apiClient.callApi(
|
|
56700
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
56701
|
+
'PATCH',
|
|
56702
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
56703
|
+
{ },
|
|
56704
|
+
{ },
|
|
56705
|
+
{ },
|
|
56706
|
+
opts['body'],
|
|
56707
|
+
['PureCloud OAuth'],
|
|
56708
|
+
['application/json'],
|
|
56709
|
+
['application/json']
|
|
56710
|
+
);
|
|
56711
|
+
}
|
|
56712
|
+
|
|
56713
|
+
/**
|
|
56714
|
+
* Updates a time off plan
|
|
56715
|
+
*
|
|
56716
|
+
* @param {String} managementUnitId The management unit ID.
|
|
56717
|
+
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
56718
|
+
* @param {Object} opts Optional parameters
|
|
56719
|
+
* @param {Object} opts.body body
|
|
56720
|
+
*/
|
|
56721
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, opts) {
|
|
56722
|
+
opts = opts || {};
|
|
56723
|
+
|
|
56724
|
+
// verify the required parameter 'managementUnitId' is set
|
|
56725
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
56726
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
56727
|
+
}
|
|
56728
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
56729
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
56730
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
56731
|
+
}
|
|
56732
|
+
|
|
56733
|
+
return this.apiClient.callApi(
|
|
56734
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
56735
|
+
'PATCH',
|
|
56736
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
56737
|
+
{ },
|
|
56738
|
+
{ },
|
|
56739
|
+
{ },
|
|
56740
|
+
opts['body'],
|
|
56741
|
+
['PureCloud OAuth'],
|
|
56742
|
+
['application/json'],
|
|
56743
|
+
['application/json']
|
|
56744
|
+
);
|
|
56745
|
+
}
|
|
56746
|
+
|
|
56282
56747
|
/**
|
|
56283
56748
|
* Update a time off request
|
|
56284
56749
|
*
|
|
@@ -57140,6 +57605,93 @@ class WorkforceManagementApi {
|
|
|
57140
57605
|
);
|
|
57141
57606
|
}
|
|
57142
57607
|
|
|
57608
|
+
/**
|
|
57609
|
+
* Creates a new time off limit object under management unit.
|
|
57610
|
+
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
57611
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
57612
|
+
* @param {Object} opts Optional parameters
|
|
57613
|
+
* @param {Object} opts.body body
|
|
57614
|
+
*/
|
|
57615
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, opts) {
|
|
57616
|
+
opts = opts || {};
|
|
57617
|
+
|
|
57618
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57619
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57620
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
57621
|
+
}
|
|
57622
|
+
|
|
57623
|
+
return this.apiClient.callApi(
|
|
57624
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
57625
|
+
'POST',
|
|
57626
|
+
{ 'managementUnitId': managementUnitId },
|
|
57627
|
+
{ },
|
|
57628
|
+
{ },
|
|
57629
|
+
{ },
|
|
57630
|
+
opts['body'],
|
|
57631
|
+
['PureCloud OAuth'],
|
|
57632
|
+
['application/json'],
|
|
57633
|
+
['application/json']
|
|
57634
|
+
);
|
|
57635
|
+
}
|
|
57636
|
+
|
|
57637
|
+
/**
|
|
57638
|
+
* Retrieves time off limit related values based on a given set of filters.
|
|
57639
|
+
*
|
|
57640
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
57641
|
+
* @param {Object} opts Optional parameters
|
|
57642
|
+
* @param {Object} opts.body body
|
|
57643
|
+
*/
|
|
57644
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, opts) {
|
|
57645
|
+
opts = opts || {};
|
|
57646
|
+
|
|
57647
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57648
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57649
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
57650
|
+
}
|
|
57651
|
+
|
|
57652
|
+
return this.apiClient.callApi(
|
|
57653
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
57654
|
+
'POST',
|
|
57655
|
+
{ 'managementUnitId': managementUnitId },
|
|
57656
|
+
{ },
|
|
57657
|
+
{ },
|
|
57658
|
+
{ },
|
|
57659
|
+
opts['body'],
|
|
57660
|
+
['PureCloud OAuth'],
|
|
57661
|
+
['application/json'],
|
|
57662
|
+
['application/json']
|
|
57663
|
+
);
|
|
57664
|
+
}
|
|
57665
|
+
|
|
57666
|
+
/**
|
|
57667
|
+
* Creates a new time off plan
|
|
57668
|
+
*
|
|
57669
|
+
* @param {String} managementUnitId The management unit ID.
|
|
57670
|
+
* @param {Object} opts Optional parameters
|
|
57671
|
+
* @param {Object} opts.body body
|
|
57672
|
+
*/
|
|
57673
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, opts) {
|
|
57674
|
+
opts = opts || {};
|
|
57675
|
+
|
|
57676
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57677
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57678
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
57679
|
+
}
|
|
57680
|
+
|
|
57681
|
+
return this.apiClient.callApi(
|
|
57682
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
57683
|
+
'POST',
|
|
57684
|
+
{ 'managementUnitId': managementUnitId },
|
|
57685
|
+
{ },
|
|
57686
|
+
{ },
|
|
57687
|
+
{ },
|
|
57688
|
+
opts['body'],
|
|
57689
|
+
['PureCloud OAuth'],
|
|
57690
|
+
['application/json'],
|
|
57691
|
+
['application/json']
|
|
57692
|
+
);
|
|
57693
|
+
}
|
|
57694
|
+
|
|
57143
57695
|
/**
|
|
57144
57696
|
* Create a new time off request
|
|
57145
57697
|
*
|
|
@@ -57198,6 +57750,35 @@ class WorkforceManagementApi {
|
|
|
57198
57750
|
);
|
|
57199
57751
|
}
|
|
57200
57752
|
|
|
57753
|
+
/**
|
|
57754
|
+
* Retrieves daily waitlist position for a list of time off requests
|
|
57755
|
+
*
|
|
57756
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
57757
|
+
* @param {Object} opts Optional parameters
|
|
57758
|
+
* @param {Object} opts.body body
|
|
57759
|
+
*/
|
|
57760
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, opts) {
|
|
57761
|
+
opts = opts || {};
|
|
57762
|
+
|
|
57763
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57764
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57765
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
57766
|
+
}
|
|
57767
|
+
|
|
57768
|
+
return this.apiClient.callApi(
|
|
57769
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
57770
|
+
'POST',
|
|
57771
|
+
{ 'managementUnitId': managementUnitId },
|
|
57772
|
+
{ },
|
|
57773
|
+
{ },
|
|
57774
|
+
{ },
|
|
57775
|
+
opts['body'],
|
|
57776
|
+
['PureCloud OAuth'],
|
|
57777
|
+
['application/json'],
|
|
57778
|
+
['application/json']
|
|
57779
|
+
);
|
|
57780
|
+
}
|
|
57781
|
+
|
|
57201
57782
|
/**
|
|
57202
57783
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
57203
57784
|
*
|
|
@@ -57581,6 +58162,30 @@ class WorkforceManagementApi {
|
|
|
57581
58162
|
);
|
|
57582
58163
|
}
|
|
57583
58164
|
|
|
58165
|
+
/**
|
|
58166
|
+
* Queries available time off for the current user
|
|
58167
|
+
*
|
|
58168
|
+
* @param {Object} opts Optional parameters
|
|
58169
|
+
* @param {Object} opts.body body
|
|
58170
|
+
*/
|
|
58171
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(opts) {
|
|
58172
|
+
opts = opts || {};
|
|
58173
|
+
|
|
58174
|
+
|
|
58175
|
+
return this.apiClient.callApi(
|
|
58176
|
+
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
58177
|
+
'POST',
|
|
58178
|
+
{ },
|
|
58179
|
+
{ },
|
|
58180
|
+
{ },
|
|
58181
|
+
{ },
|
|
58182
|
+
opts['body'],
|
|
58183
|
+
['PureCloud OAuth'],
|
|
58184
|
+
['application/json'],
|
|
58185
|
+
['application/json']
|
|
58186
|
+
);
|
|
58187
|
+
}
|
|
58188
|
+
|
|
57584
58189
|
/**
|
|
57585
58190
|
* Create a time off request for the current user
|
|
57586
58191
|
*
|
|
@@ -57605,6 +58210,40 @@ class WorkforceManagementApi {
|
|
|
57605
58210
|
);
|
|
57606
58211
|
}
|
|
57607
58212
|
|
|
58213
|
+
/**
|
|
58214
|
+
* Sets daily values for a date range of time off limit object
|
|
58215
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
58216
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
58217
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
58218
|
+
* @param {Object} opts Optional parameters
|
|
58219
|
+
* @param {Object} opts.body body
|
|
58220
|
+
*/
|
|
58221
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, opts) {
|
|
58222
|
+
opts = opts || {};
|
|
58223
|
+
|
|
58224
|
+
// verify the required parameter 'managementUnitId' is set
|
|
58225
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
58226
|
+
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
58227
|
+
}
|
|
58228
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
58229
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
58230
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
58231
|
+
}
|
|
58232
|
+
|
|
58233
|
+
return this.apiClient.callApi(
|
|
58234
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
58235
|
+
'PUT',
|
|
58236
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
58237
|
+
{ },
|
|
58238
|
+
{ },
|
|
58239
|
+
{ },
|
|
58240
|
+
opts['body'],
|
|
58241
|
+
['PureCloud OAuth'],
|
|
58242
|
+
['application/json'],
|
|
58243
|
+
['application/json']
|
|
58244
|
+
);
|
|
58245
|
+
}
|
|
58246
|
+
|
|
57608
58247
|
}
|
|
57609
58248
|
|
|
57610
58249
|
/**
|
|
@@ -57636,7 +58275,7 @@ class WorkforceManagementApi {
|
|
|
57636
58275
|
* </pre>
|
|
57637
58276
|
* </p>
|
|
57638
58277
|
* @module purecloud-platform-client-v2/index
|
|
57639
|
-
* @version
|
|
58278
|
+
* @version 128.0.0
|
|
57640
58279
|
*/
|
|
57641
58280
|
class platformClient {
|
|
57642
58281
|
constructor() {
|