purecloud-platform-client-v2 171.0.0 → 173.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 +1056 -91
- package/dist/web-amd/purecloud-platform-client-v2.js +1056 -91
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1056 -91
- package/dist/web-cjs/purecloud-platform-client-v2.js +1056 -91
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +631 -214
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +337 -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/CarrierServicesApi.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 +259 -9
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +70 -0
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -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/InfrastructureAsCodeApi.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 +10 -4
- 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 +3 -3
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +204 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +70 -0
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +31 -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/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
- 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 +1 -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 +7 -7
- 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 173.0.0
|
|
2283
2283
|
*/
|
|
2284
2284
|
class ApiClient {
|
|
2285
2285
|
/**
|
|
@@ -3358,7 +3358,7 @@ class AlertingApi {
|
|
|
3358
3358
|
/**
|
|
3359
3359
|
* Alerting service.
|
|
3360
3360
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3361
|
-
* @version
|
|
3361
|
+
* @version 173.0.0
|
|
3362
3362
|
*/
|
|
3363
3363
|
|
|
3364
3364
|
/**
|
|
@@ -3373,6 +3373,31 @@ class AlertingApi {
|
|
|
3373
3373
|
}
|
|
3374
3374
|
|
|
3375
3375
|
|
|
3376
|
+
/**
|
|
3377
|
+
* Delete an alert
|
|
3378
|
+
*
|
|
3379
|
+
* @param {String} alertId Alert ID
|
|
3380
|
+
*/
|
|
3381
|
+
deleteAlertingAlert(alertId) {
|
|
3382
|
+
// verify the required parameter 'alertId' is set
|
|
3383
|
+
if (alertId === undefined || alertId === null) {
|
|
3384
|
+
throw 'Missing the required parameter "alertId" when calling deleteAlertingAlert';
|
|
3385
|
+
}
|
|
3386
|
+
|
|
3387
|
+
return this.apiClient.callApi(
|
|
3388
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
3389
|
+
'DELETE',
|
|
3390
|
+
{ 'alertId': alertId },
|
|
3391
|
+
{ },
|
|
3392
|
+
{ },
|
|
3393
|
+
{ },
|
|
3394
|
+
null,
|
|
3395
|
+
['PureCloud OAuth'],
|
|
3396
|
+
['application/json'],
|
|
3397
|
+
['application/json']
|
|
3398
|
+
);
|
|
3399
|
+
}
|
|
3400
|
+
|
|
3376
3401
|
/**
|
|
3377
3402
|
* Delete an interaction stats alert
|
|
3378
3403
|
*
|
|
@@ -3423,6 +3448,56 @@ class AlertingApi {
|
|
|
3423
3448
|
);
|
|
3424
3449
|
}
|
|
3425
3450
|
|
|
3451
|
+
/**
|
|
3452
|
+
* Delete a rule.
|
|
3453
|
+
*
|
|
3454
|
+
* @param {String} ruleId Rule Id
|
|
3455
|
+
*/
|
|
3456
|
+
deleteAlertingRule(ruleId) {
|
|
3457
|
+
// verify the required parameter 'ruleId' is set
|
|
3458
|
+
if (ruleId === undefined || ruleId === null) {
|
|
3459
|
+
throw 'Missing the required parameter "ruleId" when calling deleteAlertingRule';
|
|
3460
|
+
}
|
|
3461
|
+
|
|
3462
|
+
return this.apiClient.callApi(
|
|
3463
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
3464
|
+
'DELETE',
|
|
3465
|
+
{ 'ruleId': ruleId },
|
|
3466
|
+
{ },
|
|
3467
|
+
{ },
|
|
3468
|
+
{ },
|
|
3469
|
+
null,
|
|
3470
|
+
['PureCloud OAuth'],
|
|
3471
|
+
['application/json'],
|
|
3472
|
+
['application/json']
|
|
3473
|
+
);
|
|
3474
|
+
}
|
|
3475
|
+
|
|
3476
|
+
/**
|
|
3477
|
+
* Get an alert
|
|
3478
|
+
*
|
|
3479
|
+
* @param {String} alertId Alert ID
|
|
3480
|
+
*/
|
|
3481
|
+
getAlertingAlert(alertId) {
|
|
3482
|
+
// verify the required parameter 'alertId' is set
|
|
3483
|
+
if (alertId === undefined || alertId === null) {
|
|
3484
|
+
throw 'Missing the required parameter "alertId" when calling getAlertingAlert';
|
|
3485
|
+
}
|
|
3486
|
+
|
|
3487
|
+
return this.apiClient.callApi(
|
|
3488
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
3489
|
+
'GET',
|
|
3490
|
+
{ 'alertId': alertId },
|
|
3491
|
+
{ },
|
|
3492
|
+
{ },
|
|
3493
|
+
{ },
|
|
3494
|
+
null,
|
|
3495
|
+
['PureCloud OAuth'],
|
|
3496
|
+
['application/json'],
|
|
3497
|
+
['application/json']
|
|
3498
|
+
);
|
|
3499
|
+
}
|
|
3500
|
+
|
|
3426
3501
|
/**
|
|
3427
3502
|
* Gets active alert count for a user.
|
|
3428
3503
|
*
|
|
@@ -3569,6 +3644,134 @@ class AlertingApi {
|
|
|
3569
3644
|
);
|
|
3570
3645
|
}
|
|
3571
3646
|
|
|
3647
|
+
/**
|
|
3648
|
+
* Get a rule.
|
|
3649
|
+
*
|
|
3650
|
+
* @param {String} ruleId Rule Id
|
|
3651
|
+
*/
|
|
3652
|
+
getAlertingRule(ruleId) {
|
|
3653
|
+
// verify the required parameter 'ruleId' is set
|
|
3654
|
+
if (ruleId === undefined || ruleId === null) {
|
|
3655
|
+
throw 'Missing the required parameter "ruleId" when calling getAlertingRule';
|
|
3656
|
+
}
|
|
3657
|
+
|
|
3658
|
+
return this.apiClient.callApi(
|
|
3659
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
3660
|
+
'GET',
|
|
3661
|
+
{ 'ruleId': ruleId },
|
|
3662
|
+
{ },
|
|
3663
|
+
{ },
|
|
3664
|
+
{ },
|
|
3665
|
+
null,
|
|
3666
|
+
['PureCloud OAuth'],
|
|
3667
|
+
['application/json'],
|
|
3668
|
+
['application/json']
|
|
3669
|
+
);
|
|
3670
|
+
}
|
|
3671
|
+
|
|
3672
|
+
/**
|
|
3673
|
+
* Allows an entity to mute/snooze an alert or update the unread status of the alert.
|
|
3674
|
+
* Snoozing an alert temporarily stop it from resending notifications to individualsas well as other services within Genesys Cloud for a given period. Muting an alert will only block the notifications to individuals.
|
|
3675
|
+
* @param {String} alertId Alert ID
|
|
3676
|
+
* @param {Object} opts Optional parameters
|
|
3677
|
+
* @param {Object} opts.body
|
|
3678
|
+
*/
|
|
3679
|
+
patchAlertingAlert(alertId, opts) {
|
|
3680
|
+
opts = opts || {};
|
|
3681
|
+
|
|
3682
|
+
// verify the required parameter 'alertId' is set
|
|
3683
|
+
if (alertId === undefined || alertId === null) {
|
|
3684
|
+
throw 'Missing the required parameter "alertId" when calling patchAlertingAlert';
|
|
3685
|
+
}
|
|
3686
|
+
|
|
3687
|
+
return this.apiClient.callApi(
|
|
3688
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
3689
|
+
'PATCH',
|
|
3690
|
+
{ 'alertId': alertId },
|
|
3691
|
+
{ },
|
|
3692
|
+
{ },
|
|
3693
|
+
{ },
|
|
3694
|
+
opts['body'],
|
|
3695
|
+
['PureCloud OAuth'],
|
|
3696
|
+
['application/json'],
|
|
3697
|
+
['application/json']
|
|
3698
|
+
);
|
|
3699
|
+
}
|
|
3700
|
+
|
|
3701
|
+
/**
|
|
3702
|
+
* Bulk alert updates
|
|
3703
|
+
*
|
|
3704
|
+
* @param {Object} body
|
|
3705
|
+
*/
|
|
3706
|
+
patchAlertingAlertsBulk(body) {
|
|
3707
|
+
// verify the required parameter 'body' is set
|
|
3708
|
+
if (body === undefined || body === null) {
|
|
3709
|
+
throw 'Missing the required parameter "body" when calling patchAlertingAlertsBulk';
|
|
3710
|
+
}
|
|
3711
|
+
|
|
3712
|
+
return this.apiClient.callApi(
|
|
3713
|
+
'/api/v2/alerting/alerts/bulk',
|
|
3714
|
+
'PATCH',
|
|
3715
|
+
{ },
|
|
3716
|
+
{ },
|
|
3717
|
+
{ },
|
|
3718
|
+
{ },
|
|
3719
|
+
body,
|
|
3720
|
+
['PureCloud OAuth'],
|
|
3721
|
+
['application/json'],
|
|
3722
|
+
['application/json']
|
|
3723
|
+
);
|
|
3724
|
+
}
|
|
3725
|
+
|
|
3726
|
+
/**
|
|
3727
|
+
* Bulk update of notification lists
|
|
3728
|
+
*
|
|
3729
|
+
* @param {Object} body
|
|
3730
|
+
*/
|
|
3731
|
+
patchAlertingRulesBulk(body) {
|
|
3732
|
+
// verify the required parameter 'body' is set
|
|
3733
|
+
if (body === undefined || body === null) {
|
|
3734
|
+
throw 'Missing the required parameter "body" when calling patchAlertingRulesBulk';
|
|
3735
|
+
}
|
|
3736
|
+
|
|
3737
|
+
return this.apiClient.callApi(
|
|
3738
|
+
'/api/v2/alerting/rules/bulk',
|
|
3739
|
+
'PATCH',
|
|
3740
|
+
{ },
|
|
3741
|
+
{ },
|
|
3742
|
+
{ },
|
|
3743
|
+
{ },
|
|
3744
|
+
body,
|
|
3745
|
+
['PureCloud OAuth'],
|
|
3746
|
+
['application/json'],
|
|
3747
|
+
['application/json']
|
|
3748
|
+
);
|
|
3749
|
+
}
|
|
3750
|
+
|
|
3751
|
+
/**
|
|
3752
|
+
* Gets a paged list of alerts. The max page size is 50
|
|
3753
|
+
*
|
|
3754
|
+
* @param {Object} opts Optional parameters
|
|
3755
|
+
* @param {Object} opts.body
|
|
3756
|
+
*/
|
|
3757
|
+
postAlertingAlertsQuery(opts) {
|
|
3758
|
+
opts = opts || {};
|
|
3759
|
+
|
|
3760
|
+
|
|
3761
|
+
return this.apiClient.callApi(
|
|
3762
|
+
'/api/v2/alerting/alerts/query',
|
|
3763
|
+
'POST',
|
|
3764
|
+
{ },
|
|
3765
|
+
{ },
|
|
3766
|
+
{ },
|
|
3767
|
+
{ },
|
|
3768
|
+
opts['body'],
|
|
3769
|
+
['PureCloud OAuth'],
|
|
3770
|
+
['application/json'],
|
|
3771
|
+
['application/json']
|
|
3772
|
+
);
|
|
3773
|
+
}
|
|
3774
|
+
|
|
3572
3775
|
/**
|
|
3573
3776
|
* Create an interaction stats rule.
|
|
3574
3777
|
*
|
|
@@ -3598,6 +3801,109 @@ class AlertingApi {
|
|
|
3598
3801
|
);
|
|
3599
3802
|
}
|
|
3600
3803
|
|
|
3804
|
+
/**
|
|
3805
|
+
* Create a Rule.
|
|
3806
|
+
*
|
|
3807
|
+
* @param {Object} body rule to be created
|
|
3808
|
+
*/
|
|
3809
|
+
postAlertingRules(body) {
|
|
3810
|
+
// verify the required parameter 'body' is set
|
|
3811
|
+
if (body === undefined || body === null) {
|
|
3812
|
+
throw 'Missing the required parameter "body" when calling postAlertingRules';
|
|
3813
|
+
}
|
|
3814
|
+
|
|
3815
|
+
return this.apiClient.callApi(
|
|
3816
|
+
'/api/v2/alerting/rules',
|
|
3817
|
+
'POST',
|
|
3818
|
+
{ },
|
|
3819
|
+
{ },
|
|
3820
|
+
{ },
|
|
3821
|
+
{ },
|
|
3822
|
+
body,
|
|
3823
|
+
['PureCloud OAuth'],
|
|
3824
|
+
['application/json'],
|
|
3825
|
+
['application/json']
|
|
3826
|
+
);
|
|
3827
|
+
}
|
|
3828
|
+
|
|
3829
|
+
/**
|
|
3830
|
+
* Bulk remove rules
|
|
3831
|
+
*
|
|
3832
|
+
* @param {Object} body
|
|
3833
|
+
*/
|
|
3834
|
+
postAlertingRulesBulkRemove(body) {
|
|
3835
|
+
// verify the required parameter 'body' is set
|
|
3836
|
+
if (body === undefined || body === null) {
|
|
3837
|
+
throw 'Missing the required parameter "body" when calling postAlertingRulesBulkRemove';
|
|
3838
|
+
}
|
|
3839
|
+
|
|
3840
|
+
return this.apiClient.callApi(
|
|
3841
|
+
'/api/v2/alerting/rules/bulk/remove',
|
|
3842
|
+
'POST',
|
|
3843
|
+
{ },
|
|
3844
|
+
{ },
|
|
3845
|
+
{ },
|
|
3846
|
+
{ },
|
|
3847
|
+
body,
|
|
3848
|
+
['PureCloud OAuth'],
|
|
3849
|
+
['application/json'],
|
|
3850
|
+
['application/json']
|
|
3851
|
+
);
|
|
3852
|
+
}
|
|
3853
|
+
|
|
3854
|
+
/**
|
|
3855
|
+
* Get a paged list of rules. The max size of the page is 50 items.
|
|
3856
|
+
*
|
|
3857
|
+
* @param {Object} opts Optional parameters
|
|
3858
|
+
* @param {Object} opts.body
|
|
3859
|
+
*/
|
|
3860
|
+
postAlertingRulesQuery(opts) {
|
|
3861
|
+
opts = opts || {};
|
|
3862
|
+
|
|
3863
|
+
|
|
3864
|
+
return this.apiClient.callApi(
|
|
3865
|
+
'/api/v2/alerting/rules/query',
|
|
3866
|
+
'POST',
|
|
3867
|
+
{ },
|
|
3868
|
+
{ },
|
|
3869
|
+
{ },
|
|
3870
|
+
{ },
|
|
3871
|
+
opts['body'],
|
|
3872
|
+
['PureCloud OAuth'],
|
|
3873
|
+
['application/json'],
|
|
3874
|
+
['application/json']
|
|
3875
|
+
);
|
|
3876
|
+
}
|
|
3877
|
+
|
|
3878
|
+
/**
|
|
3879
|
+
* Update an alert read status
|
|
3880
|
+
*
|
|
3881
|
+
* @param {String} alertId Alert ID
|
|
3882
|
+
* @param {Object} opts Optional parameters
|
|
3883
|
+
* @param {Object} opts.body
|
|
3884
|
+
*/
|
|
3885
|
+
putAlertingAlert(alertId, opts) {
|
|
3886
|
+
opts = opts || {};
|
|
3887
|
+
|
|
3888
|
+
// verify the required parameter 'alertId' is set
|
|
3889
|
+
if (alertId === undefined || alertId === null) {
|
|
3890
|
+
throw 'Missing the required parameter "alertId" when calling putAlertingAlert';
|
|
3891
|
+
}
|
|
3892
|
+
|
|
3893
|
+
return this.apiClient.callApi(
|
|
3894
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
3895
|
+
'PUT',
|
|
3896
|
+
{ 'alertId': alertId },
|
|
3897
|
+
{ },
|
|
3898
|
+
{ },
|
|
3899
|
+
{ },
|
|
3900
|
+
opts['body'],
|
|
3901
|
+
['PureCloud OAuth'],
|
|
3902
|
+
['application/json'],
|
|
3903
|
+
['application/json']
|
|
3904
|
+
);
|
|
3905
|
+
}
|
|
3906
|
+
|
|
3601
3907
|
/**
|
|
3602
3908
|
* Update an interaction stats alert read status
|
|
3603
3909
|
*
|
|
@@ -3666,13 +3972,43 @@ class AlertingApi {
|
|
|
3666
3972
|
);
|
|
3667
3973
|
}
|
|
3668
3974
|
|
|
3975
|
+
/**
|
|
3976
|
+
* Update a rule
|
|
3977
|
+
*
|
|
3978
|
+
* @param {String} ruleId Rule Id
|
|
3979
|
+
* @param {Object} body rule to be updated
|
|
3980
|
+
*/
|
|
3981
|
+
putAlertingRule(ruleId, body) {
|
|
3982
|
+
// verify the required parameter 'ruleId' is set
|
|
3983
|
+
if (ruleId === undefined || ruleId === null) {
|
|
3984
|
+
throw 'Missing the required parameter "ruleId" when calling putAlertingRule';
|
|
3985
|
+
}
|
|
3986
|
+
// verify the required parameter 'body' is set
|
|
3987
|
+
if (body === undefined || body === null) {
|
|
3988
|
+
throw 'Missing the required parameter "body" when calling putAlertingRule';
|
|
3989
|
+
}
|
|
3990
|
+
|
|
3991
|
+
return this.apiClient.callApi(
|
|
3992
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
3993
|
+
'PUT',
|
|
3994
|
+
{ 'ruleId': ruleId },
|
|
3995
|
+
{ },
|
|
3996
|
+
{ },
|
|
3997
|
+
{ },
|
|
3998
|
+
body,
|
|
3999
|
+
['PureCloud OAuth'],
|
|
4000
|
+
['application/json'],
|
|
4001
|
+
['application/json']
|
|
4002
|
+
);
|
|
4003
|
+
}
|
|
4004
|
+
|
|
3669
4005
|
}
|
|
3670
4006
|
|
|
3671
4007
|
class AnalyticsApi {
|
|
3672
4008
|
/**
|
|
3673
4009
|
* Analytics service.
|
|
3674
4010
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3675
|
-
* @version
|
|
4011
|
+
* @version 173.0.0
|
|
3676
4012
|
*/
|
|
3677
4013
|
|
|
3678
4014
|
/**
|
|
@@ -6117,7 +6453,7 @@ class ArchitectApi {
|
|
|
6117
6453
|
/**
|
|
6118
6454
|
* Architect service.
|
|
6119
6455
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6120
|
-
* @version
|
|
6456
|
+
* @version 173.0.0
|
|
6121
6457
|
*/
|
|
6122
6458
|
|
|
6123
6459
|
/**
|
|
@@ -9306,7 +9642,7 @@ class AuditApi {
|
|
|
9306
9642
|
/**
|
|
9307
9643
|
* Audit service.
|
|
9308
9644
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9309
|
-
* @version
|
|
9645
|
+
* @version 173.0.0
|
|
9310
9646
|
*/
|
|
9311
9647
|
|
|
9312
9648
|
/**
|
|
@@ -9477,7 +9813,7 @@ class AuthorizationApi {
|
|
|
9477
9813
|
/**
|
|
9478
9814
|
* Authorization service.
|
|
9479
9815
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9480
|
-
* @version
|
|
9816
|
+
* @version 173.0.0
|
|
9481
9817
|
*/
|
|
9482
9818
|
|
|
9483
9819
|
/**
|
|
@@ -10708,7 +11044,7 @@ class BillingApi {
|
|
|
10708
11044
|
/**
|
|
10709
11045
|
* Billing service.
|
|
10710
11046
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10711
|
-
* @version
|
|
11047
|
+
* @version 173.0.0
|
|
10712
11048
|
*/
|
|
10713
11049
|
|
|
10714
11050
|
/**
|
|
@@ -10788,7 +11124,7 @@ class CarrierServicesApi {
|
|
|
10788
11124
|
/**
|
|
10789
11125
|
* CarrierServices service.
|
|
10790
11126
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10791
|
-
* @version
|
|
11127
|
+
* @version 173.0.0
|
|
10792
11128
|
*/
|
|
10793
11129
|
|
|
10794
11130
|
/**
|
|
@@ -10858,7 +11194,7 @@ class ChatApi {
|
|
|
10858
11194
|
/**
|
|
10859
11195
|
* Chat service.
|
|
10860
11196
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10861
|
-
* @version
|
|
11197
|
+
* @version 173.0.0
|
|
10862
11198
|
*/
|
|
10863
11199
|
|
|
10864
11200
|
/**
|
|
@@ -11022,7 +11358,7 @@ class CoachingApi {
|
|
|
11022
11358
|
/**
|
|
11023
11359
|
* Coaching service.
|
|
11024
11360
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11025
|
-
* @version
|
|
11361
|
+
* @version 173.0.0
|
|
11026
11362
|
*/
|
|
11027
11363
|
|
|
11028
11364
|
/**
|
|
@@ -11599,7 +11935,7 @@ class ContentManagementApi {
|
|
|
11599
11935
|
/**
|
|
11600
11936
|
* ContentManagement service.
|
|
11601
11937
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11602
|
-
* @version
|
|
11938
|
+
* @version 173.0.0
|
|
11603
11939
|
*/
|
|
11604
11940
|
|
|
11605
11941
|
/**
|
|
@@ -12742,7 +13078,7 @@ class ConversationsApi {
|
|
|
12742
13078
|
/**
|
|
12743
13079
|
* Conversations service.
|
|
12744
13080
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12745
|
-
* @version
|
|
13081
|
+
* @version 173.0.0
|
|
12746
13082
|
*/
|
|
12747
13083
|
|
|
12748
13084
|
/**
|
|
@@ -13057,6 +13393,51 @@ class ConversationsApi {
|
|
|
13057
13393
|
);
|
|
13058
13394
|
}
|
|
13059
13395
|
|
|
13396
|
+
/**
|
|
13397
|
+
* Delete a messaging setting
|
|
13398
|
+
*
|
|
13399
|
+
* @param {String} messageSettingId Message Setting ID
|
|
13400
|
+
*/
|
|
13401
|
+
deleteConversationsMessagingSetting(messageSettingId) {
|
|
13402
|
+
// verify the required parameter 'messageSettingId' is set
|
|
13403
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
13404
|
+
throw 'Missing the required parameter "messageSettingId" when calling deleteConversationsMessagingSetting';
|
|
13405
|
+
}
|
|
13406
|
+
|
|
13407
|
+
return this.apiClient.callApi(
|
|
13408
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
13409
|
+
'DELETE',
|
|
13410
|
+
{ 'messageSettingId': messageSettingId },
|
|
13411
|
+
{ },
|
|
13412
|
+
{ },
|
|
13413
|
+
{ },
|
|
13414
|
+
null,
|
|
13415
|
+
['PureCloud OAuth'],
|
|
13416
|
+
['application/json'],
|
|
13417
|
+
['application/json']
|
|
13418
|
+
);
|
|
13419
|
+
}
|
|
13420
|
+
|
|
13421
|
+
/**
|
|
13422
|
+
* Delete the organization's default setting, a global default will be applied to integrations without settings
|
|
13423
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
|
13424
|
+
*/
|
|
13425
|
+
deleteConversationsMessagingSettingsDefault() {
|
|
13426
|
+
|
|
13427
|
+
return this.apiClient.callApi(
|
|
13428
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
13429
|
+
'DELETE',
|
|
13430
|
+
{ },
|
|
13431
|
+
{ },
|
|
13432
|
+
{ },
|
|
13433
|
+
{ },
|
|
13434
|
+
null,
|
|
13435
|
+
['PureCloud OAuth'],
|
|
13436
|
+
['application/json'],
|
|
13437
|
+
['application/json']
|
|
13438
|
+
);
|
|
13439
|
+
}
|
|
13440
|
+
|
|
13060
13441
|
/**
|
|
13061
13442
|
* Delete a supported content profile
|
|
13062
13443
|
*
|
|
@@ -15100,6 +15481,76 @@ class ConversationsApi {
|
|
|
15100
15481
|
);
|
|
15101
15482
|
}
|
|
15102
15483
|
|
|
15484
|
+
/**
|
|
15485
|
+
* Get a messaging setting
|
|
15486
|
+
*
|
|
15487
|
+
* @param {String} messageSettingId Message Setting ID
|
|
15488
|
+
*/
|
|
15489
|
+
getConversationsMessagingSetting(messageSettingId) {
|
|
15490
|
+
// verify the required parameter 'messageSettingId' is set
|
|
15491
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
15492
|
+
throw 'Missing the required parameter "messageSettingId" when calling getConversationsMessagingSetting';
|
|
15493
|
+
}
|
|
15494
|
+
|
|
15495
|
+
return this.apiClient.callApi(
|
|
15496
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
15497
|
+
'GET',
|
|
15498
|
+
{ 'messageSettingId': messageSettingId },
|
|
15499
|
+
{ },
|
|
15500
|
+
{ },
|
|
15501
|
+
{ },
|
|
15502
|
+
null,
|
|
15503
|
+
['PureCloud OAuth'],
|
|
15504
|
+
['application/json'],
|
|
15505
|
+
['application/json']
|
|
15506
|
+
);
|
|
15507
|
+
}
|
|
15508
|
+
|
|
15509
|
+
/**
|
|
15510
|
+
* Get a list of messaging settings
|
|
15511
|
+
*
|
|
15512
|
+
* @param {Object} opts Optional parameters
|
|
15513
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15514
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15515
|
+
*/
|
|
15516
|
+
getConversationsMessagingSettings(opts) {
|
|
15517
|
+
opts = opts || {};
|
|
15518
|
+
|
|
15519
|
+
|
|
15520
|
+
return this.apiClient.callApi(
|
|
15521
|
+
'/api/v2/conversations/messaging/settings',
|
|
15522
|
+
'GET',
|
|
15523
|
+
{ },
|
|
15524
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
15525
|
+
{ },
|
|
15526
|
+
{ },
|
|
15527
|
+
null,
|
|
15528
|
+
['PureCloud OAuth'],
|
|
15529
|
+
['application/json'],
|
|
15530
|
+
['application/json']
|
|
15531
|
+
);
|
|
15532
|
+
}
|
|
15533
|
+
|
|
15534
|
+
/**
|
|
15535
|
+
* Get the organization's default settings that will be used as the default when creating an integration.
|
|
15536
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
|
15537
|
+
*/
|
|
15538
|
+
getConversationsMessagingSettingsDefault() {
|
|
15539
|
+
|
|
15540
|
+
return this.apiClient.callApi(
|
|
15541
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
15542
|
+
'GET',
|
|
15543
|
+
{ },
|
|
15544
|
+
{ },
|
|
15545
|
+
{ },
|
|
15546
|
+
{ },
|
|
15547
|
+
null,
|
|
15548
|
+
['PureCloud OAuth'],
|
|
15549
|
+
['application/json'],
|
|
15550
|
+
['application/json']
|
|
15551
|
+
);
|
|
15552
|
+
}
|
|
15553
|
+
|
|
15103
15554
|
/**
|
|
15104
15555
|
* Get a list of Messaging Stickers
|
|
15105
15556
|
*
|
|
@@ -16600,6 +17051,36 @@ class ConversationsApi {
|
|
|
16600
17051
|
);
|
|
16601
17052
|
}
|
|
16602
17053
|
|
|
17054
|
+
/**
|
|
17055
|
+
* Update a messaging setting
|
|
17056
|
+
*
|
|
17057
|
+
* @param {String} messageSettingId Message Setting ID
|
|
17058
|
+
* @param {Object} body MessagingSetting
|
|
17059
|
+
*/
|
|
17060
|
+
patchConversationsMessagingSetting(messageSettingId, body) {
|
|
17061
|
+
// verify the required parameter 'messageSettingId' is set
|
|
17062
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
17063
|
+
throw 'Missing the required parameter "messageSettingId" when calling patchConversationsMessagingSetting';
|
|
17064
|
+
}
|
|
17065
|
+
// verify the required parameter 'body' is set
|
|
17066
|
+
if (body === undefined || body === null) {
|
|
17067
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingSetting';
|
|
17068
|
+
}
|
|
17069
|
+
|
|
17070
|
+
return this.apiClient.callApi(
|
|
17071
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
17072
|
+
'PATCH',
|
|
17073
|
+
{ 'messageSettingId': messageSettingId },
|
|
17074
|
+
{ },
|
|
17075
|
+
{ },
|
|
17076
|
+
{ },
|
|
17077
|
+
body,
|
|
17078
|
+
['PureCloud OAuth'],
|
|
17079
|
+
['application/json'],
|
|
17080
|
+
['application/json']
|
|
17081
|
+
);
|
|
17082
|
+
}
|
|
17083
|
+
|
|
16603
17084
|
/**
|
|
16604
17085
|
* Update a supported content profile
|
|
16605
17086
|
*
|
|
@@ -16847,6 +17328,32 @@ class ConversationsApi {
|
|
|
16847
17328
|
);
|
|
16848
17329
|
}
|
|
16849
17330
|
|
|
17331
|
+
/**
|
|
17332
|
+
* Barge a conversation creating a barged in conference of connected participants.
|
|
17333
|
+
*
|
|
17334
|
+
* @param {String} conversationId conversation ID
|
|
17335
|
+
* postConversationBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17336
|
+
*/
|
|
17337
|
+
postConversationBarge(conversationId) {
|
|
17338
|
+
// verify the required parameter 'conversationId' is set
|
|
17339
|
+
if (conversationId === undefined || conversationId === null) {
|
|
17340
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationBarge';
|
|
17341
|
+
}
|
|
17342
|
+
|
|
17343
|
+
return this.apiClient.callApi(
|
|
17344
|
+
'/api/v2/conversations/{conversationId}/barge',
|
|
17345
|
+
'POST',
|
|
17346
|
+
{ 'conversationId': conversationId },
|
|
17347
|
+
{ },
|
|
17348
|
+
{ },
|
|
17349
|
+
{ },
|
|
17350
|
+
null,
|
|
17351
|
+
['PureCloud OAuth'],
|
|
17352
|
+
['application/json'],
|
|
17353
|
+
['application/json']
|
|
17354
|
+
);
|
|
17355
|
+
}
|
|
17356
|
+
|
|
16850
17357
|
/**
|
|
16851
17358
|
* Creates a cobrowse session. Requires conversation:cobrowse:add (for web messaging) or conversation:cobrowsevoice:add permission.
|
|
16852
17359
|
*
|
|
@@ -16971,7 +17478,6 @@ class ConversationsApi {
|
|
|
16971
17478
|
* @param {String} conversationId conversation ID
|
|
16972
17479
|
* @param {String} participantId participant ID
|
|
16973
17480
|
* @param {Object} body Transfer request
|
|
16974
|
-
* @deprecated
|
|
16975
17481
|
*/
|
|
16976
17482
|
postConversationParticipantReplace(conversationId, participantId, body) {
|
|
16977
17483
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17007,6 +17513,7 @@ class ConversationsApi {
|
|
|
17007
17513
|
* @param {String} conversationId conversation ID
|
|
17008
17514
|
* @param {String} participantId participant ID
|
|
17009
17515
|
* @param {Object} body Transfer request
|
|
17516
|
+
* postConversationParticipantReplaceAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17010
17517
|
*/
|
|
17011
17518
|
postConversationParticipantReplaceAgent(conversationId, participantId, body) {
|
|
17012
17519
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17042,6 +17549,7 @@ class ConversationsApi {
|
|
|
17042
17549
|
* @param {String} conversationId conversation ID
|
|
17043
17550
|
* @param {String} participantId participant ID
|
|
17044
17551
|
* @param {Object} body Transfer request
|
|
17552
|
+
* postConversationParticipantReplaceExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17045
17553
|
*/
|
|
17046
17554
|
postConversationParticipantReplaceExternal(conversationId, participantId, body) {
|
|
17047
17555
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17077,6 +17585,7 @@ class ConversationsApi {
|
|
|
17077
17585
|
* @param {String} conversationId conversation ID
|
|
17078
17586
|
* @param {String} participantId participant ID
|
|
17079
17587
|
* @param {Object} body Transfer request
|
|
17588
|
+
* postConversationParticipantReplaceQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17080
17589
|
*/
|
|
17081
17590
|
postConversationParticipantReplaceQueue(conversationId, participantId, body) {
|
|
17082
17591
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17170,6 +17679,37 @@ class ConversationsApi {
|
|
|
17170
17679
|
);
|
|
17171
17680
|
}
|
|
17172
17681
|
|
|
17682
|
+
/**
|
|
17683
|
+
* Barge a given participant's call creating a barged in conference of connected participants.
|
|
17684
|
+
*
|
|
17685
|
+
* @param {String} conversationId conversationId
|
|
17686
|
+
* @param {String} participantId participantId
|
|
17687
|
+
* postConversationsCallParticipantBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17688
|
+
*/
|
|
17689
|
+
postConversationsCallParticipantBarge(conversationId, participantId) {
|
|
17690
|
+
// verify the required parameter 'conversationId' is set
|
|
17691
|
+
if (conversationId === undefined || conversationId === null) {
|
|
17692
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantBarge';
|
|
17693
|
+
}
|
|
17694
|
+
// verify the required parameter 'participantId' is set
|
|
17695
|
+
if (participantId === undefined || participantId === null) {
|
|
17696
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantBarge';
|
|
17697
|
+
}
|
|
17698
|
+
|
|
17699
|
+
return this.apiClient.callApi(
|
|
17700
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge',
|
|
17701
|
+
'POST',
|
|
17702
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
17703
|
+
{ },
|
|
17704
|
+
{ },
|
|
17705
|
+
{ },
|
|
17706
|
+
null,
|
|
17707
|
+
['PureCloud OAuth'],
|
|
17708
|
+
['application/json'],
|
|
17709
|
+
['application/json']
|
|
17710
|
+
);
|
|
17711
|
+
}
|
|
17712
|
+
|
|
17173
17713
|
/**
|
|
17174
17714
|
* Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
|
|
17175
17715
|
*
|
|
@@ -17245,7 +17785,6 @@ class ConversationsApi {
|
|
|
17245
17785
|
* @param {String} conversationId conversationId
|
|
17246
17786
|
* @param {String} participantId participantId
|
|
17247
17787
|
* @param {Object} body Destination address and initial speak to
|
|
17248
|
-
* @deprecated
|
|
17249
17788
|
*/
|
|
17250
17789
|
postConversationsCallParticipantConsult(conversationId, participantId, body) {
|
|
17251
17790
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17281,6 +17820,7 @@ class ConversationsApi {
|
|
|
17281
17820
|
* @param {String} conversationId conversationId
|
|
17282
17821
|
* @param {String} participantId participantId
|
|
17283
17822
|
* @param {Object} body Destination agent and initial speak to
|
|
17823
|
+
* postConversationsCallParticipantConsultAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17284
17824
|
*/
|
|
17285
17825
|
postConversationsCallParticipantConsultAgent(conversationId, participantId, body) {
|
|
17286
17826
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17316,6 +17856,7 @@ class ConversationsApi {
|
|
|
17316
17856
|
* @param {String} conversationId conversationId
|
|
17317
17857
|
* @param {String} participantId participantId
|
|
17318
17858
|
* @param {Object} body Destination address and initial speak to
|
|
17859
|
+
* postConversationsCallParticipantConsultExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17319
17860
|
*/
|
|
17320
17861
|
postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
|
|
17321
17862
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17351,6 +17892,7 @@ class ConversationsApi {
|
|
|
17351
17892
|
* @param {String} conversationId conversationId
|
|
17352
17893
|
* @param {String} participantId participantId
|
|
17353
17894
|
* @param {Object} body Destination queue and initial speak to
|
|
17895
|
+
* postConversationsCallParticipantConsultQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17354
17896
|
*/
|
|
17355
17897
|
postConversationsCallParticipantConsultQueue(conversationId, participantId, body) {
|
|
17356
17898
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17416,7 +17958,6 @@ class ConversationsApi {
|
|
|
17416
17958
|
* @param {String} conversationId conversationId
|
|
17417
17959
|
* @param {String} participantId participantId
|
|
17418
17960
|
* @param {Object} body Transfer request
|
|
17419
|
-
* @deprecated
|
|
17420
17961
|
*/
|
|
17421
17962
|
postConversationsCallParticipantReplace(conversationId, participantId, body) {
|
|
17422
17963
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17521,7 +18062,6 @@ class ConversationsApi {
|
|
|
17521
18062
|
* @param {String} conversationId conversationId
|
|
17522
18063
|
* @param {String} participantId participantId
|
|
17523
18064
|
* @param {Object} body Transfer request
|
|
17524
|
-
* @deprecated
|
|
17525
18065
|
*/
|
|
17526
18066
|
postConversationsCallbackParticipantReplace(conversationId, participantId, body) {
|
|
17527
18067
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17761,7 +18301,6 @@ class ConversationsApi {
|
|
|
17761
18301
|
* @param {String} conversationId conversationId
|
|
17762
18302
|
* @param {String} participantId participantId
|
|
17763
18303
|
* @param {Object} body Transfer request
|
|
17764
|
-
* @deprecated
|
|
17765
18304
|
*/
|
|
17766
18305
|
postConversationsChatParticipantReplace(conversationId, participantId, body) {
|
|
17767
18306
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17862,7 +18401,6 @@ class ConversationsApi {
|
|
|
17862
18401
|
* @param {String} participantId participantId
|
|
17863
18402
|
* @param {Object} opts Optional parameters
|
|
17864
18403
|
* @param {Object} opts.body
|
|
17865
|
-
* @deprecated
|
|
17866
18404
|
*/
|
|
17867
18405
|
postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, opts) {
|
|
17868
18406
|
opts = opts || {};
|
|
@@ -18025,7 +18563,6 @@ class ConversationsApi {
|
|
|
18025
18563
|
* @param {String} conversationId conversationId
|
|
18026
18564
|
* @param {String} participantId participantId
|
|
18027
18565
|
* @param {Object} body Transfer request
|
|
18028
|
-
* @deprecated
|
|
18029
18566
|
*/
|
|
18030
18567
|
postConversationsEmailParticipantReplace(conversationId, participantId, body) {
|
|
18031
18568
|
// verify the required parameter 'conversationId' is set
|
|
@@ -18390,7 +18927,6 @@ class ConversationsApi {
|
|
|
18390
18927
|
* @param {String} conversationId conversationId
|
|
18391
18928
|
* @param {String} participantId participantId
|
|
18392
18929
|
* @param {Object} body Transfer request
|
|
18393
|
-
* @deprecated
|
|
18394
18930
|
*/
|
|
18395
18931
|
postConversationsMessageParticipantReplace(conversationId, participantId, body) {
|
|
18396
18932
|
// verify the required parameter 'conversationId' is set
|
|
@@ -18645,6 +19181,31 @@ class ConversationsApi {
|
|
|
18645
19181
|
);
|
|
18646
19182
|
}
|
|
18647
19183
|
|
|
19184
|
+
/**
|
|
19185
|
+
* Create a messaging setting
|
|
19186
|
+
*
|
|
19187
|
+
* @param {Object} body MessagingSetting
|
|
19188
|
+
*/
|
|
19189
|
+
postConversationsMessagingSettings(body) {
|
|
19190
|
+
// verify the required parameter 'body' is set
|
|
19191
|
+
if (body === undefined || body === null) {
|
|
19192
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingSettings';
|
|
19193
|
+
}
|
|
19194
|
+
|
|
19195
|
+
return this.apiClient.callApi(
|
|
19196
|
+
'/api/v2/conversations/messaging/settings',
|
|
19197
|
+
'POST',
|
|
19198
|
+
{ },
|
|
19199
|
+
{ },
|
|
19200
|
+
{ },
|
|
19201
|
+
{ },
|
|
19202
|
+
body,
|
|
19203
|
+
['PureCloud OAuth'],
|
|
19204
|
+
['application/json'],
|
|
19205
|
+
['application/json']
|
|
19206
|
+
);
|
|
19207
|
+
}
|
|
19208
|
+
|
|
18648
19209
|
/**
|
|
18649
19210
|
* Create a Supported Content profile
|
|
18650
19211
|
*
|
|
@@ -19212,6 +19773,31 @@ class ConversationsApi {
|
|
|
19212
19773
|
);
|
|
19213
19774
|
}
|
|
19214
19775
|
|
|
19776
|
+
/**
|
|
19777
|
+
* Set the organization's default setting that may be applied to to integrations without settings
|
|
19778
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
|
19779
|
+
* @param {Object} body MessagingSetting
|
|
19780
|
+
*/
|
|
19781
|
+
putConversationsMessagingSettingsDefault(body) {
|
|
19782
|
+
// verify the required parameter 'body' is set
|
|
19783
|
+
if (body === undefined || body === null) {
|
|
19784
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingSettingsDefault';
|
|
19785
|
+
}
|
|
19786
|
+
|
|
19787
|
+
return this.apiClient.callApi(
|
|
19788
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
19789
|
+
'PUT',
|
|
19790
|
+
{ },
|
|
19791
|
+
{ },
|
|
19792
|
+
{ },
|
|
19793
|
+
{ },
|
|
19794
|
+
body,
|
|
19795
|
+
['PureCloud OAuth'],
|
|
19796
|
+
['application/json'],
|
|
19797
|
+
['application/json']
|
|
19798
|
+
);
|
|
19799
|
+
}
|
|
19800
|
+
|
|
19215
19801
|
/**
|
|
19216
19802
|
* Set the organization's default supported content profile that may be assigned to an integration when it is created.
|
|
19217
19803
|
* When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
|
|
@@ -19358,7 +19944,7 @@ class DataExtensionsApi {
|
|
|
19358
19944
|
/**
|
|
19359
19945
|
* DataExtensions service.
|
|
19360
19946
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
19361
|
-
* @version
|
|
19947
|
+
* @version 173.0.0
|
|
19362
19948
|
*/
|
|
19363
19949
|
|
|
19364
19950
|
/**
|
|
@@ -19444,7 +20030,7 @@ class DownloadsApi {
|
|
|
19444
20030
|
/**
|
|
19445
20031
|
* Downloads service.
|
|
19446
20032
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
19447
|
-
* @version
|
|
20033
|
+
* @version 173.0.0
|
|
19448
20034
|
*/
|
|
19449
20035
|
|
|
19450
20036
|
/**
|
|
@@ -19492,11 +20078,76 @@ class DownloadsApi {
|
|
|
19492
20078
|
|
|
19493
20079
|
}
|
|
19494
20080
|
|
|
20081
|
+
class EmailsApi {
|
|
20082
|
+
/**
|
|
20083
|
+
* Emails service.
|
|
20084
|
+
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20085
|
+
* @version 173.0.0
|
|
20086
|
+
*/
|
|
20087
|
+
|
|
20088
|
+
/**
|
|
20089
|
+
* Constructs a new EmailsApi.
|
|
20090
|
+
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
20091
|
+
* @class
|
|
20092
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
20093
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
20094
|
+
*/
|
|
20095
|
+
constructor(apiClient) {
|
|
20096
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
20097
|
+
}
|
|
20098
|
+
|
|
20099
|
+
|
|
20100
|
+
/**
|
|
20101
|
+
* Get email Contact Center settings
|
|
20102
|
+
*
|
|
20103
|
+
*/
|
|
20104
|
+
getEmailsSettings() {
|
|
20105
|
+
|
|
20106
|
+
return this.apiClient.callApi(
|
|
20107
|
+
'/api/v2/emails/settings',
|
|
20108
|
+
'GET',
|
|
20109
|
+
{ },
|
|
20110
|
+
{ },
|
|
20111
|
+
{ },
|
|
20112
|
+
{ },
|
|
20113
|
+
null,
|
|
20114
|
+
['PureCloud OAuth'],
|
|
20115
|
+
['application/json'],
|
|
20116
|
+
['application/json']
|
|
20117
|
+
);
|
|
20118
|
+
}
|
|
20119
|
+
|
|
20120
|
+
/**
|
|
20121
|
+
* Patch email Contact Center settings
|
|
20122
|
+
*
|
|
20123
|
+
* @param {Object} opts Optional parameters
|
|
20124
|
+
* @param {Object} opts.body
|
|
20125
|
+
*/
|
|
20126
|
+
patchEmailsSettings(opts) {
|
|
20127
|
+
opts = opts || {};
|
|
20128
|
+
|
|
20129
|
+
|
|
20130
|
+
return this.apiClient.callApi(
|
|
20131
|
+
'/api/v2/emails/settings',
|
|
20132
|
+
'PATCH',
|
|
20133
|
+
{ },
|
|
20134
|
+
{ },
|
|
20135
|
+
{ },
|
|
20136
|
+
{ },
|
|
20137
|
+
opts['body'],
|
|
20138
|
+
['PureCloud OAuth'],
|
|
20139
|
+
['application/json'],
|
|
20140
|
+
['application/json']
|
|
20141
|
+
);
|
|
20142
|
+
}
|
|
20143
|
+
|
|
20144
|
+
}
|
|
20145
|
+
|
|
19495
20146
|
class EventsApi {
|
|
19496
20147
|
/**
|
|
19497
20148
|
* Events service.
|
|
19498
20149
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
19499
|
-
* @version
|
|
20150
|
+
* @version 173.0.0
|
|
19500
20151
|
*/
|
|
19501
20152
|
|
|
19502
20153
|
/**
|
|
@@ -19592,7 +20243,7 @@ class ExternalContactsApi {
|
|
|
19592
20243
|
/**
|
|
19593
20244
|
* ExternalContacts service.
|
|
19594
20245
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
19595
|
-
* @version
|
|
20246
|
+
* @version 173.0.0
|
|
19596
20247
|
*/
|
|
19597
20248
|
|
|
19598
20249
|
/**
|
|
@@ -21550,7 +22201,7 @@ class FaxApi {
|
|
|
21550
22201
|
/**
|
|
21551
22202
|
* Fax service.
|
|
21552
22203
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
21553
|
-
* @version
|
|
22204
|
+
* @version 173.0.0
|
|
21554
22205
|
*/
|
|
21555
22206
|
|
|
21556
22207
|
/**
|
|
@@ -21721,7 +22372,7 @@ class FlowsApi {
|
|
|
21721
22372
|
/**
|
|
21722
22373
|
* Flows service.
|
|
21723
22374
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
21724
|
-
* @version
|
|
22375
|
+
* @version 173.0.0
|
|
21725
22376
|
*/
|
|
21726
22377
|
|
|
21727
22378
|
/**
|
|
@@ -21905,7 +22556,7 @@ class GamificationApi {
|
|
|
21905
22556
|
/**
|
|
21906
22557
|
* Gamification service.
|
|
21907
22558
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
21908
|
-
* @version
|
|
22559
|
+
* @version 173.0.0
|
|
21909
22560
|
*/
|
|
21910
22561
|
|
|
21911
22562
|
/**
|
|
@@ -23991,7 +24642,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
23991
24642
|
/**
|
|
23992
24643
|
* GeneralDataProtectionRegulation service.
|
|
23993
24644
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
23994
|
-
* @version
|
|
24645
|
+
* @version 173.0.0
|
|
23995
24646
|
*/
|
|
23996
24647
|
|
|
23997
24648
|
/**
|
|
@@ -24121,7 +24772,7 @@ class GeolocationApi {
|
|
|
24121
24772
|
/**
|
|
24122
24773
|
* Geolocation service.
|
|
24123
24774
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24124
|
-
* @version
|
|
24775
|
+
* @version 173.0.0
|
|
24125
24776
|
*/
|
|
24126
24777
|
|
|
24127
24778
|
/**
|
|
@@ -24252,7 +24903,7 @@ class GreetingsApi {
|
|
|
24252
24903
|
/**
|
|
24253
24904
|
* Greetings service.
|
|
24254
24905
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24255
|
-
* @version
|
|
24906
|
+
* @version 173.0.0
|
|
24256
24907
|
*/
|
|
24257
24908
|
|
|
24258
24909
|
/**
|
|
@@ -24707,7 +25358,7 @@ class GroupsApi {
|
|
|
24707
25358
|
/**
|
|
24708
25359
|
* Groups service.
|
|
24709
25360
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
24710
|
-
* @version
|
|
25361
|
+
* @version 173.0.0
|
|
24711
25362
|
*/
|
|
24712
25363
|
|
|
24713
25364
|
/**
|
|
@@ -25226,7 +25877,7 @@ class IdentityProviderApi {
|
|
|
25226
25877
|
/**
|
|
25227
25878
|
* IdentityProvider service.
|
|
25228
25879
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25229
|
-
* @version
|
|
25880
|
+
* @version 173.0.0
|
|
25230
25881
|
*/
|
|
25231
25882
|
|
|
25232
25883
|
/**
|
|
@@ -25982,7 +26633,7 @@ class InfrastructureAsCodeApi {
|
|
|
25982
26633
|
/**
|
|
25983
26634
|
* InfrastructureAsCode service.
|
|
25984
26635
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
25985
|
-
* @version
|
|
26636
|
+
* @version 173.0.0
|
|
25986
26637
|
*/
|
|
25987
26638
|
|
|
25988
26639
|
/**
|
|
@@ -26149,7 +26800,7 @@ class IntegrationsApi {
|
|
|
26149
26800
|
/**
|
|
26150
26801
|
* Integrations service.
|
|
26151
26802
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26152
|
-
* @version
|
|
26803
|
+
* @version 173.0.0
|
|
26153
26804
|
*/
|
|
26154
26805
|
|
|
26155
26806
|
/**
|
|
@@ -28111,7 +28762,7 @@ class JourneyApi {
|
|
|
28111
28762
|
/**
|
|
28112
28763
|
* Journey service.
|
|
28113
28764
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28114
|
-
* @version
|
|
28765
|
+
* @version 173.0.0
|
|
28115
28766
|
*/
|
|
28116
28767
|
|
|
28117
28768
|
/**
|
|
@@ -29214,7 +29865,7 @@ class KnowledgeApi {
|
|
|
29214
29865
|
/**
|
|
29215
29866
|
* Knowledge service.
|
|
29216
29867
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
29217
|
-
* @version
|
|
29868
|
+
* @version 173.0.0
|
|
29218
29869
|
*/
|
|
29219
29870
|
|
|
29220
29871
|
/**
|
|
@@ -30480,6 +31131,8 @@ class KnowledgeApi {
|
|
|
30480
31131
|
* @param {String} groupId The ID of the group to be retrieved.
|
|
30481
31132
|
* @param {Object} opts Optional parameters
|
|
30482
31133
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
31134
|
+
* @param {String} opts.dateStart The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
31135
|
+
* @param {String} opts.dateEnd The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30483
31136
|
*/
|
|
30484
31137
|
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
30485
31138
|
opts = opts || {};
|
|
@@ -30497,7 +31150,7 @@ class KnowledgeApi {
|
|
|
30497
31150
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
30498
31151
|
'GET',
|
|
30499
31152
|
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
30500
|
-
{ 'app': opts['app'] },
|
|
31153
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
30501
31154
|
{ },
|
|
30502
31155
|
{ },
|
|
30503
31156
|
null,
|
|
@@ -30515,6 +31168,8 @@ class KnowledgeApi {
|
|
|
30515
31168
|
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
30516
31169
|
* @param {Object} opts Optional parameters
|
|
30517
31170
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
31171
|
+
* @param {String} opts.dateStart The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
31172
|
+
* @param {String} opts.dateEnd The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30518
31173
|
*/
|
|
30519
31174
|
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
30520
31175
|
opts = opts || {};
|
|
@@ -30536,7 +31191,7 @@ class KnowledgeApi {
|
|
|
30536
31191
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
30537
31192
|
'GET',
|
|
30538
31193
|
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
30539
|
-
{ 'app': opts['app'] },
|
|
31194
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
30540
31195
|
{ },
|
|
30541
31196
|
{ },
|
|
30542
31197
|
null,
|
|
@@ -30552,6 +31207,8 @@ class KnowledgeApi {
|
|
|
30552
31207
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
30553
31208
|
* @param {Object} opts Optional parameters
|
|
30554
31209
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
31210
|
+
* @param {String} opts.dateStart The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
31211
|
+
* @param {String} opts.dateEnd The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30555
31212
|
*/
|
|
30556
31213
|
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
30557
31214
|
opts = opts || {};
|
|
@@ -30565,7 +31222,7 @@ class KnowledgeApi {
|
|
|
30565
31222
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
30566
31223
|
'GET',
|
|
30567
31224
|
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
30568
|
-
{ 'app': opts['app'] },
|
|
31225
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
30569
31226
|
{ },
|
|
30570
31227
|
{ },
|
|
30571
31228
|
null,
|
|
@@ -31844,7 +32501,7 @@ class LanguageUnderstandingApi {
|
|
|
31844
32501
|
/**
|
|
31845
32502
|
* LanguageUnderstanding service.
|
|
31846
32503
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
31847
|
-
* @version
|
|
32504
|
+
* @version 173.0.0
|
|
31848
32505
|
*/
|
|
31849
32506
|
|
|
31850
32507
|
/**
|
|
@@ -32857,7 +33514,7 @@ class LanguagesApi {
|
|
|
32857
33514
|
/**
|
|
32858
33515
|
* Languages service.
|
|
32859
33516
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
32860
|
-
* @version
|
|
33517
|
+
* @version 173.0.0
|
|
32861
33518
|
*/
|
|
32862
33519
|
|
|
32863
33520
|
/**
|
|
@@ -33079,7 +33736,7 @@ class LearningApi {
|
|
|
33079
33736
|
/**
|
|
33080
33737
|
* Learning service.
|
|
33081
33738
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33082
|
-
* @version
|
|
33739
|
+
* @version 173.0.0
|
|
33083
33740
|
*/
|
|
33084
33741
|
|
|
33085
33742
|
/**
|
|
@@ -33894,7 +34551,7 @@ class LicenseApi {
|
|
|
33894
34551
|
/**
|
|
33895
34552
|
* License service.
|
|
33896
34553
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
33897
|
-
* @version
|
|
34554
|
+
* @version 173.0.0
|
|
33898
34555
|
*/
|
|
33899
34556
|
|
|
33900
34557
|
/**
|
|
@@ -33955,7 +34612,7 @@ class LicenseApi {
|
|
|
33955
34612
|
}
|
|
33956
34613
|
|
|
33957
34614
|
/**
|
|
33958
|
-
*
|
|
34615
|
+
* Deprecated - no alternative required. This operation will always return 'true' for requested toggles
|
|
33959
34616
|
*
|
|
33960
34617
|
* @param {String} featureName featureName
|
|
33961
34618
|
*/
|
|
@@ -34078,7 +34735,7 @@ class LicenseApi {
|
|
|
34078
34735
|
}
|
|
34079
34736
|
|
|
34080
34737
|
/**
|
|
34081
|
-
*
|
|
34738
|
+
* Deprecated. No alternative required - this endpoint has no effect
|
|
34082
34739
|
*
|
|
34083
34740
|
* @param {String} featureName featureName
|
|
34084
34741
|
*/
|
|
@@ -34132,7 +34789,7 @@ class LocationsApi {
|
|
|
34132
34789
|
/**
|
|
34133
34790
|
* Locations service.
|
|
34134
34791
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34135
|
-
* @version
|
|
34792
|
+
* @version 173.0.0
|
|
34136
34793
|
*/
|
|
34137
34794
|
|
|
34138
34795
|
/**
|
|
@@ -34368,7 +35025,7 @@ class MessagingApi {
|
|
|
34368
35025
|
/**
|
|
34369
35026
|
* Messaging service.
|
|
34370
35027
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
34371
|
-
* @version
|
|
35028
|
+
* @version 173.0.0
|
|
34372
35029
|
*/
|
|
34373
35030
|
|
|
34374
35031
|
/**
|
|
@@ -34383,6 +35040,53 @@ class MessagingApi {
|
|
|
34383
35040
|
}
|
|
34384
35041
|
|
|
34385
35042
|
|
|
35043
|
+
/**
|
|
35044
|
+
* Delete a messaging setting
|
|
35045
|
+
*
|
|
35046
|
+
* @param {String} messageSettingId Message Settings ID
|
|
35047
|
+
* @deprecated
|
|
35048
|
+
*/
|
|
35049
|
+
deleteMessagingSetting(messageSettingId) {
|
|
35050
|
+
// verify the required parameter 'messageSettingId' is set
|
|
35051
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
35052
|
+
throw 'Missing the required parameter "messageSettingId" when calling deleteMessagingSetting';
|
|
35053
|
+
}
|
|
35054
|
+
|
|
35055
|
+
return this.apiClient.callApi(
|
|
35056
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
35057
|
+
'DELETE',
|
|
35058
|
+
{ 'messageSettingId': messageSettingId },
|
|
35059
|
+
{ },
|
|
35060
|
+
{ },
|
|
35061
|
+
{ },
|
|
35062
|
+
null,
|
|
35063
|
+
['PureCloud OAuth'],
|
|
35064
|
+
['application/json'],
|
|
35065
|
+
['application/json']
|
|
35066
|
+
);
|
|
35067
|
+
}
|
|
35068
|
+
|
|
35069
|
+
/**
|
|
35070
|
+
* Delete the organization's default setting, a global default will be applied to integrations without settings
|
|
35071
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
|
|
35072
|
+
* @deprecated
|
|
35073
|
+
*/
|
|
35074
|
+
deleteMessagingSettingsDefault() {
|
|
35075
|
+
|
|
35076
|
+
return this.apiClient.callApi(
|
|
35077
|
+
'/api/v2/messaging/settings/default',
|
|
35078
|
+
'DELETE',
|
|
35079
|
+
{ },
|
|
35080
|
+
{ },
|
|
35081
|
+
{ },
|
|
35082
|
+
{ },
|
|
35083
|
+
null,
|
|
35084
|
+
['PureCloud OAuth'],
|
|
35085
|
+
['application/json'],
|
|
35086
|
+
['application/json']
|
|
35087
|
+
);
|
|
35088
|
+
}
|
|
35089
|
+
|
|
34386
35090
|
/**
|
|
34387
35091
|
* Delete a supported content profile
|
|
34388
35092
|
* Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
@@ -34409,6 +35113,79 @@ class MessagingApi {
|
|
|
34409
35113
|
);
|
|
34410
35114
|
}
|
|
34411
35115
|
|
|
35116
|
+
/**
|
|
35117
|
+
* Get a messaging setting
|
|
35118
|
+
*
|
|
35119
|
+
* @param {String} messageSettingId Message Settings ID
|
|
35120
|
+
* @deprecated
|
|
35121
|
+
*/
|
|
35122
|
+
getMessagingSetting(messageSettingId) {
|
|
35123
|
+
// verify the required parameter 'messageSettingId' is set
|
|
35124
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
35125
|
+
throw 'Missing the required parameter "messageSettingId" when calling getMessagingSetting';
|
|
35126
|
+
}
|
|
35127
|
+
|
|
35128
|
+
return this.apiClient.callApi(
|
|
35129
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
35130
|
+
'GET',
|
|
35131
|
+
{ 'messageSettingId': messageSettingId },
|
|
35132
|
+
{ },
|
|
35133
|
+
{ },
|
|
35134
|
+
{ },
|
|
35135
|
+
null,
|
|
35136
|
+
['PureCloud OAuth'],
|
|
35137
|
+
['application/json'],
|
|
35138
|
+
['application/json']
|
|
35139
|
+
);
|
|
35140
|
+
}
|
|
35141
|
+
|
|
35142
|
+
/**
|
|
35143
|
+
* Get a list of messaging settings
|
|
35144
|
+
*
|
|
35145
|
+
* @param {Object} opts Optional parameters
|
|
35146
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
35147
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
35148
|
+
* @deprecated
|
|
35149
|
+
*/
|
|
35150
|
+
getMessagingSettings(opts) {
|
|
35151
|
+
opts = opts || {};
|
|
35152
|
+
|
|
35153
|
+
|
|
35154
|
+
return this.apiClient.callApi(
|
|
35155
|
+
'/api/v2/messaging/settings',
|
|
35156
|
+
'GET',
|
|
35157
|
+
{ },
|
|
35158
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
35159
|
+
{ },
|
|
35160
|
+
{ },
|
|
35161
|
+
null,
|
|
35162
|
+
['PureCloud OAuth'],
|
|
35163
|
+
['application/json'],
|
|
35164
|
+
['application/json']
|
|
35165
|
+
);
|
|
35166
|
+
}
|
|
35167
|
+
|
|
35168
|
+
/**
|
|
35169
|
+
* Get the organization's default settings that will be used as the default when creating an integration.
|
|
35170
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
|
|
35171
|
+
* @deprecated
|
|
35172
|
+
*/
|
|
35173
|
+
getMessagingSettingsDefault() {
|
|
35174
|
+
|
|
35175
|
+
return this.apiClient.callApi(
|
|
35176
|
+
'/api/v2/messaging/settings/default',
|
|
35177
|
+
'GET',
|
|
35178
|
+
{ },
|
|
35179
|
+
{ },
|
|
35180
|
+
{ },
|
|
35181
|
+
{ },
|
|
35182
|
+
null,
|
|
35183
|
+
['PureCloud OAuth'],
|
|
35184
|
+
['application/json'],
|
|
35185
|
+
['application/json']
|
|
35186
|
+
);
|
|
35187
|
+
}
|
|
35188
|
+
|
|
34412
35189
|
/**
|
|
34413
35190
|
* Get a list of Supported Content profiles
|
|
34414
35191
|
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
|
|
@@ -34461,6 +35238,37 @@ class MessagingApi {
|
|
|
34461
35238
|
);
|
|
34462
35239
|
}
|
|
34463
35240
|
|
|
35241
|
+
/**
|
|
35242
|
+
* Update a messaging setting
|
|
35243
|
+
*
|
|
35244
|
+
* @param {String} messageSettingId Message Settings ID
|
|
35245
|
+
* @param {Object} body MessagingSetting
|
|
35246
|
+
* @deprecated
|
|
35247
|
+
*/
|
|
35248
|
+
patchMessagingSetting(messageSettingId, body) {
|
|
35249
|
+
// verify the required parameter 'messageSettingId' is set
|
|
35250
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
35251
|
+
throw 'Missing the required parameter "messageSettingId" when calling patchMessagingSetting';
|
|
35252
|
+
}
|
|
35253
|
+
// verify the required parameter 'body' is set
|
|
35254
|
+
if (body === undefined || body === null) {
|
|
35255
|
+
throw 'Missing the required parameter "body" when calling patchMessagingSetting';
|
|
35256
|
+
}
|
|
35257
|
+
|
|
35258
|
+
return this.apiClient.callApi(
|
|
35259
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
35260
|
+
'PATCH',
|
|
35261
|
+
{ 'messageSettingId': messageSettingId },
|
|
35262
|
+
{ },
|
|
35263
|
+
{ },
|
|
35264
|
+
{ },
|
|
35265
|
+
body,
|
|
35266
|
+
['PureCloud OAuth'],
|
|
35267
|
+
['application/json'],
|
|
35268
|
+
['application/json']
|
|
35269
|
+
);
|
|
35270
|
+
}
|
|
35271
|
+
|
|
34464
35272
|
/**
|
|
34465
35273
|
* Update a supported content profile
|
|
34466
35274
|
* Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
@@ -34492,6 +35300,32 @@ class MessagingApi {
|
|
|
34492
35300
|
);
|
|
34493
35301
|
}
|
|
34494
35302
|
|
|
35303
|
+
/**
|
|
35304
|
+
* Create a messaging setting
|
|
35305
|
+
*
|
|
35306
|
+
* @param {Object} body MessagingSetting
|
|
35307
|
+
* @deprecated
|
|
35308
|
+
*/
|
|
35309
|
+
postMessagingSettings(body) {
|
|
35310
|
+
// verify the required parameter 'body' is set
|
|
35311
|
+
if (body === undefined || body === null) {
|
|
35312
|
+
throw 'Missing the required parameter "body" when calling postMessagingSettings';
|
|
35313
|
+
}
|
|
35314
|
+
|
|
35315
|
+
return this.apiClient.callApi(
|
|
35316
|
+
'/api/v2/messaging/settings',
|
|
35317
|
+
'POST',
|
|
35318
|
+
{ },
|
|
35319
|
+
{ },
|
|
35320
|
+
{ },
|
|
35321
|
+
{ },
|
|
35322
|
+
body,
|
|
35323
|
+
['PureCloud OAuth'],
|
|
35324
|
+
['application/json'],
|
|
35325
|
+
['application/json']
|
|
35326
|
+
);
|
|
35327
|
+
}
|
|
35328
|
+
|
|
34495
35329
|
/**
|
|
34496
35330
|
* Create a Supported Content profile
|
|
34497
35331
|
* Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
|
|
@@ -34518,13 +35352,39 @@ class MessagingApi {
|
|
|
34518
35352
|
);
|
|
34519
35353
|
}
|
|
34520
35354
|
|
|
35355
|
+
/**
|
|
35356
|
+
* Set the organization's default settings that may be applied to an integration when it is created.
|
|
35357
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
|
|
35358
|
+
* @param {Object} body Messaging Setting ID
|
|
35359
|
+
* @deprecated
|
|
35360
|
+
*/
|
|
35361
|
+
putMessagingSettingsDefault(body) {
|
|
35362
|
+
// verify the required parameter 'body' is set
|
|
35363
|
+
if (body === undefined || body === null) {
|
|
35364
|
+
throw 'Missing the required parameter "body" when calling putMessagingSettingsDefault';
|
|
35365
|
+
}
|
|
35366
|
+
|
|
35367
|
+
return this.apiClient.callApi(
|
|
35368
|
+
'/api/v2/messaging/settings/default',
|
|
35369
|
+
'PUT',
|
|
35370
|
+
{ },
|
|
35371
|
+
{ },
|
|
35372
|
+
{ },
|
|
35373
|
+
{ },
|
|
35374
|
+
body,
|
|
35375
|
+
['PureCloud OAuth'],
|
|
35376
|
+
['application/json'],
|
|
35377
|
+
['application/json']
|
|
35378
|
+
);
|
|
35379
|
+
}
|
|
35380
|
+
|
|
34521
35381
|
}
|
|
34522
35382
|
|
|
34523
35383
|
class MobileDevicesApi {
|
|
34524
35384
|
/**
|
|
34525
35385
|
* MobileDevices service.
|
|
34526
35386
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
34527
|
-
* @version
|
|
35387
|
+
* @version 173.0.0
|
|
34528
35388
|
*/
|
|
34529
35389
|
|
|
34530
35390
|
/**
|
|
@@ -34675,7 +35535,7 @@ class NotificationsApi {
|
|
|
34675
35535
|
/**
|
|
34676
35536
|
* Notifications service.
|
|
34677
35537
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
34678
|
-
* @version
|
|
35538
|
+
* @version 173.0.0
|
|
34679
35539
|
*/
|
|
34680
35540
|
|
|
34681
35541
|
/**
|
|
@@ -34908,7 +35768,7 @@ class OAuthApi {
|
|
|
34908
35768
|
/**
|
|
34909
35769
|
* OAuth service.
|
|
34910
35770
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
34911
|
-
* @version
|
|
35771
|
+
* @version 173.0.0
|
|
34912
35772
|
*/
|
|
34913
35773
|
|
|
34914
35774
|
/**
|
|
@@ -35274,7 +36134,7 @@ class ObjectsApi {
|
|
|
35274
36134
|
/**
|
|
35275
36135
|
* Objects service.
|
|
35276
36136
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
35277
|
-
* @version
|
|
36137
|
+
* @version 173.0.0
|
|
35278
36138
|
*/
|
|
35279
36139
|
|
|
35280
36140
|
/**
|
|
@@ -35545,7 +36405,7 @@ class OrganizationApi {
|
|
|
35545
36405
|
/**
|
|
35546
36406
|
* Organization service.
|
|
35547
36407
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
35548
|
-
* @version
|
|
36408
|
+
* @version 173.0.0
|
|
35549
36409
|
*/
|
|
35550
36410
|
|
|
35551
36411
|
/**
|
|
@@ -36000,7 +36860,7 @@ class OrganizationAuthorizationApi {
|
|
|
36000
36860
|
/**
|
|
36001
36861
|
* OrganizationAuthorization service.
|
|
36002
36862
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
36003
|
-
* @version
|
|
36863
|
+
* @version 173.0.0
|
|
36004
36864
|
*/
|
|
36005
36865
|
|
|
36006
36866
|
/**
|
|
@@ -37347,7 +38207,7 @@ class OutboundApi {
|
|
|
37347
38207
|
/**
|
|
37348
38208
|
* Outbound service.
|
|
37349
38209
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
37350
|
-
* @version
|
|
38210
|
+
* @version 173.0.0
|
|
37351
38211
|
*/
|
|
37352
38212
|
|
|
37353
38213
|
/**
|
|
@@ -40969,7 +41829,7 @@ class PresenceApi {
|
|
|
40969
41829
|
/**
|
|
40970
41830
|
* Presence service.
|
|
40971
41831
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
40972
|
-
* @version
|
|
41832
|
+
* @version 173.0.0
|
|
40973
41833
|
*/
|
|
40974
41834
|
|
|
40975
41835
|
/**
|
|
@@ -41708,7 +42568,7 @@ class ProcessAutomationApi {
|
|
|
41708
42568
|
/**
|
|
41709
42569
|
* ProcessAutomation service.
|
|
41710
42570
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
41711
|
-
* @version
|
|
42571
|
+
* @version 173.0.0
|
|
41712
42572
|
*/
|
|
41713
42573
|
|
|
41714
42574
|
/**
|
|
@@ -41947,7 +42807,7 @@ class QualityApi {
|
|
|
41947
42807
|
/**
|
|
41948
42808
|
* Quality service.
|
|
41949
42809
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
41950
|
-
* @version
|
|
42810
|
+
* @version 173.0.0
|
|
41951
42811
|
*/
|
|
41952
42812
|
|
|
41953
42813
|
/**
|
|
@@ -43699,7 +44559,7 @@ class RecordingApi {
|
|
|
43699
44559
|
/**
|
|
43700
44560
|
* Recording service.
|
|
43701
44561
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
43702
|
-
* @version
|
|
44562
|
+
* @version 173.0.0
|
|
43703
44563
|
*/
|
|
43704
44564
|
|
|
43705
44565
|
/**
|
|
@@ -45336,7 +46196,7 @@ class ResponseManagementApi {
|
|
|
45336
46196
|
/**
|
|
45337
46197
|
* ResponseManagement service.
|
|
45338
46198
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
45339
|
-
* @version
|
|
46199
|
+
* @version 173.0.0
|
|
45340
46200
|
*/
|
|
45341
46201
|
|
|
45342
46202
|
/**
|
|
@@ -45821,7 +46681,7 @@ class RoutingApi {
|
|
|
45821
46681
|
/**
|
|
45822
46682
|
* Routing service.
|
|
45823
46683
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
45824
|
-
* @version
|
|
46684
|
+
* @version 173.0.0
|
|
45825
46685
|
*/
|
|
45826
46686
|
|
|
45827
46687
|
/**
|
|
@@ -49528,7 +50388,7 @@ class SCIMApi {
|
|
|
49528
50388
|
/**
|
|
49529
50389
|
* SCIM service.
|
|
49530
50390
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
49531
|
-
* @version
|
|
50391
|
+
* @version 173.0.0
|
|
49532
50392
|
*/
|
|
49533
50393
|
|
|
49534
50394
|
/**
|
|
@@ -50405,7 +51265,7 @@ class ScriptsApi {
|
|
|
50405
51265
|
/**
|
|
50406
51266
|
* Scripts service.
|
|
50407
51267
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
50408
|
-
* @version
|
|
51268
|
+
* @version 173.0.0
|
|
50409
51269
|
*/
|
|
50410
51270
|
|
|
50411
51271
|
/**
|
|
@@ -50849,7 +51709,7 @@ class SearchApi {
|
|
|
50849
51709
|
/**
|
|
50850
51710
|
* Search service.
|
|
50851
51711
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
50852
|
-
* @version
|
|
51712
|
+
* @version 173.0.0
|
|
50853
51713
|
*/
|
|
50854
51714
|
|
|
50855
51715
|
/**
|
|
@@ -51534,11 +52394,76 @@ class SearchApi {
|
|
|
51534
52394
|
|
|
51535
52395
|
}
|
|
51536
52396
|
|
|
52397
|
+
class SettingsApi {
|
|
52398
|
+
/**
|
|
52399
|
+
* Settings service.
|
|
52400
|
+
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
52401
|
+
* @version 173.0.0
|
|
52402
|
+
*/
|
|
52403
|
+
|
|
52404
|
+
/**
|
|
52405
|
+
* Constructs a new SettingsApi.
|
|
52406
|
+
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
52407
|
+
* @class
|
|
52408
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
52409
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
52410
|
+
*/
|
|
52411
|
+
constructor(apiClient) {
|
|
52412
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
52413
|
+
}
|
|
52414
|
+
|
|
52415
|
+
|
|
52416
|
+
/**
|
|
52417
|
+
* Get email Contact Center settings
|
|
52418
|
+
*
|
|
52419
|
+
*/
|
|
52420
|
+
getEmailsSettings() {
|
|
52421
|
+
|
|
52422
|
+
return this.apiClient.callApi(
|
|
52423
|
+
'/api/v2/emails/settings',
|
|
52424
|
+
'GET',
|
|
52425
|
+
{ },
|
|
52426
|
+
{ },
|
|
52427
|
+
{ },
|
|
52428
|
+
{ },
|
|
52429
|
+
null,
|
|
52430
|
+
['PureCloud OAuth'],
|
|
52431
|
+
['application/json'],
|
|
52432
|
+
['application/json']
|
|
52433
|
+
);
|
|
52434
|
+
}
|
|
52435
|
+
|
|
52436
|
+
/**
|
|
52437
|
+
* Patch email Contact Center settings
|
|
52438
|
+
*
|
|
52439
|
+
* @param {Object} opts Optional parameters
|
|
52440
|
+
* @param {Object} opts.body
|
|
52441
|
+
*/
|
|
52442
|
+
patchEmailsSettings(opts) {
|
|
52443
|
+
opts = opts || {};
|
|
52444
|
+
|
|
52445
|
+
|
|
52446
|
+
return this.apiClient.callApi(
|
|
52447
|
+
'/api/v2/emails/settings',
|
|
52448
|
+
'PATCH',
|
|
52449
|
+
{ },
|
|
52450
|
+
{ },
|
|
52451
|
+
{ },
|
|
52452
|
+
{ },
|
|
52453
|
+
opts['body'],
|
|
52454
|
+
['PureCloud OAuth'],
|
|
52455
|
+
['application/json'],
|
|
52456
|
+
['application/json']
|
|
52457
|
+
);
|
|
52458
|
+
}
|
|
52459
|
+
|
|
52460
|
+
}
|
|
52461
|
+
|
|
51537
52462
|
class SpeechTextAnalyticsApi {
|
|
51538
52463
|
/**
|
|
51539
52464
|
* SpeechTextAnalytics service.
|
|
51540
52465
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
51541
|
-
* @version
|
|
52466
|
+
* @version 173.0.0
|
|
51542
52467
|
*/
|
|
51543
52468
|
|
|
51544
52469
|
/**
|
|
@@ -51707,6 +52632,36 @@ class SpeechTextAnalyticsApi {
|
|
|
51707
52632
|
);
|
|
51708
52633
|
}
|
|
51709
52634
|
|
|
52635
|
+
/**
|
|
52636
|
+
* Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation
|
|
52637
|
+
*
|
|
52638
|
+
* @param {String} conversationId Conversation ID
|
|
52639
|
+
* @param {String} communicationId Communication ID
|
|
52640
|
+
*/
|
|
52641
|
+
getSpeechandtextanalyticsConversationCommunicationTranscripturls(conversationId, communicationId) {
|
|
52642
|
+
// verify the required parameter 'conversationId' is set
|
|
52643
|
+
if (conversationId === undefined || conversationId === null) {
|
|
52644
|
+
throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';
|
|
52645
|
+
}
|
|
52646
|
+
// verify the required parameter 'communicationId' is set
|
|
52647
|
+
if (communicationId === undefined || communicationId === null) {
|
|
52648
|
+
throw 'Missing the required parameter "communicationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';
|
|
52649
|
+
}
|
|
52650
|
+
|
|
52651
|
+
return this.apiClient.callApi(
|
|
52652
|
+
'/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls',
|
|
52653
|
+
'GET',
|
|
52654
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
52655
|
+
{ },
|
|
52656
|
+
{ },
|
|
52657
|
+
{ },
|
|
52658
|
+
null,
|
|
52659
|
+
['PureCloud OAuth'],
|
|
52660
|
+
['application/json'],
|
|
52661
|
+
['application/json']
|
|
52662
|
+
);
|
|
52663
|
+
}
|
|
52664
|
+
|
|
51710
52665
|
/**
|
|
51711
52666
|
* Get a Speech and Text Analytics program by id
|
|
51712
52667
|
*
|
|
@@ -52491,7 +53446,7 @@ class StationsApi {
|
|
|
52491
53446
|
/**
|
|
52492
53447
|
* Stations service.
|
|
52493
53448
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
52494
|
-
* @version
|
|
53449
|
+
* @version 173.0.0
|
|
52495
53450
|
*/
|
|
52496
53451
|
|
|
52497
53452
|
/**
|
|
@@ -52593,7 +53548,7 @@ class SuggestApi {
|
|
|
52593
53548
|
/**
|
|
52594
53549
|
* Suggest service.
|
|
52595
53550
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
52596
|
-
* @version
|
|
53551
|
+
* @version 173.0.0
|
|
52597
53552
|
*/
|
|
52598
53553
|
|
|
52599
53554
|
/**
|
|
@@ -52732,7 +53687,7 @@ class TaskManagementApi {
|
|
|
52732
53687
|
/**
|
|
52733
53688
|
* TaskManagement service.
|
|
52734
53689
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
52735
|
-
* @version
|
|
53690
|
+
* @version 173.0.0
|
|
52736
53691
|
*/
|
|
52737
53692
|
|
|
52738
53693
|
/**
|
|
@@ -54013,7 +54968,7 @@ class TeamsApi {
|
|
|
54013
54968
|
/**
|
|
54014
54969
|
* Teams service.
|
|
54015
54970
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
54016
|
-
* @version
|
|
54971
|
+
* @version 173.0.0
|
|
54017
54972
|
*/
|
|
54018
54973
|
|
|
54019
54974
|
/**
|
|
@@ -54315,7 +55270,7 @@ class TelephonyApi {
|
|
|
54315
55270
|
/**
|
|
54316
55271
|
* Telephony service.
|
|
54317
55272
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
54318
|
-
* @version
|
|
55273
|
+
* @version 173.0.0
|
|
54319
55274
|
*/
|
|
54320
55275
|
|
|
54321
55276
|
/**
|
|
@@ -54443,7 +55398,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
54443
55398
|
/**
|
|
54444
55399
|
* TelephonyProvidersEdge service.
|
|
54445
55400
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
54446
|
-
* @version
|
|
55401
|
+
* @version 173.0.0
|
|
54447
55402
|
*/
|
|
54448
55403
|
|
|
54449
55404
|
/**
|
|
@@ -55899,7 +56854,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
55899
56854
|
/**
|
|
55900
56855
|
* Get the metrics for a list of edges.
|
|
55901
56856
|
*
|
|
55902
|
-
* @param {String} edgeIds Comma separated list of Edge Id's
|
|
56857
|
+
* @param {String} edgeIds Comma separated list of Edge Id's. Maximum of 100 edge ids allowed.
|
|
55903
56858
|
*/
|
|
55904
56859
|
getTelephonyProvidersEdgesMetrics(edgeIds) {
|
|
55905
56860
|
// verify the required parameter 'edgeIds' is set
|
|
@@ -57732,7 +58687,7 @@ class TextbotsApi {
|
|
|
57732
58687
|
/**
|
|
57733
58688
|
* Textbots service.
|
|
57734
58689
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
57735
|
-
* @version
|
|
58690
|
+
* @version 173.0.0
|
|
57736
58691
|
*/
|
|
57737
58692
|
|
|
57738
58693
|
/**
|
|
@@ -57860,7 +58815,7 @@ class TokensApi {
|
|
|
57860
58815
|
/**
|
|
57861
58816
|
* Tokens service.
|
|
57862
58817
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
57863
|
-
* @version
|
|
58818
|
+
* @version 173.0.0
|
|
57864
58819
|
*/
|
|
57865
58820
|
|
|
57866
58821
|
/**
|
|
@@ -58012,7 +58967,7 @@ class UploadsApi {
|
|
|
58012
58967
|
/**
|
|
58013
58968
|
* Uploads service.
|
|
58014
58969
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
58015
|
-
* @version
|
|
58970
|
+
* @version 173.0.0
|
|
58016
58971
|
*/
|
|
58017
58972
|
|
|
58018
58973
|
/**
|
|
@@ -58188,7 +59143,7 @@ class UsageApi {
|
|
|
58188
59143
|
/**
|
|
58189
59144
|
* Usage service.
|
|
58190
59145
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
58191
|
-
* @version
|
|
59146
|
+
* @version 173.0.0
|
|
58192
59147
|
*/
|
|
58193
59148
|
|
|
58194
59149
|
/**
|
|
@@ -58398,7 +59353,7 @@ class UserRecordingsApi {
|
|
|
58398
59353
|
/**
|
|
58399
59354
|
* UserRecordings service.
|
|
58400
59355
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
58401
|
-
* @version
|
|
59356
|
+
* @version 173.0.0
|
|
58402
59357
|
*/
|
|
58403
59358
|
|
|
58404
59359
|
/**
|
|
@@ -58583,7 +59538,7 @@ class UsersApi {
|
|
|
58583
59538
|
/**
|
|
58584
59539
|
* Users service.
|
|
58585
59540
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
58586
|
-
* @version
|
|
59541
|
+
* @version 173.0.0
|
|
58587
59542
|
*/
|
|
58588
59543
|
|
|
58589
59544
|
/**
|
|
@@ -61144,7 +62099,7 @@ class UtilitiesApi {
|
|
|
61144
62099
|
/**
|
|
61145
62100
|
* Utilities service.
|
|
61146
62101
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
61147
|
-
* @version
|
|
62102
|
+
* @version 173.0.0
|
|
61148
62103
|
*/
|
|
61149
62104
|
|
|
61150
62105
|
/**
|
|
@@ -61255,7 +62210,7 @@ class VoicemailApi {
|
|
|
61255
62210
|
/**
|
|
61256
62211
|
* Voicemail service.
|
|
61257
62212
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
61258
|
-
* @version
|
|
62213
|
+
* @version 173.0.0
|
|
61259
62214
|
*/
|
|
61260
62215
|
|
|
61261
62216
|
/**
|
|
@@ -61922,7 +62877,7 @@ class WebChatApi {
|
|
|
61922
62877
|
/**
|
|
61923
62878
|
* WebChat service.
|
|
61924
62879
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
61925
|
-
* @version
|
|
62880
|
+
* @version 173.0.0
|
|
61926
62881
|
*/
|
|
61927
62882
|
|
|
61928
62883
|
/**
|
|
@@ -62471,7 +63426,7 @@ class WebDeploymentsApi {
|
|
|
62471
63426
|
/**
|
|
62472
63427
|
* WebDeployments service.
|
|
62473
63428
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
62474
|
-
* @version
|
|
63429
|
+
* @version 173.0.0
|
|
62475
63430
|
*/
|
|
62476
63431
|
|
|
62477
63432
|
/**
|
|
@@ -62993,7 +63948,7 @@ class WebMessagingApi {
|
|
|
62993
63948
|
/**
|
|
62994
63949
|
* WebMessaging service.
|
|
62995
63950
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
62996
|
-
* @version
|
|
63951
|
+
* @version 173.0.0
|
|
62997
63952
|
*/
|
|
62998
63953
|
|
|
62999
63954
|
/**
|
|
@@ -63039,7 +63994,7 @@ class WidgetsApi {
|
|
|
63039
63994
|
/**
|
|
63040
63995
|
* Widgets service.
|
|
63041
63996
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
63042
|
-
* @version
|
|
63997
|
+
* @version 173.0.0
|
|
63043
63998
|
*/
|
|
63044
63999
|
|
|
63045
64000
|
/**
|
|
@@ -63185,7 +64140,7 @@ class WorkforceManagementApi {
|
|
|
63185
64140
|
/**
|
|
63186
64141
|
* WorkforceManagement service.
|
|
63187
64142
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
63188
|
-
* @version
|
|
64143
|
+
* @version 173.0.0
|
|
63189
64144
|
*/
|
|
63190
64145
|
|
|
63191
64146
|
/**
|
|
@@ -63924,8 +64879,8 @@ class WorkforceManagementApi {
|
|
|
63924
64879
|
*
|
|
63925
64880
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
63926
64881
|
* @param {Object} opts Optional parameters
|
|
63927
|
-
* @param {Object} opts.feature
|
|
63928
|
-
* @param {String} opts.divisionId
|
|
64882
|
+
* @param {Object} opts.feature If specified, the list of management units for which the user is authorized to use the requested feature will be returned
|
|
64883
|
+
* @param {String} opts.divisionId If specified, the list of management units belonging to the specified division will be returned
|
|
63929
64884
|
*/
|
|
63930
64885
|
getWorkforcemanagementBusinessunitManagementunits(businessUnitId, opts) {
|
|
63931
64886
|
opts = opts || {};
|
|
@@ -64564,8 +65519,8 @@ class WorkforceManagementApi {
|
|
|
64564
65519
|
* Get business units
|
|
64565
65520
|
*
|
|
64566
65521
|
* @param {Object} opts Optional parameters
|
|
64567
|
-
* @param {Object} opts.feature
|
|
64568
|
-
* @param {String} opts.divisionId
|
|
65522
|
+
* @param {Object} opts.feature If specified, the list of business units for which the user is authorized to use the requested feature will be returned
|
|
65523
|
+
* @param {String} opts.divisionId If specified, the list of business units belonging to the specified division will be returned
|
|
64569
65524
|
*/
|
|
64570
65525
|
getWorkforcemanagementBusinessunits(opts) {
|
|
64571
65526
|
opts = opts || {};
|
|
@@ -65372,8 +66327,8 @@ class WorkforceManagementApi {
|
|
|
65372
66327
|
* @param {Number} opts.pageSize Deprecated, paging is not supported
|
|
65373
66328
|
* @param {Number} opts.pageNumber Deprecated, paging is not supported
|
|
65374
66329
|
* @param {Object} opts.expand Deprecated, expand settings on the single MU route
|
|
65375
|
-
* @param {Object} opts.feature
|
|
65376
|
-
* @param {String} opts.divisionId
|
|
66330
|
+
* @param {Object} opts.feature If specified, the list of management units for which the user is authorized to use the requested feature will be returned
|
|
66331
|
+
* @param {String} opts.divisionId If specified, the list of management units belonging to the specified division will be returned
|
|
65377
66332
|
*/
|
|
65378
66333
|
getWorkforcemanagementManagementunits(opts) {
|
|
65379
66334
|
opts = opts || {};
|
|
@@ -67992,7 +68947,7 @@ class WorkforceManagementApi {
|
|
|
67992
68947
|
* </pre>
|
|
67993
68948
|
* </p>
|
|
67994
68949
|
* @module purecloud-platform-client-v2/index
|
|
67995
|
-
* @version
|
|
68950
|
+
* @version 173.0.0
|
|
67996
68951
|
*/
|
|
67997
68952
|
class platformClient {
|
|
67998
68953
|
constructor() {
|
|
@@ -68071,6 +69026,11 @@ class platformClient {
|
|
|
68071
69026
|
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|
|
68072
69027
|
*/
|
|
68073
69028
|
this.DownloadsApi = DownloadsApi;
|
|
69029
|
+
/**
|
|
69030
|
+
* The EmailsApi service constructor.
|
|
69031
|
+
* @property {module:purecloud-platform-client-v2/api/EmailsApi}
|
|
69032
|
+
*/
|
|
69033
|
+
this.EmailsApi = EmailsApi;
|
|
68074
69034
|
/**
|
|
68075
69035
|
* The EventsApi service constructor.
|
|
68076
69036
|
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|
|
@@ -68251,6 +69211,11 @@ class platformClient {
|
|
|
68251
69211
|
* @property {module:purecloud-platform-client-v2/api/SearchApi}
|
|
68252
69212
|
*/
|
|
68253
69213
|
this.SearchApi = SearchApi;
|
|
69214
|
+
/**
|
|
69215
|
+
* The SettingsApi service constructor.
|
|
69216
|
+
* @property {module:purecloud-platform-client-v2/api/SettingsApi}
|
|
69217
|
+
*/
|
|
69218
|
+
this.SettingsApi = SettingsApi;
|
|
68254
69219
|
/**
|
|
68255
69220
|
* The SpeechTextAnalyticsApi service constructor.
|
|
68256
69221
|
* @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}
|