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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2279,7 +2279,7 @@ class Configuration {
|
|
|
2279
2279
|
|
|
2280
2280
|
/**
|
|
2281
2281
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2282
|
-
* @version
|
|
2282
|
+
* @version 151.0.0
|
|
2283
2283
|
*/
|
|
2284
2284
|
class ApiClient {
|
|
2285
2285
|
/**
|
|
@@ -3351,7 +3351,7 @@ class AlertingApi {
|
|
|
3351
3351
|
/**
|
|
3352
3352
|
* Alerting service.
|
|
3353
3353
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3354
|
-
* @version
|
|
3354
|
+
* @version 151.0.0
|
|
3355
3355
|
*/
|
|
3356
3356
|
|
|
3357
3357
|
/**
|
|
@@ -3665,7 +3665,7 @@ class AnalyticsApi {
|
|
|
3665
3665
|
/**
|
|
3666
3666
|
* Analytics service.
|
|
3667
3667
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3668
|
-
* @version
|
|
3668
|
+
* @version 151.0.0
|
|
3669
3669
|
*/
|
|
3670
3670
|
|
|
3671
3671
|
/**
|
|
@@ -4892,7 +4892,7 @@ class ArchitectApi {
|
|
|
4892
4892
|
/**
|
|
4893
4893
|
* Architect service.
|
|
4894
4894
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4895
|
-
* @version
|
|
4895
|
+
* @version 151.0.0
|
|
4896
4896
|
*/
|
|
4897
4897
|
|
|
4898
4898
|
/**
|
|
@@ -7938,7 +7938,7 @@ class AuditApi {
|
|
|
7938
7938
|
/**
|
|
7939
7939
|
* Audit service.
|
|
7940
7940
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7941
|
-
* @version
|
|
7941
|
+
* @version 151.0.0
|
|
7942
7942
|
*/
|
|
7943
7943
|
|
|
7944
7944
|
/**
|
|
@@ -8109,7 +8109,7 @@ class AuthorizationApi {
|
|
|
8109
8109
|
/**
|
|
8110
8110
|
* Authorization service.
|
|
8111
8111
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8112
|
-
* @version
|
|
8112
|
+
* @version 151.0.0
|
|
8113
8113
|
*/
|
|
8114
8114
|
|
|
8115
8115
|
/**
|
|
@@ -9292,7 +9292,7 @@ class BillingApi {
|
|
|
9292
9292
|
/**
|
|
9293
9293
|
* Billing service.
|
|
9294
9294
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9295
|
-
* @version
|
|
9295
|
+
* @version 151.0.0
|
|
9296
9296
|
*/
|
|
9297
9297
|
|
|
9298
9298
|
/**
|
|
@@ -9372,7 +9372,7 @@ class ChatApi {
|
|
|
9372
9372
|
/**
|
|
9373
9373
|
* Chat service.
|
|
9374
9374
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9375
|
-
* @version
|
|
9375
|
+
* @version 151.0.0
|
|
9376
9376
|
*/
|
|
9377
9377
|
|
|
9378
9378
|
/**
|
|
@@ -9463,7 +9463,7 @@ class CoachingApi {
|
|
|
9463
9463
|
/**
|
|
9464
9464
|
* Coaching service.
|
|
9465
9465
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9466
|
-
* @version
|
|
9466
|
+
* @version 151.0.0
|
|
9467
9467
|
*/
|
|
9468
9468
|
|
|
9469
9469
|
/**
|
|
@@ -10040,7 +10040,7 @@ class ContentManagementApi {
|
|
|
10040
10040
|
/**
|
|
10041
10041
|
* ContentManagement service.
|
|
10042
10042
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10043
|
-
* @version
|
|
10043
|
+
* @version 151.0.0
|
|
10044
10044
|
*/
|
|
10045
10045
|
|
|
10046
10046
|
/**
|
|
@@ -11180,7 +11180,7 @@ class ConversationsApi {
|
|
|
11180
11180
|
/**
|
|
11181
11181
|
* Conversations service.
|
|
11182
11182
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11183
|
-
* @version
|
|
11183
|
+
* @version 151.0.0
|
|
11184
11184
|
*/
|
|
11185
11185
|
|
|
11186
11186
|
/**
|
|
@@ -12690,8 +12690,12 @@ class ConversationsApi {
|
|
|
12690
12690
|
* Get message
|
|
12691
12691
|
*
|
|
12692
12692
|
* @param {String} messageId messageId
|
|
12693
|
+
* @param {Object} opts Optional parameters
|
|
12694
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
12693
12695
|
*/
|
|
12694
|
-
getConversationsMessageDetails(messageId) {
|
|
12696
|
+
getConversationsMessageDetails(messageId, opts) {
|
|
12697
|
+
opts = opts || {};
|
|
12698
|
+
|
|
12695
12699
|
// verify the required parameter 'messageId' is set
|
|
12696
12700
|
if (messageId === undefined || messageId === null) {
|
|
12697
12701
|
throw 'Missing the required parameter "messageId" when calling getConversationsMessageDetails';
|
|
@@ -12701,7 +12705,7 @@ class ConversationsApi {
|
|
|
12701
12705
|
'/api/v2/conversations/messages/{messageId}/details',
|
|
12702
12706
|
'GET',
|
|
12703
12707
|
{ 'messageId': messageId },
|
|
12704
|
-
{
|
|
12708
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
12705
12709
|
{ },
|
|
12706
12710
|
{ },
|
|
12707
12711
|
null,
|
|
@@ -12716,8 +12720,12 @@ class ConversationsApi {
|
|
|
12716
12720
|
*
|
|
12717
12721
|
* @param {String} conversationId conversationId
|
|
12718
12722
|
* @param {String} messageId messageId
|
|
12723
|
+
* @param {Object} opts Optional parameters
|
|
12724
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
12719
12725
|
*/
|
|
12720
|
-
getConversationsMessageMessage(conversationId, messageId) {
|
|
12726
|
+
getConversationsMessageMessage(conversationId, messageId, opts) {
|
|
12727
|
+
opts = opts || {};
|
|
12728
|
+
|
|
12721
12729
|
// verify the required parameter 'conversationId' is set
|
|
12722
12730
|
if (conversationId === undefined || conversationId === null) {
|
|
12723
12731
|
throw 'Missing the required parameter "conversationId" when calling getConversationsMessageMessage';
|
|
@@ -12731,7 +12739,7 @@ class ConversationsApi {
|
|
|
12731
12739
|
'/api/v2/conversations/messages/{conversationId}/messages/{messageId}',
|
|
12732
12740
|
'GET',
|
|
12733
12741
|
{ 'conversationId': conversationId,'messageId': messageId },
|
|
12734
|
-
{
|
|
12742
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
12735
12743
|
{ },
|
|
12736
12744
|
{ },
|
|
12737
12745
|
null,
|
|
@@ -15349,6 +15357,31 @@ class ConversationsApi {
|
|
|
15349
15357
|
);
|
|
15350
15358
|
}
|
|
15351
15359
|
|
|
15360
|
+
/**
|
|
15361
|
+
* Create an email conversation, per API
|
|
15362
|
+
*
|
|
15363
|
+
* @param {Object} body Create agentless email request
|
|
15364
|
+
*/
|
|
15365
|
+
postConversationsEmailsAgentless(body) {
|
|
15366
|
+
// verify the required parameter 'body' is set
|
|
15367
|
+
if (body === undefined || body === null) {
|
|
15368
|
+
throw 'Missing the required parameter "body" when calling postConversationsEmailsAgentless';
|
|
15369
|
+
}
|
|
15370
|
+
|
|
15371
|
+
return this.apiClient.callApi(
|
|
15372
|
+
'/api/v2/conversations/emails/agentless',
|
|
15373
|
+
'POST',
|
|
15374
|
+
{ },
|
|
15375
|
+
{ },
|
|
15376
|
+
{ },
|
|
15377
|
+
{ },
|
|
15378
|
+
body,
|
|
15379
|
+
['PureCloud OAuth'],
|
|
15380
|
+
['application/json'],
|
|
15381
|
+
['application/json']
|
|
15382
|
+
);
|
|
15383
|
+
}
|
|
15384
|
+
|
|
15352
15385
|
/**
|
|
15353
15386
|
* Create Fax Conversation
|
|
15354
15387
|
*
|
|
@@ -15430,8 +15463,12 @@ class ConversationsApi {
|
|
|
15430
15463
|
* @param {String} conversationId conversationId
|
|
15431
15464
|
* @param {String} communicationId communicationId
|
|
15432
15465
|
* @param {Object} body Message
|
|
15466
|
+
* @param {Object} opts Optional parameters
|
|
15467
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
15433
15468
|
*/
|
|
15434
|
-
postConversationsMessageCommunicationMessages(conversationId, communicationId, body) {
|
|
15469
|
+
postConversationsMessageCommunicationMessages(conversationId, communicationId, body, opts) {
|
|
15470
|
+
opts = opts || {};
|
|
15471
|
+
|
|
15435
15472
|
// verify the required parameter 'conversationId' is set
|
|
15436
15473
|
if (conversationId === undefined || conversationId === null) {
|
|
15437
15474
|
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessages';
|
|
@@ -15449,7 +15486,7 @@ class ConversationsApi {
|
|
|
15449
15486
|
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages',
|
|
15450
15487
|
'POST',
|
|
15451
15488
|
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
15452
|
-
{
|
|
15489
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
15453
15490
|
{ },
|
|
15454
15491
|
{ },
|
|
15455
15492
|
body,
|
|
@@ -15489,11 +15526,47 @@ class ConversationsApi {
|
|
|
15489
15526
|
);
|
|
15490
15527
|
}
|
|
15491
15528
|
|
|
15529
|
+
/**
|
|
15530
|
+
* Send message typing event
|
|
15531
|
+
* Send message typing event for existing conversation/communication.
|
|
15532
|
+
* @param {String} conversationId conversationId
|
|
15533
|
+
* @param {String} communicationId communicationId
|
|
15534
|
+
* @param {Object} body MessageTypingEvent
|
|
15535
|
+
*/
|
|
15536
|
+
postConversationsMessageCommunicationTyping(conversationId, communicationId, body) {
|
|
15537
|
+
// verify the required parameter 'conversationId' is set
|
|
15538
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15539
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationTyping';
|
|
15540
|
+
}
|
|
15541
|
+
// verify the required parameter 'communicationId' is set
|
|
15542
|
+
if (communicationId === undefined || communicationId === null) {
|
|
15543
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationTyping';
|
|
15544
|
+
}
|
|
15545
|
+
// verify the required parameter 'body' is set
|
|
15546
|
+
if (body === undefined || body === null) {
|
|
15547
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationTyping';
|
|
15548
|
+
}
|
|
15549
|
+
|
|
15550
|
+
return this.apiClient.callApi(
|
|
15551
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing',
|
|
15552
|
+
'POST',
|
|
15553
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
15554
|
+
{ },
|
|
15555
|
+
{ },
|
|
15556
|
+
{ },
|
|
15557
|
+
body,
|
|
15558
|
+
['PureCloud OAuth'],
|
|
15559
|
+
['application/json'],
|
|
15560
|
+
['application/json']
|
|
15561
|
+
);
|
|
15562
|
+
}
|
|
15563
|
+
|
|
15492
15564
|
/**
|
|
15493
15565
|
* Get messages in batch
|
|
15494
15566
|
* 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"]
|
|
15495
15567
|
* @param {String} conversationId
|
|
15496
15568
|
* @param {Object} opts Optional parameters
|
|
15569
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media, stickers) (default to false)
|
|
15497
15570
|
* @param {Array.<String>} opts.body messageIds
|
|
15498
15571
|
*/
|
|
15499
15572
|
postConversationsMessageMessagesBulk(conversationId, opts) {
|
|
@@ -15508,7 +15581,7 @@ class ConversationsApi {
|
|
|
15508
15581
|
'/api/v2/conversations/messages/{conversationId}/messages/bulk',
|
|
15509
15582
|
'POST',
|
|
15510
15583
|
{ 'conversationId': conversationId },
|
|
15511
|
-
{
|
|
15584
|
+
{ 'useNormalizedMessage': opts['useNormalizedMessage'] },
|
|
15512
15585
|
{ },
|
|
15513
15586
|
{ },
|
|
15514
15587
|
opts['body'],
|
|
@@ -16324,7 +16397,7 @@ class DataExtensionsApi {
|
|
|
16324
16397
|
/**
|
|
16325
16398
|
* DataExtensions service.
|
|
16326
16399
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
16327
|
-
* @version
|
|
16400
|
+
* @version 151.0.0
|
|
16328
16401
|
*/
|
|
16329
16402
|
|
|
16330
16403
|
/**
|
|
@@ -16406,11 +16479,159 @@ class DataExtensionsApi {
|
|
|
16406
16479
|
|
|
16407
16480
|
}
|
|
16408
16481
|
|
|
16482
|
+
class DownloadsApi {
|
|
16483
|
+
/**
|
|
16484
|
+
* Downloads service.
|
|
16485
|
+
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
16486
|
+
* @version 151.0.0
|
|
16487
|
+
*/
|
|
16488
|
+
|
|
16489
|
+
/**
|
|
16490
|
+
* Constructs a new DownloadsApi.
|
|
16491
|
+
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
16492
|
+
* @class
|
|
16493
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
16494
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
16495
|
+
*/
|
|
16496
|
+
constructor(apiClient) {
|
|
16497
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
16498
|
+
}
|
|
16499
|
+
|
|
16500
|
+
|
|
16501
|
+
/**
|
|
16502
|
+
* Issues a redirect to a signed secure download URL for specified download
|
|
16503
|
+
* this method will issue a redirect to the url to the content
|
|
16504
|
+
* @param {String} downloadId Download ID
|
|
16505
|
+
* @param {Object} opts Optional parameters
|
|
16506
|
+
* @param {String} opts.contentDisposition
|
|
16507
|
+
* @param {Boolean} opts.issueRedirect (default to true)
|
|
16508
|
+
* @param {Boolean} opts.redirectToAuth (default to true)
|
|
16509
|
+
*/
|
|
16510
|
+
getDownload(downloadId, opts) {
|
|
16511
|
+
opts = opts || {};
|
|
16512
|
+
|
|
16513
|
+
// verify the required parameter 'downloadId' is set
|
|
16514
|
+
if (downloadId === undefined || downloadId === null) {
|
|
16515
|
+
throw 'Missing the required parameter "downloadId" when calling getDownload';
|
|
16516
|
+
}
|
|
16517
|
+
|
|
16518
|
+
return this.apiClient.callApi(
|
|
16519
|
+
'/api/v2/downloads/{downloadId}',
|
|
16520
|
+
'GET',
|
|
16521
|
+
{ 'downloadId': downloadId },
|
|
16522
|
+
{ 'contentDisposition': opts['contentDisposition'],'issueRedirect': opts['issueRedirect'],'redirectToAuth': opts['redirectToAuth'] },
|
|
16523
|
+
{ },
|
|
16524
|
+
{ },
|
|
16525
|
+
null,
|
|
16526
|
+
['PureCloud OAuth'],
|
|
16527
|
+
['application/json'],
|
|
16528
|
+
['application/json']
|
|
16529
|
+
);
|
|
16530
|
+
}
|
|
16531
|
+
|
|
16532
|
+
}
|
|
16533
|
+
|
|
16534
|
+
class EventsApi {
|
|
16535
|
+
/**
|
|
16536
|
+
* Events service.
|
|
16537
|
+
* @module purecloud-platform-client-v2/api/EventsApi
|
|
16538
|
+
* @version 151.0.0
|
|
16539
|
+
*/
|
|
16540
|
+
|
|
16541
|
+
/**
|
|
16542
|
+
* Constructs a new EventsApi.
|
|
16543
|
+
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
16544
|
+
* @class
|
|
16545
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
16546
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
16547
|
+
*/
|
|
16548
|
+
constructor(apiClient) {
|
|
16549
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
16550
|
+
}
|
|
16551
|
+
|
|
16552
|
+
|
|
16553
|
+
/**
|
|
16554
|
+
* Publish Conversation Batch Events
|
|
16555
|
+
*
|
|
16556
|
+
* @param {Object} body batchRequest
|
|
16557
|
+
*/
|
|
16558
|
+
postEventsConversations(body) {
|
|
16559
|
+
// verify the required parameter 'body' is set
|
|
16560
|
+
if (body === undefined || body === null) {
|
|
16561
|
+
throw 'Missing the required parameter "body" when calling postEventsConversations';
|
|
16562
|
+
}
|
|
16563
|
+
|
|
16564
|
+
return this.apiClient.callApi(
|
|
16565
|
+
'/api/v2/events/conversations',
|
|
16566
|
+
'POST',
|
|
16567
|
+
{ },
|
|
16568
|
+
{ },
|
|
16569
|
+
{ },
|
|
16570
|
+
{ },
|
|
16571
|
+
body,
|
|
16572
|
+
['PureCloud OAuth'],
|
|
16573
|
+
['application/json'],
|
|
16574
|
+
['application/json']
|
|
16575
|
+
);
|
|
16576
|
+
}
|
|
16577
|
+
|
|
16578
|
+
/**
|
|
16579
|
+
* Publish User Presence Status Batch Events
|
|
16580
|
+
*
|
|
16581
|
+
* @param {Object} body batchRequest
|
|
16582
|
+
*/
|
|
16583
|
+
postEventsUsersPresence(body) {
|
|
16584
|
+
// verify the required parameter 'body' is set
|
|
16585
|
+
if (body === undefined || body === null) {
|
|
16586
|
+
throw 'Missing the required parameter "body" when calling postEventsUsersPresence';
|
|
16587
|
+
}
|
|
16588
|
+
|
|
16589
|
+
return this.apiClient.callApi(
|
|
16590
|
+
'/api/v2/events/users/presence',
|
|
16591
|
+
'POST',
|
|
16592
|
+
{ },
|
|
16593
|
+
{ },
|
|
16594
|
+
{ },
|
|
16595
|
+
{ },
|
|
16596
|
+
body,
|
|
16597
|
+
['PureCloud OAuth'],
|
|
16598
|
+
['application/json'],
|
|
16599
|
+
['application/json']
|
|
16600
|
+
);
|
|
16601
|
+
}
|
|
16602
|
+
|
|
16603
|
+
/**
|
|
16604
|
+
* Publish Agent Routing Status Batch Events
|
|
16605
|
+
*
|
|
16606
|
+
* @param {Object} body batchRequest
|
|
16607
|
+
*/
|
|
16608
|
+
postEventsUsersRoutingstatus(body) {
|
|
16609
|
+
// verify the required parameter 'body' is set
|
|
16610
|
+
if (body === undefined || body === null) {
|
|
16611
|
+
throw 'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';
|
|
16612
|
+
}
|
|
16613
|
+
|
|
16614
|
+
return this.apiClient.callApi(
|
|
16615
|
+
'/api/v2/events/users/routingstatus',
|
|
16616
|
+
'POST',
|
|
16617
|
+
{ },
|
|
16618
|
+
{ },
|
|
16619
|
+
{ },
|
|
16620
|
+
{ },
|
|
16621
|
+
body,
|
|
16622
|
+
['PureCloud OAuth'],
|
|
16623
|
+
['application/json'],
|
|
16624
|
+
['application/json']
|
|
16625
|
+
);
|
|
16626
|
+
}
|
|
16627
|
+
|
|
16628
|
+
}
|
|
16629
|
+
|
|
16409
16630
|
class ExternalContactsApi {
|
|
16410
16631
|
/**
|
|
16411
16632
|
* ExternalContacts service.
|
|
16412
16633
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
16413
|
-
* @version
|
|
16634
|
+
* @version 151.0.0
|
|
16414
16635
|
*/
|
|
16415
16636
|
|
|
16416
16637
|
/**
|
|
@@ -16639,6 +16860,62 @@ class ExternalContactsApi {
|
|
|
16639
16860
|
);
|
|
16640
16861
|
}
|
|
16641
16862
|
|
|
16863
|
+
/**
|
|
16864
|
+
* List the identifiers for a contact
|
|
16865
|
+
*
|
|
16866
|
+
* @param {String} contactId ExternalContact ID
|
|
16867
|
+
*/
|
|
16868
|
+
getExternalcontactsContactIdentifiers(contactId) {
|
|
16869
|
+
// verify the required parameter 'contactId' is set
|
|
16870
|
+
if (contactId === undefined || contactId === null) {
|
|
16871
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactIdentifiers';
|
|
16872
|
+
}
|
|
16873
|
+
|
|
16874
|
+
return this.apiClient.callApi(
|
|
16875
|
+
'/api/v2/externalcontacts/contacts/{contactId}/identifiers',
|
|
16876
|
+
'GET',
|
|
16877
|
+
{ 'contactId': contactId },
|
|
16878
|
+
{ },
|
|
16879
|
+
{ },
|
|
16880
|
+
{ },
|
|
16881
|
+
null,
|
|
16882
|
+
['PureCloud OAuth'],
|
|
16883
|
+
['application/json'],
|
|
16884
|
+
['application/json']
|
|
16885
|
+
);
|
|
16886
|
+
}
|
|
16887
|
+
|
|
16888
|
+
/**
|
|
16889
|
+
* Retrieve all sessions for a given external contact.
|
|
16890
|
+
*
|
|
16891
|
+
* @param {String} contactId ExternalContact ID
|
|
16892
|
+
* @param {Object} opts Optional parameters
|
|
16893
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
16894
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
16895
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
16896
|
+
*/
|
|
16897
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
16898
|
+
opts = opts || {};
|
|
16899
|
+
|
|
16900
|
+
// verify the required parameter 'contactId' is set
|
|
16901
|
+
if (contactId === undefined || contactId === null) {
|
|
16902
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
16903
|
+
}
|
|
16904
|
+
|
|
16905
|
+
return this.apiClient.callApi(
|
|
16906
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
16907
|
+
'GET',
|
|
16908
|
+
{ 'contactId': contactId },
|
|
16909
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
16910
|
+
{ },
|
|
16911
|
+
{ },
|
|
16912
|
+
null,
|
|
16913
|
+
['PureCloud OAuth'],
|
|
16914
|
+
['application/json'],
|
|
16915
|
+
['application/json']
|
|
16916
|
+
);
|
|
16917
|
+
}
|
|
16918
|
+
|
|
16642
16919
|
/**
|
|
16643
16920
|
* Fetch a note for an external contact
|
|
16644
16921
|
*
|
|
@@ -16705,6 +16982,35 @@ class ExternalContactsApi {
|
|
|
16705
16982
|
);
|
|
16706
16983
|
}
|
|
16707
16984
|
|
|
16985
|
+
/**
|
|
16986
|
+
* Fetch an unresolved external contact
|
|
16987
|
+
*
|
|
16988
|
+
* @param {String} contactId ExternalContact ID
|
|
16989
|
+
* @param {Object} opts Optional parameters
|
|
16990
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
16991
|
+
*/
|
|
16992
|
+
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
16993
|
+
opts = opts || {};
|
|
16994
|
+
|
|
16995
|
+
// verify the required parameter 'contactId' is set
|
|
16996
|
+
if (contactId === undefined || contactId === null) {
|
|
16997
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactUnresolved';
|
|
16998
|
+
}
|
|
16999
|
+
|
|
17000
|
+
return this.apiClient.callApi(
|
|
17001
|
+
'/api/v2/externalcontacts/contacts/{contactId}/unresolved',
|
|
17002
|
+
'GET',
|
|
17003
|
+
{ 'contactId': contactId },
|
|
17004
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
17005
|
+
{ },
|
|
17006
|
+
{ },
|
|
17007
|
+
null,
|
|
17008
|
+
['PureCloud OAuth'],
|
|
17009
|
+
['application/json'],
|
|
17010
|
+
['application/json']
|
|
17011
|
+
);
|
|
17012
|
+
}
|
|
17013
|
+
|
|
16708
17014
|
/**
|
|
16709
17015
|
* Search for external contacts
|
|
16710
17016
|
*
|
|
@@ -17282,6 +17588,36 @@ class ExternalContactsApi {
|
|
|
17282
17588
|
);
|
|
17283
17589
|
}
|
|
17284
17590
|
|
|
17591
|
+
/**
|
|
17592
|
+
* Claim or release identifiers for a contact
|
|
17593
|
+
*
|
|
17594
|
+
* @param {String} contactId ExternalContact ID
|
|
17595
|
+
* @param {Object} body ClaimRequest
|
|
17596
|
+
*/
|
|
17597
|
+
patchExternalcontactsContactIdentifiers(contactId, body) {
|
|
17598
|
+
// verify the required parameter 'contactId' is set
|
|
17599
|
+
if (contactId === undefined || contactId === null) {
|
|
17600
|
+
throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContactIdentifiers';
|
|
17601
|
+
}
|
|
17602
|
+
// verify the required parameter 'body' is set
|
|
17603
|
+
if (body === undefined || body === null) {
|
|
17604
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsContactIdentifiers';
|
|
17605
|
+
}
|
|
17606
|
+
|
|
17607
|
+
return this.apiClient.callApi(
|
|
17608
|
+
'/api/v2/externalcontacts/contacts/{contactId}/identifiers',
|
|
17609
|
+
'PATCH',
|
|
17610
|
+
{ 'contactId': contactId },
|
|
17611
|
+
{ },
|
|
17612
|
+
{ },
|
|
17613
|
+
{ },
|
|
17614
|
+
body,
|
|
17615
|
+
['PureCloud OAuth'],
|
|
17616
|
+
['application/json'],
|
|
17617
|
+
['application/json']
|
|
17618
|
+
);
|
|
17619
|
+
}
|
|
17620
|
+
|
|
17285
17621
|
/**
|
|
17286
17622
|
* Bulk fetch contacts
|
|
17287
17623
|
*
|
|
@@ -17357,6 +17693,31 @@ class ExternalContactsApi {
|
|
|
17357
17693
|
);
|
|
17358
17694
|
}
|
|
17359
17695
|
|
|
17696
|
+
/**
|
|
17697
|
+
* Bulk fetch unresolved ancestor contacts
|
|
17698
|
+
*
|
|
17699
|
+
* @param {Object} body Contact ids
|
|
17700
|
+
*/
|
|
17701
|
+
postExternalcontactsBulkContactsUnresolved(body) {
|
|
17702
|
+
// verify the required parameter 'body' is set
|
|
17703
|
+
if (body === undefined || body === null) {
|
|
17704
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsUnresolved';
|
|
17705
|
+
}
|
|
17706
|
+
|
|
17707
|
+
return this.apiClient.callApi(
|
|
17708
|
+
'/api/v2/externalcontacts/bulk/contacts/unresolved',
|
|
17709
|
+
'POST',
|
|
17710
|
+
{ },
|
|
17711
|
+
{ },
|
|
17712
|
+
{ },
|
|
17713
|
+
{ },
|
|
17714
|
+
body,
|
|
17715
|
+
['PureCloud OAuth'],
|
|
17716
|
+
['application/json'],
|
|
17717
|
+
['application/json']
|
|
17718
|
+
);
|
|
17719
|
+
}
|
|
17720
|
+
|
|
17360
17721
|
/**
|
|
17361
17722
|
* Bulk update contacts
|
|
17362
17723
|
*
|
|
@@ -17712,6 +18073,31 @@ class ExternalContactsApi {
|
|
|
17712
18073
|
);
|
|
17713
18074
|
}
|
|
17714
18075
|
|
|
18076
|
+
/**
|
|
18077
|
+
* Promote an observed contact (ephemeral or identified) to a curated contact
|
|
18078
|
+
*
|
|
18079
|
+
* @param {String} contactId ExternalContact ID
|
|
18080
|
+
*/
|
|
18081
|
+
postExternalcontactsContactPromotion(contactId) {
|
|
18082
|
+
// verify the required parameter 'contactId' is set
|
|
18083
|
+
if (contactId === undefined || contactId === null) {
|
|
18084
|
+
throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactPromotion';
|
|
18085
|
+
}
|
|
18086
|
+
|
|
18087
|
+
return this.apiClient.callApi(
|
|
18088
|
+
'/api/v2/externalcontacts/contacts/{contactId}/promotion',
|
|
18089
|
+
'POST',
|
|
18090
|
+
{ 'contactId': contactId },
|
|
18091
|
+
{ },
|
|
18092
|
+
{ },
|
|
18093
|
+
{ },
|
|
18094
|
+
null,
|
|
18095
|
+
['PureCloud OAuth'],
|
|
18096
|
+
['application/json'],
|
|
18097
|
+
['application/json']
|
|
18098
|
+
);
|
|
18099
|
+
}
|
|
18100
|
+
|
|
17715
18101
|
/**
|
|
17716
18102
|
* Create an external contact
|
|
17717
18103
|
*
|
|
@@ -17762,6 +18148,56 @@ class ExternalContactsApi {
|
|
|
17762
18148
|
);
|
|
17763
18149
|
}
|
|
17764
18150
|
|
|
18151
|
+
/**
|
|
18152
|
+
* Fetch a contact using an identifier type and value.
|
|
18153
|
+
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
18154
|
+
* @param {Object} identifier
|
|
18155
|
+
*/
|
|
18156
|
+
postExternalcontactsIdentifierlookup(identifier) {
|
|
18157
|
+
// verify the required parameter 'identifier' is set
|
|
18158
|
+
if (identifier === undefined || identifier === null) {
|
|
18159
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';
|
|
18160
|
+
}
|
|
18161
|
+
|
|
18162
|
+
return this.apiClient.callApi(
|
|
18163
|
+
'/api/v2/externalcontacts/identifierlookup',
|
|
18164
|
+
'POST',
|
|
18165
|
+
{ },
|
|
18166
|
+
{ },
|
|
18167
|
+
{ },
|
|
18168
|
+
{ },
|
|
18169
|
+
identifier,
|
|
18170
|
+
['PureCloud OAuth'],
|
|
18171
|
+
['application/json'],
|
|
18172
|
+
['application/json']
|
|
18173
|
+
);
|
|
18174
|
+
}
|
|
18175
|
+
|
|
18176
|
+
/**
|
|
18177
|
+
* Merge two contacts into a new contact record
|
|
18178
|
+
*
|
|
18179
|
+
* @param {Object} body MergeRequest
|
|
18180
|
+
*/
|
|
18181
|
+
postExternalcontactsMergeContacts(body) {
|
|
18182
|
+
// verify the required parameter 'body' is set
|
|
18183
|
+
if (body === undefined || body === null) {
|
|
18184
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsMergeContacts';
|
|
18185
|
+
}
|
|
18186
|
+
|
|
18187
|
+
return this.apiClient.callApi(
|
|
18188
|
+
'/api/v2/externalcontacts/merge/contacts',
|
|
18189
|
+
'POST',
|
|
18190
|
+
{ },
|
|
18191
|
+
{ },
|
|
18192
|
+
{ },
|
|
18193
|
+
{ },
|
|
18194
|
+
body,
|
|
18195
|
+
['PureCloud OAuth'],
|
|
18196
|
+
['application/json'],
|
|
18197
|
+
['application/json']
|
|
18198
|
+
);
|
|
18199
|
+
}
|
|
18200
|
+
|
|
17765
18201
|
/**
|
|
17766
18202
|
* Create a note for an external organization
|
|
17767
18203
|
*
|
|
@@ -18153,7 +18589,7 @@ class FaxApi {
|
|
|
18153
18589
|
/**
|
|
18154
18590
|
* Fax service.
|
|
18155
18591
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
18156
|
-
* @version
|
|
18592
|
+
* @version 151.0.0
|
|
18157
18593
|
*/
|
|
18158
18594
|
|
|
18159
18595
|
/**
|
|
@@ -18324,7 +18760,7 @@ class FlowsApi {
|
|
|
18324
18760
|
/**
|
|
18325
18761
|
* Flows service.
|
|
18326
18762
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
18327
|
-
* @version
|
|
18763
|
+
* @version 151.0.0
|
|
18328
18764
|
*/
|
|
18329
18765
|
|
|
18330
18766
|
/**
|
|
@@ -18395,7 +18831,7 @@ class GamificationApi {
|
|
|
18395
18831
|
/**
|
|
18396
18832
|
* Gamification service.
|
|
18397
18833
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
18398
|
-
* @version
|
|
18834
|
+
* @version 151.0.0
|
|
18399
18835
|
*/
|
|
18400
18836
|
|
|
18401
18837
|
/**
|
|
@@ -20076,7 +20512,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
20076
20512
|
/**
|
|
20077
20513
|
* GeneralDataProtectionRegulation service.
|
|
20078
20514
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
20079
|
-
* @version
|
|
20515
|
+
* @version 151.0.0
|
|
20080
20516
|
*/
|
|
20081
20517
|
|
|
20082
20518
|
/**
|
|
@@ -20206,7 +20642,7 @@ class GeolocationApi {
|
|
|
20206
20642
|
/**
|
|
20207
20643
|
* Geolocation service.
|
|
20208
20644
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20209
|
-
* @version
|
|
20645
|
+
* @version 151.0.0
|
|
20210
20646
|
*/
|
|
20211
20647
|
|
|
20212
20648
|
/**
|
|
@@ -20337,7 +20773,7 @@ class GreetingsApi {
|
|
|
20337
20773
|
/**
|
|
20338
20774
|
* Greetings service.
|
|
20339
20775
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20340
|
-
* @version
|
|
20776
|
+
* @version 151.0.0
|
|
20341
20777
|
*/
|
|
20342
20778
|
|
|
20343
20779
|
/**
|
|
@@ -20792,7 +21228,7 @@ class GroupsApi {
|
|
|
20792
21228
|
/**
|
|
20793
21229
|
* Groups service.
|
|
20794
21230
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20795
|
-
* @version
|
|
21231
|
+
* @version 151.0.0
|
|
20796
21232
|
*/
|
|
20797
21233
|
|
|
20798
21234
|
/**
|
|
@@ -21198,7 +21634,7 @@ class IdentityProviderApi {
|
|
|
21198
21634
|
/**
|
|
21199
21635
|
* IdentityProvider service.
|
|
21200
21636
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
21201
|
-
* @version
|
|
21637
|
+
* @version 151.0.0
|
|
21202
21638
|
*/
|
|
21203
21639
|
|
|
21204
21640
|
/**
|
|
@@ -21954,7 +22390,7 @@ class IntegrationsApi {
|
|
|
21954
22390
|
/**
|
|
21955
22391
|
* Integrations service.
|
|
21956
22392
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21957
|
-
* @version
|
|
22393
|
+
* @version 151.0.0
|
|
21958
22394
|
*/
|
|
21959
22395
|
|
|
21960
22396
|
/**
|
|
@@ -23554,7 +23990,7 @@ class JourneyApi {
|
|
|
23554
23990
|
/**
|
|
23555
23991
|
* Journey service.
|
|
23556
23992
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23557
|
-
* @version
|
|
23993
|
+
* @version 151.0.0
|
|
23558
23994
|
*/
|
|
23559
23995
|
|
|
23560
23996
|
/**
|
|
@@ -24340,7 +24776,7 @@ class KnowledgeApi {
|
|
|
24340
24776
|
/**
|
|
24341
24777
|
* Knowledge service.
|
|
24342
24778
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
24343
|
-
* @version
|
|
24779
|
+
* @version 151.0.0
|
|
24344
24780
|
*/
|
|
24345
24781
|
|
|
24346
24782
|
/**
|
|
@@ -26773,7 +27209,7 @@ class LanguageUnderstandingApi {
|
|
|
26773
27209
|
/**
|
|
26774
27210
|
* LanguageUnderstanding service.
|
|
26775
27211
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
26776
|
-
* @version
|
|
27212
|
+
* @version 151.0.0
|
|
26777
27213
|
*/
|
|
26778
27214
|
|
|
26779
27215
|
/**
|
|
@@ -27677,7 +28113,7 @@ class LanguagesApi {
|
|
|
27677
28113
|
/**
|
|
27678
28114
|
* Languages service.
|
|
27679
28115
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
27680
|
-
* @version
|
|
28116
|
+
* @version 151.0.0
|
|
27681
28117
|
*/
|
|
27682
28118
|
|
|
27683
28119
|
/**
|
|
@@ -27945,7 +28381,7 @@ class LearningApi {
|
|
|
27945
28381
|
/**
|
|
27946
28382
|
* Learning service.
|
|
27947
28383
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
27948
|
-
* @version
|
|
28384
|
+
* @version 151.0.0
|
|
27949
28385
|
*/
|
|
27950
28386
|
|
|
27951
28387
|
/**
|
|
@@ -28705,7 +29141,7 @@ class LicenseApi {
|
|
|
28705
29141
|
/**
|
|
28706
29142
|
* License service.
|
|
28707
29143
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
28708
|
-
* @version
|
|
29144
|
+
* @version 151.0.0
|
|
28709
29145
|
*/
|
|
28710
29146
|
|
|
28711
29147
|
/**
|
|
@@ -28943,7 +29379,7 @@ class LocationsApi {
|
|
|
28943
29379
|
/**
|
|
28944
29380
|
* Locations service.
|
|
28945
29381
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
28946
|
-
* @version
|
|
29382
|
+
* @version 151.0.0
|
|
28947
29383
|
*/
|
|
28948
29384
|
|
|
28949
29385
|
/**
|
|
@@ -29179,7 +29615,7 @@ class MessagingApi {
|
|
|
29179
29615
|
/**
|
|
29180
29616
|
* Messaging service.
|
|
29181
29617
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
29182
|
-
* @version
|
|
29618
|
+
* @version 151.0.0
|
|
29183
29619
|
*/
|
|
29184
29620
|
|
|
29185
29621
|
/**
|
|
@@ -29330,7 +29766,7 @@ class MobileDevicesApi {
|
|
|
29330
29766
|
/**
|
|
29331
29767
|
* MobileDevices service.
|
|
29332
29768
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
29333
|
-
* @version
|
|
29769
|
+
* @version 151.0.0
|
|
29334
29770
|
*/
|
|
29335
29771
|
|
|
29336
29772
|
/**
|
|
@@ -29481,7 +29917,7 @@ class NotificationsApi {
|
|
|
29481
29917
|
/**
|
|
29482
29918
|
* Notifications service.
|
|
29483
29919
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
29484
|
-
* @version
|
|
29920
|
+
* @version 151.0.0
|
|
29485
29921
|
*/
|
|
29486
29922
|
|
|
29487
29923
|
/**
|
|
@@ -29706,7 +30142,7 @@ class OAuthApi {
|
|
|
29706
30142
|
/**
|
|
29707
30143
|
* OAuth service.
|
|
29708
30144
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
29709
|
-
* @version
|
|
30145
|
+
* @version 151.0.0
|
|
29710
30146
|
*/
|
|
29711
30147
|
|
|
29712
30148
|
/**
|
|
@@ -30072,7 +30508,7 @@ class ObjectsApi {
|
|
|
30072
30508
|
/**
|
|
30073
30509
|
* Objects service.
|
|
30074
30510
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
30075
|
-
* @version
|
|
30511
|
+
* @version 151.0.0
|
|
30076
30512
|
*/
|
|
30077
30513
|
|
|
30078
30514
|
/**
|
|
@@ -30343,7 +30779,7 @@ class OrganizationApi {
|
|
|
30343
30779
|
/**
|
|
30344
30780
|
* Organization service.
|
|
30345
30781
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
30346
|
-
* @version
|
|
30782
|
+
* @version 151.0.0
|
|
30347
30783
|
*/
|
|
30348
30784
|
|
|
30349
30785
|
/**
|
|
@@ -30746,7 +31182,7 @@ class OrganizationAuthorizationApi {
|
|
|
30746
31182
|
/**
|
|
30747
31183
|
* OrganizationAuthorization service.
|
|
30748
31184
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
30749
|
-
* @version
|
|
31185
|
+
* @version 151.0.0
|
|
30750
31186
|
*/
|
|
30751
31187
|
|
|
30752
31188
|
/**
|
|
@@ -31671,7 +32107,7 @@ class OutboundApi {
|
|
|
31671
32107
|
/**
|
|
31672
32108
|
* Outbound service.
|
|
31673
32109
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
31674
|
-
* @version
|
|
32110
|
+
* @version 151.0.0
|
|
31675
32111
|
*/
|
|
31676
32112
|
|
|
31677
32113
|
/**
|
|
@@ -35060,7 +35496,7 @@ class PresenceApi {
|
|
|
35060
35496
|
/**
|
|
35061
35497
|
* Presence service.
|
|
35062
35498
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
35063
|
-
* @version
|
|
35499
|
+
* @version 151.0.0
|
|
35064
35500
|
*/
|
|
35065
35501
|
|
|
35066
35502
|
/**
|
|
@@ -35075,6 +35511,31 @@ class PresenceApi {
|
|
|
35075
35511
|
}
|
|
35076
35512
|
|
|
35077
35513
|
|
|
35514
|
+
/**
|
|
35515
|
+
* Delete a Presence Source
|
|
35516
|
+
*
|
|
35517
|
+
* @param {String} sourceId Presence Source ID
|
|
35518
|
+
*/
|
|
35519
|
+
deletePresenceSource(sourceId) {
|
|
35520
|
+
// verify the required parameter 'sourceId' is set
|
|
35521
|
+
if (sourceId === undefined || sourceId === null) {
|
|
35522
|
+
throw 'Missing the required parameter "sourceId" when calling deletePresenceSource';
|
|
35523
|
+
}
|
|
35524
|
+
|
|
35525
|
+
return this.apiClient.callApi(
|
|
35526
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
35527
|
+
'DELETE',
|
|
35528
|
+
{ 'sourceId': sourceId },
|
|
35529
|
+
{ },
|
|
35530
|
+
{ },
|
|
35531
|
+
{ },
|
|
35532
|
+
null,
|
|
35533
|
+
['PureCloud OAuth'],
|
|
35534
|
+
['application/json'],
|
|
35535
|
+
['application/json']
|
|
35536
|
+
);
|
|
35537
|
+
}
|
|
35538
|
+
|
|
35078
35539
|
/**
|
|
35079
35540
|
* Delete a Presence Definition
|
|
35080
35541
|
*
|
|
@@ -35100,6 +35561,80 @@ class PresenceApi {
|
|
|
35100
35561
|
);
|
|
35101
35562
|
}
|
|
35102
35563
|
|
|
35564
|
+
/**
|
|
35565
|
+
* Get a Presence Source
|
|
35566
|
+
*
|
|
35567
|
+
* @param {String} sourceId Presence Source ID
|
|
35568
|
+
*/
|
|
35569
|
+
getPresenceSource(sourceId) {
|
|
35570
|
+
// verify the required parameter 'sourceId' is set
|
|
35571
|
+
if (sourceId === undefined || sourceId === null) {
|
|
35572
|
+
throw 'Missing the required parameter "sourceId" when calling getPresenceSource';
|
|
35573
|
+
}
|
|
35574
|
+
|
|
35575
|
+
return this.apiClient.callApi(
|
|
35576
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
35577
|
+
'GET',
|
|
35578
|
+
{ 'sourceId': sourceId },
|
|
35579
|
+
{ },
|
|
35580
|
+
{ },
|
|
35581
|
+
{ },
|
|
35582
|
+
null,
|
|
35583
|
+
['PureCloud OAuth'],
|
|
35584
|
+
['application/json'],
|
|
35585
|
+
['application/json']
|
|
35586
|
+
);
|
|
35587
|
+
}
|
|
35588
|
+
|
|
35589
|
+
/**
|
|
35590
|
+
* Get a list of Presence Sources
|
|
35591
|
+
*
|
|
35592
|
+
* @param {Object} opts Optional parameters
|
|
35593
|
+
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
35594
|
+
*/
|
|
35595
|
+
getPresenceSources(opts) {
|
|
35596
|
+
opts = opts || {};
|
|
35597
|
+
|
|
35598
|
+
|
|
35599
|
+
return this.apiClient.callApi(
|
|
35600
|
+
'/api/v2/presence/sources',
|
|
35601
|
+
'GET',
|
|
35602
|
+
{ },
|
|
35603
|
+
{ 'deactivated': opts['deactivated'] },
|
|
35604
|
+
{ },
|
|
35605
|
+
{ },
|
|
35606
|
+
null,
|
|
35607
|
+
['PureCloud OAuth'],
|
|
35608
|
+
['application/json'],
|
|
35609
|
+
['application/json']
|
|
35610
|
+
);
|
|
35611
|
+
}
|
|
35612
|
+
|
|
35613
|
+
/**
|
|
35614
|
+
* Get a user's Primary Presence Source
|
|
35615
|
+
*
|
|
35616
|
+
* @param {String} userId user ID
|
|
35617
|
+
*/
|
|
35618
|
+
getPresenceUserPrimarysource(userId) {
|
|
35619
|
+
// verify the required parameter 'userId' is set
|
|
35620
|
+
if (userId === undefined || userId === null) {
|
|
35621
|
+
throw 'Missing the required parameter "userId" when calling getPresenceUserPrimarysource';
|
|
35622
|
+
}
|
|
35623
|
+
|
|
35624
|
+
return this.apiClient.callApi(
|
|
35625
|
+
'/api/v2/presence/users/{userId}/primarysource',
|
|
35626
|
+
'GET',
|
|
35627
|
+
{ 'userId': userId },
|
|
35628
|
+
{ },
|
|
35629
|
+
{ },
|
|
35630
|
+
{ },
|
|
35631
|
+
null,
|
|
35632
|
+
['PureCloud OAuth'],
|
|
35633
|
+
['application/json'],
|
|
35634
|
+
['application/json']
|
|
35635
|
+
);
|
|
35636
|
+
}
|
|
35637
|
+
|
|
35103
35638
|
/**
|
|
35104
35639
|
* Get a Presence Definition
|
|
35105
35640
|
*
|
|
@@ -35296,6 +35831,31 @@ class PresenceApi {
|
|
|
35296
35831
|
);
|
|
35297
35832
|
}
|
|
35298
35833
|
|
|
35834
|
+
/**
|
|
35835
|
+
* Create a Presence Source
|
|
35836
|
+
*
|
|
35837
|
+
* @param {Object} body The Presence Source to create
|
|
35838
|
+
*/
|
|
35839
|
+
postPresenceSources(body) {
|
|
35840
|
+
// verify the required parameter 'body' is set
|
|
35841
|
+
if (body === undefined || body === null) {
|
|
35842
|
+
throw 'Missing the required parameter "body" when calling postPresenceSources';
|
|
35843
|
+
}
|
|
35844
|
+
|
|
35845
|
+
return this.apiClient.callApi(
|
|
35846
|
+
'/api/v2/presence/sources',
|
|
35847
|
+
'POST',
|
|
35848
|
+
{ },
|
|
35849
|
+
{ },
|
|
35850
|
+
{ },
|
|
35851
|
+
{ },
|
|
35852
|
+
body,
|
|
35853
|
+
['PureCloud OAuth'],
|
|
35854
|
+
['application/json'],
|
|
35855
|
+
['application/json']
|
|
35856
|
+
);
|
|
35857
|
+
}
|
|
35858
|
+
|
|
35299
35859
|
/**
|
|
35300
35860
|
* Create a Presence Definition
|
|
35301
35861
|
*
|
|
@@ -35321,6 +35881,66 @@ class PresenceApi {
|
|
|
35321
35881
|
);
|
|
35322
35882
|
}
|
|
35323
35883
|
|
|
35884
|
+
/**
|
|
35885
|
+
* Update a Presence Source
|
|
35886
|
+
*
|
|
35887
|
+
* @param {String} sourceId Presence Source ID
|
|
35888
|
+
* @param {Object} body The updated Presence Source
|
|
35889
|
+
*/
|
|
35890
|
+
putPresenceSource(sourceId, body) {
|
|
35891
|
+
// verify the required parameter 'sourceId' is set
|
|
35892
|
+
if (sourceId === undefined || sourceId === null) {
|
|
35893
|
+
throw 'Missing the required parameter "sourceId" when calling putPresenceSource';
|
|
35894
|
+
}
|
|
35895
|
+
// verify the required parameter 'body' is set
|
|
35896
|
+
if (body === undefined || body === null) {
|
|
35897
|
+
throw 'Missing the required parameter "body" when calling putPresenceSource';
|
|
35898
|
+
}
|
|
35899
|
+
|
|
35900
|
+
return this.apiClient.callApi(
|
|
35901
|
+
'/api/v2/presence/sources/{sourceId}',
|
|
35902
|
+
'PUT',
|
|
35903
|
+
{ 'sourceId': sourceId },
|
|
35904
|
+
{ },
|
|
35905
|
+
{ },
|
|
35906
|
+
{ },
|
|
35907
|
+
body,
|
|
35908
|
+
['PureCloud OAuth'],
|
|
35909
|
+
['application/json'],
|
|
35910
|
+
['application/json']
|
|
35911
|
+
);
|
|
35912
|
+
}
|
|
35913
|
+
|
|
35914
|
+
/**
|
|
35915
|
+
* Update a user's Primary Presence Source
|
|
35916
|
+
*
|
|
35917
|
+
* @param {String} userId user ID
|
|
35918
|
+
* @param {Object} body Primary Source
|
|
35919
|
+
*/
|
|
35920
|
+
putPresenceUserPrimarysource(userId, body) {
|
|
35921
|
+
// verify the required parameter 'userId' is set
|
|
35922
|
+
if (userId === undefined || userId === null) {
|
|
35923
|
+
throw 'Missing the required parameter "userId" when calling putPresenceUserPrimarysource';
|
|
35924
|
+
}
|
|
35925
|
+
// verify the required parameter 'body' is set
|
|
35926
|
+
if (body === undefined || body === null) {
|
|
35927
|
+
throw 'Missing the required parameter "body" when calling putPresenceUserPrimarysource';
|
|
35928
|
+
}
|
|
35929
|
+
|
|
35930
|
+
return this.apiClient.callApi(
|
|
35931
|
+
'/api/v2/presence/users/{userId}/primarysource',
|
|
35932
|
+
'PUT',
|
|
35933
|
+
{ 'userId': userId },
|
|
35934
|
+
{ },
|
|
35935
|
+
{ },
|
|
35936
|
+
{ },
|
|
35937
|
+
body,
|
|
35938
|
+
['PureCloud OAuth'],
|
|
35939
|
+
['application/json'],
|
|
35940
|
+
['application/json']
|
|
35941
|
+
);
|
|
35942
|
+
}
|
|
35943
|
+
|
|
35324
35944
|
/**
|
|
35325
35945
|
* Update a Presence Definition
|
|
35326
35946
|
*
|
|
@@ -35382,7 +36002,7 @@ class ProcessAutomationApi {
|
|
|
35382
36002
|
/**
|
|
35383
36003
|
* ProcessAutomation service.
|
|
35384
36004
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
35385
|
-
* @version
|
|
36005
|
+
* @version 151.0.0
|
|
35386
36006
|
*/
|
|
35387
36007
|
|
|
35388
36008
|
/**
|
|
@@ -35423,7 +36043,7 @@ class ProcessAutomationApi {
|
|
|
35423
36043
|
}
|
|
35424
36044
|
|
|
35425
36045
|
/**
|
|
35426
|
-
* Retrieve a single Trigger matching id
|
|
36046
|
+
* Retrieve a single Trigger matching id
|
|
35427
36047
|
*
|
|
35428
36048
|
* @param {String} triggerId triggerId
|
|
35429
36049
|
*/
|
|
@@ -35448,13 +36068,13 @@ class ProcessAutomationApi {
|
|
|
35448
36068
|
}
|
|
35449
36069
|
|
|
35450
36070
|
/**
|
|
35451
|
-
* Retrieves all triggers
|
|
36071
|
+
* Retrieves all triggers, optionally filtered by query parameters.
|
|
35452
36072
|
*
|
|
35453
36073
|
* @param {Object} opts Optional parameters
|
|
35454
36074
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
35455
36075
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
35456
36076
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
35457
|
-
* @param {String} opts.topicName Topic name
|
|
36077
|
+
* @param {String} opts.topicName Topic name(s). Separated by commas
|
|
35458
36078
|
* @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
|
|
35459
36079
|
*/
|
|
35460
36080
|
getProcessautomationTriggers(opts) {
|
|
@@ -35620,7 +36240,7 @@ class QualityApi {
|
|
|
35620
36240
|
/**
|
|
35621
36241
|
* Quality service.
|
|
35622
36242
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
35623
|
-
* @version
|
|
36243
|
+
* @version 151.0.0
|
|
35624
36244
|
*/
|
|
35625
36245
|
|
|
35626
36246
|
/**
|
|
@@ -37198,7 +37818,7 @@ class RecordingApi {
|
|
|
37198
37818
|
/**
|
|
37199
37819
|
* Recording service.
|
|
37200
37820
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
37201
|
-
* @version
|
|
37821
|
+
* @version 151.0.0
|
|
37202
37822
|
*/
|
|
37203
37823
|
|
|
37204
37824
|
/**
|
|
@@ -38303,7 +38923,7 @@ class RecordingApi {
|
|
|
38303
38923
|
|
|
38304
38924
|
/**
|
|
38305
38925
|
* Create a recording bulk job.
|
|
38306
|
-
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
38926
|
+
* 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.
|
|
38307
38927
|
* @param {Object} body query
|
|
38308
38928
|
*/
|
|
38309
38929
|
postRecordingJobs(body) {
|
|
@@ -38885,7 +39505,7 @@ class ResponseManagementApi {
|
|
|
38885
39505
|
/**
|
|
38886
39506
|
* ResponseManagement service.
|
|
38887
39507
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
38888
|
-
* @version
|
|
39508
|
+
* @version 151.0.0
|
|
38889
39509
|
*/
|
|
38890
39510
|
|
|
38891
39511
|
/**
|
|
@@ -39369,7 +39989,7 @@ class RoutingApi {
|
|
|
39369
39989
|
/**
|
|
39370
39990
|
* Routing service.
|
|
39371
39991
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
39372
|
-
* @version
|
|
39992
|
+
* @version 151.0.0
|
|
39373
39993
|
*/
|
|
39374
39994
|
|
|
39375
39995
|
/**
|
|
@@ -39464,6 +40084,31 @@ class RoutingApi {
|
|
|
39464
40084
|
);
|
|
39465
40085
|
}
|
|
39466
40086
|
|
|
40087
|
+
/**
|
|
40088
|
+
* Delete an outbound domain
|
|
40089
|
+
*
|
|
40090
|
+
* @param {String} domainId domain ID
|
|
40091
|
+
*/
|
|
40092
|
+
deleteRoutingEmailOutboundDomain(domainId) {
|
|
40093
|
+
// verify the required parameter 'domainId' is set
|
|
40094
|
+
if (domainId === undefined || domainId === null) {
|
|
40095
|
+
throw 'Missing the required parameter "domainId" when calling deleteRoutingEmailOutboundDomain';
|
|
40096
|
+
}
|
|
40097
|
+
|
|
40098
|
+
return this.apiClient.callApi(
|
|
40099
|
+
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
40100
|
+
'DELETE',
|
|
40101
|
+
{ 'domainId': domainId },
|
|
40102
|
+
{ },
|
|
40103
|
+
{ },
|
|
40104
|
+
{ },
|
|
40105
|
+
null,
|
|
40106
|
+
['PureCloud OAuth'],
|
|
40107
|
+
['application/json'],
|
|
40108
|
+
['application/json']
|
|
40109
|
+
);
|
|
40110
|
+
}
|
|
40111
|
+
|
|
39467
40112
|
/**
|
|
39468
40113
|
* Delete single predictor.
|
|
39469
40114
|
*
|
|
@@ -40065,6 +40710,101 @@ class RoutingApi {
|
|
|
40065
40710
|
);
|
|
40066
40711
|
}
|
|
40067
40712
|
|
|
40713
|
+
/**
|
|
40714
|
+
* Get domain
|
|
40715
|
+
*
|
|
40716
|
+
* @param {String} domainId domain ID
|
|
40717
|
+
*/
|
|
40718
|
+
getRoutingEmailOutboundDomain(domainId) {
|
|
40719
|
+
// verify the required parameter 'domainId' is set
|
|
40720
|
+
if (domainId === undefined || domainId === null) {
|
|
40721
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomain';
|
|
40722
|
+
}
|
|
40723
|
+
|
|
40724
|
+
return this.apiClient.callApi(
|
|
40725
|
+
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
40726
|
+
'GET',
|
|
40727
|
+
{ 'domainId': domainId },
|
|
40728
|
+
{ },
|
|
40729
|
+
{ },
|
|
40730
|
+
{ },
|
|
40731
|
+
null,
|
|
40732
|
+
['PureCloud OAuth'],
|
|
40733
|
+
['application/json'],
|
|
40734
|
+
['application/json']
|
|
40735
|
+
);
|
|
40736
|
+
}
|
|
40737
|
+
|
|
40738
|
+
/**
|
|
40739
|
+
* Get activation status (cname + dkim) of an outbound domain
|
|
40740
|
+
*
|
|
40741
|
+
* @param {String} domainId domain ID
|
|
40742
|
+
*/
|
|
40743
|
+
getRoutingEmailOutboundDomainActivation(domainId) {
|
|
40744
|
+
// verify the required parameter 'domainId' is set
|
|
40745
|
+
if (domainId === undefined || domainId === null) {
|
|
40746
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainActivation';
|
|
40747
|
+
}
|
|
40748
|
+
|
|
40749
|
+
return this.apiClient.callApi(
|
|
40750
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/activation',
|
|
40751
|
+
'GET',
|
|
40752
|
+
{ 'domainId': domainId },
|
|
40753
|
+
{ },
|
|
40754
|
+
{ },
|
|
40755
|
+
{ },
|
|
40756
|
+
null,
|
|
40757
|
+
['PureCloud OAuth'],
|
|
40758
|
+
['application/json'],
|
|
40759
|
+
['application/json']
|
|
40760
|
+
);
|
|
40761
|
+
}
|
|
40762
|
+
|
|
40763
|
+
/**
|
|
40764
|
+
* Search a domain across organizations
|
|
40765
|
+
*
|
|
40766
|
+
* @param {String} domainId domain ID
|
|
40767
|
+
*/
|
|
40768
|
+
getRoutingEmailOutboundDomainSearch(domainId) {
|
|
40769
|
+
// verify the required parameter 'domainId' is set
|
|
40770
|
+
if (domainId === undefined || domainId === null) {
|
|
40771
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainSearch';
|
|
40772
|
+
}
|
|
40773
|
+
|
|
40774
|
+
return this.apiClient.callApi(
|
|
40775
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/search',
|
|
40776
|
+
'GET',
|
|
40777
|
+
{ 'domainId': domainId },
|
|
40778
|
+
{ },
|
|
40779
|
+
{ },
|
|
40780
|
+
{ },
|
|
40781
|
+
null,
|
|
40782
|
+
['PureCloud OAuth'],
|
|
40783
|
+
['application/json'],
|
|
40784
|
+
['application/json']
|
|
40785
|
+
);
|
|
40786
|
+
}
|
|
40787
|
+
|
|
40788
|
+
/**
|
|
40789
|
+
* Get outbound domains
|
|
40790
|
+
*
|
|
40791
|
+
*/
|
|
40792
|
+
getRoutingEmailOutboundDomains() {
|
|
40793
|
+
|
|
40794
|
+
return this.apiClient.callApi(
|
|
40795
|
+
'/api/v2/routing/email/outbound/domains',
|
|
40796
|
+
'GET',
|
|
40797
|
+
{ },
|
|
40798
|
+
{ },
|
|
40799
|
+
{ },
|
|
40800
|
+
{ },
|
|
40801
|
+
null,
|
|
40802
|
+
['PureCloud OAuth'],
|
|
40803
|
+
['application/json'],
|
|
40804
|
+
['application/json']
|
|
40805
|
+
);
|
|
40806
|
+
}
|
|
40807
|
+
|
|
40068
40808
|
/**
|
|
40069
40809
|
* Get email setup
|
|
40070
40810
|
*
|
|
@@ -41702,6 +42442,56 @@ class RoutingApi {
|
|
|
41702
42442
|
);
|
|
41703
42443
|
}
|
|
41704
42444
|
|
|
42445
|
+
/**
|
|
42446
|
+
* Create a domain
|
|
42447
|
+
*
|
|
42448
|
+
* @param {Object} body Domain
|
|
42449
|
+
*/
|
|
42450
|
+
postRoutingEmailOutboundDomains(body) {
|
|
42451
|
+
// verify the required parameter 'body' is set
|
|
42452
|
+
if (body === undefined || body === null) {
|
|
42453
|
+
throw 'Missing the required parameter "body" when calling postRoutingEmailOutboundDomains';
|
|
42454
|
+
}
|
|
42455
|
+
|
|
42456
|
+
return this.apiClient.callApi(
|
|
42457
|
+
'/api/v2/routing/email/outbound/domains',
|
|
42458
|
+
'POST',
|
|
42459
|
+
{ },
|
|
42460
|
+
{ },
|
|
42461
|
+
{ },
|
|
42462
|
+
{ },
|
|
42463
|
+
body,
|
|
42464
|
+
['PureCloud OAuth'],
|
|
42465
|
+
['application/json'],
|
|
42466
|
+
['application/json']
|
|
42467
|
+
);
|
|
42468
|
+
}
|
|
42469
|
+
|
|
42470
|
+
/**
|
|
42471
|
+
* Create a simulated domain
|
|
42472
|
+
*
|
|
42473
|
+
* @param {Object} body Domain
|
|
42474
|
+
*/
|
|
42475
|
+
postRoutingEmailOutboundDomainsSimulated(body) {
|
|
42476
|
+
// verify the required parameter 'body' is set
|
|
42477
|
+
if (body === undefined || body === null) {
|
|
42478
|
+
throw 'Missing the required parameter "body" when calling postRoutingEmailOutboundDomainsSimulated';
|
|
42479
|
+
}
|
|
42480
|
+
|
|
42481
|
+
return this.apiClient.callApi(
|
|
42482
|
+
'/api/v2/routing/email/outbound/domains/simulated',
|
|
42483
|
+
'POST',
|
|
42484
|
+
{ },
|
|
42485
|
+
{ },
|
|
42486
|
+
{ },
|
|
42487
|
+
{ },
|
|
42488
|
+
body,
|
|
42489
|
+
['PureCloud OAuth'],
|
|
42490
|
+
['application/json'],
|
|
42491
|
+
['application/json']
|
|
42492
|
+
);
|
|
42493
|
+
}
|
|
42494
|
+
|
|
41705
42495
|
/**
|
|
41706
42496
|
* Create Language
|
|
41707
42497
|
*
|
|
@@ -42069,6 +42859,31 @@ class RoutingApi {
|
|
|
42069
42859
|
);
|
|
42070
42860
|
}
|
|
42071
42861
|
|
|
42862
|
+
/**
|
|
42863
|
+
* Request an activation status (cname + dkim) update of an outbound domain
|
|
42864
|
+
*
|
|
42865
|
+
* @param {String} domainId domain ID
|
|
42866
|
+
*/
|
|
42867
|
+
putRoutingEmailOutboundDomainActivation(domainId) {
|
|
42868
|
+
// verify the required parameter 'domainId' is set
|
|
42869
|
+
if (domainId === undefined || domainId === null) {
|
|
42870
|
+
throw 'Missing the required parameter "domainId" when calling putRoutingEmailOutboundDomainActivation';
|
|
42871
|
+
}
|
|
42872
|
+
|
|
42873
|
+
return this.apiClient.callApi(
|
|
42874
|
+
'/api/v2/routing/email/outbound/domains/{domainId}/activation',
|
|
42875
|
+
'PUT',
|
|
42876
|
+
{ 'domainId': domainId },
|
|
42877
|
+
{ },
|
|
42878
|
+
{ },
|
|
42879
|
+
{ },
|
|
42880
|
+
null,
|
|
42881
|
+
['PureCloud OAuth'],
|
|
42882
|
+
['application/json'],
|
|
42883
|
+
['application/json']
|
|
42884
|
+
);
|
|
42885
|
+
}
|
|
42886
|
+
|
|
42072
42887
|
/**
|
|
42073
42888
|
* Update a recipient
|
|
42074
42889
|
*
|
|
@@ -42365,7 +43180,7 @@ class SCIMApi {
|
|
|
42365
43180
|
/**
|
|
42366
43181
|
* SCIM service.
|
|
42367
43182
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
42368
|
-
* @version
|
|
43183
|
+
* @version 151.0.0
|
|
42369
43184
|
*/
|
|
42370
43185
|
|
|
42371
43186
|
/**
|
|
@@ -43242,7 +44057,7 @@ class ScriptsApi {
|
|
|
43242
44057
|
/**
|
|
43243
44058
|
* Scripts service.
|
|
43244
44059
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
43245
|
-
* @version
|
|
44060
|
+
* @version 151.0.0
|
|
43246
44061
|
*/
|
|
43247
44062
|
|
|
43248
44063
|
/**
|
|
@@ -43661,7 +44476,7 @@ class SearchApi {
|
|
|
43661
44476
|
/**
|
|
43662
44477
|
* Search service.
|
|
43663
44478
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
43664
|
-
* @version
|
|
44479
|
+
* @version 151.0.0
|
|
43665
44480
|
*/
|
|
43666
44481
|
|
|
43667
44482
|
/**
|
|
@@ -44190,6 +45005,31 @@ class SearchApi {
|
|
|
44190
45005
|
);
|
|
44191
45006
|
}
|
|
44192
45007
|
|
|
45008
|
+
/**
|
|
45009
|
+
* Search users assigned to teams
|
|
45010
|
+
*
|
|
45011
|
+
* @param {Object} body Search request options
|
|
45012
|
+
*/
|
|
45013
|
+
postUsersSearchTeamsAssign(body) {
|
|
45014
|
+
// verify the required parameter 'body' is set
|
|
45015
|
+
if (body === undefined || body === null) {
|
|
45016
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
45017
|
+
}
|
|
45018
|
+
|
|
45019
|
+
return this.apiClient.callApi(
|
|
45020
|
+
'/api/v2/users/search/teams/assign',
|
|
45021
|
+
'POST',
|
|
45022
|
+
{ },
|
|
45023
|
+
{ },
|
|
45024
|
+
{ },
|
|
45025
|
+
{ },
|
|
45026
|
+
body,
|
|
45027
|
+
['PureCloud OAuth'],
|
|
45028
|
+
['application/json'],
|
|
45029
|
+
['application/json']
|
|
45030
|
+
);
|
|
45031
|
+
}
|
|
45032
|
+
|
|
44193
45033
|
/**
|
|
44194
45034
|
* Search voicemails
|
|
44195
45035
|
*
|
|
@@ -44221,7 +45061,7 @@ class SpeechTextAnalyticsApi {
|
|
|
44221
45061
|
/**
|
|
44222
45062
|
* SpeechTextAnalytics service.
|
|
44223
45063
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
44224
|
-
* @version
|
|
45064
|
+
* @version 151.0.0
|
|
44225
45065
|
*/
|
|
44226
45066
|
|
|
44227
45067
|
/**
|
|
@@ -45075,7 +45915,7 @@ class StationsApi {
|
|
|
45075
45915
|
/**
|
|
45076
45916
|
* Stations service.
|
|
45077
45917
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
45078
|
-
* @version
|
|
45918
|
+
* @version 151.0.0
|
|
45079
45919
|
*/
|
|
45080
45920
|
|
|
45081
45921
|
/**
|
|
@@ -45222,7 +46062,7 @@ class SuggestApi {
|
|
|
45222
46062
|
/**
|
|
45223
46063
|
* Suggest service.
|
|
45224
46064
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
45225
|
-
* @version
|
|
46065
|
+
* @version 151.0.0
|
|
45226
46066
|
*/
|
|
45227
46067
|
|
|
45228
46068
|
/**
|
|
@@ -45361,7 +46201,7 @@ class TeamsApi {
|
|
|
45361
46201
|
/**
|
|
45362
46202
|
* Teams service.
|
|
45363
46203
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
45364
|
-
* @version
|
|
46204
|
+
* @version 151.0.0
|
|
45365
46205
|
*/
|
|
45366
46206
|
|
|
45367
46207
|
/**
|
|
@@ -45401,6 +46241,36 @@ class TeamsApi {
|
|
|
45401
46241
|
);
|
|
45402
46242
|
}
|
|
45403
46243
|
|
|
46244
|
+
/**
|
|
46245
|
+
* Delete team members
|
|
46246
|
+
*
|
|
46247
|
+
* @param {String} teamId Team ID
|
|
46248
|
+
* @param {String} id Comma separated list of member ids to remove
|
|
46249
|
+
*/
|
|
46250
|
+
deleteTeamMembers(teamId, id) {
|
|
46251
|
+
// verify the required parameter 'teamId' is set
|
|
46252
|
+
if (teamId === undefined || teamId === null) {
|
|
46253
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeamMembers';
|
|
46254
|
+
}
|
|
46255
|
+
// verify the required parameter 'id' is set
|
|
46256
|
+
if (id === undefined || id === null) {
|
|
46257
|
+
throw 'Missing the required parameter "id" when calling deleteTeamMembers';
|
|
46258
|
+
}
|
|
46259
|
+
|
|
46260
|
+
return this.apiClient.callApi(
|
|
46261
|
+
'/api/v2/teams/{teamId}/members',
|
|
46262
|
+
'DELETE',
|
|
46263
|
+
{ 'teamId': teamId },
|
|
46264
|
+
{ 'id': id },
|
|
46265
|
+
{ },
|
|
46266
|
+
{ },
|
|
46267
|
+
null,
|
|
46268
|
+
['PureCloud OAuth'],
|
|
46269
|
+
['application/json'],
|
|
46270
|
+
['application/json']
|
|
46271
|
+
);
|
|
46272
|
+
}
|
|
46273
|
+
|
|
45404
46274
|
/**
|
|
45405
46275
|
* Get team
|
|
45406
46276
|
*
|
|
@@ -45426,6 +46296,38 @@ class TeamsApi {
|
|
|
45426
46296
|
);
|
|
45427
46297
|
}
|
|
45428
46298
|
|
|
46299
|
+
/**
|
|
46300
|
+
* Get team membership
|
|
46301
|
+
*
|
|
46302
|
+
* @param {String} teamId Team ID
|
|
46303
|
+
* @param {Object} opts Optional parameters
|
|
46304
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
46305
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
46306
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
46307
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
46308
|
+
*/
|
|
46309
|
+
getTeamMembers(teamId, opts) {
|
|
46310
|
+
opts = opts || {};
|
|
46311
|
+
|
|
46312
|
+
// verify the required parameter 'teamId' is set
|
|
46313
|
+
if (teamId === undefined || teamId === null) {
|
|
46314
|
+
throw 'Missing the required parameter "teamId" when calling getTeamMembers';
|
|
46315
|
+
}
|
|
46316
|
+
|
|
46317
|
+
return this.apiClient.callApi(
|
|
46318
|
+
'/api/v2/teams/{teamId}/members',
|
|
46319
|
+
'GET',
|
|
46320
|
+
{ 'teamId': teamId },
|
|
46321
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'],'expand': opts['expand'] },
|
|
46322
|
+
{ },
|
|
46323
|
+
{ },
|
|
46324
|
+
null,
|
|
46325
|
+
['PureCloud OAuth'],
|
|
46326
|
+
['application/json'],
|
|
46327
|
+
['application/json']
|
|
46328
|
+
);
|
|
46329
|
+
}
|
|
46330
|
+
|
|
45429
46331
|
/**
|
|
45430
46332
|
* Get Team listing
|
|
45431
46333
|
*
|
|
@@ -45484,6 +46386,36 @@ class TeamsApi {
|
|
|
45484
46386
|
);
|
|
45485
46387
|
}
|
|
45486
46388
|
|
|
46389
|
+
/**
|
|
46390
|
+
* Add team members
|
|
46391
|
+
*
|
|
46392
|
+
* @param {String} teamId Team ID
|
|
46393
|
+
* @param {Object} body TeamMembers
|
|
46394
|
+
*/
|
|
46395
|
+
postTeamMembers(teamId, body) {
|
|
46396
|
+
// verify the required parameter 'teamId' is set
|
|
46397
|
+
if (teamId === undefined || teamId === null) {
|
|
46398
|
+
throw 'Missing the required parameter "teamId" when calling postTeamMembers';
|
|
46399
|
+
}
|
|
46400
|
+
// verify the required parameter 'body' is set
|
|
46401
|
+
if (body === undefined || body === null) {
|
|
46402
|
+
throw 'Missing the required parameter "body" when calling postTeamMembers';
|
|
46403
|
+
}
|
|
46404
|
+
|
|
46405
|
+
return this.apiClient.callApi(
|
|
46406
|
+
'/api/v2/teams/{teamId}/members',
|
|
46407
|
+
'POST',
|
|
46408
|
+
{ 'teamId': teamId },
|
|
46409
|
+
{ },
|
|
46410
|
+
{ },
|
|
46411
|
+
{ },
|
|
46412
|
+
body,
|
|
46413
|
+
['PureCloud OAuth'],
|
|
46414
|
+
['application/json'],
|
|
46415
|
+
['application/json']
|
|
46416
|
+
);
|
|
46417
|
+
}
|
|
46418
|
+
|
|
45487
46419
|
/**
|
|
45488
46420
|
* Create a team
|
|
45489
46421
|
*
|
|
@@ -45540,7 +46472,7 @@ class TelephonyApi {
|
|
|
45540
46472
|
/**
|
|
45541
46473
|
* Telephony service.
|
|
45542
46474
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
45543
|
-
* @version
|
|
46475
|
+
* @version 151.0.0
|
|
45544
46476
|
*/
|
|
45545
46477
|
|
|
45546
46478
|
/**
|
|
@@ -45648,7 +46580,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
45648
46580
|
/**
|
|
45649
46581
|
* TelephonyProvidersEdge service.
|
|
45650
46582
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
45651
|
-
* @version
|
|
46583
|
+
* @version 151.0.0
|
|
45652
46584
|
*/
|
|
45653
46585
|
|
|
45654
46586
|
/**
|
|
@@ -49281,7 +50213,7 @@ class TextbotsApi {
|
|
|
49281
50213
|
/**
|
|
49282
50214
|
* Textbots service.
|
|
49283
50215
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
49284
|
-
* @version
|
|
50216
|
+
* @version 151.0.0
|
|
49285
50217
|
*/
|
|
49286
50218
|
|
|
49287
50219
|
/**
|
|
@@ -49409,7 +50341,7 @@ class TokensApi {
|
|
|
49409
50341
|
/**
|
|
49410
50342
|
* Tokens service.
|
|
49411
50343
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
49412
|
-
* @version
|
|
50344
|
+
* @version 151.0.0
|
|
49413
50345
|
*/
|
|
49414
50346
|
|
|
49415
50347
|
/**
|
|
@@ -49515,7 +50447,7 @@ class UploadsApi {
|
|
|
49515
50447
|
/**
|
|
49516
50448
|
* Uploads service.
|
|
49517
50449
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
49518
|
-
* @version
|
|
50450
|
+
* @version 151.0.0
|
|
49519
50451
|
*/
|
|
49520
50452
|
|
|
49521
50453
|
/**
|
|
@@ -49691,7 +50623,7 @@ class UsageApi {
|
|
|
49691
50623
|
/**
|
|
49692
50624
|
* Usage service.
|
|
49693
50625
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
49694
|
-
* @version
|
|
50626
|
+
* @version 151.0.0
|
|
49695
50627
|
*/
|
|
49696
50628
|
|
|
49697
50629
|
/**
|
|
@@ -49762,7 +50694,7 @@ class UserRecordingsApi {
|
|
|
49762
50694
|
/**
|
|
49763
50695
|
* UserRecordings service.
|
|
49764
50696
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
49765
|
-
* @version
|
|
50697
|
+
* @version 151.0.0
|
|
49766
50698
|
*/
|
|
49767
50699
|
|
|
49768
50700
|
/**
|
|
@@ -49947,7 +50879,7 @@ class UsersApi {
|
|
|
49947
50879
|
/**
|
|
49948
50880
|
* Users service.
|
|
49949
50881
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49950
|
-
* @version
|
|
50882
|
+
* @version 151.0.0
|
|
49951
50883
|
*/
|
|
49952
50884
|
|
|
49953
50885
|
/**
|
|
@@ -51938,6 +52870,31 @@ class UsersApi {
|
|
|
51938
52870
|
);
|
|
51939
52871
|
}
|
|
51940
52872
|
|
|
52873
|
+
/**
|
|
52874
|
+
* Search users assigned to teams
|
|
52875
|
+
*
|
|
52876
|
+
* @param {Object} body Search request options
|
|
52877
|
+
*/
|
|
52878
|
+
postUsersSearchTeamsAssign(body) {
|
|
52879
|
+
// verify the required parameter 'body' is set
|
|
52880
|
+
if (body === undefined || body === null) {
|
|
52881
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
52882
|
+
}
|
|
52883
|
+
|
|
52884
|
+
return this.apiClient.callApi(
|
|
52885
|
+
'/api/v2/users/search/teams/assign',
|
|
52886
|
+
'POST',
|
|
52887
|
+
{ },
|
|
52888
|
+
{ },
|
|
52889
|
+
{ },
|
|
52890
|
+
{ },
|
|
52891
|
+
body,
|
|
52892
|
+
['PureCloud OAuth'],
|
|
52893
|
+
['application/json'],
|
|
52894
|
+
['application/json']
|
|
52895
|
+
);
|
|
52896
|
+
}
|
|
52897
|
+
|
|
51941
52898
|
/**
|
|
51942
52899
|
* Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
|
51943
52900
|
*
|
|
@@ -52279,7 +53236,7 @@ class UtilitiesApi {
|
|
|
52279
53236
|
/**
|
|
52280
53237
|
* Utilities service.
|
|
52281
53238
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
52282
|
-
* @version
|
|
53239
|
+
* @version 151.0.0
|
|
52283
53240
|
*/
|
|
52284
53241
|
|
|
52285
53242
|
/**
|
|
@@ -52390,7 +53347,7 @@ class VoicemailApi {
|
|
|
52390
53347
|
/**
|
|
52391
53348
|
* Voicemail service.
|
|
52392
53349
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
52393
|
-
* @version
|
|
53350
|
+
* @version 151.0.0
|
|
52394
53351
|
*/
|
|
52395
53352
|
|
|
52396
53353
|
/**
|
|
@@ -53057,7 +54014,7 @@ class WebChatApi {
|
|
|
53057
54014
|
/**
|
|
53058
54015
|
* WebChat service.
|
|
53059
54016
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
53060
|
-
* @version
|
|
54017
|
+
* @version 151.0.0
|
|
53061
54018
|
*/
|
|
53062
54019
|
|
|
53063
54020
|
/**
|
|
@@ -53601,7 +54558,7 @@ class WebDeploymentsApi {
|
|
|
53601
54558
|
/**
|
|
53602
54559
|
* WebDeployments service.
|
|
53603
54560
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
53604
|
-
* @version
|
|
54561
|
+
* @version 151.0.0
|
|
53605
54562
|
*/
|
|
53606
54563
|
|
|
53607
54564
|
/**
|
|
@@ -53989,7 +54946,7 @@ class WebMessagingApi {
|
|
|
53989
54946
|
/**
|
|
53990
54947
|
* WebMessaging service.
|
|
53991
54948
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
53992
|
-
* @version
|
|
54949
|
+
* @version 151.0.0
|
|
53993
54950
|
*/
|
|
53994
54951
|
|
|
53995
54952
|
/**
|
|
@@ -54035,7 +54992,7 @@ class WidgetsApi {
|
|
|
54035
54992
|
/**
|
|
54036
54993
|
* Widgets service.
|
|
54037
54994
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
54038
|
-
* @version
|
|
54995
|
+
* @version 151.0.0
|
|
54039
54996
|
*/
|
|
54040
54997
|
|
|
54041
54998
|
/**
|
|
@@ -54181,7 +55138,7 @@ class WorkforceManagementApi {
|
|
|
54181
55138
|
/**
|
|
54182
55139
|
* WorkforceManagement service.
|
|
54183
55140
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
54184
|
-
* @version
|
|
55141
|
+
* @version 151.0.0
|
|
54185
55142
|
*/
|
|
54186
55143
|
|
|
54187
55144
|
/**
|
|
@@ -57961,6 +58918,76 @@ class WorkforceManagementApi {
|
|
|
57961
58918
|
);
|
|
57962
58919
|
}
|
|
57963
58920
|
|
|
58921
|
+
/**
|
|
58922
|
+
* Query time off balances for a given user for specified activity code and dates
|
|
58923
|
+
*
|
|
58924
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
58925
|
+
* @param {String} userId The ID of the user
|
|
58926
|
+
* @param {Object} body The request body
|
|
58927
|
+
*/
|
|
58928
|
+
postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId, userId, body) {
|
|
58929
|
+
// verify the required parameter 'managementUnitId' is set
|
|
58930
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
58931
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
58932
|
+
}
|
|
58933
|
+
// verify the required parameter 'userId' is set
|
|
58934
|
+
if (userId === undefined || userId === null) {
|
|
58935
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
58936
|
+
}
|
|
58937
|
+
// verify the required parameter 'body' is set
|
|
58938
|
+
if (body === undefined || body === null) {
|
|
58939
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
58940
|
+
}
|
|
58941
|
+
|
|
58942
|
+
return this.apiClient.callApi(
|
|
58943
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs',
|
|
58944
|
+
'POST',
|
|
58945
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
58946
|
+
{ },
|
|
58947
|
+
{ },
|
|
58948
|
+
{ },
|
|
58949
|
+
body,
|
|
58950
|
+
['PureCloud OAuth'],
|
|
58951
|
+
['application/json'],
|
|
58952
|
+
['application/json']
|
|
58953
|
+
);
|
|
58954
|
+
}
|
|
58955
|
+
|
|
58956
|
+
/**
|
|
58957
|
+
* Query time off balances for dates spanned by a given time off request
|
|
58958
|
+
*
|
|
58959
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
58960
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
58961
|
+
* @param {String} timeOffRequestId The time off request id.
|
|
58962
|
+
*/
|
|
58963
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId, userId, timeOffRequestId) {
|
|
58964
|
+
// verify the required parameter 'managementUnitId' is set
|
|
58965
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
58966
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
58967
|
+
}
|
|
58968
|
+
// verify the required parameter 'userId' is set
|
|
58969
|
+
if (userId === undefined || userId === null) {
|
|
58970
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
58971
|
+
}
|
|
58972
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
58973
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
58974
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
58975
|
+
}
|
|
58976
|
+
|
|
58977
|
+
return this.apiClient.callApi(
|
|
58978
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs',
|
|
58979
|
+
'POST',
|
|
58980
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
58981
|
+
{ },
|
|
58982
|
+
{ },
|
|
58983
|
+
{ },
|
|
58984
|
+
null,
|
|
58985
|
+
['PureCloud OAuth'],
|
|
58986
|
+
['application/json'],
|
|
58987
|
+
['application/json']
|
|
58988
|
+
);
|
|
58989
|
+
}
|
|
58990
|
+
|
|
57964
58991
|
/**
|
|
57965
58992
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
57966
58993
|
*
|
|
@@ -58457,7 +59484,7 @@ class WorkforceManagementApi {
|
|
|
58457
59484
|
* </pre>
|
|
58458
59485
|
* </p>
|
|
58459
59486
|
* @module purecloud-platform-client-v2/index
|
|
58460
|
-
* @version
|
|
59487
|
+
* @version 151.0.0
|
|
58461
59488
|
*/
|
|
58462
59489
|
class platformClient {
|
|
58463
59490
|
constructor() {
|
|
@@ -58526,6 +59553,16 @@ class platformClient {
|
|
|
58526
59553
|
* @property {module:purecloud-platform-client-v2/api/DataExtensionsApi}
|
|
58527
59554
|
*/
|
|
58528
59555
|
this.DataExtensionsApi = DataExtensionsApi;
|
|
59556
|
+
/**
|
|
59557
|
+
* The DownloadsApi service constructor.
|
|
59558
|
+
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|
|
59559
|
+
*/
|
|
59560
|
+
this.DownloadsApi = DownloadsApi;
|
|
59561
|
+
/**
|
|
59562
|
+
* The EventsApi service constructor.
|
|
59563
|
+
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|
|
59564
|
+
*/
|
|
59565
|
+
this.EventsApi = EventsApi;
|
|
58529
59566
|
/**
|
|
58530
59567
|
* The ExternalContactsApi service constructor.
|
|
58531
59568
|
* @property {module:purecloud-platform-client-v2/api/ExternalContactsApi}
|