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
|
@@ -9307,7 +9307,7 @@ class Configuration {
|
|
|
9307
9307
|
|
|
9308
9308
|
/**
|
|
9309
9309
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9310
|
-
* @version
|
|
9310
|
+
* @version 151.0.0
|
|
9311
9311
|
*/
|
|
9312
9312
|
class ApiClient {
|
|
9313
9313
|
/**
|
|
@@ -10379,7 +10379,7 @@ class AlertingApi {
|
|
|
10379
10379
|
/**
|
|
10380
10380
|
* Alerting service.
|
|
10381
10381
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10382
|
-
* @version
|
|
10382
|
+
* @version 151.0.0
|
|
10383
10383
|
*/
|
|
10384
10384
|
|
|
10385
10385
|
/**
|
|
@@ -10693,7 +10693,7 @@ class AnalyticsApi {
|
|
|
10693
10693
|
/**
|
|
10694
10694
|
* Analytics service.
|
|
10695
10695
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
10696
|
-
* @version
|
|
10696
|
+
* @version 151.0.0
|
|
10697
10697
|
*/
|
|
10698
10698
|
|
|
10699
10699
|
/**
|
|
@@ -11920,7 +11920,7 @@ class ArchitectApi {
|
|
|
11920
11920
|
/**
|
|
11921
11921
|
* Architect service.
|
|
11922
11922
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
11923
|
-
* @version
|
|
11923
|
+
* @version 151.0.0
|
|
11924
11924
|
*/
|
|
11925
11925
|
|
|
11926
11926
|
/**
|
|
@@ -14966,7 +14966,7 @@ class AuditApi {
|
|
|
14966
14966
|
/**
|
|
14967
14967
|
* Audit service.
|
|
14968
14968
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14969
|
-
* @version
|
|
14969
|
+
* @version 151.0.0
|
|
14970
14970
|
*/
|
|
14971
14971
|
|
|
14972
14972
|
/**
|
|
@@ -15137,7 +15137,7 @@ class AuthorizationApi {
|
|
|
15137
15137
|
/**
|
|
15138
15138
|
* Authorization service.
|
|
15139
15139
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
15140
|
-
* @version
|
|
15140
|
+
* @version 151.0.0
|
|
15141
15141
|
*/
|
|
15142
15142
|
|
|
15143
15143
|
/**
|
|
@@ -16320,7 +16320,7 @@ class BillingApi {
|
|
|
16320
16320
|
/**
|
|
16321
16321
|
* Billing service.
|
|
16322
16322
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16323
|
-
* @version
|
|
16323
|
+
* @version 151.0.0
|
|
16324
16324
|
*/
|
|
16325
16325
|
|
|
16326
16326
|
/**
|
|
@@ -16400,7 +16400,7 @@ class ChatApi {
|
|
|
16400
16400
|
/**
|
|
16401
16401
|
* Chat service.
|
|
16402
16402
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
16403
|
-
* @version
|
|
16403
|
+
* @version 151.0.0
|
|
16404
16404
|
*/
|
|
16405
16405
|
|
|
16406
16406
|
/**
|
|
@@ -16491,7 +16491,7 @@ class CoachingApi {
|
|
|
16491
16491
|
/**
|
|
16492
16492
|
* Coaching service.
|
|
16493
16493
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16494
|
-
* @version
|
|
16494
|
+
* @version 151.0.0
|
|
16495
16495
|
*/
|
|
16496
16496
|
|
|
16497
16497
|
/**
|
|
@@ -17068,7 +17068,7 @@ class ContentManagementApi {
|
|
|
17068
17068
|
/**
|
|
17069
17069
|
* ContentManagement service.
|
|
17070
17070
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17071
|
-
* @version
|
|
17071
|
+
* @version 151.0.0
|
|
17072
17072
|
*/
|
|
17073
17073
|
|
|
17074
17074
|
/**
|
|
@@ -18208,7 +18208,7 @@ class ConversationsApi {
|
|
|
18208
18208
|
/**
|
|
18209
18209
|
* Conversations service.
|
|
18210
18210
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18211
|
-
* @version
|
|
18211
|
+
* @version 151.0.0
|
|
18212
18212
|
*/
|
|
18213
18213
|
|
|
18214
18214
|
/**
|
|
@@ -19718,8 +19718,12 @@ class ConversationsApi {
|
|
|
19718
19718
|
* Get message
|
|
19719
19719
|
*
|
|
19720
19720
|
* @param {String} messageId messageId
|
|
19721
|
+
* @param {Object} opts Optional parameters
|
|
19722
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
19721
19723
|
*/
|
|
19722
|
-
getConversationsMessageDetails(messageId) {
|
|
19724
|
+
getConversationsMessageDetails(messageId, opts) {
|
|
19725
|
+
opts = opts || {};
|
|
19726
|
+
|
|
19723
19727
|
// verify the required parameter 'messageId' is set
|
|
19724
19728
|
if (messageId === undefined || messageId === null) {
|
|
19725
19729
|
throw 'Missing the required parameter "messageId" when calling getConversationsMessageDetails';
|
|
@@ -19729,7 +19733,7 @@ class ConversationsApi {
|
|
|
19729
19733
|
'/api/v2/conversations/messages/{messageId}/details',
|
|
19730
19734
|
'GET',
|
|
19731
19735
|
{ 'messageId': messageId },
|
|
19732
|
-
{
|
|
19736
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
19733
19737
|
{ },
|
|
19734
19738
|
{ },
|
|
19735
19739
|
null,
|
|
@@ -19744,8 +19748,12 @@ class ConversationsApi {
|
|
|
19744
19748
|
*
|
|
19745
19749
|
* @param {String} conversationId conversationId
|
|
19746
19750
|
* @param {String} messageId messageId
|
|
19751
|
+
* @param {Object} opts Optional parameters
|
|
19752
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
19747
19753
|
*/
|
|
19748
|
-
getConversationsMessageMessage(conversationId, messageId) {
|
|
19754
|
+
getConversationsMessageMessage(conversationId, messageId, opts) {
|
|
19755
|
+
opts = opts || {};
|
|
19756
|
+
|
|
19749
19757
|
// verify the required parameter 'conversationId' is set
|
|
19750
19758
|
if (conversationId === undefined || conversationId === null) {
|
|
19751
19759
|
throw 'Missing the required parameter "conversationId" when calling getConversationsMessageMessage';
|
|
@@ -19759,7 +19767,7 @@ class ConversationsApi {
|
|
|
19759
19767
|
'/api/v2/conversations/messages/{conversationId}/messages/{messageId}',
|
|
19760
19768
|
'GET',
|
|
19761
19769
|
{ 'conversationId': conversationId,'messageId': messageId },
|
|
19762
|
-
{
|
|
19770
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
19763
19771
|
{ },
|
|
19764
19772
|
{ },
|
|
19765
19773
|
null,
|
|
@@ -22377,6 +22385,31 @@ class ConversationsApi {
|
|
|
22377
22385
|
);
|
|
22378
22386
|
}
|
|
22379
22387
|
|
|
22388
|
+
/**
|
|
22389
|
+
* Create an email conversation, per API
|
|
22390
|
+
*
|
|
22391
|
+
* @param {Object} body Create agentless email request
|
|
22392
|
+
*/
|
|
22393
|
+
postConversationsEmailsAgentless(body) {
|
|
22394
|
+
// verify the required parameter 'body' is set
|
|
22395
|
+
if (body === undefined || body === null) {
|
|
22396
|
+
throw 'Missing the required parameter "body" when calling postConversationsEmailsAgentless';
|
|
22397
|
+
}
|
|
22398
|
+
|
|
22399
|
+
return this.apiClient.callApi(
|
|
22400
|
+
'/api/v2/conversations/emails/agentless',
|
|
22401
|
+
'POST',
|
|
22402
|
+
{ },
|
|
22403
|
+
{ },
|
|
22404
|
+
{ },
|
|
22405
|
+
{ },
|
|
22406
|
+
body,
|
|
22407
|
+
['PureCloud OAuth'],
|
|
22408
|
+
['application/json'],
|
|
22409
|
+
['application/json']
|
|
22410
|
+
);
|
|
22411
|
+
}
|
|
22412
|
+
|
|
22380
22413
|
/**
|
|
22381
22414
|
* Create Fax Conversation
|
|
22382
22415
|
*
|
|
@@ -22458,8 +22491,12 @@ class ConversationsApi {
|
|
|
22458
22491
|
* @param {String} conversationId conversationId
|
|
22459
22492
|
* @param {String} communicationId communicationId
|
|
22460
22493
|
* @param {Object} body Message
|
|
22494
|
+
* @param {Object} opts Optional parameters
|
|
22495
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
22461
22496
|
*/
|
|
22462
|
-
postConversationsMessageCommunicationMessages(conversationId, communicationId, body) {
|
|
22497
|
+
postConversationsMessageCommunicationMessages(conversationId, communicationId, body, opts) {
|
|
22498
|
+
opts = opts || {};
|
|
22499
|
+
|
|
22463
22500
|
// verify the required parameter 'conversationId' is set
|
|
22464
22501
|
if (conversationId === undefined || conversationId === null) {
|
|
22465
22502
|
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessages';
|
|
@@ -22477,7 +22514,7 @@ class ConversationsApi {
|
|
|
22477
22514
|
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages',
|
|
22478
22515
|
'POST',
|
|
22479
22516
|
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
22480
|
-
{
|
|
22517
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
22481
22518
|
{ },
|
|
22482
22519
|
{ },
|
|
22483
22520
|
body,
|
|
@@ -22517,11 +22554,47 @@ class ConversationsApi {
|
|
|
22517
22554
|
);
|
|
22518
22555
|
}
|
|
22519
22556
|
|
|
22557
|
+
/**
|
|
22558
|
+
* Send message typing event
|
|
22559
|
+
* Send message typing event for existing conversation/communication.
|
|
22560
|
+
* @param {String} conversationId conversationId
|
|
22561
|
+
* @param {String} communicationId communicationId
|
|
22562
|
+
* @param {Object} body MessageTypingEvent
|
|
22563
|
+
*/
|
|
22564
|
+
postConversationsMessageCommunicationTyping(conversationId, communicationId, body) {
|
|
22565
|
+
// verify the required parameter 'conversationId' is set
|
|
22566
|
+
if (conversationId === undefined || conversationId === null) {
|
|
22567
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationTyping';
|
|
22568
|
+
}
|
|
22569
|
+
// verify the required parameter 'communicationId' is set
|
|
22570
|
+
if (communicationId === undefined || communicationId === null) {
|
|
22571
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationTyping';
|
|
22572
|
+
}
|
|
22573
|
+
// verify the required parameter 'body' is set
|
|
22574
|
+
if (body === undefined || body === null) {
|
|
22575
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationTyping';
|
|
22576
|
+
}
|
|
22577
|
+
|
|
22578
|
+
return this.apiClient.callApi(
|
|
22579
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing',
|
|
22580
|
+
'POST',
|
|
22581
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
22582
|
+
{ },
|
|
22583
|
+
{ },
|
|
22584
|
+
{ },
|
|
22585
|
+
body,
|
|
22586
|
+
['PureCloud OAuth'],
|
|
22587
|
+
['application/json'],
|
|
22588
|
+
['application/json']
|
|
22589
|
+
);
|
|
22590
|
+
}
|
|
22591
|
+
|
|
22520
22592
|
/**
|
|
22521
22593
|
* Get messages in batch
|
|
22522
22594
|
* 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"]
|
|
22523
22595
|
* @param {String} conversationId
|
|
22524
22596
|
* @param {Object} opts Optional parameters
|
|
22597
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
22525
22598
|
* @param {Array.<String>} opts.body messageIds
|
|
22526
22599
|
*/
|
|
22527
22600
|
postConversationsMessageMessagesBulk(conversationId, opts) {
|
|
@@ -22536,7 +22609,7 @@ class ConversationsApi {
|
|
|
22536
22609
|
'/api/v2/conversations/messages/{conversationId}/messages/bulk',
|
|
22537
22610
|
'POST',
|
|
22538
22611
|
{ 'conversationId': conversationId },
|
|
22539
|
-
{
|
|
22612
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
22540
22613
|
{ },
|
|
22541
22614
|
{ },
|
|
22542
22615
|
opts['body'],
|
|
@@ -23352,7 +23425,7 @@ class DataExtensionsApi {
|
|
|
23352
23425
|
/**
|
|
23353
23426
|
* DataExtensions service.
|
|
23354
23427
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23355
|
-
* @version
|
|
23428
|
+
* @version 151.0.0
|
|
23356
23429
|
*/
|
|
23357
23430
|
|
|
23358
23431
|
/**
|
|
@@ -23434,11 +23507,159 @@ class DataExtensionsApi {
|
|
|
23434
23507
|
|
|
23435
23508
|
}
|
|
23436
23509
|
|
|
23510
|
+
class DownloadsApi {
|
|
23511
|
+
/**
|
|
23512
|
+
* Downloads service.
|
|
23513
|
+
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
23514
|
+
* @version 151.0.0
|
|
23515
|
+
*/
|
|
23516
|
+
|
|
23517
|
+
/**
|
|
23518
|
+
* Constructs a new DownloadsApi.
|
|
23519
|
+
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
23520
|
+
* @class
|
|
23521
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
23522
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
23523
|
+
*/
|
|
23524
|
+
constructor(apiClient) {
|
|
23525
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
23526
|
+
}
|
|
23527
|
+
|
|
23528
|
+
|
|
23529
|
+
/**
|
|
23530
|
+
* Issues a redirect to a signed secure download URL for specified download
|
|
23531
|
+
* this method will issue a redirect to the url to the content
|
|
23532
|
+
* @param {String} downloadId Download ID
|
|
23533
|
+
* @param {Object} opts Optional parameters
|
|
23534
|
+
* @param {String} opts.contentDisposition
|
|
23535
|
+
* @param {Boolean} opts.issueRedirect (default to true)
|
|
23536
|
+
* @param {Boolean} opts.redirectToAuth (default to true)
|
|
23537
|
+
*/
|
|
23538
|
+
getDownload(downloadId, opts) {
|
|
23539
|
+
opts = opts || {};
|
|
23540
|
+
|
|
23541
|
+
// verify the required parameter 'downloadId' is set
|
|
23542
|
+
if (downloadId === undefined || downloadId === null) {
|
|
23543
|
+
throw 'Missing the required parameter "downloadId" when calling getDownload';
|
|
23544
|
+
}
|
|
23545
|
+
|
|
23546
|
+
return this.apiClient.callApi(
|
|
23547
|
+
'/api/v2/downloads/{downloadId}',
|
|
23548
|
+
'GET',
|
|
23549
|
+
{ 'downloadId': downloadId },
|
|
23550
|
+
{ 'contentDisposition': opts['contentDisposition'],'issueRedirect': opts['issueRedirect'],'redirectToAuth': opts['redirectToAuth'] },
|
|
23551
|
+
{ },
|
|
23552
|
+
{ },
|
|
23553
|
+
null,
|
|
23554
|
+
['PureCloud OAuth'],
|
|
23555
|
+
['application/json'],
|
|
23556
|
+
['application/json']
|
|
23557
|
+
);
|
|
23558
|
+
}
|
|
23559
|
+
|
|
23560
|
+
}
|
|
23561
|
+
|
|
23562
|
+
class EventsApi {
|
|
23563
|
+
/**
|
|
23564
|
+
* Events service.
|
|
23565
|
+
* @module purecloud-platform-client-v2/api/EventsApi
|
|
23566
|
+
* @version 151.0.0
|
|
23567
|
+
*/
|
|
23568
|
+
|
|
23569
|
+
/**
|
|
23570
|
+
* Constructs a new EventsApi.
|
|
23571
|
+
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
23572
|
+
* @class
|
|
23573
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
23574
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
23575
|
+
*/
|
|
23576
|
+
constructor(apiClient) {
|
|
23577
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
23578
|
+
}
|
|
23579
|
+
|
|
23580
|
+
|
|
23581
|
+
/**
|
|
23582
|
+
* Publish Conversation Batch Events
|
|
23583
|
+
*
|
|
23584
|
+
* @param {Object} body batchRequest
|
|
23585
|
+
*/
|
|
23586
|
+
postEventsConversations(body) {
|
|
23587
|
+
// verify the required parameter 'body' is set
|
|
23588
|
+
if (body === undefined || body === null) {
|
|
23589
|
+
throw 'Missing the required parameter "body" when calling postEventsConversations';
|
|
23590
|
+
}
|
|
23591
|
+
|
|
23592
|
+
return this.apiClient.callApi(
|
|
23593
|
+
'/api/v2/events/conversations',
|
|
23594
|
+
'POST',
|
|
23595
|
+
{ },
|
|
23596
|
+
{ },
|
|
23597
|
+
{ },
|
|
23598
|
+
{ },
|
|
23599
|
+
body,
|
|
23600
|
+
['PureCloud OAuth'],
|
|
23601
|
+
['application/json'],
|
|
23602
|
+
['application/json']
|
|
23603
|
+
);
|
|
23604
|
+
}
|
|
23605
|
+
|
|
23606
|
+
/**
|
|
23607
|
+
* Publish User Presence Status Batch Events
|
|
23608
|
+
*
|
|
23609
|
+
* @param {Object} body batchRequest
|
|
23610
|
+
*/
|
|
23611
|
+
postEventsUsersPresence(body) {
|
|
23612
|
+
// verify the required parameter 'body' is set
|
|
23613
|
+
if (body === undefined || body === null) {
|
|
23614
|
+
throw 'Missing the required parameter "body" when calling postEventsUsersPresence';
|
|
23615
|
+
}
|
|
23616
|
+
|
|
23617
|
+
return this.apiClient.callApi(
|
|
23618
|
+
'/api/v2/events/users/presence',
|
|
23619
|
+
'POST',
|
|
23620
|
+
{ },
|
|
23621
|
+
{ },
|
|
23622
|
+
{ },
|
|
23623
|
+
{ },
|
|
23624
|
+
body,
|
|
23625
|
+
['PureCloud OAuth'],
|
|
23626
|
+
['application/json'],
|
|
23627
|
+
['application/json']
|
|
23628
|
+
);
|
|
23629
|
+
}
|
|
23630
|
+
|
|
23631
|
+
/**
|
|
23632
|
+
* Publish Agent Routing Status Batch Events
|
|
23633
|
+
*
|
|
23634
|
+
* @param {Object} body batchRequest
|
|
23635
|
+
*/
|
|
23636
|
+
postEventsUsersRoutingstatus(body) {
|
|
23637
|
+
// verify the required parameter 'body' is set
|
|
23638
|
+
if (body === undefined || body === null) {
|
|
23639
|
+
throw 'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';
|
|
23640
|
+
}
|
|
23641
|
+
|
|
23642
|
+
return this.apiClient.callApi(
|
|
23643
|
+
'/api/v2/events/users/routingstatus',
|
|
23644
|
+
'POST',
|
|
23645
|
+
{ },
|
|
23646
|
+
{ },
|
|
23647
|
+
{ },
|
|
23648
|
+
{ },
|
|
23649
|
+
body,
|
|
23650
|
+
['PureCloud OAuth'],
|
|
23651
|
+
['application/json'],
|
|
23652
|
+
['application/json']
|
|
23653
|
+
);
|
|
23654
|
+
}
|
|
23655
|
+
|
|
23656
|
+
}
|
|
23657
|
+
|
|
23437
23658
|
class ExternalContactsApi {
|
|
23438
23659
|
/**
|
|
23439
23660
|
* ExternalContacts service.
|
|
23440
23661
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23441
|
-
* @version
|
|
23662
|
+
* @version 151.0.0
|
|
23442
23663
|
*/
|
|
23443
23664
|
|
|
23444
23665
|
/**
|
|
@@ -23667,6 +23888,62 @@ class ExternalContactsApi {
|
|
|
23667
23888
|
);
|
|
23668
23889
|
}
|
|
23669
23890
|
|
|
23891
|
+
/**
|
|
23892
|
+
* List the identifiers for a contact
|
|
23893
|
+
*
|
|
23894
|
+
* @param {String} contactId ExternalContact ID
|
|
23895
|
+
*/
|
|
23896
|
+
getExternalcontactsContactIdentifiers(contactId) {
|
|
23897
|
+
// verify the required parameter 'contactId' is set
|
|
23898
|
+
if (contactId === undefined || contactId === null) {
|
|
23899
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactIdentifiers';
|
|
23900
|
+
}
|
|
23901
|
+
|
|
23902
|
+
return this.apiClient.callApi(
|
|
23903
|
+
'/api/v2/externalcontacts/contacts/{contactId}/identifiers',
|
|
23904
|
+
'GET',
|
|
23905
|
+
{ 'contactId': contactId },
|
|
23906
|
+
{ },
|
|
23907
|
+
{ },
|
|
23908
|
+
{ },
|
|
23909
|
+
null,
|
|
23910
|
+
['PureCloud OAuth'],
|
|
23911
|
+
['application/json'],
|
|
23912
|
+
['application/json']
|
|
23913
|
+
);
|
|
23914
|
+
}
|
|
23915
|
+
|
|
23916
|
+
/**
|
|
23917
|
+
* Retrieve all sessions for a given external contact.
|
|
23918
|
+
*
|
|
23919
|
+
* @param {String} contactId ExternalContact ID
|
|
23920
|
+
* @param {Object} opts Optional parameters
|
|
23921
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23922
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23923
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
23924
|
+
*/
|
|
23925
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
23926
|
+
opts = opts || {};
|
|
23927
|
+
|
|
23928
|
+
// verify the required parameter 'contactId' is set
|
|
23929
|
+
if (contactId === undefined || contactId === null) {
|
|
23930
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
23931
|
+
}
|
|
23932
|
+
|
|
23933
|
+
return this.apiClient.callApi(
|
|
23934
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
23935
|
+
'GET',
|
|
23936
|
+
{ 'contactId': contactId },
|
|
23937
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
23938
|
+
{ },
|
|
23939
|
+
{ },
|
|
23940
|
+
null,
|
|
23941
|
+
['PureCloud OAuth'],
|
|
23942
|
+
['application/json'],
|
|
23943
|
+
['application/json']
|
|
23944
|
+
);
|
|
23945
|
+
}
|
|
23946
|
+
|
|
23670
23947
|
/**
|
|
23671
23948
|
* Fetch a note for an external contact
|
|
23672
23949
|
*
|
|
@@ -23733,6 +24010,35 @@ class ExternalContactsApi {
|
|
|
23733
24010
|
);
|
|
23734
24011
|
}
|
|
23735
24012
|
|
|
24013
|
+
/**
|
|
24014
|
+
* Fetch an unresolved external contact
|
|
24015
|
+
*
|
|
24016
|
+
* @param {String} contactId ExternalContact ID
|
|
24017
|
+
* @param {Object} opts Optional parameters
|
|
24018
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
24019
|
+
*/
|
|
24020
|
+
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
24021
|
+
opts = opts || {};
|
|
24022
|
+
|
|
24023
|
+
// verify the required parameter 'contactId' is set
|
|
24024
|
+
if (contactId === undefined || contactId === null) {
|
|
24025
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactUnresolved';
|
|
24026
|
+
}
|
|
24027
|
+
|
|
24028
|
+
return this.apiClient.callApi(
|
|
24029
|
+
'/api/v2/externalcontacts/contacts/{contactId}/unresolved',
|
|
24030
|
+
'GET',
|
|
24031
|
+
{ 'contactId': contactId },
|
|
24032
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
24033
|
+
{ },
|
|
24034
|
+
{ },
|
|
24035
|
+
null,
|
|
24036
|
+
['PureCloud OAuth'],
|
|
24037
|
+
['application/json'],
|
|
24038
|
+
['application/json']
|
|
24039
|
+
);
|
|
24040
|
+
}
|
|
24041
|
+
|
|
23736
24042
|
/**
|
|
23737
24043
|
* Search for external contacts
|
|
23738
24044
|
*
|
|
@@ -24310,6 +24616,36 @@ class ExternalContactsApi {
|
|
|
24310
24616
|
);
|
|
24311
24617
|
}
|
|
24312
24618
|
|
|
24619
|
+
/**
|
|
24620
|
+
* Claim or release identifiers for a contact
|
|
24621
|
+
*
|
|
24622
|
+
* @param {String} contactId ExternalContact ID
|
|
24623
|
+
* @param {Object} body ClaimRequest
|
|
24624
|
+
*/
|
|
24625
|
+
patchExternalcontactsContactIdentifiers(contactId, body) {
|
|
24626
|
+
// verify the required parameter 'contactId' is set
|
|
24627
|
+
if (contactId === undefined || contactId === null) {
|
|
24628
|
+
throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContactIdentifiers';
|
|
24629
|
+
}
|
|
24630
|
+
// verify the required parameter 'body' is set
|
|
24631
|
+
if (body === undefined || body === null) {
|
|
24632
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsContactIdentifiers';
|
|
24633
|
+
}
|
|
24634
|
+
|
|
24635
|
+
return this.apiClient.callApi(
|
|
24636
|
+
'/api/v2/externalcontacts/contacts/{contactId}/identifiers',
|
|
24637
|
+
'PATCH',
|
|
24638
|
+
{ 'contactId': contactId },
|
|
24639
|
+
{ },
|
|
24640
|
+
{ },
|
|
24641
|
+
{ },
|
|
24642
|
+
body,
|
|
24643
|
+
['PureCloud OAuth'],
|
|
24644
|
+
['application/json'],
|
|
24645
|
+
['application/json']
|
|
24646
|
+
);
|
|
24647
|
+
}
|
|
24648
|
+
|
|
24313
24649
|
/**
|
|
24314
24650
|
* Bulk fetch contacts
|
|
24315
24651
|
*
|
|
@@ -24385,6 +24721,31 @@ class ExternalContactsApi {
|
|
|
24385
24721
|
);
|
|
24386
24722
|
}
|
|
24387
24723
|
|
|
24724
|
+
/**
|
|
24725
|
+
* Bulk fetch unresolved ancestor contacts
|
|
24726
|
+
*
|
|
24727
|
+
* @param {Object} body Contact ids
|
|
24728
|
+
*/
|
|
24729
|
+
postExternalcontactsBulkContactsUnresolved(body) {
|
|
24730
|
+
// verify the required parameter 'body' is set
|
|
24731
|
+
if (body === undefined || body === null) {
|
|
24732
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsUnresolved';
|
|
24733
|
+
}
|
|
24734
|
+
|
|
24735
|
+
return this.apiClient.callApi(
|
|
24736
|
+
'/api/v2/externalcontacts/bulk/contacts/unresolved',
|
|
24737
|
+
'POST',
|
|
24738
|
+
{ },
|
|
24739
|
+
{ },
|
|
24740
|
+
{ },
|
|
24741
|
+
{ },
|
|
24742
|
+
body,
|
|
24743
|
+
['PureCloud OAuth'],
|
|
24744
|
+
['application/json'],
|
|
24745
|
+
['application/json']
|
|
24746
|
+
);
|
|
24747
|
+
}
|
|
24748
|
+
|
|
24388
24749
|
/**
|
|
24389
24750
|
* Bulk update contacts
|
|
24390
24751
|
*
|
|
@@ -24740,6 +25101,31 @@ class ExternalContactsApi {
|
|
|
24740
25101
|
);
|
|
24741
25102
|
}
|
|
24742
25103
|
|
|
25104
|
+
/**
|
|
25105
|
+
* Promote an observed contact (ephemeral or identified) to a curated contact
|
|
25106
|
+
*
|
|
25107
|
+
* @param {String} contactId ExternalContact ID
|
|
25108
|
+
*/
|
|
25109
|
+
postExternalcontactsContactPromotion(contactId) {
|
|
25110
|
+
// verify the required parameter 'contactId' is set
|
|
25111
|
+
if (contactId === undefined || contactId === null) {
|
|
25112
|
+
throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactPromotion';
|
|
25113
|
+
}
|
|
25114
|
+
|
|
25115
|
+
return this.apiClient.callApi(
|
|
25116
|
+
'/api/v2/externalcontacts/contacts/{contactId}/promotion',
|
|
25117
|
+
'POST',
|
|
25118
|
+
{ 'contactId': contactId },
|
|
25119
|
+
{ },
|
|
25120
|
+
{ },
|
|
25121
|
+
{ },
|
|
25122
|
+
null,
|
|
25123
|
+
['PureCloud OAuth'],
|
|
25124
|
+
['application/json'],
|
|
25125
|
+
['application/json']
|
|
25126
|
+
);
|
|
25127
|
+
}
|
|
25128
|
+
|
|
24743
25129
|
/**
|
|
24744
25130
|
* Create an external contact
|
|
24745
25131
|
*
|
|
@@ -24790,6 +25176,56 @@ class ExternalContactsApi {
|
|
|
24790
25176
|
);
|
|
24791
25177
|
}
|
|
24792
25178
|
|
|
25179
|
+
/**
|
|
25180
|
+
* Fetch a contact using an identifier type and value.
|
|
25181
|
+
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
25182
|
+
* @param {Object} identifier
|
|
25183
|
+
*/
|
|
25184
|
+
postExternalcontactsIdentifierlookup(identifier) {
|
|
25185
|
+
// verify the required parameter 'identifier' is set
|
|
25186
|
+
if (identifier === undefined || identifier === null) {
|
|
25187
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';
|
|
25188
|
+
}
|
|
25189
|
+
|
|
25190
|
+
return this.apiClient.callApi(
|
|
25191
|
+
'/api/v2/externalcontacts/identifierlookup',
|
|
25192
|
+
'POST',
|
|
25193
|
+
{ },
|
|
25194
|
+
{ },
|
|
25195
|
+
{ },
|
|
25196
|
+
{ },
|
|
25197
|
+
identifier,
|
|
25198
|
+
['PureCloud OAuth'],
|
|
25199
|
+
['application/json'],
|
|
25200
|
+
['application/json']
|
|
25201
|
+
);
|
|
25202
|
+
}
|
|
25203
|
+
|
|
25204
|
+
/**
|
|
25205
|
+
* Merge two contacts into a new contact record
|
|
25206
|
+
*
|
|
25207
|
+
* @param {Object} body MergeRequest
|
|
25208
|
+
*/
|
|
25209
|
+
postExternalcontactsMergeContacts(body) {
|
|
25210
|
+
// verify the required parameter 'body' is set
|
|
25211
|
+
if (body === undefined || body === null) {
|
|
25212
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsMergeContacts';
|
|
25213
|
+
}
|
|
25214
|
+
|
|
25215
|
+
return this.apiClient.callApi(
|
|
25216
|
+
'/api/v2/externalcontacts/merge/contacts',
|
|
25217
|
+
'POST',
|
|
25218
|
+
{ },
|
|
25219
|
+
{ },
|
|
25220
|
+
{ },
|
|
25221
|
+
{ },
|
|
25222
|
+
body,
|
|
25223
|
+
['PureCloud OAuth'],
|
|
25224
|
+
['application/json'],
|
|
25225
|
+
['application/json']
|
|
25226
|
+
);
|
|
25227
|
+
}
|
|
25228
|
+
|
|
24793
25229
|
/**
|
|
24794
25230
|
* Create a note for an external organization
|
|
24795
25231
|
*
|
|
@@ -25181,7 +25617,7 @@ class FaxApi {
|
|
|
25181
25617
|
/**
|
|
25182
25618
|
* Fax service.
|
|
25183
25619
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25184
|
-
* @version
|
|
25620
|
+
* @version 151.0.0
|
|
25185
25621
|
*/
|
|
25186
25622
|
|
|
25187
25623
|
/**
|
|
@@ -25352,7 +25788,7 @@ class FlowsApi {
|
|
|
25352
25788
|
/**
|
|
25353
25789
|
* Flows service.
|
|
25354
25790
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25355
|
-
* @version
|
|
25791
|
+
* @version 151.0.0
|
|
25356
25792
|
*/
|
|
25357
25793
|
|
|
25358
25794
|
/**
|
|
@@ -25423,7 +25859,7 @@ class GamificationApi {
|
|
|
25423
25859
|
/**
|
|
25424
25860
|
* Gamification service.
|
|
25425
25861
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25426
|
-
* @version
|
|
25862
|
+
* @version 151.0.0
|
|
25427
25863
|
*/
|
|
25428
25864
|
|
|
25429
25865
|
/**
|
|
@@ -27104,7 +27540,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
27104
27540
|
/**
|
|
27105
27541
|
* GeneralDataProtectionRegulation service.
|
|
27106
27542
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27107
|
-
* @version
|
|
27543
|
+
* @version 151.0.0
|
|
27108
27544
|
*/
|
|
27109
27545
|
|
|
27110
27546
|
/**
|
|
@@ -27234,7 +27670,7 @@ class GeolocationApi {
|
|
|
27234
27670
|
/**
|
|
27235
27671
|
* Geolocation service.
|
|
27236
27672
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27237
|
-
* @version
|
|
27673
|
+
* @version 151.0.0
|
|
27238
27674
|
*/
|
|
27239
27675
|
|
|
27240
27676
|
/**
|
|
@@ -27365,7 +27801,7 @@ class GreetingsApi {
|
|
|
27365
27801
|
/**
|
|
27366
27802
|
* Greetings service.
|
|
27367
27803
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27368
|
-
* @version
|
|
27804
|
+
* @version 151.0.0
|
|
27369
27805
|
*/
|
|
27370
27806
|
|
|
27371
27807
|
/**
|
|
@@ -27820,7 +28256,7 @@ class GroupsApi {
|
|
|
27820
28256
|
/**
|
|
27821
28257
|
* Groups service.
|
|
27822
28258
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27823
|
-
* @version
|
|
28259
|
+
* @version 151.0.0
|
|
27824
28260
|
*/
|
|
27825
28261
|
|
|
27826
28262
|
/**
|
|
@@ -28226,7 +28662,7 @@ class IdentityProviderApi {
|
|
|
28226
28662
|
/**
|
|
28227
28663
|
* IdentityProvider service.
|
|
28228
28664
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28229
|
-
* @version
|
|
28665
|
+
* @version 151.0.0
|
|
28230
28666
|
*/
|
|
28231
28667
|
|
|
28232
28668
|
/**
|
|
@@ -28982,7 +29418,7 @@ class IntegrationsApi {
|
|
|
28982
29418
|
/**
|
|
28983
29419
|
* Integrations service.
|
|
28984
29420
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28985
|
-
* @version
|
|
29421
|
+
* @version 151.0.0
|
|
28986
29422
|
*/
|
|
28987
29423
|
|
|
28988
29424
|
/**
|
|
@@ -30582,7 +31018,7 @@ class JourneyApi {
|
|
|
30582
31018
|
/**
|
|
30583
31019
|
* Journey service.
|
|
30584
31020
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30585
|
-
* @version
|
|
31021
|
+
* @version 151.0.0
|
|
30586
31022
|
*/
|
|
30587
31023
|
|
|
30588
31024
|
/**
|
|
@@ -31368,7 +31804,7 @@ class KnowledgeApi {
|
|
|
31368
31804
|
/**
|
|
31369
31805
|
* Knowledge service.
|
|
31370
31806
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31371
|
-
* @version
|
|
31807
|
+
* @version 151.0.0
|
|
31372
31808
|
*/
|
|
31373
31809
|
|
|
31374
31810
|
/**
|
|
@@ -33801,7 +34237,7 @@ class LanguageUnderstandingApi {
|
|
|
33801
34237
|
/**
|
|
33802
34238
|
* LanguageUnderstanding service.
|
|
33803
34239
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
33804
|
-
* @version
|
|
34240
|
+
* @version 151.0.0
|
|
33805
34241
|
*/
|
|
33806
34242
|
|
|
33807
34243
|
/**
|
|
@@ -34705,7 +35141,7 @@ class LanguagesApi {
|
|
|
34705
35141
|
/**
|
|
34706
35142
|
* Languages service.
|
|
34707
35143
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
34708
|
-
* @version
|
|
35144
|
+
* @version 151.0.0
|
|
34709
35145
|
*/
|
|
34710
35146
|
|
|
34711
35147
|
/**
|
|
@@ -34973,7 +35409,7 @@ class LearningApi {
|
|
|
34973
35409
|
/**
|
|
34974
35410
|
* Learning service.
|
|
34975
35411
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
34976
|
-
* @version
|
|
35412
|
+
* @version 151.0.0
|
|
34977
35413
|
*/
|
|
34978
35414
|
|
|
34979
35415
|
/**
|
|
@@ -35733,7 +36169,7 @@ class LicenseApi {
|
|
|
35733
36169
|
/**
|
|
35734
36170
|
* License service.
|
|
35735
36171
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
35736
|
-
* @version
|
|
36172
|
+
* @version 151.0.0
|
|
35737
36173
|
*/
|
|
35738
36174
|
|
|
35739
36175
|
/**
|
|
@@ -35971,7 +36407,7 @@ class LocationsApi {
|
|
|
35971
36407
|
/**
|
|
35972
36408
|
* Locations service.
|
|
35973
36409
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
35974
|
-
* @version
|
|
36410
|
+
* @version 151.0.0
|
|
35975
36411
|
*/
|
|
35976
36412
|
|
|
35977
36413
|
/**
|
|
@@ -36207,7 +36643,7 @@ class MessagingApi {
|
|
|
36207
36643
|
/**
|
|
36208
36644
|
* Messaging service.
|
|
36209
36645
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
36210
|
-
* @version
|
|
36646
|
+
* @version 151.0.0
|
|
36211
36647
|
*/
|
|
36212
36648
|
|
|
36213
36649
|
/**
|
|
@@ -36358,7 +36794,7 @@ class MobileDevicesApi {
|
|
|
36358
36794
|
/**
|
|
36359
36795
|
* MobileDevices service.
|
|
36360
36796
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
36361
|
-
* @version
|
|
36797
|
+
* @version 151.0.0
|
|
36362
36798
|
*/
|
|
36363
36799
|
|
|
36364
36800
|
/**
|
|
@@ -36509,7 +36945,7 @@ class NotificationsApi {
|
|
|
36509
36945
|
/**
|
|
36510
36946
|
* Notifications service.
|
|
36511
36947
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
36512
|
-
* @version
|
|
36948
|
+
* @version 151.0.0
|
|
36513
36949
|
*/
|
|
36514
36950
|
|
|
36515
36951
|
/**
|
|
@@ -36734,7 +37170,7 @@ class OAuthApi {
|
|
|
36734
37170
|
/**
|
|
36735
37171
|
* OAuth service.
|
|
36736
37172
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
36737
|
-
* @version
|
|
37173
|
+
* @version 151.0.0
|
|
36738
37174
|
*/
|
|
36739
37175
|
|
|
36740
37176
|
/**
|
|
@@ -37100,7 +37536,7 @@ class ObjectsApi {
|
|
|
37100
37536
|
/**
|
|
37101
37537
|
* Objects service.
|
|
37102
37538
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
37103
|
-
* @version
|
|
37539
|
+
* @version 151.0.0
|
|
37104
37540
|
*/
|
|
37105
37541
|
|
|
37106
37542
|
/**
|
|
@@ -37371,7 +37807,7 @@ class OrganizationApi {
|
|
|
37371
37807
|
/**
|
|
37372
37808
|
* Organization service.
|
|
37373
37809
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
37374
|
-
* @version
|
|
37810
|
+
* @version 151.0.0
|
|
37375
37811
|
*/
|
|
37376
37812
|
|
|
37377
37813
|
/**
|
|
@@ -37774,7 +38210,7 @@ class OrganizationAuthorizationApi {
|
|
|
37774
38210
|
/**
|
|
37775
38211
|
* OrganizationAuthorization service.
|
|
37776
38212
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
37777
|
-
* @version
|
|
38213
|
+
* @version 151.0.0
|
|
37778
38214
|
*/
|
|
37779
38215
|
|
|
37780
38216
|
/**
|
|
@@ -38699,7 +39135,7 @@ class OutboundApi {
|
|
|
38699
39135
|
/**
|
|
38700
39136
|
* Outbound service.
|
|
38701
39137
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38702
|
-
* @version
|
|
39138
|
+
* @version 151.0.0
|
|
38703
39139
|
*/
|
|
38704
39140
|
|
|
38705
39141
|
/**
|
|
@@ -42088,7 +42524,7 @@ class PresenceApi {
|
|
|
42088
42524
|
/**
|
|
42089
42525
|
* Presence service.
|
|
42090
42526
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
42091
|
-
* @version
|
|
42527
|
+
* @version 151.0.0
|
|
42092
42528
|
*/
|
|
42093
42529
|
|
|
42094
42530
|
/**
|
|
@@ -42103,6 +42539,31 @@ class PresenceApi {
|
|
|
42103
42539
|
}
|
|
42104
42540
|
|
|
42105
42541
|
|
|
42542
|
+
/**
|
|
42543
|
+
* Delete a Presence Source
|
|
42544
|
+
*
|
|
42545
|
+
* @param {String} sourceId Presence Source ID
|
|
42546
|
+
*/
|
|
42547
|
+
deletePresenceSource(sourceId) {
|
|
42548
|
+
// verify the required parameter 'sourceId' is set
|
|
42549
|
+
if (sourceId === undefined || sourceId === null) {
|
|
42550
|
+
throw 'Missing the required parameter "sourceId" when calling deletePresenceSource';
|
|
42551
|
+
}
|
|
42552
|
+
|
|
42553
|
+
return this.apiClient.callApi(
|
|
42554
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
42555
|
+
'DELETE',
|
|
42556
|
+
{ 'sourceId': sourceId },
|
|
42557
|
+
{ },
|
|
42558
|
+
{ },
|
|
42559
|
+
{ },
|
|
42560
|
+
null,
|
|
42561
|
+
['PureCloud OAuth'],
|
|
42562
|
+
['application/json'],
|
|
42563
|
+
['application/json']
|
|
42564
|
+
);
|
|
42565
|
+
}
|
|
42566
|
+
|
|
42106
42567
|
/**
|
|
42107
42568
|
* Delete a Presence Definition
|
|
42108
42569
|
*
|
|
@@ -42128,6 +42589,80 @@ class PresenceApi {
|
|
|
42128
42589
|
);
|
|
42129
42590
|
}
|
|
42130
42591
|
|
|
42592
|
+
/**
|
|
42593
|
+
* Get a Presence Source
|
|
42594
|
+
*
|
|
42595
|
+
* @param {String} sourceId Presence Source ID
|
|
42596
|
+
*/
|
|
42597
|
+
getPresenceSource(sourceId) {
|
|
42598
|
+
// verify the required parameter 'sourceId' is set
|
|
42599
|
+
if (sourceId === undefined || sourceId === null) {
|
|
42600
|
+
throw 'Missing the required parameter "sourceId" when calling getPresenceSource';
|
|
42601
|
+
}
|
|
42602
|
+
|
|
42603
|
+
return this.apiClient.callApi(
|
|
42604
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
42605
|
+
'GET',
|
|
42606
|
+
{ 'sourceId': sourceId },
|
|
42607
|
+
{ },
|
|
42608
|
+
{ },
|
|
42609
|
+
{ },
|
|
42610
|
+
null,
|
|
42611
|
+
['PureCloud OAuth'],
|
|
42612
|
+
['application/json'],
|
|
42613
|
+
['application/json']
|
|
42614
|
+
);
|
|
42615
|
+
}
|
|
42616
|
+
|
|
42617
|
+
/**
|
|
42618
|
+
* Get a list of Presence Sources
|
|
42619
|
+
*
|
|
42620
|
+
* @param {Object} opts Optional parameters
|
|
42621
|
+
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
42622
|
+
*/
|
|
42623
|
+
getPresenceSources(opts) {
|
|
42624
|
+
opts = opts || {};
|
|
42625
|
+
|
|
42626
|
+
|
|
42627
|
+
return this.apiClient.callApi(
|
|
42628
|
+
'/api/v2/presence/sources',
|
|
42629
|
+
'GET',
|
|
42630
|
+
{ },
|
|
42631
|
+
{ 'deactivated': opts['deactivated'] },
|
|
42632
|
+
{ },
|
|
42633
|
+
{ },
|
|
42634
|
+
null,
|
|
42635
|
+
['PureCloud OAuth'],
|
|
42636
|
+
['application/json'],
|
|
42637
|
+
['application/json']
|
|
42638
|
+
);
|
|
42639
|
+
}
|
|
42640
|
+
|
|
42641
|
+
/**
|
|
42642
|
+
* Get a user's Primary Presence Source
|
|
42643
|
+
*
|
|
42644
|
+
* @param {String} userId user ID
|
|
42645
|
+
*/
|
|
42646
|
+
getPresenceUserPrimarysource(userId) {
|
|
42647
|
+
// verify the required parameter 'userId' is set
|
|
42648
|
+
if (userId === undefined || userId === null) {
|
|
42649
|
+
throw 'Missing the required parameter "userId" when calling getPresenceUserPrimarysource';
|
|
42650
|
+
}
|
|
42651
|
+
|
|
42652
|
+
return this.apiClient.callApi(
|
|
42653
|
+
'/api/v2/presence/users/{userId}/primarysource',
|
|
42654
|
+
'GET',
|
|
42655
|
+
{ 'userId': userId },
|
|
42656
|
+
{ },
|
|
42657
|
+
{ },
|
|
42658
|
+
{ },
|
|
42659
|
+
null,
|
|
42660
|
+
['PureCloud OAuth'],
|
|
42661
|
+
['application/json'],
|
|
42662
|
+
['application/json']
|
|
42663
|
+
);
|
|
42664
|
+
}
|
|
42665
|
+
|
|
42131
42666
|
/**
|
|
42132
42667
|
* Get a Presence Definition
|
|
42133
42668
|
*
|
|
@@ -42324,6 +42859,31 @@ class PresenceApi {
|
|
|
42324
42859
|
);
|
|
42325
42860
|
}
|
|
42326
42861
|
|
|
42862
|
+
/**
|
|
42863
|
+
* Create a Presence Source
|
|
42864
|
+
*
|
|
42865
|
+
* @param {Object} body The Presence Source to create
|
|
42866
|
+
*/
|
|
42867
|
+
postPresenceSources(body) {
|
|
42868
|
+
// verify the required parameter 'body' is set
|
|
42869
|
+
if (body === undefined || body === null) {
|
|
42870
|
+
throw 'Missing the required parameter "body" when calling postPresenceSources';
|
|
42871
|
+
}
|
|
42872
|
+
|
|
42873
|
+
return this.apiClient.callApi(
|
|
42874
|
+
'/api/v2/presence/sources',
|
|
42875
|
+
'POST',
|
|
42876
|
+
{ },
|
|
42877
|
+
{ },
|
|
42878
|
+
{ },
|
|
42879
|
+
{ },
|
|
42880
|
+
body,
|
|
42881
|
+
['PureCloud OAuth'],
|
|
42882
|
+
['application/json'],
|
|
42883
|
+
['application/json']
|
|
42884
|
+
);
|
|
42885
|
+
}
|
|
42886
|
+
|
|
42327
42887
|
/**
|
|
42328
42888
|
* Create a Presence Definition
|
|
42329
42889
|
*
|
|
@@ -42349,6 +42909,66 @@ class PresenceApi {
|
|
|
42349
42909
|
);
|
|
42350
42910
|
}
|
|
42351
42911
|
|
|
42912
|
+
/**
|
|
42913
|
+
* Update a Presence Source
|
|
42914
|
+
*
|
|
42915
|
+
* @param {String} sourceId Presence Source ID
|
|
42916
|
+
* @param {Object} body The updated Presence Source
|
|
42917
|
+
*/
|
|
42918
|
+
putPresenceSource(sourceId, body) {
|
|
42919
|
+
// verify the required parameter 'sourceId' is set
|
|
42920
|
+
if (sourceId === undefined || sourceId === null) {
|
|
42921
|
+
throw 'Missing the required parameter "sourceId" when calling putPresenceSource';
|
|
42922
|
+
}
|
|
42923
|
+
// verify the required parameter 'body' is set
|
|
42924
|
+
if (body === undefined || body === null) {
|
|
42925
|
+
throw 'Missing the required parameter "body" when calling putPresenceSource';
|
|
42926
|
+
}
|
|
42927
|
+
|
|
42928
|
+
return this.apiClient.callApi(
|
|
42929
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
42930
|
+
'PUT',
|
|
42931
|
+
{ 'sourceId': sourceId },
|
|
42932
|
+
{ },
|
|
42933
|
+
{ },
|
|
42934
|
+
{ },
|
|
42935
|
+
body,
|
|
42936
|
+
['PureCloud OAuth'],
|
|
42937
|
+
['application/json'],
|
|
42938
|
+
['application/json']
|
|
42939
|
+
);
|
|
42940
|
+
}
|
|
42941
|
+
|
|
42942
|
+
/**
|
|
42943
|
+
* Update a user's Primary Presence Source
|
|
42944
|
+
*
|
|
42945
|
+
* @param {String} userId user ID
|
|
42946
|
+
* @param {Object} body Primary Source
|
|
42947
|
+
*/
|
|
42948
|
+
putPresenceUserPrimarysource(userId, body) {
|
|
42949
|
+
// verify the required parameter 'userId' is set
|
|
42950
|
+
if (userId === undefined || userId === null) {
|
|
42951
|
+
throw 'Missing the required parameter "userId" when calling putPresenceUserPrimarysource';
|
|
42952
|
+
}
|
|
42953
|
+
// verify the required parameter 'body' is set
|
|
42954
|
+
if (body === undefined || body === null) {
|
|
42955
|
+
throw 'Missing the required parameter "body" when calling putPresenceUserPrimarysource';
|
|
42956
|
+
}
|
|
42957
|
+
|
|
42958
|
+
return this.apiClient.callApi(
|
|
42959
|
+
'/api/v2/presence/users/{userId}/primarysource',
|
|
42960
|
+
'PUT',
|
|
42961
|
+
{ 'userId': userId },
|
|
42962
|
+
{ },
|
|
42963
|
+
{ },
|
|
42964
|
+
{ },
|
|
42965
|
+
body,
|
|
42966
|
+
['PureCloud OAuth'],
|
|
42967
|
+
['application/json'],
|
|
42968
|
+
['application/json']
|
|
42969
|
+
);
|
|
42970
|
+
}
|
|
42971
|
+
|
|
42352
42972
|
/**
|
|
42353
42973
|
* Update a Presence Definition
|
|
42354
42974
|
*
|
|
@@ -42410,7 +43030,7 @@ class ProcessAutomationApi {
|
|
|
42410
43030
|
/**
|
|
42411
43031
|
* ProcessAutomation service.
|
|
42412
43032
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
42413
|
-
* @version
|
|
43033
|
+
* @version 151.0.0
|
|
42414
43034
|
*/
|
|
42415
43035
|
|
|
42416
43036
|
/**
|
|
@@ -42451,7 +43071,7 @@ class ProcessAutomationApi {
|
|
|
42451
43071
|
}
|
|
42452
43072
|
|
|
42453
43073
|
/**
|
|
42454
|
-
* Retrieve a single Trigger matching id
|
|
43074
|
+
* Retrieve a single Trigger matching id
|
|
42455
43075
|
*
|
|
42456
43076
|
* @param {String} triggerId triggerId
|
|
42457
43077
|
*/
|
|
@@ -42476,13 +43096,13 @@ class ProcessAutomationApi {
|
|
|
42476
43096
|
}
|
|
42477
43097
|
|
|
42478
43098
|
/**
|
|
42479
|
-
* Retrieves all triggers
|
|
43099
|
+
* Retrieves all triggers, optionally filtered by query parameters.
|
|
42480
43100
|
*
|
|
42481
43101
|
* @param {Object} opts Optional parameters
|
|
42482
43102
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
42483
43103
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
42484
43104
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
42485
|
-
* @param {String} opts.topicName Topic name
|
|
43105
|
+
* @param {String} opts.topicName Topic name(s). Separated by commas
|
|
42486
43106
|
* @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
|
|
42487
43107
|
*/
|
|
42488
43108
|
getProcessautomationTriggers(opts) {
|
|
@@ -42648,7 +43268,7 @@ class QualityApi {
|
|
|
42648
43268
|
/**
|
|
42649
43269
|
* Quality service.
|
|
42650
43270
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
42651
|
-
* @version
|
|
43271
|
+
* @version 151.0.0
|
|
42652
43272
|
*/
|
|
42653
43273
|
|
|
42654
43274
|
/**
|
|
@@ -44226,7 +44846,7 @@ class RecordingApi {
|
|
|
44226
44846
|
/**
|
|
44227
44847
|
* Recording service.
|
|
44228
44848
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
44229
|
-
* @version
|
|
44849
|
+
* @version 151.0.0
|
|
44230
44850
|
*/
|
|
44231
44851
|
|
|
44232
44852
|
/**
|
|
@@ -45331,7 +45951,7 @@ class RecordingApi {
|
|
|
45331
45951
|
|
|
45332
45952
|
/**
|
|
45333
45953
|
* Create a recording bulk job.
|
|
45334
|
-
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
45954
|
+
* 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.
|
|
45335
45955
|
* @param {Object} body query
|
|
45336
45956
|
*/
|
|
45337
45957
|
postRecordingJobs(body) {
|
|
@@ -45913,7 +46533,7 @@ class ResponseManagementApi {
|
|
|
45913
46533
|
/**
|
|
45914
46534
|
* ResponseManagement service.
|
|
45915
46535
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
45916
|
-
* @version
|
|
46536
|
+
* @version 151.0.0
|
|
45917
46537
|
*/
|
|
45918
46538
|
|
|
45919
46539
|
/**
|
|
@@ -46397,7 +47017,7 @@ class RoutingApi {
|
|
|
46397
47017
|
/**
|
|
46398
47018
|
* Routing service.
|
|
46399
47019
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
46400
|
-
* @version
|
|
47020
|
+
* @version 151.0.0
|
|
46401
47021
|
*/
|
|
46402
47022
|
|
|
46403
47023
|
/**
|
|
@@ -46492,6 +47112,31 @@ class RoutingApi {
|
|
|
46492
47112
|
);
|
|
46493
47113
|
}
|
|
46494
47114
|
|
|
47115
|
+
/**
|
|
47116
|
+
* Delete an outbound domain
|
|
47117
|
+
*
|
|
47118
|
+
* @param {String} domainId domain ID
|
|
47119
|
+
*/
|
|
47120
|
+
deleteRoutingEmailOutboundDomain(domainId) {
|
|
47121
|
+
// verify the required parameter 'domainId' is set
|
|
47122
|
+
if (domainId === undefined || domainId === null) {
|
|
47123
|
+
throw 'Missing the required parameter "domainId" when calling deleteRoutingEmailOutboundDomain';
|
|
47124
|
+
}
|
|
47125
|
+
|
|
47126
|
+
return this.apiClient.callApi(
|
|
47127
|
+
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
47128
|
+
'DELETE',
|
|
47129
|
+
{ 'domainId': domainId },
|
|
47130
|
+
{ },
|
|
47131
|
+
{ },
|
|
47132
|
+
{ },
|
|
47133
|
+
null,
|
|
47134
|
+
['PureCloud OAuth'],
|
|
47135
|
+
['application/json'],
|
|
47136
|
+
['application/json']
|
|
47137
|
+
);
|
|
47138
|
+
}
|
|
47139
|
+
|
|
46495
47140
|
/**
|
|
46496
47141
|
* Delete single predictor.
|
|
46497
47142
|
*
|
|
@@ -47093,6 +47738,101 @@ class RoutingApi {
|
|
|
47093
47738
|
);
|
|
47094
47739
|
}
|
|
47095
47740
|
|
|
47741
|
+
/**
|
|
47742
|
+
* Get domain
|
|
47743
|
+
*
|
|
47744
|
+
* @param {String} domainId domain ID
|
|
47745
|
+
*/
|
|
47746
|
+
getRoutingEmailOutboundDomain(domainId) {
|
|
47747
|
+
// verify the required parameter 'domainId' is set
|
|
47748
|
+
if (domainId === undefined || domainId === null) {
|
|
47749
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomain';
|
|
47750
|
+
}
|
|
47751
|
+
|
|
47752
|
+
return this.apiClient.callApi(
|
|
47753
|
+
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
47754
|
+
'GET',
|
|
47755
|
+
{ 'domainId': domainId },
|
|
47756
|
+
{ },
|
|
47757
|
+
{ },
|
|
47758
|
+
{ },
|
|
47759
|
+
null,
|
|
47760
|
+
['PureCloud OAuth'],
|
|
47761
|
+
['application/json'],
|
|
47762
|
+
['application/json']
|
|
47763
|
+
);
|
|
47764
|
+
}
|
|
47765
|
+
|
|
47766
|
+
/**
|
|
47767
|
+
* Get activation status (cname + dkim) of an outbound domain
|
|
47768
|
+
*
|
|
47769
|
+
* @param {String} domainId domain ID
|
|
47770
|
+
*/
|
|
47771
|
+
getRoutingEmailOutboundDomainActivation(domainId) {
|
|
47772
|
+
// verify the required parameter 'domainId' is set
|
|
47773
|
+
if (domainId === undefined || domainId === null) {
|
|
47774
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainActivation';
|
|
47775
|
+
}
|
|
47776
|
+
|
|
47777
|
+
return this.apiClient.callApi(
|
|
47778
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/activation',
|
|
47779
|
+
'GET',
|
|
47780
|
+
{ 'domainId': domainId },
|
|
47781
|
+
{ },
|
|
47782
|
+
{ },
|
|
47783
|
+
{ },
|
|
47784
|
+
null,
|
|
47785
|
+
['PureCloud OAuth'],
|
|
47786
|
+
['application/json'],
|
|
47787
|
+
['application/json']
|
|
47788
|
+
);
|
|
47789
|
+
}
|
|
47790
|
+
|
|
47791
|
+
/**
|
|
47792
|
+
* Search a domain across organizations
|
|
47793
|
+
*
|
|
47794
|
+
* @param {String} domainId domain ID
|
|
47795
|
+
*/
|
|
47796
|
+
getRoutingEmailOutboundDomainSearch(domainId) {
|
|
47797
|
+
// verify the required parameter 'domainId' is set
|
|
47798
|
+
if (domainId === undefined || domainId === null) {
|
|
47799
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainSearch';
|
|
47800
|
+
}
|
|
47801
|
+
|
|
47802
|
+
return this.apiClient.callApi(
|
|
47803
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/search',
|
|
47804
|
+
'GET',
|
|
47805
|
+
{ 'domainId': domainId },
|
|
47806
|
+
{ },
|
|
47807
|
+
{ },
|
|
47808
|
+
{ },
|
|
47809
|
+
null,
|
|
47810
|
+
['PureCloud OAuth'],
|
|
47811
|
+
['application/json'],
|
|
47812
|
+
['application/json']
|
|
47813
|
+
);
|
|
47814
|
+
}
|
|
47815
|
+
|
|
47816
|
+
/**
|
|
47817
|
+
* Get outbound domains
|
|
47818
|
+
*
|
|
47819
|
+
*/
|
|
47820
|
+
getRoutingEmailOutboundDomains() {
|
|
47821
|
+
|
|
47822
|
+
return this.apiClient.callApi(
|
|
47823
|
+
'/api/v2/routing/email/outbound/domains',
|
|
47824
|
+
'GET',
|
|
47825
|
+
{ },
|
|
47826
|
+
{ },
|
|
47827
|
+
{ },
|
|
47828
|
+
{ },
|
|
47829
|
+
null,
|
|
47830
|
+
['PureCloud OAuth'],
|
|
47831
|
+
['application/json'],
|
|
47832
|
+
['application/json']
|
|
47833
|
+
);
|
|
47834
|
+
}
|
|
47835
|
+
|
|
47096
47836
|
/**
|
|
47097
47837
|
* Get email setup
|
|
47098
47838
|
*
|
|
@@ -48730,6 +49470,56 @@ class RoutingApi {
|
|
|
48730
49470
|
);
|
|
48731
49471
|
}
|
|
48732
49472
|
|
|
49473
|
+
/**
|
|
49474
|
+
* Create a domain
|
|
49475
|
+
*
|
|
49476
|
+
* @param {Object} body Domain
|
|
49477
|
+
*/
|
|
49478
|
+
postRoutingEmailOutboundDomains(body) {
|
|
49479
|
+
// verify the required parameter 'body' is set
|
|
49480
|
+
if (body === undefined || body === null) {
|
|
49481
|
+
throw 'Missing the required parameter "body" when calling postRoutingEmailOutboundDomains';
|
|
49482
|
+
}
|
|
49483
|
+
|
|
49484
|
+
return this.apiClient.callApi(
|
|
49485
|
+
'/api/v2/routing/email/outbound/domains',
|
|
49486
|
+
'POST',
|
|
49487
|
+
{ },
|
|
49488
|
+
{ },
|
|
49489
|
+
{ },
|
|
49490
|
+
{ },
|
|
49491
|
+
body,
|
|
49492
|
+
['PureCloud OAuth'],
|
|
49493
|
+
['application/json'],
|
|
49494
|
+
['application/json']
|
|
49495
|
+
);
|
|
49496
|
+
}
|
|
49497
|
+
|
|
49498
|
+
/**
|
|
49499
|
+
* Create a simulated domain
|
|
49500
|
+
*
|
|
49501
|
+
* @param {Object} body Domain
|
|
49502
|
+
*/
|
|
49503
|
+
postRoutingEmailOutboundDomainsSimulated(body) {
|
|
49504
|
+
// verify the required parameter 'body' is set
|
|
49505
|
+
if (body === undefined || body === null) {
|
|
49506
|
+
throw 'Missing the required parameter "body" when calling postRoutingEmailOutboundDomainsSimulated';
|
|
49507
|
+
}
|
|
49508
|
+
|
|
49509
|
+
return this.apiClient.callApi(
|
|
49510
|
+
'/api/v2/routing/email/outbound/domains/simulated',
|
|
49511
|
+
'POST',
|
|
49512
|
+
{ },
|
|
49513
|
+
{ },
|
|
49514
|
+
{ },
|
|
49515
|
+
{ },
|
|
49516
|
+
body,
|
|
49517
|
+
['PureCloud OAuth'],
|
|
49518
|
+
['application/json'],
|
|
49519
|
+
['application/json']
|
|
49520
|
+
);
|
|
49521
|
+
}
|
|
49522
|
+
|
|
48733
49523
|
/**
|
|
48734
49524
|
* Create Language
|
|
48735
49525
|
*
|
|
@@ -49097,6 +49887,31 @@ class RoutingApi {
|
|
|
49097
49887
|
);
|
|
49098
49888
|
}
|
|
49099
49889
|
|
|
49890
|
+
/**
|
|
49891
|
+
* Request an activation status (cname + dkim) update of an outbound domain
|
|
49892
|
+
*
|
|
49893
|
+
* @param {String} domainId domain ID
|
|
49894
|
+
*/
|
|
49895
|
+
putRoutingEmailOutboundDomainActivation(domainId) {
|
|
49896
|
+
// verify the required parameter 'domainId' is set
|
|
49897
|
+
if (domainId === undefined || domainId === null) {
|
|
49898
|
+
throw 'Missing the required parameter "domainId" when calling putRoutingEmailOutboundDomainActivation';
|
|
49899
|
+
}
|
|
49900
|
+
|
|
49901
|
+
return this.apiClient.callApi(
|
|
49902
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/activation',
|
|
49903
|
+
'PUT',
|
|
49904
|
+
{ 'domainId': domainId },
|
|
49905
|
+
{ },
|
|
49906
|
+
{ },
|
|
49907
|
+
{ },
|
|
49908
|
+
null,
|
|
49909
|
+
['PureCloud OAuth'],
|
|
49910
|
+
['application/json'],
|
|
49911
|
+
['application/json']
|
|
49912
|
+
);
|
|
49913
|
+
}
|
|
49914
|
+
|
|
49100
49915
|
/**
|
|
49101
49916
|
* Update a recipient
|
|
49102
49917
|
*
|
|
@@ -49393,7 +50208,7 @@ class SCIMApi {
|
|
|
49393
50208
|
/**
|
|
49394
50209
|
* SCIM service.
|
|
49395
50210
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
49396
|
-
* @version
|
|
50211
|
+
* @version 151.0.0
|
|
49397
50212
|
*/
|
|
49398
50213
|
|
|
49399
50214
|
/**
|
|
@@ -50270,7 +51085,7 @@ class ScriptsApi {
|
|
|
50270
51085
|
/**
|
|
50271
51086
|
* Scripts service.
|
|
50272
51087
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
50273
|
-
* @version
|
|
51088
|
+
* @version 151.0.0
|
|
50274
51089
|
*/
|
|
50275
51090
|
|
|
50276
51091
|
/**
|
|
@@ -50689,7 +51504,7 @@ class SearchApi {
|
|
|
50689
51504
|
/**
|
|
50690
51505
|
* Search service.
|
|
50691
51506
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
50692
|
-
* @version
|
|
51507
|
+
* @version 151.0.0
|
|
50693
51508
|
*/
|
|
50694
51509
|
|
|
50695
51510
|
/**
|
|
@@ -51218,6 +52033,31 @@ class SearchApi {
|
|
|
51218
52033
|
);
|
|
51219
52034
|
}
|
|
51220
52035
|
|
|
52036
|
+
/**
|
|
52037
|
+
* Search users assigned to teams
|
|
52038
|
+
*
|
|
52039
|
+
* @param {Object} body Search request options
|
|
52040
|
+
*/
|
|
52041
|
+
postUsersSearchTeamsAssign(body) {
|
|
52042
|
+
// verify the required parameter 'body' is set
|
|
52043
|
+
if (body === undefined || body === null) {
|
|
52044
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
52045
|
+
}
|
|
52046
|
+
|
|
52047
|
+
return this.apiClient.callApi(
|
|
52048
|
+
'/api/v2/users/search/teams/assign',
|
|
52049
|
+
'POST',
|
|
52050
|
+
{ },
|
|
52051
|
+
{ },
|
|
52052
|
+
{ },
|
|
52053
|
+
{ },
|
|
52054
|
+
body,
|
|
52055
|
+
['PureCloud OAuth'],
|
|
52056
|
+
['application/json'],
|
|
52057
|
+
['application/json']
|
|
52058
|
+
);
|
|
52059
|
+
}
|
|
52060
|
+
|
|
51221
52061
|
/**
|
|
51222
52062
|
* Search voicemails
|
|
51223
52063
|
*
|
|
@@ -51249,7 +52089,7 @@ class SpeechTextAnalyticsApi {
|
|
|
51249
52089
|
/**
|
|
51250
52090
|
* SpeechTextAnalytics service.
|
|
51251
52091
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
51252
|
-
* @version
|
|
52092
|
+
* @version 151.0.0
|
|
51253
52093
|
*/
|
|
51254
52094
|
|
|
51255
52095
|
/**
|
|
@@ -52103,7 +52943,7 @@ class StationsApi {
|
|
|
52103
52943
|
/**
|
|
52104
52944
|
* Stations service.
|
|
52105
52945
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
52106
|
-
* @version
|
|
52946
|
+
* @version 151.0.0
|
|
52107
52947
|
*/
|
|
52108
52948
|
|
|
52109
52949
|
/**
|
|
@@ -52250,7 +53090,7 @@ class SuggestApi {
|
|
|
52250
53090
|
/**
|
|
52251
53091
|
* Suggest service.
|
|
52252
53092
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
52253
|
-
* @version
|
|
53093
|
+
* @version 151.0.0
|
|
52254
53094
|
*/
|
|
52255
53095
|
|
|
52256
53096
|
/**
|
|
@@ -52389,7 +53229,7 @@ class TeamsApi {
|
|
|
52389
53229
|
/**
|
|
52390
53230
|
* Teams service.
|
|
52391
53231
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
52392
|
-
* @version
|
|
53232
|
+
* @version 151.0.0
|
|
52393
53233
|
*/
|
|
52394
53234
|
|
|
52395
53235
|
/**
|
|
@@ -52429,6 +53269,36 @@ class TeamsApi {
|
|
|
52429
53269
|
);
|
|
52430
53270
|
}
|
|
52431
53271
|
|
|
53272
|
+
/**
|
|
53273
|
+
* Delete team members
|
|
53274
|
+
*
|
|
53275
|
+
* @param {String} teamId Team ID
|
|
53276
|
+
* @param {String} id Comma separated list of member ids to remove
|
|
53277
|
+
*/
|
|
53278
|
+
deleteTeamMembers(teamId, id) {
|
|
53279
|
+
// verify the required parameter 'teamId' is set
|
|
53280
|
+
if (teamId === undefined || teamId === null) {
|
|
53281
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeamMembers';
|
|
53282
|
+
}
|
|
53283
|
+
// verify the required parameter 'id' is set
|
|
53284
|
+
if (id === undefined || id === null) {
|
|
53285
|
+
throw 'Missing the required parameter "id" when calling deleteTeamMembers';
|
|
53286
|
+
}
|
|
53287
|
+
|
|
53288
|
+
return this.apiClient.callApi(
|
|
53289
|
+
'/api/v2/teams/{teamId}/members',
|
|
53290
|
+
'DELETE',
|
|
53291
|
+
{ 'teamId': teamId },
|
|
53292
|
+
{ 'id': id },
|
|
53293
|
+
{ },
|
|
53294
|
+
{ },
|
|
53295
|
+
null,
|
|
53296
|
+
['PureCloud OAuth'],
|
|
53297
|
+
['application/json'],
|
|
53298
|
+
['application/json']
|
|
53299
|
+
);
|
|
53300
|
+
}
|
|
53301
|
+
|
|
52432
53302
|
/**
|
|
52433
53303
|
* Get team
|
|
52434
53304
|
*
|
|
@@ -52454,6 +53324,38 @@ class TeamsApi {
|
|
|
52454
53324
|
);
|
|
52455
53325
|
}
|
|
52456
53326
|
|
|
53327
|
+
/**
|
|
53328
|
+
* Get team membership
|
|
53329
|
+
*
|
|
53330
|
+
* @param {String} teamId Team ID
|
|
53331
|
+
* @param {Object} opts Optional parameters
|
|
53332
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
53333
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
53334
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
53335
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
53336
|
+
*/
|
|
53337
|
+
getTeamMembers(teamId, opts) {
|
|
53338
|
+
opts = opts || {};
|
|
53339
|
+
|
|
53340
|
+
// verify the required parameter 'teamId' is set
|
|
53341
|
+
if (teamId === undefined || teamId === null) {
|
|
53342
|
+
throw 'Missing the required parameter "teamId" when calling getTeamMembers';
|
|
53343
|
+
}
|
|
53344
|
+
|
|
53345
|
+
return this.apiClient.callApi(
|
|
53346
|
+
'/api/v2/teams/{teamId}/members',
|
|
53347
|
+
'GET',
|
|
53348
|
+
{ 'teamId': teamId },
|
|
53349
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'],'expand': opts['expand'] },
|
|
53350
|
+
{ },
|
|
53351
|
+
{ },
|
|
53352
|
+
null,
|
|
53353
|
+
['PureCloud OAuth'],
|
|
53354
|
+
['application/json'],
|
|
53355
|
+
['application/json']
|
|
53356
|
+
);
|
|
53357
|
+
}
|
|
53358
|
+
|
|
52457
53359
|
/**
|
|
52458
53360
|
* Get Team listing
|
|
52459
53361
|
*
|
|
@@ -52512,6 +53414,36 @@ class TeamsApi {
|
|
|
52512
53414
|
);
|
|
52513
53415
|
}
|
|
52514
53416
|
|
|
53417
|
+
/**
|
|
53418
|
+
* Add team members
|
|
53419
|
+
*
|
|
53420
|
+
* @param {String} teamId Team ID
|
|
53421
|
+
* @param {Object} body TeamMembers
|
|
53422
|
+
*/
|
|
53423
|
+
postTeamMembers(teamId, body) {
|
|
53424
|
+
// verify the required parameter 'teamId' is set
|
|
53425
|
+
if (teamId === undefined || teamId === null) {
|
|
53426
|
+
throw 'Missing the required parameter "teamId" when calling postTeamMembers';
|
|
53427
|
+
}
|
|
53428
|
+
// verify the required parameter 'body' is set
|
|
53429
|
+
if (body === undefined || body === null) {
|
|
53430
|
+
throw 'Missing the required parameter "body" when calling postTeamMembers';
|
|
53431
|
+
}
|
|
53432
|
+
|
|
53433
|
+
return this.apiClient.callApi(
|
|
53434
|
+
'/api/v2/teams/{teamId}/members',
|
|
53435
|
+
'POST',
|
|
53436
|
+
{ 'teamId': teamId },
|
|
53437
|
+
{ },
|
|
53438
|
+
{ },
|
|
53439
|
+
{ },
|
|
53440
|
+
body,
|
|
53441
|
+
['PureCloud OAuth'],
|
|
53442
|
+
['application/json'],
|
|
53443
|
+
['application/json']
|
|
53444
|
+
);
|
|
53445
|
+
}
|
|
53446
|
+
|
|
52515
53447
|
/**
|
|
52516
53448
|
* Create a team
|
|
52517
53449
|
*
|
|
@@ -52568,7 +53500,7 @@ class TelephonyApi {
|
|
|
52568
53500
|
/**
|
|
52569
53501
|
* Telephony service.
|
|
52570
53502
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
52571
|
-
* @version
|
|
53503
|
+
* @version 151.0.0
|
|
52572
53504
|
*/
|
|
52573
53505
|
|
|
52574
53506
|
/**
|
|
@@ -52676,7 +53608,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
52676
53608
|
/**
|
|
52677
53609
|
* TelephonyProvidersEdge service.
|
|
52678
53610
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
52679
|
-
* @version
|
|
53611
|
+
* @version 151.0.0
|
|
52680
53612
|
*/
|
|
52681
53613
|
|
|
52682
53614
|
/**
|
|
@@ -56309,7 +57241,7 @@ class TextbotsApi {
|
|
|
56309
57241
|
/**
|
|
56310
57242
|
* Textbots service.
|
|
56311
57243
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
56312
|
-
* @version
|
|
57244
|
+
* @version 151.0.0
|
|
56313
57245
|
*/
|
|
56314
57246
|
|
|
56315
57247
|
/**
|
|
@@ -56437,7 +57369,7 @@ class TokensApi {
|
|
|
56437
57369
|
/**
|
|
56438
57370
|
* Tokens service.
|
|
56439
57371
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
56440
|
-
* @version
|
|
57372
|
+
* @version 151.0.0
|
|
56441
57373
|
*/
|
|
56442
57374
|
|
|
56443
57375
|
/**
|
|
@@ -56543,7 +57475,7 @@ class UploadsApi {
|
|
|
56543
57475
|
/**
|
|
56544
57476
|
* Uploads service.
|
|
56545
57477
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
56546
|
-
* @version
|
|
57478
|
+
* @version 151.0.0
|
|
56547
57479
|
*/
|
|
56548
57480
|
|
|
56549
57481
|
/**
|
|
@@ -56719,7 +57651,7 @@ class UsageApi {
|
|
|
56719
57651
|
/**
|
|
56720
57652
|
* Usage service.
|
|
56721
57653
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
56722
|
-
* @version
|
|
57654
|
+
* @version 151.0.0
|
|
56723
57655
|
*/
|
|
56724
57656
|
|
|
56725
57657
|
/**
|
|
@@ -56790,7 +57722,7 @@ class UserRecordingsApi {
|
|
|
56790
57722
|
/**
|
|
56791
57723
|
* UserRecordings service.
|
|
56792
57724
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
56793
|
-
* @version
|
|
57725
|
+
* @version 151.0.0
|
|
56794
57726
|
*/
|
|
56795
57727
|
|
|
56796
57728
|
/**
|
|
@@ -56975,7 +57907,7 @@ class UsersApi {
|
|
|
56975
57907
|
/**
|
|
56976
57908
|
* Users service.
|
|
56977
57909
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
56978
|
-
* @version
|
|
57910
|
+
* @version 151.0.0
|
|
56979
57911
|
*/
|
|
56980
57912
|
|
|
56981
57913
|
/**
|
|
@@ -58966,6 +59898,31 @@ class UsersApi {
|
|
|
58966
59898
|
);
|
|
58967
59899
|
}
|
|
58968
59900
|
|
|
59901
|
+
/**
|
|
59902
|
+
* Search users assigned to teams
|
|
59903
|
+
*
|
|
59904
|
+
* @param {Object} body Search request options
|
|
59905
|
+
*/
|
|
59906
|
+
postUsersSearchTeamsAssign(body) {
|
|
59907
|
+
// verify the required parameter 'body' is set
|
|
59908
|
+
if (body === undefined || body === null) {
|
|
59909
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
59910
|
+
}
|
|
59911
|
+
|
|
59912
|
+
return this.apiClient.callApi(
|
|
59913
|
+
'/api/v2/users/search/teams/assign',
|
|
59914
|
+
'POST',
|
|
59915
|
+
{ },
|
|
59916
|
+
{ },
|
|
59917
|
+
{ },
|
|
59918
|
+
{ },
|
|
59919
|
+
body,
|
|
59920
|
+
['PureCloud OAuth'],
|
|
59921
|
+
['application/json'],
|
|
59922
|
+
['application/json']
|
|
59923
|
+
);
|
|
59924
|
+
}
|
|
59925
|
+
|
|
58969
59926
|
/**
|
|
58970
59927
|
* Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
|
58971
59928
|
*
|
|
@@ -59307,7 +60264,7 @@ class UtilitiesApi {
|
|
|
59307
60264
|
/**
|
|
59308
60265
|
* Utilities service.
|
|
59309
60266
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
59310
|
-
* @version
|
|
60267
|
+
* @version 151.0.0
|
|
59311
60268
|
*/
|
|
59312
60269
|
|
|
59313
60270
|
/**
|
|
@@ -59418,7 +60375,7 @@ class VoicemailApi {
|
|
|
59418
60375
|
/**
|
|
59419
60376
|
* Voicemail service.
|
|
59420
60377
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
59421
|
-
* @version
|
|
60378
|
+
* @version 151.0.0
|
|
59422
60379
|
*/
|
|
59423
60380
|
|
|
59424
60381
|
/**
|
|
@@ -60085,7 +61042,7 @@ class WebChatApi {
|
|
|
60085
61042
|
/**
|
|
60086
61043
|
* WebChat service.
|
|
60087
61044
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
60088
|
-
* @version
|
|
61045
|
+
* @version 151.0.0
|
|
60089
61046
|
*/
|
|
60090
61047
|
|
|
60091
61048
|
/**
|
|
@@ -60629,7 +61586,7 @@ class WebDeploymentsApi {
|
|
|
60629
61586
|
/**
|
|
60630
61587
|
* WebDeployments service.
|
|
60631
61588
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
60632
|
-
* @version
|
|
61589
|
+
* @version 151.0.0
|
|
60633
61590
|
*/
|
|
60634
61591
|
|
|
60635
61592
|
/**
|
|
@@ -61017,7 +61974,7 @@ class WebMessagingApi {
|
|
|
61017
61974
|
/**
|
|
61018
61975
|
* WebMessaging service.
|
|
61019
61976
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
61020
|
-
* @version
|
|
61977
|
+
* @version 151.0.0
|
|
61021
61978
|
*/
|
|
61022
61979
|
|
|
61023
61980
|
/**
|
|
@@ -61063,7 +62020,7 @@ class WidgetsApi {
|
|
|
61063
62020
|
/**
|
|
61064
62021
|
* Widgets service.
|
|
61065
62022
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
61066
|
-
* @version
|
|
62023
|
+
* @version 151.0.0
|
|
61067
62024
|
*/
|
|
61068
62025
|
|
|
61069
62026
|
/**
|
|
@@ -61209,7 +62166,7 @@ class WorkforceManagementApi {
|
|
|
61209
62166
|
/**
|
|
61210
62167
|
* WorkforceManagement service.
|
|
61211
62168
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
61212
|
-
* @version
|
|
62169
|
+
* @version 151.0.0
|
|
61213
62170
|
*/
|
|
61214
62171
|
|
|
61215
62172
|
/**
|
|
@@ -64989,6 +65946,76 @@ class WorkforceManagementApi {
|
|
|
64989
65946
|
);
|
|
64990
65947
|
}
|
|
64991
65948
|
|
|
65949
|
+
/**
|
|
65950
|
+
* Query time off balances for a given user for specified activity code and dates
|
|
65951
|
+
*
|
|
65952
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
65953
|
+
* @param {String} userId The ID of the user
|
|
65954
|
+
* @param {Object} body The request body
|
|
65955
|
+
*/
|
|
65956
|
+
postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId, userId, body) {
|
|
65957
|
+
// verify the required parameter 'managementUnitId' is set
|
|
65958
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
65959
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
65960
|
+
}
|
|
65961
|
+
// verify the required parameter 'userId' is set
|
|
65962
|
+
if (userId === undefined || userId === null) {
|
|
65963
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
65964
|
+
}
|
|
65965
|
+
// verify the required parameter 'body' is set
|
|
65966
|
+
if (body === undefined || body === null) {
|
|
65967
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
65968
|
+
}
|
|
65969
|
+
|
|
65970
|
+
return this.apiClient.callApi(
|
|
65971
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs',
|
|
65972
|
+
'POST',
|
|
65973
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
65974
|
+
{ },
|
|
65975
|
+
{ },
|
|
65976
|
+
{ },
|
|
65977
|
+
body,
|
|
65978
|
+
['PureCloud OAuth'],
|
|
65979
|
+
['application/json'],
|
|
65980
|
+
['application/json']
|
|
65981
|
+
);
|
|
65982
|
+
}
|
|
65983
|
+
|
|
65984
|
+
/**
|
|
65985
|
+
* Query time off balances for dates spanned by a given time off request
|
|
65986
|
+
*
|
|
65987
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
65988
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
65989
|
+
* @param {String} timeOffRequestId The time off request id.
|
|
65990
|
+
*/
|
|
65991
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId, userId, timeOffRequestId) {
|
|
65992
|
+
// verify the required parameter 'managementUnitId' is set
|
|
65993
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
65994
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
65995
|
+
}
|
|
65996
|
+
// verify the required parameter 'userId' is set
|
|
65997
|
+
if (userId === undefined || userId === null) {
|
|
65998
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
65999
|
+
}
|
|
66000
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
66001
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
66002
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
66003
|
+
}
|
|
66004
|
+
|
|
66005
|
+
return this.apiClient.callApi(
|
|
66006
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs',
|
|
66007
|
+
'POST',
|
|
66008
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
66009
|
+
{ },
|
|
66010
|
+
{ },
|
|
66011
|
+
{ },
|
|
66012
|
+
null,
|
|
66013
|
+
['PureCloud OAuth'],
|
|
66014
|
+
['application/json'],
|
|
66015
|
+
['application/json']
|
|
66016
|
+
);
|
|
66017
|
+
}
|
|
66018
|
+
|
|
64992
66019
|
/**
|
|
64993
66020
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
64994
66021
|
*
|
|
@@ -65485,7 +66512,7 @@ class WorkforceManagementApi {
|
|
|
65485
66512
|
* </pre>
|
|
65486
66513
|
* </p>
|
|
65487
66514
|
* @module purecloud-platform-client-v2/index
|
|
65488
|
-
* @version
|
|
66515
|
+
* @version 151.0.0
|
|
65489
66516
|
*/
|
|
65490
66517
|
class platformClient {
|
|
65491
66518
|
constructor() {
|
|
@@ -65554,6 +66581,16 @@ class platformClient {
|
|
|
65554
66581
|
* @property {module:purecloud-platform-client-v2/api/DataExtensionsApi}
|
|
65555
66582
|
*/
|
|
65556
66583
|
this.DataExtensionsApi = DataExtensionsApi;
|
|
66584
|
+
/**
|
|
66585
|
+
* The DownloadsApi service constructor.
|
|
66586
|
+
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|
|
66587
|
+
*/
|
|
66588
|
+
this.DownloadsApi = DownloadsApi;
|
|
66589
|
+
/**
|
|
66590
|
+
* The EventsApi service constructor.
|
|
66591
|
+
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|
|
66592
|
+
*/
|
|
66593
|
+
this.EventsApi = EventsApi;
|
|
65557
66594
|
/**
|
|
65558
66595
|
* The ExternalContactsApi service constructor.
|
|
65559
66596
|
* @property {module:purecloud-platform-client-v2/api/ExternalContactsApi}
|