purecloud-platform-client-v2 149.1.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 +1114 -77
- package/dist/web-amd/purecloud-platform-client-v2.js +1114 -77
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1114 -77
- package/dist/web-cjs/purecloud-platform-client-v2.js +1114 -77
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1082 -425
- 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 +81 -8
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +57 -0
- package/src/purecloud-platform-client-v2/api/EventsApi.js +101 -0
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +216 -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 +185 -1
- 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 +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +196 -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 +13 -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
|
/**
|
|
@@ -10820,8 +10820,12 @@ class ConversationsApi {
|
|
|
10820
10820
|
* Get message
|
|
10821
10821
|
*
|
|
10822
10822
|
* @param {String} messageId messageId
|
|
10823
|
+
* @param {Object} opts Optional parameters
|
|
10824
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
10823
10825
|
*/
|
|
10824
|
-
getConversationsMessageDetails(messageId) {
|
|
10826
|
+
getConversationsMessageDetails(messageId, opts) {
|
|
10827
|
+
opts = opts || {};
|
|
10828
|
+
|
|
10825
10829
|
// verify the required parameter 'messageId' is set
|
|
10826
10830
|
if (messageId === undefined || messageId === null) {
|
|
10827
10831
|
throw 'Missing the required parameter "messageId" when calling getConversationsMessageDetails';
|
|
@@ -10831,7 +10835,7 @@ class ConversationsApi {
|
|
|
10831
10835
|
'/api/v2/conversations/messages/{messageId}/details',
|
|
10832
10836
|
'GET',
|
|
10833
10837
|
{ 'messageId': messageId },
|
|
10834
|
-
{
|
|
10838
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
10835
10839
|
{ },
|
|
10836
10840
|
{ },
|
|
10837
10841
|
null,
|
|
@@ -10846,8 +10850,12 @@ class ConversationsApi {
|
|
|
10846
10850
|
*
|
|
10847
10851
|
* @param {String} conversationId conversationId
|
|
10848
10852
|
* @param {String} messageId messageId
|
|
10853
|
+
* @param {Object} opts Optional parameters
|
|
10854
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
10849
10855
|
*/
|
|
10850
|
-
getConversationsMessageMessage(conversationId, messageId) {
|
|
10856
|
+
getConversationsMessageMessage(conversationId, messageId, opts) {
|
|
10857
|
+
opts = opts || {};
|
|
10858
|
+
|
|
10851
10859
|
// verify the required parameter 'conversationId' is set
|
|
10852
10860
|
if (conversationId === undefined || conversationId === null) {
|
|
10853
10861
|
throw 'Missing the required parameter "conversationId" when calling getConversationsMessageMessage';
|
|
@@ -10861,7 +10869,7 @@ class ConversationsApi {
|
|
|
10861
10869
|
'/api/v2/conversations/messages/{conversationId}/messages/{messageId}',
|
|
10862
10870
|
'GET',
|
|
10863
10871
|
{ 'conversationId': conversationId,'messageId': messageId },
|
|
10864
|
-
{
|
|
10872
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
10865
10873
|
{ },
|
|
10866
10874
|
{ },
|
|
10867
10875
|
null,
|
|
@@ -13479,6 +13487,31 @@ class ConversationsApi {
|
|
|
13479
13487
|
);
|
|
13480
13488
|
}
|
|
13481
13489
|
|
|
13490
|
+
/**
|
|
13491
|
+
* Create an email conversation, per API
|
|
13492
|
+
*
|
|
13493
|
+
* @param {Object} body Create agentless email request
|
|
13494
|
+
*/
|
|
13495
|
+
postConversationsEmailsAgentless(body) {
|
|
13496
|
+
// verify the required parameter 'body' is set
|
|
13497
|
+
if (body === undefined || body === null) {
|
|
13498
|
+
throw 'Missing the required parameter "body" when calling postConversationsEmailsAgentless';
|
|
13499
|
+
}
|
|
13500
|
+
|
|
13501
|
+
return this.apiClient.callApi(
|
|
13502
|
+
'/api/v2/conversations/emails/agentless',
|
|
13503
|
+
'POST',
|
|
13504
|
+
{ },
|
|
13505
|
+
{ },
|
|
13506
|
+
{ },
|
|
13507
|
+
{ },
|
|
13508
|
+
body,
|
|
13509
|
+
['PureCloud OAuth'],
|
|
13510
|
+
['application/json'],
|
|
13511
|
+
['application/json']
|
|
13512
|
+
);
|
|
13513
|
+
}
|
|
13514
|
+
|
|
13482
13515
|
/**
|
|
13483
13516
|
* Create Fax Conversation
|
|
13484
13517
|
*
|
|
@@ -13560,8 +13593,12 @@ class ConversationsApi {
|
|
|
13560
13593
|
* @param {String} conversationId conversationId
|
|
13561
13594
|
* @param {String} communicationId communicationId
|
|
13562
13595
|
* @param {Object} body Message
|
|
13596
|
+
* @param {Object} opts Optional parameters
|
|
13597
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
13563
13598
|
*/
|
|
13564
|
-
postConversationsMessageCommunicationMessages(conversationId, communicationId, body) {
|
|
13599
|
+
postConversationsMessageCommunicationMessages(conversationId, communicationId, body, opts) {
|
|
13600
|
+
opts = opts || {};
|
|
13601
|
+
|
|
13565
13602
|
// verify the required parameter 'conversationId' is set
|
|
13566
13603
|
if (conversationId === undefined || conversationId === null) {
|
|
13567
13604
|
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessages';
|
|
@@ -13579,7 +13616,7 @@ class ConversationsApi {
|
|
|
13579
13616
|
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages',
|
|
13580
13617
|
'POST',
|
|
13581
13618
|
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
13582
|
-
{
|
|
13619
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
13583
13620
|
{ },
|
|
13584
13621
|
{ },
|
|
13585
13622
|
body,
|
|
@@ -13619,11 +13656,47 @@ class ConversationsApi {
|
|
|
13619
13656
|
);
|
|
13620
13657
|
}
|
|
13621
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
|
+
|
|
13622
13694
|
/**
|
|
13623
13695
|
* Get messages in batch
|
|
13624
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"]
|
|
13625
13697
|
* @param {String} conversationId
|
|
13626
13698
|
* @param {Object} opts Optional parameters
|
|
13699
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
13627
13700
|
* @param {Array.<String>} opts.body messageIds
|
|
13628
13701
|
*/
|
|
13629
13702
|
postConversationsMessageMessagesBulk(conversationId, opts) {
|
|
@@ -13638,7 +13711,7 @@ class ConversationsApi {
|
|
|
13638
13711
|
'/api/v2/conversations/messages/{conversationId}/messages/bulk',
|
|
13639
13712
|
'POST',
|
|
13640
13713
|
{ 'conversationId': conversationId },
|
|
13641
|
-
{
|
|
13714
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
13642
13715
|
{ },
|
|
13643
13716
|
{ },
|
|
13644
13717
|
opts['body'],
|
|
@@ -14454,7 +14527,7 @@ class DataExtensionsApi {
|
|
|
14454
14527
|
/**
|
|
14455
14528
|
* DataExtensions service.
|
|
14456
14529
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14457
|
-
* @version
|
|
14530
|
+
* @version 151.0.0
|
|
14458
14531
|
*/
|
|
14459
14532
|
|
|
14460
14533
|
/**
|
|
@@ -14536,11 +14609,159 @@ class DataExtensionsApi {
|
|
|
14536
14609
|
|
|
14537
14610
|
}
|
|
14538
14611
|
|
|
14612
|
+
class DownloadsApi {
|
|
14613
|
+
/**
|
|
14614
|
+
* Downloads service.
|
|
14615
|
+
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14616
|
+
* @version 151.0.0
|
|
14617
|
+
*/
|
|
14618
|
+
|
|
14619
|
+
/**
|
|
14620
|
+
* Constructs a new DownloadsApi.
|
|
14621
|
+
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
14622
|
+
* @class
|
|
14623
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
14624
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
14625
|
+
*/
|
|
14626
|
+
constructor(apiClient) {
|
|
14627
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
14628
|
+
}
|
|
14629
|
+
|
|
14630
|
+
|
|
14631
|
+
/**
|
|
14632
|
+
* Issues a redirect to a signed secure download URL for specified download
|
|
14633
|
+
* this method will issue a redirect to the url to the content
|
|
14634
|
+
* @param {String} downloadId Download ID
|
|
14635
|
+
* @param {Object} opts Optional parameters
|
|
14636
|
+
* @param {String} opts.contentDisposition
|
|
14637
|
+
* @param {Boolean} opts.issueRedirect (default to true)
|
|
14638
|
+
* @param {Boolean} opts.redirectToAuth (default to true)
|
|
14639
|
+
*/
|
|
14640
|
+
getDownload(downloadId, opts) {
|
|
14641
|
+
opts = opts || {};
|
|
14642
|
+
|
|
14643
|
+
// verify the required parameter 'downloadId' is set
|
|
14644
|
+
if (downloadId === undefined || downloadId === null) {
|
|
14645
|
+
throw 'Missing the required parameter "downloadId" when calling getDownload';
|
|
14646
|
+
}
|
|
14647
|
+
|
|
14648
|
+
return this.apiClient.callApi(
|
|
14649
|
+
'/api/v2/downloads/{downloadId}',
|
|
14650
|
+
'GET',
|
|
14651
|
+
{ 'downloadId': downloadId },
|
|
14652
|
+
{ 'contentDisposition': opts['contentDisposition'],'issueRedirect': opts['issueRedirect'],'redirectToAuth': opts['redirectToAuth'] },
|
|
14653
|
+
{ },
|
|
14654
|
+
{ },
|
|
14655
|
+
null,
|
|
14656
|
+
['PureCloud OAuth'],
|
|
14657
|
+
['application/json'],
|
|
14658
|
+
['application/json']
|
|
14659
|
+
);
|
|
14660
|
+
}
|
|
14661
|
+
|
|
14662
|
+
}
|
|
14663
|
+
|
|
14664
|
+
class EventsApi {
|
|
14665
|
+
/**
|
|
14666
|
+
* Events service.
|
|
14667
|
+
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14668
|
+
* @version 151.0.0
|
|
14669
|
+
*/
|
|
14670
|
+
|
|
14671
|
+
/**
|
|
14672
|
+
* Constructs a new EventsApi.
|
|
14673
|
+
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
14674
|
+
* @class
|
|
14675
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
14676
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
14677
|
+
*/
|
|
14678
|
+
constructor(apiClient) {
|
|
14679
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
14680
|
+
}
|
|
14681
|
+
|
|
14682
|
+
|
|
14683
|
+
/**
|
|
14684
|
+
* Publish Conversation Batch Events
|
|
14685
|
+
*
|
|
14686
|
+
* @param {Object} body batchRequest
|
|
14687
|
+
*/
|
|
14688
|
+
postEventsConversations(body) {
|
|
14689
|
+
// verify the required parameter 'body' is set
|
|
14690
|
+
if (body === undefined || body === null) {
|
|
14691
|
+
throw 'Missing the required parameter "body" when calling postEventsConversations';
|
|
14692
|
+
}
|
|
14693
|
+
|
|
14694
|
+
return this.apiClient.callApi(
|
|
14695
|
+
'/api/v2/events/conversations',
|
|
14696
|
+
'POST',
|
|
14697
|
+
{ },
|
|
14698
|
+
{ },
|
|
14699
|
+
{ },
|
|
14700
|
+
{ },
|
|
14701
|
+
body,
|
|
14702
|
+
['PureCloud OAuth'],
|
|
14703
|
+
['application/json'],
|
|
14704
|
+
['application/json']
|
|
14705
|
+
);
|
|
14706
|
+
}
|
|
14707
|
+
|
|
14708
|
+
/**
|
|
14709
|
+
* Publish User Presence Status Batch Events
|
|
14710
|
+
*
|
|
14711
|
+
* @param {Object} body batchRequest
|
|
14712
|
+
*/
|
|
14713
|
+
postEventsUsersPresence(body) {
|
|
14714
|
+
// verify the required parameter 'body' is set
|
|
14715
|
+
if (body === undefined || body === null) {
|
|
14716
|
+
throw 'Missing the required parameter "body" when calling postEventsUsersPresence';
|
|
14717
|
+
}
|
|
14718
|
+
|
|
14719
|
+
return this.apiClient.callApi(
|
|
14720
|
+
'/api/v2/events/users/presence',
|
|
14721
|
+
'POST',
|
|
14722
|
+
{ },
|
|
14723
|
+
{ },
|
|
14724
|
+
{ },
|
|
14725
|
+
{ },
|
|
14726
|
+
body,
|
|
14727
|
+
['PureCloud OAuth'],
|
|
14728
|
+
['application/json'],
|
|
14729
|
+
['application/json']
|
|
14730
|
+
);
|
|
14731
|
+
}
|
|
14732
|
+
|
|
14733
|
+
/**
|
|
14734
|
+
* Publish Agent Routing Status Batch Events
|
|
14735
|
+
*
|
|
14736
|
+
* @param {Object} body batchRequest
|
|
14737
|
+
*/
|
|
14738
|
+
postEventsUsersRoutingstatus(body) {
|
|
14739
|
+
// verify the required parameter 'body' is set
|
|
14740
|
+
if (body === undefined || body === null) {
|
|
14741
|
+
throw 'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';
|
|
14742
|
+
}
|
|
14743
|
+
|
|
14744
|
+
return this.apiClient.callApi(
|
|
14745
|
+
'/api/v2/events/users/routingstatus',
|
|
14746
|
+
'POST',
|
|
14747
|
+
{ },
|
|
14748
|
+
{ },
|
|
14749
|
+
{ },
|
|
14750
|
+
{ },
|
|
14751
|
+
body,
|
|
14752
|
+
['PureCloud OAuth'],
|
|
14753
|
+
['application/json'],
|
|
14754
|
+
['application/json']
|
|
14755
|
+
);
|
|
14756
|
+
}
|
|
14757
|
+
|
|
14758
|
+
}
|
|
14759
|
+
|
|
14539
14760
|
class ExternalContactsApi {
|
|
14540
14761
|
/**
|
|
14541
14762
|
* ExternalContacts service.
|
|
14542
14763
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14543
|
-
* @version
|
|
14764
|
+
* @version 151.0.0
|
|
14544
14765
|
*/
|
|
14545
14766
|
|
|
14546
14767
|
/**
|
|
@@ -14769,6 +14990,62 @@ class ExternalContactsApi {
|
|
|
14769
14990
|
);
|
|
14770
14991
|
}
|
|
14771
14992
|
|
|
14993
|
+
/**
|
|
14994
|
+
* List the identifiers for a contact
|
|
14995
|
+
*
|
|
14996
|
+
* @param {String} contactId ExternalContact ID
|
|
14997
|
+
*/
|
|
14998
|
+
getExternalcontactsContactIdentifiers(contactId) {
|
|
14999
|
+
// verify the required parameter 'contactId' is set
|
|
15000
|
+
if (contactId === undefined || contactId === null) {
|
|
15001
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactIdentifiers';
|
|
15002
|
+
}
|
|
15003
|
+
|
|
15004
|
+
return this.apiClient.callApi(
|
|
15005
|
+
'/api/v2/externalcontacts/contacts/{contactId}/identifiers',
|
|
15006
|
+
'GET',
|
|
15007
|
+
{ 'contactId': contactId },
|
|
15008
|
+
{ },
|
|
15009
|
+
{ },
|
|
15010
|
+
{ },
|
|
15011
|
+
null,
|
|
15012
|
+
['PureCloud OAuth'],
|
|
15013
|
+
['application/json'],
|
|
15014
|
+
['application/json']
|
|
15015
|
+
);
|
|
15016
|
+
}
|
|
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
|
+
|
|
14772
15049
|
/**
|
|
14773
15050
|
* Fetch a note for an external contact
|
|
14774
15051
|
*
|
|
@@ -14835,6 +15112,35 @@ class ExternalContactsApi {
|
|
|
14835
15112
|
);
|
|
14836
15113
|
}
|
|
14837
15114
|
|
|
15115
|
+
/**
|
|
15116
|
+
* Fetch an unresolved external contact
|
|
15117
|
+
*
|
|
15118
|
+
* @param {String} contactId ExternalContact ID
|
|
15119
|
+
* @param {Object} opts Optional parameters
|
|
15120
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
15121
|
+
*/
|
|
15122
|
+
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
15123
|
+
opts = opts || {};
|
|
15124
|
+
|
|
15125
|
+
// verify the required parameter 'contactId' is set
|
|
15126
|
+
if (contactId === undefined || contactId === null) {
|
|
15127
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactUnresolved';
|
|
15128
|
+
}
|
|
15129
|
+
|
|
15130
|
+
return this.apiClient.callApi(
|
|
15131
|
+
'/api/v2/externalcontacts/contacts/{contactId}/unresolved',
|
|
15132
|
+
'GET',
|
|
15133
|
+
{ 'contactId': contactId },
|
|
15134
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
15135
|
+
{ },
|
|
15136
|
+
{ },
|
|
15137
|
+
null,
|
|
15138
|
+
['PureCloud OAuth'],
|
|
15139
|
+
['application/json'],
|
|
15140
|
+
['application/json']
|
|
15141
|
+
);
|
|
15142
|
+
}
|
|
15143
|
+
|
|
14838
15144
|
/**
|
|
14839
15145
|
* Search for external contacts
|
|
14840
15146
|
*
|
|
@@ -15412,6 +15718,36 @@ class ExternalContactsApi {
|
|
|
15412
15718
|
);
|
|
15413
15719
|
}
|
|
15414
15720
|
|
|
15721
|
+
/**
|
|
15722
|
+
* Claim or release identifiers for a contact
|
|
15723
|
+
*
|
|
15724
|
+
* @param {String} contactId ExternalContact ID
|
|
15725
|
+
* @param {Object} body ClaimRequest
|
|
15726
|
+
*/
|
|
15727
|
+
patchExternalcontactsContactIdentifiers(contactId, body) {
|
|
15728
|
+
// verify the required parameter 'contactId' is set
|
|
15729
|
+
if (contactId === undefined || contactId === null) {
|
|
15730
|
+
throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContactIdentifiers';
|
|
15731
|
+
}
|
|
15732
|
+
// verify the required parameter 'body' is set
|
|
15733
|
+
if (body === undefined || body === null) {
|
|
15734
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsContactIdentifiers';
|
|
15735
|
+
}
|
|
15736
|
+
|
|
15737
|
+
return this.apiClient.callApi(
|
|
15738
|
+
'/api/v2/externalcontacts/contacts/{contactId}/identifiers',
|
|
15739
|
+
'PATCH',
|
|
15740
|
+
{ 'contactId': contactId },
|
|
15741
|
+
{ },
|
|
15742
|
+
{ },
|
|
15743
|
+
{ },
|
|
15744
|
+
body,
|
|
15745
|
+
['PureCloud OAuth'],
|
|
15746
|
+
['application/json'],
|
|
15747
|
+
['application/json']
|
|
15748
|
+
);
|
|
15749
|
+
}
|
|
15750
|
+
|
|
15415
15751
|
/**
|
|
15416
15752
|
* Bulk fetch contacts
|
|
15417
15753
|
*
|
|
@@ -15487,6 +15823,31 @@ class ExternalContactsApi {
|
|
|
15487
15823
|
);
|
|
15488
15824
|
}
|
|
15489
15825
|
|
|
15826
|
+
/**
|
|
15827
|
+
* Bulk fetch unresolved ancestor contacts
|
|
15828
|
+
*
|
|
15829
|
+
* @param {Object} body Contact ids
|
|
15830
|
+
*/
|
|
15831
|
+
postExternalcontactsBulkContactsUnresolved(body) {
|
|
15832
|
+
// verify the required parameter 'body' is set
|
|
15833
|
+
if (body === undefined || body === null) {
|
|
15834
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsUnresolved';
|
|
15835
|
+
}
|
|
15836
|
+
|
|
15837
|
+
return this.apiClient.callApi(
|
|
15838
|
+
'/api/v2/externalcontacts/bulk/contacts/unresolved',
|
|
15839
|
+
'POST',
|
|
15840
|
+
{ },
|
|
15841
|
+
{ },
|
|
15842
|
+
{ },
|
|
15843
|
+
{ },
|
|
15844
|
+
body,
|
|
15845
|
+
['PureCloud OAuth'],
|
|
15846
|
+
['application/json'],
|
|
15847
|
+
['application/json']
|
|
15848
|
+
);
|
|
15849
|
+
}
|
|
15850
|
+
|
|
15490
15851
|
/**
|
|
15491
15852
|
* Bulk update contacts
|
|
15492
15853
|
*
|
|
@@ -15842,6 +16203,31 @@ class ExternalContactsApi {
|
|
|
15842
16203
|
);
|
|
15843
16204
|
}
|
|
15844
16205
|
|
|
16206
|
+
/**
|
|
16207
|
+
* Promote an observed contact (ephemeral or identified) to a curated contact
|
|
16208
|
+
*
|
|
16209
|
+
* @param {String} contactId ExternalContact ID
|
|
16210
|
+
*/
|
|
16211
|
+
postExternalcontactsContactPromotion(contactId) {
|
|
16212
|
+
// verify the required parameter 'contactId' is set
|
|
16213
|
+
if (contactId === undefined || contactId === null) {
|
|
16214
|
+
throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactPromotion';
|
|
16215
|
+
}
|
|
16216
|
+
|
|
16217
|
+
return this.apiClient.callApi(
|
|
16218
|
+
'/api/v2/externalcontacts/contacts/{contactId}/promotion',
|
|
16219
|
+
'POST',
|
|
16220
|
+
{ 'contactId': contactId },
|
|
16221
|
+
{ },
|
|
16222
|
+
{ },
|
|
16223
|
+
{ },
|
|
16224
|
+
null,
|
|
16225
|
+
['PureCloud OAuth'],
|
|
16226
|
+
['application/json'],
|
|
16227
|
+
['application/json']
|
|
16228
|
+
);
|
|
16229
|
+
}
|
|
16230
|
+
|
|
15845
16231
|
/**
|
|
15846
16232
|
* Create an external contact
|
|
15847
16233
|
*
|
|
@@ -15892,6 +16278,56 @@ class ExternalContactsApi {
|
|
|
15892
16278
|
);
|
|
15893
16279
|
}
|
|
15894
16280
|
|
|
16281
|
+
/**
|
|
16282
|
+
* Fetch a contact using an identifier type and value.
|
|
16283
|
+
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
16284
|
+
* @param {Object} identifier
|
|
16285
|
+
*/
|
|
16286
|
+
postExternalcontactsIdentifierlookup(identifier) {
|
|
16287
|
+
// verify the required parameter 'identifier' is set
|
|
16288
|
+
if (identifier === undefined || identifier === null) {
|
|
16289
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';
|
|
16290
|
+
}
|
|
16291
|
+
|
|
16292
|
+
return this.apiClient.callApi(
|
|
16293
|
+
'/api/v2/externalcontacts/identifierlookup',
|
|
16294
|
+
'POST',
|
|
16295
|
+
{ },
|
|
16296
|
+
{ },
|
|
16297
|
+
{ },
|
|
16298
|
+
{ },
|
|
16299
|
+
identifier,
|
|
16300
|
+
['PureCloud OAuth'],
|
|
16301
|
+
['application/json'],
|
|
16302
|
+
['application/json']
|
|
16303
|
+
);
|
|
16304
|
+
}
|
|
16305
|
+
|
|
16306
|
+
/**
|
|
16307
|
+
* Merge two contacts into a new contact record
|
|
16308
|
+
*
|
|
16309
|
+
* @param {Object} body MergeRequest
|
|
16310
|
+
*/
|
|
16311
|
+
postExternalcontactsMergeContacts(body) {
|
|
16312
|
+
// verify the required parameter 'body' is set
|
|
16313
|
+
if (body === undefined || body === null) {
|
|
16314
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsMergeContacts';
|
|
16315
|
+
}
|
|
16316
|
+
|
|
16317
|
+
return this.apiClient.callApi(
|
|
16318
|
+
'/api/v2/externalcontacts/merge/contacts',
|
|
16319
|
+
'POST',
|
|
16320
|
+
{ },
|
|
16321
|
+
{ },
|
|
16322
|
+
{ },
|
|
16323
|
+
{ },
|
|
16324
|
+
body,
|
|
16325
|
+
['PureCloud OAuth'],
|
|
16326
|
+
['application/json'],
|
|
16327
|
+
['application/json']
|
|
16328
|
+
);
|
|
16329
|
+
}
|
|
16330
|
+
|
|
15895
16331
|
/**
|
|
15896
16332
|
* Create a note for an external organization
|
|
15897
16333
|
*
|
|
@@ -16283,7 +16719,7 @@ class FaxApi {
|
|
|
16283
16719
|
/**
|
|
16284
16720
|
* Fax service.
|
|
16285
16721
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16286
|
-
* @version
|
|
16722
|
+
* @version 151.0.0
|
|
16287
16723
|
*/
|
|
16288
16724
|
|
|
16289
16725
|
/**
|
|
@@ -16454,7 +16890,7 @@ class FlowsApi {
|
|
|
16454
16890
|
/**
|
|
16455
16891
|
* Flows service.
|
|
16456
16892
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16457
|
-
* @version
|
|
16893
|
+
* @version 151.0.0
|
|
16458
16894
|
*/
|
|
16459
16895
|
|
|
16460
16896
|
/**
|
|
@@ -16525,7 +16961,7 @@ class GamificationApi {
|
|
|
16525
16961
|
/**
|
|
16526
16962
|
* Gamification service.
|
|
16527
16963
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16528
|
-
* @version
|
|
16964
|
+
* @version 151.0.0
|
|
16529
16965
|
*/
|
|
16530
16966
|
|
|
16531
16967
|
/**
|
|
@@ -18206,7 +18642,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18206
18642
|
/**
|
|
18207
18643
|
* GeneralDataProtectionRegulation service.
|
|
18208
18644
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18209
|
-
* @version
|
|
18645
|
+
* @version 151.0.0
|
|
18210
18646
|
*/
|
|
18211
18647
|
|
|
18212
18648
|
/**
|
|
@@ -18336,7 +18772,7 @@ class GeolocationApi {
|
|
|
18336
18772
|
/**
|
|
18337
18773
|
* Geolocation service.
|
|
18338
18774
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18339
|
-
* @version
|
|
18775
|
+
* @version 151.0.0
|
|
18340
18776
|
*/
|
|
18341
18777
|
|
|
18342
18778
|
/**
|
|
@@ -18467,7 +18903,7 @@ class GreetingsApi {
|
|
|
18467
18903
|
/**
|
|
18468
18904
|
* Greetings service.
|
|
18469
18905
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18470
|
-
* @version
|
|
18906
|
+
* @version 151.0.0
|
|
18471
18907
|
*/
|
|
18472
18908
|
|
|
18473
18909
|
/**
|
|
@@ -18922,7 +19358,7 @@ class GroupsApi {
|
|
|
18922
19358
|
/**
|
|
18923
19359
|
* Groups service.
|
|
18924
19360
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18925
|
-
* @version
|
|
19361
|
+
* @version 151.0.0
|
|
18926
19362
|
*/
|
|
18927
19363
|
|
|
18928
19364
|
/**
|
|
@@ -19328,7 +19764,7 @@ class IdentityProviderApi {
|
|
|
19328
19764
|
/**
|
|
19329
19765
|
* IdentityProvider service.
|
|
19330
19766
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19331
|
-
* @version
|
|
19767
|
+
* @version 151.0.0
|
|
19332
19768
|
*/
|
|
19333
19769
|
|
|
19334
19770
|
/**
|
|
@@ -20084,7 +20520,7 @@ class IntegrationsApi {
|
|
|
20084
20520
|
/**
|
|
20085
20521
|
* Integrations service.
|
|
20086
20522
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20087
|
-
* @version
|
|
20523
|
+
* @version 151.0.0
|
|
20088
20524
|
*/
|
|
20089
20525
|
|
|
20090
20526
|
/**
|
|
@@ -21684,7 +22120,7 @@ class JourneyApi {
|
|
|
21684
22120
|
/**
|
|
21685
22121
|
* Journey service.
|
|
21686
22122
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
21687
|
-
* @version
|
|
22123
|
+
* @version 151.0.0
|
|
21688
22124
|
*/
|
|
21689
22125
|
|
|
21690
22126
|
/**
|
|
@@ -22470,7 +22906,7 @@ class KnowledgeApi {
|
|
|
22470
22906
|
/**
|
|
22471
22907
|
* Knowledge service.
|
|
22472
22908
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22473
|
-
* @version
|
|
22909
|
+
* @version 151.0.0
|
|
22474
22910
|
*/
|
|
22475
22911
|
|
|
22476
22912
|
/**
|
|
@@ -24903,7 +25339,7 @@ class LanguageUnderstandingApi {
|
|
|
24903
25339
|
/**
|
|
24904
25340
|
* LanguageUnderstanding service.
|
|
24905
25341
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
24906
|
-
* @version
|
|
25342
|
+
* @version 151.0.0
|
|
24907
25343
|
*/
|
|
24908
25344
|
|
|
24909
25345
|
/**
|
|
@@ -25807,7 +26243,7 @@ class LanguagesApi {
|
|
|
25807
26243
|
/**
|
|
25808
26244
|
* Languages service.
|
|
25809
26245
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
25810
|
-
* @version
|
|
26246
|
+
* @version 151.0.0
|
|
25811
26247
|
*/
|
|
25812
26248
|
|
|
25813
26249
|
/**
|
|
@@ -26075,7 +26511,7 @@ class LearningApi {
|
|
|
26075
26511
|
/**
|
|
26076
26512
|
* Learning service.
|
|
26077
26513
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26078
|
-
* @version
|
|
26514
|
+
* @version 151.0.0
|
|
26079
26515
|
*/
|
|
26080
26516
|
|
|
26081
26517
|
/**
|
|
@@ -26835,7 +27271,7 @@ class LicenseApi {
|
|
|
26835
27271
|
/**
|
|
26836
27272
|
* License service.
|
|
26837
27273
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
26838
|
-
* @version
|
|
27274
|
+
* @version 151.0.0
|
|
26839
27275
|
*/
|
|
26840
27276
|
|
|
26841
27277
|
/**
|
|
@@ -27073,7 +27509,7 @@ class LocationsApi {
|
|
|
27073
27509
|
/**
|
|
27074
27510
|
* Locations service.
|
|
27075
27511
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27076
|
-
* @version
|
|
27512
|
+
* @version 151.0.0
|
|
27077
27513
|
*/
|
|
27078
27514
|
|
|
27079
27515
|
/**
|
|
@@ -27309,7 +27745,7 @@ class MessagingApi {
|
|
|
27309
27745
|
/**
|
|
27310
27746
|
* Messaging service.
|
|
27311
27747
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27312
|
-
* @version
|
|
27748
|
+
* @version 151.0.0
|
|
27313
27749
|
*/
|
|
27314
27750
|
|
|
27315
27751
|
/**
|
|
@@ -27460,7 +27896,7 @@ class MobileDevicesApi {
|
|
|
27460
27896
|
/**
|
|
27461
27897
|
* MobileDevices service.
|
|
27462
27898
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27463
|
-
* @version
|
|
27899
|
+
* @version 151.0.0
|
|
27464
27900
|
*/
|
|
27465
27901
|
|
|
27466
27902
|
/**
|
|
@@ -27611,7 +28047,7 @@ class NotificationsApi {
|
|
|
27611
28047
|
/**
|
|
27612
28048
|
* Notifications service.
|
|
27613
28049
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
27614
|
-
* @version
|
|
28050
|
+
* @version 151.0.0
|
|
27615
28051
|
*/
|
|
27616
28052
|
|
|
27617
28053
|
/**
|
|
@@ -27836,7 +28272,7 @@ class OAuthApi {
|
|
|
27836
28272
|
/**
|
|
27837
28273
|
* OAuth service.
|
|
27838
28274
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
27839
|
-
* @version
|
|
28275
|
+
* @version 151.0.0
|
|
27840
28276
|
*/
|
|
27841
28277
|
|
|
27842
28278
|
/**
|
|
@@ -28202,7 +28638,7 @@ class ObjectsApi {
|
|
|
28202
28638
|
/**
|
|
28203
28639
|
* Objects service.
|
|
28204
28640
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28205
|
-
* @version
|
|
28641
|
+
* @version 151.0.0
|
|
28206
28642
|
*/
|
|
28207
28643
|
|
|
28208
28644
|
/**
|
|
@@ -28473,7 +28909,7 @@ class OrganizationApi {
|
|
|
28473
28909
|
/**
|
|
28474
28910
|
* Organization service.
|
|
28475
28911
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28476
|
-
* @version
|
|
28912
|
+
* @version 151.0.0
|
|
28477
28913
|
*/
|
|
28478
28914
|
|
|
28479
28915
|
/**
|
|
@@ -28876,7 +29312,7 @@ class OrganizationAuthorizationApi {
|
|
|
28876
29312
|
/**
|
|
28877
29313
|
* OrganizationAuthorization service.
|
|
28878
29314
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
28879
|
-
* @version
|
|
29315
|
+
* @version 151.0.0
|
|
28880
29316
|
*/
|
|
28881
29317
|
|
|
28882
29318
|
/**
|
|
@@ -29801,7 +30237,7 @@ class OutboundApi {
|
|
|
29801
30237
|
/**
|
|
29802
30238
|
* Outbound service.
|
|
29803
30239
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
29804
|
-
* @version
|
|
30240
|
+
* @version 151.0.0
|
|
29805
30241
|
*/
|
|
29806
30242
|
|
|
29807
30243
|
/**
|
|
@@ -33190,7 +33626,7 @@ class PresenceApi {
|
|
|
33190
33626
|
/**
|
|
33191
33627
|
* Presence service.
|
|
33192
33628
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33193
|
-
* @version
|
|
33629
|
+
* @version 151.0.0
|
|
33194
33630
|
*/
|
|
33195
33631
|
|
|
33196
33632
|
/**
|
|
@@ -33205,6 +33641,31 @@ class PresenceApi {
|
|
|
33205
33641
|
}
|
|
33206
33642
|
|
|
33207
33643
|
|
|
33644
|
+
/**
|
|
33645
|
+
* Delete a Presence Source
|
|
33646
|
+
*
|
|
33647
|
+
* @param {String} sourceId Presence Source ID
|
|
33648
|
+
*/
|
|
33649
|
+
deletePresenceSource(sourceId) {
|
|
33650
|
+
// verify the required parameter 'sourceId' is set
|
|
33651
|
+
if (sourceId === undefined || sourceId === null) {
|
|
33652
|
+
throw 'Missing the required parameter "sourceId" when calling deletePresenceSource';
|
|
33653
|
+
}
|
|
33654
|
+
|
|
33655
|
+
return this.apiClient.callApi(
|
|
33656
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
33657
|
+
'DELETE',
|
|
33658
|
+
{ 'sourceId': sourceId },
|
|
33659
|
+
{ },
|
|
33660
|
+
{ },
|
|
33661
|
+
{ },
|
|
33662
|
+
null,
|
|
33663
|
+
['PureCloud OAuth'],
|
|
33664
|
+
['application/json'],
|
|
33665
|
+
['application/json']
|
|
33666
|
+
);
|
|
33667
|
+
}
|
|
33668
|
+
|
|
33208
33669
|
/**
|
|
33209
33670
|
* Delete a Presence Definition
|
|
33210
33671
|
*
|
|
@@ -33230,6 +33691,80 @@ class PresenceApi {
|
|
|
33230
33691
|
);
|
|
33231
33692
|
}
|
|
33232
33693
|
|
|
33694
|
+
/**
|
|
33695
|
+
* Get a Presence Source
|
|
33696
|
+
*
|
|
33697
|
+
* @param {String} sourceId Presence Source ID
|
|
33698
|
+
*/
|
|
33699
|
+
getPresenceSource(sourceId) {
|
|
33700
|
+
// verify the required parameter 'sourceId' is set
|
|
33701
|
+
if (sourceId === undefined || sourceId === null) {
|
|
33702
|
+
throw 'Missing the required parameter "sourceId" when calling getPresenceSource';
|
|
33703
|
+
}
|
|
33704
|
+
|
|
33705
|
+
return this.apiClient.callApi(
|
|
33706
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
33707
|
+
'GET',
|
|
33708
|
+
{ 'sourceId': sourceId },
|
|
33709
|
+
{ },
|
|
33710
|
+
{ },
|
|
33711
|
+
{ },
|
|
33712
|
+
null,
|
|
33713
|
+
['PureCloud OAuth'],
|
|
33714
|
+
['application/json'],
|
|
33715
|
+
['application/json']
|
|
33716
|
+
);
|
|
33717
|
+
}
|
|
33718
|
+
|
|
33719
|
+
/**
|
|
33720
|
+
* Get a list of Presence Sources
|
|
33721
|
+
*
|
|
33722
|
+
* @param {Object} opts Optional parameters
|
|
33723
|
+
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
33724
|
+
*/
|
|
33725
|
+
getPresenceSources(opts) {
|
|
33726
|
+
opts = opts || {};
|
|
33727
|
+
|
|
33728
|
+
|
|
33729
|
+
return this.apiClient.callApi(
|
|
33730
|
+
'/api/v2/presence/sources',
|
|
33731
|
+
'GET',
|
|
33732
|
+
{ },
|
|
33733
|
+
{ 'deactivated': opts['deactivated'] },
|
|
33734
|
+
{ },
|
|
33735
|
+
{ },
|
|
33736
|
+
null,
|
|
33737
|
+
['PureCloud OAuth'],
|
|
33738
|
+
['application/json'],
|
|
33739
|
+
['application/json']
|
|
33740
|
+
);
|
|
33741
|
+
}
|
|
33742
|
+
|
|
33743
|
+
/**
|
|
33744
|
+
* Get a user's Primary Presence Source
|
|
33745
|
+
*
|
|
33746
|
+
* @param {String} userId user ID
|
|
33747
|
+
*/
|
|
33748
|
+
getPresenceUserPrimarysource(userId) {
|
|
33749
|
+
// verify the required parameter 'userId' is set
|
|
33750
|
+
if (userId === undefined || userId === null) {
|
|
33751
|
+
throw 'Missing the required parameter "userId" when calling getPresenceUserPrimarysource';
|
|
33752
|
+
}
|
|
33753
|
+
|
|
33754
|
+
return this.apiClient.callApi(
|
|
33755
|
+
'/api/v2/presence/users/{userId}/primarysource',
|
|
33756
|
+
'GET',
|
|
33757
|
+
{ 'userId': userId },
|
|
33758
|
+
{ },
|
|
33759
|
+
{ },
|
|
33760
|
+
{ },
|
|
33761
|
+
null,
|
|
33762
|
+
['PureCloud OAuth'],
|
|
33763
|
+
['application/json'],
|
|
33764
|
+
['application/json']
|
|
33765
|
+
);
|
|
33766
|
+
}
|
|
33767
|
+
|
|
33233
33768
|
/**
|
|
33234
33769
|
* Get a Presence Definition
|
|
33235
33770
|
*
|
|
@@ -33426,6 +33961,31 @@ class PresenceApi {
|
|
|
33426
33961
|
);
|
|
33427
33962
|
}
|
|
33428
33963
|
|
|
33964
|
+
/**
|
|
33965
|
+
* Create a Presence Source
|
|
33966
|
+
*
|
|
33967
|
+
* @param {Object} body The Presence Source to create
|
|
33968
|
+
*/
|
|
33969
|
+
postPresenceSources(body) {
|
|
33970
|
+
// verify the required parameter 'body' is set
|
|
33971
|
+
if (body === undefined || body === null) {
|
|
33972
|
+
throw 'Missing the required parameter "body" when calling postPresenceSources';
|
|
33973
|
+
}
|
|
33974
|
+
|
|
33975
|
+
return this.apiClient.callApi(
|
|
33976
|
+
'/api/v2/presence/sources',
|
|
33977
|
+
'POST',
|
|
33978
|
+
{ },
|
|
33979
|
+
{ },
|
|
33980
|
+
{ },
|
|
33981
|
+
{ },
|
|
33982
|
+
body,
|
|
33983
|
+
['PureCloud OAuth'],
|
|
33984
|
+
['application/json'],
|
|
33985
|
+
['application/json']
|
|
33986
|
+
);
|
|
33987
|
+
}
|
|
33988
|
+
|
|
33429
33989
|
/**
|
|
33430
33990
|
* Create a Presence Definition
|
|
33431
33991
|
*
|
|
@@ -33451,6 +34011,66 @@ class PresenceApi {
|
|
|
33451
34011
|
);
|
|
33452
34012
|
}
|
|
33453
34013
|
|
|
34014
|
+
/**
|
|
34015
|
+
* Update a Presence Source
|
|
34016
|
+
*
|
|
34017
|
+
* @param {String} sourceId Presence Source ID
|
|
34018
|
+
* @param {Object} body The updated Presence Source
|
|
34019
|
+
*/
|
|
34020
|
+
putPresenceSource(sourceId, body) {
|
|
34021
|
+
// verify the required parameter 'sourceId' is set
|
|
34022
|
+
if (sourceId === undefined || sourceId === null) {
|
|
34023
|
+
throw 'Missing the required parameter "sourceId" when calling putPresenceSource';
|
|
34024
|
+
}
|
|
34025
|
+
// verify the required parameter 'body' is set
|
|
34026
|
+
if (body === undefined || body === null) {
|
|
34027
|
+
throw 'Missing the required parameter "body" when calling putPresenceSource';
|
|
34028
|
+
}
|
|
34029
|
+
|
|
34030
|
+
return this.apiClient.callApi(
|
|
34031
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
34032
|
+
'PUT',
|
|
34033
|
+
{ 'sourceId': sourceId },
|
|
34034
|
+
{ },
|
|
34035
|
+
{ },
|
|
34036
|
+
{ },
|
|
34037
|
+
body,
|
|
34038
|
+
['PureCloud OAuth'],
|
|
34039
|
+
['application/json'],
|
|
34040
|
+
['application/json']
|
|
34041
|
+
);
|
|
34042
|
+
}
|
|
34043
|
+
|
|
34044
|
+
/**
|
|
34045
|
+
* Update a user's Primary Presence Source
|
|
34046
|
+
*
|
|
34047
|
+
* @param {String} userId user ID
|
|
34048
|
+
* @param {Object} body Primary Source
|
|
34049
|
+
*/
|
|
34050
|
+
putPresenceUserPrimarysource(userId, body) {
|
|
34051
|
+
// verify the required parameter 'userId' is set
|
|
34052
|
+
if (userId === undefined || userId === null) {
|
|
34053
|
+
throw 'Missing the required parameter "userId" when calling putPresenceUserPrimarysource';
|
|
34054
|
+
}
|
|
34055
|
+
// verify the required parameter 'body' is set
|
|
34056
|
+
if (body === undefined || body === null) {
|
|
34057
|
+
throw 'Missing the required parameter "body" when calling putPresenceUserPrimarysource';
|
|
34058
|
+
}
|
|
34059
|
+
|
|
34060
|
+
return this.apiClient.callApi(
|
|
34061
|
+
'/api/v2/presence/users/{userId}/primarysource',
|
|
34062
|
+
'PUT',
|
|
34063
|
+
{ 'userId': userId },
|
|
34064
|
+
{ },
|
|
34065
|
+
{ },
|
|
34066
|
+
{ },
|
|
34067
|
+
body,
|
|
34068
|
+
['PureCloud OAuth'],
|
|
34069
|
+
['application/json'],
|
|
34070
|
+
['application/json']
|
|
34071
|
+
);
|
|
34072
|
+
}
|
|
34073
|
+
|
|
33454
34074
|
/**
|
|
33455
34075
|
* Update a Presence Definition
|
|
33456
34076
|
*
|
|
@@ -33512,7 +34132,7 @@ class ProcessAutomationApi {
|
|
|
33512
34132
|
/**
|
|
33513
34133
|
* ProcessAutomation service.
|
|
33514
34134
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
33515
|
-
* @version
|
|
34135
|
+
* @version 151.0.0
|
|
33516
34136
|
*/
|
|
33517
34137
|
|
|
33518
34138
|
/**
|
|
@@ -33553,7 +34173,7 @@ class ProcessAutomationApi {
|
|
|
33553
34173
|
}
|
|
33554
34174
|
|
|
33555
34175
|
/**
|
|
33556
|
-
* Retrieve a single Trigger matching id
|
|
34176
|
+
* Retrieve a single Trigger matching id
|
|
33557
34177
|
*
|
|
33558
34178
|
* @param {String} triggerId triggerId
|
|
33559
34179
|
*/
|
|
@@ -33578,13 +34198,13 @@ class ProcessAutomationApi {
|
|
|
33578
34198
|
}
|
|
33579
34199
|
|
|
33580
34200
|
/**
|
|
33581
|
-
* Retrieves all triggers
|
|
34201
|
+
* Retrieves all triggers, optionally filtered by query parameters.
|
|
33582
34202
|
*
|
|
33583
34203
|
* @param {Object} opts Optional parameters
|
|
33584
34204
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
33585
34205
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
33586
34206
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
33587
|
-
* @param {String} opts.topicName Topic name
|
|
34207
|
+
* @param {String} opts.topicName Topic name(s). Separated by commas
|
|
33588
34208
|
* @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
|
|
33589
34209
|
*/
|
|
33590
34210
|
getProcessautomationTriggers(opts) {
|
|
@@ -33750,7 +34370,7 @@ class QualityApi {
|
|
|
33750
34370
|
/**
|
|
33751
34371
|
* Quality service.
|
|
33752
34372
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
33753
|
-
* @version
|
|
34373
|
+
* @version 151.0.0
|
|
33754
34374
|
*/
|
|
33755
34375
|
|
|
33756
34376
|
/**
|
|
@@ -35328,7 +35948,7 @@ class RecordingApi {
|
|
|
35328
35948
|
/**
|
|
35329
35949
|
* Recording service.
|
|
35330
35950
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35331
|
-
* @version
|
|
35951
|
+
* @version 151.0.0
|
|
35332
35952
|
*/
|
|
35333
35953
|
|
|
35334
35954
|
/**
|
|
@@ -36433,7 +37053,7 @@ class RecordingApi {
|
|
|
36433
37053
|
|
|
36434
37054
|
/**
|
|
36435
37055
|
* Create a recording bulk job.
|
|
36436
|
-
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
37056
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected.
|
|
36437
37057
|
* @param {Object} body query
|
|
36438
37058
|
*/
|
|
36439
37059
|
postRecordingJobs(body) {
|
|
@@ -37015,7 +37635,7 @@ class ResponseManagementApi {
|
|
|
37015
37635
|
/**
|
|
37016
37636
|
* ResponseManagement service.
|
|
37017
37637
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37018
|
-
* @version
|
|
37638
|
+
* @version 151.0.0
|
|
37019
37639
|
*/
|
|
37020
37640
|
|
|
37021
37641
|
/**
|
|
@@ -37499,7 +38119,7 @@ class RoutingApi {
|
|
|
37499
38119
|
/**
|
|
37500
38120
|
* Routing service.
|
|
37501
38121
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
37502
|
-
* @version
|
|
38122
|
+
* @version 151.0.0
|
|
37503
38123
|
*/
|
|
37504
38124
|
|
|
37505
38125
|
/**
|
|
@@ -37594,6 +38214,31 @@ class RoutingApi {
|
|
|
37594
38214
|
);
|
|
37595
38215
|
}
|
|
37596
38216
|
|
|
38217
|
+
/**
|
|
38218
|
+
* Delete an outbound domain
|
|
38219
|
+
*
|
|
38220
|
+
* @param {String} domainId domain ID
|
|
38221
|
+
*/
|
|
38222
|
+
deleteRoutingEmailOutboundDomain(domainId) {
|
|
38223
|
+
// verify the required parameter 'domainId' is set
|
|
38224
|
+
if (domainId === undefined || domainId === null) {
|
|
38225
|
+
throw 'Missing the required parameter "domainId" when calling deleteRoutingEmailOutboundDomain';
|
|
38226
|
+
}
|
|
38227
|
+
|
|
38228
|
+
return this.apiClient.callApi(
|
|
38229
|
+
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
38230
|
+
'DELETE',
|
|
38231
|
+
{ 'domainId': domainId },
|
|
38232
|
+
{ },
|
|
38233
|
+
{ },
|
|
38234
|
+
{ },
|
|
38235
|
+
null,
|
|
38236
|
+
['PureCloud OAuth'],
|
|
38237
|
+
['application/json'],
|
|
38238
|
+
['application/json']
|
|
38239
|
+
);
|
|
38240
|
+
}
|
|
38241
|
+
|
|
37597
38242
|
/**
|
|
37598
38243
|
* Delete single predictor.
|
|
37599
38244
|
*
|
|
@@ -38195,6 +38840,101 @@ class RoutingApi {
|
|
|
38195
38840
|
);
|
|
38196
38841
|
}
|
|
38197
38842
|
|
|
38843
|
+
/**
|
|
38844
|
+
* Get domain
|
|
38845
|
+
*
|
|
38846
|
+
* @param {String} domainId domain ID
|
|
38847
|
+
*/
|
|
38848
|
+
getRoutingEmailOutboundDomain(domainId) {
|
|
38849
|
+
// verify the required parameter 'domainId' is set
|
|
38850
|
+
if (domainId === undefined || domainId === null) {
|
|
38851
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomain';
|
|
38852
|
+
}
|
|
38853
|
+
|
|
38854
|
+
return this.apiClient.callApi(
|
|
38855
|
+
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
38856
|
+
'GET',
|
|
38857
|
+
{ 'domainId': domainId },
|
|
38858
|
+
{ },
|
|
38859
|
+
{ },
|
|
38860
|
+
{ },
|
|
38861
|
+
null,
|
|
38862
|
+
['PureCloud OAuth'],
|
|
38863
|
+
['application/json'],
|
|
38864
|
+
['application/json']
|
|
38865
|
+
);
|
|
38866
|
+
}
|
|
38867
|
+
|
|
38868
|
+
/**
|
|
38869
|
+
* Get activation status (cname + dkim) of an outbound domain
|
|
38870
|
+
*
|
|
38871
|
+
* @param {String} domainId domain ID
|
|
38872
|
+
*/
|
|
38873
|
+
getRoutingEmailOutboundDomainActivation(domainId) {
|
|
38874
|
+
// verify the required parameter 'domainId' is set
|
|
38875
|
+
if (domainId === undefined || domainId === null) {
|
|
38876
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainActivation';
|
|
38877
|
+
}
|
|
38878
|
+
|
|
38879
|
+
return this.apiClient.callApi(
|
|
38880
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/activation',
|
|
38881
|
+
'GET',
|
|
38882
|
+
{ 'domainId': domainId },
|
|
38883
|
+
{ },
|
|
38884
|
+
{ },
|
|
38885
|
+
{ },
|
|
38886
|
+
null,
|
|
38887
|
+
['PureCloud OAuth'],
|
|
38888
|
+
['application/json'],
|
|
38889
|
+
['application/json']
|
|
38890
|
+
);
|
|
38891
|
+
}
|
|
38892
|
+
|
|
38893
|
+
/**
|
|
38894
|
+
* Search a domain across organizations
|
|
38895
|
+
*
|
|
38896
|
+
* @param {String} domainId domain ID
|
|
38897
|
+
*/
|
|
38898
|
+
getRoutingEmailOutboundDomainSearch(domainId) {
|
|
38899
|
+
// verify the required parameter 'domainId' is set
|
|
38900
|
+
if (domainId === undefined || domainId === null) {
|
|
38901
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainSearch';
|
|
38902
|
+
}
|
|
38903
|
+
|
|
38904
|
+
return this.apiClient.callApi(
|
|
38905
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/search',
|
|
38906
|
+
'GET',
|
|
38907
|
+
{ 'domainId': domainId },
|
|
38908
|
+
{ },
|
|
38909
|
+
{ },
|
|
38910
|
+
{ },
|
|
38911
|
+
null,
|
|
38912
|
+
['PureCloud OAuth'],
|
|
38913
|
+
['application/json'],
|
|
38914
|
+
['application/json']
|
|
38915
|
+
);
|
|
38916
|
+
}
|
|
38917
|
+
|
|
38918
|
+
/**
|
|
38919
|
+
* Get outbound domains
|
|
38920
|
+
*
|
|
38921
|
+
*/
|
|
38922
|
+
getRoutingEmailOutboundDomains() {
|
|
38923
|
+
|
|
38924
|
+
return this.apiClient.callApi(
|
|
38925
|
+
'/api/v2/routing/email/outbound/domains',
|
|
38926
|
+
'GET',
|
|
38927
|
+
{ },
|
|
38928
|
+
{ },
|
|
38929
|
+
{ },
|
|
38930
|
+
{ },
|
|
38931
|
+
null,
|
|
38932
|
+
['PureCloud OAuth'],
|
|
38933
|
+
['application/json'],
|
|
38934
|
+
['application/json']
|
|
38935
|
+
);
|
|
38936
|
+
}
|
|
38937
|
+
|
|
38198
38938
|
/**
|
|
38199
38939
|
* Get email setup
|
|
38200
38940
|
*
|
|
@@ -39832,6 +40572,56 @@ class RoutingApi {
|
|
|
39832
40572
|
);
|
|
39833
40573
|
}
|
|
39834
40574
|
|
|
40575
|
+
/**
|
|
40576
|
+
* Create a domain
|
|
40577
|
+
*
|
|
40578
|
+
* @param {Object} body Domain
|
|
40579
|
+
*/
|
|
40580
|
+
postRoutingEmailOutboundDomains(body) {
|
|
40581
|
+
// verify the required parameter 'body' is set
|
|
40582
|
+
if (body === undefined || body === null) {
|
|
40583
|
+
throw 'Missing the required parameter "body" when calling postRoutingEmailOutboundDomains';
|
|
40584
|
+
}
|
|
40585
|
+
|
|
40586
|
+
return this.apiClient.callApi(
|
|
40587
|
+
'/api/v2/routing/email/outbound/domains',
|
|
40588
|
+
'POST',
|
|
40589
|
+
{ },
|
|
40590
|
+
{ },
|
|
40591
|
+
{ },
|
|
40592
|
+
{ },
|
|
40593
|
+
body,
|
|
40594
|
+
['PureCloud OAuth'],
|
|
40595
|
+
['application/json'],
|
|
40596
|
+
['application/json']
|
|
40597
|
+
);
|
|
40598
|
+
}
|
|
40599
|
+
|
|
40600
|
+
/**
|
|
40601
|
+
* Create a simulated domain
|
|
40602
|
+
*
|
|
40603
|
+
* @param {Object} body Domain
|
|
40604
|
+
*/
|
|
40605
|
+
postRoutingEmailOutboundDomainsSimulated(body) {
|
|
40606
|
+
// verify the required parameter 'body' is set
|
|
40607
|
+
if (body === undefined || body === null) {
|
|
40608
|
+
throw 'Missing the required parameter "body" when calling postRoutingEmailOutboundDomainsSimulated';
|
|
40609
|
+
}
|
|
40610
|
+
|
|
40611
|
+
return this.apiClient.callApi(
|
|
40612
|
+
'/api/v2/routing/email/outbound/domains/simulated',
|
|
40613
|
+
'POST',
|
|
40614
|
+
{ },
|
|
40615
|
+
{ },
|
|
40616
|
+
{ },
|
|
40617
|
+
{ },
|
|
40618
|
+
body,
|
|
40619
|
+
['PureCloud OAuth'],
|
|
40620
|
+
['application/json'],
|
|
40621
|
+
['application/json']
|
|
40622
|
+
);
|
|
40623
|
+
}
|
|
40624
|
+
|
|
39835
40625
|
/**
|
|
39836
40626
|
* Create Language
|
|
39837
40627
|
*
|
|
@@ -40199,6 +40989,31 @@ class RoutingApi {
|
|
|
40199
40989
|
);
|
|
40200
40990
|
}
|
|
40201
40991
|
|
|
40992
|
+
/**
|
|
40993
|
+
* Request an activation status (cname + dkim) update of an outbound domain
|
|
40994
|
+
*
|
|
40995
|
+
* @param {String} domainId domain ID
|
|
40996
|
+
*/
|
|
40997
|
+
putRoutingEmailOutboundDomainActivation(domainId) {
|
|
40998
|
+
// verify the required parameter 'domainId' is set
|
|
40999
|
+
if (domainId === undefined || domainId === null) {
|
|
41000
|
+
throw 'Missing the required parameter "domainId" when calling putRoutingEmailOutboundDomainActivation';
|
|
41001
|
+
}
|
|
41002
|
+
|
|
41003
|
+
return this.apiClient.callApi(
|
|
41004
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/activation',
|
|
41005
|
+
'PUT',
|
|
41006
|
+
{ 'domainId': domainId },
|
|
41007
|
+
{ },
|
|
41008
|
+
{ },
|
|
41009
|
+
{ },
|
|
41010
|
+
null,
|
|
41011
|
+
['PureCloud OAuth'],
|
|
41012
|
+
['application/json'],
|
|
41013
|
+
['application/json']
|
|
41014
|
+
);
|
|
41015
|
+
}
|
|
41016
|
+
|
|
40202
41017
|
/**
|
|
40203
41018
|
* Update a recipient
|
|
40204
41019
|
*
|
|
@@ -40495,7 +41310,7 @@ class SCIMApi {
|
|
|
40495
41310
|
/**
|
|
40496
41311
|
* SCIM service.
|
|
40497
41312
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
40498
|
-
* @version
|
|
41313
|
+
* @version 151.0.0
|
|
40499
41314
|
*/
|
|
40500
41315
|
|
|
40501
41316
|
/**
|
|
@@ -41372,7 +42187,7 @@ class ScriptsApi {
|
|
|
41372
42187
|
/**
|
|
41373
42188
|
* Scripts service.
|
|
41374
42189
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
41375
|
-
* @version
|
|
42190
|
+
* @version 151.0.0
|
|
41376
42191
|
*/
|
|
41377
42192
|
|
|
41378
42193
|
/**
|
|
@@ -41791,7 +42606,7 @@ class SearchApi {
|
|
|
41791
42606
|
/**
|
|
41792
42607
|
* Search service.
|
|
41793
42608
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
41794
|
-
* @version
|
|
42609
|
+
* @version 151.0.0
|
|
41795
42610
|
*/
|
|
41796
42611
|
|
|
41797
42612
|
/**
|
|
@@ -42320,6 +43135,31 @@ class SearchApi {
|
|
|
42320
43135
|
);
|
|
42321
43136
|
}
|
|
42322
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
|
+
|
|
42323
43163
|
/**
|
|
42324
43164
|
* Search voicemails
|
|
42325
43165
|
*
|
|
@@ -42351,7 +43191,7 @@ class SpeechTextAnalyticsApi {
|
|
|
42351
43191
|
/**
|
|
42352
43192
|
* SpeechTextAnalytics service.
|
|
42353
43193
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
42354
|
-
* @version
|
|
43194
|
+
* @version 151.0.0
|
|
42355
43195
|
*/
|
|
42356
43196
|
|
|
42357
43197
|
/**
|
|
@@ -43205,7 +44045,7 @@ class StationsApi {
|
|
|
43205
44045
|
/**
|
|
43206
44046
|
* Stations service.
|
|
43207
44047
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
43208
|
-
* @version
|
|
44048
|
+
* @version 151.0.0
|
|
43209
44049
|
*/
|
|
43210
44050
|
|
|
43211
44051
|
/**
|
|
@@ -43352,7 +44192,7 @@ class SuggestApi {
|
|
|
43352
44192
|
/**
|
|
43353
44193
|
* Suggest service.
|
|
43354
44194
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
43355
|
-
* @version
|
|
44195
|
+
* @version 151.0.0
|
|
43356
44196
|
*/
|
|
43357
44197
|
|
|
43358
44198
|
/**
|
|
@@ -43491,7 +44331,7 @@ class TeamsApi {
|
|
|
43491
44331
|
/**
|
|
43492
44332
|
* Teams service.
|
|
43493
44333
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
43494
|
-
* @version
|
|
44334
|
+
* @version 151.0.0
|
|
43495
44335
|
*/
|
|
43496
44336
|
|
|
43497
44337
|
/**
|
|
@@ -43531,6 +44371,36 @@ class TeamsApi {
|
|
|
43531
44371
|
);
|
|
43532
44372
|
}
|
|
43533
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
|
+
|
|
43534
44404
|
/**
|
|
43535
44405
|
* Get team
|
|
43536
44406
|
*
|
|
@@ -43556,6 +44426,38 @@ class TeamsApi {
|
|
|
43556
44426
|
);
|
|
43557
44427
|
}
|
|
43558
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
|
+
|
|
43559
44461
|
/**
|
|
43560
44462
|
* Get Team listing
|
|
43561
44463
|
*
|
|
@@ -43614,6 +44516,36 @@ class TeamsApi {
|
|
|
43614
44516
|
);
|
|
43615
44517
|
}
|
|
43616
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
|
+
|
|
43617
44549
|
/**
|
|
43618
44550
|
* Create a team
|
|
43619
44551
|
*
|
|
@@ -43670,7 +44602,7 @@ class TelephonyApi {
|
|
|
43670
44602
|
/**
|
|
43671
44603
|
* Telephony service.
|
|
43672
44604
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
43673
|
-
* @version
|
|
44605
|
+
* @version 151.0.0
|
|
43674
44606
|
*/
|
|
43675
44607
|
|
|
43676
44608
|
/**
|
|
@@ -43778,7 +44710,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
43778
44710
|
/**
|
|
43779
44711
|
* TelephonyProvidersEdge service.
|
|
43780
44712
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
43781
|
-
* @version
|
|
44713
|
+
* @version 151.0.0
|
|
43782
44714
|
*/
|
|
43783
44715
|
|
|
43784
44716
|
/**
|
|
@@ -47411,7 +48343,7 @@ class TextbotsApi {
|
|
|
47411
48343
|
/**
|
|
47412
48344
|
* Textbots service.
|
|
47413
48345
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
47414
|
-
* @version
|
|
48346
|
+
* @version 151.0.0
|
|
47415
48347
|
*/
|
|
47416
48348
|
|
|
47417
48349
|
/**
|
|
@@ -47539,7 +48471,7 @@ class TokensApi {
|
|
|
47539
48471
|
/**
|
|
47540
48472
|
* Tokens service.
|
|
47541
48473
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
47542
|
-
* @version
|
|
48474
|
+
* @version 151.0.0
|
|
47543
48475
|
*/
|
|
47544
48476
|
|
|
47545
48477
|
/**
|
|
@@ -47645,7 +48577,7 @@ class UploadsApi {
|
|
|
47645
48577
|
/**
|
|
47646
48578
|
* Uploads service.
|
|
47647
48579
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
47648
|
-
* @version
|
|
48580
|
+
* @version 151.0.0
|
|
47649
48581
|
*/
|
|
47650
48582
|
|
|
47651
48583
|
/**
|
|
@@ -47821,7 +48753,7 @@ class UsageApi {
|
|
|
47821
48753
|
/**
|
|
47822
48754
|
* Usage service.
|
|
47823
48755
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
47824
|
-
* @version
|
|
48756
|
+
* @version 151.0.0
|
|
47825
48757
|
*/
|
|
47826
48758
|
|
|
47827
48759
|
/**
|
|
@@ -47892,7 +48824,7 @@ class UserRecordingsApi {
|
|
|
47892
48824
|
/**
|
|
47893
48825
|
* UserRecordings service.
|
|
47894
48826
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
47895
|
-
* @version
|
|
48827
|
+
* @version 151.0.0
|
|
47896
48828
|
*/
|
|
47897
48829
|
|
|
47898
48830
|
/**
|
|
@@ -48077,7 +49009,7 @@ class UsersApi {
|
|
|
48077
49009
|
/**
|
|
48078
49010
|
* Users service.
|
|
48079
49011
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
48080
|
-
* @version
|
|
49012
|
+
* @version 151.0.0
|
|
48081
49013
|
*/
|
|
48082
49014
|
|
|
48083
49015
|
/**
|
|
@@ -50068,6 +51000,31 @@ class UsersApi {
|
|
|
50068
51000
|
);
|
|
50069
51001
|
}
|
|
50070
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
|
+
|
|
50071
51028
|
/**
|
|
50072
51029
|
* Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
|
50073
51030
|
*
|
|
@@ -50409,7 +51366,7 @@ class UtilitiesApi {
|
|
|
50409
51366
|
/**
|
|
50410
51367
|
* Utilities service.
|
|
50411
51368
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
50412
|
-
* @version
|
|
51369
|
+
* @version 151.0.0
|
|
50413
51370
|
*/
|
|
50414
51371
|
|
|
50415
51372
|
/**
|
|
@@ -50520,7 +51477,7 @@ class VoicemailApi {
|
|
|
50520
51477
|
/**
|
|
50521
51478
|
* Voicemail service.
|
|
50522
51479
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
50523
|
-
* @version
|
|
51480
|
+
* @version 151.0.0
|
|
50524
51481
|
*/
|
|
50525
51482
|
|
|
50526
51483
|
/**
|
|
@@ -51187,7 +52144,7 @@ class WebChatApi {
|
|
|
51187
52144
|
/**
|
|
51188
52145
|
* WebChat service.
|
|
51189
52146
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
51190
|
-
* @version
|
|
52147
|
+
* @version 151.0.0
|
|
51191
52148
|
*/
|
|
51192
52149
|
|
|
51193
52150
|
/**
|
|
@@ -51731,7 +52688,7 @@ class WebDeploymentsApi {
|
|
|
51731
52688
|
/**
|
|
51732
52689
|
* WebDeployments service.
|
|
51733
52690
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
51734
|
-
* @version
|
|
52691
|
+
* @version 151.0.0
|
|
51735
52692
|
*/
|
|
51736
52693
|
|
|
51737
52694
|
/**
|
|
@@ -52119,7 +53076,7 @@ class WebMessagingApi {
|
|
|
52119
53076
|
/**
|
|
52120
53077
|
* WebMessaging service.
|
|
52121
53078
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
52122
|
-
* @version
|
|
53079
|
+
* @version 151.0.0
|
|
52123
53080
|
*/
|
|
52124
53081
|
|
|
52125
53082
|
/**
|
|
@@ -52165,7 +53122,7 @@ class WidgetsApi {
|
|
|
52165
53122
|
/**
|
|
52166
53123
|
* Widgets service.
|
|
52167
53124
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
52168
|
-
* @version
|
|
53125
|
+
* @version 151.0.0
|
|
52169
53126
|
*/
|
|
52170
53127
|
|
|
52171
53128
|
/**
|
|
@@ -52311,7 +53268,7 @@ class WorkforceManagementApi {
|
|
|
52311
53268
|
/**
|
|
52312
53269
|
* WorkforceManagement service.
|
|
52313
53270
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
52314
|
-
* @version
|
|
53271
|
+
* @version 151.0.0
|
|
52315
53272
|
*/
|
|
52316
53273
|
|
|
52317
53274
|
/**
|
|
@@ -56091,6 +57048,76 @@ class WorkforceManagementApi {
|
|
|
56091
57048
|
);
|
|
56092
57049
|
}
|
|
56093
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
|
+
|
|
56094
57121
|
/**
|
|
56095
57122
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
56096
57123
|
*
|
|
@@ -56587,7 +57614,7 @@ class WorkforceManagementApi {
|
|
|
56587
57614
|
* </pre>
|
|
56588
57615
|
* </p>
|
|
56589
57616
|
* @module purecloud-platform-client-v2/index
|
|
56590
|
-
* @version
|
|
57617
|
+
* @version 151.0.0
|
|
56591
57618
|
*/
|
|
56592
57619
|
class platformClient {
|
|
56593
57620
|
constructor() {
|
|
@@ -56656,6 +57683,16 @@ class platformClient {
|
|
|
56656
57683
|
* @property {module:purecloud-platform-client-v2/api/DataExtensionsApi}
|
|
56657
57684
|
*/
|
|
56658
57685
|
this.DataExtensionsApi = DataExtensionsApi;
|
|
57686
|
+
/**
|
|
57687
|
+
* The DownloadsApi service constructor.
|
|
57688
|
+
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|
|
57689
|
+
*/
|
|
57690
|
+
this.DownloadsApi = DownloadsApi;
|
|
57691
|
+
/**
|
|
57692
|
+
* The EventsApi service constructor.
|
|
57693
|
+
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|
|
57694
|
+
*/
|
|
57695
|
+
this.EventsApi = EventsApi;
|
|
56659
57696
|
/**
|
|
56660
57697
|
* The ExternalContactsApi service constructor.
|
|
56661
57698
|
* @property {module:purecloud-platform-client-v2/api/ExternalContactsApi}
|