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
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 151.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1478,7 +1478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1478
1478
|
/**
|
|
1479
1479
|
* Alerting service.
|
|
1480
1480
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1481
|
-
* @version
|
|
1481
|
+
* @version 151.0.0
|
|
1482
1482
|
*/
|
|
1483
1483
|
|
|
1484
1484
|
/**
|
|
@@ -1792,7 +1792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1792
1792
|
/**
|
|
1793
1793
|
* Analytics service.
|
|
1794
1794
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1795
|
-
* @version
|
|
1795
|
+
* @version 151.0.0
|
|
1796
1796
|
*/
|
|
1797
1797
|
|
|
1798
1798
|
/**
|
|
@@ -3019,7 +3019,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3019
3019
|
/**
|
|
3020
3020
|
* Architect service.
|
|
3021
3021
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3022
|
-
* @version
|
|
3022
|
+
* @version 151.0.0
|
|
3023
3023
|
*/
|
|
3024
3024
|
|
|
3025
3025
|
/**
|
|
@@ -6065,7 +6065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6065
6065
|
/**
|
|
6066
6066
|
* Audit service.
|
|
6067
6067
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6068
|
-
* @version
|
|
6068
|
+
* @version 151.0.0
|
|
6069
6069
|
*/
|
|
6070
6070
|
|
|
6071
6071
|
/**
|
|
@@ -6236,7 +6236,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6236
6236
|
/**
|
|
6237
6237
|
* Authorization service.
|
|
6238
6238
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6239
|
-
* @version
|
|
6239
|
+
* @version 151.0.0
|
|
6240
6240
|
*/
|
|
6241
6241
|
|
|
6242
6242
|
/**
|
|
@@ -7419,7 +7419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7419
7419
|
/**
|
|
7420
7420
|
* Billing service.
|
|
7421
7421
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7422
|
-
* @version
|
|
7422
|
+
* @version 151.0.0
|
|
7423
7423
|
*/
|
|
7424
7424
|
|
|
7425
7425
|
/**
|
|
@@ -7499,7 +7499,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7499
7499
|
/**
|
|
7500
7500
|
* Chat service.
|
|
7501
7501
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7502
|
-
* @version
|
|
7502
|
+
* @version 151.0.0
|
|
7503
7503
|
*/
|
|
7504
7504
|
|
|
7505
7505
|
/**
|
|
@@ -7590,7 +7590,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7590
7590
|
/**
|
|
7591
7591
|
* Coaching service.
|
|
7592
7592
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7593
|
-
* @version
|
|
7593
|
+
* @version 151.0.0
|
|
7594
7594
|
*/
|
|
7595
7595
|
|
|
7596
7596
|
/**
|
|
@@ -8167,7 +8167,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8167
8167
|
/**
|
|
8168
8168
|
* ContentManagement service.
|
|
8169
8169
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8170
|
-
* @version
|
|
8170
|
+
* @version 151.0.0
|
|
8171
8171
|
*/
|
|
8172
8172
|
|
|
8173
8173
|
/**
|
|
@@ -9307,7 +9307,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9307
9307
|
/**
|
|
9308
9308
|
* Conversations service.
|
|
9309
9309
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9310
|
-
* @version
|
|
9310
|
+
* @version 151.0.0
|
|
9311
9311
|
*/
|
|
9312
9312
|
|
|
9313
9313
|
/**
|
|
@@ -10817,8 +10817,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10817
10817
|
* Get message
|
|
10818
10818
|
*
|
|
10819
10819
|
* @param {String} messageId messageId
|
|
10820
|
+
* @param {Object} opts Optional parameters
|
|
10821
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
10820
10822
|
*/
|
|
10821
|
-
getConversationsMessageDetails(messageId) {
|
|
10823
|
+
getConversationsMessageDetails(messageId, opts) {
|
|
10824
|
+
opts = opts || {};
|
|
10825
|
+
|
|
10822
10826
|
// verify the required parameter 'messageId' is set
|
|
10823
10827
|
if (messageId === undefined || messageId === null) {
|
|
10824
10828
|
throw 'Missing the required parameter "messageId" when calling getConversationsMessageDetails';
|
|
@@ -10828,7 +10832,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10828
10832
|
'/api/v2/conversations/messages/{messageId}/details',
|
|
10829
10833
|
'GET',
|
|
10830
10834
|
{ 'messageId': messageId },
|
|
10831
|
-
{
|
|
10835
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
10832
10836
|
{ },
|
|
10833
10837
|
{ },
|
|
10834
10838
|
null,
|
|
@@ -10843,8 +10847,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10843
10847
|
*
|
|
10844
10848
|
* @param {String} conversationId conversationId
|
|
10845
10849
|
* @param {String} messageId messageId
|
|
10850
|
+
* @param {Object} opts Optional parameters
|
|
10851
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
10846
10852
|
*/
|
|
10847
|
-
getConversationsMessageMessage(conversationId, messageId) {
|
|
10853
|
+
getConversationsMessageMessage(conversationId, messageId, opts) {
|
|
10854
|
+
opts = opts || {};
|
|
10855
|
+
|
|
10848
10856
|
// verify the required parameter 'conversationId' is set
|
|
10849
10857
|
if (conversationId === undefined || conversationId === null) {
|
|
10850
10858
|
throw 'Missing the required parameter "conversationId" when calling getConversationsMessageMessage';
|
|
@@ -10858,7 +10866,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10858
10866
|
'/api/v2/conversations/messages/{conversationId}/messages/{messageId}',
|
|
10859
10867
|
'GET',
|
|
10860
10868
|
{ 'conversationId': conversationId,'messageId': messageId },
|
|
10861
|
-
{
|
|
10869
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
10862
10870
|
{ },
|
|
10863
10871
|
{ },
|
|
10864
10872
|
null,
|
|
@@ -13476,6 +13484,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13476
13484
|
);
|
|
13477
13485
|
}
|
|
13478
13486
|
|
|
13487
|
+
/**
|
|
13488
|
+
* Create an email conversation, per API
|
|
13489
|
+
*
|
|
13490
|
+
* @param {Object} body Create agentless email request
|
|
13491
|
+
*/
|
|
13492
|
+
postConversationsEmailsAgentless(body) {
|
|
13493
|
+
// verify the required parameter 'body' is set
|
|
13494
|
+
if (body === undefined || body === null) {
|
|
13495
|
+
throw 'Missing the required parameter "body" when calling postConversationsEmailsAgentless';
|
|
13496
|
+
}
|
|
13497
|
+
|
|
13498
|
+
return this.apiClient.callApi(
|
|
13499
|
+
'/api/v2/conversations/emails/agentless',
|
|
13500
|
+
'POST',
|
|
13501
|
+
{ },
|
|
13502
|
+
{ },
|
|
13503
|
+
{ },
|
|
13504
|
+
{ },
|
|
13505
|
+
body,
|
|
13506
|
+
['PureCloud OAuth'],
|
|
13507
|
+
['application/json'],
|
|
13508
|
+
['application/json']
|
|
13509
|
+
);
|
|
13510
|
+
}
|
|
13511
|
+
|
|
13479
13512
|
/**
|
|
13480
13513
|
* Create Fax Conversation
|
|
13481
13514
|
*
|
|
@@ -13557,8 +13590,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13557
13590
|
* @param {String} conversationId conversationId
|
|
13558
13591
|
* @param {String} communicationId communicationId
|
|
13559
13592
|
* @param {Object} body Message
|
|
13593
|
+
* @param {Object} opts Optional parameters
|
|
13594
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
13560
13595
|
*/
|
|
13561
|
-
postConversationsMessageCommunicationMessages(conversationId, communicationId, body) {
|
|
13596
|
+
postConversationsMessageCommunicationMessages(conversationId, communicationId, body, opts) {
|
|
13597
|
+
opts = opts || {};
|
|
13598
|
+
|
|
13562
13599
|
// verify the required parameter 'conversationId' is set
|
|
13563
13600
|
if (conversationId === undefined || conversationId === null) {
|
|
13564
13601
|
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessages';
|
|
@@ -13576,7 +13613,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13576
13613
|
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages',
|
|
13577
13614
|
'POST',
|
|
13578
13615
|
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
13579
|
-
{
|
|
13616
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
13580
13617
|
{ },
|
|
13581
13618
|
{ },
|
|
13582
13619
|
body,
|
|
@@ -13616,11 +13653,47 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13616
13653
|
);
|
|
13617
13654
|
}
|
|
13618
13655
|
|
|
13656
|
+
/**
|
|
13657
|
+
* Send message typing event
|
|
13658
|
+
* Send message typing event for existing conversation/communication.
|
|
13659
|
+
* @param {String} conversationId conversationId
|
|
13660
|
+
* @param {String} communicationId communicationId
|
|
13661
|
+
* @param {Object} body MessageTypingEvent
|
|
13662
|
+
*/
|
|
13663
|
+
postConversationsMessageCommunicationTyping(conversationId, communicationId, body) {
|
|
13664
|
+
// verify the required parameter 'conversationId' is set
|
|
13665
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13666
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationTyping';
|
|
13667
|
+
}
|
|
13668
|
+
// verify the required parameter 'communicationId' is set
|
|
13669
|
+
if (communicationId === undefined || communicationId === null) {
|
|
13670
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationTyping';
|
|
13671
|
+
}
|
|
13672
|
+
// verify the required parameter 'body' is set
|
|
13673
|
+
if (body === undefined || body === null) {
|
|
13674
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationTyping';
|
|
13675
|
+
}
|
|
13676
|
+
|
|
13677
|
+
return this.apiClient.callApi(
|
|
13678
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing',
|
|
13679
|
+
'POST',
|
|
13680
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
13681
|
+
{ },
|
|
13682
|
+
{ },
|
|
13683
|
+
{ },
|
|
13684
|
+
body,
|
|
13685
|
+
['PureCloud OAuth'],
|
|
13686
|
+
['application/json'],
|
|
13687
|
+
['application/json']
|
|
13688
|
+
);
|
|
13689
|
+
}
|
|
13690
|
+
|
|
13619
13691
|
/**
|
|
13620
13692
|
* Get messages in batch
|
|
13621
13693
|
* 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"]
|
|
13622
13694
|
* @param {String} conversationId
|
|
13623
13695
|
* @param {Object} opts Optional parameters
|
|
13696
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
13624
13697
|
* @param {Array.<String>} opts.body messageIds
|
|
13625
13698
|
*/
|
|
13626
13699
|
postConversationsMessageMessagesBulk(conversationId, opts) {
|
|
@@ -13635,7 +13708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13635
13708
|
'/api/v2/conversations/messages/{conversationId}/messages/bulk',
|
|
13636
13709
|
'POST',
|
|
13637
13710
|
{ 'conversationId': conversationId },
|
|
13638
|
-
{
|
|
13711
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
13639
13712
|
{ },
|
|
13640
13713
|
{ },
|
|
13641
13714
|
opts['body'],
|
|
@@ -14451,7 +14524,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14451
14524
|
/**
|
|
14452
14525
|
* DataExtensions service.
|
|
14453
14526
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14454
|
-
* @version
|
|
14527
|
+
* @version 151.0.0
|
|
14455
14528
|
*/
|
|
14456
14529
|
|
|
14457
14530
|
/**
|
|
@@ -14533,11 +14606,159 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14533
14606
|
|
|
14534
14607
|
}
|
|
14535
14608
|
|
|
14609
|
+
class DownloadsApi {
|
|
14610
|
+
/**
|
|
14611
|
+
* Downloads service.
|
|
14612
|
+
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14613
|
+
* @version 151.0.0
|
|
14614
|
+
*/
|
|
14615
|
+
|
|
14616
|
+
/**
|
|
14617
|
+
* Constructs a new DownloadsApi.
|
|
14618
|
+
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
14619
|
+
* @class
|
|
14620
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
14621
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
14622
|
+
*/
|
|
14623
|
+
constructor(apiClient) {
|
|
14624
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
14625
|
+
}
|
|
14626
|
+
|
|
14627
|
+
|
|
14628
|
+
/**
|
|
14629
|
+
* Issues a redirect to a signed secure download URL for specified download
|
|
14630
|
+
* this method will issue a redirect to the url to the content
|
|
14631
|
+
* @param {String} downloadId Download ID
|
|
14632
|
+
* @param {Object} opts Optional parameters
|
|
14633
|
+
* @param {String} opts.contentDisposition
|
|
14634
|
+
* @param {Boolean} opts.issueRedirect (default to true)
|
|
14635
|
+
* @param {Boolean} opts.redirectToAuth (default to true)
|
|
14636
|
+
*/
|
|
14637
|
+
getDownload(downloadId, opts) {
|
|
14638
|
+
opts = opts || {};
|
|
14639
|
+
|
|
14640
|
+
// verify the required parameter 'downloadId' is set
|
|
14641
|
+
if (downloadId === undefined || downloadId === null) {
|
|
14642
|
+
throw 'Missing the required parameter "downloadId" when calling getDownload';
|
|
14643
|
+
}
|
|
14644
|
+
|
|
14645
|
+
return this.apiClient.callApi(
|
|
14646
|
+
'/api/v2/downloads/{downloadId}',
|
|
14647
|
+
'GET',
|
|
14648
|
+
{ 'downloadId': downloadId },
|
|
14649
|
+
{ 'contentDisposition': opts['contentDisposition'],'issueRedirect': opts['issueRedirect'],'redirectToAuth': opts['redirectToAuth'] },
|
|
14650
|
+
{ },
|
|
14651
|
+
{ },
|
|
14652
|
+
null,
|
|
14653
|
+
['PureCloud OAuth'],
|
|
14654
|
+
['application/json'],
|
|
14655
|
+
['application/json']
|
|
14656
|
+
);
|
|
14657
|
+
}
|
|
14658
|
+
|
|
14659
|
+
}
|
|
14660
|
+
|
|
14661
|
+
class EventsApi {
|
|
14662
|
+
/**
|
|
14663
|
+
* Events service.
|
|
14664
|
+
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14665
|
+
* @version 151.0.0
|
|
14666
|
+
*/
|
|
14667
|
+
|
|
14668
|
+
/**
|
|
14669
|
+
* Constructs a new EventsApi.
|
|
14670
|
+
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
14671
|
+
* @class
|
|
14672
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
14673
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
14674
|
+
*/
|
|
14675
|
+
constructor(apiClient) {
|
|
14676
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
14677
|
+
}
|
|
14678
|
+
|
|
14679
|
+
|
|
14680
|
+
/**
|
|
14681
|
+
* Publish Conversation Batch Events
|
|
14682
|
+
*
|
|
14683
|
+
* @param {Object} body batchRequest
|
|
14684
|
+
*/
|
|
14685
|
+
postEventsConversations(body) {
|
|
14686
|
+
// verify the required parameter 'body' is set
|
|
14687
|
+
if (body === undefined || body === null) {
|
|
14688
|
+
throw 'Missing the required parameter "body" when calling postEventsConversations';
|
|
14689
|
+
}
|
|
14690
|
+
|
|
14691
|
+
return this.apiClient.callApi(
|
|
14692
|
+
'/api/v2/events/conversations',
|
|
14693
|
+
'POST',
|
|
14694
|
+
{ },
|
|
14695
|
+
{ },
|
|
14696
|
+
{ },
|
|
14697
|
+
{ },
|
|
14698
|
+
body,
|
|
14699
|
+
['PureCloud OAuth'],
|
|
14700
|
+
['application/json'],
|
|
14701
|
+
['application/json']
|
|
14702
|
+
);
|
|
14703
|
+
}
|
|
14704
|
+
|
|
14705
|
+
/**
|
|
14706
|
+
* Publish User Presence Status Batch Events
|
|
14707
|
+
*
|
|
14708
|
+
* @param {Object} body batchRequest
|
|
14709
|
+
*/
|
|
14710
|
+
postEventsUsersPresence(body) {
|
|
14711
|
+
// verify the required parameter 'body' is set
|
|
14712
|
+
if (body === undefined || body === null) {
|
|
14713
|
+
throw 'Missing the required parameter "body" when calling postEventsUsersPresence';
|
|
14714
|
+
}
|
|
14715
|
+
|
|
14716
|
+
return this.apiClient.callApi(
|
|
14717
|
+
'/api/v2/events/users/presence',
|
|
14718
|
+
'POST',
|
|
14719
|
+
{ },
|
|
14720
|
+
{ },
|
|
14721
|
+
{ },
|
|
14722
|
+
{ },
|
|
14723
|
+
body,
|
|
14724
|
+
['PureCloud OAuth'],
|
|
14725
|
+
['application/json'],
|
|
14726
|
+
['application/json']
|
|
14727
|
+
);
|
|
14728
|
+
}
|
|
14729
|
+
|
|
14730
|
+
/**
|
|
14731
|
+
* Publish Agent Routing Status Batch Events
|
|
14732
|
+
*
|
|
14733
|
+
* @param {Object} body batchRequest
|
|
14734
|
+
*/
|
|
14735
|
+
postEventsUsersRoutingstatus(body) {
|
|
14736
|
+
// verify the required parameter 'body' is set
|
|
14737
|
+
if (body === undefined || body === null) {
|
|
14738
|
+
throw 'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';
|
|
14739
|
+
}
|
|
14740
|
+
|
|
14741
|
+
return this.apiClient.callApi(
|
|
14742
|
+
'/api/v2/events/users/routingstatus',
|
|
14743
|
+
'POST',
|
|
14744
|
+
{ },
|
|
14745
|
+
{ },
|
|
14746
|
+
{ },
|
|
14747
|
+
{ },
|
|
14748
|
+
body,
|
|
14749
|
+
['PureCloud OAuth'],
|
|
14750
|
+
['application/json'],
|
|
14751
|
+
['application/json']
|
|
14752
|
+
);
|
|
14753
|
+
}
|
|
14754
|
+
|
|
14755
|
+
}
|
|
14756
|
+
|
|
14536
14757
|
class ExternalContactsApi {
|
|
14537
14758
|
/**
|
|
14538
14759
|
* ExternalContacts service.
|
|
14539
14760
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14540
|
-
* @version
|
|
14761
|
+
* @version 151.0.0
|
|
14541
14762
|
*/
|
|
14542
14763
|
|
|
14543
14764
|
/**
|
|
@@ -14766,6 +14987,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14766
14987
|
);
|
|
14767
14988
|
}
|
|
14768
14989
|
|
|
14990
|
+
/**
|
|
14991
|
+
* List the identifiers for a contact
|
|
14992
|
+
*
|
|
14993
|
+
* @param {String} contactId ExternalContact ID
|
|
14994
|
+
*/
|
|
14995
|
+
getExternalcontactsContactIdentifiers(contactId) {
|
|
14996
|
+
// verify the required parameter 'contactId' is set
|
|
14997
|
+
if (contactId === undefined || contactId === null) {
|
|
14998
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactIdentifiers';
|
|
14999
|
+
}
|
|
15000
|
+
|
|
15001
|
+
return this.apiClient.callApi(
|
|
15002
|
+
'/api/v2/externalcontacts/contacts/{contactId}/identifiers',
|
|
15003
|
+
'GET',
|
|
15004
|
+
{ 'contactId': contactId },
|
|
15005
|
+
{ },
|
|
15006
|
+
{ },
|
|
15007
|
+
{ },
|
|
15008
|
+
null,
|
|
15009
|
+
['PureCloud OAuth'],
|
|
15010
|
+
['application/json'],
|
|
15011
|
+
['application/json']
|
|
15012
|
+
);
|
|
15013
|
+
}
|
|
15014
|
+
|
|
15015
|
+
/**
|
|
15016
|
+
* Retrieve all sessions for a given external contact.
|
|
15017
|
+
*
|
|
15018
|
+
* @param {String} contactId ExternalContact ID
|
|
15019
|
+
* @param {Object} opts Optional parameters
|
|
15020
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
15021
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
15022
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
15023
|
+
*/
|
|
15024
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
15025
|
+
opts = opts || {};
|
|
15026
|
+
|
|
15027
|
+
// verify the required parameter 'contactId' is set
|
|
15028
|
+
if (contactId === undefined || contactId === null) {
|
|
15029
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
15030
|
+
}
|
|
15031
|
+
|
|
15032
|
+
return this.apiClient.callApi(
|
|
15033
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
15034
|
+
'GET',
|
|
15035
|
+
{ 'contactId': contactId },
|
|
15036
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
15037
|
+
{ },
|
|
15038
|
+
{ },
|
|
15039
|
+
null,
|
|
15040
|
+
['PureCloud OAuth'],
|
|
15041
|
+
['application/json'],
|
|
15042
|
+
['application/json']
|
|
15043
|
+
);
|
|
15044
|
+
}
|
|
15045
|
+
|
|
14769
15046
|
/**
|
|
14770
15047
|
* Fetch a note for an external contact
|
|
14771
15048
|
*
|
|
@@ -14832,6 +15109,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14832
15109
|
);
|
|
14833
15110
|
}
|
|
14834
15111
|
|
|
15112
|
+
/**
|
|
15113
|
+
* Fetch an unresolved external contact
|
|
15114
|
+
*
|
|
15115
|
+
* @param {String} contactId ExternalContact ID
|
|
15116
|
+
* @param {Object} opts Optional parameters
|
|
15117
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
15118
|
+
*/
|
|
15119
|
+
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
15120
|
+
opts = opts || {};
|
|
15121
|
+
|
|
15122
|
+
// verify the required parameter 'contactId' is set
|
|
15123
|
+
if (contactId === undefined || contactId === null) {
|
|
15124
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactUnresolved';
|
|
15125
|
+
}
|
|
15126
|
+
|
|
15127
|
+
return this.apiClient.callApi(
|
|
15128
|
+
'/api/v2/externalcontacts/contacts/{contactId}/unresolved',
|
|
15129
|
+
'GET',
|
|
15130
|
+
{ 'contactId': contactId },
|
|
15131
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
15132
|
+
{ },
|
|
15133
|
+
{ },
|
|
15134
|
+
null,
|
|
15135
|
+
['PureCloud OAuth'],
|
|
15136
|
+
['application/json'],
|
|
15137
|
+
['application/json']
|
|
15138
|
+
);
|
|
15139
|
+
}
|
|
15140
|
+
|
|
14835
15141
|
/**
|
|
14836
15142
|
* Search for external contacts
|
|
14837
15143
|
*
|
|
@@ -15409,6 +15715,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15409
15715
|
);
|
|
15410
15716
|
}
|
|
15411
15717
|
|
|
15718
|
+
/**
|
|
15719
|
+
* Claim or release identifiers for a contact
|
|
15720
|
+
*
|
|
15721
|
+
* @param {String} contactId ExternalContact ID
|
|
15722
|
+
* @param {Object} body ClaimRequest
|
|
15723
|
+
*/
|
|
15724
|
+
patchExternalcontactsContactIdentifiers(contactId, body) {
|
|
15725
|
+
// verify the required parameter 'contactId' is set
|
|
15726
|
+
if (contactId === undefined || contactId === null) {
|
|
15727
|
+
throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContactIdentifiers';
|
|
15728
|
+
}
|
|
15729
|
+
// verify the required parameter 'body' is set
|
|
15730
|
+
if (body === undefined || body === null) {
|
|
15731
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsContactIdentifiers';
|
|
15732
|
+
}
|
|
15733
|
+
|
|
15734
|
+
return this.apiClient.callApi(
|
|
15735
|
+
'/api/v2/externalcontacts/contacts/{contactId}/identifiers',
|
|
15736
|
+
'PATCH',
|
|
15737
|
+
{ 'contactId': contactId },
|
|
15738
|
+
{ },
|
|
15739
|
+
{ },
|
|
15740
|
+
{ },
|
|
15741
|
+
body,
|
|
15742
|
+
['PureCloud OAuth'],
|
|
15743
|
+
['application/json'],
|
|
15744
|
+
['application/json']
|
|
15745
|
+
);
|
|
15746
|
+
}
|
|
15747
|
+
|
|
15412
15748
|
/**
|
|
15413
15749
|
* Bulk fetch contacts
|
|
15414
15750
|
*
|
|
@@ -15484,6 +15820,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15484
15820
|
);
|
|
15485
15821
|
}
|
|
15486
15822
|
|
|
15823
|
+
/**
|
|
15824
|
+
* Bulk fetch unresolved ancestor contacts
|
|
15825
|
+
*
|
|
15826
|
+
* @param {Object} body Contact ids
|
|
15827
|
+
*/
|
|
15828
|
+
postExternalcontactsBulkContactsUnresolved(body) {
|
|
15829
|
+
// verify the required parameter 'body' is set
|
|
15830
|
+
if (body === undefined || body === null) {
|
|
15831
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsUnresolved';
|
|
15832
|
+
}
|
|
15833
|
+
|
|
15834
|
+
return this.apiClient.callApi(
|
|
15835
|
+
'/api/v2/externalcontacts/bulk/contacts/unresolved',
|
|
15836
|
+
'POST',
|
|
15837
|
+
{ },
|
|
15838
|
+
{ },
|
|
15839
|
+
{ },
|
|
15840
|
+
{ },
|
|
15841
|
+
body,
|
|
15842
|
+
['PureCloud OAuth'],
|
|
15843
|
+
['application/json'],
|
|
15844
|
+
['application/json']
|
|
15845
|
+
);
|
|
15846
|
+
}
|
|
15847
|
+
|
|
15487
15848
|
/**
|
|
15488
15849
|
* Bulk update contacts
|
|
15489
15850
|
*
|
|
@@ -15839,6 +16200,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15839
16200
|
);
|
|
15840
16201
|
}
|
|
15841
16202
|
|
|
16203
|
+
/**
|
|
16204
|
+
* Promote an observed contact (ephemeral or identified) to a curated contact
|
|
16205
|
+
*
|
|
16206
|
+
* @param {String} contactId ExternalContact ID
|
|
16207
|
+
*/
|
|
16208
|
+
postExternalcontactsContactPromotion(contactId) {
|
|
16209
|
+
// verify the required parameter 'contactId' is set
|
|
16210
|
+
if (contactId === undefined || contactId === null) {
|
|
16211
|
+
throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactPromotion';
|
|
16212
|
+
}
|
|
16213
|
+
|
|
16214
|
+
return this.apiClient.callApi(
|
|
16215
|
+
'/api/v2/externalcontacts/contacts/{contactId}/promotion',
|
|
16216
|
+
'POST',
|
|
16217
|
+
{ 'contactId': contactId },
|
|
16218
|
+
{ },
|
|
16219
|
+
{ },
|
|
16220
|
+
{ },
|
|
16221
|
+
null,
|
|
16222
|
+
['PureCloud OAuth'],
|
|
16223
|
+
['application/json'],
|
|
16224
|
+
['application/json']
|
|
16225
|
+
);
|
|
16226
|
+
}
|
|
16227
|
+
|
|
15842
16228
|
/**
|
|
15843
16229
|
* Create an external contact
|
|
15844
16230
|
*
|
|
@@ -15889,6 +16275,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15889
16275
|
);
|
|
15890
16276
|
}
|
|
15891
16277
|
|
|
16278
|
+
/**
|
|
16279
|
+
* Fetch a contact using an identifier type and value.
|
|
16280
|
+
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
16281
|
+
* @param {Object} identifier
|
|
16282
|
+
*/
|
|
16283
|
+
postExternalcontactsIdentifierlookup(identifier) {
|
|
16284
|
+
// verify the required parameter 'identifier' is set
|
|
16285
|
+
if (identifier === undefined || identifier === null) {
|
|
16286
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';
|
|
16287
|
+
}
|
|
16288
|
+
|
|
16289
|
+
return this.apiClient.callApi(
|
|
16290
|
+
'/api/v2/externalcontacts/identifierlookup',
|
|
16291
|
+
'POST',
|
|
16292
|
+
{ },
|
|
16293
|
+
{ },
|
|
16294
|
+
{ },
|
|
16295
|
+
{ },
|
|
16296
|
+
identifier,
|
|
16297
|
+
['PureCloud OAuth'],
|
|
16298
|
+
['application/json'],
|
|
16299
|
+
['application/json']
|
|
16300
|
+
);
|
|
16301
|
+
}
|
|
16302
|
+
|
|
16303
|
+
/**
|
|
16304
|
+
* Merge two contacts into a new contact record
|
|
16305
|
+
*
|
|
16306
|
+
* @param {Object} body MergeRequest
|
|
16307
|
+
*/
|
|
16308
|
+
postExternalcontactsMergeContacts(body) {
|
|
16309
|
+
// verify the required parameter 'body' is set
|
|
16310
|
+
if (body === undefined || body === null) {
|
|
16311
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsMergeContacts';
|
|
16312
|
+
}
|
|
16313
|
+
|
|
16314
|
+
return this.apiClient.callApi(
|
|
16315
|
+
'/api/v2/externalcontacts/merge/contacts',
|
|
16316
|
+
'POST',
|
|
16317
|
+
{ },
|
|
16318
|
+
{ },
|
|
16319
|
+
{ },
|
|
16320
|
+
{ },
|
|
16321
|
+
body,
|
|
16322
|
+
['PureCloud OAuth'],
|
|
16323
|
+
['application/json'],
|
|
16324
|
+
['application/json']
|
|
16325
|
+
);
|
|
16326
|
+
}
|
|
16327
|
+
|
|
15892
16328
|
/**
|
|
15893
16329
|
* Create a note for an external organization
|
|
15894
16330
|
*
|
|
@@ -16280,7 +16716,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16280
16716
|
/**
|
|
16281
16717
|
* Fax service.
|
|
16282
16718
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16283
|
-
* @version
|
|
16719
|
+
* @version 151.0.0
|
|
16284
16720
|
*/
|
|
16285
16721
|
|
|
16286
16722
|
/**
|
|
@@ -16451,7 +16887,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16451
16887
|
/**
|
|
16452
16888
|
* Flows service.
|
|
16453
16889
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16454
|
-
* @version
|
|
16890
|
+
* @version 151.0.0
|
|
16455
16891
|
*/
|
|
16456
16892
|
|
|
16457
16893
|
/**
|
|
@@ -16522,7 +16958,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16522
16958
|
/**
|
|
16523
16959
|
* Gamification service.
|
|
16524
16960
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16525
|
-
* @version
|
|
16961
|
+
* @version 151.0.0
|
|
16526
16962
|
*/
|
|
16527
16963
|
|
|
16528
16964
|
/**
|
|
@@ -18203,7 +18639,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18203
18639
|
/**
|
|
18204
18640
|
* GeneralDataProtectionRegulation service.
|
|
18205
18641
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18206
|
-
* @version
|
|
18642
|
+
* @version 151.0.0
|
|
18207
18643
|
*/
|
|
18208
18644
|
|
|
18209
18645
|
/**
|
|
@@ -18333,7 +18769,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18333
18769
|
/**
|
|
18334
18770
|
* Geolocation service.
|
|
18335
18771
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18336
|
-
* @version
|
|
18772
|
+
* @version 151.0.0
|
|
18337
18773
|
*/
|
|
18338
18774
|
|
|
18339
18775
|
/**
|
|
@@ -18464,7 +18900,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18464
18900
|
/**
|
|
18465
18901
|
* Greetings service.
|
|
18466
18902
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18467
|
-
* @version
|
|
18903
|
+
* @version 151.0.0
|
|
18468
18904
|
*/
|
|
18469
18905
|
|
|
18470
18906
|
/**
|
|
@@ -18919,7 +19355,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18919
19355
|
/**
|
|
18920
19356
|
* Groups service.
|
|
18921
19357
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18922
|
-
* @version
|
|
19358
|
+
* @version 151.0.0
|
|
18923
19359
|
*/
|
|
18924
19360
|
|
|
18925
19361
|
/**
|
|
@@ -19325,7 +19761,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19325
19761
|
/**
|
|
19326
19762
|
* IdentityProvider service.
|
|
19327
19763
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19328
|
-
* @version
|
|
19764
|
+
* @version 151.0.0
|
|
19329
19765
|
*/
|
|
19330
19766
|
|
|
19331
19767
|
/**
|
|
@@ -20081,7 +20517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20081
20517
|
/**
|
|
20082
20518
|
* Integrations service.
|
|
20083
20519
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20084
|
-
* @version
|
|
20520
|
+
* @version 151.0.0
|
|
20085
20521
|
*/
|
|
20086
20522
|
|
|
20087
20523
|
/**
|
|
@@ -21681,7 +22117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21681
22117
|
/**
|
|
21682
22118
|
* Journey service.
|
|
21683
22119
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
21684
|
-
* @version
|
|
22120
|
+
* @version 151.0.0
|
|
21685
22121
|
*/
|
|
21686
22122
|
|
|
21687
22123
|
/**
|
|
@@ -22467,7 +22903,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22467
22903
|
/**
|
|
22468
22904
|
* Knowledge service.
|
|
22469
22905
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22470
|
-
* @version
|
|
22906
|
+
* @version 151.0.0
|
|
22471
22907
|
*/
|
|
22472
22908
|
|
|
22473
22909
|
/**
|
|
@@ -24900,7 +25336,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24900
25336
|
/**
|
|
24901
25337
|
* LanguageUnderstanding service.
|
|
24902
25338
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
24903
|
-
* @version
|
|
25339
|
+
* @version 151.0.0
|
|
24904
25340
|
*/
|
|
24905
25341
|
|
|
24906
25342
|
/**
|
|
@@ -25804,7 +26240,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25804
26240
|
/**
|
|
25805
26241
|
* Languages service.
|
|
25806
26242
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
25807
|
-
* @version
|
|
26243
|
+
* @version 151.0.0
|
|
25808
26244
|
*/
|
|
25809
26245
|
|
|
25810
26246
|
/**
|
|
@@ -26072,7 +26508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26072
26508
|
/**
|
|
26073
26509
|
* Learning service.
|
|
26074
26510
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26075
|
-
* @version
|
|
26511
|
+
* @version 151.0.0
|
|
26076
26512
|
*/
|
|
26077
26513
|
|
|
26078
26514
|
/**
|
|
@@ -26832,7 +27268,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26832
27268
|
/**
|
|
26833
27269
|
* License service.
|
|
26834
27270
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
26835
|
-
* @version
|
|
27271
|
+
* @version 151.0.0
|
|
26836
27272
|
*/
|
|
26837
27273
|
|
|
26838
27274
|
/**
|
|
@@ -27070,7 +27506,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27070
27506
|
/**
|
|
27071
27507
|
* Locations service.
|
|
27072
27508
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27073
|
-
* @version
|
|
27509
|
+
* @version 151.0.0
|
|
27074
27510
|
*/
|
|
27075
27511
|
|
|
27076
27512
|
/**
|
|
@@ -27306,7 +27742,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27306
27742
|
/**
|
|
27307
27743
|
* Messaging service.
|
|
27308
27744
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27309
|
-
* @version
|
|
27745
|
+
* @version 151.0.0
|
|
27310
27746
|
*/
|
|
27311
27747
|
|
|
27312
27748
|
/**
|
|
@@ -27457,7 +27893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27457
27893
|
/**
|
|
27458
27894
|
* MobileDevices service.
|
|
27459
27895
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27460
|
-
* @version
|
|
27896
|
+
* @version 151.0.0
|
|
27461
27897
|
*/
|
|
27462
27898
|
|
|
27463
27899
|
/**
|
|
@@ -27608,7 +28044,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27608
28044
|
/**
|
|
27609
28045
|
* Notifications service.
|
|
27610
28046
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
27611
|
-
* @version
|
|
28047
|
+
* @version 151.0.0
|
|
27612
28048
|
*/
|
|
27613
28049
|
|
|
27614
28050
|
/**
|
|
@@ -27833,7 +28269,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27833
28269
|
/**
|
|
27834
28270
|
* OAuth service.
|
|
27835
28271
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
27836
|
-
* @version
|
|
28272
|
+
* @version 151.0.0
|
|
27837
28273
|
*/
|
|
27838
28274
|
|
|
27839
28275
|
/**
|
|
@@ -28199,7 +28635,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28199
28635
|
/**
|
|
28200
28636
|
* Objects service.
|
|
28201
28637
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28202
|
-
* @version
|
|
28638
|
+
* @version 151.0.0
|
|
28203
28639
|
*/
|
|
28204
28640
|
|
|
28205
28641
|
/**
|
|
@@ -28470,7 +28906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28470
28906
|
/**
|
|
28471
28907
|
* Organization service.
|
|
28472
28908
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28473
|
-
* @version
|
|
28909
|
+
* @version 151.0.0
|
|
28474
28910
|
*/
|
|
28475
28911
|
|
|
28476
28912
|
/**
|
|
@@ -28873,7 +29309,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28873
29309
|
/**
|
|
28874
29310
|
* OrganizationAuthorization service.
|
|
28875
29311
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
28876
|
-
* @version
|
|
29312
|
+
* @version 151.0.0
|
|
28877
29313
|
*/
|
|
28878
29314
|
|
|
28879
29315
|
/**
|
|
@@ -29798,7 +30234,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29798
30234
|
/**
|
|
29799
30235
|
* Outbound service.
|
|
29800
30236
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
29801
|
-
* @version
|
|
30237
|
+
* @version 151.0.0
|
|
29802
30238
|
*/
|
|
29803
30239
|
|
|
29804
30240
|
/**
|
|
@@ -33187,7 +33623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33187
33623
|
/**
|
|
33188
33624
|
* Presence service.
|
|
33189
33625
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33190
|
-
* @version
|
|
33626
|
+
* @version 151.0.0
|
|
33191
33627
|
*/
|
|
33192
33628
|
|
|
33193
33629
|
/**
|
|
@@ -33202,6 +33638,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33202
33638
|
}
|
|
33203
33639
|
|
|
33204
33640
|
|
|
33641
|
+
/**
|
|
33642
|
+
* Delete a Presence Source
|
|
33643
|
+
*
|
|
33644
|
+
* @param {String} sourceId Presence Source ID
|
|
33645
|
+
*/
|
|
33646
|
+
deletePresenceSource(sourceId) {
|
|
33647
|
+
// verify the required parameter 'sourceId' is set
|
|
33648
|
+
if (sourceId === undefined || sourceId === null) {
|
|
33649
|
+
throw 'Missing the required parameter "sourceId" when calling deletePresenceSource';
|
|
33650
|
+
}
|
|
33651
|
+
|
|
33652
|
+
return this.apiClient.callApi(
|
|
33653
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
33654
|
+
'DELETE',
|
|
33655
|
+
{ 'sourceId': sourceId },
|
|
33656
|
+
{ },
|
|
33657
|
+
{ },
|
|
33658
|
+
{ },
|
|
33659
|
+
null,
|
|
33660
|
+
['PureCloud OAuth'],
|
|
33661
|
+
['application/json'],
|
|
33662
|
+
['application/json']
|
|
33663
|
+
);
|
|
33664
|
+
}
|
|
33665
|
+
|
|
33205
33666
|
/**
|
|
33206
33667
|
* Delete a Presence Definition
|
|
33207
33668
|
*
|
|
@@ -33227,6 +33688,80 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33227
33688
|
);
|
|
33228
33689
|
}
|
|
33229
33690
|
|
|
33691
|
+
/**
|
|
33692
|
+
* Get a Presence Source
|
|
33693
|
+
*
|
|
33694
|
+
* @param {String} sourceId Presence Source ID
|
|
33695
|
+
*/
|
|
33696
|
+
getPresenceSource(sourceId) {
|
|
33697
|
+
// verify the required parameter 'sourceId' is set
|
|
33698
|
+
if (sourceId === undefined || sourceId === null) {
|
|
33699
|
+
throw 'Missing the required parameter "sourceId" when calling getPresenceSource';
|
|
33700
|
+
}
|
|
33701
|
+
|
|
33702
|
+
return this.apiClient.callApi(
|
|
33703
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
33704
|
+
'GET',
|
|
33705
|
+
{ 'sourceId': sourceId },
|
|
33706
|
+
{ },
|
|
33707
|
+
{ },
|
|
33708
|
+
{ },
|
|
33709
|
+
null,
|
|
33710
|
+
['PureCloud OAuth'],
|
|
33711
|
+
['application/json'],
|
|
33712
|
+
['application/json']
|
|
33713
|
+
);
|
|
33714
|
+
}
|
|
33715
|
+
|
|
33716
|
+
/**
|
|
33717
|
+
* Get a list of Presence Sources
|
|
33718
|
+
*
|
|
33719
|
+
* @param {Object} opts Optional parameters
|
|
33720
|
+
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
33721
|
+
*/
|
|
33722
|
+
getPresenceSources(opts) {
|
|
33723
|
+
opts = opts || {};
|
|
33724
|
+
|
|
33725
|
+
|
|
33726
|
+
return this.apiClient.callApi(
|
|
33727
|
+
'/api/v2/presence/sources',
|
|
33728
|
+
'GET',
|
|
33729
|
+
{ },
|
|
33730
|
+
{ 'deactivated': opts['deactivated'] },
|
|
33731
|
+
{ },
|
|
33732
|
+
{ },
|
|
33733
|
+
null,
|
|
33734
|
+
['PureCloud OAuth'],
|
|
33735
|
+
['application/json'],
|
|
33736
|
+
['application/json']
|
|
33737
|
+
);
|
|
33738
|
+
}
|
|
33739
|
+
|
|
33740
|
+
/**
|
|
33741
|
+
* Get a user's Primary Presence Source
|
|
33742
|
+
*
|
|
33743
|
+
* @param {String} userId user ID
|
|
33744
|
+
*/
|
|
33745
|
+
getPresenceUserPrimarysource(userId) {
|
|
33746
|
+
// verify the required parameter 'userId' is set
|
|
33747
|
+
if (userId === undefined || userId === null) {
|
|
33748
|
+
throw 'Missing the required parameter "userId" when calling getPresenceUserPrimarysource';
|
|
33749
|
+
}
|
|
33750
|
+
|
|
33751
|
+
return this.apiClient.callApi(
|
|
33752
|
+
'/api/v2/presence/users/{userId}/primarysource',
|
|
33753
|
+
'GET',
|
|
33754
|
+
{ 'userId': userId },
|
|
33755
|
+
{ },
|
|
33756
|
+
{ },
|
|
33757
|
+
{ },
|
|
33758
|
+
null,
|
|
33759
|
+
['PureCloud OAuth'],
|
|
33760
|
+
['application/json'],
|
|
33761
|
+
['application/json']
|
|
33762
|
+
);
|
|
33763
|
+
}
|
|
33764
|
+
|
|
33230
33765
|
/**
|
|
33231
33766
|
* Get a Presence Definition
|
|
33232
33767
|
*
|
|
@@ -33423,6 +33958,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33423
33958
|
);
|
|
33424
33959
|
}
|
|
33425
33960
|
|
|
33961
|
+
/**
|
|
33962
|
+
* Create a Presence Source
|
|
33963
|
+
*
|
|
33964
|
+
* @param {Object} body The Presence Source to create
|
|
33965
|
+
*/
|
|
33966
|
+
postPresenceSources(body) {
|
|
33967
|
+
// verify the required parameter 'body' is set
|
|
33968
|
+
if (body === undefined || body === null) {
|
|
33969
|
+
throw 'Missing the required parameter "body" when calling postPresenceSources';
|
|
33970
|
+
}
|
|
33971
|
+
|
|
33972
|
+
return this.apiClient.callApi(
|
|
33973
|
+
'/api/v2/presence/sources',
|
|
33974
|
+
'POST',
|
|
33975
|
+
{ },
|
|
33976
|
+
{ },
|
|
33977
|
+
{ },
|
|
33978
|
+
{ },
|
|
33979
|
+
body,
|
|
33980
|
+
['PureCloud OAuth'],
|
|
33981
|
+
['application/json'],
|
|
33982
|
+
['application/json']
|
|
33983
|
+
);
|
|
33984
|
+
}
|
|
33985
|
+
|
|
33426
33986
|
/**
|
|
33427
33987
|
* Create a Presence Definition
|
|
33428
33988
|
*
|
|
@@ -33448,6 +34008,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33448
34008
|
);
|
|
33449
34009
|
}
|
|
33450
34010
|
|
|
34011
|
+
/**
|
|
34012
|
+
* Update a Presence Source
|
|
34013
|
+
*
|
|
34014
|
+
* @param {String} sourceId Presence Source ID
|
|
34015
|
+
* @param {Object} body The updated Presence Source
|
|
34016
|
+
*/
|
|
34017
|
+
putPresenceSource(sourceId, body) {
|
|
34018
|
+
// verify the required parameter 'sourceId' is set
|
|
34019
|
+
if (sourceId === undefined || sourceId === null) {
|
|
34020
|
+
throw 'Missing the required parameter "sourceId" when calling putPresenceSource';
|
|
34021
|
+
}
|
|
34022
|
+
// verify the required parameter 'body' is set
|
|
34023
|
+
if (body === undefined || body === null) {
|
|
34024
|
+
throw 'Missing the required parameter "body" when calling putPresenceSource';
|
|
34025
|
+
}
|
|
34026
|
+
|
|
34027
|
+
return this.apiClient.callApi(
|
|
34028
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
34029
|
+
'PUT',
|
|
34030
|
+
{ 'sourceId': sourceId },
|
|
34031
|
+
{ },
|
|
34032
|
+
{ },
|
|
34033
|
+
{ },
|
|
34034
|
+
body,
|
|
34035
|
+
['PureCloud OAuth'],
|
|
34036
|
+
['application/json'],
|
|
34037
|
+
['application/json']
|
|
34038
|
+
);
|
|
34039
|
+
}
|
|
34040
|
+
|
|
34041
|
+
/**
|
|
34042
|
+
* Update a user's Primary Presence Source
|
|
34043
|
+
*
|
|
34044
|
+
* @param {String} userId user ID
|
|
34045
|
+
* @param {Object} body Primary Source
|
|
34046
|
+
*/
|
|
34047
|
+
putPresenceUserPrimarysource(userId, body) {
|
|
34048
|
+
// verify the required parameter 'userId' is set
|
|
34049
|
+
if (userId === undefined || userId === null) {
|
|
34050
|
+
throw 'Missing the required parameter "userId" when calling putPresenceUserPrimarysource';
|
|
34051
|
+
}
|
|
34052
|
+
// verify the required parameter 'body' is set
|
|
34053
|
+
if (body === undefined || body === null) {
|
|
34054
|
+
throw 'Missing the required parameter "body" when calling putPresenceUserPrimarysource';
|
|
34055
|
+
}
|
|
34056
|
+
|
|
34057
|
+
return this.apiClient.callApi(
|
|
34058
|
+
'/api/v2/presence/users/{userId}/primarysource',
|
|
34059
|
+
'PUT',
|
|
34060
|
+
{ 'userId': userId },
|
|
34061
|
+
{ },
|
|
34062
|
+
{ },
|
|
34063
|
+
{ },
|
|
34064
|
+
body,
|
|
34065
|
+
['PureCloud OAuth'],
|
|
34066
|
+
['application/json'],
|
|
34067
|
+
['application/json']
|
|
34068
|
+
);
|
|
34069
|
+
}
|
|
34070
|
+
|
|
33451
34071
|
/**
|
|
33452
34072
|
* Update a Presence Definition
|
|
33453
34073
|
*
|
|
@@ -33509,7 +34129,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33509
34129
|
/**
|
|
33510
34130
|
* ProcessAutomation service.
|
|
33511
34131
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
33512
|
-
* @version
|
|
34132
|
+
* @version 151.0.0
|
|
33513
34133
|
*/
|
|
33514
34134
|
|
|
33515
34135
|
/**
|
|
@@ -33550,7 +34170,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33550
34170
|
}
|
|
33551
34171
|
|
|
33552
34172
|
/**
|
|
33553
|
-
* Retrieve a single Trigger matching id
|
|
34173
|
+
* Retrieve a single Trigger matching id
|
|
33554
34174
|
*
|
|
33555
34175
|
* @param {String} triggerId triggerId
|
|
33556
34176
|
*/
|
|
@@ -33575,13 +34195,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33575
34195
|
}
|
|
33576
34196
|
|
|
33577
34197
|
/**
|
|
33578
|
-
* Retrieves all triggers
|
|
34198
|
+
* Retrieves all triggers, optionally filtered by query parameters.
|
|
33579
34199
|
*
|
|
33580
34200
|
* @param {Object} opts Optional parameters
|
|
33581
34201
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
33582
34202
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
33583
34203
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
33584
|
-
* @param {String} opts.topicName Topic name
|
|
34204
|
+
* @param {String} opts.topicName Topic name(s). Separated by commas
|
|
33585
34205
|
* @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
|
|
33586
34206
|
*/
|
|
33587
34207
|
getProcessautomationTriggers(opts) {
|
|
@@ -33747,7 +34367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33747
34367
|
/**
|
|
33748
34368
|
* Quality service.
|
|
33749
34369
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
33750
|
-
* @version
|
|
34370
|
+
* @version 151.0.0
|
|
33751
34371
|
*/
|
|
33752
34372
|
|
|
33753
34373
|
/**
|
|
@@ -35325,7 +35945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35325
35945
|
/**
|
|
35326
35946
|
* Recording service.
|
|
35327
35947
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35328
|
-
* @version
|
|
35948
|
+
* @version 151.0.0
|
|
35329
35949
|
*/
|
|
35330
35950
|
|
|
35331
35951
|
/**
|
|
@@ -36430,7 +37050,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36430
37050
|
|
|
36431
37051
|
/**
|
|
36432
37052
|
* Create a recording bulk job.
|
|
36433
|
-
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
37053
|
+
* 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.
|
|
36434
37054
|
* @param {Object} body query
|
|
36435
37055
|
*/
|
|
36436
37056
|
postRecordingJobs(body) {
|
|
@@ -37012,7 +37632,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37012
37632
|
/**
|
|
37013
37633
|
* ResponseManagement service.
|
|
37014
37634
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37015
|
-
* @version
|
|
37635
|
+
* @version 151.0.0
|
|
37016
37636
|
*/
|
|
37017
37637
|
|
|
37018
37638
|
/**
|
|
@@ -37496,7 +38116,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37496
38116
|
/**
|
|
37497
38117
|
* Routing service.
|
|
37498
38118
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
37499
|
-
* @version
|
|
38119
|
+
* @version 151.0.0
|
|
37500
38120
|
*/
|
|
37501
38121
|
|
|
37502
38122
|
/**
|
|
@@ -37591,6 +38211,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37591
38211
|
);
|
|
37592
38212
|
}
|
|
37593
38213
|
|
|
38214
|
+
/**
|
|
38215
|
+
* Delete an outbound domain
|
|
38216
|
+
*
|
|
38217
|
+
* @param {String} domainId domain ID
|
|
38218
|
+
*/
|
|
38219
|
+
deleteRoutingEmailOutboundDomain(domainId) {
|
|
38220
|
+
// verify the required parameter 'domainId' is set
|
|
38221
|
+
if (domainId === undefined || domainId === null) {
|
|
38222
|
+
throw 'Missing the required parameter "domainId" when calling deleteRoutingEmailOutboundDomain';
|
|
38223
|
+
}
|
|
38224
|
+
|
|
38225
|
+
return this.apiClient.callApi(
|
|
38226
|
+
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
38227
|
+
'DELETE',
|
|
38228
|
+
{ 'domainId': domainId },
|
|
38229
|
+
{ },
|
|
38230
|
+
{ },
|
|
38231
|
+
{ },
|
|
38232
|
+
null,
|
|
38233
|
+
['PureCloud OAuth'],
|
|
38234
|
+
['application/json'],
|
|
38235
|
+
['application/json']
|
|
38236
|
+
);
|
|
38237
|
+
}
|
|
38238
|
+
|
|
37594
38239
|
/**
|
|
37595
38240
|
* Delete single predictor.
|
|
37596
38241
|
*
|
|
@@ -38192,6 +38837,101 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38192
38837
|
);
|
|
38193
38838
|
}
|
|
38194
38839
|
|
|
38840
|
+
/**
|
|
38841
|
+
* Get domain
|
|
38842
|
+
*
|
|
38843
|
+
* @param {String} domainId domain ID
|
|
38844
|
+
*/
|
|
38845
|
+
getRoutingEmailOutboundDomain(domainId) {
|
|
38846
|
+
// verify the required parameter 'domainId' is set
|
|
38847
|
+
if (domainId === undefined || domainId === null) {
|
|
38848
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomain';
|
|
38849
|
+
}
|
|
38850
|
+
|
|
38851
|
+
return this.apiClient.callApi(
|
|
38852
|
+
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
38853
|
+
'GET',
|
|
38854
|
+
{ 'domainId': domainId },
|
|
38855
|
+
{ },
|
|
38856
|
+
{ },
|
|
38857
|
+
{ },
|
|
38858
|
+
null,
|
|
38859
|
+
['PureCloud OAuth'],
|
|
38860
|
+
['application/json'],
|
|
38861
|
+
['application/json']
|
|
38862
|
+
);
|
|
38863
|
+
}
|
|
38864
|
+
|
|
38865
|
+
/**
|
|
38866
|
+
* Get activation status (cname + dkim) of an outbound domain
|
|
38867
|
+
*
|
|
38868
|
+
* @param {String} domainId domain ID
|
|
38869
|
+
*/
|
|
38870
|
+
getRoutingEmailOutboundDomainActivation(domainId) {
|
|
38871
|
+
// verify the required parameter 'domainId' is set
|
|
38872
|
+
if (domainId === undefined || domainId === null) {
|
|
38873
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainActivation';
|
|
38874
|
+
}
|
|
38875
|
+
|
|
38876
|
+
return this.apiClient.callApi(
|
|
38877
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/activation',
|
|
38878
|
+
'GET',
|
|
38879
|
+
{ 'domainId': domainId },
|
|
38880
|
+
{ },
|
|
38881
|
+
{ },
|
|
38882
|
+
{ },
|
|
38883
|
+
null,
|
|
38884
|
+
['PureCloud OAuth'],
|
|
38885
|
+
['application/json'],
|
|
38886
|
+
['application/json']
|
|
38887
|
+
);
|
|
38888
|
+
}
|
|
38889
|
+
|
|
38890
|
+
/**
|
|
38891
|
+
* Search a domain across organizations
|
|
38892
|
+
*
|
|
38893
|
+
* @param {String} domainId domain ID
|
|
38894
|
+
*/
|
|
38895
|
+
getRoutingEmailOutboundDomainSearch(domainId) {
|
|
38896
|
+
// verify the required parameter 'domainId' is set
|
|
38897
|
+
if (domainId === undefined || domainId === null) {
|
|
38898
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainSearch';
|
|
38899
|
+
}
|
|
38900
|
+
|
|
38901
|
+
return this.apiClient.callApi(
|
|
38902
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/search',
|
|
38903
|
+
'GET',
|
|
38904
|
+
{ 'domainId': domainId },
|
|
38905
|
+
{ },
|
|
38906
|
+
{ },
|
|
38907
|
+
{ },
|
|
38908
|
+
null,
|
|
38909
|
+
['PureCloud OAuth'],
|
|
38910
|
+
['application/json'],
|
|
38911
|
+
['application/json']
|
|
38912
|
+
);
|
|
38913
|
+
}
|
|
38914
|
+
|
|
38915
|
+
/**
|
|
38916
|
+
* Get outbound domains
|
|
38917
|
+
*
|
|
38918
|
+
*/
|
|
38919
|
+
getRoutingEmailOutboundDomains() {
|
|
38920
|
+
|
|
38921
|
+
return this.apiClient.callApi(
|
|
38922
|
+
'/api/v2/routing/email/outbound/domains',
|
|
38923
|
+
'GET',
|
|
38924
|
+
{ },
|
|
38925
|
+
{ },
|
|
38926
|
+
{ },
|
|
38927
|
+
{ },
|
|
38928
|
+
null,
|
|
38929
|
+
['PureCloud OAuth'],
|
|
38930
|
+
['application/json'],
|
|
38931
|
+
['application/json']
|
|
38932
|
+
);
|
|
38933
|
+
}
|
|
38934
|
+
|
|
38195
38935
|
/**
|
|
38196
38936
|
* Get email setup
|
|
38197
38937
|
*
|
|
@@ -39829,6 +40569,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39829
40569
|
);
|
|
39830
40570
|
}
|
|
39831
40571
|
|
|
40572
|
+
/**
|
|
40573
|
+
* Create a domain
|
|
40574
|
+
*
|
|
40575
|
+
* @param {Object} body Domain
|
|
40576
|
+
*/
|
|
40577
|
+
postRoutingEmailOutboundDomains(body) {
|
|
40578
|
+
// verify the required parameter 'body' is set
|
|
40579
|
+
if (body === undefined || body === null) {
|
|
40580
|
+
throw 'Missing the required parameter "body" when calling postRoutingEmailOutboundDomains';
|
|
40581
|
+
}
|
|
40582
|
+
|
|
40583
|
+
return this.apiClient.callApi(
|
|
40584
|
+
'/api/v2/routing/email/outbound/domains',
|
|
40585
|
+
'POST',
|
|
40586
|
+
{ },
|
|
40587
|
+
{ },
|
|
40588
|
+
{ },
|
|
40589
|
+
{ },
|
|
40590
|
+
body,
|
|
40591
|
+
['PureCloud OAuth'],
|
|
40592
|
+
['application/json'],
|
|
40593
|
+
['application/json']
|
|
40594
|
+
);
|
|
40595
|
+
}
|
|
40596
|
+
|
|
40597
|
+
/**
|
|
40598
|
+
* Create a simulated domain
|
|
40599
|
+
*
|
|
40600
|
+
* @param {Object} body Domain
|
|
40601
|
+
*/
|
|
40602
|
+
postRoutingEmailOutboundDomainsSimulated(body) {
|
|
40603
|
+
// verify the required parameter 'body' is set
|
|
40604
|
+
if (body === undefined || body === null) {
|
|
40605
|
+
throw 'Missing the required parameter "body" when calling postRoutingEmailOutboundDomainsSimulated';
|
|
40606
|
+
}
|
|
40607
|
+
|
|
40608
|
+
return this.apiClient.callApi(
|
|
40609
|
+
'/api/v2/routing/email/outbound/domains/simulated',
|
|
40610
|
+
'POST',
|
|
40611
|
+
{ },
|
|
40612
|
+
{ },
|
|
40613
|
+
{ },
|
|
40614
|
+
{ },
|
|
40615
|
+
body,
|
|
40616
|
+
['PureCloud OAuth'],
|
|
40617
|
+
['application/json'],
|
|
40618
|
+
['application/json']
|
|
40619
|
+
);
|
|
40620
|
+
}
|
|
40621
|
+
|
|
39832
40622
|
/**
|
|
39833
40623
|
* Create Language
|
|
39834
40624
|
*
|
|
@@ -40196,6 +40986,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40196
40986
|
);
|
|
40197
40987
|
}
|
|
40198
40988
|
|
|
40989
|
+
/**
|
|
40990
|
+
* Request an activation status (cname + dkim) update of an outbound domain
|
|
40991
|
+
*
|
|
40992
|
+
* @param {String} domainId domain ID
|
|
40993
|
+
*/
|
|
40994
|
+
putRoutingEmailOutboundDomainActivation(domainId) {
|
|
40995
|
+
// verify the required parameter 'domainId' is set
|
|
40996
|
+
if (domainId === undefined || domainId === null) {
|
|
40997
|
+
throw 'Missing the required parameter "domainId" when calling putRoutingEmailOutboundDomainActivation';
|
|
40998
|
+
}
|
|
40999
|
+
|
|
41000
|
+
return this.apiClient.callApi(
|
|
41001
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/activation',
|
|
41002
|
+
'PUT',
|
|
41003
|
+
{ 'domainId': domainId },
|
|
41004
|
+
{ },
|
|
41005
|
+
{ },
|
|
41006
|
+
{ },
|
|
41007
|
+
null,
|
|
41008
|
+
['PureCloud OAuth'],
|
|
41009
|
+
['application/json'],
|
|
41010
|
+
['application/json']
|
|
41011
|
+
);
|
|
41012
|
+
}
|
|
41013
|
+
|
|
40199
41014
|
/**
|
|
40200
41015
|
* Update a recipient
|
|
40201
41016
|
*
|
|
@@ -40492,7 +41307,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40492
41307
|
/**
|
|
40493
41308
|
* SCIM service.
|
|
40494
41309
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
40495
|
-
* @version
|
|
41310
|
+
* @version 151.0.0
|
|
40496
41311
|
*/
|
|
40497
41312
|
|
|
40498
41313
|
/**
|
|
@@ -41369,7 +42184,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41369
42184
|
/**
|
|
41370
42185
|
* Scripts service.
|
|
41371
42186
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
41372
|
-
* @version
|
|
42187
|
+
* @version 151.0.0
|
|
41373
42188
|
*/
|
|
41374
42189
|
|
|
41375
42190
|
/**
|
|
@@ -41788,7 +42603,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41788
42603
|
/**
|
|
41789
42604
|
* Search service.
|
|
41790
42605
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
41791
|
-
* @version
|
|
42606
|
+
* @version 151.0.0
|
|
41792
42607
|
*/
|
|
41793
42608
|
|
|
41794
42609
|
/**
|
|
@@ -42317,6 +43132,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42317
43132
|
);
|
|
42318
43133
|
}
|
|
42319
43134
|
|
|
43135
|
+
/**
|
|
43136
|
+
* Search users assigned to teams
|
|
43137
|
+
*
|
|
43138
|
+
* @param {Object} body Search request options
|
|
43139
|
+
*/
|
|
43140
|
+
postUsersSearchTeamsAssign(body) {
|
|
43141
|
+
// verify the required parameter 'body' is set
|
|
43142
|
+
if (body === undefined || body === null) {
|
|
43143
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
43144
|
+
}
|
|
43145
|
+
|
|
43146
|
+
return this.apiClient.callApi(
|
|
43147
|
+
'/api/v2/users/search/teams/assign',
|
|
43148
|
+
'POST',
|
|
43149
|
+
{ },
|
|
43150
|
+
{ },
|
|
43151
|
+
{ },
|
|
43152
|
+
{ },
|
|
43153
|
+
body,
|
|
43154
|
+
['PureCloud OAuth'],
|
|
43155
|
+
['application/json'],
|
|
43156
|
+
['application/json']
|
|
43157
|
+
);
|
|
43158
|
+
}
|
|
43159
|
+
|
|
42320
43160
|
/**
|
|
42321
43161
|
* Search voicemails
|
|
42322
43162
|
*
|
|
@@ -42348,7 +43188,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42348
43188
|
/**
|
|
42349
43189
|
* SpeechTextAnalytics service.
|
|
42350
43190
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
42351
|
-
* @version
|
|
43191
|
+
* @version 151.0.0
|
|
42352
43192
|
*/
|
|
42353
43193
|
|
|
42354
43194
|
/**
|
|
@@ -43202,7 +44042,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43202
44042
|
/**
|
|
43203
44043
|
* Stations service.
|
|
43204
44044
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
43205
|
-
* @version
|
|
44045
|
+
* @version 151.0.0
|
|
43206
44046
|
*/
|
|
43207
44047
|
|
|
43208
44048
|
/**
|
|
@@ -43349,7 +44189,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43349
44189
|
/**
|
|
43350
44190
|
* Suggest service.
|
|
43351
44191
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
43352
|
-
* @version
|
|
44192
|
+
* @version 151.0.0
|
|
43353
44193
|
*/
|
|
43354
44194
|
|
|
43355
44195
|
/**
|
|
@@ -43488,7 +44328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43488
44328
|
/**
|
|
43489
44329
|
* Teams service.
|
|
43490
44330
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
43491
|
-
* @version
|
|
44331
|
+
* @version 151.0.0
|
|
43492
44332
|
*/
|
|
43493
44333
|
|
|
43494
44334
|
/**
|
|
@@ -43528,6 +44368,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43528
44368
|
);
|
|
43529
44369
|
}
|
|
43530
44370
|
|
|
44371
|
+
/**
|
|
44372
|
+
* Delete team members
|
|
44373
|
+
*
|
|
44374
|
+
* @param {String} teamId Team ID
|
|
44375
|
+
* @param {String} id Comma separated list of member ids to remove
|
|
44376
|
+
*/
|
|
44377
|
+
deleteTeamMembers(teamId, id) {
|
|
44378
|
+
// verify the required parameter 'teamId' is set
|
|
44379
|
+
if (teamId === undefined || teamId === null) {
|
|
44380
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeamMembers';
|
|
44381
|
+
}
|
|
44382
|
+
// verify the required parameter 'id' is set
|
|
44383
|
+
if (id === undefined || id === null) {
|
|
44384
|
+
throw 'Missing the required parameter "id" when calling deleteTeamMembers';
|
|
44385
|
+
}
|
|
44386
|
+
|
|
44387
|
+
return this.apiClient.callApi(
|
|
44388
|
+
'/api/v2/teams/{teamId}/members',
|
|
44389
|
+
'DELETE',
|
|
44390
|
+
{ 'teamId': teamId },
|
|
44391
|
+
{ 'id': id },
|
|
44392
|
+
{ },
|
|
44393
|
+
{ },
|
|
44394
|
+
null,
|
|
44395
|
+
['PureCloud OAuth'],
|
|
44396
|
+
['application/json'],
|
|
44397
|
+
['application/json']
|
|
44398
|
+
);
|
|
44399
|
+
}
|
|
44400
|
+
|
|
43531
44401
|
/**
|
|
43532
44402
|
* Get team
|
|
43533
44403
|
*
|
|
@@ -43553,6 +44423,38 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43553
44423
|
);
|
|
43554
44424
|
}
|
|
43555
44425
|
|
|
44426
|
+
/**
|
|
44427
|
+
* Get team membership
|
|
44428
|
+
*
|
|
44429
|
+
* @param {String} teamId Team ID
|
|
44430
|
+
* @param {Object} opts Optional parameters
|
|
44431
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
44432
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
44433
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
44434
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
44435
|
+
*/
|
|
44436
|
+
getTeamMembers(teamId, opts) {
|
|
44437
|
+
opts = opts || {};
|
|
44438
|
+
|
|
44439
|
+
// verify the required parameter 'teamId' is set
|
|
44440
|
+
if (teamId === undefined || teamId === null) {
|
|
44441
|
+
throw 'Missing the required parameter "teamId" when calling getTeamMembers';
|
|
44442
|
+
}
|
|
44443
|
+
|
|
44444
|
+
return this.apiClient.callApi(
|
|
44445
|
+
'/api/v2/teams/{teamId}/members',
|
|
44446
|
+
'GET',
|
|
44447
|
+
{ 'teamId': teamId },
|
|
44448
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'],'expand': opts['expand'] },
|
|
44449
|
+
{ },
|
|
44450
|
+
{ },
|
|
44451
|
+
null,
|
|
44452
|
+
['PureCloud OAuth'],
|
|
44453
|
+
['application/json'],
|
|
44454
|
+
['application/json']
|
|
44455
|
+
);
|
|
44456
|
+
}
|
|
44457
|
+
|
|
43556
44458
|
/**
|
|
43557
44459
|
* Get Team listing
|
|
43558
44460
|
*
|
|
@@ -43611,6 +44513,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43611
44513
|
);
|
|
43612
44514
|
}
|
|
43613
44515
|
|
|
44516
|
+
/**
|
|
44517
|
+
* Add team members
|
|
44518
|
+
*
|
|
44519
|
+
* @param {String} teamId Team ID
|
|
44520
|
+
* @param {Object} body TeamMembers
|
|
44521
|
+
*/
|
|
44522
|
+
postTeamMembers(teamId, body) {
|
|
44523
|
+
// verify the required parameter 'teamId' is set
|
|
44524
|
+
if (teamId === undefined || teamId === null) {
|
|
44525
|
+
throw 'Missing the required parameter "teamId" when calling postTeamMembers';
|
|
44526
|
+
}
|
|
44527
|
+
// verify the required parameter 'body' is set
|
|
44528
|
+
if (body === undefined || body === null) {
|
|
44529
|
+
throw 'Missing the required parameter "body" when calling postTeamMembers';
|
|
44530
|
+
}
|
|
44531
|
+
|
|
44532
|
+
return this.apiClient.callApi(
|
|
44533
|
+
'/api/v2/teams/{teamId}/members',
|
|
44534
|
+
'POST',
|
|
44535
|
+
{ 'teamId': teamId },
|
|
44536
|
+
{ },
|
|
44537
|
+
{ },
|
|
44538
|
+
{ },
|
|
44539
|
+
body,
|
|
44540
|
+
['PureCloud OAuth'],
|
|
44541
|
+
['application/json'],
|
|
44542
|
+
['application/json']
|
|
44543
|
+
);
|
|
44544
|
+
}
|
|
44545
|
+
|
|
43614
44546
|
/**
|
|
43615
44547
|
* Create a team
|
|
43616
44548
|
*
|
|
@@ -43667,7 +44599,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43667
44599
|
/**
|
|
43668
44600
|
* Telephony service.
|
|
43669
44601
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
43670
|
-
* @version
|
|
44602
|
+
* @version 151.0.0
|
|
43671
44603
|
*/
|
|
43672
44604
|
|
|
43673
44605
|
/**
|
|
@@ -43775,7 +44707,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43775
44707
|
/**
|
|
43776
44708
|
* TelephonyProvidersEdge service.
|
|
43777
44709
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
43778
|
-
* @version
|
|
44710
|
+
* @version 151.0.0
|
|
43779
44711
|
*/
|
|
43780
44712
|
|
|
43781
44713
|
/**
|
|
@@ -47408,7 +48340,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47408
48340
|
/**
|
|
47409
48341
|
* Textbots service.
|
|
47410
48342
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
47411
|
-
* @version
|
|
48343
|
+
* @version 151.0.0
|
|
47412
48344
|
*/
|
|
47413
48345
|
|
|
47414
48346
|
/**
|
|
@@ -47536,7 +48468,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47536
48468
|
/**
|
|
47537
48469
|
* Tokens service.
|
|
47538
48470
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
47539
|
-
* @version
|
|
48471
|
+
* @version 151.0.0
|
|
47540
48472
|
*/
|
|
47541
48473
|
|
|
47542
48474
|
/**
|
|
@@ -47642,7 +48574,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47642
48574
|
/**
|
|
47643
48575
|
* Uploads service.
|
|
47644
48576
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
47645
|
-
* @version
|
|
48577
|
+
* @version 151.0.0
|
|
47646
48578
|
*/
|
|
47647
48579
|
|
|
47648
48580
|
/**
|
|
@@ -47818,7 +48750,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47818
48750
|
/**
|
|
47819
48751
|
* Usage service.
|
|
47820
48752
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
47821
|
-
* @version
|
|
48753
|
+
* @version 151.0.0
|
|
47822
48754
|
*/
|
|
47823
48755
|
|
|
47824
48756
|
/**
|
|
@@ -47889,7 +48821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47889
48821
|
/**
|
|
47890
48822
|
* UserRecordings service.
|
|
47891
48823
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
47892
|
-
* @version
|
|
48824
|
+
* @version 151.0.0
|
|
47893
48825
|
*/
|
|
47894
48826
|
|
|
47895
48827
|
/**
|
|
@@ -48074,7 +49006,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48074
49006
|
/**
|
|
48075
49007
|
* Users service.
|
|
48076
49008
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
48077
|
-
* @version
|
|
49009
|
+
* @version 151.0.0
|
|
48078
49010
|
*/
|
|
48079
49011
|
|
|
48080
49012
|
/**
|
|
@@ -50065,6 +50997,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50065
50997
|
);
|
|
50066
50998
|
}
|
|
50067
50999
|
|
|
51000
|
+
/**
|
|
51001
|
+
* Search users assigned to teams
|
|
51002
|
+
*
|
|
51003
|
+
* @param {Object} body Search request options
|
|
51004
|
+
*/
|
|
51005
|
+
postUsersSearchTeamsAssign(body) {
|
|
51006
|
+
// verify the required parameter 'body' is set
|
|
51007
|
+
if (body === undefined || body === null) {
|
|
51008
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
51009
|
+
}
|
|
51010
|
+
|
|
51011
|
+
return this.apiClient.callApi(
|
|
51012
|
+
'/api/v2/users/search/teams/assign',
|
|
51013
|
+
'POST',
|
|
51014
|
+
{ },
|
|
51015
|
+
{ },
|
|
51016
|
+
{ },
|
|
51017
|
+
{ },
|
|
51018
|
+
body,
|
|
51019
|
+
['PureCloud OAuth'],
|
|
51020
|
+
['application/json'],
|
|
51021
|
+
['application/json']
|
|
51022
|
+
);
|
|
51023
|
+
}
|
|
51024
|
+
|
|
50068
51025
|
/**
|
|
50069
51026
|
* Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
|
50070
51027
|
*
|
|
@@ -50406,7 +51363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50406
51363
|
/**
|
|
50407
51364
|
* Utilities service.
|
|
50408
51365
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
50409
|
-
* @version
|
|
51366
|
+
* @version 151.0.0
|
|
50410
51367
|
*/
|
|
50411
51368
|
|
|
50412
51369
|
/**
|
|
@@ -50517,7 +51474,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50517
51474
|
/**
|
|
50518
51475
|
* Voicemail service.
|
|
50519
51476
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
50520
|
-
* @version
|
|
51477
|
+
* @version 151.0.0
|
|
50521
51478
|
*/
|
|
50522
51479
|
|
|
50523
51480
|
/**
|
|
@@ -51184,7 +52141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51184
52141
|
/**
|
|
51185
52142
|
* WebChat service.
|
|
51186
52143
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
51187
|
-
* @version
|
|
52144
|
+
* @version 151.0.0
|
|
51188
52145
|
*/
|
|
51189
52146
|
|
|
51190
52147
|
/**
|
|
@@ -51728,7 +52685,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51728
52685
|
/**
|
|
51729
52686
|
* WebDeployments service.
|
|
51730
52687
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
51731
|
-
* @version
|
|
52688
|
+
* @version 151.0.0
|
|
51732
52689
|
*/
|
|
51733
52690
|
|
|
51734
52691
|
/**
|
|
@@ -52116,7 +53073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52116
53073
|
/**
|
|
52117
53074
|
* WebMessaging service.
|
|
52118
53075
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
52119
|
-
* @version
|
|
53076
|
+
* @version 151.0.0
|
|
52120
53077
|
*/
|
|
52121
53078
|
|
|
52122
53079
|
/**
|
|
@@ -52162,7 +53119,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52162
53119
|
/**
|
|
52163
53120
|
* Widgets service.
|
|
52164
53121
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
52165
|
-
* @version
|
|
53122
|
+
* @version 151.0.0
|
|
52166
53123
|
*/
|
|
52167
53124
|
|
|
52168
53125
|
/**
|
|
@@ -52308,7 +53265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52308
53265
|
/**
|
|
52309
53266
|
* WorkforceManagement service.
|
|
52310
53267
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
52311
|
-
* @version
|
|
53268
|
+
* @version 151.0.0
|
|
52312
53269
|
*/
|
|
52313
53270
|
|
|
52314
53271
|
/**
|
|
@@ -56088,6 +57045,76 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56088
57045
|
);
|
|
56089
57046
|
}
|
|
56090
57047
|
|
|
57048
|
+
/**
|
|
57049
|
+
* Query time off balances for a given user for specified activity code and dates
|
|
57050
|
+
*
|
|
57051
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
57052
|
+
* @param {String} userId The ID of the user
|
|
57053
|
+
* @param {Object} body The request body
|
|
57054
|
+
*/
|
|
57055
|
+
postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId, userId, body) {
|
|
57056
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57057
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57058
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57059
|
+
}
|
|
57060
|
+
// verify the required parameter 'userId' is set
|
|
57061
|
+
if (userId === undefined || userId === null) {
|
|
57062
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57063
|
+
}
|
|
57064
|
+
// verify the required parameter 'body' is set
|
|
57065
|
+
if (body === undefined || body === null) {
|
|
57066
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57067
|
+
}
|
|
57068
|
+
|
|
57069
|
+
return this.apiClient.callApi(
|
|
57070
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs',
|
|
57071
|
+
'POST',
|
|
57072
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
57073
|
+
{ },
|
|
57074
|
+
{ },
|
|
57075
|
+
{ },
|
|
57076
|
+
body,
|
|
57077
|
+
['PureCloud OAuth'],
|
|
57078
|
+
['application/json'],
|
|
57079
|
+
['application/json']
|
|
57080
|
+
);
|
|
57081
|
+
}
|
|
57082
|
+
|
|
57083
|
+
/**
|
|
57084
|
+
* Query time off balances for dates spanned by a given time off request
|
|
57085
|
+
*
|
|
57086
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
57087
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
57088
|
+
* @param {String} timeOffRequestId The time off request id.
|
|
57089
|
+
*/
|
|
57090
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId, userId, timeOffRequestId) {
|
|
57091
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57092
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57093
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57094
|
+
}
|
|
57095
|
+
// verify the required parameter 'userId' is set
|
|
57096
|
+
if (userId === undefined || userId === null) {
|
|
57097
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57098
|
+
}
|
|
57099
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
57100
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
57101
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57102
|
+
}
|
|
57103
|
+
|
|
57104
|
+
return this.apiClient.callApi(
|
|
57105
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs',
|
|
57106
|
+
'POST',
|
|
57107
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
57108
|
+
{ },
|
|
57109
|
+
{ },
|
|
57110
|
+
{ },
|
|
57111
|
+
null,
|
|
57112
|
+
['PureCloud OAuth'],
|
|
57113
|
+
['application/json'],
|
|
57114
|
+
['application/json']
|
|
57115
|
+
);
|
|
57116
|
+
}
|
|
57117
|
+
|
|
56091
57118
|
/**
|
|
56092
57119
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
56093
57120
|
*
|
|
@@ -56584,7 +57611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56584
57611
|
* </pre>
|
|
56585
57612
|
* </p>
|
|
56586
57613
|
* @module purecloud-platform-client-v2/index
|
|
56587
|
-
* @version
|
|
57614
|
+
* @version 151.0.0
|
|
56588
57615
|
*/
|
|
56589
57616
|
class platformClient {
|
|
56590
57617
|
constructor() {
|
|
@@ -56653,6 +57680,16 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56653
57680
|
* @property {module:purecloud-platform-client-v2/api/DataExtensionsApi}
|
|
56654
57681
|
*/
|
|
56655
57682
|
this.DataExtensionsApi = DataExtensionsApi;
|
|
57683
|
+
/**
|
|
57684
|
+
* The DownloadsApi service constructor.
|
|
57685
|
+
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|
|
57686
|
+
*/
|
|
57687
|
+
this.DownloadsApi = DownloadsApi;
|
|
57688
|
+
/**
|
|
57689
|
+
* The EventsApi service constructor.
|
|
57690
|
+
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|
|
57691
|
+
*/
|
|
57692
|
+
this.EventsApi = EventsApi;
|
|
56656
57693
|
/**
|
|
56657
57694
|
* The ExternalContactsApi service constructor.
|
|
56658
57695
|
* @property {module:purecloud-platform-client-v2/api/ExternalContactsApi}
|