purecloud-platform-client-v2 157.0.0 → 159.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 +631 -80
- package/dist/web-amd/purecloud-platform-client-v2.js +631 -80
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +631 -80
- package/dist/web-cjs/purecloud-platform-client-v2.js +641 -80
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +214 -3
- 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 +95 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +2 -3
- 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 +5 -4
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +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 +3 -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 +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
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 159.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1478,7 +1478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1478
1478
|
/**
|
|
1479
1479
|
* Alerting service.
|
|
1480
1480
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1481
|
-
* @version
|
|
1481
|
+
* @version 159.0.0
|
|
1482
1482
|
*/
|
|
1483
1483
|
|
|
1484
1484
|
/**
|
|
@@ -1792,7 +1792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1792
1792
|
/**
|
|
1793
1793
|
* Analytics service.
|
|
1794
1794
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1795
|
-
* @version
|
|
1795
|
+
* @version 159.0.0
|
|
1796
1796
|
*/
|
|
1797
1797
|
|
|
1798
1798
|
/**
|
|
@@ -3046,7 +3046,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3046
3046
|
/**
|
|
3047
3047
|
* Architect service.
|
|
3048
3048
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3049
|
-
* @version
|
|
3049
|
+
* @version 159.0.0
|
|
3050
3050
|
*/
|
|
3051
3051
|
|
|
3052
3052
|
/**
|
|
@@ -6094,7 +6094,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6094
6094
|
/**
|
|
6095
6095
|
* Audit service.
|
|
6096
6096
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6097
|
-
* @version
|
|
6097
|
+
* @version 159.0.0
|
|
6098
6098
|
*/
|
|
6099
6099
|
|
|
6100
6100
|
/**
|
|
@@ -6265,7 +6265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6265
6265
|
/**
|
|
6266
6266
|
* Authorization service.
|
|
6267
6267
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6268
|
-
* @version
|
|
6268
|
+
* @version 159.0.0
|
|
6269
6269
|
*/
|
|
6270
6270
|
|
|
6271
6271
|
/**
|
|
@@ -7493,7 +7493,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7493
7493
|
/**
|
|
7494
7494
|
* Billing service.
|
|
7495
7495
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7496
|
-
* @version
|
|
7496
|
+
* @version 159.0.0
|
|
7497
7497
|
*/
|
|
7498
7498
|
|
|
7499
7499
|
/**
|
|
@@ -7573,7 +7573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7573
7573
|
/**
|
|
7574
7574
|
* Chat service.
|
|
7575
7575
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7576
|
-
* @version
|
|
7576
|
+
* @version 159.0.0
|
|
7577
7577
|
*/
|
|
7578
7578
|
|
|
7579
7579
|
/**
|
|
@@ -7664,7 +7664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7664
7664
|
/**
|
|
7665
7665
|
* Coaching service.
|
|
7666
7666
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7667
|
-
* @version
|
|
7667
|
+
* @version 159.0.0
|
|
7668
7668
|
*/
|
|
7669
7669
|
|
|
7670
7670
|
/**
|
|
@@ -8241,7 +8241,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8241
8241
|
/**
|
|
8242
8242
|
* ContentManagement service.
|
|
8243
8243
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8244
|
-
* @version
|
|
8244
|
+
* @version 159.0.0
|
|
8245
8245
|
*/
|
|
8246
8246
|
|
|
8247
8247
|
/**
|
|
@@ -9381,7 +9381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9381
9381
|
/**
|
|
9382
9382
|
* Conversations service.
|
|
9383
9383
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9384
|
-
* @version
|
|
9384
|
+
* @version 159.0.0
|
|
9385
9385
|
*/
|
|
9386
9386
|
|
|
9387
9387
|
/**
|
|
@@ -12768,6 +12768,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12768
12768
|
);
|
|
12769
12769
|
}
|
|
12770
12770
|
|
|
12771
|
+
/**
|
|
12772
|
+
* Creates a cobrowse session. Requires conversation:cobrowse:add (for web messaging) or conversation:cobrowsevoice:add permission.
|
|
12773
|
+
*
|
|
12774
|
+
* @param {String} conversationId Conversation ID
|
|
12775
|
+
*/
|
|
12776
|
+
postConversationCobrowse(conversationId) {
|
|
12777
|
+
// verify the required parameter 'conversationId' is set
|
|
12778
|
+
if (conversationId === undefined || conversationId === null) {
|
|
12779
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCobrowse';
|
|
12780
|
+
}
|
|
12781
|
+
|
|
12782
|
+
return this.apiClient.callApi(
|
|
12783
|
+
'/api/v2/conversations/{conversationId}/cobrowse',
|
|
12784
|
+
'POST',
|
|
12785
|
+
{ 'conversationId': conversationId },
|
|
12786
|
+
{ },
|
|
12787
|
+
{ },
|
|
12788
|
+
{ },
|
|
12789
|
+
null,
|
|
12790
|
+
['PureCloud OAuth'],
|
|
12791
|
+
['application/json'],
|
|
12792
|
+
['application/json']
|
|
12793
|
+
);
|
|
12794
|
+
}
|
|
12795
|
+
|
|
12771
12796
|
/**
|
|
12772
12797
|
* 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.
|
|
12773
12798
|
*
|
|
@@ -14604,7 +14629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14604
14629
|
/**
|
|
14605
14630
|
* DataExtensions service.
|
|
14606
14631
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14607
|
-
* @version
|
|
14632
|
+
* @version 159.0.0
|
|
14608
14633
|
*/
|
|
14609
14634
|
|
|
14610
14635
|
/**
|
|
@@ -14690,7 +14715,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14690
14715
|
/**
|
|
14691
14716
|
* Downloads service.
|
|
14692
14717
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14693
|
-
* @version
|
|
14718
|
+
* @version 159.0.0
|
|
14694
14719
|
*/
|
|
14695
14720
|
|
|
14696
14721
|
/**
|
|
@@ -14742,7 +14767,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14742
14767
|
/**
|
|
14743
14768
|
* Events service.
|
|
14744
14769
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14745
|
-
* @version
|
|
14770
|
+
* @version 159.0.0
|
|
14746
14771
|
*/
|
|
14747
14772
|
|
|
14748
14773
|
/**
|
|
@@ -14838,7 +14863,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14838
14863
|
/**
|
|
14839
14864
|
* ExternalContacts service.
|
|
14840
14865
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14841
|
-
* @version
|
|
14866
|
+
* @version 159.0.0
|
|
14842
14867
|
*/
|
|
14843
14868
|
|
|
14844
14869
|
/**
|
|
@@ -16796,7 +16821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16796
16821
|
/**
|
|
16797
16822
|
* Fax service.
|
|
16798
16823
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16799
|
-
* @version
|
|
16824
|
+
* @version 159.0.0
|
|
16800
16825
|
*/
|
|
16801
16826
|
|
|
16802
16827
|
/**
|
|
@@ -16967,7 +16992,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16967
16992
|
/**
|
|
16968
16993
|
* Flows service.
|
|
16969
16994
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16970
|
-
* @version
|
|
16995
|
+
* @version 159.0.0
|
|
16971
16996
|
*/
|
|
16972
16997
|
|
|
16973
16998
|
/**
|
|
@@ -17038,7 +17063,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17038
17063
|
/**
|
|
17039
17064
|
* Gamification service.
|
|
17040
17065
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
17041
|
-
* @version
|
|
17066
|
+
* @version 159.0.0
|
|
17042
17067
|
*/
|
|
17043
17068
|
|
|
17044
17069
|
/**
|
|
@@ -18655,7 +18680,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18655
18680
|
/**
|
|
18656
18681
|
* GeneralDataProtectionRegulation service.
|
|
18657
18682
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18658
|
-
* @version
|
|
18683
|
+
* @version 159.0.0
|
|
18659
18684
|
*/
|
|
18660
18685
|
|
|
18661
18686
|
/**
|
|
@@ -18785,7 +18810,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18785
18810
|
/**
|
|
18786
18811
|
* Geolocation service.
|
|
18787
18812
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18788
|
-
* @version
|
|
18813
|
+
* @version 159.0.0
|
|
18789
18814
|
*/
|
|
18790
18815
|
|
|
18791
18816
|
/**
|
|
@@ -18916,7 +18941,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18916
18941
|
/**
|
|
18917
18942
|
* Greetings service.
|
|
18918
18943
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18919
|
-
* @version
|
|
18944
|
+
* @version 159.0.0
|
|
18920
18945
|
*/
|
|
18921
18946
|
|
|
18922
18947
|
/**
|
|
@@ -19371,7 +19396,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19371
19396
|
/**
|
|
19372
19397
|
* Groups service.
|
|
19373
19398
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19374
|
-
* @version
|
|
19399
|
+
* @version 159.0.0
|
|
19375
19400
|
*/
|
|
19376
19401
|
|
|
19377
19402
|
/**
|
|
@@ -19777,7 +19802,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19777
19802
|
/**
|
|
19778
19803
|
* IdentityProvider service.
|
|
19779
19804
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19780
|
-
* @version
|
|
19805
|
+
* @version 159.0.0
|
|
19781
19806
|
*/
|
|
19782
19807
|
|
|
19783
19808
|
/**
|
|
@@ -20533,7 +20558,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20533
20558
|
/**
|
|
20534
20559
|
* Integrations service.
|
|
20535
20560
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20536
|
-
* @version
|
|
20561
|
+
* @version 159.0.0
|
|
20537
20562
|
*/
|
|
20538
20563
|
|
|
20539
20564
|
/**
|
|
@@ -22133,7 +22158,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22133
22158
|
/**
|
|
22134
22159
|
* Journey service.
|
|
22135
22160
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22136
|
-
* @version
|
|
22161
|
+
* @version 159.0.0
|
|
22137
22162
|
*/
|
|
22138
22163
|
|
|
22139
22164
|
/**
|
|
@@ -22227,6 +22252,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22227
22252
|
);
|
|
22228
22253
|
}
|
|
22229
22254
|
|
|
22255
|
+
/**
|
|
22256
|
+
* Delete an outcome predictor.
|
|
22257
|
+
*
|
|
22258
|
+
* @param {String} predictorId ID of predictor
|
|
22259
|
+
*/
|
|
22260
|
+
deleteJourneyOutcomesPredictor(predictorId) {
|
|
22261
|
+
// verify the required parameter 'predictorId' is set
|
|
22262
|
+
if (predictorId === undefined || predictorId === null) {
|
|
22263
|
+
throw 'Missing the required parameter "predictorId" when calling deleteJourneyOutcomesPredictor';
|
|
22264
|
+
}
|
|
22265
|
+
|
|
22266
|
+
return this.apiClient.callApi(
|
|
22267
|
+
'/api/v2/journey/outcomes/predictors/{predictorId}',
|
|
22268
|
+
'DELETE',
|
|
22269
|
+
{ 'predictorId': predictorId },
|
|
22270
|
+
{ },
|
|
22271
|
+
{ },
|
|
22272
|
+
{ },
|
|
22273
|
+
null,
|
|
22274
|
+
['PureCloud OAuth'],
|
|
22275
|
+
['application/json'],
|
|
22276
|
+
['application/json']
|
|
22277
|
+
);
|
|
22278
|
+
}
|
|
22279
|
+
|
|
22230
22280
|
/**
|
|
22231
22281
|
* Delete a segment.
|
|
22232
22282
|
*
|
|
@@ -22517,6 +22567,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22517
22567
|
);
|
|
22518
22568
|
}
|
|
22519
22569
|
|
|
22570
|
+
/**
|
|
22571
|
+
* Retrieve a single outcome predictor.
|
|
22572
|
+
*
|
|
22573
|
+
* @param {String} predictorId ID of predictor
|
|
22574
|
+
*/
|
|
22575
|
+
getJourneyOutcomesPredictor(predictorId) {
|
|
22576
|
+
// verify the required parameter 'predictorId' is set
|
|
22577
|
+
if (predictorId === undefined || predictorId === null) {
|
|
22578
|
+
throw 'Missing the required parameter "predictorId" when calling getJourneyOutcomesPredictor';
|
|
22579
|
+
}
|
|
22580
|
+
|
|
22581
|
+
return this.apiClient.callApi(
|
|
22582
|
+
'/api/v2/journey/outcomes/predictors/{predictorId}',
|
|
22583
|
+
'GET',
|
|
22584
|
+
{ 'predictorId': predictorId },
|
|
22585
|
+
{ },
|
|
22586
|
+
{ },
|
|
22587
|
+
{ },
|
|
22588
|
+
null,
|
|
22589
|
+
['PureCloud OAuth'],
|
|
22590
|
+
['application/json'],
|
|
22591
|
+
['application/json']
|
|
22592
|
+
);
|
|
22593
|
+
}
|
|
22594
|
+
|
|
22595
|
+
/**
|
|
22596
|
+
* Retrieve all outcome predictors.
|
|
22597
|
+
*
|
|
22598
|
+
*/
|
|
22599
|
+
getJourneyOutcomesPredictors() {
|
|
22600
|
+
|
|
22601
|
+
return this.apiClient.callApi(
|
|
22602
|
+
'/api/v2/journey/outcomes/predictors',
|
|
22603
|
+
'GET',
|
|
22604
|
+
{ },
|
|
22605
|
+
{ },
|
|
22606
|
+
{ },
|
|
22607
|
+
{ },
|
|
22608
|
+
null,
|
|
22609
|
+
['PureCloud OAuth'],
|
|
22610
|
+
['application/json'],
|
|
22611
|
+
['application/json']
|
|
22612
|
+
);
|
|
22613
|
+
}
|
|
22614
|
+
|
|
22520
22615
|
/**
|
|
22521
22616
|
* Retrieve a single segment.
|
|
22522
22617
|
*
|
|
@@ -22889,6 +22984,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22889
22984
|
);
|
|
22890
22985
|
}
|
|
22891
22986
|
|
|
22987
|
+
/**
|
|
22988
|
+
* Create an outcome predictor.
|
|
22989
|
+
*
|
|
22990
|
+
* @param {Object} opts Optional parameters
|
|
22991
|
+
* @param {Object} opts.body
|
|
22992
|
+
*/
|
|
22993
|
+
postJourneyOutcomesPredictors(opts) {
|
|
22994
|
+
opts = opts || {};
|
|
22995
|
+
|
|
22996
|
+
|
|
22997
|
+
return this.apiClient.callApi(
|
|
22998
|
+
'/api/v2/journey/outcomes/predictors',
|
|
22999
|
+
'POST',
|
|
23000
|
+
{ },
|
|
23001
|
+
{ },
|
|
23002
|
+
{ },
|
|
23003
|
+
{ },
|
|
23004
|
+
opts['body'],
|
|
23005
|
+
['PureCloud OAuth'],
|
|
23006
|
+
['application/json'],
|
|
23007
|
+
['application/json']
|
|
23008
|
+
);
|
|
23009
|
+
}
|
|
23010
|
+
|
|
22892
23011
|
/**
|
|
22893
23012
|
* Create a segment.
|
|
22894
23013
|
*
|
|
@@ -22919,7 +23038,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22919
23038
|
/**
|
|
22920
23039
|
* Knowledge service.
|
|
22921
23040
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22922
|
-
* @version
|
|
23041
|
+
* @version 159.0.0
|
|
22923
23042
|
*/
|
|
22924
23043
|
|
|
22925
23044
|
/**
|
|
@@ -23322,7 +23441,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23322
23441
|
* @param {String} sessionId Knowledge guest session ID.
|
|
23323
23442
|
* @param {Object} opts Optional parameters
|
|
23324
23443
|
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
23325
|
-
* @param {Boolean} opts.includeSubcategories Deprecated - Do Not Use. Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
23326
23444
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 10)
|
|
23327
23445
|
*/
|
|
23328
23446
|
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
@@ -23337,7 +23455,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23337
23455
|
'/api/v2/knowledge/guest/sessions/{sessionId}/documents',
|
|
23338
23456
|
'GET',
|
|
23339
23457
|
{ 'sessionId': sessionId },
|
|
23340
|
-
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'
|
|
23458
|
+
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'pageSize': opts['pageSize'] },
|
|
23341
23459
|
{ },
|
|
23342
23460
|
{ },
|
|
23343
23461
|
null,
|
|
@@ -25352,7 +25470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25352
25470
|
/**
|
|
25353
25471
|
* LanguageUnderstanding service.
|
|
25354
25472
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25355
|
-
* @version
|
|
25473
|
+
* @version 159.0.0
|
|
25356
25474
|
*/
|
|
25357
25475
|
|
|
25358
25476
|
/**
|
|
@@ -25546,6 +25664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25546
25664
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
25547
25665
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
25548
25666
|
* @param {Boolean} opts.enableCursorPagination Enable Cursor Pagination (default to false)
|
|
25667
|
+
* @param {Boolean} opts.includeTrainingUtterances Include Training Utterances. By default they're included. (default to true)
|
|
25549
25668
|
* @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
|
|
25550
25669
|
* @param {Array.<String>} opts.fields Fields and properties to get, comma-separated
|
|
25551
25670
|
*/
|
|
@@ -25561,7 +25680,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25561
25680
|
'/api/v2/languageunderstanding/domains/{domainId}/feedback',
|
|
25562
25681
|
'GET',
|
|
25563
25682
|
{ 'domainId': domainId },
|
|
25564
|
-
{ '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') },
|
|
25683
|
+
{ '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') },
|
|
25565
25684
|
{ },
|
|
25566
25685
|
{ },
|
|
25567
25686
|
null,
|
|
@@ -26364,7 +26483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26364
26483
|
/**
|
|
26365
26484
|
* Languages service.
|
|
26366
26485
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26367
|
-
* @version
|
|
26486
|
+
* @version 159.0.0
|
|
26368
26487
|
*/
|
|
26369
26488
|
|
|
26370
26489
|
/**
|
|
@@ -26582,7 +26701,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26582
26701
|
/**
|
|
26583
26702
|
* Learning service.
|
|
26584
26703
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26585
|
-
* @version
|
|
26704
|
+
* @version 159.0.0
|
|
26586
26705
|
*/
|
|
26587
26706
|
|
|
26588
26707
|
/**
|
|
@@ -26692,7 +26811,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26692
26811
|
* @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
26693
26812
|
* @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
|
|
26694
26813
|
* @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs.
|
|
26695
|
-
* @param {Array.<String>} opts.types Specifies the
|
|
26814
|
+
* @param {Array.<String>} opts.types Specifies the module types to filter by
|
|
26696
26815
|
* @param {Array.<String>} opts.states Specifies the assignment states to filter by
|
|
26697
26816
|
* @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
|
|
26698
26817
|
*/
|
|
@@ -26729,7 +26848,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26729
26848
|
* @param {Number} opts.maxPercentageScore The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)
|
|
26730
26849
|
* @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
26731
26850
|
* @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
|
|
26732
|
-
* @param {Array.<String>} opts.types Specifies the
|
|
26851
|
+
* @param {Array.<String>} opts.types Specifies the module types to filter by
|
|
26733
26852
|
* @param {Array.<String>} opts.states Specifies the assignment states to filter by
|
|
26734
26853
|
* @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
|
|
26735
26854
|
*/
|
|
@@ -27343,7 +27462,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27343
27462
|
/**
|
|
27344
27463
|
* License service.
|
|
27345
27464
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27346
|
-
* @version
|
|
27465
|
+
* @version 159.0.0
|
|
27347
27466
|
*/
|
|
27348
27467
|
|
|
27349
27468
|
/**
|
|
@@ -27581,7 +27700,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27581
27700
|
/**
|
|
27582
27701
|
* Locations service.
|
|
27583
27702
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27584
|
-
* @version
|
|
27703
|
+
* @version 159.0.0
|
|
27585
27704
|
*/
|
|
27586
27705
|
|
|
27587
27706
|
/**
|
|
@@ -27817,7 +27936,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27817
27936
|
/**
|
|
27818
27937
|
* Messaging service.
|
|
27819
27938
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27820
|
-
* @version
|
|
27939
|
+
* @version 159.0.0
|
|
27821
27940
|
*/
|
|
27822
27941
|
|
|
27823
27942
|
/**
|
|
@@ -27968,7 +28087,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27968
28087
|
/**
|
|
27969
28088
|
* MobileDevices service.
|
|
27970
28089
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27971
|
-
* @version
|
|
28090
|
+
* @version 159.0.0
|
|
27972
28091
|
*/
|
|
27973
28092
|
|
|
27974
28093
|
/**
|
|
@@ -28119,7 +28238,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28119
28238
|
/**
|
|
28120
28239
|
* Notifications service.
|
|
28121
28240
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
28122
|
-
* @version
|
|
28241
|
+
* @version 159.0.0
|
|
28123
28242
|
*/
|
|
28124
28243
|
|
|
28125
28244
|
/**
|
|
@@ -28344,7 +28463,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28344
28463
|
/**
|
|
28345
28464
|
* OAuth service.
|
|
28346
28465
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28347
|
-
* @version
|
|
28466
|
+
* @version 159.0.0
|
|
28348
28467
|
*/
|
|
28349
28468
|
|
|
28350
28469
|
/**
|
|
@@ -28710,7 +28829,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28710
28829
|
/**
|
|
28711
28830
|
* Objects service.
|
|
28712
28831
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28713
|
-
* @version
|
|
28832
|
+
* @version 159.0.0
|
|
28714
28833
|
*/
|
|
28715
28834
|
|
|
28716
28835
|
/**
|
|
@@ -28981,7 +29100,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28981
29100
|
/**
|
|
28982
29101
|
* Organization service.
|
|
28983
29102
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28984
|
-
* @version
|
|
29103
|
+
* @version 159.0.0
|
|
28985
29104
|
*/
|
|
28986
29105
|
|
|
28987
29106
|
/**
|
|
@@ -29384,7 +29503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29384
29503
|
/**
|
|
29385
29504
|
* OrganizationAuthorization service.
|
|
29386
29505
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29387
|
-
* @version
|
|
29506
|
+
* @version 159.0.0
|
|
29388
29507
|
*/
|
|
29389
29508
|
|
|
29390
29509
|
/**
|
|
@@ -29454,6 +29573,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29454
29573
|
);
|
|
29455
29574
|
}
|
|
29456
29575
|
|
|
29576
|
+
/**
|
|
29577
|
+
* Delete Trustee Group
|
|
29578
|
+
*
|
|
29579
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
29580
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
29581
|
+
*/
|
|
29582
|
+
deleteOrgauthorizationTrusteeGroup(trusteeOrgId, trusteeGroupId) {
|
|
29583
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
29584
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
29585
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeGroup';
|
|
29586
|
+
}
|
|
29587
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
29588
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
29589
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling deleteOrgauthorizationTrusteeGroup';
|
|
29590
|
+
}
|
|
29591
|
+
|
|
29592
|
+
return this.apiClient.callApi(
|
|
29593
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}',
|
|
29594
|
+
'DELETE',
|
|
29595
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
29596
|
+
{ },
|
|
29597
|
+
{ },
|
|
29598
|
+
{ },
|
|
29599
|
+
null,
|
|
29600
|
+
['PureCloud OAuth'],
|
|
29601
|
+
['application/json'],
|
|
29602
|
+
['application/json']
|
|
29603
|
+
);
|
|
29604
|
+
}
|
|
29605
|
+
|
|
29606
|
+
/**
|
|
29607
|
+
* Delete Trustee Group Roles
|
|
29608
|
+
*
|
|
29609
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
29610
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
29611
|
+
*/
|
|
29612
|
+
deleteOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId) {
|
|
29613
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
29614
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
29615
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeGroupRoles';
|
|
29616
|
+
}
|
|
29617
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
29618
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
29619
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling deleteOrgauthorizationTrusteeGroupRoles';
|
|
29620
|
+
}
|
|
29621
|
+
|
|
29622
|
+
return this.apiClient.callApi(
|
|
29623
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles',
|
|
29624
|
+
'DELETE',
|
|
29625
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
29626
|
+
{ },
|
|
29627
|
+
{ },
|
|
29628
|
+
{ },
|
|
29629
|
+
null,
|
|
29630
|
+
['PureCloud OAuth'],
|
|
29631
|
+
['application/json'],
|
|
29632
|
+
['application/json']
|
|
29633
|
+
);
|
|
29634
|
+
}
|
|
29635
|
+
|
|
29457
29636
|
/**
|
|
29458
29637
|
* Delete Trustee User
|
|
29459
29638
|
*
|
|
@@ -29569,6 +29748,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29569
29748
|
);
|
|
29570
29749
|
}
|
|
29571
29750
|
|
|
29751
|
+
/**
|
|
29752
|
+
* Delete Trustee Group
|
|
29753
|
+
*
|
|
29754
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
29755
|
+
* @param {String} trustorGroupId Trustor Group Id
|
|
29756
|
+
*/
|
|
29757
|
+
deleteOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId) {
|
|
29758
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
29759
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
29760
|
+
throw 'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorGroup';
|
|
29761
|
+
}
|
|
29762
|
+
// verify the required parameter 'trustorGroupId' is set
|
|
29763
|
+
if (trustorGroupId === undefined || trustorGroupId === null) {
|
|
29764
|
+
throw 'Missing the required parameter "trustorGroupId" when calling deleteOrgauthorizationTrustorGroup';
|
|
29765
|
+
}
|
|
29766
|
+
|
|
29767
|
+
return this.apiClient.callApi(
|
|
29768
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}',
|
|
29769
|
+
'DELETE',
|
|
29770
|
+
{ 'trustorOrgId': trustorOrgId,'trustorGroupId': trustorGroupId },
|
|
29771
|
+
{ },
|
|
29772
|
+
{ },
|
|
29773
|
+
{ },
|
|
29774
|
+
null,
|
|
29775
|
+
['PureCloud OAuth'],
|
|
29776
|
+
['application/json'],
|
|
29777
|
+
['application/json']
|
|
29778
|
+
);
|
|
29779
|
+
}
|
|
29780
|
+
|
|
29572
29781
|
/**
|
|
29573
29782
|
* Delete Trustee User
|
|
29574
29783
|
*
|
|
@@ -29674,6 +29883,96 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29674
29883
|
);
|
|
29675
29884
|
}
|
|
29676
29885
|
|
|
29886
|
+
/**
|
|
29887
|
+
* Get Trustee Group
|
|
29888
|
+
*
|
|
29889
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
29890
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
29891
|
+
*/
|
|
29892
|
+
getOrgauthorizationTrusteeGroup(trusteeOrgId, trusteeGroupId) {
|
|
29893
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
29894
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
29895
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroup';
|
|
29896
|
+
}
|
|
29897
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
29898
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
29899
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling getOrgauthorizationTrusteeGroup';
|
|
29900
|
+
}
|
|
29901
|
+
|
|
29902
|
+
return this.apiClient.callApi(
|
|
29903
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}',
|
|
29904
|
+
'GET',
|
|
29905
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
29906
|
+
{ },
|
|
29907
|
+
{ },
|
|
29908
|
+
{ },
|
|
29909
|
+
null,
|
|
29910
|
+
['PureCloud OAuth'],
|
|
29911
|
+
['application/json'],
|
|
29912
|
+
['application/json']
|
|
29913
|
+
);
|
|
29914
|
+
}
|
|
29915
|
+
|
|
29916
|
+
/**
|
|
29917
|
+
* Get Trustee Group Roles
|
|
29918
|
+
*
|
|
29919
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
29920
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
29921
|
+
*/
|
|
29922
|
+
getOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId) {
|
|
29923
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
29924
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
29925
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroupRoles';
|
|
29926
|
+
}
|
|
29927
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
29928
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
29929
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling getOrgauthorizationTrusteeGroupRoles';
|
|
29930
|
+
}
|
|
29931
|
+
|
|
29932
|
+
return this.apiClient.callApi(
|
|
29933
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles',
|
|
29934
|
+
'GET',
|
|
29935
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
29936
|
+
{ },
|
|
29937
|
+
{ },
|
|
29938
|
+
{ },
|
|
29939
|
+
null,
|
|
29940
|
+
['PureCloud OAuth'],
|
|
29941
|
+
['application/json'],
|
|
29942
|
+
['application/json']
|
|
29943
|
+
);
|
|
29944
|
+
}
|
|
29945
|
+
|
|
29946
|
+
/**
|
|
29947
|
+
* The list of trustee groups for this organization (i.e. groups granted access to this organization).
|
|
29948
|
+
*
|
|
29949
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
29950
|
+
* @param {Object} opts Optional parameters
|
|
29951
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
29952
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
29953
|
+
*/
|
|
29954
|
+
getOrgauthorizationTrusteeGroups(trusteeOrgId, opts) {
|
|
29955
|
+
opts = opts || {};
|
|
29956
|
+
|
|
29957
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
29958
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
29959
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroups';
|
|
29960
|
+
}
|
|
29961
|
+
|
|
29962
|
+
return this.apiClient.callApi(
|
|
29963
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups',
|
|
29964
|
+
'GET',
|
|
29965
|
+
{ 'trusteeOrgId': trusteeOrgId },
|
|
29966
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
29967
|
+
{ },
|
|
29968
|
+
{ },
|
|
29969
|
+
null,
|
|
29970
|
+
['PureCloud OAuth'],
|
|
29971
|
+
['application/json'],
|
|
29972
|
+
['application/json']
|
|
29973
|
+
);
|
|
29974
|
+
}
|
|
29975
|
+
|
|
29677
29976
|
/**
|
|
29678
29977
|
* Get Trustee User
|
|
29679
29978
|
*
|
|
@@ -29889,6 +30188,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29889
30188
|
);
|
|
29890
30189
|
}
|
|
29891
30190
|
|
|
30191
|
+
/**
|
|
30192
|
+
* Get Trustee Group
|
|
30193
|
+
*
|
|
30194
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
30195
|
+
* @param {String} trustorGroupId Trustor Group Id
|
|
30196
|
+
*/
|
|
30197
|
+
getOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId) {
|
|
30198
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
30199
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
30200
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorGroup';
|
|
30201
|
+
}
|
|
30202
|
+
// verify the required parameter 'trustorGroupId' is set
|
|
30203
|
+
if (trustorGroupId === undefined || trustorGroupId === null) {
|
|
30204
|
+
throw 'Missing the required parameter "trustorGroupId" when calling getOrgauthorizationTrustorGroup';
|
|
30205
|
+
}
|
|
30206
|
+
|
|
30207
|
+
return this.apiClient.callApi(
|
|
30208
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}',
|
|
30209
|
+
'GET',
|
|
30210
|
+
{ 'trustorOrgId': trustorOrgId,'trustorGroupId': trustorGroupId },
|
|
30211
|
+
{ },
|
|
30212
|
+
{ },
|
|
30213
|
+
{ },
|
|
30214
|
+
null,
|
|
30215
|
+
['PureCloud OAuth'],
|
|
30216
|
+
['application/json'],
|
|
30217
|
+
['application/json']
|
|
30218
|
+
);
|
|
30219
|
+
}
|
|
30220
|
+
|
|
30221
|
+
/**
|
|
30222
|
+
* The list of groups in the trustor organization (i.e. groups granted access).
|
|
30223
|
+
*
|
|
30224
|
+
* @param {String} trustorOrgId Trustee Organization Id
|
|
30225
|
+
* @param {Object} opts Optional parameters
|
|
30226
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
30227
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
30228
|
+
*/
|
|
30229
|
+
getOrgauthorizationTrustorGroups(trustorOrgId, opts) {
|
|
30230
|
+
opts = opts || {};
|
|
30231
|
+
|
|
30232
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
30233
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
30234
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorGroups';
|
|
30235
|
+
}
|
|
30236
|
+
|
|
30237
|
+
return this.apiClient.callApi(
|
|
30238
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/groups',
|
|
30239
|
+
'GET',
|
|
30240
|
+
{ 'trustorOrgId': trustorOrgId },
|
|
30241
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
30242
|
+
{ },
|
|
30243
|
+
{ },
|
|
30244
|
+
null,
|
|
30245
|
+
['PureCloud OAuth'],
|
|
30246
|
+
['application/json'],
|
|
30247
|
+
['application/json']
|
|
30248
|
+
);
|
|
30249
|
+
}
|
|
30250
|
+
|
|
29892
30251
|
/**
|
|
29893
30252
|
* Get Trustee User
|
|
29894
30253
|
*
|
|
@@ -29999,6 +30358,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29999
30358
|
);
|
|
30000
30359
|
}
|
|
30001
30360
|
|
|
30361
|
+
/**
|
|
30362
|
+
* Add a group to the trust.
|
|
30363
|
+
*
|
|
30364
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
30365
|
+
* @param {Object} body Trust
|
|
30366
|
+
*/
|
|
30367
|
+
postOrgauthorizationTrusteeGroups(trusteeOrgId, body) {
|
|
30368
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
30369
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
30370
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling postOrgauthorizationTrusteeGroups';
|
|
30371
|
+
}
|
|
30372
|
+
// verify the required parameter 'body' is set
|
|
30373
|
+
if (body === undefined || body === null) {
|
|
30374
|
+
throw 'Missing the required parameter "body" when calling postOrgauthorizationTrusteeGroups';
|
|
30375
|
+
}
|
|
30376
|
+
|
|
30377
|
+
return this.apiClient.callApi(
|
|
30378
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups',
|
|
30379
|
+
'POST',
|
|
30380
|
+
{ 'trusteeOrgId': trusteeOrgId },
|
|
30381
|
+
{ },
|
|
30382
|
+
{ },
|
|
30383
|
+
{ },
|
|
30384
|
+
body,
|
|
30385
|
+
['PureCloud OAuth'],
|
|
30386
|
+
['application/json'],
|
|
30387
|
+
['application/json']
|
|
30388
|
+
);
|
|
30389
|
+
}
|
|
30390
|
+
|
|
30002
30391
|
/**
|
|
30003
30392
|
* Add a user to the trust.
|
|
30004
30393
|
*
|
|
@@ -30173,6 +30562,76 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30173
30562
|
);
|
|
30174
30563
|
}
|
|
30175
30564
|
|
|
30565
|
+
/**
|
|
30566
|
+
* Update Trustee Group Roles
|
|
30567
|
+
*
|
|
30568
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
30569
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
30570
|
+
* @param {Object} body Set of roles with corresponding divisions to apply
|
|
30571
|
+
*/
|
|
30572
|
+
putOrgauthorizationTrusteeGroupRoledivisions(trusteeOrgId, trusteeGroupId, body) {
|
|
30573
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
30574
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
30575
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeGroupRoledivisions';
|
|
30576
|
+
}
|
|
30577
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
30578
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
30579
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling putOrgauthorizationTrusteeGroupRoledivisions';
|
|
30580
|
+
}
|
|
30581
|
+
// verify the required parameter 'body' is set
|
|
30582
|
+
if (body === undefined || body === null) {
|
|
30583
|
+
throw 'Missing the required parameter "body" when calling putOrgauthorizationTrusteeGroupRoledivisions';
|
|
30584
|
+
}
|
|
30585
|
+
|
|
30586
|
+
return this.apiClient.callApi(
|
|
30587
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roledivisions',
|
|
30588
|
+
'PUT',
|
|
30589
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
30590
|
+
{ },
|
|
30591
|
+
{ },
|
|
30592
|
+
{ },
|
|
30593
|
+
body,
|
|
30594
|
+
['PureCloud OAuth'],
|
|
30595
|
+
['application/json'],
|
|
30596
|
+
['application/json']
|
|
30597
|
+
);
|
|
30598
|
+
}
|
|
30599
|
+
|
|
30600
|
+
/**
|
|
30601
|
+
* Update Trustee Group Roles
|
|
30602
|
+
*
|
|
30603
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
30604
|
+
* @param {String} trusteeGroupId Trustee Group Id
|
|
30605
|
+
* @param {Array.<String>} body List of roles
|
|
30606
|
+
*/
|
|
30607
|
+
putOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId, body) {
|
|
30608
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
30609
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
30610
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeGroupRoles';
|
|
30611
|
+
}
|
|
30612
|
+
// verify the required parameter 'trusteeGroupId' is set
|
|
30613
|
+
if (trusteeGroupId === undefined || trusteeGroupId === null) {
|
|
30614
|
+
throw 'Missing the required parameter "trusteeGroupId" when calling putOrgauthorizationTrusteeGroupRoles';
|
|
30615
|
+
}
|
|
30616
|
+
// verify the required parameter 'body' is set
|
|
30617
|
+
if (body === undefined || body === null) {
|
|
30618
|
+
throw 'Missing the required parameter "body" when calling putOrgauthorizationTrusteeGroupRoles';
|
|
30619
|
+
}
|
|
30620
|
+
|
|
30621
|
+
return this.apiClient.callApi(
|
|
30622
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles',
|
|
30623
|
+
'PUT',
|
|
30624
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeGroupId': trusteeGroupId },
|
|
30625
|
+
{ },
|
|
30626
|
+
{ },
|
|
30627
|
+
{ },
|
|
30628
|
+
body,
|
|
30629
|
+
['PureCloud OAuth'],
|
|
30630
|
+
['application/json'],
|
|
30631
|
+
['application/json']
|
|
30632
|
+
);
|
|
30633
|
+
}
|
|
30634
|
+
|
|
30176
30635
|
/**
|
|
30177
30636
|
* Update Trustee User Roles
|
|
30178
30637
|
*
|
|
@@ -30273,6 +30732,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30273
30732
|
);
|
|
30274
30733
|
}
|
|
30275
30734
|
|
|
30735
|
+
/**
|
|
30736
|
+
* Add a Trustee Group to the trust.
|
|
30737
|
+
*
|
|
30738
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
30739
|
+
* @param {String} trustorGroupId Trustor Group Id
|
|
30740
|
+
*/
|
|
30741
|
+
putOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId) {
|
|
30742
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
30743
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
30744
|
+
throw 'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorGroup';
|
|
30745
|
+
}
|
|
30746
|
+
// verify the required parameter 'trustorGroupId' is set
|
|
30747
|
+
if (trustorGroupId === undefined || trustorGroupId === null) {
|
|
30748
|
+
throw 'Missing the required parameter "trustorGroupId" when calling putOrgauthorizationTrustorGroup';
|
|
30749
|
+
}
|
|
30750
|
+
|
|
30751
|
+
return this.apiClient.callApi(
|
|
30752
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}',
|
|
30753
|
+
'PUT',
|
|
30754
|
+
{ 'trustorOrgId': trustorOrgId,'trustorGroupId': trustorGroupId },
|
|
30755
|
+
{ },
|
|
30756
|
+
{ },
|
|
30757
|
+
{ },
|
|
30758
|
+
null,
|
|
30759
|
+
['PureCloud OAuth'],
|
|
30760
|
+
['application/json'],
|
|
30761
|
+
['application/json']
|
|
30762
|
+
);
|
|
30763
|
+
}
|
|
30764
|
+
|
|
30276
30765
|
/**
|
|
30277
30766
|
* Add a Trustee user to the trust.
|
|
30278
30767
|
*
|
|
@@ -30309,7 +30798,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30309
30798
|
/**
|
|
30310
30799
|
* Outbound service.
|
|
30311
30800
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30312
|
-
* @version
|
|
30801
|
+
* @version 159.0.0
|
|
30313
30802
|
*/
|
|
30314
30803
|
|
|
30315
30804
|
/**
|
|
@@ -33846,7 +34335,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33846
34335
|
/**
|
|
33847
34336
|
* Presence service.
|
|
33848
34337
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33849
|
-
* @version
|
|
34338
|
+
* @version 159.0.0
|
|
33850
34339
|
*/
|
|
33851
34340
|
|
|
33852
34341
|
/**
|
|
@@ -34352,7 +34841,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34352
34841
|
/**
|
|
34353
34842
|
* ProcessAutomation service.
|
|
34354
34843
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34355
|
-
* @version
|
|
34844
|
+
* @version 159.0.0
|
|
34356
34845
|
*/
|
|
34357
34846
|
|
|
34358
34847
|
/**
|
|
@@ -34591,7 +35080,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34591
35080
|
/**
|
|
34592
35081
|
* Quality service.
|
|
34593
35082
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34594
|
-
* @version
|
|
35083
|
+
* @version 159.0.0
|
|
34595
35084
|
*/
|
|
34596
35085
|
|
|
34597
35086
|
/**
|
|
@@ -34853,7 +35342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34853
35342
|
* @param {String} conversationId conversationId
|
|
34854
35343
|
* @param {String} evaluationId evaluationId
|
|
34855
35344
|
* @param {Object} opts Optional parameters
|
|
34856
|
-
* @param {String} opts.expand agent, evaluator, evaluationForm
|
|
35345
|
+
* @param {String} opts.expand agent, assignee, evaluator, evaluationForm
|
|
34857
35346
|
*/
|
|
34858
35347
|
getQualityConversationEvaluation(conversationId, evaluationId, opts) {
|
|
34859
35348
|
opts = opts || {};
|
|
@@ -34964,7 +35453,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34964
35453
|
|
|
34965
35454
|
/**
|
|
34966
35455
|
* Queries Evaluations and returns a paged list
|
|
34967
|
-
* Query params must include one of conversationId, evaluatorUserId, or
|
|
35456
|
+
* Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date.
|
|
34968
35457
|
* @param {Object} opts Optional parameters
|
|
34969
35458
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
34970
35459
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -34975,6 +35464,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34975
35464
|
* @param {String} opts.conversationId conversationId specified
|
|
34976
35465
|
* @param {String} opts.agentUserId user id of the agent
|
|
34977
35466
|
* @param {String} opts.evaluatorUserId evaluator user id
|
|
35467
|
+
* @param {String} opts.assigneeUserId assignee user id
|
|
34978
35468
|
* @param {String} opts.queueId queue id
|
|
34979
35469
|
* @param {String} opts.startTime start time of the evaluation query
|
|
34980
35470
|
* @param {String} opts.endTime end time of the evaluation query
|
|
@@ -34993,7 +35483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34993
35483
|
'/api/v2/quality/evaluations/query',
|
|
34994
35484
|
'GET',
|
|
34995
35485
|
{ },
|
|
34996
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
35486
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
34997
35487
|
{ },
|
|
34998
35488
|
{ },
|
|
34999
35489
|
null,
|
|
@@ -36169,7 +36659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36169
36659
|
/**
|
|
36170
36660
|
* Recording service.
|
|
36171
36661
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
36172
|
-
* @version
|
|
36662
|
+
* @version 159.0.0
|
|
36173
36663
|
*/
|
|
36174
36664
|
|
|
36175
36665
|
/**
|
|
@@ -37299,7 +37789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37299
37789
|
|
|
37300
37790
|
/**
|
|
37301
37791
|
* Create a recording bulk job.
|
|
37302
|
-
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected.
|
|
37792
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected.
|
|
37303
37793
|
* @param {Object} body query
|
|
37304
37794
|
*/
|
|
37305
37795
|
postRecordingJobs(body) {
|
|
@@ -37906,7 +38396,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37906
38396
|
/**
|
|
37907
38397
|
* ResponseManagement service.
|
|
37908
38398
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37909
|
-
* @version
|
|
38399
|
+
* @version 159.0.0
|
|
37910
38400
|
*/
|
|
37911
38401
|
|
|
37912
38402
|
/**
|
|
@@ -38390,7 +38880,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38390
38880
|
/**
|
|
38391
38881
|
* Routing service.
|
|
38392
38882
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38393
|
-
* @version
|
|
38883
|
+
* @version 159.0.0
|
|
38394
38884
|
*/
|
|
38395
38885
|
|
|
38396
38886
|
/**
|
|
@@ -41855,7 +42345,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41855
42345
|
/**
|
|
41856
42346
|
* SCIM service.
|
|
41857
42347
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
41858
|
-
* @version
|
|
42348
|
+
* @version 159.0.0
|
|
41859
42349
|
*/
|
|
41860
42350
|
|
|
41861
42351
|
/**
|
|
@@ -42732,7 +43222,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42732
43222
|
/**
|
|
42733
43223
|
* Scripts service.
|
|
42734
43224
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
42735
|
-
* @version
|
|
43225
|
+
* @version 159.0.0
|
|
42736
43226
|
*/
|
|
42737
43227
|
|
|
42738
43228
|
/**
|
|
@@ -43151,7 +43641,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43151
43641
|
/**
|
|
43152
43642
|
* Search service.
|
|
43153
43643
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
43154
|
-
* @version
|
|
43644
|
+
* @version 159.0.0
|
|
43155
43645
|
*/
|
|
43156
43646
|
|
|
43157
43647
|
/**
|
|
@@ -43736,7 +44226,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43736
44226
|
/**
|
|
43737
44227
|
* SpeechTextAnalytics service.
|
|
43738
44228
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
43739
|
-
* @version
|
|
44229
|
+
* @version 159.0.0
|
|
43740
44230
|
*/
|
|
43741
44231
|
|
|
43742
44232
|
/**
|
|
@@ -44590,7 +45080,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44590
45080
|
/**
|
|
44591
45081
|
* Stations service.
|
|
44592
45082
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
44593
|
-
* @version
|
|
45083
|
+
* @version 159.0.0
|
|
44594
45084
|
*/
|
|
44595
45085
|
|
|
44596
45086
|
/**
|
|
@@ -44688,7 +45178,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44688
45178
|
|
|
44689
45179
|
/**
|
|
44690
45180
|
* Get an organization's StationSettings
|
|
44691
|
-
*
|
|
45181
|
+
* This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
|
|
44692
45182
|
*/
|
|
44693
45183
|
getStationsSettings() {
|
|
44694
45184
|
|
|
@@ -44708,7 +45198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44708
45198
|
|
|
44709
45199
|
/**
|
|
44710
45200
|
* Patch an organization's StationSettings
|
|
44711
|
-
*
|
|
45201
|
+
* This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
|
|
44712
45202
|
* @param {Object} body Station settings
|
|
44713
45203
|
*/
|
|
44714
45204
|
patchStationsSettings(body) {
|
|
@@ -44737,7 +45227,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44737
45227
|
/**
|
|
44738
45228
|
* Suggest service.
|
|
44739
45229
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
44740
|
-
* @version
|
|
45230
|
+
* @version 159.0.0
|
|
44741
45231
|
*/
|
|
44742
45232
|
|
|
44743
45233
|
/**
|
|
@@ -44876,7 +45366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44876
45366
|
/**
|
|
44877
45367
|
* Teams service.
|
|
44878
45368
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
44879
|
-
* @version
|
|
45369
|
+
* @version 159.0.0
|
|
44880
45370
|
*/
|
|
44881
45371
|
|
|
44882
45372
|
/**
|
|
@@ -45147,7 +45637,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45147
45637
|
/**
|
|
45148
45638
|
* Telephony service.
|
|
45149
45639
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
45150
|
-
* @version
|
|
45640
|
+
* @version 159.0.0
|
|
45151
45641
|
*/
|
|
45152
45642
|
|
|
45153
45643
|
/**
|
|
@@ -45275,7 +45765,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45275
45765
|
/**
|
|
45276
45766
|
* TelephonyProvidersEdge service.
|
|
45277
45767
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
45278
|
-
* @version
|
|
45768
|
+
* @version 159.0.0
|
|
45279
45769
|
*/
|
|
45280
45770
|
|
|
45281
45771
|
/**
|
|
@@ -46281,6 +46771,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46281
46771
|
* @param {String} opts.edgeGroupId Filter by edgeGroup.id
|
|
46282
46772
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
46283
46773
|
* @param {Boolean} opts.managed Filter by managed
|
|
46774
|
+
* @param {Boolean} opts.showCloudMedia True to show the cloud media devices in the result. (default to true)
|
|
46284
46775
|
*/
|
|
46285
46776
|
getTelephonyProvidersEdges(opts) {
|
|
46286
46777
|
opts = opts || {};
|
|
@@ -46290,7 +46781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46290
46781
|
'/api/v2/telephony/providers/edges',
|
|
46291
46782
|
'GET',
|
|
46292
46783
|
{ },
|
|
46293
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'site.id': opts['siteId'],'edgeGroup.id': opts['edgeGroupId'],'sortBy': opts['sortBy'],'managed': opts['managed'] },
|
|
46784
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'site.id': opts['siteId'],'edgeGroup.id': opts['edgeGroupId'],'sortBy': opts['sortBy'],'managed': opts['managed'],'showCloudMedia': opts['showCloudMedia'] },
|
|
46294
46785
|
{ },
|
|
46295
46786
|
{ },
|
|
46296
46787
|
null,
|
|
@@ -48908,7 +49399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48908
49399
|
/**
|
|
48909
49400
|
* Textbots service.
|
|
48910
49401
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
48911
|
-
* @version
|
|
49402
|
+
* @version 159.0.0
|
|
48912
49403
|
*/
|
|
48913
49404
|
|
|
48914
49405
|
/**
|
|
@@ -49036,7 +49527,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49036
49527
|
/**
|
|
49037
49528
|
* Tokens service.
|
|
49038
49529
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
49039
|
-
* @version
|
|
49530
|
+
* @version 159.0.0
|
|
49040
49531
|
*/
|
|
49041
49532
|
|
|
49042
49533
|
/**
|
|
@@ -49142,7 +49633,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49142
49633
|
/**
|
|
49143
49634
|
* Uploads service.
|
|
49144
49635
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
49145
|
-
* @version
|
|
49636
|
+
* @version 159.0.0
|
|
49146
49637
|
*/
|
|
49147
49638
|
|
|
49148
49639
|
/**
|
|
@@ -49318,7 +49809,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49318
49809
|
/**
|
|
49319
49810
|
* Usage service.
|
|
49320
49811
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
49321
|
-
* @version
|
|
49812
|
+
* @version 159.0.0
|
|
49322
49813
|
*/
|
|
49323
49814
|
|
|
49324
49815
|
/**
|
|
@@ -49389,7 +49880,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49389
49880
|
/**
|
|
49390
49881
|
* UserRecordings service.
|
|
49391
49882
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
49392
|
-
* @version
|
|
49883
|
+
* @version 159.0.0
|
|
49393
49884
|
*/
|
|
49394
49885
|
|
|
49395
49886
|
/**
|
|
@@ -49574,7 +50065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49574
50065
|
/**
|
|
49575
50066
|
* Users service.
|
|
49576
50067
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49577
|
-
* @version
|
|
50068
|
+
* @version 159.0.0
|
|
49578
50069
|
*/
|
|
49579
50070
|
|
|
49580
50071
|
/**
|
|
@@ -51931,7 +52422,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51931
52422
|
/**
|
|
51932
52423
|
* Utilities service.
|
|
51933
52424
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
51934
|
-
* @version
|
|
52425
|
+
* @version 159.0.0
|
|
51935
52426
|
*/
|
|
51936
52427
|
|
|
51937
52428
|
/**
|
|
@@ -52042,7 +52533,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52042
52533
|
/**
|
|
52043
52534
|
* Voicemail service.
|
|
52044
52535
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
52045
|
-
* @version
|
|
52536
|
+
* @version 159.0.0
|
|
52046
52537
|
*/
|
|
52047
52538
|
|
|
52048
52539
|
/**
|
|
@@ -52709,7 +53200,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52709
53200
|
/**
|
|
52710
53201
|
* WebChat service.
|
|
52711
53202
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
52712
|
-
* @version
|
|
53203
|
+
* @version 159.0.0
|
|
52713
53204
|
*/
|
|
52714
53205
|
|
|
52715
53206
|
/**
|
|
@@ -53253,7 +53744,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53253
53744
|
/**
|
|
53254
53745
|
* WebDeployments service.
|
|
53255
53746
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
53256
|
-
* @version
|
|
53747
|
+
* @version 159.0.0
|
|
53257
53748
|
*/
|
|
53258
53749
|
|
|
53259
53750
|
/**
|
|
@@ -53318,6 +53809,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53318
53809
|
);
|
|
53319
53810
|
}
|
|
53320
53811
|
|
|
53812
|
+
/**
|
|
53813
|
+
* Deletes a cobrowse session
|
|
53814
|
+
*
|
|
53815
|
+
* @param {String} deploymentId WebMessaging deployment ID
|
|
53816
|
+
* @param {String} sessionId Cobrowse session id or join code
|
|
53817
|
+
*/
|
|
53818
|
+
deleteWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId) {
|
|
53819
|
+
// verify the required parameter 'deploymentId' is set
|
|
53820
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
53821
|
+
throw 'Missing the required parameter "deploymentId" when calling deleteWebdeploymentsDeploymentCobrowseSessionId';
|
|
53822
|
+
}
|
|
53823
|
+
// verify the required parameter 'sessionId' is set
|
|
53824
|
+
if (sessionId === undefined || sessionId === null) {
|
|
53825
|
+
throw 'Missing the required parameter "sessionId" when calling deleteWebdeploymentsDeploymentCobrowseSessionId';
|
|
53826
|
+
}
|
|
53827
|
+
|
|
53828
|
+
return this.apiClient.callApi(
|
|
53829
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}',
|
|
53830
|
+
'DELETE',
|
|
53831
|
+
{ 'deploymentId': deploymentId,'sessionId': sessionId },
|
|
53832
|
+
{ },
|
|
53833
|
+
{ },
|
|
53834
|
+
{ },
|
|
53835
|
+
null,
|
|
53836
|
+
['PureCloud OAuth'],
|
|
53837
|
+
['application/json'],
|
|
53838
|
+
['application/json']
|
|
53839
|
+
);
|
|
53840
|
+
}
|
|
53841
|
+
|
|
53321
53842
|
/**
|
|
53322
53843
|
* Invalidate JWT
|
|
53323
53844
|
*
|
|
@@ -53472,6 +53993,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53472
53993
|
);
|
|
53473
53994
|
}
|
|
53474
53995
|
|
|
53996
|
+
/**
|
|
53997
|
+
* Retrieves a cobrowse session
|
|
53998
|
+
*
|
|
53999
|
+
* @param {String} deploymentId WebMessaging deployment ID
|
|
54000
|
+
* @param {String} sessionId Cobrowse session id or join code
|
|
54001
|
+
*/
|
|
54002
|
+
getWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId) {
|
|
54003
|
+
// verify the required parameter 'deploymentId' is set
|
|
54004
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
54005
|
+
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentCobrowseSessionId';
|
|
54006
|
+
}
|
|
54007
|
+
// verify the required parameter 'sessionId' is set
|
|
54008
|
+
if (sessionId === undefined || sessionId === null) {
|
|
54009
|
+
throw 'Missing the required parameter "sessionId" when calling getWebdeploymentsDeploymentCobrowseSessionId';
|
|
54010
|
+
}
|
|
54011
|
+
|
|
54012
|
+
return this.apiClient.callApi(
|
|
54013
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}',
|
|
54014
|
+
'GET',
|
|
54015
|
+
{ 'deploymentId': deploymentId,'sessionId': sessionId },
|
|
54016
|
+
{ },
|
|
54017
|
+
{ },
|
|
54018
|
+
{ },
|
|
54019
|
+
null,
|
|
54020
|
+
['PureCloud OAuth'],
|
|
54021
|
+
['application/json'],
|
|
54022
|
+
['application/json']
|
|
54023
|
+
);
|
|
54024
|
+
}
|
|
54025
|
+
|
|
53475
54026
|
/**
|
|
53476
54027
|
* Get active configuration for a given deployment
|
|
53477
54028
|
*
|
|
@@ -53715,7 +54266,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53715
54266
|
/**
|
|
53716
54267
|
* WebMessaging service.
|
|
53717
54268
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
53718
|
-
* @version
|
|
54269
|
+
* @version 159.0.0
|
|
53719
54270
|
*/
|
|
53720
54271
|
|
|
53721
54272
|
/**
|
|
@@ -53761,7 +54312,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53761
54312
|
/**
|
|
53762
54313
|
* Widgets service.
|
|
53763
54314
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
53764
|
-
* @version
|
|
54315
|
+
* @version 159.0.0
|
|
53765
54316
|
*/
|
|
53766
54317
|
|
|
53767
54318
|
/**
|
|
@@ -53907,7 +54458,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53907
54458
|
/**
|
|
53908
54459
|
* WorkforceManagement service.
|
|
53909
54460
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
53910
|
-
* @version
|
|
54461
|
+
* @version 159.0.0
|
|
53911
54462
|
*/
|
|
53912
54463
|
|
|
53913
54464
|
/**
|
|
@@ -58626,7 +59177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58626
59177
|
* </pre>
|
|
58627
59178
|
* </p>
|
|
58628
59179
|
* @module purecloud-platform-client-v2/index
|
|
58629
|
-
* @version
|
|
59180
|
+
* @version 159.0.0
|
|
58630
59181
|
*/
|
|
58631
59182
|
class platformClient {
|
|
58632
59183
|
constructor() {
|