purecloud-platform-client-v2 150.0.0 → 151.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 +351 -73
- package/dist/web-amd/purecloud-platform-client-v2.js +351 -73
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +351 -73
- package/dist/web-cjs/purecloud-platform-client-v2.js +351 -73
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +297 -201
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +36 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +32 -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 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +93 -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 +26 -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 +71 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 151.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1481,7 +1481,7 @@ class AlertingApi {
|
|
|
1481
1481
|
/**
|
|
1482
1482
|
* Alerting service.
|
|
1483
1483
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1484
|
-
* @version
|
|
1484
|
+
* @version 151.0.0
|
|
1485
1485
|
*/
|
|
1486
1486
|
|
|
1487
1487
|
/**
|
|
@@ -1795,7 +1795,7 @@ class AnalyticsApi {
|
|
|
1795
1795
|
/**
|
|
1796
1796
|
* Analytics service.
|
|
1797
1797
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1798
|
-
* @version
|
|
1798
|
+
* @version 151.0.0
|
|
1799
1799
|
*/
|
|
1800
1800
|
|
|
1801
1801
|
/**
|
|
@@ -3022,7 +3022,7 @@ class ArchitectApi {
|
|
|
3022
3022
|
/**
|
|
3023
3023
|
* Architect service.
|
|
3024
3024
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3025
|
-
* @version
|
|
3025
|
+
* @version 151.0.0
|
|
3026
3026
|
*/
|
|
3027
3027
|
|
|
3028
3028
|
/**
|
|
@@ -6068,7 +6068,7 @@ class AuditApi {
|
|
|
6068
6068
|
/**
|
|
6069
6069
|
* Audit service.
|
|
6070
6070
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6071
|
-
* @version
|
|
6071
|
+
* @version 151.0.0
|
|
6072
6072
|
*/
|
|
6073
6073
|
|
|
6074
6074
|
/**
|
|
@@ -6239,7 +6239,7 @@ class AuthorizationApi {
|
|
|
6239
6239
|
/**
|
|
6240
6240
|
* Authorization service.
|
|
6241
6241
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6242
|
-
* @version
|
|
6242
|
+
* @version 151.0.0
|
|
6243
6243
|
*/
|
|
6244
6244
|
|
|
6245
6245
|
/**
|
|
@@ -7422,7 +7422,7 @@ class BillingApi {
|
|
|
7422
7422
|
/**
|
|
7423
7423
|
* Billing service.
|
|
7424
7424
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7425
|
-
* @version
|
|
7425
|
+
* @version 151.0.0
|
|
7426
7426
|
*/
|
|
7427
7427
|
|
|
7428
7428
|
/**
|
|
@@ -7502,7 +7502,7 @@ class ChatApi {
|
|
|
7502
7502
|
/**
|
|
7503
7503
|
* Chat service.
|
|
7504
7504
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7505
|
-
* @version
|
|
7505
|
+
* @version 151.0.0
|
|
7506
7506
|
*/
|
|
7507
7507
|
|
|
7508
7508
|
/**
|
|
@@ -7593,7 +7593,7 @@ class CoachingApi {
|
|
|
7593
7593
|
/**
|
|
7594
7594
|
* Coaching service.
|
|
7595
7595
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7596
|
-
* @version
|
|
7596
|
+
* @version 151.0.0
|
|
7597
7597
|
*/
|
|
7598
7598
|
|
|
7599
7599
|
/**
|
|
@@ -8170,7 +8170,7 @@ class ContentManagementApi {
|
|
|
8170
8170
|
/**
|
|
8171
8171
|
* ContentManagement service.
|
|
8172
8172
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8173
|
-
* @version
|
|
8173
|
+
* @version 151.0.0
|
|
8174
8174
|
*/
|
|
8175
8175
|
|
|
8176
8176
|
/**
|
|
@@ -9310,7 +9310,7 @@ class ConversationsApi {
|
|
|
9310
9310
|
/**
|
|
9311
9311
|
* Conversations service.
|
|
9312
9312
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9313
|
-
* @version
|
|
9313
|
+
* @version 151.0.0
|
|
9314
9314
|
*/
|
|
9315
9315
|
|
|
9316
9316
|
/**
|
|
@@ -13656,6 +13656,41 @@ class ConversationsApi {
|
|
|
13656
13656
|
);
|
|
13657
13657
|
}
|
|
13658
13658
|
|
|
13659
|
+
/**
|
|
13660
|
+
* Send message typing event
|
|
13661
|
+
* Send message typing event for existing conversation/communication.
|
|
13662
|
+
* @param {String} conversationId conversationId
|
|
13663
|
+
* @param {String} communicationId communicationId
|
|
13664
|
+
* @param {Object} body MessageTypingEvent
|
|
13665
|
+
*/
|
|
13666
|
+
postConversationsMessageCommunicationTyping(conversationId, communicationId, body) {
|
|
13667
|
+
// verify the required parameter 'conversationId' is set
|
|
13668
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13669
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationTyping';
|
|
13670
|
+
}
|
|
13671
|
+
// verify the required parameter 'communicationId' is set
|
|
13672
|
+
if (communicationId === undefined || communicationId === null) {
|
|
13673
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationTyping';
|
|
13674
|
+
}
|
|
13675
|
+
// verify the required parameter 'body' is set
|
|
13676
|
+
if (body === undefined || body === null) {
|
|
13677
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationTyping';
|
|
13678
|
+
}
|
|
13679
|
+
|
|
13680
|
+
return this.apiClient.callApi(
|
|
13681
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing',
|
|
13682
|
+
'POST',
|
|
13683
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
13684
|
+
{ },
|
|
13685
|
+
{ },
|
|
13686
|
+
{ },
|
|
13687
|
+
body,
|
|
13688
|
+
['PureCloud OAuth'],
|
|
13689
|
+
['application/json'],
|
|
13690
|
+
['application/json']
|
|
13691
|
+
);
|
|
13692
|
+
}
|
|
13693
|
+
|
|
13659
13694
|
/**
|
|
13660
13695
|
* Get messages in batch
|
|
13661
13696
|
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
@@ -14492,7 +14527,7 @@ class DataExtensionsApi {
|
|
|
14492
14527
|
/**
|
|
14493
14528
|
* DataExtensions service.
|
|
14494
14529
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14495
|
-
* @version
|
|
14530
|
+
* @version 151.0.0
|
|
14496
14531
|
*/
|
|
14497
14532
|
|
|
14498
14533
|
/**
|
|
@@ -14578,7 +14613,7 @@ class DownloadsApi {
|
|
|
14578
14613
|
/**
|
|
14579
14614
|
* Downloads service.
|
|
14580
14615
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14581
|
-
* @version
|
|
14616
|
+
* @version 151.0.0
|
|
14582
14617
|
*/
|
|
14583
14618
|
|
|
14584
14619
|
/**
|
|
@@ -14630,7 +14665,7 @@ class EventsApi {
|
|
|
14630
14665
|
/**
|
|
14631
14666
|
* Events service.
|
|
14632
14667
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14633
|
-
* @version
|
|
14668
|
+
* @version 151.0.0
|
|
14634
14669
|
*/
|
|
14635
14670
|
|
|
14636
14671
|
/**
|
|
@@ -14726,7 +14761,7 @@ class ExternalContactsApi {
|
|
|
14726
14761
|
/**
|
|
14727
14762
|
* ExternalContacts service.
|
|
14728
14763
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14729
|
-
* @version
|
|
14764
|
+
* @version 151.0.0
|
|
14730
14765
|
*/
|
|
14731
14766
|
|
|
14732
14767
|
/**
|
|
@@ -14980,6 +15015,37 @@ class ExternalContactsApi {
|
|
|
14980
15015
|
);
|
|
14981
15016
|
}
|
|
14982
15017
|
|
|
15018
|
+
/**
|
|
15019
|
+
* Retrieve all sessions for a given external contact.
|
|
15020
|
+
*
|
|
15021
|
+
* @param {String} contactId ExternalContact ID
|
|
15022
|
+
* @param {Object} opts Optional parameters
|
|
15023
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
15024
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
15025
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
15026
|
+
*/
|
|
15027
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
15028
|
+
opts = opts || {};
|
|
15029
|
+
|
|
15030
|
+
// verify the required parameter 'contactId' is set
|
|
15031
|
+
if (contactId === undefined || contactId === null) {
|
|
15032
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
15033
|
+
}
|
|
15034
|
+
|
|
15035
|
+
return this.apiClient.callApi(
|
|
15036
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
15037
|
+
'GET',
|
|
15038
|
+
{ 'contactId': contactId },
|
|
15039
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
15040
|
+
{ },
|
|
15041
|
+
{ },
|
|
15042
|
+
null,
|
|
15043
|
+
['PureCloud OAuth'],
|
|
15044
|
+
['application/json'],
|
|
15045
|
+
['application/json']
|
|
15046
|
+
);
|
|
15047
|
+
}
|
|
15048
|
+
|
|
14983
15049
|
/**
|
|
14984
15050
|
* Fetch a note for an external contact
|
|
14985
15051
|
*
|
|
@@ -16653,7 +16719,7 @@ class FaxApi {
|
|
|
16653
16719
|
/**
|
|
16654
16720
|
* Fax service.
|
|
16655
16721
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16656
|
-
* @version
|
|
16722
|
+
* @version 151.0.0
|
|
16657
16723
|
*/
|
|
16658
16724
|
|
|
16659
16725
|
/**
|
|
@@ -16824,7 +16890,7 @@ class FlowsApi {
|
|
|
16824
16890
|
/**
|
|
16825
16891
|
* Flows service.
|
|
16826
16892
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16827
|
-
* @version
|
|
16893
|
+
* @version 151.0.0
|
|
16828
16894
|
*/
|
|
16829
16895
|
|
|
16830
16896
|
/**
|
|
@@ -16895,7 +16961,7 @@ class GamificationApi {
|
|
|
16895
16961
|
/**
|
|
16896
16962
|
* Gamification service.
|
|
16897
16963
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16898
|
-
* @version
|
|
16964
|
+
* @version 151.0.0
|
|
16899
16965
|
*/
|
|
16900
16966
|
|
|
16901
16967
|
/**
|
|
@@ -18576,7 +18642,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18576
18642
|
/**
|
|
18577
18643
|
* GeneralDataProtectionRegulation service.
|
|
18578
18644
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18579
|
-
* @version
|
|
18645
|
+
* @version 151.0.0
|
|
18580
18646
|
*/
|
|
18581
18647
|
|
|
18582
18648
|
/**
|
|
@@ -18706,7 +18772,7 @@ class GeolocationApi {
|
|
|
18706
18772
|
/**
|
|
18707
18773
|
* Geolocation service.
|
|
18708
18774
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18709
|
-
* @version
|
|
18775
|
+
* @version 151.0.0
|
|
18710
18776
|
*/
|
|
18711
18777
|
|
|
18712
18778
|
/**
|
|
@@ -18837,7 +18903,7 @@ class GreetingsApi {
|
|
|
18837
18903
|
/**
|
|
18838
18904
|
* Greetings service.
|
|
18839
18905
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18840
|
-
* @version
|
|
18906
|
+
* @version 151.0.0
|
|
18841
18907
|
*/
|
|
18842
18908
|
|
|
18843
18909
|
/**
|
|
@@ -19292,7 +19358,7 @@ class GroupsApi {
|
|
|
19292
19358
|
/**
|
|
19293
19359
|
* Groups service.
|
|
19294
19360
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19295
|
-
* @version
|
|
19361
|
+
* @version 151.0.0
|
|
19296
19362
|
*/
|
|
19297
19363
|
|
|
19298
19364
|
/**
|
|
@@ -19698,7 +19764,7 @@ class IdentityProviderApi {
|
|
|
19698
19764
|
/**
|
|
19699
19765
|
* IdentityProvider service.
|
|
19700
19766
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19701
|
-
* @version
|
|
19767
|
+
* @version 151.0.0
|
|
19702
19768
|
*/
|
|
19703
19769
|
|
|
19704
19770
|
/**
|
|
@@ -20454,7 +20520,7 @@ class IntegrationsApi {
|
|
|
20454
20520
|
/**
|
|
20455
20521
|
* Integrations service.
|
|
20456
20522
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20457
|
-
* @version
|
|
20523
|
+
* @version 151.0.0
|
|
20458
20524
|
*/
|
|
20459
20525
|
|
|
20460
20526
|
/**
|
|
@@ -22054,7 +22120,7 @@ class JourneyApi {
|
|
|
22054
22120
|
/**
|
|
22055
22121
|
* Journey service.
|
|
22056
22122
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22057
|
-
* @version
|
|
22123
|
+
* @version 151.0.0
|
|
22058
22124
|
*/
|
|
22059
22125
|
|
|
22060
22126
|
/**
|
|
@@ -22840,7 +22906,7 @@ class KnowledgeApi {
|
|
|
22840
22906
|
/**
|
|
22841
22907
|
* Knowledge service.
|
|
22842
22908
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22843
|
-
* @version
|
|
22909
|
+
* @version 151.0.0
|
|
22844
22910
|
*/
|
|
22845
22911
|
|
|
22846
22912
|
/**
|
|
@@ -25273,7 +25339,7 @@ class LanguageUnderstandingApi {
|
|
|
25273
25339
|
/**
|
|
25274
25340
|
* LanguageUnderstanding service.
|
|
25275
25341
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25276
|
-
* @version
|
|
25342
|
+
* @version 151.0.0
|
|
25277
25343
|
*/
|
|
25278
25344
|
|
|
25279
25345
|
/**
|
|
@@ -26177,7 +26243,7 @@ class LanguagesApi {
|
|
|
26177
26243
|
/**
|
|
26178
26244
|
* Languages service.
|
|
26179
26245
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26180
|
-
* @version
|
|
26246
|
+
* @version 151.0.0
|
|
26181
26247
|
*/
|
|
26182
26248
|
|
|
26183
26249
|
/**
|
|
@@ -26445,7 +26511,7 @@ class LearningApi {
|
|
|
26445
26511
|
/**
|
|
26446
26512
|
* Learning service.
|
|
26447
26513
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26448
|
-
* @version
|
|
26514
|
+
* @version 151.0.0
|
|
26449
26515
|
*/
|
|
26450
26516
|
|
|
26451
26517
|
/**
|
|
@@ -27205,7 +27271,7 @@ class LicenseApi {
|
|
|
27205
27271
|
/**
|
|
27206
27272
|
* License service.
|
|
27207
27273
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27208
|
-
* @version
|
|
27274
|
+
* @version 151.0.0
|
|
27209
27275
|
*/
|
|
27210
27276
|
|
|
27211
27277
|
/**
|
|
@@ -27443,7 +27509,7 @@ class LocationsApi {
|
|
|
27443
27509
|
/**
|
|
27444
27510
|
* Locations service.
|
|
27445
27511
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27446
|
-
* @version
|
|
27512
|
+
* @version 151.0.0
|
|
27447
27513
|
*/
|
|
27448
27514
|
|
|
27449
27515
|
/**
|
|
@@ -27679,7 +27745,7 @@ class MessagingApi {
|
|
|
27679
27745
|
/**
|
|
27680
27746
|
* Messaging service.
|
|
27681
27747
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27682
|
-
* @version
|
|
27748
|
+
* @version 151.0.0
|
|
27683
27749
|
*/
|
|
27684
27750
|
|
|
27685
27751
|
/**
|
|
@@ -27830,7 +27896,7 @@ class MobileDevicesApi {
|
|
|
27830
27896
|
/**
|
|
27831
27897
|
* MobileDevices service.
|
|
27832
27898
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27833
|
-
* @version
|
|
27899
|
+
* @version 151.0.0
|
|
27834
27900
|
*/
|
|
27835
27901
|
|
|
27836
27902
|
/**
|
|
@@ -27981,7 +28047,7 @@ class NotificationsApi {
|
|
|
27981
28047
|
/**
|
|
27982
28048
|
* Notifications service.
|
|
27983
28049
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
27984
|
-
* @version
|
|
28050
|
+
* @version 151.0.0
|
|
27985
28051
|
*/
|
|
27986
28052
|
|
|
27987
28053
|
/**
|
|
@@ -28206,7 +28272,7 @@ class OAuthApi {
|
|
|
28206
28272
|
/**
|
|
28207
28273
|
* OAuth service.
|
|
28208
28274
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28209
|
-
* @version
|
|
28275
|
+
* @version 151.0.0
|
|
28210
28276
|
*/
|
|
28211
28277
|
|
|
28212
28278
|
/**
|
|
@@ -28572,7 +28638,7 @@ class ObjectsApi {
|
|
|
28572
28638
|
/**
|
|
28573
28639
|
* Objects service.
|
|
28574
28640
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28575
|
-
* @version
|
|
28641
|
+
* @version 151.0.0
|
|
28576
28642
|
*/
|
|
28577
28643
|
|
|
28578
28644
|
/**
|
|
@@ -28843,7 +28909,7 @@ class OrganizationApi {
|
|
|
28843
28909
|
/**
|
|
28844
28910
|
* Organization service.
|
|
28845
28911
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28846
|
-
* @version
|
|
28912
|
+
* @version 151.0.0
|
|
28847
28913
|
*/
|
|
28848
28914
|
|
|
28849
28915
|
/**
|
|
@@ -29246,7 +29312,7 @@ class OrganizationAuthorizationApi {
|
|
|
29246
29312
|
/**
|
|
29247
29313
|
* OrganizationAuthorization service.
|
|
29248
29314
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29249
|
-
* @version
|
|
29315
|
+
* @version 151.0.0
|
|
29250
29316
|
*/
|
|
29251
29317
|
|
|
29252
29318
|
/**
|
|
@@ -30171,7 +30237,7 @@ class OutboundApi {
|
|
|
30171
30237
|
/**
|
|
30172
30238
|
* Outbound service.
|
|
30173
30239
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30174
|
-
* @version
|
|
30240
|
+
* @version 151.0.0
|
|
30175
30241
|
*/
|
|
30176
30242
|
|
|
30177
30243
|
/**
|
|
@@ -33560,7 +33626,7 @@ class PresenceApi {
|
|
|
33560
33626
|
/**
|
|
33561
33627
|
* Presence service.
|
|
33562
33628
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33563
|
-
* @version
|
|
33629
|
+
* @version 151.0.0
|
|
33564
33630
|
*/
|
|
33565
33631
|
|
|
33566
33632
|
/**
|
|
@@ -33654,7 +33720,7 @@ class PresenceApi {
|
|
|
33654
33720
|
* Get a list of Presence Sources
|
|
33655
33721
|
*
|
|
33656
33722
|
* @param {Object} opts Optional parameters
|
|
33657
|
-
* @param {String} opts.
|
|
33723
|
+
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
33658
33724
|
*/
|
|
33659
33725
|
getPresenceSources(opts) {
|
|
33660
33726
|
opts = opts || {};
|
|
@@ -33664,7 +33730,7 @@ class PresenceApi {
|
|
|
33664
33730
|
'/api/v2/presence/sources',
|
|
33665
33731
|
'GET',
|
|
33666
33732
|
{ },
|
|
33667
|
-
{ '
|
|
33733
|
+
{ 'deactivated': opts['deactivated'] },
|
|
33668
33734
|
{ },
|
|
33669
33735
|
{ },
|
|
33670
33736
|
null,
|
|
@@ -34066,7 +34132,7 @@ class ProcessAutomationApi {
|
|
|
34066
34132
|
/**
|
|
34067
34133
|
* ProcessAutomation service.
|
|
34068
34134
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34069
|
-
* @version
|
|
34135
|
+
* @version 151.0.0
|
|
34070
34136
|
*/
|
|
34071
34137
|
|
|
34072
34138
|
/**
|
|
@@ -34107,7 +34173,7 @@ class ProcessAutomationApi {
|
|
|
34107
34173
|
}
|
|
34108
34174
|
|
|
34109
34175
|
/**
|
|
34110
|
-
* Retrieve a single Trigger matching id
|
|
34176
|
+
* Retrieve a single Trigger matching id
|
|
34111
34177
|
*
|
|
34112
34178
|
* @param {String} triggerId triggerId
|
|
34113
34179
|
*/
|
|
@@ -34132,13 +34198,13 @@ class ProcessAutomationApi {
|
|
|
34132
34198
|
}
|
|
34133
34199
|
|
|
34134
34200
|
/**
|
|
34135
|
-
* Retrieves all triggers
|
|
34201
|
+
* Retrieves all triggers, optionally filtered by query parameters.
|
|
34136
34202
|
*
|
|
34137
34203
|
* @param {Object} opts Optional parameters
|
|
34138
34204
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
34139
34205
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
34140
34206
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
34141
|
-
* @param {String} opts.topicName Topic name
|
|
34207
|
+
* @param {String} opts.topicName Topic name(s). Separated by commas
|
|
34142
34208
|
* @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
|
|
34143
34209
|
*/
|
|
34144
34210
|
getProcessautomationTriggers(opts) {
|
|
@@ -34304,7 +34370,7 @@ class QualityApi {
|
|
|
34304
34370
|
/**
|
|
34305
34371
|
* Quality service.
|
|
34306
34372
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34307
|
-
* @version
|
|
34373
|
+
* @version 151.0.0
|
|
34308
34374
|
*/
|
|
34309
34375
|
|
|
34310
34376
|
/**
|
|
@@ -35882,7 +35948,7 @@ class RecordingApi {
|
|
|
35882
35948
|
/**
|
|
35883
35949
|
* Recording service.
|
|
35884
35950
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35885
|
-
* @version
|
|
35951
|
+
* @version 151.0.0
|
|
35886
35952
|
*/
|
|
35887
35953
|
|
|
35888
35954
|
/**
|
|
@@ -37569,7 +37635,7 @@ class ResponseManagementApi {
|
|
|
37569
37635
|
/**
|
|
37570
37636
|
* ResponseManagement service.
|
|
37571
37637
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37572
|
-
* @version
|
|
37638
|
+
* @version 151.0.0
|
|
37573
37639
|
*/
|
|
37574
37640
|
|
|
37575
37641
|
/**
|
|
@@ -38053,7 +38119,7 @@ class RoutingApi {
|
|
|
38053
38119
|
/**
|
|
38054
38120
|
* Routing service.
|
|
38055
38121
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38056
|
-
* @version
|
|
38122
|
+
* @version 151.0.0
|
|
38057
38123
|
*/
|
|
38058
38124
|
|
|
38059
38125
|
/**
|
|
@@ -41244,7 +41310,7 @@ class SCIMApi {
|
|
|
41244
41310
|
/**
|
|
41245
41311
|
* SCIM service.
|
|
41246
41312
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
41247
|
-
* @version
|
|
41313
|
+
* @version 151.0.0
|
|
41248
41314
|
*/
|
|
41249
41315
|
|
|
41250
41316
|
/**
|
|
@@ -42121,7 +42187,7 @@ class ScriptsApi {
|
|
|
42121
42187
|
/**
|
|
42122
42188
|
* Scripts service.
|
|
42123
42189
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
42124
|
-
* @version
|
|
42190
|
+
* @version 151.0.0
|
|
42125
42191
|
*/
|
|
42126
42192
|
|
|
42127
42193
|
/**
|
|
@@ -42540,7 +42606,7 @@ class SearchApi {
|
|
|
42540
42606
|
/**
|
|
42541
42607
|
* Search service.
|
|
42542
42608
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
42543
|
-
* @version
|
|
42609
|
+
* @version 151.0.0
|
|
42544
42610
|
*/
|
|
42545
42611
|
|
|
42546
42612
|
/**
|
|
@@ -43069,6 +43135,31 @@ class SearchApi {
|
|
|
43069
43135
|
);
|
|
43070
43136
|
}
|
|
43071
43137
|
|
|
43138
|
+
/**
|
|
43139
|
+
* Search users assigned to teams
|
|
43140
|
+
*
|
|
43141
|
+
* @param {Object} body Search request options
|
|
43142
|
+
*/
|
|
43143
|
+
postUsersSearchTeamsAssign(body) {
|
|
43144
|
+
// verify the required parameter 'body' is set
|
|
43145
|
+
if (body === undefined || body === null) {
|
|
43146
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
43147
|
+
}
|
|
43148
|
+
|
|
43149
|
+
return this.apiClient.callApi(
|
|
43150
|
+
'/api/v2/users/search/teams/assign',
|
|
43151
|
+
'POST',
|
|
43152
|
+
{ },
|
|
43153
|
+
{ },
|
|
43154
|
+
{ },
|
|
43155
|
+
{ },
|
|
43156
|
+
body,
|
|
43157
|
+
['PureCloud OAuth'],
|
|
43158
|
+
['application/json'],
|
|
43159
|
+
['application/json']
|
|
43160
|
+
);
|
|
43161
|
+
}
|
|
43162
|
+
|
|
43072
43163
|
/**
|
|
43073
43164
|
* Search voicemails
|
|
43074
43165
|
*
|
|
@@ -43100,7 +43191,7 @@ class SpeechTextAnalyticsApi {
|
|
|
43100
43191
|
/**
|
|
43101
43192
|
* SpeechTextAnalytics service.
|
|
43102
43193
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
43103
|
-
* @version
|
|
43194
|
+
* @version 151.0.0
|
|
43104
43195
|
*/
|
|
43105
43196
|
|
|
43106
43197
|
/**
|
|
@@ -43954,7 +44045,7 @@ class StationsApi {
|
|
|
43954
44045
|
/**
|
|
43955
44046
|
* Stations service.
|
|
43956
44047
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
43957
|
-
* @version
|
|
44048
|
+
* @version 151.0.0
|
|
43958
44049
|
*/
|
|
43959
44050
|
|
|
43960
44051
|
/**
|
|
@@ -44101,7 +44192,7 @@ class SuggestApi {
|
|
|
44101
44192
|
/**
|
|
44102
44193
|
* Suggest service.
|
|
44103
44194
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
44104
|
-
* @version
|
|
44195
|
+
* @version 151.0.0
|
|
44105
44196
|
*/
|
|
44106
44197
|
|
|
44107
44198
|
/**
|
|
@@ -44240,7 +44331,7 @@ class TeamsApi {
|
|
|
44240
44331
|
/**
|
|
44241
44332
|
* Teams service.
|
|
44242
44333
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
44243
|
-
* @version
|
|
44334
|
+
* @version 151.0.0
|
|
44244
44335
|
*/
|
|
44245
44336
|
|
|
44246
44337
|
/**
|
|
@@ -44280,6 +44371,36 @@ class TeamsApi {
|
|
|
44280
44371
|
);
|
|
44281
44372
|
}
|
|
44282
44373
|
|
|
44374
|
+
/**
|
|
44375
|
+
* Delete team members
|
|
44376
|
+
*
|
|
44377
|
+
* @param {String} teamId Team ID
|
|
44378
|
+
* @param {String} id Comma separated list of member ids to remove
|
|
44379
|
+
*/
|
|
44380
|
+
deleteTeamMembers(teamId, id) {
|
|
44381
|
+
// verify the required parameter 'teamId' is set
|
|
44382
|
+
if (teamId === undefined || teamId === null) {
|
|
44383
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeamMembers';
|
|
44384
|
+
}
|
|
44385
|
+
// verify the required parameter 'id' is set
|
|
44386
|
+
if (id === undefined || id === null) {
|
|
44387
|
+
throw 'Missing the required parameter "id" when calling deleteTeamMembers';
|
|
44388
|
+
}
|
|
44389
|
+
|
|
44390
|
+
return this.apiClient.callApi(
|
|
44391
|
+
'/api/v2/teams/{teamId}/members',
|
|
44392
|
+
'DELETE',
|
|
44393
|
+
{ 'teamId': teamId },
|
|
44394
|
+
{ 'id': id },
|
|
44395
|
+
{ },
|
|
44396
|
+
{ },
|
|
44397
|
+
null,
|
|
44398
|
+
['PureCloud OAuth'],
|
|
44399
|
+
['application/json'],
|
|
44400
|
+
['application/json']
|
|
44401
|
+
);
|
|
44402
|
+
}
|
|
44403
|
+
|
|
44283
44404
|
/**
|
|
44284
44405
|
* Get team
|
|
44285
44406
|
*
|
|
@@ -44305,6 +44426,38 @@ class TeamsApi {
|
|
|
44305
44426
|
);
|
|
44306
44427
|
}
|
|
44307
44428
|
|
|
44429
|
+
/**
|
|
44430
|
+
* Get team membership
|
|
44431
|
+
*
|
|
44432
|
+
* @param {String} teamId Team ID
|
|
44433
|
+
* @param {Object} opts Optional parameters
|
|
44434
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
44435
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
44436
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
44437
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
44438
|
+
*/
|
|
44439
|
+
getTeamMembers(teamId, opts) {
|
|
44440
|
+
opts = opts || {};
|
|
44441
|
+
|
|
44442
|
+
// verify the required parameter 'teamId' is set
|
|
44443
|
+
if (teamId === undefined || teamId === null) {
|
|
44444
|
+
throw 'Missing the required parameter "teamId" when calling getTeamMembers';
|
|
44445
|
+
}
|
|
44446
|
+
|
|
44447
|
+
return this.apiClient.callApi(
|
|
44448
|
+
'/api/v2/teams/{teamId}/members',
|
|
44449
|
+
'GET',
|
|
44450
|
+
{ 'teamId': teamId },
|
|
44451
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'],'expand': opts['expand'] },
|
|
44452
|
+
{ },
|
|
44453
|
+
{ },
|
|
44454
|
+
null,
|
|
44455
|
+
['PureCloud OAuth'],
|
|
44456
|
+
['application/json'],
|
|
44457
|
+
['application/json']
|
|
44458
|
+
);
|
|
44459
|
+
}
|
|
44460
|
+
|
|
44308
44461
|
/**
|
|
44309
44462
|
* Get Team listing
|
|
44310
44463
|
*
|
|
@@ -44363,6 +44516,36 @@ class TeamsApi {
|
|
|
44363
44516
|
);
|
|
44364
44517
|
}
|
|
44365
44518
|
|
|
44519
|
+
/**
|
|
44520
|
+
* Add team members
|
|
44521
|
+
*
|
|
44522
|
+
* @param {String} teamId Team ID
|
|
44523
|
+
* @param {Object} body TeamMembers
|
|
44524
|
+
*/
|
|
44525
|
+
postTeamMembers(teamId, body) {
|
|
44526
|
+
// verify the required parameter 'teamId' is set
|
|
44527
|
+
if (teamId === undefined || teamId === null) {
|
|
44528
|
+
throw 'Missing the required parameter "teamId" when calling postTeamMembers';
|
|
44529
|
+
}
|
|
44530
|
+
// verify the required parameter 'body' is set
|
|
44531
|
+
if (body === undefined || body === null) {
|
|
44532
|
+
throw 'Missing the required parameter "body" when calling postTeamMembers';
|
|
44533
|
+
}
|
|
44534
|
+
|
|
44535
|
+
return this.apiClient.callApi(
|
|
44536
|
+
'/api/v2/teams/{teamId}/members',
|
|
44537
|
+
'POST',
|
|
44538
|
+
{ 'teamId': teamId },
|
|
44539
|
+
{ },
|
|
44540
|
+
{ },
|
|
44541
|
+
{ },
|
|
44542
|
+
body,
|
|
44543
|
+
['PureCloud OAuth'],
|
|
44544
|
+
['application/json'],
|
|
44545
|
+
['application/json']
|
|
44546
|
+
);
|
|
44547
|
+
}
|
|
44548
|
+
|
|
44366
44549
|
/**
|
|
44367
44550
|
* Create a team
|
|
44368
44551
|
*
|
|
@@ -44419,7 +44602,7 @@ class TelephonyApi {
|
|
|
44419
44602
|
/**
|
|
44420
44603
|
* Telephony service.
|
|
44421
44604
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
44422
|
-
* @version
|
|
44605
|
+
* @version 151.0.0
|
|
44423
44606
|
*/
|
|
44424
44607
|
|
|
44425
44608
|
/**
|
|
@@ -44527,7 +44710,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
44527
44710
|
/**
|
|
44528
44711
|
* TelephonyProvidersEdge service.
|
|
44529
44712
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
44530
|
-
* @version
|
|
44713
|
+
* @version 151.0.0
|
|
44531
44714
|
*/
|
|
44532
44715
|
|
|
44533
44716
|
/**
|
|
@@ -48160,7 +48343,7 @@ class TextbotsApi {
|
|
|
48160
48343
|
/**
|
|
48161
48344
|
* Textbots service.
|
|
48162
48345
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
48163
|
-
* @version
|
|
48346
|
+
* @version 151.0.0
|
|
48164
48347
|
*/
|
|
48165
48348
|
|
|
48166
48349
|
/**
|
|
@@ -48288,7 +48471,7 @@ class TokensApi {
|
|
|
48288
48471
|
/**
|
|
48289
48472
|
* Tokens service.
|
|
48290
48473
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
48291
|
-
* @version
|
|
48474
|
+
* @version 151.0.0
|
|
48292
48475
|
*/
|
|
48293
48476
|
|
|
48294
48477
|
/**
|
|
@@ -48394,7 +48577,7 @@ class UploadsApi {
|
|
|
48394
48577
|
/**
|
|
48395
48578
|
* Uploads service.
|
|
48396
48579
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
48397
|
-
* @version
|
|
48580
|
+
* @version 151.0.0
|
|
48398
48581
|
*/
|
|
48399
48582
|
|
|
48400
48583
|
/**
|
|
@@ -48570,7 +48753,7 @@ class UsageApi {
|
|
|
48570
48753
|
/**
|
|
48571
48754
|
* Usage service.
|
|
48572
48755
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
48573
|
-
* @version
|
|
48756
|
+
* @version 151.0.0
|
|
48574
48757
|
*/
|
|
48575
48758
|
|
|
48576
48759
|
/**
|
|
@@ -48641,7 +48824,7 @@ class UserRecordingsApi {
|
|
|
48641
48824
|
/**
|
|
48642
48825
|
* UserRecordings service.
|
|
48643
48826
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
48644
|
-
* @version
|
|
48827
|
+
* @version 151.0.0
|
|
48645
48828
|
*/
|
|
48646
48829
|
|
|
48647
48830
|
/**
|
|
@@ -48826,7 +49009,7 @@ class UsersApi {
|
|
|
48826
49009
|
/**
|
|
48827
49010
|
* Users service.
|
|
48828
49011
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
48829
|
-
* @version
|
|
49012
|
+
* @version 151.0.0
|
|
48830
49013
|
*/
|
|
48831
49014
|
|
|
48832
49015
|
/**
|
|
@@ -50817,6 +51000,31 @@ class UsersApi {
|
|
|
50817
51000
|
);
|
|
50818
51001
|
}
|
|
50819
51002
|
|
|
51003
|
+
/**
|
|
51004
|
+
* Search users assigned to teams
|
|
51005
|
+
*
|
|
51006
|
+
* @param {Object} body Search request options
|
|
51007
|
+
*/
|
|
51008
|
+
postUsersSearchTeamsAssign(body) {
|
|
51009
|
+
// verify the required parameter 'body' is set
|
|
51010
|
+
if (body === undefined || body === null) {
|
|
51011
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
51012
|
+
}
|
|
51013
|
+
|
|
51014
|
+
return this.apiClient.callApi(
|
|
51015
|
+
'/api/v2/users/search/teams/assign',
|
|
51016
|
+
'POST',
|
|
51017
|
+
{ },
|
|
51018
|
+
{ },
|
|
51019
|
+
{ },
|
|
51020
|
+
{ },
|
|
51021
|
+
body,
|
|
51022
|
+
['PureCloud OAuth'],
|
|
51023
|
+
['application/json'],
|
|
51024
|
+
['application/json']
|
|
51025
|
+
);
|
|
51026
|
+
}
|
|
51027
|
+
|
|
50820
51028
|
/**
|
|
50821
51029
|
* Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
|
50822
51030
|
*
|
|
@@ -51158,7 +51366,7 @@ class UtilitiesApi {
|
|
|
51158
51366
|
/**
|
|
51159
51367
|
* Utilities service.
|
|
51160
51368
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
51161
|
-
* @version
|
|
51369
|
+
* @version 151.0.0
|
|
51162
51370
|
*/
|
|
51163
51371
|
|
|
51164
51372
|
/**
|
|
@@ -51269,7 +51477,7 @@ class VoicemailApi {
|
|
|
51269
51477
|
/**
|
|
51270
51478
|
* Voicemail service.
|
|
51271
51479
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
51272
|
-
* @version
|
|
51480
|
+
* @version 151.0.0
|
|
51273
51481
|
*/
|
|
51274
51482
|
|
|
51275
51483
|
/**
|
|
@@ -51936,7 +52144,7 @@ class WebChatApi {
|
|
|
51936
52144
|
/**
|
|
51937
52145
|
* WebChat service.
|
|
51938
52146
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
51939
|
-
* @version
|
|
52147
|
+
* @version 151.0.0
|
|
51940
52148
|
*/
|
|
51941
52149
|
|
|
51942
52150
|
/**
|
|
@@ -52480,7 +52688,7 @@ class WebDeploymentsApi {
|
|
|
52480
52688
|
/**
|
|
52481
52689
|
* WebDeployments service.
|
|
52482
52690
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
52483
|
-
* @version
|
|
52691
|
+
* @version 151.0.0
|
|
52484
52692
|
*/
|
|
52485
52693
|
|
|
52486
52694
|
/**
|
|
@@ -52868,7 +53076,7 @@ class WebMessagingApi {
|
|
|
52868
53076
|
/**
|
|
52869
53077
|
* WebMessaging service.
|
|
52870
53078
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
52871
|
-
* @version
|
|
53079
|
+
* @version 151.0.0
|
|
52872
53080
|
*/
|
|
52873
53081
|
|
|
52874
53082
|
/**
|
|
@@ -52914,7 +53122,7 @@ class WidgetsApi {
|
|
|
52914
53122
|
/**
|
|
52915
53123
|
* Widgets service.
|
|
52916
53124
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
52917
|
-
* @version
|
|
53125
|
+
* @version 151.0.0
|
|
52918
53126
|
*/
|
|
52919
53127
|
|
|
52920
53128
|
/**
|
|
@@ -53060,7 +53268,7 @@ class WorkforceManagementApi {
|
|
|
53060
53268
|
/**
|
|
53061
53269
|
* WorkforceManagement service.
|
|
53062
53270
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
53063
|
-
* @version
|
|
53271
|
+
* @version 151.0.0
|
|
53064
53272
|
*/
|
|
53065
53273
|
|
|
53066
53274
|
/**
|
|
@@ -56840,6 +57048,76 @@ class WorkforceManagementApi {
|
|
|
56840
57048
|
);
|
|
56841
57049
|
}
|
|
56842
57050
|
|
|
57051
|
+
/**
|
|
57052
|
+
* Query time off balances for a given user for specified activity code and dates
|
|
57053
|
+
*
|
|
57054
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
57055
|
+
* @param {String} userId The ID of the user
|
|
57056
|
+
* @param {Object} body The request body
|
|
57057
|
+
*/
|
|
57058
|
+
postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId, userId, body) {
|
|
57059
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57060
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57061
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57062
|
+
}
|
|
57063
|
+
// verify the required parameter 'userId' is set
|
|
57064
|
+
if (userId === undefined || userId === null) {
|
|
57065
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57066
|
+
}
|
|
57067
|
+
// verify the required parameter 'body' is set
|
|
57068
|
+
if (body === undefined || body === null) {
|
|
57069
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57070
|
+
}
|
|
57071
|
+
|
|
57072
|
+
return this.apiClient.callApi(
|
|
57073
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs',
|
|
57074
|
+
'POST',
|
|
57075
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
57076
|
+
{ },
|
|
57077
|
+
{ },
|
|
57078
|
+
{ },
|
|
57079
|
+
body,
|
|
57080
|
+
['PureCloud OAuth'],
|
|
57081
|
+
['application/json'],
|
|
57082
|
+
['application/json']
|
|
57083
|
+
);
|
|
57084
|
+
}
|
|
57085
|
+
|
|
57086
|
+
/**
|
|
57087
|
+
* Query time off balances for dates spanned by a given time off request
|
|
57088
|
+
*
|
|
57089
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
57090
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
57091
|
+
* @param {String} timeOffRequestId The time off request id.
|
|
57092
|
+
*/
|
|
57093
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId, userId, timeOffRequestId) {
|
|
57094
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57095
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57096
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57097
|
+
}
|
|
57098
|
+
// verify the required parameter 'userId' is set
|
|
57099
|
+
if (userId === undefined || userId === null) {
|
|
57100
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57101
|
+
}
|
|
57102
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
57103
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
57104
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57105
|
+
}
|
|
57106
|
+
|
|
57107
|
+
return this.apiClient.callApi(
|
|
57108
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs',
|
|
57109
|
+
'POST',
|
|
57110
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
57111
|
+
{ },
|
|
57112
|
+
{ },
|
|
57113
|
+
{ },
|
|
57114
|
+
null,
|
|
57115
|
+
['PureCloud OAuth'],
|
|
57116
|
+
['application/json'],
|
|
57117
|
+
['application/json']
|
|
57118
|
+
);
|
|
57119
|
+
}
|
|
57120
|
+
|
|
56843
57121
|
/**
|
|
56844
57122
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
56845
57123
|
*
|
|
@@ -57336,7 +57614,7 @@ class WorkforceManagementApi {
|
|
|
57336
57614
|
* </pre>
|
|
57337
57615
|
* </p>
|
|
57338
57616
|
* @module purecloud-platform-client-v2/index
|
|
57339
|
-
* @version
|
|
57617
|
+
* @version 151.0.0
|
|
57340
57618
|
*/
|
|
57341
57619
|
class platformClient {
|
|
57342
57620
|
constructor() {
|