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
|
@@ -9336,7 +9336,7 @@ class Configuration {
|
|
|
9336
9336
|
|
|
9337
9337
|
/**
|
|
9338
9338
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9339
|
-
* @version
|
|
9339
|
+
* @version 173.0.0
|
|
9340
9340
|
*/
|
|
9341
9341
|
class ApiClient {
|
|
9342
9342
|
/**
|
|
@@ -10415,7 +10415,7 @@ class AlertingApi {
|
|
|
10415
10415
|
/**
|
|
10416
10416
|
* Alerting service.
|
|
10417
10417
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10418
|
-
* @version
|
|
10418
|
+
* @version 173.0.0
|
|
10419
10419
|
*/
|
|
10420
10420
|
|
|
10421
10421
|
/**
|
|
@@ -10430,6 +10430,31 @@ class AlertingApi {
|
|
|
10430
10430
|
}
|
|
10431
10431
|
|
|
10432
10432
|
|
|
10433
|
+
/**
|
|
10434
|
+
* Delete an alert
|
|
10435
|
+
*
|
|
10436
|
+
* @param {String} alertId Alert ID
|
|
10437
|
+
*/
|
|
10438
|
+
deleteAlertingAlert(alertId) {
|
|
10439
|
+
// verify the required parameter 'alertId' is set
|
|
10440
|
+
if (alertId === undefined || alertId === null) {
|
|
10441
|
+
throw 'Missing the required parameter "alertId" when calling deleteAlertingAlert';
|
|
10442
|
+
}
|
|
10443
|
+
|
|
10444
|
+
return this.apiClient.callApi(
|
|
10445
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
10446
|
+
'DELETE',
|
|
10447
|
+
{ 'alertId': alertId },
|
|
10448
|
+
{ },
|
|
10449
|
+
{ },
|
|
10450
|
+
{ },
|
|
10451
|
+
null,
|
|
10452
|
+
['PureCloud OAuth'],
|
|
10453
|
+
['application/json'],
|
|
10454
|
+
['application/json']
|
|
10455
|
+
);
|
|
10456
|
+
}
|
|
10457
|
+
|
|
10433
10458
|
/**
|
|
10434
10459
|
* Delete an interaction stats alert
|
|
10435
10460
|
*
|
|
@@ -10480,6 +10505,56 @@ class AlertingApi {
|
|
|
10480
10505
|
);
|
|
10481
10506
|
}
|
|
10482
10507
|
|
|
10508
|
+
/**
|
|
10509
|
+
* Delete a rule.
|
|
10510
|
+
*
|
|
10511
|
+
* @param {String} ruleId Rule Id
|
|
10512
|
+
*/
|
|
10513
|
+
deleteAlertingRule(ruleId) {
|
|
10514
|
+
// verify the required parameter 'ruleId' is set
|
|
10515
|
+
if (ruleId === undefined || ruleId === null) {
|
|
10516
|
+
throw 'Missing the required parameter "ruleId" when calling deleteAlertingRule';
|
|
10517
|
+
}
|
|
10518
|
+
|
|
10519
|
+
return this.apiClient.callApi(
|
|
10520
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
10521
|
+
'DELETE',
|
|
10522
|
+
{ 'ruleId': ruleId },
|
|
10523
|
+
{ },
|
|
10524
|
+
{ },
|
|
10525
|
+
{ },
|
|
10526
|
+
null,
|
|
10527
|
+
['PureCloud OAuth'],
|
|
10528
|
+
['application/json'],
|
|
10529
|
+
['application/json']
|
|
10530
|
+
);
|
|
10531
|
+
}
|
|
10532
|
+
|
|
10533
|
+
/**
|
|
10534
|
+
* Get an alert
|
|
10535
|
+
*
|
|
10536
|
+
* @param {String} alertId Alert ID
|
|
10537
|
+
*/
|
|
10538
|
+
getAlertingAlert(alertId) {
|
|
10539
|
+
// verify the required parameter 'alertId' is set
|
|
10540
|
+
if (alertId === undefined || alertId === null) {
|
|
10541
|
+
throw 'Missing the required parameter "alertId" when calling getAlertingAlert';
|
|
10542
|
+
}
|
|
10543
|
+
|
|
10544
|
+
return this.apiClient.callApi(
|
|
10545
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
10546
|
+
'GET',
|
|
10547
|
+
{ 'alertId': alertId },
|
|
10548
|
+
{ },
|
|
10549
|
+
{ },
|
|
10550
|
+
{ },
|
|
10551
|
+
null,
|
|
10552
|
+
['PureCloud OAuth'],
|
|
10553
|
+
['application/json'],
|
|
10554
|
+
['application/json']
|
|
10555
|
+
);
|
|
10556
|
+
}
|
|
10557
|
+
|
|
10483
10558
|
/**
|
|
10484
10559
|
* Gets active alert count for a user.
|
|
10485
10560
|
*
|
|
@@ -10626,6 +10701,134 @@ class AlertingApi {
|
|
|
10626
10701
|
);
|
|
10627
10702
|
}
|
|
10628
10703
|
|
|
10704
|
+
/**
|
|
10705
|
+
* Get a rule.
|
|
10706
|
+
*
|
|
10707
|
+
* @param {String} ruleId Rule Id
|
|
10708
|
+
*/
|
|
10709
|
+
getAlertingRule(ruleId) {
|
|
10710
|
+
// verify the required parameter 'ruleId' is set
|
|
10711
|
+
if (ruleId === undefined || ruleId === null) {
|
|
10712
|
+
throw 'Missing the required parameter "ruleId" when calling getAlertingRule';
|
|
10713
|
+
}
|
|
10714
|
+
|
|
10715
|
+
return this.apiClient.callApi(
|
|
10716
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
10717
|
+
'GET',
|
|
10718
|
+
{ 'ruleId': ruleId },
|
|
10719
|
+
{ },
|
|
10720
|
+
{ },
|
|
10721
|
+
{ },
|
|
10722
|
+
null,
|
|
10723
|
+
['PureCloud OAuth'],
|
|
10724
|
+
['application/json'],
|
|
10725
|
+
['application/json']
|
|
10726
|
+
);
|
|
10727
|
+
}
|
|
10728
|
+
|
|
10729
|
+
/**
|
|
10730
|
+
* Allows an entity to mute/snooze an alert or update the unread status of the alert.
|
|
10731
|
+
* 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.
|
|
10732
|
+
* @param {String} alertId Alert ID
|
|
10733
|
+
* @param {Object} opts Optional parameters
|
|
10734
|
+
* @param {Object} opts.body
|
|
10735
|
+
*/
|
|
10736
|
+
patchAlertingAlert(alertId, opts) {
|
|
10737
|
+
opts = opts || {};
|
|
10738
|
+
|
|
10739
|
+
// verify the required parameter 'alertId' is set
|
|
10740
|
+
if (alertId === undefined || alertId === null) {
|
|
10741
|
+
throw 'Missing the required parameter "alertId" when calling patchAlertingAlert';
|
|
10742
|
+
}
|
|
10743
|
+
|
|
10744
|
+
return this.apiClient.callApi(
|
|
10745
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
10746
|
+
'PATCH',
|
|
10747
|
+
{ 'alertId': alertId },
|
|
10748
|
+
{ },
|
|
10749
|
+
{ },
|
|
10750
|
+
{ },
|
|
10751
|
+
opts['body'],
|
|
10752
|
+
['PureCloud OAuth'],
|
|
10753
|
+
['application/json'],
|
|
10754
|
+
['application/json']
|
|
10755
|
+
);
|
|
10756
|
+
}
|
|
10757
|
+
|
|
10758
|
+
/**
|
|
10759
|
+
* Bulk alert updates
|
|
10760
|
+
*
|
|
10761
|
+
* @param {Object} body
|
|
10762
|
+
*/
|
|
10763
|
+
patchAlertingAlertsBulk(body) {
|
|
10764
|
+
// verify the required parameter 'body' is set
|
|
10765
|
+
if (body === undefined || body === null) {
|
|
10766
|
+
throw 'Missing the required parameter "body" when calling patchAlertingAlertsBulk';
|
|
10767
|
+
}
|
|
10768
|
+
|
|
10769
|
+
return this.apiClient.callApi(
|
|
10770
|
+
'/api/v2/alerting/alerts/bulk',
|
|
10771
|
+
'PATCH',
|
|
10772
|
+
{ },
|
|
10773
|
+
{ },
|
|
10774
|
+
{ },
|
|
10775
|
+
{ },
|
|
10776
|
+
body,
|
|
10777
|
+
['PureCloud OAuth'],
|
|
10778
|
+
['application/json'],
|
|
10779
|
+
['application/json']
|
|
10780
|
+
);
|
|
10781
|
+
}
|
|
10782
|
+
|
|
10783
|
+
/**
|
|
10784
|
+
* Bulk update of notification lists
|
|
10785
|
+
*
|
|
10786
|
+
* @param {Object} body
|
|
10787
|
+
*/
|
|
10788
|
+
patchAlertingRulesBulk(body) {
|
|
10789
|
+
// verify the required parameter 'body' is set
|
|
10790
|
+
if (body === undefined || body === null) {
|
|
10791
|
+
throw 'Missing the required parameter "body" when calling patchAlertingRulesBulk';
|
|
10792
|
+
}
|
|
10793
|
+
|
|
10794
|
+
return this.apiClient.callApi(
|
|
10795
|
+
'/api/v2/alerting/rules/bulk',
|
|
10796
|
+
'PATCH',
|
|
10797
|
+
{ },
|
|
10798
|
+
{ },
|
|
10799
|
+
{ },
|
|
10800
|
+
{ },
|
|
10801
|
+
body,
|
|
10802
|
+
['PureCloud OAuth'],
|
|
10803
|
+
['application/json'],
|
|
10804
|
+
['application/json']
|
|
10805
|
+
);
|
|
10806
|
+
}
|
|
10807
|
+
|
|
10808
|
+
/**
|
|
10809
|
+
* Gets a paged list of alerts. The max page size is 50
|
|
10810
|
+
*
|
|
10811
|
+
* @param {Object} opts Optional parameters
|
|
10812
|
+
* @param {Object} opts.body
|
|
10813
|
+
*/
|
|
10814
|
+
postAlertingAlertsQuery(opts) {
|
|
10815
|
+
opts = opts || {};
|
|
10816
|
+
|
|
10817
|
+
|
|
10818
|
+
return this.apiClient.callApi(
|
|
10819
|
+
'/api/v2/alerting/alerts/query',
|
|
10820
|
+
'POST',
|
|
10821
|
+
{ },
|
|
10822
|
+
{ },
|
|
10823
|
+
{ },
|
|
10824
|
+
{ },
|
|
10825
|
+
opts['body'],
|
|
10826
|
+
['PureCloud OAuth'],
|
|
10827
|
+
['application/json'],
|
|
10828
|
+
['application/json']
|
|
10829
|
+
);
|
|
10830
|
+
}
|
|
10831
|
+
|
|
10629
10832
|
/**
|
|
10630
10833
|
* Create an interaction stats rule.
|
|
10631
10834
|
*
|
|
@@ -10655,6 +10858,109 @@ class AlertingApi {
|
|
|
10655
10858
|
);
|
|
10656
10859
|
}
|
|
10657
10860
|
|
|
10861
|
+
/**
|
|
10862
|
+
* Create a Rule.
|
|
10863
|
+
*
|
|
10864
|
+
* @param {Object} body rule to be created
|
|
10865
|
+
*/
|
|
10866
|
+
postAlertingRules(body) {
|
|
10867
|
+
// verify the required parameter 'body' is set
|
|
10868
|
+
if (body === undefined || body === null) {
|
|
10869
|
+
throw 'Missing the required parameter "body" when calling postAlertingRules';
|
|
10870
|
+
}
|
|
10871
|
+
|
|
10872
|
+
return this.apiClient.callApi(
|
|
10873
|
+
'/api/v2/alerting/rules',
|
|
10874
|
+
'POST',
|
|
10875
|
+
{ },
|
|
10876
|
+
{ },
|
|
10877
|
+
{ },
|
|
10878
|
+
{ },
|
|
10879
|
+
body,
|
|
10880
|
+
['PureCloud OAuth'],
|
|
10881
|
+
['application/json'],
|
|
10882
|
+
['application/json']
|
|
10883
|
+
);
|
|
10884
|
+
}
|
|
10885
|
+
|
|
10886
|
+
/**
|
|
10887
|
+
* Bulk remove rules
|
|
10888
|
+
*
|
|
10889
|
+
* @param {Object} body
|
|
10890
|
+
*/
|
|
10891
|
+
postAlertingRulesBulkRemove(body) {
|
|
10892
|
+
// verify the required parameter 'body' is set
|
|
10893
|
+
if (body === undefined || body === null) {
|
|
10894
|
+
throw 'Missing the required parameter "body" when calling postAlertingRulesBulkRemove';
|
|
10895
|
+
}
|
|
10896
|
+
|
|
10897
|
+
return this.apiClient.callApi(
|
|
10898
|
+
'/api/v2/alerting/rules/bulk/remove',
|
|
10899
|
+
'POST',
|
|
10900
|
+
{ },
|
|
10901
|
+
{ },
|
|
10902
|
+
{ },
|
|
10903
|
+
{ },
|
|
10904
|
+
body,
|
|
10905
|
+
['PureCloud OAuth'],
|
|
10906
|
+
['application/json'],
|
|
10907
|
+
['application/json']
|
|
10908
|
+
);
|
|
10909
|
+
}
|
|
10910
|
+
|
|
10911
|
+
/**
|
|
10912
|
+
* Get a paged list of rules. The max size of the page is 50 items.
|
|
10913
|
+
*
|
|
10914
|
+
* @param {Object} opts Optional parameters
|
|
10915
|
+
* @param {Object} opts.body
|
|
10916
|
+
*/
|
|
10917
|
+
postAlertingRulesQuery(opts) {
|
|
10918
|
+
opts = opts || {};
|
|
10919
|
+
|
|
10920
|
+
|
|
10921
|
+
return this.apiClient.callApi(
|
|
10922
|
+
'/api/v2/alerting/rules/query',
|
|
10923
|
+
'POST',
|
|
10924
|
+
{ },
|
|
10925
|
+
{ },
|
|
10926
|
+
{ },
|
|
10927
|
+
{ },
|
|
10928
|
+
opts['body'],
|
|
10929
|
+
['PureCloud OAuth'],
|
|
10930
|
+
['application/json'],
|
|
10931
|
+
['application/json']
|
|
10932
|
+
);
|
|
10933
|
+
}
|
|
10934
|
+
|
|
10935
|
+
/**
|
|
10936
|
+
* Update an alert read status
|
|
10937
|
+
*
|
|
10938
|
+
* @param {String} alertId Alert ID
|
|
10939
|
+
* @param {Object} opts Optional parameters
|
|
10940
|
+
* @param {Object} opts.body
|
|
10941
|
+
*/
|
|
10942
|
+
putAlertingAlert(alertId, opts) {
|
|
10943
|
+
opts = opts || {};
|
|
10944
|
+
|
|
10945
|
+
// verify the required parameter 'alertId' is set
|
|
10946
|
+
if (alertId === undefined || alertId === null) {
|
|
10947
|
+
throw 'Missing the required parameter "alertId" when calling putAlertingAlert';
|
|
10948
|
+
}
|
|
10949
|
+
|
|
10950
|
+
return this.apiClient.callApi(
|
|
10951
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
10952
|
+
'PUT',
|
|
10953
|
+
{ 'alertId': alertId },
|
|
10954
|
+
{ },
|
|
10955
|
+
{ },
|
|
10956
|
+
{ },
|
|
10957
|
+
opts['body'],
|
|
10958
|
+
['PureCloud OAuth'],
|
|
10959
|
+
['application/json'],
|
|
10960
|
+
['application/json']
|
|
10961
|
+
);
|
|
10962
|
+
}
|
|
10963
|
+
|
|
10658
10964
|
/**
|
|
10659
10965
|
* Update an interaction stats alert read status
|
|
10660
10966
|
*
|
|
@@ -10723,13 +11029,43 @@ class AlertingApi {
|
|
|
10723
11029
|
);
|
|
10724
11030
|
}
|
|
10725
11031
|
|
|
11032
|
+
/**
|
|
11033
|
+
* Update a rule
|
|
11034
|
+
*
|
|
11035
|
+
* @param {String} ruleId Rule Id
|
|
11036
|
+
* @param {Object} body rule to be updated
|
|
11037
|
+
*/
|
|
11038
|
+
putAlertingRule(ruleId, body) {
|
|
11039
|
+
// verify the required parameter 'ruleId' is set
|
|
11040
|
+
if (ruleId === undefined || ruleId === null) {
|
|
11041
|
+
throw 'Missing the required parameter "ruleId" when calling putAlertingRule';
|
|
11042
|
+
}
|
|
11043
|
+
// verify the required parameter 'body' is set
|
|
11044
|
+
if (body === undefined || body === null) {
|
|
11045
|
+
throw 'Missing the required parameter "body" when calling putAlertingRule';
|
|
11046
|
+
}
|
|
11047
|
+
|
|
11048
|
+
return this.apiClient.callApi(
|
|
11049
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
11050
|
+
'PUT',
|
|
11051
|
+
{ 'ruleId': ruleId },
|
|
11052
|
+
{ },
|
|
11053
|
+
{ },
|
|
11054
|
+
{ },
|
|
11055
|
+
body,
|
|
11056
|
+
['PureCloud OAuth'],
|
|
11057
|
+
['application/json'],
|
|
11058
|
+
['application/json']
|
|
11059
|
+
);
|
|
11060
|
+
}
|
|
11061
|
+
|
|
10726
11062
|
}
|
|
10727
11063
|
|
|
10728
11064
|
class AnalyticsApi {
|
|
10729
11065
|
/**
|
|
10730
11066
|
* Analytics service.
|
|
10731
11067
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
10732
|
-
* @version
|
|
11068
|
+
* @version 173.0.0
|
|
10733
11069
|
*/
|
|
10734
11070
|
|
|
10735
11071
|
/**
|
|
@@ -13174,7 +13510,7 @@ class ArchitectApi {
|
|
|
13174
13510
|
/**
|
|
13175
13511
|
* Architect service.
|
|
13176
13512
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
13177
|
-
* @version
|
|
13513
|
+
* @version 173.0.0
|
|
13178
13514
|
*/
|
|
13179
13515
|
|
|
13180
13516
|
/**
|
|
@@ -16363,7 +16699,7 @@ class AuditApi {
|
|
|
16363
16699
|
/**
|
|
16364
16700
|
* Audit service.
|
|
16365
16701
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
16366
|
-
* @version
|
|
16702
|
+
* @version 173.0.0
|
|
16367
16703
|
*/
|
|
16368
16704
|
|
|
16369
16705
|
/**
|
|
@@ -16534,7 +16870,7 @@ class AuthorizationApi {
|
|
|
16534
16870
|
/**
|
|
16535
16871
|
* Authorization service.
|
|
16536
16872
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
16537
|
-
* @version
|
|
16873
|
+
* @version 173.0.0
|
|
16538
16874
|
*/
|
|
16539
16875
|
|
|
16540
16876
|
/**
|
|
@@ -17765,7 +18101,7 @@ class BillingApi {
|
|
|
17765
18101
|
/**
|
|
17766
18102
|
* Billing service.
|
|
17767
18103
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
17768
|
-
* @version
|
|
18104
|
+
* @version 173.0.0
|
|
17769
18105
|
*/
|
|
17770
18106
|
|
|
17771
18107
|
/**
|
|
@@ -17845,7 +18181,7 @@ class CarrierServicesApi {
|
|
|
17845
18181
|
/**
|
|
17846
18182
|
* CarrierServices service.
|
|
17847
18183
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17848
|
-
* @version
|
|
18184
|
+
* @version 173.0.0
|
|
17849
18185
|
*/
|
|
17850
18186
|
|
|
17851
18187
|
/**
|
|
@@ -17915,7 +18251,7 @@ class ChatApi {
|
|
|
17915
18251
|
/**
|
|
17916
18252
|
* Chat service.
|
|
17917
18253
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
17918
|
-
* @version
|
|
18254
|
+
* @version 173.0.0
|
|
17919
18255
|
*/
|
|
17920
18256
|
|
|
17921
18257
|
/**
|
|
@@ -18079,7 +18415,7 @@ class CoachingApi {
|
|
|
18079
18415
|
/**
|
|
18080
18416
|
* Coaching service.
|
|
18081
18417
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
18082
|
-
* @version
|
|
18418
|
+
* @version 173.0.0
|
|
18083
18419
|
*/
|
|
18084
18420
|
|
|
18085
18421
|
/**
|
|
@@ -18656,7 +18992,7 @@ class ContentManagementApi {
|
|
|
18656
18992
|
/**
|
|
18657
18993
|
* ContentManagement service.
|
|
18658
18994
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
18659
|
-
* @version
|
|
18995
|
+
* @version 173.0.0
|
|
18660
18996
|
*/
|
|
18661
18997
|
|
|
18662
18998
|
/**
|
|
@@ -19799,7 +20135,7 @@ class ConversationsApi {
|
|
|
19799
20135
|
/**
|
|
19800
20136
|
* Conversations service.
|
|
19801
20137
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
19802
|
-
* @version
|
|
20138
|
+
* @version 173.0.0
|
|
19803
20139
|
*/
|
|
19804
20140
|
|
|
19805
20141
|
/**
|
|
@@ -20114,6 +20450,51 @@ class ConversationsApi {
|
|
|
20114
20450
|
);
|
|
20115
20451
|
}
|
|
20116
20452
|
|
|
20453
|
+
/**
|
|
20454
|
+
* Delete a messaging setting
|
|
20455
|
+
*
|
|
20456
|
+
* @param {String} messageSettingId Message Setting ID
|
|
20457
|
+
*/
|
|
20458
|
+
deleteConversationsMessagingSetting(messageSettingId) {
|
|
20459
|
+
// verify the required parameter 'messageSettingId' is set
|
|
20460
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
20461
|
+
throw 'Missing the required parameter "messageSettingId" when calling deleteConversationsMessagingSetting';
|
|
20462
|
+
}
|
|
20463
|
+
|
|
20464
|
+
return this.apiClient.callApi(
|
|
20465
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
20466
|
+
'DELETE',
|
|
20467
|
+
{ 'messageSettingId': messageSettingId },
|
|
20468
|
+
{ },
|
|
20469
|
+
{ },
|
|
20470
|
+
{ },
|
|
20471
|
+
null,
|
|
20472
|
+
['PureCloud OAuth'],
|
|
20473
|
+
['application/json'],
|
|
20474
|
+
['application/json']
|
|
20475
|
+
);
|
|
20476
|
+
}
|
|
20477
|
+
|
|
20478
|
+
/**
|
|
20479
|
+
* Delete the organization's default setting, a global default will be applied to integrations without settings
|
|
20480
|
+
* 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.
|
|
20481
|
+
*/
|
|
20482
|
+
deleteConversationsMessagingSettingsDefault() {
|
|
20483
|
+
|
|
20484
|
+
return this.apiClient.callApi(
|
|
20485
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
20486
|
+
'DELETE',
|
|
20487
|
+
{ },
|
|
20488
|
+
{ },
|
|
20489
|
+
{ },
|
|
20490
|
+
{ },
|
|
20491
|
+
null,
|
|
20492
|
+
['PureCloud OAuth'],
|
|
20493
|
+
['application/json'],
|
|
20494
|
+
['application/json']
|
|
20495
|
+
);
|
|
20496
|
+
}
|
|
20497
|
+
|
|
20117
20498
|
/**
|
|
20118
20499
|
* Delete a supported content profile
|
|
20119
20500
|
*
|
|
@@ -22157,6 +22538,76 @@ class ConversationsApi {
|
|
|
22157
22538
|
);
|
|
22158
22539
|
}
|
|
22159
22540
|
|
|
22541
|
+
/**
|
|
22542
|
+
* Get a messaging setting
|
|
22543
|
+
*
|
|
22544
|
+
* @param {String} messageSettingId Message Setting ID
|
|
22545
|
+
*/
|
|
22546
|
+
getConversationsMessagingSetting(messageSettingId) {
|
|
22547
|
+
// verify the required parameter 'messageSettingId' is set
|
|
22548
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
22549
|
+
throw 'Missing the required parameter "messageSettingId" when calling getConversationsMessagingSetting';
|
|
22550
|
+
}
|
|
22551
|
+
|
|
22552
|
+
return this.apiClient.callApi(
|
|
22553
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
22554
|
+
'GET',
|
|
22555
|
+
{ 'messageSettingId': messageSettingId },
|
|
22556
|
+
{ },
|
|
22557
|
+
{ },
|
|
22558
|
+
{ },
|
|
22559
|
+
null,
|
|
22560
|
+
['PureCloud OAuth'],
|
|
22561
|
+
['application/json'],
|
|
22562
|
+
['application/json']
|
|
22563
|
+
);
|
|
22564
|
+
}
|
|
22565
|
+
|
|
22566
|
+
/**
|
|
22567
|
+
* Get a list of messaging settings
|
|
22568
|
+
*
|
|
22569
|
+
* @param {Object} opts Optional parameters
|
|
22570
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
22571
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
22572
|
+
*/
|
|
22573
|
+
getConversationsMessagingSettings(opts) {
|
|
22574
|
+
opts = opts || {};
|
|
22575
|
+
|
|
22576
|
+
|
|
22577
|
+
return this.apiClient.callApi(
|
|
22578
|
+
'/api/v2/conversations/messaging/settings',
|
|
22579
|
+
'GET',
|
|
22580
|
+
{ },
|
|
22581
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
22582
|
+
{ },
|
|
22583
|
+
{ },
|
|
22584
|
+
null,
|
|
22585
|
+
['PureCloud OAuth'],
|
|
22586
|
+
['application/json'],
|
|
22587
|
+
['application/json']
|
|
22588
|
+
);
|
|
22589
|
+
}
|
|
22590
|
+
|
|
22591
|
+
/**
|
|
22592
|
+
* Get the organization's default settings that will be used as the default when creating an integration.
|
|
22593
|
+
* 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.
|
|
22594
|
+
*/
|
|
22595
|
+
getConversationsMessagingSettingsDefault() {
|
|
22596
|
+
|
|
22597
|
+
return this.apiClient.callApi(
|
|
22598
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
22599
|
+
'GET',
|
|
22600
|
+
{ },
|
|
22601
|
+
{ },
|
|
22602
|
+
{ },
|
|
22603
|
+
{ },
|
|
22604
|
+
null,
|
|
22605
|
+
['PureCloud OAuth'],
|
|
22606
|
+
['application/json'],
|
|
22607
|
+
['application/json']
|
|
22608
|
+
);
|
|
22609
|
+
}
|
|
22610
|
+
|
|
22160
22611
|
/**
|
|
22161
22612
|
* Get a list of Messaging Stickers
|
|
22162
22613
|
*
|
|
@@ -23657,6 +24108,36 @@ class ConversationsApi {
|
|
|
23657
24108
|
);
|
|
23658
24109
|
}
|
|
23659
24110
|
|
|
24111
|
+
/**
|
|
24112
|
+
* Update a messaging setting
|
|
24113
|
+
*
|
|
24114
|
+
* @param {String} messageSettingId Message Setting ID
|
|
24115
|
+
* @param {Object} body MessagingSetting
|
|
24116
|
+
*/
|
|
24117
|
+
patchConversationsMessagingSetting(messageSettingId, body) {
|
|
24118
|
+
// verify the required parameter 'messageSettingId' is set
|
|
24119
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
24120
|
+
throw 'Missing the required parameter "messageSettingId" when calling patchConversationsMessagingSetting';
|
|
24121
|
+
}
|
|
24122
|
+
// verify the required parameter 'body' is set
|
|
24123
|
+
if (body === undefined || body === null) {
|
|
24124
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingSetting';
|
|
24125
|
+
}
|
|
24126
|
+
|
|
24127
|
+
return this.apiClient.callApi(
|
|
24128
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
24129
|
+
'PATCH',
|
|
24130
|
+
{ 'messageSettingId': messageSettingId },
|
|
24131
|
+
{ },
|
|
24132
|
+
{ },
|
|
24133
|
+
{ },
|
|
24134
|
+
body,
|
|
24135
|
+
['PureCloud OAuth'],
|
|
24136
|
+
['application/json'],
|
|
24137
|
+
['application/json']
|
|
24138
|
+
);
|
|
24139
|
+
}
|
|
24140
|
+
|
|
23660
24141
|
/**
|
|
23661
24142
|
* Update a supported content profile
|
|
23662
24143
|
*
|
|
@@ -23904,6 +24385,32 @@ class ConversationsApi {
|
|
|
23904
24385
|
);
|
|
23905
24386
|
}
|
|
23906
24387
|
|
|
24388
|
+
/**
|
|
24389
|
+
* Barge a conversation creating a barged in conference of connected participants.
|
|
24390
|
+
*
|
|
24391
|
+
* @param {String} conversationId conversation ID
|
|
24392
|
+
* postConversationBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24393
|
+
*/
|
|
24394
|
+
postConversationBarge(conversationId) {
|
|
24395
|
+
// verify the required parameter 'conversationId' is set
|
|
24396
|
+
if (conversationId === undefined || conversationId === null) {
|
|
24397
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationBarge';
|
|
24398
|
+
}
|
|
24399
|
+
|
|
24400
|
+
return this.apiClient.callApi(
|
|
24401
|
+
'/api/v2/conversations/{conversationId}/barge',
|
|
24402
|
+
'POST',
|
|
24403
|
+
{ 'conversationId': conversationId },
|
|
24404
|
+
{ },
|
|
24405
|
+
{ },
|
|
24406
|
+
{ },
|
|
24407
|
+
null,
|
|
24408
|
+
['PureCloud OAuth'],
|
|
24409
|
+
['application/json'],
|
|
24410
|
+
['application/json']
|
|
24411
|
+
);
|
|
24412
|
+
}
|
|
24413
|
+
|
|
23907
24414
|
/**
|
|
23908
24415
|
* Creates a cobrowse session. Requires conversation:cobrowse:add (for web messaging) or conversation:cobrowsevoice:add permission.
|
|
23909
24416
|
*
|
|
@@ -24028,7 +24535,6 @@ class ConversationsApi {
|
|
|
24028
24535
|
* @param {String} conversationId conversation ID
|
|
24029
24536
|
* @param {String} participantId participant ID
|
|
24030
24537
|
* @param {Object} body Transfer request
|
|
24031
|
-
* @deprecated
|
|
24032
24538
|
*/
|
|
24033
24539
|
postConversationParticipantReplace(conversationId, participantId, body) {
|
|
24034
24540
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24064,6 +24570,7 @@ class ConversationsApi {
|
|
|
24064
24570
|
* @param {String} conversationId conversation ID
|
|
24065
24571
|
* @param {String} participantId participant ID
|
|
24066
24572
|
* @param {Object} body Transfer request
|
|
24573
|
+
* postConversationParticipantReplaceAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24067
24574
|
*/
|
|
24068
24575
|
postConversationParticipantReplaceAgent(conversationId, participantId, body) {
|
|
24069
24576
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24099,6 +24606,7 @@ class ConversationsApi {
|
|
|
24099
24606
|
* @param {String} conversationId conversation ID
|
|
24100
24607
|
* @param {String} participantId participant ID
|
|
24101
24608
|
* @param {Object} body Transfer request
|
|
24609
|
+
* postConversationParticipantReplaceExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24102
24610
|
*/
|
|
24103
24611
|
postConversationParticipantReplaceExternal(conversationId, participantId, body) {
|
|
24104
24612
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24134,6 +24642,7 @@ class ConversationsApi {
|
|
|
24134
24642
|
* @param {String} conversationId conversation ID
|
|
24135
24643
|
* @param {String} participantId participant ID
|
|
24136
24644
|
* @param {Object} body Transfer request
|
|
24645
|
+
* postConversationParticipantReplaceQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24137
24646
|
*/
|
|
24138
24647
|
postConversationParticipantReplaceQueue(conversationId, participantId, body) {
|
|
24139
24648
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24227,6 +24736,37 @@ class ConversationsApi {
|
|
|
24227
24736
|
);
|
|
24228
24737
|
}
|
|
24229
24738
|
|
|
24739
|
+
/**
|
|
24740
|
+
* Barge a given participant's call creating a barged in conference of connected participants.
|
|
24741
|
+
*
|
|
24742
|
+
* @param {String} conversationId conversationId
|
|
24743
|
+
* @param {String} participantId participantId
|
|
24744
|
+
* postConversationsCallParticipantBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24745
|
+
*/
|
|
24746
|
+
postConversationsCallParticipantBarge(conversationId, participantId) {
|
|
24747
|
+
// verify the required parameter 'conversationId' is set
|
|
24748
|
+
if (conversationId === undefined || conversationId === null) {
|
|
24749
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantBarge';
|
|
24750
|
+
}
|
|
24751
|
+
// verify the required parameter 'participantId' is set
|
|
24752
|
+
if (participantId === undefined || participantId === null) {
|
|
24753
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantBarge';
|
|
24754
|
+
}
|
|
24755
|
+
|
|
24756
|
+
return this.apiClient.callApi(
|
|
24757
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge',
|
|
24758
|
+
'POST',
|
|
24759
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
24760
|
+
{ },
|
|
24761
|
+
{ },
|
|
24762
|
+
{ },
|
|
24763
|
+
null,
|
|
24764
|
+
['PureCloud OAuth'],
|
|
24765
|
+
['application/json'],
|
|
24766
|
+
['application/json']
|
|
24767
|
+
);
|
|
24768
|
+
}
|
|
24769
|
+
|
|
24230
24770
|
/**
|
|
24231
24771
|
* Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
|
|
24232
24772
|
*
|
|
@@ -24302,7 +24842,6 @@ class ConversationsApi {
|
|
|
24302
24842
|
* @param {String} conversationId conversationId
|
|
24303
24843
|
* @param {String} participantId participantId
|
|
24304
24844
|
* @param {Object} body Destination address and initial speak to
|
|
24305
|
-
* @deprecated
|
|
24306
24845
|
*/
|
|
24307
24846
|
postConversationsCallParticipantConsult(conversationId, participantId, body) {
|
|
24308
24847
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24338,6 +24877,7 @@ class ConversationsApi {
|
|
|
24338
24877
|
* @param {String} conversationId conversationId
|
|
24339
24878
|
* @param {String} participantId participantId
|
|
24340
24879
|
* @param {Object} body Destination agent and initial speak to
|
|
24880
|
+
* postConversationsCallParticipantConsultAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24341
24881
|
*/
|
|
24342
24882
|
postConversationsCallParticipantConsultAgent(conversationId, participantId, body) {
|
|
24343
24883
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24373,6 +24913,7 @@ class ConversationsApi {
|
|
|
24373
24913
|
* @param {String} conversationId conversationId
|
|
24374
24914
|
* @param {String} participantId participantId
|
|
24375
24915
|
* @param {Object} body Destination address and initial speak to
|
|
24916
|
+
* postConversationsCallParticipantConsultExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24376
24917
|
*/
|
|
24377
24918
|
postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
|
|
24378
24919
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24408,6 +24949,7 @@ class ConversationsApi {
|
|
|
24408
24949
|
* @param {String} conversationId conversationId
|
|
24409
24950
|
* @param {String} participantId participantId
|
|
24410
24951
|
* @param {Object} body Destination queue and initial speak to
|
|
24952
|
+
* postConversationsCallParticipantConsultQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24411
24953
|
*/
|
|
24412
24954
|
postConversationsCallParticipantConsultQueue(conversationId, participantId, body) {
|
|
24413
24955
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24473,7 +25015,6 @@ class ConversationsApi {
|
|
|
24473
25015
|
* @param {String} conversationId conversationId
|
|
24474
25016
|
* @param {String} participantId participantId
|
|
24475
25017
|
* @param {Object} body Transfer request
|
|
24476
|
-
* @deprecated
|
|
24477
25018
|
*/
|
|
24478
25019
|
postConversationsCallParticipantReplace(conversationId, participantId, body) {
|
|
24479
25020
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24578,7 +25119,6 @@ class ConversationsApi {
|
|
|
24578
25119
|
* @param {String} conversationId conversationId
|
|
24579
25120
|
* @param {String} participantId participantId
|
|
24580
25121
|
* @param {Object} body Transfer request
|
|
24581
|
-
* @deprecated
|
|
24582
25122
|
*/
|
|
24583
25123
|
postConversationsCallbackParticipantReplace(conversationId, participantId, body) {
|
|
24584
25124
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24818,7 +25358,6 @@ class ConversationsApi {
|
|
|
24818
25358
|
* @param {String} conversationId conversationId
|
|
24819
25359
|
* @param {String} participantId participantId
|
|
24820
25360
|
* @param {Object} body Transfer request
|
|
24821
|
-
* @deprecated
|
|
24822
25361
|
*/
|
|
24823
25362
|
postConversationsChatParticipantReplace(conversationId, participantId, body) {
|
|
24824
25363
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24919,7 +25458,6 @@ class ConversationsApi {
|
|
|
24919
25458
|
* @param {String} participantId participantId
|
|
24920
25459
|
* @param {Object} opts Optional parameters
|
|
24921
25460
|
* @param {Object} opts.body
|
|
24922
|
-
* @deprecated
|
|
24923
25461
|
*/
|
|
24924
25462
|
postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, opts) {
|
|
24925
25463
|
opts = opts || {};
|
|
@@ -25082,7 +25620,6 @@ class ConversationsApi {
|
|
|
25082
25620
|
* @param {String} conversationId conversationId
|
|
25083
25621
|
* @param {String} participantId participantId
|
|
25084
25622
|
* @param {Object} body Transfer request
|
|
25085
|
-
* @deprecated
|
|
25086
25623
|
*/
|
|
25087
25624
|
postConversationsEmailParticipantReplace(conversationId, participantId, body) {
|
|
25088
25625
|
// verify the required parameter 'conversationId' is set
|
|
@@ -25447,7 +25984,6 @@ class ConversationsApi {
|
|
|
25447
25984
|
* @param {String} conversationId conversationId
|
|
25448
25985
|
* @param {String} participantId participantId
|
|
25449
25986
|
* @param {Object} body Transfer request
|
|
25450
|
-
* @deprecated
|
|
25451
25987
|
*/
|
|
25452
25988
|
postConversationsMessageParticipantReplace(conversationId, participantId, body) {
|
|
25453
25989
|
// verify the required parameter 'conversationId' is set
|
|
@@ -25702,6 +26238,31 @@ class ConversationsApi {
|
|
|
25702
26238
|
);
|
|
25703
26239
|
}
|
|
25704
26240
|
|
|
26241
|
+
/**
|
|
26242
|
+
* Create a messaging setting
|
|
26243
|
+
*
|
|
26244
|
+
* @param {Object} body MessagingSetting
|
|
26245
|
+
*/
|
|
26246
|
+
postConversationsMessagingSettings(body) {
|
|
26247
|
+
// verify the required parameter 'body' is set
|
|
26248
|
+
if (body === undefined || body === null) {
|
|
26249
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingSettings';
|
|
26250
|
+
}
|
|
26251
|
+
|
|
26252
|
+
return this.apiClient.callApi(
|
|
26253
|
+
'/api/v2/conversations/messaging/settings',
|
|
26254
|
+
'POST',
|
|
26255
|
+
{ },
|
|
26256
|
+
{ },
|
|
26257
|
+
{ },
|
|
26258
|
+
{ },
|
|
26259
|
+
body,
|
|
26260
|
+
['PureCloud OAuth'],
|
|
26261
|
+
['application/json'],
|
|
26262
|
+
['application/json']
|
|
26263
|
+
);
|
|
26264
|
+
}
|
|
26265
|
+
|
|
25705
26266
|
/**
|
|
25706
26267
|
* Create a Supported Content profile
|
|
25707
26268
|
*
|
|
@@ -26269,6 +26830,31 @@ class ConversationsApi {
|
|
|
26269
26830
|
);
|
|
26270
26831
|
}
|
|
26271
26832
|
|
|
26833
|
+
/**
|
|
26834
|
+
* Set the organization's default setting that may be applied to to integrations without settings
|
|
26835
|
+
* 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.
|
|
26836
|
+
* @param {Object} body MessagingSetting
|
|
26837
|
+
*/
|
|
26838
|
+
putConversationsMessagingSettingsDefault(body) {
|
|
26839
|
+
// verify the required parameter 'body' is set
|
|
26840
|
+
if (body === undefined || body === null) {
|
|
26841
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingSettingsDefault';
|
|
26842
|
+
}
|
|
26843
|
+
|
|
26844
|
+
return this.apiClient.callApi(
|
|
26845
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
26846
|
+
'PUT',
|
|
26847
|
+
{ },
|
|
26848
|
+
{ },
|
|
26849
|
+
{ },
|
|
26850
|
+
{ },
|
|
26851
|
+
body,
|
|
26852
|
+
['PureCloud OAuth'],
|
|
26853
|
+
['application/json'],
|
|
26854
|
+
['application/json']
|
|
26855
|
+
);
|
|
26856
|
+
}
|
|
26857
|
+
|
|
26272
26858
|
/**
|
|
26273
26859
|
* Set the organization's default supported content profile that may be assigned to an integration when it is created.
|
|
26274
26860
|
* 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.
|
|
@@ -26415,7 +27001,7 @@ class DataExtensionsApi {
|
|
|
26415
27001
|
/**
|
|
26416
27002
|
* DataExtensions service.
|
|
26417
27003
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
26418
|
-
* @version
|
|
27004
|
+
* @version 173.0.0
|
|
26419
27005
|
*/
|
|
26420
27006
|
|
|
26421
27007
|
/**
|
|
@@ -26501,7 +27087,7 @@ class DownloadsApi {
|
|
|
26501
27087
|
/**
|
|
26502
27088
|
* Downloads service.
|
|
26503
27089
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
26504
|
-
* @version
|
|
27090
|
+
* @version 173.0.0
|
|
26505
27091
|
*/
|
|
26506
27092
|
|
|
26507
27093
|
/**
|
|
@@ -26549,11 +27135,76 @@ class DownloadsApi {
|
|
|
26549
27135
|
|
|
26550
27136
|
}
|
|
26551
27137
|
|
|
27138
|
+
class EmailsApi {
|
|
27139
|
+
/**
|
|
27140
|
+
* Emails service.
|
|
27141
|
+
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
27142
|
+
* @version 173.0.0
|
|
27143
|
+
*/
|
|
27144
|
+
|
|
27145
|
+
/**
|
|
27146
|
+
* Constructs a new EmailsApi.
|
|
27147
|
+
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
27148
|
+
* @class
|
|
27149
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
27150
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
27151
|
+
*/
|
|
27152
|
+
constructor(apiClient) {
|
|
27153
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
27154
|
+
}
|
|
27155
|
+
|
|
27156
|
+
|
|
27157
|
+
/**
|
|
27158
|
+
* Get email Contact Center settings
|
|
27159
|
+
*
|
|
27160
|
+
*/
|
|
27161
|
+
getEmailsSettings() {
|
|
27162
|
+
|
|
27163
|
+
return this.apiClient.callApi(
|
|
27164
|
+
'/api/v2/emails/settings',
|
|
27165
|
+
'GET',
|
|
27166
|
+
{ },
|
|
27167
|
+
{ },
|
|
27168
|
+
{ },
|
|
27169
|
+
{ },
|
|
27170
|
+
null,
|
|
27171
|
+
['PureCloud OAuth'],
|
|
27172
|
+
['application/json'],
|
|
27173
|
+
['application/json']
|
|
27174
|
+
);
|
|
27175
|
+
}
|
|
27176
|
+
|
|
27177
|
+
/**
|
|
27178
|
+
* Patch email Contact Center settings
|
|
27179
|
+
*
|
|
27180
|
+
* @param {Object} opts Optional parameters
|
|
27181
|
+
* @param {Object} opts.body
|
|
27182
|
+
*/
|
|
27183
|
+
patchEmailsSettings(opts) {
|
|
27184
|
+
opts = opts || {};
|
|
27185
|
+
|
|
27186
|
+
|
|
27187
|
+
return this.apiClient.callApi(
|
|
27188
|
+
'/api/v2/emails/settings',
|
|
27189
|
+
'PATCH',
|
|
27190
|
+
{ },
|
|
27191
|
+
{ },
|
|
27192
|
+
{ },
|
|
27193
|
+
{ },
|
|
27194
|
+
opts['body'],
|
|
27195
|
+
['PureCloud OAuth'],
|
|
27196
|
+
['application/json'],
|
|
27197
|
+
['application/json']
|
|
27198
|
+
);
|
|
27199
|
+
}
|
|
27200
|
+
|
|
27201
|
+
}
|
|
27202
|
+
|
|
26552
27203
|
class EventsApi {
|
|
26553
27204
|
/**
|
|
26554
27205
|
* Events service.
|
|
26555
27206
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
26556
|
-
* @version
|
|
27207
|
+
* @version 173.0.0
|
|
26557
27208
|
*/
|
|
26558
27209
|
|
|
26559
27210
|
/**
|
|
@@ -26649,7 +27300,7 @@ class ExternalContactsApi {
|
|
|
26649
27300
|
/**
|
|
26650
27301
|
* ExternalContacts service.
|
|
26651
27302
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26652
|
-
* @version
|
|
27303
|
+
* @version 173.0.0
|
|
26653
27304
|
*/
|
|
26654
27305
|
|
|
26655
27306
|
/**
|
|
@@ -28607,7 +29258,7 @@ class FaxApi {
|
|
|
28607
29258
|
/**
|
|
28608
29259
|
* Fax service.
|
|
28609
29260
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
28610
|
-
* @version
|
|
29261
|
+
* @version 173.0.0
|
|
28611
29262
|
*/
|
|
28612
29263
|
|
|
28613
29264
|
/**
|
|
@@ -28778,7 +29429,7 @@ class FlowsApi {
|
|
|
28778
29429
|
/**
|
|
28779
29430
|
* Flows service.
|
|
28780
29431
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
28781
|
-
* @version
|
|
29432
|
+
* @version 173.0.0
|
|
28782
29433
|
*/
|
|
28783
29434
|
|
|
28784
29435
|
/**
|
|
@@ -28962,7 +29613,7 @@ class GamificationApi {
|
|
|
28962
29613
|
/**
|
|
28963
29614
|
* Gamification service.
|
|
28964
29615
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
28965
|
-
* @version
|
|
29616
|
+
* @version 173.0.0
|
|
28966
29617
|
*/
|
|
28967
29618
|
|
|
28968
29619
|
/**
|
|
@@ -31048,7 +31699,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
31048
31699
|
/**
|
|
31049
31700
|
* GeneralDataProtectionRegulation service.
|
|
31050
31701
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
31051
|
-
* @version
|
|
31702
|
+
* @version 173.0.0
|
|
31052
31703
|
*/
|
|
31053
31704
|
|
|
31054
31705
|
/**
|
|
@@ -31178,7 +31829,7 @@ class GeolocationApi {
|
|
|
31178
31829
|
/**
|
|
31179
31830
|
* Geolocation service.
|
|
31180
31831
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
31181
|
-
* @version
|
|
31832
|
+
* @version 173.0.0
|
|
31182
31833
|
*/
|
|
31183
31834
|
|
|
31184
31835
|
/**
|
|
@@ -31309,7 +31960,7 @@ class GreetingsApi {
|
|
|
31309
31960
|
/**
|
|
31310
31961
|
* Greetings service.
|
|
31311
31962
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
31312
|
-
* @version
|
|
31963
|
+
* @version 173.0.0
|
|
31313
31964
|
*/
|
|
31314
31965
|
|
|
31315
31966
|
/**
|
|
@@ -31764,7 +32415,7 @@ class GroupsApi {
|
|
|
31764
32415
|
/**
|
|
31765
32416
|
* Groups service.
|
|
31766
32417
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
31767
|
-
* @version
|
|
32418
|
+
* @version 173.0.0
|
|
31768
32419
|
*/
|
|
31769
32420
|
|
|
31770
32421
|
/**
|
|
@@ -32283,7 +32934,7 @@ class IdentityProviderApi {
|
|
|
32283
32934
|
/**
|
|
32284
32935
|
* IdentityProvider service.
|
|
32285
32936
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
32286
|
-
* @version
|
|
32937
|
+
* @version 173.0.0
|
|
32287
32938
|
*/
|
|
32288
32939
|
|
|
32289
32940
|
/**
|
|
@@ -33039,7 +33690,7 @@ class InfrastructureAsCodeApi {
|
|
|
33039
33690
|
/**
|
|
33040
33691
|
* InfrastructureAsCode service.
|
|
33041
33692
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
33042
|
-
* @version
|
|
33693
|
+
* @version 173.0.0
|
|
33043
33694
|
*/
|
|
33044
33695
|
|
|
33045
33696
|
/**
|
|
@@ -33206,7 +33857,7 @@ class IntegrationsApi {
|
|
|
33206
33857
|
/**
|
|
33207
33858
|
* Integrations service.
|
|
33208
33859
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
33209
|
-
* @version
|
|
33860
|
+
* @version 173.0.0
|
|
33210
33861
|
*/
|
|
33211
33862
|
|
|
33212
33863
|
/**
|
|
@@ -35168,7 +35819,7 @@ class JourneyApi {
|
|
|
35168
35819
|
/**
|
|
35169
35820
|
* Journey service.
|
|
35170
35821
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
35171
|
-
* @version
|
|
35822
|
+
* @version 173.0.0
|
|
35172
35823
|
*/
|
|
35173
35824
|
|
|
35174
35825
|
/**
|
|
@@ -36271,7 +36922,7 @@ class KnowledgeApi {
|
|
|
36271
36922
|
/**
|
|
36272
36923
|
* Knowledge service.
|
|
36273
36924
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
36274
|
-
* @version
|
|
36925
|
+
* @version 173.0.0
|
|
36275
36926
|
*/
|
|
36276
36927
|
|
|
36277
36928
|
/**
|
|
@@ -37537,6 +38188,8 @@ class KnowledgeApi {
|
|
|
37537
38188
|
* @param {String} groupId The ID of the group to be retrieved.
|
|
37538
38189
|
* @param {Object} opts Optional parameters
|
|
37539
38190
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
38191
|
+
* @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
|
|
38192
|
+
* @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
|
|
37540
38193
|
*/
|
|
37541
38194
|
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
37542
38195
|
opts = opts || {};
|
|
@@ -37554,7 +38207,7 @@ class KnowledgeApi {
|
|
|
37554
38207
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
37555
38208
|
'GET',
|
|
37556
38209
|
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
37557
|
-
{ 'app': opts['app'] },
|
|
38210
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
37558
38211
|
{ },
|
|
37559
38212
|
{ },
|
|
37560
38213
|
null,
|
|
@@ -37572,6 +38225,8 @@ class KnowledgeApi {
|
|
|
37572
38225
|
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
37573
38226
|
* @param {Object} opts Optional parameters
|
|
37574
38227
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
38228
|
+
* @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
|
|
38229
|
+
* @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
|
|
37575
38230
|
*/
|
|
37576
38231
|
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
37577
38232
|
opts = opts || {};
|
|
@@ -37593,7 +38248,7 @@ class KnowledgeApi {
|
|
|
37593
38248
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
37594
38249
|
'GET',
|
|
37595
38250
|
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
37596
|
-
{ 'app': opts['app'] },
|
|
38251
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
37597
38252
|
{ },
|
|
37598
38253
|
{ },
|
|
37599
38254
|
null,
|
|
@@ -37609,6 +38264,8 @@ class KnowledgeApi {
|
|
|
37609
38264
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37610
38265
|
* @param {Object} opts Optional parameters
|
|
37611
38266
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
38267
|
+
* @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
|
|
38268
|
+
* @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
|
|
37612
38269
|
*/
|
|
37613
38270
|
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
37614
38271
|
opts = opts || {};
|
|
@@ -37622,7 +38279,7 @@ class KnowledgeApi {
|
|
|
37622
38279
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
37623
38280
|
'GET',
|
|
37624
38281
|
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
37625
|
-
{ 'app': opts['app'] },
|
|
38282
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
37626
38283
|
{ },
|
|
37627
38284
|
{ },
|
|
37628
38285
|
null,
|
|
@@ -38901,7 +39558,7 @@ class LanguageUnderstandingApi {
|
|
|
38901
39558
|
/**
|
|
38902
39559
|
* LanguageUnderstanding service.
|
|
38903
39560
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
38904
|
-
* @version
|
|
39561
|
+
* @version 173.0.0
|
|
38905
39562
|
*/
|
|
38906
39563
|
|
|
38907
39564
|
/**
|
|
@@ -39914,7 +40571,7 @@ class LanguagesApi {
|
|
|
39914
40571
|
/**
|
|
39915
40572
|
* Languages service.
|
|
39916
40573
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
39917
|
-
* @version
|
|
40574
|
+
* @version 173.0.0
|
|
39918
40575
|
*/
|
|
39919
40576
|
|
|
39920
40577
|
/**
|
|
@@ -40136,7 +40793,7 @@ class LearningApi {
|
|
|
40136
40793
|
/**
|
|
40137
40794
|
* Learning service.
|
|
40138
40795
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
40139
|
-
* @version
|
|
40796
|
+
* @version 173.0.0
|
|
40140
40797
|
*/
|
|
40141
40798
|
|
|
40142
40799
|
/**
|
|
@@ -40951,7 +41608,7 @@ class LicenseApi {
|
|
|
40951
41608
|
/**
|
|
40952
41609
|
* License service.
|
|
40953
41610
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
40954
|
-
* @version
|
|
41611
|
+
* @version 173.0.0
|
|
40955
41612
|
*/
|
|
40956
41613
|
|
|
40957
41614
|
/**
|
|
@@ -41012,7 +41669,7 @@ class LicenseApi {
|
|
|
41012
41669
|
}
|
|
41013
41670
|
|
|
41014
41671
|
/**
|
|
41015
|
-
*
|
|
41672
|
+
* Deprecated - no alternative required. This operation will always return 'true' for requested toggles
|
|
41016
41673
|
*
|
|
41017
41674
|
* @param {String} featureName featureName
|
|
41018
41675
|
*/
|
|
@@ -41135,7 +41792,7 @@ class LicenseApi {
|
|
|
41135
41792
|
}
|
|
41136
41793
|
|
|
41137
41794
|
/**
|
|
41138
|
-
*
|
|
41795
|
+
* Deprecated. No alternative required - this endpoint has no effect
|
|
41139
41796
|
*
|
|
41140
41797
|
* @param {String} featureName featureName
|
|
41141
41798
|
*/
|
|
@@ -41189,7 +41846,7 @@ class LocationsApi {
|
|
|
41189
41846
|
/**
|
|
41190
41847
|
* Locations service.
|
|
41191
41848
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
41192
|
-
* @version
|
|
41849
|
+
* @version 173.0.0
|
|
41193
41850
|
*/
|
|
41194
41851
|
|
|
41195
41852
|
/**
|
|
@@ -41425,7 +42082,7 @@ class MessagingApi {
|
|
|
41425
42082
|
/**
|
|
41426
42083
|
* Messaging service.
|
|
41427
42084
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
41428
|
-
* @version
|
|
42085
|
+
* @version 173.0.0
|
|
41429
42086
|
*/
|
|
41430
42087
|
|
|
41431
42088
|
/**
|
|
@@ -41440,6 +42097,53 @@ class MessagingApi {
|
|
|
41440
42097
|
}
|
|
41441
42098
|
|
|
41442
42099
|
|
|
42100
|
+
/**
|
|
42101
|
+
* Delete a messaging setting
|
|
42102
|
+
*
|
|
42103
|
+
* @param {String} messageSettingId Message Settings ID
|
|
42104
|
+
* @deprecated
|
|
42105
|
+
*/
|
|
42106
|
+
deleteMessagingSetting(messageSettingId) {
|
|
42107
|
+
// verify the required parameter 'messageSettingId' is set
|
|
42108
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
42109
|
+
throw 'Missing the required parameter "messageSettingId" when calling deleteMessagingSetting';
|
|
42110
|
+
}
|
|
42111
|
+
|
|
42112
|
+
return this.apiClient.callApi(
|
|
42113
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
42114
|
+
'DELETE',
|
|
42115
|
+
{ 'messageSettingId': messageSettingId },
|
|
42116
|
+
{ },
|
|
42117
|
+
{ },
|
|
42118
|
+
{ },
|
|
42119
|
+
null,
|
|
42120
|
+
['PureCloud OAuth'],
|
|
42121
|
+
['application/json'],
|
|
42122
|
+
['application/json']
|
|
42123
|
+
);
|
|
42124
|
+
}
|
|
42125
|
+
|
|
42126
|
+
/**
|
|
42127
|
+
* Delete the organization's default setting, a global default will be applied to integrations without settings
|
|
42128
|
+
* 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.
|
|
42129
|
+
* @deprecated
|
|
42130
|
+
*/
|
|
42131
|
+
deleteMessagingSettingsDefault() {
|
|
42132
|
+
|
|
42133
|
+
return this.apiClient.callApi(
|
|
42134
|
+
'/api/v2/messaging/settings/default',
|
|
42135
|
+
'DELETE',
|
|
42136
|
+
{ },
|
|
42137
|
+
{ },
|
|
42138
|
+
{ },
|
|
42139
|
+
{ },
|
|
42140
|
+
null,
|
|
42141
|
+
['PureCloud OAuth'],
|
|
42142
|
+
['application/json'],
|
|
42143
|
+
['application/json']
|
|
42144
|
+
);
|
|
42145
|
+
}
|
|
42146
|
+
|
|
41443
42147
|
/**
|
|
41444
42148
|
* Delete a supported content profile
|
|
41445
42149
|
* Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
@@ -41466,6 +42170,79 @@ class MessagingApi {
|
|
|
41466
42170
|
);
|
|
41467
42171
|
}
|
|
41468
42172
|
|
|
42173
|
+
/**
|
|
42174
|
+
* Get a messaging setting
|
|
42175
|
+
*
|
|
42176
|
+
* @param {String} messageSettingId Message Settings ID
|
|
42177
|
+
* @deprecated
|
|
42178
|
+
*/
|
|
42179
|
+
getMessagingSetting(messageSettingId) {
|
|
42180
|
+
// verify the required parameter 'messageSettingId' is set
|
|
42181
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
42182
|
+
throw 'Missing the required parameter "messageSettingId" when calling getMessagingSetting';
|
|
42183
|
+
}
|
|
42184
|
+
|
|
42185
|
+
return this.apiClient.callApi(
|
|
42186
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
42187
|
+
'GET',
|
|
42188
|
+
{ 'messageSettingId': messageSettingId },
|
|
42189
|
+
{ },
|
|
42190
|
+
{ },
|
|
42191
|
+
{ },
|
|
42192
|
+
null,
|
|
42193
|
+
['PureCloud OAuth'],
|
|
42194
|
+
['application/json'],
|
|
42195
|
+
['application/json']
|
|
42196
|
+
);
|
|
42197
|
+
}
|
|
42198
|
+
|
|
42199
|
+
/**
|
|
42200
|
+
* Get a list of messaging settings
|
|
42201
|
+
*
|
|
42202
|
+
* @param {Object} opts Optional parameters
|
|
42203
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
42204
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
42205
|
+
* @deprecated
|
|
42206
|
+
*/
|
|
42207
|
+
getMessagingSettings(opts) {
|
|
42208
|
+
opts = opts || {};
|
|
42209
|
+
|
|
42210
|
+
|
|
42211
|
+
return this.apiClient.callApi(
|
|
42212
|
+
'/api/v2/messaging/settings',
|
|
42213
|
+
'GET',
|
|
42214
|
+
{ },
|
|
42215
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
42216
|
+
{ },
|
|
42217
|
+
{ },
|
|
42218
|
+
null,
|
|
42219
|
+
['PureCloud OAuth'],
|
|
42220
|
+
['application/json'],
|
|
42221
|
+
['application/json']
|
|
42222
|
+
);
|
|
42223
|
+
}
|
|
42224
|
+
|
|
42225
|
+
/**
|
|
42226
|
+
* Get the organization's default settings that will be used as the default when creating an integration.
|
|
42227
|
+
* 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.
|
|
42228
|
+
* @deprecated
|
|
42229
|
+
*/
|
|
42230
|
+
getMessagingSettingsDefault() {
|
|
42231
|
+
|
|
42232
|
+
return this.apiClient.callApi(
|
|
42233
|
+
'/api/v2/messaging/settings/default',
|
|
42234
|
+
'GET',
|
|
42235
|
+
{ },
|
|
42236
|
+
{ },
|
|
42237
|
+
{ },
|
|
42238
|
+
{ },
|
|
42239
|
+
null,
|
|
42240
|
+
['PureCloud OAuth'],
|
|
42241
|
+
['application/json'],
|
|
42242
|
+
['application/json']
|
|
42243
|
+
);
|
|
42244
|
+
}
|
|
42245
|
+
|
|
41469
42246
|
/**
|
|
41470
42247
|
* Get a list of Supported Content profiles
|
|
41471
42248
|
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
|
|
@@ -41518,6 +42295,37 @@ class MessagingApi {
|
|
|
41518
42295
|
);
|
|
41519
42296
|
}
|
|
41520
42297
|
|
|
42298
|
+
/**
|
|
42299
|
+
* Update a messaging setting
|
|
42300
|
+
*
|
|
42301
|
+
* @param {String} messageSettingId Message Settings ID
|
|
42302
|
+
* @param {Object} body MessagingSetting
|
|
42303
|
+
* @deprecated
|
|
42304
|
+
*/
|
|
42305
|
+
patchMessagingSetting(messageSettingId, body) {
|
|
42306
|
+
// verify the required parameter 'messageSettingId' is set
|
|
42307
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
42308
|
+
throw 'Missing the required parameter "messageSettingId" when calling patchMessagingSetting';
|
|
42309
|
+
}
|
|
42310
|
+
// verify the required parameter 'body' is set
|
|
42311
|
+
if (body === undefined || body === null) {
|
|
42312
|
+
throw 'Missing the required parameter "body" when calling patchMessagingSetting';
|
|
42313
|
+
}
|
|
42314
|
+
|
|
42315
|
+
return this.apiClient.callApi(
|
|
42316
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
42317
|
+
'PATCH',
|
|
42318
|
+
{ 'messageSettingId': messageSettingId },
|
|
42319
|
+
{ },
|
|
42320
|
+
{ },
|
|
42321
|
+
{ },
|
|
42322
|
+
body,
|
|
42323
|
+
['PureCloud OAuth'],
|
|
42324
|
+
['application/json'],
|
|
42325
|
+
['application/json']
|
|
42326
|
+
);
|
|
42327
|
+
}
|
|
42328
|
+
|
|
41521
42329
|
/**
|
|
41522
42330
|
* Update a supported content profile
|
|
41523
42331
|
* Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
@@ -41549,6 +42357,32 @@ class MessagingApi {
|
|
|
41549
42357
|
);
|
|
41550
42358
|
}
|
|
41551
42359
|
|
|
42360
|
+
/**
|
|
42361
|
+
* Create a messaging setting
|
|
42362
|
+
*
|
|
42363
|
+
* @param {Object} body MessagingSetting
|
|
42364
|
+
* @deprecated
|
|
42365
|
+
*/
|
|
42366
|
+
postMessagingSettings(body) {
|
|
42367
|
+
// verify the required parameter 'body' is set
|
|
42368
|
+
if (body === undefined || body === null) {
|
|
42369
|
+
throw 'Missing the required parameter "body" when calling postMessagingSettings';
|
|
42370
|
+
}
|
|
42371
|
+
|
|
42372
|
+
return this.apiClient.callApi(
|
|
42373
|
+
'/api/v2/messaging/settings',
|
|
42374
|
+
'POST',
|
|
42375
|
+
{ },
|
|
42376
|
+
{ },
|
|
42377
|
+
{ },
|
|
42378
|
+
{ },
|
|
42379
|
+
body,
|
|
42380
|
+
['PureCloud OAuth'],
|
|
42381
|
+
['application/json'],
|
|
42382
|
+
['application/json']
|
|
42383
|
+
);
|
|
42384
|
+
}
|
|
42385
|
+
|
|
41552
42386
|
/**
|
|
41553
42387
|
* Create a Supported Content profile
|
|
41554
42388
|
* Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
|
|
@@ -41575,13 +42409,39 @@ class MessagingApi {
|
|
|
41575
42409
|
);
|
|
41576
42410
|
}
|
|
41577
42411
|
|
|
42412
|
+
/**
|
|
42413
|
+
* Set the organization's default settings that may be applied to an integration when it is created.
|
|
42414
|
+
* 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.
|
|
42415
|
+
* @param {Object} body Messaging Setting ID
|
|
42416
|
+
* @deprecated
|
|
42417
|
+
*/
|
|
42418
|
+
putMessagingSettingsDefault(body) {
|
|
42419
|
+
// verify the required parameter 'body' is set
|
|
42420
|
+
if (body === undefined || body === null) {
|
|
42421
|
+
throw 'Missing the required parameter "body" when calling putMessagingSettingsDefault';
|
|
42422
|
+
}
|
|
42423
|
+
|
|
42424
|
+
return this.apiClient.callApi(
|
|
42425
|
+
'/api/v2/messaging/settings/default',
|
|
42426
|
+
'PUT',
|
|
42427
|
+
{ },
|
|
42428
|
+
{ },
|
|
42429
|
+
{ },
|
|
42430
|
+
{ },
|
|
42431
|
+
body,
|
|
42432
|
+
['PureCloud OAuth'],
|
|
42433
|
+
['application/json'],
|
|
42434
|
+
['application/json']
|
|
42435
|
+
);
|
|
42436
|
+
}
|
|
42437
|
+
|
|
41578
42438
|
}
|
|
41579
42439
|
|
|
41580
42440
|
class MobileDevicesApi {
|
|
41581
42441
|
/**
|
|
41582
42442
|
* MobileDevices service.
|
|
41583
42443
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
41584
|
-
* @version
|
|
42444
|
+
* @version 173.0.0
|
|
41585
42445
|
*/
|
|
41586
42446
|
|
|
41587
42447
|
/**
|
|
@@ -41732,7 +42592,7 @@ class NotificationsApi {
|
|
|
41732
42592
|
/**
|
|
41733
42593
|
* Notifications service.
|
|
41734
42594
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
41735
|
-
* @version
|
|
42595
|
+
* @version 173.0.0
|
|
41736
42596
|
*/
|
|
41737
42597
|
|
|
41738
42598
|
/**
|
|
@@ -41965,7 +42825,7 @@ class OAuthApi {
|
|
|
41965
42825
|
/**
|
|
41966
42826
|
* OAuth service.
|
|
41967
42827
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
41968
|
-
* @version
|
|
42828
|
+
* @version 173.0.0
|
|
41969
42829
|
*/
|
|
41970
42830
|
|
|
41971
42831
|
/**
|
|
@@ -42331,7 +43191,7 @@ class ObjectsApi {
|
|
|
42331
43191
|
/**
|
|
42332
43192
|
* Objects service.
|
|
42333
43193
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
42334
|
-
* @version
|
|
43194
|
+
* @version 173.0.0
|
|
42335
43195
|
*/
|
|
42336
43196
|
|
|
42337
43197
|
/**
|
|
@@ -42602,7 +43462,7 @@ class OrganizationApi {
|
|
|
42602
43462
|
/**
|
|
42603
43463
|
* Organization service.
|
|
42604
43464
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
42605
|
-
* @version
|
|
43465
|
+
* @version 173.0.0
|
|
42606
43466
|
*/
|
|
42607
43467
|
|
|
42608
43468
|
/**
|
|
@@ -43057,7 +43917,7 @@ class OrganizationAuthorizationApi {
|
|
|
43057
43917
|
/**
|
|
43058
43918
|
* OrganizationAuthorization service.
|
|
43059
43919
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
43060
|
-
* @version
|
|
43920
|
+
* @version 173.0.0
|
|
43061
43921
|
*/
|
|
43062
43922
|
|
|
43063
43923
|
/**
|
|
@@ -44404,7 +45264,7 @@ class OutboundApi {
|
|
|
44404
45264
|
/**
|
|
44405
45265
|
* Outbound service.
|
|
44406
45266
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
44407
|
-
* @version
|
|
45267
|
+
* @version 173.0.0
|
|
44408
45268
|
*/
|
|
44409
45269
|
|
|
44410
45270
|
/**
|
|
@@ -48026,7 +48886,7 @@ class PresenceApi {
|
|
|
48026
48886
|
/**
|
|
48027
48887
|
* Presence service.
|
|
48028
48888
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
48029
|
-
* @version
|
|
48889
|
+
* @version 173.0.0
|
|
48030
48890
|
*/
|
|
48031
48891
|
|
|
48032
48892
|
/**
|
|
@@ -48765,7 +49625,7 @@ class ProcessAutomationApi {
|
|
|
48765
49625
|
/**
|
|
48766
49626
|
* ProcessAutomation service.
|
|
48767
49627
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48768
|
-
* @version
|
|
49628
|
+
* @version 173.0.0
|
|
48769
49629
|
*/
|
|
48770
49630
|
|
|
48771
49631
|
/**
|
|
@@ -49004,7 +49864,7 @@ class QualityApi {
|
|
|
49004
49864
|
/**
|
|
49005
49865
|
* Quality service.
|
|
49006
49866
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
49007
|
-
* @version
|
|
49867
|
+
* @version 173.0.0
|
|
49008
49868
|
*/
|
|
49009
49869
|
|
|
49010
49870
|
/**
|
|
@@ -50756,7 +51616,7 @@ class RecordingApi {
|
|
|
50756
51616
|
/**
|
|
50757
51617
|
* Recording service.
|
|
50758
51618
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50759
|
-
* @version
|
|
51619
|
+
* @version 173.0.0
|
|
50760
51620
|
*/
|
|
50761
51621
|
|
|
50762
51622
|
/**
|
|
@@ -52393,7 +53253,7 @@ class ResponseManagementApi {
|
|
|
52393
53253
|
/**
|
|
52394
53254
|
* ResponseManagement service.
|
|
52395
53255
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
52396
|
-
* @version
|
|
53256
|
+
* @version 173.0.0
|
|
52397
53257
|
*/
|
|
52398
53258
|
|
|
52399
53259
|
/**
|
|
@@ -52878,7 +53738,7 @@ class RoutingApi {
|
|
|
52878
53738
|
/**
|
|
52879
53739
|
* Routing service.
|
|
52880
53740
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52881
|
-
* @version
|
|
53741
|
+
* @version 173.0.0
|
|
52882
53742
|
*/
|
|
52883
53743
|
|
|
52884
53744
|
/**
|
|
@@ -56585,7 +57445,7 @@ class SCIMApi {
|
|
|
56585
57445
|
/**
|
|
56586
57446
|
* SCIM service.
|
|
56587
57447
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
56588
|
-
* @version
|
|
57448
|
+
* @version 173.0.0
|
|
56589
57449
|
*/
|
|
56590
57450
|
|
|
56591
57451
|
/**
|
|
@@ -57462,7 +58322,7 @@ class ScriptsApi {
|
|
|
57462
58322
|
/**
|
|
57463
58323
|
* Scripts service.
|
|
57464
58324
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57465
|
-
* @version
|
|
58325
|
+
* @version 173.0.0
|
|
57466
58326
|
*/
|
|
57467
58327
|
|
|
57468
58328
|
/**
|
|
@@ -57906,7 +58766,7 @@ class SearchApi {
|
|
|
57906
58766
|
/**
|
|
57907
58767
|
* Search service.
|
|
57908
58768
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
57909
|
-
* @version
|
|
58769
|
+
* @version 173.0.0
|
|
57910
58770
|
*/
|
|
57911
58771
|
|
|
57912
58772
|
/**
|
|
@@ -58591,11 +59451,76 @@ class SearchApi {
|
|
|
58591
59451
|
|
|
58592
59452
|
}
|
|
58593
59453
|
|
|
59454
|
+
class SettingsApi {
|
|
59455
|
+
/**
|
|
59456
|
+
* Settings service.
|
|
59457
|
+
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
59458
|
+
* @version 173.0.0
|
|
59459
|
+
*/
|
|
59460
|
+
|
|
59461
|
+
/**
|
|
59462
|
+
* Constructs a new SettingsApi.
|
|
59463
|
+
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
59464
|
+
* @class
|
|
59465
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
59466
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
59467
|
+
*/
|
|
59468
|
+
constructor(apiClient) {
|
|
59469
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
59470
|
+
}
|
|
59471
|
+
|
|
59472
|
+
|
|
59473
|
+
/**
|
|
59474
|
+
* Get email Contact Center settings
|
|
59475
|
+
*
|
|
59476
|
+
*/
|
|
59477
|
+
getEmailsSettings() {
|
|
59478
|
+
|
|
59479
|
+
return this.apiClient.callApi(
|
|
59480
|
+
'/api/v2/emails/settings',
|
|
59481
|
+
'GET',
|
|
59482
|
+
{ },
|
|
59483
|
+
{ },
|
|
59484
|
+
{ },
|
|
59485
|
+
{ },
|
|
59486
|
+
null,
|
|
59487
|
+
['PureCloud OAuth'],
|
|
59488
|
+
['application/json'],
|
|
59489
|
+
['application/json']
|
|
59490
|
+
);
|
|
59491
|
+
}
|
|
59492
|
+
|
|
59493
|
+
/**
|
|
59494
|
+
* Patch email Contact Center settings
|
|
59495
|
+
*
|
|
59496
|
+
* @param {Object} opts Optional parameters
|
|
59497
|
+
* @param {Object} opts.body
|
|
59498
|
+
*/
|
|
59499
|
+
patchEmailsSettings(opts) {
|
|
59500
|
+
opts = opts || {};
|
|
59501
|
+
|
|
59502
|
+
|
|
59503
|
+
return this.apiClient.callApi(
|
|
59504
|
+
'/api/v2/emails/settings',
|
|
59505
|
+
'PATCH',
|
|
59506
|
+
{ },
|
|
59507
|
+
{ },
|
|
59508
|
+
{ },
|
|
59509
|
+
{ },
|
|
59510
|
+
opts['body'],
|
|
59511
|
+
['PureCloud OAuth'],
|
|
59512
|
+
['application/json'],
|
|
59513
|
+
['application/json']
|
|
59514
|
+
);
|
|
59515
|
+
}
|
|
59516
|
+
|
|
59517
|
+
}
|
|
59518
|
+
|
|
58594
59519
|
class SpeechTextAnalyticsApi {
|
|
58595
59520
|
/**
|
|
58596
59521
|
* SpeechTextAnalytics service.
|
|
58597
59522
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
58598
|
-
* @version
|
|
59523
|
+
* @version 173.0.0
|
|
58599
59524
|
*/
|
|
58600
59525
|
|
|
58601
59526
|
/**
|
|
@@ -58764,6 +59689,36 @@ class SpeechTextAnalyticsApi {
|
|
|
58764
59689
|
);
|
|
58765
59690
|
}
|
|
58766
59691
|
|
|
59692
|
+
/**
|
|
59693
|
+
* Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation
|
|
59694
|
+
*
|
|
59695
|
+
* @param {String} conversationId Conversation ID
|
|
59696
|
+
* @param {String} communicationId Communication ID
|
|
59697
|
+
*/
|
|
59698
|
+
getSpeechandtextanalyticsConversationCommunicationTranscripturls(conversationId, communicationId) {
|
|
59699
|
+
// verify the required parameter 'conversationId' is set
|
|
59700
|
+
if (conversationId === undefined || conversationId === null) {
|
|
59701
|
+
throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';
|
|
59702
|
+
}
|
|
59703
|
+
// verify the required parameter 'communicationId' is set
|
|
59704
|
+
if (communicationId === undefined || communicationId === null) {
|
|
59705
|
+
throw 'Missing the required parameter "communicationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';
|
|
59706
|
+
}
|
|
59707
|
+
|
|
59708
|
+
return this.apiClient.callApi(
|
|
59709
|
+
'/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls',
|
|
59710
|
+
'GET',
|
|
59711
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
59712
|
+
{ },
|
|
59713
|
+
{ },
|
|
59714
|
+
{ },
|
|
59715
|
+
null,
|
|
59716
|
+
['PureCloud OAuth'],
|
|
59717
|
+
['application/json'],
|
|
59718
|
+
['application/json']
|
|
59719
|
+
);
|
|
59720
|
+
}
|
|
59721
|
+
|
|
58767
59722
|
/**
|
|
58768
59723
|
* Get a Speech and Text Analytics program by id
|
|
58769
59724
|
*
|
|
@@ -59548,7 +60503,7 @@ class StationsApi {
|
|
|
59548
60503
|
/**
|
|
59549
60504
|
* Stations service.
|
|
59550
60505
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
59551
|
-
* @version
|
|
60506
|
+
* @version 173.0.0
|
|
59552
60507
|
*/
|
|
59553
60508
|
|
|
59554
60509
|
/**
|
|
@@ -59650,7 +60605,7 @@ class SuggestApi {
|
|
|
59650
60605
|
/**
|
|
59651
60606
|
* Suggest service.
|
|
59652
60607
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
59653
|
-
* @version
|
|
60608
|
+
* @version 173.0.0
|
|
59654
60609
|
*/
|
|
59655
60610
|
|
|
59656
60611
|
/**
|
|
@@ -59789,7 +60744,7 @@ class TaskManagementApi {
|
|
|
59789
60744
|
/**
|
|
59790
60745
|
* TaskManagement service.
|
|
59791
60746
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
59792
|
-
* @version
|
|
60747
|
+
* @version 173.0.0
|
|
59793
60748
|
*/
|
|
59794
60749
|
|
|
59795
60750
|
/**
|
|
@@ -61070,7 +62025,7 @@ class TeamsApi {
|
|
|
61070
62025
|
/**
|
|
61071
62026
|
* Teams service.
|
|
61072
62027
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
61073
|
-
* @version
|
|
62028
|
+
* @version 173.0.0
|
|
61074
62029
|
*/
|
|
61075
62030
|
|
|
61076
62031
|
/**
|
|
@@ -61372,7 +62327,7 @@ class TelephonyApi {
|
|
|
61372
62327
|
/**
|
|
61373
62328
|
* Telephony service.
|
|
61374
62329
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
61375
|
-
* @version
|
|
62330
|
+
* @version 173.0.0
|
|
61376
62331
|
*/
|
|
61377
62332
|
|
|
61378
62333
|
/**
|
|
@@ -61500,7 +62455,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
61500
62455
|
/**
|
|
61501
62456
|
* TelephonyProvidersEdge service.
|
|
61502
62457
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
61503
|
-
* @version
|
|
62458
|
+
* @version 173.0.0
|
|
61504
62459
|
*/
|
|
61505
62460
|
|
|
61506
62461
|
/**
|
|
@@ -62956,7 +63911,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
62956
63911
|
/**
|
|
62957
63912
|
* Get the metrics for a list of edges.
|
|
62958
63913
|
*
|
|
62959
|
-
* @param {String} edgeIds Comma separated list of Edge Id's
|
|
63914
|
+
* @param {String} edgeIds Comma separated list of Edge Id's. Maximum of 100 edge ids allowed.
|
|
62960
63915
|
*/
|
|
62961
63916
|
getTelephonyProvidersEdgesMetrics(edgeIds) {
|
|
62962
63917
|
// verify the required parameter 'edgeIds' is set
|
|
@@ -64789,7 +65744,7 @@ class TextbotsApi {
|
|
|
64789
65744
|
/**
|
|
64790
65745
|
* Textbots service.
|
|
64791
65746
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
64792
|
-
* @version
|
|
65747
|
+
* @version 173.0.0
|
|
64793
65748
|
*/
|
|
64794
65749
|
|
|
64795
65750
|
/**
|
|
@@ -64917,7 +65872,7 @@ class TokensApi {
|
|
|
64917
65872
|
/**
|
|
64918
65873
|
* Tokens service.
|
|
64919
65874
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
64920
|
-
* @version
|
|
65875
|
+
* @version 173.0.0
|
|
64921
65876
|
*/
|
|
64922
65877
|
|
|
64923
65878
|
/**
|
|
@@ -65069,7 +66024,7 @@ class UploadsApi {
|
|
|
65069
66024
|
/**
|
|
65070
66025
|
* Uploads service.
|
|
65071
66026
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
65072
|
-
* @version
|
|
66027
|
+
* @version 173.0.0
|
|
65073
66028
|
*/
|
|
65074
66029
|
|
|
65075
66030
|
/**
|
|
@@ -65245,7 +66200,7 @@ class UsageApi {
|
|
|
65245
66200
|
/**
|
|
65246
66201
|
* Usage service.
|
|
65247
66202
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
65248
|
-
* @version
|
|
66203
|
+
* @version 173.0.0
|
|
65249
66204
|
*/
|
|
65250
66205
|
|
|
65251
66206
|
/**
|
|
@@ -65455,7 +66410,7 @@ class UserRecordingsApi {
|
|
|
65455
66410
|
/**
|
|
65456
66411
|
* UserRecordings service.
|
|
65457
66412
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
65458
|
-
* @version
|
|
66413
|
+
* @version 173.0.0
|
|
65459
66414
|
*/
|
|
65460
66415
|
|
|
65461
66416
|
/**
|
|
@@ -65640,7 +66595,7 @@ class UsersApi {
|
|
|
65640
66595
|
/**
|
|
65641
66596
|
* Users service.
|
|
65642
66597
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
65643
|
-
* @version
|
|
66598
|
+
* @version 173.0.0
|
|
65644
66599
|
*/
|
|
65645
66600
|
|
|
65646
66601
|
/**
|
|
@@ -68201,7 +69156,7 @@ class UtilitiesApi {
|
|
|
68201
69156
|
/**
|
|
68202
69157
|
* Utilities service.
|
|
68203
69158
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
68204
|
-
* @version
|
|
69159
|
+
* @version 173.0.0
|
|
68205
69160
|
*/
|
|
68206
69161
|
|
|
68207
69162
|
/**
|
|
@@ -68312,7 +69267,7 @@ class VoicemailApi {
|
|
|
68312
69267
|
/**
|
|
68313
69268
|
* Voicemail service.
|
|
68314
69269
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
68315
|
-
* @version
|
|
69270
|
+
* @version 173.0.0
|
|
68316
69271
|
*/
|
|
68317
69272
|
|
|
68318
69273
|
/**
|
|
@@ -68979,7 +69934,7 @@ class WebChatApi {
|
|
|
68979
69934
|
/**
|
|
68980
69935
|
* WebChat service.
|
|
68981
69936
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
68982
|
-
* @version
|
|
69937
|
+
* @version 173.0.0
|
|
68983
69938
|
*/
|
|
68984
69939
|
|
|
68985
69940
|
/**
|
|
@@ -69528,7 +70483,7 @@ class WebDeploymentsApi {
|
|
|
69528
70483
|
/**
|
|
69529
70484
|
* WebDeployments service.
|
|
69530
70485
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
69531
|
-
* @version
|
|
70486
|
+
* @version 173.0.0
|
|
69532
70487
|
*/
|
|
69533
70488
|
|
|
69534
70489
|
/**
|
|
@@ -70050,7 +71005,7 @@ class WebMessagingApi {
|
|
|
70050
71005
|
/**
|
|
70051
71006
|
* WebMessaging service.
|
|
70052
71007
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
70053
|
-
* @version
|
|
71008
|
+
* @version 173.0.0
|
|
70054
71009
|
*/
|
|
70055
71010
|
|
|
70056
71011
|
/**
|
|
@@ -70096,7 +71051,7 @@ class WidgetsApi {
|
|
|
70096
71051
|
/**
|
|
70097
71052
|
* Widgets service.
|
|
70098
71053
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
70099
|
-
* @version
|
|
71054
|
+
* @version 173.0.0
|
|
70100
71055
|
*/
|
|
70101
71056
|
|
|
70102
71057
|
/**
|
|
@@ -70242,7 +71197,7 @@ class WorkforceManagementApi {
|
|
|
70242
71197
|
/**
|
|
70243
71198
|
* WorkforceManagement service.
|
|
70244
71199
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
70245
|
-
* @version
|
|
71200
|
+
* @version 173.0.0
|
|
70246
71201
|
*/
|
|
70247
71202
|
|
|
70248
71203
|
/**
|
|
@@ -70981,8 +71936,8 @@ class WorkforceManagementApi {
|
|
|
70981
71936
|
*
|
|
70982
71937
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
70983
71938
|
* @param {Object} opts Optional parameters
|
|
70984
|
-
* @param {Object} opts.feature
|
|
70985
|
-
* @param {String} opts.divisionId
|
|
71939
|
+
* @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
|
|
71940
|
+
* @param {String} opts.divisionId If specified, the list of management units belonging to the specified division will be returned
|
|
70986
71941
|
*/
|
|
70987
71942
|
getWorkforcemanagementBusinessunitManagementunits(businessUnitId, opts) {
|
|
70988
71943
|
opts = opts || {};
|
|
@@ -71621,8 +72576,8 @@ class WorkforceManagementApi {
|
|
|
71621
72576
|
* Get business units
|
|
71622
72577
|
*
|
|
71623
72578
|
* @param {Object} opts Optional parameters
|
|
71624
|
-
* @param {Object} opts.feature
|
|
71625
|
-
* @param {String} opts.divisionId
|
|
72579
|
+
* @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
|
|
72580
|
+
* @param {String} opts.divisionId If specified, the list of business units belonging to the specified division will be returned
|
|
71626
72581
|
*/
|
|
71627
72582
|
getWorkforcemanagementBusinessunits(opts) {
|
|
71628
72583
|
opts = opts || {};
|
|
@@ -72429,8 +73384,8 @@ class WorkforceManagementApi {
|
|
|
72429
73384
|
* @param {Number} opts.pageSize Deprecated, paging is not supported
|
|
72430
73385
|
* @param {Number} opts.pageNumber Deprecated, paging is not supported
|
|
72431
73386
|
* @param {Object} opts.expand Deprecated, expand settings on the single MU route
|
|
72432
|
-
* @param {Object} opts.feature
|
|
72433
|
-
* @param {String} opts.divisionId
|
|
73387
|
+
* @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
|
|
73388
|
+
* @param {String} opts.divisionId If specified, the list of management units belonging to the specified division will be returned
|
|
72434
73389
|
*/
|
|
72435
73390
|
getWorkforcemanagementManagementunits(opts) {
|
|
72436
73391
|
opts = opts || {};
|
|
@@ -75049,7 +76004,7 @@ class WorkforceManagementApi {
|
|
|
75049
76004
|
* </pre>
|
|
75050
76005
|
* </p>
|
|
75051
76006
|
* @module purecloud-platform-client-v2/index
|
|
75052
|
-
* @version
|
|
76007
|
+
* @version 173.0.0
|
|
75053
76008
|
*/
|
|
75054
76009
|
class platformClient {
|
|
75055
76010
|
constructor() {
|
|
@@ -75128,6 +76083,11 @@ class platformClient {
|
|
|
75128
76083
|
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|
|
75129
76084
|
*/
|
|
75130
76085
|
this.DownloadsApi = DownloadsApi;
|
|
76086
|
+
/**
|
|
76087
|
+
* The EmailsApi service constructor.
|
|
76088
|
+
* @property {module:purecloud-platform-client-v2/api/EmailsApi}
|
|
76089
|
+
*/
|
|
76090
|
+
this.EmailsApi = EmailsApi;
|
|
75131
76091
|
/**
|
|
75132
76092
|
* The EventsApi service constructor.
|
|
75133
76093
|
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|
|
@@ -75308,6 +76268,11 @@ class platformClient {
|
|
|
75308
76268
|
* @property {module:purecloud-platform-client-v2/api/SearchApi}
|
|
75309
76269
|
*/
|
|
75310
76270
|
this.SearchApi = SearchApi;
|
|
76271
|
+
/**
|
|
76272
|
+
* The SettingsApi service constructor.
|
|
76273
|
+
* @property {module:purecloud-platform-client-v2/api/SettingsApi}
|
|
76274
|
+
*/
|
|
76275
|
+
this.SettingsApi = SettingsApi;
|
|
75311
76276
|
/**
|
|
75312
76277
|
* The SpeechTextAnalyticsApi service constructor.
|
|
75313
76278
|
* @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}
|