purecloud-platform-client-v2 157.0.0 → 158.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 +529 -73
- package/dist/web-amd/purecloud-platform-client-v2.js +529 -73
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +529 -73
- package/dist/web-cjs/purecloud-platform-client-v2.js +539 -73
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +141 -2
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +26 -1
- 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/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/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +371 -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/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/SuggestApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +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 +61 -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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 158.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1481,7 +1481,7 @@ class AlertingApi {
|
|
|
1481
1481
|
/**
|
|
1482
1482
|
* Alerting service.
|
|
1483
1483
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1484
|
-
* @version
|
|
1484
|
+
* @version 158.0.0
|
|
1485
1485
|
*/
|
|
1486
1486
|
|
|
1487
1487
|
/**
|
|
@@ -1795,7 +1795,7 @@ class AnalyticsApi {
|
|
|
1795
1795
|
/**
|
|
1796
1796
|
* Analytics service.
|
|
1797
1797
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1798
|
-
* @version
|
|
1798
|
+
* @version 158.0.0
|
|
1799
1799
|
*/
|
|
1800
1800
|
|
|
1801
1801
|
/**
|
|
@@ -3049,7 +3049,7 @@ class ArchitectApi {
|
|
|
3049
3049
|
/**
|
|
3050
3050
|
* Architect service.
|
|
3051
3051
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3052
|
-
* @version
|
|
3052
|
+
* @version 158.0.0
|
|
3053
3053
|
*/
|
|
3054
3054
|
|
|
3055
3055
|
/**
|
|
@@ -6097,7 +6097,7 @@ class AuditApi {
|
|
|
6097
6097
|
/**
|
|
6098
6098
|
* Audit service.
|
|
6099
6099
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6100
|
-
* @version
|
|
6100
|
+
* @version 158.0.0
|
|
6101
6101
|
*/
|
|
6102
6102
|
|
|
6103
6103
|
/**
|
|
@@ -6268,7 +6268,7 @@ class AuthorizationApi {
|
|
|
6268
6268
|
/**
|
|
6269
6269
|
* Authorization service.
|
|
6270
6270
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6271
|
-
* @version
|
|
6271
|
+
* @version 158.0.0
|
|
6272
6272
|
*/
|
|
6273
6273
|
|
|
6274
6274
|
/**
|
|
@@ -7496,7 +7496,7 @@ class BillingApi {
|
|
|
7496
7496
|
/**
|
|
7497
7497
|
* Billing service.
|
|
7498
7498
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7499
|
-
* @version
|
|
7499
|
+
* @version 158.0.0
|
|
7500
7500
|
*/
|
|
7501
7501
|
|
|
7502
7502
|
/**
|
|
@@ -7576,7 +7576,7 @@ class ChatApi {
|
|
|
7576
7576
|
/**
|
|
7577
7577
|
* Chat service.
|
|
7578
7578
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7579
|
-
* @version
|
|
7579
|
+
* @version 158.0.0
|
|
7580
7580
|
*/
|
|
7581
7581
|
|
|
7582
7582
|
/**
|
|
@@ -7667,7 +7667,7 @@ class CoachingApi {
|
|
|
7667
7667
|
/**
|
|
7668
7668
|
* Coaching service.
|
|
7669
7669
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7670
|
-
* @version
|
|
7670
|
+
* @version 158.0.0
|
|
7671
7671
|
*/
|
|
7672
7672
|
|
|
7673
7673
|
/**
|
|
@@ -8244,7 +8244,7 @@ class ContentManagementApi {
|
|
|
8244
8244
|
/**
|
|
8245
8245
|
* ContentManagement service.
|
|
8246
8246
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8247
|
-
* @version
|
|
8247
|
+
* @version 158.0.0
|
|
8248
8248
|
*/
|
|
8249
8249
|
|
|
8250
8250
|
/**
|
|
@@ -9384,7 +9384,7 @@ class ConversationsApi {
|
|
|
9384
9384
|
/**
|
|
9385
9385
|
* Conversations service.
|
|
9386
9386
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9387
|
-
* @version
|
|
9387
|
+
* @version 158.0.0
|
|
9388
9388
|
*/
|
|
9389
9389
|
|
|
9390
9390
|
/**
|
|
@@ -12771,6 +12771,31 @@ class ConversationsApi {
|
|
|
12771
12771
|
);
|
|
12772
12772
|
}
|
|
12773
12773
|
|
|
12774
|
+
/**
|
|
12775
|
+
* Creates a cobrowse session
|
|
12776
|
+
*
|
|
12777
|
+
* @param {String} conversationId Conversation ID
|
|
12778
|
+
*/
|
|
12779
|
+
postConversationCobrowse(conversationId) {
|
|
12780
|
+
// verify the required parameter 'conversationId' is set
|
|
12781
|
+
if (conversationId === undefined || conversationId === null) {
|
|
12782
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCobrowse';
|
|
12783
|
+
}
|
|
12784
|
+
|
|
12785
|
+
return this.apiClient.callApi(
|
|
12786
|
+
'/api/v2/conversations/{conversationId}/cobrowse',
|
|
12787
|
+
'POST',
|
|
12788
|
+
{ 'conversationId': conversationId },
|
|
12789
|
+
{ },
|
|
12790
|
+
{ },
|
|
12791
|
+
{ },
|
|
12792
|
+
null,
|
|
12793
|
+
['PureCloud OAuth'],
|
|
12794
|
+
['application/json'],
|
|
12795
|
+
['application/json']
|
|
12796
|
+
);
|
|
12797
|
+
}
|
|
12798
|
+
|
|
12774
12799
|
/**
|
|
12775
12800
|
* Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
|
|
12776
12801
|
*
|
|
@@ -14607,7 +14632,7 @@ class DataExtensionsApi {
|
|
|
14607
14632
|
/**
|
|
14608
14633
|
* DataExtensions service.
|
|
14609
14634
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14610
|
-
* @version
|
|
14635
|
+
* @version 158.0.0
|
|
14611
14636
|
*/
|
|
14612
14637
|
|
|
14613
14638
|
/**
|
|
@@ -14693,7 +14718,7 @@ class DownloadsApi {
|
|
|
14693
14718
|
/**
|
|
14694
14719
|
* Downloads service.
|
|
14695
14720
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14696
|
-
* @version
|
|
14721
|
+
* @version 158.0.0
|
|
14697
14722
|
*/
|
|
14698
14723
|
|
|
14699
14724
|
/**
|
|
@@ -14745,7 +14770,7 @@ class EventsApi {
|
|
|
14745
14770
|
/**
|
|
14746
14771
|
* Events service.
|
|
14747
14772
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14748
|
-
* @version
|
|
14773
|
+
* @version 158.0.0
|
|
14749
14774
|
*/
|
|
14750
14775
|
|
|
14751
14776
|
/**
|
|
@@ -14841,7 +14866,7 @@ class ExternalContactsApi {
|
|
|
14841
14866
|
/**
|
|
14842
14867
|
* ExternalContacts service.
|
|
14843
14868
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14844
|
-
* @version
|
|
14869
|
+
* @version 158.0.0
|
|
14845
14870
|
*/
|
|
14846
14871
|
|
|
14847
14872
|
/**
|
|
@@ -16799,7 +16824,7 @@ class FaxApi {
|
|
|
16799
16824
|
/**
|
|
16800
16825
|
* Fax service.
|
|
16801
16826
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16802
|
-
* @version
|
|
16827
|
+
* @version 158.0.0
|
|
16803
16828
|
*/
|
|
16804
16829
|
|
|
16805
16830
|
/**
|
|
@@ -16970,7 +16995,7 @@ class FlowsApi {
|
|
|
16970
16995
|
/**
|
|
16971
16996
|
* Flows service.
|
|
16972
16997
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16973
|
-
* @version
|
|
16998
|
+
* @version 158.0.0
|
|
16974
16999
|
*/
|
|
16975
17000
|
|
|
16976
17001
|
/**
|
|
@@ -17041,7 +17066,7 @@ class GamificationApi {
|
|
|
17041
17066
|
/**
|
|
17042
17067
|
* Gamification service.
|
|
17043
17068
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
17044
|
-
* @version
|
|
17069
|
+
* @version 158.0.0
|
|
17045
17070
|
*/
|
|
17046
17071
|
|
|
17047
17072
|
/**
|
|
@@ -18658,7 +18683,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18658
18683
|
/**
|
|
18659
18684
|
* GeneralDataProtectionRegulation service.
|
|
18660
18685
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18661
|
-
* @version
|
|
18686
|
+
* @version 158.0.0
|
|
18662
18687
|
*/
|
|
18663
18688
|
|
|
18664
18689
|
/**
|
|
@@ -18788,7 +18813,7 @@ class GeolocationApi {
|
|
|
18788
18813
|
/**
|
|
18789
18814
|
* Geolocation service.
|
|
18790
18815
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18791
|
-
* @version
|
|
18816
|
+
* @version 158.0.0
|
|
18792
18817
|
*/
|
|
18793
18818
|
|
|
18794
18819
|
/**
|
|
@@ -18919,7 +18944,7 @@ class GreetingsApi {
|
|
|
18919
18944
|
/**
|
|
18920
18945
|
* Greetings service.
|
|
18921
18946
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18922
|
-
* @version
|
|
18947
|
+
* @version 158.0.0
|
|
18923
18948
|
*/
|
|
18924
18949
|
|
|
18925
18950
|
/**
|
|
@@ -19374,7 +19399,7 @@ class GroupsApi {
|
|
|
19374
19399
|
/**
|
|
19375
19400
|
* Groups service.
|
|
19376
19401
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19377
|
-
* @version
|
|
19402
|
+
* @version 158.0.0
|
|
19378
19403
|
*/
|
|
19379
19404
|
|
|
19380
19405
|
/**
|
|
@@ -19780,7 +19805,7 @@ class IdentityProviderApi {
|
|
|
19780
19805
|
/**
|
|
19781
19806
|
* IdentityProvider service.
|
|
19782
19807
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19783
|
-
* @version
|
|
19808
|
+
* @version 158.0.0
|
|
19784
19809
|
*/
|
|
19785
19810
|
|
|
19786
19811
|
/**
|
|
@@ -20536,7 +20561,7 @@ class IntegrationsApi {
|
|
|
20536
20561
|
/**
|
|
20537
20562
|
* Integrations service.
|
|
20538
20563
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20539
|
-
* @version
|
|
20564
|
+
* @version 158.0.0
|
|
20540
20565
|
*/
|
|
20541
20566
|
|
|
20542
20567
|
/**
|
|
@@ -22136,7 +22161,7 @@ class JourneyApi {
|
|
|
22136
22161
|
/**
|
|
22137
22162
|
* Journey service.
|
|
22138
22163
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22139
|
-
* @version
|
|
22164
|
+
* @version 158.0.0
|
|
22140
22165
|
*/
|
|
22141
22166
|
|
|
22142
22167
|
/**
|
|
@@ -22922,7 +22947,7 @@ class KnowledgeApi {
|
|
|
22922
22947
|
/**
|
|
22923
22948
|
* Knowledge service.
|
|
22924
22949
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22925
|
-
* @version
|
|
22950
|
+
* @version 158.0.0
|
|
22926
22951
|
*/
|
|
22927
22952
|
|
|
22928
22953
|
/**
|
|
@@ -25355,7 +25380,7 @@ class LanguageUnderstandingApi {
|
|
|
25355
25380
|
/**
|
|
25356
25381
|
* LanguageUnderstanding service.
|
|
25357
25382
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25358
|
-
* @version
|
|
25383
|
+
* @version 158.0.0
|
|
25359
25384
|
*/
|
|
25360
25385
|
|
|
25361
25386
|
/**
|
|
@@ -25549,6 +25574,7 @@ class LanguageUnderstandingApi {
|
|
|
25549
25574
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
25550
25575
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
25551
25576
|
* @param {Boolean} opts.enableCursorPagination Enable Cursor Pagination (default to false)
|
|
25577
|
+
* @param {Boolean} opts.includeTrainingUtterances Include Training Utterances. By default they're included. (default to true)
|
|
25552
25578
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true
|
|
25553
25579
|
* @param {Array.<String>} opts.fields Fields and properties to get, comma-separated
|
|
25554
25580
|
*/
|
|
@@ -25564,7 +25590,7 @@ class LanguageUnderstandingApi {
|
|
|
25564
25590
|
'/api/v2/languageunderstanding/domains/{domainId}/feedback',
|
|
25565
25591
|
'GET',
|
|
25566
25592
|
{ 'domainId': domainId },
|
|
25567
|
-
{ 'intentName': opts['intentName'],'assessment': opts['assessment'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'includeDeleted': opts['includeDeleted'],'language': opts['language'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'enableCursorPagination': opts['enableCursorPagination'],'after': opts['after'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
|
|
25593
|
+
{ 'intentName': opts['intentName'],'assessment': opts['assessment'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'includeDeleted': opts['includeDeleted'],'language': opts['language'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'enableCursorPagination': opts['enableCursorPagination'],'includeTrainingUtterances': opts['includeTrainingUtterances'],'after': opts['after'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
|
|
25568
25594
|
{ },
|
|
25569
25595
|
{ },
|
|
25570
25596
|
null,
|
|
@@ -26367,7 +26393,7 @@ class LanguagesApi {
|
|
|
26367
26393
|
/**
|
|
26368
26394
|
* Languages service.
|
|
26369
26395
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26370
|
-
* @version
|
|
26396
|
+
* @version 158.0.0
|
|
26371
26397
|
*/
|
|
26372
26398
|
|
|
26373
26399
|
/**
|
|
@@ -26585,7 +26611,7 @@ class LearningApi {
|
|
|
26585
26611
|
/**
|
|
26586
26612
|
* Learning service.
|
|
26587
26613
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26588
|
-
* @version
|
|
26614
|
+
* @version 158.0.0
|
|
26589
26615
|
*/
|
|
26590
26616
|
|
|
26591
26617
|
/**
|
|
@@ -26695,7 +26721,7 @@ class LearningApi {
|
|
|
26695
26721
|
* @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
26696
26722
|
* @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
|
|
26697
26723
|
* @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs.
|
|
26698
|
-
* @param {Array.<String>} opts.types Specifies the
|
|
26724
|
+
* @param {Array.<String>} opts.types Specifies the module types to filter by
|
|
26699
26725
|
* @param {Array.<String>} opts.states Specifies the assignment states to filter by
|
|
26700
26726
|
* @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
|
|
26701
26727
|
*/
|
|
@@ -26732,7 +26758,7 @@ class LearningApi {
|
|
|
26732
26758
|
* @param {Number} opts.maxPercentageScore The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)
|
|
26733
26759
|
* @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
26734
26760
|
* @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
|
|
26735
|
-
* @param {Array.<String>} opts.types Specifies the
|
|
26761
|
+
* @param {Array.<String>} opts.types Specifies the module types to filter by
|
|
26736
26762
|
* @param {Array.<String>} opts.states Specifies the assignment states to filter by
|
|
26737
26763
|
* @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
|
|
26738
26764
|
*/
|
|
@@ -27346,7 +27372,7 @@ class LicenseApi {
|
|
|
27346
27372
|
/**
|
|
27347
27373
|
* License service.
|
|
27348
27374
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27349
|
-
* @version
|
|
27375
|
+
* @version 158.0.0
|
|
27350
27376
|
*/
|
|
27351
27377
|
|
|
27352
27378
|
/**
|
|
@@ -27584,7 +27610,7 @@ class LocationsApi {
|
|
|
27584
27610
|
/**
|
|
27585
27611
|
* Locations service.
|
|
27586
27612
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27587
|
-
* @version
|
|
27613
|
+
* @version 158.0.0
|
|
27588
27614
|
*/
|
|
27589
27615
|
|
|
27590
27616
|
/**
|
|
@@ -27820,7 +27846,7 @@ class MessagingApi {
|
|
|
27820
27846
|
/**
|
|
27821
27847
|
* Messaging service.
|
|
27822
27848
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27823
|
-
* @version
|
|
27849
|
+
* @version 158.0.0
|
|
27824
27850
|
*/
|
|
27825
27851
|
|
|
27826
27852
|
/**
|
|
@@ -27971,7 +27997,7 @@ class MobileDevicesApi {
|
|
|
27971
27997
|
/**
|
|
27972
27998
|
* MobileDevices service.
|
|
27973
27999
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27974
|
-
* @version
|
|
28000
|
+
* @version 158.0.0
|
|
27975
28001
|
*/
|
|
27976
28002
|
|
|
27977
28003
|
/**
|
|
@@ -28122,7 +28148,7 @@ class NotificationsApi {
|
|
|
28122
28148
|
/**
|
|
28123
28149
|
* Notifications service.
|
|
28124
28150
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
28125
|
-
* @version
|
|
28151
|
+
* @version 158.0.0
|
|
28126
28152
|
*/
|
|
28127
28153
|
|
|
28128
28154
|
/**
|
|
@@ -28347,7 +28373,7 @@ class OAuthApi {
|
|
|
28347
28373
|
/**
|
|
28348
28374
|
* OAuth service.
|
|
28349
28375
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28350
|
-
* @version
|
|
28376
|
+
* @version 158.0.0
|
|
28351
28377
|
*/
|
|
28352
28378
|
|
|
28353
28379
|
/**
|
|
@@ -28713,7 +28739,7 @@ class ObjectsApi {
|
|
|
28713
28739
|
/**
|
|
28714
28740
|
* Objects service.
|
|
28715
28741
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28716
|
-
* @version
|
|
28742
|
+
* @version 158.0.0
|
|
28717
28743
|
*/
|
|
28718
28744
|
|
|
28719
28745
|
/**
|
|
@@ -28984,7 +29010,7 @@ class OrganizationApi {
|
|
|
28984
29010
|
/**
|
|
28985
29011
|
* Organization service.
|
|
28986
29012
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28987
|
-
* @version
|
|
29013
|
+
* @version 158.0.0
|
|
28988
29014
|
*/
|
|
28989
29015
|
|
|
28990
29016
|
/**
|
|
@@ -29387,7 +29413,7 @@ class OrganizationAuthorizationApi {
|
|
|
29387
29413
|
/**
|
|
29388
29414
|
* OrganizationAuthorization service.
|
|
29389
29415
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29390
|
-
* @version
|
|
29416
|
+
* @version 158.0.0
|
|
29391
29417
|
*/
|
|
29392
29418
|
|
|
29393
29419
|
/**
|
|
@@ -29457,6 +29483,66 @@ class OrganizationAuthorizationApi {
|
|
|
29457
29483
|
);
|
|
29458
29484
|
}
|
|
29459
29485
|
|
|
29486
|
+
/**
|
|
29487
|
+
* Delete Trustee Group
|
|
29488
|
+
*
|
|
29489
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
29490
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
29491
|
+
*/
|
|
29492
|
+
deleteOrgauthorizationTrusteeGroup(trusteeOrgId, trusteeGroupId) {
|
|
29493
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
29494
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
29495
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeGroup';
|
|
29496
|
+
}
|
|
29497
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
29498
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
29499
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling deleteOrgauthorizationTrusteeGroup';
|
|
29500
|
+
}
|
|
29501
|
+
|
|
29502
|
+
return this.apiClient.callApi(
|
|
29503
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}',
|
|
29504
|
+
'DELETE',
|
|
29505
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
29506
|
+
{ },
|
|
29507
|
+
{ },
|
|
29508
|
+
{ },
|
|
29509
|
+
null,
|
|
29510
|
+
['PureCloud OAuth'],
|
|
29511
|
+
['application/json'],
|
|
29512
|
+
['application/json']
|
|
29513
|
+
);
|
|
29514
|
+
}
|
|
29515
|
+
|
|
29516
|
+
/**
|
|
29517
|
+
* Delete Trustee Group Roles
|
|
29518
|
+
*
|
|
29519
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
29520
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
29521
|
+
*/
|
|
29522
|
+
deleteOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId) {
|
|
29523
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
29524
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
29525
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeGroupRoles';
|
|
29526
|
+
}
|
|
29527
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
29528
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
29529
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling deleteOrgauthorizationTrusteeGroupRoles';
|
|
29530
|
+
}
|
|
29531
|
+
|
|
29532
|
+
return this.apiClient.callApi(
|
|
29533
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles',
|
|
29534
|
+
'DELETE',
|
|
29535
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
29536
|
+
{ },
|
|
29537
|
+
{ },
|
|
29538
|
+
{ },
|
|
29539
|
+
null,
|
|
29540
|
+
['PureCloud OAuth'],
|
|
29541
|
+
['application/json'],
|
|
29542
|
+
['application/json']
|
|
29543
|
+
);
|
|
29544
|
+
}
|
|
29545
|
+
|
|
29460
29546
|
/**
|
|
29461
29547
|
* Delete Trustee User
|
|
29462
29548
|
*
|
|
@@ -29572,6 +29658,36 @@ class OrganizationAuthorizationApi {
|
|
|
29572
29658
|
);
|
|
29573
29659
|
}
|
|
29574
29660
|
|
|
29661
|
+
/**
|
|
29662
|
+
* Delete Trustee Group
|
|
29663
|
+
*
|
|
29664
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
29665
|
+
* @param {String} trustorGroupId Trustor Group Id
|
|
29666
|
+
*/
|
|
29667
|
+
deleteOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId) {
|
|
29668
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
29669
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
29670
|
+
throw 'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorGroup';
|
|
29671
|
+
}
|
|
29672
|
+
// verify the required parameter 'trustorGroupId' is set
|
|
29673
|
+
if (trustorGroupId === undefined || trustorGroupId === null) {
|
|
29674
|
+
throw 'Missing the required parameter "trustorGroupId" when calling deleteOrgauthorizationTrustorGroup';
|
|
29675
|
+
}
|
|
29676
|
+
|
|
29677
|
+
return this.apiClient.callApi(
|
|
29678
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}',
|
|
29679
|
+
'DELETE',
|
|
29680
|
+
{ 'trustorOrgId': trustorOrgId,'trustorGroupId': trustorGroupId },
|
|
29681
|
+
{ },
|
|
29682
|
+
{ },
|
|
29683
|
+
{ },
|
|
29684
|
+
null,
|
|
29685
|
+
['PureCloud OAuth'],
|
|
29686
|
+
['application/json'],
|
|
29687
|
+
['application/json']
|
|
29688
|
+
);
|
|
29689
|
+
}
|
|
29690
|
+
|
|
29575
29691
|
/**
|
|
29576
29692
|
* Delete Trustee User
|
|
29577
29693
|
*
|
|
@@ -29677,6 +29793,96 @@ class OrganizationAuthorizationApi {
|
|
|
29677
29793
|
);
|
|
29678
29794
|
}
|
|
29679
29795
|
|
|
29796
|
+
/**
|
|
29797
|
+
* Get Trustee Group
|
|
29798
|
+
*
|
|
29799
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
29800
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
29801
|
+
*/
|
|
29802
|
+
getOrgauthorizationTrusteeGroup(trusteeOrgId, trusteeGroupId) {
|
|
29803
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
29804
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
29805
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroup';
|
|
29806
|
+
}
|
|
29807
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
29808
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
29809
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling getOrgauthorizationTrusteeGroup';
|
|
29810
|
+
}
|
|
29811
|
+
|
|
29812
|
+
return this.apiClient.callApi(
|
|
29813
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}',
|
|
29814
|
+
'GET',
|
|
29815
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
29816
|
+
{ },
|
|
29817
|
+
{ },
|
|
29818
|
+
{ },
|
|
29819
|
+
null,
|
|
29820
|
+
['PureCloud OAuth'],
|
|
29821
|
+
['application/json'],
|
|
29822
|
+
['application/json']
|
|
29823
|
+
);
|
|
29824
|
+
}
|
|
29825
|
+
|
|
29826
|
+
/**
|
|
29827
|
+
* Get Trustee Group Roles
|
|
29828
|
+
*
|
|
29829
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
29830
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
29831
|
+
*/
|
|
29832
|
+
getOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId) {
|
|
29833
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
29834
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
29835
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroupRoles';
|
|
29836
|
+
}
|
|
29837
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
29838
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
29839
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling getOrgauthorizationTrusteeGroupRoles';
|
|
29840
|
+
}
|
|
29841
|
+
|
|
29842
|
+
return this.apiClient.callApi(
|
|
29843
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles',
|
|
29844
|
+
'GET',
|
|
29845
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
29846
|
+
{ },
|
|
29847
|
+
{ },
|
|
29848
|
+
{ },
|
|
29849
|
+
null,
|
|
29850
|
+
['PureCloud OAuth'],
|
|
29851
|
+
['application/json'],
|
|
29852
|
+
['application/json']
|
|
29853
|
+
);
|
|
29854
|
+
}
|
|
29855
|
+
|
|
29856
|
+
/**
|
|
29857
|
+
* The list of trustee groups for this organization (i.e. groups granted access to this organization).
|
|
29858
|
+
*
|
|
29859
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
29860
|
+
* @param {Object} opts Optional parameters
|
|
29861
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
29862
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
29863
|
+
*/
|
|
29864
|
+
getOrgauthorizationTrusteeGroups(trusteeOrgId, opts) {
|
|
29865
|
+
opts = opts || {};
|
|
29866
|
+
|
|
29867
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
29868
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
29869
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroups';
|
|
29870
|
+
}
|
|
29871
|
+
|
|
29872
|
+
return this.apiClient.callApi(
|
|
29873
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups',
|
|
29874
|
+
'GET',
|
|
29875
|
+
{ 'trusteeOrgId': trusteeOrgId },
|
|
29876
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
29877
|
+
{ },
|
|
29878
|
+
{ },
|
|
29879
|
+
null,
|
|
29880
|
+
['PureCloud OAuth'],
|
|
29881
|
+
['application/json'],
|
|
29882
|
+
['application/json']
|
|
29883
|
+
);
|
|
29884
|
+
}
|
|
29885
|
+
|
|
29680
29886
|
/**
|
|
29681
29887
|
* Get Trustee User
|
|
29682
29888
|
*
|
|
@@ -29892,6 +30098,66 @@ class OrganizationAuthorizationApi {
|
|
|
29892
30098
|
);
|
|
29893
30099
|
}
|
|
29894
30100
|
|
|
30101
|
+
/**
|
|
30102
|
+
* Get Trustee Group
|
|
30103
|
+
*
|
|
30104
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
30105
|
+
* @param {String} trustorGroupId Trustor Group Id
|
|
30106
|
+
*/
|
|
30107
|
+
getOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId) {
|
|
30108
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
30109
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
30110
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorGroup';
|
|
30111
|
+
}
|
|
30112
|
+
// verify the required parameter 'trustorGroupId' is set
|
|
30113
|
+
if (trustorGroupId === undefined || trustorGroupId === null) {
|
|
30114
|
+
throw 'Missing the required parameter "trustorGroupId" when calling getOrgauthorizationTrustorGroup';
|
|
30115
|
+
}
|
|
30116
|
+
|
|
30117
|
+
return this.apiClient.callApi(
|
|
30118
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}',
|
|
30119
|
+
'GET',
|
|
30120
|
+
{ 'trustorOrgId': trustorOrgId,'trustorGroupId': trustorGroupId },
|
|
30121
|
+
{ },
|
|
30122
|
+
{ },
|
|
30123
|
+
{ },
|
|
30124
|
+
null,
|
|
30125
|
+
['PureCloud OAuth'],
|
|
30126
|
+
['application/json'],
|
|
30127
|
+
['application/json']
|
|
30128
|
+
);
|
|
30129
|
+
}
|
|
30130
|
+
|
|
30131
|
+
/**
|
|
30132
|
+
* The list of groups in the trustor organization (i.e. groups granted access).
|
|
30133
|
+
*
|
|
30134
|
+
* @param {String} trustorOrgId Trustee Organization Id
|
|
30135
|
+
* @param {Object} opts Optional parameters
|
|
30136
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
30137
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
30138
|
+
*/
|
|
30139
|
+
getOrgauthorizationTrustorGroups(trustorOrgId, opts) {
|
|
30140
|
+
opts = opts || {};
|
|
30141
|
+
|
|
30142
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
30143
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
30144
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorGroups';
|
|
30145
|
+
}
|
|
30146
|
+
|
|
30147
|
+
return this.apiClient.callApi(
|
|
30148
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/groups',
|
|
30149
|
+
'GET',
|
|
30150
|
+
{ 'trustorOrgId': trustorOrgId },
|
|
30151
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
30152
|
+
{ },
|
|
30153
|
+
{ },
|
|
30154
|
+
null,
|
|
30155
|
+
['PureCloud OAuth'],
|
|
30156
|
+
['application/json'],
|
|
30157
|
+
['application/json']
|
|
30158
|
+
);
|
|
30159
|
+
}
|
|
30160
|
+
|
|
29895
30161
|
/**
|
|
29896
30162
|
* Get Trustee User
|
|
29897
30163
|
*
|
|
@@ -30002,6 +30268,36 @@ class OrganizationAuthorizationApi {
|
|
|
30002
30268
|
);
|
|
30003
30269
|
}
|
|
30004
30270
|
|
|
30271
|
+
/**
|
|
30272
|
+
* Add a group to the trust.
|
|
30273
|
+
*
|
|
30274
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
30275
|
+
* @param {Object} body Trust
|
|
30276
|
+
*/
|
|
30277
|
+
postOrgauthorizationTrusteeGroups(trusteeOrgId, body) {
|
|
30278
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
30279
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
30280
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling postOrgauthorizationTrusteeGroups';
|
|
30281
|
+
}
|
|
30282
|
+
// verify the required parameter 'body' is set
|
|
30283
|
+
if (body === undefined || body === null) {
|
|
30284
|
+
throw 'Missing the required parameter "body" when calling postOrgauthorizationTrusteeGroups';
|
|
30285
|
+
}
|
|
30286
|
+
|
|
30287
|
+
return this.apiClient.callApi(
|
|
30288
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups',
|
|
30289
|
+
'POST',
|
|
30290
|
+
{ 'trusteeOrgId': trusteeOrgId },
|
|
30291
|
+
{ },
|
|
30292
|
+
{ },
|
|
30293
|
+
{ },
|
|
30294
|
+
body,
|
|
30295
|
+
['PureCloud OAuth'],
|
|
30296
|
+
['application/json'],
|
|
30297
|
+
['application/json']
|
|
30298
|
+
);
|
|
30299
|
+
}
|
|
30300
|
+
|
|
30005
30301
|
/**
|
|
30006
30302
|
* Add a user to the trust.
|
|
30007
30303
|
*
|
|
@@ -30176,6 +30472,76 @@ class OrganizationAuthorizationApi {
|
|
|
30176
30472
|
);
|
|
30177
30473
|
}
|
|
30178
30474
|
|
|
30475
|
+
/**
|
|
30476
|
+
* Update Trustee Group Roles
|
|
30477
|
+
*
|
|
30478
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
30479
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
30480
|
+
* @param {Object} body Set of roles with corresponding divisions to apply
|
|
30481
|
+
*/
|
|
30482
|
+
putOrgauthorizationTrusteeGroupRoledivisions(trusteeOrgId, trusteeGroupId, body) {
|
|
30483
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
30484
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
30485
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeGroupRoledivisions';
|
|
30486
|
+
}
|
|
30487
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
30488
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
30489
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling putOrgauthorizationTrusteeGroupRoledivisions';
|
|
30490
|
+
}
|
|
30491
|
+
// verify the required parameter 'body' is set
|
|
30492
|
+
if (body === undefined || body === null) {
|
|
30493
|
+
throw 'Missing the required parameter "body" when calling putOrgauthorizationTrusteeGroupRoledivisions';
|
|
30494
|
+
}
|
|
30495
|
+
|
|
30496
|
+
return this.apiClient.callApi(
|
|
30497
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roledivisions',
|
|
30498
|
+
'PUT',
|
|
30499
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
30500
|
+
{ },
|
|
30501
|
+
{ },
|
|
30502
|
+
{ },
|
|
30503
|
+
body,
|
|
30504
|
+
['PureCloud OAuth'],
|
|
30505
|
+
['application/json'],
|
|
30506
|
+
['application/json']
|
|
30507
|
+
);
|
|
30508
|
+
}
|
|
30509
|
+
|
|
30510
|
+
/**
|
|
30511
|
+
* Update Trustee Group Roles
|
|
30512
|
+
*
|
|
30513
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
30514
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
30515
|
+
* @param {Array.<String>} body List of roles
|
|
30516
|
+
*/
|
|
30517
|
+
putOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId, body) {
|
|
30518
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
30519
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
30520
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeGroupRoles';
|
|
30521
|
+
}
|
|
30522
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
30523
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
30524
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling putOrgauthorizationTrusteeGroupRoles';
|
|
30525
|
+
}
|
|
30526
|
+
// verify the required parameter 'body' is set
|
|
30527
|
+
if (body === undefined || body === null) {
|
|
30528
|
+
throw 'Missing the required parameter "body" when calling putOrgauthorizationTrusteeGroupRoles';
|
|
30529
|
+
}
|
|
30530
|
+
|
|
30531
|
+
return this.apiClient.callApi(
|
|
30532
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles',
|
|
30533
|
+
'PUT',
|
|
30534
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
30535
|
+
{ },
|
|
30536
|
+
{ },
|
|
30537
|
+
{ },
|
|
30538
|
+
body,
|
|
30539
|
+
['PureCloud OAuth'],
|
|
30540
|
+
['application/json'],
|
|
30541
|
+
['application/json']
|
|
30542
|
+
);
|
|
30543
|
+
}
|
|
30544
|
+
|
|
30179
30545
|
/**
|
|
30180
30546
|
* Update Trustee User Roles
|
|
30181
30547
|
*
|
|
@@ -30276,6 +30642,36 @@ class OrganizationAuthorizationApi {
|
|
|
30276
30642
|
);
|
|
30277
30643
|
}
|
|
30278
30644
|
|
|
30645
|
+
/**
|
|
30646
|
+
* Add a Trustee Group to the trust.
|
|
30647
|
+
*
|
|
30648
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
30649
|
+
* @param {String} trustorGroupId Trustor Group Id
|
|
30650
|
+
*/
|
|
30651
|
+
putOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId) {
|
|
30652
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
30653
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
30654
|
+
throw 'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorGroup';
|
|
30655
|
+
}
|
|
30656
|
+
// verify the required parameter 'trustorGroupId' is set
|
|
30657
|
+
if (trustorGroupId === undefined || trustorGroupId === null) {
|
|
30658
|
+
throw 'Missing the required parameter "trustorGroupId" when calling putOrgauthorizationTrustorGroup';
|
|
30659
|
+
}
|
|
30660
|
+
|
|
30661
|
+
return this.apiClient.callApi(
|
|
30662
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}',
|
|
30663
|
+
'PUT',
|
|
30664
|
+
{ 'trustorOrgId': trustorOrgId,'trustorGroupId': trustorGroupId },
|
|
30665
|
+
{ },
|
|
30666
|
+
{ },
|
|
30667
|
+
{ },
|
|
30668
|
+
null,
|
|
30669
|
+
['PureCloud OAuth'],
|
|
30670
|
+
['application/json'],
|
|
30671
|
+
['application/json']
|
|
30672
|
+
);
|
|
30673
|
+
}
|
|
30674
|
+
|
|
30279
30675
|
/**
|
|
30280
30676
|
* Add a Trustee user to the trust.
|
|
30281
30677
|
*
|
|
@@ -30312,7 +30708,7 @@ class OutboundApi {
|
|
|
30312
30708
|
/**
|
|
30313
30709
|
* Outbound service.
|
|
30314
30710
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30315
|
-
* @version
|
|
30711
|
+
* @version 158.0.0
|
|
30316
30712
|
*/
|
|
30317
30713
|
|
|
30318
30714
|
/**
|
|
@@ -33849,7 +34245,7 @@ class PresenceApi {
|
|
|
33849
34245
|
/**
|
|
33850
34246
|
* Presence service.
|
|
33851
34247
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33852
|
-
* @version
|
|
34248
|
+
* @version 158.0.0
|
|
33853
34249
|
*/
|
|
33854
34250
|
|
|
33855
34251
|
/**
|
|
@@ -34355,7 +34751,7 @@ class ProcessAutomationApi {
|
|
|
34355
34751
|
/**
|
|
34356
34752
|
* ProcessAutomation service.
|
|
34357
34753
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34358
|
-
* @version
|
|
34754
|
+
* @version 158.0.0
|
|
34359
34755
|
*/
|
|
34360
34756
|
|
|
34361
34757
|
/**
|
|
@@ -34594,7 +34990,7 @@ class QualityApi {
|
|
|
34594
34990
|
/**
|
|
34595
34991
|
* Quality service.
|
|
34596
34992
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34597
|
-
* @version
|
|
34993
|
+
* @version 158.0.0
|
|
34598
34994
|
*/
|
|
34599
34995
|
|
|
34600
34996
|
/**
|
|
@@ -36172,7 +36568,7 @@ class RecordingApi {
|
|
|
36172
36568
|
/**
|
|
36173
36569
|
* Recording service.
|
|
36174
36570
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
36175
|
-
* @version
|
|
36571
|
+
* @version 158.0.0
|
|
36176
36572
|
*/
|
|
36177
36573
|
|
|
36178
36574
|
/**
|
|
@@ -37909,7 +38305,7 @@ class ResponseManagementApi {
|
|
|
37909
38305
|
/**
|
|
37910
38306
|
* ResponseManagement service.
|
|
37911
38307
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37912
|
-
* @version
|
|
38308
|
+
* @version 158.0.0
|
|
37913
38309
|
*/
|
|
37914
38310
|
|
|
37915
38311
|
/**
|
|
@@ -38393,7 +38789,7 @@ class RoutingApi {
|
|
|
38393
38789
|
/**
|
|
38394
38790
|
* Routing service.
|
|
38395
38791
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38396
|
-
* @version
|
|
38792
|
+
* @version 158.0.0
|
|
38397
38793
|
*/
|
|
38398
38794
|
|
|
38399
38795
|
/**
|
|
@@ -41858,7 +42254,7 @@ class SCIMApi {
|
|
|
41858
42254
|
/**
|
|
41859
42255
|
* SCIM service.
|
|
41860
42256
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
41861
|
-
* @version
|
|
42257
|
+
* @version 158.0.0
|
|
41862
42258
|
*/
|
|
41863
42259
|
|
|
41864
42260
|
/**
|
|
@@ -42735,7 +43131,7 @@ class ScriptsApi {
|
|
|
42735
43131
|
/**
|
|
42736
43132
|
* Scripts service.
|
|
42737
43133
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
42738
|
-
* @version
|
|
43134
|
+
* @version 158.0.0
|
|
42739
43135
|
*/
|
|
42740
43136
|
|
|
42741
43137
|
/**
|
|
@@ -43154,7 +43550,7 @@ class SearchApi {
|
|
|
43154
43550
|
/**
|
|
43155
43551
|
* Search service.
|
|
43156
43552
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
43157
|
-
* @version
|
|
43553
|
+
* @version 158.0.0
|
|
43158
43554
|
*/
|
|
43159
43555
|
|
|
43160
43556
|
/**
|
|
@@ -43739,7 +44135,7 @@ class SpeechTextAnalyticsApi {
|
|
|
43739
44135
|
/**
|
|
43740
44136
|
* SpeechTextAnalytics service.
|
|
43741
44137
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
43742
|
-
* @version
|
|
44138
|
+
* @version 158.0.0
|
|
43743
44139
|
*/
|
|
43744
44140
|
|
|
43745
44141
|
/**
|
|
@@ -44593,7 +44989,7 @@ class StationsApi {
|
|
|
44593
44989
|
/**
|
|
44594
44990
|
* Stations service.
|
|
44595
44991
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
44596
|
-
* @version
|
|
44992
|
+
* @version 158.0.0
|
|
44597
44993
|
*/
|
|
44598
44994
|
|
|
44599
44995
|
/**
|
|
@@ -44691,7 +45087,7 @@ class StationsApi {
|
|
|
44691
45087
|
|
|
44692
45088
|
/**
|
|
44693
45089
|
* Get an organization's StationSettings
|
|
44694
|
-
*
|
|
45090
|
+
* This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
|
|
44695
45091
|
*/
|
|
44696
45092
|
getStationsSettings() {
|
|
44697
45093
|
|
|
@@ -44711,7 +45107,7 @@ class StationsApi {
|
|
|
44711
45107
|
|
|
44712
45108
|
/**
|
|
44713
45109
|
* Patch an organization's StationSettings
|
|
44714
|
-
*
|
|
45110
|
+
* This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
|
|
44715
45111
|
* @param {Object} body Station settings
|
|
44716
45112
|
*/
|
|
44717
45113
|
patchStationsSettings(body) {
|
|
@@ -44740,7 +45136,7 @@ class SuggestApi {
|
|
|
44740
45136
|
/**
|
|
44741
45137
|
* Suggest service.
|
|
44742
45138
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
44743
|
-
* @version
|
|
45139
|
+
* @version 158.0.0
|
|
44744
45140
|
*/
|
|
44745
45141
|
|
|
44746
45142
|
/**
|
|
@@ -44879,7 +45275,7 @@ class TeamsApi {
|
|
|
44879
45275
|
/**
|
|
44880
45276
|
* Teams service.
|
|
44881
45277
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
44882
|
-
* @version
|
|
45278
|
+
* @version 158.0.0
|
|
44883
45279
|
*/
|
|
44884
45280
|
|
|
44885
45281
|
/**
|
|
@@ -45150,7 +45546,7 @@ class TelephonyApi {
|
|
|
45150
45546
|
/**
|
|
45151
45547
|
* Telephony service.
|
|
45152
45548
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
45153
|
-
* @version
|
|
45549
|
+
* @version 158.0.0
|
|
45154
45550
|
*/
|
|
45155
45551
|
|
|
45156
45552
|
/**
|
|
@@ -45278,7 +45674,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
45278
45674
|
/**
|
|
45279
45675
|
* TelephonyProvidersEdge service.
|
|
45280
45676
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
45281
|
-
* @version
|
|
45677
|
+
* @version 158.0.0
|
|
45282
45678
|
*/
|
|
45283
45679
|
|
|
45284
45680
|
/**
|
|
@@ -48911,7 +49307,7 @@ class TextbotsApi {
|
|
|
48911
49307
|
/**
|
|
48912
49308
|
* Textbots service.
|
|
48913
49309
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
48914
|
-
* @version
|
|
49310
|
+
* @version 158.0.0
|
|
48915
49311
|
*/
|
|
48916
49312
|
|
|
48917
49313
|
/**
|
|
@@ -49039,7 +49435,7 @@ class TokensApi {
|
|
|
49039
49435
|
/**
|
|
49040
49436
|
* Tokens service.
|
|
49041
49437
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
49042
|
-
* @version
|
|
49438
|
+
* @version 158.0.0
|
|
49043
49439
|
*/
|
|
49044
49440
|
|
|
49045
49441
|
/**
|
|
@@ -49145,7 +49541,7 @@ class UploadsApi {
|
|
|
49145
49541
|
/**
|
|
49146
49542
|
* Uploads service.
|
|
49147
49543
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
49148
|
-
* @version
|
|
49544
|
+
* @version 158.0.0
|
|
49149
49545
|
*/
|
|
49150
49546
|
|
|
49151
49547
|
/**
|
|
@@ -49321,7 +49717,7 @@ class UsageApi {
|
|
|
49321
49717
|
/**
|
|
49322
49718
|
* Usage service.
|
|
49323
49719
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
49324
|
-
* @version
|
|
49720
|
+
* @version 158.0.0
|
|
49325
49721
|
*/
|
|
49326
49722
|
|
|
49327
49723
|
/**
|
|
@@ -49392,7 +49788,7 @@ class UserRecordingsApi {
|
|
|
49392
49788
|
/**
|
|
49393
49789
|
* UserRecordings service.
|
|
49394
49790
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
49395
|
-
* @version
|
|
49791
|
+
* @version 158.0.0
|
|
49396
49792
|
*/
|
|
49397
49793
|
|
|
49398
49794
|
/**
|
|
@@ -49577,7 +49973,7 @@ class UsersApi {
|
|
|
49577
49973
|
/**
|
|
49578
49974
|
* Users service.
|
|
49579
49975
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49580
|
-
* @version
|
|
49976
|
+
* @version 158.0.0
|
|
49581
49977
|
*/
|
|
49582
49978
|
|
|
49583
49979
|
/**
|
|
@@ -51934,7 +52330,7 @@ class UtilitiesApi {
|
|
|
51934
52330
|
/**
|
|
51935
52331
|
* Utilities service.
|
|
51936
52332
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
51937
|
-
* @version
|
|
52333
|
+
* @version 158.0.0
|
|
51938
52334
|
*/
|
|
51939
52335
|
|
|
51940
52336
|
/**
|
|
@@ -52045,7 +52441,7 @@ class VoicemailApi {
|
|
|
52045
52441
|
/**
|
|
52046
52442
|
* Voicemail service.
|
|
52047
52443
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
52048
|
-
* @version
|
|
52444
|
+
* @version 158.0.0
|
|
52049
52445
|
*/
|
|
52050
52446
|
|
|
52051
52447
|
/**
|
|
@@ -52712,7 +53108,7 @@ class WebChatApi {
|
|
|
52712
53108
|
/**
|
|
52713
53109
|
* WebChat service.
|
|
52714
53110
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
52715
|
-
* @version
|
|
53111
|
+
* @version 158.0.0
|
|
52716
53112
|
*/
|
|
52717
53113
|
|
|
52718
53114
|
/**
|
|
@@ -53256,7 +53652,7 @@ class WebDeploymentsApi {
|
|
|
53256
53652
|
/**
|
|
53257
53653
|
* WebDeployments service.
|
|
53258
53654
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
53259
|
-
* @version
|
|
53655
|
+
* @version 158.0.0
|
|
53260
53656
|
*/
|
|
53261
53657
|
|
|
53262
53658
|
/**
|
|
@@ -53321,6 +53717,36 @@ class WebDeploymentsApi {
|
|
|
53321
53717
|
);
|
|
53322
53718
|
}
|
|
53323
53719
|
|
|
53720
|
+
/**
|
|
53721
|
+
* Deletes a cobrowse session
|
|
53722
|
+
*
|
|
53723
|
+
* @param {String} deploymentId WebMessaging deployment ID
|
|
53724
|
+
* @param {String} sessionId Cobrowse session id or join code
|
|
53725
|
+
*/
|
|
53726
|
+
deleteWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId) {
|
|
53727
|
+
// verify the required parameter 'deploymentId' is set
|
|
53728
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
53729
|
+
throw 'Missing the required parameter "deploymentId" when calling deleteWebdeploymentsDeploymentCobrowseSessionId';
|
|
53730
|
+
}
|
|
53731
|
+
// verify the required parameter 'sessionId' is set
|
|
53732
|
+
if (sessionId === undefined || sessionId === null) {
|
|
53733
|
+
throw 'Missing the required parameter "sessionId" when calling deleteWebdeploymentsDeploymentCobrowseSessionId';
|
|
53734
|
+
}
|
|
53735
|
+
|
|
53736
|
+
return this.apiClient.callApi(
|
|
53737
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}',
|
|
53738
|
+
'DELETE',
|
|
53739
|
+
{ 'deploymentId': deploymentId,'sessionId': sessionId },
|
|
53740
|
+
{ },
|
|
53741
|
+
{ },
|
|
53742
|
+
{ },
|
|
53743
|
+
null,
|
|
53744
|
+
['PureCloud OAuth'],
|
|
53745
|
+
['application/json'],
|
|
53746
|
+
['application/json']
|
|
53747
|
+
);
|
|
53748
|
+
}
|
|
53749
|
+
|
|
53324
53750
|
/**
|
|
53325
53751
|
* Invalidate JWT
|
|
53326
53752
|
*
|
|
@@ -53475,6 +53901,36 @@ class WebDeploymentsApi {
|
|
|
53475
53901
|
);
|
|
53476
53902
|
}
|
|
53477
53903
|
|
|
53904
|
+
/**
|
|
53905
|
+
* Retrieves a cobrowse session
|
|
53906
|
+
*
|
|
53907
|
+
* @param {String} deploymentId WebMessaging deployment ID
|
|
53908
|
+
* @param {String} sessionId Cobrowse session id or join code
|
|
53909
|
+
*/
|
|
53910
|
+
getWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId) {
|
|
53911
|
+
// verify the required parameter 'deploymentId' is set
|
|
53912
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
53913
|
+
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentCobrowseSessionId';
|
|
53914
|
+
}
|
|
53915
|
+
// verify the required parameter 'sessionId' is set
|
|
53916
|
+
if (sessionId === undefined || sessionId === null) {
|
|
53917
|
+
throw 'Missing the required parameter "sessionId" when calling getWebdeploymentsDeploymentCobrowseSessionId';
|
|
53918
|
+
}
|
|
53919
|
+
|
|
53920
|
+
return this.apiClient.callApi(
|
|
53921
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}',
|
|
53922
|
+
'GET',
|
|
53923
|
+
{ 'deploymentId': deploymentId,'sessionId': sessionId },
|
|
53924
|
+
{ },
|
|
53925
|
+
{ },
|
|
53926
|
+
{ },
|
|
53927
|
+
null,
|
|
53928
|
+
['PureCloud OAuth'],
|
|
53929
|
+
['application/json'],
|
|
53930
|
+
['application/json']
|
|
53931
|
+
);
|
|
53932
|
+
}
|
|
53933
|
+
|
|
53478
53934
|
/**
|
|
53479
53935
|
* Get active configuration for a given deployment
|
|
53480
53936
|
*
|
|
@@ -53718,7 +54174,7 @@ class WebMessagingApi {
|
|
|
53718
54174
|
/**
|
|
53719
54175
|
* WebMessaging service.
|
|
53720
54176
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
53721
|
-
* @version
|
|
54177
|
+
* @version 158.0.0
|
|
53722
54178
|
*/
|
|
53723
54179
|
|
|
53724
54180
|
/**
|
|
@@ -53764,7 +54220,7 @@ class WidgetsApi {
|
|
|
53764
54220
|
/**
|
|
53765
54221
|
* Widgets service.
|
|
53766
54222
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
53767
|
-
* @version
|
|
54223
|
+
* @version 158.0.0
|
|
53768
54224
|
*/
|
|
53769
54225
|
|
|
53770
54226
|
/**
|
|
@@ -53910,7 +54366,7 @@ class WorkforceManagementApi {
|
|
|
53910
54366
|
/**
|
|
53911
54367
|
* WorkforceManagement service.
|
|
53912
54368
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
53913
|
-
* @version
|
|
54369
|
+
* @version 158.0.0
|
|
53914
54370
|
*/
|
|
53915
54371
|
|
|
53916
54372
|
/**
|
|
@@ -58629,7 +59085,7 @@ class WorkforceManagementApi {
|
|
|
58629
59085
|
* </pre>
|
|
58630
59086
|
* </p>
|
|
58631
59087
|
* @module purecloud-platform-client-v2/index
|
|
58632
|
-
* @version
|
|
59088
|
+
* @version 158.0.0
|
|
58633
59089
|
*/
|
|
58634
59090
|
class platformClient {
|
|
58635
59091
|
constructor() {
|